@dronedeploy/rocos-js-sdk 3.0.1-alpha.2 → 3.0.1-alpha.21

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

@@ -0,0 +1,176 @@
+import * as grpc from '@grpc/grpc-js';
+import { SubscriberStatusEnum } from '../../../models';
+import { ReceiverStreamMessage, } from '../../../grpc/teletubby_pb';
+import { RocosLogger } from '../../../logger/RocosLogger';
+import { TelemetryReceiverClient } from '../../../grpc/teletubby_pb.grpc-client';
+import { TelemetryStreamAbstract } from './TelemetryStreamAbstract';
+import { v4 as uuid4 } from 'uuid';
+export class TelemetryStreamNode extends TelemetryStreamAbstract {
+    constructor(config) {
+        super(config);
+        this.logger = RocosLogger.getInstance(`TelemetryStream(${this.identifier})`);
+        this.port = config.port ?? 443;
+        this.credentials = config.insecure ? grpc.credentials.createInsecure() : grpc.credentials.createSsl();
+    }
+    stopInternal() {
+        try {
+            this.logger.info('Starting stop stream process');
+            this.logger.info('Stopping stream');
+            this.stream?.end();
+            this.stream = undefined;
+            this.logger.info('Stopping client');
+            this.client?.close();
+            this.client = undefined;
+            this.logger.info('Finished stop stream process');
+        }
+        catch (e) {
+            this.logger.error('Error stopping stream.', e);
+        }
+    }
+    registerReceiver() {
+        this.logger.info('registerReceiver');
+        // Reset counter
+        this.receivedMessagesCount = 0;
+        try {
+            const receiver = new TelemetryReceiverClient(`${this.url}:${this.port}`, this.getCredentials(), {
+                'grpc.min_reconnect_backoff_ms': 1000,
+                'grpc.max_reconnect_backoff_ms': 10000,
+            });
+            const waitForClientReady = async (error) => {
+                let err = error;
+                if (!err) {
+                    try {
+                        this.logger.info('registering stream receiver');
+                        this.stream = this.registerStream();
+                        this.logger.info('registered stream receiver');
+                    }
+                    catch (e) {
+                        err = e;
+                    }
+                }
+                if (err) {
+                    this.logger.warn(`failed to create telemetry client, error: ${err}`);
+                    // await this.stopandReRegisterStream()
+                }
+            };
+            const deadline = new Date();
+            deadline.setSeconds(deadline.getSeconds() + 2);
+            receiver.waitForReady(deadline, () => void waitForClientReady());
+            this.client = receiver;
+            this.logger.info(`Tele receiver client: ${JSON.stringify(this.client)}`);
+        }
+        catch (e) {
+            this.logger.error('Error initializing receiver client', e);
+        }
+        this.listenMessagesAndRenew();
+        return () => {
+            this.client?.close();
+        };
+    }
+    getCredentials() {
+        const mdCb = (_params, callback) => {
+            const meta = this.getMetaData();
+            callback(null, meta);
+        };
+        return grpc.credentials.combineChannelCredentials(this.credentials, grpc.credentials.createFromMetadataGenerator(mdCb));
+    }
+    registerStream() {
+        try {
+            this.logger.info('registering stream');
+            const stream = this.client.registerStreamReceiver();
+            this.logger.info('stream registered');
+            stream.on('data', (msg) => {
+                if (msg.content.oneofKind === 'message') {
+                    this.onData(msg, true);
+                }
+            });
+            stream.on('error', (e) => this.onError(e));
+            stream.on('end', () => this.onEnd());
+            return stream;
+        }
+        catch (e) {
+            this.logger.error(`Telemetry Stream registerStream error" SubscriberId: ${this.subscriberId}`, e);
+            throw e;
+        }
+    }
+    onError(e) {
+        this.logger.error(`Telemetry Stream Error: ${e}, SubscriberId: ${this.subscriberId}`);
+        this.subscriberStatus = SubscriberStatusEnum.ERROR;
+        this.statusStream$.next(this.subscriberStatus);
+    }
+    onEnd() {
+        this.logger.debug('registerReceiver', 'end');
+    }
+    getMetaData() {
+        const meta = new grpc.Metadata();
+        meta.add('r-p', this.projectId);
+        meta.add('r-tid', uuid4());
+        meta.add('r-cs', 'rocos-js-sdk-agent');
+        if (this.token)
+            meta.add('authorization', this.token);
+        return meta;
+    }
+    requestTelemetry(req) {
+        this.logger.debug('Sending telemetry request');
+        return new Promise((resolve, reject) => {
+            this.client.requestTelemetry(req, (err, ack) => {
+                this.logger.debug('subscribeSources with callsigns callback', err, ack);
+                if (err) {
+                    this.logger.error('error requestTelemetry ', err);
+                    return reject(err);
+                }
+                resolve();
+            });
+        });
+    }
+    requestTelemetryQuery(req) {
+        this.logger.debug('Requesting telemetry with query');
+        return new Promise((resolve, reject) => {
+            this.client.requestTelemetryQuery(req, (err, ack) => {
+                this.logger.debug('subscribeSources with query callback', err, ack);
+                if (err) {
+                    this.logger.error('error requestTelemetryQuery ', err);
+                    return reject(err);
+                }
+                resolve();
+            });
+        });
+    }
+    sendAcknowledgmentInternal(uid, status, noRetry) {
+        this.logger.info('Sending acknowledgment', { uid, status, noRetry });
+        const request = ReceiverStreamMessage.create({
+            content: {
+                oneofKind: 'ack',
+                ack: {
+                    uid,
+                    status,
+                    noRetry,
+                },
+            },
+        });
+        const response = this.stream?.write(request);
+        this.logger.info('Sent acknowledgment response', { uid, status, noRetry });
+        return response ?? false;
+    }
+    sendHeartbeat() {
+        try {
+            if (this.client && this.stream) {
+                this.logger.info('sending heartbeat');
+                const request = ReceiverStreamMessage.create({
+                    content: {
+                        oneofKind: 'heartbeat',
+                        heartbeat: {},
+                    },
+                });
+                this.stream?.write(request);
+            }
+            else {
+                this.logger.warn('Can not send heartbeat, stream does not exist.');
+            }
+        }
+        catch (e) {
+            this.logger?.warn('Error for heartbeat');
+            this.stream?.emit('error', e);
+        }
+    }
+}

