electrodb 2.2.0 → 2.2.2

package/README.md

@@ -132,6 +132,9 @@ tasks
       - [CreatedAt and UpdatedAt Attributes](#createdat-and-updatedat-attributes)
       - [Attribute Validation](#attribute-validation)
   * [Indexes](#indexes)
+    + [Index Types](#index-types)
+      - [Isolated Indexes](#isolated-indexes)
+      - [Clustered Indexes](#clustered-indexes)
     + [Indexes Without Sort Keys](#indexes-without-sort-keys)
     + [Indexes With Sort Keys](#indexes-with-sort-keys)
     + [Numeric Keys](#numeric-keys)
@@ -287,7 +290,8 @@ tasks
 - [Electro CLI](#electro-cli)
 - [Version 2 Migration](#version-2-migration)
   * [New response format for all query methods.](#new-response-format-for-all-query-methods)
-  * [Unified Pagination APIs](#unified-pagination-apis)
+  * [Unified pagination APIs](#unified-pagination-apis)
+  * [Pagination with a string cursor](#pagination-with-a-string-cursor)
 - [Version 1 Migration](#version-1-migration)
   * [New schema format/breaking key format change](#new-schema-format-breaking-key-format-change)
   * [The renaming of index property Facets to Composite and Template](#the-renaming-of-index-property-facets-to-composite-and-template)

package/index.d.ts

@@ -723,7 +723,7 @@ export interface BatchWriteOperationOptions<A extends string, F extends string,
 }
 
 export interface SetRecordActionOptions<A extends string, F extends string, C extends string, S extends Schema<A,F,C>, SetAttr,IndexCompositeAttributes,TableItem> {
-    go: UpdateRecordGo<Partial<TableItem>, UpdateQueryOptions>;
+    go: UpdateRecordGo<TableItem>;
     params: ParamRecord<UpdateQueryParams>;
     set: SetRecord<A,F,C,S, SetItem<A,F,C,S>,IndexCompositeAttributes,TableItem>;
     remove: SetRecord<A,F,C,S, Array<keyof SetItem<A,F,C,S>>,IndexCompositeAttributes,TableItem>;
@@ -987,7 +987,16 @@ export type ServiceQueryRecordsGo<ResponseType, Options = QueryOptions> = <T = R
 
 export type QueryRecordsGo<ResponseType, Options = QueryOptions> = <T = ResponseType>(options?: Options) => Promise<{ data: T, cursor: string | null }>;
 
-export type UpdateRecordGo<ResponseType, Options = QueryOptions> = <T = ResponseType>(options?: Options) => Promise<{ data: T }>;
+export type UpdateRecordGo<ResponseType> = <T = ResponseType, Options extends UpdateQueryOptions = UpdateQueryOptions>(options?: Options) => 
+        Options extends infer O
+            ? 'response' extends keyof O
+                ? O['response'] extends 'all_new'
+                    ? Promise<{data: T}>
+                    : O['response'] extends 'all_old'
+                        ? Promise<{data: T}>
+                        : Promise<{data: Partial<T>}>
+                : Promise<{data: Partial<T>}>
+            : never;
 
 export type PutRecordGo<ResponseType, Options = QueryOptions> = <T = ResponseType>(options?: Options) => Promise<{ data: T }>;
 
@@ -996,11 +1005,6 @@ export type DeleteRecordOperationGo<ResponseType, Options = QueryOptions> = <T =
 export type BatchWriteGo<ResponseType> = <O extends BulkOptions>(options?: O) =>
     Promise<{ unprocessed: ResponseType }>
 
-// export type PageRecord<ResponseType, CompositeAttributes> = (page?: (CompositeAttributes & OptionalDefaultEntityIdentifiers) | null, options?: PaginationOptions) => Promise<[
-//         (CompositeAttributes & OptionalDefaultEntityIdentifiers) | null,
-//     ResponseType
-// ]>;
-
 export type ParamRecord<Options = ParamOptions> = <P>(options?: Options) => P;
 
 export class ElectroError extends Error {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "electrodb",
-  "version": "2.2.0",
+  "version": "2.2.2",
   "description": "A library to more easily create and interact with multiple entities and heretical relationships in dynamodb",
   "main": "index.js",
   "scripts": {

package/src/entity.js

@@ -3037,7 +3037,7 @@ class Entity {
 			indexAccessPattern,
 			indexHasSubCollections,
 		} = this._normalizeIndexes(model.indexes);
-		let schema = new Schema(model.attributes, facets, {client});
+		let schema = new Schema(model.attributes, facets, {client, isRoot: true});
 		let filters = this._normalizeFilters(model.filters);
 		// todo: consider a rename
 		let prefixes = this._normalizeKeyFixings({service, entity, version, indexes, modelVersion, clusteredIndexes});

package/src/schema.js

@@ -524,15 +524,22 @@ class MapAttribute extends Attribute {
 			traverser: this.traverser
 		});
 		this.properties = properties;
+		this.isRoot = !!definition.isRoot;
 		this.get = this._makeGet(definition.get, properties);
 		this.set = this._makeSet(definition.set, properties);
 	}
 
 	_makeGet(get, properties) {
 		this._checkGetSet(get, "get");
-
-		const getter = get || ((attr) => attr);
-
+		const getter = get || ((val) => {
+			const isEmpty = !val || Object.keys(val).length === 0;
+			const isNotRequired = !this.required;
+			const isRoot = this.isRoot;
+			if (isEmpty && isRoot && !isNotRequired) {
+				return undefined;
+			}
+			return val;
+		});
 		return (values, siblings) => {
 			const data = {};
 
@@ -541,6 +548,9 @@ class MapAttribute extends Attribute {
 			}
 
 			if (values === undefined) {
+				if (!get) {
+					return undefined;
+				}
 				return getter(data, siblings);
 			}
 
@@ -561,11 +571,23 @@ class MapAttribute extends Attribute {
 
 	_makeSet(set, properties) {
 		this._checkGetSet(set, "set");
-		const setter = set || ((attr) => attr);
+		const setter = set || ((val) => {
+			const isEmpty = !val || Object.keys(val).length === 0;
+			const isNotRequired = !this.required;
+			const isRoot = this.isRoot;
+			if (isEmpty && isRoot && !isNotRequired) {
+				return undefined;
+			}
+			return val;
+		});
+
 		return (values, siblings) => {
 			const data = {};
 			if (values === undefined) {
-				return setter(data, siblings);
+				if (!set) {
+					return undefined;
+				}
+				return setter(values, siblings);
 			}
 			for (const name of Object.keys(properties.attributes)) {
 				const attribute = properties.attributes[name];
@@ -624,18 +646,18 @@ class MapAttribute extends Attribute {
 	}
 
 	val(value) {
-		const getValue = (v) => {
-			v = this.cast(v);
-			if (v === undefined) {
-				v = this.default();
+		const incomingIsEmpty = value === undefined;
+		let fromDefault = false;
+		let data;
+		if (value === undefined) {
+			data = this.default();
+			if (data !== undefined) {
+				fromDefault = true;
 			}
-			return v;
+		} else {
+			data = value;
 		}
 
-		let data = value === undefined
-			? getValue(value)
-			: value;
-
 		const valueType = getValueType(data);
 
 		if (data === undefined) {
@@ -654,6 +676,10 @@ class MapAttribute extends Attribute {
 			}
 		}
 
+		if (Object.keys(response).length === 0 && !fromDefault && this.isRoot && !this.required && incomingIsEmpty) {
+			return undefined;
+		}
+
 		return response;
 	}
 }
@@ -959,9 +985,9 @@ class SetAttribute extends Attribute {
 }
 
 class Schema {
-	constructor(properties = {}, facets = {}, {traverser = new AttributeTraverser(), client, parent} = {}) {
+	constructor(properties = {}, facets = {}, {traverser = new AttributeTraverser(), client, parent, isRoot} = {}) {
 		this._validateProperties(properties, parent);
-		let schema = Schema.normalizeAttributes(properties, facets, {traverser, client, parent});
+		let schema = Schema.normalizeAttributes(properties, facets, {traverser, client, parent, isRoot});
 		this.client = client;
 		this.attributes = schema.attributes;
 		this.enums = schema.enums;
@@ -972,9 +998,10 @@ class Schema {
 		this.requiredAttributes = schema.requiredAttributes;
 		this.translationForWatching = this._formatWatchTranslations(this.attributes);
 		this.traverser = traverser;
+		this.isRoot = !!isRoot;
 	}
 
-	static normalizeAttributes(attributes = {}, facets = {}, {traverser, client, parent} = {}) {
+	static normalizeAttributes(attributes = {}, facets = {}, {traverser, client, parent, isRoot} = {}) {
 		const attributeHasParent = !!parent;
 		let invalidProperties = [];
 		let normalized = {};
@@ -1073,6 +1100,7 @@ class Schema {
 				postfix,
 				traverser,
 				isKeyField,
+				isRoot: !!isRoot,
 				label: attribute.label,
 				required: !!attribute.required,
 				default: attribute.default,