repository-provider 32.7.9 → 32.7.11

package/README.md

@@ -1,6 +1,6 @@
 [![npm](https://img.shields.io/npm/v/repository-provider.svg)](https://www.npmjs.com/package/repository-provider)
 [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
-[![Open Bundle](https://bundlejs.com/badge-light.svg)](https://bundlejs.com/?q=repository-provider)
+[![bundlejs](https://deno.bundlejs.com/?q=repository-provider\&badge=detailed)](https://bundlejs.com/?q=repository-provider)
 [![downloads](http://img.shields.io/npm/dm/repository-provider.svg?style=flat-square)](https://npmjs.org/package/repository-provider)
 [![GitHub Issues](https://img.shields.io/github/issues/arlac77/repository-provider.svg?style=flat-square)](https://github.com/arlac77/repository-provider/issues)
 [![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Farlac77%2Frepository-provider%2Fbadge\&style=flat)](https://actions-badge.atrox.dev/arlac77/repository-provider/goto)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "repository-provider",
-  "version": "32.7.9",
+  "version": "32.7.11",
   "publishConfig": {
     "access": "public"
   },
@@ -37,7 +37,7 @@
     "browser-ava": "^1.3.38",
     "c8": "^7.13.0",
     "documentation": "^14.0.1",
-    "repository-provider-test-support": "^2.3.2",
+    "repository-provider-test-support": "^2.3.3",
     "semantic-release": "^21.0.2",
     "typescript": "^5.0.4"
   },

package/src/attribute-extras.mjs

@@ -32,10 +32,6 @@ export function definePropertiesFromOptions(
   const applyLater = {};
 
   Object.entries(attributes).forEach(([name, attribute]) => {
-    const path = name.split(/\./);
-    const first = path.shift();
-    const property = properties[first];
-
     let value = getAttribute(options, name);
 
     if (value === undefined) {
@@ -67,8 +63,13 @@ export function definePropertiesFromOptions(
       }
     }
 
+    const path = name.split(/\./);
+    const first = path.shift();
+    const property = properties[first];  
+
     if (path.length) {
       const remaining = path.join(".");
+
       if (property) {
         setAttribute(property.value, remaining, value);
       } else {

package/src/base-object.mjs

@@ -4,11 +4,12 @@ import {
 } from "./attribute-extras.mjs";
 import { description_attribute, id_attribute } from "./attributes.mjs";
 
-/**
- * @param {Object} options
- * @param {Object} additionalProperties
- */
-export class BaseObject {
+  /**
+   * Creates an instance of BaseObject.
+   * @param {Object|undefined} options
+   * @param {Object|undefined} additionalProperties
+   */
+  export class BaseObject {
   /**
    * @return {string} type we represent
    */
@@ -56,18 +57,13 @@ export class BaseObject {
     return {};
   }
 
-  /**
-   * Creates an instance of BaseObject.
-   * @param {Object} options
-   * @param {Object} additionalProperties
-   */
   constructor(options, additionalProperties) {
     this.updateAttributes(options, additionalProperties);
   }
 
   /**
    * Takes values from options.
-   * @param {Object} options
+   * @param {Object|undefined} options
    */
   updateAttributes(options, additionalProperties) {
     definePropertiesFromOptions(

package/src/base-provider.mjs

@@ -12,7 +12,8 @@ import {
   url_attribute,
   name_attribute,
   description_attribute,
-  priority_attribute
+  priority_attribute,
+  default_attribute
 } from "./attributes.mjs";
 
 /**
@@ -119,9 +120,9 @@ export class BaseProvider extends BaseObject {
        * To forward info/warn and error messages to
        */
       messageDestination: {
+        ...default_attribute,
         type: "object",
         default: console,
-        mandatory: false,
         writable: true,
         private: true
       }
@@ -300,7 +301,7 @@ export class BaseProvider extends BaseObject {
    * List provider objects of a given type.
    *
    * @param {string} type name of the method to deliver typed iterator projects,milestones,hooks,repositories,branches,tags
-   * @param {string|string[]} patterns group / repository filter
+   * @param {string[]|string} patterns group / repository filter
    */
   async *list(type, patterns) {
     if (patterns === undefined) {

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|undefined} options
+   * @param {Object|undefined} options passed through
    * @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

@@ -90,7 +90,7 @@ export class MultiGroupProvider extends BaseProvider {
    * Create a new repository group.
    * If there is already a group for the given name it will be returend instead
    * @param {string} name of the group
-   * @param {Object} options
+   * @param {Object|undefined} options
    * @return {Promise<RepositoryGroup>}
    */
   async createRepositoryGroup(name, options) {
@@ -100,7 +100,7 @@ export class MultiGroupProvider extends BaseProvider {
   /**
    * Add a new repository group (not provider specific actions are executed).
    * @param {string} name of the group
-   * @param {Object} options
+   * @param {Object|undefined} options
    * @return {RepositoryGroup}
    */
   addRepositoryGroup(name, options) {

package/src/named-object.mjs

@@ -9,8 +9,8 @@ import {
 /**
  * Object with a name.
  * @param {string} name
- * @param {Object} options
- * @param {Object} additionalProperties
+ * @param {Object|undefined} options
+ * @param {Object|undefined} additionalProperties
  *
  * @property {string} name
  */

package/src/ref.mjs

@@ -70,7 +70,7 @@ export class Ref extends OwnedObject {
   /**
    * Get exactly one matching entry by name or undefine if no such entry is found.
    * @param {string} name
-   * @return {Promise<ContentEntry>}
+   * @return {Promise<ContentEntry|undefined>}
    */
   async maybeEntry(name) {
     return (await this.entries(name).next()).value;

package/src/repository-group.mjs

@@ -11,7 +11,7 @@ import {
  * Abstract repository collection.
  * @param {BaseProvider} provider
  * @param {string} name of the group
- * @param {Object} options
+ * @param {Object|undefined} options
  * @param {string} [options.description] human readable description
  * @param {string} [options.id] internal id
  * @param {string} [options.uuid] internal id

package/src/repository-owner.mjs

@@ -1,11 +1,12 @@
 import { matcher } from "matching-iterator";
 import { Branch } from "./branch.mjs";
 import { Repository } from "./repository.mjs";
+import { NamedObject } from "./named-object.mjs";
 import { asArray, stripBaseName, stripBaseNames } from "./util.mjs";
 
 /**
  * Mixin to define a class able to handle a collection of repositories.
- * @param {Class} base to be extendet
+ * @param {Object} base to be extendet
  */
 export function RepositoryOwner(base) {
   return class RepositoryOwner extends base {
@@ -108,7 +109,7 @@ export function RepositoryOwner(base) {
     /**
      * List entities for a given type and pattern.
      * @param {string} type
-     * @param {string|string[]} patterns
+     * @param {string[]|string} patterns
      * @param {function} [split]
      * @param {Object} [defaultItem]
      * @return {AsyncIterator<NamedObject>} matching type and pattern

package/src/repository.mjs

@@ -23,7 +23,7 @@ import {
  * @class Repository
  * @param {RepositoryOwner} owner
  * @param {string} name (#branch) will be removed
- * @param {Object} options
+ * @param {Object|undefined} options
  * @param {string} [options.description] human readable description
  * @param {string} [options.id] internal id
  *
@@ -108,7 +108,7 @@ export class Repository extends OwnedObject {
 
   /**
    * List entries of the default branch.
-   * @param {string[]} matchingPatterns
+   * @param {string[]|string} matchingPatterns
    * @return {AsyncIterator<ContentEntry>} all matching entries in the branch
    */
   async *entries(matchingPatterns) {
@@ -126,7 +126,7 @@ export class Repository extends OwnedObject {
 
   /**
    * List commits of the default branch.
-   * @param {Object} options
+   * @param {Object|undefined} options
    * @return {AsyncIterator<Commit>} all matching commits in the repository
    */
   async *commits(options) {}
@@ -207,7 +207,7 @@ export class Repository extends OwnedObject {
   /**
    * Lookup branch by name.
    * @param {string} name
-   * @return {Promise<Branch>}
+   * @return {Promise<Branch|undefined>}
    */
   async branch(name) {
     if (name === this.defaultBranchName) {
@@ -226,6 +226,7 @@ export class Repository extends OwnedObject {
   }
 
   /**
+   * @param {string[]|string} patterns
    * @return {AsyncIterator<Branch>} of all branches
    */
   async *branches(patterns) {
@@ -239,7 +240,7 @@ export class Repository extends OwnedObject {
    * Create a new {@link Branch} by cloning a given source branch.
    * @param {string} name of the new branch
    * @param {Branch} source branch defaults to the defaultBranch
-   * @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, source, options) {
@@ -291,7 +292,7 @@ export class Repository extends OwnedObject {
   }
 
   /**
-   * @param {string|string[]} patterns
+   * @param {string[]|string} patterns
    * @return {AsyncIterator<Tag>} of all tags
    */
   async *tags(patterns) {
@@ -333,7 +334,7 @@ export class Repository extends OwnedObject {
    * Add a pull request.
    * @param {string} name
    * @param {Branch} source
-   * @param {Object} options
+   * @param {Object|undefined} options
    * @return {PullRequest}
    */
   addPullRequest(name, source, options) {
@@ -362,9 +363,9 @@ export class Repository extends OwnedObject {
   }
 
   /**
-   * The @{link PullRequest} for a given name.
+   * The @see {@link PullRequest} for a given name.
    * @param {string} name
-   * @return {Promise<PullRequest>}
+   * @return {Promise<PullRequest|undefined>}
    */
   async pullRequest(name) {
     await this.initializePullRequests();
@@ -383,7 +384,7 @@ export class Repository extends OwnedObject {
   /**
    * Add a new {@link Hook}.
    * @param {string} name of the new hoook name
-   * @param {Object} options
+   * @param {Object|undefined} options
    * @return {Hook} newly created hook
    */
   addHook(name, options) {
@@ -434,6 +435,11 @@ export class Repository extends OwnedObject {
     this.#milestones.set(milestone.name, milestone);
   }
 
+  /**
+   * Get a Milestone.
+   * @param {string} name
+   * @return {Promise<Milestone|undefined>} for the given name
+   */
   async milestone(name) {
     return this.#milestones.get(name);
   }
@@ -442,6 +448,11 @@ export class Repository extends OwnedObject {
     this.#projects.set(project.name, project);
   }
 
+  /**
+   * Get a Project.
+   * @param {string} name
+   * @return {Promise<Project|undefined>} for the given name
+   */
   async project(name) {
     return this.#projects.get(name);
   }
@@ -450,6 +461,11 @@ export class Repository extends OwnedObject {
     this.#applications.set(application.name, application);
   }
 
+  /**
+   * Get an Application.
+   * @param {string} name
+   * @return {Promise<Application|undefined>} for the given name
+   */
   async application(name) {
     return this.#applications.get(name);
   }
@@ -465,7 +481,7 @@ export class Repository extends OwnedObject {
   /**
    * Get sha of a ref.
    * @param {string} ref
-   * @return {Promise<string>} sha of the ref
+   * @return {Promise<string|undefined>} sha of the ref
    */
   async refId(ref) {}
 

package/src/util.mjs

@@ -19,6 +19,7 @@ export function asArray(value) {
  * @return {string} name without base
  */
 export function stripBaseName(name, repositoryBases, whenFound) {
+  if(name) {
   for (const b of repositoryBases) {
     const m = name.match(/^(\w+:)\/\/([^@]+@)/);
     if (m) {
@@ -30,12 +31,13 @@ export function stripBaseName(name, repositoryBases, whenFound) {
       return name.slice(b.length);
     }
   }
+}
   return name;
 }
 
 /**
  * Loops over names and executes stripBaseName.
- * @param {string|string[]} names
+ * @param {string[]|string|undefined} names
  * @param {string[]} repositoryBases all possible bases
  * @param {Function} [whenFound] to be called with the found base name
  * @return {string[]|string|undefined} names without base
@@ -43,7 +45,7 @@ export function stripBaseName(name, repositoryBases, whenFound) {
 export function stripBaseNames(names, repositoryBases, whenFound) {
   return Array.isArray(names)
     ? names.map(name => stripBaseName(name, repositoryBases, whenFound))
-    : names && stripBaseName(names, repositoryBases, whenFound);
+    : stripBaseName(names, repositoryBases, whenFound);
 }
 
 /**