repository-provider 26.4.5 → 26.5.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)
@@ -905,35 +903,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 +1007,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 +1425,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.5",
+  "version": "26.5.0",
   "publishConfig": {
     "access": "public"
   },
@@ -38,7 +38,7 @@
     "documentation": "^13.2.5",
     "repository-provider-test-support": "^1.11.1",
     "semantic-release": "^19.0.2",
-    "typescript": "^4.6.0-dev.20220201"
+    "typescript": "^4.6.0-dev.20220203"
   },
   "engines": {
     "node": ">=14.18.3"

package/src/attribute.mjs

@@ -3,8 +3,9 @@
  *
  * @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
  */
 
 /**
@@ -43,7 +44,8 @@ export function definePropertiesFromOptions(
     const first = path.shift();
     const property = properties[first];
 
-    let value = options[name];
+    let value = getAttribute(options, name);
+
     if (value === undefined) {
       if (attribute.getDefault) {
         value = attribute.getDefault(attribute, object);
@@ -152,6 +154,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

@@ -8,6 +8,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 +21,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 +88,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
@@ -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