@lukoweb/apitogo 0.1.24 → 0.1.37

package/src/lib/plugins/api-keys/index.tsx

@@ -1,272 +1,274 @@
-import { KeyRoundIcon } from "lucide-react";
-import type { RouteObject } from "react-router";
-import type { ApiKeysOptions } from "../../../config/validators/ZudokuConfig.js";
-import type { UseAuthReturn } from "../../authentication/hook.js";
-import type {
-  ApiIdentityPlugin,
-  ProfileMenuPlugin,
-  ApitogoPlugin,
-} from "../../core/plugins.js";
-import type { ZudokuContext } from "../../core/ZudokuContext.js";
-import invariant from "../../util/invariant.js";
-import { joinUrl } from "../../util/joinUrl.js";
-import { throwIfProblemJson } from "../../util/problemJson.js";
-import { SettingsApiKeys } from "./SettingsApiKeys.js";
-
-const DEFAULT_GATEWAY_URL = "https://api.zuploedge.com";
-
-const getApiKeyEndpoint = (context: ZudokuContext) => {
-  const gatewayUrl =
-    context.env.ZUPLO_GATEWAY_SERVICE_URL || DEFAULT_GATEWAY_URL;
-  return joinUrl(gatewayUrl, "v2/client");
-};
-
-export type ApiKeyService = {
-  getConsumers: (context: ZudokuContext) => Promise<ApiConsumer[]>;
-  rollKey?: (consumerId: string, context: ZudokuContext) => Promise<void>;
-  deleteKey?: (
-    consumerId: string,
-    keyId: string,
-    context: ZudokuContext,
-  ) => Promise<void>;
-  updateConsumer?: (
-    consumer: { id: string; label?: string },
-    context: ZudokuContext,
-  ) => Promise<void>;
-  getUsage?: (apiKeys: string[], context: ZudokuContext) => Promise<void>;
-  createKey?: ({
-    apiKey,
-    context,
-    auth,
-  }: {
-    apiKey: { description: string; expiresOn?: string };
-    context: ZudokuContext;
-    auth: UseAuthReturn;
-  }) => Promise<void>;
-};
-
-export type ApiKeyPluginOptions = ApiKeyService | DefaultApiKeyServiceOptions;
-
-type DefaultApiKeyServiceOptions = {
-  deploymentName?: string;
-} & Partial<ApiKeyService>;
-
-export interface ApiKey {
-  id: string;
-  description?: string;
-  createdOn?: string;
-  updatedOn?: string;
-  expiresOn?: string;
-  key: string;
-}
-
-export interface ApiConsumer {
-  id: string;
-  label: string;
-  apiKeys: ApiKey[];
-  description?: string;
-  createdOn?: string;
-  updatedOn?: string;
-  expiresOn?: string;
-  key?: ApiKey;
-}
-
-const developerHintOptions = {
-  developerHint:
-    "This project is not linked to a Zuplo deployment. Run `zuplo link` to get started with API Keys.",
-  title: "Not linked to a Zuplo deployment",
-};
-
-const createZuploService = ({
-  deploymentName,
-  ...options
-}: DefaultApiKeyServiceOptions): ApiKeyService => {
-  return {
-    deleteKey: async (consumerId, keyId, context) => {
-      invariant(deploymentName, "Cannot delete API key.", developerHintOptions);
-      const request = new Request(
-        joinUrl(
-          getApiKeyEndpoint(context),
-          `${deploymentName}/consumers/${consumerId}/keys/${keyId}`,
-        ),
-        {
-          method: "DELETE",
-        },
-      );
-      const response = await fetch(await context.signRequest(request));
-      await throwIfProblemJson(response);
-      invariant(response.ok, "Failed to delete API key");
-    },
-    updateConsumer: async (consumer, context) => {
-      invariant(
-        deploymentName,
-        "Cannot update API key description.",
-        developerHintOptions,
-      );
-      const response = await fetch(
-        await context.signRequest(
-          new Request(
-            joinUrl(
-              getApiKeyEndpoint(context),
-              `${deploymentName}/consumers/${consumer.id}`,
-            ),
-            {
-              method: "PATCH",
-              headers: {
-                "Content-Type": "application/json",
-              },
-              body: JSON.stringify({
-                label: consumer.label,
-              }),
-            },
-          ),
-        ),
-      );
-      await throwIfProblemJson(response);
-      invariant(response.ok, "Failed to update API key description");
-    },
-    rollKey: async (consumerId, context) => {
-      invariant(deploymentName, "Cannot roll API key.", developerHintOptions);
-      const response = await fetch(
-        await context.signRequest(
-          new Request(
-            joinUrl(
-              getApiKeyEndpoint(context),
-              `${deploymentName}/consumers/${consumerId}/roll-key`,
-            ),
-            {
-              method: "POST",
-              headers: {
-                "Content-Type": "application/json",
-              },
-              body: JSON.stringify({}),
-            },
-          ),
-        ),
-      );
-      await throwIfProblemJson(response);
-      invariant(response.ok, "Failed to roll API key");
-    },
-    getConsumers: async (context) => {
-      invariant(deploymentName, "Cannot get API keys.", developerHintOptions);
-      const request = new Request(
-        joinUrl(getApiKeyEndpoint(context), `${deploymentName}/consumers`),
-      );
-      await context.signRequest(request);
-
-      const keys = await fetch(request);
-      await throwIfProblemJson(keys);
-      invariant(keys.ok, "Failed to fetch API keys");
-
-      const data = (await keys.json()) as {
-        data: [
-          {
-            id: string;
-            label?: string;
-            subject?: string;
-            createdOn?: string;
-            updatedOn?: string;
-            expiresOn?: string;
-            apiKeys: {
-              data: ApiKey[];
-            };
-          },
-        ];
-      };
-
-      return data.data.map((consumer) => ({
-        id: consumer.id,
-        createdOn: consumer.createdOn,
-        updatedOn: consumer.updatedOn,
-        expiresOn: consumer.expiresOn,
-        label: consumer.label || consumer.subject || "API Key",
-        apiKeys: consumer.apiKeys.data,
-        key: consumer.apiKeys.data.at(0),
-      }));
-    },
-    ...options,
-  };
-};
-
-export const createApiKeyService = <T extends ApiKeyService>(service: T): T =>
-  service;
-
-type InternalApiKeyPluginOptions = {
-  // The name of the Zuplo deployment
-  deploymentName?: string;
-  // Indicates that the plugin is running in Zuplo "mode"
-  isZuplo?: boolean;
-};
-
-export const apiKeyPlugin = ({
-  deploymentName,
-  isZuplo,
-  ...options
-}: Omit<ApiKeysOptions, "enabled"> &
-  InternalApiKeyPluginOptions): ApitogoPlugin &
-  ApiIdentityPlugin &
-  ProfileMenuPlugin => {
-  if (isZuplo && !deploymentName) {
-    // biome-ignore lint/suspicious/noConsole: Important warning
-    console.warn(
-      "This project is not linked to a Zuplo deployment. Run `zuplo link` to get started.",
-    );
-  }
-
-  const service = isZuplo
-    ? createZuploService({ deploymentName, ...options })
-    : options;
-
-  if (!service.getConsumers) {
-    throw new Error("getConsumers is required when using the apiKeyPlugin");
-  }
-
-  const verifiedService: ApiKeyService = {
-    ...service,
-    getConsumers: service.getConsumers,
-  };
-
-  return {
-    getProfileMenuItems: () => [
-      {
-        label: "API Keys",
-        path: "/settings/api-keys",
-        category: "middle",
-        icon: KeyRoundIcon,
-      },
-    ],
-
-    getIdentities: async (context) => {
-      try {
-        const consumers = await verifiedService.getConsumers(context);
-
-        return consumers.map((consumer) => ({
-          authorizeRequest: (request) => {
-            request.headers.set(
-              "Authorization",
-              `Bearer ${consumer.apiKeys.at(0)?.key}`,
-            );
-            return request;
-          },
-          id: consumer.id,
-          label: consumer.label,
-        }));
-      } catch {
-        return [];
-      }
-    },
-
-    getRoutes: (): RouteObject[] => {
-      return [
-        {
-          path: "/settings/api-keys",
-          element: <SettingsApiKeys service={verifiedService} />,
-        },
-      ];
-    },
-
-    getProtectedRoutes: () => {
-      return ["/settings/api-keys"];
-    },
-  };
-};
+import { KeyRoundIcon } from "lucide-react";
+import type { RouteObject } from "react-router";
+import type { ApiKeysOptions } from "../../../config/validators/ZudokuConfig.js";
+import type { UseAuthReturn } from "../../authentication/hook.js";
+import type {
+  ApiIdentityPlugin,
+  ProfileMenuPlugin,
+  ApitogoPlugin,
+} from "../../core/plugins.js";
+import type { ZudokuContext } from "../../core/ZudokuContext.js";
+import invariant from "../../util/invariant.js";
+import { joinUrl } from "../../util/joinUrl.js";
+import { throwIfProblemJson } from "../../util/problemJson.js";
+import { SettingsApiKeys } from "./SettingsApiKeys.js";
+
+const DEFAULT_GATEWAY_URL = "https://api.zuploedge.com";
+
+const getApiKeyEndpoint = (context: ZudokuContext) => {
+  const gatewayUrl =
+    context.env.ZUPLO_GATEWAY_SERVICE_URL || DEFAULT_GATEWAY_URL;
+  return joinUrl(gatewayUrl, "v2/client");
+};
+
+export type ApiKeyService = {
+  getConsumers: (context: ZudokuContext) => Promise<ApiConsumer[]>;
+  rollKey?: (consumerId: string, context: ZudokuContext) => Promise<void>;
+  deleteKey?: (
+    consumerId: string,
+    keyId: string,
+    context: ZudokuContext,
+  ) => Promise<void>;
+  updateConsumer?: (
+    consumer: { id: string; label?: string },
+    context: ZudokuContext,
+  ) => Promise<void>;
+  getUsage?: (apiKeys: string[], context: ZudokuContext) => Promise<void>;
+  createKey?: ({
+    apiKey,
+    context,
+    auth,
+  }: {
+    apiKey: { description: string; expiresOn?: string };
+    context: ZudokuContext;
+    auth: UseAuthReturn;
+  }) => Promise<void>;
+};
+
+export type ApiKeyPluginOptions = ApiKeyService | DefaultApiKeyServiceOptions;
+
+type DefaultApiKeyServiceOptions = {
+  deploymentName?: string;
+} & Partial<ApiKeyService>;
+
+export interface ApiKey {
+  id: string;
+  description?: string;
+  createdOn?: string;
+  updatedOn?: string;
+  expiresOn?: string;
+  key: string;
+}
+
+export interface ApiConsumer {
+  id: string;
+  label: string;
+  apiKeys: ApiKey[];
+  description?: string;
+  createdOn?: string;
+  updatedOn?: string;
+  expiresOn?: string;
+  key?: ApiKey;
+}
+
+const developerHintOptions = {
+  developerHint:
+    "This project is not linked to a Zuplo deployment. Run `zuplo link` to get started with API Keys.",
+  title: "Not linked to a Zuplo deployment",
+};
+
+const createZuploService = ({
+  deploymentName,
+  ...options
+}: DefaultApiKeyServiceOptions): ApiKeyService => {
+  return {
+    deleteKey: async (consumerId, keyId, context) => {
+      invariant(deploymentName, "Cannot delete API key.", developerHintOptions);
+      const request = new Request(
+        joinUrl(
+          getApiKeyEndpoint(context),
+          `${deploymentName}/consumers/${consumerId}/keys/${keyId}`,
+        ),
+        {
+          method: "DELETE",
+        },
+      );
+      const response = await fetch(await context.signRequest(request));
+      await throwIfProblemJson(response);
+      invariant(response.ok, "Failed to delete API key");
+    },
+    updateConsumer: async (consumer, context) => {
+      invariant(
+        deploymentName,
+        "Cannot update API key description.",
+        developerHintOptions,
+      );
+      const response = await fetch(
+        await context.signRequest(
+          new Request(
+            joinUrl(
+              getApiKeyEndpoint(context),
+              `${deploymentName}/consumers/${consumer.id}`,
+            ),
+            {
+              method: "PATCH",
+              headers: {
+                "Content-Type": "application/json",
+              },
+              body: JSON.stringify({
+                label: consumer.label,
+              }),
+            },
+          ),
+        ),
+      );
+      await throwIfProblemJson(response);
+      invariant(response.ok, "Failed to update API key description");
+    },
+    rollKey: async (consumerId, context) => {
+      invariant(deploymentName, "Cannot roll API key.", developerHintOptions);
+      const response = await fetch(
+        await context.signRequest(
+          new Request(
+            joinUrl(
+              getApiKeyEndpoint(context),
+              `${deploymentName}/consumers/${consumerId}/roll-key`,
+            ),
+            {
+              method: "POST",
+              headers: {
+                "Content-Type": "application/json",
+              },
+              body: JSON.stringify({}),
+            },
+          ),
+        ),
+      );
+      await throwIfProblemJson(response);
+      invariant(response.ok, "Failed to roll API key");
+    },
+    getConsumers: async (context) => {
+      invariant(deploymentName, "Cannot get API keys.", developerHintOptions);
+      const request = new Request(
+        joinUrl(getApiKeyEndpoint(context), `${deploymentName}/consumers`),
+      );
+      await context.signRequest(request);
+
+      const keys = await fetch(request);
+      await throwIfProblemJson(keys);
+      invariant(keys.ok, "Failed to fetch API keys");
+
+      const data = (await keys.json()) as {
+        data: [
+          {
+            id: string;
+            label?: string;
+            subject?: string;
+            createdOn?: string;
+            updatedOn?: string;
+            expiresOn?: string;
+            apiKeys: {
+              data: ApiKey[];
+            };
+          },
+        ];
+      };
+
+      return data.data.map((consumer) => ({
+        id: consumer.id,
+        createdOn: consumer.createdOn,
+        updatedOn: consumer.updatedOn,
+        expiresOn: consumer.expiresOn,
+        label: consumer.label || consumer.subject || "API Key",
+        apiKeys: consumer.apiKeys.data,
+        key: consumer.apiKeys.data.at(0),
+      }));
+    },
+    ...options,
+  };
+};
+
+export const createApiKeyService = <T extends ApiKeyService>(service: T): T =>
+  service;
+
+type InternalApiKeyPluginOptions = {
+  // The name of the Zuplo deployment
+  deploymentName?: string;
+  // Indicates that the plugin is running in Zuplo "mode"
+  isZuplo?: boolean;
+  path?: string;
+};
+
+export const apiKeyPlugin = ({
+  deploymentName,
+  isZuplo,
+  path = "/settings/api-keys",
+  ...options
+}: Omit<ApiKeysOptions, "enabled"> &
+  InternalApiKeyPluginOptions): ApitogoPlugin &
+  ApiIdentityPlugin &
+  ProfileMenuPlugin => {
+  if (isZuplo && !deploymentName) {
+    // biome-ignore lint/suspicious/noConsole: Important warning
+    console.warn(
+      "This project is not linked to a Zuplo deployment. Run `zuplo link` to get started.",
+    );
+  }
+
+  const service = isZuplo
+    ? createZuploService({ deploymentName, ...options })
+    : options;
+
+  if (!service.getConsumers) {
+    throw new Error("getConsumers is required when using the apiKeyPlugin");
+  }
+
+  const verifiedService: ApiKeyService = {
+    ...service,
+    getConsumers: service.getConsumers,
+  };
+
+  return {
+    getProfileMenuItems: () => [
+      {
+        label: "API Keys",
+        path,
+        category: "middle",
+        icon: KeyRoundIcon,
+      },
+    ],
+
+    getIdentities: async (context) => {
+      try {
+        const consumers = await verifiedService.getConsumers(context);
+
+        return consumers.map((consumer) => ({
+          authorizeRequest: (request) => {
+            request.headers.set(
+              "Authorization",
+              `Bearer ${consumer.apiKeys.at(0)?.key}`,
+            );
+            return request;
+          },
+          id: consumer.id,
+          label: consumer.label,
+        }));
+      } catch {
+        return [];
+      }
+    },
+
+    getRoutes: (): RouteObject[] => {
+      return [
+        {
+          path,
+          element: <SettingsApiKeys service={verifiedService} />,
+        },
+      ];
+    },
+
+    getProtectedRoutes: () => {
+      return [path];
+    },
+  };
+};