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

package/dist/vite.mjs

@@ -1,7 +1,7 @@
 // src/vite/plugin.ts
 import { federation } from "@module-federation/vite";
 import { readFileSync as readFileSync2 } from "fs";
-import { resolve as resolve2, sep as sep2 } from "path";
+import { resolve as resolve3, sep as sep2 } from "path";
 
 // src/client/errors.ts
 var TAP_ERROR_CODES = [
@@ -143,6 +143,13 @@ var SCOPES = [
     requiresSecurityReview: false,
     requiresJustification: false
   },
+  {
+    key: "review.threads:read",
+    label: "Read Review threads",
+    description: "Review threads, comments, screenshot descriptors, build context and safe device context",
+    requiresSecurityReview: false,
+    requiresJustification: false
+  },
   {
     key: "crashes:read",
     label: "Read crash data",
@@ -216,7 +223,7 @@ var SCOPES = [
   {
     key: "work:sync",
     label: "Sync work items",
-    description: "Two-way comments and status on created work items",
+    description: "Sync comments and status on created work items",
     requiresSecurityReview: false,
     requiresJustification: true
   },
@@ -520,7 +527,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(),
@@ -664,7 +674,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(
@@ -699,6 +709,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(
@@ -790,7 +849,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."
@@ -1011,16 +1070,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) {
@@ -1095,10 +1174,176 @@ function validateManifest(value) {
   }));
   return { ok: false, issues };
 }
+function isLegacyWork(work) {
+  return !("auth" in work);
+}
+
+// src/vite/preview/plugin.ts
+import { randomUUID } from "crypto";
+import { isAbsolute, relative, resolve } from "path";
+import { normalizePath } from "vite";
+var PREVIEW_CLIENT_ID = "virtual:tappify-preview/client";
+var PREVIEW_MANIFEST_ID = "virtual:tappify-preview/manifest";
+var PREVIEW_REMOTE_ID = "virtual:tappify-preview/remote";
+var PREVIEW_REMOTE_ENV = "TAPPIFY_PREVIEW_REMOTE";
+var LOOPBACK_HOSTS = /* @__PURE__ */ new Set(["localhost", "127.0.0.1", "[::1]"]);
+var VIRTUAL_IDS = /* @__PURE__ */ new Set([
+  PREVIEW_CLIENT_ID,
+  PREVIEW_MANIFEST_ID,
+  PREVIEW_REMOTE_ID
+]);
+function previewRemote(remote, port) {
+  if (remote === void 0 || remote.trim() === "") {
+    return { ok: true, url: `http://localhost:${String(port)}/remoteEntry.js` };
+  }
+  let parsed;
+  try {
+    parsed = new URL(remote);
+  } catch {
+    return { ok: false, message: "The preview remote is not a valid URL." };
+  }
+  if (parsed.protocol !== "https:" && !(parsed.protocol === "http:" && LOOPBACK_HOSTS.has(parsed.hostname))) {
+    return {
+      ok: false,
+      message: "A preview remote must use HTTPS or loopback HTTP."
+    };
+  }
+  return { ok: true, url: parsed.toString() };
+}
+var escapeHtml = (value) => value.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&#39;");
+function messageDocument(title2, messages) {
+  return `<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>${escapeHtml(title2)} \xB7 Tappify local preview</title>
+    <style>body{margin:0;min-height:100vh;display:grid;place-content:center;padding:32px;box-sizing:border-box;background:#f4f5ef;color:#142012;font-family:Inter,ui-sans-serif,system-ui,sans-serif}main{max-width:720px;padding:28px;border:1px solid #d8ddcf;border-radius:12px;background:#fff;box-shadow:0 12px 36px rgb(20 32 18 / 9%)}h1{font-size:22px;margin:0 0 14px}ul{margin:0;padding-left:22px;color:#4d5849}li+li{margin-top:8px}</style>
+  </head>
+  <body><main><h1>${escapeHtml(title2)}</h1><ul>${messages.map((message) => `<li>${escapeHtml(message)}</li>`).join("")}</ul></main></body>
+</html>`;
+}
+function previewDocument(manifest, remote) {
+  if (!manifest.ok) {
+    return messageDocument(
+      "Manifest is invalid",
+      manifest.issues.map((issue) => `${issue.path}: ${issue.message}`)
+    );
+  }
+  if (!remote.ok)
+    return messageDocument("Preview remote was refused", [remote.message]);
+  const icon = manifest.manifest.icon.replace(/^\.\//, "");
+  return `<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <link rel="icon" href="/${escapeHtml(icon)}" />
+    <title>${escapeHtml(manifest.manifest.name)} \xB7 Tappify local preview</title>
+  </head>
+  <body>
+    <div id="tappify-preview-root"></div>
+    <script type="module" src="/@id/${PREVIEW_CLIENT_ID}"></script>
+  </body>
+</html>`;
+}
+var moduleSource = (value) => `export default ${JSON.stringify(value)};`;
+function optimizedReactUrl(root, cacheDir, cacheGeneration) {
+  const depsCacheDir = normalizePath(resolve(cacheDir, "deps"));
+  const relativeCacheDir = normalizePath(relative(root, depsCacheDir));
+  const prefix = isAbsolute(relativeCacheDir) || relativeCacheDir.startsWith("../") ? `/@fs/${depsCacheDir.replace(/^\/+/, "")}` : `/${relativeCacheDir}`;
+  return `${prefix}/react.js?tappify=${encodeURIComponent(cacheGeneration)}`;
+}
+function createPreviewPlugins(options) {
+  const remote = previewRemote(options.remote, options.port);
+  const cacheGeneration = randomUUID();
+  let reactUrl = optimizedReactUrl(
+    resolve(options.manifestFile, ".."),
+    resolve(options.manifestFile, "../node_modules/.vite"),
+    cacheGeneration
+  );
+  const preview = {
+    name: "tappify:preview",
+    apply: "serve",
+    config() {
+      return {
+        optimizeDeps: {
+          exclude: ["@tappify/extension-sdk/vite/preview/bootstrap"]
+        }
+      };
+    },
+    configResolved(config) {
+      reactUrl = optimizedReactUrl(
+        config.root,
+        config.cacheDir,
+        cacheGeneration
+      );
+    },
+    resolveId(id) {
+      if (VIRTUAL_IDS.has(id)) return `\0${id}`;
+      if (id.startsWith("\0") && VIRTUAL_IDS.has(id.slice(1))) return id;
+      return null;
+    },
+    load(id) {
+      if (id === `\0${PREVIEW_MANIFEST_ID}`) {
+        return moduleSource(options.loadManifest());
+      }
+      if (id === `\0${PREVIEW_REMOTE_ID}`) return moduleSource(remote);
+      if (id !== `\0${PREVIEW_CLIENT_ID}`) return null;
+      return [
+        `import { startLocalPreview } from '@tappify/extension-sdk/vite/preview/bootstrap';`,
+        `import manifest from '${PREVIEW_MANIFEST_ID}';`,
+        `import remote from '${PREVIEW_REMOTE_ID}';`,
+        `const mount = document.getElementById('tappify-preview-root');`,
+        `if (mount && manifest.ok && remote.ok) void startLocalPreview({ manifest: manifest.manifest, remote: remote.url, reactUrl: ${JSON.stringify(reactUrl)}, mount });`
+      ].join("\n");
+    },
+    configureServer(server) {
+      server.middlewares.use((request, response, next) => {
+        const path = request.url?.split("?", 1)[0];
+        if (path !== "/" && path !== "/index.html") return next();
+        void server.transformIndexHtml(
+          path,
+          previewDocument(options.loadManifest(), remote)
+        ).then((html) => {
+          response.statusCode = 200;
+          response.setHeader("Content-Type", "text/html; charset=utf-8");
+          response.end(html);
+        }).catch(next);
+      });
+    }
+  };
+  const dev = {
+    name: "tappify:dev",
+    apply: "serve",
+    config() {
+      return {
+        server: {
+          host: "127.0.0.1",
+          port: options.port,
+          strictPort: true,
+          cors: { origin: true },
+          origin: `http://localhost:${String(options.port)}`
+        }
+      };
+    },
+    configureServer(server) {
+      server.watcher.add(options.manifestFile);
+    },
+    async hotUpdate(context) {
+      if (this.environment.name !== "client") return;
+      if (context.file !== options.manifestFile) return;
+      const manifest = options.loadManifest();
+      await options.onManifestChange?.(manifest);
+      context.server.ws.send({ type: "full-reload", path: "*" });
+    }
+  };
+  return [preview, dev];
+}
 
 // src/vite/styles.ts
 import { existsSync, readFileSync } from "fs";
-import { dirname, extname, resolve, sep } from "path";
+import { dirname, extname, resolve as resolve2, sep } from "path";
 var IMPORT_PATTERN = /(?:^|\n)\s*(?:import|export)(?:[^'"]*?from\s*)?\s*['"]([^'"]+)['"]/g;
 var IMPORT_SPECIFIER_PATTERN = /((?:^|\n)\s*(?:import|export)(?:[^'"]*?from\s*)?\s*['"])([^'"]+)(['"])/g;
 var BLOCK_COMMENT_PATTERN = /\/\*[\s\S]*?\*\//g;
@@ -1111,14 +1356,14 @@ function isPlainStylesheet(specifier) {
   return specifier.endsWith(".css") && !specifier.endsWith(".module.css");
 }
 function resolveSource(specifier, importer) {
-  const base = resolve(dirname(importer), specifier);
+  const base = resolve2(dirname(importer), specifier);
   if (extname(base) !== "" && existsSync(base)) return base;
   for (const extension of SOURCE_EXTENSIONS) {
     const candidate = `${base}${extension}`;
     if (existsSync(candidate)) return candidate;
   }
   for (const extension of SOURCE_EXTENSIONS) {
-    const candidate = resolve(base, `index${extension}`);
+    const candidate = resolve2(base, `index${extension}`);
     if (existsSync(candidate)) return candidate;
   }
   return null;
@@ -1140,7 +1385,7 @@ function collectEntryStyles(entryAbsolutePath, root) {
     while (match !== null) {
       const specifier = match[1];
       if (specifier.endsWith(".css")) {
-        const value = specifier.startsWith(".") ? resolve(dirname(file), specifier) : specifier;
+        const value = specifier.startsWith(".") ? resolve2(dirname(file), specifier) : specifier;
         if (!seenStyles.has(value)) {
           seenStyles.add(value);
           styles.push(value);
@@ -1173,38 +1418,52 @@ var DEFAULT_PORT = 5273;
 var SOURCE_FILE = /\.(?:[cm]?[jt]sx?)$/;
 var federationOptionsByPlugins = /* @__PURE__ */ new WeakMap();
 function manifestFile(options) {
-  return options.manifestPath ?? resolve2(options.root ?? process.cwd(), "tappify.extension.json");
+  return options.manifestPath ?? resolve3(options.root ?? process.cwd(), "tappify.extension.json");
 }
 function loadManifest(options) {
-  const raw = options.manifest ?? JSON.parse(readFileSync2(manifestFile(options), "utf8"));
-  const result = validateManifest(raw);
-  if (!result.ok) {
-    const lines = result.issues.map((issue) => `  ${issue.path}: ${issue.message}`).join("\n");
-    throw new TapError(
-      "TAP_MANIFEST_INVALID",
-      `tappify.extension.json does not validate:
+  let raw;
+  try {
+    raw = options.manifest ?? JSON.parse(readFileSync2(manifestFile(options), "utf8"));
+  } catch (error) {
+    return {
+      ok: false,
+      issues: [
+        {
+          path: "$",
+          message: error instanceof Error ? `The manifest is not valid JSON: ${error.message}` : "The manifest is not valid JSON."
+        }
+      ]
+    };
+  }
+  return validateManifest(raw);
+}
+function manifestError(result) {
+  if (result.ok) throw new Error("A valid manifest has no validation error.");
+  const lines = result.issues.map((issue) => `  ${issue.path}: ${issue.message}`).join("\n");
+  return new TapError(
+    "TAP_MANIFEST_INVALID",
+    `tappify.extension.json does not validate:
 ${lines}
 Fix the fields above, or run \`tappify extension doctor\` for the same list with suggested fixes.`
-    );
-  }
-  return result.manifest;
+  );
 }
 function tappifyExtension(options = {}) {
   const root = options.root ?? process.cwd();
   const boundary = root.endsWith(sep2) ? root : `${root}${sep2}`;
-  const manifest = loadManifest(options);
-  const contributions = uiContributions(manifest);
+  const loaded = loadManifest(options);
+  const manifest = loaded.ok ? loaded.manifest : null;
+  const contributions = manifest === null ? [] : uiContributions(manifest);
   const port = options.port ?? DEFAULT_PORT;
   const entryByKey = /* @__PURE__ */ new Map();
   const exposes = {};
   for (const contribution of contributions) {
     const key = contribution.expose.slice("./".length);
-    entryByKey.set(key, resolve2(root, contribution.entry));
+    entryByKey.set(key, resolve3(root, contribution.entry));
     exposes[contribution.expose] = `${VIRTUAL_PREFIX}${key}`;
   }
   const singleton = { singleton: true, requiredVersion: false };
   const federationOptions = {
-    name: remoteName(manifest.id),
+    name: remoteName(manifest?.id ?? "invalid-extension"),
     filename: "remoteEntry.js",
     manifest: true,
     exposes,
@@ -1260,6 +1519,16 @@ function tappifyExtension(options = {}) {
       ].join("\n");
     }
   };
+  const guard = {
+    name: "tappify:manifest",
+    enforce: "pre",
+    config(_config, environment) {
+      if (environment.command !== "build") return null;
+      const current = loadManifest(options);
+      if (!current.ok) throw manifestError(current);
+      return null;
+    }
+  };
   const css = {
     name: "tappify:css",
     enforce: "pre",
@@ -1272,43 +1541,32 @@ function tappifyExtension(options = {}) {
       return next === null ? null : { code: next, map: null };
     }
   };
-  const dev = {
-    name: "tappify:dev",
-    apply: "serve",
-    config() {
-      return {
-        server: {
-          port,
-          strictPort: true,
-          cors: { origin: true },
-          origin: `http://localhost:${String(port)}`
-        }
-      };
-    },
-    configureServer(server) {
-      server.watcher.add(manifestFile(options));
-    },
-    /** Vite runs hotUpdate once per dev environment, and the manifest is one file. */
-    async hotUpdate(context) {
-      if (this.environment.name !== "client") return;
-      if (context.file !== manifestFile(options)) return;
-      if (options.onManifestChange === void 0) return;
-      await options.onManifestChange(loadManifest(options));
-    }
-  };
   const plugins = [
+    guard,
     expose,
     css,
     ...federation(federationOptions),
-    dev
+    ...createPreviewPlugins({
+      manifestFile: manifestFile(options),
+      loadManifest: () => loadManifest(options),
+      port,
+      remote: process.env[PREVIEW_REMOTE_ENV],
+      onManifestChange: async (result) => {
+        if (result.ok && options.onManifestChange !== void 0) {
+          await options.onManifestChange(result.manifest);
+        }
+      }
+    })
   ];
   federationOptionsByPlugins.set(plugins, federationOptions);
   return plugins;
 }
 export {
+  PREVIEW_REMOTE_ENV,
   VIRTUAL_PREFIX,
   collectEntryStyles,
   inlineCssImports,
+  previewRemote,
   tappifyExtension
 };
 //# sourceMappingURL=vite.mjs.map