@ttoss/cloudformation 0.10.9 → 0.10.10

package/dist/esm/index.js

@@ -0,0 +1,194 @@
+/** Powered by @ttoss/config. https://ttoss.dev/docs/modules/packages/config/ */
+
+// src/findAndReadCloudFormationTemplate.ts
+import * as fs2 from "node:fs";
+import * as path2 from "node:path";
+
+// src/readCloudFormationYamlTemplate.ts
+import * as fs from "fs";
+import * as path from "path";
+
+// src/cloudFormationYamlTemplate.ts
+import yaml from "js-yaml";
+var cloudFormationTypes = [{
+  tag: "!Equals",
+  options: {
+    kind: "sequence",
+    construct: data => {
+      return {
+        "Fn::Equals": data
+      };
+    }
+  }
+}, {
+  tag: "!FindInMap",
+  options: {
+    kind: "sequence",
+    construct: data => {
+      return {
+        "Fn::FindInMap": data
+      };
+    }
+  }
+}, {
+  tag: "!GetAtt",
+  options: {
+    kind: "scalar",
+    construct: data => {
+      return {
+        "Fn::GetAtt": data.split(".")
+      };
+    }
+  }
+}, {
+  tag: "!GetAtt",
+  options: {
+    kind: "sequence",
+    construct: data => {
+      return {
+        "Fn::GetAtt": data
+      };
+    }
+  }
+}, {
+  tag: "!If",
+  options: {
+    kind: "sequence",
+    construct: data => {
+      return {
+        "Fn::If": data
+      };
+    }
+  }
+}, {
+  tag: "!ImportValue",
+  options: {
+    kind: "scalar",
+    construct: data => {
+      return {
+        "Fn::ImportValue": data
+      };
+    }
+  }
+}, {
+  tag: "!Join",
+  options: {
+    kind: "sequence",
+    construct: data => {
+      return {
+        "Fn::Join": data
+      };
+    }
+  }
+}, {
+  tag: "!Not",
+  options: {
+    kind: "sequence",
+    construct: data => {
+      return {
+        "Fn::Not": data
+      };
+    }
+  }
+}, {
+  tag: "!Ref",
+  options: {
+    kind: "scalar",
+    construct: data => {
+      return {
+        Ref: data
+      };
+    }
+  }
+}, {
+  tag: "!Sub",
+  options: {
+    kind: "scalar",
+    construct: data => {
+      return {
+        "Fn::Sub": data
+      };
+    }
+  }
+}, {
+  tag: "!Sub",
+  options: {
+    kind: "sequence",
+    construct: data => {
+      return {
+        "Fn::Sub": data
+      };
+    }
+  }
+}];
+var getYamlTypes = tagAndTypeArr => {
+  return tagAndTypeArr.map(({
+    tag,
+    options
+  }) => {
+    return new yaml.Type(tag, options);
+  });
+};
+var getSchema = (tagAndTypeArr = []) => {
+  return yaml.DEFAULT_SCHEMA.extend(getYamlTypes([...tagAndTypeArr, ...cloudFormationTypes]));
+};
+var loadCloudFormationTemplate = (template, tagAndTypeArr = []) => {
+  return yaml.load(template, {
+    schema: getSchema(tagAndTypeArr)
+  });
+};
+
+// src/readCloudFormationYamlTemplate.ts
+var getTypes = () => {
+  return [{
+    tag: `!SubString`,
+    options: {
+      kind: "scalar",
+      construct: filePath => {
+        return fs.readFileSync(path.resolve(process.cwd(), filePath)).toString();
+      }
+    }
+  }];
+};
+var readCloudFormationYamlTemplate = ({
+  templatePath
+}) => {
+  const template = fs.readFileSync(templatePath).toString();
+  const parsed = loadCloudFormationTemplate(template, getTypes());
+  if (!parsed || typeof parsed === "string") {
+    throw new Error("Cannot parse CloudFormation template.");
+  }
+  return parsed;
+};
+
+// src/findAndReadCloudFormationTemplate.ts
+import { readConfigFile } from "@ttoss/read-config-file";
+var defaultTemplatePaths = ["ts", "js", "yaml", "yml", "json"].map(extension => {
+  return `./src/cloudformation.${extension}`;
+});
+var findAndReadCloudFormationTemplate = async ({
+  templatePath: defaultTemplatePath,
+  options = {}
+}) => {
+  const templatePath = defaultTemplatePath || defaultTemplatePaths.reduce((acc, cur) => {
+    if (acc) {
+      return acc;
+    }
+    return fs2.existsSync(path2.resolve(process.cwd(), cur)) ? cur : acc;
+  }, "");
+  if (!templatePath) {
+    throw new Error("Cannot find a CloudFormation template.");
+  }
+  const extension = templatePath?.split(".").pop();
+  if (["yaml", "yml"].includes(extension)) {
+    return readCloudFormationYamlTemplate({
+      templatePath
+    });
+  }
+  const configFilePath = path2.resolve(process.cwd(), templatePath);
+  return readConfigFile({
+    configFilePath,
+    options
+  });
+};
+export { findAndReadCloudFormationTemplate };

