@qiwi/semantic-release-gh-pages-plugin/typings/index.d.ts

gh-pages publishing plugin for semantic-release

declare module "@qiwi/semantic-release-gh-pages-plugin/target/es6/defaults.js" {
    /** @module semantic-release-gh-pages-plugin */
    export const PLUGIN_PATH = "@qiwi/semantic-release-gh-pages-plugin";
    export const DEFAULT_BRANCH = "gh-pages";
    export const DEFAULT_SRC = "docs";
    export const DEFAULT_DST = ".";
    export const DEFAULT_MSG = "docs updated <%= nextRelease.gitTag %>";
    export const DEFAULT_ENTERPRISE = false;
    export const DEFAULT_PULL_TAGS_BRANCH = "master";
    export const DEFAULT_PATTERN = "**/*";
}
declare module "@qiwi/semantic-release-gh-pages-plugin/target/es6/interface.js" {
    /** @module semantic-release-gh-pages-plugin */
    import { BranchSpec, Context } from 'semantic-release';
    export interface ILogger {
        log: (message: string, ...vars: any[]) => void;
        error: (message: string, ...vars: any[]) => void;
    }
    export type TAnyMap = {
        [key: string]: any;
    };
    export type TStringMap = {
        [key: string]: string;
    };
    export type TContext = Context & {
        env: TStringMap;
        branch?: Exclude<BranchSpec, string>;
        cwd: string;
        options: TAnyMap & {
            publish?: Array<any>;
            verifyConditions?: Array<any>;
        };
    };
    export interface IGhpagesPluginConfig {
        src: string;
        dst: string;
        ciBranch: string;
        docsBranch: string;
        pullTagsBranch?: string;
        msg: string;
        repo: string;
        token?: string;
        enterprise?: boolean;
        dotfiles?: boolean;
        add?: boolean;
        pattern?: string;
    }
    export interface IPushOpts extends IGhpagesPluginConfig {
        message: string;
        logger: ILogger;
        env: TAnyMap;
        cwd: string;
    }
}
declare module "@qiwi/semantic-release-gh-pages-plugin/target/es6/util.js" {
    import { ICallable } from '@qiwi/substrate-types';
    export const catchToSmth: (fn: ICallable, smth?: any) => (...args: any[]) => any;
    export const anyDefined: (...args: any[]) => any;
    export const isDirectory: (path: string) => any;
}
declare module "@qiwi/semantic-release-gh-pages-plugin/target/es6/config.js" {
    import { IGhpagesPluginConfig, TAnyMap, TContext } from "@qiwi/semantic-release-gh-pages-plugin/target/es6/interface.js";
    export { DEFAULT_BRANCH, DEFAULT_SRC, DEFAULT_MSG, DEFAULT_DST, DEFAULT_ENTERPRISE, PLUGIN_PATH, DEFAULT_PULL_TAGS_BRANCH, DEFAULT_PATTERN, } from "@qiwi/semantic-release-gh-pages-plugin/target/es6/defaults.js";
    export const GITIO_REPO_PATTERN: RegExp;
    /**
     * @private
     */
    export const extractRepoName: (repoUrl: string) => string;
    /**
     * @private
     */
    export const extractRepoDomain: (repoUrl: string) => string;
    /**
     * @private
     */
    export const extractRepoToken: (repoUrl: string) => string;
    /**
     * @private
     */
    export const getRepoUrl: (pluginConfig: TAnyMap, context: TContext, enterprise: boolean) => Promise<string>;
    /**
     * @private
     */
    export const getUrlFromPackage: () => string;
    /**
     * @private
     */
    export const getToken: (env: TAnyMap, repoUrl: string) => string | undefined;
    /**
     * @private
     */
    export const reassembleRepoUrl: (redirectedUrl: string, context: TContext) => string | undefined;
    /**
     * @private
     */
    export const resolveConfig: (pluginConfig: TAnyMap, context: TContext, path?: string, step?: string) => Promise<IGhpagesPluginConfig>;
    /**
     * @private
     */
    export const resolveOptions: (pluginConfig: TAnyMap, context: TContext, path?: string, step?: string) => TAnyMap;
}
declare module "@qiwi/semantic-release-gh-pages-plugin/target/es6/ghpages.js" {
    import { IPushOpts } from "@qiwi/semantic-release-gh-pages-plugin/target/es6/interface.js";
    /**
     * @private
     */
    export const OK: {
        status: string;
    };
    /**
     * @private
     */
    export const pullTags: (opts: IPushOpts) => Promise<any>;
    /**
     * @private
     */
    export const pushPages: (opts: IPushOpts) => Promise<unknown>;
    /**
     * @private
     */
    export const _publish: (opts: IPushOpts) => Promise<unknown>;
    /**
     * @private
     */
    export const publish: (opts: IPushOpts) => Promise<unknown>;
}
declare module "@qiwi/semantic-release-gh-pages-plugin/target/es6/tpl.js" {
    import { ILogger, TAnyMap } from "@qiwi/semantic-release-gh-pages-plugin/target/es6/interface.js";
    /**
     * @private
     */
    export const render: (template: string, context: TAnyMap, logger: ILogger) => string;
}
declare module "@qiwi/semantic-release-gh-pages-plugin/target/es6/index.js" {
    import { TContext } from "@qiwi/semantic-release-gh-pages-plugin/target/es6/interface.js";
    export * from "@qiwi/semantic-release-gh-pages-plugin/target/es6/defaults.js";
    export const verifyConditions: (pluginConfig: any, context: TContext) => Promise<void>;
    export const publish: (pluginConfig: any, context: TContext) => Promise<unknown>;
    const _default: {
        verifyConditions: (pluginConfig: any, context: TContext) => Promise<void>;
        publish: (pluginConfig: any, context: TContext) => Promise<unknown>;
    };
    export default _default;
}
declare module "@qiwi/semantic-release-gh-pages-plugin" {
    export * from "@qiwi/semantic-release-gh-pages-plugin/target/es6/index.js"
}

