repository-provider 28.0.0 → 28.2.0

package/README.md

@@ -69,12 +69,14 @@ console.log(await readme.getString());
     *   [equals](#equals)
         *   [Parameters](#parameters-9)
     *   [provider](#provider)
-    *   [info](#info)
+    *   [trace](#trace)
         *   [Parameters](#parameters-10)
-    *   [warn](#warn)
+    *   [info](#info)
         *   [Parameters](#parameters-11)
-    *   [error](#error)
+    *   [warn](#warn)
         *   [Parameters](#parameters-12)
+    *   [error](#error)
+        *   [Parameters](#parameters-13)
     *   [repositoryClass](#repositoryclass)
     *   [pullRequestClass](#pullrequestclass)
     *   [branchClass](#branchclass)
@@ -90,9 +92,9 @@ console.log(await readme.getString());
 *   [avatarURL](#avatarurl)
 *   [homePageURL](#homepageurl)
 *   [MessageDestination](#messagedestination)
-    *   [Parameters](#parameters-13)
-*   [BaseProvider](#baseprovider)
     *   [Properties](#properties-1)
+*   [BaseProvider](#baseprovider)
+    *   [Properties](#properties-2)
     *   [equals](#equals-1)
         *   [Parameters](#parameters-14)
     *   [repositoryBases](#repositorybases)
@@ -148,7 +150,7 @@ console.log(await readme.getString());
 *   [messageDestination](#messagedestination-1)
 *   [Branch](#branch)
     *   [Parameters](#parameters-31)
-    *   [Properties](#properties-2)
+    *   [Properties](#properties-3)
     *   [url](#url-1)
     *   [refType](#reftype)
     *   [isDefault](#isdefault)
@@ -164,13 +166,13 @@ console.log(await readme.getString());
     *   [createBranch](#createbranch)
         *   [Parameters](#parameters-36)
 *   [CommitResult](#commitresult)
-    *   [Properties](#properties-3)
+    *   [Properties](#properties-4)
 *   [Commit](#commit-1)
     *   [Parameters](#parameters-37)
-    *   [Properties](#properties-4)
+    *   [Properties](#properties-5)
 *   [Hook](#hook)
     *   [Parameters](#parameters-38)
-    *   [Properties](#properties-5)
+    *   [Properties](#properties-6)
     *   [equals](#equals-2)
         *   [Parameters](#parameters-39)
     *   [toJSON](#tojson-1)
@@ -194,7 +196,7 @@ console.log(await readme.getString());
         *   [Parameters](#parameters-48)
 *   [NamedObject](#namedobject)
     *   [Parameters](#parameters-49)
-    *   [Properties](#properties-6)
+    *   [Properties](#properties-7)
     *   [equals](#equals-3)
         *   [Parameters](#parameters-50)
     *   [displayName](#displayname)
@@ -204,7 +206,7 @@ console.log(await readme.getString());
     *   [Parameters](#parameters-51)
 *   [PullRequest](#pullrequest)
     *   [Parameters](#parameters-52)
-    *   [Properties](#properties-7)
+    *   [Properties](#properties-8)
     *   [fullName](#fullname-2)
     *   [url](#url-2)
     *   [repository](#repository-1)
@@ -231,7 +233,7 @@ console.log(await readme.getString());
 *   [merged](#merged)
 *   [draft](#draft)
 *   [ContentEntry](#contententry)
-    *   [Properties](#properties-8)
+    *   [Properties](#properties-9)
 *   [Ref](#ref)
     *   [Parameters](#parameters-57)
     *   [equals](#equals-5)
@@ -262,7 +264,7 @@ console.log(await readme.getString());
 *   [isProtected](#isprotected-1)
 *   [RepositoryGroup](#repositorygroup-1)
     *   [Parameters](#parameters-63)
-    *   [Properties](#properties-9)
+    *   [Properties](#properties-10)
     *   [attributeMapping](#attributemapping-1)
 *   [type](#type)
 *   [url](#url-3)
@@ -270,7 +272,7 @@ console.log(await readme.getString());
     *   [Parameters](#parameters-64)
 *   [Repository](#repository-2)
     *   [Parameters](#parameters-65)
-    *   [Properties](#properties-10)
+    *   [Properties](#properties-11)
     *   [fullName](#fullname-4)
     *   [slug](#slug)
     *   [provider](#provider-3)
@@ -283,6 +285,8 @@ console.log(await readme.getString());
         *   [Parameters](#parameters-68)
     *   [maybeEntry](#maybeentry-1)
         *   [Parameters](#parameters-69)
+    *   [commits](#commits)
+        *   [Parameters](#parameters-70)
     *   [urls](#urls)
     *   [url](#url-4)
     *   [cloneURL](#cloneurl)
@@ -296,40 +300,40 @@ console.log(await readme.getString());
     *   [delete](#delete-2)
     *   [defaultBranch](#defaultbranch)
     *   [branch](#branch-2)
-        *   [Parameters](#parameters-70)
-    *   [branches](#branches-1)
         *   [Parameters](#parameters-71)
-    *   [createBranch](#createbranch-1)
+    *   [branches](#branches-1)
         *   [Parameters](#parameters-72)
-    *   [addBranch](#addbranch)
+    *   [createBranch](#createbranch-1)
         *   [Parameters](#parameters-73)
-    *   [deleteBranch](#deletebranch)
+    *   [addBranch](#addbranch)
         *   [Parameters](#parameters-74)
-    *   [tag](#tag)
+    *   [deleteBranch](#deletebranch)
         *   [Parameters](#parameters-75)
-    *   [tags](#tags-1)
+    *   [tag](#tag)
         *   [Parameters](#parameters-76)
-    *   [addTag](#addtag)
+    *   [tags](#tags-1)
         *   [Parameters](#parameters-77)
-    *   [createPullRequest](#createpullrequest-1)
+    *   [addTag](#addtag)
         *   [Parameters](#parameters-78)
-    *   [addPullRequest](#addpullrequest)
+    *   [createPullRequest](#createpullrequest-1)
         *   [Parameters](#parameters-79)
+    *   [addPullRequest](#addpullrequest)
+        *   [Parameters](#parameters-80)
     *   [pullRequests](#pullrequests-1)
     *   [pullRequest](#pullrequest-1)
-        *   [Parameters](#parameters-80)
-    *   [deletePullRequest](#deletepullrequest)
         *   [Parameters](#parameters-81)
-    *   [addHook](#addhook)
+    *   [deletePullRequest](#deletepullrequest)
         *   [Parameters](#parameters-82)
-    *   [createHook](#createhook)
+    *   [addHook](#addhook)
         *   [Parameters](#parameters-83)
+    *   [createHook](#createhook)
+        *   [Parameters](#parameters-84)
     *   [hooks](#hooks-1)
     *   [hook](#hook-1)
-        *   [Parameters](#parameters-84)
+        *   [Parameters](#parameters-85)
     *   [type](#type-1)
     *   [refId](#refid-1)
-        *   [Parameters](#parameters-85)
+        *   [Parameters](#parameters-86)
     *   [toString](#tostring-1)
     *   [toJSON](#tojson-3)
     *   [attributes](#attributes-2)
@@ -339,23 +343,23 @@ console.log(await readme.getString());
 *   [Review](#review)
 *   [SingleGroupProvider](#singlegroupprovider)
     *   [repository](#repository-3)
-        *   [Parameters](#parameters-86)
-    *   [repositoryGroup](#repositorygroup-2)
         *   [Parameters](#parameters-87)
-    *   [repositoryGroups](#repositorygroups-1)
+    *   [repositoryGroup](#repositorygroup-2)
         *   [Parameters](#parameters-88)
+    *   [repositoryGroups](#repositorygroups-1)
+        *   [Parameters](#parameters-89)
 *   [Tag](#tag-1)
-    *   [Parameters](#parameters-89)
+    *   [Parameters](#parameters-90)
     *   [refType](#reftype-1)
     *   [isWritable](#iswritable-1)
 *   [asArray](#asarray)
-    *   [Parameters](#parameters-90)
-*   [stripBaseName](#stripbasename)
     *   [Parameters](#parameters-91)
-*   [stripBaseNames](#stripbasenames)
+*   [stripBaseName](#stripbasename)
     *   [Parameters](#parameters-92)
-*   [generateBranchName](#generatebranchname)
+*   [stripBaseNames](#stripbasenames)
     *   [Parameters](#parameters-93)
+*   [generateBranchName](#generatebranchname)
+    *   [Parameters](#parameters-94)
 
 ## Application
 
@@ -514,6 +518,14 @@ The provider we live in.
 
 Returns **[BaseProvider](#baseprovider)** 
 
+### trace
+
+Forwarded to the owner.
+
+#### Parameters
+
+*   `args` **...any** 
+
 ### info
 
 Forwarded to the owner.
@@ -622,7 +634,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
 
-### Parameters
+### Properties
 
 *   `info` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** 
 *   `warn` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** 
@@ -868,11 +880,12 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 Extract options suitable for the constructor
 form the given set of environment variables.
+Object with the detected key value pairs is delivered.
 
 #### Parameters
 
-*   `env` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** taken from process.env
-*   `instanceIdentifier` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**  (optional, default `this.instanceIdentifier`)
+*   `env` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** as from process.env
+*   `instanceIdentifier` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** part of variable name. (optional, default `this.instanceIdentifier`)
 
 Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** undefined if no suitable environment variables have been found
 
@@ -901,16 +914,16 @@ Returns **[BaseProvider](#baseprovider)** newly created provider or undefined if
 
 ## priority
 
-In case there are several provider able to support a given source which one sould be used ?
+In case there are several providers able to support a given source which one sould be used ?
 this defines the order
 
 ## name
 
-Name of the provider
+Name of the provider.
 
 ## messageDestination
 
-to forward info/warn and error messages to
+To forward info/warn and error messages to
 
 ## Branch
 
@@ -940,7 +953,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 ### refType
 
-Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** tags
+Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** heades
 
 ### isDefault
 
@@ -1035,6 +1048,8 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
 *   `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)** 
+*   `author` **User** 
+*   `committer` **User** 
 
 ## Hook
 
@@ -1322,8 +1337,8 @@ Returns **[Set](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Glob
 
 ### list
 
-List all pull request for a given repo
-result will be filtered by source branch, destination branch and states
+List all pull request for a given repo.
+Result will be filtered by source branch, destination branch and states
 
 #### Parameters
 
@@ -1683,6 +1698,16 @@ Get exactly one matching entry by name or undefined if no such entry is found.
 
 Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[ContentEntry](#contententry)>** 
 
+### commits
+
+List commits of the default branch.
+
+#### Parameters
+
+*   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
+
+Returns **AsyncIterator<[Commit](#commit)>** all matching commits in the repository
+
 ### urls
 
 Urls to access the repo.
@@ -1840,7 +1865,7 @@ Returns **[Tag](#tag)** newly created tag
 
 ### createPullRequest
 
-Create a pull request (or deliver an already present for thefiven name).
+Create a pull request (or deliver an already present for the given name).
 
 #### Parameters
 
@@ -2026,6 +2051,8 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 ### isWritable
 
+Tags cannot be written to.
+
 Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** false
 
 ## asArray

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "repository-provider",
-  "version": "28.0.0",
+  "version": "28.2.0",
   "publishConfig": {
     "access": "public"
   },
@@ -33,10 +33,10 @@
     "matching-iterator": "^2.0.4"
   },
   "devDependencies": {
-    "ava": "^4.1.0",
-    "c8": "^7.11.0",
+    "ava": "^4.2.0",
+    "c8": "^7.11.2",
     "documentation": "^13.2.5",
-    "repository-provider-test-support": "^1.12.11",
+    "repository-provider-test-support": "^2.1.2",
     "semantic-release": "^19.0.2",
     "typescript": "^4.6.3"
   },

package/src/base-object.mjs

@@ -98,6 +98,14 @@ export class BaseObject {
     return this.owner.provider;
   }
 
+  /**
+   * Forwarded to the owner.
+   * @param  {...any} args
+   */
+  trace(...args) {
+    return this.owner.trace(...args);
+  }
+
   /**
    * Forwarded to the owner.
    * @param  {...any} args
@@ -166,7 +174,7 @@ export class BaseObject {
    * By default we use the owners implementation.
    * @return {Function} as defined in the owner
    */
-   get hookClass() {
+  get hookClass() {
     return this.owner.hookClass;
   }
 }

package/src/base-provider.mjs

@@ -31,7 +31,8 @@ export class BaseProvider extends BaseObject {
   /**
    * Extract options suitable for the constructor
    * form the given set of environment variables.
-   * @param {Object} env as of from process.env
+   * Object with the detected key value pairs is delivered.
+   * @param {Object} env as from process.env
    * @param {string} instanceIdentifier part of variable name.
    * @return {Object} undefined if no suitable environment variables have been found
    */
@@ -58,8 +59,11 @@ export class BaseProvider extends BaseObject {
             if (options === undefined) {
               options = {};
             }
-            options[name] = value;
-            Object.assign(options, attribute.additionalAttributes);
+
+            if(options[name] === undefined) {
+              options[name] = value;
+              Object.assign(options, attribute.additionalAttributes);
+            }
             break;
           }
         }
@@ -449,6 +453,10 @@ export class BaseProvider extends BaseObject {
 
   initializeRepositories() {}
 
+  trace(...args) {
+    return this.messageDestination.trace(...args);
+  }
+
   info(...args) {
     return this.messageDestination.info(...args);
   }

package/src/pull-request.mjs

@@ -52,8 +52,8 @@ export class PullRequest extends NamedObject {
   }
 
   /**
-   * List all pull request for a given repo
-   * result will be filtered by source branch, destination branch and states
+   * List all pull request for a given repo.
+   * Result will be filtered by source branch, destination branch and states
    * @param {Repository} repository
    * @param {Object} filter
    * @param {Branch?} filter.source

package/src/repository.mjs

@@ -260,6 +260,15 @@ export class Repository extends NamedObject {
    * @return {Promise<Branch>}
    */
   async branch(name) {
+    if(name === this.defaultBranchName) {
+      const branch = this._branches.get(name);
+      if(branch) {
+        return branch;
+      }
+      
+      return this.addBranch(name);
+    }
+
     await this.initializeBranches();
     return this._branches.get(name);
   }
@@ -358,7 +367,7 @@ export class Repository extends NamedObject {
   }
 
   /**
-   * Create a pull request (or deliver an already present for thefiven name).
+   * Create a pull request (or deliver an already present for the given name).
    * @param {string} name of the pr
    * @param {Branch} source branch
    * @param {Object} options