electrodb 1.8.0 → 1.8.3

package/CHANGELOG.md

@@ -166,4 +166,16 @@ All notable changes to this project will be documented in this file. Breaking ch
 - Expected typings for the injected v2 client now include methods for `transactWrite` and `transactGet`
 ### Changed
 - Map attributes will now always resolve to least an empty object on a `create` and `put` methods (instead of just the root map)
-- In the past, default values for property attributes on maps only resolves when a user provided an object to place the values on. Now default values within maps attributes will now always resolve onto the object on `create` and `put` methods.
+- In the past, default values for property attributes on maps only resolves when a user provided an object to place the values on. Now default values within maps attributes will now always resolve onto the object on `create` and `put` methods.
+
+## [1.8.1] - 2022-03-29
+### Fixed
+- Solidifying default application methodology: default values for nested properties will be applied up until an undefined default occurs or default callback returns undefined
+
+## [1.8.2] - 2022-05-13
+### Fixed
+- Issue impacting the successful propagation loggers and listeners from a Service definition to Entity children
+
+## [1.8.3] - 2022-05-14
+### Changed
+- Removing validation that requires at least one attribute to be provided in a PK composite. This opens the door to static PKs if the user so chooses

package/README.md

@@ -459,7 +459,7 @@ const EmployeesModel = {
 	attributes: {
 		employee: {
 			type: "string",
-			default: () => uuidv4(),
+			default: () => uuid(),
 		},
 		firstName: {
 			type: "string",
@@ -686,9 +686,9 @@ attributes: {
 Property      | Type                                                       | Required | Types     | Description
  ------------ | :--------------------------------------------------------: | :------: | :-------: | -----------
 `type`        | `string`, `ReadonlyArray<string>`, `string[]`              | yes      | all       | Accepts the values: `"string"`, `"number"` `"boolean"`, `"map"`, `"list"`, `"set"`, an array of strings representing a finite list of acceptable values: `["option1", "option2", "option3"]`, or `"any"` which disables value type checking on that attribute.
-`required`    | `boolean`                                                  | no       | all       | Flag an attribute as required to be present when creating a record. This attribute also acts as a type of `NOT NULL` flag, preventing it from being removed directly.  
+`required`    | `boolean`                                                  | no       | all       | Flag an attribute as required to be present when creating a record. This attribute also acts as a type of `NOT NULL` flag, preventing it from being removed directly. When applied to nested properties, be mindful that default map values can cause required child attributes to fail validation.
 `hidden`      | `boolean`                                                  | no       | all       | Flag an attribute as hidden to remove the property from results before they are returned. 
-`default`     | `value`, `() => value`                                     | no       | all       | Either the default value itself or a synchronous function that returns the desired value. Applied before `set` and before `required` check. 
+`default`     | `value`, `() => value`                                     | no       | all       | Either the default value itself or a synchronous function that returns the desired value. Applied before `set` and before `required` check. In the case of nested attributes, default values will apply defaults to children attributes until an undefined value is reached
 `validate`    | `RegExp`, `(value: any) => void`, `(value: any) => string` | no       | all       | Either regex or a synchronous callback to return an error string (will result in exception using the string as the error's message), or thrown exception in the event of an error.   
 `field`       | `string`                                                   | no       | all       | The name of the attribute as it exists in DynamoDB, if named differently in the schema attributes. Defaults to the `AttributeName` as defined in the schema.
 `readOnly`    | `boolean`                                                  | no       | all       | Prevents an attribute from being updated after the record has been created. Attributes used in the composition of the table's primary Partition Key and Sort Key are read-only by default. The one exception to `readOnly` is for properties that also use the `watch` property, read [attribute watching](#attribute-watching) for more detail. 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "electrodb",
-  "version": "1.8.0",
+  "version": "1.8.3",
   "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

@@ -899,6 +899,18 @@ class Entity {
 		return {parameters, config};
 	}
 
+	addListeners(logger) {
+		this.eventManager.add(logger);
+	}
+
+	_addLogger(logger) {
+		if (validations.isFunction(logger)) {
+			this.addListeners(logger);
+		} else {
+			throw new e.ElectroError(e.ErrorCodes.InvalidLoggerProvided, `Logger must be of type function`);
+		}
+	}
+
 	_getPrimaryIndexFieldNames() {
 		let hasSortKey = this.model.lookup.indexHasSortKeys[TableIndex];
 		let accessPattern = this.model.translations.indexes.fromIndexToAccessPattern[TableIndex];

package/src/schema.js

@@ -583,7 +583,7 @@ class MapAttribute extends Attribute {
 		const valueType = getValueType(data);
 
 		if (data === undefined) {
-			data = {};
+			return data;
 		} else if (valueType !== "object") {
 			throw new e.ElectroAttributeValidationError(this.path, `Invalid value type at entity path: "${this.path}". Expected value to be an object to fulfill attribute type "${this.type}"`);
 		}

package/src/service.js

@@ -191,6 +191,14 @@ class Service {
 			entity._setClient(options.client);
 		}
 
+		if (options.logger) {
+			entity._addLogger(options.logger);
+		}
+
+		if (options.listeners) {
+			entity.addListeners(options.listeners);
+		}
+
 		if (this._modelVersion === ModelVersions.beta && this.service.version) {
 			entity.model.version = this.service.version;
 		}

package/src/validations.js

@@ -81,7 +81,6 @@ const Index = {
 				},
 				facets: {
 					type: ["array", "string"],
-					minItems: 1,
 					items: {
 						type: "string",
 					},
@@ -89,7 +88,6 @@ const Index = {
 				},
 				composite: {
 					type: ["array"],
-					minItems: 1,
 					items: {
 						type: "string",
 					},