refactor(schemas,core,console): use JsonObject instead of ArbitraryObject (#3730)

packages/console/package.json

@@ -87,7 +87,7 @@
     "react-dom": "^18.0.0",
     "react-dropzone": "^14.2.3",
     "react-helmet": "^6.1.0",
-    "react-hook-form": "^7.34.0",
+    "react-hook-form": "^7.43.9",
     "react-hot-toast": "^2.2.0",
     "react-i18next": "^12.2.0",
     "react-markdown": "^8.0.0",

packages/console/src/components/ConnectorLogo/index.tsx

@@ -1,5 +1,5 @@
-import type { ConnectorResponse } from '@logto/schemas';
 import { Theme } from '@logto/schemas';
+import type { ConnectorResponse } from '@logto/schemas';
 import classNames from 'classnames';
 
 import useTheme from '@/hooks/use-theme';

packages/console/src/components/SignInExperiencePreview/index.tsx

@@ -1,6 +1,6 @@
 import type { LanguageTag } from '@logto/language-kit';
-import type { ConnectorMetadata, ConnectorResponse, SignInExperience } from '@logto/schemas';
 import { Theme, ConnectorType } from '@logto/schemas';
+import type { ConnectorMetadata, SignInExperience, ConnectorResponse } from '@logto/schemas';
 import { conditional } from '@silverhand/essentials';
 import classNames from 'classnames';
 import { format } from 'date-fns';

packages/console/src/components/UserAccountInformation/index.tsx

@@ -1,5 +1,5 @@
 import type { AdminConsoleKey } from '@logto/phrases';
-import { type User } from '@logto/schemas';
+import type { User } from '@logto/schemas';
 import { conditionalArray } from '@silverhand/essentials';
 import { useState } from 'react';
 import { toast } from 'react-hot-toast';

packages/console/src/hooks/use-connector-in-use.ts

@@ -1,5 +1,5 @@
-import type { ConnectorResponse, SignInExperience } from '@logto/schemas';
 import { SignInIdentifier, ConnectorType } from '@logto/schemas';
+import type { SignInExperience, ConnectorResponse } from '@logto/schemas';
 import { useCallback } from 'react';
 import useSWR from 'swr';
 

packages/console/src/hooks/use-enabled-connector-types.ts

@@ -1,4 +1,4 @@
-import type { ConnectorResponse, ConnectorType } from '@logto/schemas';
+import type { ConnectorType, ConnectorResponse } from '@logto/schemas';
 import { useCallback, useMemo } from 'react';
 import useSWR from 'swr';
 

packages/console/src/pages/ConnectorDetails/components/ConnectorContent.tsx

@@ -1,5 +1,5 @@
-import type { ConnectorResponse } from '@logto/schemas';
 import { ConnectorType } from '@logto/schemas';
+import type { ConnectorResponse } from '@logto/schemas';
 import type { Optional } from '@silverhand/essentials';
 import { conditional } from '@silverhand/essentials';
 import { useEffect } from 'react';

packages/console/src/pages/ConnectorDetails/components/ConnectorTabs/index.tsx

@@ -1,5 +1,5 @@
-import type { ConnectorResponse } from '@logto/schemas';
 import { ConnectorType, ConnectorPlatform } from '@logto/schemas';
+import type { ConnectorResponse } from '@logto/schemas';
 import classNames from 'classnames';
 import { useTranslation } from 'react-i18next';
 import { Link } from 'react-router-dom';

packages/console/src/pages/ConnectorDetails/components/DeleteConnectorConfirmModal/index.tsx

@@ -1,5 +1,5 @@
-import type { ConnectorResponse } from '@logto/schemas';
 import { ConnectorType } from '@logto/schemas';
+import type { ConnectorResponse } from '@logto/schemas';
 import { Trans, useTranslation } from 'react-i18next';
 
 import ConfirmModal from '@/components/ConfirmModal';

packages/console/src/pages/Connectors/components/CreateForm/index.tsx

@@ -1,5 +1,5 @@
-import type { ConnectorFactoryResponse, ConnectorResponse } from '@logto/schemas';
 import { ConnectorType } from '@logto/schemas';
+import type { ConnectorFactoryResponse, ConnectorResponse } from '@logto/schemas';
 import classNames from 'classnames';
 import { useMemo, useState } from 'react';
 import Modal from 'react-modal';

packages/console/src/pages/Connectors/components/Guide/index.tsx

@@ -1,6 +1,6 @@
 import { isLanguageTag } from '@logto/language-kit';
-import type { ConnectorFactoryResponse, ConnectorResponse, RequestErrorBody } from '@logto/schemas';
 import { ConnectorType } from '@logto/schemas';
+import type { ConnectorFactoryResponse, RequestErrorBody, ConnectorResponse } from '@logto/schemas';
 import { generateStandardId } from '@logto/shared/universal';
 import { conditional } from '@silverhand/essentials';
 import i18next from 'i18next';

packages/console/src/pages/Connectors/index.tsx

@@ -1,6 +1,6 @@
 import { withAppInsights } from '@logto/app-insights/react';
-import type { ConnectorFactoryResponse } from '@logto/schemas';
 import { ConnectorType } from '@logto/schemas';
+import type { ConnectorFactoryResponse } from '@logto/schemas';
 import { conditional } from '@silverhand/essentials';
 import classNames from 'classnames';
 import { useMemo } from 'react';

packages/console/src/pages/Profile/components/LinkAccountSection/index.tsx

@@ -1,7 +1,7 @@
 import type { SocialUserInfo } from '@logto/connector-kit';
 import { socialUserInfoGuard } from '@logto/connector-kit';
-import type { ConnectorResponse, UserInfo } from '@logto/schemas';
 import { Theme } from '@logto/schemas';
+import type { UserInfo, ConnectorResponse } from '@logto/schemas';
 import { buildIdGenerator } from '@logto/shared/universal';
 import type { Optional } from '@silverhand/essentials';
 import { appendPath, conditional } from '@silverhand/essentials';

packages/console/src/pages/UserDetails/UserSettings/index.tsx

@@ -1,5 +1,5 @@
+import { jsonObjectGuard } from '@logto/schemas';
 import type { User } from '@logto/schemas';
-import { arbitraryObjectGuard } from '@logto/schemas';
 import { useForm, useController } from 'react-hook-form';
 import { toast } from 'react-hot-toast';
 import { useTranslation } from 'react-i18next';
@@ -59,7 +59,7 @@ function UserSettings() {
       return;
     }
 
-    const guardResult = arbitraryObjectGuard.safeParse(parseResult.data);
+    const guardResult = jsonObjectGuard.safeParse(parseResult.data);
 
     if (!guardResult.success) {
       toast.error(t('user_details.custom_data_invalid'));

packages/console/src/utils/user.ts

@@ -1,4 +1,4 @@
-import { type User } from '@logto/schemas';
+import type { User } from '@logto/schemas';
 import { conditional } from '@silverhand/essentials';
 
 const getUserIdentity = (user: User) => {

packages/core/src/routes-me/user.ts

@@ -1,6 +1,6 @@
 import { emailRegEx, passwordRegEx, usernameRegEx } from '@logto/core-kit';
 import type { UserProfileResponse } from '@logto/schemas';
-import { userInfoSelectFields, arbitraryObjectGuard } from '@logto/schemas';
+import { userInfoSelectFields, jsonObjectGuard } from '@logto/schemas';
 import { conditional, pick } from '@silverhand/essentials';
 import { literal, object, string } from 'zod';
 
@@ -80,8 +80,8 @@ export default function userRoutes<T extends AuthedMeRouter>(
   router.patch(
     '/custom-data',
     koaGuard({
-      body: arbitraryObjectGuard,
-      response: arbitraryObjectGuard,
+      body: jsonObjectGuard,
+      response: jsonObjectGuard,
     }),
     async (ctx, next) => {
       const { id: userId } = ctx.auth;

packages/core/src/routes/admin-user.ts

@@ -1,5 +1,5 @@
 import { emailRegEx, passwordRegEx, phoneRegEx, usernameRegEx } from '@logto/core-kit';
-import { arbitraryObjectGuard, userInfoSelectFields } from '@logto/schemas';
+import { jsonObjectGuard, userInfoSelectFields } from '@logto/schemas';
 import { conditional, has, pick, tryThat } from '@silverhand/essentials';
 import { boolean, literal, object, string } from 'zod';
 
@@ -86,7 +86,7 @@ export default function adminUserRoutes<T extends AuthedRouter>(
     '/users/:userId/custom-data',
     koaGuard({
       params: object({ userId: string() }),
-      response: arbitraryObjectGuard,
+      response: jsonObjectGuard,
     }),
     async (ctx, next) => {
       const {
@@ -104,8 +104,8 @@ export default function adminUserRoutes<T extends AuthedRouter>(
     '/users/:userId/custom-data',
     koaGuard({
       params: object({ userId: string() }),
-      body: object({ customData: arbitraryObjectGuard }),
-      response: arbitraryObjectGuard,
+      body: object({ customData: jsonObjectGuard }),
+      response: jsonObjectGuard,
     }),
     async (ctx, next) => {
       const {
@@ -188,7 +188,7 @@ export default function adminUserRoutes<T extends AuthedRouter>(
         primaryPhone: string().regex(phoneRegEx).or(literal('')).nullable(),
         name: string().or(literal('')).nullable(),
         avatar: string().url().or(literal('')).nullable(),
-        customData: arbitraryObjectGuard,
+        customData: jsonObjectGuard,
       }).partial(),
     }),
     async (ctx, next) => {

packages/core/src/routes/authn.ts

@@ -1,6 +1,6 @@
 import type { ConnectorSession } from '@logto/connector-kit';
 import { ConnectorError, ConnectorErrorCodes, ConnectorType } from '@logto/connector-kit';
-import { arbitraryObjectGuard } from '@logto/schemas';
+import { jsonObjectGuard } from '@logto/schemas';
 import { z } from 'zod';
 
 import RequestError from '#src/errors/RequestError/index.js';
@@ -89,7 +89,7 @@ export default function authnRoutes<T extends AnonymousRouter>(
      * The API does not care the type of the SAML assertion request body, simply pass this to
      * connector's built-in methods.
      */
-    koaGuard({ body: arbitraryObjectGuard, params: z.object({ connectorId: z.string().min(1) }) }),
+    koaGuard({ body: jsonObjectGuard, params: z.object({ connectorId: z.string().min(1) }) }),
     async (ctx, next) => {
       const {
         params: { connectorId },

packages/core/src/routes/connector/config-testing.ts

@@ -7,7 +7,7 @@ import {
   VerificationCodeType,
 } from '@logto/connector-kit';
 import { phoneRegEx, emailRegEx } from '@logto/core-kit';
-import { arbitraryObjectGuard, ConnectorType } from '@logto/schemas';
+import { jsonObjectGuard, ConnectorType } from '@logto/schemas';
 import { string, object } from 'zod';
 
 import RequestError from '#src/errors/RequestError/index.js';
@@ -27,7 +27,7 @@ export default function connectorConfigTestingRoutes<T extends AuthedRouter>(
       body: object({
         phone: string().regex(phoneRegEx).optional(),
         email: string().regex(emailRegEx).optional(),
-        config: arbitraryObjectGuard,
+        config: jsonObjectGuard,
       }),
     }),
     async (ctx, next) => {

packages/core/src/utils/zod.test.ts

@@ -1,7 +1,7 @@
 import { languages, languageTagGuard } from '@logto/language-kit';
 import {
   ApplicationType,
-  arbitraryObjectGuard,
+  jsonObjectGuard,
   translationGuard,
   customContentGuard,
 } from '@logto/schemas';
@@ -14,7 +14,7 @@ import { zodTypeToSwagger } from './zod.js';
 
 describe('zodTypeToSwagger', () => {
   it('arbitrary object guard', () => {
-    expect(zodTypeToSwagger(arbitraryObjectGuard)).toEqual({
+    expect(zodTypeToSwagger(jsonObjectGuard)).toEqual({
       type: 'object',
       description: 'arbitrary',
     });

packages/core/src/utils/zod.ts

@@ -1,5 +1,5 @@
 import { languages, languageTagGuard } from '@logto/language-kit';
-import { arbitraryObjectGuard, translationGuard } from '@logto/schemas';
+import { jsonObjectGuard, translationGuard } from '@logto/schemas';
 import type { ValuesOf } from '@silverhand/essentials';
 import { conditional } from '@silverhand/essentials';
 import type { OpenAPIV3 } from 'openapi-types';
@@ -143,7 +143,7 @@ const zodLiteralToSwagger = (zodLiteral: ZodLiteral<unknown>): OpenAPIV3.SchemaO
 export const zodTypeToSwagger = (
   config: unknown
 ): OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject => {
-  if (config === arbitraryObjectGuard) {
+  if (config === jsonObjectGuard) {
     return {
       type: 'object',
       description: 'arbitrary',

packages/schemas/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)
       );

packages/schemas/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)
       );
     `);

packages/schemas/src/foundations/jsonb-types.ts

@@ -1,17 +1,24 @@
 import { hexColorRegEx } from '@logto/core-kit';
 import { languageTagGuard } from '@logto/language-kit';
+import type { Json } from '@withtyped/server';
 import { z } from 'zod';
 
 export {
   configurableConnectorMetadataGuard,
   type ConfigurableConnectorMetadata,
 } from '@logto/connector-kit';
+export type { JsonObject } from '@withtyped/server';
 
 /* === 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()]);
 
-export type ArbitraryObject = z.infer<typeof arbitraryObjectGuard>;
+const jsonGuard: z.ZodType<Json> = z.lazy(() =>
+  z.union([literalSchema, z.array(jsonGuard), z.record(jsonGuard)])
+);
+
+export const jsonObjectGuard = z.record(jsonGuard);
 
 /* === OIDC Model Instances === */
 

packages/schemas/src/types/interactions.ts

@@ -1,7 +1,7 @@
 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 type {
   EmailVerificationCodePayload,
@@ -36,7 +36,7 @@ export type PhonePasswordPayload = z.infer<typeof phonePasswordPayloadGuard>;
 
 export const socialConnectorPayloadGuard = z.object({
   connectorId: z.string(),
-  connectorData: arbitraryObjectGuard,
+  connectorData: jsonObjectGuard,
 });
 export type SocialConnectorPayload = z.infer<typeof socialConnectorPayloadGuard>;
 

packages/schemas/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)

packages/schemas/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)
 );

packages/schemas/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)
 );

packages/schemas/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)
 );
 

packages/schemas/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()),

pnpm-lock.yaml

@@ -2961,8 +2961,8 @@ importers:
         specifier: ^6.1.0
         version: 6.1.0(react@18.2.0)
       react-hook-form:
-        specifier: ^7.34.0
-        version: 7.34.0(react@18.2.0)
+        specifier: ^7.43.9
+        version: 7.43.9(react@18.2.0)
       react-hot-toast:
         specifier: ^2.2.0
         version: 2.2.0(csstype@3.0.11)(react-dom@18.2.0)(react@18.2.0)
@@ -17425,6 +17425,15 @@ packages:
       react: 18.2.0
     dev: true
 
+  /react-hook-form@7.43.9(react@18.2.0):
+    resolution: {integrity: sha512-AUDN3Pz2NSeoxQ7Hs6OhQhDr6gtF9YRuutGDwPQqhSUAHJSgGl2VeY3qN19MG0SucpjgDiuMJ4iC5T5uB+eaNQ==}
+    engines: {node: '>=12.22.0'}
+    peerDependencies:
+      react: ^16.8.0 || ^17 || ^18 || ^18.0.0
+    dependencies:
+      react: 18.2.0
+    dev: true
+
   /react-hot-toast@2.2.0(csstype@3.0.11)(react-dom@18.2.0)(react@18.2.0):
     resolution: {integrity: sha512-248rXw13uhf/6TNDVzagX+y7R8J183rp7MwUMNkcrBRyHj/jWOggfXTGlM8zAOuh701WyVW+eUaWG2LeSufX9g==}
     engines: {node: '>=10'}