@sanity/document-internationalization 3.2.1 → 3.3.0

package/README.md

@@ -128,21 +128,21 @@ export const defineConfig({
 
       // Optional
       // Customizes the name of the language field
-      languageField: `language` // defauts to "language"
+      languageField: `language`, // defauts to "language"
 
       // Optional
       // Keep translation.metadata references weak
-      weakReferences: true // defaults to false
+      weakReferences: true, // defaults to false
 
       // Optional
       // Adds UI for publishing all translations at once. Requires access to the Scheduling API
       // https://www.sanity.io/docs/scheduling-api
-      bulkPublish: true // defaults to false
+      bulkPublish: true, // defaults to false
 
       // Optional
       // Adds additional fields to the metadata document
       metadataFields: [
-        defineField({ name: 'slug', type: 'slug' })
+        defineField({ name: 'slug', type: 'slug' }),
       ],
 
       // Optional
@@ -153,7 +153,21 @@ export const defineConfig({
       // 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
+      allowCreateMetaDoc: true, // defaults to false
+
+      // Optional
+      // Callback function that runs after a translation document has been created
+      // Note: Defaults to null
+      callback: ({
+        sourceDocument, // The document in the original language
+        newDocument, // The newly created translation of the source document
+        sourceLanguageId, // The id of the original language
+        destinationLanguageId, // The id of the destination language
+        metaDocumentId, // The id of the meta document referencing the document translations
+        client // Sanity client
+      }) {
+        // Your function implementation
+      }
     })
   ]
 })

package/dist/index.d.mts

@@ -8,6 +8,8 @@ import type {ObjectSchemaType} from 'sanity'
 import {Plugin as Plugin_2} from 'sanity'
 import type {Reference} from 'sanity'
 import type {SanityClient} from 'sanity'
+import type {SanityDocument} from 'sanity'
+import type {SanityDocumentLike} from 'sanity'
 
 export declare const DeleteTranslationAction: DocumentActionComponent
 
@@ -42,6 +44,20 @@ export declare type Metadata = {
   translations: TranslationReference[]
 }
 
+export declare type MetadataDocument = SanityDocumentLike & {
+  schemaTypes: string[]
+  translations: TranslationReference[]
+}
+
+export declare type PluginCallbackArgs = {
+  sourceDocument: SanityDocument
+  newDocument: SanityDocument
+  sourceLanguageId: string
+  destinationLanguageId: string
+  metaDocumentId: string
+  client: SanityClient
+}
+
 export declare type PluginConfig = {
   supportedLanguages: SupportedLanguages
   schemaTypes: string[]
@@ -51,6 +67,7 @@ export declare type PluginConfig = {
   metadataFields?: FieldDefinition[]
   apiVersion?: string
   allowCreateMetaDoc?: boolean
+  callback?: ((args: PluginCallbackArgs) => Promise<void>) | null
 }
 
 export declare type PluginConfigContext = Required<PluginConfig> & {

package/dist/index.d.ts

@@ -8,6 +8,8 @@ import type {ObjectSchemaType} from 'sanity'
 import {Plugin as Plugin_2} from 'sanity'
 import type {Reference} from 'sanity'
 import type {SanityClient} from 'sanity'
+import type {SanityDocument} from 'sanity'
+import type {SanityDocumentLike} from 'sanity'
 
 export declare const DeleteTranslationAction: DocumentActionComponent
 
@@ -42,6 +44,20 @@ export declare type Metadata = {
   translations: TranslationReference[]
 }
 
+export declare type MetadataDocument = SanityDocumentLike & {
+  schemaTypes: string[]
+  translations: TranslationReference[]
+}
+
+export declare type PluginCallbackArgs = {
+  sourceDocument: SanityDocument
+  newDocument: SanityDocument
+  sourceLanguageId: string
+  destinationLanguageId: string
+  metaDocumentId: string
+  client: SanityClient
+}
+
 export declare type PluginConfig = {
   supportedLanguages: SupportedLanguages
   schemaTypes: string[]
@@ -51,6 +67,7 @@ export declare type PluginConfig = {
   metadataFields?: FieldDefinition[]
   apiVersion?: string
   allowCreateMetaDoc?: boolean
+  callback?: ((args: PluginCallbackArgs) => Promise<void>) | null
 }
 
 export declare type PluginConfigContext = Required<PluginConfig> & {

package/dist/index.esm.js

@@ -34,7 +34,8 @@ const METADATA_SCHEMA_NAME = "translation.metadata", TRANSLATIONS_ARRAY_NAME = "
   bulkPublish: !1,
   metadataFields: [],
   apiVersion: API_VERSION,
-  allowCreateMetaDoc: !1
+  allowCreateMetaDoc: !1,
+  callback: null
 };
 function separateReferences(data = []) {
   const translations = [], otherReferences = [];
@@ -3714,7 +3715,7 @@ function LanguageOption(props) {
     sourceLanguageId,
     metadata: metadata2,
     metadataId
-  } = 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]);
+  } = 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, callback } = 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]);
@@ -3756,7 +3757,20 @@ function LanguageOption(props) {
     const metadataPatch = client.patch(metadataId).setIfMissing({ translations: [sourceReference] }).insert("after", "translations[-1]", [newTranslationReference]);
     transaction.patch(metadataPatch), transaction.commit().then(() => {
       const metadataExisted = !!(metadata2 != null && metadata2._createdAt);
-      return toast.push({
+      return callback == null || callback({
+        client,
+        sourceLanguageId,
+        sourceDocument: source,
+        newDocument: newTranslationDocument,
+        destinationLanguageId: language.id,
+        metaDocumentId: metadataId
+      }).catch((err) => {
+        toast.push({
+          status: "error",
+          title: "Callback",
+          description: `Error while running callback - ${err}.`
+        });
+      }), toast.push({
         status: "success",
         title: `Created "${language.title}" translation`,
         description: metadataExisted ? "Updated Translations Metadata" : "Created Translations Metadata"
@@ -3778,7 +3792,8 @@ function LanguageOption(props) {
     source,
     sourceLanguageId,
     toast,
-    weakReferences
+    weakReferences,
+    callback
   ]);
   let message;
   return current ? message = "Current document" : translation ? message = `Open ${language.title} translation` : translation || (message = `Create new ${language.title} translation`), /* @__PURE__ */ jsx(