@loopback/repository 4.0.0-alpha.6 → 4.0.0

package/dist/model.js

@@ -0,0 +1,367 @@
+"use strict";
+// Copyright IBM Corp. 2017,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.rejectNavigationalPropertiesInData = exports.Event = exports.Entity = exports.ValueObject = exports.Model = exports.ModelDefinition = void 0;
+const index_1 = require("./index");
+/**
+ * Definition for a model
+ */
+class ModelDefinition {
+    constructor(nameOrDef) {
+        if (typeof nameOrDef === 'string') {
+            nameOrDef = { name: nameOrDef };
+        }
+        const { name, properties, settings, relations } = nameOrDef;
+        this.name = name;
+        this.properties = {};
+        if (properties) {
+            for (const p in properties) {
+                this.addProperty(p, properties[p]);
+            }
+        }
+        this.settings = settings !== null && settings !== void 0 ? settings : new Map();
+        this.relations = relations !== null && relations !== void 0 ? relations : {};
+    }
+    /**
+     * Add a property
+     * @param name - Property definition or name (string)
+     * @param definitionOrType - Definition or property type
+     */
+    addProperty(name, definitionOrType) {
+        const definition = definitionOrType.type
+            ? definitionOrType
+            : { type: definitionOrType };
+        if (definition.id === true &&
+            definition.generated === true &&
+            definition.type !== undefined &&
+            definition.useDefaultIdType === undefined) {
+            definition.useDefaultIdType = false;
+        }
+        this.properties[name] = definition;
+        return this;
+    }
+    /**
+     * Add a setting
+     * @param name - Setting name
+     * @param value - Setting value
+     */
+    addSetting(name, value) {
+        this.settings[name] = value;
+        return this;
+    }
+    /**
+     * Define a new relation.
+     * @param definition - The definition of the new relation.
+     */
+    addRelation(definition) {
+        this.relations[definition.name] = definition;
+        return this;
+    }
+    /**
+     * Define a new belongsTo relation.
+     * @param name - The name of the belongsTo relation.
+     * @param definition - The definition of the belongsTo relation.
+     */
+    belongsTo(name, definition) {
+        const meta = {
+            ...definition,
+            name,
+            type: index_1.RelationType.belongsTo,
+            targetsMany: false,
+        };
+        return this.addRelation(meta);
+    }
+    /**
+     * Define a new hasOne relation.
+     * @param name - The name of the hasOne relation.
+     * @param definition - The definition of the hasOne relation.
+     */
+    hasOne(name, definition) {
+        const meta = {
+            ...definition,
+            name,
+            type: index_1.RelationType.hasOne,
+            targetsMany: false,
+        };
+        return this.addRelation(meta);
+    }
+    /**
+     * Define a new hasMany relation.
+     * @param name - The name of the hasMany relation.
+     * @param definition - The definition of the hasMany relation.
+     */
+    hasMany(name, definition) {
+        const meta = {
+            ...definition,
+            name,
+            type: index_1.RelationType.hasMany,
+            targetsMany: true,
+        };
+        return this.addRelation(meta);
+    }
+    /**
+     * Get an array of names of ID properties, which are specified in
+     * the model settings or properties with `id` attribute.
+     *
+     * @example
+     * ```ts
+     * {
+     *   settings: {
+     *     id: ['id']
+     *   }
+     *   properties: {
+     *     id: {
+     *       type: 'string',
+     *       id: true
+     *     }
+     *   }
+     * }
+     * ```
+     */
+    idProperties() {
+        if (typeof this.settings.id === 'string') {
+            return [this.settings.id];
+        }
+        else if (Array.isArray(this.settings.id)) {
+            return this.settings.id;
+        }
+        const idProps = Object.keys(this.properties).filter(prop => this.properties[prop].id);
+        return idProps;
+    }
+}
+exports.ModelDefinition = ModelDefinition;
+function asJSON(value) {
+    if (value == null)
+        return value;
+    if (typeof value.toJSON === 'function') {
+        return value.toJSON();
+    }
+    // Handle arrays
+    if (Array.isArray(value)) {
+        return value.map(item => asJSON(item));
+    }
+    return value;
+}
+/**
+ * Convert a value to a plain object as DTO.
+ *
+ * - The prototype of the value in primitive types are preserved,
+ *   like `Date`, `ObjectId`.
+ * - If the value is an instance of custom model, call `toObject` to convert.
+ * - If the value is an array, convert each element recursively.
+ *
+ * @param value the value to convert
+ * @param options the options
+ */
+function asObject(value, options) {
+    if (value == null)
+        return value;
+    if (typeof value.toObject === 'function') {
+        return value.toObject(options);
+    }
+    if (Array.isArray(value)) {
+        return value.map(item => asObject(item, options));
+    }
+    return value;
+}
+/**
+ * Base class for models
+ */
+class Model {
+    constructor(data) {
+        Object.assign(this, data);
+    }
+    static get modelName() {
+        var _a;
+        return ((_a = this.definition) === null || _a === void 0 ? void 0 : _a.name) || this.name;
+    }
+    /**
+     * Serialize into a plain JSON object
+     */
+    toJSON() {
+        const def = this.constructor.definition;
+        if (def == null || def.settings.strict === false) {
+            return this.toObject({ ignoreUnknownProperties: false });
+        }
+        const copyPropertyAsJson = (key) => {
+            const val = asJSON(this[key]);
+            if (val !== undefined) {
+                json[key] = val;
+            }
+        };
+        const json = {};
+        const hiddenProperties = def.settings.hiddenProperties || [];
+        for (const p in def.properties) {
+            if (p in this && !hiddenProperties.includes(p)) {
+                copyPropertyAsJson(p);
+            }
+        }
+        for (const r in def.relations) {
+            const relName = def.relations[r].name;
+            if (relName in this) {
+                copyPropertyAsJson(relName);
+            }
+        }
+        return json;
+    }
+    /**
+     * Convert to a plain object as DTO
+     *
+     * If `ignoreUnknownProperty` is set to false, convert all properties in the
+     * model instance, otherwise only convert the ones defined in the model
+     * definitions.
+     *
+     * See function `asObject` for each property's conversion rules.
+     */
+    toObject(options) {
+        const def = this.constructor.definition;
+        const obj = {};
+        if ((options === null || options === void 0 ? void 0 : options.ignoreUnknownProperties) === false) {
+            const hiddenProperties = (def === null || def === void 0 ? void 0 : def.settings.hiddenProperties) || [];
+            for (const p in this) {
+                if (!hiddenProperties.includes(p)) {
+                    const val = this[p];
+                    obj[p] = asObject(val, options);
+                }
+            }
+            return obj;
+        }
+        if (def === null || def === void 0 ? void 0 : def.relations) {
+            for (const r in def.relations) {
+                const relName = def.relations[r].name;
+                if (relName in this) {
+                    obj[relName] = asObject(this[relName], {
+                        ...options,
+                        ignoreUnknownProperties: false,
+                    });
+                }
+            }
+        }
+        const props = def.properties;
+        const keys = Object.keys(props);
+        for (const i in keys) {
+            const propertyName = keys[i];
+            const val = this[propertyName];
+            if (val === undefined)
+                continue;
+            obj[propertyName] = asObject(val, options);
+        }
+        return obj;
+    }
+}
+exports.Model = Model;
+/**
+ * Base class for value objects - An object that contains attributes but has no
+ * conceptual identity. They should be treated as immutable.
+ */
+class ValueObject extends Model {
+}
+exports.ValueObject = ValueObject;
+/**
+ * Base class for entities which have unique ids
+ */
+class Entity extends Model {
+    /**
+     * Get the names of identity properties (primary keys).
+     */
+    static getIdProperties() {
+        return this.definition.idProperties();
+    }
+    /**
+     * Get the identity value for a given entity instance or entity data object.
+     *
+     * @param entityOrData - The data object for which to determine the identity
+     * value.
+     */
+    static getIdOf(entityOrData) {
+        if (typeof entityOrData.getId === 'function') {
+            return entityOrData.getId();
+        }
+        const idName = this.getIdProperties()[0];
+        return entityOrData[idName];
+    }
+    /**
+     * Get the identity value. If the identity is a composite key, returns
+     * an object.
+     */
+    getId() {
+        const definition = this.constructor.definition;
+        const idProps = definition.idProperties();
+        if (idProps.length === 1) {
+            return this[idProps[0]];
+        }
+        if (!idProps.length) {
+            throw new Error(`Invalid Entity ${this.constructor.name}:` +
+                'missing primary key (id) property');
+        }
+        return this.getIdObject();
+    }
+    /**
+     * Get the identity as an object, such as `{id: 1}` or
+     * `{schoolId: 1, studentId: 2}`
+     */
+    getIdObject() {
+        const definition = this.constructor.definition;
+        const idProps = definition.idProperties();
+        const idObj = {};
+        for (const idProp of idProps) {
+            idObj[idProp] = this[idProp];
+        }
+        return idObj;
+    }
+    /**
+     * Build the where object for the given id
+     * @param id - The id value
+     */
+    static buildWhereForId(id) {
+        const where = {};
+        const idProps = this.definition.idProperties();
+        if (idProps.length === 1) {
+            where[idProps[0]] = id;
+        }
+        else {
+            for (const idProp of idProps) {
+                where[idProp] = id[idProp];
+            }
+        }
+        return where;
+    }
+}
+exports.Entity = Entity;
+/**
+ * Domain events
+ */
+class Event {
+}
+exports.Event = Event;
+/**
+ * Check model data for navigational properties linking to related models.
+ * Throw a descriptive error if any such property is found.
+ *
+ * @param modelClass Model constructor, e.g. `Product`.
+ * @param entityData  Model instance or a plain-data object,
+ * e.g. `{name: 'pen'}`.
+ */
+function rejectNavigationalPropertiesInData(modelClass, data) {
+    const def = modelClass.definition;
+    const props = def.properties;
+    for (const r in def.relations) {
+        const relName = def.relations[r].name;
+        if (!(relName in data))
+            continue;
+        let msg = 'Navigational properties are not allowed in model data ' +
+            `(model "${modelClass.modelName}" property "${relName}"), ` +
+            'please remove it.';
+        if (relName in props) {
+            msg +=
+                ' The error might be invoked by belongsTo relations, please make' +
+                    ' sure the relation name is not the same as the property name.';
+        }
+        throw new Error(msg);
+    }
+}
+exports.rejectNavigationalPropertiesInData = rejectNavigationalPropertiesInData;
+//# sourceMappingURL=model.js.map

