@lakeql/schema-generator 0.4.1 → 0.4.3

package/dist/endpoint-schema.d.mts

@@ -54,7 +54,10 @@ type PartitioningValue = boolean | string;
 interface MutationConfig {
   /** Load strategy for the write pipeline. */
   loadStrategy: LoadStrategy;
-  /** Storage adapter type. Defaults to "s3". */
+  /**
+   * Storage adapter type.
+   * @default "s3"
+   */
   type: StorageType;
   /** S3/MinIO bucket name for endpoint data. */
   bucket: string;
@@ -64,9 +67,15 @@ interface MutationConfig {
   region?: string;
   /** Optional custom endpoint. Required for MinIO, optional for S3. */
   endpoint?: string;
-  /** Partitioning mode. Default: true */
+  /**
+   * Partitioning mode. `true` partitions by write timestamp, `false` disables partitioning, or a string for field-based/custom partitioning.
+   * @default true
+   */
   partitioning?: PartitioningValue;
-  /** Partition path granularity. Default: "year/month/day" */
+  /**
+   * Partition path granularity. One of `"year"`, `"year/month"`, or `"year/month/day"`.
+   * @default "year/month/day"
+   */
   partitioningFormat?: string;
 }
 /**
@@ -137,10 +146,21 @@ type FieldValidation = {
  * Field-level options for mutation input validation.
  */
 interface FieldOptions {
-  /** Whether the field is required in mutation input. Default: false. */
+  /**
+   * Whether the field is required in mutation input.
+   * @default false
+   */
   required?: boolean;
-  /** Validation refinements to apply via Zod. */
+  /**
+   * Validation refinements to apply via Zod at runtime.
+   * @default []
+   */
   validations?: FieldValidation[];
+  /**
+   * Whether the field is read-only. Read-only fields appear in the query schema and Hive DDL but are excluded from the mutation input type.
+   * @default false
+   */
+  readOnly?: boolean;
 }
 /**
  * Zod schema for field validation refinements.

package/dist/endpoint-schema.mjs

@@ -1 +1 @@
-import{z as e}from"zod";const t=/^[a-zA-Z_][a-zA-Z0-9_]{0,63}$/u,n=/^[a-zA-Z_][a-zA-Z0-9_]{0,127}$/u,r=[`full_load`,`full_load_append`,`append`],i=[`s3`,`minio`],a=[`year`,`year/month`,`year/month/day`],o=[`year`,`month`,`day`,`hour`,`minute`,`second`];function s(e){if(!(e.includes(`/`)||e.includes(`:`)))return t.test(e)?null:`Invalid partition field name "${e}". Must match pattern: letters/underscores, no leading digit, max 64 chars.`;let n=e.split(`/`);for(let r of n){if(r===``)return`Invalid partition format: empty segment found in "${e}".`;if(r.includes(`:`)){let e=r.split(`:`);if(e.length!==2)return`Invalid partition segment "${r}": expected format "fieldname:component".`;let[n,i]=e;if(!t.test(n))return`Invalid field name "${n}" in partition segment "${r}".`;if(!o.includes(i))return`Invalid date component "${i}" in partition segment "${r}". Expected one of: ${o.join(`, `)}.`}else if(!t.test(r))return`Invalid field name "${r}" in partition format.`}return null}const c=e.object({loadStrategy:e.enum(r),type:e.enum(i).default(`s3`),bucket:e.string().min(1),basePath:e.string().min(1),region:e.string().optional(),endpoint:e.string().optional(),partitioning:e.union([e.boolean(),e.string().min(1)]).optional(),partitioningFormat:e.string().optional()}).superRefine((e,t)=>{if(e.type===`minio`&&!e.endpoint&&t.addIssue({code:`custom`,path:[`endpoint`],message:`Endpoint is required when storage type is 'minio'. Provide the MinIO server URL (e.g. http://minio:9000).`}),e.partitioning!==!1){if(typeof e.partitioning==`string`){let n=s(e.partitioning);if(n){t.addIssue({code:`custom`,path:[`partitioning`],message:n});return}if(e.partitioning.includes(`/`)||e.partitioning.includes(`:`))return}e.partitioningFormat!==void 0&&!a.includes(e.partitioningFormat)&&t.addIssue({code:`invalid_value`,values:[...a],path:[`partitioningFormat`],message:`Invalid partitioning format. Expected one of: ${a.join(`, `)}`})}}),l=e.union([e.literal(!1),c]),u=[`String`,`Integer`,`Float`,`Boolean`,`Date`,`DateTime`],d=e.union([e.object({type:e.literal(`email`)}),e.object({type:e.literal(`url`)}),e.object({type:e.literal(`uuid`)}),e.object({type:e.literal(`min`),value:e.number()}),e.object({type:e.literal(`max`),value:e.number()}),e.object({type:e.literal(`regex`),pattern:e.string()})]),f=e.object({required:e.boolean().optional(),validations:e.array(d).optional()}),p=e.lazy(()=>e.discriminatedUnion(`type`,[e.object({name:e.string().regex(t),type:e.literal(`String`),options:f.optional()}),e.object({name:e.string().regex(t),type:e.literal(`Integer`),options:f.optional()}),e.object({name:e.string().regex(t),type:e.literal(`Float`),options:f.optional()}),e.object({name:e.string().regex(t),type:e.literal(`Boolean`),options:f.optional()}),e.object({name:e.string().regex(t),type:e.literal(`Date`),options:f.optional()}),e.object({name:e.string().regex(t),type:e.literal(`DateTime`),options:f.optional()}),e.object({name:e.string().regex(t),type:e.literal(`Object`),fields:e.array(p).min(1),options:f.optional()}),e.object({name:e.string().regex(t),type:e.literal(`Array`),items:e.union([e.object({type:e.enum(u)}),e.object({type:e.literal(`Object`),fields:e.array(p).min(1)})]),options:f.optional()})])),m=e.object({version:e.literal(`1.0`),tableName:e.string().regex(n),catalog:e.string().regex(n),schema:e.string().regex(n),fields:e.array(p),mutation:l.optional()});function h(e,t=[]){let n=[],r=new Set;for(let i of e)r.has(i.name)?n.push({name:i.name,path:t}):r.add(i.name),i.type===`Object`&&i.fields&&n.push(...h(i.fields,[...t,i.name])),i.type===`Array`&&i.items?.type===`Object`&&i.items.fields&&n.push(...h(i.items.fields,[...t,i.name,`items`]));return n}export{m as endpointDefinitionSchema,p as fieldDefinitionSchema,t as fieldNamePattern,f as fieldOptionsSchema,d as fieldValidationSchema,h as findDuplicateFieldNames,r as loadStrategies,n as metadataFieldPattern,c as mutationConfigSchema,l as mutationSchema,o as partitioningComponents,a as partitioningFormats,u as primitiveTypes,i as storageTypes,s as validatePartitioningFormat};
+import{z as e}from"zod";const t=/^[a-zA-Z_][a-zA-Z0-9_]{0,63}$/u,n=/^[a-zA-Z_][a-zA-Z0-9_]{0,127}$/u,r=[`full_load`,`full_load_append`,`append`],i=[`s3`,`minio`],a=[`year`,`year/month`,`year/month/day`],o=[`year`,`month`,`day`,`hour`,`minute`,`second`];function s(e){if(!(e.includes(`/`)||e.includes(`:`)))return t.test(e)?null:`Invalid partition field name "${e}". Must match pattern: letters/underscores, no leading digit, max 64 chars.`;let n=e.split(`/`);for(let r of n){if(r===``)return`Invalid partition format: empty segment found in "${e}".`;if(r.includes(`:`)){let e=r.split(`:`);if(e.length!==2)return`Invalid partition segment "${r}": expected format "fieldname:component".`;let[n,i]=e;if(!t.test(n))return`Invalid field name "${n}" in partition segment "${r}".`;if(!o.includes(i))return`Invalid date component "${i}" in partition segment "${r}". Expected one of: ${o.join(`, `)}.`}else if(!t.test(r))return`Invalid field name "${r}" in partition format.`}return null}const c=e.object({loadStrategy:e.enum(r),type:e.enum(i).default(`s3`),bucket:e.string().min(1),basePath:e.string().min(1),region:e.string().optional(),endpoint:e.string().optional(),partitioning:e.union([e.boolean(),e.string().min(1)]).optional(),partitioningFormat:e.string().optional()}).superRefine((e,t)=>{if(e.type===`minio`&&!e.endpoint&&t.addIssue({code:`custom`,path:[`endpoint`],message:`Endpoint is required when storage type is 'minio'. Provide the MinIO server URL (e.g. http://minio:9000).`}),e.partitioning!==!1){if(typeof e.partitioning==`string`){let n=s(e.partitioning);if(n){t.addIssue({code:`custom`,path:[`partitioning`],message:n});return}if(e.partitioning.includes(`/`)||e.partitioning.includes(`:`))return}e.partitioningFormat!==void 0&&!a.includes(e.partitioningFormat)&&t.addIssue({code:`invalid_value`,values:[...a],path:[`partitioningFormat`],message:`Invalid partitioning format. Expected one of: ${a.join(`, `)}`})}}),l=e.union([e.literal(!1),c]),u=[`String`,`Integer`,`Float`,`Boolean`,`Date`,`DateTime`],d=e.union([e.object({type:e.literal(`email`)}),e.object({type:e.literal(`url`)}),e.object({type:e.literal(`uuid`)}),e.object({type:e.literal(`min`),value:e.number()}),e.object({type:e.literal(`max`),value:e.number()}),e.object({type:e.literal(`regex`),pattern:e.string()})]),f=e.object({required:e.boolean().optional(),validations:e.array(d).optional(),readOnly:e.boolean().optional()}),p=e.lazy(()=>e.discriminatedUnion(`type`,[e.object({name:e.string().regex(t),type:e.literal(`String`),options:f.optional()}),e.object({name:e.string().regex(t),type:e.literal(`Integer`),options:f.optional()}),e.object({name:e.string().regex(t),type:e.literal(`Float`),options:f.optional()}),e.object({name:e.string().regex(t),type:e.literal(`Boolean`),options:f.optional()}),e.object({name:e.string().regex(t),type:e.literal(`Date`),options:f.optional()}),e.object({name:e.string().regex(t),type:e.literal(`DateTime`),options:f.optional()}),e.object({name:e.string().regex(t),type:e.literal(`Object`),fields:e.array(p).min(1),options:f.optional()}),e.object({name:e.string().regex(t),type:e.literal(`Array`),items:e.union([e.object({type:e.enum(u)}),e.object({type:e.literal(`Object`),fields:e.array(p).min(1)})]),options:f.optional()})])),m=e.object({version:e.literal(`1.0`),tableName:e.string().regex(n),catalog:e.string().regex(n),schema:e.string().regex(n),fields:e.array(p),mutation:l.optional()});function h(e,t=[]){let n=[],r=new Set;for(let i of e)r.has(i.name)?n.push({name:i.name,path:t}):r.add(i.name),i.type===`Object`&&i.fields&&n.push(...h(i.fields,[...t,i.name])),i.type===`Array`&&i.items?.type===`Object`&&i.items.fields&&n.push(...h(i.items.fields,[...t,i.name,`items`]));return n}export{m as endpointDefinitionSchema,p as fieldDefinitionSchema,t as fieldNamePattern,f as fieldOptionsSchema,d as fieldValidationSchema,h as findDuplicateFieldNames,r as loadStrategies,n as metadataFieldPattern,c as mutationConfigSchema,l as mutationSchema,o as partitioningComponents,a as partitioningFormats,u as primitiveTypes,i as storageTypes,s as validatePartitioningFormat};

package/dist/graphql-schema.d.mts

@@ -57,6 +57,10 @@ interface GenerateModelProps {
   /** Whether this is the root model definition. */
   isRoot: boolean;
 }
