@sanity/document-internationalization 0.3.7 → 0.3.8

package/LICENSE

@@ -1,7 +1,10 @@
+MIT License
+
 Copyright © 2020 Liam Martens
+Copyright © 2022 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 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 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.
+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,10 +1,7 @@
 # Document Internationalization Plugin for Sanity.io
 
-> **NOTE**
->
-> This is the **Sanity Studio V2 version** of Document Internationalization Plugin.
->
-> For the V3 version, please refer to the [v3-branch](https://github.com/sanity-io/document-internationalization/tree/v3).
+>This is a **Sanity Studio v2** plugin.
+> For the V3 version, please refer to the [v3-branch](https://github.com/sanity-io/document-internationalization).
 
 [![npm version](https://img.shields.io/npm/v/@sanity/document-internationalization.svg?style=flat)](https://www.npmjs.com/package/@sanity/document-internationalization)
 
@@ -43,11 +40,16 @@ A good use of field-level translation could be a `person` schema. It could have
 
 With the [Sanity CLI installed](https://www.sanity.io/docs/getting-started-with-sanity-cli), from the same directory as the Studio run:
 
-```
-sanity install @sanity/document-internationalization
+```sh
+yarn add @sanity/document-internationalization@studio-v2
 ```
 
-Ensure that `@sanity/document-internationalization` is listed in `plugins` inside `sanity.json`.
+Next, add `"@sanity/document-internationalization"` to `sanity.json` plugins array:
+```json
+"plugins": [
+  "@sanity/document-internationalization"
+]
+```
 
 The plugin is now installed, but you will need to complete the following steps to see the Document Translation UI:
 

package/package.json

@@ -1,11 +1,6 @@
 {
   "name": "@sanity/document-internationalization",
-  "version": "0.3.7",
-  "license": "MIT",
-  "engines": {
-    "node": ">=14"
-  },
-  "author": "Sanity.io <hello@sanity.io>",
+  "version": "0.3.8",
   "keywords": [
     "sanity",
     "cms",
@@ -16,19 +11,23 @@
     "i18n",
     "localization"
   ],
+  "bugs": {
+    "url": "https://github.com/sanity-io/document-internationalization/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:sanity-io/document-internationalization"
+  },
+  "license": "MIT",
+  "author": "Sanity.io <hello@sanity.io>",
   "files": [
     "lib/",
     "doc/",
     "config.dist.json",
-    "sanity.json"
+    "sanity.json",
+    "README.md",
+    "LICENSE"
   ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/sanity-io/document-internationalization"
-  },
-  "bugs": {
-    "url": "https://github.com/sanity-io/document-internationalization/issues"
-  },
   "scripts": {
     "lint": "npm run eslint -- .",
     "eslint": "eslint --ext=.js,.jsx,.mjs,.ts,.tsx --quiet",
@@ -52,6 +51,23 @@
       "pre-commit": "npm run lint:fix"
     }
   },
+  "lint-staged": {
+    "src/**/*.{ts,tsx}": [
+      "eslint . --quiet --fix"
+    ]
+  },
+  "dependencies": {
+    "@babel/runtime": "^7.12.5",
+    "@cprecioso/country-flag-emoji": "^1.0.0",
+    "html-react-parser": "^1.4.12",
+    "just-omit": "^2.0.1",
+    "just-safe-get": "^4.0.1",
+    "just-split": "^3.0.1",
+    "pinst": "^2.1.6",
+    "react-twemoji": "^0.5.0",
+    "regenerator-runtime": "^0.13.7",
+    "twemoji": "^14.0.2"
+  },
   "devDependencies": {
     "@babel/cli": "^7.12.10",
     "@babel/core": "^7.12.10",
@@ -61,6 +77,8 @@
     "@babel/preset-env": "^7.12.11",
     "@babel/preset-react": "^7.12.10",
     "@babel/preset-typescript": "^7.12.7",
+    "@commitlint/cli": "^17.1.2",
+    "@commitlint/config-conventional": "^17.1.0",
     "@rollup/plugin-babel": "^5.2.2",
     "@rollup/plugin-commonjs": "^17.0.0",
     "@rollup/plugin-node-resolve": "^11.0.1",
@@ -73,6 +91,7 @@
     "@sanity/icons": "^1.2.5",
     "@sanity/language-filter": "^2.28.0",
     "@sanity/react-hooks": "^2.20.0",
+    "@sanity/semantic-release-preset": "^2.0.1",
     "@sanity/state-router": "^2.0.0",
     "@sanity/structure": "^2.20.0",
     "@sanity/types": "^2.19.0",
@@ -133,21 +152,7 @@
     "rxjs": "^6.0.0",
     "styled-components": "^5.0.0"
   },
-  "dependencies": {
-    "@babel/runtime": "^7.12.5",
-    "@cprecioso/country-flag-emoji": "^1.0.0",
-    "html-react-parser": "^1.4.12",
-    "just-omit": "^2.0.1",
-    "just-safe-get": "^4.0.1",
-    "just-split": "^3.0.1",
-    "pinst": "^2.1.6",
-    "react-twemoji": "^0.5.0",
-    "regenerator-runtime": "^0.13.7",
-    "twemoji": "^14.0.2"
-  },
-  "lint-staged": {
-    "src/**/*.{ts,tsx}": [
-      "eslint . --quiet --fix"
-    ]
+  "engines": {
+    "node": ">=14"
   }
 }

package/CHANGELOG.md

@@ -1,58 +0,0 @@
-# CHANGELOG
-
-## v0.3.7
-* Fixed issues with translation maintenance
-* Added transaction overview confirmation dialog for better transparency
-
-## v0.3.6
-* Updates the internal logic to derive the language from the given field name as opposed to the ID.
-
-## v0.3.5
-* Fix how translation draft references are created so that they can be deleted
-
-## v0.3.4
-* Updated docs regarding V3 studio
-
-## v0.3.3
-* Fixes [#59](https://github.com/sanity-io/document-internationalization/issues/59) - Missing `_weak` field in base reference
-
-## v0.1.7
-* For base I18n documents the default "Delete" action will now be replaced with the Delete (incl. translations)" action. The default "Delete" action does not make sense for base documents in any scenario as it results in broken references.
-
-## v0.1.6
-* Fixed translation maintenance functionality
-
-## v0.1.5
-* Don't override `child` resolver as it is not required anymore. This way it will correctly fallback on the Studio's structure definition
-
-## v0.1.4
-* Fixed an issue with filtering `all:part:@sanity/desk-tool/language-select-component`
-
-## v0.1.3
-* The plugin will not show the language dropdown anymore for schemas that do not have `i18n` enabled. This version also brings support for the `@sanity/language-filter` plugin for non `i18n` schemas.
-
-## v0.1.2
-* Fixed import to `ConfirmDeleteDialog`
-
-## v0.1.1
-* [#32](https://github.com/sanity-io/document-internationalization/issues/32) Fixes default and custom flag implementations
-
-## v0.1.0
-This is the first stable release for the official document internationalization plugin. A few things have changed since the original plugin. For a migration guide please see [this guide](docs/coming-from-sanity-plugin-intl-input.md).
-
-**Breaking Changes**
-- Object level translations are not supported by this plugin anymore. If your project requires this please use the [@sanity/language-filter](https://www.npmjs.com/package/@sanity/language-filter) plugin.
-- `delimiter` is now the default ID structure as opposed to `subpath`. If you are using the legacy plugin with no `idStructure` specified you will need to make sure to configure it explicitly in this version. Coming from the old version you will need to set it to `subpath` to keep your current structure.
-- It is not possible anymore to override the UI messages using plugin configuration.
-- The language configuration has been updated to use an `id` field instead of `name`. This change was made to align with the `@sanity/language-filter` plugin. You will need to update your language configuration if you are coming from the old plugin.
-- The `hard` reference behavior configuration has been renamed to `strong` to be more consistent with Sanity itself.
-- The `__i18n_refs` field will now be a simple array of rerences as opposed to an array of custom objects. They are keyed by their language code for easier querying.
-
-**Fixes**
-- Fixed issue with `fixIdStructureMismatchDocuments` maintenance function
-- Fixed a bug with the `fixBaseLanguageMismatch` method as it was not considering the field name configuration
-- [#124](https://github.com/LiamMartens/sanity-plugin-intl-input/issues/124) Updates an internal import to support the minor bump from `@sanity/desk-tool@2.28.0`
-
-**Other Changes**
-- Added a slug uniqueness validator for document level translations (`import { isSlugUnique } from '@sanity/document-internationalization/lib/validators`)
-- A maintenance function was created to add base document refs to translated documents