@loopback/repository 4.0.0-alpha.6 → 4.0.0

package/dist/decorators/model.decorator.js

@@ -0,0 +1,112 @@
+"use strict";
+// Copyright IBM Corp. 2018,2020. All Rights Reserved.
+// Node module: @loopback/repository
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.property = exports.buildModelDefinition = exports.model = exports.MODEL_WITH_PROPERTIES_KEY = exports.MODEL_PROPERTIES_KEY = exports.MODEL_KEY = void 0;
+const core_1 = require("@loopback/core");
+const model_1 = require("../model");
+const relation_decorator_1 = require("../relations/relation.decorator");
+exports.MODEL_KEY = core_1.MetadataAccessor.create('loopback:model');
+exports.MODEL_PROPERTIES_KEY = core_1.MetadataAccessor.create('loopback:model-properties');
+exports.MODEL_WITH_PROPERTIES_KEY = core_1.MetadataAccessor.create('loopback:model-and-properties');
+/**
+ * Decorator for model definitions
+ * @param definition
+ * @returns A class decorator for `model`
+ */
+function model(definition) {
+    return function (target) {
+        var _a;
+        definition = definition !== null && definition !== void 0 ? definition : {};
+        const def = Object.assign(definition, {
+            name: (_a = definition.name) !== null && _a !== void 0 ? _a : target.name,
+        });
+        const decorator = core_1.ClassDecoratorFactory.createDecorator(exports.MODEL_KEY, definition, { decoratorName: '@model' });
+        decorator(target);
+        // Build "ModelDefinition" and store it on model constructor
+        buildModelDefinition(target, def);
+    };
+}
+exports.model = model;
+/**
+ * Build model definition from decorations
+ * @param target - Target model class
+ * @param def - Model definition spec
+ */
+function buildModelDefinition(target, def) {
+    var _a, _b, _c, _d;
+    // Check if the definition for this class has been built (not from the super
+    // class)
+    const baseClass = Object.getPrototypeOf(target);
+    if (!def &&
+        target.definition &&
+        baseClass &&
+        target.definition !== baseClass.definition) {
+        return target.definition;
+    }
+    const modelDef = new model_1.ModelDefinition(def !== null && def !== void 0 ? def : { name: target.name });
+    const prototype = target.prototype;
+    const propertyMap = (_a = core_1.MetadataInspector.getAllPropertyMetadata(exports.MODEL_PROPERTIES_KEY, prototype)) !== null && _a !== void 0 ? _a : {};
+    for (const [propName, propDef] of Object.entries(propertyMap)) {
+        const designType = (_b = propDef.type) !== null && _b !== void 0 ? _b : core_1.MetadataInspector.getDesignTypeForProperty(prototype, propName);
+        if (!designType) {
+            const err = new Error(`The definition of model property ${modelDef.name}.${propName} is missing ` +
+                '`type` field and TypeScript did not provide any design-time type. ' +
+                'Learn more at https://loopback.io/doc/en/lb4/Error-codes.html#cannot_infer_property_type');
+            err.code = 'CANNOT_INFER_PROPERTY_TYPE';
+            throw err;
+        }
+        if (propDef.hidden) {
+            modelDef.settings.hiddenProperties =
+                (_c = modelDef.settings.hiddenProperties) !== null && _c !== void 0 ? _c : [];
+            modelDef.settings.hiddenProperties.push(propName);
+        }
+        propDef.type = designType;
+        modelDef.addProperty(propName, propDef);
+    }
+    target.definition = modelDef;
+    const relationMeta = (_d = core_1.MetadataInspector.getAllPropertyMetadata(relation_decorator_1.RELATIONS_KEY, prototype)) !== null && _d !== void 0 ? _d : {};
+    const relations = {};
+    // Build an object keyed by relation names
+    Object.values(relationMeta).forEach(r => {
+        relations[r.name] = r;
+    });
+    target.definition.relations = relations;
+    return modelDef;
+}
+exports.buildModelDefinition = buildModelDefinition;
+/**
+ * Decorator for model properties
+ * @param definition
+ * @returns A property decorator
+ */
+function property(definition) {
+    return core_1.PropertyDecoratorFactory.createDecorator(exports.MODEL_PROPERTIES_KEY, Object.assign({}, definition), { decoratorName: '@property' });
+}
+exports.property = property;
+(function (property) {
+    property.ERR_PROP_NOT_ARRAY = '@property.array can only decorate array properties!';
+    property.ERR_NO_ARGS = 'decorator received less than two parameters';
+    /**
+     *
+     * @param itemType - The type of array items.
+     * Examples: `number`, `Product`, `() => Order`.
+     * @param definition - Optional PropertyDefinition object for additional
+     * metadata
+     */
+    function array(itemType, definition) {
+        return function (target, propertyName) {
+            const propType = core_1.MetadataInspector.getDesignTypeForProperty(target, propertyName);
+            if (propType !== Array) {
+                throw new Error(property.ERR_PROP_NOT_ARRAY);
+            }
+            else {
+                property(Object.assign({ type: Array, itemType }, definition))(target, propertyName);
+            }
+        };
+    }
+    property.array = array;
+})(property = exports.property || (exports.property = {}));
+//# sourceMappingURL=model.decorator.js.map

