@casekit/orm2-cli 0.0.0-20250331181319 → 0.0.0

package/build/commands/init/util/generateConfigFile.js

@@ -1,12 +1,11 @@
 import { unindent } from "@casekit/unindent";
 export const generateConfigFile = (directory) => unindent `
-    import { orm } from "@casekit/orm2";
     import type { OrmCLIConfig } from "@casekit/orm2-cli";
 
-    import { models } from "./${directory.replace(/^\.\//, "")}/models";
+    import { config } from "./${directory.replace(/^\.\//, "")}/config";
 
     export default {
-        db: orm({ models }),
+        db: orm(config),
         directory: "${directory}",
     } satisfies OrmCLIConfig;
 `;

package/build/commands/init/util/generateDbFile.js

@@ -3,24 +3,15 @@ import { usesDevServer } from "#util/usesDevServer.js";
 export const generateDbFile = () => {
     return usesDevServer()
         ? unindent `
-            import { Config, ModelType, Orm, orm } from "@casekit/orm2";
+            import { type Config, type ModelType, type Orm, orm } from "@casekit/orm2";
 
-            import { models } from "./models";
+            import { type Models, config } from "./config";
 
-            export type Models = typeof models;
-
-            export type Model<M extends keyof Models> = ModelType<Models, M>;
-
-            export const config: Config<Models> = {
-                models,
-                pool: true,
-            };
-
-            let db: Orm<Models>;
+            let db: Orm<typeof config>;
 
             declare global {
                 // eslint-disable-next-line no-var
-                var __db: Orm<Models>;
+                var __db: Orm<typeof config>;
             }
 
             // we do this because in development we don't want to restart
@@ -38,24 +29,22 @@ export const generateDbFile = () => {
                 db = global.__db;
             }
 
+            export type DB = Orm<typeof config>;
+            export type Model<M extends keyof Models> = ModelType<Models[M]>;
+
             export { db };
         `
         : unindent `
-            import { Config, ModelType, Orm, orm } from "@casekit/orm2";
+            import { type Config, type ModelType, type Orm, orm } from "@casekit/orm2";
 
-            import { models } from "./models";
+            import { type Models, config } from "./config";
 
-            export type Models = typeof models;
-            export type Model<M extends keyof Models> = ModelType<Models, M>;
-
-            export const config: Config<Models> = {
-                models,
-                pool: true,
-            };
-
-            const db: Orm<Models> = orm(config);
+            const db: Orm<typeof config> = orm(config);
             await db.connect();
 
+            export type DB = Orm<typeof config>;
+            export type Model<M extends keyof Models> = ModelType<Models[M]>;
+
             export { db };
         `;
 };

package/build/commands/init/util/generateModelsFile.d.ts

@@ -1 +1 @@
-export declare const generateModelsFile: () => string;
+export declare const generateModelsFile: (models: string[]) => string;

package/build/commands/init/util/generateModelsFile.js

@@ -1,4 +1,8 @@
 import { unindent } from "@casekit/unindent";
-export const generateModelsFile = () => unindent `
-    export const models = {};
+export const generateModelsFile = (models) => unindent `
+    ${models.map((m) => `import { ${m} } from "./${m}";`).join("\n")};
+
+    export const models = {
+        ${models.map((m) => `${m},`).join("\n")}
+    }
 `;

package/build/commands/init.test.js

@@ -16,28 +16,19 @@ describe("init", () => {
         vi.spyOn(prompts, "input").mockResolvedValueOnce("./app/db.server");
         vi.spyOn(prompts, "confirm").mockResolvedValueOnce(true);
         await yargs().command(init).parseAsync("init");
-        const dbFile = vol.readFileSync("./app/db.server/db.ts", "utf-8");
+        const dbFile = vol.readFileSync("./app/db.server/index.ts", "utf-8");
         const modelFile = vol.readFileSync("./app/db.server/models/index.ts", "utf-8");
         const configFile = vol.readFileSync("./orm.config.ts", "utf-8");
         expect(dbFile).toEqual(unindent `
