repository-provider 35.0.4 → 35.1.0

package/types/branch.d.mts

@@ -0,0 +1,85 @@
+/**
+ * @typedef {Object} ContentEntry
+ * @property {string} name
+ *
+
+/**
+ * Abstract branch.
+ * @class Branch
+ * @see {@link Repository#_addBranch}
+ * @param {RepositoryOwner} owner
+ * @param {string} name
+ * @param {Object} options
+ *
+ * @property {Repository} repository
+ * @property {Provider} provider
+ * @property {string} name
+ */
+export class Branch extends Ref {
+    constructor(owner: any, name: any, options: any);
+    /**
+     * Delete the branch from the {@link Repository}.
+     * @see {@link Repository#deleteBranch}
+     * @return {Promise<any>}
+     */
+    delete(): Promise<any>;
+    /**
+     * Commit entries.
+     * @param {string} message commit message
+     * @param {ContentEntry[]} updates content to be commited
+     * @param {Object} options
+     * @return {Promise<CommitResult>}
+     */
+    commit(message: string, updates: ContentEntry[], options: any): Promise<CommitResult>;
+    /**
+     * Add commits into a pull request.
+     *
+     * @param {Commit|AsyncGenerator<Commit>} commits to be commited
+     * @param {Object} options
+     * @param {Branch|string} options.pullRequestBranch to commit into
+     * @param {boolean} [options.dry=false] do not create a branch and do not commit only create dummy PR
+     * @param {boolean} options.skipWithoutCommits do not create a PR if no commits are given
+     * @param {boolean} options.bodyFromCommitMessages generate body from commit messages
+     * @param {string} [options.body] body of the PR
+     * @return {Promise<PullRequest>}
+     */
+    commitIntoPullRequest(commits: Commit | AsyncGenerator<Commit>, options: {
+        pullRequestBranch: Branch | string;
+        dry?: boolean;
+        skipWithoutCommits: boolean;
+        bodyFromCommitMessages: boolean;
+        body?: string;
+    }): Promise<PullRequest>;
+    /**
+     * Remove entries form the branch.
+     * @param {AsyncIterable<ContentEntry>} entries
+     */
+    removeEntries(entries: AsyncIterable<ContentEntry>): Promise<void>;
+    /**
+     * Create a pull request.
+     * @param {Branch} toBranch
+     * @param {Object} [options]
+     * @return {Promise<PullRequest>}
+     */
+    createPullRequest(toBranch: Branch, options?: any): Promise<PullRequest>;
+    _addPullRequest(pullRequest: any): Promise<any>;
+    deletePullRequest(name: any): Promise<any>;
+    /**
+     * Create a new {@link Branch} by cloning a given source branch.
+     * Simply calls Repository.createBranch() with the receiver as source branch
+     * @param {string} name the new branch
+     * @param {Object} [options] passed through
+     * @return {Promise<Branch>} newly created branch (or already present old one with the same name)
+     */
+    createBranch(name: string, options?: any): Promise<Branch>;
+}
+export type ContentEntry = {
+    /**
+     * /**
+     * Abstract branch.
+     */
+    name: string;
+};
+import { Ref } from "./ref.mjs";
+import { Commit } from "./commit.mjs";
+import { PullRequest } from "./pull-request.mjs";

package/types/commit.d.mts

@@ -0,0 +1,20 @@
+/**
+ * @typedef {Object} CommitResult
+ * @property {string} ref
+ */
+export class User {
+}
+/**
+ * @property {Repository} repository
+ * @property {string} message
+ * @property {string} sha
+ * @property {User} author
+ * @property {User} committer
+ */
+export class Commit {
+    constructor(repository: any);
+    repository: any;
+}
+export type CommitResult = {
+    ref: string;
+};

package/types/hook.d.mts

