@dotdo/postgres 0.1.0

package/dist/pglite/workers-pglite.js

@@ -0,0 +1,143 @@
+/**
+ * Workers-Compatible PGLite Wrapper
+ *
+ * This module provides a production-grade PGLite implementation for Cloudflare Workers
+ * that works around the `addFunction` limitation by using the trampoline-based
+ * implementation from @dotdo/pglite/workers.
+ *
+ * Key features:
+ * - Uses pre-compiled WASM modules (no runtime compilation)
+ * - Uses EM_JS trampolines instead of addFunction (no CSP violations)
+ * - Properly handles fsBundle as ArrayBuffer or Blob
+ * - Provides query/exec/transaction interface compatible with PostgresDO
+ *
+ * @example
+ * ```typescript
+ * import { createWorkersPGLite } from './workers-pglite'
+ * import pgliteWasm from '../pglite-assets/pglite.wasm'
+ * import pgliteData from '../pglite-assets/pglite.data'
+ *
+ * const db = await createWorkersPGLite({
+ *   wasmModule: pgliteWasm,
+ *   fsBundle: pgliteData,
+ *   debug: true,
+ * })
+ *
+ * const result = await db.query('SELECT 1 + 1 AS sum')
+ * console.log(result.rows[0].sum) // 2
+ * ```
+ */
+import { PGlite } from '@dotdo/pglite';
+/**
+ * Wrapper around PGliteWorkers that provides a compatible interface
+ * for PostgresDO and handles fsBundle conversion
+ */
+export class WorkersPGLite {
+    pglite;
+    _ready = false;
+    constructor(pglite) {
+        this.pglite = pglite;
+        this._ready = true;
+    }
+    /**
+     * Create a new WorkersPGLite instance
+     */
+    static async create(options) {
+        // Convert fsBundle to ArrayBuffer if needed
+        let fsBundleBuffer;
+        if (options.fsBundle instanceof ArrayBuffer) {
+            fsBundleBuffer = options.fsBundle;
+        }
+        else if (options.fsBundle instanceof Blob) {
+            fsBundleBuffer = await options.fsBundle.arrayBuffer();
+        }
+        else if (options.fsBundle instanceof ReadableStream) {
+            const response = new Response(options.fsBundle);
+            fsBundleBuffer = await response.arrayBuffer();
+        }
+        else if (ArrayBuffer.isView(options.fsBundle)) {
+            // Handle Uint8Array or other typed arrays using type-safe conversion
+            const view = options.fsBundle;
+            if (view.buffer instanceof ArrayBuffer) {
+                // Regular ArrayBuffer - slice it directly
+                fsBundleBuffer = view.buffer.slice(view.byteOffset, view.byteOffset + view.byteLength);
+            }
+            else {
+                // SharedArrayBuffer - copy to new ArrayBuffer
+                const copy = new Uint8Array(view.byteLength);
+                copy.set(new Uint8Array(view.buffer, view.byteOffset, view.byteLength));
+                fsBundleBuffer = copy.buffer;
+            }
+        }
+        else {
+            // Fallback for any other type - attempt to use as-is
+            fsBundleBuffer = options.fsBundle;
+        }
+        // Create PGliteWorkers instance
+        // fsBundle expects Blob | File, so wrap the ArrayBuffer in a Blob
+        const pgliteOptions = {
+            wasmModule: options.wasmModule,
+            fsBundle: new Blob([fsBundleBuffer]),
+            database: options.database ?? 'postgres',
+            debug: options.debug ?? 0,
+        };
+        const pglite = await PGlite.create(pgliteOptions);
+        return new WorkersPGLite(pglite);
+    }
+    /**
+     * Check if the database is ready
+     */
+    get ready() {
+        return this._ready;
+    }
+    /**
+     * Promise that resolves when database is ready
+     * (already resolved for this implementation)
+     */
+    get waitReady() {
+        return Promise.resolve();
+    }
+    /**
+     * Execute a SQL query with optional parameters
+     * Uses PGlite's native parameterized query support for SQL injection safety
+     */
+    async query(sql, params) {
+        // Pass parameters directly to PGlite which uses the PostgreSQL
+        // Extended Query protocol with proper prepared statement safety
+        const result = await this.pglite.query(sql, params);
+        const queryResult = {
+            rows: result.rows,
+            fields: result.fields ?? [],
+        };
+        if (result.affectedRows !== undefined) {
+            queryResult.affectedRows = result.affectedRows;
+        }
+        return queryResult;
+    }
+    /**
+     * Execute SQL without returning results
+     */
+    async exec(sql) {
+        await this.pglite.exec(sql);
+    }
+    /**
+     * Close the database connection
+     */
+    async close() {
+        this._ready = false;
+        await this.pglite.close();
+    }
+}
+/**
+ * Factory function to create a WorkersPGLite instance
+ */
+export async function createWorkersPGLite(options) {
+    return WorkersPGLite.create(options);
+}
+/**
+ * Type guard to check if a value is a WorkersPGLite instance
+ */
+export function isWorkersPGLite(value) {
+    return value instanceof WorkersPGLite;
+}
+//# sourceMappingURL=workers-pglite.js.map

