@composurecdk/dynamodb 0.8.7 → 0.9.0

package/dist/commonjs/grants.d.ts

@@ -0,0 +1,23 @@
+import type { ITable } from "aws-cdk-lib/aws-dynamodb";
+import type { IGrantable } from "aws-cdk-lib/aws-iam";
+import { type Grant, type Resolvable } from "@composurecdk/core";
+/**
+ * Consumer-side grant helpers for a DynamoDB table. Pass one to a grantee
+ * builder's `grant(...)` — e.g.
+ * `role.grant(tableGrants.readWrite(ref("table", (r) => r.table)))`.
+ *
+ * `ITable` is implemented by both `Table` and `TableV2`, so these helpers serve
+ * either builder's result. Each delegates to the table's native `grant*Data`
+ * method. See ADR-0013.
+ */
+export declare const tableGrants: {
+    /** Read access (`dynamodb:GetItem`, `Query`, `Scan`, …). */
+    read: (table: Resolvable<ITable>) => Grant<IGrantable>;
+    /** Write access (`dynamodb:PutItem`, `UpdateItem`, `DeleteItem`, …). */
+    write: (table: Resolvable<ITable>) => Grant<IGrantable>;
+    /** Combined read and write access. */
+    readWrite: (table: Resolvable<ITable>) => Grant<IGrantable>;
+    /** Full access to the table and its indexes (`dynamodb:*`). */
+    fullAccess: (table: Resolvable<ITable>) => Grant<IGrantable>;
+};
+//# sourceMappingURL=grants.d.ts.map

package/dist/commonjs/grants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"grants.d.ts","sourceRoot":"","sources":["../../src/grants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,KAAK,KAAK,EAAY,KAAK,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAQ3E;;;;;;;;GAQG;AACH,eAAO,MAAM,WAAW;IACtB,4DAA4D;kBAbpD,UAAU,CAAC,MAAM,CAAC,KAAG,KAAK,CAAC,UAAU,CAAC;IAiB9C,wEAAwE;mBAjBhE,UAAU,CAAC,MAAM,CAAC,KAAG,KAAK,CAAC,UAAU,CAAC;IAqB9C,sCAAsC;uBArB9B,UAAU,CAAC,MAAM,CAAC,KAAG,KAAK,CAAC,UAAU,CAAC;IAyB9C,+DAA+D;wBAzBvD,UAAU,CAAC,MAAM,CAAC,KAAG,KAAK,CAAC,UAAU,CAAC;CA6B/C,CAAC"}

package/dist/commonjs/grants.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tableGrants = void 0;
+const core_1 = require("@composurecdk/core");
+/** Wraps one of {@link ITable}'s native grant methods as a capability helper. */
+const capability = (apply) => (table) => (0, core_1.grantVia)(table, apply);
+/**
+ * Consumer-side grant helpers for a DynamoDB table. Pass one to a grantee
+ * builder's `grant(...)` — e.g.
+ * `role.grant(tableGrants.readWrite(ref("table", (r) => r.table)))`.
+ *
+ * `ITable` is implemented by both `Table` and `TableV2`, so these helpers serve
+ * either builder's result. Each delegates to the table's native `grant*Data`
+ * method. See ADR-0013.
+ */
+exports.tableGrants = {
+    /** Read access (`dynamodb:GetItem`, `Query`, `Scan`, …). */
+    read: capability((table, grantee) => {
+        table.grantReadData(grantee);
+    }),
+    /** Write access (`dynamodb:PutItem`, `UpdateItem`, `DeleteItem`, …). */
+    write: capability((table, grantee) => {
+        table.grantWriteData(grantee);
+    }),
+    /** Combined read and write access. */
+    readWrite: capability((table, grantee) => {
+        table.grantReadWriteData(grantee);
+    }),
+    /** Full access to the table and its indexes (`dynamodb:*`). */
+    fullAccess: capability((table, grantee) => {
+        table.grantFullAccess(grantee);
+    }),
+};
+//# sourceMappingURL=grants.js.map

