@cparra/apexdocs 3.24.0 → 3.24.2

package/dist/cli/generate.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 'use strict';
 
-var errorCollector = require('../error-collector-DagrtuR3.js');
+var errorCollector = require('../error-collector-BbdZNqzo.js');
 var cosmiconfig = require('cosmiconfig');
 var yargs = require('yargs');
 var E = require('fp-ts/Either');
@@ -26,7 +26,7 @@ require('fs');
 require('fp-ts/lib/TaskEither.js');
 require('minimatch');
 require('@salesforce/source-deploy-retrieve');
-require('chalk');
+require('node:util');
 
 function _interopNamespaceDefault(e) {
   var n = Object.create(null);

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

@@ -21,7 +21,7 @@ var fs$1 = require('fs');
 var TE$1 = require('fp-ts/lib/TaskEither.js');
 var minimatch = require('minimatch');
 var sourceDeployRetrieve = require('@salesforce/source-deploy-retrieve');
-var chalk = require('chalk');
+var node_util = require('node:util');
 
 function _interopNamespaceDefault(e) {
   var n = Object.create(null);
@@ -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)];
   }
 }
 
@@ -6539,12 +6565,10 @@ class StdOutLogger {
     });
   }
   logSingle(text, color = "green") {
-    const logMessage = `${this.getChalkFn(color)((/* @__PURE__ */ new Date()).toLocaleString() + ": ")}${text}
-`;
-    process.stdout.write(logMessage);
-  }
-  getChalkFn(color) {
-    return color === "green" ? chalk.green : chalk.red;
+    const timestamp = (/* @__PURE__ */ new Date()).toLocaleString() + ": ";
+    const styled = typeof node_util.styleText === "function" ? node_util.styleText(color, timestamp) : timestamp;
+    process.stdout.write(`${styled}${text}
+`);
   }
 }
 class NoLogger {

package/dist/index.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 'use strict';
 
-var errorCollector = require('./error-collector-DagrtuR3.js');
+var errorCollector = require('./error-collector-BbdZNqzo.js');
 var E = require('fp-ts/Either');
 require('fp-ts/function');
 require('fp-ts/TaskEither');
@@ -23,7 +23,7 @@ require('fs');
 require('fp-ts/lib/TaskEither.js');
 require('minimatch');
 require('@salesforce/source-deploy-retrieve');
-require('chalk');
+require('node:util');
 
 function _interopNamespaceDefault(e) {
   var n = Object.create(null);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cparra/apexdocs",
-  "version": "3.24.0",
+  "version": "3.24.2",
   "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
   "engines": {
     "node": ">=22.12.0"
@@ -26,6 +26,7 @@
     "test:cov": "npm run build && vitest run --coverage",
     "build": "wireit",
     "lint": "wireit",
+    "format": "prettier --write src",
     "prepare": "npm run build",
     "version": "npm run format && git add -A src",
     "postversion": "git push && git push --tags"
@@ -72,12 +73,12 @@
   },
   "devDependencies": {
     "@eslint/js": "^9.34.0",
+    "@types/js-yaml": "^4.0.9",
     "@types/node": "^24.3.0",
+    "@types/yargs": "^17.0.32",
     "@vitest/coverage-v8": "^4.1.8",
     "eslint": "^9.34.0",
     "eslint-config-prettier": "^9.1.0",
-    "husky": "^9.0.11",
-    "lint-staged": "^15.2.7",
     "pkgroll": "^2.4.2",
     "prettier": "^3.3.2",
     "typescript": "^5.9.2",
@@ -85,22 +86,9 @@
     "vitest": "^4.1.8",
     "wireit": "^0.14.12"
   },
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged"
-    }
-  },
-  "lint-staged": {
-    "*.{js,ts,tsx}": [
-      "eslint --fix"
-    ]
-  },
   "dependencies": {
     "@cparra/apex-reflection": "4.0.0",
     "@salesforce/source-deploy-retrieve": "^12.20.1",
-    "@types/js-yaml": "^4.0.9",
-    "@types/yargs": "^17.0.32",
-    "chalk": "^4.1.2",
     "cosmiconfig": "^9.0.0",
     "cosmiconfig-typescript-loader": "^5.0.0",
     "fast-xml-parser": "^5.5.9",