feat!(gettext-parser): update types for v8.0.0 (DefinitelyTyped#71749)

Author: pmpak

types/gettext-parser/gettext-parser-tests.ts

@@ -1,16 +1,31 @@
 import { mo, po } from "gettext-parser";
+import { createReadStream } from "node:fs";
 
-let parsed = po.parse("foo", "utf-8");
-let compiled = po.compile(parsed, {});
+let parsed = po.parse("foo", { defaultCharset: "utf-8", validation: true });
+parsed = po.parse("foo", { defaultCharset: "utf-8" });
+parsed = po.parse("foo", { validation: true });
+parsed = po.parse("foo", { validation: false });
 parsed = po.parse(Buffer.from("bar"));
-compiled = po.compile(parsed, { anyOption: false });
-const stream = po.createParseStream(Buffer.from("bar"));
-stream.on("data", (data) => {
-    console.log(data);
+
+let compiled = po.compile(parsed, {});
+compiled = po.compile(parsed);
+compiled = po.compile(parsed, { foldLength: 80 });
+compiled = po.compile(parsed, { escapeCharacters: true });
+compiled = po.compile(parsed, { escapeCharacters: false });
+compiled = po.compile(parsed, { sort: true });
+compiled = po.compile(parsed, { sort: false });
+compiled = po.compile(parsed, { eol: "\n" });
+compiled = po.compile(parsed, { sort: (a, b) => a.msgid.length > b.msgid.length ? 1 : -1 });
+
+const poParseStream = po.createParseStream();
+const input = createReadStream("bar");
+input.pipe(poParseStream);
+poParseStream.on("data", (data) => {
+    console.log(data.translations[""]);
 });
 
+parsed = mo.parse(Buffer.from("bar"), "wrong-charset");
 parsed = mo.parse(compiled, "wrong-charset");
-compiled = mo.compile(parsed, { noOption: 3 });
 
 const charset: string = parsed.charset;
 

types/gettext-parser/index.d.ts

@@ -1,38 +1,58 @@
 /// <reference types="node" />
 
-import { Transform } from "readable-stream";
+import { Transform, TransformOptions } from "readable-stream";
 
 export interface GetTextComment {
-    translator: string;
-    reference: string;
-    extracted: string;
-    flag: string;
-    previous: string;
+    translator?: string;
+    reference?: string;
+    extracted?: string;
+    flag?: string;
+    previous?: string;
 }
 
 export interface GetTextTranslation {
-    msgctxt?: string | undefined;
+    msgctxt?: string;
     msgid: string;
-    msgid_plural?: any;
+    msgid_plural?: string;
     msgstr: string[];
-    comments?: GetTextComment | undefined;
+    comments?: GetTextComment;
+    obsolete?: boolean;
+}
+
+export interface GetTextTranslationRecord {
+    [msgctxt: string]: {
+        [msgId: string]: GetTextTranslation;
+    };
 }
 
 export interface GetTextTranslations {
     charset: string;
     headers: { [headerName: string]: string };
-    translations: { [msgctxt: string]: { [msgId: string]: GetTextTranslation } };
+    translations: GetTextTranslationRecord;
+    obsolete?: GetTextTranslationRecord;
+}
+
+export interface GetTextPoParserOptions {
+    defaultCharset?: string;
+    validation?: boolean;
+}
+
+export interface GetTextPoCompilerOptions {
+    foldLength?: number;
+    escapeCharacters?: boolean;
+    sort?: boolean | ((a: GetTextTranslation, b: GetTextTranslation) => number);
+    eol?: string;
 }
 
 export interface PoParser {
-    parse: (buffer: Buffer | string, defaultCharset?: string) => GetTextTranslations;
-    compile: (table: GetTextTranslations, options?: any) => Buffer;
-    createParseStream: (buffer: any, defaultCharset?: string) => Transform;
+    parse: (buffer: Buffer | string, options?: GetTextPoParserOptions) => GetTextTranslations;
+    compile: (table: GetTextTranslations, options?: GetTextPoCompilerOptions) => Buffer;
+    createParseStream: (options?: GetTextPoParserOptions, transformOptions?: TransformOptions) => Transform;
 }
 
 export interface MoParser {
     parse: (buffer: Buffer | string, defaultCharset?: string) => GetTextTranslations;
-    compile: (table: GetTextTranslations, options?: any) => Buffer;
+    compile: (table: GetTextTranslations) => Buffer;
 }
 
 export const po: PoParser;

types/gettext-parser/package.json

@@ -1,7 +1,8 @@
 {
     "private": true,
     "name": "@types/gettext-parser",
-    "version": "4.0.9999",
+    "version": "8.0.9999",
+    "type": "module",
     "projects": [
         "https://github.com/smhg/gettext-parser"
     ],