@sanity/document-internationalization 4.1.1 → 5.0.1

package/LICENSE

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

@@ -1,7 +1,5 @@
 # @sanity/document-internationalization
 
-All new rewrite exclusively for Sanity Studio v3
-
 - [@sanity/document-internationalization](#sanitydocument-internationalization)
   - [What this plugin solves](#what-this-plugin-solves)
     - [Many projects use both](#many-projects-use-both)
@@ -12,16 +10,13 @@ All new rewrite exclusively for Sanity Studio v3
     - [Advanced configuration](#advanced-configuration)
     - [Language field](#language-field)
     - [Excluding fields](#excluding-fields)
+    - [Document actions](#document-actions)
   - [Querying translations](#querying-translations)
     - [Querying with GROQ](#querying-with-groq)
     - [Querying with GraphQL](#querying-with-graphql)
   - [Note on document quotas](#note-on-document-quotas)
   - [Documentation](#documentation)
   - [License](#license)
-  - [Develop \& test](#develop--test)
-    - [Release new version](#release-new-version)
-
-![v3 Studio with @sanity/document-internationalization v1 Installed](./docs/img/sanity-document-internationalization-v2.png)
 
 ## What this plugin solves
 
@@ -42,7 +37,7 @@ This plugin adds features to the Studio to improve handling **document-level tra
 - Hooks and components to use throughout your custom components to handle translations
 - Document Badges to highlight the language version of a document
 
-For **field-level translations** you should use the [sanity-plugin-internationalized-array](https://github.com/sanity-io/sanity-plugin-internationalized-array).
+For **field-level translations** you should use the [sanity-plugin-internationalized-array](https://github.com/sanity-io/plugins/tree/main/plugins/sanity-plugin-internationalized-array).
 
 ### Many projects use both
 
@@ -52,7 +47,7 @@ A good use of **field-level** translation could be a `person` schema. It could h
 
 ## Upgrade
 
-[See the upgrade guide](./docs/00-upgrade-from-v1.md) for instructions on how to upgrade from the previous version of Document Internationalization.
+If upgrading from a previous version (v1), please see the [upgrade documentation](https://github.com/sanity-io/document-internationalization/blob/main/docs/00-upgrade-from-v1.md) in the original repository.
 
 ## Install
 
@@ -126,7 +121,7 @@ export const defineConfig({
 
       // Optional
       // Customizes the name of the language field
-      languageField: `language`, // defauts to "language"
+      languageField: `language`, // defaults to "language"
 
       // Optional
       // Keep translation.metadata references weak
@@ -205,6 +200,37 @@ defineField({
 }),
 ```
 
+### Document actions
+
+This package exports hook-based document actions that you can add in your Studio `document.actions` configuration:
+
+- `useDeleteTranslationAction`
+- `useDuplicateWithTranslationsAction`
+
+The legacy action exports `DeleteTranslationAction` and `DuplicateWithTranslationsAction` are deprecated.
+
+```ts
+import {
+  useDeleteTranslationAction,
+  useDuplicateWithTranslationsAction,
+} from '@sanity/document-internationalization'
+
+export default defineConfig({
+  // ... all other config
+  document: {
+    actions: (prev, context) => {
+      const translatedSchemaTypes = ['lesson', 'article']
+
+      if (translatedSchemaTypes.includes(context.schemaType)) {
+        return [...prev, useDeleteTranslationAction, useDuplicateWithTranslationsAction]
+      }
+
+      return prev
+    },
+  },
+})
+```
+
 ## Querying translations
 
 ### Querying with GROQ
@@ -234,10 +260,7 @@ Fortunately, the Sanity GraphQL API contains a similar filter for document refer
 ```graphql
 # In this example we retrieve a lesson by its `slug.current` field value
 query GetLesson($language: String!, $slug: String!) {
-  allLesson(
-    limit: 1
-    where: {language: {eq: $language}, slug: {current: {eq: $slug}}}
-  ) {
+  allLesson(limit: 1, where: {language: {eq: $language}, slug: {current: {eq: $slug}}}) {
     _id
     title
     language
@@ -273,31 +296,16 @@ This means if you have 100 documents and they are all translated into 3 language
 
 ## Documentation
 
-For more advanced topics see the documentation. For installation see [Usage](#usage).
+For more advanced topics see the [original repository documentation](https://github.com/sanity-io/document-internationalization/tree/main/docs).
 
-- [Upgrade from v1](./docs/00-upgrade-from-v1.md)
-- [Creating translations of singleton documents](./docs/01-singleton-documents.md)
-- [Importing and creating documents](./docs/02-importing-and-creating-documents.md)
-- [Deleting translated documents](./docs/03-deleting-translated-documents.md)
-- [Importing plugin components](./docs/04-importing-plugin-components.md)
-- [Allowing the same slug on different language versions](./docs/05-allowing-the-same-slug-for-translations.md)
-- [Remove default new document template](./docs/06-remove-default-new-document-template.md)
+- [Upgrade from v1](https://github.com/sanity-io/document-internationalization/blob/main/docs/00-upgrade-from-v1.md)
+- [Creating translations of singleton documents](https://github.com/sanity-io/document-internationalization/blob/main/docs/01-singleton-documents.md)
+- [Importing and creating documents](https://github.com/sanity-io/document-internationalization/blob/main/docs/02-importing-and-creating-documents.md)
+- [Deleting translated documents](https://github.com/sanity-io/document-internationalization/blob/main/docs/03-deleting-translated-documents.md)
+- [Importing plugin components](https://github.com/sanity-io/document-internationalization/blob/main/docs/04-importing-plugin-components.md)
+- [Allowing the same slug on different language versions](https://github.com/sanity-io/document-internationalization/blob/main/docs/05-allowing-the-same-slug-for-translations.md)
+- [Remove default new document template](https://github.com/sanity-io/document-internationalization/blob/main/docs/06-remove-default-new-document-template.md)
 
 ## License
 
 [MIT](LICENSE) © Sanity.io
-
-## Develop & test
-
-This plugin uses [@sanity/plugin-kit](https://github.com/sanity-io/plugin-kit)
-with default configuration for build & watch scripts.
-
-See [Testing a plugin in Sanity Studio](https://github.com/sanity-io/plugin-kit#testing-a-plugin-in-sanity-studio)
-on how to run this plugin with hot reload in the studio.
-
-### Release new version
-
-Run ["CI & Release" workflow](https://github.com/sanity-io/sanity-plugin-workflow/actions/workflows/main.yml).
-Make sure to select the main branch and check "Release new version".
-
-Semantic release will only release on configured branches, so it is safe to run the release on any branch.

package/dist/_chunks-es/{resources.mjs → resources.js}

@@ -6,4 +6,4 @@ var resources = {
 export {
   resources as default
 };
-//# sourceMappingURL=resources.mjs.map
+//# sourceMappingURL=resources.js.map

package/dist/{_chunks-cjs → _chunks-es}/resources.js.map

@@ -1 +1 @@
-{"version":3,"file":"resources.js","sources":["../../src/i18n/resources.ts"],"sourcesContent":["export default {\n  'action.duplicate.label': 'Duplicate with translations',\n  'action.duplicate.disabled.missing-metadata':\n    'The document cannot be duplicated because the metadata document is missing',\n  'action.duplicate.disabled.multiple-metadata':\n    'The document cannot be duplicated because there are multiple metadata documents',\n}\n"],"names":[],"mappings":";AAAA,IAAA,YAAe;AAAA,EACb,0BAA0B;AAAA,EAC1B,8CACE;AAAA,EACF,+CACE;AACJ;;"}
+{"version":3,"file":"resources.js","sources":["../../src/i18n/resources.ts"],"sourcesContent":["export default {\n  'action.duplicate.label': 'Duplicate with translations',\n  'action.duplicate.disabled.missing-metadata':\n    'The document cannot be duplicated because the metadata document is missing',\n  'action.duplicate.disabled.multiple-metadata':\n    'The document cannot be duplicated because there are multiple metadata documents',\n}\n"],"names":[],"mappings":"AAAA,IAAA,YAAe;AAAA,EACb,0BAA0B;AAAA,EAC1B,8CACE;AAAA,EACF,+CACE;AACJ;"}

package/dist/index.d.ts

@@ -1,92 +1,111 @@
-/// <reference types="react" />
-
-import {DocumentActionComponent} from 'sanity'
-import type {FieldDefinition} from 'sanity'
-import {JSX} from 'react'
-import type {KeyedObject} from 'sanity'
-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
-
-export declare const documentInternationalization: Plugin_2<PluginConfig>
-
-export declare function DocumentInternationalizationMenu(
-  props: DocumentInternationalizationMenuProps
-): JSX.Element | null
-
-export declare type DocumentInternationalizationMenuProps = {
-  schemaType: ObjectSchemaType
-  documentId: string
-}
-
-export declare interface DocumentInternationalizationSchemaOpts {
+import * as sanity0 from "sanity";
+import { DocumentActionDescription, DocumentActionProps, FieldDefinition, ObjectSchemaType, Reference, SanityClient, SanityDocument, SanityDocumentLike } from "sanity";
+import { InternationalizedArrayItem } from "sanity-plugin-internationalized-array";
+/**
+ * Optional Document action that removes a single translation from the metadata document
+ * and optionally deletes the translation document. Opens a confirmation dialog
+ * showing which metadata entries reference the document and any other references
+ * that may exist. When the document has translation references, those references
+ * are unset; otherwise the document is deleted directly.
+ *
+ * To use it, you need to add it to the document actions config
+ * ```
+ *  const translatedSchemaTypes = ['lesson', 'article'];
+ * document: {
+ *   actions: (prev, {schemaType}) => {
+ *     if (translatedSchemaTypes.includes(schemaType)) {
+ *       return [...prev, useDeleteTranslationAction]
+ *     }
+ *     return prev
+ *   },
+ * },
+ * ```
+ */
+declare const useDeleteTranslationAction: {
+  (props: DocumentActionProps): DocumentActionDescription;
+  action: string;
+  displayName: string;
+};
+/**
+ * @deprecated use useDeleteTranslationAction instead
+ * Will be removed in the next major version
+ */
+declare const DeleteTranslationAction: (props: DocumentActionProps) => DocumentActionDescription;
+/**
+ * Optional Document action that duplicates a document along with all its translations
+ * and the associated metadata document. The workflow duplicates each translated
+ * document, duplicates the metadata document, patches the new metadata to
+ * reference the new translation copies, and navigates to the duplicated document.
+ * Disabled when the user lacks permissions, metadata is missing or ambiguous,
+ * or the underlying duplicate operation is unavailable.
+ */
+declare const useDuplicateWithTranslationsAction: {
+  ({
+    id,
+    type,
+    onComplete
+  }: DocumentActionProps): DocumentActionDescription;
+  action: string;
+  displayName: string;
+};
+/**
+ * @deprecated use useDuplicateWithTranslationsAction instead
+ * Will be removed in the next major version
+ */
+declare const DuplicateWithTranslationsAction: {
+  (props: DocumentActionProps): DocumentActionDescription;
+  action: string;
+  displayName: string;
+};
+type Language = {
+  id: Intl.UnicodeBCP47LocaleIdentifier;
+  title: string;
+};
+type SupportedLanguages = Language[] | ((client: SanityClient) => Promise<Language[]>);
+type PluginCallbackArgs = {
+  sourceDocument: SanityDocument;
+  newDocument: SanityDocument;
+  sourceLanguageId: string;
+  destinationLanguageId: string;
+  metaDocumentId: string;
+  client: SanityClient;
+};
+type PluginConfig = {
+  supportedLanguages: SupportedLanguages;
+  schemaTypes: string[];
+  languageField?: string;
+  weakReferences?: boolean;
+  bulkPublish?: boolean;
+  metadataFields?: FieldDefinition[];
+  apiVersion?: string;
+  allowCreateMetaDoc?: boolean;
+  callback?: ((args: PluginCallbackArgs) => Promise<void>) | null;
+};
+type PluginConfigContext = Required<PluginConfig> & {
+  supportedLanguages: Language[];
+};
+type TranslationReference = InternationalizedArrayItem<Reference> & {
+  _type: 'internationalizedArrayReferenceValue';
+  value: Reference;
+};
+type Metadata = {
+  _id: string;
+  _createdAt: string;
+  translations: TranslationReference[];
+};
+type MetadataDocument = SanityDocumentLike & {
+  schemaTypes: string[];
+  translations: TranslationReference[];
+};
+type DocumentInternationalizationMenuProps = {
+  schemaType: ObjectSchemaType;
+  documentId: string;
+};
+interface DocumentInternationalizationSchemaOpts {
   documentInternationalization?: {
-    /** Set to true to disable duplication of this field or type */
-    exclude?: boolean
-  }
-}
-
-export declare const DuplicateWithTranslationsAction: DocumentActionComponent
-
-export declare type Language = {
-  id: Intl.UnicodeBCP47LocaleIdentifier
-  title: string
-}
-
-export declare type Metadata = {
-  _id: string
-  _createdAt: string
-  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
+    /** Set to true to disable duplication of this field or type */exclude?: boolean;
+  };
 }
-
-export declare type PluginConfig = {
-  supportedLanguages: SupportedLanguages
-  schemaTypes: string[]
-  languageField?: string
-  weakReferences?: boolean
-  bulkPublish?: boolean
-  metadataFields?: FieldDefinition[]
-  apiVersion?: string
-  allowCreateMetaDoc?: boolean
-  callback?: ((args: PluginCallbackArgs) => Promise<void>) | null
-}
-
-export declare type PluginConfigContext = Required<PluginConfig> & {
-  supportedLanguages: Language[]
-}
-
-export declare type SupportedLanguages =
-  | Language[]
-  | ((client: SanityClient) => Promise<Language[]>)
-
-export declare type TranslationReference = KeyedObject & {
-  _type: 'internationalizedArrayReferenceValue'
-  value: Reference
-}
-
-export declare function useDocumentInternationalizationContext(): PluginConfigContext
-
-export {}
-
 declare module 'sanity' {
   interface ArrayOptions extends DocumentInternationalizationSchemaOpts {}
   interface BlockOptions extends DocumentInternationalizationSchemaOpts {}
@@ -105,4 +124,9 @@ declare module 'sanity' {
   interface TextOptions extends DocumentInternationalizationSchemaOpts {}
   interface UrlOptions extends DocumentInternationalizationSchemaOpts {}
   interface EmailOptions extends DocumentInternationalizationSchemaOpts {}
-}
+} //# sourceMappingURL=types.d.ts.map
+declare function useDocumentInternationalizationContext(): PluginConfigContext;
+declare function DocumentInternationalizationMenu(props: DocumentInternationalizationMenuProps): React.JSX.Element | null;
+declare const documentInternationalization: sanity0.Plugin<PluginConfig>;
+export { DeleteTranslationAction, DocumentInternationalizationMenu, DocumentInternationalizationMenuProps, DocumentInternationalizationSchemaOpts, DuplicateWithTranslationsAction, Language, Metadata, MetadataDocument, PluginCallbackArgs, PluginConfig, PluginConfigContext, SupportedLanguages, TranslationReference, documentInternationalization, useDeleteTranslationAction, useDocumentInternationalizationContext, useDuplicateWithTranslationsAction };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/actions/DeleteTranslationAction.tsx","../src/actions/DuplicateWithTranslationsAction.tsx","../src/types.ts","../src/components/DocumentInternationalizationContext.tsx","../src/components/DocumentInternationalizationMenu.tsx","../src/plugin.tsx"],"mappings":";;;;;;AAkCA;;;;;;;;;;;AA+FA;;;;;;cA/Fa,0BAAA;EAAA,QACJ,mBAAA,GACN,yBAAA;;;;;;;;cA6FU,uBAAA,GAA2B,KAAA,EAAO,mBAAA,KAAsB,yBAAA;;;;AA/FrE;;;;;cCkBa,kCAAA;EAAA;;;;KAKV,mBAAA,GAAsB,yBAAA;;;;;ADwEzB;;;cC2Ha,+BAAA;EAAA,QACJ,mBAAA,GACN,yBAAA;;;;KCpPS,QAAA;EACV,EAAA,EAAI,IAAA,CAAK,4BAAA;EACT,KAAA;AAAA;AAAA,KAGU,kBAAA,GAAqB,QAAA,OAAe,MAAA,EAAQ,YAAA,KAAiB,OAAA,CAAQ,QAAA;AAAA,KAErE,kBAAA;EACV,cAAA,EAAgB,cAAA;EAChB,WAAA,EAAa,cAAA;EACb,gBAAA;EACA,qBAAA;EACA,cAAA;EACA,MAAA,EAAQ,YAAA;AAAA;AAAA,KAGE,YAAA;EACV,kBAAA,EAAoB,kBAAA;EACpB,WAAA;EACA,aAAA;EACA,cAAA;EACA,WAAA;EACA,cAAA,GAAiB,eAAA;EACjB,UAAA;EACA,kBAAA;EACA,QAAA,KAAa,IAAA,EAAM,kBAAA,KAAuB,OAAA;AAAA;AAAA,KAMhC,mBAAA,GAAsB,QAAA,CAAS,YAAA;EACzC,kBAAA,EAAoB,QAAA;AAAA;AAAA,KAGV,oBAAA,GAAuB,0BAAA,CAA2B,SAAA;EAC5D,KAAA;EACA,KAAA,EAAO,SAAA;AAAA;AAAA,KAGG,QAAA;EACV,GAAA;EACA,UAAA;EACA,YAAA,EAAc,oBAAA;AAAA;AAAA,KAGJ,gBAAA,GAAmB,kBAAA;EAC7B,WAAA;EACA,YAAA,EAAc,oBAAA;AAAA;AAAA,KAGJ,qCAAA;EACV,UAAA,EAAY,gBAAA;EACZ,UAAA;AAAA;AAAA,UAIe,sCAAA;EACf,4BAAA;ID4LD,+DC1LG,OAAA;EAAA;AAAA;AAAA;EAAA,UAKQ,YAAA,SAAqB,sCAAA;EAAA,UACrB,YAAA,SAAqB,sCAAA;EAAA,UACrB,cAAA,SAAuB,sCAAA;EAAA,UACvB,4BAAA,SAAqC,sCAAA;EAAA,UACrC,WAAA,SAAoB,sCAAA;EAAA,UACpB,eAAA,SAAwB,sCAAA;EAAA,UACxB,WAAA,SAAoB,sCAAA;EAAA,UACpB,eAAA,SAAwB,sCAAA;EAAA,UACxB,YAAA,SAAqB,sCAAA;EAAA,UACrB,aAAA,SAAsB,sCAAA;EAAA,UACtB,aAAA,SAAsB,sCAAA;EAAA,UACtB,oBAAA,SAA6B,sCAAA;EAAA,UAC7B,WAAA,SAAoB,sCAAA;EAAA,UACpB,aAAA,SAAsB,sCAAA;EAAA,UACtB,WAAA,SAAoB,sCAAA;EAAA,UACpB,UAAA,SAAmB,sCAAA;EAAA,UACnB,YAAA,SAAqB,sCAAA;AAAA;AAAA,iBChFjB,sCAAA,CAAA,GAA0C,mBAAA;AAAA,iBCO1C,gCAAA,CACd,KAAA,EAAO,qCAAA,GACN,KAAA,CAAM,GAAA,CAAI,OAAA;AAAA,cCJA,4BAAA,EAA4B,OAAA,CAAA,MAAA,CAAA,YAAA"}