@sqlrooms/layout-config 0.19.0

package/LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright 2025 Ilya Boyandin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,59 @@
+A central configuration and type definitions package that maintains base layout configuration schemas and Zod schema definitions for SQLRooms. It provides TypeScript types and interfaces along with essential constants and utilities used for managing layouts.
+
+## Features
+
+- 📝 **Layout Configuration**: Define and manage room layout configuration schemas for Mosaic layouts
+- 🔍 **Type Safety**: Strong TypeScript typing for layout configuration objects
+- ✅ **Validation**: Zod schemas for runtime validation of layout configurations
+
+## Installation
+
+```bash
+npm install @sqlrooms/layout-config
+# or
+yarn add @sqlrooms/layout-config
+```
+
+## Basic Usage
+
+### Working with Mosaic Layout Configuration
+
+```tsx
+import {
+  MosaicLayoutConfig,
+  LayoutConfig,
+  MAIN_VIEW,
+} from '@sqlrooms/layout-config';
+
+// Create a new room configuration
+const layoutConfig: MosaicLayoutConfig = {
+  type: 'mosaic',
+  nodes: {
+    direction: 'row',
+    first: MAIN_VIEW,
+    second: {
+      direction: 'column',
+      first: 'files',
+      second: 'tables',
+    },
+  },
+};
+
+// This can be part of a bigger room configuration
+interface RoomConfig {
+  // ... other properties
+  layout: LayoutConfig;
+}
+```
+
+## Advanced Features
+
+- **Schema Extensions**: Extend base schemas for custom room types
+- **Configuration Validation**: Validate configurations at runtime
+- **Serialization**: Convert configurations to/from JSON for storage
+
+For more information, visit the SQLRooms documentation.
+
+```
+
+```

package/dist/LayoutConfig.d.ts

@@ -0,0 +1,64 @@
+import { z } from 'zod';
+/** Main view room panel key */
+export declare const MAIN_VIEW = "main";
+export declare const LayoutTypes: z.ZodEnum<["mosaic"]>;
+export type LayoutTypes = z.infer<typeof MosaicLayoutDirection>;
+export declare const DEFAULT_MOSAIC_LAYOUT: MosaicLayoutConfig;
+export declare const MosaicLayoutDirection: z.ZodEnum<["row", "column"]>;
+export type MosaicLayoutDirection = z.infer<typeof MosaicLayoutDirection>;
+declare const BaseMosaicLayoutParent: z.ZodObject<{
+    direction: z.ZodEnum<["row", "column"]>;
+    splitPercentage: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    direction: "row" | "column";
+    splitPercentage?: number | undefined;
+}, {
+    direction: "row" | "column";
+    splitPercentage?: number | undefined;
+}>;
+export declare const MosaicLayoutParent: z.ZodType<MosaicLayoutParent>;
+export type MosaicLayoutParent = z.infer<typeof BaseMosaicLayoutParent> & {
+    first: MosaicLayoutNode;
+    second: MosaicLayoutNode;
+};
+export declare function isMosaicLayoutParent(node: MosaicLayoutNode | null | undefined): node is MosaicLayoutParent;
+export declare const MosaicLayoutNodeKey: z.ZodString;
+export type MosaicLayoutNodeKey = z.infer<typeof MosaicLayoutNodeKey>;
+export type MosaicLayoutNode = z.infer<typeof MosaicLayoutNode>;
+export declare const MosaicLayoutNode: z.ZodUnion<[z.ZodString, z.ZodType<MosaicLayoutParent, z.ZodTypeDef, MosaicLayoutParent>]>;
+export declare const MosaicLayoutConfig: z.ZodObject<{
+    type: z.ZodLiteral<"mosaic">;
+    nodes: z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodType<MosaicLayoutParent, z.ZodTypeDef, MosaicLayoutParent>]>>;
+    pinned: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    fixed: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+}, "strip", z.ZodTypeAny, {
+    type: "mosaic";
+    nodes: string | MosaicLayoutParent | null;
+    pinned?: string[] | undefined;
+    fixed?: string[] | undefined;
+}, {
+    type: "mosaic";
+    nodes: string | MosaicLayoutParent | null;
+    pinned?: string[] | undefined;
+    fixed?: string[] | undefined;
+}>;
+export type MosaicLayoutConfig = z.infer<typeof MosaicLayoutConfig>;
+export declare const LayoutConfig: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+    type: z.ZodLiteral<"mosaic">;
+    nodes: z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodType<MosaicLayoutParent, z.ZodTypeDef, MosaicLayoutParent>]>>;
+    pinned: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    fixed: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+}, "strip", z.ZodTypeAny, {
+    type: "mosaic";
+    nodes: string | MosaicLayoutParent | null;
+    pinned?: string[] | undefined;
+    fixed?: string[] | undefined;
+}, {
+    type: "mosaic";
+    nodes: string | MosaicLayoutParent | null;
+    pinned?: string[] | undefined;
+    fixed?: string[] | undefined;
+}>]>;
+export type LayoutConfig = z.infer<typeof LayoutConfig>;
+export {};
+//# sourceMappingURL=LayoutConfig.d.ts.map

