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

package/esm/services/StreamService.d.ts

@@ -0,0 +1,98 @@
+import { RocosError } from '../models/RocosError';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+import { IBaseService } from '../models/IBaseService';
+import { IRocosSDKConfig } from '../models/IRocosSDKConfig';
+import { ISource } from '../models/ISource';
+import { IStream } from '../models/IStream';
+import { IStreamSource } from '../models/IStreamSource';
+export declare class StreamService extends BaseServiceAbstract implements IBaseService {
+    constructor(config: IRocosSDKConfig);
+    protected getError(e: Error): RocosError;
+    getStatus(): boolean;
+    /**
+     * Create a new stream.
+     *
+     * @param projectId - Project Id
+     * @param stream - Stream object
+     */
+    create(projectId: string, stream: IStream): Promise<any>;
+    /**
+     * Get streams list by project id.
+     */
+    list(projectId: string): Promise<IStream[]>;
+    /**
+     * Get stream information by project id and stream id.
+     *
+     * @param projectId - Project Id
+     * @param streamId - Stream Id
+     */
+    info(projectId: string, streamId: string): Promise<IStream>;
+    /**
+     * Add new data to the stream
+     *
+     * @param projectId - Project Id
+     * @param streamId - Stream Id
+     * @param sources - Payload {@link IStreamSource[]}
+     */
+    addData(projectId: string, streamId: string, sources: IStreamSource[]): Promise<any>;
+    /**
+     * Get sources for stream.
+     */
+    sources(): Promise<ISource[]>;
+    /**
+     * Get source info
+     *
+     * @param sourceId - Source Id
+     */
+    sourceInfo(sourceId: string): Promise<ISource>;
+    /**
+     * Get streams list of robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot's Callsign
+     */
+    streamsForRobot(projectId: string, callsign: string): Promise<IStream[]>;
+    /**
+     * Bind robot with stream
+     *
+     * @param projectId - Project Id
+     * @param streamId - Steam Id
+     * @param callsigns - The Robots' callsigns which should bind with stream
+     */
+    bindRobot(projectId: string, streamId: string, callsigns: string[]): Promise<any>;
+    /**
+     * Unbind robot with stream
+     *
+     * @param projectId - Project Id
+     * @param streamId - Steam Id
+     * @param callsigns - The Robots' callsigns which should unbind with stream
+     */
+    unbindRobot(projectId: string, streamId: string, callsigns: string[]): Promise<any>;
+    /**
+     * Remove streams by list
+     *
+     * @param projectId - Project Id
+     * @param streamIds - Stream Ids
+     */
+    removeStreams(projectId: string, streamIds: string[]): Promise<any>;
+    /**
+     * Remove stream data by dataIds list
+     *
+     * @param projectId - Project Id
+     * @param streamId - Stream Id
+     * @param dataIds - Data Ids, e.g. {sourceId: string, dataId: string}
+     */
+    removeStreamData(projectId: string, streamId: string, dataIds: any[]): Promise<any>;
+    /**
+     * Remove stream data by ids list
+     *
+     * @param projectId - Project Id
+     * @param streamId - Stream Id
+     * @param ids - ids list (string[])
+     */
+    removeStreamDataByIds(projectId: string, streamId: string, ids: string[]): Promise<any>;
+    /**
+     * Get stream data exporter templates list
+     */
+    dataExporterTemplates(): Promise<any>;
+}

package/esm/services/TargetService.d.ts

@@ -0,0 +1,11 @@
+import { IBaseService, IRocosSDKConfig, RocosError, Target } from '../models';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+/**
+ * Service for managing targets (such as assets, PoI's, or FLOCS) on DroneDeploy
+ */
+export declare class TargetService extends BaseServiceAbstract implements IBaseService {
+    constructor(config: IRocosSDKConfig);
+    getStatus(): boolean;
+    protected getError(e: Error): RocosError;
+    list(projectId: string, frameID?: string): Promise<Target[]>;
+}

package/esm/services/TargetService.js

