sanity
Version:
Sanity is a real-time content infrastructure with a scalable, hosted backend featuring a Graph Oriented Query Language (GROQ), asset pipelines and fast edge caches
636 lines • 56.3 kB
TypeScript
import { D as StructureResolver, i as PaneRouterContextValue, j as StructureToolOptions, k as StructureToolContextValue, p as DocumentPaneNode, s as DocumentPaneContextValue, vt as DefaultDocumentNodeResolver, y as PaneNode } from "./types.js";
import * as react from "react";
import { ComponentProps, ComponentType, ElementType, HTMLProps, ReactNode } from "react";
import { Path, PreviewValue, SanityDocument, SanityDocumentLike, SchemaType, SortOrdering } from "@sanity/types";
import { BoxOverflow, CardProps, SelectableTone } from "@sanity/ui";
import { PaneRouterContext } from "sanity/_singletons";
import * as sanity from "sanity";
import { ActionComponent, DecorationMember, DocumentActionComponent, DocumentActionDialogProps, DocumentDefinition, EditStateFor, GeneralPreviewLayoutKey, InitialValueTemplateItem, PreviewConfig, ReleaseId, SanityClient, SanityDocument as SanityDocument$1, TimelineStore } from "sanity";
interface BaseStructureToolPaneProps<T extends PaneNode['type']> {
paneKey: string;
index: number;
itemId: string;
childItemId?: string;
isSelected?: boolean;
isActive?: boolean;
pane: Extract<PaneNode, {
type: T;
}>;
/**
* TODO: COREL - Remove this after updating sanity-assist to use <PerspectiveProvider>
*
* Allows to override the global version with a specific version or release.
* @deprecated use <PerspectiveProvider> instead
* @beta
*/
forcedVersion?: {
selectedPerspectiveName: ReleaseId | 'published' | undefined;
isReleaseLocked: boolean;
selectedReleaseId: ReleaseId | undefined;
};
/**
* @deprecated Avoid specifying a key, instead use `paneKey` if need be
*/
key?: string;
}
/** @internal */
interface ConfirmDeleteDialogProps {
/**
* Incoming document ID used to find other referencing documents. This
* field respects draft IDs (e.g. if you pass in a published ID when one
* doesn't exist the document title may not show up).
*/
id: string;
/**
* The schema typename of the incoming document
*/
type: string;
/**
* The name of the action being done. (e.g. the `'unpublish'` action requires
* the same document deletion confirmation).
*/
action?: 'delete' | 'unpublish';
onCancel: () => void;
onConfirm: (versions: string[]) => void;
}
/** @internal */
declare function ConfirmDeleteDialogContainer(props: ConfirmDeleteDialogProps): react.JSX.Element;
interface PaneProps {
children?: ReactNode;
currentMinWidth?: number;
currentMaxWidth?: number;
flex?: number;
id: string;
minWidth?: number;
maxWidth?: number;
selected?: boolean;
}
/**
* @hidden
* @internal
*/
declare const Pane: react.ForwardRefExoticComponent<Omit<PaneProps & Omit<CardProps, "as" | "overflow"> & Omit<HTMLProps<HTMLDivElement>, "as" | "height" | "hidden" | "id" | "style">, "ref"> & react.RefAttributes<HTMLDivElement>>;
interface PaneContentProps {
as?: ElementType | keyof React.JSX.IntrinsicElements;
overflow?: BoxOverflow;
padding?: number | number[];
}
/**
* @hidden
* @internal
*/
declare const PaneContent: react.ForwardRefExoticComponent<PaneContentProps & Omit<HTMLProps<HTMLDivElement>, "as" | "height" | "ref"> & react.RefAttributes<HTMLDivElement>>;
/**
*
* @hidden
* @beta This API will change. DO NOT USE IN PRODUCTION.
*/
interface PaneLayoutProps {
minWidth?: number;
onCollapse?: () => void;
onExpand?: () => void;
}
/**
*
* @hidden
* @beta This API will change. DO NOT USE IN PRODUCTION.
*/
declare function PaneLayout(props: PaneLayoutProps & CardProps & Omit<HTMLProps<HTMLDivElement>, 'as' | 'height' | 'ref' | 'wrap'>): react.JSX.Element;
/**
*
* @hidden
* @beta
*/
declare function usePaneRouter(): PaneRouterContextValue;
type IncomingReferenceActionsContext = {
/**
* The document that is linked to the reference.
*/
document: SanityDocument$1;
getClient: (options: {
apiVersion: string;
}) => SanityClient;
};
type IncomingReferenceActionDescription = {
label: string;
icon?: React.ElementType;
tone?: SelectableTone;
disabled?: boolean;
onHandle: (() => Promise<void>) | (() => void);
dialog?: DocumentActionDialogProps | false | null;
};
/**
* Incoming reference action component definition.
* Allows users to define actions that will be shown in the IncomingReferences component as part
* of each reference
* example:
* ```ts
* export const LogReferenceAction: IncomingReferenceAction = ({document, getClient}) => {
* return {
* label: 'Log reference',
* icon: LogIcon,
* onHandle: () => console.log(document._id)
* }
* }
* ```
*
* @beta
*/
type IncomingReferenceAction = ActionComponent<IncomingReferenceActionsContext, IncomingReferenceActionDescription>;
interface CrossDatasetIncomingReference {
type: string;
title?: string;
dataset: string;
preview: PreviewConfig;
studioUrl?: (document: {
id: string;
type?: string;
}) => string | null;
}
interface IncomingReferenceType {
type: string;
dataset?: never;
title?: string;
}
type IncomingReferencesFilterResolver = (context: {
document: SanityDocument$1 | undefined;
getClient: (options: {
apiVersion: string;
}) => SanityClient;
}) => string | {
filter: string;
filterParams?: Record<string, string>;
} | Promise<{
filter: string;
filterParams?: Record<string, string>;
}>;
type IncomingReferencesOptions = {
name: string;
title?: string;
description?: string;
/**
* The type of the incoming references.
*/
types: (IncomingReferenceType | CrossDatasetIncomingReference)[];
/**
* The filter query to apply to the incoming references in addition to the type filter.
* For example: filter all books that are from an specific editorial brand: `editorialBrand == "Random House"`
* The `_type` filter is applied automatically.
*/
filter?: string | IncomingReferencesFilterResolver;
filterParams?: Record<string, string>;
/**
* Callback to link a document to a reference.
*
* This function is called when a user wants to link an existing document to the current document.
* It receives two parameters:
* - The document that will be linked (the target document)
* - The reference object with all properties needed to establish the link
*
* The developer must implement this function to define where and how the reference
* should be placed within the document structure. The function should return the
* modified document with the reference properly added.
*
* For example:
* - We want to link a book to an author:
* ```ts
* onLinkDocument: (document, reference) => {
* return {
* ...document,
* author: reference,
* }
* }
* ```
*
*
* @param document - The document to link to the reference.
* @param reference - The reference to link to the document.
* @returns The document to link to the reference. If false, the document will not be linked to the reference.
*/
onLinkDocument?: (document: SanityDocument$1, reference: {
_type: 'reference';
_ref: string;
_weak?: boolean;
_strengthenOnPublish?: {
type: string;
};
}) => SanityDocument$1 | false;
/**
* Callback to define the actions that will be shown for the incoming reference document.
*
* For example:
* ```ts
* actions: ({document, client}) => {
* return [
* {label: 'Unlink document',
* icon: TrashIcon,
* tone: 'critical',
* onClick: async () => {
* await client.createOrReplace({...document, _id: getDraftId(document._id), author: undefined})
* }
* }
* ]
* }
* ```
* @param context - The context of the linked document.
* @returns The actions that will be shown for the linked document.
*/
actions?: IncomingReferenceAction[];
/**
* Whether to allow creation of new references.
* default: true
*
* If false, it will only be possible to link to existing documents, if the `onLinkDocument` callback is provided.
* If true, it will be possible to create new references to any template of the type.
* If an array is provided, it will only be possible to create new references that match the template id in the array provided.
*
* To define how a creation will be handled, you can use the `initialValue` option in the
* document type that will be linked.
*
* For example:
* I want to create a new book from an author:
* In the author we will have the <IncomingReferenceInput /> with the creationAllowed set to true.
*
* Then in the book type, we will have the `initialValue` option to define the default values for the new book.
* This initialValue callback will receive the `reference` object that needs to be linked to the book in the params.
*
* ```ts
* // Book type
* export default {
* type: 'document',
* name: 'book',
* title: 'Book',
* fields: [
* {
* name: 'author',
* type: 'reference',
* to: [{type: 'author'}],
* },
* ],
* initialValue: (params) => {
* return {
* author: params?.reference,
* }
* }
* ```
*/
creationAllowed?: boolean | string[];
};
/**
* Helper function to define an incoming references decoration.
*
* example:
* ```ts
* defineType({
* name: 'author',
* type: 'document',
* renderMembers: (members) => {
* return [
* ...members,
* defineIncomingReferenceDecoration({
* name: 'incomingReferences',
* title: 'Incoming references',
* types: [{type: 'author'}],
* }),
* ]
* },
* })
* ```
*
* @beta
*/
declare function defineIncomingReferenceDecoration(options: IncomingReferencesOptions): DecorationMember;
interface IncomingReferenceCreationParams {
reference: {
_type: 'reference';
_ref: string;
_weak?: boolean;
_strengthenOnPublish?: {
type: string;
};
};
from: {
fieldName: string;
type: string;
};
__internal_isIncomingReferenceCreation: true;
[key: string]: unknown;
}
/**
* Helper function to check if the document is being created from an incoming reference.
* It will be used in the initialValue callback to determine if the document is being created from an incoming reference.
*
* example:
* ```ts
* defineType({
* name: 'book',
* type: 'document',
* fields: [...],
* initialValue: (params) => {
* // If the document is being created from an incoming reference, return the reference
* // Otherwise, return undefined
* return {
* author: isIncomingReferenceCreation(params) ? params.reference : undefined,
* }
* },
* })
* ```
*
* @beta
*/
declare function isIncomingReferenceCreation(initialValue: DocumentDefinition['initialValue']): initialValue is IncomingReferenceCreationParams;
/**
* Defined locale strings for the structure tool, in US English.
*
* @internal
*/
declare const structureLocaleStrings: {
/** Label for the "Copy document ID" menu item */'action.copy-document-id.label': string; /** Tooltip for the copy actions dropdown button in the document panel header */
'action.copy-document-url.label': string; /** Label for the "Copy document URL" menu item */
'action.copy-link-to-document.label': string; /** Tooltip when action button is disabled because the operation is not ready */
'action.delete.disabled.not-ready': string; /** Tooltip when action button is disabled because the document does not exist */
'action.delete.disabled.nothing-to-delete': string; /** Tooltip when action button is disabled because the document exists in scheduled releases */
'action.delete.disabled.scheduled-release': string; /** Label for the "Delete" document action button */
'action.delete.label': string; /** Label for the "Delete" document action while the document is being deleted */
'action.delete.running.label': string; /** Tooltip when action is disabled because the document is linked to Canvas */
'action.disabled-by-canvas.tooltip': string; /** Message prompting the user to confirm discarding changes */
'action.discard-changes.confirm-dialog.confirm-discard-changes': string; /** Message prompting the user to confirm discarding changes */
'action.discard-changes.confirm-dialog.confirm-discard-changes-draft': string; /**Header for the confirm discard dialog */
'action.discard-changes.confirm-dialog.header.text': string; /** Tooltip when action is disabled because the document has no unpublished changes */
'action.discard-changes.disabled.no-change': string; /** Tooltip when action is disabled because the document is not published */
'action.discard-changes.disabled.not-published': string; /** Tooltip when action button is disabled because the operation is not ready */
'action.discard-changes.disabled.not-ready': string; /** Label for the "Discard changes" document action */
'action.discard-changes.label': string; /** Tooltip when action is disabled because the operation is not ready */
'action.duplicate.disabled.not-ready': string; /** Tooltip when action is disabled because the document doesn't exist */
'action.duplicate.disabled.nothing-to-duplicate': string; /** Label for the "Duplicate" document action */
'action.duplicate.label': string; /** Label for the "Duplicate" document action while the document is being duplicated */
'action.duplicate.running.label': string; /** Tooltip when publish button is disabled because the document is already published, and published time is unavailable.*/
'action.publish.already-published.no-time-ago.tooltip': string; /** Tooltip when publish button is disabled because the document is already published.*/
'action.publish.already-published.tooltip': string; /** Tooltip when action is disabled because the studio is not ready.*/
'action.publish.disabled.not-ready': string; /** Label for action when there are pending changes.*/
'action.publish.draft.label': string; /** Label for the "Publish" document action */
'action.publish.label': string; /** Label for the "Publish" document action when the document has live edit enabled.*/
'action.publish.live-edit.label': string; /** Fallback tooltip for the "Publish" document action when publish is invoked for a document with live edit enabled.*/
'action.publish.live-edit.publish-disabled': string; /** Tooltip for the "Publish" document action when the document has live edit enabled.*/
'action.publish.live-edit.tooltip': string; /** Tooltip when publish button is disabled because there are no changes.*/
'action.publish.no-changes.tooltip': string; /** Label for the "Publish" document action when there are no changes.*/
'action.publish.published.label': string; /** Label for the "Publish" document action while publish is being executed.*/
'action.publish.running.label': string; /** Label for the "Publish" document action while publish is being executed.*/
'action.publish.validation-in-progress.label': string; /** Toast description when trying to publish with validation errors */
'action.publish.validation-issues-toast.description': string; /** Toast title when trying to publish with validation errors */
'action.publish.validation-issues-toast.title': string; /** Tooltip when the "Publish" document action is disabled due to validation issues */
'action.publish.validation-issues.tooltip': string; /** Tooltip when publish button is waiting for validation and async tasks to complete.*/
'action.publish.waiting': string; /** Message prompting the user to confirm that they want to restore to an earlier revision*/
'action.restore.confirm.message': string; /** Fallback tooltip for when user is looking at the initial revision */
'action.restore.disabled.cannot-restore-initial': string; /** Label for the "Restore" document action */
'action.restore.label': string; /** Default tooltip for the action */
'action.restore.tooltip': string; /** Tooltip when action is disabled because the document is not already published */
'action.unpublish.disabled.not-published': string; /** Tooltip when action is disabled because the operation is not ready */
'action.unpublish.disabled.not-ready': string; /** Label for the "Unpublish" document action */
'action.unpublish.label': string; /** Fallback tooltip for the Unpublish document action when publish is invoked for a document with live edit enabled.*/
'action.unpublish.live-edit.disabled': string; /** Description for the archived release banner, rendered when viewing the history of a version document from the publihed view */
'banners.archived-release.description': string; /** Description for the archived scheduled draft banner, rendered when viewing the history of a cardinality one release document */
'banners.archived-scheduled-draft.description': string; /** The explanation displayed when a user attempts to create a new draft document, but the draft model is not switched on */
'banners.choose-new-document-destination.cannot-create-draft-document': string; /** The explanation displayed when a user attempts to create a new published document, but the schema type doesn't support live-editing */
'banners.choose-new-document-destination.cannot-create-published-document': string; /** The prompt displayed when a user must select a different perspective in order to create a document */
'banners.choose-new-document-destination.choose-destination': string; /** The explanation displayed when a user attempts to create a new document in a release, but the selected release is inactive */
'banners.choose-new-document-destination.release-inactive': string; /** The text for the restore button on the deleted document banner */
'banners.deleted-document-banner.restore-button.text': string; /** The text content for the deleted document banner */
'banners.deleted-document-banner.text': string; /** The text content for the deprecated document type banner */
'banners.deprecated-document-type-banner.text': string; /** The text for publish action for discarding the version */
'banners.live-edit-draft-banner.discard.tooltip': string; /** The text for publish action for the draft banner */
'banners.live-edit-draft-banner.publish.tooltip': string; /** The text content for the live edit document when it's a draft */
'banners.live-edit-draft-banner.text': string; /** The label for the "compare draft" action */
'banners.obsolete-draft.actions.compare-draft.text': string; /** The label for the "discard draft" action */
'banners.obsolete-draft.actions.discard-draft.text': string; /** The label for the "publish draft" action */
'banners.obsolete-draft.actions.publish-draft.text': string; /** The warning displayed when editing a document that has an obsolete draft because the draft model is not switched on */
'banners.obsolete-draft.draft-model-inactive.text': string; /** The text content for the paused scheduled draft banner */
'banners.paused-scheduled-draft.text': string; /** The text for the permission check banner if the user only has one role, and it does not allow publishing this document */
'banners.permission-check-banner.missing-permission_create_one': string; /** The text for the permission check banner if the user only has multiple roles, but they do not allow publishing this document */
'banners.permission-check-banner.missing-permission_create_other': string; /** The text for the permission check banner if the user only has one role, and it does not allow editing this document */
'banners.permission-check-banner.missing-permission_update_one': string; /** The text for the permission check banner if the user only has multiple roles, but they do not allow editing this document */
'banners.permission-check-banner.missing-permission_update_other': string; /** The pending text for the request permission button that appears for viewer roles */
'banners.permission-check-banner.request-permission-button.sent': string; /** The text for the request permission button that appears for viewer roles */
'banners.permission-check-banner.request-permission-button.text': string; /** Description for the archived release banner, rendered when viewing the history of a version document from the published view */
'banners.published-release.description': string; /** The text for the reload button */
'banners.reference-changed-banner.reason-changed.reload-button.text': string; /** The text for the reference change banner if the reason is that the reference has been changed */
'banners.reference-changed-banner.reason-changed.text': string; /** The text for the close button */
'banners.reference-changed-banner.reason-removed.close-button.text': string; /** The text for the reference change banner if the reason is that the reference has been deleted */
'banners.reference-changed-banner.reason-removed.text': string; /** The text that appears for the action button to add the current document to the global bundle, this happens when user is viewing an anonymous bundle */
'banners.release.action.add-to-bundle': string; /** The text that appears for the action button to add the current document to the global release */
'banners.release.action.add-to-release': string; /** The text that appears for the action button to add the current document to the global release */
'banners.release.action.open-to-edit': string; /** Toast description in case an error occurs when adding a document to a release */
'banners.release.error.description': string; /** Toast title in case an error occurs when adding a document to a release */
'banners.release.error.title': string; /** The text for the banner that appears when a document only has versions but is in a draft or published pinned release */
'banners.release.navigate-to-edit-description': string; /** The text for the banner that appears when a document only has versions but is in a draft or published pinned release */
'banners.release.navigate-to-edit-description-end_one': string; /** The text for the banner that appears when a document only has versions but is in a draft or published pinned release */
'banners.release.navigate-to-edit-description-end_other': string; /** The text for the banner that appears when there are multiple versions but no drafts or published, only one extra releases */
'banners.release.navigate-to-edit-description-multiple_one': string; /** The text for the banner that appears when there are multiple versions but no drafts or published, more than one extra releases */
'banners.release.navigate-to-edit-description-multiple_other': string;
/** The text for the banner that appears when a document is not part of any release
* @deprecated – no longer in use
* */
'banners.release.navigate-to-edit-description-none': string; /** The text for the banner that appears when a document only has one version but is in a draft or published pinned release */
'banners.release.navigate-to-edit-description-single': string; /** The text for the banner that appears when a document is not in the current global release */
'banners.release.not-in-release': string; /** Description of toast that will appear in case of latency between the user adding a document to a release and the UI reflecting it */
'banners.release.waiting.description': string; /** Title of toast that will appear in case of latency between the user adding a document to a release and the UI reflecting it */
'banners.release.waiting.title': string; /** The text for the revision not found banner */
'banners.revision-not-found.description': string; /** The text content for the scheduled draft override banner */
'banners.scheduled-draft-override-banner.text': string; /** The text content for the unpublished document banner when is part of a release */
'banners.unpublished-release-banner.text': string; /** The text content for the unpublished document banner letting the user know that the current published version is being shown */
'banners.unpublished-release-banner.text-with-published': string; /** Browser/tab title when creating a new document of a given type */
'browser-document-title.new-document': string; /** Browser/tab title when editing a document where the title cannot be resolved from preview configuration */
'browser-document-title.untitled-document': string; /** The action menu button aria-label */
'buttons.action-menu-button.aria-label': string; /** The action menu button tooltip */
'buttons.action-menu-button.tooltip': string; /** The aria-label for the collapse pane button on the document panel header */
'buttons.focus-pane-button.aria-label.collapse': string; /** The aria-label for the focus pane button on the document panel header */
'buttons.focus-pane-button.aria-label.focus': string; /** The tooltip for the collapse pane button on the document panel header */
'buttons.focus-pane-button.tooltip.collapse': string; /** The tooltip for the focus pane button on the document panel header */
'buttons.focus-pane-button.tooltip.focus': string; /** The aria-label for the split pane button on the document panel header */
'buttons.split-pane-button.aria-label': string; /** The tool tip for the split pane button on the document panel header */
'buttons.split-pane-button.tooltip': string; /** The title for the close button on the split pane on the document panel header */
'buttons.split-pane-close-button.title': string; /** The title for the close group button on the split pane on the document panel header */
'buttons.split-pane-close-group-button.title': string; /** The text for the canvas linked banner action button */
'canvas.banner.edit-in-canvas-action': string; /** The text for the canvas linked banner when the document in editable mode*/
'canvas.banner.editable.linked-text': string; /** The description for the canvas linked banner popover in editable mode*/
'canvas.banner.editable.popover-description': string; /** The heading for the canvas linked banner popover in editable mode*/
'canvas.banner.editable.popover-heading': string; /** The text for the canvas linked banner when the document is a draft */
'canvas.banner.linked-text.draft': string; /** The text for the canvas linked banner when the document is a live document */
'canvas.banner.linked-text.published': string; /** The text for the canvas linked banner when the document is a version document */
'canvas.banner.linked-text.version': string; /** The text for the canvas linked banner popover button */
'canvas.banner.popover-button-text': string; /** The description for the canvas linked banner popover */
'canvas.banner.popover-description': string; /** The heading for the canvas linked banner popover */
'canvas.banner.popover-heading': string; /** The description for the changes banner */
'changes.banner.description': string; /** The tooltip for the changes banner */
'changes.banner.tooltip': string; /** The label used in the changes inspector for the from selector */
'changes.from.label': string;
'changes.tab.history': string;
'changes.tab.review-changes': string; /** The label used in the changes inspector for the to selector */
'changes.to.label': string; /** The error message shown when the specified document comparison mode is not supported */
'compare-version.error.invalidModeParam': string; /** The error message shown when the next document for comparison could not be extracted from the URL */
'compare-version.error.invalidNextDocumentParam': string; /** The error message shown when the document comparison URL could not be parsed */
'compare-version.error.invalidParams.title': string; /** The error message shown when the previous document for comparison could not be extracted from the URL */
'compare-version.error.invalidPreviousDocumentParam': string; /** The error message shown when releases failed to load */
'compare-version.error.loadReleases.title': string; /** The text for the tooltip when the "Compare versions" action for a document is disabled */
'compare-versions.menu-item.disabled-reason': string; /** The text for the "Compare versions" action for a document */
'compare-versions.menu-item.title': string; /** The string used to label draft documents */
'compare-versions.status.draft': string; /** The string used to label published documents */
'compare-versions.status.published': string; /** The title used when comparing versions of a document */
'compare-versions.title': string; /** The text in the "Cancel" button in the confirm delete dialog that cancels the action and closes the dialog */
'confirm-delete-dialog.cancel-button.text': string; /** Used in `confirm-delete-dialog.cdr-summary.title` */
'confirm-delete-dialog.cdr-summary.document-count_one': string; /** Used in `confirm-delete-dialog.cdr-summary.title` */
'confirm-delete-dialog.cdr-summary.document-count_other': string; /** The text that appears in the subtitle `<summary>` that lists the datasets below the title */
'confirm-delete-dialog.cdr-summary.subtitle_one': string; /** The text that appears in the subtitle `<summary>` that lists the datasets below the title */
'confirm-delete-dialog.cdr-summary.subtitle_other': string; /** The text that appears in the subtitle `<summary>` that lists the datasets below the title */
'confirm-delete-dialog.cdr-summary.subtitle_unavailable_one': string; /** The text that appears in the subtitle `<summary>` that lists the datasets below the title */
'confirm-delete-dialog.cdr-summary.subtitle_unavailable_other': string; /** The text that appears in the title `<summary>` that includes the list of CDRs (singular) */
'confirm-delete-dialog.cdr-summary.title_one': string; /** The text that appears in the title `<summary>` that includes the list of CDRs (plural) */
'confirm-delete-dialog.cdr-summary.title_other': string; /** Appears when hovering over the copy button to copy */
'confirm-delete-dialog.cdr-table.copy-id-button.tooltip': string; /** The header for the dataset column in the list of cross-dataset references found */
'confirm-delete-dialog.cdr-table.dataset.label': string; /** The header for the document ID column in the list of cross-dataset references found */
'confirm-delete-dialog.cdr-table.document-id.label': string; /** The toast title when the copy button has been clicked but copying failed */
'confirm-delete-dialog.cdr-table.id-copied-toast.title-failed': string; /** The header for the project ID column in the list of cross-dataset references found */
'confirm-delete-dialog.cdr-table.project-id.label': string; /** The text in the "Delete anyway" button in the confirm delete dialog that confirms the action */
'confirm-delete-dialog.confirm-anyway-button.text_delete': string; /** The text in the "Unpublish anyway" button in the confirm delete dialog that confirms the action */
'confirm-delete-dialog.confirm-anyway-button.text_unpublish': string; /** The text in the "Delete now" button in the confirm delete dialog that confirms the action */
'confirm-delete-dialog.confirm-button.text_delete': string; /** The text in the "Unpublish now" button in the confirm delete dialog that confirms the action */
'confirm-delete-dialog.confirm-button.text_unpublish': string; /** If no referring documents are found, this text appears above the cancel and confirmation buttons */
'confirm-delete-dialog.confirmation.text_delete': string; /** If no referring documents are found, this text appears above the cancel and confirmation buttons */
'confirm-delete-dialog.confirmation.text_unpublish': string; /** The text body of the error dialog. */
'confirm-delete-dialog.error.message.text': string; /** The text in the retry button of the confirm delete dialog if an error occurred. */
'confirm-delete-dialog.error.retry-button.text': string; /** The header of the confirm delete dialog if an error occurred while the confirm delete dialog was open. */
'confirm-delete-dialog.error.title.text': string; /** The header of the confirm delete dialog */
'confirm-delete-dialog.header.text_delete': string; /** The header of the confirm delete dialog */
'confirm-delete-dialog.header.text_unpublish': string; /** The text that appears while the referring documents are queried */
'confirm-delete-dialog.loading.text': string; /** Shown if there are references to other documents but the user does not have the permission to see the relevant document IDs */
'confirm-delete-dialog.other-reference-count.title_one': string; /** Shown if there are references to other documents but the user does not have the permission to see the relevant document IDs */
'confirm-delete-dialog.other-reference-count.title_other': string; /** Text in the tooltip of this component if hovering over the info icon */
'confirm-delete-dialog.other-reference-count.tooltip': string; /** Appears when unable to render a document preview in the referring document list */
'confirm-delete-dialog.preview-item.preview-unavailable.subtitle': string; /** Appears when unable to render a document preview in the referring document list */
'confirm-delete-dialog.preview-item.preview-unavailable.title': string; /** Warns the user of affects to other documents if the action is confirmed (delete) */
'confirm-delete-dialog.referential-integrity-disclaimer.text_delete': string; /** Warns the user of affects to other documents if the action is confirmed (unpublish) */
'confirm-delete-dialog.referential-integrity-disclaimer.text_unpublish': string; /** Tells the user the count of how many other referring documents there are before listing them. (singular) */
'confirm-delete-dialog.referring-document-count.text_one': string; /** Tells the user the count of how many other referring documents there are before listing them. (plural) */
'confirm-delete-dialog.referring-document-count.text_other': string; /** Describes the list of documents that refer to the one trying to be deleted (delete) */
'confirm-delete-dialog.referring-documents-descriptor.text_delete': string; /** Describes the list of documents that refer to the one trying to be deleted (unpublish) */
'confirm-delete-dialog.referring-documents-descriptor.text_unpublish': string; /** The text for the cancel button in the confirm dialog used in document action shortcuts if none is provided */
'confirm-dialog.cancel-button.fallback-text': string; /** The text for the confirm button in the confirm dialog used in document action shortcuts if none is provided */
'confirm-dialog.confirm-button.fallback-text': string; /** For the default structure definition, the title for the "Content" pane */
'default-definition.content-title': string; /** The text shown if there was an error while getting the document's title via a preview value */
'doc-title.error.text': string; /** The text shown if the preview value for a document is non-existent or empty */
'doc-title.fallback.text': string; /** The text shown if a document's title via a preview value cannot be determined due to an unknown schema type */
'doc-title.unknown-schema-type.text': string; /** Tooltip text shown for the close button of the document inspector */
'document-inspector.close-button.tooltip': string; /** The title shown in the dialog header, when inspecting a valid document */
'document-inspector.dialog.title': string; /** The title shown in the dialog header, when the document being inspected is not created yet/has no value */
'document-inspector.dialog.title-no-value': string; /** Title shown for menu item that opens the "Inspect" dialog */
'document-inspector.menu-item.title': string; /** the placeholder text for the search input on the inspect dialog */
'document-inspector.search.placeholder': string; /** The "parsed" view mode, meaning the JSON is searchable, collapsible etc */
'document-inspector.view-mode.parsed': string; /** The "raw" view mode, meaning the JSON is presented syntax-highlighted, but with no other features - optimal for copying */
'document-inspector.view-mode.raw-json': string; /** The text for when a form is hidden */
'document-view.form-view.form-hidden': string; /** Fallback title shown when a form title is not provided */
'document-view.form-view.form-title-fallback': string; /** The text for when the form view is loading a document */
'document-view.form-view.loading': string; /** The description of the sync lock toast on the form view */
'document-view.form-view.sync-lock-toast.description': string; /** The title of the sync lock toast on the form view */
'document-view.form-view.sync-lock-toast.title': string; /** The description for the document favorite action */
'document.favorites.add-to-favorites': string; /** The description for the document unfavorite action */
'document.favorites.remove-from-favorites': string; /** The description for the events inspector when we can't load the document so we default to compare with published */
'events.compare-with-published.description': string; /** The title for the events inspector when we can't load the document so we default to compare with published */
'events.compare-with-published.title': string; /**The title for the menu items that will be shown when expanding a publish release event to inspect the document */
'events.inspect.release': string; /**The title for the menu items that will be shown when expanding a publish draft event to inspect the draft document*/
'events.open.draft': string; /**The title for the menu items that will be shown when expanding a publish release event to inspect the release*/
'events.open.release': string; /** The text for the add reference item in the incoming references input */
'incoming-references-input.add-reference-item': string; /** The aria-label for the incoming references list */
'incoming-references-input.list-label': string; /** The text for the no items in the incoming references input */
'incoming-references-input.no-items': string; /** The text for the reference from in the incoming references input */
'incoming-references-input.reference-from': string; /** The text for the schema type not found in the incoming references input */
'incoming-references-input.schema-type-not-found': string; /** The text for the type to search in the incoming references input */
'incoming-references-input.type-to-search': string; /** The text for the loading state in the incoming references input */
'incoming-references-input.types-loading': string; /** The text for the loading state in the incoming references input */
'incoming-references-input.types-loading-cross-dataset': string; /** The text for the no references defined in the incoming references input */
'incoming-references-input.types-not-defined': string; /** The text shown if there are no incoming references in the inspector */
'incoming-references-pane.no-references': string; /** The text shown if there are no incoming references for a type */
'incoming-references-pane.no-references-found': string; /** The text shown if there is no schema type found for a document in the incoming references pane */
'incoming-references-pane.schema-type-not-found': string; /** The loading messaging for when the tooltip is still loading permission info */
'insufficient-permissions-message-tooltip.loading-text': string;
/** --- Menu items --- */
/** The menu item group title to use for the Action menu items */
'menu-item-groups.actions-group': string; /** The menu item group title to use for the Layout menu items */
'menu-item-groups.layout-group': string; /** The menu item group title to use for the Sort menu items */
'menu-item-groups.sorting-group': string; /** The menu item title to use the compact view */
'menu-items.layout.compact-view': string; /** The menu item title to use the detailed view */
'menu-items.layout.detailed-view': string; /** The menu item title to Sort by Created */
'menu-items.sort-by.created': string; /** The menu item title to Sort by Last Edited */
'menu-items.sort-by.last-edited': string; /** The link text of the no document type screen that appears directly below the subtitle */
'no-document-types-screen.link-text': string; /** The subtitle of the no document type screen that appears directly below the title */
'no-document-types-screen.subtitle': string; /** The title of the no document type screen */
'no-document-types-screen.title': string; /** Text shown on back button visible on smaller breakpoints */
'pane-header.back-button.text': string; /** tooltip text (via `title` attribute) for the menu button */
'pane-header.context-menu-button.tooltip': string; /** Appears in a document list pane header if there are more than one option for create. This is the label for that menu */
'pane-header.create-menu.label': string; /** Tooltip displayed on the create new button in document lists */
'pane-header.create-new-button.tooltip': string; /** The `aria-label` for the disabled button in the pane header if create permissions are granted */
'pane-header.disabled-created-button.aria-label': string; /** The text shown in the tooltip of pane item previews of documents if there are unpublished edits */
'pane-item.draft-status.has-draft.tooltip': string; /** The text shown in the tooltip of pane item previews of documents if there are no unpublished edits */
'pane-item.draft-status.no-draft.tooltip': string; /** The subtitle tor pane item previews if there isn't a matching schema type found */
'pane-item.missing-schema-type.subtitle': string; /** The title tor pane item previews if there isn't a matching schema type found */
'pane-item.missing-schema-type.title': string; /** The text shown in the tooltip of pane item previews of documents if there are unpublished edits */
'pane-item.published-status.has-published.tooltip': string; /** The text shown in the tooltip of pane item previews of documents if there are no unpublished edits */
'pane-item.published-status.no-published.tooltip': string; /** The text used in the document header title if there is an error */
'panes.document-header-title.error.text': string; /** The text used in the document header title if creating a new item */
'panes.document-header-title.new.text': string; /** The text used in the document header title if no other title can be determined */
'panes.document-header-title.untitled.text': string; /** The help text saying that we have given up on automatic retry */
'panes.document-list-pane.error.max-retries-attempted': string; /** The help text saying that we'll retry fetching the document list */
'panes.document-list-pane.error.retrying': string; /** The error text on the document list pane */
'panes.document-list-pane.error.text': string; /** The error text on the document list pane */
'panes.document-list-pane.error.text.dev': string; /** The error text on the document list pane if the browser appears to be offlline */
'panes.document-list-pane.error.text.offline': string; /** The error title on the document list pane */
'panes.document-list-pane.error.title': string; /** The help text saying that we'll retry fetching the document list */
'panes.document-list-pane.error.will-retry-automatically_one': string;
'panes.document-list-pane.error.will-retry-automatically_other': string; /** The text of the document list pane if more than a maximum number of documents are returned */
'panes.document-list-pane.max-items.text': string; /** The text of the document list pane if no documents are found for a specified type */
'panes.document-list-pane.no-documents-of-type.text': string; /** The text of the document list pane if no documents are found */
'panes.document-list-pane.no-documents.text': string; /** The text of the document list pane if no documents are found matching specified criteria */
'panes.document-list-pane.no-matching-documents.text': string; /** The search input for the search input on the document list pane */
'panes.document-list-pane.reconnecting': string; /** The aria-label for the search input on the document list pane */
'panes.document-list-pane.search-input.aria-label': string; /** The search input for the search input on the document list pane */
'panes.document-list-pane.search-input.placeholder': string; /** The summary title when displaying an error for a document operation result */
'panes.document-operation-results.error.summary.title': string; /** The text when a generic operation failed (fallback, generally not shown) */
'panes.document-operation-results.operation-error': string; /** The text when a delete operation failed */
'panes.document-operation-results.operation-error_delete': string; /** The text when an unpublish operation failed */
'panes.document-operation-results.operation-error_unpublish': string; /** The text when a generic operation succeeded (fallback, generally not shown) */
'panes.document-operation-results.operation-success': string; /** The text when copy document ID operation succeeded */
'panes.document-operation-results.operation-success_copy-id': string; /** The text when copy URL operation succeeded */
'panes.document-operation-results.operation-success_copy-url': string; /** */
'panes.document-operation-results.operation-success_createVersion': string; /** The text when a delete operation succeeded */
'panes.document-operation-results.operation-success_delete': string; /** The text when a discard changes operation succeeded */
'panes.document-operation-results.operation-success_discardChanges': string; /** The text when a duplicate operation succeeded */
'panes.document-operation-results.operation-success_duplicate': string; /** The text when a publish operation succeeded */
'panes.document-operation-results.operation-success_publish': string; /** The text when a publish operation succeeded in an anonymous version */
'panes.document-operation-results.operation-success_publishVersion': string; /** The text when a restore operation succeeded */
'panes.document-operation-results.operation-success_restore': string; /** The text when an unpublish operation succeeded */
'panes.document-operation-results.operation-success_unpublish': string; /** The document title shown when document title is "undefined" in operation message */
'panes.document-operation-results.operation-undefined-title': string; /** The loading message for the document not found pane */
'panes.document-pane.document-not-found.loading': string; /** The text of the document not found pane if the schema is known */
'panes.document-pane.document-not-found.text': string; /** The title of the document not found pane if the schema is known */
'panes.document-pane.document-not-found.title': string; /** The text of the document not found pane if the schema is not found */
'panes.document-pane.document-unknown-type.text': string; /** The title of the document not found pane if the schema is not found or unknown */
'panes.document-pane.document-unknown-type.title': string; /** The title of the document not found pane if the schema is unknown */
'panes.document-pane.document-unknown-type.without-schema.text': string; /** Default message shown while resolving the structure definition for an asynchronous node */
'panes.resolving.default-message': string; /** Message shown while resolving the structure definition for an asynchronous node and it is taking a while (more than 5s) */
'panes.resolving.slow-resolve-message': string; /** The text to display when type is missing */
'panes.unknown-pane-type.missing-type.text': string; /** The title of the unknown pane */
'panes.unknown-pane-type.title': string; /** The text to display when type is unknown */
'panes.unknown-pane-type.unknown-type.text': string; /** The text for the "Open preview" action for a document */
'production-preview.menu-item.title': string; /** The text for the confirm button in the request permission dialog used in the permissions banner */
'request-permission-dialog.confirm-button.text': string; /** The description text for the request permission dialog used in the permissions banner */
'request-permission-dialog.description.text': string; /** The header/title for the request permission dialog used in the permissions banner */
'request-permission-dialog.header.text': string; /** The text describing the note input for the request permission dialog used in the permissions banner */
'request-permission-dialog.note-input.description.text': string; /** The placeholder for the note input in the request permission dialog used in the permissions banner */
'request-permission-dialog.note-input.placeholder.text': string; /** The error/warning text in the request permission dialog when the user's request has been declined */
'request-permission-dialog.warning.denied.text': string; /** The error/warning text in the request permission dialog when the user's request has been denied due to too many outstanding requests */
'request-permission-dialog.warning.limit-reached.text': string; /** Label for button when status is saved */
'status-bar.document-status-pulse.status.saved.text': string; /** Label for button when status is syncing */
'status-bar.document-status-pulse.status.syncing.text': string; /** Accessibility label indicating when the document was last published, in relative time, eg "3 weeks ago" */
'status-bar.publish-status-button.last-published-time.aria-label': string; /** Text for tooltip showing explanation of timestamp/relative time, eg "Last published <RelativeTime/>" */
'status-bar.publish-status-button.last-published-time.tooltip': string; /** Accessibility label indicating when the document was last updated, in relative time, eg "2 hours ago" */
'status-bar.publish-status-button.last-updated-time.aria-label': string; /** Text for tooltip showing explanation of timestamp/relative time, eg "Last updated <RelativeTime/>" */
'status-bar.publish-status-button.last-up