gt-sanity 0.0.5

package/src/index.ts

@@ -0,0 +1,120 @@
+import TranslationsTab from './components/TranslationsTab';
+import {
+  Secrets,
+  Adapter,
+  ExportForTranslation,
+  ImportTranslation,
+  TranslationFunctionContext,
+  TranslationsTabConfigOptions,
+  GTFile,
+} from './types';
+import {
+  baseDocumentLevelConfig,
+  legacyDocumentLevelConfig as baseLegacyDocumentLevelConfig,
+  legacyDocumentLevelPatch,
+  baseFieldLevelConfig,
+  findLatestDraft,
+  documentLevelPatch,
+  fieldLevelPatch,
+} from './configuration';
+import {
+  BaseDocumentSerializer,
+  BaseDocumentDeserializer,
+  BaseDocumentMerger,
+  defaultStopTypes,
+  customSerializers,
+  SerializedDocument,
+} from 'sanity-naive-html-serializer';
+
+export type {
+  Secrets,
+  Adapter,
+  ExportForTranslation,
+  ImportTranslation,
+  TranslationFunctionContext,
+  TranslationsTabConfigOptions,
+  SerializedDocument,
+};
+export {
+  TranslationsTab,
+  //helpers for end developers who may need to customize serialization
+  findLatestDraft,
+  legacyDocumentLevelPatch,
+  documentLevelPatch,
+  fieldLevelPatch,
+  BaseDocumentSerializer,
+  BaseDocumentDeserializer,
+  BaseDocumentMerger,
+  defaultStopTypes,
+  customSerializers,
+};
+
+import { GTAdapter } from './adapter';
+import { definePlugin } from 'sanity';
+import { gt, gtConfig } from './adapter/core';
+import { GTSerializedDocument } from './types';
+import { libraryDefaultLocale } from 'generaltranslation/internal';
+
+interface ConfigOptions {
+  adapter: Adapter;
+  secretsNamespace: string | null;
+  exportForTranslation: (
+    docInfo: GTFile,
+    context: TranslationFunctionContext
+  ) => Promise<GTSerializedDocument>;
+  importTranslation: (
+    docInfo: GTFile,
+    localeId: string,
+    doc: string,
+    context: TranslationFunctionContext
+  ) => Promise<void>;
+}
+
+export const defaultDocumentLevelConfig: ConfigOptions = {
+  ...baseDocumentLevelConfig,
+  adapter: GTAdapter,
+  secretsNamespace: 'generaltranslation',
+};
+
+export const legacyDocumentLevelConfig: ConfigOptions = {
+  ...baseLegacyDocumentLevelConfig,
+  adapter: GTAdapter,
+  secretsNamespace: 'generaltranslation',
+};
+
+export const defaultFieldLevelConfig: ConfigOptions = {
+  ...baseFieldLevelConfig,
+  adapter: GTAdapter,
+  secretsNamespace: 'generaltranslation',
+};
+
+export { GTAdapter };
+
+/**
+ * Usage in `sanity.config.ts` (or .js)
+ *
+ * ```ts
+ * import {defineConfig} from 'sanity'
+ * import {gtPlugin} from '@generaltranslation/sanity'
+ *
+ * export default defineConfig({
+ *   // ...
+ *   plugins: [gtPlugin()],
+ * })
+ * ```
+ */
+export const gtPlugin = definePlugin<
+  Omit<Parameters<typeof gt.setConfig>[0], 'locales'> & { locales: string[] }
+>(({ sourceLocale, locales, customMapping, apiKey, projectId }) => {
+  gtConfig.setLocales(locales);
+  gtConfig.setSourceLocale(sourceLocale || libraryDefaultLocale);
+  gt.setConfig({
+    sourceLocale: sourceLocale,
+    customMapping: customMapping,
+    apiKey: apiKey,
+    projectId: projectId,
+  });
+  return {
+    name: '@generaltranslation/sanity',
+  };
+});

package/src/types.ts