@@ -0,0 +1,27 @@
+import { RocosError, errorCodes } from '../models';
+import { API_TARGETS_URL } from '../constants/api';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+import { RocosLogger } from '../logger/RocosLogger';
+import { formatServiceUrl } from '../helpers/formatServiceUrl';
+/**
+ * Service for managing targets (such as assets, PoI's, or FLOCS) on DroneDeploy
+ */
+export class TargetService extends BaseServiceAbstract {
+    constructor(config) {
+        super(config);
+        this.logger = RocosLogger.getInstance(`TargetService(${this.config.url})`);
+    }
+    getStatus() {
+        return true;
+    }
+    getError(e) {
+        return new RocosError(e, errorCodes.TARGET_SERVICE_ERROR);
+    }
+    async list(projectId, frameID = 'seed') {
+        const resp = await this.callGet(formatServiceUrl(API_TARGETS_URL, {
+            url: this.config.url,
+            projectId,
+        }, this.config.insecure), 'Failed to list targets', { frameID });
+        return resp;
+    }
+}

package/esm/services/TelemetryService.d.ts

@@ -0,0 +1,50 @@
+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 statusSubscription;
+    private changeStream$;
+    private streamStatusSubject$;
+    constructor(config: IRocosSDKConfig);
+    /**
+     * The main method for subscribing to telemetry messages
+     *
+     * @param params - Subscription params
+     *
+     * @returns An Observable that outputs telemetry messages
+     */
+    subscribe<R = unknown>(params: ITelemetrySubscriptionParams): Observable<IRocosTelemetryMessage<'json', R>>;
+    /**
+     * A method to keep track of the current subscriptions
+     *
+     * @returns An Observable that outputs subscription changes
+     */
+    getSubscriptionChanges(): Observable<ITelemetrySubscriptions>;
+    /**
+     * A method to keep track of the stream status
+     *
+     * @returns An Observable that outputs stream status
+     */
+    getStatusChanges(): Observable<IStreamStatusMessage>;
+    /**
+     * Subscribes to the heartbeat telemetry and checks we receive one at least every 5s
+     * @param projectId
+     * @param callsign
+     * @param heartbeatTimeoutMs optionally override the deadline for heartbeats (in ms). Default 5000ms
+     * @param intervalMs optionally override the interval to check for heartbeats (in ms). Default 2000ms
+     */
+    getRobotStatusChanges(projectId: string, callsign: string, heartbeatTimeoutMs?: number, intervalMs?: number): Observable<CallsignStatus>;
+    /**
+     * Subscribes to the given telemetry and checks we receive one at least emission every `heartbeatTimeoutMs` (default 5s)
+     * @param projectId
+     * @param callsign
+     * @param source the telemetry source to monitor
+     * @param heartbeatTimeoutMs optionally override the deadline for telemetry emissions (in ms). Default 5000ms
+     * @param intervalMs optionally override the interval to check for telemetry emissions (in ms). Default 2000ms
+     */
+    monitorTelemetryWithTimeout(projectId: string, callsign: string, source: string, heartbeatTimeoutMs?: number, intervalMs?: number): Observable<TelemetryMonitorStatus>;
+    protected initStream(stream: ITelemetryStream): Promise<void>;
+    private buildScope;
+    private createStream;
+    protected getStream(config: ITelemetryStreamConfig): ITelemetryStream;
+}

package/esm/services/TelemetryService.js

