npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@dotdev/sanity-copy-document-action

v1.0.1

Published

Custom document action which facilitates copying documents between datasets

Downloads

22

Readme

Sanity Copy Document Action

This package provides a Sanity document action which facilitates documents to be copied between datasets. This action only works with a connected DotSanity app.

  • Provides a "Copy to..." action available from the bottom-right of all documents
  • Renders a modal with a list of configured datasets, with buttons to copy the document
  • Supports Sanity Spaces
  • Copies assets to the target dataset and relinks their references
  • Merges references from the target document if they already exist (to prevent breaking assets which were manually fixed on the target side)
  • Attempts to resolve references by handle (e.g. products, collections etc) in the target dataset when copying

Playground example

An example of this action can found in the DotDev Sanity Playground.

  • Login using the [email protected] Google account
  • Navigate to the test document
  • Make an update to the document (e.g. update the title) and publish it
  • In the bottom-right, click the little arrow icon
  • Click on the "Copy to..." action
  • The resulting modal is rendered by this package

Installation

First, install the package into your Sanity desk.

yarn add @dotdev/sanity-copy-document-action @sanity/client @sanity/icons @sanity/ui
# or
npm i @dotdev/sanity-copy-document-action @sanity/client @sanity/icons @sanity/ui --save

Add a new file to the root of your project called resolveDocumentActions.js. Update the contents of this file to match the configuration for your own Sanity desk.

import defaultResolve from "part:@sanity/base/document-actions";

import { buildCopyDocumentAction } from "@dotdev/sanity-copy-document-action";

export default function resolveDocumentActions(props) {
  return [
    ...defaultResolve(props),
    buildCopyDocumentAction({
      projectId: "foobar",
      dataset: "production",
      copyTargets: [
        {
          title: "AU Website",
          dataset: "production",
        },
        {
          title: "NZ Website",
          dataset: "alternative",
        },
      ],
      reactifySanity: {
        endpointPrefix:
          "https://australia-southeast1-foobar.cloudfunctions.net/",
        shopName: "foobar.myshopify.com",
      },
    }),
  ];
}

Update the parts key in your sanity.json file to include your new document action resolver.

"parts": [
  ...// other parts here
  {
    "implements": "part:@sanity/base/document-actions/resolver",
    "path": "resolveDocumentActions.js"
  }
],

If you are using Sanity Spaces, make sure your spaces are configured in the sanity.json file. This gives you a dropdown in the top-left, which allows the user to easily switch between datasets.

...// the rest of sanity.json
"__experimental_spaces": [
  {
    "name": "production",
    "title": "AU Website",
    "default": true,
    "api": {
      "projectId": "foobar",
      "dataset": "production"
    }
  },
  {
    "name": "alternative",
    "title": "NZ Website",
    "default": true,
    "api": {
      "projectId": "foobar",
      "dataset": "alternative"
    }
  }
]

Gotchas

  • For UI simplicity reasons, the "Copy to..." action is only available for documents which have been published and do not have an active draft. This makes it obvious exactly which data is going to be copied to the target and that the target will be published.