package/esm/api/streams/webRTCSignalling/WebRTCSignallingStream.d.ts

@@ -0,0 +1,39 @@
+import { AddIceCandidateRequest, GetDetailsRequest, OfferRequest, OperatorConnectRequest } from '../../../grpc/pigeon_pb';
+import { IStreamConfig, IWebRTCSignallingGetDetailsResponse, IWebRTCSignallingMessage, IWebRTCSignallingOutcome, IWebRTCSignallingResponseStream } from '../../../models';
+import { WebRTCSignallingStreamAbstract } from './WebRTCSignallingStreamAbstract';
+/**
+ * Web implementation for the WebRTC signalling stream
+ */
+export declare class WebRTCSignallingStream extends WebRTCSignallingStreamAbstract {
+    private webRTCOperatorclient;
+    constructor(config: IStreamConfig);
+    /**
+     * Connect operator stream
+     * @param projectId
+     * @param request
+     * @returns
+     */
+    protected connectOperatorStream(projectId: string, request: OperatorConnectRequest): IWebRTCSignallingResponseStream<IWebRTCSignallingMessage>;
+    /**
+     * Get details for the peer
+     * @param projectId
+     * @param request
+     * @returns
+     */
+    protected getPeerDetails(projectId: string, request: GetDetailsRequest): Promise<IWebRTCSignallingGetDetailsResponse>;
+    /**
+     * Send offer connecction to peer
+     * @param projectId
+     * @param request
+     * @returns
+     */
+    protected offerPeerConnection(projectId: string, request: OfferRequest): Promise<IWebRTCSignallingOutcome>;
+    /**
+     * Add ice candidate for peer
+     * @param projectId
+     * @param request
+     * @returns
+     */
+    protected addPeerIceCandidate(projectId: string, request: AddIceCandidateRequest): Promise<IWebRTCSignallingOutcome>;
+    private getMetadata;
+}

package/esm/api/streams/webRTCSignalling/WebRTCSignallingStream.js

@@ -0,0 +1,88 @@
+import { GrpcWebFetchTransport } from '@protobuf-ts/grpcweb-transport';
+import { RocosLogger } from '../../../logger/RocosLogger';
+import { WebRTCSignallingStreamAbstract } from './WebRTCSignallingStreamAbstract';
+import { operatorClient } from '../../../grpc/pigeon_pb.client';
+/**
+ * Web implementation for the WebRTC signalling stream
+ */
+export class WebRTCSignallingStream extends WebRTCSignallingStreamAbstract {
+    constructor(config) {
+        super(config);
+        this.logger = RocosLogger.getInstance(`WebRTCSignallingStream(${this.identifier})`);
+        const protocol = config.insecure ? 'http' : 'https';
+        const port = config.port ? `:${config.port}` : '';
+        const transport = new GrpcWebFetchTransport({
+            baseUrl: `${protocol}://${this.url}${port}`,
+        });
+        this.webRTCOperatorclient = new operatorClient(transport);
+    }
+    /**
+     * Connect operator stream
+     * @param projectId
+     * @param request
+     * @returns
+     */
+    connectOperatorStream(projectId, request) {
+        const metadata = this.getMetadata(projectId);
+        const abortController = new AbortController();
+        const stream = this.webRTCOperatorclient.connect(request, { meta: metadata, abort: abortController.signal });
+        return {
+            onError: (callback) => stream.responses.onError(callback),
+            onComplete: (callback) => stream.responses.onComplete(callback),
+            onNext: (callback) => stream.responses.onNext(callback),
+            onMessage: (callback) => stream.responses.onMessage(callback),
+            [Symbol.asyncIterator]: stream.responses[Symbol.asyncIterator],
+            async status() {
+                const status = await stream.status;
+                const metadata = await stream.headers;
+                return {
+                    code: status.code,
+                    details: status.detail,
+                    metadata,
+                };
+            },
+            cancel() {
+                abortController.abort();
+            },
+        };
+    }
+    /**
+     * Get details for the peer
+     * @param projectId
+     * @param request
+     * @returns
+     */
+    async getPeerDetails(projectId, request) {
+        const metadata = this.getMetadata(projectId);
+        return this.webRTCOperatorclient.get(request, { meta: metadata }).response;
+    }
+    /**
+     * Send offer connecction to peer
+     * @param projectId
+     * @param request
+     * @returns
+     */
+    offerPeerConnection(projectId, request) {
+        const metadata = this.getMetadata(projectId);
+        return this.webRTCOperatorclient.offer(request, { meta: metadata }).response;
+    }
+    /**
+     * Add ice candidate for peer
+     * @param projectId
+     * @param request
+     * @returns
+     */
+    addPeerIceCandidate(projectId, request) {
+        const metadata = this.getMetadata(projectId);
+        return this.webRTCOperatorclient.addIceCandidate(request, { meta: metadata }).response;
+    }
+    getMetadata(projectId) {
+        const meta = {
+            'r-p': projectId,
+        };
+        if (this.token) {
+            meta.authorization = this.token;
+        }
+        return meta;
+    }
+}

package/esm/api/streams/webRTCSignalling/WebRTCSignallingStreamAbstract.d.ts

