@kya-os/contracts 1.5.3-canary.16 → 1.5.3-canary.18

package/dist/audit/index.d.ts

@@ -65,38 +65,38 @@ export declare const AuditContextSchema: z.ZodObject<{
      */
     scopeId: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
-    identity: {
-        did: string;
-        kid: string;
-    } & {
-        [k: string]: unknown;
-    };
+    requestHash: string;
+    responseHash: string;
     session: {
-        sessionId: string;
         audience: string;
+        sessionId: string;
     } & {
         [k: string]: unknown;
     };
-    requestHash: string;
-    responseHash: string;
     verified: "yes" | "no";
-    scopeId?: string | undefined;
-}, {
     identity: {
         did: string;
         kid: string;
     } & {
         [k: string]: unknown;
     };
+    scopeId?: string | undefined;
+}, {
+    requestHash: string;
+    responseHash: string;
     session: {
-        sessionId: string;
         audience: string;
+        sessionId: string;
     } & {
         [k: string]: unknown;
     };
-    requestHash: string;
-    responseHash: string;
     verified: "yes" | "no";
+    identity: {
+        did: string;
+        kid: string;
+    } & {
+        [k: string]: unknown;
+    };
     scopeId?: string | undefined;
 }>;
 export type AuditContext = {
@@ -153,33 +153,33 @@ export declare const AuditEventContextSchema: z.ZodObject<{
      */
     eventData: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
 }, "strip", z.ZodTypeAny, {
+    session: {
+        audience: string;
+        sessionId: string;
+    } & {
+        [k: string]: unknown;
+    };
     identity: {
         did: string;
         kid: string;
     } & {
         [k: string]: unknown;
     };
+    eventType: string;
+    eventData?: Record<string, unknown> | undefined;
+}, {
     session: {
-        sessionId: string;
         audience: string;
+        sessionId: string;
     } & {
         [k: string]: unknown;
     };
-    eventType: string;
-    eventData?: Record<string, unknown> | undefined;
-}, {
     identity: {
         did: string;
         kid: string;
     } & {
         [k: string]: unknown;
     };
-    session: {
-        sessionId: string;
-        audience: string;
-    } & {
-        [k: string]: unknown;
-    };
     eventType: string;
     eventData?: Record<string, unknown> | undefined;
 }>;

package/dist/config/identity.d.ts

@@ -149,9 +149,9 @@ export declare const OAuthProviderSchema: z.ZodObject<{
     requiresClientSecret: boolean;
     responseType: string;
     grantType: string;
+    scopes?: string[] | undefined;
     clientSecret?: string | null | undefined;
     userInfoUrl?: string | undefined;
-    scopes?: string[] | undefined;
     defaultScopes?: string[] | undefined;
     proxyMode?: boolean | undefined;
     customParams?: Record<string, string> | undefined;
@@ -162,9 +162,9 @@ export declare const OAuthProviderSchema: z.ZodObject<{
     tokenUrl: string;
     supportsPKCE: boolean;
     requiresClientSecret: boolean;
+    scopes?: string[] | undefined;
     clientSecret?: string | null | undefined;
     userInfoUrl?: string | undefined;
-    scopes?: string[] | undefined;
     defaultScopes?: string[] | undefined;
     proxyMode?: boolean | undefined;
     customParams?: Record<string, string> | undefined;
@@ -199,9 +199,9 @@ export declare const OAuthConfigSchema: z.ZodObject<{
         requiresClientSecret: boolean;
         responseType: string;
         grantType: string;
+        scopes?: string[] | undefined;
         clientSecret?: string | null | undefined;
         userInfoUrl?: string | undefined;
-        scopes?: string[] | undefined;
         defaultScopes?: string[] | undefined;
         proxyMode?: boolean | undefined;
         customParams?: Record<string, string> | undefined;
@@ -212,9 +212,9 @@ export declare const OAuthConfigSchema: z.ZodObject<{
         tokenUrl: string;
         supportsPKCE: boolean;
         requiresClientSecret: boolean;
+        scopes?: string[] | undefined;
         clientSecret?: string | null | undefined;
         userInfoUrl?: string | undefined;
-        scopes?: string[] | undefined;
         defaultScopes?: string[] | undefined;
         proxyMode?: boolean | undefined;
         customParams?: Record<string, string> | undefined;
@@ -231,9 +231,9 @@ export declare const OAuthConfigSchema: z.ZodObject<{
         requiresClientSecret: boolean;
         responseType: string;
         grantType: string;
+        scopes?: string[] | undefined;
         clientSecret?: string | null | undefined;
         userInfoUrl?: string | undefined;
-        scopes?: string[] | undefined;
         defaultScopes?: string[] | undefined;
         proxyMode?: boolean | undefined;
         customParams?: Record<string, string> | undefined;
@@ -246,9 +246,9 @@ export declare const OAuthConfigSchema: z.ZodObject<{
         tokenUrl: string;
         supportsPKCE: boolean;
         requiresClientSecret: boolean;
+        scopes?: string[] | undefined;
         clientSecret?: string | null | undefined;
         userInfoUrl?: string | undefined;
-        scopes?: string[] | undefined;
         defaultScopes?: string[] | undefined;
         proxyMode?: boolean | undefined;
         customParams?: Record<string, string> | undefined;

package/dist/consent/schemas.d.ts

@@ -38,13 +38,13 @@ export declare const consentTermsSchema: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     required: boolean;
     version?: string | undefined;
-    text?: string | undefined;
     url?: string | undefined;
+    text?: string | undefined;
 }, {
-    required?: boolean | undefined;
     version?: string | undefined;
-    text?: string | undefined;
     url?: string | undefined;
+    required?: boolean | undefined;
+    text?: string | undefined;
 }>;
 export type ConsentTerms = z.infer<typeof consentTermsSchema>;
 /**
@@ -82,8 +82,8 @@ export declare const consentCustomFieldSchema: z.ZodEffects<z.ZodObject<{
     pattern: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     type: "text" | "textarea" | "checkbox" | "select";
-    required: boolean;
     name: string;
+    required: boolean;
     label: string;
     options?: {
         value: string;
@@ -93,8 +93,8 @@ export declare const consentCustomFieldSchema: z.ZodEffects<z.ZodObject<{
     pattern?: string | undefined;
 }, {
     type: "text" | "textarea" | "checkbox" | "select";
-    required: boolean;
     name: string;
+    required: boolean;
     label: string;
     options?: {
         value: string;
@@ -104,8 +104,8 @@ export declare const consentCustomFieldSchema: z.ZodEffects<z.ZodObject<{
     pattern?: string | undefined;
 }>, {
     type: "text" | "textarea" | "checkbox" | "select";
-    required: boolean;
     name: string;
+    required: boolean;
     label: string;
     options?: {
         value: string;
@@ -115,8 +115,8 @@ export declare const consentCustomFieldSchema: z.ZodEffects<z.ZodObject<{
     pattern?: string | undefined;
 }, {
     type: "text" | "textarea" | "checkbox" | "select";
-    required: boolean;
     name: string;
+    required: boolean;
     label: string;
     options?: {
         value: string;
@@ -151,13 +151,13 @@ export declare const oauthIdentitySchema: z.ZodObject<{
      */
     name: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
-    provider: string;
     subject: string;
+    provider: string;
     name?: string | undefined;
     email?: string | undefined;
 }, {
-    provider: string;
     subject: string;
+    provider: string;
     name?: string | undefined;
     email?: string | undefined;
 }>;
@@ -197,13 +197,13 @@ export declare const consentPageConfigSchema: z.ZodObject<{
     }, "strip", z.ZodTypeAny, {
         required: boolean;
         version?: string | undefined;
-        text?: string | undefined;
         url?: string | undefined;
+        text?: string | undefined;
     }, {
-        required?: boolean | undefined;
         version?: string | undefined;
-        text?: string | undefined;
         url?: string | undefined;
+        required?: boolean | undefined;
+        text?: string | undefined;
     }>>;
     customFields: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodObject<{
         name: z.ZodString;
@@ -224,8 +224,8 @@ export declare const consentPageConfigSchema: z.ZodObject<{
         pattern: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         type: "text" | "textarea" | "checkbox" | "select";
-        required: boolean;
         name: string;
+        required: boolean;
         label: string;
         options?: {
             value: string;
@@ -235,8 +235,8 @@ export declare const consentPageConfigSchema: z.ZodObject<{
         pattern?: string | undefined;
     }, {
         type: "text" | "textarea" | "checkbox" | "select";
-        required: boolean;
         name: string;
+        required: boolean;
         label: string;
         options?: {
             value: string;
@@ -246,8 +246,8 @@ export declare const consentPageConfigSchema: z.ZodObject<{
         pattern?: string | undefined;
     }>, {
         type: "text" | "textarea" | "checkbox" | "select";
-        required: boolean;
         name: string;
+        required: boolean;
         label: string;
         options?: {
             value: string;
@@ -257,8 +257,8 @@ export declare const consentPageConfigSchema: z.ZodObject<{
         pattern?: string | undefined;
     }, {
         type: "text" | "textarea" | "checkbox" | "select";
-        required: boolean;
         name: string;
+        required: boolean;
         label: string;
         options?: {
             value: string;
@@ -269,14 +269,24 @@ export declare const consentPageConfigSchema: z.ZodObject<{
     }>, "many">>;
     serverUrl: z.ZodString;
     autoClose: z.ZodOptional<z.ZodBoolean>;
+    /**
+     * Whether OAuth authorization is required immediately
+     * If true, the consent page will act as a landing page before redirecting
+     */
+    oauthRequired: z.ZodOptional<z.ZodBoolean>;
+    /**
+     * The OAuth authorization URL to redirect to
+     * Required if oauthRequired is true
+     */
+    oauthUrl: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     agentDid: string;
-    serverUrl: string;
-    projectId: string;
+    sessionId: string;
     tool: string;
-    toolDescription: string;
     scopes: string[];
-    sessionId: string;
+    projectId: string;
+    toolDescription: string;
+    serverUrl: string;
     provider?: string | undefined;
     branding?: {
         primaryColor?: string | undefined;
@@ -287,13 +297,13 @@ export declare const consentPageConfigSchema: z.ZodObject<{
     terms?: {
         required: boolean;
         version?: string | undefined;
-        text?: string | undefined;
         url?: string | undefined;
+        text?: string | undefined;
     } | undefined;
     customFields?: {
         type: "text" | "textarea" | "checkbox" | "select";
-        required: boolean;
         name: string;
+        required: boolean;
         label: string;
         options?: {
             value: string;
@@ -303,14 +313,16 @@ export declare const consentPageConfigSchema: z.ZodObject<{
         pattern?: string | undefined;
     }[] | undefined;
     autoClose?: boolean | undefined;
+    oauthRequired?: boolean | undefined;
+    oauthUrl?: string | undefined;
 }, {
     agentDid: string;
-    serverUrl: string;
-    projectId: string;
+    sessionId: string;
     tool: string;
-    toolDescription: string;
     scopes: string[];
-    sessionId: string;
+    projectId: string;
+    toolDescription: string;
+    serverUrl: string;
     provider?: string | undefined;
     branding?: {
         primaryColor?: string | undefined;
@@ -319,15 +331,15 @@ export declare const consentPageConfigSchema: z.ZodObject<{
         theme?: "light" | "dark" | "auto" | undefined;
     } | undefined;
     terms?: {
-        required?: boolean | undefined;
         version?: string | undefined;
-        text?: string | undefined;
         url?: string | undefined;
+        required?: boolean | undefined;
+        text?: string | undefined;
     } | undefined;
     customFields?: {
         type: "text" | "textarea" | "checkbox" | "select";
-        required: boolean;
         name: string;
+        required: boolean;
         label: string;
         options?: {
             value: string;
@@ -337,6 +349,8 @@ export declare const consentPageConfigSchema: z.ZodObject<{
         pattern?: string | undefined;
     }[] | undefined;
     autoClose?: boolean | undefined;
+    oauthRequired?: boolean | undefined;
+    oauthUrl?: string | undefined;
 }>;
 export type ConsentPageConfig = z.infer<typeof consentPageConfigSchema>;
 /**
@@ -383,13 +397,13 @@ export declare const consentApprovalRequestSchema: z.ZodObject<{
          */
         name: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
-        provider: string;
         subject: string;
+        provider: string;
         name?: string | undefined;
         email?: string | undefined;
     }, {
-        provider: string;
         subject: string;
+        provider: string;
         name?: string | undefined;
         email?: string | undefined;
     }>>>;
@@ -401,32 +415,32 @@ export declare const consentApprovalRequestSchema: z.ZodObject<{
     user_did: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     tool: string;
+    session_id: string;
     scopes: string[];
     agent_did: string;
-    session_id: string;
     project_id: string;
     termsAccepted: boolean;
     customFields?: Record<string, string | boolean> | undefined;
     termsVersion?: string | undefined;
     oauth_identity?: {
-        provider: string;
         subject: string;
+        provider: string;
         name?: string | undefined;
         email?: string | undefined;
     } | null | undefined;
     user_did?: string | undefined;
 }, {
     tool: string;
+    session_id: string;
     scopes: string[];
     agent_did: string;
-    session_id: string;
     project_id: string;
     termsAccepted: boolean;
     customFields?: Record<string, string | boolean> | undefined;
     termsVersion?: string | undefined;
     oauth_identity?: {
-        provider: string;
         subject: string;
+        provider: string;
         name?: string | undefined;
         email?: string | undefined;
     } | null | undefined;
@@ -496,13 +510,13 @@ export declare const consentConfigSchema: z.ZodObject<{
     }, "strip", z.ZodTypeAny, {
         required: boolean;
         version?: string | undefined;
-        text?: string | undefined;
         url?: string | undefined;
+        text?: string | undefined;
     }, {
-        required?: boolean | undefined;
         version?: string | undefined;
-        text?: string | undefined;
         url?: string | undefined;
+        required?: boolean | undefined;
+        text?: string | undefined;
     }>>;
     customFields: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodObject<{
         name: z.ZodString;
@@ -523,8 +537,8 @@ export declare const consentConfigSchema: z.ZodObject<{
         pattern: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         type: "text" | "textarea" | "checkbox" | "select";
-        required: boolean;
         name: string;
+        required: boolean;
         label: string;
         options?: {
             value: string;
@@ -534,8 +548,8 @@ export declare const consentConfigSchema: z.ZodObject<{
         pattern?: string | undefined;
     }, {
         type: "text" | "textarea" | "checkbox" | "select";
-        required: boolean;
         name: string;
+        required: boolean;
         label: string;
         options?: {
             value: string;
@@ -545,8 +559,8 @@ export declare const consentConfigSchema: z.ZodObject<{
         pattern?: string | undefined;
     }>, {
         type: "text" | "textarea" | "checkbox" | "select";
-        required: boolean;
         name: string;
+        required: boolean;
         label: string;
         options?: {
             value: string;
@@ -556,8 +570,8 @@ export declare const consentConfigSchema: z.ZodObject<{
         pattern?: string | undefined;
     }, {
         type: "text" | "textarea" | "checkbox" | "select";
-        required: boolean;
         name: string;
+        required: boolean;
         label: string;
         options?: {
             value: string;
@@ -592,13 +606,13 @@ export declare const consentConfigSchema: z.ZodObject<{
     terms?: {
         required: boolean;
         version?: string | undefined;
-        text?: string | undefined;
         url?: string | undefined;
+        text?: string | undefined;
     } | undefined;
     customFields?: {
         type: "text" | "textarea" | "checkbox" | "select";
-        required: boolean;
         name: string;
+        required: boolean;
         label: string;
         options?: {
             value: string;
@@ -621,15 +635,15 @@ export declare const consentConfigSchema: z.ZodObject<{
         theme?: "light" | "dark" | "auto" | undefined;
     } | undefined;
     terms?: {
-        required?: boolean | undefined;
         version?: string | undefined;
-        text?: string | undefined;
         url?: string | undefined;
+        required?: boolean | undefined;
+        text?: string | undefined;
     } | undefined;
     customFields?: {
         type: "text" | "textarea" | "checkbox" | "select";
-        required: boolean;
         name: string;
+        required: boolean;
         label: string;
         options?: {
             value: string;
@@ -657,12 +671,12 @@ export type ConsentConfig = z.infer<typeof consentConfigSchema>;
  */
 export declare function validateConsentPageConfig(config: unknown): z.SafeParseReturnType<{
     agentDid: string;
-    serverUrl: string;
-    projectId: string;
+    sessionId: string;
     tool: string;
-    toolDescription: string;
     scopes: string[];
-    sessionId: string;
+    projectId: string;
+    toolDescription: string;
+    serverUrl: string;
     provider?: string | undefined;
     branding?: {
         primaryColor?: string | undefined;
@@ -671,15 +685,15 @@ export declare function validateConsentPageConfig(config: unknown): z.SafeParseR
         theme?: "light" | "dark" | "auto" | undefined;
     } | undefined;
     terms?: {
-        required?: boolean | undefined;
         version?: string | undefined;
-        text?: string | undefined;
         url?: string | undefined;
+        required?: boolean | undefined;
+        text?: string | undefined;
     } | undefined;
     customFields?: {
         type: "text" | "textarea" | "checkbox" | "select";
-        required: boolean;
         name: string;
+        required: boolean;
         label: string;
         options?: {
             value: string;
@@ -689,14 +703,16 @@ export declare function validateConsentPageConfig(config: unknown): z.SafeParseR
         pattern?: string | undefined;
     }[] | undefined;
     autoClose?: boolean | undefined;
+    oauthRequired?: boolean | undefined;
+    oauthUrl?: string | undefined;
 }, {
     agentDid: string;
-    serverUrl: string;
-    projectId: string;
+    sessionId: string;
     tool: string;
-    toolDescription: string;
     scopes: string[];
-    sessionId: string;
+    projectId: string;
+    toolDescription: string;
+    serverUrl: string;
     provider?: string | undefined;
     branding?: {
         primaryColor?: string | undefined;
@@ -707,13 +723,13 @@ export declare function validateConsentPageConfig(config: unknown): z.SafeParseR
     terms?: {
         required: boolean;
         version?: string | undefined;
-        text?: string | undefined;
         url?: string | undefined;
+        text?: string | undefined;
     } | undefined;
     customFields?: {
         type: "text" | "textarea" | "checkbox" | "select";
-        required: boolean;
         name: string;
+        required: boolean;
         label: string;
         options?: {
             value: string;
@@ -723,6 +739,8 @@ export declare function validateConsentPageConfig(config: unknown): z.SafeParseR
         pattern?: string | undefined;
     }[] | undefined;
     autoClose?: boolean | undefined;
+    oauthRequired?: boolean | undefined;
+    oauthUrl?: string | undefined;
 }>;
 /**
  * Validate a consent approval request
@@ -732,32 +750,32 @@ export declare function validateConsentPageConfig(config: unknown): z.SafeParseR
  */
 export declare function validateConsentApprovalRequest(request: unknown): z.SafeParseReturnType<{
     tool: string;
+    session_id: string;
     scopes: string[];
     agent_did: string;
-    session_id: string;
     project_id: string;
     termsAccepted: boolean;
     customFields?: Record<string, string | boolean> | undefined;
     termsVersion?: string | undefined;
     oauth_identity?: {
-        provider: string;
         subject: string;
+        provider: string;
         name?: string | undefined;
         email?: string | undefined;
     } | null | undefined;
     user_did?: string | undefined;
 }, {
     tool: string;
+    session_id: string;
     scopes: string[];
     agent_did: string;
-    session_id: string;
     project_id: string;
     termsAccepted: boolean;
     customFields?: Record<string, string | boolean> | undefined;
     termsVersion?: string | undefined;
     oauth_identity?: {
-        provider: string;
         subject: string;
+        provider: string;
         name?: string | undefined;
         email?: string | undefined;
     } | null | undefined;
@@ -796,15 +814,15 @@ export declare function validateConsentConfig(config: unknown): z.SafeParseRetur
         theme?: "light" | "dark" | "auto" | undefined;
     } | undefined;
     terms?: {
-        required?: boolean | undefined;
         version?: string | undefined;
-        text?: string | undefined;
         url?: string | undefined;
+        required?: boolean | undefined;
+        text?: string | undefined;
     } | undefined;
     customFields?: {
         type: "text" | "textarea" | "checkbox" | "select";
-        required: boolean;
         name: string;
+        required: boolean;
         label: string;
         options?: {
             value: string;
@@ -829,13 +847,13 @@ export declare function validateConsentConfig(config: unknown): z.SafeParseRetur
     terms?: {
         required: boolean;
         version?: string | undefined;
-        text?: string | undefined;
         url?: string | undefined;
+        text?: string | undefined;
     } | undefined;
     customFields?: {
         type: "text" | "textarea" | "checkbox" | "select";
-        required: boolean;
         name: string;
+        required: boolean;
         label: string;
         options?: {
             value: string;

package/dist/consent/schemas.js

@@ -150,6 +150,16 @@ exports.consentPageConfigSchema = zod_1.z.object({
         .optional(),
     serverUrl: zod_1.z.string().url("Server URL must be a valid URL"),
     autoClose: zod_1.z.boolean().optional(),
+    /**
+     * Whether OAuth authorization is required immediately
+     * If true, the consent page will act as a landing page before redirecting
+     */
+    oauthRequired: zod_1.z.boolean().optional(),
+    /**
+     * The OAuth authorization URL to redirect to
+     * Required if oauthRequired is true
+     */
+    oauthUrl: zod_1.z.string().url().optional(),
 });
 /**
  * Consent Approval Request Schema