@cloud-copilot/iam-policy 0.0.1 → 0.0.2

package/dist/statements/statement.d.ts

@@ -0,0 +1,146 @@
+import { Action } from "../actions/action.js";
+import { Condition } from "../conditions/condition.js";
+import { Principal } from "../principals/principal.js";
+import { Resource } from "../resources/resource.js";
+/**
+ * Represents a statement in an IAM policy
+ */
+export interface Statement {
+    /**
+     * The optional Sid (Statement ID) for a statement
+     */
+    sid(): string | undefined;
+    /**
+     * The effect of the statement, either 'Allow' or 'Deny'
+     */
+    effect(): string;
+    /**
+     * Is the statement an Allow statement
+     */
+    isAllow(): boolean;
+    /**
+     * Is the statement a Deny statement
+     */
+    isDeny(): boolean;
+    /**
+     * The conditions for the statement
+     */
+    conditions(): Condition[];
+    /**
+     * Does the statement have a Principal
+     */
+    isPrincipalStatement(): this is PrincipalStatement;
+    /**
+     * Does the statement have a NotPrincipal
+     */
+    isNotPrincipalStatement(): this is NotPrincipalStatement;
+    /**
+     * Does the statement have an Action
+     */
+    isActionStatement(): this is ActionStatement;
+    /**
+     * Does the statement have a NotAction
+     */
+    isNotActionStatement(): this is NotActionStatement;
+    /**
+     * Does the statement have a Resource
+     */
+    isResourceStatement(): this is ResourceStatement;
+    /**
+     * Does the statement have a NotResource
+     */
+    isNotResourceStatement(): this is NotResourceStatement;
+}
+/**
+ * Represents a statement in an IAM policy that has Action
+ */
+export interface ActionStatement extends Statement {
+    /**
+     * The actions for the statement
+     */
+    actions(): Action[];
+}
+/**
+ * Represents a statement in an IAM policy that has NotAction
+ */
+export interface NotActionStatement extends Statement {
+    /**
+     * The not actions for the statement
+     */
+    notActions(): Action[];
+}
+/**
+ * Represents a statement in an IAM policy that has Resource
+ */
+export interface ResourceStatement extends Statement {
+    /**
+     * The resources for the statement
+     */
+    resources(): Resource[];
+    /**
+     * Is the resource element exactly a single wildcard: `"*"`
+     */
+    hasSingleResourceWildcard(): boolean;
+}
+/**
+ * Represents a statement in an IAM policy that has NotResource
+ */
+export interface NotResourceStatement extends Statement {
+    /**
+     * The not resources for the statement
+     */
+    notResources(): Resource[];
+}
+/**
+ * Represents a statement in an IAM policy that has Principal
+ */
+export interface PrincipalStatement extends Statement {
+    /**
+     * The principals for the statement
+     */
+    principals(): Principal[];
+}
+/**
+ * Represents a statement in an IAM policy that has NotPrincipal
+ */
+export interface NotPrincipalStatement extends Statement {
+    /**
+     * The not principals for the statement
+     */
+    notPrincipals(): Principal[];
+}
+/**
+ * Implementation of the Statement interface and all its sub-interfaces
+ */
+export declare class StatementImpl implements Statement, ActionStatement, NotActionStatement, ResourceStatement, NotResourceStatement, PrincipalStatement {
+    private readonly statementObject;
+    constructor(statementObject: any);
+    sid(): string | undefined;
+    effect(): string;
+    isAllow(): boolean;
+    isDeny(): boolean;
+    isPrincipalStatement(): this is PrincipalStatement;
+    isNotPrincipalStatement(): this is NotPrincipalStatement;
+    principals(): Principal[];
+    notPrincipals(): Principal[];
+    /**
+     * Parse the principal object into PrincipalImpl objects.
+     *
+     * This is non trivial and we don't want to implement this in each function.
+     *
+     * @param principals the Principal or NotPrincipal object ot parse
+     * @returns the backing principals for a Principal or NotPrincipal object
+     */
+    private parsePrincipalObject;
+    isActionStatement(): this is ActionStatement;
+    isNotActionStatement(): this is NotActionStatement;
+    actions(): Action[];
+    notActions(): Action[];
+    isResourceStatement(): this is ResourceStatement;
+    isNotResourceStatement(): this is NotResourceStatement;
+    resources(): Resource[];
+    notResources(): Resource[];
+    hasSingleResourceWildcard(): boolean;
+    conditions(): Condition[];
+}
+//# sourceMappingURL=statement.d.ts.map

