@logto/cli 1.0.0-rc.1 → 1.0.0-rc.3

package/lib/connector/utils.d.ts

@@ -0,0 +1,303 @@
+import type { AllConnector, BaseConnector, GetConnectorConfig } from '@logto/connector-kit';
+import { ConnectorType } from '@logto/connector-kit';
+import type { ConnectorFactory } from './types.js';
+export declare function validateConnectorModule(connector: Partial<BaseConnector<ConnectorType>>): asserts connector is BaseConnector<ConnectorType>;
+export declare const readUrl: (url: string, baseUrl: string, type: 'text' | 'svg') => Promise<string>;
+export declare const parseMetadata: (metadata: AllConnector['metadata'], packagePath: string) => Promise<AllConnector['metadata']>;
+export declare const buildRawConnector: (connectorFactory: ConnectorFactory, getConnectorConfig?: GetConnectorConfig) => Promise<{
+    rawConnector: AllConnector;
+    rawMetadata: {
+        isStandard?: boolean | undefined;
+        configTemplate?: string | undefined;
+        formItems?: ({
+            placeholder?: string | undefined;
+            required?: boolean | undefined;
+            defaultValue?: unknown;
+            showConditions?: {
+                expectValue?: unknown;
+                targetKey: string;
+            }[] | undefined;
+            description?: string | undefined;
+            tooltip?: string | undefined;
+            type: import("@logto/connector-kit").ConnectorConfigFormItemType.Select;
+            selectItems: {
+                value: string;
+                title: string;
+            }[];
+            key: string;
+            label: string;
+        } | {
+            placeholder?: string | undefined;
+            required?: boolean | undefined;
+            defaultValue?: unknown;
+            showConditions?: {
+                expectValue?: unknown;
+                targetKey: string;
+            }[] | undefined;
+            description?: string | undefined;
+            tooltip?: string | undefined;
+            type: import("@logto/connector-kit").ConnectorConfigFormItemType.Text | import("@logto/connector-kit").ConnectorConfigFormItemType.Number | import("@logto/connector-kit").ConnectorConfigFormItemType.MultilineText | import("@logto/connector-kit").ConnectorConfigFormItemType.Switch | import("@logto/connector-kit").ConnectorConfigFormItemType.Json;
+            key: string;
+            label: string;
+        })[] | undefined;
+        description: {
+            en: string;
+        } & {
+            "af-ZA"?: string | undefined;
+            "am-ET"?: string | undefined;
+            "ar-AR"?: string | undefined;
+            "as-IN"?: string | undefined;
+            "az-AZ"?: string | undefined;
+            "be-BY"?: string | undefined;
+            "bg-BG"?: string | undefined;
+            "bn-IN"?: string | undefined;
+            "br-FR"?: string | undefined;
+            "bs-BA"?: string | undefined;
+            "ca-ES"?: string | undefined;
+            "cb-IQ"?: string | undefined;
+            "co-FR"?: string | undefined;
+            "cs-CZ"?: string | undefined;
+            "cx-PH"?: string | undefined;
+            "cy-GB"?: string | undefined;
+            "da-DK"?: string | undefined;
+            de?: string | undefined;
+            "de-DE"?: string | undefined;
+            "el-GR"?: string | undefined;
+            "en-GB"?: string | undefined;
+            "en-US"?: string | undefined;
+            "eo-EO"?: string | undefined;
+            es?: string | undefined;
+            "es-ES"?: string | undefined;
+            "es-419"?: string | undefined;
+            "et-EE"?: string | undefined;
+            "eu-ES"?: string | undefined;
+            "fa-IR"?: string | undefined;
+            "ff-NG"?: string | undefined;
+            "fi-FI"?: string | undefined;
+            "fo-FO"?: string | undefined;
+            fr?: string | undefined;
+            "fr-CA"?: string | undefined;
+            "fr-FR"?: string | undefined;
+            "fy-NL"?: string | undefined;
+            "ga-IE"?: string | undefined;
+            "gl-ES"?: string | undefined;
+            "gn-PY"?: string | undefined;
+            "gu-IN"?: string | undefined;
+            "ha-NG"?: string | undefined;
+            "he-IL"?: string | undefined;
+            "hi-IN"?: string | undefined;
+            "hr-HR"?: string | undefined;
+            "ht-HT"?: string | undefined;
+            "hu-HU"?: string | undefined;
+            "hy-AM"?: string | undefined;
+            "id-ID"?: string | undefined;
+            "ik-US"?: string | undefined;
+            "is-IS"?: string | undefined;
+            it?: string | undefined;
+            "it-IT"?: string | undefined;
+            "iu-CA"?: string | undefined;
+            ja?: string | undefined;
+            "ja-JP"?: string | undefined;
+            "ja-KS"?: string | undefined;
+            "jv-ID"?: string | undefined;
+            "ka-GE"?: string | undefined;
+            "kk-KZ"?: string | undefined;
+            "km-KH"?: string | undefined;
+            "kn-IN"?: string | undefined;
+            ko?: string | undefined;
+            "ko-KR"?: string | undefined;
+            "ku-TR"?: string | undefined;
+            "ky-KG"?: string | undefined;
+            "lo-LA"?: string | undefined;
+            "lt-LT"?: string | undefined;
+            "lv-LV"?: string | undefined;
+            "mg-MG"?: string | undefined;
+            "mk-MK"?: string | undefined;
+            "ml-IN"?: string | undefined;
+            "mn-MN"?: string | undefined;
+            "mr-IN"?: string | undefined;
+            "ms-MY"?: string | undefined;
+            "mt-MT"?: string | undefined;
+            "my-MM"?: string | undefined;
+            "nb-NO"?: string | undefined;
+            "ne-NP"?: string | undefined;
+            "nl-BE"?: string | undefined;
+            "nl-NL"?: string | undefined;
+            "nn-NO"?: string | undefined;
+            "or-IN"?: string | undefined;
+            "pa-IN"?: string | undefined;
+            "pl-PL"?: string | undefined;
+            "ps-AF"?: string | undefined;
+            pt?: string | undefined;
+            "pt-BR"?: string | undefined;
+            "pt-PT"?: string | undefined;
+            "ro-RO"?: string | undefined;
+            ru?: string | undefined;
+            "ru-RU"?: string | undefined;
+            "rw-RW"?: string | undefined;
+            "sc-IT"?: string | undefined;
+            "si-LK"?: string | undefined;
+            "sk-SK"?: string | undefined;
+            "sl-SI"?: string | undefined;
+            "sn-ZW"?: string | undefined;
+            "sq-AL"?: string | undefined;
+            "sr-RS"?: string | undefined;
+            "sv-SE"?: string | undefined;
+            "sw-KE"?: string | undefined;
+            "sy-SY"?: string | undefined;
+            "sz-PL"?: string | undefined;
+            "ta-IN"?: string | undefined;
+            "te-IN"?: string | undefined;
+            "tg-TJ"?: string | undefined;
+            "th-TH"?: string | undefined;
+            "tl-PH"?: string | undefined;
+            tr?: string | undefined;
+            "tr-TR"?: string | undefined;
+            "tt-RU"?: string | undefined;
+            "tz-MA"?: string | undefined;
+            "uk-UA"?: string | undefined;
+            "ur-PK"?: string | undefined;
+            "uz-UZ"?: string | undefined;
+            "vi-VN"?: string | undefined;
+            zh?: string | undefined;
+            "zh-CN"?: string | undefined;
+            "zh-HK"?: string | undefined;
+            "zh-MO"?: string | undefined;
+            "zh-TW"?: string | undefined;
+            "zz-TR"?: string | undefined;
+        };
+        id: string;
+        target: string;
+        platform: import("@logto/connector-kit").ConnectorPlatform | null;
+        name: {
+            en: string;
+        } & {
+            "af-ZA"?: string | undefined;
+            "am-ET"?: string | undefined;
+            "ar-AR"?: string | undefined;
+            "as-IN"?: string | undefined;
+            "az-AZ"?: string | undefined;
+            "be-BY"?: string | undefined;
+            "bg-BG"?: string | undefined;
+            "bn-IN"?: string | undefined;
+            "br-FR"?: string | undefined;
+            "bs-BA"?: string | undefined;
+            "ca-ES"?: string | undefined;
+            "cb-IQ"?: string | undefined;
+            "co-FR"?: string | undefined;
+            "cs-CZ"?: string | undefined;
+            "cx-PH"?: string | undefined;
+            "cy-GB"?: string | undefined;
+            "da-DK"?: string | undefined;
+            de?: string | undefined;
+            "de-DE"?: string | undefined;
+            "el-GR"?: string | undefined;
+            "en-GB"?: string | undefined;
+            "en-US"?: string | undefined;
+            "eo-EO"?: string | undefined;
+            es?: string | undefined;
+            "es-ES"?: string | undefined;
+            "es-419"?: string | undefined;
+            "et-EE"?: string | undefined;
+            "eu-ES"?: string | undefined;
+            "fa-IR"?: string | undefined;
+            "ff-NG"?: string | undefined;
+            "fi-FI"?: string | undefined;
+            "fo-FO"?: string | undefined;
+            fr?: string | undefined;
+            "fr-CA"?: string | undefined;
+            "fr-FR"?: string | undefined;
+            "fy-NL"?: string | undefined;
+            "ga-IE"?: string | undefined;
+            "gl-ES"?: string | undefined;
+            "gn-PY"?: string | undefined;
+            "gu-IN"?: string | undefined;
+            "ha-NG"?: string | undefined;
+            "he-IL"?: string | undefined;
+            "hi-IN"?: string | undefined;
+            "hr-HR"?: string | undefined;
+            "ht-HT"?: string | undefined;
+            "hu-HU"?: string | undefined;
+            "hy-AM"?: string | undefined;
+            "id-ID"?: string | undefined;
+            "ik-US"?: string | undefined;
+            "is-IS"?: string | undefined;
+            it?: string | undefined;
+            "it-IT"?: string | undefined;
+            "iu-CA"?: string | undefined;
+            ja?: string | undefined;
+            "ja-JP"?: string | undefined;
+            "ja-KS"?: string | undefined;
+            "jv-ID"?: string | undefined;
+            "ka-GE"?: string | undefined;
+            "kk-KZ"?: string | undefined;
+            "km-KH"?: string | undefined;
+            "kn-IN"?: string | undefined;
+            ko?: string | undefined;
+            "ko-KR"?: string | undefined;
+            "ku-TR"?: string | undefined;
+            "ky-KG"?: string | undefined;
+            "lo-LA"?: string | undefined;
+            "lt-LT"?: string | undefined;
+            "lv-LV"?: string | undefined;
+            "mg-MG"?: string | undefined;
+            "mk-MK"?: string | undefined;
+            "ml-IN"?: string | undefined;
+            "mn-MN"?: string | undefined;
+            "mr-IN"?: string | undefined;
+            "ms-MY"?: string | undefined;
+            "mt-MT"?: string | undefined;
+            "my-MM"?: string | undefined;
+            "nb-NO"?: string | undefined;
+            "ne-NP"?: string | undefined;
+            "nl-BE"?: string | undefined;
+            "nl-NL"?: string | undefined;
+            "nn-NO"?: string | undefined;
+            "or-IN"?: string | undefined;
+            "pa-IN"?: string | undefined;
+            "pl-PL"?: string | undefined;
+            "ps-AF"?: string | undefined;
+            pt?: string | undefined;
+            "pt-BR"?: string | undefined;
+            "pt-PT"?: string | undefined;
+            "ro-RO"?: string | undefined;
+            ru?: string | undefined;
+            "ru-RU"?: string | undefined;
+            "rw-RW"?: string | undefined;
+            "sc-IT"?: string | undefined;
+            "si-LK"?: string | undefined;
+            "sk-SK"?: string | undefined;
+            "sl-SI"?: string | undefined;
+            "sn-ZW"?: string | undefined;
+            "sq-AL"?: string | undefined;
+            "sr-RS"?: string | undefined;
+            "sv-SE"?: string | undefined;
+            "sw-KE"?: string | undefined;
+            "sy-SY"?: string | undefined;
+            "sz-PL"?: string | undefined;
+            "ta-IN"?: string | undefined;
+            "te-IN"?: string | undefined;
+            "tg-TJ"?: string | undefined;
+            "th-TH"?: string | undefined;
+            "tl-PH"?: string | undefined;
+            tr?: string | undefined;
+            "tr-TR"?: string | undefined;
+            "tt-RU"?: string | undefined;
+            "tz-MA"?: string | undefined;
+            "uk-UA"?: string | undefined;
+            "ur-PK"?: string | undefined;
+            "uz-UZ"?: string | undefined;
+            "vi-VN"?: string | undefined;
+            zh?: string | undefined;
+            "zh-CN"?: string | undefined;
+            "zh-HK"?: string | undefined;
+            "zh-MO"?: string | undefined;
+            "zh-TW"?: string | undefined;
+            "zz-TR"?: string | undefined;
+        };
+        logo: string;
+        logoDark: string | null;
+        readme: string;
+    };
+}>;
+export declare const isKeyInObject: <Key extends string>(object: unknown, key: Key) => object is Record<string, unknown> & Record<Key, unknown>;

