@dronedeploy/rocos-js-sdk 2.6.1 → 3.0.0-alpha.20

package/models/IFunctionConfig.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/models/IInvitation.d.ts

@@ -1,4 +1,4 @@
-export declare type IInvitationType = 'PROJECT' | 'SIGNUP';
+export type IInvitationType = 'PROJECT' | 'SIGNUP';
 export interface IInvitation {
     email: string;
     type: IInvitationType;

package/models/IInvitation.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/models/IInvitationExists.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/models/IOperation.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/models/IPersonalAccessToken.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/models/IProject.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/models/IProjectApplication.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/models/IRobot.d.ts

@@ -14,4 +14,5 @@ export interface IRobot {
     createdAt?: string;
     updatedAt?: string;
     robotDefinitionName?: string;
+    robotDefinitionTags?: string[];
 }

package/models/IRobot.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/models/IRobotConfig.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/models/IRobotPlugin.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/models/IRobotSettings.d.ts

@@ -0,0 +1,28 @@
+export interface IRobotSettings {
+    type: "settings";
+    items: {
+        id: string;
+        value: {
+            /**
+             * The actual settings object for this specific setting type
+             */
+            settings: Record<string, any>;
+            /**
+             * The ID of the setting type, usually one of: ops-global-settings, ops-local-settings, flight-app-settings
+             */
+            id: 'ops-global-settings' | 'ops-local-settings' | 'flight-app-settings' | string;
+            enabled: boolean;
+        };
+    }[];
+    version: number;
+    robotDefinitionId: string;
+    username: string;
+    /**
+     * Date in ISO format
+     */
+    createdAt: string;
+    /**
+     * Date in ISO format
+     */
+    updatedAt: string;
+}

package/models/IRobotSettings.js

@@ -0,0 +1 @@
+export {};

package/models/IRobotTemplate.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/models/IRocosSDKConfig.d.ts

@@ -1,8 +1,9 @@
 import { IStreamOptions } from './IStreamOptions';
-export declare type IRocosSDKConfig = IRocosSDKConfigApp | IRocosSDKConfigUser | IRocosSDKConfigToken;
+export type IRocosSDKConfig = IRocosSDKConfigApp | IRocosSDKConfigToken;
 interface IRocosSDKConfigBase {
     url: string;
     token?: string;
+    refreshToken?: string;
     options?: IStreamOptions;
     port?: number;
     insecure?: boolean;
@@ -11,15 +12,8 @@ export interface IRocosSDKConfigApp extends IRocosSDKConfigBase {
     appId: string;
     appKey: string;
 }
-/**
- * @deprecated Use IRocosSDKConfigApp or IRocosSDKConfigToken instead
- */
-export interface IRocosSDKConfigUser extends IRocosSDKConfigBase {
-    email: string;
-    password: string;
-    invitationCode?: string;
-}
 export interface IRocosSDKConfigToken extends IRocosSDKConfigBase {
     token: string;
+    refreshToken?: string;
 }
 export {};

package/models/IRocosSDKConfig.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/models/ISource.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/models/IStream.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/models/IStreamConfig.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/models/IStreamOptions.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/models/IStreamSource.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/models/ISubscriberStatus.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/models/ITelemetryStreamConfig.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/models/IToken.d.ts

@@ -1,5 +1,9 @@
 export interface IToken {
-    value: string;
-    created: string;
-    expiresIn: number;
+    readonly value: string;
+    readonly expires?: Date;
+    readonly issuedAt?: Date;
+    readonly subject?: string;
+    readonly issuer?: string;
+    readonly audience?: string;
+    readonly refreshToken?: string;
 }

package/models/IToken.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/models/IWidget.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/models/IWidgetLineGroup.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/models/ResponseLevelEnum.d.ts

@@ -1,6 +1,10 @@
 export declare enum ResponseLevelEnum {
+    /** ack, return, result **/
     ALL = 0,
+    /** return, result **/
     RETURN_AND_RESULT = 1,
+    /** result **/
     RESULT_ONLY = 2,
+    /** nothing **/
     NONE = 3
 }

package/models/ResponseLevelEnum.js

@@ -1,10 +1,11 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ResponseLevelEnum = void 0;
-var ResponseLevelEnum;
+export var ResponseLevelEnum;
 (function (ResponseLevelEnum) {
+    /** ack, return, result **/
     ResponseLevelEnum[ResponseLevelEnum["ALL"] = 0] = "ALL";
+    /** return, result **/
     ResponseLevelEnum[ResponseLevelEnum["RETURN_AND_RESULT"] = 1] = "RETURN_AND_RESULT";
+    /** result **/
     ResponseLevelEnum[ResponseLevelEnum["RESULT_ONLY"] = 2] = "RESULT_ONLY";
+    /** nothing **/
     ResponseLevelEnum[ResponseLevelEnum["NONE"] = 3] = "NONE";
-})(ResponseLevelEnum = exports.ResponseLevelEnum || (exports.ResponseLevelEnum = {}));
+})(ResponseLevelEnum || (ResponseLevelEnum = {}));

