gt-sanity 0.0.5 → 0.0.6

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/\*\*
+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.
 
 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,10 +1,10 @@
 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 { GT } from 'generaltranslation';
 import { JSX } from 'react';
 import { Plugin as Plugin_2 } from 'sanity';
 import { PortableTextTypeComponent } from '@portabletext/to-html';
@@ -70,7 +70,8 @@ export declare const documentLevelPatch: (
   localeId: string,
   client: SanityClient,
   languageField?: string,
-  mergeWithTargetLocale?: boolean
+  mergeWithTargetLocale?: boolean,
+  publish?: boolean
 ) => Promise<void>;
 
 export declare type ExportForTranslation = (
@@ -99,6 +100,8 @@ export declare const findLatestDraft: (
   client: SanityClient
 ) => Promise<SanityDocument>;
 
+declare const gt: GT;
+
 export declare const GTAdapter: Adapter;
 
 declare type GTFile = {
@@ -111,7 +114,7 @@ declare type GTFile = {
  *
  * ```ts
  * import {defineConfig} from 'sanity'
- * import {gtPlugin} from '@generaltranslation/sanity'
+ * import {gtPlugin} from 'gt-sanity'
  *
  * export default defineConfig({
  *   // ...
@@ -119,26 +122,31 @@ 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;
+};
 
 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,
@@ -152,16 +160,8 @@ export declare type ImportTranslation = (
     additionalBlockDeserializers?: DeserializerRule[];
   },
   languageField?: string,
-  mergeWithTargetLocale?: boolean
-) => Promise<void>;
-
-export declare const legacyDocumentLevelConfig: ConfigOptions;
-
-export declare const legacyDocumentLevelPatch: (
-  docInfo: GTFile,
-  translatedFields: SanityDocument,
-  localeId: string,
-  client: SanityClient
+  mergeWithTargetLocale?: boolean,
+  publish?: boolean
 ) => Promise<void>;
 
 export declare type Secrets = {
@@ -176,6 +176,11 @@ export declare type Secrets = {
 
 export { SerializedDocument };
 
+declare type TranslateDocumentFilter = {
+  documentId?: string;
+  type?: string;
+};
+
 export declare interface TranslationFunctionContext {
   client: SanityClient;
   schema: Schema;

package/dist/index.d.ts

@@ -1,10 +1,10 @@
 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 { GT } from 'generaltranslation';
 import { JSX } from 'react';
 import { Plugin as Plugin_2 } from 'sanity';
 import { PortableTextTypeComponent } from '@portabletext/to-html';
@@ -70,7 +70,8 @@ export declare const documentLevelPatch: (
   localeId: string,
   client: SanityClient,
   languageField?: string,
-  mergeWithTargetLocale?: boolean
+  mergeWithTargetLocale?: boolean,
+  publish?: boolean
 ) => Promise<void>;
 
 export declare type ExportForTranslation = (
@@ -99,6 +100,8 @@ export declare const findLatestDraft: (
   client: SanityClient
 ) => Promise<SanityDocument>;
 
+declare const gt: GT;
+
 export declare const GTAdapter: Adapter;
 
 declare type GTFile = {
@@ -111,7 +114,7 @@ declare type GTFile = {
  *
  * ```ts
  * import {defineConfig} from 'sanity'
- * import {gtPlugin} from '@generaltranslation/sanity'
+ * import {gtPlugin} from 'gt-sanity'
  *
  * export default defineConfig({
  *   // ...
@@ -119,26 +122,31 @@ 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;
+};
 
 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,
@@ -152,16 +160,8 @@ export declare type ImportTranslation = (
     additionalBlockDeserializers?: DeserializerRule[];
   },
   languageField?: string,
-  mergeWithTargetLocale?: boolean
-) => Promise<void>;
-
-export declare const legacyDocumentLevelConfig: ConfigOptions;
-
-export declare const legacyDocumentLevelPatch: (
-  docInfo: GTFile,
-  translatedFields: SanityDocument,
-  localeId: string,
-  client: SanityClient
+  mergeWithTargetLocale?: boolean,
+  publish?: boolean
 ) => Promise<void>;
 
 export declare type Secrets = {
@@ -176,6 +176,11 @@ export declare type Secrets = {
 
 export { SerializedDocument };
 
+declare type TranslateDocumentFilter = {
+  documentId?: string;
+  type?: string;
+};
+
 export declare interface TranslationFunctionContext {
   client: SanityClient;
   schema: Schema;