@azrico/webobject 1.5.58 → 1.5.61

package/README.md

@@ -1,9 +1,9 @@
-# deus-object
-
-> Some useful object functions
-
-## Install
-
-```bash
-yarn add @azrico/webobject
-```
+# deus-object
+
+> Some useful object functions
+
+## Install
+
+```bash
+yarn add @azrico/webobject
+```

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from "./src/index";

package/dist/index.js

@@ -0,0 +1 @@
+export * from "./src/index";

package/dist/src/WebObjects/ParentWebObject.d.ts

@@ -0,0 +1,24 @@
+import WebObject from "./WebObject";
+type mrow = {
+    __parent__table_id: any;
+    __table_id: any;
+    __children?: any[];
+};
+/**
+ * This web object contains some more webobjects
+ */
+export declare class ParentWebObject extends WebObject {
+    constructor(is_readonly?: boolean);
+    __children: WebObject[] | undefined;
+    set_children(val: WebObject[] | undefined): void;
+    private static getParentTableId;
+    private static getTableId;
+    static fixChildParentRelations<T extends mrow>(rows: T[]): T[];
+    /**
+     * assign children of row based on all_rows
+     * @param row
+     * @param all_rows
+     */
+    private static assignChildren;
+}
+export default ParentWebObject;

package/dist/src/WebObjects/ParentWebObject.js

@@ -0,0 +1,77 @@
+import WebObject from "./WebObject";
+/**
+ * This web object contains some more webobjects
+ */
+export class ParentWebObject extends WebObject {
+    constructor(is_readonly = false) {
+        super(is_readonly);
+    }
+    __children = undefined;
+    set_children(val) {
+        if (Array.isArray(val)) {
+            const selftableid = this.__table_id;
+            val.forEach((v) => {
+                v.__parent__table_id = selftableid;
+            });
+        }
+        else
+            val = [];
+        this.__children = val;
+    }
+    static getParentTableId(obj) {
+        return (obj.__parent__table_id ??
+            obj.parent_id ??
+            obj.parent ??
+            obj.parentid);
+    }
+    static getTableId(obj) {
+        return obj.__table_id ?? obj._id;
+    }
+    static fixChildParentRelations(rows) {
+        if (!Array.isArray(rows))
+            rows = [];
+        const anyparentid = rows.find((r) => this.getParentTableId(r));
+        const anyselfid = rows.find((r) => this.getTableId(r));
+        if (!anyparentid || !anyselfid)
+            return rows;
+        const converted_rows = rows
+            .filter((r) => r != null)
+            .map((r) => {
+            return {
+                parent: this.getParentTableId(r),
+                self: this.getTableId(r),
+                data: r,
+            };
+        });
+        const top_level_rows = converted_rows.filter((r) => !r.parent);
+        const any_child = converted_rows.find((r) => Boolean(r.parent));
+        if (any_child) {
+            //find children of top-level parents:
+            for (let index = 0; index < top_level_rows.length; index++) {
+                const mrow = top_level_rows[index];
+                this.assignChildren(mrow, converted_rows);
+            }
+        }
+        return top_level_rows.map((r) => r.data);
+    }
+    /**
+     * assign children of row based on all_rows
+     * @param row
+     * @param all_rows
+     */
+    static assignChildren(row, all_rows) {
+        const my_children = all_rows.filter((s) => row.self == s.parent);
+        if (my_children.length > 0) {
+            //find children of my children:
+            for (let index = 0; index < my_children.length; index++) {
+                const child = my_children[index];
+                this.assignChildren(child, all_rows);
+            }
+            row.data.__children = my_children.map((r) => r.data);
+        }
+        else if (!Array.isArray(row.data.__children) ||
+            row.data.__children.length == 0)
+            row.data.__children = undefined;
+    }
+}
+export default ParentWebObject;

package/dist/src/WebObjects/WebObject.d.ts

