@orval/core 8.0.0-rc.0 → 8.0.0-rc.1

package/dist/index.d.ts

@@ -7,7 +7,6 @@ import { allLocales } from "@faker-js/faker";
 import { JSONSchema6, JSONSchema7 } from "json-schema";
 import { ComponentsObject, ExampleObject, InfoObject, OpenAPIObject, OperationObject, ParameterObject, PathItemObject, ReferenceObject, RequestBodyObject, ResponseObject, ResponsesObject, SchemaObject, SchemasObject } from "openapi3-ts/oas30";
 import { TypeDocOptions } from "typedoc";
-import { ValueIteratee } from "lodash";
 import { ServerObject } from "openapi3-ts/oas31";
 
 //#region src/types.d.ts
@@ -488,7 +487,7 @@ type NormalizedQueryOptions = {
   shouldSplitQueryKey?: boolean;
   useOperationIdAsQueryKey?: boolean;
   signal?: boolean;
-  version?: 4 | 5;
+  version?: 3 | 4 | 5;
 };
 type QueryOptions = {
   useQuery?: boolean;
@@ -509,7 +508,7 @@ type QueryOptions = {
   shouldSplitQueryKey?: boolean;
   useOperationIdAsQueryKey?: boolean;
   signal?: boolean;
-  version?: 4 | 5;
+  version?: 3 | 4 | 5;
 };
 type AngularOptions = {
   provideIn?: 'root' | 'any' | boolean;
@@ -1384,7 +1383,7 @@ interface RefInfo {
 declare const getRefInfo: ($ref: ReferenceObject["$ref"], context: ContextSpecs) => RefInfo;
 //#endregion
 //#region src/getters/res-req-types.d.ts
-declare const getResReqTypes: (responsesOrRequests: [string, ResponseObject | ReferenceObject | RequestBodyObject][], name: string, context: ContextSpecs, defaultType?: string, uniqueKey?: ValueIteratee<ResReqTypesValue>) => ResReqTypesValue[];
+declare const getResReqTypes: (responsesOrRequests: [string, ResponseObject | ReferenceObject | RequestBodyObject][], name: string, context: ContextSpecs, defaultType?: string, uniqueKey?: (item: ResReqTypesValue, index: number, data: ResReqTypesValue[]) => unknown) => ResReqTypesValue[];
 //#endregion
 //#region src/getters/response.d.ts
 declare const getResponse: ({

package/dist/index.js

@@ -1,5 +1,5 @@
 import { t as __export } from "./chunk-Bp6m_JJh.js";
-import isEmpty from "lodash.isempty";
+import { isEmptyish, unique, uniqueBy, uniqueWith } from "remeda";
 import { keyword } from "esutils";
 import path from "node:path";
 import fs from "node:fs";
@@ -12,9 +12,6 @@ import chalk from "chalk";
 import { convertObj } from "swagger2openapi";
 import ibmOpenapiRuleset from "@ibm-cloud/openapi-ruleset";
 import stoplight from "@stoplight/spectral-core";
-import uniqBy from "lodash.uniqby";
-import uniq from "lodash.uniq";
-import uniqWith from "lodash.uniqwith";
 import fs$1 from "fs-extra";
 import { Parser } from "acorn";
 import { build } from "esbuild";
@@ -1170,8 +1167,8 @@ const getResReqContentTypes = ({ mediaType, propName, context }) => {
 		context
 	});
 };
-const getResReqTypes = (responsesOrRequests, name, context, defaultType = "unknown", uniqueKey = "value") => {
-	return uniqBy(responsesOrRequests.filter(([_, res]) => Boolean(res)).map(([key, res]) => {
+const getResReqTypes = (responsesOrRequests, name, context, defaultType = "unknown", uniqueKey = (item) => item.value) => {
+	return uniqueBy(responsesOrRequests.filter(([_, res]) => Boolean(res)).map(([key, res]) => {
 		if (isReference(res)) {
 			const { schema: bodySchema, imports: [{ name: name$1, specKey, schemaName }] } = resolveRef(res, context);
 			const [contentType, mediaType] = Object.entries(bodySchema.content ?? {})[0] ?? [];
@@ -1516,6 +1513,23 @@ const getKey = (key) => {
 //#endregion
 //#region src/getters/object.ts
 /**
+* Extract enum values from propertyNames schema (OpenAPI 3.1)
+* Returns undefined if propertyNames doesn't have an enum
+*/
+const getPropertyNamesEnum = (item) => {
+	const schema31 = item;
+	if ("propertyNames" in schema31 && schema31.propertyNames && "enum" in schema31.propertyNames && Array.isArray(schema31.propertyNames.enum)) return schema31.propertyNames.enum.filter((val) => typeof val === "string");
+};
+/**
+* Generate index signature key type based on propertyNames enum
+* Returns union type string like "'foo' | 'bar'" or 'string' if no enum
+*/
+const getIndexSignatureKey = (item) => {
+	const enumValues = getPropertyNamesEnum(item);
+	if (enumValues && enumValues.length > 0) return enumValues.map((val) => `'${val}'`).join(" | ");
+	return "string";
+};
+/**
 * Return the output type from an object
 *
 * @param item item with type === "object"
@@ -1593,16 +1607,18 @@ const getObject = ({ item, name, context, nullable }) => {
 			acc.value += `\n  ${doc ? `${doc}  ` : ""}${isReadOnly && !context.output.override.suppressReadonlyModifier ? "readonly " : ""}${getKey(key)}${isRequired ? "" : "?"}: ${propValue};`;
 			acc.schemas.push(...resolvedValue.schemas);
 			if (arr.length - 1 === index) {
-				if (item.additionalProperties) if (isBoolean(item.additionalProperties)) acc.value += `\n  [key: string]: unknown;\n }`;
-				else {
-					const resolvedValue$1 = resolveValue({
-						schema: item.additionalProperties,
-						name,
-						context
-					});
-					acc.value += `\n  [key: string]: ${resolvedValue$1.value};\n}`;
-				}
-				else acc.value += "\n}";
+				if (item.additionalProperties) {
+					const keyType$1 = getIndexSignatureKey(item);
+					if (isBoolean(item.additionalProperties)) acc.value += `\n  [key: ${keyType$1}]: unknown;\n }`;
+					else {
+						const resolvedValue$1 = resolveValue({
+							schema: item.additionalProperties,
+							name,
+							context
+						});
+						acc.value += `\n  [key: ${keyType$1}]: ${resolvedValue$1.value};\n}`;
+					}
+				} else acc.value += "\n}";
 				acc.value += nullable;
 			}
 			return acc;
@@ -1620,8 +1636,9 @@ const getObject = ({ item, name, context, nullable }) => {
 		});
 	}
 	if (item.additionalProperties) {
+		const keyType$1 = getIndexSignatureKey(item);
 		if (isBoolean(item.additionalProperties)) return {
-			value: `{ [key: string]: unknown }` + nullable,
+			value: `{ [key: ${keyType$1}]: unknown }` + nullable,
 			imports: [],
 			schemas: [],
 			isEnum: false,
@@ -1635,7 +1652,7 @@ const getObject = ({ item, name, context, nullable }) => {
 			context
 		});
 		return {
-			value: `{[key: string]: ${resolvedValue.value}}` + nullable,
+			value: `{[key: ${keyType$1}]: ${resolvedValue.value}}` + nullable,
 			imports: resolvedValue.imports ?? [],
 			schemas: resolvedValue.schemas ?? [],
 			isEnum: false,
@@ -1654,8 +1671,9 @@ const getObject = ({ item, name, context, nullable }) => {
 		isRef: false,
 		hasReadonlyProps: item.readOnly || false
 	};
+	const keyType = item.type === "object" ? getIndexSignatureKey(item) : "string";
 	return {
-		value: (item.type === "object" ? "{ [key: string]: unknown }" : "unknown") + nullable,
+		value: (item.type === "object" ? `{ [key: ${keyType}]: unknown }` : "unknown") + nullable,
 		imports: [],
 		schemas: [],
 		isEnum: false,
@@ -1820,7 +1838,7 @@ const combineValues = ({ resolvedData, resolvedValue, separator: separator$1, co
 				values.push(resolvedData.values[i]);
 				continue;
 			}
-			const missingProperties = uniq(resolvedData.allProperties.filter((p) => !Object.keys(subSchema.properties).includes(p)));
+			const missingProperties = unique(resolvedData.allProperties.filter((p) => !Object.keys(subSchema.properties).includes(p)));
 			values.push(`${resolvedData.values[i]}${missingProperties.length > 0 ? ` & {${missingProperties.map((p) => `${p}?: never`).join("; ")}}` : ""}`);
 		}
 	}
@@ -2298,7 +2316,7 @@ const getRouteAsArray = (route) => route.replaceAll(TEMPLATE_TAG_IN_PATH_REGEX,
 //#endregion
 //#region src/generators/component-definition.ts
 const generateComponentDefinition = (responses = {}, context, suffix) => {
-	if (isEmpty(responses)) return [];
+	if (isEmptyish(responses)) return [];
 	return Object.entries(responses).reduce((acc, [name, response]) => {
 		const allResponseTypes = getResReqTypes([[suffix, response]], name, context, "void");
 		const imports = allResponseTypes.flatMap(({ imports: imports$1 }) => imports$1);
@@ -2326,7 +2344,7 @@ const generateComponentDefinition = (responses = {}, context, suffix) => {
 //#region src/generators/imports.ts
 const generateImports = ({ imports = [], target, isRootKey: isRootKey$1, specsName, specKey: currentSpecKey, namingConvention = NamingConvention.CAMEL_CASE }) => {
 	if (imports.length === 0) return "";
-	return uniqWith(imports, (a, b) => a.name === b.name && a.default === b.default && a.specKey === b.specKey).sort().map(({ specKey, name, values, alias, isConstant }) => {
+	return uniqueWith(imports, (a, b) => a.name === b.name && a.default === b.default && a.specKey === b.specKey).sort().map(({ specKey, name, values, alias, isConstant }) => {
 		const isSameSpecKey = currentSpecKey === specKey;
 		const fileName = conventionName(name, namingConvention);
 		if (specKey && !isSameSpecKey) {
@@ -2338,7 +2356,7 @@ const generateImports = ({ imports = [], target, isRootKey: isRootKey$1, specsNa
 	}).join("\n");
 };
 const generateMutatorImports = ({ mutators, implementation, oneMore }) => {
-	return uniqWith(mutators, (a, b) => a.name === b.name && a.default === b.default).reduce((acc, mutator) => {
+	return uniqueWith(mutators, (a, b) => a.name === b.name && a.default === b.default).reduce((acc, mutator) => {
 		const path$2 = `${oneMore ? "../" : ""}${mutator.path}`;
 		const importDefault = mutator.default ? mutator.name : `{ ${mutator.name} }`;
 		acc += `import ${importDefault} from '${path$2}';`;
@@ -2361,7 +2379,7 @@ const generateMutatorImports = ({ mutators, implementation, oneMore }) => {
 const generateDependency = ({ deps, isAllowSyntheticDefaultImports, dependency, specsName, key, onlyTypes }) => {
 	const defaultDep = deps.find((e) => e.default && (isAllowSyntheticDefaultImports || !e.syntheticDefaultImport));
 	const namespaceImportDep = defaultDep ? void 0 : deps.find((e) => !!e.namespaceImport || !isAllowSyntheticDefaultImports && e.syntheticDefaultImport);
-	const depsString = uniq(deps.filter((e) => !e.default && !e.syntheticDefaultImport && !e.namespaceImport).map(({ name, alias }) => alias ? `${name} as ${alias}` : name)).toSorted().join(",\n  ");
+	const depsString = unique(deps.filter((e) => !e.default && !e.syntheticDefaultImport && !e.namespaceImport).map(({ name, alias }) => alias ? `${name} as ${alias}` : name)).toSorted().join(",\n  ");
 	let importString = "";
 	const namespaceImportString = namespaceImportDep ? `import * as ${namespaceImportDep.name} from '${dependency}';` : "";
 	if (namespaceImportString) {
@@ -2773,7 +2791,7 @@ const generateInterface = ({ name, schema, context, suffix }) => {
 * @param schemas
 */
 const generateSchemasDefinition = (schemas = {}, context, suffix, filters) => {
-	if (isEmpty(schemas)) return [];
+	if (isEmptyish(schemas)) return [];
 	const transformedSchemas = resolveDiscriminators(schemas, context);
 	let generateSchemas = Object.entries(transformedSchemas);
 	if (filters?.schemas) {
@@ -3062,7 +3080,7 @@ const writeSchemas = async ({ schemaPath, schemas, target, namingConvention, fil
 //#endregion
 //#region src/writers/generate-imports-for-builder.ts
 const generateImportsForBuilder = (output, imports, relativeSchemasPath) => {
-	return output.schemas && !output.indexFiles ? uniqBy(imports, "name").map((i) => {
+	return output.schemas && !output.indexFiles ? uniqueBy(imports, (x) => x.name).map((i) => {
 		const name = conventionName(i.name, output.namingConvention);
 		return {
 			exports: [i],