orchid-orm 1.5.12 → 1.5.15

package/package.json

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

package/rollup.config.js

@@ -8,6 +8,7 @@ export default [
     plugins: [esbuild()],
     output: [
       {
+        banner: '#!/usr/bin/env node',
         file: 'dist/bin.js',
         format: 'cjs',
         sourcemap: true,

package/src/bin/bin.ts

@@ -1,3 +1,3 @@
-import { astOrchidORMConfig, initOrchidORM } from './init';
+import { askOrchidORMConfig, initOrchidORM } from './init';
 
-astOrchidORMConfig().then(initOrchidORM);
+askOrchidORMConfig().then(initOrchidORM);

package/src/bin/init.test.ts

@@ -46,6 +46,7 @@ const configPath = path.join(dbDirPath, 'config.ts');
 const dbPath = path.join(dbDirPath, 'db.ts');
 const migrationScriptPath = path.join(dbDirPath, 'dbScripts.ts');
 const migrationsPath = path.join(dbDirPath, 'migrations');
+const seedPath = path.join(dbDirPath, 'seed.ts');
 
 describe('initOrchidORM', () => {
   beforeEach(jest.clearAllMocks);
@@ -64,7 +65,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",
@@ -84,6 +86,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": {
@@ -186,6 +189,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": {
@@ -354,7 +358,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),
   }),
 });
 `);
@@ -372,8 +377,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(),
   }),
 });
 `);
@@ -391,8 +398,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(),
   }),
 });
 `);
@@ -426,7 +435,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(),
@@ -434,13 +443,13 @@ class PostTable extends BaseTable {
     text: t.text(20, 10000),
     ...t.timestamps(),
   }));
-  
+
   relations = {
     comments: this.hasMany(() => CommentTable, {
       primaryKey: 'id',
       foreignKey: 'postId',
     }),
-  }
+  };
 }
 `);
     });
@@ -459,7 +468,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(),
@@ -467,13 +476,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);
@@ -492,21 +501,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',
     }),
-  }
+  };
 }
 `);
     });
@@ -525,21 +537,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);
@@ -563,7 +578,7 @@ if (!database.databaseURL) throw new Error('DATABASE_URL is missing in .env');
 
 export const config = {
   database,
-}
+};
 `);
     });
 
@@ -595,7 +610,7 @@ if (testDatabase.databaseURL) {
 export const config = {
   allDatabases,
   database: process.env.NODE_ENV === 'test' ? testDatabase : database,
-}
+};
 `);
     });
   });
@@ -610,11 +625,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, {
+});
 `);
     });
 
@@ -628,16 +640,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,
+});
 `);
     });
   });
@@ -656,11 +665,18 @@ import { appCodeUpdater } from 'orchid-orm';
 rakeDb(config.database, {
   migrationsPath: 'src/db/migrations',
   appCodeUpdater: appCodeUpdater({
-    tablePath: (tableName) => \`src/db/tables/\${tableName}.ts\`,
-    baseTablePath: 'src/lib/baseTable.ts',
+    tablePath: (tableName) => \`src/db/tables/\${tableName}.table.ts\`,
+    baseTablePath: 'src/db/baseTable.ts',
     baseTableName: 'BaseTable',
-    mainFilePath: 'src/db.ts',
+    mainFilePath: 'src/db/db.ts',
   }),
+  useCodeUpdater: true, // set to false to disable code updater
+  commands: {
+    async seed() {
+      const { seed } = await import('./seed');
+      await seed();
+    },
+  },
 });
 `);
     });