@@ -0,0 +1,29 @@
+import { AddIceCandidateRequest, GetDetailsRequest, GetDetailsResponse, OfferRequest, OperatorConnectRequest } from '../../../grpc/pigeon_pb';
+import { IAddIceCandidateRequest, IGetDetailsRequest, IOfferRequest, IOperatorConnectRequest, IStreamConfig, IWebRTCSignallingGetDetailsResponse, IWebRTCSignallingMessage, IWebRTCSignallingOutcome, IWebRTCSignallingResponseStream, IWebRTCSignallingStream, SubscriberStatusEnum } from '../../../models';
+import { BehaviorSubject } from 'rxjs';
+import { Logger } from 'loglevel';
+export declare abstract class WebRTCSignallingStreamAbstract implements IWebRTCSignallingStream {
+    identifier: string;
+    protected token: string;
+    private readonly scope;
+    protected url: string;
+    protected subscriberStatus: SubscriberStatusEnum;
+    statusStream$: BehaviorSubject<SubscriberStatusEnum>;
+    protected logger: Logger;
+    protected constructor(config: IStreamConfig);
+    protected abstract connectOperatorStream(projectId: string, request: OperatorConnectRequest): IWebRTCSignallingResponseStream<IWebRTCSignallingMessage>;
+    protected abstract getPeerDetails(projectId: string, request: GetDetailsRequest): Promise<IWebRTCSignallingGetDetailsResponse>;
+    protected abstract offerPeerConnection(projectId: string, request: OfferRequest): Promise<IWebRTCSignallingOutcome>;
+    protected abstract addPeerIceCandidate(projectId: string, request: AddIceCandidateRequest): Promise<IWebRTCSignallingOutcome>;
+    setToken(token: string): void;
+    stopStream(): void;
+    /**
+     * Connect operator
+     * @param request
+     * @returns
+     */
+    connectOperator(request: IOperatorConnectRequest): IWebRTCSignallingResponseStream<IWebRTCSignallingMessage>;
+    getDetails(request: IGetDetailsRequest): Promise<GetDetailsResponse>;
+    offerConnection(request: IOfferRequest): Promise<IWebRTCSignallingOutcome>;
+    addIceCandidate(request: IAddIceCandidateRequest): Promise<IWebRTCSignallingOutcome>;
+}

package/esm/constants/api.d.ts

