pacc 3.4.8 → 3.6.0

package/README.md

@@ -27,8 +27,6 @@ const result = getAttribute({ a: [0,{ b: 4 }]}, "a[1].b");
 
 ### Table of Contents
 
-*   [AttributeDefinition](#attributedefinition)
-    *   [Properties](#properties)
 *   [tokens](#tokens)
 *   [tokens](#tokens-1)
     *   [Parameters](#parameters)
@@ -40,11 +38,17 @@ const result = getAttribute({ a: [0,{ b: 4 }]}, "a[1].b");
     *   [Parameters](#parameters-3)
 *   [filter](#filter)
     *   [Parameters](#parameters-4)
+*   [AttributeDefinition](#attributedefinition)
+    *   [Properties](#properties)
+*   [setAttributes](#setattributes)
+    *   [Parameters](#parameters-5)
+*   [getAttributes](#getattributes)
+    *   [Parameters](#parameters-6)
 *   [lookup](#lookup)
 *   [Token](#token)
     *   [Properties](#properties-1)
 *   [createToken](#createtoken)
-    *   [Parameters](#parameters-5)
+    *   [Parameters](#parameters-7)
 *   [PLUS](#plus)
 *   [MINUS](#minus)
 *   [STAR](#star)
@@ -72,25 +76,6 @@ const result = getAttribute({ a: [0,{ b: 4 }]}, "a[1].b");
 *   [BAR](#bar)
 *   [DOUBLE\_BAR](#double_bar)
 
-## AttributeDefinition
-
-Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
-
-### Properties
-
-*   `type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
-*   `isKey` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
-*   `writable` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
-*   `mandatory` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
-*   `private` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** should the value be shown
-*   `depends` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** name of an attribute we depend on
-*   `additionalAttributes` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** extra attributes that are present in case our attribute is set
-*   `description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** human readable
-*   `default` **any?** the default value
-*   `set` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** set the value
-*   `get` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** get the value can be used to calculate default values
-*   `env` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))?** environment variable(s) used to provide the value
-
 ## tokens
 
 ## tokens
@@ -103,7 +88,7 @@ Split property path into tokens
 
 ## setAttribute
 
-Set Object attribute.
+Set object attribute.
 The name may be a property path like 'a.b.c'.
 
 ### Parameters
@@ -146,6 +131,48 @@ Generate filter function.
 
 Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)**&#x20;
 
+## AttributeDefinition
+
+Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
+
+### Properties
+
+*   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+*   `type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+*   `isKey` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**&#x20;
+*   `writable` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**&#x20;
+*   `mandatory` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**&#x20;
+*   `private` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** should the value be shown
+*   `depends` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** name of an attribute we depend on
+*   `additionalAttributes` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** extra attributes that are present in case our attribute is set
+*   `description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** human readable
+*   `default` **any?** the default value
+*   `set` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** set the value
+*   `get` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** get the value can be used to calculate default values
+*   `env` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))?** environment variable(s) used to provide the value
+
+## setAttributes
+
+Copies attribute values from a source object into a destination object.
+
+### Parameters
+
+*   `object` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** target object to be modified
+*   `source` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** origin of the data to be copied
+*   `definitions` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** attribute definitions to be used
+*   `cb` **[function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** callback to be executed for each copied value
+
+## getAttributes
+
+Retrive attribute values from an object.
+
+### Parameters
+
+*   `object` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** attribute value source
+*   `definitions` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
+
+Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** values
+
 ## lookup
 
 Token lookup

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "pacc",
-  "version": "3.4.8",
+  "version": "3.6.0",
   "publishConfig": {
     "access": "public",
     "provenance": true
   },
-  "types": "./types/attribute.d.mts",
+  "types": "./types/module.d.mts",
   "exports": {
     ".": {
-      "types": "./types/attribute.d.mts",
-      "default": "./src/attribute.mjs"
+      "types": "./types/module.d.mts",
+      "default": "./src/module.mjs"
     }
   },
   "description": "property path utils",
@@ -36,15 +36,15 @@
     "npm-pkgbuild": "^18.1.1"
   },
   "devDependencies": {
-    "ava": "^6.4.0",
+    "ava": "^6.4.1",
     "browser-ava": "^2.3.31",
     "c8": "^10.1.3",
     "documentation": "^14.0.3",
-    "semantic-release": "^24.2.5",
+    "semantic-release": "^24.2.7",
     "typescript": "^5.8.3"
   },
   "engines": {
-    "node": ">=22.16.0"
+    "node": ">=22.17.1"
   },
   "repository": {
     "type": "git",

package/src/attribute.mjs

@@ -1,19 +1,3 @@
-/**
- * @typedef {Object} AttributeDefinition
- *
- * @property {string} type
- * @property {boolean} isKey
- * @property {boolean} writable
- * @property {boolean} mandatory
- * @property {boolean} [private] should the value be shown
- * @property {string} [depends] name of an attribute we depend on
- * @property {string[]} additionalAttributes extra attributes that are present in case our attribute is set
- * @property {string} [description] human readable
- * @property {any} [default] the default value
- * @property {Function} [set] set the value
- * @property {Function} [get] get the value can be used to calculate default values
- * @property {string[]|string} [env] environment variable(s) used to provide the value
- */
 
 /**
  * @typedef {import('./tokens.mjs').Token} Token
@@ -32,11 +16,9 @@ import {
   GREATER_EQUAL,
   STAR
 } from "./tokens.mjs";
-export * from "./tokens.mjs";
-export * from "./filter.mjs";
 
 /**
- * Set Object attribute.
+ * Set object attribute.
  * The name may be a property path like 'a.b.c'.
  * @param {Object} object
  * @param {string} expression

package/src/module.mjs

@@ -0,0 +1,8 @@
+export * from "./tokens.mjs";
+export * from "./filter.mjs";
+export * from "./multiple.mjs";
+export {
+  setAttribute,
+  getAttribute,
+  getAttributeAndOperator
+} from "./attribute.mjs";

package/src/multiple.mjs

@@ -0,0 +1,97 @@
+import { setAttribute, getAttribute } from "./attribute.mjs";
+
+/**
+ * @typedef {Object} AttributeDefinition
+ *
+ * @property {string} name
+ * @property {string} type
+ * @property {boolean} isKey
+ * @property {boolean} writable
+ * @property {boolean} mandatory
+ * @property {boolean} [private] should the value be shown
+ * @property {string} [depends] name of an attribute we depend on
+ * @property {string[]} additionalAttributes extra attributes that are present in case our attribute is set
+ * @property {string} [description] human readable
+ * @property {any} [default] the default value
+ * @property {Function} [set] set the value
+ * @property {Function} [get] get the value can be used to calculate default values
+ * @property {string[]|string} [env] environment variable(s) used to provide the value
+ */
+
+const types = {
+  base: { name: "base" },
+  string: { name: "string" },
+  number: { name: "number" },
+  boolean: { name: "boolean" }
+};
+
+/**
+ * Create attributes from its definition.
+ * @param {Object} definitions
+ * @return {Object} attributes
+ */
+export function prepareAttributesDefinitions(definitions) {
+  for (const [name, d] of Object.entries(definitions)) {
+    d.name = name;
+    if (d.attributes === undefined) {
+      d.type = types[d.type] || types.base;
+    }
+  }
+  return definitions;
+}
+
+/**
+ * Merge attribute definitions.
+ * @param {Object} dest attribute definitions to be used also the merge target
+ * @param {Object} atts attribute definitions to be used
+ * @return {Object} merged definitions (dest)
+ */
+export function mergeAttributeDefinitions(dest, atts) {
+  for (const [name, ca] of Object.entries(atts)) {
+    if (ca.attributes !== undefined) {
+      const bn = dest[name];
+
+      if (bn !== undefined) {
+        Object.assign(ca.attributes, bn.attributes);
+      }
+    }
+  }
+
+  return Object.assign(dest, atts);
+}
+
+/**
+ * Copies attribute values from a source object into a destination object.
+ * @param {Object} object target object to be modified
+ * @param {Object} source origin of the data to be copied
+ * @param {Object} definitions attribute definitions to be used
+ * @param {function} cb callback to be executed for each copied value
+ */
+export function setAttributes(object, source, definitions, cb) {
+  for (const [name, def] of Object.entries(definitions)) {
+    const value = getAttribute(source, name);
+    setAttribute(object, name, value);
+    if (cb) {
+      cb(def, name, value);
+    }
+  }
+}
+
+/**
+ * Retrive attribute values from an object.
+ * @param {Object} object attribute value source
+ * @param {Object} definitions
+ * @return {Object} values
+ */
+export function getAttributes(object, definitions) {
+  const result = {};
+
+  Object.keys(definitions).forEach(name => {
+    const value = getAttribute(object, name);
+    if (value !== undefined) {
+      result[name] = value;
+    }
+  });
+
+  return result;
+}

package/types/attribute.d.mts

@@ -1,5 +1,5 @@
 /**
- * Set Object attribute.
+ * Set object attribute.
  * The name may be a property path like 'a.b.c'.
  * @param {Object} object
  * @param {string} expression
@@ -22,44 +22,4 @@ export function getAttribute(object: any, expression: string): any;
  * @returns {[any,Token]} value associated with the given property name
  */
 export function getAttributeAndOperator(object: any, expression: string): [any, Token];
-export * from "./tokens.mjs";
-export * from "./filter.mjs";
-export type AttributeDefinition = {
-    type: string;
-    isKey: boolean;
-    writable: boolean;
-    mandatory: boolean;
-    /**
-     * should the value be shown
-     */
-    private?: boolean;
-    /**
-     * name of an attribute we depend on
-     */
-    depends?: string;
-    /**
-     * extra attributes that are present in case our attribute is set
-     */
-    additionalAttributes: string[];
-    /**
-     * human readable
-     */
-    description?: string;
-    /**
-     * the default value
-     */
-    default?: any;
-    /**
-     * set the value
-     */
-    set?: Function;
-    /**
-     * get the value can be used to calculate default values
-     */
-    get?: Function;
-    /**
-     * environment variable(s) used to provide the value
-     */
-    env?: string[] | string;
-};
 export type Token = import("./tokens.mjs").Token;

package/types/module.d.mts

@@ -0,0 +1,4 @@
+export * from "./tokens.mjs";
+export * from "./filter.mjs";
+export * from "./multiple.mjs";
+export { setAttribute, getAttribute, getAttributeAndOperator } from "./attribute.mjs";

package/types/multiple.d.mts

@@ -0,0 +1,67 @@
+/**
+ * Create attributes from its definition.
+ * @param {Object} definitions
+ * @return {Object} attributes
+ */
+export function prepareAttributesDefinitions(definitions: any): any;
+/**
+ * Merge attribute definitions.
+ * @param {Object} dest attribute definitions to be used also the merge target
+ * @param {Object} atts attribute definitions to be used
+ * @return {Object} merged definitions (dest)
+ */
+export function mergeAttributeDefinitions(dest: any, atts: any): any;
+/**
+ * Copies attribute values from a source object into a destination object.
+ * @param {Object} object target object to be modified
+ * @param {Object} source origin of the data to be copied
+ * @param {Object} definitions attribute definitions to be used
+ * @param {function} cb callback to be executed for each copied value
+ */
+export function setAttributes(object: any, source: any, definitions: any, cb: Function): void;
+/**
+ * Retrive attribute values from an object.
+ * @param {Object} object attribute value source
+ * @param {Object} definitions
+ * @return {Object} values
+ */
+export function getAttributes(object: any, definitions: any): any;
+export type AttributeDefinition = {
+    name: string;
+    type: string;
+    isKey: boolean;
+    writable: boolean;
+    mandatory: boolean;
+    /**
+     * should the value be shown
+     */
+    private?: boolean;
+    /**
+     * name of an attribute we depend on
+     */
+    depends?: string;
+    /**
+     * extra attributes that are present in case our attribute is set
+     */
+    additionalAttributes: string[];
+    /**
+     * human readable
+     */
+    description?: string;
+    /**
+     * the default value
+     */
+    default?: any;
+    /**
+     * set the value
+     */
+    set?: Function;
+    /**
+     * get the value can be used to calculate default values
+     */
+    get?: Function;
+    /**
+     * environment variable(s) used to provide the value
+     */
+    env?: string[] | string;
+};