@dronedeploy/rocos-js-sdk 3.0.1-alpha.1 → 3.0.1-alpha.14

package/esm/grpc/teletubby_pb.grpc-client.d.ts

@@ -0,0 +1,152 @@
+import type { TelemetryMessageAck } from "./teletubby_pb";
+import type { TelemetryStreamAck } from "./teletubby_pb";
+import type { TelemetryMessage } from "./teletubby_pb";
+import type { ConfigMessage } from "./teletubby_pb";
+import type { RegistrationMessage } from "./teletubby_pb";
+import type { BinaryWriteOptions } from "@protobuf-ts/runtime";
+import type { BinaryReadOptions } from "@protobuf-ts/runtime";
+import type { TelemetryQueryRequest } from "./teletubby_pb";
+import type { TelemetryRequestAck } from "./teletubby_pb";
+import type { TelemetryRequest } from "./teletubby_pb";
+import type { TelemetryStreamMessage } from "./teletubby_pb";
+import type { ReceiverStreamMessage } from "./teletubby_pb";
+import * as grpc from "@grpc/grpc-js";
+/**
+ * @generated from protobuf service teletubby.v1.TelemetryReceiver
+ */
+export interface ITelemetryReceiverClient {
+    /**
+     * Register the receiver supports bidirectional streaming. Receiver side telemetry ack is supported under bidrectional stream now
+     * TODO: merge request telemetry and telemetry query in to ReceiverStreamMessage
+     *
+     * @generated from protobuf rpc: RegisterStreamReceiver(stream teletubby.v1.ReceiverStreamMessage) returns (stream teletubby.v1.TelemetryStreamMessage);
+     */
+    registerStreamReceiver(metadata: grpc.Metadata, options?: grpc.CallOptions): grpc.ClientDuplexStream<ReceiverStreamMessage, TelemetryStreamMessage>;
+    registerStreamReceiver(options?: grpc.CallOptions): grpc.ClientDuplexStream<ReceiverStreamMessage, TelemetryStreamMessage>;
+    /**
+     * @generated from protobuf rpc: RequestTelemetry(teletubby.v1.TelemetryRequest) returns (teletubby.v1.TelemetryRequestAck);
+     */
+    requestTelemetry(input: TelemetryRequest, metadata: grpc.Metadata, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: TelemetryRequestAck) => void): grpc.ClientUnaryCall;
+    requestTelemetry(input: TelemetryRequest, metadata: grpc.Metadata, callback: (err: grpc.ServiceError | null, value?: TelemetryRequestAck) => void): grpc.ClientUnaryCall;
+    requestTelemetry(input: TelemetryRequest, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: TelemetryRequestAck) => void): grpc.ClientUnaryCall;
+    requestTelemetry(input: TelemetryRequest, callback: (err: grpc.ServiceError | null, value?: TelemetryRequestAck) => void): grpc.ClientUnaryCall;
+    /**
+     * Through telemetry query, user can specify the query of the callsign with the predicates. The subscriber can subscribe to telemetry sources from dynamic callsigns.
+     * Multiple calls to RequestTelemetryQuery with same subscribe ID will overwrite the query from previous requests.
+     *
+     * @generated from protobuf rpc: RequestTelemetryQuery(teletubby.v1.TelemetryQueryRequest) returns (teletubby.v1.TelemetryRequestAck);
+     */
+    requestTelemetryQuery(input: TelemetryQueryRequest, metadata: grpc.Metadata, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: TelemetryRequestAck) => void): grpc.ClientUnaryCall;
+    requestTelemetryQuery(input: TelemetryQueryRequest, metadata: grpc.Metadata, callback: (err: grpc.ServiceError | null, value?: TelemetryRequestAck) => void): grpc.ClientUnaryCall;
+    requestTelemetryQuery(input: TelemetryQueryRequest, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: TelemetryRequestAck) => void): grpc.ClientUnaryCall;
+    requestTelemetryQuery(input: TelemetryQueryRequest, callback: (err: grpc.ServiceError | null, value?: TelemetryRequestAck) => void): grpc.ClientUnaryCall;
+}
+/**
+ * @generated from protobuf service teletubby.v1.TelemetryReceiver
+ */
+export declare class TelemetryReceiverClient extends grpc.Client implements ITelemetryReceiverClient {
+    private readonly _binaryOptions;
+    constructor(address: string, credentials: grpc.ChannelCredentials, options?: grpc.ClientOptions, binaryOptions?: Partial<BinaryReadOptions & BinaryWriteOptions>);
+    /**
+     * Register the receiver supports bidirectional streaming. Receiver side telemetry ack is supported under bidrectional stream now
+     * TODO: merge request telemetry and telemetry query in to ReceiverStreamMessage
+     *
+     * @generated from protobuf rpc: RegisterStreamReceiver(stream teletubby.v1.ReceiverStreamMessage) returns (stream teletubby.v1.TelemetryStreamMessage);
+     */
+    registerStreamReceiver(metadata?: grpc.Metadata | grpc.CallOptions, options?: grpc.CallOptions): grpc.ClientDuplexStream<ReceiverStreamMessage, TelemetryStreamMessage>;
+    /**
+     * @generated from protobuf rpc: RequestTelemetry(teletubby.v1.TelemetryRequest) returns (teletubby.v1.TelemetryRequestAck);
+     */
+    requestTelemetry(input: TelemetryRequest, metadata: grpc.Metadata | grpc.CallOptions | ((err: grpc.ServiceError | null, value?: TelemetryRequestAck) => void), options?: grpc.CallOptions | ((err: grpc.ServiceError | null, value?: TelemetryRequestAck) => void), callback?: ((err: grpc.ServiceError | null, value?: TelemetryRequestAck) => void)): grpc.ClientUnaryCall;
+    /**
+     * Through telemetry query, user can specify the query of the callsign with the predicates. The subscriber can subscribe to telemetry sources from dynamic callsigns.
+     * Multiple calls to RequestTelemetryQuery with same subscribe ID will overwrite the query from previous requests.
+     *
+     * @generated from protobuf rpc: RequestTelemetryQuery(teletubby.v1.TelemetryQueryRequest) returns (teletubby.v1.TelemetryRequestAck);
+     */
+    requestTelemetryQuery(input: TelemetryQueryRequest, metadata: grpc.Metadata | grpc.CallOptions | ((err: grpc.ServiceError | null, value?: TelemetryRequestAck) => void), options?: grpc.CallOptions | ((err: grpc.ServiceError | null, value?: TelemetryRequestAck) => void), callback?: ((err: grpc.ServiceError | null, value?: TelemetryRequestAck) => void)): grpc.ClientUnaryCall;
+}
+/**
+ * Will be deprecated in the future
+ *
+ * @generated from protobuf service teletubby.v1.TelemetryGateway
+ */
+export interface ITelemetryGatewayClient {
+    /**
+     * @generated from protobuf rpc: RegisterSender(teletubby.v1.RegistrationMessage) returns (stream teletubby.v1.ConfigMessage);
+     */
+    registerSender(input: RegistrationMessage, metadata?: grpc.Metadata, options?: grpc.CallOptions): grpc.ClientReadableStream<ConfigMessage>;
+    registerSender(input: RegistrationMessage, options?: grpc.CallOptions): grpc.ClientReadableStream<ConfigMessage>;
+    /**
+     * @generated from protobuf rpc: RegisterReceiver(teletubby.v1.RegistrationMessage) returns (stream teletubby.v1.TelemetryMessage);
+     */
+    registerReceiver(input: RegistrationMessage, metadata?: grpc.Metadata, options?: grpc.CallOptions): grpc.ClientReadableStream<TelemetryMessage>;
+    registerReceiver(input: RegistrationMessage, options?: grpc.CallOptions): grpc.ClientReadableStream<TelemetryMessage>;
+    /**
+     * @generated from protobuf rpc: SendTelemetry(stream teletubby.v1.TelemetryMessage) returns (teletubby.v1.TelemetryStreamAck);
+     */
+    sendTelemetry(metadata: grpc.Metadata, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: TelemetryStreamAck) => void): grpc.ClientWritableStream<TelemetryMessage>;
+    sendTelemetry(metadata: grpc.Metadata, callback: (err: grpc.ServiceError | null, value?: TelemetryStreamAck) => void): grpc.ClientWritableStream<TelemetryMessage>;
+    sendTelemetry(options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: TelemetryStreamAck) => void): grpc.ClientWritableStream<TelemetryMessage>;
+    sendTelemetry(callback: (err: grpc.ServiceError | null, value?: TelemetryStreamAck) => void): grpc.ClientWritableStream<TelemetryMessage>;
+    /**
+     * @generated from protobuf rpc: SendTelemetryMessage(teletubby.v1.TelemetryMessage) returns (teletubby.v1.TelemetryMessageAck);
+     */
+    sendTelemetryMessage(input: TelemetryMessage, metadata: grpc.Metadata, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: TelemetryMessageAck) => void): grpc.ClientUnaryCall;
+    sendTelemetryMessage(input: TelemetryMessage, metadata: grpc.Metadata, callback: (err: grpc.ServiceError | null, value?: TelemetryMessageAck) => void): grpc.ClientUnaryCall;
+    sendTelemetryMessage(input: TelemetryMessage, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: TelemetryMessageAck) => void): grpc.ClientUnaryCall;
+    sendTelemetryMessage(input: TelemetryMessage, callback: (err: grpc.ServiceError | null, value?: TelemetryMessageAck) => void): grpc.ClientUnaryCall;
+    /**
+     * @generated from protobuf rpc: RequestTelemetry(teletubby.v1.TelemetryRequest) returns (teletubby.v1.TelemetryRequestAck);
+     */
+    requestTelemetry(input: TelemetryRequest, metadata: grpc.Metadata, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: TelemetryRequestAck) => void): grpc.ClientUnaryCall;
+    requestTelemetry(input: TelemetryRequest, metadata: grpc.Metadata, callback: (err: grpc.ServiceError | null, value?: TelemetryRequestAck) => void): grpc.ClientUnaryCall;
+    requestTelemetry(input: TelemetryRequest, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: TelemetryRequestAck) => void): grpc.ClientUnaryCall;
+    requestTelemetry(input: TelemetryRequest, callback: (err: grpc.ServiceError | null, value?: TelemetryRequestAck) => void): grpc.ClientUnaryCall;
+    /**
+     * Through telemetry query, user can specify the query of the callsign with the predicates. The subscriber can subscribe to telemetry sources from dynamic callsigns.
+     * Multiple calls to RequestTelemetryQuery with same subscribe ID will overwrite the query from previous requests.
+     *
+     * @generated from protobuf rpc: RequestTelemetryQuery(teletubby.v1.TelemetryQueryRequest) returns (teletubby.v1.TelemetryRequestAck);
+     */
+    requestTelemetryQuery(input: TelemetryQueryRequest, metadata: grpc.Metadata, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: TelemetryRequestAck) => void): grpc.ClientUnaryCall;
+    requestTelemetryQuery(input: TelemetryQueryRequest, metadata: grpc.Metadata, callback: (err: grpc.ServiceError | null, value?: TelemetryRequestAck) => void): grpc.ClientUnaryCall;
+    requestTelemetryQuery(input: TelemetryQueryRequest, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: TelemetryRequestAck) => void): grpc.ClientUnaryCall;
+    requestTelemetryQuery(input: TelemetryQueryRequest, callback: (err: grpc.ServiceError | null, value?: TelemetryRequestAck) => void): grpc.ClientUnaryCall;
+}
+/**
+ * Will be deprecated in the future
+ *
+ * @generated from protobuf service teletubby.v1.TelemetryGateway
+ */
+export declare class TelemetryGatewayClient extends grpc.Client implements ITelemetryGatewayClient {
+    private readonly _binaryOptions;
+    constructor(address: string, credentials: grpc.ChannelCredentials, options?: grpc.ClientOptions, binaryOptions?: Partial<BinaryReadOptions & BinaryWriteOptions>);
+    /**
+     * @generated from protobuf rpc: RegisterSender(teletubby.v1.RegistrationMessage) returns (stream teletubby.v1.ConfigMessage);
+     */
+    registerSender(input: RegistrationMessage, metadata?: grpc.Metadata | grpc.CallOptions, options?: grpc.CallOptions): grpc.ClientReadableStream<ConfigMessage>;
+    /**
+     * @generated from protobuf rpc: RegisterReceiver(teletubby.v1.RegistrationMessage) returns (stream teletubby.v1.TelemetryMessage);
+     */
+    registerReceiver(input: RegistrationMessage, metadata?: grpc.Metadata | grpc.CallOptions, options?: grpc.CallOptions): grpc.ClientReadableStream<TelemetryMessage>;
+    /**
+     * @generated from protobuf rpc: SendTelemetry(stream teletubby.v1.TelemetryMessage) returns (teletubby.v1.TelemetryStreamAck);
+     */
+    sendTelemetry(metadata: grpc.Metadata | grpc.CallOptions | ((err: grpc.ServiceError | null, value?: TelemetryStreamAck) => void), options?: grpc.CallOptions | ((err: grpc.ServiceError | null, value?: TelemetryStreamAck) => void), callback?: ((err: grpc.ServiceError | null, value?: TelemetryStreamAck) => void)): grpc.ClientWritableStream<TelemetryMessage>;
+    /**
+     * @generated from protobuf rpc: SendTelemetryMessage(teletubby.v1.TelemetryMessage) returns (teletubby.v1.TelemetryMessageAck);
+     */
+    sendTelemetryMessage(input: TelemetryMessage, metadata: grpc.Metadata | grpc.CallOptions | ((err: grpc.ServiceError | null, value?: TelemetryMessageAck) => void), options?: grpc.CallOptions | ((err: grpc.ServiceError | null, value?: TelemetryMessageAck) => void), callback?: ((err: grpc.ServiceError | null, value?: TelemetryMessageAck) => void)): grpc.ClientUnaryCall;
+    /**
+     * @generated from protobuf rpc: RequestTelemetry(teletubby.v1.TelemetryRequest) returns (teletubby.v1.TelemetryRequestAck);
+     */
+    requestTelemetry(input: TelemetryRequest, metadata: grpc.Metadata | grpc.CallOptions | ((err: grpc.ServiceError | null, value?: TelemetryRequestAck) => void), options?: grpc.CallOptions | ((err: grpc.ServiceError | null, value?: TelemetryRequestAck) => void), callback?: ((err: grpc.ServiceError | null, value?: TelemetryRequestAck) => void)): grpc.ClientUnaryCall;
+    /**
+     * Through telemetry query, user can specify the query of the callsign with the predicates. The subscriber can subscribe to telemetry sources from dynamic callsigns.
+     * Multiple calls to RequestTelemetryQuery with same subscribe ID will overwrite the query from previous requests.
+     *
+     * @generated from protobuf rpc: RequestTelemetryQuery(teletubby.v1.TelemetryQueryRequest) returns (teletubby.v1.TelemetryRequestAck);
+     */
+    requestTelemetryQuery(input: TelemetryQueryRequest, metadata: grpc.Metadata | grpc.CallOptions | ((err: grpc.ServiceError | null, value?: TelemetryRequestAck) => void), options?: grpc.CallOptions | ((err: grpc.ServiceError | null, value?: TelemetryRequestAck) => void), callback?: ((err: grpc.ServiceError | null, value?: TelemetryRequestAck) => void)): grpc.ClientUnaryCall;
+}

