@qwickapps/server 1.6.0 → 1.6.1

package/dist/plugins/api-keys/middleware/usage-logging.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Usage Logging Middleware
+ *
+ * Logs all API key requests for audit trails and usage analytics.
+ * Logging is asynchronous and non-blocking to avoid performance impact.
+ *
+ * Copyright (c) 2025 QwickApps.com. All rights reserved.
+ */
+import type { RequestHandler } from 'express';
+import type { UsageLogStore } from '../stores/usage-log-store.js';
+/**
+ * Create usage logging middleware
+ *
+ * Logs all requests made with API key authentication to the usage log store.
+ * Logging happens asynchronously after the response is sent to avoid latency.
+ *
+ * @param store Usage log storage backend
+ * @returns Express middleware
+ */
+export declare function createUsageLoggingMiddleware(store: UsageLogStore): RequestHandler;
+//# sourceMappingURL=usage-logging.d.ts.map

package/dist/plugins/api-keys/middleware/usage-logging.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"usage-logging.d.ts","sourceRoot":"","sources":["../../../../src/plugins/api-keys/middleware/usage-logging.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAmC,cAAc,EAAE,MAAM,SAAS,CAAC;AAC/E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAclE;;;;;;;;GAQG;AACH,wBAAgB,4BAA4B,CAAC,KAAK,EAAE,aAAa,GAAG,cAAc,CA4CjF"}

package/dist/plugins/api-keys/middleware/usage-logging.js

@@ -0,0 +1,57 @@
+/**
+ * Usage Logging Middleware
+ *
+ * Logs all API key requests for audit trails and usage analytics.
+ * Logging is asynchronous and non-blocking to avoid performance impact.
+ *
+ * Copyright (c) 2025 QwickApps.com. All rights reserved.
+ */
+/**
+ * Create usage logging middleware
+ *
+ * Logs all requests made with API key authentication to the usage log store.
+ * Logging happens asynchronously after the response is sent to avoid latency.
+ *
+ * @param store Usage log storage backend
+ * @returns Express middleware
+ */
+export function createUsageLoggingMiddleware(store) {
+    return (req, res, next) => {
+        const apiKeyReq = req;
+        // Skip if not API key authentication
+        if (!apiKeyReq.apiKey) {
+            return next();
+        }
+        // Capture request details
+        const keyId = apiKeyReq.apiKey.id;
+        const endpoint = req.path;
+        const method = req.method;
+        const ipAddress = (req.ip ||
+            req.headers['x-forwarded-for']?.split(',')[0].trim() ||
+            req.socket?.remoteAddress);
+        const userAgent = req.get('user-agent');
+        // Intercept response to capture status code
+        const originalSend = res.send;
+        res.send = function (data) {
+            const statusCode = res.statusCode;
+            // Log asynchronously after response is sent (non-blocking)
+            setImmediate(() => {
+                store.log({
+                    key_id: keyId,
+                    endpoint,
+                    method,
+                    status_code: statusCode,
+                    ip_address: ipAddress,
+                    user_agent: userAgent,
+                }).catch((error) => {
+                    // Log error but don't fail the request
+                    console.error('[UsageLogging] Failed to log API key usage:', error);
+                });
+            });
+            // Call original send
+            return originalSend.call(this, data);
+        };
+        next();
+    };
+}
+//# sourceMappingURL=usage-logging.js.map

