repository-provider 35.2.15 → 35.2.17

package/README.md

@@ -894,7 +894,7 @@ Returns **[BaseProvider](#baseprovider)** this
 
 List all defined entries from attributes.
 
-Returns **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
+Returns **{name: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)}** 
 
 ### instanceIdentifier
 
@@ -1145,7 +1145,7 @@ Returns **[BaseProvider](#baseprovider)** this
 
 List all defined entries from attributes.
 
-Returns **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
+Returns **{name: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)}** 
 
 ### instanceIdentifier
 
@@ -1197,11 +1197,11 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
 
 ### Properties
 
-*   `info` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** 
-*   `debug` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** 
-*   `warn` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** 
-*   `error` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** 
-*   `trace` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** 
+*   `info` **function ([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)): void** 
+*   `debug` **function ([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)): void** 
+*   `warn` **function ([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)): void** 
+*   `error` **function ([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)): void** 
+*   `trace` **function ([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)): void** 
 
 ## name
 
@@ -2608,7 +2608,7 @@ A URL auth component will be removed to.
 
 *   `name` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** 
 *   `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
+*   `whenFound` **function ([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)): void?** to be called with the found base name
 
 Returns **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** name without base
 
@@ -2620,7 +2620,7 @@ Loops over names and executes stripBaseName.
 
 *   `names` **([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))**&#x20;
 *   `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
+*   `whenFound` **function ([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)): void?** 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)> | [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
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "repository-provider",
-  "version": "35.2.15",
+  "version": "35.2.17",
   "publishConfig": {
     "access": "public",
     "provenance": true
@@ -25,32 +25,33 @@
   ],
   "license": "BSD-2-Clause",
   "scripts": {
-    "prepare": "tsc --allowJs --declaration --emitDeclarationOnly --declarationDir types -t esnext -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs",
+    "prepare": "npm run prepare:typescript",
+    "prepare:typescript": "tsc --allowJs --declaration --emitDeclarationOnly --declarationDir types --resolveJsonModule -t esnext -m esnext --module nodenext --moduleResolution nodenext --rootDir src ./src**/*.mjs",
     "test": "npm run test:browser-ava && npm run test:ava",
     "test:ava": "ava --timeout 4m tests/*-ava.mjs tests/*-ava-node.mjs",
     "test:browser-ava": "browser-ava --headless --no-keep-open tests/*-ava.mjs tests/*-ava-browser.mjs",
     "cover": "c8 -x 'tests/**/*' --temp-directory build/tmp ava --timeout 4m tests/*-ava.mjs tests/*-ava-node.mjs && c8 report -r lcov -o build/coverage --temp-directory build/tmp",
     "docs": "documentation readme --section=API ./src/**/*.mjs",
-    "lint": "npm run lint:docs && npm run lint:tsc",
+    "lint": "npm run lint:docs && npm run lint:typescript",
     "lint:docs": "documentation lint ./src/**/*.mjs",
-    "lint:tsc": "tsc --allowJs --checkJs --noEmit -t esnext -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs"
+    "lint:typescript": "tsc --allowJs --checkJs --noEmit --resolveJsonModule -t esnext -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs"
   },
   "dependencies": {
-    "content-entry": "^9.0.1",
+    "content-entry": "^11.0.0",
     "matching-iterator": "^2.1.3",
-    "pacc": "^3.1.5"
+    "pacc": "^3.1.7"
   },
   "devDependencies": {
-    "ava": "^6.1.2",
-    "browser-ava": "^2.2.2",
+    "ava": "^6.1.3",
+    "browser-ava": "^2.2.14",
     "c8": "^9.1.0",
     "documentation": "^14.0.3",
     "repository-provider-test-support": "^3.1.4",
-    "semantic-release": "^23.0.2",
-    "typescript": "^5.3.3"
+    "semantic-release": "^24.0.0",
+    "typescript": "^5.4.5"
   },
   "engines": {
-    "node": ">=20.11.1"
+    "node": ">=20.12.2"
   },
   "repository": {
     "type": "git",

package/src/base-object.mjs

@@ -62,13 +62,16 @@ export class BaseObject {
     return {};
   }
 
+  /** @type {string} */ id;
+  /** @type {string} */ description;
+
   /**
- * Creates an instance of BaseObject.
- * @param {Object} [options]
- * @param {string} [options.id]
- * @param {string} [options.description]
- * @param {Object} [additionalProperties]
- */
+   * 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);
   }

package/src/base-provider.mjs

@@ -23,11 +23,11 @@ import {
 /**
  * @typedef {Object} MessageDestination
  * Endpoint to deliver log messages to.
- * @property {Function} info
- * @property {Function} debug
- * @property {Function} warn
- * @property {Function} error
- * @property {Function} trace
+ * @property {function(string):void} info
+ * @property {function(string):void} debug
+ * @property {function(string):void} warn
+ * @property {function(string):void} error
+ * @property {function(string):void} trace
  */
 
 /**
@@ -436,7 +436,7 @@ export class BaseProvider extends BaseObject {
 
   /**
    * List all defined entries from attributes.
-   * @return {object}
+   * @return {{name: string}}
    */
   toJSON() {
     const json = { name: this.name };

package/src/named-object.mjs

@@ -33,7 +33,7 @@ export class NamedObject extends BaseObject {
     });
   }
 