@@ -0,0 +1,136 @@
+export declare const API_APPLICATION_AUTH_URL = "https://{url}/applications/auth";
+export declare const API_ADMIN_USER_INVITATION_URL = "https://{url}/admin/users/invitations";
+export declare const API_USER_URL = "https://{url}/users";
+export declare const API_USER_AUTH_URL = "https://{url}/users/auth";
+export declare const API_USER_TOKEN_URL = "https://{url}/users/token";
+export declare const API_OTP_URL = "https://{url}/otp";
+export declare const API_OTP_AUTH_URL = "https://{url}/otp/auth";
+export declare const API_USER_PASSWORD_RESET_URL = "https://{url}/users/forgotten-password-reset";
+export declare const API_USER_PASSWORD_FORGOT_URL = "https://{url}/users/forgotten-password";
+export declare const API_USER_INVITATION_URL = "https://{url}/users/invitations";
+export declare const API_USER_INVITATION_ACCEPT_URL = "https://{url}/users/invitations/{invitationId}/accept";
+export declare const API_USER_INVITATION_CHECK_URL = "https://{url}/users/invitations/{invitationId}/check";
+export declare const API_USER_VERIFY_EMAIL_URL = "https://{url}/users/verification-email";
+export declare const API_USER_PAT_URL = "https://{url}/users/pat";
+export declare const API_USER_PAT_TOKEN_URL = "https://{url}/users/pat/{token}";
+export declare const API_ACCOUNT_URL = "https://{url}/accounts";
+export declare const API_ACCOUNT_ID_URL = "https://{url}/accounts/{accountId}";
+export declare const API_ACCOUNT_ACTIVATE_URL = "https://{url}/accounts/{accountId}/activate";
+export declare const API_AUTH_USER_ACCOUNT_USER_URL = "https://{url}/accounts/{accountId}/users";
+export declare const API_AUTH_USER_ACCOUNT_USER_ID_URL = "https://{url}/accounts/{accountId}/users/{userId}";
+export declare const API_ACCOUNT_SETTINGS_URL = "https://{url}/accounts/{accountId}/settings";
+export declare const API_ACCOUNT_INTEGRATION_URL = "https://{url}/accounts/{accountId}/integrations/{integrationId}";
+export declare const API_ACCOUNT_INTEGRATION_TYPE_URL = "https://{url}/accounts/{accountId}/integrations/{integrationId}/{integrationType}";
+export declare const API_SERVER_TIME_URL = "https://{url}/time";
+export declare const API_ACCOUNT_PROJECT_URL = "https://{url}/accounts/{accountId}/projects";
+export declare const API_ACCOUNT_PROJECT_ID_URL = "https://{url}/accounts/{accountId}/projects/{projectId}";
+export declare const API_ACCOUNT_PROJECT_USER_URL = "https://{url}/accounts/{accountId}/projects/{projectId}/users";
+export declare const API_ACCOUNT_PROJECT_USER_ID_URL = "https://{url}/accounts/{accountId}/projects/{projectId}/users/{userId}";
+export declare const API_ACCOUNT_PROJECT_APPLICATION_URL = "https://{url}/accounts/{accountId}/projects/{projectId}/applications";
+export declare const API_ACCOUNT_PROJECT_APPLICATION_ID_URL = "https://{url}/accounts/{accountId}/projects/{projectId}/applications/{applicationId}";
+export declare const API_PROJECT_URL = "https://{url}/projects";
+export declare const API_PROJECT_ID_URL = "https://{url}/projects/{projectId}";
+export declare const API_PROJECT_USERS_URL = "https://{url}/projects/{projectId}/users";
+export declare const API_PROJECT_ASSET_URL = "https://{url}/projects/{projectId}/assets";
+export declare const API_PROJECT_ASSET_PATH_URL = "https://{url}/projects/{projectId}/assets/{filePath}";
+export declare const API_PROJECT_ASSET_ROBOTS_SYNC_DEFINITION_PATH_URL = "https://{url}/projects/{projectId}/robots/{callsign}/sync-definitions";
+export declare const API_PROJECT_ASSET_PROFILES_SYNC_DEFINITION_PATH_URL = "https://{url}/projects/{projectId}/profiles/{profileId}/sync-definitions";
+export declare const API_PROJECT_ASSET_INTEGRATION_PROVIDERS_PATH_URL = "https://{url}/projects/{projectId}/integration-providers";
+export declare const API_PROJECT_ASSET_INTEGRATIONS_PATH_URL = "https://{url}/projects/{projectId}/integrations";
+export declare const API_PROJECT_ASSET_INTEGRATION_PATH_URL = "https://{url}/projects/{projectId}/integrations/{integrationId}";
+export declare const API_PROJECT_ROBOT_ASSET_PATH_URL = "https://{url}/projects/{projectId}/robots/{callsign}/assets";
+export declare const API_PROJECT_FLOW_ASSET_PATH_URL = "https://{url}/projects/{projectId}/flows/{callsign}/assets";
+export declare const API_PROJECT_MISSION_ASSETS_PATH_URL = "https://{url}/projects/{projectId}/missionassets";
+export declare const API_PROJECT_MISSION_ASSET_PATH_URL = "https://{url}/projects/{projectId}/missionassets/{assetId}";
+export declare const API_PROJECT_MAPPED_ASSETS_PATH_URL = "https://{url}/projects/{projectId}/mappedassets";
+export declare const API_PROJECT_ROBOT_URL = "https://{url}/projects/{projectId}/robots";
+export declare const API_PROJECT_ROBOT_ID_URL = "https://{url}/projects/{projectId}/robots/{callsign}";
+export declare const API_PROJECT_ROBOT_ATTRIBUTES_URL = "https://{url}/projects/{projectId}/robots/{callsign}/attributes";
+export declare const API_PROJECT_ROBOT_DEFINITION_URL = "https://{url}/projects/{projectId}/robots/{callsign}/robot-definitions";
+export declare const API_PROJECT_ROBOT_REGISTER_URL = "https://{url}/projects/{projectId}/robots/{callsign}/register";
+export declare const API_PROJECT_ROBOT_EVENT_URL = "https://{url}/projects/{projectId}/robots/{callsign}/event-definitions";
+export declare const API_PROJECT_ROBOT_EVENT_HISTORY_URL = "https://{url}/projects/{projectId}/robots/{callsign}/event-definitions/{eventDefinitionId}/history";
+export declare const API_PROJECT_ROBOT_SETTING_URL = "https://{url}/projects/{projectId}/robots/{callsign}/settings";
+export declare const API_PROJECT_ROBOT_AGENT_URL = "https://{url}/projects/{projectId}/robots/{callsign}/agent-settings";
+export declare const API_PROJECT_ROBOT_COMMAND_URL = "https://{url}/projects/{projectId}/robots/{callsign}/commands";
+export declare const API_PROJECT_ROBOT_COMMAND2_URL = "https://{url}/projects/{projectId}/robots/{callsign}/commands-v2";
+export declare const API_PROJECT_ROBOT_BUTTON_URL = "https://{url}/projects/{projectId}/robots/{callsign}/buttons";
+export declare const API_PROJECT_ROBOT_TRIGGER_URL = "https://{url}/projects/{projectId}/robots/{callsign}/triggers";
+export declare const API_PROJECT_ROBOT_GAMEPAD_URL = "https://{url}/projects/{projectId}/robots/{callsign}/gamepads";
+export declare const API_PROJECT_OPERATION_URL = "https://{url}/projects/{projectId}/operations";
+export declare const API_PROJECT_OPERATION_ID_URL = "https://{url}/projects/{projectId}/operations/{operationId}";
+export declare const API_PROJECT_DASHBOARD_URL = "https://{url}/projects/{projectId}/dashboards";
+export declare const API_PROJECT_DASHBOARD_ID_URL = "https://{url}/projects/{projectId}/dashboards/{dashboardId}";
+export declare const API_PROJECT_DASHBOARD_WIDGET_URL = "https://{url}/projects/{projectId}/dashboards/{dashboardId}/widgets";
+export declare const API_PROJECT_DASHBOARD_CUSTOM_WIDGET_URL = "https://{url}/projects/{projectId}/dashboards/{dashboardId}/custom-widgets";
+export declare const API_PROJECT_COLLECTION_ID_URL = "https://{url}/projects/{projectId}/doc-collections/{collectionId}";
+export declare const API_PROJECT_COLLECTION_DOCS_URL = "https://{url}/projects/{projectId}/doc-collections/{collectionId}/docs";
+export declare const API_PROJECT_VROBOT_DETAILS_URL = "https://{url}/projects/{projectId}/vrobots/{callsign}/details";
+export declare const API_PROJECT_VROBOT_DEPLOY_URL = "https://{url}/projects/{projectId}/vrobots/{callsign}/deploy";
+export declare const API_PROJECT_DEFINITION_URL = "https://{url}/projects/{projectId}/robot-definitions";
+export declare const API_PROJECT_DEFINITION_ID_URL = "https://{url}/projects/{projectId}/robot-definitions/{definitionId}";
+export declare const API_PROJECT_DEFINITION_STREAM_URL = "https://{url}/projects/{projectId}/robot-definitions/{definitionId}/streams";
+export declare const API_PROJECT_DEFINITION_COPY_URL = "https://{url}/projects/{projectId}/robot-definitions/{definitionId}/copy";
+export declare const API_PROJECT_DEFINITION_DASHBOARD_URL = "https://{url}/projects/{projectId}/robot-definitions/{definitionId}/dashboards";
+export declare const API_PROJECT_DEFINITION_BLOB_URL = "https://{url}/projects/{projectId}/robot-definitions/{definitionId}/dashboard-blob";
+export declare const API_PROJECT_DEFINITION_SETTING_URL = "https://{url}/projects/{projectId}/robot-definitions/{definitionId}/settings";
+export declare const API_PROJECT_DEFINITION_AGENT_URL = "https://{url}/projects/{projectId}/robot-definitions/{definitionId}/agent-settings";
+export declare const API_PROJECT_DEFINITION_COMMAND_URL = "https://{url}/projects/{projectId}/robot-definitions/{definitionId}/commands";
+export declare const API_PROJECT_DEFINITION_COMMAND2_URL = "https://{url}/projects/{projectId}/robot-definitions/{definitionId}/commands-v2";
+export declare const API_PROJECT_DEFINITION_EVENT_URL = "https://{url}/projects/{projectId}/robot-definitions/{definitionId}/event-definitions";
+export declare const API_PROJECT_DEFINITION_ACTION_URL = "https://{url}/projects/{projectId}/robot-definitions/{definitionId}/command-actions";
+export declare const API_PROJECT_DEFINITION_BUTTON_URL = "https://{url}/projects/{projectId}/robot-definitions/{definitionId}/buttons";
+export declare const API_PROJECT_DEFINITION_TRIGGER_URL = "https://{url}/projects/{projectId}/robot-definitions/{definitionId}/triggers";
+export declare const API_PROJECT_DEFINITION_GAMEPAD_URL = "https://{url}/projects/{projectId}/robot-definitions/{definitionId}/gamepads";
+export declare const API_PROJECT_DEFINITION_EXPORT = "https://{url}/import-export/projects/{projectId}/robot-definitions/{definitionId}/export";
+export declare const API_PROJECT_DEFINITION_IMPORT = "https://{url}/import-export/projects/{projectId}/robot-definitions/import";
+export declare const API_PROJECT_GROUP_TYPE_URL = "https://{url}/projects/{projectId}/config-groups/{type}";
+export declare const API_PROJECT_GROUP_TYPE_ID_URL = "https://{url}/projects/{projectId}/config-groups/{type}/{configGroupId}";
+export declare const API_PROJECT_GROUP_TYPE_PUBLISH_URL = "https://{url}/projects/{projectId}/config-groups/{type}/{configGroupId}/publish";
+export declare const API_PROJECT_GROUP_TYPE_CONFIG_URL = "https://{url}/projects/{projectId}/config-groups/{type}/{configGroupId}/{configId}";
+export declare const API_PROJECT_GROUP_TYPE_VERSION_URL = "https://{url}/projects/{projectId}/config-groups/{type}/{configGroupId}/{version}";
+export declare const API_PROJECT_GROUP_TYPE_OWNER_ID_URL = "https://{url}/projects/{projectId}/config-groups/{type}/{configGroupId}/owner/{ownerId}";
+export declare const API_PROJECT_GROUP_TYPE_OWNER_OVERRIDE_URL = "https://{url}/projects/{projectId}/config-groups/{type}/{configGroupId}/{ownerId}/override";
+export declare const API_PROJECT_EXPORT_URL = "https://{url}/projects/{projectId}/export-jobs";
+export declare const API_PROJECT_STREAM_URL = "https://{url}/projects/{projectId}/streams";
+export declare const API_PROJECT_STREAM_ID_URL = "https://{url}/projects/{projectId}/streams/{streamId}";
+export declare const API_PROJECT_STREAM_DATA_URL = "https://{url}/projects/{projectId}/streams/{streamId}/data";
+export declare const API_PROJECT_STREAM_CALLSIGN_URL = "https://{url}/projects/{projectId}/streams/{streamId}/callsigns";
+export declare const API_PROJECT_ROBOT_DASHBOARD_URL = "https://{url}/projects/{projectId}/robots/{callsign}/dashboards";
+export declare const API_PROJECT_ROBOT_DASHBOARD_ID_URL = "https://{url}/projects/{projectId}/robots/{callsign}/dashboards/{dashboardId}";
+export declare const API_PROJECT_ROBOT_DASHBOARD_CUSTOM_WIDGET_URL = "https://{url}/projects/{projectId}/robots/{callsign}/dashboards/{dashboardId}/custom-widgets";
+export declare const API_PROJECT_CALLSIGN_STREAM_URL = "https://{url}/projects/{projectId}/callsigns/{callsign}/streams";
+export declare const API_PROJECT_PROFILE_DASHBOARD_URL = "https://{url}/projects/{projectId}/profiles/{profileId}/dashboards";
+export declare const API_PROJECT_PROFILE_DASHBOARD_ID_URL = "https://{url}/projects/{projectId}/profiles/{profileId}/dashboards/{dashboardId}";
+export declare const API_PROJECT_PROFILE_DASHBOARD_CUSTOM_WIDGET_URL = "https://{url}/projects/{projectId}/profiles/{profileId}/dashboards/{dashboardId}/custom-widgets";
+export declare const API_TEMPLATE_DEPLOY_URL = "https://{url}/templates/vrobot-deployment";
+export declare const API_TEMPLATE_PROVISION_URL = "https://{url}/templates/rocos-provisioning-templates";
+export declare const API_TEMPLATE_PROVISION_ID_URL = "https://{url}/templates/rocos-provisioning-templates/exec/{templateId}";
+export declare const API_TEMPLATE_EXPORTER_URL = "https://{url}/templates/project-stream-data-exporter";
+export declare const API_SOURCE_SCHEMA_URL = "https://{url}/sourceschemas";
+export declare const API_SOURCE_URL = "https://{url}/sources";
+export declare const API_SOURCE_ID_URL = "https://{url}/sources/{sourceId}";
+export declare const API_PROJECT_SCHEDULES_URL = "https://{url}/projects/{projectId}/robots/{callsign}/schedules";
+export declare const API_SPOTTY_URL = "https://{url}/spotty";
+export declare const API_DD_INTEGRATION_PLANS_URL = "https://{url}/projects/{projectId}/dd/plans";
+export declare const API_DD_INTEGRATION_PLAN_BY_ID_URL = "https://{url}/projects/{projectId}/dd/plan/{planId}";
+export declare const API_DD_INTEGRATION_OVERLAYS_URL = "https://{url}/projects/{projectId}/dd/overlays";
+export declare const API_DD_INTEGRATION_ISSUES_URL = "https://{url}/projects/{projectId}/dd/issues";
+export declare const API_MAPS_URL = "https://{url}/projects/{projectId}/maps";
+export declare const API_MAPS_DEPLOYED_URL = "https://{url}/projects/{projectId}/maps/deployed?callsign={callsign}";
+export declare const API_MAPS_MERGE_URL = "https://{url}/projects/{projectId}/maps/merge";
+export declare const API_MAP_ID_URL = "https://{url}/projects/{projectId}/maps/{mapId}";
+export declare const API_MAPS_COPY_URL = "https://{url}/projects/{projectId}/maps/{mapId}/copy";
+export declare const API_MAPS_DEPLOY_URL = "https://{url}/projects/{projectId}/maps/{mapId}/deploy";
+export declare const API_MAPS_GEOJSON_URL = "https://{url}/projects/{projectId}/maps/{mapId}/geojson";
+export declare const API_MAPS_PANORAMA_OBSERVATIONS_URL = "https://{url}/projects/{projectId}/panoramas/{panoramaId}/observations";
+export declare const API_OBSERVATIONS_URL = "https://{url}/projects/{projectId}/observations";
+export declare const API_OBSERVATION_KEYS_URL = "https://{url}/projects/{projectId}/observations/keys";
+export declare const API_PROJECT_WORKFLOW_URL = "https://{url}/projects/{projectId}/automate/flows";
+export declare const API_PROJECT_WORKFLOW_ID_URL = "https://{url}/projects/{projectId}/automate/flows/{workflowId}";
+export declare const API_PROJECT_WORKFLOW_ASSET_URL = "https://{url}/projects/{projectId}/automate/flows/{workflowId}/assets";
+export declare const API_PROJECT_DEPLOYED_WORKFLOW_URL = "https://{url}/projects/{projectId}/robots/{callsign}/automate/flows/deployments";
+export declare const API_LINKED_PROJECT_URL = "https://{url}/linked-projects/{linkedProjectId}";
+export declare const API_DEVICE_CREDENTIALS_URL = "https://{url}/projects/{projectId}/callsigns/{callsign}/device-credentials";
+export declare const API_DEVICE_CREDENTIALS_AUTH_URL = "https://{url}/device-credentials/auth";
+export declare const API_TARGETS_URL = "https://{url}/projects/{projectId}/targets";

