@miradorlabs/parallax-web 1.0.2 → 1.0.4

package/dist/index.d.ts

@@ -7,32 +7,124 @@ declare class ParallaxClient {
     apiUrl: string;
     private client;
     constructor(apiKey?: string | undefined, apiUrl?: string);
+    /**
+     * Gather client metadata for traces/spans
+     * Returns a metadata object with client environment details
+     * This includes browser, OS, screen size, IP address, and more
+     * @returns metadata
+     */
+    getClientMetadata(): Promise<{
+        [key: string]: string;
+    }>;
+    /**
+     * Creates a CreateTraceRequest with optional attributes and client metadata
+     * @param name name of the trace
+     * @param tags optional tags for trace
+     * @param attr optional attributes for trace
+     * @param includeClientMeta optional flag to include client metadata (ip, browser, os, etc)
+     * @returns a CreateTraceRequest object to be used for the createTrace request
+     */
+    createTraceRequest({ name, tags, attr, includeClientMeta }: {
+        name: string;
+        tags?: string[];
+        attr?: {
+            [key: string]: string;
+        };
+        includeClientMeta?: boolean;
+    }): Promise<CreateTraceRequest>;
     /**
      * Create a new trace
      * @param params Parameters to create a new trace
      * @returns Response from the create trace operation
      */
     createTrace(params: CreateTraceRequest): Promise<CreateTraceResponse>;
+    /**
+     * Create a StartSpanRequest with optional attributes and client metadata
+     * @param traceId trace id to associate the span with
+     * @param name name of the span
+     * @param parentSpanId (optional) create a span off a parent span id
+     * @param attr (optional) attributes to add to the span
+     * @param includeClientMeta (optional) flag to include client metadata (ip, browser, os, etc)
+     * @returns
+     */
+    createStartSpanRequest({ traceId, name, parentSpanId, attr, includeClientMeta }: {
+        traceId: string;
+        name: string;
+        parentSpanId?: string;
+        attr?: {
+            [key: string]: string;
+        };
+        includeClientMeta?: boolean;
+    }): Promise<StartSpanRequest>;
     /**
      * Start a new span within a trace
      * @param params Parameters to start a new span
      */
     startSpan(params: StartSpanRequest): Promise<StartSpanResponse>;
+    /**
+     * Create a FinishSpanRequest
+     * @param params Parameters to finish a span - traceId, spanId, status (optional) (success, errorMessage)
+     * @returns FinishSpanRequest
+     */
+    createFinishSpanRequest({ traceId, spanId, status }: {
+        traceId: string;
+        spanId: string;
+        status?: {
+            success: boolean;
+            errorMessage: string;
+        };
+    }): FinishSpanRequest;
     /**
      * Finish a span within a trace
      * @param params Parameters to finish a span
      */
     finishSpan(params: FinishSpanRequest): Promise<FinishSpanResponse>;
+    /**
+     * Creates the add span event request
+     * @param params - Parameters to create an AddSpanEventRequest - traceId, spanId, eventName, attr (optional)
+     * @returns AddSpanEventRequest
+     */
+    createAddSpanEventRequest({ traceId, spanId, eventName, attr }: {
+        traceId: string;
+        spanId: string;
+        eventName: string;
+        attr?: {
+            [key: string]: string;
+        };
+    }): AddSpanEventRequest;
     /**
      * Add an event to a span
      * @param params Parameters to add an event to a span
      */
     addSpanEvent(params: AddSpanEventRequest): Promise<AddSpanEventResponse>;
+    /**
+     * Creates the add span error request
+     * @param params - params used to generate the error request ( traceid, span id, error message, error type, stack trace)
+     * @returns AddSpanErrorRequest
+     */
+    createAddSpanErrorRequest({ traceId, spanId, errorMessage, errorType, stackTrace }: {
+        traceId: string;
+        spanId: string;
+        errorMessage: string;
+        errorType?: string;
+        stackTrace?: string;
+    }): AddSpanErrorRequest;
     /**
      * Add an error to a span
      * @param params Parameters to add an error to a span
      */
     addSpanError(params: AddSpanErrorRequest): Promise<AddSpanErrorResponse>;
+    /**
+     * Creates the add span hint request
+     * @param params - params used to generate the span hint (trace id, parentSpanId, txHash and chainId)
+     * @returns AddSpanHintRequest
+     */
+    createAddSpanHintRequest({ traceId, parentSpanId, txHash, chainId }: {
+        traceId: string;
+        parentSpanId: string;
+        txHash?: string;
+        chainId?: number;
+    }): AddSpanHintRequest;
     /**
      * Add a hint to a span
      * @param params Parameters to add a hint to a span