toolcraft-openapi 0.0.13 → 0.0.14

package/dist/generate.d.ts

@@ -2,6 +2,9 @@ import { type HttpMethod } from "./naming.js";
 type OpenApiOperation = OpenApiOperationObject | OpenApiReferenceObject;
 type OpenApiOperationMap = Partial<Record<HttpMethod, OpenApiOperation>>;
 type OpenApiParameterLocation = "path" | "query" | "header" | "cookie";
+type OpenApiScalarType = "string" | "number" | "integer" | "boolean";
+type OpenApiSchemaType = OpenApiScalarType | "object" | "array";
+type OpenApiJsonSchemaType = OpenApiSchemaType | "null";
 export type GeneratedRequestLocation = Exclude<GeneratedParam["location"], "transport">;
 export interface OpenApiDocument {
     openapi?: string;
@@ -57,7 +60,7 @@ export interface OpenApiMediaTypeObject {
     schema?: OpenApiSchemaObject | OpenApiReferenceObject;
 }
 export interface OpenApiSchemaObject {
-    type?: "string" | "number" | "integer" | "boolean" | "object" | "array";
+    type?: OpenApiJsonSchemaType | readonly OpenApiJsonSchemaType[];
     additionalProperties?: boolean | OpenApiSchemaObject | OpenApiReferenceObject;
     allOf?: Array<OpenApiSchemaObject | OpenApiReferenceObject>;
     anyOf?: Array<OpenApiSchemaObject | OpenApiReferenceObject>;

package/dist/generate.js

@@ -324,17 +324,11 @@ function assertSupportedSuccessResponseSchema(document, schema, operationId, con
     }
 }
 function expectSupportedSuccessResponseSchema(document, schema, operationId, context) {
-    const resolvedSchema = resolveSchema(document, schema, operationId, context);
+    const resolvedSchema = normalizeNullableSchema(document, resolveSchema(document, schema, operationId, context), operationId, context);
     const compositionKeyword = getCompositionKeyword(resolvedSchema);
     if (compositionKeyword === undefined) {
         return resolvedSchema;
     }
-    const nullableAnyOfSchema = compositionKeyword === "anyOf"
-        ? resolveNullableAnyOfSchema(document, resolvedSchema, operationId, context)
-        : undefined;
-    if (nullableAnyOfSchema !== undefined) {
-        return nullableAnyOfSchema;
-    }
     throw new UserError(`Operation ${JSON.stringify(operationId)} uses unsupported ${context}. JSON Schema composition keyword ${JSON.stringify(compositionKeyword)} is not supported in v1.`);
 }
 function createGeneratedParameter(document, parameter, operationId) {
@@ -578,6 +572,9 @@ function createCollectedRequestBodyParams(assemblies, bodyOptional, requestBodyD
     };
 }
 function createParamDefinition(document, schema, operationId, context) {
+    if (Array.isArray(schema.type)) {
+        throw new UserError(`Operation ${JSON.stringify(operationId)} uses unsupported ${context}. JSON Schema type arrays with multiple non-null types are not supported in v1.`);
+    }
     if (schema.type === "array") {
         const itemSchema = expectArrayItemsSchema(document, schema, operationId, context);
         return {
@@ -589,9 +586,9 @@ function createParamDefinition(document, schema, operationId, context) {
             ...(schema.nullable === true ? { nullable: true } : {})
         };
     }
-    const scalarDefinition = schema.type === undefined || !(schema.type in SCHEMA_TYPE_TO_KIND)
-        ? undefined
-        : SCHEMA_TYPE_TO_KIND[schema.type];
+    const scalarDefinition = isOpenApiScalarType(schema.type)
+        ? SCHEMA_TYPE_TO_KIND[schema.type]
+        : undefined;
     const enumValues = normalizeEnumValues(schema.enum, operationId, context, schema.nullable === true, schema.type);
     if (enumValues !== undefined) {
         return {
@@ -747,6 +744,9 @@ function expectOperation(document, operation, method, path, refChain = []) {
 function isEnumPrimitiveValue(value) {
     return typeof value === "string" || typeof value === "number" || typeof value === "boolean";
 }
+function isOpenApiScalarType(type) {
+    return typeof type === "string" && type in SCHEMA_TYPE_TO_KIND;
+}
 function expectRequestBody(document, requestBody, operationId, context, refChain = []) {
     if (!isReferenceObject(requestBody)) {
         return requestBody;
@@ -763,7 +763,7 @@ function expectResponse(document, response, operationId, statusCode, refChain =
     return expectResponse(document, resolveLocalReference(document, response.$ref, operationId, context), operationId, statusCode, [...refChain, response.$ref]);
 }
 function expectSchema(document, schema, operationId, context, refChain = []) {
-    const resolvedSchema = resolveSchema(document, schema, operationId, context, refChain);
+    const resolvedSchema = normalizeNullableSchema(document, resolveSchema(document, schema, operationId, context, refChain), operationId, context);
     const compositionKeyword = getCompositionKeyword(resolvedSchema);
     if (compositionKeyword !== undefined) {
         throw new UserError(`Operation ${JSON.stringify(operationId)} uses unsupported ${context}. JSON Schema composition keyword ${JSON.stringify(compositionKeyword)} is not supported in v1.`);
@@ -780,6 +780,28 @@ function resolveSchema(document, schema, operationId, context, refChain = []) {
     }
     return schema;
 }
+function normalizeNullableSchema(document, schema, operationId, context) {
+    const typeNormalizedSchema = normalizeNullableTypeArray(schema);
+    if (getCompositionKeyword(typeNormalizedSchema) !== "anyOf") {
+        return typeNormalizedSchema;
+    }
+    return (resolveNullableAnyOfSchema(document, typeNormalizedSchema, operationId, context) ??
+        typeNormalizedSchema);
+}
+function normalizeNullableTypeArray(schema) {
+    if (!Array.isArray(schema.type)) {
+        return schema;
+    }
+    const nonNullTypes = schema.type.filter((type) => type !== "null");
+    if (nonNullTypes.length === schema.type.length) {
+        return schema;
+    }
+    return {
+        ...schema,
+        type: nonNullTypes.length === 1 ? nonNullTypes[0] : nonNullTypes,
+        nullable: true
+    };
+}
 function getCompositionKeyword(schema) {
     for (const keyword of ["allOf", "anyOf", "oneOf"]) {
         if (schema[keyword] !== undefined) {
@@ -793,7 +815,7 @@ function resolveNullableAnyOfSchema(document, schema, operationId, context) {
     if (variants === undefined || variants.length !== 2) {
         return undefined;
     }
-    const resolvedVariants = variants.map((variant, index) => resolveSchema(document, variant, operationId, `${context} anyOf variant ${index}`));
+    const resolvedVariants = variants.map((variant, index) => normalizeNullableSchema(document, resolveSchema(document, variant, operationId, `${context} anyOf variant ${index}`), operationId, `${context} anyOf variant ${index}`));
     const nullVariantIndex = resolvedVariants.findIndex(isExplicitNullSchema);
     if (nullVariantIndex === -1) {
         return undefined;
@@ -802,8 +824,14 @@ function resolveNullableAnyOfSchema(document, schema, operationId, context) {
     if (nonNullVariant === undefined || getCompositionKeyword(nonNullVariant) !== undefined) {
         return undefined;
     }
+    const { anyOf: _anyOf, nullable: _nullable, ...wrapperSchema } = schema;
+    void _anyOf;
+    void _nullable;
     return {
+        ...wrapperSchema,
         ...nonNullVariant,
+        description: nonNullVariant.description ?? schema.description,
+        default: nonNullVariant.default ?? schema.default,
         nullable: true
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "toolcraft-openapi",
-  "version": "0.0.13",
+  "version": "0.0.14",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -30,7 +30,7 @@
     "auth-store": "^0.0.1",
     "chalk": "^5.6.2",
     "console-table-printer": "^2.15.0",
-    "toolcraft": "^0.0.13",
+    "toolcraft": "^0.0.14",
     "yaml": "^2.8.2"
   },
   "engines": {