@logto/schemas 1.2.3 → 1.3.0

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.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.js

@@ -3,9 +3,9 @@ import { z } from 'zod';
 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),
+    connectorId: z.string().min(1).max(128),
     config: jsonObjectGuard.optional(),
     metadata: configurableConnectorMetadataGuard.optional(),
     createdAt: z.number().optional(),

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.js

@@ -3,7 +3,7 @@ import { z } from 'zod';
 import { jsonObjectGuard } from './../foundations/index.js';
 const createGuard = z.object({
     tenantId: z.string().max(21).optional(),
-    key: z.string().max(256),
+    key: z.string().min(1).max(256),
     value: jsonObjectGuard.optional(),
 });
 const guard = z.object({

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.js

@@ -2,9 +2,9 @@
 import { z } from 'zod';
 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),
+    type: z.string().min(1).max(64),
     payload: jsonObjectGuard.optional(),
     createdAt: z.number().optional(),
 });

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.js

@@ -2,7 +2,7 @@
 import { z } from 'zod';
 import { jsonObjectGuard } from './../foundations/index.js';
 const createGuard = z.object({
-    key: z.string().max(256),
+    key: z.string().min(1).max(256),
     value: jsonObjectGuard.optional(),
 });
 const guard = z.object({

package/lib/db-entries/user.js

@@ -4,7 +4,7 @@ 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(),

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

@@ -228,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

@@ -126,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),
 });