package/dist/pglite/workers-pglite.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workers-pglite.js","sourceRoot":"","sources":["../../src/pglite/workers-pglite.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AAEH,OAAO,EAAE,MAAM,EAAuC,MAAM,eAAe,CAAA;AA+D3E;;;GAGG;AACH,MAAM,OAAO,aAAa;IAChB,MAAM,CAAe;IACrB,MAAM,GAAY,KAAK,CAAA;IAE/B,YAAoB,MAAqB;QACvC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAA;IACpB,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAA6B;QAC/C,4CAA4C;QAC5C,IAAI,cAA2B,CAAA;QAE/B,IAAI,OAAO,CAAC,QAAQ,YAAY,WAAW,EAAE,CAAC;YAC5C,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAA;QACnC,CAAC;aAAM,IAAI,OAAO,CAAC,QAAQ,YAAY,IAAI,EAAE,CAAC;YAC5C,cAAc,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAA;QACvD,CAAC;aAAM,IAAI,OAAO,CAAC,QAAQ,YAAY,cAAc,EAAE,CAAC;YACtD,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;YAC/C,cAAc,GAAG,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAA;QAC/C,CAAC;aAAM,IAAI,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YAChD,qEAAqE;YACrE,MAAM,IAAI,GAAG,OAAO,CAAC,QAAQ,CAAA;YAC7B,IAAI,IAAI,CAAC,MAAM,YAAY,WAAW,EAAE,CAAC;gBACvC,0CAA0C;gBAC1C,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,CAAA;YACxF,CAAC;iBAAM,CAAC;gBACN,8CAA8C;gBAC9C,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;gBAC5C,IAAI,CAAC,GAAG,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAA;gBACvE,cAAc,GAAG,IAAI,CAAC,MAAM,CAAA;YAC9B,CAAC;QACH,CAAC;aAAM,CAAC;YACN,qDAAqD;YACrD,cAAc,GAAG,OAAO,CAAC,QAAuB,CAAA;QAClD,CAAC;QAED,gCAAgC;QAChC,kEAAkE;QAClE,MAAM,aAAa,GAAyB;YAC1C,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC,cAAc,CAAC,CAAC;YACpC,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,UAAU;YACxC,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,CAAC;SAC1B,CAAA;QAED,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAA;QACjD,OAAO,IAAI,aAAa,CAAC,MAAM,CAAC,CAAA;IAClC,CAAC;IAED;;OAEG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAA;IACpB,CAAC;IAED;;;OAGG;IACH,IAAI,SAAS;QACX,OAAO,OAAO,CAAC,OAAO,EAAE,CAAA;IAC1B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,KAAK,CAAc,GAAW,EAAE,MAAkB;QAKtD,+DAA+D;QAC/D,gEAAgE;QAChE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAI,GAAG,EAAE,MAAM,CAAC,CAAA;QAEtD,MAAM,WAAW,GAIb;YACF,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,MAAM,EAAE,MAAM,CAAC,MAAM,IAAI,EAAE;SAC5B,CAAA;QACD,IAAI,MAAM,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YACtC,WAAW,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAA;QAChD,CAAC;QACD,OAAO,WAAW,CAAA;IACpB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,GAAW;QACpB,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IAC7B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,MAAM,GAAG,KAAK,CAAA;QACnB,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAA;IAC3B,CAAC;CACF;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,OAA6B;IACrE,OAAO,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;AACtC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,KAAc;IAC5C,OAAO,KAAK,YAAY,aAAa,CAAA;AACvC,CAAC"}

