@rentman/rm-core 1.7.6 → 1.8.0

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

@@ -1,70 +1,76 @@
-import { ColumnSet } from '../classes';
-import { ItemEntryFactory } from '../factories';
-import { Deferred } from '../interfaces';
-import { ColumnExpansionResult, EntryParentNull, FieldMap, ItemError, ItemId, ItemIdConversionMap, ItemType, PromiseInterface } from '../types';
-export declare class ItemEntry<ItemTypeType extends ItemType = any> {
-    private factory;
-    itemType: ItemTypeType;
-    itemId: ItemId;
-    columns: ColumnSet<ItemTypeType>;
-    id: number;
-    reloadQueued: boolean;
-    deferRequest: boolean;
-    deferred?: Deferred<this>;
-    parent: EntryParentNull;
-    initial: FieldMap<ItemTypeType>;
-    modified: FieldMap<ItemTypeType>;
-    derived: FieldMap<ItemTypeType>;
-    constructor(factory: ItemEntryFactory, itemType: ItemTypeType, itemId: ItemId, columns: ColumnSet<ItemTypeType>);
-    private getResources;
-    queueReload(): this;
-    defer(deferRequest?: boolean): this;
-    getPromise(): PromiseInterface<this>;
-    resolve(): this;
-    resolveDeferred(initial: FieldMap, derived: FieldMap, columns: ColumnSet<ItemTypeType>): this;
-    isDeferred(): boolean;
-    reject(error?: ItemError): this;
-    setFields(initial: FieldMap<ItemTypeType>, derived: FieldMap): this;
-    setLocalFields(initialValues: FieldMap, conversionMap: ItemIdConversionMap, columns?: ColumnSet<ItemTypeType>): this;
-    clone(conversionMap?: ItemIdConversionMap): ItemEntry<ItemTypeType>;
-    resetDerived(columnIds: string[]): this;
-    getFields(): FieldMap<ItemTypeType>;
-    expand(main: FieldMap, derived: FieldMap, columnExpansionResult: ColumnExpansionResult<ItemTypeType>): this;
-    expandLocal(columnExpansionResult: ColumnExpansionResult<ItemTypeType>): this;
-    private setLocalValues;
-    /**
-     * This function assumes the initial, modified, derived properties are already set. It will update the values
-     * themselves to preserve references in existing item resources.
-     */
-    updateFields(fields: FieldMap<ItemTypeType>, derived?: FieldMap | null, overwrite?: boolean): this;
-    private updateItemValues;
-    updateItemFields(conversionMap: ItemIdConversionMap, columns?: ColumnSet<ItemTypeType>): this;
-    formatRequest(): FieldMap<ItemTypeType>;
-    setDisplayName(): this;
-    getDisplayName(): string;
-    /**
-     * @param {Boolean} returnAll Returns all initial values if true
-     * @returns {Object}
-     */
-    getChanges(returnAll?: boolean): FieldMap<any>;
-    isLocal(): boolean;
-    isLockable(): boolean;
-    hasChanges(): boolean;
-    resetModified(): this;
-    setInitial(values: FieldMap, enableCallbacks?: boolean): this;
-    /**
-     * Does a shallow copy of values!
-     */
-    setModified(values?: FieldMap<ItemTypeType>): this;
-    setDerived(values: FieldMap): this;
-    setParent(parentType: ItemType, parentId: ItemId): this;
-    callOnChange(previous?: FieldMap<ItemTypeType>): this;
-    toJSON(): {
-        id: number;
-        parent: EntryParentNull;
-        initial: FieldMap<ItemTypeType>;
-        modified: FieldMap<ItemTypeType>;
-        derived: FieldMap<ItemTypeType>;
-        columns: ColumnSet<ItemTypeType>;
-    };
-}
+import { ColumnSet } from '../classes';
+import { ItemEntryFactory } from '../factories';
+import { Deferred } from '../interfaces';
+import { ItemResource } from '../models';
+import { ColumnExpansionResult, EntryParentNull, FieldMap, ItemError, ItemId, ItemIdConversionMap, ItemType, PromiseInterface } from '../types';
+export declare class ItemEntry<ItemTypeType extends ItemType = any> {
+    private factory;
+    itemType: ItemTypeType;
+    itemId: ItemId;
+    columns: ColumnSet<ItemTypeType>;
+    id: number;
+    reloadQueued: boolean;
+    deferRequest: boolean;
+    deferred?: Deferred<this>;
+    parent: EntryParentNull;
+    initial: FieldMap<ItemTypeType>;
+    modified: FieldMap<ItemTypeType>;
+    derived: FieldMap<ItemTypeType>;
+    resources: Array<ItemResource<ItemTypeType>>;
+    constructor(factory: ItemEntryFactory, itemType: ItemTypeType, itemId: ItemId, columns: ColumnSet<ItemTypeType>);
+    queueReload(): this;
+    clearResource(resource: ItemResource): void;
+    clearResources(): void;
+    defer(deferRequest?: boolean): this;
+    getPromise(): PromiseInterface<this>;
+    resolve(): this;
+    resolveDeferred(initial: FieldMap, derived: FieldMap, columns: ColumnSet<ItemTypeType>): this;
+    isDeferred(): boolean;
+    reject(error?: ItemError): this;
+    setFields(initial: FieldMap<ItemTypeType>, derived: FieldMap): this;
+    setLocalFields(initialValues: FieldMap, conversionMap: ItemIdConversionMap, columns?: ColumnSet<ItemTypeType>): this;
+    clone(conversionMap?: ItemIdConversionMap): ItemEntry<ItemTypeType>;
+    resetDerived(columnIds: string[]): this;
+    getFields(): FieldMap<ItemTypeType>;
+    expand(main: FieldMap, derived: FieldMap, columnExpansionResult: ColumnExpansionResult<ItemTypeType>): this;
+    expandLocal(columnExpansionResult: ColumnExpansionResult<ItemTypeType>): this;
+    private setLocalValues;
+    /**
+     * @description
+     * Updates the {@link ItemEntry.initial initial}, {@link ItemEntry.modified modified} and {@link ItemEntry.derived derived} properties in-place to preserve references in existing {@link ItemResource ItemResources}.
+     *
+     * @remarks
+     * - Assumes the {@link ItemEntry.initial initial}, {@link ItemEntry.modified modified} and {@link ItemEntry.derived derived} properties are already set.
+     */
+    updateFields(fields: FieldMap<ItemTypeType>, derived?: FieldMap | null, overwrite?: boolean): this;
+    private updateItemValues;
+    updateItemFields(conversionMap: ItemIdConversionMap, columns?: ColumnSet<ItemTypeType>): this;
+    formatRequest(): FieldMap<ItemTypeType>;
+    setDisplayName(): this;
+    getDisplayName(): string;
+    /**
+     * @param returnAll Returns all initial values if true
+     */
+    getChanges(returnAll?: boolean): FieldMap<any>;
+    isLocal(): boolean;
+    isLockable(): boolean;
+    hasChanges(): boolean;
+    resetModified(): this;
+    setInitial(values: FieldMap, enableCallbacks?: boolean): this;
+    /**
+     * @remarks
+     * - Does a shallow copy of values!
+     */
+    setModified(values?: FieldMap<ItemTypeType>): this;
+    setDerived(values: FieldMap): this;
+    setParent(parentType: ItemType, parentId: ItemId): this;
+    callOnChange(previous?: FieldMap<ItemTypeType>): this;
+    toJSON(): {
+        id: number;
+        parent: EntryParentNull;
+        initial: FieldMap<ItemTypeType>;
+        modified: FieldMap<ItemTypeType>;
+        derived: FieldMap<ItemTypeType>;
+        columns: ColumnSet<ItemTypeType>;
+    };
+}

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

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

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

