@channel.io/app-sdk-core 0.29.0 → 0.31.0

package/dist/extensions/hook.d.ts

@@ -1,5 +1,5 @@
 import { z } from "zod";
-import type { HookConfig as ProtoHookConfig, HookGetHooksOutput as ProtoGetHooksOutput, HookTeamChatMessageCreatedInput as ProtoTeamChatMessageCreatedHookInput, HookTeamChatMessageCreatedResult as ProtoTeamChatMessageCreatedHookResult, HookUserChatOpenedInput as ProtoUserChatOpenedHookInput, HookUserChatOpenedResult as ProtoUserChatOpenedHookResult, HookWebhookConfig as ProtoWebhookConfig, OAuthFlowHookInput as ProtoOAuthFlowHookInput, OAuthFlowHookResult as ProtoOAuthFlowHookResult } from "../gen/channel/app/sdk/v1/extension.js";
+import type { HookConfig as ProtoHookConfig, HookGetHooksOutput as ProtoGetHooksOutput, HookTeamChatMessageCreatedInput as ProtoTeamChatMessageCreatedHookInput, HookTeamChatMessageCreatedResult as ProtoTeamChatMessageCreatedHookResult, HookUserChatOpenedInput as ProtoUserChatOpenedHookInput, HookUserChatOpenedResult as ProtoUserChatOpenedHookResult, HookWebhookConfig as ProtoWebhookConfig, HookWebhookResponse as ProtoWebhookResponse, OAuthFlowHookInput as ProtoOAuthFlowHookInput, OAuthFlowHookResult as ProtoOAuthFlowHookResult } from "../gen/channel/app/sdk/v1/extension.js";
 type ProtoBacked<T extends Proto, Proto> = T;
 /**
  * Hook type returned from extension.hook.metadata.getHooks.
@@ -259,21 +259,188 @@ export declare const TeamChatMessageCreatedHookResultSchema: z.ZodDiscriminatedU
     terminal: true;
 }>]>;
 export type TeamChatMessageCreatedHookResult = ProtoBacked<z.infer<typeof TeamChatMessageCreatedHookResultSchema>, ProtoTeamChatMessageCreatedHookResult>;
+/** Fixed acknowledgement after outbox persistence; it does not report app completion. */
+export declare const WebhookResponseSchema: z.ZodEffects<z.ZodUnion<[z.ZodObject<{
+    contentType: z.ZodEffects<z.ZodString, string, string>;
+    body: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+} & {
+    statusCode: z.ZodUnion<[z.ZodNumber, z.ZodNumber]>;
+}, "strict", z.ZodTypeAny, {
+    statusCode: number;
+    contentType: string;
+    body?: string | undefined;
+}, {
+    statusCode: number;
+    contentType: string;
+    body?: string | undefined;
+}>, z.ZodObject<{
+    contentType: z.ZodEffects<z.ZodString, string, string>;
+} & {
+    statusCode: z.ZodUnion<[z.ZodLiteral<204>, z.ZodLiteral<205>]>;
+    body: z.ZodOptional<z.ZodLiteral<"">>;
+}, "strict", z.ZodTypeAny, {
+    statusCode: 204 | 205;
+    contentType: string;
+    body?: "" | undefined;
+}, {
+    statusCode: 204 | 205;
+    contentType: string;
+    body?: "" | undefined;
+}>]>, {
+    statusCode: number;
+    contentType: string;
+    body?: string | undefined;
+} | {
+    statusCode: 204 | 205;
+    contentType: string;
+    body?: "" | undefined;
+}, {
+    statusCode: number;
+    contentType: string;
+    body?: string | undefined;
+} | {
+    statusCode: 204 | 205;
+    contentType: string;
+    body?: "" | undefined;
+}>;
+export type WebhookResponse = ProtoBacked<z.infer<typeof WebhookResponseSchema>, ProtoWebhookResponse>;
 export declare const WebhookConfigSchema: z.ZodUnion<[z.ZodObject<{
     endpointToken: z.ZodString;
+    response: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodObject<{
+        contentType: z.ZodEffects<z.ZodString, string, string>;
+        body: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    } & {
+        statusCode: z.ZodUnion<[z.ZodNumber, z.ZodNumber]>;
+    }, "strict", z.ZodTypeAny, {
+        statusCode: number;
+        contentType: string;
+        body?: string | undefined;
+    }, {
+        statusCode: number;
+        contentType: string;
+        body?: string | undefined;
+    }>, z.ZodObject<{
+        contentType: z.ZodEffects<z.ZodString, string, string>;
+    } & {
+        statusCode: z.ZodUnion<[z.ZodLiteral<204>, z.ZodLiteral<205>]>;
+        body: z.ZodOptional<z.ZodLiteral<"">>;
+    }, "strict", z.ZodTypeAny, {
+        statusCode: 204 | 205;
+        contentType: string;
+        body?: "" | undefined;
+    }, {
+        statusCode: 204 | 205;
+        contentType: string;
+        body?: "" | undefined;
+    }>]>, {
+        statusCode: number;
+        contentType: string;
+        body?: string | undefined;
+    } | {
+        statusCode: 204 | 205;
+        contentType: string;
+        body?: "" | undefined;
+    }, {
+        statusCode: number;
+        contentType: string;
+        body?: string | undefined;
+    } | {
+        statusCode: 204 | 205;
+        contentType: string;
+        body?: "" | undefined;
+    }>>;
     executionScope: z.ZodOptional<z.ZodLiteral<"app">>;
 }, "strict", z.ZodTypeAny, {
     endpointToken: string;
+    response?: {
+        statusCode: number;
+        contentType: string;
+        body?: string | undefined;
+    } | {
+        statusCode: 204 | 205;
+        contentType: string;
+        body?: "" | undefined;
+    } | undefined;
     executionScope?: "app" | undefined;
 }, {
     endpointToken: string;
+    response?: {
+        statusCode: number;
+        contentType: string;
+        body?: string | undefined;
+    } | {
+        statusCode: 204 | 205;
+        contentType: string;
+        body?: "" | undefined;
+    } | undefined;
     executionScope?: "app" | undefined;
 }>, z.ZodObject<{
     executionScope: z.ZodLiteral<"manager">;
+    response: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodObject<{
+        contentType: z.ZodEffects<z.ZodString, string, string>;
+        body: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    } & {
+        statusCode: z.ZodUnion<[z.ZodNumber, z.ZodNumber]>;
+    }, "strict", z.ZodTypeAny, {
+        statusCode: number;
+        contentType: string;
+        body?: string | undefined;
+    }, {
+        statusCode: number;
+        contentType: string;
+        body?: string | undefined;
+    }>, z.ZodObject<{
+        contentType: z.ZodEffects<z.ZodString, string, string>;
+    } & {
+        statusCode: z.ZodUnion<[z.ZodLiteral<204>, z.ZodLiteral<205>]>;
+        body: z.ZodOptional<z.ZodLiteral<"">>;
+    }, "strict", z.ZodTypeAny, {
+        statusCode: 204 | 205;
+        contentType: string;
+        body?: "" | undefined;
+    }, {
+        statusCode: 204 | 205;
+        contentType: string;
+        body?: "" | undefined;
+    }>]>, {
+        statusCode: number;
+        contentType: string;
+        body?: string | undefined;
+    } | {
+        statusCode: 204 | 205;
+        contentType: string;
+        body?: "" | undefined;
+    }, {
+        statusCode: number;
+        contentType: string;
+        body?: string | undefined;
+    } | {
+        statusCode: 204 | 205;
+        contentType: string;
+        body?: "" | undefined;
+    }>>;
 }, "strict", z.ZodTypeAny, {
     executionScope: "manager";
+    response?: {
+        statusCode: number;
+        contentType: string;
+        body?: string | undefined;
+    } | {
+        statusCode: 204 | 205;
+        contentType: string;
+        body?: "" | undefined;
+    } | undefined;
 }, {
     executionScope: "manager";
+    response?: {
+        statusCode: number;
+        contentType: string;
+        body?: string | undefined;
+    } | {
+        statusCode: 204 | 205;
+        contentType: string;
+        body?: "" | undefined;
+    } | undefined;
 }>]>;
 export type WebhookConfig = ProtoBacked<z.infer<typeof WebhookConfigSchema>, ProtoWebhookConfig>;
 /**
@@ -389,19 +556,141 @@ export declare const HookConfigSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObj
     targetId: z.ZodString;
     webhook: z.ZodUnion<[z.ZodObject<{
         endpointToken: z.ZodString;
+        response: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodObject<{
+            contentType: z.ZodEffects<z.ZodString, string, string>;
+            body: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+        } & {
+            statusCode: z.ZodUnion<[z.ZodNumber, z.ZodNumber]>;
+        }, "strict", z.ZodTypeAny, {
+            statusCode: number;
+            contentType: string;
+            body?: string | undefined;
+        }, {
+            statusCode: number;
+            contentType: string;
+            body?: string | undefined;
+        }>, z.ZodObject<{
+            contentType: z.ZodEffects<z.ZodString, string, string>;
+        } & {
+            statusCode: z.ZodUnion<[z.ZodLiteral<204>, z.ZodLiteral<205>]>;
+            body: z.ZodOptional<z.ZodLiteral<"">>;
+        }, "strict", z.ZodTypeAny, {
+            statusCode: 204 | 205;
+            contentType: string;
+            body?: "" | undefined;
+        }, {
+            statusCode: 204 | 205;
+            contentType: string;
+            body?: "" | undefined;
+        }>]>, {
+            statusCode: number;
+            contentType: string;
+            body?: string | undefined;
+        } | {
+            statusCode: 204 | 205;
+            contentType: string;
+            body?: "" | undefined;
+        }, {
+            statusCode: number;
+            contentType: string;
+            body?: string | undefined;
+        } | {
+            statusCode: 204 | 205;
+            contentType: string;
+            body?: "" | undefined;
+        }>>;
         executionScope: z.ZodOptional<z.ZodLiteral<"app">>;
     }, "strict", z.ZodTypeAny, {
         endpointToken: string;
+        response?: {
+            statusCode: number;
+            contentType: string;
+            body?: string | undefined;
+        } | {
+            statusCode: 204 | 205;
+            contentType: string;
+            body?: "" | undefined;
+        } | undefined;
         executionScope?: "app" | undefined;
     }, {
         endpointToken: string;
+        response?: {
+            statusCode: number;
+            contentType: string;
+            body?: string | undefined;
+        } | {
+            statusCode: 204 | 205;
+            contentType: string;
+            body?: "" | undefined;
+        } | undefined;
         executionScope?: "app" | undefined;
     }>, z.ZodObject<{
         executionScope: z.ZodLiteral<"manager">;
+        response: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodObject<{
+            contentType: z.ZodEffects<z.ZodString, string, string>;
+            body: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+        } & {
+            statusCode: z.ZodUnion<[z.ZodNumber, z.ZodNumber]>;
+        }, "strict", z.ZodTypeAny, {
+            statusCode: number;
+            contentType: string;
+            body?: string | undefined;
+        }, {
+            statusCode: number;
+            contentType: string;
+            body?: string | undefined;
+        }>, z.ZodObject<{
+            contentType: z.ZodEffects<z.ZodString, string, string>;
+        } & {
+            statusCode: z.ZodUnion<[z.ZodLiteral<204>, z.ZodLiteral<205>]>;
+            body: z.ZodOptional<z.ZodLiteral<"">>;
+        }, "strict", z.ZodTypeAny, {
+            statusCode: 204 | 205;
+            contentType: string;
+            body?: "" | undefined;
+        }, {
+            statusCode: 204 | 205;
+            contentType: string;
+            body?: "" | undefined;
+        }>]>, {
+            statusCode: number;
+            contentType: string;
+            body?: string | undefined;
+        } | {
+            statusCode: 204 | 205;
+            contentType: string;
+            body?: "" | undefined;
+        }, {
+            statusCode: number;
+            contentType: string;
+            body?: string | undefined;
+        } | {
+            statusCode: 204 | 205;
+            contentType: string;
+            body?: "" | undefined;
+        }>>;
     }, "strict", z.ZodTypeAny, {
         executionScope: "manager";
+        response?: {
+            statusCode: number;
+            contentType: string;
+            body?: string | undefined;
+        } | {
+            statusCode: 204 | 205;
+            contentType: string;
+            body?: "" | undefined;
+        } | undefined;
     }, {
         executionScope: "manager";
+        response?: {
+            statusCode: number;
+            contentType: string;
+            body?: string | undefined;
+        } | {
+            statusCode: 204 | 205;
+            contentType: string;
+            body?: "" | undefined;
+        } | undefined;
     }>]>;
 }, "strict", z.ZodTypeAny, {
     type: "webhook.received";
@@ -409,9 +698,27 @@ export declare const HookConfigSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObj
     targetId: string;
     webhook: {
         endpointToken: string;
+        response?: {
+            statusCode: number;
+            contentType: string;
+            body?: string | undefined;
+        } | {
+            statusCode: 204 | 205;
+            contentType: string;
+            body?: "" | undefined;
+        } | undefined;
         executionScope?: "app" | undefined;
     } | {
         executionScope: "manager";
+        response?: {
+            statusCode: number;
+            contentType: string;
+            body?: string | undefined;
+        } | {
+            statusCode: 204 | 205;
+            contentType: string;
+            body?: "" | undefined;
+        } | undefined;
     };
     systemVersion?: string | undefined;
 }, {
@@ -420,9 +727,27 @@ export declare const HookConfigSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObj
     targetId: string;
     webhook: {
         endpointToken: string;
+        response?: {
+            statusCode: number;
+            contentType: string;
+            body?: string | undefined;
+        } | {
+            statusCode: 204 | 205;
+            contentType: string;
+            body?: "" | undefined;
+        } | undefined;
         executionScope?: "app" | undefined;
     } | {
         executionScope: "manager";
+        response?: {
+            statusCode: number;
+            contentType: string;
+            body?: string | undefined;
+        } | {
+            statusCode: 204 | 205;
+            contentType: string;
+            body?: "" | undefined;
+        } | undefined;
     };
     systemVersion?: string | undefined;
 }>, z.ZodObject<{
@@ -730,19 +1055,141 @@ export declare const GetHooksOutputSchema: z.ZodObject<{
         targetId: z.ZodString;
         webhook: z.ZodUnion<[z.ZodObject<{
             endpointToken: z.ZodString;
+            response: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodObject<{
+                contentType: z.ZodEffects<z.ZodString, string, string>;
+                body: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+            } & {
+                statusCode: z.ZodUnion<[z.ZodNumber, z.ZodNumber]>;
+            }, "strict", z.ZodTypeAny, {
+                statusCode: number;
+                contentType: string;
+                body?: string | undefined;
+            }, {
+                statusCode: number;
+                contentType: string;
+                body?: string | undefined;
+            }>, z.ZodObject<{
+                contentType: z.ZodEffects<z.ZodString, string, string>;
+            } & {
+                statusCode: z.ZodUnion<[z.ZodLiteral<204>, z.ZodLiteral<205>]>;
+                body: z.ZodOptional<z.ZodLiteral<"">>;
+            }, "strict", z.ZodTypeAny, {
+                statusCode: 204 | 205;
+                contentType: string;
+                body?: "" | undefined;
+            }, {
+                statusCode: 204 | 205;
+                contentType: string;
+                body?: "" | undefined;
+            }>]>, {
+                statusCode: number;
+                contentType: string;
+                body?: string | undefined;
+            } | {
+                statusCode: 204 | 205;
+                contentType: string;
+                body?: "" | undefined;
+            }, {
+                statusCode: number;
+                contentType: string;
+                body?: string | undefined;
+            } | {
+                statusCode: 204 | 205;
+                contentType: string;
+                body?: "" | undefined;
+            }>>;
             executionScope: z.ZodOptional<z.ZodLiteral<"app">>;
         }, "strict", z.ZodTypeAny, {
             endpointToken: string;
+            response?: {
+                statusCode: number;
+                contentType: string;
+                body?: string | undefined;
+            } | {
+                statusCode: 204 | 205;
+                contentType: string;
+                body?: "" | undefined;
+            } | undefined;
             executionScope?: "app" | undefined;
         }, {
             endpointToken: string;
+            response?: {
+                statusCode: number;
+                contentType: string;
+                body?: string | undefined;
+            } | {
+                statusCode: 204 | 205;
+                contentType: string;
+                body?: "" | undefined;
+            } | undefined;
             executionScope?: "app" | undefined;
         }>, z.ZodObject<{
             executionScope: z.ZodLiteral<"manager">;
+            response: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodObject<{
+                contentType: z.ZodEffects<z.ZodString, string, string>;
+                body: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+            } & {
+                statusCode: z.ZodUnion<[z.ZodNumber, z.ZodNumber]>;
+            }, "strict", z.ZodTypeAny, {
+                statusCode: number;
+                contentType: string;
+                body?: string | undefined;
+            }, {
+                statusCode: number;
+                contentType: string;
+                body?: string | undefined;
+            }>, z.ZodObject<{
+                contentType: z.ZodEffects<z.ZodString, string, string>;
+            } & {
+                statusCode: z.ZodUnion<[z.ZodLiteral<204>, z.ZodLiteral<205>]>;
+                body: z.ZodOptional<z.ZodLiteral<"">>;
+            }, "strict", z.ZodTypeAny, {
+                statusCode: 204 | 205;
+                contentType: string;
+                body?: "" | undefined;
+            }, {
+                statusCode: 204 | 205;
+                contentType: string;
+                body?: "" | undefined;
+            }>]>, {
+                statusCode: number;
+                contentType: string;
+                body?: string | undefined;
+            } | {
+                statusCode: 204 | 205;
+                contentType: string;
+                body?: "" | undefined;
+            }, {
+                statusCode: number;
+                contentType: string;
+                body?: string | undefined;
+            } | {
+                statusCode: 204 | 205;
+                contentType: string;
+                body?: "" | undefined;
+            }>>;
         }, "strict", z.ZodTypeAny, {
             executionScope: "manager";
+            response?: {
+                statusCode: number;
+                contentType: string;
+                body?: string | undefined;
+            } | {
+                statusCode: 204 | 205;
+                contentType: string;
+                body?: "" | undefined;
+            } | undefined;
         }, {
             executionScope: "manager";
+            response?: {
+                statusCode: number;
+                contentType: string;
+                body?: string | undefined;
+            } | {
+                statusCode: 204 | 205;
+                contentType: string;
+                body?: "" | undefined;
+            } | undefined;
         }>]>;
     }, "strict", z.ZodTypeAny, {
         type: "webhook.received";
@@ -750,9 +1197,27 @@ export declare const GetHooksOutputSchema: z.ZodObject<{
         targetId: string;
         webhook: {
             endpointToken: string;
+            response?: {
+                statusCode: number;
+                contentType: string;
+                body?: string | undefined;
+            } | {
+                statusCode: 204 | 205;
+                contentType: string;
+                body?: "" | undefined;
+            } | undefined;
             executionScope?: "app" | undefined;
         } | {
             executionScope: "manager";
+            response?: {
+                statusCode: number;
+                contentType: string;
+                body?: string | undefined;
+            } | {
+                statusCode: 204 | 205;
+                contentType: string;
+                body?: "" | undefined;
+            } | undefined;
         };
         systemVersion?: string | undefined;
     }, {
@@ -761,9 +1226,27 @@ export declare const GetHooksOutputSchema: z.ZodObject<{
         targetId: string;
         webhook: {
             endpointToken: string;
+            response?: {
+                statusCode: number;
+                contentType: string;
+                body?: string | undefined;
+            } | {
+                statusCode: 204 | 205;
+                contentType: string;
+                body?: "" | undefined;
+            } | undefined;
             executionScope?: "app" | undefined;
         } | {
             executionScope: "manager";
+            response?: {
+                statusCode: number;
+                contentType: string;
+                body?: string | undefined;
+            } | {
+                statusCode: 204 | 205;
+                contentType: string;
+                body?: "" | undefined;
+            } | undefined;
         };
         systemVersion?: string | undefined;
     }>, z.ZodObject<{
@@ -996,9 +1479,27 @@ export declare const GetHooksOutputSchema: z.ZodObject<{
         targetId: string;
         webhook: {
             endpointToken: string;
+            response?: {
+                statusCode: number;
+                contentType: string;
+                body?: string | undefined;
+            } | {
+                statusCode: 204 | 205;
+                contentType: string;
+                body?: "" | undefined;
+            } | undefined;
             executionScope?: "app" | undefined;
         } | {
             executionScope: "manager";
+            response?: {
+                statusCode: number;
+                contentType: string;
+                body?: string | undefined;
+            } | {
+                statusCode: 204 | 205;
+                contentType: string;
+                body?: "" | undefined;
+            } | undefined;
         };
         systemVersion?: string | undefined;
     } | {
@@ -1085,9 +1586,27 @@ export declare const GetHooksOutputSchema: z.ZodObject<{
         targetId: string;
         webhook: {
             endpointToken: string;
+            response?: {
+                statusCode: number;
+                contentType: string;
+                body?: string | undefined;
+            } | {
+                statusCode: 204 | 205;
+                contentType: string;
+                body?: "" | undefined;
+            } | undefined;
             executionScope?: "app" | undefined;
         } | {
             executionScope: "manager";
+            response?: {
+                statusCode: number;
+                contentType: string;
+                body?: string | undefined;
+            } | {
+                statusCode: 204 | 205;
+                contentType: string;
+                body?: "" | undefined;
+            } | undefined;
         };
         systemVersion?: string | undefined;
     } | {
@@ -1176,9 +1695,27 @@ export declare const GetHooksOutputSchema: z.ZodObject<{
         targetId: string;
         webhook: {
             endpointToken: string;
+            response?: {
+                statusCode: number;
+                contentType: string;
+                body?: string | undefined;
+            } | {
+                statusCode: 204 | 205;
+                contentType: string;
+                body?: "" | undefined;
+            } | undefined;
             executionScope?: "app" | undefined;
         } | {
             executionScope: "manager";
+            response?: {
+                statusCode: number;
+                contentType: string;
+                body?: string | undefined;
+            } | {
+                statusCode: 204 | 205;
+                contentType: string;
+                body?: "" | undefined;
+            } | undefined;
         };
         systemVersion?: string | undefined;
     } | {
@@ -1267,9 +1804,27 @@ export declare const GetHooksOutputSchema: z.ZodObject<{
         targetId: string;
         webhook: {
             endpointToken: string;
+            response?: {
+                statusCode: number;
+                contentType: string;
+                body?: string | undefined;
+            } | {
+                statusCode: 204 | 205;
+                contentType: string;
+                body?: "" | undefined;
+            } | undefined;
             executionScope?: "app" | undefined;
         } | {
             executionScope: "manager";
+            response?: {
+                statusCode: number;
+                contentType: string;
+                body?: string | undefined;
+            } | {
+                statusCode: 204 | 205;
+                contentType: string;
+                body?: "" | undefined;
+            } | undefined;
         };
         systemVersion?: string | undefined;
     } | {