@tappify/extension-sdk 2.0.0 → 2.1.0-beta.2

package/dist/manifest.d.ts

@@ -1,5 +1,5 @@
-import { E as ExtensionManifest, c as ExposableKind, U as UiContributionRef, M as ManifestValidation } from './constants-DJ_KgZpN.js';
-export { A as ActionDeclaration, d as AiContribution, B as BannerContribution, C as CARD_KEYS, e as CATEGORIES, f as CHARTS, g as ConnectorAuth, h as ConnectorContribution, i as ContextDeclaration, j as ContributionKind, k as CredentialField, D as DataQueryKind, l as DimensionDeclaration, m as EVENTS, n as ExtensionCategory, o as ExtensionInstallScope, p as ExtensionListing, q as ExtensionVisibility, r as HostChart, H as HostEventName, a as HostPage, s as HostTable, J as JsonSchema, K as KINDS, t as KnowledgeDeclaration, u as ManifestIssue, v as MarkerContribution, w as MentionDeclaration, x as MetricDeclaration, P as PAGES, y as PAGE_KEYS, z as PageContribution, F as PageDefinition, G as ProcedureDeclaration, I as PromptDeclaration, Q as QUERY_SCOPES, R as RowActionContribution, L as SCOPES, N as SCOPE_KEYS, O as SERVED_SDK_MAJORS, T as SLOTS, V as ScopeDefinition, W as ScopeEntry, S as ScopeKey, X as SeriesContribution, Y as SettingsContribution, Z as SkillDeclaration, b as SlotId, _ as StorageCollection, $ as TABLES, a0 as TABLE_KEYS, a1 as TabContribution, a2 as TableDefinition, a3 as ToolDeclaration, a4 as WebhookContribution, a5 as WidgetContribution, a6 as WorkContribution, a7 as findPage, a8 as findScope, a9 as findTable, aa as slotsForPage } from './constants-DJ_KgZpN.js';
+import { E as ExtensionManifest, c as ExposableKind, U as UiContributionRef, M as ManifestValidation, d as ManifestIssue } from './constants-Bh759FUI.js';
+export { A as ActionDeclaration, e as AiContribution, B as BannerContribution, C as CARD_KEYS, f as CATEGORIES, g as CHARTS, h as ConnectorAuth, i as ConnectorContribution, j as ContextDeclaration, k as ContributionKind, l as CredentialField, D as DataQueryKind, m as DimensionDeclaration, n as EVENTS, o as ExtensionCategory, p as ExtensionInstallScope, q as ExtensionListing, r as ExtensionVisibility, s as HostChart, H as HostEventName, a as HostPage, t as HostTable, J as JsonSchema, K as KINDS, u as KnowledgeDeclaration, L as LegacyWorkContribution, v as MarkerContribution, w as MentionDeclaration, x as MetricDeclaration, O as OAuthTokenRequestEncoding, P as PAGES, y as PAGE_KEYS, z as PageContribution, F as PageDefinition, G as ProcedureDeclaration, I as PromptDeclaration, Q as QUERY_SCOPES, R as RowActionContribution, N as SCOPES, T as SCOPE_KEYS, V as SERVED_SDK_MAJORS, W as SLOTS, X as ScopeDefinition, Y as ScopeEntry, S as ScopeKey, Z as SeriesContribution, _ as SettingsContribution, $ as SkillDeclaration, b as SlotId, a0 as StorageCollection, a1 as TABLES, a2 as TABLE_KEYS, a3 as TabContribution, a4 as TableDefinition, a5 as ToolDeclaration, a6 as WebhookContribution, a7 as WidgetContribution, a8 as WorkAuth, a9 as WorkContribution, aa as WorkDirection, ab as findPage, ac as findScope, ad as findTable, ae as slotsForPage } from './constants-Bh759FUI.js';
 import { z } from 'zod';
 
 declare function defineManifest(manifest: ExtensionManifest): ExtensionManifest;