package/dist/decorators/model.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.decorator.js","sourceRoot":"","sources":["../../src/decorators/model.decorator.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;;AAEhE,yCAMwB;AACxB,oCAMkB;AAClB,wEAA8D;AAEjD,QAAA,SAAS,GAAG,uBAAgB,CAAC,MAAM,CAG9C,gBAAgB,CAAC,CAAC;AACP,QAAA,oBAAoB,GAAG,uBAAgB,CAAC,MAAM,CAGzD,2BAA2B,CAAC,CAAC;AAClB,QAAA,yBAAyB,GAAG,uBAAgB,CAAC,MAAM,CAG9D,+BAA+B,CAAC,CAAC;AAInC;;;;GAIG;AACH,SAAgB,KAAK,CAAC,UAA2C;IAC/D,OAAO,UAAU,MAAiD;;QAChE,UAAU,GAAG,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,EAAE,CAAC;QAC9B,MAAM,GAAG,GAA0B,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE;YAC3D,IAAI,EAAE,MAAA,UAAU,CAAC,IAAI,mCAAI,MAAM,CAAC,IAAI;SACrC,CAAC,CAAC;QACH,MAAM,SAAS,GAAG,4BAAqB,CAAC,eAAe,CACrD,iBAAS,EACT,UAAU,EACV,EAAC,aAAa,EAAE,QAAQ,EAAC,CAC1B,CAAC;QAEF,SAAS,CAAC,MAAM,CAAC,CAAC;QAElB,4DAA4D;QAC5D,oBAAoB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACpC,CAAC,CAAC;AACJ,CAAC;AAjBD,sBAiBC;AAED;;;;GAIG;AACH,SAAgB,oBAAoB,CAClC,MAA6D,EAC7D,GAA2B;;IAE3B,4EAA4E;IAC5E,SAAS;IACT,MAAM,SAAS,GAAG,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IAChD,IACE,CAAC,GAAG;QACJ,MAAM,CAAC,UAAU;QACjB,SAAS;QACT,MAAM,CAAC,UAAU,KAAK,SAAS,CAAC,UAAU,EAC1C;QACA,OAAO,MAAM,CAAC,UAAU,CAAC;KAC1B;IACD,MAAM,QAAQ,GAAG,IAAI,uBAAe,CAAC,GAAG,aAAH,GAAG,cAAH,GAAG,GAAI,EAAC,IAAI,EAAE,MAAM,CAAC,IAAI,EAAC,CAAC,CAAC;IACjE,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;IACnC,MAAM,WAAW,GACf,MAAA,wBAAiB,CAAC,sBAAsB,CAAC,4BAAoB,EAAE,SAAS,CAAC,mCACzE,EAAE,CAAC;IACL,KAAK,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;QAC7D,MAAM,UAAU,GACd,MAAA,OAAO,CAAC,IAAI,mCACZ,wBAAiB,CAAC,wBAAwB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAClE,IAAI,CAAC,UAAU,EAAE;YACf,MAAM,GAAG,GAA4B,IAAI,KAAK,CAC5C,oCAAoC,QAAQ,CAAC,IAAI,IAAI,QAAQ,cAAc;gBACzE,oEAAoE;gBACpE,0FAA0F,CAC7F,CAAC;YACF,GAAG,CAAC,IAAI,GAAG,4BAA4B,CAAC;YACxC,MAAM,GAAG,CAAC;SACX;QAED,IAAI,OAAO,CAAC,MAAM,EAAE;YAClB,QAAQ,CAAC,QAAQ,CAAC,gBAAgB;gBAChC,MAAA,QAAQ,CAAC,QAAQ,CAAC,gBAAgB,mCAAI,EAAE,CAAC;YAC3C,QAAQ,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SACnD;QACD,OAAO,CAAC,IAAI,GAAG,UAAU,CAAC;QAC1B,QAAQ,CAAC,WAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;KACzC;IACD,MAAM,CAAC,UAAU,GAAG,QAAQ,CAAC;IAC7B,MAAM,YAAY,GAChB,MAAA,wBAAiB,CAAC,sBAAsB,CAAC,kCAAa,EAAE,SAAS,CAAC,mCAAI,EAAE,CAAC;IAC3E,MAAM,SAAS,GAA0B,EAAE,CAAC;IAC5C,0CAA0C;IAC1C,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;QACtC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;IACH,MAAM,CAAC,UAAU,CAAC,SAAS,GAAG,SAAS,CAAC;IACxC,OAAO,QAAQ,CAAC;AAClB,CAAC;AApDD,oDAoDC;AAED;;;;GAIG;AACH,SAAgB,QAAQ,CAAC,UAAwC;IAC/D,OAAO,+BAAwB,CAAC,eAAe,CAC7C,4BAAoB,EACpB,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,UAAU,CAAC,EAC7B,EAAC,aAAa,EAAE,WAAW,EAAC,CAC7B,CAAC;AACJ,CAAC;AAND,4BAMC;AAED,WAAiB,QAAQ;IACV,2BAAkB,GAC7B,qDAAqD,CAAC;IAC3C,oBAAW,GAAG,6CAA6C,CAAC;IAEzE;;;;;;OAMG;IACH,SAAgB,KAAK,CACnB,QAAsB,EACtB,UAAwC;QAExC,OAAO,UAAU,MAAc,EAAE,YAAoB;YACnD,MAAM,QAAQ,GAAG,wBAAiB,CAAC,wBAAwB,CACzD,MAAM,EACN,YAAY,CACb,CAAC;YACF,IAAI,QAAQ,KAAK,KAAK,EAAE;gBACtB,MAAM,IAAI,KAAK,CAAC,SAAA,kBAAkB,CAAC,CAAC;aACrC;iBAAM;gBACL,QAAQ,CACN,MAAM,CAAC,MAAM,CACX,EAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAgC,EACtD,UAAU,CACX,CACF,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;aACzB;QACH,CAAC,CAAC;IACJ,CAAC;IApBe,cAAK,QAoBpB,CAAA;AACH,CAAC,EAjCgB,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAiCxB"}

