@milaboratories/pl-client 3.2.4 → 3.3.0

package/dist/core/transaction.js

@@ -1,4 +1,4 @@
-import { createLocalResourceId, ensureResourceIdNotNull, extractBasicResourceData, isLocalResourceId, isNullResourceId } from "./types.js";
+import { createLocalResourceId, createSignedResourceId, ensureSignedResourceIdNotNull, extractBasicResourceData, isLocalResourceId, isSignedResourceId, parseSignedResourceId, toResourceSignature } from "./types.js";
 import { TxAPI_Open_Request_WritableTx } from "../proto-grpc/github.com/milaboratory/pl/plapi/plapiproto/api.js";
 import { toBytes } from "../util/util.js";
 import { isNotFoundError } from "./errors.js";
@@ -13,16 +13,18 @@ function isField(ref) {
 	return ref.hasOwnProperty("resourceId") && ref.hasOwnProperty("fieldName");
 }
 function isResource(ref) {
-	return typeof ref === "bigint" || ref.hasOwnProperty("globalId") && ref.hasOwnProperty("localId");
+	if (typeof ref === "bigint") return true;
+	if (typeof ref === "string") return true;
+	return isResourceRef(ref);
 }
 function isResourceId(ref) {
-	return typeof ref === "bigint" && !isLocalResourceId(ref) && !isNullResourceId(ref);
+	return typeof ref === "string" && isSignedResourceId(ref);
 }
 function isFieldRef(ref) {
 	return isResourceRef(ref.resourceId);
 }
 function isResourceRef(ref) {
-	return ref.hasOwnProperty("globalId") && ref.hasOwnProperty("localId");
+	return typeof ref === "object" && ref !== null && ref.hasOwnProperty("globalId") && ref.hasOwnProperty("localId");
 }
 function toFieldId(ref) {
 	if (isFieldRef(ref)) return {
@@ -36,15 +38,30 @@ async function toGlobalFieldId(ref) {
 		resourceId: await ref.resourceId.globalId,
 		fieldName: ref.fieldName
 	};
-	else return ref;
+	return ref;
 }
-function toResourceId(ref) {
-	if (isResourceRef(ref)) return ref.localId;
-	else return ref;
+const emptySignature = toResourceSignature(new Uint8Array(0));
+function toResourceIdAndSignature(ref) {
+	if (isResourceRef(ref)) return {
+		resourceId: ref.localId,
+		resourceSignature: emptySignature
+	};
+	if (isResourceId(ref)) {
+		const { globalId, signature } = parseSignedResourceId(ref);
+		return {
+			resourceId: globalId,
+			resourceSignature: signature
+		};
+	}
+	return {
+		resourceId: ref,
+		resourceSignature: emptySignature
+	};
 }
 async function toGlobalResourceId(ref) {
 	if (isResourceRef(ref)) return await ref.globalId;
-	else return ref;
+	if (isLocalResourceId(ref)) return createSignedResourceId(ref);
+	return ref;
 }
 function field(resourceId, fieldName) {
 	return {
@@ -146,6 +163,32 @@ var PlTransaction = class PlTransaction {
 	sendVoidAsync(r) {
 		this.track(this.sendVoidSync(r));
 	}
+	/** Set default color proof for subsequent resource creation requests */
+	setDefaultColor(colorProof) {
+		this.sendVoidAsync({
+			oneofKind: "setDefaultColor",
+			setDefaultColor: { colorProof }
+		});
+	}
+	toSignedResourceId(rId) {
+		return toResourceIdAndSignature(rId);
+	}
+	toSignedFieldId(fId) {
+		const base = toFieldId(fId);
+		const signed = toResourceIdAndSignature(base.resourceId);
+		return {
+			resourceId: signed.resourceId,
+			fieldName: base.fieldName,
+			resourceSignature: signed.resourceSignature
+		};
+	}
+	toSignedErrorRef(rId) {
+		const { resourceId, resourceSignature } = this.toSignedResourceId(rId);
+		return {
+			errorResourceId: resourceId,
+			errorResourceSignature: resourceSignature
+		};
+	}
 	checkTxOpen() {
 		if (this._completed) throw new Error("Transaction already closed");
 	}
@@ -189,25 +232,19 @@ var PlTransaction = class PlTransaction {
 		await this.ll.await();
 	}
 	get clientRoot() {
-		return ensureResourceIdNotNull(this._clientRoot);
+		return ensureSignedResourceIdNotNull(this._clientRoot);
 	}
-	createSingleton(name, type, errorIfExists = false) {
-		const localId = this.nextLocalResourceId(false);
-		const globalId = this.sendSingleAndParse({
+	createSingleton(name, type, errorIfExists = false, color) {
+		return this.createResource(false, (localId) => ({
 			oneofKind: "resourceCreateSingleton",
 			resourceCreateSingleton: {
 				type,
 				id: localId,
 				data: Buffer.from(name),
 				errorIfExists,
-				colorProof: new Uint8Array(0)
+				colorProof: color ?? emptySignature
 			}
-		}, (r) => r.resourceCreateSingleton.resourceId);
-		this.track(globalId);
-		return {
-			globalId,
-			localId
-		};
+		}), (r) => r.resourceCreateSingleton.resourceId, (r) => r.resourceCreateSingleton.resourceSignature);
 	}
 	getSingleton(name, loadFields = true) {
 		return this.sendSingleAndParse({
@@ -218,9 +255,11 @@ var PlTransaction = class PlTransaction {
 			}
 		}, (r) => protoToResource(notEmpty(r.resourceGetSingleton.resource)));
 	}
-	createResource(root, req, parser) {
+	createResource(root, req, parser, sigExtractor) {
 		const localId = this.nextLocalResourceId(root);
-		const globalId = this.sendSingleAndParse(req(localId), (r) => parser(r));
+		const globalId = this.sendSingleAndParse(req(localId), (r) => {
+			return createSignedResourceId(parser(r), sigExtractor ? toResourceSignature(sigExtractor(r)) : void 0);
+		});
 		this.track(globalId);
 		return {
 			globalId,
@@ -235,9 +274,9 @@ var PlTransaction = class PlTransaction {
 				type,
 				id: localId
 			}
-		}), (r) => r.resourceCreateRoot.resourceId);
+		}), (r) => r.resourceCreateRoot.resourceId, (r) => r.resourceCreateRoot.resourceSignature);
 	}
-	createStruct(type, data) {
+	createStruct(type, data, color) {
 		this._stat.structsCreated++;
 		this._stat.structsCreatedDataBytes += data?.length ?? 0;
 		return this.createResource(false, (localId) => ({
@@ -246,11 +285,11 @@ var PlTransaction = class PlTransaction {
 				type,
 				id: localId,
 				data: data === void 0 ? void 0 : typeof data === "string" ? Buffer.from(data) : data,
-				colorProof: new Uint8Array(0)
+				colorProof: color ?? emptySignature
 			}
-		}), (r) => r.resourceCreateStruct.resourceId);
+		}), (r) => r.resourceCreateStruct.resourceId, (r) => r.resourceCreateStruct.resourceSignature);
 	}
