ts2workflows 0.14.0 → 0.15.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # ts2workflows changelog
 
+## Version 0.15.0 - 2026-03-18
+
+New features:
+
+- Static method `Array.includes(arr, x)` for checking if the array `arr` contain the value `x`
+
+Fixes:
+
+- Print the correct source code line on error messages
+- Type annotation fixes in workflowslib
+
 ## Version 0.14.0 - 2025-11-19
 
 Fixes:

package/README.md

@@ -85,7 +85,7 @@ npm run test
 Run tests and print the test coverage:
 
 ```sh
-npm run test-coverage
+npm run test:coverage
 ```
 
 ### Architecture

package/dist/cli.js

@@ -6,6 +6,7 @@ import { program } from 'commander';
 import { transpile, transpileText } from './transpiler/index.js';
 import { WorkflowSyntaxError } from './errors.js';
 import { TSError } from '@typescript-eslint/typescript-estree';
+import { prettifySyntaxError } from './diagnostics.js';
 function parseArgs() {
     program
         .name('ts2workflow')
@@ -37,19 +38,18 @@ function cliMain() {
         files = args.sourceFiles;
     }
     files.forEach((inputFile) => {
-        const input = readSourceCode(inputFile);
         try {
-            const transpiled = generateTranspiledText(input, args.generatedFileComment, args.link, args.project);
+            const transpiled = generateTranspiledText(inputFile, readSourceCode(inputFile), args.generatedFileComment, args.link, args.project);
             writeOutput(transpiled, inputFile, args.outdir);
         }
         catch (err) {
             if (isIoError(err)) {
                 let message;
-                if ('code' in err && err.code === 'EAGAIN' && inputFile === '-') {
+                if (err.code === 'EAGAIN' && inputFile === '-') {
                     // Reading from stdin if there's no input causes error. This is a bug in node
                     message = 'Error: Failed to read from stdin';
                 }
-                else if ('code' in err && err.code === 'EISDIR') {
+                else if (err.code === 'EISDIR') {
                     message = `Error: "${inputFile}" is a directory`;
                 }
                 else {
@@ -59,11 +59,11 @@ function cliMain() {
                 process.exit(1);
             }
             else if (err instanceof WorkflowSyntaxError) {
-                prettyPrintSyntaxError(err, input);
+                console.error(prettifySyntaxError(err));
                 process.exit(1);
             }
             else if (err instanceof TSError) {
-                prettyPrintSyntaxError(err, input);
+                console.error(prettifySyntaxError(err));
                 process.exit(1);
             }
             else {
@@ -72,31 +72,19 @@ function cliMain() {
         }
     });
 }
-function generateTranspiledText(input, addGeneratedFileComment, linkSubworkflows, project) {
-    if (input.filename === undefined) {
-        return transpileText(input.read());
+function generateTranspiledText(filename, sourceCode, addGeneratedFileComment, linkSubworkflows, project) {
+    if (filename === undefined) {
+        return transpileText(sourceCode);
     }
     else {
-        const header = addGeneratedFileComment
-            ? generatedFileComment(input.filename)
-            : '';
-        const transpiled = transpile(input, project, linkSubworkflows);
+        const header = addGeneratedFileComment ? generatedFileComment(filename) : '';
+        const transpiled = transpile(filename, sourceCode, project, linkSubworkflows);
         return `${header}${transpiled}`;
     }
 }
 function readSourceCode(filename) {
-    const readCode = crateMemorizedReader(filename === '-' ? process.stdin.fd : filename);
-    return {
-        filename: filename === '-' ? undefined : filename,
-        read: () => readCode(),
-    };
-}
-function crateMemorizedReader(filenameOrFd) {
-    let cached;
-    return () => {
-        cached ??= fs.readFileSync(filenameOrFd, 'utf8');
-        return cached;
-    };
+    const filenameOrFd = filename === '-' ? process.stdin.fd : filename;
+    return fs.readFileSync(filenameOrFd, 'utf8');
 }
 function writeOutput(transpiled, inputFile, outdir) {
     if (outdir !== undefined) {
@@ -119,58 +107,12 @@ function createOutputFilename(inputFile, outdir) {
     });
 }
 function generatedFileComment(inputFile) {
-    return (`# This file has been generated by "ts2workflows ${inputFile}"\n` +
+    return (`# This file has been generated by ts2workflows from source file ${inputFile}\n` +
         '# Do not edit!\n\n');
 }
 function isIoError(err) {
     return err instanceof Error && 'code' in err;
 }
-function prettyPrintSyntaxError(exception, inp) {
-    console.error(errorDisplay(inp, exception.location));
-    console.error(`${exception.message}`);
-}
-function errorDisplay(inp, location) {
-    const lines = [];
-    const prettyFilename = inp.filename ?? '<stdin>';
-    if (typeof location?.start === 'undefined' ||
-        typeof location?.end === 'undefined' ||
-        isNaN(location?.start.line) ||
-        isNaN(location?.end.line)) {
-        lines.push(`File ${prettyFilename}:`);
-    }
-    else {
-        lines.push(`File ${prettyFilename}, line ${location.start.line}, column ${location.start.column + 1}:`);
-    }
-    const highlightedLine = highlightedSourceCodeLine(inp.read(), location?.start?.line, location?.start?.column, location?.start?.line === location?.end?.line
-        ? location?.end?.column
-        : undefined);
-    if (highlightedLine.length > 0) {
-        lines.push(highlightedLine);
-        lines.push('');
-    }
-    return lines.join('\n');
-}
-function highlightedSourceCodeLine(sourceCode, lineNumber, start, end) {
-    if (typeof lineNumber === 'undefined' ||
-        typeof start === 'undefined' ||
-        isNaN(start)) {
-        return '';
-    }
-    const lines = sourceCode.split('\n');
-    const sourceLine = lines[lineNumber - 1];
-    if (typeof sourceLine === 'undefined') {
-        return '';
-    }
-    let markerLength;
-    if (typeof end === 'undefined') {
-        markerLength = sourceLine.length - start;
-    }
-    else {
-        markerLength = Math.min(end - start + 1, sourceLine.length - start);
-    }
-    const markerLine = `${' '.repeat(start)}${'^'.repeat(markerLength)}`;
-    return `${sourceLine}\n${markerLine}`;
-}
 function versionFromPackageJson() {
     const currentFile = fileURLToPath(import.meta.url);
     const currentDir = path.dirname(currentFile);

package/dist/diagnostics.d.ts

@@ -0,0 +1,3 @@
+import { WorkflowSyntaxError } from './errors.js';
+export declare function prettifySyntaxError(exception: WorkflowSyntaxError): string;
+//# sourceMappingURL=diagnostics.d.ts.map

package/dist/diagnostics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"diagnostics.d.ts","sourceRoot":"","sources":["../src/diagnostics.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,mBAAmB,EAEpB,MAAM,aAAa,CAAA;AAEpB,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,mBAAmB,GAAG,MAAM,CAc1E"}

package/dist/diagnostics.js

@@ -0,0 +1,46 @@
+import { WorkflowSyntaxErrorWithText, } from './errors.js';
+export function prettifySyntaxError(exception) {
+    const filename = exception instanceof WorkflowSyntaxErrorWithText
+        ? exception.filename
+        : '???';
+    const errorLineText = exception instanceof WorkflowSyntaxErrorWithText
+        ? exception.errorLine
+        : undefined;
+    return (`${errorLocator(filename, exception.location, errorLineText)}\n` +
+        `${exception.message}`);
+}
+function errorLocator(filename, location, errorLineText) {
+    const lines = [];
+    if (isNaN(location.start.line) || isNaN(location.end.line)) {
+        lines.push(`File ${filename}:`);
+    }
+    else {
+        lines.push(`File ${filename}, line ${location.start.line}, column ${location.start.column + 1}:`);
+    }
+    if (errorLineText) {
+        const highlightedLine = highlightedSourceCodeLine(errorLineText, location.start.column, location.start.line === location.end.line
+            ? location.end.column
+            : undefined);
+        if (highlightedLine.length > 0) {
+            lines.push(highlightedLine);
+            lines.push('');
+        }
+    }
+    return lines.join('\n');
+}
+function highlightedSourceCodeLine(errorLineText, start, end) {
+    if (isNaN(start) || start < 0) {
+        return '';
+    }
+    const sourceLine = errorLineText.split('\n')[0] ?? '';
+    let markerLength;
+    if (end === undefined || isNaN(end) || end < 0) {
+        markerLength = sourceLine.length - start;
+    }
+    else {
+        markerLength = Math.min(end - start + 1, sourceLine.length - start);
+    }
+    markerLength = Math.max(markerLength, 0);
+    const markerLine = `${' '.repeat(start)}${'^'.repeat(markerLength)}`;
+    return `${sourceLine}\n${markerLine}`;
+}

package/dist/errors.d.ts

@@ -9,9 +9,16 @@ export interface SourceCodeLocation {
     };
 }
 export declare class WorkflowSyntaxError extends Error {
-    location: SourceCodeLocation;
+    readonly location: SourceCodeLocation;
     constructor(message: string, location: SourceCodeLocation);
 }
+export declare class WorkflowSyntaxErrorWithText extends WorkflowSyntaxError {
+    readonly location: SourceCodeLocation;
+    readonly filename: string;
+    readonly errorLine: string;
+    constructor(message: string, location: SourceCodeLocation, filename: string, errorLine: string);
+}
+export declare function syntaxErrorWithText(error: WorkflowSyntaxError, filename: string, sourceCode: string): WorkflowSyntaxErrorWithText;
 export declare class InternalTranspilingError extends Error {
     constructor(message: string);
 }

package/dist/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAA;IACvC,GAAG,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAA;CACtC;AAID,qBAAa,mBAAoB,SAAQ,KAAK;IAC5C,QAAQ,EAAE,kBAAkB,CAAA;gBAEhB,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,kBAAkB;CAI1D;AAID,qBAAa,wBAAyB,SAAQ,KAAK;gBACrC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,OAAQ,SAAQ,KAAK;aAGd,IAAI,EAAE,MAAM;gBAD5B,OAAO,EAAE,MAAM,EACC,IAAI,EAAE,MAAM;CAI/B"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAA;IACvC,GAAG,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAA;CACtC;AAID,qBAAa,mBAAoB,SAAQ,KAAK;aAG1B,QAAQ,EAAE,kBAAkB;gBAD5C,OAAO,EAAE,MAAM,EACC,QAAQ,EAAE,kBAAkB;CAI/C;AAID,qBAAa,2BAA4B,SAAQ,mBAAmB;aAGhD,QAAQ,EAAE,kBAAkB;aAC5B,QAAQ,EAAE,MAAM;aAChB,SAAS,EAAE,MAAM;gBAHjC,OAAO,EAAE,MAAM,EACC,QAAQ,EAAE,kBAAkB,EAC5B,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM;CAIpC;AAED,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,mBAAmB,EAC1B,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,GACjB,2BAA2B,CAW7B;AAID,qBAAa,wBAAyB,SAAQ,KAAK;gBACrC,OAAO,EAAE,MAAM;CAG5B;AAGD,qBAAa,OAAQ,SAAQ,KAAK;aAGd,IAAI,EAAE,MAAM;gBAD5B,OAAO,EAAE,MAAM,EACC,IAAI,EAAE,MAAM;CAI/B"}

package/dist/errors.js

@@ -7,13 +7,33 @@ export class WorkflowSyntaxError extends Error {
         this.location = location;
     }
 }
+// WorkflowSyntaxError enriched with the source code filename and the text of
+// the line where the error occurred.
+export class WorkflowSyntaxErrorWithText extends WorkflowSyntaxError {
+    location;
+    filename;
+    errorLine;
+    constructor(message, location, filename, errorLine) {
+        super(message, location);
+        this.location = location;
+        this.filename = filename;
+        this.errorLine = errorLine;
+    }
+}
+export function syntaxErrorWithText(error, filename, sourceCode) {
+    const lineNumber = Math.max(error.location.start.line, 0);
+    const lines = sourceCode.split('\n');
+    const errorLine = lines[lineNumber - 1];
+    return new WorkflowSyntaxErrorWithText(error.message, error.location, filename, errorLine);
+}
 // InternalTranspilingError is thrown when ts2workflow ends up in an unexpected state.
-// The error is in ts2workflow.
+// This is a bug in ts2workflow.
 export class InternalTranspilingError extends Error {
     constructor(message) {
         super(`Internal error: ${message}`);
     }
 }
+// An IO error with an error code string, similar to Node's SystemError
 export class IOError extends Error {
     code;
     constructor(message, code) {

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export { transpile } from './transpiler/index.js';
-export { WorkflowSyntaxError, InternalTranspilingError, SourceCodeLocation, } from './errors.js';
+export { transpile, transpileText } from './transpiler/index.js';
+export { WorkflowSyntaxError, WorkflowSyntaxErrorWithText, InternalTranspilingError, SourceCodeLocation, } from './errors.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AACjD,OAAO,EACL,mBAAmB,EACnB,wBAAwB,EACxB,kBAAkB,GACnB,MAAM,aAAa,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AAChE,OAAO,EACL,mBAAmB,EACnB,2BAA2B,EAC3B,wBAAwB,EACxB,kBAAkB,GACnB,MAAM,aAAa,CAAA"}

package/dist/index.js

@@ -1,2 +1,2 @@
-export { transpile } from './transpiler/index.js';
-export { WorkflowSyntaxError, InternalTranspilingError, } from './errors.js';
+export { transpile, transpileText } from './transpiler/index.js';
+export { WorkflowSyntaxError, WorkflowSyntaxErrorWithText, InternalTranspilingError, } from './errors.js';

package/dist/transpiler/index.d.ts

@@ -1,9 +1,6 @@
 import ts from 'typescript';
 import { WorkflowApp } from '../ast/workflows.js';
-export declare function transpile(input: {
-    filename?: string;
-    read: () => string;
-}, tsconfigPath: string | undefined, linkSubworkflows: boolean): string;
+export declare function transpile(filename: string, sourceCode: string, tsconfigPath: string | undefined, linkSubworkflows: boolean): string;
 export declare function transpileText(sourceCode: string): string;
 /**
  * Returns true if node is an ambient function declaration.

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/transpiler/index.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,MAAM,YAAY,CAAA;AAO3B,OAAO,EAGL,WAAW,EAEZ,MAAM,qBAAqB,CAAA;AAU5B,wBAAgB,SAAS,CACvB,KAAK,EAAE;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,MAAM,CAAA;CAAE,EAChD,YAAY,EAAE,MAAM,GAAG,SAAS,EAChC,gBAAgB,EAAE,OAAO,GACxB,MAAM,CAoBR;AAED,wBAAgB,aAAa,CAAC,UAAU,EAAE,MAAM,UAK/C;AAqID;;;;;;GAMG;AACH,wBAAgB,4BAA4B,CAC1C,IAAI,EAAE,EAAE,CAAC,mBAAmB,GAC3B,OAAO,CAkBT;AAgID;;GAEG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,WAAW,GAAG,MAAM,CAI1D"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/transpiler/index.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,MAAM,YAAY,CAAA;AAQ3B,OAAO,EAGL,WAAW,EAEZ,MAAM,qBAAqB,CAAA;AAU5B,wBAAgB,SAAS,CACvB,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,MAAM,GAAG,SAAS,EAChC,gBAAgB,EAAE,OAAO,GACxB,MAAM,CA2BR;AAED,wBAAgB,aAAa,CAAC,UAAU,EAAE,MAAM,UAS/C;AA2JD;;;;;;GAMG;AACH,wBAAgB,4BAA4B,CAC1C,IAAI,EAAE,EAAE,CAAC,mBAAmB,GAC3B,OAAO,CAkBT;AAgID;;GAEG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,WAAW,GAAG,MAAM,CAI1D"}

package/dist/transpiler/index.js

@@ -3,7 +3,7 @@ import * as path from 'node:path';
 import { AST_NODE_TYPES, parseAndGenerateServices, } from '@typescript-eslint/typescript-estree';
 import ts from 'typescript';
 import * as YAML from 'yaml';
-import { InternalTranspilingError, IOError, WorkflowSyntaxError, } from '../errors.js';
+import { InternalTranspilingError, IOError, syntaxErrorWithText, WorkflowSyntaxError, } from '../errors.js';
 import { SubworkflowStatements, WorkflowApp, } from '../ast/workflows.js';
 import { parseStatement } from './parsestatement.js';
 import { transformAST } from './transformations.js';
@@ -12,11 +12,14 @@ import { isPrimitive, nullEx } from '../ast/expressions.js';
 import { convertExpression } from './parseexpressions.js';
 import { generateStepNames } from './stepnames.js';
 const workflowCache = new Map();
-export function transpile(input, tsconfigPath, linkSubworkflows) {
-    const { ast, services } = parseMainFile(input, tsconfigPath);
-    const inputWorkflow = generateStepNames(ast.body.flatMap(parseTopLevelStatement));
-    if (linkSubworkflows && tsconfigPath && services.program && input.filename) {
-        const canonicalInput = path.join(process.cwd(), input.filename);
+export function transpile(filename, sourceCode, tsconfigPath, linkSubworkflows) {
+    const { ast, services } = parseMainFile(filename, sourceCode, tsconfigPath);
+    const inputWorkflow = esProgramToWorkflowAppEnrichErrors(ast, filename, sourceCode);
+    if (linkSubworkflows &&
+        tsconfigPath &&
+        services.program !== null &&
+        filename) {
+        const canonicalInput = path.join(process.cwd(), filename);
         workflowCache.set(canonicalInput, inputWorkflow);
         const subworkflows = generateLinkedOutput(canonicalInput, tsconfigPath, services.program);
         const combinedWorkflow = new WorkflowApp(subworkflows);
@@ -29,24 +32,40 @@ export function transpile(input, tsconfigPath, linkSubworkflows) {
 export function transpileText(sourceCode) {
     const parserOptions = eslintParserOptions();
     const { ast } = parseAndGenerateServices(sourceCode, parserOptions);
-    const workflow = generateStepNames(ast.body.flatMap(parseTopLevelStatement));
+    const workflow = esProgramToWorkflowAppEnrichErrors(ast, '<stdin>', sourceCode);
     return toYAMLString(workflow);
 }
-function parseMainFile(input, tsconfigPath) {
-    const parserOptions = eslintParserOptions(input.filename, tsconfigPath);
-    if (tsconfigPath && input.filename) {
+function esProgramToWorkflowAppEnrichErrors(program, filename, sourceCode) {
+    try {
+        return esProgramToWorkflowApp(program);
+    }
+    catch (error) {
+        if (error instanceof WorkflowSyntaxError) {
+            throw syntaxErrorWithText(error, filename, sourceCode);
+        }
+        else {
+            throw error;
+        }
+    }
+}
+function esProgramToWorkflowApp(program) {
+    return generateStepNames(program.body.flatMap(parseTopLevelStatement));
+}
+function parseMainFile(filename, sourceCode, tsconfigPath) {
+    const parserOptions = eslintParserOptions(filename, tsconfigPath);
+    if (tsconfigPath) {
         const cwd = process.cwd();
         const configJSON = JSON.parse(fs.readFileSync(path.join(cwd, tsconfigPath), 'utf-8'));
         const { options } = ts.parseJsonConfigFileContent(configJSON, ts.sys, cwd);
-        const program = ts.createProgram([input.filename], options);
-        const mainSourceFile = program.getSourceFile(input.filename);
+        const program = ts.createProgram([filename], options);
+        const mainSourceFile = program.getSourceFile(filename);
         if (mainSourceFile === undefined) {
-            throw new IOError(`Source file ${input.filename} not found`, 'ENOENT');
+            throw new IOError(`Source file ${filename} not found`, 'ENOENT');
         }
         return parseAndGenerateServices(mainSourceFile, parserOptions);
     }
     else {
-        return parseAndGenerateServices(input.read(), parserOptions);
+        return parseAndGenerateServices(sourceCode, parserOptions);
     }
 }
 function eslintParserOptions(inputFile, tsconfigPath) {
@@ -110,7 +129,7 @@ function getCachedWorkflow(filename, tsconfigPath) {
         const parserOptions = eslintParserOptions(filename, tsconfigPath);
         const code = fs.readFileSync(filename, 'utf8');
         const { ast } = parseAndGenerateServices(code, parserOptions);
-        const workflow = generateStepNames(ast.body.flatMap(parseTopLevelStatement));
+        const workflow = esProgramToWorkflowAppEnrichErrors(ast, filename, code);
         workflowCache.set(filename, workflow);
         return workflow;
     }

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

@@ -1 +1 @@
-{"version":3,"file":"parseexpressions.d.ts","sourceRoot":"","sources":["../../src/transpiler/parseexpressions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAkB,MAAM,sCAAsC,CAAA;AAC/E,OAAO,EAGL,UAAU,EAGV,aAAa,EACb,gBAAgB,EAChB,2BAA2B,EAc5B,MAAM,uBAAuB,CAAA;AAG9B,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,CAAC,UAAU,GAAG,UAAU,CAmE3E;AAED,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,QAAQ,CAAC,gBAAgB,GAC9B,aAAa,CA8Bf;AAmJD,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,QAAQ,CAAC,gBAAgB,GAC9B,gBAAgB,CAOlB;AA2KD,wBAAgB,WAAW,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAGvD;AAED,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAGhE;AA8CD,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,wBAAwB,CACtC,IAAI,EAAE,QAAQ,CAAC,UAAU,GAAG,QAAQ,CAAC,iBAAiB,GACrD,QAAQ,CAAC,UAAU,CAMrB;AAED,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,QAAQ,CAAC,UAAU,GACxB,2BAA2B,GAAG,gBAAgB,CAWhD"}
+{"version":3,"file":"parseexpressions.d.ts","sourceRoot":"","sources":["../../src/transpiler/parseexpressions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAkB,MAAM,sCAAsC,CAAA;AAC/E,OAAO,EAGL,UAAU,EAGV,aAAa,EACb,gBAAgB,EAChB,2BAA2B,EAc5B,MAAM,uBAAuB,CAAA;AAG9B,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,CAAC,UAAU,GAAG,UAAU,CAmE3E;AAED,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,QAAQ,CAAC,gBAAgB,GAC9B,aAAa,CAmCf;AAmJD,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,QAAQ,CAAC,gBAAgB,GAC9B,gBAAgB,CAOlB;AA2KD,wBAAgB,WAAW,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAGvD;AAED,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAGhE;AA8CD,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,wBAAwB,CACtC,IAAI,EAAE,QAAQ,CAAC,UAAU,GAAG,QAAQ,CAAC,iBAAiB,GACrD,QAAQ,CAAC,UAAU,CAMrB;AAED,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,QAAQ,CAAC,UAAU,GACxB,2BAA2B,GAAG,gBAAgB,CAWhD"}

package/dist/transpiler/parseexpressions.js

@@ -69,6 +69,10 @@ export function convertObjectExpression(node) {
             typeof key.value === 'string') {
             keyPrimitive = key.value;
         }
+        else if (key.type === AST_NODE_TYPES.Literal &&
+            typeof key.value === 'number') {
+            keyPrimitive = key.value.toString();
+        }
         else {
             throw new WorkflowSyntaxError(`Map keys must be identifiers or strings, encountered: ${key.type}`, key.loc);
         }
@@ -319,7 +323,7 @@ function convertConditionalExpression(node) {
 function convertTemplateLiteralToExpression(node) {
     const stringTerms = node.quasis
         .map((x) => x.value.cooked)
-        .map((x) => stringEx(x));
+        .map((x) => stringEx(x ?? ''));
     const templateTerms = node.expressions
         .map(convertExpression)
         .map((ex) => functionInvocationEx('default', [ex, stringEx('null')]));

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

@@ -1 +1 @@
-{"version":3,"file":"transformations.d.ts","sourceRoot":"","sources":["../../src/transpiler/transformations.ts"],"names":[],"mappings":"AAmBA,OAAO,EAcL,iBAAiB,EAClB,MAAM,sBAAsB,CAAA;AAG7B;;GAEG;AACH,wBAAgB,YAAY,CAC1B,UAAU,EAAE,iBAAiB,EAAE,GAC9B,iBAAiB,EAAE,CAUrB"}
+{"version":3,"file":"transformations.d.ts","sourceRoot":"","sources":["../../src/transpiler/transformations.ts"],"names":[],"mappings":"AAoBA,OAAO,EAcL,iBAAiB,EAClB,MAAM,sBAAsB,CAAA;AAG7B;;GAEG;AACH,wBAAgB,YAAY,CAC1B,UAAU,EAAE,iBAAiB,EAAE,GAC9B,iBAAiB,EAAE,CAUrB"}

package/dist/transpiler/transformations.js

@@ -1,6 +1,6 @@
 import * as R from 'ramda';
 import { InternalTranspilingError } from '../errors.js';
-import { binaryEx, functionInvocationEx, listEx, mapEx, memberEx, stringEx, unaryEx, variableReferenceEx, } from '../ast/expressions.js';
+import { binaryEx, functionInvocationEx, listEx, mapEx, memberEx, nullEx, stringEx, unaryEx, variableReferenceEx, } from '../ast/expressions.js';
 import { applyNested, AssignStatement, FunctionInvocationStatement, IfStatement, LabelledStatement, } from '../ast/statements.js';
 import { blockingFunctions } from './generated/functionMetadata.js';
 /**
@@ -420,13 +420,13 @@ function extractNestedMapUnary(ex, generateName, nestingLevel) {
         tempVariables,
     };
 }
-/**
- * Replace `Array.isArray(x)` with `get_type(x) == "list"`
- */
 const intrinsicFunctionImplementation = expandExpressionToStatements((ex) => [
     [],
-    transformExpression(replaceIsArray, ex),
+    transformExpression(R.pipe(replaceIsArray, replaceArrayIncludes), ex),
 ]);
+/**
+ * Replace `Array.isArray(x)` with `get_type(x) == "list"`
+ */
 function replaceIsArray(ex) {
     if (ex.tag === 'functionInvocation' && ex.functionName === 'Array.isArray') {
         return binaryEx(functionInvocationEx('get_type', ex.arguments), '==', stringEx('list'));
@@ -435,3 +435,16 @@ function replaceIsArray(ex) {
         return ex;
     }
 }
+/**
+ * Replace `Array.includes(arr, x)` with `x in arr`
+ */
+function replaceArrayIncludes(ex) {
+    if (ex.tag === 'functionInvocation' && ex.functionName === 'Array.includes') {
+        const arrayEx = ex.arguments[0] ?? nullEx;
+        const valueEx = ex.arguments[1] ?? nullEx;
+        return binaryEx(valueEx, 'in', arrayEx);
+    }
+    else {
+        return ex;
+    }
+}

package/language_reference.md

@@ -72,6 +72,23 @@ name === 'Bean'
 sys.get_env('GOOGLE_CLOUD_PROJECT_ID')
 ```
 
+### Member expression
+
+To get a value in an array, use the following code:
+
+```javasript
+const val = arr[2];
+```
+
+To get a value in a map, use either of following:
+
+```javasript
+const val = obj.name;
+const val2 = obj["name"];
+```
+
+⚠️ Numeric keys in maps are not cast to strings like in Typescript. It's best not to use numeric keys because GCP Workflows throws errors on numeric keys.
+
 ## Operators
 
 | Operator     | Description                                        |
@@ -880,7 +897,15 @@ This section describes the few standard Javascript runtime functions that are av
 Array.isArray(arg: any): arg is any[]
 ```
 
-Gets converted to the comparison `get_type(arg) == "list"`. Unlike a direct call to `get_type()`, `Array.isArray()` acts a type guard and allows narrowing the `arg` type to an array.
+Returns true, if arg is an array, and false otherwise. `Array.isArray` gets converted to the following comparison on Workflows code: `get_type(arg) == "list"`. Unlike a direct call to `get_type()`, `Array.isArray()` acts a type guard in Typescript and allows narrowing the type of `arg` to an array.
+
+### Array.includes()
+
+```typescript
+Array.includes<T>(arr: Array<T>, x: T): boolean
+```
+
+Returns true, if the array `arr` contains the value `x`, and false otherwise. This static Array method should be used instead of `arr.includes()`, which won't work in Workflows, because arrays in Workflows don't have methods. `Array.includes()` is converted to `x in arr` in the outputted Workflows code.
 
 ## Compiler intrinsics
 
@@ -925,19 +950,7 @@ The `parallel` function executes code blocks in parallel using a [parallel step]
 ### retry_policy()
 
 ```typescript
-function retry_policy(
-  params:
-    | ((errormap: Record<string, any>) => void)
-    | {
-        predicate: (errormap: Record<string, any>) => boolean
-        max_retries: number
-        backoff: {
-          initial_delay: number
-          max_delay: number
-          multiplier: number
-        }
-      },
-): void
+function retry_policy(params: RetryPolicy): void
 ```
 
 A retry policy can be attached to a `try`-`catch` block by calling `retry_policy` inside the `try` block. ts2workflows ignores `retry_policy` everywhere else.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts2workflows",
-  "version": "0.14.0",
+  "version": "0.15.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 --reporter=text --reporter=html mocha",
+    "test:coverage": "nyc --reporter=text --reporter=html mocha",
     "prepare": "husky && npm run build"
   },
   "lint-staged": {
@@ -73,7 +73,7 @@
     "husky": "^9.1.6",
     "lint-staged": "^16.1.2",
     "mocha": "^11.1.0",
-    "nyc": "^17.1.0",
+    "nyc": "^18.0.0",
     "prettier": "^3.2.5",
     "rimraf": "^6.0.1",
     "source-map-support": "^0.5.21",

package/types/global.d.ts

@@ -38,6 +38,7 @@ declare global {
 
   interface ArrayConstructor {
     isArray(arg: any): arg is any[]
+    includes<T>(arr: Array<T>, x: T): boolean
   }
 
   var Array: ArrayConstructor

package/types/workflowslib.d.ts

@@ -32,6 +32,16 @@ type HTTPQuery = Record<
   string | number | boolean | (string | number | boolean)[]
 >
 
+type RetryPolicy = {
+  predicate?: (errormap: Record<string, any>) => boolean
+  max_retries?: number | string | null
+  backoff: {
+    initial_delay?: number | string | null
+    max_delay?: number | string | null
+    multiplier?: number | string | null
+  }
+}
+
 // GCP Workflows expression helpers
 
 export declare function double(x: string | number): number
@@ -93,10 +103,8 @@ export declare namespace hash {
 }
 
 export declare namespace http {
-  export function default_retry(errormap: Record<string, any>): void
-  export function default_retry_non_idempotent(
-    errormap: Record<string, any>,
-  ): void
+  export const default_retry: RetryPolicy
+  export const default_retry_non_idempotent: RetryPolicy
   export function default_retry_predicate(
     errormap: Record<string, any>,
   ): boolean
@@ -1076,19 +1084,7 @@ export declare function parallel(
   },
 ): void
 
-export declare function retry_policy(
-  params:
-    | ((errormap: Record<string, any>) => void)
-    | {
-        predicate?: (errormap: Record<string, any>) => boolean
-        max_retries?: number | string | null
-        backoff: {
-          initial_delay?: number | string | null
-          max_delay?: number | string | null
-          multiplier?: number | string | null
-        }
-      },
-): void
+export declare function retry_policy(params: RetryPolicy): void
 
 export declare function call_step<T, A extends any[]>(
   func: (...args: A) => T,