@trackunit/react-core-contexts-api 0.2.67 → 0.2.69

package/index.cjs.js

@@ -102,6 +102,29 @@ exports.SortOrder = void 0;
     SortOrder["Desc"] = "DESC";
 })(exports.SortOrder || (exports.SortOrder = {}));
 
+const assetHomePageIds = [
+    "status",
+    "movement",
+    "events",
+    "insights",
+    "specification",
+    "telematics",
+    "activity-timeline",
+];
+const siteHomePageIds = ["overview", "assets", "asset-visibility"];
+/**
+ * type guard for IrisAppOptions
+ */
+const isIrisOptions = (options) => {
+    if (!options) {
+        return false;
+    }
+    return (typeof options === "object" &&
+        ("irisAppId") in options &&
+        Boolean(options.irisAppId) &&
+        ("extensionId") in options);
+};
+
 const UserSubscriptionPackage = {
     EXPLORE_FLEET_OWNER: "Explore (Fleet Owner)",
     EVOLVE_FLEET_OWNER: "Evolve (Fleet Owner)",
@@ -118,5 +141,8 @@ const UserSubscriptionPackage = {
 exports.SystemOfMeasurement = SystemOfMeasurement;
 exports.TimeZonePreference = TimeZonePreference;
 exports.UserSubscriptionPackage = UserSubscriptionPackage;
+exports.assetHomePageIds = assetHomePageIds;
 exports.createEvent = createEvent;
+exports.isIrisOptions = isIrisOptions;
+exports.siteHomePageIds = siteHomePageIds;
 exports.validateStringAsAssetSortByProperty = validateStringAsAssetSortByProperty;

package/index.esm.js

@@ -98,6 +98,29 @@ var SortOrder;
     SortOrder["Desc"] = "DESC";
 })(SortOrder || (SortOrder = {}));
 
+const assetHomePageIds = [
+    "status",
+    "movement",
+    "events",
+    "insights",
+    "specification",
+    "telematics",
+    "activity-timeline",
+];
+const siteHomePageIds = ["overview", "assets", "asset-visibility"];
+/**
+ * type guard for IrisAppOptions
+ */
+const isIrisOptions = (options) => {
+    if (!options) {
+        return false;
+    }
+    return (typeof options === "object" &&
+        ("irisAppId") in options &&
+        Boolean(options.irisAppId) &&
+        ("extensionId") in options);
+};
+
 const UserSubscriptionPackage = {
     EXPLORE_FLEET_OWNER: "Explore (Fleet Owner)",
     EVOLVE_FLEET_OWNER: "Evolve (Fleet Owner)",
@@ -111,4 +134,4 @@ const UserSubscriptionPackage = {
     NONE: "NONE",
 };
 
-export { AssetSortByProperty, SortOrder, SystemOfMeasurement, TimeZonePreference, UserSubscriptionPackage, createEvent, validateStringAsAssetSortByProperty };
+export { AssetSortByProperty, SortOrder, SystemOfMeasurement, TimeZonePreference, UserSubscriptionPackage, assetHomePageIds, createEvent, isIrisOptions, siteHomePageIds, validateStringAsAssetSortByProperty };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-contexts-api",
-  "version": "0.2.67",
+  "version": "0.2.69",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -9,7 +9,7 @@
   "module": "./index.esm.js",
   "main": "./index.cjs.js",
   "dependencies": {
-    "@trackunit/shared-utils": "0.0.14"
+    "@trackunit/shared-utils": "0.0.15"
   },
   "peerDependencies": {}
 }

package/src/IUserPreferencesContext.d.ts

@@ -17,3 +17,8 @@ export interface IUserPreferencesContext {
     systemOfMeasurement?: SystemOfMeasurementType;
     setSystemOfMeasurement?: (systemOfMeasurement: SystemOfMeasurementType) => void;
 }
+export interface ICurrentUserPreferenceContext {
+    getCurrentUserLanguage: () => Promise<string>;
+    getCurrentUserTimeZonePreference: () => Promise<TimeZonePreferenceType>;
+    getCurrentUserSystemOfMeasurement: () => Promise<SystemOfMeasurementType>;
+}

package/src/index.d.ts

@@ -5,6 +5,7 @@ export * from "./currentUserContext";
 export * from "./environmentContext";
 export * from "./filterBarContext";
 export * from "./globalSelectionContext";
+export * from "./navigationContext";
 export * from "./oemBrandingContext";
 export * from "./toastContext";
 export * from "./tokenContext";

package/src/navigationContext.d.ts

@@ -0,0 +1,54 @@
+export type AutocompletePreservingString = string & {};
+/**
+ * Page would often go in the sidebar. In asset home "status", "telematics" etc are pages
+ */
+type Page<TPage extends string> = {
+    page: TPage;
+} & SubPage & QueryString;
+/**
+ * SubPage allows for extra deep navigation inside of the app.
+ */
+type SubPage = {
+    subPage?: string;
+};
+type QueryString = {
+    queryString?: string;
+};
+type NeverPage = {
+    page?: never;
+};
+type NeverIrisApp = {
+    irisAppId?: never;
+    extensionId?: never;
+};
+export type IrisAppOptions = {
+    irisAppId: string;
+    extensionId: string;
+} & SubPage & QueryString & NeverPage;
+declare const mainApps: readonly ["fleet", "reports", "sites"];
+export type MainFleetApp = (typeof mainApps)[number];
+export type FleetAppStandardOptions = Page<MainFleetApp> & NeverIrisApp;
+export declare const assetHomePageIds: readonly ["status", "movement", "events", "insights", "specification", "telematics", "activity-timeline"];
+export type AssetHomePageId = (typeof assetHomePageIds)[number];
+export type AssetHomeStandardOptions = Page<AssetHomePageId> & NeverIrisApp;
+export declare const siteHomePageIds: readonly ["overview", "assets", "asset-visibility"];
+export type SiteHomePageId = (typeof siteHomePageIds)[number];
+export type SiteHomeStandardOptions = Page<SiteHomePageId> & NeverIrisApp;
+/**
+ * type guard for IrisAppOptions
+ */
+export declare const isIrisOptions: (options: IrisAppOptions | unknown) => options is IrisAppOptions;
+export type SetDeepLinkPromise = (deepLink: DeepLink) => Promise<void>;
+export type DeepLink = {
+    path: string;
+    pathname: string;
+    search: Location["search"];
+    hash: Location["hash"];
+};
+export interface INavigationContext {
+    gotoAssetHome: (assetId: string, options?: IrisAppOptions | AssetHomeStandardOptions) => Promise<boolean>;
+    gotoSiteHome: (siteId: string, options?: IrisAppOptions | SiteHomeStandardOptions) => Promise<boolean>;
+    gotoAppLibrary: (irisAppId?: string) => Promise<boolean>;
+    gotoFleetApp: (options: IrisAppOptions | FleetAppStandardOptions) => Promise<boolean>;
+}
+export {};