@dcupl/common 0.0.81-beta.5 → 0.0.81-beta.7

package/dist/lib-esm/types/aggregation.types.d.ts

@@ -0,0 +1,79 @@
+export type AggregationOptions = {
+    attributeKeys: string[];
+};
+export type AggregateType = 'number' | 'reference' | 'string';
+export type AggregateBase = {
+    attribute: string;
+    type: AggregateType;
+};
+export type NumberAggregation = AggregateBase & {
+    attribute: string;
+    type: 'number';
+    value: NumberAggregationValue;
+};
+export type ReferenceAggregation = AggregateBase & {
+    attribute: string;
+    type: 'reference';
+    value: ReferenceAggregationValue[];
+};
+export type StringAggregation = AggregateBase & {
+    attribute: string;
+    type: 'string';
+    value: StringAggregationValue[];
+};
+export type Aggregation = NumberAggregation | StringAggregation | ReferenceAggregation;
+export type NumberAggregationValue = {
+    average: number;
+    count: number;
+    sum: number;
+};
+export type ReferenceAggregationValue = {
+    value: string;
+    count: number;
+    itemKeys: string[];
+};
+export type StringAggregationValue = {
+    value: string;
+    count: number;
+};
+export type AggregationTypeNew = 'sum' | 'avg' | 'min' | 'max' | 'distinct' | 'group';
+export type AggregationOptionsNew = {
+    attribute: string;
+    types: AggregationTypeNew[];
+    distinctOptions?: {
+        limit?: number;
+    };
+    groupOptions?: {
+        limit?: number;
+        calculateNotFound?: boolean;
+        groups?: AggregationGroupOption[];
+    };
+    excludeZeros?: boolean;
+    excludeUndefineds?: boolean;
+    excludeUnresolved?: boolean;
+};
+export type AggregationGroupOption = {
+    from?: any;
+    to?: any;
+    value?: any[];
+};
+export type AggregationDistinctValue = {
+    value: string;
+    count: number;
+    keys: string[];
+};
+export type AggregationGroupValue = {
+    option: AggregationGroupOption;
+    count: number;
+    keys: string[];
+};
+export type AggregationNew = {
+    attribute: string;
+    types: AggregationTypeNew[];
+    sum?: number;
+    avg?: number;
+    min?: number;
+    max?: number;
+    distinct?: AggregationDistinctValue[];
+    group?: AggregationGroupValue[];
+};

package/dist/lib-esm/types/aggregation.types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=aggregation.types.js.map

package/dist/lib-esm/types/aggregation.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"aggregation.types.js","sourceRoot":"","sources":["../../../src/types/aggregation.types.ts"],"names":[],"mappings":""}

package/dist/lib-esm/types/dcupl.types.d.ts

