pacc 4.29.0 → 4.30.0

package/README.md

@@ -154,13 +154,16 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 ## attributeIterator
 
-iterate over all attributes.
+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)** 
 *   `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;
+
 ## AttributeDefinition
 
 Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
@@ -178,6 +181,8 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
 *   `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
+*   `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
 
 ## default\_attribute

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pacc",
-  "version": "4.29.0",
+  "version": "4.30.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 = {
@@ -102,8 +104,24 @@ export function* writableAttributeIterator(definition) {
 }
 
 export function prepareValue(value, attribute) {
-  if (attribute?.type?.prepareValue) {
-    return attribute.type.prepareValue(value, attribute);
+  if (attribute) {
+    const prepareValue = attribute.prepareValue ?? attribute.type?.prepareValue;
+    if (prepareValue) {
+      return 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

@@ -15,6 +15,7 @@
  * @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} attributes as from process.env
+ * @param {Object} env 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) {
+  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

@@ -15,6 +15,7 @@
  * @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.
@@ -42,6 +43,7 @@ export namespace string_collection_attribute {
     export let values: Set<any>;
     export let externalName: string;
     export let env: string[] | string;
+    export let additionalValues: object;
 }
 /**
  * @type {AttributeDefinition}
@@ -206,5 +208,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} attributes as from process.env
+ * @param {Object} env 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;

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";