package/dist/index.d.cts

@@ -0,0 +1,84 @@
+type Parameter = {
+    AllowedValues?: string[];
+    Default?: string | number;
+    Description?: string;
+    Type: string;
+    NoEcho?: boolean;
+};
+type Parameters = {
+    [key: string]: Parameter;
+};
+type Resource = {
+    Type: string;
+    DeletionPolicy?: 'Delete' | 'Retain';
+    Description?: string;
+    DependsOn?: string[] | string;
+    Condition?: string;
+    Properties: any;
+};
+type Policy = {
+    PolicyName: string;
+    PolicyDocument: {
+        Version: '2012-10-17';
+        Statement: {
+            Sid?: string;
+            Effect: 'Allow' | 'Deny';
+            Action: string | string[];
+            Resource: string | string[] | {
+                [key: string]: any;
+            } | {
+                [key: string]: any;
+            }[];
+        }[];
+    };
+};
+type IAMRoleResource = Resource & {
+    Type: 'AWS::IAM::Role';
+    Properties: {
+        AssumeRolePolicyDocument: {
+            Version: '2012-10-17';
+            Statement: {
+                Effect: 'Allow' | 'Deny';
+                Action: string;
+                Principal: any;
+                Condition?: {
+                    [key: string]: any;
+                };
+            }[];
+        };
+        ManagedPolicyArns?: string[];
+        Path?: string;
+        Policies?: Policy[];
+    };
+};
+type Resources = {
+    [key: string]: IAMRoleResource | Resource;
+};
+type Output = {
+    Description?: string;
+    Value: string | any;
+    Export?: {
+        Name: string | any;
+    };
+};
+type Outputs = {
+    [key: string]: Output;
+};
+type CloudFormationTemplate = {
+    AWSTemplateFormatVersion: '2010-09-09';
+    Metadata?: any;
+    Description?: string;
+    Transform?: 'AWS::Serverless-2016-10-31';
+    Mappings?: any;
+    Conditions?: any;
+    Parameters?: Parameters;
+    Resources: Resources;
+    Outputs?: Outputs;
+};
+
+declare const findAndReadCloudFormationTemplate: ({ templatePath: defaultTemplatePath, options, }: {
+    templatePath?: string;
+    options?: unknown;
+}) => Promise<CloudFormationTemplate>;
+
+export { type CloudFormationTemplate, type IAMRoleResource, type Output, type Outputs, type Parameter, type Parameters, type Policy, type Resource, type Resources, findAndReadCloudFormationTemplate };

package/dist/index.d.ts

