@forinda/kickjs-db 8.9.0 → 8.10.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/adapter-Cyxerm3a.d.mts +69 -0
- package/dist/adapter-Cyxerm3a.d.mts.map +1 -0
- package/dist/cli.d.mts +4 -2
- package/dist/cli.d.mts.map +1 -1
- package/dist/cli.mjs +4 -4
- package/dist/cli.mjs.map +1 -1
- package/dist/{create-vlNsemtQ.mjs → create-CM0i_6q6.mjs} +87 -6
- package/dist/create-CM0i_6q6.mjs.map +1 -0
- package/dist/{custom-type-BSqxHyIa.mjs → custom-type-Bu5nn7V1.mjs} +2 -2
- package/dist/{custom-type-BSqxHyIa.mjs.map → custom-type-Bu5nn7V1.mjs.map} +1 -1
- package/dist/devtools-events.d.mts +1 -1
- package/dist/devtools-events.mjs +1 -1
- package/dist/{index-CV7dszi7.d.mts → index-BjEMENJz.d.mts} +53 -14
- package/dist/index-BjEMENJz.d.mts.map +1 -0
- package/dist/index.d.mts +6 -6
- package/dist/index.mjs +2 -2
- package/dist/mysql.d.mts +2 -2
- package/dist/mysql.mjs +8 -6
- package/dist/mysql.mjs.map +1 -1
- package/dist/{pg-DqVxnk3O.mjs → pg-RiTdI_BK.mjs} +3 -3
- package/dist/{pg-DqVxnk3O.mjs.map → pg-RiTdI_BK.mjs.map} +1 -1
- package/dist/pg.d.mts +5 -69
- package/dist/pg.d.mts.map +1 -1
- package/dist/pg.mjs +9 -6
- package/dist/pg.mjs.map +1 -1
- package/dist/pglite.d.mts +39 -0
- package/dist/pglite.d.mts.map +1 -0
- package/dist/pglite.mjs +12 -0
- package/dist/pglite.mjs.map +1 -0
- package/dist/{schema-Cl1eDPkD.d.mts → schema-BeQOkoyr.d.mts} +3 -3
- package/dist/{schema-Cl1eDPkD.d.mts.map → schema-BeQOkoyr.d.mts.map} +1 -1
- package/dist/{schema-types-BMUMDpUC.d.mts → schema-types-DxKLouYj.d.mts} +3 -3
- package/dist/{schema-types-BMUMDpUC.d.mts.map → schema-types-DxKLouYj.d.mts.map} +1 -1
- package/dist/schema.d.mts +1 -1
- package/dist/schema.mjs +2 -2
- package/dist/{split-statements-CJIglzao.mjs → split-statements-0jTWFA-G.mjs} +2 -2
- package/dist/{split-statements-CJIglzao.mjs.map → split-statements-0jTWFA-G.mjs.map} +1 -1
- package/dist/sqlite.d.mts +1 -1
- package/dist/sqlite.d.mts.map +1 -1
- package/dist/sqlite.mjs +8 -7
- package/dist/sqlite.mjs.map +1 -1
- package/dist/src-aPkKZ9dw.mjs +122 -0
- package/dist/src-aPkKZ9dw.mjs.map +1 -0
- package/dist/{table-xb127l8S.d.mts → table-B2HY_SQD.d.mts} +2 -2
- package/dist/{table-xb127l8S.d.mts.map → table-B2HY_SQD.d.mts.map} +1 -1
- package/dist/testing.d.mts +2 -2
- package/dist/testing.mjs +2 -2
- package/dist/{types-CBoxFMRg.d.mts → types-BRgtaCZf.d.mts} +7 -1
- package/dist/types-BRgtaCZf.d.mts.map +1 -0
- package/dist/{types-BosmVkt_.d.mts → types-C_53X_tW.d.mts} +2 -2
- package/dist/{types-BosmVkt_.d.mts.map → types-C_53X_tW.d.mts.map} +1 -1
- package/package.json +16 -7
- package/dist/create-vlNsemtQ.mjs.map +0 -1
- package/dist/index-CV7dszi7.d.mts.map +0 -1
- package/dist/src-CvN0zCJi.mjs +0 -203
- package/dist/src-CvN0zCJi.mjs.map +0 -1
- package/dist/types-CBoxFMRg.d.mts.map +0 -1
package/dist/mysql.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"mysql.mjs","names":[],"sources":["../src/adapters/mysql/dialect.ts","../src/adapters/mysql/adapter.ts","../src/dsl/columns/mysql.ts"],"sourcesContent":["// mysqlDialect — thin factory over Kysely's MysqlDialect so adopters\n// never have to reach for `import { MysqlDialect } from 'kysely'`.\n// Mirrors the `@forinda/kickjs-db/pg` template; the kysely subpackage\n// is a pinned internal dep of the framework.\n\nimport { MysqlDialect, type Dialect as KyselyDialect } from 'kysely'\nimport { KICK_DIALECT_DATES, markDialect, type DialectDateOptions } from '../../dialect-marker'\n\nimport type { MysqlPoolLike } from './adapter'\n\nexport interface MysqlDialectOptions {\n /**\n * mysql2-compatible pool — `createPool(...)` from `mysql2/promise`, the\n * same pool `mysqlAdapter` takes. A callback-API pool works too.\n */\n pool: MysqlPoolLike\n}\n\n/**\n * Construct the dialect that `createDbClient({ dialect })` consumes.\n *\n * **MySQL 8.0+ required.** Kickjs-db's relational query layer\n * compiles to `JSON_ARRAYAGG`, which shipped in 8.0. Adapter-side\n * version assertion lands at first connection from `mysqlAdapter()`;\n * see that factory's docs.\n *\n * @example\n * ```ts\n * import { createDbClient } from '@forinda/kickjs-db'\n * import { mysqlAdapter, mysqlDialect } from '@forinda/kickjs-db/mysql'\n * import { createPool } from 'mysql2/promise'\n *\n * const pool = createPool({\n * host: '127.0.0.1', user: 'root', password: '...', database: 'app',\n * })\n *\n * export const db = createDbClient({\n * schema,\n * dialect: mysqlDialect({ pool }),\n * })\n *\n * export const migrationAdapter = mysqlAdapter({ pool })\n * ```\n */\nexport function mysqlDialect(opts: MysqlDialectOptions): KyselyDialect {\n // MysqlDialect's `pool` parameter is typed as `mysql2.Pool` in\n // newer Kysely versions; casting through `unknown` keeps adopters\n // using compatible drivers (e.g. mysql-mariadb forks) working\n // without pulling mysql2's typings into our public surface.\n // Kysely's MysqlDialect drives the callback API (`getConnection(cb)`). A\n // `mysql2/promise` pool ignores the callback, so every query hung; its\n // callback-API core is `pool.pool` — hand Kysely that.\n const raw = opts.pool as unknown as { pool?: { getConnection?: unknown } }\n const callbackPool = typeof raw.pool?.getConnection === 'function' ? raw.pool : opts.pool\n const dialect = markDialect(new MysqlDialect({ pool: callbackPool as unknown as never }), 'mysql')\n // Rows nested by `db.query` carry dates as strings; read them the way\n // mysql2 reads top-level ones — in the pool's time zone, and not at all\n // for the types `dateStrings` keeps as strings.\n type Cfg = { timezone?: string; dateStrings?: boolean | string[] }\n const config = (callbackPool as { config?: { connectionConfig?: Cfg } }).config?.connectionConfig\n const dates: DialectDateOptions = {\n timezone: config?.timezone ?? 'local',\n dateStrings: config?.dateStrings ?? false,\n }\n Object.defineProperty(dialect, KICK_DIALECT_DATES, { value: dates, enumerable: false })\n return dialect\n}\n","import { Kysely } from 'kysely'\nimport { splitSqlStatements } from '../../migrate/split-statements'\nimport { mysqlDialect } from './dialect'\nimport {\n KickDbError,\n lockTableDdl,\n lockTableName,\n pushTableName,\n quoteTable,\n KICK_MIGRATIONS_TABLE,\n migrationsTableDdl,\n type Dialect,\n type MigrationAdapter,\n type MigrationBookkeeping,\n type MigrationRow,\n type SchemaSnapshot,\n} from '../../index'\nimport { introspectMysql } from '../../migrate/introspect-mysql'\n\n/**\n * mysql2-shaped pool that `mysqlAdapter` consumes. Mirrors the\n * structural surface of `mysql2/promise`'s Pool. The adapter only\n * uses `query(...)` and `getConnection(...)` so any mysql2-compatible\n * driver works.\n *\n * Return type is `Promise<[R, unknown]>` (not `[R[], unknown]`) so\n * mysql2's `Pool.query()` is structurally assignable: SELECT\n * statements return `RowDataPacket[]` (so callers pass `R =\n * MyRow[]`), INSERT / UPDATE / DELETE return `ResultSetHeader` (so\n * callers pass `R = ResultSetHeader`). Each adapter call site picks\n * the row shape it expects via the type parameter.\n */\nexport interface MysqlConnectionLike {\n // `any[]`, not `readonly unknown[]`: mysql2 declares its values parameter\n // mutable, and a readonly one here made a real mysql2 Pool unassignable.\n // oxlint-disable-next-line no-explicit-any\n query<R = unknown>(sql: string, params?: any[]): Promise<[R, unknown]>\n release(): void\n}\n\nexport interface MysqlPoolLike {\n // oxlint-disable-next-line no-explicit-any\n query<R = unknown>(sql: string, params?: any[]): Promise<[R, unknown]>\n getConnection(): Promise<MysqlConnectionLike>\n end?(): Promise<void>\n}\n\nexport interface MysqlAdapterOptions {\n /**\n * The table migrations are recorded in. Default `kick_migrations`; its lock\n * table is the same name plus `_lock`.\n */\n migrationsTable?: string\n /**\n * mysql2-compatible Pool. Caller-owned — `close()` on the adapter\n * does NOT end the pool because adopters typically share a single\n * pool across the migration adapter and the KickDbClient.\n */\n pool: MysqlPoolLike\n /**\n * End the pool when the adapter closes. Set it when the adapter owns its\n * pool — a `kick.config.ts` `db.adapter()` factory that opens one for the\n * CLI — or the `kick db` command never exits. Default `false`: an app\n * usually shares one pool with its client.\n */\n endPoolOnClose?: boolean\n}\n\n/**\n * Minimum supported MySQL major + MariaDB version. `JSON_ARRAYAGG`\n * shipped in MySQL 8.0 and MariaDB 10.5 — earlier versions can't\n * run kickjs-db's relational query layer.\n */\nconst MIN_MYSQL_MAJOR = 8\nconst MIN_MARIADB_MAJOR = 10\nconst MIN_MARIADB_MINOR = 5\n\n/**\n * Parsed shape returned by `parseMysqlVersion`. `flavor` lets\n * adopters distinguish MySQL from MariaDB without re-grepping the\n * raw string.\n */\nexport interface ParsedMysqlVersion {\n flavor: 'mysql' | 'mariadb'\n major: number\n minor: number\n}\n\n/**\n * Parse a MySQL `SELECT VERSION()` string. Handles:\n *\n * - MySQL: `8.0.34`, `8.4.0`, `5.7.42-log`\n * - MariaDB plain: `10.6.11-MariaDB`, `10.5.21-MariaDB-log`,\n * `10.4.32-MariaDB`\n * - MariaDB w/ compat prefix: `5.5.5-10.6.11-MariaDB-1:10.6.11+maria~ubu2004`\n * (the leading `5.5.5-` is a wire-protocol thing for older MySQL\n * clients; the real server version sits immediately before\n * `-MariaDB`)\n *\n * Returns `null` on unparseable input.\n */\nexport function parseMysqlVersion(version: string): ParsedMysqlVersion | null {\n const trimmed = version.trim()\n const isMariaDb = /MariaDB/i.test(trimmed)\n\n if (isMariaDb) {\n // Pull the `major.minor` that sits immediately before\n // `-MariaDB`. This skips the `5.5.5-` compat prefix when\n // present and grabs the real server version regardless of\n // whether one's there.\n const m = /(\\d+)\\.(\\d+)(?:\\.\\d+)?-MariaDB/i.exec(trimmed)\n if (m) {\n const major = Number(m[1])\n const minor = Number(m[2])\n if (Number.isFinite(major) && Number.isFinite(minor)) {\n return { flavor: 'mariadb', major, minor }\n }\n }\n // Fallback for vendor strings we haven't seen — try the\n // leading x.y. Better to surface the wrong floor than to\n // refuse an otherwise valid MariaDB outright.\n const fallback = /^(\\d+)\\.(\\d+)/.exec(trimmed)\n if (!fallback) return null\n const major = Number(fallback[1])\n const minor = Number(fallback[2])\n if (!Number.isFinite(major) || !Number.isFinite(minor)) return null\n return { flavor: 'mariadb', major, minor }\n }\n\n // MySQL: leading x.y from the start of the string.\n const m = /^(\\d+)\\.(\\d+)/.exec(trimmed)\n if (!m) return null\n const major = Number(m[1])\n const minor = Number(m[2])\n if (!Number.isFinite(major) || !Number.isFinite(minor)) return null\n return { flavor: 'mysql', major, minor }\n}\n\n/**\n * Back-compat shim — pre-existing API surface that returned the\n * major version only. Kept exported so adopters depending on it\n * keep working; new code should use `parseMysqlVersion`.\n *\n * @deprecated Use `parseMysqlVersion` for full version + flavor info.\n */\nexport function parseMysqlMajorVersion(version: string): number | null {\n const parsed = parseMysqlVersion(version)\n return parsed?.major ?? null\n}\n\n/**\n * Returns the failure reason if the parsed version doesn't satisfy\n * kickjs-db's floor, or `null` if it does. Pure — no I/O.\n */\nfunction checkVersionSupport(parsed: ParsedMysqlVersion | null, raw: string): string | null {\n if (parsed == null) {\n return `unparseable version string: ${raw || '<empty>'}`\n }\n if (parsed.flavor === 'mariadb') {\n if (parsed.major > MIN_MARIADB_MAJOR) return null\n if (parsed.major < MIN_MARIADB_MAJOR) {\n return `MariaDB ${MIN_MARIADB_MAJOR}.${MIN_MARIADB_MINOR}+ required (detected: ${raw})`\n }\n if (parsed.minor < MIN_MARIADB_MINOR) {\n return `MariaDB ${MIN_MARIADB_MAJOR}.${MIN_MARIADB_MINOR}+ required (detected: ${raw})`\n }\n return null\n }\n // MySQL flavor.\n if (parsed.major < MIN_MYSQL_MAJOR) {\n return `MySQL ${MIN_MYSQL_MAJOR}.0+ required (detected: ${raw})`\n }\n return null\n}\n\n/** {@link splitSqlStatements} for MySQL. */\nexport function splitMysqlStatements(sql: string): string[] {\n return splitSqlStatements(sql, 'mysql')\n}\n\n/**\n * MigrationAdapter implementation backed by mysql2.\n *\n * Asserts MySQL 8.0+ (or MariaDB 10.5+) on first connection (via\n * the first `ensureMigrationTables` call, lazily — no I/O at\n * construction time). Earlier versions throw `KickDbError` with\n * code `KICK_DB_RELATIONAL_NOT_SUPPORTED` carrying the detected\n * version so adopters get a clear error before any query reaches\n * the relational compiler.\n *\n * Multi-statement support: every `query()` call splits the SQL\n * blob at top-level semicolons and runs each statement\n * sequentially. Works against mysql2's default settings; adopters\n * who set `multipleStatements: true` on the pool pay no extra\n * cost (the split is cheap on small DDL blobs).\n *\n * Lock semantics: single-row UPDATE WHERE locked_at IS NULL on\n * `kick_migrations_lock`. Only the row created by\n * `ensureMigrationTables()` exists, so the UPDATE either flips\n * `locked_at` and returns `affectedRows=1` (we won) or matches\n * zero rows (someone else holds it).\n *\n * Introspection: not implemented in v1 — throws `KickDbError` with\n * code `KICK_DB_INTROSPECT_NOT_SUPPORTED`. Drift detection lands\n * in a follow-up that walks `information_schema`.\n */\nexport function mysqlAdapter(opts: MysqlAdapterOptions): MigrationAdapter {\n if (opts.endPoolOnClose && typeof opts.pool.end !== 'function') {\n throw new KickDbError(\n 'KICK_DB_POOL_NOT_CLOSABLE',\n 'mysqlAdapter({ endPoolOnClose: true }) needs a pool with an end() method to close',\n )\n }\n const dialect: Dialect = 'mysql'\n const { pool } = opts\n let versionVerified = false\n\n async function assertVersion() {\n if (versionVerified) return\n const [rows] = await pool.query<{ version: string }[]>(`SELECT VERSION() AS \\`version\\``)\n const versionString = rows[0]?.version ?? ''\n const parsed = parseMysqlVersion(versionString)\n const failure = checkVersionSupport(parsed, versionString)\n if (failure) {\n throw new KickDbError(\n 'KICK_DB_RELATIONAL_NOT_SUPPORTED',\n `${failure}. JSON_ARRAYAGG (required by the relational query layer) shipped in ` +\n `MySQL 8.0 and MariaDB 10.5. Use layer-1/layer-2 queries (selectFrom / selectAll) ` +\n `on older versions.`,\n )\n }\n versionVerified = true\n }\n\n /**\n * Run a (possibly multi-statement) SQL blob via the pool,\n * splitting at top-level `;` so default mysql2 settings work.\n */\n async function runStatements(sql: string): Promise<void> {\n for (const stmt of splitMysqlStatements(sql)) {\n await pool.query(stmt)\n }\n }\n\n /**\n * Same as `runStatements` but on a held connection (used inside\n * `applySqlInTx` so all statements share the BEGIN / COMMIT\n * boundary).\n */\n async function runStatementsOnConn(conn: MysqlConnectionLike, sql: string): Promise<void> {\n for (const stmt of splitMysqlStatements(sql)) {\n await conn.query(stmt)\n }\n }\n\n const table = opts.migrationsTable ?? KICK_MIGRATIONS_TABLE\n const T = quoteTable(dialect, table)\n const L = quoteTable(dialect, lockTableName(table))\n // Introspection must not report the bookkeeping tables as schema.\n // A dot is part of the name here, not a schema.\n const bookkeepingTables = [table, lockTableName(table), pushTableName(table)]\n let migrationDb: Kysely<any> | undefined\n return {\n dialect,\n\n async ensureMigrationTables() {\n await assertVersion()\n await runStatements(migrationsTableDdl(dialect, table))\n await runStatements(lockTableDdl(dialect, table))\n },\n\n async listApplied(): Promise<MigrationRow[]> {\n const [rows] = await pool.query<\n Array<{\n id: string\n name: string\n hash: string\n batch: number\n applied_at: string | Date\n direction: 'up' | 'down'\n }>\n >(\n `SELECT id, name, hash, batch, applied_at, direction\n FROM ${T}\n ORDER BY applied_at ASC, id ASC`,\n )\n return rows.map((row) => ({\n id: row.id,\n name: row.name,\n hash: row.hash,\n batch: Number(row.batch),\n appliedAt:\n row.applied_at instanceof Date ? row.applied_at.toISOString() : String(row.applied_at),\n direction: row.direction,\n }))\n },\n\n async recordApplied(row) {\n await pool.query(\n `INSERT INTO ${T} (id, name, hash, batch, direction)\n VALUES (?, ?, ?, ?, ?)`,\n [row.id, row.name, row.hash, row.batch, row.direction],\n )\n },\n\n async removeApplied(id: string) {\n await pool.query(`DELETE FROM ${T} WHERE id = ?`, [id])\n },\n\n async acquireLock(owner: string): Promise<boolean> {\n const [result] = await pool.query<{ affectedRows: number }>(\n `UPDATE ${L}\n SET locked_at = CURRENT_TIMESTAMP, locked_by = ?\n WHERE id = 1 AND locked_at IS NULL`,\n [owner],\n )\n return result.affectedRows === 1\n },\n\n async releaseLock() {\n await pool.query(\n `UPDATE ${L}\n SET locked_at = NULL, locked_by = NULL\n WHERE id = 1`,\n )\n },\n\n async applySqlInTx(sql: string) {\n await this.applyMigrationInTx!(sql, null)\n },\n\n // MySQL commits DDL as it runs (an implicit COMMIT that ends this\n // transaction), so for a migration with DDL this is not atomic: the\n // schema change is committed before the bookkeeping row is written, and a\n // crash in between leaves it applied but unrecorded. Only a migration of\n // plain DML statements commits with its row.\n async applyMigrationInTx(sql: string, bookkeeping: MigrationBookkeeping | null) {\n const conn = await pool.getConnection()\n try {\n await conn.query('START TRANSACTION')\n await runStatementsOnConn(conn, sql)\n if (bookkeeping && 'record' in bookkeeping) {\n const r = bookkeeping.record\n await conn.query(\n `INSERT INTO ${T} (id, name, hash, batch, direction)\n VALUES (?, ?, ?, ?, ?)`,\n [r.id, r.name, r.hash, r.batch, r.direction],\n )\n } else if (bookkeeping) {\n await conn.query(`DELETE FROM ${T} WHERE id = ?`, [bookkeeping.remove])\n }\n await conn.query('COMMIT')\n } catch (err) {\n await conn.query('ROLLBACK').catch(() => {\n // Swallow rollback errors; we're already throwing the original.\n })\n throw err\n } finally {\n conn.release()\n }\n },\n\n async applySqlNoTx(sql: string) {\n await runStatements(sql)\n },\n\n async introspect(): Promise<SchemaSnapshot> {\n // Reverse-engineer the live schema via information_schema. Types come\n // back as the declared COLUMN_TYPE (a code-first `uuid()` reads as\n // `char(36)`), so this powers `kick db introspect`; byte-exact drift\n // against a code-first snapshot needs a dialect-normalised compare.\n return introspectMysql(pool, { excludeTables: bookkeepingTables })\n },\n\n migrationsTable: table,\n\n kysely() {\n // Built once, on the same connection. Never destroyed here: the pool or\n // handle belongs to the caller (or to close()).\n return (migrationDb ??= new Kysely<any>({\n dialect: mysqlDialect({ pool: opts.pool as never }),\n }))\n },\n\n async close() {\n // The caller owns the pool unless it said otherwise — adopters\n // typically share it with the KickDbClient.\n if (opts.endPoolOnClose) await pool.end?.()\n },\n }\n}\n","import { ColumnBuilder } from './types'\n\n/**\n * A MySQL `ENUM`: `status: mysqlEnum('active', 'archived')`, typed as the\n * union of its values. The values keep their case.\n */\nexport function mysqlEnum<const V extends readonly [string, ...string[]]>(\n ...values: V\n): ColumnBuilder<V[number]> {\n const quoted = values.map((v) => `'${v.replace(/'/g, \"''\")}'`).join(',')\n return new ColumnBuilder<V[number]>(`enum(${quoted})`)\n}\n\n/** A 1-byte integer (`TINYINT`, -128…127; 0…255 with {@link unsigned}). */\nexport function tinyint(): ColumnBuilder<number> {\n return new ColumnBuilder<number>('tinyint')\n}\n\n/** A 3-byte integer (`MEDIUMINT`). */\nexport function mediumint(): ColumnBuilder<number> {\n return new ColumnBuilder<number>('mediumint')\n}\n\n/**\n * `DATETIME`, with fractional seconds when given: `datetime(3)`. Unlike\n * `TIMESTAMP` it isn't converted to UTC, and it holds years 1000–9999.\n */\nexport function datetime(fsp?: number): ColumnBuilder<Date> {\n return new ColumnBuilder<Date>(fsp === undefined ? 'datetime' : `datetime(${fsp})`)\n}\n\n/** MySQL's spelling of each integer column type kick/db has. */\nconst INTEGER_TYPES: Record<string, string> = {\n tinyint: 'tinyint',\n smallint: 'smallint',\n mediumint: 'mediumint',\n integer: 'int',\n int: 'int',\n bigint: 'bigint',\n}\n\n/**\n * Make an integer column `UNSIGNED`: `unsigned(integer())`,\n * `unsigned(bigint({ mode: 'bigint' }))`. Its type and chain stay as they were.\n */\nexport function unsigned<\n C extends ColumnBuilder<number> | ColumnBuilder<bigint> | ColumnBuilder<string>,\n>(column: C): C {\n const state = (column as unknown as { state: { type: string } }).state\n const base = INTEGER_TYPES[state.type]\n if (!base) {\n throw new Error(`unsigned(): ${state.type} isn't an integer column`)\n }\n state.type = `${base} unsigned`\n return column\n}\n"],"mappings":";;;;;;;;;;iaA4CA,SAAgB,aAAa,KAA0C,CAQrE,IAAM,IAAM,KAAK,KACX,aAAe,OAAO,IAAI,MAAM,eAAkB,WAAa,IAAI,KAAO,KAAK,KAC/E,QAAU,YAAY,IAAI,aAAa,CAAE,KAAM,YAAiC,CAAC,EAAG,OAAO,EAK3F,OAAU,aAAyD,QAAQ,iBAC3E,MAA4B,CAChC,SAAU,QAAQ,UAAY,QAC9B,YAAa,QAAQ,aAAe,EACtC,EAEA,OADA,OAAO,eAAe,QAAS,mBAAoB,CAAE,MAAO,MAAO,WAAY,EAAM,CAAC,EAC/E,OACT,CCmCA,SAAgB,kBAAkB,QAA4C,CAC5E,IAAM,QAAU,QAAQ,KAAK,EAG7B,GAFkB,WAAW,KAAK,OAEtB,EAAG,CAKb,IAAM,EAAI,kCAAkC,KAAK,OAAO,EACxD,GAAI,EAAG,CACL,IAAM,MAAQ,OAAO,EAAE,EAAE,EACnB,MAAQ,OAAO,EAAE,EAAE,EACzB,GAAI,OAAO,SAAS,KAAK,GAAK,OAAO,SAAS,KAAK,EACjD,MAAO,CAAE,OAAQ,UAAW,MAAO,KAAM,CAE7C,CAIA,IAAM,SAAW,gBAAgB,KAAK,OAAO,EAC7C,GAAI,CAAC,SAAU,OAAO,KACtB,IAAM,MAAQ,OAAO,SAAS,EAAE,EAC1B,MAAQ,OAAO,SAAS,EAAE,EAEhC,MADI,CAAC,OAAO,SAAS,KAAK,GAAK,CAAC,OAAO,SAAS,KAAK,EAAU,KACxD,CAAE,OAAQ,UAAW,MAAO,KAAM,CAC3C,CAGA,IAAM,EAAI,gBAAgB,KAAK,OAAO,EACtC,GAAI,CAAC,EAAG,OAAO,KACf,IAAM,MAAQ,OAAO,EAAE,EAAE,EACnB,MAAQ,OAAO,EAAE,EAAE,EAEzB,MADI,CAAC,OAAO,SAAS,KAAK,GAAK,CAAC,OAAO,SAAS,KAAK,EAAU,KACxD,CAAE,OAAQ,QAAS,MAAO,KAAM,CACzC,CASA,SAAgB,uBAAuB,QAAgC,CAErE,OADe,kBAAkB,OACrB,CAAC,EAAE,OAAS,IAC1B,CAMA,SAAS,oBAAoB,OAAmC,IAA4B,CAkB1F,OAjBI,QAAU,KACL,+BAA+B,KAAO,YAE3C,OAAO,SAAW,UAChB,OAAO,MAAQ,GAA0B,KACzC,OAAO,MAAQ,IAGf,OAAO,MAAQ,EACV,qCAA0E,IAAI,GAEhF,KAGL,OAAO,MAAQ,EACV,kCAAmD,IAAI,GAEzD,IACT,CAGA,SAAgB,qBAAqB,IAAuB,CAC1D,OAAO,mBAAmB,IAAK,OAAO,CACxC,CA4BA,SAAgB,aAAa,KAA6C,CACxE,GAAI,KAAK,gBAAkB,OAAO,KAAK,KAAK,KAAQ,WAClD,MAAM,IAAI,YACR,4BACA,mFACF,EAEF,IAAM,QAAmB,QACnB,CAAE,MAAS,KACb,gBAAkB,GAEtB,eAAe,eAAgB,CAC7B,GAAI,gBAAiB,OACrB,GAAM,CAAC,MAAQ,MAAM,KAAK,MAA6B,+BAAiC,EAClF,cAAgB,KAAK,EAAE,EAAE,SAAW,GAEpC,QAAU,oBADD,kBAAkB,aACQ,EAAG,aAAa,EACzD,GAAI,QACF,MAAM,IAAI,YACR,mCACA,GAAG,QAAQ,wKAGb,EAEF,gBAAkB,EACpB,CAMA,eAAe,cAAc,IAA4B,CACvD,IAAK,IAAM,QAAQ,qBAAqB,GAAG,EACzC,MAAM,KAAK,MAAM,IAAI,CAEzB,CAOA,eAAe,oBAAoB,KAA2B,IAA4B,CACxF,IAAK,IAAM,QAAQ,qBAAqB,GAAG,EACzC,MAAM,KAAK,MAAM,IAAI,CAEzB,CAEA,IAAM,MAAQ,KAAK,iBAAA,kBACb,EAAI,WAAW,QAAS,KAAK,EAC7B,EAAI,WAAW,QAAS,cAAc,KAAK,CAAC,EAG5C,kBAAoB,CAAC,MAAO,cAAc,KAAK,EAAG,cAAc,KAAK,CAAC,EACxE,YACJ,MAAO,CACL,QAEA,MAAM,uBAAwB,CAC5B,MAAM,cAAc,EACpB,MAAM,cAAc,mBAAmB,QAAS,KAAK,CAAC,EACtD,MAAM,cAAc,aAAa,QAAS,KAAK,CAAC,CAClD,EAEA,MAAM,aAAuC,CAC3C,GAAM,CAAC,MAAQ,MAAM,KAAK,MAUxB;gBACQ,EAAE;yCAEZ,EACA,OAAO,KAAK,IAAK,MAAS,CACxB,GAAI,IAAI,GACR,KAAM,IAAI,KACV,KAAM,IAAI,KACV,MAAO,OAAO,IAAI,KAAK,EACvB,UACE,IAAI,sBAAsB,KAAO,IAAI,WAAW,YAAY,EAAI,OAAO,IAAI,UAAU,EACvF,UAAW,IAAI,SACjB,EAAE,CACJ,EAEA,MAAM,cAAc,IAAK,CACvB,MAAM,KAAK,MACT,eAAe,EAAE;iCAEjB,CAAC,IAAI,GAAI,IAAI,KAAM,IAAI,KAAM,IAAI,MAAO,IAAI,SAAS,CACvD,CACF,EAEA,MAAM,cAAc,GAAY,CAC9B,MAAM,KAAK,MAAM,eAAe,EAAE,eAAgB,CAAC,EAAE,CAAC,CACxD,EAEA,MAAM,YAAY,MAAiC,CACjD,GAAM,CAAC,QAAU,MAAM,KAAK,MAC1B,UAAU,EAAE;;6CAGZ,CAAC,KAAK,CACR,EACA,OAAO,OAAO,eAAiB,CACjC,EAEA,MAAM,aAAc,CAClB,MAAM,KAAK,MACT,UAAU,EAAE;;sBAGd,CACF,EAEA,MAAM,aAAa,IAAa,CAC9B,MAAM,KAAK,mBAAoB,IAAK,IAAI,CAC1C,EAOA,MAAM,mBAAmB,IAAa,YAA0C,CAC9E,IAAM,KAAO,MAAM,KAAK,cAAc,EACtC,GAAI,CAGF,GAFA,MAAM,KAAK,MAAM,mBAAmB,EACpC,MAAM,oBAAoB,KAAM,GAAG,EAC/B,aAAe,WAAY,YAAa,CAC1C,IAAM,EAAI,YAAY,OACtB,MAAM,KAAK,MACT,eAAe,EAAE;qCAEjB,CAAC,EAAE,GAAI,EAAE,KAAM,EAAE,KAAM,EAAE,MAAO,EAAE,SAAS,CAC7C,CACF,MAAW,aACT,MAAM,KAAK,MAAM,eAAe,EAAE,eAAgB,CAAC,YAAY,MAAM,CAAC,EAExE,MAAM,KAAK,MAAM,QAAQ,CAC3B,OAAS,IAAK,CAIZ,MAHA,MAAM,KAAK,MAAM,UAAU,CAAC,CAAC,UAAY,CAEzC,CAAC,EACK,GACR,QAAU,CACR,KAAK,QAAQ,CACf,CACF,EAEA,MAAM,aAAa,IAAa,CAC9B,MAAM,cAAc,GAAG,CACzB,EAEA,MAAM,YAAsC,CAK1C,OAAO,gBAAgB,KAAM,CAAE,cAAe,iBAAkB,CAAC,CACnE,EAEA,gBAAiB,MAEjB,QAAS,CAGP,MAAQ,eAAgB,IAAI,OAAY,CACtC,QAAS,aAAa,CAAE,KAAM,KAAK,IAAc,CAAC,CACpD,CAAC,CACH,EAEA,MAAM,OAAQ,CAGR,KAAK,gBAAgB,MAAM,KAAK,MAAM,CAC5C,CACF,CACF,CChYA,SAAgB,UACd,GAAG,OACuB,CAC1B,IAAM,OAAS,OAAO,IAAK,GAAM,IAAI,EAAE,QAAQ,KAAM,IAAI,EAAE,EAAE,CAAC,CAAC,KAAK,GAAG,EACvE,OAAO,IAAI,cAAyB,QAAQ,OAAO,EAAE,CACvD,CAGA,SAAgB,SAAiC,CAC/C,OAAO,IAAI,cAAsB,SAAS,CAC5C,CAGA,SAAgB,WAAmC,CACjD,OAAO,IAAI,cAAsB,WAAW,CAC9C,CAMA,SAAgB,SAAS,IAAmC,CAC1D,OAAO,IAAI,cAAoB,MAAQ,IAAA,GAAY,WAAa,YAAY,IAAI,EAAE,CACpF,CAGA,MAAM,cAAwC,CAC5C,QAAS,UACT,SAAU,WACV,UAAW,YACX,QAAS,MACT,IAAK,MACL,OAAQ,QACV,EAMA,SAAgB,SAEd,OAAc,CACd,IAAM,MAAS,OAAkD,MAC3D,KAAO,cAAc,MAAM,MACjC,GAAI,CAAC,KACH,MAAU,MAAM,eAAe,MAAM,KAAK,yBAAyB,EAGrE,MADA,OAAM,KAAO,GAAG,KAAK,WACd,MACT"}
|
|
1
|
+
{"version":3,"file":"mysql.mjs","names":[],"sources":["../src/adapters/mysql/dialect.ts","../src/adapters/mysql/adapter.ts","../src/dsl/columns/mysql.ts"],"sourcesContent":["// mysqlDialect — thin factory over Kysely's MysqlDialect so adopters\n// never have to reach for `import { MysqlDialect } from 'kysely'`.\n// Mirrors the `@forinda/kickjs-db/pg` template; the kysely subpackage\n// is a pinned internal dep of the framework.\n\nimport { MysqlDialect, type Dialect as KyselyDialect } from 'kysely'\nimport { KICK_DIALECT_DATES, markDialect, type DialectDateOptions } from '../../dialect-marker'\n\nimport type { MysqlPoolLike } from './adapter'\n\nexport interface MysqlDialectOptions {\n /**\n * mysql2-compatible pool — `createPool(...)` from `mysql2/promise`, the\n * same pool `mysqlAdapter` takes. A callback-API pool works too.\n */\n pool: MysqlPoolLike\n}\n\n/**\n * Construct the dialect that `createDbClient({ dialect })` consumes.\n *\n * **MySQL 8.0+ required.** Kickjs-db's relational query layer\n * compiles to `JSON_ARRAYAGG`, which shipped in 8.0. Adapter-side\n * version assertion lands at first connection from `mysqlAdapter()`;\n * see that factory's docs.\n *\n * @example\n * ```ts\n * import { createDbClient } from '@forinda/kickjs-db'\n * import { mysqlAdapter, mysqlDialect } from '@forinda/kickjs-db/mysql'\n * import { createPool } from 'mysql2/promise'\n *\n * const pool = createPool({\n * host: '127.0.0.1', user: 'root', password: '...', database: 'app',\n * })\n *\n * export const db = createDbClient({\n * schema,\n * dialect: mysqlDialect({ pool }),\n * })\n *\n * export const migrationAdapter = mysqlAdapter({ pool })\n * ```\n */\nexport function mysqlDialect(opts: MysqlDialectOptions): KyselyDialect {\n // MysqlDialect's `pool` parameter is typed as `mysql2.Pool` in\n // newer Kysely versions; casting through `unknown` keeps adopters\n // using compatible drivers (e.g. mysql-mariadb forks) working\n // without pulling mysql2's typings into our public surface.\n // Kysely's MysqlDialect drives the callback API (`getConnection(cb)`). A\n // `mysql2/promise` pool ignores the callback, so every query hung; its\n // callback-API core is `pool.pool` — hand Kysely that.\n const raw = opts.pool as unknown as { pool?: { getConnection?: unknown } }\n const callbackPool = typeof raw.pool?.getConnection === 'function' ? raw.pool : opts.pool\n const dialect = markDialect(new MysqlDialect({ pool: callbackPool as unknown as never }), 'mysql')\n // Rows nested by `db.query` carry dates as strings; read them the way\n // mysql2 reads top-level ones — in the pool's time zone, and not at all\n // for the types `dateStrings` keeps as strings.\n type Cfg = { timezone?: string; dateStrings?: boolean | string[] }\n const config = (callbackPool as { config?: { connectionConfig?: Cfg } }).config?.connectionConfig\n const dates: DialectDateOptions = {\n timezone: config?.timezone ?? 'local',\n dateStrings: config?.dateStrings ?? false,\n }\n Object.defineProperty(dialect, KICK_DIALECT_DATES, { value: dates, enumerable: false })\n return dialect\n}\n","import { Kysely } from 'kysely'\nimport { splitSqlStatements } from '../../migrate/split-statements'\nimport { mysqlDialect } from './dialect'\nimport {\n KickDbError,\n lockTableDdl,\n lockTableName,\n pushTableName,\n quoteTable,\n KICK_MIGRATIONS_TABLE,\n migrationsTableDdl,\n type Dialect,\n type MigrationAdapter,\n type MigrationBookkeeping,\n type MigrationRow,\n type SchemaSnapshot,\n} from '../../index'\nimport { introspectMysql } from '../../migrate/introspect-mysql'\n\n/**\n * mysql2-shaped pool that `mysqlAdapter` consumes. Mirrors the\n * structural surface of `mysql2/promise`'s Pool. The adapter only\n * uses `query(...)` and `getConnection(...)` so any mysql2-compatible\n * driver works.\n *\n * Return type is `Promise<[R, unknown]>` (not `[R[], unknown]`) so\n * mysql2's `Pool.query()` is structurally assignable: SELECT\n * statements return `RowDataPacket[]` (so callers pass `R =\n * MyRow[]`), INSERT / UPDATE / DELETE return `ResultSetHeader` (so\n * callers pass `R = ResultSetHeader`). Each adapter call site picks\n * the row shape it expects via the type parameter.\n */\nexport interface MysqlConnectionLike {\n // `any[]`, not `readonly unknown[]`: mysql2 declares its values parameter\n // mutable, and a readonly one here made a real mysql2 Pool unassignable.\n // oxlint-disable-next-line no-explicit-any\n query<R = unknown>(sql: string, params?: any[]): Promise<[R, unknown]>\n release(): void\n}\n\nexport interface MysqlPoolLike {\n // oxlint-disable-next-line no-explicit-any\n query<R = unknown>(sql: string, params?: any[]): Promise<[R, unknown]>\n getConnection(): Promise<MysqlConnectionLike>\n end?(): Promise<void>\n}\n\nexport interface MysqlAdapterOptions {\n /**\n * The table migrations are recorded in. Default `kick_migrations`; its lock\n * table is the same name plus `_lock`.\n */\n migrationsTable?: string\n /**\n * mysql2-compatible Pool. Caller-owned — `close()` on the adapter\n * does NOT end the pool because adopters typically share a single\n * pool across the migration adapter and the KickDbClient.\n */\n pool: MysqlPoolLike\n /**\n * End the pool when the adapter closes. Set it when the adapter owns its\n * pool — a `kick.config.ts` `db.adapter()` factory that opens one for the\n * CLI — or the `kick db` command never exits. Default `false`: an app\n * usually shares one pool with its client.\n */\n endPoolOnClose?: boolean\n}\n\n/**\n * Minimum supported MySQL major + MariaDB version. `JSON_ARRAYAGG`\n * shipped in MySQL 8.0 and MariaDB 10.5 — earlier versions can't\n * run kickjs-db's relational query layer.\n */\nconst MIN_MYSQL_MAJOR = 8\nconst MIN_MARIADB_MAJOR = 10\nconst MIN_MARIADB_MINOR = 5\n\n/**\n * Parsed shape returned by `parseMysqlVersion`. `flavor` lets\n * adopters distinguish MySQL from MariaDB without re-grepping the\n * raw string.\n */\nexport interface ParsedMysqlVersion {\n flavor: 'mysql' | 'mariadb'\n major: number\n minor: number\n}\n\n/**\n * Parse a MySQL `SELECT VERSION()` string. Handles:\n *\n * - MySQL: `8.0.34`, `8.4.0`, `5.7.42-log`\n * - MariaDB plain: `10.6.11-MariaDB`, `10.5.21-MariaDB-log`,\n * `10.4.32-MariaDB`\n * - MariaDB w/ compat prefix: `5.5.5-10.6.11-MariaDB-1:10.6.11+maria~ubu2004`\n * (the leading `5.5.5-` is a wire-protocol thing for older MySQL\n * clients; the real server version sits immediately before\n * `-MariaDB`)\n *\n * Returns `null` on unparseable input.\n */\nexport function parseMysqlVersion(version: string): ParsedMysqlVersion | null {\n const trimmed = version.trim()\n const isMariaDb = /MariaDB/i.test(trimmed)\n\n if (isMariaDb) {\n // Pull the `major.minor` that sits immediately before\n // `-MariaDB`. This skips the `5.5.5-` compat prefix when\n // present and grabs the real server version regardless of\n // whether one's there.\n const m = /(\\d+)\\.(\\d+)(?:\\.\\d+)?-MariaDB/i.exec(trimmed)\n if (m) {\n const major = Number(m[1])\n const minor = Number(m[2])\n if (Number.isFinite(major) && Number.isFinite(minor)) {\n return { flavor: 'mariadb', major, minor }\n }\n }\n // Fallback for vendor strings we haven't seen — try the\n // leading x.y. Better to surface the wrong floor than to\n // refuse an otherwise valid MariaDB outright.\n const fallback = /^(\\d+)\\.(\\d+)/.exec(trimmed)\n if (!fallback) return null\n const major = Number(fallback[1])\n const minor = Number(fallback[2])\n if (!Number.isFinite(major) || !Number.isFinite(minor)) return null\n return { flavor: 'mariadb', major, minor }\n }\n\n // MySQL: leading x.y from the start of the string.\n const m = /^(\\d+)\\.(\\d+)/.exec(trimmed)\n if (!m) return null\n const major = Number(m[1])\n const minor = Number(m[2])\n if (!Number.isFinite(major) || !Number.isFinite(minor)) return null\n return { flavor: 'mysql', major, minor }\n}\n\n/**\n * Back-compat shim — pre-existing API surface that returned the\n * major version only. Kept exported so adopters depending on it\n * keep working; new code should use `parseMysqlVersion`.\n *\n * @deprecated Use `parseMysqlVersion` for full version + flavor info.\n */\nexport function parseMysqlMajorVersion(version: string): number | null {\n const parsed = parseMysqlVersion(version)\n return parsed?.major ?? null\n}\n\n/**\n * Returns the failure reason if the parsed version doesn't satisfy\n * kickjs-db's floor, or `null` if it does. Pure — no I/O.\n */\nfunction checkVersionSupport(parsed: ParsedMysqlVersion | null, raw: string): string | null {\n if (parsed == null) {\n return `unparseable version string: ${raw || '<empty>'}`\n }\n if (parsed.flavor === 'mariadb') {\n if (parsed.major > MIN_MARIADB_MAJOR) return null\n if (parsed.major < MIN_MARIADB_MAJOR) {\n return `MariaDB ${MIN_MARIADB_MAJOR}.${MIN_MARIADB_MINOR}+ required (detected: ${raw})`\n }\n if (parsed.minor < MIN_MARIADB_MINOR) {\n return `MariaDB ${MIN_MARIADB_MAJOR}.${MIN_MARIADB_MINOR}+ required (detected: ${raw})`\n }\n return null\n }\n // MySQL flavor.\n if (parsed.major < MIN_MYSQL_MAJOR) {\n return `MySQL ${MIN_MYSQL_MAJOR}.0+ required (detected: ${raw})`\n }\n return null\n}\n\n/** {@link splitSqlStatements} for MySQL. */\nexport function splitMysqlStatements(sql: string): string[] {\n return splitSqlStatements(sql, 'mysql')\n}\n\n/**\n * MigrationAdapter implementation backed by mysql2.\n *\n * Asserts MySQL 8.0+ (or MariaDB 10.5+) on first connection (via\n * the first `ensureMigrationTables` call, lazily — no I/O at\n * construction time). Earlier versions throw `KickDbError` with\n * code `KICK_DB_RELATIONAL_NOT_SUPPORTED` carrying the detected\n * version so adopters get a clear error before any query reaches\n * the relational compiler.\n *\n * Multi-statement support: every `query()` call splits the SQL\n * blob at top-level semicolons and runs each statement\n * sequentially. Works against mysql2's default settings; adopters\n * who set `multipleStatements: true` on the pool pay no extra\n * cost (the split is cheap on small DDL blobs).\n *\n * Lock semantics: single-row UPDATE WHERE locked_at IS NULL on\n * `kick_migrations_lock`. Only the row created by\n * `ensureMigrationTables()` exists, so the UPDATE either flips\n * `locked_at` and returns `affectedRows=1` (we won) or matches\n * zero rows (someone else holds it).\n *\n * Introspection: not implemented in v1 — throws `KickDbError` with\n * code `KICK_DB_INTROSPECT_NOT_SUPPORTED`. Drift detection lands\n * in a follow-up that walks `information_schema`.\n */\nexport function mysqlAdapter(opts: MysqlAdapterOptions): MigrationAdapter {\n if (opts.endPoolOnClose && typeof opts.pool.end !== 'function') {\n throw new KickDbError(\n 'KICK_DB_POOL_NOT_CLOSABLE',\n 'mysqlAdapter({ endPoolOnClose: true }) needs a pool with an end() method to close',\n )\n }\n const dialect: Dialect = 'mysql'\n const { pool } = opts\n let versionVerified = false\n\n async function assertVersion() {\n if (versionVerified) return\n const [rows] = await pool.query<{ version: string }[]>(`SELECT VERSION() AS \\`version\\``)\n const versionString = rows[0]?.version ?? ''\n const parsed = parseMysqlVersion(versionString)\n const failure = checkVersionSupport(parsed, versionString)\n if (failure) {\n throw new KickDbError(\n 'KICK_DB_RELATIONAL_NOT_SUPPORTED',\n `${failure}. JSON_ARRAYAGG (required by the relational query layer) shipped in ` +\n `MySQL 8.0 and MariaDB 10.5. Use layer-1/layer-2 queries (selectFrom / selectAll) ` +\n `on older versions.`,\n )\n }\n versionVerified = true\n }\n\n /**\n * Run a (possibly multi-statement) SQL blob via the pool,\n * splitting at top-level `;` so default mysql2 settings work.\n */\n async function runStatements(sql: string): Promise<void> {\n for (const stmt of splitMysqlStatements(sql)) {\n await pool.query(stmt)\n }\n }\n\n /**\n * Same as `runStatements` but on a held connection (used inside\n * `applySqlInTx` so all statements share the BEGIN / COMMIT\n * boundary).\n */\n async function runStatementsOnConn(conn: MysqlConnectionLike, sql: string): Promise<void> {\n for (const stmt of splitMysqlStatements(sql)) {\n await conn.query(stmt)\n }\n }\n\n const table = opts.migrationsTable ?? KICK_MIGRATIONS_TABLE\n const T = quoteTable(dialect, table)\n const L = quoteTable(dialect, lockTableName(table))\n // Introspection must not report the bookkeeping tables as schema.\n // A dot is part of the name here, not a schema.\n const bookkeepingTables = [table, lockTableName(table), pushTableName(table)]\n let migrationDb: Kysely<any> | undefined\n return {\n dialect,\n\n async ensureMigrationTables() {\n await assertVersion()\n await runStatements(migrationsTableDdl(dialect, table))\n await runStatements(lockTableDdl(dialect, table))\n },\n\n async listApplied(): Promise<MigrationRow[]> {\n const [rows] = await pool.query<\n Array<{\n id: string\n name: string\n hash: string\n batch: number\n applied_at: string | Date\n direction: 'up' | 'down'\n }>\n >(\n `SELECT id, name, hash, batch, applied_at, direction\n FROM ${T}\n ORDER BY applied_at ASC, id ASC`,\n )\n return rows.map((row) => ({\n id: row.id,\n name: row.name,\n hash: row.hash,\n batch: Number(row.batch),\n appliedAt:\n row.applied_at instanceof Date ? row.applied_at.toISOString() : String(row.applied_at),\n direction: row.direction,\n }))\n },\n\n async recordApplied(row) {\n await pool.query(\n `INSERT INTO ${T} (id, name, hash, batch, direction)\n VALUES (?, ?, ?, ?, ?)`,\n [row.id, row.name, row.hash, row.batch, row.direction],\n )\n },\n\n async removeApplied(id: string) {\n await pool.query(`DELETE FROM ${T} WHERE id = ?`, [id])\n },\n\n async acquireLock(owner: string, staleAfterSeconds?: number): Promise<boolean> {\n const [result] = await pool.query<{ affectedRows: number }>(\n staleAfterSeconds === undefined\n ? `UPDATE ${L}\n SET locked_at = CURRENT_TIMESTAMP, locked_by = ?\n WHERE id = 1 AND locked_at IS NULL`\n : `UPDATE ${L}\n SET locked_at = CURRENT_TIMESTAMP, locked_by = ?\n WHERE id = 1 AND (locked_at IS NULL OR locked_at < CURRENT_TIMESTAMP - INTERVAL ? SECOND)`,\n staleAfterSeconds === undefined ? [owner] : [owner, staleAfterSeconds],\n )\n return result.affectedRows === 1\n },\n\n async refreshLock(owner: string) {\n // mysql2 reports matched rows (FOUND_ROWS), so a refresh in the same second still counts.\n const [result] = await pool.query<{ affectedRows: number }>(\n `UPDATE ${L} SET locked_at = CURRENT_TIMESTAMP WHERE id = 1 AND locked_by = ?`,\n [owner],\n )\n return result.affectedRows === 1\n },\n\n async releaseLock(owner?: string) {\n await pool.query(\n `UPDATE ${L}\n SET locked_at = NULL, locked_by = NULL\n WHERE id = 1 AND (? IS NULL OR locked_by = ?)`,\n [owner ?? null, owner ?? null],\n )\n },\n\n async applySqlInTx(sql: string) {\n await this.applyMigrationInTx!(sql, null)\n },\n\n // MySQL commits DDL as it runs (an implicit COMMIT that ends this\n // transaction), so for a migration with DDL this is not atomic: the\n // schema change is committed before the bookkeeping row is written, and a\n // crash in between leaves it applied but unrecorded. Only a migration of\n // plain DML statements commits with its row.\n async applyMigrationInTx(sql: string, bookkeeping: MigrationBookkeeping | null) {\n const conn = await pool.getConnection()\n try {\n await conn.query('START TRANSACTION')\n await runStatementsOnConn(conn, sql)\n if (bookkeeping && 'record' in bookkeeping) {\n const r = bookkeeping.record\n await conn.query(\n `INSERT INTO ${T} (id, name, hash, batch, direction)\n VALUES (?, ?, ?, ?, ?)`,\n [r.id, r.name, r.hash, r.batch, r.direction],\n )\n } else if (bookkeeping) {\n await conn.query(`DELETE FROM ${T} WHERE id = ?`, [bookkeeping.remove])\n }\n await conn.query('COMMIT')\n } catch (err) {\n await conn.query('ROLLBACK').catch(() => {\n // Swallow rollback errors; we're already throwing the original.\n })\n throw err\n } finally {\n conn.release()\n }\n },\n\n async applySqlNoTx(sql: string) {\n await runStatements(sql)\n },\n\n async introspect(): Promise<SchemaSnapshot> {\n // Reverse-engineer the live schema via information_schema. Types come\n // back as the declared COLUMN_TYPE (a code-first `uuid()` reads as\n // `char(36)`), so this powers `kick db introspect`; byte-exact drift\n // against a code-first snapshot needs a dialect-normalised compare.\n return introspectMysql(pool, { excludeTables: bookkeepingTables })\n },\n\n migrationsTable: table,\n\n kysely() {\n // Built once, on the same connection. Never destroyed here: the pool or\n // handle belongs to the caller (or to close()).\n return (migrationDb ??= new Kysely<any>({\n dialect: mysqlDialect({ pool: opts.pool as never }),\n }))\n },\n\n async close() {\n // The caller owns the pool unless it said otherwise — adopters\n // typically share it with the KickDbClient.\n if (opts.endPoolOnClose) await pool.end?.()\n },\n }\n}\n","import { ColumnBuilder } from './types'\n\n/**\n * A MySQL `ENUM`: `status: mysqlEnum('active', 'archived')`, typed as the\n * union of its values. The values keep their case.\n */\nexport function mysqlEnum<const V extends readonly [string, ...string[]]>(\n ...values: V\n): ColumnBuilder<V[number]> {\n const quoted = values.map((v) => `'${v.replace(/'/g, \"''\")}'`).join(',')\n return new ColumnBuilder<V[number]>(`enum(${quoted})`)\n}\n\n/** A 1-byte integer (`TINYINT`, -128…127; 0…255 with {@link unsigned}). */\nexport function tinyint(): ColumnBuilder<number> {\n return new ColumnBuilder<number>('tinyint')\n}\n\n/** A 3-byte integer (`MEDIUMINT`). */\nexport function mediumint(): ColumnBuilder<number> {\n return new ColumnBuilder<number>('mediumint')\n}\n\n/**\n * `DATETIME`, with fractional seconds when given: `datetime(3)`. Unlike\n * `TIMESTAMP` it isn't converted to UTC, and it holds years 1000–9999.\n */\nexport function datetime(fsp?: number): ColumnBuilder<Date> {\n return new ColumnBuilder<Date>(fsp === undefined ? 'datetime' : `datetime(${fsp})`)\n}\n\n/** MySQL's spelling of each integer column type kick/db has. */\nconst INTEGER_TYPES: Record<string, string> = {\n tinyint: 'tinyint',\n smallint: 'smallint',\n mediumint: 'mediumint',\n integer: 'int',\n int: 'int',\n bigint: 'bigint',\n}\n\n/**\n * Make an integer column `UNSIGNED`: `unsigned(integer())`,\n * `unsigned(bigint({ mode: 'bigint' }))`. Its type and chain stay as they were.\n */\nexport function unsigned<\n C extends ColumnBuilder<number> | ColumnBuilder<bigint> | ColumnBuilder<string>,\n>(column: C): C {\n const state = (column as unknown as { state: { type: string } }).state\n const base = INTEGER_TYPES[state.type]\n if (!base) {\n throw new Error(`unsigned(): ${state.type} isn't an integer column`)\n }\n state.type = `${base} unsigned`\n return column\n}\n"],"mappings":";;;;;;;;;;iaA4CA,SAAgB,aAAa,KAA0C,CAQrE,IAAM,IAAM,KAAK,KACX,aAAe,OAAO,IAAI,MAAM,eAAkB,WAAa,IAAI,KAAO,KAAK,KAC/E,QAAU,YAAY,IAAI,aAAa,CAAE,KAAM,YAAiC,CAAC,EAAG,OAAO,EAK3F,OAAU,aAAyD,QAAQ,iBAC3E,MAA4B,CAChC,SAAU,QAAQ,UAAY,QAC9B,YAAa,QAAQ,aAAe,EACtC,EAEA,OADA,OAAO,eAAe,QAAS,mBAAoB,CAAE,MAAO,MAAO,WAAY,EAAM,CAAC,EAC/E,OACT,CCmCA,SAAgB,kBAAkB,QAA4C,CAC5E,IAAM,QAAU,QAAQ,KAAK,EAG7B,GAFkB,WAAW,KAAK,OAEtB,EAAG,CAKb,IAAM,EAAI,kCAAkC,KAAK,OAAO,EACxD,GAAI,EAAG,CACL,IAAM,MAAQ,OAAO,EAAE,EAAE,EACnB,MAAQ,OAAO,EAAE,EAAE,EACzB,GAAI,OAAO,SAAS,KAAK,GAAK,OAAO,SAAS,KAAK,EACjD,MAAO,CAAE,OAAQ,UAAW,MAAO,KAAM,CAE7C,CAIA,IAAM,SAAW,gBAAgB,KAAK,OAAO,EAC7C,GAAI,CAAC,SAAU,OAAO,KACtB,IAAM,MAAQ,OAAO,SAAS,EAAE,EAC1B,MAAQ,OAAO,SAAS,EAAE,EAEhC,MADI,CAAC,OAAO,SAAS,KAAK,GAAK,CAAC,OAAO,SAAS,KAAK,EAAU,KACxD,CAAE,OAAQ,UAAW,MAAO,KAAM,CAC3C,CAGA,IAAM,EAAI,gBAAgB,KAAK,OAAO,EACtC,GAAI,CAAC,EAAG,OAAO,KACf,IAAM,MAAQ,OAAO,EAAE,EAAE,EACnB,MAAQ,OAAO,EAAE,EAAE,EAEzB,MADI,CAAC,OAAO,SAAS,KAAK,GAAK,CAAC,OAAO,SAAS,KAAK,EAAU,KACxD,CAAE,OAAQ,QAAS,MAAO,KAAM,CACzC,CASA,SAAgB,uBAAuB,QAAgC,CAErE,OADe,kBAAkB,OACrB,CAAC,EAAE,OAAS,IAC1B,CAMA,SAAS,oBAAoB,OAAmC,IAA4B,CAkB1F,OAjBI,QAAU,KACL,+BAA+B,KAAO,YAE3C,OAAO,SAAW,UAChB,OAAO,MAAQ,GAA0B,KACzC,OAAO,MAAQ,IAGf,OAAO,MAAQ,EACV,qCAA0E,IAAI,GAEhF,KAGL,OAAO,MAAQ,EACV,kCAAmD,IAAI,GAEzD,IACT,CAGA,SAAgB,qBAAqB,IAAuB,CAC1D,OAAO,mBAAmB,IAAK,OAAO,CACxC,CA4BA,SAAgB,aAAa,KAA6C,CACxE,GAAI,KAAK,gBAAkB,OAAO,KAAK,KAAK,KAAQ,WAClD,MAAM,IAAI,YACR,4BACA,mFACF,EAEF,IAAM,QAAmB,QACnB,CAAE,MAAS,KACb,gBAAkB,GAEtB,eAAe,eAAgB,CAC7B,GAAI,gBAAiB,OACrB,GAAM,CAAC,MAAQ,MAAM,KAAK,MAA6B,+BAAiC,EAClF,cAAgB,KAAK,EAAE,EAAE,SAAW,GAEpC,QAAU,oBADD,kBAAkB,aACQ,EAAG,aAAa,EACzD,GAAI,QACF,MAAM,IAAI,YACR,mCACA,GAAG,QAAQ,wKAGb,EAEF,gBAAkB,EACpB,CAMA,eAAe,cAAc,IAA4B,CACvD,IAAK,IAAM,QAAQ,qBAAqB,GAAG,EACzC,MAAM,KAAK,MAAM,IAAI,CAEzB,CAOA,eAAe,oBAAoB,KAA2B,IAA4B,CACxF,IAAK,IAAM,QAAQ,qBAAqB,GAAG,EACzC,MAAM,KAAK,MAAM,IAAI,CAEzB,CAEA,IAAM,MAAQ,KAAK,iBAAA,kBACb,EAAI,WAAW,QAAS,KAAK,EAC7B,EAAI,WAAW,QAAS,cAAc,KAAK,CAAC,EAG5C,kBAAoB,CAAC,MAAO,cAAc,KAAK,EAAG,cAAc,KAAK,CAAC,EACxE,YACJ,MAAO,CACL,QAEA,MAAM,uBAAwB,CAC5B,MAAM,cAAc,EACpB,MAAM,cAAc,mBAAmB,QAAS,KAAK,CAAC,EACtD,MAAM,cAAc,aAAa,QAAS,KAAK,CAAC,CAClD,EAEA,MAAM,aAAuC,CAC3C,GAAM,CAAC,MAAQ,MAAM,KAAK,MAUxB;gBACQ,EAAE;yCAEZ,EACA,OAAO,KAAK,IAAK,MAAS,CACxB,GAAI,IAAI,GACR,KAAM,IAAI,KACV,KAAM,IAAI,KACV,MAAO,OAAO,IAAI,KAAK,EACvB,UACE,IAAI,sBAAsB,KAAO,IAAI,WAAW,YAAY,EAAI,OAAO,IAAI,UAAU,EACvF,UAAW,IAAI,SACjB,EAAE,CACJ,EAEA,MAAM,cAAc,IAAK,CACvB,MAAM,KAAK,MACT,eAAe,EAAE;iCAEjB,CAAC,IAAI,GAAI,IAAI,KAAM,IAAI,KAAM,IAAI,MAAO,IAAI,SAAS,CACvD,CACF,EAEA,MAAM,cAAc,GAAY,CAC9B,MAAM,KAAK,MAAM,eAAe,EAAE,eAAgB,CAAC,EAAE,CAAC,CACxD,EAEA,MAAM,YAAY,MAAe,kBAA8C,CAC7E,GAAM,CAAC,QAAU,MAAM,KAAK,MAC1B,oBAAsB,IAAA,GAClB,UAAU,EAAE;;iDAGZ,UAAU,EAAE;;wGAGhB,oBAAsB,IAAA,GAAY,CAAC,KAAK,EAAI,CAAC,MAAO,iBAAiB,CACvE,EACA,OAAO,OAAO,eAAiB,CACjC,EAEA,MAAM,YAAY,MAAe,CAE/B,GAAM,CAAC,QAAU,MAAM,KAAK,MAC1B,UAAU,EAAE,mEACZ,CAAC,KAAK,CACR,EACA,OAAO,OAAO,eAAiB,CACjC,EAEA,MAAM,YAAY,MAAgB,CAChC,MAAM,KAAK,MACT,UAAU,EAAE;;wDAGZ,CAAC,OAAS,KAAM,OAAS,IAAI,CAC/B,CACF,EAEA,MAAM,aAAa,IAAa,CAC9B,MAAM,KAAK,mBAAoB,IAAK,IAAI,CAC1C,EAOA,MAAM,mBAAmB,IAAa,YAA0C,CAC9E,IAAM,KAAO,MAAM,KAAK,cAAc,EACtC,GAAI,CAGF,GAFA,MAAM,KAAK,MAAM,mBAAmB,EACpC,MAAM,oBAAoB,KAAM,GAAG,EAC/B,aAAe,WAAY,YAAa,CAC1C,IAAM,EAAI,YAAY,OACtB,MAAM,KAAK,MACT,eAAe,EAAE;qCAEjB,CAAC,EAAE,GAAI,EAAE,KAAM,EAAE,KAAM,EAAE,MAAO,EAAE,SAAS,CAC7C,CACF,MAAW,aACT,MAAM,KAAK,MAAM,eAAe,EAAE,eAAgB,CAAC,YAAY,MAAM,CAAC,EAExE,MAAM,KAAK,MAAM,QAAQ,CAC3B,OAAS,IAAK,CAIZ,MAHA,MAAM,KAAK,MAAM,UAAU,CAAC,CAAC,UAAY,CAEzC,CAAC,EACK,GACR,QAAU,CACR,KAAK,QAAQ,CACf,CACF,EAEA,MAAM,aAAa,IAAa,CAC9B,MAAM,cAAc,GAAG,CACzB,EAEA,MAAM,YAAsC,CAK1C,OAAO,gBAAgB,KAAM,CAAE,cAAe,iBAAkB,CAAC,CACnE,EAEA,gBAAiB,MAEjB,QAAS,CAGP,MAAQ,eAAgB,IAAI,OAAY,CACtC,QAAS,aAAa,CAAE,KAAM,KAAK,IAAc,CAAC,CACpD,CAAC,CACH,EAEA,MAAM,OAAQ,CAGR,KAAK,gBAAgB,MAAM,KAAK,MAAM,CAC5C,CACF,CACF,CC9YA,SAAgB,UACd,GAAG,OACuB,CAC1B,IAAM,OAAS,OAAO,IAAK,GAAM,IAAI,EAAE,QAAQ,KAAM,IAAI,EAAE,EAAE,CAAC,CAAC,KAAK,GAAG,EACvE,OAAO,IAAI,cAAyB,QAAQ,OAAO,EAAE,CACvD,CAGA,SAAgB,SAAiC,CAC/C,OAAO,IAAI,cAAsB,SAAS,CAC5C,CAGA,SAAgB,WAAmC,CACjD,OAAO,IAAI,cAAsB,WAAW,CAC9C,CAMA,SAAgB,SAAS,IAAmC,CAC1D,OAAO,IAAI,cAAoB,MAAQ,IAAA,GAAY,WAAa,YAAY,IAAI,EAAE,CACpF,CAGA,MAAM,cAAwC,CAC5C,QAAS,UACT,SAAU,WACV,UAAW,YACX,QAAS,MACT,IAAK,MACL,OAAQ,QACV,EAMA,SAAgB,SAEd,OAAc,CACd,IAAM,MAAS,OAAkD,MAC3D,KAAO,cAAc,MAAM,MACjC,GAAI,CAAC,KACH,MAAU,MAAM,eAAe,MAAM,KAAK,yBAAyB,EAGrE,MADA,OAAM,KAAO,GAAG,KAAK,WACd,MACT"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* @forinda/kickjs-db v8.
|
|
2
|
+
* @forinda/kickjs-db v8.10.1
|
|
3
3
|
*
|
|
4
4
|
* Copyright (c) Felix Orinda
|
|
5
5
|
*
|
|
@@ -8,5 +8,5 @@
|
|
|
8
8
|
*
|
|
9
9
|
* @license MIT
|
|
10
10
|
*/
|
|
11
|
-
import{r as ColumnBuilder,t as CustomColumnBuilder}from"./custom-type-
|
|
12
|
-
//# sourceMappingURL=pg-
|
|
11
|
+
import{r as ColumnBuilder,t as CustomColumnBuilder}from"./custom-type-Bu5nn7V1.mjs";var PgEnumColumnBuilder=class extends ColumnBuilder{enumName;values;constructor(enumName,values){super(enumName),this.enumName=enumName,this.values=values}};function pgEnum(name,...values){return Object.assign(()=>new PgEnumColumnBuilder(name,values),{enumName:name,values})}function tsvector(){return new ColumnBuilder(`tsvector`)}var PgCodecColumnBuilder=class extends CustomColumnBuilder{};const vectorToDriver=v=>`[${v.join(`,`)}]`,vectorFromDriver=raw=>typeof raw==`string`?JSON.parse(raw):raw;function vectorColumn(base,dim){return new PgCodecColumnBuilder({dataType:()=>dim===void 0?base:`${base}(${dim})`,toDriver:vectorToDriver,fromDriver:vectorFromDriver})}function vector(dim){return vectorColumn(`vector`,dim)}function halfvec(dim){return vectorColumn(`halfvec`,dim)}const pointToDriver=p=>`(${p.x},${p.y})`,pointFromDriver=raw=>{if(typeof raw!=`string`)return raw;let[x,y]=raw.replace(/[()\s]/g,``).split(`,`).map(Number);return{x,y}};function point(){return new PgCodecColumnBuilder({dataType:()=>`point`,toDriver:pointToDriver,fromDriver:pointFromDriver})}function geometry(type,srid){let args=[type,srid].filter(a=>a!==void 0);return new ColumnBuilder(args.length?`geometry(${args.join(`, `)})`:`geometry`)}function macaddr(){return new ColumnBuilder(`macaddr`)}function macaddr8(){return new ColumnBuilder(`macaddr8`)}function citext(){return new ColumnBuilder(`citext`)}function money(){return new ColumnBuilder(`money`)}function inet(){return new ColumnBuilder(`inet`)}function cidr(){return new ColumnBuilder(`cidr`)}function xml(){return new ColumnBuilder(`xml`)}export{geometry as a,macaddr as c,pgEnum as d,point as f,xml as h,citext as i,macaddr8 as l,vector as m,PgEnumColumnBuilder as n,halfvec as o,tsvector as p,cidr as r,inet as s,PgCodecColumnBuilder as t,money as u};
|
|
12
|
+
//# sourceMappingURL=pg-RiTdI_BK.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"pg-
|
|
1
|
+
{"version":3,"file":"pg-RiTdI_BK.mjs","names":[],"sources":["../src/dsl/columns/pg.ts"],"sourcesContent":["import { CustomColumnBuilder } from '../../custom-type'\nimport { ColumnBuilder } from './types'\n\n// PG-only column types. Phantom T per builder so SchemaToTypes<S> can narrow\n// each column to a useful TS shape — strings for the text-y types, number[]\n// for vector embeddings, etc.\n\n/**\n * Declare a PostgreSQL ENUM type.\n *\n * @example\n * ```ts\n * export const taskStatus = pgEnum('task_status', 'todo', 'in_progress', 'done')\n *\n * export const tasks = table('tasks', {\n * id: uuid().primaryKey().defaultRandom(),\n * status: taskStatus().notNull().default('todo'),\n * })\n * ```\n *\n * The factory returns a column builder whose phantom type narrows to\n * the union of the declared values — `db.selectFrom('tasks').select('status')`\n * types `status: 'todo' | 'in_progress' | 'done'`.\n *\n * Schema-level state (the enum name + values) is attached to every\n * column the factory produces so introspection / drift / emit can pick\n * it up: `kick db generate` emits the `CREATE TYPE <name> AS ENUM (...)`\n * before the first table that uses it, and later value changes as\n * migrations.\n */\nexport interface PgEnumBuilder<TName extends string, TValues extends readonly string[]> {\n (): PgEnumColumnBuilder<TName, TValues>\n /** The SQL identifier — used by emit + drift detection. */\n readonly enumName: TName\n /** Allowed literal values, in declaration order. */\n readonly values: TValues\n}\n\nexport class PgEnumColumnBuilder<\n TName extends string,\n TValues extends readonly string[],\n> extends ColumnBuilder<TValues[number]> {\n /** The enum's SQL identifier — preserved for emit + drift detection. */\n readonly enumName: TName\n /** Allowed values — readonly to prevent mutation across columns. */\n readonly values: TValues\n\n constructor(enumName: TName, values: TValues) {\n // The SQL data type IS the enum identifier — `status task_status`,\n // not `status text` — so PG enforces the membership constraint.\n super(enumName)\n this.enumName = enumName\n this.values = values\n }\n}\n\n// Variadic rest forces TS to infer EACH value as its literal type, so\n// `pgEnum('s', 'todo', 'done')` resolves to\n// `PgEnumBuilder<'s', ['todo', 'done']>`. Without rest, an array\n// literal stored in a variable would widen to `string[]` and the\n// column phantom would collapse to plain `string`, defeating the\n// entire point of the helper. Adopters with a pre-existing array\n// can still spread it: `pgEnum('s', ...VALUES as const)`.\nexport function pgEnum<TName extends string, const TValues extends readonly [string, ...string[]]>(\n name: TName,\n ...values: TValues\n): PgEnumBuilder<TName, TValues> {\n const factory = (): PgEnumColumnBuilder<TName, TValues> =>\n new PgEnumColumnBuilder<TName, TValues>(name, values)\n // Attach metadata to the factory itself so introspection that walks\n // `Object.values(schema)` can discover enum declarations even when\n // they're declared standalone (without a column reference).\n return Object.assign(factory, { enumName: name, values }) as PgEnumBuilder<TName, TValues>\n}\n\nexport function tsvector(): ColumnBuilder<string> {\n return new ColumnBuilder<string>('tsvector')\n}\n\n/**\n * A built-in column whose values the driver doesn't convert, with the codecs\n * that do. Validators still know its type (a custom type reads as \"any\").\n * Codecs are shared module-level functions: they're keyed by column name, and\n * one instance per type keeps same-named columns in different tables quiet.\n */\nexport class PgCodecColumnBuilder<T> extends CustomColumnBuilder<T> {}\n\n/** pgvector's text form is `[1,2,3]`: valid JSON both ways. */\nconst vectorToDriver = (v: number[]) => `[${v.join(',')}]`\nconst vectorFromDriver = (raw: unknown): number[] =>\n typeof raw === 'string' ? (JSON.parse(raw) as number[]) : (raw as number[])\n\nfunction vectorColumn(base: string, dim?: number): PgCodecColumnBuilder<number[]> {\n return new PgCodecColumnBuilder<number[]>({\n dataType: () => (dim === undefined ? base : `${base}(${dim})`),\n toDriver: vectorToDriver,\n fromDriver: vectorFromDriver,\n })\n}\n\n/** A pgvector embedding (`vector(n)`), as `number[]`. Needs the `vector` extension. */\nexport function vector(dim?: number): PgCodecColumnBuilder<number[]> {\n return vectorColumn('vector', dim)\n}\n\n/** A half-precision pgvector embedding (`halfvec(n)`, pgvector 0.7+), as `number[]`. */\nexport function halfvec(dim?: number): PgCodecColumnBuilder<number[]> {\n return vectorColumn('halfvec', dim)\n}\n\n/** A point on a plane. */\nexport interface PgPoint {\n x: number\n y: number\n}\n\nconst pointToDriver = (p: PgPoint) => `(${p.x},${p.y})`\nconst pointFromDriver = (raw: unknown): PgPoint => {\n if (typeof raw !== 'string') return raw as PgPoint // `pg` already parses it\n const [x, y] = raw\n .replace(/[()\\s]/g, '')\n .split(',')\n .map(Number)\n return { x: x!, y: y! }\n}\n\n/** Postgres' geometric `point`, as `{ x, y }`. */\nexport function point(): PgCodecColumnBuilder<PgPoint> {\n return new PgCodecColumnBuilder<PgPoint>({\n dataType: () => 'point',\n toDriver: pointToDriver,\n fromDriver: pointFromDriver,\n })\n}\n\n/**\n * A PostGIS geometry: `geometry('Point', 4326)` → `geometry(Point, 4326)`.\n * The value is what PostGIS returns (hex EWKB) and takes text in (WKT or\n * EWKT, `'SRID=4326;POINT(36.8 -1.28)'`); convert with `ST_AsGeoJSON` /\n * `ST_GeomFromGeoJSON` in SQL. Needs the `postgis` extension.\n */\nexport function geometry(type?: string, srid?: number): ColumnBuilder<string> {\n const args = [type, srid].filter((a) => a !== undefined)\n return new ColumnBuilder<string>(args.length ? `geometry(${args.join(', ')})` : 'geometry')\n}\n\n/** A MAC address (`08:00:2b:01:02:03`). */\nexport function macaddr(): ColumnBuilder<string> {\n return new ColumnBuilder<string>('macaddr')\n}\n\n/** An EUI-64 MAC address. */\nexport function macaddr8(): ColumnBuilder<string> {\n return new ColumnBuilder<string>('macaddr8')\n}\n\nexport function citext(): ColumnBuilder<string> {\n return new ColumnBuilder<string>('citext')\n}\n\nexport function money(): ColumnBuilder<string> {\n return new ColumnBuilder<string>('money')\n}\n\nexport function inet(): ColumnBuilder<string> {\n return new ColumnBuilder<string>('inet')\n}\n\nexport function cidr(): ColumnBuilder<string> {\n return new ColumnBuilder<string>('cidr')\n}\n\nexport function xml(): ColumnBuilder<string> {\n return new ColumnBuilder<string>('xml')\n}\n"],"mappings":";;;;;;;;;;oFAsCA,IAAa,oBAAb,cAGU,aAA+B,CAEvC,SAEA,OAEA,YAAY,SAAiB,OAAiB,CAG5C,MAAM,QAAQ,EACd,KAAK,SAAW,SAChB,KAAK,OAAS,MAChB,CACF,EASA,SAAgB,OACd,KACA,GAAG,OAC4B,CAM/B,OAAO,OAAO,WAJZ,IAAI,oBAAoC,KAAM,MAAM,EAIxB,CAAE,SAAU,KAAM,MAAO,CAAC,CAC1D,CAEA,SAAgB,UAAkC,CAChD,OAAO,IAAI,cAAsB,UAAU,CAC7C,CAQA,IAAa,qBAAb,cAA6C,mBAAuB,CAAC,EAGrE,MAAM,eAAkB,GAAgB,IAAI,EAAE,KAAK,GAAG,EAAE,GAClD,iBAAoB,KACxB,OAAO,KAAQ,SAAY,KAAK,MAAM,GAAG,EAAkB,IAE7D,SAAS,aAAa,KAAc,IAA8C,CAChF,OAAO,IAAI,qBAA+B,CACxC,aAAiB,MAAQ,IAAA,GAAY,KAAO,GAAG,KAAK,GAAG,IAAI,GAC3D,SAAU,eACV,WAAY,gBACd,CAAC,CACH,CAGA,SAAgB,OAAO,IAA8C,CACnE,OAAO,aAAa,SAAU,GAAG,CACnC,CAGA,SAAgB,QAAQ,IAA8C,CACpE,OAAO,aAAa,UAAW,GAAG,CACpC,CAQA,MAAM,cAAiB,GAAe,IAAI,EAAE,EAAE,GAAG,EAAE,EAAE,GAC/C,gBAAmB,KAA0B,CACjD,GAAI,OAAO,KAAQ,SAAU,OAAO,IACpC,GAAM,CAAC,EAAG,GAAK,IACZ,QAAQ,UAAW,EAAE,CAAC,CACtB,MAAM,GAAG,CAAC,CACV,IAAI,MAAM,EACb,MAAO,CAAK,EAAO,CAAG,CACxB,EAGA,SAAgB,OAAuC,CACrD,OAAO,IAAI,qBAA8B,CACvC,aAAgB,QAChB,SAAU,cACV,WAAY,eACd,CAAC,CACH,CAQA,SAAgB,SAAS,KAAe,KAAsC,CAC5E,IAAM,KAAO,CAAC,KAAM,IAAI,CAAC,CAAC,OAAQ,GAAM,IAAM,IAAA,EAAS,EACvD,OAAO,IAAI,cAAsB,KAAK,OAAS,YAAY,KAAK,KAAK,IAAI,EAAE,GAAK,UAAU,CAC5F,CAGA,SAAgB,SAAiC,CAC/C,OAAO,IAAI,cAAsB,SAAS,CAC5C,CAGA,SAAgB,UAAkC,CAChD,OAAO,IAAI,cAAsB,UAAU,CAC7C,CAEA,SAAgB,QAAgC,CAC9C,OAAO,IAAI,cAAsB,QAAQ,CAC3C,CAEA,SAAgB,OAA+B,CAC7C,OAAO,IAAI,cAAsB,OAAO,CAC1C,CAEA,SAAgB,MAA8B,CAC5C,OAAO,IAAI,cAAsB,MAAM,CACzC,CAEA,SAAgB,MAA8B,CAC5C,OAAO,IAAI,cAAsB,MAAM,CACzC,CAEA,SAAgB,KAA6B,CAC3C,OAAO,IAAI,cAAsB,KAAK,CACxC"}
|
package/dist/pg.d.mts
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
|
|
2
|
-
import { d as TypedColumnRefs, t as ColumnBuilder } from "./types-
|
|
3
|
-
import { Ct as MaterializedViewOptions,
|
|
4
|
-
import { _ as PolicyDecl, b as pgRole, n as TableDecl, r as TableOptions, v as RoleDecl, x as policy, y as isRole } from "./table-
|
|
2
|
+
import { d as TypedColumnRefs, t as ColumnBuilder } from "./types-BRgtaCZf.mjs";
|
|
3
|
+
import { Ct as MaterializedViewOptions, k as CustomColumnBuilder, wt as ViewDecl } from "./index-BjEMENJz.mjs";
|
|
4
|
+
import { _ as PolicyDecl, b as pgRole, n as TableDecl, r as TableOptions, v as RoleDecl, x as policy, y as isRole } from "./table-B2HY_SQD.mjs";
|
|
5
|
+
import { i as pgAdapter, n as PgClientLike, r as PgPoolLike, t as PgAdapterOptions } from "./adapter-Cyxerm3a.mjs";
|
|
5
6
|
import { Dialect } from "kysely";
|
|
6
7
|
//#region src/dsl/columns/pg.d.ts
|
|
7
8
|
/**
|
|
@@ -133,71 +134,6 @@ type EffectiveSchema<TName extends string> = TName extends 'public' ? undefined
|
|
|
133
134
|
export declare function pgSchema<TName extends string>(name: TName): PgSchema<EffectiveSchema<TName>>;
|
|
134
135
|
export declare function isPgSchema(value: unknown): value is PgSchema<string>;
|
|
135
136
|
//#endregion
|
|
136
|
-
//#region src/adapters/pg/adapter.d.ts
|
|
137
|
-
/**
|
|
138
|
-
* Minimal client returned by PgPoolLike.connect(). Matches the shape of
|
|
139
|
-
* pg.PoolClient and @neondatabase/serverless's PoolClient.
|
|
140
|
-
*/
|
|
141
|
-
export interface PgClientLike {
|
|
142
|
-
query<R = unknown>(sql: string, params?: readonly unknown[]): Promise<{
|
|
143
|
-
rows: R[];
|
|
144
|
-
rowCount: number | null;
|
|
145
|
-
}>;
|
|
146
|
-
release(): void;
|
|
147
|
-
}
|
|
148
|
-
/**
|
|
149
|
-
* Pool-shaped contract that pgAdapter consumes. Both `pg.Pool` and
|
|
150
|
-
* `@neondatabase/serverless`'s Pool match this structurally — no hard
|
|
151
|
-
* dependency on the `pg` package. Adopters pick whichever pg-protocol-
|
|
152
|
-
* compatible client fits their runtime (node-postgres / neon-serverless /
|
|
153
|
-
* pg-cloudflare / etc).
|
|
154
|
-
*
|
|
155
|
-
* Edge runtimes with a different surface (Neon HTTP single-shot,
|
|
156
|
-
* Cloudflare D1's batch-only model) have their own adapter packages that
|
|
157
|
-
* implement MigrationAdapter directly — they don't reuse this shape.
|
|
158
|
-
*/
|
|
159
|
-
export interface PgPoolLike {
|
|
160
|
-
query<R = unknown>(sql: string, params?: readonly unknown[]): Promise<{
|
|
161
|
-
rows: R[];
|
|
162
|
-
rowCount: number | null;
|
|
163
|
-
}>;
|
|
164
|
-
connect(): Promise<PgClientLike>;
|
|
165
|
-
end?(): Promise<void>;
|
|
166
|
-
}
|
|
167
|
-
export interface PgAdapterOptions {
|
|
168
|
-
/**
|
|
169
|
-
* The table migrations are recorded in. Default `kick_migrations`; its lock
|
|
170
|
-
* table is the same name plus `_lock`. On Postgres it may be schema-qualified
|
|
171
|
-
* (`meta.kick_migrations`); the schema is created if missing.
|
|
172
|
-
*/
|
|
173
|
-
migrationsTable?: string;
|
|
174
|
-
/**
|
|
175
|
-
* A pg-protocol-compatible Pool. Concretely: pg.Pool, neon-serverless Pool,
|
|
176
|
-
* any other Pool that satisfies the {@link PgPoolLike} structural shape.
|
|
177
|
-
*/
|
|
178
|
-
pool: PgPoolLike;
|
|
179
|
-
/** PG schema name to scope the introspector and validate at construction. Default 'public'. */
|
|
180
|
-
schema?: string;
|
|
181
|
-
/**
|
|
182
|
-
* End the pool when the adapter closes. Set it when the adapter owns its
|
|
183
|
-
* pool — a `kick.config.ts` `db.adapter()` factory that opens one for the
|
|
184
|
-
* CLI — or the `kick db` command waits for idle clients to time out.
|
|
185
|
-
* Default `false`: an app usually shares one pool with its client.
|
|
186
|
-
*/
|
|
187
|
-
endPoolOnClose?: boolean;
|
|
188
|
-
}
|
|
189
|
-
/**
|
|
190
|
-
* MigrationAdapter implementation backed by node-postgres. The pool is
|
|
191
|
-
* caller-owned — close() does NOT end() the pool because adopters typically
|
|
192
|
-
* share a single pool across the migrationAdapter and the KickDbClient.
|
|
193
|
-
*
|
|
194
|
-
* Lock semantics: single-row UPDATE WHERE locked_at IS NULL on
|
|
195
|
-
* kick_migrations_lock. Only the row created by ensureMigrationTables()
|
|
196
|
-
* exists, so the UPDATE either flips locked_at and returns rowCount=1
|
|
197
|
-
* (we won) or matches zero rows (someone else holds it).
|
|
198
|
-
*/
|
|
199
|
-
export declare function pgAdapter(opts: PgAdapterOptions): MigrationAdapter;
|
|
200
|
-
//#endregion
|
|
201
137
|
//#region src/adapters/pg/dialect.d.ts
|
|
202
138
|
export interface PgDialectOptions {
|
|
203
139
|
/**
|
|
@@ -251,5 +187,5 @@ export declare function pgDialect(opts: PgDialectOptions): Dialect;
|
|
|
251
187
|
*/
|
|
252
188
|
export declare function materializedView<TName extends string, C extends Record<string, ColumnBuilder>>(name: TName, columns: C, options: MaterializedViewOptions<C>): ViewDecl<TName, C, undefined> & TypedColumnRefs<C>;
|
|
253
189
|
//#endregion
|
|
254
|
-
export { PolicyDecl, RoleDecl, isRole, pgRole, policy };
|
|
190
|
+
export { PgAdapterOptions, PgClientLike, PgPoolLike, PolicyDecl, RoleDecl, isRole, pgAdapter, pgRole, policy };
|
|
255
191
|
//# sourceMappingURL=pg.d.mts.map
|
package/dist/pg.d.mts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"pg.d.mts","names":["KyselyDialect"],"sources":["../src/dsl/columns/pg.ts","../src/dsl/pg-schema.ts","../src/adapters/pg/
|
|
1
|
+
{"version":3,"file":"pg.d.mts","names":["KyselyDialect"],"sources":["../src/dsl/columns/pg.ts","../src/dsl/pg-schema.ts","../src/adapters/pg/dialect.ts","../src/dsl/pg-views.ts"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA8BiB,cAAc,sBAAsB;MAC/C,oBAAoB,OAAO;;WAEtB,UAAU;;WAEV,QAAQ;;qBAGN,oBACX,sBACA,2CACQ,cAAc;;WAEb,UAAU;;WAEV,QAAQ;EAEjB,YAAY,UAAU,OAAO,QAAQ;;wBAgBvB,OAAO,4BAA4B,gDACjD,MAAM,UACH,QAAQ,UACV,cAAc,OAAO;wBASR,YAAY;;;;;;;qBAUf,qBAAqB,WAAW,oBAAoB;;wBAgBjD,OAAO,eAAe;;wBAKtB,QAAQ,eAAe;;iBAKtB;EACf;EACA;;;wBAcc,SAAS,qBAAqB;;;;;;;wBAc9B,SAAS,eAAe,gBAAgB;;wBAMxC,WAAW;;wBAKX,YAAY;wBAIZ,UAAU;wBAIV,SAAS;wBAIT,QAAQ;wBAIR,QAAQ;wBAIR,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBC/IN,SAAS;WACf;;WAEA;EAET,MAAM,sBAAsB,UAAU,eAAe,gBACnD,MAAM,OACN,SAAS,GACT,UAAU,aAAa,KACtB,UAAU,OAAO,GAAG,WAAW,gBAAgB;;;;;;;;;;;;;;KAe/C,gBAAgB,wBAAwB,qCAAqC;;;;;;;wBAWlE,SAAS,sBAAsB,MAAM,QAAQ,SAAS,gBAAgB;wBA6BtE,WAAW,iBAAiB,SAAS;;;iBClFpC;;;;;;EAMf,MAAM;;;;;EAKN;;;;;;;;;;;;;;;;;;;;;wBAsBc,UAAU,MAAM,mBAAmBA;;;;;;;;;;;;;;;;;;wBC1BnC,iBAAiB,sBAAsB,UAAU,eAAe,gBAC9E,MAAM,OACN,SAAS,GACT,SAAS,wBAAwB,KAChC,SAAS,OAAO,gBAAgB,gBAAgB"}
|
package/dist/pg.mjs
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* @forinda/kickjs-db v8.
|
|
2
|
+
* @forinda/kickjs-db v8.10.1
|
|
3
3
|
*
|
|
4
4
|
* Copyright (c) Felix Orinda
|
|
5
5
|
*
|
|
@@ -8,13 +8,16 @@
|
|
|
8
8
|
*
|
|
9
9
|
* @license MIT
|
|
10
10
|
*/
|
|
11
|
-
import{a as markDialect,
|
|
11
|
+
import{_t as buildView,a as markDialect,b as introspectPg,ft as PolicyDecl,gt as policy,ht as pgRole,mt as isRole,pt as RoleDecl,ut as KickDbError}from"./create-CM0i_6q6.mjs";import{B as isPgSchema,Ft as lockTableDdl,It as lockTableName,Lt as migrationsTableDdl,Rt as pushTableName,V as pgSchema,zt as quoteTable}from"./src-aPkKZ9dw.mjs";import{a as geometry,c as macaddr,d as pgEnum,f as point,h as xml,i as citext,l as macaddr8,m as vector,n as PgEnumColumnBuilder,o as halfvec,p as tsvector,r as cidr,s as inet,t as PgCodecColumnBuilder,u as money}from"./pg-RiTdI_BK.mjs";import{Kysely,PostgresDialect}from"kysely";function pgDialect(opts){return markDialect(new PostgresDialect({pool:opts.pool,...opts.cursor?{cursor:opts.cursor}:{}}),`postgres`)}const SAFE_SCHEMA_NAME=/^[a-z_][a-z0-9_]*$/i;function pgAdapter(opts){if(opts.endPoolOnClose&&typeof opts.pool.end!=`function`)throw new KickDbError(`KICK_DB_POOL_NOT_CLOSABLE`,`pgAdapter({ endPoolOnClose: true }) needs a pool with an end() method to close`);let dialect=`postgres`,{pool}=opts,schema=opts.schema??`public`;if(!SAFE_SCHEMA_NAME.test(schema))throw Error(`Invalid PG schema name: ${schema}`);let table=opts.migrationsTable??`kick_migrations`,T=quoteTable(dialect,table),L=quoteTable(dialect,lockTableName(table)),bookkeepingTables=(table.includes(`.`)?table.slice(0,table.lastIndexOf(`.`)):schema)===schema?[table,lockTableName(table),pushTableName(table)].map(t=>t.slice(t.lastIndexOf(`.`)+1)):[],migrationDb;return{dialect,async ensureMigrationTables(){await pool.query(migrationsTableDdl(dialect,table)),await pool.query(lockTableDdl(dialect,table))},async listApplied(){return(await pool.query(`SELECT id, name, hash, batch, applied_at, direction
|
|
12
12
|
FROM ${T}
|
|
13
13
|
ORDER BY applied_at ASC, id ASC`)).rows.map(row=>({id:row.id,name:row.name,hash:row.hash,batch:Number(row.batch),appliedAt:row.applied_at instanceof Date?row.applied_at.toISOString():String(row.applied_at),direction:row.direction}))},async recordApplied(row){await pool.query(`INSERT INTO ${T} (id, name, hash, batch, direction)
|
|
14
|
-
VALUES ($1, $2, $3, $4, $5)`,[row.id,row.name,row.hash,row.batch,row.direction])},async removeApplied(id){await pool.query(`DELETE FROM ${T} WHERE id = $1`,[id])},async acquireLock(owner){return(await pool.query(`UPDATE ${L}
|
|
15
|
-
|
|
16
|
-
|
|
14
|
+
VALUES ($1, $2, $3, $4, $5)`,[row.id,row.name,row.hash,row.batch,row.direction])},async removeApplied(id){await pool.query(`DELETE FROM ${T} WHERE id = $1`,[id])},async acquireLock(owner,staleAfterSeconds){return(staleAfterSeconds===void 0?await pool.query(`UPDATE ${L}
|
|
15
|
+
SET locked_at = CURRENT_TIMESTAMP, locked_by = $1
|
|
16
|
+
WHERE id = 1 AND locked_at IS NULL`,[owner]):await pool.query(`UPDATE ${L}
|
|
17
|
+
SET locked_at = CURRENT_TIMESTAMP, locked_by = $1
|
|
18
|
+
WHERE id = 1 AND (locked_at IS NULL
|
|
19
|
+
OR locked_at < CURRENT_TIMESTAMP - $2::int * INTERVAL '1 second')`,[owner,staleAfterSeconds])).rowCount===1},async refreshLock(owner){return(await pool.query(`UPDATE ${L} SET locked_at = CURRENT_TIMESTAMP WHERE id = 1 AND locked_by = $1`,[owner])).rowCount===1},async releaseLock(owner){await pool.query(`UPDATE ${L}
|
|
17
20
|
SET locked_at = NULL, locked_by = NULL
|
|
18
|
-
WHERE id = 1
|
|
21
|
+
WHERE id = 1 AND ($1::text IS NULL OR locked_by = $1)`,[owner??null])},async applySqlInTx(sql){await this.applyMigrationInTx(sql,null)},async applyMigrationInTx(sql,bookkeeping){let client=await pool.connect();try{if(await client.query(`BEGIN`),await client.query(sql),bookkeeping&&`record`in bookkeeping){let r=bookkeeping.record;await client.query(`INSERT INTO ${T} (id, name, hash, batch, direction)
|
|
19
22
|
VALUES ($1, $2, $3, $4, $5)`,[r.id,r.name,r.hash,r.batch,r.direction])}else bookkeeping&&await client.query(`DELETE FROM ${T} WHERE id = $1`,[bookkeeping.remove]);await client.query(`COMMIT`)}catch(err){throw await client.query(`ROLLBACK`).catch(()=>{}),err}finally{client.release()}},async applySqlNoTx(sql){await pool.query(sql)},async introspect(){return introspectPg(pool,{schema,excludeTables:bookkeepingTables})},migrationsTable:table,kysely(){return migrationDb??=new Kysely({dialect:pgDialect({pool})})},async close(){opts.endPoolOnClose&&await opts.pool.end?.()}}}function materializedView(name,columns,options){return buildView(name,columns,options.as,!0,options.constraints,void 0)}export{PgCodecColumnBuilder,PgEnumColumnBuilder,PolicyDecl,RoleDecl,cidr,citext,geometry,halfvec,inet,isPgSchema,isRole,macaddr,macaddr8,materializedView,money,pgAdapter,pgDialect,pgEnum,pgRole,pgSchema,point,policy,tsvector,vector,xml};
|
|
20
23
|
//# sourceMappingURL=pg.mjs.map
|
package/dist/pg.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"pg.mjs","names":[],"sources":["../src/adapters/pg/dialect.ts","../src/adapters/pg/adapter.ts","../src/dsl/pg-views.ts"],"sourcesContent":["// pgDialect — thin factory over Kysely's PostgresDialect so adopters\n// never have to write `import { PostgresDialect } from 'kysely'`.\n// Kysely is a pinned internal dep of the framework; surfacing it\n// through our own export keeps the adopter import surface stable\n// even when we change query backends (or fork Kysely's internals).\n\nimport { PostgresDialect, type Dialect as KyselyDialect } from 'kysely'\nimport { markDialect } from '../../dialect-marker'\n\nimport type { PgPoolLike } from './adapter'\n\nexport interface PgDialectOptions {\n /**\n * pg-protocol-compatible pool. Both `pg.Pool` and\n * `@neondatabase/serverless`'s Pool match structurally; adopters\n * pick whichever runtime fits.\n */\n pool: PgPoolLike\n /**\n * `pg-cursor`'s `Cursor` class, for `.stream()`: rows arrive in chunks\n * instead of all at once. `import Cursor from 'pg-cursor'`.\n */\n cursor?: unknown\n}\n\n/**\n * Construct the dialect that `createDbClient({ dialect })` consumes.\n *\n * @example\n * ```ts\n * import { createDbClient } from '@forinda/kickjs-db'\n * import { pgDialect, pgAdapter } from '@forinda/kickjs-db/pg'\n * import { Pool } from 'pg'\n *\n * const pool = new Pool({ connectionString: process.env.DATABASE_URL })\n *\n * export const db = createDbClient({\n * schema,\n * dialect: pgDialect({ pool }),\n * })\n *\n * export const migrationAdapter = pgAdapter({ pool })\n * ```\n */\nexport function pgDialect(opts: PgDialectOptions): KyselyDialect {\n // PostgresDialect's `pool` parameter is typed as `PG.Pool` in newer\n // Kysely versions; casting through `unknown` keeps adopters using\n // alternate clients (neon, pg-cloudflare) compatible without\n // pulling node-postgres' typings into our public surface.\n return markDialect(\n new PostgresDialect({\n pool: opts.pool as unknown as never,\n ...(opts.cursor ? { cursor: opts.cursor as never } : {}),\n }),\n 'postgres',\n )\n}\n","import { Kysely } from 'kysely'\nimport { pgDialect } from './dialect'\nimport {\n introspectPg,\n KickDbError,\n lockTableDdl,\n lockTableName,\n pushTableName,\n quoteTable,\n KICK_MIGRATIONS_TABLE,\n migrationsTableDdl,\n type Dialect,\n type MigrationAdapter,\n type MigrationBookkeeping,\n type MigrationRow,\n type SchemaSnapshot,\n} from '../../index'\n\n/**\n * Minimal client returned by PgPoolLike.connect(). Matches the shape of\n * pg.PoolClient and @neondatabase/serverless's PoolClient.\n */\nexport interface PgClientLike {\n query<R = unknown>(\n sql: string,\n params?: readonly unknown[],\n ): Promise<{ rows: R[]; rowCount: number | null }>\n release(): void\n}\n\n/**\n * Pool-shaped contract that pgAdapter consumes. Both `pg.Pool` and\n * `@neondatabase/serverless`'s Pool match this structurally — no hard\n * dependency on the `pg` package. Adopters pick whichever pg-protocol-\n * compatible client fits their runtime (node-postgres / neon-serverless /\n * pg-cloudflare / etc).\n *\n * Edge runtimes with a different surface (Neon HTTP single-shot,\n * Cloudflare D1's batch-only model) have their own adapter packages that\n * implement MigrationAdapter directly — they don't reuse this shape.\n */\nexport interface PgPoolLike {\n query<R = unknown>(\n sql: string,\n params?: readonly unknown[],\n ): Promise<{ rows: R[]; rowCount: number | null }>\n connect(): Promise<PgClientLike>\n end?(): Promise<void>\n}\n\nexport interface PgAdapterOptions {\n /**\n * The table migrations are recorded in. Default `kick_migrations`; its lock\n * table is the same name plus `_lock`. On Postgres it may be schema-qualified\n * (`meta.kick_migrations`); the schema is created if missing.\n */\n migrationsTable?: string\n /**\n * A pg-protocol-compatible Pool. Concretely: pg.Pool, neon-serverless Pool,\n * any other Pool that satisfies the {@link PgPoolLike} structural shape.\n */\n pool: PgPoolLike\n /** PG schema name to scope the introspector and validate at construction. Default 'public'. */\n schema?: string\n /**\n * End the pool when the adapter closes. Set it when the adapter owns its\n * pool — a `kick.config.ts` `db.adapter()` factory that opens one for the\n * CLI — or the `kick db` command waits for idle clients to time out.\n * Default `false`: an app usually shares one pool with its client.\n */\n endPoolOnClose?: boolean\n}\n\nconst SAFE_SCHEMA_NAME = /^[a-z_][a-z0-9_]*$/i\n\n/**\n * MigrationAdapter implementation backed by node-postgres. The pool is\n * caller-owned — close() does NOT end() the pool because adopters typically\n * share a single pool across the migrationAdapter and the KickDbClient.\n *\n * Lock semantics: single-row UPDATE WHERE locked_at IS NULL on\n * kick_migrations_lock. Only the row created by ensureMigrationTables()\n * exists, so the UPDATE either flips locked_at and returns rowCount=1\n * (we won) or matches zero rows (someone else holds it).\n */\nexport function pgAdapter(opts: PgAdapterOptions): MigrationAdapter {\n if (opts.endPoolOnClose && typeof opts.pool.end !== 'function') {\n throw new KickDbError(\n 'KICK_DB_POOL_NOT_CLOSABLE',\n 'pgAdapter({ endPoolOnClose: true }) needs a pool with an end() method to close',\n )\n }\n const dialect: Dialect = 'postgres'\n const { pool } = opts\n const schema = opts.schema ?? 'public'\n if (!SAFE_SCHEMA_NAME.test(schema)) {\n // Schema name lands inside introspection queries unparameterised so guard\n // here rather than down at the SQL boundary.\n throw new Error(`Invalid PG schema name: ${schema}`)\n }\n\n const table = opts.migrationsTable ?? KICK_MIGRATIONS_TABLE\n const T = quoteTable(dialect, table)\n const L = quoteTable(dialect, lockTableName(table))\n // Introspection must not report the bookkeeping tables as schema.\n // Postgres reads a dotted name as schema.table. Introspection reads one\n // schema and matches bare names, so the tables are only left out when they\n // live in that schema — elsewhere, a same-named table here is the user's.\n const bookkeepingSchema = table.includes('.') ? table.slice(0, table.lastIndexOf('.')) : schema\n const bookkeepingTables =\n bookkeepingSchema === schema\n ? [table, lockTableName(table), pushTableName(table)].map((t) =>\n t.slice(t.lastIndexOf('.') + 1),\n )\n : []\n let migrationDb: Kysely<any> | undefined\n return {\n dialect,\n\n async ensureMigrationTables() {\n await pool.query(migrationsTableDdl(dialect, table))\n await pool.query(lockTableDdl(dialect, table))\n },\n\n async listApplied(): Promise<MigrationRow[]> {\n const r = await pool.query<{\n id: string\n name: string\n hash: string\n batch: number | string\n applied_at: string | Date\n direction: 'up' | 'down'\n }>(\n `SELECT id, name, hash, batch, applied_at, direction\n FROM ${T}\n ORDER BY applied_at ASC, id ASC`,\n )\n return r.rows.map((row) => ({\n id: row.id,\n name: row.name,\n hash: row.hash,\n batch: Number(row.batch),\n appliedAt:\n row.applied_at instanceof Date ? row.applied_at.toISOString() : String(row.applied_at),\n direction: row.direction,\n }))\n },\n\n async recordApplied(row) {\n await pool.query(\n `INSERT INTO ${T} (id, name, hash, batch, direction)\n VALUES ($1, $2, $3, $4, $5)`,\n [row.id, row.name, row.hash, row.batch, row.direction],\n )\n },\n\n async removeApplied(id: string) {\n await pool.query(`DELETE FROM ${T} WHERE id = $1`, [id])\n },\n\n async acquireLock(owner: string): Promise<boolean> {\n const r = await pool.query(\n `UPDATE ${L}\n SET locked_at = CURRENT_TIMESTAMP, locked_by = $1\n WHERE id = 1 AND locked_at IS NULL`,\n [owner],\n )\n return r.rowCount === 1\n },\n\n async releaseLock() {\n await pool.query(\n `UPDATE ${L}\n SET locked_at = NULL, locked_by = NULL\n WHERE id = 1`,\n )\n },\n\n async applySqlInTx(sql: string) {\n await this.applyMigrationInTx!(sql, null)\n },\n\n async applyMigrationInTx(sql: string, bookkeeping: MigrationBookkeeping | null) {\n const client = await pool.connect()\n try {\n await client.query('BEGIN')\n await client.query(sql)\n if (bookkeeping && 'record' in bookkeeping) {\n const r = bookkeeping.record\n await client.query(\n `INSERT INTO ${T} (id, name, hash, batch, direction)\n VALUES ($1, $2, $3, $4, $5)`,\n [r.id, r.name, r.hash, r.batch, r.direction],\n )\n } else if (bookkeeping) {\n await client.query(`DELETE FROM ${T} WHERE id = $1`, [bookkeeping.remove])\n }\n await client.query('COMMIT')\n } catch (err) {\n await client.query('ROLLBACK').catch(() => {\n /* swallow rollback errors; we're already throwing the original */\n })\n throw err\n } finally {\n client.release()\n }\n },\n\n async applySqlNoTx(sql: string) {\n await pool.query(sql)\n },\n\n async introspect(): Promise<SchemaSnapshot> {\n return introspectPg(pool, { schema, excludeTables: bookkeepingTables })\n },\n\n migrationsTable: table,\n\n kysely() {\n // Built once, on the same connection. Never destroyed here: the pool or\n // handle belongs to the caller (or to close()).\n return (migrationDb ??= new Kysely<any>({ dialect: pgDialect({ pool: pool as never }) }))\n },\n\n async close() {\n // The caller owns the pool unless it said otherwise — adopters\n // typically share it with the KickDbClient.\n if (opts.endPoolOnClose) await opts.pool.end?.()\n },\n }\n}\n","import type { ColumnBuilder, TypedColumnRefs } from './columns/types'\nimport { buildView, type MaterializedViewOptions, type ViewDecl } from './view'\n\n/**\n * A materialized view (Postgres): the `SELECT`'s result stored as a table,\n * read fast and brought up to date with `db.refreshMaterializedView(name)`.\n *\n * ```ts\n * export const dailySales = materializedView(\n * 'daily_sales',\n * { day: date().notNull(), total: numeric(12, 2, { mode: 'number' }).notNull() },\n * {\n * as: `SELECT created_at::date AS day, sum(amount) AS total FROM orders GROUP BY 1`,\n * constraints: (t) => ({ byDay: unique('daily_sales_day').on(t.day) }),\n * },\n * )\n * ```\n */\nexport function materializedView<TName extends string, C extends Record<string, ColumnBuilder>>(\n name: TName,\n columns: C,\n options: MaterializedViewOptions<C>,\n): ViewDecl<TName, C, undefined> & TypedColumnRefs<C> {\n return buildView(name, columns, options.as, true, options.constraints, undefined)\n}\n"],"mappings":";;;;;;;;;;2mBA4CA,SAAgB,UAAU,KAAuC,CAK/D,OAAO,YACL,IAAI,gBAAgB,CAClB,KAAM,KAAK,KACX,GAAI,KAAK,OAAS,CAAE,OAAQ,KAAK,MAAgB,EAAI,CAAC,CACxD,CAAC,EACD,UACF,CACF,CCiBA,MAAM,iBAAmB,sBAYzB,SAAgB,UAAU,KAA0C,CAClE,GAAI,KAAK,gBAAkB,OAAO,KAAK,KAAK,KAAQ,WAClD,MAAM,IAAI,YACR,4BACA,gFACF,EAEF,IAAM,QAAmB,WACnB,CAAE,MAAS,KACX,OAAS,KAAK,QAAU,SAC9B,GAAI,CAAC,iBAAiB,KAAK,MAAM,EAG/B,MAAU,MAAM,2BAA2B,QAAQ,EAGrD,IAAM,MAAQ,KAAK,iBAAA,kBACb,EAAI,WAAW,QAAS,KAAK,EAC7B,EAAI,WAAW,QAAS,cAAc,KAAK,CAAC,EAM5C,mBADoB,MAAM,SAAS,GAAG,EAAI,MAAM,MAAM,EAAG,MAAM,YAAY,GAAG,CAAC,EAAI,UAEjE,OAClB,CAAC,MAAO,cAAc,KAAK,EAAG,cAAc,KAAK,CAAC,CAAC,CAAC,IAAK,GACvD,EAAE,MAAM,EAAE,YAAY,GAAG,EAAI,CAAC,CAChC,EACA,CAAC,EACH,YACJ,MAAO,CACL,QAEA,MAAM,uBAAwB,CAC5B,MAAM,KAAK,MAAM,mBAAmB,QAAS,KAAK,CAAC,EACnD,MAAM,KAAK,MAAM,aAAa,QAAS,KAAK,CAAC,CAC/C,EAEA,MAAM,aAAuC,CAa3C,OAAO,MAZS,KAAK,MAQnB;gBACQ,EAAE;yCAEZ,EAAA,CACS,KAAK,IAAK,MAAS,CAC1B,GAAI,IAAI,GACR,KAAM,IAAI,KACV,KAAM,IAAI,KACV,MAAO,OAAO,IAAI,KAAK,EACvB,UACE,IAAI,sBAAsB,KAAO,IAAI,WAAW,YAAY,EAAI,OAAO,IAAI,UAAU,EACvF,UAAW,IAAI,SACjB,EAAE,CACJ,EAEA,MAAM,cAAc,IAAK,CACvB,MAAM,KAAK,MACT,eAAe,EAAE;sCAEjB,CAAC,IAAI,GAAI,IAAI,KAAM,IAAI,KAAM,IAAI,MAAO,IAAI,SAAS,CACvD,CACF,EAEA,MAAM,cAAc,GAAY,CAC9B,MAAM,KAAK,MAAM,eAAe,EAAE,gBAAiB,CAAC,EAAE,CAAC,CACzD,EAEA,MAAM,YAAY,MAAiC,CAOjD,OAAO,MANS,KAAK,MACnB,UAAU,EAAE;;6CAGZ,CAAC,KAAK,CACR,EAAA,CACS,WAAa,CACxB,EAEA,MAAM,aAAc,CAClB,MAAM,KAAK,MACT,UAAU,EAAE;;sBAGd,CACF,EAEA,MAAM,aAAa,IAAa,CAC9B,MAAM,KAAK,mBAAoB,IAAK,IAAI,CAC1C,EAEA,MAAM,mBAAmB,IAAa,YAA0C,CAC9E,IAAM,OAAS,MAAM,KAAK,QAAQ,EAClC,GAAI,CAGF,GAFA,MAAM,OAAO,MAAM,OAAO,EAC1B,MAAM,OAAO,MAAM,GAAG,EAClB,aAAe,WAAY,YAAa,CAC1C,IAAM,EAAI,YAAY,OACtB,MAAM,OAAO,MACX,eAAe,EAAE;0CAEjB,CAAC,EAAE,GAAI,EAAE,KAAM,EAAE,KAAM,EAAE,MAAO,EAAE,SAAS,CAC7C,CACF,MAAW,aACT,MAAM,OAAO,MAAM,eAAe,EAAE,gBAAiB,CAAC,YAAY,MAAM,CAAC,EAE3E,MAAM,OAAO,MAAM,QAAQ,CAC7B,OAAS,IAAK,CAIZ,MAHA,MAAM,OAAO,MAAM,UAAU,CAAC,CAAC,UAAY,CAE3C,CAAC,EACK,GACR,QAAU,CACR,OAAO,QAAQ,CACjB,CACF,EAEA,MAAM,aAAa,IAAa,CAC9B,MAAM,KAAK,MAAM,GAAG,CACtB,EAEA,MAAM,YAAsC,CAC1C,OAAO,aAAa,KAAM,CAAE,OAAQ,cAAe,iBAAkB,CAAC,CACxE,EAEA,gBAAiB,MAEjB,QAAS,CAGP,MAAQ,eAAgB,IAAI,OAAY,CAAE,QAAS,UAAU,CAAQ,IAAc,CAAC,CAAE,CAAC,CACzF,EAEA,MAAM,OAAQ,CAGR,KAAK,gBAAgB,MAAM,KAAK,KAAK,MAAM,CACjD,CACF,CACF,CCpNA,SAAgB,iBACd,KACA,QACA,QACoD,CACpD,OAAO,UAAU,KAAM,QAAS,QAAQ,GAAI,GAAM,QAAQ,YAAa,IAAA,EAAS,CAClF"}
|
|
1
|
+
{"version":3,"file":"pg.mjs","names":[],"sources":["../src/adapters/pg/dialect.ts","../src/adapters/pg/adapter.ts","../src/dsl/pg-views.ts"],"sourcesContent":["// pgDialect — thin factory over Kysely's PostgresDialect so adopters\n// never have to write `import { PostgresDialect } from 'kysely'`.\n// Kysely is a pinned internal dep of the framework; surfacing it\n// through our own export keeps the adopter import surface stable\n// even when we change query backends (or fork Kysely's internals).\n\nimport { PostgresDialect, type Dialect as KyselyDialect } from 'kysely'\nimport { markDialect } from '../../dialect-marker'\n\nimport type { PgPoolLike } from './adapter'\n\nexport interface PgDialectOptions {\n /**\n * pg-protocol-compatible pool. Both `pg.Pool` and\n * `@neondatabase/serverless`'s Pool match structurally; adopters\n * pick whichever runtime fits.\n */\n pool: PgPoolLike\n /**\n * `pg-cursor`'s `Cursor` class, for `.stream()`: rows arrive in chunks\n * instead of all at once. `import Cursor from 'pg-cursor'`.\n */\n cursor?: unknown\n}\n\n/**\n * Construct the dialect that `createDbClient({ dialect })` consumes.\n *\n * @example\n * ```ts\n * import { createDbClient } from '@forinda/kickjs-db'\n * import { pgDialect, pgAdapter } from '@forinda/kickjs-db/pg'\n * import { Pool } from 'pg'\n *\n * const pool = new Pool({ connectionString: process.env.DATABASE_URL })\n *\n * export const db = createDbClient({\n * schema,\n * dialect: pgDialect({ pool }),\n * })\n *\n * export const migrationAdapter = pgAdapter({ pool })\n * ```\n */\nexport function pgDialect(opts: PgDialectOptions): KyselyDialect {\n // PostgresDialect's `pool` parameter is typed as `PG.Pool` in newer\n // Kysely versions; casting through `unknown` keeps adopters using\n // alternate clients (neon, pg-cloudflare) compatible without\n // pulling node-postgres' typings into our public surface.\n return markDialect(\n new PostgresDialect({\n pool: opts.pool as unknown as never,\n ...(opts.cursor ? { cursor: opts.cursor as never } : {}),\n }),\n 'postgres',\n )\n}\n","import { Kysely } from 'kysely'\nimport { pgDialect } from './dialect'\nimport {\n introspectPg,\n KickDbError,\n lockTableDdl,\n lockTableName,\n pushTableName,\n quoteTable,\n KICK_MIGRATIONS_TABLE,\n migrationsTableDdl,\n type Dialect,\n type MigrationAdapter,\n type MigrationBookkeeping,\n type MigrationRow,\n type SchemaSnapshot,\n} from '../../index'\n\n/**\n * Minimal client returned by PgPoolLike.connect(). Matches the shape of\n * pg.PoolClient and @neondatabase/serverless's PoolClient.\n */\nexport interface PgClientLike {\n query<R = unknown>(\n sql: string,\n params?: readonly unknown[],\n ): Promise<{ rows: R[]; rowCount: number | null }>\n release(): void\n}\n\n/**\n * Pool-shaped contract that pgAdapter consumes. Both `pg.Pool` and\n * `@neondatabase/serverless`'s Pool match this structurally — no hard\n * dependency on the `pg` package. Adopters pick whichever pg-protocol-\n * compatible client fits their runtime (node-postgres / neon-serverless /\n * pg-cloudflare / etc).\n *\n * Edge runtimes with a different surface (Neon HTTP single-shot,\n * Cloudflare D1's batch-only model) have their own adapter packages that\n * implement MigrationAdapter directly — they don't reuse this shape.\n */\nexport interface PgPoolLike {\n query<R = unknown>(\n sql: string,\n params?: readonly unknown[],\n ): Promise<{ rows: R[]; rowCount: number | null }>\n connect(): Promise<PgClientLike>\n end?(): Promise<void>\n}\n\nexport interface PgAdapterOptions {\n /**\n * The table migrations are recorded in. Default `kick_migrations`; its lock\n * table is the same name plus `_lock`. On Postgres it may be schema-qualified\n * (`meta.kick_migrations`); the schema is created if missing.\n */\n migrationsTable?: string\n /**\n * A pg-protocol-compatible Pool. Concretely: pg.Pool, neon-serverless Pool,\n * any other Pool that satisfies the {@link PgPoolLike} structural shape.\n */\n pool: PgPoolLike\n /** PG schema name to scope the introspector and validate at construction. Default 'public'. */\n schema?: string\n /**\n * End the pool when the adapter closes. Set it when the adapter owns its\n * pool — a `kick.config.ts` `db.adapter()` factory that opens one for the\n * CLI — or the `kick db` command waits for idle clients to time out.\n * Default `false`: an app usually shares one pool with its client.\n */\n endPoolOnClose?: boolean\n}\n\nconst SAFE_SCHEMA_NAME = /^[a-z_][a-z0-9_]*$/i\n\n/**\n * MigrationAdapter implementation backed by node-postgres. The pool is\n * caller-owned — close() does NOT end() the pool because adopters typically\n * share a single pool across the migrationAdapter and the KickDbClient.\n *\n * Lock semantics: single-row UPDATE WHERE locked_at IS NULL on\n * kick_migrations_lock. Only the row created by ensureMigrationTables()\n * exists, so the UPDATE either flips locked_at and returns rowCount=1\n * (we won) or matches zero rows (someone else holds it).\n */\nexport function pgAdapter(opts: PgAdapterOptions): MigrationAdapter {\n if (opts.endPoolOnClose && typeof opts.pool.end !== 'function') {\n throw new KickDbError(\n 'KICK_DB_POOL_NOT_CLOSABLE',\n 'pgAdapter({ endPoolOnClose: true }) needs a pool with an end() method to close',\n )\n }\n const dialect: Dialect = 'postgres'\n const { pool } = opts\n const schema = opts.schema ?? 'public'\n if (!SAFE_SCHEMA_NAME.test(schema)) {\n // Schema name lands inside introspection queries unparameterised so guard\n // here rather than down at the SQL boundary.\n throw new Error(`Invalid PG schema name: ${schema}`)\n }\n\n const table = opts.migrationsTable ?? KICK_MIGRATIONS_TABLE\n const T = quoteTable(dialect, table)\n const L = quoteTable(dialect, lockTableName(table))\n // Introspection must not report the bookkeeping tables as schema.\n // Postgres reads a dotted name as schema.table. Introspection reads one\n // schema and matches bare names, so the tables are only left out when they\n // live in that schema — elsewhere, a same-named table here is the user's.\n const bookkeepingSchema = table.includes('.') ? table.slice(0, table.lastIndexOf('.')) : schema\n const bookkeepingTables =\n bookkeepingSchema === schema\n ? [table, lockTableName(table), pushTableName(table)].map((t) =>\n t.slice(t.lastIndexOf('.') + 1),\n )\n : []\n let migrationDb: Kysely<any> | undefined\n return {\n dialect,\n\n async ensureMigrationTables() {\n await pool.query(migrationsTableDdl(dialect, table))\n await pool.query(lockTableDdl(dialect, table))\n },\n\n async listApplied(): Promise<MigrationRow[]> {\n const r = await pool.query<{\n id: string\n name: string\n hash: string\n batch: number | string\n applied_at: string | Date\n direction: 'up' | 'down'\n }>(\n `SELECT id, name, hash, batch, applied_at, direction\n FROM ${T}\n ORDER BY applied_at ASC, id ASC`,\n )\n return r.rows.map((row) => ({\n id: row.id,\n name: row.name,\n hash: row.hash,\n batch: Number(row.batch),\n appliedAt:\n row.applied_at instanceof Date ? row.applied_at.toISOString() : String(row.applied_at),\n direction: row.direction,\n }))\n },\n\n async recordApplied(row) {\n await pool.query(\n `INSERT INTO ${T} (id, name, hash, batch, direction)\n VALUES ($1, $2, $3, $4, $5)`,\n [row.id, row.name, row.hash, row.batch, row.direction],\n )\n },\n\n async removeApplied(id: string) {\n await pool.query(`DELETE FROM ${T} WHERE id = $1`, [id])\n },\n\n async acquireLock(owner: string, staleAfterSeconds?: number): Promise<boolean> {\n const r =\n staleAfterSeconds === undefined\n ? await pool.query(\n `UPDATE ${L}\n SET locked_at = CURRENT_TIMESTAMP, locked_by = $1\n WHERE id = 1 AND locked_at IS NULL`,\n [owner],\n )\n : await pool.query(\n `UPDATE ${L}\n SET locked_at = CURRENT_TIMESTAMP, locked_by = $1\n WHERE id = 1 AND (locked_at IS NULL\n OR locked_at < CURRENT_TIMESTAMP - $2::int * INTERVAL '1 second')`,\n [owner, staleAfterSeconds],\n )\n return r.rowCount === 1\n },\n\n async refreshLock(owner: string) {\n const r = await pool.query(\n `UPDATE ${L} SET locked_at = CURRENT_TIMESTAMP WHERE id = 1 AND locked_by = $1`,\n [owner],\n )\n return r.rowCount === 1\n },\n\n async releaseLock(owner?: string) {\n await pool.query(\n `UPDATE ${L}\n SET locked_at = NULL, locked_by = NULL\n WHERE id = 1 AND ($1::text IS NULL OR locked_by = $1)`,\n [owner ?? null],\n )\n },\n\n async applySqlInTx(sql: string) {\n await this.applyMigrationInTx!(sql, null)\n },\n\n async applyMigrationInTx(sql: string, bookkeeping: MigrationBookkeeping | null) {\n const client = await pool.connect()\n try {\n await client.query('BEGIN')\n await client.query(sql)\n if (bookkeeping && 'record' in bookkeeping) {\n const r = bookkeeping.record\n await client.query(\n `INSERT INTO ${T} (id, name, hash, batch, direction)\n VALUES ($1, $2, $3, $4, $5)`,\n [r.id, r.name, r.hash, r.batch, r.direction],\n )\n } else if (bookkeeping) {\n await client.query(`DELETE FROM ${T} WHERE id = $1`, [bookkeeping.remove])\n }\n await client.query('COMMIT')\n } catch (err) {\n await client.query('ROLLBACK').catch(() => {\n /* swallow rollback errors; we're already throwing the original */\n })\n throw err\n } finally {\n client.release()\n }\n },\n\n async applySqlNoTx(sql: string) {\n await pool.query(sql)\n },\n\n async introspect(): Promise<SchemaSnapshot> {\n return introspectPg(pool, { schema, excludeTables: bookkeepingTables })\n },\n\n migrationsTable: table,\n\n kysely() {\n // Built once, on the same connection. Never destroyed here: the pool or\n // handle belongs to the caller (or to close()).\n return (migrationDb ??= new Kysely<any>({ dialect: pgDialect({ pool: pool as never }) }))\n },\n\n async close() {\n // The caller owns the pool unless it said otherwise — adopters\n // typically share it with the KickDbClient.\n if (opts.endPoolOnClose) await opts.pool.end?.()\n },\n }\n}\n","import type { ColumnBuilder, TypedColumnRefs } from './columns/types'\nimport { buildView, type MaterializedViewOptions, type ViewDecl } from './view'\n\n/**\n * A materialized view (Postgres): the `SELECT`'s result stored as a table,\n * read fast and brought up to date with `db.refreshMaterializedView(name)`.\n *\n * ```ts\n * export const dailySales = materializedView(\n * 'daily_sales',\n * { day: date().notNull(), total: numeric(12, 2, { mode: 'number' }).notNull() },\n * {\n * as: `SELECT created_at::date AS day, sum(amount) AS total FROM orders GROUP BY 1`,\n * constraints: (t) => ({ byDay: unique('daily_sales_day').on(t.day) }),\n * },\n * )\n * ```\n */\nexport function materializedView<TName extends string, C extends Record<string, ColumnBuilder>>(\n name: TName,\n columns: C,\n options: MaterializedViewOptions<C>,\n): ViewDecl<TName, C, undefined> & TypedColumnRefs<C> {\n return buildView(name, columns, options.as, true, options.constraints, undefined)\n}\n"],"mappings":";;;;;;;;;;0mBA4CA,SAAgB,UAAU,KAAuC,CAK/D,OAAO,YACL,IAAI,gBAAgB,CAClB,KAAM,KAAK,KACX,GAAI,KAAK,OAAS,CAAE,OAAQ,KAAK,MAAgB,EAAI,CAAC,CACxD,CAAC,EACD,UACF,CACF,CCiBA,MAAM,iBAAmB,sBAYzB,SAAgB,UAAU,KAA0C,CAClE,GAAI,KAAK,gBAAkB,OAAO,KAAK,KAAK,KAAQ,WAClD,MAAM,IAAI,YACR,4BACA,gFACF,EAEF,IAAM,QAAmB,WACnB,CAAE,MAAS,KACX,OAAS,KAAK,QAAU,SAC9B,GAAI,CAAC,iBAAiB,KAAK,MAAM,EAG/B,MAAU,MAAM,2BAA2B,QAAQ,EAGrD,IAAM,MAAQ,KAAK,iBAAA,kBACb,EAAI,WAAW,QAAS,KAAK,EAC7B,EAAI,WAAW,QAAS,cAAc,KAAK,CAAC,EAM5C,mBADoB,MAAM,SAAS,GAAG,EAAI,MAAM,MAAM,EAAG,MAAM,YAAY,GAAG,CAAC,EAAI,UAEjE,OAClB,CAAC,MAAO,cAAc,KAAK,EAAG,cAAc,KAAK,CAAC,CAAC,CAAC,IAAK,GACvD,EAAE,MAAM,EAAE,YAAY,GAAG,EAAI,CAAC,CAChC,EACA,CAAC,EACH,YACJ,MAAO,CACL,QAEA,MAAM,uBAAwB,CAC5B,MAAM,KAAK,MAAM,mBAAmB,QAAS,KAAK,CAAC,EACnD,MAAM,KAAK,MAAM,aAAa,QAAS,KAAK,CAAC,CAC/C,EAEA,MAAM,aAAuC,CAa3C,OAAO,MAZS,KAAK,MAQnB;gBACQ,EAAE;yCAEZ,EAAA,CACS,KAAK,IAAK,MAAS,CAC1B,GAAI,IAAI,GACR,KAAM,IAAI,KACV,KAAM,IAAI,KACV,MAAO,OAAO,IAAI,KAAK,EACvB,UACE,IAAI,sBAAsB,KAAO,IAAI,WAAW,YAAY,EAAI,OAAO,IAAI,UAAU,EACvF,UAAW,IAAI,SACjB,EAAE,CACJ,EAEA,MAAM,cAAc,IAAK,CACvB,MAAM,KAAK,MACT,eAAe,EAAE;sCAEjB,CAAC,IAAI,GAAI,IAAI,KAAM,IAAI,KAAM,IAAI,MAAO,IAAI,SAAS,CACvD,CACF,EAEA,MAAM,cAAc,GAAY,CAC9B,MAAM,KAAK,MAAM,eAAe,EAAE,gBAAiB,CAAC,EAAE,CAAC,CACzD,EAEA,MAAM,YAAY,MAAe,kBAA8C,CAgB7E,OAdE,oBAAsB,IAAA,GAClB,MAAM,KAAK,MACT,UAAU,EAAE;;mDAGZ,CAAC,KAAK,CACR,EACA,MAAM,KAAK,MACT,UAAU,EAAE;;;oFAIZ,CAAC,MAAO,iBAAiB,CAC3B,EAAA,CACG,WAAa,CACxB,EAEA,MAAM,YAAY,MAAe,CAK/B,OAAO,MAJS,KAAK,MACnB,UAAU,EAAE,oEACZ,CAAC,KAAK,CACR,EAAA,CACS,WAAa,CACxB,EAEA,MAAM,YAAY,MAAgB,CAChC,MAAM,KAAK,MACT,UAAU,EAAE;;gEAGZ,CAAC,OAAS,IAAI,CAChB,CACF,EAEA,MAAM,aAAa,IAAa,CAC9B,MAAM,KAAK,mBAAoB,IAAK,IAAI,CAC1C,EAEA,MAAM,mBAAmB,IAAa,YAA0C,CAC9E,IAAM,OAAS,MAAM,KAAK,QAAQ,EAClC,GAAI,CAGF,GAFA,MAAM,OAAO,MAAM,OAAO,EAC1B,MAAM,OAAO,MAAM,GAAG,EAClB,aAAe,WAAY,YAAa,CAC1C,IAAM,EAAI,YAAY,OACtB,MAAM,OAAO,MACX,eAAe,EAAE;0CAEjB,CAAC,EAAE,GAAI,EAAE,KAAM,EAAE,KAAM,EAAE,MAAO,EAAE,SAAS,CAC7C,CACF,MAAW,aACT,MAAM,OAAO,MAAM,eAAe,EAAE,gBAAiB,CAAC,YAAY,MAAM,CAAC,EAE3E,MAAM,OAAO,MAAM,QAAQ,CAC7B,OAAS,IAAK,CAIZ,MAHA,MAAM,OAAO,MAAM,UAAU,CAAC,CAAC,UAAY,CAE3C,CAAC,EACK,GACR,QAAU,CACR,OAAO,QAAQ,CACjB,CACF,EAEA,MAAM,aAAa,IAAa,CAC9B,MAAM,KAAK,MAAM,GAAG,CACtB,EAEA,MAAM,YAAsC,CAC1C,OAAO,aAAa,KAAM,CAAE,OAAQ,cAAe,iBAAkB,CAAC,CACxE,EAEA,gBAAiB,MAEjB,QAAS,CAGP,MAAQ,eAAgB,IAAI,OAAY,CAAE,QAAS,UAAU,CAAQ,IAAc,CAAC,CAAE,CAAC,CACzF,EAEA,MAAM,OAAQ,CAGR,KAAK,gBAAgB,MAAM,KAAK,KAAK,MAAM,CACjD,CACF,CACF,CCtOA,SAAgB,iBACd,KACA,QACA,QACoD,CACpD,OAAO,UAAU,KAAM,QAAS,QAAQ,GAAI,GAAM,QAAQ,YAAa,IAAA,EAAS,CAClF"}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
|
|
2
|
+
import { r as PgPoolLike } from "./adapter-Cyxerm3a.mjs";
|
|
3
|
+
//#region src/pglite.d.ts
|
|
4
|
+
/** PGlite's results have pg's shape — `rows`, `rowCount`, `command` — from 0.5.5. */
|
|
5
|
+
type PgResult = {
|
|
6
|
+
rows: any[];
|
|
7
|
+
rowCount?: number | null;
|
|
8
|
+
affectedRows?: number;
|
|
9
|
+
command?: string;
|
|
10
|
+
};
|
|
11
|
+
/** The part of a `PGlite` instance the pool uses. */
|
|
12
|
+
export interface PGliteLike {
|
|
13
|
+
query(sql: string, params?: any[]): Promise<PgResult>;
|
|
14
|
+
exec(sql: string): Promise<PgResult[]>;
|
|
15
|
+
close(): Promise<void>;
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* A pool over one PGlite database. PGlite is a single connection, so the pool
|
|
19
|
+
* hands it to one caller at a time: `connect()` waits until the previous
|
|
20
|
+
* client is released, and `pool.query()` waits too — otherwise a request's
|
|
21
|
+
* statements would run inside another request's open transaction. Share one
|
|
22
|
+
* pool between the client and the migration adapter:
|
|
23
|
+
*
|
|
24
|
+
* ```ts
|
|
25
|
+
* import { PGlite } from '@electric-sql/pglite'
|
|
26
|
+
* import { pgAdapter, pgDialect } from '@forinda/kickjs-db/pg'
|
|
27
|
+
* import { pglitePool } from '@forinda/kickjs-db/pglite'
|
|
28
|
+
*
|
|
29
|
+
* const pool = pglitePool(new PGlite('./data/pg'))
|
|
30
|
+
* export const db = createDbClient({ schema, dialect: pgDialect({ pool }) })
|
|
31
|
+
* export const migrationAdapter = pgAdapter({ pool })
|
|
32
|
+
* ```
|
|
33
|
+
*
|
|
34
|
+
* `end()` closes the database. `.stream()` isn't supported: it needs `pg-cursor`.
|
|
35
|
+
*/
|
|
36
|
+
export declare function pglitePool(db: PGliteLike): PgPoolLike;
|
|
37
|
+
//#endregion
|
|
38
|
+
export {};
|
|
39
|
+
//# sourceMappingURL=pglite.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"pglite.d.mts","names":[],"sources":["../src/pglite.ts"],"mappings":";;;;KAMK;EAAa;EAAa;EAA0B;EAAuB;;;iBAG/D;EACf,MAAM,aAAa,iBAAiB,QAAQ;EAC5C,KAAK,cAAc,QAAQ;EAC3B,SAAS;;;;;;;;;;;;;;;;;;;;;wBAsBK,WAAW,IAAI,aAAa"}
|
package/dist/pglite.mjs
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @forinda/kickjs-db v8.10.1
|
|
3
|
+
*
|
|
4
|
+
* Copyright (c) Felix Orinda
|
|
5
|
+
*
|
|
6
|
+
* This source code is licensed under the MIT license found in the
|
|
7
|
+
* LICENSE file in the root directory of this source tree.
|
|
8
|
+
*
|
|
9
|
+
* @license MIT
|
|
10
|
+
*/
|
|
11
|
+
function pglitePool(db){let tail=Promise.resolve(),turn=()=>{let release,mine=new Promise(resolve=>release=resolve),ready=tail;return tail=tail.then(()=>mine),ready.then(()=>release)};async function run(sql,params){let result=params&¶ms.length>0?await db.query(sql,[...params]):(await db.exec(sql)).at(-1)??{rows:[]};return{...result,rowCount:result.rowCount??null}}return{async query(sql,params){let release=await turn();try{return await run(sql,params)}finally{release()}},async connect(){let release=await turn(),released=!1;return{query:(sql,params)=>run(sql,params),release(){released||(released=!0,release())}}},async end(){await db.close()}}}export{pglitePool};
|
|
12
|
+
//# sourceMappingURL=pglite.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"pglite.mjs","names":[],"sources":["../src/pglite.ts"],"sourcesContent":["// `@forinda/kickjs-db/pglite` — PGlite (embedded Postgres) as a pg pool, for\n// `pgDialect()` and `pgAdapter()`. `@electric-sql/pglite` (0.5.5 or newer) is\n// an optional peer: pass your own instance.\nimport type { PgClientLike, PgPoolLike } from './adapters/pg/adapter'\n\n/** PGlite's results have pg's shape — `rows`, `rowCount`, `command` — from 0.5.5. */\ntype PgResult = { rows: any[]; rowCount?: number | null; affectedRows?: number; command?: string }\n\n/** The part of a `PGlite` instance the pool uses. */\nexport interface PGliteLike {\n query(sql: string, params?: any[]): Promise<PgResult>\n exec(sql: string): Promise<PgResult[]>\n close(): Promise<void>\n}\n\n/**\n * A pool over one PGlite database. PGlite is a single connection, so the pool\n * hands it to one caller at a time: `connect()` waits until the previous\n * client is released, and `pool.query()` waits too — otherwise a request's\n * statements would run inside another request's open transaction. Share one\n * pool between the client and the migration adapter:\n *\n * ```ts\n * import { PGlite } from '@electric-sql/pglite'\n * import { pgAdapter, pgDialect } from '@forinda/kickjs-db/pg'\n * import { pglitePool } from '@forinda/kickjs-db/pglite'\n *\n * const pool = pglitePool(new PGlite('./data/pg'))\n * export const db = createDbClient({ schema, dialect: pgDialect({ pool }) })\n * export const migrationAdapter = pgAdapter({ pool })\n * ```\n *\n * `end()` closes the database. `.stream()` isn't supported: it needs `pg-cursor`.\n */\nexport function pglitePool(db: PGliteLike): PgPoolLike {\n // ponytail: one holder at a time — PGlite serialises queries anyway.\n let tail: Promise<void> = Promise.resolve()\n const turn = () => {\n let release!: () => void\n const mine = new Promise<void>((resolve) => (release = resolve))\n const ready = tail\n tail = tail.then(() => mine)\n return ready.then(() => release)\n }\n\n // Without parameters SQL may hold several statements (a migration's up.sql),\n // which only exec() runs; the result is the last statement's.\n async function run(sql: string, params?: readonly unknown[]): Promise<PgResult> {\n const result =\n params && params.length > 0\n ? await db.query(sql, [...params])\n : ((await db.exec(sql)).at(-1) ?? { rows: [] })\n // A command tag without a count leaves rowCount out; pg reports null.\n return { ...result, rowCount: result.rowCount ?? null }\n }\n\n return {\n async query(sql, params) {\n const release = await turn()\n try {\n return (await run(sql, params)) as never\n } finally {\n release()\n }\n },\n async connect(): Promise<PgClientLike> {\n const release = await turn()\n let released = false\n return {\n query: (sql, params) => run(sql, params) as never,\n release() {\n if (released) return\n released = true\n release()\n },\n }\n },\n async end() {\n await db.close()\n },\n }\n}\n"],"mappings":";;;;;;;;;;AAkCA,SAAgB,WAAW,GAA4B,CAErD,IAAI,KAAsB,QAAQ,QAAQ,EACpC,SAAa,CACjB,IAAI,QACE,KAAO,IAAI,QAAe,SAAa,QAAU,OAAQ,EACzD,MAAQ,KAEd,MADA,MAAO,KAAK,SAAW,IAAI,EACpB,MAAM,SAAW,OAAO,CACjC,EAIA,eAAe,IAAI,IAAa,OAAgD,CAC9E,IAAM,OACJ,QAAU,OAAO,OAAS,EACtB,MAAM,GAAG,MAAM,IAAK,CAAC,GAAG,MAAM,CAAC,GAC7B,MAAM,GAAG,KAAK,GAAG,EAAA,CAAG,GAAG,EAAE,GAAK,CAAE,KAAM,CAAC,CAAE,EAEjD,MAAO,CAAE,GAAG,OAAQ,SAAU,OAAO,UAAY,IAAK,CACxD,CAEA,MAAO,CACL,MAAM,MAAM,IAAK,OAAQ,CACvB,IAAM,QAAU,MAAM,KAAK,EAC3B,GAAI,CACF,OAAQ,MAAM,IAAI,IAAK,MAAM,CAC/B,QAAU,CACR,QAAQ,CACV,CACF,EACA,MAAM,SAAiC,CACrC,IAAM,QAAU,MAAM,KAAK,EACvB,SAAW,GACf,MAAO,CACL,OAAQ,IAAK,SAAW,IAAI,IAAK,MAAM,EACvC,SAAU,CACJ,WACJ,SAAW,GACX,QAAQ,EACV,CACF,CACF,EACA,MAAM,KAAM,CACV,MAAM,GAAG,MAAM,CACjB,CACF,CACF"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
|
|
2
|
-
import { a as GeneratedAlwaysBrand, l as NotNullBrand, o as GeneratedBrand, t as ColumnBuilder } from "./types-
|
|
3
|
-
import { n as TableDecl } from "./table-
|
|
2
|
+
import { a as GeneratedAlwaysBrand, l as NotNullBrand, o as GeneratedBrand, t as ColumnBuilder } from "./types-BRgtaCZf.mjs";
|
|
3
|
+
import { n as TableDecl } from "./table-B2HY_SQD.mjs";
|
|
4
4
|
//#region src/schema.d.ts
|
|
5
5
|
type ColumnsOf<T> = T extends TableDecl<string, infer C, string | undefined> ? C : never;
|
|
6
6
|
type ValueOf<C> = C extends ColumnBuilder<infer V> ? V : never;
|
|
@@ -92,4 +92,4 @@ declare function updateSchema<T extends TableDecl, const O extends keyof Columns
|
|
|
92
92
|
}): TableSchema<Partial<Omit<InferInsert<T>, O>>>;
|
|
93
93
|
//#endregion
|
|
94
94
|
export { SchemaIssue as a, TableSchemaOptions as c, updateSchema as d, JsonSchemaOptions as i, insertSchema as l, InferInsert as n, SchemaLike as o, InferSelect as r, TableSchema as s, ColumnRule as t, selectSchema as u };
|
|
95
|
-
//# sourceMappingURL=schema-
|
|
95
|
+
//# sourceMappingURL=schema-BeQOkoyr.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"schema-
|
|
1
|
+
{"version":3,"file":"schema-BeQOkoyr.d.mts","names":[],"sources":["../src/schema.ts"],"mappings":";;;;KAyCK,UAAU,KAAK,UAAU,wBAAwB,yBAAyB;KAC1E,QAAQ,KAAK,UAAU,oBAAoB,KAAK;KAChD,UAAU,KAAK,UAAU;;KAGlB,YAAY,UAAU,gBAC/B,WAAW,UAAU,KAAK,UAAU,UAAU,GAAG,mBAC9C,QAAQ,UAAU,GAAG,MACrB,QAAQ,UAAU,GAAG;KAGtB,iBAAiB,QACnB,WAAW,UAAU,KAAK,UAAU,GAAG,WAAW,iBAC/C,IACA,UAAU,UAAU,GAAG,2BAErB,WACA,UAAU;;KAGb,gBAAgB,QAClB,WAAW,UAAU,KAAK,UAAU,GAAG,WAAW,uBAAuB,mBACpE,UAAU;;;;;KAMN,YAAY,UAAU,aAAa,KAC7C,KAAK,YAAY,IAAI,iBAAiB,MAAM,QAAQ,KAAK,YAAY,IAAI,iBAAiB,MAC1F,gBAAgB;;UAID;;EAEf;EACA;EACA;;EAEA;EACA;EACA;;;UAIe;EACf,UAAU;IAAkB;IAAe;;IAAoB;IAAgB;;EAC/E,aAAa,UAAU,oBAAoB;;UAG5B,mBAAmB,UAAU;EAC5C,aAAa,WAAW,UAAU,MAAM,aAAa;;EAErD,uBAAuB,UAAU;;UAGlB;WACN;;UAGM;EACf;EACA;EACA;;;UAIe,YAAY;EAC3B,UACE;IACG;IAAe,MAAM;;IAAc;IAAgB,QAAQ;;EAChE,aAAa,UAAU,oBAAoB;WAClC;aACE;aACA;aACA,WACP;MAEI,OAAO;MAAS;;MAChB,QAAQ;QAAgB;QAAiB;;;aACtC;eAAmB;eAAyB,QAAQ;;;;;iBAufjD,aAAa,UAAU,iBAAiB,gBAAgB,UAAU,YAChF,OAAO,GACP,UAAU,mBAAmB;EAAO,gBAAgB;IACnD,YAAY,KAAK,YAAY,IAAI;;iBAKpB,aAAa,UAAU,iBAAiB,gBAAgB,UAAU,YAChF,OAAO,GACP,UAAU,mBAAmB;EAAO,gBAAgB;IACnD,YAAY,KAAK,YAAY,IAAI;;iBAKpB,aAAa,UAAU,iBAAiB,gBAAgB,UAAU,YAChF,OAAO,GACP,UAAU,mBAAmB;EAAO,gBAAgB;IACnD,YAAY,QAAQ,KAAK,YAAY,IAAI"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
|
|
2
|
-
import { a as GeneratedAlwaysBrand, l as NotNullBrand, o as GeneratedBrand, t as ColumnBuilder } from "./types-
|
|
3
|
-
import { n as TableDecl } from "./table-
|
|
2
|
+
import { a as GeneratedAlwaysBrand, l as NotNullBrand, o as GeneratedBrand, t as ColumnBuilder } from "./types-BRgtaCZf.mjs";
|
|
3
|
+
import { n as TableDecl } from "./table-B2HY_SQD.mjs";
|
|
4
4
|
import { Generated, GeneratedAlways } from "kysely";
|
|
5
5
|
//#region src/client/schema-types.d.ts
|
|
6
6
|
/**
|
|
@@ -48,4 +48,4 @@ type TableOf<V> = V extends {
|
|
|
48
48
|
type SchemaToTypes<S> = { [K in keyof S as [TableOf<S[K]>] extends [never] ? never : TableKey<TableOf<S[K]>>]: TableOf<S[K]> extends TableDecl<string, infer C, string | undefined> ? { [Col in keyof C]: ColumnTSType<C[Col]>; } : never; };
|
|
49
49
|
//#endregion
|
|
50
50
|
export { SchemaToTypes as t };
|
|
51
|
-
//# sourceMappingURL=schema-types-
|
|
51
|
+
//# sourceMappingURL=schema-types-DxKLouYj.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"schema-types-
|
|
1
|
+
{"version":3,"file":"schema-types-DxKLouYj.d.mts","names":[],"sources":["../src/client/schema-types.ts"],"mappings":";;;;;;;;;;;;;;;;;;;;;KAyBK,WAAW,KAAK,UAAU;KAE1B,aAAa,KAChB,UAAU,oBAAoB,KAC1B,UAAU,uBACR,gBAAgB,WAAW,kBAAkB,WAAW,KACxD,WAAW,kBACT,UAAU,iBACR,UAAU,YACV,WACF,UAAU,iBACR,UAAU,KACV;;;;;;;;;;;;KAcP,SAAS,KAAK;EAAY,cAAc;IAKzC,QAAQ;EAAY,iBAAiB;IAAM,kCAAiC,WACzE,0BACC,IACA,2BACK,UAAU,MACb;;KAKL,QAAQ,KAAK;EAAY;IAC1B,IAIA,4BAA4B;EACxB,aAAa;IAAY;;IAE3B;KAGM,cAAc,QACvB,WAAW,MAAM,QAAQ,EAAE,+BAA+B,SAAS,QAAQ,EAAE,OAAO,QACnF,EAAE,YACM,wBAAwB,4BAC3B,aAAa,IAAI,aAAa,EAAE"}
|
package/dist/schema.d.mts
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
|
|
2
|
-
import { a as SchemaIssue, c as TableSchemaOptions, d as updateSchema, i as JsonSchemaOptions, l as insertSchema, n as InferInsert, o as SchemaLike, r as InferSelect, s as TableSchema, t as ColumnRule, u as selectSchema } from "./schema-
|
|
2
|
+
import { a as SchemaIssue, c as TableSchemaOptions, d as updateSchema, i as JsonSchemaOptions, l as insertSchema, n as InferInsert, o as SchemaLike, r as InferSelect, s as TableSchema, t as ColumnRule, u as selectSchema } from "./schema-BeQOkoyr.mjs";
|
|
3
3
|
export { ColumnRule, InferInsert, InferSelect, JsonSchemaOptions, SchemaIssue, SchemaLike, TableSchema, TableSchemaOptions, insertSchema, selectSchema, updateSchema };
|
package/dist/schema.mjs
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* @forinda/kickjs-db v8.
|
|
2
|
+
* @forinda/kickjs-db v8.10.1
|
|
3
3
|
*
|
|
4
4
|
* Copyright (c) Felix Orinda
|
|
5
5
|
*
|
|
@@ -8,5 +8,5 @@
|
|
|
8
8
|
*
|
|
9
9
|
* @license MIT
|
|
10
10
|
*/
|
|
11
|
-
import{t as CustomColumnBuilder}from"./custom-type-BSqxHyIa.mjs";import{n as PgEnumColumnBuilder,t as PgCodecColumnBuilder}from"./pg-DqVxnk3O.mjs";const ok=value=>({ok:!0,value}),fail=(message,code=`invalid_type`)=>({ok:!1,message,code}),INTEGER=/^-?\d+$/,DECIMAL=/^-?\d+(\.\d+)?$/,UUID=/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i,EMAIL=/^[^\s@]+@[^\s@]+\.[^\s@]+$/;function integerSpec(minimum,maximum){return{json:{type:`integer`,minimum,maximum},parse:v=>typeof v!=`number`||!Number.isInteger(v)?fail(`Expected an integer`):v<minimum||v>maximum?fail(`Must be between ${minimum} and ${maximum}`,v<minimum?`too_small`:`too_big`):ok(v)}}const INT16=32767,INT32=2147483647,INT64=2n**63n;function stringSpec(json={},check){return{json:{type:`string`,...json},parse:v=>{if(typeof v!=`string`)return fail(`Expected a string`);let problem=check?.(v);return problem?fail(problem,`invalid_string`):ok(v)}}}function dateSpec(format){return{json:{type:`string`,format},parse:v=>{let date=v instanceof Date?v:typeof v==`string`?new Date(v):void 0;return date&&!Number.isNaN(date.getTime())?ok(date):fail(`Expected a ${format===`date`?`date`:`date-time`} string`)}}}function specFor(builder){if(builder instanceof PgEnumColumnBuilder){let values=builder.values;return{json:{type:`string`,enum:[...values]},parse:v=>typeof v==`string`&&values.includes(v)?ok(v):fail(`Expected one of ${values.join(`, `)}`,`invalid_enum_value`)}}if(builder instanceof CustomColumnBuilder&&!(builder instanceof PgCodecColumnBuilder))return anySpec();let raw=builder.__state().type,type=/^enum\s*\(/i.test(raw)?`enum${raw.slice(raw.indexOf(`(`))}`:raw.toLowerCase(),spec=type.endsWith(`[]`)?arraySpec(specForType(type.slice(0,-2))):specForType(type),mode=builder.__state().mode;return mode?withMode(spec,mode):spec}function withMode(spec,mode){let convert={bigint:BigInt,number:Number,string:String}[mode];return{...spec,parse:v=>{let r=spec.parse(v);return!r.ok||r.value==null?r:mode===`number`&&typeof r.value==`bigint`&&(r.value<BigInt(-(2**53-1))||r.value>BigInt(2**53-1))?fail(`Out of the safe range for a number`,r.value<0n?`too_small`:`too_big`):mode===`number`&&typeof r.value==`string`&&(r.value.replace(/^[+-]/,``).replace(`.`,``).replace(/^0+/,``).replace(/0+$/,``).length>15||!Number.isFinite(Number(r.value)))?fail(`Too many digits for a number — use mode: 'string'`,`too_big`):ok(convert(r.value))}}}function anySpec(){return{json:{},parse:ok}}function decimalSpec(type){let[precision,scale=0]=(/\(([^)]*)\)/.exec(type)?.[1]??``).split(`,`).filter(part=>part.trim()!==``).map(Number);if(precision===void 0||scale<0||scale>precision)return{json:{type:`string`,pattern:DECIMAL.source},parse:v=>{let str=typeof v==`number`&&Number.isFinite(v)?String(v):v;return typeof str==`string`&&DECIMAL.test(str)?ok(str):fail(`Expected a decimal number or string`)}};let whole=precision-scale,wholePattern=whole>0?`\\d{1,${whole}}`:`0`,pattern=RegExp(`^-?${wholePattern}${scale>0?`(\\.\\d{1,${scale}})?`:``}$`);return{json:{type:`string`,pattern:pattern.source},parse:v=>{let str=typeof v==`number`&&Number.isFinite(v)?String(v):v;return typeof str!=`string`||!DECIMAL.test(str)?fail(`Expected a decimal number or string`):pattern.test(str)?ok(str):(str.split(`.`)[1]??``).length>scale?fail(`At most ${scale} digit(s) after the decimal point`,`invalid_format`):fail(`At most ${whole} digit(s) before the decimal point`,`too_big`)}}}function arraySpec(item,length){return{json:{type:`array`,items:item.json,...length===void 0?{}:{minItems:length,maxItems:length}},parse:v=>{if(!Array.isArray(v))return fail(`Expected an array`);if(length!==void 0&&v.length!==length)return fail(`Expected ${length} items`,`invalid_length`);let out=[];for(let[i,element]of v.entries()){let parsed=item.parse(element);if(!parsed.ok)return fail(`[${i}]: ${parsed.message}`,parsed.code);out.push(parsed.value)}return ok(out)}}}const MYSQL_INTEGERS={tinyint:[-128,127],"tinyint unsigned":[0,255],"smallint unsigned":[0,65535],mediumint:[-8388608,8388607],"mediumint unsigned":[0,16777215],"int unsigned":[0,4294967295]};function specForType(type){let base=type.replace(/\(.*$/,``).trim(),size=Number(/\((\d+)/.exec(type)?.[1]),mysqlRange=MYSQL_INTEGERS[base];if(mysqlRange)return integerSpec(...mysqlRange);switch(base){case`smallserial`:return integerSpec(1,INT16);case`serial`:return integerSpec(1,INT32);case`smallint`:return integerSpec(-32768,INT16);case`integer`:case`int`:return integerSpec(-2147483648,INT32);case`bigserial`:case`bigint`:case`bigint unsigned`:return{json:{type:`string`,pattern:INTEGER.source},parse:v=>{if(!(typeof v==`number`&&Number.isInteger(v))&&!(typeof v==`string`&&INTEGER.test(v)))return fail(`Expected an integer or a string of digits`);let n=BigInt(v),[min,max]=base===`bigint unsigned`?[0n,2n*INT64]:[-INT64,INT64];return n<min||n>=max?fail(`Out of range for a 64-bit integer`,n<min?`too_small`:`too_big`):ok(n)}};case`real`:case`double precision`:return{json:{type:`number`},parse:v=>typeof v==`number`&&Number.isFinite(v)?ok(v):fail(`Expected a number`)};case`decimal`:case`numeric`:case`money`:return decimalSpec(type);case`varchar`:case`character varying`:case`char`:case`character`:return Number.isFinite(size)?stringSpec({maxLength:size},v=>v.length>size?`Must be at most ${size} characters`:null):stringSpec();case`boolean`:return{json:{type:`boolean`},parse:v=>typeof v==`boolean`?ok(v):fail(`Expected a boolean`)};case`timestamp`:case`timestamptz`:case`datetime`:return dateSpec(`date-time`);case`date`:return dateSpec(`date`);case`uuid`:return stringSpec({format:`uuid`},v=>UUID.test(v)?null:`Expected a UUID`);case`enum`:{let values=[...type.matchAll(/'((?:[^']|'')*)'/g)].map(m=>m[1].replace(/''/g,`'`));return{json:{type:`string`,enum:values},parse:v=>typeof v==`string`&&values.includes(v)?ok(v):fail(`Expected one of ${values.join(`, `)}`,`invalid_enum_value`)}}case`point`:return{json:{type:`object`,properties:{x:{type:`number`},y:{type:`number`}},required:[`x`,`y`]},parse:v=>typeof v==`object`&&v&&typeof v.x==`number`&&typeof v.y==`number`?ok(v):fail(`Expected a point { x, y }`)};case`vector`:case`halfvec`:return arraySpec({json:{type:`number`},parse:v=>typeof v==`number`?ok(v):fail(`Expected a number`)},Number.isFinite(size)?size:void 0);case`json`:case`jsonb`:return anySpec();default:return stringSpec()}}function isSchemaLike(value){return typeof value==`object`&&!!value&&typeof value.safeParse==`function`&&typeof value.toJsonSchema==`function`}function withRule(spec,rule){if(!rule)return spec;if(isSchemaLike(rule))return{json:rule.toJsonSchema(),jsonFor:options=>rule.toJsonSchema(options),parse:v=>{let result=rule.safeParse(v);if(result.success)return ok(result.data);let first=result.issues[0];return fail(first?.message??`Invalid value`,`custom`)}};let pattern=rule.pattern===void 0?void 0:RegExp(`^(?:${rule.pattern})$`);return{json:{...spec.json,...rule},parse:v=>{let parsed=spec.parse(v);if(!parsed.ok)return parsed;let value=parsed.value;if(typeof value==`string`){if(rule.minLength!==void 0&&value.length<rule.minLength)return fail(`Must be at least ${rule.minLength} characters`,`too_small`);if(rule.maxLength!==void 0&&value.length>rule.maxLength)return fail(`Must be at most ${rule.maxLength} characters`,`too_big`);if(pattern&&!pattern.test(value))return fail(`Invalid format`,`invalid_string`);let formatProblem=checkFormat(rule.format,value);if(formatProblem)return fail(formatProblem,`invalid_string`)}if(typeof value==`number`){if(rule.minimum!==void 0&&value<rule.minimum)return fail(`Must be at least ${rule.minimum}`,`too_small`);if(rule.maximum!==void 0&&value>rule.maximum)return fail(`Must be at most ${rule.maximum}`,`too_big`)}return parsed}}}function checkFormat(format,value){switch(format){case`email`:return EMAIL.test(value)?null:`Expected an email address`;case`uuid`:return UUID.test(value)?null:`Expected a UUID`;case`uri`:case`url`:return URL.canParse(value)?null:`Expected a URL`;case`date-time`:return Number.isNaN(Date.parse(value))?`Expected a date-time string`:null;default:return null}}function optionalOnInsert(builder){let state=builder.__state();return state.nullable||state.default!==null||state.tenancy!==void 0||state.defaultFn!==void 0||state.identity===`byDefault`||/^(small|big)?serial$/.test(state.type)}function computed(builder){let state=builder.__state();return state.generated!==void 0||state.identity===`always`}function buildSchema(table,mode,options={}){let omitted=new Set(options.omit??[]),columns=Object.entries(table.__columns).filter(([name,builder])=>!omitted.has(name)&&(mode===`select`||!computed(builder))).map(([name,builder])=>({name,nullable:builder.__state().nullable,required:mode===`select`||mode===`insert`&&!optionalOnInsert(builder),spec:withRule(specFor(builder),options.columns?.[name]??table.__rules?.[name])})),safeParse=data=>{if(typeof data!=`object`||!data||Array.isArray(data))return{success:!1,issues:[{path:[],message:`Expected an object`,code:`invalid_type`}]};let input=data,out={},issues=[];for(let column of columns){let value=input[column.name];if(value===void 0){column.required&&issues.push({path:[column.name],message:`Required`,code:`invalid_type`});continue}if(value===null){column.nullable?out[column.name]=null:issues.push({path:[column.name],message:`Cannot be null`,code:`invalid_type`});continue}let parsed=column.spec.parse(value);parsed.ok?out[column.name]=parsed.value:issues.push({path:[column.name],message:parsed.message,code:parsed.code})}return issues.length>0?{success:!1,issues}:{success:!0,data:out}};return{safeParse,toJsonSchema:(jsonOptions={})=>{let openapi=jsonOptions.target===`openapi-3.0`,properties={};for(let column of columns){let json=column.spec.jsonFor?.(jsonOptions)??column.spec.json;properties[column.name]=column.nullable?openapi?{...json,nullable:!0}:{anyOf:[json,{type:`null`}]}:json}let required=columns.filter(c=>c.required).map(c=>c.name);return{type:`object`,properties,...required.length>0?{required}:{},additionalProperties:!1}},"~standard":{version:1,vendor:`kickjs-db`,validate:value=>{let result=safeParse(value);return result.success?{value:result.data}:{issues:result.issues}}}}}function selectSchema(table,options){return buildSchema(table,`select`,options)}function insertSchema(table,options){return buildSchema(table,`insert`,options)}function updateSchema(table,options){return buildSchema(table,`update`,options)}export{insertSchema,selectSchema,updateSchema};
|
|
11
|
+
import{t as CustomColumnBuilder}from"./custom-type-Bu5nn7V1.mjs";import{n as PgEnumColumnBuilder,t as PgCodecColumnBuilder}from"./pg-RiTdI_BK.mjs";const ok=value=>({ok:!0,value}),fail=(message,code=`invalid_type`)=>({ok:!1,message,code}),INTEGER=/^-?\d+$/,DECIMAL=/^-?\d+(\.\d+)?$/,UUID=/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i,EMAIL=/^[^\s@]+@[^\s@]+\.[^\s@]+$/;function integerSpec(minimum,maximum){return{json:{type:`integer`,minimum,maximum},parse:v=>typeof v!=`number`||!Number.isInteger(v)?fail(`Expected an integer`):v<minimum||v>maximum?fail(`Must be between ${minimum} and ${maximum}`,v<minimum?`too_small`:`too_big`):ok(v)}}const INT16=32767,INT32=2147483647,INT64=2n**63n;function stringSpec(json={},check){return{json:{type:`string`,...json},parse:v=>{if(typeof v!=`string`)return fail(`Expected a string`);let problem=check?.(v);return problem?fail(problem,`invalid_string`):ok(v)}}}function dateSpec(format){return{json:{type:`string`,format},parse:v=>{let date=v instanceof Date?v:typeof v==`string`?new Date(v):void 0;return date&&!Number.isNaN(date.getTime())?ok(date):fail(`Expected a ${format===`date`?`date`:`date-time`} string`)}}}function specFor(builder){if(builder instanceof PgEnumColumnBuilder){let values=builder.values;return{json:{type:`string`,enum:[...values]},parse:v=>typeof v==`string`&&values.includes(v)?ok(v):fail(`Expected one of ${values.join(`, `)}`,`invalid_enum_value`)}}if(builder instanceof CustomColumnBuilder&&!(builder instanceof PgCodecColumnBuilder))return anySpec();let raw=builder.__state().type,type=/^enum\s*\(/i.test(raw)?`enum${raw.slice(raw.indexOf(`(`))}`:raw.toLowerCase(),spec=type.endsWith(`[]`)?arraySpec(specForType(type.slice(0,-2))):specForType(type),mode=builder.__state().mode;return mode?withMode(spec,mode):spec}function withMode(spec,mode){let convert={bigint:BigInt,number:Number,string:String}[mode];return{...spec,parse:v=>{let r=spec.parse(v);return!r.ok||r.value==null?r:mode===`number`&&typeof r.value==`bigint`&&(r.value<BigInt(-(2**53-1))||r.value>BigInt(2**53-1))?fail(`Out of the safe range for a number`,r.value<0n?`too_small`:`too_big`):mode===`number`&&typeof r.value==`string`&&(r.value.replace(/^[+-]/,``).replace(`.`,``).replace(/^0+/,``).replace(/0+$/,``).length>15||!Number.isFinite(Number(r.value)))?fail(`Too many digits for a number — use mode: 'string'`,`too_big`):ok(convert(r.value))}}}function anySpec(){return{json:{},parse:ok}}function decimalSpec(type){let[precision,scale=0]=(/\(([^)]*)\)/.exec(type)?.[1]??``).split(`,`).filter(part=>part.trim()!==``).map(Number);if(precision===void 0||scale<0||scale>precision)return{json:{type:`string`,pattern:DECIMAL.source},parse:v=>{let str=typeof v==`number`&&Number.isFinite(v)?String(v):v;return typeof str==`string`&&DECIMAL.test(str)?ok(str):fail(`Expected a decimal number or string`)}};let whole=precision-scale,wholePattern=whole>0?`\\d{1,${whole}}`:`0`,pattern=RegExp(`^-?${wholePattern}${scale>0?`(\\.\\d{1,${scale}})?`:``}$`);return{json:{type:`string`,pattern:pattern.source},parse:v=>{let str=typeof v==`number`&&Number.isFinite(v)?String(v):v;return typeof str!=`string`||!DECIMAL.test(str)?fail(`Expected a decimal number or string`):pattern.test(str)?ok(str):(str.split(`.`)[1]??``).length>scale?fail(`At most ${scale} digit(s) after the decimal point`,`invalid_format`):fail(`At most ${whole} digit(s) before the decimal point`,`too_big`)}}}function arraySpec(item,length){return{json:{type:`array`,items:item.json,...length===void 0?{}:{minItems:length,maxItems:length}},parse:v=>{if(!Array.isArray(v))return fail(`Expected an array`);if(length!==void 0&&v.length!==length)return fail(`Expected ${length} items`,`invalid_length`);let out=[];for(let[i,element]of v.entries()){let parsed=item.parse(element);if(!parsed.ok)return fail(`[${i}]: ${parsed.message}`,parsed.code);out.push(parsed.value)}return ok(out)}}}const MYSQL_INTEGERS={tinyint:[-128,127],"tinyint unsigned":[0,255],"smallint unsigned":[0,65535],mediumint:[-8388608,8388607],"mediumint unsigned":[0,16777215],"int unsigned":[0,4294967295]};function specForType(type){let base=type.replace(/\(.*$/,``).trim(),size=Number(/\((\d+)/.exec(type)?.[1]),mysqlRange=MYSQL_INTEGERS[base];if(mysqlRange)return integerSpec(...mysqlRange);switch(base){case`smallserial`:return integerSpec(1,INT16);case`serial`:return integerSpec(1,INT32);case`smallint`:return integerSpec(-32768,INT16);case`integer`:case`int`:return integerSpec(-2147483648,INT32);case`bigserial`:case`bigint`:case`bigint unsigned`:return{json:{type:`string`,pattern:INTEGER.source},parse:v=>{if(!(typeof v==`number`&&Number.isInteger(v))&&!(typeof v==`string`&&INTEGER.test(v)))return fail(`Expected an integer or a string of digits`);let n=BigInt(v),[min,max]=base===`bigint unsigned`?[0n,2n*INT64]:[-INT64,INT64];return n<min||n>=max?fail(`Out of range for a 64-bit integer`,n<min?`too_small`:`too_big`):ok(n)}};case`real`:case`double precision`:return{json:{type:`number`},parse:v=>typeof v==`number`&&Number.isFinite(v)?ok(v):fail(`Expected a number`)};case`decimal`:case`numeric`:case`money`:return decimalSpec(type);case`varchar`:case`character varying`:case`char`:case`character`:return Number.isFinite(size)?stringSpec({maxLength:size},v=>v.length>size?`Must be at most ${size} characters`:null):stringSpec();case`boolean`:return{json:{type:`boolean`},parse:v=>typeof v==`boolean`?ok(v):fail(`Expected a boolean`)};case`timestamp`:case`timestamptz`:case`datetime`:return dateSpec(`date-time`);case`date`:return dateSpec(`date`);case`uuid`:return stringSpec({format:`uuid`},v=>UUID.test(v)?null:`Expected a UUID`);case`enum`:{let values=[...type.matchAll(/'((?:[^']|'')*)'/g)].map(m=>m[1].replace(/''/g,`'`));return{json:{type:`string`,enum:values},parse:v=>typeof v==`string`&&values.includes(v)?ok(v):fail(`Expected one of ${values.join(`, `)}`,`invalid_enum_value`)}}case`point`:return{json:{type:`object`,properties:{x:{type:`number`},y:{type:`number`}},required:[`x`,`y`]},parse:v=>typeof v==`object`&&v&&typeof v.x==`number`&&typeof v.y==`number`?ok(v):fail(`Expected a point { x, y }`)};case`vector`:case`halfvec`:return arraySpec({json:{type:`number`},parse:v=>typeof v==`number`?ok(v):fail(`Expected a number`)},Number.isFinite(size)?size:void 0);case`json`:case`jsonb`:return anySpec();default:return stringSpec()}}function isSchemaLike(value){return typeof value==`object`&&!!value&&typeof value.safeParse==`function`&&typeof value.toJsonSchema==`function`}function withRule(spec,rule){if(!rule)return spec;if(isSchemaLike(rule))return{json:rule.toJsonSchema(),jsonFor:options=>rule.toJsonSchema(options),parse:v=>{let result=rule.safeParse(v);if(result.success)return ok(result.data);let first=result.issues[0];return fail(first?.message??`Invalid value`,`custom`)}};let pattern=rule.pattern===void 0?void 0:RegExp(`^(?:${rule.pattern})$`);return{json:{...spec.json,...rule},parse:v=>{let parsed=spec.parse(v);if(!parsed.ok)return parsed;let value=parsed.value;if(typeof value==`string`){if(rule.minLength!==void 0&&value.length<rule.minLength)return fail(`Must be at least ${rule.minLength} characters`,`too_small`);if(rule.maxLength!==void 0&&value.length>rule.maxLength)return fail(`Must be at most ${rule.maxLength} characters`,`too_big`);if(pattern&&!pattern.test(value))return fail(`Invalid format`,`invalid_string`);let formatProblem=checkFormat(rule.format,value);if(formatProblem)return fail(formatProblem,`invalid_string`)}if(typeof value==`number`){if(rule.minimum!==void 0&&value<rule.minimum)return fail(`Must be at least ${rule.minimum}`,`too_small`);if(rule.maximum!==void 0&&value>rule.maximum)return fail(`Must be at most ${rule.maximum}`,`too_big`)}return parsed}}}function checkFormat(format,value){switch(format){case`email`:return EMAIL.test(value)?null:`Expected an email address`;case`uuid`:return UUID.test(value)?null:`Expected a UUID`;case`uri`:case`url`:return URL.canParse(value)?null:`Expected a URL`;case`date-time`:return Number.isNaN(Date.parse(value))?`Expected a date-time string`:null;default:return null}}function optionalOnInsert(builder){let state=builder.__state();return state.nullable||state.default!==null||state.tenancy!==void 0||state.defaultFn!==void 0||state.identity===`byDefault`||/^(small|big)?serial$/.test(state.type)}function computed(builder){let state=builder.__state();return state.generated!==void 0||state.identity===`always`}function buildSchema(table,mode,options={}){let omitted=new Set(options.omit??[]),columns=Object.entries(table.__columns).filter(([name,builder])=>!omitted.has(name)&&(mode===`select`||!computed(builder))).map(([name,builder])=>({name,nullable:builder.__state().nullable,required:mode===`select`||mode===`insert`&&!optionalOnInsert(builder),spec:withRule(specFor(builder),options.columns?.[name]??table.__rules?.[name])})),safeParse=data=>{if(typeof data!=`object`||!data||Array.isArray(data))return{success:!1,issues:[{path:[],message:`Expected an object`,code:`invalid_type`}]};let input=data,out={},issues=[];for(let column of columns){let value=input[column.name];if(value===void 0){column.required&&issues.push({path:[column.name],message:`Required`,code:`invalid_type`});continue}if(value===null){column.nullable?out[column.name]=null:issues.push({path:[column.name],message:`Cannot be null`,code:`invalid_type`});continue}let parsed=column.spec.parse(value);parsed.ok?out[column.name]=parsed.value:issues.push({path:[column.name],message:parsed.message,code:parsed.code})}return issues.length>0?{success:!1,issues}:{success:!0,data:out}};return{safeParse,toJsonSchema:(jsonOptions={})=>{let openapi=jsonOptions.target===`openapi-3.0`,properties={};for(let column of columns){let json=column.spec.jsonFor?.(jsonOptions)??column.spec.json;properties[column.name]=column.nullable?openapi?{...json,nullable:!0}:{anyOf:[json,{type:`null`}]}:json}let required=columns.filter(c=>c.required).map(c=>c.name);return{type:`object`,properties,...required.length>0?{required}:{},additionalProperties:!1}},"~standard":{version:1,vendor:`kickjs-db`,validate:value=>{let result=safeParse(value);return result.success?{value:result.data}:{issues:result.issues}}}}}function selectSchema(table,options){return buildSchema(table,`select`,options)}function insertSchema(table,options){return buildSchema(table,`insert`,options)}function updateSchema(table,options){return buildSchema(table,`update`,options)}export{insertSchema,selectSchema,updateSchema};
|
|
12
12
|
//# sourceMappingURL=schema.mjs.map
|