aws-iam-managed-policies 0.0.3 → 0.0.6

package/README.md

@@ -1,5 +1,8 @@
 # aws-iam-managed-policies
-Automatically populated repository of AWS IAM Managed Policies, which also updates a npm package containing the full history of AWS IAM Managed Policies.
+Automatically populated (every morning at 6AM UTC) repository of AWS IAM Managed Policies, which also updates a npm package containing the full history of AWS IAM Managed Policies.
+
+## Data
+The raw IAM Managed Policies data can be found in the [data/json](https://github.com/tobilg/aws-iam-managed-policies/tree/main/data/json) directory. It is categorized by Managed Policy name and version id.
 
 ## Usage
 
@@ -11,5 +14,4 @@ npm i --save aws-iam-managed-policies
 ```
 
 ### API
-
-
+The API docs can be found at [https://tobilg.github.io/aws-iam-managed-policies](https://tobilg.github.io/aws-iam-managed-policies).

package/dist/index.d.ts

@@ -1,7 +1,34 @@
 import { ManagedPolicies, ManagedPolicy } from '../src/types';
+/**
+ * Retrieve a list of all included IAM Managed Polcies.
+ * @returns {Array} An array of IAM Managed Policy names.
+ */
 export declare const listPolicies: () => string[];
+/**
+ * Get the number of included IAM Managed Polcies.
+ * @returns {number} The count of IAM Managed Policies.
+ */
 export declare const getPolicyCount: () => number;
-export declare const getPolicyByName: (policyName: string) => ManagedPolicy | undefined;
-export declare const getLatestPolicyDocument: (policyName: string) => object | undefined;
-export declare const getPolicyDocumentByVersion: (policyName: string, policyVersion: number) => object | undefined;
+/**
+ * Get the IAM Managed Policy by name
+ * @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.
+ */
+export declare const getPolicyByName: (policyName: string) => ManagedPolicy;
+/**
+ * Get the latest policy document for a IAM Managed Policy by name
+ * @param {string} policyName The IAM Managed Policy name.
+ * @returns {object} The IAM Managed Policy document if found.
+ * @throws Will throw an error if not found by the name.
+ */
+export declare const getLatestPolicyDocument: (policyName: string) => object;
+/**
+ * Get the latest policy document for a IAM Managed Policy by name
+ * @param {string} policyName The IAM Managed Policy name.
+ * @param {number} policyVersion The version id of the IAM Managed Policy.
+ * @returns {object} The IAM Managed Policy document if found.
+ * @throws Will throw an error if not found by the name.
+ */
+export declare const getPolicyDocumentByVersion: (policyName: string, policyVersion: number) => object;
 export { ManagedPolicies, };

package/dist/index.js

@@ -9,18 +9,44 @@ var sortObjectByPropertyNames = function (obj) { return Object.keys(obj).sort().
     objEntries[key] = obj[key];
     return objEntries;
 }, {}); };
+/**
+ * Retrieve a list of all included IAM Managed Polcies.
+ * @returns {Array} An array of IAM Managed Policy names.
+ */
 var listPolicies = function () {
     return Object.keys(sortObjectByPropertyNames(managedPolicies_json_1.default));
 };
 exports.listPolicies = listPolicies;
+/**
+ * Get the number of included IAM Managed Polcies.
+ * @returns {number} The count of IAM Managed Policies.
+ */
 var getPolicyCount = function () {
     return Object.keys(managedPolicies_json_1.default).length;
 };
 exports.getPolicyCount = getPolicyCount;
+/**
+ * Get the IAM Managed Policy by name
+ * @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.
+ */
 var getPolicyByName = function (policyName) {
-    return managedPolicies_json_1.default[policyName];
+    var policy = managedPolicies_json_1.default[policyName];
+    if (policy) {
+        return policy;
+    }
+    else {
+        throw new Error("IAM Managed Policy '".concat(policyName, "' wasn't found!"));
+    }
 };
 exports.getPolicyByName = getPolicyByName;
+/**
+ * Get the latest policy document for a IAM Managed Policy by name
+ * @param {string} policyName The IAM Managed Policy name.
+ * @returns {object} The IAM Managed Policy document if found.
+ * @throws Will throw an error if not found by the name.
+ */
 var getLatestPolicyDocument = function (policyName) {
     var policy = managedPolicies_json_1.default[policyName];
     if (policy) {
@@ -28,17 +54,24 @@ var getLatestPolicyDocument = function (policyName) {
         return policy.versions[latestVersionId].document;
     }
     else {
-        return undefined;
+        throw new Error("IAM Managed Policy '".concat(policyName, "' wasn't found!"));
     }
 };
 exports.getLatestPolicyDocument = getLatestPolicyDocument;
+/**
+ * Get the latest policy document for a IAM Managed Policy by name
+ * @param {string} policyName The IAM Managed Policy name.
+ * @param {number} policyVersion The version id of the IAM Managed Policy.
+ * @returns {object} The IAM Managed Policy document if found.
+ * @throws Will throw an error if not found by the name.
+ */
 var getPolicyDocumentByVersion = function (policyName, policyVersion) {
     var policy = managedPolicies_json_1.default[policyName];
-    if (policy) {
+    if (policy && policy.versions[policyVersion]) {
         return policy.versions[policyVersion].document;
     }
     else {
-        return undefined;
+        throw new Error("IAM Managed Policy '".concat(policyName, "' wasn't found in version '").concat(policyVersion, "'!"));
     }
 };
 exports.getPolicyDocumentByVersion = getPolicyDocumentByVersion;