spiegel-keyman/developer/docs/api/etc/kmc-copy.api.md

API Report File for "@keymanapp/kmc-copy"

Do not edit this file. It is a report generated by API Extractor.

import { CompilerAsyncCallbacks } from '@keymanapp/developer-utils';
import { CompilerBaseOptions } from '@keymanapp/developer-utils';
import { CompilerCallbacks } from '@keymanapp/developer-utils';
import { CompilerEvent } from '@keymanapp/developer-utils';
import { CompilerFileSystemAsyncCallbacks } from '@keymanapp/developer-utils';
import { CompilerNetAsyncCallbacks } from '@keymanapp/developer-utils';
import { CompilerPathCallbacks } from '@keymanapp/developer-utils';
import { GitHubUrls } from '@keymanapp/developer-utils';
import { KeymanCompiler } from '@keymanapp/developer-utils';
import { KeymanCompilerArtifact } from '@keymanapp/developer-utils';
import { KeymanCompilerArtifacts } from '@keymanapp/developer-utils';
import { KeymanCompilerResult } from '@keymanapp/developer-utils';

// Warning: (ae-internal-missing-underscore) The name "CopierMessages" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal (undocumented)
export class CopierMessages {
    // (undocumented)
    static ERROR_CannotCreateFolder: number;
    // (undocumented)
    static Error_CannotCreateFolder: (o: {
        folderName: string;
        e: any;
    }) => CompilerEvent;
    // (undocumented)
    static ERROR_CannotDownloadFolderFromGitHub: number;
    // (undocumented)
    static Error_CannotDownloadFolderFromGitHub: (o: {
        ref: string;
        message?: string;
        cause?: string;
    }) => CompilerEvent;
    // (undocumented)
    static ERROR_CannotDownloadRepoFromGitHub: number;
    // (undocumented)
    static Error_CannotDownloadRepoFromGitHub: (o: {
        ref: string;
        message?: string;
        cause?: string;
    }) => CompilerEvent;
    // (undocumented)
    static ERROR_CannotFindInputProject: number;
    // (undocumented)
    static Error_CannotFindInputProject: (o: {
        project: string;
    }) => CompilerEvent;
    // (undocumented)
    static ERROR_CannotWriteOutputFile: number;
    // (undocumented)
    static Error_CannotWriteOutputFile: (o: {
        filename: string;
        e: any;
    }) => CompilerEvent;
    // (undocumented)
    static ERROR_CloudDoesNotHaveSource: number;
    // (undocumented)
    static Error_CloudDoesNotHaveSource: (o: {
        id: string;
    }) => CompilerEvent;
    // (undocumented)
    static ERROR_CouldNotFindDefaultBranchOnGitHub: number;
    // (undocumented)
    static Error_CouldNotFindDefaultBranchOnGitHub: (o: {
        ref: string;
    }) => CompilerEvent;
    // (undocumented)
    static ERROR_CouldNotRetrieveFromCloud: number;
    // (undocumented)
    static Error_CouldNotRetrieveFromCloud: (o: {
        id: string;
        message?: string;
        cause?: string;
    }) => CompilerEvent;
    // (undocumented)
    static ERROR_FolderDownloadedFromGitHubIsNotAValidFolder: number;
    // (undocumented)
    static Error_FolderDownloadedFromGitHubIsNotAValidFolder: (o: {
        ref: string;
    }) => CompilerEvent;
    // (undocumented)
    static ERROR_InvalidCloudKeyboardId: number;
    // (undocumented)
    static Error_InvalidCloudKeyboardId: (o: {
        id: string;
    }) => CompilerEvent;
    // (undocumented)
    static ERROR_InvalidKeyboardId: number;
    // (undocumented)
    static Error_InvalidKeyboardId: (o: {
        id: string;
    }) => CompilerEvent;
    // (undocumented)
    static ERROR_InvalidLexicalModelId: number;
    // (undocumented)
    static Error_InvalidLexicalModelId: (o: {
        id: string;
    }) => CompilerEvent;
    // (undocumented)
    static ERROR_KeymanCloudReturnedInvalidData: number;
    // (undocumented)
    static Error_KeymanCloudReturnedInvalidData: (o: {
        id: string;
    }) => CompilerEvent;
    // (undocumented)
    static ERROR_OutputPathAlreadyExists: number;
    // (undocumented)
    static Error_OutputPathAlreadyExists: (o: {
        outPath: string;
    }) => CompilerEvent;
    // (undocumented)
    static ERROR_PackageFileCouldNotBeRead: number;
    // (undocumented)
    static Error_PackageFileCouldNotBeRead: (o: {
        filename: string;
    }) => CompilerEvent;
    // (undocumented)
    static FATAL_UnexpectedException: number;
    // (undocumented)
    static Fatal_UnexpectedException: (o: {
        e: any;
    }) => CompilerEvent;
    // (undocumented)
    static INFO_CannotDownloadBinaryFileFromGitHub: number;
    // (undocumented)
    static Info_CannotDownloadBinaryFileFromGitHub: (o: {
        ref: string;
        message?: string;
        cause?: string;
    }) => CompilerEvent;
    // (undocumented)
    static INFO_DryRun: number;
    // (undocumented)
    static Info_DryRun: (o: {
        outPath: string;
    }) => CompilerEvent;
    // (undocumented)
    static INFO_DryRunCreatingFolder: number;
    // (undocumented)
    static Info_DryRunCreatingFolder: (o: {
        path: string;
    }) => CompilerEvent;
    // (undocumented)
    static INFO_DryRunWritingFile: number;
    // (undocumented)
    static Info_DryRunWritingFile: (o: {
        filename: string;
    }) => CompilerEvent;
    // (undocumented)
    static VERBOSE_CopyingFile: number;
    // (undocumented)
    static Verbose_CopyingFile: (o: {
        from: string;
        to: string;
    }) => CompilerEvent;
    // (undocumented)
    static VERBOSE_DownloadingFile: number;
    // (undocumented)
    static Verbose_DownloadingFile: (o: {
        filename: string;
        url: string;
    }) => CompilerEvent;
    // (undocumented)
    static VERBOSE_DownloadingFolder: number;
    // (undocumented)
    static Verbose_DownloadingFolder: (o: {
        path: string;
        url: string;
    }) => CompilerEvent;
    // (undocumented)
    static WARN_CannotDownloadFileFromGitHub: number;
    // (undocumented)
    static Warn_CannotDownloadFileFromGitHub: (o: {
        ref: string;
        message?: string;
        cause?: string;
    }) => CompilerEvent;
    // (undocumented)
    static WARN_FilenameCollides: number;
    // (undocumented)
    static Warn_FilenameCollides: (o: {
        filename: string;
    }) => CompilerEvent;
    // (undocumented)
    static WARN_FileNotFound: number;
    // (undocumented)
    static Warn_FileNotFound: (o: {
        filename: string;
        newFilename: string;
    }) => CompilerEvent;
    // (undocumented)
    static WARN_ModelIdDoesNotFollowLexicalModelConventions: number;
    // (undocumented)
    static Warn_ModelIdDoesNotFollowLexicalModelConventions: (o: {
        id: string;
    }) => CompilerEvent;
    // (undocumented)
    static WARN_NoWordlistsFound: number;
    // (undocumented)
    static Warn_NoWordlistsFound: (o: {
        filename: string;
    }) => CompilerEvent;
}

