@cparra/apexdocs 3.24.1 → 3.24.2

package/dist/cli/generate.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 'use strict';
 
-var errorCollector = require('../error-collector-C2U2sWQ6.js');
+var errorCollector = require('../error-collector-BbdZNqzo.js');
 var cosmiconfig = require('cosmiconfig');
 var yargs = require('yargs');
 var E = require('fp-ts/Either');

package/dist/{error-collector-C2U2sWQ6.js → error-collector-BbdZNqzo.js}

@@ -4692,6 +4692,11 @@ class MethodMirrorWrapper {
       var _a;
       return (_a = this.methodMirror.docComment) == null ? void 0 : _a.annotations.find((annotation) => annotation.name.toLowerCase() === annotationName);
     };
+    /** The body of these annotations is expected to be in YAML format. */
+    this.getDocCommentAnnotationsAs = (annotationName) => {
+      var _a, _b;
+      return ((_b = (_a = this.methodMirror.docComment) == null ? void 0 : _a.annotations) != null ? _b : []).filter((annotation) => annotation.name.toLowerCase() === annotationName).map((annotation) => yaml__namespace.load(annotation.bodyLines.join("\n"))).filter((parsed) => parsed !== void 0);
+    };
   }
 }
 
@@ -4907,16 +4912,16 @@ class OpenApiDocsProcessor {
   }
   onProcess(type) {
     var _a, _b;
-    const endpointPath = this.getEndpointPath(type);
-    if (!endpointPath) {
+    const typeAsClass = type;
+    const endpoint = this.getEndpoint(typeAsClass);
+    if (!endpoint) {
       return;
     }
+    const { path: endpointPath, tagName } = endpoint;
     this.openApiModel.paths[endpointPath] = {};
     if ((_a = type.docComment) == null ? void 0 : _a.description) {
       this.openApiModel.paths[endpointPath].description = type.docComment.description;
     }
-    const typeAsClass = type;
-    const tagName = camel2title(endpointPath);
     this.openApiModel.tags.push({
       name: tagName,
       description: (_b = type.docComment) == null ? void 0 : _b.description
@@ -4928,7 +4933,7 @@ class OpenApiDocsProcessor {
     parser.parseMethod(typeAsClass, endpointPath, "put", tagName);
     parser.parseMethod(typeAsClass, endpointPath, "delete", tagName);
   }
-  getEndpointPath(type) {
+  getEndpoint(type) {
     var _a;
     const restResourceAnnotation = type.annotations.find((element) => element.name.toLowerCase() === "restresource");
     const urlMapping = (_a = restResourceAnnotation == null ? void 0 : restResourceAnnotation.elementValues) == null ? void 0 : _a.find(
@@ -4938,7 +4943,28 @@ class OpenApiDocsProcessor {
       this.logger.error(`Type does not contain urlMapping annotation ${type.name}`);
       return null;
     }
-    return urlMapping.value.replaceAll('"', "").replaceAll("'", "").replaceAll("/*", "/");
+    const rawPath = urlMapping.value.replaceAll('"', "").replaceAll("'", "");
+    const segments = rawPath.split("/");
+    const parameterNames = segments.includes("*") ? this.getPathParameterNames(type) : [];
+    let wildcardIndex = 0;
+    let fallbackIndex = 0;
+    const path = segments.map(
+      (segment) => {
+        var _a2;
+        return segment === "*" ? `{${(_a2 = parameterNames[wildcardIndex++]) != null ? _a2 : `param${++fallbackIndex}`}}` : segment;
+      }
+    ).join("/");
+    return { path, tagName: camel2title(segments.filter((segment) => segment !== "*").join("/")) };
+  }
+  /**
+   * Returns the names of all parameters declared as `in: path` through @http-parameter
+   * doc annotations on the class's methods, in the order the methods are declared.
+   */
+  getPathParameterNames(type) {
+    const names = type.methods.flatMap(
+      (method) => new MethodMirrorWrapper(method).getDocCommentAnnotationsAs("http-parameter")
+    ).filter((parameter) => parameter.in === "path" && parameter.name).map((parameter) => parameter.name);
+    return [...new Set(names)];
   }
 }
 

package/dist/index.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 'use strict';
 
-var errorCollector = require('./error-collector-C2U2sWQ6.js');
+var errorCollector = require('./error-collector-BbdZNqzo.js');
 var E = require('fp-ts/Either');
 require('fp-ts/function');
 require('fp-ts/TaskEither');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cparra/apexdocs",
-  "version": "3.24.1",
+  "version": "3.24.2",
   "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
   "engines": {
     "node": ">=22.12.0"