package/esm/helpers/arrayRemove.d.ts

@@ -0,0 +1 @@
+export declare const arrayRemove: (original: string[], remove: string[]) => string[];

package/esm/helpers/arrayUnique.d.ts

@@ -0,0 +1 @@
+export declare const arrayUnique: (data: string[]) => string[];

package/esm/helpers/average.d.ts

@@ -0,0 +1 @@
+export declare const average: (numbers: number[]) => number;

package/esm/helpers/callerMessageHelpers.d.ts

@@ -0,0 +1,14 @@
+import { IRocosCallerMessage, IRocosCallerMessageChunk, IRocosCallerMessageResponse } from '../models';
+import { OperatorFunction } from 'rxjs';
+/** Given a caller message, return the responses contained within it.
+ *
+ * Chunked responses with acks and results will return the intermediate acks and results as Responses along with the chunk itself
+ */
+export declare function getResponses(res: IRocosCallerMessage): (IRocosCallerMessageResponse | IRocosCallerMessageChunk)[];
+/** A pipeable operator that will convert a stream of chunks into a stream of responses.
+ *
+ * Any non-chunk messages will be passed through unchanged.
+ *
+ * Chunked responses will be buffered until all chunks are received, then merged into a single response.
+ */
+export declare function handleChunkedMessages(): OperatorFunction<IRocosCallerMessageChunk | IRocosCallerMessageResponse, IRocosCallerMessageResponse>;

