@privateaim/core-realtime-kit 0.7.5 → 0.7.6

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## [0.7.6](https://github.com/PrivateAIM/hub/compare/v0.7.5...v0.7.6) (2025-01-22)
+
+
+### Features
+
+* adjusted code references for core -> core-kit package renaming ([321b8ac](https://github.com/PrivateAIM/hub/commit/321b8acb33e4fdd93252c72da34fac34cc86cd9f))
+* enhance typing for doamin entities ([9d7c516](https://github.com/PrivateAIM/hub/commit/9d7c51644b66c9361e5436e2c43f463f4f219f90))
+* initial core -> core-kit package renaming ([9ac9709](https://github.com/PrivateAIM/hub/commit/9ac970999922bc76e3f88381f4d3351a51147a46))
+* initial implementation & usage refactoring ([#426](https://github.com/PrivateAIM/hub/issues/426)) ([85ff83f](https://github.com/PrivateAIM/hub/commit/85ff83f40dc129f7f1e28b41f445f60bb6d6fcfe))
+* realtime library/service split ([#474](https://github.com/PrivateAIM/hub/issues/474)) ([43c2dfa](https://github.com/PrivateAIM/hub/commit/43c2dfad654cc61ca9784914cbad56c684434088))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * devDependencies
+    * @privateaim/core-kit bumped from ^0.8.4 to ^0.8.5
+  * peerDependencies
+    * @privateaim/core-kit bumped from ^0.8.4 to ^0.8.5
+
 ## [0.7.5](https://github.com/PrivateAIM/hub/compare/v0.7.4...v0.7.5) (2024-10-24)
 
 

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sources":["../src/constants.ts","../src/utils.ts"],"sourcesContent":["/*\n * Copyright (c) 2024.\n * Author Peter Placzek (tada5hi)\n * For the full copyright and license information,\n * view the LICENSE file that was distributed with this source code.\n */\n\nexport enum STCEventName {\n    USER_CONNECTED = 'userConnected',\n    USER_DISCONNECTED = 'userDisconnected',\n\n    ROBOT_CONNECTED = 'robotConnected',\n    ROBOT_DISCONNECTED = 'robotDisconnected',\n}\n\nexport enum CTSEventName {\n    USER_CONNECTIONS = 'userConnections',\n    USER_CONNECTION_SUBSCRIBE = 'userConnectionSubscribe',\n    USER_CONNECTION_UNSUBSCRIBE = 'userConnectionUnsubscribe',\n\n    ROBOT_CONNECTIONS = 'robotConnections',\n    ROBOT_CONNECTION_SUBSCRIBE = 'robotConnectionSubscribe',\n    ROBOT_CONNECTION_UNSUBSCRIBE = 'robotConnectionUnsubscribe',\n}\n","/*\n * Copyright (c) 2021-2024.\n * Author Peter Placzek (tada5hi)\n * For the full copyright and license information,\n * view the LICENSE file that was distributed with this source code.\n */\n\nimport type { EventCallback } from './types';\n\nexport function isEventCallback(\n    input: unknown,\n    fnArgs?: number,\n) : input is EventCallback {\n    if (typeof fnArgs === 'undefined') {\n        return typeof input === 'function';\n    }\n\n    return typeof input === 'function' &&\n        input.length >= fnArgs;\n}\n\nexport function isEventTarget(\n    input: unknown,\n) : input is EventTarget {\n    return typeof input === 'number' ||\n        typeof input === 'string' ||\n        typeof input === 'undefined';\n}\n"],"names":["STCEventName","CTSEventName","isEventCallback","input","fnArgs","length","isEventTarget"],"mappings":";;AAAA;;;;;IAOO,IAAKA,YAAAA,iBAAAA,SAAAA,YAAAA,EAAAA;;;;;AAAAA,IAAAA,OAAAA,YAAAA,CAAAA;AAMX,CAAA,CAAA,EAAA,EAAA;AAEM,IAAA,YAAKC,iBAAAA,SAAAA,YAAAA,EAAAA;;;;;;;AAAAA,IAAAA,OAAAA,YAAAA,CAAAA;AAQX,CAAA,CAAA,EAAA;;ACvBD;;;;;AAKC,IAIM,SAASC,eACZC,CAAAA,KAAc,EACdC,MAAe,EAAA;IAEf,IAAI,OAAOA,WAAW,WAAa,EAAA;AAC/B,QAAA,OAAO,OAAOD,KAAU,KAAA,UAAA,CAAA;AAC5B,KAAA;AAEA,IAAA,OAAO,OAAOA,KAAAA,KAAU,UACpBA,IAAAA,KAAAA,CAAME,MAAM,IAAID,MAAAA,CAAAA;AACxB,CAAA;AAEO,SAASE,cACZH,KAAc,EAAA;AAEd,IAAA,OAAO,OAAOA,KAAU,KAAA,QAAA,IACpB,OAAOA,KAAU,KAAA,QAAA,IACjB,OAAOA,KAAU,KAAA,WAAA,CAAA;AACzB;;;;;;;"}
+{"version":3,"file":"index.cjs","sources":["../src/constants.ts","../src/utils.ts"],"sourcesContent":["/*\n * Copyright (c) 2024.\n * Author Peter Placzek (tada5hi)\n * For the full copyright and license information,\n * view the LICENSE file that was distributed with this source code.\n */\n\nexport enum STCEventName {\n    USER_CONNECTED = 'userConnected',\n    USER_DISCONNECTED = 'userDisconnected',\n\n    ROBOT_CONNECTED = 'robotConnected',\n    ROBOT_DISCONNECTED = 'robotDisconnected',\n}\n\nexport enum CTSEventName {\n    USER_CONNECTIONS = 'userConnections',\n    USER_CONNECTION_SUBSCRIBE = 'userConnectionSubscribe',\n    USER_CONNECTION_UNSUBSCRIBE = 'userConnectionUnsubscribe',\n\n    ROBOT_CONNECTIONS = 'robotConnections',\n    ROBOT_CONNECTION_SUBSCRIBE = 'robotConnectionSubscribe',\n    ROBOT_CONNECTION_UNSUBSCRIBE = 'robotConnectionUnsubscribe',\n}\n","/*\n * Copyright (c) 2021-2024.\n * Author Peter Placzek (tada5hi)\n * For the full copyright and license information,\n * view the LICENSE file that was distributed with this source code.\n */\n\nimport type { EventCallback } from './types';\n\nexport function isEventCallback(\n    input: unknown,\n    fnArgs?: number,\n) : input is EventCallback {\n    if (typeof fnArgs === 'undefined') {\n        return typeof input === 'function';\n    }\n\n    return typeof input === 'function' &&\n        input.length >= fnArgs;\n}\n\nexport function isEventTarget(\n    input: unknown,\n) : input is EventTarget {\n    return typeof input === 'number' ||\n        typeof input === 'string' ||\n        typeof input === 'undefined';\n}\n"],"names":["STCEventName","CTSEventName","isEventCallback","input","fnArgs","length","isEventTarget"],"mappings":";;AAAA;;;;;IAOO,IAAKA,YAAAA,iBAAAA,SAAAA,YAAAA,EAAAA;;;;;AAAAA,IAAAA,OAAAA,YAAAA;AAMX,CAAA,CAAA,EAAA;AAEM,IAAA,YAAKC,iBAAAA,SAAAA,YAAAA,EAAAA;;;;;;;AAAAA,IAAAA,OAAAA,YAAAA;AAQX,CAAA,CAAA,EAAA;;ACvBD;;;;;AAKC,IAIM,SAASC,eACZC,CAAAA,KAAc,EACdC,MAAe,EAAA;IAEf,IAAI,OAAOA,WAAW,WAAa,EAAA;AAC/B,QAAA,OAAO,OAAOD,KAAU,KAAA,UAAA;AAC5B;AAEA,IAAA,OAAO,OAAOA,KAAAA,KAAU,UACpBA,IAAAA,KAAAA,CAAME,MAAM,IAAID,MAAAA;AACxB;AAEO,SAASE,cACZH,KAAc,EAAA;AAEd,IAAA,OAAO,OAAOA,KAAU,KAAA,QAAA,IACpB,OAAOA,KAAU,KAAA,QAAA,IACjB,OAAOA,KAAU,KAAA,WAAA;AACzB;;;;;;;"}

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sources":["../src/constants.ts","../src/utils.ts"],"sourcesContent":["/*\n * Copyright (c) 2024.\n * Author Peter Placzek (tada5hi)\n * For the full copyright and license information,\n * view the LICENSE file that was distributed with this source code.\n */\n\nexport enum STCEventName {\n    USER_CONNECTED = 'userConnected',\n    USER_DISCONNECTED = 'userDisconnected',\n\n    ROBOT_CONNECTED = 'robotConnected',\n    ROBOT_DISCONNECTED = 'robotDisconnected',\n}\n\nexport enum CTSEventName {\n    USER_CONNECTIONS = 'userConnections',\n    USER_CONNECTION_SUBSCRIBE = 'userConnectionSubscribe',\n    USER_CONNECTION_UNSUBSCRIBE = 'userConnectionUnsubscribe',\n\n    ROBOT_CONNECTIONS = 'robotConnections',\n    ROBOT_CONNECTION_SUBSCRIBE = 'robotConnectionSubscribe',\n    ROBOT_CONNECTION_UNSUBSCRIBE = 'robotConnectionUnsubscribe',\n}\n","/*\n * Copyright (c) 2021-2024.\n * Author Peter Placzek (tada5hi)\n * For the full copyright and license information,\n * view the LICENSE file that was distributed with this source code.\n */\n\nimport type { EventCallback } from './types';\n\nexport function isEventCallback(\n    input: unknown,\n    fnArgs?: number,\n) : input is EventCallback {\n    if (typeof fnArgs === 'undefined') {\n        return typeof input === 'function';\n    }\n\n    return typeof input === 'function' &&\n        input.length >= fnArgs;\n}\n\nexport function isEventTarget(\n    input: unknown,\n) : input is EventTarget {\n    return typeof input === 'number' ||\n        typeof input === 'string' ||\n        typeof input === 'undefined';\n}\n"],"names":["STCEventName","CTSEventName","isEventCallback","input","fnArgs","length","isEventTarget"],"mappings":"AAAA;;;;;IAOO,IAAKA,YAAAA,iBAAAA,SAAAA,YAAAA,EAAAA;;;;;AAAAA,IAAAA,OAAAA,YAAAA,CAAAA;AAMX,CAAA,CAAA,EAAA,EAAA;AAEM,IAAA,YAAKC,iBAAAA,SAAAA,YAAAA,EAAAA;;;;;;;AAAAA,IAAAA,OAAAA,YAAAA,CAAAA;AAQX,CAAA,CAAA,EAAA;;ACvBD;;;;;AAKC,IAIM,SAASC,eACZC,CAAAA,KAAc,EACdC,MAAe,EAAA;IAEf,IAAI,OAAOA,WAAW,WAAa,EAAA;AAC/B,QAAA,OAAO,OAAOD,KAAU,KAAA,UAAA,CAAA;AAC5B,KAAA;AAEA,IAAA,OAAO,OAAOA,KAAAA,KAAU,UACpBA,IAAAA,KAAAA,CAAME,MAAM,IAAID,MAAAA,CAAAA;AACxB,CAAA;AAEO,SAASE,cACZH,KAAc,EAAA;AAEd,IAAA,OAAO,OAAOA,KAAU,KAAA,QAAA,IACpB,OAAOA,KAAU,KAAA,QAAA,IACjB,OAAOA,KAAU,KAAA,WAAA,CAAA;AACzB;;;;"}
+{"version":3,"file":"index.mjs","sources":["../src/constants.ts","../src/utils.ts"],"sourcesContent":["/*\n * Copyright (c) 2024.\n * Author Peter Placzek (tada5hi)\n * For the full copyright and license information,\n * view the LICENSE file that was distributed with this source code.\n */\n\nexport enum STCEventName {\n    USER_CONNECTED = 'userConnected',\n    USER_DISCONNECTED = 'userDisconnected',\n\n    ROBOT_CONNECTED = 'robotConnected',\n    ROBOT_DISCONNECTED = 'robotDisconnected',\n}\n\nexport enum CTSEventName {\n    USER_CONNECTIONS = 'userConnections',\n    USER_CONNECTION_SUBSCRIBE = 'userConnectionSubscribe',\n    USER_CONNECTION_UNSUBSCRIBE = 'userConnectionUnsubscribe',\n\n    ROBOT_CONNECTIONS = 'robotConnections',\n    ROBOT_CONNECTION_SUBSCRIBE = 'robotConnectionSubscribe',\n    ROBOT_CONNECTION_UNSUBSCRIBE = 'robotConnectionUnsubscribe',\n}\n","/*\n * Copyright (c) 2021-2024.\n * Author Peter Placzek (tada5hi)\n * For the full copyright and license information,\n * view the LICENSE file that was distributed with this source code.\n */\n\nimport type { EventCallback } from './types';\n\nexport function isEventCallback(\n    input: unknown,\n    fnArgs?: number,\n) : input is EventCallback {\n    if (typeof fnArgs === 'undefined') {\n        return typeof input === 'function';\n    }\n\n    return typeof input === 'function' &&\n        input.length >= fnArgs;\n}\n\nexport function isEventTarget(\n    input: unknown,\n) : input is EventTarget {\n    return typeof input === 'number' ||\n        typeof input === 'string' ||\n        typeof input === 'undefined';\n}\n"],"names":["STCEventName","CTSEventName","isEventCallback","input","fnArgs","length","isEventTarget"],"mappings":"AAAA;;;;;IAOO,IAAKA,YAAAA,iBAAAA,SAAAA,YAAAA,EAAAA;;;;;AAAAA,IAAAA,OAAAA,YAAAA;AAMX,CAAA,CAAA,EAAA;AAEM,IAAA,YAAKC,iBAAAA,SAAAA,YAAAA,EAAAA;;;;;;;AAAAA,IAAAA,OAAAA,YAAAA;AAQX,CAAA,CAAA,EAAA;;ACvBD;;;;;AAKC,IAIM,SAASC,eACZC,CAAAA,KAAc,EACdC,MAAe,EAAA;IAEf,IAAI,OAAOA,WAAW,WAAa,EAAA;AAC/B,QAAA,OAAO,OAAOD,KAAU,KAAA,UAAA;AAC5B;AAEA,IAAA,OAAO,OAAOA,KAAAA,KAAU,UACpBA,IAAAA,KAAAA,CAAME,MAAM,IAAID,MAAAA;AACxB;AAEO,SAASE,cACZH,KAAc,EAAA;AAEd,IAAA,OAAO,OAAOA,KAAU,KAAA,QAAA,IACpB,OAAOA,KAAU,KAAA,QAAA,IACjB,OAAOA,KAAU,KAAA,WAAA;AACzB;;;;"}

package/dist/types.d.ts

@@ -1,5 +1,5 @@
-import type { DomainEventContext, DomainEventFullName, DomainEventSubscriptionFullName, DomainSubType, DomainType } from '@privateaim/core-kit';
-export type STCEventContext<T extends Record<string, any>> = T & {
+import type { DomainEventFullName, DomainEventSubscriptionFullName, DomainTypeMap, EventRecord } from '@privateaim/core-kit';
+export type STCEventRecord<TYPE extends string, RECORD extends Record<string, any>> = EventRecord<TYPE, RECORD> & {
     meta: {
         roomName?: string;
         roomId?: string | number;
@@ -13,10 +13,12 @@ export interface EventCallback<T = any> {
 export type STSEvents = {
     [event: string]: (...args: any[]) => void;
 };
+export type STCEventHandler<TYPE extends string, RECORD extends Record<string, any>> = (data: STCEventRecord<TYPE, RECORD>) => void;
 export type STCEvents = {
-    [K in `${DomainType}` | `${DomainSubType}` as DomainEventFullName<K>]: (data: STCEventContext<DomainEventContext<K>>) => void;
+    [K in keyof DomainTypeMap as DomainEventFullName<K>]: STCEventHandler<K, DomainTypeMap[K]>;
 };
+export type CTSEventHandler = (target: EventTarget, cb: EventCallback) => void;
 export type CTSEvents = {
-    [K in DomainEventSubscriptionFullName<`${DomainType}` | `${DomainSubType}`>]: (target?: EventTarget, cb?: EventCallback) => void;
+    [K in keyof DomainTypeMap as DomainEventSubscriptionFullName<K>]: CTSEventHandler;
 };
 //# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACR,kBAAkB,EAClB,mBAAmB,EACnB,+BAA+B,EAC/B,aAAa,EACb,UAAU,EACb,MAAM,sBAAsB,CAAC;AAE9B,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC,GAAG;IAC7D,IAAI,EAAE;QACF,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;KAC3B,CAAA;CACJ,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;AACtD,MAAM,WAAW,aAAa,CAAC,CAAC,GAAG,GAAG;IAClC,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,GAAI,IAAI,CAAC;IAC7B,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,EAAE,IAAI,EAAE,CAAC,GAAI,IAAI,CAAC;CACzC;AAED,MAAM,MAAM,SAAS,GAAG;IACpB,CAAC,KAAK,EAAE,MAAM,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;CAC7C,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;KACnB,CAAC,IAAI,GAAG,UAAU,EAAE,GAAG,GAAG,aAAa,EAAE,IAAI,mBAAmB,CAAC,CAAC,CAAC,GAAG,CACnE,IAAI,EAAE,eAAe,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,KAC3C,IAAI;CACZ,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;KACnB,CAAC,IAAI,+BAA+B,CAAC,GAAG,UAAU,EAAE,GAAG,GAAG,aAAa,EAAE,CAAC,GAAG,CAC1E,MAAM,CAAC,EAAE,WAAW,EACpB,EAAE,CAAC,EAAE,aAAa,KACjB,IAAI;CACZ,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACR,mBAAmB,EACnB,+BAA+B,EAC/B,aAAa,EACb,WAAW,EACd,MAAM,sBAAsB,CAAC;AAE9B,MAAM,MAAM,cAAc,CACtB,IAAI,SAAS,MAAM,EACnB,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAClC,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG;IAC5B,IAAI,EAAE;QACF,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;KAC3B,CAAA;CACJ,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;AACtD,MAAM,WAAW,aAAa,CAAC,CAAC,GAAG,GAAG;IAClC,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,GAAI,IAAI,CAAC;IAC7B,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,EAAE,IAAI,EAAE,CAAC,GAAI,IAAI,CAAC;CACzC;AAED,MAAM,MAAM,SAAS,GAAG;IACpB,CAAC,KAAK,EAAE,MAAM,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;CAC7C,CAAC;AAEF,MAAM,MAAM,eAAe,CACvB,IAAI,SAAS,MAAM,EACnB,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAClC,CACA,IAAI,EAAE,cAAc,CAAC,IAAI,EAAE,MAAM,CAAC,KACjC,IAAI,CAAC;AACV,MAAM,MAAM,SAAS,GAAG;KACnB,CAAC,IAAI,MAAM,aAAa,IAAI,mBAAmB,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;CAC7F,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,CAC1B,MAAM,EAAE,WAAW,EACnB,EAAE,EAAE,aAAa,KAChB,IAAI,CAAC;AACV,MAAM,MAAM,SAAS,GAAG;KACnB,CAAC,IAAI,MAAM,aAAa,IAAI,+BAA+B,CAAC,CAAC,CAAC,GAAG,eAAe;CACpF,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@privateaim/core-realtime-kit",
-    "version": "0.7.5",
+    "version": "0.7.6",
     "license": "Apache-2.0",
     "description": "",
     "exports": {
@@ -26,10 +26,10 @@
         "build-watch": "rimraf ./dist && tsc -p tsconfig.build.json --watch"
     },
     "devDependencies": {
-        "@privateaim/core-kit": "^0.8.4"
+        "@privateaim/core-kit": "^0.8.5"
     },
     "peerDependencies": {
-        "@privateaim/core-kit": "^0.8.4"
+        "@privateaim/core-kit": "^0.8.5"
     },
     "publishConfig": {
         "access": "public"

package/src/types.ts

@@ -6,14 +6,16 @@
  */
 
 import type {
-    DomainEventContext,
     DomainEventFullName,
     DomainEventSubscriptionFullName,
-    DomainSubType,
-    DomainType,
+    DomainTypeMap,
+    EventRecord,
 } from '@privateaim/core-kit';
 
-export type STCEventContext<T extends Record<string, any>> = T & {
+export type STCEventRecord<
+    TYPE extends string,
+    RECORD extends Record<string, any>,
+> = EventRecord<TYPE, RECORD> & {
     meta: {
         roomName?: string,
         roomId?: string | number
@@ -30,15 +32,20 @@ export type STSEvents = {
     [event: string]: (...args: any[]) => void;
 };
 
+export type STCEventHandler<
+    TYPE extends string,
+    RECORD extends Record<string, any>,
+> = (
+    data: STCEventRecord<TYPE, RECORD>
+) => void;
 export type STCEvents = {
-    [K in `${DomainType}` | `${DomainSubType}` as DomainEventFullName<K>]: (
-        data: STCEventContext<DomainEventContext<K>>
-    ) => void
+    [K in keyof DomainTypeMap as DomainEventFullName<K>]: STCEventHandler<K, DomainTypeMap[K]>
 };
 
+export type CTSEventHandler = (
+    target: EventTarget,
+    cb: EventCallback
+) => void;
 export type CTSEvents = {
-    [K in DomainEventSubscriptionFullName<`${DomainType}` | `${DomainSubType}`>]: (
-        target?: EventTarget,
-        cb?: EventCallback
-    ) => void
+    [K in keyof DomainTypeMap as DomainEventSubscriptionFullName<K>]: CTSEventHandler
 };