@rentman/rm-core 1.5.7 → 1.5.9

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 (92) hide show
  1. package/changelog.md +17 -0
  2. package/dist/rm-core.js +7282 -7211
  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 -19
  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 -97
  22. package/dist/src/classes/CreateRequest.d.ts +20 -20
  23. package/dist/src/classes/ItemAdministrator.d.ts +241 -119
  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 +95 -67
  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 +17 -17
  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 +21 -21
  47. package/dist/src/factories/CollectionMatcherFactory.d.ts +7 -7
  48. package/dist/src/factories/CollectionResourceFactory.d.ts +30 -23
  49. package/dist/src/factories/ColumnExpansionFactory.d.ts +8 -8
  50. package/dist/src/factories/ColumnInfoFactory.d.ts +7 -6
  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 +19 -19
  56. package/dist/src/factories/ItemResourceFactory.d.ts +26 -20
  57. package/dist/src/factories/LocalCacheFactory.d.ts +15 -15
  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/LocalCacheManagerInterface.d.ts +6 -6
  69. package/dist/src/interfaces/PromiseLibraryInterface.d.ts +25 -25
  70. package/dist/src/interfaces/SocketMessageInterface.d.ts +3 -3
  71. package/dist/src/interfaces/index.d.ts +6 -6
  72. package/dist/src/models/CollectionEditResource.d.ts +15 -15
  73. package/dist/src/models/CollectionEntry.d.ts +81 -81
  74. package/dist/src/models/CollectionEntryOptions.d.ts +12 -12
  75. package/dist/src/models/CollectionResource.d.ts +39 -40
  76. package/dist/src/models/CollectionResourceOptions.d.ts +24 -23
  77. package/dist/src/models/CollectionViewResource.d.ts +6 -6
  78. package/dist/src/models/EditResource.d.ts +18 -18
  79. package/dist/src/models/ItemEntry.d.ts +73 -73
  80. package/dist/src/models/ItemEntryOptions.d.ts +11 -11
  81. package/dist/src/models/ItemResource.d.ts +23 -23
  82. package/dist/src/models/ItemResourceOptions.d.ts +10 -9
  83. package/dist/src/models/LocalViewResource.d.ts +4 -0
  84. package/dist/src/models/RemoteViewResource.d.ts +4 -0
  85. package/dist/src/models/Template.d.ts +11 -11
  86. package/dist/src/models/ViewResource.d.ts +6 -4
  87. package/dist/src/models/index.d.ts +15 -13
  88. package/dist/src/types/ItemTypesCollection.d.ts +220 -227
  89. package/dist/src/types/PromiseInterface.d.ts +2 -2
  90. package/dist/src/types/index.d.ts +2 -2
  91. package/package.json +1 -1
  92. package/readme.md +15 -15
