@fireproof/core-gateways-base 0.0.0-smoke-1b31059-1752074105

package/fp-envelope-serialize.ts

@@ -0,0 +1,208 @@
+import { exception2Result, Result, URI } from "@adviser/cement";
+import type {
+  CarClockLink,
+  DbMeta,
+  DbMetaBinary,
+  DbMetaEvent,
+  FPDecoder,
+  FPEncoder,
+  LinkOrCid,
+  SerializedMeta,
+  SerializedWAL,
+  WALState,
+} from "@fireproof/core-types-blockstore";
+import {
+  FPEnvelope,
+  FPEnvelopeCar,
+  FPEnvelopeFile,
+  FPEnvelopeMeta,
+  FPEnvelopeType,
+  FPEnvelopeTypes,
+  FPEnvelopeWAL,
+} from "@fireproof/core-types-blockstore";
+import { PARAM, PromiseToUInt8, SuperThis } from "@fireproof/core-types-base";
+import { decodeEventBlock, EventBlock } from "@web3-storage/pail/clock";
+import { base64pad } from "multiformats/bases/base64";
+import { CID, Link } from "multiformats";
+import { fromJSON } from "multiformats/link";
+import { format, parse } from "@ipld/dag-json";
+import { EventView } from "@web3-storage/pail/clock/api";
+import { coercePromiseIntoUint8 } from "@fireproof/core-runtime";
+
+export async function dbMetaEvent2Serialized(
+  sthis: SuperThis,
+  dbEvents: Omit<DbMetaEvent, "eventCid">[],
+): Promise<SerializedMeta[]> {
+  return await Promise.all(
+    dbEvents.map(async (dbEvent) => {
+      const event = await EventBlock.create<DbMetaBinary>(
+        {
+          dbMeta: sthis.txt.encode(format(dbEvent.dbMeta)),
+        },
+        dbEvent.parents as unknown as Link<EventView<DbMetaBinary>, number, number, 1>[],
+      );
+      return {
+        cid: event.cid.toString(),
+        parents: dbEvent.parents.map((i) => i.toString()),
+        data: base64pad.encode(event.bytes),
+      } satisfies SerializedMeta;
+    }),
+  );
+}
+
+function WALState2Serialized(sthis: SuperThis, wal: WALState): SerializedWAL {
+  const serializedWAL: SerializedWAL = {
+    fileOperations: wal.fileOperations.map((fop) => ({
+      cid: fop.cid.toString(),
+      public: fop.public,
+    })),
+    noLoaderOps: wal.noLoaderOps.map((nop) => ({
+      cars: nop.cars.map((i) => i.toString()),
+    })),
+    operations: wal.operations.map((op) => ({
+      cars: op.cars.map((i) => i.toString()),
+    })),
+  };
+  return serializedWAL;
+}
+
+const defaultEncoder: FPEncoder = {
+  car: async (sthis: SuperThis, payload: Uint8Array) => Result.Ok(payload),
+  file: async (sthis: SuperThis, payload: Uint8Array) => Result.Ok(payload),
+  meta: async (sthis: SuperThis, payload: SerializedMeta[]) => Result.Ok(sthis.txt.encode(JSON.stringify(payload))),
+  wal: async (sthis: SuperThis, payload: SerializedWAL) => Result.Ok(sthis.txt.encode(JSON.stringify(payload))),
+};
+
+export async function fpSerialize<T>(
+  sthis: SuperThis,
+  env: FPEnvelope<T>,
+  pencoder?: Partial<FPEncoder>,
+): Promise<Result<Uint8Array>> {
+  const encoder = {
+    ...defaultEncoder,
+    ...pencoder,
+  };
+  switch (env.type) {
+    case FPEnvelopeTypes.FILE:
+      return encoder.file(sthis, (env as FPEnvelopeFile).payload);
+    case FPEnvelopeTypes.CAR:
+      return encoder.car(sthis, (env as FPEnvelopeCar).payload);
+    case FPEnvelopeTypes.WAL:
+      return encoder.wal(sthis, WALState2Serialized(sthis, (env as FPEnvelopeWAL).payload));
+    case FPEnvelopeTypes.META:
+      return encoder.meta(sthis, await dbMetaEvent2Serialized(sthis, (env as FPEnvelopeMeta).payload));
+    default:
+      throw sthis.logger.Error().Str("type", env.type).Msg("unsupported store").AsError();
+  }
+}
+
+export async function decode2DbMetaEvents(
+  sthis: SuperThis,
+  rserializedMeta: Result<SerializedMeta[]>,
+): Promise<Result<DbMetaEvent[]>> {
+  if (rserializedMeta.isErr()) {
+    return Result.Err(rserializedMeta.Err());
+  }
+  const serializedMeta = rserializedMeta.unwrap();
+  if (!Array.isArray(serializedMeta)) {
+    return sthis.logger.Debug().Any("metaEntries", serializedMeta).Msg("No data in MetaEntries").ResultError();
+  }
+  // if (!serializedMeta.length) {
+  //   return sthis.logger.Debug().Msg("No MetaEntries found").ResultError();
+  // }
+  return Result.Ok(
+    await Promise.all(
+      serializedMeta.map(async (metaEntry) => {
+        const eventBlock = await decodeEventBlock<DbMetaBinary>(base64pad.decode(metaEntry.data));
+        const dbMeta = parse<DbMeta>(sthis.txt.decode(eventBlock.value.data.dbMeta));
+        return {
+          eventCid: eventBlock.cid as CarClockLink,
+          parents: metaEntry.parents.map((i: string) => CID.parse(i)),
+          dbMeta,
+        } satisfies DbMetaEvent;
+      }),
+    ),
+  );
+}
+
+function toCid(sthis: SuperThis, link: LinkOrCid): CID {
+  if (typeof link === "string") {
+    return CID.parse(link);
+  }
+  return fromJSON(link);
+}
+
+async function decode2WalState(sthis: SuperThis, rserializedWAL: Result<SerializedWAL>): Promise<Result<WALState>> {
+  if (rserializedWAL.isErr()) {
+    return Result.Err(rserializedWAL.Err());
+  }
+  const serializedWAL = rserializedWAL.unwrap();
+  return Result.Ok({
+    fileOperations: (serializedWAL.fileOperations || []).map((fop) => ({
+      cid: toCid(sthis, fop.cid),
+      public: fop.public,
+    })),
+    noLoaderOps: (serializedWAL.noLoaderOps || []).map((nop) => ({
+      cars: (nop.cars || []).map((i) => toCid(sthis, i)),
+    })),
+    operations: (serializedWAL.operations || []).map((op) => ({
+      cars: (op.cars || []).map((i) => toCid(sthis, i)),
+    })),
+  });
+}
+// export type CARDecodeEnvelopeBase = (sthis: SuperThis, payload: Uint8Array) => Promise<Result<Uint8Array>>;
+// export type FILEDecodeEnvelopeBase = (sthis: SuperThis, payload: Uint8Array) => Promise<Result<Uint8Array>>;
+// export type WALDecodeEnvelopeBase = (sthis: SuperThis, payload: SerializedWAL) => Promise<Result<SerializedWAL>>;
+// export type METADecodeEnvelopeBase = (sthis: SuperThis, payload: SerializedMeta[]) => Promise<Result<SerializedMeta[]>>;
+
+const defaultDecoder = {
+  car: async (sthis: SuperThis, payload: Uint8Array) => Result.Ok(payload),
+  file: async (sthis: SuperThis, payload: Uint8Array) => Result.Ok(payload),
+  meta: async (sthis: SuperThis, payload: Uint8Array) =>
+    exception2Result(() => JSON.parse(sthis.txt.decode(payload)) as SerializedMeta[]),
+  wal: async (sthis: SuperThis, payload: Uint8Array) =>
+    exception2Result(() => JSON.parse(sthis.txt.decode(payload)) as SerializedWAL),
+};
+
+function makeFPEnvelope<S>(type: FPEnvelopeType, payload: Result<S>): Result<FPEnvelope<S>> {
+  if (payload.isErr()) {
+    return Result.Err(payload.Err());
+  }
+  return Result.Ok({
+    type,
+    payload: payload.unwrap(),
+  });
+}
+
+export async function fpDeserialize<S>(
+  sthis: SuperThis,
+  url: URI,
+  intoRaw: PromiseToUInt8,
+  pdecoder?: Partial<FPDecoder>,
+): Promise<Result<FPEnvelope<S>>> {
+  const rraw = await coercePromiseIntoUint8(intoRaw);
+  if (rraw.isErr()) {
+    return Result.Err(rraw.Err());
+  }
+  const raw = rraw.unwrap();
+  const decoder = {
+    ...defaultDecoder,
+    ...pdecoder,
+  };
+  switch (url.getParam(PARAM.STORE)) {
+    case "car":
+      return makeFPEnvelope(FPEnvelopeTypes.CAR, await decoder.car(sthis, raw)) as Result<FPEnvelope<S>>;
+    case "file":
+      return makeFPEnvelope(FPEnvelopeTypes.FILE, await decoder.file(sthis, raw)) as Result<FPEnvelope<S>>;
+    case "wal":
+      return makeFPEnvelope(FPEnvelopeTypes.WAL, await decode2WalState(sthis, await decoder.wal(sthis, raw))) as Result<
+        FPEnvelope<S>
+      >;
+    case "meta":
+      return makeFPEnvelope(FPEnvelopeTypes.META, await decode2DbMetaEvents(sthis, await decoder.meta(sthis, raw))) as Result<
+        FPEnvelope<S>
+      >;
+    default:
+      return sthis.logger.Error().Str("store", url.getParam(PARAM.STORE)).Msg("unsupported store").ResultError();
+  }
+}