package/dist/plugins/api-keys/middleware/usage-logging.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"usage-logging.js","sourceRoot":"","sources":["../../../../src/plugins/api-keys/middleware/usage-logging.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAiBH;;;;;;;;GAQG;AACH,MAAM,UAAU,4BAA4B,CAAC,KAAoB;IAC/D,OAAO,CAAC,GAAY,EAAE,GAAa,EAAE,IAAkB,EAAQ,EAAE;QAC/D,MAAM,SAAS,GAAG,GAAoB,CAAC;QAEvC,qCAAqC;QACrC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;YACtB,OAAO,IAAI,EAAE,CAAC;QAChB,CAAC;QAED,0BAA0B;QAC1B,MAAM,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;QAClC,MAAM,QAAQ,GAAG,GAAG,CAAC,IAAI,CAAC;QAC1B,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;QAC1B,MAAM,SAAS,GAAG,CAAC,GAAG,CAAC,EAAE;YACtB,GAAG,CAAC,OAAO,CAAC,iBAAiB,CAAY,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE;YAChE,GAAG,CAAC,MAAM,EAAE,aAAa,CAAuB,CAAC;QACnD,MAAM,SAAS,GAAG,GAAG,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QAExC,4CAA4C;QAC5C,MAAM,YAAY,GAAG,GAAG,CAAC,IAAI,CAAC;QAC9B,GAAG,CAAC,IAAI,GAAG,UAAU,IAAc;YACjC,MAAM,UAAU,GAAG,GAAG,CAAC,UAAU,CAAC;YAElC,2DAA2D;YAC3D,YAAY,CAAC,GAAG,EAAE;gBAChB,KAAK,CAAC,GAAG,CAAC;oBACR,MAAM,EAAE,KAAK;oBACb,QAAQ;oBACR,MAAM;oBACN,WAAW,EAAE,UAAU;oBACvB,UAAU,EAAE,SAAS;oBACrB,UAAU,EAAE,SAAS;iBACtB,CAAC,CAAC,KAAK,CAAC,CAAC,KAAY,EAAE,EAAE;oBACxB,uCAAuC;oBACvC,OAAO,CAAC,KAAK,CAAC,6CAA6C,EAAE,KAAK,CAAC,CAAC;gBACtE,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;YAEH,qBAAqB;YACrB,OAAO,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACvC,CAAC,CAAC;QAEF,IAAI,EAAE,CAAC;IACT,CAAC,CAAC;AACJ,CAAC"}

package/dist/plugins/api-keys/stores/index.d.ts

@@ -4,4 +4,6 @@
  * Copyright (c) 2025 QwickApps.com. All rights reserved.
  */
 export { postgresApiKeyStore } from './postgres-store.js';
+export { createPostgresPluginScopeStore, type PluginScope, type PluginScopeStore, type PostgresPluginScopeStoreConfig, } from './plugin-scope-store.js';
+export { createPostgresUsageLogStore, type UsageLogEntry, type UsageLogQueryOptions, type UsageLogStats, type UsageLogStore, type PostgresUsageLogStoreConfig, } from './usage-log-store.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/plugins/api-keys/stores/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/plugins/api-keys/stores/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/plugins/api-keys/stores/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,EACL,8BAA8B,EAC9B,KAAK,WAAW,EAChB,KAAK,gBAAgB,EACrB,KAAK,8BAA8B,GACpC,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACL,2BAA2B,EAC3B,KAAK,aAAa,EAClB,KAAK,oBAAoB,EACzB,KAAK,aAAa,EAClB,KAAK,aAAa,EAClB,KAAK,2BAA2B,GACjC,MAAM,sBAAsB,CAAC"}

package/dist/plugins/api-keys/stores/index.js

@@ -4,4 +4,6 @@
  * Copyright (c) 2025 QwickApps.com. All rights reserved.
  */
 export { postgresApiKeyStore } from './postgres-store.js';
+export { createPostgresPluginScopeStore, } from './plugin-scope-store.js';
+export { createPostgresUsageLogStore, } from './usage-log-store.js';
 //# sourceMappingURL=index.js.map

package/dist/plugins/api-keys/stores/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/plugins/api-keys/stores/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/plugins/api-keys/stores/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,EACL,8BAA8B,GAI/B,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACL,2BAA2B,GAM5B,MAAM,sBAAsB,CAAC"}

package/dist/plugins/api-keys/stores/plugin-scope-store.d.ts