package/dist/decorators/repository.decorator.d.ts

@@ -0,0 +1,106 @@
+import { Class } from '../common-types';
+import { DataSource } from '../datasource';
+import { Entity, Model } from '../model';
+import { Repository } from '../repositories';
+import { juggler } from '../repositories/legacy-juggler-bridge';
+/**
+ * Type definition for decorators returned by `@repository` decorator factory
+ */
+export declare type RepositoryDecorator = (target: Object, key?: string, descriptorOrIndex?: TypedPropertyDescriptor<any> | number) => void;
+/**
+ * Metadata for a repository
+ */
+export declare class RepositoryMetadata {
+    /**
+     * Name of the predefined repository
+     */
+    name?: string;
+    /**
+     * Name of the model
+     */
+    modelName?: string;
+    /**
+     * Class of the model
+     */
+    modelClass?: typeof Entity;
+    /**
+     * Name of the data source
+     */
+    dataSourceName?: string;
+    /**
+     * Instance of the data source
+     */
+    dataSource?: juggler.DataSource | DataSource;
+    /**
+     * Constructor for RepositoryMetadata
+     *
+     * @param modelOrRepo - Name or class of the model. If the value is a string and
+     * `dataSource` is not present, it will treated as the name of a predefined
+     * repository
+     * @param dataSource - Name or instance of the data source
+     *
+     * For example:
+     *
+     * - new RepositoryMetadata(repoName);
+     * - new RepositoryMetadata(modelName, dataSourceName);
+     * - new RepositoryMetadata(modelClass, dataSourceInstance);
+     * - new RepositoryMetadata(modelName, dataSourceInstance);
+     * - new RepositoryMetadata(modelClass, dataSourceName);
+     */
+    constructor(modelOrRepo: string | typeof Entity, dataSource?: string | juggler.DataSource | DataSource);
+}
+/**
+ * Decorator for repository injections on properties or method arguments
+ *
+ * @example
+ * ```ts
+ * class CustomerController {
+ *   @repository(CustomerRepository) public custRepo: CustomerRepository;
+ *
+ *   constructor(
+ *     @repository(ProductRepository) public prodRepo: ProductRepository,
+ *   ) {}
+ *   // ...
+ * }
+ * ```
+ *
+ * @param repositoryName - Name of the repo
+ */
+export declare function repository(repositoryName: string | Class<Repository<Model>>): RepositoryDecorator;
+/**
+ * Decorator for DefaultCrudRepository generation and injection on properties
+ * or method arguments based on the given model and dataSource (or their names)
+ *
+ * @example
+ * ```ts
+ * class CustomerController {
+ *   @repository('Customer', 'mySqlDataSource')
+ *   public custRepo: DefaultCrudRepository<
+ *     Customer,
+ *     typeof Customer.prototype.id
+ *   >;
+ *
+ *   constructor(
+ *     @repository(Product, mySqlDataSource)
+ *     public prodRepo: DefaultCrudRepository<
+ *       Product,
+ *       typeof Product.prototype.id
+ *     >,
+ *   ) {}
+ *   // ...
+ * }
+ * ```
+ *
+ * @param model - Name/class of the model
+ * @param dataSource - Name/instance of the dataSource
+ */
+export declare function repository(model: string | typeof Entity, dataSource: string | juggler.DataSource): RepositoryDecorator;
+export declare namespace repository {
+    /**
+     * Decorator used to inject a Getter for a repository
+     * Mainly intended for usage with repository injections on relation repository
+     * factory
+     * @param nameOrClass - The repository class (ProductRepository) or a string name ('ProductRepository').
+     */
+    function getter(nameOrClass: string | Class<Repository<Model>>): (target: Object, member: string | undefined, methodDescriptorOrParameterIndex?: number | TypedPropertyDescriptor<any> | undefined) => void;
+}

