@rentman/rm-core 1.6.1 → 1.6.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (93) hide show
  1. package/changelog.md +15 -0
  2. package/dist/rm-core.js +7345 -7343
  3. package/dist/rm-core.min.js +1 -1
  4. package/dist/src/classes/ApiFormatter.d.ts +39 -39
  5. package/dist/src/classes/ApiRequestService.d.ts +20 -20
  6. package/dist/src/classes/ApiResponseProcessor.d.ts +41 -41
  7. package/dist/src/classes/BatchStatus.d.ts +27 -27
  8. package/dist/src/classes/ChangesCompilation.d.ts +51 -51
  9. package/dist/src/classes/ChangesProcessor.d.ts +33 -33
  10. package/dist/src/classes/CollectionCache.d.ts +37 -37
  11. package/dist/src/classes/CollectionEntryService.d.ts +23 -23
  12. package/dist/src/classes/CollectionHandler.d.ts +57 -57
  13. package/dist/src/classes/CollectionMatcher.d.ts +41 -41
  14. package/dist/src/classes/CollectionResourceService.d.ts +6 -6
  15. package/dist/src/classes/ColumnCache.d.ts +21 -21
  16. package/dist/src/classes/ColumnExpansion.d.ts +18 -18
  17. package/dist/src/classes/ColumnHandler.d.ts +21 -21
  18. package/dist/src/classes/ColumnInfo.d.ts +14 -14
  19. package/dist/src/classes/ColumnSet.d.ts +46 -46
  20. package/dist/src/classes/ColumnSubsetCache.d.ts +8 -8
  21. package/dist/src/classes/ColumnUtil.d.ts +89 -89
  22. package/dist/src/classes/CreateRequest.d.ts +20 -20
  23. package/dist/src/classes/ItemAdministrator.d.ts +241 -241
  24. package/dist/src/classes/ItemCache.d.ts +23 -23
  25. package/dist/src/classes/ItemEntryService.d.ts +24 -24
  26. package/dist/src/classes/ItemHandler.d.ts +60 -60
  27. package/dist/src/classes/ItemRequestService.d.ts +23 -23
  28. package/dist/src/classes/KeyService.d.ts +16 -16
  29. package/dist/src/classes/LocalCache.d.ts +96 -96
  30. package/dist/src/classes/LockService.d.ts +32 -32
  31. package/dist/src/classes/ModuleChangesCompilation.d.ts +21 -21
  32. package/dist/src/classes/QueryMatcher.d.ts +14 -14
  33. package/dist/src/classes/QueryParser.d.ts +19 -19
  34. package/dist/src/classes/QueryService.d.ts +8 -8
  35. package/dist/src/classes/RequestColumnExpansion.d.ts +14 -14
  36. package/dist/src/classes/SocketMessageHandler.d.ts +41 -41
  37. package/dist/src/classes/Util.d.ts +28 -28
  38. package/dist/src/classes/index.d.ts +34 -34
  39. package/dist/src/constants.d.ts +18 -18
  40. package/dist/src/core.d.ts +48 -48
  41. package/dist/src/factories/ApiResponseProcessorFactory.d.ts +6 -6
  42. package/dist/src/factories/BatchStatusFactory.d.ts +8 -8
  43. package/dist/src/factories/ChangesCompilationFactory.d.ts +9 -9
  44. package/dist/src/factories/ChangesProcessorFactory.d.ts +18 -18
  45. package/dist/src/factories/CollectionCacheFactory.d.ts +7 -7
  46. package/dist/src/factories/CollectionEntryFactory.d.ts +22 -22
  47. package/dist/src/factories/CollectionMatcherFactory.d.ts +7 -7
  48. package/dist/src/factories/CollectionResourceFactory.d.ts +31 -31
  49. package/dist/src/factories/ColumnExpansionFactory.d.ts +8 -8
  50. package/dist/src/factories/ColumnInfoFactory.d.ts +7 -7
  51. package/dist/src/factories/ColumnSetFactory.d.ts +11 -11
  52. package/dist/src/factories/ColumnSubsetCacheFactory.d.ts +6 -6
  53. package/dist/src/factories/CreateRequestFactory.d.ts +11 -11
  54. package/dist/src/factories/ItemCacheFactory.d.ts +7 -7
  55. package/dist/src/factories/ItemEntryFactory.d.ts +20 -20
  56. package/dist/src/factories/ItemResourceFactory.d.ts +26 -26
  57. package/dist/src/factories/LocalCacheFactory.d.ts +17 -17
  58. package/dist/src/factories/ModuleChangesCompilationFactory.d.ts +5 -5
  59. package/dist/src/factories/QueryMatcherFactory.d.ts +7 -7
  60. package/dist/src/factories/QueryParserFactory.d.ts +6 -6
  61. package/dist/src/factories/RequestColumnExpansionFactory.d.ts +6 -6
  62. package/dist/src/factories/TemplateFactory.d.ts +10 -10
  63. package/dist/src/factories/index.d.ts +22 -22
  64. package/dist/src/index.d.ts +7 -7
  65. package/dist/src/interfaces/ApiRequestServiceInterface.d.ts +11 -11
  66. package/dist/src/interfaces/AuthInterface.d.ts +9 -9
  67. package/dist/src/interfaces/ErrorHandlerInterface.d.ts +5 -5
  68. package/dist/src/interfaces/ExceptionHandlerInterface.d.ts +3 -3
  69. package/dist/src/interfaces/LocalCacheManagerInterface.d.ts +6 -6
  70. package/dist/src/interfaces/PromiseLibraryInterface.d.ts +25 -25
  71. package/dist/src/interfaces/SocketMessageInterface.d.ts +3 -3
  72. package/dist/src/interfaces/index.d.ts +7 -7
  73. package/dist/src/models/CollectionEditResource.d.ts +14 -14
  74. package/dist/src/models/CollectionEntry.d.ts +83 -83
  75. package/dist/src/models/CollectionEntryOptions.d.ts +12 -12
  76. package/dist/src/models/CollectionResource.d.ts +39 -39
  77. package/dist/src/models/CollectionResourceOptions.d.ts +24 -24
  78. package/dist/src/models/CollectionViewResource.d.ts +6 -6
  79. package/dist/src/models/EditResource.d.ts +18 -18
  80. package/dist/src/models/ItemEntry.d.ts +73 -73
  81. package/dist/src/models/ItemEntryOptions.d.ts +11 -11
  82. package/dist/src/models/ItemResource.d.ts +23 -23
  83. package/dist/src/models/ItemResourceOptions.d.ts +10 -10
  84. package/dist/src/models/LocalViewResource.d.ts +4 -4
  85. package/dist/src/models/RemoteViewResource.d.ts +4 -4
  86. package/dist/src/models/Template.d.ts +11 -11
  87. package/dist/src/models/ViewResource.d.ts +6 -6
  88. package/dist/src/models/index.d.ts +15 -15
  89. package/dist/src/types/ItemTypesCollection.d.ts +220 -220
  90. package/dist/src/types/PromiseInterface.d.ts +2 -2
  91. package/dist/src/types/index.d.ts +2 -2
  92. package/package.json +1 -1
  93. package/readme.md +15 -15
