@rentman/rm-core 7.0.6 → 7.0.7

package/dist/types/classes/CollectionMatcherCachedCollectionProcessor.d.ts

@@ -1,31 +1,31 @@
-import { QueryMatcherFactory } from '../factories';
-import { PromiseLibraryInterface } from '../interfaces';
-import { CollectionResource, ItemEntry } from '../models';
-import { CollectionQuery, ItemType, PromiseInterface } from '../types';
-import { ApiRequestService } from './ApiRequestService';
-import { AbstractCache } from './cache/AbstractCache';
-import { ChangesDeltaBase } from './ChangesDeltaBase';
-import { CollectionMatcherBase, CollectionMatcherMatches } from './CollectionMatcherBase';
-import { QueryService } from './QueryService';
-/**
- * @description
- * Processes all {@link CollectionResource CollectionResources} and adds/removes item entries that do/don't fit the query
- */
-export declare class CollectionMatcherCachedCollectionProcessor extends CollectionMatcherBase {
-    private apiRequestService;
-    private promiseService;
-    private getCollections;
-    protected map: {
-        [itemTypeAndQueryString: string]: {
-            itemType: ItemType;
-            query: CollectionQuery;
-            collectionResources: CollectionResource[];
-            matches: CollectionMatcherMatches;
-        };
-    };
-    constructor(apiRequestService: ApiRequestService, promiseService: PromiseLibraryInterface, queryService: QueryService, queryMatcherFactory: QueryMatcherFactory, transaction: AbstractCache, getCollections: (itemType: ItemType) => {
-        [queryString: string]: CollectionResource[];
-    });
-    __removeFromAndAddToCollections(isCalledAfterSocketUpdate?: boolean, changesDelta?: ChangesDeltaBase): PromiseInterface<void[]>;
-    protected _expand<ItemTypeType extends ItemType = string>(itemEntry: ItemEntry<ItemTypeType>, matchFunction: (itemType: ItemTypeType, parsedQuery: CollectionQuery) => boolean | 'maybe'): this;
-}
+import { QueryMatcherFactory } from '../factories';
+import { PromiseLibraryInterface } from '../interfaces';
+import { CollectionResource, ItemEntry } from '../models';
+import { CollectionQuery, ItemType, PromiseInterface } from '../types';
+import { ApiRequestService } from './ApiRequestService';
+import { AbstractCache } from './cache/AbstractCache';
+import { ChangesDeltaBase } from './ChangesDeltaBase';
+import { CollectionMatcherBase, CollectionMatcherMatches } from './CollectionMatcherBase';
+import { QueryService } from './QueryService';
+/**
+ * @description
+ * Processes all {@link CollectionResource CollectionResources} and adds/removes item entries that do/don't fit the query
+ */
+export declare class CollectionMatcherCachedCollectionProcessor extends CollectionMatcherBase {
+    private apiRequestService;
+    private promiseService;
+    private getCollections;
+    protected map: {
+        [itemTypeAndQueryString: string]: {
+            itemType: ItemType;
+            query: CollectionQuery;
+            collectionResources: CollectionResource[];
+            matches: CollectionMatcherMatches;
+        };
+    };
+    constructor(apiRequestService: ApiRequestService, promiseService: PromiseLibraryInterface, queryService: QueryService, queryMatcherFactory: QueryMatcherFactory, transaction: AbstractCache, getCollections: (itemType: ItemType) => {
+        [queryString: string]: CollectionResource[];
+    });
+    __removeFromAndAddToCollections(isCalledAfterSocketUpdate?: boolean, changesDelta?: ChangesDeltaBase): PromiseInterface<void[]>;
+    protected _expand<ItemTypeType extends ItemType = string>(itemEntry: ItemEntry<ItemTypeType>, matchFunction: (itemType: ItemTypeType, parsedQuery: CollectionQuery) => boolean | 'maybe'): this;
+}

package/dist/types/classes/CollectionResourceService.d.ts

@@ -1,7 +1,7 @@
-import { CollectionOptions, ItemResource } from '../models';
-import { CollectionOptionsInterface } from '../models/CollectionOptions';
-import { ItemId, ItemType } from '../types';
-export declare class CollectionResourceService {
-    processOptions<ItemTypeType extends ItemType>(options: CollectionOptionsInterface<ItemTypeType>): CollectionOptions<ItemTypeType>;
-    getIdArray(itemResources: ItemResource[]): ItemId[];
-}
+import { CollectionOptions, ItemResource } from '../models';
+import { CollectionOptionsInterface } from '../models/CollectionOptions';
+import { ItemId, ItemType } from '../types';
+export declare class CollectionResourceService {
+    processOptions<ItemTypeType extends ItemType>(options: CollectionOptionsInterface<ItemTypeType>): CollectionOptions<ItemTypeType>;
+    getIdArray(itemResources: ItemResource[]): ItemId[];
+}

