@goatlab/fluent 0.7.39 → 0.7.41

package/dist/core/Loopback/query.js

@@ -0,0 +1,484 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FilterBuilder = exports.WhereBuilder = void 0;
+exports.isFilter = isFilter;
+exports.filterTemplate = filterTemplate;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const nonWhereFields = ['fields', 'order', 'limit', 'skip', 'offset', 'include'];
+const filterFields = ['where', ...nonWhereFields];
+/**
+ * TypeGuard for Filter
+ * @param candidate
+ */
+function isFilter(candidate) {
+    if (typeof candidate !== 'object')
+        return false;
+    for (const key in candidate) {
+        if (!filterFields.includes(key)) {
+            return false;
+        }
+    }
+    return true;
+}
+/**
+ * A builder for Where object. It provides fluent APIs to add clauses such as
+ * `and`, `or`, and other operators.
+ *
+ * @example
+ * ```ts
+ * const whereBuilder = new WhereBuilder();
+ * const where = whereBuilder
+ *   .eq('a', 1)
+ *   .and({x: 'x'}, {y: {gt: 1}})
+ *   .and({b: 'b'}, {c: {lt: 1}})
+ *   .or({d: 'd'}, {e: {neq: 1}})
+ *   .build();
+ * ```
+ */
+class WhereBuilder {
+    where;
+    constructor(w) {
+        this.where = w ?? {};
+    }
+    add(w) {
+        for (const k of Object.keys(w)) {
+            if (k in this.where) {
+                // Found conflicting keys, create an `and` operator to join the existing
+                // conditions with the new one
+                const where = { and: [this.where, w] };
+                this.where = where;
+                return this;
+            }
+        }
+        // Merge the where items
+        this.where = Object.assign(this.where, w);
+        return this;
+    }
+    /**
+     * @deprecated
+     * Starting from TypeScript 3.2, we don't have to cast any more. This method
+     * should be considered as `deprecated`.
+     *
+     * Cast an `and`, `or`, or condition clause to Where
+     * @param clause - And/Or/Condition clause
+     */
+    cast(clause) {
+        return clause;
+    }
+    /**
+     * Add an `and` clause.
+     * @param w - One or more where objects
+     */
+    and(...w) {
+        let clauses = [];
+        w.forEach(where => {
+            clauses = clauses.concat(Array.isArray(where) ? where : [where]);
+        });
+        return this.add({ and: clauses });
+    }
+    /**
+     * Add an `or` clause.
+     * @param w - One or more where objects
+     */
+    or(...w) {
+        let clauses = [];
+        w.forEach(where => {
+            clauses = clauses.concat(Array.isArray(where) ? where : [where]);
+        });
+        return this.add({ or: clauses });
+    }
+    /**
+     * Add an `=` condition
+     * @param key - Property name
+     * @param val - Property value
+     */
+    eq(key, val) {
+        const w = {};
+        w[key] = val;
+        return this.add(w);
+    }
+    /**
+     * Add a `!=` condition
+     * @param key - Property name
+     * @param val - Property value
+     */
+    neq(key, val) {
+        const w = {};
+        w[key] = { neq: val };
+        return this.add(w);
+    }
+    /**
+     * Add a `>` condition
+     * @param key - Property name
+     * @param val - Property value
+     */
+    gt(key, val) {
+        const w = {};
+        w[key] = { gt: val };
+        return this.add(w);
+    }
+    /**
+     * Add a `>=` condition
+     * @param key - Property name
+     * @param val - Property value
+     */
+    gte(key, val) {
+        const w = {};
+        w[key] = { gte: val };
+        return this.add(w);
+    }
+    /**
+     * Add a `<` condition
+     * @param key - Property name
+     * @param val - Property value
+     */
+    lt(key, val) {
+        const w = {};
+        w[key] = { lt: val };
+        return this.add(w);
+    }
+    /**
+     * Add a `<=` condition
+     * @param key - Property name
+     * @param val - Property value
+     */
+    lte(key, val) {
+        const w = {};
+        w[key] = { lte: val };
+        return this.add(w);
+    }
+    /**
+     * Add a `inq` condition
+     * @param key - Property name
+     * @param val - An array of property values
+     */
+    inq(key, val) {
+        const w = {};
+        w[key] = { inq: val };
+        return this.add(w);
+    }
+    /**
+     * Add a `nin` condition
+     * @param key - Property name
+     * @param val - An array of property values
+     */
+    nin(key, val) {
+        const w = {};
+        w[key] = { nin: val };
+        return this.add(w);
+    }
+    /**
+     * Add a `between` condition
+     * @param key - Property name
+     * @param val1 - Property value lower bound
+     * @param val2 - Property value upper bound
+     */
+    between(key, val1, val2) {
+        const w = {};
+        w[key] = { between: [val1, val2] };
+        return this.add(w);
+    }
+    /**
+     * Add a `exists` condition
+     * @param key - Property name
+     * @param val - Exists or not
+     */
+    exists(key, val) {
+        const w = {};
+        w[key] = { exists: !!val || val == null };
+        return this.add(w);
+    }
+    /**
+     * Add a where object. For conflicting keys with the existing where object,
+     * create an `and` clause.
+     * @param where - Where filter
+     */
+    impose(where) {
+        if (!this.where) {
+            this.where = where || {};
+        }
+        else {
+            this.add(where);
+        }
+        return this;
+    }
+    /**
+     * Add a `like` condition
+     * @param key - Property name
+     * @param val - Regexp condition
+     */
+    like(key, val) {
+        const w = {};
+        w[key] = { like: val };
+        return this.add(w);
+    }
+    /**
+     * Add a `nlike` condition
+     * @param key - Property name
+     * @param val - Regexp condition
+     */
+    nlike(key, val) {
+        const w = {};
+        w[key] = { nlike: val };
+        return this.add(w);
+    }
+    /**
+     * Add a `ilike` condition
+     * @param key - Property name
+     * @param val - Regexp condition
+     */
+    ilike(key, val) {
+        const w = {};
+        w[key] = { ilike: val };
+        return this.add(w);
+    }
+    /**
+     * Add a `nilike` condition
+     * @param key - Property name
+     * @param val - Regexp condition
+     */
+    nilike(key, val) {
+        const w = {};
+        w[key] = { nilike: val };
+        return this.add(w);
+    }
+    /**
+     * Add a `regexp` condition
+     * @param key - Property name
+     * @param val - Regexp condition
+     */
+    regexp(key, val) {
+        const w = {};
+        w[key] = { regexp: val };
+        return this.add(w);
+    }
+    /**
+     * Get the where object
+     */
+    build() {
+        return this.where;
+    }
+}
+exports.WhereBuilder = WhereBuilder;
+/**
+ * A builder for Filter. It provides fleunt APIs to add clauses such as
+ * `fields`, `order`, `where`, `limit`, `offset`, and `include`.
+ *
+ * @example
+ * ```ts
+ * const filterBuilder = new FilterBuilder();
+ * const filter = filterBuilder
+ *   .fields('id', 'a', 'b')
+ *   .limit(10)
+ *   .offset(0)
+ *   .order(['a ASC', 'b DESC'])
+ *   .where({id: 1})
+ *   .build();
+ * ```
+ */
+class FilterBuilder {
+    filter;
+    constructor(f) {
+        this.filter = f ?? {};
+    }
+    /**
+     * Set `limit`
+     * @param limit - Maximum number of records to be returned
+     */
+    limit(limit) {
+        if (!(limit >= 1)) {
+            throw new Error(`Limit ${limit} must a positive number`);
+        }
+        this.filter.limit = limit;
+        return this;
+    }
+    /**
+     * Set `offset`
+     * @param offset - Offset of the number of records to be returned
+     */
+    offset(offset) {
+        this.filter.offset = offset;
+        return this;
+    }
+    /**
+     * Alias to `offset`
+     * @param skip
+     */
+    skip(skip) {
+        return this.offset(skip);
+    }
+    /**
+     * Describe what fields to be included/excluded
+     * @param f - A field name to be included, an array of field names to be
+     * included, or an Fields object for the inclusion/exclusion
+     */
+    fields(...f) {
+        if (!this.filter.fields) {
+            this.filter.fields = {};
+        }
+        else if (Array.isArray(this.filter.fields)) {
+            this.filter.fields = this.filter.fields.reduce((prev, current) => ({ ...prev, [current]: true }), {});
+        }
+        const { fields } = this.filter;
+        for (const field of f) {
+            if (Array.isArray(field)) {
+                field.forEach(i => (fields[i] = true));
+            }
+            else if (typeof field === 'string') {
+                fields[field] = true;
+            }
+            else {
+                Object.assign(fields, field);
+            }
+        }
+        return this;
+    }
+    validateOrder(order) {
+        if (!(order.match(/^[^\s]+( (ASC|DESC))?$/))) {
+            throw new Error(`Invalid order: ${order}`);
+        }
+    }
+    /**
+     * Describe the sorting order
+     * @param o - A field name with optional direction, an array of field names,
+     * or an Order object for the field/direction pairs
+     */
+    order(...o) {
+        if (!this.filter.order) {
+            this.filter.order = [];
+        }
+        o.forEach(order => {
+            if (typeof order === 'string') {
+                this.validateOrder(order);
+                if (!order.endsWith(' ASC') && !order.endsWith(' DESC')) {
+                    order += ' ASC';
+                }
+                this.filter.order.push(order);
+                return this;
+            }
+            if (Array.isArray(order)) {
+                order.forEach(this.validateOrder);
+                order = order.map(i => {
+                    if (!i.endsWith(' ASC') && !i.endsWith(' DESC')) {
+                        i += ' ASC';
+                    }
+                    return i;
+                });
+                this.filter.order = this.filter.order.concat(order);
+                return this;
+            }
+            // tslint:disable-next-line: forin
+            for (const i in order) {
+                this.filter.order.push(`${i} ${order[i]}`);
+            }
+        });
+        return this;
+    }
+    /**
+     * Declare `include`
+     * @param i - A relation name, an array of relation names, or an `Inclusion`
+     * object for the relation/scope definitions
+     */
+    include(...i) {
+        if (this.filter.include == null) {
+            this.filter.include = [];
+        }
+        for (const include of i) {
+            if (typeof include === 'string') {
+                this.filter.include.push({ relation: include });
+            }
+            else if (Array.isArray(include)) {
+                for (const inc of include)
+                    this.filter.include.push({ relation: inc });
+            }
+            else {
+                this.filter.include.push(include);
+            }
+        }
+        return this;
+    }
+    /**
+     * Declare a where clause
+     * @param w - Where object
+     */
+    where(w) {
+        this.filter.where = w;
+        return this;
+    }
+    /**
+     * Add a Filter or Where constraint object. If it is a filter object, create
+     * an `and` clause for conflicting keys with its where object. For any other
+     * properties, throw an error. If it's not a Filter, coerce it to a filter,
+     * and carry out the same logic.
+     *
+     * @param constraint - a constraint object to merge with own filter object
+     */
+    impose(constraint) {
+        if (!this.filter) {
+            // if constraint is a Where, turn into a Filter
+            if (!isFilter(constraint)) {
+                constraint = { where: constraint };
+            }
+            this.filter = constraint || {};
+        }
+        else {
+            if (isFilter(constraint)) {
+                // throw error if imposed Filter has non-where fields
+                for (const key of Object.keys(constraint)) {
+                    if (nonWhereFields.includes(key)) {
+                        throw new Error('merging strategy for selection, pagination, and sorting not implemented');
+                    }
+                }
+            }
+            this.filter.where = isFilter(constraint)
+                ? new WhereBuilder(this.filter.where).impose(constraint.where).build()
+                : new WhereBuilder(this.filter.where).impose(constraint).build();
+        }
+        return this;
+    }
+    /**
+     * Return the filter object
+     */
+    build() {
+        return this.filter;
+    }
+}
+exports.FilterBuilder = FilterBuilder;
+/**
+ * Get nested properties by path
+ * @param value - Value of an object
+ * @param path - Path to the property
+ */
+function getDeepProperty(value, path) {
+    const props = path.split('.');
+    for (const p of props) {
+        value = value[p];
+        if (value == null) {
+            return null;
+        }
+    }
+    return value;
+}
+function filterTemplate(strings, ...keys) {
+    return function filter(ctx) {
+        const tokens = [strings[0]];
+        keys.forEach((key, i) => {
+            if (typeof key === 'object' ||
+                typeof key === 'boolean' ||
+                typeof key === 'number') {
+                tokens.push(JSON.stringify(key), strings[i + 1]);
+                return;
+            }
+            const value = getDeepProperty(ctx, key);
+            tokens.push(JSON.stringify(value), strings[i + 1]);
+        });
+        const result = tokens.join('');
+        try {
+            return JSON.parse(result);
+        }
+        catch (e) {
+            throw new Error(`Invalid JSON: ${result}`);
+        }
+    };
+}
+//# sourceMappingURL=query.js.map

