@contentful/app-sdk 4.16.0 → 4.17.1

package/dist/types/cmaClient.types.d.ts

@@ -1,31 +1,35 @@
-import { PlainClientAPI } from 'contentful-management';
-export type CMAClient = {
-    appAction: Pick<PlainClientAPI['appAction'], 'get' | 'getMany' | 'getManyForEnvironment'>;
-    appDefinition: Pick<PlainClientAPI['appDefinition'], 'get' | 'getInstallationsForOrg'>;
-    appInstallation: Pick<PlainClientAPI['appInstallation'], 'getForOrganization'>;
-    asset: PlainClientAPI['asset'];
-    assetKey: PlainClientAPI['assetKey'];
-    appSignedRequest: Pick<PlainClientAPI['appSignedRequest'], 'create'>;
-    bulkAction: PlainClientAPI['bulkAction'];
-    comment: PlainClientAPI['comment'];
-    contentType: PlainClientAPI['contentType'];
-    editorInterface: PlainClientAPI['editorInterface'];
-    environment: Pick<PlainClientAPI['environment'], 'get'>;
-    environmentAlias: Pick<PlainClientAPI['environmentAlias'], 'get'>;
-    entry: PlainClientAPI['entry'];
-    locale: PlainClientAPI['locale'];
-    release: PlainClientAPI['release'];
-    releaseAction: PlainClientAPI['releaseAction'];
-    role: Pick<PlainClientAPI['role'], 'get' | 'getMany'>;
-    scheduledActions: PlainClientAPI['scheduledActions'];
-    snapshot: PlainClientAPI['snapshot'];
-    space: Pick<PlainClientAPI['space'], 'get'>;
-    upload: PlainClientAPI['upload'];
-    user: Pick<PlainClientAPI['user'], 'getManyForSpace' | 'getForSpace'>;
-    usage: Pick<PlainClientAPI['usage'], 'getManyForSpace'>;
-    team: Pick<PlainClientAPI['team'], 'getManyForSpace'>;
-    task: PlainClientAPI['task'];
-    tag: PlainClientAPI['tag'];
-    uiConfig: PlainClientAPI['uiConfig'];
-    userUIConfig: PlainClientAPI['userUIConfig'];
-};
+import { PlainClientAPI } from 'contentful-management';
+export type CMAClient = {
+    appAction: Pick<PlainClientAPI['appAction'], 'get' | 'getMany' | 'getManyForEnvironment'>;
+    appActionCall: Pick<PlainClientAPI['appActionCall'], 'create'>;
+    appDefinition: Pick<PlainClientAPI['appDefinition'], 'get' | 'getInstallationsForOrg'>;
+    appInstallation: Pick<PlainClientAPI['appInstallation'], 'getForOrganization'>;
+    asset: PlainClientAPI['asset'];
+    assetKey: PlainClientAPI['assetKey'];
+    appSignedRequest: Pick<PlainClientAPI['appSignedRequest'], 'create'>;
+    bulkAction: PlainClientAPI['bulkAction'];
+    comment: PlainClientAPI['comment'];
+    contentType: PlainClientAPI['contentType'];
+    editorInterface: PlainClientAPI['editorInterface'];
+    environment: Pick<PlainClientAPI['environment'], 'get'>;
+    environmentAlias: Pick<PlainClientAPI['environmentAlias'], 'get'>;
+    entry: PlainClientAPI['entry'];
+    locale: PlainClientAPI['locale'];
+    release: PlainClientAPI['release'];
+    releaseAction: PlainClientAPI['releaseAction'];
+    role: Pick<PlainClientAPI['role'], 'get' | 'getMany'>;
+    scheduledActions: PlainClientAPI['scheduledActions'];
+    snapshot: PlainClientAPI['snapshot'];
+    space: Pick<PlainClientAPI['space'], 'get'>;
+    upload: PlainClientAPI['upload'];
+    user: Pick<PlainClientAPI['user'], 'getManyForSpace' | 'getForSpace'>;
+    usage: Pick<PlainClientAPI['usage'], 'getManyForSpace'>;
+    team: Pick<PlainClientAPI['team'], 'getManyForSpace'>;
+    task: PlainClientAPI['task'];
+    tag: PlainClientAPI['tag'];
+    uiConfig: PlainClientAPI['uiConfig'];
+    userUIConfig: PlainClientAPI['userUIConfig'];
+    workflow: PlainClientAPI['workflow'];
+    workflowDefinition: PlainClientAPI['workflowDefinition'];
+    workflowsChangelog: PlainClientAPI['workflowsChangelog'];
+};

