@trackunit/iris-app-runtime-core-api 1.7.79 → 1.7.81

package/index.cjs.js

@@ -13,6 +13,7 @@ var sharedUtils = require('@trackunit/shared-utils');
  */
 const createEvent = (event) => ({
     description: event?.description,
+    // eslint-disable-next-line local-rules/no-typescript-assertion
     properties: {},
 });
 
@@ -42,6 +43,13 @@ exports.AssetSortByProperty = void 0;
     AssetSortByProperty["PlannedServiceBookingDate"] = "PLANNED_SERVICE_BOOKING_DATE";
     AssetSortByProperty["ServicePlanPrediction"] = "SERVICE_PLAN_PREDICTION";
     AssetSortByProperty["IssueCreatedAt"] = "ISSUE_CREATED_AT";
+    AssetSortByProperty["BatteryChargerState"] = "BATTERY_CHARGER_STATE";
+    AssetSortByProperty["BatteryPotential"] = "BATTERY_POTENTIAL";
+    AssetSortByProperty["BatteryStateOfChargePercent"] = "BATTERY_STATE_OF_CHARGE_PERCENT";
+    AssetSortByProperty["CumulativeOperatingHours"] = "CUMULATIVE_OPERATING_HOURS";
+    AssetSortByProperty["FuelLevel"] = "FUEL_LEVEL";
+    AssetSortByProperty["AfterTreatmentDieselExhaustFluidTankLevel"] = "AFTER_TREATMENT_DIESEL_EXHAUST_FLUID_TANK_LEVEL";
+    AssetSortByProperty["EngineTotalIdleHours"] = "ENGINE_TOTAL_IDLE_HOURS";
 })(exports.AssetSortByProperty || (exports.AssetSortByProperty = {}));
 // The type [key in AssetSortByProperty] will ensure that ALL keys are present
 const stringToEnum = {
@@ -69,6 +77,13 @@ const stringToEnum = {
     PLANNED_SERVICE_BOOKING_DATE: exports.AssetSortByProperty.PlannedServiceBookingDate,
     SERVICE_PLAN_PREDICTION: exports.AssetSortByProperty.ServicePlanPrediction,
     ISSUE_CREATED_AT: exports.AssetSortByProperty.IssueCreatedAt,
+    BATTERY_CHARGER_STATE: exports.AssetSortByProperty.BatteryChargerState,
+    BATTERY_POTENTIAL: exports.AssetSortByProperty.BatteryPotential,
+    BATTERY_STATE_OF_CHARGE_PERCENT: exports.AssetSortByProperty.BatteryStateOfChargePercent,
+    CUMULATIVE_OPERATING_HOURS: exports.AssetSortByProperty.CumulativeOperatingHours,
+    FUEL_LEVEL: exports.AssetSortByProperty.FuelLevel,
+    AFTER_TREATMENT_DIESEL_EXHAUST_FLUID_TANK_LEVEL: exports.AssetSortByProperty.AfterTreatmentDieselExhaustFluidTankLevel,
+    ENGINE_TOTAL_IDLE_HOURS: exports.AssetSortByProperty.EngineTotalIdleHours,
 };
 /**
  * Ensures that a string is a valid AssetSortByProperty enum value
@@ -223,6 +238,7 @@ const UnitSi = {
     hour: "HOUR",
 };
 
+const mainApps = ["reports", "sites", "map", "assets"];
 const assetHomePageIds = [
     "status",
     "movement",
@@ -286,5 +302,6 @@ exports.createEvent = createEvent;
 exports.customerHomePageIds = customerHomePageIds;
 exports.groupHomePageIds = groupHomePageIds;
 exports.isIrisOptions = isIrisOptions;
+exports.mainApps = mainApps;
 exports.siteHomePageIds = siteHomePageIds;
 exports.validateStringAsAssetSortByProperty = validateStringAsAssetSortByProperty;

package/index.esm.js

@@ -11,6 +11,7 @@ import { isUUID } from '@trackunit/shared-utils';
  */
 const createEvent = (event) => ({
     description: event?.description,
+    // eslint-disable-next-line local-rules/no-typescript-assertion
     properties: {},
 });
 
@@ -40,6 +41,13 @@ var AssetSortByProperty;
     AssetSortByProperty["PlannedServiceBookingDate"] = "PLANNED_SERVICE_BOOKING_DATE";
     AssetSortByProperty["ServicePlanPrediction"] = "SERVICE_PLAN_PREDICTION";
     AssetSortByProperty["IssueCreatedAt"] = "ISSUE_CREATED_AT";
+    AssetSortByProperty["BatteryChargerState"] = "BATTERY_CHARGER_STATE";
+    AssetSortByProperty["BatteryPotential"] = "BATTERY_POTENTIAL";
+    AssetSortByProperty["BatteryStateOfChargePercent"] = "BATTERY_STATE_OF_CHARGE_PERCENT";
+    AssetSortByProperty["CumulativeOperatingHours"] = "CUMULATIVE_OPERATING_HOURS";
+    AssetSortByProperty["FuelLevel"] = "FUEL_LEVEL";
+    AssetSortByProperty["AfterTreatmentDieselExhaustFluidTankLevel"] = "AFTER_TREATMENT_DIESEL_EXHAUST_FLUID_TANK_LEVEL";
+    AssetSortByProperty["EngineTotalIdleHours"] = "ENGINE_TOTAL_IDLE_HOURS";
 })(AssetSortByProperty || (AssetSortByProperty = {}));
 // The type [key in AssetSortByProperty] will ensure that ALL keys are present
 const stringToEnum = {
@@ -67,6 +75,13 @@ const stringToEnum = {
     PLANNED_SERVICE_BOOKING_DATE: AssetSortByProperty.PlannedServiceBookingDate,
     SERVICE_PLAN_PREDICTION: AssetSortByProperty.ServicePlanPrediction,
     ISSUE_CREATED_AT: AssetSortByProperty.IssueCreatedAt,
+    BATTERY_CHARGER_STATE: AssetSortByProperty.BatteryChargerState,
+    BATTERY_POTENTIAL: AssetSortByProperty.BatteryPotential,
+    BATTERY_STATE_OF_CHARGE_PERCENT: AssetSortByProperty.BatteryStateOfChargePercent,
+    CUMULATIVE_OPERATING_HOURS: AssetSortByProperty.CumulativeOperatingHours,
+    FUEL_LEVEL: AssetSortByProperty.FuelLevel,
+    AFTER_TREATMENT_DIESEL_EXHAUST_FLUID_TANK_LEVEL: AssetSortByProperty.AfterTreatmentDieselExhaustFluidTankLevel,
+    ENGINE_TOTAL_IDLE_HOURS: AssetSortByProperty.EngineTotalIdleHours,
 };
 /**
  * Ensures that a string is a valid AssetSortByProperty enum value
@@ -221,6 +236,7 @@ const UnitSi = {
     hour: "HOUR",
 };
 
+const mainApps = ["reports", "sites", "map", "assets"];
 const assetHomePageIds = [
     "status",
     "movement",
@@ -273,4 +289,4 @@ const UserSubscriptionPackage = {
     CUSTOMER_PORTAL: "Customer Portal",
 };
 
-export { AssetSortByProperty, BodyType, SortOrder, SystemOfMeasurement, TimeZonePreference, UnitOfMeasurement, UnitSi, UnitUs, UserSubscriptionPackage, assetHomePageIds, createEvent, customerHomePageIds, groupHomePageIds, isIrisOptions, siteHomePageIds, validateStringAsAssetSortByProperty };
+export { AssetSortByProperty, BodyType, SortOrder, SystemOfMeasurement, TimeZonePreference, UnitOfMeasurement, UnitSi, UnitUs, UserSubscriptionPackage, assetHomePageIds, createEvent, customerHomePageIds, groupHomePageIds, isIrisOptions, mainApps, siteHomePageIds, validateStringAsAssetSortByProperty };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/iris-app-runtime-core-api",
-  "version": "1.7.79",
+  "version": "1.7.81",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {

package/src/AnalyticsRuntime.d.ts

@@ -1,3 +1,4 @@
+import { PromisifyObject } from "./types";
 export type AdditionalProperties = Record<string, string | number | boolean | null | undefined | Array<string | number>>;
 export interface BaseEvent {
     additionalProperties?: AdditionalProperties;
@@ -15,13 +16,13 @@ export declare const createEvent: <TEventType extends object = BaseEvent>(event?
     description?: string;
 }) => Event<TEventType>;
 export type UnspecifiedEvent = AdditionalProperties;
-export type Event<T> = {
+export type Event<TProperties> = {
     description?: string;
-    properties: T;
+    properties: TProperties;
 };
 export type EventDictionary = Record<string, Event<BaseEvent | UnspecifiedEvent>>;
-export interface IAnalyticsContext<Events extends EventDictionary> {
-    logEvent<T extends keyof Events>(eventName: T, details: Events[T]["properties"], nameSupplement?: {
+export interface AnalyticsRuntimeApiSync<TEvents extends EventDictionary> {
+    logEvent<TEventName extends keyof TEvents & string>(eventName: TEventName, details: TEvents[TEventName]["properties"], nameSupplement?: {
         prefix?: string;
         postfix?: string;
     }): void;
@@ -31,12 +32,5 @@ export interface IAnalyticsContext<Events extends EventDictionary> {
     logError(details: UnspecifiedEvent): void;
     setUserProperty(name: string, data: string | number): void;
 }
-type PromisifyMethod<T> = T extends (...args: infer U) => infer V ? (...args: U) => Promise<V> : T;
-type PromisifyObject<T> = {
-    [K in keyof T]: PromisifyMethod<T[K]>;
-};
-export interface IAnalyticsContextAsync<T extends EventDictionary> extends PromisifyObject<IAnalyticsContext<T>> {
-}
-export interface AnalyticsRuntimeApi extends IAnalyticsContextAsync<Record<string, never>> {
+export interface AnalyticsRuntimeApi<TEventDictionary extends EventDictionary> extends PromisifyObject<AnalyticsRuntimeApiSync<TEventDictionary>> {
 }
-export {};

package/src/AssetSortingRuntime.d.ts

@@ -22,7 +22,14 @@ export declare enum AssetSortByProperty {
     PlannedServiceBooked = "PLANNED_SERVICE_BOOKED",
     PlannedServiceBookingDate = "PLANNED_SERVICE_BOOKING_DATE",
     ServicePlanPrediction = "SERVICE_PLAN_PREDICTION",
-    IssueCreatedAt = "ISSUE_CREATED_AT"
+    IssueCreatedAt = "ISSUE_CREATED_AT",
+    BatteryChargerState = "BATTERY_CHARGER_STATE",
+    BatteryPotential = "BATTERY_POTENTIAL",
+    BatteryStateOfChargePercent = "BATTERY_STATE_OF_CHARGE_PERCENT",
+    CumulativeOperatingHours = "CUMULATIVE_OPERATING_HOURS",
+    FuelLevel = "FUEL_LEVEL",
+    AfterTreatmentDieselExhaustFluidTankLevel = "AFTER_TREATMENT_DIESEL_EXHAUST_FLUID_TANK_LEVEL",
+    EngineTotalIdleHours = "ENGINE_TOTAL_IDLE_HOURS"
 }
 /**
  * Ensures that a string is a valid AssetSortByProperty enum value
@@ -43,11 +50,11 @@ export interface SortingState {
     sortBy: AssetSortByProperty;
     order: SortOrder;
 }
-export interface AssetSortingContextValue {
+export interface AssetSortingState {
     sortingState: SortingState;
     setSortBy: (sortBy: AssetSortByProperty, order?: SortOrder, customFieldDefinitionId?: string) => void;
 }
 export interface AssetSortingRuntimeApi {
-    getAssetSortingState: () => Promise<AssetSortingContextValue["sortingState"]>;
-    setAssetSortingState: (...args: Parameters<AssetSortingContextValue["setSortBy"]>) => Promise<void>;
+    getAssetSortingState: () => Promise<AssetSortingState["sortingState"]>;
+    setAssetSortingState: (...args: Parameters<AssetSortingState["setSortBy"]>) => Promise<void>;
 }

package/src/ChildConnector.d.ts

@@ -1,4 +1,4 @@
-import { AssetSortingContextValue } from "./AssetSortingRuntime";
+import { AssetSortingState } from "./AssetSortingRuntime";
 import { FilterBarValues } from "./FilterBarRuntime";
 import { TemporalPeriod, TimeRange } from "./TimeRangeRuntime";
 import { ITokenContext } from "./TokenRuntime";
@@ -39,7 +39,7 @@ export interface ChildConnectorApi {
      *
      * @param sorting new sorting state
      */
-    onAssetSortingStateChanged: (sorting: AssetSortingContextValue["sortingState"]) => void;
+    onAssetSortingStateChanged: (sorting: AssetSortingState["sortingState"]) => void;
     /**
      * Gets called when the filter bar values change.
      *

package/src/ConfirmationDialogRuntime.d.ts

@@ -6,8 +6,6 @@ export interface ConfirmationDialogProps {
     primaryActionLabel: string;
     secondaryActionLabel?: string;
 }
-export interface ConfirmationDialogContextValue {
+export interface ConfirmationDialogRuntimeApi {
     confirm: (props: ConfirmationDialogProps) => Promise<UserInteractionType>;
 }
-export interface ConfirmationDialogRuntimeApi extends ConfirmationDialogContextValue {
-}

package/src/CurrentUserPreferenceRuntime.d.ts

@@ -9,7 +9,7 @@ export declare const TimeZonePreference: {
 };
 export type SystemOfMeasurementType = (typeof SystemOfMeasurement)[keyof typeof SystemOfMeasurement];
 export type TimeZonePreferenceType = (typeof TimeZonePreference)[keyof typeof TimeZonePreference];
-export interface IUserPreferencesContext {
+export interface CurrentUserPreferenceState {
     language?: string;
     setLanguage?: (language: string) => void;
     timeZonePreference?: TimeZonePreferenceType;
@@ -17,10 +17,8 @@ export interface IUserPreferencesContext {
     systemOfMeasurement?: SystemOfMeasurementType;
     setSystemOfMeasurement?: (systemOfMeasurement: SystemOfMeasurementType) => void;
 }
-export interface ICurrentUserPreferenceContext {
+export interface CurrentUserPreferenceRuntimeApi {
     getCurrentUserLanguage: () => Promise<string>;
     getCurrentUserTimeZonePreference: () => Promise<TimeZonePreferenceType>;
     getCurrentUserSystemOfMeasurement: () => Promise<SystemOfMeasurementType>;
 }
-export interface CurrentUserPreferenceRuntimeApi extends ICurrentUserPreferenceContext {
-}

package/src/EnvironmentRuntime.d.ts

@@ -1,15 +1,15 @@
-export interface ITracingHeaders {
+export interface TracingHeaders {
     "X-TrackunitAppVersion": string;
     "session-id": string;
     "commit-number": number;
 }
-export interface IEnvironmentContext {
+export interface EnvironmentState {
     auth: {
         url: string;
         clientId: string;
         issuer: string;
     };
-    tracingHeaders: ITracingHeaders;
+    tracingHeaders: TracingHeaders;
     managerClassicUrl: string;
     googleMapsApiKey: string;
     amplitudeApiKey: string;
@@ -32,5 +32,5 @@ export interface IEnvironmentContext {
     reportAccessClientId: string;
 }
 export interface EnvironmentRuntimeApi {
-    getEnvironmentContext: () => Promise<IEnvironmentContext>;
+    getEnvironmentContext: () => Promise<EnvironmentState>;
 }

package/src/HostConnector.d.ts

@@ -1,4 +1,4 @@
-import { AnalyticsRuntimeApi } from "./AnalyticsRuntime";
+import { AnalyticsRuntimeApi, EventDictionary } from "./AnalyticsRuntime";
 import { AssetRuntimeApi } from "./AssetRuntime";
 import { AssetSortingRuntimeApi } from "./AssetSortingRuntime";
 import { ConfirmationDialogRuntimeApi } from "./ConfirmationDialogRuntime";
@@ -21,5 +21,5 @@ import { ToastRuntimeApi } from "./ToastRuntime";
 import { TokenRuntimeApi } from "./TokenRuntime";
 import { UserSubscriptionRuntimeApi } from "./UserSubscriptionRuntime";
 import { WidgetConfigRuntimeApi } from "./WidgetConfigRuntime";
-export interface HostConnectorApi extends AnalyticsRuntimeApi, AssetRuntimeApi, AssetSortingRuntimeApi, ConfirmationDialogRuntimeApi, CurrentUserPreferenceRuntimeApi, CurrentUserRuntimeApi, CustomerRuntimeApi, EnvironmentRuntimeApi, EventRuntimeApi, ExportDataRuntimeApi, FilterBarRuntimeApi, ModalDialogRuntimeApi, NavigationRuntimeApi, OemBrandingRuntimeApi, RestRuntimeApi, SiteRuntimeApi, ThemeCssRuntimeApi, TimeRangeRuntimeApi, ToastRuntimeApi, TokenRuntimeApi, UserSubscriptionRuntimeApi, ParamsRuntimeApi, WidgetConfigRuntimeApi {
+export interface HostConnectorApi extends AnalyticsRuntimeApi<EventDictionary>, AssetRuntimeApi, AssetSortingRuntimeApi, ConfirmationDialogRuntimeApi, CurrentUserPreferenceRuntimeApi, CurrentUserRuntimeApi, CustomerRuntimeApi, EnvironmentRuntimeApi, EventRuntimeApi, ExportDataRuntimeApi, FilterBarRuntimeApi, ModalDialogRuntimeApi, NavigationRuntimeApi, OemBrandingRuntimeApi, RestRuntimeApi, SiteRuntimeApi, ThemeCssRuntimeApi, TimeRangeRuntimeApi, ToastRuntimeApi, TokenRuntimeApi, UserSubscriptionRuntimeApi, ParamsRuntimeApi, WidgetConfigRuntimeApi {
 }

package/src/ModalDialogRuntime.d.ts

@@ -1,9 +1,7 @@
-export interface ModalDialogContextValue {
+export interface ModalDialogRuntimeApi {
     openModal: ({ scrollX, scrollY }?: {
         scrollX: number;
         scrollY: number;
     }) => Promise<void>;
     closeModal: () => Promise<void>;
 }
-export interface ModalDialogRuntimeApi extends ModalDialogContextValue {
-}

package/src/NavigationRuntime.d.ts

@@ -21,7 +21,7 @@ export type IrisAppOptions = {
     irisAppId: string;
     extensionId: string;
 } & SubPage & Search & FragmentIdentifier & NeverPage;
-declare const mainApps: readonly ["reports", "sites", "map", "assets"];
+export declare const mainApps: readonly ["reports", "sites", "map", "assets"];
 export type MainFleetApp = (typeof mainApps)[number];
 export type FleetAppStandardOptions = Page<MainFleetApp> & NeverIrisApp;
 export type MapAppStandardOptions = Page<"map"> & NeverIrisApp;
@@ -48,7 +48,7 @@ export type HasAccessToOptions = (IrisAppOptions | AssetHomeStandardOptions | Si
  * type guard for IrisAppOptions
  */
 export declare const isIrisOptions: (options: IrisAppOptions | unknown) => options is IrisAppOptions;
-export interface INavigationContext {
+export interface NavigationRuntimeApi {
     hasAccessTo: (options: HasAccessToOptions) => Promise<boolean>;
     gotoAssetHome: (assetId: string, options?: IrisAppOptions | AssetHomeStandardOptions) => Promise<boolean>;
     gotoSiteHome: (siteId: string, options?: IrisAppOptions | SiteHomeStandardOptions) => Promise<boolean>;
@@ -72,6 +72,4 @@ export interface INavigationContext {
     getAlertsUrl: (url?: string) => Promise<string>;
     getMarketplaceUrl: (options?: MarketplaceOptions) => Promise<string>;
 }
-export interface NavigationRuntimeApi extends INavigationContext {
-}
 export {};

package/src/OemBrandingRuntime.d.ts

@@ -8,10 +8,8 @@ export interface OemBranding {
     };
 }
 export type OemBrandingImageType = "logo" | "assetBanner" | "platformLogo";
-export interface OemBrandingContext {
-    getAllBrandingDetails(): Promise<Record<string, OemBranding>>;
+export interface OemBrandingRuntimeApi {
+    getAllBrandingDetails: () => Promise<Record<string, OemBranding>>;
     getOemBranding: (brand: string) => Promise<OemBranding | null>;
     getOemImage: (imageType: OemBrandingImageType, brand: string, model?: string) => Promise<string | null>;
 }
-export interface OemBrandingRuntimeApi extends OemBrandingContext {
-}

package/src/types.d.ts

@@ -0,0 +1,4 @@
+export type PromisifyMethod<TNonPromise> = TNonPromise extends (...args: infer U) => infer V ? (...args: U) => Promise<V> : TNonPromise;
+export type PromisifyObject<TNonPromiseObject> = {
+    [K in keyof TNonPromiseObject]: PromisifyMethod<TNonPromiseObject[K]>;
+};