@apm-js-collab/code-transformer 0.8.2 → 0.9.0

package/README.md

@@ -1,7 +1,4 @@
-# `@apm-js-collab/code-transformer`
-
-This is a fork of
-[`DataDog/orchestrion-js`](https://github.com/DataDog/orchestrion-js/).
+# Orchestrion-JS / `@apm-js-collab/code-transformer`
 
 This is a library to aid in instrumenting Node.js libraries at build or load
 time.
@@ -79,6 +76,32 @@ matcher.free();
 transformer.free();
 ```
 
+### Export Aliases
+
+When a module re-exports a function or class under a different name using
+`export { local as exported }`, you can target the **exported** name in your
+`FunctionQuery` by setting `isExportAlias: true`. The transformer will resolve
+the alias to the local declaration before matching.
+
+For example, given:
+
+```js
+function f(url) { return fetch(url); }
+export { f as fetchAliased };
+```
+
+You can target `fetchAliased` in your config:
+
+```js
+const instrumentation = {
+    channelName: "my-channel",
+    module: { name: "my-module", versionRange: ">=1.0.0", filePath: "./index.mjs" },
+    functionQuery: { functionName: "fetchAliased", kind: "Async", isExportAlias: true },
+};
+```
+
+This also works for class exports (e.g., `export { MyClass as PublicClass }`).
+
 ### API Reference
 
 ```ts
@@ -91,20 +114,23 @@ type FunctionKind = "Sync" | "Async";
 ```ts
 type FunctionQuery =
     | // Match class constructor
-    { className: string; index?: number }
+    { className: string; index?: number; isExportAlias?: boolean }
     | // Match class method
     {
         className: string;
         methodName: string;
         kind: FunctionKind;
         index?: number;
+        isExportAlias?: boolean;
     }
     | // Match method on objects
     { methodName: string; kind: FunctionKind; index?: number }
     | // Match standalone function
-    { functionName: string; kind: FunctionKind; index?: number }
+    { functionName: string; kind: FunctionKind; index?: number; isExportAlias?: boolean }
     | // Match arrow function or function expression
-    { expressionName: string; kind: FunctionKind; index?: number };
+    { expressionName: string; kind: FunctionKind; index?: number; isExportAlias?: boolean };
+    | // Match private class methods
+    { className: string; privateMethodName: string; kind: FunctionKind; index?: number };
 ```
 
 #### **`ModuleMatcher`**

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@apm-js-collab/code-transformer",
-  "version": "0.8.2",
+  "version": "0.9.0",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
-    "url": "https://github.com/apm-js-collab/orchestrion-js.git"
+    "url": "https://github.com/nodejs/orchestrion-js.git"
   },
   "files": [
     "./pkg/orchestrion_js.js",

package/pkg/orchestrion_js.d.ts

@@ -18,6 +18,16 @@ export interface TransformOutput {
     map: string | undefined;
 }
 
+/**
+ * Describes which function to instrument
+ */
+export type FunctionQuery = { className: string; methodName: string; kind: FunctionKind; index?: number; isExportAlias?: boolean } | { className: string; privateMethodName: string; kind: FunctionKind; index?: number } | { className: string; index?: number; isExportAlias?: boolean } | { methodName: string; kind: FunctionKind; index?: number } | { functionName: string; kind: FunctionKind; index?: number; isExportAlias?: boolean } | { expressionName: string; kind: FunctionKind; index?: number; isExportAlias?: boolean };
+
+/**
+ * The kind of function - Sync or returns a promise
+ */
+export type FunctionKind = "Sync" | "Async";
+
 /**
  * Configuration for injecting instrumentation code
  */
@@ -54,16 +64,6 @@ export interface ModuleMatcher {
     filePath: string;
 }
 
-/**
- * Describes which function to instrument
- */
-export type FunctionQuery = { className: string; methodName: string; kind: FunctionKind; index?: number } | { className: string; index?: number } | { methodName: string; kind: FunctionKind; index?: number } | { functionName: string; kind: FunctionKind; index?: number } | { expressionName: string; kind: FunctionKind; index?: number };
-
-/**
- * The kind of function - Sync or returns a promise
- */
-export type FunctionKind = "Sync" | "Async";
-
 /**
  * The type of module being passed - ESM, CJS or unknown
  */