pacc 4.27.1 → 4.29.0

package/package.json

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

package/src/attributes.mjs

@@ -1,30 +1,34 @@
-
-
 export const baseTypes = new Set(["string", "number", "bigint", "boolean"]);
 
 export const types = {
   base: { name: "base" },
-  
+
   string: { name: "string", extends: "base" },
   number: {
     name: "number",
     extends: "base",
-    prepareValue: (value, attribute) =>
+    prepareValue: value =>
       typeof value === "string" ? parseFloat(value) : value
   },
   boolean: {
     name: "boolean",
     extends: "base",
-    prepareValue: (value, attribute) => (!value || value === "0" ? false : true)
+    prepareValue: value =>
+      !value || value === "0" || value === "false" || value === "no"
+        ? false
+        : true
   },
-
   integer: {
     name: "integer",
     extends: "base",
-    prepareValue: (value, attribute) =>
-      typeof value === "string" ? parseInt(value) : value
+    prepareValue: value => (typeof value === "string" ? parseInt(value) : value)
+  },
+  "unsigned-integer": {
+    name: "unsigned-integer",
+    prepareValue: value =>
+      typeof value === "string" ? parseInt(value) : value,
+    extends: "integer"
   },
-  "unsigned-integer": { name: "unsigned-integer", extends: "integer" },
   url: { name: "url", extends: "string" },
   object: { name: "object", extends: "base" }
 };
@@ -71,26 +75,32 @@ function mergeAttributeDefinitions(dest, atts) {
 }
 
 /**
- * iterate over all attributes.
+ * Iterate over all attributes.
  * @param {Object} definition
+ * @param {Function} filter
  * @param {string[]} path
+ * @return {Iterable<[string[],object]>}
  */
-export function* attributeIterator(definition, path = []) {
+export function* attributeIterator(definition, filter, path = []) {
   if (definition) {
     for (const [name, def] of Object.entries(definition)) {
-      path.push(name);
+      if (!filter || filter(name, def)) {
+        const path2 = [...path, name];
 
-      if (def.attributes) {
-        yield* attributeIterator(def.attributes, path);
-      }
+        yield [path2, def];
 
-      yield [path, def];
-
-      path.pop();
+        if (def.attributes) {
+          yield* attributeIterator(def.attributes, filter, path2);
+        }
+      }
     }
   }
 }
 
+export function* writableAttributeIterator(definition) {
+  yield* attributeIterator(definition, (name, def) => def.writable);
+}
+
 export function prepareValue(value, attribute) {
   if (attribute?.type?.prepareValue) {
     return attribute.type.prepareValue(value, attribute);

package/src/common-attributes.mjs

@@ -12,6 +12,8 @@
  * @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 {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/properties.mjs

@@ -12,8 +12,9 @@ export function definePropertiesFromAttributes(
 
   for (const [path, attribute] of attributeIterator(attributes)) {
     const name = path.join(".");
+    const externalName = attribute.externalName ?? name;
 
-    let value = getAttribute(initialValues, name, attribute) ?? initialValues?.[name] ?? attribute.default;
+    let value = getAttribute(initialValues, externalName, attribute) ?? initialValues?.[externalName] ?? attribute.default;
 
     if (value !== undefined) {
       if (path.length === 1) {

package/types/attributes.d.mts

@@ -6,11 +6,14 @@
  */
 export function prepareAttributesDefinitions(newDefinitions: any, presentDefinitions?: any): any;
 /**
- * iterate over all attributes.
+ * Iterate over all attributes.
  * @param {Object} definition
+ * @param {Function} filter
  * @param {string[]} path
+ * @return {Iterable<[string[],object]>}
  */
-export function attributeIterator(definition: any, path?: string[]): any;
+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 const baseTypes: Set<string>;
 export const types: {
@@ -24,20 +27,21 @@ export const types: {
     number: {
         name: string;
         extends: string;
-        prepareValue: (value: any, attribute: any) => any;
+        prepareValue: (value: any) => any;
     };
     boolean: {
         name: string;
         extends: string;
-        prepareValue: (value: any, attribute: any) => boolean;
+        prepareValue: (value: any) => boolean;
     };
     integer: {
         name: string;
         extends: string;
-        prepareValue: (value: any, attribute: any) => any;
+        prepareValue: (value: any) => any;
     };
     "unsigned-integer": {
         name: string;
+        prepareValue: (value: any) => any;
         extends: string;
     };
     url: {

package/types/common-attributes.d.mts

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