declare module "@qiwi/semantic-release-gh-pages-plugin/target/es5/defaults.js" {
    /** @module semantic-release-gh-pages-plugin */
    export const PLUGIN_PATH = "@qiwi/semantic-release-gh-pages-plugin";
    export const DEFAULT_BRANCH = "gh-pages";
    export const DEFAULT_SRC = "docs";
    export const DEFAULT_DST = ".";
    export const DEFAULT_MSG = "docs updated <%= nextRelease.gitTag %>";
    export const DEFAULT_ENTERPRISE = false;
    export const DEFAULT_PULL_TAGS_BRANCH = "master";
    export const DEFAULT_PATTERN = "**/*";
}
declare module "@qiwi/semantic-release-gh-pages-plugin/target/es5/interface.js" {
    /** @module semantic-release-gh-pages-plugin */
    import { BranchSpec, Context } from 'semantic-release';
    export interface ILogger {
        log: (message: string, ...vars: any[]) => void;
        error: (message: string, ...vars: any[]) => void;
    }
    export type TAnyMap = {
        [key: string]: any;
    };
    export type TStringMap = {
        [key: string]: string;
    };
    export type TContext = Context & {
        env: TStringMap;
        branch?: Exclude<BranchSpec, string>;
        cwd: string;
        options: TAnyMap & {
            publish?: Array<any>;
            verifyConditions?: Array<any>;
        };
    };
    export interface IGhpagesPluginConfig {
        src: string;
        dst: string;
        ciBranch: string;
        docsBranch: string;
        pullTagsBranch?: string;
        msg: string;
        repo: string;
        token?: string;
        enterprise?: boolean;
        dotfiles?: boolean;
        add?: boolean;
        pattern?: string;
    }
    export interface IPushOpts extends IGhpagesPluginConfig {
        message: string;
        logger: ILogger;
        env: TAnyMap;
        cwd: string;
    }
}
declare module "@qiwi/semantic-release-gh-pages-plugin/target/es5/util.js" {
    import { ICallable } from '@qiwi/substrate-types';
    export const catchToSmth: (fn: ICallable, smth?: any) => (...args: any[]) => any;
    export const anyDefined: (...args: any[]) => any;
    export const isDirectory: (path: string) => any;
}
declare module "@qiwi/semantic-release-gh-pages-plugin/target/es5/config.js" {
    import { IGhpagesPluginConfig, TAnyMap, TContext } from "@qiwi/semantic-release-gh-pages-plugin/target/es5/interface.js";
    export { DEFAULT_BRANCH, DEFAULT_SRC, DEFAULT_MSG, DEFAULT_DST, DEFAULT_ENTERPRISE, PLUGIN_PATH, DEFAULT_PULL_TAGS_BRANCH, DEFAULT_PATTERN, } from "@qiwi/semantic-release-gh-pages-plugin/target/es5/defaults.js";
    export const GITIO_REPO_PATTERN: RegExp;
    /**
     * @private
     */
    export const extractRepoName: (repoUrl: string) => string;
    /**
     * @private
     */
    export const extractRepoDomain: (repoUrl: string) => string;
    /**
     * @private
     */
    export const extractRepoToken: (repoUrl: string) => string;
    /**
     * @private
     */
    export const getRepoUrl: (pluginConfig: TAnyMap, context: TContext, enterprise: boolean) => Promise<string>;
    /**
     * @private
     */
    export const getUrlFromPackage: () => string;
    /**
     * @private
     */
    export const getToken: (env: TAnyMap, repoUrl: string) => string | undefined;
    /**
     * @private
     */
    export const reassembleRepoUrl: (redirectedUrl: string, context: TContext) => string | undefined;
    /**
     * @private
     */
    export const resolveConfig: (pluginConfig: TAnyMap, context: TContext, path?: string, step?: string) => Promise<IGhpagesPluginConfig>;
    /**
     * @private
     */
    export const resolveOptions: (pluginConfig: TAnyMap, context: TContext, path?: string, step?: string) => TAnyMap;
}
declare module "@qiwi/semantic-release-gh-pages-plugin/target/es5/ghpages.js" {
    import { IPushOpts } from "@qiwi/semantic-release-gh-pages-plugin/target/es5/interface.js";
    /**
     * @private
     */
    export const OK: {
        status: string;
    };
    /**
     * @private
     */
    export const pullTags: (opts: IPushOpts) => Promise<any>;
    /**
     * @private
     */
    export const pushPages: (opts: IPushOpts) => Promise<unknown>;
    /**
     * @private
     */
    export const _publish: (opts: IPushOpts) => Promise<unknown>;
    /**
     * @private
     */
    export const publish: (opts: IPushOpts) => Promise<unknown>;
}
declare module "@qiwi/semantic-release-gh-pages-plugin/target/es5/tpl.js" {
    import { ILogger, TAnyMap } from "@qiwi/semantic-release-gh-pages-plugin/target/es5/interface.js";
    /**
     * @private
     */
    export const render: (template: string, context: TAnyMap, logger: ILogger) => string;
}
declare module "@qiwi/semantic-release-gh-pages-plugin/target/es5/index.js" {
    import { TContext } from "@qiwi/semantic-release-gh-pages-plugin/target/es5/interface.js";
    export * from "@qiwi/semantic-release-gh-pages-plugin/target/es5/defaults.js";
    export const verifyConditions: (pluginConfig: any, context: TContext) => Promise<void>;
    export const publish: (pluginConfig: any, context: TContext) => Promise<unknown>;
    const _default: {
        verifyConditions: (pluginConfig: any, context: TContext) => Promise<void>;
        publish: (pluginConfig: any, context: TContext) => Promise<unknown>;
    };
    export default _default;
}