@tappify/extension-sdk 2.0.0

package/dist/vite.d.cts

@@ -0,0 +1,434 @@
+import { Plugin } from 'vite';
+
+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 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 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 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];
+
+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;
+}
+
+declare function collectEntryStyles(entryAbsolutePath: string, root: string): string[];
+declare function inlineCssImports(code: string): string | null;
+
+declare const VIRTUAL_PREFIX = "virtual:tappify-expose/";
+interface TappifyExtensionOptions {
+    manifest?: ExtensionManifest;
+    manifestPath?: string;
+    root?: string;
+    port?: number;
+    onManifestChange?(manifest: ExtensionManifest): void | Promise<void>;
+}
+/**
+ * The Vite plugins that build an extension for the Tappify host.
+ *
+ * `tappifyExtension()` imports `@module-federation/vite`, an optional peer
+ * dependency (~1.16), so a vendor using this entry must install it alongside
+ * the SDK; `tappify extension init` installs it in the scaffolded extension.
+ */
+declare function tappifyExtension(options?: TappifyExtensionOptions): Plugin[];
+
+export { type TappifyExtensionOptions, VIRTUAL_PREFIX, collectEntryStyles, inlineCssImports, tappifyExtension };