@evoke-platform/context 1.0.0-dev.12 → 1.0.0-dev.121

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
 
@@ -68,7 +68,8 @@ const results = await applications.findInstances();
 
 ##### `get(options)`
 
-Get the object definition for this store's object.
+Get the object definition for this store's object. The returned object includes inherited properties and actions if
+this object is derived from another object.
 
 -   `options` _[object]_ - _optional_
     -   `sanitized` _[boolean]_
@@ -159,7 +160,16 @@ Returns a function that can be used to navigate to another page. The returned fu
 
 #### `useApp()`
 
-Returns the currently loaded Evoke app.
+Returns the currently loaded Evoke App as well as the following function.
+
+-   `findDefaultPageSlugFor`: An asynchronous function that takes an `objectId` as a parameter and returns the default page slug for that object, if no default page slug is found and the object is a subtype, the page slug of the first ancestor with a default page will be used. It returns `undefined` if no default page slug is found for any ancestor type.
+
+Example usage:
+
+```javascript
+const { id: appId, findDefaultPageSlugFor } = useApp();
+const defaultPageSlug = await findDefaultPageSlugFor(objectId);
+```
 
 ### REST API calls
 
@@ -196,18 +206,117 @@ absolute URL.
 
 ##### `delete(url, options)`
 
-### SignalR Connection
+### Notifications
+
+-   [useNofitication](#usenotification)
+    -   [documentChanges](#documentchangessubscribeobjectidinstanceid-data-documentchange)
+    -   [instanceChanges](#instancechangessubscribeobjectid-instanceids-instancechange)
+-   [useSignalRConnection](#usesignalrconnection) (_Deprecated_)
+    -   [documentChanges](#documentchangessubscribeobjectidinstanceid-data-documentchange) (_Deprecated_)
+    -   [instanceChanges](#instancechangessubscribeobjectid-instanceids-instancechange) (_Deprecated_)
+
+#### `useNofitication()`
+
+Hook used to obtain an instanceChanges instance and a documentChanges instance.
+
+##### `documentChanges.subscribe(objectId, instanceId, (data: DocumentChange[]]) => {})`
+
+Subscribe to the specified object instance changes.
+
+```javascript
+const { documentChanges } = useNotification();
+
+documentChanges.subscribe('myObjectId', 'myInstanceId', (data) => {
+    console.log(data);
+});
+```
+
+The data provided to the callback will be an array of `DocumentChange` which contains the
+following data:
+
+-   `objectId`
+    -   Object describing the instance associated with the updated document.
+-   `instanceId`
+    -   Instance that the updated document is associated with.
+-   `documentId`
+    -   Document that was updated.
+-   `type`
+    -   The type of update. Possible values are `BlobCreated`, `BlobDeleted`, and `BlobMetadataUpdated`.
+
+##### `documentChanges.unsubscribe(objectId, instanceId, (changes: DocumentChange[]) => {})`
+
+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 } = useNotification();
+
+const callback = (changes: DocumentChange[]) => {
+    console.log(changes);
+};
+
+documentChanges.subscribe('myObjectId', 'myInstanceId', callback);
+
+documentChanges.unsubscribe('myObjectId', 'myInstanceId', callback);
+```
+
+##### `instanceChanges.subscribe(objectId, (changes: InstanceChange[]) => {})`
+
+Subscribe to the specified object changes.
+
+```javascript
+const { instanceChanges } = useNotification();
+
+instanceChanges.subscribe('myObjectId', (changes) => {
+    console.log(changes);
+});
+```
+
+The data provided to the callback will be an array of `InstanceChange` which contains the
+following data:
+
+-   `objectId`
+    -   Object describing the instance associated with the updated document.
+-   `instanceId`
+    -   Instance that the updated document is associated with.
+
+##### `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.
 
--   [useSignalRConnection](#usesignalrconnection)
-    -   [documentChanges](#documentchanges)
-    -   [instanceChanges](#instancechanges)
+```javascript
+const { instanceChanges } = useNotification();
+
+const callback = (changes: InstanceChange[]) => {
+    console.log(changes);
+};
+
+instanceChanges.subscribe('myObjectId', callback);
+
+instanceChanges.unsubscribe('myObjectId', callback);
+```
 
 #### `useSignalRConnection()`
 
+> **Deprecated**
+> This has been deprecated in favor of [useNotification](#usenofitication).
+
 Hook used to obtain an instanceChanges instance of `SignalRConnection` and a documentChanges instance of `SignalRConnection`.
 
 ##### `documentChanges.subscribe('{objectId}/{instanceId}', (data: DocumentChange[]]) => {})`
 
+> **Deprecated**
+> This has been deprecated in favor of [useNotification](#usenofitication).
+
 Subscribe to the specified object instance document changes.
 
 ```javascript
@@ -218,8 +327,23 @@ documentChanges.subscribe('myObjectId/myInstanceId', (data) => {
 });
 ```
 
+The data provided to the callback will be an array of `DocumentChange` which contains the
+following data:
+
+-   `objectId`
+    -   Object describing the instance associated with the updated document.
+-   `instanceId`
+    -   Instance that the updated document is associated with.
+-   `documentId`
+    -   Document that was updated.
+-   `type`
+    -   The type of update. Possible values are `BlobCreated`, `BlobDeleted`, and `BlobMetadataUpdated`.
+
 ##### `documentChanges.unsubscribe('{objectId}/{instanceId}', (data: DocumentChange[]) => {})`
 
+> **Deprecated**
+> This has been deprecated in favor of [useNotification](#usenofitication).
+
 Unsubscribe to the specified object instance document changes.
 
 Callback function is optional.
@@ -240,6 +364,9 @@ documentChanges.unsubscribe('myObjectId/myInstanceId', callback);
 
 ##### `instanceChanges.subscribe('{objectId}', (instanceIds: InstanceChange[]) => {})`
 
+> **Deprecated**
+> This has been deprecated in favor of [useNotification](#usenofitication).
+
 Subscribe to the specified object instance changes.
 
 ```javascript
@@ -250,8 +377,13 @@ instanceChanges.subscribe('myObjectId', (instanceIds) => {
 });
 ```
 
+The data provided to the callback will be an array of instance IDs that were updated.
+
 ##### `instanceChanges.unsubscribe('{objectId}', (instanceIds: InstanceChange[]) => {})`
 
+> **Deprecated**
+> This has been deprecated in favor of [useNotification](#usenofitication).
+
 Unsubscribe to the specified object instance changes.
 
 Callback function is optional.

package/dist/api/ApiBaseUrlProvider.js

@@ -13,4 +13,3 @@ export function useApiBaseUrl() {
     return useContext(ApiBaseUrlContext);
 }
 export default ApiBaseUrlProvider;
-//# sourceMappingURL=ApiBaseUrlProvider.js.map

package/dist/api/apiServices.js

@@ -11,20 +11,23 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import axios from 'axios';
 import { useMemo } from 'react';
+import { v4 as uuidv4 } from 'uuid';
 import { useAuthenticationContext } from '../authentication/AuthenticationContextProvider.js';
 import { useApiBaseUrl } from './ApiBaseUrlProvider.js';
+import { paramsSerializer } from './paramsSerializer.js';
+const sessionId = uuidv4();
 export class ApiServices {
     constructor(api, authContext) {
         this.api = api;
-        if (authContext) {
-            this.api.interceptors.request.use((config) => __awaiter(this, void 0, void 0, function* () {
+        this.api.interceptors.request.use((config) => __awaiter(this, void 0, void 0, function* () {
+            const headers = { 'X-Session-Id': sessionId };
+            if (authContext) {
                 const token = yield authContext.getAccessToken();
-                config.headers = Object.assign({}, config.headers, {
-                    Authorization: `Bearer ${token}`,
-                });
-                return config;
-            }));
-        }
+                headers['Authorization'] = `Bearer ${token}`;
+            }
+            config.headers = Object.assign({}, config.headers, headers);
+            return config;
+        }));
     }
     promiseOrCallback(promise, cb) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -141,7 +144,6 @@ export class ApiServices {
 export function useApiServices() {
     const authContext = useAuthenticationContext();
     const baseURL = useApiBaseUrl();
-    const apiServices = useMemo(() => new ApiServices(axios.create({ baseURL }), authContext), [authContext, baseURL]);
+    const apiServices = useMemo(() => new ApiServices(axios.create({ baseURL, paramsSerializer }), authContext), [authContext, baseURL]);
     return apiServices;
 }
-//# sourceMappingURL=apiServices.js.map

package/dist/api/callback.js

@@ -10,4 +10,3 @@ export function callback(onSuccess, onError) {
         }
     };
 }
-//# sourceMappingURL=callback.js.map

package/dist/api/index.js

@@ -4,4 +4,3 @@ export * from './ApiBaseUrlProvider.js';
 export { default as ApiBaseUrlProvider } from './ApiBaseUrlProvider.js';
 export * from './apiServices.js';
 export * from './callback.js';
-//# sourceMappingURL=index.js.map

package/dist/api/paramsSerializer.d.ts

@@ -0,0 +1,2 @@
+import { ParamsSerializerOptions } from 'axios';
+export declare function paramsSerializer(params: Record<string, unknown>, options?: ParamsSerializerOptions): string;

package/dist/api/paramsSerializer.js

@@ -0,0 +1,7 @@
+export function paramsSerializer(params, options) {
+    const searchParams = new URLSearchParams();
+    for (const [key, value] of Object.entries(params)) {
+        searchParams.append(key, typeof value !== 'string' ? JSON.stringify(value) : value);
+    }
+    return searchParams.toString();
+}

package/dist/app/AppProvider.d.ts

@@ -10,10 +10,12 @@ export type App = {
     iconColor?: string;
     pages?: Page[];
     navigation?: NavigationMenu;
+    defaultPages?: Record<string, string>;
 };
 export type Page = {
     id: string;
     name: string;
+    slug?: string;
     children?: PageElement[];
 };
 export type PageElement = Container | Widget;
@@ -36,10 +38,19 @@ export type NavigationItem = {
     pageId: string;
     pageName: string;
 };
+export type AppExtended = App & {
+    /**
+     * Looks up the default page slug for a given object or its nearest type ancestor.
+     *
+     * @param {string} objectId - The ID of the object to start the search from.
+     * @returns {Promise<string | undefined>} The default page slug, or `undefined` if no default page is found.
+     */
+    findDefaultPageSlugFor: (objectId: string) => Promise<string | undefined>;
+};
 export type AppProviderProps = {
     app: App;
     children?: ReactNode;
 };
 declare function AppProvider(props: AppProviderProps): import("react/jsx-runtime").JSX.Element;
-export declare function useApp(): App;
+export declare function useApp(): AppExtended;
 export default AppProvider;

package/dist/app/AppProvider.js

@@ -1,16 +1,62 @@
+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 { createContext, useContext } from 'react';
-const defaultApp = { id: '_evoke', name: 'Evoke Platform', type: 'public' };
-const AppContext = createContext(defaultApp);
+import { createContext, useCallback, useContext } from 'react';
+import { useApiServices } from '../api/index.js';
+const defaultApp = {
+    id: '_evoke',
+    name: 'Evoke Platform',
+    type: 'public',
+};
+const defaultAppExtended = Object.assign(Object.assign({}, defaultApp), { findDefaultPageSlugFor: (objectId) => Promise.resolve(undefined) });
+const AppContext = createContext(defaultAppExtended);
 AppContext.displayName = 'AppContext';
 function AppProvider(props) {
     const { app, children } = props;
-    return _jsx(AppContext.Provider, { value: app, children: children });
+    const apiServices = useApiServices();
+    const appExtended = Object.assign(Object.assign({}, app), { findDefaultPageSlugFor: useCallback((objectId) => __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d;
+            let defaultPageId;
+            let currentObjectId = objectId;
+            while (currentObjectId !== undefined) {
+                if ((_a = app.defaultPages) === null || _a === void 0 ? void 0 : _a[currentObjectId]) {
+                    defaultPageId = app.defaultPages[currentObjectId];
+                    break;
+                }
+                const effectiveObject = yield apiServices.get(`data/objects/${currentObjectId}/effective`, {
+                    params: { filter: { fields: ['baseObject'] } },
+                });
+                currentObjectId = (_c = (_b = effectiveObject === null || effectiveObject === void 0 ? void 0 : effectiveObject.baseObject) === null || _b === void 0 ? void 0 : _b.objectId) !== null && _c !== void 0 ? _c : undefined;
+            }
+            let defaultPage;
+            if (defaultPageId) {
+                const pageId = defaultPageId.includes('/')
+                    ? defaultPageId.split('/').slice(2).join('/')
+                    : defaultPageId;
+                try {
+                    defaultPage = yield apiServices.get(`/webContent/apps/${app.id}/pages/${encodeURIComponent(encodeURIComponent(pageId))}`);
+                }
+                catch (error) {
+                    const err = error;
+                    if (((_d = err.response) === null || _d === void 0 ? void 0 : _d.status) === 404) {
+                        defaultPage = undefined;
+                    }
+                }
+            }
+            if (defaultPage === null || defaultPage === void 0 ? void 0 : defaultPage.slug) {
+                return `/${app.id}/${defaultPage.slug}`;
+            }
+        }), [app]) });
+    return _jsx(AppContext.Provider, { value: appExtended, children: children });
 }
 export function useApp() {
     return useContext(AppContext);
 }
 export default AppProvider;
-//# sourceMappingURL=AppProvider.js.map

package/dist/app/index.js

@@ -2,4 +2,3 @@
 // This file is licensed under the MIT License.
 export * from './AppProvider.js';
 export { default as AppProvider } from './AppProvider.js';
-//# sourceMappingURL=index.js.map

package/dist/authentication/AuthenticationContextProvider.js

@@ -31,7 +31,10 @@ function AuthenticationContextProvider(props) {
         ? {
             account: { id: account.localAccountId, name: account.name },
             logout: () => {
-                msal.instance.logoutRedirect({ account });
+                msal.instance.logoutRedirect({
+                    account,
+                    postLogoutRedirectUri: `/logout?p=${encodeURIComponent(window.location.pathname + window.location.search)}`,
+                });
             },
             getAccessToken,
         }
@@ -42,4 +45,3 @@ export function useAuthenticationContext() {
     return useContext(Context);
 }
 export default AuthenticationContextProvider;
-//# sourceMappingURL=AuthenticationContextProvider.js.map

package/dist/authentication/index.js

@@ -2,4 +2,3 @@
 // This file is licensed under the MIT License.
 export * from './AuthenticationContextProvider.js';
 export { default as AuthenticationContextProvider } from './AuthenticationContextProvider.js';
-//# sourceMappingURL=index.js.map

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 export * from './api/index.js';
 export * from './app/index.js';
 export * from './authentication/index.js';
+export * from './notification/index.js';
 export * from './objects/index.js';
 export * from './router/index.js';
 export * from './signalr/index.js';

package/dist/index.js

@@ -3,7 +3,7 @@
 export * from './api/index.js';
 export * from './app/index.js';
 export * from './authentication/index.js';
+export * from './notification/index.js';
 export * from './objects/index.js';
 export * from './router/index.js';
 export * from './signalr/index.js';
-//# sourceMappingURL=index.js.map

package/dist/notification/NotificationProvider.d.ts

@@ -0,0 +1,33 @@
+import React from 'react';
+export type NotificationConnectionInfo = {
+    url: string;
+    accessToken: string;
+};
+export type InstanceSubscription = {
+    subscribe: (objectId: string, callback: (...args: NotificationInstanceChange[]) => void) => void;
+    unsubscribe: (objectId: string, callback?: (...args: NotificationInstanceChange[]) => void) => void;
+};
+export type DocumentSubscription = {
+    subscribe: (objectId: string, instanceId: string | undefined, callback: (...args: NotificationDocumentChange[]) => void) => void;
+    unsubscribe: (objectId: string, instanceId: string | undefined, callback?: (...args: NotificationDocumentChange[]) => void) => void;
+};
+export type NotificationDocumentChange = {
+    objectId: string;
+    instanceId: string;
+    documentId: string;
+    type: string;
+};
+export type NotificationInstanceChange = {
+    objectId: string;
+    instanceId: string;
+};
+export type NotificationContextType = {
+    documentChanges?: DocumentSubscription;
+    instanceChanges?: InstanceSubscription;
+};
+export declare const NotificationContext: React.Context<NotificationContextType>;
+declare function NotificationProvider({ children }: {
+    children: React.ReactNode;
+}): import("react/jsx-runtime").JSX.Element;
+export declare function useNotification(): NotificationContextType;
+export default NotificationProvider;

package/dist/notification/NotificationProvider.js

@@ -0,0 +1,134 @@
+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";
+import { HubConnectionBuilder, LogLevel, } from '@microsoft/signalr';
+import { createContext, useContext, useEffect, useState } from 'react';
+import { useApiServices } from '../api/index.js';
+export const NotificationContext = createContext({});
+NotificationContext.displayName = 'NotificationContext';
+function NotificationProvider({ children }) {
+    const [instancesNotification, setInstancesNotification] = useState();
+    const [documentsNotification, setDocumentsNotification] = useState();
+    const api = useApiServices();
+    useEffect(() => {
+        const getConnectionInfo = (hubName) => {
+            return api.post(`/notification/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: () => {
+                            var _a;
+                            return (_a = instancesConnectionInfo.accessToken) !== null && _a !== void 0 ? _a : '';
+                        },
+                    };
+                    const connection = new HubConnectionBuilder()
+                        .withUrl(instancesConnectionInfo.url, options)
+                        .configureLogging(LogLevel.Error)
+                        .withAutomaticReconnect()
+                        .build();
+                    setInstancesNotification(connection);
+                }
+                if (documentsConnectionInfo) {
+                    const options = {
+                        accessTokenFactory: () => {
+                            var _a;
+                            return (_a = documentsConnectionInfo.accessToken) !== null && _a !== void 0 ? _a : '';
+                        },
+                    };
+                    const connection = new HubConnectionBuilder()
+                        .withUrl(documentsConnectionInfo.url, options)
+                        .configureLogging(LogLevel.Error)
+                        .withAutomaticReconnect()
+                        .build();
+                    setDocumentsNotification(connection);
+                }
+                // eslint-disable-next-line no-empty
+            }
+            catch (err) {
+                console.log(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 Notification Service due to error "${error}"`);
+                }
+            });
+        });
+        if (documentsNotification) {
+            startConnection(documentsNotification, 0);
+        }
+        return () => {
+            documentsNotification === null || documentsNotification === void 0 ? void 0 : documentsNotification.stop();
+            documentsConnectionStopped = true;
+        };
+    }, [documentsNotification]);
+    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 Notification Service due to error "${error}"`);
+                }
+            });
+        });
+        if (instancesNotification) {
+            startConnection(instancesNotification, 0);
+        }
+        return () => {
+            instancesNotification === null || instancesNotification === void 0 ? void 0 : instancesNotification.stop();
+            instancesConnectionStopped = true;
+        };
+    }, [instancesNotification]);
+    return (_jsx(NotificationContext.Provider, { value: {
+            documentChanges: documentsNotification
+                ? {
+                    subscribe: (objectId, instanceId, callback) => documentsNotification.on(`${objectId}/${instanceId}`, callback),
+                    unsubscribe: (objectId, instanceId, callback) => callback
+                        ? documentsNotification.off(`${objectId}/${instanceId}`, callback)
+                        : documentsNotification.off(`${objectId}/${instanceId}`),
+                }
+                : undefined,
+            instanceChanges: instancesNotification
+                ? {
+                    subscribe: (objectId, callback) => instancesNotification.on(objectId, callback),
+                    unsubscribe: (objectId, callback) => callback
+                        ? instancesNotification.off(objectId, callback)
+                        : instancesNotification.off(objectId),
+                }
+                : undefined,
+        }, children: children }));
+}
+export function useNotification() {
+    return useContext(NotificationContext);
+}
+export default NotificationProvider;

package/dist/notification/index.d.ts

@@ -0,0 +1,2 @@
+export * from './NotificationProvider.js';
+export { default as NotificationProvider } from './NotificationProvider.js';

package/dist/notification/index.js

@@ -0,0 +1,2 @@
+export * from './NotificationProvider.js';
+export { default as NotificationProvider } from './NotificationProvider.js';

package/dist/objects/filters.js

@@ -1,4 +1,3 @@
 // Copyright (c) 2023 System Automation Corporation.
 // This file is licensed under the MIT License.
 export {};
-//# sourceMappingURL=filters.js.map

package/dist/objects/index.js

@@ -2,4 +2,3 @@
 // This file is licensed under the MIT License.
 export * from './filters.js';
 export * from './objects.js';
-//# sourceMappingURL=index.js.map