@sanity/cross-dataset-duplicator 1.4.0-beta.2 → 1.4.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Sanity.io
+Copyright (c) 2025 Sanity.io
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -5,13 +5,13 @@ Sanity Studio v3 Tool and Document Action for empowering content editors to migr
 ## Installation
 
 ```
-npm install --save @sanity/cross-dataset-duplicator@reference-max-depth
+npm install --save @sanity/cross-dataset-duplicator
 ```
 
 or
 
 ```
-yarn add @sanity/cross-dataset-duplicator@reference-max-depth
+yarn add @sanity/cross-dataset-duplicator
 ```
 
 ### Important Notes
@@ -67,10 +67,12 @@ The plugin has some configuration options. These can be set by adding a config f
       tool: true,
       filter: '_type != "product"',
       follow: [],
-      reference: {
-        maxDepth: 1, // Number of documents deep to follow.  0 represents the current document only.
-        assetsOnly: true, // If true, only gather image and file assets.  'referenceMaxDepth' must be set.
-      },
+      queries:[
+        {
+          label: "All articles",
+          query: '_type == "article"'
+        }
+      ]
     })
   ]
  })
@@ -81,9 +83,8 @@ The plugin has some configuration options. These can be set by adding a config f
 - `tool` (boolean, default: true) – Set whether the Migration **Tool** is enabled.
 - `types` (Array[String], default: []) – Set which Schema Types the Migration Action should be enabled in.
 - `filter` (String, default: undefined) - Set a predicate for documents when gathering dependencies.
-- `follow` (("inbound" | "outbound")[], default: []) – Add buttons to allow the user to begin with just the existing document or first fetch all inbound references.
-- `reference.maxDepth` (Number, default: undefined) - The level of documents deep to follow, `0` represents the current document only. Must be a positive number. This is useful for when when gathering references returns a large number of references or when you want to be a bit more intentional about the which reference you gather.
-- `reference.assetsOnly`: (boolean) - If true, only gather image and file assets. The 'referenceMaxDepth' option must be set for this to work.
+- `follow` (("inbound" | "outbound")[], default: ["outbound"]) – Add buttons to allow the user to begin with just the existing document or first fetch all inbound references.
+- `queries`(Array[{label: string, query: string}], default: []) - Add button to allow the query to be populate with predefined useful queries.
 
 #### Action Options
 

package/dist/index.d.ts

@@ -65,16 +65,12 @@ export declare interface PluginConfig {
   types?: string[]
   filter?: string
   follow?: ('inbound' | 'outbound')[]
-  reference?: reference
+  queries?: PreDefinedQuery[]
 }
 
