Port sanity-plugin-google-translate to monorepo #906

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft

Copilot wants to merge 79 commits into main from copilot/move-google-translate-plugin

+999 −0

.changeset/google-translate-monorepo-port.md

-Original file line number
+Diff line change
@@ -0,0 +1,14 @@
+    ---
+    'sanity-plugin-google-translate': major
+    ---
+    Port sanity-plugin-google-translate to the Sanity plugins monorepo
+    This major release includes several breaking changes as part of the migration to the monorepo:
+    - **React Compiler enabled**: The plugin is now optimized with React Compiler targeting React 19
+    - **ESM-only**: CommonJS support has been removed. The package now ships only ESM
+    - **React 19.2+ required**: Minimum React version is now 19.2
+    - **Sanity Studio v5+ required**: Minimum Sanity version is now v5
+    - **Node.js 20.19+ required**: Minimum Node.js version is now 20.19
+    - **styled-components 6.1+ required**: Peer dependency on styled-components ^6.1

dev/test-studio/package.json

-Original file line number
+Diff line change
@@ Expand Up / @@ -34,6 +34,7 @@ @@
         "sanity-plugin-aprimo": "workspace:*",
         "sanity-plugin-asset-source-unsplash": "workspace:*",
         "sanity-plugin-bynder-input": "workspace:*",
+        "sanity-plugin-google-translate": "workspace:*",
         "sanity-plugin-graph-view": "workspace:*",
         "sanity-plugin-iframe-pane": "workspace:*",
         "sanity-plugin-internationalized-array": "workspace:*",
@@ Expand Down @@

dev/test-studio/sanity.config.ts

-Original file line number
+Diff line change
@@ Expand Up / @@ -13,6 +13,7 @@ import {codeInputExample} from '#code-input' @@
     import {colorExample} from '#color'
     import {debugLiveSyncTagsExample} from '#debug-live-sync-tags'
     import {documentInternationalizationExample} from '#document-internationalization'