@@ -1,27 +1,45 @@
-import { LocalCache } from '../classes';
-import { ItemResourceFactory } from '../factories';
-import { ItemEntry, ItemResourceOptions } from '../models';
-import { FieldMap, ItemType, ResponseColumn } from '../types';
-export declare abstract class ItemResource<ItemTypeType extends ItemType = any> {
-    protected readonly factory: ItemResourceFactory;
-    readonly entry: ItemEntry<ItemTypeType>;
-    readonly options: ItemResourceOptions<ItemResource<ItemTypeType>>;
-    protected readonly _isNew: boolean;
-    protected readonly localCache: LocalCache | null;
-    columns: {
-        [columnId: string]: ResponseColumn;
-    };
-    fields: FieldMap<ItemTypeType>;
-    derived: FieldMap<ItemTypeType>;
-    protected constructor(factory: ItemResourceFactory, entry: ItemEntry<ItemTypeType>, options: ItemResourceOptions<ItemResource<ItemTypeType>>, _isNew: boolean, localCache: LocalCache | null);
-    isNew(): boolean;
-    isLocal(): boolean;
-    clearResource(): void;
-    deactivate(): void;
-    toJSON(): {
-        columns: string[];
-        fields: FieldMap<ItemTypeType>;
-        derived: FieldMap<ItemTypeType>;
-        entry: ItemEntry<ItemTypeType>;
-    };
-}
+import { LocalCache } from '../classes';
+import { ItemResourceFactory } from '../factories';
+import { ItemEntry, ItemResourceOptions } from '../models';
+import { FieldMap, ItemType, ResponseColumn } from '../types';
+export declare abstract class ItemResource<ItemTypeType extends ItemType = any> {
+    protected readonly factory: ItemResourceFactory;
+    readonly entry: ItemEntry<ItemTypeType>;
+    readonly options: ItemResourceOptions<ItemResource<ItemTypeType>>;
+    protected readonly _isNew: boolean;
+    protected readonly localCache: LocalCache | null;
+    columns: {
+        [columnId: string]: ResponseColumn;
+    };
+    fields: FieldMap<ItemTypeType>;
+    derived: FieldMap<ItemTypeType>;
+    protected constructor(factory: ItemResourceFactory, entry: ItemEntry<ItemTypeType>, options: ItemResourceOptions<ItemResource<ItemTypeType>>, _isNew: boolean, localCache: LocalCache | null);
+    onConstruct(): 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;
+    /**
+     * @description
+     * Removes the reference to the {@link ItemResource ItemResource} from the {@link ItemEntry ItemEntry}
+     *
+     * Warning:
+     * This doesn't revert any changes made to the item, in order to revert the changes you should use {@link EditResource.start start} and {@link EditResource.rollback rollback}.
+     */
+    clearResource(): void;
+    /**
+     * @deprecated
+     *
+     * @remarks
+     * - Does *not* clear resources
+     */
+    deactivate(): void;
+    toJSON(): {
+        columns: string[];
+        fields: FieldMap<ItemTypeType>;
+        derived: FieldMap<ItemTypeType>;
+        entry: ItemEntry<ItemTypeType>;
+    };
+}

