@scalar/workspace-store 0.17.1 → 0.18.1

package/dist/navigation/helpers/traverse-webhooks.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/navigation/helpers/traverse-webhooks.ts"],
-  "sourcesContent": ["import type { HttpMethod } from '@scalar/helpers/http/http-methods'\nimport { isHttpMethod } from '@scalar/helpers/http/is-http-method'\nimport { objectKeys } from '@scalar/helpers/object/object-keys'\n\nimport { getResolvedRef } from '@/helpers/get-resolved-ref'\nimport { isDeprecatedOperation } from '@/navigation/helpers/traverse-paths'\nimport type { TagsMap, TraverseSpecOptions } from '@/navigation/types'\nimport type { TraversedWebhook } from '@/schemas/navigation'\nimport type { OpenApiDocument, TagObject } from '@/schemas/v3.1/strict/openapi-document'\n\nimport { getTag } from './get-tag'\n\n/** Creates a traversed webhook entry from an OpenAPI webhook object.\n *\n * @param ref - JSON pointer reference to the webhook in the OpenAPI document\n * @param method - HTTP method of the webhook\n * @param name - Name of the webhook, defaults to 'Unknown'\n * @param title - Title of the webhook, defaults to 'Unknown'\n * @param entitiesMap - Map to store webhook IDs and titles for mobile header navigation\n * @param getWebhookId - Function to generate unique IDs for webhooks\n * @param tag - Optional tag object associated with the webhook\n * @returns A traversed webhook entry with ID, title, name, method and reference\n */\nconst createWebhookEntry = (\n  ref: string,\n  method: HttpMethod,\n  name = 'Unknown',\n  title = 'Unknown',\n  getWebhookId: TraverseSpecOptions['getWebhookId'],\n  tag?: TagObject,\n  isDeprecated?: boolean,\n): TraversedWebhook => {\n  const id = getWebhookId({ name, method }, tag)\n\n  const entry = {\n    id,\n    title,\n    name,\n    ref,\n    method: method,\n    type: 'webhook',\n    isDeprecated,\n  } satisfies TraversedWebhook\n\n  return entry\n}\n\n/** Traverses the webhooks in an OpenAPI document to build an array of webhook entries.\n *\n * This function processes each webhook in the document to:\n * - Filter out internal webhooks (marked with x-internal) and webhooks to ignore (marked with x-scalar-ignore)\n * - Group webhooks by their tags\n * - Create webhook entries with unique references and IDs\n * - Store webhook IDs and titles for mobile header navigation\n *\n * @param content - The OpenAPI document to traverse\n * @param tagsMap - Map of tag names to arrays of traversed entries from operations\n * @param tagsDict - Dictionary mapping tag names to their OpenAPI tag objects\n * @param entitiesMap - Map to store webhook IDs and titles for mobile header navigation\n * @param getWebhookId - Function to generate unique IDs for webhooks\n * @returns Array of untagged webhook entries\n */\nexport const traverseWebhooks = (\n  content: OpenApiDocument,\n  /** The tag map from from traversing paths */\n  tagsMap: TagsMap,\n  getWebhookId: TraverseSpecOptions['getWebhookId'],\n): TraversedWebhook[] => {\n  const untagged: TraversedWebhook[] = []\n\n  // Traverse webhooks\n  Object.entries(content.webhooks ?? {}).forEach(([name, pathItemObject]) => {\n    const pathKeys = objectKeys(pathItemObject ?? {}).filter((key) => isHttpMethod(key))\n\n    pathKeys.forEach((method) => {\n      const _operation = pathItemObject?.[method]\n      const operation = getResolvedRef(_operation)\n      if (!operation) {\n        return\n      }\n\n      // Skip if the operation is internal or scalar-ignore\n      if (operation['x-internal'] || operation['x-scalar-ignore']) {\n        return\n      }\n\n      const ref = `#/webhooks/${name}/${method}`\n\n      if (operation.tags?.length) {\n        operation.tags.forEach((tagName: string) => {\n          const { tag } = getTag(tagsMap, tagName)\n          tagsMap\n            .get(tagName)\n            ?.entries.push(\n              createWebhookEntry(\n                ref,\n                method,\n                name,\n                operation.summary ?? name,\n                getWebhookId,\n                tag,\n                isDeprecatedOperation(operation),\n              ),\n            )\n        })\n      }\n      // Add to untagged\n      else {\n        untagged.push(\n          createWebhookEntry(\n            ref,\n            method,\n            name,\n            operation.summary ?? name,\n            getWebhookId,\n            undefined,\n            isDeprecatedOperation(operation),\n          ),\n        )\n      }\n    })\n  })\n\n  return untagged\n}\n"],
-  "mappings": "AACA,SAAS,oBAAoB;AAC7B,SAAS,kBAAkB;AAE3B,SAAS,sBAAsB;AAC/B,SAAS,6BAA6B;AAKtC,SAAS,cAAc;AAavB,MAAM,qBAAqB,CACzB,KACA,QACA,OAAO,WACP,QAAQ,WACR,cACA,KACA,iBACqB;AACrB,QAAM,KAAK,aAAa,EAAE,MAAM,OAAO,GAAG,GAAG;AAE7C,QAAM,QAAQ;AAAA,IACZ;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,MAAM;AAAA,IACN;AAAA,EACF;AAEA,SAAO;AACT;AAiBO,MAAM,mBAAmB,CAC9B,SAEA,SACA,iBACuB;AACvB,QAAM,WAA+B,CAAC;AAGtC,SAAO,QAAQ,QAAQ,YAAY,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,MAAM,cAAc,MAAM;AACzE,UAAM,WAAW,WAAW,kBAAkB,CAAC,CAAC,EAAE,OAAO,CAAC,QAAQ,aAAa,GAAG,CAAC;AAEnF,aAAS,QAAQ,CAAC,WAAW;AAC3B,YAAM,aAAa,iBAAiB,MAAM;AAC1C,YAAM,YAAY,eAAe,UAAU;AAC3C,UAAI,CAAC,WAAW;AACd;AAAA,MACF;AAGA,UAAI,UAAU,YAAY,KAAK,UAAU,iBAAiB,GAAG;AAC3D;AAAA,MACF;AAEA,YAAM,MAAM,cAAc,IAAI,IAAI,MAAM;AAExC,UAAI,UAAU,MAAM,QAAQ;AAC1B,kBAAU,KAAK,QAAQ,CAAC,YAAoB;AAC1C,gBAAM,EAAE,IAAI,IAAI,OAAO,SAAS,OAAO;AACvC,kBACG,IAAI,OAAO,GACV,QAAQ;AAAA,YACR;AAAA,cACE;AAAA,cACA;AAAA,cACA;AAAA,cACA,UAAU,WAAW;AAAA,cACrB;AAAA,cACA;AAAA,cACA,sBAAsB,SAAS;AAAA,YACjC;AAAA,UACF;AAAA,QACJ,CAAC;AAAA,MACH,OAEK;AACH,iBAAS;AAAA,UACP;AAAA,YACE;AAAA,YACA;AAAA,YACA;AAAA,YACA,UAAU,WAAW;AAAA,YACrB;AAAA,YACA;AAAA,YACA,sBAAsB,SAAS;AAAA,UACjC;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AAED,SAAO;AACT;",
+  "sourcesContent": ["import type { HttpMethod } from '@scalar/helpers/http/http-methods'\nimport { isHttpMethod } from '@scalar/helpers/http/is-http-method'\nimport { objectKeys } from '@scalar/helpers/object/object-keys'\n\nimport { getResolvedRef } from '@/helpers/get-resolved-ref'\nimport { isDeprecatedOperation } from '@/navigation/helpers/traverse-paths'\nimport type { TagsMap, TraverseSpecOptions } from '@/navigation/types'\nimport type { ParentTag, TraversedWebhook } from '@/schemas/navigation'\nimport type { OpenApiDocument, OperationObject, TagObject } from '@/schemas/v3.1/strict/openapi-document'\n\nimport { getTag } from './get-tag'\n\n/** Creates a traversed webhook entry from an OpenAPI webhook object.\n *\n * @param ref - JSON pointer reference to the webhook in the OpenAPI document\n * @param method - HTTP method of the webhook\n * @param name - Name of the webhook, defaults to 'Unknown'\n * @param title - Title of the webhook, defaults to 'Unknown'\n * @param entitiesMap - Map to store webhook IDs and titles for mobile header navigation\n * @param getWebhookId - Function to generate unique IDs for webhooks\n * @param tag - Optional tag object associated with the webhook\n * @returns A traversed webhook entry with ID, title, name, method and reference\n */\nconst createWebhookEntry = ({\n  ref,\n  method,\n  name,\n  title,\n  generateId,\n  parentTag,\n  webhook,\n  isDeprecated,\n  parentId,\n}: {\n  ref: string\n  method: HttpMethod\n  webhook: OperationObject\n  name: string\n  title: string\n  generateId: TraverseSpecOptions['generateId']\n  tag?: TagObject\n  parentId: string\n  parentTag?: ParentTag\n  isDeprecated?: boolean\n}): TraversedWebhook => {\n  const id = generateId({\n    type: 'webhook',\n    name,\n    method,\n    webhook: webhook,\n    parentTag,\n    parentId: parentId,\n  })\n\n  const entry = {\n    id,\n    title,\n    name,\n    ref,\n    method: method,\n    type: 'webhook',\n    isDeprecated,\n  } satisfies TraversedWebhook\n\n  return entry\n}\n\n/** Traverses the webhooks in an OpenAPI document to build an array of webhook entries.\n *\n * This function processes each webhook in the document to:\n * - Filter out internal webhooks (marked with x-internal) and webhooks to ignore (marked with x-scalar-ignore)\n * - Group webhooks by their tags\n * - Create webhook entries with unique references and IDs\n * - Store webhook IDs and titles for mobile header navigation\n *\n * @param content - The OpenAPI document to traverse\n * @param tagsMap - Map of tag names to arrays of traversed entries from operations\n * @param tagsDict - Dictionary mapping tag names to their OpenAPI tag objects\n * @param entitiesMap - Map to store webhook IDs and titles for mobile header navigation\n * @param getWebhookId - Function to generate unique IDs for webhooks\n * @returns Array of untagged webhook entries\n */\nexport const traverseWebhooks = ({\n  document,\n  tagsMap,\n  generateId,\n  untaggedWebhooksParentId,\n  documentId,\n}: {\n  /** Openapi document */\n  document: OpenApiDocument\n  /** The tag map from from traversing paths */\n  tagsMap: TagsMap\n  generateId: TraverseSpecOptions['generateId']\n  untaggedWebhooksParentId: string\n  documentId: string\n}): TraversedWebhook[] => {\n  const untagged: TraversedWebhook[] = []\n\n  // Traverse webhooks\n  Object.entries(document.webhooks ?? {}).forEach(([name, pathItemObject]) => {\n    const pathKeys = objectKeys(pathItemObject ?? {}).filter((key) => isHttpMethod(key))\n\n    pathKeys.forEach((method) => {\n      const _operation = pathItemObject?.[method]\n      const operation = getResolvedRef(_operation)\n      if (!operation) {\n        return\n      }\n\n      // Skip if the operation is internal or scalar-ignore\n      if (operation['x-internal'] || operation['x-scalar-ignore']) {\n        return\n      }\n\n      const ref = `#/webhooks/${name}/${method}`\n\n      if (operation.tags?.length) {\n        operation.tags.forEach((tagName: string) => {\n          const { tag, id: tagId } = getTag({ tagsMap, name: tagName, documentId, generateId })\n          tagsMap.get(tagName)?.entries.push(\n            createWebhookEntry({\n              ref,\n              method,\n              name,\n              title: operation.summary ?? name,\n              webhook: operation,\n              generateId: generateId,\n              parentTag: { tag, id: tagId },\n              parentId: tagId,\n              isDeprecated: isDeprecatedOperation(operation),\n            }),\n          )\n        })\n      }\n      // Add to untagged\n      else {\n        untagged.push(\n          createWebhookEntry({\n            ref,\n            method,\n            name,\n            title: operation.summary ?? name,\n            generateId,\n            isDeprecated: isDeprecatedOperation(operation),\n            webhook: operation,\n            parentId: untaggedWebhooksParentId,\n          }),\n        )\n      }\n    })\n  })\n\n  return untagged\n}\n"],
+  "mappings": "AACA,SAAS,oBAAoB;AAC7B,SAAS,kBAAkB;AAE3B,SAAS,sBAAsB;AAC/B,SAAS,6BAA6B;AAKtC,SAAS,cAAc;AAavB,MAAM,qBAAqB,CAAC;AAAA,EAC1B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,MAWwB;AACtB,QAAM,KAAK,WAAW;AAAA,IACpB,MAAM;AAAA,IACN;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AAED,QAAM,QAAQ;AAAA,IACZ;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,MAAM;AAAA,IACN;AAAA,EACF;AAEA,SAAO;AACT;AAiBO,MAAM,mBAAmB,CAAC;AAAA,EAC/B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,MAQ0B;AACxB,QAAM,WAA+B,CAAC;AAGtC,SAAO,QAAQ,SAAS,YAAY,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,MAAM,cAAc,MAAM;AAC1E,UAAM,WAAW,WAAW,kBAAkB,CAAC,CAAC,EAAE,OAAO,CAAC,QAAQ,aAAa,GAAG,CAAC;AAEnF,aAAS,QAAQ,CAAC,WAAW;AAC3B,YAAM,aAAa,iBAAiB,MAAM;AAC1C,YAAM,YAAY,eAAe,UAAU;AAC3C,UAAI,CAAC,WAAW;AACd;AAAA,MACF;AAGA,UAAI,UAAU,YAAY,KAAK,UAAU,iBAAiB,GAAG;AAC3D;AAAA,MACF;AAEA,YAAM,MAAM,cAAc,IAAI,IAAI,MAAM;AAExC,UAAI,UAAU,MAAM,QAAQ;AAC1B,kBAAU,KAAK,QAAQ,CAAC,YAAoB;AAC1C,gBAAM,EAAE,KAAK,IAAI,MAAM,IAAI,OAAO,EAAE,SAAS,MAAM,SAAS,YAAY,WAAW,CAAC;AACpF,kBAAQ,IAAI,OAAO,GAAG,QAAQ;AAAA,YAC5B,mBAAmB;AAAA,cACjB;AAAA,cACA;AAAA,cACA;AAAA,cACA,OAAO,UAAU,WAAW;AAAA,cAC5B,SAAS;AAAA,cACT;AAAA,cACA,WAAW,EAAE,KAAK,IAAI,MAAM;AAAA,cAC5B,UAAU;AAAA,cACV,cAAc,sBAAsB,SAAS;AAAA,YAC/C,CAAC;AAAA,UACH;AAAA,QACF,CAAC;AAAA,MACH,OAEK;AACH,iBAAS;AAAA,UACP,mBAAmB;AAAA,YACjB;AAAA,YACA;AAAA,YACA;AAAA,YACA,OAAO,UAAU,WAAW;AAAA,YAC5B;AAAA,YACA,cAAc,sBAAsB,SAAS;AAAA,YAC7C,SAAS;AAAA,YACT,UAAU;AAAA,UACZ,CAAC;AAAA,QACH;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AAED,SAAO;AACT;",
   "names": []
 }

