Merge pull request #1 from binarygeotech/binarygeotech-patch-1

Binarygeotech patch 1

Author: binarygeotech

README.md

@@ -162,11 +162,76 @@ export class TestSecuredController {
     }
 }
 ```
+You can now add the `entities` option to your app root module
+
+```typescript
+//app.module.ts
+import { Module } from '@nestjs/common';
+import { OAuth2Module } from '@switchit/nestjs-oauth2-server';
+
+@Module({
+    imports: [
+        OAuth2Module.forRoot({
+            userLoader: new UserLoader(),
+            userValidator: new UserValidator(),
+            entities: [
+              ClientEntity,
+              AccessTokenEntity,
+            ],
+        }),
+    ],
+})
+export class AppModule {}
+```
+
+Also for async
+```typescript
+@Module({
+    imports: [
+        OAuth2Module.forRootAsync({
+            useFactory: () => ({
+                userLoader: new UserLoader(),
+                userValidator: new UserValidator(),
+                entities: [
+                  ClientEntity,
+                  AccessTokenEntity,
+                ],
+            })
+        }),
+    ],
+})
+```
+
+## Using custom entities
+
+**OPTIONAL**: You can also use custom `entities` either by extending from the on that comes with the module or create a new entity that conforms with the module's entities.
+e.g
+```typescript
+...
+import { ClientEntity as OClientEntity } from '@switchit/nestjs-oauth2-server/dist/domain/client.entity';
+
+@Entity('...')
+@Unique(['client_id'])
+export class ClientEntity extends OClientEntity {
+  ...
+}
+```
+
+```typescript
+...
+import { ClientEntity } from './client.entity'; // Use your client entity here
+import { AccessTokenEntity as OAccessTokenEntity } from '@switchit/nestjs-oauth2-server/dist/domain/access-token.entity';
+
+@Entity('...')
+export class AccessTokenEntity extends OAccessTokenEntity {
+  ...
+}
+```
 
 ## Adding the entities to your TypeORM configuration
 
 **IMPORTANT**: The module comes with entities you have to add the configuration `node_modules/@switchit/**/*.entity.js`
-to let typeorm scan your entities or add them to the `entitie` configuration variable in TypeORM.
+to let typeorm scan your entities or add them to the `entities` configuration variable in TypeORM.
 
 ## Using the global validation pipes
 
@@ -184,4 +249,4 @@ async function bootstrap() {
   await app.listen(3000);
 }
 bootstrap();
-```
+```

lib/app/oauth2-core.module.ts

@@ -87,15 +87,17 @@ export class Oauth2CoreModule implements OnModuleInit {
             },
             inject: [OAUTH2_SERVER_OPTIONS],
         };
+        
+        const typeOrmEntities = options.entities || [
+            ClientEntity,
+            AccessTokenEntity,
+        ];
 
         return {
             module: Oauth2CoreModule,
             imports: [
                 CqrsModule,
-                TypeOrmModule.forFeature([
-                    ClientEntity,
-                    AccessTokenEntity,
-                ]),
+                TypeOrmModule.forFeature(typeOrmEntities),
             ],
             controllers: [
                 Oauth2Controller
@@ -142,15 +144,17 @@ export class Oauth2CoreModule implements OnModuleInit {
             inject: [OAUTH2_SERVER_OPTIONS],
         };
 
+        const typeOrmEntities = options.entities || [
+            ClientEntity,
+            AccessTokenEntity,
+        ];
+
         return {
             module: Oauth2CoreModule,
             imports: [
                 ...(options.imports || []),
                 CqrsModule,
-                TypeOrmModule.forFeature([
-                    ClientEntity,
-                    AccessTokenEntity,
-                ]),
+                TypeOrmModule.forFeature(typeOrmEntities),
             ],
             providers: [
                 ...providers,

lib/domain/access-token.entity.ts

@@ -45,6 +45,6 @@ export class AccessTokenEntity {
     @Column('timestamp', {name: 'created_on', nullable: false, default: () => 'now()'})
     createdAt: Date;
 
-    @Column({name: 'created_from', type: 'jsonb', nullable: true})
+    @Column({name: 'created_from', type: 'json', nullable: true})
     createdFrom: OAuth2Request;
 }