package/dist/commonjs/grants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"grants.js","sourceRoot":"","sources":["../../src/grants.ts"],"names":[],"mappings":";;;AAEA,6CAA2E;AAE3E,iFAAiF;AACjF,MAAM,UAAU,GACd,CAAC,KAAmD,EAAE,EAAE,CACxD,CAAC,KAAyB,EAAqB,EAAE,CAC/C,IAAA,eAAQ,EAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAE3B;;;;;;;;GAQG;AACU,QAAA,WAAW,GAAG;IACzB,4DAA4D;IAC5D,IAAI,EAAE,UAAU,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;QAClC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC,CAAC;IACF,wEAAwE;IACxE,KAAK,EAAE,UAAU,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;QACnC,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC,CAAC;IACF,sCAAsC;IACtC,SAAS,EAAE,UAAU,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;QACvC,KAAK,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC,CAAC;IACF,+DAA+D;IAC/D,UAAU,EAAE,UAAU,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;QACxC,KAAK,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC,CAAC;CACH,CAAC"}

package/dist/commonjs/index.d.ts

@@ -1,5 +1,6 @@
 export { createTableBuilder, type ITableBuilder, type TableBuilderProps, type TableBuilderResult, } from "./table-builder.js";
 export { createTableV2Builder, type ITableV2Builder, type TableV2BuilderProps, type TableV2BuilderResult, } from "./table-v2-builder.js";
+export { tableGrants } from "./grants.js";
 export { TABLE_DEFAULTS, TABLE_V2_DEFAULTS } from "./defaults.js";
 export { type TableAlarmConfig } from "./table-alarm-config.js";
 export { TABLE_ALARM_DEFAULTS } from "./table-alarm-defaults.js";

package/dist/commonjs/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,KAAK,aAAa,EAClB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,GACxB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,oBAAoB,EACpB,KAAK,eAAe,EACpB,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,GAC1B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAClE,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,KAAK,aAAa,EAClB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,GACxB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,oBAAoB,EACpB,KAAK,eAAe,EACpB,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,GAC1B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAClE,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC"}

package/dist/commonjs/index.js

@@ -1,10 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TABLE_ALARM_DEFAULTS = exports.TABLE_V2_DEFAULTS = exports.TABLE_DEFAULTS = exports.createTableV2Builder = exports.createTableBuilder = void 0;
+exports.TABLE_ALARM_DEFAULTS = exports.TABLE_V2_DEFAULTS = exports.TABLE_DEFAULTS = exports.tableGrants = exports.createTableV2Builder = exports.createTableBuilder = void 0;
 var table_builder_js_1 = require("./table-builder.js");
 Object.defineProperty(exports, "createTableBuilder", { enumerable: true, get: function () { return table_builder_js_1.createTableBuilder; } });
 var table_v2_builder_js_1 = require("./table-v2-builder.js");
 Object.defineProperty(exports, "createTableV2Builder", { enumerable: true, get: function () { return table_v2_builder_js_1.createTableV2Builder; } });
+var grants_js_1 = require("./grants.js");
+Object.defineProperty(exports, "tableGrants", { enumerable: true, get: function () { return grants_js_1.tableGrants; } });
 var defaults_js_1 = require("./defaults.js");
 Object.defineProperty(exports, "TABLE_DEFAULTS", { enumerable: true, get: function () { return defaults_js_1.TABLE_DEFAULTS; } });
 Object.defineProperty(exports, "TABLE_V2_DEFAULTS", { enumerable: true, get: function () { return defaults_js_1.TABLE_V2_DEFAULTS; } });