// @public
export interface CopierOptions extends CompilerBaseOptions {
    dryRun: boolean;
    outPath: string;
    relocateExternalFiles?: boolean;
}

// @public
export class KeymanProjectCopier implements KeymanCompiler {
    // Warning: (ae-forgotten-export) The symbol "CopierAsyncCallbacks" needs to be exported by the entry point main.d.ts
    //
    // (undocumented)
    asyncCallbacks: CopierAsyncCallbacks;
    // (undocumented)
    callbacks: CompilerCallbacks;
    // Warning: (ae-forgotten-export) The symbol "KeymanCloudSource" needs to be exported by the entry point main.d.ts
    //
    // (undocumented)
    cloudSource: KeymanCloudSource;
    // Warning: (ae-forgotten-export) The symbol "GitHubRef" needs to be exported by the entry point main.d.ts
    //
    // (undocumented)
    githubRef: GitHubRef;
    // (undocumented)
    init(callbacks: CompilerCallbacks, options: CopierOptions): Promise<boolean>;
    // (undocumented)
    isLocalOrigin(): boolean;
    // (undocumented)
    options: CopierOptions;
    // (undocumented)
    outPath: string;
    // (undocumented)
    outputId: string;
    // Warning: (ae-forgotten-export) The symbol "CopierResult" needs to be exported by the entry point main.d.ts
    run(source: string): Promise<CopierResult>;
    // (undocumented)
    sourceId: string;
    // @internal (undocumented)
    unitTestEndPoints: {
        getGithubSourceProject: (source: string) => Promise<GitHubRef>;
        getCloudSourceProject: (source: string) => Promise<GitHubRef>;
    };
    // Warning: (ae-forgotten-export) The symbol "CopierArtifacts" needs to be exported by the entry point main.d.ts
    write(artifacts: CopierArtifacts): Promise<boolean>;
}

// (No @packageDocumentation comment for this package)