import { GT } from 'generaltranslation'; import { configureApiClient } from './api'; export { api } from './api'; import { libraryDefaultLocale } from 'generaltranslation/internal'; import type { Secrets } from '../types'; import type { TranslateDocumentFilter, DedupeFields, IgnoreFields, SkipFields, FieldLevelTranslationMode, TranslationPreferences, } from './types'; import { SECRETS_NAMESPACE } from '../utils/shared'; import type { PortableTextHtmlComponents } from '@portabletext/to-html'; import type { CustomDeserializers } from '../serialization/types'; import type { PreviewUrlConfig } from '../translation/previewUrls'; export const gt = new GT(); /** * Built-in defaults for the automatic actions. * * The line is whether an action can put content in front of readers, or write * to something already in front of them: * - `autoRefresh` only polls for status, and auto-import depends on it. * - `autoImport` writes drafts, which are cheap to discard. * - `autoPatchReferences` normally writes a draft too, but rewrites references * on an already-published translation when that document has no draft, so it * is opt-in. * - `autoPublish` publishes, which no switch can undo. */ export const DEFAULT_TRANSLATION_PREFERENCES: TranslationPreferences = { autoRefresh: true, autoImport: true, autoPatchReferences: false, autoPublish: false, // Opt-in: turning this on means Sanity overwrites whatever General // Translation holds for that source version, including a completed // translation that has not been imported yet. preserveExistingTranslations: false, }; export function overrideConfig(secrets: Secrets | null) { const config = { ...(secrets?.project && { projectId: secrets.project }), ...(secrets?.secret && { apiKey: secrets.secret }), }; gt.setConfig(config); configureApiClient({ ...config, customMapping: gt.customMapping }); } export class GTConfig { secretsNamespace: string; languageField: string; sourceLocale: string; locales: string[]; singletons: string[]; singletonMapping: (sourceDocumentId: string, locale: string) => string; ignoreFields: IgnoreFields[]; dedupeFields: DedupeFields[]; skipFields: SkipFields[]; translateDocuments: TranslateDocumentFilter[]; additionalStopTypes: string[]; additionalSerializers: Partial; additionalDeserializers: CustomDeserializers; additionalBlockDeserializers: unknown[]; translationLevel: FieldLevelTranslationMode; fieldLevelDocuments: TranslateDocumentFilter[]; preferences: TranslationPreferences; allowNonDefaultSourceLocales: boolean = false; previewUrl: PreviewUrlConfig | null; private static instance: GTConfig; constructor( secretsNamespace: string, languageField: string, sourceLocale: string, locales: string[], singletons: string[], singletonMapping: (sourceDocumentId: string, locale: string) => string, ignoreFields: IgnoreFields[], dedupeFields: DedupeFields[], skipFields: SkipFields[], translateDocuments: TranslateDocumentFilter[], additionalStopTypes: string[] = [], additionalSerializers: Partial = {}, additionalDeserializers: CustomDeserializers = { types: {} }, additionalBlockDeserializers: unknown[] = [], translationLevel: FieldLevelTranslationMode = 'document', fieldLevelDocuments: TranslateDocumentFilter[] = [], preferences: TranslationPreferences = DEFAULT_TRANSLATION_PREFERENCES, allowNonDefaultSourceLocales: boolean = false, previewUrl: PreviewUrlConfig | null = null ) { this.secretsNamespace = secretsNamespace; this.languageField = languageField; this.sourceLocale = sourceLocale; this.locales = locales; this.singletons = singletons; this.singletonMapping = singletonMapping; this.ignoreFields = ignoreFields; this.dedupeFields = dedupeFields; this.skipFields = skipFields; this.translateDocuments = translateDocuments; this.additionalStopTypes = additionalStopTypes; this.additionalSerializers = additionalSerializers; this.additionalDeserializers = additionalDeserializers; this.additionalBlockDeserializers = additionalBlockDeserializers; this.translationLevel = translationLevel; this.fieldLevelDocuments = fieldLevelDocuments; this.preferences = preferences; this.allowNonDefaultSourceLocales = allowNonDefaultSourceLocales; this.previewUrl = previewUrl; } static getInstance() { if (!this.instance) { this.instance = new GTConfig( SECRETS_NAMESPACE, 'language', gt.sourceLocale || libraryDefaultLocale, [], [], () => '', [], [], [], [], [], { types: {} }, {}, [] ); } return this.instance; } init( secretsNamespace: string, languageField: string, sourceLocale: string, locales: string[], singletons: string[], singletonMapping: (sourceDocumentId: string, locale: string) => string, ignoreFields: IgnoreFields[], dedupeFields: DedupeFields[], skipFields: SkipFields[], translateDocuments: TranslateDocumentFilter[], additionalStopTypes: string[] = [], additionalSerializers: Partial = {}, additionalDeserializers: CustomDeserializers = { types: {} }, additionalBlockDeserializers: unknown[] = [], translationLevel: FieldLevelTranslationMode = 'document', fieldLevelDocuments: TranslateDocumentFilter[] = [], preferences: TranslationPreferences = DEFAULT_TRANSLATION_PREFERENCES, allowNonDefaultSourceLocales: boolean = false, previewUrl: PreviewUrlConfig | null = null ) { this.secretsNamespace = secretsNamespace; this.languageField = languageField; this.sourceLocale = sourceLocale; this.locales = locales; this.singletons = singletons; this.singletonMapping = singletonMapping; this.ignoreFields = ignoreFields; this.dedupeFields = dedupeFields; this.skipFields = skipFields; this.translateDocuments = translateDocuments; this.additionalStopTypes = additionalStopTypes; this.additionalSerializers = additionalSerializers; this.additionalDeserializers = additionalDeserializers; this.additionalBlockDeserializers = additionalBlockDeserializers; this.translationLevel = translationLevel; this.fieldLevelDocuments = fieldLevelDocuments; this.preferences = preferences; this.allowNonDefaultSourceLocales = allowNonDefaultSourceLocales; this.previewUrl = previewUrl; } getSecretsNamespace() { return this.secretsNamespace; } getLanguageField() { return this.languageField; } getSourceLocale() { return this.sourceLocale; } getLocales() { return this.locales; } getSingletons() { return this.singletons; } getSingletonMapping() { return this.singletonMapping; } getIgnoreFields() { return this.ignoreFields; } getDedupeFields() { return this.dedupeFields; } getSkipFields() { return this.skipFields; } getTranslateDocuments() { return this.translateDocuments; } getAdditionalStopTypes() { return this.additionalStopTypes; } getAdditionalSerializers() { return this.additionalSerializers; } getAdditionalDeserializers() { return this.additionalDeserializers; } getAdditionalBlockDeserializers() { return this.additionalBlockDeserializers; } getTranslationLevel() { return this.translationLevel; } getFieldLevelDocuments() { return this.fieldLevelDocuments; } getPreferences() { return this.preferences; } getAllowNonDefaultSourceLocales() { // Only an explicit `true` turns it on. return this.allowNonDefaultSourceLocales === true; } getPreviewUrl() { return this.previewUrl; } } export const pluginConfig = GTConfig.getInstance();