feat: initial version

.editorconfig

@@ -0,0 +1,13 @@
+; editorconfig.org
+root = true
+charset= utf8
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false

.eslintignore

@@ -0,0 +1,6 @@
+*.js
+.eslintrc.js
+commitlint.config.js
+dist
+lint-staged.config.js
+package.config.ts

.eslintrc

@@ -0,0 +1,15 @@
+{
+  "root": true,
+  "env": {
+    "node": true,
+    "browser": true
+  },
+  "extends": [
+    "sanity",
+    "sanity/typescript",
+    "sanity/react",
+    "plugin:react-hooks/recommended",
+    "plugin:prettier/recommended",
+    "plugin:react/jsx-runtime"
+  ]
+}

.github/workflows/main.yml

@@ -0,0 +1,126 @@
+---
+name: CI & Release
+
+# Workflow name based on selected inputs. Fallback to default Github naming when expression evaluates to empty string
+run-name: >-
+  ${{
+    inputs.release && inputs.test && format('Build {0} ➤ Test ➤ Publish to NPM', github.ref_name)  ||
+    inputs.release && !inputs.test && format('Build {0} ➤ Skip Tests ➤ Publish to NPM', github.ref_name) ||
+    github.event_name == 'workflow_dispatch' && inputs.test && format('Build {0} ➤ Test', github.ref_name) ||
+    github.event_name == 'workflow_dispatch' && !inputs.test && format('Build {0} ➤ Skip Tests', github.ref_name) ||
+    ''
+  }}
+
+on:
+  # Build on pushes branches that have a PR (including drafts)
+  pull_request:
+  # Build on commits pushed to branches without a PR if it's in the allowlist
+  push:
+    branches: [main]
+  # https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow
+  workflow_dispatch:
+    inputs:
+      test:
+        description: Run tests
+        required: true
+        default: true
+        type: boolean
+      release:
+        description: Release new version
+        required: true
+        default: false
+        type: boolean
+
+concurrency:
+  # On PRs builds will cancel if new pushes happen before the CI completes, as it defines `github.head_ref` and gives it the name of the branch the PR wants to merge into
+  # Otherwise `github.run_id` ensures that you can quickly merge a queue of PRs without causing tests to auto cancel on any of the commits pushed to main.
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read # for checkout
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Lint & Build
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          cache: npm
+          node-version: lts/*
+      - run: npm clean-install
+        # Linting can be skipped
+      - run: npm run lint --if-present
+        if: github.event.inputs.test != 'false'
+        # But not the build script, as semantic-release will crash if this command fails so it makes sense to test it early
+      - run: npm run prepublishOnly --if-present
+
+  test:
+    needs: build
+    # The test matrix can be skipped, in case a new release needs to be fast-tracked and tests are already passing on main
+    if: github.event.inputs.test != 'false'
+    runs-on: ${{ matrix.os }}
+    name: Node.js ${{ matrix.node }} / ${{ matrix.os }}
+    strategy:
+      # A test failing on windows doesn't mean it'll fail on macos. It's useful to let all tests run to its completion to get the full picture
+      fail-fast: false
+      matrix:
+        # Run the testing suite on each major OS with the latest LTS release of Node.js
+        os: [macos-latest, ubuntu-latest, windows-latest]
+        node: [lts/*]
+        # It makes sense to also test the oldest, and latest, versions of Node.js, on ubuntu-only since it's the fastest CI runner
+        include:
+          - os: ubuntu-latest
+            # Test the oldest LTS release of Node that's still receiving bugfixes and security patches, versions older than that have reached End-of-Life
+            node: lts/-1
+          - os: ubuntu-latest
+            # Test the actively developed version that will become the latest LTS release next October
+            node: current
+    steps:
+      # It's only necessary to do this for windows, as mac and ubuntu are sane OS's that already use LF
+      - name: Set git to use LF
+        if: matrix.os == 'windows-latest'
+        run: |
+          git config --global core.autocrlf false
+          git config --global core.eol lf
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          cache: npm
+          node-version: ${{ matrix.node }}
+      - run: npm install
+      - run: npm test --if-present
+
+  release:
+    permissions:
+      contents: write # to be able to publish a GitHub release
+      issues: write # to be able to comment on released issues
+      pull-requests: write # to be able to comment on released pull requests
+      id-token: write # to enable use of OIDC for npm provenance
+    needs: [build, test]
+    # only run if opt-in during workflow_dispatch
+    if: always() && github.event.inputs.release == 'true' && needs.build.result != 'failure' && needs.test.result != 'failure' && needs.test.result != 'cancelled'
+    runs-on: ubuntu-latest
+    name: Semantic release
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          # Need to fetch entire commit history to
+          # analyze every commit since last release
+          fetch-depth: 0
+      - uses: actions/setup-node@v3
+        with:
+          cache: npm
+          node-version: lts/*
+      - run: npm clean-install
+      - run: npm audit signatures
+        # Branches that will release new versions are defined in .releaserc.json
+      - run: npx semantic-release
+        # Don't allow interrupting the release step if the job is cancelled, as it can lead to an inconsistent state
+        # e.g. git tags were pushed but it exited before `npm publish`
+        if: always()
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}

.gitignore

@@ -0,0 +1,60 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules
+jspm_packages
+
+# Optional npm cache directory
+.npm
+
+# Optional REPL history
+.node_repl_history
+
+# macOS finder cache file
+.DS_Store
+
+# VS Code settings
+.vscode
+
+# IntelliJ
+.idea
+*.iml
+
+# Cache
+.cache
+
+# Yalc
+.yalc
+yalc.lock
+
+# npm package zips
+*.tgz
+
+# Compiled plugin
+dist

.prettierignore

@@ -0,0 +1,4 @@
+dist
+pnpm-lock.yaml
+yarn.lock
+package-lock.json

.prettierrc

@@ -0,0 +1,9 @@
+{
+  "$schema": "http://json.schemastore.org/prettierrc",
+  "endOfLine": "lf",
+  "printWidth": 80,
+  "tabWidth": 2,
+  "trailingComma": "none",
+  "singleQuote": true,
+  "plugins": ["prettier-plugin-organize-imports"]
+}

.releaserc.json

@@ -0,0 +1,4 @@
+{
+  "extends": "@sanity/semantic-release-preset",
+  "branches": ["main"]
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Winter Agency
+
+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.

README.md

@@ -0,0 +1,131 @@
+# sanity-plugin-webhooks
+
+[![Latest Stable Version](https://img.shields.io/npm/v/sanity-plugin-webhooks.svg)](https://www.npmjs.com/package/sanity-plugin-webhooks) [![Weekly Downloads](https://img.shields.io/npm/dw/sanity-plugin-webhooks?style=flat-square)](https://npm-stat.com/charts.html?package=sanity-plugin-webhooks)
+[![License](https://img.shields.io/github/license/winteragency/sanity-plugin-webhooks.svg)](https://github.com/winteragency/sanity-plugin-webhooks) [![Made by Winter](https://img.shields.io/badge/made%20by-Winter-blue.svg)](https://winteragency.se)
+
+> This is a **Sanity Studio v3** plugin.
+
+## What is it?
+
+A tool that lists your Sanity webhooks and displays their events along with status, duration and response.
+
+## Installation
+
+```sh
+npm install sanity-plugin-webhooks
+```
+
+## Usage
+
+Add it as a plugin in `sanity.config.ts`:
+
+```ts
+import { defineConfig } from 'sanity';
+import { webhooks } from 'sanity-plugin-webhooks';
+
+export default defineConfig({
+  //...
+  plugins: [webhooks()]
+});
+```
+
+This will render a list of webhooks and for each webhook show a basic list of attempts and their status. You will also be able to see the exact response that the webhook received.
+
+### Customize the list of events
+
+To fully utilize this tool and make it as useful as possible for the Studio editors you can inject a custom component to render details about the webhook response.
+
+For example, given a JSON response such as the following which comes from a Next.js revalidation API route:
+
+```json
+{
+  "success": true,
+  "message": "Revalidated 1 tag",
+  "tags": ["page-about"],
+  "received": {
+    "_id": "f5e882dc-6713-4b0e-988a-03cb8ae453b1",
+    "_type": "page",
+    "slug": {
+      "_type": "slug",
+      "current": "about"
+    }
+  }
+}
+```
+
+You can inject a custom result component such as this:
+
+```ts
+import { Stack } from '@sanity/ui';
+import {
+  BadgeRow,
+  type WebhookBodyComponentProps
+} from 'sanity-plugin-webhooks';
+
+export function WebhookBody({ attempt }: WebhookBodyComponentProps) {
+  // The result body is the response from the webhook endpoint
+  const resultBody = attempt.resultBody;
+
+  return (
+    <>
+      {resultBody?.message}
+
+      {resultBody?.tags?.length > 0 && (
+        <Stack space={[2, 2, 2]}>
+          {resultBody.tags?.length > 0 && (
+            <BadgeRow heading="Tags" badges={resultBody.tags} />
+          )}
+        </Stack>
+      )}
+
+      {resultBody?.received?.slug?.current && (
+        <Stack space={[2, 2, 2]}>
+          <BadgeRow
+            heading="Triggered By"
+            badges={[resultBody.received._type]}
+            tone="default"
+          />
+
+          <BadgeRow
+            heading="Slug"
+            badges={[resultBody.received.slug.current]}
+            tone="default"
+          />
+        </Stack>
+      )}
+    </>
+  );
+}
+```
+
+Then add the component to the plugin config like this:
+
+```ts
+import { defineConfig } from 'sanity';
+import { webhooks } from 'sanity-plugin-webhooks';
+import { WebhookBody } from './components/WebhookBody';
+
+export default defineConfig({
+  //...
+  plugins: [webhooks({ webhookBodyComponent: WebhookBody })]
+});
+```
+
+## License
+
+[MIT](LICENSE) © [Winter Agency](https://winteragency.se)
+
+## Develop & test
+
+This plugin uses [@sanity/plugin-kit](https://github.com/sanity-io/plugin-kit)
+with default configuration for build & watch scripts.
+
+See [Testing a plugin in Sanity Studio](https://github.com/sanity-io/plugin-kit#testing-a-plugin-in-sanity-studio)
+on how to run this plugin with hotreload in the studio.
+
+### Release new version
+
+Run ["CI & Release" workflow](https://github.com/winteragency/sanity-plugin-webhooks/actions/workflows/main.yml).
+Make sure to select the main branch and check "Release new version".
+
+Semantic release will only release on configured branches, so it is safe to run release on any branch.