@aneuhold/core-ts-api-lib 3.0.5 → 3.0.7

package/CHANGELOG.md

@@ -5,6 +5,21 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## 🔖 [3.0.7] (2025-12-14)
+
+### ✅ Added
+- Added websocket types for dashboard communication
+
+### 🏗️ Changed
+- Updated dependencies for compatibility
+
+
+## 🔖 [3.0.6] (2025-12-13)
+
+### 🏗️ Changed
+
+- Updated dependency: now requires `@aneuhold/core-ts-db-lib@^4.0.2` for latest schema and validation improvements.
+
 ## 🔖 [3.0.5] (2025-12-08)
 
 ### 🏗️ Changed
@@ -159,13 +174,13 @@ No direct code changes; version bump for compatibility.
 - Updated workflow permissions to allow repository write access
 
 <!-- Link References -->
-
+[3.0.7]: https://github.com/aneuhold/ts-libs/compare/core-ts-api-lib-v3.0.6...core-ts-api-lib-v3.0.7
+[3.0.6]: https://github.com/aneuhold/ts-libs/compare/core-ts-api-lib-v3.0.5...core-ts-api-lib-v3.0.6
 [3.0.5]: https://github.com/aneuhold/ts-libs/compare/core-ts-api-lib-v3.0.4...core-ts-api-lib-v3.0.5
 [3.0.4]: https://github.com/aneuhold/ts-libs/compare/core-ts-api-lib-v3.0.3...core-ts-api-lib-v3.0.4
 [3.0.3]: https://github.com/aneuhold/ts-libs/compare/core-ts-api-lib-v3.0.2...core-ts-api-lib-v3.0.3
 [3.0.2]: https://github.com/aneuhold/ts-libs/compare/core-ts-api-lib-v3.0.1...core-ts-api-lib-v3.0.2
-[3.0.1]: https://github.com/aneuhold/ts-libs/compare/core-ts-api-lib-v3.0.0...core-ts-api-lib-v3.0.1
-[3.0.0]: https://github.com/aneuhold/ts-libs/compare/core-ts-api-lib-v2.2.8...core-ts-api-lib-v3.0.0
+[3.0.1]: https://github.com/aneuhold/ts-libs/compare/core-ts-api-lib-v2.2.8...core-ts-api-lib-v3.0.1
 [2.2.8]: https://github.com/aneuhold/ts-libs/compare/core-ts-api-lib-v2.2.7...core-ts-api-lib-v2.2.8
 [2.2.7]: https://github.com/aneuhold/ts-libs/compare/core-ts-api-lib-v2.2.6...core-ts-api-lib-v2.2.7
 [2.2.6]: https://github.com/aneuhold/ts-libs/compare/core-ts-api-lib-v2.2.5...core-ts-api-lib-v2.2.6

package/lib/browser.d.ts

@@ -5,6 +5,7 @@ import type { AuthValidateUserInput, AuthValidateUserOutput } from './types/Auth
 import type { DashboardConfig } from './types/DashboardConfig.js';
 import type { ProjectDashboardInput, ProjectDashboardOptions, ProjectDashboardOutput } from './types/ProjectDashboard.js';
 import type { Translation, Translations } from './types/Translations.js';
+import type { DashboardWebSocketClientToServerEvents, DashboardWebSocketServerToClientEvents, WebSocketHandshakeAuth } from './types/WebSocket.js';
 export { APIService };
-export type { APIResponse, AuthCheckPasswordInput, AuthCheckPasswordOutput, AuthValidateUserInput, AuthValidateUserOutput, DashboardConfig, ProjectDashboardInput, ProjectDashboardOptions, ProjectDashboardOutput, Translation, Translations };
+export type { APIResponse, AuthCheckPasswordInput, AuthCheckPasswordOutput, AuthValidateUserInput, AuthValidateUserOutput, DashboardConfig, DashboardWebSocketClientToServerEvents, DashboardWebSocketServerToClientEvents, ProjectDashboardInput, ProjectDashboardOptions, ProjectDashboardOutput, Translation, Translations, WebSocketHandshakeAuth };
 //# sourceMappingURL=browser.d.ts.map

