@trackunit/react-core-hooks 0.2.209 → 0.2.212

package/index.cjs.js

@@ -294,6 +294,60 @@ const useImageUploader = () => {
     };
 };
 
+/**
+ * Returns the query string to be appended to the URL when the app is served from a Feature Branch.
+ */
+const useFeatureBranchQueryString = () => {
+    const { publicUrl, buildVersion } = useEnvironment();
+    const featureBranchQueryParam = React.useMemo(() => !publicUrl || publicUrl === "/" ? "" : `?fb_url=${encodeURIComponent(publicUrl)}&fb_version=${buildVersion}`, [publicUrl, buildVersion]);
+    return { featureBranchQueryParam };
+};
+
+const IRIS_APP_ASSET_PATH = "assets/";
+/**
+ * Provides functions to get the Iris App URL and logo image.
+ *
+ * @requires EnvironmentContextProvider, TokenProvider
+ * @returns {getAppUrl, getAppImage}
+ * @example
+ * const { getAppUrl, getAppImage } = useIrisAppImage();
+ * const irisAppUrl = getAppUrl({ irisAppId, version });
+ * const { logo } = await getAppImage({ irisAppUrl, logoPath });
+ */
+const useIrisAppImage = () => {
+    const { irisAppSdkServerUrl, tracingHeaders } = useEnvironment();
+    const { featureBranchQueryParam } = useFeatureBranchQueryString();
+    const { token } = useToken();
+    // Add Auth headers to all fetch requests
+    const headers = React.useMemo(() => (Object.assign(Object.assign({}, tracingHeaders), { "commit-number": `${tracingHeaders["commit-number"]}`, "Content-Type": "application/json", Authorization: `Bearer ${token}` })), [token, tracingHeaders]);
+    /**
+     * Returns the URL to the Iris App SDK server for the given Iris App ID and version.
+     * If the APP is served from localhost or a Feature Branch, the URL will be part of the App Entry.
+     * In that case, do not use this function, but use the url from the App Entry instead.
+     */
+    const getAppUrl = React.useCallback(({ irisAppId, version }) => {
+        return `${irisAppSdkServerUrl}app/${irisAppId}@${version}/`;
+    }, [irisAppSdkServerUrl]);
+    /**
+     * Given the Iris App URL and logo path, returns the URLs to the logo.
+     * The returned URLs are blob URLs, which can be used as src for <img> tags.
+     * If the APP is served from localhost or a Feature Branch, the URLs will be part of the App Entry.
+     * If the url does not exist in the App Entry, use the getIrisAppUrl function to get the URL.
+     */
+    const getAppImage = React.useCallback((_a) => __awaiter(void 0, [_a], void 0, function* ({ irisAppUrl, logoPath }) {
+        if (!logoPath) {
+            return null;
+        }
+        const logoFetchUrl = `${irisAppUrl}${IRIS_APP_ASSET_PATH}${logoPath}${featureBranchQueryParam}`;
+        const logoImageUrl = yield fetchAssetBlobUrl(logoFetchUrl, headers);
+        return logoImageUrl;
+    }), [featureBranchQueryParam, headers]);
+    return {
+        getAppUrl,
+        getAppImage,
+    };
+};
+
 const OemBrandingContext = React.createContext(null);
 /**
  * This is a hook to use the IOemBrandingContext.
@@ -680,15 +734,6 @@ const useToast = () => {
     return toastContext;
 };
 
-/**
- * Returns the query string to be appended to the URL when the app is served from a Feature Branch.
- */
-const useFeatureBranchQueryString = () => {
-    const { publicUrl, buildVersion } = useEnvironment();
-    const featureBranchQueryParam = React.useMemo(() => !publicUrl || publicUrl === "/" ? "" : `?fb_url=${encodeURIComponent(publicUrl)}&fb_version=${buildVersion}`, [publicUrl, buildVersion]);
-    return { featureBranchQueryParam };
-};
-
 /**
  * Hook for filtering a list of items by text search, client side search in a list.
  *
@@ -851,6 +896,7 @@ exports.useFilterBarContext = useFilterBarContext;
 exports.useHasAccessTo = useHasAccessTo;
 exports.useImageUploader = useImageUploader;
 exports.useIrisAppId = useIrisAppId;
+exports.useIrisAppImage = useIrisAppImage;
 exports.useIrisAppName = useIrisAppName;
 exports.useModalDialogContext = useModalDialogContext;
 exports.useNavigateInHost = useNavigateInHost;

package/index.esm.js

@@ -1,5 +1,5 @@
 import * as React from 'react';
-import { createContext, useContext, useState, useCallback, useEffect, useMemo } from 'react';
+import { createContext, useContext, useState, useCallback, useMemo, useEffect } from 'react';
 import { jsx } from 'react/jsx-runtime';
 import { AssetRuntime, CustomerRuntime, EventRuntime, ParamsRuntime, SiteRuntime } from '@trackunit/iris-app-runtime-core';
 import { filterByMultiple } from '@trackunit/shared-utils';
@@ -271,6 +271,60 @@ const useImageUploader = () => {
     };
 };
 
+/**
+ * Returns the query string to be appended to the URL when the app is served from a Feature Branch.
+ */
+const useFeatureBranchQueryString = () => {
+    const { publicUrl, buildVersion } = useEnvironment();
+    const featureBranchQueryParam = useMemo(() => !publicUrl || publicUrl === "/" ? "" : `?fb_url=${encodeURIComponent(publicUrl)}&fb_version=${buildVersion}`, [publicUrl, buildVersion]);
+    return { featureBranchQueryParam };
+};
+
+const IRIS_APP_ASSET_PATH = "assets/";
+/**
+ * Provides functions to get the Iris App URL and logo image.
+ *
+ * @requires EnvironmentContextProvider, TokenProvider
+ * @returns {getAppUrl, getAppImage}
+ * @example
+ * const { getAppUrl, getAppImage } = useIrisAppImage();
+ * const irisAppUrl = getAppUrl({ irisAppId, version });
+ * const { logo } = await getAppImage({ irisAppUrl, logoPath });
+ */
+const useIrisAppImage = () => {
+    const { irisAppSdkServerUrl, tracingHeaders } = useEnvironment();
+    const { featureBranchQueryParam } = useFeatureBranchQueryString();
+    const { token } = useToken();
+    // Add Auth headers to all fetch requests
+    const headers = useMemo(() => (Object.assign(Object.assign({}, tracingHeaders), { "commit-number": `${tracingHeaders["commit-number"]}`, "Content-Type": "application/json", Authorization: `Bearer ${token}` })), [token, tracingHeaders]);
+    /**
+     * Returns the URL to the Iris App SDK server for the given Iris App ID and version.
+     * If the APP is served from localhost or a Feature Branch, the URL will be part of the App Entry.
+     * In that case, do not use this function, but use the url from the App Entry instead.
+     */
+    const getAppUrl = useCallback(({ irisAppId, version }) => {
+        return `${irisAppSdkServerUrl}app/${irisAppId}@${version}/`;
+    }, [irisAppSdkServerUrl]);
+    /**
+     * Given the Iris App URL and logo path, returns the URLs to the logo.
+     * The returned URLs are blob URLs, which can be used as src for <img> tags.
+     * If the APP is served from localhost or a Feature Branch, the URLs will be part of the App Entry.
+     * If the url does not exist in the App Entry, use the getIrisAppUrl function to get the URL.
+     */
+    const getAppImage = useCallback((_a) => __awaiter(void 0, [_a], void 0, function* ({ irisAppUrl, logoPath }) {
+        if (!logoPath) {
+            return null;
+        }
+        const logoFetchUrl = `${irisAppUrl}${IRIS_APP_ASSET_PATH}${logoPath}${featureBranchQueryParam}`;
+        const logoImageUrl = yield fetchAssetBlobUrl(logoFetchUrl, headers);
+        return logoImageUrl;
+    }), [featureBranchQueryParam, headers]);
+    return {
+        getAppUrl,
+        getAppImage,
+    };
+};
+
 const OemBrandingContext = createContext(null);
 /**
  * This is a hook to use the IOemBrandingContext.
@@ -657,15 +711,6 @@ const useToast = () => {
     return toastContext;
 };
 
-/**
- * Returns the query string to be appended to the URL when the app is served from a Feature Branch.
- */
-const useFeatureBranchQueryString = () => {
-    const { publicUrl, buildVersion } = useEnvironment();
-    const featureBranchQueryParam = useMemo(() => !publicUrl || publicUrl === "/" ? "" : `?fb_url=${encodeURIComponent(publicUrl)}&fb_version=${buildVersion}`, [publicUrl, buildVersion]);
-    return { featureBranchQueryParam };
-};
-
 /**
  * Hook for filtering a list of items by text search, client side search in a list.
  *
@@ -797,4 +842,4 @@ const useCurrentUser = () => {
     return context;
 };
 
-export { AnalyticsContext, AnalyticsContextProvider, AssetSortingProvider, ConfirmationDialogProvider, CurrentUserPreferenceProvider, CurrentUserProvider, EnvironmentContextProvider, FilterBarProvider, ModalDialogContextProvider, NavigationContextProvider, OemBrandingContextProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, fetchAssetBlobUrl, useAnalytics, useAssetRuntime, useAssetSorting, useConfirmationDialog, useCurrentUser, useCurrentUserLanguage, useCurrentUserSystemOfMeasurement, useCurrentUserTimeZonePreference, useCustomerRuntime, useEnvironment, useEventRuntime, useFeatureBranchQueryString, useFilterBarContext, useHasAccessTo, useImageUploader, useIrisAppId, useIrisAppName, useModalDialogContext, useNavigateInHost, useOemBrandingContext, useSiteRuntime, useTextSearch, useToast, useToken, useUserSubscription };
+export { AnalyticsContext, AnalyticsContextProvider, AssetSortingProvider, ConfirmationDialogProvider, CurrentUserPreferenceProvider, CurrentUserProvider, EnvironmentContextProvider, FilterBarProvider, ModalDialogContextProvider, NavigationContextProvider, OemBrandingContextProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, fetchAssetBlobUrl, useAnalytics, useAssetRuntime, useAssetSorting, useConfirmationDialog, useCurrentUser, useCurrentUserLanguage, useCurrentUserSystemOfMeasurement, useCurrentUserTimeZonePreference, useCustomerRuntime, useEnvironment, useEventRuntime, useFeatureBranchQueryString, useFilterBarContext, useHasAccessTo, useImageUploader, useIrisAppId, useIrisAppImage, useIrisAppName, useModalDialogContext, useNavigateInHost, useOemBrandingContext, useSiteRuntime, useTextSearch, useToast, useToken, useUserSubscription };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-hooks",
-  "version": "0.2.209",
+  "version": "0.2.212",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {

package/src/index.d.ts

@@ -5,6 +5,7 @@ export * from "./environment/EnvironmentContextProvider";
 export * from "./fetchAssetBlobUrl";
 export * from "./filter-bar/FilterBarProvider";
 export * from "./images/useImageUploader";
+export * from "./images/useIrisAppImage";
 export * from "./irisOemApp/IrisOemAppContextProvider";
 export * from "./modalDialog/ModalDialogProvider";
 export * from "./navigation/NavigationContextProvider";