@@ -0,0 +1,153 @@
+import { SimpleObject, deltaParams, sendChangesType } from "../index";
+import { WebObjectManager } from "../index";
+export type ObjectWithUsers = Partial<{
+    _creator: string;
+    _users: string[];
+    attentions: string[];
+}>;
+export declare class WebObject extends SimpleObject {
+    static readonly __web_path: string;
+    static readonly __protectedProperties: string[];
+    static readonly __requiredProperties: never[];
+    meta_data: {
+        [key: string]: any;
+    };
+    _created_date?: string | Date;
+    _creator?: string;
+    _users?: string[];
+    constructor(is_readonly?: boolean);
+    /**
+     * get a list of all user ids that work on the given object
+     * _creator + _users + attentions(old)
+     * removes duplicates
+     * @returns array of ids
+     */
+    getAllUsers(): string[];
+    /**
+     * get a unique list of all user ids that work on the given object
+     * `_creator + _users + attentions`
+     * @returns array of ids
+     */
+    static getAllUsers(obj: ObjectWithUsers): string[];
+    /**
+     * Update meta value of this object , meta data is stored in meta_data variable
+     * @param key
+     * @param value
+     * @param sendChange
+     * @returns
+     */
+    setMetaValue(key: string, value: any, sendChange?: sendChangesType): Promise<boolean>;
+    /**
+     * Get meta value by key
+     * @param key
+     * @returns value or undefined
+     */
+    getMetaValue(key: string): any;
+    /**
+     * Get meta value by key
+     * @param o
+     * @param key
+     * @returns value or undefined
+     */
+    static getMetaValue(o: WebObject | null | undefined, key: string): any | undefined;
+    static zipSaveList(svlist: any): string;
+    static unzipSaveList(svlist: any): any[];
+    static saveList(itemList: WebObject[], extraOptions?: {
+        [key: string]: any;
+    }): Promise<boolean>;
+    Save(): Promise<any>;
+    Delete(): Promise<any>;
+    Lock(): Promise<any>;
+    UnLock(): Promise<any>;
+    Archive(): Promise<any>;
+    UnArchive(): Promise<any>;
+    canSave(deltaObj?: any): true | string;
+    canDelete(): boolean;
+    canArchive(): boolean;
+    deltaIsValid(d: any): true | string;
+    /**
+     * converts this object to an basic object
+     * that can be passed into client components from server components
+     *
+     * uses `get_fullDeltaObject`
+     * @param p
+     * @returns
+     */
+    get_basicObject(): Promise<Partial<this>>;
+    /**
+     * calls the `get_deltaObject` with
+     * `allProperties` `extraProperties`
+     * set to true
+     *
+     * @returns
+     */
+    get_fullDeltaObject(p?: deltaParams): Promise<any>;
+    /**
+     * calls the `get_deltaObject` with
+     * `allProperties` `extraProperties` `tempProperties`
+     * set to true
+     *
+     * @returns
+     */
+    get_fullObject(p?: deltaParams): Promise<any>;
+    /**
+     * You will post this to the server for saving
+     * automatically removes unchangeable fields
+     * @returns
+     */
+    get_deltaObject(p?: deltaParams): Promise<any>;
+    get manager(): WebObjectManager<any> | undefined;
+    get __web_path(): string;
+    get_webpath(): string;
+    static get_webpath(): string;
+    static get_dbname(): string;
+    onDelete(...p: any): Promise<any>;
+    onArchive(...p: any): Promise<any>;
+    onUnArchive(...p: any): Promise<any>;
+    onLock(...p: any): Promise<any>;
+    onUnLock(...p: any): Promise<any>;
+    onLoad(...p: any): Promise<any>;
+    onSave(...p: any): Promise<any>;
+    onAfterSave(...p: any): Promise<any>;
+    getSaveResult(original?: boolean): any;
+    onNew(...p: any): Promise<any>;
+    saveResultHasID(s: any): any;
+    static saveResultHasID(s: any): any;
+    /**
+     * Load Id and _index_value from the given save result into our object
+     * @param o
+     * @param srObject
+     * @returns
+     */
+    static LoadIdsFromSaveResult(o: WebObject, srObject: any): void;
+    /**
+     * get a single web object
+     * default order of parameters : search,readonly,fetchID
+     */
+    static get_single(...p: any[]): Promise<WebObject | any | undefined>;
+    /**
+     * Get a list of web objects
+     * default order of parameters : search,readonly,fetchID
+     */
+    static get_list(...p: any[]): Promise<Array<WebObject | any>>;
+    /**
+     * uses `get_list` and then saves the result to `gcache`
+     * then uses the `equals` function to return matched results
+     * @param search
+     * @returns
+     */
+    static get_list_cache(search?: any): Promise<Array<WebObject>>;
+    /**
+     * uses `get_list_cache` then the `equals` function to return matched result
+     * @param search
+     * @returns
+     */
+    static get_single_cache(search: any): Promise<WebObject | undefined>;
+    /**
+     * Get a list of web objects and convert them to basic objects
+     * can be passed to client components
+     * default order of parameters : search,readonly,fetchID
+     */
+    static get_basicList(...p: any[]): Promise<any[]>;
+}
+export default WebObject;