@peerbit/document 2.0.1 → 3.0.0

package/src/document-store.ts

@@ -5,10 +5,9 @@ import {
 	serialize,
 	variant,
 } from "@dao-xyz/borsh";
-import { CanAppend, Change, Entry, EntryType, TrimOptions } from "@peerbit/log";
+import { Change, Entry, EntryType, TrimOptions } from "@peerbit/log";
 import { Program, ProgramEvents } from "@peerbit/program";
-import { CanRead } from "@peerbit/rpc";
-import { AccessError, DecryptedThing } from "@peerbit/crypto";
+import { AccessError, DecryptedThing, PublicSignKey } from "@peerbit/crypto";
 import { logger as loggerFn } from "@peerbit/logger";
 import { AppendOptions } from "@peerbit/log";
 import { CustomEvent } from "@libp2p/interfaces/events";
@@ -18,16 +17,19 @@ import {
 	Replicator,
 	SharedLog,
 	SharedLogOptions,
+	SharedAppendOptions,
 } from "@peerbit/shared-log";
 export { Role, Observer, Replicator }; // For convenience (so that consumers does not have to do the import above from shared-log packages)
 
 import {
-	Indexable,
+	IndexableFields,
 	BORSH_ENCODING_OPERATION,
 	DeleteOperation,
 	DocumentIndex,
 	Operation,
 	PutOperation,
+	CanSearch,
+	CanRead,
 } from "./document-index.js";
 import { asString, checkKeyable, Keyable } from "./utils.js";
 import { Context, Results } from "./query.js";
@@ -47,16 +49,30 @@ export interface DocumentEvents<T> {
 	change: CustomEvent<DocumentsChange<T>>;
 }
 
+export type TransactionContext<T> = {
+	entry: Entry<Operation<T>>;
+};
+
+type MaybePromise = Promise<boolean> | boolean;
+
+type CanPerform<T> = (
+	operation: PutOperation<T> | DeleteOperation,
+	context: TransactionContext<T>
+) => MaybePromise;
+
 export type SetupOptions<T> = {
 	type: AbstractType<T>;
-	canRead?: CanRead;
-	canAppend?: CanAppend<Operation<T>>;
-	canOpen?: (program: T) => Promise<boolean> | boolean;
+	canOpen?: (program: T) => MaybePromise;
+	canPerform?: CanPerform<T>;
 	index?: {
 		key?: string | string[];
-		fields?: Indexable<T>;
+		fields?: IndexableFields<T>;
+		canSearch?: CanSearch;
+		canRead?: CanRead<T>;
+	};
+	log?: {
+		trim?: TrimOptions;
 	};
-	trim?: TrimOptions;
 } & SharedLogOptions;
 
 @variant("documents")
@@ -75,7 +91,8 @@ export class Documents<T extends Record<string, any>> extends Program<
 
 	private _clazz?: AbstractType<T>;
 
-	private _optionCanAppend?: CanAppend<Operation<T>>;
+	private _optionCanPerform?: CanPerform<T>;
+
 	canOpen?: (
 		program: T,
 		entry: Entry<Operation<T>>
@@ -109,14 +126,14 @@ export class Documents<T extends Record<string, any>> extends Program<
 				);
 			}
 		}
-		if (options.canAppend) {
-			this._optionCanAppend = options.canAppend;
-		}
+
+		this._optionCanPerform = options.canPerform;
 
 		await this._index.open({
 			type: this._clazz,
 			log: this.log,
-			canRead: options.canRead || (() => Promise.resolve(true)),
+			canRead: options?.index?.canRead,
+			canSearch: options.index?.canSearch,
 			fields: options.index?.fields || ((obj) => obj),
 			indexBy: options.index?.key,
 			sync: async (result: Results<T>) =>
@@ -125,12 +142,13 @@ export class Documents<T extends Record<string, any>> extends Program<
 
 		await this.log.open({
 			encoding: BORSH_ENCODING_OPERATION,
+			canReplicate: options?.canReplicate,
 			canAppend: this.canAppend.bind(this),
 			onChange: this.handleChanges.bind(this),
-			trim: options?.trim,
+			trim: options?.log?.trim,
 			sync: options?.sync,
 			role: options?.role,
-			minReplicas: options?.minReplicas,
+			replicas: options?.replicas,
 		});
 	}
 
@@ -150,8 +168,22 @@ export class Documents<T extends Record<string, any>> extends Program<
 			return false;
 		}
 
