sanity-plugin-internationalized-array/dist/index.d.ts

Store localized fields in an array to save on attributes

import { LanguageFilterConfig } from "@sanity/language-filter";
import { FieldDefinition, FieldMember, FieldsetState, ObjectSchemaType, Rule, RuleTypeConstraint, SanityClient } from "sanity";
type Language = {
  id: Intl.UnicodeBCP47LocaleIdentifier;
  title: string;
};
type AllowedType = 'string' | 'number' | 'boolean' | 'text' | 'reference';
type ArrayConfig = {
  name: string;
  type: AllowedType;
  languages: Language[];
  title?: string;
  group?: string;
  hidden?: boolean | (() => boolean);
  readOnly?: boolean | (() => boolean);
  validation?: Rule | Rule[];
  field?: {
    [key: string]: unknown;
    options: {
      [key: string]: unknown;
    };
  };
};
/**
 * @deprecated Use InternationalizedArrayItem instead
 */
type Value = {
  _key: string;
  /** Language identifier (e.g., 'en', 'fr'). Added in v5. */
  language: string;
  value?: unknown;
};
declare function isInternationalizedArrayItemType(type: string): type is InternationalizedArrayItem['_type'];
type InternationalizedArrayItem<T = unknown> = {
  _key: string;
  value?: T;
  /** Language identifier (e.g., 'en', 'fr'). Added in v5. */
  language: string;
  /**
   * string that starts with "internationalizedArray" and ends with "Value"
   */
  _type: `internationalizedArray${string}Value`;
};
type LanguageCallback = (client: SanityClient, selectedValue: Record<string, unknown>) => Promise<Language[]>;
type LanguageDisplay = 'titleOnly' | 'codeOnly' | 'titleAndCode';
type PluginConfig = {
  /**
   * https://www.sanity.io/docs/api-versioning
   * @defaultValue '2025-10-15'
   */
  apiVersion?: string;
  /**
   * Specify fields that should be available in the language callback:
   * ```tsx
   * {
   *   select: {
   *     markets: 'markets'
   *   },
   *   languages: (client, {markets}) =>
   *     query.fetch(groq`*[_type == "language" && market in $markets]{id,title}`, {markets})
   * }
   * ```
   */
  select?: Record<string, string>;
  /**
   * You can give it an array of language definitions:
   * ```tsx
   * {
   *   languages: [
   *     {id: 'en', title: 'English'},
   *     {id: 'fr', title: 'French'}
   *   ]
   * }
   * ```
   * You can load them async by passing a function that returns a promise:
   * ```tsx
   * {
   *   languages: async () => {
   *     const response = await fetch('https://example.com/languages')
   *     return response.json()
   *   }
   * }
   * ```
   * You can query your dataset for languages::
   * ```tsx
   * {
   *   languages: (client) =>
   *     query.fetch(groq`*[_type == "language"]{id,title}`)
   * }
   * ```
   */
  languages: Language[] | LanguageCallback;
  /**
   * You can specify a list of language IDs that should be pre-filled when creating a new document
   * ```tsx
   * {
   *  defaultLanguages: ['en']
   * }
   * ```
   */
  defaultLanguages?: string[];
  /**
   * Can be a string matching core field types, as well as custom ones:
   * ```tsx
   * {
   *   fieldTypes: [
   *     "date", "datetime", "file", "image", "number", "string", "text", "url"
   *   ]
   * }
   * ```
   * You can also define a type directly:
   * ```tsx
   * {
   *   fieldTypes: [
   *     defineField({
   *       name: 'featuredProduct',
   *       type: 'reference',
   *       to: [{type: 'product'}]
   *       hidden: (({document}) => !document?.title)
   *     })
   *   ]
   * }
   * ```
   */
  fieldTypes: (string | RuleTypeConstraint | FieldDefinition)[];
  /**
   * Locations where the "+ EN" add language buttons are visible
   * @defaultValue ['field']
   * */
  buttonLocations?: ('field' | 'unstable__fieldAction' | 'document')[];
  /**
   * Show or hide the "Add missing languages" button
   * @defaultValue true
   * */
  buttonAddAll?: boolean;
  /**
   * How to display the languages on buttons and fields
   * @defaultValue 'code'
   * */
  languageDisplay?: LanguageDisplay;
  /**
   * @internal
   * Function to determine if the plugin layout and root input should be included for a given document type.
   * @defaultValue (documentType) => documentType !== 'translation.metadata'
   * @example
   * {
   *   includeForDocumentType: (documentType) => documentType === 'translation.metadata'
   * }
   */
  includeForDocumentType?: (documentType: string) => boolean;
  /**
   * Configure the language filter for the plugin by providing the document types that should show the filter.
   * ```tsx
   * {
   *   languageFilter: {
   *     documentTypes: ['internationalizedPost', 'lesson'],
   *     defaultLanguages: ['en']
   *   }
   * }
   * ```
   */
  languageFilter?: {
    documentTypes: Required<LanguageFilterConfig>['documentTypes'];
    defaultLanguages?: LanguageFilterConfig['defaultLanguages'];
  };
};
declare const clear: () => void;
/**
 * The field name used to identify the language of an internationalized array item.
 *
 * In v4.x this was '_key', in v5+ this is 'language'.
 * ```ts
 * {
 *    "description": [
 *      {
 *        "_key": "kjjNvZHK8Y2QpTEf3K5jc",
 *        "_type": "internationalizedArrayTextValue",
 *        "language": "en"
 *        "value": "This is the description in English"
 *      },
 *      {
 *        "_key": "kjjNvZHK8Y2QpTEf3K5jc",
 *        "_type": "internationalizedArrayTextValue",
 *        "language": "es"
 *        "value": "This is the description in Spanish"
 *      },
 *    ]
 * }
 * ```
 */
declare const LANGUAGE_FIELD_NAME: 'language';
declare const internationalizedArray: import("sanity").Plugin<PluginConfig>;
/**
 * Default filter function for the internationalized array field.
 * It filter the field base on the `language` value of the object.
 */
declare const internationalizedArrayLanguageFilter: (enclosingType: ObjectSchemaType, _member: FieldMember | FieldsetState, selectedLanguageIds: string[], parentValue: Record<string, unknown> | undefined, languages: Language[]) => boolean;
export { AllowedType, ArrayConfig, InternationalizedArrayItem, LANGUAGE_FIELD_NAME, Language, LanguageCallback, LanguageDisplay, PluginConfig, Value, clear, internationalizedArray, internationalizedArrayLanguageFilter, isInternationalizedArrayItemType };
//# sourceMappingURL=index.d.ts.map