pacc 10.2.0 → 10.4.0

package/README.md

@@ -287,11 +287,11 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
 *   `writable` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** can this attribute be modified
 *   `mandatory` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
 *   `collection` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** are we a collection (set, map, array, object)
-*   `owner` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** are we the owner of the value
-*   `constructor` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** (collection) constructor
 *   `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 (especially critical for credentials)
+*   `backpointer` **[AttributeDefinition](#attributedefinition)?** 
+*   `constructor` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** (collection) constructor
 *   `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

package/package.json

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

package/src/common-attributes.mjs

@@ -9,11 +9,11 @@ import { types } from "./types.mjs";
  * @property {boolean} writable can this attribute be modified
  * @property {boolean} mandatory
  * @property {boolean} collection are we a collection (set, map, array, object)
- * @property {AttributeDefinition} [backpointer]
- * @property {Function} [constructor] (collection) constructor
  * @property {boolean} [private] should the value be shown
  * @property {boolean} [credential] any type of credential
  * @property {boolean} [persistent] should we be stored (especially critical for credentials)
+ * @property {AttributeDefinition} [backpointer]
+ * @property {Function} [constructor] (collection) constructor
  * @property {string} [depends] name of an attribute we depend on
  * @property {string} [description] human readable
  * @property {any} [default] the default value
@@ -51,6 +51,14 @@ export const default_attribute_writable = {
   writable: true
 };
 
+/**
+ * @type {AttributeDefinition}
+ */
+export const default_collection_attribute = {
+  ...default_attribute,
+  collection: true
+};
+
 /**
  * @type {AttributeDefinition}
  */

package/src/extract.mjs

@@ -0,0 +1,41 @@
+import { extendingAttributeIterator } from "pacc";
+
+export function extract(object, type = object.constructor) {
+  const result = {};
+  for (const [path, attribute] of extendingAttributeIterator(
+    type,
+    attribute => !attribute.private
+  )) {
+    const name = path.join(".");
+    const value = object[name];
+
+    if (value !== undefined) {
+      if (attribute.type.primitive) {
+        if (attribute.collection) {
+          if ((value.size ?? value.length) > 0) {
+            result[name] = [...value.values()];
+          }
+        } else {
+          result[name] = value;
+        }
+      } else {
+        if (attribute.backpointer) {
+          if (attribute.collection) {
+            if ((value.size ?? value.length) > 0) {
+              result[name] = Object.fromEntries(
+                [...value.values()].map(v => [v[v.constructor.key], extract(v)])
+              );
+            }
+          } else {
+            result[name] = extract(value);
+          }
+        } else {
+          const key = value.constructor.key;
+          result[name] = { [key]: value[key], type: value.constructor.name };
+        }
+      }
+    }
+  }
+
+  return result;
+}

package/src/module.mjs

@@ -2,6 +2,7 @@ export * from "./types.mjs";
 export * from "./time.mjs";
 export * from "./bytes.mjs";
 export * from "./attributes.mjs";
+export * from "./extract.mjs";
 export * from "./tokens.mjs";
 export * from "./filter.mjs";
 export * from "./multiple.mjs";

package/src/multiple.mjs

@@ -1,6 +1,7 @@
 import { setAttribute, getAttribute } from "./settergetter.mjs";
 import { attributeIterator, toExternal } from "./attributes.mjs";
 import { default_attribute } from "./common-attributes.mjs";