package/dist/types/classes/ColumnCache.d.ts

@@ -1,21 +1,21 @@
-import { ColumnUtil } from '../classes';
-import { ApiRequestColumns, ItemType, ResponseColumn, ResponseColumnItemTypeMap } from '../types';
-export declare class ColumnCache {
-    private columnUtil;
-    cache: ResponseColumnItemTypeMap;
-    allColumns: {
-        [itemType: string]: boolean;
-    };
-    constructor(columnUtil: ColumnUtil);
-    setColumn(itemType: ItemType, responseColumn: ResponseColumn): ResponseColumn;
-    setColumns(itemType: ItemType, requestColumns: ApiRequestColumns, responseColumns: ResponseColumnItemTypeMap): ResponseColumnItemTypeMap;
-    retrieve(itemType: ItemType, requestColumns: ApiRequestColumns): {
-        cached: ResponseColumnItemTypeMap;
-        missing: ApiRequestColumns;
-    };
-    containsAll(itemType: ItemType): boolean;
-    getColumns(itemType: ItemType): ResponseColumnItemTypeMap;
-    private retrieveColumns;
-    private retrieveColumn;
-    private getColumn;
-}
+import { ColumnUtil } from '../classes';
+import { ApiRequestColumns, ItemType, ResponseColumn, ResponseColumnItemTypeMap } from '../types';
+export declare class ColumnCache {
+    private columnUtil;
+    cache: ResponseColumnItemTypeMap;
+    allColumns: {
+        [itemType: string]: boolean;
+    };
+    constructor(columnUtil: ColumnUtil);
+    setColumn(itemType: ItemType, responseColumn: ResponseColumn): ResponseColumn;
+    setColumns(itemType: ItemType, requestColumns: ApiRequestColumns, responseColumns: ResponseColumnItemTypeMap): ResponseColumnItemTypeMap;
+    retrieve(itemType: ItemType, requestColumns: ApiRequestColumns): {
+        cached: ResponseColumnItemTypeMap;
+        missing: ApiRequestColumns;
+    };
+    containsAll(itemType: ItemType): boolean;
+    getColumns(itemType: ItemType): ResponseColumnItemTypeMap;
+    private retrieveColumns;
+    private retrieveColumn;
+    private getColumn;
+}

package/dist/types/classes/ColumnExpansion.d.ts

@@ -1,22 +1,22 @@
-import { ColumnInfo, ColumnSet } from '../classes';
-import { ColumnInfoFactory } from '../factories';
-import { ApiRequestColumn, ApiRequestColumns, ColumnExpansionResult, ItemType, ResponseColumnItemTypeMap } from '../types';
-/**
- * @description
- * A ColumnExpansion is used to make sure {@link ItemEntry ItemEntries} that have the same {@link ColumnSet ColumnSet} (matched on {@link ColumnSet.id ColumnSet.id}) will all get the same new expanded ColumnSet
- */
-export declare class ColumnExpansion<ItemTypeType extends ItemType> {
-    private columnInfoFactory;
-    itemType: ItemTypeType;
-    responseColumns: ResponseColumnItemTypeMap;
-    expansionMap: {
-        [columnSetId: string]: ColumnExpansionResult<ItemTypeType> | null;
-    };
-    expansionMapSize: number;
-    requestColumnsTrue: boolean;
-    requestColumns: ApiRequestColumn[];
-    constructor(columnInfoFactory: ColumnInfoFactory, itemType: ItemTypeType, requestColumns: ApiRequestColumns, responseColumns: ResponseColumnItemTypeMap);
-    run(columnSet: ColumnSet<ItemTypeType>): ColumnExpansionResult<ItemTypeType> | null;
-    aggregateRootColumns(): Array<ColumnInfo<ItemTypeType>>;
-    private expandRootColumnMap;
-}
+import { ColumnInfo, ColumnSet } from '../classes';
+import { ColumnInfoFactory } from '../factories';
+import { ApiRequestColumn, ApiRequestColumns, ColumnExpansionResult, ItemType, ResponseColumnItemTypeMap } from '../types';
+/**
+ * @description
+ * A ColumnExpansion is used to make sure {@link ItemEntry ItemEntries} that have the same {@link ColumnSet ColumnSet} (matched on {@link ColumnSet.id ColumnSet.id}) will all get the same new expanded ColumnSet
+ */
+export declare class ColumnExpansion<ItemTypeType extends ItemType> {
+    private columnInfoFactory;
+    itemType: ItemTypeType;
+    responseColumns: ResponseColumnItemTypeMap;
+    expansionMap: {
+        [columnSetId: string]: ColumnExpansionResult<ItemTypeType> | null;
+    };
+    expansionMapSize: number;
+    requestColumnsTrue: boolean;
+    requestColumns: ApiRequestColumn[];
+    constructor(columnInfoFactory: ColumnInfoFactory, itemType: ItemTypeType, requestColumns: ApiRequestColumns, responseColumns: ResponseColumnItemTypeMap);
+    run(columnSet: ColumnSet<ItemTypeType>): ColumnExpansionResult<ItemTypeType> | null;
+    aggregateRootColumns(): Array<ColumnInfo<ItemTypeType>>;
+    private expandRootColumnMap;
+}

