krawlet-js 1.0.1 → 1.1.0

package/dist/index.cjs

@@ -21,6 +21,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_exports = {};
 __export(index_exports, {
   AddressesResource: () => AddressesResource,
+  ApiKeyResource: () => ApiKeyResource,
   ErrorCode: () => ErrorCode,
   HealthResource: () => HealthResource,
   ItemsResource: () => ItemsResource,
@@ -549,6 +550,90 @@ var ReportsResource = class {
   }
 };
 
+// src/resources/apikey.ts
+var ApiKeyResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Get information about the authenticated API key
+   *
+   * @param options - Optional parameters
+   * @param options.usage - Include detailed usage statistics (default: true)
+   * @returns API key information with optional usage statistics
+   * @throws {KrawletError} If not authenticated (401)
+   *
+   * @example
+   * ```typescript
+   * // Get full info with usage stats
+   * const info = await client.apiKey.getInfo();
+   *
+   * // Get basic info without usage stats
+   * const basicInfo = await client.apiKey.getInfo({ usage: false });
+   * ```
+   */
+  async getInfo(options) {
+    const params = {};
+    if (options?.usage !== void 0) {
+      params.usage = String(options.usage);
+    }
+    const response = await this.client.request("/v1/apikey", {
+      params: Object.keys(params).length > 0 ? params : void 0
+    });
+    return response.data;
+  }
+  /**
+   * Get detailed usage statistics for the authenticated API key
+   *
+   * @returns Detailed usage statistics including request counts and top endpoints
+   * @throws {KrawletError} If not authenticated (401)
+   *
+   * @example
+   * ```typescript
+   * const usage = await client.apiKey.getUsage();
+   * console.log(`Total requests: ${usage.totalRequests}`);
+   * console.log(`Last 24h: ${usage.last24h}`);
+   * console.log(`Blocked: ${usage.blockedRequests}`);
+   * console.log('Top endpoints:', usage.topEndpoints);
+   * ```
+   */
+  async getUsage() {
+    const response = await this.client.request("/v1/apikey/usage");
+    return response.data;
+  }
+  /**
+   * Get recent request logs for the authenticated API key
+   *
+   * @param options - Optional parameters
+   * @param options.limit - Maximum number of logs to return (1-100, default: 50)
+   * @returns Request logs with count
+   * @throws {KrawletError} If not authenticated (401)
+   *
+   * @example
+   * ```typescript
+   * // Get default number of logs (50)
+   * const logs = await client.apiKey.getLogs();
+   *
+   * // Get last 10 requests
+   * const recentLogs = await client.apiKey.getLogs({ limit: 10 });
+   *
+   * for (const log of recentLogs.logs) {
+   *   console.log(`${log.method} ${log.path} - ${log.responseStatus} (${log.responseTimeMs}ms)`);
+   * }
+   * ```
+   */
+  async getLogs(options) {
+    const params = {};
+    if (options?.limit !== void 0) {
+      params.limit = String(options.limit);
+    }
+    const response = await this.client.request("/v1/apikey/logs", {
+      params: Object.keys(params).length > 0 ? params : void 0
+    });
+    return response.data;
+  }
+};
+
 // src/client.ts
 var KrawletClient = class {
   /**
@@ -573,6 +658,7 @@ var KrawletClient = class {
     this.addresses = new AddressesResource(this.httpClient);
     this.storage = new StorageResource(this.httpClient);
     this.reports = new ReportsResource(this.httpClient);
+    this.apiKey = new ApiKeyResource(this.httpClient);
   }
   /**
    * Get the last known rate limit information
@@ -603,6 +689,7 @@ var ErrorCode = /* @__PURE__ */ ((ErrorCode2) => {
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   AddressesResource,
+  ApiKeyResource,
   ErrorCode,
   HealthResource,
   ItemsResource,

package/dist/index.d.cts

@@ -148,6 +148,45 @@ interface ShopSyncData {
         }>;
     }>;
 }
+type ApiKeyTier = 'free' | 'premium';
+interface ApiKeyUsage {
+    totalRequests: number;
+    last24h: number;
+    last7d: number;
+    last30d: number;
+    blockedRequests: number;
+    avgResponseTimeMs: number | null;
+    topEndpoints: Array<{
+        path: string;
+        count: number;
+    }>;
+}
+interface ApiKeyInfo {
+    id: string;
+    name: string;
+    email: string | null;
+    tier: ApiKeyTier;
+    rateLimit: number;
+    isActive: boolean;
+    requestCount: number;
+    lastUsedAt: string | null;
+    createdAt: string;
+    usage?: ApiKeyUsage;
+}
+interface RequestLog {
+    requestId: string;
+    timestamp: string;
+    method: string;
+    path: string;
+    responseStatus: number | null;
+    responseTimeMs: number | null;
+    wasBlocked: boolean;
+    blockReason: string | null;
+}
+interface RequestLogsResponse {
+    count: number;
+    logs: RequestLog[];
+}
 interface RateLimit {
     limit: number;
     remaining: number;
@@ -325,6 +364,20 @@ declare class ReportsResource {
     get(id: string): Promise<unknown>;
 }
 
+interface GetApiKeyInfoOptions {
+    usage?: boolean;
+}
+interface GetApiKeyLogsOptions {
+    limit?: number;
+}
+declare class ApiKeyResource {
+    private client;
+    constructor(client: HttpClient);
+    getInfo(options?: GetApiKeyInfoOptions): Promise<ApiKeyInfo>;
+    getUsage(): Promise<ApiKeyUsage>;
+    getLogs(options?: GetApiKeyLogsOptions): Promise<RequestLogsResponse>;
+}
+
 interface KrawletClientConfig {
     baseUrl?: string;
     apiKey?: string;
@@ -343,6 +396,7 @@ declare class KrawletClient {
     readonly addresses: AddressesResource;
     readonly storage: StorageResource;
     readonly reports: ReportsResource;
+    readonly apiKey: ApiKeyResource;
     constructor(config?: KrawletClientConfig);
     getRateLimit(): RateLimit | undefined;
 }
@@ -359,4 +413,4 @@ declare class KrawletError extends Error {
     isRateLimitError(): boolean;
 }
 
-export { AddressesResource, type ApiResponse, type ApiResponseMeta, type ChangeLogOptions, type ChangeLogResult, type DetailedHealthResponse, ErrorCode, type ErrorResponse, HealthResource, type HealthResponse, type Item, type ItemChangeLog, type ItemChangeType, ItemsResource, type KnownAddress, type KnownAddressType, KrawletClient, type KrawletClientConfig, KrawletError, type Player, type PlayerNotifications, PlayersResource, type Price, type PriceChangeLog, type RateLimit, type ReportRecords, ReportsResource, type Shop, type ShopChangeLog, type ShopSyncData, ShopsResource, type StorageData, StorageResource };
+export { AddressesResource, type ApiKeyInfo, ApiKeyResource, type ApiKeyTier, type ApiKeyUsage, type ApiResponse, type ApiResponseMeta, type ChangeLogOptions, type ChangeLogResult, type DetailedHealthResponse, ErrorCode, type ErrorResponse, HealthResource, type HealthResponse, type Item, type ItemChangeLog, type ItemChangeType, ItemsResource, type KnownAddress, type KnownAddressType, KrawletClient, type KrawletClientConfig, KrawletError, type Player, type PlayerNotifications, PlayersResource, type Price, type PriceChangeLog, type RateLimit, type ReportRecords, ReportsResource, type RequestLog, type RequestLogsResponse, type Shop, type ShopChangeLog, type ShopSyncData, ShopsResource, type StorageData, StorageResource };

package/dist/index.d.ts

@@ -148,6 +148,45 @@ interface ShopSyncData {
         }>;
     }>;
 }
+type ApiKeyTier = 'free' | 'premium';
+interface ApiKeyUsage {
+    totalRequests: number;
+    last24h: number;
+    last7d: number;
+    last30d: number;
+    blockedRequests: number;
+    avgResponseTimeMs: number | null;
+    topEndpoints: Array<{
+        path: string;
+        count: number;
+    }>;
+}
+interface ApiKeyInfo {
+    id: string;
+    name: string;
+    email: string | null;
+    tier: ApiKeyTier;
+    rateLimit: number;
+    isActive: boolean;
+    requestCount: number;
+    lastUsedAt: string | null;
+    createdAt: string;
+    usage?: ApiKeyUsage;
+}
+interface RequestLog {
+    requestId: string;
+    timestamp: string;
+    method: string;
+    path: string;
+    responseStatus: number | null;
+    responseTimeMs: number | null;
+    wasBlocked: boolean;
+    blockReason: string | null;
+}
+interface RequestLogsResponse {
+    count: number;
+    logs: RequestLog[];
+}
 interface RateLimit {
     limit: number;
     remaining: number;
@@ -325,6 +364,20 @@ declare class ReportsResource {
     get(id: string): Promise<unknown>;
 }
 
+interface GetApiKeyInfoOptions {
+    usage?: boolean;
+}
+interface GetApiKeyLogsOptions {
+    limit?: number;
+}
+declare class ApiKeyResource {
+    private client;
+    constructor(client: HttpClient);
+    getInfo(options?: GetApiKeyInfoOptions): Promise<ApiKeyInfo>;
+    getUsage(): Promise<ApiKeyUsage>;
+    getLogs(options?: GetApiKeyLogsOptions): Promise<RequestLogsResponse>;
+}
+
 interface KrawletClientConfig {
     baseUrl?: string;
     apiKey?: string;
@@ -343,6 +396,7 @@ declare class KrawletClient {
     readonly addresses: AddressesResource;
     readonly storage: StorageResource;
     readonly reports: ReportsResource;
+    readonly apiKey: ApiKeyResource;
     constructor(config?: KrawletClientConfig);
     getRateLimit(): RateLimit | undefined;
 }
@@ -359,4 +413,4 @@ declare class KrawletError extends Error {
     isRateLimitError(): boolean;
 }
 
-export { AddressesResource, type ApiResponse, type ApiResponseMeta, type ChangeLogOptions, type ChangeLogResult, type DetailedHealthResponse, ErrorCode, type ErrorResponse, HealthResource, type HealthResponse, type Item, type ItemChangeLog, type ItemChangeType, ItemsResource, type KnownAddress, type KnownAddressType, KrawletClient, type KrawletClientConfig, KrawletError, type Player, type PlayerNotifications, PlayersResource, type Price, type PriceChangeLog, type RateLimit, type ReportRecords, ReportsResource, type Shop, type ShopChangeLog, type ShopSyncData, ShopsResource, type StorageData, StorageResource };
+export { AddressesResource, type ApiKeyInfo, ApiKeyResource, type ApiKeyTier, type ApiKeyUsage, type ApiResponse, type ApiResponseMeta, type ChangeLogOptions, type ChangeLogResult, type DetailedHealthResponse, ErrorCode, type ErrorResponse, HealthResource, type HealthResponse, type Item, type ItemChangeLog, type ItemChangeType, ItemsResource, type KnownAddress, type KnownAddressType, KrawletClient, type KrawletClientConfig, KrawletError, type Player, type PlayerNotifications, PlayersResource, type Price, type PriceChangeLog, type RateLimit, type ReportRecords, ReportsResource, type RequestLog, type RequestLogsResponse, type Shop, type ShopChangeLog, type ShopSyncData, ShopsResource, type StorageData, StorageResource };

package/dist/index.js

@@ -514,6 +514,90 @@ var ReportsResource = class {
   }
 };
 
+// src/resources/apikey.ts
+var ApiKeyResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Get information about the authenticated API key
+   *
+   * @param options - Optional parameters
+   * @param options.usage - Include detailed usage statistics (default: true)
+   * @returns API key information with optional usage statistics
+   * @throws {KrawletError} If not authenticated (401)
+   *
+   * @example
+   * ```typescript
+   * // Get full info with usage stats
+   * const info = await client.apiKey.getInfo();
+   *
+   * // Get basic info without usage stats
+   * const basicInfo = await client.apiKey.getInfo({ usage: false });
+   * ```
+   */
+  async getInfo(options) {
+    const params = {};
+    if (options?.usage !== void 0) {
+      params.usage = String(options.usage);
+    }
+    const response = await this.client.request("/v1/apikey", {
+      params: Object.keys(params).length > 0 ? params : void 0
+    });
+    return response.data;
+  }
+  /**
+   * Get detailed usage statistics for the authenticated API key
+   *
+   * @returns Detailed usage statistics including request counts and top endpoints
+   * @throws {KrawletError} If not authenticated (401)
+   *
+   * @example
+   * ```typescript
+   * const usage = await client.apiKey.getUsage();
+   * console.log(`Total requests: ${usage.totalRequests}`);
+   * console.log(`Last 24h: ${usage.last24h}`);
+   * console.log(`Blocked: ${usage.blockedRequests}`);
+   * console.log('Top endpoints:', usage.topEndpoints);
+   * ```
+   */
+  async getUsage() {
+    const response = await this.client.request("/v1/apikey/usage");
+    return response.data;
+  }
+  /**
+   * Get recent request logs for the authenticated API key
+   *
+   * @param options - Optional parameters
+   * @param options.limit - Maximum number of logs to return (1-100, default: 50)
+   * @returns Request logs with count
+   * @throws {KrawletError} If not authenticated (401)
+   *
+   * @example
+   * ```typescript
+   * // Get default number of logs (50)
+   * const logs = await client.apiKey.getLogs();
+   *
+   * // Get last 10 requests
+   * const recentLogs = await client.apiKey.getLogs({ limit: 10 });
+   *
+   * for (const log of recentLogs.logs) {
+   *   console.log(`${log.method} ${log.path} - ${log.responseStatus} (${log.responseTimeMs}ms)`);
+   * }
+   * ```
+   */
+  async getLogs(options) {
+    const params = {};
+    if (options?.limit !== void 0) {
+      params.limit = String(options.limit);
+    }
+    const response = await this.client.request("/v1/apikey/logs", {
+      params: Object.keys(params).length > 0 ? params : void 0
+    });
+    return response.data;
+  }
+};
+
 // src/client.ts
 var KrawletClient = class {
   /**
@@ -538,6 +622,7 @@ var KrawletClient = class {
     this.addresses = new AddressesResource(this.httpClient);
     this.storage = new StorageResource(this.httpClient);
     this.reports = new ReportsResource(this.httpClient);
+    this.apiKey = new ApiKeyResource(this.httpClient);
   }
   /**
    * Get the last known rate limit information
@@ -567,6 +652,7 @@ var ErrorCode = /* @__PURE__ */ ((ErrorCode2) => {
 })(ErrorCode || {});
 export {
   AddressesResource,
+  ApiKeyResource,
   ErrorCode,
   HealthResource,
   ItemsResource,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "krawlet-js",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "TypeScript/JavaScript client library for the Krawlet Minecraft economy tracking API",
   "type": "module",
   "main": "dist/index.cjs",