manifest target (#251)

* manifest target * fix tests
GitbookIO · Oct 3, 2023 · 5f9c5c9 · 5f9c5c9
1 parent 83d8b9f
commit 5f9c5c9
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 0 deletions.
diff --git a/.changeset/five-planets-shop.md b/.changeset/five-planets-shop.md
@@ -0,0 +1,7 @@
+---
+'@gitbook/cli': minor
+'@gitbook/api': minor
+---
+
+-   Bump API client to use the latest spec
+-   Update CLI to use the latest manifest with target support
diff --git a/packages/cli/src/manifest.ts b/packages/cli/src/manifest.ts
@@ -18,6 +18,7 @@ export interface IntegrationManifest {
     icon?: string;
     description?: string;
     summary?: string;
+    target?: api.IntegrationTarget;
     scopes?: api.IntegrationScope[];
     categories?: api.IntegrationCategory[];
     blocks?: api.IntegrationBlock[];

diff --git a/packages/cli/src/publish.ts b/packages/cli/src/publish.ts
@@ -7,6 +7,8 @@ import { buildScriptFromManifest } from './build';
 import { resolveFile } from './manifest';
 import { getAPIClient } from './remote';
 
+const targetAll = api.IntegrationTarget.All;
+
 /**
  * Publish the integration to GitBook.
  * If it already exists, it'll update it.
@@ -22,6 +24,12 @@ export async function publishIntegration(
 
     const api = await getAPIClient(true);
 
+    if (typeof manifest.target === 'string' && manifest.target !== targetAll) {
+        console.log(
+            `ℹ️ Publishing integration with "${manifest.target}" as target for installations. Keep in mind this cannot be changed later.`
+        );
+    }
+
     // Publish the integration.
     const created = await api.integrations.publishIntegration(manifest.name, {
         title: manifest.title,
@@ -36,6 +44,7 @@ export async function publishIntegration(
         configurations: manifest.configurations,
         secrets: manifest.secrets,
         visibility: manifest.visibility,
+        target: manifest.target,
         organization: manifest.organization,
         externalLinks: manifest.externalLinks,
         entities: manifest.entities,