package/dist/decorators/repository.decorator.js

@@ -0,0 +1,114 @@
+"use strict";
+// Copyright IBM Corp. 2018,2020. All Rights Reserved.
+// Node module: @loopback/repository
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.repository = exports.RepositoryMetadata = void 0;
+const tslib_1 = require("tslib");
+const core_1 = require("@loopback/core");
+const assert_1 = (0, tslib_1.__importDefault)(require("assert"));
+const repositories_1 = require("../repositories");
+const legacy_juggler_bridge_1 = require("../repositories/legacy-juggler-bridge");
+/**
+ * Metadata for a repository
+ */
+class RepositoryMetadata {
+    /**
+     * Constructor for RepositoryMetadata
+     *
+     * @param modelOrRepo - Name or class of the model. If the value is a string and
+     * `dataSource` is not present, it will treated as the name of a predefined
+     * repository
+     * @param dataSource - Name or instance of the data source
+     *
+     * For example:
+     *
+     * - new RepositoryMetadata(repoName);
+     * - new RepositoryMetadata(modelName, dataSourceName);
+     * - new RepositoryMetadata(modelClass, dataSourceInstance);
+     * - new RepositoryMetadata(modelName, dataSourceInstance);
+     * - new RepositoryMetadata(modelClass, dataSourceName);
+     */
+    constructor(modelOrRepo, dataSource) {
+        this.name =
+            typeof modelOrRepo === 'string' && dataSource === undefined
+                ? modelOrRepo
+                : undefined;
+        this.modelName =
+            typeof modelOrRepo === 'string' && dataSource != null
+                ? modelOrRepo
+                : undefined;
+        this.modelClass =
+            typeof modelOrRepo === 'function' ? modelOrRepo : undefined;
+        this.dataSourceName =
+            typeof dataSource === 'string' ? dataSource : undefined;
+        this.dataSource = typeof dataSource === 'object' ? dataSource : undefined;
+    }
+}
+exports.RepositoryMetadata = RepositoryMetadata;
+function repository(modelOrRepo, dataSource) {
+    // if string, repository or not a model ctor,
+    // keep it a string / assign to ctor's name (string) for DI
+    const stringOrModel = typeof modelOrRepo !== 'string' && !modelOrRepo.prototype.getId
+        ? modelOrRepo.name
+        : modelOrRepo;
+    const meta = new RepositoryMetadata(stringOrModel, dataSource);
+    return function (target, key, 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    descriptorOrIndex) {
+        if (key || typeof descriptorOrIndex === 'number') {
+            if (meta.name) {
+                // Make it shortcut to `@inject('repositories.MyRepo')`
+                // Please note key is undefined for constructor. If strictNullChecks
+                // is true, the compiler will complain as reflect-metadata won't
+                // accept undefined or null for key. Use ! to fool the compiler.
+                (0, core_1.inject)('repositories.' + meta.name, meta)(target, key, descriptorOrIndex);
+            }
+            else {
+                // Use repository-factory to create a repository from model + dataSource
+                (0, core_1.inject)('', meta, resolve)(target, key, descriptorOrIndex);
+            }
+            return;
+        }
+        // Mixin repository into the class
+        throw new Error('Class level @repository is not implemented');
+    };
+}
+exports.repository = repository;
+(function (repository) {
+    /**
+     * Decorator used to inject a Getter for a repository
+     * Mainly intended for usage with repository injections on relation repository
+     * factory
+     * @param nameOrClass - The repository class (ProductRepository) or a string name ('ProductRepository').
+     */
+    function getter(nameOrClass) {
+        const name = typeof nameOrClass === 'string' ? nameOrClass : nameOrClass.name;
+        return core_1.inject.getter(`repositories.${name}`);
+    }
+    repository.getter = getter;
+})(repository = exports.repository || (exports.repository = {}));
+/**
+ * Resolve the @repository injection
+ * @param ctx - Context
+ * @param injection - Injection metadata
+ */
+async function resolve(ctx, injection) {
+    const meta = injection.metadata;
+    let modelClass = meta.modelClass;
+    if (meta.modelName) {
+        modelClass = (await ctx.get('models.' + meta.modelName));
+    }
+    if (!modelClass) {
+        throw new Error('Invalid repository config: ' +
+            ' neither modelClass nor modelName was specified.');
+    }
+    let dataSource = meta.dataSource;
+    if (meta.dataSourceName) {
+        dataSource = await ctx.get('datasources.' + meta.dataSourceName);
+    }
+    (0, assert_1.default)(dataSource instanceof legacy_juggler_bridge_1.juggler.DataSource, 'DataSource must be provided');
+    return new repositories_1.DefaultCrudRepository(modelClass, dataSource);
+}
+//# sourceMappingURL=repository.decorator.js.map

