@rentman/rm-core 6.2.3 → 6.2.5

package/dist/types/models/CollectionResource.d.ts

@@ -1,72 +1,72 @@
-import { TransactionCache } from '../classes/cache/transaction/TransactionCache';
-import { ChangesDeltaResult } from '../classes/ChangesDeltaBase';
-import { CollectionResourceFactory } from '../factories';
-import { CollectionEntry, CollectionOptions, ItemEntry, ItemResource } from '../models';
-import { ApiRequestLimit, CompareFieldCallback, DeregFunction, FieldMap, ItemId, ItemResourceItemIdMap, ItemType, OnAddCallback, OnChangeCallback, OnRemoveCallback, PromiseInterface, ResponseColumnItemTypeMap } from '../types';
-export declare class CollectionResource<ItemTypeType extends ItemType = any> {
-    protected factory: CollectionResourceFactory;
-    options: CollectionOptions<ItemTypeType>;
-    transaction: TransactionCache;
-    entry: CollectionEntry<ItemTypeType>;
-    columns: ResponseColumnItemTypeMap;
-    items: Array<ItemResource<ItemTypeType>>;
-    protected itemIdMap: ItemResourceItemIdMap<ItemResource<ItemTypeType>>;
-    private fieldChangeDeregFns;
-    private readonly onChangeCallbacks;
-    private readonly onAddCallbacks;
-    private readonly onRemoveCallbacks;
-    /**
-     * @description
-     * We store the ItemIds of the items that were taking out the collections so that we can include those when doing a not-in when having a limit
-     */
-    private removedItemIds;
-    constructor(factory: CollectionResourceFactory, options: CollectionOptions<ItemTypeType>, transaction: TransactionCache, itemType: ItemTypeType, initialItemEntries: Array<ItemEntry<ItemTypeType>>);
-    onConstruct(): void;
-    setLimit(newLimit: number | ApiRequestLimit): void;
-    onAdd(callback: OnAddCallback): DeregFunction;
-    onChange(callback: OnChangeCallback): DeregFunction;
-    onRemove(callback: OnRemoveCallback): DeregFunction;
-    __clear(): void;
-    /**
-     * @deprecated
-     * Use {@link ChangesDelta.setItemMoved ChangesDelta.setItemMoved}
-     */
-    moveItems(itemEntries: Array<ItemEntry<ItemTypeType>>, destinationResource: CollectionResource<ItemTypeType>): void;
-    removeItems(idArray: ItemId[]): PromiseInterface<ChangesDeltaResult>;
-    removeItem(itemId: ItemId): PromiseInterface<ChangesDeltaResult>;
-    addItems(valuesArray: Array<FieldMap<ItemTypeType>>): PromiseInterface<ChangesDeltaResult>;
-    addItem(values: FieldMap<ItemTypeType>): PromiseInterface<ChangesDeltaResult>;
-    getIdArray(): ItemId[];
-    getItemById(itemId: number): ItemResource<ItemTypeType>;
-    addItemResources(itemEntriesToBeAdded: Array<ItemEntry<ItemTypeType>>, isInitialCall?: boolean, isCalledAfterSocketUpdate?: boolean): Array<ItemResource<ItemTypeType>>;
-    /**
-     * @description
-     * Returns the {@link ItemResource ItemResources} that where removed from the {@link CollectionResource collection}.
-     * Filters on {@link ItemResource ItemResource}.{@link ItemEntry entry} === {@link ItemEntry entry}
-     */
-    removeItemResources(itemEntries: Array<ItemEntry<ItemTypeType>>, isCalledAfterSocketUpdate: boolean): Array<ItemResource<ItemTypeType>>;
-    callOnAdd(itemResources: Array<ItemResource<ItemTypeType>>, isInitialCall?: boolean, isCalledAfterSocketUpdate?: boolean): void;
-    callOnChange(itemEntry: ItemEntry<ItemTypeType>, compareField: CompareFieldCallback, fields: FieldMap<ItemTypeType>, isCalledAfterSocketUpdate: boolean, previous: FieldMap<ItemTypeType>): void;
-    callOnRemove(itemResources: Array<ItemResource<ItemTypeType>>, isCalledAfterSocketUpdate: boolean): void;
-    forEach(callback: (itemResource: ItemResource<ItemTypeType>) => void): void;
-    filter(callback: (itemResource: ItemResource<ItemTypeType>) => boolean): Array<ItemResource<ItemTypeType>>;
-    first(callback: (itemResource: ItemResource<ItemTypeType>) => boolean): ItemResource<ItemTypeType> | null;
-    some(callback: (itemResource: ItemResource<ItemTypeType>) => boolean): boolean;
-    groupBy(argument: string | ((itemResource: ItemResource<ItemTypeType>) => string | null)): {
-        [key: string]: Array<ItemResource<ItemTypeType>>;
-    };
-    map<U>(argument: string | ((itemResource: ItemResource<ItemTypeType>) => U)): U[];
-    reduce<U>(callback: (itemResource: ItemResource<ItemTypeType>, value: U) => U, value: U): U;
-    /**
-     * @description
-     * Removes the reference to the {@link CollectionResource CollectionResource} from the {@link CollectionEntry CollectionEntry}
-     *
-     * @remarks
-     * - Doesn't revert changes on the items themselves
-     */
-    clearResource(): void;
-    private registerListeners;
-    private __registerCallback;
-    private limitAfterRemove;
-    private limitAfterAdd;
-}
+import { TransactionCache } from '../classes/cache/transaction/TransactionCache';
+import { ChangesDeltaResult } from '../classes/ChangesDeltaBase';
+import { CollectionResourceFactory } from '../factories';
+import { CollectionEntry, CollectionOptions, ItemEntry, ItemResource } from '../models';
+import { ApiRequestLimit, CompareFieldCallback, DeregFunction, FieldMap, ItemId, ItemResourceItemIdMap, ItemType, OnAddCallback, OnChangeCallback, OnRemoveCallback, PromiseInterface, ResponseColumnItemTypeMap } from '../types';
+export declare class CollectionResource<ItemTypeType extends ItemType = any> {
+    protected factory: CollectionResourceFactory;
+    options: CollectionOptions<ItemTypeType>;
+    transaction: TransactionCache;
+    entry: CollectionEntry<ItemTypeType>;
+    columns: ResponseColumnItemTypeMap;
+    items: Array<ItemResource<ItemTypeType>>;
+    protected itemIdMap: ItemResourceItemIdMap<ItemResource<ItemTypeType>>;
+    private fieldChangeDeregFns;
+    private readonly onChangeCallbacks;
+    private readonly onAddCallbacks;
+    private readonly onRemoveCallbacks;
+    /**
+     * @description
+     * We store the ItemIds of the items that were taking out the collections so that we can include those when doing a not-in when having a limit
+     */
+    private removedItemIds;
+    constructor(factory: CollectionResourceFactory, options: CollectionOptions<ItemTypeType>, transaction: TransactionCache, itemType: ItemTypeType, initialItemEntries: Array<ItemEntry<ItemTypeType>>);
+    onConstruct(): void;
+    setLimit(newLimit: number | ApiRequestLimit): void;
+    onAdd(callback: OnAddCallback): DeregFunction;
+    onChange(callback: OnChangeCallback): DeregFunction;
+    onRemove(callback: OnRemoveCallback): DeregFunction;
+    __clear(): void;
+    /**
+     * @deprecated
+     * Use {@link ChangesDelta.setItemMoved ChangesDelta.setItemMoved}
+     */
+    moveItems(itemEntries: Array<ItemEntry<ItemTypeType>>, destinationResource: CollectionResource<ItemTypeType>): void;
+    removeItems(idArray: ItemId[]): PromiseInterface<ChangesDeltaResult>;
+    removeItem(itemId: ItemId): PromiseInterface<ChangesDeltaResult>;
+    addItems(valuesArray: Array<FieldMap<ItemTypeType>>): PromiseInterface<ChangesDeltaResult>;
+    addItem(values: FieldMap<ItemTypeType>): PromiseInterface<ChangesDeltaResult>;
+    getIdArray(): ItemId[];
+    getItemById(itemId: number): ItemResource<ItemTypeType>;
+    addItemResources(itemEntriesToBeAdded: Array<ItemEntry<ItemTypeType>>, isInitialCall?: boolean, isCalledAfterSocketUpdate?: boolean): Array<ItemResource<ItemTypeType>>;
+    /**
+     * @description
+     * Returns the {@link ItemResource ItemResources} that where removed from the {@link CollectionResource collection}.
+     * Filters on {@link ItemResource ItemResource}.{@link ItemEntry entry} === {@link ItemEntry entry}
+     */
+    removeItemResources(itemEntries: Array<ItemEntry<ItemTypeType>>, isCalledAfterSocketUpdate: boolean): Array<ItemResource<ItemTypeType>>;
+    callOnAdd(itemResources: Array<ItemResource<ItemTypeType>>, isInitialCall?: boolean, isCalledAfterSocketUpdate?: boolean): void;
+    callOnChange(itemEntry: ItemEntry<ItemTypeType>, compareField: CompareFieldCallback, fields: FieldMap<ItemTypeType>, isCalledAfterSocketUpdate: boolean, previous: FieldMap<ItemTypeType>): void;
+    callOnRemove(itemResources: Array<ItemResource<ItemTypeType>>, isCalledAfterSocketUpdate: boolean): void;
+    forEach(callback: (itemResource: ItemResource<ItemTypeType>) => void): void;
+    filter(callback: (itemResource: ItemResource<ItemTypeType>) => boolean): Array<ItemResource<ItemTypeType>>;
+    first(callback: (itemResource: ItemResource<ItemTypeType>) => boolean): ItemResource<ItemTypeType> | null;
+    some(callback: (itemResource: ItemResource<ItemTypeType>) => boolean): boolean;
+    groupBy(argument: string | ((itemResource: ItemResource<ItemTypeType>) => string | null)): {
+        [key: string]: Array<ItemResource<ItemTypeType>>;
+    };
+    map<U>(argument: string | ((itemResource: ItemResource<ItemTypeType>) => U)): U[];
+    reduce<U>(callback: (itemResource: ItemResource<ItemTypeType>, value: U) => U, value: U): U;
+    /**
+     * @description
+     * Removes the reference to the {@link CollectionResource CollectionResource} from the {@link CollectionEntry CollectionEntry}
+     *
+     * @remarks
+     * - Doesn't revert changes on the items themselves
+     */
+    clearResource(): void;
+    private registerListeners;
+    private __registerCallback;
+    private limitAfterRemove;
+    private limitAfterAdd;
+}

