unikvs 0.0.12 → 0.0.13

package/src/_types.ts

@@ -0,0 +1,237 @@
+import type {
+  IStorage,
+  IMiddleware,
+  IReadableStreamStorage,
+  IWritableStreamStorage,
+} from "@unikvs/core";
+
+export type ValueOf<T> = T[keyof T];
+
+/**
+ * ミドルウェアから、エンコード時の入力データ (生データ) の型を推論するユーティリティー型です。
+ *
+ * @template TMiddleware 対象となるミドルウェアの型です。
+ */
+export type $InferEncodeDataInput<TMiddleware extends IMiddleware> =
+  TMiddleware extends IMiddleware<infer TEncodeDataInput> ? TEncodeDataInput : never;
+
+/**
+ * ミドルウェアから、エンコード時の出力データ (符号化済み) の型を推論するユーティリティー型です。
+ *
+ * @template TMiddleware 対象となるミドルウェアの型です。
+ */
+export type $InferEncodeDataOutput<TMiddleware extends IMiddleware> =
+  TMiddleware extends IMiddleware<any, infer TEncodeDataOutput> ? TEncodeDataOutput : never;
+
+/**
+ * ミドルウェアから、デコード時の入力データ (符号化済み) の型を推論するユーティリティー型です。
+ * 分岐先頭の親出力受容検査に使用します。
+ *
+ * @template TMiddleware 対象となるミドルウェアの型です。
+ */
+export type $InferDecodeDataInput<TMiddleware extends IMiddleware> =
+  TMiddleware extends IMiddleware<any, infer TDecodeDataInput> ? TDecodeDataInput : never;
+
+/**
+ * ミドルウェアから、デコード時の出力データ (生データ) の型を推論するユーティリティー型です。
+ * 分岐先頭の親入力受容検査に使用します。
+ *
+ * @template TMiddleware 対象となるミドルウェアの型です。
+ */
+export type $InferDecodeDataOutput<TMiddleware extends IMiddleware> =
+  TMiddleware extends IMiddleware<infer TDecodeDataOutput> ? TDecodeDataOutput : never;
+
+/**
+ * ミドルウェアから、デコードストリームの入力チャンクデータの型を推論するユーティリティー型です。
+ *
+ * @template TMiddleware 対象となるミドルウェアの型です。
+ */
+export type $InferDecodeChunkInput<TMiddleware extends IMiddleware> =
+  TMiddleware extends IMiddleware<any, any, any, infer TDecodeChunkInput>
+    ? TDecodeChunkInput
+    : never;
+
+/**
+ * ミドルウェアから、エンコードストリームの出力チャンクデータの型を推論するユーティリティー型です。
+ *
+ * @template TMiddleware 対象となるミドルウェアの型です。
+ */
+export type $InferEncodeChunkOutput<TMiddleware extends IMiddleware> =
+  TMiddleware extends IMiddleware<any, any, any, infer TEncodeChunkOutput>
+    ? TEncodeChunkOutput
+    : never;
+
+/**
+ * ミドルウェアから、エンコードストリームの入力チャンクデータの型を推論するユーティリティー型です。
+ * 分岐先頭のチャンク検査に使用します。
+ *
+ * @template TMiddleware 対象となるミドルウェアの型です。
+ */
+export type $InferEncodeChunkInput<TMiddleware extends IMiddleware> =
+  TMiddleware extends IMiddleware<any, any, infer TEncodeChunkInput> ? TEncodeChunkInput : never;
+
+/**
+ * ミドルウェアから、デコードストリームの出力チャンクデータの型を推論するユーティリティー型です。
+ * 分岐先頭のチャンク検査に使用します。
+ *
+ * @template TMiddleware 対象となるミドルウェアの型です。
+ */
+export type $InferDecodeChunkOutput<TMiddleware extends IMiddleware> =
+  TMiddleware extends IMiddleware<any, any, infer TDecodeChunkOutput> ? TDecodeChunkOutput : never;
+
+/**
+ * ストレージから、書き込みデータの入力型を推論するユーティリティー型です。
+ * 分岐先頭の親出力受容検査に使用します。
+ *
+ * @template TStorage 対象となるストレージの型です。
+ */
+export type $InferWriteDataInput<TStorage extends IStorage> =
+  TStorage extends IStorage<infer TWriteDataInput, any, any, any> ? TWriteDataInput : never;
+
+/**
+ * ストレージから、読み込みデータの出力型を推論するユーティリティー型です。
+ * 分岐先頭の親入力受容検査に使用します。
+ *
+ * @template TStorage 対象となるストレージの型です。
+ */
+export type $InferReadDataOutput<TStorage extends IStorage> =
+  TStorage extends IStorage<any, infer TReadDataOutput, any, any> ? TReadDataOutput : never;
+
+/**
+ * ストレージから、書き込みストリームの入力チャンクデータの型を推論するユーティリティー型です。
+ *
+ * @template TStorage 対象となるストレージの型です。
+ */
+export type $InferWriteChunkInput<TStorage extends IStorage> =
+  TStorage extends IWritableStreamStorage<infer TWriteChunkInput> ? TWriteChunkInput : never;
+
+/**
+ * ストレージから、読み込みストリームの出力チャンクデータの型を推論するユーティリティー型です。
+ *
+ * @template TStorage 対象となるストレージの型です。
+ */
+export type $InferReadChunkOutput<TStorage extends IStorage> =
+  TStorage extends IReadableStreamStorage<infer TReadChunkOutput> ? TReadChunkOutput : never;
+
+/**
+ * `any` かどうかを判定するユーティリティー型です。
+ * 分岐先頭の空判定で `any` を `unknown` と区別するために使用します。
+ *
+ * @template T 判定する型です。
+ */
+export type $IsAny<T> = 0 extends 1 & T ? true : false;
+
+/**
+ * `unknown` かどうかを判定するユーティリティー型です。
+ * 空ブランチの先頭マーカー検出に使用します。
+ *
+ * @template T 判定する型です。
+ */
+export type $IsUnknown<T> =
+  $IsAny<T> extends true
+    ? false
+    : [T] extends [unknown]
+      ? [unknown] extends [T]
+        ? true
+        : false
+      : false;
+
+/**
+ * `never` かどうかを判定するユーティリティー型です。
+ * チャンクの非対応判定に使用します。
+ *
+ * @template T 判定する型です。
+ */
+export type $IsNever<T> = [T] extends [never] ? true : false;
+
+/**
+ * 親出力が分岐先頭のエンコード入力を受容できるかを検査するユーティリティー型です。
+ * 不適合時は `never` を返し、`fork` 引数を `never` 化して型エラーを発生させます。
+ * 先頭のみを検査します。
+ * 中間以降は検査しません。
+ *
+ * @template TParentOutput 親の現出力型です。
+ * @template TBranchHeadInput 分岐先頭の入力型です。
+ */
+export type $CheckForkEncodeData<TParentOutput, TBranchHeadInput> =
+  $IsUnknown<TBranchHeadInput> extends true
+    ? unknown
+    : $IsAny<TBranchHeadInput> extends true
+      ? unknown
+      : $IsAny<TParentOutput> extends true
+        ? unknown
+        : [TParentOutput] extends [TBranchHeadInput]
+          ? unknown
+          : never;
+
+/**
+ * 分岐先頭のデコード出力が親入力を受容できるかを検査するユーティリティー型です。
+ * 不適合時は `never` を返します。
+ * 先頭のみを検査します。
+ * 中間以降は検査しません。
+ *
+ * @template TParentInput 親の現入力型です。
+ * @template TBranchHeadOutput 分岐先頭の出力型です。
+ */
+export type $CheckForkDecodeData<TParentInput, TBranchHeadOutput> =
+  $IsUnknown<TBranchHeadOutput> extends true
+    ? unknown
+    : $IsAny<TBranchHeadOutput> extends true
+      ? unknown
+      : $IsAny<TParentInput> extends true
+        ? unknown
+        : [TBranchHeadOutput] extends [TParentInput]
+          ? unknown
+          : never;
+
+/**
+ * 親チャンク出力が分岐先頭チャンク入力を受容できるかを検査するユーティリティー型です。
+ * ストリーム非対応の `never` は許容します。
+ * 先頭のみを検査します。
+ * 中間以降は検査しません。
+ *
+ * @template TParentOutput 親の現チャンク出力型です。
+ * @template TBranchHeadInput 分岐先頭のチャンク入力型です。
+ */
+export type $CheckForkEncodeChunk<TParentOutput, TBranchHeadInput> =
+  $IsUnknown<TBranchHeadInput> extends true
+    ? unknown
+    : $IsAny<TBranchHeadInput> extends true
+      ? unknown
+      : $IsAny<TParentOutput> extends true
+        ? unknown
+        : $IsUnknown<TParentOutput> extends true
+          ? unknown
+          : $IsNever<TParentOutput> extends true
+            ? unknown
+            : $IsNever<TBranchHeadInput> extends true
+              ? unknown
+              : [TParentOutput] extends [TBranchHeadInput]
+                ? unknown
+                : never;
+
+/**
+ * 分岐先頭チャンク出力が親チャンク入力を受容できるかを検査するユーティリティー型です。
+ * ストリーム非対応の `never` は許容します。
+ * 先頭のみを検査します。
+ * 中間以降は検査しません。
+ *
+ * @template TParentInput 親の現チャンク入力型です。
+ * @template TBranchHeadOutput 分岐先頭のチャンク出力型です。
+ */
+export type $CheckForkDecodeChunk<TParentInput, TBranchHeadOutput> =
+  $IsUnknown<TBranchHeadOutput> extends true
+    ? unknown
+    : $IsAny<TBranchHeadOutput> extends true
+      ? unknown
+      : $IsAny<TParentInput> extends true
+        ? unknown
+        : $IsUnknown<TParentInput> extends true
+          ? unknown
+          : $IsNever<TParentInput> extends true
+            ? unknown
+            : $IsNever<TBranchHeadOutput> extends true
+              ? unknown
+              : [TBranchHeadOutput] extends [TParentInput]
+                ? unknown
+                : never;

