@askdb/core 0.5.0-beta.0

package/dist/schema/v2/writer.js

@@ -0,0 +1,49 @@
+import matter from "gray-matter";
+/**
+ * Serialize a table front-matter model back to markdown.
+ *
+ * - Front-matter keys are emitted in a stable order.
+ * - The markdown body is preserved verbatim from the parsed input.
+ * - Round-trip property: `parse(write(parse(file)))` equals `parse(file)` for structured fields.
+ */
+export function writeTableMarkdown(frontmatter, body) {
+    const data = orderedTableFrontmatter(frontmatter);
+    return matter.stringify(body, data);
+}
+/**
+ * Serialize `concepts.md` front-matter + body back to markdown.
+ */
+export function writeConceptsMarkdown(frontmatter, body) {
+    return matter.stringify(body, { concepts: frontmatter.concepts });
+}
+/** Emit front-matter keys in a stable, spec-defined order. */
+function orderedTableFrontmatter(fm) {
+    const ordered = {};
+    ordered["id"] = fm.id;
+    ordered["name"] = fm.name;
+    ordered["schemaId"] = fm.schemaId;
+    if (fm.primaryEntity !== undefined)
+        ordered["primaryEntity"] = fm.primaryEntity;
+    if (fm.aliases !== undefined)
+        ordered["aliases"] = fm.aliases;
+    if (fm.tags !== undefined)
+        ordered["tags"] = fm.tags;
+    if (fm.sensitive !== undefined)
+        ordered["sensitive"] = fm.sensitive;
+    if (fm.columns !== undefined) {
+        ordered["columns"] = fm.columns.map((c) => {
+            const col = { id: c.id };
+            if (c.aliases !== undefined)
+                col["aliases"] = c.aliases;
+            if (c.enum !== undefined)
+                col["enum"] = c.enum;
+            if (c.description !== undefined)
+                col["description"] = c.description;
+            if (c.sensitive !== undefined)
+                col["sensitive"] = c.sensitive;
+            return col;
+        });
+    }
+    return ordered;
+}
+//# sourceMappingURL=writer.js.map

package/dist/schema/v2/writer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"writer.js","sourceRoot":"","sources":["../../../src/schema/v2/writer.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,aAAa,CAAC;AAGjC;;;;;;GAMG;AACH,MAAM,UAAU,kBAAkB,CAAC,WAA+B,EAAE,IAAY;IAC9E,MAAM,IAAI,GAAG,uBAAuB,CAAC,WAAW,CAAC,CAAC;IAClD,OAAO,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AACtC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,WAAkC,EAAE,IAAY;IACpF,OAAO,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC;AACpE,CAAC;AAED,8DAA8D;AAC9D,SAAS,uBAAuB,CAAC,EAAsB;IACrD,MAAM,OAAO,GAA4B,EAAE,CAAC;IAC5C,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC;IACtB,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC;IAC1B,OAAO,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC;IAClC,IAAI,EAAE,CAAC,aAAa,KAAK,SAAS;QAAE,OAAO,CAAC,eAAe,CAAC,GAAG,EAAE,CAAC,aAAa,CAAC;IAChF,IAAI,EAAE,CAAC,OAAO,KAAK,SAAS;QAAE,OAAO,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC;IAC9D,IAAI,EAAE,CAAC,IAAI,KAAK,SAAS;QAAE,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC;IACrD,IAAI,EAAE,CAAC,SAAS,KAAK,SAAS;QAAE,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC;IACpE,IAAI,EAAE,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QAC7B,OAAO,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YACxC,MAAM,GAAG,GAA4B,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC;YAClD,IAAI,CAAC,CAAC,OAAO,KAAK,SAAS;gBAAE,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC;YACxD,IAAI,CAAC,CAAC,IAAI,KAAK,SAAS;gBAAE,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;YAC/C,IAAI,CAAC,CAAC,WAAW,KAAK,SAAS;gBAAE,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,WAAW,CAAC;YACpE,IAAI,CAAC,CAAC,SAAS,KAAK,SAAS;gBAAE,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC;YAC9D,OAAO,GAAG,CAAC;QACb,CAAC,CAAC,CAAC;IACL,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/sql/extract-sql.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Prefer fenced ```sql blocks; otherwise use trimmed prose if it resembles a single SELECT.
+ */
+export declare function extractSqlFromModelText(raw: string): string;
+//# sourceMappingURL=extract-sql.d.ts.map

package/dist/sql/extract-sql.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"extract-sql.d.ts","sourceRoot":"","sources":["../../src/sql/extract-sql.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAO3D"}

package/dist/sql/extract-sql.js

@@ -0,0 +1,12 @@
+/**
+ * Prefer fenced ```sql blocks; otherwise use trimmed prose if it resembles a single SELECT.
+ */
+export function extractSqlFromModelText(raw) {
+    const text = raw.trim();
+    const fence = /```(?:sql)?\s*([\s\S]*?)```/im.exec(text);
+    if (fence?.[1]) {
+        return fence[1].trim();
+    }
+    return text.trim();
+}
+//# sourceMappingURL=extract-sql.js.map

package/dist/sql/extract-sql.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extract-sql.js","sourceRoot":"","sources":["../../src/sql/extract-sql.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,UAAU,uBAAuB,CAAC,GAAW;IACjD,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC;IACxB,MAAM,KAAK,GAAG,+BAA+B,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzD,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACf,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACzB,CAAC;IACD,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;AACrB,CAAC"}

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@askdb/core",
+  "version": "0.5.0-beta.0",
+  "description": "AskDB core: dialect-agnostic NL→SQL pipeline. Provides ask() orchestration, schema/IR types, modes, logging, and retrieval input. Bring your own dialect (e.g. @askdb/postgres).",
+  "keywords": [
+    "askdb",
+    "nl-to-sql",
+    "natural-language-to-sql",
+    "ai",
+    "llm",
+    "ai-sdk",
+    "schema-v2"
+  ],
+  "homepage": "https://github.com/Ygilany/AskDB#readme",
+  "bugs": {
+    "url": "https://github.com/Ygilany/AskDB/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Ygilany/AskDB.git",
+    "directory": "packages/core"
+  },
+  "license": "Apache-2.0",
+  "author": "Yahya Gilany",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE",
+    "NOTICE"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "dependencies": {
+    "@ai-sdk/azure": "^1.3.25",
+    "@ai-sdk/openai": "^1.3.21",
+    "ai": "^4.3.19",
+    "gray-matter": "^4.0.3",
+    "pino": "^9.6.0",
+    "zod": "^3.24.4"
+  },
+  "devDependencies": {
+    "typescript": "^5.7.3",
+    "vitest": "^3.0.9"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "lint": "tsc -p tsconfig.build.json --noEmit",
+    "test": "vitest run --config ../../vitest.config.ts"
+  }
+}