@peerbit/document-interface 1.0.0-1d1274c

package/dist/src/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./query.js";
+export * from "./store.js";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC"}

package/dist/src/index.js

@@ -0,0 +1,3 @@
+export * from "./query.js";
+export * from "./store.js";
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC"}

package/dist/src/query.d.ts

@@ -0,0 +1,48 @@
+import { type AbstractType } from "@dao-xyz/borsh";
+export declare abstract class Result {
+}
+export declare class Context {
+    created: bigint;
+    modified: bigint;
+    head: string;
+    gid: string;
+    size: number;
+    constructor(properties: {
+        created: bigint;
+        modified: bigint;
+        head: string;
+        gid: string;
+        size: number;
+    });
+}
+export declare class ResultWithSource<T> extends Result {
+    _source: Uint8Array;
+    context: Context;
+    _type: AbstractType<T>;
+    constructor(opts: {
+        source: Uint8Array;
+        context: Context;
+        value?: T;
+        indexed?: Record<string, any>;
+    });
+    init(type: AbstractType<T>): void;
+    _value?: T;
+    get value(): T;
+    indexed?: Record<string, any>;
+}
+export declare abstract class AbstractSearchResult<T> {
+}
+export declare class Results<T> extends AbstractSearchResult<T> {
+    results: ResultWithSource<T>[];
+    kept: bigint;
+    constructor(properties: {
+        results: ResultWithSource<T>[];
+        kept: bigint;
+    });
+}
+export declare class NoAccess extends AbstractSearchResult<any> {
+}
+/**
+ * Find logs that can be decrypted by certain keys
+ */
+//# sourceMappingURL=query.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"query.d.ts","sourceRoot":"","sources":["../../src/query.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,KAAK,YAAY,EAKjB,MAAM,gBAAgB,CAAC;AAIxB,8BAAsB,MAAM;CAAG;AAE/B,qBACa,OAAO;IAEnB,OAAO,EAAE,MAAM,CAAC;IAGhB,QAAQ,EAAE,MAAM,CAAC;IAGjB,IAAI,EAAE,MAAM,CAAC;IAGb,GAAG,EAAE,MAAM,CAAC;IAGZ,IAAI,EAAE,MAAM,CAAC;gBAED,UAAU,EAAE;QACvB,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;QACZ,IAAI,EAAE,MAAM,CAAC;KACb;CAOD;AAED,qBACa,gBAAgB,CAAC,CAAC,CAAE,SAAQ,MAAM;IAE9C,OAAO,EAAE,UAAU,CAAC;IAGpB,OAAO,EAAE,OAAO,CAAC;IAEjB,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;gBACX,IAAI,EAAE;QACjB,MAAM,EAAE,UAAU,CAAC;QACnB,OAAO,EAAE,OAAO,CAAC;QACjB,KAAK,CAAC,EAAE,CAAC,CAAC;QACV,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KAC9B;IAQD,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC;IAI1B,MAAM,CAAC,EAAE,CAAC,CAAC;IACX,IAAI,KAAK,IAAI,CAAC,CASb;IAGD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC9B;AAGD,8BAAsB,oBAAoB,CAAC,CAAC;CAAI;AAEhD,qBACa,OAAO,CAAC,CAAC,CAAE,SAAQ,oBAAoB,CAAC,CAAC,CAAC;IAEtD,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC;IAG/B,IAAI,EAAE,MAAM,CAAC;gBAED,UAAU,EAAE;QAAE,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE;CAKxE;AAED,qBACa,QAAS,SAAQ,oBAAoB,CAAC,GAAG,CAAC;CAAG;AAK1D;;GAEG"}

package/dist/src/query.js

