@witchcraft/layout 0.0.7 → 0.1.1

package/README.md

@@ -42,38 +42,39 @@ export {}
 
 ```
 
-Or if using zod, you can do something like this. Note that you will need to create/extend `zLayoutWindow/Frame` or use `zLayoutWindow/FramePassthrough` to allow for extra properties. All zod types have been made `strict` where possible as it's easy to accidentally use the wrong type and loose properties silently otherwise. 
-
+Or if using zod, you can do something like this. Note that you will need to create/extend `zLayoutWindow/Frame` or use `zLayoutWindow/FrameLoose` to allow for extra properties. They also use a basic `z.uuid()`, if you need something more specific you'll have to extend the type.
 ```ts
-import { zLayoutFramePassthrough, layoutCreate } from "@witchcraft/layout"
+import { zLayoutFrameLoose, layoutCreate } from "@witchcraft/layout"
 import { z } from "zod"
 
 // we remove the id to set the discriminated union, then add it back,
 // otherwise this doesn't work
 export const zAppFrame = z.discriminatedUnion("type", [
-	zLayoutFramePassthrough.extend({
+	zLayoutFrameLoose.extend({
 		type: z.literal("contentA"),
 		content: z.object({
 			id: z.optional(z.uuid()),
 		}),
 	}),
-	zLayoutFramePassthrough.extend({
+	zLayoutFrameLoose.extend({
 		type: z.literal("contentB"),
 		content: z.object({
 			someOtherKey: z.optional(z.uuid()),
 		}),
 	}),
 ]).and(z.object({
-	id: z.uuid(),
+	id: z.uuidv4(), // here we can specify a specific uuid type
 }))
 
+
 declare module "@witchcraft/layout" {
 	interface Register {
-		//	Register the type
+		//	Register the type, this allows importing the type from the package, while also allowing the types to be extended
 		ExtendedLayoutFrame: z.infer<typeof zAppFrame>
 	}
 }
 ```
+Note that `zFrameId` and `zWinId` are different as they also support constants (`zFrameIdConstants` and `zWindowIdConstants`).
 
 ## Basics
 

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "@witchcraft/layout",
   "configKey": "witchcraftLayout",
-  "version": "0.0.7",
+  "version": "0.1.1",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "unknown"

package/dist/module.mjs

@@ -1,7 +1,7 @@
 import { defineNuxtModule, createResolver, addComponentsDir, addTemplate } from '@nuxt/kit';
 export * from '../dist/runtime/index.js';
 
-const module = defineNuxtModule({
+const module$1 = defineNuxtModule({
   meta: {
     name: "@witchcraft/layout",
     configKey: "witchcraftLayout"
@@ -23,4 +23,4 @@ const module = defineNuxtModule({
   }
 });
 
-export { module as default };
+export { module$1 as default };

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

@@ -127,7 +127,7 @@ export declare const zLayoutFrame: z.ZodObject<{
     x: z.ZodNumber;
     y: z.ZodNumber;
 }, z.core.$loose>;
-export declare const zLayoutFramePassthrough: z.ZodObject<{
+export declare const zLayoutFrameLoose: z.ZodObject<{
     id: z.ZodUUID;
     width: z.ZodNumber;
     height: z.ZodNumber;
@@ -167,8 +167,8 @@ export declare const zLayoutWindow: z.ZodObject<{
     pxHeight: z.ZodNumber;
     pxX: z.ZodNumber;
     pxY: z.ZodNumber;
-}, z.core.$strict>;
-export declare const zLayoutWindowPassthrough: z.ZodObject<{
+}, z.core.$strip>;
+export declare const zLayoutWindowLoose: z.ZodObject<{
     id: z.ZodUUID;
     activeFrame: z.ZodOptional<z.ZodString>;
     frames: z.ZodRecord<z.ZodString, z.ZodObject<{
@@ -182,7 +182,7 @@ export declare const zLayoutWindowPassthrough: z.ZodObject<{
     pxHeight: z.ZodNumber;
     pxX: z.ZodNumber;
     pxY: z.ZodNumber;
-}, z.core.$strip>;
+}, z.core.$loose>;
 export type BaseLayoutWindow = {
     id: WindowId;
     activeFrame?: string;
@@ -204,7 +204,7 @@ export declare const zWorkspace: z.ZodObject<{
         y: z.ZodNumber;
     }, z.core.$loose>>;
 }, z.core.$strict>;
-export declare const zWorkspacePassthrough: z.ZodObject<{
+export declare const zWorkspaceLoose: z.ZodObject<{
     activeFrame: z.ZodOptional<z.ZodString>;
     frames: z.ZodRecord<z.ZodString, z.ZodObject<{
         id: z.ZodUUID;
@@ -231,8 +231,8 @@ export declare const zLayout: z.ZodObject<{
         pxHeight: z.ZodNumber;
         pxX: z.ZodNumber;
         pxY: z.ZodNumber;
-    }, z.core.$strict>>;
-}, z.core.$strict>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
 export declare const zInitializedLayout: z.ZodObject<{
     activeWindow: z.ZodNonOptional<z.ZodOptional<z.ZodString>>;
     windows: z.ZodRecord<z.ZodString, z.ZodObject<{
@@ -249,8 +249,8 @@ export declare const zInitializedLayout: z.ZodObject<{
         pxHeight: z.ZodNumber;
         pxX: z.ZodNumber;
         pxY: z.ZodNumber;
-    }, z.core.$strict>>;
-}, z.core.$strict>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
 export type Layout = ExtendedLayout & {
     activeWindow?: string;
     windows: LayoutWindows;
@@ -381,9 +381,8 @@ export declare const LAYOUT_ERROR: {
     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 = {
+export type LayoutErrorInfo<T extends LayoutError> = LayoutErrorsInfo[T] extends undefined ? never : LayoutErrorsInfo[T];
+export type LayoutErrorsInfo = {
     [LAYOUT_ERROR.INVALID_ID]: {
         id: string | undefined;
     };
@@ -431,7 +430,7 @@ export declare const zWindowCreate: z.ZodObject<{
         x: z.ZodNumber;
         y: z.ZodNumber;
     }, z.core.$loose>>>;
-}, z.core.$strip>;
+}, z.core.$loose>;
 export declare const zLayoutCreate: z.ZodObject<{
     activeWindow: z.ZodOptional<z.ZodString>;
     windows: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
@@ -448,7 +447,7 @@ export declare const zLayoutCreate: z.ZodObject<{
         pxHeight: z.ZodNumber;
         pxX: z.ZodNumber;
         pxY: z.ZodNumber;
-    }, z.core.$strict>>>;
+    }, z.core.$strip>>>;
 }, z.core.$loose>;
 export declare const zFrameCreate: z.ZodObject<{
     id: z.ZodOptional<z.ZodUUID>;

package/dist/runtime/types/index.js

@@ -44,22 +44,22 @@ export const zBaseSquare = zSize.extend(zPos.shape);
 export const zLayoutFrame = z.looseObject({
   id: z.uuid()
 }).extend(zBaseSquare.shape);
-export const zLayoutFramePassthrough = zLayoutFrame.passthrough();
+export const zLayoutFrameLoose = zLayoutFrame.loose();
 const baseLayoutWindow = z.object({
   id: z.uuid(),
   activeFrame: z.string().optional(),
   frames: z.record(z.string(), zLayoutFrame)
 }).extend(zPxSize.shape).extend(zPxPos.shape);
-export const zLayoutWindow = baseLayoutWindow.strict();
-export const zLayoutWindowPassthrough = baseLayoutWindow;
+export const zLayoutWindow = baseLayoutWindow;
+export const zLayoutWindowLoose = baseLayoutWindow.loose();
 const baseWorkspace = zLayoutWindow.pick({ activeFrame: true, frames: true });
 export const zWorkspace = baseWorkspace.strict();
-export const zWorkspacePassthrough = zWorkspace.passthrough();
-const baseLayout = z.looseObject({
+export const zWorkspaceLoose = zWorkspace.loose();
+const baseLayout = z.object({
   activeWindow: z.string().optional(),
   windows: z.record(z.string(), zLayoutWindow)
 });
-export const zLayout = baseLayout.strict();
+export const zLayout = baseLayout;
 export const zInitializedLayout = zLayout.required({
   activeWindow: true
 }).refine((layout) => {
@@ -107,8 +107,8 @@ export const LAYOUT_ERROR = enumFromArray([
   "CANT_SPLIT_FRAME_TOO_SMALL",
   "CANT_CLOSE_WITHOUT_FORCE"
 ]);
-export const zWindowCreate = zLayoutWindowPassthrough.partial({ id: true, pxWidth: true, pxHeight: true, pxX: true, pxY: true }).extend({ frames: zLayoutWindow.shape.frames.optional() });
-export const zLayoutCreate = baseLayout.extend({
+export const zWindowCreate = zLayoutWindowLoose.partial({ id: true, pxWidth: true, pxHeight: true, pxX: true, pxY: true }).extend({ frames: zLayoutWindow.shape.frames.optional() });
+export const zLayoutCreate = baseLayout.loose().extend({
   windows: zLayout.shape.windows.optional()
 });
 export const zFrameCreate = zLayoutFrame.partial({

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

@@ -1,9 +1,9 @@
-import type { AllErrors, ErrorInfo } from "../types/index.js";
+import type { LayoutError, LayoutErrorInfo } 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 {
+export declare class KnownError<T extends LayoutError = LayoutError, TInfo extends LayoutErrorInfo<T> = LayoutErrorInfo<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.7",
+  "version": "0.1.1",
   "main": "./dist/runtime/index.js",
   "type": "module",
   "sideEffects": false,
@@ -34,7 +34,7 @@
   },
   "peerDependencies": {
     "@witchcraft/nuxt-utils": "^0.3.6",
-    "@witchcraft/ui": "^0.3.7"
+    "@witchcraft/ui": "^0.3.13"
   },
   "peerDependenciesMeta": {
     "@witchcraft/ui": {
@@ -61,7 +61,7 @@
     "@vitejs/plugin-vue": "^6.0.1",
     "@vitest/coverage-c8": "^0.33.0",
     "@witchcraft/nuxt-utils": "^0.3.6",
-    "@witchcraft/ui": "^0.3.7",
+    "@witchcraft/ui": "^0.3.13",
     "concurrently": "^9.2.1",
     "cross-env": "^10.0.0",
     "fast-glob": "^3.3.3",
@@ -69,7 +69,7 @@
     "husky": "^9.1.7",
     "indexit": "2.1.0-beta.3",
     "madge": "^8.0.0",
-    "nuxt": "^4.1.2",
+    "nuxt": "^4.2.1",
     "onchange": "^7.1.0",
     "semantic-release": "^24.2.8",
     "tailwindcss": "^4.1.12",

package/src/runtime/types/index.ts

@@ -113,7 +113,7 @@ export const zLayoutFrame = z.looseObject({
 	id: z.uuid()
 }).extend(zBaseSquare.shape)
 
-export const zLayoutFramePassthrough = zLayoutFrame.passthrough()
+export const zLayoutFrameLoose = zLayoutFrame.loose()
 
 export interface Register {
 }
@@ -135,8 +135,8 @@ const baseLayoutWindow = z.object({
 }).extend(zPxSize.shape)
 	.extend(zPxPos.shape)
 
-export const zLayoutWindow = baseLayoutWindow.strict()
-export const zLayoutWindowPassthrough = baseLayoutWindow
+export const zLayoutWindow = baseLayoutWindow
+export const zLayoutWindowLoose = baseLayoutWindow.loose()
 // types are re-declared so that if they are extended, the types are still correct
 
 export type BaseLayoutWindow = {
@@ -153,16 +153,16 @@ export type LayoutWindows = Record<string, LayoutWindow>
 
 const baseWorkspace = zLayoutWindow.pick({ activeFrame: true, frames: true })
 export const zWorkspace = baseWorkspace.strict()
-export const zWorkspacePassthrough = zWorkspace.passthrough()
+export const zWorkspaceLoose = zWorkspace.loose()
 
 export type Workspace = Pick<LayoutWindow, "activeFrame" | "frames"> & ExtendedWorkspace
 
-const baseLayout = z.looseObject({
+const baseLayout = z.object({
 	activeWindow: z.string().optional(),
 	windows: z.record(z.string(), zLayoutWindow)
 })
 
-export const zLayout = baseLayout.strict()
+export const zLayout = baseLayout
 
 export const zInitializedLayout = zLayout.required({
 	activeWindow: true
@@ -234,11 +234,9 @@ export const LAYOUT_ERROR = enumFromArray([
 
 export type LayoutError = EnumLike<typeof LAYOUT_ERROR>
 
-export type AllErrors = LayoutError
+export type LayoutErrorInfo<T extends LayoutError> = LayoutErrorsInfo[T] extends undefined ? never : LayoutErrorsInfo[T]
 
-export type ErrorInfo<T extends AllErrors> = AllErrorsInfo[T] extends undefined ? never : AllErrorsInfo[T]
-
-type AllErrorsInfo = {
+export type LayoutErrorsInfo = {
 	[LAYOUT_ERROR.INVALID_ID]: {
 		id: string | undefined
 	}
@@ -275,11 +273,11 @@ type AllErrorsInfo = {
 // todo rename to toOpposite
 export type HasOpposite = Direction | EdgeSide | ExtendedDirection | ExtendedEdgeSide | keyof Point | keyof Size
 
-export const zWindowCreate = zLayoutWindowPassthrough
+export const zWindowCreate = zLayoutWindowLoose
 	.partial({ id: true, pxWidth: true, pxHeight: true, pxX: true, pxY: true })
 	.extend({ frames: zLayoutWindow.shape.frames.optional() })
 
-export const zLayoutCreate = baseLayout
+export const zLayoutCreate = baseLayout.loose()
 	.extend({
 		windows: zLayout.shape.windows.optional()
 	})

package/src/runtime/utils/KnownError.ts

@@ -1,12 +1,12 @@
-import type { AllErrors, ErrorInfo } from "../types/index.js"
+import type { LayoutError, LayoutErrorInfo } 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 class KnownError<
-	T extends AllErrors = AllErrors,
-	TInfo extends ErrorInfo<T> = ErrorInfo<T>
+	T extends LayoutError = LayoutError,
+	TInfo extends LayoutErrorInfo<T> = LayoutErrorInfo<T>
 > extends Error {
 	code: T