repository-provider 35.2.14 → 35.2.16

package/README.md

@@ -183,6 +183,7 @@ console.log(await readme.string);
     *   [Properties](#properties-2)
 *   [name](#name-2)
 *   [messageDestination](#messagedestination-1)
+*   [parsedName](#parsedname)
 *   [Branch](#branch)
     *   [Parameters](#parameters-43)
     *   [Properties](#properties-3)
@@ -747,7 +748,7 @@ Like .git suffix or #branch names.
 *   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
 *   `forLookup` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
 
-Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** normalized 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))** normalized name
 
 ### normalizeGroupName
 
@@ -759,7 +760,7 @@ Like .git suffix or #branch names.
 *   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
 *   `forLookup` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
 
-Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** normalized 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))** normalized name
 
 ### areRepositoryNamesCaseSensitive
 
@@ -785,8 +786,6 @@ base, group, repository and branch.
 *   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** 
 *   `focus` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** where lies the focus if only one path component is given (optional, default `"repository"`)
 
-Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** with separated attributes
-
 ### createRepository
 
 Create a repository.
@@ -807,6 +806,8 @@ List provider objects of a given type.
 *   `type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name of the method to deliver typed iterator projects,milestones,hooks,repositories,branches,tags
 *   `patterns` **([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))** group / repository filter
 
+Returns **AsyncIterable<([Repository](#repository) | [PullRequest](#pullrequest) | [Branch](#branch) | [Tag](#tag) | [Project](#project) | [Milestone](#milestone) | [Hook](#hook))>** all matching repositories of the providers
+
 ### projects
 
 List projects.
@@ -815,7 +816,7 @@ List projects.
 
 *   `patterns` **([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))?**&#x20;
 
-Returns **AsyncIterator<[Project](#project)>** all matching projects of the provider
+Returns **AsyncIterable<[Project](#project)>** all matching projects of the provider
 
 ### milestones
 
@@ -825,7 +826,7 @@ List milestones.
 
 *   `patterns` **([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))?**&#x20;
 
-Returns **AsyncIterator<[Milestone](#milestone)>** all matching milestones of the provider
+Returns **AsyncIterable<[Milestone](#milestone)>** all matching milestones of the provider
 
 ### repositories
 
@@ -892,7 +893,8 @@ Returns **[BaseProvider](#baseprovider)** this
 ### toJSON
 
 List all defined entries from attributes.
-return {object}
+
+Returns **{name: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)}**&#x20;
 
 ### instanceIdentifier
 
@@ -953,6 +955,7 @@ Returns **([BaseProvider](#baseprovider) | [undefined](https://developer.mozilla
 
 *   `messageDestination` **[MessageDestination](#messagedestination)**&#x20;
 *   `url` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+*   `api` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
 
 ### equals
 
@@ -996,7 +999,7 @@ Like .git suffix or #branch names.
 *   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
 *   `forLookup` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**&#x20;
 
-Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** normalized 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))** normalized name
 
 ### normalizeGroupName
 
@@ -1008,7 +1011,7 @@ Like .git suffix or #branch names.
 *   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
 *   `forLookup` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**&#x20;
 
-Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** normalized 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))** normalized name
 
 ### areRepositoryNamesCaseSensitive
 
@@ -1034,8 +1037,6 @@ base, group, repository and branch.
 *   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?**&#x20;
 *   `focus` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** where lies the focus if only one path component is given (optional, default `"repository"`)
 
-Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** with separated attributes
-
 ### createRepository
 
 Create a repository.
@@ -1056,6 +1057,8 @@ List provider objects of a given type.
 *   `type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name of the method to deliver typed iterator projects,milestones,hooks,repositories,branches,tags
 *   `patterns` **([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))** group / repository filter
 
+Returns **AsyncIterable<([Repository](#repository) | [PullRequest](#pullrequest) | [Branch](#branch) | [Tag](#tag) | [Project](#project) | [Milestone](#milestone) | [Hook](#hook))>** all matching repositories of the providers
+
 ### projects
 
 List projects.
@@ -1064,7 +1067,7 @@ List projects.
 
 *   `patterns` **([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))?**&#x20;
 
-Returns **AsyncIterator<[Project](#project)>** all matching projects of the provider
+Returns **AsyncIterable<[Project](#project)>** all matching projects of the provider
 
 ### milestones
 
@@ -1074,7 +1077,7 @@ List milestones.
 
 *   `patterns` **([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))?**&#x20;
 
-Returns **AsyncIterator<[Milestone](#milestone)>** all matching milestones of the provider
+Returns **AsyncIterable<[Milestone](#milestone)>** all matching milestones of the provider
 
 ### repositories
 
@@ -1141,7 +1144,8 @@ Returns **[BaseProvider](#baseprovider)** this
 ### toJSON
 
 List all defined entries from attributes.
-return {object}
+
+Returns **{name: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)}**&#x20;
 
 ### instanceIdentifier
 
@@ -1207,6 +1211,10 @@ Name of the provider.
 
 To forward info/warn and error messages to
 
+## parsedName
+
+Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
+
 ## Branch
 
 *   **See**: [Repository#\_addBranch](Repository#_addBranch)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "repository-provider",
-  "version": "35.2.14",
+  "version": "35.2.16",
   "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.0",
+    "content-entry": "^11.0.0",
     "matching-iterator": "^2.1.3",
-    "pacc": "^3.1.5"
+    "pacc": "^3.1.7"
   },
   "devDependencies": {
-    "ava": "^6.1.1",
-    "browser-ava": "^2.2.0",
+    "ava": "^6.1.3",
+    "browser-ava": "^2.2.14",
     "c8": "^9.1.0",
     "documentation": "^14.0.3",
-    "repository-provider-test-support": "^3.1.3",
-    "semantic-release": "^23.0.2",
-    "typescript": "^5.3.3"
+    "repository-provider-test-support": "^3.1.4",
+    "semantic-release": "^23.1.1",
+    "typescript": "^5.4.5"
   },
   "engines": {
-    "node": ">=20.11.1"
+    "node": ">=20.12.2"
   },
   "repository": {
     "type": "git",

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
  */
 
 /**
@@ -36,6 +36,7 @@ import {
  * @param {MessageDestination} [options.messageDestination]
  * @property {MessageDestination} messageDestination
  * @property {string} url
+ * @property {string} api
  */
 export class BaseProvider extends BaseObject {
   static get type() {
@@ -435,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/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-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]
@@ -17,6 +17,7 @@
  * @param {MessageDestination} [options.messageDestination]
  * @property {MessageDestination} messageDestination
  * @property {string} url
+ * @property {string} api
  */
 export class BaseProvider extends BaseObject {
     /**
@@ -229,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;
@@ -252,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/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.