@@ -0,0 +1,176 @@
+import { BehaviorSubject, catchError, combineLatest, distinctUntilChanged, from, interval, map, mergeAll, of, startWith, } from 'rxjs';
+import { CallsignStatus, CallsignsLookup, CallsignsLookupType, RocosError, TelemetryMonitorStatus, SubscriberStatusEnum, errorCodes, } from '../models';
+import { filter, finalize } from 'rxjs/operators';
+import { BaseStreamService } from './BaseStreamService';
+import { IDENTIFIER_NAME_TELEMETRY } from '../constants/identifier';
+import { RocosStore } from '../store/RocosStore';
+import { TelemetryStream } from '../api/streams/telemetry/TelemetryStream';
+import { arrayUnique } from '../helpers/arrayUnique';
+import { flattenCallsignsLookup } from '../helpers/flattenCallsignsLookup';
+import { getUniqueId } from '../helpers/getUniqueId';
+const HEARTBEAT_SOURCE = '/rocos/agent/telemetry/heartbeat';
+const HEARTBEAT_TIMEOUT = 5000; // if no heartbeat within 5 seconds then the robot is considered dead
+export class TelemetryService extends BaseStreamService {
+    constructor(config) {
+        super('TelemetryService', config);
+        this.changeStream$ = new BehaviorSubject(new Map());
+        RocosStore.getChangeSubject()
+            .pipe(filter((message) => {
+            return message.type === 'telemetry-subscription' && message.url === this.config.url;
+        }))
+            .subscribe((msg) => {
+            this.changeStream$.next(msg.data);
+        });
+        this.streamStatusSubject$ = new BehaviorSubject({
+            scope: 'default',
+            status: SubscriberStatusEnum.STOPPED,
+        });
+    }
+    /**
+     * The main method for subscribing to telemetry messages
+     *
+     * @param params - Subscription params
+     *
+     * @returns An Observable that outputs telemetry messages
+     */
+    subscribe(params) {
+        const sources = arrayUnique(params.sources).map((item) => item.trim()) ?? [];
+        if (!params?.callsigns && params?.query) {
+            this.logger.error('Error: params need to contain either callsigns or query', params);
+            throw new RocosError('Params need to contain either callsigns or query.', errorCodes.TELEMETRY_SERVICE_ERROR);
+        }
+        let callsignsLookup = new CallsignsLookup([]);
+        if (params?.callsigns) {
+            this.logger.info('subscribe with callsigns', params);
+            callsignsLookup = new CallsignsLookup(params.callsigns);
+        }
+        else if (params?.query) {
+            this.logger.info('subscribe with query', params);
+            callsignsLookup = new CallsignsLookup(params.query);
+        }
+        // scope is used as a key to generate unique streams
+        // ideally there should be just one concurrent stream opened
+        const scope = this.buildScope(params, callsignsLookup);
+        const callsigns = callsignsLookup.lookupValue;
+        const subscriptionParams = {
+            uniqueId: getUniqueId(params.projectId, callsignsLookup, sources, scope),
+            callsigns: callsignsLookup?.lookupType === CallsignsLookupType.List ? callsignsLookup.lookupValue : [],
+            sources,
+        };
+        const stream = this.createStream(params.projectId, callsignsLookup, sources, scope).then((stream) => {
+            stream.addSubscription(subscriptionParams);
+            if (!this.statusSubscription) {
+                this.statusSubscription = stream.statusStream$.subscribe((msg) => {
+                    this.status = msg === SubscriberStatusEnum.STOPPED || msg === SubscriberStatusEnum.ALIVE;
+                    this.status$.next(msg);
+                });
+            }
+            return from(stream.messageStream$).pipe(finalize(() => stream?.removeSubscription(subscriptionParams, params.terminateReceiverGroupOnUnsubscribe)));
+        });
+        return from(stream).pipe(mergeAll(), filter((message) => {
+            return callsigns.includes(message.callsign) && sources.includes(message.source);
+        }));
+    }
+    /**
+     * A method to keep track of the current subscriptions
+     *
+     * @returns An Observable that outputs subscription changes
+     */
+    getSubscriptionChanges() {
+        return this.changeStream$.asObservable();
+    }
+    /**
+     * A method to keep track of the stream status
+     *
+     * @returns An Observable that outputs stream status
+     */
+    getStatusChanges() {
+        return this.streamStatusSubject$.asObservable();
+    }
+    /**
+     * Subscribes to the heartbeat telemetry and checks we receive one at least every 5s
+     * @param projectId
+     * @param callsign
+     * @param heartbeatTimeoutMs optionally override the deadline for heartbeats (in ms). Default 5000ms
+     * @param intervalMs optionally override the interval to check for heartbeats (in ms). Default 2000ms
+     */
+    getRobotStatusChanges(projectId, callsign, heartbeatTimeoutMs = HEARTBEAT_TIMEOUT, intervalMs = 2000) {
+        return this.monitorTelemetryWithTimeout(projectId, callsign, HEARTBEAT_SOURCE, heartbeatTimeoutMs, intervalMs).pipe(map((status) => {
+            switch (status) {
+                case TelemetryMonitorStatus.CONNECTED:
+                    return CallsignStatus.ONLINE;
+                case TelemetryMonitorStatus.DISCONNECTED:
+                    return CallsignStatus.OFFLINE;
+                case TelemetryMonitorStatus.ERROR:
+                    return CallsignStatus.ERROR;
+                default:
+                    return CallsignStatus.UNKNOWN;
+            }
+        }));
+    }
+    /**
+     * Subscribes to the given telemetry and checks we receive one at least emission every `heartbeatTimeoutMs` (default 5s)
+     * @param projectId
+     * @param callsign
+     * @param source the telemetry source to monitor
+     * @param heartbeatTimeoutMs optionally override the deadline for telemetry emissions (in ms). Default 5000ms
+     * @param intervalMs optionally override the interval to check for telemetry emissions (in ms). Default 2000ms
+     */
+    monitorTelemetryWithTimeout(projectId, callsign, source, heartbeatTimeoutMs = HEARTBEAT_TIMEOUT, intervalMs = 2000) {
+        const startedAt = Date.now();
+        const heartbeatTime$ = this.subscribe({
+            projectId,
+            sources: [source],
+            callsigns: [callsign],
+        }).pipe(map(() => Date.now()));
+        return combineLatest([heartbeatTime$.pipe(startWith(startedAt)), interval(intervalMs)]).pipe(map(([lastHeartbeat, _]) => {
+            const now = Date.now();
+            // If we haven't received a heartbeat, but we've only just started
+            if (lastHeartbeat === startedAt && now - startedAt <= heartbeatTimeoutMs) {
+                return TelemetryMonitorStatus.UNKNOWN;
+            }
+            if (now - lastHeartbeat > heartbeatTimeoutMs) {
+                return TelemetryMonitorStatus.DISCONNECTED;
+            }
+            return TelemetryMonitorStatus.CONNECTED;
+        }), startWith(TelemetryMonitorStatus.UNKNOWN), distinctUntilChanged(), catchError(() => of(TelemetryMonitorStatus.ERROR)));
+    }
+    async initStream(stream) {
+        await super.initStream(stream);
+        stream.init();
+    }
+    buildScope(params, callsignsLookup) {
+        // prefix with project id to avoid stream instance to be shared across projects
+        if (params.scope)
+            return `${params.projectId}-${params.scope}`;
+        this.logger.debug('No scope is set, generating default');
+        if (callsignsLookup)
+            return `${params.projectId}-default-${flattenCallsignsLookup(callsignsLookup).join()}`;
+        return `${params.projectId}-default`;
+    }
+    async createStream(projectId, callsignsLookup, sources, scope) {
+        const newStream = await this.createStreamFromConfig(IDENTIFIER_NAME_TELEMETRY, {
+            url: this.config.url,
+            projectId,
+            callsignsLookup,
+            sources,
+            token: this.config.token,
+            scope: scope ?? 'default',
+            options: this.config.options,
+            port: this.config.port,
+            insecure: this.config.insecure,
+        });
+        if (!newStream.isNew) {
+            newStream.stream.statusStream$.subscribe((msg) => {
+                this.streamStatusSubject$.next({
+                    scope,
+                    status: msg,
+                });
+            });
+        }
+        return newStream.stream;
+    }
+    getStream(config) {
+        return new TelemetryStream(config);
+    }
+}

