terraconstructs 0.0.8

package/lib/aws/compute/states/pass.d.ts

@@ -0,0 +1,122 @@
+import { Construct } from "constructs";
+import { State } from "./state";
+import { Chain } from "../chain";
+import { IChainable, INextable } from "../types";
+/**
+ * The result of a Pass operation
+ */
+export declare class Result {
+    readonly value: any;
+    /**
+     * The result of the operation is a string
+     */
+    static fromString(value: string): Result;
+    /**
+     * The result of the operation is a number
+     */
+    static fromNumber(value: number): Result;
+    /**
+     * The result of the operation is a boolean
+     */
+    static fromBoolean(value: boolean): Result;
+    /**
+     * The result of the operation is an object
+     */
+    static fromObject(value: {
+        [key: string]: any;
+    }): Result;
+    /**
+     * The result of the operation is an array
+     */
+    static fromArray(value: any[]): Result;
+    /**
+     *
+     * @param value result of the Pass operation
+     */
+    protected constructor(value: any);
+}
+/**
+ * Properties for defining a Pass state
+ */
+export interface PassProps {
+    /**
+     * Optional name for this state
+     *
+     * @default - The construct ID will be used as state name
+     */
+    readonly stateName?: string;
+    /**
+     * An optional description for this state
+     *
+     * @default No comment
+     */
+    readonly comment?: string;
+    /**
+     * JSONPath expression to select part of the state to be the input to this state.
+     *
+     * May also be the special value JsonPath.DISCARD, which will cause the effective
+     * input to be the empty object {}.
+     *
+     * @default $
+     */
+    readonly inputPath?: string;
+    /**
+     * JSONPath expression to select part of the state to be the output to this state.
+     *
+     * May also be the special value JsonPath.DISCARD, which will cause the effective
+     * output to be the empty object {}.
+     *
+     * @default $
+     */
+    readonly outputPath?: string;
+    /**
+     * JSONPath expression to indicate where to inject the state's output
+     *
+     * May also be the special value JsonPath.DISCARD, which will cause the state's
+     * input to become its output.
+     *
+     * @default $
+     */
+    readonly resultPath?: string;
+    /**
+     * If given, treat as the result of this operation
+     *
+     * Can be used to inject or replace the current execution state.
+     *
+     * @default No injected result
+     */
+    readonly result?: Result;
+    /**
+     * Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.
+     *
+     * @see
+     * https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-parameters
+     *
+     * @default No parameters
+     */
+    readonly parameters?: {
+        [name: string]: any;
+    };
+}
+/**
+ * Define a Pass in the state machine
+ *
+ * A Pass state can be used to transform the current execution's state.
+ */
+export declare class Pass extends State implements INextable {
+    readonly endStates: INextable[];
+    private readonly result?;
+    constructor(scope: Construct, id: string, props?: PassProps);
+    /**
+     * Continue normal execution with the given state
+     */
+    next(next: IChainable): Chain;
+    /**
+     * Return the Amazon States Language object for this state
+     */
+    toStateJson(): object;
+    /**
+     * Render Parameters in ASL JSON format
+     */
+    private renderParameters;
+}

package/lib/aws/compute/states/pass.js