@@ -0,0 +1,81 @@
+/**
+ * Plugin Scope Store - PostgreSQL Implementation
+ *
+ * Manages plugin-declared scopes for fine-grained API key authorization.
+ * Plugins register their scopes during initialization, which are then available
+ * for selection during API key creation.
+ *
+ * Copyright (c) 2025 QwickApps.com. All rights reserved.
+ */
+import type { Pool } from 'pg';
+/**
+ * Plugin scope definition
+ */
+export interface PluginScope {
+    /** Scope name in format 'plugin-id:action' (e.g., 'qwickbrain:execute') */
+    name: string;
+    /** Plugin ID that declares this scope */
+    plugin_id: string;
+    /** Human-readable description for UI */
+    description: string;
+    /** Optional category for grouping (read, write, admin) */
+    category?: 'read' | 'write' | 'admin';
+    /** When scope was registered */
+    created_at?: Date;
+    /** When scope was last updated */
+    updated_at?: Date;
+}
+/**
+ * Plugin scope store interface
+ */
+export interface PluginScopeStore {
+    /** Store name */
+    name: string;
+    /**
+     * Initialize the store (create tables, indexes, etc.)
+     */
+    initialize(): Promise<void>;
+    /**
+     * Register scopes for a plugin (upsert operation)
+     * Existing scopes are updated, new scopes are inserted, removed scopes are deleted
+     */
+    registerScopes(pluginId: string, scopes: Omit<PluginScope, 'plugin_id' | 'created_at' | 'updated_at'>[]): Promise<void>;
+    /**
+     * Get all scopes for a specific plugin
+     */
+    getPluginScopes(pluginId: string): Promise<PluginScope[]>;
+    /**
+     * Get all available scopes across all plugins
+     */
+    getAllScopes(): Promise<PluginScope[]>;
+    /**
+     * Verify a scope exists
+     */
+    isValidScope(scopeName: string): Promise<boolean>;
+    /**
+     * Delete all scopes for a plugin
+     */
+    deletePluginScopes(pluginId: string): Promise<void>;
+    /**
+     * Shutdown the store
+     */
+    shutdown(): Promise<void>;
+}
+/**
+ * PostgreSQL plugin scope store configuration
+ */
+export interface PostgresPluginScopeStoreConfig {
+    /** PostgreSQL pool instance or a function that returns one (for lazy initialization) */
+    pool: Pool | (() => Pool);
+    /** Table name (default: 'plugin_scopes') */
+    tableName?: string;
+    /** Schema name (default: 'public') */
+    schema?: string;
+    /** Auto-create tables on init (default: true) */
+    autoCreateTables?: boolean;
+}
+/**
+ * PostgreSQL implementation of PluginScopeStore
+ */
+export declare function createPostgresPluginScopeStore(config: PostgresPluginScopeStoreConfig): PluginScopeStore;
+//# sourceMappingURL=plugin-scope-store.d.ts.map

package/dist/plugins/api-keys/stores/plugin-scope-store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin-scope-store.d.ts","sourceRoot":"","sources":["../../../../src/plugins/api-keys/stores/plugin-scope-store.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,IAAI,CAAC;AAE/B;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,2EAA2E;IAC3E,IAAI,EAAE,MAAM,CAAC;IACb,yCAAyC;IACzC,SAAS,EAAE,MAAM,CAAC;IAClB,wCAAwC;IACxC,WAAW,EAAE,MAAM,CAAC;IACpB,0DAA0D;IAC1D,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC;IACtC,gCAAgC;IAChC,UAAU,CAAC,EAAE,IAAI,CAAC;IAClB,kCAAkC;IAClC,UAAU,CAAC,EAAE,IAAI,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5B;;;OAGG;IACH,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,WAAW,EAAE,WAAW,GAAG,YAAY,GAAG,YAAY,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExH;;OAEG;IACH,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IAE1D;;OAEG;IACH,YAAY,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IAEvC;;OAEG;IACH,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAElD;;OAEG;IACH,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpD;;OAEG;IACH,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,wFAAwF;IACxF,IAAI,EAAE,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,CAAC;IAC1B,4CAA4C;IAC5C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,sCAAsC;IACtC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iDAAiD;IACjD,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED;;GAEG;AACH,wBAAgB,8BAA8B,CAC5C,MAAM,EAAE,8BAA8B,GACrC,gBAAgB,CA0LlB"}

package/dist/plugins/api-keys/stores/plugin-scope-store.js

