@trackunit/iris-app-runtime-core-api 0.3.82 → 0.3.83

package/index.cjs.js

@@ -2,16 +2,6 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-const assetHomePageIds = [
-    "status",
-    "movement",
-    "events",
-    "insights",
-    "specification",
-    "telematics",
-    "activity-timeline",
-];
-
 exports.CustomFieldType = void 0;
 (function (CustomFieldType) {
     CustomFieldType["BOOLEAN"] = "BOOLEAN";
@@ -72,27 +62,8 @@ 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 = {}));
-
-const siteHomePageIds = ["overview", "assets", "asset-visibility"];
-
-exports.assetHomePageIds = assetHomePageIds;
-exports.isIrisOptions = isIrisOptions;
-exports.siteHomePageIds = siteHomePageIds;

package/index.esm.js

@@ -1,13 +1,3 @@
-const assetHomePageIds = [
-    "status",
-    "movement",
-    "events",
-    "insights",
-    "specification",
-    "telematics",
-    "activity-timeline",
-];
-
 var CustomFieldType;
 (function (CustomFieldType) {
     CustomFieldType["BOOLEAN"] = "BOOLEAN";
@@ -68,25 +58,10 @@ 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 = {}));
 
-const siteHomePageIds = ["overview", "assets", "asset-visibility"];
-
-export { BodyType, CustomFieldType, UnitSi, UnitUs, assetHomePageIds, isIrisOptions, siteHomePageIds };
+export { BodyType, CustomFieldType, UnitSi, UnitUs };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/iris-app-runtime-core-api",
-  "version": "0.3.82",
+  "version": "0.3.83",
   "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.68"
+    "@trackunit/react-core-contexts-api": "0.2.69"
   },
   "peerDependencies": {}
 }

package/src/AssetRuntime.d.ts

@@ -1,5 +1,3 @@
 export interface AssetInfo {
     assetId: string;
 }
-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,8 +1,7 @@
-import { FilterBarValues, IAnalyticsContextAsync, IAssetSortingContext, ICurrentUserContext, IEnvironmentContext, IGlobalSelectionContext, ITokenContext, IUserSubscriptionContext, OemBranding, OemBrandingImageType, SystemOfMeasurementType, TimeZonePreferenceType } from "@trackunit/react-core-contexts-api";
+import { FilterBarValues, IAnalyticsContextAsync, IAssetSortingContext, ICurrentUserContext, ICurrentUserPreferenceContext, IEnvironmentContext, IGlobalSelectionContext, INavigationContext, IOemBrandingContext, ITokenContext, IUserSubscriptionContext, SetDeepLinkPromise } from "@trackunit/react-core-contexts-api";
 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 { SiteInfo } from "./SiteRuntime";
 import { PublicToast } from "./ToastRuntime";
@@ -12,36 +11,38 @@ export interface CustomFieldError {
      */
     customFieldKeys: string[];
 }
-export interface HostConnectorApi extends IAnalyticsContextAsync<{}>, INavigationRuntime {
-    getAssetInfo(): Promise<AssetInfo>;
+export interface HostConnectorApi extends IAnalyticsContextAsync<{}>, INavigationContext, IOemBrandingContext, ICurrentUserPreferenceContext {
     getAssetSortingState(): Promise<IAssetSortingContext["sortingState"]>;
     setAssetSortingState(...args: Parameters<IAssetSortingContext["setSortBy"]>): Promise<void>;
-    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>;
     getEnvironmentContext(): Promise<IEnvironmentContext>;
-    getUserSubscriptionContext(): Promise<IUserSubscriptionContext>;
     getTokenContext(): Promise<ITokenContext>;
+    getCurrentUserContext(): Promise<ICurrentUserContext>;
+    getCurrentUserRole(userIds: string | string[]): Promise<CurrentUserRole | undefined>;
+    getUserSubscriptionContext(): Promise<IUserSubscriptionContext>;
     getGlobalSelectionContext(): Promise<IGlobalSelectionContext>;
+    /**
+     * use this to keep the deep link in sync with the host page.
+     */
+    setDeepLink: SetDeepLinkPromise;
+    getCustomFieldsFor(entity: EntityIdentity): Promise<ValueAndDefinition[]>;
+    setCustomFieldsFor(entity: EntityIdentity, values: ValueAndDefinitionKey[]): Promise<void | CustomFieldError>;
+    /**
+     * Used to get the current filter bar values, only if the host page has a filterbar.
+     */
     getFilterBarValues(): Promise<FilterBarValues>;
-    getCurrentUserContext(): Promise<ICurrentUserContext>;
-    getCurrentUserLanguage(): Promise<string>;
-    getCurrentUserTimeZonePreference(): Promise<TimeZonePreferenceType>;
-    getCurrentUserSystemOfMeasurement(): Promise<SystemOfMeasurementType>;
+    /**
+     * Adds a toast to the host pages toast stack.
+     *
+     * @param toast the toast to add
+     */
     addToast(toast: PublicToast): Promise<void | "primaryAction" | "secondaryAction">;
-    getCurrentUserRole(userIds: string | string[]): Promise<CurrentUserRole | undefined>;
     getAppName(): string | undefined;
     getOrgName(): string | undefined;
     getExtensionName(): string | undefined;
     getSiteInfo(): Promise<SiteInfo>;
-    getAllBrandingDetails(): Promise<Record<string, OemBranding>>;
-    getOemBranding: (brand: string) => Promise<OemBranding | null>;
-    getOemImage: (imageType: OemBrandingImageType, brand: string, model?: string) => Promise<string | null>;
+    getAssetInfo(): Promise<AssetInfo>;
+    /**
+     * @deprecated you should use GQL instead
+     */
+    requestTrackunitRestApi: <T, E>(path: string, method: string, requestParams?: RequestParams, body?: unknown, bodyType?: BodyType, secureByDefault?: boolean) => Promise<HttpResponse<T, E>>;
 }
-export type SetDeepLink = (deepLink: DeepLink) => void;
-export type DeepLink = {
-    path: string;
-    pathname: string;
-    search: Location["search"];
-    hash: Location["hash"];
-};

package/src/NavigationRuntime.d.ts

@@ -1,47 +1,3 @@
-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 & 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 AssetHomeStandardOptions = Page<AssetHomePageId> & NeverIrisApp;
-export type SiteHomeStandardOptions = Page<SiteHomePageId> & NeverIrisApp;
-export type FleetAppStandardOptions = Page<MainFleetApp> & 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 | FleetAppStandardOptions) => Promise<boolean>;
+import { INavigationContext } from "@trackunit/react-core-contexts-api";
+export interface INavigationRuntime extends INavigationContext {
 }
-export {};

package/src/SiteRuntime.d.ts

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