@sanity/vercel-protection-bypass 3.0.0 → 3.1.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @sanity/vercel-protection-bypass
 
+## 3.1.0
+
+### Minor Changes
+
+- [`d090d93`](https://github.com/sanity-io/plugins/commit/d090d939e29a2aa46ccf1e1f18a63eb383630bdd) Thanks [@stipsan](https://github.com/stipsan)! - Add schema type for debugging
+
+### Patch Changes
+
+- [`4f82b31`](https://github.com/sanity-io/plugins/commit/4f82b3120b3006821a74f444589ac3e752475c4e) Thanks [@stipsan](https://github.com/stipsan)! - Stop publishing src folder to npm
+
 ## 3.0.0
 
 ### Major Changes

package/dist/index.js

@@ -1,22 +1,54 @@
 import { lazy } from "react";
-import { definePlugin } from "sanity";
+import { definePlugin, defineType } from "sanity";
+import { LockIcon, CheckmarkCircleIcon, CloseCircleIcon } from "@sanity/icons";
+import { vercelProtectionBypassSchemaType } from "@sanity/preview-url-secret/constants";
 const id = "vercel-protection-bypass", vercelProtectionBypassTool = definePlugin((options) => {
   const {
-    name,
-    title,
-    icon,
+    name = "vercel-protection-bypass",
+    title = "Vercel Protection Bypass",
+    icon = LockIcon,
     ...config
   } = options || {};
   return {
     name: `@sanity/preview-url-secret/${id}`,
     tools: [{
-      name: name || "vercel-protection-bypass",
-      title: title || "Vercel Protection Bypass",
+      name,
+      title,
       icon,
       component: lazy(() => import("./_chunks-es/VercelProtectionBypassTool.js")),
       options: config,
       __internalApplicationType: `sanity/${id}`
-    }]
+    }],
+    document: {
+      actions: (prev, context) => context.schemaType !== vercelProtectionBypassSchemaType ? prev : []
+    },
+    schema: {
+      types: [defineType({
+        type: "document",
+        icon: LockIcon,
+        name: vercelProtectionBypassSchemaType,
+        title,
+        readOnly: !0,
+        fields: [{
+          type: "string",
+          name: "secret",
+          title: "Secret"
+        }],
+        preview: {
+          select: {
+            secret: "secret"
+          },
+          prepare(data) {
+            const enabled = data.secret !== null;
+            return {
+              title: enabled ? "Enabled" : "Disabled",
+              subtitle: title,
+              media: enabled ? CheckmarkCircleIcon : CloseCircleIcon
+            };
+          }
+        }
+      })]
+    }
   };
 });
 export {

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":["import {lazy} from 'react'\nimport {definePlugin} from 'sanity'\n\nconst id = 'vercel-protection-bypass'\n\nexport interface VercelProtectionBypassConfig {\n  name?: string\n  title?: string\n  icon?: React.ComponentType\n}\n\nexport const vercelProtectionBypassTool = definePlugin<VercelProtectionBypassConfig | void>(\n  (options) => {\n    const {name, title, icon, ...config} = options || {}\n    return {\n      name: `@sanity/preview-url-secret/${id}`,\n      tools: [\n        {\n          name: name || 'vercel-protection-bypass',\n          title: title || 'Vercel Protection Bypass',\n          icon: icon,\n          component: lazy(() => import('./VercelProtectionBypassTool')),\n          options: config,\n          __internalApplicationType: `sanity/${id}`,\n        },\n      ],\n    }\n  },\n)\n"],"names":["id","vercelProtectionBypassTool","definePlugin","options","name","title","icon","config","tools","component","lazy","__internalApplicationType"],"mappings":";;AAGA,MAAMA,KAAK,4BAQEC,6BAA6BC,aACvCC,CAAAA,YAAY;AACX,QAAM;AAAA,IAACC;AAAAA,IAAMC;AAAAA,IAAOC;AAAAA,IAAM,GAAGC;AAAAA,EAAAA,IAAUJ,WAAW,CAAA;AAClD,SAAO;AAAA,IACLC,MAAM,8BAA8BJ,EAAE;AAAA,IACtCQ,OAAO,CACL;AAAA,MACEJ,MAAMA,QAAQ;AAAA,MACdC,OAAOA,SAAS;AAAA,MAChBC;AAAAA,MACAG,WAAWC,KAAK,MAAM,OAAO,4CAA8B,CAAC;AAAA,MAC5DP,SAASI;AAAAA,MACTI,2BAA2B,UAAUX,EAAE;AAAA,IAAA,CACxC;AAAA,EAAA;AAGP,CACF;"}
+{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":["import {lazy} from 'react'\nimport {definePlugin, defineType} from 'sanity'\n\nimport {CheckmarkCircleIcon, CloseCircleIcon, LockIcon} from '@sanity/icons'\nimport {\n  vercelProtectionBypassSchemaId as _id,\n  vercelProtectionBypassSchemaType as type,\n} from '@sanity/preview-url-secret/constants'\n\nconst id = 'vercel-protection-bypass'\n\nexport interface VercelProtectionBypassConfig {\n  name?: string\n  title?: string\n  icon?: React.ComponentType\n}\n\nexport const vercelProtectionBypassTool = definePlugin<VercelProtectionBypassConfig | void>(\n  (options) => {\n    const {\n      name = 'vercel-protection-bypass',\n      title = 'Vercel Protection Bypass',\n      icon = LockIcon,\n      ...config\n    } = options || {}\n    return {\n      name: `@sanity/preview-url-secret/${id}`,\n      tools: [\n        {\n          name,\n          title,\n          icon: icon,\n          component: lazy(() => import('./VercelProtectionBypassTool')),\n          options: config,\n          __internalApplicationType: `sanity/${id}`,\n        },\n      ],\n      document: {\n        actions: (prev, context) => {\n          if (context.schemaType !== type) {\n            return prev\n          }\n          return []\n        },\n      },\n      schema: {\n        types: [\n          defineType({\n            type: 'document',\n            icon: LockIcon,\n            name: type,\n            title,\n            readOnly: true,\n            fields: [\n              {\n                type: 'string',\n                name: 'secret',\n                title: 'Secret',\n              },\n            ],\n            preview: {\n              select: {\n                secret: 'secret',\n              },\n              prepare(data) {\n                const enabled = data['secret'] !== null\n                return {\n                  title: enabled ? 'Enabled' : 'Disabled',\n                  subtitle: title,\n                  media: enabled ? CheckmarkCircleIcon : CloseCircleIcon,\n                }\n              },\n            },\n          }),\n        ],\n      },\n    }\n  },\n)\n"],"names":["id","vercelProtectionBypassTool","definePlugin","options","name","title","icon","LockIcon","config","tools","component","lazy","__internalApplicationType","document","actions","prev","context","schemaType","type","schema","types","defineType","readOnly","fields","preview","select","secret","prepare","data","enabled","subtitle","media","CheckmarkCircleIcon","CloseCircleIcon"],"mappings":";;;;AASA,MAAMA,KAAK,4BAQEC,6BAA6BC,aACvCC,CAAAA,YAAY;AACX,QAAM;AAAA,IACJC,OAAO;AAAA,IACPC,QAAQ;AAAA,IACRC,OAAOC;AAAAA,IACP,GAAGC;AAAAA,EAAAA,IACDL,WAAW,CAAA;AACf,SAAO;AAAA,IACLC,MAAM,8BAA8BJ,EAAE;AAAA,IACtCS,OAAO,CACL;AAAA,MACEL;AAAAA,MACAC;AAAAA,MACAC;AAAAA,MACAI,WAAWC,KAAK,MAAM,OAAO,4CAA8B,CAAC;AAAA,MAC5DR,SAASK;AAAAA,MACTI,2BAA2B,UAAUZ,EAAE;AAAA,IAAA,CACxC;AAAA,IAEHa,UAAU;AAAA,MACRC,SAASA,CAACC,MAAMC,YACVA,QAAQC,eAAeC,mCAClBH,OAEF,CAAA;AAAA,IAAA;AAAA,IAGXI,QAAQ;AAAA,MACNC,OAAO,CACLC,WAAW;AAAA,QACTH,MAAM;AAAA,QACNZ,MAAMC;AAAAA,QACNH,MAAMc;AAAAA,QACNb;AAAAA,QACAiB,UAAU;AAAA,QACVC,QAAQ,CACN;AAAA,UACEL,MAAM;AAAA,UACNd,MAAM;AAAA,UACNC,OAAO;AAAA,QAAA,CACR;AAAA,QAEHmB,SAAS;AAAA,UACPC,QAAQ;AAAA,YACNC,QAAQ;AAAA,UAAA;AAAA,UAEVC,QAAQC,MAAM;AACZ,kBAAMC,UAAUD,KAAK,WAAc;AACnC,mBAAO;AAAA,cACLvB,OAAOwB,UAAU,YAAY;AAAA,cAC7BC,UAAUzB;AAAAA,cACV0B,OAAOF,UAAUG,sBAAsBC;AAAAA,YAAAA;AAAAA,UAE3C;AAAA,QAAA;AAAA,MACF,CACD,CAAC;AAAA,IAAA;AAAA,EAEN;AAEJ,CACF;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/vercel-protection-bypass",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "homepage": "https://github.com/sanity-io/plugins/tree/main/packages/%40sanity/vercel-protection-bypass#readme",
   "bugs": {
     "url": "https://github.com/sanity-io/plugins/issues"
@@ -29,9 +29,6 @@
   "types": "./dist/index.d.ts",
   "files": [
     "dist",
-    "src",
-    "!src/**/*.test.ts",
-    "!src/**/*.test-d.ts",
     "CHANGELOG.md"
   ],
   "dependencies": {
@@ -43,11 +40,12 @@
   "devDependencies": {
     "@sanity/pkg-utils": "^9.1.1",
     "@types/react": "^19.2.6",
-    "@typescript/native-preview": "7.0.0-dev.20251117.1",
+    "@typescript/native-preview": "7.0.0-dev.20251118.1",
     "babel-plugin-react-compiler": "^1.0.0",
     "react": "^19.2.0",
-    "sanity": "^4.16.0",
-    "typescript": "5.9.3"
+    "sanity": "^4.17.0",
+    "typescript": "5.9.3",
+    "@repo/package.config": "0.0.0"
   },
   "peerDependencies": {
     "react": "^18.3 || ^19",
@@ -60,7 +58,7 @@
     "access": "public"
   },
   "scripts": {
-    "typecheck": "(cd ../../.. && tsgo --project packages/@sanity/vercel-protection-bypass/tsconfig.json)",
+    "typecheck": "(cd ../../.. && tsgo --project plugins/@sanity/vercel-protection-bypass/tsconfig.json)",
     "build": "pkg build --strict --check --clean"
   }
 }

package/src/VercelProtectionBypassTool.tsx

@@ -1,275 +0,0 @@
-import {useEffect, useReducer} from 'react'
-import {useClient, type SanityClient} from 'sanity'
-
-import {AddIcon, TrashIcon} from '@sanity/icons'
-import {apiVersion} from '@sanity/preview-url-secret/constants'
-import {
-  vercelProtectionBypassSchemaId as _id,
-  vercelProtectionBypassSchemaType as _type,
-  tag,
-} from '@sanity/preview-url-secret/constants'
-import {subscribeToVercelProtectionBypass} from '@sanity/preview-url-secret/toggle-vercel-protection-bypass'
-import {Box, Button, Card, Dialog, Heading, Stack, Text, TextInput, useToast} from '@sanity/ui'
-
-interface State {
-  status:
-    | 'loading'
-    | 'disabled'
-    | 'add-secret-dialog'
-    | 'adding-secret'
-    | 'enabled'
-    | 'removing-secret'
-}
-type Action =
-  | {type: 'add-secret'}
-  | {type: 'save-secret'}
-  | {type: 'cancel-add-secret'}
-  | {type: 'failed-add-secret'}
-  | {type: 'saved-secret'}
-  | {type: 'remove-secret'}
-  | {type: 'failed-remove-secret'}
-  | {type: 'removed-secret'}
-
-function reducer(prevState: State, action: Action): State {
-  switch (action.type) {
-    case 'removed-secret':
-      return {...prevState, status: 'disabled'}
-    case 'remove-secret':
-      return {...prevState, status: 'removing-secret'}
-    case 'saved-secret':
-      return {...prevState, status: 'enabled'}
-    case 'save-secret':
-      return {...prevState, status: 'adding-secret'}
-    case 'cancel-add-secret':
-      return {...prevState, status: 'disabled'}
-    case 'add-secret':
-      return {...prevState, status: 'add-secret-dialog'}
-    case 'failed-remove-secret':
-      return {...prevState, status: 'enabled'}
-    case 'failed-add-secret':
-      return {...prevState, status: 'add-secret-dialog'}
-    default:
-      return prevState
-  }
-}
-
-async function enableVercelProtectionBypass(client: SanityClient, secret: string): Promise<void> {
-  const patch = client.patch(_id).set({secret})
-  await client.transaction().createIfNotExists({_id, _type}).patch(patch).commit({tag})
-}
-
-async function disableVercelProtectionBypass(client: SanityClient): Promise<void> {
-  const patch = client.patch(_id).set({secret: null})
-  await client.transaction().createIfNotExists({_id, _type}).patch(patch).commit({tag})
-}
-
-export default function VercelProtectionBypassTool(): React.JSX.Element {
-  const client = useClient({apiVersion: apiVersion})
-  const {push: pushToast} = useToast()
-  const [state, dispatch] = useReducer(reducer, {status: 'loading'})
-  const adding = state.status === 'adding-secret'
-  const removing = state.status === 'removing-secret'
-
-  const handleEnable = (secret: string) => {
-    dispatch({type: 'save-secret'})
-    enableVercelProtectionBypass(client, secret)
-      .then(() => {
-        dispatch({type: 'saved-secret'})
-        pushToast({
-          status: 'success',
-          title: 'Protection bypass is now enabled',
-        })
-      })
-      .catch((reason) => {
-        // eslint-disable-next-line no-console
-        console.error(reason)
-        pushToast({
-          status: 'error',
-          title:
-            'There was an error when trying to enable protection bypass. See the browser console for more information.',
-        })
-        dispatch({type: 'failed-add-secret'})
-      })
-  }
-
-  useEffect(() => {
-    const unsubscribe = subscribeToVercelProtectionBypass(client, (secret) =>
-      dispatch({type: secret ? 'saved-secret' : 'removed-secret'}),
-    )
-    return () => unsubscribe()
-  }, [client])
-
-  const enabled = state.status === 'enabled' || removing
-
-  return (
-    <>
-      <Box
-        sizing="border"
-        display="flex"
-        style={{
-          height: '100%',
-          alignItems: 'center',
-          justifyContent: 'center',
-          flexDirection: 'column',
-        }}
-      >
-        <Stack space={5}>
-          <Card padding={4} style={{maxWidth: 640}}>
-            <Stack space={4} style={{justifyItems: 'flex-start', textWrap: 'pretty'}}>
-              <Heading>Vercel Protection Bypass</Heading>
-              {enabled ? (
-                <>
-                  <Box>
-                    <Text style={{textWrap: 'pretty'}}>
-                      Sanity Presentation is setup to use{' '}
-                      <a
-                        href="https://vercel.com/docs/security/deployment-protection/methods-to-bypass-deployment-protection/protection-bypass-automation"
-                        target="_blank"
-                        rel="noreferrer"
-                      >
-                        protection bypass for automation
-                      </a>{' '}
-                      in order to display protected deployments in its preview iframe for the
-                      current Sanity dataset.
-                    </Text>
-                  </Box>
-                  <Box>
-                    <Text>
-                      You can turn off automatic protection bypass at any time by clicking the
-                      button below.
-                    </Text>
-                  </Box>
-                  <Button
-                    mode="ghost"
-                    tone="critical"
-                    icon={<TrashIcon />}
-                    loading={removing}
-                    onClick={() => {
-                      dispatch({type: 'remove-secret'})
-                      disableVercelProtectionBypass(client)
-                        .then(() => {
-                          pushToast({
-                            status: 'warning',
-                            title: 'Protection bypass is now disabled',
-                          })
-                          dispatch({type: 'removed-secret'})
-                        })
-                        .catch((reason) => {
-                          // eslint-disable-next-line no-console
-                          console.error(reason)
-                          pushToast({
-                            status: 'error',
-                            title:
-                              'There was an error when trying to disable protection bypass. See the browser console for more information.',
-                          })
-                          dispatch({type: 'failed-remove-secret'})
-                        })
-                    }}
-                    text="Remove secret"
-                  />
-                  <Text>
-                    Protection bypass remains enabled if this plugin is removed from your Sanity
-                    config.
-                  </Text>
-                </>
-              ) : (
-                <>
-                  <Box>
-                    <Text style={{textWrap: 'pretty'}}>
-                      Follow the instructions on{' '}
-                      <a
-                        href="https://vercel.com/docs/security/deployment-protection/methods-to-bypass-deployment-protection/protection-bypass-automation"
-                        target="_blank"
-                        rel="noreferrer"
-                      >
-                        how to enable protection bypass for automation
-                      </a>
-                      .
-                    </Text>
-                  </Box>
-                  <Box>
-                    <Text>
-                      This will setup a secret that Vercel exposes as an environment variable called
-                      VERCEL_AUTOMATION_BYPASS_SECRET, its value is the secret you need.
-                    </Text>
-                  </Box>
-                  <Button
-                    mode="ghost"
-                    icon={<AddIcon />}
-                    loading={state.status === 'loading'}
-                    onClick={() => {
-                      dispatch({type: 'add-secret'})
-                    }}
-                    text="Add secret"
-                  />
-                  <Text>
-                    If you&apos;re using Sanity Presentation Tool with multiple protected
-                    deployments ensure that they have the same secret set, as this tool will set a
-                    secret that is shared in your dataset with all instances of Presentation Tool.
-                  </Text>
-                </>
-              )}
-            </Stack>
-          </Card>
-        </Stack>
-      </Box>
-      {(state.status === 'add-secret-dialog' || state.status === 'adding-secret') && (
-        <Dialog
-          animate
-          id="add-secret-dialog"
-          onClickOutside={() => dispatch({type: 'cancel-add-secret'})}
-        >
-          <Card padding={3}>
-            <form
-              onSubmit={(event) => {
-                event.preventDefault()
-                event.currentTarget.reportValidity()
-                const formData = new FormData(event.currentTarget)
-                const secret = formData.get('secret') as string
-                if (secret) handleEnable(secret)
-              }}
-            >
-              <Stack space={3}>
-                <Stack space={2}>
-                  <Text as="label" weight="semibold" size={1}>
-                    Add bypass secret
-                  </Text>
-                  <Text muted size={1}>
-                    {`Make sure it's the same secret the Vercel deployment is using that's loaded in the preview iframe.`}
-                  </Text>
-                  <TextInput
-                    name="secret"
-                    onFocus={(event) => {
-                      event.currentTarget.setCustomValidity('')
-                    }}
-                    onBlur={(event) => {
-                      event.currentTarget.setCustomValidity(
-                        event.currentTarget.value.length == 32
-                          ? ''
-                          : 'Secret must be 32 characters long',
-                      )
-                      event.currentTarget.required = true
-                    }}
-                    minLength={32}
-                    maxLength={32}
-                    autoComplete="off"
-                    autoCapitalize="off"
-                    autoCorrect="off"
-                    spellCheck="false"
-                    disabled={adding}
-                  />
-                </Stack>
-                <Button
-                  type="submit"
-                  loading={adding}
-                  text={adding ? 'Saving…' : 'Save'}
-                  tone="positive"
-                />
-              </Stack>
-            </form>
-          </Card>
-        </Dialog>
-      )}
-    </>
-  )
-}

package/src/index.ts

@@ -1,29 +0,0 @@
-import {lazy} from 'react'
-import {definePlugin} from 'sanity'
-
-const id = 'vercel-protection-bypass'
-
-export interface VercelProtectionBypassConfig {
-  name?: string
-  title?: string
-  icon?: React.ComponentType
-}
-
-export const vercelProtectionBypassTool = definePlugin<VercelProtectionBypassConfig | void>(
-  (options) => {
-    const {name, title, icon, ...config} = options || {}
-    return {
-      name: `@sanity/preview-url-secret/${id}`,
-      tools: [
-        {
-          name: name || 'vercel-protection-bypass',
-          title: title || 'Vercel Protection Bypass',
-          icon: icon,
-          component: lazy(() => import('./VercelProtectionBypassTool')),
-          options: config,
-          __internalApplicationType: `sanity/${id}`,
-        },
-      ],
-    }
-  },
-)