package/dist/types/models/ItemEntry.d.ts

@@ -1,19 +1,19 @@
-import { ColumnSet } from '../classes';
-import { ItemEntryFactory } from '../factories';
-import { ItemId, ItemType } from '../types';
-export declare class ItemEntry<ItemTypeType extends ItemType = any> {
-    private factory;
-    itemType: ItemTypeType;
-    itemId: ItemId;
-    columns: ColumnSet<ItemTypeType>;
-    id: number;
-    reloadQueued: boolean;
-    constructor(factory: ItemEntryFactory, itemType: ItemTypeType, itemId: ItemId, columns: ColumnSet<ItemTypeType>);
-    queueReload(): this;
-    isLocal(): boolean;
-    isLockable(): boolean;
-    toJSON(): {
-        id: number;
-        columns: ColumnSet<ItemTypeType>;
-    };
-}
+import { ColumnSet } from '../classes';
+import { ItemEntryFactory } from '../factories';
+import { ItemId, ItemType } from '../types';
+export declare class ItemEntry<ItemTypeType extends ItemType = any> {
+    private factory;
+    itemType: ItemTypeType;
+    itemId: ItemId;
+    columns: ColumnSet<ItemTypeType>;
+    id: number;
+    reloadQueued: boolean;
+    constructor(factory: ItemEntryFactory, itemType: ItemTypeType, itemId: ItemId, columns: ColumnSet<ItemTypeType>);
+    queueReload(): this;
+    isLocal(): boolean;
+    isLockable(): boolean;
+    toJSON(): {
+        id: number;
+        columns: ColumnSet<ItemTypeType>;
+    };
+}

