@izumisy/kyrage 0.1.0 → 0.2.0
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/chunk-3W2EVB2R.js +1 -0
- package/dist/index.d.ts +72 -0
- package/dist/index.js +1 -0
- package/dist/main.js +4 -4
- package/package.json +15 -6
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import{loadConfig as c}from"c12";import{z as o}from"zod";var n=o.object({tableName:o.string(),columns:o.record(o.string(),o.object({type:o.string(),primaryKey:o.boolean().optional().default(!1),notNull:o.boolean().optional().default(!1),unique:o.boolean().optional().default(!1)}))}),a=o.record(o.string(),o.object({table:o.string(),columns:o.array(o.string()),unique:o.boolean().optional()})),i=o.enum(["postgres","cockroachdb","mysql","sqlite"]),r=o.object({dialect:i,connectionString:o.string()}),t=o.object({database:r,tables:o.array(n),indexes:o.array(a).optional()}),s=o.object({id:o.string(),version:o.string(),diff:o.any()});var d=async()=>{let e=await c({name:"kyrage"});return t.parse(e.config)},u=e=>e;export{s as a,d as b,u as c};
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
import { ColumnDataType } from 'kysely';
|
|
2
|
+
import { z } from 'zod';
|
|
3
|
+
|
|
4
|
+
type ColumnOptions = {
|
|
5
|
+
primaryKey?: boolean;
|
|
6
|
+
unique?: boolean;
|
|
7
|
+
nullable?: boolean;
|
|
8
|
+
default?: unknown;
|
|
9
|
+
};
|
|
10
|
+
type ColumnDefinition = {
|
|
11
|
+
type: ColumnDataType;
|
|
12
|
+
notNull: boolean;
|
|
13
|
+
primaryKey: boolean;
|
|
14
|
+
unique: boolean;
|
|
15
|
+
default?: unknown;
|
|
16
|
+
};
|
|
17
|
+
declare const column: (type: ColumnDataType, options?: ColumnOptions) => ColumnDefinition;
|
|
18
|
+
declare const defineTable: <T extends Record<string, ColumnDefinition>>(name: string, columns: T) => {
|
|
19
|
+
tableName: string;
|
|
20
|
+
columns: T;
|
|
21
|
+
};
|
|
22
|
+
type DefinedTable = ReturnType<typeof defineTable>;
|
|
23
|
+
|
|
24
|
+
declare const configSchema: z.ZodObject<{
|
|
25
|
+
database: z.ZodObject<{
|
|
26
|
+
dialect: z.ZodEnum<{
|
|
27
|
+
postgres: "postgres";
|
|
28
|
+
cockroachdb: "cockroachdb";
|
|
29
|
+
mysql: "mysql";
|
|
30
|
+
sqlite: "sqlite";
|
|
31
|
+
}>;
|
|
32
|
+
connectionString: z.ZodString;
|
|
33
|
+
}, z.core.$strip>;
|
|
34
|
+
tables: z.ZodArray<z.ZodObject<{
|
|
35
|
+
tableName: z.ZodString;
|
|
36
|
+
columns: z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
37
|
+
type: z.ZodString;
|
|
38
|
+
primaryKey: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
39
|
+
notNull: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
40
|
+
unique: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
41
|
+
}, z.core.$strip>>;
|
|
42
|
+
}, z.core.$strip>>;
|
|
43
|
+
indexes: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
44
|
+
table: z.ZodString;
|
|
45
|
+
columns: z.ZodArray<z.ZodString>;
|
|
46
|
+
unique: z.ZodOptional<z.ZodBoolean>;
|
|
47
|
+
}, z.core.$strip>>>>;
|
|
48
|
+
}, z.core.$strip>;
|
|
49
|
+
type ConfigValue = z.infer<typeof configSchema>;
|
|
50
|
+
|
|
51
|
+
declare const defineConfig: (config: ConfigValue) => {
|
|
52
|
+
database: {
|
|
53
|
+
dialect: "postgres" | "cockroachdb" | "mysql" | "sqlite";
|
|
54
|
+
connectionString: string;
|
|
55
|
+
};
|
|
56
|
+
tables: {
|
|
57
|
+
tableName: string;
|
|
58
|
+
columns: Record<string, {
|
|
59
|
+
type: string;
|
|
60
|
+
primaryKey: boolean;
|
|
61
|
+
notNull: boolean;
|
|
62
|
+
unique: boolean;
|
|
63
|
+
}>;
|
|
64
|
+
}[];
|
|
65
|
+
indexes?: Record<string, {
|
|
66
|
+
table: string;
|
|
67
|
+
columns: string[];
|
|
68
|
+
unique?: boolean | undefined;
|
|
69
|
+
}>[] | undefined;
|
|
70
|
+
};
|
|
71
|
+
|
|
72
|
+
export { type ColumnDefinition, type DefinedTable, column, defineConfig, defineTable };
|
package/dist/index.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import{c as o}from"./chunk-3W2EVB2R.js";var l=(n,e={})=>({type:n,notNull:!e.nullable,primaryKey:!!e.primaryKey,unique:!!e.unique,default:e.default}),t=(n,e)=>({tableName:n,columns:e});export{l as column,o as defineConfig,t as defineTable};
|
package/dist/main.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import{Migrator as
|
|
2
|
-
`)),await e.destroy();return}}let
|
|
3
|
-
`))}),
|
|
4
|
-
`))})})},
|
|
1
|
+
import{a as $,b as h}from"./chunk-3W2EVB2R.js";import{Migrator as Q}from"kysely";function E(t){let{current:a,ideal:e}=t,n=a.map(r=>r.name),o=e.map(r=>r.name),i=e.filter(r=>!n.includes(r.name)).map(r=>({table:r.name,columns:r.columns})),l=a.filter(r=>!o.includes(r.name)).map(r=>r.name),f=a.reduce((r,d)=>{let m=e.find(s=>s.name===d.name);if(!m)return r;let g=d.columns,p=m.columns,y=Object.keys(g),T=Object.keys(p),D=T.filter(s=>!y.includes(s)).map(s=>({column:s,attributes:p[s]})),M=y.filter(s=>!T.includes(s)).map(s=>({column:s,attributes:g[s]})),k=y.filter(s=>T.includes(s)&&(g[s].type!==p[s].type||g[s].notNull!==p[s].notNull)).map(s=>({column:s,before:g[s],after:p[s]}));return(D.length>0||M.length>0||k.length>0)&&r.push({table:d.name,addedColumns:D,removedColumns:M,changedColumns:k}),r},[]);return{addedTables:i,removedTables:l,changedTables:f}}import{isColumnDataType as K}from"kysely";import{readdir as S,readFile as R}from"fs/promises";import{join as q}from"path";var u="migrations",C=async()=>{try{let a=(await S(u)).filter(e=>e.endsWith(".json")).map(async e=>$.parse(JSON.parse(await R(q(u,e),"utf-8"))));return await Promise.all(a)}catch(t){if(t instanceof Object&&"code"in t&&t.code==="ENOENT")return[];throw t}},A=t=>({getMigrations:async()=>{let a=await C(),e={};return a.forEach(n=>{e[n.id]={up:async()=>{await F(t.db,n.diff)}}}),e}});async function F(t,a){for(let e of a.addedTables){let n=t.schema.createTable(e.table);for(let[o,i]of Object.entries(e.columns)){let l=i.type;w(l),n=n.addColumn(o,l,f=>{let r=f;return i.notNull&&(r=r.notNull()),i.primaryKey&&(r=r.primaryKey()),i.unique&&(r=r.unique()),r})}await n.execute()}for(let e of a.removedTables)await t.schema.dropTable(e).execute();for(let e of a.changedTables){for(let n of e.addedColumns){let o=n.attributes.type;w(o),await t.schema.alterTable(e.table).addColumn(n.column,o,i=>{let l=i;return n.attributes.notNull&&(l=l.notNull()),n.attributes.primaryKey&&(l=l.primaryKey()),n.attributes.unique&&(l=l.unique()),l}).execute()}for(let n of e.removedColumns)await t.schema.alterTable(e.table).dropColumn(n.column).execute();for(let n of e.changedColumns){if(n.before.type!==n.after.type){let o=n.after.type;w(o),await t.schema.alterTable(e.table).alterColumn(n.column,i=>i.setDataType(o)).execute()}n.after.notNull!==n.before.notNull&&(n.after.notNull?await t.schema.alterTable(e.table).alterColumn(n.column,o=>o.setNotNull()).execute():await t.schema.alterTable(e.table).alterColumn(n.column,o=>o.dropNotNull()).execute())}}}var w=t=>{if(!K(t))throw new Error(`Unsupported data type: ${t}`)};import{defineCommand as x,runMain as X}from"citty";import{Kysely as I,MysqlDialect as L,PostgresDialect as U,SqliteDialect as V}from"kysely";import{Pool as O}from"pg";import{createPool as z}from"mysql2";import G from"better-sqlite3";import{PostgresAdapter as J,PostgresDialect as _}from"kysely";var N=class extends J{async acquireMigrationLock(a,e){await a.selectFrom(e.lockTable).selectAll().forUpdate().execute()}},b=class extends _{createAdapter(){return new N}};var v=async t=>{let a=()=>{switch(t.database.dialect){case"cockroachdb":return new b({pool:new O({connectionString:t.database.connectionString})});case"postgres":return new U({pool:new O({connectionString:t.database.connectionString})});case"mysql":return new L({pool:z(t.database.connectionString)});case"sqlite":return new V({database:new G(t.database.connectionString)});default:throw new Error(`Unsupported dialect: ${t.database.dialect}`)}};return{db:new I({dialect:a()})}};var P="0.2.0";import{createConsola as Y}from"consola";import{writeFile as Z,mkdir as B}from"fs/promises";var c=Y({stdout:process.stderr}),ee=async t=>{let a=await t.selectFrom("kysely_migration").select(["name","timestamp"]).$narrowType().execute().catch(()=>[]);return a.length===0?[]:(await C()).filter(o=>!a.some(i=>i.name===o.id))},te=x({meta:{name:"generate",description:"Generate migration files based on the current schema"},args:{apply:{type:"boolean",description:"Apply the migration after generating it",default:!1},"ignore-pending":{type:"boolean",description:"Ignore pending migrations and generate a new one",default:!1}},run:async t=>{try{let a=await h(),{db:e}=await v({database:a.database});if(!t.args["ignore-pending"]){let i=await ee(e);if(i.length>0){c.warn([`There are pending migrations: ${i.map(l=>l.id).join(", ")}`,"Please apply them first before generating a new migration.","Otherwise, use --ignore-pending to skip this check."].join(`
|
|
2
|
+
`)),await e.destroy();return}}let n=await re({db:e,config:a});if(!n){c.info("No changes detected, no migration needed."),await e.destroy();return}ne(n.diff);let o=`${u}/${n.id}.json`;await B(u,{recursive:!0}),await Z(o,JSON.stringify(n,null,2)),c.success(`Migration file generated: ${o}`),t.args.apply&&await j({db:e,dryRun:!1}),await e.destroy()}catch(a){c.error(a),process.exit(1)}}}),ae=x({meta:{name:"apply",description:"Run migrations to sync database schema"},args:{"dry-run":{name:"dryRun",type:"boolean",description:"Run the migration in dry-run mode",default:!1}},run:async t=>{try{let a=await h(),{db:e}=await v({database:a.database});await j({db:e,dryRun:t.args["dry-run"]}),await e.destroy()}catch(a){c.error(a),process.exit(1)}}}),j=async t=>{let{db:a}=t,e=new Q({db:a,provider:A({db:a,migrationDirName:u})}),{results:n,error:o}=await e.migrateToLatest();n&&n.length>0?n.forEach(i=>{i.status==="Error"?c.error(`Migration failed: ${i.migrationName}`):i.status==="Success"&&c.success(`Migration applied: ${i.migrationName}`)}):c.info("No migrations to run"),o&&(c.error(`Migration error: ${o}`),process.exit(1))},ne=t=>{t.addedTables.length>0&&t.addedTables.forEach(a=>{c.log(`-- create_table: ${a.table}`),Object.entries(a.columns).forEach(([e,n])=>{c.log(` -> column: ${e} (${JSON.stringify(n)})`)})}),t.removedTables.length>0&&t.removedTables.forEach(a=>{c.log(`-- remove_table: ${a}`)}),t.changedTables.length>0&&t.changedTables.forEach(a=>{a.addedColumns.forEach(e=>{c.log([`-- add_column: ${a.table}.${e.column}`,` -> to: ${JSON.stringify(e.attributes)}`].join(`
|
|
3
|
+
`))}),a.removedColumns.forEach(e=>{c.log(`-- remove_column: ${a.table}.${e.column})`)}),a.changedColumns.forEach(e=>{c.log([`-- change_column: ${a.table}.${e.column}`,` -> from: ${JSON.stringify(e.before)}`,` -> to: ${JSON.stringify(e.after)}`].join(`
|
|
4
|
+
`))})})},re=async t=>{let{db:a,config:e}=t,o=(await a.introspection.getTables()).map(r=>({name:r.name,columns:(r.columns??[]).reduce((d,m)=>(d[m.name]={type:m.dataType,notNull:!m.isNullable},d),{})})),i=e.tables.map(r=>({name:r.tableName,columns:Object.fromEntries(Object.entries(r.columns).map(([d,m])=>[d,{type:m.type,notNull:m.notNull,primaryKey:m.primaryKey,unique:m.unique}]))})),l=E({current:o,ideal:i});return l.addedTables.length===0&&l.removedTables.length===0&&l.changedTables.length===0?null:{version:"1",id:Date.now()+"",diff:l}},oe=x({meta:{name:"kyrage",version:P,description:"Kysely migration CLI with declarative schema"},subCommands:{apply:ae,generate:te}});X(oe);
|
package/package.json
CHANGED
|
@@ -2,30 +2,39 @@
|
|
|
2
2
|
"name": "@izumisy/kyrage",
|
|
3
3
|
"private": false,
|
|
4
4
|
"type": "module",
|
|
5
|
-
"version": "0.
|
|
6
|
-
"description": "
|
|
5
|
+
"version": "0.2.0",
|
|
6
|
+
"description": "A minimal, schema-based declarative migration tool for Node.js ecosystem",
|
|
7
7
|
"files": [
|
|
8
8
|
"dist"
|
|
9
9
|
],
|
|
10
|
+
"exports": {
|
|
11
|
+
".": {
|
|
12
|
+
"types": "./dist/index.d.ts",
|
|
13
|
+
"default": "./dist/index.js"
|
|
14
|
+
}
|
|
15
|
+
},
|
|
10
16
|
"bin": {
|
|
11
17
|
"kyrage": "./dist/main.js"
|
|
12
18
|
},
|
|
13
19
|
"dependencies": {
|
|
14
|
-
"
|
|
20
|
+
"better-sqlite3": "^12.2.0",
|
|
21
|
+
"c12": "^3.2.0",
|
|
15
22
|
"citty": "^0.1.6",
|
|
16
23
|
"consola": "^3.4.2",
|
|
17
|
-
"kysely": "^0.28.
|
|
24
|
+
"kysely": "^0.28.4",
|
|
18
25
|
"kysely-codegen": "^0.18.5",
|
|
26
|
+
"mysql2": "^3.14.3",
|
|
19
27
|
"pg": "^8.16.3",
|
|
20
28
|
"zod": "^4.0.14"
|
|
21
29
|
},
|
|
22
30
|
"devDependencies": {
|
|
23
31
|
"@swc/core": "^1.13.3",
|
|
24
|
-
"@types/
|
|
32
|
+
"@types/better-sqlite3": "^7.6.13",
|
|
33
|
+
"@types/node": "^24.2.0",
|
|
25
34
|
"@types/pg": "^8.15.5",
|
|
26
35
|
"prettier": "^3.6.2",
|
|
27
36
|
"tsup": "^8.5.0",
|
|
28
|
-
"typescript": "^5.
|
|
37
|
+
"typescript": "^5.9.2",
|
|
29
38
|
"vitest": "^3.2.4"
|
|
30
39
|
},
|
|
31
40
|
"scripts": {
|