@lakeql/schema-generator 0.1.0 → 0.1.2

package/README.md

@@ -0,0 +1,17 @@
+# @lakeql/schema-generator
+
+Generates GraphQL schema models, JSON Schemas, and Hive table definitions from parsed column structures.
+
+## Installation
+
+```bash
+pnpm add @lakeql/schema-generator
+```
+
+## Documentation
+
+See the [LakeQL Documentation](https://lakeql.dev/docs) for detailed usage instructions.
+
+## License
+
+[Apache-2.0](../../LICENSE)

package/dist/graphql-schema.d.mts

@@ -42,29 +42,52 @@ type FieldDefinitionResponse = {
   subModel: JSONSchema7;
   filter: boolean;
 };
+/**
+ * Parameters for generateModel.
+ */
+interface GenerateModelProps {
+  /** The JSON Schema source definition to generate a model from. */
+  source: JSONSchema7;
+  /** The name of the model being generated. */
+  name: string;
+  /** The parent model name for nested models. */
+  parent?: string;
+  /** Accumulated model definitions. */
+  models: Record<string, ModelResponse>;
+  /** Whether this is the root model definition. */
+  isRoot: boolean;
+}
+/**
+ * Generates a GraphQL model definition from JSON Schema.
+ */
 declare const generateModel: ({
   source,
   name,
   parent,
   models,
   isRoot
-}: {
-  source: JSONSchema7;
-  name: string;
+}: GenerateModelProps) => Record<string, ModelResponse>;
+/**
+ * Parameters for generateFieldDefinition.
+ */
+interface GenerateFieldDefinitionProps {
+  /** The sanitized field name. */
+  fieldName: string;
+  /** The original raw field name from the schema. */
+  rawFieldName: string;
+  /** The JSON Schema definition for this field. */
+  fieldDefinition: JSONSchema7;
+  /** The parent model name for generating nested type references. */
   parent?: string;
-  models: Record<string, ModelResponse>;
-  isRoot: boolean;
-}) => Record<string, ModelResponse>;
+}
+/**
+ * Generates field definitions for a single model property.
+ */
 declare const generateFieldDefinition: ({
   fieldName,
   rawFieldName,
   fieldDefinition,
   parent
-}: {
-  fieldName: string;
-  rawFieldName: string;
-  fieldDefinition: JSONSchema7;
-  parent?: string;
-}) => FieldDefinitionResponse;
+}: GenerateFieldDefinitionProps) => FieldDefinitionResponse;
 //#endregion
-export { CurrentModelResponse, FieldDefinitionResponse, FilterFieldInput, ModelResponse, generateFieldDefinition, generateModel };
+export { CurrentModelResponse, FieldDefinitionResponse, FilterFieldInput, GenerateFieldDefinitionProps, GenerateModelProps, ModelResponse, generateFieldDefinition, generateModel };

package/dist/hive-table.d.mts

@@ -13,28 +13,56 @@ type ParquetField = Record<string, string | [string, ParquetField] | [string, {
     element: ParquetField;
   };
 }]>;
+/**
+ * Parameters for generateSqlSchema.
+ */
+interface GenerateSqlSchemaProps {
+  /** The JSON Schema property definitions to generate SQL columns from. */
+  definition: Record<string, SchemaDefinition>;
+}
+/**
+ * Generates SQL column definitions from parsed columns.
+ */
 declare function generateSqlSchema({
   definition
-}: {
-  definition: Record<string, SchemaDefinition>;
-}): SqlFieldDefinition[];
+}: GenerateSqlSchemaProps): SqlFieldDefinition[];
+/**
+ * Parameters for parquetTransformer.
+ */
+interface ParquetTransformerProps {
+  /** The JSON Schema property definitions to transform for Parquet format. */
+  definition: Record<string, JSONSchema7>;
+}
+/**
+ * Transforms column definitions for Parquet format.
+ */
 declare function parquetTransformer({
   definition
-}: {
-  definition: Record<string, JSONSchema7>;
-}): ParquetField;
+}: ParquetTransformerProps): ParquetField;
+/**
+ * Parameters for generateCreateTableStatement.
+ */
+interface GenerateCreateTableStatementProps {
+  /** The Hive schema name. */
+  schema: string;
+  /** The table name. */
+  tableName: string;
+  /** The S3 bucket name for external storage. */
+  bucketName: string;
+  /** The path within the S3 bucket. */
+  bucketPath: string;
+  /** The JSON Schema property definitions for table columns. */
+  definition: Record<string, SchemaDefinition>;
+}
+/**
+ * Generates a full CREATE TABLE DDL statement.
+ */
 declare function generateCreateTableStatement({
   schema,
   tableName,
   bucketName,
   bucketPath,
   definition
-}: {
-  schema: string;
-  tableName: string;
-  bucketName: string;
-  bucketPath: string;
-  definition: Record<string, SchemaDefinition>;
-}): string;
+}: GenerateCreateTableStatementProps): string;
 //#endregion
-export { generateCreateTableStatement, generateSqlSchema, parquetTransformer };
+export { GenerateCreateTableStatementProps, GenerateSqlSchemaProps, ParquetTransformerProps, generateCreateTableStatement, generateSqlSchema, parquetTransformer };

package/package.json

@@ -1,6 +1,15 @@
 {
   "name": "@lakeql/schema-generator",
-  "version": "0.1.0",
+  "version": "0.1.2",
+  "description": "Generates GraphQL schemas, Hive table definitions, and JSON schemas from Trino metadata",
+  "keywords": [
+    "codegen",
+    "graphql",
+    "hive",
+    "json-schema",
+    "lakeql",
+    "schema"
+  ],
   "homepage": "https://lakeql.dev",
   "license": "Apache-2.0",
   "author": {
@@ -41,7 +50,7 @@
     "kysely": "0.29.2",
     "lodash-es": "4.18.1",
     "magic-regexp": "0.11.0",
-    "@lakeql/helpers": "0.1.0"
+    "@lakeql/helpers": "0.1.2"
   },
   "devDependencies": {
     "@types/json-schema": "7.0.15",