@evoke-platform/context 1.0.0-dev.101 → 1.0.0-dev.102

package/README.md

@@ -160,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
 

package/dist/app/AppProvider.d.ts

@@ -38,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,13 +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';
+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 defaultPage.slug;
+            }
+        }), [app]) });
+    return _jsx(AppContext.Provider, { value: appExtended, children: children });
 }
 export function useApp() {
     return useContext(AppContext);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@evoke-platform/context",
-    "version": "1.0.0-dev.101",
+    "version": "1.0.0-dev.102",
     "description": "Utilities that provide context to Evoke platform widgets",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",