@logto/schemas 1.28.0 → 1.29.0

package/lib/foundations/jsonb-types/custom-profile-fields.d.ts

@@ -0,0 +1,116 @@
+import { z } from 'zod';
+export declare enum CustomProfileFieldType {
+    Text = "Text",
+    Number = "Number",
+    Date = "Date",
+    Checkbox = "Checkbox",
+    Select = "Select",
+    Url = "Url",
+    Regex = "Regex",
+    Address = "Address",
+    Fullname = "Fullname"
+}
+export declare const customProfileFieldTypeGuard: z.ZodNativeEnum<typeof CustomProfileFieldType>;
+export declare const fieldOptionGuard: z.ZodObject<{
+    label: z.ZodString;
+    value: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    value: string;
+    label: string;
+}, {
+    value: string;
+    label: string;
+}>;
+export type FieldOption = z.infer<typeof fieldOptionGuard>;
+export declare const fieldOptionsGuard: z.ZodArray<z.ZodObject<{
+    label: z.ZodString;
+    value: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    value: string;
+    label: string;
+}, {
+    value: string;
+    label: string;
+}>, "many">;
+export type FieldOptions = z.infer<typeof fieldOptionsGuard>;
+export declare const fieldPartGuard: z.ZodObject<{
+    key: z.ZodString;
+    enabled: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    key: string;
+    enabled: boolean;
+}, {
+    key: string;
+    enabled: boolean;
+}>;
+export type FieldPart = z.infer<typeof fieldPartGuard>;
+export declare const fieldPartsGuard: z.ZodArray<z.ZodObject<{
+    key: z.ZodString;
+    enabled: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    key: string;
+    enabled: boolean;
+}, {
+    key: string;
+    enabled: boolean;
+}>, "many">;
+export type FieldParts = z.infer<typeof fieldPartsGuard>;
+export declare const customProfileFieldConfigGuard: z.ZodObject<{
+    placeholder: z.ZodOptional<z.ZodString>;
+    minLength: z.ZodOptional<z.ZodNumber>;
+    maxLength: z.ZodOptional<z.ZodNumber>;
+    minValue: z.ZodOptional<z.ZodNumber>;
+    maxValue: z.ZodOptional<z.ZodNumber>;
+    format: z.ZodOptional<z.ZodString>;
+    options: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        label: z.ZodString;
+        value: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        value: string;
+        label: string;
+    }, {
+        value: string;
+        label: string;
+    }>, "many">>;
+    parts: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        enabled: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        key: string;
+        enabled: boolean;
+    }, {
+        key: string;
+        enabled: boolean;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    options?: {
+        value: string;
+        label: string;
+    }[] | undefined;
+    minLength?: number | undefined;
+    maxLength?: number | undefined;
+    placeholder?: string | undefined;
+    minValue?: number | undefined;
+    maxValue?: number | undefined;
+    format?: string | undefined;
+    parts?: {
+        key: string;
+        enabled: boolean;
+    }[] | undefined;
+}, {
+    options?: {
+        value: string;
+        label: string;
+    }[] | undefined;
+    minLength?: number | undefined;
+    maxLength?: number | undefined;
+    placeholder?: string | undefined;
+    minValue?: number | undefined;
+    maxValue?: number | undefined;
+    format?: string | undefined;
+    parts?: {
+        key: string;
+        enabled: boolean;
+    }[] | undefined;
+}>;
+export type CustomProfileFieldConfig = z.infer<typeof customProfileFieldConfigGuard>;

package/lib/foundations/jsonb-types/custom-profile-fields.js

