repository-provider 35.2.27 → 35.3.0

package/LICENSE

@@ -1,23 +1,12 @@
-Copyright (c) 2017-2024 by arlac77
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-* Redistributions of source code must retain the above copyright notice, this
-  list of conditions and the following disclaimer.
-
-* Redistributions in binary form must reproduce the above copyright notice,
-  this list of conditions and the following disclaimer in the documentation
-  and/or other materials provided with the distribution.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+Copyright (C) 2017-2025 by arlac77
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -1,5 +1,5 @@
 [![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)
+[![License](https://img.shields.io/badge/License-0BSD-blue.svg)](https://spdx.org/licenses/0BSD.html)
 [![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)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "repository-provider",
-  "version": "35.2.27",
+  "version": "35.3.0",
   "publishConfig": {
     "access": "public",
     "provenance": true
@@ -8,8 +8,8 @@
   "types": "./types/index.d.mts",
   "exports": {
     ".": {
-      "default": "./src/index.mjs",
-      "types": "./types/index.d.mts"
+      "types": "./types/index.d.mts",
+      "default": "./src/index.mjs"
     }
   },
   "description": "abstract interface to git repository providers like github, bitbucket and gitlab",
@@ -23,36 +23,35 @@
       "email": "markus.felten@gmx.de"
     }
   ],
-  "license": "BSD-2-Clause",
+  "license": "0BSD",
   "scripts": {
     "prepare": "node --run prepare:typescript",
-    "prepare:typescript": "tsc --allowJs --declaration --emitDeclarationOnly --declarationDir types --resolveJsonModule --target es2024 --lib es2024 -m esnext --module nodenext --moduleResolution nodenext --rootDir src ./src**/*.mjs",
+    "prepare:typescript": "tsc --allowJs --declaration --emitDeclarationOnly --declarationDir types --resolveJsonModule --target esnext -m esnext --module nodenext --moduleResolution nodenext --rootDir src ./src**/*.mjs",
     "test": "node --run test:browser-ava && node --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",
+    "docs": "documentation readme --section=API ./src**/*.mjs",
     "lint": "node --run lint:docs && node --run lint:typescript",
-    "lint:docs": "documentation lint ./src/**/*.mjs",
-    "lint:typescript": "tsc --allowJs --checkJs --noEmit --resolveJsonModule --target es2024 --lib es2024 -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs"
+    "lint:docs": "documentation lint ./src**/*.mjs",
+    "lint:typescript": "tsc --allowJs --checkJs --noEmit --resolveJsonModule --target esnext -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs"
   },
   "dependencies": {
-    "content-entry": "^11.1.2",
+    "content-entry": "^13.0.4",
     "matching-iterator": "^2.1.3",
-    "pacc": "^3.1.8"
+    "pacc": "^3.4.1"
   },
   "devDependencies": {
-    "@types/readable-stream": "^4.0.18",
-    "ava": "^6.2.0",
-    "browser-ava": "^2.3.2",
-    "c8": "^10.1.2",
+    "ava": "^6.3.0",
+    "browser-ava": "^2.3.24",
+    "c8": "^10.1.3",
     "documentation": "^14.0.3",
-    "repository-provider-test-support": "^3.1.7",
-    "semantic-release": "^24.2.0",
-    "typescript": "^5.7.1-rc"
+    "repository-provider-test-support": "^3.1.9",
+    "semantic-release": "^24.2.3",
+    "typescript": "^5.8.3"
   },
   "engines": {
-    "node": ">=22.10.0"
+    "node": ">=22.15.0"
   },
   "repository": {
     "type": "git",

package/src/base-provider.mjs

@@ -88,9 +88,7 @@ export class BaseProvider extends BaseObject {
                 ) === envName
             )
           ) {
-            if (options === undefined) {
-              options = {};
-            }
+            options ??= {};
 
             if (options[name] === undefined) {
               options[name] = value;
@@ -348,9 +346,12 @@ export class BaseProvider extends BaseObject {
           this.repositoryBases
         ).split(/\//);
 
-        if(repoPattern) {
+        if (repoPattern) {
           // TODO do cleanup in stripBase()
-          repoPattern = repoPattern.replace(/\.git(#.*)?$/, (all,b) => b || "");
+          repoPattern = repoPattern.replace(
+            /\.git(#.*)?$/,
+            (all, b) => b || ""
+          );
         }
 
         // @ts-ignore

package/src/commit.mjs

@@ -1,3 +1,5 @@
+import { Repository } from "./repository.mjs";
+
 /**
  * @property {string} ref
  */
@@ -21,7 +23,17 @@ export class User {}
 export class Commit {
   repository;
 
-  constructor(repository) {
+  /**
+   * 
+   * @param {Repository} repository 
+   * @param {Object} options
+   * @param {string} options.sha
+   * @param {string} options.message
+   * @param {string} options.author
+   * @param {string} options.committer
+   */
+  constructor(repository, options) {
     this.repository = repository;
+    Object.assign(this, options);
   }
 }

package/src/repository.mjs

@@ -19,12 +19,6 @@ import {
 
 /**
  * Abstract repository
- * @class Repository
- * @param {RepositoryOwner} owner
- * @param {string} name (#branch) will be removed
- * @param {Object} [options]
- * @param {string} [options.description] human readable description
- * @param {string} [options.id] internal id
  *
  * @property {RepositoryOwner} owner
  * @property {string} name without (#branch)
@@ -85,8 +79,19 @@ export class Repository extends OwnedObject {
   /** @type {Map<string,PullRequest>} */ #pullRequests = new Map();
   #hooks = [];
 
-  constructor(owner, name, options) {
-    super(owner, owner.normalizeRepositoryName(name, false), options);
+  /**
+   * @param {RepositoryOwner} owner
+   * @param {string} name (#branch) will be removed
+   * @param {Object} [options]
+   * @param {string} [options.description] human readable description
+   * @param {string} [options.id] internal id
+   * @param {Object} [options]
+   * @param {string} [options.id]
+   * @param {string} [options.description]
+   * @param {Object} [additionalProperties]
+   */
+  constructor(owner, name, options, additionalProperties) {
+    super(owner, owner.normalizeRepositoryName(name, false), options, additionalProperties);
   }
 
   /**

package/types/commit.d.mts

@@ -15,6 +15,21 @@ export class User {
  * @property {User} committer
  */
 export class Commit {
-    constructor(repository: any);
-    repository: any;
+    /**
+     *
+     * @param {Repository} repository
+     * @param {Object} options
+     * @param {string} options.sha
+     * @param {string} options.message
+     * @param {string} options.author
+     * @param {string} options.committer
+     */
+    constructor(repository: Repository, options: {
+        sha: string;
+        message: string;
+        author: string;
+        committer: string;
+    });
+    repository: Repository;
 }
+import { Repository } from "./repository.mjs";

package/types/repository.d.mts

@@ -1,11 +1,5 @@
 /**
  * Abstract repository
- * @class Repository
- * @param {RepositoryOwner} owner
- * @param {string} name (#branch) will be removed
- * @param {Object} [options]
- * @param {string} [options.description] human readable description
- * @param {string} [options.id] internal id
  *
  * @property {RepositoryOwner} owner
  * @property {string} name without (#branch)
@@ -51,7 +45,21 @@ export class Repository extends OwnedObject {
         name: import("pacc").AttributeDefinition;
         description: import("pacc").AttributeDefinition;
     };
-    constructor(owner: any, name: any, options: any);
+    /**
+     * @param {RepositoryOwner} owner
+     * @param {string} name (#branch) will be removed
+     * @param {Object} [options]
+     * @param {string} [options.description] human readable description
+     * @param {string} [options.id] internal id
+     * @param {Object} [options]
+     * @param {string} [options.id]
+     * @param {string} [options.description]
+     * @param {Object} [additionalProperties]
+     */
+    constructor(owner: typeof RepositoryOwner, name: string, options?: {
+        description?: string;
+        id?: string;
+    }, additionalProperties?: any);
     get defaultBranchName(): string;
     /**
      * Lookup entries form the head of the default branch.
@@ -263,3 +271,4 @@ import { Hook } from "./hook.mjs";
 import { Milestone } from "./milestone.mjs";
 import { Project } from "./project.mjs";
 import { Application } from "./application.mjs";
+import { RepositoryOwner } from "./repository-owner.mjs";