@@ -0,0 +1,84 @@
+type Parameter = {
+    AllowedValues?: string[];
+    Default?: string | number;
+    Description?: string;
+    Type: string;
+    NoEcho?: boolean;
+};
+type Parameters = {
+    [key: string]: Parameter;
+};
+type Resource = {
+    Type: string;
+    DeletionPolicy?: 'Delete' | 'Retain';
+    Description?: string;
+    DependsOn?: string[] | string;
+    Condition?: string;
+    Properties: any;
+};
+type Policy = {
+    PolicyName: string;
+    PolicyDocument: {
+        Version: '2012-10-17';
+        Statement: {
+            Sid?: string;
+            Effect: 'Allow' | 'Deny';
+            Action: string | string[];
+            Resource: string | string[] | {
+                [key: string]: any;
+            } | {
+                [key: string]: any;
+            }[];
+        }[];
+    };
+};
+type IAMRoleResource = Resource & {
+    Type: 'AWS::IAM::Role';
+    Properties: {
+        AssumeRolePolicyDocument: {
+            Version: '2012-10-17';
+            Statement: {
+                Effect: 'Allow' | 'Deny';
+                Action: string;
+                Principal: any;
+                Condition?: {
+                    [key: string]: any;
+                };
+            }[];
+        };
+        ManagedPolicyArns?: string[];
+        Path?: string;
+        Policies?: Policy[];
+    };
+};
+type Resources = {
+    [key: string]: IAMRoleResource | Resource;
+};
+type Output = {
+    Description?: string;
+    Value: string | any;
+    Export?: {
+        Name: string | any;
+    };
+};
+type Outputs = {
+    [key: string]: Output;
+};
+type CloudFormationTemplate = {
+    AWSTemplateFormatVersion: '2010-09-09';
+    Metadata?: any;
+    Description?: string;
+    Transform?: 'AWS::Serverless-2016-10-31';
+    Mappings?: any;
+    Conditions?: any;
+    Parameters?: Parameters;
+    Resources: Resources;
+    Outputs?: Outputs;
+};
+
+declare const findAndReadCloudFormationTemplate: ({ templatePath: defaultTemplatePath, options, }: {
+    templatePath?: string;
+    options?: unknown;
+}) => Promise<CloudFormationTemplate>;
+
+export { type CloudFormationTemplate, type IAMRoleResource, type Output, type Outputs, type Parameter, type Parameters, type Policy, type Resource, type Resources, findAndReadCloudFormationTemplate };

package/dist/index.js