package/models/Robot.d.ts

@@ -15,5 +15,6 @@ export declare class Robot implements IRobot {
     createdAt?: string;
     updatedAt?: string;
     robotDefinitionName?: string;
+    robotDefinitionTags?: string[];
     constructor(init?: Partial<IRobot>);
 }

package/models/Robot.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Robot = void 0;
-class Robot {
+export class Robot {
     constructor(init) {
         this.disabled = false;
         this.imageId = '';
@@ -9,4 +6,3 @@ class Robot {
         Object.assign(this, init);
     }
 }
-exports.Robot = Robot;

package/models/RobotConfig.js

@@ -1,9 +1,5 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RobotConfig = void 0;
-class RobotConfig {
+export class RobotConfig {
     constructor(init) {
         Object.assign(this, init);
     }
 }
-exports.RobotConfig = RobotConfig;

package/models/RobotPlugin.js

@@ -1,9 +1,5 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RobotPlugin = void 0;
-class RobotPlugin {
+export class RobotPlugin {
     constructor(init) {
         Object.assign(this, init);
     }
 }
-exports.RobotPlugin = RobotPlugin;

package/models/RobotTemplate.js

@@ -1,30 +1,25 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RobotTemplate = void 0;
-const RobotConfig_1 = require("./RobotConfig");
-const RobotPlugin_1 = require("./RobotPlugin");
-class RobotTemplate {
+import { RobotConfig } from './RobotConfig';
+import { RobotPlugin } from './RobotPlugin';
+export class RobotTemplate {
     constructor(init) {
-        var _a, _b, _c;
         this.parameters = [];
         this.plugins = [];
         Object.assign(this, init);
-        if ((init === null || init === void 0 ? void 0 : init.parameters) && ((_a = init === null || init === void 0 ? void 0 : init.parameters) === null || _a === void 0 ? void 0 : _a.length) > 0) {
+        if (init?.parameters && init?.parameters?.length > 0) {
             this.parameters = init.parameters.map((config) => {
-                return new RobotConfig_1.RobotConfig(config);
+                return new RobotConfig(config);
             });
         }
         try {
-            this.metaData = JSON.parse(init === null || init === void 0 ? void 0 : init.metaData);
-            if (((_c = (_b = this === null || this === void 0 ? void 0 : this.metaData) === null || _b === void 0 ? void 0 : _b.plugins) === null || _c === void 0 ? void 0 : _c.length) > 0) {
+            this.metaData = JSON.parse(init?.metaData);
+            if (this?.metaData?.plugins?.length > 0) {
                 this.plugins = this.metaData.plugins.map((plugin) => {
-                    return new RobotPlugin_1.RobotPlugin(plugin);
+                    return new RobotPlugin(plugin);
                 });
             }
         }
-        catch (_d) {
+        catch {
             this.metaData = {};
         }
     }
 }
-exports.RobotTemplate = RobotTemplate;

package/models/RocosError.d.ts

@@ -22,6 +22,7 @@ export declare const errorCodes: {
     SCHEDULE_SERVICE_ERROR: string;
     INTEGRATIONS_SERVICE_ERROR: string;
     MAPS_SERVICE_ERROR: string;
+    EVALUATOR_SERVICE_ERROR: string;
 };
 export declare class RocosError extends Error {
     code?: string;

package/models/RocosError.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RocosError = exports.errorCodes = void 0;
-exports.errorCodes = {
+export const errorCodes = {
     SKD_ERROR: 'SKD_ERROR',
     AUTH_ERROR: 'AUTH_ERROR',
     ROBOT_SERVICE_ERROR: 'ROBOT_SERVICE_ERROR',
@@ -25,8 +22,9 @@ exports.errorCodes = {
     SCHEDULE_SERVICE_ERROR: 'SCHEDULE_SERVICE_ERROR',
     INTEGRATIONS_SERVICE_ERROR: 'INTEGRATIONS_SERVICE_ERROR',
     MAPS_SERVICE_ERROR: 'MAPS_SERVICE_ERROR',
+    EVALUATOR_SERVICE_ERROR: 'EVALUATOR_SERVICE_ERROR',
 };
-class RocosError extends Error {
+export class RocosError extends Error {
     constructor(err, code, statusCode) {
         if (err instanceof Error) {
             super(err.message);
@@ -40,4 +38,3 @@ class RocosError extends Error {
         this.statusCode = statusCode;
     }
 }
-exports.RocosError = RocosError;

package/models/ServiceEnum.d.ts

@@ -22,5 +22,6 @@ export declare enum ServiceEnum {
     SCHEDULE = "schedule",
     SPOT_PROVISIONER = "spot_provisioner",
     INTEGRATION = "integration",
-    MAP = "map"
+    MAP = "map",
+    EVALUATOR = "evaluator"
 }

package/models/ServiceEnum.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ServiceEnum = void 0;
-var ServiceEnum;
+export var ServiceEnum;
 (function (ServiceEnum) {
     ServiceEnum["AUTH"] = "auth";
     ServiceEnum["TELEMETRY"] = "telemetry";
@@ -27,4 +24,5 @@ var ServiceEnum;
     ServiceEnum["SPOT_PROVISIONER"] = "spot_provisioner";
     ServiceEnum["INTEGRATION"] = "integration";
     ServiceEnum["MAP"] = "map";
-})(ServiceEnum = exports.ServiceEnum || (exports.ServiceEnum = {}));
+    ServiceEnum["EVALUATOR"] = "evaluator";
+})(ServiceEnum || (ServiceEnum = {}));

package/models/Stream.js

@@ -1,15 +1,11 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Stream = void 0;
-const StreamSource_1 = require("./StreamSource");
-class Stream {
+import { StreamSource } from './StreamSource';
+export class Stream {
     constructor(init) {
         Object.assign(this, init);
-        if (init === null || init === void 0 ? void 0 : init.data) {
+        if (init?.data) {
             this.data = init.data.map((source) => {
-                return new StreamSource_1.StreamSource(source);
+                return new StreamSource(source);
             });
         }
     }
 }
-exports.Stream = Stream;

package/models/StreamOptions.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StreamOptions = void 0;
-class StreamOptions {
+export class StreamOptions {
     constructor() {
         this.autoResubscribeEnabled = false;
         // Resubscribe when received messages above this limit.
@@ -34,4 +31,3 @@ class StreamOptions {
         return options;
     }
 }
-exports.StreamOptions = StreamOptions;

package/models/StreamSource.js

@@ -1,15 +1,11 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StreamSource = void 0;
-class StreamSource {
+export class StreamSource {
     constructor(init) {
         Object.assign(this, init);
-        if (!(init === null || init === void 0 ? void 0 : init.sourceId)) {
+        if (!init?.sourceId) {
             this.sourceId = '';
         }
-        if (!(init === null || init === void 0 ? void 0 : init.dataId)) {
+        if (!init?.dataId) {
             this.dataId = '';
         }
     }
 }
-exports.StreamSource = StreamSource;

package/models/SubscriberStatusEnum.js

@@ -1,10 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SubscriberStatusEnum = void 0;
-var SubscriberStatusEnum;
+export var SubscriberStatusEnum;
 (function (SubscriberStatusEnum) {
     SubscriberStatusEnum["STOPPED"] = "stopped";
     SubscriberStatusEnum["ALIVE"] = "alive";
     SubscriberStatusEnum["DEAD"] = "dead";
     SubscriberStatusEnum["ERROR"] = "error";
-})(SubscriberStatusEnum = exports.SubscriberStatusEnum || (exports.SubscriberStatusEnum = {}));
+})(SubscriberStatusEnum || (SubscriberStatusEnum = {}));

package/models/Token.d.ts

@@ -1,8 +1,40 @@
 import { IToken } from './IToken';
+/** Represents a JWT token.
+ *
+ * @see https://jwt.io/
+ * @see https://tools.ietf.org/html/rfc7519
+ * */
 export declare class Token implements IToken {
-    value: string;
-    created: string;
-    expiresIn: number;
-    constructor(init?: Partial<IToken>);
+    /**
+     * The raw token value.
+     *
+     * @see bearer
+     */
+    readonly value: string;
+    readonly audience?: string;
+    readonly expires?: Date;
+    readonly issuedAt?: Date;
+    readonly issuer?: string;
+    readonly subject?: string;
+    readonly refreshToken?: string;
+    constructor(token: string, refreshToken?: string);
+    /** Convenience method to get the token in Bearer format. */
+    get bearer(): string;
+    /**
+     * Check if the token is expired
+     *
+     * You may optionally provide a threshold in minutes to check if the token will expire within that time.
+     * If no threshold is provided, the token will be considered expired if it has already expired.
+     *
+     * @returns true if the token is expired (or will expire within the threshold)
+     */
+    isExpiredIn(threshold?: number, unit?: 'minutes' | 'seconds' | 'hours'): boolean;
     isExpired(): boolean;
+    private getJWTPayload;
+    /** Decode a base64 string.
+     *
+     * Supports both Node.js and browser environments.
+     * @private
+     */
+    private decodeBase64;
 }

package/models/Token.js

@@ -1,15 +1,78 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Token = void 0;
-class Token {
-    constructor(init) {
-        var _a, _b;
-        Object.assign(this, init);
-        this.created = (_a = init === null || init === void 0 ? void 0 : init.created) !== null && _a !== void 0 ? _a : new Date().toString();
-        this.expiresIn = (_b = init === null || init === void 0 ? void 0 : init.expiresIn) !== null && _b !== void 0 ? _b : 86400000; // 24 hours
+import { isNode } from '../helpers/enviroment';
+/** Represents a JWT token.
+ *
+ * @see https://jwt.io/
+ * @see https://tools.ietf.org/html/rfc7519
+ * */
+export class Token {
+    constructor(token, refreshToken) {
+        this.value = token;
+        this.refreshToken = refreshToken;
+        const decoded = this.getJWTPayload(token);
+        this.audience = typeof decoded.aud === 'string' ? decoded.aud : undefined;
+        this.expires = decoded.exp ? new Date(Number(decoded.exp) * 1000) : undefined;
+        this.issuedAt = decoded.iat ? new Date(Number(decoded.iat) * 1000) : undefined;
+        this.issuer = typeof decoded.iss === 'string' ? decoded.iss : undefined;
+        this.subject = typeof decoded.sub === 'string' ? decoded.sub : undefined;
+    }
+    /** Convenience method to get the token in Bearer format. */
+    get bearer() {
+        return `Bearer ${this.value}`;
+    }
+    /**
+     * Check if the token is expired
+     *
+     * You may optionally provide a threshold in minutes to check if the token will expire within that time.
+     * If no threshold is provided, the token will be considered expired if it has already expired.
+     *
+     * @returns true if the token is expired (or will expire within the threshold)
+     */
+    isExpiredIn(threshold = 0, unit = 'minutes') {
+        if (!this.expires) {
+            return false;
+        }
+        const msTillExpire = this.expires.getTime() - Date.now();
+        const msInUnit = {
+            minutes: 60000,
+            seconds: 1000,
+            hours: 3600000,
+        }[unit];
+        return msTillExpire <= threshold * msInUnit;
     }
     isExpired() {
-        return new Date(this.created).getMilliseconds() < new Date().getMilliseconds() - this.expiresIn;
+        return this.isExpiredIn();
+    }
+    getJWTPayload(token) {
+        const parts = token.split('.');
+        if (parts.length < 2) {
+            throw new Error('Invalid token, missing payload');
+        }
+        else if (parts.length > 3) {
+            throw new Error('Invalid token, too many parts');
+        }
+        const [header, payload] = parts.slice(0, 2).map((part) => {
+            return JSON.parse(this.decodeBase64(part));
+        });
+        if (typeof payload !== 'object') {
+            throw new Error('Invalid token, payload must be an object');
+        }
+        if (typeof header !== 'object') {
+            throw new Error('Invalid token, header must be an object');
+        }
+        if (!('typ' in header) || header.typ !== 'JWT') {
+            throw new Error('Invalid token, must be a JWT');
+        }
+        return payload;
+    }
+    /** Decode a base64 string.
+     *
+     * Supports both Node.js and browser environments.
+     * @private
+     */
+    decodeBase64(base64String) {
+        if (isNode) {
+            return Buffer.from(base64String, 'base64').toString('utf-8');
+        }
+        return atob(base64String);
     }
 }
-exports.Token = Token;

package/models/Token.spec.d.ts

@@ -0,0 +1 @@
+export {};