@trackunit/iris-app-runtime-core-api 0.3.73 → 0.3.75

package/index.cjs.js

@@ -2,15 +2,15 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-exports.AssetHomeSubPage = void 0;
-(function (AssetHomeSubPage) {
-    AssetHomeSubPage["MOVEMENT"] = "movement";
-    AssetHomeSubPage["EVENTS"] = "events";
-    AssetHomeSubPage["INSIGHTS"] = "insights";
-    AssetHomeSubPage["TELEMATICS"] = "telematics";
-    AssetHomeSubPage["SPECIFICATION"] = "specification";
-    AssetHomeSubPage["ACTIVITY_TIMELINE"] = "activity-timeline";
-})(exports.AssetHomeSubPage || (exports.AssetHomeSubPage = {}));
+const assetHomePageIds = [
+    "status",
+    "movement",
+    "events",
+    "insights",
+    "specification",
+    "telematics",
+    "activity-timeline",
+];
 
 exports.CustomFieldType = void 0;
 (function (CustomFieldType) {
@@ -72,14 +72,27 @@ exports.UnitSi = void 0;
     UnitSi["hour"] = "hour";
 })(exports.UnitSi || (exports.UnitSi = {}));
 
+/**
+ * type guard for IrisAppOptions
+ */
+const isIrisOptions = (options) => {
+    if (!options) {
+        return false;
+    }
+    return (typeof options === "object" &&
+        ("irisAppId") in options &&
+        Boolean(options.irisAppId) &&
+        ("extensionId") in options);
+};
+
 exports.BodyType = void 0;
 (function (BodyType) {
     BodyType[BodyType["Json"] = 0] = "Json";
     BodyType[BodyType["FormData"] = 1] = "FormData";
 })(exports.BodyType || (exports.BodyType = {}));
 
-exports.SiteHomeSubPage = void 0;
-(function (SiteHomeSubPage) {
-    SiteHomeSubPage["INFORMATION"] = "information";
-    SiteHomeSubPage["HISTORY"] = "history";
-})(exports.SiteHomeSubPage || (exports.SiteHomeSubPage = {}));
+const siteHomePageIds = ["overview", "assets", "asset-visibility"];
+
+exports.assetHomePageIds = assetHomePageIds;
+exports.isIrisOptions = isIrisOptions;
+exports.siteHomePageIds = siteHomePageIds;

package/index.esm.js

@@ -1,12 +1,12 @@
-var AssetHomeSubPage;
-(function (AssetHomeSubPage) {
-    AssetHomeSubPage["MOVEMENT"] = "movement";
-    AssetHomeSubPage["EVENTS"] = "events";
-    AssetHomeSubPage["INSIGHTS"] = "insights";
-    AssetHomeSubPage["TELEMATICS"] = "telematics";
-    AssetHomeSubPage["SPECIFICATION"] = "specification";
-    AssetHomeSubPage["ACTIVITY_TIMELINE"] = "activity-timeline";
-})(AssetHomeSubPage || (AssetHomeSubPage = {}));
+const assetHomePageIds = [
+    "status",
+    "movement",
+    "events",
+    "insights",
+    "specification",
+    "telematics",
+    "activity-timeline",
+];
 
 var CustomFieldType;
 (function (CustomFieldType) {
@@ -68,16 +68,25 @@ var UnitSi;
     UnitSi["hour"] = "hour";
 })(UnitSi || (UnitSi = {}));
 
+/**
+ * type guard for IrisAppOptions
+ */
+const isIrisOptions = (options) => {
+    if (!options) {
+        return false;
+    }
+    return (typeof options === "object" &&
+        ("irisAppId") in options &&
+        Boolean(options.irisAppId) &&
+        ("extensionId") in options);
+};
+
 var BodyType;
 (function (BodyType) {
     BodyType[BodyType["Json"] = 0] = "Json";
     BodyType[BodyType["FormData"] = 1] = "FormData";
 })(BodyType || (BodyType = {}));
 
-var SiteHomeSubPage;
-(function (SiteHomeSubPage) {
-    SiteHomeSubPage["INFORMATION"] = "information";
-    SiteHomeSubPage["HISTORY"] = "history";
-})(SiteHomeSubPage || (SiteHomeSubPage = {}));
+const siteHomePageIds = ["overview", "assets", "asset-visibility"];
 
-export { AssetHomeSubPage, BodyType, CustomFieldType, SiteHomeSubPage, UnitSi, UnitUs };
+export { BodyType, CustomFieldType, UnitSi, UnitUs, assetHomePageIds, isIrisOptions, siteHomePageIds };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/iris-app-runtime-core-api",
-  "version": "0.3.73",
+  "version": "0.3.75",
   "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/react-core-contexts-api": "0.2.61"
+    "@trackunit/react-core-contexts-api": "0.2.62"
   },
   "peerDependencies": {}
 }

package/src/AssetRuntime.d.ts

@@ -1,11 +1,5 @@
 export interface AssetInfo {
     assetId: string;
 }
-export declare enum AssetHomeSubPage {
-    MOVEMENT = "movement",
-    EVENTS = "events",
-    INSIGHTS = "insights",
-    TELEMATICS = "telematics",
-    SPECIFICATION = "specification",
-    ACTIVITY_TIMELINE = "activity-timeline"
-}
+export declare const assetHomePageIds: readonly ["status", "movement", "events", "insights", "specification", "telematics", "activity-timeline"];
+export type AssetHomePageId = (typeof assetHomePageIds)[number];

package/src/HostConnector.d.ts

