fix(structure): allow sanity.previewUrlSecret in document lists

Signed-off-by: Fred Carlsen <fred@sjelfull.no>
sanity-io · Feb 14, 2024 · 0fbdefc · 0fbdefc
1 parent 928eeec
commit 0fbdefc
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 6 deletions.
diff --git a/dev/test-studio/.depcheckignore.json b/dev/test-studio/.depcheckignore.json
@@ -2,10 +2,11 @@
   "//": "https://github.com/depcheck/depcheck/pull/756",
   "ignore": [
     "https:",
+    "@portabletext/react",
     "@sanity/client",
-    "@vercel/stega",
-    "@sanity/visual-editing",
+    "@sanity/preview-url-secret",
     "@sanity/react-loader",
-    "@portabletext/react"
+    "@sanity/visual-editing",
+    "@vercel/stega"
   ]
 }
diff --git a/dev/test-studio/package.json b/dev/test-studio/package.json
@@ -35,6 +35,7 @@
     "@sanity/logos": "^2.1.2",
     "@sanity/migrate": "3.29.0",
     "@sanity/portable-text-editor": "3.29.0",
+    "@sanity/preview-url-secret": "^1.6.1",
     "@sanity/react-loader": "^1.8.3",
     "@sanity/tsdoc": "1.0.0-alpha.38",
     "@sanity/types": "3.29.0",

diff --git a/dev/test-studio/plugins/router-debug/RouterDebug.tsx b/dev/test-studio/plugins/router-debug/RouterDebug.tsx
@@ -1,4 +1,6 @@
+import {createPreviewSecret} from '@sanity/preview-url-secret/create-secret'
 import {Button, Card, Code, Flex, Stack, Text} from '@sanity/ui'
+import {useClient} from 'sanity'
 import {IntentLink, RouteScope, StateLink, useRouter, useStateLink} from 'sanity/router'
 
 export function RouterDebug() {
@@ -11,10 +13,16 @@ export function RouterDebug() {
     },
   })
 
+  const client = useClient()
+
   return (
     <Card sizing="border" padding={5}>
       <Flex>
         <Stack space={4}>
+          <Button onClick={() => createPreviewSecret(client, 'test-studio', location.href)}>
+            Create Secret
+          </Button>
+
           <StateLink state={{}}>Tool home</StateLink>
           <StateLink
             state={{

diff --git a/dev/test-studio/sanity.config.ts b/dev/test-studio/sanity.config.ts
@@ -7,6 +7,7 @@ import {nnNOLocale} from '@sanity/locale-nn-no'
 import {ptPTLocale} from '@sanity/locale-pt-pt'
 import {svSELocale} from '@sanity/locale-sv-se'
 import {SanityMonogram} from '@sanity/logos'
+import {debugSecrets} from '@sanity/preview-url-secret/sanity-plugin-debug-secrets'
 import {tsdoc} from '@sanity/tsdoc/studio'
 import {visionTool} from '@sanity/vision'
 import {defineConfig, definePlugin} from 'sanity'
@@ -284,6 +285,7 @@ export default defineConfig([
     projectId: 'ppsg7ml5',
     dataset: 'playground',
     plugins: [
+      debugSecrets(),
       presentationTool({
         previewUrl: '/preview/index.html',
       }),

diff --git a/packages/sanity/src/core/search/common/utils.ts b/packages/sanity/src/core/search/common/utils.ts
@@ -5,7 +5,8 @@ import {isNonNullable} from '../../util/isNonNullable'
 const isDocumentType = (type: SchemaType): type is ObjectSchemaType =>
   Boolean(type.type && type.type.name === 'document')
 
-const isSanityType = (type: SchemaType): boolean => type.name.startsWith('sanity.')
+const isIgnoredType = (type: SchemaType): boolean =>
+  type.name.startsWith('sanity.') && type.name !== 'sanity.previewUrlSecret'
 
 /**
  * @internal
@@ -16,4 +17,4 @@ export const getSearchableTypes = (schema: Schema): ObjectSchemaType[] =>
     .map((typeName) => schema.get(typeName))
     .filter(isNonNullable)
     .filter((schemaType) => isDocumentType(schemaType))
-    .filter((type) => !isSanityType(type)) as ObjectSchemaType[]
+    .filter((type) => !isIgnoredType(type)) as ObjectSchemaType[]
diff --git a/packages/sanity/src/structure/panes/documentList/listenSearchQuery.ts b/packages/sanity/src/structure/panes/documentList/listenSearchQuery.ts
@@ -90,7 +90,7 @@ export function listenSearchQuery(options: ListenQueryOptions): Observable<Sanit
         mergeMap((typeNames: string[]) => {
           const types = getSearchTypesWithMaxDepth(
             getSearchableTypes(schema).filter((type) => {
-              return typeNames.includes(type.name) || type.name === 'sanity.previewUrlSecret'
+              return typeNames.includes(type.name)
             }),
             maxFieldDepth,
           )