package/dist/types/classes/ColumnHandler.d.ts

@@ -1,21 +1,21 @@
-import { ApiRequestService, ColumnCache, ColumnUtil } from '../classes';
-import { ErrorHandlerInterface, PromiseLibraryInterface } from '../interfaces';
-import { ApiRequestColumns, ItemType, PromiseInterface, ResponseColumn, ResponseColumnItemTypeMap } from '../types';
-export declare class ColumnHandler {
-    private apiRequestService;
-    private errorHandler;
-    private promiseService;
-    private cache;
-    private columnUtil;
-    constructor(apiRequestService: ApiRequestService, errorHandler: ErrorHandlerInterface, promiseService: PromiseLibraryInterface, cache: ColumnCache, columnUtil: ColumnUtil);
-    setColumn(itemType: ItemType, responseColumn: ResponseColumn): ResponseColumn;
-    setColumns(itemType: ItemType, requestColumns: ApiRequestColumns, responseColumns: ResponseColumnItemTypeMap): ResponseColumnItemTypeMap;
-    fetchItemTypeTranslations(itemTypes: ItemType[]): PromiseInterface<{
-        [itemType: string]: string;
-    }>;
-    request(itemType: ItemType, columns: ApiRequestColumns, params?: {
-        filter: boolean;
-    }): PromiseInterface<ResponseColumnItemTypeMap>;
-    fetch(itemType: ItemType, requestColumns: ApiRequestColumns, params?: any): PromiseInterface<ResponseColumnItemTypeMap>;
-    fetchAll(itemType: ItemType): PromiseInterface<ResponseColumnItemTypeMap>;
-}
+import { ApiRequestService, ColumnCache, ColumnUtil } from '../classes';
+import { ErrorHandlerInterface, PromiseLibraryInterface } from '../interfaces';
+import { ApiRequestColumns, ItemType, PromiseInterface, ResponseColumn, ResponseColumnItemTypeMap } from '../types';
+export declare class ColumnHandler {
+    private apiRequestService;
+    private errorHandler;
+    private promiseService;
+    private cache;
+    private columnUtil;
+    constructor(apiRequestService: ApiRequestService, errorHandler: ErrorHandlerInterface, promiseService: PromiseLibraryInterface, cache: ColumnCache, columnUtil: ColumnUtil);
+    setColumn(itemType: ItemType, responseColumn: ResponseColumn): ResponseColumn;
+    setColumns(itemType: ItemType, requestColumns: ApiRequestColumns, responseColumns: ResponseColumnItemTypeMap): ResponseColumnItemTypeMap;
+    fetchItemTypeTranslations(itemTypes: ItemType[]): PromiseInterface<{
+        [itemType: string]: string;
+    }>;
+    request(itemType: ItemType, columns: ApiRequestColumns, params?: {
+        filter: boolean;
+    }): PromiseInterface<ResponseColumnItemTypeMap>;
+    fetch(itemType: ItemType, requestColumns: ApiRequestColumns, params?: any): PromiseInterface<ResponseColumnItemTypeMap>;
+    fetchAll(itemType: ItemType): PromiseInterface<ResponseColumnItemTypeMap>;
+}

package/dist/types/classes/ColumnInfo.d.ts