@@ -0,0 +1,187 @@
+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 { deserialize, field, variant, vec, } from "@dao-xyz/borsh";
+/// ----- RESULTS -----
+export class Result {
+}
+let Context = class Context {
+    created;
+    modified;
+    head;
+    gid;
+    size; // bytes
+    constructor(properties) {
+        this.created = properties.created;
+        this.modified = properties.modified;
+        this.head = properties.head;
+        this.gid = properties.gid;
+        this.size = properties.size;
+    }
+};
+__decorate([
+    field({ type: "u64" }),
+    __metadata("design:type", BigInt)
+], Context.prototype, "created", void 0);
+__decorate([
+    field({ type: "u64" }),
+    __metadata("design:type", BigInt)
+], Context.prototype, "modified", void 0);
+__decorate([
+    field({ type: "string" }),
+    __metadata("design:type", String)
+], Context.prototype, "head", void 0);
+__decorate([
+    field({ type: "string" }),
+    __metadata("design:type", String)
+], Context.prototype, "gid", void 0);
+__decorate([
+    field({ type: "u32" }),
+    __metadata("design:type", Number)
+], Context.prototype, "size", void 0);
+Context = __decorate([
+    variant(0),
+    __metadata("design:paramtypes", [Object])
+], Context);
+export { Context };
+let ResultWithSource = class ResultWithSource extends Result {
+    _source;
+    context;
+    _type;
+    constructor(opts) {
+        super();
+        this._source = opts.source;
+        this.context = opts.context;
+        this._value = opts.value;
+        this.indexed = opts.indexed;
+    }
+    init(type) {
+        this._type = type;
+    }
+    _value;
+    get value() {
+        if (this._value) {
+            return this._value;
+        }
+        if (!this._source) {
+            throw new Error("Missing source binary");
+        }
+        this._value = deserialize(this._source, this._type);
+        return this._value;
+    }
+    // we never send this over the wire since we can always reconstruct it from value
+    indexed;
+};
+__decorate([
+    field({ type: Uint8Array }),
+    __metadata("design:type", Uint8Array)
+], ResultWithSource.prototype, "_source", void 0);
+__decorate([
+    field({ type: Context }),
+    __metadata("design:type", Context)
+], ResultWithSource.prototype, "context", void 0);
+ResultWithSource = __decorate([
+    variant(0),
+    __metadata("design:paramtypes", [Object])
+], ResultWithSource);
+export { ResultWithSource };
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export class AbstractSearchResult {
+}
+let Results = class Results extends AbstractSearchResult {
+    results;
+    kept; // how many results that were not sent, but can be collected later
+    constructor(properties) {
+        super();
+        this.kept = properties.kept;
+        this.results = properties.results;
+    }
+};
+__decorate([
+    field({ type: vec(ResultWithSource) }),
+    __metadata("design:type", Array)
+], Results.prototype, "results", void 0);
+__decorate([
+    field({ type: "u64" }),
+    __metadata("design:type", BigInt)
+], Results.prototype, "kept", void 0);
+Results = __decorate([
+    variant(0),
+    __metadata("design:paramtypes", [Object])
+], Results);
+export { Results };
+let NoAccess = class NoAccess extends AbstractSearchResult {
+};
+NoAccess = __decorate([
+    variant(1)
+], NoAccess);
+export { NoAccess };
+/* @variant(5)
+export class LogQuery extends Query { } */
+/**
+ * Find logs that can be decrypted by certain keys
+ */
+/*
+@variant(0)
+export class EntryEncryptedByQuery
+    extends LogQuery
+    implements
+    EntryEncryptionTemplate<
+        X25519PublicKey[],
+        X25519PublicKey[],
+        X25519PublicKey[],
+        X25519PublicKey[]
+    >
+{
+    @field({ type: vec(X25519PublicKey) })
+    meta: X25519PublicKey[];
+
+    @field({ type: vec(X25519PublicKey) })
+    payload: X25519PublicKey[];
+
+    @field({ type: vec(X25519PublicKey) })
+    next: X25519PublicKey[];
+
+    @field({ type: vec(X25519PublicKey) })
+    signatures: X25519PublicKey[];
+
+    constructor(properties?: {
+        meta: X25519PublicKey[];
+        next: X25519PublicKey[];
+        payload: X25519PublicKey[];
+        signatures: X25519PublicKey[];
+    }) {
+        super();
+        if (properties) {
+            this.metadata = properties.metadata;
+            this.payload = properties.payload;
+            this.next = properties.next;
+            this.signatures = properties.signatures;
+        }
+    }
+}
+
+@variant(1)
+export class SignedByQuery extends LogQuery {
+    @field({ type: vec(PublicSignKey) })
+    _publicKeys: PublicSignKey[];
+
+    constructor(properties: { publicKeys: PublicSignKey[] }) {
+        super();
+        if (properties) {
+            this._publicKeys = properties.publicKeys;
+        }
+    }
+
+    get publicKeys() {
+        return this._publicKeys;
+    }
+}
+ */
+//# sourceMappingURL=query.js.map

