@witchcraft/layout 0.0.5 → 0.0.7

package/dist/runtime/types/index.d.ts

@@ -0,0 +1,459 @@
+import type { EnumLike } from "@alanscodelog/utils";
+import { z } from "zod";
+export * from "../drag/types.js";
+export declare const zUuid: z.ZodUUID;
+export type AnyUuid = z.infer<typeof zUuid>;
+export declare const zWindowIdConstants: z.ZodEnum<{
+    ACTIVE: "ACTIVE";
+}>;
+export declare const zWinId: z.ZodUnion<[z.ZodUUID, z.ZodEnum<{
+    ACTIVE: "ACTIVE";
+}>]>;
+export type WindowId = z.infer<typeof zWinId>;
+export declare const zFrameIdConstants: z.ZodEnum<{
+    ACTIVE: "ACTIVE";
+}>;
+export declare const zFrameId: z.ZodUnion<[z.ZodUUID, z.ZodEnum<{
+    ACTIVE: "ACTIVE";
+}>]>;
+export type FrameId = z.infer<typeof zFrameId>;
+export declare const zScaledIntPercentage: z.ZodNumber;
+export declare const zPos: z.ZodObject<{
+    x: z.ZodNumber;
+    y: z.ZodNumber;
+}, z.core.$strip>;
+export type Pos = z.infer<typeof zPos>;
+export declare const zSize: z.ZodObject<{
+    width: z.ZodNumber;
+    height: z.ZodNumber;
+}, z.core.$strip>;
+export type Size = z.infer<typeof zSize>;
+export declare const zPoint: z.ZodObject<{
+    x: z.ZodNumber;
+    y: z.ZodNumber;
+}, z.core.$strip>;
+export type Point = z.infer<typeof zPoint>;
+export declare const zPxPos: z.ZodObject<{
+    pxX: z.ZodNumber;
+    pxY: z.ZodNumber;
+}, z.core.$strip>;
+export type PxPos = z.infer<typeof zPxPos>;
+export declare const zPxSize: z.ZodObject<{
+    pxWidth: z.ZodNumber;
+    pxHeight: z.ZodNumber;
+}, z.core.$strip>;
+export type PxSize = z.infer<typeof zPxSize>;
+export declare const zEdge: z.ZodObject<{
+    startX: z.ZodNumber;
+    startY: z.ZodNumber;
+    endX: z.ZodNumber;
+    endY: z.ZodNumber;
+}, z.core.$strip>;
+export type Edge = z.infer<typeof zEdge>;
+export declare const zDirection: z.ZodEnum<{
+    up: "up";
+    down: "down";
+    left: "left";
+    right: "right";
+}>;
+export declare const zExtendedDirection: z.ZodUnion<readonly [z.ZodEnum<{
+    up: "up";
+    down: "down";
+    left: "left";
+    right: "right";
+}>, z.ZodEnum<{
+    horizontal: "horizontal";
+    vertical: "vertical";
+}>]>;
+export declare const zSide: z.ZodEnum<{
+    left: "left";
+    right: "right";
+    top: "top";
+    bottom: "bottom";
+}>;
+export declare const zOrientation: z.ZodEnum<{
+    horizontal: "horizontal";
+    vertical: "vertical";
+}>;
+export declare const zExtendedSide: z.ZodUnion<readonly [z.ZodEnum<{
+    left: "left";
+    right: "right";
+    top: "top";
+    bottom: "bottom";
+}>, z.ZodEnum<{
+    horizontal: "horizontal";
+    vertical: "vertical";
+}>]>;
+export type Direction = z.infer<typeof zDirection>;
+export type ExtendedDirection = z.infer<typeof zExtendedDirection>;
+export type Orientation = z.infer<typeof zOrientation>;
+export type EdgeSide = z.infer<typeof zSide>;
+export type ExtendedEdgeSide = z.infer<typeof zExtendedSide>;
+export declare const zBaseSquare: z.ZodObject<{
+    width: z.ZodNumber;
+    height: z.ZodNumber;
+    x: z.ZodNumber;
+    y: z.ZodNumber;
+}, z.core.$strip>;
+export type BaseSquare = z.infer<typeof zBaseSquare>;
+export type BaseSquareCss = {
+    x: string;
+    y: string;
+    width: string;
+    height: string;
+    translate?: string;
+};
+export type EdgeCss = BaseSquareCss & {
+    translate: string;
+};
+export type PointCss = BaseSquareCss & {
+    translate: string;
+};
+export type Intersections = Record<number, Record<number, number>>;
+export type IntersectionEntry = {
+    point: Point;
+    count: number;
+    sharesEdge: boolean;
+    sharedEdges: {
+        horizontal: Edge[];
+        vertical: Edge[];
+    };
+    isWindowEdge: boolean;
+};
+export declare const zLayoutFrame: z.ZodObject<{
+    id: z.ZodUUID;
+    width: z.ZodNumber;
+    height: z.ZodNumber;
+    x: z.ZodNumber;
+    y: z.ZodNumber;
+}, z.core.$loose>;
+export declare const zLayoutFramePassthrough: z.ZodObject<{
+    id: z.ZodUUID;
+    width: z.ZodNumber;
+    height: z.ZodNumber;
+    x: z.ZodNumber;
+    y: z.ZodNumber;
+}, z.core.$loose>;
+export interface Register {
+}
+export type ExtendedLayoutFrame = Register extends {
+    ExtendedLayoutFrame: infer T;
+} ? T : unknown;
+export type ExtendedLayoutWindow = Register extends {
+    ExtendedLayoutWindow: infer T;
+} ? T : unknown;
+export type ExtendedLayout = Register extends {
+    ExtendedLayout: infer T;
+} ? T : unknown;
+export type ExtendedWorkspace = Register extends {
+    ExtendedWorkspace: infer T;
+} ? T : unknown;
+export type BaseLayoutFrame = Size & Pos & {
+    id: FrameId;
+};
+export type LayoutFrame = ExtendedLayoutFrame & BaseLayoutFrame;
+export type LayoutFrames = Record<string, LayoutFrame>;
+export declare const zLayoutWindow: z.ZodObject<{
+    id: z.ZodUUID;
+    activeFrame: z.ZodOptional<z.ZodString>;
+    frames: z.ZodRecord<z.ZodString, z.ZodObject<{
+        id: z.ZodUUID;
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+    }, z.core.$loose>>;
+    pxWidth: z.ZodNumber;
+    pxHeight: z.ZodNumber;
+    pxX: z.ZodNumber;
+    pxY: z.ZodNumber;
+}, z.core.$strict>;
+export declare const zLayoutWindowPassthrough: z.ZodObject<{
+    id: z.ZodUUID;
+    activeFrame: z.ZodOptional<z.ZodString>;
+    frames: z.ZodRecord<z.ZodString, z.ZodObject<{
+        id: z.ZodUUID;
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+    }, z.core.$loose>>;
+    pxWidth: z.ZodNumber;
+    pxHeight: z.ZodNumber;
+    pxX: z.ZodNumber;
+    pxY: z.ZodNumber;
+}, z.core.$strip>;
+export type BaseLayoutWindow = {
+    id: WindowId;
+    activeFrame?: string;
+    frames: LayoutFrames;
+    pxWidth: number;
+    pxHeight: number;
+    pxX: number;
+    pxY: number;
+};
+export type LayoutWindow = ExtendedLayoutWindow & BaseLayoutWindow;
+export type LayoutWindows = Record<string, LayoutWindow>;
+export declare const zWorkspace: z.ZodObject<{
+    activeFrame: z.ZodOptional<z.ZodString>;
+    frames: z.ZodRecord<z.ZodString, z.ZodObject<{
+        id: z.ZodUUID;
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+    }, z.core.$loose>>;
+}, z.core.$strict>;
+export declare const zWorkspacePassthrough: z.ZodObject<{
+    activeFrame: z.ZodOptional<z.ZodString>;
+    frames: z.ZodRecord<z.ZodString, z.ZodObject<{
+        id: z.ZodUUID;
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+    }, z.core.$loose>>;
+}, z.core.$loose>;
+export type Workspace = Pick<LayoutWindow, "activeFrame" | "frames"> & ExtendedWorkspace;
+export declare const zLayout: z.ZodObject<{
+    activeWindow: z.ZodOptional<z.ZodString>;
+    windows: z.ZodRecord<z.ZodString, z.ZodObject<{
+        id: z.ZodUUID;
+        activeFrame: z.ZodOptional<z.ZodString>;
+        frames: z.ZodRecord<z.ZodString, z.ZodObject<{
+            id: z.ZodUUID;
+            width: z.ZodNumber;
+            height: z.ZodNumber;
+            x: z.ZodNumber;
+            y: z.ZodNumber;
+        }, z.core.$loose>>;
+        pxWidth: z.ZodNumber;
+        pxHeight: z.ZodNumber;
+        pxX: z.ZodNumber;
+        pxY: z.ZodNumber;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export declare const zInitializedLayout: z.ZodObject<{
+    activeWindow: z.ZodNonOptional<z.ZodOptional<z.ZodString>>;
+    windows: z.ZodRecord<z.ZodString, z.ZodObject<{
+        id: z.ZodUUID;
+        activeFrame: z.ZodOptional<z.ZodString>;
+        frames: z.ZodRecord<z.ZodString, z.ZodObject<{
+            id: z.ZodUUID;
+            width: z.ZodNumber;
+            height: z.ZodNumber;
+            x: z.ZodNumber;
+            y: z.ZodNumber;
+        }, z.core.$loose>>;
+        pxWidth: z.ZodNumber;
+        pxHeight: z.ZodNumber;
+        pxX: z.ZodNumber;
+        pxY: z.ZodNumber;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type Layout = ExtendedLayout & {
+    activeWindow?: string;
+    windows: LayoutWindows;
+};
+export declare const zSplitDecoShapes: z.ZodObject<{
+    edge: z.ZodObject<{
+        startX: z.ZodNumber;
+        startY: z.ZodNumber;
+        endX: z.ZodNumber;
+        endY: z.ZodNumber;
+    }, z.core.$strip>;
+    newFrame: z.ZodObject<{
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+    }, z.core.$strip>;
+}, z.core.$strict>;
+export type SplitDecoShapes = z.infer<typeof zSplitDecoShapes>;
+export declare const zSplitDeco: z.ZodObject<{
+    id: z.ZodUUID;
+    type: z.ZodLiteral<"split">;
+    position: z.ZodNumber;
+    direction: z.ZodEnum<{
+        up: "up";
+        down: "down";
+        left: "left";
+        right: "right";
+    }>;
+    shapes: z.ZodObject<{
+        edge: z.ZodObject<{
+            startX: z.ZodNumber;
+            startY: z.ZodNumber;
+            endX: z.ZodNumber;
+            endY: z.ZodNumber;
+        }, z.core.$strip>;
+        newFrame: z.ZodObject<{
+            width: z.ZodNumber;
+            height: z.ZodNumber;
+            x: z.ZodNumber;
+            y: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strict>;
+}, z.core.$strict>;
+export declare const zRawSplitDeco: z.ZodObject<{
+    type: z.ZodLiteral<"split">;
+    id: z.ZodUUID;
+    position: z.ZodNumber;
+    direction: z.ZodEnum<{
+        up: "up";
+        down: "down";
+        left: "left";
+        right: "right";
+    }>;
+}, z.core.$strict>;
+export type RawSplitDeco = z.infer<typeof zRawSplitDeco>;
+export type SplitDeco = z.infer<typeof zSplitDeco>;
+declare const zCloseDeco: z.ZodObject<{
+    id: z.ZodUUID;
+    type: z.ZodLiteral<"close">;
+    force: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>;
+export type CloseDeco = z.infer<typeof zCloseDeco>;
+declare const zDropDeco: z.ZodObject<{
+    id: z.ZodUUID;
+    type: z.ZodLiteral<"drop">;
+    position: z.ZodUnion<[z.ZodEnum<{
+        left: "left";
+        right: "right";
+        top: "top";
+        bottom: "bottom";
+    }>, z.ZodEnum<{
+        center: "center";
+    }>]>;
+}, z.core.$strict>;
+export type DropDeco = z.infer<typeof zDropDeco>;
+export declare const zDeco: z.ZodUnion<readonly [z.ZodObject<{
+    id: z.ZodUUID;
+    type: z.ZodLiteral<"split">;
+    position: z.ZodNumber;
+    direction: z.ZodEnum<{
+        up: "up";
+        down: "down";
+        left: "left";
+        right: "right";
+    }>;
+    shapes: z.ZodObject<{
+        edge: z.ZodObject<{
+            startX: z.ZodNumber;
+            startY: z.ZodNumber;
+            endX: z.ZodNumber;
+            endY: z.ZodNumber;
+        }, z.core.$strip>;
+        newFrame: z.ZodObject<{
+            width: z.ZodNumber;
+            height: z.ZodNumber;
+            x: z.ZodNumber;
+            y: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strict>;
+}, z.core.$strict>, z.ZodObject<{
+    id: z.ZodUUID;
+    type: z.ZodLiteral<"close">;
+    force: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>, z.ZodObject<{
+    id: z.ZodUUID;
+    type: z.ZodLiteral<"drop">;
+    position: z.ZodUnion<[z.ZodEnum<{
+        left: "left";
+        right: "right";
+        top: "top";
+        bottom: "bottom";
+    }>, z.ZodEnum<{
+        center: "center";
+    }>]>;
+}, z.core.$strict>]>;
+export type Deco = z.infer<typeof zDeco>;
+export declare const LAYOUT_ERROR: {
+    INVALID_ID: "INVALID_ID";
+    ID_ALREADY_EXISTS: "ID_ALREADY_EXISTS";
+    CANT_RESIZE: "CANT_RESIZE";
+    NO_ACTIVE_WINDOW: "NO_ACTIVE_WINDOW";
+    NO_ACTIVE_FRAME: "NO_ACTIVE_FRAME";
+    CANT_CLOSE_NO_DRAG_EDGE: "CANT_CLOSE_NO_DRAG_EDGE";
+    CANT_CLOSE_NEARBY_FRAMES_TOO_SMALL: "CANT_CLOSE_NEARBY_FRAMES_TOO_SMALL";
+    CANT_CLOSE_SINGLE_FRAME: "CANT_CLOSE_SINGLE_FRAME";
+    CANT_SPLIT_FRAME_TOO_SMALL: "CANT_SPLIT_FRAME_TOO_SMALL";
+    CANT_CLOSE_WITHOUT_FORCE: "CANT_CLOSE_WITHOUT_FORCE";
+};
+export type LayoutError = EnumLike<typeof LAYOUT_ERROR>;
+export type AllErrors = LayoutError;
+export type ErrorInfo<T extends AllErrors> = AllErrorsInfo[T] extends undefined ? never : AllErrorsInfo[T];
+type AllErrorsInfo = {
+    [LAYOUT_ERROR.INVALID_ID]: {
+        id: string | undefined;
+    };
+    [LAYOUT_ERROR.ID_ALREADY_EXISTS]: {
+        id: string | undefined;
+    };
+    [LAYOUT_ERROR.CANT_RESIZE]: {
+        size: Size;
+    };
+    [LAYOUT_ERROR.NO_ACTIVE_WINDOW]: Record<string, never>;
+    [LAYOUT_ERROR.NO_ACTIVE_FRAME]: Record<string, never>;
+    [LAYOUT_ERROR.CANT_CLOSE_NO_DRAG_EDGE]: {
+        frame: LayoutFrame;
+    };
+    [LAYOUT_ERROR.CANT_CLOSE_NEARBY_FRAMES_TOO_SMALL]: {
+        frame: LayoutFrame;
+        nearbyFrames: LayoutFrame[];
+        minSize: Size;
+    };
+    [LAYOUT_ERROR.CANT_CLOSE_SINGLE_FRAME]: {
+        frame: LayoutFrame;
+    };
+    [LAYOUT_ERROR.CANT_SPLIT_FRAME_TOO_SMALL]: {
+        frame: LayoutFrame;
+        newSize: number;
+        minSize: number;
+    };
+    [LAYOUT_ERROR.CANT_CLOSE_WITHOUT_FORCE]: {
+        frame: LayoutFrame;
+        framesRequiredToBeDeleted: LayoutFrame[];
+    };
+};
+export type HasOpposite = Direction | EdgeSide | ExtendedDirection | ExtendedEdgeSide | keyof Point | keyof Size;
+export declare const zWindowCreate: z.ZodObject<{
+    id: z.ZodOptional<z.ZodUUID>;
+    activeFrame: z.ZodOptional<z.ZodString>;
+    pxWidth: z.ZodOptional<z.ZodNumber>;
+    pxHeight: z.ZodOptional<z.ZodNumber>;
+    pxX: z.ZodOptional<z.ZodNumber>;
+    pxY: z.ZodOptional<z.ZodNumber>;
+    frames: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        id: z.ZodUUID;
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+    }, z.core.$loose>>>;
+}, z.core.$strip>;
+export declare const zLayoutCreate: z.ZodObject<{
+    activeWindow: z.ZodOptional<z.ZodString>;
+    windows: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        id: z.ZodUUID;
+        activeFrame: z.ZodOptional<z.ZodString>;
+        frames: z.ZodRecord<z.ZodString, z.ZodObject<{
+            id: z.ZodUUID;
+            width: z.ZodNumber;
+            height: z.ZodNumber;
+            x: z.ZodNumber;
+            y: z.ZodNumber;
+        }, z.core.$loose>>;
+        pxWidth: z.ZodNumber;
+        pxHeight: z.ZodNumber;
+        pxX: z.ZodNumber;
+        pxY: z.ZodNumber;
+    }, z.core.$strict>>>;
+}, z.core.$loose>;
+export declare const zFrameCreate: z.ZodObject<{
+    id: z.ZodOptional<z.ZodUUID>;
+    width: z.ZodOptional<z.ZodNumber>;
+    height: z.ZodOptional<z.ZodNumber>;
+    x: z.ZodOptional<z.ZodNumber>;
+    y: z.ZodOptional<z.ZodNumber>;
+}, z.core.$loose>;

package/dist/runtime/utils/KnownError.d.ts

@@ -0,0 +1,10 @@
+import type { AllErrors, ErrorInfo } from "../types/index.js";
+/**
+ * Creates a known error that extends the base Error with some extra information.
+ * All the variables used to create the error message are stored in it's info property so we can easily re-craft error messages for users.
+ */
+export declare class KnownError<T extends AllErrors = AllErrors, TInfo extends ErrorInfo<T> = ErrorInfo<T>> extends Error {
+    code: T;
+    info: TInfo;
+    constructor(code: T, str: string, info: TInfo);
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@witchcraft/layout",
   "description": "Headless layout manager.",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "main": "./dist/runtime/index.js",
   "type": "module",
   "sideEffects": false,

package/src/runtime/demo/tailwind.css

@@ -1,4 +1,4 @@
-@import "tailwindcss" source("../");
+@import "tailwindcss";
 
 @import "../../../playground/.nuxt/witchcraft-ui.css";
 @import "../../../playground/.nuxt/witchcraft-layout.css";

package/src/runtime/layout/getFrameSplitInfo.ts

@@ -18,7 +18,10 @@ export function getFrameSplitInfo(
 	dragPointOrPosition: Point | number | "midpoint" = "midpoint",
 	minSize: Size = getMarginSize(),
 	snapAmount: Point = getSnapPoint()
-) {
+): {
+	splitFrame: LayoutFrame
+	newFrame: LayoutFrame
+} | KnownError<typeof LAYOUT_ERROR.CANT_SPLIT_FRAME_TOO_SMALL> {
 	frame = cloneFrame(frame)
 	let newFrame = { ...frame }
 	const isHorz = dir === "left" || dir === "right"