@@ -1,14 +1,14 @@
-import { ItemType, ResponseColumn } from '../types';
-export declare class ColumnInfo<ItemTypeType extends ItemType = any> {
-    readonly apiColumn: ResponseColumn;
-    readonly parent: ColumnInfo<ItemType> | null;
-    id: string;
-    level: number;
-    path: string;
-    tailPath: string;
-    itemType: ItemTypeType | null;
-    children: Array<ColumnInfo<ItemTypeType>>;
-    isLeaf: boolean;
-    constructor(apiColumn: ResponseColumn, parent?: ColumnInfo<ItemType> | null);
-    setChildren(itemType: ItemTypeType, children: Array<ColumnInfo<ItemTypeType>>): this;
-}
+import { ItemType, ResponseColumn } from '../types';
+export declare class ColumnInfo<ItemTypeType extends ItemType = any> {
+    readonly apiColumn: ResponseColumn;
+    readonly parent: ColumnInfo<ItemType> | null;
+    id: string;
+    level: number;
+    path: string;
+    tailPath: string;
+    itemType: ItemTypeType | null;
+    children: Array<ColumnInfo<ItemTypeType>>;
+    isLeaf: boolean;
+    constructor(apiColumn: ResponseColumn, parent?: ColumnInfo<ItemType> | null);
+    setChildren(itemType: ItemTypeType, children: Array<ColumnInfo<ItemTypeType>>): this;
+}

package/dist/types/classes/ColumnSet.d.ts

@@ -1,38 +1,38 @@
-import { ColumnInfo, ColumnUtil, RequestColumnMergeResult } from '../classes';
-import { ColumnSetFactory } from '../factories';
-import { ApiRequestColumns, ColumnExpansionResult, ItemType, ResponseColumnItemTypeMap } from '../types';
-export declare class ColumnSet<ItemTypeType extends ItemType = any> {
-    private columnUtil;
-    private columnSetFactory;
-    itemType: ItemTypeType;
-    id: number;
-    request: ApiRequestColumns;
-    requestColumnsTrue: boolean;
-    response: ResponseColumnItemTypeMap;
-    link: ColumnInfo<ItemTypeType> | null;
-    main: Array<ColumnInfo<ItemTypeType>>;
-    derived: Array<ColumnInfo<ItemTypeType>>;
-    root: Array<ColumnInfo<ItemTypeType>>;
-    leaf: Array<ColumnInfo<ItemTypeType>>;
-    formatted: {
-        main: Array<ColumnInfo<ItemTypeType>>;
-        derived: Array<ColumnInfo<ItemTypeType>>;
-    };
-    filtered: Array<ColumnInfo<ItemTypeType>>;
-    custom: Array<ColumnInfo<ItemTypeType>>;
-    searchable: Array<ColumnInfo<ItemTypeType>>;
-    item: Array<ColumnInfo<ItemTypeType>>;
-    notItem: Array<ColumnInfo<ItemTypeType>>;
-    constructor(columnUtil: ColumnUtil, columnSetFactory: ColumnSetFactory, itemType: ItemTypeType);
-    groupColumnInfo(columnInfo: ColumnInfo): void;
-    toJSON(): {
-        main: string[];
-        derived: string[];
-    };
-    isSupersetOf(columnsToCompare: ApiRequestColumns): boolean;
-    private getMergedColumnSet;
-    mergeRequestColumns(requestColumns: ApiRequestColumns): RequestColumnMergeResult;
-    mergeResponseColumns(responseColumns: ResponseColumnItemTypeMap): ResponseColumnItemTypeMap;
-    merge(columnSet: ColumnSet<ItemTypeType>): ColumnSet<ItemTypeType>;
-    expand(requestColumns: ApiRequestColumns, requestColumnsTrue: boolean, responseColumns: ResponseColumnItemTypeMap): ColumnExpansionResult<ItemTypeType>;
-}
+import { ColumnInfo, ColumnUtil, RequestColumnMergeResult } from '../classes';
+import { ColumnSetFactory } from '../factories';
+import { ApiRequestColumns, ColumnExpansionResult, ItemType, ResponseColumnItemTypeMap } from '../types';
+export declare class ColumnSet<ItemTypeType extends ItemType = any> {
+    private columnUtil;
+    private columnSetFactory;
+    itemType: ItemTypeType;
+    id: number;
+    request: ApiRequestColumns;
+    requestColumnsTrue: boolean;
+    response: ResponseColumnItemTypeMap;
+    link: ColumnInfo<ItemTypeType> | null;
+    main: Array<ColumnInfo<ItemTypeType>>;
+    derived: Array<ColumnInfo<ItemTypeType>>;
+    root: Array<ColumnInfo<ItemTypeType>>;
+    leaf: Array<ColumnInfo<ItemTypeType>>;
+    formatted: {
+        main: Array<ColumnInfo<ItemTypeType>>;
+        derived: Array<ColumnInfo<ItemTypeType>>;
+    };
+    filtered: Array<ColumnInfo<ItemTypeType>>;
+    custom: Array<ColumnInfo<ItemTypeType>>;
+    searchable: Array<ColumnInfo<ItemTypeType>>;
+    item: Array<ColumnInfo<ItemTypeType>>;
+    notItem: Array<ColumnInfo<ItemTypeType>>;
+    constructor(columnUtil: ColumnUtil, columnSetFactory: ColumnSetFactory, itemType: ItemTypeType);
+    groupColumnInfo(columnInfo: ColumnInfo): void;
+    toJSON(): {
+        main: string[];
+        derived: string[];
+    };
+    isSupersetOf(columnsToCompare: ApiRequestColumns): boolean;
+    private getMergedColumnSet;
+    mergeRequestColumns(requestColumns: ApiRequestColumns): RequestColumnMergeResult;
+    mergeResponseColumns(responseColumns: ResponseColumnItemTypeMap): ResponseColumnItemTypeMap;
+    merge(columnSet: ColumnSet<ItemTypeType>): ColumnSet<ItemTypeType>;
+    expand(requestColumns: ApiRequestColumns, requestColumnsTrue: boolean, responseColumns: ResponseColumnItemTypeMap): ColumnExpansionResult<ItemTypeType>;
+}

