@amritk/generate-parsers 0.3.0 → 0.4.0

package/dist/index.js

@@ -375,6 +375,31 @@ var isSchemaObject2 = (schema) => {
 var isObjectSchema = (schema) => {
   return isSchemaObject2(schema) && (("type" in schema) && schema.type === "object" || ("properties" in schema));
 };
+var MJST_EXTENSION_KEY = "x-mjst";
+var IDENTIFIER = /^[A-Za-z_$][A-Za-z0-9_$]*$/;
+var SUPPORTED_PRIMITIVES = new Set(["bigint"]);
+var SAFE_BRAND = /^[\w$ -]+$/;
+var readExtensionString = (schema, field) => {
+  if (!isSchemaObject2(schema))
+    return;
+  const extension = schema[MJST_EXTENSION_KEY];
+  if (typeof extension !== "object" || extension === null)
+    return;
+  const value = extension[field];
+  return typeof value === "string" ? value : undefined;
+};
+var getMjstInstanceOf = (schema) => {
+  const instanceOf = readExtensionString(schema, "instanceOf");
+  return instanceOf !== undefined && IDENTIFIER.test(instanceOf) ? instanceOf : undefined;
+};
+var getMjstPrimitive = (schema) => {
+  const primitive = readExtensionString(schema, "primitive");
+  return primitive !== undefined && SUPPORTED_PRIMITIVES.has(primitive) ? primitive : undefined;
+};
+var getMjstBrand = (schema) => {
+  const brand = readExtensionString(schema, "brand");
+  return brand !== undefined && SAFE_BRAND.test(brand) ? brand : undefined;
+};
 var toKebabCase4 = (value) => value.replace(/OAuth/g, "Oauth").replace(/([A-Z]+)([A-Z][a-z])/g, "$1-$2").replace(/([a-z\d])([A-Z])/g, "$1-$2").toLowerCase();
 var uriRefToFilename4 = (uri) => {
   const hashIndex = uri.indexOf("#");
@@ -516,12 +541,25 @@ var buildJsDocBlock = (title, description, commentUrl) => {
   return block;
 };
 var getTypeScriptType = (schema) => {
+  const base = getUnbrandedType(schema);
+  const brand = getMjstBrand(schema);
+  return brand ? `(${base} & { readonly __brand: '${brand}' })` : base;
+};
+var getUnbrandedType = (schema) => {
   if (typeof schema === "boolean") {
     return getBooleanSubSchemaType(schema);
   }
   if (typeof schema !== "object" || schema === null) {
     return "unknown";
   }
+  const instanceOf = getMjstInstanceOf(schema);
+  if (instanceOf) {
+    return instanceOf;
+  }
+  const primitive = getMjstPrimitive(schema);
+  if (primitive) {
+    return primitive;
+  }
   if (schema.$ref) {
     if (!schema.$ref.startsWith("#")) {
       return "unknown";
@@ -1082,6 +1120,31 @@ var safeKey2 = (key) => {
   return `'${key}'`;
 };
 
+// ../helpers/dist/mjst-extension.js
+var isSchemaObject4 = (schema) => {
+  return typeof schema === "object" && schema !== null && typeof schema !== "boolean";
+};
+var MJST_EXTENSION_KEY2 = "x-mjst";
+var IDENTIFIER2 = /^[A-Za-z_$][A-Za-z0-9_$]*$/;
+var SUPPORTED_PRIMITIVES2 = new Set(["bigint"]);
+var readExtensionString2 = (schema, field) => {
+  if (!isSchemaObject4(schema))
+    return;
+  const extension = schema[MJST_EXTENSION_KEY2];
+  if (typeof extension !== "object" || extension === null)
+    return;
+  const value = extension[field];
+  return typeof value === "string" ? value : undefined;
+};
+var getMjstInstanceOf2 = (schema) => {
+  const instanceOf = readExtensionString2(schema, "instanceOf");
+  return instanceOf !== undefined && IDENTIFIER2.test(instanceOf) ? instanceOf : undefined;
+};
+var getMjstPrimitive2 = (schema) => {
+  const primitive = readExtensionString2(schema, "primitive");
+  return primitive !== undefined && SUPPORTED_PRIMITIVES2.has(primitive) ? primitive : undefined;
+};
+
 // src/generators/generate-default-from-pattern.ts
 var generateDefaultFromPattern = (pattern) => {
   if (pattern.includes("@") || pattern.includes("[a-zA-Z0-9]") && pattern.includes("\\.")) {
@@ -1139,6 +1202,9 @@ var getDefaultValue = (schema) => {
       return getDefaultValue(firstSchema);
     }
   }
+  if (getMjstPrimitive2(schema) === "bigint") {
+    return "0n";
+  }
   if (!hasType(schema)) {
     return "undefined";
   }
@@ -1234,6 +1300,24 @@ var generatePropertyAssertion = (key, propSchema, isRequired, typeName) => {
     return lines;
   if (hasRef(propSchema))
     return lines;
+  const instanceOf = getMjstInstanceOf2(propSchema);
+  if (instanceOf) {
+    if (isRequired) {
+      lines.push(`  if (!(${acc} instanceof ${instanceOf})) throw new Error('[${typeName}] field "${key}" must be ${instanceOf}');`);
+    } else {
+      lines.push(`  if (${acc} !== undefined && !(${acc} instanceof ${instanceOf})) throw new Error('[${typeName}] field "${key}" must be ${instanceOf}');`);
+    }
+    return lines;
+  }
+  const primitive = getMjstPrimitive2(propSchema);
+  if (primitive) {
+    if (isRequired) {
+      lines.push(`  if (typeof ${acc} !== "${primitive}") throw new Error('[${typeName}] field "${key}" must be ${primitive}');`);
+    } else {
+      lines.push(`  if (${acc} !== undefined && typeof ${acc} !== "${primitive}") throw new Error('[${typeName}] field "${key}" must be ${primitive}');`);
+    }
+    return lines;
+  }
   if (hasEnum(propSchema)) {
     const allowed = JSON.stringify(propSchema.enum);
     const label = propSchema.enum.map((v) => JSON.stringify(v)).join(", ");
@@ -1270,6 +1354,14 @@ var generateObjectStrictAssertion = (schema, typeName) => {
   return lines;
 };
 var generateScalarStrictAssertion = (schema, typeName) => {
+  const instanceOf = getMjstInstanceOf2(schema);
+  if (instanceOf) {
+    return `  if (!(input instanceof ${instanceOf})) throw new Error(\`[${typeName}] expected ${instanceOf}, got \${input === null ? "null" : typeof input}\`);`;
+  }
+  const primitive = getMjstPrimitive2(schema);
+  if (primitive) {
+    return `  if (typeof input !== "${primitive}") throw new Error(\`[${typeName}] expected ${primitive}, got \${input === null ? "null" : typeof input}\`);`;
+  }
   if (!isSchemaObject3(schema) || !hasType(schema))
     return null;
   const t = schema.type;
@@ -1329,6 +1421,14 @@ var generateEnumCheck = (accessor, enumValues) => {
 // src/generators/generate-schema-checks.ts
 var generateSchemaChecks = (accessor, schema) => {
   const checks = [];
+  const instanceOf = getMjstInstanceOf2(schema);
+  if (instanceOf) {
+    return [`${accessor} instanceof ${instanceOf}`];
+  }
+  const primitive = getMjstPrimitive2(schema);
+  if (primitive) {
+    return [`typeof ${accessor} === "${primitive}"`];
+  }
   if (!hasType(schema)) {
     return checks;
   }
@@ -1461,6 +1561,11 @@ var generateNonDiscriminatedUnionValidation = (accessor, schemas, defaultValue,
 };
 
 // src/generators/generate-validation-expression.ts
+var getInstanceCoercion = (accessor, instanceOf) => {
+  if (instanceOf === "Date")
+    return `new Date(${accessor} as string | number | Date)`;
+  return null;
+};
 var getTypeCoercion = (accessor, schema, defaultValue) => {
   if (!hasType(schema)) {
     return null;
@@ -1489,6 +1594,20 @@ var generateValidationExpression = (key, schema, defaultValue, isRequired, rootS
   if (!isSchemaObject3(schema)) {
     return isRequired ? `${accessor} ?? ${defaultValue}` : accessor;
   }
+  const instanceOf = getMjstInstanceOf2(schema);
+  if (instanceOf) {
+    const valid = `${accessor} instanceof ${instanceOf}`;
+    const coercion = getInstanceCoercion(accessor, instanceOf);
+    if (isRequired) {
+      return coercion ? `${valid} ? ${accessor} : (${accessor} !== undefined ? ${coercion} : ${defaultValue})` : `${valid} ? ${accessor} : ${defaultValue}`;
+    }
+    return coercion ? `${valid} ? ${accessor} : (${accessor} !== undefined ? ${coercion} : undefined)` : `${valid} ? ${accessor} : undefined`;
+  }
+  const primitive = getMjstPrimitive2(schema);
+  if (primitive) {
+    const valid = `typeof ${accessor} === "${primitive}"`;
+    return isRequired ? `${valid} ? ${accessor} : ${defaultValue}` : `${valid} ? ${accessor} : undefined`;
+  }
   if (hasRef(schema) && rootSchema) {
     const ref = schema.$ref;
     if (visitedRefs?.has(ref)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amritk/generate-parsers",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Generate TypeScript parsers and type definitions from JSON Schemas.",
   "module": "./dist/index.js",
   "type": "module",
@@ -48,8 +48,8 @@
     }
   },
   "dependencies": {
-    "json-schema-typed": "catalog:",
-    "@amritk/helpers": "workspace:*",
-    "@amritk/generate-markdown": "workspace:*"
+    "json-schema-typed": "^8.0.1",
+    "@amritk/helpers": "0.4.0",
+    "@amritk/generate-markdown": "0.2.1"
   }
 }

package/src/generators/generate-schema-checks.test.ts

@@ -319,4 +319,12 @@ describe('generate-schema-checks', () => {
     const result = generateSchemaChecks('input?.name', { type: 'string', minLength: 1 })
     expect(result).toEqual(['typeof input?.name === "string"', 'input?.name.length >= 1'])
   })
+
+  it('returns an instanceof check for an x-mjst instanceOf node', () => {
+    expect(generateSchemaChecks('value', { 'x-mjst': { instanceOf: 'Date' } })).toEqual(['value instanceof Date'])
+  })
+
+  it('returns a typeof check for an x-mjst bigint node', () => {
+    expect(generateSchemaChecks('value', { 'x-mjst': { primitive: 'bigint' } })).toEqual(['typeof value === "bigint"'])
+  })
 })

package/src/generators/generate-schema-checks.ts

@@ -1,3 +1,4 @@
+import { getMjstInstanceOf, getMjstPrimitive } from '@amritk/helpers/mjst-extension'
 import {
   hasAdditionalProperties,
   hasEnum,
@@ -28,6 +29,18 @@ import { generateEnumCheck } from './generate-enum-check'
 export const generateSchemaChecks = (accessor: string, schema: JSONSchema): string[] => {
   const checks: string[] = []
 
+  // x-mjst instanceOf nodes validate purely by instance check (no native type).
+  const instanceOf = getMjstInstanceOf(schema)
+  if (instanceOf) {
+    return [`${accessor} instanceof ${instanceOf}`]
+  }
+
+  // x-mjst primitive nodes (e.g. bigint) validate purely by typeof check.
+  const primitive = getMjstPrimitive(schema)
+  if (primitive) {
+    return [`typeof ${accessor} === "${primitive}"`]
+  }
+
   if (!hasType(schema)) {
     return checks
   }

package/src/generators/generate-strict-assertion.test.ts

@@ -0,0 +1,67 @@
+import { describe, expect, it } from 'vitest'
+
+import { generateObjectStrictAssertion, generateScalarStrictAssertion } from './generate-strict-assertion'
+
+describe('generate-strict-assertion x-mjst instanceOf', () => {
+  it('asserts instanceof for a required Date property', () => {
+    const schema = {
+      type: 'object' as const,
+      properties: { createdAt: { 'x-mjst': { instanceOf: 'Date' } } },
+      required: ['createdAt'],
+    }
+    const lines = generateObjectStrictAssertion(schema, 'Event').join('\n')
+
+    expect(lines).toContain('missing required property "createdAt"')
+    expect(lines).toContain('!(input.createdAt instanceof Date)')
+    expect(lines).toContain('field "createdAt" must be Date')
+  })
+
+  it('guards undefined before asserting instanceof for an optional Date property', () => {
+    const schema = {
+      type: 'object' as const,
+      properties: { createdAt: { 'x-mjst': { instanceOf: 'Date' } } },
+    }
+    const lines = generateObjectStrictAssertion(schema, 'Event').join('\n')
+
+    expect(lines).toContain('input.createdAt !== undefined && !(input.createdAt instanceof Date)')
+  })
+
+  it('asserts instanceof for a top-level Date schema', () => {
+    const line = generateScalarStrictAssertion({ 'x-mjst': { instanceOf: 'Date' } }, 'When')
+
+    expect(line).toContain('!(input instanceof Date)')
+    expect(line).toContain('expected Date')
+  })
+})
+
+describe('generate-strict-assertion x-mjst primitive', () => {
+  it('asserts typeof bigint for a required property', () => {
+    const schema = {
+      type: 'object' as const,
+      properties: { balance: { 'x-mjst': { primitive: 'bigint' } } },
+      required: ['balance'],
+    }
+    const lines = generateObjectStrictAssertion(schema, 'Account').join('\n')
+
+    expect(lines).toContain('missing required property "balance"')
+    expect(lines).toContain('typeof input.balance !== "bigint"')
+    expect(lines).toContain('field "balance" must be bigint')
+  })
+
+  it('guards undefined before asserting typeof for an optional bigint property', () => {
+    const schema = {
+      type: 'object' as const,
+      properties: { balance: { 'x-mjst': { primitive: 'bigint' } } },
+    }
+    const lines = generateObjectStrictAssertion(schema, 'Account').join('\n')
+
+    expect(lines).toContain('input.balance !== undefined && typeof input.balance !== "bigint"')
+  })
+
+  it('asserts typeof for a top-level bigint schema', () => {
+    const line = generateScalarStrictAssertion({ 'x-mjst': { primitive: 'bigint' } }, 'Big')
+
+    expect(line).toContain('typeof input !== "bigint"')
+    expect(line).toContain('expected bigint')
+  })
+})

package/src/generators/generate-strict-assertion.ts

@@ -1,3 +1,4 @@
+import { getMjstInstanceOf, getMjstPrimitive } from '@amritk/helpers/mjst-extension'
 import { safeAccessor } from '@amritk/helpers/safe-accessor'
 import {
   hasEnum,
@@ -134,6 +135,34 @@ const generatePropertyAssertion = (
   if (!isSchemaObject(propSchema)) return lines
   if (hasRef(propSchema)) return lines
 
+  const instanceOf = getMjstInstanceOf(propSchema)
+  if (instanceOf) {
+    if (isRequired) {
+      lines.push(
+        `  if (!(${acc} instanceof ${instanceOf})) throw new Error('[${typeName}] field "${key}" must be ${instanceOf}');`,
+      )
+    } else {
+      lines.push(
+        `  if (${acc} !== undefined && !(${acc} instanceof ${instanceOf})) throw new Error('[${typeName}] field "${key}" must be ${instanceOf}');`,
+      )
+    }
+    return lines
+  }
+
+  const primitive = getMjstPrimitive(propSchema)
+  if (primitive) {
+    if (isRequired) {
+      lines.push(
+        `  if (typeof ${acc} !== "${primitive}") throw new Error('[${typeName}] field "${key}" must be ${primitive}');`,
+      )
+    } else {
+      lines.push(
+        `  if (${acc} !== undefined && typeof ${acc} !== "${primitive}") throw new Error('[${typeName}] field "${key}" must be ${primitive}');`,
+      )
+    }
+    return lines
+  }
+
   if (hasEnum(propSchema)) {
     const allowed = JSON.stringify(propSchema.enum)
     const label = (propSchema.enum as unknown[]).map((v) => JSON.stringify(v)).join(', ')
@@ -202,6 +231,16 @@ export const generateObjectStrictAssertion = (schema: JSONSchema, typeName: stri
  * Returns null when the schema has no type information to assert on.
  */
 export const generateScalarStrictAssertion = (schema: JSONSchema, typeName: string): string | null => {
+  const instanceOf = getMjstInstanceOf(schema)
+  if (instanceOf) {
+    return `  if (!(input instanceof ${instanceOf})) throw new Error(\`[${typeName}] expected ${instanceOf}, got \${input === null ? "null" : typeof input}\`);`
+  }
+
+  const primitive = getMjstPrimitive(schema)
+  if (primitive) {
+    return `  if (typeof input !== "${primitive}") throw new Error(\`[${typeName}] expected ${primitive}, got \${input === null ? "null" : typeof input}\`);`
+  }
+
   if (!isSchemaObject(schema) || !hasType(schema)) return null
   const t = schema.type as string
   const wrongType = wrongTypeCondition('input', t)

package/src/generators/generate-validation-expression.test.ts

@@ -791,4 +791,41 @@ describe('generate-validation-expression', () => {
 
     expect(result).toContain('? input?.status : undefined')
   })
+
+  it('checks instanceof and coerces a required x-mjst Date field', () => {
+    const schema = { 'x-mjst': { instanceOf: 'Date' } }
+    const result = generateValidationExpression('createdAt', schema, '{}', true)
+
+    expect(result).toContain('input?.createdAt instanceof Date')
+    expect(result).toContain('new Date(input?.createdAt as string | number | Date)')
+  })
+
+  it('checks instanceof and coerces an optional x-mjst Date field', () => {
+    const schema = { 'x-mjst': { instanceOf: 'Date' } }
+    const result = generateValidationExpression('createdAt', schema, 'undefined', false)
+
+    expect(result).toContain('input?.createdAt instanceof Date')
+    expect(result).toContain('? input?.createdAt : (input?.createdAt !== undefined ? new Date')
+  })
+
+  it('falls back to the default for an unknown instanceOf with no coercion', () => {
+    const schema = { 'x-mjst': { instanceOf: 'CustomThing' } }
+    const result = generateValidationExpression('value', schema, '{}', true)
+
+    expect(result).toBe('input?.value instanceof CustomThing ? input?.value : {}')
+  })
+
+  it('checks typeof bigint for a required x-mjst primitive field', () => {
+    const schema = { 'x-mjst': { primitive: 'bigint' } }
+    const result = generateValidationExpression('balance', schema, '0n', true)
+
+    expect(result).toBe('typeof input?.balance === "bigint" ? input?.balance : 0n')
+  })
+
+  it('checks typeof bigint for an optional x-mjst primitive field', () => {
+    const schema = { 'x-mjst': { primitive: 'bigint' } }
+    const result = generateValidationExpression('balance', schema, '0n', false)
+
+    expect(result).toBe('typeof input?.balance === "bigint" ? input?.balance : undefined')
+  })
 })

package/src/generators/generate-validation-expression.ts

@@ -1,3 +1,4 @@
+import { getMjstInstanceOf, getMjstPrimitive } from '@amritk/helpers/mjst-extension'
 import { resolveRef } from '@amritk/helpers/resolve-ref'
 import { safeAccessor } from '@amritk/helpers/safe-accessor'
 import {
@@ -34,6 +35,17 @@ import { generateEnumCheck } from './generate-enum-check'
 import { generateNonDiscriminatedUnionValidation } from './generate-non-discriminated-union-validation'
 import { generateSchemaChecks } from './generate-schema-checks'
 
+/**
+ * Coercion expression for an `x-mjst` instanceOf value, when one is known.
+ * `Date` can be reconstructed from the common JSON encodings (ISO string or
+ * epoch number); other classes have no safe generic coercion, so we return null
+ * and the caller falls back to the default.
+ */
+const getInstanceCoercion = (accessor: string, instanceOf: string): string | null => {
+  if (instanceOf === 'Date') return `new Date(${accessor} as string | number | Date)`
+  return null
+}
+
 /**
  * Generates a type coercion expression for converting a value to the expected type.
  */
@@ -85,6 +97,34 @@ export const generateValidationExpression = (
     return isRequired ? `${accessor} ?? ${defaultValue}` : accessor
   }
 
+  // Handle x-mjst instanceOf (e.g. Date): the value must be an instance of the
+  // named class. Invalid values are coerced when a coercer is known, otherwise
+  // they fall back to the default (required) or undefined (optional).
+  const instanceOf = getMjstInstanceOf(schema)
+  if (instanceOf) {
+    const valid = `${accessor} instanceof ${instanceOf}`
+    const coercion = getInstanceCoercion(accessor, instanceOf)
+
+    if (isRequired) {
+      return coercion
+        ? `${valid} ? ${accessor} : (${accessor} !== undefined ? ${coercion} : ${defaultValue})`
+        : `${valid} ? ${accessor} : ${defaultValue}`
+    }
+    return coercion
+      ? `${valid} ? ${accessor} : (${accessor} !== undefined ? ${coercion} : undefined)`
+      : `${valid} ? ${accessor} : undefined`
+  }
+
+  // Handle x-mjst primitive (e.g. bigint): validate with typeof. We do not
+  // coerce — BigInt() throws on invalid input, which a pure coercion expression
+  // cannot guard — so invalid values fall back to the default (required) or
+  // undefined (optional).
+  const primitive = getMjstPrimitive(schema)
+  if (primitive) {
+    const valid = `typeof ${accessor} === "${primitive}"`
+    return isRequired ? `${valid} ? ${accessor} : ${defaultValue}` : `${valid} ? ${accessor} : undefined`
+  }
+
   // Handle $ref - resolve and validate against the referenced schema
   if (hasRef(schema) && rootSchema) {
     const ref = schema.$ref

package/src/helpers/get-default-value.test.ts

@@ -132,4 +132,8 @@ describe('get-default-value', () => {
   it('handles empty oneOf array and falls back', () => {
     expect(getDefaultValue({ oneOf: [], type: 'boolean' })).toBe('false')
   })
+
+  it('returns 0n for an x-mjst bigint schema', () => {
+    expect(getDefaultValue({ 'x-mjst': { primitive: 'bigint' } })).toBe('0n')
+  })
 })

package/src/helpers/get-default-value.ts

@@ -1,3 +1,4 @@
+import { getMjstPrimitive } from '@amritk/helpers/mjst-extension'
 import {
   hasAllOf,
   hasAnyOf,
@@ -60,6 +61,11 @@ export const getDefaultValue = (schema: JSONSchema): string => {
     }
   }
 
+  // x-mjst bigint has no native JSON type but a sensible zero default.
+  if (getMjstPrimitive(schema) === 'bigint') {
+    return '0n'
+  }
+
   if (!hasType(schema)) {
     return 'undefined'
   }