package/esm/services/TelemetryServiceNode.d.ts

@@ -0,0 +1,6 @@
+import { ITelemetryStream } from '../models/stream/ITelemetryStream';
+import { ITelemetryStreamConfig } from '../models/ITelemetryStreamConfig';
+import { TelemetryService } from './TelemetryService';
+export declare class TelemetryServiceNode extends TelemetryService {
+    protected getStream(config: ITelemetryStreamConfig): ITelemetryStream;
+}

package/esm/services/TimeSyncerService.d.ts

@@ -0,0 +1,13 @@
+import { RocosError } from '../models/RocosError';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+import { IBaseService } from '../models/IBaseService';
+import { IRocosSDKConfig } from '../models/IRocosSDKConfig';
+export declare class TimeSyncerService extends BaseServiceAbstract implements IBaseService {
+    constructor(config: IRocosSDKConfig);
+    protected getError(e: Error): RocosError;
+    getStatus(): boolean;
+    /**
+     * Get Server Time
+     */
+    getServerTime(): Promise<any>;
+}

package/esm/services/UserService.d.ts

@@ -0,0 +1,200 @@
+import { IInvitation, IInvitationType } from '../models/IInvitation';
+import { RocosError } from '../models/RocosError';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+import { IBaseService } from '../models/IBaseService';
+import { IInvitationExists } from '../models/IInvitationExists';
+import { IPersonalAccessToken } from '../models/IPersonalAccessToken';
+import { IProjectApplication } from '../models/IProjectApplication';
+import { IRocosSDKConfig } from '../models/IRocosSDKConfig';
+export declare class UserService extends BaseServiceAbstract implements IBaseService {
+    constructor(config: IRocosSDKConfig);
+    protected getError(e: Error): RocosError;
+    getStatus(): boolean;
+    /**
+     * Get the information of current user
+     */
+    info(): Promise<any>;
+    /**
+     * Get a new valid token
+     * @deprecated Please use {@link AuthService.getNewUserToken}
+     */
+    getToken(): Promise<any>;
+    /**
+     * Create a new invitation.
+     *
+     * @param invitation - Invitation payload {@link IInvitation}
+     */
+    createInvitation(invitation: IInvitation): Promise<any>;
+    /**
+     * List invitations
+     */
+    listInvitations(): Promise<any>;
+    /**
+     * Delete invitations by email and invite type.
+     *
+     * @param email - Email
+     * @param type
+     */
+    deleteInvitations(email: string, type: IInvitationType): Promise<any>;
+    /**
+     * Accept invitation by id
+     *
+     * @param invitationId - Invitation Id
+     */
+    acceptInvitation(invitationId: string): Promise<any>;
+    /**
+     * Check invitation by id
+     *
+     * @param invitationId - Invitation Id
+     */
+    checkInvitation(invitationId: string): Promise<IInvitationExists>;
+    /**
+     * Activate account by id
+     *
+     * @param accountId - Account Id
+     */
+    activateAccount(accountId: string): Promise<any>;
+    /**
+     * Resend verification email
+     *
+     * @param email - Email
+     */
+    resendVerificationEmail(email: string): Promise<any>;
+    /**
+     * Send forgotten password email.
+     *
+     * @param email - Email
+     */
+    sendForgottenPasswordEmail(email: string): Promise<any>;
+    /**
+     * Revoke user's project access.
+     *
+     * @param accountId - Account Id
+     * @param projectId - Project Id
+     * @param userId - User Id
+     */
+    removeProjectAccess(accountId: string, projectId: string, userId: string): Promise<any>;
+    /**
+     * Revoke user's account access.
+     *
+     * @param accountId - Account Id
+     * @param userId - User Id
+     */
+    removeAccountAccess(accountId: string, userId: string): Promise<any>;
+    /**
+     * List account users
+     *
+     * @param accountId - Account Id
+     */
+    listAccountUsers(accountId: string): Promise<any>;
+    /**
+     * List project users
+     *
+     * @param accountId - Account Id
+     * @param projectId - Project Id
+     */
+    listProjectUsers(accountId: string, projectId: string): Promise<any>;
+    /**
+     * Create a users personal access token.
+     *
+     * @param personalAccessToken - Payload {@link IPersonalAccessToken}
+     */
+    createPAT(personalAccessToken: IPersonalAccessToken): Promise<IPersonalAccessToken>;
+    /**
+     * Get all personal access tokens
+     *
+     * @param projectId - Project Id
+     * @param robotDefinitionId - Robot definition Id
+     */
+    getAllPATs(projectId: string, robotDefinitionId: string): Promise<any>;
+    /**
+     * Get a personal access token
+     *
+     * @param tokenString - Token string
+     */
+    getOnePAT(tokenString: string): Promise<any>;
+    /**
+     * REmove personal access token
+     *
+     * @param id - Token Id
+     */
+    removePATById(id: string): Promise<any>;
+    /**
+     * Get account details
+     *
+     * @param accountId - Account Id
+     */
+    accountDetails(accountId: string): Promise<any>;
+    /**
+     * Create an account
+     *
+     * @param name - Account name
+     */
+    createAccount(name: string): Promise<any>;
+    /**
+     * Authenticate application
+     *
+     * @param appId - Application Id
+     * @param appKey - Application Key
+     */
+    applicationAuth(appId: string, appKey: string): Promise<any>;
+    /**
+     * Create a new application
+     *
+     * @param accountId - Account Id
+     * @param projectId - Project Id
+     * @param model - Payload {@link IProjectApplication}
+     */
+    createApplication(accountId: string, projectId: string, model: IProjectApplication): Promise<IProjectApplication>;
+    /**
+     * List all applications
+     *
+     * @param accountId - Account Id
+     * @param projectId - Project Id
+     */
+    getAllApplications(accountId: string, projectId: string): Promise<any>;
+    /**
+     * Get application information
+     *
+     * @param accountId - Account Id
+     * @param projectId - Project Id
+     * @param applicationId - Application Id
+     */
+    getApplication(accountId: string, projectId: string, applicationId: string): Promise<any>;
+    /**
+     * Update application information
+     *
+     * @param accountId - Account Id
+     * @param projectId - Project Id
+     * @param applicationId - Application Id
+     * @param model - Payload
+     */
+    updateApplication(accountId: string, projectId: string, applicationId: string, model: any): Promise<any>;
+    /**
+     * Delete application
+     *
+     * @param accountId - Account ID
+     * @param projectId - Project ID
+     * @param applicationId - Application ID
+     */
+    deleteApplication(accountId: string, projectId: string, applicationId: string): Promise<any>;
+    /**
+     * Get account settings.
+     *
+     * @param accountId - Account Id
+     */
+    accountSettings(accountId: string): Promise<any>;
+    /**
+     * Update account settings
+     *
+     * @param accountId - Account ID
+     * @param settings - Updated account settings
+     */
+    updateAccountSettings(accountId: string, settings: any): Promise<any>;
+    /**
+     * Send a new invitation.
+     *
+     * @param invitation - Invitation payload {@link IInvitation}
+     */
+    sendInvitation(invitation: IInvitation): Promise<any>;
+}