package/dist/types/dialogs.types.d.ts

@@ -1,69 +1,69 @@
-import { SerializedJSONValue } from './utils';
-export interface OpenAlertOptions {
-    title: string;
-    message: string;
-    confirmLabel?: string;
-    shouldCloseOnEscapePress?: boolean;
-    shouldCloseOnOverlayClick?: boolean;
-}
-export type OpenConfirmOptions = OpenAlertOptions & {
-    cancelLabel?: string;
-    intent?: 'primary' | 'positive' | 'negative';
-};
-export interface OpenCustomWidgetOptions {
-    id?: string;
-    width?: number | 'small' | 'medium' | 'large' | 'fullWidth';
-    minHeight?: number | string;
-    allowHeightOverflow?: boolean;
-    position?: 'center' | 'top';
-    title?: string;
-    shouldCloseOnOverlayClick?: boolean;
-    shouldCloseOnEscapePress?: boolean;
-    parameters?: SerializedJSONValue;
-}
-export interface EntityDialogOptions {
-    locale?: string;
-    contentTypes?: string[];
-    min?: number;
-    max?: number;
-}
-export interface DialogsAPI {
-    /** Opens a simple alert window (which can only be closed). */
-    openAlert: (options: OpenAlertOptions) => Promise<boolean>;
-    /** Opens a confirmation window. A user can either confirm or cancel the dialog. */
-    openConfirm: (options: OpenConfirmOptions) => Promise<boolean>;
-    /** Opens a prompt window. A user can either provide a string input or cancel the dialog. */
-    openPrompt: (options: OpenConfirmOptions & {
-        defaultValue?: string;
-    }) => Promise<string | boolean>;
-    /** Opens an extension in a dialog. */
-    openExtension: (options: OpenCustomWidgetOptions) => Promise<any>;
-    /** Opens the current app in a dialog */
-    openCurrentApp: (options?: Omit<OpenCustomWidgetOptions, 'id'>) => Promise<any>;
-    /** Opens the current app or extension in a dialog */
-    openCurrent: (options?: Omit<OpenCustomWidgetOptions, 'id'> | OpenCustomWidgetOptions) => Promise<any>;
-    /** Opens a dialog for selecting a single entry. */
-    selectSingleEntry: <T = Object>(options?: {
-        locale?: string;
-        contentTypes?: string[];
-    }) => Promise<T | null>;
-    /** Opens a dialog for selecting multiple entries. */
-    selectMultipleEntries: <T = Object>(options?: {
-        locale?: string;
-        contentTypes?: string[];
-        min?: number;
-        max?: number;
-    }) => Promise<T[] | null>;
-    /** Opens a dialog for selecting a single asset. */
-    selectSingleAsset: <T = Object>(options?: {
-        locale?: string;
-        mimetypeGroups?: string[];
-    }) => Promise<T | null>;
-    /** Opens a dialog for selecting multiple assets. */
-    selectMultipleAssets: <T = Object>(options?: {
-        locale?: string;
-        min?: number;
-        max?: number;
-        mimetypeGroups?: string[];
-    }) => Promise<T[] | null>;
-}
+import { SerializedJSONValue } from './utils';
+export interface OpenAlertOptions {
+    title: string;
+    message: string;
+    confirmLabel?: string;
+    shouldCloseOnEscapePress?: boolean;
+    shouldCloseOnOverlayClick?: boolean;
+}
+export type OpenConfirmOptions = OpenAlertOptions & {
+    cancelLabel?: string;
+    intent?: 'primary' | 'positive' | 'negative';
+};
+export interface OpenCustomWidgetOptions {
+    id?: string;
+    width?: number | 'small' | 'medium' | 'large' | 'fullWidth';
+    minHeight?: number | string;
+    allowHeightOverflow?: boolean;
+    position?: 'center' | 'top';
+    title?: string;
+    shouldCloseOnOverlayClick?: boolean;
+    shouldCloseOnEscapePress?: boolean;
+    parameters?: SerializedJSONValue;
+}
+export interface EntityDialogOptions {
+    locale?: string;
+    contentTypes?: string[];
+    min?: number;
+    max?: number;
+}
+export interface DialogsAPI {
+    /** Opens a simple alert window (which can only be closed). */
+    openAlert: (options: OpenAlertOptions) => Promise<boolean>;
+    /** Opens a confirmation window. A user can either confirm or cancel the dialog. */
+    openConfirm: (options: OpenConfirmOptions) => Promise<boolean>;
+    /** Opens a prompt window. A user can either provide a string input or cancel the dialog. */
+    openPrompt: (options: OpenConfirmOptions & {
+        defaultValue?: string;
+    }) => Promise<string | boolean>;
+    /** Opens an extension in a dialog. */
+    openExtension: (options: OpenCustomWidgetOptions) => Promise<any>;
+    /** Opens the current app in a dialog */
+    openCurrentApp: (options?: Omit<OpenCustomWidgetOptions, 'id'>) => Promise<any>;
+    /** Opens the current app or extension in a dialog */
+    openCurrent: (options?: Omit<OpenCustomWidgetOptions, 'id'> | OpenCustomWidgetOptions) => Promise<any>;
+    /** Opens a dialog for selecting a single entry. */
+    selectSingleEntry: <T = Object>(options?: {
+        locale?: string;
+        contentTypes?: string[];
+    }) => Promise<T | null>;
+    /** Opens a dialog for selecting multiple entries. */
+    selectMultipleEntries: <T = Object>(options?: {
+        locale?: string;
+        contentTypes?: string[];
+        min?: number;
+        max?: number;
+    }) => Promise<T[] | null>;
+    /** Opens a dialog for selecting a single asset. */
+    selectSingleAsset: <T = Object>(options?: {
+        locale?: string;
+        mimetypeGroups?: string[];
+    }) => Promise<T | null>;
+    /** Opens a dialog for selecting multiple assets. */
+    selectMultipleAssets: <T = Object>(options?: {
+        locale?: string;
+        min?: number;
+        max?: number;
+        mimetypeGroups?: string[];
+    }) => Promise<T[] | null>;
+}