package/esm/helpers/callerMessageHelpers.js

@@ -0,0 +1,86 @@
+import { map, pipe } from 'rxjs';
+import { filter } from 'rxjs/operators';
+/** Given a caller message, return the responses contained within it.
+ *
+ * Chunked responses with acks and results will return the intermediate acks and results as Responses along with the chunk itself
+ */
+export function getResponses(res) {
+    if (res.chunks?.chunks) {
+        return getIntermediateResponsesFromChunks(res.chunks.chunks);
+    }
+    if (res.responses?.responses) {
+        return res.responses.responses;
+    }
+    return [];
+}
+/** Given a list of chunks, convert any intermediate acks and results into responses. */
+function getIntermediateResponsesFromChunks(chunks) {
+    const responses = [];
+    for (const chunk of chunks) {
+        // chunk needs to be pushed first so that the final response can be constructed from the chunks
+        // before any result message can close the observable
+        responses.push(chunk);
+        if (chunk.uid && (chunk.ack || chunk.result)) {
+            responses.push({
+                uid: chunk.uid,
+                ack: chunk.ack,
+                result: chunk.result,
+            });
+        }
+    }
+    return responses;
+}
+/** A pipeable operator that will convert a stream of chunks into a stream of responses.
+ *
+ * Any non-chunk messages will be passed through unchanged.
+ *
+ * Chunked responses will be buffered until all chunks are received, then merged into a single response.
+ */
+export function handleChunkedMessages() {
+    let chunkBuffer = null;
+    return pipe(map((message) => {
+        if ('chunkIndex' in message) {
+            if (chunkBuffer === null) {
+                chunkBuffer = new Array(message.chunkCount);
+            }
+            chunkBuffer[message.chunkIndex] = message;
+            // have to check with Object.keys because the array is buffered and the length is not accurate
+            if (Object.keys(chunkBuffer).length !== message.chunkCount) {
+                return;
+            }
+            return buildResponseFromChunks(chunkBuffer);
+        }
+        return message;
+    }), filter(Boolean));
+}
+/** Given a complete set of chunks, build a single response. */
+function buildResponseFromChunks(chunks) {
+    const chunkPayloads = chunks.map((x) => x.payload).filter((x) => x !== undefined);
+    const payloadLength = chunkPayloads.reduce((acc, x) => acc + x.length, 0);
+    const mergedPayload = new Uint8Array(payloadLength);
+    for (let i = 0, offset = 0; i < chunkPayloads.length; i++) {
+        mergedPayload.set(chunkPayloads[i], offset);
+        offset += chunkPayloads[i].length;
+    }
+    const [header] = chunks.map((x) => x.header).filter((x) => x !== undefined);
+    if (header === undefined || Array.isArray(header)) {
+        throw new Error('No header found in chunks');
+    }
+    const [uid] = chunks.map((x) => x.uid).filter((x) => x !== undefined);
+    if (uid === undefined || Array.isArray(uid)) {
+        throw new Error('No uid found in chunks');
+    }
+    const createdAt = new Date(Number(header.created) * 1000);
+    const createdNs = (BigInt(header.created) * BigInt(1e9)).toString();
+    return {
+        uid,
+        return: {
+            header: {
+                createdNs,
+                createdAt,
+                meta: header.meta,
+            },
+            payload: mergedPayload,
+        },
+    };
+}

