@portabletext/editor 2.3.2 → 2.3.4

package/lib/_chunks-dts/behavior.types.action.d.cts

@@ -1,6 +1,8 @@
 import { Patch, Patch as Patch$1 } from "@portabletext/patches";
 import * as _sanity_types5 from "@sanity/types";
 import { ArrayDefinition, ArraySchemaType, BlockDecoratorDefinition, BlockListDefinition, BlockStyleDefinition, ObjectSchemaType, Path, PortableTextBlock, PortableTextBlock as PortableTextBlock$1, PortableTextChild, PortableTextChild as PortableTextChild$1, PortableTextListBlock, PortableTextObject, PortableTextObject as PortableTextObject$1, PortableTextSpan, PortableTextSpan as PortableTextSpan$1, PortableTextTextBlock, PortableTextTextBlock as PortableTextTextBlock$1, TypedObject } from "@sanity/types";
+import * as _portabletext_schema5 from "@portabletext/schema";
+import { AnnotationDefinition, AnnotationSchemaType, BaseDefinition, BlockObjectDefinition, BlockObjectSchemaType, DecoratorDefinition, DecoratorSchemaType, FieldDefinition, InlineObjectDefinition, InlineObjectSchemaType, ListDefinition, ListSchemaType, Schema, SchemaDefinition, SchemaDefinition as SchemaDefinition$1, StyleDefinition, StyleSchemaType, defineSchema } from "@portabletext/schema";
 import * as xstate227 from "xstate";
 import { ActorRef, ActorRefFrom, EventObject, Snapshot } from "xstate";
 import { BaseRange, Descendant, Operation } from "slate";
