@logto/schemas 1.11.0 → 1.13.0

package/lib/types/application.d.ts

@@ -1,4 +1,5 @@
-import { type z } from 'zod';
+import { UserScope } from '@logto/core-kit';
+import { z } from 'zod';
 import { type Application } from '../db-entries/index.js';
 export type ApplicationResponse = Application & {
     isAdmin: boolean;
@@ -42,6 +43,64 @@ export declare const featuredApplicationGuard: z.ZodObject<Pick<{
         alwaysIssueRefreshToken?: boolean | undefined;
         rotateRefreshToken?: boolean | undefined;
     }>;
+    protectedAppMetadata: z.ZodType<{
+        host: string;
+        origin: string;
+        sessionDuration: number;
+        pageRules: {
+            path: string;
+        }[];
+        customDomains?: {
+            status: import("../index.js").DomainStatus;
+            domain: string;
+            errorMessage: string | null;
+            dnsRecords: {
+                type: string;
+                value: string;
+                name: string;
+            }[];
+            cloudflareData: {
+                status: string;
+                id: string;
+                ssl: {
+                    status: string;
+                    validation_errors?: {
+                        message: string;
+                    }[] | undefined;
+                };
+                verification_errors?: string[] | undefined;
+            } | null;
+        }[] | undefined;
+    } | null, z.ZodTypeDef, {
+        host: string;
+        origin: string;
+        sessionDuration: number;
+        pageRules: {
+            path: string;
+        }[];
+        customDomains?: {
+            status: import("../index.js").DomainStatus;
+            domain: string;
+            errorMessage: string | null;
+            dnsRecords: {
+                type: string;
+                value: string;
+                name: string;
+            }[];
+            cloudflareData: {
+                status: string;
+                id: string;
+                ssl: {
+                    status: string;
+                    validation_errors?: {
+                        message: string;
+                    }[] | undefined;
+                };
+                verification_errors?: string[] | undefined;
+            } | null;
+        }[] | undefined;
+    } | null>;
+    isThirdParty: z.ZodType<boolean, z.ZodTypeDef, boolean>;
     createdAt: z.ZodType<number, z.ZodTypeDef, number>;
 }, "type" | "name" | "id">, "strip", z.ZodTypeAny, {
     type: import("../db-entries/custom-types.js").ApplicationType;
@@ -52,3 +111,519 @@ export declare const featuredApplicationGuard: z.ZodObject<Pick<{
     name: string;
     id: string;
 }>;
+export declare const applicationCreateGuard: z.ZodObject<{
+    description: z.ZodOptional<z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>>;
+    oidcClientMetadata: z.ZodOptional<z.ZodType<{
+        redirectUris: string[];
+        postLogoutRedirectUris: string[];
+        logoUri?: string | undefined;
+    }, z.ZodTypeDef, {
+        redirectUris: string[];
+        postLogoutRedirectUris: string[];
+        logoUri?: string | undefined;
+    }>>;
+    customClientMetadata: z.ZodOptional<z.ZodOptional<z.ZodType<{
+        corsAllowedOrigins?: string[] | undefined;
+        idTokenTtl?: number | undefined;
+        refreshTokenTtl?: number | undefined;
+        refreshTokenTtlInDays?: number | undefined;
+        tenantId?: string | undefined;
+        alwaysIssueRefreshToken?: boolean | undefined;
+        rotateRefreshToken?: boolean | undefined;
+    }, z.ZodTypeDef, {
+        corsAllowedOrigins?: string[] | undefined;
+        idTokenTtl?: number | undefined;
+        refreshTokenTtl?: number | undefined;
+        refreshTokenTtlInDays?: number | undefined;
+        tenantId?: string | undefined;
+        alwaysIssueRefreshToken?: boolean | undefined;
+        rotateRefreshToken?: boolean | undefined;
+    }>>>;
+    protectedAppMetadata: z.ZodOptional<z.ZodOptional<z.ZodType<{
+        host: string;
+        origin: string;
+        sessionDuration: number;
+        pageRules: {
+            path: string;
+        }[];
+        customDomains?: {
+            status: import("../index.js").DomainStatus;
+            domain: string;
+            errorMessage: string | null;
+            dnsRecords: {
+                type: string;
+                value: string;
+                name: string;
+            }[];
+            cloudflareData: {
+                status: string;
+                id: string;
+                ssl: {
+                    status: string;
+                    validation_errors?: {
+                        message: string;
+                    }[] | undefined;
+                };
+                verification_errors?: string[] | undefined;
+            } | null;
+        }[] | undefined;
+    } | null, z.ZodTypeDef, {
+        host: string;
+        origin: string;
+        sessionDuration: number;
+        pageRules: {
+            path: string;
+        }[];
+        customDomains?: {
+            status: import("../index.js").DomainStatus;
+            domain: string;
+            errorMessage: string | null;
+            dnsRecords: {
+                type: string;
+                value: string;
+                name: string;
+            }[];
+            cloudflareData: {
+                status: string;
+                id: string;
+                ssl: {
+                    status: string;
+                    validation_errors?: {
+                        message: string;
+                    }[] | undefined;
+                };
+                verification_errors?: string[] | undefined;
+            } | null;
+        }[] | undefined;
+    } | null>>>;
+    isThirdParty: z.ZodOptional<z.ZodOptional<z.ZodType<boolean, z.ZodTypeDef, boolean>>>;
+    type: z.ZodType<import("../db-entries/custom-types.js").ApplicationType, z.ZodTypeDef, import("../db-entries/custom-types.js").ApplicationType>;
+    name: z.ZodType<string, z.ZodTypeDef, string>;
+}, "strip", z.ZodTypeAny, {
+    type: import("../db-entries/custom-types.js").ApplicationType;
+    name: string;
+    description?: string | null | undefined;
+    oidcClientMetadata?: {
+        redirectUris: string[];
+        postLogoutRedirectUris: string[];
+        logoUri?: string | undefined;
+    } | undefined;
+    customClientMetadata?: {
+        corsAllowedOrigins?: string[] | undefined;
+        idTokenTtl?: number | undefined;
+        refreshTokenTtl?: number | undefined;
+        refreshTokenTtlInDays?: number | undefined;
+        tenantId?: string | undefined;
+        alwaysIssueRefreshToken?: boolean | undefined;
+        rotateRefreshToken?: boolean | undefined;
+    } | undefined;
+    protectedAppMetadata?: {
+        host: string;
+        origin: string;
+        sessionDuration: number;
+        pageRules: {
+            path: string;
+        }[];
+        customDomains?: {
+            status: import("../index.js").DomainStatus;
+            domain: string;
+            errorMessage: string | null;
+            dnsRecords: {
+                type: string;
+                value: string;
+                name: string;
+            }[];
+            cloudflareData: {
+                status: string;
+                id: string;
+                ssl: {
+                    status: string;
+                    validation_errors?: {
+                        message: string;
+                    }[] | undefined;
+                };
+                verification_errors?: string[] | undefined;
+            } | null;
+        }[] | undefined;
+    } | null | undefined;
+    isThirdParty?: boolean | undefined;
+}, {
+    type: import("../db-entries/custom-types.js").ApplicationType;
+    name: string;
+    description?: string | null | undefined;
+    oidcClientMetadata?: {
+        redirectUris: string[];
+        postLogoutRedirectUris: string[];
+        logoUri?: string | undefined;
+    } | undefined;
+    customClientMetadata?: {
+        corsAllowedOrigins?: string[] | undefined;
+        idTokenTtl?: number | undefined;
+        refreshTokenTtl?: number | undefined;
+        refreshTokenTtlInDays?: number | undefined;
+        tenantId?: string | undefined;
+        alwaysIssueRefreshToken?: boolean | undefined;
+        rotateRefreshToken?: boolean | undefined;
+    } | undefined;
+    protectedAppMetadata?: {
+        host: string;
+        origin: string;
+        sessionDuration: number;
+        pageRules: {
+            path: string;
+        }[];
+        customDomains?: {
+            status: import("../index.js").DomainStatus;
+            domain: string;
+            errorMessage: string | null;
+            dnsRecords: {
+                type: string;
+                value: string;
+                name: string;
+            }[];
+            cloudflareData: {
+                status: string;
+                id: string;
+                ssl: {
+                    status: string;
+                    validation_errors?: {
+                        message: string;
+                    }[] | undefined;
+                };
+                verification_errors?: string[] | undefined;
+            } | null;
+        }[] | undefined;
+    } | null | undefined;
+    isThirdParty?: boolean | undefined;
+}>;
+export declare const applicationPatchGuard: z.ZodObject<Omit<{
+    description: z.ZodOptional<z.ZodOptional<z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>>>;
+    oidcClientMetadata: z.ZodOptional<z.ZodOptional<z.ZodType<{
+        redirectUris: string[];
+        postLogoutRedirectUris: string[];
+        logoUri?: string | undefined;
+    }, z.ZodTypeDef, {
+        redirectUris: string[];
+        postLogoutRedirectUris: string[];
+        logoUri?: string | undefined;
+    }>>>;
+    customClientMetadata: z.ZodOptional<z.ZodOptional<z.ZodOptional<z.ZodType<{
+        corsAllowedOrigins?: string[] | undefined;
+        idTokenTtl?: number | undefined;
+        refreshTokenTtl?: number | undefined;
+        refreshTokenTtlInDays?: number | undefined;
+        tenantId?: string | undefined;
+        alwaysIssueRefreshToken?: boolean | undefined;
+        rotateRefreshToken?: boolean | undefined;
+    }, z.ZodTypeDef, {
+        corsAllowedOrigins?: string[] | undefined;
+        idTokenTtl?: number | undefined;
+        refreshTokenTtl?: number | undefined;
+        refreshTokenTtlInDays?: number | undefined;
+        tenantId?: string | undefined;
+        alwaysIssueRefreshToken?: boolean | undefined;
+        rotateRefreshToken?: boolean | undefined;
+    }>>>>;
+    protectedAppMetadata: z.ZodOptional<z.ZodOptional<z.ZodOptional<z.ZodType<{
+        host: string;
+        origin: string;
+        sessionDuration: number;
+        pageRules: {
+            path: string;
+        }[];
+        customDomains?: {
+            status: import("../index.js").DomainStatus;
+            domain: string;
+            errorMessage: string | null;
+            dnsRecords: {
+                type: string;
+                value: string;
+                name: string;
+            }[];
+            cloudflareData: {
+                status: string;
+                id: string;
+                ssl: {
+                    status: string;
+                    validation_errors?: {
+                        message: string;
+                    }[] | undefined;
+                };
+                verification_errors?: string[] | undefined;
+            } | null;
+        }[] | undefined;
+    } | null, z.ZodTypeDef, {
+        host: string;
+        origin: string;
+        sessionDuration: number;
+        pageRules: {
+            path: string;
+        }[];
+        customDomains?: {
+            status: import("../index.js").DomainStatus;
+            domain: string;
+            errorMessage: string | null;
+            dnsRecords: {
+                type: string;
+                value: string;
+                name: string;
+            }[];
+            cloudflareData: {
+                status: string;
+                id: string;
+                ssl: {
+                    status: string;
+                    validation_errors?: {
+                        message: string;
+                    }[] | undefined;
+                };
+                verification_errors?: string[] | undefined;
+            } | null;
+        }[] | undefined;
+    } | null>>>>;
+    isThirdParty: z.ZodOptional<z.ZodOptional<z.ZodOptional<z.ZodType<boolean, z.ZodTypeDef, boolean>>>>;
+    type: z.ZodOptional<z.ZodType<import("../db-entries/custom-types.js").ApplicationType, z.ZodTypeDef, import("../db-entries/custom-types.js").ApplicationType>>;
+    name: z.ZodOptional<z.ZodType<string, z.ZodTypeDef, string>>;
+}, "type" | "isThirdParty">, "strip", z.ZodTypeAny, {
+    name?: string | undefined;
+    description?: string | null | undefined;
+    oidcClientMetadata?: {
+        redirectUris: string[];
+        postLogoutRedirectUris: string[];
+        logoUri?: string | undefined;
+    } | undefined;
+    customClientMetadata?: {
+        corsAllowedOrigins?: string[] | undefined;
+        idTokenTtl?: number | undefined;
+        refreshTokenTtl?: number | undefined;
+        refreshTokenTtlInDays?: number | undefined;
+        tenantId?: string | undefined;
+        alwaysIssueRefreshToken?: boolean | undefined;
+        rotateRefreshToken?: boolean | undefined;
+    } | undefined;
+    protectedAppMetadata?: {
+        host: string;
+        origin: string;
+        sessionDuration: number;
+        pageRules: {
+            path: string;
+        }[];
+        customDomains?: {
+            status: import("../index.js").DomainStatus;
+            domain: string;
+            errorMessage: string | null;
+            dnsRecords: {
+                type: string;
+                value: string;
+                name: string;
+            }[];
+            cloudflareData: {
+                status: string;
+                id: string;
+                ssl: {
+                    status: string;
+                    validation_errors?: {
+                        message: string;
+                    }[] | undefined;
+                };
+                verification_errors?: string[] | undefined;
+            } | null;
+        }[] | undefined;
+    } | null | undefined;
+}, {
+    name?: string | undefined;
+    description?: string | null | undefined;
+    oidcClientMetadata?: {
+        redirectUris: string[];
+        postLogoutRedirectUris: string[];
+        logoUri?: string | undefined;
+    } | undefined;
+    customClientMetadata?: {
+        corsAllowedOrigins?: string[] | undefined;
+        idTokenTtl?: number | undefined;
+        refreshTokenTtl?: number | undefined;
+        refreshTokenTtlInDays?: number | undefined;
+        tenantId?: string | undefined;
+        alwaysIssueRefreshToken?: boolean | undefined;
+        rotateRefreshToken?: boolean | undefined;
+    } | undefined;
+    protectedAppMetadata?: {
+        host: string;
+        origin: string;
+        sessionDuration: number;
+        pageRules: {
+            path: string;
+        }[];
+        customDomains?: {
+            status: import("../index.js").DomainStatus;
+            domain: string;
+            errorMessage: string | null;
+            dnsRecords: {
+                type: string;
+                value: string;
+                name: string;
+            }[];
+            cloudflareData: {
+                status: string;
+                id: string;
+                ssl: {
+                    status: string;
+                    validation_errors?: {
+                        message: string;
+                    }[] | undefined;
+                };
+                verification_errors?: string[] | undefined;
+            } | null;
+        }[] | undefined;
+    } | null | undefined;
+}>;
+export declare const applicationUserConsentScopesResponseGuard: z.ZodObject<{
+    organizationScopes: z.ZodArray<z.ZodObject<Pick<{
+        tenantId: z.ZodType<string, z.ZodTypeDef, string>;
+        id: z.ZodType<string, z.ZodTypeDef, string>;
+        name: z.ZodType<string, z.ZodTypeDef, string>;
+        description: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+    }, "name" | "id" | "description">, "strip", z.ZodTypeAny, {
+        name: string;
+        id: string;
+        description: string | null;
+    }, {
+        name: string;
+        id: string;
+        description: string | null;
+    }>, "many">;
+    resourceScopes: z.ZodArray<z.ZodObject<{
+        resource: z.ZodObject<Pick<{
+            tenantId: z.ZodType<string, z.ZodTypeDef, string>;
+            id: z.ZodType<string, z.ZodTypeDef, string>;
+            name: z.ZodType<string, z.ZodTypeDef, string>;
+            indicator: z.ZodType<string, z.ZodTypeDef, string>;
+            isDefault: z.ZodType<boolean, z.ZodTypeDef, boolean>;
+            accessTokenTtl: z.ZodType<number, z.ZodTypeDef, number>;
+        }, "name" | "id" | "indicator">, "strip", z.ZodTypeAny, {
+            name: string;
+            id: string;
+            indicator: string;
+        }, {
+            name: string;
+            id: string;
+            indicator: string;
+        }>;
+        scopes: z.ZodArray<z.ZodObject<Pick<{
+            tenantId: z.ZodType<string, z.ZodTypeDef, string>;
+            id: z.ZodType<string, z.ZodTypeDef, string>;
+            resourceId: z.ZodType<string, z.ZodTypeDef, string>;
+            name: z.ZodType<string, z.ZodTypeDef, string>;
+            description: z.ZodType<string, z.ZodTypeDef, string>;
+            createdAt: z.ZodType<number, z.ZodTypeDef, number>;
+        }, "name" | "id" | "description">, "strip", z.ZodTypeAny, {
+            name: string;
+            id: string;
+            description: string;
+        }, {
+            name: string;
+            id: string;
+            description: string;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        resource: {
+            name: string;
+            id: string;
+            indicator: string;
+        };
+        scopes: {
+            name: string;
+            id: string;
+            description: string;
+        }[];
+    }, {
+        resource: {
+            name: string;
+            id: string;
+            indicator: string;
+        };
+        scopes: {
+            name: string;
+            id: string;
+            description: string;
+        }[];
+    }>, "many">;
+    userScopes: z.ZodArray<z.ZodNativeEnum<typeof UserScope>, "many">;
+}, "strip", z.ZodTypeAny, {
+    organizationScopes: {
+        name: string;
+        id: string;
+        description: string | null;
+    }[];
+    resourceScopes: {
+        resource: {
+            name: string;
+            id: string;
+            indicator: string;
+        };
+        scopes: {
+            name: string;
+            id: string;
+            description: string;
+        }[];
+    }[];
+    userScopes: UserScope[];
+}, {
+    organizationScopes: {
+        name: string;
+        id: string;
+        description: string | null;
+    }[];
+    resourceScopes: {
+        resource: {
+            name: string;
+            id: string;
+            indicator: string;
+        };
+        scopes: {
+            name: string;
+            id: string;
+            description: string;
+        }[];
+    }[];
+    userScopes: UserScope[];
+}>;
+export declare enum ApplicationUserConsentScopeType {
+    OrganizationScopes = "organization-scopes",
+    ResourceScopes = "resource-scopes",
+    UserScopes = "user-scopes"
+}
+export type ApplicationUserConsentScopesResponse = z.infer<typeof applicationUserConsentScopesResponseGuard>;
+export declare const applicationSignInExperienceCreateGuard: z.ZodObject<{
+    displayName: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+    branding: z.ZodOptional<z.ZodType<{
+        logoUrl?: string | undefined;
+        darkLogoUrl?: string | undefined;
+        favicon?: string | undefined;
+    }, z.ZodTypeDef, {
+        logoUrl?: string | undefined;
+        darkLogoUrl?: string | undefined;
+        favicon?: string | undefined;
+    }>>;
+    termsOfUseUrl: z.ZodUnion<[z.ZodNullable<z.ZodOptional<z.ZodString>>, z.ZodLiteral<"">]>;
+    privacyPolicyUrl: z.ZodUnion<[z.ZodNullable<z.ZodOptional<z.ZodString>>, z.ZodLiteral<"">]>;
+}, "strip", z.ZodTypeAny, {
+    displayName?: string | null | undefined;
+    branding?: {
+        logoUrl?: string | undefined;
+        darkLogoUrl?: string | undefined;
+        favicon?: string | undefined;
+    } | undefined;
+    termsOfUseUrl?: string | null | undefined;
+    privacyPolicyUrl?: string | null | undefined;
+}, {
+    displayName?: string | null | undefined;
+    branding?: {
+        logoUrl?: string | undefined;
+        darkLogoUrl?: string | undefined;
+        favicon?: string | undefined;
+    } | undefined;
+    termsOfUseUrl?: string | null | undefined;
+    privacyPolicyUrl?: string | null | undefined;
+}>;
+export type ApplicationSignInExperienceCreate = z.infer<typeof applicationSignInExperienceCreateGuard>;

package/lib/types/application.js

@@ -1,7 +1,48 @@
-import { Applications } from '../db-entries/index.js';
+import { UserScope } from '@logto/core-kit';
+import { z } from 'zod';
+import { Applications, OrganizationScopes, Resources, Scopes, ApplicationSignInExperiences, } from '../db-entries/index.js';
 /** The guard for {@link FeaturedApplication}. */
 export const featuredApplicationGuard = Applications.guard.pick({
     id: true,
     name: true,
     type: true,
 });
+export const applicationCreateGuard = Applications.createGuard
+    .omit({
+    id: true,
+    createdAt: true,
+    secret: true,
+    tenantId: true,
+})
+    .partial()
+    .merge(Applications.createGuard.pick({ name: true, type: true }));
+export const applicationPatchGuard = applicationCreateGuard.partial().omit({
+    type: true,
+    isThirdParty: true,
+});
+export const applicationUserConsentScopesResponseGuard = z.object({
+    organizationScopes: z.array(OrganizationScopes.guard.pick({ id: true, name: true, description: true })),
+    resourceScopes: z.array(z.object({
+        resource: Resources.guard.pick({ id: true, name: true, indicator: true }),
+        scopes: z.array(Scopes.guard.pick({ id: true, name: true, description: true })),
+    })),
+    userScopes: z.array(z.nativeEnum(UserScope)),
+});
+export var ApplicationUserConsentScopeType;
+(function (ApplicationUserConsentScopeType) {
+    ApplicationUserConsentScopeType["OrganizationScopes"] = "organization-scopes";
+    ApplicationUserConsentScopeType["ResourceScopes"] = "resource-scopes";
+    ApplicationUserConsentScopeType["UserScopes"] = "user-scopes";
+})(ApplicationUserConsentScopeType || (ApplicationUserConsentScopeType = {}));
+export const applicationSignInExperienceCreateGuard = ApplicationSignInExperiences.createGuard
+    .omit({
+    applicationId: true,
+    tenantId: true,
+    termsOfUseUrl: true,
+    privacyPolicyUrl: true,
+})
+    // Align with the sign-in-experience create guard.
+    .merge(z.object({
+    termsOfUseUrl: z.string().max(2048).url().optional().nullable().or(z.literal('')),
+    privacyPolicyUrl: z.string().max(2048).url().optional().nullable().or(z.literal('')),
+}));

package/lib/types/connector.js

@@ -19,7 +19,7 @@ export const connectorResponseGuard = Connectors.guard
 }));
 export const connectorFactoryResponseGuard = z
     .object({
-    type: z.nativeEnum(ConnectorType),
+    type: z.nativeEnum(ConnectorType), // Omit<BaseConnector<ConnectorType>, 'configGuard' | 'metadata'>
     isDemo: z.boolean().optional(),
 })
     .merge(connectorMetadataGuard);