package/esm/helpers/cleanObject.d.ts

@@ -0,0 +1 @@
+export declare const cleanObject: <T>(object: T) => T;

package/esm/helpers/enviroment.d.ts

@@ -0,0 +1,8 @@
+export declare const isBrowser: boolean;
+export declare const isWebWorker: boolean;
+export declare const isNode: boolean;
+/**
+ * @see https://github.com/jsdom/jsdom/releases/tag/12.0.0
+ * @see https://github.com/jsdom/jsdom/issues/1537
+ */
+export declare const isJsDom: () => boolean;

package/esm/helpers/flattenCallsignsLookup.d.ts

@@ -0,0 +1,2 @@
+import { CallsignsLookup } from '../models';
+export declare const flattenCallsignsLookup: (callsignsLookup: CallsignsLookup | string[]) => string[];

package/esm/helpers/flattenObject.d.ts

@@ -0,0 +1 @@
+export declare const flattenObject: <T>(object: T) => T;

package/esm/helpers/flattenOneOf.d.ts

@@ -0,0 +1,67 @@
+type Intersect<T> = (T extends any ? (x: T) => 0 : never) extends (x: infer R) => 0 ? R : never;
+type DropKey<T, K extends keyof T> = {
+    [P in keyof T as P extends K ? never : P]: T[P];
+};
+type WrapTypes<T> = {
+    [K in keyof T]: T[K] extends (...args: any[]) => any ? T[K] : DeepFlattenedOneOf<T[K]>;
+};
+interface OneOfProperty {
+    content: {
+        oneofKind?: string;
+        [key: string]: unknown;
+    };
+}
+/**
+ * This is a helper type to flatten oneOf types in the generated protobuf.
+ *
+ * @example
+ * type T = { a: string; content: { oneofKind: 'b'; b: boolean } | { oneofKind: 'c'; c: number } }
+ * FlattenedOneOf<T> === { a: string; b?: boolean; c?: number }`
+ */
+type FlattenedOneOf<Original> = Original extends OneOfProperty ? Omit<Original, 'content'> & Partial<Intersect<DropKey<Original['content'], 'oneofKind'>>> : Original;
+/**
+ * This is a helper type to recursively flatten oneOf types in the generated protobuf.
+ *
+ * @example
+ * type T = { a: string; content: { oneofKind: 'b'; b: {content: {oneofKind: 'b1', b1: string}} } | { oneofKind: 'c'; c: number } }
+ * DeepFlattenedOneOf<T> === { a: string; b?: {b1?: string}; c?: number }`
+ */
+type DeepFlattenedOneOf<Original> = WrapTypes<FlattenedOneOf<Original>>;
+export declare function hasOneOfField(object: unknown): object is OneOfProperty;
+/**
+ * This function flattens oneOf types in the generated protobuf.
+ *
+ * @example
+ * const a = { a: 'a', content: { oneofKind: 'b', b: true } }
+ * flattenOneOf(a) === { a: 'a', b: true }
+ *
+ * @param object the object to flatten
+ * @param deep whether to recursively flatten oneOf types
+ */
+export declare function flattenOneOf<T>(object: T, deep?: false): FlattenedOneOf<T>;
+/**
+ * This function flattens oneOf types in the generated protobuf.
+ *
+ * @example
+ * const a = {
+ *   b: {
+ *     content: { oneofKind: 'c', c: true },
+ *   },
+ *   content: {
+ *     oneofKind: 'd',
+ *     d: {
+ *       content: {
+ *         oneofKind: 'e',
+ *         e: 5,
+ *       },
+ *     },
+ *   },
+ * }
+ *
+ * flattenOneOf(a, true) === {b: {c: true}, d: {e: 5}}
+ *
+ * @param object the object to flatten
+ * @param deep whether to recursively flatten oneOf types
+ */
+export declare function flattenOneOf<T>(object: T, deep: true): DeepFlattenedOneOf<T>;
+export {};