package/dist/types/entities.d.ts

@@ -1,7 +1,7 @@
-export type { AssetProps as Asset, ContentFields as ContentTypeField, ContentTypeFieldValidation, ContentTypeProps as ContentType, EditorInterfaceProps as EditorInterface, EntryProps as Entry, KeyValueMap, MetadataProps as Metadata, QueryOptions, RoleProps as Role, ScheduledActionProps as ScheduledAction, SpaceMembershipProps as SpaceMembership, TagProps as Tag, TagVisibility, TaskProps as Task, TeamProps as Team, UploadProps as Upload, UserProps as User, WorkflowDefinitionProps as WorkflowDefinition, } from 'contentful-management/types';
-export interface CanonicalRequest {
-    method: 'GET' | 'PUT' | 'POST' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS';
-    path: string;
-    headers?: Record<string, string>;
-    body?: string;
-}
+export type { AssetProps as Asset, ContentFields as ContentTypeField, ContentTypeFieldValidation, ContentTypeProps as ContentType, EditorInterfaceProps as EditorInterface, EntryProps as Entry, KeyValueMap, MetadataProps as Metadata, QueryOptions, RoleProps as Role, ScheduledActionProps as ScheduledAction, SpaceMembershipProps as SpaceMembership, TagProps as Tag, TagVisibility, TaskProps as Task, TeamProps as Team, UploadProps as Upload, UserProps as User, WorkflowDefinitionProps as WorkflowDefinition, } from 'contentful-management/types';
+export interface CanonicalRequest {
+    method: 'GET' | 'PUT' | 'POST' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS';
+    path: string;
+    headers?: Record<string, string>;
+    body?: string;
+}

package/dist/types/entry.types.d.ts