@@ -1,5 +1,5 @@
-import { FilterOptions } from './filter.types';
-import { DcuplItemOptions, DcuplItemsOptions } from './list.types';
+import { DcuplUpdateMessage } from '../changeDetection';
+import { DcuplItemsOptions } from './list.types';
 export type DcuplInitOptions = {
     config?: DcuplInitConfig;
     logs?: DcuplInitLoggingConfig;
@@ -41,69 +41,6 @@ export type DcuplResponse<T> = {
     metrics: DcuplMetrics;
 };
 export type DcuplGlobalItemsOptions<T> = DcuplItemsOptions<T> & {
-    listKey: string;
+    modelKey: string;
 };
-export type DcuplGlobalItemOptions<T> = DcuplItemOptions<T> & {
-    listKey: string;
-};
-export type DcuplGlobalQueryOptions<T> = DcuplItemsOptions<T> & {
-    listKey: string;
-    query: FilterOptions[];
-};
-export type DcuplQueryTransformOptions = 'lowercase' | 'trim' | 'removeWhitespace';
-type DcuplQueryOptions = {
-    transform?: DcuplQueryTransformOptions[];
-    /**
-     * Invert possible for eq, typeof
-     */
-    invert?: boolean;
-};
-export declare const DcuplQueryOperatorsAsArray: readonly ["eq", "find", "gt", "gte", "lt", "lte", "typeof", "isTruthy", "size"];
-export type DcuplQueryOperator = (typeof DcuplQueryOperatorsAsArray)[number];
-export type DcuplQueryType = 'and' | 'or';
-type DcuplQueryBase = {
-    /**
-     * title, something.key someArray[0].key
-     * */
-    attribute: string;
-    options?: DcuplQueryOptions;
-};
-type DcuplQueryEq = DcuplQueryBase & {
-    operator: 'eq';
-    /**
-     * You may search for any value but
-     * only values of type string and { key:string } may be used for indexed search
-     */
-    value: any;
-};
-type DcuplQueryFind = DcuplQueryBase & {
-    operator: 'find';
-    value: Record<string, unknown> | string;
-};
-type DcuplQueryNumbers = DcuplQueryBase & {
-    operator: 'gt' | 'lt' | 'gte' | 'lte';
-    value: string | number | Date;
-};
-type DcuplQueryTypeOf = DcuplQueryBase & {
-    operator: 'typeof';
-    value: string;
-};
-type DcuplQueryIsTruthy = DcuplQueryBase & {
-    operator: 'isTruthy';
-    value: boolean;
-};
-type DcuplQuerySize = DcuplQueryBase & {
-    operator: 'size';
-    value: number;
-};
-export type DcuplQuery = DcuplQueryEq | DcuplQueryNumbers | DcuplQueryTypeOf | DcuplQueryIsTruthy | DcuplQuerySize | DcuplQueryFind;
-export type DcuplQueryGroup<QueryType extends DcuplQuery | DcuplQueryGroup = DcuplQuery> = {
-    queryType?: DcuplQueryType;
-    queryKey?: string;
-    query: Array<QueryType>;
-    options?: DcuplQueryOptions;
-};
-export type DcuplGlobalQueryOptionsNew<T> = DcuplItemsOptions<T> & {
-    listKey: string;
-} & DcuplQueryGroup<DcuplQueryGroup<DcuplQuery>>;
-export {};
+export type CallbackFunction = (item: DcuplUpdateMessage) => void;

package/dist/lib-esm/types/dcupl.types.js

@@ -1,12 +1,2 @@
-export var DcuplQueryOperatorsAsArray = [
-    'eq',
-    'find',
-    'gt',
-    'gte',
-    'lt',
-    'lte',
-    'typeof',
-    'isTruthy',
-    'size',
-];
+export {};
 //# sourceMappingURL=dcupl.types.js.map

package/dist/lib-esm/types/dcupl.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"dcupl.types.js","sourceRoot":"","sources":["../../../src/types/dcupl.types.ts"],"names":[],"mappings":"AAkEA,MAAM,CAAC,IAAM,0BAA0B,GAAG;IACxC,IAAI;IACJ,MAAM;IACN,IAAI;IACJ,KAAK;IACL,IAAI;IACJ,KAAK;IACL,QAAQ;IACR,UAAU;IACV,MAAM;CACE,CAAC"}
+{"version":3,"file":"dcupl.types.js","sourceRoot":"","sources":["../../../src/types/dcupl.types.ts"],"names":[],"mappings":""}

package/dist/lib-esm/types/facets.types.d.ts

@@ -0,0 +1,20 @@
+import { ListItem } from './data.types';
+export type DcuplFacetOptions = {
+    attributeKey: string;
+    filterKey?: string;
+    count?: number;
+    excludeZeros?: boolean;
+    excludeUndefineds?: boolean;
+    excludeUnresolved?: boolean;
+    calculateResults?: boolean;
+};
+export type DcuplFacet = {
+    key: string;
+    enabled: boolean;
+    selected: boolean;
+    size: number;
+    value: boolean | string | null | undefined;
+    entry: ListItem;
+    resultKeys: string[];
+    children?: Array<DcuplFacet>;
+};

package/dist/lib-esm/types/facets.types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=facets.types.js.map

package/dist/lib-esm/types/facets.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"facets.types.js","sourceRoot":"","sources":["../../../src/types/facets.types.ts"],"names":[],"mappings":""}

package/dist/lib-esm/types/index.d.ts

@@ -1,11 +1,14 @@
+export * from './aggregation.types';
 export * from './data.types';
 export * from './dcupl.types';
+export * from './facets.types';
 export * from './filter.types';
 export * from './global.types';
 export * from './internal.types';
 export * from './list.types';
 export * from './model.types';
 export * from './projection.types';
-export * from './selection.types';
+export * from './query.types';
 export * from './section.types';
+export * from './selection.types';
 export * from './suggestion.types';

package/dist/lib-esm/types/index.js

@@ -1,12 +1,15 @@
+export * from './aggregation.types';
 export * from './data.types';
 export * from './dcupl.types';
+export * from './facets.types';
 export * from './filter.types';
 export * from './global.types';
 export * from './internal.types';
 export * from './list.types';
 export * from './model.types';
 export * from './projection.types';
-export * from './selection.types';
+export * from './query.types';
 export * from './section.types';
