electrodb 2.10.1 → 2.10.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "electrodb",
-  "version": "2.10.1",
+  "version": "2.10.3",
   "description": "A library to more easily create and interact with multiple entities and heretical relationships in dynamodb",
   "main": "index.js",
   "scripts": {
@@ -8,7 +8,7 @@
     "build:browser": "browserify playground/browser.js -o playground/bundle.js",
     "test": "./test.sh",
     "test:ci": "npm install && npm test",
-    "test:run": "npm run test:format && npm run test:types && npm run test:init && npm run test:unit",
+    "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",
@@ -16,15 +16,16 @@
     "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",
-    "ddb:start": "docker compose up -d",
+    "ddb:start": "docker compose up -d dynamodb",
     "ddb:load": "docker compose exec electro npm run test:init",
     "ddb:stop": "docker compose stop",
     "examples:load:library": "npm run ddb:start && npm run local:init && ts-node ./examples/library/load.ts",
     "examples:query:library": "npm run ddb:start && npm run local:init && ts-node ./examples/library/query.ts",
-    "examples:load:taskmanager": "npm run ddb:start && npm run local:init && ts-node ./examples/taskmanager/load.ts",
-    "examples:query:taskmanager": "npm run ddb:start && npm run local:init && ts-node ./examples/taskmanager/query.ts",
-    "examples:load:versioncontrol": "npm run ddb:start && npm run local:init && ts-node ./examples/versioncontrol/load.ts",
-    "examples:query:versioncontrol": "npm run ddb:start && npm run local:init && ts-node ./examples/versioncontrol/query.ts",
+    "examples:load:taskmanager": "npm run ddb:start && npm run local:init && ts-node ./examples/taskManager/load.ts",
+    "examples:query:taskmanager": "npm run ddb:start && npm run local:init && ts-node ./examples/taskManager/query.ts",
+    "examples:load:versioncontrol": "npm run ddb:start && npm run local:init && ts-node ./examples/versionControl/load.ts",
+    "examples:query:versioncontrol": "npm run ddb:start && npm run local:init && ts-node ./examples/versionControl/query.ts",
+    "examples:provisiontable": "npm run ddb:start && npm run local:init && ts-node ./examples/provisionTable",
     "examples:locks": "npm run ddb:start && npm run local:init && ts-node ./examples/locks",
     "local:init": "LOCAL_DYNAMO_ENDPOINT='http://localhost:8000' npm run test:init",
     "local:start": "npm run ddb:start && npm run local:init",
@@ -64,10 +65,12 @@
     "prettier": "^3.0.3",
     "prettier-plugin-astro": "^0.12.0",
     "source-map-support": "^0.5.19",
+    "sst": "^2.28.0",
     "ts-node": "^10.9.1",
     "tsd": "^0.28.1",
     "typescript": "^5.2.2",
-    "uuid": "7.0.1"
+    "uuid": "7.0.1",
+    "aws-cdk-lib": "^2.100.0"
   },
   "keywords": [
     "electrodb",

package/src/clauses.js

@@ -973,12 +973,21 @@ let clauses = {
           sk,
           pk,
         );
+
+        const accessPattern =
+          entity.model.translations.indexes.fromIndexToAccessPattern[
+            state.query.index
+          ];
+
+        if (!entity.model.indexes[accessPattern].sk.isFieldRef) {
+          state.filterProperties(FilterOperationNames.lte, endingSk.composites);
+        }
+
         return state
           .setType(QueryTypes.and)
           .setSK(endingSk.composites)
           .setType(QueryTypes.between)
-          .setSK(startingSk.composites)
-          .filterProperties(FilterOperationNames.lte, endingSk.composites);
+          .setSK(startingSk.composites);
       } catch (err) {
         state.setError(err);
         return state;
@@ -1019,9 +1028,14 @@ let clauses = {
             pk,
           );
           state.setSK(composites);
-          state.filterProperties(FilterOperationNames.gt, {
-            ...composites,
-          });
+          const accessPattern =
+            entity.model.translations.indexes.fromIndexToAccessPattern[
+              state.query.index
+            ];
+
+          if (!entity.model.indexes[accessPattern].sk.isFieldRef) {
+            state.filterProperties(FilterOperationNames.gt, composites);
+          }
         });
       } catch (err) {
         state.setError(err);
@@ -1086,9 +1100,13 @@ let clauses = {
             pk,
           );
           state.setSK(composites);
-          state.filterProperties(FilterOperationNames.lte, {
-            ...composites,
-          });
+          const accessPattern =
+            entity.model.translations.indexes.fromIndexToAccessPattern[
+              state.query.index
+            ];
+          if (!entity.model.indexes[accessPattern].sk.isFieldRef) {
+            state.filterProperties(FilterOperationNames.lte, composites);
+          }
         });
       } catch (err) {
         state.setError(err);

package/src/entity.js

@@ -184,36 +184,6 @@ class Entity {
     return this.model.version;
   }
 
-  // ownsItem(item) {
-  // 	return (
-  // 		item &&
-  // 		this.getName() === item[this.identifiers.entity] &&
-  // 		this.getVersion() === item[this.identifiers.version] &&
-  // 		validations.isStringHasLength(item[this.identifiers.entity]) &&
-  // 		validations.isStringHasLength(item[this.identifiers.version])
-  // 	) || !!this.ownsKeys(item)
-  // }
-
-  // ownsKeys({keys = {}}) {
-  // 	let {pk, sk} = this.model.prefixes[TableIndex];
-  // 	let hasSK = this.model.lookup.indexHasSortKeys[TableIndex];
-  // 	let pkMatch = typeof keys[pk.field] === "string" && keys[pk.field].startsWith(pk.prefix);
-  // 	let skMatch = pkMatch && !hasSK;
-  // 	if (pkMatch && hasSK) {
-  // 		skMatch = typeof keys[sk.field] === "string" && keys[sk.field].startsWith(sk.prefix);
-  // 	}
-  //
-  // 	return (pkMatch && skMatch &&
-  // 		this._formatKeysToItem(TableIndex, key) !== null);
-  // }
-
-  // ownsCursor({ cursor }) {
-  // 	if (typeof cursor === 'string') {
-  // 		cursor = u.cursorFormatter.deserialize(cursor);
-  // 	}
-  // 	return this.ownsKeys({ keys: cursor });
-  // }
-
   ownsItem(item) {
     return (
       item &&
@@ -246,13 +216,18 @@ class Entity {
   ownsKeys(key = {}) {
     let { pk, sk } = this.model.prefixes[TableIndex];
     let hasSK = this.model.lookup.indexHasSortKeys[TableIndex];
-    let pkMatch =
-      typeof key[pk.field] === "string" && key[pk.field].startsWith(pk.prefix);
+    const typeofPkProvided = typeof key[pk.field];
+    const pkPrefixMatch =
+      typeofPkProvided === "string" && key[pk.field].startsWith(pk.prefix);
+    const isNumericPk = typeofPkProvided === "number" && pk.cast === "number";
+    let pkMatch = pkPrefixMatch || isNumericPk;
     let skMatch = pkMatch && !hasSK;
     if (pkMatch && hasSK) {
-      skMatch =
-        typeof key[sk.field] === "string" &&
-        key[sk.field].startsWith(sk.prefix);
+      const typeofSkProvided = typeof key[sk.field];
+      const skPrefixMatch =
+        typeofSkProvided === "string" && key[sk.field].startsWith(sk.prefix);
+      const isNumericSk = typeofSkProvided === "number" && sk.cast === "number";
+      skMatch = skPrefixMatch || isNumericSk;
     }
 
     return (
@@ -1481,7 +1456,7 @@ class Entity {
   }
 
   _createKeyDeconstructor(prefixes = {}, labels = [], attributes = {}) {
-    let { prefix, isCustom, postfix } = prefixes;
+    let { prefix, isCustom, postfix, cast } = prefixes;
     let names = [];
     let types = [];
     let pattern = `^${this._regexpEscape(prefix || "")}`;
@@ -1512,16 +1487,19 @@ class Entity {
     let regex = new RegExp(pattern, "i");
 
     return ({ key } = {}) => {
-      if (!["string", "number"].includes(typeof key)) {
+      const typeofKey = typeof key;
+      if (!["string", "number"].includes(typeofKey)) {
         return null;
       }
       key = `${key}`;
+      const isNumeric =
+        cast === CastKeyOptions.number && typeofKey === "number";
       let match = key.match(regex);
       let results = {};
-      if (match) {
+      if (match || isNumeric) {
         for (let i = 0; i < names.length; i++) {
-          let key = names[i];
-          let value = match[i + 1];
+          let keyName = names[i];
+          let value = isNumeric ? key : match[i + 1];
           let type = types[i];
           switch (type) {
             case "number": {
@@ -1533,8 +1511,8 @@ class Entity {
               break;
             }
           }
-          if (key && value !== undefined) {
-            results[key] = value;
+          if (keyName && value !== undefined) {
+            results[keyName] = value;
           }
         }
       } else {
@@ -1565,7 +1543,7 @@ class Entity {
     let skComposites = {};
     if (indexHasSortKey) {
       const sk = keys[skName];
-      if (!sk) {
+      if (sk === undefined) {
         return null;
       }
       skComposites = deconstructors.sk({ key: sk });
@@ -2724,8 +2702,9 @@ class Entity {
 
     if (
       this.model.lookup.indexHasSortKeys[index] &&
-      typeof keyExpressions.ExpressionAttributeValues[":sk1"] === "string" &&
-      keyExpressions.ExpressionAttributeValues[":sk1"].length > 0
+      (typeof keyExpressions.ExpressionAttributeValues[":sk1"] === "number" ||
+        (typeof keyExpressions.ExpressionAttributeValues[":sk1"] === "string" &&
+          keyExpressions.ExpressionAttributeValues[":sk1"].length > 0))
     ) {
       if (type === QueryTypes.is) {
         KeyConditionExpression = `${KeyConditionExpression} and #sk1 = :sk1`;
@@ -2834,17 +2813,18 @@ class Entity {
     filter = {},
     indexKeys = {},
   ) {
-    const { pk, fulfilled } = indexKeys;
+    const { pk } = indexKeys;
     const sk = indexKeys.sk[0];
-    let operator = PartialComparisons[comparison];
-    // fulfilled
-    // ? Comparisons[comparison]
-    // : PartialComparisons[comparison];
+
+    let operator =
+      typeof sk === "number"
+        ? Comparisons[comparison]
+        : PartialComparisons[comparison];
 
     if (!operator) {
       throw new Error(
         `Unexpected comparison operator "${comparison}", expected ${u.commaSeparatedString(
-          Object.values(Comparisons),
+          Object.values(PartialComparisons),
         )}`,
       );
     }
@@ -2853,6 +2833,7 @@ class Entity {
       pk,
       sk,
     );
+
     let params = {
       TableName: this.getTableName(),
       ExpressionAttributeNames: this._mergeExpressionsAttributes(
@@ -4409,6 +4390,7 @@ class Entity {
       getClient: () => this.client,
       isRoot: true,
     });
+
     let filters = this._normalizeFilters(model.filters);
     // todo: consider a rename
     let prefixes = this._normalizeKeyFixings({
@@ -4445,6 +4427,12 @@ class Entity {
           labels,
           attributes,
         );
+        for (let attributeName in schema.attributes) {
+          const { field } = schema.attributes[attributeName];
+          if (indexes[accessPattern][keyType].field === field) {
+            indexes[accessPattern][keyType].isFieldRef = true;
+          }
+        }
       }
     }
 

package/tsconfig.json

@@ -7,6 +7,7 @@
     "target": "ESNext" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */,
     "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */,
     "lib": ["ESNext"],                                   /* Specify library files to be included in the compilation. */
+    "resolveJsonModule": true,
     // "allowJs": true,                             /* Allow javascript files to be compiled. */
     // "checkJs": true,                             /* Report errors in .js files. */
     // "jsx": "preserve",                           /* Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'. */