harper.js 0.25.1 → 0.26.0

package/dist/harper.d.ts

@@ -1,3 +1,47 @@
+export declare const binary: BinaryModule;
+
+export declare const binaryInlined: BinaryModule;
+
+/** This class aims to define the communication protocol between the main thread and the worker.
+ * Note that much of the complication here comes from the fact that we can't serialize function calls or referenced WebAssembly memory.*/
+export declare class BinaryModule {
+    url: string | URL;
+    private inner;
+    constructor(url: string | URL);
+    applySuggestion(text: string, suggestion: Suggestion, span: Span): Promise<string>;
+    getDefaultLintConfigAsJSON(): Promise<string>;
+    getDefaultLintConfig(): Promise<LintConfig>;
+    toTitleCase(text: string): Promise<string>;
+    setup(): Promise<void>;
+    createLinter(dialect?: Dialect): Promise<Linter_2>;
+    serializeArg(arg: any): Promise<RequestArg>;
+    serialize(req: DeserializedRequest): Promise<SerializedRequest>;
+    deserializeArg(requestArg: RequestArg): Promise<any>;
+    deserialize(request: SerializedRequest): Promise<DeserializedRequest>;
+}
+
+/** An object that is received by the web worker to request work to be done. */
+export declare interface DeserializedRequest {
+    /** The procedure to be executed. */
+    procName: string;
+    /** The arguments to the procedure */
+    args: any[];
+}
+
+export declare enum Dialect {
+    American = 0,
+    British = 1,
+    Australian = 2,
+    Canadian = 3,
+}
+
+export declare function isSerializedRequest(v: unknown): v is SerializedRequest;
+
+declare enum Language {
+    Plain = 0,
+    Markdown = 1,
+}
+
 /**
  * An error found in provided text.
  *
@@ -92,19 +136,89 @@ export declare interface Linter {
     /** Export all added words from the dictionary. Note that this will NOT export anything from the curated dictionary,
      * only words from previous calls to `this.importWords`. */
     exportWords(): Promise<string[]>;
+    /** Get the dialect of English this linter was constructed for. */
+    getDialect(): Promise<Dialect>;
+    /** Get the dialect of English this linter was constructed for. */
+    setDialect(dialect: Dialect): Promise<void>;
+}
+
+declare class Linter_2 {
+    private constructor();
+    free(): void;
+    /**
+     * Construct a new `Linter`.
+     * Note that this can mean constructing the curated dictionary, which is the most expensive operation
+     * in Harper.
+     */
+    static new(dialect: Dialect): Linter_2;
+    /**
+     * Helper method to quickly check if a plain string is likely intended to be English
+     */
+    is_likely_english(text: string): boolean;
+    /**
+     * Helper method to remove non-English text from a plain English document.
+     */
+    isolate_english(text: string): string;
+    /**
+     * Get a JSON map containing the descriptions of all the linting rules.
+     */
+    get_lint_descriptions_as_json(): string;
+    get_lint_config_as_json(): string;
+    set_lint_config_from_json(json: string): void;
+    /**
+     * Get a Record containing the descriptions of all the linting rules.
+     */
+    get_lint_descriptions_as_object(): any;
+    get_lint_config_as_object(): any;
+    set_lint_config_from_object(object: any): void;
+    ignore_lint(lint: Lint): void;
+    /**
+     * Perform the configured linting on the provided text.
+     */
+    lint(text: string, language: Language): Lint[];
+    /**
+     * Export the linter's ignored lints as a privacy-respecting JSON list of hashes.
+     */
+    export_ignored_lints(): string;
+    /**
+     * Import into the linter's ignored lints from a privacy-respecting JSON list of hashes.
+     */
+    import_ignored_lints(json: string): void;
+    clear_ignored_lints(): void;
+    /**
+     * Import words into the dictionary.
+     */
+    import_words(additional_words: string[]): void;
+    /**
+     * Export words from the dictionary.
+     * Note: this will only return words previously added by [`Self::import_words`].
+     */
+    export_words(): string[];
+    /**
+     * Get the dialect this struct was constructed for.
+     */
+    get_dialect(): Dialect;
+}
+
+export declare interface LinterInit {
+    /** The module or path to the WebAssembly binary. */
+    binary: BinaryModule;
+    /** The dialect of English Harper should use. If omitted, Harper will default to American English. */
+    dialect?: Dialect;
 }
 
 /** The option used to configure the parser for an individual linting operation. */
-export declare type LintOptions = {
+export declare interface LintOptions {
     /** The markup language that is being passed. Defaults to `markdown`. */
     language?: 'plaintext' | 'markdown';
-};
+}
 
 /** A Linter that runs in the current JavaScript context (meaning it is allowed to block the event loop).  */
 export declare class LocalLinter implements Linter {
+    binary: BinaryModule;
     private inner;
-    /** Initialize the WebAssembly and construct the inner Linter. */
-    private initialize;
+    constructor(init: LinterInit);
+    private createInner;
     setup(): Promise<void>;
     lint(text: string, options?: LintOptions): Promise<Lint[]>;
     applySuggestion(text: string, suggestion: Suggestion, span: Span): Promise<string>;
@@ -125,6 +239,24 @@ export declare class LocalLinter implements Linter {
     clearIgnoredLints(): Promise<void>;
     importWords(words: string[]): Promise<void>;
     exportWords(): Promise<string[]>;
+    getDialect(): Promise<Dialect>;
+    setDialect(dialect: Dialect): Promise<void>;
+}
+
+/** Serializable argument to a procedure to be run on the web worker. */
+export declare interface RequestArg {
+    json: string;
+    type: SerializableTypes;
+}
+
+export declare type SerializableTypes = 'string' | 'number' | 'boolean' | 'Suggestion' | 'Lint' | 'Span' | 'Array' | 'undefined';
+
+/** An object that is sent to the web worker to request work to be done. */
+export declare interface SerializedRequest {
+    /** The procedure to be executed. */
+    procName: string;
+    /** The arguments to the procedure */
+    args: RequestArg[];
 }
 
 /**
@@ -182,10 +314,12 @@ export declare enum SuggestionKind {
  *
  * NOTE: This class will not work properly in Node. In that case, just use `LocalLinter`. */
 export declare class WorkerLinter implements Linter {
+    private binary;
+    private dialect?;
     private worker;
     private requestQueue;
     private working;
-    constructor();
+    constructor(init: LinterInit);
     private setupMainEventListeners;
     setup(): Promise<void>;
     lint(text: string, options?: LintOptions): Promise<Lint[]>;
@@ -207,6 +341,8 @@ export declare class WorkerLinter implements Linter {
     clearIgnoredLints(): Promise<void>;
     importWords(words: string[]): Promise<void>;
     exportWords(): Promise<string[]>;
+    getDialect(): Promise<Dialect>;
+    setDialect(dialect: Dialect): Promise<void>;
     /** Run a procedure on the remote worker. */
     private rpc;
     private submitRemainingRequests;