@arizeai/phoenix-client 2.3.5 → 3.0.0

package/dist/esm/spans/deleteSpan.d.ts

@@ -0,0 +1,48 @@
+import { ClientFn } from "../types/core.js";
+/**
+ * Parameters to delete a span
+ */
+export interface DeleteSpanParams extends ClientFn {
+    /**
+     * The span identifier. Can be either:
+     * - OpenTelemetry span_id (string)
+     * - Phoenix Global ID (string)
+     */
+    spanIdentifier: string;
+}
+/**
+ * Delete a single span by identifier.
+ *
+ * **Important**: This operation deletes ONLY the specified span itself and does NOT
+ * delete its descendants/children. All child spans will remain in the trace and
+ * become orphaned (their parent_id will point to a non-existent span).
+ *
+ * Behavior:
+ * - Deletes only the target span (preserves all descendant spans)
+ * - Child spans become orphaned but remain in the database
+ * - Returns successfully if span is found and deleted
+ * - Throws error if span is not found (404) or other errors occur
+ *
+ * @experimental this function is experimental and may change in the future
+ *
+ * @param params - The parameters to delete a span
+ * @returns Promise that resolves when the span is successfully deleted
+ * @throws Error if the span is not found or deletion fails
+ *
+ * @example
+ * ```ts
+ * // Delete by OpenTelemetry span_id
+ * await deleteSpan({
+ *   client,
+ *   spanIdentifier: "abc123def456"
+ * });
+ *
+ * // Delete by Phoenix Global ID
+ * await deleteSpan({
+ *   client,
+ *   spanIdentifier: "U3BhbjoyMzQ1Njc4OQ=="
+ * });
+ * ```
+ */
+export declare function deleteSpan({ client: _client, spanIdentifier, }: DeleteSpanParams): Promise<void>;
+//# sourceMappingURL=deleteSpan.d.ts.map

package/dist/esm/spans/deleteSpan.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deleteSpan.d.ts","sourceRoot":"","sources":["../../../src/spans/deleteSpan.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,QAAQ;IAChD;;;;OAIG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,wBAAsB,UAAU,CAAC,EAC/B,MAAM,EAAE,OAAO,EACf,cAAc,GACf,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CA4BlC"}

package/dist/esm/spans/deleteSpan.js

@@ -0,0 +1,60 @@
+import { createClient } from "../client.js";
+/**
+ * Delete a single span by identifier.
+ *
+ * **Important**: This operation deletes ONLY the specified span itself and does NOT
+ * delete its descendants/children. All child spans will remain in the trace and
+ * become orphaned (their parent_id will point to a non-existent span).
+ *
+ * Behavior:
+ * - Deletes only the target span (preserves all descendant spans)
+ * - Child spans become orphaned but remain in the database
+ * - Returns successfully if span is found and deleted
+ * - Throws error if span is not found (404) or other errors occur
+ *
+ * @experimental this function is experimental and may change in the future
+ *
+ * @param params - The parameters to delete a span
+ * @returns Promise that resolves when the span is successfully deleted
+ * @throws Error if the span is not found or deletion fails
+ *
+ * @example
+ * ```ts
+ * // Delete by OpenTelemetry span_id
+ * await deleteSpan({
+ *   client,
+ *   spanIdentifier: "abc123def456"
+ * });
+ *
+ * // Delete by Phoenix Global ID
+ * await deleteSpan({
+ *   client,
+ *   spanIdentifier: "U3BhbjoyMzQ1Njc4OQ=="
+ * });
+ * ```
+ */
+export async function deleteSpan({ client: _client, spanIdentifier, }) {
+    const client = _client ?? createClient();
+    const { error } = await client.DELETE("/v1/spans/{span_identifier}", {
+        params: {
+            path: {
+                span_identifier: spanIdentifier,
+            },
+        },
+    });
+    if (error) {
+        const isNotFound = typeof error === "object" &&
+            error !== null &&
+            "status" in error &&
+            error.status === 404;
+        if (isNotFound) {
+            throw new Error(`Span not found: ${spanIdentifier}`);
+        }
+        // Extract meaningful error information
+        const errorMessage = typeof error === "object" && error !== null
+            ? JSON.stringify(error, null, 2)
+            : String(error);
+        throw new Error(`Failed to delete span: ${errorMessage}`);
+    }
+}
+//# sourceMappingURL=deleteSpan.js.map

package/dist/esm/spans/deleteSpan.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deleteSpan.js","sourceRoot":"","sources":["../../../src/spans/deleteSpan.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAezC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,EAC/B,MAAM,EAAE,OAAO,EACf,cAAc,GACG;IACjB,MAAM,MAAM,GAAG,OAAO,IAAI,YAAY,EAAE,CAAC;IAEzC,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,6BAA6B,EAAE;QACnE,MAAM,EAAE;YACN,IAAI,EAAE;gBACJ,eAAe,EAAE,cAAc;aAChC;SACF;KACF,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,UAAU,GACd,OAAO,KAAK,KAAK,QAAQ;YACzB,KAAK,KAAK,IAAI;YACd,QAAQ,IAAI,KAAK;YACjB,KAAK,CAAC,MAAM,KAAK,GAAG,CAAC;QACvB,IAAI,UAAU,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,mBAAmB,cAAc,EAAE,CAAC,CAAC;QACvD,CAAC;QAED,uCAAuC;QACvC,MAAM,YAAY,GAChB,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI;YACzC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;YAChC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,0BAA0B,YAAY,EAAE,CAAC,CAAC;IAC5D,CAAC;AACH,CAAC"}

package/dist/esm/spans/index.d.ts

@@ -2,4 +2,5 @@ export * from "./addSpanAnnotation.js";
 export * from "./logSpanAnnotations.js";
 export * from "./getSpans.js";
 export * from "./getSpanAnnotations.js";
+export * from "./deleteSpan.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/esm/spans/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/spans/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,YAAY,CAAC;AAC3B,cAAc,sBAAsB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/spans/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,YAAY,CAAC;AAC3B,cAAc,sBAAsB,CAAC;AACrC,cAAc,cAAc,CAAC"}

package/dist/esm/spans/index.js

@@ -2,4 +2,5 @@ export * from "./addSpanAnnotation.js";
 export * from "./logSpanAnnotations.js";
 export * from "./getSpans.js";
 export * from "./getSpanAnnotations.js";
+export * from "./deleteSpan.js";
 //# sourceMappingURL=index.js.map

package/dist/esm/spans/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/spans/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,YAAY,CAAC;AAC3B,cAAc,sBAAsB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/spans/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,YAAY,CAAC;AAC3B,cAAc,sBAAsB,CAAC;AACrC,cAAc,cAAc,CAAC"}