@loopback/cli 4.0.0-alpha.9 → 4.1.1

package/generators/openapi/templates/src/models/model-template.ts.ejs

@@ -0,0 +1,71 @@
+<%_
+const _properties = locals.properties || [];
+if (importProperty && baseModel) {
+-%>
+import {model, property, <%- baseModel %>} from '@loopback/repository';
+<%_
+} else if (importProperty) {
+-%>
+import {model, property} from '@loopback/repository';
+<%_
+} else {
+-%>
+import {model} from '@loopback/repository';
+<%_
+}
+
+imports.forEach(i => {
+-%>
+<%- i %>
+<%_
+});
+-%>
+
+/**
+ * The model class is generated from OpenAPI schema - <%- name %>
+ * <%- escapeComment(description) %>
+ */
+@model({name: '<%- name %>'})
+<%_ if (baseModel) { -%>
+export class <%- className %> extends <%- baseModel %> {
+  constructor(data?: Partial<<%- className %>>) {
+    super(data);
+  }
+
+<%_ } else { -%>
+export class <%- className %> {
+  constructor(data?: Partial<<%- className %>>) {
+    if (data != null && typeof data === 'object') {
+      Object.assign(this, data);
+    }
+  }
+
+<%_ } -%>
+  <%_ for (const p of _properties) { -%>
+  /**
+  <%_ const _comment = escapeComment(p.description);
+    if (_comment) {
+  -%>
+   * <%- _comment %>
+  <%_ } else { -%>
+   *
+  <%_ } -%>
+   */
+<%_ if (p.comment) { -%>
+  // <%- p.comment %>
+<%_ } -%>
+<%_ if (p.decoration) { -%>
+  <%- p.decoration %>
+<%_ } -%>
+  <%- p.signature %>
+
+  <%_ } -%>
+}
+
+export interface <%- className %>Relations {
+  // describe navigational properties here
+}
+
+export type <%- className %>WithRelations = <%- className %> & <%- className %>Relations;
+
+

package/generators/openapi/templates/src/models/type-template.ts.ejs

@@ -0,0 +1,13 @@
+<%_
+imports.forEach(i => {
+-%>
+<%- i %>
+<%_
+});
+-%>
+/**
+ * The model type is generated from OpenAPI schema - <%- name %>
+ * <%- escapeComment(description) %>
+ */
+export type <%- className %> = <%- declaration %>;
+

package/generators/openapi/templates/src/services/service-proxy-template.ts.ejs

@@ -0,0 +1,55 @@
+import {inject, Provider} from '@loopback/core';
+import {getService} from '@loopback/service-proxy';
+import {<%- dataSourceClassName %>} from '../datasources';
+
+<%_
+imports.forEach(i => {
+-%>
+<%- i %>
+<%_
+});
+-%>
+
+/**
+ * The service interface is generated from OpenAPI spec with operations tagged
+ * by <%- tag || '<no-tag>' %>.
+<%_ const _comment = escapeComment(description);
+  if (_comment) {
+-%>
+ * <%- _comment %>
+<%_ } -%>
+ */
+export interface <%- serviceClassName %> {
+  <%_ for (const m of methods) { -%>
+  /**
+  <%_ for (const c of m.comments) {
+    const _comment = escapeComment(c);
+    if (_comment) {
+  -%>
+   * <%- _comment %>
+  <%_ }
+   } -%>
+   */
+  <%_ if (usePositionalParams !== false) { -%>
+  <%- m.signatureForInterface %>;
+  <%_ } else { -%>
+  <%- m.signatureForNamedParams %>;
+  <%_ } -%>
+
+  <%_ } -%>
+}
+
+export class <%- serviceClassName %>Provider implements Provider<<%- serviceClassName %>> {
+  constructor(
+    // <%- dataSourceName %> must match the name property in the datasource json file
+    @inject('datasources.<%- dataSourceName %>')
+    protected dataSource: <%- dataSourceClassName %> = new <%- dataSourceClassName %>(),
+  ) {}
+
+  async value(): Promise<<%- serviceClassName %>> {
+    const service = await getService<{apis: {'<%- tag || 'default' %>': <%- serviceClassName %>}}>(
+      this.dataSource,
+    );
+    return service.apis['<%- tag || 'default' %>'];
+  }
+}

package/generators/openapi/utils.js

@@ -0,0 +1,322 @@
+// Copyright IBM Corp. and LoopBack contributors 2018,2020. All Rights Reserved.
+// Node module: @loopback/cli
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+'use strict';
+const fs = require('fs');
+const util = require('util');
+const _ = require('lodash');
+const json5 = require('json5');
+const url = require('url');
+
+const utils = require('../../lib/utils');
+const debug = require('../../lib/debug')('openapi-generator');
+
+/**
+ * Convert OpenAPI schema to JSON schema draft 4
+ */
+const oasToJsonSchema4 = require('@openapi-contrib/openapi-schema-to-json-schema');
+
+/**
+ * Convert a string to title case
+ * @param {string} str
+ */
+function titleCase(str) {
+  return _.startCase(_.camelCase(str)).replace(/\s/g, '');
+}
+
+/**
+ * Check if a given key is openapi extension (x-)
+ * @param {string} key
+ */
+function isExtension(key) {
+  return typeof key === 'string' && key.startsWith('x-');
+}
+
+/**
+ * Dump the json object for debugging
+ * @param {string} msg Message
+ * @param {object} obj The json object
+ */
+function debugJson(msg, obj) {
+  if (debug.enabled) {
+    debug('%s: %s', msg, util.inspect(obj, {depth: 10}));
+  }
+}
+
+/**
+ * Validate a url or file path for the open api spec
+ * @param {string} specUrlStr
+ */
+function validateUrlOrFile(specUrlStr) {
+  if (!specUrlStr) {
+    return 'API spec url or file path is required.';
+  }
+  const specUrl = url.parse(specUrlStr);
+  if (specUrl.protocol === 'http:' || specUrl.protocol === 'https:') {
+    return true;
+  } else {
+    const stat = fs.existsSync(specUrlStr) && fs.statSync(specUrlStr);
+    if (stat && stat.isFile()) {
+      return true;
+    } else {
+      return util.format('Path %s is not a file.', specUrlStr);
+    }
+  }
+}
+
+/**
+ * JavaScript keywords
+ */
+const JS_KEYWORDS = [
+  'break',
+  'case',
+  'catch',
+  'class',
+  'const',
+  'continue',
+  'debugger',
+  'default',
+  'delete',
+  'do',
+  'else',
+  'export',
+  'extends',
+  'finally',
+  'for',
+  'function',
+  'if',
+  'import',
+  'in',
+  'instanceof',
+  'new',
+  'return',
+  'super',
+  'switch',
+  'this',
+  'throw',
+  'try',
+  'typeof',
+  'var',
+  'void',
+  'while',
+  'with',
+  'yield',
+  'enum',
+  'implements',
+  'interface',
+  'let',
+  'package',
+  'private',
+  'protected',
+  'public',
+  'static',
+  'await',
+  'abstract',
+  'boolean',
+  'byte',
+  'char',
+  'double',
+  'final',
+  'float',
+  'goto',
+  'int',
+  'long',
+  'native',
+  'short',
+  'synchronized',
+  'throws',
+  'transient',
+  'volatile',
+  'null',
+  'true',
+  'false',
+];
+
+/**
+ * Avoid tslint error - Shadowed name: 'requestBody'
+ */
+const DECORATOR_NAMES = ['operation', 'param', 'requestBody'];
+
+const SAFE_IDENTIFER = /^[a-zA-Z_$][0-9a-zA-Z_$]*$/;
+
+/**
+ * Escape the name to be a JavaScript identifier. If the name happens to be one
+ * of the JavaScript keywords, a `_` prefix will be added. Otherwise, it will
+ * be converted using camelCase.
+ *
+ * For example,
+ * - `default` -> `_default`
+ * - `my-name` -> 'myName'
+ *
+ * @param {string} name
+ */
+function escapeIdentifier(name) {
+  if (JS_KEYWORDS.includes(name)) {
+    return '_' + name;
+  }
+  if (!name.match(SAFE_IDENTIFER)) {
+    name = _.camelCase(name);
+  }
+  if (DECORATOR_NAMES.includes(name)) {
+    return '_' + name;
+  }
+  return name;
+}
+
+/**
+ * Escape the property if it's not a valid JavaScript identifer
+ * @param {string} name
+ */
+function escapePropertyName(name) {
+  if (JS_KEYWORDS.includes(name) || !name.match(SAFE_IDENTIFER)) {
+    return printSpecObject(name);
+  }
+  return name;
+}
+
+/**
+ * Escape a string to be used as a block comment
+ *
+ * @param {string} comment
+ */
+function escapeComment(comment) {
+  comment = comment || '';
+  comment = comment.replace(/\/\*/g, '\\/*').replace(/\*\//g, '*\\/');
+  return utils.wrapText(comment, 76);
+}
+
+/**
+ * Clone an OpenAPI spec. When a `$ref` is encountered, we store it as `x-$ref`
+ * and keep the stringified original value as `x-$original-value`. These
+ * metadata allows us to access the original object after `$ref` is resolved
+ * and dereferenced by the parser.
+ *
+ * @param {*} spec An OpenAPI spec object
+ */
+function cloneSpecObject(spec) {
+  return _.cloneDeepWith(spec, item => {
+    /**
+     * A yaml object below produces `null` for `servers.url`
+     * ```yaml
+     * servers:
+     * - url:
+     *   description: null url for testing
+     * ```
+     */
+    if (item != null && item.$ref) {
+      const copy = _.cloneDeep(item);
+      return {
+        ...copy,
+        // Store the original item in `x-$original`
+        'x-$original-value': json5.stringify(item, null, 2),
+        // Keep `$ref` as `x-$ref` as `$ref` will be removed during dereferencing
+        'x-$ref': item.$ref,
+      };
+    }
+  });
+}
+
+/**
+ * Print an OpenAPI spec object as JavaScript object literal. The original value
+ * is used if `$ref` is resolved.
+ * @param {*} specObject - An OpenAPI spec object such as `Parameter` or `Operation`.
+ */
+function printSpecObject(specObject) {
+  return json5.stringify(
+    specObject,
+    (key, value) => {
+      // Restore the original value from `x-$original-value`
+      if (value != null && value['x-$ref']) {
+        return json5.parse(value['x-$original-value']);
+      }
+      return value;
+    },
+    2,
+  );
+}
+
+/**
+ * Restore the OpenAPI spec object to its original value
+ * @param {object} specObject - OpenAPI spec object
+ */
+function restoreSpecObject(specObject) {
+  return _.cloneDeepWith(specObject, value => {
+    // Restore the original value from `x-$original-value`
+    if (value != null && value['x-$ref']) {
+      return json5.parse(value['x-$original-value']);
+    }
+    // Return `undefined` so that child items are cloned too
+    return undefined;
+  });
+}
+
+/**
+ * Convert OpenAPI schema to JSON Schema Draft 7
+ * @param {object} oasSchema - OpenAPI schema
+ */
+function toJsonSchema(oasSchema) {
+  oasSchema = restoreSpecObject(oasSchema);
+  let jsonSchema = oasToJsonSchema4(oasSchema);
+  delete jsonSchema['$schema'];
+  // See https://json-schema.org/draft-06/json-schema-release-notes.html
+  if (jsonSchema.id) {
+    // id => $id
+    jsonSchema.$id = jsonSchema.id;
+    delete jsonSchema.id;
+  }
+  jsonSchema = _.cloneDeepWith(jsonSchema, value => {
+    if (value == null) return value;
+    let changed = false;
+    if (typeof value.exclusiveMinimum === 'boolean') {
+      // exclusiveMinimum + minimum (boolean + number) => exclusiveMinimum (number)
+      if (value.exclusiveMinimum) {
+        value.exclusiveMinimum = value.minimum;
+        delete value.minimum;
+      } else {
+        delete value.exclusiveMinimum;
+      }
+      changed = true;
+    }
+    if (typeof value.exclusiveMaximum === 'boolean') {
+      // exclusiveMaximum + maximum (boolean + number) => exclusiveMaximum (number)
+      if (value.exclusiveMaximum) {
+        value.exclusiveMaximum = value.maximum;
+        delete value.maximum;
+      } else {
+        delete value.exclusiveMaximum;
+      }
+      changed = true;
+    }
+    return changed ? value : undefined;
+  });
+  return jsonSchema;
+}
+
+/**
+ * Convert OpenAPI schema to JSON schema draft 7 and print it as a JavaScript
+ * object literal
+ * @param {object} oasSchema - OpenAPI schema
+ */
+function printJsonSchema(oasSchema) {
+  const jsonSchema = toJsonSchema(oasSchema);
+  return printSpecObject(jsonSchema);
+}
+
+module.exports = {
+  isExtension,
+  titleCase,
+  debug,
+  debugJson,
+  toFileName: utils.toFileName,
+  camelCase: utils.camelCase,
+  escapeIdentifier,
+  escapePropertyName,
+  escapeComment,
+  printSpecObject,
+  cloneSpecObject,
+  toJsonSchema,
+  printJsonSchema,
+  validateUrlOrFile,
+};

package/generators/project/templates/.eslintignore

@@ -0,0 +1,4 @@
+node_modules/
+dist/
+coverage/
+.eslintrc.js

package/generators/project/templates/.eslintrc.js.ejs

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: '@loopback/eslint-config',
+};

package/generators/project/templates/.mocharc.json

@@ -0,0 +1,5 @@
+{
+  "exit": true,
+  "recursive": true,
+  "require": "source-map-support/register"
+}

package/generators/project/templates/.prettierignore

@@ -1,4 +1,2 @@
 dist
-dist6
-api-docs
 *.json

package/generators/project/templates/.prettierrc

@@ -2,5 +2,6 @@
   "bracketSpacing": false,
   "singleQuote": true,
   "printWidth": 80,
-  "trailingComma": "all"
+  "trailingComma": "all",
+  "arrowParens": "avoid"
 }

