ts2workflows 0.11.0 → 0.12.0

package/language_reference.md

@@ -85,7 +85,7 @@ sys.get_env('GOOGLE_CLOUD_PROJECT_ID')
 | !=, !==      | not equal to (both mean strict equality)           |
 | <, >, <=, >= | inequality comparisons                             |
 | &&, \|\|, !  | logical and, or, not                               |
-| in           | check if a property is present in an object        |
+| in           | check if a key is present in a map or array        |
 | ??           | nullish coalescing                                 |
 | ?.           | optional chaining                                  |
 | ? :          | conditional operator                               |
@@ -129,7 +129,7 @@ ${default(x, "default value")}
 
 ### Optional chaining
 
-ts2workflows converte the Typescript optional chaining expression
+ts2workflows converts the Typescript optional chaining expression
 
 ```javascript
 data.user?.name
@@ -141,6 +141,12 @@ to a [map.get() expression](https://cloud.google.com/workflows/docs/reference/st
 ${map.get(data, ["user", "name"])}
 ```
 
+### in operator
+
+The `in` operator checks if a key is present in a map or if a value is present in a list.
+
+⚠️ The `in` operator applied to a list behaves differently on Workflows than on Typescript. The Workflows `in` operator checks if a value is present in the list, whereas on Typescript `in` checks for the presence of a _property_ on the array object. In particular, the following evaluates to `true` on Workflows (but `false` on Typescript): `"x" in ["x", "y"]`.
+
 ### typeof operator
 
 Returns the type of the operand as a string. The return values are the same ones that Javascript typeof operation returns. The following table shows the possible values for different operand types.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts2workflows",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Transpile Typescript code to GCP Workflows programs",
   "homepage": "https://github.com/aajanki/ts2workflows",
   "repository": {
@@ -20,7 +20,7 @@
     "lint": "eslint src test scripts",
     "format": "prettier . --write",
     "test": "mocha",
-    "test-coverage": "nyc mocha",
+    "test-coverage": "nyc --reporter=text --reporter=html mocha",
     "prepare": "husky && npm run build"
   },
   "lint-staged": {
@@ -60,13 +60,14 @@
   ],
   "devDependencies": {
     "@eslint/js": "^9.10.0",
+    "@istanbuljs/nyc-config-typescript": "^1.0.2",
     "@types/chai": "^5.0.1",
     "@types/mocha": "^10.0.6",
     "@types/node": "^20",
-    "@types/ramda": "^0.30.2",
+    "@types/ramda": "^0.31.0",
     "@typescript-eslint/eslint-plugin": "^8.0.0",
     "@typescript-eslint/parser": "^8.0.0",
-    "chai": "^5.1.1",
+    "chai": "^6.0.1",
     "eslint": "^9.10.0",
     "husky": "^9.1.6",
     "lint-staged": "^16.1.2",
@@ -74,14 +75,15 @@
     "nyc": "^17.1.0",
     "prettier": "^3.2.5",
     "rimraf": "^6.0.1",
-    "tsx": "~4.19.4",
+    "source-map-support": "^0.5.21",
+    "tsx": "^4.20.5",
     "typescript-eslint": "^8.0.0"
   },
   "dependencies": {
     "@typescript-eslint/typescript-estree": "^8.0.0",
     "commander": "^14.0.0",
     "ramda": "^0.31.3",
-    "typescript": "^5.4.0",
+    "typescript": "^5.5.4",
     "yaml": "^2.4.2"
   }
 }

package/dist/ast/stepnames.d.ts

@@ -1,9 +0,0 @@
-import { WorkflowAST } from './steps.js';
-import { WorkflowApp } from './workflows.js';
-export declare class StepNameGenerator {
-    private counters;
-    constructor();
-    generate(prefix: string): string;
-}
-export declare function generateStepNames(ast: WorkflowAST): WorkflowApp;
-//# sourceMappingURL=stepnames.d.ts.map

