@logto/schemas 1.17.0 → 1.19.0

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

@@ -0,0 +1,21 @@
+import { connectorMetadataGuard, googleOneTapConfigGuard, } from '@logto/connector-kit';
+import { z } from 'zod';
+import { SignInExperiences } from '../db-entries/index.js';
+import { ssoConnectorMetadataGuard } from './sso-connector.js';
+export const fullSignInExperienceGuard = SignInExperiences.guard.extend({
+    socialConnectors: connectorMetadataGuard
+        .omit({
+        description: true,
+        configTemplate: true,
+        formItems: true,
+        readme: true,
+        customData: true,
+    })
+        .array(),
+    ssoConnectors: ssoConnectorMetadataGuard.array(),
+    forgotPassword: z.object({ phone: z.boolean(), email: z.boolean() }),
+    isDevelopmentTenant: z.boolean(),
+    googleOneTap: googleOneTapConfigGuard
+        .extend({ clientId: z.string(), connectorId: z.string() })
+        .optional(),
+});

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

@@ -82,10 +82,13 @@ export declare const ssoConnectorProvidersResponseGuard: z.ZodArray<z.ZodObject<
     providerType: SsoProviderType;
 }>, "many">;
 export type SsoConnectorProvidersResponse = z.infer<typeof ssoConnectorProvidersResponseGuard>;
