pacc 9.2.14 → 9.3.1

package/README.md

@@ -75,8 +75,10 @@ tokens "abc" "
     *   [Parameters](#parameters-1)
 *   [attributeIterator](#attributeiterator)
     *   [Parameters](#parameters-2)
-*   [parseBytes](#parsebytes)
+*   [extendingAttributeIterator](#extendingattributeiterator)
     *   [Parameters](#parameters-3)
+*   [parseBytes](#parsebytes)
+    *   [Parameters](#parameters-4)
 *   [AttributeDefinition](#attributedefinition)
     *   [Properties](#properties-1)
 *   [default\_attribute](#default_attribute)
@@ -134,40 +136,40 @@ tokens "abc" "
 *   [timeout\_attribute](#timeout_attribute)
 *   [language\_attribute](#language_attribute)
 *   [environmentValues](#environmentvalues)
-    *   [Parameters](#parameters-4)
+    *   [Parameters](#parameters-5)
 *   [expandContextDefault](#expandcontextdefault)
 *   [expandContextDoubbleCurly](#expandcontextdoubblecurly)
 *   [expand](#expand)
-    *   [Parameters](#parameters-5)
+    *   [Parameters](#parameters-6)
 *   [promises](#promises)
 *   [filter](#filter)
-    *   [Parameters](#parameters-6)
-*   [setAttributes](#setattributes)
     *   [Parameters](#parameters-7)
-*   [getAttributes](#getattributes)
+*   [setAttributes](#setattributes)
     *   [Parameters](#parameters-8)
-*   [getAttributesJSON](#getattributesjson)
+*   [getAttributes](#getattributes)
     *   [Parameters](#parameters-9)
+*   [getAttributesJSON](#getattributesjson)
+    *   [Parameters](#parameters-10)
 *   [tokens](#tokens)
 *   [tokens](#tokens-1)
-    *   [Parameters](#parameters-10)
-*   [setAttribute](#setattribute)
     *   [Parameters](#parameters-11)
-*   [getAttribute](#getattribute)
+*   [setAttribute](#setattribute)
     *   [Parameters](#parameters-12)
-*   [getAttributeAndOperator](#getattributeandoperator)
+*   [getAttribute](#getattribute)
     *   [Parameters](#parameters-13)
-*   [parseDuration](#parseduration)
+*   [getAttributeAndOperator](#getattributeandoperator)
     *   [Parameters](#parameters-14)
-*   [formatDuration](#formatduration)
+*   [parseDuration](#parseduration)
     *   [Parameters](#parameters-15)
-*   [formatDurationISO](#formatdurationiso)
+*   [formatDuration](#formatduration)
     *   [Parameters](#parameters-16)
+*   [formatDurationISO](#formatdurationiso)
+    *   [Parameters](#parameters-17)
 *   [lookup](#lookup)
 *   [Token](#token)
     *   [Properties](#properties-2)
 *   [createToken](#createtoken)
-    *   [Parameters](#parameters-17)
+    *   [Parameters](#parameters-18)
 *   [PLUS](#plus)
 *   [MINUS](#minus)
 *   [STAR](#star)
@@ -202,7 +204,7 @@ tokens "abc" "
 *   [Type](#type)
     *   [Properties](#properties-3)
 *   [raiseOnUnknownType](#raiseonunknowntype)
-    *   [Parameters](#parameters-18)
+    *   [Parameters](#parameters-19)
 
 ## AST
 
@@ -236,13 +238,26 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 ## attributeIterator
 
-Iterate over all attributes.
+Iterate over attributes.
 
 ### Parameters
 
-*   `definition` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
+*   `definition`  
 *   `filter` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** 
-*   `path` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>**  (optional, default `[]`)
+*   `path` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>?**  (optional, default `[]`)
+*   `attribute` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** definition
+
+Returns **Iterable<\[[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>, [object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)]>**&#x20;
+
+## extendingAttributeIterator
+
+Iterate over all attributes of a type.
+
+### Parameters
+
+*   `type` **[Type](#type)** definition
+*   `filter` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?**&#x20;
+*   `path` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>?**&#x20;
 
 Returns **Iterable<\[[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>, [object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)]>**&#x20;
 
@@ -264,6 +279,7 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
 
 *   `type` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
 *   `isKey` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**&#x20;
+*   `isOwner` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** are we the owner of the value
 *   `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;
 *   `collection` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**&#x20;
@@ -278,8 +294,8 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
 *   `get` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** get the value can be used to calculate default values
 *   `toInternal` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?**&#x20;
 *   `toExternal` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?**&#x20;
-*   `values` **[Set](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)\<any>?** allowed values
 *   `externalName` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** attribute name used by external system
+*   `values` **[Set](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)\<any>?** allowed 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
 *   `additionalValues` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** other values to be set in case our attribute is set
 *   `separator` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** separator for collections

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pacc",
-  "version": "9.2.14",
+  "version": "9.3.1",
   "publishConfig": {
     "access": "public",
     "provenance": true

package/src/attributes.mjs

@@ -45,17 +45,17 @@ function mergeAttributeDefinitions(dest, atts) {
 }
 
 /**
- * Iterate over all attributes.
- * @param {Object} definition
+ * Iterate over attributes.
+ * @param {Object} attribute definition
  * @param {Function} [filter]
- * @param {string[]} path
+ * @param {string[]} [path]
  * @return {Iterable<[string[],object]>}
  */
 export function* attributeIterator(definition, filter, path = []) {
   if (definition) {
     for (const [name, def] of Object.entries(definition)) {
       const path2 = [...path, name];
-      if (typeof filter !== 'function' || filter(name, def)) {
+      if (typeof filter !== "function" || filter(name, def)) {
         yield [path2, def];
       }
 
@@ -64,6 +64,20 @@ export function* attributeIterator(definition, filter, path = []) {
   }
 }
 
+/**
+ * Iterate over all attributes of a type.
+ * @param {Type} type definition
+ * @param {Function} [filter]
+ * @param {string[]} [path]
+ * @return {Iterable<[string[],object]>}
+ */
+export function* extendingAttributeIterator(type, filter, path) {
+  if (type.extends) {
+    yield* extendingAttributeIterator(type.extends, filter, path);
+  }
+  yield* attributeIterator(type.attributes, filter, path);
+}
+
 export const filterWritable = (name, attribute) => attribute.writable;
 export const filterPublic = (name, attribute) => !attribute.private;
 

package/src/common-attributes.mjs

@@ -7,7 +7,8 @@ import { types } from "./types.mjs";
  * @property {boolean} isKey
  * @property {boolean} writable
  * @property {boolean} mandatory
- * @property {boolean} collection
+ * @property {boolean} collection are we a collection (set, map, array)
+ * @property {boolean} owner are we the owner of the value
  * @property {Function} [constructor] (collection) constructor
  * @property {boolean} [private] should the value be shown
  * @property {boolean} [credential] any type of credential
@@ -19,11 +20,11 @@ import { types } from "./types.mjs";
  * @property {Function} [get] get the value can be used to calculate default values
  * @property {Function} [toInternal]
  * @property {Function} [toExternal]
- * @property {Set<any>} [values] allowed values
  * @property {string} [externalName] attribute name used by external system
+ * @property {Set<any>} [values] allowed values
  * @property {string[]|string} [env] environment variable(s) used to provide the value
  * @property {object} [additionalValues] other values to be set in case our attribute is set
- * @property {string} [separator]  separator for collections
+ * @property {string} [separator] separator for collections
  */
 
 /**
@@ -35,6 +36,7 @@ export const default_attribute = {
   writable: false,
   mandatory: false,
   collection: false,
+  owner: true,
   persistent: false,
   private: false,
   credential: false,

package/types/attributes.d.mts

@@ -6,13 +6,21 @@
  */
 export function prepareAttributesDefinitions(newDefinitions: Object, presentDefinitions?: Object): Object;
 /**
- * Iterate over all attributes.
- * @param {Object} definition
+ * Iterate over attributes.
+ * @param {Object} attribute definition
  * @param {Function} [filter]
- * @param {string[]} path
+ * @param {string[]} [path]
  * @return {Iterable<[string[],object]>}
  */
-export function attributeIterator(definition: Object, filter?: Function, path?: string[]): Iterable<[string[], object]>;
+export function attributeIterator(definition: any, filter?: Function, path?: string[]): Iterable<[string[], object]>;
+/**
+ * Iterate over all attributes of a type.
+ * @param {Type} type definition
+ * @param {Function} [filter]
+ * @param {string[]} [path]
+ * @return {Iterable<[string[],object]>}
+ */
+export function extendingAttributeIterator(type: Type, filter?: Function, path?: string[]): Iterable<[string[], object]>;
 export function writableAttributeIterator(definition: any): Generator<[string[], object], void, any>;
 export function toInternal(value: any, attribute: any): any;
 export function toExternal(value: any, attribute: any): any;

package/types/common-attributes.d.mts

@@ -5,7 +5,8 @@
  * @property {boolean} isKey
  * @property {boolean} writable
  * @property {boolean} mandatory
- * @property {boolean} collection
+ * @property {boolean} collection are we a collection (set, map, array)
+ * @property {boolean} owner are we the owner of the value
  * @property {Function} [constructor] (collection) constructor
  * @property {boolean} [private] should the value be shown
  * @property {boolean} [credential] any type of credential
@@ -17,11 +18,11 @@
  * @property {Function} [get] get the value can be used to calculate default values
  * @property {Function} [toInternal]
  * @property {Function} [toExternal]
- * @property {Set<any>} [values] allowed values
  * @property {string} [externalName] attribute name used by external system
+ * @property {Set<any>} [values] allowed values
  * @property {string[]|string} [env] environment variable(s) used to provide the value
  * @property {object} [additionalValues] other values to be set in case our attribute is set
- * @property {string} [separator]  separator for collections
+ * @property {string} [separator] separator for collections
  */
 /**
  * Common attribute properties.
@@ -103,6 +104,7 @@ export namespace yesno_attribute_writable {
     export let isKey: boolean;
     export let mandatory: boolean;
     export let collection: boolean;
+    export let owner: boolean;
     export let constructor: Function | undefined;
     let _private: boolean | undefined;
     export { _private as private };
@@ -116,8 +118,8 @@ export namespace yesno_attribute_writable {
     export let get: Function | undefined;
     export let toInternal: Function | undefined;
     export let toExternal: Function | undefined;
-    export let values: Set<any> | undefined;
     export let externalName: string | undefined;
+    export let values: Set<any> | undefined;
     export let env: string | string[] | undefined;
     export let additionalValues: object | undefined;
     export let separator: string | undefined;
@@ -230,7 +232,14 @@ export type AttributeDefinition = {
     isKey: boolean;
     writable: boolean;
     mandatory: boolean;
+    /**
+     * are we a collection (set, map, array)
+     */
     collection: boolean;
+    /**
+     * are we the owner of the value
+     */
+    owner: boolean;
     /**
      * (collection) constructor
      */
@@ -269,14 +278,14 @@ export type AttributeDefinition = {
     get?: Function | undefined;
     toInternal?: Function | undefined;
     toExternal?: Function | undefined;
-    /**
-     * allowed values
-     */
-    values?: Set<any> | undefined;
     /**
      * attribute name used by external system
      */
     externalName?: string | undefined;
+    /**
+     * allowed values
+     */
+    values?: Set<any> | undefined;
     /**
      * environment variable(s) used to provide the value
      */