@sanity/document-internationalization 1.0.0-v3-studio.7 → 1.0.0

package/LICENSE

@@ -1,7 +1,21 @@
-Copyright © 2020 Liam Martens
+MIT License
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Copyright (c) 2022 Simeon Griggs
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,91 +1,66 @@
-# Document Internationalization Plugin for Sanity.io
+# @sanity/document-internationalization
 
-> **NOTE**
->
-> This is the **Sanity Studio v3 version** of Document Internationalization Plugin.
->
-> For the v2 version, please refer to the [v2-branch](https://github.com/sanity-io/document-internationalization).
+This is a complete rewrite of the original v0 Document Internationalization plugin, exclusively for Sanity Studio v3. The major differences include:
 
-[![npm version](https://img.shields.io/npm/v/@sanity/document-internationalization.svg?style=flat)](https://www.npmjs.com/package/@sanity/document-internationalization)
-
-![Document Level Internationalization UI](docs/img/document-level-translation.gif)
-
-## What this plugin solves
-
-There are two popular methods of internationalization in Sanity Studio:
-
-- **Document-level translation**
-  - A unique document version for every language
-  - Joined together by references and/or a predictable `_id`
-  - Best for documents that have unique, language-specific fields and no common content across languages
-  - Best for translating content using Portable Text
-- **Field-level translation**
-  - A single document with many languages of content
-  - Achieved by mapping over languages on each field, to create an object
-  - Best for documents that have a mix of language-specific and common fields
-  - Not recommended for Portable Text
-
-This plugin adds features to the Studio to improve handling **document-level translations**.
-
-- A Language Selector to create and browse language-specific versions of each Document
-- Document Actions to update base and translated documents to ensure references stay in tact
-- Document Badges to highlight the language version of a document
-
-For **field-level translations** you should use the [@sanity/language-filter plugin](https://www.npmjs.com/package/@sanity/language-filter).
-
-*Studio V3 note*: language-filter is not available for V3 yet.
-
-### Many projects use both!
-
-*Studio V3 note*: language-filter is not available for V3 yet.
-
-An example of document-level translation could be a `lesson` schema, the `title`, `slug` and `content` fields would be unique in every language.
-
-A good use of field-level translation could be a `person` schema. It could have the same `name` and `image` in every language, but only the `biography` would need translating.
-
-## Studio V3 known issues
-
-Studio V3 does not implement language-filter yet. This means that the language button has moved into the document editor flow for the time being.
-We will be looking to restore the button placement during Studio V3 dev-preview. 
+- Start new documents in any language and create references later
+- Storing translation references in a separate "meta" document
+- Updates to one document no longer effect the change history of other translations
+- No use of Document Actions
+- Configurable "language" field on documents
 
 ## Installation
 
-From the same directory as the Studio run:
-
-```sh
-npm install --save @sanity/document-internationalization@studio-v3
+```
+npm install --save @sanity/document-internationalization
 ```
 
 or
 
-```sh
-yarn add @sanity/document-internationalization@studio-v3
+```
+yarn add @sanity/document-internationalization
 ```
 
+## Usage
+
+Add it as a plugin in sanity.config.ts (or .js):
+
+```ts
+ import {createConfig} from 'sanity'
+ import {documentInternationalization} from '@sanity/document-internationalization'
+
+export const createConfig({
+  // ...
+  plugins: [
+    documentInternationalization({
+      // Required
+      supportedLanguages: [
+        {id: 'nb', title: 'Norwegian (Bokmål)'},
+        {id: 'nn', title: 'Norwegian (Nynorsk)'},
+        {id: 'en', title: 'English'}
+      ],
+      schemaTypes: ['product', 'post'],
+      // Optional
+      languageField: `language` // defauts to "language"
+    })
+  ]
+})
+```
 
-The plugin is now installed, but you will need to complete the following steps to see the Document Translation UI:
-
-## Setup next steps
-1. [Enabling and configuring the plugin](docs/enabling-and-configuring.md)  
-   To declare available Languages and other settings
-2. [Activating internationalization on schema](docs/activating-internationalization-on-schema.md)  
-   To enable all the above features on schema
-3. [Customise Desk Structure](docs/desk-structure.md)  
-   To filter documents down to the base language version
-
-## Other documentation
+The schema types that use document internationalization should also have a string field with the same name configured in the `languageField` setting. You can hide this field since the plugin will handle writing patches to it.
 
-1. [Known Caveats](docs/known-caveats.md)
-2. [Data structure](docs/datastructure-intl-doc.md)
-3. [Translation Maintenance](docs/translation-maintenance.md)
-4. [GraphQL support](docs/graphql-intl-doc.md)
-5. [Advanced languages](docs/advanced-languages.md)
-6. [Usage with custom publish action](docs/usage-with-custom-publish.md)
-7. [If you don't see the plugin document actions](docs/usage-with-custom-publish.md#add-additional-actions)
-8. [GROQ query examples](/docs/groq-query-examples.md)
+```ts
+// ./schema/product.ts
 
-## Migrating from sanity-plugin-intl-input
+// ...all other settings
+defineField({
+  name: 'language',
+  type: 'string',
+  readOnly: true,
+  hidden: true,
+})
+```
 
-While most of the UI is the same in the official version of this plugin there are some breaking changes you should be aware of before migrating:
+## License
 
-[Coming from sanity-plugin-intl-input](docs/coming-from-sanity-plugin-intl-input.md)
+MIT © Simeon Griggs
+See LICENSE