@@ -0,0 +1,155 @@
+/**
+ * Plugin Scope Store - PostgreSQL Implementation
+ *
+ * Manages plugin-declared scopes for fine-grained API key authorization.
+ * Plugins register their scopes during initialization, which are then available
+ * for selection during API key creation.
+ *
+ * Copyright (c) 2025 QwickApps.com. All rights reserved.
+ */
+/**
+ * PostgreSQL implementation of PluginScopeStore
+ */
+export function createPostgresPluginScopeStore(config) {
+    const tableName = config.tableName || 'plugin_scopes';
+    const schema = config.schema || 'public';
+    const tableFullName = `"${schema}"."${tableName}"`;
+    const autoCreateTables = config.autoCreateTables !== false;
+    // In-memory cache for fast validation
+    const scopeCache = new Set();
+    let cacheInitialized = false;
+    /**
+     * Get PostgreSQL pool (lazy initialization support)
+     */
+    function getPool() {
+        if (typeof config.pool === 'function') {
+            return config.pool();
+        }
+        return config.pool;
+    }
+    /**
+     * Initialize scope cache
+     */
+    async function initializeCache() {
+        if (cacheInitialized)
+            return;
+        const pool = getPool();
+        const result = await pool.query(`SELECT name FROM ${tableFullName}`);
+        scopeCache.clear();
+        result.rows.forEach(row => scopeCache.add(row.name));
+        cacheInitialized = true;
+    }
+    /**
+     * Refresh cache after modifications
+     */
+    async function refreshCache() {
+        cacheInitialized = false;
+        await initializeCache();
+    }
+    return {
+        name: 'postgres',
+        async initialize() {
+            if (!autoCreateTables)
+                return;
+            const pool = getPool();
+            // Create plugin_scopes table
+            await pool.query(`
+        CREATE TABLE IF NOT EXISTS ${tableFullName} (
+          id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
+          plugin_id VARCHAR(255) NOT NULL,
+          name VARCHAR(255) NOT NULL UNIQUE,
+          description TEXT NOT NULL,
+          category VARCHAR(50),
+          created_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),
+          updated_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),
+
+          -- Enforce naming convention: plugin-id:action
+          CONSTRAINT scope_name_format CHECK (name ~ '^[a-z0-9-]+:[a-z0-9-]+$')
+        );
+
+        -- Indexes for performance
+        CREATE INDEX IF NOT EXISTS idx_${tableName}_plugin_id ON ${tableFullName}(plugin_id);
+        CREATE INDEX IF NOT EXISTS idx_${tableName}_category ON ${tableFullName}(category);
+        CREATE INDEX IF NOT EXISTS idx_${tableName}_name ON ${tableFullName}(name);
+      `);
+            // Insert system scopes for backwards compatibility
+            await pool.query(`
+        INSERT INTO ${tableFullName} (plugin_id, name, description, category)
+        VALUES
+          ('system', 'system:read', 'Read access to system resources', 'read'),
+          ('system', 'system:write', 'Write access to system resources', 'write'),
+          ('system', 'system:admin', 'Administrative access to system resources', 'admin')
+        ON CONFLICT (name) DO NOTHING;
+      `);
+            // Initialize cache
+            await initializeCache();
+        },
+        async registerScopes(pluginId, scopes) {
+            const pool = getPool();
+            // Start transaction for atomic upsert
+            const client = await pool.connect();
+            try {
+                await client.query('BEGIN');
+                // Get existing scopes for this plugin
+                const existingResult = await client.query(`SELECT name FROM ${tableFullName} WHERE plugin_id = $1`, [pluginId]);
+                const existingScopes = new Set(existingResult.rows.map(r => r.name));
+                const newScopes = new Set(scopes.map(s => s.name));
+                // Delete scopes that are no longer declared
+                const scopesToDelete = [...existingScopes].filter(name => !newScopes.has(name));
+                if (scopesToDelete.length > 0) {
+                    await client.query(`DELETE FROM ${tableFullName} WHERE plugin_id = $1 AND name = ANY($2)`, [pluginId, scopesToDelete]);
+                }
+                // Upsert scopes (insert new, update existing)
+                for (const scope of scopes) {
+                    await client.query(`INSERT INTO ${tableFullName} (plugin_id, name, description, category)
+             VALUES ($1, $2, $3, $4)
+             ON CONFLICT (name) DO UPDATE SET
+               description = EXCLUDED.description,
+               category = EXCLUDED.category,
+               updated_at = NOW()`, [pluginId, scope.name, scope.description, scope.category || null]);
+                }
+                await client.query('COMMIT');
+                // Refresh cache
+                await refreshCache();
+            }
+            catch (error) {
+                await client.query('ROLLBACK');
+                throw error;
+            }
+            finally {
+                client.release();
+            }
+        },
+        async getPluginScopes(pluginId) {
+            const pool = getPool();
+            const result = await pool.query(`SELECT plugin_id, name, description, category, created_at, updated_at
+         FROM ${tableFullName}
+         WHERE plugin_id = $1
+         ORDER BY name`, [pluginId]);
+            return result.rows;
+        },
+        async getAllScopes() {
+            const pool = getPool();
+            const result = await pool.query(`SELECT plugin_id, name, description, category, created_at, updated_at
+         FROM ${tableFullName}
+         ORDER BY plugin_id, name`);
+            return result.rows;
+        },
+        async isValidScope(scopeName) {
+            // Use cache for fast validation
+            await initializeCache();
+            return scopeCache.has(scopeName);
+        },
+        async deletePluginScopes(pluginId) {
+            const pool = getPool();
+            await pool.query(`DELETE FROM ${tableFullName} WHERE plugin_id = $1`, [pluginId]);
+            // Refresh cache
+            await refreshCache();
+        },
+        async shutdown() {
+            scopeCache.clear();
+            cacheInitialized = false;
+        },
+    };
+}
+//# sourceMappingURL=plugin-scope-store.js.map