+/**
+ * Sanitizes a raw field name into a valid GraphQL/TypeScript identifier-like key.
+ */
+declare function sanitizeFieldName(rawFieldName: string): string;
 /**
  * Generates a GraphQL model definition from JSON Schema.
  */
@@ -90,4 +94,4 @@ declare const generateFieldDefinition: ({
   parent
 }: GenerateFieldDefinitionProps) => FieldDefinitionResponse;
 //#endregion
-export { CurrentModelResponse, FieldDefinitionResponse, FilterFieldInput, GenerateFieldDefinitionProps, GenerateModelProps, ModelResponse, generateFieldDefinition, generateModel };
+export { CurrentModelResponse, FieldDefinitionResponse, FilterFieldInput, GenerateFieldDefinitionProps, GenerateModelProps, ModelResponse, generateFieldDefinition, generateModel, sanitizeFieldName };

package/dist/graphql-schema.mjs

@@ -1 +1 @@
-import e from"@lakeql/helpers/special-characters";import{capitalize as t,omit as n}from"lodash-es";const r=({source:a,name:o,parent:s,models:c={},isRoot:l=!0})=>{let u=n(a,[`additionalProperties`]),d={...c},f={};for(let[t,n]of Object.entries(u.properties)){let a=e(t).replace(`-`,`_`).replace(`.`,`_`).replace(/^(?<digit>\d)/u,`_$<digit>`),c=i({fieldDefinition:n,fieldName:a,parent:s??o,rawFieldName:t});f[a]={filter:c.filter,graphqlTplType:c.graphqlTplType,graphqlType:c.graphqlType,interfaceName:c.interfaceName,interfaceType:c.interfaceType,isArray:c.isArray??!1,name:a,nullable:!0,rawFieldName:t,transformed:a!==t},c.subModel!==!1&&Object.assign(d,r({isRoot:!1,models:d,name:a,parent:s??o,source:c.subModel}))}let p=l?o:`${s}_${t(o)}`;return d[p]={dateTimeFields:Object.values(f).filter(e=>e.graphqlType===`DateTime`).map(e=>e.rawFieldName),fields:f,interfaceName:`${p}Interface`,modelName:p,root:l,transformFields:Object.values(f).filter(e=>e.transformed).map(e=>[e.name,e.rawFieldName])},d},i=({fieldName:e,rawFieldName:n,fieldDefinition:r,parent:a})=>{let o=t(e);switch(r.type){case`string`:switch(r.format){case`date`:return{filter:!0,graphqlTplType:`'Date'`,graphqlType:`Date`,interfaceType:`Date`,subModel:!1};case`date-time`:return{filter:!0,graphqlTplType:`'DateTime'`,graphqlType:`DateTime`,interfaceType:`Date`,subModel:!1};default:return{filter:!0,graphqlTplType:`'String'`,graphqlType:`String`,interfaceType:`string`,subModel:!1}}case`number`:return{filter:!0,graphqlTplType:`'Float'`,graphqlType:`Float`,interfaceType:`number`,subModel:!1};case`integer`:return{filter:!0,graphqlTplType:`'Int'`,graphqlType:`Int`,interfaceType:`number`,subModel:!1};case`boolean`:return{filter:!0,graphqlTplType:`'Boolean'`,graphqlType:`Boolean`,interfaceType:`boolean`,subModel:!1};case`array`:if(r.items.type!==`object`){let t=i({fieldDefinition:r.items,fieldName:e,rawFieldName:n});return{filter:!1,graphqlTplType:`['${t.graphqlType}']`,graphqlType:`[${t.graphqlType}]`,interfaceType:`${t.interfaceType}[]`,isArray:!0,subModel:!1}}return{filter:!1,graphqlTplType:`[${a}_${o}]`,graphqlType:`[${a}_${o}]`,interfaceName:`${a}_${o}Interface[]`,interfaceType:`${a}_${o}[]`,isArray:!0,subModel:r.items};case`object`:return{filter:!1,graphqlTplType:`${a}_${o}`,graphqlType:`${a}_${o}`,interfaceName:`${a}_${o}Interface`,interfaceType:`${a}_${o}`,subModel:r};default:return{filter:!1,graphqlTplType:`Null`,graphqlType:`Null`,interfaceType:`null`,subModel:!1}}};export{i as generateFieldDefinition,r as generateModel};
+import e from"@lakeql/helpers/special-characters";import{capitalize as t,omit as n}from"lodash-es";function r(t){let n=e(t).replaceAll(/[^a-zA-Z0-9_]/gu,`_`).replaceAll(/_+/gu,`_`).replaceAll(/^_+|_+$/gu,``);return n.length===0?`field`:n.replace(/^(?<digit>\d)/u,`_$<digit>`)}function i(e,t,n){if(!t.has(e))return t.add(e),e;throw Error(`Field name collision after normalization: "${n}" -> "${e}".`)}const a=({source:e,name:s,parent:c,models:l={},isRoot:u=!0})=>{let d=n(e,[`additionalProperties`]),f={...l},p=new Set,m={};for(let[e,t]of Object.entries(d.properties)){let n=i(r(e),p,e),l=o({fieldDefinition:t,fieldName:n,parent:c??s,rawFieldName:e});m[n]={filter:l.filter,graphqlTplType:l.graphqlTplType,graphqlType:l.graphqlType,interfaceName:l.interfaceName,interfaceType:l.interfaceType,isArray:l.isArray??!1,name:n,nullable:!0,rawFieldName:e,transformed:n!==e},l.subModel!==!1&&Object.assign(f,a({isRoot:!1,models:f,name:n,parent:c??s,source:l.subModel}))}let h=u?s:`${c}_${t(s)}`;return f[h]={dateTimeFields:Object.values(m).filter(e=>e.graphqlType===`DateTime`).map(e=>e.rawFieldName),fields:m,interfaceName:`${h}Interface`,modelName:h,root:u,transformFields:Object.values(m).filter(e=>e.transformed).map(e=>[e.name,e.rawFieldName])},f},o=({fieldName:e,rawFieldName:n,fieldDefinition:r,parent:i})=>{let a=t(e);switch(r.type){case`string`:switch(r.format){case`date`:return{filter:!0,graphqlTplType:`'Date'`,graphqlType:`Date`,interfaceType:`Date`,subModel:!1};case`date-time`:return{filter:!0,graphqlTplType:`'DateTime'`,graphqlType:`DateTime`,interfaceType:`Date`,subModel:!1};default:return{filter:!0,graphqlTplType:`'String'`,graphqlType:`String`,interfaceType:`string`,subModel:!1}}case`number`:return{filter:!0,graphqlTplType:`'Float'`,graphqlType:`Float`,interfaceType:`number`,subModel:!1};case`integer`:return{filter:!0,graphqlTplType:`'Int'`,graphqlType:`Int`,interfaceType:`number`,subModel:!1};case`boolean`:return{filter:!0,graphqlTplType:`'Boolean'`,graphqlType:`Boolean`,interfaceType:`boolean`,subModel:!1};case`array`:if(r.items.type!==`object`){let t=o({fieldDefinition:r.items,fieldName:e,rawFieldName:n});return{filter:!1,graphqlTplType:`['${t.graphqlType}']`,graphqlType:`[${t.graphqlType}]`,interfaceType:`${t.interfaceType}[]`,isArray:!0,subModel:!1}}return{filter:!1,graphqlTplType:`[${i}_${a}]`,graphqlType:`[${i}_${a}]`,interfaceName:`${i}_${a}Interface[]`,interfaceType:`${i}_${a}[]`,isArray:!0,subModel:r.items};case`object`:return{filter:!1,graphqlTplType:`${i}_${a}`,graphqlType:`${i}_${a}`,interfaceName:`${i}_${a}Interface`,interfaceType:`${i}_${a}`,subModel:r};default:return{filter:!1,graphqlTplType:`Null`,graphqlType:`Null`,interfaceType:`null`,subModel:!1}}};export{o as generateFieldDefinition,a as generateModel,r as sanitizeFieldName};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lakeql/schema-generator",
-  "version": "0.4.1",
+  "version": "0.4.3",
   "description": "Generates GraphQL schemas, Hive table definitions, and JSON schemas from Trino metadata",
   "keywords": [
     "codegen",
@@ -55,7 +55,7 @@
     "lodash-es": "4.18.1",
     "magic-regexp": "0.11.0",
     "zod": "4.4.3",
-    "@lakeql/helpers": "0.1.3"
+    "@lakeql/helpers": "0.1.4"
   },
   "devDependencies": {
     "@types/json-schema": "7.0.15",
@@ -63,7 +63,7 @@
     "@types/node": "24.13.2",
     "fast-check": "^4.8.0",
     "json-column-parser": "2.0.0",
-    "tsdown": "0.22.2",
+    "tsdown": "0.22.3",
     "typescript": "6.0.3",
     "vitest": "4.1.9",
     "@lakeql/tsconfig": "0.1.0"