@verdant-web/common 1.11.1 → 1.13.0

package/src/schema/validation.ts

@@ -0,0 +1,99 @@
+import { LEGACY_OID_KEY, OID_KEY } from '../oids.js';
+import { isObject } from '../utils.js';
+import { StorageCollectionSchema, StorageFieldSchema } from './types.js';
+
+export function validateEntity(schema: StorageCollectionSchema, entity: any) {
+	for (const [key, value] of Object.entries(entity)) {
+		if (!schema.fields[key]) {
+			throw new Error(`Invalid field "${key}"`);
+		}
+		if (value) {
+			validateEntityField(schema.fields[key], value);
+		}
+	}
+}
+
+export function validateEntityField(
+	field: StorageFieldSchema,
+	value: any,
+	fieldPath: string[] = [],
+) {
+	if (field.type === 'object') {
+		if (!isObject(value)) {
+			if (value === null && field.nullable) return;
+			throw new Error(
+				`Expected object${
+					field.nullable ? ' or null' : ''
+				} for field ${formatField(fieldPath)}}`,
+			);
+		}
+		for (const [key, subField] of Object.entries(field.properties)) {
+			if (value[key]) {
+				validateEntityField(subField, value[key]);
+			}
+		}
+		for (const key of Object.keys(value)) {
+			if (!field.properties[key]) {
+				throw new Error(
+					`Invalid field "${key}" on value ${formatField(fieldPath)}`,
+				);
+			}
+		}
+	} else if (field.type === 'array') {
+		if (!Array.isArray(value)) {
+			if (value === null && field.nullable) return;
+			throw new Error(
+				`Expected array${
+					field.nullable ? ' or null' : ''
+				} for field ${formatField(fieldPath)}}`,
+			);
+		}
+		for (const item of value) {
+			validateEntityField(field.items, item);
+		}
+	} else if (field.type === 'map') {
+		if (!isObject(value)) {
+			throw new Error(`Expected map for field ${formatField(fieldPath)}}`);
+		}
+		for (const [key, item] of Object.entries(value)) {
+			// santiy check to weed out any id field
+			if (key === OID_KEY || key === LEGACY_OID_KEY) continue;
+			validateEntityField(field.values, item);
+		}
+	} else if (field.type === 'string') {
+		if (typeof value !== 'string') {
+			if (value === null && field.nullable) return;
+			throw new Error(
+				`Expected string ${
+					field.nullable ? ' or null' : ''
+				} for field ${formatField(fieldPath)}}`,
+			);
+		}
+	} else if (field.type === 'boolean') {
+		if (typeof value !== 'boolean') {
+			if (value === null && field.nullable) return;
+			throw new Error(
+				`Expected boolean ${
+					field.nullable ? ' or null' : ''
+				} for field ${formatField(fieldPath)}}`,
+			);
+		}
+	} else if (field.type === 'number') {
+		if (typeof value !== 'number') {
+			if (value === null && field.nullable) return;
+			throw new Error(
+				`Expected number ${
+					field.nullable ? ' or null' : ''
+				} for field ${formatField(fieldPath)}}`,
+			);
+		}
+	} else if (field.type === 'file') {
+		if (value === null && !field.nullable) {
+			throw new Error(`Expected file for field ${formatField(fieldPath)}}`);
+		}
+	}
+}
+
+function formatField(fieldPath: string[]) {
+	return fieldPath.join('.');
+}

package/src/utils.ts

@@ -60,19 +60,23 @@ export function stableStringify(obj: any) {
 	return JSON.stringify(obj, orderedReplacer);
 }
 