@@ -0,0 +1,92 @@
+/**
+ * Repository hook.
+ */
+export class Hook extends OwnedObject {
+    static defaultEvents: Set<string>;
+    static get attributes(): {
+        active: {
+            type: string;
+            default: boolean;
+            writable: boolean;
+            mandatory: boolean;
+            private: boolean;
+            isKey: boolean;
+            additionalAttributes: any[];
+            env: any[];
+        };
+        secret: {
+            private: boolean;
+            writable: boolean;
+            type: string;
+            mandatory: boolean;
+            isKey: boolean;
+            additionalAttributes: any[];
+            env: any[];
+        };
+        url: {
+            description: string;
+            writable: boolean;
+            type: string;
+            mandatory: boolean;
+            private: boolean;
+            isKey: boolean;
+            additionalAttributes: any[];
+            env: any[];
+        };
+        content_type: {
+            default: string;
+            writable: boolean;
+            type: string;
+            mandatory: boolean;
+            private: boolean;
+            isKey: boolean;
+            additionalAttributes: any[];
+            env: any[];
+        };
+        insecure_ssl: {
+            writable: boolean;
+            default: boolean;
+            type: string;
+            mandatory: boolean;
+            private: boolean;
+            isKey: boolean;
+            additionalAttributes: any[];
+            env: any[];
+        };
+        events: {
+            type: string;
+            default: Set<string>;
+        };
+        id: {
+            isKey: boolean;
+            description: string;
+            type: string;
+            writable: boolean;
+            mandatory: boolean;
+            private: boolean;
+            additionalAttributes: any[];
+            env: any[];
+        };
+        name: {
+            isKey: boolean;
+            type: string;
+            writable: boolean;
+            mandatory: boolean;
+            private: boolean;
+            additionalAttributes: any[];
+            env: any[];
+        };
+        description: {
+            description: string;
+            writable: boolean;
+            type: string;
+            mandatory: boolean;
+            private: boolean;
+            isKey: boolean;
+            additionalAttributes: any[];
+            env: any[];
+        };
+    };
+    static get delteteMethodName(): string;
+}
+import { OwnedObject } from "./owned-object.mjs";

package/types/index.d.mts

@@ -0,0 +1,23 @@
+export * from "./base-object.mjs";
+export * from "./named-object.mjs";
+export * from "./owned-object.mjs";
+export * from "./repository-owner.mjs";
+export * from "./base-provider.mjs";
+export * from "./single-group-provider.mjs";
+export * from "./multi-group-provider.mjs";
+export * from "./repository-group.mjs";
+export * from "./repository.mjs";
+export * from "./ref.mjs";
+export * from "./commit.mjs";
+export * from "./branch.mjs";
+export * from "./tag.mjs";
+export * from "./project.mjs";
+export * from "./issue.mjs";
+export * from "./pull-request.mjs";
+export * from "./hook.mjs";
+export * from "./milestone.mjs";
+export * from "./review.mjs";
+export * from "./application.mjs";
+export * from "./attribute-extras.mjs";
+export * from "./util.mjs";
+export * from "./attributes.mjs";

package/types/issue.d.mts

@@ -0,0 +1,10 @@
+/**
+ *
+ */
+export class Issue extends OwnedObject {
+    labels(): AsyncGenerator<never, void, unknown>;
+    assignees(): AsyncGenerator<never, void, unknown>;
+    assignee(): Promise<void>;
+    milestone(): Promise<void>;
+}
+import { OwnedObject } from "./owned-object.mjs";

package/types/milestone.d.mts

@@ -0,0 +1,46 @@
+/**
+ */
+export class Milestone extends OwnedObject {
+    static get attributes(): {
+        state: {
+            writable: boolean;
+            type: string;
+            mandatory: boolean;
+            private: boolean;
+            isKey: boolean;
+            additionalAttributes: any[];
+            env: any[];
+        };
+        id: {
+            isKey: boolean;
+            description: string;
+            type: string;
+            writable: boolean;
+            mandatory: boolean;
+            private: boolean;
+            additionalAttributes: any[];
+            env: any[];
+        };
+        name: {
+            isKey: boolean;
+            type: string;
+            writable: boolean;
+            mandatory: boolean;
+            private: boolean;
+            additionalAttributes: any[];
+            env: any[];
+        };
+        description: {
+            description: string;
+            writable: boolean;
+            type: string;
+            mandatory: boolean;
+            private: boolean;
+            isKey: boolean;
+            additionalAttributes: any[];
+            env: any[];
+        };
+    };
+    issues(): AsyncGenerator<never, void, unknown>;
+}
+import { OwnedObject } from "./owned-object.mjs";

