@keymanapp/kmc-analyze 18.0.41-alpha → 18.0.45-alpha

package/build/src/index.d.ts

@@ -1,8 +1,8 @@
-/**
- * @packageDocumentation
- * kmc-analyze - keyboard analysis classes, including tools for `&displayMap`.
- */
-export { AnalyzeOskCharacterUse, AnalyzeOskCharacterUseOptions } from './osk-character-use/index.js';
-export { AnalyzeOskRewritePua } from './osk-rewrite-pua/index.js';
-export { AnalyzerMessages } from './messages.js';
+/**
+ * @packageDocumentation
+ * kmc-analyze - keyboard analysis classes, including tools for `&displayMap`.
+ */
+export { AnalyzeOskCharacterUse, AnalyzeOskCharacterUseOptions } from './osk-character-use/index.js';
+export { AnalyzeOskRewritePua } from './osk-rewrite-pua/index.js';
+export { AnalyzerMessages } from './messages.js';
 //# sourceMappingURL=index.d.ts.map

package/build/src/index.js

@@ -1,11 +1,8 @@
-/**
- * @packageDocumentation
- * kmc-analyze - keyboard analysis classes, including tools for `&displayMap`.
- */
-
-!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:{},n=(new Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="d57ffaf0-e420-5344-91d2-a3515a8e86eb")}catch(e){}}();
-export { AnalyzeOskCharacterUse } from './osk-character-use/index.js';
-export { AnalyzeOskRewritePua } from './osk-rewrite-pua/index.js';
-export { AnalyzerMessages } from './messages.js';
-//# sourceMappingURL=index.js.map
-//# debugId=d57ffaf0-e420-5344-91d2-a3515a8e86eb
+/**
+ * @packageDocumentation
+ * kmc-analyze - keyboard analysis classes, including tools for `&displayMap`.
+ */
+export { AnalyzeOskCharacterUse } from './osk-character-use/index.js';
+export { AnalyzeOskRewritePua } from './osk-rewrite-pua/index.js';
+export { AnalyzerMessages } from './messages.js';
+//# sourceMappingURL=index.js.map

package/build/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../../src/index.ts"],"sourceRoot":"","names":[],"mappings":"AAAA;;;GAGG;;;AAEH,OAAO,EAAE,sBAAsB,EAAiC,MAAM,8BAA8B,CAAC;AACrG,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC","debug_id":"d57ffaf0-e420-5344-91d2-a3515a8e86eb"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,sBAAsB,EAAiC,MAAM,8BAA8B,CAAC;AACrG,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC"}

package/build/src/messages.d.ts

@@ -1,16 +1,16 @@
-/**
- * @internal
- * Compiler messages for `kmc analyze`
- */
-export declare class AnalyzerMessages {
-    static readonly FATAL_UnexpectedException: number;
-    static readonly Fatal_UnexpectedException: (o: {
-        e: any;
-    }) => import("@keymanapp/common-types").CompilerEvent;
-    static readonly INFO_ScanningFile: number;
-    static readonly Info_ScanningFile: (o: {
-        type: string;
-        name: string;
-    }) => import("@keymanapp/common-types").CompilerEvent;
-}
+/**
+ * @internal
+ * Compiler messages for `kmc analyze`
+ */
+export declare class AnalyzerMessages {
+    static readonly FATAL_UnexpectedException: number;
+    static readonly Fatal_UnexpectedException: (o: {
+        e: any;
+    }) => import("@keymanapp/common-types").CompilerEvent;
+    static readonly INFO_ScanningFile: number;
+    static readonly Info_ScanningFile: (o: {
+        type: string;
+        name: string;
+    }) => import("@keymanapp/common-types").CompilerEvent;
+}
 //# sourceMappingURL=messages.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../../src/messages.ts"],"names":[],"mappings":"AAUA;;;GAGG;AACH,qBAAa,gBAAgB;IAC3B,MAAM,CAAC,QAAQ,CAAC,yBAAyB,SAAqB;IAC9D,MAAM,CAAC,QAAQ,CAAC,yBAAyB,MAAM;QAAC,CAAC,EAAE,GAAG,CAAA;KAAC,qDAOrD;IAEF,MAAM,CAAC,QAAQ,CAAC,iBAAiB,SAAoB;IACrD,MAAM,CAAC,QAAQ,CAAC,iBAAiB,MAAM;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,MAAM,CAAA;KAAC,qDAIjE;CACH"}
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../../src/messages.ts"],"names":[],"mappings":"AAUA;;;GAGG;AACH,qBAAa,gBAAgB;IAC3B,MAAM,CAAC,QAAQ,CAAC,yBAAyB,SAAqB;IAC9D,MAAM,CAAC,QAAQ,CAAC,yBAAyB,MAAM;QAAC,CAAC,EAAE,GAAG,CAAA;KAAC,qDAOrD;IAEF,MAAM,CAAC,QAAQ,CAAC,iBAAiB,SAAoB;IACrD,MAAM,CAAC,QAAQ,CAAC,iBAAiB,MAAM;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAC,qDAIjE;CACH"}

