@arizeai/phoenix-client 7.12.0 → 7.13.0

package/dist/src/secrets/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./upsertOrDeleteSecrets";
+//# sourceMappingURL=index.d.ts.map

package/dist/src/secrets/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/secrets/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC"}

package/dist/src/secrets/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./upsertOrDeleteSecrets"), exports);
+//# sourceMappingURL=index.js.map

package/dist/src/secrets/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/secrets/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0DAAwC"}

package/dist/src/secrets/upsertOrDeleteSecrets.d.ts

@@ -0,0 +1,60 @@
+import type { ClientFn } from "../types/core";
+/**
+ * A secret to create, update, or delete.
+ */
+export interface SecretInput {
+    /** The environment-style key used to identify the secret. */
+    key: string;
+    /** A value to create or update, or `null` to delete the key. */
+    value: string | null;
+}
+/**
+ * Parameters for atomically updating secrets.
+ */
+export interface UpsertOrDeleteSecretsParams extends ClientFn {
+    /**
+     * Ordered secret updates. When a key occurs more than once, the server
+     * applies only its last occurrence.
+     */
+    secrets: SecretInput[];
+}
+/**
+ * The names of the keys changed by a secrets update.
+ *
+ * Secret values are intentionally excluded.
+ */
+export interface UpsertOrDeleteSecretsResult {
+    /** Keys that were created or updated. */
+    upsertedKeys: string[];
+    /** Keys that were deleted. */
+    deletedKeys: string[];
+}
+/**
+ * Atomically create, update, or delete a batch of Phoenix secrets.
+ *
+ * A non-null value creates or updates a secret, while `null` deletes it.
+ * Duplicate keys use the last occurrence in the batch. The result contains
+ * key names only; submitted values are never returned or logged.
+ *
+ * @param params - The secrets update.
+ * @param params.client - Optional Phoenix client instance.
+ * @param params.secrets - Ordered key/value-or-null updates.
+ * @returns The names of the keys that were upserted and deleted.
+ *
+ * @example
+ * ```ts
+ * import { upsertOrDeleteSecrets } from "@arizeai/phoenix-client/secrets";
+ *
+ * const apiKey = process.env.OPENAI_API_KEY;
+ * if (!apiKey) throw new Error("OPENAI_API_KEY is required");
+ *
+ * const result = await upsertOrDeleteSecrets({
+ *   secrets: [
+ *     { key: "OPENAI_API_KEY", value: apiKey },
+ *     { key: "OLD_PROVIDER_API_KEY", value: null },
+ *   ],
+ * });
+ * ```
+ */
+export declare function upsertOrDeleteSecrets({ client: _client, secrets, }: UpsertOrDeleteSecretsParams): Promise<UpsertOrDeleteSecretsResult>;
+//# sourceMappingURL=upsertOrDeleteSecrets.d.ts.map

package/dist/src/secrets/upsertOrDeleteSecrets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"upsertOrDeleteSecrets.d.ts","sourceRoot":"","sources":["../../../src/secrets/upsertOrDeleteSecrets.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAE9C;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,6DAA6D;IAC7D,GAAG,EAAE,MAAM,CAAC;IACZ,gEAAgE;IAChE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,QAAQ;IAC3D;;;OAGG;IACH,OAAO,EAAE,WAAW,EAAE,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IAC1C,yCAAyC;IACzC,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,8BAA8B;IAC9B,WAAW,EAAE,MAAM,EAAE,CAAC;CACvB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAsB,qBAAqB,CAAC,EAC1C,MAAM,EAAE,OAAO,EACf,OAAO,GACR,EAAE,2BAA2B,GAAG,OAAO,CAAC,2BAA2B,CAAC,CAoBpE"}

package/dist/src/secrets/upsertOrDeleteSecrets.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.upsertOrDeleteSecrets = upsertOrDeleteSecrets;
+const client_1 = require("../client");
+/**
+ * Atomically create, update, or delete a batch of Phoenix secrets.
+ *
+ * A non-null value creates or updates a secret, while `null` deletes it.
+ * Duplicate keys use the last occurrence in the batch. The result contains
+ * key names only; submitted values are never returned or logged.
+ *
+ * @param params - The secrets update.
+ * @param params.client - Optional Phoenix client instance.
+ * @param params.secrets - Ordered key/value-or-null updates.
+ * @returns The names of the keys that were upserted and deleted.
+ *
+ * @example
+ * ```ts
+ * import { upsertOrDeleteSecrets } from "@arizeai/phoenix-client/secrets";
+ *
+ * const apiKey = process.env.OPENAI_API_KEY;
+ * if (!apiKey) throw new Error("OPENAI_API_KEY is required");
+ *
+ * const result = await upsertOrDeleteSecrets({
+ *   secrets: [
+ *     { key: "OPENAI_API_KEY", value: apiKey },
+ *     { key: "OLD_PROVIDER_API_KEY", value: null },
+ *   ],
+ * });
+ * ```
+ */
+async function upsertOrDeleteSecrets({ client: _client, secrets, }) {
+    const client = _client !== null && _client !== void 0 ? _client : (0, client_1.createClient)();
+    const { data, error } = await client.PUT("/v1/secrets", {
+        body: { secrets },
+    });
+    // Do not include the server error payload here: validation responses can be
+    // influenced by submitted data, which must never enter helper error text.
+    if (error) {
+        throw new Error("Failed to upsert or delete secrets");
+    }
+    if (!(data === null || data === void 0 ? void 0 : data.data)) {
+        throw new Error("Failed to upsert or delete secrets: no data returned");
+    }
+    return {
+        upsertedKeys: data.data.upserted_keys,
+        deletedKeys: data.data.deleted_keys,
+    };
+}
+//# sourceMappingURL=upsertOrDeleteSecrets.js.map

package/dist/src/secrets/upsertOrDeleteSecrets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"upsertOrDeleteSecrets.js","sourceRoot":"","sources":["../../../src/secrets/upsertOrDeleteSecrets.ts"],"names":[],"mappings":";;;AAAA,sCAAyC;AAoCzC;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACI,KAAK,gCAAgC,EAC1C,MAAM,EAAE,OAAO,EACf,OAAO,GACqB;IAC5B,MAAM,MAAM,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,IAAA,qBAAY,GAAE,CAAC;IACzC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,aAAa,EAAE;QACtD,IAAI,EAAE,EAAE,OAAO,EAAE;KAClB,CAAC,CAAC;IAEH,4EAA4E;IAC5E,0EAA0E;IAC1E,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACxD,CAAC;IAED,IAAI,EAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI,CAAA,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;IAC1E,CAAC;IAED,OAAO;QACL,YAAY,EAAE,IAAI,CAAC,IAAI,CAAC,aAAa;QACrC,WAAW,EAAE,IAAI,CAAC,IAAI,CAAC,YAAY;KACpC,CAAC;AACJ,CAAC"}