unikvs 0.0.10 → 0.0.13

package/src/index.ts

@@ -1,52 +1,72 @@
-export type * from "./context.types.js";
-
 export type {
-  DecodableStreamNotSupportedErrorArgs,
-  DecodableStreamNotSupportedErrorMeta,
-  EncodableStreamNotSupportedErrorArgs,
-  EncodableStreamNotSupportedErrorMeta,
+  Issue,
+  KeyNotFoundErrorArgs,
+  KeyNotFoundErrorMeta,
   InvalidInputErrorArgs,
   InvalidInputErrorMeta,
   InvalidOutputErrorArgs,
   InvalidOutputErrorMeta,
-  Issue,
-  KeyNotFoundErrorArgs,
-  KeyNotFoundErrorMeta,
+  StorageIsNotOpenErrorArgs,
+  StorageIsNotOpenErrorMeta,
+  MiddlewareIsNotOpenErrorArgs,
+  MiddlewareIsNotOpenErrorMeta,
+  MiddlewareNextNotCalledErrorArgs,
+  MiddlewareNextNotCalledErrorMeta,
+  MiddlewareNextNotAwaitedErrorArgs,
+  MiddlewareNextNotAwaitedErrorMeta,
   PluginOperationAggregateErrorArgs,
   PluginOperationAggregateErrorMeta,
+  MultipartWriteNotSupportedErrorArgs,
+  MultipartWriteNotSupportedErrorMeta,
   ReadableStreamNotSupportedErrorArgs,
   ReadableStreamNotSupportedErrorMeta,
-  StorageIsNotOpenErrorArgs,
-  StorageIsNotOpenErrorMeta,
-  TransformerIsNotOpenErrorArgs,
-  TransformerIsNotOpenErrorMeta,
+  StreamDecodingNotSupportedErrorArgs,
+  StreamDecodingNotSupportedErrorMeta,
+  StreamEncodingNotSupportedErrorArgs,
+  StreamEncodingNotSupportedErrorMeta,
   WritableStreamNotSupportedErrorArgs,
   WritableStreamNotSupportedErrorMeta,
+  MiddlewareDestinationFrozenErrorArgs,
+  MiddlewareDestinationFrozenErrorMeta,
+  MiddlewareDestinationMissingErrorArgs,
+  MiddlewareDestinationMissingErrorMeta,
+  MiddlewareNextCalledMultipleTimesErrorArgs,
+  MiddlewareNextCalledMultipleTimesErrorMeta,
 } from "./errors.js";
 export {
-  DecodableStreamNotSupportedError,
-  EncodableStreamNotSupportedError,
+  KeyNotFoundError,
   InvalidInputError,
+  UniKvsIsOpenError,
   InvalidOutputError,
-  InvalidUsageErrorBase,
-  KeyNotFoundError,
   MissingStorageError,
+  UniKvsIsNotOpenError,
+  InvalidUsageErrorBase,
+  StorageIsNotOpenError,
+  MiddlewareIsNotOpenError,
+  MiddlewareNextNotCalledError,
+  MiddlewareNextNotAwaitedError,
   PluginOperationAggregateError,
+  MultipartWriteNotSupportedError,
   ReadableStreamNotSupportedError,
-  StorageIsNotOpenError,
-  TransformerIsNotOpenError,
-  TransformerRegistrationError,
-  UniKvsIsNotOpenError,
-  UniKvsIsOpenError,
+  StreamDecodingNotSupportedError,
+  StreamEncodingNotSupportedError,
   WritableStreamNotSupportedError,
+  MiddlewareDestinationFrozenError,
+  MiddlewareDestinationMissingError,
+  MiddlewareNextCalledMultipleTimesError,
 } from "./errors.js";
 