package/build/src/messages.js

@@ -1,25 +1,22 @@
-
-!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:{},n=(new Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="7aed8e9d-a764-5bbe-bb3d-137414d2b44f")}catch(e){}}();
-import { CompilerErrorNamespace, CompilerErrorSeverity, CompilerMessageSpec as m, CompilerMessageDef as def, CompilerMessageSpecWithException } from "@keymanapp/common-types";
-import { KeymanUrls } from "@keymanapp/developer-utils";
-const Namespace = CompilerErrorNamespace.Analyzer;
-const SevInfo = CompilerErrorSeverity.Info | Namespace;
-// const SevHint = CompilerErrorSeverity.Hint | Namespace;
-// const SevWarn = CompilerErrorSeverity.Warn | Namespace;
-// const SevError = CompilerErrorSeverity.Error | Namespace;
-const SevFatal = CompilerErrorSeverity.Fatal | Namespace;
-/**
- * @internal
- * Compiler messages for `kmc analyze`
- */
-export class AnalyzerMessages {
-    static FATAL_UnexpectedException = SevFatal | 0x0001;
+import { CompilerErrorNamespace, CompilerErrorSeverity, CompilerMessageSpec as m, CompilerMessageDef as def, CompilerMessageSpecWithException } from "@keymanapp/common-types";
+import { KeymanUrls } from "@keymanapp/developer-utils";
+const Namespace = CompilerErrorNamespace.Analyzer;
+const SevInfo = CompilerErrorSeverity.Info | Namespace;
+// const SevHint = CompilerErrorSeverity.Hint | Namespace;
+// const SevWarn = CompilerErrorSeverity.Warn | Namespace;
+// const SevError = CompilerErrorSeverity.Error | Namespace;
+const SevFatal = CompilerErrorSeverity.Fatal | Namespace;
+/**
+ * @internal
+ * Compiler messages for `kmc analyze`
+ */
+export class AnalyzerMessages {
+    static FATAL_UnexpectedException = SevFatal | 0x0001;
     static Fatal_UnexpectedException = (o) => CompilerMessageSpecWithException(this.FATAL_UnexpectedException, null, o.e ?? 'unknown error', `Raised when an analysis components has an internal error. If you
     experience this error, it should be reported to the Keyman team for
-    resolution via ${KeymanUrls.NEW_KEYMAN_ISSUE()}`);
-    static INFO_ScanningFile = SevInfo | 0x0002;
-    static Info_ScanningFile = (o) => m(this.INFO_ScanningFile, `Scanning ${def(o.type)} file ${def(o.name)}`, `Informative message reporting on the current file being scanned`);
-}
-;
-//# sourceMappingURL=messages.js.map
-//# debugId=7aed8e9d-a764-5bbe-bb3d-137414d2b44f
+    resolution via ${KeymanUrls.NEW_KEYMAN_ISSUE()}`);
+    static INFO_ScanningFile = SevInfo | 0x0002;
+    static Info_ScanningFile = (o) => m(this.INFO_ScanningFile, `Scanning ${def(o.type)} file ${def(o.name)}`, `Informative message reporting on the current file being scanned`);
+}
+;
+//# sourceMappingURL=messages.js.map

package/build/src/messages.js.map

@@ -1 +1 @@
-{"version":3,"file":"messages.js","sources":["../../src/messages.ts"],"sourceRoot":"","names":[],"mappings":";;AAAA,OAAO,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,mBAAmB,IAAI,CAAC,EAAE,kBAAkB,IAAI,GAAG,EAAE,gCAAgC,EAAE,MAAM,yBAAyB,CAAC;AAC/K,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAExD,MAAM,SAAS,GAAG,sBAAsB,CAAC,QAAQ,CAAC;AAClD,MAAM,OAAO,GAAG,qBAAqB,CAAC,IAAI,GAAG,SAAS,CAAC;AACvD,0DAA0D;AAC1D,0DAA0D;AAC1D,4DAA4D;AAC5D,MAAM,QAAQ,GAAG,qBAAqB,CAAC,KAAK,GAAG,SAAS,CAAC;AAEzD;;;GAGG;AACH,MAAM,OAAO,gBAAgB;IAC3B,MAAM,CAAU,yBAAyB,GAAG,QAAQ,GAAG,MAAM,CAAC;IAC9D,MAAM,CAAU,yBAAyB,GAAG,CAAC,CAAU,EAAE,EAAE,CAAC,gCAAgC,CAC1F,IAAI,CAAC,yBAAyB,EAC9B,IAAI,EACJ,CAAC,CAAC,CAAC,IAAI,eAAe,EACtB;;qBAEiB,UAAU,CAAC,gBAAgB,EAAE,EAAE,CACjD,CAAC;IAEF,MAAM,CAAU,iBAAiB,GAAG,OAAO,GAAG,MAAM,CAAC;IACrD,MAAM,CAAU,iBAAiB,GAAG,CAAC,CAA8B,EAAE,EAAE,CAAC,CAAC,CACvE,IAAI,CAAC,iBAAiB,EACtB,YAAY,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAC7C,iEAAiE,CAClE,CAAC;;AACH,CAAC","debug_id":"7aed8e9d-a764-5bbe-bb3d-137414d2b44f"}
+{"version":3,"file":"messages.js","sourceRoot":"","sources":["../../src/messages.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,mBAAmB,IAAI,CAAC,EAAE,kBAAkB,IAAI,GAAG,EAAE,gCAAgC,EAAE,MAAM,yBAAyB,CAAC;AAC/K,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAExD,MAAM,SAAS,GAAG,sBAAsB,CAAC,QAAQ,CAAC;AAClD,MAAM,OAAO,GAAG,qBAAqB,CAAC,IAAI,GAAG,SAAS,CAAC;AACvD,0DAA0D;AAC1D,0DAA0D;AAC1D,4DAA4D;AAC5D,MAAM,QAAQ,GAAG,qBAAqB,CAAC,KAAK,GAAG,SAAS,CAAC;AAEzD;;;GAGG;AACH,MAAM,OAAO,gBAAgB;IAC3B,MAAM,CAAU,yBAAyB,GAAG,QAAQ,GAAG,MAAM,CAAC;IAC9D,MAAM,CAAU,yBAAyB,GAAG,CAAC,CAAU,EAAE,EAAE,CAAC,gCAAgC,CAC1F,IAAI,CAAC,yBAAyB,EAC9B,IAAI,EACJ,CAAC,CAAC,CAAC,IAAI,eAAe,EACtB;;qBAEiB,UAAU,CAAC,gBAAgB,EAAE,EAAE,CACjD,CAAC;IAEF,MAAM,CAAU,iBAAiB,GAAG,OAAO,GAAG,MAAM,CAAC;IACrD,MAAM,CAAU,iBAAiB,GAAG,CAAC,CAA8B,EAAE,EAAE,CAAC,CAAC,CACvE,IAAI,CAAC,iBAAiB,EACtB,YAAY,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAC7C,iEAAiE,CAClE,CAAC;;AACH,CAAC"}

package/build/src/osk-character-use/index.d.ts

@@ -1,87 +1,87 @@
-import { CompilerCallbacks } from "@keymanapp/common-types";
-/**
- * @public
- * Options for character analysis
- */
-export interface AnalyzeOskCharacterUseOptions {
-    /**
-     * First character to use in PUA for remapping with &displayMap, defaults to
-     * U+F100
-     */
-    puaBase?: number;
-    /**
-     * If true, strips U+25CC from the key cap before further analysis
-     */
-    stripDottedCircle?: boolean;
-    /**
-     * If true, reports number of references to each character found in each
-     * source file
-     */
-    includeCounts?: boolean;
-}
-/**
- * @public
- * Analyze the characters used in On Screen Keyboard files (.kvks,
- * .keyman-touch-layout) for use with `&displayMap`.
- */
-export declare class AnalyzeOskCharacterUse {
-    private callbacks;
-    private _strings;
-    private options;
-    constructor(callbacks: CompilerCallbacks, options?: AnalyzeOskCharacterUseOptions);
-    /**
-     * Clears analysis data collected from previous calls to
-     * {@link AnalyzeOskCharacterUse.analyze}
-     */
-    clear(): void;
-    /**
-     * Analyzes a single source file for Unicode character usage. Can parse .kmn,
-     * .kvks, .keyman-touch-layout file formats. Can be called multiple times to
-     * collect results from more than one file. Use
-     * {@link AnalyzeOskCharacterUse.getStrings} to retrieve results.
-     *
-     * Note: `analyze()` collects key cap data, so calling this for a .kmn file
-     * will retrieve the key caps from the .kvks and .keyman-touch-layout files
-     * that it references, rather than key cap data from the .kmn file itself.
-     *
-     * @param   file - relative or absolute path to a Keyman source file
-     * @returns        true if the file is successfully loaded and parsed
-     */
-    analyze(file: string): Promise<boolean>;
-    private analyzeKmnKeyboard;
-    private addStrings;
-    private cleanString;
-    private scanVisualKeyboard;
-    private scanTouchLayout;
-    private prepareResults;
-    /**
-     * Returns the collected results from earlier calls to
-     * {@link AnalyzeOskCharacterUse.analyze}. This generates a mapping from a key
-     * cap (one or more characters) to a PUA code, for use with `&displayMap`.
-     *
-     * Three output formats are supported:
-     *
-     * - .txt: tab-separated string format, with three columns: PUA, Key Cap, and
-     *   plain string. The PUA and Key Cap columns are formatted as Unicode Scalar
-     *   Values, e.g. U+0061, and the plain string is the original key cap string.
-     *
-     * - .md: formatted for documentation purposes. Generates a Markdown table
-     *   (GFM) with PUA, Key Cap, and plain string. The PUA and Key Cap columns
-     *   are formatted as Unicode Scalar Values, e.g. U+0061, and the plain string
-     *   is the original key cap string.
-     *
-     * - .json: returns the final aggregated data as an array of strings, which
-     *   can be joined to form a JSON blob of an object with a single member,
-     *   `map`, which is an array of {@link Osk.StringResult} objects.
-     *
-     * @param    format - file format to return - can be '.txt', '.md', or '.json'
-     * @returns  an array of strings, formatted according to the `format`
-     *           parameter.
-     */
-    getStrings(format?: '.txt' | '.md' | '.json'): string[];
-    private static getStringsAsText;
-    private static getStringsAsMarkdown;
-    private static getStringsAsJson;
-    private static stringToUnicodeSequence;
-}
+import { CompilerCallbacks } from "@keymanapp/common-types";
+/**
+ * @public
+ * Options for character analysis
+ */
+export interface AnalyzeOskCharacterUseOptions {
+    /**
+     * First character to use in PUA for remapping with &displayMap, defaults to
+     * U+F100
+     */
+    puaBase?: number;
+    /**
+     * If true, strips U+25CC from the key cap before further analysis
+     */
+    stripDottedCircle?: boolean;
+    /**
+     * If true, reports number of references to each character found in each
+     * source file
+     */
+    includeCounts?: boolean;
+}
+/**
+ * @public
+ * Analyze the characters used in On Screen Keyboard files (.kvks,
+ * .keyman-touch-layout) for use with `&displayMap`.
+ */
+export declare class AnalyzeOskCharacterUse {
+    private callbacks;
+    private _strings;
+    private options;
+    constructor(callbacks: CompilerCallbacks, options?: AnalyzeOskCharacterUseOptions);
+    /**
+     * Clears analysis data collected from previous calls to
+     * {@link AnalyzeOskCharacterUse.analyze}
+     */
+    clear(): void;
+    /**
+     * Analyzes a single source file for Unicode character usage. Can parse .kmn,
+     * .kvks, .keyman-touch-layout file formats. Can be called multiple times to
+     * collect results from more than one file. Use
+     * {@link AnalyzeOskCharacterUse.getStrings} to retrieve results.
+     *
+     * Note: `analyze()` collects key cap data, so calling this for a .kmn file
+     * will retrieve the key caps from the .kvks and .keyman-touch-layout files
+     * that it references, rather than key cap data from the .kmn file itself.
+     *
+     * @param   file - relative or absolute path to a Keyman source file
+     * @returns        true if the file is successfully loaded and parsed
+     */
+    analyze(file: string): Promise<boolean>;
+    private analyzeKmnKeyboard;
+    private addStrings;
+    private cleanString;
+    private scanVisualKeyboard;
+    private scanTouchLayout;
+    private prepareResults;
+    /**
+     * Returns the collected results from earlier calls to
+     * {@link AnalyzeOskCharacterUse.analyze}. This generates a mapping from a key
+     * cap (one or more characters) to a PUA code, for use with `&displayMap`.
+     *
+     * Three output formats are supported:
+     *
+     * - .txt: tab-separated string format, with three columns: PUA, Key Cap, and
+     *   plain string. The PUA and Key Cap columns are formatted as Unicode Scalar
+     *   Values, e.g. U+0061, and the plain string is the original key cap string.
+     *
+     * - .md: formatted for documentation purposes. Generates a Markdown table
+     *   (GFM) with PUA, Key Cap, and plain string. The PUA and Key Cap columns
+     *   are formatted as Unicode Scalar Values, e.g. U+0061, and the plain string
+     *   is the original key cap string.
+     *
+     * - .json: returns the final aggregated data as an array of strings, which
+     *   can be joined to form a JSON blob of an object with a single member,
+     *   `map`, which is an array of {@link Osk.StringResult} objects.
+     *
+     * @param    format - file format to return - can be '.txt', '.md', or '.json'
+     * @returns  an array of strings, formatted according to the `format`
+     *           parameter.
+     */
+    getStrings(format?: '.txt' | '.md' | '.json'): string[];
+    private static getStringsAsText;
+    private static getStringsAsMarkdown;
+    private static getStringsAsJson;
+    private static stringToUnicodeSequence;
+}
 //# sourceMappingURL=index.d.ts.map