@trackunit/iris-app-runtime-core-api 1.16.6 → 1.16.8-alpha-d37885bfce4.0

package/index.cjs.js

@@ -131,6 +131,29 @@ exports.SortOrder = void 0;
     SortOrder["Desc"] = "DESC";
 })(exports.SortOrder || (exports.SortOrder = {}));
 
+/**
+ * Canonical penpal channel names used by `@trackunit/iris-app-runtime-core`.
+ *
+ * External iris-app publishers building against `@trackunit/iris-app-runtime-core`
+ * must pass one of these strings to `useSubscribeToHostChanges(methods, channel)`
+ * so the child connection lines up with the host's `usePenpalIframe({ channel })`.
+ *
+ * The module-level singleton connector uses {@link Channels.HostRuntime}; the
+ * remaining channels are dedicated to the five subscription providers
+ * (token, time-range, filter bar, widget config, asset sorting).
+ *
+ * Channel strings outside this set are reserved for future use and should not
+ * be passed to penpal `connect({ channel })` today.
+ */
+const Channels = {
+    HostRuntime: "host-runtime",
+    TokenSubscription: "token-subscription",
+    TimeRangeSubscription: "time-range-subscription",
+    FilterBarSubscription: "filter-bar-subscription",
+    WidgetConfigSubscription: "widget-config-subscription",
+    AssetSortingSubscription: "asset-sorting-subscription",
+};
+
 const SystemOfMeasurement = {
     Si: "SI",
     UsCustomary: "US_CUSTOMARY",
@@ -358,6 +381,7 @@ const UserSubscriptionPackage = {
     CUSTOMER_PORTAL: "Customer Portal",
 };
 
+exports.Channels = Channels;
 exports.SystemOfMeasurement = SystemOfMeasurement;
 exports.TimeZonePreference = TimeZonePreference;
 exports.UnitOfMeasurement = UnitOfMeasurement;

package/index.esm.js

@@ -129,6 +129,29 @@ var SortOrder;
     SortOrder["Desc"] = "DESC";
 })(SortOrder || (SortOrder = {}));
 
+/**
+ * Canonical penpal channel names used by `@trackunit/iris-app-runtime-core`.
+ *
+ * External iris-app publishers building against `@trackunit/iris-app-runtime-core`
+ * must pass one of these strings to `useSubscribeToHostChanges(methods, channel)`
+ * so the child connection lines up with the host's `usePenpalIframe({ channel })`.
+ *
+ * The module-level singleton connector uses {@link Channels.HostRuntime}; the
+ * remaining channels are dedicated to the five subscription providers
+ * (token, time-range, filter bar, widget config, asset sorting).
+ *
+ * Channel strings outside this set are reserved for future use and should not
+ * be passed to penpal `connect({ channel })` today.
+ */
+const Channels = {
+    HostRuntime: "host-runtime",
+    TokenSubscription: "token-subscription",
+    TimeRangeSubscription: "time-range-subscription",
+    FilterBarSubscription: "filter-bar-subscription",
+    WidgetConfigSubscription: "widget-config-subscription",
+    AssetSortingSubscription: "asset-sorting-subscription",
+};
+
 const SystemOfMeasurement = {
     Si: "SI",
     UsCustomary: "US_CUSTOMARY",
@@ -356,4 +379,4 @@ const UserSubscriptionPackage = {
     CUSTOMER_PORTAL: "Customer Portal",
 };
 
-export { AggregationPeriod, AssetSortByProperty, BodyType, SortOrder, SystemOfMeasurement, TimeZonePreference, UnitOfMeasurement, UnitSi, UnitUs, UserSubscriptionPackage, allPages, assetHomePageIds, createEvent, customerHomePageIds, groupHomePageIds, isAssetHomeOptions, isCustomerHomeOptions, isFleetAppStandardOptions, isGroupHomeOptions, isIrisOptions, isSiteHomeOptions, mainApps, siteHomePageIds, validateStringAsAssetSortByProperty };
+export { AggregationPeriod, AssetSortByProperty, BodyType, Channels, SortOrder, SystemOfMeasurement, TimeZonePreference, UnitOfMeasurement, UnitSi, UnitUs, UserSubscriptionPackage, allPages, assetHomePageIds, createEvent, customerHomePageIds, groupHomePageIds, isAssetHomeOptions, isCustomerHomeOptions, isFleetAppStandardOptions, isGroupHomeOptions, isIrisOptions, isSiteHomeOptions, mainApps, siteHomePageIds, validateStringAsAssetSortByProperty };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/iris-app-runtime-core-api",
-  "version": "1.16.6",
+  "version": "1.16.8-alpha-d37885bfce4.0",
   "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.15.6",
-    "@trackunit/geo-json-utils": "1.14.6"
+    "@trackunit/shared-utils": "1.15.8-alpha-d37885bfce4.0",
+    "@trackunit/geo-json-utils": "1.14.8-alpha-d37885bfce4.0"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",

package/src/channels.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Canonical penpal channel names used by `@trackunit/iris-app-runtime-core`.
+ *
+ * External iris-app publishers building against `@trackunit/iris-app-runtime-core`
+ * must pass one of these strings to `useSubscribeToHostChanges(methods, channel)`
+ * so the child connection lines up with the host's `usePenpalIframe({ channel })`.
+ *
+ * The module-level singleton connector uses {@link Channels.HostRuntime}; the
+ * remaining channels are dedicated to the five subscription providers
+ * (token, time-range, filter bar, widget config, asset sorting).
+ *
+ * Channel strings outside this set are reserved for future use and should not
+ * be passed to penpal `connect({ channel })` today.
+ */
+export declare const Channels: {
+    readonly HostRuntime: "host-runtime";
+    readonly TokenSubscription: "token-subscription";
+    readonly TimeRangeSubscription: "time-range-subscription";
+    readonly FilterBarSubscription: "filter-bar-subscription";
+    readonly WidgetConfigSubscription: "widget-config-subscription";
+    readonly AssetSortingSubscription: "asset-sorting-subscription";
+};
+/**
+ * String-literal union of the canonical penpal channel names exported by
+ * {@link Channels}.
+ *
+ * External iris-app publishers must pass a value of this type to
+ * `useSubscribeToHostChanges(methods, channel)`; the module-level singleton
+ * uses `Channels.HostRuntime`. Custom channel strings outside this set are
+ * reserved for future use.
+ */
+export type Channel = (typeof Channels)[keyof typeof Channels];

package/src/index.d.ts

@@ -1,6 +1,7 @@
 export * from "./AnalyticsRuntime";
 export * from "./AssetRuntime";
 export * from "./AssetSortingRuntime";
+export * from "./channels";
 export * from "./ChildConnector";
 export * from "./ConfirmationDialogRuntime";
 export * from "./CurrentUserPreferenceRuntime";