repository-provider 35.2.12 → 35.2.14

package/README.md

@@ -639,7 +639,7 @@ Takes values from options.
 
 #### Parameters
 
-*   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
+*   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
 *   `additionalProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
 
 ### update
@@ -930,9 +930,10 @@ Creates a new provider for a given set of options.
 
 #### Parameters
 
-*   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** additional options (optional, default `{}`)
+*   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** additional options
 
     *   `options.instanceIdentifier` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** name of the provider instance
+    *   `options.description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** 
 *   `env` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** taken from process.env
 
 Returns **([BaseProvider](#baseprovider) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** newly created provider or undefined if options are not sufficient to construct a provider
@@ -1178,9 +1179,10 @@ Creates a new provider for a given set of options.
 
 #### Parameters
 
-*   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** additional options (optional, default `{}`)
+*   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** additional options
 
     *   `options.instanceIdentifier` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** name of the provider instance
+    *   `options.description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** 
 *   `env` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** taken from process.env
 
 Returns **([BaseProvider](#baseprovider) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** newly created provider or undefined if options are not sufficient to construct a provider

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "repository-provider",
-  "version": "35.2.12",
+  "version": "35.2.14",
   "publishConfig": {
     "access": "public",
     "provenance": true

package/src/base-provider.mjs

@@ -15,10 +15,10 @@ import {
   default_attribute
 } from "./attributes.mjs";
 
-/** 
-* @typedef {import('./project.mjs').Project} Project
-* @typedef {import('./milestone.mjs').Milestone} Milestone
-*/
+/**
+ * @typedef {import('./project.mjs').Project} Project
+ * @typedef {import('./milestone.mjs').Milestone} Milestone
+ */
 
 /**
  * @typedef {Object} MessageDestination
@@ -143,6 +143,11 @@ export class BaseProvider extends BaseObject {
     return 0;
   }
 
+  /**
+   * @typedef {Object} parsedName
+   *
+   */
+
   /**
    * Creates a new provider for a given set of options.
    * @param {Object} options additional options
@@ -163,7 +168,7 @@ export class BaseProvider extends BaseObject {
   }
 
   /**
-   * @param {any} other 
+   * @param {any} other
    * @return {boolean} true if other provider is the same as the receiver
    */
   equals(other) {
@@ -199,11 +204,11 @@ export class BaseProvider extends BaseObject {
    * Like .git suffix or #branch names.
    * @param {string} name
    * @param {boolean} forLookup
-   * @return {string} normalized name
+   * @return {string|undefined} normalized name
    */
   normalizeRepositoryName(name, forLookup) {
     const { repository } = this.parseName(name);
-    return forLookup && !this.areRepositoryNamesCaseSensitive
+    return repository && forLookup && !this.areRepositoryNamesCaseSensitive
       ? repository.toLowerCase()
       : repository;
   }
@@ -213,7 +218,7 @@ export class BaseProvider extends BaseObject {
    * Like .git suffix or #branch names.
    * @param {string} name
    * @param {boolean} forLookup
-   * @return {string} normalized name
+   * @return {string|undefined} normalized name
    */
   normalizeGroupName(name, forLookup) {
     const { group } = this.parseName(name, "group");
@@ -245,12 +250,13 @@ export class BaseProvider extends BaseObject {
    * base, group, repository and branch.
    * @param {string} [name]
    * @param {string} focus where lies the focus if only one path component is given
-   * @return {Object} with separated attributes
+   * @return {{base: string|undefined, group: string|undefined, repository: string|undefined, branch: string|undefined}} with separated attributes
    */
   parseName(name, focus = "repository") {
     const result = {};
 
     if (name === undefined) {
+      // @ts-ignore
       return result;
     }
 
@@ -295,6 +301,7 @@ export class BaseProvider extends BaseObject {
       }
     }
 
+    // @ts-ignore
     return result;
   }
 
@@ -310,12 +317,13 @@ export class BaseProvider extends BaseObject {
     const rg = await this.repositoryGroup(group);
     return rg.createRepository(repository, options);
   }
-  
+
   /**
    * 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|undefined} patterns group / repository filter
+   * @return {AsyncIterable<Repository|PullRequest|Branch|Tag|Project|Milestone|Hook>} all matching repositories of the providers
    */
   async *list(type, patterns) {
     if (patterns === undefined) {
@@ -325,6 +333,7 @@ export class BaseProvider extends BaseObject {
       }
     } else {
       for (const pattern of asArray(patterns)) {
+        // @ts-ignore
         const [groupPattern, repoPattern] = stripBaseName(
           pattern,
           this.repositoryBases
@@ -341,18 +350,20 @@ export class BaseProvider extends BaseObject {
   /**
    * List projects.
    * @param {string[]|string} [patterns]
-   * @return {AsyncIterator<Project>} all matching projects of the provider
+   * @return {AsyncIterable<Project>} all matching projects of the provider
    */
   async *projects(patterns) {
+    // @ts-ignore
     yield* this.list("projects", patterns);
   }
 
   /**
    * List milestones.
    * @param {string[]|string} [patterns]
-   * @return {AsyncIterator<Milestone>} all matching milestones of the provider
+   * @return {AsyncIterable<Milestone>} all matching milestones of the provider
    */
   async *milestones(patterns) {
+    // @ts-ignore
     yield* this.list("milestones", patterns);
   }
 
@@ -362,6 +373,7 @@ export class BaseProvider extends BaseObject {
    * @return {AsyncIterable<Repository>} all matching repos of the provider
    */
   async *repositories(patterns) {
+    // @ts-ignore
     yield* this.list("repositories", patterns);
   }
 
@@ -371,6 +383,7 @@ export class BaseProvider extends BaseObject {
    * @return {AsyncIterable<Branch>} all matching branches of the provider
    */
   async *branches(patterns) {
+    // @ts-ignore
     yield* this.list("branches", patterns);
   }
 
@@ -380,6 +393,7 @@ export class BaseProvider extends BaseObject {
    * @return {AsyncIterable<Tag>} all matching tags of the provider
    */
   async *tags(patterns) {
+    // @ts-ignore
     yield* this.list("tags", patterns);
   }
 
@@ -389,6 +403,7 @@ export class BaseProvider extends BaseObject {
    * @return {AsyncIterable<Hook>} all matching hooks of the provider
    */
   async *hooks(patterns) {
+    // @ts-ignore
     yield* this.list("hooks", patterns);
   }
 
@@ -398,6 +413,7 @@ export class BaseProvider extends BaseObject {
    * @return {AsyncIterable<PullRequest>} all matching pullRequests of the provider
    */
   async *pullRequests(patterns) {
+    // @ts-ignore
     yield* this.list("pullRequests", patterns);
   }
 
@@ -419,7 +435,7 @@ export class BaseProvider extends BaseObject {
 
   /**
    * List all defined entries from attributes.
-   * return {object}
+   * @return {object}
    */
   toJSON() {
     const json = { name: this.name };

package/types/base-provider.d.mts

@@ -1,7 +1,7 @@
 /**
-* @typedef {import('./project.mjs').Project} Project
-* @typedef {import('./milestone.mjs').Milestone} Milestone
-*/
+ * @typedef {import('./project.mjs').Project} Project
+ * @typedef {import('./milestone.mjs').Milestone} Milestone
+ */
 /**
  * @typedef {Object} MessageDestination
  * Endpoint to deliver log messages to.
@@ -79,6 +79,10 @@ export class BaseProvider extends BaseObject {
             env?: string | string[];
         };
     };
+    /**
+     * @typedef {Object} parsedName
+     *
+     */
     /**
      * Creates a new provider for a given set of options.
      * @param {Object} options additional options
@@ -120,17 +124,17 @@ export class BaseProvider extends BaseObject {
      * Like .git suffix or #branch names.
      * @param {string} name
      * @param {boolean} forLookup
-     * @return {string} normalized name
+     * @return {string|undefined} normalized name
      */
-    normalizeRepositoryName(name: string, forLookup: boolean): string;
+    normalizeRepositoryName(name: string, forLookup: boolean): string | undefined;
     /**
      * Bring a group name into its normal form by removing any clutter.
      * Like .git suffix or #branch names.
      * @param {string} name
      * @param {boolean} forLookup
-     * @return {string} normalized name
+     * @return {string|undefined} normalized name
      */
-    normalizeGroupName(name: string, forLookup: boolean): string;
+    normalizeGroupName(name: string, forLookup: boolean): string | undefined;
     /**
      * Are repository names case sensitive.
      * Overwrite and return false if you want to have case insensitive repository lookup.
@@ -148,9 +152,14 @@ export class BaseProvider extends BaseObject {
      * base, group, repository and branch.
      * @param {string} [name]
      * @param {string} focus where lies the focus if only one path component is given
-     * @return {Object} with separated attributes
+     * @return {{base: string|undefined, group: string|undefined, repository: string|undefined, branch: string|undefined}} with separated attributes
      */
-    parseName(name?: string, focus?: string): any;
+    parseName(name?: string, focus?: string): {
+        base: string | undefined;
+        group: string | undefined;
+        repository: string | undefined;
+        branch: string | undefined;
+    };
     /**
      * Create a repository.
      * @param {string} name of group and repository
@@ -163,20 +172,21 @@ export class BaseProvider extends BaseObject {
      *
      * @param {string} type name of the method to deliver typed iterator projects,milestones,hooks,repositories,branches,tags
      * @param {string[]|string|undefined} patterns group / repository filter
+     * @return {AsyncIterable<Repository|PullRequest|Branch|Tag|Project|Milestone|Hook>} all matching repositories of the providers
      */
-    list(type: string, patterns: string[] | string | undefined): AsyncGenerator<any, void, any>;
+    list(type: string, patterns: string[] | string | undefined): AsyncIterable<Repository | PullRequest | Branch | Tag | Project | Milestone | Hook>;
     /**
      * List projects.
      * @param {string[]|string} [patterns]
-     * @return {AsyncIterator<Project>} all matching projects of the provider
+     * @return {AsyncIterable<Project>} all matching projects of the provider
      */
-    projects(patterns?: string[] | string): AsyncIterator<Project>;
+    projects(patterns?: string[] | string): AsyncIterable<Project>;
     /**
      * List milestones.
      * @param {string[]|string} [patterns]
-     * @return {AsyncIterator<Milestone>} all matching milestones of the provider
+     * @return {AsyncIterable<Milestone>} all matching milestones of the provider
      */
-    milestones(patterns?: string[] | string): AsyncIterator<Milestone>;
+    milestones(patterns?: string[] | string): AsyncIterable<Milestone>;
     /**
      * List repositories.
      * @param {string[]|string} [patterns]
@@ -219,11 +229,9 @@ export class BaseProvider extends BaseObject {
     get provider(): BaseProvider;
     /**
      * List all defined entries from attributes.
-     * return {object}
+     * @return {object}
      */
-    toJSON(): {
-        name: string;
-    };
+    toJSON(): object;
     initializeRepositories(): void;
     trace(...args: any[]): any;
     debug(...args: any[]): any;
@@ -252,9 +260,9 @@ export type MessageDestination = {
 };
 import { BaseObject } from "./base-object.mjs";
 import { Repository } from "./repository.mjs";
+import { PullRequest } from "./pull-request.mjs";
 import { Branch } from "./branch.mjs";
 import { Tag } from "./tag.mjs";
 import { Hook } from "./hook.mjs";
-import { PullRequest } from "./pull-request.mjs";
 import { RepositoryGroup } from "./repository-group.mjs";
 import { ContentEntry } from "content-entry";