@liiift-studio/deploy-vercel-from-sanity 1.0.8 → 1.0.9

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Liiift Studio
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -6,7 +6,7 @@
 [![Sanity v3/v4/v5](https://img.shields.io/badge/sanity-v3%20%7C%20v4%20%7C%20v5-f03e2f)](https://www.sanity.io)
 [![License: MIT](https://img.shields.io/badge/license-MIT-blue)](./LICENSE)
 
-![Deploy with Vercel — Production and Preview targets with live status](./docs/screenshot.png)
+![The Deploy tool inside Sanity Studio — Production and Preview targets each showing a live status badge, branch, commit SHA, deploy author, and a one-click Deploy button](https://raw.githubusercontent.com/Liiift-Studio/Deploy-Vercel-from-Sanity/main/docs/screenshot.png?v=1)
 
 ---
 
@@ -119,6 +119,28 @@ tools: (prev, { currentUser }) => {
 
 ## How it works
 
+```mermaid
+flowchart LR
+    subgraph studio["Sanity Studio"]
+        tool["Deploy tool"]
+    end
+    subgraph dataset["Sanity dataset"]
+        targets["vercel_deploy docs<br/>(deploy targets)"]
+        cfg["config.vercelDeploy doc<br/>(API token)"]
+    end
+    subgraph vercel["Vercel"]
+        hook["Deploy hook<br/>POST /v1/integrations/deploy/…"]
+        api["REST API<br/>/v6/deployments · /v2/.../events"]
+    end
+
+    tool -- "reads targets + token" --> targets
+    tool -- "reads token" --> cfg
+    tool -- "1 - click Deploy" --> hook
+    hook -- "queues a build" --> api
+    api -- "poll every 5s while active" --> tool
+    tool -. "toast on Ready / Error / Canceled" .-> tool
+```
+
 1. Deploy targets are stored as `vercel_deploy` documents in your Sanity dataset.
 2. The plugin fetches the last 10 deployments for each target from the Vercel API, filtered to those triggered by that hook.
 3. While a deployment is active (Queued / Initializing / Building), it polls every 5 seconds.
@@ -164,7 +186,7 @@ If "No stderr or stdout was captured" appears, the build may have failed before
 
 ## Security
 
-**API token storage** — The Vercel API token is stored in a `config.vercelDeploy` Sanity document, readable by all authenticated studio users. Audit who has access to your Sanity project at sanity.io → Project → Members. If your studio includes untrusted editors, consider a server-side proxy that holds the token and exposes only a scoped deploy endpoint.
+**API token storage** — The Vercel API token is stored in a `config.vercelDeploy` Sanity document, readable by all authenticated studio users. Note that a **Full Account** scoped token can read and write your entire Vercel account, so anyone with studio access can read a credential that grants broad Vercel access — treat the token accordingly. Audit who has access to your Sanity project at sanity.io → Project → Members. If your studio includes untrusted editors, consider a server-side proxy that holds the token and exposes only a scoped deploy endpoint.
 
 **Deploy hook URL validation** — `triggerDeploy` validates that the hook URL matches `api.vercel.com/v1/integrations/deploy/` before making the request, preventing SSRF from a tampered document.
 
@@ -180,12 +202,16 @@ If "No stderr or stdout was captured" appears, the build may have failed before
 - React 18 or 19
 - A Vercel account with at least one project and a deploy hook configured
 
+Zero runtime dependencies — `react` and `sanity` are peer dependencies provided by your Studio; the plugin ships nothing else.
+
 ---
 
 ## Contributing
 
 Issues and pull requests welcome at [github.com/Liiift-Studio/Deploy-Vercel-from-Sanity](https://github.com/Liiift-Studio/Deploy-Vercel-from-Sanity).
 
+Local development, `npm link`, and publishing steps are documented in [SETUP.md](./SETUP.md).
+
 ---
 
 ## License

package/dist/index.d.mts

@@ -66,7 +66,7 @@ declare const vercelDeploySchema: {
  *
  * @example
  * // sanity.config.ts
- * import { vercelDeploy } from 'deploy-vercel-from-sanity'
+ * import { vercelDeploy } from '@liiift-studio/deploy-vercel-from-sanity'
  *
  * export default defineConfig({
  *   plugins: [

package/dist/index.d.ts

@@ -66,7 +66,7 @@ declare const vercelDeploySchema: {
  *
  * @example
  * // sanity.config.ts
- * import { vercelDeploy } from 'deploy-vercel-from-sanity'
+ * import { vercelDeploy } from '@liiift-studio/deploy-vercel-from-sanity'
  *
  * export default defineConfig({
  *   plugins: [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@liiift-studio/deploy-vercel-from-sanity",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "description": "Sanity Studio plugin — trigger and monitor Vercel deployments with full status, history, and build logs. Supports v3, v4, and v5.",
   "license": "MIT",
   "author": "Liiift Studio",

package/src/index.ts

@@ -13,7 +13,7 @@ export type { VercelDeployPluginConfig, DeployTarget, VercelDeployment, VercelDe
  *
  * @example
  * // sanity.config.ts
- * import { vercelDeploy } from 'deploy-vercel-from-sanity'
+ * import { vercelDeploy } from '@liiift-studio/deploy-vercel-from-sanity'
  *
  * export default defineConfig({
  *   plugins: [