package/dist/model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.js","sourceRoot":"","sources":["../src/model.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;;AAGhE,mCAOiB;AAoGjB;;GAEG;AACH,MAAa,eAAe;IAQ1B,YAAY,SAAyC;QACnD,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;YACjC,SAAS,GAAG,EAAC,IAAI,EAAE,SAAS,EAAC,CAAC;SAC/B;QACD,MAAM,EAAC,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,SAAS,EAAC,GAAG,SAAS,CAAC;QAE1D,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QAEjB,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrB,IAAI,UAAU,EAAE;YACd,KAAK,MAAM,CAAC,IAAI,UAAU,EAAE;gBAC1B,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;aACpC;SACF;QAED,IAAI,CAAC,QAAQ,GAAG,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,IAAI,GAAG,EAAE,CAAC;QACtC,IAAI,CAAC,SAAS,GAAG,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,EAAE,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACH,WAAW,CACT,IAAY,EACZ,gBAAmD;QAEnD,MAAM,UAAU,GAAI,gBAAuC,CAAC,IAAI;YAC9D,CAAC,CAAE,gBAAuC;YAC1C,CAAC,CAAC,EAAC,IAAI,EAAE,gBAAgB,EAAC,CAAC;QAE7B,IACE,UAAU,CAAC,EAAE,KAAK,IAAI;YACtB,UAAU,CAAC,SAAS,KAAK,IAAI;YAC7B,UAAU,CAAC,IAAI,KAAK,SAAS;YAC7B,UAAU,CAAC,gBAAgB,KAAK,SAAS,EACzC;YACA,UAAU,CAAC,gBAAgB,GAAG,KAAK,CAAC;SACrC;QAED,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,IAAY,EAAE,KAAU;QACjC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,WAAW,CAAC,UAA4B;QACtC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,SAAS,CACP,IAAY,EACZ,UAAsE;QAEtE,MAAM,IAAI,GAAwB;YAChC,GAAG,UAAU;YACb,IAAI;YACJ,IAAI,EAAE,oBAAY,CAAC,SAAS;YAC5B,WAAW,EAAE,KAAK;SACnB,CAAC;QACF,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACH,MAAM,CACJ,IAAY,EACZ,UAAmE;QAEnE,MAAM,IAAI,GAAqB;YAC7B,GAAG,UAAU;YACb,IAAI;YACJ,IAAI,EAAE,oBAAY,CAAC,MAAM;YACzB,WAAW,EAAE,KAAK;SACnB,CAAC;QACF,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACH,OAAO,CACL,IAAY,EACZ,UAAoE;QAEpE,MAAM,IAAI,GAAsB;YAC9B,GAAG,UAAU;YACb,IAAI;YACJ,IAAI,EAAE,oBAAY,CAAC,OAAO;YAC1B,WAAW,EAAE,IAAI;SAClB,CAAC;QACF,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,YAAY;QACV,IAAI,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,KAAK,QAAQ,EAAE;YACxC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;SAC3B;aAAM,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE;YAC1C,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;SACzB;QACD,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,CACjD,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,EAAE,CACjC,CAAC;QACF,OAAO,OAAO,CAAC;IACjB,CAAC;CACF;AA5JD,0CA4JC;AAED,SAAS,MAAM,CAAC,KAAU;IACxB,IAAI,KAAK,IAAI,IAAI;QAAE,OAAO,KAAK,CAAC;IAChC,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,UAAU,EAAE;QACtC,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC;KACvB;IACD,gBAAgB;IAChB,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QACxB,OAAO,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;KACxC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,QAAQ,CAAC,KAAU,EAAE,OAAiB;IAC7C,IAAI,KAAK,IAAI,IAAI;QAAE,OAAO,KAAK,CAAC;IAChC,IAAI,OAAO,KAAK,CAAC,QAAQ,KAAK,UAAU,EAAE;QACxC,OAAO,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;KAChC;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QACxB,OAAO,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;KACnD;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;GAEG;AACH,MAAa,KAAK;IA2FhB,YAAY,IAAwB;QAClC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC5B,CAAC;IA5FD,MAAM,KAAK,SAAS;;QAClB,OAAO,CAAA,MAAA,IAAI,CAAC,UAAU,0CAAE,IAAI,KAAI,IAAI,CAAC,IAAI,CAAC;IAC5C,CAAC;IAID;;OAEG;IACH,MAAM;QACJ,MAAM,GAAG,GAAI,IAAI,CAAC,WAA4B,CAAC,UAAU,CAAC;QAC1D,IAAI,GAAG,IAAI,IAAI,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,KAAK,KAAK,EAAE;YAChD,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAC,uBAAuB,EAAE,KAAK,EAAC,CAAC,CAAC;SACxD;QAED,MAAM,kBAAkB,GAAG,CAAC,GAAW,EAAE,EAAE;YACzC,MAAM,GAAG,GAAG,MAAM,CAAE,IAAkB,CAAC,GAAG,CAAC,CAAC,CAAC;YAC7C,IAAI,GAAG,KAAK,SAAS,EAAE;gBACrB,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;aACjB;QACH,CAAC,CAAC;QAEF,MAAM,IAAI,GAAc,EAAE,CAAC;QAC3B,MAAM,gBAAgB,GAAa,GAAG,CAAC,QAAQ,CAAC,gBAAgB,IAAI,EAAE,CAAC;QACvE,KAAK,MAAM,CAAC,IAAI,GAAG,CAAC,UAAU,EAAE;YAC9B,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;gBAC9C,kBAAkB,CAAC,CAAC,CAAC,CAAC;aACvB;SACF;QAED,KAAK,MAAM,CAAC,IAAI,GAAG,CAAC,SAAS,EAAE;YAC7B,MAAM,OAAO,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YACtC,IAAI,OAAO,IAAI,IAAI,EAAE;gBACnB,kBAAkB,CAAC,OAAO,CAAC,CAAC;aAC7B;SACF;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,OAAiB;QACxB,MAAM,GAAG,GAAI,IAAI,CAAC,WAA4B,CAAC,UAAU,CAAC;QAC1D,MAAM,GAAG,GAAc,EAAE,CAAC;QAE1B,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,uBAAuB,MAAK,KAAK,EAAE;YAC9C,MAAM,gBAAgB,GAAa,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,QAAQ,CAAC,gBAAgB,KAAI,EAAE,CAAC;YACxE,KAAK,MAAM,CAAC,IAAI,IAAI,EAAE;gBACpB,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;oBACjC,MAAM,GAAG,GAAI,IAAkB,CAAC,CAAC,CAAC,CAAC;oBACnC,GAAG,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;iBACjC;aACF;YACD,OAAO,GAAG,CAAC;SACZ;QAED,IAAI,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,SAAS,EAAE;YAClB,KAAK,MAAM,CAAC,IAAI,GAAG,CAAC,SAAS,EAAE;gBAC7B,MAAM,OAAO,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;gBACtC,IAAI,OAAO,IAAI,IAAI,EAAE;oBACnB,GAAG,CAAC,OAAO,CAAC,GAAG,QAAQ,CAAE,IAAkB,CAAC,OAAO,CAAC,EAAE;wBACpD,GAAG,OAAO;wBACV,uBAAuB,EAAE,KAAK;qBAC/B,CAAC,CAAC;iBACJ;aACF;SACF;QAED,MAAM,KAAK,GAAG,GAAG,CAAC,UAAU,CAAC;QAC7B,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAEhC,KAAK,MAAM,CAAC,IAAI,IAAI,EAAE;YACpB,MAAM,YAAY,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YAC7B,MAAM,GAAG,GAAI,IAAkB,CAAC,YAAY,CAAC,CAAC;YAE9C,IAAI,GAAG,KAAK,SAAS;gBAAE,SAAS;YAChC,GAAG,CAAC,YAAY,CAAC,GAAG,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;SAC5C;QAED,OAAO,GAAG,CAAC;IACb,CAAC;CAKF;AA9FD,sBA8FC;AAMD;;;GAGG;AACH,MAAsB,WAAY,SAAQ,KAAK;CAA0B;AAAzE,kCAAyE;AAEzE;;GAEG;AACH,MAAa,MAAO,SAAQ,KAAK;IAC/B;;OAEG;IACH,MAAM,CAAC,eAAe;QACpB,OAAO,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,OAAO,CAAC,YAAuB;QACpC,IAAI,OAAO,YAAY,CAAC,KAAK,KAAK,UAAU,EAAE;YAC5C,OAAO,YAAY,CAAC,KAAK,EAAE,CAAC;SAC7B;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,CAAC;QACzC,OAAO,YAAY,CAAC,MAAM,CAAC,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACH,KAAK;QACH,MAAM,UAAU,GAAI,IAAI,CAAC,WAA6B,CAAC,UAAU,CAAC;QAClE,MAAM,OAAO,GAAG,UAAU,CAAC,YAAY,EAAE,CAAC;QAC1C,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE;YACxB,OAAQ,IAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;SACxC;QACD,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;YACnB,MAAM,IAAI,KAAK,CACb,kBAAkB,IAAI,CAAC,WAAW,CAAC,IAAI,GAAG;gBACxC,mCAAmC,CACtC,CAAC;SACH;QACD,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACH,WAAW;QACT,MAAM,UAAU,GAAI,IAAI,CAAC,WAA6B,CAAC,UAAU,CAAC;QAClE,MAAM,OAAO,GAAG,UAAU,CAAC,YAAY,EAAE,CAAC;QAC1C,MAAM,KAAK,GAAG,EAAS,CAAC;QACxB,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;YAC5B,KAAK,CAAC,MAAM,CAAC,GAAI,IAAkB,CAAC,MAAM,CAAC,CAAC;SAC7C;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,eAAe,CAAC,EAAO;QAC5B,MAAM,KAAK,GAAG,EAAS,CAAC;QACxB,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,CAAC;QAC/C,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE;YACxB,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;SACxB;aAAM;YACL,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;gBAC5B,KAAK,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,CAAC;aAC5B;SACF;QACD,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAxED,wBAwEC;AAED;;GAEG;AACH,MAAa,KAAK;CAGjB;AAHD,sBAGC;AAMD;;;;;;;GAOG;AACH,SAAgB,kCAAkC,CAChD,UAAa,EACb,IAAgC;IAEhC,MAAM,GAAG,GAAG,UAAU,CAAC,UAAU,CAAC;IAClC,MAAM,KAAK,GAAG,GAAG,CAAC,UAAU,CAAC;IAE7B,KAAK,MAAM,CAAC,IAAI,GAAG,CAAC,SAAS,EAAE;QAC7B,MAAM,OAAO,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACtC,IAAI,CAAC,CAAC,OAAO,IAAI,IAAI,CAAC;YAAE,SAAS;QAEjC,IAAI,GAAG,GACL,wDAAwD;YACxD,WAAW,UAAU,CAAC,SAAS,eAAe,OAAO,MAAM;YAC3D,mBAAmB,CAAC;QAEtB,IAAI,OAAO,IAAI,KAAK,EAAE;YACpB,GAAG;gBACD,iEAAiE;oBACjE,+DAA+D,CAAC;SACnE;QAED,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;KACtB;AACH,CAAC;AAxBD,gFAwBC"}

