repository-provider 35.2.14 → 35.2.15

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 **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#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 **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#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.15",
   "publishConfig": {
     "access": "public",
     "provenance": true
@@ -36,16 +36,16 @@
     "lint:tsc": "tsc --allowJs --checkJs --noEmit -t esnext -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs"
   },
   "dependencies": {
-    "content-entry": "^9.0.0",
+    "content-entry": "^9.0.1",
     "matching-iterator": "^2.1.3",
     "pacc": "^3.1.5"
   },
   "devDependencies": {
-    "ava": "^6.1.1",
-    "browser-ava": "^2.2.0",
+    "ava": "^6.1.2",
+    "browser-ava": "^2.2.2",
     "c8": "^9.1.0",
     "documentation": "^14.0.3",
-    "repository-provider-test-support": "^3.1.3",
+    "repository-provider-test-support": "^3.1.4",
     "semantic-release": "^23.0.2",
     "typescript": "^5.3.3"
   },

package/src/base-provider.mjs

@@ -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() {

package/types/base-provider.d.mts

@@ -17,6 +17,7 @@
  * @param {MessageDestination} [options.messageDestination]
  * @property {MessageDestination} messageDestination
  * @property {string} url
+ * @property {string} api
  */
 export class BaseProvider extends BaseObject {
     /**
@@ -56,6 +57,14 @@ 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;
@@ -75,6 +84,14 @@ 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[];
         };