@djangocfg/api 2.1.441 → 2.1.443

package/dist/hooks.d.cts

@@ -3,12 +3,25 @@ interface ApiKeyTestResult {
     userId: string | null;
 }
 interface UseApiKeyReturn {
+    /**
+     * The key to display. Masked by default (from retrieve). Becomes the FULL
+     * value after `reveal()` or `regenerate()` resolves, so the user can copy it.
+     */
     apiKey: string | null;
+    /** True once `reveal()`/`regenerate()` has surfaced the full (unmasked) key. */
+    isRevealed: boolean;
     reissuedAt: string | null;
     createdAt: string | null;
     isLoading: boolean;
+    isRevealing: boolean;
     isRegenerating: boolean;
     isTesting: boolean;
+    /**
+     * Fetch the current full key WITHOUT rotating it (the durable value every one
+     * of the user's agents uses). Use this to let the user copy their key for
+     * agent onboarding — `regenerate()` would invalidate the agents already using it.
+     */
+    reveal: () => Promise<void>;
     regenerate: () => Promise<void>;
     testKey: (key: string) => Promise<ApiKeyTestResult>;
     refresh: () => void;

package/dist/hooks.d.ts

@@ -3,12 +3,25 @@ interface ApiKeyTestResult {
     userId: string | null;
 }
 interface UseApiKeyReturn {
+    /**
+     * The key to display. Masked by default (from retrieve). Becomes the FULL
+     * value after `reveal()` or `regenerate()` resolves, so the user can copy it.
+     */
     apiKey: string | null;
+    /** True once `reveal()`/`regenerate()` has surfaced the full (unmasked) key. */
+    isRevealed: boolean;
     reissuedAt: string | null;
     createdAt: string | null;
     isLoading: boolean;
+    isRevealing: boolean;
     isRegenerating: boolean;
     isTesting: boolean;
+    /**
+     * Fetch the current full key WITHOUT rotating it (the durable value every one
+     * of the user's agents uses). Use this to let the user copy their key for
+     * agent onboarding — `regenerate()` would invalidate the agents already using it.
+     */
+    reveal: () => Promise<void>;
     regenerate: () => Promise<void>;
     testKey: (key: string) => Promise<ApiKeyTestResult>;
     refresh: () => void;

package/dist/hooks.mjs

@@ -1284,11 +1284,7 @@ var CfgAccountsApiKey = class {
   static cfgAccountsApiKeyRetrieve(options) {
     return (options?.client ?? client).get({
       security: [
-        {
-          key: "jwtAuth",
-          scheme: "bearer",
-          type: "http"
-        },
+        { scheme: "bearer", type: "http" },
         {
           in: "cookie",
           name: "sessionid",
@@ -1308,11 +1304,31 @@ var CfgAccountsApiKey = class {
   static cfgAccountsApiKeyRegenerateCreate(options) {
     return (options.client ?? client).post({
       security: [
+        { scheme: "bearer", type: "http" },
         {
-          key: "jwtAuth",
-          scheme: "bearer",
-          type: "http"
+          in: "cookie",
+          name: "sessionid",
+          type: "apiKey"
         },
+        { name: "X-API-Key", type: "apiKey" }
+      ],
+      url: "/cfg/accounts/api-key/regenerate/",
+      ...options,
+      headers: {
+        "Content-Type": "application/json",
+        ...options.headers
+      }
+    });
+  }
+  /**
+   * Reveal API key
+   *
+   * Return the current full API key WITHOUT rotating it. The same durable value every one of the user's agents uses — for the signed-in user to copy and paste into agent onboarding. Default GET stays masked; this is the explicit reveal action.
+   */
+  static cfgAccountsApiKeyRevealCreate(options) {
+    return (options.client ?? client).post({
+      security: [
+        { scheme: "bearer", type: "http" },
         {
           in: "cookie",
           name: "sessionid",
@@ -1320,7 +1336,7 @@ var CfgAccountsApiKey = class {
         },
         { name: "X-API-Key", type: "apiKey" }
       ],
-      url: "/cfg/accounts/api-key/regenerate/",
+      url: "/cfg/accounts/api-key/reveal/",
       ...options,
       headers: {
         "Content-Type": "application/json",
@@ -1336,11 +1352,7 @@ var CfgAccountsApiKey = class {
   static cfgAccountsApiKeyTestCreate(options) {
     return (options.client ?? client).post({
       security: [
-        {
-          key: "jwtAuth",
-          scheme: "bearer",
-          type: "http"
-        },
+        { scheme: "bearer", type: "http" },
         {
           in: "cookie",
           name: "sessionid",
@@ -1472,19 +1484,77 @@ function useCfgAccountsApiKeyRetrieve(args, config) {
 }
 __name(useCfgAccountsApiKeyRetrieve, "useCfgAccountsApiKeyRetrieve");
 
-// src/_api/generated/_cfg_accounts/hooks/useCfgAccountsApiKeyTestCreate.ts
+// src/_api/generated/_cfg_accounts/hooks/useCfgAccountsApiKeyRevealCreate.ts
 import useSWRMutation2 from "swr/mutation";
 
-// src/_api/generated/_cfg_accounts/schemas/APIKeyTestResult.ts
+// src/_api/generated/_cfg_accounts/schemas/APIKeyReveal.ts
 import { z as z3 } from "zod";
-var APIKeyTestResultSchema = z3.object({
-  valid: z3.boolean(),
-  user_id: z3.string().nullable()
+var APIKeyRevealSchema = z3.object({
+  key: z3.string(),
+  created_at: z3.string().datetime({ offset: true }),
+  reissued_at: z3.string().datetime({ offset: true }).nullable()
+});
+
+// src/_api/generated/_cfg_accounts/hooks/useCfgAccountsApiKeyRevealCreate.ts
+function useCfgAccountsApiKeyRevealCreate(config) {
+  return useSWRMutation2(
+    ["cfg_accounts_api_key_reveal_create"],
+    async (_key, { arg }) => {
+      const res = await CfgAccountsApiKey.cfgAccountsApiKeyRevealCreate({ ...arg, throwOnError: true });
+      const data = res.data;
+      const parsed = APIKeyRevealSchema.safeParse(data);
+      if (!parsed.success) {
+        console.warn(
+          "[zod] response did not match schema",
+          {
+            operation: "cfg_accounts_api_key_reveal_create",
+            method: "POST",
+            path: "/cfg/accounts/api-key/reveal/",
+            issues: parsed.error.issues,
+            data
+          }
+        );
+        if (typeof window !== "undefined") {
+          try {
+            window.dispatchEvent(
+              new CustomEvent("zod-validation-error", {
+                detail: {
+                  operation: "cfg_accounts_api_key_reveal_create",
+                  method: "POST",
+                  path: "/cfg/accounts/api-key/reveal/",
+                  issues: parsed.error.issues,
+                  data,
+                  timestamp: /* @__PURE__ */ new Date()
+                },
+                bubbles: true,
+                cancelable: false
+              })
+            );
+          } catch {
+          }
+        }
+        return data;
+      }
+      return parsed.data;
+    },
+    config
+  );
+}
+__name(useCfgAccountsApiKeyRevealCreate, "useCfgAccountsApiKeyRevealCreate");
+
+// src/_api/generated/_cfg_accounts/hooks/useCfgAccountsApiKeyTestCreate.ts
+import useSWRMutation3 from "swr/mutation";
+
+// src/_api/generated/_cfg_accounts/schemas/APIKeyTestResult.ts
+import { z as z4 } from "zod";
+var APIKeyTestResultSchema = z4.object({
+  valid: z4.boolean(),
+  user_id: z4.string().nullable()
 });
 
 // src/_api/generated/_cfg_accounts/hooks/useCfgAccountsApiKeyTestCreate.ts
 function useCfgAccountsApiKeyTestCreate(config) {
-  return useSWRMutation2(
+  return useSWRMutation3(
     ["cfg_accounts_api_key_test_create"],
     async (_key, { arg }) => {
       const res = await CfgAccountsApiKey.cfgAccountsApiKeyTestCreate({ ...arg, throwOnError: true });
@@ -1532,12 +1602,21 @@ __name(useCfgAccountsApiKeyTestCreate, "useCfgAccountsApiKeyTestCreate");
 // src/hooks/useApiKey.ts
 function useApiKey() {
   const { data, isLoading, mutate } = useCfgAccountsApiKeyRetrieve();
+  const { trigger: revealTrigger, isMutating: isRevealing } = useCfgAccountsApiKeyRevealCreate();
   const { trigger: regenerateTrigger, isMutating: isRegenerating } = useCfgAccountsApiKeyRegenerateCreate();
   const { trigger: testTrigger, isMutating: isTesting } = useCfgAccountsApiKeyTestCreate();
   const [freshKey, setFreshKey] = useState(null);
   const apiKey = freshKey ?? (data?.key ?? null);
+  const isRevealed = freshKey !== null;
   const reissuedAt = data?.reissued_at ?? null;
   const createdAt = data?.created_at ?? null;
+  const reveal = useCallback(async () => {
+    const result = await revealTrigger({});
+    const fullKey = result?.key;
+    if (fullKey) {
+      setFreshKey(fullKey);
+    }
+  }, [revealTrigger]);
   const regenerate = useCallback(async () => {
     const result = await regenerateTrigger({});
     const newKey = result?.key;
@@ -1559,11 +1638,14 @@ function useApiKey() {
   }, [mutate]);
   return {
     apiKey,
+    isRevealed,
     reissuedAt,
     createdAt,
     isLoading,
+    isRevealing,
     isRegenerating,
     isTesting,
+    reveal,
     regenerate,
     testKey,
     refresh