package/dist/relations/belongs-to/belongs-to.accessor.d.ts

@@ -0,0 +1,17 @@
+import { Entity } from '../../model';
+import { EntityCrudRepository } from '../../repositories/repository';
+import { BelongsToDefinition, Getter, InclusionResolver } from '../relation.types';
+export interface BelongsToAccessor<Target extends Entity, SourceId> {
+    /**
+     * Invoke the function to obtain HasManyRepository.
+     */
+    (sourceId: SourceId): Promise<Target>;
+    /**
+     * Use `resolver` property to obtain an InclusionResolver for this relation.
+     */
+    inclusionResolver: InclusionResolver<Entity, Target>;
+}
+/**
+ * Enforces a BelongsTo constraint on a repository
+ */
+export declare function createBelongsToAccessor<Target extends Entity, TargetId, Source extends Entity, SourceId>(belongsToMetadata: BelongsToDefinition, targetRepoGetter: Getter<EntityCrudRepository<Target, TargetId>>, sourceRepository: EntityCrudRepository<Source, SourceId>): BelongsToAccessor<Target, SourceId>;

package/dist/relations/belongs-to/belongs-to.accessor.js

@@ -0,0 +1,40 @@
+"use strict";
+// Copyright IBM Corp. 2018,2019. 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.createBelongsToAccessor = void 0;
+const tslib_1 = require("tslib");
+const debug_1 = (0, tslib_1.__importDefault)(require("debug"));
+const belongs_to_helpers_1 = require("./belongs-to.helpers");
+const belongs_to_inclusion_resolver_1 = require("./belongs-to.inclusion-resolver");
+const belongs_to_repository_1 = require("./belongs-to.repository");
+const debug = (0, debug_1.default)('loopback:repository:relations:belongs-to:accessor');
+/**
+ * Enforces a BelongsTo constraint on a repository
+ */
+function createBelongsToAccessor(belongsToMetadata, targetRepoGetter, sourceRepository) {
+    const meta = (0, belongs_to_helpers_1.resolveBelongsToMetadata)(belongsToMetadata);
+    debug('Resolved BelongsTo relation metadata: %o', meta);
+    const result = async function getTargetInstanceOfBelongsTo(sourceId) {
+        const foreignKey = meta.keyFrom;
+        const primaryKey = meta.keyTo;
+        const sourceModel = await sourceRepository.findById(sourceId);
+        const foreignKeyValue = sourceModel[foreignKey];
+        // workaround to check referential integrity.
+        // should be removed once the memory connector ref integrity is done
+        // GH issue: https://github.com/loopbackio/loopback-next/issues/2333
+        if (!foreignKeyValue) {
+            return undefined;
+        }
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const constraint = { [primaryKey]: foreignKeyValue };
+        const constrainedRepo = new belongs_to_repository_1.DefaultBelongsToRepository(targetRepoGetter, constraint);
+        return constrainedRepo.get();
+    };
+    result.inclusionResolver = (0, belongs_to_inclusion_resolver_1.createBelongsToInclusionResolver)(meta, targetRepoGetter);
+    return result;
+}
+exports.createBelongsToAccessor = createBelongsToAccessor;
+//# sourceMappingURL=belongs-to.accessor.js.map