package/dist/navigation/types.d.ts

@@ -1,7 +1,9 @@
-import type { TraversedEntry } from '../schemas/navigation.js';
-import type { OperationObject, TagObject } from '../schemas/v3.1/strict/openapi-document.js';
+import type { IdGenerator, TraversedEntry } from '../schemas/navigation.js';
+import type { TagObject } from '../schemas/v3.1/strict/openapi-document.js';
 /** Map of tagNames and their entries */
 export type TagsMap = Map<string, {
+    id: string;
+    parentId: string;
     tag: TagObject;
     entries: TraversedEntry[];
 }>;
@@ -26,28 +28,7 @@ export type TraverseSpecOptions = {
     operationsSorter?: 'alpha' | 'method' | ((a: OperationSortValue, b: OperationSortValue) => number);
     /** Whether to hide model schemas from the navigation */
     hideModels: boolean;
-    /** Function to generate unique IDs for markdown headings */
-    getHeadingId: (heading: {
-        depth: number;
-        value: string;
-        slug?: string;
-    }) => string;
-    /** Function to generate unique IDs for operations */
-    getOperationId: (operation: {
-        path: string;
-        method: string;
-    } & OperationObject, parentTag: TagObject) => string;
-    /** Function to generate unique IDs for webhooks */
-    getWebhookId: (webhook: {
-        name: string;
-        method?: string;
-    }, parentTag?: TagObject) => string;
-    /** Function to generate unique IDs for models/schemas */
-    getModelId: (model: {
-        name?: string;
-    }, parentTag?: TagObject) => string;
-    /** Function to generate unique IDs for tags */
-    getTagId: (tag: TagObject) => string;
+    generateId: IdGenerator;
 };
 export type Heading = {
     depth: number;

package/dist/navigation/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/navigation/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC1D,OAAO,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,wCAAwC,CAAA;AACxF,wCAAwC;AACxC,MAAM,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,EAAE;IAAE,GAAG,EAAE,SAAS,CAAC;IAAC,OAAO,EAAE,cAAc,EAAE,CAAA;CAAE,CAAC,CAAA;AAEhF,KAAK,kBAAkB,GAAG;IACxB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,qCAAqC;IACrC,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,2FAA2F;IAC3F,UAAU,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,KAAK,MAAM,CAAC,CAAA;IAE/D,sGAAsG;IACtG,gBAAgB,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,CAAC,EAAE,kBAAkB,KAAK,MAAM,CAAC,CAAA;IAElG,wDAAwD;IACxD,UAAU,EAAE,OAAO,CAAA;IAEnB,4DAA4D;IAC5D,YAAY,EAAE,CAAC,OAAO,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM,CAAA;IAElF,qDAAqD;IACrD,cAAc,EAAE,CACd,SAAS,EAAE;QACT,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,EAAE,MAAM,CAAA;KACf,GAAG,eAAe,EACnB,SAAS,EAAE,SAAS,KACjB,MAAM,CAAA;IAEX,mDAAmD;IACnD,YAAY,EAAE,CACZ,OAAO,EAAE;QACP,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,EACD,SAAS,CAAC,EAAE,SAAS,KAClB,MAAM,CAAA;IAEX,yDAAyD;IACzD,UAAU,EAAE,CACV,KAAK,EAAE;QACL,IAAI,CAAC,EAAE,MAAM,CAAA;KACd,EACD,SAAS,CAAC,EAAE,SAAS,KAClB,MAAM,CAAA;IAEX,+CAA+C;IAC/C,QAAQ,EAAE,CAAC,GAAG,EAAE,SAAS,KAAK,MAAM,CAAA;CACrC,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/navigation/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACvE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wCAAwC,CAAA;AAEvE,wCAAwC;AACxC,MAAM,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,EAAE;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,SAAS,CAAC;IAAC,OAAO,EAAE,cAAc,EAAE,CAAA;CAAE,CAAC,CAAA;AAE9G,KAAK,kBAAkB,GAAG;IACxB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,qCAAqC;IACrC,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,2FAA2F;IAC3F,UAAU,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,KAAK,MAAM,CAAC,CAAA;IAE/D,sGAAsG;IACtG,gBAAgB,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,CAAC,EAAE,kBAAkB,KAAK,MAAM,CAAC,CAAA;IAElG,wDAAwD;IACxD,UAAU,EAAE,OAAO,CAAA;IAEnB,UAAU,EAAE,WAAW,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,CAAA"}

package/dist/persistence/index.d.ts

@@ -0,0 +1,86 @@
+import type { InMemoryWorkspace } from '../schemas/inmemory-workspace.js';
+import type { WorkspaceMeta } from '../schemas/workspace.js';
+type WorkspaceStoreShape = {
+    name: string;
+    workspace: InMemoryWorkspace;
+};
+/**
+ * Creates the persistence layer for the workspace store using IndexedDB.
+ * This sets up all the required tables for storing workspace chunk information,
+ * such as workspace meta, documents, original documents, intermediate documents, overrides, etc.
+ * Each logical group (meta, documents, etc) gets its own table keyed appropriately for efficient sub-document access.
+ * Returns an object containing `meta`, `documents`, `originalDocuments`, `intermediateDocuments`, `overrides`,
+ * `documentMeta`, `documentConfigs`, and `workspace` sections, each exposing a `setItem` method
+ * for upsetting records, and in the case of `workspace`, also `getItem` and `deleteItem`.
+ */
+export declare const createWorkspaceStorePersistence: () => Promise<{
+    close: () => void;
+    meta: {
+        /**
+         * Set meta data for a workspace.
+         */
+        setItem: (workspaceId: string, data: WorkspaceMeta) => Promise<void>;
+    };
+    documents: {
+        /**
+         * Set (persist) a workspace document using workspaceId and documentName as composite key.
+         */
+        setItem: (workspaceId: string, documentName: string, data: InMemoryWorkspace["documents"][string]) => Promise<void>;
+    };
+    originalDocuments: {
+        /**
+         * Set an original (raw) document for a workspace/document pair.
+         */
+        setItem: (workspaceId: string, documentName: string, data: InMemoryWorkspace["originalDocuments"][string]) => Promise<void>;
+    };
+    intermediateDocuments: {
+        /**
+         * Set an intermediate (transformed) document for a workspace/document pair.
+         */
+        setItem: (workspaceId: string, documentName: string, data: InMemoryWorkspace["intermediateDocuments"][string]) => Promise<void>;
+    };
+    overrides: {
+        /**
+         * Set document overrides for a workspace/document pair.
+         */
+        setItem: (workspaceId: string, documentName: string, data: InMemoryWorkspace["overrides"][string]) => Promise<void>;
+    };
+    documentConfigs: {
+        /**
+         * Set configuration for a document in a workspace.
+         */
+        setItem: (workspaceId: string, documentName: string, data: InMemoryWorkspace["documentConfigs"][string]) => Promise<void>;
+    };
+    workspace: {
+        /**
+         * Retrieves a workspace by its ID.
+         * Returns undefined if the workspace does not exist.
+         * Gathers all workspace 'chunk' tables and assembles a full workspace shape.
+         */
+        getItem: (id: string) => Promise<(WorkspaceStoreShape & {
+            id: string;
+        }) | undefined>;
+        /**
+         * Retrieves all workspaces from the database.
+         * Returns only the workspace ID and name for each workspace.
+         * To get the full workspace data including documents and metadata, use getItem() with a specific ID.
+         * Returns an empty array if no workspaces exist.
+         */
+        getAll: () => Promise<{
+            name: string;
+            id: string;
+        }[]>;
+        /**
+         * Saves a workspace to the database.
+         * All chunks (meta, documents, configs, etc.) are upsert in their respective tables.
+         * If a workspace with the same ID already exists, it will be replaced.
+         */
+        setItem: (id: string, value: WorkspaceStoreShape) => Promise<void>;
+        /**
+         * Deletes an entire workspace and all associated chunk records from all tables by ID.
+         */
+        deleteItem: (id: string) => Promise<void>;
+    };
+}>;
+export {};
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/persistence/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAA;AACrE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAExD,KAAK,mBAAmB,GAAG;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,iBAAiB,CAAA;CAC7B,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,+BAA+B;;;QAoDtC;;WAEG;+BAC0B,MAAM,QAAQ,aAAa;;;QAKxD;;WAEG;+BAC0B,MAAM,gBAAgB,MAAM,QAAQ,iBAAiB,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC;;;QAKvG;;WAEG;+BAEY,MAAM,gBACL,MAAM,QACd,iBAAiB,CAAC,mBAAmB,CAAC,CAAC,MAAM,CAAC;;;QAMtD;;WAEG;+BAEY,MAAM,gBACL,MAAM,QACd,iBAAiB,CAAC,uBAAuB,CAAC,CAAC,MAAM,CAAC;;;QAM1D;;WAEG;+BAC0B,MAAM,gBAAgB,MAAM,QAAQ,iBAAiB,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC;;;QAKvG;;WAEG;+BAEY,MAAM,gBACL,MAAM,QACd,iBAAiB,CAAC,iBAAiB,CAAC,CAAC,MAAM,CAAC;;;QAMpD;;;;WAIG;sBACiB,MAAM,KAAG,OAAO,CAAC,CAAC,mBAAmB,GAAG;YAAE,EAAE,EAAE,MAAM,CAAA;SAAE,CAAC,GAAG,SAAS,CAAC;QAkCxF;;;;;WAKG;;;;;QAKH;;;;WAIG;sBACiB,MAAM,SAAS,mBAAmB,KAAG,OAAO,CAAC,IAAI,CAAC;QA0CtE;;WAEG;yBACoB,MAAM,KAAG,OAAO,CAAC,IAAI,CAAC;;EAkBlD,CAAA"}

package/dist/persistence/index.js

@@ -0,0 +1,196 @@
+import { Type } from "@scalar/typebox";
+import { createIndexDbConnection } from "../persistence/indexdb.js";
+const createWorkspaceStorePersistence = async () => {
+  const connection = await createIndexDbConnection({
+    name: "scalar-workspace-store",
+    version: 1,
+    tables: {
+      workspace: {
+        schema: Type.Object({ id: Type.String(), name: Type.String() }),
+        index: ["id"]
+      },
+      meta: {
+        schema: Type.Object({ workspaceId: Type.String(), data: Type.Any() }),
+        index: ["workspaceId"]
+      },
+      documents: {
+        schema: Type.Object({ workspaceId: Type.String(), documentName: Type.String(), data: Type.Any() }),
+        index: ["workspaceId", "documentName"]
+      },
+      originalDocuments: {
+        schema: Type.Object({ workspaceId: Type.String(), documentName: Type.String(), data: Type.Any() }),
+        index: ["workspaceId", "documentName"]
+      },
+      intermediateDocuments: {
+        schema: Type.Object({ workspaceId: Type.String(), documentName: Type.String(), data: Type.Any() }),
+        index: ["workspaceId", "documentName"]
+      },
+      overrides: {
+        schema: Type.Object({ workspaceId: Type.String(), documentName: Type.String(), data: Type.Any() }),
+        index: ["workspaceId", "documentName"]
+      },
+      documentConfigs: {
+        schema: Type.Object({ workspaceId: Type.String(), documentName: Type.String(), data: Type.Any() }),
+        index: ["workspaceId", "documentName"]
+      }
+    }
+  });
+  const workspaceTable = connection.get("workspace");
+  const metaTable = connection.get("meta");
+  const documentsTable = connection.get("documents");
+  const originalDocumentTable = connection.get("originalDocuments");
+  const intermediateDocumentTable = connection.get("intermediateDocuments");
+  const overridesTable = connection.get("overrides");
+  const documentConfigsTable = connection.get("documentConfigs");
+  return {
+    close: () => {
+      connection.closeDatabase();
+    },
+    meta: {
+      /**
+       * Set meta data for a workspace.
+       */
+      setItem: async (workspaceId, data) => {
+        await metaTable.addItem({ workspaceId }, { data });
+      }
+    },
+    documents: {
+      /**
+       * Set (persist) a workspace document using workspaceId and documentName as composite key.
+       */
+      setItem: async (workspaceId, documentName, data) => {
+        await documentsTable.addItem({ workspaceId, documentName }, { data });
+      }
+    },
+    originalDocuments: {
+      /**
+       * Set an original (raw) document for a workspace/document pair.
+       */
+      setItem: async (workspaceId, documentName, data) => {
+        await originalDocumentTable.addItem({ workspaceId, documentName }, { data });
+      }
+    },
+    intermediateDocuments: {
+      /**
+       * Set an intermediate (transformed) document for a workspace/document pair.
+       */
+      setItem: async (workspaceId, documentName, data) => {
+        await intermediateDocumentTable.addItem({ workspaceId, documentName }, { data });
+      }
+    },
+    overrides: {
+      /**
+       * Set document overrides for a workspace/document pair.
+       */
+      setItem: async (workspaceId, documentName, data) => {
+        await overridesTable.addItem({ workspaceId, documentName }, { data });
+      }
+    },
+    documentConfigs: {
+      /**
+       * Set configuration for a document in a workspace.
+       */
+      setItem: async (workspaceId, documentName, data) => {
+        await documentConfigsTable.addItem({ workspaceId, documentName }, { data });
+      }
+    },
+    workspace: {
+      /**
+       * Retrieves a workspace by its ID.
+       * Returns undefined if the workspace does not exist.
+       * Gathers all workspace 'chunk' tables and assembles a full workspace shape.
+       */
+      getItem: async (id) => {
+        const workspace = await workspaceTable.getItem({ id });
+        if (!workspace) {
+          return void 0;
+        }
+        const workspaceDocuments = await documentsTable.getRange([id]);
+        const workspaceOriginalDocuments = await originalDocumentTable.getRange([id]);
+        const workspaceIntermediateDocuments = await intermediateDocumentTable.getRange([id]);
+        const workspaceOverrides = await overridesTable.getRange([id]);
+        const workspaceMeta = await metaTable.getItem({ workspaceId: id });
+        const workspaceDocumentConfigs = await documentConfigsTable.getRange([id]);
+        return {
+          id,
+          name: workspace.name,
+          workspace: {
+            documents: Object.fromEntries(workspaceDocuments.map((item) => [item.documentName, item.data])),
+            originalDocuments: Object.fromEntries(
+              workspaceOriginalDocuments.map((item) => [item.documentName, item.data])
+            ),
+            intermediateDocuments: Object.fromEntries(
+              workspaceIntermediateDocuments.map((item) => [item.documentName, item.data])
+            ),
+            overrides: Object.fromEntries(workspaceOverrides.map((item) => [item.documentName, item.data])),
+            meta: workspaceMeta?.data,
+            documentConfigs: Object.fromEntries(workspaceDocumentConfigs.map((item) => [item.documentName, item.data]))
+          }
+        };
+      },
+      /**
+       * Retrieves all workspaces from the database.
+       * Returns only the workspace ID and name for each workspace.
+       * To get the full workspace data including documents and metadata, use getItem() with a specific ID.
+       * Returns an empty array if no workspaces exist.
+       */
+      getAll: async () => {
+        return await workspaceTable.getAll();
+      },
+      /**
+       * Saves a workspace to the database.
+       * All chunks (meta, documents, configs, etc.) are upsert in their respective tables.
+       * If a workspace with the same ID already exists, it will be replaced.
+       */
+      setItem: async (id, value) => {
+        await workspaceTable.addItem({ id }, { name: value.name });
+        await metaTable.addItem({ workspaceId: id }, { data: value.workspace.meta });
+        await Promise.all(
+          Object.entries(value.workspace.documents ?? {}).map(([name, data]) => {
+            return documentsTable.addItem({ workspaceId: id, documentName: name }, { data });
+          })
+        );
+        await Promise.all(
+          Object.entries(value.workspace.originalDocuments ?? {}).map(([name, data]) => {
+            return originalDocumentTable.addItem({ workspaceId: id, documentName: name }, { data });
+          })
+        );
+        await Promise.all(
+          Object.entries(value.workspace.intermediateDocuments ?? {}).map(([name, data]) => {
+            return intermediateDocumentTable.addItem({ workspaceId: id, documentName: name }, { data });
+          })
+        );
+        await Promise.all(
+          Object.entries(value.workspace.overrides ?? {}).map(([name, data]) => {
+            return overridesTable.addItem({ workspaceId: id, documentName: name }, { data });
+          })
+        );
+        await Promise.all(
+          Object.entries(value.workspace.documentConfigs ?? {}).map(([name, data]) => {
+            return documentConfigsTable.addItem({ workspaceId: id, documentName: name }, { data });
+          })
+        );
+      },
+      /**
+       * Deletes an entire workspace and all associated chunk records from all tables by ID.
+       */
+      deleteItem: async (id) => {
+        await workspaceTable.deleteItem({ id });
+        await Promise.all([
+          // By id
+          metaTable.deleteItem({ workspaceId: id }),
+          // By range (composite-key tables)
+          documentsTable.deleteRange([id]),
+          originalDocumentTable.deleteRange([id]),
+          intermediateDocumentTable.deleteRange([id]),
+          overridesTable.deleteRange([id]),
+          documentConfigsTable.deleteRange([id])
+        ]);
+      }
+    }
+  };
+};
+export {
+  createWorkspaceStorePersistence
+};
+//# sourceMappingURL=index.js.map

package/dist/persistence/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/persistence/index.ts"],
+  "sourcesContent": ["import { Type } from '@scalar/typebox'\n\nimport { createIndexDbConnection } from '@/persistence/indexdb'\nimport type { InMemoryWorkspace } from '@/schemas/inmemory-workspace'\nimport type { WorkspaceMeta } from '@/schemas/workspace'\n\ntype WorkspaceStoreShape = {\n  name: string\n  workspace: InMemoryWorkspace\n}\n\n/**\n * Creates the persistence layer for the workspace store using IndexedDB.\n * This sets up all the required tables for storing workspace chunk information,\n * such as workspace meta, documents, original documents, intermediate documents, overrides, etc.\n * Each logical group (meta, documents, etc) gets its own table keyed appropriately for efficient sub-document access.\n * Returns an object containing `meta`, `documents`, `originalDocuments`, `intermediateDocuments`, `overrides`,\n * `documentMeta`, `documentConfigs`, and `workspace` sections, each exposing a `setItem` method\n * for upsetting records, and in the case of `workspace`, also `getItem` and `deleteItem`.\n */\nexport const createWorkspaceStorePersistence = async () => {\n  // Create the database connection and setup all required tables for workspace storage.\n  const connection = await createIndexDbConnection({\n    name: 'scalar-workspace-store',\n    version: 1,\n    tables: {\n      workspace: {\n        schema: Type.Object({ id: Type.String(), name: Type.String() }),\n        index: ['id'],\n      },\n      meta: {\n        schema: Type.Object({ workspaceId: Type.String(), data: Type.Any() }),\n        index: ['workspaceId'],\n      },\n      documents: {\n        schema: Type.Object({ workspaceId: Type.String(), documentName: Type.String(), data: Type.Any() }),\n        index: ['workspaceId', 'documentName'],\n      },\n      originalDocuments: {\n        schema: Type.Object({ workspaceId: Type.String(), documentName: Type.String(), data: Type.Any() }),\n        index: ['workspaceId', 'documentName'],\n      },\n      intermediateDocuments: {\n        schema: Type.Object({ workspaceId: Type.String(), documentName: Type.String(), data: Type.Any() }),\n        index: ['workspaceId', 'documentName'],\n      },\n      overrides: {\n        schema: Type.Object({ workspaceId: Type.String(), documentName: Type.String(), data: Type.Any() }),\n        index: ['workspaceId', 'documentName'],\n      },\n      documentConfigs: {\n        schema: Type.Object({ workspaceId: Type.String(), documentName: Type.String(), data: Type.Any() }),\n        index: ['workspaceId', 'documentName'],\n      },\n    },\n  })\n\n  // Tables wrappers for each logical section.\n  const workspaceTable = connection.get('workspace')\n  const metaTable = connection.get('meta')\n  const documentsTable = connection.get('documents')\n  const originalDocumentTable = connection.get('originalDocuments')\n  const intermediateDocumentTable = connection.get('intermediateDocuments')\n  const overridesTable = connection.get('overrides')\n  const documentConfigsTable = connection.get('documentConfigs')\n\n  // The returned persistence API with logical sections for each table and mapping.\n  return {\n    close: () => {\n      connection.closeDatabase()\n    },\n    meta: {\n      /**\n       * Set meta data for a workspace.\n       */\n      setItem: async (workspaceId: string, data: WorkspaceMeta) => {\n        await metaTable.addItem({ workspaceId }, { data })\n      },\n    },\n    documents: {\n      /**\n       * Set (persist) a workspace document using workspaceId and documentName as composite key.\n       */\n      setItem: async (workspaceId: string, documentName: string, data: InMemoryWorkspace['documents'][string]) => {\n        await documentsTable.addItem({ workspaceId, documentName }, { data })\n      },\n    },\n    originalDocuments: {\n      /**\n       * Set an original (raw) document for a workspace/document pair.\n       */\n      setItem: async (\n        workspaceId: string,\n        documentName: string,\n        data: InMemoryWorkspace['originalDocuments'][string],\n      ) => {\n        await originalDocumentTable.addItem({ workspaceId, documentName }, { data })\n      },\n    },\n    intermediateDocuments: {\n      /**\n       * Set an intermediate (transformed) document for a workspace/document pair.\n       */\n      setItem: async (\n        workspaceId: string,\n        documentName: string,\n        data: InMemoryWorkspace['intermediateDocuments'][string],\n      ) => {\n        await intermediateDocumentTable.addItem({ workspaceId, documentName }, { data })\n      },\n    },\n    overrides: {\n      /**\n       * Set document overrides for a workspace/document pair.\n       */\n      setItem: async (workspaceId: string, documentName: string, data: InMemoryWorkspace['overrides'][string]) => {\n        await overridesTable.addItem({ workspaceId, documentName }, { data })\n      },\n    },\n    documentConfigs: {\n      /**\n       * Set configuration for a document in a workspace.\n       */\n      setItem: async (\n        workspaceId: string,\n        documentName: string,\n        data: InMemoryWorkspace['documentConfigs'][string],\n      ) => {\n        await documentConfigsTable.addItem({ workspaceId, documentName }, { data })\n      },\n    },\n    workspace: {\n      /**\n       * Retrieves a workspace by its ID.\n       * Returns undefined if the workspace does not exist.\n       * Gathers all workspace 'chunk' tables and assembles a full workspace shape.\n       */\n      getItem: async (id: string): Promise<(WorkspaceStoreShape & { id: string }) | undefined> => {\n        const workspace = await workspaceTable.getItem({ id })\n\n        if (!workspace) {\n          return undefined\n        }\n\n        // Retrieve all chunk records for this workspace.\n        const workspaceDocuments = await documentsTable.getRange([id])\n        const workspaceOriginalDocuments = await originalDocumentTable.getRange([id])\n        const workspaceIntermediateDocuments = await intermediateDocumentTable.getRange([id])\n        const workspaceOverrides = await overridesTable.getRange([id])\n        const workspaceMeta = await metaTable.getItem({ workspaceId: id })\n        const workspaceDocumentConfigs = await documentConfigsTable.getRange([id])\n\n        // Compose the workspace structure from table records.\n        return {\n          id,\n          name: workspace.name,\n          workspace: {\n            documents: Object.fromEntries(workspaceDocuments.map((item) => [item.documentName, item.data])),\n            originalDocuments: Object.fromEntries(\n              workspaceOriginalDocuments.map((item) => [item.documentName, item.data]),\n            ),\n            intermediateDocuments: Object.fromEntries(\n              workspaceIntermediateDocuments.map((item) => [item.documentName, item.data]),\n            ),\n            overrides: Object.fromEntries(workspaceOverrides.map((item) => [item.documentName, item.data])),\n            meta: workspaceMeta?.data,\n            documentConfigs: Object.fromEntries(workspaceDocumentConfigs.map((item) => [item.documentName, item.data])),\n          },\n        }\n      },\n\n      /**\n       * Retrieves all workspaces from the database.\n       * Returns only the workspace ID and name for each workspace.\n       * To get the full workspace data including documents and metadata, use getItem() with a specific ID.\n       * Returns an empty array if no workspaces exist.\n       */\n      getAll: async () => {\n        return await workspaceTable.getAll()\n      },\n\n      /**\n       * Saves a workspace to the database.\n       * All chunks (meta, documents, configs, etc.) are upsert in their respective tables.\n       * If a workspace with the same ID already exists, it will be replaced.\n       */\n      setItem: async (id: string, value: WorkspaceStoreShape): Promise<void> => {\n        await workspaceTable.addItem({ id }, { name: value.name })\n\n        // Save all meta info for workspace.\n        await metaTable.addItem({ workspaceId: id }, { data: value.workspace.meta })\n\n        // Persist all workspace documents (chunks).\n        await Promise.all(\n          Object.entries(value.workspace.documents ?? {}).map(([name, data]) => {\n            return documentsTable.addItem({ workspaceId: id, documentName: name }, { data })\n          }),\n        )\n\n        // Persist all original documents.\n        await Promise.all(\n          Object.entries(value.workspace.originalDocuments ?? {}).map(([name, data]) => {\n            return originalDocumentTable.addItem({ workspaceId: id, documentName: name }, { data })\n          }),\n        )\n\n        // Persist all intermediate documents.\n        await Promise.all(\n          Object.entries(value.workspace.intermediateDocuments ?? {}).map(([name, data]) => {\n            return intermediateDocumentTable.addItem({ workspaceId: id, documentName: name }, { data })\n          }),\n        )\n\n        // Persist all document overrides.\n        await Promise.all(\n          Object.entries(value.workspace.overrides ?? {}).map(([name, data]) => {\n            return overridesTable.addItem({ workspaceId: id, documentName: name }, { data })\n          }),\n        )\n\n        // Persist all document configs.\n        await Promise.all(\n          Object.entries(value.workspace.documentConfigs ?? {}).map(([name, data]) => {\n            return documentConfigsTable.addItem({ workspaceId: id, documentName: name }, { data })\n          }),\n        )\n      },\n\n      /**\n       * Deletes an entire workspace and all associated chunk records from all tables by ID.\n       */\n      deleteItem: async (id: string): Promise<void> => {\n        await workspaceTable.deleteItem({ id })\n\n        // Remove all workspace-related records from all chunk tables.\n        await Promise.all([\n          // By id\n          metaTable.deleteItem({ workspaceId: id }),\n\n          // By range (composite-key tables)\n          documentsTable.deleteRange([id]),\n          originalDocumentTable.deleteRange([id]),\n          intermediateDocumentTable.deleteRange([id]),\n          overridesTable.deleteRange([id]),\n          documentConfigsTable.deleteRange([id]),\n        ])\n      },\n    },\n  }\n}\n"],
+  "mappings": "AAAA,SAAS,YAAY;AAErB,SAAS,+BAA+B;AAkBjC,MAAM,kCAAkC,YAAY;AAEzD,QAAM,aAAa,MAAM,wBAAwB;AAAA,IAC/C,MAAM;AAAA,IACN,SAAS;AAAA,IACT,QAAQ;AAAA,MACN,WAAW;AAAA,QACT,QAAQ,KAAK,OAAO,EAAE,IAAI,KAAK,OAAO,GAAG,MAAM,KAAK,OAAO,EAAE,CAAC;AAAA,QAC9D,OAAO,CAAC,IAAI;AAAA,MACd;AAAA,MACA,MAAM;AAAA,QACJ,QAAQ,KAAK,OAAO,EAAE,aAAa,KAAK,OAAO,GAAG,MAAM,KAAK,IAAI,EAAE,CAAC;AAAA,QACpE,OAAO,CAAC,aAAa;AAAA,MACvB;AAAA,MACA,WAAW;AAAA,QACT,QAAQ,KAAK,OAAO,EAAE,aAAa,KAAK,OAAO,GAAG,cAAc,KAAK,OAAO,GAAG,MAAM,KAAK,IAAI,EAAE,CAAC;AAAA,QACjG,OAAO,CAAC,eAAe,cAAc;AAAA,MACvC;AAAA,MACA,mBAAmB;AAAA,QACjB,QAAQ,KAAK,OAAO,EAAE,aAAa,KAAK,OAAO,GAAG,cAAc,KAAK,OAAO,GAAG,MAAM,KAAK,IAAI,EAAE,CAAC;AAAA,QACjG,OAAO,CAAC,eAAe,cAAc;AAAA,MACvC;AAAA,MACA,uBAAuB;AAAA,QACrB,QAAQ,KAAK,OAAO,EAAE,aAAa,KAAK,OAAO,GAAG,cAAc,KAAK,OAAO,GAAG,MAAM,KAAK,IAAI,EAAE,CAAC;AAAA,QACjG,OAAO,CAAC,eAAe,cAAc;AAAA,MACvC;AAAA,MACA,WAAW;AAAA,QACT,QAAQ,KAAK,OAAO,EAAE,aAAa,KAAK,OAAO,GAAG,cAAc,KAAK,OAAO,GAAG,MAAM,KAAK,IAAI,EAAE,CAAC;AAAA,QACjG,OAAO,CAAC,eAAe,cAAc;AAAA,MACvC;AAAA,MACA,iBAAiB;AAAA,QACf,QAAQ,KAAK,OAAO,EAAE,aAAa,KAAK,OAAO,GAAG,cAAc,KAAK,OAAO,GAAG,MAAM,KAAK,IAAI,EAAE,CAAC;AAAA,QACjG,OAAO,CAAC,eAAe,cAAc;AAAA,MACvC;AAAA,IACF;AAAA,EACF,CAAC;AAGD,QAAM,iBAAiB,WAAW,IAAI,WAAW;AACjD,QAAM,YAAY,WAAW,IAAI,MAAM;AACvC,QAAM,iBAAiB,WAAW,IAAI,WAAW;AACjD,QAAM,wBAAwB,WAAW,IAAI,mBAAmB;AAChE,QAAM,4BAA4B,WAAW,IAAI,uBAAuB;AACxE,QAAM,iBAAiB,WAAW,IAAI,WAAW;AACjD,QAAM,uBAAuB,WAAW,IAAI,iBAAiB;AAG7D,SAAO;AAAA,IACL,OAAO,MAAM;AACX,iBAAW,cAAc;AAAA,IAC3B;AAAA,IACA,MAAM;AAAA;AAAA;AAAA;AAAA,MAIJ,SAAS,OAAO,aAAqB,SAAwB;AAC3D,cAAM,UAAU,QAAQ,EAAE,YAAY,GAAG,EAAE,KAAK,CAAC;AAAA,MACnD;AAAA,IACF;AAAA,IACA,WAAW;AAAA;AAAA;AAAA;AAAA,MAIT,SAAS,OAAO,aAAqB,cAAsB,SAAiD;AAC1G,cAAM,eAAe,QAAQ,EAAE,aAAa,aAAa,GAAG,EAAE,KAAK,CAAC;AAAA,MACtE;AAAA,IACF;AAAA,IACA,mBAAmB;AAAA;AAAA;AAAA;AAAA,MAIjB,SAAS,OACP,aACA,cACA,SACG;AACH,cAAM,sBAAsB,QAAQ,EAAE,aAAa,aAAa,GAAG,EAAE,KAAK,CAAC;AAAA,MAC7E;AAAA,IACF;AAAA,IACA,uBAAuB;AAAA;AAAA;AAAA;AAAA,MAIrB,SAAS,OACP,aACA,cACA,SACG;AACH,cAAM,0BAA0B,QAAQ,EAAE,aAAa,aAAa,GAAG,EAAE,KAAK,CAAC;AAAA,MACjF;AAAA,IACF;AAAA,IACA,WAAW;AAAA;AAAA;AAAA;AAAA,MAIT,SAAS,OAAO,aAAqB,cAAsB,SAAiD;AAC1G,cAAM,eAAe,QAAQ,EAAE,aAAa,aAAa,GAAG,EAAE,KAAK,CAAC;AAAA,MACtE;AAAA,IACF;AAAA,IACA,iBAAiB;AAAA;AAAA;AAAA;AAAA,MAIf,SAAS,OACP,aACA,cACA,SACG;AACH,cAAM,qBAAqB,QAAQ,EAAE,aAAa,aAAa,GAAG,EAAE,KAAK,CAAC;AAAA,MAC5E;AAAA,IACF;AAAA,IACA,WAAW;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAMT,SAAS,OAAO,OAA4E;AAC1F,cAAM,YAAY,MAAM,eAAe,QAAQ,EAAE,GAAG,CAAC;AAErD,YAAI,CAAC,WAAW;AACd,iBAAO;AAAA,QACT;AAGA,cAAM,qBAAqB,MAAM,eAAe,SAAS,CAAC,EAAE,CAAC;AAC7D,cAAM,6BAA6B,MAAM,sBAAsB,SAAS,CAAC,EAAE,CAAC;AAC5E,cAAM,iCAAiC,MAAM,0BAA0B,SAAS,CAAC,EAAE,CAAC;AACpF,cAAM,qBAAqB,MAAM,eAAe,SAAS,CAAC,EAAE,CAAC;AAC7D,cAAM,gBAAgB,MAAM,UAAU,QAAQ,EAAE,aAAa,GAAG,CAAC;AACjE,cAAM,2BAA2B,MAAM,qBAAqB,SAAS,CAAC,EAAE,CAAC;AAGzE,eAAO;AAAA,UACL;AAAA,UACA,MAAM,UAAU;AAAA,UAChB,WAAW;AAAA,YACT,WAAW,OAAO,YAAY,mBAAmB,IAAI,CAAC,SAAS,CAAC,KAAK,cAAc,KAAK,IAAI,CAAC,CAAC;AAAA,YAC9F,mBAAmB,OAAO;AAAA,cACxB,2BAA2B,IAAI,CAAC,SAAS,CAAC,KAAK,cAAc,KAAK,IAAI,CAAC;AAAA,YACzE;AAAA,YACA,uBAAuB,OAAO;AAAA,cAC5B,+BAA+B,IAAI,CAAC,SAAS,CAAC,KAAK,cAAc,KAAK,IAAI,CAAC;AAAA,YAC7E;AAAA,YACA,WAAW,OAAO,YAAY,mBAAmB,IAAI,CAAC,SAAS,CAAC,KAAK,cAAc,KAAK,IAAI,CAAC,CAAC;AAAA,YAC9F,MAAM,eAAe;AAAA,YACrB,iBAAiB,OAAO,YAAY,yBAAyB,IAAI,CAAC,SAAS,CAAC,KAAK,cAAc,KAAK,IAAI,CAAC,CAAC;AAAA,UAC5G;AAAA,QACF;AAAA,MACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAQA,QAAQ,YAAY;AAClB,eAAO,MAAM,eAAe,OAAO;AAAA,MACrC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAOA,SAAS,OAAO,IAAY,UAA8C;AACxE,cAAM,eAAe,QAAQ,EAAE,GAAG,GAAG,EAAE,MAAM,MAAM,KAAK,CAAC;AAGzD,cAAM,UAAU,QAAQ,EAAE,aAAa,GAAG,GAAG,EAAE,MAAM,MAAM,UAAU,KAAK,CAAC;AAG3E,cAAM,QAAQ;AAAA,UACZ,OAAO,QAAQ,MAAM,UAAU,aAAa,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,MAAM,IAAI,MAAM;AACpE,mBAAO,eAAe,QAAQ,EAAE,aAAa,IAAI,cAAc,KAAK,GAAG,EAAE,KAAK,CAAC;AAAA,UACjF,CAAC;AAAA,QACH;AAGA,cAAM,QAAQ;AAAA,UACZ,OAAO,QAAQ,MAAM,UAAU,qBAAqB,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,MAAM,IAAI,MAAM;AAC5E,mBAAO,sBAAsB,QAAQ,EAAE,aAAa,IAAI,cAAc,KAAK,GAAG,EAAE,KAAK,CAAC;AAAA,UACxF,CAAC;AAAA,QACH;AAGA,cAAM,QAAQ;AAAA,UACZ,OAAO,QAAQ,MAAM,UAAU,yBAAyB,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,MAAM,IAAI,MAAM;AAChF,mBAAO,0BAA0B,QAAQ,EAAE,aAAa,IAAI,cAAc,KAAK,GAAG,EAAE,KAAK,CAAC;AAAA,UAC5F,CAAC;AAAA,QACH;AAGA,cAAM,QAAQ;AAAA,UACZ,OAAO,QAAQ,MAAM,UAAU,aAAa,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,MAAM,IAAI,MAAM;AACpE,mBAAO,eAAe,QAAQ,EAAE,aAAa,IAAI,cAAc,KAAK,GAAG,EAAE,KAAK,CAAC;AAAA,UACjF,CAAC;AAAA,QACH;AAGA,cAAM,QAAQ;AAAA,UACZ,OAAO,QAAQ,MAAM,UAAU,mBAAmB,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,MAAM,IAAI,MAAM;AAC1E,mBAAO,qBAAqB,QAAQ,EAAE,aAAa,IAAI,cAAc,KAAK,GAAG,EAAE,KAAK,CAAC;AAAA,UACvF,CAAC;AAAA,QACH;AAAA,MACF;AAAA;AAAA;AAAA;AAAA,MAKA,YAAY,OAAO,OAA8B;AAC/C,cAAM,eAAe,WAAW,EAAE,GAAG,CAAC;AAGtC,cAAM,QAAQ,IAAI;AAAA;AAAA,UAEhB,UAAU,WAAW,EAAE,aAAa,GAAG,CAAC;AAAA;AAAA,UAGxC,eAAe,YAAY,CAAC,EAAE,CAAC;AAAA,UAC/B,sBAAsB,YAAY,CAAC,EAAE,CAAC;AAAA,UACtC,0BAA0B,YAAY,CAAC,EAAE,CAAC;AAAA,UAC1C,eAAe,YAAY,CAAC,EAAE,CAAC;AAAA,UAC/B,qBAAqB,YAAY,CAAC,EAAE,CAAC;AAAA,QACvC,CAAC;AAAA,MACH;AAAA,IACF;AAAA,EACF;AACF;",
+  "names": []
+}

