@loopback/rest-crud 0.11.1

package/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) IBM Corp. 2019.
+Node module: @loopback/rest-crud
+This project is licensed under the MIT License, full text below.
+
+--------
+
+MIT license
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,168 @@
+# @loopback/rest-crud
+
+REST API controller implementing default CRUD semantics.
+
+## Overview
+
+This module allows applications to quickly expose models via REST API without
+having to implement custom controller or repository classes.
+
+## Installation
+
+```sh
+npm install --save @loopback/rest-crud
+```
+
+## Basic use
+
+`@loopback/rest-crud` can be used along with the built-in `ModelApiBooter` to
+easily create a repository class and a controller class for your model. The
+following use is a simple approach for this creation, however, you can look at
+the "Advanced use" section instead for a more flexible approach.
+
+For the examples in the following sections, we are assuming a model named
+`Product` and a datasource named `db` have already been created.
+
+In your `src/application.ts` file:
+
+```ts
+// add the following import
+import {CrudRestComponent} from '@loopback/rest-crud';
+
+export class TryApplication extends BootMixin(
+  ServiceMixin(RepositoryMixin(RestApplication)),
+) {
+  constructor(options: ApplicationConfig = {}) {
+    // other code
+
+    // add the following line
+    this.component(CrudRestComponent);
+  }
+}
+```
+
+Create a new file for the configuration, e.g.
+`src/model-endpoints/product.rest-config.ts` that defines the `model`,
+`pattern`, `dataSource`, and `basePath` properties:
+
+```ts
+import {ModelCrudRestApiConfig} from '@loopback/rest-crud';
+import {Product} from '../models';
+
+module.exports = <ModelCrudRestApiConfig>{
+  model: Product,
+  pattern: 'CrudRest', // make sure to use this pattern
+  dataSource: 'db',
+  basePath: '/products',
+};
+```
+
+Now your `Product` model will have a default repository and default controller
+class defined without the need for a repository or controller class file.
+
+## Advanced use
+
+If you would like more flexibility, e.g. if you would only like to define a
+default `CrudRest` controller or repository, you can use the two helper methods
+(`defineCrudRestController` from `@loopback/rest-crud` and
+`defineCrudRepositoryClass` from `@loopback/repository`). These functions will
+help you create controllers and repositories using code.
+
+For the examples in the following sections, we are also assuming a model named
+`Product`, and a datasource named `db` have already been created.
+
+### Creating a CRUD Controller
+
+Here is how you would use `defineCrudRestController` for exposing the CRUD
+endpoints of an existing model with a respository.
+
+1. Create a REST CRUD controller class for your model.
+
+   ```ts
+   const ProductController = defineCrudRestController<
+     Product,
+     typeof Product.prototype.id,
+     'id'
+   >(Product, {basePath: '/products'});
+   ```
+
+2. Set up dependency injection for the `ProductController`.
+
+   ```ts
+   inject('repositories.ProductRepository')(ProductController, undefined, 0);
+   ```
+
+3. Register the controller with your application.
+
+   ```ts
+   app.controller(ProductController);
+   ```
+
+### Creating a CRUD repository
+
+Use the `defineCrudRepositoryClass` method to create named repositories (based
+on the Model) for your app.
+
+Usage example:
+
+```ts
+import {defineCrudRepositoryClass} from '@loopback/repository';
+
+const ProductRepository = defineCrudRepositoryClass(Product);
+this.repository(ProductRepository);
+inject('datasources.db')(ProductRepository, undefined, 0);
+```
+
+### Integrated example
+
+Here is an example of an app which uses `defineCrudRepositoryClass` and
+`defineCrudRestController` to fulfill its repository and controller
+requirements.
+
+```ts
+import {defineCrudRepositoryClass} from '@loopback/repository';
+
+export class TryApplication extends BootMixin(
+  ServiceMixin(RepositoryMixin(RestApplication)),
+) {
+  constructor(options: ApplicationConfig = {}) {
+    // ...
+  }
+
+  async boot(): Promise<void> {
+    await super.boot();
+
+    const ProductRepository = defineCrudRepositoryClass(Product);
+    const repoBinding = this.repository(ProductRepository);
+
+    inject('datasources.db')(ProductRepository, undefined, 0);
+
+    const ProductController = defineCrudRestController<
+      Product,
+      typeof Product.prototype.id,
+      'id'
+    >(Product, {basePath: '/products'});
+
+    inject(repoBinding.key)(ProductController, undefined, 0);
+    this.controller(ProductController);
+  }
+}
+```
+
+## Contributions
+
+- [Guidelines](https://github.com/loopbackio/loopback-next/blob/master/docs/CONTRIBUTING.md)
+- [Join the team](https://github.com/loopbackio/loopback-next/issues/110)
+
+## Tests
+
+Run `npm test` from the root folder.
+
+## Contributors
+
+See
+[all contributors](https://github.com/loopbackio/loopback-next/graphs/contributors).
+
+## License
+
+MIT

package/dist/crud-rest.api-builder.d.ts

@@ -0,0 +1,12 @@
+import { ModelApiBuilder, ModelApiConfig } from '@loopback/model-api-builder';
+import { ApplicationWithRepositories } from '@loopback/repository';
+import { Model } from '@loopback/rest';
+export interface ModelCrudRestApiConfig extends ModelApiConfig {
+    basePath: string;
+}
+export declare class CrudRestApiBuilder implements ModelApiBuilder {
+    readonly pattern: string;
+    build(application: ApplicationWithRepositories, modelClass: typeof Model & {
+        prototype: Model;
+    }, cfg: ModelApiConfig): Promise<void>;
+}

package/dist/crud-rest.api-builder.js

@@ -0,0 +1,86 @@
+"use strict";
+// Copyright IBM Corp. 2020. All Rights Reserved.
+// Node module: @loopback/rest-crud
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CrudRestApiBuilder = void 0;
+const tslib_1 = require("tslib");
+const core_1 = require("@loopback/core");
+const model_api_builder_1 = require("@loopback/model-api-builder");
+const repository_1 = require("@loopback/repository");
+const debug_1 = tslib_1.__importDefault(require("debug"));
+const _1 = require(".");
+const debug = debug_1.default('loopback:boot:crud-rest');
+let CrudRestApiBuilder = class CrudRestApiBuilder {
+    constructor() {
+        this.pattern = 'CrudRest';
+    }
+    build(application, modelClass, cfg) {
+        const modelName = modelClass.name;
+        const config = cfg;
+        if (!config.basePath) {
+            throw new Error(`Missing required field "basePath" in configuration for model ${modelName}.`);
+        }
+        if (!(modelClass.prototype instanceof repository_1.Entity)) {
+            throw new Error(`CrudRestController requires a model that extends 'Entity'. (Model name ${modelName} does not extend 'Entity')`);
+        }
+        const entityClass = modelClass;
+        let repoBindingName = `repositories.${entityClass.name}Repository`;
+        if (application.isBound(repoBindingName)) {
+            debug('Using the existing Repository binding %j', repoBindingName);
+        }
+        else {
+            // repository class does not exist
+            const repositoryClass = setupCrudRepository(entityClass, config);
+            application.repository(repositoryClass);
+            repoBindingName = repositoryClass.name;
+            debug('Registered repository class', repoBindingName);
+        }
+        const controllerClass = setupCrudRestController(entityClass, config);
+        application.controller(controllerClass);
+        debug('Registered controller class', controllerClass.name);
+        return Promise.resolve();
+    }
+};
+CrudRestApiBuilder = tslib_1.__decorate([
+    core_1.injectable(model_api_builder_1.asModelApiBuilder)
+], CrudRestApiBuilder);
+exports.CrudRestApiBuilder = CrudRestApiBuilder;
+/**
+ * Set up a CRUD Repository class for the given Entity class.
+ *
+ * @param entityClass - the Entity class the repository is built for
+ * @param config - configuration of the Entity class
+ */
+function setupCrudRepository(entityClass, config) {
+    const repositoryClass = repository_1.defineCrudRepositoryClass(entityClass);
+    injectFirstConstructorArg(repositoryClass, `datasources.${config.dataSource}`);
+    return repositoryClass;
+}
+/**
+ * Set up a CRUD Controller class for the given Entity class.
+ *
+ * @param entityClass - the Entity class the controller is built for
+ * @param config - configuration of the Entity class
+ */
+function setupCrudRestController(entityClass, config) {
+    const controllerClass = _1.defineCrudRestController(entityClass, 
+    // important - forward the entire config object to allow controller
+    // factories to accept additional (custom) config options
+    config);
+    injectFirstConstructorArg(controllerClass, `repositories.${entityClass.name}Repository`);
+    return controllerClass;
+}
+/**
+ * Inject given key into a given class constructor
+ *
+ * @param ctor - constructor for a class (e.g. a controller class)
+ * @param key - binding to use in order to resolve the value of the decorated
+ * constructor parameter or property
+ */
+function injectFirstConstructorArg(ctor, key) {
+    core_1.inject(key)(ctor, undefined, // constructor member
+    0);
+}
+//# sourceMappingURL=crud-rest.api-builder.js.map

package/dist/crud-rest.api-builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"crud-rest.api-builder.js","sourceRoot":"","sources":["../src/crud-rest.api-builder.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,mCAAmC;AACnC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,yCAMwB;AACxB,mEAIqC;AACrC,qDAM8B;AAE9B,0DAAiC;AACjC,wBAA2C;AAE3C,MAAM,KAAK,GAAG,eAAY,CAAC,yBAAyB,CAAC,CAAC;AAQtD,IAAa,kBAAkB,GAA/B,MAAa,kBAAkB;IAA/B;QACW,YAAO,GAAW,UAAU,CAAC;IAwCxC,CAAC;IAtCC,KAAK,CACH,WAAwC,EACxC,UAA6C,EAC7C,GAAmB;QAEnB,MAAM,SAAS,GAAG,UAAU,CAAC,IAAI,CAAC;QAClC,MAAM,MAAM,GAAG,GAA6B,CAAC;QAC7C,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE;YACpB,MAAM,IAAI,KAAK,CACb,gEAAgE,SAAS,GAAG,CAC7E,CAAC;SACH;QAED,IAAI,CAAC,CAAC,UAAU,CAAC,SAAS,YAAY,mBAAM,CAAC,EAAE;YAC7C,MAAM,IAAI,KAAK,CACb,0EAA0E,SAAS,4BAA4B,CAChH,CAAC;SACH;QACD,MAAM,WAAW,GAAG,UAAiD,CAAC;QAEtE,IAAI,eAAe,GAAG,gBAAgB,WAAW,CAAC,IAAI,YAAY,CAAC;QAEnE,IAAI,WAAW,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE;YACxC,KAAK,CAAC,0CAA0C,EAAE,eAAe,CAAC,CAAC;SACpE;aAAM;YACL,kCAAkC;YAClC,MAAM,eAAe,GAAG,mBAAmB,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;YACjE,WAAW,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;YACxC,eAAe,GAAG,eAAe,CAAC,IAAI,CAAC;YACvC,KAAK,CAAC,6BAA6B,EAAE,eAAe,CAAC,CAAC;SACvD;QAED,MAAM,eAAe,GAAG,uBAAuB,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;QACrE,WAAW,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;QACxC,KAAK,CAAC,6BAA6B,EAAE,eAAe,CAAC,IAAI,CAAC,CAAC;QAE3D,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;CACF,CAAA;AAzCY,kBAAkB;IAD9B,iBAAU,CAAC,qCAAiB,CAAC;GACjB,kBAAkB,CAyC9B;AAzCY,gDAAkB;AA2C/B;;;;;GAKG;AACH,SAAS,mBAAmB,CAC1B,WAAgD,EAChD,MAA8B;IAE9B,MAAM,eAAe,GAAG,sCAAyB,CAAC,WAAW,CAAC,CAAC;IAE/D,yBAAyB,CACvB,eAAe,EACf,eAAe,MAAM,CAAC,UAAU,EAAE,CACnC,CAAC;IAEF,OAAO,eAAe,CAAC;AACzB,CAAC;AAED;;;;;GAKG;AACH,SAAS,uBAAuB,CAC9B,WAAgD,EAChD,MAA8B;IAE9B,MAAM,eAAe,GAAG,2BAAwB,CAC9C,WAAW;IACX,mEAAmE;IACnE,yDAAyD;IACzD,MAAM,CACP,CAAC;IAEF,yBAAyB,CACvB,eAAe,EACf,gBAAgB,WAAW,CAAC,IAAI,YAAY,CAC7C,CAAC;IAEF,OAAO,eAAe,CAAC;AACzB,CAAC;AAED;;;;;;GAMG;AACH,SAAS,yBAAyB,CAChC,IAAoB,EACpB,GAAoB;IAEpB,aAAM,CAAC,GAAG,CAAC,CACT,IAAI,EACJ,SAAS,EAAE,qBAAqB;IAChC,CAAC,CACF,CAAC;AACJ,CAAC"}

package/dist/crud-rest.component.d.ts

@@ -0,0 +1,4 @@
+import { Binding, Component } from '@loopback/core';
+export declare class CrudRestComponent implements Component {
+    bindings: Binding[];
+}

package/dist/crud-rest.component.js

@@ -0,0 +1,16 @@
+"use strict";
+// Copyright IBM Corp. 2019,2020. All Rights Reserved.
+// Node module: @loopback/rest-crud
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CrudRestComponent = void 0;
+const core_1 = require("@loopback/core");
+const crud_rest_api_builder_1 = require("./crud-rest.api-builder");
+class CrudRestComponent {
+    constructor() {
+        this.bindings = [core_1.createBindingFromClass(crud_rest_api_builder_1.CrudRestApiBuilder)];
+    }
+}
+exports.CrudRestComponent = CrudRestComponent;
+//# sourceMappingURL=crud-rest.component.js.map

package/dist/crud-rest.component.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"crud-rest.component.js","sourceRoot":"","sources":["../src/crud-rest.component.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,mCAAmC;AACnC,+CAA+C;AAC/C,gEAAgE;;;AAEhE,yCAA0E;AAC1E,mEAA2D;AAE3D,MAAa,iBAAiB;IAA9B;QACE,aAAQ,GAAc,CAAC,6BAAsB,CAAC,0CAAkB,CAAC,CAAC,CAAC;IACrE,CAAC;CAAA;AAFD,8CAEC"}

package/dist/crud-rest.controller.d.ts

@@ -0,0 +1,60 @@
+import { Entity, EntityCrudRepository } from '@loopback/repository';
+/**
+ * This interface describes prototype members of the controller class
+ * returned by `defineCrudRestController`.
+ */
+export interface CrudRestController<T extends Entity, IdType, IdName extends keyof T, Relations extends object = {}> {
+    /**
+     * The backing repository used to access & modify model data.
+     */
+    readonly repository: EntityCrudRepository<T, IdType>;
+    /**
+     * Implementation of the endpoint `POST /`.
+     * @param data Model data
+     */
+    create(data: Omit<T, IdName>): Promise<T>;
+}
+/**
+ * Constructor of the controller class returned by `defineCrudRestController`.
+ */
+export interface CrudRestControllerCtor<T extends Entity, IdType, IdName extends keyof T, Relations extends object = {}> {
+    new (repository: EntityCrudRepository<T, IdType, Relations>): CrudRestController<T, IdType, IdName, Relations>;
+}
+/**
+ * Options to configure different aspects of a CRUD REST Controller.
+ */
+export interface CrudRestControllerOptions {
+    /**
+     * The base path where to "mount" the controller.
+     */
+    basePath: string;
+}
+/**
+ * Create (define) a CRUD Controller class for the given model.
+ *
+ * @example
+ *
+ * ```ts
+ * const ProductController = defineCrudRestController<
+ * Product,
+ * typeof Product.prototype.id,
+ * 'id'
+ * >(Product, {basePath: '/products'});
+ *
+ * inject('repositories.ProductRepository')(
+ *  ProductController,
+ *   undefined,
+ *   0,
+ * );
+ *
+ * app.controller(ProductController);
+ * ```
+ *
+ * @param modelCtor A model class, e.g. `Product`.
+ * @param options Configuration options, e.g. `{basePath: '/products'}`.
+ */
+export declare function defineCrudRestController<T extends Entity, IdType, IdName extends keyof T, Relations extends object = {}>(modelCtor: typeof Entity & {
+    prototype: T & {
+        [key in IdName]: IdType;
+    };
+}, options: CrudRestControllerOptions): CrudRestControllerCtor<T, IdType, IdName, Relations>;

package/dist/crud-rest.controller.js

@@ -0,0 +1,234 @@
+"use strict";
+// Copyright IBM Corp. 2019,2020. All Rights Reserved.
+// Node module: @loopback/rest-crud
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defineCrudRestController = void 0;
+const tslib_1 = require("tslib");
+const repository_1 = require("@loopback/repository");
+const rest_1 = require("@loopback/rest");
+const assert = require("assert");
+/**
+ * Create (define) a CRUD Controller class for the given model.
+ *
+ * @example
+ *
+ * ```ts
+ * const ProductController = defineCrudRestController<
+ * Product,
+ * typeof Product.prototype.id,
+ * 'id'
+ * >(Product, {basePath: '/products'});
+ *
+ * inject('repositories.ProductRepository')(
+ *  ProductController,
+ *   undefined,
+ *   0,
+ * );
+ *
+ * app.controller(ProductController);
+ * ```
+ *
+ * @param modelCtor A model class, e.g. `Product`.
+ * @param options Configuration options, e.g. `{basePath: '/products'}`.
+ */
+function defineCrudRestController(modelCtor, options) {
+    const modelName = modelCtor.name;
+    const idPathParam = {
+        name: 'id',
+        in: 'path',
+        schema: getIdSchema(modelCtor),
+    };
+    let CrudRestControllerImpl = class CrudRestControllerImpl {
+        constructor(repository) {
+            this.repository = repository;
+        }
+        async create(data) {
+            return this.repository.create(
+            // FIXME(bajtos) Improve repository API to support this use case
+            // with no explicit type-casts required
+            data);
+        }
+        async find(filter) {
+            return this.repository.find(filter);
+        }
+        async findById(id, filter) {
+            return this.repository.findById(id, filter);
+        }
+        async count(where) {
+            return this.repository.count(where);
+        }
+        async updateAll(data, where) {
+            return this.repository.updateAll(
+            // FIXME(bajtos) Improve repository API to support this use case
+            // with no explicit type-casts required
+            data, where);
+        }
+        async updateById(id, data) {
+            await this.repository.updateById(id, 
+            // FIXME(bajtos) Improve repository API to support this use case
+            // with no explicit type-casts required
+            data);
+        }
+        async replaceById(id, data) {
+            await this.repository.replaceById(id, data);
+        }
+        async deleteById(id) {
+            await this.repository.deleteById(id);
+        }
+    };
+    tslib_1.__decorate([
+        rest_1.post('/', {
+            ...response.model(200, `${modelName} instance created`, modelCtor),
+        }),
+        tslib_1.__param(0, body(modelCtor, {
+            title: `New${modelName}`,
+            exclude: modelCtor.getIdProperties(),
+        })),
+        tslib_1.__metadata("design:type", Function),
+        tslib_1.__metadata("design:paramtypes", [Object]),
+        tslib_1.__metadata("design:returntype", Promise)
+    ], CrudRestControllerImpl.prototype, "create", null);
+    tslib_1.__decorate([
+        rest_1.get('/', {
+            ...response.array(200, `Array of ${modelName} instances`, modelCtor, {
+                includeRelations: true,
+            }),
+        }),
+        tslib_1.__param(0, rest_1.param.filter(modelCtor)),
+        tslib_1.__metadata("design:type", Function),
+        tslib_1.__metadata("design:paramtypes", [Object]),
+        tslib_1.__metadata("design:returntype", Promise)
+    ], CrudRestControllerImpl.prototype, "find", null);
+    tslib_1.__decorate([
+        rest_1.get('/{id}', {
+            ...response.model(200, `${modelName} instance`, modelCtor, {
+                includeRelations: true,
+            }),
+        }),
+        tslib_1.__param(0, rest_1.param(idPathParam)),
+        tslib_1.__param(1, rest_1.param.query.object('filter', rest_1.getFilterSchemaFor(modelCtor, { exclude: 'where' }))),
+        tslib_1.__metadata("design:type", Function),
+        tslib_1.__metadata("design:paramtypes", [Object, Object]),
+        tslib_1.__metadata("design:returntype", Promise)
+    ], CrudRestControllerImpl.prototype, "findById", null);
+    tslib_1.__decorate([
+        rest_1.get('/count', {
+            ...response(200, `${modelName} count`, { schema: repository_1.CountSchema }),
+        }),
+        tslib_1.__param(0, rest_1.param.where(modelCtor)),
+        tslib_1.__metadata("design:type", Function),
+        tslib_1.__metadata("design:paramtypes", [Object]),
+        tslib_1.__metadata("design:returntype", Promise)
+    ], CrudRestControllerImpl.prototype, "count", null);
+    tslib_1.__decorate([
+        rest_1.patch('/', {
+            ...response(200, `Count of ${modelName} models updated`, {
+                schema: repository_1.CountSchema,
+            }),
+        }),
+        tslib_1.__param(0, body(modelCtor, { partial: true })),
+        tslib_1.__param(1, rest_1.param.where(modelCtor)),
+        tslib_1.__metadata("design:type", Function),
+        tslib_1.__metadata("design:paramtypes", [Object, Object]),
+        tslib_1.__metadata("design:returntype", Promise)
+    ], CrudRestControllerImpl.prototype, "updateAll", null);
+    tslib_1.__decorate([
+        rest_1.patch('/{id}', {
+            responses: {
+                '204': { description: `${modelName} was updated` },
+            },
+        }),
+        tslib_1.__param(0, rest_1.param(idPathParam)),
+        tslib_1.__param(1, body(modelCtor, { partial: true })),
+        tslib_1.__metadata("design:type", Function),
+        tslib_1.__metadata("design:paramtypes", [Object, Object]),
+        tslib_1.__metadata("design:returntype", Promise)
+    ], CrudRestControllerImpl.prototype, "updateById", null);
+    tslib_1.__decorate([
+        rest_1.put('/{id}', {
+            responses: {
+                '204': { description: `${modelName} was updated` },
+            },
+        }),
+        tslib_1.__param(0, rest_1.param(idPathParam)),
+        tslib_1.__param(1, body(modelCtor)),
+        tslib_1.__metadata("design:type", Function),
+        tslib_1.__metadata("design:paramtypes", [Object, Object]),
+        tslib_1.__metadata("design:returntype", Promise)
+    ], CrudRestControllerImpl.prototype, "replaceById", null);
+    tslib_1.__decorate([
+        rest_1.del('/{id}', {
+            responses: {
+                '204': { description: `${modelName} was deleted` },
+            },
+        }),
+        tslib_1.__param(0, rest_1.param(idPathParam)),
+        tslib_1.__metadata("design:type", Function),
+        tslib_1.__metadata("design:paramtypes", [Object]),
+        tslib_1.__metadata("design:returntype", Promise)
+    ], CrudRestControllerImpl.prototype, "deleteById", null);
+    CrudRestControllerImpl = tslib_1.__decorate([
+        rest_1.api({ basePath: options.basePath, paths: {} }),
+        tslib_1.__metadata("design:paramtypes", [Object])
+    ], CrudRestControllerImpl);
+    const controllerName = modelName + 'Controller';
+    const defineNamedController = new Function('controllerClass', `return class ${controllerName} extends controllerClass {}`);
+    const controller = defineNamedController(CrudRestControllerImpl);
+    assert.equal(controller.name, controllerName);
+    return controller;
+}
+exports.defineCrudRestController = defineCrudRestController;
+function getIdSchema(modelCtor) {
+    var _a;
+    const idProp = modelCtor.getIdProperties()[0];
+    const modelSchema = rest_1.jsonToSchemaObject(rest_1.getJsonSchema(modelCtor));
+    return ((_a = modelSchema.properties) !== null && _a !== void 0 ? _a : {})[idProp];
+}
+// Temporary implementation of a short-hand version of `@requestBody`
+// See https://github.com/loopbackio/loopback-next/issues/3493
+function body(modelCtor, options) {
+    return rest_1.requestBody({
+        content: {
+            'application/json': {
+                schema: rest_1.getModelSchemaRef(modelCtor, options),
+            },
+        },
+    });
+}
+// Temporary workaround for a missing `@response` decorator
+// See https://github.com/loopbackio/loopback-next/issues/1672
+// Please note this is just a workaround, the real helper should be implemented
+// as a decorator that contributes OpenAPI metadata in a way that allows
+// `@post` to merge the responses with the metadata provided at operation level
+function response(statusCode, description, payload) {
+    return {
+        responses: {
+            [`${statusCode}`]: {
+                description,
+                content: {
+                    'application/json': payload,
+                },
+            },
+        },
+    };
+}
+(function (response) {
+    function model(statusCode, description, modelCtor, options) {
+        return response(statusCode, description, {
+            schema: rest_1.getModelSchemaRef(modelCtor, options),
+        });
+    }
+    response.model = model;
+    function array(statusCode, description, modelCtor, options) {
+        return response(statusCode, description, {
+            schema: {
+                type: 'array',
+                items: rest_1.getModelSchemaRef(modelCtor, options),
+            },
+        });
+    }
+    response.array = array;
+})(response || (response = {}));
+//# sourceMappingURL=crud-rest.controller.js.map

package/dist/crud-rest.controller.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"crud-rest.controller.js","sourceRoot":"","sources":["../src/crud-rest.controller.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,mCAAmC;AACnC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,qDAS8B;AAC9B,yCAkBwB;AACxB,iCAAkC;AAuElC;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAgB,wBAAwB,CAMtC,SAAqE,EACrE,OAAkC;IAElC,MAAM,SAAS,GAAG,SAAS,CAAC,IAAI,CAAC;IACjC,MAAM,WAAW,GAAoB;QACnC,IAAI,EAAE,IAAI;QACV,EAAE,EAAE,MAAM;QACV,MAAM,EAAE,WAAW,CAAC,SAAS,CAAC;KAC/B,CAAC;IAGF,IAAM,sBAAsB,GAA5B,MAAM,sBAAsB;QAG1B,YACkB,UAAsD;YAAtD,eAAU,GAAV,UAAU,CAA4C;QACrE,CAAC;QAKJ,KAAK,CAAC,MAAM,CAKV,IAAqB;YAErB,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM;YAC3B,gEAAgE;YAChE,uCAAuC;YACvC,IAAqB,CACtB,CAAC;QACJ,CAAC;QAOD,KAAK,CAAC,IAAI,CAER,MAAkB;YAElB,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACtC,CAAC;QAOD,KAAK,CAAC,QAAQ,CACQ,EAAU,EAK9B,MAAgC;YAEhC,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QAC9C,CAAC;QAKD,KAAK,CAAC,KAAK,CAET,KAAgB;YAEhB,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACtC,CAAC;QAOD,KAAK,CAAC,SAAS,CACqB,IAAgB,EAElD,KAAgB;YAEhB,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS;YAC9B,gEAAgE;YAChE,uCAAuC;YACvC,IAAqB,EACrB,KAAK,CACN,CAAC;QACJ,CAAC;QAOD,KAAK,CAAC,UAAU,CACM,EAAU,EACI,IAAgB;YAElD,MAAM,IAAI,CAAC,UAAU,CAAC,UAAU,CAC9B,EAAE;YACF,gEAAgE;YAChE,uCAAuC;YACvC,IAAqB,CACtB,CAAC;QACJ,CAAC;QAOD,KAAK,CAAC,WAAW,CACK,EAAU,EACb,IAAO;YAExB,MAAM,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QAC9C,CAAC;QAOD,KAAK,CAAC,UAAU,CAAqB,EAAU;YAC7C,MAAM,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QACvC,CAAC;KACF,CAAA;IA3GC;QAHC,WAAI,CAAC,GAAG,EAAE;YACT,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,SAAS,mBAAmB,EAAE,SAAS,CAAC;SACnE,CAAC;QAEC,mBAAA,IAAI,CAAC,SAAS,EAAE;YACf,KAAK,EAAE,MAAM,SAAS,EAAE;YACxB,OAAO,EAAE,SAAS,CAAC,eAAe,EAAiB;SACpD,CAAC,CAAA;;;;wDAQH;IAOD;QALC,UAAG,CAAC,GAAG,EAAE;YACR,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,EAAE,YAAY,SAAS,YAAY,EAAE,SAAS,EAAE;gBACnE,gBAAgB,EAAE,IAAI;aACvB,CAAC;SACH,CAAC;QAEC,mBAAA,YAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;;;;sDAIzB;IAOD;QALC,UAAG,CAAC,OAAO,EAAE;YACZ,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,SAAS,WAAW,EAAE,SAAS,EAAE;gBACzD,gBAAgB,EAAE,IAAI;aACvB,CAAC;SACH,CAAC;QAEC,mBAAA,YAAK,CAAC,WAAW,CAAC,CAAA;QAClB,mBAAA,YAAK,CAAC,KAAK,CAAC,MAAM,CACjB,QAAQ,EACR,yBAAkB,CAAC,SAAS,EAAE,EAAC,OAAO,EAAE,OAAO,EAAC,CAAC,CAClD,CAAA;;;;0DAIF;IAKD;QAHC,UAAG,CAAC,QAAQ,EAAE;YACb,GAAG,QAAQ,CAAC,GAAG,EAAE,GAAG,SAAS,QAAQ,EAAE,EAAC,MAAM,EAAE,wBAAW,EAAC,CAAC;SAC9D,CAAC;QAEC,mBAAA,YAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;;;;uDAIxB;IAOD;QALC,YAAK,CAAC,GAAG,EAAE;YACV,GAAG,QAAQ,CAAC,GAAG,EAAE,YAAY,SAAS,iBAAiB,EAAE;gBACvD,MAAM,EAAE,wBAAW;aACpB,CAAC;SACH,CAAC;QAEC,mBAAA,IAAI,CAAC,SAAS,EAAE,EAAC,OAAO,EAAE,IAAI,EAAC,CAAC,CAAA;QAChC,mBAAA,YAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;;;;2DASxB;IAOD;QALC,YAAK,CAAC,OAAO,EAAE;YACd,SAAS,EAAE;gBACT,KAAK,EAAE,EAAC,WAAW,EAAE,GAAG,SAAS,cAAc,EAAC;aACjD;SACF,CAAC;QAEC,mBAAA,YAAK,CAAC,WAAW,CAAC,CAAA;QAClB,mBAAA,IAAI,CAAC,SAAS,EAAE,EAAC,OAAO,EAAE,IAAI,EAAC,CAAC,CAAA;;;;4DAQlC;IAOD;QALC,UAAG,CAAC,OAAO,EAAE;YACZ,SAAS,EAAE;gBACT,KAAK,EAAE,EAAC,WAAW,EAAE,GAAG,SAAS,cAAc,EAAC;aACjD;SACF,CAAC;QAEC,mBAAA,YAAK,CAAC,WAAW,CAAC,CAAA;QAClB,mBAAA,IAAI,CAAC,SAAS,CAAC,CAAA;;;;6DAGjB;IAOD;QALC,UAAG,CAAC,OAAO,EAAE;YACZ,SAAS,EAAE;gBACT,KAAK,EAAE,EAAC,WAAW,EAAE,GAAG,SAAS,cAAc,EAAC;aACjD;SACF,CAAC;QACgB,mBAAA,YAAK,CAAC,WAAW,CAAC,CAAA;;;;4DAEnC;IApHG,sBAAsB;QAD3B,UAAG,CAAC,EAAC,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE,EAAC,CAAC;;OACvC,sBAAsB,CAqH3B;IAED,MAAM,cAAc,GAAG,SAAS,GAAG,YAAY,CAAC;IAChD,MAAM,qBAAqB,GAAG,IAAI,QAAQ,CACxC,iBAAiB,EACjB,gBAAgB,cAAc,6BAA6B,CAC5D,CAAC;IACF,MAAM,UAAU,GAAG,qBAAqB,CAAC,sBAAsB,CAAC,CAAC;IACjE,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;IAC9C,OAAO,UAAU,CAAC;AACpB,CAAC;AAhJD,4DAgJC;AAED,SAAS,WAAW,CAClB,SAAyC;;IAEzC,MAAM,MAAM,GAAG,SAAS,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,CAAC;IAC9C,MAAM,WAAW,GAAG,yBAAkB,CACpC,oBAAa,CAAC,SAAS,CAAC,CACT,CAAC;IAClB,OAAO,CAAC,MAAA,WAAW,CAAC,UAAU,mCAAI,EAAE,CAAC,CAAC,MAAM,CAAiB,CAAC;AAChE,CAAC;AAED,qEAAqE;AACrE,8DAA8D;AAC9D,SAAS,IAAI,CACX,SAAoC,EACpC,OAA8B;IAE9B,OAAO,kBAAW,CAAC;QACjB,OAAO,EAAE;YACP,kBAAkB,EAAE;gBAClB,MAAM,EAAE,wBAAiB,CAAC,SAAS,EAAE,OAAO,CAAC;aAC9C;SACF;KACF,CAAC,CAAC;AACL,CAAC;AAED,2DAA2D;AAC3D,8DAA8D;AAC9D,+EAA+E;AAC/E,wEAAwE;AACxE,+EAA+E;AAC/E,SAAS,QAAQ,CACf,UAAkB,EAClB,WAAmB,EACnB,OAAwB;IAExB,OAAO;QACL,SAAS,EAAE;YACT,CAAC,GAAG,UAAU,EAAE,CAAC,EAAE;gBACjB,WAAW;gBACX,OAAO,EAAE;oBACP,kBAAkB,EAAE,OAAO;iBAC5B;aACF;SACF;KACF,CAAC;AACJ,CAAC;AAED,WAAU,QAAQ;IAChB,SAAgB,KAAK,CACnB,UAAkB,EAClB,WAAmB,EACnB,SAAoC,EACpC,OAA8B;QAE9B,OAAO,QAAQ,CAAC,UAAU,EAAE,WAAW,EAAE;YACvC,MAAM,EAAE,wBAAiB,CAAC,SAAS,EAAE,OAAO,CAAC;SAC9C,CAAC,CAAC;IACL,CAAC;IATe,cAAK,QASpB,CAAA;IAED,SAAgB,KAAK,CACnB,UAAkB,EAClB,WAAmB,EACnB,SAAoC,EACpC,OAA8B;QAE9B,OAAO,QAAQ,CAAC,UAAU,EAAE,WAAW,EAAE;YACvC,MAAM,EAAE;gBACN,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE,wBAAiB,CAAC,SAAS,EAAE,OAAO,CAAC;aAC7C;SACF,CAAC,CAAC;IACL,CAAC;IAZe,cAAK,QAYpB,CAAA;AACH,CAAC,EAzBS,QAAQ,KAAR,QAAQ,QAyBjB"}

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * REST API controller implementing default CRUD semantics.
+ *
+ * @remarks
+ * Allows LoopBack 4 applications to quickly expose models via REST API without
+ * having to implement custom controller or repository classes.
+ *
+ * @packageDocumentation
+ */
+export { defineCrudRepositoryClass } from '@loopback/repository';
+export * from './crud-rest.api-builder';
+export * from './crud-rest.component';
+export * from './crud-rest.controller';

package/dist/index.js

@@ -0,0 +1,24 @@
+"use strict";
+// Copyright IBM Corp. 2019,2020. All Rights Reserved.
+// Node module: @loopback/rest-crud
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defineCrudRepositoryClass = void 0;
+const tslib_1 = require("tslib");
+/**
+ * REST API controller implementing default CRUD semantics.
+ *
+ * @remarks
+ * Allows LoopBack 4 applications to quickly expose models via REST API without
+ * having to implement custom controller or repository classes.
+ *
+ * @packageDocumentation
+ */
+// Re-export `defineCrudRepositoryClass` for backward-compatibility
+var repository_1 = require("@loopback/repository");
+Object.defineProperty(exports, "defineCrudRepositoryClass", { enumerable: true, get: function () { return repository_1.defineCrudRepositoryClass; } });
+tslib_1.__exportStar(require("./crud-rest.api-builder"), exports);
+tslib_1.__exportStar(require("./crud-rest.component"), exports);
+tslib_1.__exportStar(require("./crud-rest.controller"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,mCAAmC;AACnC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE;;;;;;;;GAQG;AAEH,mEAAmE;AACnE,mDAA+D;AAAvD,uHAAA,yBAAyB,OAAA;AACjC,kEAAwC;AACxC,gEAAsC;AACtC,iEAAuC"}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@loopback/rest-crud",
+  "description": "REST API controller implementing default CRUD semantics",
+  "version": "0.11.1",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "author": "IBM Corp.",
+  "copyright.owner": "IBM Corp.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/loopbackio/loopback-next.git",
+    "directory": "packages/rest-crud"
+  },
+  "engines": {
+    "node": "^10.16 || 12 || 14 || 16"
+  },
+  "scripts": {
+    "build": "lb-tsc",
+    "clean": "lb-clean loopback-rest-crud*.tgz dist *.tsbuildinfo package",
+    "pretest": "npm run build",
+    "test": "lb-mocha \"dist/__tests__/**/*.js\"",
+    "verify": "npm pack && tar xf loopback-rest-crud*.tgz && tree package && npm run clean"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "README.md",
+    "dist",
+    "src",
+    "!*/__tests__"
+  ],
+  "peerDependencies": {
+    "@loopback/core": "^2.17.0",
+    "@loopback/repository": "^3.7.2",
+    "@loopback/rest": "^10.0.1"
+  },
+  "dependencies": {
+    "@loopback/model-api-builder": "^2.3.3",
+    "debug": "^4.3.2",
+    "tslib": "^2.3.1"
+  },
+  "devDependencies": {
+    "@loopback/build": "^7.0.1",
+    "@loopback/core": "^2.17.0",
+    "@loopback/repository": "^3.7.2",
+    "@loopback/rest": "^10.0.1",
+    "@loopback/testlab": "^3.4.3",
+    "@types/debug": "^4.1.7",
+    "@types/node": "^10.17.60"
+  },
+  "gitHead": "1df36bb1ee2e513d9e197bd6010c4cfb296d50b8"
+}

package/src/crud-rest.api-builder.ts

@@ -0,0 +1,141 @@
+// Copyright IBM Corp. 2020. All Rights Reserved.
+// Node module: @loopback/rest-crud
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+import {
+  BindingSelector,
+  Constructor,
+  ControllerClass,
+  inject,
+  injectable,
+} from '@loopback/core';
+import {
+  asModelApiBuilder,
+  ModelApiBuilder,
+  ModelApiConfig,
+} from '@loopback/model-api-builder';
+import {
+  ApplicationWithRepositories,
+  Class,
+  defineCrudRepositoryClass,
+  Entity,
+  EntityCrudRepository,
+} from '@loopback/repository';
+import {Model} from '@loopback/rest';
+import debugFactory from 'debug';
+import {defineCrudRestController} from '.';
+
+const debug = debugFactory('loopback:boot:crud-rest');
+
+export interface ModelCrudRestApiConfig extends ModelApiConfig {
+  // E.g. '/products'
+  basePath: string;
+}
+
+@injectable(asModelApiBuilder)
+export class CrudRestApiBuilder implements ModelApiBuilder {
+  readonly pattern: string = 'CrudRest';
+
+  build(
+    application: ApplicationWithRepositories,
+    modelClass: typeof Model & {prototype: Model},
+    cfg: ModelApiConfig,
+  ): Promise<void> {
+    const modelName = modelClass.name;
+    const config = cfg as ModelCrudRestApiConfig;
+    if (!config.basePath) {
+      throw new Error(
+        `Missing required field "basePath" in configuration for model ${modelName}.`,
+      );
+    }
+
+    if (!(modelClass.prototype instanceof Entity)) {
+      throw new Error(
+        `CrudRestController requires a model that extends 'Entity'. (Model name ${modelName} does not extend 'Entity')`,
+      );
+    }
+    const entityClass = modelClass as typeof Entity & {prototype: Entity};
+
+    let repoBindingName = `repositories.${entityClass.name}Repository`;
+
+    if (application.isBound(repoBindingName)) {
+      debug('Using the existing Repository binding %j', repoBindingName);
+    } else {
+      // repository class does not exist
+      const repositoryClass = setupCrudRepository(entityClass, config);
+      application.repository(repositoryClass);
+      repoBindingName = repositoryClass.name;
+      debug('Registered repository class', repoBindingName);
+    }
+
+    const controllerClass = setupCrudRestController(entityClass, config);
+    application.controller(controllerClass);
+    debug('Registered controller class', controllerClass.name);
+
+    return Promise.resolve();
+  }
+}
+
+/**
+ * Set up a CRUD Repository class for the given Entity class.
+ *
+ * @param entityClass - the Entity class the repository is built for
+ * @param config - configuration of the Entity class
+ */
+function setupCrudRepository(
+  entityClass: typeof Entity & {prototype: Entity},
+  config: ModelCrudRestApiConfig,
+): Class<EntityCrudRepository<Entity, unknown>> {
+  const repositoryClass = defineCrudRepositoryClass(entityClass);
+
+  injectFirstConstructorArg(
+    repositoryClass,
+    `datasources.${config.dataSource}`,
+  );
+
+  return repositoryClass;
+}
+
+/**
+ * Set up a CRUD Controller class for the given Entity class.
+ *
+ * @param entityClass - the Entity class the controller is built for
+ * @param config - configuration of the Entity class
+ */
+function setupCrudRestController(
+  entityClass: typeof Entity & {prototype: Entity},
+  config: ModelCrudRestApiConfig,
+): ControllerClass {
+  const controllerClass = defineCrudRestController(
+    entityClass,
+    // important - forward the entire config object to allow controller
+    // factories to accept additional (custom) config options
+    config,
+  );
+
+  injectFirstConstructorArg(
+    controllerClass,
+    `repositories.${entityClass.name}Repository`,
+  );
+
+  return controllerClass;
+}
+
+/**
+ * Inject given key into a given class constructor
+ *
+ * @param ctor - constructor for a class (e.g. a controller class)
+ * @param key - binding to use in order to resolve the value of the decorated
+ * constructor parameter or property
+ */
+function injectFirstConstructorArg<T>(
+  ctor: Constructor<T>,
+  key: BindingSelector,
+) {
+  inject(key)(
+    ctor,
+    undefined, // constructor member
+    0, // the first argument
+  );
+}

package/src/crud-rest.component.ts

@@ -0,0 +1,11 @@
+// Copyright IBM Corp. 2019,2020. All Rights Reserved.
+// Node module: @loopback/rest-crud
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+import {Binding, Component, createBindingFromClass} from '@loopback/core';
+import {CrudRestApiBuilder} from './crud-rest.api-builder';
+
+export class CrudRestComponent implements Component {
+  bindings: Binding[] = [createBindingFromClass(CrudRestApiBuilder)];
+}

package/src/crud-rest.controller.ts

@@ -0,0 +1,348 @@
+// Copyright IBM Corp. 2019,2020. All Rights Reserved.
+// Node module: @loopback/rest-crud
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+import {
+  Count,
+  CountSchema,
+  DataObject,
+  Entity,
+  EntityCrudRepository,
+  Filter,
+  FilterExcludingWhere,
+  Where,
+} from '@loopback/repository';
+import {
+  api,
+  del,
+  get,
+  getFilterSchemaFor,
+  getJsonSchema,
+  getModelSchemaRef,
+  JsonSchemaOptions,
+  jsonToSchemaObject,
+  MediaTypeObject,
+  param,
+  ParameterObject,
+  patch,
+  post,
+  put,
+  requestBody,
+  ResponsesObject,
+  SchemaObject,
+} from '@loopback/rest';
+import assert = require('assert');
+
+// Ideally, this file should simply `export class CrudRestController<...>{}`
+// Unfortunately, that's not possible for several reasons.
+//
+// First of all, to correctly decorate methods and define schemas for request
+// and response bodies, we need to know the target model which will be used by
+// the controller. As a result, this file has to export a function that will
+// create a constructor class specific to the given model.
+//
+// Secondly, TypeScript does not allow decorators to be used in class
+// expressions - see https://github.com/microsoft/TypeScript/issues/7342.
+// As a result, we cannot write implement the factory as `return class ...`,
+// but have to define the class as an internal type and return the controller
+// constructor in a new statement.
+// Because the controller class is an internal type scoped to the body of the
+// factory function, we cannot use it to describe the return type. We must
+// explicitly provide the return type.
+//
+// To work around those issues, we use the following design:
+// - The interface `CrudRestController` describes controller methods (members)
+// - The type `CrudRestControllerCtor` describes the class constructor.
+// - `defineCrudRestController` returns `CrudRestControllerCtor` type.
+
+/**
+ * This interface describes prototype members of the controller class
+ * returned by `defineCrudRestController`.
+ */
+export interface CrudRestController<
+  T extends Entity,
+  IdType,
+  IdName extends keyof T,
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  Relations extends object = {},
+> {
+  /**
+   * The backing repository used to access & modify model data.
+   */
+  readonly repository: EntityCrudRepository<T, IdType>;
+
+  /**
+   * Implementation of the endpoint `POST /`.
+   * @param data Model data
+   */
+  create(data: Omit<T, IdName>): Promise<T>;
+}
+
+/**
+ * Constructor of the controller class returned by `defineCrudRestController`.
+ */
+export interface CrudRestControllerCtor<
+  T extends Entity,
+  IdType,
+  IdName extends keyof T,
+  Relations extends object = {},
+> {
+  new (
+    repository: EntityCrudRepository<T, IdType, Relations>,
+  ): CrudRestController<T, IdType, IdName, Relations>;
+}
+
+/**
+ * Options to configure different aspects of a CRUD REST Controller.
+ */
+export interface CrudRestControllerOptions {
+  /**
+   * The base path where to "mount" the controller.
+   */
+  basePath: string;
+}
+
+/**
+ * Create (define) a CRUD Controller class for the given model.
+ *
+ * @example
+ *
+ * ```ts
+ * const ProductController = defineCrudRestController<
+ * Product,
+ * typeof Product.prototype.id,
+ * 'id'
+ * >(Product, {basePath: '/products'});
+ *
+ * inject('repositories.ProductRepository')(
+ *  ProductController,
+ *   undefined,
+ *   0,
+ * );
+ *
+ * app.controller(ProductController);
+ * ```
+ *
+ * @param modelCtor A model class, e.g. `Product`.
+ * @param options Configuration options, e.g. `{basePath: '/products'}`.
+ */
+export function defineCrudRestController<
+  T extends Entity,
+  IdType,
+  IdName extends keyof T,
+  Relations extends object = {},
+>(
+  modelCtor: typeof Entity & {prototype: T & {[key in IdName]: IdType}},
+  options: CrudRestControllerOptions,
+): CrudRestControllerCtor<T, IdType, IdName, Relations> {
+  const modelName = modelCtor.name;
+  const idPathParam: ParameterObject = {
+    name: 'id',
+    in: 'path',
+    schema: getIdSchema(modelCtor),
+  };
+
+  @api({basePath: options.basePath, paths: {}})
+  class CrudRestControllerImpl
+    implements CrudRestController<T, IdType, IdName>
+  {
+    constructor(
+      public readonly repository: EntityCrudRepository<T, IdType, Relations>,
+    ) {}
+
+    @post('/', {
+      ...response.model(200, `${modelName} instance created`, modelCtor),
+    })
+    async create(
+      @body(modelCtor, {
+        title: `New${modelName}`,
+        exclude: modelCtor.getIdProperties() as (keyof T)[],
+      })
+      data: Omit<T, IdName>,
+    ): Promise<T> {
+      return this.repository.create(
+        // FIXME(bajtos) Improve repository API to support this use case
+        // with no explicit type-casts required
+        data as DataObject<T>,
+      );
+    }
+
+    @get('/', {
+      ...response.array(200, `Array of ${modelName} instances`, modelCtor, {
+        includeRelations: true,
+      }),
+    })
+    async find(
+      @param.filter(modelCtor)
+      filter?: Filter<T>,
+    ): Promise<(T & Relations)[]> {
+      return this.repository.find(filter);
+    }
+
+    @get('/{id}', {
+      ...response.model(200, `${modelName} instance`, modelCtor, {
+        includeRelations: true,
+      }),
+    })
+    async findById(
+      @param(idPathParam) id: IdType,
+      @param.query.object(
+        'filter',
+        getFilterSchemaFor(modelCtor, {exclude: 'where'}),
+      )
+      filter?: FilterExcludingWhere<T>,
+    ): Promise<T & Relations> {
+      return this.repository.findById(id, filter);
+    }
+
+    @get('/count', {
+      ...response(200, `${modelName} count`, {schema: CountSchema}),
+    })
+    async count(
+      @param.where(modelCtor)
+      where?: Where<T>,
+    ): Promise<Count> {
+      return this.repository.count(where);
+    }
+
+    @patch('/', {
+      ...response(200, `Count of ${modelName} models updated`, {
+        schema: CountSchema,
+      }),
+    })
+    async updateAll(
+      @body(modelCtor, {partial: true}) data: Partial<T>,
+      @param.where(modelCtor)
+      where?: Where<T>,
+    ): Promise<Count> {
+      return this.repository.updateAll(
+        // FIXME(bajtos) Improve repository API to support this use case
+        // with no explicit type-casts required
+        data as DataObject<T>,
+        where,
+      );
+    }
+
+    @patch('/{id}', {
+      responses: {
+        '204': {description: `${modelName} was updated`},
+      },
+    })
+    async updateById(
+      @param(idPathParam) id: IdType,
+      @body(modelCtor, {partial: true}) data: Partial<T>,
+    ): Promise<void> {
+      await this.repository.updateById(
+        id,
+        // FIXME(bajtos) Improve repository API to support this use case
+        // with no explicit type-casts required
+        data as DataObject<T>,
+      );
+    }
+
+    @put('/{id}', {
+      responses: {
+        '204': {description: `${modelName} was updated`},
+      },
+    })
+    async replaceById(
+      @param(idPathParam) id: IdType,
+      @body(modelCtor) data: T,
+    ): Promise<void> {
+      await this.repository.replaceById(id, data);
+    }
+
+    @del('/{id}', {
+      responses: {
+        '204': {description: `${modelName} was deleted`},
+      },
+    })
+    async deleteById(@param(idPathParam) id: IdType): Promise<void> {
+      await this.repository.deleteById(id);
+    }
+  }
+
+  const controllerName = modelName + 'Controller';
+  const defineNamedController = new Function(
+    'controllerClass',
+    `return class ${controllerName} extends controllerClass {}`,
+  );
+  const controller = defineNamedController(CrudRestControllerImpl);
+  assert.equal(controller.name, controllerName);
+  return controller;
+}
+
+function getIdSchema<T extends Entity>(
+  modelCtor: typeof Entity & {prototype: T},
+): SchemaObject {
+  const idProp = modelCtor.getIdProperties()[0];
+  const modelSchema = jsonToSchemaObject(
+    getJsonSchema(modelCtor),
+  ) as SchemaObject;
+  return (modelSchema.properties ?? {})[idProp] as SchemaObject;
+}
+
+// Temporary implementation of a short-hand version of `@requestBody`
+// See https://github.com/loopbackio/loopback-next/issues/3493
+function body<T extends Entity>(
+  modelCtor: Function & {prototype: T},
+  options?: JsonSchemaOptions<T>,
+) {
+  return requestBody({
+    content: {
+      'application/json': {
+        schema: getModelSchemaRef(modelCtor, options),
+      },
+    },
+  });
+}
+
+// Temporary workaround for a missing `@response` decorator
+// See https://github.com/loopbackio/loopback-next/issues/1672
+// Please note this is just a workaround, the real helper should be implemented
+// as a decorator that contributes OpenAPI metadata in a way that allows
+// `@post` to merge the responses with the metadata provided at operation level
+function response(
+  statusCode: number,
+  description: string,
+  payload: MediaTypeObject,
+): {responses: ResponsesObject} {
+  return {
+    responses: {
+      [`${statusCode}`]: {
+        description,
+        content: {
+          'application/json': payload,
+        },
+      },
+    },
+  };
+}
+
+namespace response {
+  export function model<T extends Entity>(
+    statusCode: number,
+    description: string,
+    modelCtor: Function & {prototype: T},
+    options?: JsonSchemaOptions<T>,
+  ) {
+    return response(statusCode, description, {
+      schema: getModelSchemaRef(modelCtor, options),
+    });
+  }
+
+  export function array<T extends Entity>(
+    statusCode: number,
+    description: string,
+    modelCtor: Function & {prototype: T},
+    options?: JsonSchemaOptions<T>,
+  ) {
+    return response(statusCode, description, {
+      schema: {
+        type: 'array',
+        items: getModelSchemaRef(modelCtor, options),
+      },
+    });
+  }
+}

package/src/index.ts

@@ -0,0 +1,20 @@
+// Copyright IBM Corp. 2019,2020. All Rights Reserved.
+// Node module: @loopback/rest-crud
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+/**
+ * REST API controller implementing default CRUD semantics.
+ *
+ * @remarks
+ * Allows LoopBack 4 applications to quickly expose models via REST API without
+ * having to implement custom controller or repository classes.
+ *
+ * @packageDocumentation
+ */
+
+// Re-export `defineCrudRepositoryClass` for backward-compatibility
+export {defineCrudRepositoryClass} from '@loopback/repository';
+export * from './crud-rest.api-builder';
+export * from './crud-rest.component';
+export * from './crud-rest.controller';