feat: add in support for 0.3 typeorm (#43)(@asheliahut)

Update adapter to support new Typeorm

BREAKING CHANGE: The adapter has been updated to work with Typeorm of version ~0.3.0 so it will no longer work with older versions of Typeorm.
- Change `Connection` inputsto `DataSource` for referencing database
- Update all find methods to findBy

Author: asheliahut

.github/workflows/push.yml

@@ -62,7 +62,7 @@ jobs:
       - name: Lint
         run: yarn lint
       - name: Migrate
-        run: yarn typeorm migration:run
+        run: yarn run migrate
       - name: Test
         run: yarn test
 

README.md

@@ -25,10 +25,10 @@ Resource.validate = validate
 import {
   BaseEntity,
   Entity, PrimaryGeneratedColumn, Column,
-  createConnection,
   ManyToOne,
   RelationId
 } from 'typeorm'
+import { MyDataSource } from './my-data-source'
 import * as express from 'express'
 import { Database, Resource } from '@adminjs/typeorm'
 import { validate } from 'class-validator'
@@ -67,13 +67,10 @@ export class Person extends BaseEntity
 
 ( async () =>
 {
-  const connection = await createConnection({/* ... */})
-
-  // Applying connection to model
-  Person.useConnection(connection)
+  await MyDataSource.initialize();
 
   const adminJs = new AdminJS({
-    // databases: [connection],
+    // databases: [MyDataSource],
     resources: [
       { resource: Person, options: { parent: { name: 'foobar' } } }
       ],

package.json

@@ -19,6 +19,7 @@
     "test": "mocha -r ts-node/register ./spec/**/*.spec.ts",
     "ts-node": "ts-node",
     "lint": "eslint './src/**/*.{ts,js}' './spec/**/*.{ts,js}' './example-app/**/*.{ts,js}' --ignore-pattern 'build' --ignore-pattern 'yarn.lock'",
+    "migrate": "ts-node ./node_modules/typeorm/cli.js migration:run -d spec/utils/test-data-source.ts",
     "check:all": "yarn lint && yarn test && yarn build",
     "typeorm": "ts-node -r tsconfig-paths/register ./node_modules/typeorm/cli.js",
     "release": "semantic-release"
@@ -36,7 +37,7 @@
   "license": "MIT",
   "peerDependencies": {
     "adminjs": "^5.0.0",
-    "typeorm": "~0.2.45"
+    "typeorm": "~0.3.0"
   },
   "optionalDependencies": {},
   "devDependencies": {
@@ -59,12 +60,12 @@
     "eslint-plugin-react-hooks": "^4.0.8",
     "husky": "^4.2.5",
     "mocha": "^6.2.2",
-    "pg": "^7.12.1",
+    "pg": "^8.7.3",
     "semantic-release": "^17.0.7",
     "semantic-release-slack-bot": "^1.6.2",
-    "ts-node": "^8.4.1",
-    "tsconfig-paths": "^3.9.0",
-    "typeorm": "~0.2.45",
-    "typescript": "^4.0.3"
+    "ts-node": "^10.7.0",
+    "tsconfig-paths": "^3.14.1",
+    "typeorm": "~0.3.0",
+    "typescript": "^4.6.3"
   }
 }

spec/Database.spec.ts

@@ -1,27 +1,28 @@
 import { expect } from 'chai'
 
-import { connection, connect, close } from './utils/testConnection'
+import { dataSource } from './utils/test-data-source'
 import { Database } from '../src/Database'
 
 describe('Database', () => {
   before(async () => {
-    await connect()
+    await dataSource.initialize()
   })
 
-  after(() => { close() })
+  after(() => { dataSource.destroy() })
 
   describe('.isAdapterFor', () => {
-    it('returns true when typeorm connection is given', () => {
-      expect(Database.isAdapterFor(connection)).to.equal(true)
-    })
-    it('returns false for any other data', () => {
-      expect(Database.isAdapterFor({})).to.equal(false)
+    it('returns true when typeorm DataSource is given', () => {
+      expect(Database.isAdapterFor(dataSource)).to.equal(true)
     })
+    // Test is irrelevent because isAdapterFor is typed
+    // it('returns false for any other data', () => {
+    //   expect(Database.isAdapterFor()).to.equal(false)
+    // })
   })
 
   describe('#resources', () => {
     it('returns all entities', async () => {
-      expect(new Database(connection).resources()).to.have.lengthOf(3)
+      expect(new Database(dataSource).resources()).to.have.lengthOf(3)
     })
   })
 })

spec/Property.spec.ts

@@ -3,13 +3,13 @@ import { expect } from 'chai'
 import { ColumnMetadata } from 'typeorm/metadata/ColumnMetadata'
 import { Property } from '../src/Property'
 import { Car } from './entities/Car'
-import { connect, close } from './utils/testConnection'
+import { dataSource } from './utils/test-data-source'
 
 describe('Property', () => {
   let columns: Array<ColumnMetadata>
 
   before(async () => {
-    await connect()
+    await dataSource.initialize()
   })
 
   beforeEach(() => {
@@ -18,7 +18,7 @@ describe('Property', () => {
 
   after(async () => {
     await Car.delete({})
-    close()
+    dataSource.destroy()
   })
 
   describe('#name', () => {

spec/Resource.spec.ts

@@ -4,7 +4,7 @@ import { validate } from 'class-validator'
 
 import { Car } from './entities/Car'
 import { CarDealer } from './entities/CarDealer'
-import { connect, close } from './utils/testConnection'
+import { dataSource } from './utils/test-data-source'
 
 import { Resource } from '../src/Resource'
 import { CarBuyer } from './entities/CarBuyer'
@@ -22,7 +22,7 @@ describe('Resource', () => {
   }
 
   before(async () => {
-    await connect()
+    await dataSource.initialize()
   })
 
   beforeEach(async () => {
@@ -33,7 +33,7 @@ describe('Resource', () => {
   })
 
   after(async () => {
-    close()
+    dataSource.destroy()
   })
 
   describe('.isAdapterFor', () => {
@@ -68,12 +68,12 @@ describe('Resource', () => {
 
   describe('#properties', () => {
     it('returns all the properties', () => {
-      expect(resource.properties()).to.have.lengthOf(13)
+      expect(resource.properties()).to.have.lengthOf(12)
     })
 
     it('returns all properties with the correct position', () => {
       expect(resource.properties().map((property) => property.position())).to.deep.equal([
-        0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12,
+        0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11,
       ])
     })
   })
@@ -138,23 +138,29 @@ describe('Resource', () => {
 
     it('stores Column with defined name property', async () => {
       const params = await resource.create(data)
-      const storedRecord = await Car.findOne(params.carId) as Car
+      const reference: any = {}
+      reference[resource.idName()] = params.carId
+      const storedRecord: Car|null = await Car.findOneBy(reference)
 
-      expect(storedRecord.streetNumber).to.equal(data.streetNumber)
+      expect(storedRecord?.streetNumber).to.equal(data.streetNumber)
     })
 
     it('stores number Column with property as string', async () => {
       const params = await resource.create(data)
-      const storedRecord = await Car.findOne(params.carId) as Car
+      const reference: any = {}
+      reference[resource.idName()] = params.carId
+      const storedRecord: Car|null = await Car.findOneBy(reference)
 
-      expect(storedRecord.stringAge).to.equal(4)
+      expect(storedRecord?.stringAge).to.equal(4)
     })
 
     it('stores mixed type properties', async () => {
       const params = await resource.create(data)
-      const storedRecord = await Car.findOne(params.carId) as Car
+      const reference: any = {}
+      reference[resource.idName()] = params.carId
+      const storedRecord: Car|null = await Car.findOneBy(reference)
 
-      expect(storedRecord.meta).to.deep.equal({
+      expect(storedRecord?.meta).to.deep.equal({
         title: data['meta.title'],
         description: data['meta.description'],
       })
@@ -218,7 +224,7 @@ describe('Resource', () => {
       })
       const recordInDb = await resource.findOne((record && record.id()) as string)
 
-      expect(recordInDb && recordInDb.param('name')).to.equal(ford)
+      expect(recordInDb && recordInDb.get('name')).to.equal(ford)
     })
 
     it('throws error when wrong name is given', async () => {
@@ -274,7 +280,7 @@ describe('Resource', () => {
 
     afterEach(async () => {
       await Car.delete(carParams.carId)
-      await CarDealer.delete(carDealer)
+      await CarDealer.delete(carDealer.id)
     })
 
     it('deletes the resource', async () => {

spec/entities/Car.ts

@@ -60,9 +60,9 @@ export class Car extends BaseEntity {
   public carDealerId: number;
 
   @ManyToOne(() => CarBuyer, (carBuyer) => carBuyer.cars)
-  // @JoinColumn({
-  //   name: 'car_buyer_id',
-  // })
+  @JoinColumn({
+    name: 'car_buyer_id',
+  })
   public carBuyer: CarBuyer;
 
   @Column({ name: 'car_buyer_id', type: 'uuid', nullable: true })

spec/entities/CarBuyer.ts

@@ -4,13 +4,17 @@ import { Car } from './Car'
 
 @Entity()
 export class CarBuyer extends BaseEntity {
-  @PrimaryGeneratedColumn('uuid')
+  @PrimaryGeneratedColumn('uuid', {
+    name: 'car_buyer_id',
+  })
   public carBuyerId: string;
 
   @Column()
   @IsDefined()
   public name: string;
 
-  @OneToMany(() => Car, (car) => car.carDealer)
+  @OneToMany(() => Car, (car) => car.carDealer, {
+    cascade: true,
+  })
   public cars: Array<Car>;
 }

spec/entities/CarDealer.ts

@@ -4,13 +4,17 @@ import { Car } from './Car'
 
 @Entity()
 export class CarDealer extends BaseEntity {
-  @PrimaryGeneratedColumn()
+  @PrimaryGeneratedColumn({
+    name: 'car_dealer_id',
+  })
   public id: string;
 
   @Column()
   @IsDefined()
   public name: string;
 
-  @OneToMany(() => Car, (car) => car.carDealer)
+  @OneToMany(() => Car, (car) => car.carDealer, {
+    cascade: true,
+  })
   public cars: Array<Car>;
 }

ormconfig.js renamed to spec/utils/test-data-source.ts

@@ -1,18 +1,18 @@
-module.exports = {
+/* eslint-disable no-unused-expressions */
+// eslint-disable-next-line import/no-extraneous-dependencies
+import 'reflect-metadata'
+import { DataSource } from 'typeorm'
+
+export const dataSource = new DataSource({
   type: 'postgres',
   host: process.env.POSTGRES_HOST || 'localhost',
   port: +(process.env.POSTGRES_PORT || 5432),
   username: process.env.POSTGRES_USER || '',
-  password: process.env.POSTGRES_PASSWORD || '',
+  password: process.env.POSTGRES_PASSWORD || 'mysecretpassword',
   database: process.env.POSTGRES_DATABASE || 'database_test',
   entities: ['spec/entities/**/*.ts'],
   migrations: ['spec/migrations/**/*.ts'],
   subscribers: ['spec/subscribers/**/*.ts'],
   synchronize: true,
   logging: false,
-  cli: {
-    migrationsDir: 'spec/migrations',
-    entitiesDir: 'spec/entities',
-    subscribersDir: 'spec/subscribers',
-  },
-}
+})