package/dist/decorators/repository.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"repository.decorator.js","sourceRoot":"","sources":["../../src/decorators/repository.decorator.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,yCAA0D;AAC1D,iEAA4B;AAI5B,kDAAkE;AAClE,iFAA8D;AAY9D;;GAEG;AACH,MAAa,kBAAkB;IAsB7B;;;;;;;;;;;;;;;OAeG;IACH,YACE,WAAmC,EACnC,UAAqD;QAErD,IAAI,CAAC,IAAI;YACP,OAAO,WAAW,KAAK,QAAQ,IAAI,UAAU,KAAK,SAAS;gBACzD,CAAC,CAAC,WAAW;gBACb,CAAC,CAAC,SAAS,CAAC;QAChB,IAAI,CAAC,SAAS;YACZ,OAAO,WAAW,KAAK,QAAQ,IAAI,UAAU,IAAI,IAAI;gBACnD,CAAC,CAAC,WAAW;gBACb,CAAC,CAAC,SAAS,CAAC;QAChB,IAAI,CAAC,UAAU;YACb,OAAO,WAAW,KAAK,UAAU,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;QAC9D,IAAI,CAAC,cAAc;YACjB,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1D,IAAI,CAAC,UAAU,GAAG,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;IAC5E,CAAC;CACF;AAxDD,gDAwDC;AAuDD,SAAgB,UAAU,CACxB,WAA8D,EAC9D,UAAwC;IAExC,6CAA6C;IAC7C,2DAA2D;IAC3D,MAAM,aAAa,GACjB,OAAO,WAAW,KAAK,QAAQ,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,KAAK;QAC7D,CAAC,CAAC,WAAW,CAAC,IAAI;QAClB,CAAC,CAAE,WAA6B,CAAC;IACrC,MAAM,IAAI,GAAG,IAAI,kBAAkB,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;IAC/D,OAAO,UACL,MAAc,EACd,GAAY;IACZ,8DAA8D;IAC9D,iBAAyD;QAEzD,IAAI,GAAG,IAAI,OAAO,iBAAiB,KAAK,QAAQ,EAAE;YAChD,IAAI,IAAI,CAAC,IAAI,EAAE;gBACb,uDAAuD;gBACvD,oEAAoE;gBACpE,gEAAgE;gBAChE,gEAAgE;gBAChE,IAAA,aAAM,EAAC,eAAe,GAAG,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CACvC,MAAM,EACN,GAAI,EACJ,iBAAiB,CAClB,CAAC;aACH;iBAAM;gBACL,wEAAwE;gBACxE,IAAA,aAAM,EAAC,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,MAAM,EAAE,GAAI,EAAE,iBAAiB,CAAC,CAAC;aAC5D;YACD,OAAO;SACR;QACD,kCAAkC;QAClC,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAChE,CAAC,CAAC;AACJ,CAAC;AArCD,gCAqCC;AAED,WAAiB,UAAU;IACzB;;;;;OAKG;IACH,SAAgB,MAAM,CAAC,WAA8C;QACnE,MAAM,IAAI,GACR,OAAO,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC;QACnE,OAAO,aAAM,CAAC,MAAM,CAAC,gBAAgB,IAAI,EAAE,CAAC,CAAC;IAC/C,CAAC;IAJe,iBAAM,SAIrB,CAAA;AACH,CAAC,EAZgB,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAY1B;AAED;;;;GAIG;AACH,KAAK,UAAU,OAAO,CAAC,GAAY,EAAE,SAAoB;IACvD,MAAM,IAAI,GAAG,SAAS,CAAC,QAA8B,CAAC;IACtD,IAAI,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;IACjC,IAAI,IAAI,CAAC,SAAS,EAAE;QAClB,UAAU,GAAG,CAAC,MAAM,GAAG,CAAC,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,CAAkB,CAAC;KAC3E;IACD,IAAI,CAAC,UAAU,EAAE;QACf,MAAM,IAAI,KAAK,CACb,6BAA6B;YAC3B,kDAAkD,CACrD,CAAC;KACH;IAED,IAAI,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;IACjC,IAAI,IAAI,CAAC,cAAc,EAAE;QACvB,UAAU,GAAG,MAAM,GAAG,CAAC,GAAG,CACxB,cAAc,GAAG,IAAI,CAAC,cAAc,CACrC,CAAC;KACH;IACD,IAAA,gBAAM,EACJ,UAAU,YAAY,+BAAO,CAAC,UAAU,EACxC,6BAA6B,CAC9B,CAAC;IACF,OAAO,IAAI,oCAAqB,CAC9B,UAAU,EACV,UAAiC,CAClC,CAAC;AACJ,CAAC"}

