@tappify/extension-sdk 2.0.0

package/dist/codegen.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/codegen/generate.ts","../src/client/errors.ts"],"sourcesContent":["import { compile } from 'json-schema-to-typescript';\nimport { dirname, join } from 'node:path';\nimport { TapError } from '../client/errors';\nimport type {\n  CredentialField,\n  ExtensionManifest,\n  JsonSchema,\n} from '../manifest/types';\n\nexport const GENERATED_HEADER = `/* eslint-disable */\n/**\n * Generated by \\`tappify extension types\\`. Do not edit by hand.\n * Re-run the command after changing tappify.extension.json or any schema it points at.\n */`;\n\nexport interface RegistrySnapshot {\n  events: { name: string; payload?: JsonSchema }[];\n}\n\nexport interface GenerateTypesOptions {\n  manifest: ExtensionManifest;\n  registrySnapshot?: RegistrySnapshot;\n  readSchemaFile?(path: string): JsonSchema;\n  /**\n   * The extension root. A `$ref` inside a schema file resolves against that\n   * file's own directory under it, the way the host and the Tap Store read\n   * it; without a root the process directory stands in.\n   */\n  cwd?: string;\n}\n\nconst STYLE = {\n  bracketSpacing: true,\n  printWidth: 80,\n  semi: true,\n  singleQuote: true,\n  tabWidth: 2,\n  trailingComma: 'all',\n  useTabs: false,\n} as const;\n\nfunction pascal(value: string): string {\n  return value\n    .split(/[^A-Za-z0-9]+/)\n    .filter(part => part !== '')\n    .map(part => part.charAt(0).toUpperCase() + part.slice(1))\n    .join('');\n}\n\ninterface Emitter {\n  declare(preferredName: string, schema: JsonSchema): Promise<string>;\n  declarations(): string[];\n}\n\ninterface ResolvedSchema {\n  schema: JsonSchema;\n  /** Where the schema's own nested `$ref`s resolve from. */\n  cwd?: string;\n}\n\nfunction createEmitter(\n  resolveSchema: (schema: JsonSchema) => ResolvedSchema,\n): Emitter {\n  const used = new Set<string>();\n  const blocks: string[] = [];\n\n  return {\n    async declare(preferredName, schema) {\n      let name = pascal(preferredName);\n      let suffix = 2;\n      while (used.has(name)) {\n        name = `${pascal(preferredName)}${String(suffix)}`;\n        suffix += 1;\n      }\n      used.add(name);\n\n      const resolved = resolveSchema(schema);\n      const input: Parameters<typeof compile>[0] = {\n        ...resolved.schema,\n        title: name,\n      };\n\n      const text = await compile(input, name, {\n        bannerComment: '',\n        additionalProperties: false,\n        declareExternallyReferenced: true,\n        enableConstEnums: false,\n        format: true,\n        style: STYLE,\n        unknownAny: true,\n        ...(resolved.cwd === undefined ? {} : { cwd: resolved.cwd }),\n      });\n\n      blocks.push(text.trim());\n      return name;\n    },\n    declarations() {\n      return blocks;\n    },\n  };\n}\n\nfunction credentialSchema(fields: CredentialField[]): JsonSchema {\n  const properties: Record<string, JsonSchema> = {};\n  const required: string[] = [];\n\n  for (const field of fields) {\n    const property: JsonSchema =\n      field.type === 'select' && field.options\n        ? { type: 'string', enum: field.options }\n        : { type: 'string' };\n    if (field.help !== undefined) property.description = field.help;\n    properties[field.name] = property;\n    if (field.required) required.push(field.name);\n  }\n\n  return { type: 'object', properties, required, additionalProperties: false };\n}\n\nexport async function generateTypes(\n  options: GenerateTypesOptions,\n): Promise<string> {\n  const { manifest, registrySnapshot } = options;\n  const contributes = manifest.contributes;\n\n  const resolveSchema = (schema: JsonSchema): ResolvedSchema => {\n    const ref = schema.$ref;\n    if (typeof ref !== 'string' || ref.startsWith('#')) {\n      return { schema, cwd: options.cwd };\n    }\n    if (options.readSchemaFile === undefined) {\n      throw new TapError(\n        'TAP_SCHEMA_UNRESOLVED',\n        `The manifest points at the schema file \"${ref}\", but this call passed no readSchemaFile. Run \\`tappify extension types\\`, which reads schema files from the extension directory, or supply readSchemaFile.`,\n      );\n    }\n    return {\n      schema: options.readSchemaFile(ref),\n      cwd:\n        options.cwd === undefined ? undefined : dirname(join(options.cwd, ref)),\n    };\n  };\n\n  const emitter = createEmitter(resolveSchema);\n  const augmentations: string[] = [];\n\n  const storageEntries = Object.entries(contributes.storage ?? {});\n  if (storageEntries.length > 0) {\n    const lines: string[] = [];\n    for (const [name, collection] of storageEntries) {\n      const typeName = await emitter.declare(name, collection.schema);\n      const kind = collection.singleton === true ? 'singleton' : 'collection';\n      lines.push(\n        `    '${name}': { kind: '${kind}'; scope: '${collection.scope}'; document: ${typeName} };`,\n      );\n    }\n    augmentations.push(`  interface TapStorageMap {\\n${lines.join('\\n')}\\n  }`);\n  }\n\n  const procedureEntries = Object.entries(manifest.server?.procedures ?? {});\n  if (procedureEntries.length > 0) {\n    const lines: string[] = [];\n    for (const [name, declaration] of procedureEntries) {\n      const inputName = await emitter.declare(\n        `${name}Input`,\n        declaration.input,\n      );\n      const outputName = await emitter.declare(\n        `${name}Output`,\n        declaration.output,\n      );\n      lines.push(\n        `    '${name}': { input: ${inputName}; output: ${outputName} };`,\n      );\n    }\n    augmentations.push(\n      `  interface TapProcedureMap {\\n${lines.join('\\n')}\\n  }`,\n    );\n  }\n\n  const actions = contributes.ai?.actions ?? [];\n  if (actions.length > 0) {\n    const lines: string[] = [];\n    for (const action of actions) {\n      const name = await emitter.declare(`${action.id}Input`, action.input);\n      lines.push(`    '${action.id}': { input: ${name} };`);\n    }\n    augmentations.push(`  interface TapActionMap {\\n${lines.join('\\n')}\\n  }`);\n  }\n\n  const tools = contributes.ai?.tools ?? [];\n  if (tools.length > 0) {\n    const lines: string[] = [];\n    for (const tool of tools) {\n      const name = await emitter.declare(`${tool.id}Input`, tool.input);\n      lines.push(`    '${tool.id}': { input: ${name} };`);\n    }\n    augmentations.push(`  interface TapToolMap {\\n${lines.join('\\n')}\\n  }`);\n  }\n\n  const prompts = (contributes.ai?.prompts ?? []).filter(\n    prompt => prompt.input !== undefined,\n  );\n  if (prompts.length > 0) {\n    const lines: string[] = [];\n    for (const prompt of prompts) {\n      const name = await emitter.declare(\n        `${prompt.id}PromptInput`,\n        prompt.input ?? { type: 'object' },\n      );\n      lines.push(`    '${prompt.id}': { input: ${name} };`);\n    }\n    augmentations.push(`  interface TapPromptMap {\\n${lines.join('\\n')}\\n  }`);\n  }\n\n  const webhooks = contributes.webhooks ?? [];\n  if (webhooks.length > 0) {\n    const lines: string[] = [];\n    for (const webhook of webhooks) {\n      const name = await emitter.declare(\n        `${webhook.event}Payload`,\n        webhook.payload,\n      );\n      lines.push(`    '${webhook.event}': ${name};`);\n    }\n    augmentations.push(`  interface TapWebhookMap {\\n${lines.join('\\n')}\\n  }`);\n  }\n\n  if (registrySnapshot !== undefined && registrySnapshot.events.length > 0) {\n    const lines: string[] = [];\n    for (const event of registrySnapshot.events) {\n      const name = await emitter.declare(\n        `${event.name}Event`,\n        event.payload ?? { type: 'object' },\n      );\n      lines.push(`    '${event.name}': ${name};`);\n    }\n    augmentations.push(\n      `  interface TapHostEventMap {\\n${lines.join('\\n')}\\n  }`,\n    );\n  }\n\n  const telemetry = manifest.telemetry ?? [];\n  if (telemetry.length > 0) {\n    const lines = telemetry.map(name => `    '${name}': true;`);\n    augmentations.push(\n      `  interface TapTelemetryEvents {\\n${lines.join('\\n')}\\n  }`,\n    );\n  }\n\n  if (contributes.settings) {\n    const name = await emitter.declare('Settings', contributes.settings.schema);\n    augmentations.push(`  interface TapSettings extends ${name} {}`);\n  }\n\n  const credentialFields = contributes.connector?.auth?.fields ?? [];\n  if (credentialFields.length > 0) {\n    const name = await emitter.declare(\n      'Credentials',\n      credentialSchema(credentialFields),\n    );\n    augmentations.push(`  interface TapCredentials extends ${name} {}`);\n  }\n\n  const declarations = emitter.declarations();\n  const module =\n    augmentations.length === 0\n      ? \"declare module '@tappify/extension-sdk' {}\"\n      : `declare module '@tappify/extension-sdk' {\\n${augmentations.join('\\n\\n')}\\n}`;\n\n  return [\n    GENERATED_HEADER,\n    '',\n    ...(declarations.length > 0 ? [declarations.join('\\n\\n'), ''] : []),\n    module,\n    '',\n    'export {};',\n    '',\n  ].join('\\n');\n}\n","/** Every code a `TapError` the SDK raises carries. */\nexport type TapErrorCode =\n  | 'TAP_OUTSIDE_HOST'\n  | 'TAP_SCOPE_MISSING'\n  | 'TAP_UNKNOWN_COLLECTION'\n  | 'TAP_UNKNOWN_PROCEDURE'\n  | 'TAP_NO_PORTAL'\n  | 'TAP_NO_QUERY_CLIENT'\n  | 'TAP_MANIFEST_INVALID'\n  | 'TAP_ENTRY_MISSING'\n  | 'TAP_STYLES_UNRESOLVED'\n  | 'TAP_SCHEMA_UNRESOLVED'\n  | 'TAP_TOKEN_MISSING'\n  | 'TAP_TOKEN_INVALID'\n  | 'TAP_TOKEN_AUDIENCE'\n  | 'TAP_EVENT_ID_MISSING'\n  | 'TAP_BODY_INVALID'\n  | 'TAP_BODY_TOO_LARGE'\n  | 'TAP_ROUTE_UNKNOWN'\n  | 'TAP_HANDLER_MISSING'\n  | 'TAP_INTERNAL_ERROR'\n  | 'TAP_WEBHOOK_REJECTED'\n  | 'TAP_TEST_TARGET_INVALID';\n\n/**\n * The same codes as `TapErrorCode`, as an array to iterate or check membership\n * against at runtime.\n */\nexport const TAP_ERROR_CODES: readonly TapErrorCode[] = [\n  'TAP_OUTSIDE_HOST',\n  'TAP_SCOPE_MISSING',\n  'TAP_UNKNOWN_COLLECTION',\n  'TAP_UNKNOWN_PROCEDURE',\n  'TAP_NO_PORTAL',\n  'TAP_NO_QUERY_CLIENT',\n  'TAP_MANIFEST_INVALID',\n  'TAP_ENTRY_MISSING',\n  'TAP_STYLES_UNRESOLVED',\n  'TAP_SCHEMA_UNRESOLVED',\n  'TAP_TOKEN_MISSING',\n  'TAP_TOKEN_INVALID',\n  'TAP_TOKEN_AUDIENCE',\n  'TAP_EVENT_ID_MISSING',\n  'TAP_BODY_INVALID',\n  'TAP_BODY_TOO_LARGE',\n  'TAP_ROUTE_UNKNOWN',\n  'TAP_HANDLER_MISSING',\n  'TAP_INTERNAL_ERROR',\n  'TAP_WEBHOOK_REJECTED',\n  'TAP_TEST_TARGET_INVALID',\n];\n\nconst CODE_SET = new Set<string>(TAP_ERROR_CODES);\n\n/**\n * The error the SDK and the host raise when a call cannot be served at all.\n *\n * @remarks\n * The SDK throws it for a mount outside the host (`TAP_OUTSIDE_HOST`), a\n * collection or procedure the manifest does not declare\n * (`TAP_UNKNOWN_COLLECTION`, `TAP_UNKNOWN_PROCEDURE`), a missing portal or query\n * client, a token the server rejected, and a misused testing helper. The host\n * turns a refused read or write into `TAP_SCOPE_MISSING`. Branch on `code`, which\n * is stable; the message is prose and changes. An error your own server raised is\n * a `TapServerError` instead.\n *\n * @example\n * ```tsx\n * import { TapError, TapErrorState, useTapQuery } from '@tappify/extension-sdk';\n *\n * function Revenue() {\n *   const revenue = useTapQuery({\n *     kind: 'revenue',\n *     range: { from: '2026-09-01', to: '2026-09-08' },\n *   });\n *   if (TapError.is(revenue.error) && revenue.error.code === 'TAP_SCOPE_MISSING') {\n *     return <TapErrorState title=\"Revenue is not shared with this extension\" />;\n *   }\n *   return <span>{revenue.data?.mrr ?? 0}</span>;\n * }\n * ```\n */\nexport class TapError extends Error {\n  readonly code: TapErrorCode;\n\n  constructor(code: TapErrorCode, message: string) {\n    super(message);\n    this.name = 'TapError';\n    this.code = code;\n  }\n\n  /**\n   * Narrows an unknown value to a `TapError`, by name and by a code it\n   * recognises, so it holds across module instances.\n   */\n  static is(value: unknown): value is TapError {\n    return (\n      value instanceof Error &&\n      value.name === 'TapError' &&\n      'code' in value &&\n      typeof value.code === 'string' &&\n      CODE_SET.has(value.code)\n    );\n  }\n}\n\n/**\n * The error a vendor server throws to answer a Tappify call with a code and a\n * message the owner sees.\n *\n * @remarks\n * `createTappifyHandler` catches it and answers `{ error: { code, message } }`\n * with `status`, or 400 when no status was given; the host relays both to the\n * calling mount, where they arrive as the `error` of `useTapServer`. Pick a code\n * of your own and keep it stable — the SDK's own codes are `SERVER_ERROR_CODES` —\n * and write the message for the owner, who reads it on screen.\n *\n * @example\n * ```ts\n * import { TapServerError } from '@tappify/extension-sdk/server';\n *\n * function assertRange(days: number) {\n *   if (days > 0) return;\n *   throw new TapServerError(\n *     'RANGE_TOO_SHORT',\n *     'getSummary needs a range of at least one day. Widen the date picker, then retry.',\n *     400,\n *   );\n * }\n * ```\n */\nexport class TapServerError extends Error {\n  readonly code: string;\n  readonly status: number | undefined;\n\n  constructor(code: string, message: string, status?: number) {\n    super(message);\n    this.name = 'TapServerError';\n    this.code = code;\n    this.status = status;\n  }\n\n  /** The wire body the handler answers with, without the status. */\n  toJSON(): { error: { code: string; message: string } } {\n    return { error: { code: this.code, message: this.message } };\n  }\n\n  /**\n   * Narrows an unknown value to a `TapServerError` by name and by carrying a\n   * string `code`, so it holds across module instances.\n   */\n  static is(value: unknown): value is TapServerError {\n    return (\n      value instanceof Error &&\n      value.name === 'TapServerError' &&\n      'code' in value &&\n      typeof value.code === 'string'\n    );\n  }\n}\n"],"mappings":";AAAA,SAAS,eAAe;AACxB,SAAS,SAAS,YAAY;;;AC2BvB,IAAM,kBAA2C;AAAA,EACtD;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAEA,IAAM,WAAW,IAAI,IAAY,eAAe;AA8BzC,IAAM,WAAN,cAAuB,MAAM;AAAA,EAGlC,YAAY,MAAoB,SAAiB;AAC/C,UAAM,OAAO;AACb,SAAK,OAAO;AACZ,SAAK,OAAO;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,OAAO,GAAG,OAAmC;AAC3C,WACE,iBAAiB,SACjB,MAAM,SAAS,cACf,UAAU,SACV,OAAO,MAAM,SAAS,YACtB,SAAS,IAAI,MAAM,IAAI;AAAA,EAE3B;AACF;;;AD/FO,IAAM,mBAAmB;AAAA;AAAA;AAAA;AAAA;AAsBhC,IAAM,QAAQ;AAAA,EACZ,gBAAgB;AAAA,EAChB,YAAY;AAAA,EACZ,MAAM;AAAA,EACN,aAAa;AAAA,EACb,UAAU;AAAA,EACV,eAAe;AAAA,EACf,SAAS;AACX;AAEA,SAAS,OAAO,OAAuB;AACrC,SAAO,MACJ,MAAM,eAAe,EACrB,OAAO,UAAQ,SAAS,EAAE,EAC1B,IAAI,UAAQ,KAAK,OAAO,CAAC,EAAE,YAAY,IAAI,KAAK,MAAM,CAAC,CAAC,EACxD,KAAK,EAAE;AACZ;AAaA,SAAS,cACP,eACS;AACT,QAAM,OAAO,oBAAI,IAAY;AAC7B,QAAM,SAAmB,CAAC;AAE1B,SAAO;AAAA,IACL,MAAM,QAAQ,eAAe,QAAQ;AACnC,UAAI,OAAO,OAAO,aAAa;AAC/B,UAAI,SAAS;AACb,aAAO,KAAK,IAAI,IAAI,GAAG;AACrB,eAAO,GAAG,OAAO,aAAa,CAAC,GAAG,OAAO,MAAM,CAAC;AAChD,kBAAU;AAAA,MACZ;AACA,WAAK,IAAI,IAAI;AAEb,YAAM,WAAW,cAAc,MAAM;AACrC,YAAM,QAAuC;AAAA,QAC3C,GAAG,SAAS;AAAA,QACZ,OAAO;AAAA,MACT;AAEA,YAAM,OAAO,MAAM,QAAQ,OAAO,MAAM;AAAA,QACtC,eAAe;AAAA,QACf,sBAAsB;AAAA,QACtB,6BAA6B;AAAA,QAC7B,kBAAkB;AAAA,QAClB,QAAQ;AAAA,QACR,OAAO;AAAA,QACP,YAAY;AAAA,QACZ,GAAI,SAAS,QAAQ,SAAY,CAAC,IAAI,EAAE,KAAK,SAAS,IAAI;AAAA,MAC5D,CAAC;AAED,aAAO,KAAK,KAAK,KAAK,CAAC;AACvB,aAAO;AAAA,IACT;AAAA,IACA,eAAe;AACb,aAAO;AAAA,IACT;AAAA,EACF;AACF;AAEA,SAAS,iBAAiB,QAAuC;AAC/D,QAAM,aAAyC,CAAC;AAChD,QAAM,WAAqB,CAAC;AAE5B,aAAW,SAAS,QAAQ;AAC1B,UAAM,WACJ,MAAM,SAAS,YAAY,MAAM,UAC7B,EAAE,MAAM,UAAU,MAAM,MAAM,QAAQ,IACtC,EAAE,MAAM,SAAS;AACvB,QAAI,MAAM,SAAS,OAAW,UAAS,cAAc,MAAM;AAC3D,eAAW,MAAM,IAAI,IAAI;AACzB,QAAI,MAAM,SAAU,UAAS,KAAK,MAAM,IAAI;AAAA,EAC9C;AAEA,SAAO,EAAE,MAAM,UAAU,YAAY,UAAU,sBAAsB,MAAM;AAC7E;AAEA,eAAsB,cACpB,SACiB;AACjB,QAAM,EAAE,UAAU,iBAAiB,IAAI;AACvC,QAAM,cAAc,SAAS;AAE7B,QAAM,gBAAgB,CAAC,WAAuC;AAC5D,UAAM,MAAM,OAAO;AACnB,QAAI,OAAO,QAAQ,YAAY,IAAI,WAAW,GAAG,GAAG;AAClD,aAAO,EAAE,QAAQ,KAAK,QAAQ,IAAI;AAAA,IACpC;AACA,QAAI,QAAQ,mBAAmB,QAAW;AACxC,YAAM,IAAI;AAAA,QACR;AAAA,QACA,2CAA2C,GAAG;AAAA,MAChD;AAAA,IACF;AACA,WAAO;AAAA,MACL,QAAQ,QAAQ,eAAe,GAAG;AAAA,MAClC,KACE,QAAQ,QAAQ,SAAY,SAAY,QAAQ,KAAK,QAAQ,KAAK,GAAG,CAAC;AAAA,IAC1E;AAAA,EACF;AAEA,QAAM,UAAU,cAAc,aAAa;AAC3C,QAAM,gBAA0B,CAAC;AAEjC,QAAM,iBAAiB,OAAO,QAAQ,YAAY,WAAW,CAAC,CAAC;AAC/D,MAAI,eAAe,SAAS,GAAG;AAC7B,UAAM,QAAkB,CAAC;AACzB,eAAW,CAAC,MAAM,UAAU,KAAK,gBAAgB;AAC/C,YAAM,WAAW,MAAM,QAAQ,QAAQ,MAAM,WAAW,MAAM;AAC9D,YAAM,OAAO,WAAW,cAAc,OAAO,cAAc;AAC3D,YAAM;AAAA,QACJ,QAAQ,IAAI,eAAe,IAAI,cAAc,WAAW,KAAK,gBAAgB,QAAQ;AAAA,MACvF;AAAA,IACF;AACA,kBAAc,KAAK;AAAA,EAAgC,MAAM,KAAK,IAAI,CAAC;AAAA,IAAO;AAAA,EAC5E;AAEA,QAAM,mBAAmB,OAAO,QAAQ,SAAS,QAAQ,cAAc,CAAC,CAAC;AACzE,MAAI,iBAAiB,SAAS,GAAG;AAC/B,UAAM,QAAkB,CAAC;AACzB,eAAW,CAAC,MAAM,WAAW,KAAK,kBAAkB;AAClD,YAAM,YAAY,MAAM,QAAQ;AAAA,QAC9B,GAAG,IAAI;AAAA,QACP,YAAY;AAAA,MACd;AACA,YAAM,aAAa,MAAM,QAAQ;AAAA,QAC/B,GAAG,IAAI;AAAA,QACP,YAAY;AAAA,MACd;AACA,YAAM;AAAA,QACJ,QAAQ,IAAI,eAAe,SAAS,aAAa,UAAU;AAAA,MAC7D;AAAA,IACF;AACA,kBAAc;AAAA,MACZ;AAAA,EAAkC,MAAM,KAAK,IAAI,CAAC;AAAA;AAAA,IACpD;AAAA,EACF;AAEA,QAAM,UAAU,YAAY,IAAI,WAAW,CAAC;AAC5C,MAAI,QAAQ,SAAS,GAAG;AACtB,UAAM,QAAkB,CAAC;AACzB,eAAW,UAAU,SAAS;AAC5B,YAAM,OAAO,MAAM,QAAQ,QAAQ,GAAG,OAAO,EAAE,SAAS,OAAO,KAAK;AACpE,YAAM,KAAK,QAAQ,OAAO,EAAE,eAAe,IAAI,KAAK;AAAA,IACtD;AACA,kBAAc,KAAK;AAAA,EAA+B,MAAM,KAAK,IAAI,CAAC;AAAA,IAAO;AAAA,EAC3E;AAEA,QAAM,QAAQ,YAAY,IAAI,SAAS,CAAC;AACxC,MAAI,MAAM,SAAS,GAAG;AACpB,UAAM,QAAkB,CAAC;AACzB,eAAW,QAAQ,OAAO;AACxB,YAAM,OAAO,MAAM,QAAQ,QAAQ,GAAG,KAAK,EAAE,SAAS,KAAK,KAAK;AAChE,YAAM,KAAK,QAAQ,KAAK,EAAE,eAAe,IAAI,KAAK;AAAA,IACpD;AACA,kBAAc,KAAK;AAAA,EAA6B,MAAM,KAAK,IAAI,CAAC;AAAA,IAAO;AAAA,EACzE;AAEA,QAAM,WAAW,YAAY,IAAI,WAAW,CAAC,GAAG;AAAA,IAC9C,YAAU,OAAO,UAAU;AAAA,EAC7B;AACA,MAAI,QAAQ,SAAS,GAAG;AACtB,UAAM,QAAkB,CAAC;AACzB,eAAW,UAAU,SAAS;AAC5B,YAAM,OAAO,MAAM,QAAQ;AAAA,QACzB,GAAG,OAAO,EAAE;AAAA,QACZ,OAAO,SAAS,EAAE,MAAM,SAAS;AAAA,MACnC;AACA,YAAM,KAAK,QAAQ,OAAO,EAAE,eAAe,IAAI,KAAK;AAAA,IACtD;AACA,kBAAc,KAAK;AAAA,EAA+B,MAAM,KAAK,IAAI,CAAC;AAAA,IAAO;AAAA,EAC3E;AAEA,QAAM,WAAW,YAAY,YAAY,CAAC;AAC1C,MAAI,SAAS,SAAS,GAAG;AACvB,UAAM,QAAkB,CAAC;AACzB,eAAW,WAAW,UAAU;AAC9B,YAAM,OAAO,MAAM,QAAQ;AAAA,QACzB,GAAG,QAAQ,KAAK;AAAA,QAChB,QAAQ;AAAA,MACV;AACA,YAAM,KAAK,QAAQ,QAAQ,KAAK,MAAM,IAAI,GAAG;AAAA,IAC/C;AACA,kBAAc,KAAK;AAAA,EAAgC,MAAM,KAAK,IAAI,CAAC;AAAA,IAAO;AAAA,EAC5E;AAEA,MAAI,qBAAqB,UAAa,iBAAiB,OAAO,SAAS,GAAG;AACxE,UAAM,QAAkB,CAAC;AACzB,eAAW,SAAS,iBAAiB,QAAQ;AAC3C,YAAM,OAAO,MAAM,QAAQ;AAAA,QACzB,GAAG,MAAM,IAAI;AAAA,QACb,MAAM,WAAW,EAAE,MAAM,SAAS;AAAA,MACpC;AACA,YAAM,KAAK,QAAQ,MAAM,IAAI,MAAM,IAAI,GAAG;AAAA,IAC5C;AACA,kBAAc;AAAA,MACZ;AAAA,EAAkC,MAAM,KAAK,IAAI,CAAC;AAAA;AAAA,IACpD;AAAA,EACF;AAEA,QAAM,YAAY,SAAS,aAAa,CAAC;AACzC,MAAI,UAAU,SAAS,GAAG;AACxB,UAAM,QAAQ,UAAU,IAAI,UAAQ,QAAQ,IAAI,UAAU;AAC1D,kBAAc;AAAA,MACZ;AAAA,EAAqC,MAAM,KAAK,IAAI,CAAC;AAAA;AAAA,IACvD;AAAA,EACF;AAEA,MAAI,YAAY,UAAU;AACxB,UAAM,OAAO,MAAM,QAAQ,QAAQ,YAAY,YAAY,SAAS,MAAM;AAC1E,kBAAc,KAAK,mCAAmC,IAAI,KAAK;AAAA,EACjE;AAEA,QAAM,mBAAmB,YAAY,WAAW,MAAM,UAAU,CAAC;AACjE,MAAI,iBAAiB,SAAS,GAAG;AAC/B,UAAM,OAAO,MAAM,QAAQ;AAAA,MACzB;AAAA,MACA,iBAAiB,gBAAgB;AAAA,IACnC;AACA,kBAAc,KAAK,sCAAsC,IAAI,KAAK;AAAA,EACpE;AAEA,QAAM,eAAe,QAAQ,aAAa;AAC1C,QAAM,SACJ,cAAc,WAAW,IACrB,+CACA;AAAA,EAA8C,cAAc,KAAK,MAAM,CAAC;AAAA;AAE9E,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA,GAAI,aAAa,SAAS,IAAI,CAAC,aAAa,KAAK,MAAM,GAAG,EAAE,IAAI,CAAC;AAAA,IACjE;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,EAAE,KAAK,IAAI;AACb;","names":[]}