package/esm/constants/api.js

@@ -0,0 +1,136 @@
+export const API_APPLICATION_AUTH_URL = 'https://{url}/applications/auth';
+export const API_ADMIN_USER_INVITATION_URL = 'https://{url}/admin/users/invitations';
+export const API_USER_URL = 'https://{url}/users';
+export const API_USER_AUTH_URL = 'https://{url}/users/auth';
+export const API_USER_TOKEN_URL = 'https://{url}/users/token';
+export const API_OTP_URL = 'https://{url}/otp';
+export const API_OTP_AUTH_URL = 'https://{url}/otp/auth';
+export const API_USER_PASSWORD_RESET_URL = 'https://{url}/users/forgotten-password-reset';
+export const API_USER_PASSWORD_FORGOT_URL = 'https://{url}/users/forgotten-password';
+export const API_USER_INVITATION_URL = 'https://{url}/users/invitations';
+export const API_USER_INVITATION_ACCEPT_URL = 'https://{url}/users/invitations/{invitationId}/accept';
+export const API_USER_INVITATION_CHECK_URL = 'https://{url}/users/invitations/{invitationId}/check';
+export const API_USER_VERIFY_EMAIL_URL = 'https://{url}/users/verification-email';
+export const API_USER_PAT_URL = 'https://{url}/users/pat';
+export const API_USER_PAT_TOKEN_URL = 'https://{url}/users/pat/{token}';
+export const API_ACCOUNT_URL = 'https://{url}/accounts';
+export const API_ACCOUNT_ID_URL = 'https://{url}/accounts/{accountId}';
+export const API_ACCOUNT_ACTIVATE_URL = 'https://{url}/accounts/{accountId}/activate';
+export const API_AUTH_USER_ACCOUNT_USER_URL = 'https://{url}/accounts/{accountId}/users';
+export const API_AUTH_USER_ACCOUNT_USER_ID_URL = 'https://{url}/accounts/{accountId}/users/{userId}';
+export const API_ACCOUNT_SETTINGS_URL = 'https://{url}/accounts/{accountId}/settings';
+export const API_ACCOUNT_INTEGRATION_URL = 'https://{url}/accounts/{accountId}/integrations/{integrationId}';
+export const API_ACCOUNT_INTEGRATION_TYPE_URL = 'https://{url}/accounts/{accountId}/integrations/{integrationId}/{integrationType}';
+export const API_SERVER_TIME_URL = 'https://{url}/time';
+export const API_ACCOUNT_PROJECT_URL = 'https://{url}/accounts/{accountId}/projects';
+export const API_ACCOUNT_PROJECT_ID_URL = 'https://{url}/accounts/{accountId}/projects/{projectId}';
+export const API_ACCOUNT_PROJECT_USER_URL = 'https://{url}/accounts/{accountId}/projects/{projectId}/users';
+export const API_ACCOUNT_PROJECT_USER_ID_URL = 'https://{url}/accounts/{accountId}/projects/{projectId}/users/{userId}';
+export const API_ACCOUNT_PROJECT_APPLICATION_URL = 'https://{url}/accounts/{accountId}/projects/{projectId}/applications';
+export const API_ACCOUNT_PROJECT_APPLICATION_ID_URL = 'https://{url}/accounts/{accountId}/projects/{projectId}/applications/{applicationId}';
+export const API_PROJECT_URL = 'https://{url}/projects';
+export const API_PROJECT_ID_URL = 'https://{url}/projects/{projectId}';
+export const API_PROJECT_USERS_URL = 'https://{url}/projects/{projectId}/users';
+export const API_PROJECT_ASSET_URL = 'https://{url}/projects/{projectId}/assets';
+export const API_PROJECT_ASSET_PATH_URL = 'https://{url}/projects/{projectId}/assets/{filePath}';
+export const API_PROJECT_ASSET_ROBOTS_SYNC_DEFINITION_PATH_URL = 'https://{url}/projects/{projectId}/robots/{callsign}/sync-definitions';
+export const API_PROJECT_ASSET_PROFILES_SYNC_DEFINITION_PATH_URL = 'https://{url}/projects/{projectId}/profiles/{profileId}/sync-definitions';
+export const API_PROJECT_ASSET_INTEGRATION_PROVIDERS_PATH_URL = 'https://{url}/projects/{projectId}/integration-providers';
+export const API_PROJECT_ASSET_INTEGRATIONS_PATH_URL = 'https://{url}/projects/{projectId}/integrations';
+export const API_PROJECT_ASSET_INTEGRATION_PATH_URL = 'https://{url}/projects/{projectId}/integrations/{integrationId}';
+export const API_PROJECT_ROBOT_ASSET_PATH_URL = 'https://{url}/projects/{projectId}/robots/{callsign}/assets';
+export const API_PROJECT_FLOW_ASSET_PATH_URL = 'https://{url}/projects/{projectId}/flows/{callsign}/assets';
+export const API_PROJECT_MISSION_ASSETS_PATH_URL = 'https://{url}/projects/{projectId}/missionassets';
+export const API_PROJECT_MISSION_ASSET_PATH_URL = 'https://{url}/projects/{projectId}/missionassets/{assetId}';
+export const API_PROJECT_MAPPED_ASSETS_PATH_URL = 'https://{url}/projects/{projectId}/mappedassets';
+export const API_PROJECT_ROBOT_URL = 'https://{url}/projects/{projectId}/robots';
+export const API_PROJECT_ROBOT_ID_URL = 'https://{url}/projects/{projectId}/robots/{callsign}';
+export const API_PROJECT_ROBOT_ATTRIBUTES_URL = 'https://{url}/projects/{projectId}/robots/{callsign}/attributes';
+export const API_PROJECT_ROBOT_DEFINITION_URL = 'https://{url}/projects/{projectId}/robots/{callsign}/robot-definitions';
+export const API_PROJECT_ROBOT_REGISTER_URL = 'https://{url}/projects/{projectId}/robots/{callsign}/register';
+export const API_PROJECT_ROBOT_EVENT_URL = 'https://{url}/projects/{projectId}/robots/{callsign}/event-definitions';
+export const API_PROJECT_ROBOT_EVENT_HISTORY_URL = 'https://{url}/projects/{projectId}/robots/{callsign}/event-definitions/{eventDefinitionId}/history';
+export const API_PROJECT_ROBOT_SETTING_URL = 'https://{url}/projects/{projectId}/robots/{callsign}/settings';
+export const API_PROJECT_ROBOT_AGENT_URL = 'https://{url}/projects/{projectId}/robots/{callsign}/agent-settings';
+export const API_PROJECT_ROBOT_COMMAND_URL = 'https://{url}/projects/{projectId}/robots/{callsign}/commands';
+export const API_PROJECT_ROBOT_COMMAND2_URL = 'https://{url}/projects/{projectId}/robots/{callsign}/commands-v2';
+export const API_PROJECT_ROBOT_BUTTON_URL = 'https://{url}/projects/{projectId}/robots/{callsign}/buttons';
+export const API_PROJECT_ROBOT_TRIGGER_URL = 'https://{url}/projects/{projectId}/robots/{callsign}/triggers';
+export const API_PROJECT_ROBOT_GAMEPAD_URL = 'https://{url}/projects/{projectId}/robots/{callsign}/gamepads';
+export const API_PROJECT_OPERATION_URL = 'https://{url}/projects/{projectId}/operations';
+export const API_PROJECT_OPERATION_ID_URL = 'https://{url}/projects/{projectId}/operations/{operationId}';
+export const API_PROJECT_DASHBOARD_URL = 'https://{url}/projects/{projectId}/dashboards';
+export const API_PROJECT_DASHBOARD_ID_URL = 'https://{url}/projects/{projectId}/dashboards/{dashboardId}';
+export const API_PROJECT_DASHBOARD_WIDGET_URL = 'https://{url}/projects/{projectId}/dashboards/{dashboardId}/widgets';
+export const API_PROJECT_DASHBOARD_CUSTOM_WIDGET_URL = 'https://{url}/projects/{projectId}/dashboards/{dashboardId}/custom-widgets';
+export const API_PROJECT_COLLECTION_ID_URL = 'https://{url}/projects/{projectId}/doc-collections/{collectionId}';
+export const API_PROJECT_COLLECTION_DOCS_URL = 'https://{url}/projects/{projectId}/doc-collections/{collectionId}/docs';
+export const API_PROJECT_VROBOT_DETAILS_URL = 'https://{url}/projects/{projectId}/vrobots/{callsign}/details';
+export const API_PROJECT_VROBOT_DEPLOY_URL = 'https://{url}/projects/{projectId}/vrobots/{callsign}/deploy';
+export const API_PROJECT_DEFINITION_URL = 'https://{url}/projects/{projectId}/robot-definitions';
+export const API_PROJECT_DEFINITION_ID_URL = 'https://{url}/projects/{projectId}/robot-definitions/{definitionId}';
+export const API_PROJECT_DEFINITION_STREAM_URL = 'https://{url}/projects/{projectId}/robot-definitions/{definitionId}/streams';
+export const API_PROJECT_DEFINITION_COPY_URL = 'https://{url}/projects/{projectId}/robot-definitions/{definitionId}/copy';
+export const API_PROJECT_DEFINITION_DASHBOARD_URL = 'https://{url}/projects/{projectId}/robot-definitions/{definitionId}/dashboards';
+export const API_PROJECT_DEFINITION_BLOB_URL = 'https://{url}/projects/{projectId}/robot-definitions/{definitionId}/dashboard-blob';
+export const API_PROJECT_DEFINITION_SETTING_URL = 'https://{url}/projects/{projectId}/robot-definitions/{definitionId}/settings';
+export const API_PROJECT_DEFINITION_AGENT_URL = 'https://{url}/projects/{projectId}/robot-definitions/{definitionId}/agent-settings';
+export const API_PROJECT_DEFINITION_COMMAND_URL = 'https://{url}/projects/{projectId}/robot-definitions/{definitionId}/commands';
+export const API_PROJECT_DEFINITION_COMMAND2_URL = 'https://{url}/projects/{projectId}/robot-definitions/{definitionId}/commands-v2';
+export const API_PROJECT_DEFINITION_EVENT_URL = 'https://{url}/projects/{projectId}/robot-definitions/{definitionId}/event-definitions';
+export const API_PROJECT_DEFINITION_ACTION_URL = 'https://{url}/projects/{projectId}/robot-definitions/{definitionId}/command-actions';
+export const API_PROJECT_DEFINITION_BUTTON_URL = 'https://{url}/projects/{projectId}/robot-definitions/{definitionId}/buttons';
+export const API_PROJECT_DEFINITION_TRIGGER_URL = 'https://{url}/projects/{projectId}/robot-definitions/{definitionId}/triggers';
+export const API_PROJECT_DEFINITION_GAMEPAD_URL = 'https://{url}/projects/{projectId}/robot-definitions/{definitionId}/gamepads';
+export const API_PROJECT_DEFINITION_EXPORT = 'https://{url}/import-export/projects/{projectId}/robot-definitions/{definitionId}/export';
+export const API_PROJECT_DEFINITION_IMPORT = 'https://{url}/import-export/projects/{projectId}/robot-definitions/import';
+export const API_PROJECT_GROUP_TYPE_URL = 'https://{url}/projects/{projectId}/config-groups/{type}';
+export const API_PROJECT_GROUP_TYPE_ID_URL = 'https://{url}/projects/{projectId}/config-groups/{type}/{configGroupId}';
+export const API_PROJECT_GROUP_TYPE_PUBLISH_URL = 'https://{url}/projects/{projectId}/config-groups/{type}/{configGroupId}/publish';
+export const API_PROJECT_GROUP_TYPE_CONFIG_URL = 'https://{url}/projects/{projectId}/config-groups/{type}/{configGroupId}/{configId}';
+export const API_PROJECT_GROUP_TYPE_VERSION_URL = 'https://{url}/projects/{projectId}/config-groups/{type}/{configGroupId}/{version}';
+export const API_PROJECT_GROUP_TYPE_OWNER_ID_URL = 'https://{url}/projects/{projectId}/config-groups/{type}/{configGroupId}/owner/{ownerId}';
+export const API_PROJECT_GROUP_TYPE_OWNER_OVERRIDE_URL = 'https://{url}/projects/{projectId}/config-groups/{type}/{configGroupId}/{ownerId}/override';
+export const API_PROJECT_EXPORT_URL = 'https://{url}/projects/{projectId}/export-jobs';
+export const API_PROJECT_STREAM_URL = 'https://{url}/projects/{projectId}/streams';
+export const API_PROJECT_STREAM_ID_URL = 'https://{url}/projects/{projectId}/streams/{streamId}';
+export const API_PROJECT_STREAM_DATA_URL = 'https://{url}/projects/{projectId}/streams/{streamId}/data';
+export const API_PROJECT_STREAM_CALLSIGN_URL = 'https://{url}/projects/{projectId}/streams/{streamId}/callsigns';
+export const API_PROJECT_ROBOT_DASHBOARD_URL = 'https://{url}/projects/{projectId}/robots/{callsign}/dashboards';
+export const API_PROJECT_ROBOT_DASHBOARD_ID_URL = 'https://{url}/projects/{projectId}/robots/{callsign}/dashboards/{dashboardId}';
+export const API_PROJECT_ROBOT_DASHBOARD_CUSTOM_WIDGET_URL = 'https://{url}/projects/{projectId}/robots/{callsign}/dashboards/{dashboardId}/custom-widgets';
+export const API_PROJECT_CALLSIGN_STREAM_URL = 'https://{url}/projects/{projectId}/callsigns/{callsign}/streams';
+export const API_PROJECT_PROFILE_DASHBOARD_URL = 'https://{url}/projects/{projectId}/profiles/{profileId}/dashboards';
+export const API_PROJECT_PROFILE_DASHBOARD_ID_URL = 'https://{url}/projects/{projectId}/profiles/{profileId}/dashboards/{dashboardId}';
+export const API_PROJECT_PROFILE_DASHBOARD_CUSTOM_WIDGET_URL = 'https://{url}/projects/{projectId}/profiles/{profileId}/dashboards/{dashboardId}/custom-widgets';
+export const API_TEMPLATE_DEPLOY_URL = 'https://{url}/templates/vrobot-deployment';
+export const API_TEMPLATE_PROVISION_URL = 'https://{url}/templates/rocos-provisioning-templates';
+export const API_TEMPLATE_PROVISION_ID_URL = 'https://{url}/templates/rocos-provisioning-templates/exec/{templateId}';
+export const API_TEMPLATE_EXPORTER_URL = 'https://{url}/templates/project-stream-data-exporter';
+export const API_SOURCE_SCHEMA_URL = 'https://{url}/sourceschemas';
+export const API_SOURCE_URL = 'https://{url}/sources';
+export const API_SOURCE_ID_URL = 'https://{url}/sources/{sourceId}';
+export const API_PROJECT_SCHEDULES_URL = 'https://{url}/projects/{projectId}/robots/{callsign}/schedules';
+export const API_SPOTTY_URL = 'https://{url}/spotty';
+export const API_DD_INTEGRATION_PLANS_URL = 'https://{url}/projects/{projectId}/dd/plans';
+export const API_DD_INTEGRATION_PLAN_BY_ID_URL = 'https://{url}/projects/{projectId}/dd/plan/{planId}';
+export const API_DD_INTEGRATION_OVERLAYS_URL = 'https://{url}/projects/{projectId}/dd/overlays';
+export const API_DD_INTEGRATION_ISSUES_URL = 'https://{url}/projects/{projectId}/dd/issues';
+export const API_MAPS_URL = 'https://{url}/projects/{projectId}/maps';
+export const API_MAPS_DEPLOYED_URL = 'https://{url}/projects/{projectId}/maps/deployed?callsign={callsign}';
+export const API_MAPS_MERGE_URL = 'https://{url}/projects/{projectId}/maps/merge';
+export const API_MAP_ID_URL = 'https://{url}/projects/{projectId}/maps/{mapId}';
+export const API_MAPS_COPY_URL = 'https://{url}/projects/{projectId}/maps/{mapId}/copy';
+export const API_MAPS_DEPLOY_URL = 'https://{url}/projects/{projectId}/maps/{mapId}/deploy';
+export const API_MAPS_GEOJSON_URL = 'https://{url}/projects/{projectId}/maps/{mapId}/geojson';
+export const API_MAPS_PANORAMA_OBSERVATIONS_URL = 'https://{url}/projects/{projectId}/panoramas/{panoramaId}/observations';
+export const API_OBSERVATIONS_URL = 'https://{url}/projects/{projectId}/observations';
+export const API_OBSERVATION_KEYS_URL = 'https://{url}/projects/{projectId}/observations/keys';
+export const API_PROJECT_WORKFLOW_URL = 'https://{url}/projects/{projectId}/automate/flows';
+export const API_PROJECT_WORKFLOW_ID_URL = 'https://{url}/projects/{projectId}/automate/flows/{workflowId}';
+export const API_PROJECT_WORKFLOW_ASSET_URL = 'https://{url}/projects/{projectId}/automate/flows/{workflowId}/assets';
+export const API_PROJECT_DEPLOYED_WORKFLOW_URL = 'https://{url}/projects/{projectId}/robots/{callsign}/automate/flows/deployments';
+export const API_LINKED_PROJECT_URL = 'https://{url}/linked-projects/{linkedProjectId}';
+export const API_DEVICE_CREDENTIALS_URL = 'https://{url}/projects/{projectId}/callsigns/{callsign}/device-credentials';
+export const API_DEVICE_CREDENTIALS_AUTH_URL = 'https://{url}/device-credentials/auth';
+export const API_TARGETS_URL = 'https://{url}/projects/{projectId}/targets';

package/esm/constants/auth.d.ts

@@ -0,0 +1,2 @@
+/** The expected issuer of the JWT token used to authenticate with our SDK. */
+export declare const issuer = "https://rocos.auth0.com/";