@deeptrekker/api-domain 0.31.1

package/dist/types/server/index.js

@@ -0,0 +1,28 @@
+"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/generated/server/registerSession.json}
+ */
+var IRegisterSession = "";
+/**
+ * SdpMessageType
+ */
+var SdpMessageType;
+(function (SdpMessageType) {
+    SdpMessageType["Answer"] = "answer";
+    SdpMessageType["Offer"] = "offer";
+})(SdpMessageType = exports.SdpMessageType || (exports.SdpMessageType = {}));

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

@@ -0,0 +1,134 @@
+import { DeviceModel } from "../devices";
+/**
+ * FileTransfer
+ *
+ * Describe the meta data related to a generic file transfer.
+ */
+export declare type FileTransfer = {
+    /**
+     * File size
+     * @description Total number of bytes of the file.
+     */
+    size?: number;
+    /**
+     * File name
+     * @description 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.
+     */
+    sha256?: string;
+    /**
+     * readyToTransfer
+     * @description 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.
+     * @readonly
+     */
+    readyToTransfer?: boolean;
+};
+/**
+ * SWUpdate
+ *
+ * An endpoint to facilitate the software update process.
+ */
+export declare type SWUpdate = {
+    /**
+     * File
+     * @description Define the update package tar file to be transferred.
+     */
+    file?: FileTransfer;
+    /**
+     * Progress
+     * @description Percentage complete indicator.
+     * @readonly
+     *
+     * @minimum 0
+     * @maximum 100
+     */
+    progress?: number;
+    /**
+     * Log
+     * @description Provides messages driven by state of the update. WebApp may
+     * choose to display these messages as they are delivered.
+     * @readonly
+     */
+    log?: string;
+};
+/**
+ * VersionNote
+ *
+ * Describes changes made in a software update, an array of improvements and bug fixes.
+ */
+export declare type VersionNote = {
+    improvements: string[];
+    fixes: string[];
+};
+/**
+ * SoftwareUpdate
+ *
+ * Describes a software update giving a release date and corresponding version notes.
+ */
+export declare type SoftwareUpdate = {
+    releaseDate: string;
+    versionNotes: VersionNote;
+};
+/**
+ * HardwareRevision
+ *
+ * A list of software updates for specific hardware.
+ */
+export declare type HardwareRevision = {
+    [softwareVersion: string]: SoftwareUpdate;
+};
+/**
+ *
+ * HardwareRevisions
+ *
+ * A list of corresponding hardware revisions.
+ */
+export declare type HardwareRevisions = {
+    [hardwareRevision: string]: HardwareRevision;
+};
+/**
+ * Changelog
+ *
+ * An package containing information related to an update of one or more devices.
+ */
+export declare type Changelog = {
+    [deviceModel in DeviceModel | "BRIDGEBOX"]?: HardwareRevisions;
+};
+/**
+ * UpdatePackagePayload
+ *
+ * An package containing information related to an update of one or more devices.
+ */
+export declare type UpdatePackagePayload = {
+    /**
+     * buildDate
+     * @description Provides a build date to UpdatePackage.
+     * @readonly
+     */
+    buildDate: string;
+    /**
+     * size
+     * @description Total number of bytes of the file.
+     * @readonly
+     */
+    size: string;
+    /**
+     * sha256
+     * @description 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.
+     * @readonly
+     */
+    changelog: Changelog;
+};

package/dist/types/swupdates/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,49 @@
+{
+    "name": "@deeptrekker/api-domain",
+    "version": "0.31.1",
+    "description": "A business domain of types and schemas that the DeepTrekker topside communicates with via an API.",
+    "main": "dist/index.js",
+    "files": [
+        "LICENSE.md",
+        "readme.md",
+        "dist/*"
+    ],
+    "scripts": {
+        "build": "rimraf ./dist ./docs && npm run set-versions && tsc && npm run schema && npm run generate-sample && npx typedoc && npm run copy-dist && npm run 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",
+        "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",
+        "test": "echo \"Error: no test specified\" && exit 1",
+        "postversion": "npm run set-versions && git commit -am 'increment version'",
+        "replace-code-blocks-css": "ts-node scripts/replaceCodeBlocksCss.ts"
+    },
+    "author": "",
+    "license": "SEE LICENSE IN LICENSE.md",
+    "repository": {
+        "type": "git",
+        "url": "git+ssh://git@bitbucket.org/deeptrekker/dt_bweb_api_domain.git"
+    },
+    "bugs": {
+        "url": "https://bitbucket.org/deeptrekker/dt_bweb_api_domain/issues"
+    },
+    "homepage": "https://bitbucket.org/deeptrekker/dt_bweb_api_domain#readme",
+    "devDependencies": {
+        "@knodes/typedoc-plugin-code-blocks": "^0.22.7",
+        "@types/lodash": "^4.14.182",
+        "@types/node": "^18.0.0",
+        "@zamiell/typedoc-plugin-not-exported": "^0.2.0",
+        "rimraf": "^3.0.2",
+        "semver-compare-cli": "^2.0.0",
+        "ts-json-schema-generator": "^1.0.0",
+        "ts-node": "^10.8.1",
+        "tslib": "^2.4.0",
+        "typedoc": "^0.22.15",
+        "typescript": "^4.6.3"
+    },
+    "dependencies": {
+        "lodash": "^4.17.21",
+        "mkdirp": "^1.0.4"
+    }
+}