package/esm/services/WebRTCSignallingService.d.ts

@@ -0,0 +1,22 @@
+import { IAddIceCandidateRequest, IGetDetailsRequest, IOfferRequest, IOperatorConnectRequest, IWebRTCSignallingGetDetailsResponse, IWebRTCSignallingMessage, IWebRTCSignallingOutcome, IWebRTCSignallingResponseStream, IWebRTCSignallingStream } from '..';
+import { IBaseService } from '../models/IBaseService';
+import { IRocosSDKConfig } from '../models/IRocosSDKConfig';
+import { IStreamConfig } from '../models/IStreamConfig';
+import { ISubscriberStatus } from '../models/ISubscriberStatus';
+import { Subject } from 'rxjs';
+import { SubscriberStatusEnum } from '../models/SubscriberStatusEnum';
+export declare class WebRTCSignallingService implements IBaseService, ISubscriberStatus {
+    private config;
+    private logger;
+    private status;
+    status$: Subject<SubscriberStatusEnum>;
+    constructor(config: IRocosSDKConfig);
+    getStatus(): boolean;
+    connectOperator(request: IOperatorConnectRequest): Promise<IWebRTCSignallingResponseStream<IWebRTCSignallingMessage>>;
+    getDetails(request: IGetDetailsRequest): Promise<IWebRTCSignallingGetDetailsResponse>;
+    offerConnection(request: IOfferRequest): Promise<IWebRTCSignallingOutcome>;
+    addIceCandidate(request: IAddIceCandidateRequest): Promise<IWebRTCSignallingOutcome>;
+    private createSignallingStream;
+    private initStream;
+    protected getStream(config: IStreamConfig): IWebRTCSignallingStream;
+}

