repository-provider 31.2.7 → 32.0.0

package/README.md

@@ -200,7 +200,6 @@ console.log(await readme.getString());
     *   [fullName](#fullname-1)
     *   [toJSON](#tojson-1)
     *   [attributes](#attributes-1)
-*   [avatarURL](#avatarurl)
 *   [homePageURL](#homepageurl)
 *   [OwnedObject](#ownedobject)
     *   [Parameters](#parameters-45)
@@ -241,14 +240,13 @@ console.log(await readme.getString());
 *   [Ref](#ref)
     *   [ref](#ref-1)
     *   [refId](#refid)
-        *   [Parameters](#parameters-52)
     *   [entries](#entries)
-        *   [Parameters](#parameters-53)
+        *   [Parameters](#parameters-52)
     *   [asyncIterator](#asynciterator)
     *   [maybeEntry](#maybeentry)
-        *   [Parameters](#parameters-54)
+        *   [Parameters](#parameters-53)
     *   [entry](#entry)
-        *   [Parameters](#parameters-55)
+        *   [Parameters](#parameters-54)
     *   [repository](#repository-2)
     *   [fullName](#fullname-3)
     *   [fullCondensedName](#fullcondensedname-1)
@@ -262,27 +260,28 @@ console.log(await readme.getString());
     *   [attributes](#attributes-2)
 *   [isProtected](#isprotected-1)
 *   [RepositoryGroup](#repositorygroup-1)
-    *   [Parameters](#parameters-56)
+    *   [Parameters](#parameters-55)
     *   [Properties](#properties-9)
     *   [attributeMapping](#attributemapping-1)
 *   [type](#type-1)
 *   [url](#url-3)
 *   [url](#url-4)
+*   [avatarURL](#avatarurl)
 *   [RepositoryOwner](#repositoryowner)
-    *   [Parameters](#parameters-57)
+    *   [Parameters](#parameters-56)
 *   [Repository](#repository-3)
-    *   [Parameters](#parameters-58)
+    *   [Parameters](#parameters-57)
     *   [Properties](#properties-10)
     *   [fullName](#fullname-4)
     *   [slug](#slug)
     *   [entry](#entry-1)
-        *   [Parameters](#parameters-59)
+        *   [Parameters](#parameters-58)
     *   [entries](#entries-1)
-        *   [Parameters](#parameters-60)
+        *   [Parameters](#parameters-59)
     *   [maybeEntry](#maybeentry-1)
-        *   [Parameters](#parameters-61)
+        *   [Parameters](#parameters-60)
     *   [commits](#commits)
-        *   [Parameters](#parameters-62)
+        *   [Parameters](#parameters-61)
     *   [cloneURL](#cloneurl)
     *   [issuesURL](#issuesurl-1)
     *   [homePageURL](#homepageurl-2)
@@ -293,63 +292,62 @@ console.log(await readme.getString());
     *   [delete](#delete-2)
     *   [defaultBranch](#defaultbranch)
     *   [branch](#branch-2)
-        *   [Parameters](#parameters-63)
+        *   [Parameters](#parameters-62)
     *   [hasBranches](#hasbranches)
     *   [branches](#branches-1)
-        *   [Parameters](#parameters-64)
+        *   [Parameters](#parameters-63)
     *   [createBranch](#createbranch-1)
-        *   [Parameters](#parameters-65)
+        *   [Parameters](#parameters-64)
     *   [addBranch](#addbranch)
-        *   [Parameters](#parameters-66)
+        *   [Parameters](#parameters-65)
     *   [deleteBranch](#deletebranch)
-        *   [Parameters](#parameters-67)
+        *   [Parameters](#parameters-66)
     *   [tag](#tag)
-        *   [Parameters](#parameters-68)
+        *   [Parameters](#parameters-67)
     *   [tags](#tags-1)
-        *   [Parameters](#parameters-69)
+        *   [Parameters](#parameters-68)
     *   [addTag](#addtag)
-        *   [Parameters](#parameters-70)
+        *   [Parameters](#parameters-69)
     *   [createPullRequest](#createpullrequest-1)
-        *   [Parameters](#parameters-71)
+        *   [Parameters](#parameters-70)
     *   [addPullRequest](#addpullrequest)
-        *   [Parameters](#parameters-72)
+        *   [Parameters](#parameters-71)
     *   [pullRequests](#pullrequests-1)
     *   [pullRequest](#pullrequest-1)
-        *   [Parameters](#parameters-73)
+        *   [Parameters](#parameters-72)
     *   [deletePullRequest](#deletepullrequest)
-        *   [Parameters](#parameters-74)
+        *   [Parameters](#parameters-73)
     *   [addHook](#addhook)
-        *   [Parameters](#parameters-75)
+        *   [Parameters](#parameters-74)
     *   [createHook](#createhook)
-        *   [Parameters](#parameters-76)
+        *   [Parameters](#parameters-75)
     *   [hooks](#hooks-1)
     *   [hook](#hook-1)
-        *   [Parameters](#parameters-77)
+        *   [Parameters](#parameters-76)
     *   [type](#type-2)
     *   [refId](#refid-1)
-        *   [Parameters](#parameters-78)
-    *   [toJSON](#tojson-2)
+        *   [Parameters](#parameters-77)
     *   [attributes](#attributes-3)
 *   [defaultBranchName](#defaultbranchname)
 *   [issuesURL](#issuesurl-2)
 *   [Review](#review)
 *   [SingleGroupProvider](#singlegroupprovider)
     *   [repository](#repository-4)
-        *   [Parameters](#parameters-79)
+        *   [Parameters](#parameters-78)
     *   [repositoryGroup](#repositorygroup-2)
-        *   [Parameters](#parameters-80)
+        *   [Parameters](#parameters-79)
     *   [repositoryGroups](#repositorygroups-1)
-        *   [Parameters](#parameters-81)
+        *   [Parameters](#parameters-80)
 *   [Tag](#tag-1)
     *   [refType](#reftype-1)
 *   [asArray](#asarray)
-    *   [Parameters](#parameters-82)
+    *   [Parameters](#parameters-81)
 *   [stripBaseName](#stripbasename)
-    *   [Parameters](#parameters-83)
+    *   [Parameters](#parameters-82)
 *   [stripBaseNames](#stripbasenames)
-    *   [Parameters](#parameters-84)
+    *   [Parameters](#parameters-83)
 *   [generateBranchName](#generatebranchname)
-    *   [Parameters](#parameters-85)
+    *   [Parameters](#parameters-84)
 
 ## Application
 
@@ -1193,12 +1191,6 @@ Provided name and all defined attributes.
 
 options
 
-## avatarURL
-
-Avatar.
-
-Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
-
 ## homePageURL
 
 The url of home page.
@@ -1437,10 +1429,6 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 Get sha of a ref.
 
-#### Parameters
-
-*   `ref` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**  (optional, default `this.ref`)
-
 Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** sha of the ref
 
 ### entries
@@ -1591,6 +1579,12 @@ URL of the repository
 
 Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
 
+## avatarURL
+
+Avatar.
+
+Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+
 ## RepositoryOwner
 
 Mixin to define a class able to handle a collection of repositories.
@@ -1920,10 +1914,6 @@ Get sha of a ref.
 
 Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** sha of the ref
 
-### toJSON
-
-Provide name and all defined attributes
-
 ### attributes
 
 options

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "repository-provider",
-  "version": "31.2.7",
+  "version": "32.0.0",
   "publishConfig": {
     "access": "public"
   },
@@ -36,9 +36,9 @@
     "ava": "^4.3.0",
     "c8": "^7.11.3",
     "documentation": "^13.2.5",
-    "repository-provider-test-support": "^2.2.4",
+    "repository-provider-test-support": "^2.2.6",
     "semantic-release": "^19.0.3",
-    "typescript": "^4.7.3"
+    "typescript": "^4.7.4"
   },
   "engines": {
     "node": ">=16.15.1"

package/src/ref.mjs

@@ -38,12 +38,11 @@ export class Ref extends OwnedObject {
   }
 
   /**
-   * Get sha of a ref.
-   * @param {string} ref
+   * Get sha of our ref.
    * @return {Promise<string>} sha of the ref
    */
-  async refId(ref = this.ref) {
-    return this.owner.refId(ref);
+  get refId() {
+    return this.owner.refId(this.ref);
   }
 
   /**

package/src/repository-owner.mjs

@@ -81,7 +81,15 @@ export function RepositoryOwner(base) {
       );
     }
 
-    async _lookup(type, name, split, defaultItem) {
+    /**
+     * Lookup entity of a given type and name.
+     * @param {string} type 
+     * @param {string} name 
+     * @param {function} split 
+     * @param {Object} defaultItem 
+     * @returns {NamedObject} from a repository
+     */
+    async lookup(type, name, split, defaultItem) {
       if (name !== undefined) {
         await this.initializeRepositories();
 
@@ -100,7 +108,15 @@ export function RepositoryOwner(base) {
       }
     }
 
-    async *_list(type, patterns, split, defaultItem) {
+    /**
+     * List entities for a given type and pattern.
+     * @param {string} type 
+     * @param {string|string[]} patterns 
+     * @param {function} split 
+     * @param {Object} defaultItem
+     * @return {AsyncIterator<NamedObject>} matching type and pattern
+     */
+    async *list(type, patterns, split, defaultItem) {
       await this.initializeRepositories();
 
       patterns = stripBaseNames(patterns, this.provider.repositoryBases);
@@ -175,7 +191,7 @@ export function RepositoryOwner(base) {
      * @return {Promise<Branch|undefined>}
      */
     async branch(name) {
-      return this._lookup(
+      return this.lookup(
         "branch",
         name,
         name => name.split(/#/),
@@ -189,7 +205,7 @@ export function RepositoryOwner(base) {
      * @return {AsyncIterator<Branch>} all matching branches of the owner
      */
     async *branches(patterns) {
-      yield* this._list(
+      yield* this.list(
         "branches",
         patterns,
         pattern => pattern.split(/#/),
@@ -198,51 +214,51 @@ export function RepositoryOwner(base) {
     }
 
     async tag(name) {
-      return this._lookup("tag", name, name => name.split(/#/));
+      return this.lookup("tag", name, name => name.split(/#/));
     }
 
     async *tags(patterns) {
-      yield* this._list("tags", patterns, pattern => pattern.split(/#/));
+      yield* this.list("tags", patterns, pattern => pattern.split(/#/));
     }
 
     async pullRequest(name) {
-      return this._lookup("pullRequest", name);
+      return this.lookup("pullRequest", name);
     }
 
     async *pullRequests(patterns) {
-      yield* this._list("pullRequests", patterns);
+      yield* this.list("pullRequests", patterns);
     }
 
     async project(name) {
-      return this._lookup("project", name);
+      return this.lookup("project", name);
     }
 
     async *projects(patterns) {
-      yield* this._list("projects", patterns);
+      yield* this.list("projects", patterns);
     }
 
     async application(name) {
-      return this._lookup("application", name);
+      return this.lookup("application", name);
     }
 
     async *applications(patterns) {
-      yield* this._list("applications", patterns);
+      yield* this.list("applications", patterns);
     }
 
     async milestone(name) {
-      return this._lookup("milestone", name);
+      return this.lookup("milestone", name);
     }
 
     async *milestones(patterns) {
-      yield* this._list("milestones", patterns);
+      yield* this.list("milestones", patterns);
     }
 
     async hook(name) {
-      return this._lookup("hook", name);
+      return this.lookup("hook", name);
     }
 
     async *hooks(patterns) {
-      yield* this._list("hooks", patterns);
+      yield* this.list("hooks", patterns);
     }
   };
 }

package/src/repository.mjs

@@ -465,16 +465,6 @@ export class Repository extends OwnedObject {
    */
   async refId(ref) {}
 
-  /**
-   * Provide name and all defined attributes
-   */
-  toJSON() {
-    return optionJSON(this, {
-      name: this.name,
-      fullName: this.fullName,
-    });
-  }
-
   initialize() {}
 
   initializeHooks() {