@deeptrekker/api-channels 0.8.0 → 0.8.1-testingconnectionfix.1

package/dist/lib/channels/index.d.ts

@@ -1,9 +1,9 @@
-import { ConfigProperties, ConnectionSettings, WebRtcOptions } from "@types";
-/**
- * Establish Full Connection
- *
- * Sets up the {@link HubConnection} and then initializes the {@link RTCPeerConnection}.
- * @param connectionSettings {@link ConnectionSettings}
- * @param callbacks {@link WebRtcOptions}
- */
-export declare const establishFullConnection: (connectionSettings: ConnectionSettings, callbacks: WebRtcOptions, configProperties?: ConfigProperties) => Promise<void>;
+import { ConfigProperties, ConnectionSettings, WebRtcOptions } from "@types";
+/**
+ * Establish Full Connection
+ *
+ * Sets up the {@link HubConnection} and then initializes the {@link RTCPeerConnection}.
+ * @param connectionSettings {@link ConnectionSettings}
+ * @param callbacks {@link WebRtcOptions}
+ */
+export declare const establishFullConnection: (connectionSettings: ConnectionSettings, callbacks: WebRtcOptions, configProperties?: ConfigProperties) => Promise<void>;

package/dist/lib/index.d.ts

@@ -1,3 +1,3 @@
-export * from "./channels";
-export * from "./signalR";
-export * from "./webRTC";
+export * from "./channels";
+export * from "./signalR";
+export * from "./webRTC";

package/dist/lib/signalR/index.d.ts

@@ -1,13 +1,13 @@
-import { HubConnection } from "@microsoft/signalr";
-import { ConfigProperties, ConnectionSettings } from "@types";
-export declare const getTime: () => string;
-/**
- * Connect to Server
- *
- * Attempts to connect to the signaling server
- * @param onConnectionSuccess The callback provided that returns the connected {@link HubConnection}
- * @param connectionSettings {@link ConnectionSettings} The provided connection settings used to determine what signaling server to connect other similar settings
- * @returns void
- *
- */
-export declare const connectToServer: (onConnectionSuccess: (socket: HubConnection) => void, connectionSettings: ConnectionSettings, configProperties: ConfigProperties) => Promise<void>;
+import { HubConnection } from "@microsoft/signalr";
+import { ConfigProperties, ConnectionSettings } from "@types";
+export declare const getTime: () => string;
+/**
+ * Connect to Server
+ *
+ * Attempts to connect to the signaling server
+ * @param onConnectionSuccess The callback provided that returns the connected {@link HubConnection}
+ * @param connectionSettings {@link ConnectionSettings} The provided connection settings used to determine what signaling server to connect other similar settings
+ * @returns void
+ *
+ */
+export declare const connectToServer: (onConnectionSuccess: (socket: HubConnection) => void, connectionSettings: ConnectionSettings, configProperties: ConfigProperties) => Promise<void>;

package/dist/lib/webRTC/index.d.ts

@@ -1,12 +1,12 @@
-import { HubConnection } from "@microsoft/signalr";
-import { ConfigProperties, WebRtcOptions } from "@types";
-export declare const peerConnections: Record<string, RTCPeerConnection | null>;
-export declare const closeAllPeerConnections: () => void;
-/**
- * Initialize WebRTC
- *
- * Negotiates a {@link RTCPeerConnection} with the provided {@link HubConnection} and relays information through the provided callbacks
- * @param socketRef The SignalR hub connection that will be used to negotiate the WebRTC connection
- * @param callbacks The grouping of callbacks that will return important information to the frontend
- */
-export declare const initializeWebRTC: (socketRef: HubConnection, callbacks: WebRtcOptions, configProperties: ConfigProperties) => void;
+import { HubConnection } from "@microsoft/signalr";
+import { ConfigProperties, WebRtcOptions } from "@types";
+export declare const peerConnections: Record<string, RTCPeerConnection | null>;
+export declare const closeAllPeerConnections: () => void;
+/**
+ * Initialize WebRTC
+ *
+ * Negotiates a {@link RTCPeerConnection} with the provided {@link HubConnection} and relays information through the provided callbacks
+ * @param socketRef The SignalR hub connection that will be used to negotiate the WebRTC connection
+ * @param callbacks The grouping of callbacks that will return important information to the frontend
+ */
+export declare const initializeWebRTC: (socketRef: HubConnection, callbacks: WebRtcOptions, configProperties: ConfigProperties) => void;

package/dist/types/index.d.ts

