feat(cli): add option to mark id field as not required in discover command

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

Author: awaissaeedforenax

docs/site/Discovering-models.md

@@ -47,6 +47,9 @@ placed. Default is `src/models`
 `--schema`: Specify the schema which the datasource will find the models to
 discover
 
+`--optionalId`: Specify if the Id property of generated models will be marked as
+not required
+
 ### Interactive Prompts
 
 Based on the option, the tool may prompt you for:

packages/cli/.yo-rc.json

@@ -1270,6 +1270,13 @@
           "description": "Specify the directory into which the `model.model.ts` files will be placed",
           "name": "outDir",
           "hide": false
+        },
+        "optionalId": {
+          "type": "Boolean",
+          "description": "Boolean to mark id property as optional field",
+          "default": false,
+          "name": "optionalId",
+          "hide": false
         }
       },
       "arguments": [

packages/cli/generators/discover/index.js

@@ -50,6 +50,12 @@ module.exports = class DiscoveryGenerator extends ArtifactGenerator {
       ),
       default: undefined,
     });
+
+    this.option('optionalId', {
+      type: Boolean,
+      description: g.f('Boolean to mark id property as optional field'),
+      default: false,
+    });
   }
 
   _setupGenerator() {
@@ -289,6 +295,18 @@ module.exports = class DiscoveryGenerator extends ArtifactGenerator {
       );
       debug(`Discovered: ${modelInfo.name}`);
     }
+
+    if (this.options.optionalId) {
+      // Find id property
+      const idProperty = Object.entries(
+        this.artifactInfo.modelDefinitions[0].properties,
+      ).find(x => x[1].id === 1)[0];
+
+      // Mark as not required
+      this.artifactInfo.modelDefinitions[0].properties[
+        idProperty
+      ].required = false;
+    }
   }
 
   /**

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

@@ -1328,6 +1328,13 @@ exports[`cli saves command metadata to .yo-rc.json 1`] = `
           "description": "Specify the directory into which the \`model.model.ts\` files will be placed",
           "name": "outDir",
           "hide": false
+        },
+        "optionalId": {
+          "type": "Boolean",
+          "description": "Boolean to mark id property as optional field",
+          "default": false,
+          "name": "optionalId",
+          "hide": false
         }
       },
       "arguments": [

packages/cli/snapshots/integration/generators/discover.integration.snapshots.js

@@ -7,6 +7,58 @@
 
 'use strict';
 
+exports[`lb4 discover integration model discovery does not mark id property as required based on optionalId option 1`] = `
+import {Entity, model, property} from '@loopback/repository';
+
+@model()
+export class Test extends Entity {
+  @property({
+    type: 'date',
+  })
+  dateTest?: string;
+
+  @property({
+    type: 'number',
+  })
+  numberTest?: number;
+
+  @property({
+    type: 'string',
+  })
+  stringTest?: string;
+
+  @property({
+    type: 'boolean',
+  })
+  booleanText?: boolean;
+
+  @property({
+    type: 'number',
+    scale: 0,
+    id: 1,
+  })
+  id?: number;
+
+  // Define well-known properties here
+
+  // Indexer property to allow additional data
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  [prop: string]: any;
+
+  constructor(data?: Partial<Test>) {
+    super(data);
+  }
+}
+
+export interface TestRelations {
+  // describe navigational properties here
+}
+
+export type TestWithRelations = Test & TestRelations;
+
+`;
+
+
 exports[`lb4 discover integration model discovery generates all models without prompts using --all --dataSource 1`] = `
 import {Entity, model, property} from '@loopback/repository';
 

packages/cli/test/integration/generators/discover.integration.js

@@ -50,6 +50,10 @@ const disableCamelCaseOptions = {
 const missingDataSourceOptions = {
   dataSource: 'foo',
 };
+const optionalIdOptions = {
+  ...baseOptions,
+  optionalId: true,
+};
 
 // Expected File Name
 const defaultExpectedTestModel = path.join(
@@ -155,5 +159,19 @@ describe('lb4 discover integration', () => {
           .withOptions(missingDataSourceOptions),
       ).to.be.rejectedWith(/Cannot find datasource/);
     });
+
+    it('does not mark id property as required based on optionalId option', async () => {
+      await testUtils
+        .executeGenerator(generator)
+        .inDir(sandbox.path, () =>
+          testUtils.givenLBProject(sandbox.path, {
+            additionalFiles: SANDBOX_FILES,
+          }),
+        )
+        .withOptions(optionalIdOptions);
+
+      assert.file(defaultExpectedTestModel);
+      expectFileToMatchSnapshot(defaultExpectedTestModel);
+    });
   });
 });