package/dist/define-model-class.d.ts

@@ -0,0 +1,55 @@
+import { DataObject, PrototypeOf } from './common-types';
+import { Model, ModelDefinition } from './model';
+/**
+ * Create (define) a new model class with the given name and definition.
+ *
+ * @remarks
+ *
+ * ```ts
+ * const Product = defineModelClass(Entity, new ModelDefinition('Product'));
+ * ```
+ *
+ * To enable type safety, you should describe properties of your model:
+ *
+ * ```ts
+ * const Product = defineModelClass<
+ *  typeof Entity,
+ *  {id: number, name: string}
+ * >(Entity, new ModelDefinition('Product'));
+ * ```
+ *
+ * If your model allows arbitrary (free-form) properties, then add `AnyObject`
+ * to the type describing model properties.
+ *
+ * ```ts
+ * const Product = defineModelClass<
+ *  typeof Entity,
+ *  AnyObject & {id: number},
+ * >(Entity, new ModelDefinition('Product'));
+ * ```
+ *
+ * @param base The base model to extend, typically Model or Entity.
+ *  You can also use your own base class, e.g. `User`.
+ * @param definition Definition of the model to create.
+ * @typeParam BaseCtor Constructor type of the base class,
+ *   e.g `typeof Model` or `typeof Entity`
+ * @typeParam Props Interface describing model properties,
+ *   e.g. `{title: string}` or `AnyObject & {id: number}`.
+ */
+export declare function defineModelClass<BaseCtor extends typeof Model, Props extends object = {}>(base: BaseCtor, definition: ModelDefinition): DynamicModelCtor<BaseCtor, Props>;
+/**
+ * A type describing a model class created via `defineModelClass`.
+ *
+ * Assuming template arguments `BaseCtor` and `Props`, this type describes
+ * a class constructor with the following properties:
+ * - a constructor function accepting `DataObject<Props>` as the only argument,
+ *   this argument is optional
+ * - all static fields (properties, methods) from `BaseCtor` are inherited and
+ *   available as static fields on the dynamic class
+ * - all prototype fields from `BaseCtor` prototype are inherited and available
+ *   as prototype fields on the dynamic class
+ */
+export declare type DynamicModelCtor<BaseCtor extends typeof Model, Props extends object> = {
+    /** Model constructor accepting partial model data. */
+    new (data?: DataObject<PrototypeOf<BaseCtor> & Props>): PrototypeOf<BaseCtor> & Props;
+} & BaseCtor;

