@robotical/webapp-types 3.17.51 → 3.17.52

package/dist-types/src/wrapper-app/connectors/Connector.d.ts

@@ -4,13 +4,14 @@ import { ConnectionAttemptResults, RaftTypeE } from "../../types/raft";
 import { RaftObserver } from "../../application/RAFTs/RaftObserver";
 import ConnectorInterface from "./ConnectorInterface";
 import { ConnManager, RICLedLcdColours } from "@robotical/roboticaljs";
-import { RaftOKFail, RaftConnEvent, RaftUpdateEvent, RaftPublishEvent } from "@robotical/raftjs";
+import { RaftOKFail, RaftConnEvent, RaftUpdateEvent, RaftPublishEvent } from "@robdobsn/raftjs";
 declare class Connector implements ConnectorInterface {
     id: string;
     type: RaftTypeE;
     protected _observers: {
         [key: string]: Array<RaftObserver>;
     };
+    private _onDisconnected?;
     connManager: ConnManager;
     constructor(id: string, connManager: ConnManager);
     /**
@@ -20,7 +21,7 @@ declare class Connector implements ConnectorInterface {
     /**
      * Get connected raft info
      */
-    getSystemInfo(): Promise<import("@robotical/raftjs").RaftSystemInfo>;
+    getSystemInfo(): Promise<import("@robdobsn/raftjs").RaftSystemInfo>;
     /**
      * Gets the RAFT name
      */
@@ -37,6 +38,17 @@ declare class Connector implements ConnectorInterface {
      * Disconnect from a RAFT
      */
     disconnect(): Promise<boolean>;
+    /**
+     * Register the manager-owned cleanup callback for a terminal disconnect event.
+     */
+    setOnDisconnected(onDisconnected: () => void): void;
+    /**
+     * Best-effort synchronous cleanup for page navigation/unload. Prefer the
+     * ConnManager boundary so its connection generation and Web BLE lease are
+     * finalized as well. The fallback keeps this app compatible with an older
+     * RoboticalJS package while the new ConnManager API is being released.
+     */
+    disconnectForPageUnload(): void;
     /**
      * Stop verifying RAFT
      * @param confirmCorrectRIC - indicates if the correct RAFT was selected (user input)

package/dist-types/src/wrapper-app/connectors/Connector.js

@@ -38,7 +38,7 @@ import { RaftInfoEvents } from "../../types/events/raft-info";
 import { WrapperSentMessage } from "../../types/communication-between-apps/wrapper-communication";
 import Logger from "../../services/logger/Logger";
 import { RaftTypeE } from "../../types/raft";
-import { RaftConnEvent, RaftUpdateEvent, RICRESTElemCode, } from "@robotical/raftjs";
+import { RaftConnEvent, RaftUpdateEvent, RICRESTElemCode, } from "@robdobsn/raftjs";
 var SHOW_LOGS = true;
 var TAG = "Connector";
 var formatRestCommand = function (msg, params) {
@@ -64,6 +64,7 @@ var Connector = /** @class */ (function () {
         // Set the listener function
         // Subscribe to connManager events
         this.connManager.setConnectionEventListener(function (eventType, eventEnum, eventName, eventData) {
+            var _a;
             if (eventType === "pub") {
                 // if it's a pub event, we are publishing it from _pubEventHandler method (in child classes)
             }
@@ -72,6 +73,9 @@ var Connector = /** @class */ (function () {
                 _this.publish(eventType, eventEnum, eventName, eventData);
             }
             _this.eventHandler(eventType, eventEnum, eventName, eventData);
+            if (eventType === "conn" && eventEnum === RaftConnEvent.CONN_DISCONNECTED) {
+                (_a = _this._onDisconnected) === null || _a === void 0 ? void 0 : _a.call(_this);
+            }
         });
     }
     /**
@@ -158,6 +162,26 @@ var Connector = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Register the manager-owned cleanup callback for a terminal disconnect event.
+     */
+    Connector.prototype.setOnDisconnected = function (onDisconnected) {
+        this._onDisconnected = onDisconnected;
+    };
+    /**
+     * Best-effort synchronous cleanup for page navigation/unload. Prefer the
+     * ConnManager boundary so its connection generation and Web BLE lease are
+     * finalized as well. The fallback keeps this app compatible with an older
+     * RoboticalJS package while the new ConnManager API is being released.
+     */
+    Connector.prototype.disconnectForPageUnload = function () {
+        var connManagerWithPageUnload = this.connManager;
+        if (typeof connManagerWithPageUnload.disconnectForPageUnload === "function") {
+            connManagerWithPageUnload.disconnectForPageUnload();
+            return;
+        }
+        this.connManager.getConnector().disconnectForPageUnload();
+    };
     /**
      * Stop verifying RAFT
      * @param confirmCorrectRIC - indicates if the correct RAFT was selected (user input)

package/dist-types/src/wrapper-app/connectors/ConnectorFactory.d.ts

@@ -10,6 +10,6 @@ export default class ConnectorFactory {
      * @returns Promise<ConnectionAttemptResults>
      *
      */
-    static connectToRaftHelper(method: RaftConnectionMethod, uuids: string[]): Promise<Connector | null>;
+    static connectToRaftHelper(method: RaftConnectionMethod, uuids: string[], onConnManagerCreated?: (connManager: ConnManager) => void): Promise<Connector | null>;
     static createConnector(raftType: string | undefined, connManager: ConnManager): Connector;
 }

package/dist-types/src/wrapper-app/connectors/ConnectorFactory.js

@@ -52,16 +52,21 @@ var ConnectorFactory = /** @class */ (function () {
      * @returns Promise<ConnectionAttemptResults>
      *
      */
-    ConnectorFactory.connectToRaftHelper = function (method, uuids) {
+    ConnectorFactory.connectToRaftHelper = function (method, uuids, onConnManagerCreated) {
         return __awaiter(this, void 0, void 0, function () {
-            var connManager, wasConnected, systemInfo, raftType, connector;
+            var connManager, connectorWasCreated, wasConnected, systemInfo, raftType, connector, error_1;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
                         connManager = new ConnManager();
+                        connectorWasCreated = false;
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, , 3, 8]);
+                        onConnManagerCreated === null || onConnManagerCreated === void 0 ? void 0 : onConnManagerCreated(connManager);
                         Logger.info(SHOW_LOGS, TAG, "Connecting to RAFT with method: ".concat(method));
                         return [4 /*yield*/, connManager.connect(method, "", uuids)];
-                    case 1:
+                    case 2:
                         wasConnected = _a.sent();
                         Logger.info(SHOW_LOGS, TAG, "Was connected to RAFT: ".concat(wasConnected));
                         if (!wasConnected) {
@@ -70,7 +75,23 @@ var ConnectorFactory = /** @class */ (function () {
                         systemInfo = connManager.getConnector().getRaftSystemUtils().getCachedSystemInfo();
                         raftType = systemInfo === null || systemInfo === void 0 ? void 0 : systemInfo.SystemName;
                         connector = this.createConnector(raftType, connManager);
+                        connectorWasCreated = true;
                         return [2 /*return*/, connector];
+                    case 3:
+                        if (!!connectorWasCreated) return [3 /*break*/, 7];
+                        _a.label = 4;
+                    case 4:
+                        _a.trys.push([4, 6, , 7]);
+                        return [4 /*yield*/, connManager.disconnect()];
+                    case 5:
+                        _a.sent();
+                        return [3 /*break*/, 7];
+                    case 6:
+                        error_1 = _a.sent();
+                        Logger.warn(SHOW_LOGS, TAG, "Failed to clean up uncommitted RAFT connection: ".concat(error_1));
+                        return [3 /*break*/, 7];
+                    case 7: return [7 /*endfinally*/];
+                    case 8: return [2 /*return*/];
                 }
             });
         });

package/dist-types/src/wrapper-app/connectors/ConnectorInterface.d.ts

@@ -1,4 +1,4 @@
-import { RaftConnEvent, RaftPublishEvent, RaftUpdateEvent } from "@robotical/raftjs";
+import { RaftConnEvent, RaftPublishEvent, RaftUpdateEvent } from "@robdobsn/raftjs";
 import { ConnectionAttemptResults, RaftTypeE } from "../../types/raft";
 import { RaftInfoEvents } from "../../types/events/raft-info";
 import { RICLedLcdColours } from "@robotical/roboticaljs";

package/dist-types/src/wrapper-app/connectors/MartyConnector/MartyConnector.d.ts

@@ -2,7 +2,7 @@ import { RaftInfoEvents } from "../../../types/events/raft-info";
 import { ConnectionAttemptResults, RaftTypeE } from "../../../types/raft";
 import Connector from "../Connector";
 import ConnectorInterface from "../ConnectorInterface";
-import { RaftConnEvent, RaftUpdateEvent, RaftPublishEvent } from "@robotical/raftjs";
+import { RaftConnEvent, RaftUpdateEvent, RaftPublishEvent } from "@robdobsn/raftjs";
 import { ConnManager } from "@robotical/roboticaljs";
 declare class MartyConnector extends Connector implements ConnectorInterface {
     type: RaftTypeE;

package/dist-types/src/wrapper-app/connectors/MartyConnector/MartyConnector.js

@@ -54,7 +54,7 @@ import { RaftInfoEvents } from "../../../types/events/raft-info";
 import Logger from "../../../services/logger/Logger";
 import { RaftTypeE } from "../../../types/raft";
 import Connector from "../Connector";
-import { RaftConnEvent, RaftUpdateEvent, RaftPublishEvent, } from "@robotical/raftjs";
+import { RaftConnEvent, RaftUpdateEvent, RaftPublishEvent, } from "@robdobsn/raftjs";
 import { RICServoParamUpdater, RICSystemUtils, } from "@robotical/roboticaljs";
 import { WrapperSentMessage } from "../../../types/communication-between-apps/wrapper-communication";
 var SHOW_LOGS = true;

package/dist-types/src/wrapper-app/utils/ColourSensorManualCalibratorMarty.d.ts

@@ -1,4 +1,4 @@
-import { RaftConnector } from "@robotical/raftjs";
+import { RaftConnector } from "@robdobsn/raftjs";
 import { ColourSensorCalibrationStage } from "../../types/colour-sensor-calibration";
 export default class ColourSensorManualCalibratorMarty {
     private static _raftConnector;

package/package.json

@@ -1,11 +1,20 @@
 {
   "name": "@robotical/webapp-types",
-  "version": "3.17.51",
+  "version": "3.17.52",
   "description": "Type definitions for the Application Manager",
   "main": "dist/application-manager.d.ts",
   "types": "dist/application-manager.d.ts",
   "author": "Nikos Theodoropoulos",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/robotical/marty-web-app.git",
+    "directory": "types-package"
+  },
+  "peerDependencies": {
+    "@robdobsn/raftjs": "^2.1.6",
+    "@robotical/roboticaljs": "^1.1.27"
+  },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"