ducjs 1.0.0

package/dist/legacy/v1/utils/constants.d.ts

@@ -0,0 +1,370 @@
+import { GridSettings, RawValue, SnapSettings } from "ducjs/legacy/v1/types";
+import { DucElement, DucEllipseElement, DucFreeDrawElement, DucTextElement, ElementBackground, ElementStroke, FontFamilyValues } from "ducjs/legacy/v1/types/elements";
+import { MAX_ZOOM, MIN_ZOOM } from "ducjs/legacy/v1/utils/scopes";
+export declare const COLOR_PALETTE: {
+    readonly transparent: "transparent";
+    readonly black: "#1e1e1e";
+    readonly white: "#ffffff";
+    readonly midGray: "#808080";
+    readonly night: "#0F0F0F";
+};
+export declare const TEXT_AUTOWRAP_THRESHOLD = 36;
+export declare const DRAGGING_THRESHOLD = 10;
+export declare const LINE_CONFIRM_THRESHOLD = 8;
+export declare const FIXED_BINDING_DISTANCE = 5;
+export declare const ELEMENT_SHIFT_TRANSLATE_AMOUNT = 5;
+export declare const ELEMENT_TRANSLATE_AMOUNT = 1;
+export declare const TEXT_TO_CENTER_SNAP_THRESHOLD = 30;
+export declare const SHIFT_LOCKING_ANGLE: number;
+export declare const DEFAULT_GRID_SIZE = 1;
+export declare const DEFAULT_GRID_STEP = 20;
+export declare const IMAGE_MIME_TYPES: {
+    readonly svg: "image/svg+xml";
+    readonly png: "image/png";
+    readonly jpg: "image/jpeg";
+    readonly gif: "image/gif";
+    readonly webp: "image/webp";
+    readonly bmp: "image/bmp";
+    readonly ico: "image/x-icon";
+    readonly avif: "image/avif";
+    readonly jfif: "image/jfif";
+};
+export declare const MIME_TYPES: {
+    readonly svg: "image/svg+xml";
+    readonly png: "image/png";
+    readonly jpg: "image/jpeg";
+    readonly gif: "image/gif";
+    readonly webp: "image/webp";
+    readonly bmp: "image/bmp";
+    readonly ico: "image/x-icon";
+    readonly avif: "image/avif";
+    readonly jfif: "image/jfif";
+    readonly json: "application/json";
+    readonly duc: "application/vnd.duc-cad";
+    readonly ducfig: "application/vnd.duc-config";
+    readonly excalidrawlib: "application/vnd.excalidrawlib+json";
+    readonly "excalidraw.svg": "image/svg+xml";
+    readonly "excalidraw.png": "image/png";
+    readonly binary: "application/octet-stream";
+};
+export declare const EXPORT_IMAGE_TYPES: {
+    readonly png: "png";
+    readonly svg: "svg";
+    readonly clipboard: "clipboard";
+};
+export declare const EXPORT_DATA_TYPES: {
+    readonly duc: "duc";
+    readonly json: "json";
+    readonly excalidrawClipboard: "excalidraw/clipboard";
+    readonly excalidrawLibrary: "excalidrawlib";
+    readonly excalidrawClipboardWithAPI: "excalidraw-api/clipboard";
+};
+export declare const VERSIONS: {
+    readonly excalidraw: 2;
+    readonly excalidrawLibrary: 2;
+};
+export declare const DEFAULT_ZOOM_STEP = 0.1;
+export declare const MIN_ZOOM_STEP = 1e-7;
+export declare const MAX_ZOOM_STEP = 5;
+export { MAX_ZOOM, MIN_ZOOM };
+export declare const BOUND_TEXT_PADDING = 5;
+export declare const ARROW_LABEL_WIDTH_FRACTION = 0.7;
+export declare const ARROW_LABEL_FONT_SIZE_TO_MIN_WIDTH_RATIO = 11;
+export declare const NO_PEER_POINTS: number[];
+export declare const ELEMENT_READY_TO_ERASE_OPACITY = 0.2;
+export declare const HIDE_FRAME_NAME_ZOOM_THRESHOLD = 0.18;
+export declare const DEFAULT_PROPORTIONAL_RADIUS = 0.25;
+export declare const DEFAULT_ADAPTIVE_RADIUS = 32;
+export declare const VERTICAL_ALIGN: {
+    readonly TOP: 10;
+    readonly MIDDLE: 11;
+    readonly BOTTOM: 12;
+};
+export declare const TEXT_ALIGN: {
+    readonly LEFT: 10;
+    readonly CENTER: 11;
+    readonly RIGHT: 12;
+};
+export declare const ROUGHNESS: {
+    readonly architect: 0;
+    readonly artist: 1;
+    readonly cartoonist: 2;
+};
+export declare const STROKE_PLACEMENT: {
+    readonly outside: 12;
+    readonly center: 11;
+    readonly inside: 10;
+};
+export declare const STROKE_WIDTH: {
+    readonly thin: 1;
+    readonly bold: 2;
+    readonly extraBold: 4;
+};
+export declare const ELEMENT_CONTENT_PREFERENCE: {
+    readonly hachure: 10;
+    readonly "cross-hatch": 11;
+    readonly solid: 12;
+    readonly zigzag: 13;
+    readonly fill: 14;
+    readonly fit: 15;
+    readonly tile: 16;
+    readonly stretch: 17;
+    readonly hatch: 18;
+};
+export declare const STROKE_PREFERENCE: {
+    readonly solid: 10;
+    readonly dashed: 11;
+    readonly dotted: 12;
+    readonly custom: 13;
+};
+export declare const STROKE_SIDE_PREFERENCE: {
+    readonly top: 10;
+    readonly bottom: 11;
+    readonly left: 12;
+    readonly right: 13;
+    readonly custom: 14;
+    readonly all: 15;
+};
+export declare const STROKE_CAP: {
+    readonly butt: 10;
+    readonly round: 11;
+    readonly square: 12;
+};
+export declare const STROKE_JOIN: {
+    readonly miter: 10;
+    readonly round: 11;
+    readonly bevel: 12;
+};
+export declare const LINE_HEAD: {
+    readonly arrow: 10;
+    readonly bar: 11;
+    readonly circle: 12;
+    readonly circle_outlined: 13;
+    readonly triangle: 14;
+    readonly triangle_outlined: 15;
+    readonly diamond: 16;
+    readonly diamond_outlined: 17;
+    readonly cross: 18;
+    readonly open_arrow: 19;
+    readonly reversed_arrow: 20;
+    readonly reversed_triangle: 21;
+    readonly reversed_triangle_outlined: 22;
+    readonly cone: 23;
+    readonly half_cone: 24;
+};
+export declare const BEZIER_MIRRORING: {
+    readonly NONE: 10;
+    readonly ANGLE: 11;
+    readonly ANGLE_LENGTH: 12;
+};
+export declare const HANDLE_TYPE: {
+    readonly HANDLE_IN: 10;
+    readonly HANDLE_OUT: 11;
+};
+export declare const ANTI_ALIASING: {
+    readonly NONE: 10;
+    readonly ANALYTIC: 11;
+    readonly MSAA_8: 8;
+    readonly MSAA_16: 16;
+};
+export declare const YOUTUBE_STATES: {
+    readonly UNSTARTED: -1;
+    readonly ENDED: 0;
+    readonly PLAYING: 1;
+    readonly PAUSED: 2;
+    readonly BUFFERING: 3;
+    readonly CUED: 5;
+};
+export declare const BLENDING: {
+    readonly MULTIPLY: 11;
+    readonly SCREEN: 12;
+    readonly OVERLAY: 13;
+    readonly DARKEN: 14;
+    readonly LIGHTEN: 15;
+    readonly DIFFERENCE: 16;
+    readonly EXCLUSION: 17;
+};
+export declare const ELEMENT_SUBSET: {
+    readonly AUX: 14;
+    readonly COTA: 15;
+};
+export declare const IMAGE_STATUS: {
+    readonly pending: "pending";
+    readonly saved: "saved";
+    readonly error: "error";
+};
+/**
+ * // TODO: shouldn't be really `const`, likely neither have integers as values, due to value for the custom fonts, which should likely be some hash.
+ *
+ * Let's think this through and consider:
+ * - https://developer.mozilla.org/en-US/docs/Web/CSS/generic-family
+ * - https://drafts.csswg.org/css-fonts-4/#font-family-prop
+ * - https://learn.microsoft.com/en-us/typography/opentype/spec/ibmfc
+ */
+export declare const FONT_FAMILY: {
+    Virgil: number;
+    Helvetica: number;
+    Cascadia: number;
+    Excalifont: number;
+    Nunito: number;
+    "Lilita One": number;
+    "Comic Shanns": number;
+    "Liberation Sans": number;
+    "Roboto Mono": number;
+};
+export declare const THEME: {
+    readonly LIGHT: "light";
+    readonly DARK: "dark";
+};
+export declare const WINDOWS_EMOJI_FALLBACK_FONT = "Segoe UI Emoji";
+export declare const DEFAULT_VERSION = "{version}";
+export declare const MIN_FONT_SIZE = 1;
+export declare const DEFAULT_FONT_SIZE = 20;
+export declare const DEFAULT_FONT_FAMILY: FontFamilyValues;
+export declare const DEFAULT_TEXT_ALIGN: DucTextElement["textAlign"];
+export declare const DEFAULT_VERTICAL_ALIGN: DucTextElement["verticalAlign"];
+export declare const DEFAULT_LINE_HEIGHT = 1;
+export declare const DEFAULT_POLYGON_SIDES = 5;
+export declare const LIBRARY_DISABLED_TYPES: Set<"iframe" | "embeddable" | "image">;
+/**
+ * not translated as this is used only in public, stateless API as default value
+ * where filename is optional and we can't retrieve name from app state
+ */
+export declare const DEFAULT_FILENAME = "Untitled";
+export declare const MIN_WIDTH_OR_HEIGHT = 1;
+export declare const EASINGS: readonly ["linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInSine", "easeOutSine", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo"];
+export type FreeDrawEasingNames = typeof EASINGS[number];
+export declare const FREEDRAW_EASINGS: Record<FreeDrawEasingNames, (t: number) => number>;
+export declare const DEFAULT_FRAME_STYLE: {
+    stroke: ElementStroke[];
+    background: ElementBackground[];
+    roundness: DucElement["roundness"];
+    radius: number;
+    nameOffsetY: number;
+    nameColorLightTheme: string;
+    nameColorDarkTheme: string;
+    nameFontSize: number;
+    nameLineHeight: number;
+};
+export declare const DEFAULT_ELEMENT_PROPS: {
+    isVisible: DucElement["isVisible"];
+    stroke: ElementStroke;
+    background: ElementBackground;
+    roundness: DucElement["roundness"];
+    opacity: DucElement["opacity"];
+    locked: DucElement["locked"];
+    scope: DucElement["scope"];
+    index: DucElement["index"];
+    width: DucElement["width"];
+    height: DucElement["height"];
+    angle: DucElement["angle"];
+    groupIds: DucElement["groupIds"];
+    boundElements: DucElement["boundElements"];
+    link: DucElement["link"];
+    frameId: DucElement["frameId"];
+    subset: DucElement["subset"];
+    noPlot: DucElement["noPlot"];
+    description: DucElement["description"];
+};
+export declare const DEFAULT_IFRAME_LIKE_NO_STYLE: {
+    stroke: ElementStroke[];
+    background: ElementBackground[];
+};
+export declare const DEFAULT_LINEAR_ELEMENT_STROKE: ElementStroke;
+export declare const DEFAULT_FREEDRAW_ELEMENT: {
+    size: RawValue;
+    thinning: DucFreeDrawElement["thinning"];
+    smoothing: DucFreeDrawElement["smoothing"];
+    streamline: DucFreeDrawElement["streamline"];
+    easing: DucFreeDrawElement["easing"];
+};
+export declare const DEFAULT_ELLIPSE_ELEMENT: {
+    ratio: DucEllipseElement["ratio"];
+    startAngle: DucEllipseElement["startAngle"];
+    endAngle: DucEllipseElement["endAngle"];
+    showAuxCrosshair: DucEllipseElement["showAuxCrosshair"];
+};
+/**
+ * Grid display types
+ */
+export declare const GRID_DISPLAY_TYPE: {
+    readonly LINES: 10;
+    readonly DOTS: 11;
+    readonly CROSSES: 12;
+    readonly ADAPTIVE: 13;
+};
+/**
+ * Grid coordinate system types
+ */
+export declare const GRID_TYPE: {
+    readonly RECTANGULAR: 10;
+    readonly ISOMETRIC: 11;
+    readonly POLAR: 12;
+    readonly TRIANGULAR: 13;
+    readonly CUSTOM: 14;
+};
+/**
+ * Default grid configurations
+ */
+export declare const DEFAULT_GRID_SETTINGS: GridSettings;
+/**
+ * Predefined grid configurations
+ */
+export declare const PREDEFINED_GRIDS: {
+    readonly ARCHITECTURAL_IMPERIAL: "arch-imperial";
+    readonly ARCHITECTURAL_METRIC: "arch-metric";
+    readonly ENGINEERING_IMPERIAL: "eng-imperial";
+    readonly ENGINEERING_METRIC: "eng-metric";
+    readonly ISOMETRIC_30: "iso-30";
+    readonly POLAR_DEGREES: "polar-deg";
+    readonly FINE_DETAIL: "fine-detail";
+};
+export declare const OBJECT_SNAP_MODE: {
+    readonly ENDPOINT: 10;
+    readonly MIDPOINT: 11;
+    readonly CENTER: 12;
+    readonly QUADRANT: 13;
+    readonly INTERSECTION: 14;
+    readonly EXTENSION: 15;
+    readonly PERPENDICULAR: 16;
+    readonly TANGENT: 17;
+    readonly NEAREST: 18;
+    readonly NODE: 19;
+    readonly INSERT: 20;
+    readonly PARALLEL: 21;
+    readonly APPARENT: 22;
+    readonly FROM: 23;
+    readonly POINT_FILTER: 24;
+    readonly TEMPORARY: 25;
+    readonly BETWEEN_TWO_POINTS: 26;
+    readonly POINT_ON_CURVE: 27;
+    readonly GEOMETRIC: 28;
+};
+/**
+ * Snap behavior modes
+ */
+export declare const SNAP_MODE: {
+    readonly RUNNING: 10;
+    readonly SINGLE: 11;
+};
+/**
+ * Snap override behaviors
+ */
+export declare const SNAP_OVERRIDE_BEHAVIOR: {
+    readonly DISABLE: 10;
+    readonly FORCE_GRID: 11;
+    readonly FORCE_OBJECT: 12;
+};
+/**
+ * Snap marker shapes
+ */
+export declare const SNAP_MARKER_SHAPE: {
+    readonly SQUARE: 10;
+    readonly CIRCLE: 11;
+    readonly TRIANGLE: 12;
+    readonly X: 13;
+};
+/**
+ * Default snap settings configuration
+ */
+export declare const DEFAULT_SNAP_SETTINGS: SnapSettings;