@logto/schemas 1.2.2 → 1.3.0

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/1.3.0-1683292832-update-hooks.ts

@@ -0,0 +1,105 @@
+import { generateStandardId } from '@logto/shared';
+import { sql } from 'slonik';
+
+import type { AlterationScript } from '../lib/types/alteration.js';
+
+enum HookEvent {
+  PostRegister = 'PostRegister',
+  PostSignIn = 'PostSignIn',
+  PostResetPassword = 'PostResetPassword',
+}
+
+type HookConfig = {
+  url: string;
+  headers?: Record<string, string>;
+  retries?: number;
+};
+
+type Hook = {
+  tenantId: string;
+  id: string;
+  name: string;
+  event: HookEvent | null;
+  events: HookEvent[];
+  config: HookConfig;
+  signingKey: string;
+  enabled: boolean;
+  createdAt: number;
+};
+
+const alteration: AlterationScript = {
+  up: async (pool) => {
+    await pool.query(sql`
+      alter table hooks
+        add column name varchar(256) not null default '',
+        add column events jsonb not null default '[]'::jsonb,
+        add column signing_key varchar(64) not null default '',
+        add column enabled boolean not null default true,
+        alter column event drop not null;
+      drop index hooks__event;
+    `);
+  },
+  down: async (pool) => {
+    await pool.query(sql`
+      delete from hooks where enabled = false;
+    `);
+
+    const { rows: hooks } = await pool.query<Hook>(sql`
+      select * from hooks;
+    `);
+
+    /* eslint-disable no-await-in-loop */
+    for (const { id, tenantId, events, config } of hooks) {
+      const { retries, ...rest } = config;
+
+      const updatedConfig = {
+        ...rest,
+        retries: retries ?? 3,
+      };
+
+      if (events.length === 0) {
+        await pool.query(sql`
+          update hooks
+          set config = ${JSON.stringify(updatedConfig)}
+          where id = ${id} and tenant_id = ${tenantId};
+        `);
+
+        continue;
+      }
+
+      for (const [index, event] of events.entries()) {
+        if (index === 0) {
+          await pool.query(sql`
+            update hooks
+            set event = ${event},
+            config = ${JSON.stringify(updatedConfig)}
+            where id = ${id} and tenant_id = ${tenantId};
+          `);
+
+          continue;
+        }
+
+        // Create new hook when there are multiple events
+        const hookId = generateStandardId();
+
+        await pool.query(sql`
+          insert into hooks (id, tenant_id,  event, config)
+          values (${hookId}, ${tenantId}, ${event}, ${JSON.stringify(updatedConfig)});
+        `);
+      }
+    }
+    /* eslint-enable no-await-in-loop */
+
+    await pool.query(sql`
+      alter table hooks
+        alter column event set not null,
+        drop column name,
+        drop column events,
+        drop column signing_key,
+        drop column enabled;
+      create index hooks__event on hooks (tenant_id, event);
+    `);
+  },
+};
+
+export default alteration;

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/alterations-js/1.3.0-1683292832-update-hooks.d.ts

@@ -0,0 +1,3 @@
+import type { AlterationScript } from '../lib/types/alteration.js';
+declare const alteration: AlterationScript;
+export default alteration;

package/alterations-js/1.3.0-1683292832-update-hooks.js

