{"_id":"@horietakehiro/aws-cdk-utul","_rev":"170-f24dad9004d94568cc64fa06b7f37992","name":"@horietakehiro/aws-cdk-utul","dist-tags":{"latest":"0.41.86"},"versions":{"0.1.1":{"name":"@horietakehiro/aws-cdk-utul","version":"0.1.1","license":"MIT","_id":"@horietakehiro/aws-cdk-utul@0.1.1","maintainers":[{"name":"horietakehiro","email":"nashhoward1312@docomo.ne.jp"}],"dist":{"shasum":"7b308820fb1677345fe5e9400ad49cc572e89806","tarball":"https://registry.npmjs.org/@horietakehiro/aws-cdk-utul/-/aws-cdk-utul-0.1.1.tgz","fileCount":2624,"integrity":"sha512-/QoAvfBeALBKBA+MNBRe841tEFIBwdPdlINk4xo+xXqRcLzAUknKyTEQ+aeb76SovLnWpWUA69QLi2lfQhR2tQ==","signatures":[{"sig":"MEQCIBd0sZ6RD+fo04VeDeJpfV1QH+Q7ieOW+U8TmdCj8G27AiA0fCzT7qwsjp2CMgKNvKquAP1rrZUDxJDBAHvqxmuwOw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":10890146},"main":"src/index.js","types":"src/index.d.ts","gitHead":"2c68ba91e9e91935142a2198b5770173f238aa76","scripts":{"cdk":"cdk","test":"jest","build":"tsc","watch":"tsc -w"},"_npmUser":{"name":"horietakehiro","email":"nashhoward1312@docomo.ne.jp"},"repository":{"url":"","type":"git"},"_npmVersion":"10.2.4","description":"This is a blank project for CDK development with TypeScript.","directories":{},"_nodeVersion":"20.11.1","dependencies":{"constructs":"^10.0.0","decompress":"^4.2.1","node-fetch":"^2.7.0","aws-cdk-lib":"2.X.0","@types/decompress":"^4.2.7","@types/node-fetch":"^2.6.11","https-proxy-agent":"^7.0.5","source-map-support":"^0.5.21","json-schema-to-typescript":"^15.0.2"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^29.7.0","aws-cdk":"2.131.0","ts-jest":"^29.1.2","ts-node":"^10.9.2","typescript":"~5.3.3","@types/jest":"^29.5.12","@types/node":"^20.11.19"},"_npmOperationalInternal":{"tmp":"tmp/aws-cdk-utul_0.1.1_1727053478513_0.2910591183575386","host":"s3://npm-registry-packages"}},"0.2.1":{"name":"@horietakehiro/aws-cdk-utul","version":"0.2.1","license":"MIT","_id":"@horietakehiro/aws-cdk-utul@0.2.1","maintainers":[{"name":"horietakehiro","email":"nashhoward1312@docomo.ne.jp"}],"homepage":"https://github.com/horietakehiro/aws-cdk-utul#readme","bugs":{"url":"https://github.com/horietakehiro/aws-cdk-utul/issues"},"dist":{"shasum":"49220bfe5f2583a49a3e3a94b964ce6332e19bfa","tarball":"https://registry.npmjs.org/@horietakehiro/aws-cdk-utul/-/aws-cdk-utul-0.2.1.tgz","fileCount":2625,"integrity":"sha512-QgfS+J0kQvOsA6lBu+sgCovSyALAG3gx0WYWyizDJFcDWdzFvKy2K23I7BV0ORSzMqNEoWXpTUwwk5ZjSbwJ0Q==","signatures":[{"sig":"MEQCIGehQI//1ZafNU8PCm+W+TfgTSE7TttPtF9cwOpOkV48AiBhIcSXecpAi9klb3JAWEWARx0nV0Gr5WdxTu8p5pxTGg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":10891312},"main":"index.js","types":"index.d.ts","scripts":{"cdk":"cdk","test":"jest","build":"tsc","watch":"tsc -w"},"_npmUser":{"name":"horietakehiro","email":"nashhoward1312@docomo.ne.jp"},"repository":{"url":"git+https://github.com/horietakehiro/aws-cdk-utul.git","type":"git"},"_npmVersion":"10.7.0","description":"This is a blank project for CDK development with TypeScript.","directories":{},"_nodeVersion":"20.14.0","dependencies":{"constructs":"^10.0.0","decompress":"^4.2.1","node-fetch":"^2.7.0","aws-cdk-lib":"2.X.0","@types/decompress":"^4.2.7","@types/node-fetch":"^2.6.11","https-proxy-agent":"^7.0.5","source-map-support":"^0.5.21","json-schema-to-typescript":"^15.0.2"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^29.7.0","aws-cdk":"2.131.0","ts-jest":"^29.1.2","ts-node":"^10.9.2","typescript":"~5.3.3","@types/jest":"^29.5.12","@types/node":"^20.11.19"},"_npmOperationalInternal":{"tmp":"tmp/aws-cdk-utul_0.2.1_1727071084251_0.02165333989682172","host":"s3://npm-registry-packages"}},"0.2.2":{"name":"@horietakehiro/aws-cdk-utul","version":"0.2.2","license":"MIT","_id":"@horietakehiro/aws-cdk-utul@0.2.2","maintainers":[{"name":"horietakehiro","email":"nashhoward1312@docomo.ne.jp"}],"homepage":"https://github.com/horietakehiro/aws-cdk-utul#readme","bugs":{"url":"https://github.com/horietakehiro/aws-cdk-utul/issues"},"dist":{"shasum":"06e31fcb2641ab8ae31e8c10c34db114bd7b2409","tarball":"https://registry.npmjs.org/@horietakehiro/aws-cdk-utul/-/aws-cdk-utul-0.2.2.tgz","fileCount":2625,"integrity":"sha512-rGVWplMaEJy/M3wTB+dZt1J7XEiHFdWsaLS0G2rULGxoQ1LwJJBG//jQ4yYI9cqEwDoGeKgBZz7cTgmTX7gGBw==","signatures":[{"sig":"MEYCIQDD7R1vu370OfN0jZFR7hHkWMlb5JkqOJ/lZF54LqxgjQIhALcu1Zt/OYdSF8v9+bTENTDtl6mztqxOkItnwKiHB0uG","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":10891312},"main":"index.js","types":"index.d.ts","scripts":{"cdk":"cdk","test":"jest","build":"tsc","watch":"tsc -w"},"_npmUser":{"name":"horietakehiro","email":"nashhoward1312@docomo.ne.jp"},"repository":{"url":"git+https://github.com/horietakehiro/aws-cdk-utul.git","type":"git"},"_npmVersion":"10.7.0","description":"This is a blank project for CDK development with TypeScript.","directories":{},"_nodeVersion":"20.14.0","dependencies":{"constructs":"^10.0.0","decompress":"^4.2.1","node-fetch":"^2.7.0","aws-cdk-lib":"2.X.0","@types/decompress":"^4.2.7","@types/node-fetch":"^2.6.11","https-proxy-agent":"^7.0.5","source-map-support":"^0.5.21","json-schema-to-typescript":"^15.0.2"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^29.7.0","aws-cdk":"2.131.0","ts-jest":"^29.1.2","ts-node":"^10.9.2","typescript":"~5.3.3","@types/jest":"^29.5.12","@types/node":"^20.11.19"},"_npmOperationalInternal":{"tmp":"tmp/aws-cdk-utul_0.2.2_1727071639680_0.38940710395736633","host":"s3://npm-registry-packages"}},"0.9.0":{"name":"@horietakehiro/aws-cdk-utul","version":"0.9.0","license":"MIT","_id":"@horietakehiro/aws-cdk-utul@0.9.0","maintainers":[{"name":"horietakehiro","email":"nashhoward1312@docomo.ne.jp"}],"homepage":"https://github.com/horietakehiro/aws-cdk-utul#readme","bugs":{"url":"https://github.com/horietakehiro/aws-cdk-utul/issues"},"dist":{"shasum":"671442dda7a8e65afe8d93f36a5eefd8758773b5","tarball":"https://registry.npmjs.org/@horietakehiro/aws-cdk-utul/-/aws-cdk-utul-0.9.0.tgz","fileCount":2626,"integrity":"sha512-TfO90m3sMPXIy/QGvdhiPJ7z+DM/v2IdG/8ghmq3SD2PrFHD2mkoliH9vfXG3DSNC1hzPfOrETpjA2+lfYH9ng==","signatures":[{"sig":"MEUCIQCvS8S0uuruyk93j2Z2UViYrSNRlswbK3LKERoLelB7lQIgfLo7YsrIr+WyIYloZCGvEpbV8ieZ5o7VqPrknH/r7S8=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":11019707},"main":"index.js","types":"index.d.ts","scripts":{"cdk":"cdk","test":"jest","build":"tsc","watch":"tsc -w"},"_npmUser":{"name":"horietakehiro","email":"nashhoward1312@docomo.ne.jp"},"repository":{"url":"git+https://github.com/horietakehiro/aws-cdk-utul.git","type":"git"},"_npmVersion":"10.7.0","description":"
\n\n**aws-cdk-utul(unit test utility library) makes it faster, more efficient with less mistakes for you to code AWS CDK unit tests.**\n\n---\n\n## Features\n\n---\n\n### TypedTemplate\n\n`TypedTemplate` class provides you proper type definitions for (almost) all AWS CloudFormation resource types. So you can easily and quickly code AWS CDK unit tests without trivial mistakes and googling.\n\n\n\n\n- You can use all methods implemented by AWS CDK's `Template` class with proper type definitions.\n- Return values of some methods - e.g. `findResources` - are changed from original ones, so that succeeding processes can handle and access them more easily.\n- You can still use AWS CDK's `Matcher` class and other arbitrary objects too.\n\n```js\nimport { Stack } from \"aws-cdk-lib\";\nimport { TypedTemplate } from \"@horietakehiro/aws-cdk-utul/lib/assertions\";\nimport { AWS_EC2_SUBNET, AWS_EC2_VPC } from \"@horietakehiro/aws-cdk-utul/lib/types/cfn-resource-types\";\nconst stack = new Stack()\n\nconst template = TypedTemplate.fromStack(stack)\n// you can execute all method implemented in original `Template` instance\ntemplate.hasResource(AWS_EC2_VPC({Properties: {\n CidrBlock: \"10.0.0.0/16\"\n}}))\n// you can still use original `Matcher` class too.\nconst subnets = template.findResources(AWS_EC2_SUBNET({Properties: {\n Tags: Match.arrayWith([\n {Key: \"Name\", Value: Match.stringLikeRegexp(\"Public\")}\n ])\n}}))\n// you can access resources with more efficient way\nsubnets.forEach((sn) => { \n expect(sn.def.Properties?.CidrBlock?.endsWith(\"/24\")).toBe(true)\n})\n```\n\n---\n\n### ExtraMatch\n\n`ExtraMatch` class provides you some kind of a syntax sugar for AWS CDK's `Match` class.\n\n```js\nimport { ExtraMatch } from \"@horietakehiro/aws-cdk-utul/lib/assertions\"\n// get just vpc's logical id\nconst [{id}] = template.findResources(AWS_EC2_VPC({}))\ntemplate.allResources(AWS_EC2_SUBNET({\n // Equals to {VpcId: {Ref: id}}\n Properties: {VpcId: ExtraMatch.ref(id)}\n}))\ntemplate.hasOutput(\"VPCARN\", {\n // Equals to {Value: {\"Fn::GetAtt\": [id, \"Arn\"]}}\n Value: ExtraMatch.getAttArn(id)\n})\n```\n\n`ExtraMatch.iamPolicyLike` method provides schemas for [IAM Policy document](https://docs.aws.amazon.com/ja_jp/IAM/latest/UserGuide/reference_policies_grammar.html) - it's useful when defining tests for `AWS::IAM::Policy` and `AWS::IAM::Role`\n\n\n\n---\n\n`ExtraMatch.{arrayWith,arrayLike,objectLike,objectEquals,not,exact}` are same method as those of `Match` class but additionally provide type hints. These are useful to type-safely use `Matcher`\n\n\n\n\n\n---\n\n## Install\n\n```bash\nnpm install @horietakehiro/aws-cdk-utul\n```\n\nBy default, you may feel difficult to use this library because import path is too long for type hits to fit in IDE dialog box like below.\n\n\n\nSo I recommend that you add module alias settings in your `tsconfig.json` file like below.\n\n```json\n{\n \"compilerOptions\": {\n \"baseUrl\": \".\",\n \"paths\": {\n \"@/cfn-types\": [\"node_modules/@horietakehiro/aws-cdk-utul/lib/types/cfn-resource-types\"],\n \"@/cfn-types/*\": [\"node_modules/@horietakehiro/aws-cdk-utul/lib/types/cfn-resource-types/*\"]\n }\n }\n}\n```\n\n\n\n---\n\n## Release policy\n\nThis package will be released new version every 3 days, so that catching up updates of AWS CloudFormation resource types and those schemas which will be happened frequently and irregularly.\n\n---\n\n\n## Some other notes\n\n- Schemas of AWS CloudFormation resource types used in this library are based on [those at `us-east-1`](https://docs.aws.amazon.com/ja_jp/AWSCloudFormation/latest/UserGuide/resource-type-schemas.html)\n- Compatible with AWS CDK v2.0.0 or greater.\n","readmeFilename":"README.md"}
![\"NPM](\"https://img.shields.io/npm/v/%40horietakehiro%2Faws-cdk-utul\")