package/dist/statements/statement.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"statement.d.ts","sourceRoot":"","sources":["../../src/statements/statement.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAc,MAAM,sBAAsB,CAAA;AACzD,OAAO,EAAE,SAAS,EAAiB,MAAM,4BAA4B,CAAA;AACrE,OAAO,EAAE,SAAS,EAAgC,MAAM,4BAA4B,CAAA;AACpF,OAAO,EAAE,QAAQ,EAAgB,MAAM,0BAA0B,CAAA;AAEjE;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,GAAG,IAAI,MAAM,GAAG,SAAS,CAAA;IAEzB;;OAEG;IACH,MAAM,IAAI,MAAM,CAAA;IAEhB;;OAEG;IACH,OAAO,IAAI,OAAO,CAAA;IAElB;;OAEG;IACH,MAAM,IAAI,OAAO,CAAA;IAEjB;;OAEG;IACH,UAAU,IAAI,SAAS,EAAE,CAAA;IAEzB;;OAEG;IACH,oBAAoB,IAAI,IAAI,IAAI,kBAAkB,CAAA;IAElD;;OAEG;IACH,uBAAuB,IAAI,IAAI,IAAI,qBAAqB,CAAA;IAExD;;OAEG;IACH,iBAAiB,IAAI,IAAI,IAAI,eAAe,CAAA;IAE5C;;OAEG;IACH,oBAAoB,IAAI,IAAI,IAAI,kBAAkB,CAAA;IAElD;;OAEG;IACH,mBAAmB,IAAI,IAAI,IAAI,iBAAiB,CAAA;IAEhD;;OAEG;IACH,sBAAsB,IAAI,IAAI,IAAI,oBAAoB,CAAA;CACvD;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,SAAS;IAChD;;OAEG;IACH,OAAO,IAAI,MAAM,EAAE,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,SAAS;IAEnD;;OAEG;IACH,UAAU,IAAI,MAAM,EAAE,CAAA;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,SAAS;IAClD;;OAEG;IACH,SAAS,IAAI,QAAQ,EAAE,CAAA;IAEvB;;OAEG;IACH,yBAAyB,IAAI,OAAO,CAAA;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,SAAS;IACrD;;OAEG;IACH,YAAY,IAAI,QAAQ,EAAE,CAAA;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,SAAS;IACnD;;OAEG;IACH,UAAU,IAAI,SAAS,EAAE,CAAA;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,SAAS;IAEtD;;OAEG;IACH,aAAa,IAAI,SAAS,EAAE,CAAA;CAC7B;AAED;;GAEG;AACH,qBAAa,aAAc,YAAW,SAAS,EAAE,eAAe,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,kBAAkB;IACnI,OAAO,CAAC,QAAQ,CAAC,eAAe;gBAAf,eAAe,EAAE,GAAG;IAE1C,GAAG,IAAI,MAAM,GAAG,SAAS;IAIzB,MAAM,IAAI,MAAM;IAIhB,OAAO,IAAI,OAAO;IAIlB,MAAM,IAAI,OAAO;IAIjB,oBAAoB,IAAI,IAAI,IAAI,kBAAkB;IAIlD,uBAAuB,IAAI,IAAI,IAAI,qBAAqB;IAIxD,UAAU,IAAI,SAAS,EAAE;IAOzB,aAAa,IAAI,SAAS,EAAE;IAOnC;;;;;;;OAOG;IACH,OAAO,CAAC,oBAAoB;IAcrB,iBAAiB,IAAI,IAAI,IAAI,eAAe;IAI5C,oBAAoB,IAAI,IAAI,IAAI,kBAAkB;IAIlD,OAAO,IAAI,MAAM,EAAE;IAOnB,UAAU,IAAI,MAAM,EAAE;IAOtB,mBAAmB,IAAI,IAAI,IAAI,iBAAiB;IAIhD,sBAAsB,IAAI,IAAI,IAAI,oBAAoB;IAItD,SAAS,IAAI,QAAQ,EAAE;IAOvB,YAAY,IAAI,QAAQ,EAAE;IAO1B,yBAAyB,IAAI,OAAO;IAOpC,UAAU,IAAI,SAAS,EAAE;CAWjC"}

package/dist/statements/statement.js

