gt-sanity 2.0.21 → 2.1.0

package/dist/index.d.cts

@@ -1,12 +1,16 @@
+import type { ArrayOfObjectsInputProps } from "sanity";
+import type { ComponentType } from "react";
 import type { DeserializerRule } from "@portabletext/block-tools";
 import { DocumentActionComponent } from "sanity";
 import { documentInternationalization } from "@sanity/document-internationalization";
 import { PluginConfig as DocumentInternationalizationConfig } from "@sanity/document-internationalization";
 import { DocumentInternationalizationMenu } from "@sanity/document-internationalization";
+import type { FieldProps } from "sanity";
 import { GT } from "generaltranslation";
 import { Language } from "@sanity/document-internationalization";
 import { Metadata } from "@sanity/document-internationalization";
 import { ObjectField } from "sanity";
+import type { ObjectItemProps } from "sanity";
 import { Plugin as Plugin_2 } from "sanity";
 import { PortableTextHtmlComponents } from "@portabletext/to-html";
 import { PortableTextTypeComponent } from "@portabletext/to-html";
@@ -14,6 +18,7 @@ import { default as React_2 } from "react";
 import { SanityClient } from "sanity";
 import { SanityDocument } from "sanity";
 import { Schema } from "sanity";
+import { SchemaTypeDefinition } from "sanity";
 import { TranslationReference } from "@sanity/document-internationalization";
 import { TypedObject } from "sanity";
 import { useDeleteTranslationAction } from "@sanity/document-internationalization";
@@ -84,6 +89,32 @@ export declare const BaseDocumentSerializer: (schemas: Schema) => {
   ) => string;
 };
 
+/**
+ * Generate `internationalizedArray*` schema types from gtPlugin locale config.
+ *
+ * Each generated type is an array of `{ _key, _type, language, value }` objects
+ * matching `sanity-plugin-internationalized-array`, giving zero-migration
+ * interop with existing internationalized-array data.
+ *
+ * When `typePrefix` is customized and `includeCompatibilityTypes` is true, the
+ * standard `internationalizedArray*` names are also generated so existing
+ * content keeps resolving.
+ */
+export declare function createInternationalizedArrayTypes(
+  options: CreateInternationalizedArrayTypesOptions,
+): SchemaTypeDefinition[];
+
+declare type CreateInternationalizedArrayTypesOptions = {
+  sourceLocale: string;
+  locales: string[];
+  fieldTypes: FieldLevelFieldType[];
+  languageTitles?: Record<string, string>;
+  getLanguageTitle?: (locale: string) => string;
+  typePrefix?: string;
+  includeCompatibilityTypes?: boolean;
+  components?: FieldLevelUIComponents;
+};
+
 declare type CustomDeserializer = (
   element: HTMLElement,
 ) => Record<string, unknown> | unknown[];
@@ -129,6 +160,54 @@ export declare type ExportForTranslation = (
   context: TranslationFunctionContext,
 ) => Promise<GTSerializedDocument>;
 