package/dist/src/query.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query.js","sourceRoot":"","sources":["../../src/query.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAEN,WAAW,EACX,KAAK,EACL,OAAO,EACP,GAAG,GACH,MAAM,gBAAgB,CAAC;AAExB,uBAAuB;AAEvB,MAAM,OAAgB,MAAM;CAAG;AAGxB,IAAM,OAAO,GAAb,MAAM,OAAO;IAEnB,OAAO,CAAS;IAGhB,QAAQ,CAAS;IAGjB,IAAI,CAAS;IAGb,GAAG,CAAS;IAGZ,IAAI,CAAS,CAAC,QAAQ;IAEtB,YAAY,UAMX;QACA,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC;QAClC,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;QACpC,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;QAC5B,IAAI,CAAC,GAAG,GAAG,UAAU,CAAC,GAAG,CAAC;QAC1B,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;IAC7B,CAAC;CACD,CAAA;AA3BA;IADC,KAAK,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;;wCACP;AAGhB;IADC,KAAK,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;;yCACN;AAGjB;IADC,KAAK,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;qCACb;AAGb;IADC,KAAK,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;oCACd;AAGZ;IADC,KAAK,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;;qCACV;AAdD,OAAO;IADnB,OAAO,CAAC,CAAC,CAAC;;GACE,OAAO,CA6BnB;;AAGM,IAAM,gBAAgB,GAAtB,MAAM,gBAAoB,SAAQ,MAAM;IAE9C,OAAO,CAAa;IAGpB,OAAO,CAAU;IAEjB,KAAK,CAAkB;IACvB,YAAY,IAKX;QACA,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC;QACzB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;IAC7B,CAAC;IAED,IAAI,CAAC,IAAqB;QACzB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,MAAM,CAAK;IACX,IAAI,KAAK;QACR,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,OAAO,IAAI,CAAC,MAAM,CAAC;QACpB,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC1C,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QACpD,OAAO,IAAI,CAAC,MAAM,CAAC;IACpB,CAAC;IAED,iFAAiF;IACjF,OAAO,CAAuB;CAC9B,CAAA;AArCA;IADC,KAAK,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;8BACnB,UAAU;iDAAC;AAGpB;IADC,KAAK,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;8BAChB,OAAO;iDAAC;AALL,gBAAgB;IAD5B,OAAO,CAAC,CAAC,CAAC;;GACE,gBAAgB,CAuC5B;;AAED,6DAA6D;AAC7D,MAAM,OAAgB,oBAAoB;CAAM;AAGzC,IAAM,OAAO,GAAb,MAAM,OAAW,SAAQ,oBAAuB;IAEtD,OAAO,CAAwB;IAG/B,IAAI,CAAS,CAAC,kEAAkE;IAEhF,YAAY,UAA4D;QACvE,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;QAC5B,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC;IACnC,CAAC;CACD,CAAA;AAVA;IADC,KAAK,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,gBAAgB,CAAC,EAAE,CAAC;;wCACR;AAG/B;IADC,KAAK,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;;qCACV;AALD,OAAO;IADnB,OAAO,CAAC,CAAC,CAAC;;GACE,OAAO,CAYnB;;AAGM,IAAM,QAAQ,GAAd,MAAM,QAAS,SAAQ,oBAAyB;CAAG,CAAA;AAA7C,QAAQ;IADpB,OAAO,CAAC,CAAC,CAAC;GACE,QAAQ,CAAqC;;AAE1D;0CAC0C;AAE1C;;GAEG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG"}

package/dist/src/store.d.ts

@@ -0,0 +1,6 @@
+export type IDocumentStore<T> = {
+    index: {
+        search: (query: any) => Promise<T[]>;
+    };
+};
+//# sourceMappingURL=store.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../src/store.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI;IAC/B,KAAK,EAAE;QAAE,MAAM,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,OAAO,CAAC,CAAC,EAAE,CAAC,CAAA;KAAE,CAAC;CAChD,CAAC"}

package/dist/src/store.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=store.js.map

package/dist/src/store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"store.js","sourceRoot":"","sources":["../../src/store.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@peerbit/document-interface",
+  "version": "1.0.0-1d1274c",
+  "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-1d1274c",
+    "@peerbit/indexer-interface": "1.0.0-1d1274c"
+  }
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from "./query.js";
+export * from "./store.js";

package/src/query.ts