+
 /**
  * Copies attribute values from a source object into a destination object.
  * @param {Object} object target object to be modified
@@ -9,25 +10,25 @@ import { default_attribute } from "./common-attributes.mjs";
  * @param {function?} cb callback to be executed for each copied value
  */
 export function setAttributes(object, source, definitions, cb) {
-  for (const [path, def] of attributeIterator(definitions)) {
+  for (const [path, attribute] of attributeIterator(definitions)) {
     const name = path.join(".");
 
     let value = getAttribute(source, name);
 
     if (value === undefined) {
       if (
-        def.default === undefined ||
+        attribute.default === undefined ||
         getAttribute(object, name) !== undefined
       ) {
         continue;
       }
-      value = def.default;
+      value = attribute.default;
     }
 
-    setAttribute(object, name, value, def);
+    setAttribute(object, name, value, attribute);
 
     if (cb) {
-      cb(def, name, value);
+      cb(attribute, name, value);
     }
   }
 }
@@ -42,12 +43,11 @@ export function setAttributes(object, source, definitions, cb) {
 export function getAttributes(object, definitions, filter) {
   const result = {};
 
-  for (const [path, def] of attributeIterator(definitions, filter)) {
+  for (const [path, attribute] of attributeIterator(definitions, filter)) {
     const name = path.join(".");
-
-    const value = getAttribute(object, name, def);
+    const value = getAttribute(object, name, attribute);
     if (value !== undefined) {
-      setAttribute(result, name, value, def);
+      setAttribute(result, name, value, attribute);
     }
   }
   return result;
@@ -63,16 +63,16 @@ export function getAttributes(object, definitions, filter) {
 export function getAttributesJSON(object, definitions, filter) {
   const result = {};
 
-  for (const [path, def] of attributeIterator(definitions, filter)) {
+  for (const [path, attribute] of attributeIterator(definitions, filter)) {
     const name = path.join(".");
 
-    let value = getAttribute(object, name, def);
+    let value = getAttribute(object, name, attribute);
     if (value !== undefined) {
       value = toExternal(value);
       if (value instanceof Set) {
         value = [...value];
       }
-      setAttribute(result, def.externalName ?? name, value, default_attribute);
+      setAttribute(result, attribute.externalName ?? name, value, default_attribute);
     }
   }
   return result;

package/src/types.mjs

@@ -98,8 +98,8 @@ export const types = {
   },
   url: {
     name: "url",
-    toInternal: emptyStringIsUndefined,
-    primitive: true
+    primitive: true,
+    toInternal: emptyStringIsUndefined
   },
   object: { name: "object", primitive: false }
 };
@@ -193,11 +193,17 @@ export function resolveTypeLinks() {
       type.owners = type.owners.map(owner => raiseOnUnknownType(owner, type));
     }
 
-    for (const [path, attribute] of attributeIterator(type.attributes)) {
-      if (typeof attribute.type === "string") {
-        attribute.type = oneOfType(attribute.type);
-      }
+    for (const [path, attribute] of attributeIterator(
+      type.attributes,
+      attribute => typeof attribute.type === "string"
+    )) {
+      attribute.type = oneOfType(attribute.type);
     }
   }
 }
 
+export function create(type, owner, data) {
+  const factory = type.factoryFor?.(owner, data) || type;
+  return new factory(data);
+}
+

package/types/common-attributes.d.mts

@@ -7,11 +7,11 @@
  * @property {boolean} writable can this attribute be modified
  * @property {boolean} mandatory
  * @property {boolean} collection are we a collection (set, map, array, object)
- * @property {AttributeDefinition} [backpointer]
- * @property {Function} [constructor] (collection) constructor
  * @property {boolean} [private] should the value be shown
  * @property {boolean} [credential] any type of credential
  * @property {boolean} [persistent] should we be stored (especially critical for credentials)
+ * @property {AttributeDefinition} [backpointer]
+ * @property {Function} [constructor] (collection) constructor
  * @property {string} [depends] name of an attribute we depend on
  * @property {string} [description] human readable
  * @property {any} [default] the default value
@@ -34,6 +34,10 @@ export const default_attribute: AttributeDefinition;
  * @type {AttributeDefinition}
  */
 export const default_attribute_writable: AttributeDefinition;
+/**
+ * @type {AttributeDefinition}
+ */
+export const default_collection_attribute: AttributeDefinition;
 /**
  * @type {AttributeDefinition}
  */
@@ -130,12 +134,12 @@ export namespace yesno_attribute_writable {
     export let key: boolean;
     export let mandatory: boolean;
     export let collection: boolean;
-    export let backpointer: AttributeDefinition | undefined;
-    export let constructor: Function | undefined;
     let _private: boolean | undefined;
     export { _private as private };
     export let credential: boolean | undefined;
     export let persistent: boolean | undefined;
+    export let backpointer: AttributeDefinition | undefined;
+    export let constructor: Function | undefined;
     export let depends: string | undefined;
     export let description: string | undefined;
     let _default: any;
@@ -300,11 +304,6 @@ export type AttributeDefinition = {
      * are we a collection (set, map, array, object)
      */
     collection: boolean;
-    backpointer?: AttributeDefinition | undefined;
-    /**
-     * (collection) constructor
-     */
-    constructor?: Function | undefined;
     /**
      * should the value be shown
      */
@@ -317,6 +316,11 @@ export type AttributeDefinition = {
      * should we be stored (especially critical for credentials)
      */
     persistent?: boolean | undefined;
+    backpointer?: AttributeDefinition | undefined;
+    /**
+     * (collection) constructor
+     */
+    constructor?: Function | undefined;
     /**
      * name of an attribute we depend on
      */

package/types/extract.d.mts

@@ -0,0 +1 @@
+export function extract(object: any, type?: any): {};

package/types/module.d.mts

@@ -2,6 +2,7 @@ export * from "./types.mjs";
 export * from "./time.mjs";
 export * from "./bytes.mjs";
 export * from "./attributes.mjs";
+export * from "./extract.mjs";
 export * from "./tokens.mjs";
 export * from "./filter.mjs";
 export * from "./multiple.mjs";

package/types/types.d.mts

@@ -1,6 +1,7 @@
 export function addType(type: any): any;
 export function oneOfType(definition: any): any;
 export function resolveTypeLinks(): void;
+export function create(type: any, owner: any, data: any): any;
 export const types: {
     string: {
         name: string;
@@ -52,8 +53,8 @@ export const types: {
     };
     url: {
         name: string;
-        toInternal: (value: any) => any;
         primitive: boolean;
+        toInternal: (value: any) => any;
     };
     object: {
         name: string;