Merge pull request #157 from Fekide/109-update-translations

feat(admin): add batch updating

.github/workflows/build.yml

@@ -5,48 +5,18 @@ on:
       - main
       - next
 jobs:
-  eslint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - name: Install modules
-        run: yarn
-      - name: Run ESLint
-        run: yarn lint
-
-  commitlint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - uses: wagoid/commitlint-github-action@v5
-
+  lint:
+    uses: ./.github/workflows/lint.yml
   unittest:
-    strategy:
-      matrix:
-        version: [14, 16, 18]
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.version }}
-          cache: 'yarn'
-      - run: yarn
-      - run: yarn test
-      - uses: codecov/codecov-action@v3
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}
-          files: ./plugin/coverage/clover.xml,./providers/deepl/coverage/clover.xml
-          flags: unittests
-          name: codecov-umbrella
+    uses: ./.github/workflows/unittest.yml
+  e2e:
+    uses: ./.github/workflows/e2e.yml
 
   release:
     needs:
-      - eslint
-      - commitlint
+      - lint
       - unittest
+      - e2e
     name: Release
     runs-on: ubuntu-latest
     steps:

.github/workflows/diff.yml

@@ -0,0 +1,9 @@
+on:
+  workflow_call:
+jobs:
+  diff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Run diff script
+        run: sh ./scripts/diff.sh

.github/workflows/e2e.yml

@@ -0,0 +1,26 @@
+on:
+  workflow_call:
+jobs:
+  e2e:
+    strategy:
+      matrix:
+        node: [14, 16, 18]
+        strapi: [4.6, 4.7, 4.8, 4.9]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node }}
+          cache: 'yarn'
+      - run: VERSION=${{ matrix.strapi }} envsubst < playground/templates/template.package.json > playground/package.json
+      - run: yarn
+      - run: yarn workspace playground build
+      - run: yarn workspace playground e2e
+      - uses: actions/upload-artifact@v3
+        if: always()
+        with:
+          name: cypress results (node=${{ matrix.node }},strapi=${{ matrix.strapi }})
+          path: |
+            playground/cypress/videos/*
+            playground/cypress/screenshots/*

.github/workflows/lint.yml

@@ -0,0 +1,19 @@
+on:
+  workflow_call:
+jobs:
+  eslint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install modules
+        run: yarn
+      - name: Run ESLint
+        run: yarn lint
+
+  commitlint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: wagoid/commitlint-github-action@v5

.github/workflows/pr.yml

@@ -1,39 +1,11 @@
 name: Pull Request
 on: pull_request
 jobs:
-  eslint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - name: Install modules
-        run: yarn
-      - name: Run ESLint
-        run: yarn lint
-
-  commitlint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - uses: wagoid/commitlint-github-action@v5
-
+  lint:
+    uses: ./.github/workflows/lint.yml
+  diff:
+    uses: ./.github/workflows/diff.yml
   unittest:
-    strategy:
-      matrix:
-        version: [14, 16, 18]
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.version }}
-          cache: 'yarn'
-      - run: yarn
-      - run: yarn test
-      - uses: codecov/codecov-action@v3
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}
-          files: ./plugin/coverage/clover.xml,./providers/deepl/coverage/clover.xml
-          flags: unittests
-          name: codecov-umbrella
+    uses: ./.github/workflows/unittest.yml
+  e2e:
+    uses: ./.github/workflows/e2e.yml

.github/workflows/unittest.yml

@@ -0,0 +1,22 @@
+on:
+  workflow_call:
+jobs:
+  unittest:
+    strategy:
+      matrix:
+        version: [14, 16, 18]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.version }}
+          cache: 'yarn'
+      - run: yarn
+      - run: yarn test
+      - uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./plugin/coverage/clover.xml,./providers/deepl/coverage/clover.xml,./providers/libretranslate/coverage/clover.xml
+          flags: unittests
+          name: codecov-umbrella

.gitignore

@@ -132,3 +132,7 @@ dist
 .vscode
 
 build/
+
+
+**/cypress/videos
+**/cypress/screenshots

README.md

@@ -29,6 +29,7 @@
 This plugin requires the following, in order to work correctly:
 
 - Strapi v4 (this plugin is not compatible with v3)