package/dist/src/models/ItemResourceOptions.d.ts

@@ -1,9 +1,9 @@
-import { OnChangeFunction } from '../types';
-import { ItemResource } from './ItemResource';
-export declare type ItemResourceOptionsInterface<ItemResourceType extends ItemResource<any> = ItemResource<any>> = Partial<ItemResourceOptions<ItemResourceType>>;
-export declare class ItemResourceOptions<ItemResourceType extends ItemResource<any> = ItemResource<any>> {
-    edit: boolean;
-    remote: boolean;
-    onChange: OnChangeFunction<ItemResourceType>;
-    constructor(values: ItemResourceOptionsInterface<ItemResourceType>);
-}
+import { OnChangeFunction } from '../types';
+import { ItemResource } from './ItemResource';
+export declare type ItemResourceOptionsInterface<ItemResourceType extends ItemResource<any> = ItemResource<any>> = Partial<ItemResourceOptions<ItemResourceType>>;
+export declare class ItemResourceOptions<ItemResourceType extends ItemResource<any> = ItemResource<any>> {
+    edit: boolean;
+    remote: boolean;
+    onChange: OnChangeFunction<ItemResourceType>;
+    constructor(values: ItemResourceOptionsInterface<ItemResourceType>);
+}

package/dist/src/models/LocalViewResource.d.ts