-export function cloneDeep<T>(obj: T): T {
-	if (isObject(obj)) {
+/**
+ * A version of structured cloning which preserves object identity
+ * references in the system.
+ */
+export function cloneDeep<T>(obj: T, copyOids = true): T {
+	if (isObject(obj) || Array.isArray(obj)) {
 		const oid = maybeGetOid(obj);
 		let clone: any;
 		if (Array.isArray(obj)) {
-			clone = obj.map(cloneDeep) as T;
+			clone = obj.map((v) => cloneDeep(v, copyOids)) as T;
 		} else {
 			clone = {};
 			for (const [key, value] of Object.entries(obj as any)) {
-				clone[key] = cloneDeep(value);
+				clone[key] = cloneDeep(value, copyOids);
 			}
 		}
-		if (oid) {
+		if (copyOids && oid) {
 			assignOid(clone, oid);
 		}
 		return clone;

package/dist/cjs/schema/defaults.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"defaults.js","sourceRoot":"","sources":["../../../src/schema/defaults.ts"],"names":[],"mappings":";;;AAAA,wCAAqD;AAGrD,SAAgB,gBAAgB,CAC/B,UAAmC,EACnC,KAAU;IAEV,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;QAC7D,MAAM,YAAY,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;QAC5C,IAAI,YAAY,KAAK,SAAS,IAAI,KAAK,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE;YAC3D,KAAK,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC;SAC1B;QACD,IAAI,KAAK,CAAC,GAAG,CAAC,EAAE;YACf,wCAAwC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;SAC5D;KACD;IACD,OAAO,KAAK,CAAC;AACd,CAAC;AAdD,4CAcC;AAED,SAAgB,wCAAwC,CACvD,KAAU,EACV,KAAyB;IAEzB,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,KAAK,CAAC;IACxD,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE;QAC5B,KAAK,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE;YAC/D,IAAI,KAAK,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE;gBAC7B,MAAM,YAAY,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC;gBAC/C,IAAI,YAAY,KAAK,SAAS,EAAE;oBAC/B,KAAK,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC;iBAC1B;aACD;YACD,wCAAwC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,QAAQ,CAAC,CAAC;SAC/D;KACD;SAAM,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE;QAClC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACzB,wCAAwC,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;SAC5D;KACD;SAAM,IAAI,KAAK,CAAC,IAAI,KAAK,KAAK,EAAE;QAChC,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YAChD,wCAAwC;YACxC,IAAI,GAAG,KAAK,iBAAO,IAAI,GAAG,KAAK,wBAAc;gBAAE,SAAS;YACxD,wCAAwC,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;SAC7D;KACD;AACF,CAAC;AA1BD,4FA0BC;AAED,SAAgB,eAAe,CAAC,KAAyB;IACxD,IACC,KAAK,CAAC,IAAI,KAAK,QAAQ;QACvB,KAAK,CAAC,IAAI,KAAK,QAAQ;QACvB,KAAK,CAAC,IAAI,KAAK,SAAS;QACxB,KAAK,CAAC,IAAI,KAAK,KAAK,EACnB;QACD,IAAI,KAAK,CAAC,OAAO,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,UAAU,EAAE;YACzD,OAAO,KAAK,CAAC,OAAO,EAAE,CAAC;SACvB;aAAM,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE;YACvC,yBAAyB;YACzB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;SACjD;KACD;IACD,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE;QAC3B,OAAO,EAAE,CAAC;KACV;IACD,IAAI,KAAK,CAAC,IAAI,KAAK,KAAK,EAAE;QACzB,OAAO,EAAE,CAAC;KACV;IACD,IAAI,KAAK,CAAC,IAAI,KAAK,KAAK,IAAI,KAAK,CAAC,QAAQ,EAAE;QAC3C,OAAO,IAAI,CAAC;KACZ;IACD,OAAO,SAAS,CAAC;AAClB,CAAC;AAxBD,0CAwBC"}

package/dist/esm/schema/defaults.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"defaults.js","sourceRoot":"","sources":["../../../src/schema/defaults.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAGrD,MAAM,UAAU,gBAAgB,CAC/B,UAAmC,EACnC,KAAU;IAEV,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;QAC7D,MAAM,YAAY,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;QAC5C,IAAI,YAAY,KAAK,SAAS,IAAI,KAAK,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE;YAC3D,KAAK,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC;SAC1B;QACD,IAAI,KAAK,CAAC,GAAG,CAAC,EAAE;YACf,wCAAwC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;SAC5D;KACD;IACD,OAAO,KAAK,CAAC;AACd,CAAC;AAED,MAAM,UAAU,wCAAwC,CACvD,KAAU,EACV,KAAyB;IAEzB,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,KAAK,CAAC;IACxD,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE;QAC5B,KAAK,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE;YAC/D,IAAI,KAAK,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE;gBAC7B,MAAM,YAAY,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC;gBAC/C,IAAI,YAAY,KAAK,SAAS,EAAE;oBAC/B,KAAK,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC;iBAC1B;aACD;YACD,wCAAwC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,QAAQ,CAAC,CAAC;SAC/D;KACD;SAAM,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE;QAClC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACzB,wCAAwC,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;SAC5D;KACD;SAAM,IAAI,KAAK,CAAC,IAAI,KAAK,KAAK,EAAE;QAChC,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YAChD,wCAAwC;YACxC,IAAI,GAAG,KAAK,OAAO,IAAI,GAAG,KAAK,cAAc;gBAAE,SAAS;YACxD,wCAAwC,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;SAC7D;KACD;AACF,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,KAAyB;IACxD,IACC,KAAK,CAAC,IAAI,KAAK,QAAQ;QACvB,KAAK,CAAC,IAAI,KAAK,QAAQ;QACvB,KAAK,CAAC,IAAI,KAAK,SAAS;QACxB,KAAK,CAAC,IAAI,KAAK,KAAK,EACnB;QACD,IAAI,KAAK,CAAC,OAAO,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,UAAU,EAAE;YACzD,OAAO,KAAK,CAAC,OAAO,EAAE,CAAC;SACvB;aAAM,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE;YACvC,yBAAyB;YACzB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;SACjD;KACD;IACD,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE;QAC3B,OAAO,EAAE,CAAC;KACV;IACD,IAAI,KAAK,CAAC,IAAI,KAAK,KAAK,EAAE;QACzB,OAAO,EAAE,CAAC;KACV;IACD,IAAI,KAAK,CAAC,IAAI,KAAK,KAAK,IAAI,KAAK,CAAC,QAAQ,EAAE;QAC3C,OAAO,IAAI,CAAC;KACZ;IACD,OAAO,SAAS,CAAC;AAClB,CAAC"}