-		if (this._optionCanAppend && !(await this._optionCanAppend(entry))) {
-			return false;
+		if (this._optionCanPerform) {
+			const payload = await entry.getPayloadValue();
+
+			if (payload instanceof PutOperation) {
+				payload.getValue(this.index.valueEncoding); // Decode they value so callbacks can jsut do .value
+			}
+			if (
+				!(await this._optionCanPerform(
+					payload as PutOperation<T> | DeleteOperation,
+					{
+						entry,
+					}
+				))
+			) {
+				return false;
+			}
 		}
 		return true;
 	}
@@ -248,7 +280,7 @@ export class Documents<T extends Record<string, any>> extends Program<
 
 	public async put(
 		doc: T,
-		options?: AppendOptions<Operation<T>> & { unique?: boolean }
+		options?: SharedAppendOptions<Operation<T>> & { unique?: boolean }
 	) {
 		const key = this._index.indexByResolver(doc as any as Keyable);
 		checkKeyable(key);
@@ -269,10 +301,13 @@ export class Documents<T extends Record<string, any>> extends Program<
 				value: doc,
 			}),
 			{
-				nexts: existingDocument
-					? [await this._resolveEntry(existingDocument.context.head)]
-					: [], //
 				...options,
+				meta: {
+					next: existingDocument
+						? [await this._resolveEntry(existingDocument.context.head)]
+						: [],
+					...options?.meta,
+				}, //
 			}
 		);
 	}
@@ -293,9 +328,12 @@ export class Documents<T extends Record<string, any>> extends Program<
 				key: asString(key),
 			}),
 			{
-				nexts: [await this._resolveEntry(existing.context.head)],
-				type: EntryType.CUT,
 				...options,
+				meta: {
+					next: [await this._resolveEntry(existing.context.head)],
+					type: EntryType.CUT,
+					...options?.meta,
+				},
 			} //
 		);
 	}
@@ -358,8 +396,8 @@ export class Documents<T extends Record<string, any>> extends Program<
 					const context = new Context({
 						created:
 							this._index.index.get(key)?.context.created ||
-							item.metadata.clock.timestamp.wallTime,
-						modified: item.metadata.clock.timestamp.wallTime,
+							item.meta.clock.timestamp.wallTime,
+						modified: item.meta.clock.timestamp.wallTime,
 						head: item.hash,
 					});
 
@@ -378,7 +416,7 @@ export class Documents<T extends Record<string, any>> extends Program<
 						if (
 							(await this.canOpen!(value, item)) &&
 							this.log.role instanceof Replicator &&
-							(await this.log.replicator(item.gid)) // TODO types, throw runtime error if replicator is not provided
+							(await this.log.replicator(item)) // TODO types, throw runtime error if replicator is not provided
 						) {
 							await this.node.open(value, {
 								parent: this as Program<any, any>,

package/src/query.ts

@@ -6,6 +6,7 @@ import {
 	variant,
 	vec,
 } from "@dao-xyz/borsh";
+
 import { asString } from "./utils.js";
 import { randomBytes, sha256Base64Sync } from "@peerbit/crypto";
 
@@ -431,8 +432,10 @@ export class ResultWithSource<T> extends Result {
 	}
 }
 
+export abstract class AbstractSearchResult<T> {}
+
 @variant(0)
-export class Results<T> {
+export class Results<T> extends AbstractSearchResult<T> {
 	@field({ type: vec(ResultWithSource) })
 	results: ResultWithSource<T>[];
 
@@ -440,11 +443,15 @@ export class Results<T> {
 	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 { } */
 
@@ -464,7 +471,7 @@ export class EntryEncryptedByQuery
 	>
 {
 	@field({ type: vec(X25519PublicKey) })
-	metadata: X25519PublicKey[];
+	meta: X25519PublicKey[];
 
 	@field({ type: vec(X25519PublicKey) })
 	payload: X25519PublicKey[];
@@ -476,7 +483,7 @@ export class EntryEncryptedByQuery
 	signatures: X25519PublicKey[];
 
 	constructor(properties?: {
-		metadata: X25519PublicKey[];
+		meta: X25519PublicKey[];
 		next: X25519PublicKey[];
 		payload: X25519PublicKey[];
 		signatures: X25519PublicKey[];