package/dist/relations/belongs-to/belongs-to.accessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"belongs-to.accessor.js","sourceRoot":"","sources":["../../../src/relations/belongs-to/belongs-to.accessor.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,+DAAiC;AASjC,6DAA8D;AAC9D,mFAAiF;AACjF,mEAAmE;AAEnE,MAAM,KAAK,GAAG,IAAA,eAAY,EAAC,mDAAmD,CAAC,CAAC;AAchF;;GAEG;AACH,SAAgB,uBAAuB,CAMrC,iBAAsC,EACtC,gBAAgE,EAChE,gBAAwD;IAExD,MAAM,IAAI,GAAG,IAAA,6CAAwB,EAAC,iBAAiB,CAAC,CAAC;IACzD,KAAK,CAAC,0CAA0C,EAAE,IAAI,CAAC,CAAC;IACxD,MAAM,MAAM,GACV,KAAK,UAAU,4BAA4B,CAAC,QAAkB;QAC5D,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC;QAChC,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC;QAC9B,MAAM,WAAW,GAAG,MAAM,gBAAgB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC9D,MAAM,eAAe,GAAG,WAAW,CAAC,UAA0B,CAAC,CAAC;QAChE,6CAA6C;QAC7C,oEAAoE;QACpE,oEAAoE;QACpE,IAAI,CAAC,eAAe,EAAE;YACpB,OAAO,SAA8B,CAAC;SACvC;QACD,8DAA8D;QAC9D,MAAM,UAAU,GAAQ,EAAC,CAAC,UAAU,CAAC,EAAE,eAAe,EAAC,CAAC;QACxD,MAAM,eAAe,GAAG,IAAI,kDAA0B,CACpD,gBAAgB,EAChB,UAAgC,CACjC,CAAC;QACF,OAAO,eAAe,CAAC,GAAG,EAAE,CAAC;IAC/B,CAAC,CAAC;IAEJ,MAAM,CAAC,iBAAiB,GAAG,IAAA,gEAAgC,EACzD,IAAI,EACJ,gBAAgB,CACjB,CAAC;IACF,OAAO,MAAM,CAAC;AAChB,CAAC;AAtCD,0DAsCC"}