@@ -127,146 +129,7 @@ type SlateEditor = {
 /**
  * @public
  */
-type BaseDefinition = {
-  name: string;
-  title?: string;
-};
-/**
- * @public
- */
-type FieldDefinition = BaseDefinition & {
-  type: 'string' | 'number' | 'boolean' | 'array' | 'object';
-};
-/**
- * @public
- */
-type DecoratorDefinition<TBaseDefinition extends BaseDefinition = BaseDefinition> = TBaseDefinition;
-/**
- * @public
- */
-type AnnotationDefinition<TBaseDefinition extends BaseDefinition = BaseDefinition> = TBaseDefinition & {
-  fields?: ReadonlyArray<FieldDefinition>;
-};
-/**
- * @public
- */
-type BlockObjectDefinition<TBaseDefinition extends BaseDefinition = BaseDefinition> = TBaseDefinition & {
-  fields?: ReadonlyArray<FieldDefinition>;
-};
-/**
- * @public
- */
-type InlineObjectDefinition<TBaseDefinition extends BaseDefinition = BaseDefinition> = TBaseDefinition & {
-  fields?: ReadonlyArray<FieldDefinition>;
-};
-/**
- * @public
- */
-type ListDefinition<TBaseDefinition extends BaseDefinition = BaseDefinition> = TBaseDefinition;
-/**
- * @public
- */
-type StyleDefinition<TBaseDefinition extends BaseDefinition = BaseDefinition> = TBaseDefinition;
-/**
- * @public
- */
-type SchemaDefinition<TBaseDefinition extends BaseDefinition = BaseDefinition> = {
-  decorators?: ReadonlyArray<DecoratorDefinition<TBaseDefinition>>;
-  blockObjects?: ReadonlyArray<BlockObjectDefinition<TBaseDefinition>>;
-  inlineObjects?: ReadonlyArray<InlineObjectDefinition<TBaseDefinition>>;
-  annotations?: ReadonlyArray<AnnotationDefinition<TBaseDefinition>>;
-  lists?: ReadonlyArray<ListDefinition<TBaseDefinition>>;
-  styles?: ReadonlyArray<StyleDefinition<TBaseDefinition>>;
-};
-/**
- * @public
- * A helper wrapper that adds editor support, such as autocomplete and type checking, for a schema definition.
- * @example
- * ```ts
- * import { defineSchema } from '@portabletext/editor'
- *
- * const schemaDefinition = defineSchema({
- *  decorators: [{name: 'strong'}, {name: 'em'}, {name: 'underline'}],
- *  annotations: [{name: 'link'}],
- *  styles: [
- *    {name: 'normal'},
- *    {name: 'h1'},
- *    {name: 'h2'},
- *    {name: 'h3'},
- *    {name: 'blockquote'},
- *  ],
- *  lists: [],
- *  inlineObjects: [],
- *  blockObjects: [],
- * }
- * ```
- */
-declare function defineSchema<const TSchemaDefinition extends SchemaDefinition>(definition: TSchemaDefinition): TSchemaDefinition;
-/**
- * @public
- */
-type EditorSchema = {
-  annotations: ReadonlyArray<AnnotationSchemaType>;
-  block: {
-    name: string;
-  };
-  blockObjects: ReadonlyArray<BlockObjectSchemaType>;
-  decorators: ReadonlyArray<DecoratorSchemaType>;
-  inlineObjects: ReadonlyArray<InlineObjectSchemaType>;
-  span: {
-    name: string;
-  };
-  styles: ReadonlyArray<StyleSchemaType>;
-  lists: ReadonlyArray<ListSchemaType>;
-};
-/**
- * @public
- */
-type AnnotationSchemaType = BaseDefinition & {
-  fields: ReadonlyArray<FieldDefinition>;
-};
-/**
- * @public
- */
-type BlockObjectSchemaType = BaseDefinition & {
-  fields: ReadonlyArray<FieldDefinition>;
-};
-/**
- * @public
- */
-type DecoratorSchemaType = BaseDefinition & {
-  /**
-   * @deprecated
-   * Use `name` instead
-   */
-  value: string;
-};
-/**
- * @public
- */
-type InlineObjectSchemaType = BaseDefinition & {
-  fields: ReadonlyArray<FieldDefinition>;
-};
-/**
- * @public
- */
-type ListSchemaType = BaseDefinition & {
-  /**
-   * @deprecated
-   * Use `name` instead
-   */
-  value: string;
-};
-/**
- * @public
- */
-type StyleSchemaType = BaseDefinition & {
-  /**
-   * @deprecated
-   * Use `name` instead
-   */
-  value: string;
-};
+type EditorSchema = Schema;
 type InternalEditor = Editor & {
   _internal: {
     editable: EditableAPI;
@@ -1912,7 +1775,7 @@ declare const editorMachine: xstate227.StateMachine<{
     keyGenerator: () => string;
     pendingEvents: never[];
     pendingIncomingPatchesEvents: never[];
-    schema: EditorSchema;
+    schema: _portabletext_schema5.Schema;
     selection: null;
     initialReadOnly: boolean;
     maxBlocks: number | undefined;
@@ -3747,4 +3610,4 @@ type BehaviorActionSet<TBehaviorEvent, TGuardResponse> = (payload: {
   event: TBehaviorEvent;
   dom: EditorDom;
 }, guardResponse: TGuardResponse) => Array<BehaviorAction>;
-export { type AddedAnnotationPaths, type AnnotationDefinition, type AnnotationPath, type AnnotationSchemaType, type BaseDefinition, Behavior, BehaviorAction, BehaviorActionSet, BehaviorEvent, BehaviorGuard, type BlockAnnotationRenderProps, type BlockChildRenderProps, type BlockDecoratorRenderProps, type BlockListItemRenderProps, type BlockObjectDefinition, type BlockObjectSchemaType, type BlockOffset, type BlockPath, type BlockRenderProps, type BlockStyleRenderProps, type BlurChange, type ChildPath, type ConnectionChange, CustomBehaviorEvent, type DecoratorDefinition, type DecoratorSchemaType, type EditableAPI, type EditableAPIDeleteOptions, type Editor, type EditorChange, type EditorChanges, type EditorConfig, type EditorContext, type EditorEmittedEvent, type EditorEvent, EditorEventListener, EditorProvider, type EditorProviderProps, type EditorSchema, type EditorSelection, type EditorSelectionPoint, type EditorSelector, type EditorSnapshot, type ErrorChange, type FieldDefinition, type FocusChange, type HotkeyOptions, type InlineObjectDefinition, type InlineObjectSchemaType, InsertPlacement, type InvalidValue, type InvalidValueResolution, type ListDefinition, type ListSchemaType, type LoadingChange, type MutationChange, type MutationEvent, NativeBehaviorEvent, type OnBeforeInputFn, type OnCopyFn, type OnPasteFn, type OnPasteResult, type OnPasteResultOrPromise, type PasteData, type Patch$1 as Patch, type PatchChange, type PatchObservable, type PatchesEvent, type PortableTextBlock$1 as PortableTextBlock, type PortableTextChild$1 as PortableTextChild, PortableTextEditable, type PortableTextEditableProps, PortableTextEditor, type PortableTextEditorProps, type PortableTextMemberSchemaTypes, type PortableTextObject$1 as PortableTextObject, type PortableTextSpan$1 as PortableTextSpan, type PortableTextTextBlock$1 as PortableTextTextBlock, type RangeDecoration, type RangeDecorationOnMovedDetails, type ReadyChange, type RedoChange, type RenderAnnotationFunction, type RenderBlockFunction, type RenderChildFunction, type RenderDecoratorFunction, type RenderEditableFunction, type RenderListItemFunction, type RenderPlaceholderFunction, type RenderStyleFunction, type SchemaDefinition, type ScrollSelectionIntoViewFunction, type SelectionChange, type StyleDefinition, type StyleSchemaType, SyntheticBehaviorEvent, type UndoChange, type UnsetChange, type ValueChange, defaultKeyGenerator, defineBehavior, defineSchema, effect, execute, forward, raise, useEditor, useEditorSelector, usePortableTextEditor, usePortableTextEditorSelection };
+export { type AddedAnnotationPaths, type AnnotationDefinition, type AnnotationPath, type AnnotationSchemaType, type BaseDefinition, Behavior, BehaviorAction, BehaviorActionSet, BehaviorEvent, BehaviorGuard, type BlockAnnotationRenderProps, type BlockChildRenderProps, type BlockDecoratorRenderProps, type BlockListItemRenderProps, type BlockObjectDefinition, type BlockObjectSchemaType, type BlockOffset, type BlockPath, type BlockRenderProps, type BlockStyleRenderProps, type BlurChange, type ChildPath, type ConnectionChange, CustomBehaviorEvent, type DecoratorDefinition, type DecoratorSchemaType, type EditableAPI, type EditableAPIDeleteOptions, type Editor, type EditorChange, type EditorChanges, type EditorConfig, type EditorContext, type EditorEmittedEvent, type EditorEvent, EditorEventListener, EditorProvider, type EditorProviderProps, type EditorSchema, type EditorSelection, type EditorSelectionPoint, type EditorSelector, type EditorSnapshot, type ErrorChange, type FieldDefinition, type FocusChange, type HotkeyOptions, type InlineObjectDefinition, type InlineObjectSchemaType, InsertPlacement, type InvalidValue, type InvalidValueResolution, type ListDefinition, type ListSchemaType, type LoadingChange, type MutationChange, type MutationEvent, NativeBehaviorEvent, type OnBeforeInputFn, type OnCopyFn, type OnPasteFn, type OnPasteResult, type OnPasteResultOrPromise, type PasteData, type Patch$1 as Patch, type PatchChange, type PatchObservable, type PatchesEvent, type PortableTextBlock$1 as PortableTextBlock, type PortableTextChild$1 as PortableTextChild, PortableTextEditable, type PortableTextEditableProps, PortableTextEditor, type PortableTextEditorProps, type PortableTextMemberSchemaTypes, type PortableTextObject$1 as PortableTextObject, type PortableTextSpan$1 as PortableTextSpan, type PortableTextTextBlock$1 as PortableTextTextBlock, type RangeDecoration, type RangeDecorationOnMovedDetails, type ReadyChange, type RedoChange, type RenderAnnotationFunction, type RenderBlockFunction, type RenderChildFunction, type RenderDecoratorFunction, type RenderEditableFunction, type RenderListItemFunction, type RenderPlaceholderFunction, type RenderStyleFunction, type SchemaDefinition$1 as SchemaDefinition, type ScrollSelectionIntoViewFunction, type SelectionChange, type StyleDefinition, type StyleSchemaType, SyntheticBehaviorEvent, type UndoChange, type UnsetChange, type ValueChange, defaultKeyGenerator, defineBehavior, defineSchema, effect, execute, forward, raise, useEditor, useEditorSelector, usePortableTextEditor, usePortableTextEditorSelection };