@dcupl/common 0.0.72-beta.3 → 0.0.73

package/dist/lib-cjs/types/filter.types.d.ts

@@ -50,6 +50,8 @@ export declare type FilterEntryDateRange = {
     max: Date;
 };
 export declare type FilterItemType = 'reference' | 'number' | 'text' | 'date';
+export declare type FilterItemPropertyType = 'number' | 'text' | 'date';
+export declare type FilterItemReferenceType = 'reference';
 export declare type FilterItemBase = {
     key: string;
     attributeKey: string;

package/dist/lib-cjs/types/internal.types.d.ts

@@ -1,2 +1,5 @@
+import { ListItem } from './data.types';
 export declare type InverseIndexReferenceMap = Map<string, InverseIndexValuesMap>;
 export declare type InverseIndexValuesMap = Map<string, string[]>;
+export declare type InverseIndexDataMap = Map<string, InverseIndexDataValuesMap>;
+export declare type InverseIndexDataValuesMap = Map<string, ListItem>;

package/dist/lib-cjs/types/list.types.d.ts

@@ -22,6 +22,7 @@ export declare type DcuplSectionOptions<T> = DcuplItemsOptions<T> & {
 export declare type DcuplFilterOptions = CatalogApiOptions & {
     calculateFacets?: boolean;
     excludeZeros?: boolean;
+    excludeUndefineds?: boolean;
     count?: number;
 };
 export declare type DcuplFiltersOptions = DcuplFilterOptions & {
@@ -33,6 +34,18 @@ export declare type DcuplListOptions<ModelNames extends string = string> = {
     listItemKeys?: string[];
     empty?: boolean;
 };
+export declare type DcuplRangeOptions = {
+    propertyKey: string;
+    filterKey?: string;
+};
+export declare type DcuplFacetOptions = {
+    attributeKey: string;
+    filterKey?: string;
+    count?: number;
+    excludeZeros?: boolean;
+    excludeUndefineds?: boolean;
+    calculateFacets?: boolean;
+};
 export declare type ListMetadata = {
     key: string;
     currentSize: number;

package/dist/lib-cjs/types/model.types.d.ts

@@ -1,5 +1,7 @@
 import { RawItem } from '.';
 export declare type PropertyType = 'string' | 'int' | 'float' | 'json' | 'date' | 'any' | 'Array<string>' | 'Array<int>' | 'Array<float>' | 'Array<date>';
+export declare const NumberPropertyTypes: PropertyType[];
+export declare const DatePropertyTypes: PropertyType[];
 /**
  *  must be singleValued or  multiValued
  * singleValued contains only one key to an object
@@ -14,6 +16,11 @@ export declare type PropertyType = 'string' | 'int' | 'float' | 'json' | 'date'
  */
 export declare type ReferenceType = 'singleValued' | 'multiValued';
 export declare type AttributeType = PropertyType | ReferenceType;
+export declare type ModelMetadata = {
+    name: string;
+    description?: string;
+    [key: string]: any;
+};
 export declare type FilterComparisonType = 'equal' | 'equalIgnoreCase' | 'contains' | 'containsIgnoreCase' | 'containsIgnoreCaseAndWhitespace';
 /**
  * A property is a quality or characteristic belonging an object.
@@ -36,6 +43,8 @@ declare type PropertyBase = {
         remoteProperty: string;
         separator?: string;
     };
+    meta?: ModelMetadata;
+    index?: boolean;
 };
 export declare type PropertyInt = PropertyBase & {
     type: 'int' | 'Array<int>';
@@ -97,6 +106,7 @@ export declare type FilterStringSingle = {
 export declare type ReferenceFilterDefinition = {
     calculateFacets?: boolean;
     excludeZeros?: boolean;
+    excludeUndefineds?: boolean;
 };
 export declare type ReferenceValidity = 'loose' | 'strict';
 /**
@@ -126,6 +136,8 @@ export declare type ReferenceBase = {
     filter?: boolean | ReferenceFilterDefinition;
     validity?: ReferenceValidity;
     aggregate?: boolean;
+    meta?: ModelMetadata;
+    index?: boolean;
 };
 export declare type AggregatedReference = ReferenceBase & {
     aggregate: true;
@@ -224,6 +236,7 @@ export declare type ModelDefinition<ModelNames extends string = string> = {
     autoGenerateKey?: boolean;
     keyProperty?: string;
     valueMappings?: ValueMappingConfig[];
+    meta?: ModelMetadata;
 };
 export declare type DcuplViewType = 'section';
 /**
@@ -251,6 +264,7 @@ export declare type ViewDefinition = {
      */
     primaryAttribute: string;
     aggregates: string[];
+    meta?: ModelMetadata;
 };
 /**
  * Container for ModelDescriptions & Views

package/dist/lib-cjs/types/model.types.js

@@ -1,3 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.DatePropertyTypes = exports.NumberPropertyTypes = void 0;
+exports.NumberPropertyTypes = ['int', 'float', 'Array<int>', 'Array<float>'];
+exports.DatePropertyTypes = ['date', 'Array<date>'];
 //# sourceMappingURL=model.types.js.map

package/dist/lib-cjs/types/model.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"model.types.js","sourceRoot":"","sources":["../../../src/types/model.types.ts"],"names":[],"mappings":""}
+{"version":3,"file":"model.types.js","sourceRoot":"","sources":["../../../src/types/model.types.ts"],"names":[],"mappings":";;;AAca,QAAA,mBAAmB,GAAmB,CAAC,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,cAAc,CAAC,CAAC;AACrF,QAAA,iBAAiB,GAAmB,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC"}

package/dist/lib-esm/getFacetEntries.d.ts

@@ -1,2 +1,2 @@
-import { ListItem, Reference, FilterConstraint, FilterItemEntry, DcuplFilterOptions, InverseIndexValuesMap } from './types';
-export declare function getFacetEntries<ListType extends ListItem = ListItem>(modelData: Map<string, ListType>, remoteModelData: Map<string, ListType>, options: DcuplFilterOptions, constraints: FilterConstraint[], reference: Reference, indexMap?: InverseIndexValuesMap): FilterItemEntry[];
+import { ListItem, FilterConstraint, FilterItemEntry, DcuplFilterOptions, InverseIndexValuesMap } from './types';
+export declare function getFacetEntries<ListType extends ListItem = ListItem>(modelData: Map<string, ListType>, remoteModelData: Map<string, ListType>, options: DcuplFilterOptions, constraints: FilterConstraint[], attributeKey: string, indexMap: InverseIndexValuesMap): FilterItemEntry[];

package/dist/lib-esm/getFacetEntries.js

@@ -1,3 +1,28 @@
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
 var __values = (this && this.__values) || function(o) {
     var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
     if (m) return m.call(o);
@@ -11,50 +36,57 @@ var __values = (this && this.__values) || function(o) {
 };
 import { getFilteredData } from './getFilteredData';
 import { getFilterEntryId } from './helper';
-export function getFacetEntries(modelData, remoteModelData, options, constraints, reference, indexMap) {
-    var e_1, _a;
+export function getFacetEntries(modelData, remoteModelData, options, constraints, attributeKey, indexMap) {
+    var e_1, _a, e_2, _b;
     var filterItemEntries = [];
-    var constraintsExceptSameFilterKey = constraints.filter(function (c) { return c.filterKey !== reference.key; });
+    var constraintsExceptSameFilterKey = constraints.filter(function (c) { return c.filterKey !== attributeKey; });
     var currentFilteredData = getFilteredData(modelData, constraintsExceptSameFilterKey, false);
-    var _loop_1 = function (dataEntry) {
+    var validFacetKeys = new Set(__spreadArray([], __read(remoteModelData.keys()), false));
+    if (options.excludeUndefineds === false) {
+        try {
+            for (var _c = __values(indexMap.keys()), _d = _c.next(); !_d.done; _d = _c.next()) {
+                var key = _d.value;
+                validFacetKeys.add(key);
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (_d && !_d.done && (_a = _c.return)) _a.call(_c);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+    }
+    var _loop_1 = function (validFacetKey) {
+        var e_3, _g;
         var result = new Map();
-        if (indexMap) {
-            var keys = indexMap.get(dataEntry.key);
-            if (keys) {
-                if (options === null || options === void 0 ? void 0 : options.calculateFacets) {
-                    keys.forEach(function (key) {
-                        if (currentFilteredData.has(key)) {
-                            result.set(key, currentFilteredData.get(key));
-                        }
-                    });
-                }
-                else {
-                    var key = keys.find(function (k) { return currentFilteredData.has(k); });
-                    if (key) {
-                        result.set(key, currentFilteredData.get(key));
+        var indexedValueKeys = indexMap.get(validFacetKey) || [];
+        try {
+            for (var indexedValueKeys_1 = (e_3 = void 0, __values(indexedValueKeys)), indexedValueKeys_1_1 = indexedValueKeys_1.next(); !indexedValueKeys_1_1.done; indexedValueKeys_1_1 = indexedValueKeys_1.next()) {
+                var key = indexedValueKeys_1_1.value;
+                var value = currentFilteredData.get(key);
+                if (value) {
+                    result.set(key, value);
+                    if (!(options === null || options === void 0 ? void 0 : options.calculateFacets)) {
+                        break;
                     }
                 }
             }
         }
-        else {
-            // Fallback if there is no indexMap
-            var constraintToAdd = {
-                uid: '',
-                filterKey: reference.key,
-                attributeKey: reference.key,
-                type: 'referenceConstraint',
-                value: dataEntry.key,
-                calculateFacets: !!(options === null || options === void 0 ? void 0 : options.calculateFacets),
-            };
-            result = getFilteredData(currentFilteredData, [constraintToAdd], !(options === null || options === void 0 ? void 0 : options.calculateFacets));
+        catch (e_3_1) { e_3 = { error: e_3_1 }; }
+        finally {
+            try {
+                if (indexedValueKeys_1_1 && !indexedValueKeys_1_1.done && (_g = indexedValueKeys_1.return)) _g.call(indexedValueKeys_1);
+            }
+            finally { if (e_3) throw e_3.error; }
         }
         var facetEntry = {
-            key: dataEntry.key,
-            value: dataEntry.key,
-            selected: !!constraints.find(function (constraint) { return constraint.uid === getFilterEntryId(reference.key, dataEntry.key); }),
+            key: validFacetKey,
+            value: validFacetKey,
+            selected: !!constraints.find(function (constraint) { return constraint.uid === getFilterEntryId(attributeKey, validFacetKey); }),
             enabled: result.size > 0,
             size: result.size,
-            entry: dataEntry,
+            entry: remoteModelData.get(validFacetKey),
             resultKeys: Array.from(result.keys()),
         };
         if ((options === null || options === void 0 ? void 0 : options.excludeZeros) && facetEntry.size === 0) {
@@ -66,19 +98,19 @@ export function getFacetEntries(modelData, remoteModelData, options, constraints
         filterItemEntries.push(facetEntry);
     };
     try {
-        for (var _b = __values(remoteModelData.values()), _c = _b.next(); !_c.done; _c = _b.next()) {
-            var dataEntry = _c.value;
-            var state_1 = _loop_1(dataEntry);
+        for (var _e = __values(validFacetKeys.values()), _f = _e.next(); !_f.done; _f = _e.next()) {
+            var validFacetKey = _f.value;
+            var state_1 = _loop_1(validFacetKey);
             if (typeof state_1 === "object")
                 return state_1.value;
         }
     }
-    catch (e_1_1) { e_1 = { error: e_1_1 }; }
+    catch (e_2_1) { e_2 = { error: e_2_1 }; }
     finally {
         try {
-            if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+            if (_f && !_f.done && (_b = _e.return)) _b.call(_e);
         }
-        finally { if (e_1) throw e_1.error; }
+        finally { if (e_2) throw e_2.error; }
     }
     return filterItemEntries;
 }

package/dist/lib-esm/getFacetEntries.js.map

@@ -1 +1 @@
-{"version":3,"file":"getFacetEntries.js","sourceRoot":"","sources":["../../src/getFacetEntries.ts"],"names":[],"mappings":";;;;;;;;;;;AASA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5C,MAAM,UAAU,eAAe,CAC7B,SAAgC,EAChC,eAAsC,EACtC,OAA2B,EAC3B,WAA+B,EAC/B,SAAoB,EACpB,QAAgC;;IAEhC,IAAM,iBAAiB,GAAsB,EAAE,CAAC;IAEhD,IAAM,8BAA8B,GAAG,WAAW,CAAC,MAAM,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,SAAS,KAAK,SAAS,CAAC,GAAG,EAA7B,CAA6B,CAAC,CAAC;IAChG,IAAM,mBAAmB,GAAG,eAAe,CAAC,SAAS,EAAE,8BAA8B,EAAE,KAAK,CAAC,CAAC;4BAEnF,SAAS;QAClB,IAAI,MAAM,GAAG,IAAI,GAAG,EAAoB,CAAC;QACzC,IAAI,QAAQ,EAAE;YACZ,IAAM,IAAI,GAAG,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;YAEzC,IAAI,IAAI,EAAE;gBACR,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,eAAe,EAAE;oBAC5B,IAAI,CAAC,OAAO,CAAC,UAAC,GAAW;wBACvB,IAAI,mBAAmB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;4BAChC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,mBAAmB,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC,CAAC;yBAChD;oBACH,CAAC,CAAC,CAAC;iBACJ;qBAAM;oBACL,IAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,UAAC,CAAC,IAAK,OAAA,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAC,EAA1B,CAA0B,CAAC,CAAC;oBACzD,IAAI,GAAG,EAAE;wBACP,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,mBAAmB,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC,CAAC;qBAChD;iBACF;aACF;SACF;aAAM;YACL,mCAAmC;YACnC,IAAM,eAAe,GAAwB;gBAC3C,GAAG,EAAE,EAAE;gBACP,SAAS,EAAE,SAAS,CAAC,GAAG;gBACxB,YAAY,EAAE,SAAS,CAAC,GAAG;gBAC3B,IAAI,EAAE,qBAAqB;gBAC3B,KAAK,EAAE,SAAS,CAAC,GAAG;gBACpB,eAAe,EAAE,CAAC,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,eAAe,CAAA;aAC5C,CAAC;YACF,MAAM,GAAG,eAAe,CAAC,mBAAmB,EAAE,CAAC,eAAe,CAAC,EAAE,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,eAAe,CAAA,CAAC,CAAC;SAC7F;QAED,IAAM,UAAU,GAAoB;YAClC,GAAG,EAAE,SAAS,CAAC,GAAG;YAClB,KAAK,EAAE,SAAS,CAAC,GAAG;YACpB,QAAQ,EAAE,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,UAAC,UAAU,IAAK,OAAA,UAAU,CAAC,GAAG,KAAK,gBAAgB,CAAC,SAAS,CAAC,GAAG,EAAE,SAAS,CAAC,GAAG,CAAC,EAAjE,CAAiE,CAAC;YAC/G,OAAO,EAAE,MAAM,CAAC,IAAI,GAAG,CAAC;YACxB,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,KAAK,EAAE,SAAS;YAChB,UAAU,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;SACtC,CAAC;QAEF,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY,KAAI,UAAU,CAAC,IAAI,KAAK,CAAC,EAAE;;SAEnD;QAED,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,KAAI,iBAAiB,CAAC,MAAM,MAAK,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,CAAA,EAAE;4BAC1D,iBAAiB;SACzB;QAED,iBAAiB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;;;QAlDrC,KAAwB,IAAA,KAAA,SAAA,eAAe,CAAC,MAAM,EAAE,CAAA,gBAAA;YAA3C,IAAM,SAAS,WAAA;kCAAT,SAAS;;;SAmDnB;;;;;;;;;IACD,OAAO,iBAAiB,CAAC;AAC3B,CAAC"}
+{"version":3,"file":"getFacetEntries.js","sourceRoot":"","sources":["../../src/getFacetEntries.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5C,MAAM,UAAU,eAAe,CAC7B,SAAgC,EAChC,eAAsC,EACtC,OAA2B,EAC3B,WAA+B,EAC/B,YAAoB,EACpB,QAA+B;;IAE/B,IAAM,iBAAiB,GAAsB,EAAE,CAAC;IAEhD,IAAM,8BAA8B,GAAG,WAAW,CAAC,MAAM,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,SAAS,KAAK,YAAY,EAA5B,CAA4B,CAAC,CAAC;IAE/F,IAAM,mBAAmB,GAAG,eAAe,CAAC,SAAS,EAAE,8BAA8B,EAAE,KAAK,CAAC,CAAC;IAE9F,IAAM,cAAc,GAAgB,IAAI,GAAG,0BAAK,eAAe,CAAC,IAAI,EAAE,UAAE,CAAC;IAEzE,IAAI,OAAO,CAAC,iBAAiB,KAAK,KAAK,EAAE;;YACvC,KAAkB,IAAA,KAAA,SAAA,QAAS,CAAC,IAAI,EAAE,CAAA,gBAAA,4BAAE;gBAA/B,IAAM,GAAG,WAAA;gBACZ,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;aACzB;;;;;;;;;KACF;4BAEU,aAAa;;QACtB,IAAM,MAAM,GAAG,IAAI,GAAG,EAAoB,CAAC;QAE3C,IAAM,gBAAgB,GAAG,QAAQ,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;;YAE3D,KAAkB,IAAA,oCAAA,SAAA,gBAAgB,CAAA,CAAA,kDAAA,gFAAE;gBAA/B,IAAM,GAAG,6BAAA;gBACZ,IAAM,KAAK,GAAG,mBAAmB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBAC3C,IAAI,KAAK,EAAE;oBACT,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;oBACvB,IAAI,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,eAAe,CAAA,EAAE;wBAC7B,MAAM;qBACP;iBACF;aACF;;;;;;;;;QAED,IAAM,UAAU,GAAoB;YAClC,GAAG,EAAE,aAAa;YAClB,KAAK,EAAE,aAAa;YACpB,QAAQ,EAAE,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,UAAC,UAAU,IAAK,OAAA,UAAU,CAAC,GAAG,KAAK,gBAAgB,CAAC,YAAY,EAAE,aAAa,CAAC,EAAhE,CAAgE,CAAC;YAC9G,OAAO,EAAE,MAAM,CAAC,IAAI,GAAG,CAAC;YACxB,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,KAAK,EAAE,eAAe,CAAC,GAAG,CAAC,aAAa,CAAE;YAC1C,UAAU,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;SACtC,CAAC;QAEF,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY,KAAI,UAAU,CAAC,IAAI,KAAK,CAAC,EAAE;;SAEnD;QAED,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,KAAI,iBAAiB,CAAC,MAAM,MAAK,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,CAAA,EAAE;4BAC1D,iBAAiB;SACzB;QAED,iBAAiB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;;;QAjCrC,KAA4B,IAAA,KAAA,SAAA,cAAc,CAAC,MAAM,EAAE,CAAA,gBAAA;YAA9C,IAAM,aAAa,WAAA;kCAAb,aAAa;;;SAkCvB;;;;;;;;;IAED,OAAO,iBAAiB,CAAC;AAC3B,CAAC"}