@trackunit/react-core-hooks 0.2.205 → 0.2.208

package/index.cjs.js

@@ -135,6 +135,55 @@ const useEnvironment = () => {
     return context;
 };
 
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+
+function __awaiter(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());
+    });
+}
+
+typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+};
+
+/**
+ * Fetch any url as a blob and return a blob url.
+ * This is used to get and display logos and images related to Iris Apps.
+ */
+const fetchAssetBlobUrl = (fullUrl, headers) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        const result = yield fetch(fullUrl, {
+            method: "GET",
+            headers,
+        });
+        const blob = yield result.blob();
+        const assetUrl = URL.createObjectURL(blob);
+        return assetUrl;
+    }
+    catch (e) {
+        return null;
+    }
+});
+
 const FilterBarContext = React__namespace.createContext(null);
 /**
  * This is a hook to use the FilterBarProvider.
@@ -287,36 +336,6 @@ const useModalDialogContext = () => {
     return modalDialogContext;
 };
 
-/******************************************************************************
-Copyright (c) Microsoft Corporation.
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-PERFORMANCE OF THIS SOFTWARE.
-***************************************************************************** */
-
-function __awaiter(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());
-    });
-}
-
-typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
-    var e = new Error(message);
-    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
-};
-
 const NavigationContext = React.createContext(null);
 /**
  * This is a provider for the NavigationContext.
@@ -661,6 +680,15 @@ 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.
  *
@@ -806,6 +834,7 @@ exports.OemBrandingContextProvider = OemBrandingContextProvider;
 exports.ToastProvider = ToastProvider;
 exports.TokenProvider = TokenProvider;
 exports.UserSubscriptionProvider = UserSubscriptionProvider;
+exports.fetchAssetBlobUrl = fetchAssetBlobUrl;
 exports.useAnalytics = useAnalytics;
 exports.useAssetRuntime = useAssetRuntime;
 exports.useAssetSorting = useAssetSorting;
@@ -817,6 +846,7 @@ exports.useCurrentUserTimeZonePreference = useCurrentUserTimeZonePreference;
 exports.useCustomerRuntime = useCustomerRuntime;
 exports.useEnvironment = useEnvironment;
 exports.useEventRuntime = useEventRuntime;
+exports.useFeatureBranchQueryString = useFeatureBranchQueryString;
 exports.useFilterBarContext = useFilterBarContext;
 exports.useHasAccessTo = useHasAccessTo;
 exports.useImageUploader = useImageUploader;

package/index.esm.js

@@ -112,6 +112,55 @@ const useEnvironment = () => {
     return context;
 };
 
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+
+function __awaiter(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());
+    });
+}
+
+typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+};
+
+/**
+ * Fetch any url as a blob and return a blob url.
+ * This is used to get and display logos and images related to Iris Apps.
+ */
+const fetchAssetBlobUrl = (fullUrl, headers) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        const result = yield fetch(fullUrl, {
+            method: "GET",
+            headers,
+        });
+        const blob = yield result.blob();
+        const assetUrl = URL.createObjectURL(blob);
+        return assetUrl;
+    }
+    catch (e) {
+        return null;
+    }
+});
+
 const FilterBarContext = React.createContext(null);
 /**
  * This is a hook to use the FilterBarProvider.
@@ -264,36 +313,6 @@ const useModalDialogContext = () => {
     return modalDialogContext;
 };
 
-/******************************************************************************
-Copyright (c) Microsoft Corporation.
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-PERFORMANCE OF THIS SOFTWARE.
-***************************************************************************** */
-
-function __awaiter(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());
-    });
-}
-
-typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
-    var e = new Error(message);
-    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
-};
-
 const NavigationContext = createContext(null);
 /**
  * This is a provider for the NavigationContext.
@@ -638,6 +657,15 @@ 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.
  *
@@ -769,4 +797,4 @@ const useCurrentUser = () => {
     return context;
 };
 
-export { AnalyticsContext, AnalyticsContextProvider, AssetSortingProvider, ConfirmationDialogProvider, CurrentUserPreferenceProvider, CurrentUserProvider, EnvironmentContextProvider, FilterBarProvider, ModalDialogContextProvider, NavigationContextProvider, OemBrandingContextProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, useAnalytics, useAssetRuntime, useAssetSorting, useConfirmationDialog, useCurrentUser, useCurrentUserLanguage, useCurrentUserSystemOfMeasurement, useCurrentUserTimeZonePreference, useCustomerRuntime, useEnvironment, useEventRuntime, 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, useIrisAppName, useModalDialogContext, useNavigateInHost, useOemBrandingContext, useSiteRuntime, useTextSearch, useToast, useToken, useUserSubscription };

package/package.json

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

package/src/analytics/AnalyticsProvider.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import { BaseEvent, Event, IAnalyticsContext } from "@trackunit/react-core-contexts-api";
-export declare const AnalyticsContext: import("react").Context<IAnalyticsContext<{}> | null>;
-export declare const AnalyticsContextProvider: import("react").Provider<IAnalyticsContext<{}> | null>;
+export declare const AnalyticsContext: import("react").Context<IAnalyticsContext<Record<string, never>> | null>;
+export declare const AnalyticsContextProvider: import("react").Provider<IAnalyticsContext<Record<string, never>> | null>;
 /**
  * Hook to get the analytics context.
  *
@@ -18,4 +18,4 @@ export declare const AnalyticsContextProvider: import("react").Provider<IAnalyti
  * logEvent("Login", { loginPage: "New Manager" });
  * @see {@link IAnalyticsContext}
  */
