@loopback/model-api-builder 2.3.3

package/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) IBM Corp. 2019.
+Node module: @loopback/model-api-builder
+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,59 @@
+# @loopback/model-api-builder
+
+Types and helpers for packages contributing Model API builders.
+
+## Overview
+
+The `@loopback/model-api-builder` package provides a contract for extensions
+that contribute builders for repositories and controllers. Users provide both
+the model class and an extension. The extension is then used to build their
+repository and controller based on the model class.
+
+## Installation
+
+```sh
+npm install --save @loopback/model-api-builder
+```
+
+## Basic use
+
+An extension that contributes the repository and controller builders can be made
+by implementing `ModelApiBuilder`:
+
+```ts
+import {
+  asModelApiBuilder,
+  ModelApiBuilder,
+  ModelApiConfig,
+} from '@loopback/model-api-builder';
+
+@injectable(asModelApiBuilder)
+export class SampleApiBuilder implements ModelApiBuilder {
+  readonly pattern: string = 'Sample';
+
+  build(
+    application: ApplicationWithRepositories,
+    modelClass: typeof Model & {prototype: Model},
+    config: ModelApiConfig,
+  ): Promise<void> {
+    // define repository setup here
+    // ...
+    // define controller setup here
+    // ...
+  }
+}
+```
+
+## Contributions
+
+- [Guidelines](https://github.com/loopbackio/loopback-next/blob/master/docs/CONTRIBUTING.md)
+- [Join the team](https://github.com/loopbackio/loopback-next/issues/110)
+
+## Contributors
+
+See
+[all contributors](https://github.com/loopbackio/loopback-next/graphs/contributors).
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * A packge with types and helpers for packages contributing Model API builders.
+ *
+ * @remarks
+ * Provides a contract for extensions that contribute builders for repositories
+ * and controllers. Users provide both the model class and an extension. The
+ * extension is then used to build their repository and controller based on the
+ * model class.
+ *
+ * @packageDocumentation
+ */
+export * from './model-api-builder';
+export * from './model-api-config';

package/dist/index.js

@@ -0,0 +1,21 @@
+"use strict";
+// Copyright IBM Corp. 2019,2020. All Rights Reserved.
+// Node module: @loopback/model-api-builder
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+/**
+ * A packge with types and helpers for packages contributing Model API builders.
+ *
+ * @remarks
+ * Provides a contract for extensions that contribute builders for repositories
+ * and controllers. Users provide both the model class and an extension. The
+ * extension is then used to build their repository and controller based on the
+ * model class.
+ *
+ * @packageDocumentation
+ */
+tslib_1.__exportStar(require("./model-api-builder"), exports);
+tslib_1.__exportStar(require("./model-api-config"), 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,2CAA2C;AAC3C,+CAA+C;AAC/C,gEAAgE;;;AAEhE;;;;;;;;;;GAUG;AAEH,8DAAoC;AACpC,6DAAmC"}

package/dist/model-api-builder.d.ts

@@ -0,0 +1,20 @@
+import { BindingTemplate } from '@loopback/core';
+import { ApplicationWithRepositories, Model } from '@loopback/repository';
+import { ModelApiConfig } from './model-api-config';
+/**
+ * Extension Point name for Model API builders.
+ */
+export declare const MODEL_API_BUILDER_PLUGINS = "model-api-builders";
+/**
+ * Interface for extensions contributing custom API flavors.
+ */
+export interface ModelApiBuilder {
+    readonly pattern: string;
+    build(application: ApplicationWithRepositories, modelClass: typeof Model & {
+        prototype: Model;
+    }, config: ModelApiConfig): Promise<void>;
+}
+/**
+ * A binding template for model API extensions
+ */
+export declare const asModelApiBuilder: BindingTemplate;

package/dist/model-api-builder.js

@@ -0,0 +1,21 @@
+"use strict";
+// Copyright IBM Corp. 2019. All Rights Reserved.
+// Node module: @loopback/model-api-builder
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.asModelApiBuilder = exports.MODEL_API_BUILDER_PLUGINS = void 0;
+const core_1 = require("@loopback/core");
+/**
+ * Extension Point name for Model API builders.
+ */
+exports.MODEL_API_BUILDER_PLUGINS = 'model-api-builders';
+/**
+ * A binding template for model API extensions
+ */
+const asModelApiBuilder = binding => {
+    core_1.extensionFor(exports.MODEL_API_BUILDER_PLUGINS)(binding);
+    binding.tag({ namespace: 'model-api-builders' });
+};
+exports.asModelApiBuilder = asModelApiBuilder;
+//# sourceMappingURL=model-api-builder.js.map

package/dist/model-api-builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"model-api-builder.js","sourceRoot":"","sources":["../src/model-api-builder.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,2CAA2C;AAC3C,+CAA+C;AAC/C,gEAAgE;;;AAEhE,yCAA6D;AAI7D;;GAEG;AACU,QAAA,yBAAyB,GAAG,oBAAoB,CAAC;AAc9D;;GAEG;AACI,MAAM,iBAAiB,GAAoB,OAAO,CAAC,EAAE;IAC1D,mBAAY,CAAC,iCAAyB,CAAC,CAAC,OAAO,CAAC,CAAC;IACjD,OAAO,CAAC,GAAG,CAAC,EAAC,SAAS,EAAE,oBAAoB,EAAC,CAAC,CAAC;AACjD,CAAC,CAAC;AAHW,QAAA,iBAAiB,qBAG5B"}

package/dist/model-api-config.d.ts

@@ -0,0 +1,26 @@
+import { Model } from '@loopback/repository';
+/**
+ * Configuration settings for individual model files. This type describes
+ * content of `public-models/{model-name}.config.json` files.
+ */
+export declare type ModelApiConfig = {
+    /**
+     * The model class that the repository and controller are to be built from.
+     * e.g. Product (a Model class)
+     */
+    model: typeof Model & {
+        prototype: Model;
+    };
+    /**
+     * Name of data-access pattern describing the API builder. Users can
+     * customize and use a unique pattern name.
+     * e.g. 'RestCrud'
+     */
+    pattern: string;
+    /**
+     * The dataSource the model uses under the hood.
+     * e.g. 'db'
+     */
+    dataSource: string;
+    [patternSpecificSetting: string]: unknown;
+};

package/dist/model-api-config.js

@@ -0,0 +1,7 @@
+"use strict";
+// Copyright IBM Corp. 2019. All Rights Reserved.
+// Node module: @loopback/model-api-builder
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=model-api-config.js.map

package/dist/model-api-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"model-api-config.js","sourceRoot":"","sources":["../src/model-api-config.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,2CAA2C;AAC3C,+CAA+C;AAC/C,gEAAgE"}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@loopback/model-api-builder",
+  "description": "Types and helpers for packages contributing Model API builders.",
+  "version": "2.3.3",
+  "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/model-api-builder"
+  },
+  "engines": {
+    "node": "^10.16 || 12 || 14 || 16"
+  },
+  "scripts": {
+    "build": "lb-tsc",
+    "clean": "lb-clean loopback-model-api-builder*.tgz dist *.tsbuildinfo package",
+    "pretest": "npm run build",
+    "test": "",
+    "verify": "npm pack && tar xf loopback-model-api-builder*.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"
+  },
+  "dependencies": {
+    "tslib": "^2.3.1"
+  },
+  "devDependencies": {
+    "@loopback/build": "^7.0.1",
+    "@loopback/core": "^2.17.0",
+    "@loopback/repository": "^3.7.2",
+    "@types/node": "^10.17.60"
+  },
+  "gitHead": "1df36bb1ee2e513d9e197bd6010c4cfb296d50b8"
+}

package/src/index.ts

@@ -0,0 +1,19 @@
+// Copyright IBM Corp. 2019,2020. All Rights Reserved.
+// Node module: @loopback/model-api-builder
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+/**
+ * A packge with types and helpers for packages contributing Model API builders.
+ *
+ * @remarks
+ * Provides a contract for extensions that contribute builders for repositories
+ * and controllers. Users provide both the model class and an extension. The
+ * extension is then used to build their repository and controller based on the
+ * model class.
+ *
+ * @packageDocumentation
+ */
+
+export * from './model-api-builder';
+export * from './model-api-config';

package/src/model-api-builder.ts

@@ -0,0 +1,33 @@
+// Copyright IBM Corp. 2019. All Rights Reserved.
+// Node module: @loopback/model-api-builder
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+import {BindingTemplate, extensionFor} from '@loopback/core';
+import {ApplicationWithRepositories, Model} from '@loopback/repository';
+import {ModelApiConfig} from './model-api-config';
+
+/**
+ * Extension Point name for Model API builders.
+ */
+export const MODEL_API_BUILDER_PLUGINS = 'model-api-builders';
+
+/**
+ * Interface for extensions contributing custom API flavors.
+ */
+export interface ModelApiBuilder {
+  readonly pattern: string; // e.g. CrudRest
+  build(
+    application: ApplicationWithRepositories,
+    modelClass: typeof Model & {prototype: Model},
+    config: ModelApiConfig,
+  ): Promise<void>;
+}
+
+/**
+ * A binding template for model API extensions
+ */
+export const asModelApiBuilder: BindingTemplate = binding => {
+  extensionFor(MODEL_API_BUILDER_PLUGINS)(binding);
+  binding.tag({namespace: 'model-api-builders'});
+};

package/src/model-api-config.ts

@@ -0,0 +1,33 @@
+// Copyright IBM Corp. 2019. All Rights Reserved.
+// Node module: @loopback/model-api-builder
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+import {Model} from '@loopback/repository';
+
+/**
+ * Configuration settings for individual model files. This type describes
+ * content of `public-models/{model-name}.config.json` files.
+ */
+export type ModelApiConfig = {
+  /**
+   * The model class that the repository and controller are to be built from.
+   * e.g. Product (a Model class)
+   */
+  model: typeof Model & {prototype: Model};
+
+  /**
+   * Name of data-access pattern describing the API builder. Users can
+   * customize and use a unique pattern name.
+   * e.g. 'RestCrud'
+   */
+  pattern: string;
+
+  /**
+   * The dataSource the model uses under the hood.
+   * e.g. 'db'
+   */
+  dataSource: string;
+
+  [patternSpecificSetting: string]: unknown;
+};