@@ -0,0 +1,124 @@
+import { SanityClient, Schema, TypedObject } from 'sanity';
+import { SerializedDocument } from 'sanity-naive-html-serializer';
+import { PortableTextTypeComponent } from '@portabletext/to-html';
+import { DeserializerRule } from '@sanity/block-tools';
+
+export type TranslationTaskLocaleStatus = {
+  localeId: string;
+  progress: number;
+};
+
+export type TranslationTask = {
+  document: GTFile;
+  locales: TranslationTaskLocaleStatus[];
+  linkToVendorTask?: string;
+};
+
+export type TranslationLocale = {
+  localeId: string;
+  description: string;
+  enabled?: boolean;
+};
+
+//this varies according to provider
+//not every vendor uses every field
+export type Secrets = {
+  organization: string;
+  project: string;
+  token?: string;
+  secret?: string;
+  username?: string;
+  password?: string;
+  proxy?: string;
+};
+
+export type WorkflowIdentifiers = {
+  workflowUid: string;
+  workflowName: string;
+};
+
+export type GTFile = {
+  documentId: string;
+  versionId?: string;
+};
+
+export interface Adapter {
+  getLocales: (secrets: Secrets | null) => Promise<TranslationLocale[]>;
+  getTranslationTask: (
+    document: GTFile,
+    secrets: Secrets | null
+  ) => Promise<TranslationTask>;
+  createTask: (
+    documentInfo: GTFile,
+    serializedDocument: GTSerializedDocument,
+    localeIds: string[],
+    secrets: Secrets | null,
+    workflowUid?: string,
+    callbackUrl?: string
+  ) => Promise<TranslationTask>;
+  getTranslation: (
+    document: GTFile,
+    localeId: string,
+    secrets: Secrets | null
+  ) => Promise<any | null>;
+}
+
+export interface TranslationFunctionContext {
+  client: SanityClient;
+  schema: Schema;
+}
+
+export type GTSerializedDocument = Omit<SerializedDocument, 'name'> & GTFile;
+
+export type ExportForTranslation = (
+  documentInfo: GTFile,
+  context: TranslationFunctionContext,
+  serializationOptions?: {
+    additionalStopTypes?: string[];
+    additionalSerializers?: Record<
+      string,
+      PortableTextTypeComponent | undefined
+    >;
+  },
+  languageField?: string
+) => Promise<GTSerializedDocument>;
+
+export type ImportTranslation = (
+  documentInfo: GTFile,
+  localeId: string,
+  document: string,
+  context: TranslationFunctionContext,
+  serializationOptions?: {
+    additionalDeserializers?: Record<
+      string,
+      (value: HTMLElement) => TypedObject
+    >;
+    additionalBlockDeserializers?: DeserializerRule[];
+  },
+  languageField?: string,
+  mergeWithTargetLocale?: boolean
+) => Promise<void>;
+
+export type TranslationsTabConfigOptions = {
+  adapter: Adapter;
+  secretsNamespace: string | null;
+  exportForTranslation: ExportForTranslation;
+  importTranslation: ImportTranslation;
+  serializationOptions?: {
+    additionalStopTypes?: string[];
+    additionalSerializers?: Record<
+      string,
+      PortableTextTypeComponent | undefined
+    >;
+    additionalDeserializers?: Record<
+      string,
+      (value: HTMLElement) => TypedObject
+    >;
+    additionalBlockDeserializers?: DeserializerRule[];
+  };
+  workflowOptions?: WorkflowIdentifiers[];
+  localeIdAdapter?: (id: string) => string;
+  languageField?: string;
+  callbackUrl?: string;
+  mergeWithTargetLocale?: boolean;
+};

package/v2-incompatible.js

@@ -0,0 +1,11 @@
+const { showIncompatiblePluginDialog } = require('@sanity/incompatible-plugin');
+const { name, version, sanityExchangeUrl } = require('./package.json');
+
+export default showIncompatiblePluginDialog({
+  name: name,
+  versions: {
+    v3: version,
+    v2: undefined,
+  },
+  sanityExchangeUrl,
+});