package/esm/helpers/formatServiceUrl.d.ts

@@ -0,0 +1 @@
+export declare const formatServiceUrl: (url: string, params: Record<string, string>, insecure?: boolean) => string;

package/esm/helpers/generateUUID.d.ts

@@ -0,0 +1 @@
+export declare const generateUUID: () => string;

package/esm/helpers/getSha256Hex.d.ts

@@ -0,0 +1 @@
+export declare const getSha256Hex: (arrayBuffer: ArrayBuffer) => Promise<string>;

package/esm/helpers/getSha256Hex.js

@@ -0,0 +1,5 @@
+export const getSha256Hex = async (arrayBuffer) => {
+    const hashBuffer = await crypto.subtle.digest('SHA-256', arrayBuffer);
+    const hashArray = Array.from(new Uint8Array(hashBuffer));
+    return hashArray.map((b) => b.toString(16).padStart(2, '0')).join('');
+};

package/esm/helpers/getSha256HexNode.d.ts

@@ -0,0 +1 @@
+export declare const getSha256HexNode: (arrayBuffer: ArrayBuffer) => Promise<string>;

package/esm/helpers/getSha256HexNode.js

@@ -0,0 +1,6 @@
+import crypto from 'crypto';
+export const getSha256HexNode = async (arrayBuffer) => {
+    const hashBuffer = await crypto.subtle.digest('SHA-256', arrayBuffer);
+    const hashArray = Array.from(new Uint8Array(hashBuffer));
+    return hashArray.map((b) => b.toString(16).padStart(2, '0')).join('');
+};

