@logto/schemas 1.12.0 → 1.13.1

package/lib/foundations/jsonb-types/applications.d.ts

@@ -0,0 +1,380 @@
+import { z } from 'zod';
+export declare const customDomainGuard: z.ZodObject<{
+    domain: z.ZodString;
+    status: z.ZodNativeEnum<typeof import("./custom-domain.js").DomainStatus>;
+    errorMessage: z.ZodNullable<z.ZodString>;
+    dnsRecords: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        type: z.ZodString;
+        value: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        value: string;
+        name: string;
+    }, {
+        type: string;
+        value: string;
+        name: string;
+    }>, "many">;
+    cloudflareData: z.ZodNullable<z.ZodObject<{
+        id: z.ZodString;
+        status: z.ZodString;
+        ssl: z.ZodObject<{
+            status: z.ZodString;
+            validation_errors: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                message: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                message: string;
+            }, {
+                message: string;
+            }>, "many">>;
+        }, "strip", z.ZodTypeAny, {
+            status: string;
+            validation_errors?: {
+                message: string;
+            }[] | undefined;
+        }, {
+            status: string;
+            validation_errors?: {
+                message: string;
+            }[] | undefined;
+        }>;
+        verification_errors: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        status: string;
+        id: string;
+        ssl: {
+            status: string;
+            validation_errors?: {
+                message: string;
+            }[] | undefined;
+        };
+        verification_errors?: string[] | undefined;
+    }, {
+        status: string;
+        id: string;
+        ssl: {
+            status: string;
+            validation_errors?: {
+                message: string;
+            }[] | undefined;
+        };
+        verification_errors?: string[] | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    status: import("./custom-domain.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;
+}, {
+    status: import("./custom-domain.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;
+}>;
+export declare const customDomainsGuard: z.ZodArray<z.ZodObject<{
+    domain: z.ZodString;
+    status: z.ZodNativeEnum<typeof import("./custom-domain.js").DomainStatus>;
+    errorMessage: z.ZodNullable<z.ZodString>;
+    dnsRecords: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        type: z.ZodString;
+        value: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        value: string;
+        name: string;
+    }, {
+        type: string;
+        value: string;
+        name: string;
+    }>, "many">;
+    cloudflareData: z.ZodNullable<z.ZodObject<{
+        id: z.ZodString;
+        status: z.ZodString;
+        ssl: z.ZodObject<{
+            status: z.ZodString;
+            validation_errors: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                message: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                message: string;
+            }, {
+                message: string;
+            }>, "many">>;
+        }, "strip", z.ZodTypeAny, {
+            status: string;
+            validation_errors?: {
+                message: string;
+            }[] | undefined;
+        }, {
+            status: string;
+            validation_errors?: {
+                message: string;
+            }[] | undefined;
+        }>;
+        verification_errors: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        status: string;
+        id: string;
+        ssl: {
+            status: string;
+            validation_errors?: {
+                message: string;
+            }[] | undefined;
+        };
+        verification_errors?: string[] | undefined;
+    }, {
+        status: string;
+        id: string;
+        ssl: {
+            status: string;
+            validation_errors?: {
+                message: string;
+            }[] | undefined;
+        };
+        verification_errors?: string[] | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    status: import("./custom-domain.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;
+}, {
+    status: import("./custom-domain.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;
+}>, "many">;
+export type CustomDomain = z.infer<typeof customDomainGuard>;
+export declare const protectedAppMetadataGuard: z.ZodObject<{
+    host: z.ZodString;
+    origin: z.ZodString;
+    sessionDuration: z.ZodNumber;
+    pageRules: z.ZodArray<z.ZodObject<{
+        path: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        path: string;
+    }, {
+        path: string;
+    }>, "many">;
+    customDomains: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        domain: z.ZodString;
+        status: z.ZodNativeEnum<typeof import("./custom-domain.js").DomainStatus>;
+        errorMessage: z.ZodNullable<z.ZodString>;
+        dnsRecords: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            type: z.ZodString;
+            value: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            type: string;
+            value: string;
+            name: string;
+        }, {
+            type: string;
+            value: string;
+            name: string;
+        }>, "many">;
+        cloudflareData: z.ZodNullable<z.ZodObject<{
+            id: z.ZodString;
+            status: z.ZodString;
+            ssl: z.ZodObject<{
+                status: z.ZodString;
+                validation_errors: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                    message: z.ZodString;
+                }, "strip", z.ZodTypeAny, {
+                    message: string;
+                }, {
+                    message: string;
+                }>, "many">>;
+            }, "strip", z.ZodTypeAny, {
+                status: string;
+                validation_errors?: {
+                    message: string;
+                }[] | undefined;
+            }, {
+                status: string;
+                validation_errors?: {
+                    message: string;
+                }[] | undefined;
+            }>;
+            verification_errors: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        }, "strip", z.ZodTypeAny, {
+            status: string;
+            id: string;
+            ssl: {
+                status: string;
+                validation_errors?: {
+                    message: string;
+                }[] | undefined;
+            };
+            verification_errors?: string[] | undefined;
+        }, {
+            status: string;
+            id: string;
+            ssl: {
+                status: string;
+                validation_errors?: {
+                    message: string;
+                }[] | undefined;
+            };
+            verification_errors?: string[] | undefined;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        status: import("./custom-domain.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;
+    }, {
+        status: import("./custom-domain.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;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    host: string;
+    origin: string;
+    sessionDuration: number;
+    pageRules: {
+        path: string;
+    }[];
+    customDomains?: {
+        status: import("./custom-domain.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;
+}, {
+    host: string;
+    origin: string;
+    sessionDuration: number;
+    pageRules: {
+        path: string;
+    }[];
+    customDomains?: {
+        status: import("./custom-domain.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;
+}>;
+export type ProtectedAppMetadata = z.infer<typeof protectedAppMetadataGuard>;

package/lib/foundations/jsonb-types/applications.js

@@ -0,0 +1,29 @@
+import { z } from 'zod';
+import { cloudflareDataGuard, domainDnsRecordsGuard, domainStatusGuard } from './custom-domain.js';
+export const customDomainGuard = z.object({
+    /* The domain name, e.g app.example.com */
+    domain: z.string(),
+    /* The status of the domain in Cloudflare */
+    status: domainStatusGuard,
+    /* The error message if any */
+    errorMessage: z.string().nullable(),
+    /* The DNS records of the domain */
+    dnsRecords: domainDnsRecordsGuard,
+    /* The remote Cloudflare data */
+    cloudflareData: cloudflareDataGuard.nullable(),
+});
+export const customDomainsGuard = z.array(customDomainGuard);
+export const protectedAppMetadataGuard = z.object({
+    /* The host of the site */
+    host: z.string(),
+    /* The origin of the site */
+    origin: z.string(),
+    /* Session duration in seconds */
+    sessionDuration: z.number(),
+    pageRules: z.array(z.object({
+        /* The path pattern (regex) to match */
+        path: z.string(),
+    })),
+    /* Custom domain */
+    customDomains: customDomainsGuard.optional(),
+});

package/lib/foundations/jsonb-types/custom-domain.d.ts

@@ -34,96 +34,44 @@ export declare const cloudflareDataGuard: z.ZodObject<{
         status: z.ZodString;
         validation_errors: z.ZodOptional<z.ZodArray<z.ZodObject<{
             message: z.ZodString;
-        }, "strip", z.ZodUnknown, z.objectOutputType<{
-            message: z.ZodString;
-        }, z.ZodUnknown, "strip">, z.objectInputType<{
-            message: z.ZodString;
-        }, z.ZodUnknown, "strip">>, "many">>;
-    }, "strip", z.ZodUnknown, z.objectOutputType<{
-        status: z.ZodString;
-        validation_errors: z.ZodOptional<z.ZodArray<z.ZodObject<{
-            message: z.ZodString;
-        }, "strip", z.ZodUnknown, z.objectOutputType<{
-            message: z.ZodString;
-        }, z.ZodUnknown, "strip">, z.objectInputType<{
-            message: z.ZodString;
-        }, z.ZodUnknown, "strip">>, "many">>;
-    }, z.ZodUnknown, "strip">, z.objectInputType<{
-        status: z.ZodString;
-        validation_errors: z.ZodOptional<z.ZodArray<z.ZodObject<{
-            message: z.ZodString;
-        }, "strip", z.ZodUnknown, z.objectOutputType<{
-            message: z.ZodString;
-        }, z.ZodUnknown, "strip">, z.objectInputType<{
-            message: z.ZodString;
-        }, z.ZodUnknown, "strip">>, "many">>;
-    }, z.ZodUnknown, "strip">>;
+        }, "strip", z.ZodTypeAny, {
+            message: string;
+        }, {
+            message: string;
+        }>, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        status: string;
+        validation_errors?: {
+            message: string;
+        }[] | undefined;
+    }, {
+        status: string;
+        validation_errors?: {
+            message: string;
+        }[] | undefined;
+    }>;
     verification_errors: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-}, "strip", z.ZodUnknown, z.objectOutputType<{
-    id: z.ZodString;
-    status: z.ZodString;
-    ssl: z.ZodObject<{
-        status: z.ZodString;
-        validation_errors: z.ZodOptional<z.ZodArray<z.ZodObject<{
-            message: z.ZodString;
-        }, "strip", z.ZodUnknown, z.objectOutputType<{
-            message: z.ZodString;
-        }, z.ZodUnknown, "strip">, z.objectInputType<{
-            message: z.ZodString;
-        }, z.ZodUnknown, "strip">>, "many">>;
-    }, "strip", z.ZodUnknown, z.objectOutputType<{
-        status: z.ZodString;
-        validation_errors: z.ZodOptional<z.ZodArray<z.ZodObject<{
-            message: z.ZodString;
-        }, "strip", z.ZodUnknown, z.objectOutputType<{
-            message: z.ZodString;
-        }, z.ZodUnknown, "strip">, z.objectInputType<{
-            message: z.ZodString;
-        }, z.ZodUnknown, "strip">>, "many">>;
-    }, z.ZodUnknown, "strip">, z.objectInputType<{
-        status: z.ZodString;
-        validation_errors: z.ZodOptional<z.ZodArray<z.ZodObject<{
-            message: z.ZodString;
-        }, "strip", z.ZodUnknown, z.objectOutputType<{
-            message: z.ZodString;
-        }, z.ZodUnknown, "strip">, z.objectInputType<{
-            message: z.ZodString;
-        }, z.ZodUnknown, "strip">>, "many">>;
-    }, z.ZodUnknown, "strip">>;
-    verification_errors: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-}, z.ZodUnknown, "strip">, z.objectInputType<{
-    id: z.ZodString;
-    status: z.ZodString;
-    ssl: z.ZodObject<{
-        status: z.ZodString;
-        validation_errors: z.ZodOptional<z.ZodArray<z.ZodObject<{
-            message: z.ZodString;
-        }, "strip", z.ZodUnknown, z.objectOutputType<{
-            message: z.ZodString;
-        }, z.ZodUnknown, "strip">, z.objectInputType<{
-            message: z.ZodString;
-        }, z.ZodUnknown, "strip">>, "many">>;
-    }, "strip", z.ZodUnknown, z.objectOutputType<{
-        status: z.ZodString;
-        validation_errors: z.ZodOptional<z.ZodArray<z.ZodObject<{
-            message: z.ZodString;
-        }, "strip", z.ZodUnknown, z.objectOutputType<{
-            message: z.ZodString;
-        }, z.ZodUnknown, "strip">, z.objectInputType<{
-            message: z.ZodString;
-        }, z.ZodUnknown, "strip">>, "many">>;
-    }, z.ZodUnknown, "strip">, z.objectInputType<{
-        status: z.ZodString;
-        validation_errors: z.ZodOptional<z.ZodArray<z.ZodObject<{
-            message: z.ZodString;
-        }, "strip", z.ZodUnknown, z.objectOutputType<{
-            message: z.ZodString;
-        }, z.ZodUnknown, "strip">, z.objectInputType<{
-            message: z.ZodString;
-        }, z.ZodUnknown, "strip">>, "many">>;
-    }, z.ZodUnknown, "strip">>;
-    verification_errors: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-}, z.ZodUnknown, "strip">>;
+}, "strip", z.ZodTypeAny, {
+    status: string;
+    id: string;
+    ssl: {
+        status: string;
+        validation_errors?: {
+            message: string;
+        }[] | undefined;
+    };
+    verification_errors?: string[] | undefined;
+}, {
+    status: string;
+    id: string;
+    ssl: {
+        status: string;
+        validation_errors?: {
+            message: string;
+        }[] | undefined;
+    };
+    verification_errors?: string[] | undefined;
+}>;
 export type CloudflareData = z.infer<typeof cloudflareDataGuard>;
 export declare enum DomainStatus {
     PendingVerification = "PendingVerification",

package/lib/foundations/jsonb-types/custom-domain.js

@@ -7,25 +7,20 @@ export const domainDnsRecordGuard = z.object({
 export const domainDnsRecordsGuard = domainDnsRecordGuard.array();
 // https://developers.cloudflare.com/api/operations/custom-hostname-for-a-zone-list-custom-hostnames#Responses
 // Predefine the "useful" fields
-export const cloudflareDataGuard = z
-    .object({
+export const cloudflareDataGuard = z.object({
     id: z.string(),
     status: z.string(),
-    ssl: z
-        .object({
+    ssl: z.object({
         status: z.string(),
         validation_errors: z
             .object({
             message: z.string(),
         })
-            .catchall(z.unknown())
             .array()
             .optional(),
-    })
-        .catchall(z.unknown()),
+    }),
     verification_errors: z.string().array().optional(),
-})
-    .catchall(z.unknown());
+});
 export var DomainStatus;
 (function (DomainStatus) {
     DomainStatus["PendingVerification"] = "PendingVerification";

package/lib/foundations/jsonb-types/index.d.ts

@@ -9,6 +9,7 @@ export * from './sign-in-experience.js';
 export * from './sentinel.js';
 export * from './users.js';
 export * from './sso-connector.js';
+export * from './applications.js';
 export { configurableConnectorMetadataGuard, type ConfigurableConnectorMetadata, } from '@logto/connector-kit';
 export type { Json, JsonObject } from '@withtyped/server';
 export declare const jsonGuard: z.ZodType<Json>;

package/lib/foundations/jsonb-types/index.js

@@ -8,6 +8,7 @@ export * from './sign-in-experience.js';
 export * from './sentinel.js';
 export * from './users.js';
 export * from './sso-connector.js';
+export * from './applications.js';
 export { configurableConnectorMetadataGuard, } from '@logto/connector-kit';
 /* === Commonly Used === */
 // Copied from https://github.com/colinhacks/zod#json-type

package/lib/foundations/jsonb-types/users.d.ts

@@ -1,7 +1,7 @@
 import { z } from 'zod';
 import { MfaFactor } from './sign-in-experience.js';
 export declare const roleNamesGuard: z.ZodArray<z.ZodString, "many">;
-declare const identityGuard: z.ZodObject<{
+export declare const identityGuard: z.ZodObject<{
     userId: z.ZodString;
     details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
 }, "strip", z.ZodTypeAny, {
@@ -282,4 +282,3 @@ export declare const mfaVerificationsGuard: z.ZodArray<z.ZodDiscriminatedUnion<"
     lastUsedAt?: string | undefined;
 }>]>, "many">;
 export type MfaVerifications = z.infer<typeof mfaVerificationsGuard>;
-export {};

package/lib/foundations/jsonb-types/users.js

@@ -1,7 +1,7 @@
 import { z } from 'zod';
 import { MfaFactor } from './sign-in-experience.js';
 export const roleNamesGuard = z.string().array();
-const identityGuard = z.object({
+export const identityGuard = z.object({
     userId: z.string(),
     details: z.record(z.unknown()).optional(), // Connector's userinfo details, schemaless
 });

package/lib/models/tenants.d.ts

@@ -1,7 +1,7 @@
 import type { InferModelType } from '@withtyped/server/model';
 import { z } from 'zod';
 import { TenantTag } from '../types/tenant.js';
-export declare const Tenants: import("@withtyped/server/model").default<"tenants", {
+export declare const Tenants: import("@withtyped/server/lib/model/index.js").default<"tenants", {
     id: string;
     dbUser: string | null;
     dbUserPassword: string | null;

package/lib/seeds/application.d.ts

@@ -9,5 +9,5 @@ export declare const demoAppApplicationId = "demo-app";
 export declare const buildDemoAppDataForTenant: (tenantId: string) => Application;
 export declare const createDefaultAdminConsoleApplication: () => Readonly<CreateApplication>;
 export declare const createTenantMachineToMachineApplication: (tenantId: string) => Readonly<CreateApplication>;
-/** Create role for "tenant application (M2M)" in admin tenant */
+/** Create an entry to assign a role to an application in the admin tenant. */
 export declare const createAdminTenantApplicationRole: (applicationId: string, roleId: string) => Readonly<CreateApplicationsRole>;

package/lib/seeds/application.js

@@ -17,6 +17,8 @@ export const buildDemoAppDataForTenant = (tenantId) => ({
     type: ApplicationType.SPA,
     oidcClientMetadata: { redirectUris: [], postLogoutRedirectUris: [] },
     customClientMetadata: {},
+    protectedAppMetadata: null,
+    isThirdParty: false,
     createdAt: 0,
 });
 export const createDefaultAdminConsoleApplication = () => Object.freeze({
@@ -43,7 +45,7 @@ export const createTenantMachineToMachineApplication = (tenantId) => Object.free
         tenantId,
     },
 });
-/** Create role for "tenant application (M2M)" in admin tenant */
+/** Create an entry to assign a role to an application in the admin tenant. */
 export const createAdminTenantApplicationRole = (applicationId, roleId) => Object.freeze({
     id: generateStandardId(),
     tenantId: adminTenantId,

package/lib/seeds/cloud-api.d.ts

@@ -5,8 +5,6 @@ export declare const cloudApiIndicator = "https://cloud.logto.io/api";
 export declare enum CloudScope {
     /** The user can create a user tenant. */
     CreateTenant = "create:tenant",
-    /** The user can perform arbitrary operations on any tenant. */
-    ManageTenant = "manage:tenant",
     /** The user can update or delete its own tenants. */
     ManageTenantSelf = "manage:tenant:self",
     SendSms = "send:sms",
@@ -14,7 +12,9 @@ export declare enum CloudScope {
     /** The user can see and manage affiliates, including create, update, and delete. */
     ManageAffiliate = "manage:affiliate",
     /** The user can create new affiliates and logs. */
-    CreateAffiliate = "create:affiliate"
+    CreateAffiliate = "create:affiliate",
+    /** The user can cleanup outdated logs. */
+    CleanupOutdatedLogs = "cleanup:outdated-logs"
 }
 export declare const createCloudApi: () => readonly [UpdateAdminData, ...CreateScope[]];
 export declare const createTenantApplicationRole: () => Readonly<Role>;