package/dist/types/models/ItemEntryOptions.d.ts

@@ -1,8 +1,8 @@
-import { ApiRequestColumns, EntryParentNull } from '../types';
-export declare type ItemEntryOptionsInterface = Partial<ItemEntryOptions>;
-export declare class ItemEntryOptions {
-    columns: ApiRequestColumns;
-    parent: EntryParentNull;
-    templateOptions: any;
-    constructor(values: ItemEntryOptionsInterface);
-}
+import { ApiRequestColumns, EntryParentNull } from '../types';
+export declare type ItemEntryOptionsInterface = Partial<ItemEntryOptions>;
+export declare class ItemEntryOptions {
+    columns: ApiRequestColumns;
+    parent: EntryParentNull;
+    templateOptions: any;
+    constructor(values: ItemEntryOptionsInterface);
+}

package/dist/types/models/ItemResource.d.ts

@@ -1,84 +1,84 @@
-import { TransactionCache } from '../classes';
-import { ItemResourceFactory } from '../factories';
-import { ItemEntry } from '../models';
-import { EntryParentNull, FieldMap, ItemType, PromiseInterface, ResponseColumn } from '../types';
-export declare class ItemResource<ItemTypeType extends ItemType = any> {
-    protected readonly factory: ItemResourceFactory;
-    readonly entry: ItemEntry<ItemTypeType>;
-    protected readonly _isNew: boolean;
-    protected readonly transaction: TransactionCache;
-    columns: {
-        [columnId: string]: ResponseColumn;
-    };
-    fields: FieldMap<ItemTypeType>;
-    initial: Readonly<FieldMap<ItemTypeType>>;
-    constructor(factory: ItemResourceFactory, entry: ItemEntry<ItemTypeType>, _isNew: boolean, transaction: TransactionCache);
-    onConstruct(): void;
-    /**
-     * @description
-     * Updates the fields of the item and calls onChange, when updating many fields of many items it's better to create a {@link ChangesDelta ChangesDelta} yourself so all changes can be applied at once
-     */
-    setFields(values: FieldMap<ItemTypeType>): PromiseInterface<this>;
-    copyFields(destination?: FieldMap<ItemTypeType>): FieldMap<ItemTypeType>;
-    /**
-     * Fetches the ItemResource's parent with the current fields
-     *
-     * ----------------
-     *
-     * @remark
-     * Use this if you need to get the parent after an item has been deleted
-     */
-    getParent(fromInitial?: boolean): EntryParentNull;
-    /**
-     * @deprecated
-     * Use {@link TransactionCache.applyChangesDelta transaction.applyChangesDelta} instead
-     */
-    callOnChange(previous: FieldMap<ItemTypeType>): void;
-    /**
-     * @description
-     * Utility function to easily check if a field is changed.
-     * Will return `false` if the field is changed
-     *
-     * @example
-     * onChange: (
-     *     itemResource,
-     *     previous,
-     *     compareItemField
-     * ) {
-     *     if (!compareItemField('columnId')) {
-     *         processItem(itemResource);
-     *     }
-     * }
-     */
-    compareItemField(columnId: keyof FieldMap<ItemTypeType>, previous: FieldMap<ItemTypeType>): boolean;
-    hasChanges(): boolean;
-    setTransactionParameters(parameters: any): void;
-    /**
-     * @description
-     * 'isNew' means that the {@link ItemEntry ItemEntry} is a local item and that this resource was created when the {@link ItemEntry ItemEntry} was first created
-     */
-    isNew(): boolean;
-    isLocal(): boolean;
-    toJSON(): {
-        columns: string[];
-        fields: FieldMap<ItemTypeType>;
-        entry: ItemEntry<ItemTypeType>;
-    };
-    /**
-     * @description
-     * Returns the value of the columnPath, or undefined when the path couldn't be traversed
-     *
-     * @param columnPath Can either be an array of columnIds (['column', 'column2']) or a config column string ('column>column2')
-     */
-    getDerivedValue<T extends any = any>(columnPath: string[] | string): T | undefined;
-    /**
-     * @description
-     * Traverses the column path and returns the fields of the derived item, returns undefined if the item isn't found
-     *
-     * ---------------------
-     *
-     * @remark
-     * Assumes the derived item's values are already cached
-     */
-    getDerivedValues(columnPath: string[]): Readonly<FieldMap> | undefined;
-}
+import { TransactionCache } from '../classes';
+import { ItemResourceFactory } from '../factories';
+import { ItemEntry } from '../models';
+import { EntryParentNull, FieldMap, ItemType, PromiseInterface, ResponseColumn } from '../types';
+export declare class ItemResource<ItemTypeType extends ItemType = any> {
+    protected readonly factory: ItemResourceFactory;
+    readonly entry: ItemEntry<ItemTypeType>;
+    protected readonly _isNew: boolean;
+    protected readonly transaction: TransactionCache;
+    columns: {
+        [columnId: string]: ResponseColumn;
+    };
+    fields: FieldMap<ItemTypeType>;
+    initial: Readonly<FieldMap<ItemTypeType>>;
+    constructor(factory: ItemResourceFactory, entry: ItemEntry<ItemTypeType>, _isNew: boolean, transaction: TransactionCache);
+    onConstruct(): void;
+    /**
+     * @description
+     * Updates the fields of the item and calls onChange, when updating many fields of many items it's better to create a {@link ChangesDelta ChangesDelta} yourself so all changes can be applied at once
+     */
+    setFields(values: FieldMap<ItemTypeType>): PromiseInterface<this>;
+    copyFields(destination?: FieldMap<ItemTypeType>): FieldMap<ItemTypeType>;
+    /**
+     * Fetches the ItemResource's parent with the current fields
+     *
+     * ----------------
+     *
+     * @remark
+     * Use this if you need to get the parent after an item has been deleted
+     */
+    getParent(fromInitial?: boolean): EntryParentNull;
+    /**
+     * @deprecated
+     * Use {@link TransactionCache.applyChangesDelta transaction.applyChangesDelta} instead
+     */
+    callOnChange(previous: FieldMap<ItemTypeType>): void;
+    /**
+     * @description
+     * Utility function to easily check if a field is changed.
+     * Will return `false` if the field is changed
+     *
+     * @example
+     * onChange: (
+     *     itemResource,
+     *     previous,
+     *     compareItemField
+     * ) {
+     *     if (!compareItemField('columnId')) {
+     *         processItem(itemResource);
+     *     }
+     * }
+     */
+    compareItemField(columnId: keyof FieldMap<ItemTypeType>, previous: FieldMap<ItemTypeType>): boolean;
+    hasChanges(): boolean;
+    setTransactionParameters(parameters: any): void;
+    /**
+     * @description
+     * 'isNew' means that the {@link ItemEntry ItemEntry} is a local item and that this resource was created when the {@link ItemEntry ItemEntry} was first created
+     */
+    isNew(): boolean;
+    isLocal(): boolean;
+    toJSON(): {
+        columns: string[];
+        fields: FieldMap<ItemTypeType>;
+        entry: ItemEntry<ItemTypeType>;
+    };
+    /**
+     * @description
+     * Returns the value of the columnPath, or undefined when the path couldn't be traversed
+     *
+     * @param columnPath Can either be an array of columnIds (['column', 'column2']) or a config column string ('column>column2')
+     */
+    getDerivedValue<T extends any = any>(columnPath: string[] | string): T | undefined;
+    /**
+     * @description
+     * Traverses the column path and returns the fields of the derived item, returns undefined if the item isn't found
+     *
+     * ---------------------
+     *
+     * @remark
+     * Assumes the derived item's values are already cached
+     */
+    getDerivedValues(columnPath: string[]): Readonly<FieldMap> | undefined;
+}