package/dist/core/Loopback/query.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query.js","sourceRoot":"","sources":["../../../src/core/Loopback/query.ts"],"names":[],"mappings":";;;AAiPA,4BAUC;AAwdD,wCAsBC;AAluBD,uDAAuD;AAEvD,MAAM,cAAc,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAA;AAEhF,MAAM,YAAY,GAAG,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC,CAAA;AAkOjD;;;GAGG;AACH,SAAgB,QAAQ,CACtB,SAAc;IAEd,IAAI,OAAO,SAAS,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IAC/C,KAAK,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;QAC5B,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAChC,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAa,YAAY;IACvB,KAAK,CAAW;IAEhB,YAAY,CAAa;QACvB,IAAI,CAAC,KAAK,GAAG,CAAC,IAAI,EAAE,CAAA;IACtB,CAAC;IAEO,GAAG,CAAC,CAAY;QACtB,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;YAC/B,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACpB,wEAAwE;gBACxE,8BAA8B;gBAC9B,MAAM,KAAK,GAAG,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,CAAA;gBACtC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;gBAClB,OAAO,IAAI,CAAA;YACb,CAAC;QACH,CAAC;QACD,wBAAwB;QACxB,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;QACzC,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,MAAoD;QACvD,OAAO,MAAM,CAAA;IACf,CAAC;IAED;;;OAGG;IACH,GAAG,CAAC,GAAG,CAA8B;QACnC,IAAI,OAAO,GAAgB,EAAE,CAAA;QAC7B,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YAChB,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAA;QAClE,CAAC,CAAC,CAAA;QACF,OAAO,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAA;IACnC,CAAC;IAED;;;OAGG;IACH,EAAE,CAAC,GAAG,CAA8B;QAClC,IAAI,OAAO,GAAgB,EAAE,CAAA;QAC7B,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YAChB,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAA;QAClE,CAAC,CAAC,CAAA;QACF,OAAO,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,CAAA;IAClC,CAAC;IAED;;;;OAIG;IACH,EAAE,CAAsB,GAAM,EAAE,GAAU;QACxC,MAAM,CAAC,GAAc,EAAE,CAAA;QACvB,CAAC,CAAC,GAAG,CAAC,GAAG,GAAU,CAAA;QACnB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IACpB,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAsB,GAAM,EAAE,GAAU;QACzC,MAAM,CAAC,GAAc,EAAE,CAAA;QACvB,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAA;QACrB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IACpB,CAAC;IAED;;;;OAIG;IACH,EAAE,CAAsB,GAAM,EAAE,GAAU;QACxC,MAAM,CAAC,GAAc,EAAE,CAAA;QACvB,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,EAAE,GAAG,EAAE,CAAA;QACpB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IACpB,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAsB,GAAM,EAAE,GAAU;QACzC,MAAM,CAAC,GAAc,EAAE,CAAA;QACvB,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAA;QACrB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IACpB,CAAC;IAED;;;;OAIG;IACH,EAAE,CAAsB,GAAM,EAAE,GAAU;QACxC,MAAM,CAAC,GAAc,EAAE,CAAA;QACvB,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,EAAE,GAAG,EAAE,CAAA;QACpB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IACpB,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAsB,GAAM,EAAE,GAAU;QACzC,MAAM,CAAC,GAAc,EAAE,CAAA;QACvB,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAA;QACrB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IACpB,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAsB,GAAM,EAAE,GAAY;QAC3C,MAAM,CAAC,GAAc,EAAE,CAAA;QACvB,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAA;QACrB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IACpB,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAsB,GAAM,EAAE,GAAY;QAC3C,MAAM,CAAC,GAAc,EAAE,CAAA;QACvB,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAA;QACrB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IACpB,CAAC;IAED;;;;;OAKG;IACH,OAAO,CAAsB,GAAM,EAAE,IAAW,EAAE,IAAW;QAC3D,MAAM,CAAC,GAAc,EAAE,CAAA;QACvB,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAA;QAClC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IACpB,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAsB,GAAM,EAAE,GAAa;QAC/C,MAAM,CAAC,GAAc,EAAE,CAAA;QACvB,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC,GAAG,IAAI,GAAG,IAAI,IAAI,EAAE,CAAA;QACzC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IACpB,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAgB;QACrB,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YAChB,IAAI,CAAC,KAAK,GAAG,KAAK,IAAI,EAAE,CAAA;QAC1B,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;QACjB,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;OAIG;IACH,IAAI,CAAsB,GAAM,EAAE,GAAU;QAC1C,MAAM,CAAC,GAAc,EAAE,CAAA;QACvB,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,CAAA;QACtB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IACpB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAsB,GAAM,EAAE,GAAU;QAC3C,MAAM,CAAC,GAAc,EAAE,CAAA;QACvB,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,CAAA;QACvB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IACpB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAsB,GAAM,EAAE,GAAU;QAC3C,MAAM,CAAC,GAAc,EAAE,CAAA;QACvB,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,CAAA;QACvB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IACpB,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAsB,GAAM,EAAE,GAAU;QAC5C,MAAM,CAAC,GAAc,EAAE,CAAA;QACvB,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,CAAA;QACxB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IACpB,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAsB,GAAM,EAAE,GAAoB;QACtD,MAAM,CAAC,GAAc,EAAE,CAAA;QACvB,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,CAAA;QACxB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IACpB,CAAC;IAED;;OAEG;IACH,KAAK;QACH,OAAO,IAAI,CAAC,KAAK,CAAA;IACnB,CAAC;CACF;AApPD,oCAoPC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAa,aAAa;IACxB,MAAM,CAAY;IAElB,YAAY,CAAc;QACxB,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAA;IACvB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,KAAa;QACjB,IAAG,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,SAAS,KAAK,yBAAyB,CAAC,CAAA;QAC1D,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,KAAK,CAAA;QACzB,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,MAAc;QACnB,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,MAAM,CAAA;QAC3B,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;OAGG;IACH,IAAI,CAAC,IAAY;QACf,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IAC1B,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,GAAG,CAA6C;QACrD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACxB,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,EAAE,CAAA;QACzB,CAAC;aAAM,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;YAC7C,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAC5C,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,CAAC,EACjD,EAAE,CACH,CAAA;QACH,CAAC;QACD,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,CAAA;QAC9B,KAAK,MAAM,KAAK,IAAI,CAAC,EAAE,CAAC;YACtB,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAA;YACxC,CAAC;iBAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBACrC,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAA;YACtB,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;YAC9B,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAEO,aAAa,CAAC,KAAa;QACjC,IAAG,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC,EAAE,CAAC;YAC5C,MAAM,IAAI,KAAK,CAAC,kBAAkB,KAAK,EAAE,CAAC,CAAA;QAC5C,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,GAAG,CAAoC;QAC3C,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;YACvB,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,EAAE,CAAA;QACxB,CAAC;QACD,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YAChB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC9B,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;gBACzB,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;oBACxD,KAAK,IAAI,MAAM,CAAA;gBACjB,CAAC;gBACD,IAAI,CAAC,MAAM,CAAC,KAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;gBAC9B,OAAO,IAAI,CAAA;YACb,CAAC;YACD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;gBACjC,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;oBACpB,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;wBAChD,CAAC,IAAI,MAAM,CAAA;oBACb,CAAC;oBACD,OAAO,CAAC,CAAA;gBACV,CAAC,CAAC,CAAA;gBACF,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,KAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;gBACpD,OAAO,IAAI,CAAA;YACb,CAAC;YACD,kCAAkC;YAClC,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;gBACtB,IAAI,CAAC,MAAM,CAAC,KAAM,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;YAC7C,CAAC;QACH,CAAC,CAAC,CAAA;QACF,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,GAAG,CAAoC;QAC7C,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,IAAI,IAAI,EAAE,CAAC;YAChC,IAAI,CAAC,MAAM,CAAC,OAAO,GAAG,EAAE,CAAA;QAC1B,CAAC;QACD,KAAK,MAAM,OAAO,IAAI,CAAC,EAAE,CAAC;YACxB,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;gBAChC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAA;YACjD,CAAC;iBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;gBAClC,KAAK,MAAM,GAAG,IAAI,OAAO;oBAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,CAAA;YACxE,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,MAAM,CAAC,OAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YACpC,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,CAAY;QAChB,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,CAAC,CAAA;QACrB,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,UAAkC;QACvC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,+CAA+C;YAC/C,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC1B,UAAU,GAAG,EAAE,KAAK,EAAE,UAAU,EAAE,CAAA;YACpC,CAAC;YACD,IAAI,CAAC,MAAM,GAAI,UAAyB,IAAI,EAAE,CAAA;QAChD,CAAC;aAAM,CAAC;YACN,IAAI,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;gBACzB,qDAAqD;gBACrD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;oBAC1C,IAAI,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;wBACjC,MAAM,IAAI,KAAK,CACb,yEAAyE,CAC1E,CAAA;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;YACD,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,QAAQ,CAAC,UAAU,CAAC;gBACtC,CAAC,CAAC,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,KAAM,CAAC,CAAC,KAAK,EAAE;gBACvE,CAAC,CAAC,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,KAAK,EAAE,CAAA;QACpE,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;OAEG;IACH,KAAK;QACH,OAAO,IAAI,CAAC,MAAM,CAAA;IACpB,CAAC;CACF;AA/KD,sCA+KC;AAED;;;;GAIG;AACH,SAAS,eAAe,CAAC,KAAgB,EAAE,IAAY;IACrD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAC7B,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;QACtB,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAA;QAChB,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;YAClB,OAAO,IAAI,CAAA;QACb,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAED,SAAgB,cAAc,CAAC,OAA6B,EAAE,GAAG,IAAW;IAC1E,OAAO,SAAS,MAAM,CAAC,GAAc;QACnC,MAAM,MAAM,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAA;QAC3B,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE;YACtB,IACE,OAAO,GAAG,KAAK,QAAQ;gBACvB,OAAO,GAAG,KAAK,SAAS;gBACxB,OAAO,GAAG,KAAK,QAAQ,EACvB,CAAC;gBACD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;gBAChD,OAAM;YACR,CAAC;YACD,MAAM,KAAK,GAAG,eAAe,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;YACvC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;QACpD,CAAC,CAAC,CAAA;QACF,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAC9B,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;QAC3B,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,iBAAiB,MAAM,EAAE,CAAC,CAAA;QAC5C,CAAC;IACH,CAAC,CAAA;AACH,CAAC"}

