@contractspec/lib.contracts-transformers 1.44.0

package/dist/openapi/schema-converter.d.ts

@@ -0,0 +1,71 @@
+import { OpenApiSchema } from "./types.js";
+import { ContractsrcConfig, SchemaFormat } from "@contractspec/lib.contracts";
+
+//#region src/openapi/schema-converter.d.ts
+
+/**
+ * TypeScript type representation for code generation.
+ */
+interface TypescriptType {
+  /** The type expression (e.g., "string", "number", "MyModel") */
+  type: string;
+  /** Whether the type is optional */
+  optional: boolean;
+  /** Whether the type is an array */
+  array: boolean;
+  /** Whether this is a primitive type */
+  primitive: boolean;
+  /** Description for documentation */
+  description?: string;
+  /** Whether this type is a reference to another schema (needs import) vs inline */
+  isReference?: boolean;
+}
+/**
+ * SchemaModel field representation for code generation.
+ */
+interface SchemaField {
+  /** Field name */
+  name: string;
+  /** Field type */
+  type: TypescriptType;
+  /** Scalar type enum value (for FieldType) */
+  scalarType?: string;
+  /** Enum values if this is an enum type */
+  enumValues?: string[];
+  /** Nested model if this is an object type */
+  nestedModel?: GeneratedModel;
+}
+/**
+ * Generated model representation.
+ */
+interface GeneratedModel {
+  /** Model name (PascalCase) */
+  name: string;
+  /** Model description */
+  description?: string;
+  /** Fields */
+  fields: SchemaField[];
+  /** Generated TypeScript code */
+  code: string;
+  /** Required imports */
+  imports?: string[];
+}
+/**
+ * Convert a JSON Schema to a TypeScript type representation.
+ */
+declare function jsonSchemaToType(schema: OpenApiSchema, name?: string): TypescriptType;
+/**
+ * Get the ScalarTypeEnum value for a JSON Schema type.
+ */
+declare function getScalarType(schema: OpenApiSchema): string | undefined;
+/**
+ * Generate code for a schema model using the specified format.
+ */
+declare function generateSchemaModelCode(schema: OpenApiSchema, modelName: string, schemaFormat?: SchemaFormat, config?: ContractsrcConfig): GeneratedModel;
+/**
+ * Generate import statements for a SchemaModel.
+ */
+declare function generateImports(fields: SchemaField[], options: ContractsrcConfig, sameDirectory?: boolean): string;
+//#endregion
+export { GeneratedModel, SchemaField, TypescriptType, generateImports, generateSchemaModelCode, getScalarType, jsonSchemaToType };
+//# sourceMappingURL=schema-converter.d.ts.map

package/dist/openapi/schema-converter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-converter.d.ts","names":[],"sources":["../../src/openapi/schema-converter.ts"],"sourcesContent":[],"mappings":";;;;;AAkEA;AA+BA;AAiHA;AA2BgB,UA7MC,cAAA,CA6MsB;EAC7B;EAEM,IAAA,EAAA,MAAA;EACL;EACR,QAAA,EAAA,OAAA;EAAc;EAkBD,KAAA,EAAA,OAAA;;;;;;;;;;;UAlNC,WAAA;;;;QAIT;;;;;;gBAMQ;;;;;UAMC,cAAA;;;;;;UAMP;;;;;;;;;iBAyBM,gBAAA,SACN,+BAEP;;;;iBA8Ga,aAAA,SAAsB;;;;iBA2BtB,uBAAA,SACN,iDAEM,uBACL,oBACR;;;;iBAkBa,eAAA,SACN,wBACC"}

package/dist/openapi/schema-converter.js