package/dist/relations/belongs-to/belongs-to.decorator.d.ts

@@ -0,0 +1,11 @@
+import { Entity, EntityResolver, PropertyDefinition } from '../../model';
+import { BelongsToDefinition } from '../relation.types';
+/**
+ * Decorator for belongsTo
+ * @param targetResolver - A resolver function that returns the target model for
+ * a belongsTo relation
+ * @param definition - Optional metadata for setting up a belongsTo relation
+ * @param propertyDefinition - Optional metadata for setting up the property
+ * @returns A property decorator
+ */
+export declare function belongsTo<T extends Entity>(targetResolver: EntityResolver<T>, definition?: Partial<BelongsToDefinition>, propertyDefinition?: Partial<PropertyDefinition>): (decoratedTarget: Entity, decoratedKey: string) => void;

package/dist/relations/belongs-to/belongs-to.decorator.js

@@ -0,0 +1,64 @@
+"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.belongsTo = void 0;
+const core_1 = require("@loopback/core");
+const decorators_1 = require("../../decorators");
+const relation_decorator_1 = require("../relation.decorator");
+const relation_types_1 = require("../relation.types");
+/**
+ * Decorator for belongsTo
+ * @param targetResolver - A resolver function that returns the target model for
+ * a belongsTo relation
+ * @param definition - Optional metadata for setting up a belongsTo relation
+ * @param propertyDefinition - Optional metadata for setting up the property
+ * @returns A property decorator
+ */
+function belongsTo(targetResolver, definition, propertyDefinition) {
+    return function (decoratedTarget, decoratedKey) {
+        var _a;
+        const propType = (_a = core_1.MetadataInspector.getDesignTypeForProperty(decoratedTarget, decoratedKey)) !== null && _a !== void 0 ? _a : propertyDefinition === null || propertyDefinition === void 0 ? void 0 : propertyDefinition.type;
+        if (!propType) {
+            const fullPropName = core_1.DecoratorFactory.getTargetName(decoratedTarget, decoratedKey);
+            throw new Error(`Cannot infer type of model property ${fullPropName} because ` +
+                'TypeScript compiler option `emitDecoratorMetadata` is not set. ' +
+                'Please enable `emitDecoratorMetadata` or use the third argument of ' +
+                '`@belongsTo` decorator to specify the property type explicitly.');
+        }
+        const propMeta = Object.assign({}, 
+        // properties provided by the caller
+        propertyDefinition, 
+        // properties enforced by the decorator
+        {
+            type: propType,
+            // TODO(bajtos) Make the foreign key required once our REST API layer
+            // allows controller methods to exclude required properties
+            // required: true,
+        });
+        (0, decorators_1.property)(propMeta)(decoratedTarget, decoratedKey);
+        // @belongsTo() is typically decorating the foreign key property,
+        // e.g. customerId. We need to strip the trailing "Id" suffix from the name.
+        const relationName = decoratedKey.replace(/Id$/, '');
+        const meta = Object.assign(
+        // default values, can be customized by the caller
+        {
+            keyFrom: decoratedKey,
+            name: relationName,
+        }, 
+        // properties provided by the caller
+        definition, 
+        // properties enforced by the decorator
+        {
+            type: relation_types_1.RelationType.belongsTo,
+            targetsMany: false,
+            source: decoratedTarget.constructor,
+            target: targetResolver,
+        });
+        (0, relation_decorator_1.relation)(meta)(decoratedTarget, decoratedKey);
+    };
+}
+exports.belongsTo = belongsTo;
+//# sourceMappingURL=belongs-to.decorator.js.map