+    import {googleTranslateExample} from '#google-translate'
     import {iframePaneExample} from '#iframe-pane'
     import {
       internationalizedArrayAsyncLanguages,
@@ Expand Down Expand Up / @@ -62,6 +63,7 @@ export default defineConfig([ @@
         plugins: [
           structureTool(),
           assistExample(),
+          googleTranslateExample(),
           // add new plugins here
           latexInputExample(),
           debugLiveSyncTagsExample(),
@@ Expand Down @@

dev/test-studio/src/google-translate/index.tsx

-Original file line number
+Diff line change
@@ -0,0 +1,57 @@
+    import {defineField, definePlugin, defineType} from 'sanity'
+    import {googleTranslate} from 'sanity-plugin-google-translate'
+    const languages = [
+      {id: 'en', title: 'English', isDefault: true},
+      {id: 'es', title: 'Spanish'},
+      {id: 'fr', title: 'French'},
+    ]
+    const localizedString = defineType({
+      name: 'localizedString',
+      type: 'object',
+      options: {
+        // @ts-expect-error - plugin-specific object option
+        translate: true,
+        apiKey: 'DEMO_KEY',
+      },
+      fieldsets: [
+        {
+          title: 'Translations',
+          name: 'translations',
+          options: {collapsible: true, collapsed: false},
+        },
+      ],
+      fields: languages.map((lang) =>
+        defineField({
+          name: lang.id,
+          title: lang.title,
+          type: 'string',
+          fieldset: lang.isDefault ? undefined : 'translations',
+        }),
+      ),
+    })
+    const googleTranslateTest = defineType({
+      type: 'document',
+      name: 'googleTranslateTest',
+      title: 'Google Translate',
+      fields: [
+        defineField({type: 'string', name: 'title', title: 'Title'}),
+        defineField({
+          type: 'localizedString',
+          name: 'greeting',
+          title: 'Greeting',
+        }),
+        defineField({
+          type: 'localizedString',
+          name: 'description',
+          title: 'Description',
+        }),
+      ],
+    })
+    export const googleTranslateExample = definePlugin(() => ({
+      schema: {types: [localizedString, googleTranslateTest]},
+      plugins: [googleTranslate()],
+    }))

knip.jsonc

-Original file line number
+Diff line change
@@ Expand Up / @@ -152,6 +152,14 @@ @@
           ],
         },
         // add new plugin workspaces here
+        "plugins/sanity-plugin-google-translate": {
+          "entry": ["package.config.ts"],
+          "project": ["src/**/*.{ts,tsx}"],
+          "ignoreDependencies": [
+            // Used by @sanity/pkg-utils babel transform, not directly imported
+            "babel-plugin-styled-components",
+          ],
+        },
         "plugins/sanity-plugin-latex-input": {
           "entry": ["package.config.ts"],
           "project": ["src/**/*.{ts,tsx}"],
@@ Expand Down @@

plugins/sanity-plugin-google-translate/CHANGELOG.md

-Original file line number
+Diff line change
@@ -0,0 +1,104 @@
+    # sanity-plugin-google-translate
+    ## [3.0.3](https://github.com/sanity-io/sanity-plugin-google-translate/compare/v3.0.2...v3.0.3) (2025-12-29)
+    ### Bug Fixes
+    - update package.json and package-lock.json to support Sanity v5 ([#27](https://github.com/sanity-io/sanity-plugin-google-translate/issues/27)) ([b3eaeee](https://github.com/sanity-io/sanity-plugin-google-translate/commit/b3eaeeeb032da5666bce955ac2f84473d6b147d5))
+    ## [3.0.2](https://github.com/sanity-io/sanity-plugin-google-translate/compare/v3.0.1...v3.0.2) (2025-07-10)
+    ### Bug Fixes
+    - **deps:** bump icons ([2e8606b](https://github.com/sanity-io/sanity-plugin-google-translate/commit/2e8606b3b41e2537f78a797ba9b87966da0688cd))
+    ## [3.0.1](https://github.com/sanity-io/sanity-plugin-google-translate/compare/v3.0.0...v3.0.1) (2025-07-10)
+    ### Bug Fixes
+    - **deps:** allow studio v4 peer dep ranges ([91a003c](https://github.com/sanity-io/sanity-plugin-google-translate/commit/91a003c01d86a181665807e3585c3f230816f78a))
+    ## [3.0.0](https://github.com/sanity-io/sanity-plugin-google-translate/compare/v2.0.0...v3.0.0) (2023-04-04)
+    ### ⚠ BREAKING CHANGES
+    - First new version of v3-compatible plugin
+    ### Features
+    - force new release ([7af61d9](https://github.com/sanity-io/sanity-plugin-google-translate/commit/7af61d93a0348c63011b2391cf4df83555eb16b1))
+    ## [3.0.0](https://github.com/sanity-io/sanity-plugin-google-translate/compare/v2.0.0...v3.0.0) (2023-04-04)
+    ### ⚠ BREAKING CHANGES
+    - First new version of v3-compatible plugin
+    ### Features
+    - force new release ([7af61d9](https://github.com/sanity-io/sanity-plugin-google-translate/commit/7af61d93a0348c63011b2391cf4df83555eb16b1))
+    ## [3.0.0](https://github.com/sanity-io/sanity-plugin-google-translate/compare/v2.0.0...v3.0.0) (2023-04-04)
+    ### ⚠ BREAKING CHANGES
+    - First new version of v3-compatible plugin
+    ### Features
+    - force new release ([7af61d9](https://github.com/sanity-io/sanity-plugin-google-translate/commit/7af61d93a0348c63011b2391cf4df83555eb16b1))
+    ## [2.0.0](https://github.com/sanity-io/sanity-plugin-google-translate/compare/v1.0.0...v2.0.0) (2023-04-04)
+    ### ⚠ BREAKING CHANGES
+    - First new version of v3-compatible plugin
+    ### Features
+    - force new release ([732b9d5](https://github.com/sanity-io/sanity-plugin-google-translate/commit/732b9d5a0864ce7acd800de53f411289db70fe57))
+    ## 1.0.0 (2023-04-04)
+    ### ⚠ BREAKING CHANGES
+    - First new version of v3-compatible plugin
+    ### Features
+    - begin v3 upgrade ([86646ed](https://github.com/sanity-io/sanity-plugin-google-translate/commit/86646ed26e69325b2c78561b9135986b4cca6e57))
+    - complete input, readme, update plugin-kit ([0901d62](https://github.com/sanity-io/sanity-plugin-google-translate/commit/0901d622b29f82ad10a727ef017833bcd2ffd187))
+    - rap up work on new plugin ([91561fa](https://github.com/sanity-io/sanity-plugin-google-translate/commit/91561fa1ac6a99380cf2c1b2ef16ba744bceb086))
+    ### Bug Fixes
+    - build settings ([15a48ed](https://github.com/sanity-io/sanity-plugin-google-translate/commit/15a48ede35d7cf582c7d3e89d0bfe5fa45d76445))
+    - remove old/temp files ([f85ad9b](https://github.com/sanity-io/sanity-plugin-google-translate/commit/f85ad9bc9072bff330289b9842bf3508c93cc917))
+    ## [1.0.2](https://github.com/SimeonGriggs/sanity-plugin-utils/compare/v1.0.1...v1.0.2) (2023-02-09)
+    ### Bug Fixes
+    - add a package lock ([a7703cd](https://github.com/SimeonGriggs/sanity-plugin-utils/commit/a7703cdbde1cc0b09b4d66624327c4713efb5643))
+    - add api version to useClient ([cf3451f](https://github.com/SimeonGriggs/sanity-plugin-utils/commit/cf3451f7aff25e1d683c2d96d8587f7d3057466d))
+    - downgrade semantic release ([4ae8a7b](https://github.com/SimeonGriggs/sanity-plugin-utils/commit/4ae8a7bb0035e970c61c72bbe67522e59362f713))
+    - go live ([c1fc363](https://github.com/SimeonGriggs/sanity-plugin-utils/commit/c1fc363799d3d6f5c484244edad0fd4de4df197b))
+    - inject ([c54e564](https://github.com/SimeonGriggs/sanity-plugin-utils/commit/c54e564707660a364b08920e5b364519465ae25e))
+    - inject latest ([58175fe](https://github.com/SimeonGriggs/sanity-plugin-utils/commit/58175fec34d4392a8424ce28ff3e2f50615e4e69))
+    - remove parcel cache ([126bcdf](https://github.com/SimeonGriggs/sanity-plugin-utils/commit/126bcdf949a5bd64a91ac71e4ac6ff5b6a69844d))
+    - update plugin config ([24c1add](https://github.com/SimeonGriggs/sanity-plugin-utils/commit/24c1add389be2bcbd222b3698b077c4e047f1afe))
+    ## [1.0.1](https://github.com/SimeonGriggs/sanity-plugin-utils/compare/v1.0.0...v1.0.1) (2022-12-13)
+    ### Bug Fixes
+    - update deps to v3 studio ([fb0c225](https://github.com/SimeonGriggs/sanity-plugin-utils/commit/fb0c2259e99deb28af0af84353471f7e60759a15))
+    - update package-lock ([45b3faf](https://github.com/SimeonGriggs/sanity-plugin-utils/commit/45b3faf195bf4c44200b313fa755847d915a3e1e))
+    - update packages ([72c518c](https://github.com/SimeonGriggs/sanity-plugin-utils/commit/72c518cc4b8d11528a546c5be1c66285ecff3f3f))
+    ## 1.0.0 (2022-11-17)
+    ### Features
+    - release ([5f6a76c](https://github.com/SimeonGriggs/sanity-plugin-utils/commit/5f6a76c8621d8b13d60d567f8f2449aaff775568))
+    - remove dry run and do first release ([33359be](https://github.com/SimeonGriggs/sanity-plugin-utils/commit/33359bed43a8a69296fbb62c2d8ad3abbae17217))

plugins/sanity-plugin-google-translate/README.md

-Original file line number
+Diff line change
@@ -0,0 +1,115 @@
+    # sanity-plugin-google-translate
+    This plugin lets you connect Sanity fields to Google Cloud Translate API, giving you instant machine translations for 108 languages and counting! Enable it for all of them! ...or just the ones you need.
+    ## Installation
+    ```
+    npm install --save sanity-plugin-google-translate
+    OR
+    yarn add sanity-plugin-google-translate
+    ```
+    ## Usage
+    First, add it as a plugin in `sanity.config.ts/js`
+    ```ts
+    // ./sanity.config.ts
+    import {createConfig} from 'sanity'
+    import {googleTranslate} from 'sanity-plugin-google-translate'
+    export const createConfig({
+        // ...all other config settings
+        plugins: [
+           // ...all other plugins
+           googleTranslate()
+        ]
+    })
+    ```
+    This plugin is designed to work with <a href="https://www.sanity.io/docs/localization#cd568b11a09c">field-level translated objects</a> and replace the default input component with a Google Translate-powered one. By setting `options.translate = true` on an object field definition.
+    These objects should be registered in the way recommended by the <a href="https://www.npmjs.com/package/@sanity/language-filter">@sanity/language-filter plugin</a>. With a field for each language. The base language at the top level, and all other languages inside a fieldset.
+    Note: This will not translate Portable Text content, as that schema type should not be mapped over multiple times in a single document. If you need multiple languages of Portable Text, you are best to use <a href="https://github.com/sanity-io/document-internationalization">document-level translation</a>.
+    ### Example: Add Google Translate to all localized `string` objects
+    ```js
+    // ./schemas/fields/localizedString.ts
+    const languages = [
+      {id: 'en', title: 'English', isDefault: true},
+      {id: 'es', title: 'Spanish'},
+      {id: 'fr', title: 'French'},
+    ]
+    export default defineField({
+      name: 'localizedString',
+      type: 'object',
+      options: {
+        // This will replace the default input component
+        translate: true,
+        // This API key will be bundled with your studio
+        // and so should be restricted by hostname
+        // See: https://www.sanity.io/docs/studio-environment-variables
+        apiKey: process.env.SANITY_STUDIO_GOOGLE_TRANSLATE_API_KEY,
+      },
+      fieldsets: [
+        {
+          title: 'Translations',
+          name: 'translations',
+          options: {collapsible: true, collapsed: false},
+        },
+      ],
+      fields: languages.map((lang) => ({
+        name: lang.id,
+        title: lang.title,
+        type: 'string', // or `text`, etc
+        fieldset: lang.isDefault ? null : 'translations',
+      })),
+    })
+    ```
+    ### Example: Extend some localized `string` objects with Google Translate
+    Alternatively, you could selectively extend specific uses of `localizedString`, by registering another object to your schema which uses it as a base. This is helpful if you only need Google Translate on specific fields.
+    ```ts
+    // ./schemas/fields/localizedGoogleTranslateString.ts
+    export default defineField({
+      name: 'localizedGoogleTranslateString',
+      title: 'Localized String',
+      type: 'localizedString',
+      options: {
+        translate: true,
+        apiKey: process.env.SANITY_STUDIO_GOOGLE_TRANSLATE_API_KEY,
+      },
+    })
+    ```
+    ## API Key security
+    By including your Google Cloud Translation API key in the schema definition it becomes part of the Studio bundle which is hosted as static files on web servers.
+    To avoid others using your key you should restrict it to hosts where your studio runs, like
+    - `http://localhost:3333/*`
+    - `http://<your-project>.sanity.studio/*`
+    - ...or custom domain you may be hosting the Studio
+    <a href="https://cloud.google.com/docs/authentication/api-keys#adding_http_restrictions">More info on adding HTTP restrictions</a>
+    ## License
+    MIT © Sanity.io
+    See LICENSE
+    ## License
+    <a>MIT</a> © Sanity.io

plugins/sanity-plugin-google-translate/package.config.ts

-Original file line number
+Diff line change
@@ -0,0 +1,8 @@
+    import config from '@repo/package.config'
+    import {defineConfig} from '@sanity/pkg-utils'
+    export default defineConfig({
+      ...config,
+      babel: {reactCompiler: true, styledComponents: true},
+      reactCompilerOptions: {target: '19'},
+    })

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Port sanity-plugin-google-translate to monorepo #906

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Port sanity-plugin-google-translate to monorepo #906

Are you sure you want to change the base?

Port sanity-plugin-google-translate to monorepo #906

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!