-  #name;
+  /** @type {string} */ #name;
 
   get name() {
     return this.#name;

package/src/util.mjs

@@ -15,7 +15,7 @@ export function asArray(value) {
  * A URL auth component will be removed to.
  * @param {string|undefined} name
  * @param {string[]} repositoryBases all possible bases
- * @param {Function} [whenFound] to be called with the found base name
+ * @param {function(string):void} [whenFound] to be called with the found base name
  * @return {string|undefined} name without base
  */
 export function stripBaseName(name, repositoryBases, whenFound) {
@@ -39,7 +39,7 @@ export function stripBaseName(name, repositoryBases, whenFound) {
  * Loops over names and executes stripBaseName.
  * @param {string[]|string|undefined} names
  * @param {string[]} repositoryBases all possible bases
- * @param {Function} [whenFound] to be called with the found base name
+ * @param {function(string):void} [whenFound] to be called with the found base name
  * @return {string[]|string|undefined} names without base
  */
 export function stripBaseNames(names, repositoryBases, whenFound) {

package/types/base-object.d.mts

@@ -37,16 +37,18 @@ export class BaseObject {
      */
     static get attributeMapping(): any;
     /**
-   * Creates an instance of BaseObject.
-   * @param {Object} [options]
-   * @param {string} [options.id]
-   * @param {string} [options.description]
-   * @param {Object} [additionalProperties]
-   */
+     * 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);
+    /** @type {string} */ id: string;
+    /** @type {string} */ description: string;
     /**
      * Takes values from options.
      * @param {Object} [options]

package/types/base-provider.d.mts

@@ -5,11 +5,11 @@
 /**
  * @typedef {Object} MessageDestination
  * Endpoint to deliver log messages to.
- * @property {Function} info
- * @property {Function} debug
- * @property {Function} warn
- * @property {Function} error
- * @property {Function} trace
+ * @property {function(string):void} info
+ * @property {function(string):void} debug
+ * @property {function(string):void} warn
+ * @property {function(string):void} error
+ * @property {function(string):void} trace
  */
 /**
  * @param {Object} [options]
@@ -57,14 +57,6 @@ export class BaseProvider extends BaseObject {
             description?: string;
             default?: any;
             set?: Function;
-            /**
-             * Extract options suitable for the constructor.
-             * Form the given set of environment variables.
-             * 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} undefined if no suitable environment variables have been found
-             */
             get?: Function;
         };
         url: import("pacc").AttributeDefinition;
@@ -84,14 +76,6 @@ export class BaseProvider extends BaseObject {
             additionalAttributes: string[];
             description?: string;
             set?: Function;
-            /**
-             * Extract options suitable for the constructor.
-             * Form the given set of environment variables.
-             * 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} undefined if no suitable environment variables have been found
-             */
             get?: Function;
             env?: string | string[];
         };
@@ -246,9 +230,11 @@ export class BaseProvider extends BaseObject {
     get provider(): BaseProvider;
     /**
      * List all defined entries from attributes.
-     * @return {object}
+     * @return {{name: string}}
      */
-    toJSON(): object;
+    toJSON(): {
+        name: string;
+    };
     initializeRepositories(): void;
     trace(...args: any[]): any;
     debug(...args: any[]): any;
@@ -269,11 +255,11 @@ export type Milestone = import('./milestone.mjs').Milestone;
  * Endpoint to deliver log messages to.
  */
 export type MessageDestination = {
-    info: Function;
-    debug: Function;
-    warn: Function;
-    error: Function;
-    trace: Function;
+    info: (arg0: string) => void;
+    debug: (arg0: string) => void;
+    warn: (arg0: string) => void;
+    error: (arg0: string) => void;
+    trace: (arg0: string) => void;
 };
 import { BaseObject } from "./base-object.mjs";
 import { Repository } from "./repository.mjs";

package/types/named-object.d.mts

@@ -16,8 +16,8 @@ export class NamedObject extends BaseObject {
         description: import("pacc").AttributeDefinition;
     };
     constructor(name: any, options: any, additionalProperties: any);
-    set name(name: any);
-    get name(): any;
+    set name(name: string);
+    get name(): string;
     /**
      * Beautified name use for human displaying only.
      * @return {string} human readable name

package/types/pull-request.d.mts

@@ -108,7 +108,7 @@ export class PullRequest extends OwnedObject {
     };
     source: any;
     get destination(): any;
-    get number(): any;
+    get number(): string;
     get dry(): boolean;
     /**
      * @return {Repository} destination repository

package/types/util.d.mts

@@ -10,18 +10,18 @@ export function asArray(value: any[] | any): any[];
  * A URL auth component will be removed to.
  * @param {string|undefined} name
  * @param {string[]} repositoryBases all possible bases
- * @param {Function} [whenFound] to be called with the found base name
+ * @param {function(string):void} [whenFound] to be called with the found base name
  * @return {string|undefined} name without base
  */
-export function stripBaseName(name: string | undefined, repositoryBases: string[], whenFound?: Function): string | undefined;
+export function stripBaseName(name: string | undefined, repositoryBases: string[], whenFound?: (arg0: string) => void): string | undefined;
 /**
  * Loops over names and executes stripBaseName.
  * @param {string[]|string|undefined} names
  * @param {string[]} repositoryBases all possible bases
- * @param {Function} [whenFound] to be called with the found base name
+ * @param {function(string):void} [whenFound] to be called with the found base name
  * @return {string[]|string|undefined} names without base
  */
-export function stripBaseNames(names: string[] | string | undefined, repositoryBases: string[], whenFound?: Function): string[] | string | undefined;
+export function stripBaseNames(names: string[] | string | undefined, repositoryBases: string[], whenFound?: (arg0: string) => void): string[] | string | undefined;
 /**
  * Find a new branch name for a given pattern.
  * '*' will be replaced by a number.