bitbucket-repository-provider 6.0.11 → 6.0.13

package/README.md

@@ -1,5 +1,6 @@
 [![npm](https://img.shields.io/npm/v/bitbucket-repository-provider.svg)](https://www.npmjs.com/package/bitbucket-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=bitbucket-repository-provider\&badge=detailed)](https://bundlejs.com/?q=bitbucket-repository-provider)
 [![downloads](http://img.shields.io/npm/dm/bitbucket-repository-provider.svg?style=flat-square)](https://npmjs.org/package/bitbucket-repository-provider)
 [![GitHub Issues](https://img.shields.io/github/issues/arlac77/bitbucket-repository-provider.svg?style=flat-square)](https://github.com/arlac77/bitbucket-repository-provider/issues)

package/package.json

@@ -1,12 +1,14 @@
 {
   "name": "bitbucket-repository-provider",
-  "version": "6.0.11",
+  "version": "6.0.13",
   "publishConfig": {
     "access": "public",
     "provenance": true
   },
   "exports": {
-    ".": "./src/bitbucket-provider.mjs"
+    ".": {
+      "default": "./src/bitbucket-provider.mjs"
+    }
   },
   "description": "repository provider for bitbucket",
   "keywords": [
@@ -22,26 +24,30 @@
   ],
   "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:ava",
     "test:ava": "ava --timeout 4m tests/*-ava.mjs tests/*-ava-node.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",
-    "lint:docs": "documentation lint ./src/**/*.mjs"
+    "lint": "npm run lint:docs && npm run lint:tsc",
+    "lint:docs": "documentation lint ./src/**/*.mjs",
+    "lint:tsc": "tsc --allowJs --checkJs --noEmit -t esnext -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs"
   },
   "dependencies": {
     "content-entry": "^8.0.1",
-    "fetch-rate-limit-util": "^4.2.0",
+    "fetch-rate-limit-util": "^4.2.1",
     "matching-iterator": "^2.1.3",
     "one-time-execution-method": "^3.1.1",
-    "repository-provider": "^35.2.3"
+    "repository-provider": "^35.2.8"
   },
   "devDependencies": {
+    "@types/node": "^20.11.19",
     "ava": "^6.1.1",
     "c8": "^9.1.0",
     "documentation": "^14.0.3",
-    "repository-provider-test-support": "^3.0.4",
-    "semantic-release": "^23.0.2"
+    "repository-provider-test-support": "^3.0.6",
+    "semantic-release": "^23.0.2",
+    "typescript": "^5.3.3"
   },
   "engines": {
     "node": ">=20.11.1"
@@ -57,7 +63,8 @@
   "template": {
     "inheritFrom": [
       "arlac77/template-arlac77-github",
-      "arlac77/template-javascript-component"
+      "arlac77/template-javascript-component",
+      "arlac77/template-typescript"
     ]
   }
 }

package/src/bitbucket-provider.mjs

@@ -1,6 +1,11 @@
 import { replaceWithOneTimeExecutionMethod } from "one-time-execution-method";
 import { stateActionHandler } from "fetch-rate-limit-util";
-import { MultiGroupProvider, url_attribute, secret_attribute, default_attribute } from "repository-provider";
+import {
+  MultiGroupProvider,
+  url_attribute,
+  secret_attribute,
+  default_attribute
+} from "repository-provider";
 import { BitbucketBranch } from "./bitbucket-branch.mjs";
 import { BitbucketRepositoryGroup } from "./bitbucket-repository-group.mjs";
 import { BitbucketRepository } from "./bitbucket-repository.mjs";
@@ -77,7 +82,7 @@ export class BitbucketProvider extends MultiGroupProvider {
         ...secret_attribute,
         description: "API token",
         env: "{{instanceIdentifier}}TOKEN",
-        additionalAttributes: { "authentication.type": "token" },
+        additionalAttributes: { "authentication.type": "token" }
       },
       "authentication.password": {
         ...secret_attribute,
@@ -86,7 +91,7 @@ export class BitbucketProvider extends MultiGroupProvider {
           "{{instanceIdentifier}}APP_PASSWORD",
           "{{instanceIdentifier}}PASSWORD"
         ],
-        additionalAttributes: { "authentication.type": "basic" },
+        additionalAttributes: { "authentication.type": "basic" }
       },
       "authentication.username": {
         ...default_attribute,
@@ -105,37 +110,22 @@ export class BitbucketProvider extends MultiGroupProvider {
     return options["authentication.type"] !== undefined;
   }
 
-  /**
-   * @return {Class} repository group class used by the Provider
-   */
   get repositoryGroupClass() {
     return BitbucketRepositoryGroup;
   }
 
-  /**
-   * @return {Class} BitbucketRepository
-   */
   get repositoryClass() {
     return BitbucketRepository;
   }
 
-  /**
-   * @return {Class} BitbucketBranch
-   */
   get branchClass() {
     return BitbucketBranch;
   }
 
-  /**
-   * @return {Class} pull request class used by the Provider
-   */
   get pullRequestClass() {
     return BitbucketPullRequest;
   }
 
-  /**
-   * @return {Class} hook class used by the Provider
-   */
   get hookClass() {
     return BitbucketHook;
   }
@@ -202,13 +192,10 @@ export class BitbucketProvider extends MultiGroupProvider {
 
     options.reporter = (url, ...args) => this.trace(url.toString(), ...args);
 
-    return stateActionHandler(
-      new URL(url, this.api),
-      {
-        ...options,
-        headers
-      }
-    );
+    return stateActionHandler(new URL(url, this.api), {
+      ...options,
+      headers
+    });
   }
 
   fetchJSON(url, options = {}) {

package/src/bitbucket-pull-request.mjs

@@ -1,5 +1,7 @@
 import {
   PullRequest,
+  Repository,
+  Branch,
   boolean_attribute,
   count_attribute,
   default_attribute

package/src/bitbucket-repository-group.mjs

@@ -1,4 +1,4 @@
-import { RepositoryGroup, uuid_attribute } from "repository-provider";
+import { Repository, RepositoryGroup, uuid_attribute } from "repository-provider";
 
 /**
  *

package/src/bitbucket-repository.mjs

@@ -1,6 +1,7 @@
 import { replaceWithOneTimeExecutionMethod } from "one-time-execution-method";
 import {
   Repository,
+  RepositoryOwner,
   uuid_attribute,
   size_attribute,
   language_attribute,
@@ -9,7 +10,7 @@ import {
 
 /**
  * a repository hosted on bitbucket
- * @param {Owner} owner
+ * @param {RepositoryOwner} owner
  * @param {string} name
  * @param {Object} options
  * @param {string} [options.api]
@@ -32,7 +33,7 @@ export class BitbucketRepository extends Repository {
 
   static get attributMapping() {
     return {
-      ...super.attributeMappin,
+      ...super.attributeMapping,
       is_private: "isPrivate",
       website: "homePageURL"
     };
@@ -63,7 +64,7 @@ export class BitbucketRepository extends Repository {
   }
 
   /**
-   * {@link https://developer.atlassian.com/cloud/bitbucket/rest/api-group-repositories/#api-repositories-workspace-repo-slug-put}
+   * @link https://developer.atlassian.com/cloud/bitbucket/rest/api-group-repositories/#api-repositories-workspace-repo-slug-put
    */
   async update() {
     return this.provider.fetch(this.api, {
@@ -78,7 +79,7 @@ export class BitbucketRepository extends Repository {
   }
 
   /**
-   * @{link https://developer.atlassian.com/cloud/bitbucket/rest/api-group-repositories/#api-repositories-workspace-repo-slug-hooks-get}
+   * @link https://developer.atlassian.com/cloud/bitbucket/rest/api-group-repositories/#api-repositories-workspace-repo-slug-hooks-get
    */
   async initializeHooks() {
     let url = `${this.api}/hooks`;

package/types/bitbucket-branch.d.mts

@@ -0,0 +1,46 @@
+/**
+ * Branch of a bitbucket repository.
+ */
+export class BitbucketBranch extends Branch {
+    initialize(): Promise<void>;
+    hash: any;
+    /**
+     *
+     * @param patterns
+     */
+    entries(patterns: any): AsyncGenerator<{
+        [x: string]: any;
+        readonly isCollection: boolean;
+        readonly types: string[];
+        readonly mode: number;
+    } | LazyBufferContentEntry, void, unknown>;
+    /**
+     * Commit entries
+     * @param {string} message commit message
+     * @param {ContentEntry[]} updates content to be commited
+     * @param {Object} [options]
+     * @return {Promise}
+     */
+    commit(message: string, updates: ContentEntry[], options?: any): Promise<any>;
+    get entryClass(): typeof BufferContentEntry;
+}
+import { Branch } from "repository-provider";
+declare const LazyBufferContentEntry_base: {
+    new (): {
+        [x: string]: any;
+        readonly string: string;
+        readonly readStream: ReadableStream<any>;
+        readonly isEmpty: boolean;
+        readonly size: number;
+        getReadStream(): Promise<ReadableStream<any>>;
+    };
+    [x: string]: any;
+};
+declare class LazyBufferContentEntry extends LazyBufferContentEntry_base {
+    constructor(name: any, branch: any);
+    get buffer(): Promise<Buffer>;
+    _buffer(): Promise<Buffer>;
+}
+import { ContentEntry } from "content-entry";
+import { BufferContentEntry } from "content-entry";
+export {};

package/types/bitbucket-hook.d.mts

@@ -0,0 +1,9 @@
+/**
+ *
+ */
+export class BitbucketHook extends Hook {
+    static get attributeMapping(): {
+        uuid: string;
+    };
+}
+import { Hook } from "repository-provider";

package/types/bitbucket-provider.d.mts

@@ -0,0 +1,48 @@
+/**
+ * Provider for bitbucket repositories.
+ *
+ * Supported name schemes are
+ * - https://user:aSecret@bitbucket.org/owner/repo-name.git
+ * - git+https://user:aSecret@bitbucket.org/owner/repo-name.git
+ * - git@bitbucket.org:owner/repo-name.git
+ * - owner/repo-name
+ * Known environment variables
+ * - BITBUCKET_API api
+ * - BITBUCKET_TOKEN api token
+ * - BITBUCKET_USERNAME username
+ * - BITBUCKET_APP_PASSWORD password
+ * - BITBUCKET_PASSWORD password
+ * @param {Object} config
+ * @param {string} config.url provider scm base
+ * @param {string} config.api provider api base
+ * @param {Object} config.authentication authentication
+ * @param {string} config.authentication.type
+ * @param {string} config.authentication.username
+ * @param {string} config.authentication.password
+ */
+export class BitbucketProvider extends MultiGroupProvider {
+    /**
+     * Default configuration as given for the cloud privider.
+     * @return {Object}
+     */
+    static get attributes(): any;
+    get repositoryGroupClass(): typeof BitbucketRepositoryGroup;
+    get repositoryClass(): typeof BitbucketRepository;
+    get branchClass(): typeof BitbucketBranch;
+    get pullRequestClass(): typeof BitbucketPullRequest;
+    get hookClass(): typeof BitbucketHook;
+    /**
+     * {@link https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories}
+     */
+    initializeRepositories(): Promise<void>;
+    fetch(url: any, options?: {}): any;
+    fetchJSON(url: any, options?: {}): any;
+}
+export default BitbucketProvider;
+import { BitbucketBranch } from "./bitbucket-branch.mjs";
+import { BitbucketRepository } from "./bitbucket-repository.mjs";
+import { BitbucketPullRequest } from "./bitbucket-pull-request.mjs";
+import { BitbucketRepositoryGroup } from "./bitbucket-repository-group.mjs";
+import { BitbucketHook } from "./bitbucket-hook.mjs";
+import { MultiGroupProvider } from "repository-provider";
+export { BitbucketBranch, BitbucketRepository, BitbucketPullRequest, BitbucketRepositoryGroup, BitbucketHook };

package/types/bitbucket-pull-request.d.mts

@@ -0,0 +1,63 @@
+/**
+ * Pull request inside bitbucket
+ */
+export class BitbucketPullRequest extends PullRequest {
+    static mergeStrategies: Set<string>;
+    static get attributes(): {
+        state: {
+            values: Set<string>;
+            writeable: boolean;
+            type: string;
+            isKey: boolean;
+            writable: boolean;
+            mandatory: boolean;
+            private?: boolean;
+            depends?: string;
+            additionalAttributes: string[];
+            description?: string;
+            default?: any;
+            set?: Function;
+            get?: Function;
+            env?: string | string[];
+        };
+        close_source_branch: import("pacc").AttributeDefinition;
+        task_count: import("pacc").AttributeDefinition;
+        body: import("pacc").AttributeDefinition;
+        title: import("pacc").AttributeDefinition;
+        url: import("pacc").AttributeDefinition;
+        locked: import("pacc").AttributeDefinition;
+        merged: import("pacc").AttributeDefinition;
+        draft: import("pacc").AttributeDefinition;
+        dry: import("pacc").AttributeDefinition;
+        empty: import("pacc").AttributeDefinition;
+        id: import("pacc").AttributeDefinition;
+        name: import("pacc").AttributeDefinition;
+        description: import("pacc").AttributeDefinition;
+    };
+    /**
+     * List all pull request for a given repo.
+     * Result will be filtered by source branch, destination branch and states
+     * @param {Repository} repository
+     * @param {Object} filter
+     * @param {Branch} [filter.source]
+     * @param {Branch} [filter.destination]
+     * @param {Set<string>} [filter.states]
+     * @return {AsyncIterator<PullRequest>}
+     */
+    static list(repository: Repository, filter?: {
+        source?: Branch;
+        destination?: Branch;
+        states?: Set<string>;
+    }): AsyncIterator<PullRequest>;
+    /**
+     * {@link https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/pullrequests#post}
+     */
+    static open(source: any, destination: any, options: any): Promise<any>;
+    /**
+     * {@link https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/pullrequests/%7Bpull_request_id%7D/merge}
+     */
+    _merge(merge_strategy?: string): Promise<any>;
+}
+import { PullRequest } from "repository-provider";
+import { Repository } from "repository-provider";
+import { Branch } from "repository-provider";

package/types/bitbucket-repository-group.d.mts

@@ -0,0 +1,11 @@
+/**
+ *
+ */
+export class BitbucketRepositoryGroup extends RepositoryGroup {
+    static get attributeMapping(): {
+        display_name: string;
+        "links.avatar.href": string;
+        website: string;
+    };
+}
+import { RepositoryGroup } from "repository-provider";

package/types/bitbucket-repository.d.mts

@@ -0,0 +1,88 @@
+/**
+ * a repository hosted on bitbucket
+ * @param {RepositoryOwner} owner
+ * @param {string} name
+ * @param {Object} options
+ * @param {string} [options.api]
+ * @param {string} [options.group]
+ *
+ * @property {string} api
+ * @property {string} group
+ * @property {string} user
+ */
+export class BitbucketRepository extends Repository {
+    static get attributes(): {
+        uuid: import("pacc").AttributeDefinition;
+        size_attribute: import("pacc").AttributeDefinition;
+        language_attribute: import("pacc").AttributeDefinition;
+        fork_policy: {
+            default: string;
+            type: string;
+            isKey: boolean;
+            writable: boolean;
+            mandatory: boolean;
+            private?: boolean;
+            depends?: string;
+            additionalAttributes: string[];
+            description?: string;
+            set?: Function;
+            get?: Function;
+            env?: string | string[];
+        };
+        url: import("pacc").AttributeDefinition;
+        defaultBranchName: {
+            default: string;
+            type: string;
+            isKey: boolean;
+            writable: boolean;
+            mandatory: boolean;
+            private?: boolean;
+            depends?: string;
+            additionalAttributes: string[];
+            description?: string;
+            set?: Function;
+            get?: Function;
+            env?: string | string[];
+        };
+        cloneURL: import("pacc").AttributeDefinition;
+        isArchived: import("pacc").AttributeDefinition;
+        isLocked: import("pacc").AttributeDefinition;
+        isDisabled: import("pacc").AttributeDefinition;
+        isTemplate: import("pacc").AttributeDefinition;
+        isFork: import("pacc").AttributeDefinition;
+        id: import("pacc").AttributeDefinition;
+        name: import("pacc").AttributeDefinition;
+        description: import("pacc").AttributeDefinition;
+    };
+    static get attributMapping(): any;
+    get user(): any;
+    /**
+     * @link https://developer.atlassian.com/cloud/bitbucket/rest/api-group-repositories/#api-repositories-workspace-repo-slug-put
+     */
+    update(): Promise<any>;
+    /**
+     * @link https://developer.atlassian.com/cloud/bitbucket/rest/api-group-repositories/#api-repositories-workspace-repo-slug-hooks-get
+     */
+    initializeHooks(): Promise<void>;
+    /**
+     * {@link https://developer.atlassian.com/cloud/bitbucket/rest/api-group-refs/#api-group-refs}
+     */
+    initializeBranches(): Promise<void>;
+    /**
+     * Create a new branch
+     * {@link https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/refs/branches?_ga=2.65542446.1034690805.1541022941-164225451.1541022941#post}
+     * @param {string} name of the new branch to create
+     * @param {BitbucketBranch} from
+     * @param {Object} options
+     * @param {string} options.message
+     */
+    createBranch(name: string, from: BitbucketBranch, options: {
+        message: string;
+    }): Promise<import("repository-provider").Branch>;
+    /**
+     * {@link https://docs.atlassian.com/bitbucket-server/rest/5.8.0/bitbucket-branch-rest.html#idm45555984542992}
+     * {@link https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/refs/branches/%7Bname%7D#delete}
+     */
+    deleteBranch(name: any): Promise<any>;
+}
+import { Repository } from "repository-provider";