package/dist/persistence/indexdb.d.ts

@@ -0,0 +1,87 @@
+import type { Static, TObject } from '@scalar/typebox';
+type TableEntry<S extends TObject, K extends readonly (keyof Static<S>)[]> = {
+    schema: S;
+    index: K;
+};
+/**
+ * Initializes and manages an IndexedDB database connection for table-based persistence.
+ *
+ * @param name - The database name. Defaults to 'scalar-workspace-store'.
+ * @param tables - Table definitions: the tables to create and their key schemas.
+ * @param version - The database version. Bump this to trigger upgrades (default: 1).
+ * @param migrations - Optional migration steps to run for version upgrades.
+ * @returns An object with the following methods:
+ *   - `get(tableName)` — Get a wrapper to interact with the object store for the given table name.
+ *   - `closeDatabase()` — Closes the database connection.
+ *
+ * Example usage:
+ * ```ts
+ * import { Type } from '@scalar/typebox'
+ * import { createIndexDbConnection } from './indexdb.js'
+ *
+ * // Define a schema for a user
+ * const UserSchema = Type.Object({
+ *   id: Type.String(),
+ *   name: Type.String(),
+ *   age: Type.Number(),
+ * })
+ *
+ * // Define tables in the database
+ * const dbConfig = {
+ *   users: {
+ *     schema: UserSchema,
+ *     index: ['id'] as const,
+ *   },
+ * }
+ *
+ * // Open the database connection and get table API
+ * const { get, closeDatabase } = await createIndexDbConnection({
+ *   name: 'my-app-db',
+ *   tables: dbConfig,
+ *   version: 1,
+ * })
+ *
+ * // Get a strongly-typed users table API
+ * const usersTable = get('users')
+ *
+ * // Add a user
+ * await usersTable.addItem({ id: 'user-1' }, { name: 'Alice', age: 25 })
+ *
+ * // Retrieve a user by id
+ * const user = await usersTable.getItem({ id: 'user-1' })
+ *
+ * // Don't forget to close the database when done!
+ * closeDatabase()
+ * ```
+ */
+export declare const createIndexDbConnection: <T extends Record<string, TableEntry<any, readonly (keyof any)[]>>>({ name, tables, version, migrations, }: {
+    name: string;
+    tables: T;
+    version: number;
+    migrations?: {
+        version: number;
+        exec: (db: IDBDatabase, event: IDBVersionChangeEvent) => {};
+    }[];
+}) => Promise<{
+    get: <Name extends keyof T>(name: Name) => {
+        addItem: (key: Record<T[Name]["index"][number], IDBValidKey>, value: Omit<(T[Name]["schema"] & {
+            params: [];
+        })["static"], T[Name]["index"][number]>) => Promise<(T[Name]["schema"] & {
+            params: [];
+        })["static"]>;
+        getItem: (key: Record<T[Name]["index"][number], IDBValidKey>) => Promise<(T[Name]["schema"] & {
+            params: [];
+        })["static"] | undefined>;
+        getRange: (partialKey: IDBValidKey[]) => Promise<(T[Name]["schema"] & {
+            params: [];
+        })["static"][]>;
+        deleteItem: (key: Record<T[Name]["index"][number], IDBValidKey>) => Promise<void>;
+        deleteRange: (partialKey: IDBValidKey[]) => Promise<number>;
+        getAll: () => Promise<(T[Name]["schema"] & {
+            params: [];
+        })["static"][]>;
+    };
+    closeDatabase: () => void;
+}>;
+export {};
+//# sourceMappingURL=indexdb.d.ts.map

