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

package/dist/esm/rules/general.test.js

@@ -0,0 +1,42 @@
+import { ruleName } from '../namespaces.js';
+import generalRules from './general.js';
+const serialize = (name) => {
+    return generalRules.resolve(name).serialize();
+};
+describe('general rules', () => {
+    it('shoud expose all general named rules', () => {
+        expect(generalRules.names().sort()).toStrictEqual([
+            ruleName('data.remove'),
+            ruleName('lambda.only_event_source_mapping'),
+            ruleName('log_groups.only_event_bridge'),
+        ].sort());
+    });
+    it('shoud remove data nodes except policy artifacts by default', () => {
+        expect(serialize(ruleName('data.remove'))).toStrictEqual({
+            id: 'RemoveNode',
+            config: {
+                node: {
+                    or: [
+                        {
+                            and: [
+                                { attr: { key: 'terraform.kind', eq: 'data' } },
+                                {
+                                    not: {
+                                        attr: {
+                                            key: 'terraform.resource',
+                                            in: ['aws_iam_policy_document', 'aws_iam_policy'],
+                                        },
+                                    },
+                                },
+                            ],
+                        },
+                    ],
+                },
+            },
+        });
+    });
+    it('shoud remove non-event-bridge log groups and non-core lambda resources by query', () => {
+        expect(serialize(ruleName('log_groups.only_event_bridge')).id).toBe('RemoveNode');
+        expect(serialize(ruleName('lambda.only_event_source_mapping')).id).toBe('RemoveNode');
+    });
+});

package/dist/esm/rulesets/dot.d.ts

@@ -0,0 +1,3 @@
+import { NamedRuleSetRegistry } from '@terra-graph/core';
+declare const _default: NamedRuleSetRegistry;
+export default _default;

package/dist/esm/rulesets/dot.js

@@ -0,0 +1,23 @@
+import { EdgeLegend, NamedRuleSetRegistry, RuleSet } from '@terra-graph/core';
+import { ruleName, ruleSetName } from '../namespaces.js';
+export default new NamedRuleSetRegistry({
+    [ruleSetName('dot.sqs.dlq')]: new RuleSet({
+        rules: [
+            { namedRule: ruleName('dot.sqs.dlq.align') },
+            new EdgeLegend({
+                options: {
+                    colour: '#c20202',
+                    title: 'SQS dead letters / failures',
+                },
+                edge: {
+                    from: {
+                        attr: { key: 'terraform.resource', eq: 'aws_sqs_queue' },
+                    },
+                    to: {
+                        attr: { key: 'terraform.resource', eq: 'aws_sqs_queue' },
+                    },
+                },
+            }),
+        ],
+    }),
+});

package/dist/esm/rulesets/dot.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/esm/rulesets/dot.test.js

@@ -0,0 +1,43 @@
+import { ruleSetName } from '../namespaces.js';
+import dotRules from '../rules/dot.js';
+import dotRuleSet from './dot.js';
+describe('dot rule sets', () => {
+    it('shoud expose the SQS dead-letter rule set', () => {
+        const name = ruleSetName('dot.sqs.dlq');
+        expect(dotRuleSet.names()).toEqual([name]);
+        const resolved = dotRuleSet.resolve(name);
+        const phases = resolved.resolvePhases(dotRules);
+        expect(phases).toHaveLength(1);
+        expect(phases[0]).toHaveLength(2);
+        expect(phases[0][0].serialize()).toStrictEqual({
+            id: 'AlignNodes',
+            config: {
+                edge: {
+                    from: {
+                        attr: { key: 'terraform.resource', eq: 'aws_sqs_queue' },
+                    },
+                    to: {
+                        attr: { key: 'terraform.resource', eq: 'aws_sqs_queue' },
+                    },
+                },
+            },
+        });
+        expect(phases[0][1]).toMatchObject({
+            serialize: expect.any(Function),
+        });
+        expect(phases[0][1].serialize().id).toBe('EdgeLegend');
+        expect(phases[0][1].serialize().config.options).toMatchObject({
+            colour: '#c20202',
+            title: 'SQS dead letters / failures',
+        });
+        const edgeLegend = phases[0][1].serialize();
+        if (!('edge' in edgeLegend.config)) {
+            throw new Error('Expected EdgeLegend to provide an edge config');
+        }
+        expect(edgeLegend.config.edge).toMatchObject({
+            from: {
+                attr: { key: 'terraform.resource', eq: 'aws_sqs_queue' },
+            },
+        });
+    });
+});

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@terra-graph/conventions-aws",
+  "version": "1.0.0-rc.1",
+  "description": "AWS convention assets for terra-graph",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/terra-graph/conventions"
+  },
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/esm/index.d.ts",
+  "type": "module",
+  "files": [
+    "dist",
+    "CHANGELOG.md",
+    "README.md"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/esm/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js",
+      "default": "./dist/esm/index.js"
+    }
+  },
+  "scripts": {
+    "prebuild": "yarn workspace @terra-graph/conventions-core build",
+    "build": "rm -rf dist && tsc -p tsconfig.json && tsc -p tsconfig-commonjs.json && echo '{\"type\":\"commonjs\"}' > dist/cjs/package.json",
+    "test": "jest --config jest.config.cjs --coverage",
+    "semantic-release": "semantic-release"
+  },
+  "peerDependencies": {
+    "@terra-graph/core": "^1.0.0-rc.4"
+  },
+  "devDependencies": {
+    "@terra-graph/core": "^1.0.0-rc.4"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@terra-graph/conventions-core": "^1.0.0-rc.3"
+  }
+}