@@ -0,0 +1,170 @@
+import {
+	type AbstractType,
+	deserialize,
+	field,
+	variant,
+	vec,
+} from "@dao-xyz/borsh";
+
+/// ----- RESULTS -----
+
+export abstract class Result {}
+
+@variant(0)
+export class Context {
+	@field({ type: "u64" })
+	created: bigint;
+
+	@field({ type: "u64" })
+	modified: bigint;
+
+	@field({ type: "string" })
+	head: string;
+
+	@field({ type: "string" })
+	gid: string;
+
+	@field({ type: "u32" })
+	size: number; // bytes
+
+	constructor(properties: {
+		created: bigint;
+		modified: bigint;
+		head: string;
+		gid: string;
+		size: number;
+	}) {
+		this.created = properties.created;
+		this.modified = properties.modified;
+		this.head = properties.head;
+		this.gid = properties.gid;
+		this.size = properties.size;
+	}
+}
+
+@variant(0)
+export class ResultWithSource<T> extends Result {
+	@field({ type: Uint8Array })
+	_source: Uint8Array;
+
+	@field({ type: Context })
+	context: Context;
+
+	_type: AbstractType<T>;
+	constructor(opts: {
+		source: Uint8Array;
+		context: Context;
+		value?: T;
+		indexed?: Record<string, any>;
+	}) {
+		super();
+		this._source = opts.source;
+		this.context = opts.context;
+		this._value = opts.value;
+		this.indexed = opts.indexed;
+	}
+
+	init(type: AbstractType<T>) {
+		this._type = type;
+	}
+
+	_value?: T;
+	get value(): T {
+		if (this._value) {
+			return this._value;
+		}
+		if (!this._source) {
+			throw new Error("Missing source binary");
+		}
+		this._value = deserialize(this._source, this._type);
+		return this._value;
+	}
+
+	// we never send this over the wire since we can always reconstruct it from value
+	indexed?: Record<string, any>;
+}
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export abstract class AbstractSearchResult<T> {}
+
+@variant(0)
+export class Results<T> extends AbstractSearchResult<T> {
+	@field({ type: vec(ResultWithSource) })
+	results: ResultWithSource<T>[];
+
+	@field({ type: "u64" })
+	kept: bigint; // how many results that were not sent, but can be collected later
+
+	constructor(properties: { results: ResultWithSource<T>[]; kept: bigint }) {
+		super();
+		this.kept = properties.kept;
+		this.results = properties.results;
+	}
+}
+
+@variant(1)
+export class NoAccess extends AbstractSearchResult<any> {}
+
+/* @variant(5)
+export class LogQuery extends Query { } */
+
+/**
+ * Find logs that can be decrypted by certain keys
+ */
+/* 
+@variant(0)
+export class EntryEncryptedByQuery
+	extends LogQuery
+	implements
+	EntryEncryptionTemplate<
+		X25519PublicKey[],
+		X25519PublicKey[],
+		X25519PublicKey[],
+		X25519PublicKey[]
+	>
+{
+	@field({ type: vec(X25519PublicKey) })
+	meta: X25519PublicKey[];
+
+	@field({ type: vec(X25519PublicKey) })
+	payload: X25519PublicKey[];
+
+	@field({ type: vec(X25519PublicKey) })
+	next: X25519PublicKey[];
+
+	@field({ type: vec(X25519PublicKey) })
+	signatures: X25519PublicKey[];
+
+	constructor(properties?: {
+		meta: X25519PublicKey[];
+		next: X25519PublicKey[];
+		payload: X25519PublicKey[];
+		signatures: X25519PublicKey[];
+	}) {
+		super();
+		if (properties) {
+			this.metadata = properties.metadata;
+			this.payload = properties.payload;
+			this.next = properties.next;
+			this.signatures = properties.signatures;
+		}
+	}
+}
+
+@variant(1)
+export class SignedByQuery extends LogQuery {
+	@field({ type: vec(PublicSignKey) })
+	_publicKeys: PublicSignKey[];
+
+	constructor(properties: { publicKeys: PublicSignKey[] }) {
+		super();
+		if (properties) {
+			this._publicKeys = properties.publicKeys;
+		}
+	}
+
+	get publicKeys() {
+		return this._publicKeys;
+	}
+}
+ */

package/src/store.ts

@@ -0,0 +1,3 @@
+export type IDocumentStore<T> = {
+	index: { search: (query: any) => Promise<T[]> };
+};