package/dist/persistence/indexdb.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexdb.d.ts","sourceRoot":"","sources":["../../src/persistence/indexdb.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,OAAO,EAAW,MAAM,iBAAiB,CAAA;AAE/D,KAAK,UAAU,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC,SAAS,SAAS,CAAC,MAAM,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI;IAC3E,MAAM,EAAE,CAAC,CAAA;IACT,KAAK,EAAE,CAAC,CAAA;CACT,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,eAAO,MAAM,uBAAuB,GAAU,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,GAAG,EAAE,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,CAAC,EAAE,wCAK9G;IACD,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,CAAC,CAAA;IACT,OAAO,EAAE,MAAM,CAAA;IACf,UAAU,CAAC,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,CAAC,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,qBAAqB,KAAK,EAAE,CAAA;KAAE,EAAE,CAAA;CAChG;UAgCS,IAAI,SAAS,MAAM,CAAC,QAAQ,IAAI;;;;;;;;;+BA+FV,WAAW,EAAE;;;4EA6Ba,OAAO,CAAC,IAAI,CAAC;kCAmBpC,WAAW,EAAE,KAAG,OAAO,CAAC,MAAM,CAAC;;;;;;EAxIjE,CAAA"}

package/dist/persistence/indexdb.js

@@ -0,0 +1,125 @@
+const createIndexDbConnection = async ({
+  name = "scalar-workspace-store",
+  tables,
+  version = 1,
+  migrations = []
+}) => {
+  const db = indexedDB.open(name, version);
+  db.onupgradeneeded = (e) => {
+    if (e.oldVersion < 1) {
+      const database = db.result;
+      Object.entries(tables).forEach(([name2, options]) => {
+        if (!database.objectStoreNames.contains(name2)) {
+          database.createObjectStore(name2, {
+            keyPath: options.index.length === 1 ? options.index[0] : options.index
+          });
+        }
+      });
+    }
+    migrations.forEach((migration) => {
+      if (e.oldVersion < migration.version) {
+        migration.exec(db.result, e);
+      }
+    });
+  };
+  await new Promise((resolve, reject) => {
+    db.onsuccess = () => resolve(true);
+    db.onerror = () => reject(db.error);
+  });
+  return {
+    get: (name2) => {
+      return createTableWrapper(name2, db.result);
+    },
+    closeDatabase: () => {
+      db.result.close();
+    }
+  };
+};
+function createTableWrapper(name, db) {
+  const getStore = (mode) => {
+    const tx = db.transaction(name, mode);
+    return tx.objectStore(name);
+  };
+  async function addItem(key, value) {
+    const store = getStore("readwrite");
+    const keyObj = { ...key };
+    const finalValue = { ...keyObj, ...value };
+    await requestAsPromise(store.put(finalValue));
+    return finalValue;
+  }
+  function getItem(key) {
+    const store = getStore("readonly");
+    const keyValues = Object.values(key);
+    const keyToUse = keyValues.length === 1 ? keyValues[0] : keyValues;
+    return requestAsPromise(store.get(keyToUse));
+  }
+  function getRange(partialKey) {
+    const store = getStore("readonly");
+    const results = [];
+    const upperBound = [...partialKey];
+    upperBound.push([]);
+    const range = IDBKeyRange.bound(partialKey, upperBound, false, true);
+    return new Promise((resolve, reject) => {
+      const request = store.openCursor(range);
+      request.onerror = () => reject(request.error);
+      request.onsuccess = (event) => {
+        const cursor = event.target.result;
+        if (cursor) {
+          results.push(cursor.value);
+          cursor.continue();
+        } else {
+          resolve(results);
+        }
+      };
+    });
+  }
+  async function deleteItem(key) {
+    const store = getStore("readwrite");
+    const keyValues = Object.values(key);
+    const keyToUse = keyValues.length === 1 ? keyValues[0] : keyValues;
+    await requestAsPromise(store.delete(keyToUse));
+  }
+  function deleteRange(partialKey) {
+    const store = getStore("readwrite");
+    let deletedCount = 0;
+    const upperBound = [...partialKey];
+    upperBound.push([]);
+    const range = IDBKeyRange.bound(partialKey, upperBound, false, true);
+    return new Promise((resolve, reject) => {
+      const request = store.openCursor(range);
+      request.onerror = () => reject(request.error);
+      request.onsuccess = (event) => {
+        const cursor = event.target.result;
+        if (cursor) {
+          cursor.delete();
+          deletedCount++;
+          cursor.continue();
+        } else {
+          resolve(deletedCount);
+        }
+      };
+    });
+  }
+  function getAll() {
+    const store = getStore("readonly");
+    return requestAsPromise(store.getAll());
+  }
+  return {
+    addItem,
+    getItem,
+    getRange,
+    deleteItem,
+    deleteRange,
+    getAll
+  };
+}
+function requestAsPromise(req) {
+  return new Promise((resolve, reject) => {
+    req.onsuccess = () => resolve(req.result);
+    req.onerror = () => reject(req.error);
+  });
+}
+export {
+  createIndexDbConnection
+};
+//# sourceMappingURL=indexdb.js.map