orchid-orm 1.5.15 → 1.5.17

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "orchid-orm",
-  "version": "1.5.15",
+  "version": "1.5.17",
   "description": "Postgres ORM",
   "homepage": "https://orchid-orm.netlify.app/guide/orm-setup-and-overview.html",
   "repository": {
@@ -40,7 +40,7 @@
   "author": "Roman Kushyn",
   "license": "ISC",
   "dependencies": {
-    "pqb": "0.9.10",
+    "pqb": "0.9.11",
     "prompts": "^2.4.2"
   },
   "devDependencies": {
@@ -52,10 +52,10 @@
     "@types/prompts": "^2.4.2",
     "dotenv": "^16.0.1",
     "jest": "^28.1.2",
-    "orchid-orm-schema-to-zod": "0.2.16",
+    "orchid-orm-schema-to-zod": "0.2.17",
     "pg": "^8.7.3",
     "pg-transactional-tests": "^1.0.7",
-    "rake-db": "2.3.15",
+    "rake-db": "2.3.16",
     "rimraf": "^3.0.2",
     "rollup": "^2.79.0",
     "rollup-plugin-dts": "^4.2.2",

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);
 

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) => {
@@ -485,3 +487,22 @@ export const seed = async () => {
 `,
   );
 };
+
+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,
 });
 `);
     });