-export declare const useAnalytics: <T extends Record<string, Event<BaseEvent | import("@trackunit/react-core-contexts-api").AdditionalProperties>>>(type?: T) => IAnalyticsContext<T>;
+export declare const useAnalytics: <T extends Record<string, Event<BaseEvent | import("@trackunit/react-core-contexts-api").AdditionalProperties>> = never>(type?: T) => IAnalyticsContext<T>;

package/src/fetchAssetBlobUrl.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Fetch any url as a blob and return a blob url.
+ * This is used to get and display logos and images related to Iris Apps.
+ */
+export declare const fetchAssetBlobUrl: (fullUrl: string, headers: HeadersInit) => Promise<string | null>;

package/src/images/useIrisAppImage.d.ts

@@ -0,0 +1,23 @@
+interface GetIrisAppUrlParams {
+    irisAppId: string;
+    version: string;
+}
+interface GetImageAssetsParams {
+    irisAppUrl: string;
+    logoPath?: string;
+}
+/**
+ * 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 });
+ */
+export declare const useIrisAppImage: () => {
+    getAppUrl: ({ irisAppId, version }: GetIrisAppUrlParams) => string;
+    getAppImage: ({ irisAppUrl, logoPath }: GetImageAssetsParams) => Promise<string | null>;
+};
+export {};

package/src/index.d.ts

@@ -2,6 +2,7 @@ export * from "./analytics/AnalyticsProvider";
 export * from "./assetSorting/AssetSortingProvider";
 export * from "./confirmationDialog/ConfirmationDialogProvider";
 export * from "./environment/EnvironmentContextProvider";
+export * from "./fetchAssetBlobUrl";
 export * from "./filter-bar/FilterBarProvider";
 export * from "./images/useImageUploader";
 export * from "./irisOemApp/IrisOemAppContextProvider";
@@ -15,6 +16,7 @@ export * from "./runtimes/useSiteRuntime";
 export * from "./subscription/UserSubscriptionProvider";
 export * from "./toast/ToastProvider";
 export * from "./token/TokenProvider";
+export * from "./useFeatureBranchQueryString";
 export * from "./useTextSearch";
 export * from "./user/CurrentUserPreferenceProvider";
 export * from "./user/CurrentUserProvider";

package/src/useFeatureBranchQueryString.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Returns the query string to be appended to the URL when the app is served from a Feature Branch.
+ */
+export declare const useFeatureBranchQueryString: () => {
+    featureBranchQueryParam: string;
+};