@peerbit/document-interface 1.0.0-55cebfe → 1.0.0

package/dist/src/id.d.ts

@@ -0,0 +1,47 @@
+export declare abstract class PrimitiveValue {
+}
+export declare class StringValue extends PrimitiveValue {
+    string: string;
+    constructor(string: string);
+}
+export declare abstract class NumberValue extends PrimitiveValue {
+    abstract get value(): number | bigint;
+}
+export declare abstract class IntegerValue extends NumberValue {
+}
+export declare class UnsignedIntegerValue extends IntegerValue {
+    number: number;
+    constructor(number: number);
+    get value(): number;
+}
+export declare class BigUnsignedIntegerValue extends IntegerValue {
+    number: bigint;
+    constructor(number: bigint);
+    get value(): bigint;
+}
+export type IdPrimitive = string | number | bigint;
+export declare abstract class IdKey {
+    abstract get key(): string | bigint | number | Uint8Array;
+    abstract get primitive(): IdPrimitive;
+}
+export declare class StringKey extends IdKey {
+    key: string;
+    constructor(key: string);
+    get primitive(): string;
+}
+export declare class Uint8ArrayKey extends IdKey {
+    key: Uint8Array;
+    constructor(key: Uint8Array);
+    private _keyString;
+    get primitive(): string;
+}
+export declare class IntegerKey extends IdKey {
+    key: number;
+    constructor(key: number);
+    get primitive(): number;
+}
+export type Ideable = string | number | bigint | Uint8Array;
+export declare const toId: (obj: Ideable) => IdKey;
+export declare const toIdeable: (key: IdKey | Ideable) => string | number | bigint;
+export declare const checkId: (obj: Ideable) => void;
+//# sourceMappingURL=id.d.ts.map

package/dist/src/id.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"id.d.ts","sourceRoot":"","sources":["../../src/id.ts"],"names":[],"mappings":"AAQA,8BAAsB,cAAc;CAAI;AAExC,qBACa,WAAY,SAAQ,cAAc;IAE9C,MAAM,EAAE,MAAM,CAAC;gBAEH,MAAM,EAAE,MAAM;CAI1B;AAED,8BACsB,WAAY,SAAQ,cAAc;IACvD,QAAQ,KAAK,KAAK,IAAI,MAAM,GAAG,MAAM,CAAC;CACtC;AAED,8BACsB,YAAa,SAAQ,WAAW;CAAI;AAE1D,qBACa,oBAAqB,SAAQ,YAAY;IAErD,MAAM,EAAE,MAAM,CAAC;gBAEH,MAAM,EAAE,MAAM;IAY1B,IAAI,KAAK,WAER;CACD;AAED,qBACa,uBAAwB,SAAQ,YAAY;IAExD,MAAM,EAAE,MAAM,CAAC;gBAEH,MAAM,EAAE,MAAM;IAO1B,IAAI,KAAK,WAER;CACD;AAED,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AAEnD,8BAAsB,KAAK;IAC1B,QAAQ,KAAK,GAAG,IAAI,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC;IAC1D,QAAQ,KAAK,SAAS,IAAI,WAAW,CAAC;CACtC;AAED,qBACa,SAAU,SAAQ,KAAK;IAEnC,GAAG,EAAE,MAAM,CAAC;gBAEA,GAAG,EAAE,MAAM;IAIvB,IAAI,SAAS,WAEZ;CACD;AAED,qBACa,aAAc,SAAQ,KAAK;IAEvC,GAAG,EAAE,UAAU,CAAC;gBAEJ,GAAG,EAAE,UAAU;IAK3B,OAAO,CAAC,UAAU,CAAS;IAC3B,IAAI,SAAS,IAAI,MAAM,CAEtB;CACD;AAiBD,qBACa,UAAW,SAAQ,KAAK;IAEpC,GAAG,EAAE,MAAM,CAAC;gBAEA,GAAG,EAAE,MAAM;IAKvB,IAAI,SAAS,WAEZ;CACD;AAED,MAAM,MAAM,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC;AAI5D,eAAO,MAAM,IAAI,QAAS,OAAO,KAAG,KAuBnC,CAAC;AAEF,eAAO,MAAM,SAAS,QAAS,KAAK,GAAG,OAAO,KAAG,MAAM,GAAG,MAAM,GAAG,MAsBlE,CAAC;AAEF,eAAO,MAAM,OAAO,QAAS,OAAO,SAqBnC,CAAC"}

