@rentman/rm-core 1.0.22 → 1.0.24

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 (34) hide show
  1. package/changelog.md +33 -0
  2. package/dist/definitions/src/classes/ApiRequestService.d.ts +9 -9
  3. package/dist/definitions/src/classes/BatchStatus.d.ts +3 -3
  4. package/dist/definitions/src/classes/ChangesProcessor.d.ts +3 -3
  5. package/dist/definitions/src/classes/CollectionHandler.d.ts +8 -8
  6. package/dist/definitions/src/classes/ColumnHandler.d.ts +5 -5
  7. package/dist/definitions/src/classes/ItemAdministrator.d.ts +23 -46
  8. package/dist/definitions/src/classes/ItemEntryService.d.ts +2 -2
  9. package/dist/definitions/src/classes/ItemHandler.d.ts +9 -9
  10. package/dist/definitions/src/classes/ItemRequestService.d.ts +7 -7
  11. package/dist/definitions/src/classes/{ResourceCache.d.ts → LocalCache.d.ts} +6 -9
  12. package/dist/definitions/src/classes/LockService.d.ts +2 -2
  13. package/dist/definitions/src/classes/SocketMessageHandler.d.ts +9 -9
  14. package/dist/definitions/src/factories/BatchStatusFactory.d.ts +2 -2
  15. package/dist/definitions/src/factories/ChangesProcessorFactory.d.ts +2 -2
  16. package/dist/definitions/src/factories/CollectionEntryFactory.d.ts +2 -2
  17. package/dist/definitions/src/factories/CollectionResourceFactory.d.ts +2 -2
  18. package/dist/definitions/src/factories/ItemResourceFactory.d.ts +2 -2
  19. package/dist/definitions/src/factories/{ResourceCacheFactory.d.ts → LocalCacheFactory.d.ts} +5 -5
  20. package/dist/definitions/src/index.d.ts +5 -7
  21. package/dist/definitions/src/interfaces/ApiRequestServiceInterface.d.ts +8 -8
  22. package/dist/definitions/src/interfaces/LocalCacheManagerInterface.d.ts +6 -0
  23. package/dist/definitions/src/interfaces/PromiseInterface.d.ts +11 -0
  24. package/dist/definitions/src/models/CollectionEditResource.d.ts +5 -5
  25. package/dist/definitions/src/models/CollectionEntry.d.ts +3 -3
  26. package/dist/definitions/src/models/CollectionResource.d.ts +1 -1
  27. package/dist/definitions/src/models/CollectionViewResource.d.ts +2 -2
  28. package/dist/definitions/src/models/EditResource.d.ts +4 -4
  29. package/dist/definitions/src/models/ItemEntry.d.ts +1 -1
  30. package/dist/rm-core.js +369 -3022
  31. package/package.json +1 -2
  32. package/readme.md +12 -4
  33. package/dist/definitions/src/classes/PromiseService.d.ts +0 -9
  34. package/dist/definitions/src/interfaces/ResourceCacheInterface.d.ts +0 -6
@@ -2,9 +2,9 @@ import CollectionEntryService from "../classes/CollectionEntryService";
2
2
  import ItemEntryService from '../classes/ItemEntryService';
3
3
  import ItemRequestService from "../classes/ItemRequestService";
4
4
  import KeyService from '../classes/KeyService';
5
- import PromiseService from '../classes/PromiseService';
6
5
  import QueryService from '../classes/QueryService';
7
6
  import ErrorHandlerInterface from '../interfaces/ErrorHandlerInterface';
7
+ import PromiseInterface from '../interfaces/PromiseInterface';
8
8
  import CollectionEntry from "../models/CollectionEntry";