package/dist/types/classes/ColumnSubsetCache.d.ts

@@ -1,10 +1,10 @@
-import { ColumnSet, ColumnUtil } from '../classes';
-import { ApiRequestColumns, ItemType } from '../types';
-export declare class ColumnSubsetCache<ItemTypeType extends ItemType> {
-    private columnUtil;
-    requestColumns: ApiRequestColumns;
-    private cache;
-    constructor(columnUtil: ColumnUtil, requestColumns: ApiRequestColumns);
-    run(columnSet: ColumnSet<ItemTypeType>): boolean;
-    runWithRequestColumns(cachedRequestColumns: ApiRequestColumns): boolean;
-}
+import { ColumnSet, ColumnUtil } from '../classes';
+import { ApiRequestColumns, ItemType } from '../types';
+export declare class ColumnSubsetCache<ItemTypeType extends ItemType> {
+    private columnUtil;
+    requestColumns: ApiRequestColumns;
+    private cache;
+    constructor(columnUtil: ColumnUtil, requestColumns: ApiRequestColumns);
+    run(columnSet: ColumnSet<ItemTypeType>): boolean;
+    runWithRequestColumns(cachedRequestColumns: ApiRequestColumns): boolean;
+}

package/dist/types/classes/ColumnUtil.d.ts

