@terra-graph/conventions-aws 1.0.0-rc.1

package/CHANGELOG.md

@@ -0,0 +1,35 @@
+## 1.0.0-rc.1 (2026-03-28)
+
+### Features
+
+* add aws package ([2eaadc9](https://github.com/terra-graph/conventions/commit/2eaadc93f45ac1a9a1cd75f11b3652c9b838b37d))
+* add initial aws package ([8700de3](https://github.com/terra-graph/conventions/commit/8700de3984fcc75368864bbe615a38645c404d1b))
+* added core package ([1bdc6e7](https://github.com/terra-graph/conventions/commit/1bdc6e7aefc2813e5fb6650bd008a0bf31295719))
+
+### Bug Fixes
+
+* force release ([38320d9](https://github.com/terra-graph/conventions/commit/38320d95672062fba3dd62500f8653c67b09bb45))
+* force release ([f625ac0](https://github.com/terra-graph/conventions/commit/f625ac0a95083f25df1db7155c08d2d1544c4f2b))
+* force release ([955c8b6](https://github.com/terra-graph/conventions/commit/955c8b66eebbadc6663b771f12cad85830e29b59))
+* force release ([f53250c](https://github.com/terra-graph/conventions/commit/f53250ca7b027d453a63731782d627d24cfc2de9))
+* force release ([fd1b399](https://github.com/terra-graph/conventions/commit/fd1b3998f3015b791981ef4a99b253855938ef92))
+* force release ([b3c459b](https://github.com/terra-graph/conventions/commit/b3c459b97b1f6c9028a7a173a6a8a0ad0e6b9f20))
+* force release ([1b05e2b](https://github.com/terra-graph/conventions/commit/1b05e2b9e03f76d7fe22a80a2e80f519ac320bc6))
+* release ([ca16ba5](https://github.com/terra-graph/conventions/commit/ca16ba5293f7bbc38c80f93052f90942ddedc56d))
+* release ([a85626d](https://github.com/terra-graph/conventions/commit/a85626d70979d59aed9e1d77f4372bd7751b3984))
+* release ([4d150c0](https://github.com/terra-graph/conventions/commit/4d150c0c8eecac008b3ebba875663bfe7ab1e164))
+* release ([ac7c8e0](https://github.com/terra-graph/conventions/commit/ac7c8e0b22f852fcff331f79b11d3c044b51fcdd))
+* release ([af4d120](https://github.com/terra-graph/conventions/commit/af4d1204bbba1f950421d971bdddeb13f470f20c))
+* release ([80c26e0](https://github.com/terra-graph/conventions/commit/80c26e0c2bd43cd965c9a6537b6bf6fbb8be72cf))
+* release ([0e72f68](https://github.com/terra-graph/conventions/commit/0e72f687704df3a0edf1b4fb54b04e123030cd40))
+* release ([f996d7b](https://github.com/terra-graph/conventions/commit/f996d7b29190acfd575c2f01df6ac86f11f97871))
+* release ([ca0daff](https://github.com/terra-graph/conventions/commit/ca0daffdb70c7a5fe471114d5b7e03c4863fbc21))
+* release ([9c60c78](https://github.com/terra-graph/conventions/commit/9c60c780ae91fbde08f4d121871c73e4142dc910))
+* release ([7912dd5](https://github.com/terra-graph/conventions/commit/7912dd53c34009ad0008c4c4c4210730c78c32ae))
+* release ([24e33b6](https://github.com/terra-graph/conventions/commit/24e33b63d6c589fb7e36de9c127f3ece5889155f))
+* release ([54e836e](https://github.com/terra-graph/conventions/commit/54e836e6a8f5d8fd29fb3ed57bb5d0e83deb96f7))
+* update tests ([53d386c](https://github.com/terra-graph/conventions/commit/53d386ce82d78d1ce75c7cf88f63e09ee5840c75))
+
+# Changelog
+
+All notable changes to this package will be documented in this file.

package/README.md

@@ -0,0 +1,25 @@
+# @terra-graph/conventions-aws
+
+AWS convention/provider package for `terra-graph`.
+
+## Install
+
+```bash
+yarn add @terra-graph/conventions-aws
+```
+
+## API
+
+```ts
+import {
+  AWS_CONVENTION_PACKAGE,
+  AWS_CONVENTION_VERSION,
+  awsNamedRules,
+  awsNamedRuleSets,
+  awsProfiles,
+  awsPlugins,
+  awsConventionManifest,
+} from '@terra-graph/conventions-aws';
+```
+
+This package currently ships placeholder, serialization-safe convention assets and a manifest contract for future expansion.

package/dist/cjs/conventions/dataflow/profiles/base.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.conventionDataFlowBaseProfileName = void 0;
+const conventions_core_1 = require("@terra-graph/conventions-core");
+const core_1 = require("@terra-graph/core");
+const namespaces_js_1 = require("../../../namespaces.js");
+const AwsIam_js_1 = require("../../../plugins/AwsIam.js");
+const AwsS3_js_1 = require("../../../plugins/AwsS3.js");
+const index_js_1 = require("../../index.js");
+exports.conventionDataFlowBaseProfileName = (0, namespaces_js_1.conventionName)(index_js_1.Convention.DataFlow, (0, namespaces_js_1.profileName)('base'));
+exports.default = new core_1.Profile(exports.conventionDataFlowBaseProfileName, {
+    usesProfiles: [conventions_core_1.coreBase],
+    phases: [
+        {
+            phase: 'pre',
+            rules: [
+                new core_1.RemoveNode({
+                    node: {
+                        or: [
+                            {
+                                attr: {
+                                    key: 'terraform.resource',
+                                    startsWith: ['aws_kms_', 'aws_ssm_'],
+                                },
+                            },
+                            {
+                                attr: {
+                                    key: 'terraform.resource',
+                                    in: ['external', 'aws_caller_identity'],
+                                },
+                            },
+                        ],
+                    },
+                }),
+                // { namedRule: ruleName('log_groups.only_event_bridge') },
+                { namedRule: (0, namespaces_js_1.ruleName)('lambda.only_event_source_mapping') },
+            ],
+        },
+        {
+            phase: 'semantics',
+            rules: [{ namedRuleSet: (0, namespaces_js_1.conventionName)(index_js_1.Convention.DataFlow, (0, namespaces_js_1.ruleSetName)('semantics')) }],
+        },
+        {
+            phase: 'cleanup',
+            rules: [
+                // not sure this semantics re-run is needed?
+                { namedRuleSet: (0, namespaces_js_1.conventionName)(index_js_1.Convention.DataFlow, (0, namespaces_js_1.ruleSetName)('semantics')) },
+                { namedRuleSet: (0, namespaces_js_1.conventionName)(index_js_1.Convention.DataFlow, (0, namespaces_js_1.ruleSetName)('cleanup')) },
+            ],
+        },
+        {
+            phase: 'main',
+            rules: [
+            // TODO: ConvertNodeToEdge probably should apply some hints to the edge (converted node etc)
+            // new ConvertNodeToEdge({
+            //   node: {
+            //     attr: {
+            //       key: 'terraform.resource',
+            //       in: [
+            //         'aws_lambda_event_source_mapping',
+            //         'aws_cloudwatch_event_target',
+            //         'aws_cloudwatch_log_destination',
+            //       ],
+            //     },
+            //   },
+            // }),
+            ],
+        },
+    ],
+    plugins: [
+        { plugin: AwsS3_js_1.AwsS3.id },
+        {
+            plugin: AwsIam_js_1.AwsIamGraphPlugin.id,
+            options: { mode: 'full', removeOrphans: true },
+        },
+        // { plugin: 'aws.iam', options: { mode: 'full' } },
+        // {
+        //   plugin: 'aws.iam',
+        //   options: { mode: 'roles_policies', attachments: 'convert_to_edge' },
+        // }, // can't see any difference
+        // { plugin: 'aws.iam', options: { mode: 'full' } }, // shows everything as expected
+        // {
+        //   plugin: 'aws.iam',
+        //   options: {
+        //     mode: 'full',
+        //   },
+        // },
+    ],
+});

package/dist/cjs/conventions/dataflow/profiles/dot.js

@@ -0,0 +1,44 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.conventionDataFlowDotProfileName = void 0;
+const core_1 = require("@terra-graph/core");
+const namespaces_js_1 = require("../../../namespaces.js");
+const index_js_1 = require("../../index.js");
+const base_js_1 = __importDefault(require("./base.js"));
+exports.conventionDataFlowDotProfileName = (0, namespaces_js_1.conventionName)(index_js_1.Convention.DataFlow, (0, namespaces_js_1.profileName)('dot'));
+const baseDotProfile = new core_1.Profile('overview.dot', {
+    supports: core_1.DotAdapter,
+    render: {
+        options: {
+            graph: {
+                rankdir: 'LR',
+                ranksep: 2.5,
+                nodesep: 0.6,
+                pad: 1,
+            },
+        },
+    },
+    phases: [
+        {
+            phase: 'normalize',
+            rules: [{ namedRule: 'dot.normalise_modules' }],
+        },
+    ],
+});
+exports.default = new core_1.Profile(exports.conventionDataFlowDotProfileName, {
+    supports: core_1.DotAdapter,
+    usesProfiles: [base_js_1.default, baseDotProfile],
+    phases: [
+        {
+            phase: 'main',
+            rules: [
+                { namedRuleSet: (0, namespaces_js_1.ruleSetName)('dot.sqs.dlq') },
+                { namedRule: (0, namespaces_js_1.ruleName)('dot.schedule.align') },
+                { namedRule: (0, namespaces_js_1.ruleName)('dot.iam_role.align') },
+            ],
+        },
+    ],
+});

package/dist/cjs/conventions/dataflow/profiles/dot.test.js

@@ -0,0 +1,147 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@terra-graph/core");
+const index_js_1 = __importDefault(require("../../../index.js"));
+const namespaces_js_1 = require("../../../namespaces.js");
+const AwsIam_js_1 = require("../../../plugins/AwsIam.js");
+const AwsS3_js_1 = require("../../../plugins/AwsS3.js");
+const index_js_2 = require("../../index.js");
+const rules_js_1 = __importDefault(require("../rules.js"));
+const rulesets_js_1 = __importDefault(require("../rulesets.js"));
+const dot_js_1 = __importStar(require("./dot.js"));
+const baseNamedRules = new core_1.NamedRuleRegistry({
+    'remove.tfconfig': new core_1.RemoveNode({
+        node: {
+            or: [
+                {
+                    attr: {
+                        key: 'terraform.kind',
+                        in: ['local', 'var', 'terraform_data'],
+                    },
+                },
+                {
+                    attr: {
+                        key: 'terraform.resource',
+                        in: ['null_resource', 'local_file'],
+                    },
+                },
+            ],
+        },
+    }),
+    'reconnect.time_sleep': new core_1.RemoveNodeAndReconnectEdges({
+        node: {
+            attr: {
+                key: 'terraform.resource',
+                eq: 'time_sleep',
+            },
+        },
+    }),
+    'remove.childless_modules': new core_1.RemoveNode({
+        node: {
+            and: [{ attr: { key: 'terraform.kind', eq: 'module' } }, { children: { exists: false } }],
+        },
+    }),
+    'dot.normalise_modules': new core_1.NodeDotProperties({
+        options: {
+            peripheries: 0,
+            label: '',
+            height: 0,
+            width: 0,
+        },
+        node: {
+            attr: {
+                key: 'terraform.kind',
+                eq: 'module',
+            },
+        },
+    }),
+});
+const baseNamedRuleSets = new core_1.NamedRuleSetRegistry({});
+describe('data flow dot profile', () => {
+    it('shoud expose namespaced profile metadata and plugin refs', () => {
+        const serialized = dot_js_1.default.serialize();
+        expect(serialized.name).toBe(dot_js_1.conventionDataFlowDotProfileName);
+        expect(serialized.supports).toBe(core_1.DotAdapter.name);
+        expect(serialized.phases?.map((phase) => phase.phase)).toStrictEqual(['main']);
+        const baseProfile = serialized.usesProfiles?.[0];
+        expect(baseProfile?.phases?.map((phase) => phase.phase)).toStrictEqual([
+            'pre',
+            'semantics',
+            'cleanup',
+            'main',
+        ]);
+        expect(baseProfile?.plugins).toEqual([
+            { plugin: AwsS3_js_1.AwsS3.id },
+            {
+                plugin: AwsIam_js_1.AwsIamGraphPlugin.id,
+                options: { mode: 'full', removeOrphans: true },
+            },
+        ]);
+        expect(dot_js_1.conventionDataFlowDotProfileName).toBe((0, namespaces_js_1.conventionName)(index_js_2.Convention.DataFlow, (0, namespaces_js_1.profileName)('dot')));
+    });
+    it('shoud resolve phase plan with runtime provider registries', () => {
+        const runtime = (0, index_js_1.default)();
+        const runtimeNamedRules = runtime.namedRules;
+        const runtimeNamedRuleSets = runtime.namedRuleSets;
+        const runtimePlugins = runtime.plugins;
+        if (!runtimeNamedRules || !runtimeNamedRuleSets || !runtimePlugins) {
+            throw new Error('Runtime provider missing expected registries');
+        }
+        const namedRules = core_1.NamedRuleRegistry.from([baseNamedRules, runtimeNamedRules]);
+        const namedRuleSets = core_1.NamedRuleSetRegistry.from([baseNamedRuleSets, runtimeNamedRuleSets]);
+        const phases = dot_js_1.default.resolvePhases(namedRules, namedRuleSets, runtimePlugins);
+        expect(phases.length).toBeGreaterThan(4);
+        expect(phases.map((rules) => rules.some((rule) => rule.serialize().id === 'EdgeLegend'))).toContain(true);
+    });
+    it('shoud reference conventions rules and rule sets from the dataflow profile', () => {
+        const baseProfile = dot_js_1.default.serialize().usesProfiles?.[0];
+        const preRules = baseProfile?.phases?.[0]?.rules;
+        const mainRules = dot_js_1.default.serialize().phases?.[0]?.rules;
+        expect(preRules).toEqual(expect.arrayContaining([
+            expect.objectContaining({ id: 'RemoveNode' }),
+            { namedRule: (0, namespaces_js_1.ruleName)('lambda.only_event_source_mapping') },
+        ]));
+        expect(mainRules).toEqual(expect.arrayContaining([
+            { namedRuleSet: (0, namespaces_js_1.ruleSetName)('dot.sqs.dlq') },
+            { namedRule: (0, namespaces_js_1.ruleName)('dot.schedule.align') },
+        ]));
+        expect(rulesets_js_1.default.names()).toContain((0, namespaces_js_1.conventionName)(index_js_2.Convention.DataFlow, (0, namespaces_js_1.ruleSetName)('semantics')));
+        expect(rules_js_1.default.names()).toEqual([]);
+    });
+});

package/dist/cjs/conventions/dataflow/rules.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@terra-graph/core");
+exports.default = new core_1.NamedRuleRegistry({});

package/dist/cjs/conventions/dataflow/rules.test.js

@@ -0,0 +1,11 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const rules_js_1 = __importDefault(require("./rules.js"));
+describe('dataflow convention rules', () => {
+    it('shoud export an empty registry', () => {
+        expect(rules_js_1.default.names()).toEqual([]);
+    });
+});