package/dist/ast/stepnames.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"stepnames.d.ts","sourceRoot":"","sources":["../../src/ast/stepnames.ts"],"names":[],"mappings":"AAAA,OAAO,EAUL,WAAW,EAGZ,MAAM,YAAY,CAAA;AACnB,OAAO,EAAe,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAQzD,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,QAAQ,CAAqB;;IAMrC,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;CAMjC;AAED,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,WAAW,GAAG,WAAW,CAS/D"}

package/dist/ast/stepnames.js

@@ -1,280 +0,0 @@
-import { ForStepASTNamed, NextStepAST, ParallelStepASTNamed, StepsStepASTNamed, SwitchStepASTNamed, TryStepASTNamed, nestedSteps, } from './steps.js';
-import { Subworkflow, WorkflowApp } from './workflows.js';
-export class StepNameGenerator {
-    counters;
-    constructor() {
-        this.counters = new Map();
-    }
-    generate(prefix) {
-        const i = this.counters.get(prefix) ?? 1;
-        this.counters.set(prefix, i + 1);
-        return `${prefix}${i}`;
-    }
-}
-export function generateStepNames(ast) {
-    const subworkflows = ast.subworkflows
-        .map((subworkflow) => {
-        const stepNameGenerator = new StepNameGenerator();
-        return subworkflow.withStepNames((x) => stepNameGenerator.generate(x));
-    })
-        .map(fixJumpLabels);
-    return new WorkflowApp(subworkflows);
-}
-function fixJumpLabels(subworkflow) {
-    const jumpTargetLabels = collectActualJumpTargets(subworkflow);
-    const stepsWithoutJumpTargetNodes = removeJumpTargetSteps(subworkflow.steps);
-    const relabeledSteps = relabelNextLabels(stepsWithoutJumpTargetNodes, jumpTargetLabels);
-    return new Subworkflow(subworkflow.name, relabeledSteps, subworkflow.params);
-}
-/**
- * Find a mapping from jump target labels to step names.
- *
- * Iterate over all steps in the workflow. For JumpTargetAST nodes, find the
- * next node that is not a JumpTargetAST, save its name as the real jump taget
- * name.
- */
-function collectActualJumpTargets(subworkflow) {
-    const replacements = new Map();
-    // The processing is done iteratively with an explicit stack because
-    // nextNonJumpTargetNode() needs the stack. Note the order of steps on the
-    // stack: the first step is the last element of the stack.
-    const stack = [];
-    stack.push(...stepsToJumpStackElements(subworkflow.steps, 0));
-    while (stack.length > 0) {
-        // Do not yet pop in case nextNonJumpTargetNode needs to search the stack
-        const { namedStep, nestingLevel } = stack[stack.length - 1];
-        if (namedStep.step.tag === 'jumptarget') {
-            const currentLabel = namedStep.step.label;
-            const target = nextNonJumpTargetNode(stack);
-            const targetName = target ? target.name : 'end';
-            replacements.set(currentLabel, targetName);
-        }
-        // Now nextNonJumpTargetNode has been executed and it's safe to pop the
-        // current element from the stack.
-        stack.pop();
-        const children = nestedSteps(namedStep.step).map((x) => stepsToJumpStackElements(x, nestingLevel + 1));
-        children.reverse();
-        children.forEach((children) => {
-            stack.push(...children);
-        });
-    }
-    return replacements;
-}
-function stepsToJumpStackElements(steps, nestingLevel) {
-    const block = steps.map((step, i) => ({
-        namedStep: step,
-        nestingLevel,
-        isLastInBlock: i === steps.length - 1,
-    }));
-    block.reverse();
-    return block;
-}
-function nextNonJumpTargetNode(stack) {
-    if (stack.length <= 0) {
-        return undefined;
-    }
-    let nestingLevel = stack[stack.length - 1].nestingLevel;
-    while (nestingLevel >= 0) {
-        // Consider only the steps in the current code block (= the same nesting
-        // level, taking steps until isLastInBlock)
-        let endOfBlockIndex = stack.findLastIndex((x) => x.nestingLevel === nestingLevel && x.isLastInBlock);
-        if (endOfBlockIndex < 0) {
-            // should not be reached
-            endOfBlockIndex = stack.findLastIndex((x) => x.nestingLevel <= nestingLevel);
-            if (endOfBlockIndex < 0) {
-                endOfBlockIndex = 0;
-            }
-        }
-        const firstNonJumpTarget = stack
-            .slice(endOfBlockIndex)
-            .findLast((x) => x.nestingLevel === nestingLevel &&
-            x.namedStep.step.tag !== 'jumptarget');
-        if (firstNonJumpTarget) {
-            return firstNonJumpTarget.namedStep;
-        }
-        nestingLevel--;
-    }
-    return undefined;
-}
-function removeJumpTargetSteps(steps) {
-    return steps
-        .filter((x) => x.step.tag !== 'jumptarget')
-        .map(({ name, step }) => ({
-        name,
-        step: removeJumpTargetRecurse(step),
-    }));
-}
-function removeJumpTargetRecurse(step) {
-    switch (step.tag) {
-        case 'assign':
-        case 'call':
-        case 'next':
-        case 'raise':
-        case 'return':
-        case 'jumptarget':
-            return step;
-        case 'for':
-            return removeJumpTargetsFor(step);
-        case 'parallel':
-            return removeJumpTargetsParallel(step);
-        case 'steps':
-            return new StepsStepASTNamed(removeJumpTargetSteps(step.steps));
-        case 'switch':
-            return removeJumpTargetsSwitch(step);
-        case 'try':
-            return new TryStepASTNamed(removeJumpTargetSteps(step.trySteps), step.exceptSteps !== undefined
-                ? removeJumpTargetSteps(step.exceptSteps)
-                : undefined, step.retryPolicy, step.errorMap);
-    }
-}
-function removeJumpTargetsFor(step) {
-    return new ForStepASTNamed(removeJumpTargetSteps(step.steps), step.loopVariableName, step.listExpression, step.indexVariableName, step.rangeStart, step.rangeEnd);
-}
-function removeJumpTargetsParallel(step) {
-    let transformedSteps;
-    if (step.branches) {
-        transformedSteps = Object.fromEntries(step.branches.map((x) => {
-            return [
-                x.name,
-                new StepsStepASTNamed(removeJumpTargetSteps(nestedSteps(x.step).flat())),
-            ];
-        }));
-    }
-    else if (step.forStep) {
-        transformedSteps = removeJumpTargetsFor(step.forStep);
-    }
-    else {
-        // should not be reached
-        transformedSteps = {};
-    }
-    return new ParallelStepASTNamed(transformedSteps, step.shared, step.concurrenceLimit, step.exceptionPolicy);
-}
-function removeJumpTargetsSwitch(step) {
-    const transformedConditions = step.branches.map((cond) => {
-        return {
-            condition: cond.condition,
-            steps: removeJumpTargetSteps(cond.steps),
-            next: cond.next,
-        };
-    });
-    return new SwitchStepASTNamed(transformedConditions, step.next);
-}
-function relabelNextLabels(steps, replacements) {
-    return steps.map((step) => ({
-        name: step.name,
-        step: renameJumpTargets(step.step, replacements),
-    }));
-}
-/**
- * Renames a copy of a step with jump targets renamed according to replaceLabels map.
- */
-function renameJumpTargets(step, replaceLabels) {
-    switch (step.tag) {
-        case 'call':
-        case 'raise':
-        case 'return':
-        case 'jumptarget':
-            return step;
-        case 'assign':
-            return renameJumpTargetsAssign(step, replaceLabels);
-        case 'next':
-            return renameJumpTargetsNext(step, replaceLabels);
-        case 'for':
-            return renameJumpTargetsFor(step, replaceLabels);
-        case 'parallel':
-            return renameJumpTargetsParallel(step, replaceLabels);
-        case 'steps':
-            return renameJumpTargetsSteps(step, replaceLabels);
-        case 'switch':
-            return renameJumpTargetsSwitch(step, replaceLabels);
-        case 'try':
-            return renameJumpTargetsTry(step, replaceLabels);
-    }
-}
-function renameJumpTargetsAssign(step, replaceLabels) {
-    if (step.next) {
-        const newLabel = replaceLabels.get(step.next);
-        if (newLabel) {
-            return step.withNext(newLabel);
-        }
-    }
-    return step;
-}
-function renameJumpTargetsFor(step, replaceLabels) {
-    const transformedSteps = step.steps.map(({ name, step: nested }) => ({
-        name,
-        step: renameJumpTargets(nested, replaceLabels),
-    }));
-    return new ForStepASTNamed(transformedSteps, step.loopVariableName, step.listExpression, step.indexVariableName, step.rangeStart, step.rangeEnd);
-}
-function renameJumpTargetsNext(step, replaceLabels) {
-    const newLabel = replaceLabels.get(step.target);
-    if (newLabel) {
-        return new NextStepAST(newLabel);
-    }
-    else {
-        return step;
-    }
-}
-function renameJumpTargetsParallel(step, replaceLabels) {
-    let transformedSteps;
-    if (step.branches) {
-        transformedSteps = Object.fromEntries(step.branches.map(({ name, step: nested }) => {
-            const renamedNested = nestedSteps(nested)
-                .flat()
-                .map((x) => ({
-                name: x.name,
-                step: renameJumpTargets(x.step, replaceLabels),
-            }));
-            return [name, new StepsStepASTNamed(renamedNested)];
-        }));
-    }
-    else if (step.forStep) {
-        transformedSteps = renameJumpTargetsFor(step.forStep, replaceLabels);
-    }
-    else {
-        // should not be reached
-        transformedSteps = {};
-    }
-    return new ParallelStepASTNamed(transformedSteps, step.shared, step.concurrenceLimit, step.exceptionPolicy);
-}
-function renameJumpTargetsSteps(step, replaceLabels) {
-    const transformedSteps = step.steps.map(({ name, step: nested }) => ({
-        name,
-        step: renameJumpTargets(nested, replaceLabels),
-    }));
-    return new StepsStepASTNamed(transformedSteps);
-}
-function renameJumpTargetsSwitch(step, replaceLabels) {
-    let updatedNext = undefined;
-    if (step.next) {
-        updatedNext = replaceLabels.get(step.next) ?? step.next;
-    }
-    const updatedConditions = step.branches.map((cond) => {
-        let updatedCondNext = undefined;
-        if (cond.next) {
-            updatedCondNext = replaceLabels.get(cond.next) ?? cond.next;
-        }
-        const updatedCondSteps = cond.steps.map((nested) => ({
-            name: nested.name,
-            step: renameJumpTargets(nested.step, replaceLabels),
-        }));
-        return {
-            condition: cond.condition,
-            steps: updatedCondSteps,
-            next: updatedCondNext,
-        };
-    });
-    return new SwitchStepASTNamed(updatedConditions, updatedNext);
-}
-function renameJumpTargetsTry(step, replaceLabels) {
-    const transformedTrySteps = step.trySteps.map(({ name, step: nested }) => ({
-        name,
-        step: renameJumpTargets(nested, replaceLabels),
-    }));
-    const transformedExceptSteps = step.exceptSteps?.map(({ name, step: nested }) => ({
-        name,
-        step: renameJumpTargets(nested, replaceLabels),
-    }));
-    return new TryStepASTNamed(transformedTrySteps, transformedExceptSteps, step.retryPolicy, step.errorMap);
-}

