@questwork/q-utilities 0.1.13 → 0.1.14

package/dist/q-utilities.min.js

@@ -58,6 +58,7 @@ __webpack_require__.d(__webpack_exports__, {
   TenantAwareEntity: () => (/* reexport */ TenantAwareEntity),
   TrackedEntity: () => (/* reexport */ TrackedEntity),
   UniqueKeyGenerator: () => (/* reexport */ UniqueKeyGenerator),
+  authorize: () => (/* reexport */ authorize),
   concatStringByArray: () => (/* reexport */ concatStringByArray),
   convertString: () => (/* reexport */ convertString),
   formatDate: () => (/* reexport */ formatDate),
@@ -73,9 +74,45 @@ __webpack_require__.d(__webpack_exports__, {
   pReduce: () => (/* reexport */ pReduce),
   padZeros: () => (/* reexport */ padZeros),
   stringFormatter: () => (/* reexport */ stringFormatter),
-  stringHelper: () => (/* reexport */ stringHelper)
+  stringHelper: () => (/* reexport */ stringHelper),
+  trackingPlugin: () => (/* reexport */ trackingPlugin)
 });
 
+;// ./lib/helpers/authorize/authorize.js
+function authorize({ allowOwner, query = {}, required, user }) {
+  if (!user) {
+    throw new Error('Require login.')
+  }
+  if (!user.permission) {
+    throw new Error('You do not have any permission.')
+  }
+  const scopes = user.permission.getScopes(required || {})
+  if (!scopes || scopes.length === 0) {
+    throw new Error('You are not allowed in this scope.')
+  }
+  if (!scopes.includes('*')) {
+    query.tenantCode = user.tenantCode
+  }
+  if (!scopes.includes('TENANT')) {
+    query.eventShortCode = user.eventShortCode
+  }
+  if (!scopes.includes('EVENT')) {
+    query.eventRegistrationCode = user.eventRegistrationCode
+  }
+  if (allowOwner) {
+    query.__ALLOW_OWNER = true
+  }
+  // not good, just use it as example
+  if (user.hasExcludedFields) {
+    query.__EXCLUDED_FIELDS = user.getExcludedFields(required)
+  }
+  query.__LOGIN_SUBJECT_CODE = user.loginSubjectCode
+  return query
+}
+
+;// ./lib/helpers/authorize/index.js
+
+
 ;// ./lib/helpers/getValidation/getValidation.js
 function getValidation(rule, data, getDataByKey, KeyValueObject) {
   if (!rule) {
@@ -337,6 +374,7 @@ const _FN_NAMES = [
   'lte',
   'map',
   'neq',
+  'removeHtml',
   'toLowerCase',
   'toUpperCase',
 ]
@@ -925,6 +963,66 @@ function _neq(data, args) {
 
 
 
+;// ./lib/models/templateCompiler/helpers/_removeHtml.js
+
+
+function _removeHtml(html, args) {
+  if (html === null || html === undefined) {
+    return null
+  }
+  if (!Array.isArray(args)) {
+    throw new TemplateCompilerException(`_removeHtml: ${TEMPLATE_COMPILER_EXCEPTION_TYPE.argumentFormatException}: args parts must be array`)
+  }
+
+  return _htmlToPlainText(html, args[0])
+}
+
+function _htmlToPlainText(html, delimiter = '\n') {
+  if (typeof delimiter !== 'string') {
+    delimiter = '\n'; // Fallback to default if not a string
+  }
+
+  // First decode HTML entities and normalize whitespace
+  const decodedHtml = html
+    .replace(/ /g, ' ')
+    .replace(/\s+/g, ' ');  // Collapse all whitespace to single spaces
+
+  // Process HTML tags
+  let text = decodedHtml
+    // Replace block tags with temporary marker (~~~)
+    .replace(/<\/?(p|div|h[1-6]|ul|ol|li|pre|section|article|table|tr|td|th)(\s[^>]*)?>/gi, '~~~')
+    // Replace <br> tags with temporary marker (~~~)
+    .replace(/<br\s*\/?>/gi, '~~~')
+    // Remove all other tags
+    .replace(/<[^>]+>/g, '')
+    // Convert markers to specified delimiter
+    .replace(/~~~+/g, delimiter)
+    // Trim and clean whitespace
+    .trim();
+
+  // Special handling for empty delimiter
+  if (delimiter === '') {
+    // Collapse all whitespace to single space
+    text = text.replace(/\s+/g, ' ');
+  } else {
+
+
+    // Collapse multiple delimiters to single
+    text = text.replace(new RegExp(`${escapeRegExp(delimiter)}+`, 'g'), delimiter);
+    // Remove leading/trailing delimiters
+    text = text.replace(new RegExp(`^${escapeRegExp(delimiter)}|${escapeRegExp(delimiter)}$`, 'g'), '');
+  }
+
+  return text;
+}
+
+
+function escapeRegExp(string) {
+  return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+}
+
+
+
 ;// ./lib/models/templateCompiler/helpers/_toLowerCase.js
 
 
@@ -979,6 +1077,7 @@ function _toUpperCase(data, args) {
 
 
 
+
 
 
 ;// ./lib/models/templateCompiler/templateCompiler.js
@@ -1049,6 +1148,9 @@ class TemplateCompiler {
   static neq(data, args) {
     return _neq(data, args)
   }
+  static removeHtml(data, args) {
+    return _removeHtml(data, args)
+  }
   static toLowerCase(data, args) {
     return _toLowerCase(data, args)
   }
@@ -1058,6 +1160,9 @@ class TemplateCompiler {
   static parseFunction(expression) {
     return _parseFunction(expression, _FN_NAMES)
   }
+  static parseParams(parameters) {
+    return _parseParams(parameters)
+  }
 
   pipe(expression = '') {
     this.delimiters = expression.substring(0, 2) === '{{' ? TAGS_HANDLEBAR : TAGS_EJS
@@ -1237,6 +1342,8 @@ function _callFunction(data, functionName, parameters) {
         return _map(data, parameters)
       case 'neq':
         return _neq(data, parameters)
+      case 'removeHtml':
+        return _removeHtml(data, parameters)
       case 'toLowerCase':
         return _toLowerCase(data)
       case 'toUpperCase':
@@ -1385,42 +1492,59 @@ const objectHelper = {
   },
   merge,
   set(obj, path, value) {
-    const parts = path.split('.')
-    let current = obj
+    const parts = path.split('.');
+    let current = obj;
+
+    // 处理所有中间部分
     for (let i = 0; i < parts.length - 1; i++) {
-      const part = parts[i]
-      if (part.endsWith('[]')) {
-        // 处理数组遍历
-        const key = part.slice(0, -2) // 去掉 '[]' 得到属性名
-        if (Array.isArray(current[key])) {
-          current[key].forEach((item) => set(item, parts.slice(i + 1).join('.'), value))
+      const part = parts[i];
+      let key, index;
+
+      // 检查是否是数组索引格式，如key[0]
+      const arrayMatch = part.match(/^(\w+)\[(\d+)\]$/);
+      if (arrayMatch) {
+        key = arrayMatch[1];
+        index = parseInt(arrayMatch[2], 10);
+        // 确保当前层级的数组存在
+        if (!current[key] || !Array.isArray(current[key])) {
+          current[key] = [];
         }
-        return // 处理完数组后直接返回
-      }
-      if (part.includes('[') && part.includes(']')) {
-        // 处理数组索引
-        const arrayMatch = part.match(/(\w+)\[(\d+)\]/)
-        if (arrayMatch) {
-          const key = arrayMatch[1]
-          const index = arrayMatch[2]
-          if (Array.isArray(current[key]) && current[key][index]) {
-            current = current[key][index]
-          } else {
-            return // 如果数组或索引不存在，直接返回
-          }
+        // 扩展数组到足够大
+        while (current[key].length <= index) {
+          current[key].push(undefined);
         }
+        // 如果当前位置未定义或为null，初始化为对象
+        if (current[key][index] == null) {
+          current[key][index] = {};
+        }
+        current = current[key][index];
       } else {
         // 处理普通属性
         if (!current[part]) {
-          current[part] = {} // 如果属性不存在，创建一个空对象
+          current[part] = {};
         }
-        current = current[part]
+        current = current[part];
+      }
+    }
+
+    // 处理最后一部分
+    const lastPart = parts[parts.length - 1];
+    const arrayMatch = lastPart.match(/^(\w+)\[(\d+)\]$/);
+    if (arrayMatch) {
+      const key = arrayMatch[1];
+      const index = parseInt(arrayMatch[2], 10);
+      // 确保数组存在
+      if (!current[key] || !Array.isArray(current[key])) {
+        current[key] = [];
+      }
+      // 扩展数组到所需索引
+      while (current[key].length <= index) {
+        current[key].push(undefined);
       }
+      current[key][index] = value;
+    } else {
+      current[lastPart] = value;
     }
-  
-    // 设置最终属性值
-    const lastPart = parts[parts.length - 1]
-    current[lastPart] = value
   }
 }
 
@@ -1489,6 +1613,8 @@ async function pReduce(iterable, reducer, initialValue) {
 
 
 ;// ./lib/models/repo/repo.js
+
+
 class Repo {
   constructor(options) {
     options = options || {}
@@ -1501,11 +1627,7 @@ class Repo {
       : null
   }
   static init(options = {}) {
-    if (options instanceof this) {
-      return options
-    }
-    const instance = new this(options)
-    return instance.isValid ? instance : null
+    return init(this, options)
   }
   static get _classname() {
     return 'Repo'
@@ -1697,6 +1819,11 @@ function _makeLog({ systemLog, label, message: message1, input } = {}) {
 
 
 
+;// ./lib/models/repo/index.js
+
+
+
+
 ;// ./lib/models/apiResponse/apiResponse.js
 class ApiResponse {
   constructor(options = {}) {
@@ -1841,6 +1968,11 @@ function makeService({ repo }) {
 
 
 
+;// ./lib/models/service/index.js
+
+
+
+
 ;// ./lib/helpers/generalPost/generalPost.js
 
 
@@ -1865,7 +1997,13 @@ async function generalPost({ body = {}, GeneralModel, UniqueKeyGenerator, resour
 function _attachShared(data, globalShared = {}, shared = {}) {
   Object.keys(shared).forEach((key) => {
     const _data = data[key]
-    data[key] = objectHelper.merge({}, _data, globalShared, shared[key] || {})
+    if (Array.isArray(_data)) {
+      data[key] = _data.map((_dataItem) => {
+        return objectHelper.merge({}, _dataItem, globalShared, shared[key] || {})
+      })
+    } else {
+      data[key] = objectHelper.merge({}, _data, globalShared, shared[key] || {})
+    }
   })
 }
 
@@ -1900,7 +2038,7 @@ function init(_class, options) {
   }
   try {
     const instance = new _class(options)
-    return instance.isValid ? instance : null
+    return instance.isValid !== false ? instance : null
   } catch (e) {
     console.log(`init failed for class: ${_class._classname || 'no _classname'}`, e)
     return null
@@ -2092,6 +2230,36 @@ const stringHelper = {
 
 
 
+;// ./lib/helpers/trackingPlugin/trackingPlugin.js
+function trackingPlugin(schema, options) {
+  // Add meta fields
+  schema.add({
+    meta: {
+      active: { type: Boolean, default: true },
+      created: { type: Number },
+      creator: { type: String },
+      deleted: { type: Boolean, default: false },
+      modified: { type: Number },
+      owner: { type: String },
+    }
+  })
+
+  // Auto-update hook
+  schema.pre('save', function(next) {
+    this.meta.modified = Date.now()
+    next()
+  })
+
+  // Optional: Add helper methods
+  // schema.methods.touch = function(userId) {
+  //   this.meta.updatedAt = new Date()
+  //   this.meta.updatedBy = userId
+  // }
+}
+
+;// ./lib/helpers/trackingPlugin/index.js
+
+
 ;// ./lib/helpers/index.js
 
 
@@ -2108,6 +2276,8 @@ const stringHelper = {
 
 
 
+
+
 ;// ./lib/models/apiResponse/index.js
 
 
@@ -2448,21 +2618,12 @@ class QMeta {
 
 
 
-;// ./lib/models/repo/index.js
-
-
-
-
-;// ./lib/models/service/index.js
-
-
-
-
 ;// ./lib/models/trackedEntity/trackedEntity.js
 
 
 class TrackedEntity {
-  constructor(options = {}, { trackFlat = false } = {}) {
+  constructor(options = {}) {
+    options = options || {}
     const timestamp = Date.now()
     const _tracking = {
       active: options.active ?? true,
@@ -2473,11 +2634,13 @@ class TrackedEntity {
       owner: options.owner ?? '',
     }
 
-    if (trackFlat) {
-      Object.assign(this, _tracking)
-    } else {
-      this.meta = { ..._tracking, ...options.meta }
-    }
+    this.meta = { ..._tracking, ...options.meta }
+
+    // if (trackFlat) {
+    //   Object.assign(this, _tracking)
+    // } else {
+    //   this.meta = { ..._tracking, ...options.meta }
+    // }
   }
 
   // Class methods
@@ -2497,16 +2660,52 @@ class TrackedEntity {
   static initOnlyValidFromArray(arr = []) {
     return initOnlyValidFromArray(this, arr)
   }
-  static nest(entity) {
-    const { active, created, creator, deleted, modified, owner, ...rest } = entity
-    return { ...rest, meta: { active, created, creator, deleted, modified, owner } }
-  }
+  // static nest(entity) {
+  //   const { active, created, creator, deleted, modified, owner, ...rest } = entity
+  //   return { ...rest, meta: { active, created, creator, deleted, modified, owner } }
+  // }
 
   // getters
   get isValid() {
     return !!this
   }
-
+  get active() {
+    return this.meta?.active ?? this.active
+  }
+  get created() {
+    return this.meta?.created ?? this.created
+  }
+  get creator() {
+    return this.meta?.creator ?? this.creator
+  }
+  get deleted() {
+    return this.meta?.deleted ?? this.deleted
+  }
+  get modified() {
+    return this.meta?.modified ?? this.modified
+  }
+  get owner() {
+    return this.meta?.owner ?? this.owner
+  }
+  delete() {
+    return this.setDeleted()
+  }
+  setActive() {
+    if (this.meta) {
+      this.meta.active = true
+    } else {
+      this.active = true
+    }
+    return this
+  }
+  setDeleted() {
+    if (this.meta) {
+      this.meta.deleted = true
+    } else {
+      this.deleted = true
+    }
+    return this
+  }
   setModified() {
     const timestamp = Date.now()
     if (this.meta) {
@@ -2514,6 +2713,41 @@ class TrackedEntity {
     } else {
       this.modified = timestamp
     }
+    return this
+  }
+  setOwner(owner) {
+    if (!owner) {
+      return this
+    }
+    if (this.meta) {
+      this.meta.owner = owner
+    } else {
+      this.owner = owner
+    }
+    return this
+  }
+  unsetActive() {
+    if (this.meta) {
+      this.meta.active = false
+    } else {
+      this.active = false
+    }
+    return this
+  }
+  unsetDeleted() {
+    if (this.meta) {
+      this.meta.deleted = false
+    } else {
+      this.deleted = false
+    }
+    return this
+  }
+
+  update(update) {
+    if (update.meta) {
+      this.meta = { ...this.meta, ...update.meta }
+    }
+    return this.setModified()
   }
 }
 
@@ -2524,6 +2758,8 @@ class TrackedEntity {
 ;// ./lib/models/tenantAwareEntity/tenantAwareEntity.js
 
 
+
+
 class TenantAwareEntity extends TrackedEntity {
   constructor(options = {}) {
     options = options || {}
@@ -2538,6 +2774,9 @@ class TenantAwareEntity extends TrackedEntity {
     super(options)
 
     this._tenant = options._tenant
+
+    this.metadata = Metadata.initOnlyValidFromArray(options.metadata)
+    this.remarks = KeyValueObject.initOnlyValidFromArray(options.remarks)
     this.tenantCode = options.tenantCode // Required for multi-tenancy
   }
 
@@ -2553,6 +2792,41 @@ class TenantAwareEntity extends TrackedEntity {
   get isValid() {
     return super.isValid && !!this.tenantCode // Required for multi-tenancy
   }
+
+  // instance methods
+  getMetadata() {
+    return this.metadata
+  }
+  getMetadataByKey(key) {
+    return Metadata.foundByKey(this.metadata, key)
+  }
+  getMetadataValueByKey(key) {
+    const found = this.getMetadataByKey(key)
+    return found ? found.value : null
+  }
+  getRemarks() {
+    return this.remarks
+  }
+  getRemarkByKey(key) {
+    return KeyValueObject.foundByKey(this.remarks, key)
+  }
+  getRemarksValueByKey(key) {
+    const found = this.getRemarkByKey(key)
+    return found ? found.value : null
+  }
+  getTenantCode() {
+    return this.tenantCode
+  }
+
+  update(update) {
+    if (update.metadata && Array.isArray(update.metadata)) {
+      this.metadata = Metadata.initOnlyValidFromArray(update.metadata)
+    }
+    if (update.remarks && Array.isArray(update.remarks)) {
+      this.remarks = KeyValueObject.initOnlyValidFromArray(update.remarks)
+    }
+    return super.update(update)
+  }
 }
 
 ;// ./lib/models/tenantAwareEntity/index.js

package/package.json

@@ -1,14 +1,21 @@
 {
   "name": "@questwork/q-utilities",
-  "version": "0.1.13",
+  "version": "0.1.14",
   "description": "Questwork QUtilities",
   "type": "module",
   "exports": {
     ".": {
       "require": "./dist/index.min.cjs",
+      "import": "./dist/q-utilities.esm.js",
       "default": "./dist/q-utilities.min.js"
     }
   },
+  "scripts": {
+    "build": "cross-env NODE_ENV=production minimize=false gulp",
+    "build:wp": "cross-env NODE_ENV=production minimize=false gulp wp",
+    "lint": "eslint .",
+    "test:models": "NODE_ENV=test mocha --exit 'lib/models/test.setup.js' 'lib/models/**/*.spec.js'"
+  },
   "author": {
     "name": "Questwork Consulting Limited",
     "email": "info@questwork.com",
@@ -23,6 +30,7 @@
     "chai": "^4.5.0",
     "clean-webpack-plugin": "^4.0.0",
     "cross-env": "^7.0.3",
+    "del": "^8.0.0",
     "eslint": "^9.26.0",
     "gulp": "^4.0.2",
     "gulp-rename": "^2.0.0",
@@ -33,11 +41,5 @@
   },
   "engines": {
     "node": ">=10.0.0"
-  },
-  "scripts": {
-    "build": "cross-env NODE_ENV=production minimize=false gulp",
-    "build:wp": "cross-env NODE_ENV=production minimize=false gulp wp",
-    "lint": "eslint .",
-    "test:models": "NODE_ENV=test mocha --exit 'lib/models/test.setup.js' 'lib/models/**/*.spec.js'"
   }
-}
+}