@sqlrooms/sql-editor-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,47 @@
+A central configuration and type definitions package that maintains base SQL editor configuration schemas and Zod schema definitions for SQLRooms. It provides TypeScript types and interfaces along with essential constants and utilities used for managing SQL editor state.
+
+## Features
+
+- 📝 **SQL Editor Configuration**: Define and manage room SQL editor configuration schemas.
+- 🔍 **Type Safety**: Strong TypeScript typing for SQL editor configuration objects.
+- ✅ **Validation**: Zod schemas for runtime validation of SQL editor configurations.
+
+## Installation
+
+```bash
+npm install @sqlrooms/sql-editor-config
+# or
+yarn add @sqlrooms/sql-editor-config
+```
+
+## Basic Usage
+
+### Working with SQL Editor Configuration
+
+```tsx
+import {
+  SqlEditorSliceConfig,
+  createDefaultSqlEditorConfig,
+} from '@sqlrooms/sql-editor-config';
+
+// Create a new SQL editor configuration
+const sqlEditorConfig: SqlEditorSliceConfig = createDefaultSqlEditorConfig();
+
+// This can be part of a bigger room configuration
+interface RoomConfig {
+  // ... other properties
+  sqlEditor: SqlEditorSliceConfig['sqlEditor'];
+}
+```
+
+## 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/SqlEditorSliceConfig.d.ts

@@ -0,0 +1,59 @@
+import { z } from 'zod';
+export declare const SqlEditorSliceConfig: z.ZodObject<{
+    sqlEditor: z.ZodObject<{
+        queries: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            name: z.ZodString;
+            query: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+            name: string;
+            query: string;
+        }, {
+            id: string;
+            name: string;
+            query: string;
+        }>, "many">;
+        selectedQueryId: z.ZodDefault<z.ZodString>;
+        lastExecutedQuery: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        queries: {
+            id: string;
+            name: string;
+            query: string;
+        }[];
+        selectedQueryId: string;
+        lastExecutedQuery?: string | undefined;
+    }, {
+        queries: {
+            id: string;
+            name: string;
+            query: string;
+        }[];
+        selectedQueryId?: string | undefined;
+        lastExecutedQuery?: string | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    sqlEditor: {
+        queries: {
+            id: string;
+            name: string;
+            query: string;
+        }[];
+        selectedQueryId: string;
+        lastExecutedQuery?: string | undefined;
+    };
+}, {
+    sqlEditor: {
+        queries: {
+            id: string;
+            name: string;
+            query: string;
+        }[];
+        selectedQueryId?: string | undefined;
+        lastExecutedQuery?: string | undefined;
+    };
+}>;
+export type SqlEditorSliceConfig = z.infer<typeof SqlEditorSliceConfig>;
+export declare function createDefaultSqlEditorConfig(): SqlEditorSliceConfig;
+//# sourceMappingURL=SqlEditorSliceConfig.d.ts.map

package/dist/SqlEditorSliceConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SqlEditorSliceConfig.d.ts","sourceRoot":"","sources":["../src/SqlEditorSliceConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,CAAC,EAAC,MAAM,KAAK,CAAC;AAGtB,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAe/B,CAAC;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAExE,wBAAgB,4BAA4B,IAAI,oBAAoB,CAOnE"}

package/dist/SqlEditorSliceConfig.js

@@ -0,0 +1,25 @@
+import { z } from 'zod';
+// Saved state (persisted)
+export const SqlEditorSliceConfig = z.object({
+    sqlEditor: z.object({
+        queries: z.array(z.object({
+            id: z.string().describe('Query identifier.'),
+            name: z.string().describe('Query name.'),
+            query: z.string().describe('SQL query to execute.'),
+        })),
+        selectedQueryId: z
+            .string()
+            .default('default')
+            .describe('The id of the currently selected query.'),
+        lastExecutedQuery: z.string().optional().describe('Last executed query'),
+    }),
+});
+export function createDefaultSqlEditorConfig() {
+    return {
+        sqlEditor: {
+            queries: [{ id: 'default', name: 'Untitled', query: '' }],
+            selectedQueryId: 'default',
+        },
+    };
+}
+//# sourceMappingURL=SqlEditorSliceConfig.js.map

package/dist/SqlEditorSliceConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SqlEditorSliceConfig.js","sourceRoot":"","sources":["../src/SqlEditorSliceConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,CAAC,EAAC,MAAM,KAAK,CAAC;AAEtB,0BAA0B;AAC1B,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC;QAClB,OAAO,EAAE,CAAC,CAAC,KAAK,CACd,CAAC,CAAC,MAAM,CAAC;YACP,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,mBAAmB,CAAC;YAC5C,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC;YACxC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,uBAAuB,CAAC;SACpD,CAAC,CACH;QACD,eAAe,EAAE,CAAC;aACf,MAAM,EAAE;aACR,OAAO,CAAC,SAAS,CAAC;aAClB,QAAQ,CAAC,yCAAyC,CAAC;QACtD,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,qBAAqB,CAAC;KACzE,CAAC;CACH,CAAC,CAAC;AAGH,MAAM,UAAU,4BAA4B;IAC1C,OAAO;QACL,SAAS,EAAE;YACT,OAAO,EAAE,CAAC,EAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,EAAE,EAAC,CAAC;YACvD,eAAe,EAAE,SAAS;SAC3B;KACF,CAAC;AACJ,CAAC","sourcesContent":["import {z} from 'zod';\n\n// Saved state (persisted)\nexport const SqlEditorSliceConfig = z.object({\n  sqlEditor: z.object({\n    queries: z.array(\n      z.object({\n        id: z.string().describe('Query identifier.'),\n        name: z.string().describe('Query name.'),\n        query: z.string().describe('SQL query to execute.'),\n      }),\n    ),\n    selectedQueryId: z\n      .string()\n      .default('default')\n      .describe('The id of the currently selected query.'),\n    lastExecutedQuery: z.string().optional().describe('Last executed query'),\n  }),\n});\nexport type SqlEditorSliceConfig = z.infer<typeof SqlEditorSliceConfig>;\n\nexport function createDefaultSqlEditorConfig(): SqlEditorSliceConfig {\n  return {\n    sqlEditor: {\n      queries: [{id: 'default', name: 'Untitled', query: ''}],\n      selectedQueryId: 'default',\n    },\n  };\n}\n"]}

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * {@include ../README.md}
+ * @packageDocumentation
+ */
+export * from './SqlEditorSliceConfig';
+//# 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,wBAAwB,CAAC"}

package/dist/index.js

@@ -0,0 +1,6 @@
+/**
+ * {@include ../README.md}
+ * @packageDocumentation
+ */
+export * from './SqlEditorSliceConfig';
+//# 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,wBAAwB,CAAC","sourcesContent":["/**\n * {@include ../README.md}\n * @packageDocumentation\n */\n\nexport * from './SqlEditorSliceConfig';\n"]}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@sqlrooms/sql-editor-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"
+}