@@ -680,11 +696,18 @@ import { appCodeUpdater } from 'orchid-orm';
 rakeDb(config.allDatabases, {
   migrationsPath: 'src/db/migrations',
   appCodeUpdater: appCodeUpdater({
-    tablePath: (tableName) => \`src/db/tables/\${tableName}.ts\`,
-    baseTablePath: 'src/lib/baseTable.ts',
+    tablePath: (tableName) => \`src/db/tables/\${tableName}.table.ts\`,
+    baseTablePath: 'src/db/baseTable.ts',
     baseTableName: 'BaseTable',
-    mainFilePath: 'src/db.ts',
+    mainFilePath: 'src/db/db.ts',
   }),
+  useCodeUpdater: true, // set to false to disable code updater
+  commands: {
+    async seed() {
+      const { seed } = await import('./seed');
+      await seed();
+    },
+  },
 });
 `);
     });
@@ -730,6 +753,24 @@ change(async (db) => {
     ...t.timestamps(),
   }));
 });
+`);
+    });
+  });
+
+  describe('seed', () => {
+    it('should create seed file', async () => {
+      await initOrchidORM({});
+
+      const [, content] = asMock(fs.writeFile).mock.calls.find(
+        ([to]) => to === seedPath,
+      );
+      expect(content).toBe(`import { db } from './db';
+
+export const seed = async () => {
+  // create records here
+
+  await db.$close();
+};
 `);
     });
   });

package/src/bin/init.ts

@@ -15,7 +15,7 @@ type DependencyKind = 'dependencies' | 'devDependencies';
 
 const dirPath = path.resolve(process.cwd(), 'src', 'db');
 
-export const astOrchidORMConfig = async () => {
+export const askOrchidORMConfig = async () => {
   const response = await prompts([
     {
       type: 'select',
@@ -73,6 +73,7 @@ export const initOrchidORM = async (config: InitConfig) => {
   await setupMainDb(config);
   await setupMigrationScript(config);
   await createMigrations(config);
+  await createSeed();
 };
 
 const setupPackageJson = async (config: InitConfig) => {
@@ -80,6 +81,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'),
@@ -212,14 +214,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 += `
@@ -246,7 +250,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(),
@@ -254,13 +258,13 @@ class PostTable extends BaseTable {
     text: t.text(20, 10000),
     ...t.timestamps(),
   }));
-  
+
   relations = {
     comments: this.hasMany(() => CommentTable, {
       primaryKey: 'id',
       foreignKey: 'postId',
     }),
-  }
+  };
 }
 ${
   config.addSchemaToZod
@@ -279,21 +283,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
@@ -344,7 +351,7 @@ export const config = {`;
   database,`;
   }
   content += `
-}
+};
 `;
 
   await fs.writeFile(configPath, content);
@@ -355,11 +362,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');
@@ -368,11 +375,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}
+});
 `,
   );
 };
@@ -388,11 +392,18 @@ 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\`,
-    baseTablePath: 'src/lib/baseTable.ts',
+    tablePath: (tableName) => \`src/db/tables/\${tableName}.table.ts\`,
+    baseTablePath: 'src/db/baseTable.ts',
     baseTableName: 'BaseTable',
-    mainFilePath: 'src/db.ts',
+    mainFilePath: 'src/db/db.ts',
   }),
+  useCodeUpdater: true, // set to false to disable code updater
+  commands: {
+    async seed() {
+      const { seed } = await import('./seed');
+      await seed();
+    },
+  },
 });
 `,
   );
@@ -404,9 +415,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,
@@ -423,9 +436,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,
@@ -443,8 +458,7 @@ change(async (db) => {
   );
 };
 
-const makeFileTimeStamp = () => {
-  const now = new Date();
+const makeFileTimeStamp = (now: Date) => {
   return [
     now.getUTCFullYear(),
     now.getUTCMonth() + 1,
@@ -456,3 +470,18 @@ const makeFileTimeStamp = () => {
     .map((value) => (value < 10 ? `0${value}` : value))
     .join('');
 };
+
+const createSeed = async () => {
+  const filePath = path.join(dirPath, 'seed.ts');
+  await fs.writeFile(
+    filePath,
+    `import { db } from './db';
+
+export const seed = async () => {
+  // create records here
+
+  await db.$close();
+};
+`,
+  );
+};