@scalar/workspace-store 0.3.1 → 0.3.2

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @scalar/workspace-store
 
+## 0.3.2
+
+### Patch Changes
+
+- 11fabae: fix(openapi-parser): webpack bundle errors because of the barrel files
+- Updated dependencies [11fabae]
+  - @scalar/openapi-parser@0.16.0
+
 ## 0.3.1
 
 ### Patch Changes

package/dist/client.js

@@ -3,7 +3,7 @@ import { createMagicProxy } from "./helpers/proxy.js";
 import { isObject } from "./helpers/general.js";
 import { getValueByPath } from "./helpers/json-path-utils.js";
 import { bundle } from "@scalar/openapi-parser";
-import { fetchUrls } from "@scalar/openapi-parser/utils/bundle/plugins/fetch-urls";
+import { fetchUrls } from "@scalar/openapi-parser/plugins-browser";
 async function loadDocument(workspaceDocument) {
   if ("url" in workspaceDocument) {
     return fetchUrls().exec(workspaceDocument.url);

package/dist/client.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/client.ts"],
-  "sourcesContent": ["import { reactive, toRaw } from 'vue'\nimport type { WorkspaceMeta, WorkspaceDocumentMeta, Workspace } from './schemas/server-workspace'\nimport { createMagicProxy } from './helpers/proxy'\nimport { isObject } from '@/helpers/general'\nimport { getValueByPath } from '@/helpers/json-path-utils'\nimport { bundle } from '@scalar/openapi-parser'\nimport { fetchUrls } from '@scalar/openapi-parser/utils/bundle/plugins/fetch-urls'\n\ntype WorkspaceDocumentMetaInput = { meta?: WorkspaceDocumentMeta; name: string }\ntype WorkspaceDocumentInput =\n  | ({ document: Record<string, unknown> } & WorkspaceDocumentMetaInput)\n  | ({ url: string } & WorkspaceDocumentMetaInput)\n\n/**\n * Resolves a workspace document from various input sources (URL, local file, or direct document object).\n *\n * @param workspaceDocument - The document input to resolve, which can be:\n *   - A URL to fetch the document from\n *   - A local file path to read the document from\n *   - A direct document object\n * @returns A promise that resolves to an object containing:\n *   - ok: boolean indicating if the resolution was successful\n *   - data: The resolved document data\n *\n * @example\n * // Resolve from URL\n * const urlDoc = await loadDocument({ name: 'api', url: 'https://api.example.com/openapi.json' })\n *\n * // Resolve from local file\n * const fileDoc = await loadDocument({ name: 'local', path: './openapi.json' })\n *\n * // Resolve direct document\n * const directDoc = await loadDocument({\n *   name: 'inline',\n *   document: { openapi: '3.0.0', paths: {} }\n * })\n */\nasync function loadDocument(workspaceDocument: WorkspaceDocumentInput) {\n  if ('url' in workspaceDocument) {\n    return fetchUrls().exec(workspaceDocument.url)\n  }\n\n  return {\n    ok: true as const,\n    data: workspaceDocument.document,\n  }\n}\n\n/**\n * Creates a reactive workspace store that manages documents and their metadata.\n * The store provides functionality for accessing, updating, and resolving document references.\n *\n * @param workspaceProps - Configuration object for the workspace\n * @param workspaceProps.meta - Optional metadata for the workspace\n * @param workspaceProps.documents - Optional record of documents to initialize the workspace with\n * @returns An object containing methods and getters for managing the workspace\n * @deprecated Use `createWorkspaceStore` instead.\n */\nexport function createWorkspaceStoreSync(workspaceProps?: {\n  meta?: WorkspaceMeta\n}) {\n  // Create a reactive workspace object with proxied documents\n  // Each document is wrapped in a proxy to enable reactive updates and reference resolution\n  const workspace = reactive({\n    ...workspaceProps?.meta,\n    documents: {},\n    /**\n     * Returns the currently active document from the workspace.\n     * The active document is determined by the 'x-scalar-active-document' metadata field,\n     * falling back to the first document in the workspace if no active document is specified.\n     *\n     * @returns The active document or undefined if no document is found\n     */\n    get activeDocument(): (typeof workspace.documents)[number] | undefined {\n      const activeDocumentKey = workspace['x-scalar-active-document'] ?? Object.keys(workspace.documents)[0] ?? ''\n      return workspace.documents[activeDocumentKey]\n    },\n  }) as Workspace\n\n  // Cache to track visited nodes during reference resolution to prevent bundling the same subtree multiple times\n  // This is needed because we are doing partial bundle operations\n  const visitedNodesCache = new Set()\n\n  return {\n    /**\n     * Returns the raw (non-reactive) workspace object\n     */\n    get rawWorkspace() {\n      return toRaw(workspace)\n    },\n    /**\n     * Returns the reactive workspace object with an additional activeDocument getter\n     */\n    get workspace() {\n      return workspace\n    },\n    /**\n     * Updates a specific metadata field in the workspace\n     * @param key - The metadata field to update\n     * @param value - The new value for the field\n     * @example\n     * // Update the workspace title\n     * update('x-scalar-active-document', 'document-name')\n     */\n    update<K extends keyof WorkspaceMeta>(key: K, value: WorkspaceMeta[K]) {\n      // @ts-ignore\n      if (key === '__proto__' || key === 'constructor' || key === 'prototype') {\n        throw new Error('Invalid key: cannot modify prototype')\n      }\n      Object.assign(workspace, { [key]: value })\n    },\n    /**\n     * Updates a specific metadata field in a document\n     * @param name - The name of the document to update ('active' or a specific document name)\n     * @param key - The metadata field to update\n     * @param value - The new value for the field\n     * @throws Error if the specified document doesn't exist\n     * @example\n     * // Update the auth of the active document\n     * updateDocument('active', 'x-scalar-active-auth', 'Bearer')\n     * // Update the auth of a specific document\n     * updateDocument('document-name', 'x-scalar-active-auth', 'Bearer')\n     */\n    updateDocument<K extends keyof WorkspaceDocumentMeta>(\n      name: 'active' | (string & {}),\n      key: K,\n      value: WorkspaceDocumentMeta[K],\n    ) {\n      const currentDocument =\n        workspace.documents[\n          name === 'active'\n            ? (workspace['x-scalar-active-document'] ?? Object.keys(workspace.documents)[0] ?? '')\n            : name\n        ]\n\n      if (!currentDocument) {\n        throw 'Please select a valid document'\n      }\n\n      Object.assign(currentDocument, { [key]: value })\n    },\n    /**\n     * Resolves a reference in the active document by following the provided path and resolving any external $ref references.\n     * This method traverses the document structure following the given path and resolves any $ref references it encounters.\n     * During resolution, it sets a loading status and updates the reference with the resolved content.\n     *\n     * @param path - Array of strings representing the path to the reference (e.g. ['paths', '/users', 'get', 'responses', '200'])\n     * @throws Error if the path is invalid or empty\n     * @example\n     * // Resolve a reference in the active document\n     * resolve(['paths', '/users', 'get', 'responses', '200'])\n     */\n    resolve: async (path: string[]) => {\n      const activeDocument = workspace.activeDocument\n\n      const target = getValueByPath(activeDocument, path)\n\n      if (!isObject(target)) {\n        console.error(\n          `Invalid path provided for resolution. Path: [${path.join(', ')}]. Found value of type: ${typeof target}. Expected an object.`,\n        )\n        return\n      }\n\n      // Bundle the target document with the active document as root, resolving any external references\n      // and tracking resolution status through hooks\n      return bundle(target, {\n        root: activeDocument,\n        treeShake: false,\n        plugins: [fetchUrls()],\n        urlMap: false,\n        hooks: {\n          onResolveStart: (node) => {\n            node['$status'] = 'loading'\n          },\n          onResolveError: (node) => {\n            node['$status'] = 'error'\n          },\n        },\n        visitedNodes: visitedNodesCache,\n      })\n    },\n    /**\n     * Adds a new document to the workspace\n     * @param document - The document content to add. This should be a valid OpenAPI/Swagger document or other supported format\n     * @param meta - Metadata for the document, including its name and other properties defined in WorkspaceDocumentMeta\n     * @example\n     * // Add a new OpenAPI document to the workspace\n     * store.addDocument({\n     *   name: 'name',\n     *   document: {\n     *     openapi: '3.0.0',\n     *     info: { title: 'title' },\n     *   },\n     *   meta: {\n     *     'x-scalar-active-auth': 'Bearer',\n     *     'x-scalar-active-server': 'production'\n     *   }\n     * })\n     */\n    addDocument: async (input: WorkspaceDocumentInput) => {\n      const { name, meta } = input\n\n      const resolve = await loadDocument(input)\n\n      if (!resolve.ok || !isObject(resolve.data)) {\n        console.error(`Can not load the document '${name}'`)\n        workspace.documents[name] = {\n          ...meta,\n        }\n        return\n      }\n\n      workspace.documents[name] = createMagicProxy({ ...(resolve.data as Record<string, unknown>), ...meta })\n    },\n  }\n}\n\n/**\n * Creates a reactive workspace store that manages documents and their metadata.\n * The store provides functionality for accessing, updating, and resolving document references.\n *\n * @param workspaceProps - Configuration object for the workspace\n * @param workspaceProps.meta - Optional metadata for the workspace\n * @param workspaceProps.documents - Optional record of documents to initialize the workspace with\n * @returns An object containing methods and getters for managing the workspace\n * @example\n * // Create a workspace store with metadata and documents\n * const store = await createWorkspaceStore({\n *   meta: {\n *     name: 'My Workspace',\n *     description: 'A workspace for my API'\n *   },\n *   documents: [\n *     {\n *       name: 'petstore',\n *       document: {\n *         openapi: '3.0.0',\n *         info: { title: 'Petstore API' }\n *       }\n *     }\n *   ]\n * })\n */\nexport async function createWorkspaceStore(workspaceProps?: {\n  meta?: WorkspaceMeta\n  documents?: WorkspaceDocumentInput[]\n}) {\n  const store = createWorkspaceStoreSync({ meta: workspaceProps?.meta })\n\n  await Promise.all(workspaceProps?.documents?.map((it) => store.addDocument(it)) ?? [])\n\n  return store\n}\n"],
+  "sourcesContent": ["import { reactive, toRaw } from 'vue'\nimport type { WorkspaceMeta, WorkspaceDocumentMeta, Workspace } from './schemas/server-workspace'\nimport { createMagicProxy } from './helpers/proxy'\nimport { isObject } from '@/helpers/general'\nimport { getValueByPath } from '@/helpers/json-path-utils'\nimport { bundle } from '@scalar/openapi-parser'\nimport { fetchUrls } from '@scalar/openapi-parser/plugins-browser'\n\ntype WorkspaceDocumentMetaInput = { meta?: WorkspaceDocumentMeta; name: string }\ntype WorkspaceDocumentInput =\n  | ({ document: Record<string, unknown> } & WorkspaceDocumentMetaInput)\n  | ({ url: string } & WorkspaceDocumentMetaInput)\n\n/**\n * Resolves a workspace document from various input sources (URL, local file, or direct document object).\n *\n * @param workspaceDocument - The document input to resolve, which can be:\n *   - A URL to fetch the document from\n *   - A local file path to read the document from\n *   - A direct document object\n * @returns A promise that resolves to an object containing:\n *   - ok: boolean indicating if the resolution was successful\n *   - data: The resolved document data\n *\n * @example\n * // Resolve from URL\n * const urlDoc = await loadDocument({ name: 'api', url: 'https://api.example.com/openapi.json' })\n *\n * // Resolve from local file\n * const fileDoc = await loadDocument({ name: 'local', path: './openapi.json' })\n *\n * // Resolve direct document\n * const directDoc = await loadDocument({\n *   name: 'inline',\n *   document: { openapi: '3.0.0', paths: {} }\n * })\n */\nasync function loadDocument(workspaceDocument: WorkspaceDocumentInput) {\n  if ('url' in workspaceDocument) {\n    return fetchUrls().exec(workspaceDocument.url)\n  }\n\n  return {\n    ok: true as const,\n    data: workspaceDocument.document,\n  }\n}\n\n/**\n * Creates a reactive workspace store that manages documents and their metadata.\n * The store provides functionality for accessing, updating, and resolving document references.\n *\n * @param workspaceProps - Configuration object for the workspace\n * @param workspaceProps.meta - Optional metadata for the workspace\n * @param workspaceProps.documents - Optional record of documents to initialize the workspace with\n * @returns An object containing methods and getters for managing the workspace\n * @deprecated Use `createWorkspaceStore` instead.\n */\nexport function createWorkspaceStoreSync(workspaceProps?: {\n  meta?: WorkspaceMeta\n}) {\n  // Create a reactive workspace object with proxied documents\n  // Each document is wrapped in a proxy to enable reactive updates and reference resolution\n  const workspace = reactive({\n    ...workspaceProps?.meta,\n    documents: {},\n    /**\n     * Returns the currently active document from the workspace.\n     * The active document is determined by the 'x-scalar-active-document' metadata field,\n     * falling back to the first document in the workspace if no active document is specified.\n     *\n     * @returns The active document or undefined if no document is found\n     */\n    get activeDocument(): (typeof workspace.documents)[number] | undefined {\n      const activeDocumentKey = workspace['x-scalar-active-document'] ?? Object.keys(workspace.documents)[0] ?? ''\n      return workspace.documents[activeDocumentKey]\n    },\n  }) as Workspace\n\n  // Cache to track visited nodes during reference resolution to prevent bundling the same subtree multiple times\n  // This is needed because we are doing partial bundle operations\n  const visitedNodesCache = new Set()\n\n  return {\n    /**\n     * Returns the raw (non-reactive) workspace object\n     */\n    get rawWorkspace() {\n      return toRaw(workspace)\n    },\n    /**\n     * Returns the reactive workspace object with an additional activeDocument getter\n     */\n    get workspace() {\n      return workspace\n    },\n    /**\n     * Updates a specific metadata field in the workspace\n     * @param key - The metadata field to update\n     * @param value - The new value for the field\n     * @example\n     * // Update the workspace title\n     * update('x-scalar-active-document', 'document-name')\n     */\n    update<K extends keyof WorkspaceMeta>(key: K, value: WorkspaceMeta[K]) {\n      // @ts-ignore\n      if (key === '__proto__' || key === 'constructor' || key === 'prototype') {\n        throw new Error('Invalid key: cannot modify prototype')\n      }\n      Object.assign(workspace, { [key]: value })\n    },\n    /**\n     * Updates a specific metadata field in a document\n     * @param name - The name of the document to update ('active' or a specific document name)\n     * @param key - The metadata field to update\n     * @param value - The new value for the field\n     * @throws Error if the specified document doesn't exist\n     * @example\n     * // Update the auth of the active document\n     * updateDocument('active', 'x-scalar-active-auth', 'Bearer')\n     * // Update the auth of a specific document\n     * updateDocument('document-name', 'x-scalar-active-auth', 'Bearer')\n     */\n    updateDocument<K extends keyof WorkspaceDocumentMeta>(\n      name: 'active' | (string & {}),\n      key: K,\n      value: WorkspaceDocumentMeta[K],\n    ) {\n      const currentDocument =\n        workspace.documents[\n          name === 'active'\n            ? (workspace['x-scalar-active-document'] ?? Object.keys(workspace.documents)[0] ?? '')\n            : name\n        ]\n\n      if (!currentDocument) {\n        throw 'Please select a valid document'\n      }\n\n      Object.assign(currentDocument, { [key]: value })\n    },\n    /**\n     * Resolves a reference in the active document by following the provided path and resolving any external $ref references.\n     * This method traverses the document structure following the given path and resolves any $ref references it encounters.\n     * During resolution, it sets a loading status and updates the reference with the resolved content.\n     *\n     * @param path - Array of strings representing the path to the reference (e.g. ['paths', '/users', 'get', 'responses', '200'])\n     * @throws Error if the path is invalid or empty\n     * @example\n     * // Resolve a reference in the active document\n     * resolve(['paths', '/users', 'get', 'responses', '200'])\n     */\n    resolve: async (path: string[]) => {\n      const activeDocument = workspace.activeDocument\n\n      const target = getValueByPath(activeDocument, path)\n\n      if (!isObject(target)) {\n        console.error(\n          `Invalid path provided for resolution. Path: [${path.join(', ')}]. Found value of type: ${typeof target}. Expected an object.`,\n        )\n        return\n      }\n\n      // Bundle the target document with the active document as root, resolving any external references\n      // and tracking resolution status through hooks\n      return bundle(target, {\n        root: activeDocument,\n        treeShake: false,\n        plugins: [fetchUrls()],\n        urlMap: false,\n        hooks: {\n          onResolveStart: (node) => {\n            node['$status'] = 'loading'\n          },\n          onResolveError: (node) => {\n            node['$status'] = 'error'\n          },\n        },\n        visitedNodes: visitedNodesCache,\n      })\n    },\n    /**\n     * Adds a new document to the workspace\n     * @param document - The document content to add. This should be a valid OpenAPI/Swagger document or other supported format\n     * @param meta - Metadata for the document, including its name and other properties defined in WorkspaceDocumentMeta\n     * @example\n     * // Add a new OpenAPI document to the workspace\n     * store.addDocument({\n     *   name: 'name',\n     *   document: {\n     *     openapi: '3.0.0',\n     *     info: { title: 'title' },\n     *   },\n     *   meta: {\n     *     'x-scalar-active-auth': 'Bearer',\n     *     'x-scalar-active-server': 'production'\n     *   }\n     * })\n     */\n    addDocument: async (input: WorkspaceDocumentInput) => {\n      const { name, meta } = input\n\n      const resolve = await loadDocument(input)\n\n      if (!resolve.ok || !isObject(resolve.data)) {\n        console.error(`Can not load the document '${name}'`)\n        workspace.documents[name] = {\n          ...meta,\n        }\n        return\n      }\n\n      workspace.documents[name] = createMagicProxy({ ...(resolve.data as Record<string, unknown>), ...meta })\n    },\n  }\n}\n\n/**\n * Creates a reactive workspace store that manages documents and their metadata.\n * The store provides functionality for accessing, updating, and resolving document references.\n *\n * @param workspaceProps - Configuration object for the workspace\n * @param workspaceProps.meta - Optional metadata for the workspace\n * @param workspaceProps.documents - Optional record of documents to initialize the workspace with\n * @returns An object containing methods and getters for managing the workspace\n * @example\n * // Create a workspace store with metadata and documents\n * const store = await createWorkspaceStore({\n *   meta: {\n *     name: 'My Workspace',\n *     description: 'A workspace for my API'\n *   },\n *   documents: [\n *     {\n *       name: 'petstore',\n *       document: {\n *         openapi: '3.0.0',\n *         info: { title: 'Petstore API' }\n *       }\n *     }\n *   ]\n * })\n */\nexport async function createWorkspaceStore(workspaceProps?: {\n  meta?: WorkspaceMeta\n  documents?: WorkspaceDocumentInput[]\n}) {\n  const store = createWorkspaceStoreSync({ meta: workspaceProps?.meta })\n\n  await Promise.all(workspaceProps?.documents?.map((it) => store.addDocument(it)) ?? [])\n\n  return store\n}\n"],
   "mappings": "AAAA,SAAS,UAAU,aAAa;AAEhC,SAAS,wBAAwB;AACjC,SAAS,gBAAgB;AACzB,SAAS,sBAAsB;AAC/B,SAAS,cAAc;AACvB,SAAS,iBAAiB;AA+B1B,eAAe,aAAa,mBAA2C;AACrE,MAAI,SAAS,mBAAmB;AAC9B,WAAO,UAAU,EAAE,KAAK,kBAAkB,GAAG;AAAA,EAC/C;AAEA,SAAO;AAAA,IACL,IAAI;AAAA,IACJ,MAAM,kBAAkB;AAAA,EAC1B;AACF;AAYO,SAAS,yBAAyB,gBAEtC;AAGD,QAAM,YAAY,SAAS;AAAA,IACzB,GAAG,gBAAgB;AAAA,IACnB,WAAW,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQZ,IAAI,iBAAmE;AACrE,YAAM,oBAAoB,UAAU,0BAA0B,KAAK,OAAO,KAAK,UAAU,SAAS,EAAE,CAAC,KAAK;AAC1G,aAAO,UAAU,UAAU,iBAAiB;AAAA,IAC9C;AAAA,EACF,CAAC;AAID,QAAM,oBAAoB,oBAAI,IAAI;AAElC,SAAO;AAAA;AAAA;AAAA;AAAA,IAIL,IAAI,eAAe;AACjB,aAAO,MAAM,SAAS;AAAA,IACxB;AAAA;AAAA;AAAA;AAAA,IAIA,IAAI,YAAY;AACd,aAAO;AAAA,IACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IASA,OAAsC,KAAQ,OAAyB;AAErE,UAAI,QAAQ,eAAe,QAAQ,iBAAiB,QAAQ,aAAa;AACvE,cAAM,IAAI,MAAM,sCAAsC;AAAA,MACxD;AACA,aAAO,OAAO,WAAW,EAAE,CAAC,GAAG,GAAG,MAAM,CAAC;AAAA,IAC3C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAaA,eACE,MACA,KACA,OACA;AACA,YAAM,kBACJ,UAAU,UACR,SAAS,WACJ,UAAU,0BAA0B,KAAK,OAAO,KAAK,UAAU,SAAS,EAAE,CAAC,KAAK,KACjF,IACN;AAEF,UAAI,CAAC,iBAAiB;AACpB,cAAM;AAAA,MACR;AAEA,aAAO,OAAO,iBAAiB,EAAE,CAAC,GAAG,GAAG,MAAM,CAAC;AAAA,IACjD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAYA,SAAS,OAAO,SAAmB;AACjC,YAAM,iBAAiB,UAAU;AAEjC,YAAM,SAAS,eAAe,gBAAgB,IAAI;AAElD,UAAI,CAAC,SAAS,MAAM,GAAG;AACrB,gBAAQ;AAAA,UACN,gDAAgD,KAAK,KAAK,IAAI,CAAC,2BAA2B,OAAO,MAAM;AAAA,QACzG;AACA;AAAA,MACF;AAIA,aAAO,OAAO,QAAQ;AAAA,QACpB,MAAM;AAAA,QACN,WAAW;AAAA,QACX,SAAS,CAAC,UAAU,CAAC;AAAA,QACrB,QAAQ;AAAA,QACR,OAAO;AAAA,UACL,gBAAgB,CAAC,SAAS;AACxB,iBAAK,SAAS,IAAI;AAAA,UACpB;AAAA,UACA,gBAAgB,CAAC,SAAS;AACxB,iBAAK,SAAS,IAAI;AAAA,UACpB;AAAA,QACF;AAAA,QACA,cAAc;AAAA,MAChB,CAAC;AAAA,IACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAmBA,aAAa,OAAO,UAAkC;AACpD,YAAM,EAAE,MAAM,KAAK,IAAI;AAEvB,YAAM,UAAU,MAAM,aAAa,KAAK;AAExC,UAAI,CAAC,QAAQ,MAAM,CAAC,SAAS,QAAQ,IAAI,GAAG;AAC1C,gBAAQ,MAAM,8BAA8B,IAAI,GAAG;AACnD,kBAAU,UAAU,IAAI,IAAI;AAAA,UAC1B,GAAG;AAAA,QACL;AACA;AAAA,MACF;AAEA,gBAAU,UAAU,IAAI,IAAI,iBAAiB,EAAE,GAAI,QAAQ,MAAkC,GAAG,KAAK,CAAC;AAAA,IACxG;AAAA,EACF;AACF;AA4BA,eAAsB,qBAAqB,gBAGxC;AACD,QAAM,QAAQ,yBAAyB,EAAE,MAAM,gBAAgB,KAAK,CAAC;AAErE,QAAM,QAAQ,IAAI,gBAAgB,WAAW,IAAI,CAAC,OAAO,MAAM,YAAY,EAAE,CAAC,KAAK,CAAC,CAAC;AAErF,SAAO;AACT;",
   "names": []
 }

package/package.json

@@ -16,10 +16,14 @@
     "openapi",
     "scalar"
   ],