package/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./fp-envelope-serialize.js";
+export * from "./def-serde-gateway.js";
+export * from "./interceptor-gateway.js";
+export * from "./uri-interceptor.js";
+export * from "./utils.js";
+export * from "./indexeddb-version.js";
+export * from "./meta-key-hack.js";

package/index.js

@@ -0,0 +1,8 @@
+export * from "./fp-envelope-serialize.js";
+export * from "./def-serde-gateway.js";
+export * from "./interceptor-gateway.js";
+export * from "./uri-interceptor.js";
+export * from "./utils.js";
+export * from "./indexeddb-version.js";
+export * from "./meta-key-hack.js";
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAC;AAC3C,cAAc,wBAAwB,CAAC;AACvC,cAAc,0BAA0B,CAAC;AACzC,cAAc,sBAAsB,CAAC;AACrC,cAAc,YAAY,CAAC;AAC3B,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC"}

package/index.ts

@@ -0,0 +1,7 @@
+export * from "./fp-envelope-serialize.js";
+export * from "./def-serde-gateway.js";
+export * from "./interceptor-gateway.js";
+export * from "./uri-interceptor.js";
+export * from "./utils.js";
+export * from "./indexeddb-version.js";
+export * from "./meta-key-hack.js";

package/indexeddb-version.d.ts

