repository-provider 26.1.3 → 26.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "repository-provider",
-  "version": "26.1.3",
+  "version": "26.4.0",
   "publishConfig": {
     "access": "public"
   },
@@ -36,9 +36,9 @@
     "ava": "^4.0.1",
     "c8": "^7.11.0",
     "documentation": "^13.2.5",
-    "repository-provider-test-support": "^1.9.6",
-    "semantic-release": "^18.0.1",
-    "typescript": "^4.6.0-dev.20220115"
+    "repository-provider-test-support": "^1.9.8",
+    "semantic-release": "^19.0.2",
+    "typescript": "^4.6.0-dev.20220124"
   },
   "engines": {
     "node": ">=14.18.3"

package/src/base-object.mjs

@@ -71,6 +71,11 @@ export class BaseObject {
     );
   }
 
+  /**
+   * Save object attributes in the backing store.
+   */
+  async update() {}
+
   /**
    * Check for equality
    * @param {BaseObject} other
@@ -79,4 +84,84 @@ export class BaseObject {
   equals(other) {
     return other !== undefined;
   }
+
+  /**
+   * The provider we live in.
+   * @return {BaseProvider}
+   */
+  get provider() {
+    return this.owner.provider;
+  }
+
+  /**
+   * Forwarded to the owner.
+   * @param  {...any} args
+   */
+  info(...args) {
+    return this.owner.info(...args);
+  }
+
+  /**
+   * Forwarded to the owner.
+   * @param  {...any} args
+   */
+  warn(...args) {
+    return this.owner.warn(...args);
+  }
+
+  /**
+   * Forwarded to the owner.
+   * @param  {...any} args
+   */
+  error(...args) {
+    return this.owner.error(...args);
+  }
+
+  /**
+   * By default we use the owners implementation.
+   * @return {Class} as defined in the owner
+   */
+  get repositoryClass() {
+    return this.owner.repositoryClass;
+  }
+
+  /**
+   * By default we use the owners implementation.
+   * @return {Class} as defined in the owner
+   */
+  get pullRequestClass() {
+    return this.owner.pullRequestClass;
+  }
+
+  /**
+   * By default we use the owners implementation.
+   * @return {Class} as defined in the owner
+   */
+  get branchClass() {
+    return this.owner.branchClass;
+  }
+
+  /**
+   * By default we use the owners implementation.
+   * @return {Class} as defined in the owner
+   */
+  get tagClass() {
+    return this.owner.tagClass;
+  }
+
+  /**
+   * By default we use the owners implementation.
+   * @return {Class} as defined in the owner
+   */
+  get entryClass() {
+    return this.owner.entryClass;
+  }
+
+  /**
+   * By default we use the owners implementation.
+   * @return {Class} as defined in the owner
+   */
+  get hookClass() {
+    return this.owner.hookClass;
+  }
 }

package/src/base-provider.mjs

@@ -482,6 +482,13 @@ export class BaseProvider {
     return Branch;
   }
 
+  /**
+   * @return {Class} branch class used by the Provider
+   */
+  get tagClass() {
+    return Tag;
+  }
+
   /**
    * @return {Class} entry class used by the Provider
    */

package/src/branch.mjs