package/dist/define-model-class.js

@@ -0,0 +1,57 @@
+"use strict";
+// Copyright IBM Corp. 2019,2020. All Rights Reserved.
+// Node module: @loopback/repository
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defineModelClass = void 0;
+const tslib_1 = require("tslib");
+const assert = (0, tslib_1.__importStar)(require("assert"));
+const decorators_1 = require("./decorators");
+/**
+ * Create (define) a new model class with the given name and definition.
+ *
+ * @remarks
+ *
+ * ```ts
+ * const Product = defineModelClass(Entity, new ModelDefinition('Product'));
+ * ```
+ *
+ * To enable type safety, you should describe properties of your model:
+ *
+ * ```ts
+ * const Product = defineModelClass<
+ *  typeof Entity,
+ *  {id: number, name: string}
+ * >(Entity, new ModelDefinition('Product'));
+ * ```
+ *
+ * If your model allows arbitrary (free-form) properties, then add `AnyObject`
+ * to the type describing model properties.
+ *
+ * ```ts
+ * const Product = defineModelClass<
+ *  typeof Entity,
+ *  AnyObject & {id: number},
+ * >(Entity, new ModelDefinition('Product'));
+ * ```
+ *
+ * @param base The base model to extend, typically Model or Entity.
+ *  You can also use your own base class, e.g. `User`.
+ * @param definition Definition of the model to create.
+ * @typeParam BaseCtor Constructor type of the base class,
+ *   e.g `typeof Model` or `typeof Entity`
+ * @typeParam Props Interface describing model properties,
+ *   e.g. `{title: string}` or `AnyObject & {id: number}`.
+ */
+function defineModelClass(base /* Model or Entity */, definition) {
+    const modelName = definition.name;
+    const defineNamedModelClass = new Function(base.name, `return class ${modelName} extends ${base.name} {}`);
+    const modelClass = defineNamedModelClass(base);
+    assert.equal(modelClass.name, modelName);
+    // Apply `@model(definition)` to the generated class
+    (0, decorators_1.model)(definition)(modelClass);
+    return modelClass;
+}
+exports.defineModelClass = defineModelClass;
+//# sourceMappingURL=define-model-class.js.map

package/dist/define-model-class.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"define-model-class.js","sourceRoot":"","sources":["../src/define-model-class.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,4DAAiC;AAEjC,6CAAmC;AAGnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,SAAgB,gBAAgB,CAI9B,IAAc,CAAC,qBAAqB,EACpC,UAA2B;IAE3B,MAAM,SAAS,GAAG,UAAU,CAAC,IAAI,CAAC;IAClC,MAAM,qBAAqB,GAAG,IAAI,QAAQ,CACxC,IAAI,CAAC,IAAI,EACT,gBAAgB,SAAS,YAAY,IAAI,CAAC,IAAI,KAAK,CACpD,CAAC;IACF,MAAM,UAAU,GAAG,qBAAqB,CAAC,IAAI,CAG5C,CAAC;IACF,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IAEzC,oDAAoD;IACpD,IAAA,kBAAK,EAAC,UAAU,CAAC,CAAC,UAAU,CAAC,CAAC;IAC9B,OAAO,UAAU,CAAC;AACpB,CAAC;AArBD,4CAqBC"}

package/dist/define-repository-class.d.ts