-            import { Config, ModelType, Orm, orm } from "@casekit/orm2";
+            import { type Config, type ModelType, type Orm, orm } from "@casekit/orm2";
 
-            import { models } from "./models";
+            import { type Models, config } from "./config";
 
-            export type Models = typeof models;
-
-            export type Model<M extends keyof Models> = ModelType<Models, M>;
-
-            export const config: Config<Models> = {
-                models,
-                pool: true,
-            };
-
-            let db: Orm<Models>;
+            let db: Orm<typeof config>;
 
             declare global {
                 // eslint-disable-next-line no-var
-                var __db: Orm<Models>;
+                var __db: Orm<typeof config>;
             }
 
             // we do this because in development we don't want to restart
@@ -55,19 +46,21 @@ describe("init", () => {
                 db = global.__db;
             }
 
+            export type DB = Orm<typeof config>;
+            export type Model<M extends keyof Models> = ModelType<Models[M]>;
+
             export { db };
         `);
-        expect(modelFile).toEqual(unindent `
+        expect(modelFile.trim()).toEqual(unindent `
             export const models = {};
         `);
         expect(configFile).toEqual(unindent `
-            import { orm } from "@casekit/orm2";
             import type { OrmCLIConfig } from "@casekit/orm2-cli";
 
-            import { models } from "./app/db.server/models";
+            import { config } from "./app/db.server/config";
 
             export default {
-                db: orm({ models }),
+                db: orm(config),
                 directory: "./app/db.server",
             } satisfies OrmCLIConfig;
         `);
@@ -77,7 +70,7 @@ describe("init", () => {
             "package.json": JSON.stringify({ dependencies: {} }),
             "app/db.server/models/index.ts": "original",
             "orm.config.ts": "original",
-            "app/db.server/db.ts": "original",
+            "app/db.server/index.ts": "original",
         }, "/project");
         vi.spyOn(prompts, "input").mockResolvedValueOnce("./app/db.server");
         vi.spyOn(prompts, "confirm")
@@ -85,25 +78,20 @@ describe("init", () => {
             .mockResolvedValueOnce(false)
             .mockResolvedValueOnce(false);
         await yargs().command(init).parseAsync("init");
-        const dbFile = vol.readFileSync("./app/db.server/db.ts", "utf-8");
+        const dbFile = vol.readFileSync("./app/db.server/index.ts", "utf-8");
         const modelFile = vol.readFileSync("./app/db.server/models/index.ts", "utf-8");
         const configFile = vol.readFileSync("./orm.config.ts", "utf-8");
         expect(dbFile).toEqual(unindent `
-            import { Config, ModelType, Orm, orm } from "@casekit/orm2";
+            import { type Config, type ModelType, type Orm, orm } from "@casekit/orm2";
 
-            import { models } from "./models";
+            import { type Models, config } from "./config";
 
-            export type Models = typeof models;
-            export type Model<M extends keyof Models> = ModelType<Models, M>;
-
-            export const config: Config<Models> = {
-                models,
-                pool: true,
-            };
-
-            const db: Orm<Models> = orm(config);
+            const db: Orm<typeof config> = orm(config);
             await db.connect();
 
+            export type DB = Orm<typeof config>;
+            export type Model<M extends keyof Models> = ModelType<Models[M]>;
+
             export { db };
         `);
         expect(modelFile).toEqual("original");

package/build/types.d.ts

@@ -1,6 +1,6 @@
 import { ConnectionConfig } from "pg";
 import { ArgumentsCamelCase, InferredOptionTypes, Options } from "yargs";
-import { ZodSchema } from "zod";
+import { ZodType } from "zod";
 import { ModelDefinition, Orm } from "@casekit/orm2";
 import { globalOptions } from "#options.js";
 export interface OrmCLIConfig {
@@ -8,7 +8,7 @@ export interface OrmCLIConfig {
     directory: string;
     generate?: {
         templates?: Record<string, ModelDefinition>;
-        defaultSchemas?: Record<string, ZodSchema>;
+        defaultSchemas?: Record<string, ZodType>;
     };
     migrate?: {
         connection?: ConnectionConfig;

package/build/util/createOrOverwriteFile.d.ts

@@ -1 +1 @@
-export declare const createOrOverwriteFile: (filePath: string, content: string, force?: boolean) => Promise<void>;
+export declare const createOrOverwriteFile: (filePath: string, content: string, force?: boolean) => Promise<string | undefined>;

package/build/util/createOrOverwriteFile.js

@@ -13,5 +13,5 @@ export const createOrOverwriteFile = async (filePath, content, force) => {
     }
     fs.mkdirSync(path.dirname(fullPath), { recursive: true });
     fs.writeFileSync(fullPath, content);
-    console.log(`- Created ${filePath}`);
+    return fullPath;
 };

package/build/util/loadConfig.js

@@ -5,7 +5,11 @@ export const loadConfig = async (options) => {
         const unregister = register();
         const { default: config } = await import(path.join(process.cwd(), options.config));
         await unregister();
-        return "default" in config ? config.default : config;
+        const c = "default" in config ? config.default : config;
+        process.on("exit", async function () {
+            await c.db.close();
+        });
+        return c;
     }
     catch (e) {
         console.error(e instanceof Error ? e.message : e);

package/package.json

@@ -1,45 +1,47 @@
 {
   "name": "@casekit/orm2-cli",
   "description": "",
-  "version": "0.0.0-20250331181319",
+  "version": "0.0.0",
   "author": "",
   "bin": {
     "orm": "./build/cli.js"
   },
   "dependencies": {
     "@casekit/unindent": "^1.0.5",
-    "@inquirer/prompts": "^7.4.0",
-    "@inquirer/testing": "^2.1.45",
+    "@inquirer/prompts": "^7.5.3",
+    "@inquirer/testing": "^2.1.47",
     "byline": "^5.0.0",
     "camelcase": "^8.0.0",
-    "es-toolkit": "^1.33.0",
-    "jscodeshift": "^17.2.0",
-    "tsx": "^4.19.3",
-    "yargs": "^17.7.2",
-    "@casekit/orm2-migrate": "0.0.0-20250331181319",
-    "@casekit/orm2": "0.0.0-20250331181319",
-    "@casekit/sql": "0.0.0-20250331181319",
-    "@casekit/toolbox": "0.0.0-20250331181319"
+    "es-toolkit": "^1.39.3",
+    "jscodeshift": "^17.3.0",
+    "pluralize": "^8.0.0",
+    "tsx": "^4.20.3",
+    "yargs": "^18.0.0",
+    "@casekit/orm2": "0.0.0",
+    "@casekit/sql": "0.0.0",
+    "@casekit/orm2-migrate": "0.0.0",
+    "@casekit/toolbox": "0.0.0"
   },
   "devDependencies": {
     "@trivago/prettier-plugin-sort-imports": "^5.2.2",
     "@types/byline": "^4.2.36",
-    "@types/jscodeshift": "^0.12.0",
-    "@types/node": "^22.13.13",
-    "@types/pg": "^8.11.11",
+    "@types/jscodeshift": "^17.3.0",
+    "@types/node": "^24.0.3",
+    "@types/pg": "^8.15.4",
+    "@types/pluralize": "^0.0.33",
     "@types/yargs": "^17.0.33",
-    "@vitest/coverage-v8": "^3.0.9",
-    "dotenv": "^16.4.7",
-    "memfs": "^4.17.0",
+    "@vitest/coverage-v8": "^3.2.4",
+    "dotenv": "^16.5.0",
+    "memfs": "^4.17.2",
     "prettier": "^3.5.3",
-    "prettier-plugin-svelte": "^3.3.3",
-    "typescript": "^5.8.2",
+    "prettier-plugin-svelte": "^3.4.0",
+    "typescript": "^5.8.3",
     "vite-tsconfig-paths": "^5.1.4",
-    "vitest": "^3.0.9",
-    "zod": "^3.24.2",
-    "@casekit/prettier-config": "0.0.0-20250331181319",
-    "@casekit/orm2-fixtures": "0.0.0-20250331181319",
-    "@casekit/tsconfig": "0.0.0-20250331181319"
+    "vitest": "^3.2.4",
+    "zod": "^4.0.17",
+    "@casekit/tsconfig": "0.0.0",
+    "@casekit/orm2-fixtures": "0.0.0",
+    "@casekit/prettier-config": "0.0.0"
   },
   "exports": {
     ".": "./build/index.js"
@@ -52,7 +54,6 @@
   },
   "keywords": [],
   "license": "ISC",
-  "main": "index.js",
   "peerDependencies": {
     "pg": "^8.13.1"
   },

package/build/commands/generate-model/handler.d.ts

@@ -1,3 +0,0 @@
-import { Handler } from "#types.js";
-import { builder } from "./options.js";
-export declare const handler: Handler<typeof builder>;

package/build/commands/generate-model/handler.js

@@ -1,10 +0,0 @@
-import { createOrOverwriteFile } from "#util/createOrOverwriteFile.js";
-import { loadConfig } from "#util/loadConfig.js";
-import { generateModelFile } from "./util/generateModelFile.js";
-import { regenerateModelsFile } from "./util/regenerateModelsFile.js";
-export const handler = async (opts) => {
-    const config = await loadConfig(opts);
-    const modelFile = await generateModelFile(opts);
-    await createOrOverwriteFile(`${config.directory}/models/${opts.name}.ts`, modelFile, opts.force);
-    await regenerateModelsFile(config, opts.name);
-};

package/build/commands/generate-model/options.d.ts

@@ -1,18 +0,0 @@
-export declare const builder: {
-    readonly name: {
-        readonly type: "string";
-        readonly desc: "Name of the model";
-        readonly demandOption: true;
-    };
-    readonly template: {
-        readonly type: "string";
-        readonly desc: "Template to use to generate the model. Pass --template none if you have a default template defined but don't want to use it.";
-        readonly default: "default";
-    };
-    readonly fields: {
-        readonly type: "string";
-        readonly desc: "Fields to generate for the model, in the format 'name:type name:type'";
-        readonly array: true;
-        readonly default: readonly [];
-    };
-};

package/build/commands/generate-model/options.js

@@ -1,18 +0,0 @@
-export const builder = {
-    name: {
-        type: "string",
-        desc: "Name of the model",
-        demandOption: true,
-    },
-    template: {
-        type: "string",
-        desc: "Template to use to generate the model. Pass --template none if you have a default template defined but don't want to use it.",
-        default: "default",
-    },
-    fields: {
-        type: "string",
-        desc: "Fields to generate for the model, in the format 'name:type name:type'",
-        array: true,
-        default: [],
-    },
-};

package/build/commands/generate-model/util/generateModelFile.d.ts

@@ -1,3 +0,0 @@
-import { CommandOptions } from "#types.js";
-import { builder } from "../options.js";
-export declare const generateModelFile: (opts: Pick<CommandOptions<typeof builder>, "name" | "config" | "template" | "fields">) => Promise<string>;

package/build/commands/generate-model/util/generateModelFile.js

@@ -1,59 +0,0 @@
-import fs from "fs";
-import jscodeshift from "jscodeshift";
-import { prettify } from "#util/prettify.js";
-export const generateModelFile = async (opts) => {
-    const config = fs.readFileSync(opts.config, "utf-8");
-    const j = jscodeshift.withParser("ts");
-    const root = j(config);
-    const templateContent = root
-        .find(j.ExportDefaultDeclaration)
-        .find(j.ObjectExpression)
-        .find(j.ObjectProperty, { key: { name: "templates" } })
-        .find(j.ObjectExpression)
-        .find(j.ObjectProperty, { key: { name: opts.template } })
-        .find(j.ObjectExpression);
-    if (templateContent.length === 0) {
-        if (opts.template !== "default") {
-            console.warn(`Template "${opts.template}" not found.`);
-        }
-    }
-    const templateAst = templateContent.length === 0
-        ? j("{ fields: {} }")
-        : j(templateContent.get().node);
-    const fieldsObj = templateAst
-        .find(j.ObjectProperty, {
-        key: { name: "fields" },
-    })
-        .find(j.ObjectExpression);
-    for (const field of opts.fields) {
-        const [name, type] = field.split(":");
-        if (!name || !type) {
-            console.error("Invalid field definition:", field);
-            process.exit(1);
-        }
-        const existingProperties = fieldsObj.get().node.properties ?? [];
-        const filteredProperties = existingProperties.filter((prop) => prop.type === "ObjectProperty" &&
-            prop.key.type === "Identifier" &&
-            prop.key.name !== name);
-        fieldsObj.replaceWith(j.objectExpression([
-            ...filteredProperties.map((prop) => j.objectProperty(prop.key, prop.value)),
-            j.objectProperty(j.identifier(name), j.objectExpression([
-                j.objectProperty(j.identifier("type"), j.stringLiteral(type)),
-            ])),
-        ]));
-    }
-    templateAst.find(j.EmptyStatement).remove();
-    const usesSqlLiteral = templateAst.find(j.TaggedTemplateExpression).length > 0;
-    // we avoid trailing commas and strip newlines so
-    // prettier won't break code onto multiple lines unless necessary.
-    // trailing commas will be added in again by prettier.
-    const definition = templateAst.toSource({
-        trailingComma: false,
-        lineTerminator: " ",
-    });
-    const result = `
-        import { ModelDefinition ${usesSqlLiteral ? ", sql" : ""} } from "@casekit/orm2";
-
-        export const ${opts.name} = ${definition} as const satisfies ModelDefinition;`;
-    return await prettify(process.cwd(), result);
-};

package/build/commands/generate-model/util/generateModelFile.test.js

@@ -1,67 +0,0 @@
-import { vol } from "memfs";
-import { beforeAll, describe, expect, test, vi } from "vitest";
-import { unindent } from "@casekit/unindent";
-import { generateModelFile } from "./generateModelFile.js";
-describe("generateModelFile", () => {
-    beforeAll(() => {
-        vol.fromJSON({
-            "orm.config.ts": unindent `
-                import { sql } from "@casekit/orm2";
-                import { type OrmCLIConfig } from "@casekit/orm2-cli";
-
-                export default {
-                    directory: "./app/db.server",
-                    generate: {
-                        templates: {
-                            default: {
-                                fields: {
-                                    id: { type: "uuid", primaryKey: true },
-                                    createdAt: { type: "timestamp", default: sql\`now()\` },
-                                },
-                            },
-                            foo: {
-                                fields: {
-                                    name: { type: "text" },
-                                },
-                            },
-                        },
-                    },
-                } satisfies OrmCLIConfig;
-            `,
-        }, "/project");
-    });
-    test("merges fields from the passed `fields` argument, overwriting same-named fields in the template", async () => {
-        const result = await generateModelFile({
-            config: "orm.config.ts",
-            name: "bar",
-            template: "default",
-            fields: ["id:serial", "name:text"],
-        });
-        expect(result.trim()).toBe(unindent `
-            import { ModelDefinition, sql } from "@casekit/orm2";
-
-            export const bar = {
-                fields: {
-                    createdAt: { type: "timestamp", default: sql\`now()\` },
-                    id: { type: "serial" },
-                    name: { type: "text" },
-                },
-            } as const satisfies ModelDefinition;
-        `);
-    });
-    test("works if the template does not exist - but logs a warning", async () => {
-        const warnSpy = vi.spyOn(console, "warn").mockReturnValue();
-        const result = await generateModelFile({
-            config: "orm.config.ts",
-            name: "foo",
-            template: "wrong",
-            fields: [],
-        });
-        expect(warnSpy).toHaveBeenCalledWith(`Template "wrong" not found.`);
-        expect(result.trim()).toBe(unindent `
-            import { ModelDefinition } from "@casekit/orm2";
-
-            export const foo = { fields: {} } as const satisfies ModelDefinition;
-        `);
-    });
-});

package/build/commands/generate-model/util/regenerateModelsFile.d.ts

@@ -1,2 +0,0 @@
-import { OrmCLIConfig } from "#types.js";
-export declare const regenerateModelsFile: (config: OrmCLIConfig, name: string) => Promise<void>;

package/build/commands/generate-model/util/regenerateModelsFile.js

@@ -1,50 +0,0 @@
-import fs from "fs";
-import jscodeshift from "jscodeshift";
-import path from "path";
-import { prettify } from "#util/prettify.js";
-export const regenerateModelsFile = async (config, name) => {
-    console.log(`- Regenerating models/index.ts file: ${config.directory}`);
-    const filename = path.join(config.directory, "models/index.ts");
-    const source = fs.readFileSync(path.join(process.cwd(), filename), "utf-8");
-    const j = jscodeshift.withParser("ts");
-    const root = j(source);
-    const modelsExport = root
-        .find(j.ExportNamedDeclaration)
-        .filter((path) => path.node.declaration?.type === "VariableDeclaration" &&
-        path.node.declaration?.declarations[0]?.type ===
-            "VariableDeclarator" &&
-        path.node.declaration?.declarations[0]?.id.type ===
-            "Identifier" &&
-        path.node.declaration?.declarations[0]?.id.name === "models" &&
-        path.node.declaration?.declarations[0]?.init?.type ===
-            "ObjectExpression" &&
-        path.node.declaration?.declarations[0]?.init?.type ===
-            "ObjectExpression")
-        .at(0);
-    if (modelsExport.size() === 0) {
-        console.log(`- No \`models\` object found in models/index.ts. Cannot inject \${name}\` export.`);
-        return;
-    }
-    const modelsObject = modelsExport.get().node.declaration.declarations[0].init;
-    // Add an import for `name` from `./name` if not already imported
-    const existingImport = root
-        .find(j.ImportDeclaration)
-        .filter((path) => path.node.source.value === `./${name}` &&
-        !!path.node.specifiers?.some((specifier) => specifier.type === "ImportSpecifier" &&
-            specifier.imported.name === name));
-    if (existingImport.size() === 0) {
-        const newImport = j.importDeclaration([j.importSpecifier(j.identifier(name))], j.literal(`./${name}`));
-        root.get().node.program.body.unshift(newImport);
-        modelsObject.properties.push(j.property.from({
-            key: j.identifier(name),
-            value: j.identifier(name),
-            shorthand: true,
-            kind: "init",
-        }));
-        console.log(`- Injected export into ${filename}`);
-    }
-    else {
-        console.log("- Model already exported from index file, skipping");
-    }
-    fs.writeFileSync(path.join(process.cwd(), filename), await prettify(path.join(process.cwd(), filename), root.toSource()));
-};

package/build/commands/generate-model.d.ts

@@ -1,40 +0,0 @@
-export declare const generateModel: {
-    command: string;
-    desc: string;
-    builder: {
-        readonly name: {
-            readonly type: "string";
-            readonly desc: "Name of the model";
-            readonly demandOption: true;
-        };
-        readonly template: {
-            readonly type: "string";
-            readonly desc: "Template to use to generate the model. Pass --template none if you have a default template defined but don't want to use it.";
-            readonly default: "default";
-        };
-        readonly fields: {
-            readonly type: "string";
-            readonly desc: "Fields to generate for the model, in the format 'name:type name:type'";
-            readonly array: true;
-            readonly default: readonly [];
-        };
-    };
-    handler: import("../types.js").Handler<{
-        readonly name: {
-            readonly type: "string";
-            readonly desc: "Name of the model";
-            readonly demandOption: true;
-        };
-        readonly template: {
-            readonly type: "string";
-            readonly desc: "Template to use to generate the model. Pass --template none if you have a default template defined but don't want to use it.";
-            readonly default: "default";
-        };
-        readonly fields: {
-            readonly type: "string";
-            readonly desc: "Fields to generate for the model, in the format 'name:type name:type'";
-            readonly array: true;
-            readonly default: readonly [];
-        };
-    }>;
-};

package/build/commands/generate-model.js

@@ -1,8 +0,0 @@
-import { handler } from "./generate-model/handler.js";
-import { builder } from "./generate-model/options.js";
-export const generateModel = {
-    command: "model",
-    desc: "Generate a skeleton model file",
-    builder,
-    handler,
-};