package/dist/src/id.js

@@ -0,0 +1,217 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { field, variant } from "@dao-xyz/borsh";
+import { toBase64 } from "@peerbit/crypto";
+import { decodeUint8Array, encodeUint8Array, encodingLength } from "uint8-varint";
+export class PrimitiveValue {
+}
+let StringValue = class StringValue extends PrimitiveValue {
+    string;
+    constructor(string) {
+        super();
+        this.string = string;
+    }
+};
+__decorate([
+    field({ type: "string" }),
+    __metadata("design:type", String)
+], StringValue.prototype, "string", void 0);
+StringValue = __decorate([
+    variant(0),
+    __metadata("design:paramtypes", [String])
+], StringValue);
+export { StringValue };
+let NumberValue = class NumberValue extends PrimitiveValue {
+};
+NumberValue = __decorate([
+    variant(1)
+], NumberValue);
+export { NumberValue };
+let IntegerValue = class IntegerValue extends NumberValue {
+};
+IntegerValue = __decorate([
+    variant(0)
+], IntegerValue);
+export { IntegerValue };
+let UnsignedIntegerValue = class UnsignedIntegerValue extends IntegerValue {
+    number;
+    constructor(number) {
+        super();
+        if (Number.isInteger(number) === false ||
+            number > 4294967295 ||
+            number < 0) {
+            throw new Error("Number is not u32");
+        }
+        this.number = number;
+    }
+    get value() {
+        return this.number;
+    }
+};
+__decorate([
+    field({ type: "u32" }),
+    __metadata("design:type", Number)
+], UnsignedIntegerValue.prototype, "number", void 0);
+UnsignedIntegerValue = __decorate([
+    variant(0),
+    __metadata("design:paramtypes", [Number])
+], UnsignedIntegerValue);
+export { UnsignedIntegerValue };
+let BigUnsignedIntegerValue = class BigUnsignedIntegerValue extends IntegerValue {
+    number;
+    constructor(number) {
+        super();
+        if (number > 18446744073709551615n || number < 0) {
+            throw new Error("Number is not u32");
+        }
+        this.number = number;
+    }
+    get value() {
+        return this.number;
+    }
+};
+__decorate([
+    field({ type: "u64" }),
+    __metadata("design:type", BigInt)
+], BigUnsignedIntegerValue.prototype, "number", void 0);
+BigUnsignedIntegerValue = __decorate([
+    variant(1),
+    __metadata("design:paramtypes", [BigInt])
+], BigUnsignedIntegerValue);
+export { BigUnsignedIntegerValue };
+export class IdKey {
+}
+let StringKey = class StringKey extends IdKey {
+    key;
+    constructor(key) {
+        super();
+        this.key = key;
+    }
+    get primitive() {
+        return this.key;
+    }
+};
+__decorate([
+    field({ type: "string" }),
+    __metadata("design:type", String)
+], StringKey.prototype, "key", void 0);
+StringKey = __decorate([
+    variant(0),
+    __metadata("design:paramtypes", [String])
+], StringKey);
+export { StringKey };
+let Uint8ArrayKey = class Uint8ArrayKey extends IdKey {
+    key;
+    constructor(key) {
+        super();
+        this.key = key;
+    }
+    _keyString;
+    get primitive() {
+        return this._keyString || (this._keyString = toBase64(this.key));
+    }
+};
+__decorate([
+    field({ type: Uint8Array }),
+    __metadata("design:type", Uint8Array)
+], Uint8ArrayKey.prototype, "key", void 0);
+Uint8ArrayKey = __decorate([
+    variant(1),
+    __metadata("design:paramtypes", [Uint8Array])
+], Uint8ArrayKey);
+export { Uint8ArrayKey };
+const varint53 = {
+    deserialize: (reader) => {
+        const number = decodeUint8Array(reader._buf, reader._offset);
+        const len = encodingLength(number);
+        reader._offset += len;
+        return number;
+    },
+    serialize: (value, writer) => {
+        const offset = writer.totalSize;
+        writer["_writes"] = writer["_writes"].next = () => encodeUint8Array(value, writer["_buf"], offset);
+        writer.totalSize += encodingLength(value);
+    }
+};
+let IntegerKey = class IntegerKey extends IdKey {
+    key;
+    constructor(key) {
+        super();
+        this.key = key;
+    }
+    get primitive() {
+        return this.key;
+    }
+};
+__decorate([
+    field(varint53) // max value is 2^53 - 1 (9007199254740991)
+    ,
+    __metadata("design:type", Number)
+], IntegerKey.prototype, "key", void 0);
+IntegerKey = __decorate([
+    variant(2),
+    __metadata("design:paramtypes", [Number])
+], IntegerKey);
+export { IntegerKey };
+const idKeyTypes = new Set(["string", "number", "bigint"]);
+export const toId = (obj) => {
+    if (typeof obj === "string") {
+        return new StringKey(obj);
+    }
+    if (typeof obj === "number") {
+        return new IntegerKey(obj);
+    }
+    if (typeof obj === "bigint") {
+        if (obj <= Number.MAX_SAFE_INTEGER && obj >= 0) {
+            return new IntegerKey(Number(obj));
+        }
+        throw new Error("BigInt is not less than 2^53. Max value is 9007199254740991");
+    }
+    if (obj instanceof Uint8Array) {
+        return new Uint8ArrayKey(obj);
+    }
+    throw new Error("Unexpected index key: " +
+        typeof obj +
+        ", expected: string, number, bigint or Uint8Array");
+};
+export const toIdeable = (key) => {
+    if (key instanceof IdKey) {
+        return key.primitive;
+    }
+    if (typeof key === "string") {
+        return key;
+    }
+    if (typeof key === "number") {
+        return key;
+    }
+    if (typeof key === "bigint") {
+        return key;
+    }
+    if (key instanceof Uint8Array) {
+        return toBase64(key);
+    }
+    throw new Error("Unexpected index key: " + typeof key);
+};
+export const checkId = (obj) => {
+    if (obj == null) {
+        throw new Error(`The provided key value is null or undefined, expecting string, number, bigint, or Uint8array`);
+    }
+    const type = typeof obj;
+    if (type === "number") {
+        if (Number.isInteger(obj) === false) {
+            throw new Error(`The provided key number value is not an integer`);
+        }
+    }
+    if (idKeyTypes.has(type) || obj instanceof Uint8Array) {
+        return;
+    }
+    throw new Error(`Key is not ${[...idKeyTypes]}, provided key value type: ${typeof obj}`);
+};
+//# sourceMappingURL=id.js.map

