@rentman/rm-core 8.1.9 → 8.2.0

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

@@ -1,18 +1,18 @@
-import { ApiEnumItemType, ItemId } from '@rentman/backend-types';
-import { ColumnSet, ItemEntryFactory } from '../internal';
-export declare class ItemEntry<ItemTypeType extends ApiEnumItemType = 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 { ApiEnumItemType, ItemId } from '@rentman/backend-types';
+import { ColumnSet, ItemEntryFactory } from '../internal';
+export declare class ItemEntry<ItemTypeType extends ApiEnumItemType = 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 '../internal';
-export declare type ItemEntryOptionsInterface = Partial<ItemEntryOptions>;
-export declare class ItemEntryOptions {
-    columns: ApiRequestColumns;
-    parent: EntryParentNull;
-    templateOptions: any;
-    constructor(values: ItemEntryOptionsInterface);
-}
+import { ApiRequestColumns, EntryParentNull } from '../internal';
+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,85 +1,90 @@
-import { ApiEnumItemType, ApiFields } from '@rentman/backend-types';
-import { EntryParentNull, ExtractApiItemType, FieldMap, ItemEntry, ItemResourceFactory, PromiseInterface, ResponseColumnMap, TransactionCache } from '../internal';
-export declare class ItemResource<ItemTypeType extends ApiEnumItemType = any, ColumnIds extends Array<keyof ApiFields[ItemTypeType]> = Array<keyof ApiFields[ItemTypeType]>> {
-    protected readonly factory: ItemResourceFactory;
-    readonly entry: ItemEntry<ItemTypeType>;
-    protected readonly _isNew: boolean;
-    protected readonly transaction: TransactionCache;
-    columns: ResponseColumnMap<ItemTypeType, ColumnIds>;
-    fields: FieldMap<ItemTypeType, ColumnIds>;
-    initial: Readonly<FieldMap<ItemTypeType, ColumnIds>>;
-    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: Partial<FieldMap<ItemTypeType, ColumnIds>>): PromiseInterface<this>;
-    copyFields(destination?: FieldMap<ItemTypeType, []>): FieldMap<ItemTypeType, ColumnIds>;
-    /**
-     * 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, ColumnIds>): 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: ColumnIds[number], previous: FieldMap<ItemTypeType, ColumnIds>): 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, ColumnIds>;
-        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<T1 extends string>(columnPath: T1): any | undefined;
-    getDerivedValue<T1 extends ColumnIds[number]>(columnPath: [T1]): FieldMap<ItemTypeType>[T1] | undefined;
-    getDerivedValue<T1 extends ColumnIds[number], T2 extends keyof ApiFields[ExtractApiItemType<ApiFields[ItemTypeType][T1]>]>(columnPath: [T1, T2]): FieldMap<ExtractApiItemType<ApiFields[ItemTypeType][T1]>>[T2] | undefined;
-    getDerivedValue<T1 extends ColumnIds[number], T2 extends keyof ApiFields[ExtractApiItemType<ApiFields[ItemTypeType][T1]>], T3 extends keyof ApiFields[ExtractApiItemType<ApiFields[ExtractApiItemType<ApiFields[ItemTypeType][T1]>][T2]>]>(columnPath: [T1, T2, T3]): FieldMap<ExtractApiItemType<ApiFields[ExtractApiItemType<ApiFields[ItemTypeType][T1]>][T2]>>[T3] | 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<T1 extends ColumnIds[number]>(columnPath: [T1]): FieldMap<ExtractApiItemType<ApiFields[ItemTypeType][T1]>> | undefined;
-    getDerivedValues<T1 extends ColumnIds[number], T2 extends keyof ApiFields[ExtractApiItemType<ApiFields[ItemTypeType][T1]>]>(columnPath: [T1, T2]): FieldMap<ExtractApiItemType<ApiFields[ExtractApiItemType<ApiFields[ItemTypeType][T1]>][T2]>> | undefined;
-    getDerivedValues<T1 extends ColumnIds[number], T2 extends keyof ApiFields[ExtractApiItemType<ApiFields[ItemTypeType][T1]>], T3 extends keyof ApiFields[ExtractApiItemType<ApiFields[ExtractApiItemType<ApiFields[ItemTypeType][T1]>][T2]>]>(columnPath: [T1, T2, T3]): FieldMap<ExtractApiItemType<ApiFields[ExtractApiItemType<ApiFields[ExtractApiItemType<ApiFields[ItemTypeType][T1]>][T2]>]>> | undefined;
-}
+import { ApiEnumItemType, ApiFields } from '@rentman/backend-types';
+import { CollectionResource, EntryParentNull, ExtractApiItemType, FieldMap, ItemEntry, ItemResourceFactory, PromiseInterface, ResponseColumnMap, TransactionCache } from '../internal';
+export declare type ChildCollectionResources = {
+    [ChildItemType in ApiEnumItemType]?: CollectionResource<ChildItemType>;
+};
+export declare type ChildCollectionResourcesNull = ChildCollectionResources | null;
+export declare class ItemResource<ItemTypeType extends ApiEnumItemType = any, ColumnIds extends Array<keyof ApiFields[ItemTypeType]> = Array<keyof ApiFields[ItemTypeType]>, Children extends ChildCollectionResourcesNull = any> {
+    protected readonly factory: ItemResourceFactory;
+    readonly entry: ItemEntry<ItemTypeType>;
+    protected readonly transaction: TransactionCache;
+    children: Children;
+    private readonly _isNew;
+    columns: ResponseColumnMap<ItemTypeType, ColumnIds>;
+    fields: FieldMap<ItemTypeType, ColumnIds>;
+    initial: Readonly<FieldMap<ItemTypeType, ColumnIds>>;
+    constructor(factory: ItemResourceFactory, entry: ItemEntry<ItemTypeType>, transaction: TransactionCache, children: Children, _isNew: boolean);
+    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: Partial<FieldMap<ItemTypeType, ColumnIds>>): PromiseInterface<this>;
+    copyFields(destination?: FieldMap<ItemTypeType, []>): FieldMap<ItemTypeType, ColumnIds>;
+    /**
+     * 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, ColumnIds>): 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: ColumnIds[number], previous: FieldMap<ItemTypeType, ColumnIds>): 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, ColumnIds>;
+        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<T1 extends string>(columnPath: T1): any | undefined;
+    getDerivedValue<T1 extends ColumnIds[number]>(columnPath: [T1]): FieldMap<ItemTypeType>[T1] | undefined;
+    getDerivedValue<T1 extends ColumnIds[number], T2 extends keyof ApiFields[ExtractApiItemType<ApiFields[ItemTypeType][T1]>]>(columnPath: [T1, T2]): FieldMap<ExtractApiItemType<ApiFields[ItemTypeType][T1]>>[T2] | undefined;
+    getDerivedValue<T1 extends ColumnIds[number], T2 extends keyof ApiFields[ExtractApiItemType<ApiFields[ItemTypeType][T1]>], T3 extends keyof ApiFields[ExtractApiItemType<ApiFields[ExtractApiItemType<ApiFields[ItemTypeType][T1]>][T2]>]>(columnPath: [T1, T2, T3]): FieldMap<ExtractApiItemType<ApiFields[ExtractApiItemType<ApiFields[ItemTypeType][T1]>][T2]>>[T3] | 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<T1 extends ColumnIds[number]>(columnPath: [T1]): FieldMap<ExtractApiItemType<ApiFields[ItemTypeType][T1]>> | undefined;
+    getDerivedValues<T1 extends ColumnIds[number], T2 extends keyof ApiFields[ExtractApiItemType<ApiFields[ItemTypeType][T1]>]>(columnPath: [T1, T2]): FieldMap<ExtractApiItemType<ApiFields[ExtractApiItemType<ApiFields[ItemTypeType][T1]>][T2]>> | undefined;
+    getDerivedValues<T1 extends ColumnIds[number], T2 extends keyof ApiFields[ExtractApiItemType<ApiFields[ItemTypeType][T1]>], T3 extends keyof ApiFields[ExtractApiItemType<ApiFields[ExtractApiItemType<ApiFields[ItemTypeType][T1]>][T2]>]>(columnPath: [T1, T2, T3]): FieldMap<ExtractApiItemType<ApiFields[ExtractApiItemType<ApiFields[ExtractApiItemType<ApiFields[ItemTypeType][T1]>][T2]>]>> | undefined;
+}

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

@@ -1,11 +1,11 @@
-import { ApiEnumItemType, ApiFields } from '@rentman/backend-types';
-import { ApiRequestColumnMap, ApiResponse, ColumnSet, FieldMap, ItemTypeMap, ResponseColumnItemTypeMap, TemplateFactory } from '../internal';
-export declare class Template<ItemTypeType extends ApiEnumItemType = any, ColumnIds extends Array<keyof ApiFields[ItemTypeType]> = any> {
-    itemType: ItemTypeType;
-    response: ApiResponse;
-    additionalRequestColumns: ApiRequestColumnMap;
-    responseColumns: ResponseColumnItemTypeMap;
-    columns: ColumnSet<ItemTypeType>;
-    constructor(factory: TemplateFactory, itemType: ItemTypeType, response: ApiResponse, additionalRequestColumns: ApiRequestColumnMap, additionalResponseColumns: ItemTypeMap<ResponseColumnItemTypeMap>);
-    getFields(): FieldMap<ItemTypeType, ColumnIds>;
-}
+import { ApiEnumItemType, ApiFields } from '@rentman/backend-types';
+import { ApiRequestColumnMap, ApiResponse, ColumnSet, FieldMap, ItemTypeMap, ResponseColumnItemTypeMap, TemplateFactory } from '../internal';
+export declare class Template<ItemTypeType extends ApiEnumItemType = any, ColumnIds extends Array<keyof ApiFields[ItemTypeType]> = any> {
+    itemType: ItemTypeType;
+    response: ApiResponse;
+    additionalRequestColumns: ApiRequestColumnMap;
+    responseColumns: ResponseColumnItemTypeMap;
+    columns: ColumnSet<ItemTypeType>;
+    constructor(factory: TemplateFactory, itemType: ItemTypeType, response: ApiResponse, additionalRequestColumns: ApiRequestColumnMap, additionalResponseColumns: ItemTypeMap<ResponseColumnItemTypeMap>);
+    getFields(): FieldMap<ItemTypeType, ColumnIds>;
+}