-export type * from "./unikvs-config.js";
-export { default as UniKvsConfig } from "./unikvs-config.js";
+export type * from "./types.js";
+
+export type * from "./unikvs-branch.js";
+export { default as UniKvsBranch, default as Branch } from "./unikvs-branch.js";
+
+export type * from "./unikvs-builder.js";
+export { default as UniKvsBuilder, default as Builder } from "./unikvs-builder.js";
 
 export type * from "./unikvs.js";
 export { default as UniKvs } from "./unikvs.js";
 
-export type * from "./utils.types.js";
+export type * from "./unikvs.types.js";
 
-export type * from "./value-stream.types.js";
+export * from "./value-schemas.js";

package/src/types.ts

@@ -0,0 +1,13 @@
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/unikvs#value-stream)
+ */
+export interface IValueStream<T = any>
+  extends
+    Omit<ReadableStream, keyof AsyncDisposable | keyof AsyncIterable<unknown>>,
+    AsyncDisposable,
+    AsyncIterable<T, void, unknown> {
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/unikvs#value-stream)
+   */
+  dispose: (this: void) => Promise<void>;
+}

package/src/unikvs-branch.ts

@@ -0,0 +1,445 @@
+import type { IStorage, IMiddleware } from "@unikvs/core";
+
+import UniKvsMiddleware from "./_middleware.js";
+import UniKvsStorage from "./_storage.js";
+import type {
+  $IsUnknown,
+  $CheckForkDecodeData,
+  $CheckForkEncodeData,
+  $InferReadDataOutput,
+  $InferWriteDataInput,
+  $CheckForkDecodeChunk,
+  $CheckForkEncodeChunk,
+  $InferDecodeDataInput,
+  $InferEncodeDataInput,
+  $InferReadChunkOutput,
+  $InferWriteChunkInput,
+  $InferDecodeChunkInput,
+  $InferDecodeDataOutput,
+  $InferEncodeChunkInput,
+  $InferEncodeDataOutput,
+  $InferDecodeChunkOutput,
+  $InferEncodeChunkOutput,
+} from "./_types.js";
+import { type BranchState, branchStates, appendForkDestinations } from "./_unikvs-branch.js";
+import type { Value } from "./value-schemas.js";
+
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/unikvs#value-types)
+ */
+export type KeyValueMapping<T = any> = Readonly<Record<string, Value<T>>>;
+
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/unikvs#builder)
+ */
+export interface IUniKvsBranch<
+  TKeyValueMapping extends KeyValueMapping = KeyValueMapping,
+  TBranchChunkInput = any,
+  TBranchChunkOutput = any,
+  THeadEncodeDataInput = unknown,
+  THeadDecodeDataOutput = unknown,
+  THeadEncodeChunkInput = unknown,
+  THeadDecodeChunkOutput = unknown,
+  TLastDecodeDataInput = any,
+  TLastEncodeDataOutput = any,
+  TLastDecodeChunkInput = any,
+  TLastEncodeChunkOutput = any,
+  TBranchHasPersist extends boolean = false,
+> {
+  fork<
+    TSubChunkInput,
+    TSubChunkOutput,
+    TSubHeadEncodeDataInput,
+    TSubHeadDecodeDataOutput,
+    TSubHeadEncodeChunkInput,
+    TSubHeadDecodeChunkOutput,
+    TSubLastDecodeDataInput,
+    TSubLastEncodeDataOutput,
+    TSubLastDecodeChunkInput,
+    TSubLastEncodeChunkOutput,
+    TSubHasPersist extends boolean,
+  >(
+    branch: IUniKvsBranch<
+      any,
+      TSubChunkInput,
+      TSubChunkOutput,
+      TSubHeadEncodeDataInput,
+      TSubHeadDecodeDataOutput,
+      TSubHeadEncodeChunkInput,
+      TSubHeadDecodeChunkOutput,
+      TSubLastDecodeDataInput,
+      TSubLastEncodeDataOutput,
+      TSubLastDecodeChunkInput,
+      TSubLastEncodeChunkOutput,
+      TSubHasPersist
+    > &
+      (TSubHasPersist extends true
+        ? $CheckForkEncodeData<TLastEncodeDataOutput, TSubHeadEncodeDataInput>
+        : unknown) &
+      (TSubHasPersist extends true
+        ? $CheckForkDecodeData<TLastDecodeDataInput, TSubHeadDecodeDataOutput>
+        : unknown) &
+      (TSubHasPersist extends true
+        ? $CheckForkEncodeChunk<TLastEncodeChunkOutput, TSubHeadEncodeChunkInput>
+        : unknown) &
+      (TSubHasPersist extends true
+        ? $CheckForkDecodeChunk<TLastDecodeChunkInput, TSubHeadDecodeChunkOutput>
+        : unknown),
+  ): IUniKvsBranch<
+    TKeyValueMapping,
+    TSubHasPersist extends true
+      ? [TBranchChunkInput] extends [never]
+        ? never
+        : [TSubChunkInput] extends [never]
+          ? never
+          : TBranchChunkInput
+      : TBranchChunkInput,
+    TSubHasPersist extends true
+      ? [TBranchChunkOutput] extends [never]
+        ? never
+        : [TSubChunkOutput] extends [never]
+          ? never
+          : TBranchChunkOutput
+      : TBranchChunkOutput,
+    TSubHasPersist extends true
+      ? $IsUnknown<THeadEncodeDataInput> extends true
+        ? TSubHeadEncodeDataInput
+        : THeadEncodeDataInput
+      : THeadEncodeDataInput,
+    TSubHasPersist extends true
+      ? $IsUnknown<THeadDecodeDataOutput> extends true
+        ? TSubHeadDecodeDataOutput
+        : THeadDecodeDataOutput
+      : THeadDecodeDataOutput,
+    TSubHasPersist extends true
+      ? $IsUnknown<THeadEncodeChunkInput> extends true
+        ? TSubHeadEncodeChunkInput
+        : THeadEncodeChunkInput
+      : THeadEncodeChunkInput,
+    TSubHasPersist extends true
+      ? $IsUnknown<THeadDecodeChunkOutput> extends true
+        ? TSubHeadDecodeChunkOutput
+        : THeadDecodeChunkOutput
+      : THeadDecodeChunkOutput,
+    TLastDecodeDataInput,
+    TLastEncodeDataOutput,
+    TLastDecodeChunkInput,
+    TLastEncodeChunkOutput,
+    TBranchHasPersist extends true ? true : TSubHasPersist
+  >;
+
+  use<
+    TMiddleware extends IMiddleware<
+      [TLastEncodeDataOutput] extends [never] ? any : TLastEncodeDataOutput,
+      any,
+      [TLastEncodeChunkOutput] extends [never] ? any : TLastEncodeChunkOutput
+    >,
+  >(
+    middleware: TMiddleware,
+  ): IUniKvsBranch<
+    TKeyValueMapping,
+    [TBranchChunkInput] extends [never]
+      ? never
+      : [$InferDecodeChunkInput<TMiddleware>] extends [never]
+        ? never
+        : TBranchChunkInput,
+    [TBranchChunkOutput] extends [never]
+      ? never
+      : [$InferEncodeChunkOutput<TMiddleware>] extends [never]
+        ? never
+        : TBranchChunkOutput,
+    $IsUnknown<THeadEncodeDataInput> extends true
+      ? $InferEncodeDataInput<TMiddleware>
+      : THeadEncodeDataInput,
+    $IsUnknown<THeadDecodeDataOutput> extends true
+      ? $InferDecodeDataOutput<TMiddleware>
+      : THeadDecodeDataOutput,
+    $IsUnknown<THeadEncodeChunkInput> extends true
+      ? $InferEncodeChunkInput<TMiddleware>
+      : THeadEncodeChunkInput,
+    $IsUnknown<THeadDecodeChunkOutput> extends true
+      ? $InferDecodeChunkOutput<TMiddleware>
+      : THeadDecodeChunkOutput,
+    $InferDecodeDataInput<TMiddleware>,
+    $InferEncodeDataOutput<TMiddleware>,
+    $InferDecodeChunkInput<TMiddleware>,
+    $InferEncodeChunkOutput<TMiddleware>,
+    TBranchHasPersist
+  >;
+
+  persist<
+    TStorage extends IStorage<
+      [TLastEncodeDataOutput] extends [never] ? any : TLastEncodeDataOutput,
+      [TLastDecodeDataInput] extends [never] ? any : TLastDecodeDataInput,
+      [TLastEncodeChunkOutput] extends [never] ? any : TLastEncodeChunkOutput,
+      [TLastDecodeChunkInput] extends [never] ? any : TLastDecodeChunkInput
+    >,
+  >(
+    storage: TStorage,
+  ): IUniKvsBranch<
+    TKeyValueMapping,
+    [TBranchChunkInput] extends [never]
+      ? never
+      : [$InferWriteChunkInput<TStorage>] extends [never]
+        ? never
+        : TBranchChunkInput,
+    [TBranchChunkOutput] extends [never]
+      ? never
+      : [$InferReadChunkOutput<TStorage>] extends [never]
+        ? never
+        : TBranchChunkOutput,
+    $IsUnknown<THeadEncodeDataInput> extends true
+      ? $InferWriteDataInput<TStorage>
+      : THeadEncodeDataInput,
+    $IsUnknown<THeadDecodeDataOutput> extends true
+      ? $InferReadDataOutput<TStorage>
+      : THeadDecodeDataOutput,
+    $IsUnknown<THeadEncodeChunkInput> extends true
+      ? $InferWriteChunkInput<TStorage>
+      : THeadEncodeChunkInput,
+    $IsUnknown<THeadDecodeChunkOutput> extends true
+      ? $InferReadChunkOutput<TStorage>
+      : THeadDecodeChunkOutput,
+    TLastDecodeDataInput,
+    TLastEncodeDataOutput,
+    TLastDecodeChunkInput,
+    TLastEncodeChunkOutput,
+    true
+  >;
+}
+
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/unikvs#builder)
+ */
+export default class UniKvsBranch<
+  TKeyValueMapping extends KeyValueMapping = KeyValueMapping,
+  TBranchChunkInput = any,
+  TBranchChunkOutput = any,
+  THeadEncodeDataInput = unknown,
+  THeadDecodeDataOutput = unknown,
+  THeadEncodeChunkInput = unknown,
+  THeadDecodeChunkOutput = unknown,
+  TLastDecodeDataInput = any,
+  TLastEncodeDataOutput = any,
+  TLastDecodeChunkInput = any,
+  TLastEncodeChunkOutput = any,
+  TBranchHasPersist extends boolean = false,
+> implements IUniKvsBranch<
+  TKeyValueMapping,
+  TBranchChunkInput,
+  TBranchChunkOutput,
+  THeadEncodeDataInput,
+  THeadDecodeDataOutput,
+  THeadEncodeChunkInput,
+  THeadDecodeChunkOutput,
+  TLastDecodeDataInput,
+  TLastEncodeDataOutput,
+  TLastDecodeChunkInput,
+  TLastEncodeChunkOutput,
+  TBranchHasPersist
+> {
+  public constructor() {
+    branchStates.set(this, {
+      middlewares: [],
+      destinations: [],
+    });
+  }
+
+  /**
+   * この分岐の構築状態を取得します。
+   *
+   * @returns 構築状態を返します。
+   */
+  #branchState(): BranchState {
+    const state = branchStates.get(this);
+
+    if (state === undefined) {
+      throw new Error("分岐の構築状態が見つかりません。");
+    }
+
+    return state;
+  }
+
+  public fork<
+    TSubChunkInput,
+    TSubChunkOutput,
+    TSubHeadEncodeDataInput,
+    TSubHeadDecodeDataOutput,
+    TSubHeadEncodeChunkInput,
+    TSubHeadDecodeChunkOutput,
+    TSubLastDecodeDataInput,
+    TSubLastEncodeDataOutput,
+    TSubLastDecodeChunkInput,
+    TSubLastEncodeChunkOutput,
+    TSubHasPersist extends boolean,
+  >(
+    branch: IUniKvsBranch<
+      any,
+      TSubChunkInput,
+      TSubChunkOutput,
+      TSubHeadEncodeDataInput,
+      TSubHeadDecodeDataOutput,
+      TSubHeadEncodeChunkInput,
+      TSubHeadDecodeChunkOutput,
+      TSubLastDecodeDataInput,
+      TSubLastEncodeDataOutput,
+      TSubLastDecodeChunkInput,
+      TSubLastEncodeChunkOutput,
+      TSubHasPersist
+    > &
+      (TSubHasPersist extends true
+        ? $CheckForkEncodeData<TLastEncodeDataOutput, TSubHeadEncodeDataInput>
+        : unknown) &
+      (TSubHasPersist extends true
+        ? $CheckForkDecodeData<TLastDecodeDataInput, TSubHeadDecodeDataOutput>
+        : unknown) &
+      (TSubHasPersist extends true
+        ? $CheckForkEncodeChunk<TLastEncodeChunkOutput, TSubHeadEncodeChunkInput>
+        : unknown) &
+      (TSubHasPersist extends true
+        ? $CheckForkDecodeChunk<TLastDecodeChunkInput, TSubHeadDecodeChunkOutput>
+        : unknown),
+  ): IUniKvsBranch<
+    TKeyValueMapping,
+    TSubHasPersist extends true
+      ? [TBranchChunkInput] extends [never]
+        ? never
+        : [TSubChunkInput] extends [never]
+          ? never
+          : TBranchChunkInput
+      : TBranchChunkInput,
+    TSubHasPersist extends true
+      ? [TBranchChunkOutput] extends [never]
+        ? never
+        : [TSubChunkOutput] extends [never]
+          ? never
+          : TBranchChunkOutput
+      : TBranchChunkOutput,
+    TSubHasPersist extends true
+      ? $IsUnknown<THeadEncodeDataInput> extends true
+        ? TSubHeadEncodeDataInput
+        : THeadEncodeDataInput
+      : THeadEncodeDataInput,
+    TSubHasPersist extends true
+      ? $IsUnknown<THeadDecodeDataOutput> extends true
+        ? TSubHeadDecodeDataOutput
+        : THeadDecodeDataOutput
+      : THeadDecodeDataOutput,
+    TSubHasPersist extends true
+      ? $IsUnknown<THeadEncodeChunkInput> extends true
+        ? TSubHeadEncodeChunkInput
+        : THeadEncodeChunkInput
+      : THeadEncodeChunkInput,
+    TSubHasPersist extends true
+      ? $IsUnknown<THeadDecodeChunkOutput> extends true
+        ? TSubHeadDecodeChunkOutput
+        : THeadDecodeChunkOutput
+      : THeadDecodeChunkOutput,
+    TLastDecodeDataInput,
+    TLastEncodeDataOutput,
+    TLastDecodeChunkInput,
+    TLastEncodeChunkOutput,
+    TBranchHasPersist extends true ? true : TSubHasPersist
+  >;
+  public fork(branch: IUniKvsBranch): IUniKvsBranch {
+    const state = this.#branchState();
+    appendForkDestinations(state.destinations, state.middlewares, branch);
+
+    return this;
+  }
+
+  public use<
+    TMiddleware extends IMiddleware<
+      [TLastEncodeDataOutput] extends [never] ? any : TLastEncodeDataOutput,
+      any,
+      [TLastEncodeChunkOutput] extends [never] ? any : TLastEncodeChunkOutput
+    >,
+  >(
+    middleware: TMiddleware,
+  ): IUniKvsBranch<
+    TKeyValueMapping,
+    [TBranchChunkInput] extends [never]
+      ? never
+      : [$InferDecodeChunkInput<TMiddleware>] extends [never]
+        ? never
+        : TBranchChunkInput,
+    [TBranchChunkOutput] extends [never]
+      ? never
+      : [$InferEncodeChunkOutput<TMiddleware>] extends [never]
+        ? never
+        : TBranchChunkOutput,
+    $IsUnknown<THeadEncodeDataInput> extends true
+      ? $InferEncodeDataInput<TMiddleware>
+      : THeadEncodeDataInput,
+    $IsUnknown<THeadDecodeDataOutput> extends true
+      ? $InferDecodeDataOutput<TMiddleware>
+      : THeadDecodeDataOutput,
+    $IsUnknown<THeadEncodeChunkInput> extends true
+      ? $InferEncodeChunkInput<TMiddleware>
+      : THeadEncodeChunkInput,
+    $IsUnknown<THeadDecodeChunkOutput> extends true
+      ? $InferDecodeChunkOutput<TMiddleware>
+      : THeadDecodeChunkOutput,
+    $InferDecodeDataInput<TMiddleware>,
+    $InferEncodeDataOutput<TMiddleware>,
+    $InferDecodeChunkInput<TMiddleware>,
+    $InferEncodeChunkOutput<TMiddleware>,
+    TBranchHasPersist
+  >;
+  public use(middleware: IMiddleware): IUniKvsBranch {
+    const state = this.#branchState();
+    state.middlewares.push(UniKvsMiddleware.from(middleware));
+
+    return this;
+  }
+
+  public persist<
+    TStorage extends IStorage<
+      [TLastEncodeDataOutput] extends [never] ? any : TLastEncodeDataOutput,
+      [TLastDecodeDataInput] extends [never] ? any : TLastDecodeDataInput,
+      [TLastEncodeChunkOutput] extends [never] ? any : TLastEncodeChunkOutput,
+      [TLastDecodeChunkInput] extends [never] ? any : TLastDecodeChunkInput
+    >,
+  >(
+    storage: TStorage,
+  ): IUniKvsBranch<
+    TKeyValueMapping,
+    [TBranchChunkInput] extends [never]
+      ? never
+      : [$InferWriteChunkInput<TStorage>] extends [never]
+        ? never
+        : TBranchChunkInput,
+    [TBranchChunkOutput] extends [never]
+      ? never
+      : [$InferReadChunkOutput<TStorage>] extends [never]
+        ? never
+        : TBranchChunkOutput,
+    $IsUnknown<THeadEncodeDataInput> extends true
+      ? $InferWriteDataInput<TStorage>
+      : THeadEncodeDataInput,
+    $IsUnknown<THeadDecodeDataOutput> extends true
+      ? $InferReadDataOutput<TStorage>
+      : THeadDecodeDataOutput,
+    $IsUnknown<THeadEncodeChunkInput> extends true
+      ? $InferWriteChunkInput<TStorage>
+      : THeadEncodeChunkInput,
+    $IsUnknown<THeadDecodeChunkOutput> extends true
+      ? $InferReadChunkOutput<TStorage>
+      : THeadDecodeChunkOutput,
+    TLastDecodeDataInput,
+    TLastEncodeDataOutput,
+    TLastDecodeChunkInput,
+    TLastEncodeChunkOutput,
+    true
+  >;
+  public persist(storage: IStorage): IUniKvsBranch {
+    const state = this.#branchState();
+    state.destinations.push({
+      storage: UniKvsStorage.from(storage),
+      // 登録時点のチェーンをスナップショットして保持するため、以降の use はこの登録に影響しません。
+      middlewares: [...state.middlewares],
+    });
+
+    return this;
+  }
+}