-export declare const ssoConnectorWithProviderConfigGuard: z.ZodObject<{
-    id: z.ZodType<string, z.ZodTypeDef, string>;
+export declare const ssoConnectorWithProviderConfigGuard: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<{
     tenantId: z.ZodType<string, z.ZodTypeDef, string>;
-    createdAt: z.ZodType<number, z.ZodTypeDef, number>;
+    id: z.ZodType<string, z.ZodTypeDef, string>;
+    providerName: z.ZodType<string, z.ZodTypeDef, string>;
+    connectorName: z.ZodType<string, z.ZodTypeDef, string>;
+    config: z.ZodType<import("@withtyped/server").JsonObject, z.ZodTypeDef, import("@withtyped/server").JsonObject>;
+    domains: z.ZodType<string[], z.ZodTypeDef, string[]>;
     branding: z.ZodType<{
         displayName?: string | undefined;
         logo?: string | undefined;
@@ -96,28 +99,24 @@ export declare const ssoConnectorWithProviderConfigGuard: z.ZodObject<{
         darkLogo?: string | undefined;
     }>;
     syncProfile: z.ZodType<boolean, z.ZodTypeDef, boolean>;
-    config: z.ZodType<import("@withtyped/server").JsonObject, z.ZodTypeDef, import("@withtyped/server").JsonObject>;
-    domains: z.ZodType<string[], z.ZodTypeDef, string[]>;
+    createdAt: z.ZodType<number, z.ZodTypeDef, number>;
+}, {
     providerName: z.ZodNativeEnum<typeof SsoProviderName>;
-    connectorName: z.ZodType<string, z.ZodTypeDef, string>;
+}>, {
     name: z.ZodString;
     providerType: z.ZodNativeEnum<typeof SsoProviderType>;
     providerLogo: z.ZodString;
     providerLogoDark: z.ZodString;
     providerConfig: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-}, "strip", z.ZodTypeAny, {
+}>, "strip", z.ZodTypeAny, {
     name: string;
     id: string;
     tenantId: string;
     createdAt: number;
-    branding: {
-        displayName?: string | undefined;
-        logo?: string | undefined;
-        darkLogo?: string | undefined;
-    };
+    branding: import("../index.js").SsoBranding;
     syncProfile: boolean;
     config: import("@withtyped/server").JsonObject;
-    domains: string[];
+    domains: import("../index.js").SsoDomains;
     providerName: SsoProviderName;
     connectorName: string;
     providerType: SsoProviderType;
@@ -129,14 +128,10 @@ export declare const ssoConnectorWithProviderConfigGuard: z.ZodObject<{
     id: string;
     tenantId: string;
     createdAt: number;
-    branding: {
-        displayName?: string | undefined;
-        logo?: string | undefined;
-        darkLogo?: string | undefined;
-    };
+    branding: import("../index.js").SsoBranding;
     syncProfile: boolean;
     config: import("@withtyped/server").JsonObject;
-    domains: string[];
+    domains: import("../index.js").SsoDomains;
     providerName: SsoProviderName;
     connectorName: string;
     providerType: SsoProviderType;

package/lib/types/ssr.d.ts

@@ -0,0 +1,25 @@
+import { type LocalePhrase } from '@logto/phrases-experience';
+import { type FullSignInExperience } from './sign-in-experience.js';
+/**
+ * The server-side rendering data type for **experience**.
+ */
+export type SsrData = {
+    signInExperience: {
+        appId?: string;
+        organizationId?: string;
+        data: FullSignInExperience;
+    };
+    phrases: {
+        lng: string;
+        data: LocalePhrase;
+    };
+};
+/**
+ * Variable placeholder for **experience** server-side rendering. The value should be replaced by
+ * the server.
+ *
+ * CAUTION: The value should be kept in sync with {@link file://./../../../experience/src/index.html}.
+ *
+ * @see {@link SsrData} for the data structure to replace the placeholders.
+ */
+export declare const ssrPlaceholder = "\"__LOGTO_SSR__\"";

package/lib/types/ssr.js

@@ -0,0 +1,9 @@
+/**
+ * Variable placeholder for **experience** server-side rendering. The value should be replaced by
+ * the server.
+ *
+ * CAUTION: The value should be kept in sync with {@link file://./../../../experience/src/index.html}.
+ *
+ * @see {@link SsrData} for the data structure to replace the placeholders.
+ */
+export const ssrPlaceholder = '"__LOGTO_SSR__"';

package/lib/types/subject-token.d.ts

@@ -0,0 +1,12 @@
+import { type z } from 'zod';
+export declare const subjectTokenResponseGuard: z.ZodObject<{
+    subjectToken: z.ZodString;
+    expiresIn: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    subjectToken: string;
+    expiresIn: number;
+}, {
+    subjectToken: string;
+    expiresIn: number;
+}>;
+export type SubjectTokenResponse = z.infer<typeof subjectTokenResponseGuard>;

package/lib/types/subject-token.js

@@ -0,0 +1,5 @@
+import { number, object, string } from 'zod';
+export const subjectTokenResponseGuard = object({
+    subjectToken: string(),
+    expiresIn: number(),
+});

package/lib/types/system.d.ts

@@ -46,17 +46,17 @@ export declare const storageProviderDataGuard: z.ZodDiscriminatedUnion<"provider
     bucket: string;
     accessKeyId: string;
     accessSecretKey: string;
+    region?: string | undefined;
     publicUrl?: string | undefined;
     endpoint?: string | undefined;
-    region?: string | undefined;
 }, {
     provider: StorageProvider.S3Storage;
     bucket: string;
     accessKeyId: string;
     accessSecretKey: string;
+    region?: string | undefined;
     publicUrl?: string | undefined;
     endpoint?: string | undefined;
-    region?: string | undefined;
 }>, z.ZodObject<{
     publicUrl: z.ZodOptional<z.ZodString>;
     provider: z.ZodLiteral<StorageProvider.GoogleStorage>;
@@ -78,10 +78,14 @@ export declare const storageProviderDataGuard: z.ZodDiscriminatedUnion<"provider
 }>]>;
 export type StorageProviderData = z.infer<typeof storageProviderDataGuard>;
 export declare enum StorageProviderKey {
-    StorageProvider = "storageProvider"
+    StorageProvider = "storageProvider",
+    ExperienceBlobsProvider = "experienceBlobsProvider",
+    ExperienceZipsProvider = "experienceZipsProvider"
 }
 export type StorageProviderType = {
     [StorageProviderKey.StorageProvider]: StorageProviderData;
+    [StorageProviderKey.ExperienceBlobsProvider]: StorageProviderData;
+    [StorageProviderKey.ExperienceZipsProvider]: StorageProviderData;
 };
 export declare const storageProviderGuard: Readonly<{
     [key in StorageProviderKey]: ZodType<StorageProviderType[key]>;
@@ -96,17 +100,17 @@ export declare const sendgridEmailServiceConfigGuard: z.ZodObject<{
     fromName: z.ZodString;
     fromEmail: z.ZodString;
 }, "strip", z.ZodTypeAny, {
+    fromEmail: string;
     provider: EmailServiceProvider;
     apiKey: string;
     templateId: string;
     fromName: string;
-    fromEmail: string;
 }, {
+    fromEmail: string;
     provider: EmailServiceProvider;
     apiKey: string;
     templateId: string;
     fromName: string;
-    fromEmail: string;
 }>;
 export type SendgridEmailServiceConfig = z.infer<typeof sendgridEmailServiceConfigGuard>;
 export declare const emailServiceConfigGuard: z.ZodDiscriminatedUnion<"provider", [z.ZodObject<{
@@ -116,17 +120,17 @@ export declare const emailServiceConfigGuard: z.ZodDiscriminatedUnion<"provider"
     fromName: z.ZodString;
     fromEmail: z.ZodString;
 }, "strip", z.ZodTypeAny, {
+    fromEmail: string;
     provider: EmailServiceProvider;
     apiKey: string;
     templateId: string;
     fromName: string;
-    fromEmail: string;
 }, {
+    fromEmail: string;
     provider: EmailServiceProvider;
     apiKey: string;
     templateId: string;
     fromName: string;
-    fromEmail: string;
 }>]>;
 export type EmailServiceConfig = z.infer<typeof emailServiceConfigGuard>;
 export declare enum EmailServiceProviderKey {

package/lib/types/system.js

@@ -47,9 +47,13 @@ export const storageProviderDataGuard = z.discriminatedUnion('provider', [
 export var StorageProviderKey;
 (function (StorageProviderKey) {
     StorageProviderKey["StorageProvider"] = "storageProvider";
+    StorageProviderKey["ExperienceBlobsProvider"] = "experienceBlobsProvider";
+    StorageProviderKey["ExperienceZipsProvider"] = "experienceZipsProvider";
 })(StorageProviderKey || (StorageProviderKey = {}));
 export const storageProviderGuard = Object.freeze({
     [StorageProviderKey.StorageProvider]: storageProviderDataGuard,
+    [StorageProviderKey.ExperienceBlobsProvider]: storageProviderDataGuard,
+    [StorageProviderKey.ExperienceZipsProvider]: storageProviderDataGuard,
 });
 // Email service provider
 export var EmailServiceProvider;

package/lib/types/tenant-organization.d.ts

@@ -98,6 +98,7 @@ export declare enum TenantRole {
  *   id: 'collaborator',
  *   name: 'collaborator',
  *   description: 'Collaborator of the tenant, who has permissions to operate the tenant data, but not the tenant settings.',
+ *   type: RoleType.User,
  * });
  * ```
  *

package/lib/types/tenant-organization.js

@@ -6,6 +6,7 @@
  *
  * This module provides utilities to manage tenant organizations.
  */
+import { RoleType, } from '../db-entries/index.js';
 import { adminTenantId } from '../seeds/tenant.js';
 /** Given a tenant ID, return the corresponding organization ID in the admin tenant. */
 export const getTenantOrganizationId = (tenantId) => `t-${tenantId}`;
@@ -129,6 +130,7 @@ const tenantRoleDescriptions = Object.freeze({
  *   id: 'collaborator',
  *   name: 'collaborator',
  *   description: 'Collaborator of the tenant, who has permissions to operate the tenant data, but not the tenant settings.',
+ *   type: RoleType.User,
  * });
  * ```
  *
@@ -139,6 +141,7 @@ export const getTenantRole = (role) => Object.freeze({
     id: role,
     name: role,
     description: tenantRoleDescriptions[role],
+    type: RoleType.User,
 });
 /**
  * The dictionary of tenant roles and their corresponding scopes.

package/lib/types/user-assets.d.ts

@@ -1,19 +1,19 @@
 import { z } from 'zod';
 export declare const maxUploadFileSize: number;
-export declare const allowUploadMimeTypes: readonly ["image/jpeg", "image/png", "image/gif", "image/vnd.microsoft.icon", "image/x-icon", "image/svg+xml", "image/tiff", "image/webp", "image/bmp"];
-declare const allowUploadMimeTypeGuard: z.ZodEnum<["image/jpeg", "image/png", "image/gif", "image/vnd.microsoft.icon", "image/x-icon", "image/svg+xml", "image/tiff", "image/webp", "image/bmp"]>;
+export declare const allowUploadMimeTypes: readonly ["image/jpeg", "image/png", "image/gif", "image/vnd.microsoft.icon", "image/x-icon", "image/svg+xml", "image/tiff", "image/webp", "image/bmp", "application/zip"];
+declare const allowUploadMimeTypeGuard: z.ZodEnum<["image/jpeg", "image/png", "image/gif", "image/vnd.microsoft.icon", "image/x-icon", "image/svg+xml", "image/tiff", "image/webp", "image/bmp", "application/zip"]>;
 export type AllowedUploadMimeType = z.infer<typeof allowUploadMimeTypeGuard>;
 export declare const userAssetsServiceStatusGuard: z.ZodObject<{
     status: z.ZodUnion<[z.ZodLiteral<"ready">, z.ZodLiteral<"not_configured">]>;
-    allowUploadMimeTypes: z.ZodOptional<z.ZodArray<z.ZodEnum<["image/jpeg", "image/png", "image/gif", "image/vnd.microsoft.icon", "image/x-icon", "image/svg+xml", "image/tiff", "image/webp", "image/bmp"]>, "many">>;
+    allowUploadMimeTypes: z.ZodOptional<z.ZodArray<z.ZodEnum<["image/jpeg", "image/png", "image/gif", "image/vnd.microsoft.icon", "image/x-icon", "image/svg+xml", "image/tiff", "image/webp", "image/bmp", "application/zip"]>, "many">>;
     maxUploadFileSize: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
     status: "ready" | "not_configured";
-    allowUploadMimeTypes?: ("image/jpeg" | "image/png" | "image/gif" | "image/vnd.microsoft.icon" | "image/x-icon" | "image/svg+xml" | "image/tiff" | "image/webp" | "image/bmp")[] | undefined;
+    allowUploadMimeTypes?: ("image/jpeg" | "image/png" | "image/gif" | "image/vnd.microsoft.icon" | "image/x-icon" | "image/svg+xml" | "image/tiff" | "image/webp" | "image/bmp" | "application/zip")[] | undefined;
     maxUploadFileSize?: number | undefined;
 }, {
     status: "ready" | "not_configured";
-    allowUploadMimeTypes?: ("image/jpeg" | "image/png" | "image/gif" | "image/vnd.microsoft.icon" | "image/x-icon" | "image/svg+xml" | "image/tiff" | "image/webp" | "image/bmp")[] | undefined;
+    allowUploadMimeTypes?: ("image/jpeg" | "image/png" | "image/gif" | "image/vnd.microsoft.icon" | "image/x-icon" | "image/svg+xml" | "image/tiff" | "image/webp" | "image/bmp" | "application/zip")[] | undefined;
     maxUploadFileSize?: number | undefined;
 }>;
 export type UserAssetsServiceStatus = z.infer<typeof userAssetsServiceStatusGuard>;
@@ -25,4 +25,24 @@ export declare const userAssetsGuard: z.ZodObject<{
     url: string;
 }>;
 export type UserAssets = z.infer<typeof userAssetsGuard>;
+export declare const uploadFileGuard: z.ZodObject<{
+    filepath: z.ZodString;
+    mimetype: z.ZodString;
+    originalFilename: z.ZodString;
+    size: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    filepath: string;
+    mimetype: string;
+    originalFilename: string;
+    size: number;
+}, {
+    filepath: string;
+    mimetype: string;
+    originalFilename: string;
+    size: number;
+}>;
+type MimeTypeToFileExtensionMappings = {
+    [key in AllowedUploadMimeType]: readonly string[];
+};
+export declare const mimeTypeToFileExtensionMappings: MimeTypeToFileExtensionMappings;
 export {};

package/lib/types/user-assets.js

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-export const maxUploadFileSize = 8 * 1024 * 1024; // 8MB
+export const maxUploadFileSize = 20 * 1024 * 1024; // 20 MB
 // Reference: https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types
 export const allowUploadMimeTypes = [
     'image/jpeg',
@@ -11,6 +11,7 @@ export const allowUploadMimeTypes = [
     'image/tiff',
     'image/webp',
     'image/bmp',
+    'application/zip',
 ];
 const allowUploadMimeTypeGuard = z.enum(allowUploadMimeTypes);
 export const userAssetsServiceStatusGuard = z.object({
@@ -21,3 +22,21 @@ export const userAssetsServiceStatusGuard = z.object({
 export const userAssetsGuard = z.object({
     url: z.string(),
 });
+export const uploadFileGuard = z.object({
+    filepath: z.string(),
+    mimetype: z.string(),
+    originalFilename: z.string(),
+    size: z.number(),
+});
+export const mimeTypeToFileExtensionMappings = Object.freeze({
+    'image/jpeg': ['jpeg', 'jpg'],
+    'image/png': ['png'],
+    'image/gif': ['gif'],
+    'image/vnd.microsoft.icon': ['ico'],
+    'image/x-icon': ['ico'],
+    'image/svg+xml': ['svg'],
+    'image/tiff': ['tif', 'tiff'],
+    'image/webp': ['webp'],
+    'image/bmp': ['bmp'],
+    'application/zip': ['zip'],
+});