github-repository-provider 9.0.5 → 9.0.7

package/README.md

@@ -383,7 +383,7 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
 *   `sha` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
 *   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
 
-Returns **any** 
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)>**&#x20;
 
 ### deletePullRequest
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "github-repository-provider",
-  "version": "9.0.5",
+  "version": "9.0.7",
   "publishConfig": {
     "access": "public",
     "provenance": true
@@ -24,6 +24,7 @@
   ],
   "license": "BSD-2-Clause",
   "scripts": {
+    "prepare": "tsc --allowJs --declaration --emitDeclarationOnly --declarationDir types -t esnext -m esnext --module nodenext --moduleResolution nodenext --rootDir src ./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",
@@ -33,22 +34,22 @@
     "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",
     "fetch-link-util": "^1.1.1",
-    "fetch-rate-limit-util": "^4.2.1",
+    "fetch-rate-limit-util": "^4.2.2",
     "matching-iterator": "^2.1.3",
     "one-time-execution-method": "^3.1.1",
-    "repository-provider": "^35.2.11"
+    "repository-provider": "^35.2.15"
   },
   "devDependencies": {
-    "@types/node": "^20.11.19",
-    "ava": "^6.1.1",
+    "@types/node": "^20.11.24",
+    "ava": "^6.1.2",
     "c8": "^9.1.0",
     "documentation": "^14.0.3",
     "etag-cache-leveldb": "^2.1.1",
     "leveldown": "^6.1.1",
     "levelup": "^5.1.1",
-    "repository-provider-test-support": "^3.1.2",
+    "repository-provider-test-support": "^3.1.4",
     "semantic-release": "^23.0.2",
     "typescript": "^5.3.3"
   },

package/src/github-repository.mjs

@@ -283,7 +283,6 @@ export class GithubRepository extends Repository {
   }
 
   /**
-   * @TODO generalize for all repos ?
    * @param {string} ref
    * @param {string} sha
    */