@@ -0,0 +1 @@
+export declare const INDEXEDDB_VERSION = "v0.19-indexeddb";

package/indexeddb-version.js

@@ -0,0 +1,2 @@
+export const INDEXEDDB_VERSION = "v0.19-indexeddb";
+//# sourceMappingURL=indexeddb-version.js.map

package/indexeddb-version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexeddb-version.js","sourceRoot":"","sources":["indexeddb-version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,iBAAiB,GAAG,iBAAiB,CAAC"}

package/indexeddb-version.ts

@@ -0,0 +1 @@
+export const INDEXEDDB_VERSION = "v0.19-indexeddb";

package/interceptor-gateway.d.ts

@@ -0,0 +1,27 @@
+import { Result, URI } from "@adviser/cement";
+import type { FPEnvelope, FPEnvelopeMeta, SerdeGateway, SerdeGatewayBuildUrlReturn, SerdeGatewayCloseReturn, SerdeGatewayCtx, SerdeGatewayDeleteReturn, SerdeGatewayDestroyReturn, SerdeGatewayGetReturn, SerdeGatewayInterceptor, SerdeGatewayPutReturn, SerdeGatewayStartReturn, SerdeGatewaySubscribeReturn, SerdeGetResult, UnsubscribeResult, VoidResult } from "@fireproof/core-types-blockstore";
+import type { SuperThis } from "@fireproof/core-types-base";
+export declare class PassThroughGateway implements SerdeGatewayInterceptor {
+    buildUrl(ctx: SerdeGatewayCtx, url: URI, key: string): Promise<Result<SerdeGatewayBuildUrlReturn>>;
+    start(ctx: SerdeGatewayCtx, url: URI): Promise<Result<SerdeGatewayStartReturn>>;
+    close(ctx: SerdeGatewayCtx, url: URI): Promise<Result<SerdeGatewayCloseReturn>>;
+    delete(ctx: SerdeGatewayCtx, url: URI): Promise<Result<SerdeGatewayDeleteReturn>>;
+    destroy(ctx: SerdeGatewayCtx, url: URI): Promise<Result<SerdeGatewayDestroyReturn>>;
+    put<T>(ctx: SerdeGatewayCtx, url: URI, body: FPEnvelope<T>): Promise<Result<SerdeGatewayPutReturn<T>>>;
+    get<S>(ctx: SerdeGatewayCtx, url: URI): Promise<Result<SerdeGatewayGetReturn<S>>>;
+    subscribe(ctx: SerdeGatewayCtx, url: URI, callback: (meta: FPEnvelopeMeta) => Promise<void>): Promise<Result<SerdeGatewaySubscribeReturn>>;
+}
+export declare class InterceptorGateway implements SerdeGateway {
+    readonly innerGW: SerdeGateway;
+    readonly interceptor: SerdeGatewayInterceptor;
+    constructor(sthis: SuperThis, innerGW: SerdeGateway, interceptor: SerdeGatewayInterceptor | undefined);
+    buildUrl(ctx: SerdeGatewayCtx, baseUrl: URI, key: string): Promise<Result<URI>>;
+    destroy(ctx: SerdeGatewayCtx, iurl: URI): Promise<Result<void>>;
+    start(ctx: SerdeGatewayCtx, url: URI): Promise<Result<URI>>;
+    close(ctx: SerdeGatewayCtx, url: URI): Promise<VoidResult>;
+    put<T>(ctx: SerdeGatewayCtx, url: URI, fpEnv: FPEnvelope<T>): Promise<VoidResult>;
+    get<S>(ctx: SerdeGatewayCtx, url: URI): Promise<SerdeGetResult<S>>;
+    subscribe(ctx: SerdeGatewayCtx, url: URI, callback: (msg: FPEnvelopeMeta) => Promise<void>): Promise<UnsubscribeResult>;
+    delete(ctx: SerdeGatewayCtx, url: URI): Promise<VoidResult>;
+    getPlain(ctx: SerdeGatewayCtx, url: URI, key: string): Promise<Result<Uint8Array>>;
+}

