@azrico/webobject 1.3.4 → 1.3.6

package/dist/src/structs/SimpleObject.d.ts

@@ -0,0 +1,121 @@
+import { MapableObject } from "./MapableObject";
+import ObjectManager from "./ObjectManager";
+export type saveResultType = "normal" | "nothing" | "error" | "canceled";
+export type saveType = "normal" | "quick";
+export type sendChangesType = boolean | "auto";
+export type PropOf<obj> = keyof obj;
+export type WriteablePropOf<obj> = keyof obj;
+export type PropType<obj, prop extends keyof obj> = obj[prop];
+export declare class SimpleObject extends MapableObject {
+    #private;
+    static readonly __cache_name?: string;
+    static readonly __unchangeables?: string[];
+    static readonly __changeables?: string[];
+    static readonly __extraProperties?: string[];
+    static readonly __use_delta: boolean;
+    _static(): Function;
+    __originalobject?: this;
+    __delta: Partial<this>;
+    __temp: any;
+    __changed: boolean;
+    __lastChanged: string;
+    __is_readonly: boolean;
+    __throw_errors: boolean;
+    __errors?: any[];
+    __showErrors?: boolean;
+    __saveResultObject?: any;
+    __saveResultIsSuccess: boolean;
+    __saveResultType?: saveResultType;
+    _index_key: string;
+    _index_value: number;
+    constructor(is_readonly?: boolean);
+    loadValues(initObject: any, fullUpdate?: boolean): boolean;
+    static loadValues(obj: SimpleObject, initObject: any, fullUpdate?: boolean): boolean;
+    static getValue<T extends SimpleObject, MKey extends PropOf<T>>(o: T, key: MKey, original?: boolean): PropType<T, MKey> | undefined;
+    getValue: <MKey extends keyof this>(key: MKey, original?: boolean) => PropType<this, MKey>;
+    get: <MKey extends keyof this>(key: MKey, original?: boolean) => PropType<this, MKey>;
+    getTemp: (key: string) => any;
+    /**
+     * set value
+     * @param key
+     * @param value
+     * @return true if changed , false otherwise
+     */
+    setValue(key: WriteablePropOf<this>, value: any, sendChanges?: sendChangesType): Promise<boolean>;
+    set: (key: WriteablePropOf<this>, value: any, sendChanges?: sendChangesType) => Promise<boolean>;
+    setTemp: (key: string, value: any) => any;
+    setDefaultValue(key: WriteablePropOf<this>, value: any): boolean;
+    setDefault: (key: WriteablePropOf<this>, value: any) => boolean;
+    /**
+     * set key of subObject
+     * @param key
+     * @param value
+     * @param subvalue
+     * @return true if changed , false otherwise
+     */
+    setSubValue(key: PropOf<this>, objKey: string, subvalue: any, sendChanges?: sendChangesType): Promise<boolean>;
+    pushValue<MKey extends PropOf<this>>(key: MKey, value: any, sendChanges?: sendChangesType): Promise<this[MKey] | false>;
+    notifyChanged(type: string, key: string, value: any, subvalue?: any): Promise<void>;
+    static canChangeKey(object: SimpleObject, key: string, useExtraProps: boolean): boolean;
+    /**
+     * Apply the changes and empty the delta object
+     */
+    apply_changes(): boolean;
+    clear_changes(): boolean;
+    clear_cache(): boolean;
+    /**
+     * Sets readonly property on given objects
+     * @param objs array of given objects or a single object
+     * @param readonlyval readonly
+     * @param clearChanges should we clean the changes after setting readonly
+     */
+    static setReadonly(objs?: SimpleObject[] | SimpleObject, readonlyval?: boolean, clearChanges?: boolean): void;
+    static setThrowErrors(objs?: SimpleObject[] | SimpleObject, throwErr?: boolean): void;
+    get isChanged(): boolean;
+    get isDeleted(): boolean;
+    get d(): Partial<this>;
+    get allproperties(): this & Partial<this>;
+    get canModify(): boolean;
+    get __cache_name(): string;
+    get __changeables(): string[];
+    get __unchangeables(): string[];
+    get __use_delta(): boolean;
+    get isSaved(): boolean;
+    get isNew(): boolean;
+    get_lastChanged(): boolean;
+    get manager(): ObjectManager<any> | null;
+    get_managerClass: () => ObjectManager<any> | null;
+    static isDeleted<T extends SimpleObject>(obj: T): boolean;
+    getIndexOrID(): number | string;
+    getIndex(): number;
+    getID(): string;
+    static getIndexOrID(o: any): number;
+    static getIndex(o: any): number;
+    static getID(o: any): string;
+    getOriginal(): this | undefined;
+    setOriginal(toObj?: null | 0 | any): this | undefined;
+    static setOriginal<T>(obj: T, toObj?: null | 0 | any): T | undefined;
+    static getOriginal<T extends SimpleObject>(obj: T): T | undefined;
+    static addError(o?: SimpleObject, title?: string, message?: string, sendToRegister?: boolean | "auto"): any[] | undefined;
+    static getErrors(o: SimpleObject): any[];
+    static clearErrors(o: SimpleObject): boolean;
+    /**
+     * Checks if the given object is a valid and truthy save result
+     * @param result_object
+     * @returns
+     */
+    static isResultValid(result_object: any, sub?: boolean): any;
+    /**
+     * set the response of last save from site
+     * and its type
+     * @param toObj
+     */
+    setSaveResult(toObj: any, type: saveResultType | "auto"): void;
+    getSaveResult(original?: boolean): any;
+    getSaveResultType(): saveResultType;
+    static factoryClear(obj: SimpleObject): void;
+    static delete_cache(): void;
+    static get_canModify(o: SimpleObject): boolean;
+    static equals(a?: SimpleObject | any, b?: SimpleObject | any): boolean;
+}
+export default SimpleObject;