fix: support string type primary keys

Beta

Author: wojtek-krysiak

README.md

@@ -7,16 +7,16 @@ Installation: `yarn add @admin-bro/typeorm`
 ## Usage
 
 The plugin can be registered using standard `AdminBro.registerAdapter` method.
-
+o
 ```typescript
-import { Database, Resource } from "@admin-bro/typeorm";
+import { Database, Resource } from '@admin-bro/typeorm'
 import AdminBro from 'admin-bro'
 
 AdminBro.registerAdapter({ Database, Resource });
 
 // optional: if you use class-validator you have to inject this to resource.
 import { validate } from 'class-validator'
-Resource.validate = validate;
+Resource.validate = validate
 ```
 
 ## Example
@@ -28,16 +28,16 @@ import {
     createConnection,
     ManyToOne,
     RelationId
-} from 'typeorm';
-import * as express from 'express';
-import { Database, Resource } from '@admin-bro/typeorm';
+} from 'typeorm'
+import * as express from 'express'
+import { Database, Resource } from '@admin-bro/typeorm'
 import { validate } from 'class-validator'
 
-import AdminBro from 'admin-bro';
+import AdminBro from 'admin-bro'
 import * as AdminBroExpress from '@admin-bro/express'
 
-Resource.validate = validate;
-AdminBro.registerAdapter({ Database, Resource });
+Resource.validate = validate
+AdminBro.registerAdapter({ Database, Resource })
 
 @Entity()
 export class Person extends BaseEntity
@@ -67,26 +67,86 @@ export class Person extends BaseEntity
 
 ( async () =>
 {
-    const connection = await createConnection({/* ... */});
+    const connection = await createConnection({/* ... */})
 
     // Applying connection to model
-    Person.useConnection(connection);
+    Person.useConnection(connection)
 
     const adminBro = new AdminBro({
         // databases: [connection],
         resources: [
             { resource: Person, options: { parent: { name: 'foobar' } } }
         ], 
         rootPath: '/admin',
-    });
+    })
 
-    const app = express();
-    const router = AdminBroExpress.buildRouter(adminBro);
-    app.use(adminBro.options.rootPath, router);
-    app.listen(3000);
-})();
+    const app = express()
+    const router = AdminBroExpress.buildRouter(adminBro)
+    app.use(adminBro.options.rootPath, router)
+    app.listen(3000)
+})()
 ```
 
 ## ManyToOne
 
 Admin supports ManyToOne relationship but you also have to define @RealationId as stated in the example above.
+
+## Contribution
+
+### Running the example app
+
+If you want to set this up locally this is the suggested process:
+
+1. fork the repo
+2. Install dependencies
+
+```
+yarn install
+```
+
+3. register this package as a (linked package)[https://classic.yarnpkg.com/en/docs/cli/link/]
+
+```
+yarn link
+```
+
+4. Setup example app
+
+Install all dependencies and use previously linked version of `@admin-bro/typeorm`.
+
+```
+cd example-app
+yarn install
+yarn link @admin-bro/typeorm
+```
+
+Optionally you might want to link your local version of `admin-bro` package
+
+5. Make sure you have all the envs set (which are defined in `example-app/ormconfig.js`)
+
+6. Build the package in watch mode
+
+(in the root folder)
+
+```
+yarn watch
+```
+
+6. run the app in the dev mode
+
+```
+cd example-app
+yarn start:dev
+```
+
+### Pull request
+
+Before you make a PR make sure all tests pass and your code wont causes linter errors.
+You can do this by running:
+
+```
+yarn lint
+yarn test
+```
+
+or with proper envs: `POSTGRES_USER=yourtestuser POSTGRES_DATABASE="database_test" yarn test`

example-app/src/entity/Car.ts

@@ -1,5 +1,6 @@
 import { BaseEntity, Entity, PrimaryGeneratedColumn, Column, RelationId, ManyToOne } from 'typeorm'
 import { User } from './User'
+import { Seller } from './Seller'
 
 @Entity()
 export class Car extends BaseEntity {
@@ -12,7 +13,13 @@ export class Car extends BaseEntity {
   @ManyToOne((type) => User, (user) => user.cars)
   owner: User;
 
+  @ManyToOne((type) => Seller, (seller) => seller.cars)
+  seller: User;
+
   // in order be able to fetch resources in admin-bro - we have to have id available
   @RelationId((car: Car) => car.owner)
   ownerId: number;
+
+  @RelationId((car: Car) => car.seller)
+  sellerId: string;
 }

example-app/src/entity/Seller.ts

@@ -0,0 +1,19 @@
+import { BaseEntity, Entity, PrimaryGeneratedColumn, Column, OneToMany } from 'typeorm'
+import { Car } from './Car'
+
+export enum UserRoles {
+  DESIGNER = 'designer',
+  CLIENT = 'client'
+}
+
+@Entity()
+export class Seller extends BaseEntity {
+  @PrimaryGeneratedColumn('uuid')
+  id: string;
+
+  @Column()
+  name: string;
+
+  @OneToMany((type) => Car, (car) => car.seller)
+  cars: Array<Car>
+}

example-app/src/index.ts

@@ -6,6 +6,7 @@ import { buildRouter } from '@admin-bro/express'
 import * as TypeormAdapter from '@admin-bro/typeorm'
 import { User } from './entity/User'
 import { Car } from './entity/Car'
+import { Seller } from './entity/Seller'
 
 AdminBro.registerAdapter(TypeormAdapter)
 
@@ -24,7 +25,7 @@ const run = async () => {
           },
         },
       },
-    }, Car],
+    }, Car, Seller],
   })
   const router = buildRouter(admin)