unikvs 0.0.2 → 0.0.3

package/src/core/transformer.types.ts

@@ -0,0 +1,110 @@
+import type { Context } from "./context.types.js";
+import type { IPlugin } from "./plugin.types.js";
+import type { MaybePromise } from "./utils.types.js";
+
+// export interface IEncodeBatchTransformer<
+//   TEncodeDataInput = any,
+//   TEncodeDataOutput = any,
+// > {
+//   encode(
+//     data: TEncodeDataInput,
+//     signal: AbortSignal,
+//     context: Context,
+//   ): MaybePromise<TEncodeDataOutput>;
+// }
+
+// export interface IDecodeBatchTransformer<
+//   TDecodeDataInput = any,
+//   TDecodeDataOutput = any,
+// > {
+//   decode(
+//     data: TDecodeDataInput,
+//     signal: AbortSignal,
+//     context: Context,
+//   ): MaybePromise<TDecodeDataOutput>;
+// }
+
+// export interface IBatchTransformer<
+//   TEncodeDataInput = any,
+//   TDecodeDataInput = any,
+//   TEncodeDataOutput = TDecodeDataInput,
+//   TDecodeDataOutput = TEncodeDataInput,
+// > extends
+//   IEncodeBatchTransformer<TEncodeDataInput, TEncodeDataOutput>,
+//   IDecodeBatchTransformer<TDecodeDataInput, TDecodeDataOutput>
+// {}
+
+export interface IEncodable<
+  TEncodeChunkInput = any,
+  TEncodeChunkOutput = any,
+> extends TransformStream<TEncodeChunkInput, TEncodeChunkOutput> {}
+
+export interface IEncodableStreamTransformer<TEncodeChunkInput = any, TEncodeChunkOutput = any> {
+  getEncodable(
+    signal: AbortSignal,
+    context: Context,
+  ): MaybePromise<IEncodable<TEncodeChunkInput, TEncodeChunkOutput>>;
+}
+
+export interface IDecodable<
+  TDecodeChunkInput = any,
+  TDecodeChunkOutput = any,
+> extends TransformStream<TDecodeChunkInput, TDecodeChunkOutput> {}
+
+export interface IDecodableStreamTransformer<TDecodeChunkInput = any, TDecodeChunkOutput = any> {
+  getDecodable(
+    signal: AbortSignal,
+    context: Context,
+  ): MaybePromise<IDecodable<TDecodeChunkInput, TDecodeChunkOutput>>;
+}
+
+// export interface IStreamTransformer<
+//   TEncodeChunkInput = any,
+//   TDecodeChunkInput = any,
+//   TEncodeChunkOutput = TDecodeChunkInput,
+//   TDecodeChunkOutput = TEncodeChunkInput,
+// > extends
+//   IEncodableStreamTransformer<TEncodeChunkInput, TEncodeChunkOutput>,
+//   IDecodableStreamTransformer<TDecodeChunkInput, TDecodeChunkOutput>
+// {}
+
+export interface ITransformer<
+  TEncodeDataInput = any,
+  TDecodeDataInput = any,
+  TEncodeDataOutput = any,
+  TDecodeDataOutput = any,
+  TEncodeChunkInput = any,
+  TDecodeChunkInput = any,
+  TEncodeChunkOutput = any,
+  TDecodeChunkOutput = any,
+>
+  extends
+    IPlugin,
+    // IBatchTransformer<
+    //   TEncodeDataInput,
+    //   TDecodeDataInput,
+    //   TEncodeDataOutput,
+    //   TDecodeDataOutput
+    // >,
+    // Partial<
+    //   IStreamTransformer<
+    //     TEncodeChunkInput,
+    //     TDecodeChunkInput,
+    //     TEncodeChunkOutput,
+    //     TDecodeChunkOutput
+    //   >
+    // >
+    Partial<IEncodableStreamTransformer<TEncodeChunkInput, TEncodeChunkOutput>>,
+    Partial<IDecodableStreamTransformer<TDecodeChunkInput, TDecodeChunkOutput>> {
+  encode(
+    data: TEncodeDataInput,
+    signal: AbortSignal,
+    context: Context,
+  ): MaybePromise<TEncodeDataOutput>;
+
+  decode(
+    data: TDecodeDataInput,
+    signal: AbortSignal,
+    context: Context,
+  ): MaybePromise<TDecodeDataOutput>;
+}

package/src/core/unikvs-config.ts

