@rentman/rm-core 1.4.0 → 1.5.0

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

@@ -1,71 +1,71 @@
-import { ColumnSet } from '../classes';
-import { ItemEntryFactory } from '../factories';
-import { ItemResource } from '../models';
-import { ColumnExpansionResult, EntryParentNull, FieldMap, ItemId, ItemIdConversionMap, ItemType } from '../types';
-export declare class ItemEntry {
-    private factory;
-    itemType: string;
-    itemId: ItemId;
-    columns: ColumnSet;
-    id: number;
-    reloadQueued: boolean;
-    deferRequest: boolean;
-    deferred: any;
-    parent: EntryParentNull;
-    initial: FieldMap;
-    modified: FieldMap;
-    derived: FieldMap;
-    resources: ItemResource[];
-    constructor(factory: ItemEntryFactory, itemType: string, itemId: ItemId, columns: ColumnSet);
-    queueReload(): this;
-    defer(deferRequest?: boolean): this;
-    resolve(): this;
-    resolveDeferred(initial: any, derived: any, columns: any): this;
-    isDeferred(): boolean;
-    reject(error?: any): this;
-    setFields(initial: FieldMap, derived: FieldMap): this;
-    setLocalFields(initialValues: FieldMap, conversionMap: ItemIdConversionMap, columns?: ColumnSet): this;
-    clone(conversionMap?: ItemIdConversionMap): ItemEntry;
-    resetDerived(columnIds: any): this;
-    clearResources(): this;
-    deactivateResources(): this;
-    getFields(): FieldMap;
-    expand(main: FieldMap, derived: FieldMap, columnExpansionResult: ColumnExpansionResult): this;
-    expandLocal(columnExpansionResult: ColumnExpansionResult): this;
-    private setLocalValues(fields, columns);
-    /**
-     * 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, derived?: FieldMap | null, overwrite?: boolean): this;
-    private updateItemValues(fields, itemColumns, conversionMap);
-    updateItemFields(conversionMap: ItemIdConversionMap, columns?: ColumnSet): this;
-    formatRequest(): FieldMap;
-    setDisplayName(): this;
-    getDisplayName(): string;
-    /**
-     * @param {Boolean} returnAll Returns all initial values if true
-     * @returns {Object}
-     */
-    getChanges(returnAll?: boolean): FieldMap;
-    isLocal(): boolean;
-    isLockable(): boolean;
-    hasChanges(): boolean;
-    resetModified(): this;
-    setInitial(values: FieldMap, enableCallbacks?: boolean): this;
-    /**
-     * Does a shallow copy of values!
-     */
-    setModified(values?: FieldMap): this;
-    setDerived(values: FieldMap): this;
-    setParent(parentType: ItemType, parentId: ItemId): this;
-    callOnChange(previous: FieldMap): this;
-    toJSON(): {
-        id: number;
-        parent: EntryParentNull;
-        initial: FieldMap;
-        modified: FieldMap;
-        derived: FieldMap;
-        columns: ColumnSet;
-    };
-}
+import { ColumnSet } from '../classes';
+import { ItemEntryFactory } from '../factories';
+import { ItemResource } from '../models';
+import { ColumnExpansionResult, EntryParentNull, FieldMap, ItemId, ItemIdConversionMap, ItemType } from '../types';
+export declare class ItemEntry {
+    private factory;
+    itemType: string;
+    itemId: ItemId;
+    columns: ColumnSet;
+    id: number;
+    reloadQueued: boolean;
+    deferRequest: boolean;
+    deferred: any;
+    parent: EntryParentNull;
+    initial: FieldMap;
+    modified: FieldMap;
+    derived: FieldMap;
+    resources: ItemResource[];
+    constructor(factory: ItemEntryFactory, itemType: string, itemId: ItemId, columns: ColumnSet);
+    queueReload(): this;
+    defer(deferRequest?: boolean): this;
+    resolve(): this;
+    resolveDeferred(initial: any, derived: any, columns: any): this;
+    isDeferred(): boolean;
+    reject(error?: any): this;
+    setFields(initial: FieldMap, derived: FieldMap): this;
+    setLocalFields(initialValues: FieldMap, conversionMap: ItemIdConversionMap, columns?: ColumnSet): this;
+    clone(conversionMap?: ItemIdConversionMap): ItemEntry;
+    resetDerived(columnIds: any): this;
+    clearResources(): this;
+    deactivateResources(): this;
+    getFields(): FieldMap;
+    expand(main: FieldMap, derived: FieldMap, columnExpansionResult: ColumnExpansionResult): this;
+    expandLocal(columnExpansionResult: ColumnExpansionResult): this;
+    private setLocalValues(fields, columns);
+    /**
+     * 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, derived?: FieldMap | null, overwrite?: boolean): this;
+    private updateItemValues(fields, itemColumns, conversionMap);
+    updateItemFields(conversionMap: ItemIdConversionMap, columns?: ColumnSet): this;
+    formatRequest(): FieldMap;
+    setDisplayName(): this;
+    getDisplayName(): string;
+    /**
+     * @param {Boolean} returnAll Returns all initial values if true
+     * @returns {Object}
+     */
+    getChanges(returnAll?: boolean): FieldMap;
+    isLocal(): boolean;
+    isLockable(): boolean;
+    hasChanges(): boolean;
+    resetModified(): this;
+    setInitial(values: FieldMap, enableCallbacks?: boolean): this;
+    /**
+     * Does a shallow copy of values!
+     */
+    setModified(values?: FieldMap): this;
+    setDerived(values: FieldMap): this;
+    setParent(parentType: ItemType, parentId: ItemId): this;
+    callOnChange(previous: FieldMap): this;
+    toJSON(): {
+        id: number;
+        parent: EntryParentNull;
+        initial: FieldMap;
+        modified: FieldMap;
+        derived: FieldMap;
+        columns: ColumnSet;
+    };
+}

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

