@channel.io/app-sdk-core 0.7.3 → 0.9.0

package/dist/extensions/oauth.d.ts

@@ -9,14 +9,25 @@ import { z } from "zod";
  */
 export declare const ParameterCaseSchema: z.ZodEnum<["snake", "camel"]>;
 export type ParameterCase = z.infer<typeof ParameterCaseSchema>;
+export declare const TokenRequestContentTypeSchema: z.ZodEnum<["form", "json"]>;
+export type TokenRequestContentType = z.infer<typeof TokenRequestContentTypeSchema>;
+export declare const OAuthAuthScopeSchema: z.ZodEnum<["channel", "manager"]>;
+export type OAuthAuthScope = z.infer<typeof OAuthAuthScopeSchema>;
 /**
- * OAuth 2.0 configuration schema
+ * OAuth 2.0 provider metadata returned from metadata.getAuthConfig.
+ *
+ * Client credentials are intentionally excluded. AppStore stores and manages
+ * provider client ID/secret separately through Desk APIs/UI.
  */
-export declare const OAuthConfigSchema: z.ZodObject<{
+export declare const OAuthProviderSchema: z.ZodObject<{
+    provider: z.ZodString;
     authorizationUrl: z.ZodString;
     tokenUrl: z.ZodString;
+    refreshTokenUrl: z.ZodOptional<z.ZodString>;
     scopes: z.ZodArray<z.ZodString, "many">;
-    clientId: z.ZodString;
+    providerName: z.ZodString;
+    providerDescription: z.ZodOptional<z.ZodString>;
+    providerIconUrl: z.ZodOptional<z.ZodString>;
     pkceRequired: z.ZodOptional<z.ZodBoolean>;
     additionalParams: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
     /**
@@ -25,24 +36,145 @@ export declare const OAuthConfigSchema: z.ZodObject<{
      * on the authorize URL and token endpoint.
      */
     parameterCase: z.ZodOptional<z.ZodEnum<["snake", "camel"]>>;
+    /**
+     * Token endpoint request body format. Defaults to `"form"` for RFC 6749
+     * providers, but some providers expect JSON bodies.
+     */
+    tokenRequestContentType: z.ZodOptional<z.ZodEnum<["form", "json"]>>;
 }, "strip", z.ZodTypeAny, {
+    provider: string;
     authorizationUrl: string;
     tokenUrl: string;
     scopes: string[];
-    clientId: string;
+    providerName: string;
+    refreshTokenUrl?: string | undefined;
+    providerDescription?: string | undefined;
+    providerIconUrl?: string | undefined;
     pkceRequired?: boolean | undefined;
     additionalParams?: Record<string, string> | undefined;
     parameterCase?: "snake" | "camel" | undefined;
+    tokenRequestContentType?: "form" | "json" | undefined;
 }, {
+    provider: string;
     authorizationUrl: string;
     tokenUrl: string;
     scopes: string[];
-    clientId: string;
+    providerName: string;
+    refreshTokenUrl?: string | undefined;
+    providerDescription?: string | undefined;
+    providerIconUrl?: string | undefined;
     pkceRequired?: boolean | undefined;
     additionalParams?: Record<string, string> | undefined;
     parameterCase?: "snake" | "camel" | undefined;
+    tokenRequestContentType?: "form" | "json" | undefined;
+}>;
+export type OAuthProvider = z.infer<typeof OAuthProviderSchema>;
+/**
+ * Output schema for extension.oauth.metadata.getAuthConfig.
+ */
+export declare const OAuthConfigSchema: z.ZodObject<{
+    authType: z.ZodLiteral<"oauth">;
+    authScope: z.ZodEnum<["channel", "manager"]>;
+    oauthProvider: z.ZodObject<{
+        provider: z.ZodString;
+        authorizationUrl: z.ZodString;
+        tokenUrl: z.ZodString;
+        refreshTokenUrl: z.ZodOptional<z.ZodString>;
+        scopes: z.ZodArray<z.ZodString, "many">;
+        providerName: z.ZodString;
+        providerDescription: z.ZodOptional<z.ZodString>;
+        providerIconUrl: z.ZodOptional<z.ZodString>;
+        pkceRequired: z.ZodOptional<z.ZodBoolean>;
+        additionalParams: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        /**
+         * OAuth standard parameter naming convention. Defaults to `"snake"` (RFC 6749).
+         * Declare `"camel"` when the provider (e.g. Imweb) requires camelCase keys
+         * on the authorize URL and token endpoint.
+         */
+        parameterCase: z.ZodOptional<z.ZodEnum<["snake", "camel"]>>;
+        /**
+         * Token endpoint request body format. Defaults to `"form"` for RFC 6749
+         * providers, but some providers expect JSON bodies.
+         */
+        tokenRequestContentType: z.ZodOptional<z.ZodEnum<["form", "json"]>>;
+    }, "strip", z.ZodTypeAny, {
+        provider: string;
+        authorizationUrl: string;
+        tokenUrl: string;
+        scopes: string[];
+        providerName: string;
+        refreshTokenUrl?: string | undefined;
+        providerDescription?: string | undefined;
+        providerIconUrl?: string | undefined;
+        pkceRequired?: boolean | undefined;
+        additionalParams?: Record<string, string> | undefined;
+        parameterCase?: "snake" | "camel" | undefined;
+        tokenRequestContentType?: "form" | "json" | undefined;
+    }, {
+        provider: string;
+        authorizationUrl: string;
+        tokenUrl: string;
+        scopes: string[];
+        providerName: string;
+        refreshTokenUrl?: string | undefined;
+        providerDescription?: string | undefined;
+        providerIconUrl?: string | undefined;
+        pkceRequired?: boolean | undefined;
+        additionalParams?: Record<string, string> | undefined;
+        parameterCase?: "snake" | "camel" | undefined;
+        tokenRequestContentType?: "form" | "json" | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    authType: "oauth";
+    authScope: "manager" | "channel";
+    oauthProvider: {
+        provider: string;
+        authorizationUrl: string;
+        tokenUrl: string;
+        scopes: string[];
+        providerName: string;
+        refreshTokenUrl?: string | undefined;
+        providerDescription?: string | undefined;
+        providerIconUrl?: string | undefined;
+        pkceRequired?: boolean | undefined;
+        additionalParams?: Record<string, string> | undefined;
+        parameterCase?: "snake" | "camel" | undefined;
+        tokenRequestContentType?: "form" | "json" | undefined;
+    };
+}, {
+    authType: "oauth";
+    authScope: "manager" | "channel";
+    oauthProvider: {
+        provider: string;
+        authorizationUrl: string;
+        tokenUrl: string;
+        scopes: string[];
+        providerName: string;
+        refreshTokenUrl?: string | undefined;
+        providerDescription?: string | undefined;
+        providerIconUrl?: string | undefined;
+        pkceRequired?: boolean | undefined;
+        additionalParams?: Record<string, string> | undefined;
+        parameterCase?: "snake" | "camel" | undefined;
+        tokenRequestContentType?: "form" | "json" | undefined;
+    };
 }>;
 export type OAuthConfig = z.infer<typeof OAuthConfigSchema>;
+/**
+ * Input schema for extension.oauth.validation.validateCredentials.
+ *
+ * AppStore calls this with an empty params object after token exchange and
+ * injects the decrypted access token into context.authToken. accessToken is
+ * kept optional for local test harnesses and older examples.
+ */
+export declare const CredentialValidationInputSchema: z.ZodObject<{
+    accessToken: z.ZodOptional<z.ZodString>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    accessToken: z.ZodOptional<z.ZodString>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    accessToken: z.ZodOptional<z.ZodString>;
+}, z.ZodTypeAny, "passthrough">>;
+export type CredentialValidationInput = z.infer<typeof CredentialValidationInputSchema>;
 /**
  * Credential validation result schema
  */

package/dist/extensions/oauth.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"oauth.d.ts","sourceRoot":"","sources":["../../src/extensions/oauth.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB,+BAA6B,CAAC;AAC9D,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;IAO5B;;;;OAIG;;;;;;;;;;;;;;;;;;EAEH,CAAC;AAEH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE5D;;GAEG;AACH,eAAO,MAAM,gCAAgC;;;;;;;;;;;;EAI3C,CAAC;AAEH,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAC"}
+{"version":3,"file":"oauth.d.ts","sourceRoot":"","sources":["../../src/extensions/oauth.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB,+BAA6B,CAAC;AAC9D,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE,eAAO,MAAM,6BAA6B,6BAA2B,CAAC;AACtE,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAC;AAEpF,eAAO,MAAM,oBAAoB,mCAAiC,CAAC;AACnE,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAElE;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;IAW9B;;;;OAIG;;IAEH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEH,CAAC;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;QAjB5B;;;;WAIG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAYH,CAAC;AAEH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE5D;;;;;;GAMG;AACH,eAAO,MAAM,+BAA+B;;;;;;gCAI5B,CAAC;AAEjB,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAC;AAExF;;GAEG;AACH,eAAO,MAAM,gCAAgC;;;;;;;;;;;;EAI3C,CAAC;AAEH,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAC"}

package/dist/extensions/oauth.js

@@ -8,14 +8,23 @@ import { z } from "zod";
  *   Required by some tenant-aware providers such as Imweb. Applies to both authorize URL and token endpoint.
  */
 export const ParameterCaseSchema = z.enum(["snake", "camel"]);
+export const TokenRequestContentTypeSchema = z.enum(["form", "json"]);
+export const OAuthAuthScopeSchema = z.enum(["channel", "manager"]);
 /**
- * OAuth 2.0 configuration schema
+ * OAuth 2.0 provider metadata returned from metadata.getAuthConfig.
+ *
+ * Client credentials are intentionally excluded. AppStore stores and manages
+ * provider client ID/secret separately through Desk APIs/UI.
  */
-export const OAuthConfigSchema = z.object({
+export const OAuthProviderSchema = z.object({
+    provider: z.string().min(1),
     authorizationUrl: z.string().url(),
     tokenUrl: z.string().url(),
-    scopes: z.array(z.string()),
-    clientId: z.string(),
+    refreshTokenUrl: z.string().url().optional(),
+    scopes: z.array(z.string()).min(1),
+    providerName: z.string().min(1),
+    providerDescription: z.string().optional(),
+    providerIconUrl: z.string().url().optional(),
     pkceRequired: z.boolean().optional(),
     additionalParams: z.record(z.string()).optional(),
     /**
@@ -24,7 +33,32 @@ export const OAuthConfigSchema = z.object({
      * on the authorize URL and token endpoint.
      */
     parameterCase: ParameterCaseSchema.optional(),
+    /**
+     * Token endpoint request body format. Defaults to `"form"` for RFC 6749
+     * providers, but some providers expect JSON bodies.
+     */
+    tokenRequestContentType: TokenRequestContentTypeSchema.optional(),
 });
+/**
+ * Output schema for extension.oauth.metadata.getAuthConfig.
+ */
+export const OAuthConfigSchema = z.object({
+    authType: z.literal("oauth"),
+    authScope: OAuthAuthScopeSchema,
+    oauthProvider: OAuthProviderSchema,
+});
+/**
+ * Input schema for extension.oauth.validation.validateCredentials.
+ *
+ * AppStore calls this with an empty params object after token exchange and
+ * injects the decrypted access token into context.authToken. accessToken is
+ * kept optional for local test harnesses and older examples.
+ */
+export const CredentialValidationInputSchema = z
+    .object({
+    accessToken: z.string().optional(),
+})
+    .passthrough();
 /**
  * Credential validation result schema
  */

package/dist/extensions/oauth.js.map

@@ -1 +1 @@
-{"version":3,"file":"oauth.js","sourceRoot":"","sources":["../../src/extensions/oauth.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;AAG9D;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAClC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAC1B,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC3B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACpC,gBAAgB,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACjD;;;;OAIG;IACH,aAAa,EAAE,mBAAmB,CAAC,QAAQ,EAAE;CAC9C,CAAC,CAAC;AAIH;;GAEG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAAC,CAAC,MAAM,CAAC;IACvD,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE;IAClB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC7B,CAAC,CAAC"}
+{"version":3,"file":"oauth.js","sourceRoot":"","sources":["../../src/extensions/oauth.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;AAG9D,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AAGtE,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;AAGnE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC3B,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAClC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAC1B,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAC5C,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAClC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC/B,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1C,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAC5C,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACpC,gBAAgB,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACjD;;;;OAIG;IACH,aAAa,EAAE,mBAAmB,CAAC,QAAQ,EAAE;IAC7C;;;OAGG;IACH,uBAAuB,EAAE,6BAA6B,CAAC,QAAQ,EAAE;CAClE,CAAC,CAAC;AAGH;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;IAC5B,SAAS,EAAE,oBAAoB;IAC/B,aAAa,EAAE,mBAAmB;CACnC,CAAC,CAAC;AAIH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC;KAC7C,MAAM,CAAC;IACN,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACnC,CAAC;KACD,WAAW,EAAE,CAAC;AAIjB;;GAEG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAAC,CAAC,MAAM,CAAC;IACvD,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE;IAClB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC7B,CAAC,CAAC"}

package/dist/extensions/order.d.ts

@@ -143,8 +143,8 @@ export declare const OrderItemSchema: z.ZodObject<{
         shippingAddressChangeable: boolean;
     }>;
 }, "strip", z.ZodTypeAny, {
-    name: string;
     id: string;
+    name: string;
     state: string;
     amount: number;
     quantity: number;
@@ -162,8 +162,8 @@ export declare const OrderItemSchema: z.ZodObject<{
     deliveredAt?: number | undefined;
     estimatedShipDate?: number | undefined;
 }, {
-    name: string;
     id: string;
+    name: string;
     state: string;
     amount: number;
     quantity: number;
@@ -271,8 +271,8 @@ export declare const OrderSchema: z.ZodObject<{
             shippingAddressChangeable: boolean;
         }>;
     }, "strip", z.ZodTypeAny, {
-        name: string;
         id: string;
+        name: string;
         state: string;
         amount: number;
         quantity: number;
@@ -290,8 +290,8 @@ export declare const OrderSchema: z.ZodObject<{
         deliveredAt?: number | undefined;
         estimatedShipDate?: number | undefined;
     }, {
-        name: string;
         id: string;
+        name: string;
         state: string;
         amount: number;
         quantity: number;
@@ -422,12 +422,12 @@ export declare const OrderSchema: z.ZodObject<{
         extClaimId?: string | undefined;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
-    title: string;
     id: string;
+    title: string;
     createdAt: number;
     items: {
-        name: string;
         id: string;
+        name: string;
         state: string;
         amount: number;
         quantity: number;
@@ -486,12 +486,12 @@ export declare const OrderSchema: z.ZodObject<{
         province?: string | undefined;
     } | undefined;
 }, {
-    title: string;
     id: string;
+    title: string;
     createdAt: number;
     items: {
-        name: string;
         id: string;
+        name: string;
         state: string;
         amount: number;
         quantity: number;

package/dist/types/index.d.ts

@@ -2,4 +2,5 @@ export * from "./context.js";
 export * from "./extension.js";
 export * from "./function.js";
 export * from "./message.js";
+export * from "./native.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC"}

package/dist/types/index.js

@@ -2,4 +2,5 @@ export * from "./context.js";
 export * from "./extension.js";
 export * from "./function.js";
 export * from "./message.js";
+export * from "./native.js";
 //# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC"}