@goatlab/fluent 0.7.39 → 0.7.40

package/dist/TypeOrmConnector/util/extractMetadataFromKeys.d.ts

@@ -0,0 +1,12 @@
+export interface KeysMetadata {
+    keyName: string;
+    nestableKey: string;
+    relation?: string;
+    parentRelation?: string;
+    level?: number;
+    cardinality?: string;
+}
+export interface KeysMetadataResponse {
+    [key: string]: KeysMetadata;
+}
+export declare const extractMetadataFromKeys: (keys: string[]) => KeysMetadataResponse;

package/dist/TypeOrmConnector/util/extractMetadataFromKeys.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractMetadataFromKeys = void 0;
+const extractMetadataFromKeys = (keys) => {
+    // Example of a key
+    // Level 0:
+    //    users__id
+    // Level 2:
+    //    users___XXOneToManyXX___cars___XXManyToOneXX___user__id
+    const keyToNestedKeyMap = {};
+    for (const key of keys) {
+        // All keys have an _ before the actual attribute name
+        const preAttributeIndex = key.lastIndexOf('_');
+        const fullTableAlias = key.slice(0, preAttributeIndex).replace('_', '');
+        const keyName = key.slice(preAttributeIndex + 1, key.length);
+        const flattened = fullTableAlias
+            .replace(/___XXManyToOneXX/g, '')
+            .replace(/___XXOneToManyXX/g, '')
+            .replace(/___/g, '.')
+            .replace('__', '.')
+            .replace('.XXOneToManyXX', '');
+        const possibleCurrentTableKey = key.lastIndexOf('___');
+        const relation = possibleCurrentTableKey <= 0
+            ? undefined
+            : key.slice(possibleCurrentTableKey + 3, preAttributeIndex);
+        const possibleParentTableKeyInit = key.lastIndexOf('___XX');
+        const possibleParentTableKeyEnd = key.lastIndexOf('XX__');
+        const cardinality = key.slice(possibleParentTableKeyInit, possibleParentTableKeyEnd) ||
+            undefined;
+        const parentRelationKey = key
+            .substring(0, possibleParentTableKeyInit)
+            .lastIndexOf('___');
+        const parentRelation = key
+            .substring(parentRelationKey, possibleParentTableKeyInit)
+            .replace(/___/g, '') || undefined;
+        var level = (key.match(/XX___/g) || []).length;
+        keyToNestedKeyMap[key] = {
+            keyName,
+            nestableKey: `${flattened}.${keyName}`,
+            relation,
+            parentRelation,
+            level,
+            cardinality: cardinality && cardinality.replace(/XX/g, '').replace(/___/g, '')
+        };
+    }
+    return keyToNestedKeyMap;
+};
+exports.extractMetadataFromKeys = extractMetadataFromKeys;
+//# sourceMappingURL=extractMetadataFromKeys.js.map

