orchid-orm 1.5.14 → 1.5.16

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "orchid-orm",
-  "version": "1.5.14",
+  "version": "1.5.16",
   "description": "Postgres ORM",
   "homepage": "https://orchid-orm.netlify.app/guide/orm-setup-and-overview.html",
   "repository": {

package/src/bin/init.test.ts

@@ -48,6 +48,8 @@ const migrationScriptPath = path.join(dbDirPath, 'dbScripts.ts');
 const migrationsPath = path.join(dbDirPath, 'migrations');
 const seedPath = path.join(dbDirPath, 'seed.ts');
 
+console.log = jest.fn();
+
 describe('initOrchidORM', () => {
   beforeEach(jest.clearAllMocks);
 
@@ -65,7 +67,8 @@ describe('initOrchidORM', () => {
   "dependencies": {
     "dotenv": "^1.2.3",
     "orchid-orm": "^1.2.3",
-    "pqb": "^1.2.3"
+    "pqb": "^1.2.3",
+    "pg": "^1.2.3"
   },
   "devDependencies": {
     "rake-db": "^1.2.3",
@@ -85,6 +88,7 @@ describe('initOrchidORM', () => {
     "dotenv": "^1.2.3",
     "orchid-orm": "^1.2.3",
     "pqb": "^1.2.3",
+    "pg": "^1.2.3",
     "orchid-orm-schema-to-zod": "^1.2.3"
   },
   "devDependencies": {
@@ -187,6 +191,7 @@ describe('initOrchidORM', () => {
     "dotenv": "^1.2.3",
     "orchid-orm": "^1.2.3",
     "pqb": "^1.2.3",
+    "pg": "^1.2.3",
     "orchid-orm-schema-to-zod": "^1.2.3"
   },
   "devDependencies": {
@@ -355,7 +360,8 @@ ko
 
 export const BaseTable = createBaseTable({
   columnTypes: (t) => ({
-    text: (min: 0, max: Infinity) => t.text(min, max),
+    ...t,
+    text: (min = 0, max = Infinity) => t.text(min, max),
   }),
 });
 `);
@@ -373,8 +379,10 @@ export const BaseTable = createBaseTable({
 
 export const BaseTable = createBaseTable({
   columnTypes: (t) => ({
-    text: (min: 0, max: Infinity) => t.text(min, max),
-    timestamp: <P extends number>(precision?: P) => t.timestamp<P>(precision).asDate(),
+    ...t,
+    text: (min = 0, max = Infinity) => t.text(min, max),
+    timestamp: <P extends number>(precision?: P) =>
+      t.timestamp<P>(precision).asDate(),
   }),
 });
 `);
@@ -392,8 +400,10 @@ export const BaseTable = createBaseTable({
 
 export const BaseTable = createBaseTable({
   columnTypes: (t) => ({
-    text: (min: 0, max: Infinity) => t.text(min, max),
-    timestamp: <P extends number>(precision?: P) => t.timestamp<P>(precision).asNumber(),
+    ...t,
+    text: (min = 0, max = Infinity) => t.text(min, max),
+    timestamp: <P extends number>(precision?: P) =>
+      t.timestamp<P>(precision).asNumber(),
   }),
 });
 `);
@@ -427,7 +437,7 @@ export const BaseTable = createBaseTable({
 import { CommentTable } from './comment.table';
 
 export type Post = PostTable['columns']['type'];
-class PostTable extends BaseTable {
+export class PostTable extends BaseTable {
   table = 'post';
   columns = this.setColumns((t) => ({
     id: t.serial().primaryKey(),
@@ -435,13 +445,13 @@ class PostTable extends BaseTable {
     text: t.text(20, 10000),
     ...t.timestamps(),
   }));
-  
+
   relations = {
     comments: this.hasMany(() => CommentTable, {
       primaryKey: 'id',
       foreignKey: 'postId',
     }),
-  }
+  };
 }
 `);
     });
@@ -460,7 +470,7 @@ import { CommentTable } from './comment.table';
 import { tableToZod } from 'orchid-orm-schema-to-zod';
 
 export type Post = PostTable['columns']['type'];
-class PostTable extends BaseTable {
+export class PostTable extends BaseTable {
   table = 'post';
   columns = this.setColumns((t) => ({
     id: t.serial().primaryKey(),
@@ -468,13 +478,13 @@ class PostTable extends BaseTable {
     text: t.text(20, 10000),
     ...t.timestamps(),
   }));
-  
+
   relations = {
     comments: this.hasMany(() => CommentTable, {
       primaryKey: 'id',
       foreignKey: 'postId',
     }),
-  }
+  };
 }
 
 export const postSchema = tableToZod(PostTable);
@@ -493,21 +503,24 @@ export const postSchema = tableToZod(PostTable);
 import { PostTable } from './post.table';
 
 export type Comment = CommentTable['columns']['type'];
-class CommentTable extends BaseTable {
+export class CommentTable extends BaseTable {
   table = 'comment';
   columns = this.setColumns((t) => ({
     id: t.serial().primaryKey(),
-    postId: t.integer().foreignKey(() => PostTable, 'id').index(),
+    postId: t
+      .integer()
+      .foreignKey(() => PostTable, 'id')
+      .index(),
     text: t.text(5, 1000),
     ...t.timestamps(),
   }));
-  
+
   relations = {
     post: this.belongsTo(() => PostTable, {
       primaryKey: 'id',
       foreignKey: 'postId',
     }),
-  }
+  };
 }
 `);
     });
@@ -526,21 +539,24 @@ import { PostTable } from './post.table';
 import { tableToZod } from 'orchid-orm-schema-to-zod';
 
 export type Comment = CommentTable['columns']['type'];
-class CommentTable extends BaseTable {
+export class CommentTable extends BaseTable {
   table = 'comment';
   columns = this.setColumns((t) => ({
     id: t.serial().primaryKey(),
-    postId: t.integer().foreignKey(() => PostTable, 'id').index(),
+    postId: t
+      .integer()
+      .foreignKey(() => PostTable, 'id')
+      .index(),
     text: t.text(5, 1000),
     ...t.timestamps(),
   }));
-  
+
   relations = {
     post: this.belongsTo(() => PostTable, {
       primaryKey: 'id',
       foreignKey: 'postId',
     }),
-  }
+  };
 }
 
 export const commentSchema = tableToZod(CommentTable);
@@ -564,7 +580,7 @@ if (!database.databaseURL) throw new Error('DATABASE_URL is missing in .env');
 
 export const config = {
   database,
-}
+};
 `);
     });
 
@@ -596,7 +612,7 @@ if (testDatabase.databaseURL) {
 export const config = {
   allDatabases,
   database: process.env.NODE_ENV === 'test' ? testDatabase : database,
-}
+};
 `);
     });
   });
@@ -611,11 +627,8 @@ export const config = {
       expect(content).toBe(`import { orchidORM } from 'orchid-orm';
 import { config } from './config';
 
-export const db = orchidORM(
-  config.database,
-  {
-  }
-);
+export const db = orchidORM(config.database, {
+});
 `);
     });
 
@@ -629,16 +642,13 @@ export const db = orchidORM(
       );
       expect(content).toBe(`import { orchidORM } from 'orchid-orm';
 import { config } from './config';
-import { Post } from './tables/post.table';
-import { Comment } from './tables/comment.table';
-
-export const db = orchidORM(
-  config.database,
-  {
-    post: Post,
-    comment: Comment,
-  }
-);
+import { PostTable } from './tables/post.table';
+import { CommentTable } from './tables/comment.table';
+
+export const db = orchidORM(config.database, {
+  post: PostTable,
+  comment: CommentTable,
+});
 `);
     });
   });
@@ -657,15 +667,16 @@ import { appCodeUpdater } from 'orchid-orm';
 rakeDb(config.database, {
   migrationsPath: 'src/db/migrations',
   appCodeUpdater: appCodeUpdater({
-    tablePath: (tableName) => \`src/db/tables/\${tableName}.ts\`,
+    tablePath: (tableName) => \`src/db/tables/\${tableName}.table.ts\`,
     baseTablePath: 'src/db/baseTable.ts',
     baseTableName: 'BaseTable',
     mainFilePath: 'src/db/db.ts',
   }),
+  useCodeUpdater: true, // set to false to disable code updater
   commands: {
     async seed() {
-      const { run } = await import('./seed');
-      await run();
+      const { seed } = await import('./seed');
+      await seed();
     },
   },
 });
@@ -687,15 +698,16 @@ import { appCodeUpdater } from 'orchid-orm';
 rakeDb(config.allDatabases, {
   migrationsPath: 'src/db/migrations',
   appCodeUpdater: appCodeUpdater({
-    tablePath: (tableName) => \`src/db/tables/\${tableName}.ts\`,
+    tablePath: (tableName) => \`src/db/tables/\${tableName}.table.ts\`,
     baseTablePath: 'src/db/baseTable.ts',
     baseTableName: 'BaseTable',
     mainFilePath: 'src/db/db.ts',
   }),
+  useCodeUpdater: true, // set to false to disable code updater
   commands: {
     async seed() {
-      const { run } = await import('./seed');
-      await run();
+      const { seed } = await import('./seed');
+      await seed();
     },
   },
 });
@@ -759,8 +771,8 @@ change(async (db) => {
 export const seed = async () => {
   // create records here
 
-  await db.close();
-}
+  await db.$close();
+};
 `);
     });
   });

package/src/bin/init.ts

@@ -74,6 +74,8 @@ export const initOrchidORM = async (config: InitConfig) => {
   await setupMigrationScript(config);
   await createMigrations(config);
   await createSeed();
+
+  greet();
 };
 
 const setupPackageJson = async (config: InitConfig) => {
@@ -81,6 +83,7 @@ const setupPackageJson = async (config: InitConfig) => {
     getLatestPackageVersion('dotenv', 'dependencies'),
     getLatestPackageVersion('orchid-orm', 'dependencies'),
     getLatestPackageVersion('pqb', 'dependencies'),
+    getLatestPackageVersion('pg', 'dependencies'),
     config.addSchemaToZod &&
       getLatestPackageVersion('orchid-orm-schema-to-zod', 'dependencies'),
     getLatestPackageVersion('rake-db', 'devDependencies'),
@@ -213,14 +216,16 @@ const setupBaseTable = async (config: InitConfig) => {
 
 export const BaseTable = createBaseTable({
   columnTypes: (t) => ({
-    text: (min: 0, max: Infinity) => t.text(min, max),`;
+    ...t,
+    text: (min = 0, max = Infinity) => t.text(min, max),`;
 
   const { timestamp } = config;
   if (timestamp) {
     content += `
-    timestamp: <P extends number>(precision?: P) => t.timestamp<P>(precision).${
-      timestamp === 'date' ? 'asDate' : 'asNumber'
-    }(),`;
+    timestamp: <P extends number>(precision?: P) =>
+      t.timestamp<P>(precision).${
+        timestamp === 'date' ? 'asDate' : 'asNumber'
+      }(),`;
   }
 
   content += `
@@ -247,7 +252,7 @@ ${
     : ''
 }
 export type Post = PostTable['columns']['type'];
-class PostTable extends BaseTable {
+export class PostTable extends BaseTable {
   table = 'post';
   columns = this.setColumns((t) => ({
     id: t.serial().primaryKey(),
@@ -255,13 +260,13 @@ class PostTable extends BaseTable {
     text: t.text(20, 10000),
     ...t.timestamps(),
   }));
-  
+
   relations = {
     comments: this.hasMany(() => CommentTable, {
       primaryKey: 'id',
       foreignKey: 'postId',
     }),
-  }
+  };
 }
 ${
   config.addSchemaToZod
@@ -280,21 +285,24 @@ ${
     : ''
 }
 export type Comment = CommentTable['columns']['type'];
-class CommentTable extends BaseTable {
+export class CommentTable extends BaseTable {
   table = 'comment';
   columns = this.setColumns((t) => ({
     id: t.serial().primaryKey(),
-    postId: t.integer().foreignKey(() => PostTable, 'id').index(),
+    postId: t
+      .integer()
+      .foreignKey(() => PostTable, 'id')
+      .index(),
     text: t.text(5, 1000),
     ...t.timestamps(),
   }));
-  
+
   relations = {
     post: this.belongsTo(() => PostTable, {
       primaryKey: 'id',
       foreignKey: 'postId',
     }),
-  }
+  };
 }
 ${
   config.addSchemaToZod
@@ -345,7 +353,7 @@ export const config = {`;
   database,`;
   }
   content += `
-}
+};
 `;
 
   await fs.writeFile(configPath, content);
@@ -356,11 +364,11 @@ const setupMainDb = async (config: InitConfig) => {
   let tables = '';
   if (config.demoTables) {
     imports += `
-import { Post } from './tables/post.table';
-import { Comment } from './tables/comment.table';`;
+import { PostTable } from './tables/post.table';
+import { CommentTable } from './tables/comment.table';`;
     tables += `
-    post: Post,
-    comment: Comment,`;
+  post: PostTable,
+  comment: CommentTable,`;
   }
 
   const dbPath = path.join(dirPath, 'db.ts');
@@ -369,11 +377,8 @@ import { Comment } from './tables/comment.table';`;
     `import { orchidORM } from 'orchid-orm';
 import { config } from './config';${imports}
 
-export const db = orchidORM(
-  config.database,
-  {${tables}
-  }
-);
+export const db = orchidORM(config.database, {${tables}
+});
 `,
   );
 };
@@ -389,15 +394,16 @@ import { appCodeUpdater } from 'orchid-orm';
 rakeDb(${config.testDatabase ? 'config.allDatabases' : 'config.database'}, {
   migrationsPath: 'src/db/migrations',
   appCodeUpdater: appCodeUpdater({
-    tablePath: (tableName) => \`src/db/tables/\${tableName}.ts\`,
+    tablePath: (tableName) => \`src/db/tables/\${tableName}.table.ts\`,
     baseTablePath: 'src/db/baseTable.ts',
     baseTableName: 'BaseTable',
     mainFilePath: 'src/db/db.ts',
   }),
+  useCodeUpdater: true, // set to false to disable code updater
   commands: {
     async seed() {
-      const { run } = await import('./seed');
-      await run();
+      const { seed } = await import('./seed');
+      await seed();
     },
   },
 });
@@ -411,9 +417,11 @@ const createMigrations = async (config: InitConfig) => {
 
   if (!config.demoTables) return;
 
+  const now = new Date();
+
   const postPath = path.join(
     migrationsPath,
-    `${makeFileTimeStamp()}_createPost.ts`,
+    `${makeFileTimeStamp(now)}_createPost.ts`,
   );
   await fs.writeFile(
     postPath,
@@ -430,9 +438,11 @@ change(async (db) => {
 `,
   );
 
+  now.setTime(now.getTime() + 1000);
+
   const commentPath = path.join(
     migrationsPath,
-    `${makeFileTimeStamp()}_createComment.ts`,
+    `${makeFileTimeStamp(now)}_createComment.ts`,
   );
   await fs.writeFile(
     commentPath,
@@ -450,8 +460,7 @@ change(async (db) => {
   );
 };
 
-const makeFileTimeStamp = () => {
-  const now = new Date();
+const makeFileTimeStamp = (now: Date) => {
   return [
     now.getUTCFullYear(),
     now.getUTCMonth() + 1,
@@ -473,8 +482,25 @@ const createSeed = async () => {
 export const seed = async () => {
   // create records here
 
-  await db.close();
-}
+  await db.$close();
+};
 `,
   );
 };
+
+const greet = () => {
+  console.log(`Thank you for trying Orchid ORM!
+  
+To finish setup, install dependencies:
+
+> npm i
+
+Enter the correct database credentials to the .env file,
+then create the database:
+
+> npm run db create
+
+And run the migrations:
+
+> npm run db migrate`);
+};

package/src/codegen/testUtils.ts

@@ -4,13 +4,14 @@ import path from 'path';
 import fs from 'fs/promises';
 
 export const asMock = (fn: unknown) => fn as jest.Mock;
-export const tablePath = (table: string) => path.resolve(`tables/${table}.ts`);
+export const tablePath = (table: string) =>
+  path.resolve(`tables/${table}.table.ts`);
 
 const makeAst = () => {
   const addTable: RakeDbAst.Table = {
     type: 'table',
     action: 'create',
-    name: 'table',
+    name: 'some',
     shape: {
       id: columnTypes.serial().primaryKey(),
     },
@@ -26,8 +27,8 @@ const makeAst = () => {
 
   const renameTable: RakeDbAst.RenameTable = {
     type: 'renameTable',
-    from: 'table',
-    to: 'renamedTable',
+    from: 'some',
+    to: 'another',
   };
 
   const tableData = {
@@ -37,7 +38,7 @@ const makeAst = () => {
 
   const changeTable: RakeDbAst.ChangeTable = {
     type: 'changeTable',
-    name: 'table',
+    name: 'some',
     shape: {},
     add: tableData,
     drop: tableData,

package/src/codegen/updateMainFile.test.ts

@@ -31,14 +31,14 @@ describe('updateMainFile', () => {
       });
 
       testWritten(`import { orchidORM } from 'orchid-orm';
-import { Table } from './tables/table';
+import { SomeTable } from './tables/some.table';
 
 export const db = orchidORM(
   {
     databaseURL: 'url',
   },
   {
-    table: Table,
+    some: SomeTable,
   }
 );
 `);
@@ -55,10 +55,10 @@ export const db = orchidORM({}, {});
 
       testWritten(`
 import { orchidORM } from 'orchid-orm';
-import { Table } from './tables/table';
+import { SomeTable } from './tables/some.table';
 
 export const db = orchidORM({}, {
-  table: Table,
+  some: SomeTable,
 });
 `);
     });
@@ -74,10 +74,10 @@ export const db = custom({}, {});
 
       testWritten(`
 import { orchidORM as custom } from 'orchid-orm';
-import { Table } from './tables/table';
+import { SomeTable } from './tables/some.table';
 
 export const db = custom({}, {
-  table: Table,
+  some: SomeTable,
 });
 `);
     });
@@ -97,11 +97,11 @@ export const db = orchidORM({}, {
       testWritten(`
 import { orchidORM } from 'orchid-orm';
 import { Some } from './tables/some';
-import { Table } from './tables/table';
+import { SomeTable } from './tables/some.table';
 
 export const db = orchidORM({}, {
   some: Some,
-  table: Table,
+  some: SomeTable,
 });
 `);
     });
@@ -121,11 +121,11 @@ export const db = orchidORM({}, {
       testWritten(`
 import { orchidORM } from 'orchid-orm';
 import { Some } from './tables/some';
-import { Table } from './tables/table';
+import { SomeTable } from './tables/some.table';
 
 export const db = orchidORM({}, {
   some: Some,
-  table: Table,
+  some: SomeTable,
 });
 `);
     });
@@ -135,10 +135,10 @@ export const db = orchidORM({}, {
     it('should remove table', async () => {
       asMock(fs.readFile).mockResolvedValue(`
 import { orchidORM } from 'orchid-orm';
-import { Table } from './tables/table';
+import { SomeTable } from './tables/some.table';
 
 export const db = orchidORM({}, {
-  table: Table,
+  some: SomeTable,
 });
 `);
 
@@ -155,7 +155,7 @@ export const db = orchidORM({}, {
     it('should remove aliased import', async () => {
       asMock(fs.readFile).mockResolvedValue(`
 import { orchidORM } from 'orchid-orm';
-import { Table as koko } from './tables/table';
+import { SomeTable as koko } from './tables/some.table';
 
 export const db = orchidORM({}, {
   koko: koko,
@@ -175,7 +175,7 @@ export const db = orchidORM({}, {
     it('should remove short form of key and value', async () => {
       asMock(fs.readFile).mockResolvedValue(`
 import { orchidORM } from 'orchid-orm';
-import { Table as koko } from './tables/table';
+import { SomeTable as koko } from './tables/some.table';
 
 export const db = orchidORM({}, {
   koko,
@@ -196,12 +196,12 @@ export const db = orchidORM({}, {
       asMock(fs.readFile).mockResolvedValue(`
 import { orchidORM } from 'orchid-orm';
 import { One } from './tables/one';
-import { Table } from './tables/table';
+import { SomeTable } from './tables/some.table';
 import { Two } from './tables/two';
 
 export const db = orchidORM({}, {
   one,
-  table: Table,
+  some: SomeTable,
   two,
 });
 `);

package/src/codegen/updateMainFile.ts

@@ -117,7 +117,7 @@ const createTable = (
   ast: RakeDbAst.Table,
 ) => {
   const key = toCamelCase(ast.name);
-  const value = toPascalCase(ast.name);
+  const value = `${toPascalCase(ast.name)}Table`;
 
   const changes = new FileChanges(content);
 
@@ -147,7 +147,7 @@ const dropTable = (
   const changes = new FileChanges(content);
 
   const importPath = getImportPath(filePath, tablePath(ast.name));
-  const tableClassName = toPascalCase(ast.name);
+  const tableClassName = `${toPascalCase(ast.name)}Table`;
   const importNames: string[] = [];
   for (const node of ts.import.iterateWithSource(statements, importPath)) {
     changes.remove(node.pos, node.end);