package/interceptor-gateway.js

@@ -0,0 +1,139 @@
+import { Result } from "@adviser/cement";
+export class PassThroughGateway {
+    async buildUrl(ctx, url, key) {
+        const op = { url, key };
+        return Result.Ok({ op });
+    }
+    async start(ctx, url) {
+        const op = { url };
+        return Result.Ok({ op });
+    }
+    async close(ctx, url) {
+        const op = { url };
+        return Result.Ok({ op });
+    }
+    async delete(ctx, url) {
+        const op = { url };
+        return Result.Ok({ op });
+    }
+    async destroy(ctx, url) {
+        const op = { url };
+        return Result.Ok({ op });
+    }
+    async put(ctx, url, body) {
+        const op = { url, body };
+        return Result.Ok({ op });
+    }
+    async get(ctx, url) {
+        const op = { url };
+        return Result.Ok({ op });
+    }
+    async subscribe(ctx, url, callback) {
+        const op = { url, callback };
+        return Result.Ok({ op });
+    }
+}
+const passThrougthGateway = new PassThroughGateway();
+export class InterceptorGateway {
+    innerGW;
+    interceptor;
+    constructor(sthis, innerGW, interceptor) {
+        this.innerGW = innerGW;
+        this.interceptor = interceptor || passThrougthGateway;
+    }
+    async buildUrl(ctx, baseUrl, key) {
+        const rret = await this.interceptor.buildUrl(ctx, baseUrl, key);
+        if (rret.isErr()) {
+            return Result.Err(rret.Err());
+        }
+        const ret = rret.unwrap();
+        if (ret.stop && ret.value) {
+            return ret.value;
+        }
+        return this.innerGW.buildUrl(ctx, ret.op.url, ret.op.key);
+    }
+    async destroy(ctx, iurl) {
+        const rret = await this.interceptor.destroy(ctx, iurl);
+        if (rret.isErr()) {
+            return Result.Err(rret.Err());
+        }
+        const ret = rret.unwrap();
+        if (ret.stop && ret.value) {
+            return ret.value;
+        }
+        return this.innerGW.destroy(ctx, ret.op.url);
+    }
+    async start(ctx, url) {
+        const rret = await this.interceptor.start(ctx, url);
+        if (rret.isErr()) {
+            return Result.Err(rret.Err());
+        }
+        const ret = rret.unwrap();
+        if (ret.stop && ret.value) {
+            return ret.value;
+        }
+        return await this.innerGW.start(ctx, ret.op.url);
+    }
+    async close(ctx, url) {
+        const rret = await this.interceptor.close(ctx, url);
+        if (rret.isErr()) {
+            return Result.Err(rret.Err());
+        }
+        const ret = rret.unwrap();
+        if (ret.stop && ret.value) {
+            return ret.value;
+        }
+        return await this.innerGW.close(ctx, ret.op.url);
+    }
+    async put(ctx, url, fpEnv) {
+        const rret = await this.interceptor.put(ctx, url, fpEnv);
+        if (rret.isErr()) {
+            return Result.Err(rret.Err());
+        }
+        const ret = rret.unwrap();
+        if (ret.stop && ret.value) {
+            return ret.value;
+        }
+        return this.innerGW.put(ctx, ret.op.url, ret.op.body);
+    }
+    async get(ctx, url) {
+        const rret = await this.interceptor.get(ctx, url);
+        if (rret.isErr()) {
+            return Result.Err(rret.Err());
+        }
+        const ret = rret.unwrap();
+        if (ret.stop && ret.value) {
+            return ret.value;
+        }
+        return this.innerGW.get(ctx, ret.op.url);
+    }
+    async subscribe(ctx, url, callback) {
+        if (!this.innerGW.subscribe) {
+            return Result.Err(ctx.loader.sthis.logger.Error().Url(url).Msg("subscribe not supported").AsError());
+        }
+        const rret = await this.interceptor.subscribe(ctx, url, callback);
+        if (rret.isErr()) {
+            return Result.Err(rret.Err());
+        }
+        const ret = rret.unwrap();
+        if (ret.stop && ret.value) {
+            return ret.value;
+        }
+        return this.innerGW.subscribe(ctx, ret.op.url, ret.op.callback);
+    }
+    async delete(ctx, url) {
+        const rret = await this.interceptor.delete(ctx, url);
+        if (rret.isErr()) {
+            return Result.Err(rret.Err());
+        }
+        const ret = rret.unwrap();
+        if (ret.stop && ret.value) {
+            return ret.value;
+        }
+        return this.innerGW.delete(ctx, url);
+    }
+    async getPlain(ctx, url, key) {
+        return this.innerGW.getPlain(ctx, url, key);
+    }
+}
+//# sourceMappingURL=interceptor-gateway.js.map

