repository-provider 27.0.3 → 27.0.6

package/README.md

@@ -250,6 +250,7 @@ console.log(await readme.getString());
     *   [fullName](#fullname-3)
     *   [fullCondensedName](#fullcondensedname)
     *   [identifier](#identifier-1)
+    *   [toString](#tostring)
     *   [issuesURL](#issuesurl)
     *   [homePageURL](#homepageurl-1)
     *   [isLocked](#islocked)
@@ -292,6 +293,7 @@ console.log(await readme.getString());
     *   [isLocked](#islocked-1)
     *   [isDisabled](#isdisabled-1)
     *   [isTemplate](#istemplate)
+    *   [delete](#delete-2)
     *   [defaultBranch](#defaultbranch)
     *   [branch](#branch-2)
         *   [Parameters](#parameters-70)
@@ -309,7 +311,6 @@ console.log(await readme.getString());
         *   [Parameters](#parameters-76)
     *   [addTag](#addtag)
         *   [Parameters](#parameters-77)
-    *   [delete](#delete-2)
     *   [createPullRequest](#createpullrequest-1)
         *   [Parameters](#parameters-78)
     *   [addPullRequest](#addpullrequest)
@@ -329,6 +330,7 @@ console.log(await readme.getString());
     *   [type](#type-1)
     *   [refId](#refid-1)
         *   [Parameters](#parameters-85)
+    *   [toString](#tostring-1)
     *   [toJSON](#tojson-3)
     *   [attributes](#attributes-2)
 *   [defaultBranchName](#defaultbranchname)
@@ -540,37 +542,37 @@ Forwarded to the owner.
 
 By default we use the owners implementation.
 
-Returns **Class** as defined in the owner
+Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** as defined in the owner
 
 ### pullRequestClass
 
 By default we use the owners implementation.
 
-Returns **Class** as defined in the owner
+Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** as defined in the owner
 
 ### branchClass
 
 By default we use the owners implementation.
 
-Returns **Class** as defined in the owner
+Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** as defined in the owner
 
 ### tagClass
 
 By default we use the owners implementation.
 
-Returns **Class** as defined in the owner
+Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** as defined in the owner
 
 ### entryClass
 
 By default we use the owners implementation.
 
-Returns **Class** as defined in the owner
+Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** as defined in the owner
 
 ### hookClass
 
 By default we use the owners implementation.
 
-Returns **Class** as defined in the owner
+Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** as defined in the owner
 
 ### attributes
 
@@ -832,31 +834,31 @@ return {object}
 
 ### repositoryGroupClass
 
-Returns **Class** repository group class used by the Provider
+Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** repository group class used by the Provider
 
 ### hookClass
 
-Returns **Class** hook class used by the Provider
+Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** hook class used by the Provider
 
 ### repositoryClass
 
-Returns **Class** repository class used by the Provider
+Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** repository class used by the Provider
 
 ### branchClass
 
-Returns **Class** branch class used by the Provider
+Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** branch class used by the Provider
 
 ### tagClass
 
-Returns **Class** branch class used by the Provider
+Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** branch class used by the Provider
 
 ### entryClass
 
-Returns **Class** entry class used by the Provider
+Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** entry class used by the Provider
 
 ### pullRequestClass
 
-Returns **Class** pull request class used by the Provider
+Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** pull request class used by the Provider
 
 ### instanceIdentifier
 
@@ -1416,7 +1418,7 @@ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
 
 ### ref
 
-ref name.
+Full ref path.
 
 Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** git ref of the Ref
 
@@ -1470,7 +1472,7 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
 
 *   **See**: [Repository#owner](Repository#owner)
 
-Branch owner.
+Ref owner.
 By default we provide the repository owner
 
 Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
@@ -1494,6 +1496,12 @@ Short human readable identifier with provider and branch.
 
 Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
 
+### toString
+
+Same as identifier.
+
+Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+
 ### issuesURL
 
 *   **See**: [Repository#issuesURL](#repositoryissuesurl)
@@ -1618,7 +1626,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 ### slug
 
-URL name of the repo.
+Name of the repo as used in the URL.
 
 Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
 
@@ -1689,7 +1697,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 ### cloneURL
 
-The url used fro cloning the repo.
+The url used for cloning the repo.
 
 Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
 
@@ -1735,6 +1743,13 @@ By default we are not a template.
 
 Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** false
 
+### delete
+
+Delete the repository from the [Provider](Provider).
+[Provider#deleteRepository](Provider#deleteRepository)
+
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<any>** 
+
 ### defaultBranch
 
 Lookup the default branch.
@@ -1823,13 +1838,6 @@ Internal tag creation does not call repository.initialize()
 
 Returns **[Tag](#tag)** newly created tag
 
-### delete
-
-Delete the repository from the [Provider](Provider).
-[Provider#deleteRepository](Provider#deleteRepository)
-
-Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<any>** 
-
 ### createPullRequest
 
 Create a pull request (or deliver an already present for thefiven name).
@@ -1928,6 +1936,12 @@ 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
 
+### toString
+
+full name.
+
+Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+
 ### toJSON
 
 Provide name and all defined attributes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "repository-provider",
-  "version": "27.0.3",
+  "version": "27.0.6",
   "publishConfig": {
     "access": "public"
   },
@@ -27,18 +27,18 @@
     "docs": "documentation readme --section=API ./src/**/*.mjs",
     "lint": "npm run lint:docs && npm run lint:tsc",
     "lint:docs": "documentation lint ./src/**/*.mjs",
-    "lint:tsc": "tsc --allowJs --checkJs --noEmit -module nodenext -t es2022 ./src/*.mjs"
+    "lint:tsc": "tsc --allowJs --checkJs --noEmit -t es2022 ./src/*.mjs"
   },
   "dependencies": {
-    "matching-iterator": "^2.0.3"
+    "matching-iterator": "^2.0.4"
   },
   "devDependencies": {
-    "ava": "^4.0.1",
+    "ava": "^4.1.0",
     "c8": "^7.11.0",
     "documentation": "^13.2.5",
-    "repository-provider-test-support": "^1.12.8",
+    "repository-provider-test-support": "^1.12.11",
     "semantic-release": "^19.0.2",
-    "typescript": "^4.7.0-dev.20220225"
+    "typescript": "^4.6.3"
   },
   "engines": {
     "node": ">=14.18.3"

package/src/base-object.mjs

@@ -124,7 +124,7 @@ export class BaseObject {
 
   /**
    * By default we use the owners implementation.
-   * @return {Class} as defined in the owner
+   * @return {Function} as defined in the owner
    */
   get repositoryClass() {
     return this.owner.repositoryClass;
@@ -132,7 +132,7 @@ export class BaseObject {
 
   /**
    * By default we use the owners implementation.
-   * @return {Class} as defined in the owner
+   * @return {Function} as defined in the owner
    */
   get pullRequestClass() {
     return this.owner.pullRequestClass;
@@ -140,7 +140,7 @@ export class BaseObject {
 
   /**
    * By default we use the owners implementation.
-   * @return {Class} as defined in the owner
+   * @return {Function} as defined in the owner
    */
   get branchClass() {
     return this.owner.branchClass;
@@ -148,7 +148,7 @@ export class BaseObject {
 
   /**
    * By default we use the owners implementation.
-   * @return {Class} as defined in the owner
+   * @return {Function} as defined in the owner
    */
   get tagClass() {
     return this.owner.tagClass;
@@ -156,7 +156,7 @@ export class BaseObject {
 
   /**
    * By default we use the owners implementation.
-   * @return {Class} as defined in the owner
+   * @return {Function} as defined in the owner
    */
   get entryClass() {
     return this.owner.entryClass;
@@ -164,7 +164,7 @@ export class BaseObject {
 
   /**
    * By default we use the owners implementation.
-   * @return {Class} as defined in the owner
+   * @return {Function} as defined in the owner
    */
    get hookClass() {
     return this.owner.hookClass;

package/src/base-provider.mjs

@@ -462,49 +462,49 @@ export class BaseProvider extends BaseObject {
   }
 
   /**
-   * @return {Class} repository group class used by the Provider
+   * @return {Function} repository group class used by the Provider
    */
   get repositoryGroupClass() {
     return RepositoryGroup;
   }
 
   /**
-   * @return {Class} hook class used by the Provider
+   * @return {Function} hook class used by the Provider
    */
   get hookClass() {
     return Hook;
   }
 
   /**
-   * @return {Class} repository class used by the Provider
+   * @return {Function} repository class used by the Provider
    */
   get repositoryClass() {
     return Repository;
   }
 
   /**
-   * @return {Class} branch class used by the Provider
+   * @return {Function} branch class used by the Provider
    */
   get branchClass() {
     return Branch;
   }
 
   /**
-   * @return {Class} branch class used by the Provider
+   * @return {Function} branch class used by the Provider
    */
   get tagClass() {
     return Tag;
   }
 
   /**
-   * @return {Class} entry class used by the Provider
+   * @return {Function} entry class used by the Provider
    */
   get entryClass() {
     return undefined;
   }
 
   /**
-   * @return {Class} pull request class used by the Provider
+   * @return {Function} pull request class used by the Provider
    */
   get pullRequestClass() {
     return PullRequest;

package/src/ref.mjs

@@ -43,7 +43,7 @@ export class Ref extends NamedObject {
   }
 
   /**
-   * ref name.
+   * Full ref path.
    * @return {string} git ref of the Ref
    */
   get ref() {
@@ -97,7 +97,7 @@ export class Ref extends NamedObject {
   }
 
   /**
-   * Branch owner.
+   * Ref owner.
    * By default we provide the repository owner
    * @see {@link Repository#owner}
    * @return {string}
@@ -137,6 +137,10 @@ export class Ref extends NamedObject {
     return `${this.provider.name}:${this.fullCondensedName}`;
   }
 
+  /**
+   * Same as identifier.
+   * @return {string}
+   */
   toString() {
     return this.identifier;
   }

package/src/repository.mjs

@@ -84,7 +84,7 @@ export class Repository extends NamedObject {
   }
 
   /**
-   * URL name of the repo.
+   * Name of the repo as used in the URL.
    * @return {string}
    */
   get slug() {
@@ -166,7 +166,7 @@ export class Repository extends NamedObject {
   }
 
   /**
-   * The url used fro cloning the repo.
+   * The url used for cloning the repo.
    * @return {string}
    */
   get cloneURL() {
@@ -229,6 +229,15 @@ export class Repository extends NamedObject {
     return false;
   }
 
+  /**
+   * Delete the repository from the {@link Provider}.
+   * {@link Provider#deleteRepository}
+   * @return {Promise<any>}
+   */
+  async delete() {
+    return this.owner.deleteRepository(this.name);
+  }
+
   /**
    * Lookup the default branch.
    * @return {Promise<Branch>} branch named after defaultBranchName
@@ -340,15 +349,6 @@ export class Repository extends NamedObject {
     this._tags.set(tag.name, tag);
   }
 
-  /**
-   * Delete the repository from the {@link Provider}.
-   * {@link Provider#deleteRepository}
-   * @return {Promise<any>}
-   */
-  async delete() {
-    return this.owner.deleteRepository(this.name);
-  }
-
   /**
    * Create a pull request (or deliver an already present for thefiven name).
    * @param {string} name of the pr
@@ -487,9 +487,12 @@ export class Repository extends NamedObject {
    * @return {Promise<string>} sha of the ref
    */
   async refId(ref) {
-    return undefined;
   }
 
+  /**
+   * full name.
+   * @returns {string}
+   */
   toString() {
     return this.fullName;
   }