@@ -0,0 +1,99 @@
+"use strict";
+var _a, _b;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Pass = exports.Result = void 0;
+const JSII_RTTI_SYMBOL_1 = Symbol.for("jsii.rtti");
+const state_type_1 = require("./private/state-type");
+const state_1 = require("./state");
+const chain_1 = require("../chain");
+const fields_1 = require("../fields");
+/**
+ * The result of a Pass operation
+ */
+class Result {
+    /**
+     * The result of the operation is a string
+     */
+    static fromString(value) {
+        return new Result(value);
+    }
+    /**
+     * The result of the operation is a number
+     */
+    static fromNumber(value) {
+        return new Result(value);
+    }
+    /**
+     * The result of the operation is a boolean
+     */
+    static fromBoolean(value) {
+        return new Result(value);
+    }
+    /**
+     * The result of the operation is an object
+     */
+    static fromObject(value) {
+        return new Result(value);
+    }
+    /**
+     * The result of the operation is an array
+     */
+    static fromArray(value) {
+        return new Result(value);
+    }
+    /**
+     *
+     * @param value result of the Pass operation
+     */
+    constructor(value) {
+        this.value = value;
+    }
+}
+exports.Result = Result;
+_a = JSII_RTTI_SYMBOL_1;
+Result[_a] = { fqn: "terraconstructs.aws.compute.Result", version: "0.0.8" };
+/**
+ * Define a Pass in the state machine
+ *
+ * A Pass state can be used to transform the current execution's state.
+ */
+class Pass extends state_1.State {
+    constructor(scope, id, props = {}) {
+        super(scope, id, props);
+        this.result = props.result;
+        this.endStates = [this];
+    }
+    /**
+     * Continue normal execution with the given state
+     */
+    next(next) {
+        super.makeNext(next.startState);
+        return chain_1.Chain.sequence(this, next);
+    }
+    /**
+     * Return the Amazon States Language object for this state
+     */
+    toStateJson() {
+        return {
+            Type: state_type_1.StateType.PASS,
+            Comment: this.comment,
+            Result: this.result?.value,
+            ResultPath: (0, state_1.renderJsonPath)(this.resultPath),
+            ...this.renderInputOutput(),
+            ...this.renderParameters(),
+            ...this.renderNextEnd(),
+        };
+    }
+    /**
+     * Render Parameters in ASL JSON format
+     */
+    renderParameters() {
+        return fields_1.FieldUtils.renderObject({
+            Parameters: this.parameters,
+        });
+    }
+}
+exports.Pass = Pass;
+_b = JSII_RTTI_SYMBOL_1;
+Pass[_b] = { fqn: "terraconstructs.aws.compute.Pass", version: "0.0.8" };
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicGFzcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9hd3MvY29tcHV0ZS9zdGF0ZXMvcGFzcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQUdBLHFEQUFpRDtBQUNqRCxtQ0FBZ0Q7QUFDaEQsb0NBQWlDO0FBQ2pDLHNDQUF1QztBQUd2Qzs7R0FFRztBQUNILE1BQWEsTUFBTTtJQUNqQjs7T0FFRztJQUNJLE1BQU0sQ0FBQyxVQUFVLENBQUMsS0FBYTtRQUNwQyxPQUFPLElBQUksTUFBTSxDQUFDLEtBQUssQ0FBQyxDQUFDO0lBQzNCLENBQUM7SUFFRDs7T0FFRztJQUNJLE1BQU0sQ0FBQyxVQUFVLENBQUMsS0FBYTtRQUNwQyxPQUFPLElBQUksTUFBTSxDQUFDLEtBQUssQ0FBQyxDQUFDO0lBQzNCLENBQUM7SUFFRDs7T0FFRztJQUNJLE1BQU0sQ0FBQyxXQUFXLENBQUMsS0FBYztRQUN0QyxPQUFPLElBQUksTUFBTSxDQUFDLEtBQUssQ0FBQyxDQUFDO0lBQzNCLENBQUM7SUFFRDs7T0FFRztJQUNJLE1BQU0sQ0FBQyxVQUFVLENBQUMsS0FBNkI7UUFDcEQsT0FBTyxJQUFJLE1BQU0sQ0FBQyxLQUFLLENBQUMsQ0FBQztJQUMzQixDQUFDO0lBRUQ7O09BRUc7SUFDSSxNQUFNLENBQUMsU0FBUyxDQUFDLEtBQVk7UUFDbEMsT0FBTyxJQUFJLE1BQU0sQ0FBQyxLQUFLLENBQUMsQ0FBQztJQUMzQixDQUFDO0lBRUQ7OztPQUdHO0lBQ0gsWUFBc0MsS0FBVTtRQUFWLFVBQUssR0FBTCxLQUFLLENBQUs7SUFBRyxDQUFDOztBQXhDdEQsd0JBeUNDOzs7QUFzRUQ7Ozs7R0FJRztBQUNILE1BQWEsSUFBSyxTQUFRLGFBQUs7SUFLN0IsWUFBWSxLQUFnQixFQUFFLEVBQVUsRUFBRSxRQUFtQixFQUFFO1FBQzdELEtBQUssQ0FBQyxLQUFLLEVBQUUsRUFBRSxFQUFFLEtBQUssQ0FBQyxDQUFDO1FBRXhCLElBQUksQ0FBQyxNQUFNLEdBQUcsS0FBSyxDQUFDLE1BQU0sQ0FBQztRQUMzQixJQUFJLENBQUMsU0FBUyxHQUFHLENBQUMsSUFBSSxDQUFDLENBQUM7SUFDMUIsQ0FBQztJQUVEOztPQUVHO0lBQ0ksSUFBSSxDQUFDLElBQWdCO1FBQzFCLEtBQUssQ0FBQyxRQUFRLENBQUMsSUFBSSxDQUFDLFVBQVUsQ0FBQyxDQUFDO1FBQ2hDLE9BQU8sYUFBSyxDQUFDLFFBQVEsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLENBQUM7SUFDcEMsQ0FBQztJQUVEOztPQUVHO0lBQ0ksV0FBVztRQUNoQixPQUFPO1lBQ0wsSUFBSSxFQUFFLHNCQUFTLENBQUMsSUFBSTtZQUNwQixPQUFPLEVBQUUsSUFBSSxDQUFDLE9BQU87WUFDckIsTUFBTSxFQUFFLElBQUksQ0FBQyxNQUFNLEVBQUUsS0FBSztZQUMxQixVQUFVLEVBQUUsSUFBQSxzQkFBYyxFQUFDLElBQUksQ0FBQyxVQUFVLENBQUM7WUFDM0MsR0FBRyxJQUFJLENBQUMsaUJBQWlCLEVBQUU7WUFDM0IsR0FBRyxJQUFJLENBQUMsZ0JBQWdCLEVBQUU7WUFDMUIsR0FBRyxJQUFJLENBQUMsYUFBYSxFQUFFO1NBQ3hCLENBQUM7SUFDSixDQUFDO0lBRUQ7O09BRUc7SUFDSyxnQkFBZ0I7UUFDdEIsT0FBTyxtQkFBVSxDQUFDLFlBQVksQ0FBQztZQUM3QixVQUFVLEVBQUUsSUFBSSxDQUFDLFVBQVU7U0FDNUIsQ0FBQyxDQUFDO0lBQ0wsQ0FBQzs7QUExQ0gsb0JBMkNDIiwic291cmNlc0NvbnRlbnQiOlsiLy8gaHR0cHM6Ly9naXRodWIuY29tL2F3cy9hd3MtY2RrL2Jsb2IvdjIuMTYwLjAvcGFja2FnZXMvYXdzLWNkay1saWIvYXdzLXN0ZXBmdW5jdGlvbnMvbGliL3N0YXRlcy9wYXNzLnRzXG5cbmltcG9ydCB7IENvbnN0cnVjdCB9IGZyb20gXCJjb25zdHJ1Y3RzXCI7XG5pbXBvcnQgeyBTdGF0ZVR5cGUgfSBmcm9tIFwiLi9wcml2YXRlL3N0YXRlLXR5cGVcIjtcbmltcG9ydCB7IHJlbmRlckpzb25QYXRoLCBTdGF0ZSB9IGZyb20gXCIuL3N0YXRlXCI7XG5pbXBvcnQgeyBDaGFpbiB9IGZyb20gXCIuLi9jaGFpblwiO1xuaW1wb3J0IHsgRmllbGRVdGlscyB9IGZyb20gXCIuLi9maWVsZHNcIjtcbmltcG9ydCB7IElDaGFpbmFibGUsIElOZXh0YWJsZSB9IGZyb20gXCIuLi90eXBlc1wiO1xuXG4vKipcbiAqIFRoZSByZXN1bHQgb2YgYSBQYXNzIG9wZXJhdGlvblxuICovXG5leHBvcnQgY2xhc3MgUmVzdWx0IHtcbiAgLyoqXG4gICAqIFRoZSByZXN1bHQgb2YgdGhlIG9wZXJhdGlvbiBpcyBhIHN0cmluZ1xuICAgKi9cbiAgcHVibGljIHN0YXRpYyBmcm9tU3RyaW5nKHZhbHVlOiBzdHJpbmcpOiBSZXN1bHQge1xuICAgIHJldHVybiBuZXcgUmVzdWx0KHZhbHVlKTtcbiAgfVxuXG4gIC8qKlxuICAgKiBUaGUgcmVzdWx0IG9mIHRoZSBvcGVyYXRpb24gaXMgYSBudW1iZXJcbiAgICovXG4gIHB1YmxpYyBzdGF0aWMgZnJvbU51bWJlcih2YWx1ZTogbnVtYmVyKTogUmVzdWx0IHtcbiAgICByZXR1cm4gbmV3IFJlc3VsdCh2YWx1ZSk7XG4gIH1cblxuICAvKipcbiAgICogVGhlIHJlc3VsdCBvZiB0aGUgb3BlcmF0aW9uIGlzIGEgYm9vbGVhblxuICAgKi9cbiAgcHVibGljIHN0YXRpYyBmcm9tQm9vbGVhbih2YWx1ZTogYm9vbGVhbik6IFJlc3VsdCB7XG4gICAgcmV0dXJuIG5ldyBSZXN1bHQodmFsdWUpO1xuICB9XG5cbiAgLyoqXG4gICAqIFRoZSByZXN1bHQgb2YgdGhlIG9wZXJhdGlvbiBpcyBhbiBvYmplY3RcbiAgICovXG4gIHB1YmxpYyBzdGF0aWMgZnJvbU9iamVjdCh2YWx1ZTogeyBba2V5OiBzdHJpbmddOiBhbnkgfSk6IFJlc3VsdCB7XG4gICAgcmV0dXJuIG5ldyBSZXN1bHQodmFsdWUpO1xuICB9XG5cbiAgLyoqXG4gICAqIFRoZSByZXN1bHQgb2YgdGhlIG9wZXJhdGlvbiBpcyBhbiBhcnJheVxuICAgKi9cbiAgcHVibGljIHN0YXRpYyBmcm9tQXJyYXkodmFsdWU6IGFueVtdKTogUmVzdWx0IHtcbiAgICByZXR1cm4gbmV3IFJlc3VsdCh2YWx1ZSk7XG4gIH1cblxuICAvKipcbiAgICpcbiAgICogQHBhcmFtIHZhbHVlIHJlc3VsdCBvZiB0aGUgUGFzcyBvcGVyYXRpb25cbiAgICovXG4gIHByb3RlY3RlZCBjb25zdHJ1Y3RvcihwdWJsaWMgcmVhZG9ubHkgdmFsdWU6IGFueSkge31cbn1cblxuLyoqXG4gKiBQcm9wZXJ0aWVzIGZvciBkZWZpbmluZyBhIFBhc3Mgc3RhdGVcbiAqL1xuZXhwb3J0IGludGVyZmFjZSBQYXNzUHJvcHMge1xuICAvKipcbiAgICogT3B0aW9uYWwgbmFtZSBmb3IgdGhpcyBzdGF0ZVxuICAgKlxuICAgKiBAZGVmYXVsdCAtIFRoZSBjb25zdHJ1Y3QgSUQgd2lsbCBiZSB1c2VkIGFzIHN0YXRlIG5hbWVcbiAgICovXG4gIHJlYWRvbmx5IHN0YXRlTmFtZT86IHN0cmluZztcblxuICAvKipcbiAgICogQW4gb3B0aW9uYWwgZGVzY3JpcHRpb24gZm9yIHRoaXMgc3RhdGVcbiAgICpcbiAgICogQGRlZmF1bHQgTm8gY29tbWVudFxuICAgKi9cbiAgcmVhZG9ubHkgY29tbWVudD86IHN0cmluZztcblxuICAvKipcbiAgICogSlNPTlBhdGggZXhwcmVzc2lvbiB0byBzZWxlY3QgcGFydCBvZiB0aGUgc3RhdGUgdG8gYmUgdGhlIGlucHV0IHRvIHRoaXMgc3RhdGUuXG4gICAqXG4gICAqIE1heSBhbHNvIGJlIHRoZSBzcGVjaWFsIHZhbHVlIEpzb25QYXRoLkRJU0NBUkQsIHdoaWNoIHdpbGwgY2F1c2UgdGhlIGVmZmVjdGl2ZVxuICAgKiBpbnB1dCB0byBiZSB0aGUgZW1wdHkgb2JqZWN0IHt9LlxuICAgKlxuICAgKiBAZGVmYXVsdCAkXG4gICAqL1xuICByZWFkb25seSBpbnB1dFBhdGg/OiBzdHJpbmc7XG5cbiAgLyoqXG4gICAqIEpTT05QYXRoIGV4cHJlc3Npb24gdG8gc2VsZWN0IHBhcnQgb2YgdGhlIHN0YXRlIHRvIGJlIHRoZSBvdXRwdXQgdG8gdGhpcyBzdGF0ZS5cbiAgICpcbiAgICogTWF5IGFsc28gYmUgdGhlIHNwZWNpYWwgdmFsdWUgSnNvblBhdGguRElTQ0FSRCwgd2hpY2ggd2lsbCBjYXVzZSB0aGUgZWZmZWN0aXZlXG4gICAqIG91dHB1dCB0byBiZSB0aGUgZW1wdHkgb2JqZWN0IHt9LlxuICAgKlxuICAgKiBAZGVmYXVsdCAkXG4gICAqL1xuICByZWFkb25seSBvdXRwdXRQYXRoPzogc3RyaW5nO1xuXG4gIC8qKlxuICAgKiBKU09OUGF0aCBleHByZXNzaW9uIHRvIGluZGljYXRlIHdoZXJlIHRvIGluamVjdCB0aGUgc3RhdGUncyBvdXRwdXRcbiAgICpcbiAgICogTWF5IGFsc28gYmUgdGhlIHNwZWNpYWwgdmFsdWUgSnNvblBhdGguRElTQ0FSRCwgd2hpY2ggd2lsbCBjYXVzZSB0aGUgc3RhdGUnc1xuICAgKiBpbnB1dCB0byBiZWNvbWUgaXRzIG91dHB1dC5cbiAgICpcbiAgICogQGRlZmF1bHQgJFxuICAgKi9cbiAgcmVhZG9ubHkgcmVzdWx0UGF0aD86IHN0cmluZztcblxuICAvKipcbiAgICogSWYgZ2l2ZW4sIHRyZWF0IGFzIHRoZSByZXN1bHQgb2YgdGhpcyBvcGVyYXRpb25cbiAgICpcbiAgICogQ2FuIGJlIHVzZWQgdG8gaW5qZWN0IG9yIHJlcGxhY2UgdGhlIGN1cnJlbnQgZXhlY3V0aW9uIHN0YXRlLlxuICAgKlxuICAgKiBAZGVmYXVsdCBObyBpbmplY3RlZCByZXN1bHRcbiAgICovXG4gIHJlYWRvbmx5IHJlc3VsdD86IFJlc3VsdDtcblxuICAvKipcbiAgICogUGFyYW1ldGVycyBwYXNzIGEgY29sbGVjdGlvbiBvZiBrZXktdmFsdWUgcGFpcnMsIGVpdGhlciBzdGF0aWMgdmFsdWVzIG9yIEpTT05QYXRoIGV4cHJlc3Npb25zIHRoYXQgc2VsZWN0IGZyb20gdGhlIGlucHV0LlxuICAgKlxuICAgKiBAc2VlXG4gICAqIGh0dHBzOi8vZG9jcy5hd3MuYW1hem9uLmNvbS9zdGVwLWZ1bmN0aW9ucy9sYXRlc3QvZGcvaW5wdXQtb3V0cHV0LWlucHV0cGF0aC1wYXJhbXMuaHRtbCNpbnB1dC1vdXRwdXQtcGFyYW1ldGVyc1xuICAgKlxuICAgKiBAZGVmYXVsdCBObyBwYXJhbWV0ZXJzXG4gICAqL1xuICByZWFkb25seSBwYXJhbWV0ZXJzPzogeyBbbmFtZTogc3RyaW5nXTogYW55IH07XG59XG5cbi8qKlxuICogRGVmaW5lIGEgUGFzcyBpbiB0aGUgc3RhdGUgbWFjaGluZVxuICpcbiAqIEEgUGFzcyBzdGF0ZSBjYW4gYmUgdXNlZCB0byB0cmFuc2Zvcm0gdGhlIGN1cnJlbnQgZXhlY3V0aW9uJ3Mgc3RhdGUuXG4gKi9cbmV4cG9ydCBjbGFzcyBQYXNzIGV4dGVuZHMgU3RhdGUgaW1wbGVtZW50cyBJTmV4dGFibGUge1xuICBwdWJsaWMgcmVhZG9ubHkgZW5kU3RhdGVzOiBJTmV4dGFibGVbXTtcblxuICBwcml2YXRlIHJlYWRvbmx5IHJlc3VsdD86IFJlc3VsdDtcblxuICBjb25zdHJ1Y3RvcihzY29wZTogQ29uc3RydWN0LCBpZDogc3RyaW5nLCBwcm9wczogUGFzc1Byb3BzID0ge30pIHtcbiAgICBzdXBlcihzY29wZSwgaWQsIHByb3BzKTtcblxuICAgIHRoaXMucmVzdWx0ID0gcHJvcHMucmVzdWx0O1xuICAgIHRoaXMuZW5kU3RhdGVzID0gW3RoaXNdO1xuICB9XG5cbiAgLyoqXG4gICAqIENvbnRpbnVlIG5vcm1hbCBleGVjdXRpb24gd2l0aCB0aGUgZ2l2ZW4gc3RhdGVcbiAgICovXG4gIHB1YmxpYyBuZXh0KG5leHQ6IElDaGFpbmFibGUpOiBDaGFpbiB7XG4gICAgc3VwZXIubWFrZU5leHQobmV4dC5zdGFydFN0YXRlKTtcbiAgICByZXR1cm4gQ2hhaW4uc2VxdWVuY2UodGhpcywgbmV4dCk7XG4gIH1cblxuICAvKipcbiAgICogUmV0dXJuIHRoZSBBbWF6b24gU3RhdGVzIExhbmd1YWdlIG9iamVjdCBmb3IgdGhpcyBzdGF0ZVxuICAgKi9cbiAgcHVibGljIHRvU3RhdGVKc29uKCk6IG9iamVjdCB7XG4gICAgcmV0dXJuIHtcbiAgICAgIFR5cGU6IFN0YXRlVHlwZS5QQVNTLFxuICAgICAgQ29tbWVudDogdGhpcy5jb21tZW50LFxuICAgICAgUmVzdWx0OiB0aGlzLnJlc3VsdD8udmFsdWUsXG4gICAgICBSZXN1bHRQYXRoOiByZW5kZXJKc29uUGF0aCh0aGlzLnJlc3VsdFBhdGgpLFxuICAgICAgLi4udGhpcy5yZW5kZXJJbnB1dE91dHB1dCgpLFxuICAgICAgLi4udGhpcy5yZW5kZXJQYXJhbWV0ZXJzKCksXG4gICAgICAuLi50aGlzLnJlbmRlck5leHRFbmQoKSxcbiAgICB9O1xuICB9XG5cbiAgLyoqXG4gICAqIFJlbmRlciBQYXJhbWV0ZXJzIGluIEFTTCBKU09OIGZvcm1hdFxuICAgKi9cbiAgcHJpdmF0ZSByZW5kZXJQYXJhbWV0ZXJzKCk6IGFueSB7XG4gICAgcmV0dXJuIEZpZWxkVXRpbHMucmVuZGVyT2JqZWN0KHtcbiAgICAgIFBhcmFtZXRlcnM6IHRoaXMucGFyYW1ldGVycyxcbiAgICB9KTtcbiAgfVxufVxuIl19