package/dist/playground/index.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Playground Module
+ *
+ * Interactive SQL playground for browser-based PostgreSQL execution.
+ * This module provides a complete interactive environment for running SQL queries
+ * in the browser using PGLite (PostgreSQL compiled to WebAssembly).
+ *
+ * ## Features
+ *
+ * - **SQL Query Execution**: Execute SQL queries with parameter binding
+ * - **Result Formatting**: Display results in table, JSON, or CSV format
+ * - **Schema Exploration**: Browse database tables, columns, and indexes
+ * - **Query History**: Track and search through executed queries
+ * - **Error Handling**: User-friendly error messages with position information
+ *
+ * ## Usage
+ *
+ * ```typescript
+ * import { createPlayground } from '@dotdo/postgres/playground'
+ *
+ * const playground = await createPlayground()
+ * await playground.initialize()
+ *
+ * // Execute queries
+ * const result = await playground.executeQuery('SELECT * FROM users')
+ *
+ * // Format results
+ * if (result.success) {
+ *   const formatted = playground.getFormatter().format(result, {
+ *     pageSize: 10
+ *   })
+ * }
+ *
+ * // Explore schema
+ * const tables = await playground.getSchemaExplorer().getTables()
+ *
+ * // Track history
+ * const history = playground.getHistoryManager().getAll()
+ * ```
+ *
+ * @module playground
+ */
+export type { PlaygroundQueryOptions, QueryResultField, PlaygroundQueryResult, PlaygroundQueryError, PlaygroundExecutionResult, QueryExecutionPlan, ResultDisplayFormat, ColumnDisplayConfig, TableDisplayOptions, FormattedResult, TableInfo, ColumnInfo, IndexInfo, TableSchema, SchemaBrowserState, QueryHistoryEntry, QueryHistoryState, AddHistoryEntryOptions, PlaygroundState, IQueryExecutor, IResultFormatter, ISchemaExplorer, IQueryHistoryManager, IPlayground, } from './types';
+export { createPlayground, Playground, type PlaygroundOptions } from './playground';
+export { createQueryExecutor, PlaygroundQueryExecutor, type PlaygroundQueryExecutorOptions } from './query-executor';
+export { createResultFormatter, ResultFormatter } from './result-formatter';
+export { createSchemaExplorer, SchemaExplorer } from './schema-explorer';
+export { createQueryHistoryManager, QueryHistoryManager, type QueryHistoryManagerOptions } from './query-history';
+export { type SampleQuery, type SampleQueryCategory, type SampleQueryCategoryInfo, SAMPLE_QUERY_CATEGORIES, SAMPLE_QUERIES, getQueriesByCategory, getQueriesByDifficulty, getStandaloneQueries, searchQueries, getQueryById, } from './sample-queries';
+export { type SampleDataset, SAMPLE_DATASETS, BLOG_DATASET, ECOMMERCE_DATASET, HR_DATASET, IOT_DATASET, getDatasetById, getDatasetsByTag, getAllDatasetTags, getDatasetSql, getDefaultDatasetSql, } from './sample-datasets';
+export { type ModifierKey, type KeyboardShortcut, type ShortcutCategory, type ShortcutCategoryInfo, type ShortcutHandler, SHORTCUT_CATEGORIES, KEYBOARD_SHORTCUTS, detectPlatform, getEffectiveModifiers, formatShortcut, getShortcutsByCategory, getShortcutById, matchesShortcut, findMatchingShortcut, generateShortcutsReference, createShortcutHandler, } from './keyboard-shortcuts';
+//# sourceMappingURL=index.d.ts.map

