@awsless/dynamodb-server 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,24 @@
+import { DynamoDBClient } from '@aws-sdk/client-dynamodb';
+import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb';
+
+declare class DynamoDBServer {
+    private region;
+    private client?;
+    private documentClient?;
+    private endpoint;
+    private process;
+    constructor(region?: string);
+    listen(port: number): Promise<void>;
+    /** Kill the DynamoDB server. */
+    kill(): Promise<void>;
+    /** Ping the DynamoDB server if its ready. */
+    ping(): Promise<boolean>;
+    /** Ping the DynamoDB server untill its ready. */
+    wait(times?: number): Promise<void>;
+    /** Get DynamoDBClient connected to dynamodb local. */
+    getClient(): DynamoDBClient;
+    /** Get DynamoDBDocumentClient connected to dynamodb local. */
+    getDocumentClient(): DynamoDBDocumentClient;
+}
+
+export { DynamoDBServer };

package/dist/index.js

@@ -0,0 +1,119 @@
+"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 src_exports = {};
+__export(src_exports, {
+  DynamoDBServer: () => DynamoDBServer
+});
+module.exports = __toCommonJS(src_exports);
+var import_client_dynamodb = require("@aws-sdk/client-dynamodb");
+var import_lib_dynamodb = require("@aws-sdk/lib-dynamodb");
+var import_url_parser = require("@aws-sdk/url-parser");
+var import_sleep_await = require("sleep-await");
+var import_dynamo_db_local = __toESM(require("dynamo-db-local"));
+var DynamoDBServer = class {
+  constructor(region = "us-east-1") {
+    this.region = region;
+    this.endpoint = (0, import_url_parser.parseUrl)(`http://localhost`);
+  }
+  client;
+  documentClient;
+  endpoint;
+  process;
+  async listen(port) {
+    if (this.process) {
+      throw new Error(`DynamoDB server is already listening on port: ${this.endpoint.port}`);
+    }
+    if (port < 0 || port >= 65536) {
+      throw new RangeError(`Port should be >= 0 and < 65536. Received ${port}.`);
+    }
+    this.endpoint.port = port;
+    this.process = await import_dynamo_db_local.default.spawn({ port });
+  }
+  /** Kill the DynamoDB server. */
+  async kill() {
+    if (this.process) {
+      await this.process.kill();
+      this.process = void 0;
+    }
+  }
+  /** Ping the DynamoDB server if its ready. */
+  async ping() {
+    const client = this.getClient();
+    const command = new import_client_dynamodb.ListTablesCommand({});
+    try {
+      const response = await client.send(command);
+      return Array.isArray(response.TableNames);
+    } catch (error) {
+      return false;
+    }
+  }
+  /** Ping the DynamoDB server untill its ready. */
+  async wait(times = 10) {
+    while (times--) {
+      if (await this.ping()) {
+        return;
+      }
+      await (0, import_sleep_await.sleepAwait)(100 * times);
+    }
+    throw new Error("DynamoDB server is unavailable");
+  }
+  /** Get DynamoDBClient connected to dynamodb local. */
+  getClient() {
+    if (!this.client) {
+      this.client = new import_client_dynamodb.DynamoDBClient({
+        maxAttempts: 10,
+        endpoint: this.endpoint,
+        region: this.region,
+        tls: false,
+        credentials: {
+          accessKeyId: "fake",
+          secretAccessKey: "fake"
+        }
+      });
+    }
+    return this.client;
+  }
+  /** Get DynamoDBDocumentClient connected to dynamodb local. */
+  getDocumentClient() {
+    if (!this.documentClient) {
+      this.documentClient = import_lib_dynamodb.DynamoDBDocumentClient.from(this.getClient(), {
+        marshallOptions: {
+          removeUndefinedValues: true
+        }
+      });
+    }
+    return this.documentClient;
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  DynamoDBServer
+});

package/dist/index.mjs

@@ -0,0 +1,84 @@
+// src/index.ts
+import { DynamoDBClient, ListTablesCommand } from "@aws-sdk/client-dynamodb";
+import { DynamoDBDocumentClient } from "@aws-sdk/lib-dynamodb";
+import { parseUrl } from "@aws-sdk/url-parser";
+import { sleepAwait } from "sleep-await";
+import dynamoDbLocal from "dynamo-db-local";
+var DynamoDBServer = class {
+  constructor(region = "us-east-1") {
+    this.region = region;
+    this.endpoint = parseUrl(`http://localhost`);
+  }
+  client;
+  documentClient;
+  endpoint;
+  process;
+  async listen(port) {
+    if (this.process) {
+      throw new Error(`DynamoDB server is already listening on port: ${this.endpoint.port}`);
+    }
+    if (port < 0 || port >= 65536) {
+      throw new RangeError(`Port should be >= 0 and < 65536. Received ${port}.`);
+    }
+    this.endpoint.port = port;
+    this.process = await dynamoDbLocal.spawn({ port });
+  }
+  /** Kill the DynamoDB server. */
+  async kill() {
+    if (this.process) {
+      await this.process.kill();
+      this.process = void 0;
+    }
+  }
+  /** Ping the DynamoDB server if its ready. */
+  async ping() {
+    const client = this.getClient();
+    const command = new ListTablesCommand({});
+    try {
+      const response = await client.send(command);
+      return Array.isArray(response.TableNames);
+    } catch (error) {
+      return false;
+    }
+  }
+  /** Ping the DynamoDB server untill its ready. */
+  async wait(times = 10) {
+    while (times--) {
+      if (await this.ping()) {
+        return;
+      }
+      await sleepAwait(100 * times);
+    }
+    throw new Error("DynamoDB server is unavailable");
+  }
+  /** Get DynamoDBClient connected to dynamodb local. */
+  getClient() {
+    if (!this.client) {
+      this.client = new DynamoDBClient({
+        maxAttempts: 10,
+        endpoint: this.endpoint,
+        region: this.region,
+        tls: false,
+        credentials: {
+          accessKeyId: "fake",
+          secretAccessKey: "fake"
+        }
+      });
+    }
+    return this.client;
+  }
+  /** Get DynamoDBDocumentClient connected to dynamodb local. */
+  getDocumentClient() {
+    if (!this.documentClient) {
+      this.documentClient = DynamoDBDocumentClient.from(this.getClient(), {
+        marshallOptions: {
+          removeUndefinedValues: true
+        }
+      });
+    }
+    return this.documentClient;
+  }
+};
+export {
+  DynamoDBServer
+};

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@awsless/dynamodb-server",
+  "version": "0.0.1",
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/awsless/awsless.git"
+  },
+  "bugs": {
+    "url": "https://github.com/awsless/awsless/issues"
+  },
+  "dependencies": {
+    "@aws-sdk/client-dynamodb": "3.272.0",
+    "@aws-sdk/lib-dynamodb": "3.258.0",
+    "@aws-sdk/smithy-client": "3.272.0",
+    "@aws-sdk/url-parser": "^3.272.0",
+    "dynamo-db-local": "^4.1.3",
+    "sleep-await": "^1.0.2"
+  },
+  "scripts": {
+    "test": "pnpm code test",
+    "build": "pnpm tsup src/index.ts --format cjs,esm --dts --clean --external vitest",
+    "prepublish": "pnpm test; pnpm build"
+  }
+}