-	createEphemeral(type, data) {
+	createEphemeral(type, data, color) {
 		this._stat.ephemeralsCreated++;
 		this._stat.ephemeralsCreatedDataBytes += data?.length ?? 0;
 		return this.createResource(false, (localId) => ({
@@ -259,11 +298,11 @@ var PlTransaction = class PlTransaction {
 				type,
 				id: localId,
 				data: data === void 0 ? void 0 : typeof data === "string" ? Buffer.from(data) : data,
-				colorProof: new Uint8Array(0)
+				colorProof: color ?? emptySignature
 			}
-		}), (r) => r.resourceCreateEphemeral.resourceId);
+		}), (r) => r.resourceCreateEphemeral.resourceId, (r) => r.resourceCreateEphemeral.resourceSignature);
 	}
-	createValue(type, data, errorIfExists = false) {
+	createValue(type, data, errorIfExists = false, color) {
 		this._stat.valuesCreated++;
 		this._stat.valuesCreatedDataBytes += data?.length ?? 0;
 		return this.createResource(false, (localId) => ({
@@ -273,26 +312,26 @@ var PlTransaction = class PlTransaction {
 				id: localId,
 				data: typeof data === "string" ? Buffer.from(data) : data,
 				errorIfExists,
-				colorProof: new Uint8Array(0)
+				colorProof: color ?? emptySignature
 			}
-		}), (r) => r.resourceCreateValue.resourceId);
+		}), (r) => r.resourceCreateValue.resourceId, (r) => r.resourceCreateValue.resourceSignature);
 	}