@@ -0,0 +1,73 @@
+import { generateStandardId } from '@logto/shared';
+import { sql } from 'slonik';
+var HookEvent;
+(function (HookEvent) {
+    HookEvent["PostRegister"] = "PostRegister";
+    HookEvent["PostSignIn"] = "PostSignIn";
+    HookEvent["PostResetPassword"] = "PostResetPassword";
+})(HookEvent || (HookEvent = {}));
+const alteration = {
+    up: async (pool) => {
+        await pool.query(sql `
+      alter table hooks
+        add column name varchar(256) not null default '',
+        add column events jsonb not null default '[]'::jsonb,
+        add column signing_key varchar(64) not null default '',
+        add column enabled boolean not null default true,
+        alter column event drop not null;
+      drop index hooks__event;
+    `);
+    },
+    down: async (pool) => {
+        await pool.query(sql `
+      delete from hooks where enabled = false;
+    `);
+        const { rows: hooks } = await pool.query(sql `
+      select * from hooks;
+    `);
+        /* eslint-disable no-await-in-loop */
+        for (const { id, tenantId, events, config } of hooks) {
+            const { retries, ...rest } = config;
+            const updatedConfig = {
+                ...rest,
+                retries: retries ?? 3,
+            };
+            if (events.length === 0) {
+                await pool.query(sql `
+          update hooks
+          set config = ${JSON.stringify(updatedConfig)}
+          where id = ${id} and tenant_id = ${tenantId};
+        `);
+                continue;
+            }
+            for (const [index, event] of events.entries()) {
+                if (index === 0) {
+                    await pool.query(sql `
+            update hooks
+            set event = ${event},
+            config = ${JSON.stringify(updatedConfig)}
+            where id = ${id} and tenant_id = ${tenantId};
+          `);
+                    continue;
+                }
+                // Create new hook when there are multiple events
+                const hookId = generateStandardId();
+                await pool.query(sql `
+          insert into hooks (id, tenant_id,  event, config)
+          values (${hookId}, ${tenantId}, ${event}, ${JSON.stringify(updatedConfig)});
+        `);
+            }
+        }
+        /* eslint-enable no-await-in-loop */
+        await pool.query(sql `
+      alter table hooks
+        alter column event set not null,
+        drop column name,
+        drop column events,
+        drop column signing_key,
+        drop column enabled;
+      create index hooks__event on hooks (tenant_id, event);
+    `);
+    },
+};
+export default alteration;

package/lib/db-entries/application.js

@@ -4,9 +4,9 @@ import { oidcClientMetadataGuard, customClientMetadataGuard } from './../foundat
 import { ApplicationType } from './custom-types.js';
 const createGuard = z.object({
     tenantId: z.string().max(21).optional(),
-    id: z.string().max(21),
-    name: z.string().max(256),
-    secret: z.string().max(64),
+    id: z.string().min(1).max(21),
+    name: z.string().min(1).max(256),
+    secret: z.string().min(1).max(64),
     description: z.string().nullable().optional(),
     type: z.nativeEnum(ApplicationType),
     oidcClientMetadata: oidcClientMetadataGuard,

package/lib/db-entries/applications-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),
-    applicationId: z.string().max(21),
-    roleId: z.string().max(21),
+    id: z.string().min(1).max(21),
+    applicationId: 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/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),
+    id: z.string().min(1).max(128),
     syncProfile: z.boolean().optional(),
-    connectorId: z.string().max(128),
-    config: arbitraryObjectGuard.optional(),
+    connectorId: z.string().min(1).max(128),
+    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/custom-phrase.js

