@lakeql/file-generator 0.1.0 → 0.1.2

package/README.md

@@ -0,0 +1,17 @@
+# @lakeql/file-generator
+
+Generates TypeScript source files (configs, interfaces, query schemas) from parsed table models using the TypeScript Compiler API.
+
+## Installation
+
+```bash
+pnpm add @lakeql/file-generator
+```
+
+## Documentation
+
+See the [LakeQL Documentation](https://lakeql.dev/docs) for detailed usage instructions.
+
+## License
+
+[Apache-2.0](../../LICENSE)

package/dist/config-registry.d.mts

@@ -1,10 +1,18 @@
 import ts from "typescript";
 
 //#region src/config-registry.d.ts
+/**
+ * Parameters for generateConfigReqistry.
+ */
+interface GenerateConfigReqistryProps {
+  /** Relative paths to individual table config modules. */
+  configPaths: string[];
+}
+/**
+ * Generates the config registry aggregating all table configs.
+ */
 declare function generateConfigReqistry({
   configPaths
-}: {
-  configPaths: string[];
-}): (ts.ImportDeclaration | ts.VariableStatement | ts.TypeAliasDeclaration)[];
+}: GenerateConfigReqistryProps): (ts.VariableStatement | ts.ImportDeclaration | ts.TypeAliasDeclaration)[];
 //#endregion
-export { generateConfigReqistry };
+export { GenerateConfigReqistryProps, generateConfigReqistry };

package/dist/config.d.mts

@@ -1,18 +1,30 @@
 import ts from "typescript";
 
 //#region src/config.d.ts
+/**
+ * Parameters for generateConfig.
+ */
+interface GenerateConfigProps {
+  /** The Hive catalog name. */
+  catalog: string;
+  /** The Hive schema name. */
+  schema: string;
+  /** The Hive table name. */
+  tableName: string;
+  /** The GraphQL query name for this table. */
+  queryName: string;
+  /** Optional mutation names for this table endpoint. */
+  mutationName?: string[];
+}
+/**
+ * Generates config.ts AST nodes for a table endpoint.
+ */
 declare function generateConfig({
   catalog,
   schema,
   tableName,
   queryName,
   mutationName
-}: {
-  catalog: string;
-  schema: string;
-  tableName: string;
-  queryName: string;
-  mutationName?: string[];
-}): ts.VariableStatement[];
+}: GenerateConfigProps): ts.VariableStatement[];
 //#endregion
-export { generateConfig };
+export { GenerateConfigProps, generateConfig };

package/dist/index.d.mts

@@ -1,12 +1,21 @@
 import ts from "typescript";
 
 //#region src/index.d.ts
+/**
+ * Parameters for generateCode.
+ */
+interface GenerateCodeProps {
+  /** The output file name for the generated source. */
+  fileName: string;
+  /** The TypeScript AST nodes to print and format. */
+  nodes: ts.Node[];
+}
+/**
+ * Generates formatted TypeScript source from AST nodes.
+ */
 declare function generateCode({
   fileName,
   nodes
-}: {
-  fileName: string;
-  nodes: ts.Node[];
-}): Promise<ts.SourceFile>;
+}: GenerateCodeProps): Promise<ts.SourceFile>;
 //#endregion
-export { generateCode };
+export { GenerateCodeProps, generateCode };

package/dist/query-schema.d.mts

@@ -2,6 +2,26 @@ import ts from "typescript";
 import { FilterFieldInput, ModelResponse } from "@lakeql/schema-generator/graphql-schema";
 
 //#region src/query-schema.d.ts
+/**
+ * Parameters for generateQuerySchema.
+ */
+interface GenerateQuerySchemaProps {
+  /** The model definitions keyed by model name. */
+  models: Record<string, ModelResponse>;
+  /** The GraphQL query name for this table. */
+  queryName: string;
+  /** Field name mappings for transformed fields (original to renamed). */
+  transformFields: string[][];
+  /** Filter field definitions for the query input. */
+  filterFields: FilterFieldInput[];
+  /** The GraphQL scalar types used in filters. */
+  filterTypes: string[];
+  /** Field names that contain date-time values. */
+  dateTimeFields: string[];
+}
+/**
+ * Generates the Pothos query schema AST for a table.
+ */
 declare function generateQuerySchema({
   models,
   queryName,
@@ -9,13 +29,6 @@ declare function generateQuerySchema({
   filterFields,
   filterTypes,
   dateTimeFields
-}: {
-  models: Record<string, ModelResponse>;
-  queryName: string;
-  transformFields: string[][];
-  filterFields: FilterFieldInput[];
-  filterTypes: string[];
-  dateTimeFields: string[];
-}): ts.Node[];
+}: GenerateQuerySchemaProps): ts.Node[];
 //#endregion
-export { generateQuerySchema };
+export { GenerateQuerySchemaProps, generateQuerySchema };

package/package.json

@@ -1,6 +1,14 @@
 {
   "name": "@lakeql/file-generator",
-  "version": "0.1.0",
+  "version": "0.1.2",
+  "description": "Generates TypeScript source files from Trino table metadata",
+  "keywords": [
+    "ast",
+    "codegen",
+    "lakeql",
+    "trino",
+    "typescript"
+  ],
   "homepage": "https://lakeql.dev",
   "license": "Apache-2.0",
   "author": {
@@ -52,15 +60,15 @@
   },
   "dependencies": {
     "typescript": "6.0.3",
-    "@lakeql/helpers": "0.1.0",
-    "@lakeql/schema-generator": "0.1.0"
+    "@lakeql/helpers": "0.1.2",
+    "@lakeql/schema-generator": "0.1.2"
   },
   "devDependencies": {
     "@types/node": "24.13.2",
     "lodash-es": "4.18.1",
     "tsdown": "0.22.2",
     "vitest": "4.1.8",
-    "@lakeql/column-parser": "0.1.0",
+    "@lakeql/column-parser": "0.1.2",
     "@lakeql/tsconfig": "0.1.0"
   },
   "scripts": {