@azrico/webobject 1.5.58 → 1.5.59

package/dist/index.d.ts

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

package/dist/index.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _index = require("./src/index");
+Object.keys(_index).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _index[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _index[key];
+    }
+  });
+});

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,121 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = exports.ParentWebObject = void 0;
+var _WebObject2 = _interopRequireDefault(require("./WebObject"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstructorReturn(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], _getPrototypeOf(t).constructor) : o.apply(t, e)); }
+function _possibleConstructorReturn(t, e) { if (e && ("object" == _typeof(e) || "function" == typeof e)) return e; if (void 0 !== e) throw new TypeError("Derived constructors may only return object or undefined"); return _assertThisInitialized(t); }
+function _assertThisInitialized(e) { if (void 0 === e) throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); return e; }
+function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
+function _getPrototypeOf(t) { return _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf.bind() : function (t) { return t.__proto__ || Object.getPrototypeOf(t); }, _getPrototypeOf(t); }
+function _inherits(t, e) { if ("function" != typeof e && null !== e) throw new TypeError("Super expression must either be null or a function"); t.prototype = Object.create(e && e.prototype, { constructor: { value: t, writable: !0, configurable: !0 } }), Object.defineProperty(t, "prototype", { writable: !1 }), e && _setPrototypeOf(t, e); }
+function _setPrototypeOf(t, e) { return _setPrototypeOf = Object.setPrototypeOf ? Object.setPrototypeOf.bind() : function (t, e) { return t.__proto__ = e, t; }, _setPrototypeOf(t, e); }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+/**
+ * This web object contains some more webobjects
+ */
+var ParentWebObject = exports.ParentWebObject = /*#__PURE__*/function (_WebObject) {
+  function ParentWebObject() {
+    var _this;
+    var is_readonly = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
+    _classCallCheck(this, ParentWebObject);
+    _this = _callSuper(this, ParentWebObject, [is_readonly]);
+    _defineProperty(_this, "__children", undefined);
+    return _this;
+  }
+  _inherits(ParentWebObject, _WebObject);
+  return _createClass(ParentWebObject, [{
+    key: "set_children",
+    value: function set_children(val) {
+      if (Array.isArray(val)) {
+        var selftableid = this.__table_id;
+        val.forEach(function (v) {
+          v.__parent__table_id = selftableid;
+        });
+      } else val = [];
+      this.__children = val;
+    }
+  }], [{
+    key: "getParentTableId",
+    value: function getParentTableId(obj) {
+      var _ref, _ref2, _obj$__parent__table_;
+      return (_ref = (_ref2 = (_obj$__parent__table_ = obj.__parent__table_id) !== null && _obj$__parent__table_ !== void 0 ? _obj$__parent__table_ : obj.parent_id) !== null && _ref2 !== void 0 ? _ref2 : obj.parent) !== null && _ref !== void 0 ? _ref : obj.parentid;
+    }
+  }, {
+    key: "getTableId",
+    value: function getTableId(obj) {
+      var _obj$__table_id;
+      return (_obj$__table_id = obj.__table_id) !== null && _obj$__table_id !== void 0 ? _obj$__table_id : obj._id;
+    }
+  }, {
+    key: "fixChildParentRelations",
+    value: function fixChildParentRelations(rows) {
+      var _this2 = this;
+      if (!Array.isArray(rows)) rows = [];
+      var anyparentid = rows.find(function (r) {
+        return _this2.getParentTableId(r);
+      });
+      var anyselfid = rows.find(function (r) {
+        return _this2.getTableId(r);
+      });
+      if (!anyparentid || !anyselfid) return rows;
+      var converted_rows = rows.filter(function (r) {
+        return r != null;
+      }).map(function (r) {
+        return {
+          parent: _this2.getParentTableId(r),
+          self: _this2.getTableId(r),
+          data: r
+        };
+      });
+      var top_level_rows = converted_rows.filter(function (r) {
+        return !r.parent;
+      });
+      var any_child = converted_rows.find(function (r) {
+        return Boolean(r.parent);
+      });
+      if (any_child) {
+        //find children of top-level parents:
+        for (var index = 0; index < top_level_rows.length; index++) {
+          var mrow = top_level_rows[index];
+          this.assignChildren(mrow, converted_rows);
+        }
+      }
+      return top_level_rows.map(function (r) {
+        return r.data;
+      });
+    }
+    /**
+     * assign children of row based on all_rows
+     * @param row
+     * @param all_rows
+     */
+  }, {
+    key: "assignChildren",
+    value: function assignChildren(row, all_rows) {
+      var my_children = all_rows.filter(function (s) {
+        return row.self == s.parent;
+      });
+      if (my_children.length > 0) {
+        //find children of my children:
+        for (var index = 0; index < my_children.length; index++) {
+          var child = my_children[index];
+          this.assignChildren(child, all_rows);
+        }
+        row.data.__children = my_children.map(function (r) {
+          return r.data;
+        });
+      } else if (!Array.isArray(row.data.__children) || row.data.__children.length == 0) row.data.__children = undefined;
+    }
+  }]);
+}(_WebObject2["default"]);
+var _default = exports["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;