package/dist/commonjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,uDAK4B;AAJ1B,sHAAA,kBAAkB,OAAA;AAKpB,6DAK+B;AAJ7B,2HAAA,oBAAoB,OAAA;AAKtB,6CAAkE;AAAzD,6GAAA,cAAc,OAAA;AAAE,gHAAA,iBAAiB,OAAA;AAE1C,qEAAiE;AAAxD,+HAAA,oBAAoB,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,uDAK4B;AAJ1B,sHAAA,kBAAkB,OAAA;AAKpB,6DAK+B;AAJ7B,2HAAA,oBAAoB,OAAA;AAKtB,yCAA0C;AAAjC,wGAAA,WAAW,OAAA;AACpB,6CAAkE;AAAzD,6GAAA,cAAc,OAAA;AAAE,gHAAA,iBAAiB,OAAA;AAE1C,qEAAiE;AAAxD,+HAAA,oBAAoB,OAAA"}

package/dist/esm/grants.d.ts

@@ -0,0 +1,23 @@
+import type { ITable } from "aws-cdk-lib/aws-dynamodb";
+import type { IGrantable } from "aws-cdk-lib/aws-iam";
+import { type Grant, type Resolvable } from "@composurecdk/core";
+/**
+ * Consumer-side grant helpers for a DynamoDB table. Pass one to a grantee
+ * builder's `grant(...)` — e.g.
+ * `role.grant(tableGrants.readWrite(ref("table", (r) => r.table)))`.
+ *
+ * `ITable` is implemented by both `Table` and `TableV2`, so these helpers serve
+ * either builder's result. Each delegates to the table's native `grant*Data`
+ * method. See ADR-0013.
+ */
+export declare const tableGrants: {
+    /** Read access (`dynamodb:GetItem`, `Query`, `Scan`, …). */
+    read: (table: Resolvable<ITable>) => Grant<IGrantable>;
+    /** Write access (`dynamodb:PutItem`, `UpdateItem`, `DeleteItem`, …). */
+    write: (table: Resolvable<ITable>) => Grant<IGrantable>;
+    /** Combined read and write access. */
+    readWrite: (table: Resolvable<ITable>) => Grant<IGrantable>;
+    /** Full access to the table and its indexes (`dynamodb:*`). */
+    fullAccess: (table: Resolvable<ITable>) => Grant<IGrantable>;
+};
+//# sourceMappingURL=grants.d.ts.map

package/dist/esm/grants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"grants.d.ts","sourceRoot":"","sources":["../../src/grants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,KAAK,KAAK,EAAY,KAAK,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAQ3E;;;;;;;;GAQG;AACH,eAAO,MAAM,WAAW;IACtB,4DAA4D;kBAbpD,UAAU,CAAC,MAAM,CAAC,KAAG,KAAK,CAAC,UAAU,CAAC;IAiB9C,wEAAwE;mBAjBhE,UAAU,CAAC,MAAM,CAAC,KAAG,KAAK,CAAC,UAAU,CAAC;IAqB9C,sCAAsC;uBArB9B,UAAU,CAAC,MAAM,CAAC,KAAG,KAAK,CAAC,UAAU,CAAC;IAyB9C,+DAA+D;wBAzBvD,UAAU,CAAC,MAAM,CAAC,KAAG,KAAK,CAAC,UAAU,CAAC;CA6B/C,CAAC"}

package/dist/esm/grants.js

@@ -0,0 +1,31 @@
+import { grantVia } from "@composurecdk/core";
+/** Wraps one of {@link ITable}'s native grant methods as a capability helper. */
+const capability = (apply) => (table) => grantVia(table, apply);
+/**
+ * Consumer-side grant helpers for a DynamoDB table. Pass one to a grantee
+ * builder's `grant(...)` — e.g.
+ * `role.grant(tableGrants.readWrite(ref("table", (r) => r.table)))`.
+ *
+ * `ITable` is implemented by both `Table` and `TableV2`, so these helpers serve
+ * either builder's result. Each delegates to the table's native `grant*Data`
+ * method. See ADR-0013.
+ */
+export const tableGrants = {
+    /** Read access (`dynamodb:GetItem`, `Query`, `Scan`, …). */
+    read: capability((table, grantee) => {
+        table.grantReadData(grantee);
+    }),
+    /** Write access (`dynamodb:PutItem`, `UpdateItem`, `DeleteItem`, …). */
+    write: capability((table, grantee) => {
+        table.grantWriteData(grantee);
+    }),
+    /** Combined read and write access. */
+    readWrite: capability((table, grantee) => {
+        table.grantReadWriteData(grantee);
+    }),
+    /** Full access to the table and its indexes (`dynamodb:*`). */
+    fullAccess: capability((table, grantee) => {
+        table.grantFullAccess(grantee);
+    }),
+};
+//# sourceMappingURL=grants.js.map