package/src/_unikvs-branch.ts

@@ -0,0 +1,94 @@
+import type UniKvsMiddleware from "./_middleware.js";
+import type UniKvsStorage from "./_storage.js";
+import type { IUniKvsBranch } from "./unikvs-branch.js";
+
+/**
+ * `fork` で親に引き継がれる分岐先の情報です。
+ */
+type BranchDestination = {
+  /**
+   * データの永続化先です。
+   */
+  readonly storage: UniKvsStorage;
+
+  /**
+   * ストレージに対するパイプラインです。
+   * 登録順に保持します。
+   */
+  readonly middlewares: readonly UniKvsMiddleware[];
+};
+
+/**
+ * `UniKvsBranch` のインスタンスごとの内部状態です。
+ * ネイティブの `#` フィールドの代わりに `WeakMap` に保持することで、別モジュールの `UniKvsBuilder` から内部アクセサー経由で参照できます。
+ * `branchStates` 自体は外部に公開しません。
+ */
+export type BranchState = {
+  /**
+   * 自前の相対パイプラインです。
+   * 登録順に保持します。
+   */
+  readonly middlewares: UniKvsMiddleware[];
+
+  /**
+   * 自前の分岐先と各登録時点の相対パイプラインのスナップショットです。
+   */
+  readonly destinations: BranchDestination[];
+};
+
+/**
+ * インスタンスと内部状態の対応表です。
+ * コンパイラーによる `#` フィールドのダウンレベルと同様に、`WeakMap` をブランド兼ストレージとして使います。
+ */
+export const branchStates: WeakMap<IUniKvsBranch, BranchState> = /* #__PURE__ */ new WeakMap<
+  IUniKvsBranch,
+  BranchState
+>();
+
+/**
+ * 分岐先のスナップショットを返します。
+ *
+ * 親の `fork` で接頭辞付加するために使用します。
+ * `new Branch()` で作成された分岐以外の値が渡されたときは例外を投げます。
+ * 外部からは使用しません。
+ *
+ * @param branch スナップショットを取得する分岐です。
+ *
+ * @returns 分岐先のコピーを返します。
+ */
+export function getBranchDestinationsForFork(branch: IUniKvsBranch): BranchDestination[] {
+  const state = branchStates.get(branch);
+
+  if (!state) {
+    throw new TypeError("fork() expects a branch created by new Branch().");
+  }
+
+  // コピーを返します。親の fork で接頭辞を付けても、元の分岐は変更されません。
+  return state.destinations.map((dest) => ({
+    storage: dest.storage,
+    middlewares: [...dest.middlewares],
+  }));
+}
+
+/**
+ * 分岐先を親の接頭辞付きで追加します。
+ *
+ * @param destinations 追加先の分岐先列です。
+ * @param prefix 親のミドルウェア列です。
+ * @param branch 追加する分岐です。
+ */
+export function appendForkDestinations(
+  destinations: BranchDestination[],
+  prefix: readonly UniKvsMiddleware[],
+  branch: IUniKvsBranch,
+): void {
+  const prefixSnapshot = [...prefix];
+
+  for (const dest of getBranchDestinationsForFork(branch)) {
+    destinations.push({
+      storage: dest.storage,
+      // fork 時点の親チェーンを接頭辞として各分岐先の先頭に付け、ブランチのミドルウェアを結合します。
+      middlewares: [...prefixSnapshot, ...dest.middlewares],
+    });
+  }
+}