@infra-blocks/aws-dynamodb 0.37.0 → 0.38.0

package/lib/cjs/index.d.ts

@@ -2,3 +2,4 @@ export * from "./client.js";
 export * from "./commands/index.js";
 export * from "./error.js";
 export * from "./types.js";
+export * from "./utils.js";

package/lib/cjs/index.js

@@ -18,4 +18,5 @@ __exportStar(require("./client.js"), exports);
 __exportStar(require("./commands/index.js"), exports);
 __exportStar(require("./error.js"), exports);
 __exportStar(require("./types.js"), exports);
+__exportStar(require("./utils.js"), exports);
 //# sourceMappingURL=index.js.map

package/lib/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,sDAAoC;AACpC,6CAA2B;AAC3B,6CAA2B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,sDAAoC;AACpC,6CAA2B;AAC3B,6CAA2B;AAC3B,6CAA2B"}

package/lib/cjs/utils.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Converts a Date object into a TTL value that AWS DynamoDB expects.
+ *
+ * The TTL value that DynamoDB expects is a Unix epoch timestamp in seconds.
+ * This function converts the provided Date object into such a timestamp
+ * by doing this: `Math.round(date.getTime() / 1000)`. Nuff said.
+ *
+ * @param date - The date to convert into a TTL value.
+ *
+ * @returns The TTL value as expected by AWS DynamoDB.
+ *
+ * @see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html
+ */
+export declare function dateToTtl(date: Date): number;

package/lib/cjs/utils.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dateToTtl = dateToTtl;
+/**
+ * Converts a Date object into a TTL value that AWS DynamoDB expects.
+ *
+ * The TTL value that DynamoDB expects is a Unix epoch timestamp in seconds.
+ * This function converts the provided Date object into such a timestamp
+ * by doing this: `Math.round(date.getTime() / 1000)`. Nuff said.
+ *
+ * @param date - The date to convert into a TTL value.
+ *
+ * @returns The TTL value as expected by AWS DynamoDB.
+ *
+ * @see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html
+ */
+function dateToTtl(date) {
+    return Math.round(date.getTime() / 1000);
+}
+//# sourceMappingURL=utils.js.map

package/lib/cjs/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":";;AAaA,8BAEC;AAfD;;;;;;;;;;;;GAYG;AACH,SAAgB,SAAS,CAAC,IAAU;IAClC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;AAC3C,CAAC"}

package/lib/esm/index.d.ts

@@ -2,3 +2,4 @@ export * from "./client.js";
 export * from "./commands/index.js";
 export * from "./error.js";
 export * from "./types.js";
+export * from "./utils.js";

package/lib/esm/index.js

@@ -2,4 +2,5 @@ export * from "./client.js";
 export * from "./commands/index.js";
 export * from "./error.js";
 export * from "./types.js";
+export * from "./utils.js";
 //# sourceMappingURL=index.js.map

package/lib/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,qBAAqB,CAAC;AACpC,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,qBAAqB,CAAC;AACpC,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC"}

package/lib/esm/utils.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Converts a Date object into a TTL value that AWS DynamoDB expects.
+ *
+ * The TTL value that DynamoDB expects is a Unix epoch timestamp in seconds.
+ * This function converts the provided Date object into such a timestamp
+ * by doing this: `Math.round(date.getTime() / 1000)`. Nuff said.
+ *
+ * @param date - The date to convert into a TTL value.
+ *
+ * @returns The TTL value as expected by AWS DynamoDB.
+ *
+ * @see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html
+ */
+export declare function dateToTtl(date: Date): number;

package/lib/esm/utils.js

@@ -0,0 +1,17 @@
+/**
+ * Converts a Date object into a TTL value that AWS DynamoDB expects.
+ *
+ * The TTL value that DynamoDB expects is a Unix epoch timestamp in seconds.
+ * This function converts the provided Date object into such a timestamp
+ * by doing this: `Math.round(date.getTime() / 1000)`. Nuff said.
+ *
+ * @param date - The date to convert into a TTL value.
+ *
+ * @returns The TTL value as expected by AWS DynamoDB.
+ *
+ * @see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html
+ */
+export function dateToTtl(date) {
+    return Math.round(date.getTime() / 1000);
+}
+//# sourceMappingURL=utils.js.map

package/lib/esm/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,SAAS,CAAC,IAAU;IAClC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;AAC3C,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@infra-blocks/aws-dynamodb",
-  "version": "0.37.0",
+  "version": "0.38.0",
   "description": "A convenience wrapper over @aws-sdk/client-dynamodb and @aws-sdk/lib-dynamodb.",
   "keywords": [
     "aws",