@deeptrekker/api-domain 0.61.5 → 1.0.0

package/dist/types/server/index.d.ts

@@ -1,5 +1,4 @@
 /**
- * {@link ISessionCheck | 📖 See extended definition}
  *
  * SessionCheck
  *
@@ -7,7 +6,8 @@
  *
  * **Note 💡 Ensure the number-like property values are sent as strings when sent and are enclosed in quotes \"\"**
  *
- * @category SignalServer
+ * @group Server
+ * @category Signaling
  * @endpoint  `/session_check`
  * @protocol *wss* | *https*
  */
@@ -18,13 +18,15 @@ export type SessionCheck = {
  * Client
  *
  * Identify a client through its named and connection ids
+ *
+ * @group Server
+ * @category Signaling
  */
 export type Client = {
     client_id: string;
     connection_id: string;
 };
 /**
- * {@link ISession | 📖 See extended definition}
  *
  * Session
  *
@@ -32,7 +34,8 @@ export type Client = {
  *
  * **Note 💡 Ensure the number-like property values are sent as strings when sent and are enclosed in quotes \"\"**
  *
- * @category SignalServer
+ * @group Server
+ * @category Signaling
  * @endpoint  `/session_list`
  * @protocol *wss* | *https*
  * @response Response to {@link SessionCheck}.
@@ -43,19 +46,18 @@ export type Session = {
     clients: Client[];
 };
 /**
- * {@link IJoinSession | 📖 See extended definition}
  *
  * RegisterSession
  *
  * Creates a new session using a unique vehicle id.
  *
- * @category SignalServer
+ * @group Server
+ * @category Signaling
  * @protocol *wss* | *https*
  * @endpoint  `/register_session`
  */
 export type RegisterSession = string;
 /**
- * {@link IJoinSession | 📖 See extended definition}
  *
  * JoinSession
  *
@@ -65,7 +67,8 @@ export type RegisterSession = string;
  *
  * @typeParam T - BridgeBox
  *
- * @category SignalServer
+ * @group Server
+ * @category Signaling
  * @protocol *wss* | *https*
  * @endpoint  `/join_session`
  */
@@ -74,13 +77,13 @@ export type JoinSession = {
     session_id: string;
 };
 /**
- * {@link ILeaveSession | 📖 See extended definition}
  *
  * LeaveSession
  *
  * **Note 💡 Ensure the number-like property values are sent as strings when sent and are enclosed in quotes \"\"**
  *
- * @category SignalServer
+ * @group Server
+ * @category Signaling
  * @protocol *wss* | *https*
  * @endpoint  `/leave_session`
  */
@@ -90,6 +93,9 @@ export type LeaveSession = {
 };
 /**
  * SdpMessageType
+ *
+ * @group Server
+ * @category Signaling
  */
 export declare enum SdpMessageType {
     Answer = "answer",
@@ -99,11 +105,19 @@ export declare enum SdpMessageType {
  * SdpMessage (used internally)
  *
  * **Note 💡 Ensure the number-like property values are sent as strings when sent and are enclosed in quotes \"\"**
+ * @group Server
+ * @category Signaling
  */
 export type SdpMessage = {
     type: SdpMessageType;
     sdp: string;
 };
+/**
+ * Offer/answer message that gets sent to establish peer connections.
+ *
+ * @group Server
+ * @category Signaling
+ */
 export type OfferAnswer = {
     sdp: RTCSessionDescription;
     caller?: string;
@@ -111,25 +125,25 @@ export type OfferAnswer = {
     sessionId?: string;
 };
 /**
- * {@link IOffer | 📖 See extended definition}
  *
  * Offer
  *
  * **Note 💡 Ensure the number-like property values are sent as strings when sent and are enclosed in quotes \"\"**
  *
- * @category SignalServer
+ * @group Server
+ * @category Signaling
  * @protocol *wss* | *https*
  * @endpoint  `/offer`
  */
 export type Offer = OfferAnswer;
 /**
- * {@link IAnswer | 📖 See extended definition}
  *
  * Answer
  *
  * **Note 💡 Ensure the number-like property values are sent as strings when sent and are enclosed in quotes \"\"**
  *
- * @category SignalServer
+ * @group Server
+ * @category Signaling
  * @protocol *wss* | *https*
  * @endpoint  `/answer`
  */
@@ -138,6 +152,8 @@ export type Answer = OfferAnswer;
  * SdpMessage (used internally)
  *
  * **Note 💡 Ensure the number-like property values are sent as strings when sent and are enclosed in quotes \"\"**
+ * @group Server
+ * @category Signaling
  */
 export type IceCandidateMessage = {
     sdpMid: string;
@@ -145,17 +161,16 @@ export type IceCandidateMessage = {
     content: string;
 };
 /**
- * {@link IIceCandidate | 📖 See extended definition}
  *
  * IceCandidate
  *
  * **Note 💡 Ensure the number-like property values are sent as strings when sent and are enclosed in quotes \"\"**
  *
- * @category SignalServer
+ * @group Server
+ * @category Signaling
  * @protocol *wss* | *https*
  * @endpoint `/ice_candidate`
  *
- * {@codeblock ~~/dist/samples/json/server/iceCandidate.json}
  */
 export type IceCandidate = {
     target?: string;
@@ -164,15 +179,15 @@ export type IceCandidate = {
     candidate?: IceCandidateMessage;
 };
 /**
- * {@link IOnDisconnectAsync | 📖 See extended definition}
  *
  * OnDisconnectAsync
  *
  * See base method documentation on {@link https://docs.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.signalr.hub.ondisconnectedasync?view=aspnetcore-3.1 | OnDisconnectAsync}
  *
  * @override
- * @category SignalServer
+ * @group Server
+ * @category Signaling
  * @protocol *wss* | *https*
  * @endpoint  `/session_closed`
  */
-export type OnDisconnectAsync = {};
+export type OnDisconnectAsync = () => void;

package/dist/types/server/index.js

@@ -1,28 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SdpMessageType = void 0;
-/**
- *
- *  RegisterSession
- *
- * Creates a new session using a unique vehicle id.
- *
- * **Note 💡 Ensure the number-like property values are sent as strings when sent and are enclosed in quotes \"\"**
- *
- * @notExported
- * {@link JoinSession | See type declaration}
- * @category SignalServer
- * @protocol *wss* | *https*
- * @endpoint  `/register_session`
- *
- * {@codeblock ~~/dist/samples/json/server/registerSession.json}
- */
-var IRegisterSession = "";
 /**
  * SdpMessageType
+ *
+ * @group Server
+ * @category Signaling
  */
 var SdpMessageType;
 (function (SdpMessageType) {
     SdpMessageType["Answer"] = "answer";
     SdpMessageType["Offer"] = "offer";
-})(SdpMessageType = exports.SdpMessageType || (exports.SdpMessageType = {}));
+})(SdpMessageType || (exports.SdpMessageType = SdpMessageType = {}));

package/dist/types/swupdates/index.d.ts

@@ -1,4 +1,9 @@
 import { DeviceModel } from "../devices";
+/**
+ * Offline Update State
+ * @group Devices
+ * @category Software Updates
+ */
 export declare enum OfflineUpdateState {
     OFFLINE_AVAILABLE = 0,
     UPTODATE = 1,
@@ -10,26 +15,28 @@ export declare enum OfflineUpdateState {
  * FileTransfer
  *
  * Describe the meta data related to a generic file transfer.
+ * @group Devices
+ * @category Software Updates
  */
 export type FileTransfer = {
     /**
      * File size
-     * @description Total number of bytes of the file.
+     * @remarks Total number of bytes of the file.
      */
     size?: number;
     /**
      * File name
-     * @description The plain file name with file extension. May not contain directory structures.
+     * @remarks The plain file name with file extension. May not contain directory structures.
      */
     name?: string;
     /**
      * Checksum
-     * @description The sha256 checksum used to verify the file content after transfer.
+     * @remarks The sha256 checksum used to verify the file content after transfer.
      */
     sha256?: string;
     /**
      * readyToTransfer
-     * @description Indicate the receiver is ready for the file transfer. Sender should await
+     * @remarks Indicate the receiver is ready for the file transfer. Sender should await
      * this response before sending a byte stream via WebRTC. May not send multiple files
      * to a single endpoint at a time. If multiple files are attempted to be sent simultaneously
      * the receiver should send an error message.
@@ -41,16 +48,18 @@ export type FileTransfer = {
  * SWUpdate
  *
  * An endpoint to facilitate the software update process.
+ * @group Devices
+ * @category Software Updates
  */
 export type SWUpdate = {
     /**
      * File
-     * @description Define the update package tar file to be transferred.
+     * @remarks Define the update package tar file to be transferred.
      */
     file?: FileTransfer;
     /**
      * Progress
-     * @description Percentage complete indicator.
+     * @remarks Percentage complete indicator.
      * @readonly
      *
      * @minimum 0
@@ -59,20 +68,58 @@ export type SWUpdate = {
     progress?: number;
     /**
      * Log
-     * @description Provides messages driven by state of the update. WebApp may
+     * @remarks Provides messages driven by state of the update. WebApp may
      * choose to display these messages as they are delivered.
      * @readonly
      */
     log?: string;
     /**
-     * OfflineUpdates
-     * @description Informs user of the current state of offline updates.
+     * # Description
+     * Informs user of the current state of offline updates.
      * User can also set this state to start offline updates or check for available ones.
+     * # JSON Examples
+     * ## Check for offline updates
+     * ## Offline updates available
+     * ```json
+     * {
+     *   "apiVersion": "1.0.0",
+     *   "method": "UPDATE",
+     *   "payload": {
+     *     "swupdate": {
+     *       "offlineUpdates": 1
+     *     }
+     *   }
+     * }
+     * ```
+     * ## System up-to-date (No new offline updates available)
+     * ```json
+     * {
+     *   "apiVersion": "1.0.0",
+     *   "method": "UPDATE",
+     *   "payload": {
+     *     "swupdate": {
+     *       "offlineUpdates": 1
+     *     }
+     *   }
+     * }
+     * ```
+     * ## Start offline updates
+     * ```json
+     * {
+     *   "apiVersion": "1.0.0",
+     *   "method": "SET",
+     *   "payload": {
+     *     "swupdate": {
+     *       "offlineUpdates": 4
+     *     }
+     *   }
+     * }
+     * ```
      */
     offlineUpdates?: OfflineUpdateState;
     /**
      * ReleaseInfo
-     * @description Returns a valid stringified JSON that contains
+     * @remarks Returns a valid stringified JSON that contains
      * a map of device models to their latest available versions.
      * These latest versions could be the same as the current versions of the robot/peripherals
      * in which case, there would be no available update.
@@ -83,6 +130,8 @@ export type SWUpdate = {
  * VersionNote
  *
  * Describes changes made in a software update, an array of improvements and bug fixes.
+ * @group Devices
+ * @category Software Updates
  */
 export type VersionNote = {
     improvements: string[];
@@ -92,6 +141,8 @@ export type VersionNote = {
  * SoftwareUpdate
  *
  * Describes a software update giving a release date and corresponding version notes.
+ * @group Devices
+ * @category Software Updates
  */
 export type SoftwareUpdate = {
     releaseDate: string;
@@ -101,6 +152,8 @@ export type SoftwareUpdate = {
  * HardwareRevision
  *
  * A list of software updates for specific hardware.
+ * @group Devices
+ * @category Software Updates
  */
 export type HardwareRevision = {
     [softwareVersion: string]: SoftwareUpdate;
@@ -110,6 +163,8 @@ export type HardwareRevision = {
  * HardwareRevisions
  *
  * A list of corresponding hardware revisions.
+ * @group Devices
+ * @category Software Updates
  */
 export type HardwareRevisions = {
     [hardwareRevision: string]: HardwareRevision;
@@ -118,6 +173,8 @@ export type HardwareRevisions = {
  * Changelog
  *
  * An package containing information related to an update of one or more devices.
+ * @group Devices
+ * @category Software Updates
  */
 export type Changelog = {
     [deviceModel in DeviceModel | "BRIDGEBOX"]?: HardwareRevisions;
@@ -126,29 +183,31 @@ export type Changelog = {
  * UpdatePackagePayload
  *
  * An package containing information related to an update of one or more devices.
+ * @group Devices
+ * @category Software Updates
  */
 export type UpdatePackagePayload = {
     /**
      * buildDate
-     * @description Provides a build date to UpdatePackage.
+     * @remarks Provides a build date to UpdatePackage.
      * @readonly
      */
     buildDate: string;
     /**
      * size
-     * @description Total number of bytes of the file.
+     * @remarks Total number of bytes of the file.
      * @readonly
      */
     size: string;
     /**
      * sha256
-     * @description The sha256 checksum used to verify the file content after transfer.
+     * @remarks The sha256 checksum used to verify the file content after transfer.
      * @readonly
      */
     sha256: string;
     /**
      * Changelog
-     * @description A list changes reflecting devices and their hardware and software revisions.
+     * @remarks A list changes reflecting devices and their hardware and software revisions.
      * @readonly
      */
     changelog: Changelog;

package/dist/types/swupdates/index.js

@@ -1,6 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OfflineUpdateState = void 0;
+/**
+ * Offline Update State
+ * @group Devices
+ * @category Software Updates
+ */
 var OfflineUpdateState;
 (function (OfflineUpdateState) {
     //Backend States, do not set these from the front-end.
@@ -10,4 +15,4 @@ var OfflineUpdateState;
     //User states
     OfflineUpdateState[OfflineUpdateState["CHECK_FOR_UPDATES"] = 3] = "CHECK_FOR_UPDATES";
     OfflineUpdateState[OfflineUpdateState["START_OFFLINE_UPDATE"] = 4] = "START_OFFLINE_UPDATE";
-})(OfflineUpdateState = exports.OfflineUpdateState || (exports.OfflineUpdateState = {}));
+})(OfflineUpdateState || (exports.OfflineUpdateState = OfflineUpdateState = {}));

package/dist/utils/index.d.ts

@@ -1,7 +1,6 @@
 import Ajv from "ajv";
 import { OmitStrict } from "type-zoo";
-import { TransferPayload } from "../samples";
-import { VehicleModelMap, ReelModelMap, VehicleDeviceFromModel, BridgeBox, CameraHeadDeviceFromModel, CameraDeviceFromModel, DeviceModel, ReelDeviceFromModel } from "../types";
+import { VehicleModelMap, ReelModelMap, VehicleDeviceFromModel, BridgeBox, CameraHeadDeviceFromModel, CameraDeviceFromModel, DeviceModel, ReelDeviceFromModel, TransferPayload } from "../types";
 export declare const ajv: Ajv;
 /** BridgeBox Web API validator. This can validate requests that are sent and received through the API */
 export declare const validate: (req: TransferPayload<BridgeBox>) => TransferPayload<BridgeBox>;

package/dist/utils/index.js

@@ -10,15 +10,20 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.payload = exports.validate = exports.ajv = void 0;
-var ajv_1 = require("ajv");
+exports.validate = exports.ajv = void 0;
+exports.payload = payload;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+var ajv_1 = __importDefault(require("ajv"));
 var ts_pattern_1 = require("ts-pattern");
-var samples_1 = require("../samples");
 var types_1 = require("../types");
 exports.ajv = new ajv_1.default();
 /** Compiled JSON schema Validator */
-var Validator = exports.ajv.compile(require("../../dist/schemas/schema.json"));
+var schema_json_1 = __importDefault(require("../constants/schema/schema.json"));
+var Validator = exports.ajv.compile(schema_json_1.default);
 /** BridgeBox Web API validator. This can validate requests that are sent and received through the API */
 var validate = function (req) {
     var _a;
@@ -40,7 +45,7 @@ function payload() {
     return function (payload) {
         var _a;
         var _b, _c, _d, _e;
-        return (0, exports.validate)(__assign(__assign({}, (0, samples_1.getApiRequest)(samples_1.TransferMethodType.Set)), { payload: __assign({}, (models[0]
+        return (0, exports.validate)(__assign(__assign({}, getApiRequest(types_1.TransferMethodType.Set)), { payload: __assign({}, (models[0]
                 ? {
                     devices: (_a = {},
                         _a[models[0][ID_INDEX]] = __assign({ model: (_b = models[0]) === null || _b === void 0 ? void 0 : _b[MODEL_INDEX] }, (((_c = models[1]) === null || _c === void 0 ? void 0 : _c[MODEL_INDEX]) === undefined ||
@@ -78,4 +83,10 @@ function payload() {
                 : payload)) })).payload;
     };
 }
-exports.payload = payload;
+function getApiRequest(method) {
+    return {
+        apiVersion: "1.0.0",
+        method: method,
+        payload: {},
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@deeptrekker/api-domain",
-    "version": "0.61.5",
+    "version": "1.0.0",
     "description": "A business domain of types and schemas that the Deep Trekker topside communicates with via an API.",
     "main": "dist/index.js",
     "engines": {
@@ -12,14 +12,15 @@
         "dist/*"
     ],
     "scripts": {
-        "build": "rimraf ./dist ./docs && yarn set-versions && tsc && yarn schema && yarn generate-sample && npx typedoc && yarn copy-dist && yarn replace-code-blocks-css && tsc",
-        "schema": "ts-json-schema-generator --path src/types/schemas/index.ts --type __TransferPayload_BridgeBox -o dist/schemas/schema.json",
-        "docs": "npx typedoc",
+        "build": "rimraf ./dist ./docs && yarn set-versions && tsc && yarn schema && yarn docs && yarn copy-dist && yarn replace-code-blocks-css",
+        "schema": "ts-json-schema-generator --path src/types/schemas/index.ts --type __TransferPayload_BridgeBox -o src/constants/schema/schema.json",
+        "docs": "npx typedoc --options typedoc.json",
         "set-versions": "node scripts/setVersions.js",
-        "generate-sample": "npx typedoc --tsconfig tsconfigSamples.json && ts-node scripts/generateSamples.ts",
-        "copy-dist": "ts-node scripts/copyDist.ts",
+        "generate-sample": "npx typedoc src/index.ts  --tsconfig tsconfigSamples.json && ts-node scripts/generateSamples.js",
+        "copy-dist": "ts-node scripts/copyDist.js",
+        "lint": "eslint . --ext .ts,.tsx",
         "test": "echo \"Error: no test specified\" && exit 1",
-        "replace-code-blocks-css": "ts-node scripts/replaceCodeBlocksCss.ts",
+        "replace-code-blocks-css": "ts-node scripts/replaceCodeBlocksCss.js",
         "clean-publish": "yarn && node scripts/publish.js"
     },
     "author": "",
@@ -35,16 +36,21 @@
     "devDependencies": {
         "@knodes/typedoc-plugin-code-blocks": "^0.22.7",
         "@types/lodash": "^4.14.182",
-        "@types/node": "^18.0.0",
+        "@types/node": "^22.0.0",
+        "@typescript-eslint/eslint-plugin": "^6.1.0",
+        "@typescript-eslint/parser": "^6.1.0",
         "@zamiell/typedoc-plugin-not-exported": "^0.2.0",
+        "eslint": "^8.45.0",
+        "eslint-config-prettier": "^8.8.0",
+        "eslint-plugin-unused-imports": "^3.0.0",
         "prettier": "3.0.3",
         "rimraf": "^3.0.2",
         "semver-compare-cli": "^2.0.0",
-        "ts-json-schema-generator": "^1.0.0",
+        "ts-json-schema-generator": "2.4.0",
         "ts-node": "^10.8.1",
         "tslib": "^2.4.0",
-        "typedoc": "^0.22.15",
-        "typescript": "^4.9.5"
+        "typedoc": "^0.28.9",
+        "typescript": "^5.9"
     },
     "dependencies": {
         "@js-temporal/polyfill": "^0.4.4",