package/dist/constants-DJ_KgZpN.d.cts

@@ -0,0 +1,449 @@
+type JsonSchema = Record<string, unknown>;
+type ExtensionVisibility = 'public' | 'unlisted' | 'private';
+type ExtensionInstallScope = 'project' | 'organization';
+interface ScopeEntry {
+    key: ScopeKey;
+    justification?: string;
+}
+interface ProcedureDeclaration {
+    input: JsonSchema;
+    output: JsonSchema;
+    cache?: '1m' | '5m' | '1h';
+    kind?: 'read' | 'write';
+}
+interface StorageCollection {
+    scope: 'user' | 'install' | 'organization';
+    singleton?: boolean;
+    schema: JsonSchema;
+}
+interface PageContribution {
+    id: string;
+    title: string;
+    entry: string;
+    nav?: boolean;
+    mobile?: boolean;
+}
+interface TabContribution {
+    id: string;
+    title: string;
+    entry: string;
+    page: HostPage;
+    mobile?: boolean;
+}
+interface WidgetContribution {
+    id: string;
+    title: string;
+    entry: string;
+    page: HostPage;
+    slot: SlotId;
+    size: '1x1' | '2x1' | '2x2';
+    expandable?: boolean;
+}
+interface SeriesContribution {
+    id: string;
+    label: string;
+    chart: HostChart;
+    metric: string;
+}
+interface BannerContribution {
+    id: string;
+    page: HostPage;
+    event: string;
+}
+interface RowActionContribution {
+    id: string;
+    title: string;
+    table: HostTable;
+    entry: string;
+}
+interface MarkerContribution {
+    id: string;
+    label: string;
+    chart: HostChart | '*';
+    event: string;
+    glyph: string;
+}
+interface SettingsContribution {
+    entry: string;
+    schema: JsonSchema;
+}
+interface CredentialField {
+    name: string;
+    label: string;
+    type: 'text' | 'password' | 'textarea' | 'file' | 'select';
+    required: boolean;
+    options?: string[];
+    help?: string;
+}
+interface ConnectorAuth {
+    method: 'none' | 'api_key' | 'oauth';
+    fields?: CredentialField[];
+    oauth?: {
+        authorizationUrl: string;
+        tokenUrl: string;
+        scopes: string[];
+    };
+}
+interface DimensionDeclaration {
+    key: string;
+    label: string;
+}
+interface MetricDeclaration {
+    key: string;
+    label: string;
+    unit: 'count' | 'ratio' | 'currency' | 'seconds' | 'bytes';
+    kind: 'gauge' | 'counter';
+    dimensions?: DimensionDeclaration[];
+    backfillDays?: number;
+}
+interface ConnectorContribution {
+    auth?: ConnectorAuth;
+    sync?: '5m' | '15m' | '1h' | '6h' | '24h';
+    metrics?: MetricDeclaration[];
+}
+interface WebhookContribution {
+    event: string;
+    as: 'alert' | 'banner' | 'event';
+    payload: JsonSchema;
+}
+interface ToolDeclaration {
+    id: string;
+    description: string;
+    input: JsonSchema;
+    returns: 'comparison' | 'table' | 'series' | 'list' | 'value';
+    cost: 'low' | 'medium' | 'high';
+    cache?: '1m' | '5m' | '1h';
+}
+interface MentionDeclaration {
+    id: string;
+    label: string;
+    list: string;
+}
+interface ActionDeclaration {
+    id: string;
+    description: string;
+    input: JsonSchema;
+    approval: true;
+    reversible: boolean;
+    scope: ScopeKey;
+    estimatesCost?: boolean;
+}
+interface KnowledgeDeclaration {
+    id: string;
+    category: 'metric_definitions' | 'gotchas' | 'setup';
+    file: string;
+}
+interface SkillDeclaration {
+    id: string;
+    name: string;
+    description: string;
+    file: string;
+    tools?: string[];
+}
+interface PromptDeclaration {
+    id: string;
+    title: string;
+    template: string;
+    surfaces: ('chat_suggestion' | 'widget' | 'page' | 'result_card')[];
+    after?: string[];
+    input?: JsonSchema;
+}
+interface ContextDeclaration {
+    id: string;
+    description: string;
+    when: ('turn_start' | 'mention')[];
+    cache?: '1m' | '5m' | '1h';
+}
+interface AiContribution {
+    tools?: ToolDeclaration[];
+    mentions?: MentionDeclaration[];
+    actions?: ActionDeclaration[];
+    knowledge?: KnowledgeDeclaration[];
+    skills?: SkillDeclaration[];
+    prompts?: PromptDeclaration[];
+    context?: ContextDeclaration[];
+}
+interface WorkContribution {
+    kind: 'tracker' | 'docs' | 'chat';
+    container: {
+        label: string;
+        list: string;
+    };
+    creates: ('issue' | 'page' | 'message')[];
+    fields: {
+        priority?: string[];
+        labels?: boolean;
+        assignee?: boolean;
+        required: string[];
+    };
+    attachments: ('image' | 'link')[];
+    comments: 'two-way' | 'none';
+    status?: {
+        webhook: string;
+        map: Record<'open' | 'in_progress' | 'done', string[]>;
+    };
+    identity: 'user' | 'install';
+}
+interface ExtensionListing {
+    longDescription?: string;
+    screenshots?: string[];
+    website?: string;
+    supportUrl?: string;
+    privacyUrl?: string;
+}
+interface ExtensionManifest {
+    $schema?: string;
+    id: string;
+    name: string;
+    description: string;
+    icon: string;
+    category: ExtensionCategory;
+    sdk: string;
+    visibility: ExtensionVisibility;
+    installScope: ExtensionInstallScope;
+    scopes: ScopeEntry[];
+    contributes: {
+        pages?: PageContribution[];
+        tabs?: TabContribution[];
+        widgets?: WidgetContribution[];
+        series?: SeriesContribution[];
+        banners?: BannerContribution[];
+        rowActions?: RowActionContribution[];
+        markers?: MarkerContribution[];
+        settings?: SettingsContribution;
+        storage?: Record<string, StorageCollection>;
+        connector?: ConnectorContribution;
+        webhooks?: WebhookContribution[];
+        ai?: AiContribution;
+        work?: WorkContribution;
+    };
+    server?: {
+        baseUrl: string;
+        sandboxBaseUrl?: string;
+        procedures?: Record<string, ProcedureDeclaration>;
+        events?: HostEventName[];
+    };
+    telemetry?: string[];
+    listing?: ExtensionListing;
+    pricing?: never;
+    score?: never;
+}
+type ExposableKind = 'page' | 'tab' | 'widget' | 'rowAction' | 'settings';
+interface UiContributionRef {
+    kind: ExposableKind;
+    id: string;
+    entry: string;
+    expose: string;
+}
+interface ManifestIssue {
+    path: string;
+    message: string;
+}
+type ManifestValidation = {
+    ok: true;
+    manifest: ExtensionManifest;
+} | {
+    ok: false;
+    issues: ManifestIssue[];
+};
+
+declare const SCOPES: readonly [{
+    readonly key: "ui:render";
+    readonly label: "Render UI";
+    readonly description: "Render the declared pages, tabs, widgets, row actions and settings panel, and open chat with a visible prompt";
+    readonly requiresSecurityReview: false;
+    readonly requiresJustification: false;
+}, {
+    readonly key: "projects:read";
+    readonly label: "Read the project";
+    readonly description: "Project name, platforms and store identity";
+    readonly requiresSecurityReview: false;
+    readonly requiresJustification: false;
+}, {
+    readonly key: "analytics:read";
+    readonly label: "Read analytics";
+    readonly description: "Downloads, impressions, page views and conversion series";
+    readonly requiresSecurityReview: false;
+    readonly requiresJustification: false;
+}, {
+    readonly key: "store.metadata:read";
+    readonly label: "Read store metadata";
+    readonly description: "Listing metadata, keyword set and keyword positions";
+    readonly requiresSecurityReview: false;
+    readonly requiresJustification: false;
+}, {
+    readonly key: "reviews:read";
+    readonly label: "Read store reviews";
+    readonly description: "Review text, ratings and replies";
+    readonly requiresSecurityReview: false;
+    readonly requiresJustification: false;
+}, {
+    readonly key: "crashes:read";
+    readonly label: "Read crash data";
+    readonly description: "Crash-free rate and issue counts";
+    readonly requiresSecurityReview: false;
+    readonly requiresJustification: false;
+}, {
+    readonly key: "revenue:read";
+    readonly label: "Read revenue";
+    readonly description: "MRR, revenue series and refund counts";
+    readonly requiresSecurityReview: false;
+    readonly requiresJustification: true;
+}, {
+    readonly key: "metrics:write";
+    readonly label: "Write connector metrics";
+    readonly description: "Write the metrics this extension declares into the metrics store";
+    readonly requiresSecurityReview: false;
+    readonly requiresJustification: false;
+}, {
+    readonly key: "alerts:write";
+    readonly label: "Raise alerts and banners";
+    readonly description: "Turn declared webhooks into alerts and banners, at most three a day per project";
+    readonly requiresSecurityReview: false;
+    readonly requiresJustification: true;
+}, {
+    readonly key: "insights:write";
+    readonly label: "Post insights";
+    readonly description: "Post insights to Home and to chat";
+    readonly requiresSecurityReview: false;
+    readonly requiresJustification: true;
+}, {
+    readonly key: "ai:tools";
+    readonly label: "Add assistant tools";
+    readonly description: "Offer tools and mentions to the assistant";
+    readonly requiresSecurityReview: false;
+    readonly requiresJustification: false;
+}, {
+    readonly key: "ai:actions";
+    readonly label: "Run assistant actions";
+    readonly description: "Run declared actions, each behind the approval card";
+    readonly requiresSecurityReview: true;
+    readonly requiresJustification: true;
+}, {
+    readonly key: "store.metadata:write";
+    readonly label: "Propose store metadata changes";
+    readonly description: "Propose listing changes through a Tappify approval";
+    readonly requiresSecurityReview: true;
+    readonly requiresJustification: true;
+}, {
+    readonly key: "autopilot:trigger";
+    readonly label: "Trigger automated store actions";
+    readonly description: "Start automated store actions on the owner’s behalf";
+    readonly requiresSecurityReview: true;
+    readonly requiresJustification: true;
+}, {
+    readonly key: "work:create";
+    readonly label: "Create work items";
+    readonly description: "Create issues, pages or messages in the vendor’s system";
+    readonly requiresSecurityReview: false;
+    readonly requiresJustification: true;
+}, {
+    readonly key: "work:sync";
+    readonly label: "Sync work items";
+    readonly description: "Two-way comments and status on created work items";
+    readonly requiresSecurityReview: false;
+    readonly requiresJustification: true;
+}, {
+    readonly key: "storage:write";
+    readonly label: "Use hosted storage";
+    readonly description: "Read and write this extension’s own hosted storage collections";
+    readonly requiresSecurityReview: false;
+    readonly requiresJustification: false;
+}, {
+    readonly key: "messaging:send";
+    readonly label: "Send messages to end users";
+    readonly description: "Send messages or push notifications to the owner’s end users through owner-supplied credentials";
+    readonly requiresSecurityReview: true;
+    readonly requiresJustification: true;
+}, {
+    readonly key: "ai:skills";
+    readonly label: "Shape the assistant";
+    readonly description: "Add skills, prompt templates and context providers that shape the assistant’s behaviour";
+    readonly requiresSecurityReview: false;
+    readonly requiresJustification: true;
+}];
+type ScopeDefinition = (typeof SCOPES)[number];
+/** Every scope an extension can ask for under `scopes` in its manifest. */
+type ScopeKey = ScopeDefinition['key'];
+declare const SCOPE_KEYS: readonly ScopeKey[];
+declare const SLOTS: readonly ["kpi-row", "insights", "sidebar", "below-chart", "below-list"];
+/** The anchors on a host page a widget can be declared at. */
+type SlotId = (typeof SLOTS)[number];
+declare const CHARTS: readonly ["installs-activity", "conversion", "release-cadence"];
+type HostChart = (typeof CHARTS)[number];
+declare const PAGES: readonly [{
+    readonly key: "overview";
+    readonly label: "Home";
+    readonly route: "/projects/:id/overview";
+    readonly slots: readonly ["kpi-row", "insights", "sidebar"];
+    readonly charts: readonly ["installs-activity"];
+    readonly tabs: true;
+    readonly banners: true;
+}, {
+    readonly key: "analytics";
+    readonly label: "Analytics";
+    readonly route: "/projects/:id/analytics";
+    readonly slots: readonly ["kpi-row", "below-chart", "sidebar"];
+    readonly charts: readonly ["installs-activity", "conversion"];
+    readonly tabs: true;
+    readonly banners: true;
+}, {
+    readonly key: "deployments";
+    readonly label: "Deployments";
+    readonly route: "/projects/:id/deployments";
+    readonly slots: readonly ["sidebar", "below-list"];
+    readonly charts: readonly ["release-cadence"];
+    readonly tabs: true;
+    readonly banners: false;
+}, {
+    readonly key: "ai_chat";
+    readonly label: "Assistant";
+    readonly route: "chat";
+    readonly slots: readonly [];
+    readonly charts: readonly [];
+    readonly tabs: false;
+    readonly banners: false;
+}];
+type PageDefinition = (typeof PAGES)[number];
+/** The host pages a contribution can attach a tab, widget or banner to. */
+type HostPage = PageDefinition['key'];
+declare const PAGE_KEYS: readonly HostPage[];
+declare const TABLES: readonly [{
+    readonly key: "analytics.keywords";
+    readonly label: "Keywords";
+}, {
+    readonly key: "analytics.reviews";
+    readonly label: "Reviews";
+}, {
+    readonly key: "deployments.releases";
+    readonly label: "Releases";
+}, {
+    readonly key: "deployments.builds";
+    readonly label: "Builds";
+}];
+type TableDefinition = (typeof TABLES)[number];
+type HostTable = TableDefinition['key'];
+declare const TABLE_KEYS: readonly HostTable[];
+declare const KINDS: readonly ["page", "tab", "widget", "series", "banner", "rowAction", "marker", "settings", "storage", "connector", "webhook", "tool", "mention", "action", "knowledge", "skill", "prompt", "context", "work"];
+type ContributionKind = (typeof KINDS)[number];
+declare const CATEGORIES: readonly ["market_data", "subscriptions", "product_analytics", "crashes", "attribution", "experiments", "messaging", "session_replay", "localization", "design", "ci_cd", "trackers", "support", "chat", "ad_monetization", "warehouse", "compliance", "additional_stores"];
+type ExtensionCategory = (typeof CATEGORIES)[number];
+declare const EVENTS: readonly ["release.shipped", "metadata.changed", "keyword.set_changed", "screenshots.updated", "price.changed", "featuring.started", "score.changed", "incident.opened", "incident.resolved", "playbook.step_approved", "review.thread_opened", "review.thread_resolved", "approval.requested", "digest.sent", "install.created", "install.paused", "install.resumed", "install.revoked", "install.token_rotated", "scopes.changed", "settings.changed"];
+/** Every event Tappify emits, which a mount or a server can subscribe to. */
+type HostEventName = (typeof EVENTS)[number];
+declare const SERVED_SDK_MAJORS: readonly number[];
+/** The `kind` of every read `tap.data.query` accepts, one per scope it needs. */
+type DataQueryKind = 'project' | 'series' | 'keywords' | 'listing' | 'reviews' | 'crashes' | 'revenue';
+declare const QUERY_SCOPES: Record<DataQueryKind, ScopeKey>;
+/**
+ * The keys a tool's answer carries for each `returns` kind it may declare.
+ * `validateToolResponse`, `tappify extension doctor` and the host all read
+ * this one table, so a wrong body fails the same way wherever it is checked.
+ */
+declare const CARD_KEYS: Record<ToolDeclaration['returns'], string[]>;
+declare const findScope: (key: string) => ScopeDefinition | undefined;
+declare const findPage: (key: string) => PageDefinition | undefined;
+declare const findTable: (key: string) => TableDefinition | undefined;
+declare const slotsForPage: (page: string) => readonly SlotId[];
+
+export { TABLES as $, type ActionDeclaration as A, type BannerContribution as B, CARD_KEYS as C, type DataQueryKind as D, type ExtensionManifest as E, type PageDefinition as F, type ProcedureDeclaration as G, type HostEventName as H, type PromptDeclaration as I, type JsonSchema as J, KINDS as K, SCOPES as L, type ManifestValidation as M, SCOPE_KEYS as N, SERVED_SDK_MAJORS as O, PAGES as P, QUERY_SCOPES as Q, type RowActionContribution as R, type ScopeKey as S, SLOTS as T, type UiContributionRef as U, type ScopeDefinition as V, type ScopeEntry as W, type SeriesContribution as X, type SettingsContribution as Y, type SkillDeclaration as Z, type StorageCollection as _, type HostPage as a, TABLE_KEYS as a0, type TabContribution as a1, type TableDefinition as a2, type ToolDeclaration as a3, type WebhookContribution as a4, type WidgetContribution as a5, type WorkContribution as a6, findPage as a7, findScope as a8, findTable as a9, slotsForPage as aa, type SlotId as b, type ExposableKind as c, type AiContribution as d, CATEGORIES as e, CHARTS as f, type ConnectorAuth as g, type ConnectorContribution as h, type ContextDeclaration as i, type ContributionKind as j, type CredentialField as k, type DimensionDeclaration as l, EVENTS as m, type ExtensionCategory as n, type ExtensionInstallScope as o, type ExtensionListing as p, type ExtensionVisibility as q, type HostChart as r, type HostTable as s, type KnowledgeDeclaration as t, type ManifestIssue as u, type MarkerContribution as v, type MentionDeclaration as w, type MetricDeclaration as x, PAGE_KEYS as y, type PageContribution as z };