@forinda/kickjs-db 8.12.0 → 8.12.2
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-o2we9YIw.d.mts → adapter-cVrkWrul.d.mts} +2 -2
- package/dist/{adapter-o2we9YIw.d.mts.map → adapter-cVrkWrul.d.mts.map} +1 -1
- package/dist/cli.d.mts +1 -1
- package/dist/cli.mjs +2 -2
- package/dist/{create-CWQcQNgu.mjs → create-9XyIsHPz.mjs} +4 -4
- package/dist/{create-CWQcQNgu.mjs.map → create-9XyIsHPz.mjs.map} +1 -1
- package/dist/{custom-type-ZuO--c_x.mjs → custom-type-DTr9-SUD.mjs} +2 -2
- package/dist/{custom-type-ZuO--c_x.mjs.map → custom-type-DTr9-SUD.mjs.map} +1 -1
- package/dist/devtools-events.mjs +1 -1
- package/dist/{index-BACCTsy5.d.mts → index-Nf43jLx4.d.mts} +15 -4
- package/dist/index-Nf43jLx4.d.mts.map +1 -0
- package/dist/index.d.mts +1 -1
- package/dist/index.mjs +2 -2
- package/dist/mysql.d.mts +1 -1
- package/dist/mysql.mjs +3 -3
- package/dist/mysql.mjs.map +1 -1
- package/dist/{pg-DV5SG4cf.mjs → pg-C3LLh6SM.mjs} +3 -3
- package/dist/{pg-DV5SG4cf.mjs.map → pg-C3LLh6SM.mjs.map} +1 -1
- package/dist/pg.d.mts +2 -2
- package/dist/pg.mjs +3 -3
- package/dist/pg.mjs.map +1 -1
- package/dist/pglite.d.mts +1 -1
- package/dist/pglite.mjs +1 -1
- package/dist/schema.mjs +2 -2
- package/dist/{split-statements-lMBXme3t.mjs → split-statements-ByQRGN3X.mjs} +2 -2
- package/dist/{split-statements-lMBXme3t.mjs.map → split-statements-ByQRGN3X.mjs.map} +1 -1
- package/dist/sqlite.d.mts +1 -1
- package/dist/sqlite.d.mts.map +1 -1
- package/dist/sqlite.mjs +4 -4
- package/dist/sqlite.mjs.map +1 -1
- package/dist/{src-LEmnUV3S.mjs → src-BE1SzVq7.mjs} +4 -4
- package/dist/src-BE1SzVq7.mjs.map +1 -0
- package/dist/testing.mjs +2 -2
- package/package.json +7 -7
- package/dist/index-BACCTsy5.d.mts.map +0 -1
- package/dist/src-LEmnUV3S.mjs.map +0 -1
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
|
|
2
|
-
import { ea as MigrationAdapter } from "./index-
|
|
2
|
+
import { ea as MigrationAdapter } from "./index-Nf43jLx4.mjs";
|
|
3
3
|
//#region src/adapters/pg/adapter.d.ts
|
|
4
4
|
/**
|
|
5
5
|
* Minimal client returned by PgPoolLike.connect(). Matches the shape of
|
|
@@ -66,4 +66,4 @@ interface PgAdapterOptions {
|
|
|
66
66
|
declare function pgAdapter(opts: PgAdapterOptions): MigrationAdapter;
|
|
67
67
|
//#endregion
|
|
68
68
|
export { pgAdapter as i, PgClientLike as n, PgPoolLike as r, PgAdapterOptions as t };
|
|
69
|
-
//# sourceMappingURL=adapter-
|
|
69
|
+
//# sourceMappingURL=adapter-cVrkWrul.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"adapter-
|
|
1
|
+
{"version":3,"file":"adapter-cVrkWrul.d.mts","names":[],"sources":["../src/adapters/pg/adapter.ts"],"mappings":";;;;;;;UAsBiB;EACf,MAAM,aACJ,aACA,8BACC;IAAU,MAAM;IAAK;;EACxB;;;;;;;;;;;;;UAce;EACf,MAAM,aACJ,aACA,8BACC;IAAU,MAAM;IAAK;;EACxB,WAAW,QAAQ;EACnB,QAAQ;;UAGO;;;;;;EAMf;;;;;EAKA,MAAM;;EAEN;;;;;;;EAOA;;;;;;;;;;;;iBAec,UAAU,MAAM,mBAAmB"}
|
package/dist/cli.d.mts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
|
|
2
2
|
import { _ as Dialect } from "./types-DB_xyeQT.mjs";
|
|
3
|
-
import { Ji as TenantsConfig, Ki as DbConfig, Xi as DriftBehavior, Zi as DriftIgnore, qi as MigrationAdapterFactory } from "./index-
|
|
3
|
+
import { Ji as TenantsConfig, Ki as DbConfig, Xi as DriftBehavior, Zi as DriftIgnore, qi as MigrationAdapterFactory } from "./index-Nf43jLx4.mjs";
|
|
4
4
|
import { CliTypegen, KickCliPlugin } from "@forinda/kickjs-cli-kit";
|
|
5
5
|
import { Command } from "commander";
|
|
6
6
|
//#region src/cli-typegen.d.ts
|
package/dist/cli.mjs
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* @forinda/kickjs-db v8.12.
|
|
2
|
+
* @forinda/kickjs-db v8.12.2
|
|
3
3
|
*
|
|
4
4
|
* Copyright (c) Felix Orinda
|
|
5
5
|
*
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
*
|
|
9
9
|
* @license MIT
|
|
10
10
|
*/
|
|
11
|
-
import{$ as removeCasing,T as loadModule,d as migrateLatest,f as migrateRollback,m as migrateUp,p as migrateStatus,u as migrateDown}from"./create-
|
|
11
|
+
import{$ as removeCasing,T as loadModule,d as migrateLatest,f as migrateRollback,m as migrateUp,p as migrateStatus,u as migrateDown}from"./create-9XyIsHPz.mjs";import{Ct as migrateTenants,St as reviewMigration,Vt as detectCompositeReferences,Wt as renderSchemaSource,_t as runSeeds,bt as pushSchema,vt as checkMigrations,xt as generate}from"./src-BE1SzVq7.mjs";import{writeFile}from"node:fs/promises";import{existsSync}from"node:fs";import path from"node:path";import{defineCliPlugin}from"@forinda/kickjs-cli-kit";import{createInterface}from"node:readline/promises";const DEFAULT_SCHEMA_PATHS=[`src/db/schema.ts`,`src/db/schema/index.ts`,`src/db/schema`],kickDbTypegen=()=>({id:`kick/db`,inputs:[`src/db/schema.ts`,`src/db/schema/**/*.ts`],async generate(ctx){let schemaAbs=resolveSchema(ctx.cwd,ctx.config?.db?.schemaPath);if(!schemaAbs)return null;let typesDir=path.resolve(ctx.cwd,`.kickjs/types`);return[`import type { SchemaToTypes, SchemaToRelationsRegister, KickDbClient } from '@forinda/kickjs-db'`,`import type * as appSchema from '${posix(path.relative(typesDir,schemaAbs)).replace(/\.ts$/,``).replace(/\/index$/,``)}'`,``,`declare global {`,` interface KickDbSchema extends SchemaToTypes<typeof appSchema> {}`,`}`,``,`declare module '@forinda/kickjs-db' {`,` interface KickDbRegister {`,` db: KickDbClient<KickDbSchema>`,` }`,``,` interface KickDbRelationsRegister {`,` db: SchemaToRelationsRegister<typeof appSchema>`,` }`,`}`].join(`
|
|
12
12
|
`)}});function resolveSchema(cwd,configuredPath){if(configuredPath){let abs=path.resolve(cwd,configuredPath);if(existsSync(abs))return abs;let idx=path.join(abs,`index.ts`);if(existsSync(idx))return idx}for(let candidate of DEFAULT_SCHEMA_PATHS){let abs=path.resolve(cwd,candidate);if(candidate.endsWith(`.ts`)){if(existsSync(abs))return abs}else{let idx=path.join(abs,`index.ts`);if(existsSync(idx))return idx}}return null}function posix(p){return p.replace(/\\/g,`/`)}function parseRenameFlags(tables=[],columns=[]){let pairs=(values,flag)=>values.map(v=>{let eq=v.indexOf(`=`);if(eq<=0||eq===v.length-1)throw Error(`kickjs-db: ${flag} expects old=new, got '${v}'`);return[v.slice(0,eq),v.slice(eq+1)]});for(let[from]of pairs(columns,`--rename-column`))if(!from.includes(`.`))throw Error(`kickjs-db: --rename-column expects table.old=new, got '${from}'`);return{tables:Object.fromEntries(pairs(tables,`--rename-table`)),columns:Object.fromEntries(pairs(columns,`--rename-column`))}}async function askRenamesInTerminal(candidates,io={input:process.stdin,output:process.stdout}){let rl=createInterface({input:io.input,output:io.output}),hints={tables:{},columns:{}};try{let ask=async(what,options)=>{let free=options.filter(o=>!Object.values(hints.tables).includes(o)&&!Object.values(hints.columns).includes(o));if(free.length===0)return;let list=free.map((o,i)=>` ${i+1}) renamed to ${o}`).join(`
|
|
13
13
|
`);for(;;){let answer=(await rl.question(`${what} is gone. Was it renamed?\n 0) no, drop it\n${list}\n> `)).trim(),n=answer===``?0:Number(answer);if(Number.isInteger(n)&&n>=0&&n<=free.length)return n===0?void 0:free[n-1]}};for(let c of candidates.tables){let to=await ask(`Table ${c.from}`,c.to);to&&(hints.tables[c.from]=to)}for(let c of candidates.columns){let to=await ask(`Column ${c.table}.${c.from}`,c.to);to&&(hints.columns[`${c.table}.${c.from}`]=to)}}finally{rl.close()}return hints}async function confirmInTerminal(question,io={input:process.stdin,output:process.stdout}){let rl=createInterface({input:io.input,output:io.output});try{return/^y(es)?$/i.test((await rl.question(`${question} [y/N] `)).trim())}finally{rl.close()}}function remoteHost(connectionString){let match=/^[a-z][\w+.-]*:\/\/(?:[^@/?#]*@)?([^/?#]*)[^?#]*(?:\?([^#]*))?/i.exec(connectionString??``);if(match)return(new URLSearchParams(match[2]??``).get(`host`)??decodeURIComponent(match[1]??``)).split(`,`).map(h=>stripPort(h.trim()).toLowerCase()).filter(h=>h&&!h.startsWith(`/`)).find(host=>!isLocal(host))}function stripPort(entry){return entry.startsWith(`[`)?entry.slice(1,entry.indexOf(`]`)):entry.replace(/:\d+$/,``)}function isLocal(host){return host===`localhost`||host===`::1`||host===`0.0.0.0`||host.startsWith(`127.`)||host.endsWith(`.localhost`)||host.endsWith(`.local`)||!host.includes(`.`)}function runDirs(config){return config.migrationsDirs?.length?[config.migrationsDir,...config.migrationsDirs]:config.migrationsDir}function folderOf(config,id){return[config.migrationsDir,...config.migrationsDirs??[]].find(d=>existsSync(path.join(d,id)))??config.migrationsDir}function defineKickDbConfig(cfg){return cfg}function mergeKickDbConfig(...configs){return Object.assign({},...configs.filter(Boolean))}function resolveKickDbConfig(block){let db=block??{};return{schemaPath:db.schemaPath??`src/db/schema.ts`,migrationsDir:db.migrationsDir??`db/migrations`,seedsDir:db.seedsDir??`db/seeds`,dialect:db.dialect??`postgres`,connectionString:db.connectionString??process.env.DATABASE_URL,adapter:db.adapter,driftCheck:db.driftCheck,driftIgnore:db.driftIgnore,casing:db.casing,migrationsTable:db.migrationsTable,migrationsDirs:db.migrationsDirs,tenants:db.tenants}}async function resolveAdapter(config){if(config.adapter){let adapter=await config.adapter();return{adapter,cleanup:async()=>adapter.close()}}if(!config.connectionString)throw Error(`kickjs-db: no adapter resolved — set db.connectionString (or DATABASE_URL), or supply a db.adapter() factory`);let dialect=config.dialect??`postgres`;if(dialect!==`postgres`)throw Error(`kickjs-db: the built-in CLI adapter only supports postgres (dialect=${dialect}); supply a db.adapter() factory for other dialects`);let[{pgAdapter},pg]=await Promise.all([import(`./pg.mjs`),import(`pg`)]),pool=new pg.default.Pool({connectionString:config.connectionString}),adapter=pgAdapter({pool,migrationsTable:config.migrationsTable});return{adapter,cleanup:async()=>{await adapter.close(),await pool.end()}}}async function tryResolvePgQueryRunner(config){if(config.adapter||(config.dialect??`postgres`)!==`postgres`||!config.connectionString)return null;let pool=new(await(import(`pg`))).default.Pool({connectionString:config.connectionString});return{runner:pool,cleanup:async()=>void await pool.end()}}function printStatusTable(status){status.length===0?console.log(`No migrations.`):console.table(status.map(s=>({id:s.id,state:s.state,batch:s.batch??`-`,reviewed:s.reviewed,applied:s.appliedAt??`-`})))}function registerDbCommands(parent,getConfig){parent.command(`generate <name>`).description(`Generate a new migration from schema diff`).option(`-e, --empty`,`Skip schema diff and create an empty migration shell (data migration, seed, freeform SQL)`).option(`--rename-table <old=new>`,`Treat a dropped table as renamed (repeatable)`,(v,all=[])=>[...all,v]).option(`--rename-column <table.old=new>`,`Treat a dropped column as renamed (repeatable)`,(v,all=[])=>[...all,v]).option(`--no-interactive`,`Don't ask which drops are renames, even in a terminal`).option(`--ts`,`Write the migration in TypeScript — a migration.ts with up(db) / down(db) — for data changes that need code`).action(async(name,opts)=>{let cwd=process.cwd(),config=await getConfig(),probe=await tryResolvePgQueryRunner(config),detectCompositeRefs=probe?enumName=>detectCompositeReferences(probe.runner,enumName):void 0;try{let renames=parseRenameFlags(opts.renameTable,opts.renameColumn),askRenames=opts.interactive!==!1&&process.stdin.isTTY?askRenamesInTerminal:void 0,result=await generate({name,config,cwd,empty:opts.empty,typescript:opts.ts,detectCompositeRefs,renames,askRenames,onPossibleRename:askRenames?void 0:drop=>console.warn(`Warning: ${drop.what} will be dropped. If it was renamed, generate again with ${drop.flag} — the data goes with a drop.`),onCallShapedDefault:d=>console.warn(`Warning: ${d.table}.${d.column} has .default('${d.value}'), which is the text ${d.value}, not a call — for SQL the database evaluates, use .defaultSql('${d.value}').`)});if(result.status===`no-changes`){console.log(`No schema changes detected.`);return}if(result.empty){console.log(opts.ts?`Created migration ${result.migrationDir} (write up() and down() in migration.ts).`:`Created empty migration ${result.migrationDir} (author up.sql + down.sql).`);return}let plural=result.changeCount===1?``:`s`;console.log(`Created migration ${result.migrationDir} (${result.changeCount} change${plural}).`)}finally{await probe?.cleanup()}}),parent.command(`check`).description(`Fail if the schema has changes no migration covers, or a migration is unreviewed or edited (no database needed — for CI)`).action(async()=>{let config=await getConfig(),r=await checkMigrations({config,cwd:process.cwd()});if(r.unmigratedChanges>0){let plural=r.unmigratedChanges===1?``:`s`;console.error(`The schema has ${r.unmigratedChanges} change${plural} no migration covers — run \`kick db generate <name>\`.`)}for(let id of r.unreviewed)console.error(`${id} is not reviewed — read it, then \`kick db migrate review ${id}\`.`);for(let id of r.modified)console.error(`${id} was edited after it was reviewed — review it again, or revert the edit.`);r.ok?console.log(`Migrations are in step with the schema.`):process.exitCode=1}),parent.command(`push`).description(`Make the database match the schema with no migration file — for prototyping; refused on a database with migrations applied`).option(`--rename-table <old=new>`,`Treat a dropped table as renamed (repeatable)`,(v,all=[])=>[...all,v]).option(`--rename-column <table.old=new>`,`Treat a dropped column as renamed (repeatable)`,(v,all=[])=>[...all,v]).option(`--no-interactive`,`Don't ask about renames or data loss, even in a terminal`).option(`--accept-data-loss`,`Apply changes that drop tables, columns or enum values`).option(`-y, --yes`,`Push to a remote database without asking`).action(async opts=>{let config=await getConfig(),interactive=opts.interactive!==!1&&process.stdin.isTTY,remote=remoteHost(config.connectionString);if(remote&&!opts.yes&&!(interactive&&await confirmInTerminal(`Push changes the database at ${remote} without a migration file. Continue?`)))throw Error(`kickjs-db: refusing to push to ${remote} — push is for a local prototyping database. Pass --yes if this is one.`);let schema=await loadModule(path.resolve(process.cwd(),config.schemaPath),{fresh:!0}),{adapter,cleanup}=await resolveAdapter(config);try{let r=await pushSchema({adapter,schema,casing:config.casing,renames:parseRenameFlags(opts.renameTable,opts.renameColumn),askRenames:interactive?askRenamesInTerminal:void 0,confirmDataLoss:opts.acceptDataLoss?async()=>!0:interactive?losses=>confirmInTerminal(`This loses data:\n${losses.map(l=>` - ${l}`).join(`
|
|
14
14
|
`)}\nApply it?`):void 0}),plural=r.changeCount===1?``:`s`;console.log(r.status===`no-changes`?`The database already matches the schema.`:`Pushed ${r.changeCount} change${plural}.`)}finally{await cleanup()}}),parent.command(`seed [names...]`).description(`Run the seed files in db/seeds (or only those named), in name order — no migration tracking, so make them safe to re-run`).action(async names=>{let config=await getConfig(),dir=path.resolve(process.cwd(),config.seedsDir??`db/seeds`);try{let{ran}=await runSeeds({dir,names});console.log(ran.length===0?`No seeds in ${dir}.`:`Ran ${ran.length} seed(s): ${ran.join(`, `)}`)}catch(err){console.error(err instanceof Error?err.message:String(err)),process.exitCode=1}process.stderr.write(``,()=>process.stdout.write(``,()=>process.exit(process.exitCode??0)))});let migrate=parent.command(`migrate`).description(`Migration runner subcommands`);migrate.command(`latest`).description(`Apply all pending migrations in a new batch`).option(`--confirm-enum-drop`,"Allow migrations carrying the `-- KICK ENUM REMOVE` header to apply",!1).option(`--tenants`,`Migrate every tenant's schema or database (db.tenants in kick.config)`).action(async opts=>{let config=await getConfig();if(opts.tenants){if(!config.tenants)throw Error("kick db migrate latest --tenants needs a `tenants: { list, adapter }` db config");let r=await migrateTenants({tenants:config.tenants.list,adapterFor:config.tenants.adapter,concurrency:config.tenants.concurrency,migrationsDir:runDirs(config),driftCheck:config.driftCheck,driftIgnore:config.driftIgnore,confirmEnumDrop:opts.confirmEnumDrop,onTenant:t=>console.log(t.error?`✗ ${t.tenant}: ${t.error instanceof Error?t.error.message:String(t.error)}`:`✓ ${t.tenant}: ${t.summary.applied.length===0?`up to date`:t.summary.applied.join(`, `)}`)});console.log(`${r.results.length-r.failed.length} migrated, ${r.failed.length} failed`),r.failed.length>0&&(process.exitCode=1);return}let{adapter,cleanup}=await resolveAdapter(config);try{let r=await migrateLatest({adapter,migrationsDir:runDirs(config),driftCheck:config.driftCheck,driftIgnore:config.driftIgnore,confirmEnumDrop:opts.confirmEnumDrop});console.log(r.applied.length===0?`No pending migrations.`:`Applied batch ${r.batch}: ${r.applied.join(`, `)}`)}finally{await cleanup()}}),migrate.command(`up`).description(`Apply the next single pending migration, or every one up to --to`).option(`--to <migration>`,`Apply pending migrations up to and including this one (id or name)`).option(`--confirm-enum-drop`,"Allow migrations carrying the `-- KICK ENUM REMOVE` header to apply",!1).action(async opts=>{let config=await getConfig(),{adapter,cleanup}=await resolveAdapter(config);try{let r=await migrateUp({adapter,migrationsDir:runDirs(config),driftCheck:config.driftCheck,driftIgnore:config.driftIgnore,confirmEnumDrop:opts.confirmEnumDrop,to:opts.to});console.log(r.applied.length===0?`No pending migrations.`:`Applied ${r.applied.join(`, `)} (batch ${r.batch})`)}finally{await cleanup()}}),migrate.command(`down`).description(`Reverse the most recent applied migration, or every one after --to`).option(`--to <migration>`,`Reverse every migration applied after this one (id or name), which stays`).action(async opts=>{let config=await getConfig(),{adapter,cleanup}=await resolveAdapter(config);try{let r=await migrateDown({adapter,migrationsDir:runDirs(config),driftCheck:config.driftCheck,driftIgnore:config.driftIgnore,to:opts.to});console.log(r.reversedAll.length>0?`Reversed ${r.reversedAll.join(`, `)}.`:`Nothing to reverse.`)}finally{await cleanup()}}),migrate.command(`rollback`).description(`Reverse the entire last batch as a single unit, or with --all every migration`).option(`--all`,`Reverse every applied migration, newest first`).action(async opts=>{let config=await getConfig(),{adapter,cleanup}=await resolveAdapter(config);try{let r=await migrateRollback({adapter,migrationsDir:runDirs(config),driftCheck:config.driftCheck,driftIgnore:config.driftIgnore,all:opts.all});console.log(r.reversed.length===0?`Nothing to roll back.`:opts.all?`Rolled back every migration: ${r.reversed.join(`, `)}`:`Rolled back batch ${r.batch}: ${r.reversed.join(`, `)}`)}finally{await cleanup()}}),migrate.command(`status`).description(`Print applied + pending migrations`).action(async()=>{let config=await getConfig(),{adapter,cleanup}=await resolveAdapter(config);try{printStatusTable(await migrateStatus({adapter,migrationsDir:runDirs(config)}))}finally{await cleanup()}}),migrate.command(`unlock`).description(`Release the migration lock left by a run that was killed mid-migration (make sure none is running)`).action(async()=>{let{adapter,cleanup}=await resolveAdapter(await getConfig());try{await adapter.releaseLock(),console.log(`Released the migration lock.`)}finally{await cleanup()}}),migrate.command(`review <id>`).description(`Mark a migration reviewed (flips meta.json; migrates legacy -- REVIEWED markers)`).action(async id=>{let config=await getConfig(),r=await reviewMigration(folderOf(config,id),id);console.log(r.alreadyReviewed?`${r.id} was already reviewed — recorded its current contents as reviewed.`:`Reviewed ${r.id} — it can now be applied.`)}),parent.command(`introspect`).description(`Generate a TypeScript schema file from a live database`).option(`--out <path>`,`Output file (defaults to db.schemaPath from config)`).option(`--json`,`Print the raw SchemaSnapshot JSON to stdout instead of writing TS source`).action(async opts=>{let config=await getConfig(),{adapter,cleanup}=await resolveAdapter(config);try{let snapshot=await adapter.introspect();if(opts.json){console.log(JSON.stringify(snapshot,null,2));return}let out=opts.out??config.schemaPath,source=config.casing===`snake_case`?removeCasing(snapshot):snapshot;await writeFile(out,renderSchemaSource(source),`utf8`);let n=Object.keys(snapshot.tables).length;console.log(`Wrote ${out} (${n} table${n===1?``:`s`}).`)}finally{await cleanup()}})}function dbBlockOf(config){return config?.db}const dbCliPlugin=defineCliPlugin({name:`kick/db`,register(program,ctx){registerDbCommands(program.command(`db`).description(`Database commands (kickjs-db)`),()=>resolveKickDbConfig(dbBlockOf(ctx.config)))},typegens:[kickDbTypegen()]});export{dbCliPlugin,defineKickDbConfig,kickDbTypegen,mergeKickDbConfig,registerDbCommands,resolveKickDbConfig};
|