@suss/terraform-aws 0.7.0

package/LICENSE

@@ -0,0 +1,205 @@
+                                 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 please. Also add information on
+      how to contact you by electronic and paper mail.
+
+      If the program does not interact with users remotely through a computer
+      network, then your name and employer's name (e.g., your institution)
+      is sufficient to fill in the "name of copyright owner" field. Feel
+      free to omit the "name of employer" line if you are in no way affiliated
+      with any institution.
+
+      Copyright 2026 Nimbus Cloud AI LLC
+
+      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,48 @@
+# @suss/terraform-aws
+
+Says what AWS's Terraform provider declares, for `@suss/contract-terraform` to read.
+
+## What this package is
+
+A pack, and nothing but data. The reader walks HCL and knows nothing about any provider; this says that `aws_dynamodb_table` is a store keyed by `hash_key` and `range_key`, that `aws_sqs_queue` is a channel, and which provider versions each of those statements is about.
+
+```ts
+import { terraformFileToSummaries } from "@suss/contract-terraform";
+import { awsTerraform } from "@suss/terraform-aws";
+
+terraformFileToSummaries("infra/terraform/dynamodb", { packs: [awsTerraform()] });
+```
+
+`suss contract --from terraform <path>` loads it for you.
+
+## What it reads today
+
+| Resource | Becomes |
+| --- | --- |
+| `aws_dynamodb_table` | a store, keyed by `hash_key` and `range_key`, with each `global_secondary_index` and `local_secondary_index` as its own way in |
+| `aws_s3_bucket` | a store whose objects have no fields to compare against |
+| `aws_sqs_queue` | a channel |
+| `aws_sns_topic` | a channel |
+| `aws_cloudwatch_event_bus` | a channel |
+
+Everything else a configuration declares, a security group, a subnet, an IAM policy, is how the deployment is wired rather than something a caller addresses, so nothing reads it.
+
+## Why every entry states a version range
+
+The provider moves things between releases. Version 4 split a bucket's settings into resources of their own, so `aws_s3_bucket_server_side_encryption_configuration` is a separate resource in a v4 configuration and an inline block in a v3 one. An entry that describes the v4 shape says so, and a configuration pinned to v3 is read by the entries written for v3 and by none of the others.
+
+A configuration states its own pin:
+
+```hcl
+terraform {
+  required_providers {
+    aws = { source = "hashicorp/aws", version = "~> 5.0" }
+  }
+}
+```
+
+The reader takes that pin and hands it to the pack. A configuration that pins nothing is read by every entry, since nothing said otherwise.
+
+## Where it fits in suss
+
+Depends on `@suss/contract-terraform` for the shape of an entry, and on nothing else. A pack for another provider, `google` or `cloudflare`, is the same file with different entries.

package/dist/index.cjs

@@ -0,0 +1,108 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  awsTerraform: () => awsTerraform,
+  default: () => index_default
+});
+module.exports = __toCommonJS(index_exports);
+var CURRENT = ">=4 <7";
+function awsTerraform() {
+  return {
+    name: "terraform-aws",
+    provider: "aws",
+    resources: [
+      {
+        resource: "aws_dynamodb_table",
+        providerVersions: CURRENT,
+        boundary: {
+          kind: "storage",
+          storageSystem: "dynamodb",
+          // A caller reaches a table through the SDK over HTTPS rather
+          // than through a wire protocol of its own.
+          transport: "aws-sdk",
+          nameAttribute: "name",
+          // A table declares its key attributes and lets every other
+          // attribute vary.
+          fieldSet: "partial",
+          identifies: ["hash_key", "range_key"],
+          accessPathBlocks: ["global_secondary_index", "local_secondary_index"],
+          serves: {
+            kindAttribute: "projection_type",
+            fieldsAttribute: "non_key_attributes",
+            everything: "ALL"
+          },
+          fieldTypes: {
+            block: "attribute",
+            nameAttribute: "name",
+            typeAttribute: "type"
+          }
+        }
+      },
+      {
+        resource: "aws_s3_bucket",
+        providerVersions: CURRENT,
+        boundary: {
+          kind: "storage",
+          storageSystem: "s3",
+          transport: "aws-sdk",
+          nameAttribute: "bucket",
+          // An object has no fields to compare a read against, and what
+          // picks one out is the shape of its key, which the bucket
+          // does not state.
+          fieldSet: "none"
+        }
+      },
+      {
+        resource: "aws_sqs_queue",
+        providerVersions: CURRENT,
+        boundary: {
+          kind: "message-bus",
+          messageBus: "sqs",
+          nameAttribute: "name"
+        }
+      },
+      {
+        resource: "aws_sns_topic",
+        providerVersions: CURRENT,
+        boundary: {
+          kind: "message-bus",
+          messageBus: "sns",
+          nameAttribute: "name"
+        }
+      },
+      {
+        resource: "aws_cloudwatch_event_bus",
+        providerVersions: CURRENT,
+        boundary: {
+          kind: "message-bus",
+          messageBus: "eventbridge",
+          nameAttribute: "name"
+        }
+      }
+    ]
+  };
+}
+var index_default = awsTerraform;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  awsTerraform
+});