@@ -1,99 +1,99 @@
-import { LinkTreeServiceInterface } from '../interfaces/LinkTreeServiceInterface';
-import { ApiRequestColumn, ApiRequestColumns, ItemType, ResponseColumn, ResponseColumnItemTypeMap, ResponseColumnMap } from '../types';
-export declare type RequestColumnMergeResult<T extends ApiRequestColumns = ApiRequestColumns, U extends ApiRequestColumns = ApiRequestColumns> = {
-    merged: T;
-    difference: U;
-};
-export declare class ColumnUtil {
-    private linkTreeService;
-    constructor(linkTreeService: LinkTreeServiceInterface);
-    /**
-     * @description
-     * Checks the {@link ApiLinkTree LinkTree} and returns the link columnIds for the given ItemType
-     *
-     * @remark
-     * - For {@link ApiLinkTreeType.DIRECT direct links} it will be a columnId
-     * - For {@link ApiLinkTreeType.ITEMTABLE itemtable links} it will be 'itemtype' and 'item'
-     */
-    getColumnsFromLink(parentType: ItemType, itemType: ItemType): ApiRequestColumn[];
-    getColumnPath(columns: ResponseColumn[], renderAs: null | string): string;
-    getDateFormatOptions(columnType?: 'datetime'): {
-        'J-M-Y': string;
-        'J-M': string;
-        'j+F+Y': string;
-        'D+j+F+Y': string;
-        'F': string;
-        'f': string;
-        'D': string;
-        'd': string;
-    };
-    isStringColumn(column: ResponseColumn): boolean;
-    isFloatColumn(column: ResponseColumn): boolean;
-    isIntColumn(column: ResponseColumn): boolean;
-    isNumberColumn(column: ResponseColumn): boolean;
-    isCustomColumn(column: ResponseColumn): boolean;
-    isItemColumn(column: ResponseColumn, includeId?: boolean): boolean;
-    isDateColumn(column: ResponseColumn): boolean;
-    isRenderedColumn(column: ResponseColumn): boolean;
-    isFilteredColumn(column: ResponseColumn): boolean;
-    isFormattedColumn(column: ResponseColumn): boolean;
-    isSelectableColumn(column: ResponseColumn): boolean;
-    hasLocationProperty(column: ResponseColumn, location: number): boolean;
-    isEditableColumn(column: ResponseColumn): boolean;
-    isSearchableColumn(column: ResponseColumn): boolean;
-    getDefaultWeight(column: ResponseColumn): number;
-    getComparators(column: ResponseColumn & {
-        type: 'dimension' | 'weight' | 'price';
-    }): ['=', '>', '<'];
-    getComparators(column: ResponseColumn & {
-        type: 'date' | 'datetime' | 'time' | 'duration';
-    }): ['>', '<'];
-    getComparators(column: ResponseColumn): ['=', '!='];
-    containsColumn(requestColumn: ApiRequestColumn, destination: ApiRequestColumn[]): boolean;
-    containsDerivedColumns(requestColumns: ApiRequestColumn[]): boolean;
-    responseColumnsAvailable(itemType: ItemType, requestColumns: ApiRequestColumn[], responseColumnMap: ResponseColumnItemTypeMap): boolean;
-    copyRequestColumns(columns: true): true;
-    copyRequestColumns(columns: ApiRequestColumn[]): ApiRequestColumn[];
-    copyRequestColumn(requestColumn: ApiRequestColumn): ApiRequestColumn;
-    mergeRequestColumns(first: true, second: ApiRequestColumns): RequestColumnMergeResult<true, []>;
-    mergeRequestColumns(first: ApiRequestColumn[], second: true): RequestColumnMergeResult<true, true>;
-    mergeRequestColumns(first: ApiRequestColumn[], second: ApiRequestColumn[]): RequestColumnMergeResult<ApiRequestColumn[], ApiRequestColumn[]>;
-    mergeRequestColumns(first: ApiRequestColumns, second: ApiRequestColumns): RequestColumnMergeResult;
-    mergeRequestColumn(requestColumn: ApiRequestColumn, destination: ApiRequestColumn[]): string | {
-        [columnId: string]: ApiRequestColumn[];
-    } | null;
-    getRequestColumnId(requestColumn: ApiRequestColumn): string;
-    parseRequestColumn(requestColumn: ApiRequestColumn): {
-        id: string;
-        children: ApiRequestColumn[];
-    };
-    /**
-     * @description
-     * Merges two sets of {@link ResponseColumnItemTypeMap ResponseColumnItemTypeMaps}.
-     *
-     * @returns
-     * - Merged: The merged set of columns
-     * - Difference: Columns that are in second, but not in first
-     */
-    mergeResponseColumns(first: ResponseColumnItemTypeMap, second: ResponseColumnItemTypeMap): {
-        merged: ResponseColumnItemTypeMap;
-        difference: ResponseColumnItemTypeMap;
-    };
-    /**
-     * @description
-     * Merges two sets of {@link ResponseColumnMap response columns}.
-     *
-     * @returns
-     * - Merged: The merged set of columns
-     * - Difference: Columns that are in second, but not in first
-     */
-    mergeResponseColumnMap(first: ResponseColumnMap, second: ResponseColumnMap): {
-        merged: ResponseColumnMap;
-        difference: ResponseColumnMap;
-    };
-    isLocalColumnId(columnId: string): boolean;
-    processConfigColumns(configColumns: string[]): ApiRequestColumn[];
-    parseConfigColumn(configColumn: string): string[];
-    processConfigColumn(parsedConfigColumn: string[], destination: ApiRequestColumn[]): void;
-    findRequestColumn(columnId: string, requestColumns: ApiRequestColumn[]): number;
-}
+import { LinkTreeServiceInterface } from '../interfaces/LinkTreeServiceInterface';
+import { ApiRequestColumn, ApiRequestColumns, ItemType, ResponseColumn, ResponseColumnItemTypeMap, ResponseColumnMap } from '../types';
+export declare type RequestColumnMergeResult<T extends ApiRequestColumns = ApiRequestColumns, U extends ApiRequestColumns = ApiRequestColumns> = {
+    merged: T;
+    difference: U;
+};
+export declare class ColumnUtil {
+    private linkTreeService;
+    constructor(linkTreeService: LinkTreeServiceInterface);
+    /**
+     * @description
+     * Checks the {@link ApiLinkTree LinkTree} and returns the link columnIds for the given ItemType
+     *
+     * @remark
+     * - For {@link ApiLinkTreeType.DIRECT direct links} it will be a columnId
+     * - For {@link ApiLinkTreeType.ITEMTABLE itemtable links} it will be 'itemtype' and 'item'
+     */
+    getColumnsFromLink(parentType: ItemType, itemType: ItemType): ApiRequestColumn[];
+    getColumnPath(columns: ResponseColumn[], renderAs: null | string): string;
+    getDateFormatOptions(columnType?: 'datetime'): {
+        'J-M-Y': string;
+        'J-M': string;
+        'j+F+Y': string;
+        'D+j+F+Y': string;
+        'F': string;
+        'f': string;
+        'D': string;
+        'd': string;
+    };
+    isStringColumn(column: ResponseColumn): boolean;
+    isFloatColumn(column: ResponseColumn): boolean;
+    isIntColumn(column: ResponseColumn): boolean;
+    isNumberColumn(column: ResponseColumn): boolean;
+    isCustomColumn(column: ResponseColumn): boolean;
+    isItemColumn(column: ResponseColumn, includeId?: boolean): boolean;
+    isDateColumn(column: ResponseColumn): boolean;
+    isRenderedColumn(column: ResponseColumn): boolean;
+    isFilteredColumn(column: ResponseColumn): boolean;
+    isFormattedColumn(column: ResponseColumn): boolean;
+    isSelectableColumn(column: ResponseColumn): boolean;
+    hasLocationProperty(column: ResponseColumn, location: number): boolean;
+    isEditableColumn(column: ResponseColumn): boolean;
+    isSearchableColumn(column: ResponseColumn): boolean;
+    getDefaultWeight(column: ResponseColumn): number;
+    getComparators(column: ResponseColumn & {
+        type: 'dimension' | 'weight' | 'price';
+    }): ['=', '>', '<'];
+    getComparators(column: ResponseColumn & {
+        type: 'date' | 'datetime' | 'time' | 'duration';
+    }): ['>', '<'];
+    getComparators(column: ResponseColumn): ['=', '!='];
+    containsColumn(requestColumn: ApiRequestColumn, destination: ApiRequestColumn[]): boolean;
+    containsDerivedColumns(requestColumns: ApiRequestColumn[]): boolean;
+    responseColumnsAvailable(itemType: ItemType, requestColumns: ApiRequestColumn[], responseColumnMap: ResponseColumnItemTypeMap): boolean;
+    copyRequestColumns(columns: true): true;
+    copyRequestColumns(columns: ApiRequestColumn[]): ApiRequestColumn[];
+    copyRequestColumn(requestColumn: ApiRequestColumn): ApiRequestColumn;
+    mergeRequestColumns(first: true, second: ApiRequestColumns): RequestColumnMergeResult<true, []>;
+    mergeRequestColumns(first: ApiRequestColumn[], second: true): RequestColumnMergeResult<true, true>;
+    mergeRequestColumns(first: ApiRequestColumn[], second: ApiRequestColumn[]): RequestColumnMergeResult<ApiRequestColumn[], ApiRequestColumn[]>;
+    mergeRequestColumns(first: ApiRequestColumns, second: ApiRequestColumns): RequestColumnMergeResult;
+    mergeRequestColumn(requestColumn: ApiRequestColumn, destination: ApiRequestColumn[]): string | {
+        [columnId: string]: ApiRequestColumn[];
+    } | null;
+    getRequestColumnId(requestColumn: ApiRequestColumn): string;
+    parseRequestColumn(requestColumn: ApiRequestColumn): {
+        id: string;
+        children: ApiRequestColumn[];
+    };
+    /**
+     * @description
+     * Merges two sets of {@link ResponseColumnItemTypeMap ResponseColumnItemTypeMaps}.
+     *
+     * @returns
+     * - Merged: The merged set of columns
+     * - Difference: Columns that are in second, but not in first
+     */
+    mergeResponseColumns(first: ResponseColumnItemTypeMap, second: ResponseColumnItemTypeMap): {
+        merged: ResponseColumnItemTypeMap;
+        difference: ResponseColumnItemTypeMap;
+    };
+    /**
+     * @description
+     * Merges two sets of {@link ResponseColumnMap response columns}.
+     *
+     * @returns
+     * - Merged: The merged set of columns
+     * - Difference: Columns that are in second, but not in first
+     */
+    mergeResponseColumnMap(first: ResponseColumnMap, second: ResponseColumnMap): {
+        merged: ResponseColumnMap;
+        difference: ResponseColumnMap;
+    };
+    isLocalColumnId(columnId: string): boolean;
+    processConfigColumns(configColumns: string[]): ApiRequestColumn[];
+    parseConfigColumn(configColumn: string): string[];
+    processConfigColumn(parsedConfigColumn: string[], destination: ApiRequestColumn[]): void;
+    findRequestColumn(columnId: string, requestColumns: ApiRequestColumn[]): number;
+}