package/dist/LayoutConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LayoutConfig.d.ts","sourceRoot":"","sources":["../src/LayoutConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,CAAC,EAAC,MAAM,KAAK,CAAC;AAEtB,+BAA+B;AAC/B,eAAO,MAAM,SAAS,SAAS,CAAC;AAEhC,eAAO,MAAM,WAAW,uBAAqB,CAAC;AAC9C,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEhE,eAAO,MAAM,qBAAqB,EAAE,kBAGnC,CAAC;AAEF,eAAO,MAAM,qBAAqB,8BAA4B,CAAC;AAC/D,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAE1E,QAAA,MAAM,sBAAsB;;;;;;;;;EAG1B,CAAC;AAGH,eAAO,MAAM,kBAAkB,EAAE,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAIzD,CAAC;AACL,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,GAAG;IACxE,KAAK,EAAE,gBAAgB,CAAC;IACxB,MAAM,EAAE,gBAAgB,CAAC;CAC1B,CAAC;AAEF,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,gBAAgB,GAAG,IAAI,GAAG,SAAS,GACxC,IAAI,IAAI,kBAAkB,CAE5B;AAED,eAAO,MAAM,mBAAmB,aAAa,CAAC;AAC9C,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEtE,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAChE,eAAO,MAAM,gBAAgB,4FAG3B,CAAC;AAEH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;EAK7B,CAAC;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAEpE,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;IAAqD,CAAC;AAC/E,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC"}

package/dist/LayoutConfig.js

@@ -0,0 +1,34 @@
+import { z } from 'zod';
+/** Main view room panel key */
+export const MAIN_VIEW = 'main';
+export const LayoutTypes = z.enum(['mosaic']);
+export const DEFAULT_MOSAIC_LAYOUT = {
+    type: LayoutTypes.enum.mosaic,
+    nodes: MAIN_VIEW,
+};
+export const MosaicLayoutDirection = z.enum(['row', 'column']);
+const BaseMosaicLayoutParent = z.object({
+    direction: MosaicLayoutDirection,
+    splitPercentage: z.number().optional(),
+});
+// See https://zod.dev/?id=recursive-types
+export const MosaicLayoutParent = BaseMosaicLayoutParent.extend({
+    first: z.lazy(() => MosaicLayoutNode),
+    second: z.lazy(() => MosaicLayoutNode),
+});
+export function isMosaicLayoutParent(node) {
+    return typeof node !== 'string';
+}
+export const MosaicLayoutNodeKey = z.string();
+export const MosaicLayoutNode = z.union([
+    MosaicLayoutNodeKey,
+    MosaicLayoutParent,
+]);
+export const MosaicLayoutConfig = z.object({
+    type: z.literal(LayoutTypes.enum.mosaic),
+    nodes: MosaicLayoutNode.nullable(),
+    pinned: z.array(MosaicLayoutNodeKey).optional(),
+    fixed: z.array(MosaicLayoutNodeKey).optional(),
+});
+export const LayoutConfig = z.discriminatedUnion('type', [MosaicLayoutConfig]);
+//# sourceMappingURL=LayoutConfig.js.map

