@amplitude/ampli/lib/actions/base.d.ts

Amplitude CLI

/// <reference types="debug" />
import { Settings, User, UserId } from '../settings';
import { Branch, BranchOrg, BranchVersion, BranchWorkspace, MergedBranchVersion, PullRequest, Source } from '../graphql/types';
import { Runtime, Zone } from '../types';
export declare type CommonFlags = {
    debug: boolean;
    showProgress: boolean;
    userDir: string;
    projectDir: string;
    renameConfigs: boolean;
    zone: string;
};
export declare type CommonFlagsWithToken = {
    token: string | undefined;
} & CommonFlags;
export declare type ActionConfig = {
    id: string;
    print: (text: string) => void;
    println: (text?: string) => void;
    debug: debug.Debugger;
    error: (err: Error, exitCode: number) => never;
};
export default class BaseAction<Flags extends CommonFlags = CommonFlags, Args = {}> {
    protected flags: Flags;
    protected args: Args;
    protected config: ActionConfig;
    protected id: string;
    protected print: (text: string) => void;
    protected println: (text?: string) => void;
    protected debug: debug.Debugger;
    protected error: (err: Error, exitCode: number) => never;
    private spinner;
    constructor(flags: Flags, args: Args, config: ActionConfig);
    private static ampliGraphQLClient?;
    protected getAmpliGraphQLClient(zone?: Zone): Promise<{
        editEventStatuses(variables: import("../graphql/generated").Exact<{
            input: import("../graphql/generated").EditEventStatusInput | import("../graphql/generated").EditEventStatusInput[];
        }>): Promise<import("../graphql/generated").EditEventStatusesMutation>;
        editSource(variables: import("../graphql/generated").Exact<{
            input: import("../graphql/generated").EditSourceInput;
        }>): Promise<import("../graphql/generated").EditSourceMutation>;
        refreshPullRequest(variables: import("../graphql/generated").Exact<{
            input: import("../graphql/generated").RefreshPullRequestInput;
        }>): Promise<import("../graphql/generated").RefreshPullRequestMutation>;
        branchVersions(variables: import("../graphql/generated").Exact<{
            orgId: string;
            workspaceId: string;
            branchId: string;
            versionId?: string | null | undefined;
        }>): Promise<import("../graphql/generated").BranchVersionsQuery>;
        branches(variables: import("../graphql/generated").Exact<{
            orgId: string;
            workspaceId: string;
        }>): Promise<import("../graphql/generated").BranchesQuery>;
        mergedVersions(variables: import("../graphql/generated").Exact<{
            orgId: string;
            workspaceId: string;
            branchNames?: string | string[] | null | undefined;
            versionIds?: string | string[] | null | undefined;
        }>): Promise<import("../graphql/generated").MergedVersionsQuery>;
        orgs(variables?: import("../graphql/generated").Exact<{
            [key: string]: never;
        }> | undefined): Promise<import("../graphql/generated").OrgsQuery>;
        pullRequests(variables: import("../graphql/generated").Exact<{
            orgId: string;
            workspaceId: string;
            originBranchId: string;
        }>): Promise<import("../graphql/generated").PullRequestsQuery>;
        runtimes(variables?: import("../graphql/generated").Exact<{
            [key: string]: never;
        }> | undefined): Promise<import("../graphql/generated").RuntimesQuery>;
        sdk(variables: import("../graphql/generated").Exact<{
            orgId: string;
            workspaceId: string;
            branchId: string;
            sourceId: string;
            versionId: string;
            omitApiKeys?: boolean | null | undefined;
            packageName?: string | null | undefined;
        }>): Promise<import("../graphql/generated").SdkQuery>;
        sources(variables: import("../graphql/generated").Exact<{
            orgId: string;
            workspaceId: string;
            branchId: string;
            versionId: string;
            sourceId?: string | null | undefined;
        }>): Promise<import("../graphql/generated").SourcesQuery>;
        versionChangeCount(variables: import("../graphql/generated").Exact<{
            orgId: string;
            workspaceId: string;
            branchId: string;
            versionId: string;
        }>): Promise<import("../graphql/generated").VersionChangeCountQuery>;
        versionChanges(variables: import("../graphql/generated").Exact<{
            orgId: string;
            workspaceId: string;
            branchId: string;
            versionId: string;
            versionIdToDiffAgainst?: string | null | undefined;
            sourceId: string;
        }>): Promise<import("../graphql/generated").VersionChangesQuery>;
        versions(variables: import("../graphql/generated").Exact<{
            orgId: string;
            workspaceId: string;
            branchId: string;
            versionId: string;
        }>): Promise<import("../graphql/generated").VersionsQuery>;
    } & {
        zone: "us" | "eu";
    }>;
    protected authenticate(userId?: UserId): void;
    protected getUser(zone: Zone | undefined): Promise<User>;
    protected getSettings(): Settings;
    protected startSpinner(text: string): void;
    protected stopSpinner(success: boolean): void;
    protected getOrgWorkspaceBranches(orgId: string, workspaceId: string): Promise<{
        org: BranchOrg;
        workspace: BranchWorkspace;
        branches: Branch[];
        defaultBranch: Branch;
    }>;
    protected getBranchVersions(orgId: string, workspaceId: string, branchId: string): Promise<BranchVersion[]>;
    protected getBranchVersion(orgId: string, workspaceId: string, branchId: string, versionId: string): Promise<BranchVersion | undefined>;
    private getBranchVersionId;
    protected getVersionIdFromSettings(settings: Settings, branch: Branch | undefined): Promise<string | undefined>;
    protected getSources(orgId: string, workspaceId: string, defaultBranch: Branch, sourceBranch: Branch | undefined, sourceVersionId: string | undefined, sourceId: string | undefined): Promise<Source[]>;
    protected getMergedVersionByVersionId(orgId: string, workspaceId: string, versionId: string): Promise<MergedBranchVersion | undefined>;
    protected getMergedVersionByVersionSemVer(orgId: string, workspaceId: string, branchName: string, versionSemVer: string | undefined): Promise<MergedBranchVersion | undefined>;
    protected compareSettingsAndActualRuntimes(settings: Settings, settingsRuntime: Runtime | undefined, actualRuntime: Runtime): Runtime | undefined;
    static identifyUser(user: User): void;
    protected getPullRequest(orgId: string, workspaceId: string, originBranchId: string, defaultBranchId: string): Promise<PullRequest | undefined>;
    protected getBranchUrl(orgUrl: string, workspaceName: string, branchName: string): string;
    protected getRuntimes(): Promise<Runtime[]>;
    protected checkRuntimeIsSupported(runtime: Runtime): boolean;
}