@scalar/workspace-store 0.6.0 → 0.7.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @scalar/workspace-store
 
+## 0.7.0
+
+### Minor Changes
+
+- a05d638: feat(workspace-store): create types and validator for reference config schema
+- 8d8e427: feat(api-reference): load documents on the new store
+- dbbdd70: feat(workspace-store) add configuration mapping to the workspace store
+
+### Patch Changes
+
+- 23b150b: fix: export and fix up some types from workspace store
+- Updated dependencies [533469b]
+- Updated dependencies [23b150b]
+  - @scalar/openapi-types@0.3.4
+  - @scalar/helpers@0.0.5
+  - @scalar/openapi-parser@0.18.0
+  - @scalar/types@0.2.5
+  - @scalar/code-highlight@0.1.4
+
 ## 0.6.0
 
 ### Minor Changes

package/README.md

@@ -237,4 +237,50 @@ await store.addDocument({
 
 // Output: { openapi: 'x.x.x', ... }
 console.log(store.workspace.documents.default)
-```
+```
+
+#### Configuration
+
+You can pass configuration object to the workspace store which is going to be applied to all the documents
+
+```ts
+const store = createWorkspaceStore({
+  config: {
+    "x-scalar-reference-config": {
+      features: {
+        showModels: true,
+      },
+      appearance: {
+        layout: 'modern'
+      },
+    }
+  }
+})
+```
+
+You can override specific document configuration when you add the document to the store
+
+```ts
+store.addDocumentSync({
+  name: 'example',
+  document: {
+    openapi: '3.0.0',
+    info: { title: 'Example API', version: '1.0.0' },
+    paths: {},
+  },
+  config: {
+    features: {
+      showModels: false,
+    },
+  }
+})
+```
+
+To get the active document configuration you can use config getter\
+
+```ts
+// Get the configuration for the active document
+console.log(store.config['x-scalar-reference-config'].features.showModels)
+```
+
+When no configuration is provided it will return the default configuration