@@ -0,0 +1,18 @@
+import { ApiRequestColumnMap, ApiRequestColumns, EntryParentNull, OptionsInterface } from '../types';
+export declare abstract class ItemEntryOptionsInterface implements OptionsInterface {
+    columns?: ApiRequestColumns;
+    parent?: EntryParentNull;
+    templateOptions?: any;
+    templateColumns?: ApiRequestColumnMap;
+    deferRequest?: boolean;
+    isDuplicate?: boolean;
+}
+export declare class ItemEntryOptions extends ItemEntryOptionsInterface {
+    columns: any;
+    parent: any;
+    templateOptions: any;
+    templateColumns: any;
+    deferRequest: any;
+    isDuplicate: any;
+    constructor(values: ItemEntryOptionsInterface);
+}

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

@@ -1,23 +1,23 @@
-import { ItemEntry } from '../models';
-import { FieldMap, ResponseColumn } from '../types';
-export declare class ItemResource {
-    entry: ItemEntry;
-    options: any;
-    protected readonly _isNew: boolean;
-    columns: {
-        [columnId: string]: ResponseColumn;
-    };
-    fields: FieldMap;
-    derived: FieldMap;
-    constructor(entry: ItemEntry, options: any, _isNew?: boolean);
-    isNew(): boolean;
-    isLocal(): boolean;
-    clearResource(): void;
-    deactivate(): void;
-    toJSON(): {
-        columns: string[];
-        fields: FieldMap;
-        derived: FieldMap;
-        entry: ItemEntry;
-    };
-}
+import { ItemEntry, ItemResourceOptions } from '../models';
+import { FieldMap, ResponseColumn } from '../types';
+export declare class ItemResource {
+    entry: ItemEntry;
+    options: ItemResourceOptions;
+    protected readonly _isNew: boolean;
+    columns: {
+        [columnId: string]: ResponseColumn;
+    };
+    fields: FieldMap;
+    derived: FieldMap;
+    constructor(entry: ItemEntry, options: ItemResourceOptions, _isNew?: boolean);
+    isNew(): boolean;
+    isLocal(): boolean;
+    clearResource(): void;
+    deactivate(): void;
+    toJSON(): {
+        columns: string[];
+        fields: FieldMap;
+        derived: FieldMap;
+        entry: ItemEntry;
+    };
+}

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

@@ -0,0 +1,13 @@
+import { ItemEntry } from '../models';
+import { ItemOptionsInterface, OnChangeFunction } from '../types';
+export declare abstract class ItemResourceOptionsInterface implements ItemOptionsInterface {
+    edit?: boolean;
+    onChange?: OnChangeFunction;
+    onDeactivate?: (itemEntry: ItemEntry) => void;
+}
+export declare class ItemResourceOptions extends ItemResourceOptionsInterface {
+    edit: any;
+    onChange: any;
+    onDeactivate: any;
+    constructor(values: ItemResourceOptionsInterface);
+}

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 {
-    itemType: ItemType;
-    response: ApiResponse;
-    fields: FieldMap;
-    responseColumns: ResponseColumnMap;
-    columns: ColumnSet;
-    constructor(factory: TemplateFactory, itemType: ItemType, response: ApiResponse, additionalColumns: ResponseColumnMap);
-}
+import { ColumnSet } from '../classes';
+import { TemplateFactory } from '../factories';
+import { ApiResponse, FieldMap, ItemType, ResponseColumnMap } from '../types';
+export declare class Template {
+    itemType: ItemType;
+    response: ApiResponse;
+    fields: FieldMap;
+    responseColumns: ResponseColumnMap;
+    columns: ColumnSet;
+    constructor(factory: TemplateFactory, itemType: ItemType, response: ApiResponse, additionalColumns: ResponseColumnMap);
+}

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

@@ -1,4 +1,4 @@
-import { ItemEntry, ItemResource } from '../models';
-export declare class ViewResource extends ItemResource {
-    constructor(entry: ItemEntry, options: any, isNew?: boolean);
-}
+import { ItemEntry, ItemResource, ItemResourceOptions } from '../models';
+export declare class ViewResource extends ItemResource {
+    constructor(entry: ItemEntry, options: ItemResourceOptions, isNew?: boolean);
+}

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

@@ -1,9 +1,13 @@
-export * from './CollectionEntry';
-export * from './CollectionResource';
-export * from './CollectionViewResource';
-export * from './CollectionEditResource';
-export * from './ItemEntry';
-export * from './ItemResource';
-export * from './ViewResource';
-export * from './EditResource';
-export * from './Template';
+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';