-  "version": "0.3.1",
+  "version": "0.3.2",
   "engines": {
     "node": ">=18"
   },
+  "files": [
+    "dist",
+    "CHANGELOG.md"
+  ],
   "type": "module",
   "exports": {
     "./client": {
@@ -41,7 +45,7 @@
   "dependencies": {
     "@sinclair/typebox": "0.34.3",
     "vue": "^3.5.12",
-    "@scalar/openapi-parser": "0.15.0",
+    "@scalar/openapi-parser": "0.16.0",
     "@scalar/openapi-types": "0.3.2"
   },
   "devDependencies": {

package/.turbo/turbo-build.log

@@ -1,13 +0,0 @@
-
-> @scalar/workspace-store@0.3.1 build /home/runner/work/scalar/scalar/packages/workspace-store
-> scalar-build-esbuild
-
-namespacePath . schemas
-namespacePath . client
-namespacePath . server
-Updating package.json exports field…
-@scalar/workspace-store: Build completed in 30.95ms
-
-> @scalar/workspace-store@0.3.1 types:build /home/runner/work/scalar/scalar/packages/workspace-store
-> scalar-types-build
-

package/esbuild.ts

@@ -1,8 +0,0 @@
-import { build } from '@scalar/build-tooling/esbuild'
-
-const entries = ['./src/schemas.ts', './src/client.ts', './src/server.ts']
-
-await build({
-  entries,
-  platform: 'node',
-})

package/src/client.test.ts

@@ -1,409 +0,0 @@
-import { createServerWorkspaceStore } from '@/server'
-import { createWorkspaceStore } from '@/client'
-import { beforeEach, describe, expect, test } from 'vitest'
-import fastify, { type FastifyInstance } from 'fastify'
-import { afterEach } from 'node:test'
-
-// Test document
-const document = {
-  openapi: '3.0.0',
-  info: { title: 'My API' },
-  components: {
-    schemas: {
-      User: {
-        type: 'object',
-        properties: {
-          id: {
-            type: 'string',
-            description: 'The user ID',
-          },
-          name: {
-            type: 'string',
-            description: 'The user name',
-          },
-          email: {
-            type: 'string',
-            format: 'email',
-            description: 'The user email',
-          },
-        },
-      },
-    },
-  },
-  paths: {
-    '/users': {
-      get: {
-        summary: 'Get all users',
-        responses: {
-          '200': {
-            description: 'Successful response',
-            content: {
-              'application/json': {
-                schema: {
-                  type: 'array',
-                  items: {
-                    $ref: '#/components/schemas/User',
-                  },
-                },
-              },
-            },
-          },
-        },
-      },
-    },
-  },
-}
-
-describe('create-workspace-store', () => {
-  let server: FastifyInstance
-
-  beforeEach(() => {
-    server = fastify({ logger: false })
-  })
-
-  afterEach(async () => {
-    await server.close()
-  })
-
-  test('should correctly update workspace metadata', async () => {
-    const store = await createWorkspaceStore({
-      meta: {
-        'x-scalar-theme': 'default',
-        'x-scalar-dark-mode': false,
-      },
-    })
-
-    store.update('x-scalar-dark-mode', true)
-    store.update('x-scalar-theme', 'saturn')
-
-    expect(store.rawWorkspace['x-scalar-dark-mode']).toBe(true)
-    expect(store.rawWorkspace['x-scalar-theme']).toBe('saturn')
-  })
-
-  test('should correctly update document metadata', async () => {
-    const store = await createWorkspaceStore({
-      documents: [
-        {
-          name: 'default',
-          document: {
-            openapi: '3.0.0',
-            info: { title: 'My API' },
-          },
-          meta: {
-            'x-scalar-active-auth': 'Bearer',
-            'x-scalar-active-server': 'server-1',
-          },
-        },
-      ],
-    })
-
-    // Should update the active document
-    store.updateDocument('active', 'x-scalar-active-server', 'server-2')
-    store.updateDocument('active', 'x-scalar-active-auth', undefined)
-    expect(store.rawWorkspace.documents['default']['x-scalar-active-auth']).toBe(undefined)
-    expect(store.rawWorkspace.documents['default']['x-scalar-active-server']).toBe('server-2')
-
-    // Should update a specific document
-    store.updateDocument('default', 'x-scalar-active-server', 'server-3')
-    store.updateDocument('default', 'x-scalar-active-auth', 'Bearer')
-    expect(store.rawWorkspace.documents['default']['x-scalar-active-auth']).toBe('Bearer')
-    expect(store.rawWorkspace.documents['default']['x-scalar-active-server']).toBe('server-3')
-  })
-
-  test('should correctly get the correct document', async () => {
-    const store = await createWorkspaceStore({
-      documents: [
-        {
-          name: 'default',
-          document: {
-            openapi: '3.0.0',
-            info: { title: 'My API' },
-          },
-          meta: {
-            'x-scalar-active-auth': 'Bearer',
-            'x-scalar-active-server': 'server-1',
-          },
-        },
-        {
-          name: 'document2',
-          document: {
-            openapi: '3.0.0',
-            info: { title: 'Second API' },
-          },
-          meta: {
-            'x-scalar-active-auth': 'Bearer',
-            'x-scalar-active-server': 'server-1',
-          },
-        },
-      ],
-      meta: {
-        'x-scalar-active-document': 'default',
-      },
-    })
-
-    // Correctly gets the active document
-    expect(store.workspace.activeDocument?.info?.title).toBe('My API')
-
-    store.update('x-scalar-active-document', 'document2')
-    expect(store.workspace.activeDocument?.info?.title).toBe('Second API')
-
-    // Correctly get a specific document
-    expect(store.workspace.documents['default'].info?.title).toBe('My API')
-  })
-
-  test('should correctly add new documents', async () => {
-    const store = await createWorkspaceStore({
-      documents: [],
-    })
-
-    await store.addDocument({
-      document: {
-        openapi: '3.0.0',
-        info: { title: 'My API' },
-      },
-      name: 'default',
-    })
-
-    store.update('x-scalar-active-document', 'default')
-    expect(store.workspace.activeDocument?.info?.title).toBe('My API')
-  })
-
-  test('should correctly resolve refs on the fly', async () => {
-    const store = await createWorkspaceStore({
-      documents: [
-        {
-          name: 'default',
-          document: {
-            openapi: '3.0.0',
-            info: { title: 'My API' },
-            components: {
-              schemas: {
-                User: {
-                  type: 'object',
-                  properties: {
-                    id: {
-                      type: 'string',
-                      description: 'The user ID',
-                    },
-                    name: {
-                      type: 'string',
-                      description: 'The user name',
-                    },
-                    email: {
-                      type: 'string',
-                      format: 'email',
-                      description: 'The user email',
-                    },
-                  },
-                },
-              },
-            },
-            paths: {
-              '/users': {
-                get: {
-                  summary: 'Get all users',
-                  responses: {
-                    '200': {
-                      description: 'Successful response',
-                      content: {
-                        'application/json': {
-                          schema: {
-                            type: 'array',
-                            items: {
-                              $ref: '#/components/schemas/User',
-                            },
-                          },
-                        },
-                      },
-                    },
-                  },
-                },
-              },
-            },
-          },
-        },
-      ],
-    })
-
-    expect(
-      (store.workspace.activeDocument?.paths?.['/users'].get as any)?.responses?.[200].content['application/json']
-        .schema.items.properties.name,
-    ).toEqual({
-      type: 'string',
-      description: 'The user name',
-    })
-  })
-
-  test('should correctly resolve chunks from the remote server', async () => {
-    server.get('/*', (req, res) => {
-      const path = req.url
-      const contents = serverStore.get(path)
-
-      res.send(contents)
-    })
-
-    const PORT = 9988
-    await server.listen({ port: PORT })
-
-    const serverStore = createServerWorkspaceStore({
-      mode: 'ssr',
-      baseUrl: `http://localhost:${PORT}`,
-      documents: [
-        {
-          name: 'default',
-          document,
-        },
-      ],
-    })
-
-    const store = await createWorkspaceStore({
-      documents: [
-        {
-          name: 'default',
-          document: serverStore.getWorkspace().documents['default'],
-        },
-      ],
-    })
-
-    // The operation should not be resolved on the fly
-    expect(store.workspace.activeDocument?.paths?.['/users'].get).toEqual({
-      '$ref': 'http://localhost:9988/default/operations/~1users/get#',
-      $global: true,
-    })
-
-    // We resolve the ref
-    await store.resolve(['paths', '/users', 'get'])
-
-    // We expect the ref to have been resolved with the correct contents
-    expect(store.workspace.activeDocument?.paths?.['/users'].get?.summary).toEqual(document.paths['/users'].get.summary)
-
-    expect(
-      (store.workspace.activeDocument?.paths?.['/users'].get as any).responses[200].content['application/json'].schema
-        .items,
-    ).toEqual(document.components.schemas.User)
-  })
-
-  test('should load files form the remote url', async () => {
-    const PORT = 9989
-    const url = `http://localhost:${PORT}`
-
-    // Send the default document
-    server.get('/', (_, reply) => {
-      reply.send(document)
-    })
-
-    await server.listen({ port: PORT })
-
-    const store = await createWorkspaceStore({
-      documents: [
-        {
-          url: url,
-          name: 'default',
-        },
-      ],
-    })
-
-    expect(Object.keys(store.workspace.documents)).toEqual(['default'])
-    expect(store.workspace.documents['default'].info?.title).toEqual(document.info.title)
-
-    // Add a new remote file
-    await store.addDocument({ name: 'new', url: url })
-
-    expect(Object.keys(store.workspace.documents)).toEqual(['default', 'new'])
-    expect(store.workspace.documents['new'].info?.title).toEqual(document.info.title)
-  })
-
-  test('should handle circular references when we try to resolve all remote chunks recursively', async () => {
-    const document = {
-      openapi: '3.0.0',
-      info: { title: 'My API' },
-      components: {
-        schemas: {
-          User: {
-            type: 'object',
-            properties: {
-              id: {
-                type: 'string',
-                description: 'The user ID',
-              },
-              name: {
-                $ref: '#/components/schemas/Rec',
-              },
-            },
-          },
-          Rec: {
-            type: 'object',
-            properties: {
-              id: {
-                $ref: '#/components/schemas/User',
-              },
-            },
-          },
-        },
-      },
-      paths: {
-        '/users': {
-          get: {
-            summary: 'Get all users',
-            responses: {
-              '200': {
-                description: 'Successful response',
-                content: {
-                  'application/json': {
-                    schema: {
-                      type: 'array',
-                      items: {
-                        $ref: '#/components/schemas/User',
-                      },
-                    },
-                  },
-                },
-              },
-            },
-          },
-        },
-      },
-    }
-
-    server.get('/*', (req, res) => {
-      const path = req.url
-      const contents = serverStore.get(path)
-
-      res.send(contents)
-    })
-
-    const PORT = 6672
-    await server.listen({ port: PORT })
-
-    const serverStore = createServerWorkspaceStore({
-      mode: 'ssr',
-      baseUrl: `http://localhost:${PORT}`,
-      documents: [
-        {
-          name: 'default',
-          document,
-        },
-      ],
-    })
-
-    const store = await createWorkspaceStore({
-      documents: [
-        {
-          name: 'default',
-          document: serverStore.getWorkspace().documents['default'],
-        },
-      ],
-    })
-
-    // The operation should not be resolved on the fly
-    expect(store.workspace.activeDocument?.paths?.['/users'].get).toEqual({
-      '$ref': `http://localhost:${PORT}/default/operations/~1users/get#`,
-      $global: true,
-    })
-
-    // We resolve the ref
-    await store.resolve(['paths', '/users', 'get'])
-
-    expect((store.workspace.activeDocument?.components?.schemas?.['User'] as any)?.type).toBe('object')
-  })
-})