@sanity/document-internationalization 2.0.2 → 2.1.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Sanity.io
+Copyright (c) 2024 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

@@ -169,6 +169,23 @@ defineField({
 })
 ```
 
+### Excluding fields
+
+The default behaviour of this plugin when creating a new translation is to duplicate the originating document, which is useful for then translating the fields directly in the new document - perhaps with [Sanity AI Assist](https://github.com/sanity-io/assist). However, sometimes you may want to exclude certain fields from being copied to the new document. You can do this by updating your schema to exclude certain types or fields with `options.documentInternationalization.exclude`:
+
+```ts
+defineField({
+  name: 'title',
+  title: 'Title',
+  type: 'string',
+  options: {
+    documentInternationalization: {
+      exclude: true,
+    },
+  },
+}),
+```
+
 ## Querying translations
 
 ### Querying with GROQ

package/dist/index.d.ts

@@ -20,6 +20,13 @@ export declare type DocumentInternationalizationMenuProps = {
   documentId: string
 }
 
+export declare interface DocumentInternationalizationSchemaOpts {
+  documentInternationalization?: {
+    /** Set to true to disable duplication of this field or type */
+    exclude?: boolean
+  }
+}
+
 export declare type Language = {
   id: Intl.UnicodeBCP47LocaleIdentifier
   title: string
@@ -57,3 +64,25 @@ export declare type TranslationReference = KeyedObject & {
 export declare function useDocumentInternationalizationContext(): PluginConfigContext
 
 export {}
+
+declare module 'sanity' {
+  interface ArrayOptions extends DocumentInternationalizationSchemaOpts {}
+  interface BlockOptions extends DocumentInternationalizationSchemaOpts {}
+  interface BooleanOptions extends DocumentInternationalizationSchemaOpts {}
+  interface CrossDatasetReferenceOptions
+    extends DocumentInternationalizationSchemaOpts {}
+  interface DateOptions extends DocumentInternationalizationSchemaOpts {}
+  interface DatetimeOptions extends DocumentInternationalizationSchemaOpts {}
+  interface FileOptions extends DocumentInternationalizationSchemaOpts {}
+  interface GeopointOptions extends DocumentInternationalizationSchemaOpts {}
+  interface ImageOptions extends DocumentInternationalizationSchemaOpts {}
+  interface NumberOptions extends DocumentInternationalizationSchemaOpts {}
+  interface ObjectOptions extends DocumentInternationalizationSchemaOpts {}
+  interface ReferenceBaseOptions
+    extends DocumentInternationalizationSchemaOpts {}
+  interface SlugOptions extends DocumentInternationalizationSchemaOpts {}
+  interface StringOptions extends DocumentInternationalizationSchemaOpts {}
+  interface TextOptions extends DocumentInternationalizationSchemaOpts {}
+  interface UrlOptions extends DocumentInternationalizationSchemaOpts {}
+  interface EmailOptions extends DocumentInternationalizationSchemaOpts {}
+}

package/dist/index.esm.js

@@ -2,11 +2,12 @@ import { jsx, jsxs, Fragment } from 'react/jsx-runtime';
 import { TrashIcon, CogIcon, SplitVerticalIcon, CheckmarkIcon, AddIcon, EditIcon, TranslateIcon, InfoOutlineIcon } from '@sanity/icons';
 import { Flex, Spinner, Stack, Text, Card, Grid, Button, useToast, Tooltip, Box, Badge, useClickOutside, TextInput, Popover, Inline, Dialog } from '@sanity/ui';
 import { useMemo, useEffect, createContext, useContext, useState, useCallback } from 'react';
-import { useSchema, Preview, useClient, useEditState, useValidationStatus, TextWithTone, useWorkspace, PatchEvent, unset, defineType, defineField, definePlugin, isSanityDocument } from 'sanity';
+import { useSchema, Preview, useClient, isDocumentSchemaType, pathToString, useEditState, useValidationStatus, TextWithTone, useWorkspace, PatchEvent, unset, defineType, defineField, definePlugin, isSanityDocument } from 'sanity';
 import { Feedback, useListeningQuery } from 'sanity-plugin-utils';
 import { uuid } from '@sanity/uuid';
 import { usePaneRouter, useDocumentPane } from 'sanity/desk';
 import { RouterContext } from 'sanity/router';
+import { Mutation, extractWithPath } from '@sanity/mutator';
 import styled from 'styled-components';
 import { internationalizedArray } from 'sanity-plugin-internationalized-array';
 function DocumentPreview(props) {
@@ -403,6 +404,77 @@ function createReference(key, ref, type) {
     }
   };
 }
+function removeExcludedPaths(doc, schemaType) {
+  if (!isDocumentSchemaType(schemaType) || !doc) {
+    return doc;
+  }
+  const pathsToExclude = extractPaths(doc, schemaType, []).filter(field => {
+    var _a, _b, _c;
+    return ((_c = (_b = (_a = field.schemaType) == null ? void 0 : _a.options) == null ? void 0 : _b.documentInternationalization) == null ? void 0 : _c.exclude) === true;
+  }).map(field => {
+    return pathToString(field.path);
+  });
+  const mut = new Mutation({
+    mutations: [{
+      patch: {
+        id: doc._id,
+        unset: pathsToExclude
+      }
+    }]
+  });
+  return mut.apply(doc);
+}
+function extractPaths(doc, schemaType, path) {
+  return schemaType.fields.reduce((acc, field) => {
+    var _a, _b;
+    const fieldPath = [...path, field.name];
+    const fieldSchema = field.type;
+    const {
+      value
+    } = (_a = extractWithPath(pathToString(fieldPath), doc)[0]) != null ? _a : {};
+    if (!value) {
+      return acc;
+    }
+    const thisFieldWithPath = {
+      path: fieldPath,
+      name: field.name,
+      schemaType: fieldSchema,
+      value
+    };
+    if (fieldSchema.jsonType === "object") {
+      const innerFields = extractPaths(doc, fieldSchema, fieldPath);
+      return [...acc, thisFieldWithPath, ...innerFields];
+    } else if (fieldSchema.jsonType === "array" && fieldSchema.of.length && fieldSchema.of.some(item => "fields" in item)) {
+      const {
+        value: arrayValue
+      } = (_b = extractWithPath(pathToString(fieldPath), doc)[0]) != null ? _b : {};
+      let arrayPaths = [];
+      if (arrayValue == null ? void 0 : arrayValue.length) {
+        for (const item of arrayValue) {
+          const itemPath = [...fieldPath, {
+            _key: item._key
+          }];
+          let itemSchema = fieldSchema.of.find(t => t.name === item._type);
+          if (!item._type) {
+            itemSchema = fieldSchema.of[0];
+          }
+          if (item._key && itemSchema) {
+            const innerFields = extractPaths(doc, itemSchema, itemPath);
+            const arrayMember = {
+              path: itemPath,
+              name: item._key,
+              schemaType: itemSchema,
+              value: item
+            };
+            arrayPaths = [...arrayPaths, arrayMember, ...innerFields];
+          }
+        }
+      }
+      return [...acc, thisFieldWithPath, ...arrayPaths];
+    }
+    return [...acc, thisFieldWithPath];
+  }, []);
+}
 function LanguageOption(props) {
   var _a;
   const {
@@ -426,7 +498,7 @@ function LanguageOption(props) {
     apiVersion
   });
   const toast = useToast();
-  const open = useOpenInNewPane((_a = translation == null ? void 0 : translation.value) == null ? void 0 : _a._ref, schemaType);
+  const open = useOpenInNewPane((_a = translation == null ? void 0 : translation.value) == null ? void 0 : _a._ref, schemaType.name);
   const handleOpen = useCallback(() => open(), [open]);
   const handleCreate = useCallback(async () => {
     if (!source) {
@@ -440,19 +512,20 @@ function LanguageOption(props) {
     }
     const transaction = client.transaction();
     const newTranslationDocumentId = uuid();
-    const newTranslationDocument = {
+    let newTranslationDocument = {
       ...source,
       _id: "drafts.".concat(newTranslationDocumentId),
       // 2. Update language of the translation
       [languageField]: language.id
     };
+    newTranslationDocument = removeExcludedPaths(newTranslationDocument, schemaType);
     transaction.create(newTranslationDocument);
-    const sourceReference = createReference(sourceLanguageId, documentId, schemaType, !weakReferences);
-    const newTranslationReference = createReference(language.id, newTranslationDocumentId, schemaType, !weakReferences);
+    const sourceReference = createReference(sourceLanguageId, documentId, schemaType.name, !weakReferences);
+    const newTranslationReference = createReference(language.id, newTranslationDocumentId, schemaType.name, !weakReferences);
     const newMetadataDocument = {
       _id: metadataId,
       _type: METADATA_SCHEMA_NAME,
-      schemaTypes: [schemaType],
+      schemaTypes: [schemaType.name],
       translations: [sourceReference]
     };
     transaction.createIfNotExists(newMetadataDocument);
@@ -605,7 +678,7 @@ function DocumentInternationalizationMenu(props) {
   const {
     documentId
   } = props;
-  const schemaType = props.schemaType.name;
+  const schemaType = props.schemaType;
   const {
     languageField,
     supportedLanguages
@@ -640,7 +713,7 @@ function DocumentInternationalizationMenu(props) {
   const {
     draft,
     published
-  } = useEditState(documentId, schemaType);
+  } = useEditState(documentId, schemaType.name);
   const source = draft || published;
   const documentIsInOneMetadataDocument = useMemo(() => {
     return Array.isArray(data) && data.length <= 1;
@@ -725,7 +798,7 @@ function DocumentInternationalizationMenu(props) {
   if (!documentId) {
     return null;
   }
-  if (!schemaType) {
+  if (!schemaType || !schemaType.name) {
     return null;
   }
   return /* @__PURE__ */jsx(Popover, {