pacc 4.29.1 → 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.29.1",
+  "version": "4.31.0",
   "publishConfig": {
     "access": "public",
     "provenance": true

package/src/attributes.mjs

@@ -1,3 +1,5 @@
+import {getAttribute} from "./settergetter.mjs";
+
 export const baseTypes = new Set(["string", "number", "bigint", "boolean"]);
 
 export const types = {
@@ -110,3 +112,16 @@ export function prepareValue(value, attribute) {
   }
   return value;
 }
+
+export function manadatoryAttributesPresent(object, attributes) {
+  for (const [path, attribute] of attributeIterator(
+    attributes,
+    (name, attribute) => attribute.mandatory
+  )) {
+    const name = path.join(".");
+    if (getAttribute(object, name) === undefined) {
+      return false;
+    }
+  }
+  return true;
+}

package/src/common-attributes.mjs

@@ -12,9 +12,11 @@
  * @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
+ * @property {object} [additionalValues] other values to be set in case our attribute is set
  */
 
 /**

package/src/environment.mjs

@@ -0,0 +1,34 @@
+import { attributeIterator, setAttribute } from "pacc";
+
+/**
+ * Extract values from environment.
+ * @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(env, attributes, instanceIdentifier) {
+  let values;
+
+  for (const [path, attribute] of attributeIterator(
+    attributes,
+    (name, attribute) => attribute.env || attribute.attributes
+  )) {
+    const name = path.join(".");
+
+    for (const envName of (Array.isArray(attribute.env)
+      ? attribute.env
+      : [attribute.env]
+    ).map(
+      name =>
+        name && name.replace("{{instanceIdentifier}}", () => instanceIdentifier)
+    )) {
+      if (env?.[envName] !== undefined) {
+        values ??= {};
+        setAttribute(values, name, env[envName]);
+      }
+    }
+  }
+
+  return values;
+}

package/src/module.mjs

@@ -6,6 +6,7 @@ export * from "./common-attributes.mjs";
 export * from "./properties.mjs";
 export * from "./expression.mjs";
 export * from "./expand.mjs";
+export * from "./environment.mjs";
 export {
   setAttribute,
   getAttribute,

package/src/properties.mjs

@@ -14,7 +14,10 @@ export function definePropertiesFromAttributes(
     const name = path.join(".");
     const externalName = attribute.externalName ?? name;
 
-    let value = getAttribute(initialValues, externalName, attribute) ?? initialValues?.[externalName] ?? attribute.default;
+    let value =
+      getAttribute(initialValues, externalName, attribute) ??
+      initialValues?.[externalName] ??
+      attribute.default;
 
     if (value !== undefined) {
       if (path.length === 1) {

package/types/attributes.d.mts

@@ -15,6 +15,7 @@ export function prepareAttributesDefinitions(newDefinitions: any, presentDefinit
 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 manadatoryAttributesPresent(object: any, attributes: any): boolean;
 export const baseTypes: Set<string>;
 export const types: {
     base: {

package/types/common-attributes.d.mts

@@ -12,9 +12,11 @@
  * @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
+ * @property {object} [additionalValues] other values to be set in case our attribute is set
  */
 /**
  * Common attribute properties.
@@ -39,9 +41,11 @@ 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;
+    export let additionalValues: object;
 }
 /**
  * @type {AttributeDefinition}
@@ -194,6 +198,7 @@ export type AttributeDefinition = {
      * get the value can be used to calculate default values
      */
     get?: Function;
+    prepareValue?: Function;
     /**
      * allowed values
      */
@@ -206,5 +211,9 @@ export type AttributeDefinition = {
      * environment variable(s) used to provide the value
      */
     env?: string[] | string;
+    /**
+     * other values to be set in case our attribute is set
+     */
+    additionalValues?: object;
 };
 export { default_attribute as string_attribute, default_attribute_writable as string_attribute_writable, default_attribute as type_attribute, default_attribute_writable as state_attribute, boolean_attribute_writable_false as boolean_attribute, boolean_attribute_writable_true as active_attribute, secret_attribute as username_attribute, secret_attribute as password_attribute, secret_attribute as token_attribute, secret_attribute as certificate_attribute, integer_attribute as count_attribute, integer_attribute as size_attribute, default_attribute_writable as body_attribute, number_attribute as duration_attribute };

package/types/environment.d.mts

@@ -0,0 +1,8 @@
+/**
+ * Extract values from environment.
+ * @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(env: any, attributes: any, instanceIdentifier: string): any | undefined;

package/types/module.d.mts

@@ -6,4 +6,5 @@ export * from "./common-attributes.mjs";
 export * from "./properties.mjs";
 export * from "./expression.mjs";
 export * from "./expand.mjs";
+export * from "./environment.mjs";
 export { setAttribute, getAttribute, getAttributeAndOperator } from "./settergetter.mjs";