repository-provider 35.0.4 → 35.2.0

package/README.md

@@ -1,5 +1,6 @@
 [![npm](https://img.shields.io/npm/v/repository-provider.svg)](https://www.npmjs.com/package/repository-provider)
 [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
+[![Typed with TypeScript](https://flat.badgen.net/badge/icon/Typed?icon=typescript\&label\&labelColor=blue\&color=555555)](https://typescriptlang.org)
 [![bundlejs](https://deno.bundlejs.com/?q=repository-provider\&badge=detailed)](https://bundlejs.com/?q=repository-provider)
 [![downloads](http://img.shields.io/npm/dm/repository-provider.svg?style=flat-square)](https://npmjs.org/package/repository-provider)
 [![GitHub Issues](https://img.shields.io/github/issues/arlac77/repository-provider.svg?style=flat-square)](https://github.com/arlac77/repository-provider/issues)
@@ -64,14 +65,12 @@ console.log(await readme.string);
 *   [priority\_attribute](#priority_attribute)
 *   [BaseObject](#baseobject)
     *   [Parameters](#parameters-5)
+    *   [Properties](#properties)
     *   [updateAttributes](#updateattributes)
         *   [Parameters](#parameters-6)
     *   [update](#update)
     *   [toString](#tostring)
-    *   [displayName](#displayname)
     *   [fullName](#fullname)
-    *   [fullCondensedName](#fullcondensedname)
-    *   [condensedName](#condensedname)
     *   [isWritable](#iswritable)
     *   [equals](#equals)
         *   [Parameters](#parameters-7)
@@ -81,9 +80,9 @@ console.log(await readme.string);
     *   [writableAttributes](#writableattributes)
     *   [attributeMapping](#attributemapping)
 *   [MessageDestination](#messagedestination)
-    *   [Properties](#properties)
-*   [BaseProvider](#baseprovider)
     *   [Properties](#properties-1)
+*   [BaseProvider](#baseprovider)
+    *   [Properties](#properties-2)
     *   [equals](#equals-1)
         *   [Parameters](#parameters-8)
     *   [repositoryBases](#repositorybases)
@@ -136,7 +135,7 @@ console.log(await readme.string);
 *   [messageDestination](#messagedestination-1)
 *   [Branch](#branch)
     *   [Parameters](#parameters-25)
-    *   [Properties](#properties-2)
+    *   [Properties](#properties-3)
     *   [url](#url)
     *   [refType](#reftype)
     *   [isWritable](#iswritable-1)
@@ -153,10 +152,10 @@ console.log(await readme.string);
     *   [createBranch](#createbranch)
         *   [Parameters](#parameters-30)
 *   [CommitResult](#commitresult)
-    *   [Properties](#properties-3)
+    *   [Properties](#properties-4)
 *   [Commit](#commit-1)
     *   [Parameters](#parameters-31)
-    *   [Properties](#properties-4)
+    *   [Properties](#properties-5)
 *   [Hook](#hook)
 *   [Issue](#issue)
 *   [Milestone](#milestone)
@@ -175,7 +174,10 @@ console.log(await readme.string);
         *   [Parameters](#parameters-37)
 *   [NamedObject](#namedobject)
     *   [Parameters](#parameters-38)
-    *   [Properties](#properties-5)
+    *   [Properties](#properties-6)
+    *   [displayName](#displayname)
+    *   [condensedName](#condensedname)
+    *   [fullCondensedName](#fullcondensedname)
     *   [equals](#equals-2)
         *   [Parameters](#parameters-39)
     *   [toJSON](#tojson-1)
@@ -216,7 +218,7 @@ console.log(await readme.string);
 *   [Project](#project)
 *   [PullRequest](#pullrequest)
     *   [Parameters](#parameters-47)
-    *   [Properties](#properties-6)
+    *   [Properties](#properties-7)
     *   [fullName](#fullname-2)
     *   [url](#url-2)
     *   [repository](#repository-1)
@@ -238,7 +240,7 @@ console.log(await readme.string);
 *   [merged](#merged)
 *   [draft](#draft)
 *   [ContentEntry](#contententry)
-    *   [Properties](#properties-7)
+    *   [Properties](#properties-8)
 *   [Ref](#ref)
     *   [ref](#ref-1)
     *   [refId](#refid)
@@ -258,7 +260,7 @@ console.log(await readme.string);
 *   [isProtected](#isprotected-1)
 *   [RepositoryGroup](#repositorygroup-1)
     *   [Parameters](#parameters-54)
-    *   [Properties](#properties-8)
+    *   [Properties](#properties-9)
     *   [attributeMapping](#attributemapping-1)
 *   [type](#type-1)
 *   [homePageURL](#homepageurl-1)
@@ -266,7 +268,7 @@ console.log(await readme.string);
     *   [Parameters](#parameters-55)
 *   [Repository](#repository-3)
     *   [Parameters](#parameters-56)
-    *   [Properties](#properties-9)
+    *   [Properties](#properties-10)
     *   [slug](#slug-1)
     *   [entry](#entry-1)
         *   [Parameters](#parameters-57)
@@ -329,6 +331,9 @@ console.log(await readme.string);
         *   [Parameters](#parameters-79)
     *   [attributes](#attributes-2)
 *   [defaultBranchName](#defaultbranchname)
+*   [branches](#branches-2)
+*   [tags](#tags-2)
+*   [pullRequests](#pullrequests-2)
 *   [Review](#review)
 *   [SingleGroupProvider](#singlegroupprovider)
     *   [repository](#repository-4)
@@ -467,6 +472,11 @@ Creates an instance of BaseObject.
 *   `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)?** 
 
+### Properties
+
+*   `id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** 
+*   `description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** 
+
 ### updateAttributes
 
 Takes values from options.
@@ -484,30 +494,12 @@ Save object attributes in the backing store.
 
 Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** fullName
 
-### displayName
-
-Beautified name use for human displaying only.
-
-Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** human readable name
-
 ### fullName
 
 Complete name in the hierachy.
 
 Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
 
-### fullCondensedName
-
-Complete name in the hierachy.
-
-Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
-
-### condensedName
-
-Name with default parts removed
-
-Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
-
 ### isWritable
 
 By default cannot be written to.
@@ -537,7 +529,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 ### attributes
 
-Attributes definitions
+Attributes definitions.
 
 Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
 
@@ -703,7 +695,7 @@ List repositories.
 
 *   `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<[Repository](#repository)>** all matching repos of the provider
+Returns **AsyncIterable<[Repository](#repository)>** all matching repos of the provider
 
 ### branches
 
@@ -713,7 +705,7 @@ List branches.
 
 *   `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<[Branch](#branch)>** all matching branches of the provider
+Returns **AsyncIterable<[Branch](#branch)>** all matching branches of the provider
 
 ### tags
 
@@ -723,7 +715,7 @@ List 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))?**&#x20;
 
-Returns **AsyncIterator<[Tag](#tag)>** all matching tags of the provider
+Returns **AsyncIterable<[Tag](#tag)>** all matching tags of the provider
 
 ### hooks
 
@@ -733,7 +725,7 @@ List hooks.
 
 *   `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<[Hook](#hook)>** all matching hooks of the provider
+Returns **AsyncIterable<[Hook](#hook)>** all matching hooks of the provider
 
 ### pullRequests
 
@@ -743,7 +735,7 @@ List pull requests.
 
 *   `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<[PullRequest](#pullrequest)>** all matching pullRequests of the provider
+Returns **AsyncIterable<[PullRequest](#pullrequest)>** all matching pullRequests of the provider
 
 ### name
 
@@ -893,7 +885,7 @@ Add commits into a pull request.
 
 #### Parameters
 
-*   `commits` **([Commit](#commit) | AsyncIterator<[Commit](#commit)>)** to be commited
+*   `commits` **([Commit](#commit) | AsyncGenerator<[Commit](#commit)>)** to be commited
 *   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
 
     *   `options.pullRequestBranch` **([Branch](#branch) | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))** to commit into
@@ -910,7 +902,7 @@ Remove entries form the branch.
 
 #### Parameters
 
-*   `entries` **AsyncIterator<[ContentEntry](#contententry)>**&#x20;
+*   `entries` **AsyncIterable<[ContentEntry](#contententry)>**&#x20;
 
 ### createPullRequest
 
@@ -1015,7 +1007,7 @@ List groups.
 
 *   `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<[RepositoryGroup](#repositorygroup)>** all matching repositories groups of the provider
+Returns **AsyncIterable<[RepositoryGroup](#repositorygroup)>** all matching repositories groups of the provider
 
 ### createRepositoryGroup
 
@@ -1056,6 +1048,24 @@ Object with a name.
 
 *   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
 
+### displayName
+
+Beautified name use for human displaying only.
+
+Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** human readable name
+
+### condensedName
+
+Name with default parts removed
+
+Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+
+### fullCondensedName
+
+Complete name in the hierachy.
+
+Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+
 ### equals
 
 Check for equality.
@@ -1209,28 +1219,38 @@ Forwarded to the owner.
 
 By default we use the owners implementation.
 
-Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** as defined in the owner
+Returns **[Repository](#repository)** as defined in the owner
 
 ### pullRequestClass
 
 By default we use the owners implementation.
 
+Returns **[PullRequest](#pullrequest)** as defined in the owner
+
 ### branchClass
 
 By default we use the owners implementation.
 
+Returns **[Branch](#branch)** as defined in the owner
+
 ### tagClass
 
 By default we use the owners implementation.
 
+Returns **[Tag](#tag)** as defined in the owner
+
 ### entryClass
 
 By default we use the owners implementation.
 
+Returns **[ContentEntry](#contententry)** as defined in the owner
+
 ### hookClass
 
 By default we use the owners implementation.
 
+Returns **[Hook](#hook)** as defined in the owner
+
 ### addMethodName
 
 Method name to be called to register one instance in the owner.
@@ -1317,7 +1337,7 @@ Decline the pull request.
 
 ### reviews
 
-Returns **AsyncIterator<[Review](#review)>**&#x20;
+Returns **AsyncIterable<[Review](#review)>**&#x20;
 
 ### identifier
 
@@ -1335,10 +1355,14 @@ Returns **[Set](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Glob
 
 possible states
 
+Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
+
 ### validMergeMethods
 
 All valid merge methods
 
+Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
+
 Returns **[Set](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** valid merge methods.
 
 ### list
@@ -1355,7 +1379,7 @@ Result will be filtered by source branch, destination branch and states
     *   `filter.destination` **[Branch](#branch)??**&#x20;
     *   `filter.states` **[Set](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>?**&#x20;
 
-Returns **AsyncIterator<[PullRequest](#pullrequest)>**&#x20;
+Returns **AsyncIterable<[PullRequest](#pullrequest)>**&#x20;
 
 ### open
 
@@ -1429,13 +1453,13 @@ List entries of the branch.
 
 *   `matchingPatterns` **([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<[ContentEntry](#contententry)>** all matching entries in the branch
+Returns **AsyncGenerator<[ContentEntry](#contententry)>** all matching entries in the branch
 
 ### asyncIterator
 
 List all entries of the branch.
 
-Returns **AsyncIterator<[ContentEntry](#contententry)>** all entries in the branch
+Returns **AsyncGenerator<[ContentEntry](#contententry)>** all entries in the branch
 
 ### maybeEntry
 
@@ -1593,7 +1617,7 @@ List entries of the default branch.
 
 *   `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<[ContentEntry](#contententry)>** all matching entries in the branch
+Returns **AsyncIterable<[ContentEntry](#contententry)>** all matching entries in the branch
 
 ### maybeEntry
 
@@ -1613,7 +1637,7 @@ List commits of the default branch.
 
 *   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**&#x20;
 
-Returns **AsyncIterator<[Commit](#commit)>** all matching commits in the repository
+Returns **AsyncIterable<[Commit](#commit)>** all matching commits in the repository
 
 ### cloneURL
 
@@ -1625,13 +1649,13 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 The url of issue tracking system.
 
-Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+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))**&#x20;
 
 ### homePageURL
 
 The url of home page.
 
-Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+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))**&#x20;
 
 ### isArchived
 
@@ -1690,7 +1714,7 @@ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
 
 *   `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<[Branch](#branch)>** of all branches
+Returns **AsyncGenerator<[Branch](#branch)>** of all branches
 
 ### createBranch
 
@@ -1714,7 +1738,7 @@ Internal branch creation does not call repository.initialize()
 *   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the new branch
 *   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** to be passed to the branch
 
-Returns **[Branch](#branch)** newly created branch
+Returns **[Branch](#branch)** newly created branch or already present one for the given name
 
 ### deleteBranch
 
@@ -1742,7 +1766,7 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
 
 *   `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<[Tag](#tag)>** of all tags
+Returns **AsyncGenerator<[Tag](#tag)>** of all tags
 
 ### addTag
 
@@ -1784,7 +1808,7 @@ Returns **[PullRequest](#pullrequest)**&#x20;
 
 Deliver all [PullRequest](#pullrequest)s.
 
-Returns **AsyncIterator<[PullRequest](#pullrequest)>** of all pull requests
+Returns **AsyncGenerator<[PullRequest](#pullrequest)>** of all pull requests
 
 ### pullRequest
 
@@ -1829,7 +1853,7 @@ Add a new Hook.
 
 List hooks.
 
-Returns **AsyncIterator<[Hook](#hook)>** all hooks of the repository
+Returns **AsyncGenerator<[Hook](#hook)>** all hooks of the repository
 
 ### hook
 
@@ -1897,6 +1921,18 @@ The name of the default branch
 
 Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
 
+## branches
+
+Type: [Map](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), [Branch](#branch)>
+
+## tags
+
+Type: [Map](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), [Tag](#tag)>
+
+## pullRequests
+
+Type: [Map](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), [PullRequest](#pullrequest)>
+
 ## Review
 
 **Extends OwnedObject**
@@ -1935,7 +1971,7 @@ List groups.
 
 *   `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))**&#x20;
 
-Returns **AsyncIterator<[RepositoryGroup](#repositorygroup)>** always deliver the one and only present group
+Returns **AsyncIterable<[RepositoryGroup](#repositorygroup)>** always deliver the one and only present group
 
 ## Tag
 

package/package.json

@@ -1,13 +1,17 @@
 {
   "name": "repository-provider",
-  "version": "35.0.4",
+  "version": "35.2.0",
   "publishConfig": {
     "access": "public",
     "provenance": true
   },
   "exports": {
-    ".": "./src/index.mjs"
+    ".": {
+      "types": "./types/index.d.mts",
+      "default": "./src/index.mjs"
+    }
   },
+  "types": "./types/index.d.mts",
   "description": "abstract interface to git repository providers like github, bitbucket and gitlab",
   "keywords": [
     "git",
@@ -21,6 +25,7 @@
   ],
   "license": "BSD-2-Clause",
   "scripts": {
+    "prepare": "tsc --allowJs --declaration --emitDeclarationOnly --declarationDir types -t esnext -m esnext --module nodenext --moduleResolution nodenext ./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",
@@ -31,24 +36,24 @@
     "lint:tsc": "tsc --allowJs --checkJs --noEmit -t esnext -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs"
   },
   "dependencies": {
-    "matching-iterator": "^2.0.12",
-    "pacc": "^3.0.0"
+    "matching-iterator": "^2.1.3",
+    "pacc": "^3.1.1"
   },
   "devDependencies": {
     "ava": "^6.1.1",
-    "browser-ava": "^2.1.10",
+    "browser-ava": "^2.2.0",
     "c8": "^9.1.0",
     "documentation": "^14.0.3",
-    "repository-provider-test-support": "^3.0.3",
-    "semantic-release": "^23.0.0",
+    "repository-provider-test-support": "^3.0.4",
+    "semantic-release": "^23.0.2",
     "typescript": "^5.3.3"
   },
   "engines": {
-    "node": ">=20.11.0"
+    "node": ">=20.11.1"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/arlac77/repository-provider"
+    "url": "git+https://github.com/arlac77/repository-provider.git"
   },
   "bugs": {
     "url": "https://github.com/arlac77/repository-provider/issues"
@@ -58,7 +63,7 @@
     "inheritFrom": [
       "arlac77/template-arlac77-github",
       "arlac77/template-browser-ava",
-      "arlac77/template-esm-only",
+      "arlac77/template-javascript-component",
       "arlac77/template-typescript"
     ]
   }

package/src/base-object.mjs

@@ -8,6 +8,9 @@ import { description_attribute, id_attribute } from "./attributes.mjs";
  * Creates an instance of BaseObject.
  * @param {Object} options
  * @param {Object} [additionalProperties]
+ * 
+ * @property {string?} id
+ * @property {string?} description
  */
 export class BaseObject {
   /**
@@ -29,7 +32,7 @@ export class BaseObject {
   }
 
   /**
-   * Attributes definitions
+   * Attributes definitions.
    * @return {Object}
    */
   static get attributes() {

package/src/base-provider.mjs

@@ -347,7 +347,7 @@ export class BaseProvider extends BaseObject {
   /**
    * List repositories.
    * @param {string[]|string} [patterns]
-   * @return {AsyncIterator<Repository>} all matching repos of the provider
+   * @return {AsyncIterable<Repository>} all matching repos of the provider
    */
   async *repositories(patterns) {
     yield* this.list("repositories", patterns);
@@ -356,7 +356,7 @@ export class BaseProvider extends BaseObject {
   /**
    * List branches.
    * @param {string[]|string} [patterns]
-   * @return {AsyncIterator<Branch>} all matching branches of the provider
+   * @return {AsyncIterable<Branch>} all matching branches of the provider
    */
   async *branches(patterns) {
     yield* this.list("branches", patterns);
@@ -365,7 +365,7 @@ export class BaseProvider extends BaseObject {
   /**
    * List tags.
    * @param {string[]|string} [patterns]
-   * @return {AsyncIterator<Tag>} all matching tags of the provider
+   * @return {AsyncIterable<Tag>} all matching tags of the provider
    */
   async *tags(patterns) {
     yield* this.list("tags", patterns);
@@ -374,7 +374,7 @@ export class BaseProvider extends BaseObject {
   /**
    * List hooks.
    * @param {string[]|string} [patterns]
-   * @return {AsyncIterator<Hook>} all matching hooks of the provider
+   * @return {AsyncIterable<Hook>} all matching hooks of the provider
    */
   async *hooks(patterns) {
     yield* this.list("hooks", patterns);
@@ -383,7 +383,7 @@ export class BaseProvider extends BaseObject {
   /**
    * List pull requests.
    * @param {string[]|string} [patterns]
-   * @return {AsyncIterator<PullRequest>} all matching pullRequests of the provider
+   * @return {AsyncIterable<PullRequest>} all matching pullRequests of the provider
    */
   async *pullRequests(patterns) {
     yield* this.list("pullRequests", patterns);

package/src/branch.mjs

@@ -2,7 +2,7 @@ import { Ref } from "./ref.mjs";
 import { PullRequest } from "./pull-request.mjs";
 import { Repository } from "./repository.mjs";
 import { RepositoryOwner } from "./repository-owner.mjs";
-import { Commit } from "./commit.mjs";
+import { Commit, CommitResult } from "./commit.mjs";
 
 /**
  * @typedef {Object} ContentEntry
@@ -172,7 +172,7 @@ export class Branch extends Ref {
 
   /**
    * Remove entries form the branch.
-   * @param {AsyncIterator<ContentEntry>} entries
+   * @param {AsyncIterable<ContentEntry>} entries
    */
   async removeEntries(entries) {}
 

package/src/commit.mjs

@@ -1,14 +1,16 @@
-
 /**
- * @typedef {Object} CommitResult
  * @property {string} ref
  */
+export class CommitResult {
+  ref;
 
-export class User
-{
-
+  constructor(ref) {
+    this.ref = ref;
+  }
 }
 
+export class User {}
+
 /**
  * @property {Repository} repository
  * @property {string} message
@@ -17,9 +19,8 @@ export class User
  * @property {User} committer
  */
 export class Commit {
-
   repository;
-  
+
   constructor(repository) {
     this.repository = repository;
   }

package/src/multi-group-provider.mjs

@@ -71,7 +71,7 @@ export class MultiGroupProvider extends BaseProvider {
   /**
    * List groups.
    * @param {string[]|string} [patterns]
-   * @return {AsyncIterator<RepositoryGroup>} all matching repositories groups of the provider
+   * @return {AsyncIterable<RepositoryGroup>} all matching repositories groups of the provider
    */
   async *repositoryGroups(patterns) {
     await this.initializeRepositories();