@logto/schemas 1.28.0 → 1.30.0

package/lib/types/secrets.js

@@ -0,0 +1,73 @@
+import { tokenResponseGuard } from '@logto/connector-kit';
+import { z } from 'zod';
+import { SecretEnterpriseSsoConnectorRelations } from '../db-entries/secret-enterprise-sso-connector-relation.js';
+import { SecretSocialConnectorRelations } from '../db-entries/secret-social-connector-relation.js';
+import { Secrets } from '../db-entries/secret.js';
+import { SecretType } from '../foundations/index.js';
+export const encryptedSecretGuard = Secrets.guard.pick({
+    encryptedDek: true,
+    iv: true,
+    authTag: true,
+    ciphertext: true,
+});
+export const tokenSetGuard = z.object({
+    id_token: z.string().optional(),
+    access_token: z.string(),
+    refresh_token: z.string().optional(),
+});
+export const tokenSetMetadataGuard = z.object({
+    scope: z.string().optional(),
+    expiresAt: z.number().optional(),
+    tokenType: z.string().optional(),
+    hasRefreshToken: z.boolean(),
+});
+export const encryptedTokenSetGuard = z.object({
+    encryptedTokenSetBase64: z.string(),
+    metadata: tokenSetMetadataGuard,
+});
+export const secretSocialConnectorRelationPayloadGuard = SecretSocialConnectorRelations.createGuard.pick({
+    connectorId: true,
+    target: true,
+    identityId: true,
+});
+export const secretEnterpriseSsoConnectorRelationPayloadGuard = SecretEnterpriseSsoConnectorRelations.createGuard.pick({
+    ssoConnectorId: true,
+    issuer: true,
+    identityId: true,
+});
+export const socialTokenSetSecretGuard = Secrets.guard.extend({
+    type: z.literal(SecretType.FederatedTokenSet),
+    metadata: tokenSetMetadataGuard,
+    connectorId: z.string(),
+    identityId: z.string(),
+    target: z.string(),
+});
+export const desensitizedSocialTokenSetSecretGuard = socialTokenSetSecretGuard.omit({
+    encryptedDek: true,
+    iv: true,
+    authTag: true,
+    ciphertext: true,
+});
+export const enterpriseSsoTokenSetSecretGuard = Secrets.guard.extend({
+    type: z.literal(SecretType.FederatedTokenSet),
+    metadata: tokenSetMetadataGuard,
+    ssoConnectorId: z.string(),
+    issuer: z.string(),
+    identityId: z.string(),
+});
+export const desensitizedEnterpriseSsoTokenSetSecretGuard = enterpriseSsoTokenSetSecretGuard.omit({
+    encryptedDek: true,
+    iv: true,
+    authTag: true,
+    ciphertext: true,
+});
+export const getThirdPartyAccessTokenResponseGuard = tokenResponseGuard
+    .pick({
+    access_token: true,
+    scope: true,
+    token_type: true,
+    expires_in: true,
+})
+    .extend({
+    access_token: z.string(),
+});

package/lib/types/sign-in-experience.d.ts

@@ -1,6 +1,6 @@
 import { type ConnectorMetadata, type GoogleOneTapConfig } from '@logto/connector-kit';
 import { z } from 'zod';