9
9
  export default class CollectionEntryFactory {
10
10
  private errorHandler;
@@ -14,6 +14,6 @@ export default class CollectionEntryFactory {
14
14
  private keyService;
15
15
  private queryService;
16
16
  private promiseService;
17
- constructor(errorHandler: ErrorHandlerInterface, collectionEntryService: CollectionEntryService, itemRequestService: ItemRequestService, itemEntryService: ItemEntryService, keyService: KeyService, queryService: QueryService, promiseService: PromiseService);
17
+ constructor(errorHandler: ErrorHandlerInterface, collectionEntryService: CollectionEntryService, itemRequestService: ItemRequestService, itemEntryService: ItemEntryService, keyService: KeyService, queryService: QueryService, promiseService: PromiseInterface);
18
18
  construct(itemType: string, options: any): CollectionEntry;
19
19
  }
@@ -1,8 +1,8 @@
1
1
  import CollectionResourceService from '../classes/CollectionResourceService';
2
2
  import ItemHandler from "../classes/ItemHandler";
3
3
  import KeyService from '../classes/KeyService';
4
- import PromiseService from '../classes/PromiseService';
5
4
  import ErrorHandlerInterface from '../interfaces/ErrorHandlerInterface';
5
+ import PromiseInterface from '../interfaces/PromiseInterface';
6
6
  import CollectionEntry from "../models/CollectionEntry";
7
7
  import CollectionResource from "../models/CollectionResource";
8
8
  import ChangesProcessorFactory from './ChangesProcessorFactory';
@@ -15,6 +15,6 @@ export default class CollectionResourceFactory {
15
15
  private keyService;
16
16
  private promiseService;
17
17
  private collectionResourceService;
18
- constructor(errorHandler: ErrorHandlerInterface, itemHandler: ItemHandler, itemResourceFactory: ItemResourceFactory, changesProcessorFactory: ChangesProcessorFactory, keyService: KeyService, promiseService: PromiseService, collectionResourceService: CollectionResourceService);
18
+ constructor(errorHandler: ErrorHandlerInterface, itemHandler: ItemHandler, itemResourceFactory: ItemResourceFactory, changesProcessorFactory: ChangesProcessorFactory, keyService: KeyService, promiseService: PromiseInterface, collectionResourceService: CollectionResourceService);
19
19
  construct(collectionEntry: CollectionEntry, options: any): CollectionResource;
20
20
  }
@@ -4,8 +4,8 @@ import CollectionHandler from '../classes/CollectionHandler';
4
4
  import ItemEntryService from '../classes/ItemEntryService';
5
5
  import ItemResourceService from "../classes/ItemResourceService";
6
6
  import LockService from '../classes/LockService';
7
- import PromiseService from '../classes/PromiseService';
8
7
  import ErrorHandlerInterface from '../interfaces/ErrorHandlerInterface';
8
+ import PromiseInterface from '../interfaces/PromiseInterface';
9
9
  import { EditResource } from "../models/EditResource";
10
10
  import ItemEntry from "../models/ItemEntry";
11
11
  import ItemResource from "../models/ItemResource";
@@ -19,7 +19,7 @@ export default class ItemResourceFactory {
19
19
  private collectionHandler;
20
20
  private errorHandler;
21
21
  private promiseService;
22
- constructor(itemEntryService: ItemEntryService, itemResourceService: ItemResourceService, apiFormatter: ApiFormatter, lockService: LockService, changesProcessor: ChangesProcessor, collectionHandler: CollectionHandler, errorHandler: ErrorHandlerInterface, promiseService: PromiseService);
22
+ constructor(itemEntryService: ItemEntryService, itemResourceService: ItemResourceService, apiFormatter: ApiFormatter, lockService: LockService, changesProcessor: ChangesProcessor, collectionHandler: CollectionHandler, errorHandler: ErrorHandlerInterface, promiseService: PromiseInterface);
23
23
  getConstructor(options: any): (itemEntry: any) => EditResource | ViewResource;
24
24
  construct(itemEntry: ItemEntry, options: any): ItemResource;
25
25
  }
@@ -4,16 +4,16 @@ import ItemEntryService from '../classes/ItemEntryService';
4
4
  import ItemHandler from "../classes/ItemHandler";
5
5
  import ItemResourceService from '../classes/ItemResourceService';
6
6
  import LockService from "../classes/LockService";
7
- import PromiseService from '../classes/PromiseService';
8
- import ResourceCache from "../classes/ResourceCache";
7
+ import LocalCache from "../classes/LocalCache";
9
8
  import ApiRequestServiceInterface from '../interfaces/ApiRequestServiceInterface';
10
9
  import ErrorHandlerInterface from '../interfaces/ErrorHandlerInterface';
10
+ import PromiseInterface from '../interfaces/PromiseInterface';
11
11
  import ChangesProcessorFactory from "./ChangesProcessorFactory";
12
12
  import CollectionCacheFactory from "./CollectionCacheFactory";
13
13
  import CollectionResourceFactory from "./CollectionResourceFactory";
14
14
  import ItemCacheFactory from "./ItemCacheFactory";
15
15
  import ItemResourceFactory from "./ItemResourceFactory";
16
- export default class ResourceCacheFactory {
16
+ export default class LocalCacheFactory {
17
17
  private apiRequestService;
18
18
  private errorHandler;
19
19
  private itemHandler;
@@ -28,6 +28,6 @@ export default class ResourceCacheFactory {
28
28
  private itemEntryService;
29
29
  private itemResourceService;
30
30
  private promiseService;
31
- constructor(apiRequestService: ApiRequestServiceInterface, errorHandler: ErrorHandlerInterface, itemHandler: ItemHandler, collectionHandler: CollectionHandler, columnHandler: ColumnHandler, lockService: LockService, itemResourceFactory: ItemResourceFactory, collectionCacheFactory: CollectionCacheFactory, changesProcessorFactory: ChangesProcessorFactory, itemCacheFactory: ItemCacheFactory, collectionResourceFactory: CollectionResourceFactory, itemEntryService: ItemEntryService, itemResourceService: ItemResourceService, promiseService: PromiseService);
32
- construct(): ResourceCache;
31
+ constructor(apiRequestService: ApiRequestServiceInterface, errorHandler: ErrorHandlerInterface, itemHandler: ItemHandler, collectionHandler: CollectionHandler, columnHandler: ColumnHandler, lockService: LockService, itemResourceFactory: ItemResourceFactory, collectionCacheFactory: CollectionCacheFactory, changesProcessorFactory: ChangesProcessorFactory, itemCacheFactory: ItemCacheFactory, collectionResourceFactory: CollectionResourceFactory, itemEntryService: ItemEntryService, itemResourceService: ItemResourceService, promiseService: PromiseInterface);
32
+ construct(): LocalCache;
33
33
  }
@@ -13,7 +13,6 @@ import ItemRequestService from "./classes/ItemRequestService";
13
13
  import ItemResourceService from './classes/ItemResourceService';
14
14
  import KeyService from './classes/KeyService';
15
15
  import LockService from "./classes/LockService";
16
- import PromiseService from './classes/PromiseService';
17
16
  import QueryService from './classes/QueryService';
18
17
  import SocketMessageHandler from './classes/SocketMessageHandler';
19
18
  import ApiResponseProcessorFactory from './factories/ApiResponseProcessorFactory';
@@ -33,14 +32,14 @@ import ModuleChangesCompilerFactory from "./factories/ModuleChangesCompilerFacto
33
32
  import QueryMatcherFactory from "./factories/QueryMatcherFactory";
34
33
  import QueryParserFactory from "./factories/QueryParserFactory";
35
34
  import RequestColumnExpansionFactory from "./factories/RequestColumnExpansionFactory";
36
- import ResourceCacheFactory from "./factories/ResourceCacheFactory";
35
+ import LocalCacheFactory from "./factories/LocalCacheFactory";
37
36
  import ApiRequestServiceInterface from './interfaces/ApiRequestServiceInterface';
38
37
  import AuthInterface from './interfaces/AuthInterface';
39
38
  import ErrorHandlerInterface from './interfaces/ErrorHandlerInterface';
40
- import ResourceCacheInterface from './interfaces/ResourceCacheInterface';
39
+ import LocalCacheManagerInterface from './interfaces/LocalCacheManagerInterface';
40
+ import PromiseInterface from './interfaces/PromiseInterface';
41
41
  export default class RmCore {
42
42
  version: string;
43
- promiseService: PromiseService;
44
43
  apiFormatter: ApiFormatter;
45
44
  keyService: KeyService;
46
45
  queryService: QueryService;
@@ -70,14 +69,13 @@ export default class RmCore {
70
69
  columnSetFactory: ColumnSetFactory;
71
70
  createRequestFactory: CreateRequestFactory;
72
71
  itemResourceFactory: ItemResourceFactory;
73
- resourceCacheFactory: ResourceCacheFactory;
72
+ localCacheFactory: LocalCacheFactory;
74
73
  moduleChangesCompilerFactory: ModuleChangesCompilerFactory;
75
74
  queryParserFactory: QueryParserFactory;
76
75
  batchStatusFactory: BatchStatusFactory;
77
76
  socketMessageHandler: SocketMessageHandler;
78
77
  apiRequestService: ApiRequestService;
79
- destroy: () => void;
80
- constructor(externalApiRequestService: ApiRequestServiceInterface, resourceCacheInterface: ResourceCacheInterface, authInterface: AuthInterface, errorHandlerInterface: ErrorHandlerInterface);
78
+ constructor(externalApiRequestService: ApiRequestServiceInterface, localCacheManager: LocalCacheManagerInterface, authInterface: AuthInterface, errorHandlerInterface: ErrorHandlerInterface, promiseInterface: PromiseInterface);
81
79
  }
82
80
  export declare function noop(): void;
83
81
  export declare function identity(value: any): any;
@@ -1,10 +1,10 @@
1
1
  export default interface ApiRequestServiceInterface {
2
- template(itemType: string, params: any): PromiseLike<any>;
3
- create(itemType: string, itemId: number, values: any, parentType?: string, parentId?: number): PromiseLike<any>;
4
- delete(itemType: string, itemIds: number[]): PromiseLike<any>;
5
- updateItems(itemType: string, items: object, columns: any): PromiseLike<any>;
6
- requestSkeleton(params: any, requestCanceler?: PromiseLike<any>): PromiseLike<any>;
7
- moveItems(parentType: string, parentId: number, items: object): PromiseLike<any>;
8
- columns(itemType: string, columns: object, params?: any): PromiseLike<any>;
9
- query(itemType: string, query: object, columns: object, allLinks?: boolean, limit?: object): PromiseLike<any>;
2
+ template(itemType: string, params: any): Promise<any>;
3
+ create(itemType: string, itemId: number, values: any, parentType?: string, parentId?: number): Promise<any>;
4
+ delete(itemType: string, itemIds: number[]): Promise<any>;
5
+ updateItems(itemType: string, items: object, columns: any): Promise<any>;
6
+ requestSkeleton(params: any, requestCanceler?: Promise<any>): Promise<any>;
7
+ moveItems(parentType: string, parentId: number, items: object): Promise<any>;
8
+ columns(itemType: string, columns: object, params?: any): Promise<any>;
9
+ query(itemType: string, query: object, columns: object, allLinks?: boolean, limit?: object): Promise<any>;
10
10
  }
@@ -0,0 +1,6 @@
1
+ import LocalCache from '../classes/LocalCache';
2
+ export default interface LocalCacheManagerInterface {
3
+ updateTabParams(conversionMap: any, keepTabHeading: boolean): Promise<any>;
4
+ getCacheManager(userId: string): LocalCache;
5
+ setCacheManager(userId: string, entry: LocalCache): any;
6
+ }
@@ -0,0 +1,11 @@
1
+ export default interface PromiseInterface {
2
+ all(iterable: Array<Promise<any> | any> | {
3
+ key: Promise<any> | any;
4
+ }): Promise<any>;
5
+ when(value?: any): Promise<any>;
6
+ reject(value?: any): Promise<any>;
7
+ defer(): {
8
+ (value?): any;
9
+ (value?): any;
10
+ };
11
+ }
@@ -1,9 +1,9 @@
1
1
  import ItemHandler from "../classes/ItemHandler";
2
2
  import KeyService from "../classes/KeyService";
3
- import PromiseService from "../classes/PromiseService";
4
3
  import ChangesProcessorFactory from '../factories/ChangesProcessorFactory';
5
4
  import ItemResourceFactory from "../factories/ItemResourceFactory";
6
5
  import ErrorHandlerInterface from '../interfaces/ErrorHandlerInterface';
6
+ import PromiseInterface from '../interfaces/PromiseInterface';
7
7
  import CollectionEntry from "./CollectionEntry";
8
8
  import CollectionResource from "./CollectionResource";
9
9
  export default class CollectionEditResource extends CollectionResource {
@@ -12,11 +12,11 @@ export default class CollectionEditResource extends CollectionResource {
12
12
  private changesProcessorFactory;
13
13
  private keyService;
14
14
  private promiseService;
15
- constructor(errorHandler: ErrorHandlerInterface, itemHandler: ItemHandler, itemResourceFactory: ItemResourceFactory, changesProcessorFactory: ChangesProcessorFactory, keyService: KeyService, promiseService: PromiseService, collectionEntry: CollectionEntry, options: any);
16
- save(): any;
15
+ constructor(errorHandler: ErrorHandlerInterface, itemHandler: ItemHandler, itemResourceFactory: ItemResourceFactory, changesProcessorFactory: ChangesProcessorFactory, keyService: KeyService, promiseService: PromiseInterface, collectionEntry: CollectionEntry, options: any);
16
+ save(): Promise<any>;
17
17
  moveItems(idArray: any, destination: any, enableCallbacks: any): any;
18
- removeItems(idArray: any, enableCallbacks: any): any;
19
- removeItem(itemId: any, enableCallbacks: any): any;
18
+ removeItems(idArray: any, enableCallbacks: any): Promise<any>;
19
+ removeItem(itemId: any, enableCallbacks: any): Promise<any>;
20
20
  addItems(valuesArray: any, enableCallbacks?: boolean): Promise<any>;
21
21
  addItem(values: any, enableCallbacks: any): Promise<any>;
22
22
  clear(enableCallbacks: any): any;
@@ -2,9 +2,9 @@ import CollectionEntryService from "../classes/CollectionEntryService";
2
2
  import ItemEntryService from "../classes/ItemEntryService";
3
3
  import ItemRequestService from "../classes/ItemRequestService";
4
4
  import KeyService from "../classes/KeyService";
5
- import PromiseService from "../classes/PromiseService";
6
5
  import QueryService from "../classes/QueryService";
7
6
  import ErrorHandlerInterface from '../interfaces/ErrorHandlerInterface';
7
+ import PromiseInterface from '../interfaces/PromiseInterface';
8
8
  import CollectionResource from "./CollectionResource";
9
9
  import ItemEntry from "./ItemEntry";
10
10
  import ItemResource from './ItemResource';
@@ -31,7 +31,7 @@ export default class CollectionEntry {
31
31
  deferred: any;
32
32
  promise: any;
33
33
  reloadQueued: boolean;
34
- constructor(errorHandler: ErrorHandlerInterface, collectionEntryService: CollectionEntryService, itemRequestService: ItemRequestService, itemEntryService: ItemEntryService, keyService: KeyService, queryService: QueryService, promiseService: PromiseService, itemType: string, options: any);
34
+ constructor(errorHandler: ErrorHandlerInterface, collectionEntryService: CollectionEntryService, itemRequestService: ItemRequestService, itemEntryService: ItemEntryService, keyService: KeyService, queryService: QueryService, promiseService: PromiseInterface, itemType: string, options: any);
35
35
  isDeferred(): boolean;
36
36
  resolve(itemEntryResource: any): CollectionEntry;
37
37
  isLocal(): boolean;
@@ -45,7 +45,7 @@ export default class CollectionEntry {
45
45
  handleRemovedItems(filterFunction: any, resultResource: any, updateInitial: any, enableCallback?: boolean): any;
46
46
  expand(newColumns: any): any;
47
47
  extendQuery(callback: any): any;
48
- extend(queryCallback: any, collectionResource: any, enableCallback?: any, updateInitial?: any): PromiseLike<any>;
48
+ extend(queryCallback: any, collectionResource: any, enableCallback?: any, updateInitial?: any): Promise<any>;
49
49
  queueReload(): void;
50
50
  updateColumns(columnExpansion: any): void;
51
51
  getAddedItems(returnItemIds?: boolean): any[];
@@ -31,7 +31,7 @@ export default class CollectionResource {
31
31
  groupBy(argument: any): {};
32
32
  map(argument: any): any[];
33
33
  reduce<T>(callback: (itemResource: ItemResource, value: T) => T, value: T): T;
34
- extend(queryCallback: any, returnAllItems: any, enableCallbacks: any): PromiseLike<ItemResource[]>;
34
+ extend(queryCallback: any, returnAllItems: any, enableCallbacks: any): Promise<ItemResource[]>;
35
35
  deactivate(): void;
36
36
  clearResource(): void;
37
37
  }
@@ -1,9 +1,9 @@
1
1
  import ItemHandler from "../classes/ItemHandler";
2
2
  import KeyService from '../classes/KeyService';
3
- import PromiseService from '../classes/PromiseService';
4
3
  import ChangesProcessorFactory from '../factories/ChangesProcessorFactory';
5
4
  import ItemResourceFactory from "../factories/ItemResourceFactory";
6
5
  import ErrorHandlerInterface from '../interfaces/ErrorHandlerInterface';
6
+ import PromiseInterface from '../interfaces/PromiseInterface';
7
7
  import CollectionEntry from "./CollectionEntry";
8
8
  import CollectionResource from "./CollectionResource";
9
9
  export default class CollectionViewResource extends CollectionResource {
@@ -12,5 +12,5 @@ export default class CollectionViewResource extends CollectionResource {
12
12
  private changesProcessorFactory;
13
13
  private keyService;
14
14
  private promiseService;
15
- constructor(errorHandler: ErrorHandlerInterface, itemHandler: ItemHandler, itemResourceFactory: ItemResourceFactory, changesProcessorFactory: ChangesProcessorFactory, keyService: KeyService, promiseService: PromiseService, collectionEntry: CollectionEntry, options: any);
15
+ constructor(errorHandler: ErrorHandlerInterface, itemHandler: ItemHandler, itemResourceFactory: ItemResourceFactory, changesProcessorFactory: ChangesProcessorFactory, keyService: KeyService, promiseService: PromiseInterface, collectionEntry: CollectionEntry, options: any);
16
16
  }
@@ -3,8 +3,8 @@ import ChangesProcessor from '../classes/ChangesProcessor';
3
3
  import CollectionHandler from '../classes/CollectionHandler';
4
4
  import ItemEntryService from "../classes/ItemEntryService";
5
5
  import LockService from '../classes/LockService';
6
- import PromiseService from '../classes/PromiseService';
7
6
  import ErrorHandlerInterface from '../interfaces/ErrorHandlerInterface';
7
+ import PromiseInterface from '../interfaces/PromiseInterface';
8
8
  import ItemEntry from "./ItemEntry";
9
9
  import ItemResource from "./ItemResource";
10
10
  export declare class EditResource extends ItemResource {
@@ -17,8 +17,8 @@ export declare class EditResource extends ItemResource {
17
17
  localCopies: any[];
18
18
  transactions: number;
19
19
  hasChanges: boolean;
20
- constructor(itemEntryService: ItemEntryService, entry: ItemEntry, options: any, apiFormatter: ApiFormatter, lockService: LockService, changesProcessor: ChangesProcessor, collectionHandler: CollectionHandler, errorHandler: ErrorHandlerInterface, promiseService: PromiseService);
21
- startTransaction(): void;
20
+ constructor(itemEntryService: ItemEntryService, entry: ItemEntry, options: any, apiFormatter: ApiFormatter, lockService: LockService, changesProcessor: ChangesProcessor, collectionHandler: CollectionHandler, errorHandler: ErrorHandlerInterface, promiseService: PromiseInterface);
21
+ start(): void;
22
22
  rollback(): void;
23
23
  commit(initial: any): void;
24
24
  getLocalCopy(): any;
@@ -26,5 +26,5 @@ export declare class EditResource extends ItemResource {
26
26
  setFields(values: any, callOnChange: any): this;
27
27
  callOnChange(previous: any): void;
28
28
  save(parameters?: any): any;
29
- saveLocal(): any;
29
+ saveLocal(): Promise<any>;
30
30
  }
@@ -6,7 +6,7 @@ export default class ItemEntry {
6
6
  initial: {};
7
7
  derived: {};
8
8
  resources: ItemResource[];
9
- entryId: number;
9
+ id: number;
10
10
  modified: any;
11
11
  parent: null | {
12
12
  itemType: string;