package/dist/plugins/api-keys/stores/plugin-scope-store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin-scope-store.js","sourceRoot":"","sources":["../../../../src/plugins/api-keys/stores/plugin-scope-store.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAgFH;;GAEG;AACH,MAAM,UAAU,8BAA8B,CAC5C,MAAsC;IAEtC,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,IAAI,eAAe,CAAC;IACtD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,QAAQ,CAAC;IACzC,MAAM,aAAa,GAAG,IAAI,MAAM,MAAM,SAAS,GAAG,CAAC;IACnD,MAAM,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,KAAK,KAAK,CAAC;IAE3D,sCAAsC;IACtC,MAAM,UAAU,GAAG,IAAI,GAAG,EAAU,CAAC;IACrC,IAAI,gBAAgB,GAAG,KAAK,CAAC;IAE7B;;OAEG;IACH,SAAS,OAAO;QACd,IAAI,OAAO,MAAM,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YACtC,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC;QACvB,CAAC;QACD,OAAO,MAAM,CAAC,IAAI,CAAC;IACrB,CAAC;IAED;;OAEG;IACH,KAAK,UAAU,eAAe;QAC5B,IAAI,gBAAgB;YAAE,OAAO;QAE7B,MAAM,IAAI,GAAG,OAAO,EAAE,CAAC;QACvB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAC7B,oBAAoB,aAAa,EAAE,CACpC,CAAC;QAEF,UAAU,CAAC,KAAK,EAAE,CAAC;QACnB,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;QACrD,gBAAgB,GAAG,IAAI,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,KAAK,UAAU,YAAY;QACzB,gBAAgB,GAAG,KAAK,CAAC;QACzB,MAAM,eAAe,EAAE,CAAC;IAC1B,CAAC;IAED,OAAO;QACL,IAAI,EAAE,UAAU;QAEhB,KAAK,CAAC,UAAU;YACd,IAAI,CAAC,gBAAgB;gBAAE,OAAO;YAE9B,MAAM,IAAI,GAAG,OAAO,EAAE,CAAC;YAEvB,6BAA6B;YAC7B,MAAM,IAAI,CAAC,KAAK,CAAC;qCACc,aAAa;;;;;;;;;;;;;;yCAcT,SAAS,iBAAiB,aAAa;yCACvC,SAAS,gBAAgB,aAAa;yCACtC,SAAS,YAAY,aAAa;OACpE,CAAC,CAAC;YAEH,mDAAmD;YACnD,MAAM,IAAI,CAAC,KAAK,CAAC;sBACD,aAAa;;;;;;OAM5B,CAAC,CAAC;YAEH,mBAAmB;YACnB,MAAM,eAAe,EAAE,CAAC;QAC1B,CAAC;QAED,KAAK,CAAC,cAAc,CAClB,QAAgB,EAChB,MAAsE;YAEtE,MAAM,IAAI,GAAG,OAAO,EAAE,CAAC;YAEvB,sCAAsC;YACtC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;YACpC,IAAI,CAAC;gBACH,MAAM,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBAE5B,sCAAsC;gBACtC,MAAM,cAAc,GAAG,MAAM,MAAM,CAAC,KAAK,CACvC,oBAAoB,aAAa,uBAAuB,EACxD,CAAC,QAAQ,CAAC,CACX,CAAC;gBACF,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;gBACrE,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;gBAEnD,4CAA4C;gBAC5C,MAAM,cAAc,GAAG,CAAC,GAAG,cAAc,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;gBAChF,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC9B,MAAM,MAAM,CAAC,KAAK,CAChB,eAAe,aAAa,0CAA0C,EACtE,CAAC,QAAQ,EAAE,cAAc,CAAC,CAC3B,CAAC;gBACJ,CAAC;gBAED,8CAA8C;gBAC9C,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;oBAC3B,MAAM,MAAM,CAAC,KAAK,CAChB,eAAe,aAAa;;;;;kCAKN,EACtB,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,WAAW,EAAE,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,CAClE,CAAC;gBACJ,CAAC;gBAED,MAAM,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;gBAE7B,gBAAgB;gBAChB,MAAM,YAAY,EAAE,CAAC;YACvB,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;gBAC/B,MAAM,KAAK,CAAC;YACd,CAAC;oBAAS,CAAC;gBACT,MAAM,CAAC,OAAO,EAAE,CAAC;YACnB,CAAC;QACH,CAAC;QAED,KAAK,CAAC,eAAe,CAAC,QAAgB;YACpC,MAAM,IAAI,GAAG,OAAO,EAAE,CAAC;YACvB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAC7B;gBACQ,aAAa;;uBAEN,EACf,CAAC,QAAQ,CAAC,CACX,CAAC;YAEF,OAAO,MAAM,CAAC,IAAI,CAAC;QACrB,CAAC;QAED,KAAK,CAAC,YAAY;YAChB,MAAM,IAAI,GAAG,OAAO,EAAE,CAAC;YACvB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAC7B;gBACQ,aAAa;kCACK,CAC3B,CAAC;YAEF,OAAO,MAAM,CAAC,IAAI,CAAC;QACrB,CAAC;QAED,KAAK,CAAC,YAAY,CAAC,SAAiB;YAClC,gCAAgC;YAChC,MAAM,eAAe,EAAE,CAAC;YACxB,OAAO,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACnC,CAAC;QAED,KAAK,CAAC,kBAAkB,CAAC,QAAgB;YACvC,MAAM,IAAI,GAAG,OAAO,EAAE,CAAC;YACvB,MAAM,IAAI,CAAC,KAAK,CACd,eAAe,aAAa,uBAAuB,EACnD,CAAC,QAAQ,CAAC,CACX,CAAC;YAEF,gBAAgB;YAChB,MAAM,YAAY,EAAE,CAAC;QACvB,CAAC;QAED,KAAK,CAAC,QAAQ;YACZ,UAAU,CAAC,KAAK,EAAE,CAAC;YACnB,gBAAgB,GAAG,KAAK,CAAC;QAC3B,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/plugins/api-keys/stores/usage-log-store.d.ts

