@keymanapp/kmc-copy 18.0.138-alpha

package/build/src/KeymanProjectCopier.d.ts

@@ -0,0 +1,145 @@
+import { CompilerCallbacks, CompilerLogLevel, KeymanCompiler, KeymanCompilerArtifact, KeymanCompilerArtifacts, KeymanCompilerResult } from "@keymanapp/developer-utils";
+import { CopierAsyncCallbacks } from "./copier-async-callbacks.js";
+import { GitHubRef, KeymanCloudSource } from "./cloud.js";
+/**
+ * @public
+ * Options for the Keyman Developer project copier
+ */
+export interface CopierOptions {
+    /**
+     * Reporting level to console, used by NodeCompilerCallbacks (not used in
+     * compiler modules; all messages are still reported to the internal log)
+     */
+    logLevel?: CompilerLogLevel;
+    /**
+     * output path where project folder will be created
+     */
+    outPath: string;
+    /**
+     * dryRun: show what would happen
+     */
+    dryRun: boolean;
+}
+/**
+ * @public
+ * Internal in-memory build artifacts from a successful copy
+ */
+export interface CopierArtifacts extends KeymanCompilerArtifacts {
+    /**
+     * The target path for the copy, equal to the normalized output path.
+     * This folder must not exist before `write()`. This pattern is
+     * used to avoid name collisions with other artifacts
+     */
+    ['kmc-copy:outputPath']: KeymanCompilerArtifact;
+    /**
+     * Copied project files to be written to disk
+    */
+    [name: string]: KeymanCompilerArtifact;
+}
+/**
+ * @public
+ * Result of a successful copy
+ */
+export interface CopierResult extends KeymanCompilerResult {
+    /**
+     * Internal in-memory build artifacts from a successful compilation. Caller
+     * can write these to disk with {@link KeymanProjectCopier.write}
+     */
+    artifacts: CopierArtifacts;
+}
+export declare class KeymanProjectCopier implements KeymanCompiler {
+    options: CopierOptions;
+    callbacks: CompilerCallbacks;
+    asyncCallbacks: CopierAsyncCallbacks;
+    sourceId: string;
+    outputId: string;
+    outPath: string;
+    githubRef: GitHubRef;
+    cloudSource: KeymanCloudSource;
+    isLocalOrigin(): boolean;
+    relocateExternalFiles: boolean;
+    init(callbacks: CompilerCallbacks, options: CopierOptions): Promise<boolean>;
+    /**
+     * Copy a Keyman project. Returns an object containing binary
+     * artifacts on success. The files are passed in by name, and the compiler
+     * will use callbacks as passed to the {@link KeymanProjectCopier.init}
+     * function to read any input files by disk.
+     * @param   source  Source file or folder to copy. Can be a local file or folder, github:repo[:path], or cloud:id
+     * @returns         Binary artifacts on success, null on failure.
+     */
+    run(source: string): Promise<CopierResult>;
+    /**
+     * Resolve the source project file to either a local filesystem file,
+     * or a reference on GitHub
+     * @param source
+     * @returns  path to .kpj (either local or remote)
+     */
+    private getSourceProject;
+    /**
+     * Resolve source path to the contained project file; the project
+     * file must have the same basename as the folder in this case
+     * @param source
+     * @returns
+     */
+    private getLocalFolderProject;
+    /**
+     * Resolve source path to the input .kpj filename, folder name
+     * is not relevant when .kpj filename is passed in
+     * @param source
+     * @returns
+     */
+    private getLocalFileProject;
+    /**
+     * Resolve path to GitHub source, which must be in the following format:
+     *   `github:owner/repo[:branch]:path/to/kpj`
+     * The path must be fully qualified, referencing the .kpj file; it
+     * cannot just be the folder where the .kpj is found
+     * @param source
+     * @returns a promise: GitHub reference to the source for the keyboard, or null on failure
+     */
+    private getGitHubSourceProject;
+    /**
+     * Resolve path to Keyman Cloud source (which is on GitHub), which must be in
+     * the following format:
+     *   `cloud:keyboard_id|model_id`
+     * The `keyboard_id` parameter should be a valid id (a-z0-9_), as found at
+     * https://keyman.com/keyboards; alternativel if it is a model_id, it should
+     * have the format author.bcp47.uniq
+     * @param source
+     * @returns a promise: GitHub reference to the source for the keyboard, or null on failure
+     */
+    private getCloudSourceProject;
+    private normalizePath;
+    private verifyOutputPath;
+    private copiers;
+    private copyFolder;
+    private resolveFilename;
+    private copyProjectFile;
+    private copyGenericFile;
+    private copySourceFile;
+    private copyModelTsSourceFile;
+    private copyKmnSourceFile;
+    private copyKpsSourceFile;
+    private copySubFileAndGetRelativePath;
+    private splitFilename;
+    /**
+     * renames matching filename to the output filename pattern, and prepends the
+     * outputPath
+     * @param filename
+     * @param outputPath
+     * @returns
+     */
+    private generateNewFilename;
+    private calculateNewFilePath;
+    private loadProjectFromFile;
+    /**
+     * Write artifacts from a successful compile to disk, via callbacks methods.
+     * The artifacts written will include all files from the project, across
+     * multiple folders. Folders will be created as needed
+     *
+     * @param artifacts - object containing artifact binary data to write out
+     * @returns true on success
+     */
+    write(artifacts: CopierArtifacts): Promise<boolean>;
+}
+//# sourceMappingURL=KeymanProjectCopier.d.ts.map

