vue-block-editor-headless 0.0.0-stage → 4.5.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020-present Jimmy Chen
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,69 @@
-# Temporary Holding Version
+# vue-block-editor-headless
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[![Apache-2.0 licensed][badge-license]][url-license]
+[![NPM version][badge-npm-version]][url-npm]
+[![NPM downloads][badge-npm-downloads]][url-npm]
+[![NPM Unpacked Size (with version)][badge-npm-unpacked-size]][url-npm]
+
+This package is a headless Vue block editor with no styling or DOM. It edits a typed node tree over a registry, with commands that edit it as JSON Patch operations, and its `useEditSession` composable holds one document's edit state for a Vue component.
+
+Design notes live in [the specs](https://github.com/Esposter/Esposter/tree/main/openspec/specs/vue-block-editor-headless).
+
+## Table of Contents
+
+- 🚀 [Getting Started](#getting-started)
+- 🧩 [Key Exports](#key-exports)
+- 📝 [Usage](#usage)
+- ⚖️ [License](#license)
+
+---
+
+## <a name="getting-started">🚀 Getting Started</a>
+
+```bash
+pnpm i vue-block-editor-headless zod
+```
+
+## <a name="key-exports">🧩 Key Exports</a>
+
+| Export                      | Kind       | Purpose                                                                                                                                    |
+| :-------------------------- | :--------- | :----------------------------------------------------------------------------------------------------------------------------------------- |
+| `applyBlockEdit`            | function   | Applies an edit's operations and parses the result with the document's schema, refusing the whole edit if either fails                     |
+| `BlockChildren`             | type       | A consumer's children port, switched on a node's type so a slot the type lacks fails the typecheck                                         |
+| `BlockDocument`             | interface  | A document: its content and its root's props, with a third type parameter naming the node type the root accepts (default: every node type) |
+| `BlockRegistry`             | interface  | One definition per block type, and the root's definition                                                                                   |
+| `BlockTypeDefinition`       | interface  | One block type's props schema, and the child types each of its slots allows                                                                |
+| `createBlockDocumentSchema` | function   | The document's schema: content the root accepts, props, ids unique across every slot, and a node limit                                     |
+| `getBlockLayerRows`         | function   | Every node in document order, with its depth and pointer                                                                                   |
+| `insertBlockNode`           | function   | Adds a node at an index of a slot, or no operations when the slot does not accept its type                                                 |
+| `moveBlockNode`             | function   | Moves a node to an index of another slot as a remove and an add, or no operations when refused                                             |
+| `NO_BLOCK_SLOTS`            | constant   | The slots of a node that holds none, the record a children port returns for it                                                             |
+| `removeBlockNode`           | function   | Removes the node a pointer names, with its subtree                                                                                         |
+| `renderBlockNodes`          | function   | Renders each node once its slots have rendered, skipping a node whose type the registry lacks                                              |
+| `updateBlockNodeProps`      | function   | One JSON Patch add per prop, replacing a prop the node already has                                                                         |
+| `useEditSession`            | composable | An editing session over one document: a commit sets the document and its undo history together, and a load clears the history              |
+
+## <a name="usage">📝 Usage</a>
+
+```ts
+import { applyBlockEdit, insertBlockNode } from "vue-block-editor-headless";
+
+// The registry, children port and document schema are the consumer's own, the schema made by createBlockDocumentSchema
+const operations = insertBlockNode(document, registry, children, "/content/0/props/children", 1, {
+  props: { id: crypto.randomUUID(), text: "" },
+  type: "heading",
+});
+// A neverthrow Result: its document is the schema's typed output, and its inverses undo the edit
+const edit = applyBlockEdit(documentSchema, document, operations);
+```
+
+## <a name="license">⚖️ License</a>
+
+Licensed under [Apache-2.0][url-license].
+
+[badge-license]: https://img.shields.io/github/license/Esposter/Esposter.svg?color=blue
+[url-license]: https://github.com/Esposter/Esposter/blob/main/LICENSE
+[badge-npm-version]: https://img.shields.io/npm/v/vue-block-editor-headless/latest?color=brightgreen
+[url-npm]: https://www.npmjs.com/package/vue-block-editor-headless/v/latest
+[badge-npm-unpacked-size]: https://img.shields.io/npm/unpacked-size/vue-block-editor-headless/latest?label=npm
+[badge-npm-downloads]: https://img.shields.io/npm/dm/vue-block-editor-headless.svg

package/dist/index.d.ts

@@ -0,0 +1,383 @@
+import { ApplyPatchesResult, History, ItemEntityType, JsonPatchOperation } from "@esposter/shared";
+import { Ref, ShallowRef, WritableComputedRef } from "vue";
+import { z } from "zod";
+import { Result } from "neverthrow";
+export interface EditSession<TDocument, TEntry> {
+  commit: (newDocument: TDocument, newHistory: History<TEntry>) => void;
+  history: ShallowRef<History<TEntry>>;
+  load: (newDocument: TDocument) => void;
+  selectedPointer: WritableComputedRef<string>;
+}
+export interface EditSessionSelection<TDocument> {
+  getIdByPointer: (document: TDocument, nodePointer: string) => string;
+  getPointerById: (document: TDocument, id: string) => string;
+}
+export declare const useEditSession: <TDocument, TEntry>(document: Ref<TDocument>, historyLimit: number, selection?: EditSessionSelection<TDocument>) => EditSession<TDocument, TEntry>;
+export interface ArrowBinding {
+  connectionPointIndex: number;
+  elementId: string;
+}
+export declare const arrowBindingSchema: z.ZodObject<{
+  connectionPointIndex: z.ZodNumber;
+  elementId: z.ZodUUID;
+}>;
+export interface Point {
+  x: number;
+  y: number;
+}
+export declare const pointSchema: z.ZodObject<{
+  x: z.ZodNumber;
+  y: z.ZodNumber;
+}>;
+export interface ArrowEnd {
+  binding?: ArrowBinding;
+  hasArrowhead: boolean;
+  point: Point;
+}
+export declare const arrowEndSchema: z.ZodObject<{
+  binding: z.ZodOptional<typeof arrowBindingSchema>;
+  hasArrowhead: z.ZodBoolean;
+  point: typeof pointSchema;
+}>;
+export declare enum ArrowPathKind {
+  Curved = "curved",
+  RightAngled = "rightAngled",
+  Straight = "straight"
+}
+export declare const arrowPathKindSchema: z.ZodEnum<typeof ArrowPathKind>;
+export declare enum PositionedElementType {
+  Arrow = "arrow",
+  Image = "image",
+  Shape = "shape",
+  StickyNote = "stickyNote",
+  Stroke = "stroke",
+  Text = "text"
+}
+export interface ArrowElement extends ItemEntityType<PositionedElementType.Arrow> {
+  end: ArrowEnd;
+  id: string;
+  label: string;
+  pathKind: ArrowPathKind;
+  start: ArrowEnd;
+}
+export declare const arrowElementSchema: z.ZodObject<{
+  end: typeof arrowEndSchema;
+  id: z.ZodUUID;
+  label: z.ZodString;
+  pathKind: typeof arrowPathKindSchema;
+  start: typeof arrowEndSchema;
+  type: z.ZodLiteral<PositionedElementType.Arrow>;
+}>;
+export declare enum ArrowEndKey {
+  End = "end",
+  Start = "start"
+}
+export interface BlockNodeProps {
+  id: string;
+}
+export interface BlockNode<TType extends string = string, TProps extends BlockNodeProps = BlockNodeProps> {
+  props: TProps;
+  type: TType;
+}
+export type SlotKeys<TProps extends BlockNodeProps> = { [K in keyof TProps]: TProps[K] extends BlockNode[] ? K : never; }[keyof TProps];
+export type BlockSlots<TNode extends BlockNode, TChild extends BlockNode = TNode> = TNode extends BlockNode ? { [TSlot in SlotKeys<TNode["props"]>]: readonly TChild[]; } : never;
+export type BlockChildren<TNode extends BlockNode> = (node: TNode) => BlockSlots<TNode>;
+export interface BlockCollection {
+  count: number;
+  ids: Set<string>;
+}
+export type BlockRootProps = object;
+export interface BlockDocument<TNode extends BlockNode = BlockNode, TRootProps extends BlockRootProps = BlockRootProps, TRootNode extends TNode = TNode> {
+  content: TRootNode[];
+  root: {
+    props: TRootProps;
+  };
+}
+export interface BlockDocumentInput {
+  content: unknown[];
+  root: {
+    props: unknown;
+  };
+}
+export interface BlockLayerRow {
+  depth: number;
+  nodePointer: string;
+  type: string;
+}
+export interface BlockRootDefinition<TProps extends BlockRootProps = BlockRootProps, TType extends string = string> {
+  content: TType[];
+  propsSchema: z.ZodType<TProps>;
+}
+export type NodeTypeOf<TList> = TList extends BlockNode[] ? TList[number]["type"] : never;
+export type OwnProps<TProps extends BlockNodeProps> = { [K in keyof TProps as K extends "id" | SlotKeys<TProps> ? never : K]: TProps[K]; };
+export interface BlockTypeDefinition<TNode extends BlockNode = BlockNode> {
+  propsSchema: z.ZodType<OwnProps<TNode["props"]>>;
+  slots: { [K in SlotKeys<TNode["props"]>]: NodeTypeOf<TNode["props"][K]>[]; };
+  type: TNode["type"];
+}
+export interface BlockRegistry<TNode extends BlockNode = BlockNode, TRootProps extends BlockRootProps = BlockRootProps, TDefinition extends BlockTypeDefinition<TNode> = BlockTypeDefinition<TNode>> {
+  root: BlockRootDefinition<TRootProps, TNode["type"]>;
+  types: TDefinition[];
+}
+export type BlockSlotName<TNode extends BlockNode> = Extract<TNode extends BlockNode ? SlotKeys<TNode["props"]> : never, string>;
+export interface Bounds {
+  height: number;
+  width: number;
+  x: number;
+  y: number;
+}
+export interface BoxElement {
+  height: number;
+  id: string;
+  width: number;
+  x: number;
+  y: number;
+}
+export declare const boxElementSchema: z.ZodObject<{
+  height: z.ZodNumber;
+  id: z.ZodUUID;
+  width: z.ZodNumber;
+  x: z.ZodNumber;
+  y: z.ZodNumber;
+}>;
+export declare enum TextAnchor {
+  Middle = "middle",
+  Start = "start"
+}
+export interface TextLayout {
+  baselineY: number;
+  lines: {
+    dy: number;
+    text: string;
+  }[];
+}
+export interface TextPlacement {
+  point: Point;
+  textAnchor: TextAnchor;
+  width: number;
+}
+export interface ImageElement extends BoxElement, ItemEntityType<PositionedElementType.Image> {
+  fileId: string;
+}
+export declare const imageElementSchema: z.ZodObject<typeof boxElementSchema.shape & {
+  fileId: z.ZodCustomStringFormat<"sha256_hex">;
+  type: z.ZodLiteral<PositionedElementType.Image>;
+}>;
+export declare enum ShapeKind {
+  Annotation = "annotation",
+  Decision = "decision",
+  Diamond = "diamond",
+  Ellipse = "ellipse",
+  InputOutput = "inputOutput",
+  PredefinedProcess = "predefinedProcess",
+  Process = "process",
+  Rectangle = "rectangle",
+  Terminal = "terminal"
+}
+export declare const shapeKindSchema: z.ZodEnum<typeof ShapeKind>;
+export interface ShapeElement extends BoxElement, ItemEntityType<PositionedElementType.Shape> {
+  fill: string;
+  kind: ShapeKind;
+  text: string;
+}
+export declare const shapeElementSchema: z.ZodObject<typeof boxElementSchema.shape & {
+  fill: z.ZodString;
+  kind: typeof shapeKindSchema;
+  text: z.ZodString;
+  type: z.ZodLiteral<PositionedElementType.Shape>;
+}>;
+export interface StickyNoteElement extends BoxElement, ItemEntityType<PositionedElementType.StickyNote> {
+  fill: string;
+  text: string;
+}
+export declare const stickyNoteElementSchema: z.ZodObject<typeof boxElementSchema.shape & {
+  fill: z.ZodString;
+  text: z.ZodString;
+  type: z.ZodLiteral<PositionedElementType.StickyNote>;
+}>;
+export interface StrokeElement extends ItemEntityType<PositionedElementType.Stroke> {
+  id: string;
+  points: Point[];
+  strokeWidth: number;
+}
+export declare const strokeElementSchema: z.ZodObject<{
+  id: z.ZodUUID;
+  points: z.ZodArray<typeof pointSchema>;
+  strokeWidth: z.ZodNumber;
+  type: z.ZodLiteral<PositionedElementType.Stroke>;
+}>;
+export interface TextElement extends ItemEntityType<PositionedElementType.Text> {
+  id: string;
+  text: string;
+  width: number;
+  x: number;
+  y: number;
+}
+export declare const textElementSchema: z.ZodObject<{
+  id: z.ZodUUID;
+  text: z.ZodString;
+  type: z.ZodLiteral<PositionedElementType.Text>;
+  width: z.ZodNumber;
+  x: z.ZodNumber;
+  y: z.ZodNumber;
+}>;
+export type PositionedElement = ArrowElement | ImageElement | ShapeElement | StickyNoteElement | StrokeElement | TextElement;
+export declare const positionedElementSchema: z.ZodDiscriminatedUnion<[typeof arrowElementSchema, typeof imageElementSchema, typeof shapeElementSchema, typeof stickyNoteElementSchema, typeof strokeElementSchema, typeof textElementSchema]>;
+export interface PositionedDocument {
+  elements: PositionedElement[];
+}
+export declare const positionedDocumentSchema: z.ZodType<PositionedDocument>;
+export type PositionedElementProperty = {
+  end: ArrowEndKey;
+  property: "hasArrowhead";
+  value: boolean;
+} | {
+  property: "fill";
+  value: string;
+} | {
+  property: "pathKind";
+  value: ArrowPathKind;
+};
+export interface Size {
+  height: number;
+  width: number;
+}
+export declare const applyBlockEdit: <TDocument>(schema: z.ZodType<TDocument>, document: TDocument, operations: JsonPatchOperation[]) => Result<ApplyPatchesResult<TDocument>, Error>;
+export declare const bindPositionedArrowEnd: (document: PositionedDocument, index: number, arrowEndKey: ArrowEndKey, binding: ArrowBinding) => JsonPatchOperation[];
+export declare const changePositionedElementZOrder: (document: PositionedDocument, fromIndex: number, toIndex: number) => JsonPatchOperation[];
+export declare const checkAcceptedType: (context: z.RefinementCtx, type: string, acceptedTypes: readonly string[], path: PropertyKey[]) => void;
+export declare const checkBlockNodeIds: <TNode extends BlockNode>(context: z.RefinementCtx, registry: BlockRegistry<TNode>, children: BlockChildren<TNode>, nodes: readonly TNode[], segments: PropertyKey[], collection: BlockCollection) => void;
+export declare const checkIsBoundOnlyTo: (arrow: ArrowElement, elementId: string) => boolean;
+export declare const checkIsPointInBounds: (bounds: Bounds, point: Point, tolerance: number) => boolean;
+export declare const checkIsPointInPolygon: (polygon: Point[], point: Point) => boolean;
+export declare const checkIsPointInShape: (shape: ShapeElement, point: Point, tolerance: number) => boolean;
+export declare const checkIsPointOnElement: (element: PositionedElement, point: Point, tolerance: number) => boolean;
+export declare const checkIsResizablePositionedElement: (element: PositionedElement) => boolean;
+export declare const checkIsSamePoint: (point: Point, otherPoint: Point) => boolean;
+export declare const checkIsVertical: (direction: Point | undefined) => boolean;
+export declare const checkPositionedBindings: (context: z.RefinementCtx, elements: PositionedElement[]) => void;
+export declare const checkPositionedDocument: (document: PositionedDocument, context: z.RefinementCtx) => void;
+export declare const checkPositionedElementIds: (context: z.RefinementCtx, elements: PositionedElement[]) => void;
+export declare const CONNECTION_POINT_COUNT = 4;
+export declare const ARROW_STUB_LENGTH = 16;
+export declare const GRID_SIZE = 20;
+export declare const ARROW_LABEL_WIDTH = 120;
+export declare const ARROW_CURVE_SEGMENT_COUNT = 16;
+export declare const ELLIPSE_OUTLINE_SEGMENT_COUNT = 32;
+export declare const INPUT_OUTPUT_SLANT_RATIO = .2;
+export declare const HEX_COLOR_REGEX: RegExp;
+export declare const NO_BLOCK_SLOTS: Readonly<Record<string, readonly never[]>>;
+export declare const createAcceptedTypesError: (acceptedTypes: readonly string[]) => {
+  error: (issue: z.core.$ZodRawIssue) => string | undefined;
+};
+export declare const createBlockDocumentSchema: <TNode extends BlockNode, TRootProps extends BlockRootProps, TRootNode extends TNode = TNode>(contentSchema: z.ZodType<TRootNode>, registry: BlockRegistry<TNode, TRootProps>, children: BlockChildren<TNode>, maxNodes: number) => z.ZodType<BlockDocument<TNode, TRootProps, TRootNode>, BlockDocumentInput>;
+export declare const createBlockNodesSchema: <TNode extends BlockNode>(nodeSchema: z.ZodType<TNode>, registry: BlockRegistry<TNode>, children: BlockChildren<TNode>, acceptedTypes: readonly string[]) => z.ZodType<TNode[]>;
+export declare const deletePositionedElement: (document: PositionedDocument, index: number) => JsonPatchOperation[];
+export declare const duplicateBlockNode: <TNode extends BlockNode>(document: BlockDocument<TNode>, registry: BlockRegistry<TNode>, children: BlockChildren<TNode>, nodeSchema: z.ZodType<TNode>, nodePointer: string) => JsonPatchOperation[];
+export declare const EXPORT_PADDING = 16;
+export declare const EXPORT_BACKGROUND_COLOR = "#ffffff";
+export declare const EXPORT_LINE_COLOR = "#1e1e1e";
+export declare const EXPORT_LINE_WIDTH = 2;
+export declare const EXPORT_LINE_ATTRIBUTES: string;
+export declare const SKETCH_OFFSET_LIMIT = 1.5;
+export declare const SKETCH_HASH_MODULUS = 2147483647;
+export declare const TEXT_FONT_FAMILY = "sans-serif";
+export declare const TEXT_FONT_SIZE = 16;
+export declare const TEXT_LINE_HEIGHT = 20;
+export declare const TEXT_CHARACTER_WIDTH: number;
+export declare const TEXT_WIDE_CHARACTER_WIDTH: number;
+export declare const TEXT_WIDE_CHARACTER_REGEX: RegExp;
+export declare const ARROWHEAD_LENGTH = 12;
+export declare const ARROWHEAD_HALF_WIDTH = 5;
+export declare const escapeSvgValue: (value: string) => string;
+export declare const getArrowheadPoints: (tip: Point, previous: Point) => Point[];
+export declare const getArrowheads: (arrow: ArrowElement, route: Point[]) => Point[][];
+export declare const getExportBounds: (positionedDocument: PositionedDocument) => Bounds;
+export declare const getRouteMidpoint: (route: Point[]) => Point;
+export declare const getSketchedPoints: (points: Point[], elementId: string) => Point[];
+export declare const getSketchOffset: (key: string) => number;
+export declare const getTextLayout: (text: string, { point, textAnchor, width }: TextPlacement) => TextLayout;
+export declare const getTextPlacement: (element: PositionedElement) => TextPlacement | undefined;
+export declare const getTextWidth: (text: string) => number;
+export declare const getWrappedLines: (text: string, width: number) => string[];
+export declare const toArrowSvg: (arrow: ArrowElement) => string;
+export declare const toClosedSketchedPathData: (points: Point[], elementId: string) => string;
+export declare const toElementTextSvg: (element: PositionedElement) => string;
+export declare const toImageSvg: ({ fileId, height, width, x, y }: ImageElement, getAssetUrl: (fileId: string) => string) => string;
+export declare const toPathData: (points: Point[]) => string;
+export declare const toPolygonPoints: (points: Point[]) => string;
+export declare const toPositionedElementSvg: (element: PositionedElement, getAssetUrl: (fileId: string) => string) => string;
+export declare const toPositionedSvg: (positionedDocument: PositionedDocument, getAssetUrl: (fileId: string) => string) => string;
+export declare const toShapeSvg: (shape: ShapeElement) => string;
+export declare const toSketchedPathData: (points: Point[], elementId: string) => string;
+export declare const toStickyNoteSvg: (stickyNote: StickyNoteElement) => string;
+export declare const toStrokeSvg: ({ points, strokeWidth }: StrokeElement) => string;
+export declare const toTextSvg: (text: string, placement: TextPlacement) => string;
+export declare const wrapParagraph: (paragraph: string, width: number) => string[];
+export declare const getAcceptedTypes: <TNode extends BlockNode>(document: BlockDocument<TNode>, registry: BlockRegistry<TNode>, children: BlockChildren<TNode>, slotPointer: string) => readonly string[];
+export declare const getAcceptedTypesMessage: (acceptedTypes: readonly string[]) => string;
+export declare const getAcceptingSlotPointers: <TNode extends BlockNode>(document: BlockDocument<TNode>, registry: BlockRegistry<TNode>, children: BlockChildren<TNode>, nodePointer: string) => string[];
+export declare const getAdjacentBlockNodePointer: <TNode extends BlockNode>(document: BlockDocument<TNode>, children: BlockChildren<TNode>, nodePointer: string, offset: number) => string | undefined;
+export declare const getArrowEndDirection: (arrowEnd: ArrowEnd) => Point | undefined;
+export declare const getArrowRoute: (arrow: ArrowElement) => Point[];
+export declare const getBezierPoint: (controlPoints: Point[], progress: number) => Point;
+export declare const getBindableShape: (elements: PositionedElement[], binding: ArrowBinding) => ShapeElement | undefined;
+export declare const getBlockLayerRows: <TNode extends BlockNode>(document: BlockDocument<TNode>, children: BlockChildren<TNode>) => BlockLayerRow[];
+export declare const getBlockNode: <TNode extends BlockNode>(document: BlockDocument<TNode>, nodePointer: string, children: BlockChildren<TNode>) => TNode | undefined;
+export declare const getBlockNodeAt: <TNode extends BlockNode>(nodes: readonly TNode[], segments: string[], children: BlockChildren<TNode>) => TNode | undefined;
+export declare const getBlockPropPointer: (nodePointer: string, key: string) => string;
+export declare const getBlockPropValue: (props: BlockNodeProps, key: string) => unknown;
+export declare const getBlockSlots: <TNode extends BlockNode>(children: BlockChildren<TNode>, node: TNode) => Readonly<Record<string, readonly TNode[]>>;
+export declare const getBlockTypeDefinition: <TDefinition extends {
+  type: string;
+}>(registry: {
+  types: TDefinition[];
+}, type: string) => TDefinition | undefined;
+export declare const getBoundsCorners: ({ height, width, x, y }: Bounds) => Point[];
+export declare const getChildRows: <TNode extends BlockNode>(children: BlockChildren<TNode>, nodes: readonly TNode[], listPointer: string, depth: number) => BlockLayerRow[];
+export declare const getConnectionPoint: (bounds: Bounds, connectionPointIndex: number) => Point;
+export declare const getConnectionPointDirection: (connectionPointIndex: number) => Point | undefined;
+export declare const getCurveControl: (point: Point, direction: Point | undefined, span: Point) => Point;
+export declare const getCurvedRoute: (start: ArrowEnd, end: ArrowEnd) => Point[];
+export declare const getDistanceToPolyline: (points: Point[], point: Point) => number;
+export declare const getDistanceToSegment: (start: Point, end: Point, point: Point) => number;
+export declare const getEdgeMidpoints: (bounds: Bounds) => Point[];
+export declare const getElementBounds: (element: PositionedElement) => Bounds;
+export declare const getElementPointer: (index: number) => string;
+export declare const getEllipseOutline: (bounds: Bounds) => Point[];
+export declare const getFocusAfterRemoval: <TNode extends BlockNode>(document: BlockDocument<TNode>, children: BlockChildren<TNode>, nodePointer: string) => string;
+export declare const getHitElementIndex: (document: PositionedDocument, point: Point, tolerance: number) => number | undefined;
+export declare const getPointsBounds: (points: Point[]) => Bounds;
+export declare const getPositionedElement: (document: PositionedDocument, index: number) => PositionedElement | undefined;
+export declare const getPositionedElementText: (element: PositionedElement) => string | undefined;
+export declare const getPositionOperations: (pointer: string, point: Point) => JsonPatchOperation[];
+export declare const getRerouteOperations: (elements: PositionedElement[], shape: ShapeElement) => JsonPatchOperation[];
+export declare const getRightAngledMiddlePoints: (startStub: Point, endStub: Point, isStartVertical: boolean, isEndVertical: boolean) => Point[];
+export declare const getRightAngledRoute: (start: ArrowEnd, end: ArrowEnd) => Point[];
+export declare const getRootAcceptedTypes: <TNode extends BlockNode>(registry: BlockRegistry<TNode>) => TNode["type"][];
+export declare const getShapeOutline: (shape: ShapeElement) => Point[];
+export declare const getSiblingMoveOperations: <TNode extends BlockNode>(document: BlockDocument<TNode>, registry: BlockRegistry<TNode>, children: BlockChildren<TNode>, nodePointer: string, offset: number) => JsonPatchOperation[];
+export declare const getSlotItems: <TItem>(slots: Readonly<Record<string, readonly TItem[]>>, slot: string) => readonly TItem[];
+export declare const getSlotPointer: <TNode extends BlockNode>(nodePointer: string, slot: BlockSlotName<TNode>) => string;
+export declare const getSlotPointerAfterRemoval: (nodePointer: string, slotPointer: string) => string;
+export declare const getStubPoint: (point: Point, direction: Point | undefined) => Point;
+export declare const insertBlockNode: <TNode extends BlockNode>(document: BlockDocument<TNode>, registry: BlockRegistry<TNode>, children: BlockChildren<TNode>, slotPointer: string, index: number, node: TNode) => JsonPatchOperation[];
+export declare const insertPositionedElement: (document: PositionedDocument, index: number, element: PositionedElement) => JsonPatchOperation[];
+export declare const moveBlockNode: <TNode extends BlockNode>(document: BlockDocument<TNode>, registry: BlockRegistry<TNode>, children: BlockChildren<TNode>, nodePointer: string, slotPointer: string, index: number) => JsonPatchOperation[];
+export declare const moveIntoPreviousSibling: <TNode extends BlockNode>(document: BlockDocument<TNode>, registry: BlockRegistry<TNode>, children: BlockChildren<TNode>, nodePointer: string) => JsonPatchOperation[];
+export declare const moveOutAfterParent: <TNode extends BlockNode>(document: BlockDocument<TNode>, registry: BlockRegistry<TNode>, children: BlockChildren<TNode>, nodePointer: string) => JsonPatchOperation[];
+export declare const movePositionedElement: (document: PositionedDocument, index: number, point: Point) => JsonPatchOperation[];
+export declare const pasteBlockNodes: <TNode extends BlockNode>(document: BlockDocument<TNode>, registry: BlockRegistry<TNode>, children: BlockChildren<TNode>, nodeSchema: z.ZodType<TNode>, nodes: TNode[], slotPointer: string, index: number) => JsonPatchOperation[];
+export declare const remintBlockNode: <TNode extends BlockNode>(children: BlockChildren<TNode>, node: TNode) => BlockNode;
+export declare const removeBlockNode: (nodePointer: string) => JsonPatchOperation[];
+export declare const removeRepeatedPoints: (points: Point[]) => Point[];
+export declare const renderBlockNodes: <TNode extends BlockNode, TDefinition extends BlockTypeDefinition, TOutput>(nodes: readonly TNode[], registry: {
+  types: TDefinition[];
+}, children: BlockChildren<TNode>, render: (node: TNode, definition: TDefinition, slots: Record<string, TOutput[]>) => TOutput) => TOutput[];
+export declare const resizePositionedElement: (document: PositionedDocument, index: number, size: Size, position?: Point) => JsonPatchOperation[];
+export declare const resizePositionedElementBounds: (document: PositionedDocument, index: number, bounds: Bounds) => JsonPatchOperation[];
+export declare const snapToGrid: (value: number, gridSize: number) => number;
+export declare const unbindPositionedArrowEnd: (document: PositionedDocument, index: number, arrowEndKey: ArrowEndKey) => JsonPatchOperation[];
+export declare const updateBlockNodeProps: <TProps extends BlockNodeProps>(nodePointer: string, props: Partial<TProps>) => JsonPatchOperation[];
+export declare const updatePositionedElementProperty: (document: PositionedDocument, index: number, change: PositionedElementProperty) => JsonPatchOperation[];
+export declare const updatePositionedElementText: (document: PositionedDocument, index: number, text: string) => JsonPatchOperation[];