@amritk/generate-parsers 0.4.0 → 0.6.0

package/dist/generators/build-schema.d.ts

@@ -34,6 +34,15 @@ export type GeneratedFile = {
  * @param helpersMode - `'package'` (default) emits `import ... from '@amritk/helpers/...'`.
  *   `'embedded'` emits `import ... from './_helpers/...'` and appends the helper sources
  *   as additional `GeneratedFile` entries so the output directory is self-contained.
+ * @param helpersImportPrefix - Relative path prefix to the `_helpers/` directory in
+ *   embedded mode. Defaults to `'./'`. The recursive multi-schema build passes `'../'`,
+ *   `'../../'`, etc. so nested parsers can import from a single shared `_helpers/`
+ *   directory while the helper sources are emitted once at the output root.
+ * @param readonly - When true, every property, array, and record in the generated type
+ *   definitions is emitted as `readonly`.
+ * @param typeSuffix - Suffix appended to every type/parser name derived from a `$ref`
+ *   (e.g. `'Object'` → `ContactObject`). Defaults to `''` (no suffix). The root type name
+ *   is used verbatim and is not affected by this suffix.
  * @returns An array of generated TypeScript files
  *
  * @example
@@ -66,4 +75,4 @@ export type GeneratedFile = {
  * });
  * ```
  */
-export declare const buildSchema: (rootSchema: JSONSchema, rootTypeName: string, extensions?: SchemaExtensions, typesOnly?: boolean, logWarnings?: boolean, strict?: boolean, helpersMode?: HelpersMode) => Promise<GeneratedFile[]>;
+export declare const buildSchema: (rootSchema: JSONSchema, rootTypeName: string, extensions?: SchemaExtensions, typesOnly?: boolean, logWarnings?: boolean, strict?: boolean, helpersMode?: HelpersMode, helpersImportPrefix?: string, readonly?: boolean, typeSuffix?: string) => Promise<GeneratedFile[]>;

package/dist/generators/generate-files.d.ts

@@ -37,6 +37,23 @@ type GenerateFileOptions = {
      *   be shipped alongside the generated files.
      */
     readonly helpersMode?: HelpersMode;
+    /**
+     * Relative path prefix to the shared `_helpers/` directory in embedded mode.
+     * Defaults to `'./'`. The recursive multi-schema build passes `'../'`,
+     * `'../../'`, etc. so a nested parser can reach a single `_helpers/` directory
+     * at the output root.
+     */
+    readonly helpersImportPrefix?: string;
+    /**
+     * When true, every property, array, and record in the generated type
+     * definitions is emitted as `readonly`.
+     */
+    readonly readonly?: boolean;
+    /**
+     * Suffix appended to every type/parser name derived from a `$ref`.
+     * Defaults to `''` (no suffix). Set to e.g. `'Object'` to emit `ContactObject`.
+     */
+    readonly typeSuffix?: string;
 };
 /** Result of generating a single parser file. */
 export type GeneratedFileContent = {

package/dist/generators/generate-parser-function.d.ts

@@ -20,6 +20,11 @@ type GenerateParserOptions = {
      * with a path-aware Error. Unknown extra keys are still allowed.
      */
     readonly strict?: boolean;
+    /**
+     * Suffix appended to every type/parser name derived from a `$ref`. Must match
+     * the suffix used when generating the referenced files. Defaults to `''`.
+     */
+    readonly typeSuffix?: string;
 };
 /**
  * Generates a safe parser as an arrow function that never throws.
@@ -49,5 +54,5 @@ export declare const shapeValidatorFunctionName: (typeName: string) => string;
  * in additionalProperties). The stub is safe: parents calling it will fall
  * through to the slow path, matching the pre-deep-fast-path behavior.
  */
-export declare const generateShapeValidator: (schema: JSONSchema, typeName: string, useRefImports: boolean) => string;
+export declare const generateShapeValidator: (schema: JSONSchema, typeName: string, useRefImports: boolean, suffix?: string) => string;
 export {};

package/dist/helpers/collect-helpers.d.ts

@@ -12,5 +12,12 @@ export type CollectedHelpers = {
      */
     readonly used: Set<RuntimeHelperName>;
 };
-/** Detects which runtime helpers a generated parser body references. */
-export declare const collectHelpers: (parserFunction: string, mode: HelpersMode) => CollectedHelpers;
+/**
+ * Detects which runtime helpers a generated parser body references.
+ *
+ * @param helpersImportPrefix - Relative path prefix to the shared `_helpers/`
+ *   directory in embedded mode. Defaults to `'./'`. The recursive multi-schema
+ *   build passes `'../'`, `'../../'`, etc. so nested parsers can reach a single
+ *   `_helpers/` directory at the output root.
+ */
+export declare const collectHelpers: (parserFunction: string, mode: HelpersMode, helpersImportPrefix?: string) => CollectedHelpers;

package/dist/helpers/collect-imports.d.ts

@@ -20,6 +20,12 @@ type CollectImportsOptions = {
      * imports for external schemas that were never generated as files.
      */
     readonly rootSchema?: Record<string, unknown> | undefined;
+    /**
+     * Suffix appended to every type name derived from a `$ref`. Must match the
+     * suffix used when generating the referenced files so imports resolve.
+     * Defaults to `''` (no suffix).
+     */
+    readonly typeSuffix?: string;
 };
 /**
  * Collects all import statements needed for a schema by finding $ref references

package/dist/index.d.ts

@@ -1 +1 @@
-export { buildSchema } from './generators/build-schema';
+export { buildSchema, type GeneratedFile } from './generators/build-schema';