package/dist/src/id.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"id.js","sourceRoot":"","sources":["../../src/id.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EACN,gBAAgB,EAChB,gBAAgB,EAChB,cAAc,EACd,MAAM,cAAc,CAAC;AAEtB,MAAM,OAAgB,cAAc;CAAI;AAGjC,IAAM,WAAW,GAAjB,MAAM,WAAY,SAAQ,cAAc;IAE9C,MAAM,CAAS;IAEf,YAAY,MAAc;QACzB,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACtB,CAAC;CACD,CAAA;AANA;IADC,KAAK,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;2CACX;AAFH,WAAW;IADvB,OAAO,CAAC,CAAC,CAAC;;GACE,WAAW,CAQvB;;AAGM,IAAe,WAAW,GAA1B,MAAe,WAAY,SAAQ,cAAc;CAEvD,CAAA;AAFqB,WAAW;IADhC,OAAO,CAAC,CAAC,CAAC;GACW,WAAW,CAEhC;;AAGM,IAAe,YAAY,GAA3B,MAAe,YAAa,SAAQ,WAAW;CAAI,CAAA;AAApC,YAAY;IADjC,OAAO,CAAC,CAAC,CAAC;GACW,YAAY,CAAwB;;AAGnD,IAAM,oBAAoB,GAA1B,MAAM,oBAAqB,SAAQ,YAAY;IAErD,MAAM,CAAS;IAEf,YAAY,MAAc;QACzB,KAAK,EAAE,CAAC;QACR,IACC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,KAAK;YAClC,MAAM,GAAG,UAAU;YACnB,MAAM,GAAG,CAAC,EACT,CAAC;YACF,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;QACtC,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACtB,CAAC;IAED,IAAI,KAAK;QACR,OAAO,IAAI,CAAC,MAAM,CAAC;IACpB,CAAC;CACD,CAAA;AAjBA;IADC,KAAK,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;;oDACR;AAFH,oBAAoB;IADhC,OAAO,CAAC,CAAC,CAAC;;GACE,oBAAoB,CAmBhC;;AAGM,IAAM,uBAAuB,GAA7B,MAAM,uBAAwB,SAAQ,YAAY;IAExD,MAAM,CAAS;IAEf,YAAY,MAAc;QACzB,KAAK,EAAE,CAAC;QACR,IAAI,MAAM,GAAG,qBAAqB,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;YAClD,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;QACtC,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACtB,CAAC;IACD,IAAI,KAAK;QACR,OAAO,IAAI,CAAC,MAAM,CAAC;IACpB,CAAC;CACD,CAAA;AAZA;IADC,KAAK,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;;uDACR;AAFH,uBAAuB;IADnC,OAAO,CAAC,CAAC,CAAC;;GACE,uBAAuB,CAcnC;;AAID,MAAM,OAAgB,KAAK;CAG1B;AAGM,IAAM,SAAS,GAAf,MAAM,SAAU,SAAQ,KAAK;IAEnC,GAAG,CAAS;IAEZ,YAAY,GAAW;QACtB,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IAChB,CAAC;IACD,IAAI,SAAS;QACZ,OAAO,IAAI,CAAC,GAAG,CAAC;IACjB,CAAC;CACD,CAAA;AATA;IADC,KAAK,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;sCACd;AAFA,SAAS;IADrB,OAAO,CAAC,CAAC,CAAC;;GACE,SAAS,CAWrB;;AAGM,IAAM,aAAa,GAAnB,MAAM,aAAc,SAAQ,KAAK;IAEvC,GAAG,CAAa;IAEhB,YAAY,GAAe;QAC1B,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IAChB,CAAC;IAEO,UAAU,CAAS;IAC3B,IAAI,SAAS;QACZ,OAAO,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAClE,CAAC;CACD,CAAA;AAXA;IADC,KAAK,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;8BACvB,UAAU;0CAAC;AAFJ,aAAa;IADzB,OAAO,CAAC,CAAC,CAAC;qCAKO,UAAU;GAJf,aAAa,CAazB;;AAED,MAAM,QAAQ,GAAG;IAChB,WAAW,EAAE,CAAC,MAAW,EAAE,EAAE;QAC5B,MAAM,MAAM,GAAG,gBAAgB,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;QAC7D,MAAM,GAAG,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;QACnC,MAAM,CAAC,OAAO,IAAI,GAAG,CAAC;QACtB,OAAO,MAAM,CAAC;IACf,CAAC;IACD,SAAS,EAAE,CAAC,KAAU,EAAE,MAAW,EAAE,EAAE;QACtC,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC;QAChC,MAAM,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,GAAG,GAAG,EAAE,CACjD,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC;QACjD,MAAM,CAAC,SAAS,IAAI,cAAc,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC;CACD,CAAC;AAGK,IAAM,UAAU,GAAhB,MAAM,UAAW,SAAQ,KAAK;IAEpC,GAAG,CAAS;IAEZ,YAAY,GAAW;QACtB,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IAChB,CAAC;IAED,IAAI,SAAS;QACZ,OAAO,IAAI,CAAC,GAAG,CAAC;IACjB,CAAC;CACD,CAAA;AAVA;IADC,KAAK,CAAC,QAAQ,CAAC,CAAC,2CAA2C;;;uCAChD;AAFA,UAAU;IADtB,OAAO,CAAC,CAAC,CAAC;;GACE,UAAU,CAYtB;;AAID,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;AAE3D,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,GAAY,EAAS,EAAE;IAC3C,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC7B,OAAO,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;IACD,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC7B,OAAO,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC;IAC5B,CAAC;IACD,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC7B,IAAI,GAAG,IAAI,MAAM,CAAC,gBAAgB,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC;YAChD,OAAO,IAAI,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;QACpC,CAAC;QACD,MAAM,IAAI,KAAK,CACd,6DAA6D,CAC7D,CAAC;IACH,CAAC;IACD,IAAI,GAAG,YAAY,UAAU,EAAE,CAAC;QAC/B,OAAO,IAAI,aAAa,CAAC,GAAG,CAAC,CAAC;IAC/B,CAAC;IACD,MAAM,IAAI,KAAK,CACd,wBAAwB;QACxB,OAAO,GAAG;QACV,kDAAkD,CAClD,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,GAAoB,EAA4B,EAAE;IAC3E,IAAI,GAAG,YAAY,KAAK,EAAE,CAAC;QAC1B,OAAO,GAAG,CAAC,SAAS,CAAC;IACtB,CAAC;IAED,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC7B,OAAO,GAAG,CAAC;IACZ,CAAC;IAED,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC7B,OAAO,GAAG,CAAC;IACZ,CAAC;IAED,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC7B,OAAO,GAAG,CAAC;IACZ,CAAC;IAED,IAAI,GAAG,YAAY,UAAU,EAAE,CAAC;QAC/B,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC;IACtB,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,wBAAwB,GAAG,OAAO,GAAG,CAAC,CAAC;AACxD,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,GAAY,EAAE,EAAE;IACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CACd,8FAA8F,CAC9F,CAAC;IACH,CAAC;IACD,MAAM,IAAI,GAAG,OAAO,GAAG,CAAC;IAExB,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;QACvB,IAAI,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,KAAK,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACpE,CAAC;IACF,CAAC;IAED,IAAI,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,GAAG,YAAY,UAAU,EAAE,CAAC;QACvD,OAAO;IACR,CAAC;IAED,MAAM,IAAI,KAAK,CACd,cAAc,CAAC,GAAG,UAAU,CAAC,8BAA8B,OAAO,GAAG,EAAE,CACvE,CAAC;AACH,CAAC,CAAC"}