package/lib/connector/utils.js

@@ -0,0 +1,51 @@
+import { existsSync } from 'fs';
+import { readFile } from 'fs/promises';
+import path from 'path';
+import { ConnectorError, ConnectorErrorCodes, ConnectorType } from '@logto/connector-kit';
+import { notImplemented } from './consts.js';
+export function validateConnectorModule(connector) {
+    if (!connector.metadata) {
+        throw new ConnectorError(ConnectorErrorCodes.InvalidMetadata);
+    }
+    if (!connector.configGuard) {
+        throw new ConnectorError(ConnectorErrorCodes.InvalidConfigGuard);
+    }
+    if (!connector.type || !Object.values(ConnectorType).includes(connector.type)) {
+        throw new ConnectorError(ConnectorErrorCodes.UnexpectedType);
+    }
+}
+export const readUrl = async (url, baseUrl, type) => {
+    if (!url) {
+        return url;
+    }
+    if (type !== 'text' && url.startsWith('http')) {
+        return url;
+    }
+    if (!existsSync(path.join(baseUrl, url))) {
+        return url;
+    }
+    if (type === 'svg') {
+        const data = await readFile(path.join(baseUrl, url));
+        return `data:image/svg+xml;base64,${data.toString('base64')}`;
+    }
+    return readFile(path.join(baseUrl, url), 'utf8');
+};
+export const parseMetadata = async (metadata, packagePath) => {
+    return {
+        ...metadata,
+        logo: await readUrl(metadata.logo, packagePath, 'svg'),
+        logoDark: metadata.logoDark && (await readUrl(metadata.logoDark, packagePath, 'svg')),
+        readme: await readUrl(metadata.readme, packagePath, 'text'),
+        configTemplate: metadata.configTemplate && (await readUrl(metadata.configTemplate, packagePath, 'text')),
+    };
+};
+export const buildRawConnector = async (connectorFactory, getConnectorConfig) => {
+    const { createConnector, path: packagePath } = connectorFactory;
+    const rawConnector = await createConnector({
+        getConfig: getConnectorConfig ?? notImplemented,
+    });
+    validateConnectorModule(rawConnector);
+    const rawMetadata = await parseMetadata(rawConnector.metadata, packagePath);
+    return { rawConnector, rawMetadata };
+};
+export const isKeyInObject = (object, key) => object !== null && typeof object === 'object' && key in object;