@@ -0,0 +1,239 @@
+/** Powered by @ttoss/config. https://ttoss.dev/docs/modules/packages/config/ */
+"use strict";
+
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all) __defProp(target, name, {
+    get: all[name],
+    enumerable: true
+  });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from)) if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+      get: () => from[key],
+      enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+    });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+// If the importer is in node compatibility mode or this is not an ESM
+// file that has been converted to a CommonJS file using a Babel-
+// compatible transform (i.e. "__esModule" has not been set), then set
+// "default" to the CommonJS "module.exports" for node compatibility.
+isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+  value: mod,
+  enumerable: true
+}) : target, mod));
+var __toCommonJS = mod => __copyProps(__defProp({}, "__esModule", {
+  value: true
+}), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  findAndReadCloudFormationTemplate: () => findAndReadCloudFormationTemplate
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/findAndReadCloudFormationTemplate.ts
+var fs2 = __toESM(require("fs"), 1);
+var path2 = __toESM(require("path"), 1);
+
+// src/readCloudFormationYamlTemplate.ts
+var fs = __toESM(require("fs"), 1);
+var path = __toESM(require("path"), 1);
+
+// src/cloudFormationYamlTemplate.ts
+var import_js_yaml = __toESM(require("js-yaml"), 1);
+var cloudFormationTypes = [{
+  tag: "!Equals",
+  options: {
+    kind: "sequence",
+    construct: data => {
+      return {
+        "Fn::Equals": data
+      };
+    }
+  }
+}, {
+  tag: "!FindInMap",
+  options: {
+    kind: "sequence",
+    construct: data => {
+      return {
+        "Fn::FindInMap": data
+      };
+    }
+  }
+}, {
+  tag: "!GetAtt",
+  options: {
+    kind: "scalar",
+    construct: data => {
+      return {
+        "Fn::GetAtt": data.split(".")
+      };
+    }
+  }
+}, {
+  tag: "!GetAtt",
+  options: {
+    kind: "sequence",
+    construct: data => {
+      return {
+        "Fn::GetAtt": data
+      };
+    }
+  }
+}, {
+  tag: "!If",
+  options: {
+    kind: "sequence",
+    construct: data => {
+      return {
+        "Fn::If": data
+      };
+    }
+  }
+}, {
+  tag: "!ImportValue",
+  options: {
+    kind: "scalar",
+    construct: data => {
+      return {
+        "Fn::ImportValue": data
+      };
+    }
+  }
+}, {
+  tag: "!Join",
+  options: {
+    kind: "sequence",
+    construct: data => {
+      return {
+        "Fn::Join": data
+      };
+    }
+  }
+}, {
+  tag: "!Not",
+  options: {
+    kind: "sequence",
+    construct: data => {
+      return {
+        "Fn::Not": data
+      };
+    }
+  }
+}, {
+  tag: "!Ref",
+  options: {
+    kind: "scalar",
+    construct: data => {
+      return {
+        Ref: data
+      };
+    }
+  }
+}, {
+  tag: "!Sub",
+  options: {
+    kind: "scalar",
+    construct: data => {
+      return {
+        "Fn::Sub": data
+      };
+    }
+  }
+}, {
+  tag: "!Sub",
+  options: {
+    kind: "sequence",
+    construct: data => {
+      return {
+        "Fn::Sub": data
+      };
+    }
+  }
+}];
+var getYamlTypes = tagAndTypeArr => {
+  return tagAndTypeArr.map(({
+    tag,
+    options
+  }) => {
+    return new import_js_yaml.default.Type(tag, options);
+  });
+};
+var getSchema = (tagAndTypeArr = []) => {
+  return import_js_yaml.default.DEFAULT_SCHEMA.extend(getYamlTypes([...tagAndTypeArr, ...cloudFormationTypes]));
+};
+var loadCloudFormationTemplate = (template, tagAndTypeArr = []) => {
+  return import_js_yaml.default.load(template, {
+    schema: getSchema(tagAndTypeArr)
+  });
+};
+
+// src/readCloudFormationYamlTemplate.ts
+var getTypes = () => {
+  return [{
+    tag: `!SubString`,
+    options: {
+      kind: "scalar",
+      construct: filePath => {
+        return fs.readFileSync(path.resolve(process.cwd(), filePath)).toString();
+      }
+    }
+  }];
+};
+var readCloudFormationYamlTemplate = ({
+  templatePath
+}) => {
+  const template = fs.readFileSync(templatePath).toString();
+  const parsed = loadCloudFormationTemplate(template, getTypes());
+  if (!parsed || typeof parsed === "string") {
+    throw new Error("Cannot parse CloudFormation template.");
+  }
+  return parsed;
+};
+
+// src/findAndReadCloudFormationTemplate.ts
+var import_read_config_file = require("@ttoss/read-config-file");
+var defaultTemplatePaths = ["ts", "js", "yaml", "yml", "json"].map(extension => {
+  return `./src/cloudformation.${extension}`;
+});
+var findAndReadCloudFormationTemplate = async ({
+  templatePath: defaultTemplatePath,
+  options = {}
+}) => {
+  const templatePath = defaultTemplatePath || defaultTemplatePaths.reduce((acc, cur) => {
+    if (acc) {
+      return acc;
+    }
+    return fs2.existsSync(path2.resolve(process.cwd(), cur)) ? cur : acc;
+  }, "");
+  if (!templatePath) {
+    throw new Error("Cannot find a CloudFormation template.");
+  }
+  const extension = templatePath?.split(".").pop();
+  if (["yaml", "yml"].includes(extension)) {
+    return readCloudFormationYamlTemplate({
+      templatePath
+    });
+  }
+  const configFilePath = path2.resolve(process.cwd(), templatePath);
+  return (0, import_read_config_file.readConfigFile)({
+    configFilePath,
+    options
+  });
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  findAndReadCloudFormationTemplate
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ttoss/cloudformation",
-  "version": "0.10.9",
+  "version": "0.10.10",
   "description": "CloudFormation utils.",
   "author": "ttoss",
   "contributors": [
@@ -24,7 +24,7 @@
   ],
   "dependencies": {
     "js-yaml": "^4.1.0",
-    "@ttoss/read-config-file": "^2.0.2"
+    "@ttoss/read-config-file": "^2.0.3"
   },
   "devDependencies": {
     "@types/jest": "^29.5.13",
@@ -32,8 +32,8 @@
     "@types/node": "^20.16.1",
     "jest": "^29.7.0",
     "tsup": "^8.3.0",
-    "@ttoss/config": "^1.33.0",
-    "@ttoss/test-utils": "^2.1.15"
+    "@ttoss/test-utils": "^2.1.16",
+    "@ttoss/config": "^1.34.0"
   },
   "keywords": [],
   "publishConfig": {