@@ -1,45 +1,45 @@
-import { Metadata, Task } from './entities';
-import { EntryFieldAPI } from './field.types';
-import { CollectionResponse, EntrySys, SearchQuery } from './utils';
-type TaskState = 'active' | 'resolved';
-export interface TaskInputData {
-    assignedToId: string;
-    assignedToType?: 'User' | 'Team';
-    body: string;
-    status: TaskState;
-    dueDate?: string;
-}
-/** Allows accessing the Task API for the current entry. */
-export interface TaskAPI {
-    getTask(id: string): Promise<Task>;
-    getTasks(query?: SearchQuery): Promise<CollectionResponse<Task>>;
-    createTask(data: TaskInputData): Promise<Task>;
-    updateTask(task: Task): Promise<Task>;
-    deleteTask(task: Task): Promise<void>;
-}
-export interface EntryAPI extends TaskAPI {
-    /** Returns sys for an entry. */
-    getSys: () => EntrySys;
-    /** Publish the entry */
-    publish: (options?: {
-        skipUiValidation?: boolean;
-    }) => Promise<void>;
-    /** Unpublish the entry */
-    unpublish: () => Promise<void>;
-    /** Saves the current changes of the entry */
-    save: () => Promise<void>;
-    /** Calls the callback with sys every time that sys changes. */
-    onSysChanged: (callback: (sys: EntrySys) => void) => () => void;
-    /** Allows to control the values of all other fields in the current entry. */
-    fields: {
-        [key: string]: EntryFieldAPI;
-    };
-    /**
-     * Optional metadata on an entry
-     * @deprecated
-     */
-    metadata?: Metadata;
-    getMetadata: () => Metadata | undefined;
-    onMetadataChanged: (callback: (metadata?: Metadata) => void) => VoidFunction;
-}
-export {};
+import { Metadata, Task } from './entities';
+import { EntryFieldAPI } from './field.types';
+import { CollectionResponse, EntrySys, SearchQuery } from './utils';
+type TaskState = 'active' | 'resolved';
+export interface TaskInputData {
+    assignedToId: string;
+    assignedToType?: 'User' | 'Team';
+    body: string;
+    status: TaskState;
+    dueDate?: string;
+}
+/** Allows accessing the Task API for the current entry. */
+export interface TaskAPI {
+    getTask(id: string): Promise<Task>;
+    getTasks(query?: SearchQuery): Promise<CollectionResponse<Task>>;
+    createTask(data: TaskInputData): Promise<Task>;
+    updateTask(task: Task): Promise<Task>;
+    deleteTask(task: Task): Promise<void>;
+}
+export interface EntryAPI extends TaskAPI {
+    /** Returns sys for an entry. */
+    getSys: () => EntrySys;
+    /** Publish the entry */
+    publish: (options?: {
+        skipUiValidation?: boolean;
+    }) => Promise<void>;
+    /** Unpublish the entry */
+    unpublish: () => Promise<void>;
+    /** Saves the current changes of the entry */
+    save: () => Promise<void>;
+    /** Calls the callback with sys every time that sys changes. */
+    onSysChanged: (callback: (sys: EntrySys) => void) => () => void;
+    /** Allows to control the values of all other fields in the current entry. */
+    fields: {
+        [key: string]: EntryFieldAPI;
+    };
+    /**
+     * Optional metadata on an entry
+     * @deprecated
+     */
+    metadata?: Metadata;
+    getMetadata: () => Metadata | undefined;
+    onMetadataChanged: (callback: (metadata?: Metadata) => void) => VoidFunction;
+}
+export {};

package/dist/types/field-locale.types.d.ts

