@stacksjs/cache 0.41.1 → 0.42.1

package/README.md

@@ -40,7 +40,7 @@ Please see our [releases](https://github.com/stacksjs/stacks/releases) page for
 
 ## 💪🏼 Contributing
 
-Please see [CONTRIBUTING](../../.github/CONTRIBUTING.md) for details.
+Please review the [Contributing Guide](https://github.com/stacksjs/contributing) for details.
 
 ## 🏝 Community
 
@@ -50,7 +50,7 @@ For help, discussion about best practices, or any other conversation that would
 
 For casual chit-chat with others using this package:
 
-[Join the Open Web Discord Server](https://discord.ow3.org)
+[Join the Stacks Discord Server](https://discord.ow3.org)
 
 ## 📄 License
 

package/dist/drivers/dynamodb.d.ts

@@ -1,5 +1,6 @@
+declare function createTable(): Promise<void>;
 declare function set(key: string, value: string | number): Promise<void>;
 declare function get(key: string): Promise<string | undefined | null>;
 declare function remove(key: string): Promise<void>;
 declare function del(key: string): Promise<void>;
-export { set, get, remove, del };
+export { set, get, remove, del, createTable };

package/dist/drivers/dynamodb.mjs

@@ -1,11 +1,38 @@
-import { DynamoDB } from "@aws-sdk/client-dynamodb";
+import { DynamoDB, ListTablesCommand } from "@aws-sdk/client-dynamodb";
 import { cache } from "@stacksjs/config";
 const valueAttribute = "value";
 const keyAttribute = "key";
+const tableName = cache.dynamodb.table;
 const dynamodb = new DynamoDB({ region: cache.dynamodb.region });
+async function createTable() {
+  const tables = await dynamodb.send(new ListTablesCommand({}));
+  const tableExists = tables.TableNames?.includes("cache");
+  if (tableExists)
+    return;
+  const params = {
+    AttributeDefinitions: [
+      {
+        AttributeName: "key",
+        AttributeType: "S"
+      }
+    ],
+    KeySchema: [
+      {
+        AttributeName: "key",
+        KeyType: "HASH"
+      }
+    ],
+    ProvisionedThroughput: {
+      ReadCapacityUnits: 5,
+      WriteCapacityUnits: 5
+    },
+    TableName: tableName
+  };
+  await dynamodb.createTable(params);
+}
 async function set(key, value) {
   const params = {
-    TableName: "cache",
+    TableName: tableName,
     Item: {
       [keyAttribute]: {
         S: key
@@ -19,7 +46,7 @@ async function set(key, value) {
 }
 async function get(key) {
   const params = {
-    TableName: "cache",
+    TableName: tableName,
     Key: {
       [keyAttribute]: {
         S: key
@@ -40,7 +67,7 @@ function getValueType(value) {
 }
 async function remove(key) {
   const params = {
-    TableName: "cache",
+    TableName: tableName,
     Key: {
       [keyAttribute]: {
         S: key
@@ -51,7 +78,7 @@ async function remove(key) {
 }
 async function del(key) {
   const params = {
-    TableName: "cache",
+    TableName: tableName,
     Key: {
       [keyAttribute]: {
         S: key
@@ -63,4 +90,4 @@ async function del(key) {
 function serialize(value) {
   return String(value);
 }
-export { set, get, remove, del };
+export { set, get, remove, del, createTable };

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@stacksjs/cache",
   "type": "module",
-  "version": "0.41.1",
-  "packageManager": "pnpm@7.16.0",
+  "version": "0.42.1",
+  "packageManager": "pnpm@7.17.0",
   "description": "The Stacks way to test.",
   "author": "Chris Breuer",
   "license": "MIT",
@@ -36,23 +36,21 @@
   ],
   "engines": {
     "node": ">=v18.12.1",
-    "pnpm": ">=7.16.0"
+    "pnpm": ">=7.17.0"
   },
   "peerDependencies": {
-    "@stacksjs/config": "0.41.1",
+    "@aws-sdk/client-dynamodb": "^3.215.0",
+    "@types/memjs": "^1.2.4",
     "memcached": "^2.2.2",
+    "memjs": "^1.3.0",
     "redis": "^4.5.0",
-    "vitest": "^0.25.2"
-  },
-  "dependencies": {
-    "@aws-sdk/client-dynamodb": "^3.211.0",
-    "memcached": "^2.2.2",
-    "memjs": "^1.3.0"
+    "vitest": "^0.25.2",
+    "@stacksjs/config": "0.42.1"
   },
   "devDependencies": {
     "mkdist": "^1.0.0",
     "typescript": "^4.9.3",
-    "vitest": "^0.25.2"
+    "@stacksjs/testing": "0.42.1"
   },
   "scripts": {
     "build": "mkdist -d",

package/dist/tests/DynamoDB.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tests/DynamoDB.test.mjs

@@ -1,75 +0,0 @@
-import { DynamoDB } from "@aws-sdk/client-dynamodb";
-import { describe, expect, it } from "vitest";
-const dynamodb = new DynamoDB({ region: "us-east-1" });
-describe("DynamoDB test", () => {
-  it("it should set dynamodb cache", async () => {
-    await set("foo", "bar");
-    const value = await get("foo");
-    expect(value).toBe("bar");
-  });
-  it("it should get dynamodb cache", async () => {
-    await set("foo", "bar");
-    const value = await get("foo");
-    expect(value).toBe("bar");
-  });
-  it("it should delete dynamodb cache", async () => {
-    await set("foo", "bar");
-    await remove("foo");
-    const value = await get("foo");
-    expect(value).toBe(null);
-  });
-});
-async function set(key, value) {
-  const valueAttribute = "value";
-  const keyAttribute = "key";
-  const params = {
-    TableName: "cache",
-    Item: {
-      [keyAttribute]: {
-        S: key
-      },
-      [valueAttribute]: {
-        [getValueType(value)]: serialize(value)
-      }
-    }
-  };
-  await dynamodb.putItem(params);
-}
-async function get(key) {
-  const valueAttribute = "value";
-  const keyAttribute = "key";
-  const params = {
-    TableName: "cache",
-    Key: {
-      [keyAttribute]: {
-        S: key
-      }
-    }
-  };
-  const response = await dynamodb.getItem(params);
-  if (!response.Item)
-    return null;
-  return response.Item[valueAttribute].S ?? response.Item[valueAttribute].N;
-}
-function getValueType(value) {
-  if (typeof value === "string")
-    return "S";
-  if (typeof value === "number")
-    return "N";
-  return "S";
-}
-async function remove(key) {
-  const keyAttribute = "key";
-  const params = {
-    TableName: "cache",
-    Key: {
-      [keyAttribute]: {
-        S: key
-      }
-    }
-  };
-  await dynamodb.deleteItem(params);
-}
-function serialize(value) {
-  return String(value);
-}

package/dist/tests/Memcached.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tests/Memcached.test.mjs

@@ -1,37 +0,0 @@
-import Memcached from "memjs";
-import { describe, expect, it } from "vitest";
-const client = Memcached.Client.create("127.0.0.1:11211");
-async function set(key, value, duration) {
-  await client.set(key, value, { expires: duration });
-}
-async function get(key) {
-  const value = await client.get(key);
-  const result = value.value ? value.value.toString() : null;
-  return result;
-}
-async function del(key) {
-  await client.delete(key);
-}
-async function flush() {
-  await client.flush();
-}
-describe("MemcachedTest", () => {
-  it("it should set memcached cache", async () => {
-    await set("test", "test", 10 * 60);
-    expect(await get("test")).toBe("test");
-  });
-  it("it should get memcached cache", async () => {
-    await set("test", "test", 10 * 60);
-    expect(await get("test")).toBe("test");
-  });
-  it("it should delete memcached cache", async () => {
-    await set("test", "test", 10 * 60);
-    await del("test");
-    expect(await get("test")).toBe(null);
-  });
-  it("it should flush memcached cache", async () => {
-    await set("test", "test", 10 * 60);
-    await flush();
-    expect(await get("test")).toBe(null);
-  });
-});

package/dist/tests/Redis.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tests/Redis.test.mjs

@@ -1,59 +0,0 @@
-import { describe, expect, it } from "vitest";
-import { createClient } from "redis";
-const client = createClient({
-  socket: {
-    host: "127.0.0.1",
-    port: 6379
-  },
-  password: ""
-});
-await client.connect();
-async function set(key, value) {
-  await client.set(key, value);
-}
-async function get(key) {
-  const value = await client.get(key);
-  return value;
-}
-async function remove(key) {
-  await client.del(key);
-}
-async function del(key) {
-  await client.del(key);
-}
-async function flushAll() {
-  await client.sendCommand(["FLUSHALL", "ASYNC"]);
-}
-async function flushDB() {
-  await client.sendCommand(["FLUSHDB", "ASYNC"]);
-}
-describe("RedisTest", () => {
-  it("it should set redis cache", async () => {
-    await set("test", "test");
-    expect(await get("test")).toBe("test");
-  });
-  it("it should get redis cache", async () => {
-    await set("test", "test");
-    expect(await get("test")).toBe("test");
-  });
-  it("it should remove cache", async () => {
-    await set("test", "test");
-    await remove("test");
-    expect(await get("test")).toBe(null);
-  });
-  it("it should del cache", async () => {
-    await set("test", "test");
-    await del("test");
-    expect(await get("test")).toBe(null);
-  });
-  it("it should flush all cache", async () => {
-    await set("test", "test");
-    await flushAll();
-    expect(await get("test")).toBe(null);
-  });
-  it("it should flush all DB", async () => {
-    await set("test", "test");
-    await flushDB();
-    expect(await get("test")).toBe(null);
-  });
-});