package/dist/TypeOrmConnector/util/extractMetadataFromKeys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extractMetadataFromKeys.js","sourceRoot":"","sources":["../../../src/TypeOrmConnector/util/extractMetadataFromKeys.ts"],"names":[],"mappings":";;;AAcO,MAAM,uBAAuB,GAAG,CAAC,IAAc,EAAwB,EAAE;IAC9E,mBAAmB;IACnB,WAAW;IACX,eAAe;IACf,WAAW;IACX,6DAA6D;IAC7D,MAAM,iBAAiB,GAAG,EAAE,CAAA;IAE5B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,sDAAsD;QACtD,MAAM,iBAAiB,GAAG,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,CAAA;QAC9C,MAAM,cAAc,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,iBAAiB,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;QACvE,MAAM,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,iBAAiB,GAAG,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;QAE5D,MAAM,SAAS,GAAG,cAAc;aAC7B,OAAO,CAAC,mBAAmB,EAAE,EAAE,CAAC;aAChC,OAAO,CAAC,mBAAmB,EAAE,EAAE,CAAC;aAChC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC;aACpB,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC;aAClB,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAA;QAEhC,MAAM,uBAAuB,GAAG,GAAG,CAAC,WAAW,CAAC,KAAK,CAAC,CAAA;QAEtD,MAAM,QAAQ,GACZ,uBAAuB,IAAI,CAAC;YAC1B,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,uBAAuB,GAAG,CAAC,EAAE,iBAAiB,CAAC,CAAA;QAE/D,MAAM,0BAA0B,GAAG,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;QAC3D,MAAM,yBAAyB,GAAG,GAAG,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;QAEzD,MAAM,WAAW,GACf,GAAG,CAAC,KAAK,CAAC,0BAA0B,EAAE,yBAAyB,CAAC;YAChE,SAAS,CAAA;QAEX,MAAM,iBAAiB,GAAG,GAAG;aAC1B,SAAS,CAAC,CAAC,EAAE,0BAA0B,CAAC;aACxC,WAAW,CAAC,KAAK,CAAC,CAAA;QAErB,MAAM,cAAc,GAClB,GAAG;aACA,SAAS,CAAC,iBAAiB,EAAE,0BAA0B,CAAC;aACxD,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,SAAS,CAAA;QAErC,IAAI,KAAK,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAA;QAE9C,iBAAiB,CAAC,GAAG,CAAC,GAAG;YACvB,OAAO;YACP,WAAW,EAAE,GAAG,SAAS,IAAI,OAAO,EAAE;YACtC,QAAQ;YACR,cAAc;YACd,KAAK;YACL,WAAW,EACT,WAAW,IAAI,WAAW,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;SACpE,CAAA;IACH,CAAC;IAED,OAAO,iBAAiB,CAAA;AAC1B,CAAC,CAAA;AA1DY,QAAA,uBAAuB,2BA0DnC"}

package/dist/TypeOrmConnector/util/extractOrderBy.d.ts

@@ -0,0 +1,2 @@
+import { FluentQuery } from '../../types';
+export declare const extractOrderBy: <T>(orderBy?: FluentQuery<T>["orderBy"]) => import("@goatlab/js-utils").AnyObject;

package/dist/TypeOrmConnector/util/extractOrderBy.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractOrderBy = void 0;
+const js_utils_1 = require("@goatlab/js-utils");
+const extractOrderBy = (orderBy) => {
+    if (!orderBy) {
+        return {};
+    }
+    // Handle both array and object formats
+    const orderByArray = Array.isArray(orderBy) ? orderBy : [orderBy];
+    if (orderByArray.length === 0) {
+        return {};
+    }
+    const order = {};
+    for (const orderElement of orderByArray) {
+        const flattenOrder = js_utils_1.Objects.flatten(orderElement);
+        for (const k of Object.keys(flattenOrder)) {
+            order[k] = flattenOrder[k];
+        }
+    }
+    return js_utils_1.Objects.nest(order);
+};
+exports.extractOrderBy = extractOrderBy;
+//# sourceMappingURL=extractOrderBy.js.map

package/dist/TypeOrmConnector/util/extractOrderBy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extractOrderBy.js","sourceRoot":"","sources":["../../../src/TypeOrmConnector/util/extractOrderBy.ts"],"names":[],"mappings":";;;AAAA,gDAA2C;AAGpC,MAAM,cAAc,GAAG,CAAI,OAAmC,EAAE,EAAE;IACvE,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,EAAE,CAAA;IACX,CAAC;IAED,uCAAuC;IACvC,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAA;IAEjE,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC9B,OAAO,EAAE,CAAA;IACX,CAAC;IAED,MAAM,KAAK,GAAG,EAAE,CAAA;IAEhB,KAAK,MAAM,YAAY,IAAI,YAAY,EAAE,CAAC;QACxC,MAAM,YAAY,GAAG,kBAAO,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;QAElD,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;YAC1C,KAAK,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAA;QAC5B,CAAC;IACH,CAAC;IAED,OAAO,kBAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;AAC5B,CAAC,CAAA;AAvBY,QAAA,cAAc,kBAuB1B"}

package/dist/TypeOrmConnector/util/getRelationsFromModelGenerator.d.ts

