npm - @sanity/debug-preview-url-secret-plugin - Versions diffs - 0.0.1 → 1.0.0 - Mend

@sanity/debug-preview-url-secret-plugin 0.0.1 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

package/CHANGELOG.md ADDED Viewed

@@ -0,0 +1,7 @@
+# @sanity/debug-preview-url-secret-plugin
+## 1.0.0
+### Major Changes
+- [#37](https://github.com/sanity-io/plugins/pull/37) [`004bf6a`](https://github.com/sanity-io/plugins/commit/004bf6a7edf74cd45fd1dc499ff9f48b64c19712) Thanks [@stipsan](https://github.com/stipsan)! - Initial release of `@sanity/debug-preview-url-secret-plugin`, which replaces `@sanity/preview-url-secret/sanity-plugin-debug-secrets`.

package/LICENSE ADDED Viewed

@@ -0,0 +1,21 @@
+MIT License
+Copyright (c) 2025 Sanity
+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 CHANGED Viewed

@@ -1,45 +1,42 @@
 # @sanity/debug-preview-url-secret-plugin
-## ⚠️ IMPORTANT NOTICE ⚠️
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
-## Purpose
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@sanity/debug-preview-url-secret-plugin`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
-## What is OIDC Trusted Publishing?
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
-## Setup Instructions
-To properly configure OIDC trusted publishing for this package:
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
-## DO NOT USE THIS PACKAGE
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
-## More Information
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
----
-**Maintained for OIDC setup purposes only**
+[![npm stat](https://img.shields.io/npm/dm/@sanity/debug-preview-url-secret-plugin.svg?style=flat-square)](https://npm-stat.com/charts.html?package=@sanity/debug-preview-url-secret-plugin)
+[![npm version](https://img.shields.io/npm/v/@sanity/debug-preview-url-secret-plugin.svg?style=flat-square)](https://www.npmjs.com/package/@sanity/debug-preview-url-secret-plugin)
+```sh
+npm install @sanity/debug-preview-url-secret-plugin
+```
+This package is used together with [`sanity/presentation`] to debug URL preview secrets and their status.
+Add the plugin to your `sanity.config.ts`:
+```ts
+// ./sanity.config.ts
+import { debugSecrets } from "@sanity/debug-preview-url-secret-plugin";
+import { defineConfig } from "sanity";
+import { structureTool } from "sanity/structure";
+import { presentationTool } from "sanity/presentation";
+export default defineConfig({
+  // ... other options
+  plugins: [
+    // ... other plugins
+    structureTool(),
+    presentationTool({
+      previewUrl: {
+        // @TODO change to the URL of the application, or `location.origin` if it's an embedded Studio
+        origin: "http://localhost:3000",
+        previewMode: {
+          enable: "/api/draft",
+        },
+      },
+    }),
+    debugSecrets(),
+  ],
+});
+```
+You should see a new `@sanity/preview-url-secret` type in Structure Tool, which lists out secrets with metadata about when they were created and in what context.
+[`sanity/presentation`]: https://www.sanity.io/docs/visual-editing/configuring-the-presentation-tool

package/dist/index.d.ts ADDED Viewed

@@ -0,0 +1,3 @@
+import * as sanity0 from "sanity";
+declare const debugSecrets: sanity0.Plugin<void>;
+export { debugSecrets };

package/dist/index.js ADDED Viewed

@@ -0,0 +1,63 @@
+import { definePlugin, defineType } from "sanity";
+import { LockIcon, CloseCircleIcon, CheckmarkCircleIcon } from "@sanity/icons";
+import { schemaType, SECRET_TTL } from "@sanity/preview-url-secret/constants";
+const debugSecrets = definePlugin(() => ({
+  name: "sanity-plugin-debug-secrets",
+  schema: {
+    types: [
+      defineType({
+        type: "document",
+        icon: LockIcon,
+        name: schemaType,
+        title: "@sanity/preview-url-secret",
+        readOnly: !0,
+        fields: [
+          {
+            type: "string",
+            name: "secret",
+            title: "Secret"
+          },
+          {
+            type: "string",
+            name: "source",
+            title: "Source Tool"
+          },
+          {
+            type: "string",
+            name: "studioUrl",
+            title: "Studio URL"
+          },
+          {
+            type: "string",
+            name: "userId",
+            title: "Sanity User ID"
+          }
+        ],
+        preview: {
+          select: {
+            source: "source",
+            studioUrl: "studioUrl",
+            updatedAt: "_updatedAt"
+          },
+          prepare(data) {
+            const url = data.studioUrl ? new URL(data.studioUrl, location.origin) : void 0, updatedAt = new Date(data.updatedAt).getTime(), expiresAt = new Date(updatedAt + 1e3 * SECRET_TTL), expired = expiresAt < /* @__PURE__ */ new Date(), icon = expired ? CloseCircleIcon : CheckmarkCircleIcon;
+            return {
+              title: url ? `${url.host}${url.pathname}` : data.source,
+              subtitle: expired ? "Expired" : `Expires in ${Math.round((expiresAt.getTime() - Date.now()) / (1e3 * 60))} minutes`,
+              media: icon
+            };
+          }
+        }
+      })
+    ]
+  },
+  document: {
+    actions: (prev, context) => context.schemaType !== schemaType ? prev : prev.filter(({ action }) => action === "delete"),
+    inspectors: (prev, context) => context.documentType !== schemaType ? prev : [],
+    unstable_fieldActions: (prev, context) => context.schemaType.name !== schemaType ? prev : []
+  }
+}));
+export {
+  debugSecrets
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":["import {definePlugin, defineType} from 'sanity'\n\nimport {CheckmarkCircleIcon, CloseCircleIcon, LockIcon} from '@sanity/icons'\nimport {schemaType, SECRET_TTL} from '@sanity/preview-url-secret/constants'\n\nexport const debugSecrets = definePlugin<void>(() => {\n return {\n name: 'sanity-plugin-debug-secrets',\n schema: {\n types: [\n defineType({\n type: 'document',\n icon: LockIcon,\n name: schemaType,\n title: '@sanity/preview-url-secret',\n readOnly: true,\n fields: [\n {\n type: 'string',\n name: 'secret',\n title: 'Secret',\n },\n {\n type: 'string',\n name: 'source',\n title: 'Source Tool',\n },\n {\n type: 'string',\n name: 'studioUrl',\n title: 'Studio URL',\n },\n {\n type: 'string',\n name: 'userId',\n title: 'Sanity User ID',\n },\n ],\n preview: {\n select: {\n source: 'source',\n studioUrl: 'studioUrl',\n updatedAt: '_updatedAt',\n },\n prepare(data) {\n const url = data['studioUrl']\n ? new URL(data['studioUrl'], location.origin)\n : undefined\n const updatedAt = new Date(data['updatedAt']).getTime()\n const expiresAt = new Date(updatedAt + 1000 * SECRET_TTL)\n const expired = expiresAt < new Date()\n const icon = expired ? CloseCircleIcon : CheckmarkCircleIcon\n return {\n title: url ? `${url.host}${url.pathname}` : data['source'],\n subtitle: expired\n ? 'Expired'\n : `Expires in ${Math.round((expiresAt.getTime() - Date.now()) / (1000 * 60))} minutes`,\n media: icon,\n }\n },\n },\n }),\n ],\n },\n document: {\n actions: (prev, context) => {\n if (context.schemaType !== schemaType) {\n return prev\n }\n return prev.filter(({action}) => action === 'delete')\n },\n inspectors: (prev, context) => {\n if (context.documentType !== schemaType) {\n return prev\n }\n return []\n },\n unstable_fieldActions: (prev, context) => {\n if (context.schemaType.name !== schemaType) {\n return prev\n }\n return []\n },\n },\n }\n})\n"],"names":[],"mappings":";;;AAKO,MAAM,eAAe,aAAmB,OACtC;AAAA,EACL,MAAM;AAAA,EACN,QAAQ;AAAA,IACN,OAAO;AAAA,MACL,WAAW;AAAA,QACT,MAAM;AAAA,QACN,MAAM;AAAA,QACN,MAAM;AAAA,QACN,OAAO;AAAA,QACP,UAAU;AAAA,QACV,QAAQ;AAAA,UACN;AAAA,YACE,MAAM;AAAA,YACN,MAAM;AAAA,YACN,OAAO;AAAA,UAAA;AAAA,UAET;AAAA,YACE,MAAM;AAAA,YACN,MAAM;AAAA,YACN,OAAO;AAAA,UAAA;AAAA,UAET;AAAA,YACE,MAAM;AAAA,YACN,MAAM;AAAA,YACN,OAAO;AAAA,UAAA;AAAA,UAET;AAAA,YACE,MAAM;AAAA,YACN,MAAM;AAAA,YACN,OAAO;AAAA,UAAA;AAAA,QACT;AAAA,QAEF,SAAS;AAAA,UACP,QAAQ;AAAA,YACN,QAAQ;AAAA,YACR,WAAW;AAAA,YACX,WAAW;AAAA,UAAA;AAAA,UAEb,QAAQ,MAAM;AACZ,kBAAM,MAAM,KAAK,YACb,IAAI,IAAI,KAAK,WAAc,SAAS,MAAM,IAC1C,QACE,YAAY,IAAI,KAAK,KAAK,SAAY,EAAE,QAAA,GACxC,YAAY,IAAI,KAAK,YAAY,MAAO,UAAU,GAClD,UAAU,YAAY,oBAAI,KAAA,GAC1B,OAAO,UAAU,kBAAkB;AACzC,mBAAO;AAAA,cACL,OAAO,MAAM,GAAG,IAAI,IAAI,GAAG,IAAI,QAAQ,KAAK,KAAK;AAAA,cACjD,UAAU,UACN,YACA,cAAc,KAAK,OAAO,UAAU,QAAA,IAAY,KAAK,IAAA,MAAU,MAAO,GAAG,CAAC;AAAA,cAC9E,OAAO;AAAA,YAAA;AAAA,UAEX;AAAA,QAAA;AAAA,MACF,CACD;AAAA,IAAA;AAAA,EACH;AAAA,EAEF,UAAU;AAAA,IACR,SAAS,CAAC,MAAM,YACV,QAAQ,eAAe,aAClB,OAEF,KAAK,OAAO,CAAC,EAAC,OAAA,MAAY,WAAW,QAAQ;AAAA,IAEtD,YAAY,CAAC,MAAM,YACb,QAAQ,iBAAiB,aACpB,OAEF,CAAA;AAAA,IAET,uBAAuB,CAAC,MAAM,YACxB,QAAQ,WAAW,SAAS,aACvB,OAEF,CAAA;AAAA,EAAC;AAGd,EACD;"}

package/package.json CHANGED Viewed

@@ -1,10 +1,60 @@
 {
   "name": "@sanity/debug-preview-url-secret-plugin",
-  "version": "0.0.1",
-  "description": "OIDC trusted publishing setup package for @sanity/debug-preview-url-secret-plugin",
+  "version": "1.0.0",
+  "homepage": "https://github.com/sanity-io/plugins/tree/main/plugins/%40sanity/debug-preview-url-secret-plugin#readme",
+  "bugs": {
+    "url": "https://github.com/sanity-io/plugins/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/sanity-io/plugins.git",
+    "directory": "plugins/@sanity/debug-preview-url-secret-plugin"
+  },
   "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
-  ]
-}
+    "sanity",
+    "studio",
+    "sanity-plugin"
+  ],
+  "license": "MIT",
+  "author": "Sanity.io <hello@sanity.io>",
+  "type": "module",
+  "exports": {
+    ".": {
+      "source": "./src/index.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "CHANGELOG.md"
+  ],
+  "dependencies": {
+    "@sanity/icons": "^3.7.4",
+    "@sanity/preview-url-secret": "^3.0.0"
+  },
+  "devDependencies": {
+    "@sanity/pkg-utils": "^9.1.1",
+    "@types/react": "^19.2.6",
+    "@typescript/native-preview": "7.0.0-dev.20251121.1",
+    "react": "^19.2.0",
+    "sanity": "^4.17.0",
+    "typescript": "5.9.3",
+    "@repo/package.config": "0.0.0"
+  },
+  "peerDependencies": {
+    "react": "^18.3 || ^19",
+    "sanity": "^4"
+  },
+  "engines": {
+    "node": ">=20.19 <22 || >=22.12"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "typecheck": "(cd ../../.. && tsgo --project plugins/@sanity/debug-preview-url-secret-plugin/tsconfig.json)",
+    "build": "pkg build --strict --check --clean"
+  }
+}