refactor: remove slonik from shared

packages/cli/package.json

@@ -65,7 +65,7 @@
     "pg-protocol": "^1.6.0",
     "roarr": "^7.11.0",
     "semver": "^7.3.8",
-    "slonik": "^30.0.0",
+    "slonik": "30.4.0",
     "slonik-interceptor-preset": "^1.2.10",
     "slonik-sql-tag-raw": "^1.1.4",
     "tar": "^6.1.11",

packages/cli/src/commands/database/seed/tables.ts

@@ -28,14 +28,15 @@ import {
 } from '@logto/schemas';
 import { getTenantRole } from '@logto/schemas';
 import { Tenants } from '@logto/schemas/models';
-import { convertToIdentifiers, generateStandardId } from '@logto/shared';
+import { generateStandardId } from '@logto/shared';
 import type { DatabaseTransactionConnection } from 'slonik';
 import { sql } from 'slonik';
 import { raw } from 'slonik-sql-tag-raw';
 
 import { insertInto } from '../../../database.js';
 import { getDatabaseName } from '../../../queries/database.js';
 import { updateDatabaseTimestamp } from '../../../queries/system.js';
+import { convertToIdentifiers } from '../../../sql.js';
 import { consoleLog, getPathInModule } from '../../../utils.js';
 
 import { appendAdminConsoleRedirectUris, seedTenantCloudServiceApplication } from './cloud.js';

packages/cli/src/database.ts

@@ -1,11 +1,11 @@
 import type { SchemaLike } from '@logto/schemas';
-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 { convertToPrimitiveOrSql } from './sql.js';
 import { ConfigKey, consoleLog, getCliConfigWithPrompt } from './utils.js';
 
 export const defaultDatabaseUrl = 'postgresql://localhost:5432/logto';

packages/cli/src/queries/logto-config.ts

@@ -1,11 +1,12 @@
 import type { LogtoConfig, LogtoConfigKey, logtoConfigGuards } from '@logto/schemas';
 import { LogtoConfigs } from '@logto/schemas';
-import { convertToIdentifiers } from '@logto/shared';
 import type { Nullable } from '@silverhand/essentials';
 import type { CommonQueryMethods } from 'slonik';
 import { sql } from 'slonik';
 import type { z } from 'zod';
 
