@logto/schemas 1.2.2 → 1.2.3

package/alterations/1.0.0-1678716747-service-logs.ts

@@ -25,7 +25,7 @@ const alteration: AlterationScript = {
         tenant_id varchar(21) not null
           references tenants (id) on update cascade on delete cascade,
         type varchar(64) not null,
-        payload jsonb /* @use ArbitraryObject */ not null default '{}'::jsonb,
+        payload jsonb /* @use JsonObject */ not null default '{}'::jsonb,
         created_at timestamptz not null default(now()),
         primary key (id)
       );

package/alterations/1.0.0_beta.10-1-logto-config.ts

@@ -7,7 +7,7 @@ const alteration: AlterationScript = {
     await pool.query(sql`
       create table _logto_configs (
         key varchar(256) not null,
-        value jsonb /* @use ArbitraryObject */ not null default '{}'::jsonb,
+        value jsonb /* @use JsonObject */ not null default '{}'::jsonb,
         primary key (key)
       );
     `);

package/alterations-js/1.0.0-1678716747-service-logs.js

@@ -17,7 +17,7 @@ const alteration = {
         tenant_id varchar(21) not null
           references tenants (id) on update cascade on delete cascade,
         type varchar(64) not null,
-        payload jsonb /* @use ArbitraryObject */ not null default '{}'::jsonb,
+        payload jsonb /* @use JsonObject */ not null default '{}'::jsonb,
         created_at timestamptz not null default(now()),
         primary key (id)
       );

package/alterations-js/1.0.0_beta.10-1-logto-config.js

@@ -4,7 +4,7 @@ const alteration = {
         await pool.query(sql `
       create table _logto_configs (
         key varchar(256) not null,
-        value jsonb /* @use ArbitraryObject */ not null default '{}'::jsonb,
+        value jsonb /* @use JsonObject */ not null default '{}'::jsonb,
         primary key (key)
       );
     `);

package/lib/db-entries/connector.d.ts

@@ -1,10 +1,10 @@
-import { ArbitraryObject, ConfigurableConnectorMetadata, GeneratedSchema } from './../foundations/index.js';
+import { JsonObject, ConfigurableConnectorMetadata, GeneratedSchema } from './../foundations/index.js';
 export type CreateConnector = {
     tenantId?: string;
     id: string;
     syncProfile?: boolean;
     connectorId: string;
-    config?: ArbitraryObject;
+    config?: JsonObject;
     metadata?: ConfigurableConnectorMetadata;
     createdAt?: number;
 };
@@ -13,7 +13,7 @@ export type Connector = {
     id: string;
     syncProfile: boolean;
     connectorId: string;
-    config: ArbitraryObject;
+    config: JsonObject;
     metadata: ConfigurableConnectorMetadata;
     createdAt: number;
 };

package/lib/db-entries/connector.js

@@ -1,12 +1,12 @@
 // THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
 import { z } from 'zod';
-import { arbitraryObjectGuard, configurableConnectorMetadataGuard } from './../foundations/index.js';
+import { jsonObjectGuard, configurableConnectorMetadataGuard } from './../foundations/index.js';
 const createGuard = z.object({
     tenantId: z.string().max(21).optional(),
     id: z.string().max(128),
     syncProfile: z.boolean().optional(),
     connectorId: z.string().max(128),
-    config: arbitraryObjectGuard.optional(),
+    config: jsonObjectGuard.optional(),
     metadata: configurableConnectorMetadataGuard.optional(),
     createdAt: z.number().optional(),
 });
@@ -15,7 +15,7 @@ const guard = z.object({
     id: z.string().max(128),
     syncProfile: z.boolean(),
     connectorId: z.string().max(128),
-    config: arbitraryObjectGuard,
+    config: jsonObjectGuard,
     metadata: configurableConnectorMetadataGuard,
     createdAt: z.number(),
 });

package/lib/db-entries/logto-config.d.ts

@@ -1,12 +1,12 @@
-import { ArbitraryObject, GeneratedSchema } from './../foundations/index.js';
+import { JsonObject, GeneratedSchema } from './../foundations/index.js';
 export type CreateLogtoConfig = {
     tenantId?: string;
     key: string;
-    value?: ArbitraryObject;
+    value?: JsonObject;
 };
 export type LogtoConfig = {
     tenantId: string;
     key: string;
-    value: ArbitraryObject;
+    value: JsonObject;
 };
 export declare const LogtoConfigs: GeneratedSchema<CreateLogtoConfig, LogtoConfig>;

package/lib/db-entries/logto-config.js

@@ -1,15 +1,15 @@
 // THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
 import { z } from 'zod';
-import { arbitraryObjectGuard } from './../foundations/index.js';
+import { jsonObjectGuard } from './../foundations/index.js';
 const createGuard = z.object({
     tenantId: z.string().max(21).optional(),
     key: z.string().max(256),
-    value: arbitraryObjectGuard.optional(),
+    value: jsonObjectGuard.optional(),
 });
 const guard = z.object({
     tenantId: z.string().max(21),
     key: z.string().max(256),
-    value: arbitraryObjectGuard,
+    value: jsonObjectGuard,
 });
 export const LogtoConfigs = Object.freeze({
     table: 'logto_configs',

package/lib/db-entries/service-log.d.ts

@@ -1,16 +1,16 @@
-import { ArbitraryObject, GeneratedSchema } from './../foundations/index.js';
+import { JsonObject, GeneratedSchema } from './../foundations/index.js';
 export type CreateServiceLog = {
     id: string;
     tenantId?: string;
     type: string;
-    payload?: ArbitraryObject;
+    payload?: JsonObject;
     createdAt?: number;
 };
 export type ServiceLog = {
     id: string;
     tenantId: string;
     type: string;
-    payload: ArbitraryObject;
+    payload: JsonObject;
     createdAt: number;
 };
 export declare const ServiceLogs: GeneratedSchema<CreateServiceLog, ServiceLog>;

package/lib/db-entries/service-log.js

@@ -1,18 +1,18 @@
 // THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
 import { z } from 'zod';
-import { arbitraryObjectGuard } from './../foundations/index.js';
+import { jsonObjectGuard } from './../foundations/index.js';
 const createGuard = z.object({
     id: z.string().max(21),
     tenantId: z.string().max(21).optional(),
     type: z.string().max(64),
-    payload: arbitraryObjectGuard.optional(),
+    payload: jsonObjectGuard.optional(),
     createdAt: z.number().optional(),
 });
 const guard = z.object({
     id: z.string().max(21),
     tenantId: z.string().max(21),
     type: z.string().max(64),
-    payload: arbitraryObjectGuard,
+    payload: jsonObjectGuard,
     createdAt: z.number(),
 });
 export const ServiceLogs = Object.freeze({

package/lib/db-entries/system.d.ts

@@ -1,10 +1,10 @@
-import { ArbitraryObject, GeneratedSchema } from './../foundations/index.js';
+import { JsonObject, GeneratedSchema } from './../foundations/index.js';
 export type CreateSystem = {
     key: string;
-    value?: ArbitraryObject;
+    value?: JsonObject;
 };
 export type System = {
     key: string;
-    value: ArbitraryObject;
+    value: JsonObject;
 };
 export declare const Systems: GeneratedSchema<CreateSystem, System>;

package/lib/db-entries/system.js

@@ -1,13 +1,13 @@
 // THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
 import { z } from 'zod';
-import { arbitraryObjectGuard } from './../foundations/index.js';
+import { jsonObjectGuard } from './../foundations/index.js';
 const createGuard = z.object({
     key: z.string().max(256),
-    value: arbitraryObjectGuard.optional(),
+    value: jsonObjectGuard.optional(),
 });
 const guard = z.object({
     key: z.string().max(256),
-    value: arbitraryObjectGuard,
+    value: jsonObjectGuard,
 });
 export const Systems = Object.freeze({
     table: 'systems',

package/lib/db-entries/user.d.ts

@@ -1,4 +1,4 @@
-import { Identities, ArbitraryObject, GeneratedSchema } from './../foundations/index.js';
+import { Identities, JsonObject, GeneratedSchema } from './../foundations/index.js';
 import { UsersPasswordEncryptionMethod } from './custom-types.js';
 export type CreateUser = {
     tenantId?: string;
@@ -12,7 +12,7 @@ export type CreateUser = {
     avatar?: string | null;
     applicationId?: string | null;
     identities?: Identities;
-    customData?: ArbitraryObject;
+    customData?: JsonObject;
     isSuspended?: boolean;
     lastSignInAt?: number | null;
     createdAt?: number;
@@ -29,7 +29,7 @@ export type User = {
     avatar: string | null;
     applicationId: string | null;
     identities: Identities;
-    customData: ArbitraryObject;
+    customData: JsonObject;
     isSuspended: boolean;
     lastSignInAt: number | null;
     createdAt: number;

package/lib/db-entries/user.js

@@ -1,6 +1,6 @@
 // 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(),
@@ -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/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>;

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({

package/lib/types/interactions.d.ts

@@ -38,13 +38,13 @@ export declare const phonePasswordPayloadGuard: z.ZodObject<{
 export type PhonePasswordPayload = z.infer<typeof phonePasswordPayloadGuard>;
 export declare const socialConnectorPayloadGuard: z.ZodObject<{
     connectorId: z.ZodString;
-    connectorData: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    connectorData: z.ZodRecord<z.ZodString, z.ZodType<import("@withtyped/server").Json, z.ZodTypeDef, import("@withtyped/server").Json>>;
 }, "strip", z.ZodTypeAny, {
     connectorId: string;
-    connectorData: Record<string, unknown>;
+    connectorData: Record<string, import("@withtyped/server").Json>;
 }, {
     connectorId: string;
-    connectorData: Record<string, unknown>;
+    connectorData: Record<string, import("@withtyped/server").Json>;
 }>;
 export type SocialConnectorPayload = z.infer<typeof socialConnectorPayloadGuard>;
 export declare const socialEmailPayloadGuard: z.ZodObject<{
@@ -123,13 +123,13 @@ export declare const identifierPayloadGuard: z.ZodUnion<[z.ZodObject<{
     verificationCode: string;
 }>, z.ZodObject<{
     connectorId: z.ZodString;
-    connectorData: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    connectorData: z.ZodRecord<z.ZodString, z.ZodType<import("@withtyped/server").Json, z.ZodTypeDef, import("@withtyped/server").Json>>;
 }, "strip", z.ZodTypeAny, {
     connectorId: string;
-    connectorData: Record<string, unknown>;
+    connectorData: Record<string, import("@withtyped/server").Json>;
 }, {
     connectorId: string;
-    connectorData: Record<string, unknown>;
+    connectorData: Record<string, import("@withtyped/server").Json>;
 }>, z.ZodObject<{
     connectorId: z.ZodString;
     email: z.ZodString;

package/lib/types/interactions.js

@@ -1,6 +1,6 @@
 import { emailRegEx, phoneRegEx, usernameRegEx, passwordRegEx } from '@logto/core-kit';
 import { z } from 'zod';
-import { arbitraryObjectGuard } from '../foundations/index.js';
+import { jsonObjectGuard } from '../foundations/index.js';
 import { emailVerificationCodePayloadGuard, phoneVerificationCodePayloadGuard, } from './verification-code.js';
 /**
  * Detailed Identifier Methods guard
@@ -19,7 +19,7 @@ export const phonePasswordPayloadGuard = z.object({
 });
 export const socialConnectorPayloadGuard = z.object({
     connectorId: z.string(),
-    connectorData: arbitraryObjectGuard,
+    connectorData: jsonObjectGuard,
 });
 export const socialEmailPayloadGuard = z.object({
     connectorId: z.string(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logto/schemas",
-  "version": "1.2.2",
+  "version": "1.2.3",
   "author": "Silverhand Inc. <contact@silverhand.io>",
   "license": "MPL-2.0",
   "type": "module",

package/tables/connectors.sql

@@ -4,7 +4,7 @@ create table connectors (
   id varchar(128) not null,
   sync_profile boolean not null default FALSE,
   connector_id varchar(128) not null,
-  config jsonb /* @use ArbitraryObject */ not null default '{}'::jsonb,
+  config jsonb /* @use JsonObject */ not null default '{}'::jsonb,
   metadata jsonb /* @use ConfigurableConnectorMetadata */ not null default '{}'::jsonb,
   created_at timestamptz not null default(now()),
   primary key (id)

package/tables/logto_configs.sql

@@ -2,6 +2,6 @@ create table logto_configs (
   tenant_id varchar(21) not null
     references tenants (id) on update cascade on delete cascade,
   key varchar(256) not null,
-  value jsonb /* @use ArbitraryObject */ not null default '{}'::jsonb,
+  value jsonb /* @use JsonObject */ not null default '{}'::jsonb,
   primary key (tenant_id, key)
 );

package/tables/service_logs.sql

@@ -3,7 +3,7 @@ create table service_logs (
   tenant_id varchar(21) not null
     references tenants (id) on update cascade on delete cascade,
   type varchar(64) not null,
-  payload jsonb /* @use ArbitraryObject */ not null default '{}'::jsonb,
+  payload jsonb /* @use JsonObject */ not null default '{}'::jsonb,
   created_at timestamptz not null default(now()),
   primary key (id)
 );

package/tables/systems.sql

@@ -1,6 +1,6 @@
 create table systems (
   key varchar(256) not null,
-  value jsonb /* @use ArbitraryObject */ not null default '{}'::jsonb,
+  value jsonb /* @use JsonObject */ not null default '{}'::jsonb,
   primary key (key)
 );
 

package/tables/users.sql

@@ -15,7 +15,7 @@ create table users (
   avatar varchar(2048),
   application_id varchar(21),
   identities jsonb /* @use Identities */ not null default '{}'::jsonb,
-  custom_data jsonb /* @use ArbitraryObject */ not null default '{}'::jsonb,
+  custom_data jsonb /* @use JsonObject */ not null default '{}'::jsonb,
   is_suspended boolean not null default false,
   last_sign_in_at timestamptz,
   created_at timestamptz not null default (now()),