@@ -0,0 +1,121 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StatementImpl = void 0;
+const action_js_1 = require("../actions/action.js");
+const condition_js_1 = require("../conditions/condition.js");
+const principal_js_1 = require("../principals/principal.js");
+const resource_js_1 = require("../resources/resource.js");
+/**
+ * Implementation of the Statement interface and all its sub-interfaces
+ */
+class StatementImpl {
+    statementObject;
+    constructor(statementObject) {
+        this.statementObject = statementObject;
+    }
+    sid() {
+        return this.statementObject.Sid;
+    }
+    effect() {
+        return this.statementObject.Effect;
+    }
+    isAllow() {
+        return this.effect() === 'Allow';
+    }
+    isDeny() {
+        return this.effect() === 'Deny';
+    }
+    isPrincipalStatement() {
+        return this.statementObject.Principal !== undefined;
+    }
+    isNotPrincipalStatement() {
+        return this.statementObject.NotPrincipal !== undefined;
+    }
+    principals() {
+        if (!this.isPrincipalStatement()) {
+            throw new Error('Called principals on a statement without Principal, use isPrincipalStatement before calling principals');
+        }
+        return this.parsePrincipalObject(this.statementObject.Principal);
+    }
+    notPrincipals() {
+        if (!this.isNotPrincipalStatement()) {
+            throw new Error('Called notPrincipals on a statement without NotPrincipal, use isNotPrincipalStatement before calling notPrincipals');
+        }
+        return this.parsePrincipalObject(this.statementObject.NotPrincipal);
+    }
+    /**
+     * Parse the principal object into PrincipalImpl objects.
+     *
+     * This is non trivial and we don't want to implement this in each function.
+     *
+     * @param principals the Principal or NotPrincipal object ot parse
+     * @returns the backing principals for a Principal or NotPrincipal object
+     */
+    parsePrincipalObject(principals) {
+        if (typeof principals === 'string') {
+            return [new principal_js_1.PrincipalImpl('AWS', principals)];
+        }
+        return Object.entries(principals).map(([principalType, principalValue]) => {
+            if (typeof principalValue === 'string') {
+                return new principal_js_1.PrincipalImpl(principalType, principalValue);
+            }
+            return Object.entries(principalValue).map(([key, value]) => {
+                return new principal_js_1.PrincipalImpl(principalType, value);
+            });
+        }).flat();
+    }
+    isActionStatement() {
+        return this.statementObject.Action !== undefined;
+    }
+    isNotActionStatement() {
+        return this.statementObject.NotAction !== undefined;
+    }
+    actions() {
+        if (!this.isActionStatement()) {
+            throw new Error('Called actions on a statement without Action, use isActionStatement before calling actions');
+        }
+        return [this.statementObject.Action].flat().map((action) => new action_js_1.ActionImpl(action));
+    }
+    notActions() {
+        if (!this.isNotActionStatement()) {
+            throw new Error('Called notActions on a statement without NotAction, use isNotActionStatement before calling notActions');
+        }
+        return [this.statementObject.NotAction].flat().map((action) => new action_js_1.ActionImpl(action));
+    }
+    isResourceStatement() {
+        return this.statementObject.Resource !== undefined;
+    }
+    isNotResourceStatement() {
+        return this.statementObject.NotResource !== undefined;
+    }
+    resources() {
+        if (!this.isResourceStatement()) {
+            throw new Error('Called resources on a statement without Resource, use isResourceStatement before calling resources');
+        }
+        return [this.statementObject.Resource].flat().map((resource) => new resource_js_1.ResourceImpl(resource));
+    }
+    notResources() {
+        if (!this.isNotResourceStatement()) {
+            throw new Error('Called notResources on a statement without NotResource, use isNotResourceStatement before calling notResources');
+        }
+        return [this.statementObject.NotResource].flat().map((resource) => new resource_js_1.ResourceImpl(resource));
+    }
+    hasSingleResourceWildcard() {
+        if (!this.isResourceStatement()) {
+            throw new Error('Called hasSingleResourceWildcard on a statement without Resource, use isResourceStatement before calling hasSingleResourceWildcard');
+        }
+        return this.isResourceStatement() && this.statementObject.Resource === '*';
+    }
+    conditions() {
+        if (!this.statementObject.Condition) {
+            return [];
+        }
+        return Object.entries(this.statementObject.Condition).map(([opKey, opValue]) => {
+            return Object.entries(opValue).map(([condKey, condValue]) => {
+                return new condition_js_1.ConditionImpl(opKey, condKey, condValue);
+            });
+        }).flat();
+    }
+}
+exports.StatementImpl = StatementImpl;
+//# sourceMappingURL=statement.js.map

