octokit-plugin-create-pull-request/dist-types/types.d.ts

Octokit plugin to create a pull request with multiple file changes

import type { Octokit } from "@octokit/core";
import type { Endpoints } from "@octokit/types";
export type TreeParameter = Endpoints["POST /repos/{owner}/{repo}/git/trees"]["parameters"]["tree"];
export type Options = {
    owner: string;
    repo: string;
    title: string;
    body: string;
    head: string;
    changes: Changes | Changes[];
    labels?: String[];
    base?: string;
    createWhenEmpty?: boolean;
    draft?: boolean;
    forceFork?: boolean;
    update?: boolean;
};
export type Changes = {
    files?: {
        [path: string]: string | File | UpdateFunction | null | Symbol;
    };
    emptyCommit?: boolean | string;
    commit: string;
    committer?: Committer;
    author?: Author | undefined;
    signature?: SignatureFunction | undefined;
};
export type File = {
    content: string;
    encoding: "utf-8" | "base64";
    mode?: string;
};
export type SignatureFunction = (commitPayload: CommitPayload) => string;
export type UpdateFunctionFile = {
    exists: true;
    size: number;
    encoding: "base64";
    content: string;
} | {
    exists: false;
    size: never;
    encoding: never;
    content: never;
};
export type UpdateFunction = (file: UpdateFunctionFile) => string | File | null | Symbol | Promise<string | File | null | Symbol>;
export type State = {
    octokit: Octokit;
    owner: string;
    repo: string;
    ownerOrFork?: string;
    latestCommitSha?: string;
    latestCommitTreeSha?: string;
    treeSha?: string;
};
export type Committer = {
    name?: string;
    email?: string;
    date?: string;
};
export type Author = {
    name: string;
    email: string;
    date?: string;
};
export type CommitPayload = {
    message: string;
    tree: string;
    parents: string[];
    author?: Author;
    committer?: Committer;
};