@@ -0,0 +1,161 @@
+import { toPascalCase } from "../common/utils.js";
+import { createSchemaGenerator } from "./schema-generators/index.js";
+
+//#region src/openapi/schema-converter.ts
+/**
+* JSON Schema to SchemaModel conversion utilities.
+* Converts OpenAPI JSON Schema to ContractSpec SchemaModel definitions.
+*/
+/**
+* Map JSON Schema types to ContractSpec ScalarTypeEnum values.
+*/
+const JSON_SCHEMA_TO_SCALAR = {
+	string: "ScalarTypeEnum.String_unsecure",
+	integer: "ScalarTypeEnum.Int_unsecure",
+	number: "ScalarTypeEnum.Float_unsecure",
+	boolean: "ScalarTypeEnum.Boolean",
+	"string:date": "ScalarTypeEnum.Date",
+	"string:date-time": "ScalarTypeEnum.DateTime",
+	"string:email": "ScalarTypeEnum.EmailAddress",
+	"string:uri": "ScalarTypeEnum.URL",
+	"string:uuid": "ScalarTypeEnum.ID"
+};
+/**
+* Check if a schema is a reference object.
+*/
+function isReference(schema) {
+	return typeof schema === "object" && schema !== null && "$ref" in schema;
+}
+/**
+* Extract type name from a $ref.
+*/
+function typeNameFromRef(ref) {
+	const parts = ref.split("/");
+	return parts[parts.length - 1] ?? "Unknown";
+}
+/**
+* Convert a JSON Schema to a TypeScript type representation.
+*/
+function jsonSchemaToType(schema, name) {
+	if (isReference(schema)) return {
+		type: toPascalCase(typeNameFromRef(schema.$ref)),
+		optional: false,
+		array: false,
+		primitive: false,
+		isReference: true
+	};
+	const schemaObj = schema;
+	const type = schemaObj["type"];
+	const format = schemaObj["format"];
+	const nullable = schemaObj["nullable"];
+	const originalTypeName = schemaObj["_originalTypeName"];
+	if (originalTypeName) return {
+		type: toPascalCase(originalTypeName),
+		optional: nullable ?? false,
+		array: false,
+		primitive: false,
+		isReference: true
+	};
+	if (type === "array") {
+		const items = schemaObj["items"];
+		if (items) return {
+			...jsonSchemaToType(items, name),
+			array: true,
+			optional: nullable ?? false
+		};
+		return {
+			type: "unknown",
+			optional: nullable ?? false,
+			array: true,
+			primitive: false,
+			isReference: true
+		};
+	}
+	if (type === "object" || schemaObj["properties"]) return {
+		type: name ? toPascalCase(name) : "Record<string, unknown>",
+		optional: nullable ?? false,
+		array: false,
+		primitive: false,
+		isReference: true
+	};
+	if (schemaObj["enum"]) return {
+		type: name ? toPascalCase(name) : "string",
+		optional: nullable ?? false,
+		array: false,
+		primitive: false,
+		isReference: true
+	};
+	const scalarKey = format ? `${type}:${format}` : type;
+	if (scalarKey === "string") return {
+		type: "string",
+		optional: nullable ?? false,
+		array: false,
+		primitive: true
+	};
+	if (scalarKey === "integer" || type === "number") return {
+		type: "number",
+		optional: nullable ?? false,
+		array: false,
+		primitive: true
+	};
+	if (scalarKey === "boolean") return {
+		type: "boolean",
+		optional: nullable ?? false,
+		array: false,
+		primitive: true
+	};
+	return {
+		type: "unknown",
+		optional: nullable ?? false,
+		array: false,
+		primitive: false,
+		isReference: true
+	};
+}
+/**
+* Get the ScalarTypeEnum value for a JSON Schema type.
+*/
+function getScalarType(schema) {
+	if (isReference(schema)) return;
+	const schemaObj = schema;
+	const type = schemaObj["type"];
+	const format = schemaObj["format"];
+	if (!type) return void 0;
+	if (type === "array") {
+		const items = schemaObj["items"];
+		if (items) return getScalarType(items);
+		return;
+	}
+	return JSON_SCHEMA_TO_SCALAR[format ? `${type}:${format}` : type] ?? JSON_SCHEMA_TO_SCALAR[type] ?? void 0;
+}
+/**
+* Generate code for a schema model using the specified format.
+*/
+function generateSchemaModelCode(schema, modelName, schemaFormat = "contractspec", config) {
+	const result = createSchemaGenerator(schemaFormat, config).generateModel(schema, modelName, { description: schema["description"] });
+	return {
+		name: result.name,
+		description: schema["description"],
+		fields: [],
+		code: result.code,
+		imports: result.imports
+	};
+}
+/**
+* Generate import statements for a SchemaModel.
+*/
+function generateImports(fields, options, sameDirectory = true) {
+	const imports = /* @__PURE__ */ new Set();
+	const modelsDir = sameDirectory ? "." : `../${options.conventions.models}`;
+	imports.add("import { defineSchemaModel, ScalarTypeEnum, EnumType } from '@contractspec/lib.schema';");
+	for (const field of fields) if (field.type.isReference && !field.type.primitive && !field.enumValues && !field.scalarType && !field.nestedModel) {
+		const modelName = field.type.type;
+		const kebabName = modelName.replace(/([a-z0-9])([A-Z])/g, "$1-$2").toLowerCase();
+		imports.add(`import { ${modelName} } from '${modelsDir}/${kebabName}';`);
+	}
+	return Array.from(imports).join("\n");
+}
+
+//#endregion
+export { generateImports, generateSchemaModelCode, getScalarType, jsonSchemaToType };
+//# sourceMappingURL=schema-converter.js.map

