@ttoss/cloudformation 0.2.1 → 0.3.0

package/dist/esm/index.js

@@ -15,7 +15,7 @@ import * as path2 from "path";
 import * as fs from "fs";
 import * as path from "path";
 
-// src/cloudFormationTemplate.ts
+// src/cloudFormationYamlTemplate.ts
 import yaml from "js-yaml";
 var cloudFormationTypes = [
   {
@@ -172,6 +172,9 @@ var readObjectFile = ({ path: path3 }) => {
   if (extension === "ts") {
     __require("ts-node").register({
       compilerOptions: { module: "commonjs" },
+      moduleTypes: {
+        "carlin.*": "cjs"
+      },
       transpileOnly: true
     });
     const tsObj = __require(path3);
@@ -217,5 +220,6 @@ var findAndReadCloudFormationTemplate = ({
   return readObjectFile({ path: fullPath });
 };
 export {
-  findAndReadCloudFormationTemplate
+  findAndReadCloudFormationTemplate,
+  readObjectFile as unstable_readObjectFile
 };

package/dist/index.d.ts

@@ -5,6 +5,9 @@ interface Parameter {
     Type: string;
     NoEcho?: boolean;
 }
+type Parameters = {
+    [key: string]: Parameter;
+};
 interface Resource {
     Type: string;
     DeletionPolicy?: 'Delete' | 'Retain';
@@ -13,6 +16,39 @@ interface Resource {
     Condition?: string;
     Properties: any;
 }
+interface IAMRoleResource extends Resource {
+    Type: 'AWS::IAM::Role';
+    Properties: {
+        AssumeRolePolicyDocument: {
+            Version: '2012-10-17';
+            Statement: {
+                Effect: 'Allow' | 'Deny';
+                Action: string;
+                Principal: any;
+            }[];
+        };
+        ManagedPolicyArns?: string[];
+        Path?: string;
+        Policies?: {
+            PolicyName: string;
+            PolicyDocument: {
+                Version: '2012-10-17';
+                Statement: {
+                    Effect: 'Allow' | 'Deny';
+                    Action: string | string[];
+                    Resource: string | string[] | {
+                        [key: string]: string;
+                    } | {
+                        [key: string]: string;
+                    }[];
+                }[];
+            };
+        }[];
+    };
+}
+type Resources = {
+    [key: string]: IAMRoleResource | Resource;
+};
 type Output = {
     Description?: string;
     Value: string | any;
@@ -20,24 +56,26 @@ type Output = {
         Name: string | any;
     };
 };
-interface CloudFormationTemplate {
+type Outputs = {
+    [key: string]: Output;
+};
+type CloudFormationTemplate = {
     AWSTemplateFormatVersion: '2010-09-09';
+    Description?: string;
     Transform?: 'AWS::Serverless-2016-10-31';
     Mappings?: any;
     Conditions?: any;
-    Parameters?: {
-        [key: string]: Parameter;
-    };
-    Resources: {
-        [key: string]: Resource;
-    };
-    Outputs?: {
-        [key: string]: Output;
-    };
-}
+    Parameters?: Parameters;
+    Resources: Resources;
+    Outputs?: Outputs;
+};
 
 declare const findAndReadCloudFormationTemplate: ({ templatePath: defaultTemplatePath, }: {
     templatePath?: string;
 }) => CloudFormationTemplate;
 
-export { findAndReadCloudFormationTemplate };
+declare const readObjectFile: ({ path }: {
+    path: string;
+}) => any;
+
+export { CloudFormationTemplate, IAMRoleResource, Output, Outputs, Parameter, Parameters, Resource, Resources, findAndReadCloudFormationTemplate, readObjectFile as unstable_readObjectFile };

package/dist/index.js

@@ -27,7 +27,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
-  findAndReadCloudFormationTemplate: () => findAndReadCloudFormationTemplate
+  findAndReadCloudFormationTemplate: () => findAndReadCloudFormationTemplate,
+  unstable_readObjectFile: () => readObjectFile
 });
 module.exports = __toCommonJS(src_exports);
 
@@ -39,7 +40,7 @@ var path2 = __toESM(require("path"));
 var fs = __toESM(require("fs"));
 var path = __toESM(require("path"));
 
-// src/cloudFormationTemplate.ts
+// src/cloudFormationYamlTemplate.ts
 var import_js_yaml = __toESM(require("js-yaml"));
 var cloudFormationTypes = [
   {
@@ -196,6 +197,9 @@ var readObjectFile = ({ path: path3 }) => {
   if (extension === "ts") {
     require("ts-node").register({
       compilerOptions: { module: "commonjs" },
+      moduleTypes: {
+        "carlin.*": "cjs"
+      },
       transpileOnly: true
     });
     const tsObj = require(path3);
@@ -242,5 +246,6 @@ var findAndReadCloudFormationTemplate = ({
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  findAndReadCloudFormationTemplate
+  findAndReadCloudFormationTemplate,
+  unstable_readObjectFile
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ttoss/cloudformation",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "CloudFormation utils.",
   "license": "UNLICENSED",
   "author": "ttoss",
@@ -15,7 +15,7 @@
   ],
   "scripts": {
     "build": "tsup",
-    "test": "echo test"
+    "test": "jest"
   },
   "typings": "dist/index.d.ts",
   "dependencies": {
@@ -23,11 +23,14 @@
     "ts-node": "^10.9.1"
   },
   "devDependencies": {
-    "@ttoss/config": "^1.26.0"
+    "@ttoss/config": "^1.26.0",
+    "@ttoss/test-utils": "^1.20.0",
+    "@types/jest": "^29.2.4",
+    "jest": "^29.3.1"
   },
   "keywords": [],
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "98cf227311c2f28ab73520c793bfe0bf0df27530"
+  "gitHead": "f7fcb1caa22adf045f0ec7d15a678bfe48a3913d"
 }

package/src/CloudFormationTemplate.ts

@@ -0,0 +1,72 @@
+export interface Parameter {
+  AllowedValues?: string[];
+  Default?: string | number;
+  Description?: string;
+  Type: string;
+  NoEcho?: boolean;
+}
+
+export type Parameters = { [key: string]: Parameter };
+
+export interface Resource {
+  Type: string;
+  DeletionPolicy?: 'Delete' | 'Retain';
+  Description?: string;
+  DependsOn?: string[] | string;
+  Condition?: string;
+  Properties: any;
+}
+
+export interface IAMRoleResource extends Resource {
+  Type: 'AWS::IAM::Role';
+  Properties: {
+    AssumeRolePolicyDocument: {
+      Version: '2012-10-17';
+      Statement: {
+        Effect: 'Allow' | 'Deny';
+        Action: string;
+        Principal: any;
+      }[];
+    };
+    ManagedPolicyArns?: string[];
+    Path?: string;
+    Policies?: {
+      PolicyName: string;
+      PolicyDocument: {
+        Version: '2012-10-17';
+        Statement: {
+          Effect: 'Allow' | 'Deny';
+          Action: string | string[];
+          Resource:
+            | string
+            | string[]
+            | { [key: string]: string }
+            | { [key: string]: string }[];
+        }[];
+      };
+    }[];
+  };
+}
+
+export type Resources = { [key: string]: IAMRoleResource | Resource };
+
+export type Output = {
+  Description?: string;
+  Value: string | any;
+  Export?: {
+    Name: string | any;
+  };
+};
+
+export type Outputs = { [key: string]: Output };
+
+export type CloudFormationTemplate = {
+  AWSTemplateFormatVersion: '2010-09-09';
+  Description?: string;
+  Transform?: 'AWS::Serverless-2016-10-31';
+  Mappings?: any;
+  Conditions?: any;
+  Parameters?: Parameters;
+  Resources: Resources;
+  Outputs?: Outputs;
+};

package/src/{cloudFormationTemplate.ts → cloudFormationYamlTemplate.ts}

@@ -1,40 +1,6 @@
+import { CloudFormationTemplate } from './CloudFormationTemplate';
 import yaml from 'js-yaml';
 
-interface Parameter {
-  AllowedValues?: string[];
-  Default?: string | number;
-  Description?: string;
-  Type: string;
-  NoEcho?: boolean;
-}
-
-export interface Resource {
-  Type: string;
-  DeletionPolicy?: 'Delete' | 'Retain';
-  Description?: string;
-  DependsOn?: string[] | string;
-  Condition?: string;
-  Properties: any;
-}
-
-export type Output = {
-  Description?: string;
-  Value: string | any;
-  Export?: {
-    Name: string | any;
-  };
-};
-
-export interface CloudFormationTemplate {
-  AWSTemplateFormatVersion: '2010-09-09';
-  Transform?: 'AWS::Serverless-2016-10-31';
-  Mappings?: any;
-  Conditions?: any;
-  Parameters?: { [key: string]: Parameter };
-  Resources: { [key: string]: Resource };
-  Outputs?: { [key: string]: Output };
-}
-
 export interface TagAndType {
   tag: string;
   options: yaml.TypeConstructorOptions;

package/src/findAndReadCloudFormationTemplate.ts

@@ -1,6 +1,6 @@
 import * as fs from 'fs';
 import * as path from 'path';
-import { CloudFormationTemplate } from './cloudFormationTemplate';
+import { CloudFormationTemplate } from './CloudFormationTemplate';
 import { readCloudFormationYamlTemplate } from './readCloudFormationYamlTemplate';
 import { readObjectFile } from './readObjectFile';
 

package/src/index.ts

@@ -1 +1,7 @@
 export { findAndReadCloudFormationTemplate } from './findAndReadCloudFormationTemplate';
+export * from './CloudFormationTemplate';
+
+/**
+ * Unstable API.
+ */
+export { readObjectFile as unstable_readObjectFile } from './readObjectFile';

package/src/readCloudFormationYamlTemplate.ts

@@ -1,10 +1,10 @@
 import * as fs from 'fs';
 import * as path from 'path';
+import { CloudFormationTemplate } from './CloudFormationTemplate';
 import {
-  CloudFormationTemplate,
   TagAndType,
   loadCloudFormationTemplate,
-} from './cloudFormationTemplate';
+} from './cloudFormationYamlTemplate';
 
 const getTypes = (): TagAndType[] => {
   return [

package/src/readObjectFile.ts

@@ -7,13 +7,6 @@ export const readYaml = ({ path }: { path: string }) => {
   return yaml.load(template);
 };
 
-/**
- * If your file is `.ts`, you must you must export the final object
- * `export default { ... }`. If your file is `.js`, you must you must export
- * the final object `module.exports =  { ... }`. `.json` and `.yml/yaml` must
- * define the resources in [JSON](https://www.json.org/json-en.html) and
- * [YAML](https://yaml.org/) format respectively.
- */
 export const readObjectFile = ({ path }: { path: string }) => {
   if (!fs.existsSync(path)) {
     return {};
@@ -24,6 +17,9 @@ export const readObjectFile = ({ path }: { path: string }) => {
   if (extension === 'ts') {
     require('ts-node').register({
       compilerOptions: { module: 'commonjs' },
+      moduleTypes: {
+        'carlin.*': 'cjs',
+      },
       transpileOnly: true,
     });
     const tsObj = require(path);