@hot-updater/console 1.0.0-rc.9 → 1.0.0

package/src/index.ts

@@ -1,4 +1,8 @@
-import type { ConfigInput, DatabasePlugin } from "@hot-updater/plugin-core";
+import type {
+  AnyHotUpdaterPlugin,
+  ConfiguredDatabase,
+  StorageAdapter,
+} from "@hot-updater/plugin-core";
 
 export type ConsoleAuthProvider = "google" | "github";
 
@@ -19,26 +23,29 @@ export type ConsoleAuthAdapter = Readonly<{
   getProviders(request: Request): Promise<readonly ConsoleAuthProvider[]>;
 }>;
 
-export type ConsoleSigningConfig = Readonly<{
-  enabled: boolean;
-  provider?: string;
+export type HotUpdaterConsoleConfig = Readonly<{
+  /**
+   * The database your server runs on, such as `dynamoDB(...)`, or
+   * `standaloneRepository(...)`, which reaches a self-hosted server through
+   * its admin API.
+   */
+  database: ConfiguredDatabase;
+  /** The storage your server lists; the console reads bundle files with it. */
+  storage: StorageAdapter;
+  /**
+   * The plugins your server runs, such as the `plugins` a managed provider
+   * package exports or `[insights(), apiKeys()]`. The console runs them over
+   * `database` as the server does, and shows only the built-in features of
+   * the plugins listed. With `standaloneRepository`, they run on the server,
+   * and the console shows the features its admin API serves.
+   */
+  plugins?: readonly AnyHotUpdaterPlugin[];
+  console?: {
+    /** The Git repository whose commits the console links bundles to. */
+    gitUrl?: string;
+  };
 }>;
 
-export type HotUpdaterConsoleConfig = Readonly<
-  Omit<
-    Pick<ConfigInput, "console" | "database" | "signing" | "storage">,
-    "database"
-  > & {
-    database: DatabasePlugin;
-  }
->;
-
-export type ResolvedHotUpdaterConsoleConfig = Readonly<
-  Omit<HotUpdaterConsoleConfig, "signing"> & {
-    signing?: ConsoleSigningConfig;
-  }
->;
-
 export type HotUpdaterConsoleConfigSource =
   | HotUpdaterConsoleConfig
   | ((

package/src/lib/api-keys-api.ts

@@ -1,43 +1,15 @@
 import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
-import type { QueryClient } from "@tanstack/react-query";
-import { redirect } from "@tanstack/react-router";
 
 import {
   createApiKeyRpc,
-  getApiKeyCapabilityRpc,
   listApiKeysRpc,
   revokeApiKeyRpc,
 } from "./api-keys-rpc";
 
 export const apiKeyQueryKeys = {
-  capability: ["api-keys", "capability"] as const,
   list: ["api-keys", "list"] as const,
 };
 
-export const getApiKeyCapabilityQueryOptions = () => ({
-  queryKey: apiKeyQueryKeys.capability,
-  queryFn: () => getApiKeyCapabilityRpc(),
-  staleTime: Infinity,
-});
-
-export const useApiKeyCapabilityQuery = () =>
-  useQuery(getApiKeyCapabilityQueryOptions());
-
-export const ensureApiKeyRouteAccess = async (
-  queryClient: QueryClient,
-): Promise<void> => {
-  const capability = await queryClient.ensureQueryData(
-    getApiKeyCapabilityQueryOptions(),
-  );
-  if (!capability.apiKeys) {
-    throw redirect({
-      to: "/",
-      search: {},
-      replace: true,
-    });
-  }
-};
-
 export const useApiKeysQuery = () =>
   useQuery({
     queryKey: apiKeyQueryKeys.list,

package/src/lib/api-keys-rpc.ts

@@ -1,7 +1,8 @@
-import type { ApiKeyRow } from "@hot-updater/plugin-core";
-import { createApiKey } from "@hot-updater/server";
+import type { ApiKeyRow } from "@hot-updater/server/plugins";
 import { createServerFn } from "@tanstack/react-start";
 
+import { consoleAccess } from "./console-access";
+
 export type ApiKeyView = Omit<ApiKeyRow, "hash">;
 
 export const toApiKeyView = ({
@@ -31,43 +32,33 @@ const parseId = (input: unknown): { readonly id: string } => {
   return { id };
 };
 
-const requireStore = async () => {
-  const { prepareConfig } = await import("./server/config.server");
-  const { apiKeyStore } = await prepareConfig();
-  if (apiKeyStore === null) {
-    throw new Error(
-      "API keys are not supported by the configured database plugin.",
-    );
-  }
-  return apiKeyStore;
+/** API key management, once the console's access check and the feature guard pass. */
+const apiKeyManagement = async () => {
+  const [{ prepareConfig }, { requireFeature }] = await Promise.all([
+    import("./server/config.server"),
+    import("./server/runtime.server"),
+  ]);
+  const { runtime } = await prepareConfig();
+  return requireFeature(runtime, "apiKeys");
 };
 
-export const getApiKeyCapabilityRpc = createServerFn({
-  method: "GET",
-}).handler(async () => {
-  const { prepareConfig } = await import("./server/config.server");
-  const { apiKeyStore } = await prepareConfig();
-  return { apiKeys: apiKeyStore !== null } as const;
-});
-
 export const listApiKeysRpc = createServerFn({
   method: "GET",
-}).handler(async () => {
-  const store = await requireStore();
-  const records = await store.list();
-  return [...records]
-    .sort((left, right) => right.created_at_ms - left.created_at_ms)
-    .map(toApiKeyView);
-});
+})
+  .middleware([consoleAccess])
+  .handler(async (): Promise<ApiKeyView[]> => {
+    const apiKeys = await apiKeyManagement();
+    return [...(await apiKeys.list())].sort(
+      (left, right) => right.created_at_ms - left.created_at_ms,
+    );
+  });
 
 export const createApiKeyRpc = createServerFn({ method: "POST" })
+  .middleware([consoleAccess])
   .validator(parseName)
   .handler(async ({ data }) => {
-    const store = await requireStore();
-    const created = await createApiKey({
-      apiKeys: store,
-      name: data.name,
-    });
+    const apiKeys = await apiKeyManagement();
+    const created = await apiKeys.create({ name: data.name });
     return {
       apiKey: created.apiKey,
       record: created.record,
@@ -75,13 +66,11 @@ export const createApiKeyRpc = createServerFn({ method: "POST" })
   });
 
 export const revokeApiKeyRpc = createServerFn({ method: "POST" })
+  .middleware([consoleAccess])
   .validator(parseId)
-  .handler(async ({ data }) => {
-    const store = await requireStore();
-    const revoked = await store.revoke({
-      id: data.id,
-      revokedAtMs: Date.now(),
-    });
+  .handler(async ({ data }): Promise<ApiKeyView> => {
+    const apiKeys = await apiKeyManagement();
+    const revoked = await apiKeys.revoke({ id: data.id });
     if (revoked === null) throw new Error("API key not found.");
-    return toApiKeyView(revoked);
+    return revoked;
   });