@@ -297,9 +296,8 @@ export class GithubRepository extends Repository {
    * @param {string} ref
    * @param {string} sha
    * @param {Object} options
-   * @returns
+   * @returns {Promise<Object>}
    *
-   * @TODO belongs into Ref ?
    */
   async setRefId(ref, sha, options) {
     ref = ref.replace(/^refs\//, "");

package/types/github-branch.d.mts

@@ -0,0 +1,60 @@
+/**
+ * Branch on GitHub.
+ */
+export class GithubBranch extends Branch {
+    constructor(owner: any, name: any, options: any);
+    /**
+     * Writes content into the branch
+     * {@link https://developer.github.com/v3/git/blobs/#get-a-blob}
+     * @param {ContentEntry} entry
+     * @return {Promise<ContentEntry>} written content with sha values set
+     */
+    writeEntry(entry: ContentEntry): Promise<ContentEntry>;
+    /**
+     * {@link https://developer.github.com/v3/git/trees/#create-a-tree}
+     * {@link https://developer.github.com/v3/git/commits/#create-a-commit}
+     * {@link https://developer.github.com/v3/git/refs/#update-a-reference}
+     * @param {string} message
+     * @param {ContentEntry[]} entries
+     * @param {Object} [options]
+     */
+    commit(message: string, entries: ContentEntry[], options?: any): Promise<any>;
+    /**
+     * {@link https://developer.github.com/v3/repos/contents/#get-repository-content}
+     * @param {string} name
+     */
+    entry(name: string): Promise<any>;
+    entries(patterns: any): AsyncGenerator<{
+        [x: string]: any;
+        readonly isCollection: boolean;
+        readonly types: string[];
+        readonly mode: number;
+    } | LazyBufferContentEntry, void, unknown>;
+    /**
+     * https://developer.github.com/v3/repos/contents/
+     * @param {AsyncIterator<ContentEntry>} entries
+     */
+    removeEntries(entries: AsyncIterator<ContentEntry>): Promise<void>;
+    #private;
+}
+import { Branch } from "repository-provider";
+import { ContentEntry } from "content-entry";
+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, mode: any, branch: any);
+    branch: any;
+    get buffer(): Promise<any>;
+    getBuffer(): Promise<any>;
+    #private;
+}
+export {};

package/types/github-owner.d.mts

@@ -0,0 +1,15 @@
+/**
+ * Represents github repo owner either
+ * - users
+ * - organization
+ */
+export class GithubOwner extends RepositoryGroup {
+    /**
+     * Map attributes between external and internal representation.
+     */
+    static get attributeMapping(): {
+        site_admin: string;
+    };
+    get api(): string;
+}
+import { RepositoryGroup } from "repository-provider";

package/types/github-provider.d.mts

@@ -0,0 +1,174 @@
+/**
+ * <!-- skip-example -->
+ * GitHub provider.
+ * Lookup a repository.
+ * known environment variables
+ * - GITHUB_TOKEN or GH_TOKEN api token
+ * @example
+ * import GithubProvider from 'github-repository-provider';
+ *
+ * const ghp = new GithubProvider();
+ * const r1 = ghp.repository('git@github.com:arlac77/github-repository-provider.git');
+ * const r2 = ghp.repository('git://github.com/arlac77/github-repository-provider.git');
+ * const r3 = ghp.repository('git+ssh://github.com/arlac77/github-repository-provider.git');
+ * const r4 = ghp.repository('https://github.com/arlac77/github-repository-provider.git#master');
+ * const r5 = ghp.repository('git+https://github.com/arlac77/github-repository-provider.git#master');
+ * const r6 = ghp.repository('arlac77/github-repository-provider');
+ * // different ways to address the same repository
+ */
+export class GithubProvider extends MultiGroupProvider {
+    static get attributes(): {
+        host: {
+            env: string[];
+            default: string;
+            type: string;
+            isKey: boolean;
+            writable: boolean;
+            mandatory: boolean;
+            private?: boolean;
+            depends?: string;
+            additionalAttributes: string[];
+            description?: string;
+            set?: Function;
+            get?: Function; /**
+             * We are called github.
+             * @return {string} github
+             */
+        };
+        ssh: {
+            default: string;
+            type: string;
+            isKey: boolean;
+            writable: boolean;
+            mandatory: boolean;
+            private?: boolean;
+            depends?: string;
+            additionalAttributes: string[];
+            description?: string;
+            set?: Function;
+            get?: Function; /**
+             * We are called github.
+             * @return {string} github
+             */
+            env?: string | string[];
+        };
+        url: {
+            env: string;
+            set: (value: any) => any;
+            default: string;
+            depends: string;
+            type: string;
+            isKey: boolean;
+            writable: boolean;
+            mandatory: boolean;
+            private?: boolean;
+            additionalAttributes: string[];
+            description?: string;
+            get?: Function; /**
+             * We are called github.
+             * @return {string} github
+             */
+        };
+        api: {
+            env: string;
+            set: (value: any) => any;
+            depends: string;
+            default: string;
+            type: string;
+            isKey: boolean;
+            writable: boolean;
+            mandatory: boolean;
+            private?: boolean;
+            additionalAttributes: string[];
+            description?: string;
+            get?: Function; /**
+             * We are called github.
+             * @return {string} github
+             */
+        };
+        "authentication.token": {
+            env: string[];
+            additionalAttributes: {
+                "authentication.type": string;
+            };
+            private: boolean;
+            mandatory: boolean;
+            type: string;
+            isKey: boolean;
+            writable: boolean;
+            depends?: string;
+            description?: string;
+            default?: any;
+            set?: Function;
+            get?: Function; /**
+             * We are called github.
+             * @return {string} github
+             */
+        };
+        priority: {
+            default: number;
+            type: string;
+            isKey: boolean;
+            writable: boolean;
+            mandatory: boolean;
+            private?: boolean;
+            depends?: string;
+            additionalAttributes: string[];
+            description?: string;
+            set?: Function;
+            get?: Function; /**
+             * We are called github.
+             * @return {string} github
+             */
+            env?: string | string[];
+        };
+        name: {
+            env: string;
+            type: string;
+            isKey: boolean;
+            writable: boolean;
+            mandatory: boolean;
+            private?: boolean;
+            depends?: string;
+            additionalAttributes: string[];
+            description?: string;
+            default?: any;
+            set?: Function;
+            get?: Function;
+        };
+        description: import("pacc").AttributeDefinition;
+        messageDestination: {
+            type: string;
+            default: Console;
+            writable: boolean;
+            private: boolean;
+            isKey: boolean;
+            mandatory: boolean;
+            depends?: string;
+            additionalAttributes: string[];
+            description?: string;
+            set?: Function;
+            get?: Function;
+            env?: string | string[];
+        };
+    };
+    fetch(url: any, options?: {}): any;
+    fetchJSON(url: any, options?: {}): any;
+    /**
+     * {@link https://developer.github.com/v3/repos/#list-repositories-for-the-authenticated-user}
+     */
+    initializeRepositories(): Promise<void>;
+    get pullRequestClass(): typeof GithubPullRequest;
+    get repositoryClass(): typeof GithubRepository;
+    get branchClass(): typeof GithubBranch;
+    get repositoryGroupClass(): typeof GithubOwner;
+    get entryClass(): typeof BufferContentEntry;
+}
+export default GithubProvider;
+import { GithubRepository } from "./github-repository.mjs";
+import { GithubBranch } from "./github-branch.mjs";
+import { GithubOwner } from "./github-owner.mjs";
+import { GithubPullRequest } from "./github-pull-request.mjs";
+import { MultiGroupProvider } from "repository-provider";
+import { BufferContentEntry } from "content-entry";
+export { GithubRepository, GithubBranch, GithubOwner, GithubPullRequest };

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

@@ -0,0 +1,59 @@
+/**
+ * Github pull request.
+ */
+export class GithubPullRequest extends PullRequest {
+    /**
+     * All valid merge methods.
+     * @return {Set<string>} valid merge methods
+     */
+    static validMergeMethods: Set<string>;
+    static get attributes(): {
+        maintainer_can_modify: import("pacc").AttributeDefinition;
+        body: import("pacc").AttributeDefinition;
+        title: import("pacc").AttributeDefinition;
+        url: import("pacc").AttributeDefinition;
+        state: {
+            default: string;
+            values: Set<string>;
+            type: string;
+            isKey: boolean;
+            writable: boolean;
+            mandatory: boolean;
+            private?: boolean;
+            depends?: string;
+            additionalAttributes: string[];
+            description?: string;
+            set?: Function;
+            get?: Function;
+            env?: string | string[];
+        };
+        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;
+    };
+    /**
+     * {@link https://developer.github.com/v3/pulls/#list-pull-requests}
+     * @param {Repository} repository
+     * @param {Object} filter
+     */
+    static list(repository: Repository, filter?: any): AsyncGenerator<GithubPullRequest, void, unknown>;
+    /**
+     * {@link https://developer.github.com/v3/pulls/#create-a-pull-request}
+     * @param {Branch} source
+     * @param {Branch} destination
+     * @param {Object} [options]
+     */
+    static open(source: Branch, destination: Branch, options?: any): Promise<GithubPullRequest>;
+    /**
+     * {@link https://developer.github.com/v3/pulls/#merge-a-pull-request}
+     */
+    _merge(method?: string): Promise<void>;
+}
+import { PullRequest } from "repository-provider";
+import { Repository } from "repository-provider";
+import { Branch } from "repository-provider";

package/types/github-repository.d.mts

@@ -0,0 +1,113 @@
+/**
+ * Repository on GitHub.
+ */
+export class GithubRepository extends Repository {
+    static get attributes(): {
+        auto_init: import("pacc").AttributeDefinition;
+        size: import("pacc").AttributeDefinition;
+        language: import("pacc").AttributeDefinition;
+        gitignore_template: import("pacc").AttributeDefinition;
+        license_template: import("pacc").AttributeDefinition;
+        allow_squash_merge: import("pacc").AttributeDefinition;
+        allow_merge_commit: import("pacc").AttributeDefinition;
+        allow_rebase_merge: import("pacc").AttributeDefinition;
+        allow_auto_merge: import("pacc").AttributeDefinition;
+        delete_branch_on_merge: import("pacc").AttributeDefinition;
+        issuesURL: import("pacc").AttributeDefinition;
+        squash_merge_commit_title: import("pacc").AttributeDefinition;
+        squash_merge_commit_message: import("pacc").AttributeDefinition;
+        merge_commit_title: import("pacc").AttributeDefinition;
+        merge_commit_message: import("pacc").AttributeDefinition;
+        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;
+    };
+    /**
+     * {@link https://docs.github.com/en/rest/reference/commits#list-commits}
+     * @param {Object} options
+     * @returns {AsyncIterable<Commit>}
+     */
+    commits(options: any): AsyncIterable<Commit>;
+    addCommit(tree: any, parents: any, message: any): Promise<any>;
+    /**
+     * {@link https://developer.github.com/v3/git/commits/#get-a-commit}
+     * @param {string} sha
+     * @return {Promise<Object>} response
+     */
+    commitForSha(sha: string): Promise<any>;
+    /**
+     * @see https://developer.github.com/v3/git/trees/
+     * @param {string} sha
+     * @return {Promise<Object[]>}
+     */
+    tree(sha: string): Promise<any[]>;
+    /**
+     * @see https://developer.github.com/v3/git/trees/
+     * @param {Object[]} updates
+     * @param {string} base base tree sha
+     * @returns {Promise<Object>} newly created tree
+     */
+    addTree(updates: any[], base: string): Promise<any>;
+    /**
+     * {@link https://developer.github.com/v3/repos/branches/#list-branches}
+     */
+    initializeBranches(): Promise<void>;
+    /**
+     * {@link https://docs.github.com/en/rest/reference/repos#list-repository-tags}
+     */
+    initializeTags(): Promise<void>;
+    /**
+     * {@link https://docs.github.com/de/rest/repos/repos?apiVersion=2022-11-28#update-a-repository}
+     */
+    update(): Promise<any>;
+    /**
+     * @param {string} ref
+     * @param {string} sha
+     */
+    _setRefId(ref: string, sha: string): void;
+    /**
+     * {@link https://docs.github.com/en/github-ae@latest/rest/git/refs#update-a-reference}
+     * @param {string} ref
+     * @param {string} sha
+     * @param {Object} options
+     * @returns {Promise<Object>}
+     *
+     */
+    setRefId(ref: string, sha: string, options: any): Promise<any>;
+    createBranch(name: any, from: any, options: any): Promise<import("repository-provider").Branch>;
+    deleteBranch(name: any): Promise<any>;
+    /**
+     * {@link https://developer.github.com/v3/pulls/#update-a-pull-request}
+     *
+     * @param {string} name
+     */
+    deletePullRequest(name: string): Promise<void>;
+    /**
+     * {@link https://developer.github.com/v3/repos/hooks/}
+     */
+    initializeHooks(): Promise<void>;
+    #private;
+}
+import { Repository } from "repository-provider";
+import { Commit } from "repository-provider";