docs: typedoc for javascript modules (#2379)

Author: mikeldking

.gitignore

@@ -17,6 +17,9 @@ sdist
 .safety-project.ini
 .mastra
 
+# Generated docs
+js/**/docs
+
 # Data files
 *.csv
 *.parquet

js/README.md

@@ -2,12 +2,9 @@
 
 This is the JavaScript version of OpenInference, a framework for collecting traces from LLM applications.
 
-> [!NOTE]
-> Currently we only support OpenAI but we are working on adding support for other LLM frameworks and SDKs. If you are interested in contributing, please reach out to us by joining our slack community or opening an issue!
-
 ## Installation
 
-OpenInference uses OpenTelemetry Protocol (OTLP) to send traces to a compatible backend (e.x. [arize-phoenix](<[https://git](https://github.com/Arize-ai/phoenix)>)). To use OpenInference, you will need to install the OpenTelemetry SDK and the OpenInference instrumentation for the LLM framework you are using.
+OpenInference uses OpenTelemetry Protocol (OTLP) to send traces to a compatible backend (e.x. [arize-phoenix](https://github.com/Arize-ai/phoenix)). To use OpenInference, you will need to install the OpenTelemetry SDK and the OpenInference instrumentation for the LLM framework you are using.
 
 Install the OpenTelemetry SDK:
 

js/package.json

@@ -13,7 +13,9 @@
     "type:check": "pnpm run -r type:check",
     "lint": "eslint .",
     "ci:version": "pnpm changeset version",
-    "ci:publish": "pnpm run -r prebuild && pnpm run -r build && pnpm publish -r --access public --provenance"
+    "ci:publish": "pnpm run -r prebuild && pnpm run -r build && pnpm publish -r --access public --provenance",
+    "docs:generate": "typedoc",
+    "docs:preview": "rimraf docs && pnpm docs:generate && pnpx http-server ./docs -p 8080 -o"
   },
   "keywords": [
     "telemetry",
@@ -32,6 +34,7 @@
     "prettier": "^3.6.2",
     "rimraf": "^5.0.9",
     "tsc-alias": "^1.8.10",
+    "typedoc": "^0.28.14",
     "typescript": "^5.5.4",
     "typescript-eslint": "^8.46.2",
     "vitest": "^4.0.3"

js/packages/openinference-core/src/trace/trace-config/OITracer.ts

@@ -53,9 +53,9 @@ export class OITracer implements Tracer {
   private readonly tracer: Tracer;
   private readonly config: TraceConfig;
   /**
-   *
-   * @param tracer The OpenTelemetry {@link Tracer} to wrap
-   * @param traceConfig The {@link TraceConfigOptions} to set to control the behavior of the tracer
+   * @param params - The parameters for the OITracer constructor
+   * @param params.tracer - The OpenTelemetry {@link Tracer} to wrap
+   * @param params.traceConfig - The {@link TraceConfigOptions} to set to control the behavior of the tracer
    */
   constructor({
     tracer,

js/packages/openinference-core/src/trace/trace-config/maskingRules.ts

@@ -205,9 +205,10 @@ const maskingRules: MaskingRule[] = [
 
 /**
  * A function that masks (redacts or removes) sensitive information from span attributes based on the trace config.
- * @param config The {@link TraceConfig} to use to determine if the value should be masked
- * @param key The key of the attribute to mask
- * @param value The value of the attribute to mask
+ * @param params - The masking parameters
+ * @param params.config - The TraceConfig to use to determine if the value should be masked
+ * @param params.key - The key of the attribute to mask
+ * @param params.value - The value of the attribute to mask
  * @returns The redacted value or undefined if the value should be masked, otherwise the original value
  */
 export function mask({

js/packages/openinference-core/src/trace/trace-config/types.ts

@@ -24,7 +24,7 @@ export type TraceConfig = Readonly<Required<TraceConfigOptions>>;
 
 export type TraceConfigKey = keyof TraceConfig;
 
-type BooleanTraceConfigFlag = {
+export type BooleanTraceConfigFlag = {
   /**
    * The default value for the flag
    */
@@ -39,7 +39,7 @@ type BooleanTraceConfigFlag = {
   type: "boolean";
 };
 
-type NumericTraceConfigFlag = {
+export type NumericTraceConfigFlag = {
   /**
    * The default value for the flag
    */

js/packages/openinference-genai/src/attributes.ts

@@ -225,7 +225,7 @@ export const convertGenAISpanAttributesToOpenInferenceSpanAttributes = (
 
 /**
  * Map provider and system to openinference attributes
- * @todo add some heuristics that can map incoming provider names to the correct OpenInference provider name
+ * @remarks TODO: add some heuristics that can map incoming provider names to the correct OpenInference provider name
  * @param spanAttributes - The span attributes containing provider and system to map
  * @returns The mapped provider and system attributes
  */

js/packages/openinference-vercel/src/utils.ts

@@ -51,7 +51,7 @@ const getVercelFunctionNameFromOperationName = (
 
 /**
  * Gets the OpenInference span kind that corresponds to the Vercel operation name
- * @param attributes the attributes of the span
+ * @param attributes - The attributes of the span
  * @returns the OpenInference span kind associated with the attributes or null if not found
  */
 const getOISpanKindFromAttributes = (
@@ -411,9 +411,7 @@ const safelyGetMetadataAttributes = withSafety({
 
 /**
  * Gets the OpenInference attributes associated with the span from the initial attributes
- * @param attributesWithSpanKind the initial attributes of the span and the OpenInference span kind
- * @param attributesWithSpanKind.attributes the initial attributes of the span
- * @param attributesWithSpanKind.spanKind the OpenInference span kind
+ * @param attributes - The initial attributes of the span
  * @returns The OpenInference attributes associated with the span
  */
 const getOpenInferenceAttributes = (attributes: Attributes): Attributes => {
@@ -567,8 +565,9 @@ export const isOpenInferenceSpan = (span: ReadableSpan) => {
 
 /**
  * Determines whether a span should be exported based on configuration and the spans attributes.
- * @param span the spn to check for export eligibility.
- * @param spanFilter a filter to apply to a span before exporting. If it returns true for a given span, the span will be exported.
+ * @param params - The parameters object
+ * @param params.span - The span to check for export eligibility
+ * @param params.spanFilter - A filter to apply to a span before exporting. If it returns true for a given span, the span will be exported
  * @returns true if the span should be exported, false otherwise.
  */
 export const shouldExportSpan = ({