package/esm/helpers/getSubscriptionsDifference.d.ts

@@ -0,0 +1,10 @@
+type ISubscriptionsDifferenceRecord = {
+    callsigns: string[];
+    sources: string[];
+};
+type ISubscriptionsDifference = {
+    toRemove: ISubscriptionsDifferenceRecord;
+    toAdd: ISubscriptionsDifferenceRecord;
+};
+export declare const getSubscriptionsDifference: (before: Record<string, string[]>, after: Record<string, string[]>) => ISubscriptionsDifference;
+export {};

package/esm/helpers/getURLSearchParams.d.ts

@@ -0,0 +1,2 @@
+export type QueryParams = Record<string, string | number | boolean> | URLSearchParams;
+export declare const getURLSearchParams: (params: QueryParams) => URLSearchParams;

package/esm/helpers/getUniqueConfigKey.d.ts

@@ -0,0 +1,11 @@
+import { IRocosSDKConfig } from '../models';
+type ConfigWithParent = IRocosSDKConfig & {
+    _parentConfig?: ConfigWithParent;
+};
+/**
+ * Flattens and orders the sdk config props to make a unique key
+ *
+ * @param config - SDK config {@link IRocosSDKConfig}
+ */
+export declare const getUniqueConfigKey: (config: ConfigWithParent) => string;
+export {};

package/esm/helpers/getUniqueConfigKey.js

@@ -0,0 +1,19 @@
+/**
+ * Flattens and orders the sdk config props to make a unique key
+ *
+ * @param config - SDK config {@link IRocosSDKConfig}
+ */
+export const getUniqueConfigKey = (config) => {
+    let rootConfig = config;
+    if (rootConfig._parentConfig) {
+        // assume there is only one level of nesting
+        rootConfig = rootConfig._parentConfig;
+    }
+    return Object.keys(rootConfig)
+        .sort()
+        .map((item) => {
+        return item !== 'token' ? `${item}:${rootConfig[item]}` : false;
+    })
+        .filter(Boolean)
+        .join();
+};

package/esm/helpers/getUniqueId.d.ts

@@ -0,0 +1,9 @@
+import { CallsignsLookup } from '../models/callsigns/CallsignsLookup';
+/**
+ *
+ * @param projectId
+ * @param callsignsLookup = CallsignsLookup or String[] for backward compatibility for the portal using callsigns string array
+ * @param sources
+ * @param scope
+ */
+export declare const getUniqueId: (projectId: string, callsignsLookup: CallsignsLookup | string[], sources: string[], scope: string) => string;

package/esm/helpers/getUnixTimeMs.d.ts

@@ -0,0 +1 @@
+export declare const getUnixTimeMs: (offsetMs: number, baseOn?: Date) => number;

package/esm/helpers/index.js

@@ -0,0 +1,5 @@
+export * from './average';
+export * from './standardDeviation';
+export * from './generateUUID';
+export * from './getURLSearchParams';
+export * from './websandbox';

package/esm/helpers/nanosecondToMillisecond.d.ts

@@ -0,0 +1 @@
+export declare const nanosecondToMillisecond: (nano: number | string) => number;

package/esm/helpers/randomString.d.ts

@@ -0,0 +1 @@
+export declare const randomString: () => string;

package/esm/helpers/splitRobotTopic.d.ts

