repository-provider 26.4.3 → 26.6.0

package/README.md

@@ -146,33 +146,31 @@ console.log(await readme.getString());
 *   [priority](#priority)
 *   [name](#name-1)
 *   [messageDestination](#messagedestination-1)
-*   [Commit](#commit)
-    *   [Properties](#properties-2)
-*   [Commit](#commit-1)
-    *   [Parameters](#parameters-32)
-    *   [Properties](#properties-3)
-*   [CommitResult](#commitresult)
-    *   [Properties](#properties-4)
 *   [Branch](#branch)
-    *   [Parameters](#parameters-33)
-    *   [Properties](#properties-5)
+    *   [Parameters](#parameters-32)
+    *   [Properties](#properties-2)
     *   [url](#url-1)
     *   [refType](#reftype)
     *   [isDefault](#isdefault)
     *   [delete](#delete)
-    *   [commit](#commit-2)
-        *   [Parameters](#parameters-34)
+    *   [commit](#commit)
+        *   [Parameters](#parameters-33)
     *   [commitIntoPullRequest](#commitintopullrequest)
-        *   [Parameters](#parameters-35)
+        *   [Parameters](#parameters-34)
     *   [removeEntries](#removeentries)
-        *   [Parameters](#parameters-36)
+        *   [Parameters](#parameters-35)
     *   [createPullRequest](#createpullrequest)
-        *   [Parameters](#parameters-37)
+        *   [Parameters](#parameters-36)
     *   [createBranch](#createbranch)
-        *   [Parameters](#parameters-38)
+        *   [Parameters](#parameters-37)
+*   [CommitResult](#commitresult)
+    *   [Properties](#properties-3)
+*   [Commit](#commit-1)
+    *   [Parameters](#parameters-38)
+    *   [Properties](#properties-4)
 *   [Hook](#hook)
     *   [Parameters](#parameters-39)
-    *   [Properties](#properties-6)
+    *   [Properties](#properties-5)
     *   [equals](#equals-2)
         *   [Parameters](#parameters-40)
     *   [toJSON](#tojson-1)
@@ -196,7 +194,7 @@ console.log(await readme.getString());
         *   [Parameters](#parameters-49)
 *   [NamedObject](#namedobject)
     *   [Parameters](#parameters-50)
-    *   [Properties](#properties-7)
+    *   [Properties](#properties-6)
     *   [equals](#equals-3)
         *   [Parameters](#parameters-51)
     *   [displayName](#displayname)
@@ -205,7 +203,7 @@ console.log(await readme.getString());
     *   [Parameters](#parameters-52)
 *   [PullRequest](#pullrequest)
     *   [Parameters](#parameters-53)
-    *   [Properties](#properties-8)
+    *   [Properties](#properties-7)
     *   [fullName](#fullname)
     *   [url](#url-2)
     *   [repository](#repository-1)
@@ -232,7 +230,7 @@ console.log(await readme.getString());
 *   [merged](#merged)
 *   [draft](#draft)
 *   [ContentEntry](#contententry)
-    *   [Properties](#properties-9)
+    *   [Properties](#properties-8)
 *   [Ref](#ref)
     *   [Parameters](#parameters-58)
     *   [equals](#equals-5)
@@ -262,7 +260,7 @@ console.log(await readme.getString());
 *   [isProtected](#isprotected-1)
 *   [RepositoryGroup](#repositorygroup-1)
     *   [Parameters](#parameters-64)
-    *   [Properties](#properties-10)
+    *   [Properties](#properties-9)
     *   [attributeMapping](#attributemapping-1)
 *   [type](#type)
 *   [url](#url-3)
@@ -270,7 +268,7 @@ console.log(await readme.getString());
     *   [Parameters](#parameters-65)
 *   [Repository](#repository-2)
     *   [Parameters](#parameters-66)
-    *   [Properties](#properties-11)
+    *   [Properties](#properties-10)
     *   [fullName](#fullname-2)
     *   [slug](#slug)
     *   [provider](#provider-3)
@@ -374,8 +372,9 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
 
 *   `type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
 *   `writable` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
-*   `private` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
+*   `private` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** should the value be shown
 *   `description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+*   `default` **any?** the default value
 
 ## definePropertiesFromOptions
 
@@ -404,7 +403,7 @@ Object.definedProperties(new aClass(),{ with_default: { value: 77 }})
 *   `object` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** target object
 *   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** as passed to object constructor (optional, default `{}`)
 *   `properties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** object properties (optional, default `{}`)
-*   `attributes` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**  (optional, default `object.constructor.attributes`)
+*   `attributes` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**  (optional, default `object.constructor.attributes||[]`)
 
 ## defaultValues
 
@@ -905,35 +904,6 @@ Name of the provider
 
 to forward info/warn and error messages to
 
-## Commit
-
-Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
-
-### Properties
-
-*   `message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
-*   `updates` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[ContentEntry](#contententry)>** 
-
-## Commit
-
-### Parameters
-
-*   `repository`  
-
-### Properties
-
-*   `repository` **[Repository](#repository)** 
-*   `message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
-*   `sha` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
-
-## CommitResult
-
-Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
-
-### Properties
-
-*   `ref` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
-
 ## Branch
 
 **Extends Ref**
@@ -1038,6 +1008,26 @@ Simply calls Repository.createBranch() with the receiver as source branch
 
 Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Branch](#branch)>** newly created branch (or already present old one with the same name)
 
+## CommitResult
+
+Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
+
+### Properties
+
+*   `ref` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+
+## Commit
+
+### Parameters
+
+*   `repository`  
+
+### Properties
+
+*   `repository` **[Repository](#repository)** 
+*   `message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+*   `sha` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+
 ## Hook
 
 **Extends BaseObject**
@@ -1436,7 +1426,7 @@ List entries of the branch.
 
 #### Parameters
 
-*   `matchingPatterns` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** 
+*   `matchingPatterns` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>?** 
 
 Returns **AsyncIterator<[ContentEntry](#contententry)>** all matching entries in the branch
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "repository-provider",
-  "version": "26.4.3",
+  "version": "26.6.0",
   "publishConfig": {
     "access": "public"
   },
@@ -30,15 +30,15 @@
     "lint:tsc": "tsc --allowJs --checkJs --noEmit -module nodenext -t es2022 ./src/*.mjs"
   },
   "dependencies": {
-    "matching-iterator": "^2.0.1"
+    "matching-iterator": "^2.0.2"
   },
   "devDependencies": {
     "ava": "^4.0.1",
     "c8": "^7.11.0",
     "documentation": "^13.2.5",
-    "repository-provider-test-support": "^1.9.9",
+    "repository-provider-test-support": "^1.12.0",
     "semantic-release": "^19.0.2",
-    "typescript": "^4.6.0-dev.20220126"
+    "typescript": "^4.6.0-dev.20220204"
   },
   "engines": {
     "node": ">=14.18.3"

package/src/attribute.mjs

@@ -3,8 +3,10 @@
  *
  * @property {string} type
  * @property {boolean} writable
- * @property {boolean} private
+ * @property {boolean} [private] should the value be shown
  * @property {string} description
+ * @property {any} [default]  the default value
+ * @property {string|string[]} [env] environment variable use to provide the value
  */
 
 /**
@@ -34,69 +36,68 @@ export function definePropertiesFromOptions(
   object,
   options = {},
   properties = {},
-  attributes = object.constructor.attributes
+  attributes = object.constructor.attributes || []
 ) {
   const applyLater = {};
 
-  if (attributes !== undefined) {
-    Object.entries(attributes).forEach(([name, attribute]) => {
-      const path = name.split(/\./);
-      const first = path.shift();
-      const property = properties[first];
-
-      let value = options[name];
-      if (value === undefined) {
-        if (attribute.getDefault) {
-          value = attribute.getDefault(attribute, object);
-        } else if (
-          attribute.default !== undefined &&
-          attribute.default !== getAttribute(object, name)
-        ) {
-          value = attribute.default;
-        }
+  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.getDefault) {
+        value = attribute.getDefault(attribute, object);
+      } 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 "boolean":
-            if (value !== undefined) {
-              value =
-                value === 0 || value === "0" || value === false ? false : true;
-            }
-            break;
-        }
+    if (attribute.set) {
+      value = attribute.set(value);
+    } else {
+      switch (attribute.type) {
+        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 };
-        }
+    if (path.length) {
+      const remaining = path.join(".");
+      if (property) {
+        setAttribute(property.value, remaining, value);
       } else {
-        if (value !== undefined) {
-          const op = Object.getOwnPropertyDescriptor(
-            object.constructor.prototype,
-            first
+        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 && op.set) || (property && property.set)) {
+          applyLater[first] = value;
+        } else {
+          properties[first] = Object.assign(
+            { value, writable: attribute.writable },
+            property
           );
-
-          if ((op && op.set) || (property && property.set)) {
-            applyLater[first] = value;
-          } else {
-            properties[first] = Object.assign(
-              { value, writable: attribute.writable },
-              property
-            );
-          }
         }
       }
-    });
-  }
+    }
+  });
 
   Object.defineProperties(object, properties);
   Object.assign(object, applyLater);
@@ -114,8 +115,7 @@ export function defaultValues(attributes, object) {
 
       if (attribute.default !== undefined) {
         a.push([name, attribute.default]);
-      }
-      else if (attribute.getDefault !== undefined) {
+      } else if (attribute.getDefault !== undefined) {
         a.push([name, attribute.getDefault(attribute, object)]);
       }
 
@@ -155,6 +155,10 @@ export function setAttribute(object, name, value) {
 export function getAttribute(object, name) {
   let value = object;
 
+  if(value && value[name] !== undefined) {
+    return value[name];
+  }
+
   for (const p of name.split(/\./)) {
     if (value === undefined) {
       break;

package/src/base-object.mjs

@@ -65,8 +65,8 @@ export class BaseObject {
 
   /**
    * Creates an instance of BaseObject.
-   * @param {*} options
-   * @param {*} additionalProperties
+   * @param {object} options
+   * @param {object} additionalProperties
    */
   constructor(options, additionalProperties) {
     definePropertiesFromOptions(

package/src/base-provider.mjs

@@ -1,5 +1,4 @@
 import { asArray, stripBaseName } from "./util.mjs";
-import { definePropertiesFromOptions } from "./attribute.mjs";
 import { PullRequest } from "./pull-request.mjs";
 import { RepositoryGroup } from "./repository-group.mjs";
 import { Repository } from "./repository.mjs";
@@ -8,6 +7,7 @@ import { Tag } from "./tag.mjs";
 import { Hook } from "./hook.mjs";
 import { Project } from "./project.mjs";
 import { Milestone } from "./milestone.mjs";
+import { BaseObject } from "./base-object.mjs";
 
 /**
  * @typedef {Object} MessageDestination
@@ -20,7 +20,7 @@ import { Milestone } from "./milestone.mjs";
 /**
  * @property {MessageDestination} messageDestination
  */
-export class BaseProvider {
+export class BaseProvider extends BaseObject {
   /**
    * @return {string} identifier for environment options
    */
@@ -87,6 +87,7 @@ export class BaseProvider {
 
   static get attributes() {
     return {
+      ...super.attributes,
       /**
        * In case there are several provider able to support a given source which one sould be used ?
        * this defines the order
@@ -100,7 +101,8 @@ export class BaseProvider {
        * Name of the provider
        */
       name: {
-        type: "string"
+        type: "string",
+        env: ["{{instanceIdentifier}}NAME"]
       },
 
       url: {
@@ -141,10 +143,6 @@ export class BaseProvider {
     }
   }
 
-  constructor(options, properties) {
-    definePropertiesFromOptions(this, options, properties);
-  }
-
   /**
    * @return {boolean} true if other provider is the same as the receiver
    */
@@ -401,6 +399,11 @@ export class BaseProvider {
     return this.constructor.name;
   }
 
+  get fullName()
+  {
+    return this.name;
+  }
+
   /**
    * We are our own provider.
    * @return {BaseProvider} this

package/src/branch.mjs

@@ -1,17 +1,8 @@
 import { Ref } from "./ref.mjs";
 import { PullRequest } from "./pull-request.mjs";
 import { Repository } from "./repository.mjs";
+import { Commit } from "./commit.mjs";
 
-/**
- * @typedef {Object} Commit
- * @property {string} message
- * @property {ContentEntry[]} updates
- */
-
-/**
- * @typedef {Object} CommitResult
- * @property {string} ref
- */
 
 /**
  * Abstract branch.

package/src/commit.mjs

@@ -1,3 +1,10 @@
+
+
+/**
+ * @typedef {Object} CommitResult
+ * @property {string} ref
+ */
+
 /**
  * @property {Repository} repository
  * @property {string} message

package/src/multi-group-provider.mjs

@@ -50,9 +50,7 @@ export class MultiGroupProvider extends BaseProvider {
         if (rg !== undefined) {
           const r = await rg.repository(repository);
           if (r !== undefined) {
-            return r.branch(
-              branch === undefined ? r.defaultBranchName : branch
-            );
+            return r.branch( r.defaultBranchName || branch);
           }
         }
       }

package/src/ref.mjs

@@ -1,9 +1,11 @@
 import { NamedObject } from "./named-object.mjs";
+
 /**
  * @typedef {Object} ContentEntry
  * @property {string} name
  * 
  */
+
 /**
  * Base for Branch and Tag
  */
@@ -59,7 +61,7 @@ export class Ref extends NamedObject {
 
   /**
    * List entries of the branch.
-   * @param {string[]} matchingPatterns
+   * @param {string[]} [matchingPatterns]
    * @return {AsyncIterator<ContentEntry>} all matching entries in the branch
    */
   async *entries(matchingPatterns) {}