@@ -1,7 +1,7 @@
-import { LocalCache } from '../classes';
-import { ItemResourceFactory } from '../factories';
-import { ItemEntry, ItemResourceOptions, ViewResource } from '../models';
-import { ItemType } from '../types';
-export declare class LocalViewResource<ItemTypeType extends ItemType = any> extends ViewResource<ItemTypeType> {
-    constructor(factory: ItemResourceFactory, entry: ItemEntry<ItemTypeType>, options: ItemResourceOptions, isNew: boolean, localCache: LocalCache | null);
-}
+import { LocalCache } from '../classes';
+import { ItemResourceFactory } from '../factories';
+import { ItemEntry, ItemResourceOptions, ViewResource } from '../models';
+import { ItemType } from '../types';
+export declare class LocalViewResource<ItemTypeType extends ItemType = any> extends ViewResource<ItemTypeType> {
+    constructor(factory: ItemResourceFactory, entry: ItemEntry<ItemTypeType>, options: ItemResourceOptions, isNew: boolean, localCache: LocalCache | null);
+}

package/dist/src/models/RemoteViewResource.d.ts

@@ -1,7 +1,7 @@
-import { LocalCache } from '../classes';
-import { ItemResourceFactory } from '../factories';
-import { ItemEntry, ItemResourceOptions, ViewResource } from '../models';
-import { ItemType } from '../types';
-export declare class RemoteViewResource<ItemTypeType extends ItemType = any> extends ViewResource<ItemTypeType> {
-    constructor(factory: ItemResourceFactory, entry: ItemEntry<ItemTypeType>, options: ItemResourceOptions<RemoteViewResource<ItemTypeType>>, isNew: boolean, localCache: LocalCache | null);
-}
+import { LocalCache } from '../classes';
+import { ItemResourceFactory } from '../factories';
+import { ItemEntry, ItemResourceOptions, ViewResource } from '../models';
+import { ItemType } from '../types';
+export declare class RemoteViewResource<ItemTypeType extends ItemType = any> extends ViewResource<ItemTypeType> {
+    constructor(factory: ItemResourceFactory, entry: ItemEntry<ItemTypeType>, options: ItemResourceOptions<RemoteViewResource<ItemTypeType>>, isNew: boolean, localCache: LocalCache | null);
+}

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

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

package/dist/src/models/ViewResource.d.ts

@@ -1,8 +1,8 @@
-import { LocalCache } from '../classes';
-import { ItemResourceFactory } from '../factories';
-import { ItemEntry, ItemResource, ItemResourceOptions } from '../models';
-import { FieldMap, ItemType } from '../types';
-export declare abstract class ViewResource<ItemTypeType extends ItemType = any> extends ItemResource<ItemTypeType> {
-    fields: Readonly<FieldMap<ItemTypeType>>;
-    protected constructor(factory: ItemResourceFactory, entry: ItemEntry<ItemTypeType>, options: ItemResourceOptions<ViewResource<ItemTypeType>>, isNew: boolean, localCache: LocalCache | null);
-}
+import { LocalCache } from '../classes';
+import { ItemResourceFactory } from '../factories';
+import { ItemEntry, ItemResource, ItemResourceOptions } from '../models';
+import { FieldMap, ItemType } from '../types';
+export declare abstract class ViewResource<ItemTypeType extends ItemType = any> extends ItemResource<ItemTypeType> {
+    fields: Readonly<FieldMap<ItemTypeType>>;
+    protected constructor(factory: ItemResourceFactory, entry: ItemEntry<ItemTypeType>, options: ItemResourceOptions<ViewResource<ItemTypeType>>, isNew: boolean, localCache: LocalCache | null);
+}

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

@@ -1,15 +1,15 @@
-export * from './ItemEntryOptions';
-export * from './ItemResourceOptions';
-export * from './ItemEntry';
-export * from './ItemResource';
-export * from './ViewResource';
-export * from './EditResource';
-export * from './CollectionEntryOptions';
-export * from './CollectionResourceOptions';
-export * from './CollectionEntry';
-export * from './CollectionResource';
-export * from './CollectionViewResource';
-export * from './CollectionEditResource';
-export * from './Template';
-export * from './RemoteViewResource';
-export * from './LocalViewResource';
+export * from './ItemEntryOptions';
+export * from './ItemResourceOptions';
+export * from './ItemEntry';
+export * from './ItemResource';
+export * from './ViewResource';
+export * from './EditResource';
+export * from './CollectionEntryOptions';
+export * from './CollectionResourceOptions';
+export * from './CollectionEntry';
+export * from './CollectionResource';
+export * from './CollectionViewResource';
+export * from './CollectionEditResource';
+export * from './Template';
+export * from './RemoteViewResource';
+export * from './LocalViewResource';