@rentman/rm-core 6.2.5 → 6.3.1

package/dist/types/types/ItemTypesCollection.d.ts

@@ -1,263 +1,262 @@
-import { ApiResponseProcessor, ColumnSet, RequestColumnExpansion } from '../classes';
-import { CollectionResource, ItemEntry, ItemEntryOptionsInterface, ItemResource } from '../models';
-import { CollectionOptions } from '../models/CollectionOptions';
-export declare type ParentIdMap<T> = {
-    [parentId: number]: T;
-};
-export declare type EntryParent = {
-    itemType: string;
-    itemId: number;
-};
-export declare type EntryParentNull = EntryParent | null;
-/**
- * @description
- * Used for fields that belong to a specific itemType
- */
-export declare type FieldMap<_ItemTypeType extends ItemType = any> = {
-    [key: string]: any;
-};
-export declare type ItemOptionsInterface = ItemEntryOptionsInterface;
-export interface CollectionDefinition<ItemTypeType extends ItemType = any> {
-    itemType: ItemTypeType;
-    options: CollectionOptions;
-}
-export interface LinkCollectionDefinition<ItemTypeType extends ItemType = any> extends CollectionDefinition<ItemTypeType> {
-    linkField: string;
-}
-export declare enum StateKeyType {
-    New = "new",
-    Duplicate = "duplicate"
-}
-export declare type StateKey = {
-    type: StateKeyType;
-    template?: string;
-    itemId?: number;
-};
-export declare type SocketMessageType = 'event' | 'notification';
-export interface SocketMessage {
-    header: {
-        domain: string;
-        account: string;
-        sender: {
-            displayname: string;
-            itemType: 'Medewerker';
-            itemId: ItemId;
-            authorized: boolean;
-            session: string;
-        };
-        messageId: {
-            Id: string;
-            sequence: number;
-            batch: number;
-            request: number;
-        };
-        sent: string;
-        forceEvaluate: boolean;
-    };
-    body: any;
-    messageType: SocketMessageType;
-}
-export interface SocketMessageCreate extends SocketMessage {
-    body: {
-        eventType: 'create';
-        columns: ResponseColumnItemTypeMap;
-        itemType: ItemType;
-        items: {
-            [itemType: string]: {
-                [itemId: number]: {
-                    parent: null | EntryParent;
-                    values: FieldMap;
-                };
-            };
-        };
-    };
-}
-export interface SocketMessageUpdate extends SocketMessage {
-    body: {
-        eventType: 'update';
-        columns: ResponseColumnItemTypeMap;
-        itemType: ItemType;
-        items: {
-            [itemType: string]: {
-                [itemId: number]: {
-                    parent: null | EntryParent;
-                    values: FieldMap;
-                };
-            };
-        };
-    };
-}
-export interface SocketMessageLinkTo extends SocketMessage {
-    body: {
-        eventType: 'linkto';
-        columns: ResponseColumnItemTypeMap;
-        itemType: ItemType;
-        items: {
-            [itemType: string]: {
-                [itemId: number]: {
-                    parent: null | EntryParent;
-                    values: FieldMap;
-                };
-            };
-        };
-    };
-}
-export interface SocketMessageDelete extends SocketMessage {
-    body: {
-        eventType: 'delete';
-        itemType: ItemType;
-        items: ItemId[];
-    };
-}
-export interface FunctionChangesResolveSocketMessage extends SocketMessage {
-    body: {
-        itemType: 'FunctionChangesResolve';
-        [key: string]: any;
-    };
-}
-export declare type ItemResourceItemIdMap<T extends ItemResource<any> = ItemResource<any>> = {
-    [itemId: number]: T;
-};
-export declare type ItemResourcesItemTypeMap<T extends ItemResource<any> = ItemResource<any>> = {
-    [itemType: string]: T[];
-};
-export declare type ItemId = number;
-export declare type ItemType = string;
-export declare type ItemMap<T> = {
-    [itemType: string]: {
-        [itemId: string]: T;
-    };
-};
-export declare type ItemEntryMap<ItemTypeType extends ItemType> = ItemMap<ItemEntry<ItemTypeType>>;
-export declare type ItemEntryParentIdMap<ItemTypeType extends ItemType> = ParentIdMap<Array<ItemEntry<ItemTypeType>>>;
-export declare type ConversionMap = {
-    [itemId: number]: number;
-};
-export declare type ItemIdConversionMap = {
-    [itemType: string]: ConversionMap;
-};
-export declare type CreateRequestParameterMap<T = any> = ItemMap<T>;
-export declare type ItemError = {
-    message: string;
-};
-export declare type CollectionQuery = {
-    object: object;
-    string: string;
-};
-export declare type CollectionResourceParentIdMap<ItemTypeType extends ItemType = any> = ParentIdMap<CollectionResource<ItemTypeType>>;
-export declare type ResponseColumn = any;
-export declare type ResponseColumnMap = {
-    [columnId: string]: ResponseColumn;
-};
-export declare type ResponseColumnItemTypeMap = {
-    [itemType: string]: ResponseColumnMap;
-};
-export declare type ColumnExpansionResult<ItemTypeType extends ItemType = any> = {
-    merged: ColumnSet<ItemTypeType>;
-    difference: ColumnSet<ItemTypeType>;
-};
-export declare type RootColumnMap = {
-    [columnId: string]: {
-        apiColumn: ResponseColumn;
-        children: RootColumnMap;
-    };
-};
-export declare type ApiResponse = ApiResponseProcessor;
-export declare type TemplateItemResourceMap<T extends ItemResource<any>> = {
-    main: T;
-    linked: ItemResourcesItemTypeMap;
-};
-export declare type ItemTypeMap<T = any> = {
-    [itemType: string]: T;
-};
-export declare type ApiQuery = any;
-export declare type ApiRequestItemValues = {
-    values?: any;
-    links?: {
-        [itemType: string]: ItemId[];
-    };
-};
-export declare type ApiRequestItemMap = {
-    [itemType: string]: {
-        [itemId: number]: ApiRequestItemValues;
-    };
-};
-export declare type ApiRequestColumn = string | {
-    [columnId: string]: ApiRequestColumn[];
-};
-export declare type ApiRequestColumns = ApiRequestColumn[] | true;
-export declare type ApiRequestColumnMap = {
-    [itemType: string]: ApiRequestColumns;
-};
-export declare type ApiRequestLimit = {
-    field: string;
-    limit: number;
-    order?: 'desc' | 'asc';
-};
-export declare type ApiRequestMoveItems = {
-    [itemType: string]: ItemId[];
-};
-export declare type CreateRequestEntry<ItemTypeType extends ItemType> = {
-    request: {
-        requestType: 'create';
-        itemType?: ItemTypeType;
-        parentType?: ItemType;
-        parentId?: {
-            [itemId: string]: ItemId;
-        };
-        items: ApiRequestItemMap;
-        columns: ApiRequestColumnMap;
-    };
-    columns: RequestColumnExpansion;
-    items: ItemEntryMap<ItemTypeType>;
-};
-export declare enum ApiLinkTreeType {
-    ITEMTABLE = "itemtable",
-    DIRECT = "direct"
-}
-export declare type ApiLinkTreeEntry = {
-    type: ApiLinkTreeType.ITEMTABLE;
-} | {
-    type: ApiLinkTreeType.DIRECT;
-    field: string;
-};
-export declare type ApiLinkTree = {
-    [itemType: string]: {
-        [childType: string]: ApiLinkTreeEntry;
-    };
-};
-/**
- * @description
- * Callback to determine if an item should be included in the create delta, return `false` to exclude the item
- */
-export declare type FilterItemEntryCallback = <ItemTypeType extends ItemType>(itemType: ItemTypeType, fields: FieldMap<ItemTypeType>) => boolean;
-export declare type ModifyFieldsCallback = <ItemTypeType extends ItemType>(itemType: ItemTypeType, fields: FieldMap<ItemTypeType>, itemIdConversionMap?: ItemIdConversionMap) => void;
-/**
- * @description
- * Returns 'false' if the field changed
- */
-export declare type CompareFieldCallback<ItemTypeType extends ItemType = any> = (field: keyof FieldMap<ItemTypeType>) => boolean;
-export declare type FieldChangeCallbackArgs<ItemTypeType extends ItemType = any> = {
-    itemEntry: ItemEntry<ItemTypeType>;
-    compareField: CompareFieldCallback;
-    fields: FieldMap<ItemTypeType>;
-    isCalledAfterSocketUpdate: boolean;
-    previous: FieldMap<ItemTypeType>;
-};
-export declare type FieldChangeCallback<ItemTypeType extends ItemType = any> = (args: FieldChangeCallbackArgs<ItemTypeType>) => void;
-export declare type DeregFunction = () => void;
-export declare type OnChangeCallbackArgs<ItemTypeType extends ItemType = any> = FieldChangeCallbackArgs<ItemTypeType>;
-export declare type OnChangeCallback<ItemTypeType extends ItemType = any> = FieldChangeCallback<ItemTypeType>;
-export declare type OnAddCallbackArgs<ItemTypeType extends ItemType = any> = {
-    itemResources: Array<ItemResource<ItemTypeType>>;
-    collectionResource: CollectionResource<ItemTypeType>;
-    isInitialCall: boolean;
-    isCalledAfterSocketUpdate: boolean;
-};
-export declare type OnAddCallback<ItemTypeType extends ItemType = any> = (args: OnAddCallbackArgs<ItemTypeType>) => void;
-export declare type OnRemoveCallbackArgs<ItemTypeType extends ItemType = any> = {
-    itemResources: Array<ItemResource<ItemTypeType>>;
-    collectionResource: CollectionResource<ItemTypeType>;
-    isCalledAfterSocketUpdate: boolean;
-};
-export declare type OnRemoveCallback<ItemTypeType extends ItemType = any> = (args: OnRemoveCallbackArgs<ItemTypeType>) => void;
+import { ApiResponseProcessor, ColumnSet, RequestColumnExpansion } from '../classes';
+import { CollectionResource, ItemEntry, ItemEntryOptionsInterface, ItemResource } from '../models';
+import { CollectionOptions } from '../models/CollectionOptions';
+export declare type ParentIdMap<T> = {
+    [parentId: number]: T;
+};
+export declare type EntryParent = {
+    itemType: string;
+    itemId: number;
+};
+export declare type EntryParentNull = EntryParent | null;
+/**
+ * @description
+ * Used for fields that belong to a specific itemType
+ */
+export declare type FieldMap<_ItemTypeType extends ItemType = any, Values = ColumnIdTypeMap> = Values;
+export declare type ColumnIdTypeMap<Fields extends object = any> = Fields;
+export declare type ItemOptionsInterface = ItemEntryOptionsInterface;
+export interface CollectionDefinition<ItemTypeType extends ItemType = any> {
+    itemType: ItemTypeType;
+    options: CollectionOptions;
+}
+export interface LinkCollectionDefinition<ItemTypeType extends ItemType = any> extends CollectionDefinition<ItemTypeType> {
+    linkField: string;
+}
+export declare enum StateKeyType {
+    New = "new",
+    Duplicate = "duplicate"
+}
+export declare type StateKey = {
+    type: StateKeyType;
+    template?: string;
+    itemId?: number;
+};
+export declare type SocketMessageType = 'event' | 'notification';
+export interface SocketMessage {
+    header: {
+        domain: string;
+        account: string;
+        sender: {
+            displayname: string;
+            itemType: 'Medewerker';
+            itemId: ItemId;
+            authorized: boolean;
+            session: string;
+        };
+        messageId: {
+            Id: string;
+            sequence: number;
+            batch: number;
+            request: number;
+        };
+        sent: string;
+        forceEvaluate: boolean;
+    };
+    body: any;
+    messageType: SocketMessageType;
+}
+export interface SocketMessageCreate extends SocketMessage {
+    body: {
+        eventType: 'create';
+        columns: ResponseColumnItemTypeMap;
+        itemType: ItemType;
+        items: {
+            [itemType: string]: {
+                [itemId: number]: {
+                    parent: null | EntryParent;
+                    values: FieldMap;
+                };
+            };
+        };
+    };
+}
+export interface SocketMessageUpdate extends SocketMessage {
+    body: {
+        eventType: 'update';
+        columns: ResponseColumnItemTypeMap;
+        itemType: ItemType;
+        items: {
+            [itemType: string]: {
+                [itemId: number]: {
+                    parent: null | EntryParent;
+                    values: FieldMap;
+                };
+            };
+        };
+    };
+}
+export interface SocketMessageLinkTo extends SocketMessage {
+    body: {
+        eventType: 'linkto';
+        columns: ResponseColumnItemTypeMap;
+        itemType: ItemType;
+        items: {
+            [itemType: string]: {
+                [itemId: number]: {
+                    parent: null | EntryParent;
+                    values: FieldMap;
+                };
+            };
+        };
+    };
+}
+export interface SocketMessageDelete extends SocketMessage {
+    body: {
+        eventType: 'delete';
+        itemType: ItemType;
+        items: ItemId[];
+    };
+}
+export interface FunctionChangesResolveSocketMessage extends SocketMessage {
+    body: {
+        itemType: 'FunctionChangesResolve';
+        [key: string]: any;
+    };
+}
+export declare type ItemResourceItemIdMap<T extends ItemResource = ItemResource> = {
+    [itemId: number]: T;
+};
+export declare type ItemResourcesItemTypeMap<T extends ItemResource = ItemResource> = {
+    [itemType: string]: T[];
+};
+export declare type ItemId = number;
+export declare type ItemType = string;
+export declare type ItemMap<T> = {
+    [itemType: string]: {
+        [itemId: string]: T;
+    };
+};
+export declare type ItemEntryMap<ItemTypeType extends ItemType> = ItemMap<ItemEntry<ItemTypeType>>;
+export declare type ItemEntryParentIdMap<ItemTypeType extends ItemType> = ParentIdMap<Array<ItemEntry<ItemTypeType>>>;
+export declare type ConversionMap = {
+    [itemId: number]: number;
+};
+export declare type ItemIdConversionMap = {
+    [itemType: string]: ConversionMap;
+};
+export declare type CreateRequestParameterMap<T = any> = ItemMap<T>;
+export declare type ItemError = {
+    message: string;
+};
+export declare type CollectionQuery = {
+    object: object;
+    string: string;
+};
+export declare type CollectionResourceParentIdMap<ItemTypeType extends ItemType = any> = ParentIdMap<CollectionResource<ItemTypeType>>;
+export declare type ResponseColumn = any;
+export declare type ResponseColumnMap = {
+    [columnId: string]: ResponseColumn;
+};
+export declare type ResponseColumnItemTypeMap = {
+    [itemType: string]: ResponseColumnMap;
+};
+export declare type ColumnExpansionResult<ItemTypeType extends ItemType = any> = {
+    merged: ColumnSet<ItemTypeType>;
+    difference: ColumnSet<ItemTypeType>;
+};
+export declare type RootColumnMap = {
+    [columnId: string]: {
+        apiColumn: ResponseColumn;
+        children: RootColumnMap;
+    };
+};
+export declare type ApiResponse = ApiResponseProcessor;
+export declare type TemplateItemResourceMap<T extends ItemResource<any>> = {
+    main: T;
+    linked: ItemResourcesItemTypeMap;
+};
+export declare type ItemTypeMap<T = any> = {
+    [itemType: string]: T;
+};
+export declare type ApiQuery = any;
+export declare type ApiRequestItemValues = {
+    values?: any;
+    links?: {
+        [itemType: string]: ItemId[];
+    };
+};
+export declare type ApiRequestItemMap = {
+    [itemType: string]: {
+        [itemId: number]: ApiRequestItemValues;
+    };
+};
+export declare type ApiRequestColumn = string | {
+    [columnId: string]: ApiRequestColumn[];
+};
+export declare type ApiRequestColumns = ApiRequestColumn[] | true;
+export declare type ApiRequestColumnMap = {
+    [itemType: string]: ApiRequestColumns;
+};
+export declare type ApiRequestLimit = {
+    field: string;
+    limit: number;
+    order?: 'desc' | 'asc';
+};
+export declare type ApiRequestMoveItems = {
+    [itemType: string]: ItemId[];
+};
+export declare type CreateRequestEntry<ItemTypeType extends ItemType> = {
+    request: {
+        requestType: 'create';
+        itemType?: ItemTypeType;
+        parentType?: ItemType;
+        parentId?: {
+            [itemId: string]: ItemId;
+        };
+        items: ApiRequestItemMap;
+        columns: ApiRequestColumnMap;
+    };
+    columns: RequestColumnExpansion;
+    items: ItemEntryMap<ItemTypeType>;
+};
+export declare enum ApiLinkTreeType {
+    ITEMTABLE = "itemtable",
+    DIRECT = "direct"
+}
+export declare type ApiLinkTreeEntry = {
+    type: ApiLinkTreeType.ITEMTABLE;
+} | {
+    type: ApiLinkTreeType.DIRECT;
+    field: string;
+};
+export declare type ApiLinkTree = {
+    [itemType: string]: {
+        [childType: string]: ApiLinkTreeEntry;
+    };
+};
+/**
+ * @description
+ * Callback to determine if an item should be included in the create delta, return `false` to exclude the item
+ */
+export declare type FilterItemEntryCallback = <ItemTypeType extends ItemType, Fields extends ColumnIdTypeMap = any>(itemType: ItemTypeType, fields: FieldMap<ItemTypeType, Fields>) => boolean;
+export declare type ModifyFieldsCallback = <ItemTypeType extends ItemType, Fields extends ColumnIdTypeMap = any>(itemType: ItemTypeType, fields: FieldMap<ItemTypeType, Fields>, itemIdConversionMap?: ItemIdConversionMap) => void;
+/**
+ * @description
+ * Returns 'false' if the field changed
+ */
+export declare type CompareFieldCallback<Fields extends ColumnIdTypeMap, T extends keyof Fields = string> = (field: T) => boolean;
+export declare type FieldChangeCallbackArgs<ItemTypeType extends ItemType = any, Fields extends ColumnIdTypeMap = any> = {
+    itemEntry: ItemEntry<ItemTypeType>;
+    compareField: CompareFieldCallback<Fields>;
+    fields: FieldMap<ItemTypeType, Fields>;
+    isCalledAfterSocketUpdate: boolean;
+    previous: FieldMap<ItemTypeType, Fields>;
+};
+export declare type FieldChangeCallback<ItemTypeType extends ItemType = any, Fields extends ColumnIdTypeMap = any> = (args: FieldChangeCallbackArgs<ItemTypeType, Fields>) => void;
+export declare type DeregFunction = () => void;
+export declare type OnChangeCallbackArgs<ItemTypeType extends ItemType = any, Fields extends ColumnIdTypeMap = any> = FieldChangeCallbackArgs<ItemTypeType, Fields>;
+export declare type OnChangeCallback<ItemTypeType extends ItemType = any, Fields extends ColumnIdTypeMap = any> = FieldChangeCallback<ItemTypeType, Fields>;
+export declare type OnAddCallbackArgs<ItemTypeType extends ItemType = any, Fields extends ColumnIdTypeMap = any> = {
+    itemResources: Array<ItemResource<ItemTypeType, Fields>>;
+    collectionResource: CollectionResource<ItemTypeType, Fields>;
+    isInitialCall: boolean;
+    isCalledAfterSocketUpdate: boolean;
+};
+export declare type OnAddCallback<ItemTypeType extends ItemType = any, Fields extends ColumnIdTypeMap = any> = (args: OnAddCallbackArgs<ItemTypeType, Fields>) => void;
+export declare type OnRemoveCallbackArgs<ItemTypeType extends ItemType = any, Fields extends ColumnIdTypeMap = any> = {
+    itemResources: Array<ItemResource<ItemTypeType, Fields>>;
+    collectionResource: CollectionResource<ItemTypeType, Fields>;
+    isCalledAfterSocketUpdate: boolean;
+};
+export declare type OnRemoveCallback<ItemTypeType extends ItemType = any, Fields extends ColumnIdTypeMap = any> = (args: OnRemoveCallbackArgs<ItemTypeType, Fields>) => void;

