Refactor type imports and move schema types to types.d.ts

Moved all schema-related type definitions from utils.ts to types.d.ts for better separation and maintainability. Updated imports in index.ts and plugin.ts to reference types from types.d.ts. Bumped package version to 0.5.8.

Author: JeffreyNijs

index.ts

@@ -1,6 +1,6 @@
 import {JSONSchemaFaker} from 'json-schema-faker'
 import type { Schema} from 'json-schema-faker'
-import type { BuilderOptions } from './utils'
+import type { BuilderOptions } from './types'
 
 export interface JSFOptions {
     useDefaultValue?: boolean

package.json

@@ -1,6 +1,6 @@
 {
   "name": "hey-api-builders",
-  "version": "0.5.7",
+  "version": "0.5.8",
   "description": "A custom plugin for @hey-api/openapi-ts that wraps JSON Schema Faker to generate builders.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

plugin.ts

@@ -1,5 +1,5 @@
 import { collectSchemas, generateWithMethods } from './utils';
-import type { BuildersHandler } from './utils';
+import type { BuildersHandler } from './types';
 import type { IR } from '@hey-api/openapi-ts';
 
 export const handler: BuildersHandler = ({ plugin }) => {

types.d.ts

@@ -1,4 +1,6 @@
 import {DefinePlugin} from "@hey-api/openapi-ts";
+import type { IR } from '@hey-api/openapi-ts';
+import type { Schema } from 'json-schema-faker';
 
 export interface Config {
     /**
@@ -20,3 +22,72 @@ export interface Config {
 }
 
 export type BuildersPlugin = DefinePlugin<Config>
+
+// Schema-related types moved from utils.ts
+export interface BuilderOptions {
+  useDefault?: boolean;
+  useExamples?: boolean;
+  alwaysIncludeOptionals?: boolean;
+  optionalsProbability?: number | false;
+  omitNulls?: boolean;
+}
+
+export interface GeneratedSchemaMeta {
+  typeName: string;
+  constName: string;
+  isEnum: boolean;
+  schema: Schema;
+  isObject: boolean;
+}
+
+export interface EnumSchemaObject {
+  enum?: JsonValue[];
+  type?: string | 'enum';
+  items?: EnumItem[] | IR.SchemaObject | IR.SchemaObject[];
+  nullable?: boolean;
+  $ref?: string;
+  properties?: Record<string, IR.SchemaObject>;
+  required?: string[];
+  additionalProperties?: boolean | IR.SchemaObject;
+  allOf?: IR.SchemaObject[];
+  anyOf?: IR.SchemaObject[];
+  oneOf?: IR.SchemaObject[];
+  [key: string]: unknown;
+}
+
+export interface EnumItem {
+  const: JsonValue;
+  description?: string;
+}
+
+export type JsonValue = string | number | boolean | null | JsonValue[] | { [key: string]: JsonValue };
+
+export interface ExtendedSchema {
+  type?: 'null' | 'boolean' | 'object' | 'array' | 'number' | 'string' | 'integer' | Array<'null' | 'boolean' | 'object' | 'array' | 'number' | 'string' | 'integer'>;
+  properties?: Record<string, Schema>;
+  required?: string[];
+  additionalProperties?: boolean | Schema;
+  items?: Schema | Schema[];
+  allOf?: Schema[];
+  anyOf?: Schema[];
+  oneOf?: Schema[];
+  enum?: JsonValue[];
+  nullable?: boolean;
+  [key: string]: unknown;
+}
+
+export interface NormalizedSchemaNode {
+  type?: 'null' | 'boolean' | 'object' | 'array' | 'number' | 'string' | 'integer' | 'enum' | Array<'null' | 'boolean' | 'object' | 'array' | 'number' | 'string' | 'integer'>;
+  items?: NormalizedSchemaNode | NormalizedSchemaNode[];
+  properties?: Record<string, NormalizedSchemaNode>;
+  additionalProperties?: boolean | NormalizedSchemaNode;
+  allOf?: NormalizedSchemaNode[];
+  anyOf?: NormalizedSchemaNode[];
+  oneOf?: NormalizedSchemaNode[];
+  enum?: JsonValue[];
+  logicalOperator?: string;
+  const?: JsonValue;
+  [key: string]: unknown;
+}
+
+export type BuildersHandler = BuildersPlugin['Handler'];

utils.ts

@@ -1,72 +1,16 @@
 import type { IR } from '@hey-api/openapi-ts';
-import type { BuildersPlugin } from './types';
 import type { Schema } from 'json-schema-faker';
-
-export interface BuilderOptions {
-  useDefault?: boolean;
-  useExamples?: boolean;
-  alwaysIncludeOptionals?: boolean;
-  optionalsProbability?: number | false;
-  omitNulls?: boolean;
-}
-
-export interface GeneratedSchemaMeta {
-  typeName: string;
-  constName: string;
-  isEnum: boolean;
-  schema: Schema;
-  isObject: boolean;
-}
-
-interface EnumSchemaObject {
-  enum?: JsonValue[];
-  type?: string | 'enum';
-  items?: EnumItem[] | IR.SchemaObject | IR.SchemaObject[];
-  nullable?: boolean;
-  $ref?: string;
-  properties?: Record<string, IR.SchemaObject>;
-  required?: string[];
-  additionalProperties?: boolean | IR.SchemaObject;
-  allOf?: IR.SchemaObject[];
-  anyOf?: IR.SchemaObject[];
-  oneOf?: IR.SchemaObject[];
-  [key: string]: unknown;
-}
-
-interface EnumItem {
-  const: JsonValue;
-  description?: string;
-}
-
-type JsonValue = string | number | boolean | null | JsonValue[] | { [key: string]: JsonValue };
-
-interface ExtendedSchema {
-  type?: 'null' | 'boolean' | 'object' | 'array' | 'number' | 'string' | 'integer' | Array<'null' | 'boolean' | 'object' | 'array' | 'number' | 'string' | 'integer'>;
-  properties?: Record<string, Schema>;
-  required?: string[];
-  additionalProperties?: boolean | Schema;
-  items?: Schema | Schema[];
-  allOf?: Schema[];
-  anyOf?: Schema[];
-  oneOf?: Schema[];
-  enum?: JsonValue[];
-  nullable?: boolean;
-  [key: string]: unknown;
-}
-
-interface NormalizedSchemaNode {
-  type?: 'null' | 'boolean' | 'object' | 'array' | 'number' | 'string' | 'integer' | 'enum' | Array<'null' | 'boolean' | 'object' | 'array' | 'number' | 'string' | 'integer'>;
-  items?: NormalizedSchemaNode | NormalizedSchemaNode[];
-  properties?: Record<string, NormalizedSchemaNode>;
-  additionalProperties?: boolean | NormalizedSchemaNode;
-  allOf?: NormalizedSchemaNode[];
-  anyOf?: NormalizedSchemaNode[];
-  oneOf?: NormalizedSchemaNode[];
-  enum?: JsonValue[];
-  logicalOperator?: string;
-  const?: JsonValue;
-  [key: string]: unknown;
-}
+import type {
+  BuildersPlugin,
+  BuilderOptions,
+  GeneratedSchemaMeta,
+  EnumSchemaObject,
+  EnumItem,
+  JsonValue,
+  ExtendedSchema,
+  NormalizedSchemaNode,
+  BuildersHandler
+} from './types';
 
 export function irToSchema(
   ir: IR.SchemaObject,
@@ -307,5 +251,3 @@ export function generateWithMethods(schema: Schema, typeName: string): string {
     .map(p => `  with${toPascal(p)}(value: types.${typeName}["${p}"]): this { this.overrides["${p}"] = value; return this; }`)
     .join('\n');
 }
-
-export type BuildersHandler = BuildersPlugin['Handler'];