@@ -1,55 +1,55 @@
-import { ContentTypeFieldValidation } from './entities';
-import type { Items, SerializedJSONValue } from './utils';
-import { ValidationError } from './validation-error';
-export interface FieldAPI {
-    /** The ID of a field is defined in an entry's content type. */
-    id: string;
-    /** The current locale of a field the app is attached to. */
-    locale: string;
-    /** Holds the type of the field the app is attached to. */
-    type: string;
-    /** Indicates if a value for this field is required */
-    required: boolean;
-    /** A list of validations for this field that are defined in the content type. */
-    validations: ContentTypeFieldValidation[];
-    /** Defines the shape of array items */
-    items?: Items;
-    /** Gets the current value of the field and locale. */
-    getValue: () => any;
-    /** Sets the value for the field and locale.  */
-    setValue: <Value = any>(value: Value) => Promise<SerializedJSONValue | undefined>;
-    /** Removes the value for the field and locale. */
-    removeValue: () => Promise<void>;
-    /** Communicates to the web application if the field is in a valid state or not. */
-    setInvalid: (value: boolean) => void;
-    /** Calls the callback every time the value of the field is changed by an external event or when setValue() is called.
-     *  the returned function can be called to remove the handler function
-     **/
-    onValueChanged: (callback: (value: any) => void) => () => void;
-    /**
-     * Returns whether the current field is disabled
-     *
-     * The disabled state can change. To always work with the latest state, use `onIsDisabledChanged`.
-     */
-    getIsDisabled(): boolean;
-    /**
-     * Subscribes to changes to this field's disabled state
-     *
-     * @param callback Function that is called every time this field's disabled state changes. Called immidiately with the current state.
-     * @returns Function to unsubscribe. `callback` won't be called anymore.
-     */
-    onIsDisabledChanged: (callback: (isDisabled: boolean) => void) => () => void;
-    /**
-     * Returns the field's validation errors
-     *
-     * The schema errors can change. To always work with the latest errors, use `onSchemaErrorsChanged`.
-     */
-    getSchemaErrors(): ValidationError[];
-    /**
-     * Subscribes to schema errors
-     *
-     * @param callback Function that is called every time the schema errors change. Called immediately with the current errors.
-     * @returns Function to unsubscribe. `callback` won't be called anymore.
-     */
-    onSchemaErrorsChanged: (callback: (errors: ValidationError[]) => void) => () => void;
-}
+import { ContentTypeFieldValidation } from './entities';
+import type { Items, SerializedJSONValue } from './utils';
+import { ValidationError } from './validation-error';
+export interface FieldAPI {
+    /** The ID of a field is defined in an entry's content type. */
+    id: string;
+    /** The current locale of a field the app is attached to. */
+    locale: string;
+    /** Holds the type of the field the app is attached to. */
+    type: string;
+    /** Indicates if a value for this field is required */
+    required: boolean;
+    /** A list of validations for this field that are defined in the content type. */
+    validations: ContentTypeFieldValidation[];
+    /** Defines the shape of array items */
+    items?: Items;
+    /** Gets the current value of the field and locale. */
+    getValue: () => any;
+    /** Sets the value for the field and locale.  */
+    setValue: <Value = any>(value: Value) => Promise<SerializedJSONValue | undefined>;
+    /** Removes the value for the field and locale. */
+    removeValue: () => Promise<void>;
+    /** Communicates to the web application if the field is in a valid state or not. */
+    setInvalid: (value: boolean) => void;
+    /** Calls the callback every time the value of the field is changed by an external event or when setValue() is called.
+     *  the returned function can be called to remove the handler function
+     **/
+    onValueChanged: (callback: (value: any) => void) => () => void;
+    /**
+     * Returns whether the current field is disabled
+     *
+     * The disabled state can change. To always work with the latest state, use `onIsDisabledChanged`.
+     */
+    getIsDisabled(): boolean;
+    /**
+     * Subscribes to changes to this field's disabled state
+     *
+     * @param callback Function that is called every time this field's disabled state changes. Called immidiately with the current state.
+     * @returns Function to unsubscribe. `callback` won't be called anymore.
+     */
+    onIsDisabledChanged: (callback: (isDisabled: boolean) => void) => () => void;
+    /**
+     * Returns the field's validation errors
+     *
+     * The schema errors can change. To always work with the latest errors, use `onSchemaErrorsChanged`.
+     */
+    getSchemaErrors(): ValidationError[];
+    /**
+     * Subscribes to schema errors
+     *
+     * @param callback Function that is called every time the schema errors change. Called immediately with the current errors.
+     * @returns Function to unsubscribe. `callback` won't be called anymore.
+     */
+    onSchemaErrorsChanged: (callback: (errors: ValidationError[]) => void) => () => void;
+}

package/dist/types/field.types.d.ts