@@ -52,6 +52,7 @@ declare const manifestSchema: z.ZodObject<{
             "analytics:read": "analytics:read";
             "store.metadata:read": "store.metadata:read";
             "reviews:read": "reviews:read";
+            "review.threads:read": "review.threads:read";
             "crashes:read": "crashes:read";
             "revenue:read": "revenue:read";
             "metrics:write": "metrics:write";
@@ -180,10 +181,10 @@ declare const manifestSchema: z.ZodObject<{
                     label: z.ZodString;
                     type: z.ZodEnum<{
                         text: "text";
-                        password: "password";
+                        select: "select";
                         textarea: "textarea";
+                        password: "password";
                         file: "file";
-                        select: "select";
                     }>;
                     required: z.ZodBoolean;
                     options: z.ZodOptional<z.ZodArray<z.ZodString>>;
@@ -193,6 +194,10 @@ declare const manifestSchema: z.ZodObject<{
                     authorizationUrl: z.ZodURL;
                     tokenUrl: z.ZodURL;
                     scopes: z.ZodArray<z.ZodString>;
+                    tokenRequestEncoding: z.ZodOptional<z.ZodEnum<{
+                        form: "form";
+                        json: "json";
+                    }>>;
                 }, z.core.$strict>>;
             }, z.core.$strict>>;
             sync: z.ZodOptional<z.ZodEnum<{
@@ -238,11 +243,11 @@ declare const manifestSchema: z.ZodObject<{
                 description: z.ZodString;
                 input: z.ZodRecord<z.ZodString, z.ZodUnknown>;
                 returns: z.ZodEnum<{
-                    comparison: "comparison";
+                    value: "value";
+                    list: "list";
                     table: "table";
+                    comparison: "comparison";
                     series: "series";
-                    list: "list";
-                    value: "value";
                 }>;
                 cost: z.ZodEnum<{
                     low: "low";
@@ -272,6 +277,7 @@ declare const manifestSchema: z.ZodObject<{
                     "analytics:read": "analytics:read";
                     "store.metadata:read": "store.metadata:read";
                     "reviews:read": "reviews:read";
+                    "review.threads:read": "review.threads:read";
                     "crashes:read": "crashes:read";
                     "revenue:read": "revenue:read";
                     "metrics:write": "metrics:write";
@@ -310,9 +316,9 @@ declare const manifestSchema: z.ZodObject<{
                 title: z.ZodString;
                 template: z.ZodString;
                 surfaces: z.ZodArray<z.ZodEnum<{
+                    page: "page";
                     chat_suggestion: "chat_suggestion";
                     widget: "widget";
-                    page: "page";
                     result_card: "result_card";
                 }>>;
                 after: z.ZodOptional<z.ZodArray<z.ZodString>>;
@@ -332,7 +338,84 @@ declare const manifestSchema: z.ZodObject<{
                 }>>;
             }, z.core.$strict>>>;
         }, z.core.$strict>>;
-        work: z.ZodOptional<z.ZodObject<{
+        work: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
+            kind: z.ZodEnum<{
+                chat: "chat";
+                tracker: "tracker";
+                docs: "docs";
+            }>;
+            creates: z.ZodArray<z.ZodEnum<{
+                page: "page";
+                issue: "issue";
+                message: "message";
+            }>>;
+            attachments: z.ZodArray<z.ZodEnum<{
+                link: "link";
+                image: "image";
+            }>>;
+            identity: z.ZodEnum<{
+                user: "user";
+                install: "install";
+            }>;
+            container: z.ZodOptional<z.ZodObject<{
+                label: z.ZodString;
+                list: z.ZodString;
+            }, z.core.$strict>>;
+            fields: z.ZodOptional<z.ZodObject<{
+                priority: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                labels: z.ZodOptional<z.ZodBoolean>;
+                assignee: z.ZodOptional<z.ZodBoolean>;
+                required: z.ZodArray<z.ZodString>;
+            }, z.core.$strict>>;
+            comments: z.ZodUnion<readonly [z.ZodEnum<{
+                none: "none";
+                "two-way": "two-way";
+            }>, z.ZodObject<{
+                direction: z.ZodEnum<{
+                    none: "none";
+                    to_provider: "to_provider";
+                    from_provider: "from_provider";
+                    "two-way": "two-way";
+                }>;
+                supportsEdits: z.ZodLiteral<false>;
+                supportsDeletes: z.ZodLiteral<false>;
+            }, z.core.$strict>]>;
+            status: z.ZodOptional<z.ZodObject<{
+                direction: z.ZodEnum<{
+                    none: "none";
+                    to_provider: "to_provider";
+                    from_provider: "from_provider";
+                    "two-way": "two-way";
+                }>;
+                webhook: z.ZodOptional<z.ZodString>;
+                map: z.ZodOptional<z.ZodObject<{
+                    open: z.ZodArray<z.ZodString>;
+                    in_progress: z.ZodArray<z.ZodString>;
+                    done: z.ZodArray<z.ZodString>;
+                }, z.core.$strict>>;
+            }, z.core.$strict>>;
+            auth: z.ZodDiscriminatedUnion<[z.ZodObject<{
+                method: z.ZodLiteral<"oauth">;
+                provider: z.ZodString;
+                scopes: z.ZodArray<z.ZodString>;
+            }, z.core.$strict>, z.ZodObject<{
+                method: z.ZodLiteral<"api_key">;
+                fields: z.ZodArray<z.ZodObject<{
+                    name: z.ZodString;
+                    label: z.ZodString;
+                    type: z.ZodEnum<{
+                        text: "text";
+                        select: "select";
+                        textarea: "textarea";
+                        password: "password";
+                        file: "file";
+                    }>;
+                    required: z.ZodBoolean;
+                    options: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                    help: z.ZodOptional<z.ZodString>;
+                }, z.core.$strict>>;
+            }, z.core.$strict>], "method">;
+        }, z.core.$strict>, z.ZodObject<{
             kind: z.ZodEnum<{
                 chat: "chat";
                 tracker: "tracker";
@@ -354,8 +437,8 @@ declare const manifestSchema: z.ZodObject<{
                 required: z.ZodArray<z.ZodString>;
             }, z.core.$strict>;
             attachments: z.ZodArray<z.ZodEnum<{
-                image: "image";
                 link: "link";
+                image: "image";
             }>>;
             comments: z.ZodEnum<{
                 none: "none";
@@ -373,7 +456,7 @@ declare const manifestSchema: z.ZodObject<{
                 user: "user";
                 install: "install";
             }>;
-        }, z.core.$strict>>;
+        }, z.core.$strict>]>>;
     }, z.core.$strict>;
     server: z.ZodOptional<z.ZodObject<{
         baseUrl: z.ZodURL;
@@ -428,5 +511,7 @@ declare const manifestSchema: z.ZodObject<{
 }, z.core.$strict>;
 declare function manifestJsonSchema(): Record<string, unknown>;
 declare function validateManifest(value: unknown): ManifestValidation;
+/** Migration warnings are separate from validation during SDK v2 compatibility. */
+declare function workManifestWarnings(manifest: ExtensionManifest): ManifestIssue[];
 
-export { ExposableKind, ExtensionManifest, ManifestValidation, UiContributionRef, defineManifest, exposeName, manifestJsonSchema, manifestSchema, remoteName, sdkMajors, uiContributions, validateManifest };
+export { ExposableKind, ExtensionManifest, ManifestIssue, ManifestValidation, UiContributionRef, defineManifest, exposeName, manifestJsonSchema, manifestSchema, remoteName, sdkMajors, uiContributions, validateManifest, workManifestWarnings };

package/dist/manifest.mjs

@@ -1,3 +1,9 @@
+import {
+  defineManifest,
+  exposeName,
+  remoteName,
+  uiContributions
+} from "./chunk-Z43DPNZ6.mjs";
 import {
   CARD_KEYS,
   CATEGORIES,
@@ -17,70 +23,8 @@ import {
   findScope,
   findTable,
   slotsForPage
-} from "./chunk-MNDVYPEP.mjs";
-
-// src/manifest/define.ts
-var EXPOSE_FOLDER = {
-  page: "pages",
-  tab: "tabs",
-  widget: "widgets",
-  rowAction: "rowActions"
-};
-function defineManifest(manifest) {
-  return manifest;
-}
-function exposeName(kind, id) {
-  if (kind === "settings") return "./settings";
-  return `./${EXPOSE_FOLDER[kind]}/${id ?? ""}`;
-}
-function remoteName(extensionId) {
-  return `ext_${extensionId.replace(/-/g, "_")}`;
-}
-function uiContributions(manifest) {
-  const contributes = manifest.contributes;
-  const refs = [];
-  for (const page of contributes.pages ?? []) {
-    refs.push({
-      kind: "page",
-      id: page.id,
-      entry: page.entry,
-      expose: exposeName("page", page.id)
-    });
-  }
-  for (const tab of contributes.tabs ?? []) {
-    refs.push({
-      kind: "tab",
-      id: tab.id,
-      entry: tab.entry,
-      expose: exposeName("tab", tab.id)
-    });
-  }
-  for (const widget of contributes.widgets ?? []) {
-    refs.push({
-      kind: "widget",
-      id: widget.id,
-      entry: widget.entry,
-      expose: exposeName("widget", widget.id)
-    });
-  }
-  for (const rowAction of contributes.rowActions ?? []) {
-    refs.push({
-      kind: "rowAction",
-      id: rowAction.id,
-      entry: rowAction.entry,
-      expose: exposeName("rowAction", rowAction.id)
-    });
-  }
-  if (contributes.settings) {
-    refs.push({
-      kind: "settings",
-      id: "settings",
-      entry: contributes.settings.entry,
-      expose: exposeName("settings")
-    });
-  }
-  return refs;
-}
+} from "./chunk-SGCYEEXD.mjs";
+import "./chunk-J5LGTIGS.mjs";
 
 // src/manifest/schema.ts
 import { z } from "zod";
@@ -254,7 +198,10 @@ var connectorContribution = z.object({
       ),
       scopes: z.array(z.string()).describe(
         "The scopes asked of the outside service. These are that service's scopes, not Tappify's."
-      )
+      ),
+      tokenRequestEncoding: z.enum(["form", "json"]).describe(
+        "The request body encoding for authorization-code and refresh token exchanges. When omitted, uses form encoding (application/x-www-form-urlencoded); json uses application/json."
+      ).optional()
     }).strict().describe('The endpoints, for `method: "oauth"`.').optional()
   }).strict().describe("How owners authenticate this connector.").optional(),
   sync: z.enum(["5m", "15m", "1h", "6h", "24h"]).describe("How often Tappify asks your server to sync.").optional(),