@@ -0,0 +1,36 @@
+import { z } from 'zod';
+export var CustomProfileFieldType;
+(function (CustomProfileFieldType) {
+    /* Primitive types */
+    CustomProfileFieldType["Text"] = "Text";
+    CustomProfileFieldType["Number"] = "Number";
+    CustomProfileFieldType["Date"] = "Date";
+    CustomProfileFieldType["Checkbox"] = "Checkbox";
+    CustomProfileFieldType["Select"] = "Select";
+    CustomProfileFieldType["Url"] = "Url";
+    CustomProfileFieldType["Regex"] = "Regex";
+    /* Composite types */
+    CustomProfileFieldType["Address"] = "Address";
+    CustomProfileFieldType["Fullname"] = "Fullname";
+})(CustomProfileFieldType || (CustomProfileFieldType = {}));
+export const customProfileFieldTypeGuard = z.nativeEnum(CustomProfileFieldType);
+export const fieldOptionGuard = z.object({
+    label: z.string(),
+    value: z.string(),
+});
+export const fieldOptionsGuard = fieldOptionGuard.array();
+export const fieldPartGuard = z.object({
+    key: z.string(),
+    enabled: z.boolean(),
+});
+export const fieldPartsGuard = fieldPartGuard.array();
+export const customProfileFieldConfigGuard = z.object({
+    placeholder: z.string().max(256).optional(),
+    minLength: z.number().int().optional(),
+    maxLength: z.number().int().optional(),
+    minValue: z.number().int().optional(),
+    maxValue: z.number().int().optional(),
+    format: z.string().max(128).optional(),
+    options: fieldOptionsGuard.optional(),
+    parts: fieldPartsGuard.optional(),
+});

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

@@ -8,12 +8,13 @@ export * from './sentinel.js';
 export * from './users.js';
 export * from './sso-connector.js';
 export * from './applications.js';
-export * from './verification-records.js';
 export * from './account-centers.js';
 export * from './saml-application-configs.js';
 export * from './saml-application-sessions.js';
 export * from './email-templates.js';
 export * from './one-time-tokens.js';
 export * from './captcha.js';
+export * from './custom-profile-fields.js';
+export * from './secrets.js';
 export { configurableConnectorMetadataGuard, type ConfigurableConnectorMetadata, jsonGuard, jsonObjectGuard, } from '@logto/connector-kit';
 export type { Json, JsonObject } from '@withtyped/server';

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

@@ -8,11 +8,12 @@ export * from './sentinel.js';
 export * from './users.js';
 export * from './sso-connector.js';
 export * from './applications.js';
-export * from './verification-records.js';
 export * from './account-centers.js';
 export * from './saml-application-configs.js';
 export * from './saml-application-sessions.js';
 export * from './email-templates.js';
 export * from './one-time-tokens.js';
 export * from './captcha.js';
+export * from './custom-profile-fields.js';
+export * from './secrets.js';
 export { configurableConnectorMetadataGuard, jsonGuard, jsonObjectGuard, } from '@logto/connector-kit';

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

@@ -0,0 +1,9 @@
+import { z } from 'zod';
+export declare enum SecretType {
+    /**
+     * A federated token set is a collection of OAuth tokens from the third-party providers.
+     * Use these tokens to get access to the third-party APIs.
+     */
+    FederatedTokenSet = "federated_token_set"
+}
+export declare const secretTypeGuard: z.ZodNativeEnum<typeof SecretType>;

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

@@ -0,0 +1,10 @@
+import { z } from 'zod';
+export var SecretType;
+(function (SecretType) {
+    /**
+     * A federated token set is a collection of OAuth tokens from the third-party providers.
+     * Use these tokens to get access to the third-party APIs.
+     */
+    SecretType["FederatedTokenSet"] = "federated_token_set";
+})(SecretType || (SecretType = {}));
+export const secretTypeGuard = z.nativeEnum(SecretType);

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

@@ -21,6 +21,28 @@ export type UserProfile = Partial<{
         country: string;
     }>;
 }>;
+export declare const addressGuard: z.ZodObject<{
+    formatted: z.ZodOptional<z.ZodString>;
+    streetAddress: z.ZodOptional<z.ZodString>;
+    locality: z.ZodOptional<z.ZodString>;
+    region: z.ZodOptional<z.ZodString>;
+    postalCode: z.ZodOptional<z.ZodString>;
+    country: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    formatted?: string | undefined;
+    streetAddress?: string | undefined;
+    locality?: string | undefined;
+    region?: string | undefined;
+    postalCode?: string | undefined;
+    country?: string | undefined;
+}, {
+    formatted?: string | undefined;
+    streetAddress?: string | undefined;
+    locality?: string | undefined;
+    region?: string | undefined;
+    postalCode?: string | undefined;
+    country?: string | undefined;
+}>;
 export declare const userProfileGuard: z.ZodObject<{
     familyName: z.ZodOptional<z.ZodString>;
     givenName: z.ZodOptional<z.ZodString>;
@@ -97,6 +119,7 @@ export declare const userProfileGuard: z.ZodObject<{
     } | undefined;
 }>;
 export declare const userProfileKeys: readonly ["familyName", "givenName", "middleName", "nickname", "preferredUsername", "profile", "website", "gender", "birthdate", "zoneinfo", "locale", "address"];
