@dronedeploy/rocos-js-sdk 3.0.10 → 3.0.11

package/esm/helpers/kscript/kscript.js

@@ -1,30 +1,39 @@
 import Context from './Context';
-import { parse } from 'acorn';
+import { parse as acorn } from 'acorn';
 import { construct } from './utils';
-export function execute(code, scope, options) {
-    return compile(code, scope, options).run();
-}
-export function compile(code, scope, options) {
-    let program;
+const parse = (code) => {
     try {
         // we add the brackets to ensure that object literals are parsed correctly
-        program = parse(`(${code})`, { ecmaVersion: 2020, sourceType: 'script' });
+        // e.g. `{ a: 1 }` is not a valid statement, but `({ a: 1 })` is
+        return acorn(`(${code})`, { ecmaVersion: 2020, sourceType: 'script' });
     }
     catch (error) {
         if (error instanceof SyntaxError) {
             // fallback to non-wrapped code for edge cases where the brackets cause issues
-            program = parse(`${code}`, { ecmaVersion: 2020, sourceType: 'script' });
-        }
-        else {
-            throw error;
+            // e.g. `if (a) 2; else 4;` will throw a syntax error if wrapped in brackets
+            return acorn(`${code}`, { ecmaVersion: 2020, sourceType: 'script' });
         }
+        throw error;
     }
+};
+export const compile = (code, scope, options) => {
+    const program = parse(code);
     const context = new Context(scope ?? SAFE_GLOBALS, {
         prototypeWhitelist: SAFE_PROTOTYPES,
         ...options,
     });
     return construct(program, context);
-}
+};
+/** Throws an error if the code uses an invalid node.
+ *
+ * This does not check that the code will run without errors, only that the nodes used are allowed.
+ **/
+export const validate = (code, options) => {
+    compile(code, undefined, options).validate(true);
+};
+export const execute = (code, scope, options) => {
+    return compile(code, scope, options).run();
+};
 export const SAFE_GLOBALS = new Map(Object.entries({
     console: {
         debug: console.debug,

package/esm/helpers/kscript/nodes/Identifier.d.ts

@@ -8,5 +8,6 @@ import Node from './Node';
  */
 export default class IdentifierNode extends Node<Identifier> {
     constructor(node: AnyNode, context: Context);
+    validate(): void;
     run(): unknown;
 }

package/esm/helpers/kscript/nodes/Identifier.js

@@ -8,6 +8,7 @@ export default class IdentifierNode extends Node {
     constructor(node, context) {
         super(node, context, 'Identifier');
     }
+    validate() { }
     run() {
         return this.scope.get(this.node.name);
     }

package/esm/helpers/kscript/nodes/Literal.d.ts

@@ -7,5 +7,6 @@ import Node from './Node';
  */
 export default class LiteralNode extends Node<Literal> {
     constructor(node: AnyNode, context: Context);
+    validate(): void;
     run(): unknown;
 }

package/esm/helpers/kscript/nodes/Literal.js

@@ -7,10 +7,13 @@ export default class LiteralNode extends Node {
     constructor(node, context) {
         super(node, context, 'Literal');
     }
-    run() {
+    validate() {
         if (this.node.bigint) {
             throw new Error('BigInts are not supported');
         }
+    }
+    run() {
+        this.validate();
         return this.node.value;
     }
 }

package/esm/helpers/kscript/nodes/Node.d.ts

@@ -5,5 +5,11 @@ export default abstract class Node<T extends AnyNode = AnyNode> {
     protected node: T;
     protected scope: Context['scope'];
     protected constructor(node: AnyNode, context: Context, expectedType: T['type'] | T['type'][]);
+    /** Runs the node. */
     abstract run(): unknown;
+    /** Validates the node. If the node is invalid, an error is thrown.
+     *
+     * if `validateChildren` is true, the children of the node will also be validated.
+     */
+    abstract validate(validateChildren: boolean): void;
 }

package/esm/helpers/kscript/nodes/Program.d.ts

@@ -7,5 +7,6 @@ import Node from './Node';
  */
 export default class ProgramNode extends Node<Program> {
     constructor(node: AnyNode, scope: Context);
+    validate(validateChildren?: boolean): void;
     run(): unknown;
 }

package/esm/helpers/kscript/nodes/Program.js

@@ -8,11 +8,17 @@ export default class ProgramNode extends Node {
     constructor(node, scope) {
         super(node, scope, 'Program');
     }
-    run() {
-        const children = this.node.body;
-        if (children.length !== 1) {
+    validate(validateChildren = false) {
+        if (this.node.body.length !== 1) {
             throw new Error('Only a single statement is supported in the sandbox');
         }
-        return construct(children[0], this.context).run();
+        if (!validateChildren) {
+            return;
+        }
+        construct(this.node.body[0], this.context).validate(true);
+    }
+    run() {
+        this.validate();
+        return construct(this.node.body[0], this.context).run();
     }
 }

package/esm/helpers/kscript/nodes/TemplateLiteral.d.ts

@@ -19,5 +19,6 @@ import Node from './Node';
  */
 export default class TemplateLiteralNode extends Node<TemplateLiteral> {
     constructor(node: AnyNode, scope: Context);
+    validate(validateChildren?: boolean): void;
     run(): unknown;
 }

package/esm/helpers/kscript/nodes/TemplateLiteral.js

@@ -20,6 +20,14 @@ export default class TemplateLiteralNode extends Node {
     constructor(node, scope) {
         super(node, scope, 'TemplateLiteral');
     }
+    validate(validateChildren = false) {
+        if (!validateChildren) {
+            return;
+        }
+        for (const expression of this.node.expressions) {
+            construct(expression, this.context).validate(true);
+        }
+    }
     run() {
         return this.node.quasis.reduce((acc, quasi, i) => {
             const expression = this.node.expressions[i] ? construct(this.node.expressions[i], this.context).run() : '';

package/esm/helpers/kscript/nodes/expressions/ArrayExpression.d.ts

@@ -3,5 +3,6 @@ import type Context from '../../Context';
 import Node from '../Node';
 export default class ArrayExpressionNode extends Node<ArrayExpression> {
     constructor(node: AnyNode, context: Context);
+    validate(validateChildren?: boolean): void;
     run(): unknown;
 }

package/esm/helpers/kscript/nodes/expressions/ArrayExpression.js

@@ -4,6 +4,17 @@ export default class ArrayExpressionNode extends Node {
     constructor(node, context) {
         super(node, context, 'ArrayExpression');
     }
+    validate(validateChildren = false) {
+        if (!validateChildren) {
+            return;
+        }
+        for (const element of this.node.elements) {
+            if (element === null) {
+                continue;
+            }
+            construct(element, this.context).validate(true);
+        }
+    }
     run() {
         const array = [];
         for (const element of this.node.elements) {

package/esm/helpers/kscript/nodes/expressions/ArrowFunctionExpression.d.ts

@@ -10,5 +10,6 @@ import Node from '../Node';
 export default class ArrowFunctionExpressionNode extends Node<ArrowFunctionExpression> {
     private readonly params;
     constructor(node: AnyNode, context: Context);
+    validate(validateChildren?: boolean): void;
     run(): unknown;
 }

package/esm/helpers/kscript/nodes/expressions/ArrowFunctionExpression.js

@@ -14,13 +14,20 @@ export default class ArrowFunctionExpressionNode extends Node {
         }
         this.params = this.node.params;
     }
-    run() {
+    validate(validateChildren = false) {
         if (!this.context.isFunctionCallAllowed)
             throw new Error('functions are not allowed');
         if (!this.node.expression)
             throw new Error('functions must be an expression');
         if (this.node.async)
             throw new Error('async functions are not supported');
+        if (!validateChildren) {
+            return;
+        }
+        construct(this.node.body, this.context).validate(true);
+    }
+    run() {
+        this.validate();
         return (...args) => {
             const scope = new Map();
             for (const param of this.params) {

package/esm/helpers/kscript/nodes/expressions/BinaryExpression.d.ts

@@ -6,7 +6,13 @@ import Node from '../Node';
  * e.g. `1 + 2`, `a === b`, `c < d`
  */
 export default class BinaryExpressionNode extends Node<BinaryExpression> {
+    private static readonly EQUALITY_OPERATORS;
+    private static readonly COMPARISON_OPERATORS;
+    private static readonly ARITHMETIC_OPERATORS;
+    private static readonly IN_OPERATOR;
+    private static readonly SUPPORTED_OPERATORS;
     constructor(node: AnyNode, context: Context);
+    validate(validateChildren?: boolean): void;
     run(): unknown;
     private operate;
     private arithmetic;

package/esm/helpers/kscript/nodes/expressions/BinaryExpression.js

@@ -4,39 +4,39 @@ import { construct } from '../../utils';
  *
  * e.g. `1 + 2`, `a === b`, `c < d`
  */
-export default class BinaryExpressionNode extends Node {
+class BinaryExpressionNode extends Node {
     constructor(node, context) {
         super(node, context, 'BinaryExpression');
     }
+    validate(validateChildren = false) {
+        if (!BinaryExpressionNode.SUPPORTED_OPERATORS.has(this.node.operator)) {
+            throw new Error(`Unsupported operator: ${this.node.operator}`);
+        }
+        if (!validateChildren) {
+            return;
+        }
+        construct(this.node.left, this.context).validate(true);
+        construct(this.node.right, this.context).validate(true);
+    }
     run() {
         const left = construct(this.node.left, this.context).run();
         const right = construct(this.node.right, this.context).run();
         return this.operate(left, right);
     }
     operate(left, right) {
-        switch (this.node.operator) {
-            case '==':
-            case '!=':
-            case '===':
-            case '!==':
-                return this.equality(this.node.operator, left, right);
-            case '<':
-            case '<=':
-            case '>':
-            case '>=':
-                return this.comparison(this.node.operator, left, right);
-            case 'in':
-                return this.checkIn(left, right);
-            case '**':
-            case '+':
-            case '-':
-            case '*':
-            case '/':
-            case '%':
-                return this.arithmetic(this.node.operator, left, right);
-            default:
-                throw new Error(`Unsupported operator: ${this.node.operator}`);
+        if (BinaryExpressionNode.EQUALITY_OPERATORS.has(this.node.operator)) {
+            return this.equality(this.node.operator, left, right);
+        }
+        if (BinaryExpressionNode.COMPARISON_OPERATORS.has(this.node.operator)) {
+            return this.comparison(this.node.operator, left, right);
+        }
+        if (BinaryExpressionNode.ARITHMETIC_OPERATORS.has(this.node.operator)) {
+            return this.arithmetic(this.node.operator, left, right);
+        }
+        if (this.node.operator === BinaryExpressionNode.IN_OPERATOR) {
+            return this.checkIn(left, right);
         }
+        throw new Error(`Unsupported operator: ${this.node.operator}`);
     }
     arithmetic(operator, left, right) {
         if (operator === '+' && (typeof left === 'string' || typeof right === 'string')) {
@@ -96,3 +96,21 @@ export default class BinaryExpressionNode extends Node {
         return right.includes(left);
     }
 }
+BinaryExpressionNode.EQUALITY_OPERATORS = new Set(['==', '!=', '===', '!==']);
+BinaryExpressionNode.COMPARISON_OPERATORS = new Set(['<', '<=', '>', '>=']);
+BinaryExpressionNode.ARITHMETIC_OPERATORS = new Set([
+    '+',
+    '-',
+    '*',
+    '/',
+    '%',
+    '**',
+]);
+BinaryExpressionNode.IN_OPERATOR = 'in';
+BinaryExpressionNode.SUPPORTED_OPERATORS = new Set([
+    ...BinaryExpressionNode.EQUALITY_OPERATORS,
+    ...BinaryExpressionNode.COMPARISON_OPERATORS,
+    ...BinaryExpressionNode.ARITHMETIC_OPERATORS,
+    BinaryExpressionNode.IN_OPERATOR,
+]);
+export default BinaryExpressionNode;

package/esm/helpers/kscript/nodes/expressions/CallExpression.d.ts

@@ -3,6 +3,7 @@ import Context from '../../Context';
 import Node from '../Node';
 export default class CallExpressionNode extends Node<CallExpression> {
     constructor(node: AnyNode, context: Context);
+    validate(validateChildren?: boolean): void;
     run(): unknown;
     private spreadArgs;
 }

package/esm/helpers/kscript/nodes/expressions/CallExpression.js

@@ -4,9 +4,19 @@ export default class CallExpressionNode extends Node {
     constructor(node, context) {
         super(node, context, 'CallExpression');
     }
-    run() {
+    validate(validateChildren = false) {
         if (!this.context.isFunctionCallAllowed)
             throw new Error('Function calls are not allowed');
+        if (!validateChildren) {
+            return;
+        }
+        construct(this.node.callee, this.context).validate(true);
+        for (const arg of this.node.arguments) {
+            construct(arg, this.context).validate(true);
+        }
+    }
+    run() {
+        this.validate();
         const callee = construct(this.node.callee, this.context).run();
         let thisArg = {};
         if (this.node.callee.type === 'MemberExpression') {

package/esm/helpers/kscript/nodes/expressions/ChainExpression.d.ts

@@ -12,5 +12,6 @@ import Node from '../Node';
  */
 export default class ExpressionStatementNode extends Node<ChainExpression> {
     constructor(node: AnyNode, context: Context);
+    validate(): void;
     run(): unknown;
 }

package/esm/helpers/kscript/nodes/expressions/ChainExpression.js

@@ -13,6 +13,7 @@ export default class ExpressionStatementNode extends Node {
     constructor(node, context) {
         super(node, context, 'ChainExpression');
     }
+    validate() { }
     run() {
         return construct(this.node.expression, this.context).run();
     }

package/esm/helpers/kscript/nodes/expressions/ConditionalExpression.d.ts

@@ -10,5 +10,6 @@ import Node from '../Node';
  */
 export default class ConditionalExpressionNode extends Node<IfStatement | ConditionalExpression> {
     constructor(node: AnyNode, context: Context);
+    validate(validateChildren: boolean): void;
     run(): unknown;
 }

package/esm/helpers/kscript/nodes/expressions/ConditionalExpression.js

@@ -11,6 +11,16 @@ export default class ConditionalExpressionNode extends Node {
     constructor(node, context) {
         super(node, context, ['ConditionalExpression', 'IfStatement']);
     }
+    validate(validateChildren) {
+        if (!validateChildren) {
+            return;
+        }
+        construct(this.node.test, this.context).validate(true);
+        construct(this.node.consequent, this.context).validate(true);
+        if (this.node.alternate !== null && this.node.alternate !== undefined) {
+            construct(this.node.alternate, this.context).validate(true);
+        }
+    }
     run() {
         const test = construct(this.node.test, this.context).run();
         if (test) {

package/esm/helpers/kscript/nodes/expressions/ExpressionStatement.d.ts

@@ -3,5 +3,6 @@ import Context from '../../Context';
 import Node from '../Node';
 export default class ExpressionStatementNode extends Node<ExpressionStatement> {
     constructor(node: AnyNode, context: Context);
+    validate(validateChildren?: boolean): void;
     run(): unknown;
 }

package/esm/helpers/kscript/nodes/expressions/ExpressionStatement.js

@@ -4,9 +4,16 @@ export default class ExpressionStatementNode extends Node {
     constructor(node, context) {
         super(node, context, 'ExpressionStatement');
     }
-    run() {
+    validate(validateChildren = false) {
         if (this.node.directive)
             throw new Error('Directives are not supported');
+        if (!validateChildren) {
+            return;
+        }
+        construct(this.node.expression, this.context).validate(true);
+    }
+    run() {
+        this.validate();
         return construct(this.node.expression, this.context).run();
     }
 }

package/esm/helpers/kscript/nodes/expressions/LogicalExpression.d.ts

@@ -2,7 +2,9 @@ import { AnyNode, LogicalExpression } from 'acorn';
 import Context from '../../Context';
 import Node from '../Node';
 export default class BinaryExpressionNode extends Node<LogicalExpression> {
+    private static readonly SUPPORTED_OPERATORS;
     constructor(node: AnyNode, context: Context);
+    validate(validateChildren: boolean): void;
     run(): unknown;
     /** Try and skip evaluating the right operand */
     private shortCircuit;

package/esm/helpers/kscript/nodes/expressions/LogicalExpression.js

@@ -1,9 +1,19 @@
 import Node from '../Node';
 import { construct } from '../../utils';
-export default class BinaryExpressionNode extends Node {
+class BinaryExpressionNode extends Node {
     constructor(node, context) {
         super(node, context, 'LogicalExpression');
     }
+    validate(validateChildren) {
+        if (!BinaryExpressionNode.SUPPORTED_OPERATORS.has(this.node.operator)) {
+            throw new Error(`Unsupported operator: ${this.node.operator}`);
+        }
+        if (!validateChildren) {
+            return;
+        }
+        construct(this.node.left, this.context).validate(true);
+        construct(this.node.right, this.context).validate(true);
+    }
     run() {
         const left = construct(this.node.left, this.context).run();
         const shortCircuit = this.shortCircuit(left);
@@ -39,3 +49,5 @@ export default class BinaryExpressionNode extends Node {
         }
     }
 }
+BinaryExpressionNode.SUPPORTED_OPERATORS = new Set(['||', '&&', '??']);
+export default BinaryExpressionNode;

package/esm/helpers/kscript/nodes/expressions/MemberExpression.d.ts

@@ -22,6 +22,7 @@ import Node from '../Node';
  */
 export default class MemberExpressionNode extends Node<MemberExpression> {
     constructor(node: AnyNode, context: Context);
+    validate(validateChildren?: boolean): void;
     run(): unknown;
     /** Returns the name of the property being accessed.
      *

package/esm/helpers/kscript/nodes/expressions/MemberExpression.js

@@ -23,6 +23,13 @@ export default class MemberExpressionNode extends Node {
     constructor(node, context) {
         super(node, context, 'MemberExpression');
     }
+    validate(validateChildren = false) {
+        if (!validateChildren) {
+            return;
+        }
+        construct(this.node.object, this.context).validate(true);
+        construct(this.node.property, this.context).validate(true);
+    }
     run() {
         const object = construct(this.node.object, this.context).run();
         if (object === null || object === undefined) {

package/esm/helpers/kscript/nodes/expressions/ObjectExpression.d.ts

@@ -3,6 +3,7 @@ import type Context from '../../Context';
 import Node from '../Node';
 export default class ObjectExpressionNode extends Node<ObjectExpression> {
     constructor(node: AnyNode, context: Context);
+    validate(validateChildren: boolean): void;
     run(): unknown;
     private addProperty;
     private spreadProperty;

package/esm/helpers/kscript/nodes/expressions/ObjectExpression.js

@@ -4,6 +4,35 @@ export default class ObjectExpressionNode extends Node {
     constructor(node, context) {
         super(node, context, 'ObjectExpression');
     }
+    validate(validateChildren) {
+        for (const property of this.node.properties) {
+            // SpreadElements do not need to be validated - they only have a single argument
+            if (property.type === 'SpreadElement') {
+                continue;
+            }
+            if (property.kind !== 'init') {
+                // do not support getters or setters
+                throw new Error('Only init properties are supported');
+            }
+            if (!property.computed) {
+                // ensure that the key is valid
+                this.getStaticKey(property.key);
+            }
+        }
+        if (!validateChildren) {
+            return;
+        }
+        for (const property of this.node.properties) {
+            if (property.type === 'SpreadElement') {
+                construct(property.argument, this.context).validate(true);
+                continue;
+            }
+            if (property.computed) {
+                construct(property.key, this.context).validate(true);
+            }
+            construct(property.value, this.context).validate(true);
+        }
+    }
     run() {
         const object = {};
         for (const property of this.node.properties) {

package/esm/helpers/kscript/nodes/expressions/UnaryExpression.d.ts

@@ -6,7 +6,9 @@ import Node from '../Node';
  * e.g. `+1`, `-2`, `!true`, `typeof x`
  */
 export default class UnaryExpressionNode extends Node<UnaryExpression> {
+    private static readonly SUPPORTED_OPERATORS;
     constructor(node: AnyNode, context: Context);
+    validate(validateChildren: boolean): void;
     run(): unknown;
     private arithmetic;
 }

package/esm/helpers/kscript/nodes/expressions/UnaryExpression.js

@@ -4,10 +4,18 @@ import { construct } from '../../utils';
  *
  * e.g. `+1`, `-2`, `!true`, `typeof x`
  */
-export default class UnaryExpressionNode extends Node {
+class UnaryExpressionNode extends Node {
     constructor(node, context) {
         super(node, context, 'UnaryExpression');
     }
+    validate(validateChildren) {
+        if (!UnaryExpressionNode.SUPPORTED_OPERATORS.has(this.node.operator)) {
+            throw new Error(`Unsupported operator: ${this.node.operator}`);
+        }
+        if (validateChildren) {
+            construct(this.node.argument, this.context).validate(true);
+        }
+    }
     run() {
         const argument = construct(this.node.argument, this.context).run();
         switch (this.node.operator) {
@@ -36,3 +44,5 @@ export default class UnaryExpressionNode extends Node {
         }
     }
 }
+UnaryExpressionNode.SUPPORTED_OPERATORS = new Set(['+', '-', '!', 'typeof']);
+export default UnaryExpressionNode;

package/esm/models/asset-storage/SyncIntegrations.d.ts

@@ -12,9 +12,9 @@ export interface AssetSyncDefinitionModel {
 export interface AssetSyncDefinitionOverrideModel extends AssetSyncDefinitionModel {
     _isOverridden: boolean;
 }
-export interface AssetSyncDefinitionsModel {
-    items: AssetSyncDefinitionModel[];
-    profileOverriddenItems?: AssetSyncDefinitionOverrideModel[];
+export interface AssetSyncDefinitionsModel<I extends AssetSyncDefinitionModel = AssetSyncDefinitionOverrideModel> {
+    items: I[];
+    profileOverriddenItems?: AssetSyncDefinitionModel[];
 }
 export interface AssetSyncIntegrationProviderModel {
     provider: string;

package/esm/services/AssetStorageService.d.ts

@@ -1,4 +1,4 @@
-import { AssetItemModel, AssetItemWithObservationsModel, AssetSyncDefinitionsModel, AssetSyncIntegrationModel, AssetSyncIntegrationProviderModel, CreateAssetSyncIntegrationModel, IBaseService, IRocosSDKConfig, RocosError } from '../models';
+import { AssetItemModel, AssetItemWithObservationsModel, AssetSyncDefinitionModel, AssetSyncDefinitionsModel, AssetSyncIntegrationModel, AssetSyncIntegrationProviderModel, CreateAssetSyncIntegrationModel, IBaseService, IRocosSDKConfig, RocosError } from '../models';
 import { BaseServiceAbstract } from './BaseServiceAbstract';
 export declare class AssetStorageService extends BaseServiceAbstract implements IBaseService {
     constructor(config: IRocosSDKConfig);
@@ -92,7 +92,7 @@ export declare class AssetStorageService extends BaseServiceAbstract implements
      * @param definition
      * @param syncNow - Sync configured paths immediately
      */
-    setRobotSyncDefinitions(projectId: string, callsign: string, definition: AssetSyncDefinitionsModel, syncNow?: boolean): Promise<AssetSyncDefinitionsModel>;
+    setRobotSyncDefinitions(projectId: string, callsign: string, definition: AssetSyncDefinitionsModel<AssetSyncDefinitionModel>, syncNow?: boolean): Promise<AssetSyncDefinitionsModel>;
     /**
      * Get Robot Sync Definitions
      * @param projectId
@@ -105,7 +105,7 @@ export declare class AssetStorageService extends BaseServiceAbstract implements
      * @param profileId
      * @param definition
      */
-    setProfileSyncDefinitions(projectId: string, profileId: string, definition: AssetSyncDefinitionsModel): Promise<AssetSyncDefinitionsModel>;
+    setProfileSyncDefinitions(projectId: string, profileId: string, definition: Omit<AssetSyncDefinitionsModel<AssetSyncDefinitionModel>, 'profileOverriddenItems'>): Promise<AssetSyncDefinitionsModel>;
     /**
      * Get Profile Sync Definitions
      * @param projectId

package/package.json

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