aws-iam-managed-policies 0.0.6 → 0.0.7

package/dist/index.d.ts

@@ -10,7 +10,7 @@ export declare const listPolicies: () => string[];
  */
 export declare const getPolicyCount: () => number;
 /**
- * Get the IAM Managed Policy by name
+ * Get the IAM Managed Policy by name with the full version history
  * @param {string} policyName The IAM Managed Policy name.
  * @returns {object} The IAM Managed Policy if found.
  * @throws Will throw an error if not found by the name.
@@ -31,4 +31,13 @@ export declare const getLatestPolicyDocument: (policyName: string) => object;
  * @throws Will throw an error if not found by the name.
  */
 export declare const getPolicyDocumentByVersion: (policyName: string, policyVersion: number) => object;
+/**
+ * Get a diff of the policy documents for two versions of a IAM Managed Policy
+ * @param {string} policyName The IAM Managed Policy name.
+ * @param {number} oldPolicyVersion The old version id of the IAM Managed Policy.
+ * @param {number} newPolicyVersion The new version id of the IAM Managed Policy.
+ * @returns {object} The diff of the IAM Managed Policy document versions if found.
+ * @throws Will throw an error if not found by the name or the respective policy document versions.
+ */
+export declare const getPolicyDiffByVersions: (policyName: string, oldPolicyVersion: number, newPolicyVersion: number) => object;
 export { ManagedPolicies, };

package/dist/index.js

@@ -3,7 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPolicyDocumentByVersion = exports.getLatestPolicyDocument = exports.getPolicyByName = exports.getPolicyCount = exports.listPolicies = void 0;
+exports.getPolicyDiffByVersions = exports.getPolicyDocumentByVersion = exports.getLatestPolicyDocument = exports.getPolicyByName = exports.getPolicyCount = exports.listPolicies = void 0;
+var deep_object_diff_1 = require("deep-object-diff");
 var managedPolicies_json_1 = __importDefault(require("./managedPolicies.json"));
 var sortObjectByPropertyNames = function (obj) { return Object.keys(obj).sort().reduce(function (objEntries, key) {
     objEntries[key] = obj[key];
@@ -26,7 +27,7 @@ var getPolicyCount = function () {
 };
 exports.getPolicyCount = getPolicyCount;
 /**
- * Get the IAM Managed Policy by name
+ * Get the IAM Managed Policy by name with the full version history
  * @param {string} policyName The IAM Managed Policy name.
  * @returns {object} The IAM Managed Policy if found.
  * @throws Will throw an error if not found by the name.
@@ -67,11 +68,35 @@ exports.getLatestPolicyDocument = getLatestPolicyDocument;
  */
 var getPolicyDocumentByVersion = function (policyName, policyVersion) {
     var policy = managedPolicies_json_1.default[policyName];
-    if (policy && policy.versions[policyVersion]) {
-        return policy.versions[policyVersion].document;
+    if (policy && policy.versions["v".concat(policyVersion)]) {
+        return policy.versions["v".concat(policyVersion)].document;
     }
     else {
         throw new Error("IAM Managed Policy '".concat(policyName, "' wasn't found in version '").concat(policyVersion, "'!"));
     }
 };
 exports.getPolicyDocumentByVersion = getPolicyDocumentByVersion;
+/**
+ * Get a diff of the policy documents for two versions of a IAM Managed Policy
+ * @param {string} policyName The IAM Managed Policy name.
+ * @param {number} oldPolicyVersion The old version id of the IAM Managed Policy.
+ * @param {number} newPolicyVersion The new version id of the IAM Managed Policy.
+ * @returns {object} The diff of the IAM Managed Policy document versions if found.
+ * @throws Will throw an error if not found by the name or the respective policy document versions.
+ */
+var getPolicyDiffByVersions = function (policyName, oldPolicyVersion, newPolicyVersion) {
+    var policy = managedPolicies_json_1.default[policyName];
+    if (policy) {
+        if (!policy.versions["v".concat(oldPolicyVersion)]) {
+            throw new Error("IAM Managed Policy '".concat(policyName, "' wasn't found in version '").concat(oldPolicyVersion, "'!"));
+        }
+        if (!policy.versions["v".concat(newPolicyVersion)]) {
+            throw new Error("IAM Managed Policy '".concat(policyName, "' wasn't found in version '").concat(newPolicyVersion, "'!"));
+        }
+        return (0, deep_object_diff_1.detailedDiff)(policy.versions["v".concat(oldPolicyVersion)].document, policy.versions["v".concat(newPolicyVersion)].document);
+    }
+    else {
+        throw new Error("IAM Managed Policy '".concat(policyName, "' wasn't found!"));
+    }
+};
+exports.getPolicyDiffByVersions = getPolicyDiffByVersions;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aws-iam-managed-policies",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "Provides AWS IAM Managed Policies historical data as a convenient npm package that can be used in other OSS projects.",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -41,5 +41,8 @@
     "p-limit": "3.1.0",
     "ts-node": "^10.9.1",
     "typescript": "^5.1.6"
+  },
+  "dependencies": {
+    "deep-object-diff": "^1.1.9"
   }
 }