pacc 3.5.0 → 3.6.1

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,21 @@ const result = getAttribute({ a: [0,{ b: 4 }]}, "a[1].b");
     *   [Parameters](#parameters-3)
 *   [filter](#filter)
     *   [Parameters](#parameters-4)
+*   [AttributeDefinition](#attributedefinition)
+    *   [Properties](#properties)
+*   [prepareAttributesDefinitions](#prepareattributesdefinitions)
+    *   [Parameters](#parameters-5)
+*   [mergeAttributeDefinitions](#mergeattributedefinitions)
+    *   [Parameters](#parameters-6)
+*   [setAttributes](#setattributes)
+    *   [Parameters](#parameters-7)
+*   [getAttributes](#getattributes)
+    *   [Parameters](#parameters-8)
 *   [lookup](#lookup)
 *   [Token](#token)
     *   [Properties](#properties-1)
 *   [createToken](#createtoken)
-    *   [Parameters](#parameters-5)
+    *   [Parameters](#parameters-9)
 *   [PLUS](#plus)
 *   [MINUS](#minus)
 *   [STAR](#star)
@@ -72,25 +80,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
@@ -146,6 +135,69 @@ 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
+
+## prepareAttributesDefinitions
+
+Create attributes from its definition.
+
+### Parameters
+
+*   `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)** attributes
+
+## mergeAttributeDefinitions
+
+Merge attribute definitions.
+
+### Parameters
+
+*   `dest` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** attribute definitions to be used also the merge target
+*   `atts` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** attribute definitions to be used
+
+Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** merged definitions (dest)
+
+## 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,6 +1,6 @@
 {
   "name": "pacc",
-  "version": "3.5.0",
+  "version": "3.6.1",
   "publishConfig": {
     "access": "public",
     "provenance": true

package/src/multiple.mjs

@@ -18,12 +18,56 @@ import { setAttribute, getAttribute } from "./attribute.mjs";
  * @property {string[]|string} [env] environment variable(s) used to provide the value
  */
 
+const types = {
+  base: { name: "base" },
+  string: { name: "string" },
+  number: { name: "number" },
+  integer: { name: "integer" },
+  boolean: { name: "boolean" },
+  object: { name: "object" }
+};
+
+/**
+ * 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
+ * @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)) {

package/types/multiple.d.mts

@@ -1,28 +1,24 @@
 /**
- * @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
+ * 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
+ * @param {function?} cb callback to be executed for each copied value
  */
-export function setAttributes(object: any, source: any, definitions: any, cb: Function): void;
+export function setAttributes(object: any, source: any, definitions: any, cb: Function | null): void;
 /**
  * Retrive attribute values from an object.
  * @param {Object} object attribute value source