electrodb 1.12.1 → 2.0.0

package/src/service.js

@@ -243,13 +243,8 @@ class Service {
 
 	cleanseRetrievedData(collection = "", entities, data = {}, config = {}) {
 		if (config.raw) {
-			if (config._isPagination) {
-				return [data.LastEvaluatedKey, data];
-			} else {
-				return data;
-			}
+			return data;
 		}
-
 		data.Items = data.Items || [];
 		let index = this.collectionSchema[collection].index;
 		let results = {};
@@ -268,18 +263,15 @@ class Service {
 			if (!entityAlias) {
 				continue;
 			}
-
 			// pager=false because we don't want the entity trying to parse the lastEvaluatedKey
-			let items = this.collectionSchema[collection].entities[entityAlias].formatResponse({Item: record}, index, {...config, pager: false});
-			results[entityAlias].push(items);
-		}
-
-		if (config._isPagination) {
-			let page = this._formatReturnPager(config, index, data.LastEvaluatedKey, data.Items[data.Items.length - 1]);
-			return [page, results];
-		} else {
-			return results;
+			let items = this.collectionSchema[collection].entities[entityAlias].formatResponse({Item: record}, index, {
+				...config,
+				pager: false,
+				parse: undefined
+			});
+			results[entityAlias].push(items.data);
 		}
+		return results;
 	}
 
 	findKeyOwner(lastEvaluatedKey) {
@@ -287,92 +279,25 @@ class Service {
 			.find((entity) => entity.ownsLastEvaluatedKey(lastEvaluatedKey));
 	}
 
-	findItemPagerOwner(collection, pager = {}) {
-		if (this.collectionSchema[collection] === undefined) {
-			throw new Error("Invalid collection");
-		}
-		let matchingEntities = [];
-		if (pager === null) {
-			return matchingEntities;
-		}
-		for (let entity of Object.values(this.collectionSchema[collection].entities)) {
-			if (entity.ownsPager(pager, this.collectionSchema[collection].index)) {
-				matchingEntities.push(entity);
-			}
-		}
-		return matchingEntities;
-	}
-
-	findNamedPagerOwner(pager = {}) {
-		let identifiers = this._getEntityIdentifiers(this.entities);
-		for (let identifier of identifiers) {
-			let hasCorrectFieldProperties = typeof pager[identifier.nameField] === "string" && typeof pager[identifier.versionField] === "string";
-			let hasMatchingFieldValues = pager[identifier.nameField] === identifier.name && pager[identifier.versionField] === identifier.version;
-			if (hasCorrectFieldProperties && hasMatchingFieldValues) {
-				return identifier.entity;
-			}
-		}
-	}
-
-	expectPagerOwner(type, collection, pager) {
-		if (type === Pager.raw) {
-			return Object.values(this.collectionSchema[collection].entities)[0];
-		} else if (type === Pager.named || type === undefined) {
-			let owner = this.findNamedPagerOwner(pager);
-			if (owner === undefined) {
-				throw new e.ElectroError(e.ErrorCodes.NoOwnerForPager, "Supplied Pager does not resolve to Entity within Service");
-			}
-			return owner;
-		} else if (type === Pager.item) {
-			let owners = this.findItemPagerOwner(collection, pager);
-			if (owners.length === 1) {
-				return owners[0];
-			} else {
-				throw new e.ElectroError(e.ErrorCodes.PagerNotUnique, "Supplied Pager did not resolve to single Entity");
-			}
-		} else {
-			throw new e.ElectroError(e.ErrorCodes.InvalidOptions, `Invalid value for option "pager" provider: "${pager}". Allowed values include ${u.commaSeparatedString(Object.keys(Pager))}.`)
+	expectKeyOwner(lastEvaluatedKey) {
+		const owner = this.findKeyOwner(lastEvaluatedKey);
+		if (owner === undefined) {
+			throw new e.ElectroError(e.ErrorCodes.NoOwnerForCursor, `Supplied cursor does not resolve to Entity within the Service ${this.service.name}`);
 		}
+		return owner;
 	}
 
-	findPagerIdentifiers(collection, pager = {}) {
-		if (this.collectionSchema[collection] === undefined) {
-			throw new Error("Invalid collection");
-		}
-		let matchingIdentifiers = [];
-		if (pager === null) {
-			return matchingIdentifiers;
-		}
-		for (let entity of Object.values(this.collectionSchema[collection].entities)) {
-			if (entity.ownsPager(pager, this.collectionSchema[collection].index)) {
-				matchingIdentifiers.push({
-					[entity.identifiers.entity]: entity.getName(),
-					[entity.identifiers.version]: entity.getVersion(),
-				});
-			}
-		}
-		return matchingIdentifiers;
+	findCursorOwner(cursor) {
+		return Object.values(this.entities)
+			.find(entity => entity.ownsCursor(cursor));
 	}
 
-	_formatReturnPager(config, index, lastEvaluatedKey, lastReturned) {
-		if (config.pager === "raw") {
-			return lastEvaluatedKey;
-		} else if (!lastEvaluatedKey) {
-			return null;
-		} else {
-			let entity = this.findKeyOwner(lastEvaluatedKey);
-			if (!entity) {
-				return lastReturned !== undefined
-					? this._formatReturnPager(config, index, lastReturned)
-					: null
-			}
-			let page = entity._formatKeysToItem(index, lastEvaluatedKey);
-			if (config.pager === "named") {
-				page[entity.identifiers.entity] = entity.getName();
-				page[entity.identifiers.version] = entity.getVersion();
-			}
-			return page;
+	expectCursorOwner(cursor) {
+		const owner = this.findCursorOwner(cursor);
+		if (owner === undefined) {
+			throw new e.ElectroError(e.ErrorCodes.NoOwnerForCursor, `Supplied cursor does not resolve to Entity within the Service ${this.service.name}`);
 		}
+		return owner;
 	}
 
 	_getTableName() {
@@ -389,21 +314,7 @@ class Service {
 	_makeCollectionChain(name = "", attributes = {}, initialClauses = {}, expressions = {}, entities = {}, entity = {}, facets = {}) {
 		let filterBuilder = new FilterFactory(attributes, FilterOperations);
 		let whereBuilder = new WhereFactory(attributes, FilterOperations);
-
-		let pageClause = {...initialClauses.page};
-		let pageAction = initialClauses.page.action;
-		pageClause.action = (entity, state, page = null, options = {}) => {
-			try {
-				if (page === null) {
-					return pageAction(entity, state, page, options);
-				}
-				let owner = this.expectPagerOwner(options.pager, name, page);
-				return pageAction(owner, state, page, options);
-			} catch(err) {
-				return Promise.reject(err);
-			}
-		}
-		let clauses = {...initialClauses, page: pageClause};
+		let clauses = {...initialClauses};
 
 		clauses = filterBuilder.injectFilterClauses(clauses);
 		clauses = whereBuilder.injectWhereClauses(clauses);
@@ -412,6 +323,14 @@ class Service {
 			// expressions, // DynamoDB doesnt return what I expect it would when provided with these entity filters
 			parse: (options, data) => {
 				return this.cleanseRetrievedData(name, entities, data, options);
+			},
+			formatCursor: {
+				serialize: (key) => {
+					return this.expectKeyOwner(key).serializeCursor(key);
+				},
+				deserialize: (cursor) => {
+					return this.expectCursorOwner(cursor).deserilizeCursor(cursor);
+				}
 			}
 		};
 

package/src/types.js

@@ -110,7 +110,8 @@ const AttributeMutationMethods = {
 const Pager = {
 	raw: "raw",
 	named: "named",
-	item: "item"
+	item: "item",
+	cursor: "cursor"
 }
 
 const UnprocessedTypes = {
@@ -194,6 +195,15 @@ const TerminalOperation = {
 	page: 'page',
 }
 
+const AllPages = 'all';
+
+const ResultOrderOption = {
+	'asc': true,
+	'desc': false
+};
+
+const ResultOrderParam = 'ScanIndexForward';
+
 module.exports = {
 	Pager,
 	KeyTypes,
@@ -223,5 +233,8 @@ module.exports = {
 	AttributeProxySymbol,
 	ElectroInstanceTypes,
 	EventSubscriptionTypes,
-	AttributeMutationMethods
+	AttributeMutationMethods,
+	AllPages,
+	ResultOrderOption,
+	ResultOrderParam,
 };

package/src/util.js

@@ -161,6 +161,29 @@ function getUnique(arr1, arr2) {
   ]));
 }
 
+const cursorFormatter = {
+  serialize: (key) => {
+    if (!key) {
+      return null;
+    } else if (typeof val !== 'string') {
+      key = JSON.stringify(key);
+    }
+    return Buffer.from(key).toString('base64url');
+  },
+  deserialize: (cursor) => {
+    if (!cursor) {
+      return undefined;
+    } else if (typeof cursor !== 'string') {
+      throw new Error(`Invalid cursor provided, expected type 'string' recieved: ${JSON.stringify(cursor)}`);
+    }
+    try {
+      return JSON.parse(Buffer.from(cursor, 'base64url').toString('utf8'));
+    } catch(err) {
+      throw new Error('Unable to parse cursor');
+    }
+  }
+}
+
 module.exports = {
   getUnique,
   batchItems,
@@ -171,6 +194,7 @@ module.exports = {
   genericizeJSONPath,
   commaSeparatedString,
   formatAttributeCasing,
+  cursorFormatter,
   applyBetaModelOverrides,
   formatIndexNameForDisplay,
   BatchGetOrderMaintainer,

package/src/where.js

@@ -120,7 +120,7 @@ class WhereFactory {
 			injected[name] = {
 				name,
 				action: this.buildClause(filter),
-				children: ["params", "go", "page", "where", ...modelFilters],
+				children: ["params", "go", "where", ...modelFilters],
 			};
 		}
 		filterChildren.push("where");
@@ -129,7 +129,7 @@ class WhereFactory {
 			action: (entity, state, fn) => {
 				return this.buildClause(fn)(entity, state);
 			},
-			children: ["params", "go", "page", "where", ...modelFilters],
+			children: ["params", "go", "where", ...modelFilters],
 		};
 		for (let parent of filterParents) {
 			injected[parent] = { ...injected[parent] };

package/notes

@@ -1,45 +0,0 @@
-/*
-
-todo: better param typing
-done: get typing
-todo: get implementation
-done: get[] typing
-todo: get[] implementation
-done: delete typing
-todo: delete implementation
-done: delete[] typing
-todo: delete[] implementation
-done: put[] typing
-todo: put[] implementation
-done: put typing
-todo: put implementation
-todo: update typing
-done: update implementation
-    done: SetRecord
-    done: RemoveRecord
-    done: DataUpdateMethodRecord
-
-done: scan typing
-todo: scan implementation
-done: query typing
-todo: query implementation
-done: find typing
-todo: find implementation
-done: match typing
-todo: match implementation
-done: parse typing
-todo: parse implementation (requires cursor?)
-todo: collection query
-todo: collection impl
-
-todo: add where to go?
-todo: rethink option names
-
-todo: add cursor to query options
-todo: remove old doc notes on `join` and slim down `service`
-
-
-
-find and test any add on set and number
-try number enum?
-integration test enum set ts

package/output

@@ -1,106 +0,0 @@
-page {
-    "data": [
-        {
-            "prop2": "e3b142b1-e5d7-4b17-8a66-38fcdf6ef1ef",
-            "prop1": "value1",
-            "prop4": "value4"
-        },
-        {
-            "prop2": "e8ed19db-3ac4-45d6-8fb8-281ada117e96",
-            "prop1": "value1",
-            "prop4": "value4"
-        },
-        {
-            "prop2": "dcca03f5-7478-4afb-9297-20a68ff56559",
-            "prop1": "value1",
-            "prop4": "value4"
-        },
-        {
-            "prop2": "03ccd79e-c5e5-4179-8213-196eafcbd4b9",
-            "prop1": "value1",
-            "prop4": "value4"
-        },
-        {
-            "prop2": "2900735e-aaa4-4661-a52d-7aecb752e694",
-            "prop1": "value1",
-            "prop4": "value4"
-        },
-        {
-            "prop2": "0f1da461-5257-4f6c-8cb3-af7b56819100",
-            "prop1": "value1",
-            "prop4": "value4"
-        },
-        {
-            "prop2": "7562c43b-8ac9-483c-b950-4f0e1366c11a",
-            "prop1": "value1",
-            "prop4": "value4"
-        },
-        {
-            "prop2": "ee844e97-dc1c-4242-bd2b-45685e39d7fd",
-            "prop1": "value1",
-            "prop4": "value4"
-        },
-        {
-            "prop2": "4b55e242-9875-412e-b483-24e51dabf6c8",
-            "prop1": "value1",
-            "prop4": "value4"
-        },
-        {
-            "prop2": "77a5b66e-c658-4ec6-9630-4d2469653bd4",
-            "prop1": "value1",
-            "prop4": "value4"
-        },
-        {
-            "prop2": "194efbfe-7be6-4662-9982-a1c8eb6ab36d",
-            "prop1": "value1",
-            "prop4": "value4"
-        },
-        {
-            "prop2": "value2",
-            "prop1": "value1",
-            "prop4": "value4"
-        },
-        {
-            "prop2": "516d8256-3b3e-41e1-a44a-0720fe748e23",
-            "prop1": "value1",
-            "prop4": "value4"
-        },
-        {
-            "prop2": "35bf3a7e-9dff-4817-a157-2be09c5fc8a8",
-            "prop1": "value1",
-            "prop4": "value4"
-        },
-        {
-            "prop2": "3836452b-6c00-415e-85ce-a9596644b6eb",
-            "prop1": "value1",
-            "prop4": "value4"
-        },
-        {
-            "prop2": "value2abc",
-            "prop1": "value1",
-            "prop4": "value4"
-        },
-        {
-            "prop2": "887e5301-113c-4ca6-b6d0-ebaf27e217d5",
-            "prop1": "value1",
-            "prop4": "value4"
-        },
-        {
-            "prop2": "6c6d9363-3821-40c8-b3d0-7ec2c6d3f1eb",
-            "prop1": "value1",
-            "prop4": "value4"
-        },
-        {
-            "prop2": "fcff14a3-ffa9-498e-a0ae-596c747b027b",
-            "prop1": "value1",
-            "prop4": "value4"
-        },
-        {
-            "prop2": "1d199eeb-ccc1-4c25-a1b6-1685126d44b3",
-            "prop1": "value1",
-            "prop4": "value4"
-        }
-    ],
-    "count": 2,
-    "next": null
-}