package/lib/database.js

@@ -1,10 +1,10 @@
 import { convertToPrimitiveOrSql } from '@logto/shared';
 import { assert } from '@silverhand/essentials';
 import decamelize from 'decamelize';
+import { DatabaseError } from 'pg-protocol';
 import { createPool, parseDsn, sql, stringifyDsn } from 'slonik';
 import { createInterceptors } from 'slonik-interceptor-preset';
-import { z } from 'zod';
-import { ConfigKey, getCliConfigWithPrompt, log } from './utilities.js';
+import { ConfigKey, getCliConfigWithPrompt, log } from './utils.js';
 export const defaultDatabaseUrl = 'postgresql://localhost:5432/logto';
 export const getDatabaseUrlFromConfig = async () => (await getCliConfigWithPrompt({
     key: ConfigKey.DatabaseUrl,
@@ -29,10 +29,9 @@ export const createPoolAndDatabaseIfNeeded = async () => {
         return await createPoolFromConfig();
     }
     catch (error) {
-        const result = z.object({ code: z.string() }).safeParse(error);
         // Database does not exist, try to create one
         // https://www.postgresql.org/docs/14/errcodes-appendix.html
-        if (!(result.success && result.data.code === '3D000')) {
+        if (!(error instanceof DatabaseError && error.code === '3D000')) {
             log.error(error);
         }
         const databaseUrl = await getDatabaseUrlFromConfig();

package/lib/index.js

@@ -6,7 +6,7 @@ import connector from './commands/connector/index.js';
 import database from './commands/database/index.js';
 import install from './commands/install/index.js';
 import { packageJson } from './package-json.js';
-import { cliConfig, ConfigKey } from './utilities.js';
+import { cliConfig, ConfigKey } from './utils.js';
 void yargs(hideBin(process.argv))
     .version(false)
     .option('env', {

package/lib/package-json.d.ts

@@ -40,6 +40,7 @@ export declare const packageJson: {
         url: string;
     };
     dependencies: {
+        "@logto/connector-kit": string;
         "@logto/core-kit": string;
         "@logto/schemas": string;
         "@logto/shared": string;
@@ -54,6 +55,7 @@ export declare const packageJson: {
         ora: string;
         "p-limit": string;
         "p-retry": string;
+        "pg-protocol": string;
         roarr: string;
         semver: string;
         slonik: string;
@@ -82,9 +84,6 @@ export declare const packageJson: {
     };
     eslintConfig: {
         extends: string;
-        rules: {
-            complexity: (string | number)[];
-        };
         ignorePatterns: string[];
     };
     prettier: string;

package/lib/package-json.js

@@ -1,6 +1,6 @@
 export const packageJson = {
     "name": "@logto/cli",
-    "version": "1.0.0-rc.1",
+    "version": "1.0.0-rc.3",
     "description": "Logto CLI.",
     "author": "Silverhand Inc. <contact@silverhand.io>",
     "homepage": "https://github.com/logto-io/logto#readme",
@@ -43,10 +43,11 @@ export const packageJson = {
         "url": "https://github.com/logto-io/logto/issues"
     },
     "dependencies": {
+        "@logto/connector-kit": "workspace:*",
         "@logto/core-kit": "workspace:*",
         "@logto/schemas": "workspace:*",
         "@logto/shared": "workspace:*",
-        "@silverhand/essentials": "2.1.0",
+        "@silverhand/essentials": "^2.5.0",
         "chalk": "^5.0.0",
         "decamelize": "^6.0.0",
         "dotenv": "^16.0.0",
@@ -57,6 +58,7 @@ export const packageJson = {
         "ora": "^6.1.2",
         "p-limit": "^4.0.0",
         "p-retry": "^5.1.2",
+        "pg-protocol": "^1.6.0",
         "roarr": "^7.11.0",
         "semver": "^7.3.8",
         "slonik": "^30.0.0",
@@ -67,30 +69,24 @@ export const packageJson = {
         "zod": "^3.20.2"
     },
     "devDependencies": {
-        "@silverhand/eslint-config": "1.3.0",
-        "@silverhand/ts-config": "1.2.1",
+        "@silverhand/eslint-config": "2.0.1",
+        "@silverhand/ts-config": "2.0.3",
         "@types/inquirer": "^9.0.0",
-        "@types/jest": "^29.1.2",
+        "@types/jest": "^29.4.0",
         "@types/node": "^18.11.18",
         "@types/semver": "^7.3.12",
         "@types/sinon": "^10.0.13",
         "@types/tar": "^6.1.2",
         "@types/yargs": "^17.0.13",
-        "eslint": "^8.21.0",
-        "jest": "^29.3.1",
+        "eslint": "^8.34.0",
+        "jest": "^29.5.0",
         "lint-staged": "^13.0.0",
-        "prettier": "^2.8.1",
+        "prettier": "^2.8.2",
         "sinon": "^15.0.0",
         "typescript": "^4.9.4"
     },
     "eslintConfig": {
         "extends": "@silverhand",
-        "rules": {
-            "complexity": [
-                "error",
-                11
-            ]
-        },
         "ignorePatterns": [
             "src/package-json.ts"
         ]

package/lib/queries/database.d.ts

@@ -0,0 +1,2 @@
+import type { CommonQueryMethods } from 'slonik';
+export declare const getDatabaseName: (pool: CommonQueryMethods, normalized?: boolean) => Promise<string>;

package/lib/queries/database.js

@@ -0,0 +1,7 @@
+import { sql } from 'slonik';
+export const getDatabaseName = async (pool, normalized = false) => {
+    const { currentDatabase } = await pool.one(sql `
+    select current_database();
+  `);
+    return normalized ? currentDatabase.replaceAll('-', '_') : currentDatabase;
+};

package/lib/queries/logto-config.d.ts

@@ -2,5 +2,5 @@ import type { LogtoConfig, LogtoConfigKey, logtoConfigGuards } from '@logto/sche
 import type { CommonQueryMethods } from 'slonik';
 import type { z } from 'zod';
 export declare const doesConfigsTableExist: (pool: CommonQueryMethods) => Promise<boolean>;
-export declare const getRowsByKeys: (pool: CommonQueryMethods, keys: LogtoConfigKey[]) => Promise<import("slonik").QueryResult<LogtoConfig>>;
-export declare const updateValueByKey: <T extends LogtoConfigKey>(pool: CommonQueryMethods, key: T, value: z.TypeOf<import("@logto/schemas").LogtoConfigGuard[T]>) => Promise<import("slonik").QueryResult<import("slonik").QueryResultRow>>;
+export declare const getRowsByKeys: (pool: CommonQueryMethods, tenantId: string, keys: LogtoConfigKey[]) => Promise<import("slonik").QueryResult<LogtoConfig>>;
+export declare const updateValueByKey: <T extends LogtoConfigKey>(pool: CommonQueryMethods, tenantId: string, key: T, value: z.TypeOf<import("@logto/schemas").LogtoConfigGuard[T]>) => Promise<import("slonik").QueryResult<import("slonik").QueryResultRow>>;

package/lib/queries/logto-config.js

@@ -6,13 +6,14 @@ export const doesConfigsTableExist = async (pool) => {
     const { rows } = await pool.query(sql `select to_regclass(${LogtoConfigs.table}) as regclass`);
     return Boolean(rows[0]?.regclass);
 };
-export const getRowsByKeys = async (pool, keys) => pool.query(sql `
+export const getRowsByKeys = async (pool, tenantId, keys) => pool.query(sql `
     select ${sql.join([fields.key, fields.value], sql `,`)} from ${table}
-      where ${fields.key} in (${sql.join(keys, sql `,`)})
+      where ${fields.tenantId} = ${tenantId}
+      and ${fields.key} in (${sql.join(keys, sql `,`)})
   `);
-export const updateValueByKey = async (pool, key, value) => pool.query(sql `
-      insert into ${table} (${fields.key}, ${fields.value}) 
-        values (${key}, ${sql.jsonb(value)})
+export const updateValueByKey = async (pool, tenantId, key, value) => pool.query(sql `
+      insert into ${table} (${fields.tenantId}, ${fields.key}, ${fields.value}) 
+        values (${tenantId}, ${key}, ${sql.jsonb(value)})
         on conflict (${fields.tenantId}, ${fields.key})
           do update set ${fields.value}=excluded.${fields.value}
     `);

package/lib/queries/system.d.ts

@@ -1,4 +1,9 @@
+import type { System, SystemKey } from '@logto/schemas';
+import { systemGuards } from '@logto/schemas';
 import type { CommonQueryMethods, DatabaseTransactionConnection } from 'slonik';
+import type { z } from 'zod';
 export declare const doesSystemsTableExist: (pool: CommonQueryMethods) => Promise<boolean>;
 export declare const getCurrentDatabaseAlterationTimestamp: (pool: CommonQueryMethods) => Promise<number>;
 export declare const updateDatabaseTimestamp: (connection: DatabaseTransactionConnection, timestamp: number) => Promise<void>;
+export declare const getRowByKey: (pool: CommonQueryMethods, key: SystemKey) => Promise<System | null>;
+export declare const updateValueByKey: <T extends SystemKey>(pool: CommonQueryMethods, key: T, value: z.TypeOf<import("@logto/schemas").SystemGuard[T]>) => Promise<import("slonik").QueryResult<import("slonik").QueryResultRow>>;

package/lib/queries/system.js

@@ -1,8 +1,8 @@
 import { systemGuards, Systems, AlterationStateKey } from '@logto/schemas';
 import { convertToIdentifiers } from '@logto/shared';
+import { DatabaseError } from 'pg-protocol';
 import { sql } from 'slonik';
-import { z } from 'zod';
-const { fields } = convertToIdentifiers(Systems);
+const { fields, table } = convertToIdentifiers(Systems);
 const doesTableExist = async (pool, table) => {
     const { rows } = await pool.query(sql `select to_regclass(${table}) as regclass`);
     return Boolean(rows[0]?.regclass);
@@ -20,10 +20,9 @@ export const getCurrentDatabaseAlterationTimestamp = async (pool) => {
         return (parsed.success && parsed.data.timestamp) || 0;
     }
     catch (error) {
-        const result = z.object({ code: z.string() }).safeParse(error);
         // Relation does not exist, treat as 0
         // https://www.postgresql.org/docs/14/errcodes-appendix.html
-        if (result.success && result.data.code === '42P01') {
+        if (error instanceof DatabaseError && error.code === '42P01') {
             return 0;
         }
         throw error;
@@ -41,3 +40,13 @@ export const updateDatabaseTimestamp = async (connection, timestamp) => {
         on conflict (${fields.key}) do update set ${fields.value}=excluded.${fields.value}
     `);
 };
+export const getRowByKey = async (pool, key) => pool.maybeOne(sql `
+    select ${sql.join([fields.key, fields.value], sql `,`)} from ${table}
+      where ${fields.key} = ${key}
+  `);
+export const updateValueByKey = async (pool, key, value) => pool.query(sql `
+      insert into ${table} (${fields.key}, ${fields.value}) 
+        values (${key}, ${sql.jsonb(value)})
+        on conflict (${fields.key})
+          do update set ${fields.value}=excluded.${fields.value}
+    `);

package/lib/queries/system.test.js

@@ -1,7 +1,8 @@
 import { AlterationStateKey, Systems } from '@logto/schemas';
 import { convertToIdentifiers } from '@logto/shared';
+import { DatabaseError } from 'pg-protocol';
 import { createMockPool, createMockQueryResult, sql } from 'slonik';
-import { expectSqlAssert } from '../test-utilities.js';
+import { expectSqlAssert } from '../test-utils.js';
 import { updateDatabaseTimestamp, getCurrentDatabaseAlterationTimestamp } from './system.js';
 const { jest } = import.meta;
 const mockQuery = jest.fn();
@@ -11,11 +12,14 @@ const pool = createMockPool({
     },
 });
 const { table, fields } = convertToIdentifiers(Systems);
-const timestamp = 1663923776;
+const timestamp = 1_663_923_776;
 const systemsTableExists = async () => createMockQueryResult([{ regclass: true }]);
 describe('getCurrentDatabaseAlterationTimestamp()', () => {
     it('returns 0 if query failed (table not found)', async () => {
-        mockQuery.mockImplementationOnce(systemsTableExists).mockRejectedValueOnce({ code: '42P01' });
+        const error = new DatabaseError('test', 0, 'noData');
+        // eslint-disable-next-line @silverhand/fp/no-mutation
+        error.code = '42P01';
+        mockQuery.mockImplementationOnce(systemsTableExists).mockRejectedValueOnce(error);
         await expect(getCurrentDatabaseAlterationTimestamp(pool)).resolves.toBe(0);
     });
     it('returns 0 if the row is not found', async () => {