@@ -0,0 +1,119 @@
+import { PrototypeOf } from './common-types';
+import { Entity, Model } from './model';
+import { DefaultCrudRepository, DefaultKeyValueRepository, juggler, Repository } from './repositories';
+/**
+ * Signature for a Repository class bound to a given model. The constructor
+ * accepts only the dataSource to use for persistence.
+ *
+ * `define*` functions return a class implementing this interface.
+ *
+ * @typeParam M - Model class
+ * @typeParam R - Repository class/interface
+ */
+export interface ModelRepositoryClass<M extends Model, R extends Repository<M>> {
+    /**
+     * The constructor for the generated repository class
+     * @param dataSource - DataSource object
+     */
+    new (dataSource: juggler.DataSource): R;
+    prototype: R;
+}
+/**
+ * Signature for repository classes that can be used as the base class for
+ * `define*` functions. The constructor of a base repository class accepts
+ * the target model constructor and the datasource to use.
+ *
+ * `define*` functions require a class implementing this interface on input.
+ *
+ * @typeParam M - Model class constructor, e.g `typeof Model`.
+ * **❗️IMPORTANT: The type argument `M` is describing the model constructor type
+ * (e.g. `typeof Model`), not the model instance type (`Model`) as is the case
+ * in other repository-related types. The constructor type is required
+ * to support custom repository classes requiring a Model subclass in the
+ * constructor arguments, e.g. `Entity` or a user-provided model.**
+ *
+ * @typeParam R - Repository class/interface
+ */
+export interface BaseRepositoryClass<M extends typeof Model, R extends Repository<PrototypeOf<M>>> {
+    /**
+     * The constructor for the generated repository class
+     * @param modelClass - Model class
+     * @param dataSource - DataSource object
+     */
+    new (modelClass: M, dataSource: juggler.DataSource): R;
+    prototype: R;
+}
+/**
+ * Create (define) a repository class for the given model.
+ *
+ * See also `defineCrudRepositoryClass` and `defineKeyValueRepositoryClass`
+ * for convenience wrappers providing repository class factory for the default
+ * CRUD and KeyValue implementations.
+ *
+ * **❗️IMPORTANT: The compiler (TypeScript 3.8) is not able to correctly infer
+ * generic arguments `M` and `R` from the class constructors provided in
+ * function arguments. You must always provide both M and R types explicitly.**
+ *
+ * @example
+ *
+ * ```ts
+ * const AddressRepository = defineRepositoryClass<
+ *   typeof Address,
+ *   DefaultEntityCrudRepository<
+ *    Address,
+ *    typeof Address.prototype.id,
+ *    AddressRelations
+ *   >,
+ * >(Address, DefaultCrudRepository);
+ * ```
+ *
+ * @param modelClass - A model class such as `Address`.
+ * @param baseRepositoryClass - Repository implementation to use as the base,
+ * e.g. `DefaultCrudRepository`.
+ *
+ * @typeParam M - Model class constructor (e.g. `typeof Address`)
+ * @typeParam R - Repository class (e.g. `DefaultCrudRepository<Address, number>`)
+ */
+export declare function defineRepositoryClass<M extends typeof Model, R extends Repository<PrototypeOf<M>>>(modelClass: M, baseRepositoryClass: BaseRepositoryClass<M, R>): ModelRepositoryClass<PrototypeOf<M>, R>;
+/**
+ * Create (define) an entity CRUD repository class for the given model.
+ * This function always uses `DefaultCrudRepository` as the base class,
+ * use `defineRepositoryClass` if you want to use your own base repository.
+ *
+ * @example
+ *
+ * ```ts
+ * const ProductRepository = defineCrudRepositoryClass<
+ *   Product,
+ *   typeof Product.prototype.id,
+ *   ProductRelations
+ * >(Product);
+ * ```
+ *
+ * @param entityClass - An entity class such as `Product`.
+ *
+ * @typeParam E - An entity class
+ * @typeParam IdType - ID type for the entity
+ * @typeParam Relations - Relations for the entity
+ */
+export declare function defineCrudRepositoryClass<E extends Entity, IdType, Relations extends object>(entityClass: typeof Entity & {
+    prototype: E;
+}): ModelRepositoryClass<E, DefaultCrudRepository<E, IdType, Relations>>;
+/**
+ * Create (define) a KeyValue repository class for the given entity.
+ * This function always uses `DefaultKeyValueRepository` as the base class,
+ * use `defineRepositoryClass` if you want to use your own base repository.
+ *
+ * @example
+ *
+ * ```ts
+ * const ProductKeyValueRepository = defineKeyValueRepositoryClass(Product);
+ * ```
+ *
+ * @param modelClass - An entity class such as `Product`.
+ *
+ * @typeParam M - Model class
+ */
+export declare function defineKeyValueRepositoryClass<M extends Model>(modelClass: typeof Model & {
+    prototype: M;
+}): ModelRepositoryClass<M, DefaultKeyValueRepository<M>>;