package/types/multi-group-provider.d.mts

@@ -0,0 +1,51 @@
+/**
+ * Provider supporting serveral repository groups.
+ *
+ */
+export class MultiGroupProvider extends BaseProvider {
+    /**
+     * Lookup a repository in the provider and all of its repository groups.
+     * @param {string} name of the repository
+     * @return {Promise<Repository|undefined>}
+     */
+    repository(name: string): Promise<Repository | undefined>;
+    /**
+     * Lookup a branch.
+     * @param {string} name of the branch
+     * @return {Promise<Branch|undefined>}
+     */
+    branch(name: string): Promise<Branch | undefined>;
+    /**
+     * Lookup a repository group.
+     * @param {string} name of the group
+     * @return {Promise<RepositoryGroup|undefined>}
+     */
+    repositoryGroup(name: string): Promise<RepositoryGroup | undefined>;
+    /**
+     * List groups.
+     * @param {string[]|string} [patterns]
+     * @return {AsyncIterable<RepositoryGroup>} all matching repositories groups of the provider
+     */
+    repositoryGroups(patterns?: string[] | string): AsyncIterable<RepositoryGroup>;
+    /**
+     * Create a new repository group.
+     * If there is already a group for the given name it will be returend instead
+     * @param {string} name of the group
+     * @param {Object} [options]
+     * @return {Promise<RepositoryGroup>}
+     */
+    createRepositoryGroup(name: string, options?: any): Promise<RepositoryGroup>;
+    /**
+     * Add a new repository group (not provider specific actions are executed).
+     * @param {string} name of the group
+     * @param {Object} [options]
+     * @return {RepositoryGroup}
+     */
+    addRepositoryGroup(name: string, options?: any): RepositoryGroup;
+    _addRepositoryGroup(repositoryGroup: any): void;
+    #private;
+}
+import { BaseProvider } from "./base-provider.mjs";
+import { Repository } from "./repository.mjs";
+import { Branch } from "./branch.mjs";
+import { RepositoryGroup } from "./repository-group.mjs";

package/types/named-object.d.mts

@@ -0,0 +1,71 @@
+/**
+ * Object with a name.
+ * @param {string} name
+ * @param {Object} [options]
+ * @param {Object} [additionalProperties]
+ *
+ * @property {string} name
+ */
+export class NamedObject extends BaseObject {
+    static get attributes(): {
+        id: {
+            isKey: boolean;
+            description: string;
+            type: string;
+            writable: boolean;
+            mandatory: boolean;
+            private: boolean;
+            additionalAttributes: any[];
+            env: any[];
+        };
+        name: {
+            isKey: boolean;
+            type: string;
+            writable: boolean;
+            mandatory: boolean;
+            private: boolean;
+            additionalAttributes: any[];
+            env: any[];
+        };
+        description: {
+            description: string;
+            writable: boolean;
+            type: string;
+            mandatory: boolean;
+            private: boolean;
+            isKey: boolean;
+            additionalAttributes: any[];
+            env: any[];
+        };
+    };
+    constructor(name: any, options: any, additionalProperties: any);
+    set name(name: any);
+    get name(): any;
+    /**
+     * Beautified name use for human displaying only.
+     * @return {string} human readable name
+     */
+    get displayName(): string;
+    /**
+     * Name with default parts removed
+     * @return {string}
+     */
+    get condensedName(): string;
+    /**
+     * Complete name in the hierachy.
+     * @return {string}
+     */
+    get fullCondensedName(): string;
+    /**
+     * Check for equality.
+     * @param {NamedObject} other
+     * @return {boolean} true if names are equal and have the same provider
+     */
+    equals(other: NamedObject): boolean;
+    /**
+     * Provided name and all defined attributes.
+     */
+    toJSON(): any;
+    #private;
+}
+import { BaseObject } from "./base-object.mjs";