package/dist/types/types/PromiseInterface.d.ts

@@ -1,2 +1,2 @@
-export interface PromiseInterface<T> extends Promise<T> {
-}
+export interface PromiseInterface<T> extends Promise<T> {
+}

package/dist/types/types/index.d.ts

@@ -1,2 +1,2 @@
-export * from './ItemTypesCollection';
-export * from './PromiseInterface';
+export * from './ItemTypesCollection';
+export * from './PromiseInterface';

package/package.json

@@ -1,36 +1,36 @@
-{
-  "name": "@rentman/rm-core",
-  "version": "6.2.5",
-  "description": "Rentman core functionalities",
-  "main": "./dist/rm-core.js",
-  "types": "./dist/types/index.d.ts",
-  "dependencies": {},
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/rentmanpublic/frontend-core"
-  },
-  "devDependencies": {
-    "@types/moment": "^2.13.0",
-    "@types/q": "^1.5.0",
-    "clean-webpack-plugin": "^0.1.19",
-    "ts-loader": "^6.2.1",
-    "tslint": "5.19.0",
-    "typescript": "^3.7.2",
-    "typescript-tslint-plugin": "^0.5.5",
-    "uglifyjs-webpack-plugin": "^1.2.5",
-    "webpack": "4.41.2",
-    "webpack-cli": "3.3.6",
-    "webpack-merge": "^4.1.4"
-  },
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "prepublishOnly": "npm run bundle",
-    "bundle-dev": "webpack --config webpack.dev.js",
-    "bundle": "webpack --config webpack.prod.js",
-    "type-check": "tsc --noEmit"
-  },
-  "author": "Martijn Welker <martijn@rentman.nl>",
-  "license": "UNLICENSED"
-}
+{
+  "name": "@rentman/rm-core",
+  "version": "6.3.1",
+  "description": "Rentman core functionalities",
+  "main": "./dist/rm-core.js",
+  "types": "./dist/types/index.d.ts",
+  "dependencies": {},
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/rentmanpublic/frontend-core"
+  },
+  "devDependencies": {
+    "@types/moment": "^2.13.0",
+    "@types/q": "^1.5.0",
+    "clean-webpack-plugin": "^0.1.19",
+    "ts-loader": "^6.2.1",
+    "tslint": "5.19.0",
+    "typescript": "^3.7.2",
+    "typescript-tslint-plugin": "^0.5.5",
+    "uglifyjs-webpack-plugin": "^1.2.5",
+    "webpack": "4.41.2",
+    "webpack-cli": "3.3.6",
+    "webpack-merge": "^4.1.4"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "prepublishOnly": "npm run bundle",
+    "bundle-dev": "webpack --config webpack.dev.js",
+    "bundle": "webpack --config webpack.prod.js",
+    "type-check": "tsc --noEmit"
+  },
+  "author": "Martijn Welker <martijn@rentman.nl>",
+  "license": "UNLICENSED"
+}

package/readme.md

@@ -1,16 +1,16 @@
-# Running a local test version
-1. Make changes
-2. run `npm run bundle-dev`
-3. copy `dist` folder to 
-    - Frontend: `<project>/bower_components/rentman-rm-core/`
-    - App: `<project>/node_modules/@rentman/rm-core/`
-
-# Publishing your local version
-
-(You have to be logged in as rentman-user on npm, run `npm whoami` to see who you are logged in as)
-
-1. Make changes
-2. Report changes in changelog
-3. Update version in package.json and main.ts
-4. Commit, tag and push changes
+# Running a local test version
+1. Make changes
+2. run `npm run bundle-dev`
+3. copy `dist` folder to 
+    - Frontend: `<project>/bower_components/rentman-rm-core/`
+    - App: `<project>/node_modules/@rentman/rm-core/`
+
+# Publishing your local version
+
+(You have to be logged in as rentman-user on npm, run `npm whoami` to see who you are logged in as)
+
+1. Make changes
+2. Report changes in changelog
+3. Update version in package.json and main.ts
+4. Commit, tag and push changes
 5. run `npm publish`