gt-sanity 0.0.6 → 1.0.0

package/LICENSE.md

@@ -106,7 +106,7 @@ specific language governing permissions and limitations under the License.
 
 ## Additional Code
 
-The some portions 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.
+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/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 { customSerializers } from 'sanity-naive-html-serializer';
-import { defaultStopTypes } from 'sanity-naive-html-serializer';
-import { DeserializerRule } from '@sanity/block-tools';
+import type { DeserializerRule } from '@portabletext/block-tools';
 import { GT } from 'generaltranslation';
-import { JSX } from 'react';
+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,66 +31,76 @@ export declare interface Adapter {
   ) => Promise<any | null>;
 }
 
-export { BaseDocumentDeserializer };
-
-export { BaseDocumentMerger };
-
-export { BaseDocumentSerializer };
+export declare function attachGTData(
+  html: string,
+  data: Record<string, any>,
+  type: 'markDef'
+): string;
+
+export declare const BaseDocumentDeserializer: Deserializer;
+
+export declare const BaseDocumentMerger: Merger;
+
+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;
+};
 
-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 declare const customSerializers: Partial<PortableTextHtmlComponents>;
+
+export declare const defaultStopTypes: string[];
+
+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 { customSerializers };
-
-export declare const defaultDocumentLevelConfig: ConfigOptions;
-
-export declare const defaultFieldLevelConfig: ConfigOptions;
-
-export { defaultStopTypes };
-
-export declare const documentLevelPatch: (
-  docInfo: GTFile,
-  translatedFields: SanityDocument,
-  localeId: string,
-  client: SanityClient,
-  languageField?: string,
-  mergeWithTargetLocale?: boolean,
-  publish?: 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
@@ -102,8 +108,6 @@ export declare const findLatestDraft: (
 
 declare const gt: GT;
 
-export declare const GTAdapter: Adapter;
-
 declare type GTFile = {
   documentId: string;
   versionId?: string;
@@ -135,6 +139,10 @@ export declare type GTPluginConfig = Omit<
   languageField?: string;
   translateDocuments?: TranslateDocumentFilter[];
   secretsNamespace?: string;
+  additionalStopTypes?: string[];
+  additionalSerializers?: Partial<PortableTextHtmlComponents>;
+  additionalDeserializers?: Record<string, any>;
+  additionalBlockDeserializers?: any[];
 };
 
 declare type GTSerializedDocument = Omit<SerializedDocument, 'name'> & GTFile;
@@ -152,18 +160,28 @@ export declare type ImportTranslation = (
   localeId: string,
   document: string,
   context: TranslationFunctionContext,
-  serializationOptions?: {
-    additionalDeserializers?: Record<
-      string,
-      (value: HTMLElement) => TypedObject
-    >;
-    additionalBlockDeserializers?: DeserializerRule[];
-  },
-  languageField?: string,
   mergeWithTargetLocale?: boolean,
   publish?: boolean
 ) => 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;
   project: string;
@@ -174,7 +192,10 @@ export declare type Secrets = {
   proxy?: string;
 };
 
-export { SerializedDocument };
+export declare type SerializedDocument = {
+  name: string;
+  content: string;
+};
 
 declare type TranslateDocumentFilter = {
   documentId?: string;
@@ -186,6 +207,8 @@ export declare interface TranslationFunctionContext {
   schema: Schema;
 }
 
+declare type TranslationLevel = 'document' | 'field';
+
 declare type TranslationLocale = {
   localeId: string;
   description: string;
@@ -194,7 +217,7 @@ declare type TranslationLocale = {
 
 export declare const TranslationsTab: (
   props: TranslationTabProps
-) => JSX.Element;
+) => React_2.JSX.Element;
 
 export declare type TranslationsTabConfigOptions = {
   adapter: Adapter;
@@ -224,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 { customSerializers } from 'sanity-naive-html-serializer';
-import { defaultStopTypes } from 'sanity-naive-html-serializer';
-import { DeserializerRule } from '@sanity/block-tools';
+import type { DeserializerRule } from '@portabletext/block-tools';
 import { GT } from 'generaltranslation';
-import { JSX } from 'react';
+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,66 +31,76 @@ export declare interface Adapter {
   ) => Promise<any | null>;
 }
 
-export { BaseDocumentDeserializer };
-
-export { BaseDocumentMerger };
-
-export { BaseDocumentSerializer };
+export declare function attachGTData(
+  html: string,
+  data: Record<string, any>,
+  type: 'markDef'
+): string;
+
+export declare const BaseDocumentDeserializer: Deserializer;
+
+export declare const BaseDocumentMerger: Merger;
+
+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;
+};
 
-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 declare const customSerializers: Partial<PortableTextHtmlComponents>;
+
+export declare const defaultStopTypes: string[];
+
+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 { customSerializers };
-
-export declare const defaultDocumentLevelConfig: ConfigOptions;
-
-export declare const defaultFieldLevelConfig: ConfigOptions;
-
-export { defaultStopTypes };
-
-export declare const documentLevelPatch: (
-  docInfo: GTFile,
-  translatedFields: SanityDocument,
-  localeId: string,
-  client: SanityClient,
-  languageField?: string,
-  mergeWithTargetLocale?: boolean,
-  publish?: 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
@@ -102,8 +108,6 @@ export declare const findLatestDraft: (
 
 declare const gt: GT;
 
-export declare const GTAdapter: Adapter;
-
 declare type GTFile = {
   documentId: string;
   versionId?: string;
@@ -135,6 +139,10 @@ export declare type GTPluginConfig = Omit<
   languageField?: string;
   translateDocuments?: TranslateDocumentFilter[];
   secretsNamespace?: string;
+  additionalStopTypes?: string[];
+  additionalSerializers?: Partial<PortableTextHtmlComponents>;
+  additionalDeserializers?: Record<string, any>;
+  additionalBlockDeserializers?: any[];
 };
 
 declare type GTSerializedDocument = Omit<SerializedDocument, 'name'> & GTFile;
@@ -152,18 +160,28 @@ export declare type ImportTranslation = (
   localeId: string,
   document: string,
   context: TranslationFunctionContext,
-  serializationOptions?: {
-    additionalDeserializers?: Record<
-      string,
-      (value: HTMLElement) => TypedObject
-    >;
-    additionalBlockDeserializers?: DeserializerRule[];
-  },
-  languageField?: string,
   mergeWithTargetLocale?: boolean,
   publish?: boolean
 ) => 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;
   project: string;
@@ -174,7 +192,10 @@ export declare type Secrets = {
   proxy?: string;
 };
 
-export { SerializedDocument };
+export declare type SerializedDocument = {
+  name: string;
+  content: string;
+};
 
 declare type TranslateDocumentFilter = {
   documentId?: string;
@@ -186,6 +207,8 @@ export declare interface TranslationFunctionContext {
   schema: Schema;
 }
 
+declare type TranslationLevel = 'document' | 'field';
+
 declare type TranslationLocale = {
   localeId: string;
   description: string;
@@ -194,7 +217,7 @@ declare type TranslationLocale = {
 
 export declare const TranslationsTab: (
   props: TranslationTabProps
-) => JSX.Element;
+) => React_2.JSX.Element;
 
 export declare type TranslationsTabConfigOptions = {
   adapter: Adapter;
@@ -224,7 +247,6 @@ declare type TranslationTabProps = {
   document: {
     displayed: SanityDocument;
   };
-  options: TranslationsTabConfigOptions;
 };
 
 declare type TranslationTask = {