@@ -0,0 +1,9 @@
+export interface RobotPath {
+    component: string;
+    topic: string;
+}
+/** Splits a robot path string into component and topic.
+ *
+ * @example splitRobotTopic('/component/topic/a') => { component: 'component', topic: 'topic/a' }
+ */
+export declare function splitRobotTopic(path: string): RobotPath;

package/esm/helpers/splitRobotTopic.js

@@ -0,0 +1,12 @@
+/** Splits a robot path string into component and topic.
+ *
+ * @example splitRobotTopic('/component/topic/a') => { component: 'component', topic: 'topic/a' }
+ */
+export function splitRobotTopic(path) {
+    const [component, ...topicItems] = path.replace(/^\/+/, '').split('/');
+    const topic = topicItems.join('/');
+    return {
+        component,
+        topic,
+    };
+}

package/esm/helpers/standardDeviation.d.ts

@@ -0,0 +1 @@
+export declare const standardDeviation: (numbers: number[]) => number;

package/esm/helpers/stringToUint8Array.d.ts

@@ -0,0 +1 @@
+export declare const stringToUint8Array: (input: string) => Uint8Array;

package/esm/helpers/uint8ArrayToString.d.ts

@@ -0,0 +1 @@
+export declare const uint8ArrayToString: (arr: Uint8Array | any) => string;

package/esm/helpers/websandbox/connection.d.ts

@@ -0,0 +1,67 @@
+import { APIDeclaration } from './types';
+export interface ConnectionOptions {
+    allowedSenderOrigin?: string;
+    debugMode: boolean;
+}
+type ListenerCallback = (e: MessageEvent<Message>) => void;
+declare enum MessageType {
+    RESPONSE = "response",
+    MESSAGE = "message"
+}
+interface BaseMessageData {
+    type: MessageType;
+    callId: string;
+}
+interface ResponseData extends BaseMessageData {
+    type: MessageType.RESPONSE;
+    success: boolean;
+    result: unknown;
+}
+interface MessageData extends BaseMessageData {
+    type: MessageType.MESSAGE;
+    methodName: string;
+    arguments: unknown[];
+}
+type Message = MessageData | ResponseData;
+export default class Connection<Local extends APIDeclaration<Local>, Remote extends APIDeclaration<Remote>> {
+    private readonly name;
+    private incrementalID;
+    private readonly options;
+    private readonly postMessageInternal;
+    private callbacks;
+    private serviceMethods;
+    constructor(name: string, postMessage: typeof window.postMessage, methods: Local, registerOnMessageListener: (listener: ListenerCallback) => void, options?: Partial<ConnectionOptions>);
+    /** Call a remote method
+     *
+     * returns a promise that resolves when the remote responds
+     *
+     * @param name - name of remote method to call
+     * @param args - arguments to pass to remote method
+     */
+    callRemoteMethod<Method extends keyof Remote>(name: Method, ...args: Parameters<Remote[Method]>): Promise<ReturnType<Remote[Method]>>;
+    private onMessageListener;
+    private callLocalMethod;
+    /** Respond to remote call
+     *
+     * @param id - remote call ID
+     * @param result - result to pass to calling function
+     * @param success - whether the call was successful
+     */
+    private responseOtherSide;
+    /** Store a callback to be called when the remote responds
+     *
+     * @param success - callback to be called on success
+     * @param failure - callback to be called on failure
+     */
+    private registerCallback;
+    /** Calls and deletes stored callback
+     *
+     * @param callId - ID of callback to call
+     * @param success - whether the call was successful
+     * @param result - result of remote call
+     */
+    private popCallback;
+    private postMessage;
+    private log;
+}
+export {};

package/esm/helpers/websandbox/frame/frame.d.ts

@@ -0,0 +1,12 @@
+import { Task } from '../types';
+export interface FrameMethods {
+    startTask: (task: Task) => unknown;
+}
+declare class Frame {
+    private connection;
+    private workerManager;
+    constructor();
+    private runCode;
+}
+declare const frame: Frame;
+export default frame;

package/esm/helpers/websandbox/frame/frame.source.d.ts

@@ -0,0 +1,2 @@
+declare const source: string;
+export default source;

package/esm/helpers/websandbox/frame/frame.source.js

