@keyv/dynamo 1.0.0

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2017-2021 Luke Childs
+Copyright (c) 2021-2022 Jared Wray
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,40 @@
+# @keyv/dynamo [<img width="100" align="right" src="https://jaredwray.com/images/keyv-symbol.svg" alt="keyv">](https://github.com/jaredwra/keyv)
+
+> DynamoDB storage adapter for Keyv
+
+[![build](https://github.com/jaredwray/keyv/actions/workflows/tests.yaml/badge.svg)](https://github.com/jaredwray/keyv/actions/workflows/tests.yaml)
+[![codecov](https://codecov.io/gh/jaredwray/keyv/branch/main/graph/badge.svg?token=bRzR3RyOXZ)](https://codecov.io/gh/jaredwray/keyv)
+[![npm](https://img.shields.io/npm/v/@keyv/dynamo.svg)](https://www.npmjs.com/package/@keyv/dynamo)
+[![npm](https://img.shields.io/npm/dm/@keyv/dynamo)](https://npmjs.com/package/@keyv/dynamo)
+
+DynamoDB storage adapter for [Keyv](https://github.com/jaredwray/keyv).
+
+Uses TTL indexes to automatically remove expired documents. However [DynamoDB doesn't guarantee data will be deleted immediately upon expiration](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html).
+
+## Install
+
+```shell
+npm install --save keyv @keyv/dynamo
+```
+
+## Usage
+
+```js
+import Keyv from 'keyv';
+import KeyvDynamo from '@keyv/dynamo';
+
+const keyv = new Keyv(new KeyvDynamo());
+keyv.on('error', handleConnectionError);
+```
+
+You can specify the table name, by default `'keyv'` is used.
+
+e.g:
+
+```js
+const keyv = new KeyvDynamo({ tableName: 'cacheTable' });
+```
+
+## License
+
+[MIT © Jared Wray](LISCENCE)

package/dist/index.cjs

@@ -0,0 +1,150 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  KeyvDynamo: () => KeyvDynamo,
+  default: () => index_default
+});
+module.exports = __toCommonJS(index_exports);
+var import_events = __toESM(require("events"), 1);
+var import_client_dynamodb = require("@aws-sdk/client-dynamodb");
+var import_lib_dynamodb = require("@aws-sdk/lib-dynamodb");
+var KeyvDynamo = class extends import_events.default {
+  ttlSupport = true;
+  sixHoursInMilliseconds = 6 * 60 * 60 * 1e3;
+  namespace;
+  opts;
+  client;
+  constructor(options) {
+    super();
+    options ??= {};
+    if (typeof options === "string") {
+      options = { endpoint: options };
+    }
+    this.opts = {
+      tableName: "keyv",
+      dialect: "dynamo",
+      ...options
+    };
+    this.client = import_lib_dynamodb.DynamoDBDocument.from(new import_client_dynamodb.DynamoDB(this.opts));
+    this.checkTableExists(this.opts.tableName).catch((error) => {
+      this.emit("error", error);
+    });
+  }
+  async checkTableExists(tableName) {
+    await this.client.send(new import_client_dynamodb.DescribeTableCommand({ TableName: tableName }));
+  }
+  async set(key, value, ttl) {
+    const sixHoursFromNowEpoch = Math.floor((Date.now() + this.sixHoursInMilliseconds) / 1e3);
+    const expiresAt = typeof ttl === "number" ? Math.floor((Date.now() + (ttl + 1e3)) / 1e3) : sixHoursFromNowEpoch;
+    const putInput = {
+      TableName: this.opts.tableName,
+      Item: {
+        id: key,
+        value,
+        expiresAt
+      }
+    };
+    await this.client.put(putInput);
+  }
+  async get(key) {
+    const getInput = {
+      TableName: this.opts.tableName,
+      Key: {
+        id: key
+      }
+    };
+    const { Item } = await this.client.get(getInput);
+    return Item?.value;
+  }
+  async delete(key) {
+    const deleteInput = {
+      TableName: this.opts.tableName,
+      Key: {
+        id: key
+      },
+      ReturnValues: "ALL_OLD"
+    };
+    const { Attributes } = await this.client.delete(deleteInput);
+    return Boolean(Attributes);
+  }
+  async getMany(keys) {
+    const batchGetInput = {
+      RequestItems: {
+        [this.opts.tableName]: {
+          Keys: keys.map((key) => ({
+            id: key
+          }))
+        }
+      }
+    };
+    const { Responses: { [this.opts.tableName]: items = [] } = {} } = await this.client.batchGet(batchGetInput);
+    return keys.map((key) => items.find((item) => item?.id === key)?.value);
+  }
+  async deleteMany(keys) {
+    if (keys.length === 0) {
+      return false;
+    }
+    const items = await this.getMany(keys);
+    if (items.filter(Boolean).length === 0) {
+      return false;
+    }
+    const batchDeleteInput = {
+      RequestItems: {
+        [this.opts.tableName]: keys.map((key) => ({
+          DeleteRequest: {
+            TableName: this.opts.tableName,
+            Key: {
+              id: key
+            }
+          }
+        }))
+      }
+    };
+    const response = await this.client.batchWrite(batchDeleteInput);
+    return Boolean(response);
+  }
+  async clear() {
+    const scanResult = await this.client.scan({
+      TableName: this.opts.tableName
+    });
+    const keys = this.extractKey(scanResult);
+    await this.deleteMany(keys);
+  }
+  extractKey(output, keyProperty = "id") {
+    return (output.Items ?? []).map((item) => item[keyProperty]).filter((key) => key.startsWith(this.namespace ?? ""));
+  }
+};
+var index_default = KeyvDynamo;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  KeyvDynamo
+});

package/dist/index.d.cts

@@ -0,0 +1,30 @@
+import EventEmitter from 'events';
+import { DynamoDBClientConfig } from '@aws-sdk/client-dynamodb';
+import { KeyvStoreAdapter, StoredData } from 'keyv';
+
+declare class KeyvDynamo extends EventEmitter implements KeyvStoreAdapter {
+    ttlSupport: boolean;
+    sixHoursInMilliseconds: number;
+    namespace?: string;
+    opts: Omit<KeyvDynamoOptions, 'tableName'> & {
+        tableName: string;
+    };
+    private readonly client;
+    constructor(options: KeyvDynamoOptions | string);
+    checkTableExists(tableName: string): Promise<void>;
+    set(key: string, value: unknown, ttl?: number): Promise<void>;
+    get<Value>(key: string): Promise<StoredData<Value>>;
+    delete(key: string): Promise<boolean>;
+    getMany<Value>(keys: string[]): Promise<Array<StoredData<Value | undefined>>>;
+    deleteMany(keys: string[]): Promise<boolean>;
+    clear(): Promise<void>;
+    private extractKey;
+}
+
+type KeyvDynamoOptions = {
+    namespace?: string;
+    dialect?: string;
+    tableName?: string;
+} & DynamoDBClientConfig;
+
+export { KeyvDynamo, type KeyvDynamoOptions, KeyvDynamo as default };

package/dist/index.d.ts

@@ -0,0 +1,30 @@
+import EventEmitter from 'events';
+import { DynamoDBClientConfig } from '@aws-sdk/client-dynamodb';
+import { KeyvStoreAdapter, StoredData } from 'keyv';
+
+declare class KeyvDynamo extends EventEmitter implements KeyvStoreAdapter {
+    ttlSupport: boolean;
+    sixHoursInMilliseconds: number;
+    namespace?: string;
+    opts: Omit<KeyvDynamoOptions, 'tableName'> & {
+        tableName: string;
+    };
+    private readonly client;
+    constructor(options: KeyvDynamoOptions | string);
+    checkTableExists(tableName: string): Promise<void>;
+    set(key: string, value: unknown, ttl?: number): Promise<void>;
+    get<Value>(key: string): Promise<StoredData<Value>>;
+    delete(key: string): Promise<boolean>;
+    getMany<Value>(keys: string[]): Promise<Array<StoredData<Value | undefined>>>;
+    deleteMany(keys: string[]): Promise<boolean>;
+    clear(): Promise<void>;
+    private extractKey;
+}
+
+type KeyvDynamoOptions = {
+    namespace?: string;
+    dialect?: string;
+    tableName?: string;
+} & DynamoDBClientConfig;
+
+export { KeyvDynamo, type KeyvDynamoOptions, KeyvDynamo as default };

package/dist/index.js

@@ -0,0 +1,120 @@
+// src/index.ts
+import EventEmitter from "events";
+import {
+  DescribeTableCommand,
+  DynamoDB
+} from "@aws-sdk/client-dynamodb";
+import {
+  DynamoDBDocument
+} from "@aws-sdk/lib-dynamodb";
+var KeyvDynamo = class extends EventEmitter {
+  ttlSupport = true;
+  sixHoursInMilliseconds = 6 * 60 * 60 * 1e3;
+  namespace;
+  opts;
+  client;
+  constructor(options) {
+    super();
+    options ??= {};
+    if (typeof options === "string") {
+      options = { endpoint: options };
+    }
+    this.opts = {
+      tableName: "keyv",
+      dialect: "dynamo",
+      ...options
+    };
+    this.client = DynamoDBDocument.from(new DynamoDB(this.opts));
+    this.checkTableExists(this.opts.tableName).catch((error) => {
+      this.emit("error", error);
+    });
+  }
+  async checkTableExists(tableName) {
+    await this.client.send(new DescribeTableCommand({ TableName: tableName }));
+  }
+  async set(key, value, ttl) {
+    const sixHoursFromNowEpoch = Math.floor((Date.now() + this.sixHoursInMilliseconds) / 1e3);
+    const expiresAt = typeof ttl === "number" ? Math.floor((Date.now() + (ttl + 1e3)) / 1e3) : sixHoursFromNowEpoch;
+    const putInput = {
+      TableName: this.opts.tableName,
+      Item: {
+        id: key,
+        value,
+        expiresAt
+      }
+    };
+    await this.client.put(putInput);
+  }
+  async get(key) {
+    const getInput = {
+      TableName: this.opts.tableName,
+      Key: {
+        id: key
+      }
+    };
+    const { Item } = await this.client.get(getInput);
+    return Item?.value;
+  }
+  async delete(key) {
+    const deleteInput = {
+      TableName: this.opts.tableName,
+      Key: {
+        id: key
+      },
+      ReturnValues: "ALL_OLD"
+    };
+    const { Attributes } = await this.client.delete(deleteInput);
+    return Boolean(Attributes);
+  }
+  async getMany(keys) {
+    const batchGetInput = {
+      RequestItems: {
+        [this.opts.tableName]: {
+          Keys: keys.map((key) => ({
+            id: key
+          }))
+        }
+      }
+    };
+    const { Responses: { [this.opts.tableName]: items = [] } = {} } = await this.client.batchGet(batchGetInput);
+    return keys.map((key) => items.find((item) => item?.id === key)?.value);
+  }
+  async deleteMany(keys) {
+    if (keys.length === 0) {
+      return false;
+    }
+    const items = await this.getMany(keys);
+    if (items.filter(Boolean).length === 0) {
+      return false;
+    }
+    const batchDeleteInput = {
+      RequestItems: {
+        [this.opts.tableName]: keys.map((key) => ({
+          DeleteRequest: {
+            TableName: this.opts.tableName,
+            Key: {
+              id: key
+            }
+          }
+        }))
+      }
+    };
+    const response = await this.client.batchWrite(batchDeleteInput);
+    return Boolean(response);
+  }
+  async clear() {
+    const scanResult = await this.client.scan({
+      TableName: this.opts.tableName
+    });
+    const keys = this.extractKey(scanResult);
+    await this.deleteMany(keys);
+  }
+  extractKey(output, keyProperty = "id") {
+    return (output.Items ?? []).map((item) => item[keyProperty]).filter((key) => key.startsWith(this.namespace ?? ""));
+  }
+};
+var index_default = KeyvDynamo;
+export {
+  KeyvDynamo,
+  index_default as default
+};

package/package.json

@@ -0,0 +1,82 @@
+{
+  "name": "@keyv/dynamo",
+  "version": "1.0.0",
+  "description": "DynamoDB storage adapter for Keyv",
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.js"
+    }
+  },
+  "xo": {
+    "space": true,
+    "rules": {
+      "import/no-named-as-default": "off",
+      "unicorn/prefer-module": "off",
+      "unicorn/prefer-event-target": "off",
+      "unicorn/no-array-reduce": "off",
+      "unicorn/prefer-object-from-entries": "off",
+      "unicorn/prefer-node-protocol": "off",
+      "@typescript-eslint/no-unsafe-assignment": "off",
+      "@typescript-eslint/no-unsafe-call": "off",
+      "@typescript-eslint/no-unsafe-return": "off",
+      "@typescript-eslint/no-unsafe-argument": "off",
+      "import/extensions": "off",
+      "@typescript-eslint/consistent-type-imports": "off",
+      "@typescript-eslint/naming-convention": "off",
+      "@typescript-eslint/no-floating-promises": "off",
+      "import/no-extraneous-dependencies": "off",
+      "@typescript-eslint/no-confusing-void-expression": "off",
+      "@typescript-eslint/no-empty-function": "off",
+      "promise/prefer-await-to-then": "off"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jaredwray/keyv.git"
+  },
+  "keywords": [
+    "dynamo",
+    "dynamodb",
+    "keyv",
+    "storage",
+    "adapter",
+    "key",
+    "value",
+    "store",
+    "cache",
+    "ttl"
+  ],
+  "author": "Jared Wray <me@jaredwray.com> (https://jaredwray.com)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/jaredwray/keyv/issues"
+  },
+  "homepage": "https://github.com/jaredwray/keyv",
+  "dependencies": {
+    "@aws-sdk/client-dynamodb": "^3.835.0",
+    "@aws-sdk/lib-dynamodb": "^3.835.0"
+  },
+  "devDependencies": {
+    "vitest": "^3.2.4",
+    "keyv": "^5.3.4",
+    "@keyv/test-suite": "^2.0.9"
+  },
+  "tsd": {
+    "directory": "test"
+  },
+  "files": [
+    "dist",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "rimraf ./dist && tsup src/index.ts --format cjs,esm --dts --clean",
+    "test": "xo --fix && vitest run --coverage",
+    "test:ci": "xo && vitest --run --sequence.setupFiles=list --coverage",
+    "clean": "rimraf ./node_modules ./coverage ./dist"
+  }
+}