package/generators/project/templates/.vscode/launch.json

@@ -0,0 +1,38 @@
+{
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Launch Program",
+      "skipFiles": [
+        "<node_internals>/**"
+      ],
+      "program": "${workspaceFolder}/dist/index.js",
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Run Mocha tests",
+      "program": "${workspaceRoot}/node_modules/mocha/bin/_mocha",
+      "runtimeArgs": [
+        "-r",
+        "${workspaceRoot}/node_modules/source-map-support/register"
+      ],
+      "cwd": "${workspaceRoot}",
+      "autoAttachChildProcesses": true,
+      "args": [
+        "--config",
+        "${workspaceRoot}/.mocharc.json",
+        "${workspaceRoot}/dist/__tests__/**/*.js",
+        "-t",
+        "0"
+      ]
+    },
+    {
+      "type": "node",
+      "request": "attach",
+      "name": "Attach to Process",
+      "port": 5858
+    }
+  ]
+}

package/generators/project/templates/.vscode/settings.json

@@ -0,0 +1,32 @@
+{
+  "editor.rulers": [80],
+  "editor.tabCompletion": "on",
+  "editor.tabSize": 2,
+  "editor.trimAutoWhitespace": true,
+  "editor.formatOnSave": true,
+  "editor.codeActionsOnSave": {
+    "source.organizeImports": true,
+    "source.fixAll.eslint": true
+  },
+
+  "files.exclude": {
+    "**/.DS_Store": true,
+    "**/.git": true,
+    "**/.hg": true,
+    "**/.svn": true,
+    "**/CVS": true,
+    "dist": true,
+  },
+  "files.insertFinalNewline": true,
+  "files.trimTrailingWhitespace": true,
+
+  "typescript.tsdk": "./node_modules/typescript/lib",
+  "typescript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyBraces": false,
+  "typescript.preferences.quoteStyle": "single",
+  "eslint.run": "onSave",
+  "eslint.nodePath": "./node_modules",
+  "eslint.validate": [
+    "javascript",
+    "typescript"
+  ]
+}

