@verdant-web/common 2.7.3 → 2.9.0

package/src/patch.ts

@@ -3,22 +3,24 @@
  */
 
 import { AuthorizationKey } from './authz.js';
+import { diffToPatches } from './diffing.js';
 import { FileRef } from './files.js';
 import { createRef, createSubOid, ObjectIdentifier } from './oids.js';
 import {
-	diffToPatches,
 	initialToPatches,
 	ObjectRef,
 	Operation,
 	PropertyName,
+	PropertyValue,
+	shallowInitialToPatches,
 } from './operation.js';
 import { isRef } from './refs.js';
-import { isObject } from './utils.js';
+import { assert, isObject } from './utils.js';
 
 export class PatchCreator {
 	constructor(
-		private getNow: () => string,
-		private createSubId?: () => string,
+		readonly getNow: () => string,
+		readonly createSubId?: () => string,
 	) {}
 
 	isPrimitive = (value: any) => {
@@ -28,7 +30,13 @@ export class PatchCreator {
 	createDiff = (
 		from: any,
 		to: any,
-		options: { mergeUnknownObjects?: boolean; defaultUndefined?: boolean } = {},
+		options: {
+			mergeUnknownObjects?: boolean;
+			/** @deprecated use the equivalent 'merge' */
+			defaultUndefined?: boolean;
+			merge?: boolean;
+			authz?: AuthorizationKey;
+		} = {},
 	) => {
 		return diffToPatches(from, to, this.getNow, this.createSubId, [], options);
 	};
@@ -37,7 +45,17 @@ export class PatchCreator {
 		obj: any,
 		oid: ObjectIdentifier,
 		authz?: AuthorizationKey,
+		shallow?: boolean,
 	) => {
+		if (shallow) {
+			return shallowInitialToPatches(
+				obj,
+				oid,
+				this.getNow,
+				undefined,
+				authz ? { authz } : undefined,
+			);
+		}
 		return initialToPatches(
 			obj,
 			oid,
@@ -52,6 +70,7 @@ export class PatchCreator {
 		oid: ObjectIdentifier,
 		key: PropertyName,
 		value: any,
+		authz?: AuthorizationKey,
 	): Operation[] => {
 		// incoming value must be normalized. if it's not a primitive, it and all sub-objects
 		// must be created
@@ -65,6 +84,7 @@ export class PatchCreator {
 						name: key,
 						value,
 					},
+					authz,
 				},
 			];
 		} else {
@@ -72,7 +92,16 @@ export class PatchCreator {
 			return [
 				// since we're setting a complex nested object, we can initialize it wholesale.
 				// no diffing to do.
-				...initialToPatches(value, itemOid, this.getNow),
+				...initialToPatches(
+					value,
+					itemOid,
+					this.getNow,
+					this.createSubId,
+					undefined,
+					{
+						authz,
+					},
+				),
 				// then set the reference to the object
 				{
 					oid,
@@ -82,12 +111,17 @@ export class PatchCreator {
 						value: createRef(itemOid),
 						name: key,
 					},
+					authz,
 				},
 			];
 		}
 	};
 
-	createRemove = (oid: ObjectIdentifier, key: PropertyName): Operation[] => {
+	createRemove = (
+		oid: ObjectIdentifier,
+		key: PropertyName,
+		authz?: AuthorizationKey,
+	): Operation[] => {
 		return [
 			{
 				oid,
@@ -96,6 +130,7 @@ export class PatchCreator {
 					op: 'remove',
 					name: key,
 				},
+				authz,
 			},
 		];
 	};
@@ -104,7 +139,9 @@ export class PatchCreator {
 		oid: ObjectIdentifier,
 		index: number,
 		value: any,
+		authz?: AuthorizationKey,
 	): Operation[] => {
+		assert(index >= 0, 'List index must be non-negative');
 		if (this.isPrimitive(value)) {
 			return [
 				{
@@ -115,12 +152,22 @@ export class PatchCreator {
 						index,
 						value,
 					},
+					authz,
 				},
 			];
 		} else {
 			const itemOid = createSubOid(oid, this.createSubId);
 			return [
-				...initialToPatches(value, itemOid, this.getNow),
+				...initialToPatches(
+					value,
+					itemOid,
+					this.getNow,
+					this.createSubId,
+					undefined,
+					{
+						authz,
+					},
+				),
 				{
 					oid,
 					timestamp: this.getNow(),
@@ -129,12 +176,17 @@ export class PatchCreator {
 						index,
 						value: createRef(itemOid),
 					},
+					authz,
 				},
 			];
 		}
 	};
 
-	createListPush = (oid: ObjectIdentifier, value: any): Operation[] => {
+	createListPush = (
+		oid: ObjectIdentifier,
+		value: any,
+		authz?: AuthorizationKey,
+	): Operation[] => {
 		if (this.isPrimitive(value)) {
 			return [
 				{
@@ -144,12 +196,15 @@ export class PatchCreator {
 						op: 'list-push',
 						value,
 					},
+					authz,
 				},
 			];
 		} else {
 			const itemOid = createSubOid(oid, this.createSubId);
 			return [
-				...initialToPatches(value, itemOid, this.getNow),
+				...initialToPatches(value, itemOid, this.getNow, undefined, undefined, {
+					authz,
+				}),
 				{
 					oid,
 					timestamp: this.getNow(),
@@ -157,12 +212,17 @@ export class PatchCreator {
 						op: 'list-push',
 						value: createRef(itemOid),
 					},
+					authz,
 				},
 			];
 		}
 	};
 
-	createListAdd = (oid: ObjectIdentifier, value: any): Operation[] => {
+	createListAdd = (
+		oid: ObjectIdentifier,
+		value: any,
+		authz?: AuthorizationKey,
+	): Operation[] => {
 		if (!this.isPrimitive(value)) {
 			return [
 				{
@@ -172,6 +232,7 @@ export class PatchCreator {
 						op: 'list-add',
 						value: createRef(value),
 					},
+					authz,
 				},
 			];
 		} else {
@@ -183,6 +244,7 @@ export class PatchCreator {
 						op: 'list-add',
 						value,
 					},
+					authz,
 				},
 			];
 		}
@@ -192,7 +254,9 @@ export class PatchCreator {
 		oid: ObjectIdentifier,
 		index: number,
 		value: any,
+		authz?: AuthorizationKey,
 	): Operation[] => {
+		assert(index >= 0, 'List index must be non-negative');
 		if (this.isPrimitive(value)) {
 			return [
 				{
@@ -203,12 +267,24 @@ export class PatchCreator {
 						value,
 						index,
 					},
+					authz,
 				},
 			];
 		} else {
 			const itemOid = createSubOid(oid, this.createSubId);
 			return [
-				...initialToPatches(value, itemOid, this.getNow),
+				...initialToPatches(
+					value,
+					itemOid,
+					this.getNow,
+					this.createSubId,
+					undefined,
+					authz
+						? {
+								authz,
+							}
+						: undefined,
+				),
 				{
 					oid,
 					timestamp: this.getNow(),
@@ -217,15 +293,55 @@ export class PatchCreator {
 						value: createRef(itemOid),
 						index,
 					},
+					authz,
 				},
 			];
 		}
 	};
 
+	createListInsertMany = (
+		oid: ObjectIdentifier,
+		index: number,
+		values: any[],
+		authz?: AuthorizationKey,
+	): Operation[] => {
+		assert(index >= 0, 'List index must be non-negative');
+		const operations: Operation[] = [];
+		const refs = values.map((value) => {
+			if (this.isPrimitive(value)) return value;
+			const subOid = createSubOid(oid, this.createSubId);
+			operations.push(
+				...initialToPatches(
+					value,
+					subOid,
+					this.getNow,
+					this.createSubId,
+					undefined,
+					{
+						authz,
+					},
+				),
+			);
+			return createRef(subOid);
+		});
+		operations.push({
+			oid,
+			timestamp: this.getNow(),
+			data: {
+				op: 'list-insert',
+				values: refs,
+				index,
+			},
+			authz,
+		});
+		return operations;
+	};
+
 	createListRemove = (
 		oid: ObjectIdentifier,
-		value: any,
+		value: PropertyValue,
 		only?: 'first' | 'last',
+		authz?: AuthorizationKey,
 	): Operation[] => {
 		return [
 			{
@@ -236,6 +352,7 @@ export class PatchCreator {
 					value,
 					only,
 				},
+				authz,
 			},
 		];
 	};
@@ -244,7 +361,10 @@ export class PatchCreator {
 		oid: ObjectIdentifier,
 		index: number,
 		count: number = 1,
+		authz?: AuthorizationKey,
 	): Operation[] => {
+		assert(index >= 0, 'List index must be non-negative');
+		assert(count > 0, 'Count must be positive and non-zero');
 		return [
 			{
 				oid,
@@ -254,6 +374,7 @@ export class PatchCreator {
 					index,
 					count,
 				},
+				authz,
 			},
 		];
 	};
@@ -262,7 +383,9 @@ export class PatchCreator {
 		oid: ObjectIdentifier,
 		value: ObjectRef | FileRef,
 		index: number,
+		authz?: AuthorizationKey,
 	): Operation[] => {
+		assert(index >= 0, 'List index must be non-negative');
 		return [
 			{
 				oid,
@@ -272,6 +395,7 @@ export class PatchCreator {
 					value,
 					index,
 				},
+				authz,
 			},
 		];
 	};
@@ -280,7 +404,10 @@ export class PatchCreator {
 		oid: ObjectIdentifier,
 		fromIndex: number,
 		toIndex: number,
+		authz?: AuthorizationKey,
 	): Operation[] => {
+		assert(fromIndex >= 0, 'List move from index must be non-negative');
+		assert(toIndex >= 0, 'List move to index must be non-negative');
 		return [
 			{
 				oid,
@@ -290,11 +417,15 @@ export class PatchCreator {
 					from: fromIndex,
 					to: toIndex,
 				},
+				authz,
 			},
 		];
 	};
 
-	createDelete = (oid: ObjectIdentifier): Operation[] => {
+	createDelete = (
+		oid: ObjectIdentifier,
+		authz?: AuthorizationKey,
+	): Operation[] => {
 		return [
 			{
 				oid,
@@ -302,6 +433,7 @@ export class PatchCreator {
 				data: {
 					op: 'delete',
 				},
+				authz,
 			},
 		];
 	};

package/src/schema/validation.test.ts

@@ -0,0 +1,66 @@
+import { describe, expect, it } from 'vitest';
+import { createFileRef } from '../files.js';
+import { createRef } from '../oids.js';
+import { schema, validateEntityField } from './index.js';
+
+describe('validation', () => {
+	it('validates shallowly with refs', () => {
+		const fieldSchema = schema.fields.object({
+			fields: {
+				obj: schema.fields.object({
+					fields: {},
+				}),
+				file: schema.fields.file(),
+			},
+		});
+		expect(
+			validateEntityField({
+				field: fieldSchema,
+				value: {
+					obj: createRef('some/id:1'),
+					file: createFileRef('somefile'),
+				},
+				fieldPath: [],
+				expectRefs: true,
+			}),
+		).toBeUndefined();
+		expect(
+			validateEntityField({
+				field: fieldSchema,
+				value: {
+					obj: createRef('some/id:1'),
+					file: createRef('some/object:1'),
+				},
+				fieldPath: [],
+				expectRefs: true,
+			}),
+		).toMatchInlineSnapshot(`
+			{
+			  "fieldPath": [
+			    "file",
+			  ],
+			  "message": "Expected file ref for field file, got {"@@type":"ref","id":"some/object:1"}",
+			  "type": "invalid-type",
+			}
+		`);
+		expect(
+			validateEntityField({
+				field: fieldSchema,
+				value: {
+					obj: 'foo',
+					file: createFileRef('somefile'),
+				},
+				fieldPath: [],
+				expectRefs: true,
+			}),
+		).toMatchInlineSnapshot(`
+			{
+			  "fieldPath": [
+			    "obj",
+			  ],
+			  "message": "Expected ref for field obj, got "foo"",
+			  "type": "invalid-type",
+			}
+		`);
+	});
+});