package/dist/src/index-engine.d.ts

@@ -0,0 +1,44 @@
+import { PublicSignKey } from "@peerbit/crypto";
+import { CloseIteratorRequest, CollectNextRequest, Context, SearchRequest } from "./query.js";
+import { IdKey, type IdPrimitive } from "./id.js";
+export interface IndexedResult {
+    id: IdKey;
+    indexed: Record<string, any>;
+    context: Context;
+}
+export interface IndexedResults {
+    results: IndexedResult[];
+    kept: number;
+}
+export interface IndexedValue<T = Record<string, any>> {
+    id: IdKey;
+    indexed: T;
+    context: Context;
+    size: number;
+}
+export type NestedProperties<T> = {
+    match: (obj: any) => obj is T;
+    query: (nested: T, query: SearchRequest) => Promise<Record<string, any>[]>;
+};
+export type IndexEngineInitProperties<N> = {
+    indexBy: string | string[];
+    nested?: NestedProperties<N>;
+    maxBatchSize: number;
+};
+export interface IndexEngine<N = any> {
+    init(properties: IndexEngineInitProperties<N>): Promise<void> | void;
+    start?(): Promise<void> | void;
+    stop?(): Promise<void> | void;
+    get(id: IdKey): Promise<IndexedResult | undefined> | IndexedResult | undefined;
+    put(value: IndexedValue): Promise<void> | void;
+    del(id: IdKey): Promise<void> | void;
+    query(query: SearchRequest, from: PublicSignKey): Promise<IndexedResults>;
+    next(query: CollectNextRequest, from: PublicSignKey): Promise<IndexedResults>;
+    close(query: CloseIteratorRequest, from: PublicSignKey): Promise<void> | void;
+    iterator(): IterableIterator<[IdPrimitive, IndexedValue]>;
+    getSize(): number | Promise<number>;
+    getPending(cursorId: string): number | undefined;
+    get cursorCount(): number;
+}
+export type IndexEngineConstuctor = (directory?: string) => Promise<IndexEngine> | IndexEngine;
+//# sourceMappingURL=index-engine.d.ts.map