package/esm/services/WorkflowService.d.ts

@@ -0,0 +1,62 @@
+import type { Workflow, WorkflowBase } from '../models/workflow/Workflow';
+import { RocosError } from '../models/RocosError';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+import { IBaseService } from '../models/IBaseService';
+import { IRocosSDKConfig } from '../models/IRocosSDKConfig';
+export declare class WorkflowService extends BaseServiceAbstract implements IBaseService {
+    constructor(config: IRocosSDKConfig);
+    protected getError(e: Error): RocosError;
+    getStatus(): boolean;
+    /**
+     * Get workflows for project
+     *
+     * @param projectId - Project Id
+     */
+    list(projectId: string): Promise<Workflow[]>;
+    /**
+     * Create a workflow
+     *
+     * @param projectId - Project Id
+     * @param model - Workflow
+     */
+    create(projectId: string, model: WorkflowBase): Promise<Workflow>;
+    /**
+     * Get a workflow
+     *
+     * @param projectId - Project Id
+     * @param workflowId - Workflow Id
+     */
+    get(projectId: string, workflowId: string): Promise<Workflow>;
+    /**
+     * Update a workflow
+     *
+     * @param projectId - Project Id
+     * @param workflowId - Workflow Id
+     * @param model - Workflow
+     */
+    update(projectId: string, workflowId: string, model: Workflow): Promise<Workflow>;
+    /**
+     * Upload workflow asset
+     *
+     * @param projectId - Project Id
+     * @param workflowId - Workflow Id
+     * @param fileName - Name of file including extension
+     * @param arrayBuffer - data to upload
+     */
+    uploadAsset(projectId: string, workflowId: string, fileName: string, arrayBuffer: ArrayBuffer): Promise<void>;
+    protected uploadAssetWithHash(projectId: string, workflowId: string, fileName: string, arrayBuffer: ArrayBuffer, hash: string): Promise<void>;
+    /**
+     * Delete a workflow
+     *
+     * @param projectId - Project Id
+     * @param workflowId - Workflow Id
+     */
+    delete(projectId: string, workflowId: string): Promise<void>;
+    /**
+     * Get deployed workflows on robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     */
+    getDeployedWorkflows(projectId: string, callsign: string): Promise<Workflow[]>;
+}