package/dist/transpiler/expressions.d.ts

@@ -1,11 +0,0 @@
-import { TSESTree } from '@typescript-eslint/typescript-estree';
-import { Expression, MemberExpression, Primitive, VariableReferenceExpression } from '../ast/expressions.js';
-export declare function convertExpression(instance: TSESTree.Expression): Expression;
-export declare function convertObjectExpression(node: TSESTree.ObjectExpression): Record<string, Primitive | Expression>;
-export declare function convertObjectAsExpressionValues(node: TSESTree.ObjectExpression): Record<string, Expression>;
-export declare function convertMemberExpression(node: TSESTree.MemberExpression): Expression;
-export declare function isIntrinsic(calleeName: string): boolean;
-export declare function isIntrinsicStatment(calleeName: string): boolean;
-export declare function throwIfSpread<T extends TSESTree.Expression | TSESTree.Property | TSESTree.SpreadElement | null>(nodes: T[]): Exclude<T, TSESTree.SpreadElement>[];
-export declare function convertVariableNameExpression(instance: TSESTree.Expression): VariableReferenceExpression | MemberExpression;
-//# sourceMappingURL=expressions.d.ts.map

package/dist/transpiler/expressions.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"expressions.d.ts","sourceRoot":"","sources":["../../src/transpiler/expressions.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAkB,MAAM,sCAAsC,CAAA;AAC/E,OAAO,EAGL,UAAU,EAEV,gBAAgB,EAChB,SAAS,EAGT,2BAA2B,EAI5B,MAAM,uBAAuB,CAAA;AAG9B,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,CAAC,UAAU,GAAG,UAAU,CAiE3E;AAcD,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,QAAQ,CAAC,gBAAgB,GAC9B,MAAM,CAAC,MAAM,EAAE,SAAS,GAAG,UAAU,CAAC,CAgCxC;AAED,wBAAgB,+BAA+B,CAC7C,IAAI,EAAE,QAAQ,CAAC,gBAAgB,GAC9B,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAG5B;AAwJD,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,QAAQ,CAAC,gBAAgB,GAC9B,UAAU,CAcZ;AA0JD,wBAAgB,WAAW,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAGvD;AAED,wBAAgB,mBAAmB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAG/D;AAoDD,wBAAgB,aAAa,CAC3B,CAAC,SACG,QAAQ,CAAC,UAAU,GACnB,QAAQ,CAAC,QAAQ,GACjB,QAAQ,CAAC,aAAa,GACtB,IAAI,EACR,KAAK,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC,EAAE,QAAQ,CAAC,aAAa,CAAC,EAAE,CAgBlD;AAED,wBAAgB,6BAA6B,CAC3C,QAAQ,EAAE,QAAQ,CAAC,UAAU,GAC5B,2BAA2B,GAAG,gBAAgB,CAchD"}