package/dist/openapi/schema-converter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-converter.js","names":["JSON_SCHEMA_TO_SCALAR: Record<string, string>"],"sources":["../../src/openapi/schema-converter.ts"],"sourcesContent":["/**\n * JSON Schema to SchemaModel conversion utilities.\n * Converts OpenAPI JSON Schema to ContractSpec SchemaModel definitions.\n */\n\nimport { createSchemaGenerator } from './schema-generators';\nimport type {\n  SchemaFormat,\n  ContractsrcConfig,\n} from '@contractspec/lib.contracts';\nimport type { OpenApiSchema } from './types';\nimport { toPascalCase } from '../common/utils';\n\n/**\n * Map JSON Schema types to ContractSpec ScalarTypeEnum values.\n */\nconst JSON_SCHEMA_TO_SCALAR: Record<string, string> = {\n  string: 'ScalarTypeEnum.String_unsecure',\n  integer: 'ScalarTypeEnum.Int_unsecure',\n  number: 'ScalarTypeEnum.Float_unsecure',\n  boolean: 'ScalarTypeEnum.Boolean',\n  // Special formats\n  'string:date': 'ScalarTypeEnum.Date',\n  'string:date-time': 'ScalarTypeEnum.DateTime',\n  'string:email': 'ScalarTypeEnum.EmailAddress',\n  'string:uri': 'ScalarTypeEnum.URL',\n  'string:uuid': 'ScalarTypeEnum.ID',\n};\n\n/**\n * TypeScript type representation for code generation.\n */\nexport interface TypescriptType {\n  /** The type expression (e.g., \"string\", \"number\", \"MyModel\") */\n  type: string;\n  /** Whether the type is optional */\n  optional: boolean;\n  /** Whether the type is an array */\n  array: boolean;\n  /** Whether this is a primitive type */\n  primitive: boolean;\n  /** Description for documentation */\n  description?: string;\n  /** Whether this type is a reference to another schema (needs import) vs inline */\n  isReference?: boolean;\n}\n\n/**\n * SchemaModel field representation for code generation.\n */\nexport interface SchemaField {\n  /** Field name */\n  name: string;\n  /** Field type */\n  type: TypescriptType;\n  /** Scalar type enum value (for FieldType) */\n  scalarType?: string;\n  /** Enum values if this is an enum type */\n  enumValues?: string[];\n  /** Nested model if this is an object type */\n  nestedModel?: GeneratedModel;\n}\n\n/**\n * Generated model representation.\n */\nexport interface GeneratedModel {\n  /** Model name (PascalCase) */\n  name: string;\n  /** Model description */\n  description?: string;\n  /** Fields */\n  fields: SchemaField[];\n  /** Generated TypeScript code */\n  code: string;\n  /** Required imports */\n  imports?: string[];\n}\n\n/**\n * Check if a schema is a reference object.\n */\nfunction isReference(schema: OpenApiSchema): schema is { $ref: string } {\n  return typeof schema === 'object' && schema !== null && '$ref' in schema;\n}\n\n/**\n * Extract type name from a $ref.\n */\nfunction typeNameFromRef(ref: string): string {\n  const parts = ref.split('/');\n  return parts[parts.length - 1] ?? 'Unknown';\n}\n\n/**\n * Convert a JSON Schema to a TypeScript type representation.\n */\nexport function jsonSchemaToType(\n  schema: OpenApiSchema,\n  name?: string\n): TypescriptType {\n  if (isReference(schema)) {\n    return {\n      type: toPascalCase(typeNameFromRef(schema.$ref)),\n      optional: false,\n      array: false,\n      primitive: false,\n      isReference: true,\n    };\n  }\n\n  const schemaObj = schema as Record<string, unknown>;\n  const type = schemaObj['type'] as string | undefined;\n  const format = schemaObj['format'] as string | undefined;\n  const nullable = schemaObj['nullable'] as boolean | undefined;\n\n  // Check if this schema was dereferenced from a $ref - use the original type name\n  const originalTypeName = schemaObj['_originalTypeName'] as string | undefined;\n  if (originalTypeName) {\n    return {\n      type: toPascalCase(originalTypeName),\n      optional: nullable ?? false,\n      array: false,\n      primitive: false,\n      isReference: true,\n    };\n  }\n\n  // Handle arrays\n  if (type === 'array') {\n    const items = schemaObj['items'] as OpenApiSchema | undefined;\n    if (items) {\n      const itemType = jsonSchemaToType(items, name);\n      return {\n        ...itemType,\n        array: true,\n        optional: nullable ?? false,\n      };\n    }\n    return {\n      type: 'unknown',\n      optional: nullable ?? false,\n      array: true,\n      primitive: false,\n      isReference: true,\n    };\n  }\n\n  // Handle objects\n  if (type === 'object' || schemaObj['properties']) {\n    return {\n      type: name ? toPascalCase(name) : 'Record<string, unknown>',\n      optional: nullable ?? false,\n      array: false,\n      primitive: false,\n      isReference: true,\n    };\n  }\n\n  // Handle enums\n  if (schemaObj['enum']) {\n    return {\n      type: name ? toPascalCase(name) : 'string',\n      optional: nullable ?? false,\n      array: false,\n      primitive: false,\n      isReference: true,\n    };\n  }\n\n  // Handle primitives\n  const scalarKey = format ? `${type}:${format}` : type;\n  if (scalarKey === 'string') {\n    return {\n      type: 'string',\n      optional: nullable ?? false,\n      array: false,\n      primitive: true,\n    };\n  }\n  if (scalarKey === 'integer' || type === 'number') {\n    return {\n      type: 'number',\n      optional: nullable ?? false,\n      array: false,\n      primitive: true,\n    };\n  }\n  if (scalarKey === 'boolean') {\n    return {\n      type: 'boolean',\n      optional: nullable ?? false,\n      array: false,\n      primitive: true,\n    };\n  }\n\n  // Default to unknown\n  return {\n    type: 'unknown',\n    optional: nullable ?? false,\n    array: false,\n    primitive: false,\n    isReference: true,\n  };\n}\n\n/**\n * Get the ScalarTypeEnum value for a JSON Schema type.\n */\nexport function getScalarType(schema: OpenApiSchema): string | undefined {\n  if (isReference(schema)) {\n    return undefined;\n  }\n\n  const schemaObj = schema as Record<string, unknown>;\n  const type = schemaObj['type'] as string | undefined;\n  const format = schemaObj['format'] as string | undefined;\n\n  if (!type) return undefined;\n\n  // For arrays, get the scalar type of the items\n  if (type === 'array') {\n    const items = schemaObj['items'] as OpenApiSchema | undefined;\n    if (items) {\n      return getScalarType(items);\n    }\n    return undefined;\n  }\n\n  const key = format ? `${type}:${format}` : type;\n  return JSON_SCHEMA_TO_SCALAR[key] ?? JSON_SCHEMA_TO_SCALAR[type] ?? undefined;\n}\n\n/**\n * Generate code for a schema model using the specified format.\n */\nexport function generateSchemaModelCode(\n  schema: OpenApiSchema,\n  modelName: string,\n  schemaFormat: SchemaFormat = 'contractspec',\n  config?: ContractsrcConfig\n): GeneratedModel {\n  const generator = createSchemaGenerator(schemaFormat, config);\n  const result = generator.generateModel(schema, modelName, {\n    description: (schema as Record<string, unknown>)['description'] as string,\n  });\n\n  return {\n    name: result.name,\n    description: (schema as Record<string, unknown>)['description'] as string,\n    fields: [], // fields are processed internally by generators now\n    code: result.code,\n    imports: result.imports,\n  };\n}\n\n/**\n * Generate import statements for a SchemaModel.\n */\nexport function generateImports(\n  fields: SchemaField[],\n  options: ContractsrcConfig,\n  sameDirectory = true\n): string {\n  const imports = new Set<string>();\n  const modelsDir = sameDirectory ? '.' : `../${options.conventions.models}`;\n\n  imports.add(\n    \"import { defineSchemaModel, ScalarTypeEnum, EnumType } from '@contractspec/lib.schema';\"\n  );\n\n  for (const field of fields) {\n    // Only import fields that are actual references to other schemas (not inline types)\n    if (\n      field.type.isReference &&\n      !field.type.primitive &&\n      !field.enumValues &&\n      !field.scalarType &&\n      !field.nestedModel\n    ) {\n      // This is a reference to another schema model\n      const modelName = field.type.type;\n      const kebabName = modelName\n        .replace(/([a-z0-9])([A-Z])/g, '$1-$2')\n        .toLowerCase();\n      imports.add(`import { ${modelName} } from '${modelsDir}/${kebabName}';`);\n    }\n  }\n\n  return Array.from(imports).join('\\n');\n}\n"],"mappings":";;;;;;;;;;;AAgBA,MAAMA,wBAAgD;CACpD,QAAQ;CACR,SAAS;CACT,QAAQ;CACR,SAAS;CAET,eAAe;CACf,oBAAoB;CACpB,gBAAgB;CAChB,cAAc;CACd,eAAe;CAChB;;;;AAuDD,SAAS,YAAY,QAAmD;AACtE,QAAO,OAAO,WAAW,YAAY,WAAW,QAAQ,UAAU;;;;;AAMpE,SAAS,gBAAgB,KAAqB;CAC5C,MAAM,QAAQ,IAAI,MAAM,IAAI;AAC5B,QAAO,MAAM,MAAM,SAAS,MAAM;;;;;AAMpC,SAAgB,iBACd,QACA,MACgB;AAChB,KAAI,YAAY,OAAO,CACrB,QAAO;EACL,MAAM,aAAa,gBAAgB,OAAO,KAAK,CAAC;EAChD,UAAU;EACV,OAAO;EACP,WAAW;EACX,aAAa;EACd;CAGH,MAAM,YAAY;CAClB,MAAM,OAAO,UAAU;CACvB,MAAM,SAAS,UAAU;CACzB,MAAM,WAAW,UAAU;CAG3B,MAAM,mBAAmB,UAAU;AACnC,KAAI,iBACF,QAAO;EACL,MAAM,aAAa,iBAAiB;EACpC,UAAU,YAAY;EACtB,OAAO;EACP,WAAW;EACX,aAAa;EACd;AAIH,KAAI,SAAS,SAAS;EACpB,MAAM,QAAQ,UAAU;AACxB,MAAI,MAEF,QAAO;GACL,GAFe,iBAAiB,OAAO,KAAK;GAG5C,OAAO;GACP,UAAU,YAAY;GACvB;AAEH,SAAO;GACL,MAAM;GACN,UAAU,YAAY;GACtB,OAAO;GACP,WAAW;GACX,aAAa;GACd;;AAIH,KAAI,SAAS,YAAY,UAAU,cACjC,QAAO;EACL,MAAM,OAAO,aAAa,KAAK,GAAG;EAClC,UAAU,YAAY;EACtB,OAAO;EACP,WAAW;EACX,aAAa;EACd;AAIH,KAAI,UAAU,QACZ,QAAO;EACL,MAAM,OAAO,aAAa,KAAK,GAAG;EAClC,UAAU,YAAY;EACtB,OAAO;EACP,WAAW;EACX,aAAa;EACd;CAIH,MAAM,YAAY,SAAS,GAAG,KAAK,GAAG,WAAW;AACjD,KAAI,cAAc,SAChB,QAAO;EACL,MAAM;EACN,UAAU,YAAY;EACtB,OAAO;EACP,WAAW;EACZ;AAEH,KAAI,cAAc,aAAa,SAAS,SACtC,QAAO;EACL,MAAM;EACN,UAAU,YAAY;EACtB,OAAO;EACP,WAAW;EACZ;AAEH,KAAI,cAAc,UAChB,QAAO;EACL,MAAM;EACN,UAAU,YAAY;EACtB,OAAO;EACP,WAAW;EACZ;AAIH,QAAO;EACL,MAAM;EACN,UAAU,YAAY;EACtB,OAAO;EACP,WAAW;EACX,aAAa;EACd;;;;;AAMH,SAAgB,cAAc,QAA2C;AACvE,KAAI,YAAY,OAAO,CACrB;CAGF,MAAM,YAAY;CAClB,MAAM,OAAO,UAAU;CACvB,MAAM,SAAS,UAAU;AAEzB,KAAI,CAAC,KAAM,QAAO;AAGlB,KAAI,SAAS,SAAS;EACpB,MAAM,QAAQ,UAAU;AACxB,MAAI,MACF,QAAO,cAAc,MAAM;AAE7B;;AAIF,QAAO,sBADK,SAAS,GAAG,KAAK,GAAG,WAAW,SACN,sBAAsB,SAAS;;;;;AAMtE,SAAgB,wBACd,QACA,WACA,eAA6B,gBAC7B,QACgB;CAEhB,MAAM,SADY,sBAAsB,cAAc,OAAO,CACpC,cAAc,QAAQ,WAAW,EACxD,aAAc,OAAmC,gBAClD,CAAC;AAEF,QAAO;EACL,MAAM,OAAO;EACb,aAAc,OAAmC;EACjD,QAAQ,EAAE;EACV,MAAM,OAAO;EACb,SAAS,OAAO;EACjB;;;;;AAMH,SAAgB,gBACd,QACA,SACA,gBAAgB,MACR;CACR,MAAM,0BAAU,IAAI,KAAa;CACjC,MAAM,YAAY,gBAAgB,MAAM,MAAM,QAAQ,YAAY;AAElE,SAAQ,IACN,0FACD;AAED,MAAK,MAAM,SAAS,OAElB,KACE,MAAM,KAAK,eACX,CAAC,MAAM,KAAK,aACZ,CAAC,MAAM,cACP,CAAC,MAAM,cACP,CAAC,MAAM,aACP;EAEA,MAAM,YAAY,MAAM,KAAK;EAC7B,MAAM,YAAY,UACf,QAAQ,sBAAsB,QAAQ,CACtC,aAAa;AAChB,UAAQ,IAAI,YAAY,UAAU,WAAW,UAAU,GAAG,UAAU,IAAI;;AAI5E,QAAO,MAAM,KAAK,QAAQ,CAAC,KAAK,KAAK"}