@arizeai/phoenix-client 7.12.0 → 7.13.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @arizeai/phoenix-client
 
+## 7.13.0
+
+### Minor Changes
+
+- c282563: Add an `upsertOrDeleteSecrets` helper to the new `secrets` subpath. It atomically creates, updates, or deletes ordered key/value-or-null batches through `PUT /v1/secrets`, returns only the affected key names, and keeps submitted values out of helper output and error messages.
+
 ## 7.12.0
 
 ### Minor Changes

package/README.md

@@ -797,6 +797,33 @@ await setProjectRetentionPolicy({
 
 This helper only changes a project's assignment to an existing policy. Creating, reading, updating, and deleting retention policies is outside the scope of the TypeScript projects helper.
 
+## Secrets
+
+Use the `secrets` entrypoint to atomically create, update, or delete encrypted
+provider credentials. A string value creates or updates a key, while `null`
+deletes it. Duplicate keys use the last occurrence in the batch. The result
+contains only changed key names and never returns secret values.
+
+```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 },
+  ],
+});
+
+console.log(result.upsertedKeys);
+console.log(result.deletedKeys);
+```
+
+Managing secrets requires an administrator when Phoenix authentication is
+enabled. Avoid logging the request batch or otherwise retaining its values.
+
 ## Examples
 
 To run examples, install dependencies using `pnpm` and run:

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

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

package/dist/esm/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/esm/secrets/index.js

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

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

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

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

@@ -0,0 +1,60 @@
+import type { ClientFn } from "../types/core.js";
+/**
+ * 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/esm/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/esm/secrets/upsertOrDeleteSecrets.js

@@ -0,0 +1,47 @@
+import { createClient } from "../client.js";
+/**
+ * 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 async function upsertOrDeleteSecrets({ client: _client, secrets, }) {
+    const client = _client ?? 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?.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/esm/secrets/upsertOrDeleteSecrets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"upsertOrDeleteSecrets.js","sourceRoot":"","sources":["../../../src/secrets/upsertOrDeleteSecrets.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAoCzC;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,EAC1C,MAAM,EAAE,OAAO,EACf,OAAO,GACqB;IAC5B,MAAM,MAAM,GAAG,OAAO,IAAI,YAAY,EAAE,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,CAAC,IAAI,EAAE,IAAI,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"}