repository-provider 27.0.4 → 28.0.0

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)
@@ -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.4",
+  "version": "28.0.0",
   "publishConfig": {
     "access": "public"
   },
@@ -30,18 +30,18 @@
     "lint:tsc": "tsc --allowJs --checkJs --noEmit -t es2022 ./src/*.mjs"
   },
   "dependencies": {
-    "matching-iterator": "^2.0.3"
+    "matching-iterator": "^2.0.4"
   },
   "devDependencies": {
     "ava": "^4.1.0",
     "c8": "^7.11.0",
     "documentation": "^13.2.5",
-    "repository-provider-test-support": "^1.12.9",
+    "repository-provider-test-support": "^1.12.11",
     "semantic-release": "^19.0.2",
-    "typescript": "^4.6.2"
+    "typescript": "^4.6.3"
   },
   "engines": {
-    "node": ">=14.18.3"
+    "node": ">=16.14.2"
   },
   "repository": {
     "type": "git",

package/src/base-provider.mjs

@@ -12,9 +12,9 @@ import { BaseObject } from "./base-object.mjs";
 /**
  * @typedef {Object} MessageDestination
  * Endpoint to deliver log messages to.
- * @param {Function} info
- * @param {Function} warn
- * @param {Function} error
+ * @property {Function} info
+ * @property {Function} warn
+ * @property {Function} error
  */
 
 /**
@@ -31,8 +31,8 @@ export class BaseProvider extends BaseObject {
   /**
    * Extract options suitable for the constructor
    * form the given set of environment variables.
-   * @param {Object} env taken from process.env
-   * @param {string} instanceIdentifier
+   * @param {Object} env as of from process.env
+   * @param {string} instanceIdentifier part of variable name.
    * @return {Object} undefined if no suitable environment variables have been found
    */
   static optionsFromEnvironment(
@@ -89,7 +89,7 @@ export class BaseProvider extends BaseObject {
     return {
       ...super.attributes,
       /**
-       * 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
        */
       priority: {
@@ -98,7 +98,7 @@ export class BaseProvider extends BaseObject {
       },
 
       /**
-       * Name of the provider
+       * Name of the provider.
        */
       name: {
         type: "string",
@@ -111,7 +111,7 @@ export class BaseProvider extends BaseObject {
       },
 
       /**
-       * to forward info/warn and error messages to
+       * To forward info/warn and error messages to
        */
       messageDestination: {
         type: "object",

package/src/branch.mjs

@@ -32,7 +32,7 @@ export class Branch extends Ref {
   }
 
   /**
-   * @return {string} tags
+   * @return {string} heades
    */
   get refType() {
     return "heads";

package/src/commit.mjs

@@ -5,10 +5,17 @@
  * @property {string} ref
  */
 
+export class User
+{
+
+}
+
 /**
  * @property {Repository} repository
  * @property {string} message
  * @property {string} sha
+ * @property {User} author
+ * @property {User} committer
  */
 export class Commit {
   constructor(repository) {

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() {
@@ -149,6 +149,14 @@ export class Repository extends NamedObject {
     return (await this.defaultBranch).maybeEntry(name);
   }
 
+  /**
+   * List commits of the default branch.
+   * @param {Object} options
+   * @return {AsyncIterator<Commit>} all matching commits in the repository
+   */
+  async *commits(options) {
+  }
+
   /**
    * Urls to access the repo.
    * @return {string[]}
@@ -166,7 +174,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 +237,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 +357,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 +495,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;
   }

package/src/tag.mjs

@@ -17,7 +17,7 @@ export class Tag extends Ref {
   }
 
   /**
-   * 
+   * Tags cannot be written to.
    * @return {boolean} false
    */
   get isWritable()