pacc 4.30.0 → 4.31.0

package/README.md

@@ -79,28 +79,30 @@ const result = getAttribute({ a: [0,{ b: 4 }]}, "a[1].b");
 *   [priority\_attribute](#priority_attribute)
 *   [timeout\_attribute](#timeout_attribute)
 *   [language\_attribute](#language_attribute)
-*   [expand](#expand)
+*   [environmentValues](#environmentvalues)
     *   [Parameters](#parameters-3)
-*   [filter](#filter)
+*   [expand](#expand)
     *   [Parameters](#parameters-4)
-*   [setAttributes](#setattributes)
+*   [filter](#filter)
     *   [Parameters](#parameters-5)
-*   [getAttributes](#getattributes)
+*   [setAttributes](#setattributes)
     *   [Parameters](#parameters-6)
+*   [getAttributes](#getattributes)
+    *   [Parameters](#parameters-7)
 *   [tokens](#tokens)
 *   [tokens](#tokens-1)
-    *   [Parameters](#parameters-7)
-*   [setAttribute](#setattribute)
     *   [Parameters](#parameters-8)
-*   [getAttribute](#getattribute)
+*   [setAttribute](#setattribute)
     *   [Parameters](#parameters-9)
-*   [getAttributeAndOperator](#getattributeandoperator)
+*   [getAttribute](#getattribute)
     *   [Parameters](#parameters-10)
+*   [getAttributeAndOperator](#getattributeandoperator)
+    *   [Parameters](#parameters-11)
 *   [lookup](#lookup)
 *   [Token](#token)
     *   [Properties](#properties-1)
 *   [createToken](#createtoken)
-    *   [Parameters](#parameters-11)
+    *   [Parameters](#parameters-12)
 *   [PLUS](#plus)
 *   [MINUS](#minus)
 *   [STAR](#star)
@@ -184,6 +186,7 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
 *   `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
 *   `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
 
 ## default\_attribute
 
@@ -374,6 +377,18 @@ Type: [AttributeDefinition](#attributedefinition)
 
 Type: [AttributeDefinition](#attributedefinition)
 
+## environmentValues
+
+Extract values from environment.
+
+### Parameters
+
+*   `attributes` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** as from process.env
+*   `env` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** as from process.env
+*   `instanceIdentifier` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** part of variable name.
+
+Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** undefined if no suitable environment variables have been found
+
 ## expand
 
 Expand expressions inside of object graphs.

package/package.json

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

package/src/common-attributes.mjs

@@ -12,6 +12,7 @@
  * @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 {Function} [prepareValue]
  * @property {Set<any>} [values] allowed values
  * @property {string} [externalName] attrubute name used by external system
  * @property {string[]|string} [env] environment variable(s) used to provide the value

package/src/environment.mjs

@@ -2,12 +2,12 @@ import { attributeIterator, setAttribute } from "pacc";
 
 /**
  * Extract values from environment.
- * @param {Object} attributes as from process.env
  * @param {Object} env as from process.env
+ * @param {Object} attributes as from process.env
  * @param {string} instanceIdentifier part of variable name.
  * @return {Object|undefined} undefined if no suitable environment variables have been found
  */
-export function environmentValues(attributes, env, instanceIdentifier) {
+export function environmentValues(env, attributes, instanceIdentifier) {
   let values;
 
   for (const [path, attribute] of attributeIterator(
@@ -23,7 +23,7 @@ export function environmentValues(attributes, env, instanceIdentifier) {
       name =>
         name && name.replace("{{instanceIdentifier}}", () => instanceIdentifier)
     )) {
-      if (env[envName] !== undefined) {
+      if (env?.[envName] !== undefined) {
         values ??= {};
         setAttribute(values, name, env[envName]);
       }

package/types/common-attributes.d.mts

@@ -12,6 +12,7 @@
  * @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 {Function} [prepareValue]
  * @property {Set<any>} [values] allowed values
  * @property {string} [externalName] attrubute name used by external system
  * @property {string[]|string} [env] environment variable(s) used to provide the value
@@ -40,6 +41,7 @@ export namespace string_collection_attribute {
     export { _default as default };
     export let set: Function;
     export let get: Function;
+    export let prepareValue: Function;
     export let values: Set<any>;
     export let externalName: string;
     export let env: string[] | string;
@@ -196,6 +198,7 @@ export type AttributeDefinition = {
      * get the value can be used to calculate default values
      */
     get?: Function;
+    prepareValue?: Function;
     /**
      * allowed values
      */

package/types/environment.d.mts

@@ -1,8 +1,8 @@
 /**
  * Extract values from environment.
- * @param {Object} attributes as from process.env
  * @param {Object} env as from process.env
+ * @param {Object} attributes as from process.env
  * @param {string} instanceIdentifier part of variable name.
  * @return {Object|undefined} undefined if no suitable environment variables have been found
  */
-export function environmentValues(attributes: any, env: any, instanceIdentifier: string): any | undefined;
+export function environmentValues(env: any, attributes: any, instanceIdentifier: string): any | undefined;