package/interceptor-gateway.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interceptor-gateway.js","sourceRoot":"","sources":["interceptor-gateway.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAO,MAAM,iBAAiB,CAAC;AAqB9C,MAAM,OAAO,kBAAkB;IAC7B,KAAK,CAAC,QAAQ,CAAC,GAAoB,EAAE,GAAQ,EAAE,GAAW;QACxD,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;QACxB,OAAO,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAC3B,CAAC;IACD,KAAK,CAAC,KAAK,CAAC,GAAoB,EAAE,GAAQ;QACxC,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;QACnB,OAAO,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAC3B,CAAC;IACD,KAAK,CAAC,KAAK,CAAC,GAAoB,EAAE,GAAQ;QACxC,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;QACnB,OAAO,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAC3B,CAAC;IACD,KAAK,CAAC,MAAM,CAAC,GAAoB,EAAE,GAAQ;QACzC,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;QACnB,OAAO,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAC3B,CAAC;IACD,KAAK,CAAC,OAAO,CAAC,GAAoB,EAAE,GAAQ;QAC1C,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;QACnB,OAAO,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAC3B,CAAC;IACD,KAAK,CAAC,GAAG,CAAI,GAAoB,EAAE,GAAQ,EAAE,IAAmB;QAC9D,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC;QACzB,OAAO,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAC3B,CAAC;IACD,KAAK,CAAC,GAAG,CAAI,GAAoB,EAAE,GAAQ;QACzC,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;QACnB,OAAO,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAC3B,CAAC;IACD,KAAK,CAAC,SAAS,CACb,GAAoB,EACpB,GAAQ,EACR,QAAiD;QAEjD,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC;QAC7B,OAAO,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAC3B,CAAC;CACF;AAED,MAAM,mBAAmB,GAAG,IAAI,kBAAkB,EAAE,CAAC;AAErD,MAAM,OAAO,kBAAkB;IACpB,OAAO,CAAe;IACtB,WAAW,CAA0B;IAE9C,YAAY,KAAgB,EAAE,OAAqB,EAAE,WAAgD;QACnG,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,WAAW,GAAG,WAAW,IAAI,mBAAmB,CAAC;IACxD,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,GAAoB,EAAE,OAAY,EAAE,GAAW;QAC5D,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;QAChE,IAAI,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC;YACjB,OAAO,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QAChC,CAAC;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAC1B,IAAI,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,KAAK,EAAE,CAAC;YAC1B,OAAO,GAAG,CAAC,KAAK,CAAC;QACnB,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IAC5D,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,GAAoB,EAAE,IAAS;QAC3C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QACvD,IAAI,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC;YACjB,OAAO,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QAChC,CAAC;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAC1B,IAAI,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,KAAK,EAAE,CAAC;YAC1B,OAAO,GAAG,CAAC,KAAK,CAAC;QACnB,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IAC/C,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,GAAoB,EAAE,GAAQ;QACxC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACpD,IAAI,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC;YACjB,OAAO,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QAChC,CAAC;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAC1B,IAAI,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,KAAK,EAAE,CAAC;YAC1B,OAAO,GAAG,CAAC,KAAK,CAAC;QACnB,CAAC;QACD,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IACnD,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,GAAoB,EAAE,GAAQ;QACxC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACpD,IAAI,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC;YACjB,OAAO,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QAChC,CAAC;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAC1B,IAAI,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,KAAK,EAAE,CAAC;YAC1B,OAAO,GAAG,CAAC,KAAK,CAAC;QACnB,CAAC;QACD,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IACnD,CAAC;IAED,KAAK,CAAC,GAAG,CAAI,GAAoB,EAAE,GAAQ,EAAE,KAAoB;QAC/D,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;QACzD,IAAI,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC;YACjB,OAAO,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QAChC,CAAC;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAC1B,IAAI,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,KAAK,EAAE,CAAC;YAC1B,OAAO,GAAG,CAAC,KAAK,CAAC;QACnB,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;IACxD,CAAC;IAED,KAAK,CAAC,GAAG,CAAI,GAAoB,EAAE,GAAQ;QACzC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,CAAI,GAAG,EAAE,GAAG,CAAC,CAAC;QACrD,IAAI,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC;YACjB,OAAO,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QAChC,CAAC;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAC1B,IAAI,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,KAAK,EAAE,CAAC;YAC1B,OAAO,GAAG,CAAC,KAAK,CAAC;QACnB,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IAC3C,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,GAAoB,EAAE,GAAQ,EAAE,QAAgD;QAC9F,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;YAC5B,OAAO,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QACvG,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC;QAClE,IAAI,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC;YACjB,OAAO,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QAChC,CAAC;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAC1B,IAAI,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,KAAK,EAAE,CAAC;YAC1B,OAAO,GAAG,CAAC,KAAK,CAAC;QACnB,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC;IAClE,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,GAAoB,EAAE,GAAQ;QACzC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACrD,IAAI,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC;YACjB,OAAO,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QAChC,CAAC;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAC1B,IAAI,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,KAAK,EAAE,CAAC;YAC1B,OAAO,GAAG,CAAC,KAAK,CAAC;QACnB,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IACvC,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,GAAoB,EAAE,GAAQ,EAAE,GAAW;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;IAC9C,CAAC;CACF"}