+export declare const userProfileAddressKeys: readonly ["formatted", "streetAddress", "locality", "region", "postalCode", "country"];
 export declare const roleNamesGuard: z.ZodArray<z.ZodString, "many">;
 export declare const identityGuard: z.ZodObject<{
     userId: z.ZodString;
@@ -152,6 +175,7 @@ export declare const mfaVerificationWebAuthn: z.ZodObject<{
     transports: z.ZodOptional<z.ZodArray<z.ZodEnum<["usb", "nfc", "ble", "internal", "cable", "hybrid", "smart-card"]>, "many">>;
     counter: z.ZodNumber;
     agent: z.ZodString;
+    name: z.ZodOptional<z.ZodString>;
     id: z.ZodString;
     createdAt: z.ZodString;
     lastUsedAt: z.ZodOptional<z.ZodString>;
@@ -164,6 +188,7 @@ export declare const mfaVerificationWebAuthn: z.ZodObject<{
     publicKey: string;
     counter: number;
     agent: string;
+    name?: string | undefined;
     lastUsedAt?: string | undefined;
     transports?: ("usb" | "nfc" | "ble" | "internal" | "cable" | "hybrid" | "smart-card")[] | undefined;
 }, {
@@ -174,6 +199,7 @@ export declare const mfaVerificationWebAuthn: z.ZodObject<{
     publicKey: string;
     counter: number;
     agent: string;
+    name?: string | undefined;
     lastUsedAt?: string | undefined;
     transports?: ("usb" | "nfc" | "ble" | "internal" | "cable" | "hybrid" | "smart-card")[] | undefined;
 }>;
@@ -237,6 +263,7 @@ export declare const mfaVerificationGuard: z.ZodDiscriminatedUnion<"type", [z.Zo
     transports: z.ZodOptional<z.ZodArray<z.ZodEnum<["usb", "nfc", "ble", "internal", "cable", "hybrid", "smart-card"]>, "many">>;
     counter: z.ZodNumber;
     agent: z.ZodString;
+    name: z.ZodOptional<z.ZodString>;
     id: z.ZodString;
     createdAt: z.ZodString;
     lastUsedAt: z.ZodOptional<z.ZodString>;
@@ -249,6 +276,7 @@ export declare const mfaVerificationGuard: z.ZodDiscriminatedUnion<"type", [z.Zo
     publicKey: string;
     counter: number;
     agent: string;
+    name?: string | undefined;
     lastUsedAt?: string | undefined;
     transports?: ("usb" | "nfc" | "ble" | "internal" | "cable" | "hybrid" | "smart-card")[] | undefined;
 }, {
@@ -259,6 +287,7 @@ export declare const mfaVerificationGuard: z.ZodDiscriminatedUnion<"type", [z.Zo
     publicKey: string;
     counter: number;
     agent: string;
+    name?: string | undefined;
     lastUsedAt?: string | undefined;
     transports?: ("usb" | "nfc" | "ble" | "internal" | "cable" | "hybrid" | "smart-card")[] | undefined;
 }>, z.ZodObject<{
@@ -320,6 +349,7 @@ export declare const mfaVerificationsGuard: z.ZodArray<z.ZodDiscriminatedUnion<"
     transports: z.ZodOptional<z.ZodArray<z.ZodEnum<["usb", "nfc", "ble", "internal", "cable", "hybrid", "smart-card"]>, "many">>;
     counter: z.ZodNumber;
     agent: z.ZodString;
+    name: z.ZodOptional<z.ZodString>;
     id: z.ZodString;
     createdAt: z.ZodString;
     lastUsedAt: z.ZodOptional<z.ZodString>;
@@ -332,6 +362,7 @@ export declare const mfaVerificationsGuard: z.ZodArray<z.ZodDiscriminatedUnion<"
     publicKey: string;
     counter: number;
     agent: string;
+    name?: string | undefined;
     lastUsedAt?: string | undefined;
     transports?: ("usb" | "nfc" | "ble" | "internal" | "cable" | "hybrid" | "smart-card")[] | undefined;
 }, {
@@ -342,6 +373,7 @@ export declare const mfaVerificationsGuard: z.ZodArray<z.ZodDiscriminatedUnion<"
     publicKey: string;
     counter: number;
     agent: string;
+    name?: string | undefined;
     lastUsedAt?: string | undefined;
     transports?: ("usb" | "nfc" | "ble" | "internal" | "cable" | "hybrid" | "smart-card")[] | undefined;
 }>, z.ZodObject<{

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

@@ -1,6 +1,14 @@
 import { jsonObjectGuard } from '@logto/connector-kit';
 import { z } from 'zod';
 import { MfaFactor } from './sign-in-experience.js';
+export const addressGuard = z.object({
+    formatted: z.string().optional(),
+    streetAddress: z.string().optional(),
+    locality: z.string().optional(),
+    region: z.string().optional(),
+    postalCode: z.string().optional(),
+    country: z.string().optional(),
+});
 export const userProfileGuard = z.object({
     familyName: z.string(),
     givenName: z.string(),
@@ -13,18 +21,10 @@ export const userProfileGuard = z.object({
     birthdate: z.string(),
     zoneinfo: z.string(),
     locale: z.string(),
-    address: z
-        .object({
-        formatted: z.string(),
-        streetAddress: z.string(),
-        locality: z.string(),
-        region: z.string(),
-        postalCode: z.string(),
-        country: z.string(),
-    })
-        .partial(),
+    address: addressGuard,
 }).partial();
 export const userProfileKeys = Object.freeze(userProfileGuard.keyof().options);
+export const userProfileAddressKeys = Object.freeze(addressGuard.keyof().options);
 export const roleNamesGuard = z.string().array();
 export const identityGuard = z.object({
     userId: z.string(),
@@ -58,6 +58,7 @@ export const mfaVerificationWebAuthn = z.object({
     transports: webAuthnTransportGuard.array().optional(),
     counter: z.number(),
     agent: z.string(),
+    name: z.string().optional(),
 });
 export const mfaVerificationBackupCode = z.object({
     type: z.literal(MfaFactor.BackupCode),

package/lib/types/consent.d.ts

@@ -77,6 +77,7 @@ export declare const publicUserInfoGuard: z.ZodObject<Pick<{
         publicKey: string;
         counter: number;
         agent: string;
+        name?: string | undefined;
         lastUsedAt?: string | undefined;
         transports?: ("usb" | "nfc" | "ble" | "internal" | "cable" | "hybrid" | "smart-card")[] | undefined;
     } | {
@@ -102,6 +103,7 @@ export declare const publicUserInfoGuard: z.ZodObject<Pick<{
         publicKey: string;
         counter: number;
         agent: string;
+        name?: string | undefined;
         lastUsedAt?: string | undefined;
         transports?: ("usb" | "nfc" | "ble" | "internal" | "cable" | "hybrid" | "smart-card")[] | undefined;
     } | {
@@ -643,6 +645,7 @@ export declare const consentInfoResponseGuard: z.ZodObject<{
             publicKey: string;
             counter: number;
             agent: string;
+            name?: string | undefined;
             lastUsedAt?: string | undefined;
             transports?: ("usb" | "nfc" | "ble" | "internal" | "cable" | "hybrid" | "smart-card")[] | undefined;
         } | {
@@ -668,6 +671,7 @@ export declare const consentInfoResponseGuard: z.ZodObject<{
             publicKey: string;
             counter: number;
             agent: string;
+            name?: string | undefined;
             lastUsedAt?: string | undefined;
             transports?: ("usb" | "nfc" | "ble" | "internal" | "cable" | "hybrid" | "smart-card")[] | undefined;
         } | {