package/dist/src/index-engine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-engine.d.ts","sourceRoot":"","sources":["../../src/index-engine.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EACN,oBAAoB,EACpB,kBAAkB,EAClB,OAAO,EACP,aAAa,EACb,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,KAAK,EAAE,KAAK,WAAW,EAAE,MAAM,SAAS,CAAC;AAElD,MAAM,WAAW,aAAa;IAC7B,EAAE,EAAE,KAAK,CAAC;IACV,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC7B,OAAO,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,cAAc;IAC9B,OAAO,EAAE,aAAa,EAAE,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,YAAY,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IACpD,EAAE,EAAE,KAAK,CAAC;IACV,OAAO,EAAE,CAAC,CAAC;IACX,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;CACb;AAED,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI;IACjC,KAAK,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,IAAI,CAAC,CAAC;IAC9B,KAAK,EAAE,CAAC,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,aAAa,KAAK,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;CAC3E,CAAC;AAEF,MAAM,MAAM,yBAAyB,CAAC,CAAC,IAAI;IAC1C,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC3B,MAAM,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC;IAC7B,YAAY,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,GAAG;IACnC,IAAI,CAAC,UAAU,EAAE,yBAAyB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IACrE,KAAK,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAC/B,IAAI,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAC9B,GAAG,CACF,EAAE,EAAE,KAAK,GACP,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC,GAAG,aAAa,GAAG,SAAS,CAAC;IAClE,GAAG,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAC/C,GAAG,CAAC,EAAE,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IACrC,KAAK,CAAC,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAC1E,IAAI,CAAC,KAAK,EAAE,kBAAkB,EAAE,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAC9E,KAAK,CAAC,KAAK,EAAE,oBAAoB,EAAE,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAC9E,QAAQ,IAAI,gBAAgB,CAAC,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC,CAAC;IAC1D,OAAO,IAAI,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACpC,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;IACjD,IAAI,WAAW,IAAI,MAAM,CAAC;CAC1B;AAED,MAAM,MAAM,qBAAqB,GAAG,CAAC,SAAS,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,WAAW,CAAC,GAAG,WAAW,CAAC"}

