electrodb 2.7.1 → 2.8.0

package/index.d.ts

@@ -1780,6 +1780,8 @@ export interface IndexWithSortKey {
 
 export type AccessPatternCollection<C extends string> = C | ReadonlyArray<C>;
 
+export type KeyCastOption = 'string' | 'number'
+
 export interface Schema<A extends string, F extends string, C extends string> {
     readonly model: {
         readonly entity: string;
@@ -1800,12 +1802,14 @@ export interface Schema<A extends string, F extends string, C extends string> {
                 readonly field: string;
                 readonly composite: ReadonlyArray<F>;
                 readonly template?: string;
+                readonly cast?: KeyCastOption;
             }
             readonly sk?: {
                 readonly casing?: "upper" | "lower" | "none" | "default";
                 readonly field: string;
                 readonly composite: ReadonlyArray<F>;
                 readonly template?: string;
+                readonly cast?: KeyCastOption;
             }
         }
     }

package/package.json

@@ -1,19 +1,24 @@
 {
   "name": "electrodb",
-  "version": "2.7.1",
+  "version": "2.8.0",
   "description": "A library to more easily create and interact with multiple entities and heretical relationships in dynamodb",
   "main": "index.js",
   "scripts": {
-    "test": "npm run test:types && npm run test:init && npm run test:unit",
-    "test:init": "LOCAL_DYNAMO_ENDPOINT=http://localhost:8000 node ./test/init.js",
-    "test:unit": "LOCAL_DYNAMO_ENDPOINT=http://localhost:8000 mocha -r ts-node/register ./test/**.spec.*",
+    "test:run": "npm run test:types && npm run test:init && npm run test:unit",
+    "test:init": "node ./test/init.js",
+    "test:unit": "mocha -r ts-node/register ./test/**.spec.*",
     "test:types": "tsd",
     "coverage": "npm run test:init && nyc npm run test:unit && nyc report --reporter=text-lcov | coveralls",
     "coverage:local:coveralls": "npm run test:init && nyc npm run test:unit && nyc report --reporter=text-lcov | coveralls",
     "coverage:local:html": "npm run test:init && nyc npm run test:unit && nyc report --reporter=html",
     "build:browser": "browserify playground/browser.js -o playground/bundle.js",
     "build": "sh buildbrowser.sh",
-    "start:containers": "docker compose up -d"
+    "test": "./test.sh",
+    "test:ci": "npm install && npm test",
+    "ddb:start": "docker compose up -d",
+    "ddb:load": "docker compose exec electro npm run test:init",
+    "ddb:stop": "docker compose stop",
+    "example:taskapp": "npm run ddb:start && npm run ddb:load && ts-node ./examples/taskmanager/src/index.ts; npm run ddb:stop"
   },
   "repository": {
     "type": "git",

package/src/entity.js

@@ -26,6 +26,7 @@ const {
 	PartialComparisons,
 	MethodTypeTranslation,
 	TransactionCommitSymbol,
+	CastKeyOptions,
 } = require("./types");
 const { FilterFactory } = require("./filters");
 const { FilterOperations } = require("./operations");
@@ -1279,7 +1280,7 @@ class Entity {
 			}
 			indexParts = { ...indexParts, ...tableIndexParts };
 		}
-		let noPartsFound = Object.keys(indexParts).length === 0;
+		let noPartsFound = Object.keys(indexParts).length === 0 && this.model.facets.byIndex[tableIndex].all.length > 0;
 		let partsAreIncomplete = this.model.facets.byIndex[tableIndex].all.find(facet => indexParts[facet.name] === undefined);
 		if (noPartsFound || partsAreIncomplete) {
 			// In this case no suitable record could be found be the deconstructed pager.
@@ -2592,7 +2593,8 @@ class Entity {
 		version = "1",
 		tableIndex,
 		modelVersion,
-		isClustered
+		isClustered,
+		schema
 	}) {
 		/*
 			Collections will prefix the sort key so they can be queried with
@@ -2608,12 +2610,14 @@ class Entity {
 				field: tableIndex.pk.field,
 				casing: tableIndex.pk.casing,
 				isCustom: tableIndex.customFacets.pk,
+				cast: tableIndex.pk.cast,
 			},
 			sk: {
 				prefix: "",
 				casing: tableIndex.sk.casing,
 				isCustom: tableIndex.customFacets.sk,
 				field: tableIndex.sk ? tableIndex.sk.field : undefined,
+				cast: tableIndex.sk ? tableIndex.sk.cast : undefined,
 			}
 		};
 
@@ -2652,7 +2656,7 @@ class Entity {
 			}
 		}
 
-		// If keys arent custom, set the prefixes
+		// If keys are not custom, set the prefixes
 		if (!keys.pk.isCustom) {
 			keys.pk.prefix = u.formatKeyCasing(pk, tableIndex.pk.casing);
 		}
@@ -2662,6 +2666,40 @@ class Entity {
 			keys.sk.postfix = u.formatKeyCasing(postfix, tableIndex.sk.casing);
 		}
 
+		const castKeys = tableIndex.hasSk 
+			? [tableIndex.pk, tableIndex.sk]
+			: [tableIndex.pk];
+	
+		for (const castKey of castKeys) {
+			if (castKey.cast === CastKeyOptions.string) {
+				keys[castKey.type].cast = CastKeyOptions.string;
+			} else if (
+				// custom keys with only one facet and no labels are numeric by default
+				castKey.cast === undefined &&
+				castKey.isCustom &&
+				castKey.facets.length === 1 &&
+				castKey.facetLabels.every(({label}) => !label) &&
+				schema.attributes[castKey.facets[0]] &&
+				schema.attributes[castKey.facets[0]].type === 'number'
+			) {
+				keys[castKey.type].cast = CastKeyOptions.number;
+			} else if (
+				castKey.cast === CastKeyOptions.number &&
+				castKey.facets.length === 1 &&
+				schema.attributes[castKey.facets[0]] &&
+				['number', 'string', 'boolean'].includes(schema.attributes[castKey.facets[0]].type)
+			) {
+				keys[castKey.type].cast = CastKeyOptions.number;
+			} else if (
+				castKey.cast === CastKeyOptions.number &&
+				castKey.facets.length > 1
+			) {
+				throw new e.ElectroError(e.ErrorCodes.InvalidModel, `Invalid "cast" option provided for ${castKey.type} definition on index "${u.formatIndexNameForDisplay(tableIndex.index)}". Keys can only be cast to 'number' if they are a composite of one numeric attribute.`);
+			} else {
+				keys[castKey.type].cast = CastKeyOptions.string;
+			}
+		}
+
 		return keys;
 	}
 
@@ -2743,7 +2781,12 @@ class Entity {
 			throw new Error(`Invalid index: ${index}`);
 		}
 		// let partitionKey = this._makeKey(prefixes.pk, facets.pk, pkFacets, this.model.facets.labels[index].pk, { excludeLabelTail: true });
-		let partitionKey = this._makeKey(prefixes.pk, facets.pk, pkFacets, this.model.facets.labels[index].pk);
+		let partitionKey = this._makeKey(
+			prefixes.pk, 
+			facets.pk, 
+			pkFacets, 
+			this.model.facets.labels[index].pk,
+		);
 		let pk = partitionKey.key;
 		let sk = [];
 		let fulfilled = false;
@@ -2822,21 +2865,45 @@ class Entity {
 		};
 	}
 
-	_isNumericKey(isCustom, facets = [], labels = []) {
-		let attribute = this.model.schema.attributes[facets[0]];
-		let isSingleComposite = facets.length === 1;
-		let hasNoLabels = isCustom && labels.every(({label}) => !label);
-		let facetIsNonStringPrimitive = attribute && attribute.type === "number";
-		return isCustom && isSingleComposite && hasNoLabels && facetIsNonStringPrimitive
+	_formatNumericCastKey(attributeName, key) {
+		const fulfilled = key !== undefined;
+		if (!fulfilled) {
+			return {
+				fulfilled,
+				key,
+			}
+		}
+		if (typeof key === 'number') {
+			return {
+				fulfilled,
+				key,
+			}
+		}
+		if (typeof key === 'string') {
+			const parsed = parseInt(key);
+			if (!isNaN(parsed)) {
+				return {
+					fulfilled,
+					key: parsed,
+				}
+			}
+		}
+
+		if (typeof key === 'boolean') {
+			return {
+				fulfilled,
+				key: key === true ? 1 : 0,
+			}
+		}
+
+		throw new e.ElectroAttributeValidationError(attributeName, `Invalid key value provided, could not cast composite attribute ${attributeName} to number for index`);
 	}
 
+
 	/* istanbul ignore next */
-	_makeKey({prefix, isCustom, casing, postfix} = {}, facets = [], supplied = {}, labels = [], {excludeLabelTail, excludePostfix, transform = (val) => val} = {}) {
-		if (this._isNumericKey(isCustom, facets, labels)) {
-			return {
-				fulfilled: supplied[facets[0]] !== undefined,
-				key: supplied[facets[0]],
-			};
+	_makeKey({prefix, isCustom, casing, postfix, cast} = {}, facets = [], supplied = {}, labels = [], {excludeLabelTail, excludePostfix, transform = (val) => val} = {}) {
+		if (cast === CastKeyOptions.number) {
+			return this._formatNumericCastKey(facets[0], supplied[facets[0]]);
 		}
 
 		let key = prefix;
@@ -3153,7 +3220,6 @@ class Entity {
 		};
 		let seenIndexes = {};
 		let seenIndexFields = {};
-
 		let accessPatterns = Object.keys(indexes);
 
 		for (let i in accessPatterns) {
@@ -3202,6 +3268,7 @@ class Entity {
 				index: indexName,
 				casing: pkCasing,
 				type: KeyTypes.pk,
+				cast: index.pk.cast, 
 				field: index.pk.field || "",
 				facets: parsedPKAttributes.attributes,
 				isCustom: parsedPKAttributes.isCustom,
@@ -3219,6 +3286,7 @@ class Entity {
 					index: indexName,
 					casing: skCasing,
 					type: KeyTypes.sk,
+					cast: index.sk.cast, 
 					field: index.sk.field || "",
 					facets: parsedSKAttributes.attributes,
 					isCustom: parsedSKAttributes.isCustom,
@@ -3410,7 +3478,7 @@ class Entity {
 		return normalized;
 	}
 
-	_normalizeKeyFixings({service, entity, version, indexes, modelVersion, clusteredIndexes}) {
+	_normalizeKeyFixings({service, entity, version, indexes, modelVersion, clusteredIndexes, schema}) {
 		let prefixes = {};
 		for (let accessPattern of Object.keys(indexes)) {
 			let tableIndex = indexes[accessPattern];
@@ -3421,6 +3489,7 @@ class Entity {
 				tableIndex,
 				modelVersion,
 				isClustered: clusteredIndexes.has(accessPattern),
+				schema,
 			});
 		}
 		return prefixes;
@@ -3569,17 +3638,17 @@ class Entity {
 		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});
+		let prefixes = this._normalizeKeyFixings({service, entity, version, indexes, modelVersion, clusteredIndexes, schema});
 
 		// apply model defined labels
 		let schemaDefinedLabels = schema.getLabels();
+		const deconstructors = {};
 		facets.labels = this._mergeKeyDefinitions(facets.labels, schemaDefinedLabels);
 		for (let indexName of Object.keys(facets.labels)) {
-			indexes[indexAccessPattern.fromIndexToAccessPattern[indexName]].pk.labels = facets.labels[indexName].pk;
-			indexes[indexAccessPattern.fromIndexToAccessPattern[indexName]].sk.labels = facets.labels[indexName].sk;
-		}
-		const deconstructors = {};
-		for (const indexName of Object.keys(facets.labels)) {
+			const accessPattern = indexAccessPattern.fromIndexToAccessPattern[indexName];
+			indexes[accessPattern].pk.labels = facets.labels[indexName].pk;
+			indexes[accessPattern].sk.labels = facets.labels[indexName].sk;
+			
 			const keyTypes = prefixes[indexName] || {};
 			deconstructors[indexName] = {};
 			for (const keyType in keyTypes) {

package/src/errors.js

@@ -148,7 +148,7 @@ const ErrorCodes = {
   InconsistentIndexDefinition: {
     code: 1022,
     section: "inconsistent-index-definition",
-    name: "InvalidClientProvided",
+    name: "Inconsistent Index Definition",
     sym: ErrorCode,
   },
   MissingAttribute: {

package/src/schema.js

@@ -542,8 +542,9 @@ class MapAttribute extends Attribute {
 		const getter = get || ((val) => {
 			const isEmpty = !val || Object.keys(val).length === 0;
 			const isNotRequired = !this.required;
+			const doesNotHaveDefault = this.default === undefined;
 			const isRoot = this.isRoot;
-			if (isEmpty && isRoot && !isNotRequired) {
+			if (isEmpty && isRoot && isNotRequired && doesNotHaveDefault) {
 				return undefined;
 			}
 			return val;
@@ -582,11 +583,16 @@ class MapAttribute extends Attribute {
 		const setter = set || ((val) => {
 			const isEmpty = !val || Object.keys(val).length === 0;
 			const isNotRequired = !this.required;
+			const doesNotHaveDefault = this.default === undefined;
+			const defaultIsValue = this.default === val;
 			const isRoot = this.isRoot;
-			if (isEmpty && isRoot && !isNotRequired) {
+			if (defaultIsValue) {
+				return val;
+			} else if (isEmpty && isRoot && isNotRequired && doesNotHaveDefault) {
 				return undefined;
+			} else {
+				return val;
 			}
-			return val;
 		});
 
 		return (values, siblings) => {
@@ -1113,7 +1119,7 @@ class Schema {
 				prefix,
 				postfix,
 				traverser,
-				isKeyField,
+				isKeyField: isKeyField || isKey,
 				isRoot: !!isRoot,
 				label: attribute.label,
 				required: !!attribute.required,

package/src/types.js

@@ -312,6 +312,11 @@ const DynamoDBAttributeTypes = Object.entries({
 	return obj;
 }, {});
 
+const CastKeyOptions = {
+	string: 'string',
+	number: 'number',
+}
+
 module.exports = {
 	Pager,
 	KeyTypes,
@@ -331,6 +336,7 @@ module.exports = {
 	ItemOperations,
 	AttributeTypes,
 	EntityVersions,
+	CastKeyOptions,
 	ServiceVersions,
 	ExpressionTypes,
 	ElectroInstance,

package/src/validations.js

@@ -113,6 +113,11 @@ const Index = {
 					type: "string",
 					enum: ["upper", "lower", "none", "default"],
 					required: false,
+				},
+				cast: {
+					type: "string",
+					enum: ["string", "number"],
+					required: false,
 				}
 			},
 		},
@@ -146,6 +151,11 @@ const Index = {
 					type: "string",
 					enum: ["upper", "lower", "none", "default"],
 					required: false,
+				},
+				cast: {
+					type: "string",
+					enum: ["string", "number"],
+					required: false,
 				}
 			},
 		},

package/output

@@ -1,168 +0,0 @@
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",
-"target": "top",
-"target": "byOrganization",
-"target": "byCategory",