@@ -1,70 +1,70 @@
-import { Items, SerializedJSONValue } from './utils';
-import { FieldAPI } from './field-locale.types';
-import { ContentTypeFieldValidation } from './entities';
-import { ValidationError } from './validation-error';
-export interface FieldInfo {
-    id: string;
-    locale: string;
-    type: string;
-    required: boolean;
-    validations: ContentTypeFieldValidation[];
-    items?: Items;
-    value: any;
-    isDisabled: boolean;
-    schemaErrors: ValidationError[];
-}
-export interface EntryFieldInfo {
-    id: string;
-    locales: string[];
-    type: string;
-    required: boolean;
-    validations: ContentTypeFieldValidation[];
-    items?: Items;
-    values: {
-        [locale: string]: any;
-    };
-    isDisabled: {
-        [locale: string]: boolean;
-    };
-    schemaErrors: {
-        [locale: string]: ValidationError[];
-    };
-}
-export interface EntryFieldAPI {
-    /** The ID of a field is defined in an entry's content type. */
-    id: string;
-    /** The list of locales for the field. */
-    locales: string[];
-    /** Holds the type of the field. */
-    type: string;
-    /** Indicates if a value for this field is required */
-    required: boolean;
-    /** A list of validations for this field that are defined in the content type. */
-    validations: ContentTypeFieldValidation[];
-    /** Defines the shape of array items */
-    items?: Items;
-    /** Gets the current value of the field and locale. */
-    getValue: (locale?: string) => any;
-    /** Sets the value for the field and locale.  */
-    setValue: <Value = any>(value: Value, locale?: string) => Promise<SerializedJSONValue | undefined>;
-    /** Removes the value for the field and locale. */
-    removeValue: (locale?: string) => Promise<void>;
-    /** Calls the callback every time the value of the field is changed by an external event or when setValue() is called.
-     *  the returned function can be called to remove the handler function
-     **/
-    onValueChanged: {
-        (callback: (value: any) => void): () => void;
-        (locale: string, callback: (value: any) => void): () => void;
-    };
-    /** Calls the callback when the disabled status of the field changes.
-     *  the returned function can be called to remove the handler function
-     **/
-    onIsDisabledChanged: {
-        (callback: (isDisabled: boolean) => void): () => void;
-        (locale: string, callback: (isDisabled: boolean) => void): () => void;
-    };
-    /** Get an instance of FieldAPI for this field, specific to the locale that is
-     * passed as an argument
-     **/
-    getForLocale: (locale: string) => FieldAPI;
-}
+import { Items, SerializedJSONValue } from './utils';
+import { FieldAPI } from './field-locale.types';
+import { ContentTypeFieldValidation } from './entities';
+import { ValidationError } from './validation-error';
+export interface FieldInfo {
+    id: string;
+    locale: string;
+    type: string;
+    required: boolean;
+    validations: ContentTypeFieldValidation[];
+    items?: Items;
+    value: any;
+    isDisabled: boolean;
+    schemaErrors: ValidationError[];
+}
+export interface EntryFieldInfo {
+    id: string;
+    locales: string[];
+    type: string;
+    required: boolean;
+    validations: ContentTypeFieldValidation[];
+    items?: Items;
+    values: {
+        [locale: string]: any;
+    };
+    isDisabled: {
+        [locale: string]: boolean;
+    };
+    schemaErrors: {
+        [locale: string]: ValidationError[];
+    };
+}
+export interface EntryFieldAPI {
+    /** The ID of a field is defined in an entry's content type. */
+    id: string;
+    /** The list of locales for the field. */
+    locales: string[];
+    /** Holds the type of the field. */
+    type: string;
+    /** Indicates if a value for this field is required */
+    required: boolean;
+    /** A list of validations for this field that are defined in the content type. */
+    validations: ContentTypeFieldValidation[];
+    /** Defines the shape of array items */
+    items?: Items;
+    /** Gets the current value of the field and locale. */
+    getValue: (locale?: string) => any;
+    /** Sets the value for the field and locale.  */
+    setValue: <Value = any>(value: Value, locale?: string) => Promise<SerializedJSONValue | undefined>;
+    /** Removes the value for the field and locale. */
+    removeValue: (locale?: string) => Promise<void>;
+    /** Calls the callback every time the value of the field is changed by an external event or when setValue() is called.
+     *  the returned function can be called to remove the handler function
+     **/
+    onValueChanged: {
+        (callback: (value: any) => void): () => void;
+        (locale: string, callback: (value: any) => void): () => void;
+    };
+    /** Calls the callback when the disabled status of the field changes.
+     *  the returned function can be called to remove the handler function
+     **/
+    onIsDisabledChanged: {
+        (callback: (isDisabled: boolean) => void): () => void;
+        (locale: string, callback: (isDisabled: boolean) => void): () => void;
+    };
+    /** Get an instance of FieldAPI for this field, specific to the locale that is
+     * passed as an argument
+     **/
+    getForLocale: (locale: string) => FieldAPI;
+}

package/dist/types/index.d.ts