package/dist/relations/belongs-to/belongs-to.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"belongs-to.decorator.js","sourceRoot":"","sources":["../../../src/relations/belongs-to/belongs-to.decorator.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;;AAEhE,yCAAmE;AACnE,iDAA0C;AAC1C,8DAA+C;AAE/C,sDAAoE;AAEpE;;;;;;;GAOG;AACH,SAAgB,SAAS,CACvB,cAAiC,EACjC,UAAyC,EACzC,kBAAgD;IAEhD,OAAO,UAAU,eAAuB,EAAE,YAAoB;;QAC5D,MAAM,QAAQ,GACZ,MAAA,wBAAiB,CAAC,wBAAwB,CACxC,eAAe,EACf,YAAY,CACb,mCAAI,kBAAkB,aAAlB,kBAAkB,uBAAlB,kBAAkB,CAAE,IAAI,CAAC;QAEhC,IAAI,CAAC,QAAQ,EAAE;YACb,MAAM,YAAY,GAAG,uBAAgB,CAAC,aAAa,CACjD,eAAe,EACf,YAAY,CACb,CAAC;YACF,MAAM,IAAI,KAAK,CACb,uCAAuC,YAAY,WAAW;gBAC5D,iEAAiE;gBACjE,qEAAqE;gBACrE,iEAAiE,CACpE,CAAC;SACH;QAED,MAAM,QAAQ,GAAuB,MAAM,CAAC,MAAM,CAChD,EAAE;QACF,oCAAoC;QACpC,kBAAkB;QAClB,uCAAuC;QACvC;YACE,IAAI,EAAE,QAAQ;YACd,qEAAqE;YACrE,2DAA2D;YAC3D,kBAAkB;SACnB,CACF,CAAC;QACF,IAAA,qBAAQ,EAAC,QAAQ,CAAC,CAAC,eAAe,EAAE,YAAY,CAAC,CAAC;QAElD,iEAAiE;QACjE,4EAA4E;QAC5E,MAAM,YAAY,GAAG,YAAY,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAErD,MAAM,IAAI,GAAwB,MAAM,CAAC,MAAM;QAC7C,kDAAkD;QAClD;YACE,OAAO,EAAE,YAAY;YACrB,IAAI,EAAE,YAAY;SACnB;QACD,oCAAoC;QACpC,UAAU;QACV,uCAAuC;QACvC;YACE,IAAI,EAAE,6BAAY,CAAC,SAAS;YAC5B,WAAW,EAAE,KAAK;YAClB,MAAM,EAAE,eAAe,CAAC,WAAW;YACnC,MAAM,EAAE,cAAc;SACvB,CACF,CAAC;QACF,IAAA,6BAAQ,EAAC,IAAI,CAAC,CAAC,eAAe,EAAE,YAAY,CAAC,CAAC;IAChD,CAAC,CAAC;AACJ,CAAC;AA7DD,8BA6DC"}