+export * from './selection.types';
 export * from './suggestion.types';
 //# sourceMappingURL=index.js.map

package/dist/lib-esm/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC"}

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

@@ -1,4 +1,4 @@
-import { DcuplGlobalQueryOptionsNew } from './dcupl.types';
+import { DcuplGlobalQueryOptionsNew } from './query.types';
 import { ViewDefinition, ModelAttribute } from './model.types';
 import { Projection, SortingProjection } from './projection.types';
 export type DcuplItemsOptions<T> = {
@@ -11,6 +11,10 @@ export type DcuplItemOptions<T> = {
     projection?: Projection<T>;
     itemKey: string;
 };
+export type DcuplManyItemsOptions<T> = {
+    projection?: Projection<T>;
+    itemKeys: string[];
+};
 export type DcuplSectionItemOption<T> = DcuplItemsOptions<T> & {
     key: string;
 };
@@ -30,8 +34,8 @@ export type DcuplFiltersOptions = DcuplFilterOptions & {
     filterKeys?: string[];
 };
 export type DcuplListOptions<ModelNames extends string = string> = {
-    listKey: ModelNames;
-    name?: string;
+    modelKey: ModelNames;
+    key?: string;
     listItemKeys?: string[];
     empty?: boolean;
 };
@@ -39,22 +43,12 @@ export type DcuplRangeOptions = {
     propertyKey: string;
     filterKey?: string;
 };
-export type DcuplFacetOptions = {
-    attributeKey: string;
-    filterKey?: string;
-    count?: number;
-    excludeZeros?: boolean;
-    excludeUndefineds?: boolean;
-    excludeUnresolved?: boolean;
-    calculateFacets?: boolean;
-};
 export type ListMetadata = {
     key: string;
     currentSize: number;
     initialSize: number;
     appliedQuery: DcuplGlobalQueryOptionsNew<any>;
     attributes: ModelAttribute[];
-    itemOptions: DcuplItemsOptions<any>;
     views: ViewDefinition[];
 };
 export type ViewMetadata = {
@@ -62,44 +56,6 @@ export type ViewMetadata = {
     currentSize: number;
     initialSize: number;
 };
-export type AggregationOptions = {
-    attributeKeys: string[];
-};
-export type AggregateType = 'number' | 'reference' | 'string';
-export type AggregateBase = {
-    attribute: string;
-    type: AggregateType;
-};
-export type NumberAggregation = AggregateBase & {
-    attribute: string;
-    type: 'number';
-    value: NumberAggregationValue;
-};
-export type ReferenceAggregation = AggregateBase & {
-    attribute: string;
-    type: 'reference';
-    value: ReferenceAggregationValue[];
-};
-export type StringAggregation = AggregateBase & {
-    attribute: string;
-    type: 'string';
-    value: StringAggregationValue[];
-};
-export type Aggregation = NumberAggregation | StringAggregation | ReferenceAggregation;
-export type NumberAggregationValue = {
-    average: number;
-    count: number;
-    sum: number;
-};
-export type ReferenceAggregationValue = {
-    value: string;
-    count: number;
-    itemKeys: string[];
-};
-export type StringAggregationValue = {
-    value: string;
-    count: number;
-};
 export type CatalogApiOptions = {
     skipProcessing?: boolean;
 };

package/dist/lib-esm/types/query.types.d.ts

@@ -0,0 +1,70 @@
+import { Projection, SortingProjection } from './projection.types';
+export type DcuplQueryTransformOptions = 'lowercase' | 'trim' | 'removeWhitespace';
+type DcuplQueryOptions = {
+    transform?: DcuplQueryTransformOptions[];
+    /**
+     * Invert possible for eq, typeof
+     */
+    invert?: boolean;
+};
+export declare const DcuplQueryOperatorsAsArray: readonly ["eq", "find", "gt", "gte", "lt", "lte", "typeof", "isTruthy", "size"];
+export type DcuplQueryOperator = (typeof DcuplQueryOperatorsAsArray)[number];
+export type DcuplQueryType = 'and' | 'or';
+type DcuplQueryBase = {
+    attribute: string;
+    options?: DcuplQueryOptions;
+};
+type DcuplQueryEq = DcuplQueryBase & {
+    operator: 'eq';
+    /**
+     * You may search for any value but
+     * only values of type string and { key:string } may be used for indexed search
+     */
+    value: any;
+};
+type DcuplQueryFind = DcuplQueryBase & {
+    operator: 'find';
+    value: Record<string, unknown> | string;
+};
+type DcuplQueryNumbers = DcuplQueryBase & {
+    operator: 'gt' | 'lt' | 'gte' | 'lte';
+    value: string | number | Date;
+};
+type DcuplQueryTypeOf = DcuplQueryBase & {
+    operator: 'typeof';
+    value: string;
+};
+type DcuplQueryIsTruthy = DcuplQueryBase & {
+    operator: 'isTruthy';
+    value: boolean;
+};
+type DcuplQuerySize = DcuplQueryBase & {
+    operator: 'size';
+    value: number;
+};
+export type DcuplQuery = DcuplQueryEq | DcuplQueryNumbers | DcuplQueryTypeOf | DcuplQueryIsTruthy | DcuplQuerySize | DcuplQueryFind;
+export type DcuplQueryGroup<ChildQuery extends DcuplQuery | DcuplQueryGroup = any> = {
+    groupType?: DcuplQueryType;
+    groupKey?: string;
+    queries: Array<ChildQuery>;
+    options?: DcuplQueryOptions;
+};
+export type DcuplGlobalQueryOptionsNew<T> = DcuplGlobalQueryOptions<T>;
+type DcuplItemOptions<T> = {
+    start?: number;
+    count?: number;
+    projection?: Projection<T>;
+    sort?: SortingProjection<T>;
+};
+export type DcuplGlobalQueryOptions<T> = {
+    modelKey: string;
+} & DcuplItemOptions<T> & DcuplQueryGroup;
+export type DcuplGlobalItemOptions<T> = {
+    modelKey: string;
+    itemKey: string;
+} & DcuplItemOptions<T>;
+export type DcuplListQueryOptions<T> = DcuplItemOptions<T> & DcuplQueryGroup;
+export type DcuplListItemOptions<T> = DcuplItemOptions<T> & {
+    itemKey: string;
+};
+export {};

package/dist/lib-esm/types/query.types.js

@@ -0,0 +1,12 @@
+export var DcuplQueryOperatorsAsArray = [
+    'eq',
+    'find',
+    'gt',
+    'gte',
+    'lt',
+    'lte',
+    'typeof',
+    'isTruthy',
+    'size',
+];
+//# sourceMappingURL=query.types.js.map

package/dist/lib-esm/types/query.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query.types.js","sourceRoot":"","sources":["../../../src/types/query.types.ts"],"names":[],"mappings":"AAYA,MAAM,CAAC,IAAM,0BAA0B,GAAG;IACxC,IAAI;IACJ,MAAM;IACN,IAAI;IACJ,KAAK;IACL,IAAI;IACJ,KAAK;IACL,QAAQ;IACR,UAAU;IACV,MAAM;CACE,CAAC"}

package/dist/lib-esm/types/section.types.d.ts

@@ -1,5 +1,5 @@
 import { ListItem } from './data.types';
-import { Aggregation } from './list.types';
+import { Aggregation } from './aggregation.types';
 export type SectionItem = ListItem & {
     _meta: {
         size: number;

package/dist/lib-esm/types/selection.types.d.ts

@@ -8,7 +8,7 @@ export type DcuplSelectionItem = {
 export type DcuplSelection = {
     uid?: string;
     selectionKey: string;
-    listKey?: string;
+    modelKey?: string;
     items?: DcuplSelectionItem[];
     properties?: DcuplSelectionProperty;
 };

package/dist/lib-esm/types/suggestion.types.d.ts

@@ -1,5 +1,6 @@
 import { CatalogApiOptions } from './list.types';
 import { FilterComparisonType } from './model.types';
+import { DcuplQueryTransformOptions } from './query.types';
 export type SuggestionValueEntry = {
     key: string;
     value: string;
@@ -14,3 +15,14 @@ export type SuggestionOptions = CatalogApiOptions & {
     max?: number;
     comparisonType?: FilterComparisonType;
 };
+export type SuggestionOptionsNew = CatalogApiOptions & {
+    attribute: string;
+    searchTerm: string;
+    max?: number;
+    calculateResultKeys?: boolean;
+    transform?: DcuplQueryTransformOptions;
+};
+export type SuggestionNew = {
+    value: string;
+    keys: string[];
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dcupl/common",
-  "version": "0.0.81-beta.5",
+  "version": "0.0.81-beta.7",
   "description": "Dcupl Common Code",
   "main": "dist/lib-cjs/index.js",
   "module": "dist/lib-esm/index.js",
@@ -24,7 +24,5 @@
     "date-fns": "^2.29.x",
     "lodash": "4.17.x"
   },
-  "peerDependencies": {
-    "rxjs": ">= 6.x <= 7.x"
-  }
+  "peerDependencies": {}
 }