@@ -0,0 +1,119 @@
+/**
+ * API Key Usage Log Store - PostgreSQL Implementation
+ *
+ * Tracks all API calls made with API keys for audit trails and usage analytics.
+ * Uses table partitioning for efficient storage and querying of large log volumes.
+ *
+ * Copyright (c) 2025 QwickApps.com. All rights reserved.
+ */
+import type { Pool } from 'pg';
+/**
+ * API key usage log entry
+ */
+export interface UsageLogEntry {
+    /** Log entry ID */
+    id?: string;
+    /** API key ID that made the request */
+    key_id: string;
+    /** Endpoint path (e.g., '/cpanel/api/qwickbrain/tools') */
+    endpoint: string;
+    /** HTTP method (GET, POST, etc.) */
+    method: string;
+    /** HTTP response status code */
+    status_code?: number;
+    /** Client IP address */
+    ip_address?: string;
+    /** User agent string */
+    user_agent?: string;
+    /** Request timestamp */
+    timestamp?: Date;
+}
+/**
+ * Usage log query options
+ */
+export interface UsageLogQueryOptions {
+    /** Limit number of results */
+    limit?: number;
+    /** Offset for pagination */
+    offset?: number;
+    /** Filter by start date */
+    since?: Date;
+    /** Filter by end date */
+    until?: Date;
+    /** Filter by endpoint pattern */
+    endpoint?: string;
+    /** Filter by HTTP method */
+    method?: string;
+    /** Filter by status code */
+    statusCode?: number;
+}
+/**
+ * Usage log statistics
+ */
+export interface UsageLogStats {
+    /** Total number of calls */
+    totalCalls: number;
+    /** Last call timestamp */
+    lastUsed?: Date;
+    /** Calls by status code */
+    callsByStatus: Record<number, number>;
+    /** Calls by endpoint */
+    callsByEndpoint: Record<string, number>;
+}
+/**
+ * Usage log store interface
+ */
+export interface UsageLogStore {
+    /** Store name */
+    name: string;
+    /**
+     * Initialize the store (create tables, partitions, indexes, etc.)
+     */
+    initialize(): Promise<void>;
+    /**
+     * Log an API key usage
+     */
+    log(entry: UsageLogEntry): Promise<void>;
+    /**
+     * Batch log multiple entries (more efficient)
+     */
+    logBatch(entries: UsageLogEntry[]): Promise<void>;
+    /**
+     * Get usage logs for a specific API key
+     */
+    getKeyUsage(keyId: string, options?: UsageLogQueryOptions): Promise<UsageLogEntry[]>;
+    /**
+     * Get usage statistics for a specific API key
+     */
+    getKeyStats(keyId: string, options?: Pick<UsageLogQueryOptions, 'since' | 'until'>): Promise<UsageLogStats>;
+    /**
+     * Delete old logs (for retention policy)
+     */
+    deleteOlderThan(date: Date): Promise<number>;
+    /**
+     * Shutdown the store
+     */
+    shutdown(): Promise<void>;
+}
+/**
+ * PostgreSQL usage log store configuration
+ */
+export interface PostgresUsageLogStoreConfig {
+    /** PostgreSQL pool instance or a function that returns one (for lazy initialization) */
+    pool: Pool | (() => Pool);
+    /** Table name (default: 'api_key_usage_logs') */
+    tableName?: string;
+    /** Schema name (default: 'public') */
+    schema?: string;
+    /** Auto-create tables on init (default: true) */
+    autoCreateTables?: boolean;
+    /** Enable table partitioning (default: true) */
+    enablePartitioning?: boolean;
+    /** Partition interval in days (default: 30) */
+    partitionIntervalDays?: number;
+}
+/**
+ * PostgreSQL implementation of UsageLogStore
+ */
+export declare function createPostgresUsageLogStore(config: PostgresUsageLogStoreConfig): UsageLogStore;
+//# sourceMappingURL=usage-log-store.d.ts.map