-/**
- * Reference object
- * @public
- */
-export declare type reference = {
-  maxDepth: number
-  assetsOnly?: boolean
+declare type PreDefinedQuery = {
+  label: string
+  query: string
 }
 
 /**

package/dist/index.esm.js

@@ -1,7 +1,7 @@
 import { useClient, useSchema, useWorkspaces, Preview, definePlugin } from 'sanity';
 import { jsx, jsxs, Fragment } from 'react/jsx-runtime';
 import React, { useState, useEffect, useCallback, createContext, useContext } from 'react';
-import { ArrowRightIcon, SearchIcon, LaunchIcon } from '@sanity/icons';
+import { InfoOutlineIcon, ArrowRightIcon, SearchIcon, LaunchIcon } from '@sanity/icons';
 import { useSecrets, SettingsView } from '@sanity/studio-secrets';
 import { Card, Flex, Button, Badge, Tooltip, Box, Text, useTheme, Container, Stack, Label, Select, Checkbox, Spinner, Grid, TextInput } from '@sanity/ui';
 import mapLimit from 'async/mapLimit';
@@ -24,10 +24,7 @@ const stickyStyles = function () {
     backgroundColor: isDarkMode ? "rgba(10,10,10,0.95)" : "rgba(255,255,255,0.95)"
   };
 };
-const isAsset = doc => doc._type === "sanity.imageAsset" || doc._type === "sanity.fileAsset";
-const returnOnlyAssets = references => references.filter(item => isAsset(item));
 async function getDocumentsInArray(options) {
-  let recurrsionDepth = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
   const {
     fetchIds,
     client,
@@ -35,9 +32,6 @@ async function getDocumentsInArray(options) {
     currentIds,
     projection
   } = options;
-  const {
-    reference
-  } = pluginConfig;
   const collection = [];
   const filter = ["_id in $fetchIds", pluginConfig.filter].filter(Boolean).join(" && ");
   const query = "*[".concat(filter, "]").concat(projection != null ? projection : "");
@@ -58,35 +52,14 @@ async function getDocumentsInArray(options) {
       if (references.length) {
         const newReferenceIds = new Set(references.filter(ref => !localCurrentIds.has(ref)));
         if (newReferenceIds.size) {
-          if (typeof (reference == null ? void 0 : reference.maxDepth) === "number" && (reference == null ? void 0 : reference.maxDepth) >= 0) {
-            recurrsionDepth++;
-            const referenceDocs = await getDocumentsInArray({
-              fetchIds: Array.from(newReferenceIds),
-              currentIds: localCurrentIds,
-              client,
-              pluginConfig
-            }, recurrsionDepth);
-            if (
-            // // If we are at the max depth and reference?.assetsOnly is falsy
-            (referenceDocs == null ? void 0 : referenceDocs.length) && recurrsionDepth === reference.maxDepth + 1 && !(reference == null ? void 0 : reference.assetsOnly)) {
-              collection.push(...referenceDocs);
-            } else if (
-            // // If we are at the max depth and reference?.assetsOnly is truthy
-            (referenceDocs == null ? void 0 : referenceDocs.length) && recurrsionDepth === reference.maxDepth + 1 && (reference == null ? void 0 : reference.assetsOnly)) {
-              collection.push(...returnOnlyAssets(referenceDocs));
-            } else if ((referenceDocs == null ? void 0 : referenceDocs.length) && recurrsionDepth < reference.maxDepth + 1) {
-              collection.push(...referenceDocs);
-            }
-          } else {
-            const referenceDocs = await getDocumentsInArray({
-              fetchIds: Array.from(newReferenceIds),
-              currentIds: localCurrentIds,
-              client,
-              pluginConfig
-            });
-            if (referenceDocs == null ? void 0 : referenceDocs.length) {
-              collection.push(...referenceDocs);
-            }
+          const referenceDocs = await getDocumentsInArray({
+            fetchIds: Array.from(newReferenceIds),
+            currentIds: localCurrentIds,
+            client,
+            pluginConfig
+          });
+          if (referenceDocs == null ? void 0 : referenceDocs.length) {
+            collection.push(...referenceDocs);
           }
         }
       }
@@ -239,13 +212,18 @@ function StatusBadge(props) {
     fallbackPlacements: ["right", "left"],
     placement: "top",
     portal: true,
-    children: /* @__PURE__ */jsx(Badge, {
+    children: /* @__PURE__ */jsxs(Badge, {
       muted: true,
-      padding: 2,
+      padding: 3,
       fontSize: 1,
       tone: badgeTone,
       mode: "outline",
-      children: badgeStatus
+      children: [badgeStatus, /* @__PURE__ */jsx(Box, {
+        marginLeft: 2,
+        display: "inline-block",
+        as: "span",
+        children: /* @__PURE__ */jsx(InfoOutlineIcon, {})
+      })]
     })
   });
 }
@@ -282,7 +260,7 @@ function Duplicator(props) {
   const workspaces = useWorkspaces();
   const workspacesOptions = workspaces.map(workspace => ({
     ...workspace,
-    disabled: workspace.dataset === originClient.config().dataset
+    disabled: workspace.dataset === originClient.config().dataset && workspace.projectId === originClient.config().projectId
   }));
   const [destination, setDestination] = useState(workspaces.length ? (_a = workspacesOptions.find(space => !space.disabled)) != null ? _a : null : null);
   const [message, setMessage] = useState(null);
@@ -303,7 +281,7 @@ function Duplicator(props) {
         doc
       });
     });
