@logto/schemas 1.2.2 → 1.3.0

package/lib/db-entries/user.js

@@ -1,10 +1,10 @@
 // THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
 import { z } from 'zod';
-import { identitiesGuard, arbitraryObjectGuard } from './../foundations/index.js';
+import { identitiesGuard, jsonObjectGuard } from './../foundations/index.js';
 import { UsersPasswordEncryptionMethod } from './custom-types.js';
 const createGuard = z.object({
     tenantId: z.string().max(21).optional(),
-    id: z.string().max(12),
+    id: z.string().min(1).max(12),
     username: z.string().max(128).nullable().optional(),
     primaryEmail: z.string().max(128).nullable().optional(),
     primaryPhone: z.string().max(128).nullable().optional(),
@@ -14,7 +14,7 @@ const createGuard = z.object({
     avatar: z.string().max(2048).nullable().optional(),
     applicationId: z.string().max(21).nullable().optional(),
     identities: identitiesGuard.optional(),
-    customData: arbitraryObjectGuard.optional(),
+    customData: jsonObjectGuard.optional(),
     isSuspended: z.boolean().optional(),
     lastSignInAt: z.number().nullable().optional(),
     createdAt: z.number().optional(),
@@ -31,7 +31,7 @@ const guard = z.object({
     avatar: z.string().max(2048).nullable(),
     applicationId: z.string().max(21).nullable(),
     identities: identitiesGuard,
-    customData: arbitraryObjectGuard,
+    customData: jsonObjectGuard,
     isSuspended: z.boolean(),
     lastSignInAt: z.number().nullable(),
     createdAt: z.number(),

package/lib/db-entries/users-role.js

@@ -2,9 +2,9 @@
 import { z } from 'zod';
 const createGuard = z.object({
     tenantId: z.string().max(21).optional(),
-    id: z.string().max(21),
-    userId: z.string().max(21),
-    roleId: z.string().max(21),
+    id: z.string().min(1).max(21),
+    userId: z.string().min(1).max(21),
+    roleId: z.string().min(1).max(21),
 });
 const guard = z.object({
     tenantId: z.string().max(21),

package/lib/db-entries/verification-status.js

@@ -2,8 +2,8 @@
 import { z } from 'zod';
 const createGuard = z.object({
     tenantId: z.string().max(21).optional(),
-    id: z.string().max(21),
-    userId: z.string().max(21),
+    id: z.string().min(1).max(21),
+    userId: z.string().min(1).max(21),
     createdAt: z.number().optional(),
 });
 const guard = z.object({

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

@@ -1,7 +1,8 @@
+import type { Json } from '@withtyped/server';
 import { z } from 'zod';
 export { configurableConnectorMetadataGuard, type ConfigurableConnectorMetadata, } from '@logto/connector-kit';
-export declare const arbitraryObjectGuard: z.ZodRecord<z.ZodString, z.ZodUnknown>;
-export type ArbitraryObject = z.infer<typeof arbitraryObjectGuard>;
+export type { JsonObject } from '@withtyped/server';
+export declare const jsonObjectGuard: z.ZodRecord<z.ZodString, z.ZodType<Json, z.ZodTypeDef, Json>>;
 export declare const oidcModelInstancePayloadGuard: z.ZodObject<{
     userCode: z.ZodOptional<z.ZodString>;
     uid: z.ZodOptional<z.ZodString>;
@@ -227,17 +228,28 @@ export declare enum HookEvent {
     PostResetPassword = "PostResetPassword"
 }
 export declare const hookEventGuard: z.ZodType<HookEvent>;
-export type HookConfig = {
+export declare const hookEventsGuard: z.ZodArray<z.ZodType<HookEvent, z.ZodTypeDef, HookEvent>, "many">;
+export type HookEvents = z.infer<typeof hookEventsGuard>;
+export declare const hookConfigGuard: z.ZodObject<{
     /** We don't need `type` since v1 only has web hook */
     /** Method fixed to `POST` */
-    url: string;
+    url: z.ZodString;
     /** Additional headers that attach to the request */
-    headers?: Record<string, string>;
+    headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
     /**
+     * @deprecated
      * Retry times when hook response status >= 500.
-     *
-     * Must be less than or equal to `3`. Use `0` to disable retry.
-     **/
+     * Now the retry times is fixed to 3.
+     * Keep for backward compatibility.
+     */
+    retries: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    headers?: Record<string, string> | undefined;
+    url: string;
     retries: number;
-};
-export declare const hookConfigGuard: z.ZodType<HookConfig>;
+}, {
+    headers?: Record<string, string> | undefined;
+    url: string;
+    retries: number;
+}>;
+export type HookConfig = z.infer<typeof hookConfigGuard>;

package/lib/foundations/jsonb-types.js

@@ -3,7 +3,10 @@ import { languageTagGuard } from '@logto/language-kit';
 import { z } from 'zod';
 export { configurableConnectorMetadataGuard, } from '@logto/connector-kit';
 /* === Commonly Used === */
-export const arbitraryObjectGuard = z.record(z.unknown());
+// Copied from https://github.com/colinhacks/zod#json-type
+const literalSchema = z.union([z.string(), z.number(), z.boolean(), z.null()]);
+const jsonGuard = z.lazy(() => z.union([literalSchema, z.array(jsonGuard), z.record(jsonGuard)]));
+export const jsonObjectGuard = z.record(jsonGuard);
 /* === OIDC Model Instances === */
 export const oidcModelInstancePayloadGuard = z
     .object({
@@ -123,8 +126,19 @@ export var HookEvent;
     HookEvent["PostResetPassword"] = "PostResetPassword";
 })(HookEvent || (HookEvent = {}));
 export const hookEventGuard = z.nativeEnum(HookEvent);
+export const hookEventsGuard = hookEventGuard.array();
 export const hookConfigGuard = z.object({
+    /** We don't need `type` since v1 only has web hook */
+    // type: 'web';
+    /** Method fixed to `POST` */
     url: z.string(),
+    /** Additional headers that attach to the request */
     headers: z.record(z.string()).optional(),
+    /**
+     * @deprecated
+     * Retry times when hook response status >= 500.
+     * Now the retry times is fixed to 3.
+     * Keep for backward compatibility.
+     */
     retries: z.number().gte(0).lte(3),
 });