@znemz/cft-utils 0.0.5-0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Nicholas McCready
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,39 @@
+# cft-utils
+
+This projects goal is to provide information and capabilities of what AWS Cloudformation
+actually provides. There are many missing gaps and this library intends to fill them. The
+original goal of this library is to identify all AWS Resources which are actually Taggable via
+a Cloudformation Template.
+
+Note: the first time the library is run it processes the aws-cd-lib for taggable resources. This
+is then cached inside of `./src/cache/*.json` .
+
+## install
+
+`npm i --save @znemz/cft-utils`
+
+## SDK
+
+```js
+const lib = require('@znemz/cft-utils');
+(async () => 
+  console.log(await lib.resources.taggable.getResources())
+  console.log(await lib.resources.taggable.getResourceMap())
+
+  await lib.resources.taggable.isTaggableResource('AWS::IAM::Role') // true
+)();
+```
+
+## CLI Tools
+
+```bash
+$ ./bin/taggableResourceMap.js
+{"AWS::AccessAnalyzer::Analyzer":true,"AWS::ACMPCA::CertificateAuthority":true,"AWS::AmazonMQ::Broker":true,"AWS::AmazonMQ::Configuration":true,"AWS::Amplify::App":true,"AWS::Amplify::Branch":true,"AWS::AmplifyUIBuilder::Component":true,"AWS::AmplifyUIBuilder::Form":true,"AWS::AmplifyUIBuilder::Theme":true,"AWS::ApiGatewayV2::Api":true,"AWS::ApiGatewayV2::DomainName":true,"AWS::ApiGatewayV2::Stage":true,"AWS::ApiGatewayV2::VpcLink":true,"AWS::AppConfig::Extension":true,
+... more items
+```
+
+```bash
+$ ./bin/taggableResources.js
+["AWS::AccessAnalyzer::Analyzer","AWS::ACMPCA::CertificateAuthority","AWS::AmazonMQ::Broker","AWS::AmazonMQ::Configuration","AWS::Amplify::App","AWS::Amplify::Branch","AWS::AmplifyUIBuilder::Component","AWS::AmplifyUIBuilder::Form","AWS::AmplifyUIBuilder::Theme",
+... more items
+```

package/bin/taggableResourceMap.js

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+const taggable = require('../src/resources/taggable');
+
+(async () => {
+  const _map = await taggable.getResourceMap();
+  process.stdout.write(`${JSON.stringify(_map)}\n`);
+})();

package/bin/taggableResources.js

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+const taggable = require('../src/resources/taggable');
+
+(async () => {
+  const resouces = await taggable.getResources();
+  process.stdout.write(`${JSON.stringify(resouces)}\n`);
+})();

package/debug.js

@@ -0,0 +1,3 @@
+const { name } = require('./package.json');
+
+module.exports = require('debug-fabulous').spawnable(name);

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@znemz/cft-utils",
+  "version": "0.0.5-0",
+  "description": "AWS CFT Utilities to fill the gaps for Cloud Formation",
+  "keywords": [
+    "cft",
+    "aws",
+    "cloudformation"
+  ],
+  "homepage": "https://github.com/nmccready/cft-utils#readme",
+  "bugs": {
+    "url": "https://github.com/nmccready/cft-utils/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nmccready/cft-utils.git"
+  },
+  "author": "Nicholas McCready",
+  "main": "src/index.js",
+  "bin": {
+    "taggableResourceMap.js": "./bin/taggableResourceMap.js",
+    "taggableResources.js": "./bin/taggableResources.js"
+  },
+  "files": [
+    "src/**/*.js",
+    "src/**/*.json",
+    "*.js",
+    "!commitlint.config.js",
+    "!jest*.js",
+    "!.*.js"
+  ],
+  "scripts": {
+    "lint": "eslint .",
+    "prepack": "./bin/taggableResourceMap.js && ./bin/taggableResources.js",
+    "prepare": "skip-npm-task -t prepare sort-package-json",
+    "test": "mocha --timeout 20000 --bail ./src/**/*.test.js",
+    "unused:dependencies": "depcheck --ignore-bin-package --ignores @znemz/skip-npm-task,sort-package-json"
+  },
+  "dependencies": {
+    "debug-fabulous": "2.0.2",
+    "globby": "11.1.0"
+  },
+  "devDependencies": {
+    "@znemz/skip-npm-task": "0.1.0",
+    "aws-cdk-lib": "2",
+    "commit-and-tag-version": "12",
+    "commitlint": "19",
+    "depcheck": "1.4.7",
+    "eslint": "8",
+    "eslint-config-prettier": "9",
+    "eslint-config-standard": "17",
+    "eslint-plugin-mocha": "10",
+    "eslint-plugin-prettier": "5",
+    "mocha": "10",
+    "sort-package-json": "1.42"
+  }
+}