🤖 Merge PR DefinitelyTyped#74808 Add types for textile-js by @phothinmg

Author: phothinmg

types/textile-js/.npmignore

@@ -0,0 +1,5 @@
+*
+!**/*.d.ts
+!**/*.d.cts
+!**/*.d.mts
+!**/*.d.*.ts

types/textile-js/index.d.ts

@@ -0,0 +1,35 @@
+export = textile;
+declare function textile(txt: string, opts?: textile.Options): string;
+declare namespace textile {
+    type Tag = string;
+    type JMLAttributes = Record<string, string | number | boolean | null | undefined>;
+    type JMLElement = [Tag, ...(JMLAttributes | JMLElement | string)[]];
+    type JMLNode = Array<JMLElement | string> & { sourceLength?: number };
+    type JMLDocument = ["html", ...(JMLElement | string)[]];
+    type TokenType = "OPEN" | "CLOSE" | "TEXT" | "SINGLE" | "WS" | "COMMENT";
+    type Token =
+        | {
+            type: "OPEN" | "CLOSE" | "SINGLE";
+            tag: Tag;
+            attr?: JMLAttributes;
+            pos: number;
+            src: string;
+        }
+        | {
+            type: "TEXT" | "WS" | "COMMENT";
+            data: string;
+            pos: number;
+            src: string;
+        };
+    interface Options {
+        breaks?: boolean;
+    }
+    const defaults: Options;
+    function setOptions(opt: Options): typeof textile;
+    function setoptions(opt: Options): typeof textile;
+    function parse(txt: string, opts?: Options): string;
+    function convert(txt: string, opts?: Options): string;
+    function jsonml(txt: string, opts?: Options): JMLDocument;
+    function serialize(jsonml: JMLElement | string): string;
+    function html_parser(tokens: Token[], lazy?: boolean): JMLNode;
+}

types/textile-js/package.json

@@ -0,0 +1,17 @@
+{
+    "private": true,
+    "name": "@types/textile-js",
+    "version": "2.1.9999",
+    "projects": [
+        "https://github.com/borgar/textile-js"
+    ],
+    "devDependencies": {
+        "@types/textile-js": "workspace:."
+    },
+    "owners": [
+        {
+            "name": "phothinmg",
+            "githubUsername": "phothinmg"
+        }
+    ]
+}

types/textile-js/textile-js-tests.ts

@@ -0,0 +1,39 @@
+import textile = require("textile-js");
+
+const txt = "h1. Hello World";
+const opt: textile.Options = { breaks: true };
+
+const rendered: string = textile(txt, opt);
+
+const parsed: string = textile.parse(txt, opt);
+const converted: string = textile.convert(txt, opt);
+
+const doc: textile.JMLDocument = textile.jsonml(txt, opt);
+const serializedDoc: string = textile.serialize(doc);
+
+const node: textile.JMLElement = ["p", { class: "intro", "data-id": 1 }, "Hello"];
+const serializedNode: string = textile.serialize(node);
+
+const textOnlySerialized: string = textile.serialize("plain text");
+
+const defaults: textile.Options = textile.defaults;
+const chained: typeof textile = textile.setOptions(defaults).setoptions({ breaks: false });
+
+const tokens: textile.Token[] = [
+    { type: "OPEN", tag: "p", pos: 0, src: "<p>" },
+    { type: "TEXT", data: "Hello", pos: 3, src: "Hello" },
+    { type: "CLOSE", tag: "p", pos: 8, src: "</p>" },
+];
+
+const parsedNode: textile.JMLNode = textile.html_parser(tokens);
+const parsedNodeLazy: textile.JMLNode = textile.html_parser(tokens, true);
+
+void rendered;
+void parsed;
+void converted;
+void serializedDoc;
+void serializedNode;
+void textOnlySerialized;
+void chained;
+void parsedNode;
+void parsedNodeLazy;

types/textile-js/tsconfig.json

@@ -0,0 +1,19 @@
+{
+    "compilerOptions": {
+        "module": "node16",
+        "lib": [
+            "es6"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "textile-js-tests.ts"
+    ]
+}