gt-sanity 0.0.5 → 1.0.0

package/LICENSE.md

@@ -106,14 +106,7 @@ specific language governing permissions and limitations under the License.
 
 ## Additional Code
 
-The following files of the Software are adapted from https://github.com/sanity-io/sanity-translations-tab.
-These portions are licensed under the license of the original software, listed below.
-
-- src/components/\*\*
-- src/configuration/\*\*
-- src/hooks/\*\*
-- src/types.ts
-- src/utils/\*\*
+Some portions of the Software are adapted from https://github.com/sanity-io/sanity-translations-tab and https://github.com/sanity-io/sanity-naive-html-serializer. These portions are licensed under the license of the original software, listed below.
 
 MIT License
 

package/README.md

@@ -1,11 +1,11 @@
-# @generaltranslation/sanity
+# gt-sanity
 
 > This is a **Sanity Studio v3** plugin.
 
 ## Installation
 
 ```sh
-npm install @generaltranslation/sanity
+npm install gt-sanity
 ```
 
 Then, create a [GT project](https://generaltranslation.com/dashboard) and get a production API key and project ID.
@@ -49,7 +49,7 @@ Add it as a plugin in `sanity.config.ts` (or .js):
 
 ```ts
 import { defineConfig } from 'sanity';
-import { gtPlugin } from '@generaltranslation/sanity';
+import { gtPlugin } from 'gt-sanity';
 
 export default defineConfig({
   //...
@@ -68,8 +68,8 @@ Add the Translation View to your document structure:
 ```ts
 // ./structure.ts
 import type { DefaultDocumentNodeResolver } from 'sanity/structure';
-import { TranslationsTab } from '@generaltranslation/sanity';
-import { defaultDocumentLevelConfig } from '@generaltranslation/sanity';
+import { TranslationsTab } from 'gt-sanity';
+import { defaultDocumentLevelConfig } from 'gt-sanity';
 export const defaultDocumentNode: DefaultDocumentNodeResolver = (
   S,
   { schemaType }

package/dist/index.d.mts

@@ -1,17 +1,13 @@
-import { BaseDocumentDeserializer } from 'sanity-naive-html-serializer';
-import { BaseDocumentMerger } from 'sanity-naive-html-serializer';
-import { BaseDocumentSerializer } from 'sanity-naive-html-serializer';
-import { CustomMapping } from 'generaltranslation/types';
-import { customSerializers } from 'sanity-naive-html-serializer';
-import { defaultStopTypes } from 'sanity-naive-html-serializer';
-import { DeserializerRule } from '@sanity/block-tools';
-import { JSX } from 'react';
+import type { DeserializerRule } from '@portabletext/block-tools';
+import { GT } from 'generaltranslation';
+import { ObjectField } from 'sanity';
 import { Plugin as Plugin_2 } from 'sanity';
+import { PortableTextHtmlComponents } from '@portabletext/to-html';
 import { PortableTextTypeComponent } from '@portabletext/to-html';
+import { default as React_2 } from 'react';
 import { SanityClient } from 'sanity';
 import { SanityDocument } from 'sanity';
 import { Schema } from 'sanity';
-import { SerializedDocument } from 'sanity-naive-html-serializer';
 import { TypedObject } from 'sanity';
 
 export declare interface Adapter {
@@ -35,71 +31,82 @@ export declare interface Adapter {
   ) => Promise<any | null>;
 }
 
-export { BaseDocumentDeserializer };
+export declare function attachGTData(
+  html: string,
+  data: Record<string, any>,
+  type: 'markDef'
+): string;
 
-export { BaseDocumentMerger };
+export declare const BaseDocumentDeserializer: Deserializer;
 
-export { BaseDocumentSerializer };
+export declare const BaseDocumentMerger: Merger;
 
-declare 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 { customSerializers };
+export declare const BaseDocumentSerializer: (schemas: Schema) => {
+  serializeDocument: (
+    doc: SanityDocument,
+    translationLevel?: TranslationLevel,
+    baseLang?: string,
+    stopTypes?: string[],
+    serializers?: Partial<PortableTextHtmlComponents>
+  ) => {
+    name: string;
+    content: string;
+  };
+  fieldFilter: (
+    obj: Record<string, any>,
+    objFields: ObjectField[],
+    stopTypes: string[]
+  ) => TypedObject;
+  languageObjectFieldFilter: (
+    obj: Record<string, any>,
+    baseLang: string
+  ) => Record<string, any>;
+  serializeArray: (
+    fieldContent: Record<string, any>[],
+    fieldName: string,
+    stopTypes: string[],
+    serializers: Record<string, any>
+  ) => string;
+  serializeObject: (
+    obj: TypedObject,
+    stopTypes: string[],
+    serializers: Record<string, any>
+  ) => string;
+};
 
-export declare const defaultDocumentLevelConfig: ConfigOptions;
+export declare const customSerializers: Partial<PortableTextHtmlComponents>;
 
-export declare const defaultFieldLevelConfig: ConfigOptions;
+export declare const defaultStopTypes: string[];
 
-export { defaultStopTypes };
+declare interface Deserializer {
+  deserializeDocument: (
+    serializedDoc: string,
+    deserializers?: Record<string, any>,
+    blockDeserializers?: Array<any>
+  ) => Record<string, any>;
+  deserializeHTML: (
+    html: string,
+    deserializers: Record<string, any>,
+    blockDeserializers: Array<any>
+  ) => Record<string, any> | any[];
+}
 
-export declare const documentLevelPatch: (
-  docInfo: GTFile,
-  translatedFields: SanityDocument,
-  localeId: string,
-  client: SanityClient,
-  languageField?: string,
-  mergeWithTargetLocale?: boolean
-) => Promise<void>;
+export declare function detachGTData(html: string): {
+  html: string;
+  data?: Record<'markDef', Record<string, any>>;
+};
 
 export declare type ExportForTranslation = (
   documentInfo: GTFile,
-  context: TranslationFunctionContext,
-  serializationOptions?: {
-    additionalStopTypes?: string[];
-    additionalSerializers?: Record<
-      string,
-      PortableTextTypeComponent | undefined
-    >;
-  },
-  languageField?: string
+  context: TranslationFunctionContext
 ) => Promise<GTSerializedDocument>;
 
-export declare const fieldLevelPatch: (
-  docInfo: GTFile,
-  translatedFields: SanityDocument,
-  localeId: string,
-  client: SanityClient,
-  mergeWithTargetLocale?: boolean
-) => Promise<void>;
-
 export declare const findLatestDraft: (
   documentId: string,
   client: SanityClient
 ) => Promise<SanityDocument>;
 
-export declare const GTAdapter: Adapter;
+declare const gt: GT;
 
 declare type GTFile = {
   documentId: string;
@@ -111,7 +118,7 @@ declare type GTFile = {
  *
  * ```ts
  * import {defineConfig} from 'sanity'
- * import {gtPlugin} from '@generaltranslation/sanity'
+ * import {gtPlugin} from 'gt-sanity'
  *
  * export default defineConfig({
  *   // ...
@@ -119,50 +126,61 @@ declare type GTFile = {
  * })
  * ```
  */
-export declare const gtPlugin: Plugin_2<
-  Omit<
-    {
-      apiKey?: string;
-      devApiKey?: string;
-      sourceLocale?: string;
-      targetLocale?: string;
-      locales?: string[];
-      projectId?: string;
-      baseUrl?: string;
-      customMapping?: CustomMapping;
-    },
-    'locales'
-  > & {
-    locales: string[];
-  }
->;
+export declare const gtPlugin: Plugin_2<GTPluginConfig>;
+
+export declare type GTPluginConfig = Omit<
+  Parameters<typeof gt.setConfig>[0],
+  'locales'
+> & {
+  locales: string[];
+  singletons?: string[];
+  singletonMapping?: (sourceDocumentId: string, locale: string) => string;
+  ignoreFields?: IgnoreFields[];
+  languageField?: string;
+  translateDocuments?: TranslateDocumentFilter[];
+  secretsNamespace?: string;
+  additionalStopTypes?: string[];
+  additionalSerializers?: Partial<PortableTextHtmlComponents>;
+  additionalDeserializers?: Record<string, any>;
+  additionalBlockDeserializers?: any[];
+};
 
 declare type GTSerializedDocument = Omit<SerializedDocument, 'name'> & GTFile;
 
+declare type IgnoreFields = {
+  documentId?: string;
+  fields?: {
+    property: string;
+    type?: string;
+  }[];
+};
+
 export declare type ImportTranslation = (
   documentInfo: GTFile,
   localeId: string,
   document: string,
   context: TranslationFunctionContext,
-  serializationOptions?: {
-    additionalDeserializers?: Record<
-      string,
-      (value: HTMLElement) => TypedObject
-    >;
-    additionalBlockDeserializers?: DeserializerRule[];
-  },
-  languageField?: string,
-  mergeWithTargetLocale?: boolean
+  mergeWithTargetLocale?: boolean,
+  publish?: boolean
 ) => Promise<void>;
 
-export declare const legacyDocumentLevelConfig: ConfigOptions;
-
-export declare const legacyDocumentLevelPatch: (
-  docInfo: GTFile,
-  translatedFields: SanityDocument,
-  localeId: string,
-  client: SanityClient
-) => Promise<void>;
+declare interface Merger {
+  fieldLevelMerge: (
+    translatedFields: Record<string, any>,
+    baseDoc: SanityDocument,
+    localeId: string,
+    baseLang: string
+  ) => Record<string, any>;
+  documentLevelMerge: (
+    translatedFields: Record<string, any>,
+    baseDoc: SanityDocument
+  ) => Record<string, any>;
+  reconcileArray: (origArray: any[], translatedArray: any[]) => any[];
+  reconcileObject: (
+    origObject: Record<string, any>,
+    translatedObject: Record<string, any>
+  ) => Record<string, any>;
+}
 
 export declare type Secrets = {
   organization: string;
@@ -174,13 +192,23 @@ export declare type Secrets = {
   proxy?: string;
 };
 
-export { SerializedDocument };
+export declare type SerializedDocument = {
+  name: string;
+  content: string;
+};
+
+declare type TranslateDocumentFilter = {
+  documentId?: string;
+  type?: string;
+};
 
 export declare interface TranslationFunctionContext {
   client: SanityClient;
   schema: Schema;
 }
 
+declare type TranslationLevel = 'document' | 'field';
+
 declare type TranslationLocale = {
   localeId: string;
   description: string;
@@ -189,7 +217,7 @@ declare type TranslationLocale = {
 
 export declare const TranslationsTab: (
   props: TranslationTabProps
-) => JSX.Element;
+) => React_2.JSX.Element;
 
 export declare type TranslationsTabConfigOptions = {
   adapter: Adapter;
@@ -219,7 +247,6 @@ declare type TranslationTabProps = {
   document: {
     displayed: SanityDocument;
   };
-  options: TranslationsTabConfigOptions;
 };
 
 declare type TranslationTask = {

package/dist/index.d.ts

@@ -1,17 +1,13 @@
-import { BaseDocumentDeserializer } from 'sanity-naive-html-serializer';
-import { BaseDocumentMerger } from 'sanity-naive-html-serializer';
-import { BaseDocumentSerializer } from 'sanity-naive-html-serializer';
-import { CustomMapping } from 'generaltranslation/types';
-import { customSerializers } from 'sanity-naive-html-serializer';
-import { defaultStopTypes } from 'sanity-naive-html-serializer';
-import { DeserializerRule } from '@sanity/block-tools';
-import { JSX } from 'react';
+import type { DeserializerRule } from '@portabletext/block-tools';
+import { GT } from 'generaltranslation';
+import { ObjectField } from 'sanity';
 import { Plugin as Plugin_2 } from 'sanity';
+import { PortableTextHtmlComponents } from '@portabletext/to-html';
 import { PortableTextTypeComponent } from '@portabletext/to-html';
+import { default as React_2 } from 'react';
 import { SanityClient } from 'sanity';
 import { SanityDocument } from 'sanity';
 import { Schema } from 'sanity';
-import { SerializedDocument } from 'sanity-naive-html-serializer';
 import { TypedObject } from 'sanity';
 
 export declare interface Adapter {
@@ -35,71 +31,82 @@ export declare interface Adapter {
   ) => Promise<any | null>;
 }
 
-export { BaseDocumentDeserializer };
+export declare function attachGTData(
+  html: string,
+  data: Record<string, any>,
+  type: 'markDef'
+): string;
 
-export { BaseDocumentMerger };
+export declare const BaseDocumentDeserializer: Deserializer;
 
-export { BaseDocumentSerializer };
+export declare const BaseDocumentMerger: Merger;
 
-declare 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 { customSerializers };
+export declare const BaseDocumentSerializer: (schemas: Schema) => {
+  serializeDocument: (
+    doc: SanityDocument,
+    translationLevel?: TranslationLevel,
+    baseLang?: string,
+    stopTypes?: string[],
+    serializers?: Partial<PortableTextHtmlComponents>
+  ) => {
+    name: string;
+    content: string;
+  };
+  fieldFilter: (
+    obj: Record<string, any>,
+    objFields: ObjectField[],
+    stopTypes: string[]
+  ) => TypedObject;
+  languageObjectFieldFilter: (
+    obj: Record<string, any>,
+    baseLang: string
+  ) => Record<string, any>;
+  serializeArray: (
+    fieldContent: Record<string, any>[],
+    fieldName: string,
+    stopTypes: string[],
+    serializers: Record<string, any>
+  ) => string;
+  serializeObject: (
+    obj: TypedObject,
+    stopTypes: string[],
+    serializers: Record<string, any>
+  ) => string;
+};
 
-export declare const defaultDocumentLevelConfig: ConfigOptions;
+export declare const customSerializers: Partial<PortableTextHtmlComponents>;
 
-export declare const defaultFieldLevelConfig: ConfigOptions;
+export declare const defaultStopTypes: string[];
 
-export { defaultStopTypes };
+declare interface Deserializer {
+  deserializeDocument: (
+    serializedDoc: string,
+    deserializers?: Record<string, any>,
+    blockDeserializers?: Array<any>
+  ) => Record<string, any>;
+  deserializeHTML: (
+    html: string,
+    deserializers: Record<string, any>,
+    blockDeserializers: Array<any>
+  ) => Record<string, any> | any[];
+}
 
-export declare const documentLevelPatch: (
-  docInfo: GTFile,
-  translatedFields: SanityDocument,
-  localeId: string,
-  client: SanityClient,
-  languageField?: string,
-  mergeWithTargetLocale?: boolean
-) => Promise<void>;
+export declare function detachGTData(html: string): {
+  html: string;
+  data?: Record<'markDef', Record<string, any>>;
+};
 
 export declare type ExportForTranslation = (
   documentInfo: GTFile,
-  context: TranslationFunctionContext,
-  serializationOptions?: {
-    additionalStopTypes?: string[];
-    additionalSerializers?: Record<
-      string,
-      PortableTextTypeComponent | undefined
-    >;
-  },
-  languageField?: string
+  context: TranslationFunctionContext
 ) => Promise<GTSerializedDocument>;
 
-export declare const fieldLevelPatch: (
-  docInfo: GTFile,
-  translatedFields: SanityDocument,
-  localeId: string,
-  client: SanityClient,
-  mergeWithTargetLocale?: boolean
-) => Promise<void>;
-
 export declare const findLatestDraft: (
   documentId: string,
   client: SanityClient
 ) => Promise<SanityDocument>;
 
-export declare const GTAdapter: Adapter;
+declare const gt: GT;
 
 declare type GTFile = {
   documentId: string;
@@ -111,7 +118,7 @@ declare type GTFile = {
  *
  * ```ts
  * import {defineConfig} from 'sanity'
- * import {gtPlugin} from '@generaltranslation/sanity'
+ * import {gtPlugin} from 'gt-sanity'
  *
  * export default defineConfig({
  *   // ...
@@ -119,50 +126,61 @@ declare type GTFile = {
  * })
  * ```
  */
-export declare const gtPlugin: Plugin_2<
-  Omit<
-    {
-      apiKey?: string;
-      devApiKey?: string;
-      sourceLocale?: string;
-      targetLocale?: string;
-      locales?: string[];
-      projectId?: string;
-      baseUrl?: string;
-      customMapping?: CustomMapping;
-    },
-    'locales'
-  > & {
-    locales: string[];
-  }
->;
+export declare const gtPlugin: Plugin_2<GTPluginConfig>;
+
+export declare type GTPluginConfig = Omit<
+  Parameters<typeof gt.setConfig>[0],
+  'locales'
+> & {
+  locales: string[];
+  singletons?: string[];
+  singletonMapping?: (sourceDocumentId: string, locale: string) => string;
+  ignoreFields?: IgnoreFields[];
+  languageField?: string;
+  translateDocuments?: TranslateDocumentFilter[];
+  secretsNamespace?: string;
+  additionalStopTypes?: string[];
+  additionalSerializers?: Partial<PortableTextHtmlComponents>;
+  additionalDeserializers?: Record<string, any>;
+  additionalBlockDeserializers?: any[];
+};
 
 declare type GTSerializedDocument = Omit<SerializedDocument, 'name'> & GTFile;
 
+declare type IgnoreFields = {
+  documentId?: string;
+  fields?: {
+    property: string;
+    type?: string;
+  }[];
+};
+
 export declare type ImportTranslation = (
   documentInfo: GTFile,
   localeId: string,
   document: string,
   context: TranslationFunctionContext,
-  serializationOptions?: {
-    additionalDeserializers?: Record<
-      string,
-      (value: HTMLElement) => TypedObject
-    >;
-    additionalBlockDeserializers?: DeserializerRule[];
-  },
-  languageField?: string,
-  mergeWithTargetLocale?: boolean
+  mergeWithTargetLocale?: boolean,
+  publish?: boolean
 ) => Promise<void>;
 
-export declare const legacyDocumentLevelConfig: ConfigOptions;
-
-export declare const legacyDocumentLevelPatch: (
-  docInfo: GTFile,
-  translatedFields: SanityDocument,
-  localeId: string,
-  client: SanityClient
-) => Promise<void>;
+declare interface Merger {
+  fieldLevelMerge: (
+    translatedFields: Record<string, any>,
+    baseDoc: SanityDocument,
+    localeId: string,
+    baseLang: string
+  ) => Record<string, any>;
+  documentLevelMerge: (
+    translatedFields: Record<string, any>,
+    baseDoc: SanityDocument
+  ) => Record<string, any>;
+  reconcileArray: (origArray: any[], translatedArray: any[]) => any[];
+  reconcileObject: (
+    origObject: Record<string, any>,
+    translatedObject: Record<string, any>
+  ) => Record<string, any>;
+}
 
 export declare type Secrets = {
   organization: string;
@@ -174,13 +192,23 @@ export declare type Secrets = {
   proxy?: string;
 };
 
-export { SerializedDocument };
+export declare type SerializedDocument = {
+  name: string;
+  content: string;
+};
+
+declare type TranslateDocumentFilter = {
+  documentId?: string;
+  type?: string;
+};
 
 export declare interface TranslationFunctionContext {
   client: SanityClient;
   schema: Schema;
 }
 
+declare type TranslationLevel = 'document' | 'field';
+
 declare type TranslationLocale = {
   localeId: string;
   description: string;
@@ -189,7 +217,7 @@ declare type TranslationLocale = {
 
 export declare const TranslationsTab: (
   props: TranslationTabProps
-) => JSX.Element;
+) => React_2.JSX.Element;
 
 export declare type TranslationsTabConfigOptions = {
   adapter: Adapter;
@@ -219,7 +247,6 @@ declare type TranslationTabProps = {
   document: {
     displayed: SanityDocument;
   };
-  options: TranslationsTabConfigOptions;
 };
 
 declare type TranslationTask = {