@witchcraft/layout 0.1.0 → 0.1.1

package/README.md

@@ -42,8 +42,7 @@ export {}
 
 ```
 
-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. 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 { zLayoutFrameLoose, layoutCreate } from "@witchcraft/layout"
 import { z } from "zod"
@@ -64,16 +63,18 @@ export const zAppFrame = z.discriminatedUnion("type", [
 		}),
 	}),
 ]).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.1.0",
+  "version": "0.1.1",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "unknown"

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

@@ -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;
     };

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.1.0",
+  "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",

package/src/runtime/types/index.ts

@@ -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
 	}

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