package/interceptor-gateway.ts

@@ -0,0 +1,174 @@
+import { Result, URI } from "@adviser/cement";
+import type {
+  FPEnvelope,
+  FPEnvelopeMeta,
+  SerdeGateway,
+  SerdeGatewayBuildUrlReturn,
+  SerdeGatewayCloseReturn,
+  SerdeGatewayCtx,
+  SerdeGatewayDeleteReturn,
+  SerdeGatewayDestroyReturn,
+  SerdeGatewayGetReturn,
+  SerdeGatewayInterceptor,
+  SerdeGatewayPutReturn,
+  SerdeGatewayStartReturn,
+  SerdeGatewaySubscribeReturn,
+  SerdeGetResult,
+  UnsubscribeResult,
+  VoidResult,
+} from "@fireproof/core-types-blockstore";
+import type { SuperThis } from "@fireproof/core-types-base";
+
+export class PassThroughGateway implements SerdeGatewayInterceptor {
+  async buildUrl(ctx: SerdeGatewayCtx, url: URI, key: string): Promise<Result<SerdeGatewayBuildUrlReturn>> {
+    const op = { url, key };
+    return Result.Ok({ op });
+  }
+  async start(ctx: SerdeGatewayCtx, url: URI): Promise<Result<SerdeGatewayStartReturn>> {
+    const op = { url };
+    return Result.Ok({ op });
+  }
+  async close(ctx: SerdeGatewayCtx, url: URI): Promise<Result<SerdeGatewayCloseReturn>> {
+    const op = { url };
+    return Result.Ok({ op });
+  }
+  async delete(ctx: SerdeGatewayCtx, url: URI): Promise<Result<SerdeGatewayDeleteReturn>> {
+    const op = { url };
+    return Result.Ok({ op });
+  }
+  async destroy(ctx: SerdeGatewayCtx, url: URI): Promise<Result<SerdeGatewayDestroyReturn>> {
+    const op = { url };
+    return Result.Ok({ op });
+  }
+  async put<T>(ctx: SerdeGatewayCtx, url: URI, body: FPEnvelope<T>): Promise<Result<SerdeGatewayPutReturn<T>>> {
+    const op = { url, body };
+    return Result.Ok({ op });
+  }
+  async get<S>(ctx: SerdeGatewayCtx, url: URI): Promise<Result<SerdeGatewayGetReturn<S>>> {
+    const op = { url };
+    return Result.Ok({ op });
+  }
+  async subscribe(
+    ctx: SerdeGatewayCtx,
+    url: URI,
+    callback: (meta: FPEnvelopeMeta) => Promise<void>,
+  ): Promise<Result<SerdeGatewaySubscribeReturn>> {
+    const op = { url, callback };
+    return Result.Ok({ op });
+  }
+}
+
+const passThrougthGateway = new PassThroughGateway();
+
+export class InterceptorGateway implements SerdeGateway {
+  readonly innerGW: SerdeGateway;
+  readonly interceptor: SerdeGatewayInterceptor;
+
+  constructor(sthis: SuperThis, innerGW: SerdeGateway, interceptor: SerdeGatewayInterceptor | undefined) {
+    this.innerGW = innerGW;
+    this.interceptor = interceptor || passThrougthGateway;
+  }
+
+  async buildUrl(ctx: SerdeGatewayCtx, baseUrl: URI, key: string): Promise<Result<URI>> {
+    const rret = await this.interceptor.buildUrl(ctx, baseUrl, key);
+    if (rret.isErr()) {
+      return Result.Err(rret.Err());
+    }
+    const ret = rret.unwrap();
+    if (ret.stop && ret.value) {
+      return ret.value;
+    }
+    return this.innerGW.buildUrl(ctx, ret.op.url, ret.op.key);
+  }
+
+  async destroy(ctx: SerdeGatewayCtx, iurl: URI): Promise<Result<void>> {
+    const rret = await this.interceptor.destroy(ctx, iurl);
+    if (rret.isErr()) {
+      return Result.Err(rret.Err());
+    }
+    const ret = rret.unwrap();
+    if (ret.stop && ret.value) {
+      return ret.value;
+    }
+    return this.innerGW.destroy(ctx, ret.op.url);
+  }
+
+  async start(ctx: SerdeGatewayCtx, url: URI): Promise<Result<URI>> {
+    const rret = await this.interceptor.start(ctx, url);
+    if (rret.isErr()) {
+      return Result.Err(rret.Err());
+    }
+    const ret = rret.unwrap();
+    if (ret.stop && ret.value) {
+      return ret.value;
+    }
+    return await this.innerGW.start(ctx, ret.op.url);
+  }
+
+  async close(ctx: SerdeGatewayCtx, url: URI): Promise<VoidResult> {
+    const rret = await this.interceptor.close(ctx, url);
+    if (rret.isErr()) {
+      return Result.Err(rret.Err());
+    }
+    const ret = rret.unwrap();
+    if (ret.stop && ret.value) {
+      return ret.value;
+    }
+    return await this.innerGW.close(ctx, ret.op.url);
+  }
+
+  async put<T>(ctx: SerdeGatewayCtx, url: URI, fpEnv: FPEnvelope<T>): Promise<VoidResult> {
+    const rret = await this.interceptor.put(ctx, url, fpEnv);
+    if (rret.isErr()) {
+      return Result.Err(rret.Err());
+    }
+    const ret = rret.unwrap();
+    if (ret.stop && ret.value) {
+      return ret.value;
+    }
+    return this.innerGW.put(ctx, ret.op.url, ret.op.body);
+  }
+
+  async get<S>(ctx: SerdeGatewayCtx, url: URI): Promise<SerdeGetResult<S>> {
+    const rret = await this.interceptor.get<S>(ctx, url);
+    if (rret.isErr()) {
+      return Result.Err(rret.Err());
+    }
+    const ret = rret.unwrap();
+    if (ret.stop && ret.value) {
+      return ret.value;
+    }
+    return this.innerGW.get(ctx, ret.op.url);
+  }
+
+  async subscribe(ctx: SerdeGatewayCtx, url: URI, callback: (msg: FPEnvelopeMeta) => Promise<void>): Promise<UnsubscribeResult> {
+    if (!this.innerGW.subscribe) {
+      return Result.Err(ctx.loader.sthis.logger.Error().Url(url).Msg("subscribe not supported").AsError());
+    }
+    const rret = await this.interceptor.subscribe(ctx, url, callback);
+    if (rret.isErr()) {
+      return Result.Err(rret.Err());
+    }
+    const ret = rret.unwrap();
+    if (ret.stop && ret.value) {
+      return ret.value;
+    }
+    return this.innerGW.subscribe(ctx, ret.op.url, ret.op.callback);
+  }
+
+  async delete(ctx: SerdeGatewayCtx, url: URI): Promise<VoidResult> {
+    const rret = await this.interceptor.delete(ctx, url);
+    if (rret.isErr()) {
+      return Result.Err(rret.Err());
+    }
+    const ret = rret.unwrap();
+    if (ret.stop && ret.value) {
+      return ret.value;
+    }
+    return this.innerGW.delete(ctx, url);
+  }
+
+  async getPlain(ctx: SerdeGatewayCtx, url: URI, key: string): Promise<Result<Uint8Array>> {
+    return this.innerGW.getPlain(ctx, url, key);
+  }
+}

