Add TypeScript declaration files to bnf package

Co-authored-by: hzhangxyz <[email protected]>

Author: Copilot

bnf/atsds_bnf/.gitignore

@@ -1,2 +1,3 @@
 *
-!index.js
+!index.mjs
+!index.mts

bnf/atsds_bnf/index.mts

@@ -0,0 +1,132 @@
+import { InputStream, CommonTokenStream } from "antlr4";
+import DspLexer from "./DspLexer.js";
+import DspParser from "./DspParser.js";
+import DspVisitor from "./DspVisitor.js";
+import DsLexer from "./DsLexer.js";
+import DsParser from "./DsParser.js";
+import DsVisitor from "./DsVisitor.js";
+
+class ParseVisitor extends DspVisitor {
+    visitRule_pool(ctx: any): string {
+        return ctx
+            .rule_()
+            .map((r: any) => this.visit(r))
+            .join("\n\n");
+    }
+
+    visitRule(ctx: any): string {
+        const result = ctx.term().map((t: any) => this.visit(t));
+        if (result.length === 1) {
+            return `----\n${result[0]}`;
+        } else {
+            const conclusion = result.pop();
+            const length = Math.max(...result.map((premise: string) => premise.length));
+            result.push("-".repeat(Math.max(length, 4)));
+            result.push(conclusion);
+            return result.join("\n");
+        }
+    }
+
+    visitSymbol(ctx: any): string {
+        return ctx.SYMBOL().getText();
+    }
+
+    visitParentheses(ctx: any): string {
+        return this.visit(ctx.term());
+    }
+
+    visitSubscript(ctx: any): string {
+        return `(subscript ${ctx
+            .term()
+            .map((t: any) => this.visit(t))
+            .join(" ")})`;
+    }
+
+    visitFunction(ctx: any): string {
+        return `(function ${ctx
+            .term()
+            .map((t: any) => this.visit(t))
+            .join(" ")})`;
+    }
+
+    visitUnary(ctx: any): string {
+        return `(unary ${ctx.getChild(0).getText()} ${this.visit(ctx.term())})`;
+    }
+
+    visitBinary(ctx: any): string {
+        return `(binary ${ctx.getChild(1).getText()} ${this.visit(ctx.term(0))} ${this.visit(ctx.term(1))})`;
+    }
+}
+
+class UnparseVisitor extends DsVisitor {
+    visitRule_pool(ctx: any): string {
+        return ctx
+            .rule_()
+            .map((r: any) => this.visit(r))
+            .join("\n");
+    }
+
+    visitRule(ctx: any): string {
+        const result = ctx.term().map((t: any) => this.visit(t));
+        const conclusion = result.pop();
+        return result.join(", ") + " -> " + conclusion;
+    }
+
+    visitSymbol(ctx: any): string {
+        return ctx.SYMBOL().getText();
+    }
+
+    visitSubscript(ctx: any): string {
+        return `${this.visit(ctx.term(0))}[${ctx
+            .term()
+            .slice(1)
+            .map((t: any) => this.visit(t))
+            .join(", ")}]`;
+    }
+
+    visitFunction(ctx: any): string {
+        return `${this.visit(ctx.term(0))}(${ctx
+            .term()
+            .slice(1)
+            .map((t: any) => this.visit(t))
+            .join(", ")})`;
+    }
+
+    visitUnary(ctx: any): string {
+        return `(${ctx.getChild(1).getText()} ${this.visit(ctx.term())})`;
+    }
+
+    visitBinary(ctx: any): string {
+        return `(${this.visit(ctx.term(0))} ${ctx.getChild(1).getText()} ${this.visit(ctx.term(1))})`;
+    }
+}
+
+/**
+ * Parse Dsp format (human-readable) to Ds format (internal S-expression)
+ * @param input - The Dsp format string to parse
+ * @returns The Ds format string
+ */
+export function parse(input: string): string {
+    const chars = new InputStream(input);
+    const lexer = new DspLexer(chars);
+    const tokens = new CommonTokenStream(lexer);
+    const parser = new DspParser(tokens);
+    const tree = parser.rule_pool();
+    const visitor = new ParseVisitor();
+    return visitor.visit(tree);
+}
+
+/**
+ * Unparse Ds format (internal S-expression) to Dsp format (human-readable)
+ * @param input - The Ds format string to unparse
+ * @returns The Dsp format string
+ */
+export function unparse(input: string): string {
+    const chars = new InputStream(input);
+    const lexer = new DsLexer(chars);
+    const tokens = new CommonTokenStream(lexer);
+    const parser = new DsParser(tokens);
+    const tree = parser.rule_pool();
+    const visitor = new UnparseVisitor();
+    return visitor.visit(tree);
+}

bnf/package-lock.json

@@ -13,7 +13,9 @@
     "main": "dist/index.mjs",
     "module": "dist/index.mjs",
     "browser": "dist/index.mjs",
+    "types": "dist/index.d.mts",
     "files": [
+        "dist/index.d.mts",
         "dist/index.mjs"
     ],
     "scripts": {
@@ -33,10 +35,14 @@
         "@rollup/plugin-json": "^6.1.0",
         "@rollup/plugin-node-resolve": "^16.0.3",
         "@rollup/plugin-terser": "^0.4.4",
+        "@rollup/plugin-typescript": "^12.3.0",
         "@types/jest": "^30.0.0",
         "cross-env": "^10.1.0",
         "jest": "^30.2.0",
         "npm-run-all": "^4.1.5",
-        "rollup": "^4.53.3"
+        "rollup": "^4.53.3",
+        "rollup-plugin-dts": "^6.3.0",
+        "tslib": "^2.8.1",
+        "typescript": "^5.9.3"
     }
 }

bnf/package.json

@@ -2,15 +2,18 @@ import commonjs from "@rollup/plugin-commonjs";
 import json from "@rollup/plugin-json";
 import nodeResolve from "@rollup/plugin-node-resolve";
 import terser from "@rollup/plugin-terser";
+import typescript from "@rollup/plugin-typescript";
+import { dts } from "rollup-plugin-dts";
 
 export default [
     {
-        input: "atsds_bnf/index.mjs",
+        input: "atsds_bnf/index.mts",
         output: {
             file: "dist/index.mjs",
             format: "es",
         },
         plugins: [
+            typescript(),
             nodeResolve({
                 browser: true,
             }),
@@ -19,4 +22,12 @@ export default [
             terser(),
         ],
     },
+    {
+        input: "atsds_bnf/index.mts",
+        output: {
+            file: "dist/index.d.mts",
+            format: "es",
+        },
+        plugins: [dts()],
+    },
 ];

bnf/rollup.config.mjs

@@ -0,0 +1,11 @@
+{
+    "compilerOptions": {
+        "target": "esnext",
+        "module": "esnext",
+        "strict": true,
+        "esModuleInterop": true,
+        "isolatedModules": true,
+        "skipLibCheck": true
+    },
+    "include": ["atsds_bnf/*"]
+}