@trackunit/iris-app-runtime-core-api 1.9.4 → 1.9.7

package/index.cjs.js

@@ -41,6 +41,9 @@ exports.AssetSortByProperty = void 0;
     AssetSortByProperty["Type"] = "TYPE";
     AssetSortByProperty["PlannedServiceBooked"] = "PLANNED_SERVICE_BOOKED";
     AssetSortByProperty["PlannedServiceBookingDate"] = "PLANNED_SERVICE_BOOKING_DATE";
+    AssetSortByProperty["PlannedServiceDate"] = "PLANNED_SERVICE_DATE";
+    AssetSortByProperty["PlannedServiceHoursRemaining"] = "PLANNED_SERVICE_HOURS_REMAINING";
+    AssetSortByProperty["PlannedServiceDistanceRemaining"] = "PLANNED_SERVICE_DISTANCE_REMAINING";
     AssetSortByProperty["ServicePlanPrediction"] = "SERVICE_PLAN_PREDICTION";
     AssetSortByProperty["IssueCreatedAt"] = "ISSUE_CREATED_AT";
     AssetSortByProperty["BatteryChargerState"] = "BATTERY_CHARGER_STATE";
@@ -75,6 +78,9 @@ const stringToEnum = {
     TYPE: exports.AssetSortByProperty.Type,
     PLANNED_SERVICE_BOOKED: exports.AssetSortByProperty.PlannedServiceBooked,
     PLANNED_SERVICE_BOOKING_DATE: exports.AssetSortByProperty.PlannedServiceBookingDate,
+    PLANNED_SERVICE_DATE: exports.AssetSortByProperty.PlannedServiceDate,
+    PLANNED_SERVICE_HOURS_REMAINING: exports.AssetSortByProperty.PlannedServiceHoursRemaining,
+    PLANNED_SERVICE_DISTANCE_REMAINING: exports.AssetSortByProperty.PlannedServiceDistanceRemaining,
     SERVICE_PLAN_PREDICTION: exports.AssetSortByProperty.ServicePlanPrediction,
     ISSUE_CREATED_AT: exports.AssetSortByProperty.IssueCreatedAt,
     BATTERY_CHARGER_STATE: exports.AssetSortByProperty.BatteryChargerState,
@@ -238,31 +244,71 @@ const UnitSi = {
     hour: "HOUR",
 };
 
-const mainApps = ["reports", "sites", "map", "assets"];
-const assetHomePageIds = [
-    "status",
-    "movement",
-    "events",
-    "insights",
-    "specification",
-    "telematics",
-    "contracts",
-];
+const mainApps = ["myhome", "map", "assets", "sites", "customers", "groups", "reports"];
+const assetHomePageIds = ["status", "movement", "events", "insights", "specification", "telematics"];
 const siteHomePageIds = ["overview", "assets", "asset-visibility"];
 const groupHomePageIds = ["assets", "users", "details"];
 const customerHomePageIds = ["info", "assets", "contact-list"];
+const allPages = [
+    ...assetHomePageIds,
+    ...siteHomePageIds,
+    ...groupHomePageIds,
+    ...customerHomePageIds,
+    ...mainApps,
+];
 /**
  * type guard for IrisAppOptions
  */
 const isIrisOptions = (options) => {
-    if (!options) {
-        return false;
-    }
     return (typeof options === "object" &&
         "irisAppId" in options &&
         Boolean(options.irisAppId) &&
         "extensionId" in options);
 };
+/**
+ * type guard for FleetAppStandardOptions
+ */
+const isFleetAppStandardOptions = (options) => {
+    // eslint-disable-next-line local-rules/no-typescript-assertion
+    return Boolean(options.page && mainApps.includes(options.page) && !isIrisOptions(options));
+};
+/**
+ * type guard for AssetHomeOptions
+ */
+const isAssetHomeOptions = (options) => {
+    return Boolean(typeof options === "object" &&
+        "assetId" in options &&
+        Boolean(options.assetId) &&
+        typeof options.page === "string" &&
+        !isIrisOptions(options) &&
+        assetHomePageIds.includes(options.page));
+};
+/**
+ * type guard for SiteHomeOptions
+ */
+const isSiteHomeOptions = (options) => {
+    return Boolean(typeof options === "object" &&
+        "siteId" in options &&
+        Boolean(options.siteId) &&
+        typeof options.page === "string" &&
+        !isIrisOptions(options) &&
+        siteHomePageIds.includes(options.page));
+};
+/**
+ * type guard for GroupHomeStandardOptions
+ */
+const isGroupHomeStandardOptions = (options) => {
+    // eslint-disable-next-line local-rules/no-typescript-assertion
+    return Boolean(options.page && !isIrisOptions(options) && groupHomePageIds.includes(options.page));
+};
+/**
+ * type guard for CustomerHomeStandardOptions
+ */
+const isCustomerHomeStandardOptions = (options) => {
+    return Boolean(
+    // eslint-disable-next-line local-rules/no-typescript-assertion
+    options.page && !isIrisOptions(options) && customerHomePageIds.includes(options.page));
+};
 
 exports.BodyType = void 0;
 (function (BodyType) {
@@ -297,11 +343,17 @@ exports.UnitOfMeasurement = UnitOfMeasurement;
 exports.UnitSi = UnitSi;
 exports.UnitUs = UnitUs;
 exports.UserSubscriptionPackage = UserSubscriptionPackage;
+exports.allPages = allPages;
 exports.assetHomePageIds = assetHomePageIds;
 exports.createEvent = createEvent;
 exports.customerHomePageIds = customerHomePageIds;
 exports.groupHomePageIds = groupHomePageIds;
+exports.isAssetHomeOptions = isAssetHomeOptions;
+exports.isCustomerHomeStandardOptions = isCustomerHomeStandardOptions;
+exports.isFleetAppStandardOptions = isFleetAppStandardOptions;
+exports.isGroupHomeStandardOptions = isGroupHomeStandardOptions;
 exports.isIrisOptions = isIrisOptions;
+exports.isSiteHomeOptions = isSiteHomeOptions;
 exports.mainApps = mainApps;
 exports.siteHomePageIds = siteHomePageIds;
 exports.validateStringAsAssetSortByProperty = validateStringAsAssetSortByProperty;

package/index.esm.js

@@ -39,6 +39,9 @@ var AssetSortByProperty;
     AssetSortByProperty["Type"] = "TYPE";
     AssetSortByProperty["PlannedServiceBooked"] = "PLANNED_SERVICE_BOOKED";
     AssetSortByProperty["PlannedServiceBookingDate"] = "PLANNED_SERVICE_BOOKING_DATE";
+    AssetSortByProperty["PlannedServiceDate"] = "PLANNED_SERVICE_DATE";
+    AssetSortByProperty["PlannedServiceHoursRemaining"] = "PLANNED_SERVICE_HOURS_REMAINING";
+    AssetSortByProperty["PlannedServiceDistanceRemaining"] = "PLANNED_SERVICE_DISTANCE_REMAINING";
     AssetSortByProperty["ServicePlanPrediction"] = "SERVICE_PLAN_PREDICTION";
     AssetSortByProperty["IssueCreatedAt"] = "ISSUE_CREATED_AT";
     AssetSortByProperty["BatteryChargerState"] = "BATTERY_CHARGER_STATE";
@@ -73,6 +76,9 @@ const stringToEnum = {
     TYPE: AssetSortByProperty.Type,
     PLANNED_SERVICE_BOOKED: AssetSortByProperty.PlannedServiceBooked,
     PLANNED_SERVICE_BOOKING_DATE: AssetSortByProperty.PlannedServiceBookingDate,
+    PLANNED_SERVICE_DATE: AssetSortByProperty.PlannedServiceDate,
+    PLANNED_SERVICE_HOURS_REMAINING: AssetSortByProperty.PlannedServiceHoursRemaining,
+    PLANNED_SERVICE_DISTANCE_REMAINING: AssetSortByProperty.PlannedServiceDistanceRemaining,
     SERVICE_PLAN_PREDICTION: AssetSortByProperty.ServicePlanPrediction,
     ISSUE_CREATED_AT: AssetSortByProperty.IssueCreatedAt,
     BATTERY_CHARGER_STATE: AssetSortByProperty.BatteryChargerState,
@@ -236,31 +242,71 @@ const UnitSi = {
     hour: "HOUR",
 };
 
-const mainApps = ["reports", "sites", "map", "assets"];
-const assetHomePageIds = [
-    "status",
-    "movement",
-    "events",
-    "insights",
-    "specification",
-    "telematics",
-    "contracts",
-];
+const mainApps = ["myhome", "map", "assets", "sites", "customers", "groups", "reports"];
+const assetHomePageIds = ["status", "movement", "events", "insights", "specification", "telematics"];
 const siteHomePageIds = ["overview", "assets", "asset-visibility"];
 const groupHomePageIds = ["assets", "users", "details"];
 const customerHomePageIds = ["info", "assets", "contact-list"];
+const allPages = [
+    ...assetHomePageIds,
+    ...siteHomePageIds,
+    ...groupHomePageIds,
+    ...customerHomePageIds,
+    ...mainApps,
+];
 /**
  * type guard for IrisAppOptions
  */
 const isIrisOptions = (options) => {
-    if (!options) {
-        return false;
-    }
     return (typeof options === "object" &&
         "irisAppId" in options &&
         Boolean(options.irisAppId) &&
         "extensionId" in options);
 };
+/**
+ * type guard for FleetAppStandardOptions
+ */
+const isFleetAppStandardOptions = (options) => {
+    // eslint-disable-next-line local-rules/no-typescript-assertion
+    return Boolean(options.page && mainApps.includes(options.page) && !isIrisOptions(options));
+};
+/**
+ * type guard for AssetHomeOptions
+ */
+const isAssetHomeOptions = (options) => {
+    return Boolean(typeof options === "object" &&
+        "assetId" in options &&
+        Boolean(options.assetId) &&
+        typeof options.page === "string" &&
+        !isIrisOptions(options) &&
+        assetHomePageIds.includes(options.page));
+};
+/**
+ * type guard for SiteHomeOptions
+ */
+const isSiteHomeOptions = (options) => {
+    return Boolean(typeof options === "object" &&
+        "siteId" in options &&
+        Boolean(options.siteId) &&
+        typeof options.page === "string" &&
+        !isIrisOptions(options) &&
+        siteHomePageIds.includes(options.page));
+};
+/**
+ * type guard for GroupHomeStandardOptions
+ */
+const isGroupHomeStandardOptions = (options) => {
+    // eslint-disable-next-line local-rules/no-typescript-assertion
+    return Boolean(options.page && !isIrisOptions(options) && groupHomePageIds.includes(options.page));
+};
+/**
+ * type guard for CustomerHomeStandardOptions
+ */
+const isCustomerHomeStandardOptions = (options) => {
+    return Boolean(
+    // eslint-disable-next-line local-rules/no-typescript-assertion
+    options.page && !isIrisOptions(options) && customerHomePageIds.includes(options.page));
+};
 
 var BodyType;
 (function (BodyType) {
@@ -289,4 +335,4 @@ const UserSubscriptionPackage = {
     CUSTOMER_PORTAL: "Customer Portal",
 };
 
-export { AssetSortByProperty, BodyType, SortOrder, SystemOfMeasurement, TimeZonePreference, UnitOfMeasurement, UnitSi, UnitUs, UserSubscriptionPackage, assetHomePageIds, createEvent, customerHomePageIds, groupHomePageIds, isIrisOptions, mainApps, siteHomePageIds, validateStringAsAssetSortByProperty };
+export { AssetSortByProperty, BodyType, SortOrder, SystemOfMeasurement, TimeZonePreference, UnitOfMeasurement, UnitSi, UnitUs, UserSubscriptionPackage, allPages, assetHomePageIds, createEvent, customerHomePageIds, groupHomePageIds, isAssetHomeOptions, isCustomerHomeStandardOptions, isFleetAppStandardOptions, isGroupHomeStandardOptions, isIrisOptions, isSiteHomeOptions, mainApps, siteHomePageIds, validateStringAsAssetSortByProperty };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/iris-app-runtime-core-api",
-  "version": "1.9.4",
+  "version": "1.9.7",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -8,8 +8,8 @@
   },
   "dependencies": {
     "@graphql-typed-document-node/core": "^3.2.0",
-    "@trackunit/shared-utils": "1.11.4",
-    "@trackunit/geo-json-utils": "1.9.4"
+    "@trackunit/shared-utils": "1.11.5",
+    "@trackunit/geo-json-utils": "1.9.5"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",

package/src/AssetSortingRuntime.d.ts

@@ -21,6 +21,9 @@ export declare enum AssetSortByProperty {
     Type = "TYPE",
     PlannedServiceBooked = "PLANNED_SERVICE_BOOKED",
     PlannedServiceBookingDate = "PLANNED_SERVICE_BOOKING_DATE",
+    PlannedServiceDate = "PLANNED_SERVICE_DATE",
+    PlannedServiceHoursRemaining = "PLANNED_SERVICE_HOURS_REMAINING",
+    PlannedServiceDistanceRemaining = "PLANNED_SERVICE_DISTANCE_REMAINING",
     ServicePlanPrediction = "SERVICE_PLAN_PREDICTION",
     IssueCreatedAt = "ISSUE_CREATED_AT",
     BatteryChargerState = "BATTERY_CHARGER_STATE",

package/src/NavigationRuntime.d.ts

@@ -21,14 +21,14 @@ export type IrisAppOptions = {
     irisAppId: string;
     extensionId: string;
 } & SubPage & Search & FragmentIdentifier & NeverPage;
-export declare const mainApps: readonly ["reports", "sites", "map", "assets"];
+export declare const mainApps: readonly ["myhome", "map", "assets", "sites", "customers", "groups", "reports"];
 export type MainFleetApp = (typeof mainApps)[number];
 export type FleetAppStandardOptions = Page<MainFleetApp> & NeverIrisApp;
 export type MapAppStandardOptions = Page<"map"> & NeverIrisApp;
 export type MarketplaceOptions = {
     irisAppId: string;
 };
-export declare const assetHomePageIds: readonly ["status", "movement", "events", "insights", "specification", "telematics", "contracts"];
+export declare const assetHomePageIds: readonly ["status", "movement", "events", "insights", "specification", "telematics"];
 export type AssetHomePageId = (typeof assetHomePageIds)[number];
 export type AssetHomeStandardOptions = Page<AssetHomePageId> & NeverIrisApp;
 export declare const siteHomePageIds: readonly ["overview", "assets", "asset-visibility"];
@@ -40,14 +40,39 @@ export type GroupHomeStandardOptions = Page<GroupHomePageId> & NeverIrisApp;
 export declare const customerHomePageIds: readonly ["info", "assets", "contact-list"];
 export type CustomerHomePageId = (typeof customerHomePageIds)[number];
 export type CustomerHomeStandardOptions = Page<CustomerHomePageId> & NeverIrisApp;
-export type HasAccessToOptions = (IrisAppOptions | AssetHomeStandardOptions | SiteHomeStandardOptions | FleetAppStandardOptions) & {
-    assetId?: string;
-    siteId?: string;
+export declare const allPages: readonly ["status", "movement", "events", "insights", "specification", "telematics", "overview", "assets", "asset-visibility", "assets", "users", "details", "info", "assets", "contact-list", "myhome", "map", "assets", "sites", "customers", "groups", "reports"];
+export type AllPages = (typeof allPages)[number];
+export type AssetHomeOptions = AssetHomeStandardOptions & {
+    assetId: string;
 };
+export type SiteHomeOptions = SiteHomeStandardOptions & {
+    siteId: string;
+};
+export type HasAccessToOptions = IrisAppOptions | AssetHomeOptions | SiteHomeOptions | GroupHomeStandardOptions | CustomerHomeStandardOptions | FleetAppStandardOptions;
 /**
  * type guard for IrisAppOptions
  */
-export declare const isIrisOptions: (options: IrisAppOptions | unknown) => options is IrisAppOptions;
+export declare const isIrisOptions: (options: IrisAppOptions | AssetHomeStandardOptions | SiteHomeStandardOptions | FleetAppStandardOptions | GroupHomeStandardOptions | CustomerHomeStandardOptions | undefined) => options is IrisAppOptions;
+/**
+ * type guard for FleetAppStandardOptions
+ */
+export declare const isFleetAppStandardOptions: (options: HasAccessToOptions) => options is FleetAppStandardOptions;
+/**
+ * type guard for AssetHomeOptions
+ */
+export declare const isAssetHomeOptions: (options: HasAccessToOptions) => options is AssetHomeOptions;
+/**
+ * type guard for SiteHomeOptions
+ */
+export declare const isSiteHomeOptions: (options: HasAccessToOptions) => options is SiteHomeOptions;
+/**
+ * type guard for GroupHomeStandardOptions
+ */
+export declare const isGroupHomeStandardOptions: (options: HasAccessToOptions) => options is GroupHomeStandardOptions;
+/**
+ * type guard for CustomerHomeStandardOptions
+ */
+export declare const isCustomerHomeStandardOptions: (options: HasAccessToOptions) => options is CustomerHomeStandardOptions;
 export interface NavigationRuntimeApi {
     hasAccessTo: (options: HasAccessToOptions) => Promise<boolean>;
     gotoAssetHome: (assetId: string, options?: IrisAppOptions | AssetHomeStandardOptions) => Promise<boolean>;