electrodb 2.12.0 → 2.12.2

package/README.md

@@ -46,10 +46,10 @@ _Please submit issues/feedback or reach out on Twitter [@tinkertamper](https://t
 - [**Easily Query Across Entities**](https://electrodb.dev/en/core-concepts/single-table-relationships) - Define "collections" to create powerful/idiomatic queries that return multiple entities in a single request.
 - [**Automatic Index Selection**](https://electrodb.dev/en/queries/find/) - Use `.find()` or `.match()` methods to dynamically and efficiently query based on defined sort key structures.
 - [**Simplified Pagination API**](https://electrodb.dev/en/queries/pagination/) - ElectroDB generates url safe cursors for pagination, allows for fine grain automated pagination, and supports async iteration.
-- [**TypeScript Support**](https://electrodb.dev/en/reference/typscript/) - Strong **TypeScript** support for both Entities and Services now in Beta.
+- [**Strong TypeScript Inference**](https://electrodb.dev/en/reference/typescript/) - Strong **TypeScript** support for both Entities and Services now in Beta.
 - [**Query Directly via the Terminal**](https://github.com/tywalch/electrocli#query-taskapp) - Execute queries against your `Entities`, `Services`, `Models` directly from the command line.
 - [**Stand Up Rest Server for Entities**](https://github.com/tywalch/electrocli#query-taskapp) - Stand up a REST Server to interact with your `Entities`, `Services`, `Models` for easier prototyping.
-- [**Use with your existing tables**](https://electrodb.dev/en/core-concepts/use-electrodb-with-existing-table/) - ElectroDB simplifies building DocumentClient parameters, so you can use it with existing tables/data.
+- [**Use with your existing tables**](https://electrodb.dev/en/recipes/use-electrodb-with-existing-table/) - ElectroDB simplifies building DocumentClient parameters, so you can use it with existing tables/data.
 
 ---
 

package/index.d.ts

@@ -3914,51 +3914,53 @@ type PartialDefinedKeys<T> = {
 };
 
 export type ItemAttribute<A extends Attribute> =
-  A["type"] extends OpaquePrimitiveTypeName<infer T>
-    ? T
-    : A["type"] extends CustomAttributeTypeName<infer T>
-    ? T
-    : A["type"] extends infer R
-    ? R extends "string"
-      ? string
-      : R extends "number"
-      ? number
-      : R extends "boolean"
-      ? boolean
-      : R extends ReadonlyArray<infer E>
-      ? E
-      : R extends "map"
-      ? "properties" extends keyof A
-        ? {
-            [P in keyof A["properties"]]: A["properties"][P] extends infer M
-              ? M extends Attribute
-                ? ItemAttribute<M>
-                : never
-              : never;
-          }
-        : never
-      : R extends "list"
-      ? "items" extends keyof A
-        ? A["items"] extends infer I
-          ? I extends Attribute
-            ? Array<ItemAttribute<I>>
+  A["type"] extends infer T
+    ? T extends OpaquePrimitiveTypeName<infer OP>
+      ? OP
+      : T extends CustomAttributeTypeName<infer CA>
+      ? CA
+      : T extends infer R
+      ? R extends "string"
+        ? string
+        : R extends "number"
+        ? number
+        : R extends "boolean"
+        ? boolean
+        : R extends ReadonlyArray<infer E>
+        ? E
+        : R extends "map"
+        ? "properties" extends keyof A
+          ? {
+              [P in keyof A["properties"]]: A["properties"][P] extends infer M
+                ? M extends Attribute
+                  ? ItemAttribute<M>
+                  : never
+                : never;
+            }
+          : never
+        : R extends "list"
+        ? "items" extends keyof A
+          ? A["items"] extends infer I
+            ? I extends Attribute
+              ? Array<ItemAttribute<I>>
+              : never
             : never
           : never
-        : never
-      : R extends "set"
-      ? "items" extends keyof A
-        ? A["items"] extends infer I
-          ? I extends "string"
-            ? string[]
-            : I extends "number"
-            ? number[]
-            : I extends ReadonlyArray<infer ENUM>
-            ? ENUM[]
+        : R extends "set"
+        ? "items" extends keyof A
+          ? A["items"] extends infer I
+            ? I extends "string"
+              ? string[]
+              : I extends "number"
+              ? number[]
+              : I extends ReadonlyArray<infer ENUM>
+              ? ENUM[]
+              : never
             : never
           : never
+        : R extends "any"
+        ? any
         : never
-      : R extends "any"
-      ? any
       : never
     : never;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "electrodb",
-  "version": "2.12.0",
+  "version": "2.12.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

@@ -2211,30 +2211,61 @@ class Entity {
     let { pk, sk } = this._makeIndexKeys({
       index: indexBase,
     });
+
     let keys = this._makeParameterKey(indexBase, pk, ...sk);
+    // trim empty key values (this can occur when keys are defined by users)
+    for (let key in keys) {
+      if (keys[key] === undefined || keys[key] === '') {
+        delete keys[key];
+      }
+    }
+
     let keyExpressions = this._expressionAttributeBuilder(keys);
-    let params = {
-      TableName: this.getTableName(),
-      ExpressionAttributeNames: this._mergeExpressionsAttributes(
+
+    const expressionAttributeNames = this._mergeExpressionsAttributes(
         filter.getNames(),
         keyExpressions.ExpressionAttributeNames,
-      ),
-      ExpressionAttributeValues: this._mergeExpressionsAttributes(
+    );
+
+    const expressionAttributeValues = this._mergeExpressionsAttributes(
         filter.getValues(),
         keyExpressions.ExpressionAttributeValues,
-      ),
-      FilterExpression: `begins_with(#${pkField}, :${pkField})`,
+    );
+
+
+    let params = {
+      TableName: this.getTableName(),
     };
 
+    if (Object.keys(expressionAttributeNames).length) {
+      params['ExpressionAttributeNames'] = expressionAttributeNames;
+    }
+
+    if (Object.keys(expressionAttributeValues).length) {
+      params['ExpressionAttributeValues'] = expressionAttributeValues;
+    }
+
+    let filterExpressions = [];
+
+    if (keys[pkField]) {
+      filterExpressions.push(`begins_with(#${pkField}, :${pkField})`);
+    }
+
     if (hasSortKey) {
       let skField = this.model.indexes[accessPattern].sk.field;
-      params.FilterExpression = `${params.FilterExpression} AND begins_with(#${skField}, :${skField})`;
+      if (keys[skField]) {
+        filterExpressions.push(`begins_with(#${skField}, :${skField})`);
+      }
     }
+
     if (filter.build()) {
-      params.FilterExpression = `${
-        params.FilterExpression
-      } AND ${filter.build()}`;
+      filterExpressions.push(filter.build());
     }
+
+    if (filterExpressions.length) {
+      params.FilterExpression = filterExpressions.join(' AND ');
+    }
+
     return params;
   }
 

package/test.csv

@@ -0,0 +1,117 @@
+
+> electrodb@2.12.1 local:exec
+> LOCAL_DYNAMO_ENDPOINT='http://localhost:8000' ts-node ./test/debug.ts
+
+kind, op, value, region, plan, datetime
+item, value, $test_1#region_central-1#plan_base#datetime_1989-07-01, central-1, Base, 1989-07-01
+item, value, $test_1#region_central-1#plan_base#datetime_2023-12-01, central-1, Base, 2023-12-01
+item, value, $test_1#region_central-1#plan_base#datetime_2024-12-01, central-1, Base, 2024-12-01
+item, value, $test_1#region_central-1#plan_pro#datetime_1989-07-01, central-1, Pro, 1989-07-01
+item, value, $test_1#region_central-1#plan_pro#datetime_2023-12-01, central-1, Pro, 2023-12-01
+item, value, $test_1#region_central-1#plan_pro#datetime_2024-12-01, central-1, Pro, 2024-12-01
+item, value, $test_1#region_central-1#plan_proplus#datetime_1989-07-01, central-1, ProPlus, 1989-07-01
+item, value, $test_1#region_central-1#plan_proplus#datetime_2023-12-01, central-1, ProPlus, 2023-12-01
+item, value, $test_1#region_central-1#plan_proplus#datetime_2024-12-01, central-1, ProPlus, 2024-12-01
+item, value, $test_1#region_central-1#plan_special#datetime_1989-07-01, central-1, Special, 1989-07-01
+item, value, $test_1#region_central-1#plan_special#datetime_2023-12-01, central-1, Special, 2023-12-01
+item, value, $test_1#region_central-1#plan_special#datetime_2024-12-01, central-1, Special, 2024-12-01
+item, value, $test_1#region_east-1#plan_base#datetime_1989-07-01, east-1, Base, 1989-07-01
+item, value, $test_1#region_east-1#plan_base#datetime_2023-12-01, east-1, Base, 2023-12-01
+item, value, $test_1#region_east-1#plan_base#datetime_2024-12-01, east-1, Base, 2024-12-01
+item, value, $test_1#region_east-1#plan_pro#datetime_1989-07-01, east-1, Pro, 1989-07-01
+item, value, $test_1#region_east-1#plan_pro#datetime_2023-12-01, east-1, Pro, 2023-12-01
+item, value, $test_1#region_east-1#plan_pro#datetime_2024-12-01, east-1, Pro, 2024-12-01
+item, value, $test_1#region_east-1#plan_proplus#datetime_1989-07-01, east-1, ProPlus, 1989-07-01
+item, value, $test_1#region_east-1#plan_proplus#datetime_2023-12-01, east-1, ProPlus, 2023-12-01
+item, value, $test_1#region_east-1#plan_proplus#datetime_2024-12-01, east-1, ProPlus, 2024-12-01
+item, value, $test_1#region_east-1#plan_special#datetime_1989-07-01, east-1, Special, 1989-07-01
+item, value, $test_1#region_east-1#plan_special#datetime_2023-12-01, east-1, Special, 2023-12-01
+item, value, $test_1#region_east-1#plan_special#datetime_2024-12-01, east-1, Special, 2024-12-01
+item, value, $test_1#region_east-2#plan_base#datetime_1989-07-01, east-2, Base, 1989-07-01
+item, value, $test_1#region_east-2#plan_base#datetime_2023-12-01, east-2, Base, 2023-12-01
+item, value, $test_1#region_east-2#plan_base#datetime_2024-12-01, east-2, Base, 2024-12-01
+item, value, $test_1#region_east-2#plan_pro#datetime_1989-07-01, east-2, Pro, 1989-07-01
+item, value, $test_1#region_east-2#plan_pro#datetime_2023-12-01, east-2, Pro, 2023-12-01
+item, value, $test_1#region_east-2#plan_pro#datetime_2024-12-01, east-2, Pro, 2024-12-01
+item, value, $test_1#region_east-2#plan_proplus#datetime_1989-07-01, east-2, ProPlus, 1989-07-01
+item, value, $test_1#region_east-2#plan_proplus#datetime_2023-12-01, east-2, ProPlus, 2023-12-01
+item, value, $test_1#region_east-2#plan_proplus#datetime_2024-12-01, east-2, ProPlus, 2024-12-01
+item, value, $test_1#region_east-2#plan_special#datetime_1989-07-01, east-2, Special, 1989-07-01
+item, value, $test_1#region_east-2#plan_special#datetime_2023-12-01, east-2, Special, 2023-12-01
+item, value, $test_1#region_east-2#plan_special#datetime_2024-12-01, east-2, Special, 2024-12-01
+item, value, $test_1#region_west-1#plan_base#datetime_1989-07-01, west-1, Base, 1989-07-01
+item, value, $test_1#region_west-1#plan_base#datetime_2023-12-01, west-1, Base, 2023-12-01
+item, value, $test_1#region_west-1#plan_base#datetime_2024-12-01, west-1, Base, 2024-12-01
+item, value, $test_1#region_west-1#plan_pro#datetime_1989-07-01, west-1, Pro, 1989-07-01
+item, value, $test_1#region_west-1#plan_pro#datetime_2023-12-01, west-1, Pro, 2023-12-01
+item, value, $test_1#region_west-1#plan_pro#datetime_2024-12-01, west-1, Pro, 2024-12-01
+item, value, $test_1#region_west-1#plan_proplus#datetime_1989-07-01, west-1, ProPlus, 1989-07-01
+item, value, $test_1#region_west-1#plan_proplus#datetime_2023-12-01, west-1, ProPlus, 2023-12-01
+item, value, $test_1#region_west-1#plan_proplus#datetime_2024-12-01, west-1, ProPlus, 2024-12-01
+item, value, $test_1#region_west-1#plan_special#datetime_1989-07-01, west-1, Special, 1989-07-01
+item, value, $test_1#region_west-1#plan_special#datetime_2023-12-01, west-1, Special, 2023-12-01
+item, value, $test_1#region_west-1#plan_special#datetime_2024-12-01, west-1, Special, 2024-12-01
+partials, all, $test_1#region_, , , 
+partials, begins, $test_1, , , 
+partials, gt, $test_2, , , 
+partials, gte, $test_1, , , 
+partials, lt, $test_1, , , 
+partials, lte, $test_2, , , 
+partials, between_start, $test_1, , , 
+partials, between_end, $test_2, , , 
+partials, all, $test_1#region_east#plan_, east, , 
+partials, begins, $test_1#region_east, east, , 
+partials, gt, $test_1#region_easu, east, , 
+partials, gte, $test_1#region_east, east, , 
+partials, lt, $test_1#region_east, east, , 
+partials, lte, $test_1#region_easu, east, , 
+partials, between_start, $test_1#region_east, east, , 
+partials, between_end, $test_1#region_easu, east, , 
+partials, all, $test_1#region_east#plan_pro#datetime_, east, Pro, 
+partials, begins, $test_1#region_east#plan_pro, east, Pro, 
+partials, gt, $test_1#region_east#plan_prp, east, Pro, 
+partials, gte, $test_1#region_east#plan_pro, east, Pro, 
+partials, lt, $test_1#region_east#plan_pro, east, Pro, 
+partials, lte, $test_1#region_east#plan_prp, east, Pro, 
+partials, between_start, $test_1#region_east#plan_pro, east, Pro, 
+partials, between_end, $test_1#region_east#plan_prp, east, Pro, 
+partials, all, $test_1#region_east#plan_pro#datetime_2023-12-00, east, Pro, 2023-12-00
+partials, begins, $test_1#region_east#plan_pro#datetime_2023-12-00, east, Pro, 2023-12-00
+partials, gt, $test_1#region_east#plan_pro#datetime_2023-12-01, east, Pro, 2023-12-00
+partials, gte, $test_1#region_east#plan_pro#datetime_2023-12-00, east, Pro, 2023-12-00
+partials, lt, $test_1#region_east#plan_pro#datetime_2023-12-00, east, Pro, 2023-12-00
+partials, lte, $test_1#region_east#plan_pro#datetime_2023-12-01, east, Pro, 2023-12-00
+partials, between_start, $test_1#region_east#plan_pro#datetime_2023-12-00, east, Pro, 2023-12-00
+partials, between_end, $test_1#region_east#plan_pro#datetime_2023-12-01, east, Pro, 2023-12-00
+complete, all, $test_1#region_, , , 
+complete, begins, $test_1, , , 
+complete, gt, $test_2, , , 
+complete, gte, $test_1, , , 
+complete, lt, $test_1, , , 
+complete, lte, $test_2, , , 
+complete, between_start, $test_1, , , 
+complete, between_end, $test_2, , , 
+complete, all, $test_1#region_east-1#plan_, east-1, , 
+complete, begins, $test_1#region_east-1, east-1, , 
+complete, gt, $test_1#region_east-2, east-1, , 
+complete, gte, $test_1#region_east-1, east-1, , 
+complete, lt, $test_1#region_east-1, east-1, , 
+complete, lte, $test_1#region_east-2, east-1, , 
+complete, between_start, $test_1#region_east-1, east-1, , 
+complete, between_end, $test_1#region_east-2, east-1, , 
+complete, all, $test_1#region_east-1#plan_proplus#datetime_, east-1, ProPlus, 
+complete, begins, $test_1#region_east-1#plan_proplus, east-1, ProPlus, 
+complete, gt, $test_1#region_east-1#plan_proplut, east-1, ProPlus, 
+complete, gte, $test_1#region_east-1#plan_proplus, east-1, ProPlus, 
+complete, lt, $test_1#region_east-1#plan_proplus, east-1, ProPlus, 
+complete, lte, $test_1#region_east-1#plan_proplut, east-1, ProPlus, 
+complete, between_start, $test_1#region_east-1#plan_proplus, east-1, ProPlus, 
+complete, between_end, $test_1#region_east-1#plan_proplut, east-1, ProPlus, 
+complete, all, $test_1#region_east-1#plan_proplus#datetime_2023-12-01, east-1, ProPlus, 2023-12-01
+complete, begins, $test_1#region_east-1#plan_proplus#datetime_2023-12-01, east-1, ProPlus, 2023-12-01
+complete, gt, $test_1#region_east-1#plan_proplus#datetime_2023-12-02, east-1, ProPlus, 2023-12-01
+complete, gte, $test_1#region_east-1#plan_proplus#datetime_2023-12-01, east-1, ProPlus, 2023-12-01
+complete, lt, $test_1#region_east-1#plan_proplus#datetime_2023-12-01, east-1, ProPlus, 2023-12-01
+complete, lte, $test_1#region_east-1#plan_proplus#datetime_2023-12-02, east-1, ProPlus, 2023-12-01
+complete, between_start, $test_1#region_east-1#plan_proplus#datetime_2023-12-01, east-1, ProPlus, 2023-12-01
+complete, between_end, $test_1#region_east-1#plan_proplus#datetime_2023-12-02, east-1, ProPlus, 2023-12-01