@@ -82,6 +82,7 @@ export class Branch extends Ref {
    * @param {boolean} options.dry do not create a branch and do not commit only create dummy PR
    * @param {boolean} options.skipWithoutCommits do not create a PR if no commits are given
    * @param {boolean} options.bodyFromCommitMessages generate body from commit messages
+   * @param {string} [options.body] body of the PR
    * @return {Promise<PullRequest>}
    */
   async commitIntoPullRequest(commits, options) {
@@ -182,14 +183,6 @@ export class Branch extends Ref {
     return this.repository.deletePullRequest(name);
   }
 
-  /**
-   * By default we use the repository implementation.
-   * @return {Class} as defined in the repository
-   */
-  get pullRequestClass() {
-    return this.repository.pullRequestClass;
-  }
-
   /**
    * Create a new {@link Branch} by cloning a given source branch.
    * Simply calls Repository.createBranch() with the receiver as source branch

package/src/hook.mjs

@@ -36,6 +36,11 @@ export class Hook extends BaseObject {
     repository._addHook(this);
   }
 
+  get owner()
+  {
+    return this.repository;
+  }
+
   get fullName() {
     return `${this.repository.fullName}/${this.id}`;
   }
@@ -59,16 +64,4 @@ export class Hook extends BaseObject {
   toJSON() {
     return optionJSON(this, { id: this.id, events: [...this.events] });
   }
-
-  info(...args) {
-    return this.repository.info(...args);
-  }
-
-  warn(...args) {
-    return this.repository.warn(...args);
-  }
-
-  error(...args) {
-    return this.repository.error(...args);
-  }
 }

package/src/named-object.mjs

@@ -34,13 +34,6 @@ export class NamedObject extends BaseObject {
     return this.name;
   }
 
-  /**
-   * Save object attributes in the backing store.
-   */
-  async update()
-  {
-  }
-
   toString() {
     return this.name;
   }

package/src/ref.mjs

@@ -96,14 +96,6 @@ export class Ref extends NamedObject {
     return e;
   }
 
-  /**
-   * The provider we live in.
-   * @return {BaseProvider}
-   */
-  get provider() {
-    return this.repository.provider;
-  }
-
   /**
    * Branch owner.
    * By default we provide the repository owner
@@ -208,16 +200,4 @@ export class Ref extends NamedObject {
       !this.isProtected
     );
   }
-
-  info(...args) {
-    return this.repository.info(...args);
-  }
-
-  warn(...args) {
-    return this.repository.warn(...args);
-  }
-
-  error(...args) {
-    return this.repository.error(...args);
-  }
 }

package/src/repository-group.mjs

@@ -49,6 +49,11 @@ export class RepositoryGroup extends RepositoryOwner(NamedObject) {
     });
   }
 
+  get owner()
+  {
+    return this.provider;
+  }
+
   get isAdmin() {
     return false;
   }
@@ -60,56 +65,4 @@ export class RepositoryGroup extends RepositoryOwner(NamedObject) {
   get areRepositoryGroupNamesCaseSensitive() {
     return this.provider.areRepositoryGroupNamesCaseSensitive;
   }
-
-  /**
-   * By default we use the providers implementation.
-   * @return {Class} as defined in the provider
-   */
-  get repositoryClass() {
-    return this.provider.repositoryClass;
-  }
-
-  /**
-   * By default we use the providers implementation.
-   * @return {Class} as defined in the provider
-   */
-  get branchClass() {
-    return this.provider.branchClass;
-  }
-
-  /**
-   * By default we use the providers implementation.
-   * @return {Class} as defined in the provider
-   */
-  get contentClass() {
-    return this.provider.contentClass;
-  }
-
-  /**
-   * By default we use the providers implementation.
-   * @return {Class} as defined in the provider
-   */
-  get pullRequestClass() {
-    return this.provider.pullRequestClass;
-  }
-
-  /**
-   * By default we use the providers implementation.
-   * @return {Class} as defined in the provider
-   */
-  get hookClass() {
-    return this.provider.hookClass;
-  }
-
-  info(...args) {
-    return this.provider.info(...args);
-  }
-
-  warn(...args) {
-    return this.provider.warn(...args);
-  }
-
-  error(...args) {
-    return this.provider.error(...args);
-  }
 }

package/src/repository.mjs

@@ -42,7 +42,7 @@ export class Repository extends NamedObject {
        * URLs of the repository
        * @return {string[]}
        */
-      urls: { },
+      urls: {},
 
       cloneURL: { type: "url" },
 
@@ -229,6 +229,14 @@ export class Repository extends NamedObject {
     return false;
   }
 
+  /**
+   * Lookup the default branch.
+   * @return {Promise<Branch>} branch named after defaultBranchName
+   */
+  get defaultBranch() {
+    return this.branch(this.defaultBranchName);
+  }
+
   /**
    * Lookup branch by name.
    * @param {string} name
@@ -239,14 +247,6 @@ export class Repository extends NamedObject {
     return this._branches.get(name);
   }
 
-  /**
-   * Lookup the default branch.
-   * @return {Promise<Branch>} branch named after defaultBranchName
-   */
-  get defaultBranch() {
-    return this.branch(this.defaultBranchName);
-  }
-
   /**
    * @return {AsyncIterator<Branch>} of all branches
    */
@@ -274,7 +274,7 @@ export class Repository extends NamedObject {
    * Internal branch creation does not call repository.initialize()
    * @param {string} name of the new branch
    * @param {Object} options
-   * @return {Promise<Branch>} newly created branch
+   * @return {Branch} newly created branch
    */
   addBranch(name, options) {
     let branch = this._branches.get(name);
@@ -298,8 +298,14 @@ export class Repository extends NamedObject {
     this._branches.delete(name);
   }
 
-  _addTag(tag) {
-    this._tags.set(tag.name, tag);
+  /**
+   * Get a Tag.
+   * @param {string} name
+   * @return {Promise<Tag>}
+   */
+  async tag(name) {
+    await this.initializeTags();
+    return this._tags.get(name);
   }
 
   /**
@@ -315,13 +321,23 @@ export class Repository extends NamedObject {
   }
 
   /**
-   * Get a Tag.
-   * @param {string} name
-   * @return {Promise<Tag>}
+   * Add a new {@link Tag}.
+   * Internal tag creation does not call repository.initialize()
+   * @param {string} name of the new tag
+   * @param {Object} options
+   * @return {Tag} newly created tag
    */
-  async tag(name) {
-    await this.initializeTags();
-    return this._tags.get(name);
+  addTag(name, options) {
+    let tag = this._tags.get(name);
+    if (tag === undefined) {
+      tag = new this.tagClass(this, name, options);
+    }
+
+    return tag;
+  }
+
+  _addTag(tag) {
+    this._tags.set(tag.name, tag);
   }
 
   /**
@@ -474,46 +490,6 @@ export class Repository extends NamedObject {
     return undefined;
   }
 
-  /**
-   * By default we use the owners implementation.
-   * @return {Class} as defined in the owner
-   */
-  get repositoryClass() {
-    return this.owner.repositoryClass;
-  }
-
-  /**
-   * By default we use the owners implementation.
-   * @return {Class} as defined in the owner
-   */
-  get pullRequestClass() {
-    return this.owner.pullRequestClass;
-  }
-
-  /**
-   * By default we use the owners implementation.
-   * @return {Class} as defined in the owner
-   */
-  get branchClass() {
-    return this.owner.branchClass;
-  }
-
-  /**
-   * By default we use the owners implementation.
-   * @return {Class} as defined in the owner
-   */
-  get entryClass() {
-    return this.owner.entryClass;
-  }
-
-  /**
-   * By default we use the owners implementation.
-   * @return {Class} as defined in the owner
-   */
-  get hookClass() {
-    return this.owner.hookClass;
-  }
-
   toString() {
     return this.fullName;
   }
@@ -529,18 +505,6 @@ export class Repository extends NamedObject {
     });
   }
 
-  info(...args) {
-    return this.owner.info(...args);
-  }
-
-  warn(...args) {
-    return this.owner.warn(...args);
-  }
-
-  error(...args) {
-    return this.owner.error(...args);
-  }
-
   initialize() {}
 
   initializeHooks() {