package/dist/playground/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/playground/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AAGH,YAAY,EAEV,sBAAsB,EACtB,gBAAgB,EAChB,qBAAqB,EACrB,oBAAoB,EACpB,yBAAyB,EACzB,kBAAkB,EAGlB,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,eAAe,EAGf,SAAS,EACT,UAAU,EACV,SAAS,EACT,WAAW,EACX,kBAAkB,EAGlB,iBAAiB,EACjB,iBAAiB,EACjB,sBAAsB,EAGtB,eAAe,EAGf,cAAc,EACd,gBAAgB,EAChB,eAAe,EACf,oBAAoB,EACpB,WAAW,GACZ,MAAM,SAAS,CAAA;AAGhB,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,KAAK,iBAAiB,EAAE,MAAM,cAAc,CAAA;AACnF,OAAO,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,KAAK,8BAA8B,EAAE,MAAM,kBAAkB,CAAA;AACpH,OAAO,EAAE,qBAAqB,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AAC3E,OAAO,EAAE,oBAAoB,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AACxE,OAAO,EAAE,yBAAyB,EAAE,mBAAmB,EAAE,KAAK,0BAA0B,EAAE,MAAM,iBAAiB,CAAA;AAGjH,OAAO,EACL,KAAK,WAAW,EAChB,KAAK,mBAAmB,EACxB,KAAK,uBAAuB,EAC5B,uBAAuB,EACvB,cAAc,EACd,oBAAoB,EACpB,sBAAsB,EACtB,oBAAoB,EACpB,aAAa,EACb,YAAY,GACb,MAAM,kBAAkB,CAAA;AAGzB,OAAO,EACL,KAAK,aAAa,EAClB,eAAe,EACf,YAAY,EACZ,iBAAiB,EACjB,UAAU,EACV,WAAW,EACX,cAAc,EACd,gBAAgB,EAChB,iBAAiB,EACjB,aAAa,EACb,oBAAoB,GACrB,MAAM,mBAAmB,CAAA;AAG1B,OAAO,EACL,KAAK,WAAW,EAChB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,EACzB,KAAK,eAAe,EACpB,mBAAmB,EACnB,kBAAkB,EAClB,cAAc,EACd,qBAAqB,EACrB,cAAc,EACd,sBAAsB,EACtB,eAAe,EACf,eAAe,EACf,oBAAoB,EACpB,0BAA0B,EAC1B,qBAAqB,GACtB,MAAM,sBAAsB,CAAA"}

package/dist/playground/index.js

@@ -0,0 +1,55 @@
+/**
+ * Playground Module
+ *
+ * Interactive SQL playground for browser-based PostgreSQL execution.
+ * This module provides a complete interactive environment for running SQL queries
+ * in the browser using PGLite (PostgreSQL compiled to WebAssembly).
+ *
+ * ## Features
+ *
+ * - **SQL Query Execution**: Execute SQL queries with parameter binding
+ * - **Result Formatting**: Display results in table, JSON, or CSV format
+ * - **Schema Exploration**: Browse database tables, columns, and indexes
+ * - **Query History**: Track and search through executed queries
+ * - **Error Handling**: User-friendly error messages with position information
+ *
+ * ## Usage
+ *
+ * ```typescript
+ * import { createPlayground } from '@dotdo/postgres/playground'
+ *
+ * const playground = await createPlayground()
+ * await playground.initialize()
+ *
+ * // Execute queries
+ * const result = await playground.executeQuery('SELECT * FROM users')
+ *
+ * // Format results
+ * if (result.success) {
+ *   const formatted = playground.getFormatter().format(result, {
+ *     pageSize: 10
+ *   })
+ * }
+ *
+ * // Explore schema
+ * const tables = await playground.getSchemaExplorer().getTables()
+ *
+ * // Track history
+ * const history = playground.getHistoryManager().getAll()
+ * ```
+ *
+ * @module playground
+ */
+// Export implementations
+export { createPlayground, Playground } from './playground';
+export { createQueryExecutor, PlaygroundQueryExecutor } from './query-executor';
+export { createResultFormatter, ResultFormatter } from './result-formatter';
+export { createSchemaExplorer, SchemaExplorer } from './schema-explorer';
+export { createQueryHistoryManager, QueryHistoryManager } from './query-history';
+// Export sample queries
+export { SAMPLE_QUERY_CATEGORIES, SAMPLE_QUERIES, getQueriesByCategory, getQueriesByDifficulty, getStandaloneQueries, searchQueries, getQueryById, } from './sample-queries';
+// Export sample datasets
+export { SAMPLE_DATASETS, BLOG_DATASET, ECOMMERCE_DATASET, HR_DATASET, IOT_DATASET, getDatasetById, getDatasetsByTag, getAllDatasetTags, getDatasetSql, getDefaultDatasetSql, } from './sample-datasets';
+// Export keyboard shortcuts
+export { SHORTCUT_CATEGORIES, KEYBOARD_SHORTCUTS, detectPlatform, getEffectiveModifiers, formatShortcut, getShortcutsByCategory, getShortcutById, matchesShortcut, findMatchingShortcut, generateShortcutsReference, createShortcutHandler, } from './keyboard-shortcuts';
+//# sourceMappingURL=index.js.map