-	createJsonValue(data) {
+	createJsonValue(data, color) {
 		const jsonData = canonicalJsonBytes(data);
-		return this.createValue(JsonObject, jsonData, false);
+		return this.createValue(JsonObject, jsonData, false, color);
 	}
-	createJsonGzValue(data, minSizeToGzip = 16384) {
+	createJsonGzValue(data, minSizeToGzip = 16384, color) {
 		const { data: jsonData, isGzipped } = canonicalJsonGzBytes(data, minSizeToGzip);
-		return this.createValue(isGzipped ? JsonGzObject : JsonObject, jsonData, false);
+		return this.createValue(isGzipped ? JsonGzObject : JsonObject, jsonData, false, color);
 	}
-	createError(message) {
-		return this.createValue(ErrorResourceType, JSON.stringify({ message }));
+	createError(message, color) {
+		return this.createValue(ErrorResourceType, JSON.stringify({ message }), false, color);
 	}
 	setResourceName(name, rId) {
 		this.sendVoidAsync({
 			oneofKind: "resourceNameSet",
 			resourceNameSet: {
-				resourceId: toResourceId(rId),
+				...this.toSignedResourceId(rId),
 				name
 			}
 		});
@@ -307,7 +346,11 @@ var PlTransaction = class PlTransaction {
 		return this.sendSingleAndParse({
 			oneofKind: "resourceNameGet",
 			resourceNameGet: { name }
-		}, (r) => ensureResourceIdNotNull(r.resourceNameGet.resourceId));
+		}, (r) => {
+			const rawId = r.resourceNameGet.resourceId;
+			if (rawId === 0n) throw new Error("null resource id from getResourceByName");
+			return createSignedResourceId(rawId, toResourceSignature(r.resourceNameGet.resourceSignature));
+		});
 	}
 	checkResourceNameExists(name) {
 		return this.sendSingleAndParse({
@@ -318,18 +361,18 @@ var PlTransaction = class PlTransaction {
 	removeResource(rId) {
 		this.sendVoidAsync({
 			oneofKind: "resourceRemove",
-			resourceRemove: { resourceId: rId }
+			resourceRemove: this.toSignedResourceId(rId)
 		});
 	}
 	resourceExists(rId) {
 		return this.sendSingleAndParse({
 			oneofKind: "resourceExists",
-			resourceExists: { resourceId: rId }
+			resourceExists: this.toSignedResourceId(rId)
 		}, (r) => r.resourceExists.exists);
 	}
 	async getResourceData(rId, loadFields = true, ignoreCache = false) {
 		return this.track(async () => {
-			if (!ignoreCache && !isResourceRef(rId) && !isLocalResourceId(rId)) {
+			if (!ignoreCache && isResourceId(rId)) {
 				const fromCache = this.sharedResourceDataCache.get(rId);
 				if (fromCache && fromCache.cacheTxOpenTimestamp < this.txOpenTimestamp) {
 					if (!loadFields) {
@@ -347,14 +390,14 @@ var PlTransaction = class PlTransaction {
 			const result = await this.sendSingleAndParse({
 				oneofKind: "resourceGet",
 				resourceGet: {
-					resourceId: toResourceId(rId),
+					...this.toSignedResourceId(rId),
 					loadFields
 				}
 			}, (r) => protoToResource(notEmpty(r.resourceGet.resource)));
 			this._stat.rGetDataNetRequests++;
 			this._stat.rGetDataNetBytes += result.data?.length ?? 0;
 			this._stat.rGetDataNetFields += result.fields.length;
-			if (!isResourceRef(rId) && !isLocalResourceId(rId) && this.finalPredicate(result)) {
+			if (isResourceId(rId) && this.finalPredicate(result)) {
 				deepFreeze(result);
 				const fromCache = this.sharedResourceDataCache.get(rId);
 				if (fromCache) {
@@ -383,7 +426,7 @@ var PlTransaction = class PlTransaction {
 	async getResourceDataIfExists(rId, loadFields = true) {
 		return this.track(async () => {
 			const result = await notFoundToUndefined(async () => await this.getResourceData(rId, loadFields, true));
-			if (result === void 0 && !isResourceRef(rId) && !isLocalResourceId(rId)) this.sharedResourceDataCache.delete(rId);
+			if (result === void 0 && isResourceId(rId)) this.sharedResourceDataCache.delete(rId);
 			return result;
 		});
 	}
@@ -398,10 +441,7 @@ var PlTransaction = class PlTransaction {
 		this._stat.inputsLocked++;
 		this.sendVoidAsync({
 			oneofKind: "resourceLockInputs",
-			resourceLockInputs: {
-				resourceId: toResourceId(rId),
-				resourceSignature: new Uint8Array(0)
-			}
+			resourceLockInputs: this.toSignedResourceId(rId)
 		});
 	}
 	/**
@@ -412,10 +452,7 @@ var PlTransaction = class PlTransaction {
 		this._stat.outputsLocked++;
 		this.sendVoidAsync({
 			oneofKind: "resourceLockOutputs",
-			resourceLockOutputs: {
-				resourceId: toResourceId(rId),
-				resourceSignature: new Uint8Array(0)
-			}
+			resourceLockOutputs: this.toSignedResourceId(rId)
 		});
 	}
 	lock(rID) {
@@ -426,8 +463,8 @@ var PlTransaction = class PlTransaction {
 		this.sendVoidAsync({
 			oneofKind: "resourceSetError",
 			resourceSetError: {
-				resourceId: toResourceId(rId),
-				errorResourceId: toResourceId(ref)
+				...this.toSignedResourceId(rId),
+				...this.toSignedErrorRef(ref)
 			}
 		});
 	}
@@ -437,7 +474,7 @@ var PlTransaction = class PlTransaction {
 			oneofKind: "fieldCreate",
 			fieldCreate: {
 				type: fieldTypeToProto(fieldType),
-				id: toFieldId(fId)
+				id: this.toSignedFieldId(fId)
 			}
 		});
 		if (value !== void 0) this.setField(fId, value);
@@ -445,7 +482,7 @@ var PlTransaction = class PlTransaction {
 	fieldExists(fId) {
 		return this.sendSingleAndParse({
 			oneofKind: "fieldExists",
-			fieldExists: { field: toFieldId(fId) }
+			fieldExists: { field: this.toSignedFieldId(fId) }
 		}, (r) => r.fieldExists.exists);
 	}
 	setField(fId, ref) {
@@ -453,9 +490,9 @@ var PlTransaction = class PlTransaction {
 		if (isResource(ref)) this.sendVoidAsync({
 			oneofKind: "fieldSet",
 			fieldSet: {
-				field: toFieldId(fId),
+				field: this.toSignedFieldId(fId),
 				value: {
-					resourceId: toResourceId(ref),
+					...this.toSignedResourceId(ref),
 					fieldName: ""
 				}
 			}
@@ -463,8 +500,8 @@ var PlTransaction = class PlTransaction {
 		else this.sendVoidAsync({
 			oneofKind: "fieldSet",
 			fieldSet: {
-				field: toFieldId(fId),
-				value: toFieldId(ref)
+				field: this.toSignedFieldId(fId),
+				value: this.toSignedFieldId(ref)
 			}
 		});
 	}
@@ -473,8 +510,8 @@ var PlTransaction = class PlTransaction {
 		this.sendVoidAsync({
 			oneofKind: "fieldSetError",
 			fieldSetError: {
-				field: toFieldId(fId),
-				errorResourceId: toResourceId(ref)
+				field: this.toSignedFieldId(fId),
+				...this.toSignedErrorRef(ref)
 			}
 		});
 	}
@@ -482,7 +519,7 @@ var PlTransaction = class PlTransaction {
 		this._stat.fieldsGet++;
 		return this.sendSingleAndParse({
 			oneofKind: "fieldGet",
-			fieldGet: { field: toFieldId(fId) }
+			fieldGet: { field: this.toSignedFieldId(fId) }
 		}, (r) => protoToField(notEmpty(r.fieldGet.field)));
 	}
 	async getFieldIfExists(fId) {
@@ -491,13 +528,13 @@ var PlTransaction = class PlTransaction {
 	resetField(fId) {
 		this.sendVoidAsync({
 			oneofKind: "fieldReset",
-			fieldReset: { field: toFieldId(fId) }
+			fieldReset: { field: this.toSignedFieldId(fId) }
 		});
 	}
 	removeField(fId) {
 		this.sendVoidAsync({
 			oneofKind: "fieldRemove",
-			fieldRemove: { field: toFieldId(fId) }
+			fieldRemove: { field: this.toSignedFieldId(fId) }
 		});
 	}
 	async listKeyValues(rId) {
@@ -505,7 +542,7 @@ var PlTransaction = class PlTransaction {
 			const result = await this.sendMultiAndParse({
 				oneofKind: "resourceKeyValueList",
 				resourceKeyValueList: {
-					resourceId: toResourceId(rId),
+					...this.toSignedResourceId(rId),
 					startFrom: "",
 					limit: 0
 				}
@@ -534,8 +571,7 @@ var PlTransaction = class PlTransaction {
 		this.sendVoidAsync({
 			oneofKind: "resourceKeyValueSet",
 			resourceKeyValueSet: {
-				resourceId: toResourceId(rId),
-				resourceSignature: new Uint8Array(0),
+				...this.toSignedResourceId(rId),
 				key,
 				value: toBytes(value)
 			}
@@ -545,8 +581,7 @@ var PlTransaction = class PlTransaction {
 		this.sendVoidAsync({
 			oneofKind: "resourceKeyValueDelete",
 			resourceKeyValueDelete: {
-				resourceId: toResourceId(rId),
-				resourceSignature: new Uint8Array(0),
+				...this.toSignedResourceId(rId),
 				key
 			}
 		});
@@ -556,7 +591,7 @@ var PlTransaction = class PlTransaction {
 			const result = await this.sendSingleAndParse({
 				oneofKind: "resourceKeyValueGet",
 				resourceKeyValueGet: {
-					resourceId: toResourceId(rId),
+					...this.toSignedResourceId(rId),
 					key
 				}
 			}, (r) => r.resourceKeyValueGet.value);
@@ -576,7 +611,7 @@ var PlTransaction = class PlTransaction {
 			const result = await this.sendSingleAndParse({
 				oneofKind: "resourceKeyValueGetIfExists",
 				resourceKeyValueGetIfExists: {
-					resourceId: toResourceId(rId),
+					...this.toSignedResourceId(rId),
 					key
 				}
 			}, (r) => r.resourceKeyValueGetIfExists.exists ? r.resourceKeyValueGetIfExists.value : void 0);
@@ -593,7 +628,7 @@ var PlTransaction = class PlTransaction {
 	}
 	async getKValueJsonIfExists(rId, key) {
 		return this.track(async () => {
-			const str = await this.getKValueString(rId, key);
+			const str = await this.getKValueStringIfExists(rId, key);
 			if (str === void 0) return void 0;
 			return JSON.parse(str);
 		});
@@ -645,6 +680,6 @@ var PlTransaction = class PlTransaction {
 	}
 };
 //#endregion
-export { PlTransaction, TxCommitConflict, field, isField, isFieldRef, isResource, isResourceId, isResourceRef, toFieldId, toGlobalFieldId, toGlobalResourceId, toResourceId };
+export { PlTransaction, TxCommitConflict, field, isField, isFieldRef, isResource, isResourceId, isResourceRef, toFieldId, toGlobalFieldId, toGlobalResourceId };
 
 //# sourceMappingURL=transaction.js.map