package/lib/aws/compute/states/private/state-type.d.ts

@@ -0,0 +1,13 @@
+/**
+ * State types
+ */
+export declare enum StateType {
+    PASS = "Pass",
+    TASK = "Task",
+    CHOICE = "Choice",
+    WAIT = "Wait",
+    SUCCEED = "Succeed",
+    FAIL = "Fail",
+    PARALLEL = "Parallel",
+    MAP = "Map"
+}

package/lib/aws/compute/states/private/state-type.js

@@ -0,0 +1,19 @@
+"use strict";
+// https://github.com/aws/aws-cdk/blob/v2.160.0/packages/aws-cdk-lib/aws-stepfunctions/lib/states/private/state-type.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StateType = void 0;
+/**
+ * State types
+ */
+var StateType;
+(function (StateType) {
+    StateType["PASS"] = "Pass";
+    StateType["TASK"] = "Task";
+    StateType["CHOICE"] = "Choice";
+    StateType["WAIT"] = "Wait";
+    StateType["SUCCEED"] = "Succeed";
+    StateType["FAIL"] = "Fail";
+    StateType["PARALLEL"] = "Parallel";
+    StateType["MAP"] = "Map";
+})(StateType || (exports.StateType = StateType = {}));
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic3RhdGUtdHlwZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uL3NyYy9hd3MvY29tcHV0ZS9zdGF0ZXMvcHJpdmF0ZS9zdGF0ZS10eXBlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSx1SEFBdUg7OztBQUV2SDs7R0FFRztBQUNILElBQVksU0FTWDtBQVRELFdBQVksU0FBUztJQUNuQiwwQkFBYSxDQUFBO0lBQ2IsMEJBQWEsQ0FBQTtJQUNiLDhCQUFpQixDQUFBO0lBQ2pCLDBCQUFhLENBQUE7SUFDYixnQ0FBbUIsQ0FBQTtJQUNuQiwwQkFBYSxDQUFBO0lBQ2Isa0NBQXFCLENBQUE7SUFDckIsd0JBQVcsQ0FBQTtBQUNiLENBQUMsRUFUVyxTQUFTLHlCQUFULFNBQVMsUUFTcEIiLCJzb3VyY2VzQ29udGVudCI6WyIvLyBodHRwczovL2dpdGh1Yi5jb20vYXdzL2F3cy1jZGsvYmxvYi92Mi4xNjAuMC9wYWNrYWdlcy9hd3MtY2RrLWxpYi9hd3Mtc3RlcGZ1bmN0aW9ucy9saWIvc3RhdGVzL3ByaXZhdGUvc3RhdGUtdHlwZS50c1xuXG4vKipcbiAqIFN0YXRlIHR5cGVzXG4gKi9cbmV4cG9ydCBlbnVtIFN0YXRlVHlwZSB7XG4gIFBBU1MgPSBcIlBhc3NcIixcbiAgVEFTSyA9IFwiVGFza1wiLFxuICBDSE9JQ0UgPSBcIkNob2ljZVwiLFxuICBXQUlUID0gXCJXYWl0XCIsXG4gIFNVQ0NFRUQgPSBcIlN1Y2NlZWRcIixcbiAgRkFJTCA9IFwiRmFpbFwiLFxuICBQQVJBTExFTCA9IFwiUGFyYWxsZWxcIixcbiAgTUFQID0gXCJNYXBcIixcbn1cbiJdfQ==