package/dist/LayoutConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LayoutConfig.js","sourceRoot":"","sources":["../src/LayoutConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,CAAC,EAAC,MAAM,KAAK,CAAC;AAEtB,+BAA+B;AAC/B,MAAM,CAAC,MAAM,SAAS,GAAG,MAAM,CAAC;AAEhC,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;AAG9C,MAAM,CAAC,MAAM,qBAAqB,GAAuB;IACvD,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC,MAAM;IAC7B,KAAK,EAAE,SAAS;CACjB,CAAC;AAEF,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC;AAG/D,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,SAAS,EAAE,qBAAqB;IAChC,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACvC,CAAC,CAAC;AAEH,0CAA0C;AAC1C,MAAM,CAAC,MAAM,kBAAkB,GAC7B,sBAAsB,CAAC,MAAM,CAAC;IAC5B,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,gBAAgB,CAAC;IACrC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,gBAAgB,CAAC;CACvC,CAAC,CAAC;AAML,MAAM,UAAU,oBAAoB,CAClC,IAAyC;IAEzC,OAAO,OAAO,IAAI,KAAK,QAAQ,CAAC;AAClC,CAAC;AAED,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC;AAI9C,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC;IACtC,mBAAmB;IACnB,kBAAkB;CACnB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC;IACxC,KAAK,EAAE,gBAAgB,CAAC,QAAQ,EAAE;IAClC,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC,QAAQ,EAAE;IAC/C,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC,QAAQ,EAAE;CAC/C,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAC,kBAAkB,CAAC,CAAC,CAAC","sourcesContent":["import {z} from 'zod';\n\n/** Main view room panel key */\nexport const MAIN_VIEW = 'main';\n\nexport const LayoutTypes = z.enum(['mosaic']);\nexport type LayoutTypes = z.infer<typeof MosaicLayoutDirection>;\n\nexport const DEFAULT_MOSAIC_LAYOUT: MosaicLayoutConfig = {\n  type: LayoutTypes.enum.mosaic,\n  nodes: MAIN_VIEW,\n};\n\nexport const MosaicLayoutDirection = z.enum(['row', 'column']);\nexport type MosaicLayoutDirection = z.infer<typeof MosaicLayoutDirection>;\n\nconst BaseMosaicLayoutParent = z.object({\n  direction: MosaicLayoutDirection,\n  splitPercentage: z.number().optional(),\n});\n\n// See https://zod.dev/?id=recursive-types\nexport const MosaicLayoutParent: z.ZodType<MosaicLayoutParent> =\n  BaseMosaicLayoutParent.extend({\n    first: z.lazy(() => MosaicLayoutNode),\n    second: z.lazy(() => MosaicLayoutNode),\n  });\nexport type MosaicLayoutParent = z.infer<typeof BaseMosaicLayoutParent> & {\n  first: MosaicLayoutNode;\n  second: MosaicLayoutNode;\n};\n\nexport function isMosaicLayoutParent(\n  node: MosaicLayoutNode | null | undefined,\n): node is MosaicLayoutParent {\n  return typeof node !== 'string';\n}\n\nexport const MosaicLayoutNodeKey = z.string();\nexport type MosaicLayoutNodeKey = z.infer<typeof MosaicLayoutNodeKey>;\n\nexport type MosaicLayoutNode = z.infer<typeof MosaicLayoutNode>;\nexport const MosaicLayoutNode = z.union([\n  MosaicLayoutNodeKey,\n  MosaicLayoutParent,\n]);\n\nexport const MosaicLayoutConfig = z.object({\n  type: z.literal(LayoutTypes.enum.mosaic),\n  nodes: MosaicLayoutNode.nullable(),\n  pinned: z.array(MosaicLayoutNodeKey).optional(),\n  fixed: z.array(MosaicLayoutNodeKey).optional(),\n});\nexport type MosaicLayoutConfig = z.infer<typeof MosaicLayoutConfig>;\n\nexport const LayoutConfig = z.discriminatedUnion('type', [MosaicLayoutConfig]);\nexport type LayoutConfig = z.infer<typeof LayoutConfig>;\n"]}

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * {@include ../README.md}
+ * @packageDocumentation
+ */
+export * from './LayoutConfig';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,gBAAgB,CAAC"}

package/dist/index.js

@@ -0,0 +1,6 @@
+/**
+ * {@include ../README.md}
+ * @packageDocumentation
+ */
+export * from './LayoutConfig';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,gBAAgB,CAAC","sourcesContent":["/**\n * {@include ../README.md}\n * @packageDocumentation\n */\n\nexport * from './LayoutConfig';\n"]}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@sqlrooms/layout-config",
+  "version": "0.19.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "module": "dist/index.js",
+  "type": "module",
+  "author": "Ilya Boyandin <ilya@boyandin.me>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sqlrooms/sqlrooms.git"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "zod": "^3.25.57"
+  },
+  "scripts": {
+    "dev": "tsc -w",
+    "build": "tsc",
+    "lint": "eslint .",
+    "typecheck": "tsc --noEmit",
+    "typedoc": "typedoc"
+  },
+  "gitHead": "ba6000f1e06d3ab01e309d805b5d187b32c9ff06"
+}