@@ -1,89 +1,89 @@
1
- import { ApiRequestColumn, ApiRequestColumns, ItemType, ResponseColumn, ResponseColumnMap } from '../types';
2
- export declare type RequestColumnMergeResult<T extends ApiRequestColumns = ApiRequestColumns, U extends ApiRequestColumns = ApiRequestColumns> = {
3
- merged: T;
4
- difference: U;
5
- };
6
- export declare class ColumnUtil {
7
- constructor();
8
- getColumnPath(columns: ResponseColumn[], renderAs: null | string): string;
9
- getDateFormatOptions(columnType?: 'datetime'): {
10
- 'J-M-Y': string;
11
- 'J-M': string;
12
- 'j+F+Y': string;
13
- 'D+j+F+Y': string;
14
- 'F': string;
15
- 'f': string;
16
- 'D': string;
17
- 'd': string;
18
- };
19
- isStringColumn(column: ResponseColumn): boolean;
20
- isFloatColumn(column: ResponseColumn): boolean;
21
- isIntColumn(column: ResponseColumn): boolean;
22
- isNumberColumn(column: ResponseColumn): boolean;
23
- isCustomColumn(column: ResponseColumn): boolean;
24
- isItemColumn(column: ResponseColumn, includeId?: boolean): boolean;
25
- isDateColumn(column: ResponseColumn): boolean;
26
- isRenderedColumn(column: ResponseColumn): boolean;
27
- isFilteredColumn(column: ResponseColumn): boolean;
28
- isFormattedColumn(column: ResponseColumn): boolean;
29
- isSelectableColumn(column: ResponseColumn): boolean;
30
- hasLocationProperty(column: ResponseColumn, location: number): boolean;
31
- isEditableColumn(column: ResponseColumn): boolean;
32
- isSearchableColumn(column: ResponseColumn): boolean;
33
- getDefaultWeight(column: ResponseColumn): number;
34
- getComparators(column: ResponseColumn & {
35
- type: 'dimension' | 'weight' | 'price';
36
- }): ['=', '>', '<'];
37
- getComparators(column: ResponseColumn & {
38
- type: 'date' | 'datetime' | 'time' | 'duration';
39
- }): ['>', '<'];
40
- getComparators(column: ResponseColumn): ['=', '!='];
41
- containsColumn(requestColumn: ApiRequestColumn, destination: ApiRequestColumn[]): boolean;
42
- containsDerivedColumns(requestColumns: ApiRequestColumn[]): boolean;
43
- responseColumnsAvailable(itemType: ItemType, requestColumns: ApiRequestColumn[], responseColumnMap: ResponseColumnMap): boolean;
44
- copyRequestColumns(columns: true): true;
45
- copyRequestColumns(columns: ApiRequestColumn[]): ApiRequestColumn[];
46
- copyRequestColumn(requestColumn: ApiRequestColumn): ApiRequestColumn;
47
- /**
48
- * Difference: columns that are in second, but not in first
49
- * @param {Array} first
50
- * @param {Array} second
51
- * @returns {Object} An object containing 'merged' and 'difference' properties
52
- */
53
- mergeRequestColumns(first: true, second: ApiRequestColumns): RequestColumnMergeResult<true, []>;
54
- mergeRequestColumns(first: ApiRequestColumn[], second: true): RequestColumnMergeResult<true, true>;
55
- mergeRequestColumns(first: ApiRequestColumn[], second: ApiRequestColumn[]): RequestColumnMergeResult<ApiRequestColumn[], ApiRequestColumn[]>;
56
- mergeRequestColumns(first: ApiRequestColumns, second: ApiRequestColumns): RequestColumnMergeResult;
57
- mergeRequestColumn(requestColumn: ApiRequestColumn, destination: ApiRequestColumn[]): string | {
58
- [columnId: string]: ApiRequestColumn[];
59
- } | null;
60
- getRequestColumnId(requestColumn: ApiRequestColumn): string;
61
- parseRequestColumn(requestColumn: ApiRequestColumn): {
62
- id: string;
63
- children: ApiRequestColumn[];
64
- };
65
- /**
66
- * Merges two sets of response columns.
67
- * @param {object} first
68
- * @param {object} second
69
- * @returns {object} An object containing a 'merged' and a 'difference' property.
70
- */
71
- mergeResponseColumns(first: ResponseColumnMap, second: ResponseColumnMap): {
72
- merged: ResponseColumnMap;
73
- difference: ResponseColumnMap;
74
- };
75
- /**
76
- * @param {array} first
77
- * @param {array} second
78
- * @returns {object} difference: the columns that are in second, but not in first.
79
- */
80
- mergeResponseColumnMap(first: ResponseColumnMap, second: ResponseColumnMap): {
81
- merged: ResponseColumnMap;
82
- difference: ResponseColumnMap;
83
- };
84
- isLocalColumnId(columnId: string): boolean;
85
- processConfigColumns(configColumns: string[]): ApiRequestColumn[];
86
- parseConfigColumn(configColumn: string): string[];
87
- processConfigColumn(parsedConfigColumn: string[], destination: ApiRequestColumn[]): void;
88
- findRequestColumn(columnId: string, requestColumns: ApiRequestColumn[]): number;
89
- }
1
+ import { ApiRequestColumn, ApiRequestColumns, ItemType, ResponseColumn, ResponseColumnMap } from '../types';
2
+ export declare type RequestColumnMergeResult<T extends ApiRequestColumns = ApiRequestColumns, U extends ApiRequestColumns = ApiRequestColumns> = {
3
+ merged: T;
4
+ difference: U;
5
+ };
6
+ export declare class ColumnUtil {
7
+ constructor();
8
+ getColumnPath(columns: ResponseColumn[], renderAs: null | string): string;
9
+ getDateFormatOptions(columnType?: 'datetime'): {
10
+ 'J-M-Y': string;
11
+ 'J-M': string;
12
+ 'j+F+Y': string;
13
+ 'D+j+F+Y': string;
14
+ 'F': string;
15
+ 'f': string;
16
+ 'D': string;
17
+ 'd': string;
18
+ };
19
+ isStringColumn(column: ResponseColumn): boolean;
20
+ isFloatColumn(column: ResponseColumn): boolean;
21
+ isIntColumn(column: ResponseColumn): boolean;
22
+ isNumberColumn(column: ResponseColumn): boolean;
23
+ isCustomColumn(column: ResponseColumn): boolean;
24
+ isItemColumn(column: ResponseColumn, includeId?: boolean): boolean;
25
+ isDateColumn(column: ResponseColumn): boolean;
26
+ isRenderedColumn(column: ResponseColumn): boolean;
27
+ isFilteredColumn(column: ResponseColumn): boolean;
28
+ isFormattedColumn(column: ResponseColumn): boolean;
29
+ isSelectableColumn(column: ResponseColumn): boolean;
30
+ hasLocationProperty(column: ResponseColumn, location: number): boolean;
31
+ isEditableColumn(column: ResponseColumn): boolean;
32
+ isSearchableColumn(column: ResponseColumn): boolean;
33
+ getDefaultWeight(column: ResponseColumn): number;
34
+ getComparators(column: ResponseColumn & {
35
+ type: 'dimension' | 'weight' | 'price';
36
+ }): ['=', '>', '<'];
37
+ getComparators(column: ResponseColumn & {
38
+ type: 'date' | 'datetime' | 'time' | 'duration';
39
+ }): ['>', '<'];
40
+ getComparators(column: ResponseColumn): ['=', '!='];
41
+ containsColumn(requestColumn: ApiRequestColumn, destination: ApiRequestColumn[]): boolean;
42
+ containsDerivedColumns(requestColumns: ApiRequestColumn[]): boolean;
43
+ responseColumnsAvailable(itemType: ItemType, requestColumns: ApiRequestColumn[], responseColumnMap: ResponseColumnMap): boolean;
44
+ copyRequestColumns(columns: true): true;
45
+ copyRequestColumns(columns: ApiRequestColumn[]): ApiRequestColumn[];
46
+ copyRequestColumn(requestColumn: ApiRequestColumn): ApiRequestColumn;
47
+ /**
48
+ * Difference: columns that are in second, but not in first
49
+ * @param {Array} first
50
+ * @param {Array} second
51
+ * @returns {Object} An object containing 'merged' and 'difference' properties
52
+ */
53
+ mergeRequestColumns(first: true, second: ApiRequestColumns): RequestColumnMergeResult<true, []>;
54
+ mergeRequestColumns(first: ApiRequestColumn[], second: true): RequestColumnMergeResult<true, true>;
55
+ mergeRequestColumns(first: ApiRequestColumn[], second: ApiRequestColumn[]): RequestColumnMergeResult<ApiRequestColumn[], ApiRequestColumn[]>;
56
+ mergeRequestColumns(first: ApiRequestColumns, second: ApiRequestColumns): RequestColumnMergeResult;
57
+ mergeRequestColumn(requestColumn: ApiRequestColumn, destination: ApiRequestColumn[]): string | {
58
+ [columnId: string]: ApiRequestColumn[];
59
+ } | null;
60
+ getRequestColumnId(requestColumn: ApiRequestColumn): string;
61
+ parseRequestColumn(requestColumn: ApiRequestColumn): {
62
+ id: string;
63
+ children: ApiRequestColumn[];
64
+ };
65
+ /**
66
+ * Merges two sets of response columns.
67
+ * @param {object} first
68
+ * @param {object} second
69
+ * @returns {object} An object containing a 'merged' and a 'difference' property.
70
+ */
71
+ mergeResponseColumns(first: ResponseColumnMap, second: ResponseColumnMap): {
72
+ merged: ResponseColumnMap;
73
+ difference: ResponseColumnMap;
74
+ };
75
+ /**
76
+ * @param {array} first
77
+ * @param {array} second
78
+ * @returns {object} difference: the columns that are in second, but not in first.
79
+ */
80
+ mergeResponseColumnMap(first: ResponseColumnMap, second: ResponseColumnMap): {
81
+ merged: ResponseColumnMap;
82
+ difference: ResponseColumnMap;
83
+ };
84
+ isLocalColumnId(columnId: string): boolean;
85
+ processConfigColumns(configColumns: string[]): ApiRequestColumn[];
86
+ parseConfigColumn(configColumn: string): string[];
87
+ processConfigColumn(parsedConfigColumn: string[], destination: ApiRequestColumn[]): void;
88
+ findRequestColumn(columnId: string, requestColumns: ApiRequestColumn[]): number;
89
+ }
@@ -1,20 +1,20 @@
1
- import { CollectionCache, CollectionHandler, CreateCompilation, KeyService } from '../classes';
2
- import { CollectionMatcherFactory, RequestColumnExpansionFactory } from '../factories';
3
- import { CreateRequestEntry, CreateRequestParameterMap, ItemType } from '../types';
4
- export declare class CreateRequest {
5
- private collectionHandler;
6
- private collectionMatcherFactory;
7
- private keyService;
8
- private requestColumnExpansionFactory;
9
- private compilation;
10
- private localCollectionCache;
11
- private parameterMap;
12
- private breakupByParent;
13
- requests: CreateRequestEntry[];
14
- constructor(collectionHandler: CollectionHandler, collectionMatcherFactory: CollectionMatcherFactory, keyService: KeyService, requestColumnExpansionFactory: RequestColumnExpansionFactory, compilation: CreateCompilation, localCollectionCache: CollectionCache, parameterMap: CreateRequestParameterMap, breakupByParent?: boolean);
15
- finalizeRequest(requestResource: CreateRequestEntry): CreateRequestEntry;
16
- setRequestParent(parentType: ItemType, requestEntry: CreateRequestEntry): boolean;
17
- run(): CreateRequestEntry[];
18
- initializeRequest(): CreateRequestEntry;
19
- private extendRequest;
20
- }
1
+ import { CollectionCache, CollectionHandler, CreateCompilation, KeyService } from '../classes';
2
+ import { CollectionMatcherFactory, RequestColumnExpansionFactory } from '../factories';
3
+ import { CreateRequestEntry, CreateRequestParameterMap, ItemType } from '../types';
4
+ export declare class CreateRequest {
5
+ private collectionHandler;
6
+ private collectionMatcherFactory;
7
+ private keyService;
8
+ private requestColumnExpansionFactory;
9
+ private compilation;
10
+ private localCollectionCache;
11
+ private parameterMap;
12
+ private breakupByParent;
13
+ requests: CreateRequestEntry[];
14
+ constructor(collectionHandler: CollectionHandler, collectionMatcherFactory: CollectionMatcherFactory, keyService: KeyService, requestColumnExpansionFactory: RequestColumnExpansionFactory, compilation: CreateCompilation, localCollectionCache: CollectionCache, parameterMap: CreateRequestParameterMap, breakupByParent?: boolean);
15
+ finalizeRequest(requestResource: CreateRequestEntry): CreateRequestEntry;
16
+ setRequestParent(parentType: ItemType, requestEntry: CreateRequestEntry): boolean;
17
+ run(): CreateRequestEntry[];
18
+ initializeRequest(): CreateRequestEntry;
19
+ private extendRequest;
20
+ }