@@ -0,0 +1,19 @@
+import { Repository } from 'typeorm';
+export interface GeneratedModelRelations {
+    relations: {
+        [key: string]: {
+            isOneToMany: boolean;
+            isManyToOne: boolean;
+            isManyToMany: boolean;
+            inverseSidePropertyRelationPath?: string;
+            inverseSidePropertyPath?: string;
+            propertyName: string;
+            entityName: string;
+            tableName: string;
+            targetClass: string;
+            joinColumns: any[];
+            inverseJoinColumns: any[];
+        };
+    };
+}
+export declare const getRelationsFromModelGenerator: (typeOrmRepo: Repository<any>) => GeneratedModelRelations;

package/dist/TypeOrmConnector/util/getRelationsFromModelGenerator.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRelationsFromModelGenerator = void 0;
+const getRelationsFromModelGenerator = (typeOrmRepo) => {
+    const relations = {};
+    for (const relation of typeOrmRepo.metadata.relations) {
+        const pPath = relation.inverseRelation?.joinColumns[0];
+        relations[relation.propertyName] = {
+            isOneToMany: relation.isOneToMany,
+            isManyToOne: relation.isManyToOne,
+            isManyToMany: relation.isManyToMany,
+            inverseSidePropertyRelationPath: relation.inverseSidePropertyPath,
+            inverseSidePropertyPath: pPath?.propertyPath,
+            propertyName: relation.propertyName,
+            entityName: relation.inverseEntityMetadata.name,
+            tableName: relation.inverseEntityMetadata.tableName,
+            targetClass: relation.inverseEntityMetadata.target,
+            joinColumns: relation.joinColumns,
+            inverseJoinColumns: relation.inverseJoinColumns
+        };
+    }
+    return {
+        relations
+    };
+};
+exports.getRelationsFromModelGenerator = getRelationsFromModelGenerator;
+//# sourceMappingURL=getRelationsFromModelGenerator.js.map

package/dist/TypeOrmConnector/util/getRelationsFromModelGenerator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getRelationsFromModelGenerator.js","sourceRoot":"","sources":["../../../src/TypeOrmConnector/util/getRelationsFromModelGenerator.ts"],"names":[],"mappings":";;;AAoBO,MAAM,8BAA8B,GAAG,CAC5C,WAA4B,EACH,EAAE;IAC3B,MAAM,SAAS,GAAG,EAAE,CAAA;IACpB,KAAK,MAAM,QAAQ,IAAI,WAAW,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC;QACtD,MAAM,KAAK,GAAG,QAAQ,CAAC,eAAe,EAAE,WAAW,CAAC,CAAC,CAAC,CAAA;QACtD,SAAS,CAAC,QAAQ,CAAC,YAAY,CAAC,GAAG;YACjC,WAAW,EAAE,QAAQ,CAAC,WAAW;YACjC,WAAW,EAAE,QAAQ,CAAC,WAAW;YACjC,YAAY,EAAE,QAAQ,CAAC,YAAY;YACnC,+BAA+B,EAAE,QAAQ,CAAC,uBAAuB;YACjE,uBAAuB,EAAE,KAAK,EAAE,YAAY;YAC5C,YAAY,EAAE,QAAQ,CAAC,YAAY;YACnC,UAAU,EAAE,QAAQ,CAAC,qBAAqB,CAAC,IAAI;YAC/C,SAAS,EAAE,QAAQ,CAAC,qBAAqB,CAAC,SAAS;YACnD,WAAW,EAAE,QAAQ,CAAC,qBAAqB,CAAC,MAAM;YAClD,WAAW,EAAE,QAAQ,CAAC,WAAW;YACjC,kBAAkB,EAAE,QAAQ,CAAC,kBAAkB;SAChD,CAAA;IACH,CAAC;IACD,OAAO;QACL,SAAS;KACV,CAAA;AACH,CAAC,CAAA;AAvBY,QAAA,8BAA8B,kCAuB1C"}

package/dist/TypeOrmConnector/util/getSelectedKeysFromRawSql.d.ts