+import { convertToIdentifiers } from '../sql.js';
+
 const { table, fields } = convertToIdentifiers(LogtoConfigs);
 
 export const doesConfigsTableExist = async (pool: CommonQueryMethods) => {

packages/cli/src/queries/system.test.ts

@@ -1,8 +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 { convertToIdentifiers } from '../sql.js';
 import type { QueryType } from '../test-utils.js';
 import { expectSqlAssert } from '../test-utils.js';
 

packages/cli/src/queries/system.ts

@@ -1,12 +1,13 @@
 import type { AlterationState, System, SystemKey } from '@logto/schemas';
 import { systemGuards, Systems, AlterationStateKey } from '@logto/schemas';
-import { convertToIdentifiers } from '@logto/shared';
 import type { Nullable } from '@silverhand/essentials';
 import { DatabaseError } from 'pg-protocol';
 import type { CommonQueryMethods, DatabaseTransactionConnection } from 'slonik';
 import { sql } from 'slonik';
 import type { z } from 'zod';
 
+import { convertToIdentifiers } from '../sql.js';
+
 const { fields, table } = convertToIdentifiers(Systems);
 
 const doesTableExist = async (pool: CommonQueryMethods, table: string) => {

packages/cli/src/sql.ts

@@ -0,0 +1,75 @@
+/**
+ * @fileoverview Copied from `@logto/core`. Originally we put them in `@logto/shared` but it
+ * requires `slonik` which makes the package too heavy.
+ *
+ * Since `@logto/cli` only use these functions in a stable manner, we copy them here for now. If
+ * the number of functions grows, we should consider moving them to a separate package. (Actually,
+ * we should remove the dependency on `slonik` at all, and this may not be an issue then.)
+ */
+
+import { type SchemaValue, type SchemaValuePrimitive, type Table } from '@logto/shared';
+import { type IdentifierSqlToken, type SqlToken, sql } from 'slonik';
+
+/**
+ * Note `undefined` is removed from the acceptable list,
+ * since you should NOT call this function if ignoring the field is the desired behavior.
+ * Calling this function with `null` means an explicit `null` setting in database is expected.
+ * @param key The key of value. Will treat as `timestamp` if it ends with `_at` or 'At' AND value is a number;
+ * @param value The value to convert.
+ * @returns A primitive that can be saved into database.
+ */
+export const convertToPrimitiveOrSql = (
+  key: string,
+  value: SchemaValue
+  // eslint-disable-next-line @typescript-eslint/ban-types
+): NonNullable<SchemaValuePrimitive> | SqlToken | null => {
+  if (value === null) {
+    return null;
+  }
+
+  if (typeof value === 'object') {
+    return JSON.stringify(value);
+  }
+
+  if (
+    (['_at', 'At'].some((value) => key.endsWith(value)) || key === 'date') &&
+    typeof value === 'number'
+  ) {
+    return sql`to_timestamp(${value}::double precision / 1000)`;
+  }
+
+  if (typeof value === 'number' || typeof value === 'boolean') {
+    return value;
+  }
+
+  if (typeof value === 'string') {
+    if (value === '') {
+      return null;
+    }
+
+    return value;
+  }
+
+  throw new Error(`Cannot convert ${key} to primitive`);
+};
+
+type FieldIdentifiers<Key extends string> = {
+  [key in Key]: IdentifierSqlToken;
+};
+
+export const convertToIdentifiers = <Key extends string>(
+  { table, fields }: Table<Key>,
+  withPrefix = false
+) => {
+  const fieldsIdentifiers = Object.entries<string>(fields).map<[Key, IdentifierSqlToken]>(
+    // eslint-disable-next-line no-restricted-syntax -- Object.entries can only return string keys
+    ([key, value]) => [key as Key, sql.identifier(withPrefix ? [table, value] : [value])]
+  );
+
+  return {
+    table: sql.identifier([table]),
+    // Key value inferred from the original fields directly
+    // eslint-disable-next-line no-restricted-syntax
+    fields: Object.fromEntries(fieldsIdentifiers) as FieldIdentifiers<Key>,
+  };
+};

packages/core/package.json

@@ -85,7 +85,7 @@
     "roarr": "^7.11.0",
     "samlify": "2.8.10",
     "semver": "^7.3.8",
-    "slonik": "^30.0.0",
+    "slonik": "30.4.0",
     "slonik-interceptor-preset": "^1.2.10",
     "slonik-sql-tag-raw": "^1.1.4",
     "snake-case": "^3.0.4",

packages/core/src/database/find-all-entities.ts

@@ -1,7 +1,8 @@
 import { type GeneratedSchema, type SchemaLike } from '@logto/schemas';
-import { conditionalSql, convertToIdentifiers, manyRows } from '@logto/shared';
 import { sql, type CommonQueryMethods } from 'slonik';
 
+import { conditionalSql, convertToIdentifiers, manyRows } from '#src/utils/sql.js';
+
 import { buildSearchSql, expandFields, type SearchOptions } from './utils.js';
 
 export const buildFindAllEntitiesWithPool =

packages/core/src/database/find-entity-by-id.ts

@@ -1,11 +1,11 @@
 import type { SchemaLike, GeneratedSchema } from '@logto/schemas';
-import { convertToIdentifiers } from '@logto/shared';
 import type { CommonQueryMethods } from 'slonik';
 import { sql, NotFoundError } from 'slonik';
 
 import RequestError from '#src/errors/RequestError/index.js';
 import assertThat from '#src/utils/assert-that.js';
 import { isKeyOf } from '#src/utils/schema.js';
+import { convertToIdentifiers } from '#src/utils/sql.js';
 
 type WithId<Key> = Key | 'id';
 

packages/core/src/database/insert-into.test.ts

@@ -1,9 +1,9 @@
 import type { CreateUser } from '@logto/schemas';
 import { Users } from '@logto/schemas';
-import { convertToIdentifiers } from '@logto/shared';
 import decamelize from 'decamelize';
 
 import { InsertionError } from '#src/errors/SlonikError/index.js';
+import { convertToIdentifiers } from '#src/utils/sql.js';
 import { createTestPool } from '#src/utils/test-utils.js';
 
 const { buildInsertIntoWithPool } = await import('./insert-into.js');

packages/core/src/database/insert-into.ts

@@ -1,17 +1,17 @@
 import type { GeneratedSchema, SchemaLike } from '@logto/schemas';
-import type { OmitAutoSetFields } from '@logto/shared';
-import {
-  convertToIdentifiers,
-  excludeAutoSetFields,
-  convertToPrimitiveOrSql,
-  conditionalSql,
-} from '@logto/shared';
 import { has } from '@silverhand/essentials';
 import type { CommonQueryMethods, IdentifierSqlToken } from 'slonik';
 import { sql } from 'slonik';
 
 import { InsertionError } from '#src/errors/SlonikError/index.js';
 import assertThat from '#src/utils/assert-that.js';
+import {
+  type OmitAutoSetFields,
+  convertToIdentifiers,
+  excludeAutoSetFields,
+  convertToPrimitiveOrSql,
+  conditionalSql,
+} from '#src/utils/sql.js';
 
 const setExcluded = (...fields: IdentifierSqlToken[]) =>
   sql.join(

packages/core/src/database/update-where.ts

@@ -1,5 +1,4 @@
 import type { SchemaLike, GeneratedSchema, SchemaValue } from '@logto/schemas';
-import { convertToIdentifiers, convertToPrimitiveOrSql, conditionalSql } from '@logto/shared';
 import type { UpdateWhereData } from '@logto/shared';
 import type { Truthy } from '@silverhand/essentials';
 import { notFalsy } from '@silverhand/essentials';
@@ -9,6 +8,7 @@ import { sql } from 'slonik';
 import { UpdateError } from '#src/errors/SlonikError/index.js';
 import assertThat from '#src/utils/assert-that.js';
 import { isKeyOf } from '#src/utils/schema.js';
+import { convertToIdentifiers, convertToPrimitiveOrSql, conditionalSql } from '#src/utils/sql.js';
 
 type BuildUpdateWhere = {
   <

packages/core/src/database/utils.ts

@@ -1,7 +1,9 @@
 import { type GeneratedSchema } from '@logto/schemas';
-import { type SchemaLike, conditionalSql, convertToIdentifiers, type Table } from '@logto/shared';
+import { type SchemaLike, type Table } from '@logto/shared';
 import { type SqlSqlToken, sql } from 'slonik';
 
+import { conditionalSql, convertToIdentifiers } from '#src/utils/sql.js';
+
 /**
  * Options for searching for a string within a set of fields (case-insensitive).
  */

packages/core/src/errors/SlonikError/index.ts

@@ -1,7 +1,9 @@
 import type { SchemaLike, GeneratedSchema } from '@logto/schemas';
-import type { OmitAutoSetFields, UpdateWhereData } from '@logto/shared';
+import type { UpdateWhereData } from '@logto/shared';
 import { SlonikError } from 'slonik';
 
+import { type OmitAutoSetFields } from '#src/utils/sql.js';
+
 export class DeletionError extends SlonikError {
   public constructor(
     public readonly table?: string,

packages/core/src/libraries/logto-config.ts

@@ -7,13 +7,13 @@ import {
   jwtCustomizerConfigGuard,
 } from '@logto/schemas';
 import type { LogtoOidcConfigType, LogtoJwtTokenKey } from '@logto/schemas';
-import { convertToIdentifiers } from '@logto/shared';
 import chalk from 'chalk';
 import { z, ZodError } from 'zod';
 
 import RequestError from '#src/errors/RequestError/index.js';
 import type Queries from '#src/tenants/Queries.js';
 import { consoleLog } from '#src/utils/console.js';
+import { convertToIdentifiers } from '#src/utils/sql.js';
 
 export type LogtoConfigLibrary = ReturnType<typeof createLogtoConfigLibrary>;
 const { table } = convertToIdentifiers(LogtoConfigs);

packages/core/src/libraries/user.ts

@@ -1,7 +1,6 @@
 import type { User, CreateUser, Scope, BindMfa, MfaVerification } from '@logto/schemas';
 import { MfaFactor, Users, UsersPasswordEncryptionMethod } from '@logto/schemas';
 import { generateStandardShortId, generateStandardId } from '@logto/shared';
-import type { OmitAutoSetFields } from '@logto/shared';
 import type { Nullable } from '@silverhand/essentials';
 import { deduplicate } from '@silverhand/essentials';
 import { argon2Verify, bcryptVerify, md5, sha1, sha256 } from 'hash-wasm';
@@ -14,6 +13,7 @@
 import type Queries from '#src/tenants/Queries.js';
 import assertThat from '#src/utils/assert-that.js';
 import { encryptPassword } from '#src/utils/password.js';
+import type { OmitAutoSetFields } from '#src/utils/sql.js';
 
 export const encryptUserPassword = async (
   password: string
@@ -190,7 +190,7 @@
   };
 
   const addUserMfaVerification = async (userId: string, payload: BindMfa) => {
     // TODO @sijie use jsonb array append
     const { mfaVerifications } = await findUserById(userId);
     await updateUserById(userId, {
       mfaVerifications: [...mfaVerifications, converBindMfaToMfaVerification(payload)],

packages/core/src/middleware/koa-auth/utils.ts

@@ -7,13 +7,13 @@ import {
   LogtoOidcConfigKey,
   LogtoConfigs,
 } from '@logto/schemas';
-import { convertToIdentifiers } from '@logto/shared';
 import { appendPath } from '@silverhand/essentials';
 import type { JWK } from 'jose';
 import { sql } from 'slonik';
 
 import { EnvSet, getTenantEndpoint } from '#src/env-set/index.js';
 import { exportJWK } from '#src/utils/jwks.js';
+import { convertToIdentifiers } from '#src/utils/sql.js';
 
 const { table, fields } = convertToIdentifiers(LogtoConfigs);
 

packages/core/src/queries/application-sign-in-experience.ts

@@ -1,9 +1,9 @@
 import { ApplicationSignInExperiences, type ApplicationSignInExperience } from '@logto/schemas';
-import { convertToIdentifiers } from '@logto/shared';
 import { sql, type CommonQueryMethods } from 'slonik';
 
 import { buildInsertIntoWithPool } from '#src/database/insert-into.js';
 import { buildUpdateWhereWithPool } from '#src/database/update-where.js';
+import { convertToIdentifiers } from '#src/utils/sql.js';
 
 const createApplicationSignInExperienceQueries = (pool: CommonQueryMethods) => {
   const insert = buildInsertIntoWithPool(pool)(ApplicationSignInExperiences, {

packages/core/src/queries/application-user-consent-organizations.ts

@@ -4,10 +4,10 @@ import {
   Organizations,
   Users,
 } from '@logto/schemas';
-import { convertToIdentifiers } from '@logto/shared';
 import { sql, type CommonQueryMethods } from 'slonik';
 
 import RelationQueries from '#src/utils/RelationQueries.js';
+import { convertToIdentifiers } from '#src/utils/sql.js';
 
 class ApplicationUserConsentOrganizationsQuery extends RelationQueries<
   [typeof Applications, typeof Users, typeof Organizations]

packages/core/src/queries/application-user-consent-scopes.ts

@@ -7,12 +7,12 @@ import {
   OrganizationScopes,
   Scopes,
 } from '@logto/schemas';
-import { convertToIdentifiers } from '@logto/shared';
 import { sql, type CommonQueryMethods } from 'slonik';
 
 import { buildInsertIntoWithPool } from '#src/database/insert-into.js';
 import { DeletionError } from '#src/errors/SlonikError/index.js';
 import { TwoRelationsQueries } from '#src/utils/RelationQueries.js';
+import { convertToIdentifiers } from '#src/utils/sql.js';
 
 export class ApplicationUserConsentOrganizationScopeQueries extends TwoRelationsQueries<
   typeof Applications,

packages/core/src/queries/application.test.ts

@@ -1,10 +1,14 @@
 import { Applications } from '@logto/schemas';
-import { convertToIdentifiers, convertToPrimitiveOrSql, excludeAutoSetFields } from '@logto/shared';
 import { createMockPool, createMockQueryResult, sql } from 'slonik';
 import { snakeCase } from 'snake-case';
 
 import { mockApplication } from '#src/__mocks__/index.js';
 import { DeletionError } from '#src/errors/SlonikError/index.js';
+import {
+  convertToIdentifiers,
+  convertToPrimitiveOrSql,
+  excludeAutoSetFields,
+} from '#src/utils/sql.js';
 import type { QueryType } from '#src/utils/test-utils.js';
 import { expectSqlAssert } from '#src/utils/test-utils.js';
 

packages/core/src/queries/application.ts

@@ -1,7 +1,5 @@
 import type { Application, CreateApplication } from '@logto/schemas';
 import { ApplicationType, Applications, SearchJointMode } from '@logto/schemas';
-import type { OmitAutoSetFields } from '@logto/shared';
-import { convertToIdentifiers, conditionalSql, conditionalArraySql } from '@logto/shared';
 import type { CommonQueryMethods, SqlSqlToken } from 'slonik';
 import { sql } from 'slonik';
 
@@ -12,6 +10,8 @@ import { buildUpdateWhereWithPool } from '#src/database/update-where.js';
 import { DeletionError } from '#src/errors/SlonikError/index.js';
 import { buildConditionsFromSearch } from '#src/utils/search.js';
 import type { Search } from '#src/utils/search.js';
+import { convertToIdentifiers, conditionalSql, conditionalArraySql } from '#src/utils/sql.js';
+import type { OmitAutoSetFields } from '#src/utils/sql.js';
 
 import ApplicationUserConsentOrganizationsQuery from './application-user-consent-organizations.js';
 import {

packages/core/src/queries/applications-roles.ts

@@ -1,11 +1,11 @@
 import type { ApplicationsRole, CreateApplicationsRole, Role } from '@logto/schemas';
 import { Roles, ApplicationsRoles, RolesScopes } from '@logto/schemas';
-import { convertToIdentifiers, conditionalSql } from '@logto/shared';
 import { type Nullable } from '@silverhand/essentials';
 import type { CommonQueryMethods } from 'slonik';
 import { sql } from 'slonik';
 
 import { DeletionError } from '#src/errors/SlonikError/index.js';
+import { convertToIdentifiers, conditionalSql } from '#src/utils/sql.js';
 
 const { table, fields } = convertToIdentifiers(ApplicationsRoles, true);
 const { fields: insertFields } = convertToIdentifiers(ApplicationsRoles);

packages/core/src/queries/connector.test.ts

@@ -1,10 +1,10 @@
 import { Connectors } from '@logto/schemas';
-import { convertToIdentifiers } from '@logto/shared';
 import { createMockPool, createMockQueryResult, sql } from 'slonik';
 
 import { mockConnector } from '#src/__mocks__/index.js';
 import { DeletionError } from '#src/errors/SlonikError/index.js';
 import { MockWellKnownCache } from '#src/test-utils/tenant.js';
+import { convertToIdentifiers } from '#src/utils/sql.js';
 import type { QueryType } from '#src/utils/test-utils.js';
 import { expectSqlAssert } from '#src/utils/test-utils.js';