package/dist/relations/belongs-to/belongs-to.helpers.d.ts

@@ -0,0 +1,17 @@
+import { BelongsToDefinition } from '../relation.types';
+/**
+ * Relation definition with optional metadata (e.g. `keyTo`) filled in.
+ * @internal
+ */
+export declare type BelongsToResolvedDefinition = BelongsToDefinition & {
+    keyFrom: string;
+    keyTo: string;
+};
+/**
+ * Resolves given belongsTo metadata if target is specified to be a resolver.
+ * Mainly used to infer what the `keyTo` property should be from the target's
+ * property id metadata
+ * @param relationMeta - belongsTo metadata to resolve
+ * @internal
+ */
+export declare function resolveBelongsToMetadata(relationMeta: BelongsToDefinition): BelongsToResolvedDefinition;

package/dist/relations/belongs-to/belongs-to.helpers.js

@@ -0,0 +1,63 @@
+"use strict";
+// Copyright IBM Corp. 2019. 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.resolveBelongsToMetadata = void 0;
+const tslib_1 = require("tslib");
+const debug_1 = (0, tslib_1.__importDefault)(require("debug"));
+const lodash_1 = require("lodash");
+const errors_1 = require("../../errors");
+const type_resolver_1 = require("../../type-resolver");
+const relation_types_1 = require("../relation.types");
+const debug = (0, debug_1.default)('loopback:repository:relations:belongs-to:helpers');
+/**
+ * Resolves given belongsTo metadata if target is specified to be a resolver.
+ * Mainly used to infer what the `keyTo` property should be from the target's
+ * property id metadata
+ * @param relationMeta - belongsTo metadata to resolve
+ * @internal
+ */
+function resolveBelongsToMetadata(relationMeta) {
+    if (relationMeta.type !== relation_types_1.RelationType.belongsTo) {
+        const reason = 'relation type must be BelongsTo';
+        throw new errors_1.InvalidRelationError(reason, relationMeta);
+    }
+    if (!(0, type_resolver_1.isTypeResolver)(relationMeta.target)) {
+        const reason = 'target must be a type resolver';
+        throw new errors_1.InvalidRelationError(reason, relationMeta);
+    }
+    const sourceModel = relationMeta.source;
+    if (!sourceModel || !sourceModel.modelName) {
+        const reason = 'source model must be defined';
+        throw new errors_1.InvalidRelationError(reason, relationMeta);
+    }
+    const targetModel = relationMeta.target();
+    const targetName = targetModel.modelName;
+    debug('Resolved model %s from given metadata: %o', targetName, targetModel);
+    let keyFrom;
+    if (relationMeta.keyFrom &&
+        relationMeta.source.definition.properties[relationMeta.keyFrom]) {
+        keyFrom = relationMeta.keyFrom;
+    }
+    else {
+        keyFrom = (0, lodash_1.camelCase)(targetName + '_id');
+    }
+    const targetProperties = targetModel.definition.properties;
+    debug('relation metadata from %o: %o', targetName, targetProperties);
+    if (relationMeta.keyTo && targetProperties[relationMeta.keyTo]) {
+        // The explicit cast is needed because of a limitation of type inference
+        return Object.assign(relationMeta, {
+            keyFrom,
+        });
+    }
+    const targetPrimaryKey = targetModel.definition.idProperties()[0];
+    if (!targetPrimaryKey) {
+        const reason = `${targetName} does not have any primary key (id property)`;
+        throw new errors_1.InvalidRelationError(reason, relationMeta);
+    }
+    return Object.assign(relationMeta, { keyFrom, keyTo: targetPrimaryKey });
+}
+exports.resolveBelongsToMetadata = resolveBelongsToMetadata;
+//# sourceMappingURL=belongs-to.helpers.js.map

