@rentman/rm-core 1.7.6 → 1.9.0

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

@@ -1,89 +1,88 @@
-import { ApiRequestColumn, ApiRequestColumns, ItemType, ResponseColumn, ResponseColumnMap } from '../types';
-export declare type RequestColumnMergeResult<T extends ApiRequestColumns = ApiRequestColumns, U extends ApiRequestColumns = ApiRequestColumns> = {
-    merged: T;
-    difference: U;
-};
-export declare class ColumnUtil {
-    constructor();
-    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: ResponseColumnMap): boolean;
-    copyRequestColumns(columns: true): true;
-    copyRequestColumns(columns: ApiRequestColumn[]): ApiRequestColumn[];
-    copyRequestColumn(requestColumn: ApiRequestColumn): ApiRequestColumn;
-    /**
-     * Difference: columns that are in second, but not in first
-     * @param {Array} first
-     * @param {Array} second
-     * @returns {Object} An object containing 'merged' and 'difference' properties
-     */
-    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[];
-    };
-    /**
-     * Merges two sets of response columns.
-     * @param {object} first
-     * @param {object} second
-     * @returns {object} An object containing a 'merged' and a 'difference' property.
-     */
-    mergeResponseColumns(first: ResponseColumnMap, second: ResponseColumnMap): {
-        merged: ResponseColumnMap;
-        difference: ResponseColumnMap;
-    };
-    /**
-     * @param {array} first
-     * @param {array} second
-     * @returns {object} difference: the 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 { 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 {
+    constructor();
+    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/src/classes/CreateRequest.d.ts

@@ -1,20 +1,20 @@
-import { CollectionCache, CollectionHandler, CreateCompilation, KeyService } from '../classes';
-import { CollectionMatcherFactory, RequestColumnExpansionFactory } from '../factories';
-import { CreateRequestEntry, CreateRequestParameterMap, ItemType } from '../types';
-export declare class CreateRequest<ItemTypeType extends ItemType> {
-    private collectionHandler;
-    private collectionMatcherFactory;
-    private keyService;
-    private requestColumnExpansionFactory;
-    private compilation;
-    private localCollectionCache;
-    private parameterMap;
-    private breakupByParent;
-    requests: Array<CreateRequestEntry<ItemTypeType>>;
-    constructor(collectionHandler: CollectionHandler, collectionMatcherFactory: CollectionMatcherFactory, keyService: KeyService, requestColumnExpansionFactory: RequestColumnExpansionFactory, compilation: CreateCompilation, localCollectionCache: CollectionCache, parameterMap: CreateRequestParameterMap, breakupByParent?: boolean);
-    finalizeRequest(requestResource: CreateRequestEntry<ItemTypeType>): CreateRequestEntry<ItemTypeType>;
-    setRequestParent(parentType: ItemType, requestEntry: CreateRequestEntry<ItemTypeType>): boolean;
-    run(): CreateRequestEntry<ItemTypeType>[];
-    initializeRequest(): CreateRequestEntry<ItemTypeType>;
-    private extendRequest;
-}
+import { CollectionCache, CollectionHandler, CreateCompilation, KeyService } from '../classes';
+import { CollectionMatcherFactory, RequestColumnExpansionFactory } from '../factories';
+import { CreateRequestEntry, CreateRequestParameterMap, ItemType } from '../types';
+export declare class CreateRequest<ItemTypeType extends ItemType> {
+    private collectionHandler;
+    private collectionMatcherFactory;
+    private keyService;
+    private requestColumnExpansionFactory;
+    private compilation;
+    private localCollectionCache;
+    private parameterMap;
+    private breakupByParent;
+    requests: Array<CreateRequestEntry<ItemTypeType>>;
+    constructor(collectionHandler: CollectionHandler, collectionMatcherFactory: CollectionMatcherFactory, keyService: KeyService, requestColumnExpansionFactory: RequestColumnExpansionFactory, compilation: CreateCompilation, localCollectionCache: CollectionCache, parameterMap: CreateRequestParameterMap, breakupByParent?: boolean);
+    finalizeRequest(requestResource: CreateRequestEntry<ItemTypeType>): CreateRequestEntry<ItemTypeType>;
+    setRequestParent(parentType: ItemType, requestEntry: CreateRequestEntry<ItemTypeType>): boolean;
+    run(): CreateRequestEntry<ItemTypeType>[];
+    initializeRequest(): CreateRequestEntry<ItemTypeType>;
+    private extendRequest;
+}