package/dist/types/classes/ConversionMapService.d.ts

@@ -1,27 +1,27 @@
-import { ItemEntry } from '../models';
-import { ApiResponse, EntryParentNull, FieldMap, ItemId, ItemIdConversionMap, ItemType } from '../types';
-import { ColumnInfo } from './ColumnInfo';
-import { KeyService } from './KeyService';
-/**
- * @description A 'ConversionMap' is used to update a set of item IDs to another. This happens when processing back-end
- * responses (create / template) or cloning items in the front-end. A conversion map is grouped by item type, as item
- * ID's are not unique across types.
- *
- * TODO: In the future, we should create a class and a 'ConversionMapFactory'.
- */
-export declare class ConversionMapService {
-    private keyService;
-    constructor(keyService: KeyService);
-    createLocalConversionMap(itemType: ItemType, itemId: ItemId, doExtend: boolean | undefined, apiResponse: ApiResponse): ItemIdConversionMap;
-    expandLocalConversionMap(parentType: ItemType, parentId: ItemId, apiResponse: ApiResponse, conversionMap: ItemIdConversionMap): void;
-    expandConversionMap(itemEntry: ItemEntry, conversionMap: ItemIdConversionMap, newItemId?: ItemId): ItemId;
-    batchExpandConversionMap(itemEntries: Array<ItemEntry<any>>, conversionMap: ItemIdConversionMap): ItemIdConversionMap;
-    getConversionValue(itemType: ItemType, itemId: ItemId, map: ItemIdConversionMap): ItemId | undefined;
-    /**
-     * @description
-     * Updates the columns in `fields` using the `parent` and `conversionMap`.
-     * @param parent - When retrieving an item the 'link' column is not present in the template response, and is
-     * added at a later stage. The value for this column can be read from this parameter.
-     */
-    updateItemValues<ItemTypeType extends ItemType>(source: FieldMap<ItemTypeType>, destination: FieldMap<ItemTypeType>, itemColumns: Array<ColumnInfo<ItemTypeType>>, conversionMap: ItemIdConversionMap, parent?: EntryParentNull): void;
-}
+import { ItemEntry } from '../models';
+import { ApiResponse, EntryParentNull, FieldMap, ItemId, ItemIdConversionMap, ItemType } from '../types';
+import { ColumnInfo } from './ColumnInfo';
+import { KeyService } from './KeyService';
+/**
+ * @description A 'ConversionMap' is used to update a set of item IDs to another. This happens when processing back-end
+ * responses (create / template) or cloning items in the front-end. A conversion map is grouped by item type, as item
+ * ID's are not unique across types.
+ *
+ * TODO: In the future, we should create a class and a 'ConversionMapFactory'.
+ */
+export declare class ConversionMapService {
+    private keyService;
+    constructor(keyService: KeyService);
+    createLocalConversionMap(itemType: ItemType, itemId: ItemId, doExtend: boolean | undefined, apiResponse: ApiResponse): ItemIdConversionMap;
+    expandLocalConversionMap(parentType: ItemType, parentId: ItemId, apiResponse: ApiResponse, conversionMap: ItemIdConversionMap): void;
+    expandConversionMap(itemEntry: ItemEntry, conversionMap: ItemIdConversionMap, newItemId?: ItemId): ItemId;
+    batchExpandConversionMap(itemEntries: Array<ItemEntry<any>>, conversionMap: ItemIdConversionMap): ItemIdConversionMap;
+    getConversionValue(itemType: ItemType, itemId: ItemId, map: ItemIdConversionMap): ItemId | undefined;
+    /**
+     * @description
+     * Updates the columns in `fields` using the `parent` and `conversionMap`.
+     * @param parent - When retrieving an item the 'link' column is not present in the template response, and is
+     * added at a later stage. The value for this column can be read from this parameter.
+     */
+    updateItemValues<ItemTypeType extends ItemType>(source: FieldMap<ItemTypeType>, destination: FieldMap<ItemTypeType>, itemColumns: Array<ColumnInfo<ItemTypeType>>, conversionMap: ItemIdConversionMap, parent?: EntryParentNull): void;
+}