feat(repository): add support for relational query (#6)

* feat(repository): add support for relational query

Supported relations are `@hasOne`, `@hasMany`, `@hasMany through`,
`@referencesMany` and `@belongsTo`. No Extra configuration
needed to use them, inclusion requests are parsed from `include` filter itself.

* fix: remove dependency from juggler datasource

SequelizeDataSource no longer extends juggler.Datasource,
and SequelizeCrudRepository implements it's own inclusion resolvers

BREAKING CHANGE: `SequelizeRepository` is renamed to `SequelizeCrudRepository`

* test(repository): add test cases for relations

namely for fields, order and limit filter along with createAll,
updateAll, delete and relations such as `@hasOne`, `@hasMany`, `@belongsTo`
`@hasMany through`, `@referencesMany` and for INNER JOIN using `required: true` flag

Author: shubhamp-sf

.gitignore

@@ -62,3 +62,5 @@ typings/
 
 # Cache used by TypeScript's incremental build
 *.tsbuildinfo
+
+/src/sequelize/usercrud.sequelize.repository.base.ts

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "loopback4-sequelize",
   "version": "1.0.0",
-  "description": "Loopback 4 extension that provides Sequelize powered repository methods",
+  "description": "Loopback 4 Extension That Provides Sequelize Crud Repository Compatible With Default Loopback Models.",
   "keywords": [
     "loopback-extension",
     "loopback",
@@ -68,6 +68,8 @@
     "@types/node": "^14.18.26",
     "cz-conventional-changelog": "^3.3.0",
     "eslint": "^8.22.0",
+    "pg": "^8.8.0",
+    "pg-hstore": "^2.3.4",
     "semantic-release": "^19.0.5",
     "source-map-support": "^0.5.21",
     "sqlite3": "^5.1.2",

package.json

@@ -0,0 +1,38 @@
+import {
+  repository,
+} from '@loopback/repository';
+import {
+  param,
+  get,
+  getModelSchemaRef,
+} from '@loopback/rest';
+import {
+  Book,
+  Category,
+} from '../models';
+import {BookRepository} from '../repositories';
+
+export class BookCategoryController {
+  constructor(
+    @repository(BookRepository)
+    public bookRepository: BookRepository,
+  ) { }
+
+  @get('/books/{id}/category', {
+    responses: {
+      '200': {
+        description: 'Category belonging to Book',
+        content: {
+          'application/json': {
+            schema: {type: 'array', items: getModelSchemaRef(Category)},
+          },
+        },
+      },
+    },
+  })
+  async getCategory(
+    @param.path.number('id') id: typeof Book.prototype.id,
+  ): Promise<Category> {
+    return this.bookRepository.category(id);
+  }
+}

src/__tests__/fixtures/controllers/book-category.controller.ts

@@ -0,0 +1,186 @@
+import {
+  Count,
+  CountSchema,
+  Filter,
+  FilterExcludingWhere,
+  repository,
+  Where,
+} from '@loopback/repository';
+import {
+  del,
+  get,
+  getModelSchemaRef,
+  param,
+  patch,
+  post,
+  put,
+  requestBody,
+  response,
+} from '@loopback/rest';
+import {Book} from '../models';
+import {BookRepository} from '../repositories';
+import {TestControllerBase} from './test.controller.base';
+
+export class BookController extends TestControllerBase {
+  constructor(
+    @repository(BookRepository)
+    public bookRepository: BookRepository,
+  ) {
+    super(bookRepository);
+  }
+
+  @post('/books')
+  @response(200, {
+    description: 'Book model instance',
+    content: {'application/json': {schema: getModelSchemaRef(Book)}},
+  })
+  async create(
+    @requestBody({
+      content: {
+        'application/json': {
+          schema: getModelSchemaRef(Book, {
+            title: 'NewBook',
+            exclude: ['id'],
+          }),
+        },
+      },
+    })
+    book: Omit<Book, 'id'>,
+  ): Promise<Book> {
+    return this.bookRepository.create(book);
+  }
+
+  @post('/books-bulk')
+  @response(200, {
+    description: 'Book model instances',
+    content: {
+      'application/json': {
+        schema: {
+          type: 'array',
+          items: getModelSchemaRef(Book),
+        },
+      },
+    },
+  })
+  async createAll(
+    @requestBody({
+      content: {
+        'application/json': {
+          schema: {
+            type: 'array',
+            items: getModelSchemaRef(Book, {
+              title: 'NewBook',
+              exclude: ['id'],
+            }),
+          },
+        },
+      },
+    })
+    books: Array<Omit<Book, 'id'>>,
+  ): Promise<Book[]> {
+    return this.bookRepository.createAll(books);
+  }
+
+  @get('/books/count')
+  @response(200, {
+    description: 'Book model count',
+    content: {'application/json': {schema: CountSchema}},
+  })
+  async count(@param.where(Book) where?: Where<Book>): Promise<Count> {
+    return this.bookRepository.count(where);
+  }
+
+  @get('/books')
+  @response(200, {
+    description: 'Array of Book model instances',
+    content: {
+      'application/json': {
+        schema: {
+          type: 'array',
+          items: getModelSchemaRef(Book, {includeRelations: true}),
+        },
+      },
+    },
+  })
+  async find(@param.filter(Book) filter?: Filter<Book>): Promise<Book[]> {
+    return this.bookRepository.find(filter);
+  }
+
+  @patch('/books')
+  @response(200, {
+    description: 'Book PATCH success count',
+    content: {'application/json': {schema: CountSchema}},
+  })
+  async updateAll(
+    @requestBody({
+      content: {
+        'application/json': {
+          schema: getModelSchemaRef(Book, {partial: true}),
+        },
+      },
+    })
+    book: Book,
+    @param.where(Book) where?: Where<Book>,
+  ): Promise<Count> {
+    return this.bookRepository.updateAll(book, where);
+  }
+
+  @get('/books/{id}')
+  @response(200, {
+    description: 'Book model instance',
+    content: {
+      'application/json': {
+        schema: getModelSchemaRef(Book, {includeRelations: true}),
+      },
+    },
+  })
+  async findById(
+    @param.path.number('id') id: number,
+    @param.filter(Book, {exclude: 'where'}) filter?: FilterExcludingWhere<Book>,
+  ): Promise<Book> {
+    return this.bookRepository.findById(id, filter);
+  }
+
+  @patch('/books/{id}')
+  @response(204, {
+    description: 'Book PATCH success',
+  })
+  async updateById(
+    @param.path.number('id') id: number,
+    @requestBody({
+      content: {
+        'application/json': {
+          schema: getModelSchemaRef(Book, {partial: true}),
+        },
+      },
+    })
+    book: Book,
+  ): Promise<void> {
+    await this.bookRepository.updateById(id, book);
+  }
+
+  @put('/books/{id}')
+  @response(204, {
+    description: 'Book PUT success',
+  })
+  async replaceById(
+    @param.path.number('id') id: number,
+    @requestBody() book: Book,
+  ): Promise<void> {
+    await this.bookRepository.replaceById(id, book);
+  }
+
+  @del('/books/{id}')
+  @response(204, {
+    description: 'Book DELETE success',
+  })
+  async deleteById(@param.path.number('id') id: number): Promise<void> {
+    await this.bookRepository.deleteById(id);
+  }
+
+  @get('/books/sync-sequelize-model')
+  @response(200)
+  async syncSequelizeModel(): Promise<void> {
+    await this.beforeEach({syncAll: true});
+  }
+}