package/lib/browser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../src/browser.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qCAAqC,CAAC;AAC7D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,KAAK,EAAE,sBAAsB,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACpG,OAAO,KAAK,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACjG,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,KAAK,EACV,qBAAqB,EACrB,uBAAuB,EACvB,sBAAsB,EACvB,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAGzE,OAAO,EAAE,UAAU,EAAE,CAAC;AAGtB,YAAY,EACV,WAAW,EACX,sBAAsB,EACtB,uBAAuB,EACvB,qBAAqB,EACrB,sBAAsB,EACtB,eAAe,EACf,qBAAqB,EACrB,uBAAuB,EACvB,sBAAsB,EACtB,WAAW,EACX,YAAY,EACb,CAAC"}
+{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../src/browser.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qCAAqC,CAAC;AAC7D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,KAAK,EAAE,sBAAsB,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACpG,OAAO,KAAK,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACjG,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,KAAK,EACV,qBAAqB,EACrB,uBAAuB,EACvB,sBAAsB,EACvB,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACzE,OAAO,KAAK,EACV,sCAAsC,EACtC,sCAAsC,EACtC,sBAAsB,EACvB,MAAM,sBAAsB,CAAC;AAG9B,OAAO,EAAE,UAAU,EAAE,CAAC;AAGtB,YAAY,EACV,WAAW,EACX,sBAAsB,EACtB,uBAAuB,EACvB,qBAAqB,EACrB,sBAAsB,EACtB,eAAe,EACf,sCAAsC,EACtC,sCAAsC,EACtC,qBAAqB,EACrB,uBAAuB,EACvB,sBAAsB,EACtB,WAAW,EACX,YAAY,EACZ,sBAAsB,EACvB,CAAC"}

package/lib/browser.js.map

@@ -1 +1 @@
-{"version":3,"file":"browser.js","sourceRoot":"","sources":["../src/browser.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qCAAqC,CAAC;AAY7D,kEAAkE;AAClE,OAAO,EAAE,UAAU,EAAE,CAAC"}
+{"version":3,"file":"browser.js","sourceRoot":"","sources":["../src/browser.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qCAAqC,CAAC;AAiB7D,kEAAkE;AAClE,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/lib/browser.ts

@@ -9,6 +9,11 @@ import type {
   ProjectDashboardOutput
 } from './types/ProjectDashboard.js';
 import type { Translation, Translations } from './types/Translations.js';
+import type {
+  DashboardWebSocketClientToServerEvents,
+  DashboardWebSocketServerToClientEvents,
+  WebSocketHandshakeAuth
+} from './types/WebSocket.js';
 
 // Export all browser-safe functions and classes from this library
 export { APIService };
@@ -21,9 +26,12 @@ export type {
   AuthValidateUserInput,
   AuthValidateUserOutput,
   DashboardConfig,
+  DashboardWebSocketClientToServerEvents,
+  DashboardWebSocketServerToClientEvents,
   ProjectDashboardInput,
   ProjectDashboardOptions,
   ProjectDashboardOutput,
   Translation,
-  Translations
+  Translations,
+  WebSocketHandshakeAuth
 };

package/lib/types/ProjectDashboard.d.ts

@@ -77,6 +77,7 @@ export interface ProjectDashboardOptions {
 export interface ProjectDashboardInput {
     apiKey: UUID;
     options: ProjectDashboardOptions;
+    socketId?: string;
 }
 /**
  * Represents the output of the project dashboard function.

package/lib/types/ProjectDashboard.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ProjectDashboard.d.ts","sourceRoot":"","sources":["../../src/types/ProjectDashboard.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,mBAAmB,EACnB,kBAAkB,EAClB,qBAAqB,EACrB,OAAO,EACR,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,GAAG,CAAC,EAAE;QACJ;;WAEG;QACH,YAAY,CAAC,EAAE,OAAO,CAAC;QACvB;;;WAGG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB;;WAEG;QACH,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB;;WAEG;QACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;QAC9B;;WAEG;QACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;KAClC,CAAC;IACF,MAAM,CAAC,EAAE;QACP;;WAEG;QACH,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;QACxB;;WAEG;QACH,mBAAmB,CAAC,EAAE,kBAAkB,EAAE,CAAC;QAC3C;;WAEG;QACH,sBAAsB,CAAC,EAAE,qBAAqB,EAAE,CAAC;KAClD,CAAC;IACF,MAAM,CAAC,EAAE;QACP;;WAEG;QACH,UAAU,CAAC,EAAE,mBAAmB,CAAC;QACjC;;WAEG;QACH,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;QACxB;;WAEG;QACH,mBAAmB,CAAC,EAAE,kBAAkB,EAAE,CAAC;QAC3C;;WAEG;QACH,sBAAsB,CAAC,EAAE,qBAAqB,EAAE,CAAC;KAClD,CAAC;IACF,MAAM,CAAC,EAAE;QACP;;WAEG;QACH,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;KACzB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,IAAI,CAAC;IACb,OAAO,EAAE,uBAAuB,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,UAAU,CAAC,EAAE,mBAAmB,CAAC;IACjC,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;IACxB,aAAa,CAAC,EAAE,OAAO,EAAE,CAAC;IAC1B,gBAAgB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAClC,mBAAmB,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAC3C,sBAAsB,CAAC,EAAE,qBAAqB,EAAE,CAAC;CAClD"}
+{"version":3,"file":"ProjectDashboard.d.ts","sourceRoot":"","sources":["../../src/types/ProjectDashboard.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,mBAAmB,EACnB,kBAAkB,EAClB,qBAAqB,EACrB,OAAO,EACR,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,GAAG,CAAC,EAAE;QACJ;;WAEG;QACH,YAAY,CAAC,EAAE,OAAO,CAAC;QACvB;;;WAGG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB;;WAEG;QACH,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB;;WAEG;QACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;QAC9B;;WAEG;QACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;KAClC,CAAC;IACF,MAAM,CAAC,EAAE;QACP;;WAEG;QACH,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;QACxB;;WAEG;QACH,mBAAmB,CAAC,EAAE,kBAAkB,EAAE,CAAC;QAC3C;;WAEG;QACH,sBAAsB,CAAC,EAAE,qBAAqB,EAAE,CAAC;KAClD,CAAC;IACF,MAAM,CAAC,EAAE;QACP;;WAEG;QACH,UAAU,CAAC,EAAE,mBAAmB,CAAC;QACjC;;WAEG;QACH,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;QACxB;;WAEG;QACH,mBAAmB,CAAC,EAAE,kBAAkB,EAAE,CAAC;QAC3C;;WAEG;QACH,sBAAsB,CAAC,EAAE,qBAAqB,EAAE,CAAC;KAClD,CAAC;IACF,MAAM,CAAC,EAAE;QACP;;WAEG;QACH,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;KACzB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,IAAI,CAAC;IACb,OAAO,EAAE,uBAAuB,CAAC;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,UAAU,CAAC,EAAE,mBAAmB,CAAC;IACjC,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;IACxB,aAAa,CAAC,EAAE,OAAO,EAAE,CAAC;IAC1B,gBAAgB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAClC,mBAAmB,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAC3C,sBAAsB,CAAC,EAAE,qBAAqB,EAAE,CAAC;CAClD"}

package/lib/types/ProjectDashboard.ts

@@ -85,6 +85,7 @@ export interface ProjectDashboardOptions {
 export interface ProjectDashboardInput {
   apiKey: UUID;
   options: ProjectDashboardOptions;
+  socketId?: string;
 }
 
 /**

package/lib/types/WebSocket.d.ts

@@ -0,0 +1,29 @@
+import type { UUID } from 'crypto';
+import type { ProjectDashboardOutput } from './ProjectDashboard.js';
+/**
+ * The data each client is expected to send over with a request. For example on the client side:
+ *
+ * ```
+   const socket = io('http://localhost:8080', {
+    auth: {
+      apiKey: 'your-api-key' // Replace with your actual API key
+    }
+  });
+ * ```
+ */
+export type WebSocketHandshakeAuth = {
+    apiKey?: UUID;
+};
+/**
+ * Nothing for now, except a test event if wanted.
+ */
+export type DashboardWebSocketClientToServerEvents = {
+    test: (data: string) => void;
+};
+/**
+ * The events that the server can send to clients.
+ */
+export type DashboardWebSocketServerToClientEvents = {
+    rootPostResult: (data: ProjectDashboardOutput) => void;
+};
+//# sourceMappingURL=WebSocket.d.ts.map

package/lib/types/WebSocket.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebSocket.d.ts","sourceRoot":"","sources":["../../src/types/WebSocket.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAEpE;;;;;;;;;;GAUG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,MAAM,CAAC,EAAE,IAAI,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAAG;IACnD,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;CAC9B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAAG;IACnD,cAAc,EAAE,CAAC,IAAI,EAAE,sBAAsB,KAAK,IAAI,CAAC;CACxD,CAAC"}

package/lib/types/WebSocket.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=WebSocket.js.map

package/lib/types/WebSocket.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebSocket.js","sourceRoot":"","sources":["../../src/types/WebSocket.ts"],"names":[],"mappings":""}

package/lib/types/WebSocket.ts

@@ -0,0 +1,31 @@
+import type { UUID } from 'crypto';
+import type { ProjectDashboardOutput } from './ProjectDashboard.js';
+
+/**
+ * The data each client is expected to send over with a request. For example on the client side:
+ * 
+ * ```
+   const socket = io('http://localhost:8080', {
+    auth: {
+      apiKey: 'your-api-key' // Replace with your actual API key
+    }
+  });
+ * ```
+ */
+export type WebSocketHandshakeAuth = {
+  apiKey?: UUID;
+};
+
+/**
+ * Nothing for now, except a test event if wanted.
+ */
+export type DashboardWebSocketClientToServerEvents = {
+  test: (data: string) => void;
+};
+
+/**
+ * The events that the server can send to clients.
+ */
+export type DashboardWebSocketServerToClientEvents = {
+  rootPostResult: (data: ProjectDashboardOutput) => void;
+};

package/package.json

@@ -2,9 +2,9 @@
   "name": "@aneuhold/core-ts-api-lib",
   "author": "Anton G. Neuhold Jr.",
   "license": "MIT",
-  "version": "3.0.5",
+  "version": "3.0.7",
   "description": "A library for interacting with the backend and defining the backend API for personal projects.",
-  "packageManager": "pnpm@10.12.1",
+  "packageManager": "pnpm@10.25.0",
   "type": "module",
   "scripts": {
     "build": "rimraf lib && pnpm build:withoutClean",
@@ -71,15 +71,15 @@
     "TypeScript"
   ],
   "dependencies": {
-    "@aneuhold/core-ts-db-lib": "^4.0.1",
-    "@aneuhold/core-ts-lib": "^2.3.14",
+    "@aneuhold/core-ts-db-lib": "^4.0.3",
+    "@aneuhold/core-ts-lib": "^2.3.15",
     "bson": "^7.0.0"
   },
   "devDependencies": {
-    "@aneuhold/local-npm-registry": "^0.2.21",
+    "@aneuhold/local-npm-registry": "^0.2.22",
     "@aneuhold/main-scripts": "^2.8.0",
-    "@types/node": "^24.10.1",
-    "eslint": "^9.39.1",
+    "@types/node": "^25.0.2",
+    "eslint": "^9.39.2",
     "jsr": "^0.13.5",
     "prettier": "^3.7.4",
     "rimraf": "^6.1.2",