@flow-as-code/tf 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 The flow-as-code Authors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,67 @@
+# @flow-as-code/tf
+
+```
+npm i @flow-as-code/tf
+```
+
+Apache-2.0, Node 22.12 or newer.
+
+Implements docs/03-tf-emitter.md. Deterministic HCL emission, `terraform validate`-clean when the address map is complete, loud TODO placeholders when it is not. Never emits literal ARNs, provider blocks, or backend config.
+
+One-way in v1: FlowDoc in, HCL out. Reading HCL back into FlowDoc needs HCL evaluation and is deferred to the provider era.
+
+## Use
+
+```ts
+import { emitTf, writeTf } from "@flow-as-code/tf";
+
+const { files } = emitTf([doc], {
+  addressMap: { "queue:front-desk": "aws_connect_queue.front_desk.arn" },
+});
+
+writeTf([doc], "infra/flows", { addressMap });
+```
+
+`emitTf` is pure: documents in, a relative path to content map out, sorted by path and byte-identical across runs. `writeTf` is the filesystem wrapper; it creates directories, overwrites the files it emits, and touches nothing else in the target directory.
+
+`@flow-as-code/tf/emit` is the same emitter without the filesystem half. The package index re-exports `writeTf`, which imports `node:fs`, so a browser bundle (`@flow-as-code/studio`'s Terraform export) imports the subpath instead.
+
+## Output
+
+| File                      | What it holds                                                                                                 |
+| ------------------------- | ------------------------------------------------------------------------------------------------------------- |
+| `flows/<name>.flow.tftpl` | Deployable Flow language JSON, each reference replaced by a `templatefile` interpolation                      |
+| `flows.tf`                | `aws_connect_contact_flow` / `aws_connect_contact_flow_module`, plus awscc module version and alias resources |
+| `flow_refs.tf`            | `locals` holding the terraform address behind every reference                                                 |
+| `variables.tf`            | The Connect instance id variable, unless `instanceIdExpression` supplies one                                  |
+| `versions.tf.example`     | Required providers and versions, as an example; not loaded by either tool                                     |
+
+Provider configuration, credentials, and backend configuration are yours. The emitter writes none of them, by rule.
+
+## References
+
+Every `${cdref:type:name}` token becomes a template variable named `<type>_<name>_arn`, hyphens as underscores, with a module alias folded in: `queue_front_desk_arn`, `module_survey_prod_arn`. Addresses come from three places, in this order:
+
+1. **The document set itself.** A `${cdref:module:x@prod}` whose module `x` is emitted here resolves to `awscc_connect_contact_flow_module_alias.x_prod.contact_flow_module_alias_arn`; a `${cdref:flow:y}` whose flow `y` is emitted here resolves to that flow. An address map entry for one of these is ignored, and the emitted file says so on the line above.
+2. **The address map.** Keys are a token (`${cdref:queue:front-desk}`), the token body (`queue:front-desk`, `module:survey@prod`), or the variable name (`queue_front_desk_arn`). Values are HCL address expressions. A literal ARN is refused, as is anything that would comment out or overrun its line. Entries matching no reference in the set are ignored, so one shared map can serve several flow sets.
+3. **Nothing.** The entry becomes `TODO_MISSING_ADDRESS_<type>_<name>` with a `# TODO` naming the reference. That is an undeclared reference, so `terraform validate` and `tofu validate` fail loudly rather than an apply writing a broken flow.
+
+Addresses of resources the set emits itself live in a per-document local (`merge(local.flow_refs, { ... })`) rather than in the shared map. Putting them in the shared map makes the map depend on the resources rendered from it, and both tools report that as a dependency cycle. Two flows that reference each other are still a cycle, because it is one.
+
+## Escaping
+
+The `.tftpl` body is JSON containing caller text, and caller text legitimately contains `${` and `%{`, the two sequences HCL reads as template introducers. Every one of them is escaped (`$${`, `%%{`) and only the emitter's own reference interpolations are left live. The substitution runs through unique sentinels chosen so they cannot collide with the document, so text that looks like a sentinel is caller text and stays caller text. `conformance/emit-tf/hostile-text` holds the fixture, and the gated tests render it with a real `tofu` and compare against a reference implementation of the template grammar.
+
+## Versions and aliases
+
+Flow versioning is not available: `CreateContactFlowVersion` "only supports creating versions for flows of type Campaign" ([API reference](https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateContactFlowVersion.html)). Flows update their content in place. Modules get `awscc_connect_contact_flow_module_version` and `awscc_connect_contact_flow_module_alias`, which is how a caller pins the module content it invokes. A version snapshots content at create time, so a module content change needs the version resource replaced for aliases to serve it.
+
+## Tests
+
+`npm test` runs the goldens in `conformance/emit-tf` and the unit tests. The tests that run a real `tofu init`, `tofu validate`, `tofu fmt`, and `tofu console` need the network and a few minutes on a cold provider cache, so they are gated behind `RUN_TOFU_VALIDATE=1`:
+
+```sh
+RUN_TOFU_VALIDATE=1 npx vitest run --project @flow-as-code/tf
+```
+
+CI runs them in the `emit-tf` job, and an ungated test asserts that the job still sets the variable. Regenerate goldens deliberately with `UPDATE_GOLDENS=1` and read the diff.

package/dist/emit.d.ts

@@ -0,0 +1,45 @@
+import { type FlowDoc } from "@flow-as-code/core";
+/**
+ * The oldest core version the emitted configuration promises to work on, per
+ * docs/03-tf-emitter.md ("emit nothing Terraform 1.8+/OpenTofu 1.7+ do not both
+ * support"). It lands in every `versions.tf.example` as `required_version`, and
+ * the emit-tf CI job is asserted to run the gated suite against it, so the
+ * promise and the thing that checks the promise cannot drift apart.
+ */
+export declare const CORE_VERSION_FLOOR = "1.7.0";
+/** Emission refused. Every problem found is listed, not just the first. */
+export declare class EmitTfError extends Error {
+    readonly problems: readonly string[];
+    constructor(problems: readonly string[]);
+}
+export interface EmitTfOptions {
+    /**
+     * Reference to terraform address expression, for references this emitter
+     * cannot resolve from the document set itself. A key is a token
+     * (`${cdref:queue:front-desk}`), the token body (`queue:front-desk`,
+     * `module:survey@prod`), or the generated variable name
+     * (`queue_front_desk_arn`); the three are tried in that order. Values are HCL
+     * expressions such as `aws_connect_queue.front_desk.arn`, never literal ARNs.
+     * Entries matching no reference in the set are ignored.
+     */
+    addressMap?: Record<string, string>;
+    /**
+     * Expression for the `instance_id` argument. Defaults to
+     * `var.connect_instance_id`, in which case variables.tf declaring that
+     * variable is emitted too. Pass something else (`aws_connect_instance.main.id`)
+     * to wire the flows into an instance you already manage; no variables.tf is
+     * emitted then.
+     */
+    instanceIdExpression?: string;
+}
+export interface EmitTfResult {
+    /** Relative POSIX path to file content, insertion-ordered by sorted path. */
+    files: Record<string, string>;
+}
+/**
+ * Emits a Terraform/OpenTofu configuration for a set of FlowDocs. Pure and
+ * deterministic: the same documents and options produce byte-identical files,
+ * and paths come back sorted.
+ */
+export declare function emitTf(docs: readonly FlowDoc[], options?: EmitTfOptions): EmitTfResult;
+//# sourceMappingURL=emit.d.ts.map

package/dist/emit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"emit.d.ts","sourceRoot":"","sources":["../src/emit.ts"],"names":[],"mappings":"AAmBA,OAAO,EACL,KAAK,OAAO,EAMb,MAAM,oBAAoB,CAAC;AAI5B;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,UAAU,CAAC;AAE1C,2EAA2E;AAC3E,qBAAa,WAAY,SAAQ,KAAK;IACpC,QAAQ,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;gBAEzB,QAAQ,EAAE,SAAS,MAAM,EAAE;CAKxC;AAED,MAAM,WAAW,aAAa;IAC5B;;;;;;;;OAQG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC;;;;;;OAMG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,MAAM,WAAW,YAAY;IAC3B,6EAA6E;IAC7E,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC/B;AAsZD;;;;GAIG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,SAAS,OAAO,EAAE,EAAE,OAAO,GAAE,aAAkB,GAAG,YAAY,CA8C1F"}