@@ -0,0 +1,230 @@
+import toContext from "./_to-context.js";
+import type { Context, ContextSource } from "./context.types.js";
+import type {
+  IReadableStreamStorage,
+  IStorage,
+  IWritableStreamStorage,
+  Key,
+} from "./storage.types.js";
+import type {
+  IDecodableStreamTransformer,
+  IEncodableStreamTransformer,
+  ITransformer,
+} from "./transformer.types.js";
+import type UniKvs from "./unikvs.js";
+import type { ValueOf } from "./utils.types.js";
+
+type $InferDecodeDataInput<TTransformer extends ITransformer> =
+  TTransformer extends ITransformer<any, infer TDecodeDataInput> ? TDecodeDataInput : never;
+
+type $InferEncodeDataOutput<TTransformer extends ITransformer> =
+  TTransformer extends ITransformer<any, any, infer TEncodeDataOutput> ? TEncodeDataOutput : never;
+
+type $InferDecodeChunkInput<TTransformer extends ITransformer> =
+  TTransformer extends IDecodableStreamTransformer<infer TDecodeChunkInput>
+    ? TDecodeChunkInput
+    : never;
+
+type $InferEncodeChunkOutput<TTransformer extends ITransformer> =
+  TTransformer extends IEncodableStreamTransformer<any, infer TEncodeChunkOutput>
+    ? TEncodeChunkOutput
+    : never;
+
+type $InferWriteChunkInput<TStorage extends IStorage> =
+  TStorage extends IWritableStreamStorage<infer TWriteChunkInput> ? TWriteChunkInput : never;
+
+type $InferReadChunkOutput<TStorage extends IStorage> =
+  TStorage extends IReadableStreamStorage<infer TReadChunkOutput> ? TReadChunkOutput : never;
+
+declare const PLAIN_VALUE: unique symbol;
+export type PlainValue<TData = any> = [Kind: typeof PLAIN_VALUE, Data: TData];
+
+declare const STREAM_VALUE: unique symbol;
+export type StreamValue<TChunkData = any> = [Kind: typeof STREAM_VALUE, ChunkData: TChunkData];
+
+export type Value<TDataAndChunkData = any> =
+  | PlainValue<TDataAndChunkData>
+  | StreamValue<TDataAndChunkData>;
+
+export type KeyValueMapping<T = any> = { readonly [key: Key]: Value<T> };
+
+export type $InferPlainValueData<TPlainValue> =
+  TPlainValue extends PlainValue<infer TData> ? TData : never;
+
+export type $InferStreamValueChunkData<TStremValue> =
+  TStremValue extends StreamValue<infer TChunkData> ? TChunkData : never;
+
+export type KeyofKeyValueMapping<TKeyValueMapping extends KeyValueMapping = KeyValueMapping> =
+  Extract<keyof TKeyValueMapping, Key>;
+
+export interface IUniKvsConfigBuilder<
+  TKeyValueMapping extends KeyValueMapping = KeyValueMapping,
+  TUniKvsDataInput = ValueOf<{
+    [TKey in KeyofKeyValueMapping<TKeyValueMapping>]: $InferPlainValueData<TKeyValueMapping[TKey]>;
+  }>,
+  TUniKvsDataOutput = TUniKvsDataInput,
+  TUniKvsChunkInput = ValueOf<{
+    [TKey in KeyofKeyValueMapping<TKeyValueMapping>]: $InferStreamValueChunkData<
+      TKeyValueMapping[TKey]
+    >;
+  }>,
+  TUniKvsChunkOutput = TUniKvsChunkInput,
+  TLastTransformerDecodeDataInput = TUniKvsDataOutput,
+  TLastTransformerEncodeDataOutput = TUniKvsDataInput,
+  TLastTransformerDecodeChunkInput = TUniKvsChunkOutput,
+  TLastTransformerEncodeChunkOutput = TUniKvsChunkInput,
+> {
+  setContext(context: ContextSource): this;
+
+  appendStorage<
+    TStorage extends IStorage<
+      [TLastTransformerEncodeDataOutput] extends [never] ? any : TLastTransformerEncodeDataOutput,
+      [TLastTransformerDecodeDataInput] extends [never] ? any : TLastTransformerDecodeDataInput,
+      [TLastTransformerEncodeChunkOutput] extends [never] ? any : TLastTransformerEncodeChunkOutput,
+      [TLastTransformerDecodeChunkInput] extends [never] ? any : TLastTransformerDecodeChunkInput
+    >,
+  >(
+    storage: TStorage,
+  ): IUniKvsConfigFinalizer<
+    TKeyValueMapping,
+    TLastTransformerEncodeDataOutput,
+    TLastTransformerDecodeDataInput,
+    [TLastTransformerEncodeChunkOutput] extends [never]
+      ? never
+      : [$InferWriteChunkInput<TStorage>] extends [never]
+        ? never
+        : TLastTransformerEncodeChunkOutput,
+    [TLastTransformerDecodeChunkInput] extends [never]
+      ? never
+      : [$InferReadChunkOutput<TStorage>] extends [never]
+        ? never
+        : TLastTransformerDecodeChunkInput
+  >;
+
+  appendTransformer<
+    TTransformer extends ITransformer<
+      // 最後のトランスファーマーのエンコード出力を、入力値として受け入れられる必要があります。
+      [TLastTransformerEncodeDataOutput] extends [never] ? any : TLastTransformerEncodeDataOutput,
+      // ここではまだ、後段のトランスフォーマーのデコード出力を気にしません。
+      any,
+      // ここではまだ、後段のトランスフォーマーのエンコード入力を気にしません。
+      any,
+      // 最後のトランスフォーマーのデコード入力を出力する必要があります。
+      [TLastTransformerDecodeDataInput] extends [never] ? any : TLastTransformerDecodeDataInput,
+      // 最後のトランスファーマーのエンコード出力を、入力値として受け入れられる必要があります。
+      [TLastTransformerEncodeChunkOutput] extends [never] ? any : TLastTransformerEncodeChunkOutput,
+      // ここではまだ、後段のトランスフォーマーのデコード出力を気にしません。
+      any,
+      // ここではまだ、後段のトランスフォーマーのエンコード入力を気にしません。
+      any,
+      // 最後のトランスフォーマーのデコード入力を出力する必要があります。
+      [TLastTransformerDecodeChunkInput] extends [never] ? any : TLastTransformerDecodeChunkInput
+    >,
+  >(
+    transformer: TTransformer,
+  ): IUniKvsConfigBuilder<
+    TKeyValueMapping,
+    TUniKvsDataInput,
+    TUniKvsDataOutput,
+    [TUniKvsChunkInput] extends [never]
+      ? never
+      : [$InferDecodeChunkInput<TTransformer>] extends [never]
+        ? never
+        : TUniKvsChunkInput,
+    [TUniKvsChunkOutput] extends [never]
+      ? never
+      : [$InferEncodeChunkOutput<TTransformer>] extends [never]
+        ? never
+        : TUniKvsChunkOutput,
+    $InferDecodeDataInput<TTransformer>,
+    $InferEncodeDataOutput<TTransformer>,
+    $InferDecodeChunkInput<TTransformer>,
+    $InferEncodeChunkOutput<TTransformer>
+  >;
+}
+
+export interface IUniKvsConfigFinalizer<
+  TKeyValueMapping extends KeyValueMapping = KeyValueMapping,
+  TWriteDataInput = any,
+  TReadDataOutput = any,
+  TWriteChunkInput = any,
+  TReadChunkOutput = any,
+> {
+  create(): UniKvs<TKeyValueMapping>;
+
+  setContext(context: ContextSource): this;
+
+  appendStorage<
+    TStorage extends IStorage<
+      [TWriteDataInput] extends [never] ? any : TWriteDataInput,
+      [TReadDataOutput] extends [never] ? any : TReadDataOutput,
+      [TWriteChunkInput] extends [never] ? any : TWriteChunkInput,
+      [TReadChunkOutput] extends [never] ? any : TReadChunkOutput
+    >,
+  >(
+    storage: TStorage,
+  ): IUniKvsConfigFinalizer<
+    TKeyValueMapping,
+    TWriteDataInput,
+    TReadDataOutput,
+    [TWriteChunkInput] extends [never]
+      ? never
+      : [$InferWriteChunkInput<TStorage>] extends [never]
+        ? never
+        : TWriteChunkInput,
+    [TReadChunkOutput] extends [never]
+      ? never
+      : [$InferReadChunkOutput<TStorage>] extends [never]
+        ? never
+        : TReadChunkOutput
+  >;
+}
+
+export default class UniKvsConfig implements IUniKvsConfigBuilder, IUniKvsConfigFinalizer {
+  readonly #UniKvs: typeof UniKvs;
+
+  #context: Context;
+
+  readonly #destinations: IStorage[];
+
+  readonly #transformers: ITransformer[];
+
+  public constructor(UniKvsConstructor: typeof UniKvs) {
+    this.#UniKvs = UniKvsConstructor;
+    this.#context = {};
+    this.#destinations = [];
+    this.#transformers = [];
+  }
+
+  public create(): UniKvs {
+    const [dest, ...destinations] = this.#destinations;
+    if (!dest) {
+      throw new Error("UniKvs を使用するためには最低 1 つのストレージが必要です。");
+    }
+
+    return new this.#UniKvs(
+      { ...this.#context },
+      [dest, ...destinations],
+      this.#transformers.slice(),
+    );
+  }
+
+  public setContext(context: ContextSource): this {
+    this.#context = toContext(context, { copy: true });
+    return this;
+  }
+
+  public appendStorage(storage: IStorage): IUniKvsConfigFinalizer {
+    this.#destinations.push(storage);
+    return this;
+  }
+
+  public appendTransformer(transformer: ITransformer): IUniKvsConfigBuilder {
+    if (this.#destinations.length > 0) {
+      throw new Error("ストレージが登録された後にトランスフォーマーを追加することはできません。");
+    }
+
+    this.#transformers.push(transformer);
+    return this;
+  }
+}