repository-provider 28.1.1 → 28.3.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)
@@ -94,36 +96,36 @@ console.log(await readme.getString());
 *   [BaseProvider](#baseprovider)
     *   [Properties](#properties-2)
     *   [equals](#equals-1)
-        *   [Parameters](#parameters-13)
+        *   [Parameters](#parameters-14)
     *   [repositoryBases](#repositorybases)
     *   [normalizeRepositoryName](#normalizerepositoryname)
-        *   [Parameters](#parameters-14)
-    *   [normalizeGroupName](#normalizegroupname)
         *   [Parameters](#parameters-15)
+    *   [normalizeGroupName](#normalizegroupname)
+        *   [Parameters](#parameters-16)
     *   [areRepositoryNamesCaseSensitive](#arerepositorynamescasesensitive)
     *   [areGroupNamesCaseSensitive](#aregroupnamescasesensitive)
     *   [supportsBase](#supportsbase)
-        *   [Parameters](#parameters-16)
-    *   [parseName](#parsename)
         *   [Parameters](#parameters-17)
-    *   [createRepository](#createrepository)
+    *   [parseName](#parsename)
         *   [Parameters](#parameters-18)
-    *   [list](#list)
+    *   [createRepository](#createrepository)
         *   [Parameters](#parameters-19)
-    *   [projects](#projects)
+    *   [list](#list)
         *   [Parameters](#parameters-20)
-    *   [milestones](#milestones)
+    *   [projects](#projects)
         *   [Parameters](#parameters-21)
-    *   [repositories](#repositories)
+    *   [milestones](#milestones)
         *   [Parameters](#parameters-22)
-    *   [branches](#branches)
+    *   [repositories](#repositories)
         *   [Parameters](#parameters-23)
-    *   [tags](#tags)
+    *   [branches](#branches)
         *   [Parameters](#parameters-24)
-    *   [hooks](#hooks)
+    *   [tags](#tags)
         *   [Parameters](#parameters-25)
-    *   [pullRequests](#pullrequests)
+    *   [hooks](#hooks)
         *   [Parameters](#parameters-26)
+    *   [pullRequests](#pullrequests)
+        *   [Parameters](#parameters-27)
     *   [name](#name)
     *   [fullName](#fullname)
     *   [provider](#provider-1)
@@ -138,82 +140,82 @@ console.log(await readme.getString());
     *   [pullRequestClass](#pullrequestclass-1)
     *   [instanceIdentifier](#instanceidentifier)
     *   [optionsFromEnvironment](#optionsfromenvironment)
-        *   [Parameters](#parameters-27)
-    *   [areOptionsSufficcient](#areoptionssufficcient)
         *   [Parameters](#parameters-28)
-    *   [initialize](#initialize)
+    *   [areOptionsSufficcient](#areoptionssufficcient)
         *   [Parameters](#parameters-29)
+    *   [initialize](#initialize)
+        *   [Parameters](#parameters-30)
 *   [priority](#priority)
 *   [name](#name-1)
 *   [messageDestination](#messagedestination-1)
 *   [Branch](#branch)
-    *   [Parameters](#parameters-30)
+    *   [Parameters](#parameters-31)
     *   [Properties](#properties-3)
     *   [url](#url-1)
     *   [refType](#reftype)
     *   [isDefault](#isdefault)
     *   [delete](#delete)
     *   [commit](#commit)
-        *   [Parameters](#parameters-31)
-    *   [commitIntoPullRequest](#commitintopullrequest)
         *   [Parameters](#parameters-32)
-    *   [removeEntries](#removeentries)
+    *   [commitIntoPullRequest](#commitintopullrequest)
         *   [Parameters](#parameters-33)
-    *   [createPullRequest](#createpullrequest)
+    *   [removeEntries](#removeentries)
         *   [Parameters](#parameters-34)
-    *   [createBranch](#createbranch)
+    *   [createPullRequest](#createpullrequest)
         *   [Parameters](#parameters-35)
+    *   [createBranch](#createbranch)
+        *   [Parameters](#parameters-36)
 *   [CommitResult](#commitresult)
     *   [Properties](#properties-4)
 *   [Commit](#commit-1)
-    *   [Parameters](#parameters-36)
+    *   [Parameters](#parameters-37)
     *   [Properties](#properties-5)
 *   [Hook](#hook)
-    *   [Parameters](#parameters-37)
+    *   [Parameters](#parameters-38)
     *   [Properties](#properties-6)
     *   [equals](#equals-2)
-        *   [Parameters](#parameters-38)
+        *   [Parameters](#parameters-39)
     *   [toJSON](#tojson-1)
 *   [Issue](#issue)
-    *   [Parameters](#parameters-39)
-*   [Milestone](#milestone)
     *   [Parameters](#parameters-40)
-*   [MultiGroupProvider](#multigroupprovider)
+*   [Milestone](#milestone)
     *   [Parameters](#parameters-41)
+*   [MultiGroupProvider](#multigroupprovider)
+    *   [Parameters](#parameters-42)
     *   [repository](#repository)
-        *   [Parameters](#parameters-42)
-    *   [branch](#branch-1)
         *   [Parameters](#parameters-43)
-    *   [repositoryGroup](#repositorygroup)
+    *   [branch](#branch-1)
         *   [Parameters](#parameters-44)
-    *   [repositoryGroups](#repositorygroups)
+    *   [repositoryGroup](#repositorygroup)
         *   [Parameters](#parameters-45)
-    *   [createRepositoryGroup](#createrepositorygroup)
+    *   [repositoryGroups](#repositorygroups)
         *   [Parameters](#parameters-46)
-    *   [addRepositoryGroup](#addrepositorygroup)
+    *   [createRepositoryGroup](#createrepositorygroup)
         *   [Parameters](#parameters-47)
+    *   [addRepositoryGroup](#addrepositorygroup)
+        *   [Parameters](#parameters-48)
 *   [NamedObject](#namedobject)
-    *   [Parameters](#parameters-48)
+    *   [Parameters](#parameters-49)
     *   [Properties](#properties-7)
     *   [equals](#equals-3)
-        *   [Parameters](#parameters-49)
+        *   [Parameters](#parameters-50)
     *   [displayName](#displayname)
     *   [fullName](#fullname-1)
     *   [toJSON](#tojson-2)
 *   [Project](#project)
-    *   [Parameters](#parameters-50)
-*   [PullRequest](#pullrequest)
     *   [Parameters](#parameters-51)
+*   [PullRequest](#pullrequest)
+    *   [Parameters](#parameters-52)
     *   [Properties](#properties-8)
     *   [fullName](#fullname-2)
     *   [url](#url-2)
     *   [repository](#repository-1)
     *   [provider](#provider-2)
     *   [equals](#equals-4)
-        *   [Parameters](#parameters-52)
+        *   [Parameters](#parameters-53)
     *   [delete](#delete-1)
     *   [merge](#merge)
-        *   [Parameters](#parameters-53)
+        *   [Parameters](#parameters-54)
     *   [decline](#decline)
     *   [reviews](#reviews)
     *   [identifier](#identifier)
@@ -221,9 +223,9 @@ console.log(await readme.getString());
     *   [defaultListStates](#defaultliststates)
     *   [validMergeMethods](#validmergemethods)
     *   [list](#list-1)
-        *   [Parameters](#parameters-54)
-    *   [open](#open)
         *   [Parameters](#parameters-55)
+    *   [open](#open)
+        *   [Parameters](#parameters-56)
 *   [title](#title)
 *   [body](#body)
 *   [state](#state)
@@ -233,19 +235,19 @@ console.log(await readme.getString());
 *   [ContentEntry](#contententry)
     *   [Properties](#properties-9)
 *   [Ref](#ref)
-    *   [Parameters](#parameters-56)
+    *   [Parameters](#parameters-57)
     *   [equals](#equals-5)
-        *   [Parameters](#parameters-57)
+        *   [Parameters](#parameters-58)
     *   [ref](#ref-1)
     *   [refId](#refid)
-        *   [Parameters](#parameters-58)
-    *   [entries](#entries)
         *   [Parameters](#parameters-59)
+    *   [entries](#entries)
+        *   [Parameters](#parameters-60)
     *   [asyncIterator](#asynciterator)
     *   [maybeEntry](#maybeentry)
-        *   [Parameters](#parameters-60)
-    *   [entry](#entry)
         *   [Parameters](#parameters-61)
+    *   [entry](#entry)
+        *   [Parameters](#parameters-62)
     *   [owner](#owner)
     *   [fullName](#fullname-3)
     *   [fullCondensedName](#fullcondensedname)
@@ -261,30 +263,30 @@ console.log(await readme.getString());
     *   [attributes](#attributes-1)
 *   [isProtected](#isprotected-1)
 *   [RepositoryGroup](#repositorygroup-1)
-    *   [Parameters](#parameters-62)
+    *   [Parameters](#parameters-63)
     *   [Properties](#properties-10)
     *   [attributeMapping](#attributemapping-1)
 *   [type](#type)
 *   [url](#url-3)
 *   [RepositoryOwner](#repositoryowner)
-    *   [Parameters](#parameters-63)
-*   [Repository](#repository-2)
     *   [Parameters](#parameters-64)
+*   [Repository](#repository-2)
+    *   [Parameters](#parameters-65)
     *   [Properties](#properties-11)
     *   [fullName](#fullname-4)
     *   [slug](#slug)
     *   [provider](#provider-3)
     *   [identifier](#identifier-2)
     *   [equals](#equals-6)
-        *   [Parameters](#parameters-65)
-    *   [entry](#entry-1)
         *   [Parameters](#parameters-66)
-    *   [entries](#entries-1)
+    *   [entry](#entry-1)
         *   [Parameters](#parameters-67)
-    *   [maybeEntry](#maybeentry-1)
+    *   [entries](#entries-1)
         *   [Parameters](#parameters-68)
-    *   [commits](#commits)
+    *   [maybeEntry](#maybeentry-1)
         *   [Parameters](#parameters-69)
+    *   [commits](#commits)
+        *   [Parameters](#parameters-70)
     *   [urls](#urls)
     *   [url](#url-4)
     *   [cloneURL](#cloneurl)
@@ -298,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)
@@ -341,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
 
@@ -516,6 +518,14 @@ The provider we live in.
 
 Returns **[BaseProvider](#baseprovider)** 
 
+### trace
+
+Forwarded to the owner.
+
+#### Parameters
+
+*   `args` **...any** 
+
 ### info
 
 Forwarded to the owner.
@@ -870,10 +880,11 @@ 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)** as of from process.env
+*   `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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "repository-provider",
-  "version": "28.1.1",
+  "version": "28.3.0",
   "publishConfig": {
     "access": "public"
   },
@@ -36,7 +36,7 @@
     "ava": "^4.2.0",
     "c8": "^7.11.2",
     "documentation": "^13.2.5",
-    "repository-provider-test-support": "^2.1.1",
+    "repository-provider-test-support": "^2.1.2",
     "semantic-release": "^19.0.2",
     "typescript": "^4.6.3"
   },

package/src/application.mjs

@@ -1,15 +1,7 @@
-import { NamedObject } from "./named-object.mjs";
+import { OwnedObject } from "./owned-object.mjs";
 
 /**
  * 
  */
-export class Application extends NamedObject {
-
-  constructor(owner, name, options) {
-    super(name, options, {
-      owner: { value: owner }
-    });
-
-    owner._addApplication(this);
-  }
+export class Application extends OwnedObject {
 }

package/src/base-provider.mjs

@@ -15,6 +15,7 @@ import { BaseObject } from "./base-object.mjs";
  * @property {Function} info
  * @property {Function} warn
  * @property {Function} error
+ * @property {Function} trace
  */
 
 /**

package/src/index.mjs

@@ -1,5 +1,6 @@
 export * from "./base-object.mjs";
 export * from "./named-object.mjs";
+export * from "./owned-object.mjs";
 export * from "./repository-owner.mjs";
 export * from "./base-provider.mjs";
 export * from "./single-group-provider.mjs";

package/src/issue.mjs

@@ -1,18 +1,9 @@
-import { NamedObject } from "./named-object.mjs";
+import { OwnedObject } from "./owned-object.mjs";
 
 /**
  * 
  */
-export class Issue extends NamedObject {
-
-  constructor(owner, name, options) {
-    super(name, options, {
-      owner: { value: owner }
-    });
-
-    owner._addIssue(this);
-  }
-
+export class Issue extends OwnedObject {
   async *labels() {}
   async *assignees() {}
   async assignee() {}

package/src/milestone.mjs

@@ -1,8 +1,8 @@
-import { NamedObject } from "./named-object.mjs";
+import { OwnedObject } from "./owned-object.mjs";
 
 /**
  */
-export class Milestone extends NamedObject {
+export class Milestone extends OwnedObject {
   static get attributes() {
     return {
       ...super.attributes,
@@ -10,13 +10,5 @@ export class Milestone extends NamedObject {
     };
   }
 
-  constructor(owner, name, options) {
-    super(name, options, {
-      owner: { value: owner }
-    });
-
-    owner._addMilestone(this);
-  }
-
   async *issues() {}
 }

package/src/named-object.mjs

@@ -23,7 +23,7 @@ export class NamedObject extends BaseObject {
    * @return {boolean} true if names are equal and have the same owner
    */
   equals(other) {
-    return super.equals(other) && this.name === other.name;
+    return super.equals(other) && this.fullName === other.fullName && this.provider.equals(other.provider);
   }
 
   /**

package/src/owned-object.mjs

@@ -0,0 +1,23 @@
+import { NamedObject } from "./named-object.mjs";
+
+/**
+ * Named Object registering itself in the owner.
+ */
+export class OwnedObject extends NamedObject {
+  /**
+   * Method name to be called to register one instance in the owner. 
+   * sample: Application => _addApplication
+   * @return {string} 
+   */
+  static get registerInstanceMethodName() {
+    return "_add" + this.name;
+  }
+
+  constructor(owner, name, options) {
+    super(name, options, {
+      owner: { value: owner }
+    });
+
+    owner[this.constructor.registerInstanceMethodName](this);
+  }
+}

package/src/project.mjs

@@ -1,13 +1,6 @@
-import { NamedObject } from "./named-object.mjs";
+import { OwnedObject } from "./owned-object.mjs";
 
 /**
- * 
+ *
  */
-export class Project extends NamedObject {
-  constructor(owner, name, options) {
-    super(name, options, {
-      owner: { value: owner }
-    });
-
-    owner._addProject(this);
-  }}
+export class Project extends OwnedObject {}

package/src/ref.mjs

@@ -120,7 +120,7 @@ export class Ref extends NamedObject {
 
   /**
    * Repository fullName and branch name combined.
-   * But skipping the branch name if it is the default branch
+   * But skipping the branch name if it is the default branch.
    * @return {string} 'user/repo#branch'
    */
   get fullCondensedName() {

package/src/repository.mjs

@@ -91,14 +91,6 @@ export class Repository extends NamedObject {
     return `${this.owner.name}/${this.name}`;
   }
 
-  /**
-   * The owners provider.
-   * @return {BaseProvider}
-   */
-  get provider() {
-    return this.owner.provider;
-  }
-
   /**
    * Short human readable identifier with provider and branch.
    * @return {string}
@@ -107,21 +99,6 @@ export class Repository extends NamedObject {
     return `${this.provider.name}:${this.fullName}`;
   }
 
-  /**
-   * Check for equality.
-   * @param {Repository} other
-   * @return {boolean} true if name and provider are equal
-   */
-  equals(other) {
-    if (other === undefined) {
-      return false;
-    }
-
-    return (
-      this.fullName === other.fullName && this.provider.equals(other.provider)
-    );
-  }
-
   /**
    * Lookup entries form the head of the default branch.
    * {@link Branch#entry}
@@ -260,6 +237,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);
   }