@@ -0,0 +1,6 @@
+/**
+ *
+ * @param sql
+ * @returns
+ */
+export declare const getSelectedKeysFromRawSql: (sql: string) => string[];

package/dist/TypeOrmConnector/util/getSelectedKeysFromRawSql.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSelectedKeysFromRawSql = void 0;
+/**
+ *
+ * @param sql
+ * @returns
+ */
+const getSelectedKeysFromRawSql = (sql) => {
+    const possibleKeys = sql.split('AS');
+    const keys = new Set([]);
+    for (const stringKey of possibleKeys) {
+        if (stringKey.includes('SELECT')) {
+            const key = stringKey.split('"')[1];
+            if (!key || key.includes('___') || !key.includes('_')) {
+                continue;
+            }
+            keys.add(key.replace('_id', 'id').replace('_', '.'));
+            continue;
+        }
+        const key = stringKey.split('"')[1];
+        if (key) {
+            keys.add(key.replace('_id', 'id').replace('_', '.'));
+        }
+    }
+    return Array.from(keys);
+};
+exports.getSelectedKeysFromRawSql = getSelectedKeysFromRawSql;
+//# sourceMappingURL=getSelectedKeysFromRawSql.js.map

package/dist/TypeOrmConnector/util/getSelectedKeysFromRawSql.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getSelectedKeysFromRawSql.js","sourceRoot":"","sources":["../../../src/TypeOrmConnector/util/getSelectedKeysFromRawSql.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACI,MAAM,yBAAyB,GAAG,CAAC,GAAW,EAAY,EAAE;IACjE,MAAM,YAAY,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IACpC,MAAM,IAAI,GAAgB,IAAI,GAAG,CAAC,EAAE,CAAC,CAAA;IAErC,KAAK,MAAM,SAAS,IAAI,YAAY,EAAE,CAAC;QACrC,IAAI,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YACjC,MAAM,GAAG,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;YACnC,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBACtD,SAAQ;YACV,CAAC;YAED,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAA;YAEpD,SAAQ;QACV,CAAC;QAED,MAAM,GAAG,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;QACnC,IAAI,GAAG,EAAE,CAAC;YACR,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAA;QACtD,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;AACzB,CAAC,CAAA;AAvBY,QAAA,yBAAyB,6BAuBrC"}

package/dist/TypeOrmConnector/util/isAnyObject.d.ts

@@ -0,0 +1 @@
+export declare const isAnyObject: (val: any) => boolean;

package/dist/TypeOrmConnector/util/isAnyObject.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isAnyObject = void 0;
+const isAnyObject = (val) => {
+    return typeof val === 'object' && !Array.isArray(val) && val !== null;
+};
+exports.isAnyObject = isAnyObject;
+//# sourceMappingURL=isAnyObject.js.map

package/dist/TypeOrmConnector/util/isAnyObject.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isAnyObject.js","sourceRoot":"","sources":["../../../src/TypeOrmConnector/util/isAnyObject.ts"],"names":[],"mappings":";;;AAAO,MAAM,WAAW,GAAG,CAAC,GAAQ,EAAW,EAAE;IAC/C,OAAO,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG,KAAK,IAAI,CAAA;AACvE,CAAC,CAAA;AAFY,QAAA,WAAW,eAEvB"}

package/dist/TypeOrmConnector/util/nestQueryResults.d.ts

@@ -0,0 +1,2 @@
+import { AnyObject } from '../../types';
+export declare const nestQueryResults: (results: AnyObject[], keyToNestedKeyMap: AnyObject) => AnyObject[];

