@scalar/workspace-store 0.2.0 → 0.3.1

package/src/{create-workspace-store.ts → client.ts}

@@ -4,14 +4,12 @@ import { createMagicProxy } from './helpers/proxy'
 import { isObject } from '@/helpers/general'
 import { getValueByPath } from '@/helpers/json-path-utils'
 import { bundle } from '@scalar/openapi-parser'
-import { readFiles } from '@scalar/openapi-parser/utils/bundle/plugins/read-files'
 import { fetchUrls } from '@scalar/openapi-parser/utils/bundle/plugins/fetch-urls'
 
 type WorkspaceDocumentMetaInput = { meta?: WorkspaceDocumentMeta; name: string }
 type WorkspaceDocumentInput =
   | ({ document: Record<string, unknown> } & WorkspaceDocumentMetaInput)
   | ({ url: string } & WorkspaceDocumentMetaInput)
-  | ({ path: string } & WorkspaceDocumentMetaInput)
 
 /**
  * Resolves a workspace document from various input sources (URL, local file, or direct document object).
@@ -42,10 +40,6 @@ async function loadDocument(workspaceDocument: WorkspaceDocumentInput) {
     return fetchUrls().exec(workspaceDocument.url)
   }
 
-  if ('path' in workspaceDocument) {
-    return readFiles().exec(workspaceDocument.path)
-  }
-
   return {
     ok: true as const,
     data: workspaceDocument.document,
@@ -60,45 +54,16 @@ async function loadDocument(workspaceDocument: WorkspaceDocumentInput) {
  * @param workspaceProps.meta - Optional metadata for the workspace
  * @param workspaceProps.documents - Optional record of documents to initialize the workspace with
  * @returns An object containing methods and getters for managing the workspace
+ * @deprecated Use `createWorkspaceStore` instead.
  */