package/generators/project/templates/.vscode/tasks.json

@@ -0,0 +1,29 @@
+{
+  // See https://go.microsoft.com/fwlink/?LinkId=733558
+  // for the documentation about the tasks.json format
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Watch and Compile Project",
+      "type": "shell",
+      "command": "npm",
+      "args": ["--silent", "run", "build:watch"],
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      },
+      "problemMatcher": "$tsc-watch"
+    },
+    {
+      "label": "Build, Test and Lint",
+      "type": "shell",
+      "command": "npm",
+      "args": ["--silent", "run", "test:dev"],
+      "group": {
+        "kind": "test",
+        "isDefault": true
+      },
+      "problemMatcher": ["$tsc", "$eslint-compact", "$eslint-stylish"]
+    }
+  ]
+}

package/generators/project/templates/DEVELOPING.md

@@ -0,0 +1,36 @@
+# Developer's Guide
+
+We use Visual Studio Code for developing LoopBack and recommend the same to our
+users.
+
+## VSCode setup
+
+Install the following extensions:
+
+ - [eslint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
+ - [prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
+
+## Development workflow
+
+### Visual Studio Code
+
+1. Start the build task (Cmd+Shift+B) to run TypeScript compiler in the
+   background, watching and recompiling files as you change them. Compilation
+   errors will be shown in the VSCode's "PROBLEMS" window.
+
+2. Execute "Run Rest Task" from the Command Palette (Cmd+Shift+P) to re-run the
+   test suite and lint the code for both programming and style errors. Linting
+   errors will be shown in VSCode's "PROBLEMS" window. Failed tests are printed
+   to terminal output only.
+
+### Other editors/IDEs
+
+1. Open a new terminal window/tab and start the continuous build process via
+   `npm run build:watch`. It will run TypeScript compiler in watch mode,
+   recompiling files as you change them. Any compilation errors will be printed
+   to the terminal.
+
+2. In your main terminal window/tab, run `npm run test:dev` to re-run the test
+   suite and lint the code for both programming and style errors. You should run
+   this command manually whenever you have new changes to test. Test failures
+   and linter errors will be printed to the terminal.

package/generators/project/templates/_.gitignore

@@ -57,10 +57,8 @@ typings/
 # dotenv environment variables file
 .env
 
-# Generated apidocs
-api-docs/
-
 # Transpiled JavaScript files from Typescript
-dist/
-dist6/
+/dist
 
+# Cache used by TypeScript's incremental build
+*.tsbuildinfo