package/types/owned-object.d.mts

@@ -0,0 +1,132 @@
+/**
+ * Named Object registering itself in the owner.
+ */
+export class OwnedObject extends NamedObject {
+    /**
+     * Method name to be called to register one instance in the owner.
+     * sample: Application => _addApplication
+     * @return {string}
+     */
+    static get addMethodName(): string;
+    /**
+     * Method name to be called to unregister one instance in the owner.
+     * sample: Application => _deleteApplication
+     * @return {string}
+     */
+    static get deleteMethodName(): string;
+    constructor(owner: any, name: any, options: any, additionalProperties: any);
+    owner: any;
+    /**
+     * Removes the receiver from the owner.
+     */
+    delete(): void;
+    /**
+     * Check for equality.
+     * @param {OwnedObject} other
+     * @return {boolean} true if receiver and owner are equal
+     */
+    equals(other: OwnedObject): boolean;
+    /**
+     * Url of home page.
+     * @see {@link Repository#homePageURL}
+     * @return {string} as provided from the owner
+     */
+    get homePageURL(): string;
+    /**
+     * Url of issue tracking system.
+     * @see {@link Repository#issuesURL}
+     * @return {string} as provided from the repository
+     */
+    get issuesURL(): string;
+    /**
+     * Forwarded from the owner.
+     * @return {boolean}
+     */
+    get isLocked(): boolean;
+    /**
+     * Forwarded from the owner.
+     * @return {boolean}
+     */
+    get isArchived(): boolean;
+    /**
+     * Forwarded from the owner.
+     * @return {boolean}
+     */
+    get isDisabled(): boolean;
+    /**
+     * API as given by the owner.
+     * @return {string} url
+     */
+    get api(): string;
+    /**
+     * API as given by the owner.
+     * @return {string} url
+     */
+    get slug(): string;
+    /**
+     * URL as given by the owner.
+     * @return {string} url
+     */
+    get url(): string;
+    /**
+     * The provider we live in.
+     * @return {BaseProvider}
+     */
+    get provider(): BaseProvider;
+    /**
+     * Forwarded to the owner.
+     * @param  {...any} args
+     */
+    trace(...args: any[]): any;
+    /**
+     * Forwarded to the owner.
+     * @param  {...any} args
+     */
+    info(...args: any[]): any;
+    /**
+     * Forwarded to the owner.
+     * @param  {...any} args
+     */
+    warn(...args: any[]): any;
+    /**
+     * Forwarded to the owner.
+     * @param  {...any} args
+     */
+    error(...args: any[]): any;
+    /**
+     * Forwarded to the owner.
+     * @param  {...any} args
+     */
+    debug(...args: any[]): any;
+    /**
+     * By default we use the owners implementation.
+     * @return {Repository} as defined in the owner
+     */
+    get repositoryClass(): Repository;
+    /**
+     * By default we use the owners implementation.
+     * @return {PullRequest} as defined in the owner
+     */
+    get pullRequestClass(): PullRequest;
+    /**
+     * By default we use the owners implementation.
+     * @return {Branch} as defined in the owner
+     */
+    get branchClass(): Branch;
+    /**
+     * By default we use the owners implementation.
+     * @return {Tag} as defined in the owner
+     */
+    get tagClass(): Tag;
+    /**
+     * By default we use the owners implementation.
+     * @return {ContentEntry} as defined in the owner
+     */
+    get entryClass(): ContentEntry;
+    /**
+     * By default we use the owners implementation.
+     * @return {Hook} as defined in the owner
+     */
+    get hookClass(): Hook;
+}
+import { NamedObject } from "./named-object.mjs";

package/types/project.d.mts

@@ -0,0 +1,6 @@
+/**
+ *
+ */
+export class Project extends OwnedObject {
+}
+import { OwnedObject } from "./owned-object.mjs";