@@ -109,10 +109,10 @@ export const db = orchidORM({}, {
     it('should handle object list without ending coma', async () => {
       asMock(fs.readFile).mockResolvedValue(`
 import { orchidORM } from 'orchid-orm';
-import { Some } from './tables/some';
+import { MyTable } from './tables/my.table';
 
 export const db = orchidORM({}, {
-  some: Some
+  my: MyTable,
 });
 `);
 
@@ -120,14 +120,29 @@ export const db = orchidORM({}, {
 
       testWritten(`
 import { orchidORM } from 'orchid-orm';
-import { Some } from './tables/some';
-import { Table } from './tables/table';
+import { MyTable } from './tables/my.table';
+import { SomeTable } from './tables/some.table';
 
 export const db = orchidORM({}, {
-  some: Some,
-  table: Table,
+  my: MyTable,
+  some: SomeTable,
+});
+`);
+    });
+
+    it('should not add table if it is already added', async () => {
+      asMock(fs.readFile).mockResolvedValue(`
+import { orchidORM } from 'orchid-orm';
+import { SomeTable } from './tables/some.table';
+
+export const db = orchidORM({}, {
+  some: SomeTable
 });
 `);
+
+      await updateMainFile(mainFilePath, tablePath, ast.addTable, options);
+
+      expect(fs.writeFile).not.toBeCalled();
     });
   });
 
@@ -135,10 +150,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 +170,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 +190,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 +211,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,11 +117,17 @@ 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);
 
   const importPath = getImportPath(filePath, tablePath(ast.name));
+
+  const existing = Array.from(
+    ts.import.iterateWithSource(statements, importPath),
+  );
+  if (existing.length) return;
+
   const importPos = ts.import.getEndPos(statements);
   changes.add(
     importPos,
@@ -147,7 +153,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);

package/src/codegen/updateTableFile/changeTable.test.ts

@@ -16,7 +16,7 @@ const baseTableName = 'BaseTable';
 const params = { baseTablePath, baseTableName, tablePath };
 const t = columnTypes;
 
-const testWritten = makeTestWritten(tablePath('table'));
+const testWritten = makeTestWritten(tablePath('some'));
 
 const tableData = newTableData();
 
@@ -30,7 +30,7 @@ const change = (
 });
 
 class Table {
-  table = 'table';
+  table = 'some';
 }
 
 describe('updateTableFile', () => {
@@ -42,8 +42,8 @@ describe('updateTableFile', () => {
     asMock(fs.readFile)
       .mockResolvedValue(`import { BaseTable } from '../baseTable';
 
-export class TableTable extends BaseTable {
-  table = 'table';
+export class SomeTable extends BaseTable {
+  table = 'some';
   columns = this.setColumns((t) => ({}));
 }`);
 
@@ -59,8 +59,8 @@ export class TableTable extends BaseTable {
 
     testWritten(`import { BaseTable } from '../baseTable';
 
-export class TableTable extends BaseTable {
-  table = 'table';
+export class SomeTable extends BaseTable {
+  table = 'some';
   columns = this.setColumns((t) => ({
     name: t.text(1, 10),
   }));
@@ -71,8 +71,8 @@ export class TableTable extends BaseTable {
     asMock(fs.readFile)
       .mockResolvedValue(`import { BaseTable } from '../baseTable';
 
-export class TableTable extends BaseTable {
-  table = 'table';
+export class SomeTable extends BaseTable {
+  table = 'some';
   columns = this.setColumns((t) => ({
     id: t.serial().primaryKey(),
   }));
@@ -90,8 +90,8 @@ export class TableTable extends BaseTable {
 
     testWritten(`import { BaseTable } from '../baseTable';
 
-export class TableTable extends BaseTable {
-  table = 'table';
+export class SomeTable extends BaseTable {
+  table = 'some';
   columns = this.setColumns((t) => ({
     id: t.serial().primaryKey(),
     name: t.text(1, 10),
@@ -103,8 +103,8 @@ export class TableTable extends BaseTable {
     asMock(fs.readFile)
       .mockResolvedValue(`import { BaseTable } from '../baseTable';
 
-export class TableTable extends BaseTable {
-  table = 'table';
+export class SomeTable extends BaseTable {
+  table = 'some';
   columns = this.setColumns((t) => ({
     id: t.serial().primaryKey(),
   }));
@@ -123,8 +123,8 @@ export class TableTable extends BaseTable {
 
     testWritten(`import { BaseTable } from '../baseTable';
 
-export class TableTable extends BaseTable {
-  table = 'table';
+export class SomeTable extends BaseTable {
+  table = 'some';
   columns = this.setColumns((t) => ({
     id: t.serial().primaryKey(),
     name: t.text(1, 10),
@@ -137,8 +137,8 @@ export class TableTable extends BaseTable {
     asMock(fs.readFile)
       .mockResolvedValue(`import { BaseTable } from '../baseTable';
 
-export class TableTable extends BaseTable {
-  table = 'table';
+export class SomeTable extends BaseTable {
+  table = 'some';
   columns = this.setColumns((t) => ({
     id: t.serial().primaryKey()
   }));
@@ -157,8 +157,8 @@ export class TableTable extends BaseTable {
 
     testWritten(`import { BaseTable } from '../baseTable';
 
-export class TableTable extends BaseTable {
-  table = 'table';
+export class SomeTable extends BaseTable {
+  table = 'some';
   columns = this.setColumns((t) => ({
     id: t.serial().primaryKey(),
     name: t.text(1, 10),
@@ -171,8 +171,8 @@ export class TableTable extends BaseTable {
     asMock(fs.readFile)
       .mockResolvedValue(`import { BaseTable } from '../baseTable';
 
-export class TableTable extends BaseTable {
-  table = 'table';
+export class SomeTable extends BaseTable {
+  table = 'some';
   columns = this.setColumns((t) => ({
     id: t.serial().primaryKey(),
     name: t.text(),
@@ -192,8 +192,8 @@ export class TableTable extends BaseTable {
 
     testWritten(`import { BaseTable } from '../baseTable';
 
-export class TableTable extends BaseTable {
-  table = 'table';
+export class SomeTable extends BaseTable {
+  table = 'some';
   columns = this.setColumns((t) => ({
     id: t.serial().primaryKey(),
     active: t.boolean(),
@@ -205,8 +205,8 @@ export class TableTable extends BaseTable {
     asMock(fs.readFile)
       .mockResolvedValue(`import { BaseTable } from '../baseTable';
 
-export class TableTable extends BaseTable {
-  table = 'table';
+export class SomeTable extends BaseTable {
+  table = 'some';
   columns = this.setColumns((t) => ({
     id: t.serial().primaryKey(),
     name: t.text(),
@@ -225,8 +225,8 @@ export class TableTable extends BaseTable {
 
     testWritten(`import { BaseTable } from '../baseTable';
 
-export class TableTable extends BaseTable {
-  table = 'table';
+export class SomeTable extends BaseTable {
+  table = 'some';
   columns = this.setColumns((t) => ({
     id: t.serial().primaryKey(),
   }));
@@ -237,8 +237,8 @@ export class TableTable extends BaseTable {
     asMock(fs.readFile)
       .mockResolvedValue(`import { BaseTable } from '../baseTable';
 
-export class TableTable extends BaseTable {
-  table = 'table';
+export class SomeTable extends BaseTable {
+  table = 'some';
   columns = this.setColumns((t) => ({
     name: t.integer(),
   }));
@@ -263,8 +263,8 @@ export class TableTable extends BaseTable {
 
     testWritten(`import { BaseTable } from '../baseTable';
 
-export class TableTable extends BaseTable {
-  table = 'table';
+export class SomeTable extends BaseTable {
+  table = 'some';
   columns = this.setColumns((t) => ({
     name: t.text(1, 10),
   }));
@@ -275,8 +275,8 @@ export class TableTable extends BaseTable {
     asMock(fs.readFile)
       .mockResolvedValue(`import { BaseTable } from '../baseTable';
 
-export class TableTable extends BaseTable {
-  table = 'table';
+export class SomeTable extends BaseTable {
+  table = 'some';
   columns = this.setColumns((t) => ({
     changeCollate: t.text().collate('one'),
     addCollate: t.text(),
@@ -318,8 +318,8 @@ export class TableTable extends BaseTable {
 
     testWritten(`import { BaseTable } from '../baseTable';
 
-export class TableTable extends BaseTable {
-  table = 'table';
+export class SomeTable extends BaseTable {
+  table = 'some';
   columns = this.setColumns((t) => ({
     changeCollate: t.text().collate('two'),
     addCollate: t.text().collate('two'),
@@ -341,8 +341,8 @@ export class TableTable extends BaseTable {
   describe('primaryKey', () => {
     const result = `import { BaseTable } from '../baseTable';
  
-export class TableTable extends BaseTable {
-  table = 'table';
+export class SomeTable extends BaseTable {
+  table = 'some';
   columns = this.setColumns((t) => ({
     ...t.primaryKey(['one', 'two'], { name: 'name' }),
   }));
@@ -360,8 +360,8 @@ export class TableTable extends BaseTable {
       asMock(fs.readFile)
         .mockResolvedValue(`import { BaseTable } from '../baseTable';
  
-export class TableTable extends BaseTable {
-  table = 'table';
+export class SomeTable extends BaseTable {
+  table = 'some';
   columns = this.setColumns((t) => ({
     ...t.primaryKey(['foo', 'bar'], { name: 'baz' }),
   }));
@@ -382,8 +382,8 @@ export class TableTable extends BaseTable {
       asMock(fs.readFile)
         .mockResolvedValue(`import { BaseTable } from '../baseTable';
  
-export class TableTable extends BaseTable {
-  table = 'table';
+export class SomeTable extends BaseTable {
+  table = 'some';
   columns = this.setColumns((t) => ({
   }));
 }`);
@@ -405,8 +405,8 @@ export class TableTable extends BaseTable {
       asMock(fs.readFile)
         .mockResolvedValue(`import { BaseTable } from '../baseTable';
 
-export class TableTable extends BaseTable {
-  table = 'table';
+export class SomeTable extends BaseTable {
+  table = 'some';
   columns = this.setColumns((t) => ({
     name: t.text().index({ order: 'one' }).index({ collate: 'en_US' })
   }));
@@ -428,8 +428,8 @@ export class TableTable extends BaseTable {
 
       testWritten(`import { BaseTable } from '../baseTable';
 
-export class TableTable extends BaseTable {
-  table = 'table';
+export class SomeTable extends BaseTable {
+  table = 'some';
   columns = this.setColumns((t) => ({
     name: t.text().index({
       order: 'two',
@@ -444,8 +444,8 @@ export class TableTable extends BaseTable {
       asMock(fs.readFile)
         .mockResolvedValue(`import { BaseTable } from '../baseTable';
 
-export class TableTable extends BaseTable {
-  table = 'table';
+export class SomeTable extends BaseTable {
+  table = 'some';
   columns = this.setColumns((t) => ({
     name: t.text(),
   }));
@@ -467,8 +467,8 @@ export class TableTable extends BaseTable {
 
       testWritten(`import { BaseTable } from '../baseTable';
 
-export class TableTable extends BaseTable {
-  table = 'table';
+export class SomeTable extends BaseTable {
+  table = 'some';
   columns = this.setColumns((t) => ({
     name: t.text().index({
       order: 'two',
@@ -481,8 +481,8 @@ export class TableTable extends BaseTable {
 
     const result = `import { BaseTable } from '../baseTable';
 
-export class TableTable extends BaseTable {
-  table = 'table';
+export class SomeTable extends BaseTable {
+  table = 'some';
   columns = this.setColumns((t) => ({
     ...t.index(['6']),
     ...t.index(['7', '8']),
@@ -523,8 +523,8 @@ export class TableTable extends BaseTable {
       asMock(fs.readFile)
         .mockResolvedValue(`import { BaseTable } from '../baseTable';
 
-export class TableTable extends BaseTable {
-  table = 'table';
+export class SomeTable extends BaseTable {
+  table = 'some';
   columns = this.setColumns((t) => ({
     ...t.index('1'),
     ...t.index(['2', '3']),
@@ -564,8 +564,8 @@ export class TableTable extends BaseTable {
       asMock(fs.readFile)
         .mockResolvedValue(`import { BaseTable } from '../baseTable';
 
-export class TableTable extends BaseTable {
-  table = 'table';
+export class SomeTable extends BaseTable {
+  table = 'some';
   columns = this.setColumns((t) => ({
   }));
 }`);
@@ -587,8 +587,8 @@ export class TableTable extends BaseTable {
       asMock(fs.readFile)
         .mockResolvedValue(`import { BaseTable } from '../baseTable';
 
-export class TableTable extends BaseTable {
-  table = 'table';
+export class SomeTable extends BaseTable {
+  table = 'some';
   columns = this.setColumns((t) => ({
     name: t.text().foreignKey('a', 'b').foreignKey('c', 'd')
   }));
@@ -620,8 +620,8 @@ export class TableTable extends BaseTable {
 
       testWritten(`import { BaseTable } from '../baseTable';
 
-export class TableTable extends BaseTable {
-  table = 'table';
+export class SomeTable extends BaseTable {
+  table = 'some';
   columns = this.setColumns((t) => ({
     name: t.text().foreignKey('e', 'f').foreignKey('g', 'h'),
   }));
@@ -632,8 +632,8 @@ export class TableTable extends BaseTable {
       asMock(fs.readFile)
         .mockResolvedValue(`import { BaseTable } from '../baseTable';
 
-export class TableTable extends BaseTable {
-  table = 'table';
+export class SomeTable extends BaseTable {
+  table = 'some';
   columns = this.setColumns((t) => ({
     name: t.text(),
   }));
@@ -660,8 +660,8 @@ export class TableTable extends BaseTable {
 
       testWritten(`import { BaseTable } from '../baseTable';
 
-export class TableTable extends BaseTable {
-  table = 'table';
+export class SomeTable extends BaseTable {
+  table = 'some';
   columns = this.setColumns((t) => ({
     name: t.text().foreignKey('e', 'f').foreignKey('g', 'h'),
   }));
@@ -670,12 +670,12 @@ export class TableTable extends BaseTable {
 
     const result = `import { BaseTable } from '../baseTable';
 
-export class TableTable extends BaseTable {
-  table = 'table';
+export class SomeTable extends BaseTable {
+  table = 'some';
   columns = this.setColumns((t) => ({
     ...t.foreignKey(
       ['7'],
-      'table',
+      'some',
       ['8'],
       {
         name: 'first',
@@ -700,7 +700,7 @@ export class TableTable extends BaseTable {
       foreignKeys: [
         {
           columns: ['7'],
-          fnOrTable: 'table',
+          fnOrTable: 'some',
           foreignColumns: ['8'],
           options: {
             name: 'first',
@@ -724,8 +724,8 @@ export class TableTable extends BaseTable {
       asMock(fs.readFile)
         .mockResolvedValue(`import { BaseTable } from '../baseTable';
 
-export class TableTable extends BaseTable {
-  table = 'table';
+export class SomeTable extends BaseTable {
+  table = 'some';
   columns = this.setColumns((t) => ({
     ...t.foreignKey(
       ['1'],
@@ -734,7 +734,7 @@ export class TableTable extends BaseTable {
     ),
     ...t.foreignKey(
       ['3', '4'],
-      'table',
+      'some',
       ['5', '6'],
       {
         name: 'foreignKeyName',
@@ -761,7 +761,7 @@ export class TableTable extends BaseTable {
               },
               {
                 columns: ['3', '4'],
-                fnOrTable: 'table',
+                fnOrTable: 'some',
                 foreignColumns: ['5', '6'],
                 options: {
                   name: 'foreignKeyName',
@@ -784,8 +784,8 @@ export class TableTable extends BaseTable {
       asMock(fs.readFile)
         .mockResolvedValue(`import { BaseTable } from '../baseTable';
 
-export class TableTable extends BaseTable {
-  table = 'table';
+export class SomeTable extends BaseTable {
+  table = 'some';
   columns = this.setColumns((t) => ({
   }));
 }`);