@dronedeploy/rocos-js-sdk 3.1.7 → 4.0.0

package/README.md

@@ -19,6 +19,11 @@ yarn add @dronedeploy/rocos-js-sdk rxjs@^7
 
 ## What's new
 
+### 4.0.0
+
+* **BREAKING:** The default telemetry `transport` is now `'connect'` (the Connect protocol) instead of `'grpc-web'`. Consumers that do not set `transport` explicitly will switch to Connect automatically. If your backend or proxy only supports gRPC-web, restore the previous behaviour with `transport: 'grpc-web'`.
+* The `'grpc-web'` telemetry transport is deprecated and will be removed in a future release. Selecting it now logs a one-time deprecation warning.
+
 ### 3.1.2
 
 * Use the optional `fetch` implementation for the gRPC-web transport too, so a custom `fetch` can be supplied consistently across transports.

package/cjs/api/streams/telemetry/TelemetryStreamConnect.d.ts

@@ -3,7 +3,7 @@ import { TelemetryAckStatus, TelemetryQueryRequest, TelemetryRequest } from '../
 import { TelemetryStreamAbstract } from './TelemetryStreamAbstract';
 /**
  * Connect-protocol telemetry receive stream. Mirrors TelemetryStream (grpc-web) but uses
- * @connectrpc/connect. Selected when config.transport === 'connect'.
+ * @connectrpc/connect. The default transport, selected unless config.transport === 'grpc-web'.
  *
  * The shared TelemetryStreamAbstract is typed with the protobuf-ts message types, while the
  * Connect client uses @bufbuild/protobuf types. Both serialise to identical protobuf wire

package/cjs/api/streams/telemetry/TelemetryStreamConnect.js

@@ -11,7 +11,7 @@ const TelemetryStreamAbstract_1 = require("./TelemetryStreamAbstract");
 const connect_web_1 = require("@connectrpc/connect-web");
 /**
  * Connect-protocol telemetry receive stream. Mirrors TelemetryStream (grpc-web) but uses
- * @connectrpc/connect. Selected when config.transport === 'connect'.
+ * @connectrpc/connect. The default transport, selected unless config.transport === 'grpc-web'.
  *
  * The shared TelemetryStreamAbstract is typed with the protobuf-ts message types, while the
  * Connect client uses @bufbuild/protobuf types. Both serialise to identical protobuf wire

package/cjs/models/IStreamConfig.d.ts

@@ -1,5 +1,5 @@
 import { IStreamOptions } from './IStreamOptions';
-export type TelemetryTransport = 'grpc-web' | 'connect';
+export type TelemetryTransport = 'connect' | 'grpc-web';
 export interface IStreamConfig {
     url: string;
     token: string;

package/cjs/models/maps/Panorama.d.ts

@@ -21,7 +21,14 @@ export interface Panorama {
         pos: Vector3;
     };
     data: {
-        path: string;
+        /**
+         * Conventional location of the panorama image. Optional: it is not read by the SDK
+         * (nor required by the server), and a placeholder panorama may be created before the
+         * image exists.
+         */
+        path?: string;
+        /** The panorama node carries arbitrary data beyond the conventional fields above. */
+        [key: string]: unknown;
     };
 }
 /**

package/cjs/services/TelemetryService.d.ts

@@ -2,6 +2,7 @@ import { Observable } from 'rxjs';
 import { CallsignStatus, IRocosSDKConfig, IRocosTelemetryMessage, IStreamStatusMessage, ITelemetryStream, ITelemetryStreamConfig, ITelemetrySubscriptionParams, ITelemetrySubscriptions, TelemetryMonitorStatus } from '../models';
 import { BaseStreamService } from './BaseStreamService';
 export declare class TelemetryService extends BaseStreamService<ITelemetryStream, ITelemetryStreamConfig> {
+    private static grpcWebDeprecationWarned;
     private statusSubscription;
     private changeStream$;
     private streamStatusSubject$;

package/cjs/services/TelemetryService.js

@@ -177,10 +177,16 @@ class TelemetryService extends BaseStreamService_1.BaseStreamService {
         return newStream.stream;
     }
     getStream(config) {
-        if (config.transport === 'connect') {
-            return new TelemetryStreamConnect_1.TelemetryStreamConnect(config);
+        if (config.transport === 'grpc-web') {
+            if (!TelemetryService.grpcWebDeprecationWarned) {
+                TelemetryService.grpcWebDeprecationWarned = true;
+                this.logger.warn('The grpc-web telemetry transport is deprecated and will be removed in a future release. ' +
+                    'Switch to the Connect protocol by setting transport to "connect" (now the default).');
+            }
+            return new TelemetryStream_1.TelemetryStream(config);
         }
-        return new TelemetryStream_1.TelemetryStream(config);
+        return new TelemetryStreamConnect_1.TelemetryStreamConnect(config);
     }
 }
 exports.TelemetryService = TelemetryService;
+TelemetryService.grpcWebDeprecationWarned = false;

package/esm/api/streams/telemetry/TelemetryStreamConnect.d.ts

@@ -3,7 +3,7 @@ import { TelemetryAckStatus, TelemetryQueryRequest, TelemetryRequest } from '../
 import { TelemetryStreamAbstract } from './TelemetryStreamAbstract';
 /**
  * Connect-protocol telemetry receive stream. Mirrors TelemetryStream (grpc-web) but uses
- * @connectrpc/connect. Selected when config.transport === 'connect'.
+ * @connectrpc/connect. The default transport, selected unless config.transport === 'grpc-web'.
  *
  * The shared TelemetryStreamAbstract is typed with the protobuf-ts message types, while the
  * Connect client uses @bufbuild/protobuf types. Both serialise to identical protobuf wire

package/esm/api/streams/telemetry/TelemetryStreamConnect.js

@@ -8,7 +8,7 @@ import { TelemetryStreamAbstract } from './TelemetryStreamAbstract';
 import { createConnectTransport } from '@connectrpc/connect-web';
 /**
  * Connect-protocol telemetry receive stream. Mirrors TelemetryStream (grpc-web) but uses
- * @connectrpc/connect. Selected when config.transport === 'connect'.
+ * @connectrpc/connect. The default transport, selected unless config.transport === 'grpc-web'.
  *
  * The shared TelemetryStreamAbstract is typed with the protobuf-ts message types, while the
  * Connect client uses @bufbuild/protobuf types. Both serialise to identical protobuf wire

package/esm/models/IStreamConfig.d.ts

@@ -1,5 +1,5 @@
 import { IStreamOptions } from './IStreamOptions';
-export type TelemetryTransport = 'grpc-web' | 'connect';
+export type TelemetryTransport = 'connect' | 'grpc-web';
 export interface IStreamConfig {
     url: string;
     token: string;

package/esm/models/maps/Panorama.d.ts

@@ -21,7 +21,14 @@ export interface Panorama {
         pos: Vector3;
     };
     data: {
-        path: string;
+        /**
+         * Conventional location of the panorama image. Optional: it is not read by the SDK
+         * (nor required by the server), and a placeholder panorama may be created before the
+         * image exists.
+         */
+        path?: string;
+        /** The panorama node carries arbitrary data beyond the conventional fields above. */
+        [key: string]: unknown;
     };
 }
 /**

package/esm/services/TelemetryService.d.ts

@@ -2,6 +2,7 @@ import { Observable } from 'rxjs';
 import { CallsignStatus, IRocosSDKConfig, IRocosTelemetryMessage, IStreamStatusMessage, ITelemetryStream, ITelemetryStreamConfig, ITelemetrySubscriptionParams, ITelemetrySubscriptions, TelemetryMonitorStatus } from '../models';
 import { BaseStreamService } from './BaseStreamService';
 export declare class TelemetryService extends BaseStreamService<ITelemetryStream, ITelemetryStreamConfig> {
+    private static grpcWebDeprecationWarned;
     private statusSubscription;
     private changeStream$;
     private streamStatusSubject$;

package/esm/services/TelemetryService.js

@@ -174,9 +174,15 @@ export class TelemetryService extends BaseStreamService {
         return newStream.stream;
     }
     getStream(config) {
-        if (config.transport === 'connect') {
-            return new TelemetryStreamConnect(config);
+        if (config.transport === 'grpc-web') {
+            if (!TelemetryService.grpcWebDeprecationWarned) {
+                TelemetryService.grpcWebDeprecationWarned = true;
+                this.logger.warn('The grpc-web telemetry transport is deprecated and will be removed in a future release. ' +
+                    'Switch to the Connect protocol by setting transport to "connect" (now the default).');
+            }
+            return new TelemetryStream(config);
         }
-        return new TelemetryStream(config);
+        return new TelemetryStreamConnect(config);
     }
 }
+TelemetryService.grpcWebDeprecationWarned = false;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dronedeploy/rocos-js-sdk",
-  "version": "3.1.7",
+  "version": "4.0.0",
   "description": "Javascript SDK for rocos",
   "main": "cjs/index.js",
   "module": "esm/index.js",