package/dist/src/index-engine.js

@@ -0,0 +1,4 @@
+import { PublicSignKey } from "@peerbit/crypto";
+import { CloseIteratorRequest, CollectNextRequest, Context, SearchRequest } from "./query.js";
+import { IdKey } from "./id.js";
+//# sourceMappingURL=index-engine.js.map

package/dist/src/index-engine.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-engine.js","sourceRoot":"","sources":["../../src/index-engine.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EACN,oBAAoB,EACpB,kBAAkB,EAClB,OAAO,EACP,aAAa,EACb,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,KAAK,EAAoB,MAAM,SAAS,CAAC"}

package/dist/src/utils.d.ts

@@ -0,0 +1,10 @@
+import { Context, Sort } from "./query.js";
+export declare const stringArraysEquals: (a: string[] | string, b: string[] | string) => boolean;
+export declare const resolvedSort: <Q extends {
+    indexed: Record<string, any>;
+    context: Context;
+}>(arr: Q[], sorts: Sort[]) => Promise<Q[]>;
+export declare const extractSortCompare: (a: Record<string, any>, b: Record<string, any>, sorts: Sort[]) => number;
+export declare const sortCompare: (av: any, bv: any) => number;
+export declare const extractFieldValue: <T>(doc: any, path: string[]) => T;
+//# sourceMappingURL=utils.d.ts.map