package/dist/statements/statement.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"statement.js","sourceRoot":"","sources":["../../src/statements/statement.ts"],"names":[],"mappings":";;;AAAA,oDAAyD;AACzD,6DAAqE;AACrE,6DAAoF;AACpF,0DAAiE;AAiIjE;;GAEG;AACH,MAAa,aAAa;IACK;IAA7B,YAA6B,eAAoB;QAApB,oBAAe,GAAf,eAAe,CAAK;IAAG,CAAC;IAE9C,GAAG;QACR,OAAO,IAAI,CAAC,eAAe,CAAC,GAAG,CAAA;IACjC,CAAC;IAEM,MAAM;QACX,OAAO,IAAI,CAAC,eAAe,CAAC,MAAM,CAAA;IACpC,CAAC;IAEM,OAAO;QACZ,OAAO,IAAI,CAAC,MAAM,EAAE,KAAK,OAAO,CAAA;IAClC,CAAC;IAEM,MAAM;QACX,OAAO,IAAI,CAAC,MAAM,EAAE,KAAK,MAAM,CAAA;IACjC,CAAC;IAEM,oBAAoB;QACzB,OAAO,IAAI,CAAC,eAAe,CAAC,SAAS,KAAK,SAAS,CAAC;IACtD,CAAC;IAEM,uBAAuB;QAC5B,OAAO,IAAI,CAAC,eAAe,CAAC,YAAY,KAAK,SAAS,CAAC;IACzD,CAAC;IAEM,UAAU;QACf,IAAG,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,wGAAwG,CAAC,CAAA;QAC3H,CAAC;QACD,OAAO,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAA;IAClE,CAAC;IAEM,aAAa;QAClB,IAAG,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,oHAAoH,CAAC,CAAA;QACvI,CAAC;QACD,OAAO,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,CAAA;IACrE,CAAC;IAED;;;;;;;OAOG;IACK,oBAAoB,CAAC,UAAe;QAC1C,IAAG,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;YAClC,OAAO,CAAC,IAAI,4BAAa,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,CAAA;QAC/C,CAAC;QACD,OAAO,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,aAAa,EAAE,cAAc,CAAC,EAAE,EAAE;YACxE,IAAG,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;gBACtC,OAAO,IAAI,4BAAa,CAAC,aAA8B,EAAE,cAAc,CAAC,CAAA;YAC1E,CAAC;YACD,OAAO,MAAM,CAAC,OAAO,CAAC,cAAqB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;gBAChE,OAAO,IAAI,4BAAa,CAAC,aAA8B,EAAE,KAAe,CAAC,CAAA;YAC3E,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;IACX,CAAC;IAEM,iBAAiB;QACtB,OAAO,IAAI,CAAC,eAAe,CAAC,MAAM,KAAK,SAAS,CAAC;IACnD,CAAC;IAEM,oBAAoB;QACzB,OAAO,IAAI,CAAC,eAAe,CAAC,SAAS,KAAK,SAAS,CAAC;IACtD,CAAC;IAEM,OAAO;QACZ,IAAG,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,4FAA4F,CAAC,CAAA;QAC/G,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,MAAW,EAAE,EAAE,CAAC,IAAI,sBAAU,CAAC,MAAM,CAAC,CAAC,CAAA;IAC1F,CAAC;IAEM,UAAU;QACf,IAAG,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,wGAAwG,CAAC,CAAA;QAC3H,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,MAAW,EAAE,EAAE,CAAC,IAAI,sBAAU,CAAC,MAAM,CAAC,CAAC,CAAA;IAC7F,CAAC;IAEM,mBAAmB;QACxB,OAAO,IAAI,CAAC,eAAe,CAAC,QAAQ,KAAK,SAAS,CAAC;IACrD,CAAC;IAEM,sBAAsB;QAC3B,OAAO,IAAI,CAAC,eAAe,CAAC,WAAW,KAAK,SAAS,CAAC;IACxD,CAAC;IAEM,SAAS;QACd,IAAG,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,oGAAoG,CAAC,CAAA;QACvH,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,QAAa,EAAE,EAAE,CAAC,IAAI,0BAAY,CAAC,QAAQ,CAAC,CAAC,CAAA;IAClG,CAAC;IAEM,YAAY;QACjB,IAAG,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,gHAAgH,CAAC,CAAA;QACnI,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,QAAa,EAAE,EAAE,CAAC,IAAI,0BAAY,CAAC,QAAQ,CAAC,CAAC,CAAA;IACrG,CAAC;IAEM,yBAAyB;QAC9B,IAAG,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,oIAAoI,CAAC,CAAA;QACvJ,CAAC;QACD,OAAO,IAAI,CAAC,mBAAmB,EAAE,IAAI,IAAI,CAAC,eAAe,CAAC,QAAQ,KAAK,GAAG,CAAA;IAC5E,CAAC;IAEM,UAAU;QACf,IAAG,CAAC,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,CAAC;YACnC,OAAO,EAAE,CAAA;QACX,CAAC;QAED,OAAO,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,EAAE;YAC7E,OAAO,MAAM,CAAC,OAAO,CAAC,OAAc,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,EAAE;gBACjE,OAAO,IAAI,4BAAa,CAAC,KAAK,EAAE,OAAO,EAAE,SAA8B,CAAC,CAAA;YAC1E,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;IACX,CAAC;CACF;AA7HD,sCA6HC"}

package/dist/statements/statement.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=statement.test.d.ts.map

package/dist/statements/statement.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"statement.test.d.ts","sourceRoot":"","sources":["../../src/statements/statement.test.ts"],"names":[],"mappings":""}