package/build/src/KeymanProjectCopier.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeymanProjectCopier.d.ts","sourceRoot":"","sources":["../../src/KeymanProjectCopier.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,cAAc,EAAE,sBAAsB,EAAE,uBAAuB,EAAE,oBAAoB,EAAqH,MAAM,4BAA4B,CAAC;AAI3R,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAM1D;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAMhB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,uBAAuB;IAC9D;;;;OAIG;IACH,CAAC,qBAAqB,CAAC,EAAE,sBAAsB,CAAC;IAChD;;MAEE;IACF,CAAC,IAAI,EAAC,MAAM,GAAG,sBAAsB,CAAC;CACvC;AAED;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,oBAAoB;IACxD;;;OAGG;IACH,SAAS,EAAE,eAAe,CAAC;CAC5B;AAED,qBAAa,mBAAoB,YAAW,cAAc;IACxD,OAAO,EAAE,aAAa,CAAC;IACvB,SAAS,EAAE,iBAAiB,CAAC;IAC7B,cAAc,EAAE,oBAAoB,CAAC;IAErC,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAEhB,SAAS,EAAE,SAAS,CAAC;IACrB,WAAW,EAAE,iBAAiB,CAAC;IAC/B,aAAa,IAAI,OAAO;IAGxB,qBAAqB,EAAE,OAAO,CAAS;IAE1B,IAAI,CAAC,SAAS,EAAE,iBAAiB,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC;IAOzF;;;;;;;OAOG;IACU,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IA4CvD;;;;;OAKG;YACW,gBAAgB;IAgB9B;;;;;OAKG;IACH,OAAO,CAAC,qBAAqB;IAU7B;;;;;OAKG;IACH,OAAO,CAAC,mBAAmB;IAI3B;;;;;;;OAOG;YACW,sBAAsB;IAoCpC;;;;;;;;;OASG;YACW,qBAAqB;IAgBnC,OAAO,CAAC,aAAa;IAIrB,OAAO,CAAC,gBAAgB;IAexB,OAAO,CAAC,OAAO,CAUb;YAEY,UAAU;IAmBxB,OAAO,CAAC,eAAe;YAeT,eAAe;YA8Bf,eAAe;YA+Bf,cAAc;YAId,qBAAqB;YAmCrB,iBAAiB;YA4BjB,iBAAiB;YAqEjB,6BAA6B;IA4B3C,OAAO,CAAC,aAAa;IASrB;;;;;;OAMG;IACH,OAAO,CAAC,mBAAmB;IAS3B,OAAO,CAAC,oBAAoB;YA0Bd,mBAAmB;IAyBjC;;;;;;;OAOG;IAEU,KAAK,CAAC,SAAS,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC;CAkDjE"}