alepha/src/api/keys/index.ts

Easy-to-use modern TypeScript framework for building many kind of applications.

import { $module } from "alepha";
import { AdminApiKeyController } from "./controllers/AdminApiKeyController.ts";
import { ApiKeyController } from "./controllers/ApiKeyController.ts";
import { ApiKeyService } from "./services/ApiKeyService.ts";

export * from "./controllers/AdminApiKeyController.ts";
export * from "./controllers/ApiKeyController.ts";
export * from "./entities/apiKeyEntity.ts";
export * from "./schemas/adminApiKeyQuerySchema.ts";
export * from "./schemas/adminApiKeyResourceSchema.ts";
export * from "./schemas/createApiKeyBodySchema.ts";
export * from "./schemas/createApiKeyResponseSchema.ts";
export * from "./schemas/listApiKeyResponseSchema.ts";
export * from "./schemas/revokeApiKeyParamsSchema.ts";
export * from "./schemas/revokeApiKeyResponseSchema.ts";
export * from "./services/ApiKeyService.ts";

/**
 * API key management module for programmatic access.
 *
 * **Features:**
 * - Create API keys with role snapshots
 * - List and revoke API keys
 * - 15-minute validation caching
 * - Query param (?api_key=) and Bearer header support
 *
 * **Integration:**
 * To enable API key authentication for an issuer, register the resolver:
 *
 * ```ts
 * class MyApp {
 *   apiKeyService = $inject(ApiKeyService);
 *   issuer = $issuer({
 *     secret: env.APP_SECRET,
 *     resolvers: [this.apiKeyService.createResolver()],
 *   });
 * }
 * ```
 *
 * @module alepha.api.keys
 */
export const AlephaApiKeys = $module({
  name: "alepha.api.keys",
  services: [ApiKeyService, ApiKeyController, AdminApiKeyController],
});