package/dist/esm/grants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"grants.js","sourceRoot":"","sources":["../../src/grants.ts"],"names":[],"mappings":"AAEA,OAAO,EAAc,QAAQ,EAAmB,MAAM,oBAAoB,CAAC;AAE3E,iFAAiF;AACjF,MAAM,UAAU,GACd,CAAC,KAAmD,EAAE,EAAE,CACxD,CAAC,KAAyB,EAAqB,EAAE,CAC/C,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAE3B;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,4DAA4D;IAC5D,IAAI,EAAE,UAAU,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;QAClC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC,CAAC;IACF,wEAAwE;IACxE,KAAK,EAAE,UAAU,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;QACnC,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC,CAAC;IACF,sCAAsC;IACtC,SAAS,EAAE,UAAU,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;QACvC,KAAK,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC,CAAC;IACF,+DAA+D;IAC/D,UAAU,EAAE,UAAU,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;QACxC,KAAK,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC,CAAC;CACH,CAAC"}

package/dist/esm/index.d.ts

@@ -1,5 +1,6 @@
 export { createTableBuilder, type ITableBuilder, type TableBuilderProps, type TableBuilderResult, } from "./table-builder.js";
 export { createTableV2Builder, type ITableV2Builder, type TableV2BuilderProps, type TableV2BuilderResult, } from "./table-v2-builder.js";
+export { tableGrants } from "./grants.js";
 export { TABLE_DEFAULTS, TABLE_V2_DEFAULTS } from "./defaults.js";
 export { type TableAlarmConfig } from "./table-alarm-config.js";
 export { TABLE_ALARM_DEFAULTS } from "./table-alarm-defaults.js";

package/dist/esm/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,KAAK,aAAa,EAClB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,GACxB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,oBAAoB,EACpB,KAAK,eAAe,EACpB,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,GAC1B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAClE,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,KAAK,aAAa,EAClB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,GACxB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,oBAAoB,EACpB,KAAK,eAAe,EACpB,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,GAC1B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAClE,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC"}

package/dist/esm/index.js

@@ -1,5 +1,6 @@
 export { createTableBuilder, } from "./table-builder.js";
 export { createTableV2Builder, } from "./table-v2-builder.js";
+export { tableGrants } from "./grants.js";
 export { TABLE_DEFAULTS, TABLE_V2_DEFAULTS } from "./defaults.js";
 export { TABLE_ALARM_DEFAULTS } from "./table-alarm-defaults.js";
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,GAInB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,oBAAoB,GAIrB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAElE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,GAInB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,oBAAoB,GAIrB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAElE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@composurecdk/dynamodb",
-  "version": "0.8.7",
+  "version": "0.9.0",
   "description": "Composable DynamoDB table builder with well-architected defaults",
   "repository": {
     "type": "git",
@@ -48,9 +48,9 @@
     }
   },
   "peerDependencies": {
-    "@composurecdk/cloudformation": "^0.8.0",
-    "@composurecdk/cloudwatch": "^0.8.0",
-    "@composurecdk/core": "^0.8.0",
+    "@composurecdk/cloudformation": "^0.9.0",
+    "@composurecdk/cloudwatch": "^0.9.0",
+    "@composurecdk/core": "^0.9.0",
     "aws-cdk-lib": "^2.178.0",
     "constructs": "^10.0.0"
   },