package/dist/core/Loopback/relation.types.d.ts

@@ -0,0 +1,141 @@
+import { InclusionFilter } from './query';
+import { Options } from './common-types';
+import { Entity } from './model';
+import { TypeResolver } from './type-resolver';
+export declare enum RelationType {
+    belongsTo = "belongsTo",
+    hasOne = "hasOne",
+    hasMany = "hasMany",
+    embedsOne = "embedsOne",
+    embedsMany = "embedsMany",
+    referencesOne = "referencesOne",
+    referencesMany = "referencesMany"
+}
+export interface RelationDefinitionBase {
+    /**
+     * The type of the relation, must be one of RelationType values.
+     */
+    type: RelationType;
+    /**
+     * True for relations targeting multiple instances (e.g. HasMany),
+     * false for relations with a single target (e.g. BelongsTo, HasOne).
+     * This property is needed by OpenAPI/JSON Schema generator.
+     */
+    targetsMany: boolean;
+    /**
+     * The relation name, typically matching the name of the accessor property
+     * defined on the source model. For example "orders" or "customer".
+     */
+    name: string;
+    /**
+     * The source model of this relation.
+     *
+     * E.g. when a Customer has many Order instances, then Customer is the source.
+     */
+    source: typeof Entity;
+    /**
+     * The target model of this relation.
+     *
+     * E.g. when a Customer has many Order instances, then Order is the target.
+     */
+    target: TypeResolver<Entity, typeof Entity>;
+}
+/**
+ * HasManyDefinition defines one-to-many relations and also possible defines
+ * many-to-many relations with through models.
+ */
+export interface HasManyDefinition extends RelationDefinitionBase {
+    type: RelationType.hasMany;
+    targetsMany: true;
+    /**
+     * keyTo: The foreign key used by the target model for this relation.
+     * keyFrom: The source key used by the source model for this relation.
+     *
+     * E.g. when a Customer has many Order instances, then keyTo is "customerId".
+     * Note that "customerId" is the default FK assumed by the framework, users
+     * can provide a custom FK name by setting "keyTo".
+     * And Customer.id is keyFrom. keyFrom defaults to the id property of a model.
+     * Users can provide a custom source key name by setting "keyTo".
+     *
+     */
+    keyTo?: string;
+    keyFrom?: string;
+    /**
+     * Description of the through model of the hasManyThrough relation.
+     *
+     * A `hasManyThrough` relation defines a many-to-many connection with another model.
+     * This relation indicates that the declaring model can be matched with zero or more
+     * instances of another model by proceeding through a third model.
+     *
+     * E.g a Category has many Products, and a Product can have many Categories.
+     * CategoryProductLink can be the through model.
+     * Such a through model has information of foreign keys of the source model(Category) and the target model(Product).
+     *
+     * Warning: The hasManyThrough interface is experimental and is subject to change.
+     * If backwards-incompatible changes are made, a new major version may not be
+     * released.
+     */
+    through?: {
+        /**
+         * The through model of this relation.
+         *
+         * E.g. when a Category has many CategoryProductLink instances and a Product has many CategoryProductLink instances,
+         * then CategoryProductLink is through.
+         */
+        model: TypeResolver<Entity, typeof Entity>;
+        /**
+         * The foreign key of the source model defined in the through model, e.g. CategoryProductLink#categoryId
+         */
+        keyFrom?: string;
+        /**
+         * The foreign key of the target model defined in the through model, e.g. CategoryProductLink#productId
+         */
+        keyTo?: string;
+    };
+}
+export interface BelongsToDefinition extends RelationDefinitionBase {
+    type: RelationType.belongsTo;
+    targetsMany: false;
+    keyFrom?: string;
+    keyTo?: string;
+}
+export interface HasOneDefinition extends RelationDefinitionBase {
+    type: RelationType.hasOne;
+    targetsMany: false;
+    /**
+     * keyTo: The foreign key used by the target model for this relation.
+     * keyFrom: The source key used by the source model for this relation.
+     *
+     * E.g. when a Customer has one Address instance, then keyTo is "customerId".
+     * Note that "customerId" is the default FK assumed by the framework, users
+     * can provide a custom FK name by setting "keyTo".
+     * And Customer.id is keyFrom. keyFrom defaults to the id property of a model.
+     * Users can provide a custom source key name by setting "keyTo".
+     */
+    keyTo?: string;
+    keyFrom?: string;
+}
+/**
+ * A union type describing all possible Relation metadata objects.
+ */
+export type RelationMetadata = HasManyDefinition | BelongsToDefinition | HasOneDefinition | RelationDefinitionBase;
+/**
+ * @returns An array of resolved values, the items must be ordered in the same
+ * way as `sourceEntities`. The resolved value can be one of:
+ * - `undefined` when no target model(s) were found
+ * - `Entity` for relations targeting a single model
+ * - `Entity[]` for relations targeting multiple models
+ */
+export type InclusionResolver<S extends Entity, T extends Entity> = (
+/**
+ * List of source models as returned by the first database query.
+ */
+sourceEntities: S[], 
+/**
+ * Inclusion requested by the user (e.g. scope constraints to apply).
+ */
+inclusion: InclusionFilter, 
+/**
+ * Generic options object, e.g. carrying the Transaction object.
+ */
+options?: Options) => Promise<(T | undefined)[] | (T[] | undefined)[]>;

package/dist/core/Loopback/relation.types.js

@@ -0,0 +1,18 @@
+"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.RelationType = void 0;
+var RelationType;
+(function (RelationType) {
+    RelationType["belongsTo"] = "belongsTo";
+    RelationType["hasOne"] = "hasOne";
+    RelationType["hasMany"] = "hasMany";
+    RelationType["embedsOne"] = "embedsOne";
+    RelationType["embedsMany"] = "embedsMany";
+    RelationType["referencesOne"] = "referencesOne";
+    RelationType["referencesMany"] = "referencesMany";
+})(RelationType || (exports.RelationType = RelationType = {}));
+//# sourceMappingURL=relation.types.js.map

package/dist/core/Loopback/relation.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"relation.types.js","sourceRoot":"","sources":["../../../src/core/Loopback/relation.types.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;;AAOhE,IAAY,YAQX;AARD,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,iCAAiB,CAAA;IACjB,mCAAmB,CAAA;IACnB,uCAAuB,CAAA;IACvB,yCAAyB,CAAA;IACzB,+CAA+B,CAAA;IAC/B,iDAAiC,CAAA;AACnC,CAAC,EARW,YAAY,4BAAZ,YAAY,QAQvB"}