feat(rest-crud): add option to create readonly rest-crud apis

Signed-off-by: Awais Saeed <[email protected]>

Author: awaissaeed530

docs/site/Rest-Crud-generator.md

@@ -27,6 +27,8 @@ src/datasources
 
 `--basePath` : _(Optional)_ base path of the model endpoint
 
+`--readonly` : _(Optional)_ create readonly APIs e.g find and count
+
 ### Configuration file
 
 This generator supports a config file with the following format, see the
@@ -37,7 +39,8 @@ file.
 {
   "datasource": "validDataSourceName",
   "model": "validModelName",
-  "basePath": "/<base-path>"
+  "basePath": "/<base-path>",
+  "readonly": "<boolean>"
 }
 ```
 
@@ -74,6 +77,9 @@ The tool will prompt you for:
   supplied from the command line with `--basePath` option or more than one
   models are selected, the prompt is skipped.
 
+- **Create readonly APIs.** _(readonly)_ If readonly had been supplied from the
+  command line with `--readonly` option, the prompt is skipped.
+
 ### Output
 
 Once all the prompts have been answered, the CLI will do the following for each

packages/cli/.yo-rc.json

@@ -1577,6 +1577,14 @@
           "name": "basePath",
           "hide": false
         },
+        "readonly": {
+          "type": "Boolean",
+          "required": false,
+          "description": "Create readonly APIs",
+          "default": false,
+          "name": "readonly",
+          "hide": false
+        },
         "config": {
           "type": "String",
           "alias": "c",

packages/cli/generators/rest-crud/index.js

@@ -26,6 +26,7 @@ const PROMPT_MESSAGE_MODEL = g.f(
 );
 const PROMPT_MESSAGE_DATA_SOURCE = g.f('Please select the datasource');
 const PROMPT_MESSAGE_BASE_PATH = g.f('Please specify the base path');
+const PROMPT_MESSAGE_READONLY = g.f('Do you want to create readonly APIs?');
 
 const ERROR_NO_DATA_SOURCES_FOUND = g.f('No datasources found at');
 const ERROR_NO_MODELS_FOUND = g.f('No models found at');
@@ -93,6 +94,13 @@ module.exports = class RestCrudGenerator extends ArtifactGenerator {
       description: g.f('A valid base path'),
     });
 
+    this.option('readonly', {
+      type: Boolean,
+      required: false,
+      description: g.f('Create readonly APIs'),
+      default: false,
+    });
+
     return super._setupGenerator();
   }
 
@@ -308,6 +316,20 @@ module.exports = class RestCrudGenerator extends ArtifactGenerator {
     }
   }
 
+  async promptReadonly() {
+    const props = await this.prompt([
+      {
+        type: 'confirm',
+        name: 'readonly',
+        message: PROMPT_MESSAGE_READONLY,
+        default: false,
+      },
+    ]);
+    if (props) {
+      this.artifactInfo.readonly = props.readonly;
+    }
+  }
+
   async scaffold() {
     if (this.shouldExit()) return false;
 

packages/cli/generators/rest-crud/templates/src/model-endpoints/model.rest-config-template.ts.ejs

@@ -6,5 +6,6 @@ const config: ModelCrudRestApiConfig = {
   pattern: 'CrudRest',
   dataSource: '<%= dataSourceName %>',
   basePath: '<%= basePath %>',
+  readonly: <%= readonly %>,
 };
 module.exports = config;

packages/cli/snapshots/integration/cli/cli.integration.snapshots.js

@@ -1635,6 +1635,14 @@ exports[`cli saves command metadata to .yo-rc.json 1`] = `
           "name": "basePath",
           "hide": false
         },
+        "readonly": {
+          "type": "Boolean",
+          "required": false,
+          "description": "Create readonly APIs",
+          "default": false,
+          "name": "readonly",
+          "hide": false
+        },
         "config": {
           "type": "String",
           "alias": "c",

packages/cli/snapshots/integration/generators/rest-crud.integration.snapshots.js

@@ -16,6 +16,7 @@ const config: ModelCrudRestApiConfig = {
   pattern: 'CrudRest',
   dataSource: 'dbmem',
   basePath: '/default-models',
+  readonly: false,
 };
 module.exports = config;
 

packages/cli/test/integration/generators/rest-crud.integration.js

@@ -193,6 +193,38 @@ describe('lb4 rest-crud', /** @this {Mocha.Suite} */ function () {
       assert.fileContent(expectedFile, /basePath: '\/decorator-defineds'/);
       assertApplicationTsFileUpdated();
     });
+
+    it('generates a single readonly rest-crud model endpoint with base path', async () => {
+      const singleModelPrompt = {
+        basePath: '/multiWords',
+        dataSourceName: 'dbmem',
+        modelNameList: ['MultiWord'],
+        readonly: true,
+      };
+
+      await testUtils
+        .executeGenerator(generator)
+        .inDir(sandbox.path, () =>
+          testUtils.givenLBProject(sandbox.path, {
+            additionalFiles: SANDBOX_FILES,
+          }),
+        )
+        .withPrompts(singleModelPrompt);
+
+      const expectedFile = path.join(
+        sandbox.path,
+        MODEL_ENDPOINT_PATH,
+        'multi-word.rest-config.ts',
+      );
+
+      assert.file(expectedFile);
+      assert.fileContent(
+        expectedFile,
+        /import \{MultiWord\} from '\.\.\/models'/,
+      );
+      assert.fileContent(expectedFile, /readonly: true/);
+      assertApplicationTsFileUpdated();
+    });
   });
 
   describe('all invalid parameters and usage', () => {

packages/rest-crud/README.md

@@ -43,7 +43,7 @@ export class TryApplication extends BootMixin(
 
 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:
+`pattern`, `dataSource`, `basePath`, and `readonly` properties:
 
 ```ts
 import {ModelCrudRestApiConfig} from '@loopback/rest-crud';
@@ -54,6 +54,7 @@ module.exports = <ModelCrudRestApiConfig>{
   pattern: 'CrudRest', // make sure to use this pattern
   dataSource: 'db',
   basePath: '/products',
+  readonly: false,
 };
 ```
 

packages/rest-crud/src/__tests__/unit/crud-rest-controller.unit.ts

@@ -23,4 +23,26 @@ describe('defineCrudRestController', () => {
 
     expect(CrudRestController.name).to.equal('ProductController');
   });
+
+  it('should generate controller based on Model name with readonly APIs', async () => {
+    @model()
+    class Product extends Entity {
+      @property({id: true})
+      id: number;
+    }
+
+    const CrudRestController = defineCrudRestController<
+      Product,
+      typeof Product.prototype.id,
+      'id'
+    >(Product, {basePath: '/products', readonly: true});
+
+    expect(CrudRestController.name).to.equal('ProductController');
+
+    // It should not generate create method
+    expect(CrudRestController.prototype.create).to.equal(undefined);
+
+    // It must generate read methods
+    expect(CrudRestController.prototype.find).not.equal(undefined);
+  });
 });

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

@@ -31,6 +31,10 @@ const debug = debugFactory('loopback:boot:crud-rest');
 export interface ModelCrudRestApiConfig extends ModelApiConfig {
   // E.g. '/products'
   basePath: string;
+  /**
+   * If true, the generated controller only has find and count APIs
+   */
+  readonly?: boolean;
 }
 
 @injectable(asModelApiBuilder)