🤖 Merge PR DefinitelyTyped#72950 [dom-chromium-ai] add types for Proofreader API by @christianliebel

Author: christianliebel

types/dom-chromium-ai/dom-chromium-ai-tests.ts

@@ -410,4 +410,45 @@ async function topLevel() {
     console.log(languageDetectorResult.confidence);
 
     languageDetector.destroy();
+
+    // Proofreader
+
+    const proofreader = await Proofreader.create({
+        includeCorrectionTypes: true,
+        includeCorrectionExplanations: true,
+        correctionExplanationLanguage: "de",
+        expectedInputLanguages: ["de"],
+        signal: (new AbortController()).signal,
+        monitor(m: CreateMonitor) {
+            m.addEventListener("downloadprogress", (e) => {
+                console.log(e.loaded, e.total);
+            });
+        },
+    });
+
+    const proofreaderAvailability1: Availability = await Proofreader.availability();
+    console.log(proofreaderAvailability1);
+
+    const proofreaderAvailability2: Availability = await Proofreader.availability({
+        expectedInputLanguages: ["de"],
+    });
+    console.log(proofreaderAvailability2);
+
+    const proofreaderResult: ProofreadResult = await proofreader.proofread("foo");
+    console.log(proofreaderResult);
+
+    // for await (
+    //     const chunk of proofreader.proofreadStreaming("foo")
+    // ) {
+    //     console.log(chunk);
+    // }
+
+    console.log(
+        proofreader.expectedInputLanguages,
+        proofreader.correctionExplanationLanguage,
+        proofreader.includeCorrectionExplanations,
+        proofreader.includeCorrectionTypes,
+    );
+
+    proofreader.destroy();
 }

types/dom-chromium-ai/index.d.ts

@@ -389,3 +389,48 @@ interface LanguageDetectionResult {
     detectedLanguage?: string;
     confidence?: number;
 }
+
+// Proofreader API
+// https://github.com/webmachinelearning/proofreader-api?tab=readme-ov-file#full-api-surface-in-web-idl
+
+declare abstract class Proofreader implements DestroyableModel {
+    static create(options?: ProofreaderCreateOptions): Promise<Proofreader>;
+    static availability(options?: ProofreaderCreateCoreOptions): Promise<Availability>;
+
+    proofread(input: string): Promise<ProofreadResult>;
+    // proofreadStreaming(input: string): ReadableStream<unknown>;
+
+    readonly includeCorrectionTypes: boolean;
+    readonly includeCorrectionExplanations: boolean;
+    readonly correctionExplanationLanguage?: string;
+    readonly expectedInputLanguages: ReadonlyArray<string>;
+
+    destroy(): void;
+}
+
+interface ProofreaderCreateCoreOptions {
+    includeCorrectionTypes?: boolean;
+    includeCorrectionExplanations?: boolean;
+    correctionExplanationLanguage?: string;
+    expectedInputLanguages?: string[];
+}
+
+interface ProofreaderCreateOptions extends ProofreaderCreateCoreOptions {
+    signal?: AbortSignal;
+    monitor?: CreateMonitorCallback;
+}
+
+interface ProofreadResult {
+    correctedInput: string;
+    corrections: ProofreadCorrection[];
+}
+
+interface ProofreadCorrection {
+    startIndex: number;
+    endIndex: number;
+    correction: string;
+    type?: CorrectionType;
+    explanation?: string;
+}
+
+type CorrectionType = "spelling" | "punctuation" | "capitalization" | "preposition" | "missing-words" | "grammar";