package/dist/transpiler/statements.d.ts

@@ -1,10 +0,0 @@
-import { TSESTree } from '@typescript-eslint/typescript-estree';
-import { StepName, WorkflowStepAST } from '../ast/steps.js';
-export interface ParsingContext {
-    readonly breakTarget?: StepName;
-    readonly continueTarget?: StepName;
-    readonly parallelNestingLevel?: number;
-    finalizerTargets?: StepName[];
-}
-export declare function parseStatement(node: TSESTree.Statement, ctx: ParsingContext): WorkflowStepAST[];
-//# sourceMappingURL=statements.d.ts.map

package/dist/transpiler/statements.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"statements.d.ts","sourceRoot":"","sources":["../../src/transpiler/statements.ts"],"names":[],"mappings":"AACA,OAAO,EAAkB,QAAQ,EAAE,MAAM,sCAAsC,CAAA;AAC/E,OAAO,EAWL,QAAQ,EAOR,eAAe,EAChB,MAAM,iBAAiB,CAAA;AAkCxB,MAAM,WAAW,cAAc;IAE7B,QAAQ,CAAC,WAAW,CAAC,EAAE,QAAQ,CAAA;IAE/B,QAAQ,CAAC,cAAc,CAAC,EAAE,QAAQ,CAAA;IAGlC,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAA;IAKtC,gBAAgB,CAAC,EAAE,QAAQ,EAAE,CAAA;CAC9B;AAED,wBAAgB,cAAc,CAC5B,IAAI,EAAE,QAAQ,CAAC,SAAS,EACxB,GAAG,EAAE,cAAc,GAClB,eAAe,EAAE,CA6EnB"}