package/dist/TypeOrmConnector/util/nestQueryResults.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.nestQueryResults = void 0;
+const js_utils_1 = require("@goatlab/js-utils");
+const nestQueryResults = (results, keyToNestedKeyMap) => {
+    let nestableObject = {};
+    let currentLevel = 0;
+    // For each of the keys that we need to map
+    for (const key of Object.keys(keyToNestedKeyMap)) {
+        if (!key.endsWith('_id')) {
+            continue;
+        }
+        const currentLevelMetadata = keyToNestedKeyMap[key];
+        currentLevel = currentLevelMetadata.level;
+        // We only group by Ids of the current level
+        const grouped = js_utils_1.Arrays.groupBy(results, r => r[key]);
+        const resultCount = Object.keys(grouped)?.length || 0;
+        // ForEach Id of the grouped results
+        for (const [index, k] of Object.keys(grouped).entries()) {
+            const prefixindex = currentLevelMetadata.nestableKey.lastIndexOf('.');
+            const prefix = currentLevelMetadata.nestableKey.substring(0, prefixindex);
+            const currentIndex = `${prefix}.${index}.${currentLevelMetadata.keyName}`;
+            const results = grouped[k];
+            console.log(currentLevelMetadata);
+            // Get current level values
+            if (currentLevelMetadata.level === currentLevel) {
+                // Get value of the id
+                nestableObject[`${currentIndex}`] = k;
+            }
+            for (const result of results) {
+            }
+        }
+        // currentLevel = currentLevelMetadata.level
+    }
+    return results;
+};
+exports.nestQueryResults = nestQueryResults;
+//# sourceMappingURL=nestQueryResults.js.map

package/dist/TypeOrmConnector/util/nestQueryResults.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nestQueryResults.js","sourceRoot":"","sources":["../../../src/TypeOrmConnector/util/nestQueryResults.ts"],"names":[],"mappings":";;;AAAA,gDAA0C;AAGnC,MAAM,gBAAgB,GAAG,CAC9B,OAAoB,EACpB,iBAA4B,EACf,EAAE;IACf,IAAI,cAAc,GAAG,EAAE,CAAA;IACvB,IAAI,YAAY,GAAG,CAAC,CAAA;IACpB,2CAA2C;IAC3C,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC;QACjD,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,SAAQ;QACV,CAAC;QAED,MAAM,oBAAoB,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAA;QACnD,YAAY,GAAG,oBAAoB,CAAC,KAAK,CAAA;QAEzC,4CAA4C;QAC5C,MAAM,OAAO,GAAc,iBAAM,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAA;QAE/D,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC,CAAA;QAErD,oCAAoC;QACpC,KAAK,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC;YACxD,MAAM,WAAW,GAAG,oBAAoB,CAAC,WAAW,CAAC,WAAW,CAAC,GAAG,CAAC,CAAA;YACrE,MAAM,MAAM,GAAG,oBAAoB,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,EAAE,WAAW,CAAC,CAAA;YACzE,MAAM,YAAY,GAAG,GAAG,MAAM,IAAI,KAAK,IAAI,oBAAoB,CAAC,OAAO,EAAE,CAAA;YACzE,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;YAE1B,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAA;YACjC,2BAA2B;YAC3B,IAAI,oBAAoB,CAAC,KAAK,KAAK,YAAY,EAAE,CAAC;gBAChD,sBAAsB;gBACtB,cAAc,CAAC,GAAG,YAAY,EAAE,CAAC,GAAG,CAAC,CAAA;YACvC,CAAC;YAED,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC/B,CAAC;QACH,CAAC;QAED,4CAA4C;IAC9C,CAAC;IACD,OAAO,OAAO,CAAA;AAChB,CAAC,CAAA;AAzCY,QAAA,gBAAgB,oBAyC5B"}

package/dist/core/Loopback/build-schema.d.ts

