@orval/core 7.9.0 → 7.10.0

package/dist/index.js

@@ -6594,6 +6594,7 @@ function createScanner(text, ignoreTrivia) {
       return token = 14;
     }
     switch (code) {
+      // tokens: []{}:,
       case 123:
         pos++;
         return token = 1;
@@ -6612,10 +6613,12 @@ function createScanner(text, ignoreTrivia) {
       case 44:
         pos++;
         return token = 5;
+      // strings
       case 34:
         pos++;
         value = scanString();
         return token = 10;
+      // comments
       case 47:
         var start = pos - 1;
         if (text.charCodeAt(pos + 1) === 47) {
@@ -6659,12 +6662,16 @@ function createScanner(text, ignoreTrivia) {
         value += String.fromCharCode(code);
         pos++;
         return token = 16;
+      // numbers
       case 45:
         value += String.fromCharCode(code);
         pos++;
         if (pos === len || !isDigit(text.charCodeAt(pos))) {
           return token = 16;
         }
+      // found a minus, followed by a number so
+      // we fall through to proceed with scanning
+      // numbers
       case 48:
       case 49:
       case 50:
@@ -6677,6 +6684,7 @@ function createScanner(text, ignoreTrivia) {
       case 57:
         value += scanNumber();
         return token = 11;
+      // literals and unknown symbols
       default:
         while (pos < len && isUnknownContentCharacter(code)) {
           pos++;
@@ -24963,6 +24971,7 @@ var require_immer_cjs_development = __commonJS({
               switch (type) {
                 case 2:
                   return base2.set(key, value);
+                /* istanbul ignore next */
                 case 3:
                   die(16);
                 default:
@@ -27628,6 +27637,7 @@ var require_URI = __commonJS({
         switch (getType(value)) {
           case "Undefined":
             return name in data;
+          // data[name] !== undefined;
           case "Boolean":
             var _booly = Boolean(isArray(data[name]) ? data[name].length : data[name]);
             return value === _booly;
@@ -27649,6 +27659,7 @@ var require_URI = __commonJS({
             return arrayContains(data[name], value);
           case "Number":
             value = String(value);
+          /* falls through */
           case "String":
             if (!isArray(data[name])) {
               return data[name] === value;
@@ -27942,6 +27953,7 @@ var require_URI = __commonJS({
             return relative;
           case "absolute":
             return !relative;
+          // hostname identification
           case "domain":
           case "name":
             return name;
@@ -32546,6 +32558,7 @@ var require_index_node_cjs = __commonJS({
               addType = true;
             }
             break;
+          /* c8 ignore next 2 */
           default:
             throw new TypeError("Unknown value type " + valueType);
         }
@@ -41722,6 +41735,7 @@ var require_minimatch = __commonJS({
           continue;
         }
         switch (c2) {
+          /* istanbul ignore next */
           case "/": {
             return false;
           }
@@ -41729,6 +41743,8 @@ var require_minimatch = __commonJS({
             clearStateChar();
             escaping = true;
             continue;
+          // the various stateChar values
+          // for the "extglob" stuff.
           case "?":
           case "*":
           case "+":
@@ -41789,6 +41805,7 @@ var require_minimatch = __commonJS({
             clearStateChar();
             re2 += "|";
             continue;
+          // these are mostly the same in regexp and glob
           case "[":
             clearStateChar();
             if (inClass) {
@@ -44302,7 +44319,7 @@ var require_get_intrinsic = __commonJS({
             if (!allowMissing) {
               throw new $TypeError("base intrinsic for " + name + " exists, but the property is not available.");
             }
-            return void 0;
+            return void undefined2;
           }
           if ($gOPD && i3 + 1 >= parts.length) {
             var desc = $gOPD(value, part);
@@ -48109,8 +48126,8 @@ var require_dist10 = __commonJS({
 });
 
 // src/index.ts
-var src_exports = {};
-__export(src_exports, {
+var index_exports = {};
+__export(index_exports, {
   BODY_TYPE_NAME: () => BODY_TYPE_NAME,
   EnumGeneration: () => EnumGeneration,
   FormDataArrayHandling: () => FormDataArrayHandling,
@@ -48167,6 +48184,7 @@ __export(src_exports, {
   getArray: () => getArray,
   getBody: () => getBody,
   getEnum: () => getEnum,
+  getEnumDescriptions: () => getEnumDescriptions,
   getEnumImplementation: () => getEnumImplementation,
   getEnumNames: () => getEnumNames,
   getExtension: () => getExtension,
@@ -48212,6 +48230,7 @@ __export(src_exports, {
   jsDoc: () => jsDoc,
   jsStringEscape: () => jsStringEscape,
   kebab: () => kebab,
+  keyValuePairsToJsDoc: () => keyValuePairsToJsDoc,
   loadFile: () => loadFile,
   log: () => log,
   logError: () => logError,
@@ -48242,7 +48261,7 @@ __export(src_exports, {
   writeSplitTagsMode: () => writeSplitTagsMode,
   writeTagsMode: () => writeTagsMode
 });
-module.exports = __toCommonJS(src_exports);
+module.exports = __toCommonJS(index_exports);
 
 // src/types.ts
 var PropertySortOrder = {
@@ -49071,21 +49090,28 @@ var compareVersions = (firstVersion, secondVersions, operator = ">=") => {
 var search = "\\*/";
 var replacement = "*\\/";
 var regex = new RegExp(search, "g");
-function jsDoc({
-  description,
-  deprecated,
-  summary,
-  minLength,
-  maxLength,
-  minimum,
-  maximum,
-  exclusiveMinimum,
-  exclusiveMaximum,
-  minItems,
-  maxItems,
-  nullable,
-  pattern
-}, tryOneLine = false) {
+function jsDoc(schema, tryOneLine = false, context) {
+  if (context?.output?.override?.jsDoc) {
+    const { filter: filter2 } = context.output.override.jsDoc;
+    if (filter2) {
+      return keyValuePairsToJsDoc(filter2(schema));
+    }
+  }
+  const {
+    description,
+    deprecated,
+    summary,
+    minLength,
+    maxLength,
+    minimum,
+    maximum,
+    exclusiveMinimum,
+    exclusiveMaximum,
+    minItems,
+    maxItems,
+    nullable,
+    pattern
+  } = schema;
   const lines = (Array.isArray(description) ? description.filter((d2) => !d2.includes("eslint-disable")) : [description || ""]).map((line) => line.replace(regex, replacement));
   const count2 = [
     description,
@@ -49157,6 +49183,16 @@ ${tryOneLine ? "  " : ""} *`;
   doc += "*/\n";
   return doc;
 }
+function keyValuePairsToJsDoc(keyValues) {
+  if (!keyValues.length) return "";
+  let doc = "/**\n";
+  keyValues.forEach(({ key, value }) => {
+    doc += ` * @${key} ${value}
+`;
+  });
+  doc += " */\n";
+  return doc;
+}
 
 // src/utils/dynamic-import.ts
 var import_url = require("url");
@@ -49373,6 +49409,7 @@ var jsStringEscape = (input) => input.replace(/["'\\\n\r\u2028\u2029]/g, (charac
     case "'":
     case "\\":
       return "\\" + character;
+    // Four possible LineTerminator characters need to be escaped:
     case "\n":
       return "\\n";
     case "\r":
@@ -49431,38 +49468,42 @@ var getIsBodyVerb = (verb) => VERBS_WITH_BODY.includes(verb);
 var getEnumNames = (schemaObject) => {
   return schemaObject?.["x-enumNames"] || schemaObject?.["x-enumnames"] || schemaObject?.["x-enum-varnames"];
 };
-var getEnum = (value, enumName, names, enumGenerationType) => {
+var getEnumDescriptions = (schemaObject) => {
+  return schemaObject?.["x-enumDescriptions"] || schemaObject?.["x-enumdescriptions"] || schemaObject?.["x-enum-descriptions"];
+};
+var getEnum = (value, enumName, names, enumGenerationType, descriptions) => {
   if (enumGenerationType === EnumGeneration.CONST)
-    return getTypeConstEnum(value, enumName, names);
+    return getTypeConstEnum(value, enumName, names, descriptions);
   if (enumGenerationType === EnumGeneration.ENUM)
     return getNativeEnum(value, enumName, names);
   if (enumGenerationType === EnumGeneration.UNION)
     return getUnion(value, enumName);
   throw new Error(`Invalid enumGenerationType: ${enumGenerationType}`);
 };
-var getTypeConstEnum = (value, enumName, names) => {
+var getTypeConstEnum = (value, enumName, names, descriptions) => {
   let enumValue = `export type ${enumName} = typeof ${enumName}[keyof typeof ${enumName}]`;
   if (value.endsWith(" | null")) {
     value = value.replace(" | null", "");
     enumValue += " | null";
   }
   enumValue += ";\n";
-  const implementation = getEnumImplementation(value, names);
-  enumValue += `
-
-`;
+  const implementation = getEnumImplementation(value, names, descriptions);
+  enumValue += "\n\n";
   enumValue += "// eslint-disable-next-line @typescript-eslint/no-redeclare\n";
   enumValue += `export const ${enumName} = {
 ${implementation}} as const;
 `;
   return enumValue;
 };
-var getEnumImplementation = (value, names) => {
+var getEnumImplementation = (value, names, descriptions) => {
   if (value === "") return "";
   return [...new Set(value.split(" | "))].reduce((acc, val, index3) => {
     const name = names?.[index3];
+    const description = descriptions?.[index3];
+    const comment = description ? `  /** ${description} */
+` : "";
     if (name) {
-      return acc + `  ${import_esutils2.keyword.isIdentifierNameES5(name) ? name : `'${name}'`}: ${val},
+      return acc + comment + `  ${import_esutils2.keyword.isIdentifierNameES5(name) ? name : `'${name}'`}: ${val},
 `;
     }
     let key = val.startsWith("'") ? val.slice(1, -1) : val;
@@ -49478,7 +49519,7 @@ var getEnumImplementation = (value, names) => {
         special: true
       });
     }
-    return acc + `  ${import_esutils2.keyword.isIdentifierNameES5(key) ? key : `'${key}'`}: ${val},
+    return acc + comment + `  ${import_esutils2.keyword.isIdentifierNameES5(key) ? key : `'${key}'`}: ${val},
 `;
   }, "");
 };
@@ -49767,7 +49808,8 @@ var resolveObjectOriginal = ({
       resolvedValue.value,
       propName,
       getEnumNames(resolvedValue.originalSchema),
-      context.output.override.enumGenerationType
+      context.output.override.enumGenerationType,
+      getEnumDescriptions(resolvedValue.originalSchema)
     );
     return {
       value: propName,
@@ -50163,6 +50205,9 @@ var resolveSchemaPropertiesToFormData = ({
   const formDataValues = Object.entries(schema.properties ?? {}).reduce(
     (acc, [key, value]) => {
       const { schema: property } = resolveRef(value, context);
+      if (property.readOnly) {
+        return acc;
+      }
       let formDataValue = "";
       const formattedKeyPrefix = !isRequestBodyOptional ? "" : !import_esutils3.keyword.isIdentifierNameES5(key) ? "?." : "?";
       const formattedKey = !import_esutils3.keyword.isIdentifierNameES5(key) ? `['${key}']` : `.${key}`;
@@ -50423,7 +50468,7 @@ var getObject = ({
         if (!index3) {
           acc.value += "{";
         }
-        const doc = jsDoc(schema, true);
+        const doc = jsDoc(schema, true, context);
         acc.hasReadonlyProps ||= isReadOnly || false;
         acc.imports.push(...resolvedValue.imports);
         acc.value += `
@@ -50857,7 +50902,8 @@ var getCombineEnumValue = ({
       return `...${e3},`;
     }
     const names = getEnumNames(originalSchema[i3]);
-    return getEnumImplementation(e3, names);
+    const descriptions = getEnumDescriptions(originalSchema[i3]);
+    return getEnumImplementation(e3, names, descriptions);
   }).join("");
   return `{${enums}} as const`;
 };
@@ -51044,10 +51090,10 @@ var getProps = ({
   };
   const queryParamsProp = {
     name: "params",
-    definition: `params${queryParams?.isOptional ? "?" : ""}: ${queryParams?.schema.name}`,
-    implementation: `params${queryParams?.isOptional ? "?" : ""}: ${queryParams?.schema.name}`,
+    definition: `params${queryParams?.isOptional || context.output.allParamsOptional ? "?" : ""}: ${queryParams?.schema.name}`,
+    implementation: `params${queryParams?.isOptional || context.output.allParamsOptional ? "?" : ""}: ${queryParams?.schema.name}`,
     default: false,
-    required: !isUndefined(queryParams?.isOptional) ? !queryParams?.isOptional : false,
+    required: !isUndefined(queryParams?.isOptional) ? !queryParams?.isOptional && !context.output.allParamsOptional : !context.output.allParamsOptional,
     type: GetterPropType.QUERY_PARAM
   };
   const headersProp = {
@@ -51125,7 +51171,14 @@ var getQueryParamsTypes = (queryParams, operationName, context) => {
       name: queryName
     });
     const key = getKey(name);
-    const doc = jsDoc(parameter);
+    const doc = jsDoc(
+      {
+        description: parameter.description,
+        ...schema
+      },
+      void 0,
+      context
+    );
     if (parameterImports.length) {
       return {
         definition: `${doc}${key}${!required || schema.default ? "?" : ""}: ${parameterImports[0].name};`,
@@ -51140,7 +51193,8 @@ var getQueryParamsTypes = (queryParams, operationName, context) => {
         resolvedValue.value,
         enumName,
         getEnumNames(resolvedValue.originalSchema),
-        context.output.override.enumGenerationType
+        context.output.override.enumGenerationType,
+        getEnumDescriptions(resolvedValue.originalSchema)
       );
       return {
         definition: `${doc}${key}${!required || schema.default ? "?" : ""}: ${enumName};`,
@@ -52106,7 +52160,7 @@ var generateInterface = ({
   }
   if (scalar.type === "object" && !context?.output.override?.useTypeOverInterfaces) {
     if (scalar.type === "object" && schema.properties && Object.values(schema.properties).length > 0 && Object.values(schema.properties).every((item) => "const" in item)) {
-      const mappedScalarValue = scalar.value.replaceAll(";", ",");
+      const mappedScalarValue = scalar.value.replaceAll(";", ",").replaceAll("?:", ":");
       model += `export const ${name}Value = ${mappedScalarValue} as const;
 export type ${name} = typeof ${name}Value;
 `;
@@ -52181,7 +52235,8 @@ var generateSchemasDefinition = (schemas = {}, context, suffix, filters) => {
           resolvedValue.value,
           schemaName,
           getEnumNames(resolvedValue.originalSchema),
-          context.output.override.enumGenerationType
+          context.output.override.enumGenerationType,
+          getEnumDescriptions(resolvedValue.originalSchema)
         );
       } else if (schemaName === resolvedValue.value && resolvedValue.isRef) {
         const { schema: referredSchema } = resolveRef(schema, context);
@@ -53355,6 +53410,7 @@ var writeTagsMode = async ({
   getArray,
   getBody,
   getEnum,
+  getEnumDescriptions,
   getEnumImplementation,
   getEnumNames,
   getExtension,
@@ -53400,6 +53456,7 @@ var writeTagsMode = async ({
   jsDoc,
   jsStringEscape,
   kebab,
+  keyValuePairsToJsDoc,
   loadFile,
   log,
   logError,