@@ -1,112 +1,112 @@
-import { HubConnection, LogLevel } from "@microsoft/signalr";
-/**
- * Answer Event
- *
- * An event triggered during the signaling process
- * @property {@link RTCSessionDescription} sdp: The session description protocol object. See WebRTC documentation for more details
- */
-export type AnswerEvent = {
-    sdp: RTCSessionDescription;
-    caller: string;
-};
-/**
- * Client
- *
- * A structure used for the signaling mechanism to identify connected users
- *
- * @property {@link string} client_id: The human-readable name that a client provides to the signaling server
- * @property {@link string} connection_id: The generated ID for a given client provided by the signaling server
- */
-export type Client = {
-    client_id: string;
-    connection_id: string;
-};
-/**
- * Session Info
- *
- * The session info used to generate a {@link RTCPeerConnection}
- *
- * @property {@link string} session_id: The session id provided by the signaling server
- * @property {@link string} connection_id: The vehicle's connection id generated by the signaling server
- * @property {@link Client}[] clients: The array of clients that are currently connected to this session
- */
-export type SessionInfo = {
-    session_id: string;
-    connection_id: string;
-    clients: Client[];
-};
-/**
- * Connection State
- *
- * Used to describe the current state of the Bridge Box connection process
- * @readonly
- * @enum
- * @member Searching - The connection process has not started yet
- * @member Connecting - Attempting to connect to the signaling server
- * @member Connected - The connection to Bridge Box has been established and WebRTC is being initialized to connect to the vehicle.
- * @member Error - An error occurred when during the connection process
- * @member SSL - The system detected a potential SSL validation error.
- * @member Ready - The connection to the vehicle is successful and both systems (client app & the vehicle) are able to communicate.
- */
-export declare enum ConnectionState {
-    Searching = 0,
-    Connecting = 1,
-    Connected = 2,
-    Error = 3,
-    SSL = 4,
-    Ready = 5
-}
-/**
- * Connection Settings
- *
- * These properties are used to customize the signaling server connection process.
- *
- * @property {string} ip: The desired ip address to connect to. If none are provided uses the [default ip address]({@link SIGNAL_SERVER_CONNECTION_STRING})
- * @property {boolean} reconnection: Indicates that the initial connection failed and now the system is attempting to connect again
- * @property {boolean} isElectron: Indicates whether or not the library is being used in an Electron application. Prevents certain states from being reached if it is.
- * @property {callback} onConnectionStateChange: Handler for the connectionState of Bridge Box.
- */
-export interface ConnectionSettings {
-    ip?: string;
-    reconnection?: boolean;
-    isElectron?: boolean;
-    connectionState?: ConnectionState;
-    onConnectionStateChange?: (newState: ConnectionState) => void;
-    onSocketConnected?: (socket: HubConnection) => void;
-}
-/**
- * WebRTC Options
- *
- * These callback functions provide access to important elements generated within this library
- *
- * @property {callback} onDataChannel: Triggered whenever a datachannel is created/received. Passes the newly created datachannel back
- * @property {callback} onTrackEvent: Triggered whenever a track event is received. Passes the new track back
- * @property {callback} onSessionList: Triggered whenever a session info event occurs. Passes the updated session info back
- * @property {callback} onJoinSession: Triggered whenever a session is joined. Passes back the session id of the joined session
- * @property {callback} onSessionClose: Triggered whenever the connection closes. No values are passed back
- * @property {callback} onConnectionStateChange: Triggered whenever the {@link RTCPeerConnection} state changes. Passes back the event
- * @property {callback} onError: Triggered whenever an error is encountered. Passes back the error
- */
-export interface WebRtcOptions {
-    onDataChannel: (dataChannel: RTCDataChannelEvent) => void;
-    onTrackEvent: (trackEvent: RTCVideoTrackInfo) => void;
-    onSessionList: (sessionList: SessionInfo[], callback: (session: SessionInfo) => void) => void;
-    onJoinSession: (session: SessionInfo) => void;
-    onSessionClose: () => void;
-    onConnectionStateChange: (event: Event) => void;
-    onError: (reason: unknown) => void;
-    onSessionInfo: (session: SessionInfo, call: (session: SessionInfo, connectionId: string) => void) => string | undefined;
-}
-export interface ConfigProperties {
-    connectionTimeout?: number;
-    abortConnectionTimeout?: number;
-    defaultPort?: number;
-    defaultAddress?: string;
-    defaultConnectionString?: string;
-    clientId?: string;
-    socketLogging?: LogLevel;
-}
-export type RTCVideoTrackInfo = {
-    trackEvent: RTCTrackEvent;
-    label: string;
-};
+import { HubConnection, LogLevel } from "@microsoft/signalr";
+/**
+ * Answer Event
+ *
+ * An event triggered during the signaling process
+ * @property {@link RTCSessionDescription} sdp: The session description protocol object. See WebRTC documentation for more details
+ */
+export type AnswerEvent = {
+    sdp: RTCSessionDescription;
+    caller: string;
+};
+/**
+ * Client
+ *
+ * A structure used for the signaling mechanism to identify connected users
+ *
+ * @property {@link string} client_id: The human-readable name that a client provides to the signaling server
+ * @property {@link string} connection_id: The generated ID for a given client provided by the signaling server
+ */
+export type Client = {
+    client_id: string;
+    connection_id: string;
+};
+/**
+ * Session Info
+ *
+ * The session info used to generate a {@link RTCPeerConnection}
+ *
+ * @property {@link string} session_id: The session id provided by the signaling server
+ * @property {@link string} connection_id: The vehicle's connection id generated by the signaling server
+ * @property {@link Client}[] clients: The array of clients that are currently connected to this session
+ */
+export type SessionInfo = {
+    session_id: string;
+    connection_id: string;
+    clients: Client[];
+};
+/**
+ * Connection State
+ *
+ * Used to describe the current state of the Bridge Box connection process
+ * @readonly
+ * @enum
+ * @member Searching - The connection process has not started yet
+ * @member Connecting - Attempting to connect to the signaling server
+ * @member Connected - The connection to Bridge Box has been established and WebRTC is being initialized to connect to the vehicle.
+ * @member Error - An error occurred when during the connection process
+ * @member SSL - The system detected a potential SSL validation error.
+ * @member Ready - The connection to the vehicle is successful and both systems (client app & the vehicle) are able to communicate.
+ */
+export declare enum ConnectionState {
+    Searching = 0,
+    Connecting = 1,
+    Connected = 2,
+    Error = 3,
+    SSL = 4,
+    Ready = 5
+}
+/**
+ * Connection Settings
+ *
+ * These properties are used to customize the signaling server connection process.
+ *
+ * @property {string} ip: The desired ip address to connect to. If none are provided uses the [default ip address]({@link SIGNAL_SERVER_CONNECTION_STRING})
+ * @property {boolean} reconnection: Indicates that the initial connection failed and now the system is attempting to connect again
+ * @property {boolean} isElectron: Indicates whether or not the library is being used in an Electron application. Prevents certain states from being reached if it is.
+ * @property {callback} onConnectionStateChange: Handler for the connectionState of Bridge Box.
+ */
+export interface ConnectionSettings {
+    ip?: string;
+    reconnection?: boolean;
+    isElectron?: boolean;
+    connectionState?: ConnectionState;
+    onConnectionStateChange?: (newState: ConnectionState) => void;
+    onSocketConnected?: (socket: HubConnection) => void;
+}
+/**
+ * WebRTC Options
+ *
+ * These callback functions provide access to important elements generated within this library
+ *
+ * @property {callback} onDataChannel: Triggered whenever a datachannel is created/received. Passes the newly created datachannel back
+ * @property {callback} onTrackEvent: Triggered whenever a track event is received. Passes the new track back
+ * @property {callback} onSessionList: Triggered whenever a session info event occurs. Passes the updated session info back
+ * @property {callback} onJoinSession: Triggered whenever a session is joined. Passes back the session id of the joined session
+ * @property {callback} onSessionClose: Triggered whenever the connection closes. No values are passed back
+ * @property {callback} onConnectionStateChange: Triggered whenever the {@link RTCPeerConnection} state changes. Passes back the event
+ * @property {callback} onError: Triggered whenever an error is encountered. Passes back the error
+ */
+export interface WebRtcOptions {
+    onDataChannel: (dataChannel: RTCDataChannelEvent) => void;
+    onTrackEvent: (trackEvent: RTCVideoTrackInfo) => void;
+    onSessionList: (sessionList: SessionInfo[], callback: (session: SessionInfo) => void) => void;
+    onJoinSession: (session: SessionInfo) => void;
+    onSessionClose: () => void;
+    onConnectionStateChange: (event: Event) => void;
+    onError: (reason: unknown) => void;
+    onSessionInfo: (session: SessionInfo, call: (session: SessionInfo, connectionId: string) => void) => string | undefined;
+}
+export interface ConfigProperties {
+    connectionTimeout?: number;
+    abortConnectionTimeout?: number;
+    defaultPort?: number;
+    defaultAddress?: string;
+    defaultConnectionString?: string;
+    clientId?: string;
+    socketLogging?: LogLevel;
+}
+export type RTCVideoTrackInfo = {
+    trackEvent: RTCTrackEvent;
+    label: string;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@deeptrekker/api-channels",
-    "version": "0.8.0",
+    "version": "0.8.1-testingconnectionfix.1",
     "description": "",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -11,11 +11,14 @@
         "dist/*"
     ],
     "scripts": {
-        "build": "rollup -c"
+        "build": "rollup -c",
+        "clean-publish": "yarn && node scripts/publish.js"
     },
     "dependencies": {
         "@microsoft/signalr": "^8.0.0",
         "@types/sdp-transform": "^2.4.6",
+        "dotenv-flow": "^4.1.0",
+        "fs-extra": "^11.3.2",
         "lodash": "^4.17.21",
         "sdp-transform": "^2.14.1"
     },