pacc 6.6.2 → 6.7.0

package/README.md

@@ -88,6 +88,7 @@ const result = getAttribute({ a: [0,{ b: 4 }]}, "a[1].b");
     *   [Parameters](#parameters-4)
 *   [expand](#expand)
     *   [Parameters](#parameters-5)
+*   [promises](#promises)
 *   [filter](#filter)
     *   [Parameters](#parameters-6)
 *   [setAttributes](#setattributes)
@@ -146,6 +147,8 @@ const result = getAttribute({ a: [0,{ b: 4 }]}, "a[1].b");
 *   [EOF](#eof)
 *   [Type](#type)
     *   [Properties](#properties-2)
+*   [raiseOnUnknownType](#raiseonunknowntype)
+    *   [Parameters](#parameters-18)
 
 ## prepareAttributesDefinitions
 
@@ -176,7 +179,7 @@ Iterate over all attributes.
 ### Parameters
 
 *   `definition` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
-*   `filter` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** 
+*   `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 `[]`)
 
 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;
@@ -204,7 +207,7 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
 *   `collection` **[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
 *   `credential` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** any type of credential
-*   `persistent` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** should we be stored
+*   `persistent` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** should we be stored (especially critical for credentials)
 *   `depends` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** name of an attribute we depend on
 *   `description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** human readable
 *   `default` **any?** the default value
@@ -212,7 +215,7 @@ 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
 *   `prepareValue` **[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)?** attrubute name used by external system
+*   `externalName` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** attribute name used by external system
 *   `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
 
@@ -442,13 +445,17 @@ Expand expressions inside of object graphs.
 *   `object` **any**&#x20;
 *   `context` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**  (optional, default `{}`)
 
-    *   `context.root` **any**&#x20;
+    *   `context.root` **any?**&#x20;
     *   `context.stopClass` **[function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?**&#x20;
     *   `context.leadIn` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?**&#x20;
     *   `context.leadOut` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?**&#x20;
 
 Returns **any**&#x20;
 
+## promises
+
+Type: [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<any>>
+
 ## filter
 
 Generate filter function.
@@ -489,7 +496,7 @@ Retrive attribute values from an object.
 
 *   `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;
-*   `filter` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
+*   `filter` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?**&#x20;
 
 Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** values
 
@@ -710,6 +717,15 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
 *   `primitive` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?**&#x20;
 *   `prepareValue` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?**&#x20;
 
+## raiseOnUnknownType
+
+### Parameters
+
+*   `type` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))**&#x20;
+*   `origin` **any**&#x20;
+
+Returns **[Type](#type)**&#x20;
+
 # install
 
 With [npm](http://npmjs.org) do:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pacc",
-  "version": "6.6.2",
+  "version": "6.7.0",
   "publishConfig": {
     "access": "public",
     "provenance": true
@@ -39,7 +39,7 @@
   },
   "devDependencies": {
     "ava": "^6.4.1",
-    "browser-ava": "^2.3.47",
+    "browser-ava": "^2.3.49",
     "c8": "^10.1.3",
     "documentation": "^14.0.3",
     "semantic-release": "^25.0.2",

package/src/attributes.mjs

@@ -47,7 +47,7 @@ function mergeAttributeDefinitions(dest, atts) {
 /**
  * Iterate over all attributes.
  * @param {Object} definition
- * @param {Function} filter
+ * @param {Function} [filter]
  * @param {string[]} path
  * @return {Iterable<[string[],object]>}
  */

package/src/common-attributes.mjs

@@ -10,7 +10,7 @@ import { types } from "./types.mjs";
  * @property {boolean} collection
  * @property {boolean} [private] should the value be shown
  * @property {boolean} [credential] any type of credential
- * @property {boolean} [persistent] should we be stored
+ * @property {boolean} [persistent] should we be stored (especially critical for credentials)
  * @property {string} [depends] name of an attribute we depend on
  * @property {string} [description] human readable
  * @property {any} [default] the default value
@@ -18,7 +18,7 @@ import { types } from "./types.mjs";
  * @property {Function} [get] get the value can be used to calculate default values
  * @property {Function} [prepareValue]
  * @property {Set<any>} [values] allowed values
- * @property {string} [externalName] attrubute name used by external system
+ * @property {string} [externalName] attribute name used by external system
  * @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
  */
@@ -367,6 +367,14 @@ export const duration_attribute = {
   type: types.duration
 };
 
+/**
+ * @type {AttributeDefinition}
+ */
+export const duration_attribute_writable = {
+  ...duration_attribute,
+  writable: true
+};
+
 /**
  * @type {AttributeDefinition}
  */

package/src/expand.mjs

@@ -6,14 +6,14 @@ const maxNestingLevel = 5;
  * Expand expressions inside of object graphs.
  * @param {any} object
  * @param {Object} context
- * @param {any} context.root
+ * @param {any} [context.root]
  * @param {function} [context.stopClass]
  * @param {string} [context.leadIn]
  * @param {string} [context.leadOut]
  * @returns {any}
  */
 export function expand(object, context = {}) {
-  const promises = [];
+  const /** @type {Array<Promise<any>>} */ promises = [];
 
   const leadIn = context.leadIn ?? "${";
   const leadOut = context.leadOut ?? "}";

package/src/multiple.mjs

@@ -60,7 +60,7 @@ export function getAttributes(object, definitions) {
  * Retrive attribute values from an object.
  * @param {Object} object attribute value source
  * @param {Object} definitions
- * @param {Object} filter
+ * @param {Function} [filter]
  * @return {Object} values
  */
 export function getAttributesJSON(object, definitions, filter) {

package/src/types.mjs

@@ -61,10 +61,12 @@ export const types = {
   object: { name: "object", primitive: false }
 };
 
-function error(message) {
-  throw new Error(message);
-}
-
+/**
+ * 
+ * @param {string|undefined} type 
+ * @param {any} origin 
+ * @returns {Type}
+ */
 function raiseOnUnknownType(type, origin) {
   switch (typeof type) {
     case "string":
@@ -72,7 +74,7 @@ function raiseOnUnknownType(type, origin) {
         return types[type];
       }
     case "undefined":
-      error(`Unknown type ${type} in '${origin}'`);
+      throw new Error(`Unknown type ${type} in '${origin}'`, { cause: type });
   }
 
   return type;
@@ -174,7 +176,6 @@ export function resolveTypeLinks() {
 
 export function typeFactory(type, owner, data) {
   const factory = type.factoryFor?.(owner, data) || type.clazz;
-  //console.log(factory, type, owner, data);
   const object = new factory(owner);
 
   object.read(data);

package/types/attributes.d.mts

@@ -8,11 +8,11 @@ export function prepareAttributesDefinitions(newDefinitions: any, presentDefinit
 /**
  * Iterate over all attributes.
  * @param {Object} definition
- * @param {Function} filter
+ * @param {Function} [filter]
  * @param {string[]} path
  * @return {Iterable<[string[],object]>}
  */
-export function attributeIterator(definition: any, filter: Function, path?: string[]): Iterable<[string[], object]>;
+export function attributeIterator(definition: any, filter?: Function, path?: string[]): Iterable<[string[], object]>;
 export function writableAttributeIterator(definition: any): Generator<[string[], any], void, any>;
 export function prepareValue(value: any, attribute: any): any;
 export function mandatoryAttributesPresent(object: any, attributes: any): boolean;

package/types/common-attributes.d.mts

@@ -8,7 +8,7 @@
  * @property {boolean} collection
  * @property {boolean} [private] should the value be shown
  * @property {boolean} [credential] any type of credential
- * @property {boolean} [persistent] should we be stored
+ * @property {boolean} [persistent] should we be stored (especially critical for credentials)
  * @property {string} [depends] name of an attribute we depend on
  * @property {string} [description] human readable
  * @property {any} [default] the default value
@@ -16,7 +16,7 @@
  * @property {Function} [get] get the value can be used to calculate default values
  * @property {Function} [prepareValue]
  * @property {Set<any>} [values] allowed values
- * @property {string} [externalName] attrubute name used by external system
+ * @property {string} [externalName] attribute name used by external system
  * @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
  */
@@ -186,6 +186,10 @@ export const priority_attribute: AttributeDefinition;
  * @type {AttributeDefinition}
  */
 export const duration_attribute: AttributeDefinition;
+/**
+ * @type {AttributeDefinition}
+ */
+export const duration_attribute_writable: AttributeDefinition;
 /**
  * @type {AttributeDefinition}
  */
@@ -213,7 +217,7 @@ export type AttributeDefinition = {
      */
     credential?: boolean;
     /**
-     * should we be stored
+     * should we be stored (especially critical for credentials)
      */
     persistent?: boolean;
     /**
@@ -242,7 +246,7 @@ export type AttributeDefinition = {
      */
     values?: Set<any>;
     /**
-     * attrubute name used by external system
+     * attribute name used by external system
      */
     externalName?: string;
     /**

package/types/expand.d.mts

@@ -2,14 +2,14 @@
  * Expand expressions inside of object graphs.
  * @param {any} object
  * @param {Object} context
- * @param {any} context.root
+ * @param {any} [context.root]
  * @param {function} [context.stopClass]
  * @param {string} [context.leadIn]
  * @param {string} [context.leadOut]
  * @returns {any}
  */
 export function expand(object: any, context?: {
-    root: any;
+    root?: any;
     stopClass?: Function;
     leadIn?: string;
     leadOut?: string;

package/types/multiple.d.mts

@@ -17,7 +17,7 @@ export function getAttributes(object: any, definitions: any): any;
  * Retrive attribute values from an object.
  * @param {Object} object attribute value source
  * @param {Object} definitions
- * @param {Object} filter
+ * @param {Function} [filter]
  * @return {Object} values
  */
-export function getAttributesJSON(object: any, definitions: any, filter: any): any;
+export function getAttributesJSON(object: any, definitions: any, filter?: Function): any;