feat(vision): allow specifying a default dataset

sanity-io · Aug 11, 2022 · 0f2cea4 · 0f2cea4
1 parent 32e4686
commit 0f2cea4
Show file tree

Hide file tree

Showing 7 changed files with 14 additions and 181 deletions.
diff --git a/dev/test-studio/package.json b/dev/test-studio/package.json
@@ -21,7 +21,7 @@
     "@sanity/ui-workshop": "^0.4.3",
     "@sanity/util": "3.0.0-dev-preview.12",
     "@sanity/uuid": "^3.0.1",
-    "@sanity/vision": "3.0.0-dev-preview.11",
+    "@sanity/vision": "3.0.0-dev-preview.12",
     "@turf/helpers": "^6.0.1",
     "@turf/points-within-polygon": "^5.1.5",
     "chokidar": "^3.5.3",

diff --git a/dev/test-studio/sanity.config.ts b/dev/test-studio/sanity.config.ts
@@ -59,7 +59,7 @@ const sharedSettings = createPlugin({
       ],
     }),
     visionTool({
-      defaultApiVersion: 'v1',
+      defaultApiVersion: '2022-08-08',
     }),
   ],
 })

diff --git a/packages/@sanity/vision/README.md b/packages/@sanity/vision/README.md
@@ -24,7 +24,9 @@ export default createConfig({
   // ...
   plugins: [
     vision({
+      // Note: These are both optional
       defaultApiVersion: 'v2021-10-21',
+      defaultDataset: 'some-dataset',
     }),
   ],
 })

diff --git a/packages/@sanity/vision/src/apiVersions.ts b/packages/@sanity/vision/src/apiVersions.ts
@@ -1,2 +1,2 @@
 export const API_VERSIONS = ['v1', 'vX', 'v2021-03-25', 'v2021-10-21']
-export const DEFAULT_API_VERSION = '2021-10-21'
+export const [DEFAULT_API_VERSION] = API_VERSIONS.slice(-1)
diff --git a/packages/@sanity/vision/src/components/VisionGui.tsx b/packages/@sanity/vision/src/components/VisionGui.tsx
@@ -141,20 +141,21 @@ export class VisionGui extends React.PureComponent<VisionGuiProps, VisionGuiStat
   constructor(props: VisionGuiProps) {
     super(props)
 
-    this._localStorage = getLocalStorage(props.client.config().projectId || 'default')
+    const {client, datasets, config} = props
+    this._localStorage = getLocalStorage(client.config().projectId || 'default')
 
     const lastQuery = this._localStorage.get('query', '')
     const lastParams = this._localStorage.get('params', '{\n  \n}')
 
-    const defaultDataset = props.client.config().dataset || props.datasets[0]
-    const defaultApiVersion = prefixApiVersion(`${props.config.defaultApiVersion}`)
+    const defaultDataset = config.defaultDataset || client.config().dataset || datasets[0]
+    const defaultApiVersion = prefixApiVersion(`${config.defaultApiVersion}`)
 
     let dataset = this._localStorage.get('dataset', defaultDataset)
     let apiVersion = this._localStorage.get('apiVersion', defaultApiVersion)
     const customApiVersion = API_VERSIONS.includes(apiVersion) ? false : apiVersion
 
-    if (!this.props.datasets.some((name) => name === dataset)) {
-      dataset = defaultDataset
+    if (!datasets.includes(dataset)) {
+      dataset = datasets.includes(defaultDataset) ? defaultDataset : datasets[0]
     }
 
     if (!API_VERSIONS.includes(apiVersion)) {

diff --git a/packages/@sanity/vision/src/types.ts b/packages/@sanity/vision/src/types.ts
@@ -8,6 +8,7 @@ export interface VisionProps {
 
 export interface VisionConfig {
   defaultApiVersion: string
+  defaultDataset?: string
 }
 
 export interface VisionToolConfig extends Partial<VisionConfig> {