gt-sanity 0.0.5 → 0.0.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gt-sanity",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "General Translation integration with Sanity",
   "keywords": [
     "sanity",
@@ -59,11 +59,13 @@
     "@sanity/incompatible-plugin": "^1.0.5",
     "@sanity/ui": "^2.16.4",
     "@sanity/util": "^3.98.1",
-    "generaltranslation": "^7.6.2",
+    "generaltranslation": "^7.6.3",
+    "jsonpath-plus": "^10.3.0",
+    "jsonpointer": "^5.0.1",
+    "lightningcss": "^1.30.1",
     "sanity-naive-html-serializer": "^3.2.0"
   },
   "devDependencies": {
-    "lightningcss": "^1.30.1",
     "@sanity/pkg-utils": "^8.1.6",
     "@sanity/plugin-kit": "^4.0.19",
     "@types/react": "^19.1.12",

package/src/adapter/core.ts

@@ -1,6 +1,8 @@
 import { GT } from 'generaltranslation';
 import { libraryDefaultLocale } from 'generaltranslation/internal';
 import type { Secrets } from '../types';
+import type { TranslateDocumentFilter, IgnoreFields } from './types';
+import { SECRETS_NAMESPACE } from '../utils/shared';
 
 export const gt = new GT();
 
@@ -12,33 +14,96 @@ export function overrideConfig(secrets: Secrets | null) {
 }
 
 export class GTConfig {
+  secretsNamespace: string;
+  languageField: string;
   sourceLocale: string;
   locales: string[];
+  singletons: string[];
+  singletonMapping: (sourceDocumentId: string, locale: string) => string;
+  ignoreFields: IgnoreFields[];
+  translateDocuments: TranslateDocumentFilter[];
   private static instance: GTConfig;
-  constructor(sourceLocale: string, locales: string[]) {
+  constructor(
+    secretsNamespace: string,
+    languageField: string,
+    sourceLocale: string,
+    locales: string[],
+    singletons: string[],
+    singletonMapping: (sourceDocumentId: string, locale: string) => string,
+    ignoreFields: IgnoreFields[],
+    translateDocuments: TranslateDocumentFilter[]
+  ) {
+    this.secretsNamespace = secretsNamespace;
+    this.languageField = languageField;
     this.sourceLocale = sourceLocale;
     this.locales = locales;
+    this.singletons = singletons;
+    this.singletonMapping = singletonMapping;
+    this.ignoreFields = ignoreFields;
+    this.translateDocuments = translateDocuments;
   }
 
   static getInstance() {
     if (!this.instance) {
-      this.instance = new GTConfig(gt.sourceLocale || libraryDefaultLocale, []);
+      this.instance = new GTConfig(
+        SECRETS_NAMESPACE,
+        'language',
+        gt.sourceLocale || libraryDefaultLocale,
+        [],
+        [],
+        () => '',
+        [],
+        []
+      );
     }
     return this.instance;
   }
 
-  setSourceLocale(sourceLocale: string) {
+  init(
+    secretsNamespace: string,
+    languageField: string,
+    sourceLocale: string,
+    locales: string[],
+    singletons: string[],
+    singletonMapping: (sourceDocumentId: string, locale: string) => string,
+    ignoreFields: IgnoreFields[],
+    translateDocuments: TranslateDocumentFilter[]
+  ) {
+    this.secretsNamespace = secretsNamespace;
+    this.languageField = languageField;
     this.sourceLocale = sourceLocale;
+    this.locales = locales;
+    this.singletons = singletons;
+    this.singletonMapping = singletonMapping;
+    this.ignoreFields = ignoreFields;
+    this.translateDocuments = translateDocuments;
   }
-  getSourceLocale() {
-    return this.sourceLocale;
+
+  getSecretsNamespace() {
+    return this.secretsNamespace;
   }
 
-  setLocales(locales: string[]) {
-    this.locales = locales;
+  getLanguageField() {
+    return this.languageField;
+  }
+
+  getSourceLocale() {
+    return this.sourceLocale;
   }
   getLocales() {
     return this.locales;
   }
+  getSingletons() {
+    return this.singletons;
+  }
+  getSingletonMapping() {
+    return this.singletonMapping;
+  }
+  getIgnoreFields() {
+    return this.ignoreFields;
+  }
+  getTranslateDocuments() {
+    return this.translateDocuments;
+  }
 }
 export const gtConfig = GTConfig.getInstance();

package/src/adapter/createTask.ts

@@ -13,7 +13,7 @@ export const createTask: Adapter['createTask'] = async (
   workflowUid?: string,
   callbackUrl?: string
 ) => {
-  const fileName = `sanity-${documentInfo.documentId}`;
+  const fileName = `sanity/${documentInfo.documentId}`;
   overrideConfig(secrets);
   const uploadResult = await gt.uploadSourceFiles(
     [

package/src/adapter/types.ts

@@ -0,0 +1,9 @@
+export type IgnoreFields = {
+  documentId?: string;
+  fields?: { property: string; type?: string }[];
+};
+
+export type TranslateDocumentFilter = {
+  documentId?: string;
+  type?: string;
+};

package/src/components/LanguageStatus.tsx

@@ -1,3 +1,5 @@
+// adapted from https://github.com/sanity-io/sanity-translations-tab. See LICENSE.md for more details.
+
 import { useCallback, useState } from 'react';
 import { Flex, Card, Text, Grid, Box, Button } from '@sanity/ui';
 import { DownloadIcon, CheckmarkCircleIcon } from '@sanity/icons';

package/src/components/NewTask.tsx

@@ -1,3 +1,5 @@
+// adapted from https://github.com/sanity-io/sanity-translations-tab. See LICENSE.md for more details.
+
 import React, {
   useState,
   useContext,

package/src/components/ProgressBar.tsx

@@ -1,3 +1,5 @@
+// adapted from https://github.com/sanity-io/sanity-translations-tab. See LICENSE.md for more details.
+
 import { Card, Flex, Label } from '@sanity/ui';
 
 export default function ProgressBar({ progress }: { progress: number }) {

package/src/components/TaskView.tsx

@@ -1,3 +1,5 @@
+// adapted from https://github.com/sanity-io/sanity-translations-tab. See LICENSE.md for more details.
+
 import { useCallback, useContext, useState, useEffect } from 'react';
 import { Box, Button, Flex, Text, Stack, useToast, Switch } from '@sanity/ui';
 import {

package/src/components/TranslationContext.tsx

@@ -1,9 +1,14 @@
+// adapted from https://github.com/sanity-io/sanity-translations-tab. See LICENSE.md for more details.
+
 import React from 'react';
+import { SanityDocument } from 'sanity';
 import { GTSerializedDocument } from '../types';
 import { Adapter, GTFile, Secrets, WorkflowIdentifiers } from '../types';
 
 export type ContextProps = {
   documentInfo: GTFile;
+  document: SanityDocument;
+  languageField: string;
   adapter: Adapter;
   importTranslation: (languageId: string, document: string) => Promise<void>;
   exportForTranslation: (documentInfo: GTFile) => Promise<GTSerializedDocument>;

package/src/components/TranslationView.tsx

@@ -1,10 +1,13 @@
+// adapted from https://github.com/sanity-io/sanity-translations-tab. See LICENSE.md for more details.
+
 /**
  * Add cleanup function to cancel async tasks
  */
 
-import { useCallback, useContext, useEffect, useState } from 'react';
-import { Stack, useToast } from '@sanity/ui';
+import { useCallback, useContext, useEffect, useState, useMemo } from 'react';
+import { Stack, useToast, Text, Card } from '@sanity/ui';
 import { TranslationContext } from './TranslationContext';
+import { gtConfig } from '../adapter/core';
 
 import { NewTask } from './NewTask';
 import { TaskView } from './TaskView';
@@ -17,6 +20,23 @@ export const TranslationView = () => {
   const context = useContext(TranslationContext);
   const toast = useToast();
 
+  // Extract the current document's language from the language field
+  const currentDocumentLanguage = useMemo(() => {
+    if (!context?.document || !context?.languageField) return null;
+
+    // Get the language from the document's language field
+    const documentLanguage = context.document[context.languageField];
+
+    // If no language field is set, assume it's the source language
+    return documentLanguage || gtConfig.getSourceLocale();
+  }, [context?.document, context?.languageField]);
+
+  // Only show translation components if we're on a source language document
+  const shouldShowTranslationComponents = useMemo(() => {
+    if (!currentDocumentLanguage) return false;
+    return currentDocumentLanguage === gtConfig.getSourceLocale();
+  }, [currentDocumentLanguage]);
+
   useEffect(() => {
     async function fetchData() {
       if (!context) {
@@ -71,6 +91,18 @@ export const TranslationView = () => {
     }
   }, [context, setTask]);
 
+  // Show message if we're not on a source language document
+  if (!shouldShowTranslationComponents) {
+    return (
+      <Card padding={4} tone='neutral' border>
+        <Text size={1} muted>
+          Translation tools are only available for{' '}
+          <code>{gtConfig.getSourceLocale()}</code> documents.
+        </Text>
+      </Card>
+    );
+  }
+
   return (
     <Stack space={6}>
       <NewTask locales={locales} refreshTask={refreshTask} />

package/src/components/TranslationsTab.tsx

@@ -1,3 +1,5 @@
+// adapted from https://github.com/sanity-io/sanity-translations-tab. See LICENSE.md for more details.
+
 import { useMemo } from 'react';
 import { SanityDocument, useSchema } from 'sanity';
 import { randomKey } from '@sanity/util/content';
@@ -154,6 +156,8 @@ const TranslationTab = (props: TranslationTabProps) => {
               <TranslationContext.Provider
                 value={{
                   documentInfo: { documentId, versionId: revisionId },
+                  document: displayed,
+                  languageField: props.options.languageField || 'language',
                   secrets,
                   importTranslation,
                   exportForTranslation,