package/dist/src/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,IAAI,EAAiB,MAAM,YAAY,CAAC;AAE1D,eAAO,MAAM,kBAAkB,MAC3B,MAAM,EAAE,GAAG,MAAM,KACjB,MAAM,EAAE,GAAG,MAAM,YAWpB,CAAC;AAEF,eAAO,MAAM,YAAY;aACH,OAAO,MAAM,EAAE,GAAG,CAAC;aAAW,OAAO;QAErD,CAAC,EAAE,SACD,IAAI,EAAE,iBAIb,CAAC;AAEF,eAAO,MAAM,kBAAkB,MAC3B,OAAO,MAAM,EAAE,GAAG,CAAC,KACnB,OAAO,MAAM,EAAE,GAAG,CAAC,SACf,IAAI,EAAE,WAeb,CAAC;AAEF,eAAO,MAAM,WAAW,OAAQ,GAAG,MAAM,GAAG,WAU3C,CAAC;AAEF,eAAO,MAAM,iBAAiB,WAAY,GAAG,QAAQ,MAAM,EAAE,KAAG,CAK/D,CAAC"}

package/dist/src/utils.js

@@ -0,0 +1,51 @@
+import { Context, Sort, SortDirection } from "./query.js";
+export const stringArraysEquals = (a, b) => {
+    if (a.length !== b.length) {
+        return false;
+    }
+    for (let i = 0; i < a.length; i++) {
+        if (a[i] !== b[i]) {
+            return false;
+        }
+    }
+    return true;
+};
+export const resolvedSort = async (arr, sorts) => {
+    arr.sort((a, b) => extractSortCompare(a.indexed, b.indexed, sorts));
+    return arr;
+};
+export const extractSortCompare = (a, b, sorts) => {
+    for (const sort of sorts) {
+        const av = extractFieldValue(a, sort.key);
+        const bv = extractFieldValue(b, sort.key);
+        const cmp = sortCompare(av, bv);
+        if (cmp != 0) {
+            if (sort.direction === SortDirection.ASC) {
+                return cmp;
+            }
+            else {
+                return -cmp;
+            }
+        }
+    }
+    return 0;
+};
+export const sortCompare = (av, bv) => {
+    if (typeof av === "string" && typeof bv === "string") {
+        return av.localeCompare(bv);
+    }
+    if (av < bv) {
+        return -1;
+    }
+    else if (av > bv) {
+        return 1;
+    }
+    return 0;
+};
+export const extractFieldValue = (doc, path) => {
+    for (let i = 0; i < path.length; i++) {
+        doc = doc[path[i]];
+    }
+    return doc;
+};
+//# sourceMappingURL=utils.js.map

package/dist/src/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAE1D,MAAM,CAAC,MAAM,kBAAkB,GAAG,CACjC,CAAoB,EACpB,CAAoB,EACnB,EAAE;IACH,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC;QAC3B,OAAO,KAAK,CAAC;IACd,CAAC;IACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACnC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACnB,OAAO,KAAK,CAAC;QACd,CAAC;IACF,CAAC;IACD,OAAO,IAAI,CAAC;AACb,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,EAGhC,GAAQ,EACR,KAAa,EACZ,EAAE;IACH,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;IACpE,OAAO,GAAG,CAAC;AACZ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CACjC,CAAsB,EACtB,CAAsB,EACtB,KAAa,EACZ,EAAE;IACH,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QAC1B,MAAM,EAAE,GAAG,iBAAiB,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;QAC1C,MAAM,EAAE,GAAG,iBAAiB,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;QAC1C,MAAM,GAAG,GAAG,WAAW,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAChC,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC;YACd,IAAI,IAAI,CAAC,SAAS,KAAK,aAAa,CAAC,GAAG,EAAE,CAAC;gBAC1C,OAAO,GAAG,CAAC;YACZ,CAAC;iBAAM,CAAC;gBACP,OAAO,CAAC,GAAG,CAAC;YACb,CAAC;QACF,CAAC;IACF,CAAC;IACD,OAAO,CAAC,CAAC;AACV,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,EAAO,EAAE,EAAO,EAAE,EAAE;IAC/C,IAAI,OAAO,EAAE,KAAK,QAAQ,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE,CAAC;QACtD,OAAO,EAAE,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;IAC7B,CAAC;IACD,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC;QACb,OAAO,CAAC,CAAC,CAAC;IACX,CAAC;SAAM,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC;QACpB,OAAO,CAAC,CAAC;IACV,CAAC;IACD,OAAO,CAAC,CAAC;AACV,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAI,GAAQ,EAAE,IAAc,EAAK,EAAE;IACnE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACtC,GAAG,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;IACD,OAAO,GAAG,CAAC;AACZ,CAAC,CAAC"}