@@ -0,0 +1,5 @@
+// Auto-generated file
+/* eslint-disable */
+import __WORKER_SOURCE__ from './worker/worker.source';
+const source = `(()=>{"use strict";var e={880:(e,t)=>{var s;Object.defineProperty(t,"__esModule",{value:!0}),function(e){e.RESPONSE="response",e.MESSAGE="message"}(s||(s={}));const r={allowedSenderOrigin:void 0,debugMode:!1};t.default=class{constructor(e,t,s,i,o={}){this.callbacks=new Map,this.serviceMethods=new Map,this.name=e,this.options={...r,...o},this.log("Created connection w/ allowedOrigin:",this.options.allowedSenderOrigin),this.serviceMethods=new Map(Object.entries(s));const[n]=crypto.getRandomValues(new Uint32Array(1));this.incrementalID=n,this.postMessageInternal=t,i((e=>this.onMessageListener(e)))}callRemoteMethod(e,...t){return this.log("Calling Remote Method",{name:e,args:t}),new Promise(((r,i)=>{const o=this.registerCallback(r,i);this.postMessage({callId:o,type:s.MESSAGE,methodName:e,arguments:t})}))}onMessageListener(e){this.log("Received message",e);const{data:t}=e,{allowedSenderOrigin:r}=this.options;switch(r&&e.origin!==r&&console.warn(\`Received message from invalid origin: \${e.origin}\`),t.type){case s.RESPONSE:return void this.popCallback(t.callId,t.success,t.result);case s.MESSAGE:this.callLocalMethod(t.methodName,t.arguments).then((e=>this.responseOtherSide(t.callId,e))).catch((e=>this.responseOtherSide(t.callId,e,!1)))}}async callLocalMethod(e,t){this.log("calling local method",e,t);const s=this.serviceMethods.get(e);if(!s)throw new Error(\`service method \${e} not found\`);return s(...t)}responseOtherSide(e,t,r=!0){this.log("responding to remote call",{id:e,result:t,success:r});const i=t=>{this.postMessage({callId:e,type:s.RESPONSE,success:r,result:t})};try{i(t)}catch(e){e instanceof DOMException&&i(JSON.parse(JSON.stringify(t)))}}registerCallback(e,t){const s=(++this.incrementalID).toString();return this.log("registering callback for id",s),this.callbacks.set(s,{success:e,failure:t}),s}popCallback(e,t,s){this.log("calling callback for id",e,{success:t,result:s});const r=this.callbacks.get(e);t?r?.success(s):r?.failure(s),this.callbacks.delete(e)}postMessage(e,t="*"){this.log("sending message",{data:e,targetOrigin:t}),this.postMessageInternal(e,t)}log(...e){this.options.debugMode&&console.debug(\`[\${this.name}]\`,...e)}}},306:function(e,t,s){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});const i=r(s(880)),o=r(s(54)),n=new class{constructor(){const e=!!window?.debugMode;this.connection=new i.default("FRAME",window.parent.postMessage.bind(window.parent),{startTask:this.runCode.bind(this)},(e=>{window.addEventListener("message",e)}),{debugMode:e}),this.connection.callRemoteMethod("iframeInitialised"),this.workerManager=new o.default}async runCode(e){return this.workerManager.execute(e)}};t.default=n},54:function(e,t,s){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});const i=r(s(420));t.default=i.default},420:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.default=class{constructor(){this.messageListeners=new Map,this.worker=this.createWorker()}async execute(e){const t={...e,contextVariable:e.contextVariable??"ctx"},s=this.runTask(t),r=new Promise(((t,s)=>{const r=AbortSignal.timeout(e.timeout);r.addEventListener("abort",(()=>{s(r.reason)}))}));return Promise.race([s,r]).catch((e=>{throw"TimeoutError"===e.name&&this.terminate(),e})).finally((()=>{this.removeMessageListener(e.id)}))}terminate(){for(const e of this.messageListeners.values())this.worker.removeEventListener("message",e);this.worker.terminate(),this.worker=this.createWorker()}runTask(e){return new Promise(((t,s)=>{const r=r=>{const{data:i}=r;i.id===e.id&&(i.success?t(i.result):s(i.result))};this.messageListeners.set(e.id,r),this.worker.addEventListener("message",r),this.worker.postMessage(e)}))}createWorker(){const e=URL.createObjectURL(new Blob(["${__WORKER_SOURCE__.replace(/(['`"$])/g, '\\$1')}"],{type:"application/javascript"}));return new Worker(e)}removeMessageListener(e){const t=this.messageListeners.get(e);t&&this.worker.removeEventListener("message",t)}}}},t={};!function s(r){var i=t[r];if(void 0!==i)return i.exports;var o=t[r]={exports:{}};return e[r].call(o.exports,o,o.exports,s),o.exports}(306)})();`;
+export default source;

package/esm/helpers/websandbox/frame/index.js

@@ -0,0 +1,2 @@
+import source from './frame.source';
+export default source;

package/esm/helpers/websandbox/frame/worker/index.js

@@ -0,0 +1,2 @@
+import Manager from './manager';
+export default Manager;

package/esm/helpers/websandbox/frame/worker/manager.d.ts

@@ -0,0 +1,11 @@
+import { Task } from '../../types';
+export default class Manager {
+    private worker;
+    private messageListeners;
+    constructor();
+    execute(task: Task): Promise<unknown>;
+    terminate(): void;
+    private runTask;
+    private createWorker;
+    private removeMessageListener;
+}