package/dist/index.d.cts

@@ -0,0 +1,15 @@
+import { TerraformPack } from '@suss/contract-terraform';
+
+/**
+ * What AWS's Terraform provider declares, as far as suss reads it.
+ *
+ * Every entry says which provider versions it describes. The provider
+ * moves things between releases, so a configuration pinned to one major
+ * is read by the entries written for it and by no others. Version 4
+ * split a bucket's settings into resources of their own, which is why
+ * the bucket entry starts there.
+ */
+
+declare function awsTerraform(): TerraformPack;
+
+export { awsTerraform, awsTerraform as default };

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+import { TerraformPack } from '@suss/contract-terraform';
+
+/**
+ * What AWS's Terraform provider declares, as far as suss reads it.
+ *
+ * Every entry says which provider versions it describes. The provider
+ * moves things between releases, so a configuration pinned to one major
+ * is read by the entries written for it and by no others. Version 4
+ * split a bucket's settings into resources of their own, which is why
+ * the bucket entry starts there.
+ */
+
+declare function awsTerraform(): TerraformPack;
+
+export { awsTerraform, awsTerraform as default };

package/dist/index.js

@@ -0,0 +1,83 @@
+// src/index.ts
+var CURRENT = ">=4 <7";
+function awsTerraform() {
+  return {
+    name: "terraform-aws",
+    provider: "aws",
+    resources: [
+      {
+        resource: "aws_dynamodb_table",
+        providerVersions: CURRENT,
+        boundary: {
+          kind: "storage",
+          storageSystem: "dynamodb",
+          // A caller reaches a table through the SDK over HTTPS rather
+          // than through a wire protocol of its own.
+          transport: "aws-sdk",
+          nameAttribute: "name",
+          // A table declares its key attributes and lets every other
+          // attribute vary.
+          fieldSet: "partial",
+          identifies: ["hash_key", "range_key"],
+          accessPathBlocks: ["global_secondary_index", "local_secondary_index"],
+          serves: {
+            kindAttribute: "projection_type",
+            fieldsAttribute: "non_key_attributes",
+            everything: "ALL"
+          },
+          fieldTypes: {
+            block: "attribute",
+            nameAttribute: "name",
+            typeAttribute: "type"
+          }
+        }
+      },
+      {
+        resource: "aws_s3_bucket",
+        providerVersions: CURRENT,
+        boundary: {
+          kind: "storage",
+          storageSystem: "s3",
+          transport: "aws-sdk",
+          nameAttribute: "bucket",
+          // An object has no fields to compare a read against, and what
+          // picks one out is the shape of its key, which the bucket
+          // does not state.
+          fieldSet: "none"
+        }
+      },
+      {
+        resource: "aws_sqs_queue",
+        providerVersions: CURRENT,
+        boundary: {
+          kind: "message-bus",
+          messageBus: "sqs",
+          nameAttribute: "name"
+        }
+      },
+      {
+        resource: "aws_sns_topic",
+        providerVersions: CURRENT,
+        boundary: {
+          kind: "message-bus",
+          messageBus: "sns",
+          nameAttribute: "name"
+        }
+      },
+      {
+        resource: "aws_cloudwatch_event_bus",
+        providerVersions: CURRENT,
+        boundary: {
+          kind: "message-bus",
+          messageBus: "eventbridge",
+          nameAttribute: "name"
+        }
+      }
+    ]
+  };
+}
+var index_default = awsTerraform;
+export {
+  awsTerraform,
+  index_default as default
+};

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@suss/terraform-aws",
+  "version": "0.7.0",
+  "type": "module",
+  "description": "What AWS's Terraform provider declares, for the Terraform contract reader.",
+  "keywords": [
+    "suss",
+    "behavioral-summary",
+    "terraform",
+    "aws"
+  ],
+  "license": "Apache-2.0",
+  "author": "Nimbus Cloud AI LLC",
+  "homepage": "https://github.com/nimbuscloud-ai/suss/tree/main/packages/terraform/aws#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nimbuscloud-ai/suss.git",
+    "directory": "packages/terraform/aws"
+  },
+  "bugs": {
+    "url": "https://github.com/nimbuscloud-ai/suss/issues"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "lint": "biome check .",
+    "lint:fix": "biome check --write .",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@suss/contract-terraform": "0.7.0"
+  },
+  "devDependencies": {
+    "@suss/behavioral-ir": "*",
+    "tsup": "*",
+    "typescript": "*",
+    "vitest": "*"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}