package/dist/relations/belongs-to/belongs-to.helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"belongs-to.helpers.js","sourceRoot":"","sources":["../../../src/relations/belongs-to/belongs-to.helpers.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,+DAAiC;AACjC,mCAAiC;AACjC,yCAAkD;AAClD,uDAAmD;AACnD,sDAAoE;AAEpE,MAAM,KAAK,GAAG,IAAA,eAAY,EAAC,kDAAkD,CAAC,CAAC;AAW/E;;;;;;GAMG;AACH,SAAgB,wBAAwB,CAAC,YAAiC;IACxE,IAAK,YAAY,CAAC,IAAqB,KAAK,6BAAY,CAAC,SAAS,EAAE;QAClE,MAAM,MAAM,GAAG,iCAAiC,CAAC;QACjD,MAAM,IAAI,6BAAoB,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;KACtD;IAED,IAAI,CAAC,IAAA,8BAAc,EAAC,YAAY,CAAC,MAAM,CAAC,EAAE;QACxC,MAAM,MAAM,GAAG,gCAAgC,CAAC;QAChD,MAAM,IAAI,6BAAoB,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;KACtD;IAED,MAAM,WAAW,GAAG,YAAY,CAAC,MAAM,CAAC;IACxC,IAAI,CAAC,WAAW,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE;QAC1C,MAAM,MAAM,GAAG,8BAA8B,CAAC;QAC9C,MAAM,IAAI,6BAAoB,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;KACtD;IAED,MAAM,WAAW,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC;IAC1C,MAAM,UAAU,GAAG,WAAW,CAAC,SAAS,CAAC;IACzC,KAAK,CAAC,2CAA2C,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;IAE5E,IAAI,OAAO,CAAC;IACZ,IACE,YAAY,CAAC,OAAO;QACpB,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,YAAY,CAAC,OAAO,CAAC,EAC/D;QACA,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC;KAChC;SAAM;QACL,OAAO,GAAG,IAAA,kBAAS,EAAC,UAAU,GAAG,KAAK,CAAC,CAAC;KACzC;IAED,MAAM,gBAAgB,GAAG,WAAW,CAAC,UAAU,CAAC,UAAU,CAAC;IAC3D,KAAK,CAAC,+BAA+B,EAAE,UAAU,EAAE,gBAAgB,CAAC,CAAC;IAErE,IAAI,YAAY,CAAC,KAAK,IAAI,gBAAgB,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE;QAC9D,wEAAwE;QACxE,OAAO,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE;YACjC,OAAO;SACR,CAAgC,CAAC;KACnC;IAED,MAAM,gBAAgB,GAAG,WAAW,CAAC,UAAU,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,CAAC;IAClE,IAAI,CAAC,gBAAgB,EAAE;QACrB,MAAM,MAAM,GAAG,GAAG,UAAU,8CAA8C,CAAC;QAC3E,MAAM,IAAI,6BAAoB,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;KACtD;IAED,OAAO,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,EAAC,OAAO,EAAE,KAAK,EAAE,gBAAgB,EAAC,CAAC,CAAC;AACzE,CAAC;AAhDD,4DAgDC"}

package/dist/relations/belongs-to/belongs-to.inclusion-resolver.d.ts

@@ -0,0 +1,14 @@
+import { Entity } from '../../model';
+import { EntityCrudRepository } from '../../repositories';
+import { BelongsToDefinition, Getter, InclusionResolver } from '../relation.types';
+/**
+ * Creates InclusionResolver for BelongsTo relation.
+ * Notice that this function only generates the inclusionResolver.
+ * It doesn't register it for the source repository.
+ *
+ * Notice: scope field for inclusion is not supported yet
+ *
+ * @param meta - resolved BelongsToMetadata
+ * @param getTargetRepo - target repository i.e where related instances are
+ */
+export declare function createBelongsToInclusionResolver<Target extends Entity, TargetID, TargetRelations extends object>(meta: BelongsToDefinition, getTargetRepo: Getter<EntityCrudRepository<Target, TargetID, TargetRelations>>): InclusionResolver<Entity, Target>;

package/dist/relations/belongs-to/belongs-to.inclusion-resolver.js

@@ -0,0 +1,36 @@
+"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.createBelongsToInclusionResolver = void 0;
+const relation_helpers_1 = require("../relation.helpers");
+const belongs_to_helpers_1 = require("./belongs-to.helpers");
+/**
+ * Creates InclusionResolver for BelongsTo relation.
+ * Notice that this function only generates the inclusionResolver.
+ * It doesn't register it for the source repository.
+ *
+ * Notice: scope field for inclusion is not supported yet
+ *
+ * @param meta - resolved BelongsToMetadata
+ * @param getTargetRepo - target repository i.e where related instances are
+ */
+function createBelongsToInclusionResolver(meta, getTargetRepo) {
+    const relationMeta = (0, belongs_to_helpers_1.resolveBelongsToMetadata)(meta);
+    return async function fetchIncludedModels(entities, inclusion, options) {
+        if (!entities.length)
+            return [];
+        const sourceKey = relationMeta.keyFrom;
+        const sourceIds = entities.map(e => e[sourceKey]);
+        const targetKey = relationMeta.keyTo;
+        const dedupedSourceIds = (0, relation_helpers_1.deduplicate)(sourceIds);
+        const scope = typeof inclusion === 'string' ? {} : inclusion.scope;
+        const targetRepo = await getTargetRepo();
+        const targetsFound = await (0, relation_helpers_1.findByForeignKeys)(targetRepo, targetKey, dedupedSourceIds.filter(e => e), scope, options);
+        return (0, relation_helpers_1.flattenTargetsOfOneToOneRelation)(sourceIds, targetsFound, targetKey);
+    };
+}
+exports.createBelongsToInclusionResolver = createBelongsToInclusionResolver;
+//# sourceMappingURL=belongs-to.inclusion-resolver.js.map