+/**
+ * A localizable field type. Built-in shortcuts (`string`, `text`, `block`) map
+ * to generated `value` field definitions; an object form supplies a custom
+ * `value` field definition verbatim.
+ */
+export declare type FieldLevelFieldType =
+  | "string"
+  | "text"
+  | "block"
+  | {
+      /** Suffix used in the generated type name, e.g. `seo` → `internationalizedArraySeo`. */
+      name: string;
+      /** Sanity type of the generated `value` field (e.g. an object type name). */
+      type: string;
+      title?: string;
+      of?: unknown[];
+      fields?: unknown[];
+      options?: Record<string, unknown>;
+    };
+
+export declare type FieldLevelTranslationMode =
+  | "document"
+  | "internationalizedArray"
+  | "mixed";
+
+/**
+ * Studio component overrides for generated `internationalizedArray*` types.
+ *
+ * Each slot defaults to GT's inline UI (per-locale labeled inputs with
+ * remove buttons and add-locale buttons). Pass a component to replace a
+ * slot, or `false` to detach GT's component and fall back to Sanity's
+ * default rendering. Translation is unaffected either way — it operates on
+ * the stored `{_key, language, value}` data, not on the components.
+ */
+export declare type FieldLevelUIComponents = {
+  /** Input for the generated array types. Default: GT's inline input. */
+  input?: ComponentType<ArrayOfObjectsInputProps> | false;
+  /** Item for the generated `*Value` objects. Default: GT's inline item. */
+  item?: ComponentType<ObjectItemProps> | false;
+  /**
+   * Field wrapper for the generated array types. Defaults to a wrapper that
+   * resets the field level (removes nested-object indentation) — but only
+   * while GT's default input is in use; with a custom or disabled `input`,
+   * this defaults to Sanity's standard field rendering.
+   */
+  field?: ComponentType<FieldProps> | false;
+};
+
 declare type FieldMatcher = {
   documentId?: string | null;
   fields?: {
@@ -144,6 +223,35 @@ export declare const findLatestDraft: (
 
 declare const gt: GT;
 
+/**
+ * Field-level localization options, mirroring the useful parts of
+ * `sanity-plugin-internationalized-array` while keeping `sourceLocale` /
+ * `locales` from `gtPlugin()` as the only source of locale identity.
+ */
+export declare type GTFieldLevelLocalizationConfig = {
+  /** Generate `internationalizedArray*` schema types + input components. Default `false`. */
+  enabled?: boolean;
+  /** Which field types to generate. Default `['string', 'text']`. */
+  fieldTypes?: FieldLevelFieldType[];
+  /** Per-locale display labels shown in the Studio input. */
+  languageTitles?: Record<string, string>;
+  /** Compute a display label for a locale (overrides `languageTitles`). */
+  getLanguageTitle?: (locale: string) => string;
+  /** Prefix for generated type names. Default `'internationalizedArray'`. */
+  typePrefix?: string;
+  /**
+   * When `typePrefix` is customized, also generate `internationalizedArray*`
+   * aliases for interop with existing data. Default `true`.
+   */
+  includeCompatibilityTypes?: boolean;
+  /**
+   * Override or detach the Studio components attached to generated types.
+   * Use this to keep your own UI (or Sanity's default) while GT generates
+   * the schema types and handles translation.
+   */
+  components?: FieldLevelUIComponents;
+};
+
 declare type GTFile = {
   documentId: string;
   versionId?: string;
@@ -183,6 +291,10 @@ export declare type GTPluginConfig = Omit<
   additionalDeserializers?: CustomDeserializers;
   additionalBlockDeserializers?: unknown[];
   showDocumentInternationalization?: boolean;
+  internationalizedArray?: GTFieldLevelLocalizationConfig;
+  fieldLevelLocalization?: GTFieldLevelLocalizationConfig;
+  translationLevel?: FieldLevelTranslationMode;
+  fieldLevelDocuments?: TranslateDocumentFilter[] | string[];
 };
 
 declare type GTSerializedDocument = Omit<SerializedDocument, "name"> & GTFile;
@@ -255,7 +367,7 @@ export declare interface TranslationFunctionContext {
   schema: Schema;
 }
 
-declare type TranslationLevel = "document" | "field";
+declare type TranslationLevel = "document" | "field" | "internationalizedArray";
 
 declare type TranslationLocale = {
   localeId: string;

package/dist/index.d.ts

@@ -1,12 +1,16 @@
+import type { ArrayOfObjectsInputProps } from "sanity";
+import type { ComponentType } from "react";
 import type { DeserializerRule } from "@portabletext/block-tools";
 import { DocumentActionComponent } from "sanity";
 import { documentInternationalization } from "@sanity/document-internationalization";
 import { PluginConfig as DocumentInternationalizationConfig } from "@sanity/document-internationalization";
 import { DocumentInternationalizationMenu } from "@sanity/document-internationalization";
+import type { FieldProps } from "sanity";
 import { GT } from "generaltranslation";
 import { Language } from "@sanity/document-internationalization";
 import { Metadata } from "@sanity/document-internationalization";
 import { ObjectField } from "sanity";
+import type { ObjectItemProps } from "sanity";
 import { Plugin as Plugin_2 } from "sanity";
 import { PortableTextHtmlComponents } from "@portabletext/to-html";
 import { PortableTextTypeComponent } from "@portabletext/to-html";
@@ -14,6 +18,7 @@ import { default as React_2 } from "react";
 import { SanityClient } from "sanity";
 import { SanityDocument } from "sanity";
 import { Schema } from "sanity";
+import { SchemaTypeDefinition } from "sanity";
 import { TranslationReference } from "@sanity/document-internationalization";
 import { TypedObject } from "sanity";
 import { useDeleteTranslationAction } from "@sanity/document-internationalization";
@@ -84,6 +89,32 @@ export declare const BaseDocumentSerializer: (schemas: Schema) => {
   ) => string;
 };
 
+/**
+ * Generate `internationalizedArray*` schema types from gtPlugin locale config.
+ *
+ * Each generated type is an array of `{ _key, _type, language, value }` objects
+ * matching `sanity-plugin-internationalized-array`, giving zero-migration
+ * interop with existing internationalized-array data.
+ *
+ * When `typePrefix` is customized and `includeCompatibilityTypes` is true, the
+ * standard `internationalizedArray*` names are also generated so existing
+ * content keeps resolving.
+ */
+export declare function createInternationalizedArrayTypes(
+  options: CreateInternationalizedArrayTypesOptions,
+): SchemaTypeDefinition[];
+
+declare type CreateInternationalizedArrayTypesOptions = {
+  sourceLocale: string;
+  locales: string[];
+  fieldTypes: FieldLevelFieldType[];
+  languageTitles?: Record<string, string>;
+  getLanguageTitle?: (locale: string) => string;
+  typePrefix?: string;
+  includeCompatibilityTypes?: boolean;
+  components?: FieldLevelUIComponents;
+};
+
 declare type CustomDeserializer = (
   element: HTMLElement,
 ) => Record<string, unknown> | unknown[];
@@ -129,6 +160,54 @@ export declare type ExportForTranslation = (
   context: TranslationFunctionContext,
 ) => Promise<GTSerializedDocument>;
 
+/**
+ * A localizable field type. Built-in shortcuts (`string`, `text`, `block`) map
+ * to generated `value` field definitions; an object form supplies a custom
+ * `value` field definition verbatim.
+ */
+export declare type FieldLevelFieldType =
+  | "string"
+  | "text"
+  | "block"
+  | {
+      /** Suffix used in the generated type name, e.g. `seo` → `internationalizedArraySeo`. */
+      name: string;
+      /** Sanity type of the generated `value` field (e.g. an object type name). */
+      type: string;
+      title?: string;
+      of?: unknown[];
+      fields?: unknown[];
+      options?: Record<string, unknown>;
+    };
+
+export declare type FieldLevelTranslationMode =
+  | "document"
+  | "internationalizedArray"
+  | "mixed";
+
+/**
+ * Studio component overrides for generated `internationalizedArray*` types.
+ *
+ * Each slot defaults to GT's inline UI (per-locale labeled inputs with
+ * remove buttons and add-locale buttons). Pass a component to replace a
+ * slot, or `false` to detach GT's component and fall back to Sanity's
+ * default rendering. Translation is unaffected either way — it operates on
+ * the stored `{_key, language, value}` data, not on the components.
+ */
+export declare type FieldLevelUIComponents = {
+  /** Input for the generated array types. Default: GT's inline input. */
+  input?: ComponentType<ArrayOfObjectsInputProps> | false;
+  /** Item for the generated `*Value` objects. Default: GT's inline item. */
+  item?: ComponentType<ObjectItemProps> | false;
+  /**
+   * Field wrapper for the generated array types. Defaults to a wrapper that
+   * resets the field level (removes nested-object indentation) — but only
+   * while GT's default input is in use; with a custom or disabled `input`,
+   * this defaults to Sanity's standard field rendering.
+   */
+  field?: ComponentType<FieldProps> | false;
+};
+
 declare type FieldMatcher = {
   documentId?: string | null;
   fields?: {
@@ -144,6 +223,35 @@ export declare const findLatestDraft: (
 
 declare const gt: GT;
 
+/**
+ * Field-level localization options, mirroring the useful parts of
+ * `sanity-plugin-internationalized-array` while keeping `sourceLocale` /
+ * `locales` from `gtPlugin()` as the only source of locale identity.
+ */
+export declare type GTFieldLevelLocalizationConfig = {
+  /** Generate `internationalizedArray*` schema types + input components. Default `false`. */
+  enabled?: boolean;
+  /** Which field types to generate. Default `['string', 'text']`. */
+  fieldTypes?: FieldLevelFieldType[];
+  /** Per-locale display labels shown in the Studio input. */
+  languageTitles?: Record<string, string>;
+  /** Compute a display label for a locale (overrides `languageTitles`). */
+  getLanguageTitle?: (locale: string) => string;
+  /** Prefix for generated type names. Default `'internationalizedArray'`. */
+  typePrefix?: string;
+  /**
+   * When `typePrefix` is customized, also generate `internationalizedArray*`
+   * aliases for interop with existing data. Default `true`.
+   */
+  includeCompatibilityTypes?: boolean;
+  /**
+   * Override or detach the Studio components attached to generated types.
+   * Use this to keep your own UI (or Sanity's default) while GT generates
+   * the schema types and handles translation.
+   */
+  components?: FieldLevelUIComponents;
+};
+
 declare type GTFile = {
   documentId: string;
   versionId?: string;
@@ -183,6 +291,10 @@ export declare type GTPluginConfig = Omit<
   additionalDeserializers?: CustomDeserializers;
   additionalBlockDeserializers?: unknown[];
   showDocumentInternationalization?: boolean;
+  internationalizedArray?: GTFieldLevelLocalizationConfig;
+  fieldLevelLocalization?: GTFieldLevelLocalizationConfig;
+  translationLevel?: FieldLevelTranslationMode;
+  fieldLevelDocuments?: TranslateDocumentFilter[] | string[];
 };
 
 declare type GTSerializedDocument = Omit<SerializedDocument, "name"> & GTFile;
@@ -255,7 +367,7 @@ export declare interface TranslationFunctionContext {
   schema: Schema;
 }
 
-declare type TranslationLevel = "document" | "field";
+declare type TranslationLevel = "document" | "field" | "internationalizedArray";
 
 declare type TranslationLocale = {
   localeId: string;