-export async function createWorkspaceStore(workspaceProps?: {
+export function createWorkspaceStoreSync(workspaceProps?: {
   meta?: WorkspaceMeta
-  documents?: WorkspaceDocumentInput[]
 }) {
   // Create a reactive workspace object with proxied documents
   // Each document is wrapped in a proxy to enable reactive updates and reference resolution
   const workspace = reactive({
     ...workspaceProps?.meta,
-    documents: (
-      await Promise.all(
-        (workspaceProps?.documents ?? []).map<
-          Promise<{ name: string; meta?: WorkspaceDocumentMeta; document: Record<string, unknown> }>
-        >(async (data) => {
-          const resolved = await loadDocument(data)
-
-          if (!resolved.ok) {
-            console.error(`Can not load the document '${data.name}'`)
-            return {
-              name: data.name,
-              meta: data.meta,
-              document: {},
-            }
-          }
-
-          return {
-            name: data.name,
-            meta: data.meta,
-            document: isObject(resolved.data) ? (resolved.data as Record<string, unknown>) : {},
-          }
-        }),
-      )
-    ).reduce<Record<string, Record<string, unknown>>>((acc, { name, meta, document }) => {
-      /**
-       * We wrap each document in the magic proxy to enable auto-resolving of references
-       */
-      acc[name] = createMagicProxy({ ...document, ...meta })
-      return acc
-    }, {}),
+    documents: {},
     /**
      * Returns the currently active document from the workspace.
      * The active document is determined by the 'x-scalar-active-document' metadata field,
@@ -164,7 +129,7 @@ export async function createWorkspaceStore(workspaceProps?: {
       const currentDocument =
         workspace.documents[
           name === 'active'
-            ? (workspace['x-scalar-active-document'] ?? workspaceProps?.documents?.[0].name ?? '')
+            ? (workspace['x-scalar-active-document'] ?? Object.keys(workspace.documents)[0] ?? '')
             : name
         ]
 
@@ -202,7 +167,7 @@ export async function createWorkspaceStore(workspaceProps?: {
       return bundle(target, {
         root: activeDocument,
         treeShake: false,
-        plugins: [fetchUrls(), readFiles()],
+        plugins: [fetchUrls()],
         urlMap: false,
         hooks: {
           onResolveStart: (node) => {
@@ -240,6 +205,9 @@ export async function createWorkspaceStore(workspaceProps?: {
 
       if (!resolve.ok || !isObject(resolve.data)) {
         console.error(`Can not load the document '${name}'`)
+        workspace.documents[name] = {
+          ...meta,
+        }
         return
       }
 
@@ -247,3 +215,40 @@ export async function createWorkspaceStore(workspaceProps?: {
     },
   }
 }
+
+/**
+ * Creates a reactive workspace store that manages documents and their metadata.
+ * The store provides functionality for accessing, updating, and resolving document references.
+ *
+ * @param workspaceProps - Configuration object for the workspace
+ * @param workspaceProps.meta - Optional metadata for the workspace
+ * @param workspaceProps.documents - Optional record of documents to initialize the workspace with
+ * @returns An object containing methods and getters for managing the workspace
+ * @example
+ * // Create a workspace store with metadata and documents
+ * const store = await createWorkspaceStore({
+ *   meta: {
+ *     name: 'My Workspace',
+ *     description: 'A workspace for my API'
+ *   },
+ *   documents: [
+ *     {
+ *       name: 'petstore',
+ *       document: {
+ *         openapi: '3.0.0',
+ *         info: { title: 'Petstore API' }
+ *       }
+ *     }
+ *   ]
+ * })
+ */
+export async function createWorkspaceStore(workspaceProps?: {
+  meta?: WorkspaceMeta
+  documents?: WorkspaceDocumentInput[]
+}) {
+  const store = createWorkspaceStoreSync({ meta: workspaceProps?.meta })
+
+  await Promise.all(workspaceProps?.documents?.map((it) => store.addDocument(it)) ?? [])
+
+  return store
+}

package/src/schemas.ts

@@ -0,0 +1,6 @@
+export {
+  WorkspaceSchema,
+  type Workspace,
+  WorkspaceDocumentSchema,
+  type WorkspaceDocument,
+} from './schemas/server-workspace'

package/src/{create-server-workspace-store.test.ts → server.test.ts}

@@ -5,7 +5,7 @@ import {
   externalizeComponentReferences,
   externalizePathReferences,
   filterHttpMethodsOnly,
-} from './create-server-workspace-store'
+} from './server'
 import fs from 'node:fs/promises'
 import { cwd } from 'node:process'
 import { allFilesMatch } from '../test/helpers'

package/dist/create-server-workspace-store.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"create-server-workspace-store.d.ts","sourceRoot":"","sources":["../src/create-server-workspace-store.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAIxD,OAAO,KAAK,EAAE,qBAAqB,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAGtF,eAAO,MAAM,mBAAmB,0BAA0B,CAAA;AAE1D,KAAK,0BAA0B,GAC3B;IACE,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,QAAQ,CAAA;IACd,SAAS,EAAE;QACT,IAAI,EAAE,MAAM,CAAA;QACZ,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAA;QAC1C,IAAI,CAAC,EAAE,qBAAqB,CAAA;KAC7B,EAAE,CAAA;IACH,IAAI,CAAC,EAAE,aAAa,CAAA;CACrB,GACD;IACE,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,KAAK,CAAA;IACX,SAAS,EAAE;QACT,IAAI,EAAE,MAAM,CAAA;QACZ,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAA;QAC1C,IAAI,CAAC,EAAE,qBAAqB,CAAA;KAC7B,EAAE,CAAA;IACH,IAAI,CAAC,EAAE,aAAa,CAAA;CACrB,CAAA;AAIL;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,WAAW,CAAC,WAAW,mCAsBnE;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,WAAW,CAAC,WAAW,mCAOzD;AAED;;GAEG;AACH,wBAAgB,8BAA8B,CAC5C,QAAQ,EAAE,WAAW,CAAC,QAAQ,EAC9B,IAAI,EAAE;IAAE,IAAI,EAAE,KAAK,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,uBAqB3G;AAED;;GAEG;AACH,wBAAgB,yBAAyB,CACvC,QAAQ,EAAE,WAAW,CAAC,QAAQ,EAC9B,IAAI,EAAE;IAAE,IAAI,EAAE,KAAK,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,uBAgC3G;AAED;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,cAAc,EAAE,0BAA0B;IAkDjF;;;;;;;;;;;OAWG;;IAwCH;;;;;;;;;;OAUG;;;;;;;;IAIH;;;;;;;;;;;;;;;;;OAiBG;mBACY,MAAM;IAGrB;;;;;;;;;;;OAWG;4BACqB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,QAAQ;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,qBAAqB;EAwBlG"}