@zuplo/runtime 6.67.11 → 6.67.13

package/out/types/index.d.ts

@@ -586,6 +586,82 @@ export declare interface ApiAuthKeyInboundPolicyOptions {
  */
 declare type APIKey = string;
 
+/**
+ * Represents a consumer in the API Key service.
+ * @public
+ */
+export declare interface ApiKeyConsumer {
+  /** The unique consumer identifier, e.g. csmr_f9HGke8lQHi2HgxFa4OIst9W */
+  id: string;
+  /** The consumer name */
+  name: string;
+  /** Optional description of the consumer */
+  description?: string;
+  /** Custom metadata stored with the consumer */
+  metadata?: unknown;
+  /** ISO timestamp when the consumer was created */
+  createdOn: string;
+  /** ISO timestamp when the consumer was last updated */
+  updatedOn: string;
+}
+
+/**
+ * A client for retrieving consumer data from the Zuplo API key service.
+ *
+ * @example
+ * ```typescript
+ * import { ApiKeyConsumerClient, ZuploContext, ZuploRequest } from "@zuplo/runtime";
+ *
+ * // Configure once (e.g., at module level)
+ * const consumers = new ApiKeyConsumerClient({
+ *   cacheDurationSeconds: 300,
+ * });
+ *
+ * export async function myHandler(request: ZuploRequest, context: ZuploContext) {
+ *   const consumer = await consumers.get("csmr_f9HGke8lQHi2HgxFa4OIst9W");
+ *
+ *   context.log.info(`Consumer: ${consumer.name}`);
+ *   const metadata = consumer.metadata as { plan: string };
+ *
+ *   return Response.json({ consumer });
+ * }
+ * ```
+ *
+ * @beta
+ * @public
+ */
+export declare class ApiKeyConsumerClient {
+  private readonly bucketId;
+  private readonly cacheDurationSeconds;
+  private cacheNamePromise;
+  constructor(options?: ApiKeyConsumerClientOptions);
+  private getCacheName;
+  /**
+   * Get consumer data by consumer ID.
+   *
+   * @param consumerId - The unique identifier of the consumer
+   * @returns The consumer data including metadata
+   */
+  get(consumerId: string): Promise<ApiKeyConsumer>;
+}
+
+/**
+ * Configuration options for {@link ApiKeyConsumerClient}.
+ * @public
+ */
+export declare interface ApiKeyConsumerClientOptions {
+  /**
+   * The bucket ID for the API key service.
+   * Defaults to the ZUPLO_SERVICE_BUCKET_ID environment variable.
+   */
+  bucketId?: string;
+  /**
+   * Cache duration in seconds. Set to 0 to disable caching.
+   * Defaults to 60.
+   */
+  cacheDurationSeconds?: number;
+}
+
 /**
  * Authenticates requests based on API Keys using Zuplo's built-in API key management.
  * This policy validates API keys against Zuplo's key storage, caches results for performance,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zuplo/runtime",
   "type": "module",
-  "version": "6.67.11",
+  "version": "6.67.13",
   "repository": "https://github.com/zuplo/zuplo",
   "author": "Zuplo, Inc.",
   "exports": {