Merge pull request #12 from lishaduck/deno-kv

Deno KV

deno.json

@@ -3,6 +3,7 @@
   "nodeModulesDir": "manual",
   "license": "MIT",
   "workspace": ["./packages/*"],
+  "unstable": ["kv"],
   "imports": {
     "@biomejs/biome": "npm:@biomejs/biome@^1.9.4",
     "@effect/vitest": "npm:@effect/vitest@^0.13.16",

packages/platform-deno/deno.json

@@ -5,6 +5,7 @@
     ".": "./src/mod.ts",
     "./DenoContext": "./src/DenoContext.ts",
     "./DenoFileSystem": "./src/DenoFileSystem.ts",
+    "./DenoKeyValueStore": "./src/DenoKeyValueStore.ts",
     "./DenoPath": "./src/DenoPath.ts",
     "./DenoRuntime": "./src/DenoRuntime.ts",
     "./DenoWorker": "./src/DenoWorker.ts",

packages/platform-deno/src/DenoContext.ts

@@ -1,7 +1,27 @@
 /**
- * This module exposes a {@linkplain Layer.Layer | layer} for Deno-powered operations.
+ * This module exposes a platform context {@linkplain Layer.Layer | layer} for Deno-powered applications.
  * @module
  *
+ * @example
+ * ```ts
+ * import { Path } from "@effect/platform";
+ * import { DenoContext, DenoRuntime } from "@lishaduck/effect-platform-deno";
+ * import { assertEquals } from "@std/assert";
+ * import { Console, Effect } from "effect";
+ *
+ * const program = Effect.gen(function* () {
+ *   // Access the Path service
+ *   const path = yield* Path.Path;
+ *
+ *   // Join parts of a path to create a complete file path
+ *   const fileName = path.basename("some/directory/file.txt");
+ *
+ *   assertEquals(fileName, "file.txt");
+ * });
+ *
+ * DenoRuntime.runMain(program.pipe(Effect.provide(DenoContext.layer)));
+ * ```
+ *
  * @since 0.1.0
  */
 

packages/platform-deno/src/DenoKeyValueStore.ts

@@ -1,16 +1,21 @@
 /**
- * @since 1.0.0
+ * This module exposes database primitives.
+ * @module
+ *
+ * @since 0.1.2
  */
+
 import * as KeyValueStore from "@effect/platform/KeyValueStore";
-import type * as Layer from "effect/Layer";
+import * as Layer from "effect/Layer";
+import { makeKvStore } from "./internal/kv.ts";
 
 /**
  * Creates a {@linkcode KeyValueStore} layer that uses the Web-native {@linkcode localStorage} API.
  *
  * Values are stored between sessions.
  *
- * @since 1.0.0
- * @category models
+ * @since 0.1.2
+ * @category layer
  */
 export const layerLocalStorage: Layer.Layer<KeyValueStore.KeyValueStore> =
   KeyValueStore.layerStorage(() => localStorage);
@@ -20,8 +25,21 @@ export const layerLocalStorage: Layer.Layer<KeyValueStore.KeyValueStore> =
  *
  * Values are stored only for the current session.
  *
- * @since 1.0.0
- * @category models
+ * @since 0.1.2
+ * @category layer
  */
 export const layerSessionStorage: Layer.Layer<KeyValueStore.KeyValueStore> =
   KeyValueStore.layerStorage(() => sessionStorage);
+
+/**
+ * Creates a {@linkcode KeyValueStore} layer that uses Deno’s cloud-native {@linkcode Deno.Kv} API.
+ *
+ * @remarks
+ * This does not support gradual adoption,
+ * and will fail semi-gracefully on non-`string` or {@linkcode Uint8Array} values.
+ *kvStore
+ * @since 0.1.2
+ * @category layer
+ */
+export const layerKv: Layer.Layer<KeyValueStore.KeyValueStore, never, never> =
+  Layer.effect(KeyValueStore.KeyValueStore, makeKvStore());

packages/platform-deno/src/DenoPath.ts

@@ -2,6 +2,27 @@
  * This module exposes path operations from the Deno Standard Library.
  * @module
  *
+ *
+ * @example
+ * ```ts
+ * import { Path } from "@effect/platform";
+ * import { DenoContext, DenoRuntime } from "@lishaduck/effect-platform-deno";
+ * import { assertEquals } from "@std/assert";
+ * import { Console, Effect } from "effect";
+ *
+ * const program = Effect.gen(function* () {
+ *   // Access the Path service
+ *   const path = yield* Path.Path;
+ *
+ *   // Join parts of a path to create a complete file path
+ *   const extension = path.extname("file.txt");
+ *
+ *   assertEquals(extension, ".txt");
+ * });
+ *
+ * DenoRuntime.runMain(program.pipe(Effect.provide(DenoContext.layer)));
+ * ```
+ *
  * @since 0.1.0
  */
 

packages/platform-deno/src/DenoRuntime.ts

@@ -2,6 +2,14 @@
  * This module exposes an {@link https://effect.website/docs/runtime/ | Effect Runtime} powered by Deno.
  * @module
  *
+ * @example
+ * ```ts
+ * import { DenoContext, DenoRuntime } from "@lishaduck/effect-platform-deno";
+ * import { Console, Effect } from "effect";
+ *
+ * DenoRuntime.runMain(Console.log("Hello, World").pipe(Effect.provide(DenoContext.layer)));
+ * ```
+ *
  * @since 0.1.0
  */
 

packages/platform-deno/src/DenoWorkerRunner.ts

@@ -2,8 +2,9 @@
  * This modules exposes primitives for multithread-communication using the standard {@linkcode MessagePort} API.
  * @module
  *
- * @since 1.0.0
+ * @since 0.1.1
  */
+
 import { WorkerRunner as Runner, WorkerError } from "@effect/platform";
 import {
   Context,
@@ -34,7 +35,7 @@ if (typeof self !== "undefined" && "onconnect" in self) {
 /**
  * Constructs a {@linkplain Runner.PlatformRunner | runner} from a {@linkcode MessagePort}.
  *
- * @since 1.0.0
+ * @since 0.1.1
  * @category constructors
  */
 export const make: (self: MessagePort | Window) => Runner.PlatformRunner = (
@@ -199,7 +200,7 @@ export const make: (self: MessagePort | Window) => Runner.PlatformRunner = (
 /**
  * A {@linkplain Layer.Layer | layer} that provides a {@linkcode Runner.PlatformRunner | PlatformRunner} from {@linkcode self} to your app.
  *
- * @since 1.0.0
+ * @since 0.1.1
  * @category layers
  */
 export const layer: Layer.Layer<Runner.PlatformRunner> = Layer.sync(
@@ -210,7 +211,7 @@ export const layer: Layer.Layer<Runner.PlatformRunner> = Layer.sync(
 /**
  * A {@linkplain Layer.Layer | layer} that provides a {@linkcode Runner.PlatformRunner | PlatformRunner} from a {@linkcode MessagePort} to your app.
  *
- * @since 1.0.0
+ * @since 0.1.1
  * @category layers
  */
 export const layerMessagePort: (

packages/platform-deno/src/internal/kv.ts

@@ -0,0 +1,102 @@
+import { KeyValueStore } from "@effect/platform";
+import type { PlatformError } from "@effect/platform/Error";
+import { Effect, Option } from "effect";
+
+export const makeKvStore = (): Effect.Effect<KeyValueStore.KeyValueStore> =>
+  Effect.promise(async () => {
+    const store = await Deno.openKv();
+    const encoder = new TextEncoder();
+
+    const get = (key: string): Effect.Effect<Option.Option<string>> =>
+      Effect.promise(async () => {
+        const val = await store.get([key]);
+        const value = val.value;
+
+        if (value == null) return Option.none();
+        if (typeof value === "string") return Option.some(value);
+
+        return Option.none();
+      });
+
+    const getUint8Array = (
+      key: string,
+    ): Effect.Effect<Option.Option<Uint8Array>> =>
+      Effect.gen(function* () {
+        const val = yield* Effect.promise(async () => await store.get([key]));
+
+        const value = Option.fromNullable(val.key[0]);
+
+        return value.pipe(
+          Option.flatMap((value) => {
+            if (typeof value === "string") {
+              return Option.some(encoder.encode(value));
+            }
+            if (value instanceof Uint8Array) {
+              return Option.some(value);
+            }
+
+            return Option.none();
+          }),
+        );
+      });
+
+    const modifyUint8Array = (
+      key: string,
+      f: (value: Uint8Array) => Uint8Array,
+    ): Effect.Effect<Option.Option<Uint8Array>, PlatformError> =>
+      Effect.flatMap(getUint8Array(key), (o) => {
+        if (Option.isNone(o)) {
+          return Effect.succeedNone;
+        }
+        const newValue = f(o.value);
+        return Effect.as(set(key, newValue), Option.some(newValue));
+      });
+
+    const set = (
+      key: string,
+      value: string | Uint8Array,
+    ): Effect.Effect<void> =>
+      Effect.promise(async () => {
+        await store.set([key], value);
+      });
+
+    const remove = (key: string): Effect.Effect<void> =>
+      Effect.promise(async () => {
+        await store.delete([key]);
+      });
+
+    const getAll = <T>(): Deno.KvListIterator<T> =>
+      store.list<T>({ prefix: [] });
+
+    const clear = Effect.promise(async () => {
+      const entries = getAll();
+
+      const promises: Promise<void>[] = [];
+
+      for await (const entry of entries) {
+        promises.push(store.delete(entry.key));
+      }
+
+      await Promise.all(promises);
+    });
+
+    const size = Effect.promise(async () => {
+      const entries = getAll();
+
+      let size = 0;
+      for await (const _ of entries) {
+        size++;
+      }
+      return size;
+    });
+
+    return KeyValueStore.make({
+      get,
+      getUint8Array,
+      modifyUint8Array,
+      set,
+      remove,
+      clear,
+      size,
+    });
+  });

packages/platform-deno/src/mod.ts

@@ -23,75 +23,10 @@
  * ```
  */
 
-/**
- * Provides a platform context using Deno.
- *
- * @example
- * ```ts
- * import { Path } from "@effect/platform";
- * import { DenoContext, DenoRuntime } from "@lishaduck/effect-platform-deno";
- * import { assertEquals } from "@std/assert";
- * import { Console, Effect } from "effect";
- *
- * const program = Effect.gen(function* () {
- *   // Access the Path service
- *   const path = yield* Path.Path;
- *
- *   // Join parts of a path to create a complete file path
- *   const fileName = path.basename("some/directory/file.txt");
- *
- *   assertEquals(fileName, "file.txt");
- * });
- *
- * DenoRuntime.runMain(program.pipe(Effect.provide(DenoContext.layer)));
- * ```
- *
- * @since 0.1.0
- */
 export * as DenoContext from "./DenoContext.ts";
-
-/**
- * An effect runtime using Deno.
- *
- * @example
- * ```ts
- * import { DenoContext, DenoRuntime } from "@lishaduck/effect-platform-deno";
- * import { Console, Effect } from "effect";
- *
- * DenoRuntime.runMain(Console.log("Hello, World").pipe(Effect.provide(DenoContext.layer)));
- * ```
- *
- * @since 0.1.0
- */
+export * as DenoFileSystem from "./DenoFileSystem.ts";
+export * as DenoKeyValueStore from "./DenoKeyValueStore.ts";
 export * as DenoRuntime from "./DenoRuntime.ts";
-
-/**
- * @since 0.1.0
- *
- * @example
- * ```ts
- * import { Path } from "@effect/platform";
- * import { DenoContext, DenoRuntime } from "@lishaduck/effect-platform-deno";
- * import { assertEquals } from "@std/assert";
- * import { Console, Effect } from "effect";
- *
- * const program = Effect.gen(function* () {
- *   // Access the Path service
- *   const path = yield* Path.Path;
- *
- *   // Join parts of a path to create a complete file path
- *   const extension = path.extname("file.txt");
- *
- *   assertEquals(extension, ".txt");
- * });
- *
- * DenoRuntime.runMain(program.pipe(Effect.provide(DenoContext.layer)));
- * ```
- *
- */
 export * as DenoPath from "./DenoPath.ts";
-
-/**
- * @since 0.1.0
- */
 export * as DenoWorker from "./DenoWorker.ts";
+export * as DenoWorkerRunner from "./DenoWorkerRunner.ts";