@@ -1,9 +1,10 @@
 import { FilterBarValues, IAnalyticsContextAsync, IAssetSortingContext, ICurrentUserContext, IEnvironmentContext, IGlobalSelectionContext, ITokenContext, IUserSubscriptionContext, OemBranding, OemBrandingImageType, SystemOfMeasurementType, TimeZonePreferenceType } from "@trackunit/react-core-contexts-api";
-import { AssetHomeSubPage, AssetInfo } from "./AssetRuntime";
+import { AssetInfo } from "./AssetRuntime";
 import { CurrentUserRole } from "./CurrentUserRuntime";
 import { EntityIdentity, ValueAndDefinition, ValueAndDefinitionKey } from "./CustomFieldRuntime";
+import { INavigationRuntime } from "./NavigationRuntime";
 import { BodyType, HttpResponse, RequestParams } from "./RestRuntime";
-import { SiteHomeSubPage, SiteInfo } from "./SiteRuntime";
+import { SiteInfo } from "./SiteRuntime";
 import { PublicToast } from "./ToastRuntime";
 export interface CustomFieldError {
     /**
@@ -11,21 +12,10 @@ export interface CustomFieldError {
      */
     customFieldKeys: string[];
 }
-export interface HostConnectorApi extends IAnalyticsContextAsync<{}> {
+export interface HostConnectorApi extends IAnalyticsContextAsync<{}>, INavigationRuntime {
     getAssetInfo(): Promise<AssetInfo>;
     getAssetSortingState(): Promise<IAssetSortingContext["sortingState"]>;
     setAssetSortingState(...args: Parameters<IAssetSortingContext["setSortBy"]>): Promise<void>;
-    gotoAssetHome(assetId: string, options?: {
-        irisAppId?: string;
-        extensionId?: string;
-        subPage?: AssetHomeSubPage;
-    }): Promise<boolean>;
-    gotoSiteHome(siteId: string, options?: {
-        irisAppId?: string;
-        extensionId?: string;
-        subPage?: SiteHomeSubPage;
-    }): Promise<boolean>;
-    gotoAppLibrary(irisAppId?: string): Promise<boolean>;
     requestTrackunitRestApi: <T, E>(path: string, method: string, requestParams?: RequestParams, body?: unknown, bodyType?: BodyType, secureByDefault?: boolean) => Promise<HttpResponse<T, E>>;
     getCustomFieldsFor(entity: EntityIdentity): Promise<ValueAndDefinition[]>;
     setCustomFieldsFor(entity: EntityIdentity, values: ValueAndDefinitionKey[]): Promise<void | CustomFieldError>;
@@ -38,7 +28,6 @@ export interface HostConnectorApi extends IAnalyticsContextAsync<{}> {
     getCurrentUserLanguage(): Promise<string>;
     getCurrentUserTimeZonePreference(): Promise<TimeZonePreferenceType>;
     getCurrentUserSystemOfMeasurement(): Promise<SystemOfMeasurementType>;
-    setDeepLink: SetDeepLink;
     addToast(toast: PublicToast): Promise<void | "primaryAction" | "secondaryAction">;
     getCurrentUserRole(userIds: string | string[]): Promise<CurrentUserRole | undefined>;
     getAppName(): string | undefined;

package/src/NavigationRuntime.d.ts

@@ -0,0 +1,43 @@
+import { AssetHomePageId } from "./AssetRuntime";
+import { SetDeepLink } from "./HostConnector";
+import { SiteHomePageId } from "./SiteRuntime";
+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 allows for extra deep navigation inside of the app.
+ */
+type SubPage = {
+    subPage?: string;
+};
+type NeverPage = {
+    page?: never;
+};
+type NeverIrisApp = {
+    irisAppId?: never;
+    extensionId?: never;
+};
+export type IrisAppOptions = {
+    irisAppId: string;
+    extensionId: string;
+} & SubPage & NeverPage;
+declare const mainApps: readonly ["fleet", "reports", "sites"];
+export type MainFleetApp = (typeof mainApps)[number];
+export type AssetHomeStandardOptions = Page<AssetHomePageId> & SubPage & NeverIrisApp;
+export type SiteHomeStandardOptions = Page<SiteHomePageId> & SubPage & NeverIrisApp;
+/**
+ * type guard for IrisAppOptions
+ */
+export declare const isIrisOptions: (options: IrisAppOptions | unknown) => options is IrisAppOptions;
+export interface INavigationRuntime {
+    setDeepLink: SetDeepLink;
+    gotoAssetHome: (assetId: string, options?: IrisAppOptions | AssetHomeStandardOptions) => Promise<boolean>;
+    gotoSiteHome: (siteId: string, options?: IrisAppOptions | SiteHomeStandardOptions) => Promise<boolean>;
+    gotoAppLibrary: (irisAppId?: string) => Promise<boolean>;
+    gotoFleetApp: (options: IrisAppOptions | MainFleetApp) => Promise<boolean>;
+}
+export {};

package/src/SiteRuntime.d.ts

@@ -1,7 +1,5 @@
 export interface SiteInfo {
     siteId: string;
 }
-export declare enum SiteHomeSubPage {
-    INFORMATION = "information",
-    HISTORY = "history"
-}
+export declare const siteHomePageIds: readonly ["overview", "assets", "asset-visibility"];
+export type SiteHomePageId = (typeof siteHomePageIds)[number];

package/src/index.d.ts

@@ -3,6 +3,7 @@ export * from "./ChildConnector";
 export * from "./CurrentUserRuntime";
 export * from "./CustomFieldRuntime";
 export * from "./HostConnector";
+export * from "./NavigationRuntime";
 export * from "./RestRuntime";
 export * from "./SiteRuntime";
 export * from "./ToastRuntime";