diff --git a/CHANGELOG.md b/CHANGELOG.md
index 6ada0314..19a7a4e5 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -536,4 +536,14 @@ All notable changes to this project will be documented in this file. Breaking ch
## [2.15.0] - 2024-09-19
### Updated
- Updated `@aws-sdk/lib-dynamodb` dependency from pinned version `3.395.0` to latest release `^3.654.0`. This impacts users using the v3 aws-sdk.
-- Adds dependency `@aws-sdk/util-dynamodb` for unmarshalling functionality.
\ No newline at end of file
+- Adds dependency `@aws-sdk/util-dynamodb` for unmarshalling functionality.
+
+## [3.0.0]
+### Changed
+- ElectroDB is changing how it generates query parameters to give more control to users. Prior to `v3`, query operations that used the `gt`, `lte`, or `between` methods would incur additional post-processing, including additional filter expressions and some sort key hacks. The post-processing was an attempt to bridge an interface gap between attribute-level considerations and key-level considerations. Checkout the GitHub issue championed by @rcoundon and @PaulJNewell77 [here](https://github.com/tywalch/electrodb/issues/228) to learn more. With `v3`, ElectroDB will not apply post-processing to queries of any type and abstains from adding implicit/erroneous filter expressions to queries _by default_. This change should provide additional control to users to achieve more advanced queries, but also introduces some additional complexity. There are many factors related to sorting and using comparison queries that are not intuitive, and the simplest way to mitigate this is by using additional [filter expressions](https://electrodb.dev/en/queries/filters/) to ensure the items returned will match expectations. To ease migration and adoption, I have added a new execution option called `compare`; To recreate `v2` functionality without further changes, use the execution option `{ compare: "v2" }`. This value is marked as deprecated and will be removed at a later date, but should allow users to safely upgrade to `v3` and experiment with the impact of this change on their existing data. The new `compare` option has other values that will continue to see support, however; to learn more about this new option, checkout [Comparison Queries](https://electrodb.dev/en/queries/query#comparison-queries).
+- The `validate` callback on attributes now expects a strict return type of `boolean`. Additionally, the semantic meaning of a boolean response has _flipped_. The callback should return `true` for "valid" values and `false` for "invalid" values. If your validation function throws an error, ElectroDB will still behave as it previously did in `v2`, by catching and wrapping the error.
+- Providing the execution option `limit` on queries now _only_ applies a `Limit` parameter to its request to DynamoDB. Previously, the `limit` option would cause ElectroDB to effectively "seek" DynamoDB until the limit was _at least_ reached. The execution option `count` can be used in similar cases where `limit` was used, but performance may vary depending on your data and use case.
+### Removed
+- The execution options `includeKeys` and `raw` were deprecated in version `2.0.0` and have now been removed in favor of the execution option `data`. To migrate from `v2`, use the options `{ data: "includeKeys" }` and `{ data: "raw" }` respectively.
+### Fixed
+- Response typing and formatting logic for `delete`
diff --git a/README.md b/README.md
index aae6b1b6..67834e32 100644
--- a/README.md
+++ b/README.md
@@ -16,15 +16,19 @@
_Please submit issues/feedback or reach out on Twitter [@tinkertamper](https://twitter.com/tinkertamper)._
+ElectroDB v3 now released
+
+Visit the v3 migration page to learn more about this new update.
+
---
-New: Documentation now found at ElectroDB.dev
+Documentation now found at ElectroDB.dev
-ElectroDB's new website for Documentation is now live at www.ElectroDB.dev.
+ElectroDB's new website for Documentation is now live at electrodb.dev.
---
-Introducing: The NEW ElectroDB Playground
+The NEW ElectroDB Playground
diff --git a/index.d.ts b/index.d.ts
index 392624ae..95007a41 100644
--- a/index.d.ts
+++ b/index.d.ts
@@ -2536,12 +2536,9 @@ export interface QueryOptions {
listeners?: Array;
logger?: ElectroEventListener;
data?: "raw" | "includeKeys" | "attributes";
-
- /** @depricated use 'data=raw' instead */
- raw?: boolean;
- /** @depricated use 'data=includeKeys' instead */
- includeKeys?: boolean;
order?: "asc" | "desc";
+
+ consistent?: boolean;
}
// subset of QueryOptions
@@ -2581,7 +2578,7 @@ export interface PutQueryOptions extends QueryOptions {
response?: "default" | "none" | "all_old" | "all_new";
}
-export interface ParamOptions {
+export type ParamOptions = {
cursor?: string | null;
params?: object;
table?: string;
@@ -2594,7 +2591,8 @@ export interface ParamOptions {
| "all_new"
| "updated_new";
order?: "asc" | "desc";
-}
+ consistent?: boolean;
+} & QueryExecutionComparisonParts;
export interface BulkOptions extends QueryOptions {
unprocessed?: "raw" | "item";
@@ -2609,11 +2607,6 @@ export type OptionalDefaultEntityIdentifiers = {
interface GoBatchGetTerminalOptions {
data?: "raw" | "includeKeys" | "attributes";
- /** @depricated use 'data=raw' instead */
- raw?: boolean;
- /** @depricated use 'data=raw' instead */
- includeKeys?: boolean;
-
table?: string;
limit?: number;
params?: object;
@@ -2626,15 +2619,23 @@ interface GoBatchGetTerminalOptions {
preserveBatchOrder?: boolean;
listeners?: Array;
logger?: ElectroEventListener;
+ consistent?: boolean;
}
-interface ServiceQueryGoTerminalOptions {
+export type ExecutionOptionCompare = "keys" | "attributes" | "v2";
+
+export type QueryExecutionComparisonParts = {
+ compare?: "keys" | "attributes"
+} | {
+ /**
+ * @deprecated 'v2' exists to ease user migration to ElectroDB v3. Support for this option will eventually be dropped.
+ */
+ compare?: "v2"
+}
+
+type ServiceQueryGoTerminalOptions = {
cursor?: string | null;
data?: "raw" | "includeKeys" | "attributes";
- /** @depricated use 'data=raw' instead */
- raw?: boolean;
- /** @depricated use 'data=raw' instead */
- includeKeys?: boolean;
table?: string;
limit?: number;
params?: object;
@@ -2645,15 +2646,12 @@ interface ServiceQueryGoTerminalOptions {
logger?: ElectroEventListener;
order?: "asc" | "desc";
hydrate?: boolean;
-}
+ consistent?: boolean;
+} & QueryExecutionComparisonParts;
-interface GoQueryTerminalOptions {
+type GoQueryTerminalOptions = {
cursor?: string | null;
data?: "raw" | "includeKeys" | "attributes";
- /** @depricated use 'data=raw' instead */
- raw?: boolean;
- /** @depricated use 'data=raw' instead */
- includeKeys?: boolean;
table?: string;
limit?: number;
count?: number;
@@ -2666,7 +2664,8 @@ interface GoQueryTerminalOptions {
logger?: ElectroEventListener;
order?: "asc" | "desc";
hydrate?: boolean;
-}
+ consistent?: boolean;
+} & QueryExecutionComparisonParts;
interface TransactWriteQueryOptions {
data?: "raw" | "includeKeys" | "attributes";
@@ -2688,13 +2687,15 @@ interface TransactGetQueryOptions {
attributes?: ReadonlyArray;
listeners?: Array;
logger?: ElectroEventListener;
+ consistent?: boolean;
}
-export interface ParamTerminalOptions {
+export type ParamTerminalOptions = {
table?: string;
limit?: number;
params?: object;
originalErr?: boolean;
+ consistent?: boolean;
attributes?: ReadonlyArray;
response?:
| "default"
@@ -2704,7 +2705,7 @@ export interface ParamTerminalOptions {
| "all_new"
| "updated_new";
order?: "asc" | "desc";
-}
+} & QueryExecutionComparisonParts;
type GoBatchGetTerminal<
A extends string,
@@ -2915,11 +2916,11 @@ export type DeleteRecordOperationGo = <
? O["response"] extends "all_old"
? Promise<{ data: T | null }>
: O["response"] extends "default"
- ? Promise<{ data: Keys | null }>
- : O["response"] extends "none"
- ? Promise<{ data: null }>
- : Promise<{ data: Keys | null }>
- : Promise<{ data: Keys | null }>
+ ? Promise<{ data: Keys }>
+ : O["response"] extends "none"
+ ? Promise<{ data: null }>
+ : Promise<{ data: Keys | null }>
+ : Promise<{ data: Keys }>
: never;
export type BatchWriteGo = (
@@ -3000,10 +3001,7 @@ export interface NestedBooleanAttribute {
readonly get?: (val: boolean, item: any) => boolean | undefined | void;
readonly set?: (val?: boolean, item?: any) => boolean | undefined | void;
readonly default?: boolean | (() => boolean);
- readonly validate?:
- | ((val: boolean) => boolean)
- | ((val: boolean) => void)
- | ((val: boolean) => string | void);
+ readonly validate?: ((val: boolean) => boolean)
readonly field?: string;
}
@@ -3015,10 +3013,7 @@ export interface BooleanAttribute {
readonly get?: (val: boolean, item: any) => boolean | undefined | void;
readonly set?: (val?: boolean, item?: any) => boolean | undefined | void;
readonly default?: boolean | (() => boolean);
- readonly validate?:
- | ((val: boolean) => boolean)
- | ((val: boolean) => void)
- | ((val: boolean) => string | void);
+ readonly validate?: ((val: boolean) => boolean)
readonly field?: string;
readonly label?: string;
readonly watch?: ReadonlyArray | "*";
@@ -3036,10 +3031,7 @@ export interface NestedNumberAttribute {
readonly get?: (val: number, item: any) => number | undefined | void;
readonly set?: (val?: number, item?: any) => number | undefined | void;
readonly default?: number | (() => number);
- readonly validate?:
- | ((val: number) => boolean)
- | ((val: number) => void)
- | ((val: number) => string | void);
+ readonly validate?: ((val: number) => boolean)
readonly field?: string;
}
@@ -3051,10 +3043,7 @@ export interface NumberAttribute {
readonly get?: (val: number, item: any) => number | undefined | void;
readonly set?: (val?: number, item?: any) => number | undefined | void;
readonly default?: number | (() => number);
- readonly validate?:
- | ((val: number) => boolean)
- | ((val: number) => void)
- | ((val: number) => string | void);
+ readonly validate?: ((val: number) => boolean)
readonly field?: string;
readonly label?: string;
readonly watch?: ReadonlyArray | "*";
@@ -3074,8 +3063,6 @@ export interface NestedStringAttribute {
readonly default?: string | (() => string);
readonly validate?:
| ((val: string) => boolean)
- | ((val: string) => void)
- | ((val: string) => string | void)
| RegExp;
readonly field?: string;
}
@@ -3090,8 +3077,6 @@ export interface StringAttribute {
readonly default?: string | (() => string);
readonly validate?:
| ((val: string) => boolean)
- | ((val: string) => void)
- | ((val: string) => string | void)
| RegExp;
readonly field?: string;
readonly label?: string;
@@ -3110,10 +3095,7 @@ export interface NestedEnumAttribute {
readonly get?: (val: any, item: any) => any | undefined | void;
readonly set?: (val?: any, item?: any) => any | undefined | void;
readonly default?: string | (() => string);
- readonly validate?:
- | ((val: any) => boolean)
- | ((val: any) => void)
- | ((val: any) => string | void);
+ readonly validate?: ((val: any) => boolean)
readonly field?: string;
readonly label?: string;
}
@@ -3126,10 +3108,7 @@ export interface EnumAttribute {
readonly get?: (val: any, item: any) => any | undefined | void;
readonly set?: (val?: any, item?: any) => any | undefined | void;
readonly default?: string | (() => string);
- readonly validate?:
- | ((val: any) => boolean)
- | ((val: any) => void)
- | ((val: any) => string | void);
+ readonly validate?: ((val: any) => boolean)
readonly field?: string;
readonly label?: string;
readonly watch?: ReadonlyArray | "*";
@@ -3143,10 +3122,7 @@ export interface NestedAnyAttribute {
readonly get?: (val: any, item: any) => any | undefined | void;
readonly set?: (val?: any, item?: any) => any | undefined | void;
readonly default?: any | (() => any);
- readonly validate?:
- | ((val: any) => boolean)
- | ((val: any) => void)
- | ((val: any) => string | void);
+ readonly validate?: ((val: any) => boolean)
readonly field?: string;
}
@@ -3158,10 +3134,7 @@ export interface AnyAttribute {
readonly get?: (val: any, item: any) => any | undefined | void;
readonly set?: (val?: any, item?: any) => any | undefined | void;
readonly default?: any | (() => any);
- readonly validate?:
- | ((val: any) => boolean)
- | ((val: any) => void)
- | ((val: any) => string | void);
+ readonly validate?: ((val: any) => boolean)
readonly field?: string;
readonly label?: string;
readonly watch?: ReadonlyArray | "*";
@@ -3184,10 +3157,7 @@ export interface NestedMapAttribute {
item?: any,
) => Record | undefined | void;
readonly default?: Record | (() => Record);
- readonly validate?:
- | ((val: Record) => boolean)
- | ((val: Record) => void)
- | ((val: Record) => string | void);
+ readonly validate?: ((val: Record) => boolean)
readonly field?: string;
}
@@ -3208,10 +3178,7 @@ export interface MapAttribute {
item?: any,
) => Record | undefined | void;
readonly default?: Record | (() => Record);
- readonly validate?:
- | ((val: Record) => boolean)
- | ((val: Record) => void)
- | ((val: Record) => string | void);
+ readonly validate?: ((val: Record) => boolean)
readonly field?: string;
readonly watch?: ReadonlyArray | "*";
}
@@ -3231,10 +3198,7 @@ export interface NestedCustomListAttribute {
item?: any,
) => Array | undefined | void;
readonly default?: Array | (() => Array);
- readonly validate?:
- | ((val: Array) => boolean)
- | ((val: Array) => void)
- | ((val: Array) => string | void);
+ readonly validate?: ((val: Array) => boolean)
}
export interface NestedStringListAttribute {
@@ -3249,8 +3213,6 @@ export interface NestedStringListAttribute {
readonly default?: string | (() => string);
readonly validate?:
| ((val: string) => boolean)
- | ((val: string) => void)
- | ((val: string) => string | void)
| RegExp;
readonly field?: string;
};
@@ -3266,10 +3228,7 @@ export interface NestedStringListAttribute {
item?: any,
) => Array | undefined | void;
readonly default?: Array | (() => Array);
- readonly validate?:
- | ((val: Array) => boolean)
- | ((val: Array) => void)
- | ((val: Array) => string | void);
+ readonly validate?: ((val: Array) => boolean)
}
export interface StringListAttribute {
@@ -3284,8 +3243,6 @@ export interface StringListAttribute {
readonly default?: string | (() => string);
readonly validate?:
| ((val: string) => boolean)
- | ((val: string) => void)
- | ((val: string) => string | void)
| RegExp;
readonly field?: string;
};
@@ -3301,10 +3258,7 @@ export interface StringListAttribute {
item?: any,
) => Array | undefined | void;
readonly default?: Array | (() => Array);
- readonly validate?:
- | ((val: Array) => boolean)
- | ((val: Array) => void)
- | ((val: Array) => string | void);
+ readonly validate?: ((val: Array) => boolean)
readonly watch?: ReadonlyArray | "*";
}
@@ -3323,10 +3277,7 @@ export interface NestedNumberListAttribute {
item?: any,
) => Array | undefined | void;
readonly default?: Array | (() => Array);
- readonly validate?:
- | ((val: Array) => boolean)
- | ((val: Array) => void)
- | ((val: Array) => string | void);
+ readonly validate?: ((val: Array) => boolean)
readonly field?: string;
}
@@ -3345,10 +3296,7 @@ export interface NumberListAttribute {
item?: any,
) => Array | undefined | void;
readonly default?: Array | (() => Array);
- readonly validate?:
- | ((val: Array) => boolean)
- | ((val: Array) => void)
- | ((val: Array) => string | void);
+ readonly validate?: ((val: Array) => boolean)
readonly field?: string;
readonly watch?: ReadonlyArray | "*";
}
@@ -3368,10 +3316,7 @@ export interface NestedMapListAttribute {
item?: any,
) => Record[] | undefined | void;
readonly default?: Record[] | (() => Record[]);
- readonly validate?:
- | ((val: Record[]) => boolean)
- | ((val: Record[]) => void)
- | ((val: Record[]) => string | void);
+ readonly validate?: ((val: Record[]) => boolean)
readonly field?: string;
}
@@ -3390,10 +3335,7 @@ export interface NestedAnyListAttribute {
item?: any,
) => Record[] | undefined | void;
readonly default?: Record[] | (() => Record[]);
- readonly validate?:
- | ((val: Record[]) => boolean)
- | ((val: Record[]) => void)
- | ((val: Record[]) => string | void);
+ readonly validate?: ((val: Record[]) => boolean)
readonly field?: string;
}
@@ -3412,10 +3354,7 @@ export interface MapListAttribute {
item?: any,
) => Record[] | undefined | void;
readonly default?: Record[] | (() => Record[]);
- readonly validate?:
- | ((val: Record[]) => boolean)
- | ((val: Record[]) => void)
- | ((val: Record[]) => string | void);
+ readonly validate?: ((val: Record[]) => boolean)
readonly field?: string;
readonly watch?: ReadonlyArray | "*";
}
@@ -3435,10 +3374,7 @@ export interface CustomListAttribute {
item?: any,
) => Array | undefined | void;
readonly default?: Array | (() => Array);
- readonly validate?:
- | ((val: Array) => boolean)
- | ((val: Array) => void)
- | ((val: Array) => string | void);
+ readonly validate?: ((val: Array) => boolean);
readonly field?: string;
readonly watch?: ReadonlyArray | "*";
}
@@ -3458,10 +3394,7 @@ export interface AnyListAttribute {
item?: any,
) => Array | undefined | void;
readonly default?: Array | (() => Array);
- readonly validate?:
- | ((val: Array) => boolean)
- | ((val: Array) => void)
- | ((val: Array) => string | void);
+ readonly validate?: ((val: Array) => boolean)
readonly field?: string;
readonly watch?: ReadonlyArray | "*";
}
@@ -3483,8 +3416,6 @@ export interface NestedStringSetAttribute {
readonly default?: Array | (() => Array);
readonly validate?:
| ((val: Array) => boolean)
- | ((val: Array) => void)
- | ((val: Array) => string | void)
| RegExp;
readonly field?: string;
}
@@ -3504,11 +3435,7 @@ export interface NestedEnumNumberSetAttribute {
item?: any,
) => Array | undefined | void;
readonly default?: Array | (() => Array);
- readonly validate?:
- | ((val: Array) => boolean)
- | ((val: Array) => void)
- | ((val: Array) => string | void)
- | RegExp;
+ readonly validate?: ((val: Array) => boolean)
readonly field?: string;
}
@@ -3527,11 +3454,7 @@ export interface EnumNumberSetAttribute {
item?: any,
) => Array | undefined | void;
readonly default?: Array | (() => Array);
- readonly validate?:
- | ((val: Array) => boolean)
- | ((val: Array) => void)
- | ((val: Array) => string | void)
- | RegExp;
+ readonly validate?: ((val: Array) => boolean)
readonly field?: string;
readonly watch?: ReadonlyArray | "*";
}
@@ -3553,8 +3476,6 @@ export interface NestedEnumStringSetAttribute {
readonly default?: Array | (() => Array);
readonly validate?:
| ((val: Array) => boolean)
- | ((val: Array) => void)
- | ((val: Array) => string | void)
| RegExp;
readonly field?: string;
}
@@ -3576,8 +3497,6 @@ export interface EnumStringSetAttribute {
readonly default?: Array | (() => Array);
readonly validate?:
| ((val: Array) => boolean)
- | ((val: Array) => void)
- | ((val: Array) => string | void)
| RegExp;
readonly field?: string;
readonly watch?: ReadonlyArray | "*";
@@ -3600,8 +3519,6 @@ export interface StringSetAttribute {
readonly default?: Array | (() => Array);
readonly validate?:
| ((val: Array) => boolean)
- | ((val: Array) => void)
- | ((val: Array) => string | void)
| RegExp;
readonly field?: string;
readonly watch?: ReadonlyArray | "*";
@@ -3622,10 +3539,7 @@ export interface NestedNumberSetAttribute {
item?: any,
) => Array | undefined | void;
readonly default?: Array | (() => Array);
- readonly validate?:
- | ((val: Array) => boolean)
- | ((val: Array) => void)
- | ((val: Array) => string | void);
+ readonly validate?: ((val: Array) => boolean)
readonly field?: string;
}
@@ -3644,10 +3558,7 @@ export interface NumberSetAttribute {
item?: any,
) => Array | undefined | void;
readonly default?: Array | (() => Array);
- readonly validate?:
- | ((val: Array) => boolean)
- | ((val: Array) => void)
- | ((val: Array) => string | void);
+ readonly validate?: ((val: Array) => boolean)
readonly field?: string;
readonly watch?: ReadonlyArray | "*";
}
@@ -3671,10 +3582,7 @@ type CustomAttribute = {
readonly get?: (val: any, item: any) => any | undefined | void;
readonly set?: (val?: any, item?: any) => any | undefined | void;
readonly default?: any | (() => any);
- readonly validate?:
- | ((val: any) => boolean)
- | ((val: any) => void)
- | ((val: any) => string | void);
+ readonly validate?: ((val: any) => boolean)
readonly field?: string;
readonly watch?: ReadonlyArray | "*";
};
@@ -3687,10 +3595,7 @@ type NestedCustomAttribute = {
readonly get?: (val: any, item: any) => any | undefined | void;
readonly set?: (val?: any, item?: any) => any | undefined | void;
readonly default?: any | (() => any);
- readonly validate?:
- | ((val: any) => boolean)
- | ((val: any) => void)
- | ((val: any) => string | void);
+ readonly validate?: ((val: any) => boolean)
readonly field?: string;
};
@@ -5365,7 +5270,6 @@ export class Entity<
TableIndexCompositeAttributes
>;
query: Queries;
- conversions: Conversions;
parse>>(
item: ParseSingleInput,
@@ -5402,6 +5306,13 @@ export class Entity<
client: any;
}
+declare function createConversions<
+ A extends string,
+ F extends string,
+ C extends string,
+ S extends Schema,
+>(entity: Entity): Conversions;
+
export class TransactWriteEntity<
A extends string,
F extends string,
@@ -5776,10 +5687,7 @@ type CustomAttributeDefinition = {
readonly get?: (val: T, item: any) => T | undefined | void;
readonly set?: (val?: T, item?: any) => T | undefined | void;
readonly default?: T | (() => T);
- readonly validate?:
- | ((val: T) => boolean)
- | ((val: T) => void)
- | ((val: T) => string | void);
+ readonly validate?: ((val: T) => boolean)
readonly field?: string;
readonly watch?: ReadonlyArray | "*";
};
@@ -5809,4 +5717,4 @@ declare function createSchema<
F extends string,
C extends string,
S extends Schema,
->(schema: S): S;
+>(schema: S): S;
\ No newline at end of file
diff --git a/index.js b/index.js
index 323b6df1..0a3849f3 100644
--- a/index.js
+++ b/index.js
@@ -15,15 +15,24 @@ const {
ElectroUserValidationError,
ElectroAttributeValidationError,
} = require("./src/errors");
+const { createConversions } = require("./src/conversions");
+
+const {
+ ComparisonTypes
+} = require('./src/types');
module.exports = {
Entity,
Service,
ElectroError,
createSchema,
+ ComparisonTypes,
CustomAttributeType,
createCustomAttribute,
ElectroValidationError,
createGetTransaction,
createWriteTransaction,
+ ElectroUserValidationError,
+ ElectroAttributeValidationError,
+ createConversions,
};
diff --git a/index.test-d.ts b/index.test-d.ts
index a0531669..95a09f55 100644
--- a/index.test-d.ts
+++ b/index.test-d.ts
@@ -12,9 +12,7 @@ import {
expectError,
expectAssignable,
expectNotAssignable,
- expectNotType,
} from "tsd";
-import * as tests from "./test/tests.test-d";
type Resolve = T extends Function | string | number | boolean
? T
@@ -582,19 +580,17 @@ expectError({
});
expectAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
concurrency: 10,
unprocessed: "raw",
});
expectAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
concurrency: 10,
unprocessed: "raw",
@@ -614,20 +610,18 @@ expectAssignable({
});
expectNotAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
concurrency: 10,
unprocessed: "raw",
attributes: ["attrz1"],
});
expectNotAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
concurrency: 10,
unprocessed: "raw",
@@ -850,66 +844,58 @@ type DeleteBatchParamsParamsWithoutSK = Parameter<
>;
expectAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
response: "all_old",
});
expectAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
response: "all_old",
});
expectAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
});
expectAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
});
expectAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
response: "all_old",
});
expectAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
response: "all_old",
});
expectAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
});
expectAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
});
@@ -934,38 +920,34 @@ expectNotAssignable({
});
expectAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
concurrency: 10,
unprocessed: "raw",
});
expectAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
concurrency: 10,
unprocessed: "raw",
});
expectAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
concurrency: 10,
unprocessed: "raw",
});
expectAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
concurrency: 10,
unprocessed: "raw",
@@ -987,19 +969,62 @@ entityWithoutSK.delete({ attr1: "asbc" }).where((attr, op) => {
});
// Results
-expectAssignable>(
+expectAssignable>(
entityWithSK
.delete({ attr1: "abc", attr2: "def" })
.go({ response: "all_old" })
.then((res) => res.data),
);
-expectAssignable>(
+
+expectAssignable>(
+ entityWithSK
+ .delete({ attr1: "abc", attr2: "def" })
+ .go({ response: "default" })
+ .then((res) => res.data),
+);
+
+expectAssignable>(
+ entityWithSK
+ .delete({ attr1: "abc", attr2: "def" })
+ .go()
+ .then((res) => res.data),
+);
+
+expectAssignable>(
+ entityWithSK
+ .delete({ attr1: "abc", attr2: "def" })
+ .go({ response: "none" })
+ .then((res) => res.data),
+);
+
+expectAssignable>(
entityWithoutSK
.delete({ attr1: "abc" })
.go({ response: "all_old" })
.then((res) => res.data),
);
+expectAssignable>(
+ entityWithoutSK
+ .delete({ attr1: "abc" })
+ .go({ response: "none" })
+ .then((res) => res.data),
+);
+
+expectAssignable>(
+ entityWithoutSK
+ .delete({ attr1: "abc" })
+ .go({ response: "default" })
+ .then((res) => res.data),
+);
+
+expectAssignable>(
+ entityWithoutSK
+ .delete({ attr1: "abc" })
+ .go()
+ .then((res) => res.data),
+);
+
expectAssignable<"paramtest">(
entityWithSK.delete({ attr1: "abc", attr2: "def" }).params<"paramtest">(),
);
@@ -1153,35 +1178,31 @@ type PutBatchParamsParamsWithoutSK = Parameter<
>;
expectAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
response: "all_old",
});
expectAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
response: "all_old",
});
expectAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
response: "all_old",
});
expectAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
response: "all_old",
});
@@ -1205,39 +1226,35 @@ expectError({
});
expectAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
concurrency: 10,
unprocessed: "raw",
});
expectAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
concurrency: 10,
unprocessed: "raw",
});
expectNotAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
concurrency: 10,
unprocessed: "raw",
response: "all_old",
});
expectNotAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
concurrency: 10,
unprocessed: "raw",
@@ -1245,39 +1262,35 @@ expectNotAssignable({
});
expectAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
concurrency: 10,
unprocessed: "raw",
});
expectAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
concurrency: 10,
unprocessed: "raw",
});
expectNotAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
concurrency: 10,
unprocessed: "raw",
response: "all_old",
});
expectNotAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
concurrency: 10,
unprocessed: "raw",
@@ -1431,32 +1444,28 @@ type CreateParamsParams = Parameter;
type CreateParamsParamsWithoutSK = Parameter;
expectAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
});
expectAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
});
expectAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
});
expectAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
});
@@ -1608,18 +1617,16 @@ type UpdateParamsParams = Parameter;
type UpdateParamsParamsWithoutSK = Parameter;
expectAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
response: "updated_new",
});
expectAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
response: "updated_new",
});
@@ -1761,18 +1768,16 @@ type PatchParamsParams = Parameter;
type PatchParamsParamsWithoutSK = Parameter;
expectAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
response: "updated_new",
});
expectAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
response: "updated_new",
});
@@ -1876,34 +1881,30 @@ type MatchParamsParams = Parameter;
type MatchParamsParamsWithoutSK = Parameter;
expectAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
pages: 123,
});
expectAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
pages: 123,
});
expectAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
pages: 123,
});
expectAssignable({
- includeKeys: true,
+ data: 'includeKeys',
originalErr: true,
params: {},
- raw: true,
table: "abc",
pages: 123,
});
@@ -2635,10 +2636,9 @@ expectType(expectedAfterQueryChainMethods);
type GoParams = Parameter;
expectAssignable({
table: "df",
- raw: true,
params: {},
originalErr: true,
- includeKeys: true,
+ data: 'includeKeys',
pages: 123,
});
complexService.collections
diff --git a/package-lock.json b/package-lock.json
index c4beb4c1..f65689c2 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,12 +1,12 @@
{
"name": "electrodb",
- "version": "2.14.3",
+ "version": "3.0.0",
"lockfileVersion": 2,
"requires": true,
"packages": {
"": {
"name": "electrodb",
- "version": "2.14.3",
+ "version": "3.0.0",
"license": "ISC",
"dependencies": {
"@aws-sdk/lib-dynamodb": "^3.654.0",
diff --git a/package.json b/package.json
index 38e000a0..35281ffa 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "electrodb",
- "version": "2.15.0",
+ "version": "3.0.0",
"description": "A library to more easily create and interact with multiple entities and heretical relationships in dynamodb",
"main": "index.js",
"scripts": {
diff --git a/src/clauses.js b/src/clauses.js
index aaee3261..c2406380 100644
--- a/src/clauses.js
+++ b/src/clauses.js
@@ -9,6 +9,7 @@ const {
KeyTypes,
IndexTypes,
UpsertOperations,
+ ComparisonTypes,
} = require("./types");
const {
AttributeOperationProxy,
@@ -119,13 +120,27 @@ let clauses = {
pk,
);
state.setSK(composites);
- // we must apply eq on filter on all provided because if the user then does a sort key operation, it'd actually then unexpect results
- if (sk.length > 1) {
- state.filterProperties(FilterOperationNames.eq, {
- ...unused,
- ...composites,
- });
- }
+ state.beforeBuildParams(({ options, state }) => {
+ const accessPattern =
+ entity.model.translations.indexes.fromIndexToAccessPattern[
+ state.query.index
+ ];
+
+ if (
+ options.compare === ComparisonTypes.attributes ||
+ options.compare === ComparisonTypes.v2
+ ) {
+ if (
+ !entity.model.indexes[accessPattern].sk.isFieldRef &&
+ sk.length > 1
+ ) {
+ state.filterProperties(FilterOperationNames.eq, {
+ ...unused,
+ ...composites,
+ });
+ }
+ }
+ });
})
.whenOptions(({ options, state }) => {
if (!options.ignoreOwnership && !state.getParams()) {
@@ -204,11 +219,13 @@ let clauses = {
.whenOptions(({ state, options }) => {
if (!options.ignoreOwnership && !state.getParams()) {
state.unsafeApplyFilter(
+ {},
FilterOperationNames.eq,
entity.identifiers.entity,
entity.getName(),
);
state.unsafeApplyFilter(
+ {},
FilterOperationNames.eq,
entity.identifiers.version,
entity.getVersion(),
@@ -324,9 +341,9 @@ let clauses = {
const attributes = state.getCompositeAttributes();
const filter = state.query.filter[ExpressionTypes.ConditionExpression];
const { pk, sk } = entity._getPrimaryIndexFieldNames();
- filter.unsafeSet(FilterOperationNames.exists, pk);
+ filter.unsafeSet({}, FilterOperationNames.exists, pk);
if (sk) {
- filter.unsafeSet(FilterOperationNames.exists, sk);
+ filter.unsafeSet({}, FilterOperationNames.exists, sk);
}
const pkComposite = entity._expectFacets(facets, attributes.pk);
state.addOption("_includeOnResponseItem", pkComposite);
@@ -432,14 +449,15 @@ let clauses = {
const { pk } = state.query.keys;
const sk = state.query.keys.sk[0];
- const { updatedKeys, setAttributes, indexKey, deletedKeys = [] } = entity._getPutKeys(
- pk,
- sk && sk.facets,
- onlySetAppliedData,
- );
+ const {
+ updatedKeys,
+ setAttributes,
+ indexKey,
+ deletedKeys = [],
+ } = entity._getPutKeys(pk, sk && sk.facets, onlySetAppliedData);
for (const deletedKey of deletedKeys) {
- state.query.update.remove(deletedKey)
+ state.query.update.remove(deletedKey);
}
// calculated here but needs to be used when building the params
@@ -540,9 +558,9 @@ let clauses = {
const attributes = state.getCompositeAttributes();
const filter = state.query.filter[ExpressionTypes.ConditionExpression];
const { pk, sk } = entity._getPrimaryIndexFieldNames();
- filter.unsafeSet(FilterOperationNames.notExists, pk);
+ filter.unsafeSet({}, FilterOperationNames.notExists, pk);
if (sk) {
- filter.unsafeSet(FilterOperationNames.notExists, sk);
+ filter.unsafeSet({}, FilterOperationNames.notExists, sk);
}
return state
.setMethod(MethodTypes.put)
@@ -570,9 +588,9 @@ let clauses = {
const attributes = state.getCompositeAttributes();
const filter = state.query.filter[ExpressionTypes.ConditionExpression];
const { pk, sk } = entity._getPrimaryIndexFieldNames();
- filter.unsafeSet(FilterOperationNames.exists, pk);
+ filter.unsafeSet({}, FilterOperationNames.exists, pk);
if (sk) {
- filter.unsafeSet(FilterOperationNames.exists, sk);
+ filter.unsafeSet({}, FilterOperationNames.exists, sk);
}
const pkComposite = entity._expectFacets(facets, attributes.pk);
state.addOption("_includeOnResponseItem", pkComposite);
@@ -923,15 +941,20 @@ let clauses = {
pk,
);
state.setSK(state.buildQueryComposites(facets, sk));
- // we must apply eq on filter on all provided because if the user then does a sort key operation, it'd actually then unexpect results
- if (sk.length > 1) {
- state.filterProperties(FilterOperationNames.eq, {
- ...unused,
- ...composites,
- });
- }
state.whenOptions(({ options, state }) => {
+ if (
+ options.compare === ComparisonTypes.attributes ||
+ options.compare === ComparisonTypes.v2
+ ) {
+ if (sk.length > 1) {
+ state.filterProperties(FilterOperationNames.eq, {
+ ...unused,
+ ...composites,
+ });
+ }
+ }
+
if (
state.query.options.indexType === IndexTypes.clustered &&
Object.keys(composites).length < sk.length &&
@@ -940,11 +963,13 @@ let clauses = {
) {
state
.unsafeApplyFilter(
+ {},
FilterOperationNames.eq,
entity.identifiers.entity,
entity.getName(),
)
.unsafeApplyFilter(
+ {},
FilterOperationNames.eq,
entity.identifiers.version,
entity.getVersion(),
@@ -983,15 +1008,34 @@ let clauses = {
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);
+ .setSK(startingSk.composites)
+ .beforeBuildParams(({ options, state }) => {
+ if (
+ options.compare === ComparisonTypes.attributes ||
+ options.compare === ComparisonTypes.v2
+ ) {
+ if (!entity.model.indexes[accessPattern].sk.isFieldRef) {
+ state.filterProperties(
+ FilterOperationNames.lte,
+ endingSk.composites,
+ { asPrefix: true },
+ );
+ }
+ if (options.compare === ComparisonTypes.attributes) {
+ if (!entity.model.indexes[accessPattern].sk.isFieldRef) {
+ state.filterProperties(
+ FilterOperationNames.gte,
+ startingSk.composites,
+ { asPrefix: true },
+ );
+ }
+ }
+ }
+ });
} catch (err) {
state.setError(err);
return state;
@@ -1032,14 +1076,23 @@ let clauses = {
pk,
);
state.setSK(composites);
- const accessPattern =
- entity.model.translations.indexes.fromIndexToAccessPattern[
- state.query.index
- ];
-
- if (!entity.model.indexes[accessPattern].sk.isFieldRef) {
- state.filterProperties(FilterOperationNames.gt, composites);
- }
+ state.beforeBuildParams(({ options, state }) => {
+ if (
+ options.compare === ComparisonTypes.attributes ||
+ options.compare === ComparisonTypes.v2
+ ) {
+ const accessPattern =
+ entity.model.translations.indexes.fromIndexToAccessPattern[
+ state.query.index
+ ];
+
+ if (!entity.model.indexes[accessPattern].sk.isFieldRef) {
+ state.filterProperties(FilterOperationNames.gt, composites, {
+ asPrefix: true,
+ });
+ }
+ }
+ });
});
} catch (err) {
state.setError(err);
@@ -1058,6 +1111,27 @@ let clauses = {
return state.setType(QueryTypes.gte).ifSK((state) => {
const attributes = state.getCompositeAttributes();
state.setSK(state.buildQueryComposites(facets, attributes.sk));
+ state.beforeBuildParams(({ options, state }) => {
+ const { composites } = state.identifyCompositeAttributes(
+ facets,
+ attributes.sk,
+ attributes.pk,
+ );
+ if (options.compare === ComparisonTypes.attributes) {
+ const accessPattern =
+ entity.model.translations.indexes.fromIndexToAccessPattern[
+ state.query.index
+ ];
+ if (
+ !entity.model.indexes[accessPattern].sk.isFieldRef &&
+ attributes.sk.length > 1
+ ) {
+ state.filterProperties(FilterOperationNames.gte, composites, {
+ asPrefix: true,
+ });
+ }
+ }
+ });
});
} catch (err) {
state.setError(err);
@@ -1081,6 +1155,19 @@ let clauses = {
pk,
);
state.setSK(composites);
+ state.beforeBuildParams(({ options, state }) => {
+ if (options.compare === ComparisonTypes.attributes) {
+ const accessPattern =
+ entity.model.translations.indexes.fromIndexToAccessPattern[
+ state.query.index
+ ];
+ if (!entity.model.indexes[accessPattern].sk.isFieldRef) {
+ state.filterProperties(FilterOperationNames.lt, composites, {
+ asPrefix: true,
+ });
+ }
+ }
+ });
});
} catch (err) {
state.setError(err);
@@ -1104,13 +1191,23 @@ let clauses = {
pk,
);
state.setSK(composites);
- const accessPattern =
- entity.model.translations.indexes.fromIndexToAccessPattern[
- state.query.index
- ];
- if (!entity.model.indexes[accessPattern].sk.isFieldRef) {
- state.filterProperties(FilterOperationNames.lte, composites);
- }
+
+ state.beforeBuildParams(({ options, state }) => {
+ if (
+ options.compare === ComparisonTypes.attributes ||
+ options.compare === ComparisonTypes.v2
+ ) {
+ const accessPattern =
+ entity.model.translations.indexes.fromIndexToAccessPattern[
+ state.query.index
+ ];
+ if (!entity.model.indexes[accessPattern].sk.isFieldRef) {
+ state.filterProperties(FilterOperationNames.lte, composites, {
+ asPrefix: true,
+ });
+ }
+ }
+ });
});
} catch (err) {
state.setError(err);
@@ -1430,14 +1527,20 @@ class ChainState {
};
}
- applyFilter(operation, name, ...values) {
+ applyFilter(operation, name, values, filterOptions) {
if (
- (FilterOperationNames[operation] !== undefined) & (name !== undefined) &&
- values.length > 0
+ FilterOperationNames[operation] !== undefined &&
+ name !== undefined &&
+ values !== undefined
) {
const attribute = this.attributes[name];
if (attribute !== undefined) {
- this.unsafeApplyFilter(operation, attribute.field, ...values);
+ this.unsafeApplyFilter(
+ filterOptions,
+ operation,
+ attribute.field,
+ values,
+ );
}
}
return this;
@@ -1452,28 +1555,28 @@ class ChainState {
const attribute = this.attributes[name];
if (attribute !== undefined) {
const filter = this.query.filter[ExpressionTypes.ConditionExpression];
- filter.unsafeSet(operation, attribute.field, ...values);
+ filter.unsafeSet({}, operation, attribute.field, ...values);
}
}
return this;
}
- unsafeApplyFilter(operation, name, ...values) {
+ unsafeApplyFilter(filterOptions = {}, operation, name, values) {
if (
(FilterOperationNames[operation] !== undefined) & (name !== undefined) &&
- values.length > 0
+ values !== undefined
) {
const filter = this.query.filter[ExpressionTypes.FilterExpression];
- filter.unsafeSet(operation, name, ...values);
+ filter.unsafeSet(filterOptions, operation, name, values);
}
return this;
}
- filterProperties(operation, obj = {}) {
+ filterProperties(operation, obj = {}, filterOptions = {}) {
for (const property in obj) {
const value = obj[property];
if (value !== undefined) {
- this.applyFilter(operation, property, value);
+ this.applyFilter(operation, property, value, filterOptions);
}
}
return this;
@@ -1551,8 +1654,11 @@ class ChainState {
fn({ options, state: this });
});
}
+
+ return this;
}
+ // these are ran before "beforeBuildParams"
applyWithOptions(options = {}) {
this.applyAfterOptions.forEach((fn) => fn(options));
}
@@ -1563,6 +1669,7 @@ class ChainState {
fn({ options, state: this });
});
}
+ return this;
}
applyBeforeBuildParams(options = {}) {
diff --git a/src/client.js b/src/client.js
index 808dca79..afa79012 100644
--- a/src/client.js
+++ b/src/client.js
@@ -1,5 +1,5 @@
-const lib = require('@aws-sdk/lib-dynamodb')
-const util = require('@aws-sdk/util-dynamodb')
+const lib = require("@aws-sdk/lib-dynamodb");
+const util = require("@aws-sdk/util-dynamodb");
const { isFunction } = require("./validations");
const { ElectroError, ErrorCodes } = require("./errors");
const DocumentClientVersions = {
@@ -11,12 +11,12 @@ const unmarshallItem = (value) => {
const unmarshall = util.unmarshall || ((val) => val);
try {
value.Item = unmarshall(value.Item);
- } catch(err) {
- console.error('Internal Error: Failed to unmarshal input', err);
+ } catch (err) {
+ console.error("Internal Error: Failed to unmarshal input", err);
}
return value;
-}
+};
const v3Methods = ["send"];
const v2Methods = [
diff --git a/src/conversions.js b/src/conversions.js
new file mode 100644
index 00000000..d2e359b5
--- /dev/null
+++ b/src/conversions.js
@@ -0,0 +1,68 @@
+function createConversions(entity) {
+ const conversions = {
+ fromComposite: {
+ toKeys: (composite, options = {}) =>
+ entity._fromCompositeToKeys({ provided: composite }, options),
+ toCursor: (composite) =>
+ entity._fromCompositeToCursor(
+ { provided: composite },
+ { strict: "all" },
+ ),
+ },
+ fromKeys: {
+ toCursor: (keys) => entity._fromKeysToCursor({ provided: keys }, {}),
+ toComposite: (keys) => entity._fromKeysToComposite({ provided: keys }),
+ },
+ fromCursor: {
+ toKeys: (cursor) => entity._fromCursorToKeys({ provided: cursor }),
+ toComposite: (cursor) =>
+ entity._fromCursorToComposite({ provided: cursor }),
+ },
+ byAccessPattern: {},
+ };
+
+ for (let accessPattern in entity.model.indexes) {
+ let index = entity.model.indexes[accessPattern].index;
+ conversions.byAccessPattern[accessPattern] = {
+ fromKeys: {
+ toCursor: (keys) =>
+ entity._fromKeysToCursorByIndex({ indexName: index, provided: keys }),
+ toComposite: (keys) =>
+ entity._fromKeysToCompositeByIndex({
+ indexName: index,
+ provided: keys,
+ }),
+ },
+ fromCursor: {
+ toKeys: (cursor) =>
+ entity._fromCursorToKeysByIndex({
+ indexName: index,
+ provided: cursor,
+ }),
+ toComposite: (cursor) =>
+ entity._fromCursorToCompositeByIndex({
+ indexName: index,
+ provided: cursor,
+ }),
+ },
+ fromComposite: {
+ toCursor: (composite) =>
+ entity._fromCompositeToCursorByIndex(
+ { indexName: index, provided: composite },
+ { strict: "all" },
+ ),
+ toKeys: (composite, options = {}) =>
+ entity._fromCompositeToKeysByIndex(
+ { indexName: index, provided: composite },
+ options,
+ ),
+ },
+ };
+ }
+
+ return conversions;
+}
+
+module.exports = {
+ createConversions,
+};
diff --git a/src/entity.js b/src/entity.js
index 15a51d3f..91cb57d8 100644
--- a/src/entity.js
+++ b/src/entity.js
@@ -23,10 +23,12 @@ const {
ResultOrderOption,
ResultOrderParam,
IndexTypes,
- PartialComparisons,
+ KeyAttributesComparisons,
MethodTypeTranslation,
TransactionCommitSymbol,
CastKeyOptions,
+ ComparisonTypes,
+ DataOptions,
} = require("./types");
const { FilterFactory } = require("./filters");
const { FilterOperations } = require("./operations");
@@ -40,9 +42,9 @@ const e = require("./errors");
const v = require("./validations");
const ImpactedIndexTypeSource = {
- composite: 'composite',
- provided: 'provided',
-}
+ composite: "composite",
+ provided: "provided",
+};
class Entity {
constructor(model, config = {}) {
@@ -76,27 +78,6 @@ class Entity {
);
this.query = {};
- this.conversions = {
- fromComposite: {
- toKeys: (composite, options = {}) =>
- this._fromCompositeToKeys({ provided: composite }, options),
- toCursor: (composite) =>
- this._fromCompositeToCursor(
- { provided: composite },
- { strict: "all" },
- ),
- },
- fromKeys: {
- toCursor: (keys) => this._fromKeysToCursor({ provided: keys }, {}),
- toComposite: (keys) => this._fromKeysToComposite({ provided: keys }),
- },
- fromCursor: {
- toKeys: (cursor) => this._fromCursorToKeys({ provided: cursor }),
- toComposite: (cursor) =>
- this._fromCursorToComposite({ provided: cursor }),
- },
- byAccessPattern: {},
- };
for (let accessPattern in this.model.indexes) {
let index = this.model.indexes[accessPattern].index;
this.query[accessPattern] = (...values) => {
@@ -111,42 +92,6 @@ class Entity {
options,
).query(...values);
};
-
- this.conversions.byAccessPattern[accessPattern] = {
- fromKeys: {
- toCursor: (keys) =>
- this._fromKeysToCursorByIndex({ indexName: index, provided: keys }),
- toComposite: (keys) =>
- this._fromKeysToCompositeByIndex({
- indexName: index,
- provided: keys,
- }),
- },
- fromCursor: {
- toKeys: (cursor) =>
- this._fromCursorToKeysByIndex({
- indexName: index,
- provided: cursor,
- }),
- toComposite: (cursor) =>
- this._fromCursorToCompositeByIndex({
- indexName: index,
- provided: cursor,
- }),
- },
- fromComposite: {
- toCursor: (composite) =>
- this._fromCompositeToCursorByIndex(
- { indexName: index, provided: composite },
- { strict: "all" },
- ),
- toKeys: (composite, options = {}) =>
- this._fromCompositeToKeysByIndex(
- { indexName: index, provided: composite },
- options,
- ),
- },
- };
}
this.config.identifiers = config.identifiers || {};
@@ -633,7 +578,7 @@ class Entity {
_safeMinimum(...values) {
let eligibleNumbers = [];
for (let value of values) {
- if (typeof value === 'number') {
+ if (typeof value === "number") {
eligibleNumbers.push(value);
}
}
@@ -733,16 +678,14 @@ class Entity {
ExclusiveStartKey = undefined;
}
let pages = this._normalizePagesValue(config.pages);
- let max = this._normalizeLimitValue(config.limit);
let iterations = 0;
let count = 0;
let hydratedUnprocessed = [];
const shouldHydrate = config.hydrate && method === MethodTypes.query;
do {
- let limit = max === undefined ? parameters.Limit : max - count;
let response = await this._exec(
method,
- { ExclusiveStartKey, ...parameters, Limit: limit },
+ { ExclusiveStartKey, ...parameters },
config,
);
@@ -750,17 +693,17 @@ class Entity {
response = this.formatResponse(response, parameters.IndexName, {
...config,
- includeKeys: shouldHydrate || config.includeKeys,
+ data:
+ shouldHydrate &&
+ (!config.data || config.data === DataOptions.attributes)
+ ? "includeKeys"
+ : config.data,
ignoreOwnership: shouldHydrate || config.ignoreOwnership,
});
-
- if (config.raw) {
+ if (config.data === DataOptions.raw) {
return response;
} else if (config._isCollectionQuery) {
for (const entity in response.data) {
- if (max) {
- count += response.data[entity].length;
- }
let items = response.data[entity];
if (shouldHydrate && items.length) {
const hydrated = await config.hydrator(
@@ -778,8 +721,8 @@ class Entity {
results[entity] = [...results[entity], ...items];
}
} else if (Array.isArray(response.data)) {
- let prevCount = count
- if (!!max || !!config.count) {
+ let prevCount = count;
+ if (config.count) {
count += response.data.length;
}
let items = response.data;
@@ -801,7 +744,10 @@ class Entity {
results = [...results, ...items];
if (moreItemsThanRequired || count === config.count) {
const lastItem = results[results.length - 1];
- ExclusiveStartKey = this._fromCompositeToKeysByIndex({ indexName, provided: lastItem });
+ ExclusiveStartKey = this._fromCompositeToKeysByIndex({
+ indexName,
+ provided: lastItem,
+ });
break;
}
} else {
@@ -810,8 +756,9 @@ class Entity {
iterations++;
} while (
ExclusiveStartKey &&
- (pages === AllPages || (config.count !== undefined || iterations < pages)) &&
- (max === undefined || count < max) &&
+ (pages === AllPages ||
+ config.count !== undefined ||
+ iterations < pages) &&
(config.count === undefined || count < config.count)
);
@@ -869,14 +816,13 @@ class Entity {
}
cleanseRetrievedData(item = {}, options = {}) {
- let { includeKeys } = options;
let data = {};
let names = this.model.schema.translationForRetrieval;
for (let [attr, value] of Object.entries(item)) {
let name = names[attr];
if (name) {
data[name] = value;
- } else if (includeKeys) {
+ } else if (options.data === DataOptions.includeKeys) {
data[attr] = value;
}
}
@@ -963,14 +909,14 @@ class Entity {
let results = {};
if (validations.isFunction(config.parse)) {
results = config.parse(config, response);
- } else if (config.raw && !config._isPagination) {
+ } else if (config.data === DataOptions.raw && !config._isPagination) {
if (response.TableName) {
results = {};
} else {
results = response;
}
} else if (
- config.raw &&
+ config.data === DataOptions.raw &&
(config._isPagination || config.lastEvaluatedKeyRaw)
) {
results = response;
@@ -1372,7 +1318,7 @@ class Entity {
_formatReturnPager(config, lastEvaluatedKey) {
let page = lastEvaluatedKey || null;
- if (config.raw || config.pager === Pager.raw) {
+ if (config.data === DataOptions.raw || config.pager === Pager.raw) {
return page;
}
return config.formatCursor.serialize(page) || null;
@@ -1380,7 +1326,7 @@ class Entity {
_formatExclusiveStartKey({ config, indexName = TableIndex }) {
let exclusiveStartKey = config.cursor;
- if (config.raw || config.pager === Pager.raw) {
+ if (config.data === DataOptions.raw || config.pager === Pager.raw) {
return (
this._trimKeysToIndex({ provided: exclusiveStartKey, indexName }) ||
null
@@ -1683,6 +1629,9 @@ class Entity {
response: "default",
cursor: null,
data: "attributes",
+ consistent: undefined,
+ compare: ComparisonTypes.keys,
+ complete: false,
ignoreOwnership: false,
_providedIgnoreOwnership: false,
_isPagination: false,
@@ -1717,6 +1666,23 @@ class Entity {
}
}
+ if (typeof option.compare === "string") {
+ const type = ComparisonTypes[option.compare.toLowerCase()];
+ if (type) {
+ config.compare = type;
+ if (type === ComparisonTypes.v2 && option.complete === undefined) {
+ config.complete = true;
+ }
+ } else {
+ throw new e.ElectroError(
+ e.ErrorCodes.InvalidOptions,
+ `Invalid value for query option "compare" provided. Valid options include ${u.commaSeparatedString(
+ Object.keys(ComparisonTypes),
+ )}, received: "${option.compare}"`,
+ );
+ }
+ }
+
if (typeof option.response === "string" && option.response.length) {
const format = ReturnValues[option.response];
if (format === undefined) {
@@ -1728,13 +1694,14 @@ class Entity {
Object.keys(ReturnValues),
)}.`,
);
- }
- config.response = format;
- if (context.operation === MethodTypes.transactWrite) {
- config.params.ReturnValuesOnConditionCheckFailure =
- FormatToReturnValues[format];
- } else {
- config.params.ReturnValues = FormatToReturnValues[format];
+ } else if (format !== ReturnValues.default) {
+ config.response = format;
+ if (context.operation === MethodTypes.transactWrite) {
+ config.params.ReturnValuesOnConditionCheckFailure =
+ FormatToReturnValues[format];
+ } else {
+ config.params.ReturnValues = FormatToReturnValues[format];
+ }
}
}
@@ -1801,12 +1768,20 @@ class Entity {
}
if (option.data) {
+ if (!DataOptions[option.data]) {
+ throw new e.ElectroError(
+ e.ErrorCodes.InvalidOptions,
+ `Query option 'data' must be one of ${u.commaSeparatedString(
+ Object.keys(DataOptions),
+ )}.`,
+ );
+ }
config.data = option.data;
switch (option.data) {
- case "raw":
+ case DataOptions.raw:
config.raw = true;
break;
- case "includeKeys":
+ case DataOptions.includeKeys:
config.includeKeys = true;
break;
}
@@ -1814,11 +1789,19 @@ class Entity {
if (option.count !== undefined) {
if (typeof option.count !== "number" || option.count < 1) {
- throw new e.ElectroError(e.ErrorCodes.InvalidOptions, `Query option 'count' must be of type 'number' and greater than zero.`);
+ throw new e.ElectroError(
+ e.ErrorCodes.InvalidOptions,
+ `Query option 'count' must be of type 'number' and greater than zero.`,
+ );
}
config.count = option.count;
}
+ if (option.consistent === true) {
+ config.consistent = true;
+ config.params.ConsistentRead = true;
+ }
+
if (option.limit !== undefined) {
config.limit = option.limit;
config.params.Limit = option.limit;
@@ -2064,7 +2047,7 @@ class Entity {
return parameters;
}
- const requiresRawResponse = !!config.raw;
+ const requiresRawResponse = config.data === DataOptions.raw;
const enforcesOwnership = !config.ignoreOwnership;
const requiresUserInvolvedPagination =
TerminalOperation[config.terminalOperation] === TerminalOperation.page;
@@ -2258,7 +2241,7 @@ class Entity {
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] === '') {
+ if (keys[key] === undefined || keys[key] === "") {
delete keys[key];
}
}
@@ -2266,26 +2249,25 @@ class Entity {
let keyExpressions = this._expressionAttributeBuilder(keys);
const expressionAttributeNames = this._mergeExpressionsAttributes(
- filter.getNames(),
- keyExpressions.ExpressionAttributeNames,
+ filter.getNames(),
+ keyExpressions.ExpressionAttributeNames,
);
const expressionAttributeValues = this._mergeExpressionsAttributes(
- filter.getValues(),
- keyExpressions.ExpressionAttributeValues,
+ filter.getValues(),
+ keyExpressions.ExpressionAttributeValues,
);
-
let params = {
TableName: this.getTableName(),
};
if (Object.keys(expressionAttributeNames).length) {
- params['ExpressionAttributeNames'] = expressionAttributeNames;
+ params["ExpressionAttributeNames"] = expressionAttributeNames;
}
if (Object.keys(expressionAttributeValues).length) {
- params['ExpressionAttributeValues'] = expressionAttributeValues;
+ params["ExpressionAttributeValues"] = expressionAttributeValues;
}
let filterExpressions = [];
@@ -2306,7 +2288,7 @@ class Entity {
}
if (filterExpressions.length) {
- params.FilterExpression = filterExpressions.join(' AND ');
+ params.FilterExpression = filterExpressions.join(" AND ");
}
return params;
@@ -2365,7 +2347,13 @@ class Entity {
indexKey,
updatedKeys,
deletedKeys = [],
- } = this._getUpdatedKeys(pk, sk, attributesAndComposites, removed, update.composites);
+ } = this._getUpdatedKeys(
+ pk,
+ sk,
+ attributesAndComposites,
+ removed,
+ update.composites,
+ );
const accessPattern =
this.model.translations.indexes.fromIndexToAccessPattern[TableIndex];
for (const path of Object.keys(preparedUpdateValues)) {
@@ -2645,7 +2633,7 @@ class Entity {
return expressions;
}
- _makeQueryKeys(state) {
+ _makeQueryKeys(state, options) {
let consolidatedQueryFacets = this._consolidateQueryFacets(
state.query.keys.sk,
);
@@ -2660,13 +2648,17 @@ class Entity {
isCollection: state.query.options._isCollectionQuery,
});
default:
- return this._makeIndexKeysWithoutTail(state, consolidatedQueryFacets);
+ return this._makeIndexKeysWithoutTail(
+ state,
+ consolidatedQueryFacets,
+ options,
+ );
}
}
/* istanbul ignore next */
_queryParams(state = {}, options = {}) {
- const indexKeys = this._makeQueryKeys(state);
+ const indexKeys = this._makeQueryKeys(state, options);
let parameters = {};
switch (state.query.type) {
case QueryTypes.is:
@@ -2707,6 +2699,7 @@ class Entity {
break;
case QueryTypes.between:
parameters = this._makeBetweenQueryParams(
+ state.query.options,
state.query.index,
state.query.filter[ExpressionTypes.FilterExpression],
indexKeys.pk,
@@ -2722,6 +2715,8 @@ class Entity {
state.query.type,
state.query.filter[ExpressionTypes.FilterExpression],
indexKeys,
+ options,
+ state.query.options,
);
break;
default:
@@ -2739,31 +2734,50 @@ class Entity {
});
}
- _makeBetweenQueryParams(index, filter, pk, ...sk) {
+ _makeBetweenQueryParams(queryOptions, index, filter, pk, ...sk) {
let keyExpressions = this._queryKeyExpressionAttributeBuilder(
index,
pk,
...sk,
);
+
delete keyExpressions.ExpressionAttributeNames["#sk2"];
+
+ const customExpressions = {
+ names: (queryOptions.expressions && queryOptions.expressions.names) || {},
+ values:
+ (queryOptions.expressions && queryOptions.expressions.values) || {},
+ expression:
+ (queryOptions.expressions && queryOptions.expressions.expression) || "",
+ };
+
let params = {
TableName: this.getTableName(),
ExpressionAttributeNames: this._mergeExpressionsAttributes(
filter.getNames(),
keyExpressions.ExpressionAttributeNames,
+ customExpressions.names,
),
ExpressionAttributeValues: this._mergeExpressionsAttributes(
filter.getValues(),
keyExpressions.ExpressionAttributeValues,
+ customExpressions.values,
),
KeyConditionExpression: `#pk = :pk and #sk1 BETWEEN :sk1 AND :sk2`,
};
+
if (index) {
params["IndexName"] = index;
}
- if (filter.build()) {
- params.FilterExpression = filter.build();
+
+ let expressions = [customExpressions.expression, filter.build()]
+ .filter(Boolean)
+ .join(" AND ");
+
+ if (expressions.length) {
+ params.FilterExpression = expressions;
}
+
return params;
}
@@ -2881,28 +2895,52 @@ class Entity {
return merged;
}
+ _getComparisonOperator(comparison, skType, comparisonType) {
+ if (skType === "number") {
+ return Comparisons[comparison];
+ } else if (
+ comparisonType === ComparisonTypes.attributes ||
+ comparisonType === ComparisonTypes.v2
+ ) {
+ return KeyAttributesComparisons[comparison];
+ } else {
+ return Comparisons[comparison];
+ }
+ }
+
/* istanbul ignore next */
_makeComparisonQueryParams(
index = TableIndex,
comparison = "",
filter = {},
indexKeys = {},
+ options = {},
+ queryOptions = {},
) {
const { pk } = indexKeys;
const sk = indexKeys.sk[0];
- let operator =
- typeof sk === "number"
- ? Comparisons[comparison]
- : PartialComparisons[comparison];
-
+ let operator = this._getComparisonOperator(
+ comparison,
+ typeof sk,
+ options.compare,
+ );
if (!operator) {
throw new Error(
`Unexpected comparison operator "${comparison}", expected ${u.commaSeparatedString(
- Object.values(PartialComparisons),
+ Object.keys(KeyAttributesComparisons),
)}`,
);
}
+
+ let customExpressions = {
+ names: (queryOptions.expressions && queryOptions.expressions.names) || {},
+ values:
+ (queryOptions.expressions && queryOptions.expressions.values) || {},
+ expression:
+ (queryOptions.expressions && queryOptions.expressions.expression) || "",
+ };
+
let keyExpressions = this._queryKeyExpressionAttributeBuilder(
index,
pk,
@@ -2914,27 +2952,40 @@ class Entity {
ExpressionAttributeNames: this._mergeExpressionsAttributes(
filter.getNames(),
keyExpressions.ExpressionAttributeNames,
+ customExpressions.names,
),
ExpressionAttributeValues: this._mergeExpressionsAttributes(
filter.getValues(),
keyExpressions.ExpressionAttributeValues,
+ customExpressions.values,
),
KeyConditionExpression: `#pk = :pk and #sk1 ${operator} :sk1`,
};
+
if (index) {
params["IndexName"] = index;
}
- if (filter.build()) {
- params.FilterExpression = filter.build();
+
+ let expressions = [customExpressions.expression, filter.build()]
+ .filter(Boolean)
+ .join(" AND ");
+
+ if (expressions.length) {
+ params.FilterExpression = expressions;
}
+
return params;
}
- _expectIndexFacets(attributes, facets, { utilizeIncludedOnlyIndexes, skipConditionCheck } = {}) {
+ _expectIndexFacets(
+ attributes,
+ facets,
+ { utilizeIncludedOnlyIndexes, skipConditionCheck } = {},
+ ) {
let [isIncomplete, { incomplete, complete }] = this._getIndexImpact(
attributes,
facets,
- { utilizeIncludedOnlyIndexes, skipConditionCheck },
+ { utilizeIncludedOnlyIndexes, skipConditionCheck },
);
if (isIncomplete) {
@@ -2963,7 +3014,8 @@ class Entity {
_makeKeysFromAttributes(indexes, attributes, conditions) {
let indexKeys = {};
for (let [index, keyTypes] of Object.entries(indexes)) {
- const shouldMakeKeys = !this._indexConditionIsDefined(index) || conditions[index];
+ const shouldMakeKeys =
+ !this._indexConditionIsDefined(index) || conditions[index];
if (!shouldMakeKeys && index !== TableIndex) {
continue;
}
@@ -2994,7 +3046,10 @@ class Entity {
_makePutKeysFromAttributes(indexes, attributes) {
let indexKeys = {};
for (let index of indexes) {
- const shouldMakeKeys = this.model.indexes[this.model.translations.indexes.fromIndexToAccessPattern[index]].condition(attributes);
+ const shouldMakeKeys =
+ this.model.indexes[
+ this.model.translations.indexes.fromIndexToAccessPattern[index]
+ ].condition(attributes);
if (!shouldMakeKeys) {
continue;
}
@@ -3019,11 +3074,15 @@ class Entity {
);
let deletedKeys = [];
- for (const [indexName, condition] of Object.entries(completeFacets.conditions)) {
+ for (const [indexName, condition] of Object.entries(
+ completeFacets.conditions,
+ )) {
if (!condition) {
deletedKeys.push(this.model.translations.keys[indexName][KeyTypes.pk]);
if (this.model.translations.keys[indexName][KeyTypes.sk]) {
- deletedKeys.push(this.model.translations.keys[indexName][KeyTypes.sk]);
+ deletedKeys.push(
+ this.model.translations.keys[indexName][KeyTypes.sk],
+ );
}
}
}
@@ -3071,7 +3130,7 @@ class Entity {
const removedKeyImpact = this._expectIndexFacets(
{ ...removed },
{ ...keyAttributes },
- { skipConditionCheck: true }
+ { skipConditionCheck: true },
);
// complete facets, only includes impacted facets which likely does not include the updateIndex which then needs to be added here.
@@ -3091,11 +3150,15 @@ class Entity {
let updatedKeys = {};
let deletedKeys = [];
let indexKey = {};
- for (const [indexName, condition] of Object.entries(completeFacets.conditions)) {
+ for (const [indexName, condition] of Object.entries(
+ completeFacets.conditions,
+ )) {
if (!condition) {
deletedKeys.push(this.model.translations.keys[indexName][KeyTypes.pk]);
if (this.model.translations.keys[indexName][KeyTypes.sk]) {
- deletedKeys.push(this.model.translations.keys[indexName][KeyTypes.sk]);
+ deletedKeys.push(
+ this.model.translations.keys[indexName][KeyTypes.sk],
+ );
}
}
}
@@ -3122,9 +3185,9 @@ class Entity {
let hasPrefix =
indexHasSk && this.model.prefixes[index].sk.prefix !== undefined;
let hasPostfix =
- indexHasSk && this.model.prefixes[index].sk.prefix !== undefined;
+ indexHasSk && this.model.prefixes[index].sk.prefix !== undefined;
if (noImpactSk && noAttributeSk) {
- let key = hasPrefix ? this.model.prefixes[index].sk.prefix : '';
+ let key = hasPrefix ? this.model.prefixes[index].sk.prefix : "";
if (hasPostfix) {
key = `${key}${this.model.prefixes[index].sk.postfix}`;
}
@@ -3146,12 +3209,19 @@ class Entity {
}
_indexConditionIsDefined(index) {
- const definition = this.model.indexes[this.model.translations.indexes.fromIndexToAccessPattern[index]];
+ const definition =
+ this.model.indexes[
+ this.model.translations.indexes.fromIndexToAccessPattern[index]
+ ];
return definition && definition.conditionDefined;
}
/* istanbul ignore next */
- _getIndexImpact(attributes = {}, included = {}, { utilizeIncludedOnlyIndexes, skipConditionCheck } = {}) {
+ _getIndexImpact(
+ attributes = {},
+ included = {},
+ { utilizeIncludedOnlyIndexes, skipConditionCheck } = {},
+ ) {
// beware: this entire algorithm stinks and needs to be completely refactored. It does redundant loops and fights
// itself the whole way through. I am sorry.
let includedFacets = Object.keys(included);
@@ -3166,21 +3236,26 @@ class Entity {
facets[attribute] = attributes[attribute];
indexes.forEach((definition) => {
const { index, type } = definition;
- impactedIndexes[index] = impactedIndexes[index] || {};
- impactedIndexes[index][type] = impactedIndexes[index][type] || [];
- impactedIndexes[index][type].push(attribute);
- impactedIndexTypes[index] = impactedIndexTypes[index] || {};
- impactedIndexTypes[index][type] = this.model.translations.keys[index][type];
+ impactedIndexes[index] = impactedIndexes[index] || {};
+ impactedIndexes[index][type] = impactedIndexes[index][type] || [];
+ impactedIndexes[index][type].push(attribute);
+ impactedIndexTypes[index] = impactedIndexTypes[index] || {};
+ impactedIndexTypes[index][type] =
+ this.model.translations.keys[index][type];
- impactedIndexTypeSources[index] = impactedIndexTypeSources[index] || {};
- impactedIndexTypeSources[index][type] = ImpactedIndexTypeSource.provided;
+ impactedIndexTypeSources[index] =
+ impactedIndexTypeSources[index] || {};
+ impactedIndexTypeSources[index][type] =
+ ImpactedIndexTypeSource.provided;
});
}
}
// this function is used to determine key impact for update `set`, update `delete`, and `put`. This block is currently only used by update `set`
if (utilizeIncludedOnlyIndexes) {
- for (const [index, { pk, sk }] of Object.entries(this.model.facets.byIndex)) {
+ for (const [index, { pk, sk }] of Object.entries(
+ this.model.facets.byIndex,
+ )) {
// The main table index is handled somewhere else (messy I know), and we only want to do this processing if an
// index condition is defined for backwards compatibility. Backwards compatibility is not required for this
// change, but I have paranoid concerns of breaking changes around sparse indexes.
@@ -3188,24 +3263,36 @@ class Entity {
continue;
}
- if (pk && pk.length && pk.every(attr => included[attr] !== undefined)) {
+ if (
+ pk &&
+ pk.length &&
+ pk.every((attr) => included[attr] !== undefined)
+ ) {
pk.forEach((attr) => {
facets[attr] = included[attr];
});
impactedIndexes[index] = impactedIndexes[index] || {};
impactedIndexes[index][KeyTypes.pk] = [...pk];
impactedIndexTypes[index] = impactedIndexTypes[index] || {};
- impactedIndexTypes[index][KeyTypes.pk] = this.model.translations.keys[index][KeyTypes.pk];
+ impactedIndexTypes[index][KeyTypes.pk] =
+ this.model.translations.keys[index][KeyTypes.pk];
// flagging the impactedIndexTypeSource as `composite` means the entire key is only being impacted because
// all composites are in `included`. This will help us determine if we need to evaluate the `condition`
// callback for the index. If both the `sk` and `pk` were impacted because of `included` then we can skip
// the condition check because the index doesn't need to be recalculated;
- impactedIndexTypeSources[index] = impactedIndexTypeSources[index] || {};
- impactedIndexTypeSources[index][KeyTypes.pk] = impactedIndexTypeSources[index][KeyTypes.pk] || ImpactedIndexTypeSource.composite;
+ impactedIndexTypeSources[index] =
+ impactedIndexTypeSources[index] || {};
+ impactedIndexTypeSources[index][KeyTypes.pk] =
+ impactedIndexTypeSources[index][KeyTypes.pk] ||
+ ImpactedIndexTypeSource.composite;
}
- if (sk && sk.length && sk.every(attr => included[attr] !== undefined)) {
+ if (
+ sk &&
+ sk.length &&
+ sk.every((attr) => included[attr] !== undefined)
+ ) {
if (this.model.translations.keys[index][KeyTypes.sk]) {
sk.forEach((attr) => {
facets[attr] = included[attr];
@@ -3213,61 +3300,66 @@ class Entity {
impactedIndexes[index] = impactedIndexes[index] || {};
impactedIndexes[index][KeyTypes.sk] = [...sk];
impactedIndexTypes[index] = impactedIndexTypes[index] || {};
- impactedIndexTypes[index][KeyTypes.sk] = this.model.translations.keys[index][KeyTypes.sk];
+ impactedIndexTypes[index][KeyTypes.sk] =
+ this.model.translations.keys[index][KeyTypes.sk];
// flagging the impactedIndexTypeSource as `composite` means the entire key is only being impacted because
// all composites are in `included`. This will help us determine if we need to evaluate the `condition`
// callback for the index. If both the `sk` and `pk` were impacted because of `included` then we can skip
// the condition check because the index doesn't need to be recalculated;
- impactedIndexTypeSources[index] = impactedIndexTypeSources[index] || {};
- impactedIndexTypeSources[index][KeyTypes.sk] = impactedIndexTypeSources[index][KeyTypes.sk] || ImpactedIndexTypeSource.composite;
+ impactedIndexTypeSources[index] =
+ impactedIndexTypeSources[index] || {};
+ impactedIndexTypeSources[index][KeyTypes.sk] =
+ impactedIndexTypeSources[index][KeyTypes.sk] ||
+ ImpactedIndexTypeSource.composite;
}
}
}
}
- let indexesWithMissingComposites = Object.entries(this.model.facets.byIndex)
- .map(([index, definition]) => {
- const { pk, sk } = definition;
- let impacted = impactedIndexes[index];
- let impact = {
- index,
- definition,
- missing: []
- };
- if (impacted) {
- let missingPk =
- impacted[KeyTypes.pk] && impacted[KeyTypes.pk].length !== pk.length;
- let missingSk =
- impacted[KeyTypes.sk] && impacted[KeyTypes.sk].length !== sk.length;
- if (missingPk) {
- impact.missing = [
- ...impact.missing,
- ...pk.filter((attr) => {
- return (
- !impacted[KeyTypes.pk].includes(attr) &&
- !includedFacets.includes(attr)
- );
- }),
- ];
- }
- if (missingSk) {
- impact.missing = [
- ...impact.missing,
- ...sk.filter(
- (attr) =>
- !impacted[KeyTypes.sk].includes(attr) &&
- !includedFacets.includes(attr),
- ),
- ];
- }
- if (!missingPk && !missingSk) {
- completedIndexes.push(index);
- }
+ let indexesWithMissingComposites = Object.entries(
+ this.model.facets.byIndex,
+ ).map(([index, definition]) => {
+ const { pk, sk } = definition;
+ let impacted = impactedIndexes[index];
+ let impact = {
+ index,
+ definition,
+ missing: [],
+ };
+ if (impacted) {
+ let missingPk =
+ impacted[KeyTypes.pk] && impacted[KeyTypes.pk].length !== pk.length;
+ let missingSk =
+ impacted[KeyTypes.sk] && impacted[KeyTypes.sk].length !== sk.length;
+ if (missingPk) {
+ impact.missing = [
+ ...impact.missing,
+ ...pk.filter((attr) => {
+ return (
+ !impacted[KeyTypes.pk].includes(attr) &&
+ !includedFacets.includes(attr)
+ );
+ }),
+ ];
+ }
+ if (missingSk) {
+ impact.missing = [
+ ...impact.missing,
+ ...sk.filter(
+ (attr) =>
+ !impacted[KeyTypes.sk].includes(attr) &&
+ !includedFacets.includes(attr),
+ ),
+ ];
}
+ if (!missingPk && !missingSk) {
+ completedIndexes.push(index);
+ }
+ }
- return impact;
- });
+ return impact;
+ });
let incomplete = [];
for (const { index, missing, definition } of indexesWithMissingComposites) {
@@ -3277,28 +3369,53 @@ class Entity {
// is meaningless and ElectroDB should uphold its obligation to keep keys and attributes in sync.
// `index === TableIndex` is a special case where we don't need to check the condition because the main table is immutable
// `!this._indexConditionIsDefined(index)` means the index doesn't have a condition defined, so we can skip the check
- if (skipConditionCheck || index === TableIndex || !indexConditionIsDefined) {
+ if (
+ skipConditionCheck ||
+ index === TableIndex ||
+ !indexConditionIsDefined
+ ) {
incomplete.push({ index, missing });
conditions[index] = true;
continue;
}
- const memberAttributeIsImpacted = impactedIndexTypeSources[index] && (impactedIndexTypeSources[index][KeyTypes.pk] === ImpactedIndexTypeSource.provided || impactedIndexTypeSources[index][KeyTypes.sk] === ImpactedIndexTypeSource.provided);
- const allMemberAttributesAreIncluded = definition.all.every(({name}) => included[name] !== undefined);
+ const memberAttributeIsImpacted =
+ impactedIndexTypeSources[index] &&
+ (impactedIndexTypeSources[index][KeyTypes.pk] ===
+ ImpactedIndexTypeSource.provided ||
+ impactedIndexTypeSources[index][KeyTypes.sk] ===
+ ImpactedIndexTypeSource.provided);
+ const allMemberAttributesAreIncluded = definition.all.every(
+ ({ name }) => included[name] !== undefined,
+ );
if (memberAttributeIsImpacted || allMemberAttributesAreIncluded) {
// the `missing` array will contain indexes that are partially provided, but that leaves cases where the pk or
// sk of an index is complete but not both. Both cases are invalid if `indexConditionIsDefined=true`
const missingAttributes = definition.all
- .filter(({name}) => attributes[name] === undefined && included[name] === undefined || missing.includes(name))
- .map(({name}) => name)
+ .filter(
+ ({ name }) =>
+ (attributes[name] === undefined &&
+ included[name] === undefined) ||
+ missing.includes(name),
+ )
+ .map(({ name }) => name);
if (missingAttributes.length) {
- throw new e.ElectroError(e.ErrorCodes.IncompleteIndexCompositesAttributesProvided, `Incomplete composite attributes provided for index ${index}. Write operations that include composite attributes, for indexes with a condition callback defined, must always provide values for every index composite. This is to ensure consistency between index values and attribute values. Missing composite attributes identified: ${u.commaSeparatedString(missingAttributes)}`);
+ throw new e.ElectroError(
+ e.ErrorCodes.IncompleteIndexCompositesAttributesProvided,
+ `Incomplete composite attributes provided for index ${index}. Write operations that include composite attributes, for indexes with a condition callback defined, must always provide values for every index composite. This is to ensure consistency between index values and attribute values. Missing composite attributes identified: ${u.commaSeparatedString(
+ missingAttributes,
+ )}`,
+ );
}
- const accessPattern = this.model.translations.indexes.fromIndexToAccessPattern[index];
- let shouldMakeKeys = !!this.model.indexes[accessPattern].condition({...attributes, ...included});
+ const accessPattern =
+ this.model.translations.indexes.fromIndexToAccessPattern[index];
+ let shouldMakeKeys = !!this.model.indexes[accessPattern].condition({
+ ...attributes,
+ ...included,
+ });
// this helps identify which conditions were checked (key is present) and what the result was (true/false)
conditions[index] = shouldMakeKeys;
@@ -3313,7 +3430,12 @@ class Entity {
incomplete = incomplete.filter(({ missing }) => missing.length);
let isIncomplete = !!incomplete.length;
- let complete = { facets, indexes: completedIndexes, impactedIndexTypes, conditions };
+ let complete = {
+ facets,
+ indexes: completedIndexes,
+ impactedIndexTypes,
+ conditions,
+ };
return [isIncomplete, { incomplete, complete }];
}
@@ -3555,34 +3677,32 @@ class Entity {
return prefix;
}
- _makeKeyTransforms(queryType) {
+ _makeKeyTransforms(queryType, options = {}) {
const transforms = [];
const shiftUp = (val) => u.shiftSortOrder(val, 1);
const noop = (val) => val;
- switch (queryType) {
- case QueryTypes.between:
- transforms.push(noop, shiftUp);
- break;
- case QueryTypes.lte:
- case QueryTypes.gt:
- transforms.push(shiftUp);
- break;
- default:
- transforms.push(noop);
- break;
+ if (options.compare !== ComparisonTypes.v2) {
+ transforms.push(noop);
+ } else if (queryType === QueryTypes.between) {
+ transforms.push(noop, shiftUp);
+ } else if (queryType === QueryTypes.lte || queryType === QueryTypes.gt) {
+ transforms.push(shiftUp);
+ } else {
+ transforms.push(noop);
}
+
return transforms;
}
/* istanbul ignore next */
- _makeIndexKeysWithoutTail(state = {}, skFacets = []) {
+ _makeIndexKeysWithoutTail(state = {}, skFacets = [], options) {
const index = state.query.index || TableIndex;
this._validateIndex(index);
const pkFacets = state.query.keys.pk || {};
const excludePostfix =
state.query.options.indexType === IndexTypes.clustered &&
state.query.options._isCollectionQuery;
- const transforms = this._makeKeyTransforms(state.query.type);
+ const transforms = this._makeKeyTransforms(state.query.type, options);
if (!skFacets.length) {
skFacets.push({});
}
@@ -4078,8 +4198,8 @@ class Entity {
let indexScope = index.scope || "";
if (index.index === undefined && v.isFunction(index.condition)) {
throw new e.ElectroError(
- e.ErrorCodes.InvalidIndexCondition,
- `The index option 'condition' is only allowed on secondary indexes`,
+ e.ErrorCodes.InvalidIndexCondition,
+ `The index option 'condition' is only allowed on secondary indexes`,
);
}
@@ -4184,7 +4304,7 @@ class Entity {
}
}
- let definition= {
+ let definition = {
pk,
sk,
hasSk,
diff --git a/src/errors.js b/src/errors.js
index ba028f61..72e82de3 100644
--- a/src/errors.js
+++ b/src/errors.js
@@ -219,8 +219,8 @@ const ErrorCodes = {
},
IncompleteIndexCompositesAttributesProvided: {
code: 2012,
- section: 'invalid-index-composite-attributes-provided',
- name: 'IncompleteIndexCompositesAttributesProvided',
+ section: "invalid-index-composite-attributes-provided",
+ name: "IncompleteIndexCompositesAttributesProvided",
sym: ErrorCode,
},
InvalidAttribute: {
diff --git a/src/operations.js b/src/operations.js
index a0fce097..5a80bccb 100644
--- a/src/operations.js
+++ b/src/operations.js
@@ -313,12 +313,15 @@ class AttributeOperationProxy {
return AttributeOperationProxy.pathProxy(() => {
const { commit, root, target, builder } = build();
const attribute = target.getChild(prop);
- const nestedAny = attribute.type === AttributeTypes.any &&
- // if the name doesn't match that's because we are nested under 'any'
- attribute.name !== prop;
+ const nestedAny =
+ attribute.type === AttributeTypes.any &&
+ // if the name doesn't match that's because we are nested under 'any'
+ attribute.name !== prop;
let field;
if (attribute === undefined) {
- throw new Error(`Invalid attribute "${prop}" at path "${target.path}.${prop}"`);
+ throw new Error(
+ `Invalid attribute "${prop}" at path "${target.path}.${prop}"`,
+ );
} else if (nestedAny) {
field = prop;
} else {
diff --git a/src/schema.js b/src/schema.js
index 26c6e0e3..7396f83a 100644
--- a/src/schema.js
+++ b/src/schema.js
@@ -8,6 +8,7 @@ const {
PathTypes,
TableIndex,
ItemOperations,
+ DataOptions,
} = require("./types");
const AttributeTypeNames = Object.keys(AttributeTypes);
const ValidFacetTypes = [
@@ -466,26 +467,18 @@ class Attribute {
if (typeof definition === "function") {
return (val) => {
try {
- let reason = definition(val);
- const isValid = !reason;
- if (isValid) {
- return [isValid, []];
- } else if (typeof reason === "boolean") {
- return [
- isValid,
- [
- new e.ElectroUserValidationError(
- this.path,
- "Invalid value provided",
- ),
- ],
- ];
- } else {
- return [
- isValid,
- [new e.ElectroUserValidationError(this.path, reason)],
- ];
- }
+ let isValid = !!definition(val);
+ return [
+ isValid,
+ isValid
+ ? []
+ : [
+ new e.ElectroUserValidationError(
+ this.path,
+ "Invalid value provided",
+ ),
+ ],
+ ];
} catch (err) {
return [false, [new e.ElectroUserValidationError(this.path, err)]];
}
@@ -1687,14 +1680,13 @@ class Schema {
}
translateFromFields(item = {}, options = {}) {
- let { includeKeys } = options;
let data = {};
let names = this.translationForRetrieval;
for (let [attr, value] of Object.entries(item)) {
let name = names[attr];
if (name) {
data[name] = value;
- } else if (includeKeys) {
+ } else if (options.data === DataOptions.includeKeys) {
data[attr] = value;
}
}
diff --git a/src/service.js b/src/service.js
index 9ae82d15..2b560be1 100644
--- a/src/service.js
+++ b/src/service.js
@@ -9,11 +9,11 @@ const {
TransactionMethods,
KeyCasing,
ServiceVersions,
- Pager,
ElectroInstance,
ElectroInstanceTypes,
ModelVersions,
IndexTypes,
+ DataOptions,
} = require("./types");
const { FilterFactory } = require("./filters");
const { FilterOperations } = require("./operations");
@@ -345,7 +345,7 @@ class Service {
}
cleanseRetrievedData(index = TableIndex, entities, data = {}, config = {}) {
- if (config.raw) {
+ if (config.data === DataOptions.raw) {
return data;
}
const identifiers = getEntityIdentifiers(entities);
@@ -462,7 +462,7 @@ class Service {
let options = {
// expressions, // DynamoDB doesnt return what I expect it would when provided with these entity filters
parse: (options, data) => {
- if (options.raw) {
+ if (options.data === DataOptions.raw) {
return data;
}
return this.cleanseRetrievedData(index, entities, data, options);
@@ -634,11 +634,11 @@ class Service {
if (!scopeMatch) {
collectionDifferences.push(
- `The index scope value provided "${
- providedIndex.scope || "undefined"
- }" does not match established index scope value "${
- definition.scope || "undefined"
- }" on index "${providedIndexName}". Index scope options must match across all entities participating in a collection`,
+ `The index scope value provided "${
+ providedIndex.scope || "undefined"
+ }" does not match established index scope value "${
+ definition.scope || "undefined"
+ }" on index "${providedIndexName}". Index scope options must match across all entities participating in a collection`,
);
}
diff --git a/src/transaction.js b/src/transaction.js
index aba8cb73..7aef39e9 100644
--- a/src/transaction.js
+++ b/src/transaction.js
@@ -1,4 +1,4 @@
-const { TableIndex, TransactionMethods } = require("./types");
+const { TableIndex, TransactionMethods, DataOptions } = require("./types");
const { getEntityIdentifiers, matchToEntityAlias } = require("./entity");
function cleanseCanceledData(
@@ -7,7 +7,7 @@ function cleanseCanceledData(
data = {},
config = {},
) {
- if (config.raw) {
+ if (config.data === DataOptions.raw) {
return data;
}
const identifiers = getEntityIdentifiers(entities);
@@ -52,7 +52,7 @@ function cleanseTransactionData(
data = {},
config = {},
) {
- if (config.raw) {
+ if (config.data === DataOptions.raw) {
return data;
}
const identifiers = getEntityIdentifiers(entities);
@@ -139,7 +139,7 @@ function createTransaction(options) {
const response = await driver.go(method, params, {
...options,
parse: (options, data) => {
- if (options.raw) {
+ if (options.data === DataOptions.raw) {
return data;
} else if (data.canceled) {
canceled = true;
diff --git a/src/types.js b/src/types.js
index 410a6a93..52b7a965 100644
--- a/src/types.js
+++ b/src/types.js
@@ -3,11 +3,23 @@ const KeyTypes = {
sk: "sk",
};
+const DataOptions = {
+ raw: "raw",
+ includeKeys: "includeKeys",
+ attributes: "attributes",
+};
+
const BatchWriteTypes = {
batch: "batch",
concurrent: "concurrent",
};
+const ComparisonTypes = {
+ keys: "keys",
+ attributes: "attributes",
+ v2: "v2",
+};
+
const QueryTypes = {
and: "and",
gte: "gte",
@@ -86,7 +98,7 @@ const Comparisons = {
gt: ">",
};
-const PartialComparisons = {
+const KeyAttributesComparisons = {
lt: "<",
gte: ">=",
@@ -332,6 +344,7 @@ module.exports = {
ValueTypes,
TableIndex,
MethodTypes,
+ DataOptions,
Comparisons,
BuilderTypes,
ReturnValues,
@@ -341,6 +354,7 @@ module.exports = {
AttributeTypes,
EntityVersions,
CastKeyOptions,
+ ComparisonTypes,
ServiceVersions,
ExpressionTypes,
ElectroInstance,
@@ -348,13 +362,13 @@ module.exports = {
UnprocessedTypes,
AttributeWildCard,
TerminalOperation,
- PartialComparisons,
FormatToReturnValues,
AttributeProxySymbol,
ElectroInstanceTypes,
MethodTypeTranslation,
EventSubscriptionTypes,
DynamoDBAttributeTypes,
+ KeyAttributesComparisons,
AttributeMutationMethods,
AllPages,
ResultOrderOption,
@@ -363,4 +377,5 @@ module.exports = {
TransactionOperations,
TransactionMethods,
UpsertOperations,
+ BatchWriteTypes,
};
diff --git a/src/validations.js b/src/validations.js
index f26b1731..d616ffd3 100644
--- a/src/validations.js
+++ b/src/validations.js
@@ -122,7 +122,7 @@ const Index = {
scope: {
type: "string",
required: false,
- }
+ },
},
},
sk: {
@@ -178,7 +178,7 @@ const Index = {
type: "any",
required: false,
format: "isFunction",
- }
+ },
},
};
diff --git a/src/where.js b/src/where.js
index c345b70f..95bb0cc3 100644
--- a/src/where.js
+++ b/src/where.js
@@ -27,7 +27,8 @@ class FilterExpression extends ExpressionState {
return !expression.replace(/\n|\r|\w/g, "").trim();
}
- add(newExpression) {
+ add(newExpression, filterOptions = {}) {
+ const asPrefix = !!filterOptions.asPrefix;
let expression = "";
let existingExpression = this.expression;
if (
@@ -39,13 +40,19 @@ class FilterExpression extends ExpressionState {
if (isEmpty) {
return existingExpression;
}
- let existingNeedsParens =
+
+ if (
+ !asPrefix &&
!existingExpression.startsWith("(") &&
- !existingExpression.endsWith(")");
- if (existingNeedsParens) {
+ !existingExpression.endsWith(")")
+ ) {
existingExpression = `(${existingExpression})`;
}
- expression = `${existingExpression} AND ${newExpression}`;
+ if (asPrefix) {
+ expression = `(${newExpression}) AND ${existingExpression}`;
+ } else {
+ expression = `${existingExpression} AND ${newExpression}`;
+ }
} else {
expression = this._trim(newExpression);
}
@@ -53,7 +60,7 @@ class FilterExpression extends ExpressionState {
}
// applies operations without verifying them against known attributes. Used internally for key conditions.
- unsafeSet(operation, name, ...values) {
+ unsafeSet(filterOptions, operation, name, ...values) {
const { template } = FilterOperations[operation] || {};
if (template === undefined) {
throw new Error(
@@ -68,7 +75,7 @@ class FilterExpression extends ExpressionState {
names.prop,
...valueExpressions,
);
- this.add(condition);
+ this.add(condition, filterOptions);
}
build() {
diff --git a/test/connected.batch.spec.js b/test/connected.batch.spec.js
index 91ff5b2c..dc3ca467 100644
--- a/test/connected.batch.spec.js
+++ b/test/connected.batch.spec.js
@@ -62,7 +62,7 @@ let schema = {
type: "string",
required: true,
validate: (date) =>
- moment(date, "YYYY-MM-DD").isValid() ? "" : "Invalid date format",
+ moment(date, "YYYY-MM-DD").isValid()
},
rent: {
type: "string",
@@ -510,7 +510,7 @@ describe("BatchGet", () => {
response,
resultsAll: [],
unprocessedAll: [],
- config: { includeKeys: true },
+ config: { data: 'includeKeys' },
orderMaintainer: {
getOrder: () => -1,
},
diff --git a/test/connected.crud.spec.js b/test/connected.crud.spec.js
index 0f3250c1..f9946c75 100644
--- a/test/connected.crud.spec.js
+++ b/test/connected.crud.spec.js
@@ -75,7 +75,7 @@ const createModel = (entityName) => {
type: "string",
required: true,
validate: (date) =>
- moment(date, "YYYY-MM-DD").isValid() ? "" : "Invalid date format",
+ moment(date, "YYYY-MM-DD").isValid()
},
rent: {
type: "string",
@@ -496,8 +496,6 @@ for (const [clientVersion, client] of [
required: true,
validate: (date) =>
moment(date, "YYYY-MM-DD").isValid()
- ? ""
- : "Invalid date format",
},
rent: {
type: "string",
@@ -3926,12 +3924,12 @@ for (const [clientVersion, client] of [
let someValue = "ABDEF";
let putRecord = await db
.put({ id, date, someValue })
- .go({ raw: true })
+ .go({ data: 'raw' })
.then((res) => res.data);
expect(putRecord).to.deep.equal({});
let getRecord = await db
.get({ id, date })
- .go({ raw: true })
+ .go({ data: 'raw' })
.then((res) => res.data);
if (clientVersion === c.DocumentClientVersions.v2) {
expect(getRecord).to.deep.equal({
@@ -3951,7 +3949,7 @@ for (const [clientVersion, client] of [
let updateRecord = await db
.update({ id, date })
.set({ someValue })
- .go({ raw: true })
+ .go({ data: 'raw' })
.then((res) => res.data);
if (clientVersion === c.DocumentClientVersions.v2) {
expect(updateRecord).to.deep.equal({});
@@ -3963,7 +3961,7 @@ for (const [clientVersion, client] of [
let queryRecord = await db.query
.record({ id, date })
- .go({ raw: true })
+ .go({ data: 'raw' })
.then((res) => res.data);
if (clientVersion === c.DocumentClientVersions.v2) {
expect(queryRecord).to.deep.equal({
@@ -3982,7 +3980,6 @@ for (const [clientVersion, client] of [
ScannedCount: 1,
});
} else {
- console.log({queryRecord});
expect(queryRecord).to.have.keys([
"Items",
"Count",
@@ -3992,7 +3989,7 @@ for (const [clientVersion, client] of [
}
let recordWithKeys = await db
.get({ id, date })
- .go({ includeKeys: true })
+ .go({ data: 'includeKeys' })
.then((res) => res.data);
expect(recordWithKeys).to.deep.equal({
id,
@@ -4362,19 +4359,11 @@ for (const [clientVersion, client] of [
ExpressionAttributeNames: {
"#pk": "gsi2pk",
"#sk1": "gsi2sk",
- "#prop6": "prop6",
- "#prop7": "prop7",
- "#prop8": "prop8",
},
ExpressionAttributeValues: {
- ":prop60": record.prop6,
- ":prop70": record.prop7,
- ":prop80": record.prop8,
":pk": `$test#prop5_${record.prop5}`,
":sk1": `$dummy_1#prop6_${record.prop6}#prop7_${record.prop7}#prop8_${record.prop8}`,
},
- FilterExpression:
- "(#prop6 = :prop60) AND #prop7 = :prop70 AND #prop8 = :prop80",
IndexName: "gsi2pk-gsi2sk-index",
});
let beforeUpdate = await Dummy.query
@@ -4409,19 +4398,11 @@ for (const [clientVersion, client] of [
ExpressionAttributeNames: {
"#pk": "gsi2pk",
"#sk1": "gsi2sk",
- "#prop6": "prop6",
- "#prop7": "prop7",
- "#prop8": "prop8",
},
ExpressionAttributeValues: {
- ":prop60": record.prop6,
- ":prop70": record.prop7,
- ":prop80": record.prop8,
":pk": `$test#prop5_${prop5}`,
":sk1": `$dummy_1#prop6_${record.prop6}#prop7_${record.prop7}#prop8_${record.prop8}`,
},
- FilterExpression:
- "(#prop6 = :prop60) AND #prop7 = :prop70 AND #prop8 = :prop80",
IndexName: "gsi2pk-gsi2sk-index",
});
let afterUpdate = await Dummy.query
@@ -4472,19 +4453,11 @@ for (const [clientVersion, client] of [
ExpressionAttributeNames: {
"#pk": "gsi2pk",
"#sk1": "gsi2sk",
- "#prop6": "prop6",
- "#prop7": "prop7",
- "#prop8": "prop8",
},
ExpressionAttributeValues: {
- ":prop60": record.prop6,
- ":prop70": record.prop7,
- ":prop80": record.prop8,
":pk": `$test#prop5_${record.prop5}`,
":sk1": `$dummy_1#prop6_${record.prop6}#prop7_${record.prop7}#prop8_${record.prop8}`,
},
- FilterExpression:
- "(#prop6 = :prop60) AND #prop7 = :prop70 AND #prop8 = :prop80",
IndexName: "gsi2pk-gsi2sk-index",
});
let beforeUpdate = await Dummy.query
@@ -4519,19 +4492,11 @@ for (const [clientVersion, client] of [
ExpressionAttributeNames: {
"#pk": "gsi2pk",
"#sk1": "gsi2sk",
- "#prop6": "prop6",
- "#prop7": "prop7",
- "#prop8": "prop8",
},
ExpressionAttributeValues: {
- ":prop60": record.prop6,
- ":prop70": record.prop7,
- ":prop80": record.prop8,
":pk": `$test#prop5_${prop5}`,
":sk1": `$dummy_1#prop6_${record.prop6}#prop7_${record.prop7}#prop8_${record.prop8}`,
},
- FilterExpression:
- "(#prop6 = :prop60) AND #prop7 = :prop70 AND #prop8 = :prop80",
IndexName: "gsi2pk-gsi2sk-index",
});
let afterUpdate = await Dummy.query
@@ -4688,7 +4653,7 @@ for (const [clientVersion, client] of [
// THIS IS A FOOLISH TEST: IT ONLY FULLY WORKS WHEN THE TABLE USED FOR TESTING IS FULL OF RECORDS. THIS WILL HAVE TO DO UNTIL I HAVE TIME TO FIGURE OUT A PROPER WAY MOCK DDB.
let MallStores = new Entity(model, { client });
let results = await MallStores.scan
- .go({ raw: true })
+ .go({ data: 'raw' })
.then((res) => [res.cursor, res.data]);
expect(results).to.be.an("array").and.have.length(2);
// Scan may not return records, dont force a bad test then
@@ -4700,7 +4665,7 @@ for (const [clientVersion, client] of [
expect(stores.Items[0]).to.have.a.property("pk");
expect(stores.Items[0]).to.have.a.property("sk");
let [nextIndex, nextStores] = await MallStores.scan
- .go({ cursor: index, raw: true })
+ .go({ cursor: index, data: 'raw' })
.then((res) => [res.cursor, res.data]);
expect(nextIndex).to.not.deep.equal(index);
expect(nextStores.Items).to.be.an("array");
@@ -4764,8 +4729,6 @@ for (const [clientVersion, client] of [
required: true,
validate: (date) =>
moment(date, "YYYY-MM-DD").isValid()
- ? ""
- : "Invalid date format",
},
rent: {
type: "string",
@@ -4883,17 +4846,11 @@ for (const [clientVersion, client] of [
ExpressionAttributeNames: {
"#pk": "gsi1pk",
"#sk1": "gsi1sk",
- "#unitId": "unitId",
- "#buildingId": "buildingId",
},
ExpressionAttributeValues: {
":pk": "mallz_eastpointe",
":sk1": "b_buildingz#u_g1#s_",
- ":buildingId0": "BuildingZ",
- ":unitId0": "G1",
},
- FilterExpression:
- "(#buildingId = :buildingId0) AND #unitId = :unitId0",
IndexName: "gsi1pk-gsi1sk-index",
});
expect(leasesParams).to.deep.equal({
@@ -4902,17 +4859,11 @@ for (const [clientVersion, client] of [
ExpressionAttributeNames: {
"#pk": "gsi2pk",
"#sk1": "gsi2sk",
- "#leaseEnd": "leaseEnd",
- "#storeId": "storeId",
},
ExpressionAttributeValues: {
":pk": "m_eastpointe",
":sk1": "l_2020-01-20#s_lattelarrys#b_",
- ":leaseEnd0": "2020-01-20",
- ":storeId0": "LatteLarrys",
},
- FilterExpression:
- "(#leaseEnd = :leaseEnd0) AND #storeId = :storeId0",
IndexName: "gsi2pk-gsi2sk-index",
});
expect(shopParams).to.deep.equal({
@@ -4921,17 +4872,11 @@ for (const [clientVersion, client] of [
ExpressionAttributeNames: {
"#pk": "gsi4pk",
"#sk1": "gsi4sk",
- "#buildingId": "buildingId",
- "#mallId": "mallId",
},
ExpressionAttributeValues: {
- ":buildingId0": "BuildingZ",
- ":mallId0": "EastPointe",
":pk": "$facettest_1#store_lattelarrys",
":sk1": `$${ENTITY}#mall_eastpointe#building_buildingz#unit_`,
},
- FilterExpression:
- "(#mallId = :mallId0) AND #buildingId = :buildingId0",
IndexName: "gsi4pk-gsi4sk-index",
});
expect(createParams).to.deep.equal({
diff --git a/test/connected.page.spec.js b/test/connected.page.spec.js
index 9732da5f..89622797 100644
--- a/test/connected.page.spec.js
+++ b/test/connected.page.spec.js
@@ -394,59 +394,11 @@ describe("Query Pagination", () => {
} while (cursor !== null);
}).timeout(10000);
- it(`should continue to query until '${limitOption}' option is reached`, async () => {
- const ExclusiveStartKey = { key: "hi" };
- const [one, two, three, four, five, six] = tasks.data;
- const { client, calls } = createClient({
- mockResponses: [
- {
- Items: [one, two, three],
- LastEvaluatedKey: ExclusiveStartKey,
- },
- {
- Items: [four, five, six],
- LastEvaluatedKey: ExclusiveStartKey,
- },
- {
- Items: [],
- LastEvaluatedKey: ExclusiveStartKey,
- },
- {
- Items: [],
- LastEvaluatedKey: undefined,
- },
- {
- Items: [],
- LastEvaluatedKey: ExclusiveStartKey,
- },
- ],
- });
- const pages = 3;
- const limit = 5;
- const entity = new Tasks(TasksModel, { client, table });
- const results = await entity.query
- .task({ task: "my_task" })
- .go({ pages, [limitOption]: limit })
- .then((res) => res.data);
- expect(results).to.be.an("array").with.length(limitOption === 'count' ? 5 : 6);
- expect(calls).to.have.length(2);
- for (let i = 0; i < calls.length; i++) {
- const call = calls[i];
- if (i === 0) {
- expect(call.ExclusiveStartKey).to.be.undefined;
- } else {
- expect(call.ExclusiveStartKey.key).to.equal("hi");
- expect(call.ExclusiveStartKey.key === ExclusiveStartKey.key).to.be
- .true;
- }
- }
- });
-
it(`should throw if '${limitOption}' option is less than one or not a valid number`, async () => {
const employee = "employee";
const project = "project";
const message = limitOption === 'limit'
- ? "Query option 'limit' must be of type 'number' and greater than zero. - For more detail on this error reference: https://electrodb.dev/en/reference/errors/#invalid-limit-option"
+ ? "Error thrown by DynamoDB client: \"Limit must be greater than or equal to 1\" - For more detail on this error reference: https://electrodb.dev/en/reference/errors/#aws-error"
: "Query option 'count' must be of type 'number' and greater than zero. - For more detail on this error reference: https://electrodb.dev/en/reference/errors/#invalid-options"
const result1 = await service.collections
.assignments({ employee })
@@ -464,14 +416,6 @@ describe("Query Pagination", () => {
expect(result2.success).to.be.false;
expect(result2.message).to.equal(message);
- const result3 = await service.collections
- .assignments({ employee })
- .go({ [limitOption]: "weasel" })
- .then(() => ({ success: true }))
- .catch((err) => ({ success: false, message: err.message }));
- expect(result3.success).to.be.false;
- expect(result3.message).to.equal(message);
-
const result4 = await tasks.query
.projects({ project })
.go({ [limitOption]: -1 })
@@ -487,14 +431,6 @@ describe("Query Pagination", () => {
.catch((err) => ({ success: false, message: err.message }));
expect(result5.success).to.be.false;
expect(result5.message).to.equal(message);
-
- const result6 = await tasks.query
- .projects({ project })
- .go({ [limitOption]: "weasel" })
- .then(() => ({ success: true }))
- .catch((err) => ({ success: false, message: err.message }));
- expect(result6.success).to.be.false;
- expect(result6.message).to.equal(message);
});
}
@@ -517,7 +453,7 @@ describe("Query Pagination", () => {
expect(limit).to.be.lessThan(occurrences);
const results = await tasks.query
.projects({ project })
- .go({ limit, raw: true })
+ .go({ limit, data: 'raw' })
.then((res) => res.data);
expect(results.Items).to.be.an("array").and.have.length(limit);
expect(created.calls).to.be.an("array").and.have.length(1);
@@ -534,7 +470,7 @@ describe("Query Pagination", () => {
let keys = new Set();
let [next, results] = await tasks.query
.projects({ project: Tasks.projects[0] })
- .go({ cursor, raw: true, limit })
+ .go({ cursor, data: 'raw', limit })
.then((res) => [res.cursor, res.data]);
if (next !== null && count > 1) {
expect(next).to.have.keys(["sk", "pk", "gsi1sk", "gsi1pk"]);
@@ -698,24 +634,24 @@ describe("Query Pagination", () => {
const id = uuid();
const queries = [
['query operation using default execution options', () => entity1.query.record({ id }).go()],
- ['query operation with raw flag', () => entity1.query.record({ id }).go({ raw: true })],
- ['query operation with includeKeys flag', () => entity1.query.record({ id }).go({ includeKeys: true })],
+ ['query operation with raw flag', () => entity1.query.record({ id }).go({ data: 'raw' })],
+ ['query operation with includeKeys flag', () => entity1.query.record({ id }).go({ data: 'includeKeys' })],
['query operation with ignoreOwnership flag', () => entity1.query.record({ id }).go({ ignoreOwnership: true })],
// ['scan query using default execution options', () => entity1.scan.go()],
- // ['scan query with raw flag', () => entity1.scan.go({ raw: true })],
- // ['scan query with includeKeys flag', () => entity1.scan.go({ includeKeys: true })],
+ // ['scan query with raw flag', () => entity1.scan.go({ data: 'raw' })],
+ // ['scan query with includeKeys flag', () => entity1.scan.go({ data: 'includeKeys' })],
// ['scan query with ignoreOwnership flag', () => entity1.scan.go({ ignoreOwnership: true })],
['match query using default execution options', () => entity1.match({ id }).go()],
- ['match query with raw flag', () => entity1.match({ id }).go({ raw: true })],
- ['match query with includeKeys flag', () => entity1.match({ id }).go({ includeKeys: true })],
+ ['match query with raw flag', () => entity1.match({ id }).go({ data: 'raw' })],
+ ['match query with includeKeys flag', () => entity1.match({ id }).go({ data: 'includeKeys' })],
['match query with ignoreOwnership flag', () => entity1.match({ id }).go({ ignoreOwnership: true })],
['find query using default execution options', () => entity1.find({ id }).go()],
- ['find query with raw flag', () => entity1.find({ id }).go({ raw: true })],
- ['find query with includeKeys flag', () => entity1.find({ id }).go({ includeKeys: true })],
+ ['find query with raw flag', () => entity1.find({ id }).go({ data: 'raw' })],
+ ['find query with includeKeys flag', () => entity1.find({ id }).go({ data: 'includeKeys' })],
['find query with ignoreOwnership flag', () => entity1.find({ id }).go({ ignoreOwnership: true })],
['collection query using default execution options', () => service.collections.test({ id }).go()],
- ['collection query with raw flag', () => service.collections.test({ id }).go({ raw: true })],
- ['collection query with includeKeys flag', () => service.collections.test({ id }).go({ includeKeys: true })],
+ ['collection query with raw flag', () => service.collections.test({ id }).go({ data: 'raw' })],
+ ['collection query with includeKeys flag', () => service.collections.test({ id }).go({ data: 'includeKeys' })],
['collection query with ignoreOwnership flag', () => service.collections.test({ id }).go({ ignoreOwnership: true })],
];
@@ -774,7 +710,7 @@ describe("Query Pagination", () => {
// }).timeout(10000);
it("Should paginate and return raw results", async () => {
- let results = await tasks.scan.go({ raw: true });
+ let results = await tasks.scan.go({ data: 'raw' });
expect(results).to.have.keys(["cursor", "data"]);
expect(results.data.Items).to.not.be.undefined;
expect(results.data.Items).to.be.an("array");
@@ -954,7 +890,7 @@ describe("Query Pagination", () => {
},
],
});
- const pages = 3;
+ const pages = 'all';
const limit = 5;
const entity = new Tasks(TasksModel, { client, table });
const results = await entity.query
@@ -962,7 +898,7 @@ describe("Query Pagination", () => {
.go({ pages, limit })
.then((res) => res.data);
expect(results).to.be.an("array").with.length(6);
- expect(calls).to.have.length(2);
+ expect(calls).to.have.length(4);
for (let i = 0; i < calls.length; i++) {
const call = calls[i];
if (i === 0) {
@@ -1120,65 +1056,6 @@ describe("Query Pagination", () => {
}
});
- it("collection query should continue to query until 'limit' option is reached", async () => {
- const ExclusiveStartKey = { key: "hi" };
- const tasks = new Tasks(makeTasksModel(), { client, table });
- const tasks2 = new Tasks(makeTasksModel(), { client, table });
-
- await tasks.load(10);
- await tasks2.load(10);
- const [one, two, three, four, five, six] = tasks.data;
- const [seven, eight, nine, ten] = tasks2.data;
- const created = createClient({
- mockResponses: [
- {
- Items: [one, two, three, seven, eight, nine],
- LastEvaluatedKey: ExclusiveStartKey,
- },
- {
- Items: [four, five, six, ten],
- LastEvaluatedKey: ExclusiveStartKey,
- },
- {
- Items: [],
- LastEvaluatedKey: ExclusiveStartKey,
- },
- {
- Items: [],
- LastEvaluatedKey: undefined,
- },
- {
- Items: [],
- LastEvaluatedKey: ExclusiveStartKey,
- },
- ],
- });
- const service = new Service(
- { tasks, tasks2 },
- { client: created.client, table },
- );
- const pages = 3;
- const limit = 9;
- const employee = "my_employee";
- const results = await service.collections
- .assignments({ employee })
- .go({ pages, limit })
- .then((res) => res.data);
- expect(results.tasks).to.be.an("array").with.length(6);
- expect(results.tasks2).to.be.an("array").with.length(4);
- expect(created.calls).to.have.length(2);
- for (let i = 0; i < created.calls.length; i++) {
- const call = created.calls[i];
- if (i === 0) {
- expect(call.ExclusiveStartKey).to.be.undefined;
- } else {
- expect(call.ExclusiveStartKey.key).to.equal("hi");
- expect(call.ExclusiveStartKey.key === ExclusiveStartKey.key).to.be
- .true;
- }
- }
- });
-
it("collection query should only count entities belonging to the collection entities to fulfill 'limit' option requirements", async () => {
const ExclusiveStartKey = { key: "hi" };
const tasks = new Tasks(makeTasksModel(), { client, table });
@@ -1216,7 +1093,7 @@ describe("Query Pagination", () => {
{ tasks, tasks2 },
{ client: created.client, table },
);
- const pages = 3;
+ const pages = 'all' // 3;
const limit = 6;
const employee = "my_employee";
const results = await service.collections
@@ -1225,7 +1102,7 @@ describe("Query Pagination", () => {
.then((res) => res.data);
expect(results.tasks).to.be.an("array").with.length(4);
expect(results.tasks2).to.be.an("array").with.length(3);
- expect(created.calls).to.have.length(2);
+ expect(created.calls).to.have.length(4);
for (let i = 0; i < created.calls.length; i++) {
const call = created.calls[i];
if (i === 0) {
diff --git a/test/connected.service.spec.js b/test/connected.service.spec.js
index 38418d23..e265cba9 100644
--- a/test/connected.service.spec.js
+++ b/test/connected.service.spec.js
@@ -1,9 +1,8 @@
const sleep = async (ms) => new Promise((resolve) => setTimeout(resolve, ms));
process.env.AWS_NODEJS_CONNECTION_REUSE_ENABLED = 1;
-const { Entity, clauses } = require("../src/entity");
+const { Entity } = require("../src/entity");
const { Service } = require("../src/service");
const { expect } = require("chai");
-const moment = require("moment");
const uuid = require("uuid").v4;
const DynamoDB = require("aws-sdk/clients/dynamodb");
const table = "electro";
@@ -505,6 +504,11 @@ describe("Service Connected", () => {
entityThree: [recordThree],
});
+ expect(collectionF).to.deep.equal({
+ entityTwo: [recordTwo],
+ entityThree: [recordThree],
+ });
+
expect(collectionG).to.deep.equal({
entityTwo: [recordTwo],
});
@@ -898,7 +902,7 @@ describe("Entities with custom identifiers and versions", () => {
let collectionA = await service.collections
.collectionA({ prop1 })
.where(({ prop2 }, { eq }) => eq(prop2, "prop2Value"))
- .go({ raw: true })
+ .go({ data: 'raw' })
.then((res) => res.data)
.then((data) => ({ success: true, data }))
.catch((err) => ({ success: false, err }));
diff --git a/test/connected.update.spec.js b/test/connected.update.spec.js
index 5fa7c799..7132bf4b 100644
--- a/test/connected.update.spec.js
+++ b/test/connected.update.spec.js
@@ -1,6 +1,5 @@
process.env.AWS_NODEJS_CONNECTION_REUSE_ENABLED = 1;
const { Entity } = require("../src/entity");
-const { Service } = require("../src/service");
const { expect } = require("chai");
const uuid = require("uuid").v4;
const moment = require("moment");
@@ -1705,7 +1704,7 @@ describe("Update Item", () => {
const itemBefore = await users
.get({ username })
- .go({ raw: true })
+ .go({ data: 'raw' })
.then((res) => res.data);
expect(itemBefore).to.deep.equal({
@@ -1758,7 +1757,7 @@ describe("Update Item", () => {
const itemAfter = await users
.get({ username })
- .go({ raw: true })
+ .go({ data: 'raw' })
.then((res) => res.data);
expect(itemAfter).to.deep.equal({
@@ -1852,7 +1851,7 @@ describe("Update Item", () => {
const itemBefore = await users
.get({ username })
- .go({ raw: true })
+ .go({ data: 'raw' })
.then((res) => res.data);
expect(itemBefore).to.deep.equal({
@@ -1904,7 +1903,7 @@ describe("Update Item", () => {
const itemAfter = await users
.get({ username })
- .go({ raw: true })
+ .go({ data: 'raw' })
.then((res) => res.data);
expect(itemAfter).to.deep.equal({
@@ -1999,7 +1998,7 @@ describe("Update Item", () => {
const itemBefore = await users
.get({ username })
- .go({ raw: true })
+ .go({ data: 'raw' })
.then((res) => res.data);
expect(itemBefore).to.deep.equal({
diff --git a/test/connected.where.spec.js b/test/connected.where.spec.js
index 945ad8e1..32e5c89f 100644
--- a/test/connected.where.spec.js
+++ b/test/connected.where.spec.js
@@ -1,8 +1,7 @@
const sleep = async (ms) => new Promise((resolve) => setTimeout(resolve, ms));
process.env.AWS_NODEJS_CONNECTION_REUSE_ENABLED = 1;
-const { Entity, clauses } = require("../src/entity");
+const { Entity } = require("../src/entity");
const { expect } = require("chai");
-const moment = require("moment");
const uuidV4 = require("uuid").v4;
const DynamoDB = require("aws-sdk/clients/dynamodb");
const client = new DynamoDB.DocumentClient({
@@ -72,7 +71,7 @@ describe("Where Clause Queries", () => {
];
let penRows = [];
before(async () => {
- let results = await Promise.all(
+ await Promise.all(
animals.map((animal) => {
let row = uuidV4();
penRows.push({ pen, row, animal });
@@ -278,7 +277,7 @@ describe("Where Clause Queries", () => {
${name(animal)} = ${value(animal, penRow.animal)} AND ${notExists(dangerous)}
`,
)
- .go({ raw: true })
+ .go({ data: 'raw' })
.then((res) => res.data);
expect(results).to.be.empty;
let after = await WhereTests.get(penRow)
@@ -321,7 +320,7 @@ describe("Where Clause Queries", () => {
let doesExist = await WhereTests.patch(penRow)
.set({ dangerous: true })
.where(({ dangerous }, { notExists }) => notExists(dangerous))
- .go({ raw: true })
+ .go({ data: 'raw' })
.then(() => false)
.catch(() => true);
expect(doesExist).to.be.true;
diff --git a/test/generation/comparisonTests/generate.ts b/test/generation/comparisonTests/generate.ts
new file mode 100644
index 00000000..8db6e693
--- /dev/null
+++ b/test/generation/comparisonTests/generate.ts
@@ -0,0 +1,16 @@
+import { resolve } from 'path';
+import { writeFileSync } from 'fs';
+import { generateInitialConfiguration, generateTestCases } from "./testCaseGenerators";
+
+function main() {
+ const configuration = generateInitialConfiguration();
+ const testCases = generateTestCases(configuration);
+ const withoutEvaluation = testCases.filter((testCase) => testCase.evaluations.length === 0);
+ if (withoutEvaluation.length > 0) {
+ console.log(JSON.stringify({ withoutEvaluation }, null, 4));
+ throw new Error(`Some did not have evaluations, ${withoutEvaluation.length}`);
+ }
+ writeFileSync(resolve(__dirname, './testCases.json'), JSON.stringify(testCases, null, 2));
+}
+
+main();
\ No newline at end of file
diff --git a/test/generation/comparisonTests/inputs.ts b/test/generation/comparisonTests/inputs.ts
new file mode 100644
index 00000000..d5eda5d6
--- /dev/null
+++ b/test/generation/comparisonTests/inputs.ts
@@ -0,0 +1,178 @@
+import { Entity, EntityRecord, ExecutionOptionCompare, Service } from "../../../index";
+import { bool } from "aws-sdk/clients/signer";
+
+const table = 'electro';
+
+export const Attraction = new Entity({
+ model: {
+ entity: 'attraction',
+ service: 'comparison',
+ version: '1'
+ },
+ attributes: {
+ name: {
+ type: 'string'
+ },
+ country: {
+ type: 'string'
+ },
+ state: {
+ type: 'string'
+ },
+ county: {
+ type: 'string'
+ },
+ city: {
+ type: 'string'
+ },
+ zip: {
+ type: 'string'
+ }
+ },
+ indexes: {
+ location: {
+ pk: {
+ field: 'pk',
+ composite: ['country', 'state']
+ },
+ sk: {
+ field: 'sk',
+ composite: ['county', 'city', 'zip', 'name']
+ }
+ },
+ clusteredLocation: {
+ index: 'gsi1pk-gsi1sk-index',
+ collection: ['clusteredRegion'],
+ type: 'clustered',
+ pk: {
+ field: 'gsi1pk',
+ composite: ['country', 'state']
+ },
+ sk: {
+ field: 'gsi1sk',
+ composite: ['county', 'city', 'zip', 'name']
+ }
+ },
+ isolatedLocation: {
+ index: 'gsi2pk-gsi2sk-index',
+ collection: ['isolatedRegion'],
+ type: 'isolated',
+ pk: {
+ field: 'gsi2pk',
+ composite: ['country', 'state']
+ },
+ sk: {
+ field: 'gsi2sk',
+ composite: ['county', 'city', 'zip', 'name']
+ }
+ }
+ }
+}, { table });
+
+export const AttractionService = new Service({ Attraction });
+
+type Exhaustive = {
+ [K in T]: K;
+}
+
+export type AttractionIndexes = keyof typeof Attraction['query'];
+
+export const indexes: Exhaustive = {
+ clusteredLocation: 'clusteredLocation',
+ isolatedLocation: 'isolatedLocation',
+ location: 'location',
+}
+
+export const indexTypes: Record = {
+ clusteredLocation: 'clustered',
+ isolatedLocation: 'isolated',
+ location: 'isolated',
+}
+
+export const indexHasCollection: Record = {
+ clusteredLocation: true,
+ isolatedLocation: true,
+ location: false,
+}
+
+type AttractionCollections = keyof typeof AttractionService['collections'];
+
+export const collections: Exhaustive = {
+ clusteredRegion: 'clusteredRegion',
+ isolatedRegion: 'isolatedRegion',
+}
+
+export const collectionTypes: Record = {
+ clusteredRegion: 'clustered',
+ isolatedRegion: 'isolated',
+}
+
+export const comparisons: Exhaustive = {
+ attributes: 'attributes',
+ keys: "keys",
+ v2: 'v2',
+};
+
+export type Operators = "" | "gte" | "gt" | "lt" | "lte" | "between" | "begins";
+
+export const operators: Exhaustive = {
+ "": "",
+ gte: "gte",
+ gt: "gt",
+ lt: "lt",
+ lte: "lte",
+ between: "between",
+ begins: "begins",
+}
+
+export const data: EntityRecord = {
+ country: 'USA',
+ state: 'Wisconsin',
+ county: 'Dane',
+ city: 'Madison',
+ zip: '53713',
+ name: 'Veterans Memorial Coliseum',
+}
+
+export const {
+ country,
+ county,
+ state,
+ city,
+ zip,
+ name
+} = data;
+
+export const pks = new Set(['country', 'state']);
+export const sks = new Set(['county', 'city', 'zip', 'name']);
+
+export const operatorParts = {
+ "": [{country, state, county, city}],
+ gte: [{country, state}, {county, city}],
+ gt: [{country, state}, {county, city}],
+ lt: [{country, state}, {county, city}],
+ lte: [{country, state}, {county, city}],
+ between: [{country, state}, {county, city: 'Madison'}, {county, city: 'Marshall'}],
+ begins: [{country, state}, {county, city}],
+} as const;
+
+export type OperatorParts = typeof operatorParts
+
+export type ValuesOf = {
+ [K in keyof T]: T[K]
+}[keyof T];
+
+export type ConfigurationItem =
+ {
+ hasCollection: boolean;
+ operator: Operators;
+ parts: ValuesOf