repository-provider 32.6.3 → 32.6.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "repository-provider",
-  "version": "32.6.3",
+  "version": "32.6.5",
   "publishConfig": {
     "access": "public"
   },
@@ -34,12 +34,12 @@
   },
   "devDependencies": {
     "ava": "^5.1.1",
-    "browser-ava": "^1.3.19",
+    "browser-ava": "^1.3.20",
     "c8": "^7.12.0",
     "documentation": "^14.0.1",
     "repository-provider-test-support": "^2.2.36",
-    "semantic-release": "^20.0.3",
-    "typescript": "^4.9.4"
+    "semantic-release": "^20.1.0",
+    "typescript": "^4.9.5"
   },
   "engines": {
     "node": ">=16.19.0"

package/src/attribute-extras.mjs

@@ -0,0 +1,208 @@
+
+import { setAttribute, getAttribute } from "./attribute.mjs";
+
+/**
+ * @typedef {Object} Attribute
+ *
+ * @property {string} type
+ * @property {boolean} writable
+ * @property {boolean} [private] should the value be shown
+ * @property {string} [depends] name of an attribute we depend on
+ * @property {string} description
+ * @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 {string|string[]} [env] environment variable use to provide the value
+ */
+
+/**
+ * Create properties from options and default options.
+ * Already present properties (direct) are skipped.
+ * The attribute list from the class will be applied to the
+ * options and merged with the given set of properties.
+ * ```js
+ * class aClass {
+ *   static get attributes() {
+ *     return { with_default: { default: 77 }};
+ *   }
+ * }
+ *
+ * definePropertiesFromOptions(new aClass());
+ * // equivalent to
+ * Object.definedProperties(new aClass(),{ with_default: { value: 77 }})
+ * ```
+ * @see Object.definedProperties()
+ * @see Object.getOwnPropertyDescriptor()
+ * @param {Object} object target object
+ * @param {Object} options as passed to object constructor
+ * @param {Object} properties object properties
+ * @param {Object} attributes
+ */
+export function definePropertiesFromOptions(
+  object,
+  options = {},
+  properties = {},
+  attributes = object.constructor.attributes || []
+) {
+  const applyLater = {};
+
+  Object.entries(attributes).forEach(([name, attribute]) => {
+    const path = name.split(/\./);
+    const first = path.shift();
+    const property = properties[first];
+
+    let value = getAttribute(options, name);
+
+    if (value === undefined) {
+      if (attribute.get) {
+        value = attribute.get(attribute, object, properties);
+      } else if (
+        attribute.default !== undefined &&
+        attribute.default !== getAttribute(object, name)
+      ) {
+        value = attribute.default;
+      }
+    }
+
+    if (attribute.set) {
+      value = attribute.set(value);
+    } else {
+      switch (attribute.type) {
+        case "set":
+          if (Array.isArray(value)) {
+            value = new Set(value);
+          }
+          break;
+        case "boolean":
+          if (value !== undefined) {
+            value =
+              value === 0 || value === "0" || value === false ? false : true;
+          }
+          break;
+      }
+    }
+
+    if (path.length) {
+      const remaining = path.join(".");
+      if (property) {
+        setAttribute(property.value, remaining, value);
+      } else {
+        const slice = {};
+        setAttribute(slice, remaining, value);
+        properties[first] = { configurable: true, value: slice };
+      }
+    } else {
+      if (value !== undefined) {
+        const op = Object.getOwnPropertyDescriptor(
+          object.constructor.prototype,
+          first
+        );
+
+        if (op?.set || property?.set) {
+          applyLater[first] = value;
+        } else {
+          properties[first] = Object.assign(
+            { value, writable: attribute.writable },
+            property
+          );
+        }
+      }
+    }
+  });
+
+  Object.defineProperties(object, properties);
+  Object.assign(object, applyLater);
+}
+
+/**
+ * Get default values.
+ * @param {Object} attributes
+ * @return {Object} filled with default values
+ */
+export function defaultValues(attributes, object) {
+  return Object.fromEntries(
+    Object.entries(attributes).reduce((a, c) => {
+      const [name, attribute] = c;
+
+      if (attribute.default !== undefined) {
+        a.push([name, attribute.default]);
+      } else if (attribute.get !== undefined) {
+        const value = attribute.get(attribute, object);
+        if (value !== undefined) {
+          a.push([name, value]);
+        }
+      }
+
+      return a;
+    }, [])
+  );
+}
+
+/**
+ * Create json based on present options.
+ * In other words only produce key value pairs if value is defined.
+ * @param {Object} object
+ * @param {Object} initial
+ * @param {Object} attributes to operator on
+ * @return {Object} initial + defined values
+ */
+export function optionJSON(
+  object,
+  initial = {},
+  attributes = object.constructor.attributes
+) {
+  return attributes
+    ? Object.keys(attributes).reduce((a, c) => {
+        const value = object[c];
+        if (value !== undefined && !(value instanceof Function)) {
+          if (value instanceof Set) {
+            a[c] = [...value];
+          } else {
+            a[c] = value;
+          }
+        }
+        return a;
+      }, initial)
+    : initial;
+}
+
+/**
+ * Rename attributes.
+ * Filters out null, undefined and empty strings.
+ * ```js
+ * mapAttributes({a:1},{a:"a'"}) // {"a'": 1}
+ * ```
+ * @param {Object} object
+ * @param {Object} mapping
+ * @return {Object} keys renamed after mapping
+ */
+export function mapAttributes(object, mapping) {
+  if (object !== undefined) {
+    const o = {};
+
+    for (const k of Object.keys(object)) {
+      const v = getAttribute(object, k);
+      if (v !== undefined && v !== null && v !== "") {
+        setAttribute(o, mapping[k] || k, v);
+      }
+    }
+
+    return o;
+  }
+}
+
+/**
+ * Same as mapAttributes but with the inverse mapping.
+ * Filters out null, undefined and empty strings
+ * @param {Object} object
+ * @param {Object} mapping
+ * @return {Object} keys renamed after mapping
+ */
+export function mapAttributesInverse(object, mapping) {
+  return mapping === undefined
+    ? object
+    : mapAttributes(
+        object,
+        Object.fromEntries(Object.entries(mapping).map(([k, v]) => [v, k]))
+      );
+}

package/src/attribute.mjs

@@ -1,143 +1,7 @@
-/**
- * @typedef {Object} Attribute
- *
- * @property {string} type
- * @property {boolean} writable
- * @property {boolean} [private] should the value be shown
- * @property {string} [depends] name of an attribute we depend on
- * @property {string} description
- * @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 {string|string[]} [env] environment variable use to provide the value
- */
-
-/**
- * Create properties from options and default options.
- * Already present properties (direct) are skipped.
- * The attribute list from the class will be applied to the
- * options and merged with the given set of properties.
- * ```js
- * class aClass {
- *   static get attributes() {
- *     return { with_default: { default: 77 }};
- *   }
- * }
- *
- * definePropertiesFromOptions(new aClass());
- * // equivalent to
- * Object.definedProperties(new aClass(),{ with_default: { value: 77 }})
- * ```
- * @see Object.definedProperties()
- * @see Object.getOwnPropertyDescriptor()
- * @param {Object} object target object
- * @param {Object} options as passed to object constructor
- * @param {Object} properties object properties
- * @param {Object} attributes
- */
-export function definePropertiesFromOptions(
-  object,
-  options = {},
-  properties = {},
-  attributes = object.constructor.attributes || []
-) {
-  const applyLater = {};
-
-  Object.entries(attributes).forEach(([name, attribute]) => {
-    const path = name.split(/\./);
-    const first = path.shift();
-    const property = properties[first];
-
-    let value = getAttribute(options, name);
-
-    if (value === undefined) {
-      if (attribute.get) {
-        value = attribute.get(attribute, object, properties);
-      } else if (
-        attribute.default !== undefined &&
-        attribute.default !== getAttribute(object, name)
-      ) {
-        value = attribute.default;
-      }
-    }
-
-    if (attribute.set) {
-      value = attribute.set(value);
-    } else {
-      switch (attribute.type) {
-        case "set":
-          if (Array.isArray(value)) {
-            value = new Set(value);
-          }
-          break;
-        case "boolean":
-          if (value !== undefined) {
-            value =
-              value === 0 || value === "0" || value === false ? false : true;
-          }
-          break;
-      }
-    }
-
-    if (path.length) {
-      const remaining = path.join(".");
-      if (property) {
-        setAttribute(property.value, remaining, value);
-      } else {
-        const slice = {};
-        setAttribute(slice, remaining, value);
-        properties[first] = { configurable: true, value: slice };
-      }
-    } else {
-      if (value !== undefined) {
-        const op = Object.getOwnPropertyDescriptor(
-          object.constructor.prototype,
-          first
-        );
-
-        if (op?.set || property?.set) {
-          applyLater[first] = value;
-        } else {
-          properties[first] = Object.assign(
-            { value, writable: attribute.writable },
-            property
-          );
-        }
-      }
-    }
-  });
-
-  Object.defineProperties(object, properties);
-  Object.assign(object, applyLater);
-}
-
-/**
- * Get default values.
- * @param {Object} attributes
- * @return {Object} filled with default values
- */
-export function defaultValues(attributes, object) {
-  return Object.fromEntries(
-    Object.entries(attributes).reduce((a, c) => {
-      const [name, attribute] = c;
-
-      if (attribute.default !== undefined) {
-        a.push([name, attribute.default]);
-      } else if (attribute.get !== undefined) {
-        const value = attribute.get(attribute, object);
-        if (value !== undefined) {
-          a.push([name, value]);
-        }
-      }
-
-      return a;
-    }, [])
-  );
-}
 
 /**
  * Split property path into tokens
- * @param {string} string 
+ * @param {string} string
  * @return {Iterator<string>}
  */
 function* tokens(string) {
@@ -146,7 +10,12 @@ function* tokens(string) {
   for (const c of string) {
     switch (c) {
       case "\t":
-      case " ": break;
+      case " ":
+        break;
+
+      case ">":
+      case "<":
+
       case ".":
       case "[":
       case "]":
@@ -179,20 +48,22 @@ export function setAttribute(object, name, value) {
 
   for (const token of tokens(name)) {
     switch (token) {
+      case ">":
+      case "<":
       case ".":
-        case "[":
-        case "]":
-          break;
-  
-        default:
-          if (object[token] === undefined || typeof object[token] !== "object") {
-            object[token] = {};
-          }
+      case "[":
+      case "]":
+        break;
+
+      default:
+        if (object[token] === undefined || typeof object[token] !== "object") {
+          object[token] = {};
+        }
 
-          lastObject = object;
-          lastKey = token;
+        lastObject = object;
+        lastKey = token;
 
-          object = object[token];
+        object = object[token];
     }
   }
 
@@ -213,6 +84,8 @@ export function getAttribute(object, name) {
 
   for (const token of tokens(name)) {
     switch (token) {
+      case ">":
+      case "<":
       case ".":
       case "[":
       case "]":
@@ -229,72 +102,3 @@ export function getAttribute(object, name) {
 
   return object;
 }
-
-/**
- * Create json based on present options.
- * In other words only produce key value pairs if value is defined.
- * @param {Object} object
- * @param {Object} initial
- * @param {Object} attributes to operator on
- * @return {Object} initial + defined values
- */
-export function optionJSON(
-  object,
-  initial = {},
-  attributes = object.constructor.attributes
-) {
-  return attributes
-    ? Object.keys(attributes).reduce((a, c) => {
-        const value = object[c];
-        if (value !== undefined && !(value instanceof Function)) {
-          if (value instanceof Set) {
-            a[c] = [...value];
-          } else {
-            a[c] = value;
-          }
-        }
-        return a;
-      }, initial)
-    : initial;
-}
-
-/**
- * Rename attributes.
- * Filters out null, undefined and empty strings.
- * ```js
- * mapAttributes({a:1},{a:"a'"}) // {"a'": 1}
- * ```
- * @param {Object} object
- * @param {Object} mapping
- * @return {Object} keys renamed after mapping
- */
-export function mapAttributes(object, mapping) {
-  if (object !== undefined) {
-    const o = {};
-
-    for (const k of Object.keys(object)) {
-      const v = getAttribute(object, k);
-      if (v !== undefined && v !== null && v !== "") {
-        setAttribute(o, mapping[k] || k, v);
-      }
-    }
-
-    return o;
-  }
-}
-
-/**
- * Same as mapAttributes but with the inverse mapping.
- * Filters out null, undefined and empty strings
- * @param {Object} object
- * @param {Object} mapping
- * @return {Object} keys renamed after mapping
- */
-export function mapAttributesInverse(object, mapping) {
-  return mapping === undefined
-    ? object
-    : mapAttributes(
-        object,
-        Object.fromEntries(Object.entries(mapping).map(([k, v]) => [v, k]))
-      );
-}

package/src/base-object.mjs

@@ -1,4 +1,4 @@
-import { definePropertiesFromOptions, mapAttributes } from "./attribute.mjs";
+import { definePropertiesFromOptions, mapAttributes } from "./attribute-extras.mjs";
 import { description_attribute, id_attribute } from "./attributes.mjs";
 
 /**

package/src/index.mjs

@@ -19,5 +19,6 @@ export * from "./milestone.mjs";
 export * from "./review.mjs";
 export * from "./application.mjs";
 export * from "./attribute.mjs";
+export * from "./attribute-extras.mjs";
 export * from "./util.mjs";
 export * from "./attributes.mjs";

package/src/named-object.mjs

@@ -1,4 +1,4 @@
-import { optionJSON } from "./attribute.mjs";
+import { optionJSON } from "./attribute-extras.mjs";
 import { BaseObject } from "./base-object.mjs";
 import { name_attribute, url_attribute, description_attribute, id_attribute } from "./attributes.mjs";
 

package/src/pull-request.mjs

@@ -1,4 +1,4 @@
-import { optionJSON } from "./attribute.mjs";
+import { optionJSON } from "./attribute-extras.mjs";
 import { OwnedObject } from "./owned-object.mjs";
 import { Branch } from "./branch.mjs";
 import { Repository } from "./repository.mjs";