-    setPayload(initialPayload);
+    updatePayloadStatuses(initialPayload);
     const docCount = docs.length;
     const refsCount = initialRefs.length;
     if (initialRefs.length) {
@@ -745,15 +723,19 @@ function Duplicator(props) {
   });
 }
 function DuplicatorQuery(props) {
-  var _a, _b;
+  var _a;
   const {
     token,
     pluginConfig
   } = props;
+  const {
+    queries: preDefinedQueries
+  } = pluginConfig;
   const originClient = useClient(clientConfig);
   const schema = useSchema();
   const schemaTypes = schema.getTypeNames();
   const [value, setValue] = useState("");
+  const [fetched, setFetched] = useState(false);
   const [initialData, setInitialData] = useState({
     docs: []
     // draftIds: []
@@ -767,6 +749,8 @@ function DuplicatorQuery(props) {
         docs: registeredAndPublishedDocs
         // draftIds: initialDraftIds
       });
+
+      setFetched(true);
     }).catch(err => console.error(err));
   }
   useEffect(() => {
@@ -781,9 +765,9 @@ function DuplicatorQuery(props) {
       children: /* @__PURE__ */jsxs(Grid, {
         columns: [1, 1, 1, 2],
         gap: [1, 1, 1, 4],
-        children: [/* @__PURE__ */jsx(Box, {
+        children: [/* @__PURE__ */jsxs(Box, {
           padding: [2, 2, 2, 0],
-          children: /* @__PURE__ */jsx(Card, {
+          children: [/* @__PURE__ */jsx(Card, {
             padding: 4,
             radius: 3,
             border: true,
@@ -824,14 +808,38 @@ function DuplicatorQuery(props) {
                 })
               })]
             })
-          })
-        }), !((_a = initialData.docs) == null ? void 0 : _a.length) || initialData.docs.length < 1 && /* @__PURE__ */jsx(Container, {
+          }), preDefinedQueries && (preDefinedQueries == null ? void 0 : preDefinedQueries.length) > 0 && /* @__PURE__ */jsx(Card, {
+            marginTop: 2,
+            padding: 4,
+            radius: 3,
+            border: true,
+            children: /* @__PURE__ */jsx(Box, {
+              children: /* @__PURE__ */jsxs(Stack, {
+                space: 4,
+                children: [/* @__PURE__ */jsx(Box, {
+                  children: /* @__PURE__ */jsx(Label, {
+                    children: "Predefined Queries"
+                  })
+                }), /* @__PURE__ */jsx(Stack, {
+                  space: 2,
+                  children: preDefinedQueries.map(query => /* @__PURE__ */jsx(Button, {
+                    padding: 2,
+                    paddingX: 4,
+                    tone: "primary",
+                    onClick: () => setValue("*[".concat(query.query, "]")),
+                    text: query.label
+                  }, query.label.replace(/\s+/g, "-")))
+                })]
+              })
+            })
+          })]
+        }), fetched && initialData.docs.length < 1 && /* @__PURE__ */jsx(Container, {
           width: 1,
           children: /* @__PURE__ */jsx(Card, {
             padding: 5,
-            children: value ? "No Documents registered to the Schema match this query" : "Start with a valid GROQ query"
+            children: value ? "No documents match this query" : "Start with a valid GROQ query"
           })
-        }), ((_b = initialData.docs) == null ? void 0 : _b.length) > 0 && /* @__PURE__ */jsx(Duplicator, {
+        }), ((_a = initialData.docs) == null ? void 0 : _a.length) > 0 && /* @__PURE__ */jsx(Duplicator, {
           docs: initialData.docs,
           token,
           pluginConfig
@@ -900,7 +908,8 @@ const DEFAULT_CONFIG = {
   tool: true,
   types: [],
   filter: "",
-  follow: ["outbound"]
+  follow: ["outbound"],
+  queries: []
 };
 function ResetSecret() {
   const client = useClient(clientConfig);