package/dist/types/models/Template.d.ts

@@ -1,11 +1,11 @@
-import { ColumnSet } from '../classes';
-import { TemplateFactory } from '../factories';
-import { ApiRequestColumnMap, ApiResponse, FieldMap, ItemType, ResponseColumnItemTypeMap } from '../types';
-export declare class Template<ItemTypeType extends ItemType = any> {
-    itemType: ItemTypeType;
-    response: ApiResponse;
-    responseColumns: ResponseColumnItemTypeMap;
-    columns: ColumnSet<ItemTypeType>;
-    constructor(factory: TemplateFactory, itemType: ItemTypeType, response: ApiResponse, additionalRequestColumns: ApiRequestColumnMap, additionalResponseColumns: ResponseColumnItemTypeMap);
-    getFields(): FieldMap<ItemTypeType>;
-}
+import { ColumnSet } from '../classes';
+import { TemplateFactory } from '../factories';
+import { ApiRequestColumnMap, ApiResponse, FieldMap, ItemType, ResponseColumnItemTypeMap } from '../types';
+export declare class Template<ItemTypeType extends ItemType = any> {
+    itemType: ItemTypeType;
+    response: ApiResponse;
+    responseColumns: ResponseColumnItemTypeMap;
+    columns: ColumnSet<ItemTypeType>;
+    constructor(factory: TemplateFactory, itemType: ItemTypeType, response: ApiResponse, additionalRequestColumns: ApiRequestColumnMap, additionalResponseColumns: ResponseColumnItemTypeMap);
+    getFields(): FieldMap<ItemTypeType>;
+}

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

@@ -1,7 +1,7 @@
-export * from './ItemEntryOptions';
-export * from './ItemEntry';
-export * from './ItemResource';
-export * from './CollectionOptions';
-export * from './CollectionEntry';
-export * from './CollectionResource';
-export * from './Template';
+export * from './ItemEntryOptions';
+export * from './ItemEntry';
+export * from './ItemResource';
+export * from './CollectionOptions';
+export * from './CollectionEntry';
+export * from './CollectionResource';
+export * from './Template';