@@ -0,0 +1,148 @@
+import { MetadataAccessor } from '@loopback/metadata';
+import { SchemaObject as JsonSchema } from 'openapi3-ts/oas30';
+export interface SchemaObject extends JsonSchema {
+    definitions?: {
+        [key: string]: SchemaObject;
+    };
+    $ref?: string;
+}
+import { RelationMetadata } from './relation.types';
+import { PropertyDefinition, PropertyType } from './model';
+export declare const JSON_SCHEMA_KEY: MetadataAccessor<{
+    [key: string]: SchemaObject;
+}, ClassDecorator>;
+export interface JsonSchemaOptions<T extends object> {
+    /**
+     * The title to use in the generated schema.
+     *
+     * When using options like `exclude`, the auto-generated title can be
+     * difficult to read for humans. Use this option to change the title to
+     * a more meaningful value.
+     */
+    title?: string;
+    /**
+     * Set this flag if you want the schema to define navigational properties
+     * for model relations.
+     */
+    includeRelations?: boolean;
+    /**
+     * Set this flag to mark all model properties as optional. This is typically
+     * used to describe request body of PATCH endpoints. This option will be
+     * overridden by the "optional" option if it is set and non-empty.
+     *
+     * The flag also applies to nested model instances if its value is set to
+     * 'deep', such as:
+     *
+     * @example
+     * ```ts
+     * @model()
+     * class Address {
+     *  @property()
+     *  street: string;
+     *  @property()
+     *  city: string;
+     *  @property()
+     *  state: string;
+     *  @property()
+     *  zipCode: string;
+     * }
+     *
+     * @model()
+     * class Customer {
+     *   @property()
+     *   address: Address;
+     * }
+     *
+     * // The following schema allows properties of `customer` optional, but not
+     * // `customer.address`
+     * const schemaRef1 = getModelSchemaRef(Customer, {partial: true});
+     *
+     * // The following schema allows properties of `customer` and
+     * // `customer.address` optional
+     * const schemaRef2 = getModelSchemaRef(Customer, {partial: 'deep'});
+     * ```
+     */
+    partial?: boolean | 'deep';
+    /**
+     * List of model properties to exclude from the schema.
+     */
+    exclude?: (keyof T)[];
+    /**
+     * List of model properties to mark as optional. Overrides the "partial"
+     * option if it is not empty.
+     */
+    optional?: (keyof T)[];
+    /**
+     * @internal
+     */
+    visited?: {
+        [key: string]: SchemaObject;
+    };
+}
+/**
+ * @internal
+ */
+export declare function buildModelCacheKey<T extends object>(options?: JsonSchemaOptions<T>): string;
+/**
+ * Gets the JSON Schema of a TypeScript model/class by seeing if one exists
+ * in a cache. If not, one is generated and then cached.
+ * @param ctor - Constructor of class to get JSON Schema from
+ */
+export declare function getJsonSchema<T extends object>(ctor: Function & {
+    prototype: T;
+}, options?: JsonSchemaOptions<T>): SchemaObject;
+/**
+ * Describe the provided Model as a reference to a definition shared by multiple
+ * endpoints. The definition is included in the returned schema.
+ *
+ * @example
+ *
+ * ```ts
+ * const schema = {
+ *   $ref: '/definitions/Product',
+ *   definitions: {
+ *     Product: {
+ *       title: 'Product',
+ *       properties: {
+ *         // etc.
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @param modelCtor - The model constructor (e.g. `Product`)
+ * @param options - Additional options
+ */
+export declare function getJsonSchemaRef<T extends object>(modelCtor: Function & {
+    prototype: T;
+}, options?: JsonSchemaOptions<T>): SchemaObject;
+/**
+ * Gets the wrapper function of primitives string, number, and boolean
+ * @param type - Name of type
+ */
+export declare function stringTypeToWrapper(type: string | Function): Function;
+/**
+ * Determines whether a given string or constructor is array type or not
+ * @param type - Type as string or wrapper
+ */
+export declare function isArrayType(type: string | Function | PropertyType): boolean;
+/**
+ * Converts property metadata into a JSON property definition
+ * @param meta
+ */
+export declare function metaToJsonProperty(meta: PropertyDefinition): SchemaObject;
+/**
+ * Checks and return navigational property definition for the relation
+ * @param relMeta Relation metadata object
+ * @param targetRef Schema definition for the target model
+ */
+export declare function getNavigationalPropertyForRelation(relMeta: RelationMetadata, targetRef: SchemaObject): SchemaObject;
+/**
+ * Converts a TypeScript class into a JSON Schema using TypeScript's
+ * reflection API
+ * @param ctor - Constructor of class to convert from
+ */
+export declare function modelToJsonSchema<T extends object>(ctor: Function & {
+    prototype: T;
+}, jsonSchemaOptions?: JsonSchemaOptions<T>): SchemaObject;