@@ -1,13 +1,13 @@
-export type { AccessAPI, AppExtensionSDK, ArchiveableAction, BaseExtensionSDK, ConnectMessage, ContentTypeAPI, CrudAction, DialogExtensionSDK, EditorExtensionSDK, EditorLocaleSettings, FieldExtensionSDK, HomeExtensionSDK, IdsAPI, KnownSDK, LocalesAPI, LocationAPI, Locations, NotifierAPI, PageExtensionSDK, ParametersAPI, PublishableAction, SharedEditorSDK, SidebarExtensionSDK, UserAPI, JSONPatchItem, } from './api.types';
-export type { AppConfigAPI, AppState, OnConfigureHandler, OnConfigureHandlerReturn, } from './app.types';
-export type { DialogsAPI, EntityDialogOptions, OpenAlertOptions, OpenConfirmOptions, OpenCustomWidgetOptions, } from './dialogs.types';
-export type { Asset, CanonicalRequest, ContentType, ContentTypeField, EditorInterface, Entry, Metadata, Role, ScheduledAction, SpaceMembership, Tag, TagVisibility, Task, Team, User, WorkflowDefinition, } from './entities';
-export type { EntryAPI, TaskAPI, TaskInputData } from './entry.types';
-export type { FieldInfo, EntryFieldInfo, EntryFieldAPI } from './field.types';
-export type { FieldAPI } from './field-locale.types';
-export type { NavigatorAPI, AppPageLocationOptions, NavigatorAPIOptions, NavigatorOpenResponse, NavigatorPageResponse, NavigatorSlideInfo, PageExtensionOptions, } from './navigator.types';
-export type { SpaceAPI } from './space.types';
-export type { SearchQuery, CollectionResponse, EntrySys, ContentEntitySys, ContentEntityType, Items, Link, WithOptionalId, WithId, SerializedJSONValue, } from './utils';
-export type { DateRangeValidationError, InValidationError, LinkContentTypeValidationError, LinkMimetypeGroupValidationError, NotResolvableValidationError, ProhibitRegexpValidationError, RangeValidationError, RegexpValidationError, RequiredValidationError, SizeValidationError, TypeValidationError, UniqueValidationError, UnknownValidationError, ValidationError, } from './validation-error';
-export type { WindowAPI } from './window.types';
-export type { CMAClient } from './cmaClient.types';
+export type { AppExtensionSDK, BaseExtensionSDK, DialogExtensionSDK, EditorExtensionSDK, FieldExtensionSDK, HomeExtensionSDK, KnownSDK, PageExtensionSDK, SidebarExtensionSDK, ConfigAppSDK, BaseAppSDK, DialogAppSDK, EditorAppSDK, FieldAppSDK, HomeAppSDK, KnownAppSDK, PageAppSDK, SidebarAppSDK, AccessAPI, ArchiveableAction, ConnectMessage, ContentTypeAPI, CrudAction, EditorLocaleSettings, IdsAPI, LocalesAPI, LocationAPI, Locations, NotifierAPI, ParametersAPI, PublishableAction, SharedEditorSDK, UserAPI, JSONPatchItem, } from './api.types';
+export type { AppConfigAPI, AppState, OnConfigureHandler, OnConfigureHandlerReturn, } from './app.types';
+export type { DialogsAPI, EntityDialogOptions, OpenAlertOptions, OpenConfirmOptions, OpenCustomWidgetOptions, } from './dialogs.types';
+export type { Asset, CanonicalRequest, ContentType, ContentTypeField, EditorInterface, Entry, Metadata, Role, ScheduledAction, SpaceMembership, Tag, TagVisibility, Task, Team, User, WorkflowDefinition, } from './entities';
+export type { EntryAPI, TaskAPI, TaskInputData } from './entry.types';
+export type { FieldInfo, EntryFieldInfo, EntryFieldAPI } from './field.types';
+export type { FieldAPI } from './field-locale.types';
+export type { NavigatorAPI, AppPageLocationOptions, NavigatorAPIOptions, NavigatorOpenResponse, NavigatorPageResponse, NavigatorSlideInfo, PageExtensionOptions, } from './navigator.types';
+export type { SpaceAPI } from './space.types';
+export type { SearchQuery, CollectionResponse, EntrySys, ContentEntitySys, ContentEntityType, Items, Link, WithOptionalId, WithId, SerializedJSONValue, } from './utils';
+export type { DateRangeValidationError, InValidationError, LinkContentTypeValidationError, LinkMimetypeGroupValidationError, NotResolvableValidationError, ProhibitRegexpValidationError, RangeValidationError, RegexpValidationError, RequiredValidationError, SizeValidationError, TypeValidationError, UniqueValidationError, UnknownValidationError, ValidationError, } from './validation-error';
+export type { WindowAPI } from './window.types';
+export type { CMAClient } from './cmaClient.types';