@ucdjs/schema-gen 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-PRESENT Lucas Nørgård
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,21 @@
+# @ucdjs/schema-gen
+
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+
+Utilities for working with the Unicode Character Database (UCD).
+
+## Installation
+
+```bash
+npm install @ucdjs/schema-gen
+```
+
+## 📄 License
+
+Published under [MIT License](./LICENSE).
+
+[npm-version-src]: https://img.shields.io/npm/v/@ucdjs/schema-gen?style=flat&colorA=18181B&colorB=4169E1
+[npm-version-href]: https://npmjs.com/package/@ucdjs/schema-gen
+[npm-downloads-src]: https://img.shields.io/npm/dm/@ucdjs/schema-gen?style=flat&colorA=18181B&colorB=4169E1
+[npm-downloads-href]: https://npmjs.com/package/@ucdjs/schema-gen

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+import { RawDataFile } from "@luxass/unicode-utils";
+
+//#region src/fields.d.ts
+interface GenerateFieldsOptions {
+    /**
+     * The data file to generate fields for.
+     */
+    datafile: RawDataFile;
+    /**
+     * The OpenAI API key to use for generating fields.
+     */
+    apiKey: string;
+}
+declare function generateFields(options: GenerateFieldsOptions): Promise<string | null>;
+
+//#endregion
+export { generateFields };

package/dist/index.js

@@ -0,0 +1,69 @@
+import { createOpenAI } from "@ai-sdk/openai";
+import { dedent } from "@luxass/utils";
+import { generateObject } from "ai";
+import { z } from "zod";
+
+//#region src/fields.ts
+const SYSTEM_PROMOT = dedent`
+    <system_prompt>
+      <role>Expert TypeScript code generator specializing in interfaces and documentation</role>
+
+      <task>
+        <input>Text description: {{INPUT}}</input>
+        <output>TypeScript interface with comprehensive JSDoc comments</output>
+      </task>
+
+      <requirements>
+        <field_processing>
+          - Extract all relevant fields from text
+          - Convert field names to snake_case
+          - Preserve original order
+        </field_processing>
+
+        <documentation>
+          - JSDoc for each property only
+          - Document union types with double quotes (no enums)
+          - Explain constraints and formats with examples
+          - No JSDoc for the main interface
+        </documentation>
+
+        <structure>
+          - Single interface named after the input file name without version numbers (e.g., ArabicShaping not ArabicShaping-16.0.0)
+          - No additional interfaces or arrays
+          - Create ordered keys array named [INTERFACE_NAME]_FIELDS using SCREAMING_SNAKE_CASE
+          - Convert the interface name to SCREAMING_SNAKE_CASE by inserting underscores between camelCase words
+          - Use double quotes for field names in the keys array
+          - No example data or additional declarations
+          - Export all variables and interfaces
+        </structure>
+      </requirements>
+
+      <format>Single TypeScript code block containing only the interface and fields array, both exported</format>
+
+      <examples>
+        - Interface: NamedSequences -> Fields array: NAMED_SEQUENCES_FIELDS
+        - Interface: NamedSequencesProv -> Fields array: NAMED_SEQUENCES_PROV_FIELDS
+        - Interface: ArabicShaping -> Fields array: ARABIC_SHAPING_FIELDS
+      </examples>
+    </system_prompt>
+`;
+async function generateFields(options) {
+	const { datafile, apiKey } = options;
+	if (datafile.heading == null) return null;
+	if (!apiKey) return null;
+	const openai = createOpenAI({ apiKey });
+	try {
+		const result = await generateObject({
+			model: openai("gpt-4o-mini"),
+			schema: z.object({ code: z.string().describe("A TypeScript code block containing the JSDoc commented interface definition and the corresponding keys array with original casing.") }),
+			prompt: SYSTEM_PROMOT.replace("{{INPUT}}", datafile.heading)
+		});
+		return result.object.code;
+	} catch (err) {
+		console.error("error generating fields:", err);
+		return null;
+	}
+}
+
+//#endregion
+export { generateFields };

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@ucdjs/schema-gen",
+  "version": "0.1.0",
+  "type": "module",
+  "author": {
+    "name": "Lucas Nørgård",
+    "email": "lucasnrgaard@gmail.com",
+    "url": "https://luxass.dev"
+  },
+  "license": "MIT",
+  "homepage": "https://github.com/ucdjs/ucd",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ucdjs/ucd.git",
+    "directory": "packages/schema-gen"
+  },
+  "bugs": {
+    "url": "https://github.com/ucdjs/ucd/issues"
+  },
+  "exports": {
+    ".": "./dist/index.js",
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@ai-sdk/openai": "^1.3.20",
+    "@luxass/unicode-utils": "^0.4.1",
+    "@luxass/utils": "^1.4.0",
+    "ai": "^4.3.10",
+    "zod": "^3.24.3"
+  },
+  "devDependencies": {
+    "@luxass/eslint-config": "^4.18.1",
+    "eslint": "^9.25.1",
+    "publint": "^0.3.12",
+    "tsdown": "v0.9.3",
+    "typescript": "^5.8.3",
+    "vitest-testdirs": "^3.0.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "clean": "git clean -xdf dist node_modules",
+    "lint": "eslint .",
+    "typecheck": "tsc --noEmit"
+  }
+}