-import { type SignInExperience } from '../db-entries/index.js';
+import { type CustomProfileField, type SignInExperience } from '../db-entries/index.js';
 import { CaptchaType } from '../foundations/jsonb-types/index.js';
 import { type SsoConnectorMetadata } from './sso-connector.js';
 type ForgotPassword = {
@@ -33,6 +33,7 @@ export type FullSignInExperience = SignInExperience & {
         type: CaptchaType;
         siteKey: string;
     };
+    customProfileFields?: Readonly<CustomProfileField[]>;
 };
 export declare const fullSignInExperienceGuard: z.ZodObject<{
     tenantId: z.ZodType<string, z.ZodTypeDef, string>;
@@ -165,6 +166,7 @@ export declare const fullSignInExperienceGuard: z.ZodObject<{
             description: z.ZodOptional<z.ZodString>;
             tooltip: z.ZodOptional<z.ZodString>;
             isConfidential: z.ZodOptional<z.ZodBoolean>;
+            isDevFeature: z.ZodOptional<z.ZodBoolean>;
             type: z.ZodLiteral<import("@logto/connector-kit").ConnectorConfigFormItemType.Select>;
             selectItems: z.ZodArray<z.ZodObject<{
                 value: z.ZodString;
@@ -194,6 +196,7 @@ export declare const fullSignInExperienceGuard: z.ZodObject<{
             description?: string | undefined;
             tooltip?: string | undefined;
             isConfidential?: boolean | undefined;
+            isDevFeature?: boolean | undefined;
         }, {
             type: import("@logto/connector-kit").ConnectorConfigFormItemType.Select;
             selectItems: {
@@ -212,6 +215,7 @@ export declare const fullSignInExperienceGuard: z.ZodObject<{
             description?: string | undefined;
             tooltip?: string | undefined;
             isConfidential?: boolean | undefined;
+            isDevFeature?: boolean | undefined;
         }>, z.ZodObject<{
             key: z.ZodString;
             label: z.ZodString;
@@ -231,6 +235,7 @@ export declare const fullSignInExperienceGuard: z.ZodObject<{
             description: z.ZodOptional<z.ZodString>;
             tooltip: z.ZodOptional<z.ZodString>;
             isConfidential: z.ZodOptional<z.ZodBoolean>;
+            isDevFeature: z.ZodOptional<z.ZodBoolean>;
             type: z.ZodLiteral<import("@logto/connector-kit").ConnectorConfigFormItemType.MultiSelect>;
             selectItems: z.ZodArray<z.ZodObject<{
                 value: z.ZodString;
@@ -256,6 +261,7 @@ export declare const fullSignInExperienceGuard: z.ZodObject<{
             description?: string | undefined;
             tooltip?: string | undefined;
             isConfidential?: boolean | undefined;
+            isDevFeature?: boolean | undefined;
         }, {
             type: import("@logto/connector-kit").ConnectorConfigFormItemType.MultiSelect;
             selectItems: {
@@ -273,6 +279,7 @@ export declare const fullSignInExperienceGuard: z.ZodObject<{
             description?: string | undefined;
             tooltip?: string | undefined;
             isConfidential?: boolean | undefined;
+            isDevFeature?: boolean | undefined;
         }>, z.ZodObject<{
             key: z.ZodString;
             label: z.ZodString;
@@ -292,6 +299,7 @@ export declare const fullSignInExperienceGuard: z.ZodObject<{
             description: z.ZodOptional<z.ZodString>;
             tooltip: z.ZodOptional<z.ZodString>;
             isConfidential: z.ZodOptional<z.ZodBoolean>;
+            isDevFeature: z.ZodOptional<z.ZodBoolean>;
             type: z.ZodEnum<[import("@logto/connector-kit").ConnectorConfigFormItemType.Text, import("@logto/connector-kit").ConnectorConfigFormItemType.Number, import("@logto/connector-kit").ConnectorConfigFormItemType.MultilineText, import("@logto/connector-kit").ConnectorConfigFormItemType.Switch, import("@logto/connector-kit").ConnectorConfigFormItemType.Json]>;
         }, "strip", z.ZodTypeAny, {
             type: import("@logto/connector-kit").ConnectorConfigFormItemType.Text | import("@logto/connector-kit").ConnectorConfigFormItemType.Number | import("@logto/connector-kit").ConnectorConfigFormItemType.MultilineText | import("@logto/connector-kit").ConnectorConfigFormItemType.Switch | import("@logto/connector-kit").ConnectorConfigFormItemType.Json;
@@ -307,6 +315,7 @@ export declare const fullSignInExperienceGuard: z.ZodObject<{
             description?: string | undefined;
             tooltip?: string | undefined;
             isConfidential?: boolean | undefined;
+            isDevFeature?: boolean | undefined;
         }, {
             type: import("@logto/connector-kit").ConnectorConfigFormItemType.Text | import("@logto/connector-kit").ConnectorConfigFormItemType.Number | import("@logto/connector-kit").ConnectorConfigFormItemType.MultilineText | import("@logto/connector-kit").ConnectorConfigFormItemType.Switch | import("@logto/connector-kit").ConnectorConfigFormItemType.Json;
             key: string;
@@ -321,12 +330,14 @@ export declare const fullSignInExperienceGuard: z.ZodObject<{
             description?: string | undefined;
             tooltip?: string | undefined;
             isConfidential?: boolean | undefined;
+            isDevFeature?: boolean | undefined;
         }>]>, "many">>;
         customData: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
         fromEmail: z.ZodOptional<z.ZodString>;
     } & {
         platform: z.ZodNullable<z.ZodNativeEnum<typeof import("@logto/connector-kit").ConnectorPlatform>>;
         isStandard: z.ZodOptional<z.ZodBoolean>;
+        isTokenStorageSupported: z.ZodOptional<z.ZodBoolean>;
     }, "customData" | "description" | "readme" | "configTemplate" | "formItems">, "strip", z.ZodTypeAny, {
         name: {
             en: string;
@@ -466,6 +477,7 @@ export declare const fullSignInExperienceGuard: z.ZodObject<{
         platform: import("@logto/connector-kit").ConnectorPlatform | null;
         fromEmail?: string | undefined;
         isStandard?: boolean | undefined;
+        isTokenStorageSupported?: boolean | undefined;
     }, {
         name: {
             en: string;
@@ -605,6 +617,7 @@ export declare const fullSignInExperienceGuard: z.ZodObject<{
         platform: import("@logto/connector-kit").ConnectorPlatform | null;
         fromEmail?: string | undefined;
         isStandard?: boolean | undefined;
+        isTokenStorageSupported?: boolean | undefined;
     }>, "many">;
     ssoConnectors: z.ZodArray<z.ZodObject<{
         id: z.ZodString;
@@ -666,9 +679,11 @@ export declare const fullSignInExperienceGuard: z.ZodObject<{
         type: CaptchaType;
         siteKey: string;
     }>>;
+    customProfileFields: z.ZodOptional<z.ZodArray<import("../index.js").Guard<CustomProfileField>, "many">>;
 }, "strip", z.ZodTypeAny, {
     id: string;
     tenantId: string;
+    mfa: import("../foundations/jsonb-types/sign-in-experience.js").Mfa;
     color: import("../foundations/jsonb-types/sign-in-experience.js").Color;
     branding: import("../foundations/jsonb-types/sign-in-experience.js").Branding;
     termsOfUseUrl: string | null;
@@ -684,7 +699,6 @@ export declare const fullSignInExperienceGuard: z.ZodObject<{
     customContent: import("../foundations/jsonb-types/sign-in-experience.js").CustomContent;
     customUiAssets: import("../foundations/jsonb-types/sign-in-experience.js").CustomUiAssets | null;
     passwordPolicy: import("../foundations/jsonb-types/logs.js").PartialPasswordPolicy;
-    mfa: import("../foundations/jsonb-types/sign-in-experience.js").Mfa;
     singleSignOnEnabled: boolean;
     supportEmail: string | null;
     supportWebsiteUrl: string | null;
@@ -831,6 +845,7 @@ export declare const fullSignInExperienceGuard: z.ZodObject<{
         platform: import("@logto/connector-kit").ConnectorPlatform | null;
         fromEmail?: string | undefined;
         isStandard?: boolean | undefined;
+        isTokenStorageSupported?: boolean | undefined;
     }[];
     ssoConnectors: {
         id: string;
@@ -855,9 +870,11 @@ export declare const fullSignInExperienceGuard: z.ZodObject<{
         type: CaptchaType;
         siteKey: string;
     } | undefined;
+    customProfileFields?: CustomProfileField[] | undefined;
 }, {
     id: string;
     tenantId: string;
+    mfa: import("../foundations/jsonb-types/sign-in-experience.js").Mfa;
     color: import("../foundations/jsonb-types/sign-in-experience.js").Color;
     branding: import("../foundations/jsonb-types/sign-in-experience.js").Branding;
     termsOfUseUrl: string | null;
@@ -873,7 +890,6 @@ export declare const fullSignInExperienceGuard: z.ZodObject<{
     customContent: import("../foundations/jsonb-types/sign-in-experience.js").CustomContent;
     customUiAssets: import("../foundations/jsonb-types/sign-in-experience.js").CustomUiAssets | null;
     passwordPolicy: import("../foundations/jsonb-types/logs.js").PartialPasswordPolicy;
-    mfa: import("../foundations/jsonb-types/sign-in-experience.js").Mfa;
     singleSignOnEnabled: boolean;
     supportEmail: string | null;
     supportWebsiteUrl: string | null;
@@ -1020,6 +1036,7 @@ export declare const fullSignInExperienceGuard: z.ZodObject<{
         platform: import("@logto/connector-kit").ConnectorPlatform | null;
         fromEmail?: string | undefined;
         isStandard?: boolean | undefined;
+        isTokenStorageSupported?: boolean | undefined;
     }[];
     ssoConnectors: {
         id: string;
@@ -1044,5 +1061,6 @@ export declare const fullSignInExperienceGuard: z.ZodObject<{
         type: CaptchaType;
         siteKey: string;
     } | undefined;
+    customProfileFields?: CustomProfileField[] | undefined;
 }>;
 export {};

package/lib/types/sign-in-experience.js

@@ -1,6 +1,6 @@
 import { connectorMetadataGuard, googleOneTapConfigGuard, } from '@logto/connector-kit';
 import { z } from 'zod';
-import { SignInExperiences } from '../db-entries/index.js';
+import { CustomProfileFields, SignInExperiences, } from '../db-entries/index.js';
 import { CaptchaType } from '../foundations/jsonb-types/index.js';
 import { ssoConnectorMetadataGuard } from './sso-connector.js';
 export const fullSignInExperienceGuard = SignInExperiences.guard.extend({
@@ -25,4 +25,6 @@ export const fullSignInExperienceGuard = SignInExperiences.guard.extend({
         siteKey: z.string(),
     })
         .optional(),
+    // @charles TODO: Remove `optional` before release
+    customProfileFields: CustomProfileFields.guard.array().optional(),
 });

package/lib/types/sso-connector.d.ts

@@ -98,6 +98,7 @@ export declare const ssoConnectorWithProviderConfigGuard: z.ZodObject<{
         darkLogo?: string | undefined;
     }>;
     syncProfile: z.ZodType<boolean, z.ZodTypeDef, boolean>;
+    enableTokenStorage: z.ZodType<boolean, z.ZodTypeDef, boolean>;
     createdAt: z.ZodType<number, z.ZodTypeDef, number>;
 } & {
     providerName: z.ZodNativeEnum<typeof SsoProviderName>;
@@ -112,9 +113,10 @@ export declare const ssoConnectorWithProviderConfigGuard: z.ZodObject<{
     id: string;
     tenantId: string;
     createdAt: number;
-    branding: import("../index.js").SsoBranding;
     config: import("@withtyped/server").JsonObject;
+    branding: import("../index.js").SsoBranding;
     syncProfile: boolean;
+    enableTokenStorage: boolean;
     domains: import("../index.js").SsoDomains;
     providerName: SsoProviderName;
     connectorName: string;
@@ -127,9 +129,10 @@ export declare const ssoConnectorWithProviderConfigGuard: z.ZodObject<{
     id: string;
     tenantId: string;
     createdAt: number;
-    branding: import("../index.js").SsoBranding;
     config: import("@withtyped/server").JsonObject;
+    branding: import("../index.js").SsoBranding;
     syncProfile: boolean;
+    enableTokenStorage: boolean;
     domains: import("../index.js").SsoDomains;
     providerName: SsoProviderName;
     connectorName: string;
@@ -142,4 +145,27 @@ export type SsoConnectorWithProviderConfig = z.infer<typeof ssoConnectorWithProv
 export declare enum SsoAuthenticationQueryKey {
     SsoConnectorId = "ssoConnectorId"
 }
+export declare const extendedSocialUserInfoGuard: z.ZodObject<{
+    id: z.ZodString;
+    email: z.ZodOptional<z.ZodString>;
+    phone: z.ZodOptional<z.ZodString>;
+    name: z.ZodOptional<z.ZodString>;
+    avatar: z.ZodOptional<z.ZodString>;
+    rawData: z.ZodOptional<z.ZodType<import("@withtyped/server").Json, z.ZodTypeDef, import("@withtyped/server").Json>>;
+}, "strip", z.ZodUnknown, z.objectOutputType<{
+    id: z.ZodString;
+    email: z.ZodOptional<z.ZodString>;
+    phone: z.ZodOptional<z.ZodString>;
+    name: z.ZodOptional<z.ZodString>;
+    avatar: z.ZodOptional<z.ZodString>;
+    rawData: z.ZodOptional<z.ZodType<import("@withtyped/server").Json, z.ZodTypeDef, import("@withtyped/server").Json>>;
+}, z.ZodUnknown, "strip">, z.objectInputType<{
+    id: z.ZodString;
+    email: z.ZodOptional<z.ZodString>;
+    phone: z.ZodOptional<z.ZodString>;
+    name: z.ZodOptional<z.ZodString>;
+    avatar: z.ZodOptional<z.ZodString>;
+    rawData: z.ZodOptional<z.ZodType<import("@withtyped/server").Json, z.ZodTypeDef, import("@withtyped/server").Json>>;
+}, z.ZodUnknown, "strip">>;
+export type ExtendedSocialUserInfo = z.infer<typeof extendedSocialUserInfoGuard>;
 export {};

package/lib/types/sso-connector.js

@@ -1,3 +1,4 @@
+import { socialUserInfoGuard } from '@logto/connector-kit';
 import { z } from 'zod';
 import { SsoConnectors } from '../db-entries/sso-connector.js';
 /**
@@ -73,3 +74,5 @@ export var SsoAuthenticationQueryKey;
 (function (SsoAuthenticationQueryKey) {
     SsoAuthenticationQueryKey["SsoConnectorId"] = "ssoConnectorId";
 })(SsoAuthenticationQueryKey || (SsoAuthenticationQueryKey = {}));
+// Saml assertion returned user attribute value
+export const extendedSocialUserInfoGuard = socialUserInfoGuard.catchall(z.unknown());

package/lib/types/tenant.d.ts

@@ -2,3 +2,4 @@ export declare enum TenantTag {
     Development = "development",
     Production = "production"
 }
+export declare const defaultTenantIdKey = "defaultTenantId";

package/lib/types/tenant.js

@@ -5,3 +5,4 @@ export var TenantTag;
     /* A production tenant must have an associated subscription plan, even if it's a free plan. */
     TenantTag["Production"] = "production";
 })(TenantTag || (TenantTag = {}));
+export const defaultTenantIdKey = 'defaultTenantId';

package/lib/types/user-logto-config.d.ts

@@ -0,0 +1,45 @@
+import { z } from 'zod';
+/**
+ * The key for MFA-related data in user's logto_config
+ */
+export declare const userMfaDataKey = "mfa";
+/**
+ * Schema for MFA-related data stored in user's logto_config
+ */
+export declare const userMfaDataGuard: z.ZodObject<{
+    skipped: z.ZodOptional<z.ZodBoolean>;
+    skipMfaOnSignIn: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    skipped?: boolean | undefined;
+    skipMfaOnSignIn?: boolean | undefined;
+}, {
+    skipped?: boolean | undefined;
+    skipMfaOnSignIn?: boolean | undefined;
+}>;
+export type UserMfaData = z.infer<typeof userMfaDataGuard>;
+/**
+ * Schema for user's logto_config field
+ */
+export declare const userLogtoConfigGuard: z.ZodObject<{
+    mfa: z.ZodOptional<z.ZodObject<{
+        skipped: z.ZodOptional<z.ZodBoolean>;
+        skipMfaOnSignIn: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        skipped?: boolean | undefined;
+        skipMfaOnSignIn?: boolean | undefined;
+    }, {
+        skipped?: boolean | undefined;
+        skipMfaOnSignIn?: boolean | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    mfa?: {
+        skipped?: boolean | undefined;
+        skipMfaOnSignIn?: boolean | undefined;
+    } | undefined;
+}, {
+    mfa?: {
+        skipped?: boolean | undefined;
+        skipMfaOnSignIn?: boolean | undefined;
+    } | undefined;
+}>;
+export type UserLogtoConfig = z.infer<typeof userLogtoConfigGuard>;

package/lib/types/user-logto-config.js

@@ -0,0 +1,18 @@
+import { z } from 'zod';
+/**
+ * The key for MFA-related data in user's logto_config
+ */
+export const userMfaDataKey = 'mfa';
+/**
+ * Schema for MFA-related data stored in user's logto_config
+ */
+export const userMfaDataGuard = z.object({
+    skipped: z.boolean().optional(),
+    skipMfaOnSignIn: z.boolean().optional(),
+});
+/**
+ * Schema for user's logto_config field
+ */
+export const userLogtoConfigGuard = z.object({
+    [userMfaDataKey]: userMfaDataGuard.optional(),
+});