package/lib/aws/compute/states/state.d.ts

@@ -0,0 +1,276 @@
+import { IConstruct, Construct } from "constructs";
+import { Condition } from "../condition";
+import { StateGraph } from "../state-graph";
+import { CatchProps, IChainable, INextable, ProcessorConfig, ProcessorMode, RetryProps } from "../types";
+/**
+ * Properties shared by all states
+ */
+export interface StateProps {
+    /**
+     * Optional name for this state
+     *
+     * @default - The construct ID will be used as state name
+     */
+    readonly stateName?: string;
+    /**
+     * A comment describing this state
+     *
+     * @default No comment
+     */
+    readonly comment?: string;
+    /**
+     * JSONPath expression to select part of the state to be the input to this state.
+     *
+     * May also be the special value JsonPath.DISCARD, which will cause the effective
+     * input to be the empty object {}.
+     *
+     * @default $
+     */
+    readonly inputPath?: string;
+    /**
+     * Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.
+     *
+     * @see
+     * https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-parameters
+     *
+     * @default No parameters
+     */
+    readonly parameters?: {
+        [name: string]: any;
+    };
+    /**
+     * JSONPath expression to select part of the state to be the output to this state.
+     *
+     * May also be the special value JsonPath.DISCARD, which will cause the effective
+     * output to be the empty object {}.
+     *
+     * @default $
+     */
+    readonly outputPath?: string;
+    /**
+     * JSONPath expression to indicate where to inject the state's output
+     *
+     * May also be the special value JsonPath.DISCARD, which will cause the state's
+     * input to become its output.
+     *
+     * @default $
+     */
+    readonly resultPath?: string;
+    /**
+     * The JSON that will replace the state's raw result and become the effective
+     * result before ResultPath is applied.
+     *
+     * You can use ResultSelector to create a payload with values that are static
+     * or selected from the state's raw result.
+     *
+     * @see
+     * https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector
+     *
+     * @default - None
+     */
+    readonly resultSelector?: {
+        [key: string]: any;
+    };
+}
+/**
+ * Base class for all other state classes
+ */
+export declare abstract class State extends Construct implements IChainable {
+    /**
+     * Add a prefix to the stateId of all States found in a construct tree
+     */
+    static prefixStates(root: IConstruct, prefix: string): void;
+    /**
+     * Find the set of states reachable through transitions from the given start state.
+     * This does not retrieve states from within sub-graphs, such as states within a Parallel state's branch.
+     */
+    static findReachableStates(start: State, options?: FindStateOptions): State[];
+    /**
+     * Find the set of end states states reachable through transitions from the given start state
+     */
+    static findReachableEndStates(start: State, options?: FindStateOptions): State[];
+    /**
+     * Return only the states that allow chaining from an array of states
+     */
+    static filterNextables(states: State[]): INextable[];
+    /**
+     * First state of this Chainable
+     */
+    readonly startState: State;
+    /**
+     * Continuable states of this Chainable
+     */
+    abstract readonly endStates: INextable[];
+    protected readonly stateName?: string;
+    protected readonly comment?: string;
+    protected readonly inputPath?: string;
+    protected readonly parameters?: object;
+    protected readonly outputPath?: string;
+    protected readonly resultPath?: string;
+    protected readonly resultSelector?: object;
+    protected readonly branches: StateGraph[];
+    protected iteration?: StateGraph;
+    protected processorMode?: ProcessorMode;
+    protected processor?: StateGraph;
+    protected processorConfig?: ProcessorConfig;
+    protected defaultChoice?: State;
+    /**
+     * @internal
+     */
+    protected _next?: State;
+    private readonly retries;
+    private readonly catches;
+    private readonly choices;
+    private readonly prefixes;
+    /**
+     * The graph that this state is part of.
+     *
+     * Used for guaranteeing consistency between graphs and graph components.
+     */
+    private containingGraph?;
+    /**
+     * States with references to this state.
+     *
+     * Used for finding complete connected graph that a state is part of.
+     */
+    private readonly incomingStates;
+    constructor(scope: Construct, id: string, props: StateProps);
+    /**
+     * Allows the state to validate itself.
+     */
+    protected validateState(): string[];
+    get id(): string;
+    /**
+     * Tokenized string that evaluates to the state's ID
+     */
+    get stateId(): string;
+    /**
+     * Add a prefix to the stateId of this state
+     */
+    addPrefix(x: string): void;
+    /**
+     * Register this state as part of the given graph
+     *
+     * Don't call this. It will be called automatically when you work
+     * with states normally.
+     */
+    bindToGraph(graph: StateGraph): void;
+    /**
+     * Render the state as JSON
+     */
+    abstract toStateJson(): object;
+    /**
+     * Add a retrier to the retry list of this state
+     * @internal
+     */
+    protected _addRetry(props?: RetryProps): void;
+    /**
+     * Add an error handler to the catch list of this state
+     * @internal
+     */
+    protected _addCatch(handler: State, props?: CatchProps): void;
+    /**
+     * Make the indicated state the default transition of this state
+     */
+    protected makeNext(next: State): void;
+    /**
+     * Add a choice branch to this state
+     */
+    protected addChoice(condition: Condition, next: State, options?: ChoiceTransitionOptions): void;
+    /**
+     * Add a parallel branch to this state
+     */
+    protected addBranch(branch: StateGraph): void;
+    /**
+     * Add a map iterator to this state
+     */
+    protected addIterator(iteration: StateGraph): void;
+    /**
+     * Add a item processor to this state
+     */
+    protected addItemProcessor(processor: StateGraph, config?: ProcessorConfig): void;
+    /**
+     * Make the indicated state the default choice transition of this state
+     */
+    protected makeDefault(def: State): void;
+    /**
+     * Render the default next state in ASL JSON format
+     */
+    protected renderNextEnd(): any;
+    /**
+     * Render the choices in ASL JSON format
+     */
+    protected renderChoices(): any;
+    /**
+     * Render InputPath/Parameters/OutputPath in ASL JSON format
+     */
+    protected renderInputOutput(): any;
+    /**
+     * Render parallel branches in ASL JSON format
+     */
+    protected renderBranches(): any;
+    /**
+     * Render map iterator in ASL JSON format
+     */
+    protected renderIterator(): any;
+    /**
+     * Render error recovery options in ASL JSON format
+     */
+    protected renderRetryCatch(): any;
+    /**
+     * Render ResultSelector in ASL JSON format
+     */
+    protected renderResultSelector(): any;
+    /**
+     * Render ItemProcessor in ASL JSON format
+     */
+    protected renderItemProcessor(): any;
+    /**
+     * Render ProcessorConfig in ASL JSON format
+     */
+    private renderProcessorConfig;
+    /**
+     * Called whenever this state is bound to a graph
+     *
+     * Can be overridden by subclasses.
+     */
+    protected whenBoundToGraph(graph: StateGraph): void;
+    /**
+     * Add a state to the incoming list
+     */
+    private addIncoming;
+    /**
+     * Return all states this state can transition to
+     */
+    private outgoingTransitions;
+}
+/**
+ * Options for finding reachable states
+ */
+export interface FindStateOptions {
+    /**
+     * Whether or not to follow error-handling transitions
+     *
+     * @default false
+     */
+    readonly includeErrorHandlers?: boolean;
+}
+/**
+ * Options for Choice Transition
+ */
+export interface ChoiceTransitionOptions {
+    /**
+     * An optional description for the choice transition
+     *
+     * @default No comment
+     */
+    readonly comment?: string;
+}
+/**
+ * Render a list or return undefined for an empty list
+ */
+export declare function renderList<T>(xs: T[], mapFn: (x: T) => any, sortFn?: (a: T, b: T) => number): any;
+/**
+ * Render JSON path, respecting the special value JsonPath.DISCARD
+ */
+export declare function renderJsonPath(jsonPath?: string): undefined | null | string;