@evoke-platform/context 1.0.0-dev.112 → 1.0.0-dev.113

package/README.md

@@ -17,7 +17,7 @@ available and no further installation is necessary.
 
 -   [Working With Objects](#working-with-objects)
 -   [REST API Calls](#rest-api-calls)
--   [SignalR Connection](#signalr-connection)
+-   [Notifications](#notifications)
 
 ### Working With Objects
 
@@ -206,26 +206,27 @@ absolute URL.
 
 ##### `delete(url, options)`
 
-### SignalR Connection
+### Notifications
 
-Deprecated
-
--   [useSignalRConnection](#usesignalrconnection)
+-   [useNofitication](#usenotification)
     -   [documentChanges](#documentchangessubscribeobjectidinstanceid-data-documentchange)
     -   [instanceChanges](#instancechangessubscribeobjectid-instanceids-instancechange)
+-   [useSignalRConnection](#usesignalrconnection) (_Deprecated_)
+    -   [documentChanges](#documentchangessubscribeobjectidinstanceid-data-documentchange) (_Deprecated_)
+    -   [instanceChanges](#instancechangessubscribeobjectid-instanceids-instancechange) (_Deprecated_)
 
-#### `useSignalRConnection()`
+#### `useNofitication()`
 
-Hook used to obtain an instanceChanges instance of `SignalRConnection` and a documentChanges instance of `SignalRConnection`.
+Hook used to obtain an instanceChanges instance and a documentChanges instance.
 
-##### `documentChanges.subscribe('{objectId}/{instanceId}', (data: DocumentChange[]]) => {})`
+##### `documentChanges.subscribe(objectId, instanceId, (data: DocumentChange[]]) => {})`
 
-Subscribe to the specified object instance document changes.
+Subscribe to the specified object instance changes.
 
 ```javascript
-const { documentChanges } = useSignalRConnection();
+const { documentChanges } = useNotification();
 
-documentChanges.subscribe('myObjectId/myInstanceId', (data) => {
+documentChanges.subscribe('myObjectId', 'myInstanceId', (data) => {
     console.log(data);
 });
 ```
@@ -242,53 +243,61 @@ following data:
 -   `type`
     -   The type of update. Possible values are `BlobCreated`, `BlobDeleted`, and `BlobMetadataUpdated`.
 
-##### `documentChanges.unsubscribe('{objectId}/{instanceId}', (data: DocumentChange[]) => {})`
+##### `documentChanges.unsubscribe(objectId, instanceId, (changes: DocumentChange[]) => {})`
 
-Unsubscribe to the specified object instance document changes.
+Unsubscribe to the specified object instance changes.
 
 Callback function is optional.
+If callback function is not defined, all subscriptions will be removed.
 If callback function is defined, you must pass the exact same Function instance as was previously passed to `documentChanges.subscribe`.
 Passing a different instance (even if the function body is the same) will not remove the subscription.
 
 ```javascript
-const { documentChanges } = useSignalRConnection();
+const { documentChanges } = useNotification();
 
-const callback = (data: DocumentChange[]) => {
-    console.log(data);
+const callback = (changes: DocumentChange[]) => {
+    console.log(changes);
 };
 
-documentChanges.subscribe('myObjectId/myInstanceId', callback);
+documentChanges.subscribe('myObjectId', 'myInstanceId', callback);
 
-documentChanges.unsubscribe('myObjectId/myInstanceId', callback);
+documentChanges.unsubscribe('myObjectId', 'myInstanceId', callback);
 ```
 
-##### `instanceChanges.subscribe('{objectId}', (instanceIds: InstanceChange[]) => {})`
+##### `instanceChanges.subscribe(objectId, (changes: InstanceChange[]) => {})`
 
-Subscribe to the specified object instance changes.
+Subscribe to the specified object changes.
 
 ```javascript
-const { instanceChanges } = useSignalRConnection();
+const { instanceChanges } = useNotification();
 
-instanceChanges.subscribe('myObjectId', (instanceIds) => {
-    console.log(instanceIds);
+instanceChanges.subscribe('myObjectId', (changes) => {
+    console.log(changes);
 });
 ```
 
-The data provided to the callback will be an array of instance IDs that were updated.
+The data provided to the callback will be an array of `InstanceChange` which contains the
+following data:
 
-##### `instanceChanges.unsubscribe('{objectId}', (instanceIds: InstanceChange[]) => {})`
+-   `objectId`
+    -   Object describing the instance associated with the updated document.
+-   `instanceId`
+    -   Instance that the updated document is associated with.
 
-Unsubscribe to the specified object instance changes.
+##### `instanceChanges.unsubscribe(objectId, (changes: InstanceChange[]) => {})`
+
+Unsubscribe to the specified object changes.
 
 Callback function is optional.
+If callback function is not defined, all subscriptions will be removed.
 If callback function is defined, you must pass the exact same Function instance as was previously passed to `instanceChanges.subscribe`.
 Passing a different instance (even if the function body is the same) will not remove the subscription.
 
 ```javascript
-const { instanceChanges } = useSignalRConnection();
+const { instanceChanges } = useNotification();
 
-const callback = (instanceIds: InstanceChange[]) => {
-    console.log(instanceIds);
+const callback = (changes: InstanceChange[]) => {
+    console.log(changes);
 };
 
 instanceChanges.subscribe('myObjectId', callback);
@@ -296,24 +305,24 @@ instanceChanges.subscribe('myObjectId', callback);
 instanceChanges.unsubscribe('myObjectId', callback);
 ```
 
-### Notification
+#### `useSignalRConnection()`
 
--   [useNofitication](#usenotification)
-    -   [documentChanges](#documentchangessubscribeobjectidinstanceid-data-documentchange)
-    -   [instanceChanges](#instancechangessubscribeobjectid-instanceids-instancechange)
+> **Deprecated**
+> This has been deprecated in favor of [useNotification](#usenofitication).
 
-#### `useNofitication()`
+Hook used to obtain an instanceChanges instance of `SignalRConnection` and a documentChanges instance of `SignalRConnection`.
 
-Hook used to obtain an instanceChanges instance and a documentChanges instance.
+##### `documentChanges.subscribe('{objectId}/{instanceId}', (data: DocumentChange[]]) => {})`
 
-##### `documentChanges.subscribe(objectId, instanceId, (data: DocumentChange[]]) => {})`
+> **Deprecated**
+> This has been deprecated in favor of [useNotification](#usenofitication).
 
-Subscribe to the specified object instance changes.
+Subscribe to the specified object instance document changes.
 
 ```javascript
-const { documentChanges } = useNotification();
+const { documentChanges } = useSignalRConnection();
 
-documentChanges.subscribe('myObjectId', 'myInstanceId', (data) => {
+documentChanges.subscribe('myObjectId/myInstanceId', (data) => {
     console.log(data);
 });
 ```
@@ -330,61 +339,62 @@ following data:
 -   `type`
     -   The type of update. Possible values are `BlobCreated`, `BlobDeleted`, and `BlobMetadataUpdated`.
 
-##### `documentChanges.unsubscribe(objectId, instanceId, (changes: DocumentChange[]) => {})`
+##### `documentChanges.unsubscribe('{objectId}/{instanceId}', (data: DocumentChange[]) => {})`
 
-Unsubscribe to the specified object instance changes.
+> **Deprecated**
+> This has been deprecated in favor of [useNotification](#usenofitication).
+
+Unsubscribe to the specified object instance document changes.
 
 Callback function is optional.
-If callback function is not defined, all subscriptions will be removed.
 If callback function is defined, you must pass the exact same Function instance as was previously passed to `documentChanges.subscribe`.
 Passing a different instance (even if the function body is the same) will not remove the subscription.
 
 ```javascript
-const { documentChanges } = useNotification();
+const { documentChanges } = useSignalRConnection();
 
-const callback = (changes: DocumentChange[]) => {
-    console.log(changes);
+const callback = (data: DocumentChange[]) => {
+    console.log(data);
 };
 
-documentChanges.subscribe('myObjectId', 'myInstanceId', callback);
+documentChanges.subscribe('myObjectId/myInstanceId', callback);
 
-documentChanges.unsubscribe('myObjectId', 'myInstanceId', callback);
+documentChanges.unsubscribe('myObjectId/myInstanceId', callback);
 ```
 
-##### `instanceChanges.subscribe(objectId, (changes: InstanceChange[]) => {})`
+##### `instanceChanges.subscribe('{objectId}', (instanceIds: InstanceChange[]) => {})`
 
-Subscribe to the specified object changes.
+> **Deprecated**
+> This has been deprecated in favor of [useNotification](#usenofitication).
+
+Subscribe to the specified object instance changes.
 
 ```javascript
-const { instanceChanges } = useNotification();
+const { instanceChanges } = useSignalRConnection();
 
-instanceChanges.subscribe('myObjectId', (changes) => {
-    console.log(changes);
+instanceChanges.subscribe('myObjectId', (instanceIds) => {
+    console.log(instanceIds);
 });
 ```
 
-The data provided to the callback will be an array of `InstanceChange` which contains the
-following data:
+The data provided to the callback will be an array of instance IDs that were updated.
 
--   `objectId`
-    -   Object describing the instance associated with the updated document.
--   `instanceId`
-    -   Instance that the updated document is associated with.
+##### `instanceChanges.unsubscribe('{objectId}', (instanceIds: InstanceChange[]) => {})`
 
-##### `instanceChanges.unsubscribe(objectId, (changes: InstanceChange[]) => {})`
+> **Deprecated**
+> This has been deprecated in favor of [useNotification](#usenofitication).
 
-Unsubscribe to the specified object changes.
+Unsubscribe to the specified object instance changes.
 
 Callback function is optional.
-If callback function is not defined, all subscriptions will be removed.
 If callback function is defined, you must pass the exact same Function instance as was previously passed to `instanceChanges.subscribe`.
 Passing a different instance (even if the function body is the same) will not remove the subscription.
 
 ```javascript
-const { instanceChanges } = useNotification();
+const { instanceChanges } = useSignalRConnection();
 
-const callback = (changes: InstanceChange[]) => {
-    console.log(changes);
+const callback = (instanceIds: InstanceChange[]) => {
+    console.log(instanceIds);
 };
 
 instanceChanges.subscribe('myObjectId', callback);

package/dist/notification/NotificationProvider.js

@@ -8,7 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { jsx as _jsx } from "react/jsx-runtime";
-import { HubConnectionBuilder, LogLevel, } from '@microsoft/signalr/dist/esm/index.js';
+import { HubConnectionBuilder, LogLevel, } from '@microsoft/signalr';
 import { createContext, useContext, useEffect, useState } from 'react';
 import { useApiServices } from '../api/index.js';
 export const NotificationContext = createContext({});

package/dist/signalr/SignalRConnectionProvider.js

@@ -1,142 +1,53 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 import { jsx as _jsx } from "react/jsx-runtime";
 // Copyright (c) 2023 System Automation Corporation.
 // This file is licensed under the MIT License.
-import { HubConnectionBuilder, LogLevel } from '@microsoft/signalr/dist/esm/index.js';
-import { createContext, useContext, useEffect, useState } from 'react';
-import { useApiServices } from '../api/index.js';
+import { createContext, useContext, useState } from 'react';
+import { useNotification } from '../notification/index.js';
 export const SignalRConnectionContext = createContext({});
 SignalRConnectionContext.displayName = 'SignalRConnectionContext';
 function SignalRConnectionProvider({ children }) {
-    const [instancesSignalRConnection, setInstancesSignalRConnection] = useState();
-    const [documentsSignalRConnection, setDocumentsSignalRConnection] = useState();
-    const api = useApiServices();
-    useEffect(() => {
-        const getConnectionInfo = (hubName) => {
-            return api.post(`/signalr/hubs/${hubName}/negotiate`);
-        };
-        const getConnection = () => __awaiter(this, void 0, void 0, function* () {
-            try {
-                const instancesConnectionInfo = yield getConnectionInfo('instanceChanges');
-                const documentsConnectionInfo = yield getConnectionInfo('documentChanges');
-                if (instancesConnectionInfo) {
-                    const options = {
-                        accessTokenFactory: () => __awaiter(this, void 0, void 0, function* () {
-                            if (instancesConnectionInfo.accessToken) {
-                                return instancesConnectionInfo.accessToken;
-                            }
-                            else {
-                                return getConnection();
-                            }
-                        }),
-                    };
-                    const connection = new HubConnectionBuilder()
-                        .withUrl(instancesConnectionInfo.url, options)
-                        .configureLogging(LogLevel.Error)
-                        .withAutomaticReconnect()
-                        .build();
-                    setInstancesSignalRConnection(connection);
-                }
-                if (documentsConnectionInfo) {
-                    const options = {
-                        accessTokenFactory: () => __awaiter(this, void 0, void 0, function* () {
-                            if (documentsConnectionInfo.accessToken) {
-                                return documentsConnectionInfo.accessToken;
-                            }
-                            else {
-                                return getConnection();
-                            }
-                        }),
-                    };
-                    const connection = new HubConnectionBuilder()
-                        .withUrl(documentsConnectionInfo.url, options)
-                        .configureLogging(LogLevel.Error)
-                        .withAutomaticReconnect()
-                        .build();
-                    setDocumentsSignalRConnection(connection);
-                }
-                // eslint-disable-next-line no-empty
-            }
-            catch (err) { }
-        });
-        getConnection();
-    }, []);
-    useEffect(() => {
-        let documentsConnectionStopped = false;
-        const startConnection = (connection, numOfAttempts) => __awaiter(this, void 0, void 0, function* () {
-            yield connection.start().catch((error) => {
-                if (numOfAttempts < 4 && !documentsConnectionStopped) {
-                    setTimeout(() => {
-                        if (!documentsConnectionStopped) {
-                            startConnection(connection, numOfAttempts + 1);
-                        }
-                    }, 2000);
-                }
-                else {
-                    console.warn(`Cannot start connection to SignalR due to error "${error}"`);
-                }
-            });
-        });
-        if (documentsSignalRConnection) {
-            startConnection(documentsSignalRConnection, 0);
-        }
-        return () => {
-            documentsSignalRConnection === null || documentsSignalRConnection === void 0 ? void 0 : documentsSignalRConnection.stop();
-            documentsConnectionStopped = true;
-        };
-    }, [documentsSignalRConnection]);
-    useEffect(() => {
-        let instancesConnectionStopped = false;
-        const startConnection = (connection, numOfAttempts) => __awaiter(this, void 0, void 0, function* () {
-            yield connection.start().catch((error) => {
-                if (numOfAttempts < 4 && !instancesConnectionStopped) {
-                    setTimeout(() => {
-                        if (!instancesConnectionStopped) {
-                            startConnection(connection, numOfAttempts + 1);
-                        }
-                    }, 2000);
-                }
-                else {
-                    console.warn(`Cannot start connection to SignalR due to error "${error}"`);
-                }
-            });
-        });
-        if (instancesSignalRConnection) {
-            startConnection(instancesSignalRConnection, 0);
-        }
-        return () => {
-            instancesSignalRConnection === null || instancesSignalRConnection === void 0 ? void 0 : instancesSignalRConnection.stop();
-            instancesConnectionStopped = true;
-        };
-    }, [instancesSignalRConnection]);
+    const notifications = useNotification();
+    const [instanceCallbacks] = useState(
+    // Map provided callbacks to our wrappers that are sent to the underlying
+    // notification provider.
+    new WeakMap());
     return (_jsx(SignalRConnectionContext.Provider, { value: {
-            documentChanges: documentsSignalRConnection
-                ? {
-                    subscribe: (topicName, callback) => documentsSignalRConnection.on(topicName, callback),
-                    unsubscribe: (topicName, callback) => callback
-                        ? documentsSignalRConnection.off(topicName, callback)
-                        : documentsSignalRConnection.off(topicName),
-                }
-                : undefined,
-            instanceChanges: instancesSignalRConnection
-                ? {
-                    subscribe: (topicName, callback) => instancesSignalRConnection.on(topicName, callback),
-                    unsubscribe: (topicName, callback) => callback
-                        ? instancesSignalRConnection.off(topicName, callback)
-                        : instancesSignalRConnection.off(topicName),
-                }
-                : undefined,
+            documentChanges: {
+                subscribe: (topicName, callback) => {
+                    var _a;
+                    const [objectId, instanceId] = topicName.split('/');
+                    (_a = notifications.documentChanges) === null || _a === void 0 ? void 0 : _a.subscribe(objectId, instanceId, callback);
+                },
+                unsubscribe: (topicName, callback) => {
+                    var _a;
+                    const [objectId, instanceId] = topicName.split('/');
+                    (_a = notifications.documentChanges) === null || _a === void 0 ? void 0 : _a.unsubscribe(objectId, instanceId, callback);
+                },
+            },
+            instanceChanges: {
+                subscribe: (objectId, callback) => {
+                    var _a;
+                    // If there is already a wrapper for the given callback, we must reuse the
+                    // same one.  Otherwise, if we overwrite the entry in our cache, we'll lose
+                    // track of the original wrapper.
+                    let wrapper = instanceCallbacks.get(callback);
+                    if (!wrapper) {
+                        wrapper = (...changes) => {
+                            callback(...changes.map((change) => change.instanceId));
+                        };
+                        instanceCallbacks.set(callback, wrapper);
+                    }
+                    (_a = notifications.instanceChanges) === null || _a === void 0 ? void 0 : _a.subscribe(objectId, wrapper);
+                },
+                unsubscribe: (objectId, callback) => {
+                    var _a;
+                    (_a = notifications.instanceChanges) === null || _a === void 0 ? void 0 : _a.unsubscribe(objectId, callback && instanceCallbacks.get(callback));
+                },
+            },
         }, children: children }));
 }
 export function useSignalRConnection() {
+    console.warn('Use of useSignalRConnection is deprecated. Use useNotification instead.');
     return useContext(SignalRConnectionContext);
 }
 export default SignalRConnectionProvider;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@evoke-platform/context",
-    "version": "1.0.0-dev.112",
+    "version": "1.0.0-dev.113",
     "description": "Utilities that provide context to Evoke platform widgets",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -37,20 +37,25 @@
     "devDependencies": {
         "@azure/msal-browser": "^2.38.4",
         "@azure/msal-react": "^1.5.9",
+        "@testing-library/dom": "^10.4.0",
+        "@testing-library/react": "^16.0.1",
         "@types/chai": "^4.3.11",
         "@types/dirty-chai": "^2.0.4",
         "@types/mocha": "^10.0.6",
         "@types/node": "^18.15.7",
         "@types/react": "^18.2.28",
-        "@types/uuid": "^9.0.8",
         "@types/sinon": "^17.0.3",
+        "@types/uuid": "^9.0.8",
         "chai": "^4.4.1",
         "commit-and-tag-version": "^12.1.0",
         "dirty-chai": "^2.0.1",
         "eslint-plugin-react": "^7.33.2",
+        "global-jsdom": "^25.0.0",
+        "jsdom": "^25.0.1",
         "mocha": "^10.2.0",
         "msw": "^1.3.1",
         "react": "^18.2.0",
+        "react-dom": "^18.3.1",
         "react-router-dom": "^6.16.0",
         "sinon": "^18.0.0",
         "typescript": "^5.3.3"