@sanity/document-internationalization 3.2.0 → 3.3.0

package/README.md

@@ -76,10 +76,10 @@ The only required configuration is:
 ```ts
 // sanity.config.ts
 
-import {createConfig} from 'sanity'
+import {defineConfig} from 'sanity'
 import {documentInternationalization} from '@sanity/document-internationalization'
 
-export const createConfig({
+export const defineConfig({
   // ... all other config
   plugins: [
     // ... all other plugins
@@ -102,10 +102,10 @@ The plugin also supports asynchronously retrieving languages from the dataset, m
 ```ts
 // sanity.config.ts
 
-import {createConfig} from 'sanity'
+import {defineConfig} from 'sanity'
 import {documentInternationalization} from '@sanity/document-internationalization'
 
-export const createConfig({
+export const defineConfig({
   // ... all other config
   plugins: [
     // ... all other plugins
@@ -128,21 +128,21 @@ export const createConfig({
 
       // 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 createConfig({
       // 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> & {