package/meta-key-hack.d.ts

@@ -0,0 +1,33 @@
+import { Result, URI } from "@adviser/cement";
+import { FPEnvelopeMeta, SerializedMeta, V2SerializedMetaKey, Gateway, Loadable, FPEnvelope, SerdeGateway, SerdeGatewayCtx } from "@fireproof/core-types-blockstore";
+import { NotFoundError } from "@fireproof/core-types-base";
+type V1SerializedMetaKey = SerializedMeta & {
+    readonly key?: string | string[];
+    readonly keys?: string[];
+};
+export declare function V2SerializedMetaKeyExtractKey(ctx: SerdeGatewayCtx, v2: V2SerializedMetaKey): Promise<Result<SerializedMeta[]>>;
+export declare function decodeAsToSerializedMeta(ctx: SerdeGatewayCtx, raw: Uint8Array): Promise<Result<V2SerializedMetaKey>>;
+export declare function addKeyToDbMetaDecoder(ctx: SerdeGatewayCtx & {
+    readonly lastDecodedMetas?: V2SerializedMetaKey[];
+}): SerdeGatewayCtx & {
+    lastDecodedMetas: V2SerializedMetaKey[];
+};
+export declare function encodeAsV1SerializedMetaKey(ctx: SerdeGatewayCtx, payload: SerializedMeta[]): Promise<Result<V1SerializedMetaKey[]>>;
+export declare function encodeAsV2SerializedMetaKey(ctx: SerdeGatewayCtx, payload: SerializedMeta[]): Promise<Result<V2SerializedMetaKey>>;
+export declare function addKeyToDbMetaEncoder(ctx: SerdeGatewayCtx, version: "v1" | "v2"): SerdeGatewayCtx;
+export declare class AddKeyToDbMetaGateway implements SerdeGateway {
+    private readonly sdGw;
+    readonly version: "v1" | "v2";
+    constructor(gw: Gateway, version: "v1" | "v2");
+    buildUrl(ctx: SerdeGatewayCtx, baseUrl: URI, key: string): Promise<Result<URI>>;
+    start(ctx: SerdeGatewayCtx, baseUrl: URI): Promise<Result<URI>>;
+    close(ctx: SerdeGatewayCtx, baseUrl: URI): Promise<Result<void, Error>>;
+    put<T>(ctx: SerdeGatewayCtx, url: URI, body: FPEnvelope<T>): Promise<Result<void, Error>>;
+    get<S>(ctx: SerdeGatewayCtx, url: URI): Promise<Result<FPEnvelope<S>, Error | NotFoundError>>;
+    readonly lastDecodedMetas: V2SerializedMetaKey[];
+    delete(ctx: SerdeGatewayCtx, url: URI, loader?: Loadable): Promise<Result<void, Error>>;
+    subscribe(ctx: SerdeGatewayCtx, url: URI, callback: (meta: FPEnvelopeMeta) => Promise<void>): Promise<Result<() => void, Error>>;
+    getPlain(ctx: SerdeGatewayCtx, url: URI, key: string): Promise<Result<Uint8Array>>;
+    destroy(ctx: SerdeGatewayCtx, baseUrl: URI): Promise<Result<void, Error>>;
+}
+export {};