@@ -3,8 +3,8 @@ import { z } from 'zod';
 import { translationGuard } from './../foundations/index.js';
 const createGuard = z.object({
     tenantId: z.string().max(21).optional(),
-    id: z.string().max(21),
-    languageTag: z.string().max(16),
+    id: z.string().min(1).max(21),
+    languageTag: z.string().min(1).max(16),
     translation: translationGuard,
 });
 const guard = z.object({

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

@@ -1,16 +1,24 @@
-import { HookEvent, HookConfig, GeneratedSchema } from './../foundations/index.js';
+import { HookEvent, HookEvents, HookConfig, GeneratedSchema } from './../foundations/index.js';
 export type CreateHook = {
     tenantId?: string;
     id: string;
-    event: HookEvent;
+    name?: string;
+    event?: HookEvent | null;
+    events?: HookEvents;
     config: HookConfig;
+    signingKey?: string;
+    enabled?: boolean;
     createdAt?: number;
 };
 export type Hook = {
     tenantId: string;
     id: string;
-    event: HookEvent;
+    name: string;
+    event: HookEvent | null;
+    events: HookEvents;
     config: HookConfig;
+    signingKey: string;
+    enabled: boolean;
     createdAt: number;
 };
 export declare const Hooks: GeneratedSchema<CreateHook, Hook>;

package/lib/db-entries/hook.js

@@ -1,18 +1,26 @@
 // THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
 import { z } from 'zod';
-import { hookEventGuard, hookConfigGuard } from './../foundations/index.js';
+import { hookEventGuard, hookEventsGuard, hookConfigGuard } from './../foundations/index.js';
 const createGuard = z.object({
     tenantId: z.string().max(21).optional(),
-    id: z.string().max(21),
-    event: hookEventGuard,
+    id: z.string().min(1).max(21),
+    name: z.string().max(256).optional(),
+    event: hookEventGuard.nullable().optional(),
+    events: hookEventsGuard.optional(),
     config: hookConfigGuard,
+    signingKey: z.string().max(64).optional(),
+    enabled: z.boolean().optional(),
     createdAt: z.number().optional(),
 });
 const guard = z.object({
     tenantId: z.string().max(21),
     id: z.string().max(21),
-    event: hookEventGuard,
+    name: z.string().max(256),
+    event: hookEventGuard.nullable(),
+    events: hookEventsGuard,
     config: hookConfigGuard,
+    signingKey: z.string().max(64),
+    enabled: z.boolean(),
     createdAt: z.number(),
 });
 export const Hooks = Object.freeze({
@@ -21,15 +29,23 @@ export const Hooks = Object.freeze({
     fields: {
         tenantId: 'tenant_id',
         id: 'id',
+        name: 'name',
         event: 'event',
+        events: 'events',
         config: 'config',
+        signingKey: 'signing_key',
+        enabled: 'enabled',
         createdAt: 'created_at',
     },
     fieldKeys: [
         'tenantId',
         'id',
+        'name',
         'event',
+        'events',
         'config',
+        'signingKey',
+        'enabled',
         'createdAt',
     ],
     createGuard,

package/lib/db-entries/log.js

@@ -3,8 +3,8 @@ import { z } from 'zod';
 import { logContextPayloadGuard } from './../foundations/index.js';
 const createGuard = z.object({
     tenantId: z.string().max(21).optional(),
-    id: z.string().max(21),
-    key: z.string().max(128),
+    id: z.string().min(1).max(21),
+    key: z.string().min(1).max(128),
     payload: logContextPayloadGuard.optional(),
     createdAt: z.number().optional(),
 });

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(),
+    key: z.string().min(1).max(256),
+    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/oidc-model-instance.js

@@ -3,8 +3,8 @@ import { z } from 'zod';
 import { oidcModelInstancePayloadGuard } from './../foundations/index.js';
 const createGuard = z.object({
     tenantId: z.string().max(21).optional(),
-    modelName: z.string().max(64),
-    id: z.string().max(128),
+    modelName: z.string().min(1).max(64),
+    id: z.string().min(1).max(128),
     payload: oidcModelInstancePayloadGuard,
     expiresAt: z.number(),
     consumedAt: z.number().nullable().optional(),

package/lib/db-entries/passcode.js

@@ -2,12 +2,12 @@
 import { z } from 'zod';
 const createGuard = z.object({
     tenantId: z.string().max(21).optional(),
-    id: z.string().max(21),
+    id: z.string().min(1).max(21),
     interactionJti: z.string().max(128).nullable().optional(),
     phone: z.string().max(32).nullable().optional(),
     email: z.string().max(128).nullable().optional(),
-    type: z.string().max(32),
-    code: z.string().max(6),
+    type: z.string().min(1).max(32),
+    code: z.string().min(1).max(6),
     consumed: z.boolean().optional(),
     tryCount: z.number().optional(),
     createdAt: z.number().optional(),

package/lib/db-entries/resource.js

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

package/lib/db-entries/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),
-    name: z.string().max(128),
-    description: z.string().max(128),
+    id: z.string().min(1).max(21),
+    name: z.string().min(1).max(128),
+    description: z.string().min(1).max(128),
 });
 const guard = z.object({
     tenantId: z.string().max(21),

package/lib/db-entries/roles-scope.js

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

package/lib/db-entries/scope.js

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

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),
+    id: z.string().min(1).max(21),
     tenantId: z.string().max(21).optional(),
-    type: z.string().max(64),
-    payload: arbitraryObjectGuard.optional(),
+    type: z.string().min(1).max(64),
+    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/sign-in-experience.js

@@ -4,7 +4,7 @@ import { colorGuard, brandingGuard, languageInfoGuard, signInGuard, signUpGuard,
 import { SignInMode } from './custom-types.js';
 const createGuard = z.object({
     tenantId: z.string().max(21).optional(),
-    id: z.string().max(21),
+    id: z.string().min(1).max(21),
     color: colorGuard,
     branding: brandingGuard,
     languageInfo: languageInfoGuard,

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(),
+    key: z.string().min(1).max(256),
+    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;