@@ -1,81 +1,81 @@
1
- import { ColumnExpansion, ColumnInfo, ColumnSet, ItemCache } from '../classes';
2
- import { CollectionEntryFactory } from '../factories';
3
- import { CollectionEditResource, CollectionEntryOptions, CollectionResource, CollectionViewResource, ItemEntry, ViewResource } from '../models';
4
- import { ApiRequestColumns, CollectionQuery, ConversionMap, EntryParentNull, FieldMap, ItemId, ItemIdConversionMap, ItemType, PromiseInterface, QueryCallback } from '../types';
5
- export declare class CollectionEntry {
6
- private factory;
7
- itemType: ItemType;
8
- options: CollectionEntryOptions;
9
- id: number;
10
- query: CollectionQuery;
11
- columns: ColumnSet;
12
- templateColumns: ColumnSet | null;
13
- parent: EntryParentNull;
14
- initial: ItemEntry[];
15
- items: ItemEntry[];
16
- resources: Array<CollectionViewResource | CollectionEditResource>;
17
- deferred: any;
18
- promise: PromiseInterface<this>;
19
- reloadQueued: boolean;
20
- hasEditResources: boolean;
21
- hasItemEditResources: boolean;
22
- constructor(factory: CollectionEntryFactory, itemType: ItemType, options: CollectionEntryOptions);
23
- defer(): this;
24
- isDeferred(): boolean;
25
- _resolve(): this;
26
- resolve(itemEntryCompound: {
27
- columns: ColumnSet;
28
- initial: ItemEntry[];
29
- modified?: ItemEntry[];
30
- }): this;
31
- isLocal(): boolean;
32
- matchParent(itemType: ItemType, itemId: ItemId): boolean;
33
- forEach(callback: (itemEntry: ItemEntry) => void): void;
34
- getItemById(itemId: ItemId): ItemEntry | undefined;
35
- getIdArray(accumulator?: ItemId[]): ItemId[];
36
- createItems(valuesArray: FieldMap[]): PromiseInterface<ItemEntry[]>;
37
- resolveDerivedValues(itemEntries: ItemEntry[], localItemCache: ItemCache): PromiseInterface<ItemEntry[]>;
38
- addItems<U extends CollectionResource>(itemEntries: ItemEntry[], resultResource: U, updateInitial?: boolean, callOnAdd?: boolean, callOnActivate?: boolean): U['items'];
39
- addItems(itemEntries: ItemEntry[], resultResource?: null, updateInitial?: boolean, callOnAdd?: boolean, callOnActivate?: boolean): null;
40
- addItems<U extends CollectionResource>(itemEntries: ItemEntry[], resultResource?: U | null, updateInitial?: boolean, callOnAdd?: boolean, callOnActivate?: boolean): U['items'] | null;
41
- private handleAddedItemCallbacks;
42
- removeItems<U extends CollectionResource>(idArray: ItemId[], resultResource: U, updateInitial?: boolean, callOnRemove?: boolean): U['items'];
43
- removeItems(idArray: ItemId[], resultResource?: null, updateInitial?: boolean, callOnRemove?: boolean): null;
44
- removeItems<U extends CollectionResource>(idArray: ItemId[], resultResource?: U | null, updateInitial?: boolean, callOnRemove?: boolean): U['items'] | null;
45
- clear<U extends CollectionResource>(resultResource: U, updateInitial?: boolean, callOnRemove?: boolean): U['items'];
46
- clear(resultResource?: null, updateInitial?: boolean, callOnRemove?: boolean): null;
47
- handleRemovedItems<U extends CollectionResource>(filterFunction: (itemEntry: ItemEntry) => boolean, resultResource: U, updateInitial?: boolean, callOnRemove?: boolean): U['items'];
48
- handleRemovedItems(filterFunction: (itemEntry: ItemEntry) => boolean, resultResource?: null, updateInitial?: boolean, callOnRemove?: boolean): null;
49
- handleRemovedItems<U extends CollectionResource>(filterFunction: (itemEntry: ItemEntry) => boolean, resultResource?: U | null, updateInitial?: boolean, callOnRemove?: boolean): U['items'] | null;
50
- private handleRemovedItemCallbacks;
51
- private createBatchStatus;
52
- private expandLocal;
53
- private expandRemote;
54
- expand(newColumns: ApiRequestColumns, localItemCache: ItemCache): PromiseInterface<this>;
55
- extendQuery(callback?: QueryCallback): CollectionQuery;
56
- extend<U extends CollectionResource>(queryCallback: QueryCallback, collectionResource?: U, callOnAdd?: boolean, updateInitial?: boolean): PromiseInterface<U['items']>;
57
- extend(queryCallback: QueryCallback, collectionResource?: null, callOnAdd?: boolean, updateInitial?: boolean): PromiseInterface<null>;
58
- queueReload(): void;
59
- expandColumns(columnExpansion: ColumnExpansion): void;
60
- expandRequestColumns(requestColumns: ApiRequestColumns): void;
61
- getAddedItems(returnItemIds: true): ItemId[];
62
- getAddedItems(returnItemIds?: boolean): ItemEntry[];
63
- getRemovedItems(returnItemIds: true): ItemId[];
64
- getRemovedItems(returnItemIds?: boolean): ItemEntry[];
65
- getUpdatedItems(): ItemEntry[];
66
- hasAddedItems(): boolean;
67
- hasRemovedItems(): boolean;
68
- hasUpdatedItems(): boolean;
69
- getCurrentResource<T extends CollectionViewResource = CollectionViewResource<ViewResource>>(): T;
70
- clearResources(isSubtabChange?: boolean): void;
71
- /**
72
- * @description
73
- * this doesn't revert updates
74
- */
75
- revertChanges(): void;
76
- onItemsCreated(conversionMap: ConversionMap): void;
77
- getUpdatedItemColumns(conversionMap: ItemIdConversionMap): {
78
- [columnId: string]: ColumnInfo;
79
- };
80
- clone(parent: EntryParentNull, conversionMap?: ItemIdConversionMap): CollectionEntry;
81
- }
1
+ import { ColumnExpansion, ColumnInfo, ColumnSet, ItemCache } from '../classes';
2
+ import { CollectionEntryFactory } from '../factories';
3
+ import { CollectionEntryOptions, CollectionResource, ItemEntry } from '../models';
4
+ import { ApiRequestColumns, CollectionQuery, ConversionMap, EntryParentNull, FieldMap, ItemId, ItemIdConversionMap, ItemType, PromiseInterface, QueryCallback } from '../types';
5
+ export declare class CollectionEntry {
6
+ private factory;
7
+ itemType: ItemType;
8
+ options: CollectionEntryOptions;
9
+ id: number;
10
+ query: CollectionQuery;
11
+ columns: ColumnSet;
12
+ templateColumns: ColumnSet | null;
13
+ parent: EntryParentNull;
14
+ initial: ItemEntry[];
15
+ items: ItemEntry[];
16
+ resources: CollectionResource[];
17
+ deferred: any;
18
+ promise: PromiseInterface<this>;
19
+ reloadQueued: boolean;
20
+ hasEditResources: boolean;
21
+ hasItemEditResources: boolean;
22
+ constructor(factory: CollectionEntryFactory, itemType: ItemType, options: CollectionEntryOptions);
23
+ defer(): this;
24
+ isDeferred(): boolean;
25
+ _resolve(): this;
26
+ resolve(itemEntryCompound: {
27
+ columns: ColumnSet;
28
+ initial: ItemEntry[];
29
+ modified?: ItemEntry[];
30
+ }): this;
31
+ isLocal(): boolean;
32
+ matchParent(itemType: ItemType, itemId: ItemId): boolean;
33
+ forEach(callback: (itemEntry: ItemEntry) => void): void;
34
+ getItemById(itemId: ItemId): ItemEntry | undefined;
35
+ getIdArray(accumulator?: ItemId[]): ItemId[];
36
+ createItems(valuesArray: FieldMap[]): PromiseInterface<ItemEntry[]>;
37
+ resolveDerivedValues(itemEntries: ItemEntry[], localItemCache: ItemCache): PromiseInterface<ItemEntry[]>;
38
+ addItems<U extends CollectionResource>(itemEntries: ItemEntry[], resultResource: U, updateInitial?: boolean, callOnAdd?: boolean, callOnActivate?: boolean): U['items'];
39
+ addItems(itemEntries: ItemEntry[], resultResource?: null, updateInitial?: boolean, callOnAdd?: boolean, callOnActivate?: boolean): null;
40
+ addItems<U extends CollectionResource>(itemEntries: ItemEntry[], resultResource?: U | null, updateInitial?: boolean, callOnAdd?: boolean, callOnActivate?: boolean): U['items'] | null;
41
+ private handleAddedItemCallbacks;
42
+ removeItems<U extends CollectionResource>(idArray: ItemId[], resultResource: U, updateInitial?: boolean, callOnRemove?: boolean): U['items'];
43
+ removeItems(idArray: ItemId[], resultResource?: null, updateInitial?: boolean, callOnRemove?: boolean): null;
44
+ removeItems<U extends CollectionResource>(idArray: ItemId[], resultResource?: U | null, updateInitial?: boolean, callOnRemove?: boolean): U['items'] | null;
45
+ clear<U extends CollectionResource>(resultResource: U, updateInitial?: boolean, callOnRemove?: boolean): U['items'];
46
+ clear(resultResource?: null, updateInitial?: boolean, callOnRemove?: boolean): null;
47
+ handleRemovedItems<U extends CollectionResource>(filterFunction: (itemEntry: ItemEntry) => boolean, resultResource: U, updateInitial?: boolean, callOnRemove?: boolean): U['items'];
48
+ handleRemovedItems(filterFunction: (itemEntry: ItemEntry) => boolean, resultResource?: null, updateInitial?: boolean, callOnRemove?: boolean): null;
49
+ handleRemovedItems<U extends CollectionResource>(filterFunction: (itemEntry: ItemEntry) => boolean, resultResource?: U | null, updateInitial?: boolean, callOnRemove?: boolean): U['items'] | null;
50
+ private handleRemovedItemCallbacks;
51
+ private createBatchStatus;
52
+ private expandLocal;
53
+ private expandRemote;
54
+ expand(newColumns: ApiRequestColumns, localItemCache: ItemCache): PromiseInterface<this>;
55
+ extendQuery(callback?: QueryCallback): CollectionQuery;
56
+ extend<U extends CollectionResource>(queryCallback: QueryCallback, collectionResource?: U, callOnAdd?: boolean, updateInitial?: boolean): PromiseInterface<U['items']>;
57
+ extend(queryCallback: QueryCallback, collectionResource?: null, callOnAdd?: boolean, updateInitial?: boolean): PromiseInterface<null>;
58
+ queueReload(): void;
59
+ expandColumns(columnExpansion: ColumnExpansion): void;
60
+ expandRequestColumns(requestColumns: ApiRequestColumns): void;
61
+ getAddedItems(returnItemIds: true): ItemId[];
62
+ getAddedItems(returnItemIds?: boolean): ItemEntry[];
63
+ getRemovedItems(returnItemIds: true): ItemId[];
64
+ getRemovedItems(returnItemIds?: boolean): ItemEntry[];
65
+ getUpdatedItems(): ItemEntry[];
66
+ hasAddedItems(): boolean;
67
+ hasRemovedItems(): boolean;
68
+ hasUpdatedItems(): boolean;
69
+ getCurrentResource<T extends CollectionResource>(): T;
70
+ clearResources(isSubtabChange?: boolean): void;
71
+ /**
72
+ * @description
73
+ * this doesn't revert updates
74
+ */
75
+ revertChanges(): void;
76
+ onItemsCreated(conversionMap: ConversionMap): void;
77
+ getUpdatedItemColumns(conversionMap: ItemIdConversionMap): {
78
+ [columnId: string]: ColumnInfo;
79
+ };
80
+ clone(parent: EntryParentNull, conversionMap?: ItemIdConversionMap): CollectionEntry;
81
+ }
@@ -1,12 +1,12 @@
1
- import { ApiQuery, ApiRequestColumns, ApiRequestLimit, EntryParentNull } from '../types';
2
- export declare type CollectionEntryOptionsInterface = Partial<CollectionEntryOptions>;
3
- export declare class CollectionEntryOptions {
4
- columns: ApiRequestColumns;
5
- query: ApiQuery | null;
6
- queryParams: any;
7
- parent: EntryParentNull;
8
- deferRequest: boolean;
9
- limit: ApiRequestLimit | null;
10
- entryKey: string | null;
11
- constructor(values: CollectionEntryOptionsInterface);
12
- }
1
+ import { ApiQuery, ApiRequestColumns, ApiRequestLimit, EntryParentNull } from '../types';
2
+ export declare type CollectionEntryOptionsInterface = Partial<CollectionEntryOptions>;
3
+ export declare class CollectionEntryOptions {
4
+ columns: ApiRequestColumns;
5
+ query: ApiQuery | null;
6
+ queryParams: any;
7
+ parent: EntryParentNull;
8
+ deferRequest: boolean;
9
+ limit: ApiRequestLimit | null;
10
+ entryKey: string | null;
11
+ constructor(values: CollectionEntryOptionsInterface);
12
+ }
@@ -1,40 +1,39 @@
1
- import { LocalCache } from '../classes';
2
- import { ItemResourceFactory } from '../factories';
3
- import { CollectionResourceOptions, EditResource, ItemEntry, ViewResource } from '../models';
4
- import { ItemResourceItemIdMap, PromiseInterface, QueryCallback, ResponseColumnMap } from '../types';
5
- import { CollectionEntry } from './CollectionEntry';
6
- export declare class CollectionResource<T extends ViewResource | EditResource = ViewResource> {
7
- private itemResourceFactory;
8
- entry: CollectionEntry;
9
- options: CollectionResourceOptions;
10
- localCache: LocalCache;
11
- items: T[];
12
- itemIdMap: ItemResourceItemIdMap<T>;
13
- columns: ResponseColumnMap;
14
- constructor(itemResourceFactory: ItemResourceFactory, entry: CollectionEntry, options: CollectionResourceOptions, localCache: LocalCache);
15
- getItemById(itemId: number): T;
16
- rebuildMap(): void;
17
- addItemResources(itemEntries: ItemEntry[]): T[];
18
- /**
19
- * @param itemEntries
20
- * @returns {ItemResource[]}
21
- *
22
- * Returns the Itemresources that where removed Collection.
23
- * Filters on ItemResource.entry === ItemEntry
24
- */
25
- removeItemResources(itemEntries: ItemEntry[]): T[];
26
- callOnAdd(itemResources: this['items']): void;
27
- callOnRemove(itemResources: this['items']): void;
28
- forEach(callback: (itemResource: T) => void): void;
29
- filter(callback: (itemResource: T) => boolean): T[];
30
- first(callback: (itemResource: T) => boolean): T | null;
31
- some(callback: (itemResource: T) => boolean): boolean;
32
- groupBy(argument: string | ((itemResource: T) => string | null)): {
33
- [key: string]: T[];
34
- };
35
- map<U>(argument: string | ((itemResource: T) => U)): U[];
36
- reduce<U>(callback: (itemResource: T, value: U) => U, value: U): U;
37
- extend(queryCallback: QueryCallback, returnAllItems?: boolean, callOnAdd?: boolean): PromiseInterface<this['items']>;
38
- deactivate(): void;
39
- clearResource(): void;
40
- }
1
+ import { LocalCache } from '../classes';
2
+ import { ItemResourceFactory } from '../factories';
3
+ import { CollectionEntry, CollectionResourceOptions, ItemEntry, ItemResource, LocalViewResource } from '../models';
4
+ import { ItemResourceItemIdMap, PromiseInterface, QueryCallback, ResponseColumnMap } from '../types';
5
+ export declare abstract class CollectionResource<T extends ItemResource = LocalViewResource> {
6
+ private itemResourceFactory;
7
+ entry: CollectionEntry;
8
+ options: CollectionResourceOptions;
9
+ localCache: LocalCache;
10
+ items: T[];
11
+ itemIdMap: ItemResourceItemIdMap<T>;
12
+ columns: ResponseColumnMap;
13
+ protected constructor(itemResourceFactory: ItemResourceFactory, entry: CollectionEntry, options: CollectionResourceOptions, localCache: LocalCache);
14
+ getItemById(itemId: number): T;
15
+ rebuildMap(): void;
16
+ addItemResources(itemEntries: ItemEntry[]): T[];
17
+ /**
18
+ * @param itemEntries
19
+ * @returns {ItemResource[]}
20
+ *
21
+ * Returns the Itemresources that where removed Collection.
22
+ * Filters on ItemResource.entry === ItemEntry
23
+ */
24
+ removeItemResources(itemEntries: ItemEntry[]): T[];
25
+ callOnAdd(itemResources: this['items']): void;
26
+ callOnRemove(itemResources: this['items']): void;
27
+ forEach(callback: (itemResource: T) => void): void;
28
+ filter(callback: (itemResource: T) => boolean): T[];
29
+ first(callback: (itemResource: T) => boolean): T | null;
30
+ some(callback: (itemResource: T) => boolean): boolean;
31
+ groupBy(argument: string | ((itemResource: T) => string | null)): {
32
+ [key: string]: T[];
33
+ };
34
+ map<U>(argument: string | ((itemResource: T) => U)): U[];
35
+ reduce<U>(callback: (itemResource: T, value: U) => U, value: U): U;
36
+ extend(queryCallback: QueryCallback, returnAllItems?: boolean, callOnAdd?: boolean): PromiseInterface<this['items']>;
37
+ deactivate(): void;
38
+ clearResource(): void;
39
+ }
@@ -1,23 +1,24 @@
1
- import { CollectionEntry, CollectionResource, ItemEntry, ItemResource } from '../models';
2
- import { ConversionMap, OnChangeFunction } from '../types';
3
- export declare type CollectionResourceCallback = (itemResources: ItemResource[], collectionResource: CollectionResource) => void;
4
- export declare type CollectionResourceInitialCallback = (itemEntries: ItemEntry[], collectionEntry: CollectionEntry) => void;
5
- export declare type OnItemsCreatedCallback = (conversionMap: ConversionMap) => void;
6
- export declare type CollectionResourceOptionsInterface = Partial<CollectionResourceOptions>;
7
- export declare class CollectionResourceOptions {
8
- editItems: boolean;
9
- editCollection: boolean;
10
- modInstant: boolean;
11
- enableSave: boolean;
12
- onItemsCreated: OnItemsCreatedCallback;
13
- onChange: OnChangeFunction;
14
- onAdd: CollectionResourceCallback;
15
- onRemove: CollectionResourceCallback;
16
- onAddInitial: CollectionResourceInitialCallback;
17
- onRemoveInitial: CollectionResourceInitialCallback;
18
- resourceKey: string | null;
19
- clearOnTabChange: boolean;
20
- clearOnSubTabChange: boolean;
21
- custom: any;
22
- constructor(values: CollectionResourceOptionsInterface);
23
- }
1
+ import { CollectionEntry, CollectionResource, ItemEntry, ItemResource } from '../models';
2
+ import { ConversionMap, OnChangeFunction } from '../types';
3
+ export declare type CollectionResourceCallback = (itemResources: ItemResource[], collectionResource: CollectionResource) => void;
4
+ export declare type CollectionResourceInitialCallback = (itemEntries: ItemEntry[], collectionEntry: CollectionEntry) => void;
5
+ export declare type OnItemsCreatedCallback = (conversionMap: ConversionMap) => void;
6
+ export declare type CollectionResourceOptionsInterface = Partial<CollectionResourceOptions>;
7
+ export declare class CollectionResourceOptions {
8
+ editItems: boolean;
9
+ remoteItems: boolean;
10
+ editCollection: boolean;
11
+ modInstant: boolean;
12
+ enableSave: boolean;
13
+ onItemsCreated: OnItemsCreatedCallback;
14
+ onChange: OnChangeFunction;
15
+ onAdd: CollectionResourceCallback;
16
+ onRemove: CollectionResourceCallback;
17
+ onAddInitial: CollectionResourceInitialCallback;
18
+ onRemoveInitial: CollectionResourceInitialCallback;
19
+ resourceKey: string | null;
20
+ clearOnTabChange: boolean;
21
+ clearOnSubTabChange: boolean;
22
+ custom: any;
23
+ constructor(values: CollectionResourceOptionsInterface);
24
+ }
@@ -1,6 +1,6 @@
1
- import { LocalCache } from '../classes';
2
- import { ItemResourceFactory } from '../factories';
3
- import { CollectionEntry, CollectionResource, CollectionResourceOptions, EditResource, ViewResource } from '../models';
4
- export declare class CollectionViewResource<T extends EditResource | ViewResource = ViewResource> extends CollectionResource<T> {
5
- constructor(itemResourceFactory: ItemResourceFactory, collectionEntry: CollectionEntry, options: CollectionResourceOptions, localCache: LocalCache);
6
- }
1
+ import { LocalCache } from '../classes';
2
+ import { ItemResourceFactory } from '../factories';
3
+ import { CollectionEntry, CollectionResource, CollectionResourceOptions, ItemResource, LocalViewResource } from '../models';
4
+ export declare class CollectionViewResource<T extends ItemResource = LocalViewResource> extends CollectionResource<T> {
5
+ constructor(itemResourceFactory: ItemResourceFactory, collectionEntry: CollectionEntry, options: CollectionResourceOptions, localCache: LocalCache);
6
+ }
@@ -1,18 +1,18 @@
1
- import { ItemResourceFactory } from '../factories';
2
- import { ItemEntry, ItemResource, ItemResourceOptions } from '../models';
3
- import { FieldMap, PromiseInterface } from '../types';
4
- export declare class EditResource extends ItemResource {
5
- private factory;
6
- localCopies: FieldMap[];
7
- transactions: number;
8
- constructor(factory: ItemResourceFactory, entry: ItemEntry, options: ItemResourceOptions, isNew?: boolean);
9
- isNew(): boolean;
10
- start(): this;
11
- rollback(): this;
12
- commit(callOnChange?: boolean): this;
13
- getLocalCopy(): FieldMap | null;
14
- copyFields(destination?: FieldMap): FieldMap;
15
- setFields(values: FieldMap, callOnChange?: boolean): this;
16
- callOnChange(previous?: FieldMap): this;
17
- save(parameters?: any): PromiseInterface<this>;
18
- }
1
+ import { ItemResourceFactory } from '../factories';
2
+ import { ItemEntry, ItemResource, ItemResourceOptions } from '../models';
3
+ import { FieldMap, PromiseInterface } from '../types';
4
+ export declare class EditResource extends ItemResource {
5
+ private factory;
6
+ localCopies: FieldMap[];
7
+ transactions: number;
8
+ constructor(factory: ItemResourceFactory, entry: ItemEntry, options: ItemResourceOptions, isNew?: boolean);
9
+ isNew(): boolean;
10
+ start(): this;
11
+ rollback(): this;
12
+ commit(callOnChange?: boolean): this;
13
+ getLocalCopy(): FieldMap | null;
14
+ copyFields(destination?: FieldMap): FieldMap;
15
+ setFields(values: FieldMap, callOnChange?: boolean): this;
16
+ callOnChange(previous?: FieldMap): this;
17
+ save(parameters?: any): PromiseInterface<this>;
18
+ }
@@ -1,73 +1,73 @@
1
- import { ColumnSet } from '../classes';
2
- import { ItemEntryFactory } from '../factories';
3
- import { ItemResource } from '../models';
4
- import { ColumnExpansionResult, EntryParentNull, FieldMap, ItemError, ItemId, ItemIdConversionMap, ItemType, PromiseInterface } from '../types';
5
- import { Deferred } from '../interfaces';
6
- export declare class ItemEntry {
7
- private factory;
8
- itemType: string;
9
- itemId: ItemId;
10
- columns: ColumnSet;
11
- id: number;
12
- reloadQueued: boolean;
13
- deferRequest: boolean;
14
- deferred?: Deferred<this>;
15
- parent: EntryParentNull;
16
- initial: FieldMap;
17
- modified: FieldMap;
18
- derived: FieldMap;
19
- resources: ItemResource[];
20
- constructor(factory: ItemEntryFactory, itemType: string, itemId: ItemId, columns: ColumnSet);
21
- queueReload(): this;
22
- defer(deferRequest?: boolean): this;
23
- getPromise(): PromiseInterface<this>;
24
- resolve(): this;
25
- resolveDeferred(initial: FieldMap, derived: FieldMap, columns: ColumnSet): this;
26
- isDeferred(): boolean;
27
- reject(error?: ItemError): this;
28
- setFields(initial: FieldMap, derived: FieldMap): this;
29
- setLocalFields(initialValues: FieldMap, conversionMap: ItemIdConversionMap, columns?: ColumnSet): this;
30
- clone(conversionMap?: ItemIdConversionMap): ItemEntry;
31
- resetDerived(columnIds: string[]): this;
32
- clearResources(): this;
33
- deactivateResources(): this;
34
- getFields(): FieldMap;
35
- expand(main: FieldMap, derived: FieldMap, columnExpansionResult: ColumnExpansionResult): this;
36
- expandLocal(columnExpansionResult: ColumnExpansionResult): this;
37
- private setLocalValues;
38
- /**
39
- * This function assumes the initial, modified, derived properties are already set. It will update the values
40
- * themselves to preserve references in existing item resources.
41
- */
42
- updateFields(fields: FieldMap, derived?: FieldMap | null, overwrite?: boolean): this;
43
- private updateItemValues;
44
- updateItemFields(conversionMap: ItemIdConversionMap, columns?: ColumnSet): this;
45
- formatRequest(): FieldMap;
46
- setDisplayName(): this;
47
- getDisplayName(): string;
48
- /**
49
- * @param {Boolean} returnAll Returns all initial values if true
50
- * @returns {Object}
51
- */
52
- getChanges(returnAll?: boolean): FieldMap;
53
- isLocal(): boolean;
54
- isLockable(): boolean;
55
- hasChanges(): boolean;
56
- resetModified(): this;
57
- setInitial(values: FieldMap, enableCallbacks?: boolean): this;
58
- /**
59
- * Does a shallow copy of values!
60
- */
61
- setModified(values?: FieldMap): this;
62
- setDerived(values: FieldMap): this;
63
- setParent(parentType: ItemType, parentId: ItemId): this;
64
- callOnChange(previous?: FieldMap): this;
65
- toJSON(): {
66
- id: number;
67
- parent: EntryParentNull;
68
- initial: FieldMap;
69
- modified: FieldMap;
70
- derived: FieldMap;
71
- columns: ColumnSet;
72
- };
73
- }
1
+ import { ColumnSet } from '../classes';
2
+ import { ItemEntryFactory } from '../factories';
3
+ import { ItemResource } from '../models';
4
+ import { ColumnExpansionResult, EntryParentNull, FieldMap, ItemError, ItemId, ItemIdConversionMap, ItemType, PromiseInterface } from '../types';
5
+ import { Deferred } from '../interfaces';
6
+ export declare class ItemEntry {
7
+ private factory;
8
+ itemType: string;
9
+ itemId: ItemId;
10
+ columns: ColumnSet;
11
+ id: number;
12
+ reloadQueued: boolean;
13
+ deferRequest: boolean;
14
+ deferred?: Deferred<this>;
15
+ parent: EntryParentNull;
16
+ initial: FieldMap;
17
+ modified: FieldMap;
18
+ derived: FieldMap;
19
+ resources: ItemResource[];
20
+ constructor(factory: ItemEntryFactory, itemType: string, itemId: ItemId, columns: ColumnSet);
21
+ queueReload(): this;
22
+ defer(deferRequest?: boolean): this;
23
+ getPromise(): PromiseInterface<this>;
24
+ resolve(): this;
25
+ resolveDeferred(initial: FieldMap, derived: FieldMap, columns: ColumnSet): this;
26
+ isDeferred(): boolean;
27
+ reject(error?: ItemError): this;
28
+ setFields(initial: FieldMap, derived: FieldMap): this;
29
+ setLocalFields(initialValues: FieldMap, conversionMap: ItemIdConversionMap, columns?: ColumnSet): this;
30
+ clone(conversionMap?: ItemIdConversionMap): ItemEntry;
31
+ resetDerived(columnIds: string[]): this;
32
+ clearResources(): this;
33
+ deactivateResources(): this;
34
+ getFields(): FieldMap;
35
+ expand(main: FieldMap, derived: FieldMap, columnExpansionResult: ColumnExpansionResult): this;
36
+ expandLocal(columnExpansionResult: ColumnExpansionResult): this;
37
+ private setLocalValues;
38
+ /**
39
+ * This function assumes the initial, modified, derived properties are already set. It will update the values
40
+ * themselves to preserve references in existing item resources.
41
+ */
42
+ updateFields(fields: FieldMap, derived?: FieldMap | null, overwrite?: boolean): this;
43
+ private updateItemValues;
44
+ updateItemFields(conversionMap: ItemIdConversionMap, columns?: ColumnSet): this;
45
+ formatRequest(): FieldMap;
46
+ setDisplayName(): this;
47
+ getDisplayName(): string;
48
+ /**
49
+ * @param {Boolean} returnAll Returns all initial values if true
50
+ * @returns {Object}
51
+ */
52
+ getChanges(returnAll?: boolean): FieldMap;
53
+ isLocal(): boolean;
54
+ isLockable(): boolean;
55
+ hasChanges(): boolean;
56
+ resetModified(): this;
57
+ setInitial(values: FieldMap, enableCallbacks?: boolean): this;
58
+ /**
59
+ * Does a shallow copy of values!
60
+ */
61
+ setModified(values?: FieldMap): this;
62
+ setDerived(values: FieldMap): this;
63
+ setParent(parentType: ItemType, parentId: ItemId): this;
64
+ callOnChange(previous?: FieldMap): this;
65
+ toJSON(): {
66
+ id: number;
67
+ parent: EntryParentNull;
68
+ initial: FieldMap;
69
+ modified: FieldMap;
70
+ derived: FieldMap;
71
+ columns: ColumnSet;
72
+ };
73
+ }
@@ -1,11 +1,11 @@
1
- import { ApiRequestColumnMap, ApiRequestColumns, EntryParentNull } from '../types';
2
- export declare type ItemEntryOptionsInterface = Partial<ItemEntryOptions>;
3
- export declare class ItemEntryOptions {
4
- columns: ApiRequestColumns;
5
- parent: EntryParentNull;
6
- templateOptions: any;
7
- templateColumns: ApiRequestColumnMap;
8
- deferRequest: boolean;
9
- isDuplicate: boolean;
10
- constructor(values: ItemEntryOptionsInterface);
11
- }
1
+ import { ApiRequestColumnMap, ApiRequestColumns, EntryParentNull } from '../types';
2
+ export declare type ItemEntryOptionsInterface = Partial<ItemEntryOptions>;
3
+ export declare class ItemEntryOptions {
4
+ columns: ApiRequestColumns;
5
+ parent: EntryParentNull;
6
+ templateOptions: any;
7
+ templateColumns: ApiRequestColumnMap;
8
+ deferRequest: boolean;
9
+ isDuplicate: boolean;
10
+ constructor(values: ItemEntryOptionsInterface);
11
+ }
@@ -1,23 +1,23 @@
1
- import { ItemEntry, ItemResourceOptions } from '../models';
2
- import { FieldMap, ResponseColumn } from '../types';
3
- export declare class ItemResource {
4
- entry: ItemEntry;
5
- options: ItemResourceOptions;
6
- protected readonly _isNew: boolean;
7
- columns: {
8
- [columnId: string]: ResponseColumn;
9
- };
10
- fields: FieldMap;
11
- derived: FieldMap;
12
- constructor(entry: ItemEntry, options: ItemResourceOptions, _isNew?: boolean);
13
- isNew(): boolean;
14
- isLocal(): boolean;
15
- clearResource(): void;
16
- deactivate(): void;
17
- toJSON(): {
18
- columns: string[];
19
- fields: FieldMap;
20
- derived: FieldMap;
21
- entry: ItemEntry;
22
- };
23
- }
1
+ import { ItemEntry, ItemResourceOptions } from '../models';
2
+ import { FieldMap, ResponseColumn } from '../types';
3
+ export declare abstract class ItemResource {
4
+ entry: ItemEntry;
5
+ options: ItemResourceOptions;
6
+ protected readonly _isNew: boolean;
7
+ columns: {
8
+ [columnId: string]: ResponseColumn;
9
+ };
10
+ fields: FieldMap;
11
+ derived: FieldMap;
12
+ protected constructor(entry: ItemEntry, options: ItemResourceOptions, _isNew?: boolean);
13
+ isNew(): boolean;
14
+ isLocal(): boolean;
15
+ clearResource(): void;
16
+ deactivate(): void;
17
+ toJSON(): {
18
+ columns: string[];
19
+ fields: FieldMap;
20
+ derived: FieldMap;
21
+ entry: ItemEntry;
22
+ };
23
+ }
@@ -1,9 +1,10 @@
1
- import { ItemEntry } from '../models';
2
- import { OnChangeFunction } from '../types';
3
- export declare type ItemResourceOptionsInterface = Partial<ItemResourceOptions>;
4
- export declare class ItemResourceOptions {
5
- edit: boolean;
6
- onChange: OnChangeFunction;
7
- onDeactivate: (itemEntry: ItemEntry) => void;
8
- constructor(values: ItemResourceOptionsInterface);
9
- }
1
+ import { ItemEntry } from '../models';
2
+ import { OnChangeFunction } from '../types';
3
+ export declare type ItemResourceOptionsInterface = Partial<ItemResourceOptions>;
4
+ export declare class ItemResourceOptions {
5
+ edit: boolean;
6
+ remote: boolean;
7
+ onChange: OnChangeFunction;
8
+ onDeactivate: (itemEntry: ItemEntry) => void;
9
+ constructor(values: ItemResourceOptionsInterface);
10
+ }
@@ -0,0 +1,4 @@
1
+ import { ItemEntry, ItemResourceOptions, ViewResource } from '../models';
2
+ export declare class LocalViewResource extends ViewResource {
3
+ constructor(entry: ItemEntry, options: ItemResourceOptions, isNew?: boolean);
4
+ }
@@ -0,0 +1,4 @@
1
+ import { ItemEntry, ItemResourceOptions, ViewResource } from '../models';
2
+ export declare class RemoteViewResource extends ViewResource {
3
+ constructor(entry: ItemEntry, options: ItemResourceOptions, isNew?: boolean);
4
+ }