package/dist/plugins/api-keys/stores/usage-log-store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"usage-log-store.d.ts","sourceRoot":"","sources":["../../../../src/plugins/api-keys/stores/usage-log-store.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,IAAI,CAAC;AAE/B;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,mBAAmB;IACnB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,uCAAuC;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,2DAA2D;IAC3D,QAAQ,EAAE,MAAM,CAAC;IACjB,oCAAoC;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,gCAAgC;IAChC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,wBAAwB;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,wBAAwB;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,wBAAwB;IACxB,SAAS,CAAC,EAAE,IAAI,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,8BAA8B;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,4BAA4B;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2BAA2B;IAC3B,KAAK,CAAC,EAAE,IAAI,CAAC;IACb,yBAAyB;IACzB,KAAK,CAAC,EAAE,IAAI,CAAC;IACb,iCAAiC;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,4BAA4B;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,4BAA4B;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,4BAA4B;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,IAAI,CAAC;IAChB,2BAA2B;IAC3B,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,wBAAwB;IACxB,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5B;;OAEG;IACH,GAAG,CAAC,KAAK,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElD;;OAEG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC;IAErF;;OAEG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,oBAAoB,EAAE,OAAO,GAAG,OAAO,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAE5G;;OAEG;IACH,eAAe,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE7C;;OAEG;IACH,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,wFAAwF;IACxF,IAAI,EAAE,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,CAAC;IAC1B,iDAAiD;IACjD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,sCAAsC;IACtC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iDAAiD;IACjD,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,gDAAgD;IAChD,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,+CAA+C;IAC/C,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED;;GAEG;AACH,wBAAgB,2BAA2B,CACzC,MAAM,EAAE,2BAA2B,GAClC,aAAa,CAiSf"}