+  - Plugin tested for `v4.6` to `v4.9`
 - The plugin **i18n** installed and enabled (`@strapi/plugin-i18n` [[npm](https://www.npmjs.com/package/@strapi/plugin-i18n)])
 - The content type to have internationalization enabled (advanced settings in the content type builder)
 - In the internationalization settings at least **two** locales
@@ -92,6 +93,7 @@ module.exports = {
 #### Available providers
 
 - [strapi-provider-translate-deepl](https://www.npmjs.com/package/strapi-provider-translate-deepl)
+- [strapi-provider-translate-libretranslate](https://www.npmjs.com/package/strapi-provider-translate-libretranslate)
 
 ### Configure translation of individual fields/attributes
 
@@ -189,6 +191,12 @@ _The related objects are not translated directly, only the relation itself is tr
 - the relation goes both ways and would be removed from another object or localization if it was used (the case with oneToOne or oneToMany) -> it is removed
 - otherwise the relation is kept
 
+## 🔐 Permissions
+
+Since RBAC was moved to the community edition in Strapi v4.8.0, permissions for endpoints of direct translation, batch translation and api usage can now be granted to other roles than super admins:
+
+![Permissions for Translate plugin](https://github.com/Fekide/strapi-plugin-deepl/blob/main/assets/permissions.png)
+
 ## 🧑‍💻 Creating your own translation provider
 
 A translation provider should have the following:
@@ -270,5 +278,4 @@ return providerClient.translateTexts(texts)
 ## ⚠ Limitations:
 
 - The translation of Markdown and HTML may vary between different providers
-- **Only super admins can translate**. This is currently the case, since permissions were added to the `translate` endpoint. Probably you can change the permissions with an enterprise subscription but I am not sure. If you know how to do that also in the community edition please tell me or open a merge request!
 - Relations that do not have a translation of the desired locale will not be translated. To keep the relation you will need to translate both in succession (Behaviour for multi-relations has not yet been analyzed)

commitlint.config.js

@@ -3,6 +3,6 @@ module.exports = {
   ignores: [
     (message) =>
       /^Bumps \[.+]\(.+\) from .+ to .+\.$/m.test(message) ||
-      /^chore(release)/.test(message),
+      /^chore\(release\)/.test(message),
   ],
 }

package.json

@@ -32,7 +32,7 @@
     "husky": "^8.0.1",
     "jest": "^29.4.1",
     "lint-staged": "^13.2.0",
-    "multi-semantic-release": "^3.0.1",
+    "multi-semantic-release": "^3.0.2",
     "semantic-release": "^19.0.5"
   },
   "config": {

playground/.env.example

@@ -5,4 +5,10 @@ API_TOKEN_SALT=tobemodified
 ADMIN_JWT_SECRET=tobemodified
 JWT_SECRET=tobemodified
 DEEPL_API_KEY=tobemodified
+INIT_ADMIN=true
+INIT_ADMIN_USERNAME=admin
+INIT_ADMIN_PASSWORD=admin
+INIT_ADMIN_FIRSTNAME=Admin
+INIT_ADMIN_LASTNAME=Admin
+INIT_ADMIN_EMAIL=[email protected]
 #DEEPL_API_URL=optional

playground/.env.test

@@ -0,0 +1,14 @@
+HOST=0.0.0.0
+PORT=1337
+APP_KEYS="toBeModified1,toBeModified2"
+API_TOKEN_SALT=tobemodified
+ADMIN_JWT_SECRET=tobemodified
+JWT_SECRET=tobemodified
+TRANSLATE_PROVIDER=dummy
+INIT_ADMIN=true
+INIT_ADMIN_USERNAME=admin
+INIT_ADMIN_PASSWORD=admin
+INIT_ADMIN_FIRSTNAME=Admin
+INIT_ADMIN_LASTNAME=Admin
+INIT_ADMIN_EMAIL=[email protected]
+#DEEPL_API_URL=optional

playground/config/admin.js

@@ -5,4 +5,8 @@ module.exports = ({ env }) => ({
   apiToken: {
     salt: env('API_TOKEN_SALT'),
   },
+  rateLimit: {
+    enabled: false,
+  },
+  watchIgnoreFiles: ['./cypress/**/*'],
 })

playground/config/plugins.js

@@ -1,11 +1,12 @@
 module.exports = ({ env }) => ({
   // ...
   translate: {
-    resolve: "../plugin",
+    resolve: '../plugin',
     enabled: true,
     config: {
-      provider: 'deepl',
+      provider: env('TRANSLATE_PROVIDER', 'deepl'),
       providerOptions: {},
+      regenerateUids: true,
     },
   },
   // ...

playground/cypress.config.js

@@ -0,0 +1,18 @@
+const { defineConfig } = require('cypress')
+
+const dotenv = require('dotenv')
+
+dotenv.config({ path: process.env.ENV_PATH })
+
+module.exports = defineConfig({
+  e2e: {
+    setupNodeEvents(on, config) {
+      // implement node event listeners here
+    },
+    baseUrl: `http://${process.env.HOST}:${process.env.PORT}`,
+  },
+  env: {
+    ADMIN_MAIL: process.env.INIT_ADMIN_EMAIL,
+    ADMIN_PASSWORD: process.env.INIT_ADMIN_PASSWORD,
+  },
+})