@sanity/document-internationalization 3.0.0 → 3.1.0

package/README.md

@@ -11,6 +11,7 @@ All new rewrite exclusively for Sanity Studio v3
     - [Basic configuration](#basic-configuration)
     - [Advanced configuration](#advanced-configuration)
     - [Language field](#language-field)
+    - [Excluding fields](#excluding-fields)
   - [Querying translations](#querying-translations)
     - [Querying with GROQ](#querying-with-groq)
     - [Querying with GraphQL](#querying-with-graphql)
@@ -118,6 +119,7 @@ export const createConfig({
       ],
       // ...or a function that takes the client and returns a promise of an array of supported languages
       // MUST return an "id" and "title" as strings
+      // Note: Async language configuration cannot create templates for new documents
       // supportedLanguages: (client) => client.fetch(`*[_type == "language"]{id, title}`),
 
       // Required
@@ -146,7 +148,12 @@ export const createConfig({
       // Optional
       // Define API Version for all queries
       // https://www.sanity.io/docs/api-versioning
-      apiVersion: '2023-05-22'
+      apiVersion: '2023-05-22',
+
+      // Optional
+      // Enable "manage translations" button without creating a translated version. Helpful if you have
+      // pre-existing documents that you need to tie together through the metadata document
+      allowCreateMetaDoc: true // defaults to false
     })
   ]
 })

package/dist/index.d.mts

@@ -48,6 +48,7 @@ export declare type PluginConfig = {
   bulkPublish?: boolean
   metadataFields?: FieldDefinition[]
   apiVersion?: string
+  allowCreateMetaDoc?: boolean
 }
 
 export declare type PluginConfigContext = Required<PluginConfig> & {

package/dist/index.d.ts

@@ -48,6 +48,7 @@ export declare type PluginConfig = {
   bulkPublish?: boolean
   metadataFields?: FieldDefinition[]
   apiVersion?: string
+  allowCreateMetaDoc?: boolean
 }
 
 export declare type PluginConfigContext = Required<PluginConfig> & {

package/dist/index.esm.js

@@ -21,7 +21,8 @@ const METADATA_SCHEMA_NAME = "translation.metadata", TRANSLATIONS_ARRAY_NAME = "
   weakReferences: !1,
   bulkPublish: !1,
   metadataFields: [],
-  apiVersion: API_VERSION
+  apiVersion: API_VERSION,
+  allowCreateMetaDoc: !1
 };
 function separateReferences(data = []) {
   const translations = [], otherReferences = [];
@@ -243,42 +244,75 @@ function useOpenInNewPane(id, type) {
     routerContext.navigateUrl({ path: href });
   }, [id, type, routerContext, routerPanesState, groupIndex]);
 }
+function createReference(key, ref, type, strengthenOnPublish = !0) {
+  return {
+    _key: key,
+    _type: "internationalizedArrayReferenceValue",
+    value: {
+      _type: "reference",
+      _ref: ref,
+      _weak: !0,
+      // If the user has configured weakReferences, we won't want to strengthen them
+      ...strengthenOnPublish ? { _strengthenOnPublish: { type } } : {}
+    }
+  };
+}
 function LanguageManage(props) {
-  const { id } = props, open = useOpenInNewPane(id, METADATA_SCHEMA_NAME);
+  const { id, metadataId, schemaType, documentId, sourceLanguageId } = props, open = useOpenInNewPane(id, METADATA_SCHEMA_NAME), openCreated = useOpenInNewPane(metadataId, METADATA_SCHEMA_NAME), { allowCreateMetaDoc, apiVersion, weakReferences } = useDocumentInternationalizationContext(), client = useClient({ apiVersion }), [userHasClicked, setUserHasClicked] = useState(!1), canCreate = !id && !!metadataId && allowCreateMetaDoc, handleClick = useCallback(() => {
+    if (!id && metadataId && sourceLanguageId) {
+      setUserHasClicked(!0);
+      const transaction = client.transaction(), sourceReference = createReference(
+        sourceLanguageId,
+        documentId,
+        schemaType.name,
+        !weakReferences
+      ), newMetadataDocument = {
+        _id: metadataId,
+        _type: METADATA_SCHEMA_NAME,
+        schemaTypes: [schemaType.name],
+        translations: [sourceReference]
+      };
+      transaction.createIfNotExists(newMetadataDocument), transaction.commit().then(() => {
+        setUserHasClicked(!1), openCreated();
+      }).catch((err) => {
+        console.error(err), setUserHasClicked(!1);
+      });
+    } else
+      open();
+  }, [
+    id,
+    metadataId,
+    sourceLanguageId,
+    client,
+    documentId,
+    schemaType.name,
+    weakReferences,
+    openCreated,
+    open
+  ]);
   return /* @__PURE__ */ jsx(
     Tooltip,
     {
       animate: !0,
-      content: id ? null : /* @__PURE__ */ jsx(Box, { padding: 2, children: /* @__PURE__ */ jsx(Text, { muted: !0, size: 1, children: "Document has no other translations" }) }),
+      content: /* @__PURE__ */ jsx(Box, { padding: 2, children: /* @__PURE__ */ jsx(Text, { muted: !0, size: 1, children: "Document has no other translations" }) }),
       fallbackPlacements: ["right", "left"],
       placement: "top",
       portal: !0,
+      disabled: !!id || canCreate,
       children: /* @__PURE__ */ jsx(Stack, { children: /* @__PURE__ */ jsx(
         Button,
         {
-          disabled: !id,
+          disabled: !id && !canCreate || canCreate && !sourceLanguageId || userHasClicked,
           mode: "ghost",
           text: "Manage Translations",
           icon: CogIcon,
-          onClick: () => open()
+          loading: userHasClicked,
+          onClick: handleClick
         }
       ) })
     }
   );
 }
-function createReference(key, ref, type, strengthenOnPublish = !0) {
-  return {
-    _key: key,
-    _type: "internationalizedArrayReferenceValue",
-    value: {
-      _type: "reference",
-      _ref: ref,
-      _weak: !0,
-      // If the user has configured weakReferences, we won't want to strengthen them
-      ...strengthenOnPublish ? { _strengthenOnPublish: { type } } : {}
-    }
-  };
-}
 function removeExcludedPaths(doc, schemaType) {
   if (!isDocumentSchemaType(schemaType) || !doc)
     return doc;
@@ -351,13 +385,18 @@ function LanguageOption(props) {
     sourceLanguageId,
     metadata: metadata2,
     metadataId
-  } = props, disabled = props.disabled || current || !source || !sourceLanguageId || !metadataId, translation = metadata2 != null && metadata2.translations.length ? metadata2.translations.find((t) => t._key === language.id) : void 0, { apiVersion, languageField, weakReferences } = useDocumentInternationalizationContext(), client = useClient({ apiVersion }), toast = useToast(), open = useOpenInNewPane((_a = translation == null ? void 0 : translation.value) == null ? void 0 : _a._ref, schemaType.name), handleOpen = useCallback(() => open(), [open]), handleCreate = useCallback(async () => {
+  } = props, [userHasClicked, setUserHasClicked] = useState(!1), disabled = props.disabled || userHasClicked || current || !source || !sourceLanguageId || !metadataId, translation = metadata2 != null && metadata2.translations.length ? metadata2.translations.find((t) => t._key === language.id) : void 0, { apiVersion, languageField, weakReferences } = useDocumentInternationalizationContext(), client = useClient({ apiVersion }), toast = useToast(), open = useOpenInNewPane((_a = translation == null ? void 0 : translation.value) == null ? void 0 : _a._ref, schemaType.name), handleOpen = useCallback(() => open(), [open]);
+  useEffect(() => {
+    setUserHasClicked(!1);
+  }, [!!translation]);
+  const handleCreate = useCallback(async () => {
     if (!source)
       throw new Error("Cannot create translation without source document");
     if (!sourceLanguageId)
       throw new Error("Cannot create translation without source language ID");
     if (!metadataId)
       throw new Error("Cannot create translation without a metadata ID");
+    setUserHasClicked(!0);
     const transaction = client.transaction(), newTranslationDocumentId = uuid();
     let newTranslationDocument = {
       ...source,
@@ -394,7 +433,7 @@ function LanguageOption(props) {
         title: `Created "${language.title}" translation`,
         description: metadataExisted ? "Updated Translations Metadata" : "Created Translations Metadata"
       });
-    }).catch((err) => (console.error(err), toast.push({
+    }).catch((err) => (console.error(err), setUserHasClicked(!1), toast.push({
       status: "error",
       title: "Error creating translation",
       description: err.message
@@ -491,7 +530,16 @@ function DocumentInternationalizationMenu(props) {
       supportedLanguages
     ), valid;
   }, [supportedLanguages]), content = /* @__PURE__ */ jsx(Box, { padding: 1, children: error ? /* @__PURE__ */ jsx(Card, { tone: "critical", padding: 1, children: /* @__PURE__ */ jsx(Text, { children: "There was an error returning translations metadata" }) }) : /* @__PURE__ */ jsxs(Stack, { space: 1, children: [
-    /* @__PURE__ */ jsx(LanguageManage, { id: metadata2 == null ? void 0 : metadata2._id }),
+    /* @__PURE__ */ jsx(
+      LanguageManage,
+      {
+        id: metadata2 == null ? void 0 : metadata2._id,
+        documentId,
+        metadataId,
+        schemaType,
+        sourceLanguageId
+      }
+    ),
     supportedLanguages.length > 4 ? /* @__PURE__ */ jsx(
       TextInput,
       {