repository-provider 32.7.6 → 32.7.8

package/README.md

@@ -228,6 +228,7 @@ console.log(await readme.getString());
     *   [reviews](#reviews)
     *   [identifier](#identifier-1)
     *   [defaultListStates](#defaultliststates)
+    *   [states](#states)
     *   [validMergeMethods](#validmergemethods)
     *   [list](#list-1)
         *   [Parameters](#parameters-52)
@@ -1352,11 +1353,15 @@ States to list pull request by default
 
 Returns **[Set](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** states to list by default
 
+### states
+
+possible states
+
 ### validMergeMethods
 
 All valid merge methods
 
-Returns **[Set](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** valid merge methods
+Returns **[Set](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** valid merge methods.
 
 ### list
 
@@ -1931,7 +1936,7 @@ Lookup a repository in the provider and all of its repository groups.
 
 *   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the repository
 
-Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Repository](#repository)>**&#x20;
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<([Repository](#repository) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))>**&#x20;
 
 ### repositoryGroup
 
@@ -1941,7 +1946,7 @@ Get a single group.
 
 *   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
 
-Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[RepositoryGroup](#repositorygroup)>** deliver the one and only present group
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<([RepositoryGroup](#repositorygroup) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))>** deliver the one and only present group
 
 ### repositoryGroups
 
@@ -1997,7 +2002,7 @@ Loops over names and executes stripBaseName.
 *   `repositoryBases` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** all possible bases
 *   `whenFound` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** to be called with the found base name
 
-Returns **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** names without base
+Returns **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** names without base
 
 ## generateBranchName
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "repository-provider",
-  "version": "32.7.6",
+  "version": "32.7.8",
   "publishConfig": {
     "access": "public"
   },
@@ -38,7 +38,7 @@
     "c8": "^7.13.0",
     "documentation": "^14.0.1",
     "repository-provider-test-support": "^2.3.2",
-    "semantic-release": "^21.0.1",
+    "semantic-release": "^21.0.2",
     "typescript": "^5.0.4"
   },
   "engines": {

package/src/attributes.mjs

@@ -7,7 +7,8 @@ export const default_attribute = {
   mandatory: false,
   private: false,
   isKey: false,
-  additionalAttributes: []
+  additionalAttributes: [],
+  env: []
 };
 
 export const boolean_attribute = {

package/src/base-provider.mjs

@@ -46,7 +46,7 @@ export class BaseProvider extends BaseObject {
    * Object with the detected key value pairs is delivered.
    * @param {Object} env as from process.env
    * @param {string} instanceIdentifier part of variable name.
-   * @return {Object} undefined if no suitable environment variables have been found
+   * @return {Object|undefined} undefined if no suitable environment variables have been found
    */
   static optionsFromEnvironment(
     env,
@@ -137,7 +137,7 @@ export class BaseProvider extends BaseObject {
    * @param {Object} options additional options
    * @param {string} [options.instanceIdentifier] name of the provider instance
    * @param {Object} env taken from process.env
-   * @return {BaseProvider} newly created provider or undefined if options are not sufficient to construct a provider
+   * @return {BaseProvider|undefined} newly created provider or undefined if options are not sufficient to construct a provider
    */
   static initialize(options = {}, env) {
     options = {

package/src/branch.mjs

@@ -201,7 +201,7 @@ export class Branch extends Ref {
    * Create a new {@link Branch} by cloning a given source branch.
    * Simply calls Repository.createBranch() with the receiver as source branch
    * @param {string} name the new branch
-   * @param {Object} options
+   * @param {Object|undefined} options
    * @return {Promise<Branch>} newly created branch (or already present old one with the same name)
    */
   async createBranch(name, options) {

package/src/multi-group-provider.mjs

@@ -16,7 +16,7 @@ export class MultiGroupProvider extends BaseProvider {
   /**
    * Lookup a repository in the provider and all of its repository groups.
    * @param {string} name of the repository
-   * @return {Promise<Repository>}
+   * @return {Promise<Repository|undefined>}
    */
   async repository(name) {
     const { base, group, repository } = this.parseName(name);
@@ -35,7 +35,7 @@ export class MultiGroupProvider extends BaseProvider {
   /**
    * Lookup a branch.
    * @param {string} name of the branch
-   * @return {Promise<Branch>}
+   * @return {Promise<Branch|undefined>}
    */
   async branch(name) {
     const { base, group, repository, branch } = this.parseName(name);
@@ -57,7 +57,7 @@ export class MultiGroupProvider extends BaseProvider {
   /**
    * Lookup a repository group.
    * @param {string} name of the group
-   * @return {Promise<RepositoryGroup>}
+   * @return {Promise<RepositoryGroup|undefined>}
    */
   async repositoryGroup(name) {
     const { base } = this.parseName(name);

package/src/pull-request.mjs

@@ -60,12 +60,12 @@ export class PullRequest extends OwnedObject {
    * possible states
    */
   static states = new Set(["OPEN", "MERGED", "CLOSED"]);
-  
+
   /**
    * All valid merge methods
    * @return {Set<string>} valid merge methods.
    */
-  static validMergeMethods =new Set(/*["MERGE", "SQUASH", "REBASE"]*/);
+  static validMergeMethods = new Set(/*["MERGE", "SQUASH", "REBASE"]*/);
 
   /**
    * List all pull request for a given repo.

package/src/repository.mjs

@@ -251,7 +251,7 @@ export class Repository extends OwnedObject {
    * Add a new {@link Branch}.
    * Internal branch creation does not call repository.initialize()
    * @param {string} name of the new branch
-   * @param {Object} options to be passed to the branch
+   * @param {Object|undefined} options to be passed to the branch
    * @return {Branch} newly created branch
    */
   addBranch(name, options) {
@@ -306,7 +306,7 @@ export class Repository extends OwnedObject {
    * Add a new {@link Tag}.
    * Internal tag creation does not call repository.initialize()
    * @param {string} name of the new tag
-   * @param {Object} options
+   * @param {Object|undefined} options
    * @return {Tag} newly created tag
    */
   addTag(name, options) {
@@ -321,7 +321,7 @@ export class Repository extends OwnedObject {
    * Create a pull request (or deliver an already present for the given name).
    * @param {string} name of the pr
    * @param {Branch} source branch
-   * @param {Object} options
+   * @param {Object|undefined} options
    * @return {Promise<PullRequest>}
    */
   async createPullRequest(name, source, options) {
@@ -419,7 +419,7 @@ export class Repository extends OwnedObject {
   /**
    * Get a Hook.
    * @param {string|number} id
-   * @return {Promise<Hook>} for the given id
+   * @return {Promise<Hook|undefined>} for the given id
    */
   async hook(id) {
     for await (const hook of this.hooks()) {

package/src/single-group-provider.mjs

@@ -11,7 +11,7 @@ export class SingleGroupProvider extends RepositoryOwner(BaseProvider) {
   /**
    * Lookup a repository in the provider and all of its repository groups.
    * @param {string} name of the repository
-   * @return {Promise<Repository>}
+   * @return {Promise<Repository|undefined>}
    */
   async repository(name) {
     const { base, repository } = this.parseName(name);
@@ -23,7 +23,7 @@ export class SingleGroupProvider extends RepositoryOwner(BaseProvider) {
   /**
    * Get a single group.
    * @param {string} name
-   * @return {Promise<RepositoryGroup>} deliver the one and only present group
+   * @return {Promise<RepositoryGroup|undefined>} deliver the one and only present group
    */
   async repositoryGroup(name) {
     const { base } = this.parseName(name);

package/src/util.mjs

@@ -38,7 +38,7 @@ export function stripBaseName(name, repositoryBases, whenFound) {
  * @param {string|string[]} names
  * @param {string[]} repositoryBases all possible bases
  * @param {Function} [whenFound] to be called with the found base name
- * @return {string[]|undefined} names without base
+ * @return {string[]|string|undefined} names without base
  */
 export function stripBaseNames(names, repositoryBases, whenFound) {
   return Array.isArray(names)
@@ -61,5 +61,5 @@ export async function generateBranchName(repository, pattern) {
     n++;
   }
 
-  return pattern.replace(/\*/, n);
+  return pattern.replace(/\*/, n.toString());
 }