package/dist/playground/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/playground/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AAyCH,yBAAyB;AACzB,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAA0B,MAAM,cAAc,CAAA;AACnF,OAAO,EAAE,mBAAmB,EAAE,uBAAuB,EAAuC,MAAM,kBAAkB,CAAA;AACpH,OAAO,EAAE,qBAAqB,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AAC3E,OAAO,EAAE,oBAAoB,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AACxE,OAAO,EAAE,yBAAyB,EAAE,mBAAmB,EAAmC,MAAM,iBAAiB,CAAA;AAEjH,wBAAwB;AACxB,OAAO,EAIL,uBAAuB,EACvB,cAAc,EACd,oBAAoB,EACpB,sBAAsB,EACtB,oBAAoB,EACpB,aAAa,EACb,YAAY,GACb,MAAM,kBAAkB,CAAA;AAEzB,yBAAyB;AACzB,OAAO,EAEL,eAAe,EACf,YAAY,EACZ,iBAAiB,EACjB,UAAU,EACV,WAAW,EACX,cAAc,EACd,gBAAgB,EAChB,iBAAiB,EACjB,aAAa,EACb,oBAAoB,GACrB,MAAM,mBAAmB,CAAA;AAE1B,4BAA4B;AAC5B,OAAO,EAML,mBAAmB,EACnB,kBAAkB,EAClB,cAAc,EACd,qBAAqB,EACrB,cAAc,EACd,sBAAsB,EACtB,eAAe,EACf,eAAe,EACf,oBAAoB,EACpB,0BAA0B,EAC1B,qBAAqB,GACtB,MAAM,sBAAsB,CAAA"}

package/dist/playground/keyboard-shortcuts.d.ts

@@ -0,0 +1,116 @@
+/**
+ * Keyboard Shortcuts for Playground
+ *
+ * Defines keyboard shortcuts and their documentation for the interactive
+ * SQL playground. Provides a consistent keyboard interface for power users.
+ *
+ * @module playground/keyboard-shortcuts
+ */
+/**
+ * Minimal KeyboardEvent interface for non-DOM environments
+ * Used when DOM types are not available (e.g., Cloudflare Workers)
+ */
+interface KeyboardEvent {
+    code: string;
+    key: string;
+    ctrlKey: boolean;
+    metaKey: boolean;
+    altKey: boolean;
+    shiftKey: boolean;
+    preventDefault(): void;
+    stopPropagation(): void;
+}
+/**
+ * Modifier keys supported by the shortcut system
+ */
+export type ModifierKey = 'Ctrl' | 'Alt' | 'Shift' | 'Meta' | 'Cmd';
+/**
+ * A keyboard shortcut definition
+ */
+export interface KeyboardShortcut {
+    /** Unique identifier for the shortcut */
+    id: string;
+    /** Human-readable description of what the shortcut does */
+    description: string;
+    /** The key code (e.g., 'Enter', 'KeyS', 'F5') */
+    key: string;
+    /** Display string for the key (e.g., 'Enter', 'S', 'F5') */
+    keyDisplay: string;
+    /** Modifier keys required */
+    modifiers: ModifierKey[];
+    /** Category for grouping in documentation */
+    category: ShortcutCategory;
+    /** Whether this shortcut is enabled by default */
+    enabled: boolean;
+    /** Platform-specific overrides (Mac uses Cmd instead of Ctrl) */
+    platformOverrides?: {
+        mac?: {
+            modifiers: ModifierKey[];
+        };
+        windows?: {
+            modifiers: ModifierKey[];
+        };
+    };
+}
+/**
+ * Shortcut categories
+ */
+export type ShortcutCategory = 'execution' | 'editor' | 'navigation' | 'history' | 'results' | 'general';
+/**
+ * Category metadata for display
+ */
+export interface ShortcutCategoryInfo {
+    id: ShortcutCategory;
+    name: string;
+    description: string;
+}
+/**
+ * Category information
+ */
+export declare const SHORTCUT_CATEGORIES: ShortcutCategoryInfo[];
+/**
+ * All keyboard shortcuts
+ */
+export declare const KEYBOARD_SHORTCUTS: KeyboardShortcut[];
+/**
+ * Detect the current platform
+ */
+export declare function detectPlatform(): 'mac' | 'windows' | 'linux';
+/**
+ * Get the effective modifiers for a shortcut on the current platform
+ */
+export declare function getEffectiveModifiers(shortcut: KeyboardShortcut, platform?: 'mac' | 'windows' | 'linux'): ModifierKey[];
+/**
+ * Format a shortcut for display
+ */
+export declare function formatShortcut(shortcut: KeyboardShortcut, platform?: 'mac' | 'windows' | 'linux'): string;
+/**
+ * Get shortcuts by category
+ */
+export declare function getShortcutsByCategory(category: ShortcutCategory): KeyboardShortcut[];
+/**
+ * Get a shortcut by ID
+ */
+export declare function getShortcutById(id: string): KeyboardShortcut | undefined;
+/**
+ * Check if a keyboard event matches a shortcut
+ */
+export declare function matchesShortcut(event: KeyboardEvent, shortcut: KeyboardShortcut): boolean;
+/**
+ * Find which shortcut matches a keyboard event
+ */
+export declare function findMatchingShortcut(event: KeyboardEvent): KeyboardShortcut | undefined;
+/**
+ * Generate a printable keyboard shortcuts reference
+ */
+export declare function generateShortcutsReference(platform?: 'mac' | 'windows' | 'linux'): string;
+/**
+ * Type for shortcut handler callback
+ */
+export type ShortcutHandler = (shortcut: KeyboardShortcut, event: KeyboardEvent) => void | boolean;
+/**
+ * Create a keyboard shortcut handler that can be attached to a DOM element
+ */
+export declare function createShortcutHandler(handlers: Partial<Record<string, ShortcutHandler>>): (event: KeyboardEvent) => void;
+export {};
+//# sourceMappingURL=keyboard-shortcuts.d.ts.map

