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

package/dist/vite.d.cts

@@ -30,6 +30,12 @@ declare const SCOPES: readonly [{
     readonly description: "Review text, ratings and replies";
     readonly requiresSecurityReview: false;
     readonly requiresJustification: false;
+}, {
+    readonly key: "review.threads:read";
+    readonly label: "Read Review threads";
+    readonly description: "Review threads, comments, screenshot descriptors, build context and safe device context";
+    readonly requiresSecurityReview: false;
+    readonly requiresJustification: false;
 }, {
     readonly key: "crashes:read";
     readonly label: "Read crash data";
@@ -93,7 +99,7 @@ declare const SCOPES: readonly [{
 }, {
     readonly key: "work:sync";
     readonly label: "Sync work items";
-    readonly description: "Two-way comments and status on created work items";
+    readonly description: "Sync comments and status on created work items";
     readonly requiresSecurityReview: false;
     readonly requiresJustification: true;
 }, {
@@ -257,6 +263,7 @@ interface CredentialField {
     options?: string[];
     help?: string;
 }
+type OAuthTokenRequestEncoding = 'form' | 'json';
 interface ConnectorAuth {
     method: 'none' | 'api_key' | 'oauth';
     fields?: CredentialField[];
@@ -264,6 +271,8 @@ interface ConnectorAuth {
         authorizationUrl: string;
         tokenUrl: string;
         scopes: string[];
+        /** The token request body encoding. When omitted, uses form encoding. */
+        tokenRequestEncoding?: OAuthTokenRequestEncoding;
     };
 }
 interface DimensionDeclaration {
@@ -345,26 +354,53 @@ interface AiContribution {
     prompts?: PromptDeclaration[];
     context?: ContextDeclaration[];
 }
+type WorkDirection = 'none' | 'to_provider' | 'from_provider' | 'two-way';
+type WorkAuth = {
+    method: 'oauth';
+    provider: string;
+    scopes: string[];
+} | {
+    method: 'api_key';
+    fields: CredentialField[];
+};
 interface WorkContribution {
     kind: 'tracker' | 'docs' | 'chat';
-    container: {
+    creates: ('issue' | 'page' | 'message')[];
+    identity: 'install' | 'user';
+    comments: 'two-way' | 'none' | {
+        direction: WorkDirection;
+        supportsEdits: false;
+        supportsDeletes: false;
+    };
+    status?: {
+        direction: WorkDirection;
+        webhook?: string;
+        map?: Record<'open' | 'in_progress' | 'done', string[]>;
+    };
+    attachments: ('image' | 'link')[];
+    auth: WorkAuth;
+    /** @deprecated resolved dynamically by describe_container */
+    container?: {
         label: string;
         list: string;
     };
-    creates: ('issue' | 'page' | 'message')[];
-    fields: {
+    /** @deprecated resolved dynamically by describe_container */
+    fields?: {
         priority?: string[];
         labels?: boolean;
         assignee?: boolean;
         required: string[];
     };
-    attachments: ('image' | 'link')[];
+}
+/** @deprecated Migrate to WorkContribution during the SDK v2 compatibility window. */
+interface LegacyWorkContribution extends Omit<WorkContribution, 'auth' | 'container' | 'fields' | 'comments' | 'status'> {
+    container: NonNullable<WorkContribution['container']>;
+    fields: NonNullable<WorkContribution['fields']>;
     comments: 'two-way' | 'none';
     status?: {
         webhook: string;
         map: Record<'open' | 'in_progress' | 'done', string[]>;
     };
-    identity: 'user' | 'install';
 }
 interface ExtensionListing {
     longDescription?: string;
@@ -397,7 +433,7 @@ interface ExtensionManifest {
         connector?: ConnectorContribution;
         webhooks?: WebhookContribution[];
         ai?: AiContribution;
-        work?: WorkContribution;
+        work?: WorkContribution | LegacyWorkContribution;
     };
     server?: {
         baseUrl: string;
@@ -431,4 +467,14 @@ interface TappifyExtensionOptions {
  */
 declare function tappifyExtension(options?: TappifyExtensionOptions): Plugin[];
 
-export { type TappifyExtensionOptions, VIRTUAL_PREFIX, collectEntryStyles, inlineCssImports, tappifyExtension };
+declare const PREVIEW_REMOTE_ENV = "TAPPIFY_PREVIEW_REMOTE";
+type PreviewRemote = {
+    ok: true;
+    url: string;
+} | {
+    ok: false;
+    message: string;
+};
+declare function previewRemote(remote: string | undefined, port: number): PreviewRemote;
+
+export { PREVIEW_REMOTE_ENV, type PreviewRemote, type TappifyExtensionOptions, VIRTUAL_PREFIX, collectEntryStyles, inlineCssImports, previewRemote, tappifyExtension };

package/dist/vite.d.ts

@@ -30,6 +30,12 @@ declare const SCOPES: readonly [{
     readonly description: "Review text, ratings and replies";
     readonly requiresSecurityReview: false;
     readonly requiresJustification: false;
+}, {
+    readonly key: "review.threads:read";
+    readonly label: "Read Review threads";
+    readonly description: "Review threads, comments, screenshot descriptors, build context and safe device context";
+    readonly requiresSecurityReview: false;
+    readonly requiresJustification: false;
 }, {
     readonly key: "crashes:read";
     readonly label: "Read crash data";
@@ -93,7 +99,7 @@ declare const SCOPES: readonly [{
 }, {
     readonly key: "work:sync";
     readonly label: "Sync work items";
-    readonly description: "Two-way comments and status on created work items";
+    readonly description: "Sync comments and status on created work items";
     readonly requiresSecurityReview: false;
     readonly requiresJustification: true;
 }, {
@@ -257,6 +263,7 @@ interface CredentialField {
     options?: string[];
     help?: string;
 }
+type OAuthTokenRequestEncoding = 'form' | 'json';
 interface ConnectorAuth {
     method: 'none' | 'api_key' | 'oauth';
     fields?: CredentialField[];
@@ -264,6 +271,8 @@ interface ConnectorAuth {
         authorizationUrl: string;
         tokenUrl: string;
         scopes: string[];
+        /** The token request body encoding. When omitted, uses form encoding. */
+        tokenRequestEncoding?: OAuthTokenRequestEncoding;
     };
 }
 interface DimensionDeclaration {
@@ -345,26 +354,53 @@ interface AiContribution {
     prompts?: PromptDeclaration[];
     context?: ContextDeclaration[];
 }
+type WorkDirection = 'none' | 'to_provider' | 'from_provider' | 'two-way';
+type WorkAuth = {
+    method: 'oauth';
+    provider: string;
+    scopes: string[];
+} | {
+    method: 'api_key';
+    fields: CredentialField[];
+};
 interface WorkContribution {
     kind: 'tracker' | 'docs' | 'chat';
-    container: {
+    creates: ('issue' | 'page' | 'message')[];
+    identity: 'install' | 'user';
+    comments: 'two-way' | 'none' | {
+        direction: WorkDirection;
+        supportsEdits: false;
+        supportsDeletes: false;
+    };
+    status?: {
+        direction: WorkDirection;
+        webhook?: string;
+        map?: Record<'open' | 'in_progress' | 'done', string[]>;
+    };
+    attachments: ('image' | 'link')[];
+    auth: WorkAuth;
+    /** @deprecated resolved dynamically by describe_container */
+    container?: {
         label: string;
         list: string;
     };
-    creates: ('issue' | 'page' | 'message')[];
-    fields: {
+    /** @deprecated resolved dynamically by describe_container */
+    fields?: {
         priority?: string[];
         labels?: boolean;
         assignee?: boolean;
         required: string[];
     };
-    attachments: ('image' | 'link')[];
+}
+/** @deprecated Migrate to WorkContribution during the SDK v2 compatibility window. */
+interface LegacyWorkContribution extends Omit<WorkContribution, 'auth' | 'container' | 'fields' | 'comments' | 'status'> {
+    container: NonNullable<WorkContribution['container']>;
+    fields: NonNullable<WorkContribution['fields']>;
     comments: 'two-way' | 'none';
     status?: {
         webhook: string;
         map: Record<'open' | 'in_progress' | 'done', string[]>;
     };
-    identity: 'user' | 'install';
 }
 interface ExtensionListing {
     longDescription?: string;
@@ -397,7 +433,7 @@ interface ExtensionManifest {
         connector?: ConnectorContribution;
         webhooks?: WebhookContribution[];
         ai?: AiContribution;
-        work?: WorkContribution;
+        work?: WorkContribution | LegacyWorkContribution;
     };
     server?: {
         baseUrl: string;
@@ -431,4 +467,14 @@ interface TappifyExtensionOptions {
  */
 declare function tappifyExtension(options?: TappifyExtensionOptions): Plugin[];
 
-export { type TappifyExtensionOptions, VIRTUAL_PREFIX, collectEntryStyles, inlineCssImports, tappifyExtension };
+declare const PREVIEW_REMOTE_ENV = "TAPPIFY_PREVIEW_REMOTE";
+type PreviewRemote = {
+    ok: true;
+    url: string;
+} | {
+    ok: false;
+    message: string;
+};
+declare function previewRemote(remote: string | undefined, port: number): PreviewRemote;
+
+export { PREVIEW_REMOTE_ENV, type PreviewRemote, type TappifyExtensionOptions, VIRTUAL_PREFIX, collectEntryStyles, inlineCssImports, previewRemote, tappifyExtension };