package/package.json

@@ -1,65 +1,65 @@
 {
-  "name": "@peerbit/document-interface",
-  "version": "1.0.0-55cebfe",
-  "description": "Document store interface",
-  "sideEffects": false,
-  "type": "module",
-  "types": "./dist/src/index.d.ts",
-  "typesVersions": {
-    "*": {
-      "*": [
-        "*",
-        "dist/*",
-        "dist/src/*",
-        "dist/src/*/index"
-      ],
-      "src/*": [
-        "*",
-        "dist/*",
-        "dist/src/*",
-        "dist/src/*/index"
-      ]
-    }
-  },
-  "files": [
-    "src",
-    "dist",
-    "!dist/e2e",
-    "!dist/test",
-    "!**/*.tsbuildinfo"
-  ],
-  "exports": {
-    ".": {
-      "types": "./dist/src/index.d.ts",
-      "import": "./dist/src/index.js"
-    }
-  },
-  "eslintConfig": {
-    "extends": "peerbit",
-    "parserOptions": {
-      "project": true,
-      "sourceType": "module"
-    },
-    "ignorePatterns": [
-      "!.aegir.js",
-      "test/ts-use",
-      "*.d.ts"
-    ]
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "scripts": {
-    "clean": "aegir clean",
-    "build": "aegir build --no-bundle",
-    "test": "",
-    "lint": "aegir lint"
-  },
-  "author": "dao.xyz",
-  "license": "MIT",
-  "dependencies": {
-    "@dao-xyz/borsh": "^5.2.3",
-    "@peerbit/crypto": "2.3.0-55cebfe",
-    "@peerbit/indexer-interface": "1.0.0-55cebfe"
-  }
+	"name": "@peerbit/document-interface",
+	"version": "1.0.0",
+	"description": "Document store interface",
+	"sideEffects": false,
+	"type": "module",
+	"types": "./dist/src/index.d.ts",
+	"typesVersions": {
+		"*": {
+			"*": [
+				"*",
+				"dist/*",
+				"dist/src/*",
+				"dist/src/*/index"
+			],
+			"src/*": [
+				"*",
+				"dist/*",
+				"dist/src/*",
+				"dist/src/*/index"
+			]
+		}
+	},
+	"files": [
+		"src",
+		"dist",
+		"!dist/e2e",
+		"!dist/test",
+		"!**/*.tsbuildinfo"
+	],
+	"exports": {
+		".": {
+			"types": "./dist/src/index.d.ts",
+			"import": "./dist/src/index.js"
+		}
+	},
+	"eslintConfig": {
+		"extends": "peerbit",
+		"parserOptions": {
+			"project": true,
+			"sourceType": "module"
+		},
+		"ignorePatterns": [
+			"!.aegir.js",
+			"test/ts-use",
+			"*.d.ts"
+		]
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"scripts": {
+		"clean": "aegir clean",
+		"build": "aegir build --no-bundle",
+		"test": "",
+		"lint": "aegir lint"
+	},
+	"author": "dao.xyz",
+	"license": "MIT",
+	"dependencies": {
+		"@dao-xyz/borsh": "^5.2.3",
+		"@peerbit/crypto": "^2.3.0",
+		"@peerbit/indexer-interface": "^1.0.0"
+	}
 }