package/dist/playground/keyboard-shortcuts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyboard-shortcuts.d.ts","sourceRoot":"","sources":["../../src/playground/keyboard-shortcuts.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;;GAGG;AACH,UAAU,aAAa;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,EAAE,OAAO,CAAA;IACf,QAAQ,EAAE,OAAO,CAAA;IACjB,cAAc,IAAI,IAAI,CAAA;IACtB,eAAe,IAAI,IAAI,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,CAAA;AAEnE;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,yCAAyC;IACzC,EAAE,EAAE,MAAM,CAAA;IACV,2DAA2D;IAC3D,WAAW,EAAE,MAAM,CAAA;IACnB,iDAAiD;IACjD,GAAG,EAAE,MAAM,CAAA;IACX,4DAA4D;IAC5D,UAAU,EAAE,MAAM,CAAA;IAClB,6BAA6B;IAC7B,SAAS,EAAE,WAAW,EAAE,CAAA;IACxB,6CAA6C;IAC7C,QAAQ,EAAE,gBAAgB,CAAA;IAC1B,kDAAkD;IAClD,OAAO,EAAE,OAAO,CAAA;IAChB,iEAAiE;IACjE,iBAAiB,CAAC,EAAE;QAClB,GAAG,CAAC,EAAE;YAAE,SAAS,EAAE,WAAW,EAAE,CAAA;SAAE,CAAA;QAClC,OAAO,CAAC,EAAE;YAAE,SAAS,EAAE,WAAW,EAAE,CAAA;SAAE,CAAA;KACvC,CAAA;CACF;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GACxB,WAAW,GACX,QAAQ,GACR,YAAY,GACZ,SAAS,GACT,SAAS,GACT,SAAS,CAAA;AAEb;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,gBAAgB,CAAA;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;CACpB;AAED;;GAEG;AACH,eAAO,MAAM,mBAAmB,EAAE,oBAAoB,EA+BrD,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,kBAAkB,EAAE,gBAAgB,EAoahD,CAAA;AAED;;GAEG;AACH,wBAAgB,cAAc,IAAI,KAAK,GAAG,SAAS,GAAG,OAAO,CAO5D;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,gBAAgB,EAAE,QAAQ,CAAC,EAAE,KAAK,GAAG,SAAS,GAAG,OAAO,GAAG,WAAW,EAAE,CAIvH;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,QAAQ,EAAE,gBAAgB,EAAE,QAAQ,CAAC,EAAE,KAAK,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,CAwBzG;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,gBAAgB,EAAE,CAErF;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS,CAExE;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,gBAAgB,GAAG,OAAO,CAiBzF;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,aAAa,GAAG,gBAAgB,GAAG,SAAS,CAEvF;AAED;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,QAAQ,CAAC,EAAE,KAAK,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,CAoBzF;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,QAAQ,EAAE,gBAAgB,EAAE,KAAK,EAAE,aAAa,KAAK,IAAI,GAAG,OAAO,CAAA;AAElG;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,CAexH"}