@@ -398,7 +345,7 @@ var aiContribution = z.object({
   ).optional()
 }).strict();
 var statusNames = (stage) => z.array(z.string()).describe(`Your own status names that mean ${stage}.`);
-var workContribution = z.object({
+var legacyWorkContribution = z.object({
   kind: z.enum(["tracker", "docs", "chat"]).describe("What kind of destination this is."),
   container: z.object({
     label: z.string().min(1).max(60).describe(
@@ -433,6 +380,55 @@ var workContribution = z.object({
     "Whether items are created as the owner who asked (`user`) or as the install itself."
   )
 }).strict();
+var workDirection = z.enum([
+  "none",
+  "to_provider",
+  "from_provider",
+  "two-way"
+]);
+var workAuth = z.discriminatedUnion("method", [
+  z.object({
+    method: z.literal("oauth"),
+    provider: z.string().min(1).describe("The OAuth provider identifier."),
+    scopes: z.array(z.string()).describe("The scopes requested from the provider.")
+  }).strict(),
+  z.object({
+    method: z.literal("api_key"),
+    fields: z.array(credentialField).max(20)
+  }).strict()
+]);
+var currentWorkContribution = legacyWorkContribution.extend({
+  container: legacyWorkContribution.shape.container.describe(
+    "Deprecated. Resolve containers dynamically with describe_container."
+  ).optional(),
+  fields: legacyWorkContribution.shape.fields.describe("Deprecated. Resolve fields dynamically with describe_container.").optional(),
+  comments: z.union([
+    z.enum(["two-way", "none"]).describe("Deprecated. Declare a comments capability object."),
+    z.object({
+      direction: workDirection,
+      supportsEdits: z.literal(false),
+      supportsDeletes: z.literal(false)
+    }).strict()
+  ]),
+  status: z.object({
+    direction: workDirection,
+    webhook: z.string().regex(DOMAIN_EVENT).optional(),
+    map: z.object({
+      open: statusNames("not started"),
+      in_progress: statusNames("under way"),
+      done: statusNames("finished")
+    }).strict().describe(
+      "Deprecated. Resolve statuses dynamically with describe_container."
+    ).optional()
+  }).strict().optional(),
+  auth: workAuth.describe("How owners authenticate the work destination.")
+});
+var workContribution = z.union([
+  currentWorkContribution,
+  legacyWorkContribution.describe(
+    "Deprecated SDK v2 work declaration. Migrate to work capabilities and auth."
+  )
+]);
 var listing = z.object({
   longDescription: z.string().min(1).max(5e3).describe("The body of your listing page, in markdown.").optional(),
   screenshots: z.array(z.string().min(1)).min(1, "A listing shows 1 to 6 screenshots.").max(6, "A listing shows 1 to 6 screenshots.").describe(
@@ -524,7 +520,7 @@ var manifestObject = z.object({
       "What this extension offers the assistant: tools, mentions, actions, knowledge, skills, prompts and context providers."
     ).optional(),
     work: workContribution.describe(
-      "The work destination this extension creates issues, pages or messages in. Needs the `work:create` and `work:sync` scopes."
+      "The work destination this extension creates issues, pages or messages in. Needs `review.threads:read` and `work:create`; active comment or status sync also needs `work:sync`."
     ).optional()
   }).strict().describe(
     "What this extension adds to the host. At most 20 UI contributions in total, and a page, tab, widget, row action, marker or settings panel needs the `ui:render` scope."
@@ -745,16 +741,36 @@ var manifestSchema = manifestObject.superRefine((manifest, ctx) => {
     }
   }
   if (contributes.work) {
+    const work = contributes.work;
+    const legacy = isLegacyWork(work);
+    if (!legacy || !granted.has("reviews:read")) {
+      requireScope(
+        "review.threads:read",
+        ["scopes"],
+        "the work destination reads Review threads."
+      );
+    }
     requireScope(
       "work:create",
       ["scopes"],
       "the work destination creates items."
     );
-    requireScope(
-      "work:sync",
-      ["scopes"],
-      "the work destination syncs comments and status."
-    );
+    const comments = typeof work.comments === "string" ? work.comments : work.comments.direction;
+    const status = work.status ? "direction" in work.status ? work.status.direction : "from_provider" : "none";
+    if (comments !== "none" || status !== "none") {
+      requireScope(
+        "work:sync",
+        ["scopes"],
+        "the work destination syncs comments or status."
+      );
+    }
+    if (work.identity === "user") {
+      ctx.addIssue({
+        code: "custom",
+        path: ["contributes", "work", "identity"],
+        message: 'Per-user work identity is not supported. Set identity to "install".'
+      });
+    }
   }
   const needsServer = contributes.connector !== void 0 || (contributes.webhooks?.length ?? 0) > 0 || ai !== void 0 || contributes.work !== void 0 || manifest.server?.procedures !== void 0;
   if (needsServer && !manifest.server?.baseUrl) {
@@ -841,6 +857,45 @@ function validateManifest(value) {
   }));
   return { ok: false, issues };
 }
+function isLegacyWork(work) {
+  return !("auth" in work);
+}
+function workManifestWarnings(manifest) {
+  const work = manifest.contributes.work;
+  if (!work) return [];
+  const warnings = [];
+  if (work.container) {
+    warnings.push({
+      path: "contributes.work.container",
+      message: "Static work containers are deprecated. Resolve containers dynamically with describe_container."
+    });
+  }
+  if (work.fields) {
+    warnings.push({
+      path: "contributes.work.fields",
+      message: "Static work fields are deprecated. Resolve fields dynamically with describe_container."
+    });
+  }
+  if (typeof work.comments === "string") {
+    warnings.push({
+      path: "contributes.work.comments",
+      message: "String work comments are deprecated. Declare direction, supportsEdits: false and supportsDeletes: false."
+    });
+  }
+  if (work.status?.map) {
+    warnings.push({
+      path: "contributes.work.status.map",
+      message: "Static work status maps are deprecated. Resolve statuses dynamically with describe_container."
+    });
+  }
+  if (isLegacyWork(work) && manifest.scopes.some((scope) => scope.key === "reviews:read") && !manifest.scopes.some((scope) => scope.key === "review.threads:read")) {
+    warnings.push({
+      path: "scopes",
+      message: "Using reviews:read for work is deprecated. Add review.threads:read for Review threads; reviews:read grants store-review access."
+    });
+  }
+  return warnings;
+}
 export {
   CARD_KEYS,
   CATEGORIES,
@@ -867,6 +922,7 @@ export {
   sdkMajors,
   slotsForPage,
   uiContributions,
-  validateManifest
+  validateManifest,
+  workManifestWarnings
 };
 //# sourceMappingURL=manifest.mjs.map