repository-provider 35.2.11 → 35.2.13

package/README.md

@@ -626,9 +626,6 @@ Creates an instance of BaseObject.
 ### Parameters
 
 *   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
-
-    *   `options.id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** 
-    *   `options.description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** 
 *   `additionalProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
 
 ### Properties
@@ -642,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
@@ -933,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
@@ -1181,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.11",
+  "version": "35.2.13",
   "publishConfig": {
     "access": "public",
     "provenance": true
@@ -36,7 +36,7 @@
     "lint:tsc": "tsc --allowJs --checkJs --noEmit -t esnext -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs"
   },
   "dependencies": {
-    "content-entry": "^8.1.2",
+    "content-entry": "^9.0.0",
     "matching-iterator": "^2.1.3",
     "pacc": "^3.1.5"
   },
@@ -45,7 +45,7 @@
     "browser-ava": "^2.2.0",
     "c8": "^9.1.0",
     "documentation": "^14.0.3",
-    "repository-provider-test-support": "^3.1.2",
+    "repository-provider-test-support": "^3.1.3",
     "semantic-release": "^23.0.2",
     "typescript": "^5.3.3"
   },

package/src/base-object.mjs

@@ -62,13 +62,20 @@ export class BaseObject {
     return {};
   }
 
+  /**
+ * Creates an instance of BaseObject.
+ * @param {Object} [options]
+ * @param {string} [options.id]
+ * @param {string} [options.description]
+ * @param {Object} [additionalProperties]
+ */
   constructor(options, additionalProperties) {
     this.updateAttributes(options, additionalProperties);
   }
 
   /**
    * Takes values from options.
-   * @param {Object} options
+   * @param {Object} [options]
    * @param {Object} [additionalProperties]
    */
   updateAttributes(options, additionalProperties) {

package/src/base-provider.mjs

@@ -147,13 +147,14 @@ export class BaseProvider extends BaseObject {
    * Creates a new provider for a given set of options.
    * @param {Object} options additional options
    * @param {string} [options.instanceIdentifier] name of the provider instance
+   * @param {string} [options.description]
    * @param {Object} env taken from process.env
    * @return {BaseProvider|undefined} newly created provider or undefined if options are not sufficient to construct a provider
    */
-  static initialize(options = {}, env) {
+  static initialize(options, env) {
     options = {
       ...options,
-      ...this.optionsFromEnvironment(env, options.instanceIdentifier)
+      ...this.optionsFromEnvironment(env, options?.instanceIdentifier)
     };
 
     if (this.areOptionsSufficcient(options)) {
@@ -315,6 +316,7 @@ 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
    */
   async *list(type, patterns) {
     if (patterns === undefined) {
@@ -324,6 +326,7 @@ export class BaseProvider extends BaseObject {
       }
     } else {
       for (const pattern of asArray(patterns)) {
+        // @ts-ignore
         const [groupPattern, repoPattern] = stripBaseName(
           pattern,
           this.repositoryBases
@@ -343,6 +346,7 @@ export class BaseProvider extends BaseObject {
    * @return {AsyncIterator<Project>} all matching projects of the provider
    */
   async *projects(patterns) {
+    // @ts-ignore
     yield* this.list("projects", patterns);
   }
 
@@ -352,6 +356,7 @@ export class BaseProvider extends BaseObject {
    * @return {AsyncIterator<Milestone>} all matching milestones of the provider
    */
   async *milestones(patterns) {
+    // @ts-ignore
     yield* this.list("milestones", patterns);
   }
 
@@ -361,6 +366,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);
   }
 
@@ -370,6 +376,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);
   }
 
@@ -379,6 +386,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);
   }
 
@@ -388,6 +396,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);
   }
 
@@ -397,6 +406,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);
   }
 

package/types/base-object.d.mts

@@ -36,13 +36,23 @@ export class BaseObject {
      * @return {Object}
      */
     static get attributeMapping(): any;
-    constructor(options: any, additionalProperties: any);
+    /**
+   * Creates an instance of BaseObject.
+   * @param {Object} [options]
+   * @param {string} [options.id]
+   * @param {string} [options.description]
+   * @param {Object} [additionalProperties]
+   */
+    constructor(options?: {
+        id?: string;
+        description?: string;
+    }, additionalProperties?: any);
     /**
      * Takes values from options.
-     * @param {Object} options
+     * @param {Object} [options]
      * @param {Object} [additionalProperties]
      */
-    updateAttributes(options: any, additionalProperties?: any): void;
+    updateAttributes(options?: any, additionalProperties?: any): void;
     /**
      * Save object attributes in the backing store.
      */

package/types/base-provider.d.mts

@@ -83,11 +83,13 @@ export class BaseProvider extends BaseObject {
      * Creates a new provider for a given set of options.
      * @param {Object} options additional options
      * @param {string} [options.instanceIdentifier] name of the provider instance
+     * @param {string} [options.description]
      * @param {Object} env taken from process.env
      * @return {BaseProvider|undefined} newly created provider or undefined if options are not sufficient to construct a provider
      */
     static initialize(options: {
         instanceIdentifier?: string;
+        description?: string;
     }, env: any): BaseProvider | undefined;
     get priority(): number;
     /**
@@ -161,8 +163,9 @@ 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]
@@ -250,9 +253,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";