@verdant-web/common 2.0.2 → 2.1.0

package/src/schema/types/fields.ts

@@ -21,19 +21,21 @@ export type StorageBooleanFieldSchema = {
 	/** @deprecated - add an index to indexes with this field name. */
 	indexed?: boolean;
 };
-export type StorageArrayFieldSchema = {
+export type StorageArrayFieldSchema<TItems extends NestedStorageFieldSchema> = {
 	type: 'array';
-	items: NestedStorageFieldSchema;
+	items: TItems;
 	nullable?: boolean;
 };
-export type StorageObjectFieldSchema = {
-	type: 'object';
-	properties: NestedStorageFieldsSchema;
-	nullable?: boolean;
-};
-export type StorageAnyFieldSchema = {
+export type StorageObjectFieldSchema<Props extends NestedStorageFieldsSchema> =
+	{
+		type: 'object';
+		properties: Props;
+		nullable?: boolean;
+		default?: Record<string, any> | (() => Record<string, any>);
+	};
+export type StorageAnyFieldSchema<TShape = any> = {
 	type: 'any';
-	default?: any;
+	default?: TShape;
 };
 export type StorageMapFieldSchema<V extends NestedStorageFieldSchema> = {
 	type: 'map';
@@ -54,8 +56,8 @@ export type StorageFieldSchema =
 	| StorageStringFieldSchema
 	| StorageNumberFieldSchema
 	| StorageBooleanFieldSchema
-	| StorageArrayFieldSchema
-	| StorageObjectFieldSchema
+	| StorageArrayFieldSchema<any>
+	| StorageObjectFieldSchema<any>
 	| StorageAnyFieldSchema
 	| StorageMapFieldSchema<any>
 	| StorageFileFieldSchema;
@@ -81,8 +83,8 @@ export type NestedStorageFieldSchema =
 	| NestedStorageStringFieldSchema
 	| NestedStorageNumberFieldSchema
 	| NestedStorageBooleanFieldSchema
-	| StorageArrayFieldSchema
-	| StorageObjectFieldSchema
+	| StorageArrayFieldSchema<any>
+	| StorageObjectFieldSchema<any>
 	| StorageAnyFieldSchema
 	| StorageMapFieldSchema<any>
 	| StorageFileFieldSchema;

package/src/schema/types/shapes.ts

@@ -25,10 +25,10 @@ export type BaseShapeFromProperty<T extends StorageFieldSchema> =
 		? number
 		: T['type'] extends 'boolean'
 		? boolean
-		: T extends StorageArrayFieldSchema
-		? ShapeFromProperty<T['items']>[]
-		: T extends StorageObjectFieldSchema
-		? ShapeFromFields<T['properties']>
+		: T extends StorageArrayFieldSchema<infer U>
+		? ShapeFromProperty<U>[]
+		: T extends StorageObjectFieldSchema<infer U>
+		? ShapeFromFields<U>
 		: T extends StorageMapFieldSchema<any>
 		? Record<string, ShapeFromProperty<T['values']>>
 		: T['type'] extends 'any'
@@ -65,7 +65,7 @@ type StoragePropertyIsOptional<T extends StorageFieldSchema> =
 		? true
 		: false;
 
-type ShapeFromFieldsWithDefaults<
+export type ShapeFromFieldsWithDefaults<
 	T extends StorageFieldsSchema | NestedStorageFieldsSchema,
 > = {
 	[K in keyof T as StoragePropertyIsOptional<T[K]> extends true
@@ -80,3 +80,7 @@ type ShapeFromFieldsWithDefaults<
 export type StorageDocumentInit<
 	Collection extends StorageCollectionSchema<any, any, any>,
 > = ShapeFromFieldsWithDefaults<Collection['fields']>;
+
+export type FieldsFromShape<Shape extends Record<string, unknown>> = {
+	[K in keyof Shape]: StorageFieldSchema;
+};

package/src/schema/validation.ts

@@ -1,12 +1,19 @@
+import { OID_KEY } from '../oids.js';
 import { isObject } from '../utils.js';
 import { hasDefault, isNullable } from './fields.js';
-import { StorageFieldSchema, StorageFieldsSchema } from './types.js';
+import {
+	NestedStorageFieldsSchema,
+	StorageFieldSchema,
+	StorageFieldsSchema,
+} from './types.js';
 
 export function validateEntity(
 	schema: StorageFieldsSchema,
 	entity: any,
 ): EntityValidationProblem | void {
 	for (const [key, value] of Object.entries(entity)) {
+		// legacy -- old objects sometimes accidentally include this key
+		if (key === OID_KEY) continue;
 		if (!schema[key]) {
 			return {
 				type: 'invalid-key',
@@ -73,7 +80,11 @@ export function validateEntityField({
 				} for field ${formatField(fieldPath)}, got ${value}`,
 			};
 		}
-		for (const [key, subField] of Object.entries(field.properties)) {
+		for (const [key, subField] of Object.entries(
+			field.properties as NestedStorageFieldsSchema,
+		)) {
+			// legacy -- old objects sometimes accidentally include this key
+			if (key === OID_KEY) continue;
 			if (value[key]) {
 				validateEntityField({
 					field: subField,