dyno-table 0.2.0-0 → 1.0.0-alpha.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +182 -577
- package/dist/{table.cjs → index.cjs} +175 -87
- package/dist/index.d.cts +2971 -0
- package/dist/index.d.ts +2971 -0
- package/dist/{table.js → index.js} +127 -86
- package/package.json +10 -77
- package/dist/builder-types-C_PDZhnP.d.ts +0 -118
- package/dist/builder-types-DtwbqMeF.d.cts +0 -118
- package/dist/builders/condition-check-builder.cjs +0 -394
- package/dist/builders/condition-check-builder.cjs.map +0 -1
- package/dist/builders/condition-check-builder.d.cts +0 -157
- package/dist/builders/condition-check-builder.d.ts +0 -157
- package/dist/builders/condition-check-builder.js +0 -392
- package/dist/builders/condition-check-builder.js.map +0 -1
- package/dist/builders/delete-builder.cjs +0 -405
- package/dist/builders/delete-builder.cjs.map +0 -1
- package/dist/builders/delete-builder.d.cts +0 -166
- package/dist/builders/delete-builder.d.ts +0 -166
- package/dist/builders/delete-builder.js +0 -403
- package/dist/builders/delete-builder.js.map +0 -1
- package/dist/builders/paginator.cjs +0 -199
- package/dist/builders/paginator.cjs.map +0 -1
- package/dist/builders/paginator.d.cts +0 -179
- package/dist/builders/paginator.d.ts +0 -179
- package/dist/builders/paginator.js +0 -197
- package/dist/builders/paginator.js.map +0 -1
- package/dist/builders/put-builder.cjs +0 -476
- package/dist/builders/put-builder.cjs.map +0 -1
- package/dist/builders/put-builder.d.cts +0 -274
- package/dist/builders/put-builder.d.ts +0 -274
- package/dist/builders/put-builder.js +0 -474
- package/dist/builders/put-builder.js.map +0 -1
- package/dist/builders/query-builder.cjs +0 -674
- package/dist/builders/query-builder.cjs.map +0 -1
- package/dist/builders/query-builder.d.cts +0 -6
- package/dist/builders/query-builder.d.ts +0 -6
- package/dist/builders/query-builder.js +0 -672
- package/dist/builders/query-builder.js.map +0 -1
- package/dist/builders/transaction-builder.cjs +0 -894
- package/dist/builders/transaction-builder.cjs.map +0 -1
- package/dist/builders/transaction-builder.d.cts +0 -511
- package/dist/builders/transaction-builder.d.ts +0 -511
- package/dist/builders/transaction-builder.js +0 -892
- package/dist/builders/transaction-builder.js.map +0 -1
- package/dist/builders/update-builder.cjs +0 -627
- package/dist/builders/update-builder.cjs.map +0 -1
- package/dist/builders/update-builder.d.cts +0 -365
- package/dist/builders/update-builder.d.ts +0 -365
- package/dist/builders/update-builder.js +0 -625
- package/dist/builders/update-builder.js.map +0 -1
- package/dist/conditions--ld9a78i.d.ts +0 -331
- package/dist/conditions-ChhQWd6z.d.cts +0 -331
- package/dist/conditions.cjs +0 -59
- package/dist/conditions.cjs.map +0 -1
- package/dist/conditions.d.cts +0 -3
- package/dist/conditions.d.ts +0 -3
- package/dist/conditions.js +0 -43
- package/dist/conditions.js.map +0 -1
- package/dist/entity.cjs +0 -228
- package/dist/entity.cjs.map +0 -1
- package/dist/entity.d.cts +0 -149
- package/dist/entity.d.ts +0 -149
- package/dist/entity.js +0 -224
- package/dist/entity.js.map +0 -1
- package/dist/query-builder-Csror9Iu.d.ts +0 -507
- package/dist/query-builder-D2FM9rsu.d.cts +0 -507
- package/dist/standard-schema.cjs +0 -4
- package/dist/standard-schema.cjs.map +0 -1
- package/dist/standard-schema.d.cts +0 -57
- package/dist/standard-schema.d.ts +0 -57
- package/dist/standard-schema.js +0 -3
- package/dist/standard-schema.js.map +0 -1
- package/dist/table-BEhBPy2G.d.cts +0 -364
- package/dist/table-BW3cmUqr.d.ts +0 -364
- package/dist/table.cjs.map +0 -1
- package/dist/table.d.cts +0 -12
- package/dist/table.d.ts +0 -12
- package/dist/table.js.map +0 -1
- package/dist/types.cjs +0 -4
- package/dist/types.cjs.map +0 -1
- package/dist/types.d.cts +0 -22
- package/dist/types.d.ts +0 -22
- package/dist/types.js +0 -3
- package/dist/types.js.map +0 -1
- package/dist/utils/partition-key-template.cjs +0 -19
- package/dist/utils/partition-key-template.cjs.map +0 -1
- package/dist/utils/partition-key-template.d.cts +0 -32
- package/dist/utils/partition-key-template.d.ts +0 -32
- package/dist/utils/partition-key-template.js +0 -17
- package/dist/utils/partition-key-template.js.map +0 -1
- package/dist/utils/sort-key-template.cjs +0 -19
- package/dist/utils/sort-key-template.cjs.map +0 -1
- package/dist/utils/sort-key-template.d.cts +0 -35
- package/dist/utils/sort-key-template.d.ts +0 -35
- package/dist/utils/sort-key-template.js +0 -17
- package/dist/utils/sort-key-template.js.map +0 -1
|
@@ -1,331 +0,0 @@
|
|
|
1
|
-
import { DynamoItem } from './types.cjs';
|
|
2
|
-
|
|
3
|
-
type Primitive = null | undefined | string | number | boolean | symbol | bigint;
|
|
4
|
-
type IsEqual<T1, T2> = T1 extends T2 ? (<G>() => G extends T1 ? 1 : 2) extends <G>() => G extends T2 ? 1 : 2 ? true : false : false;
|
|
5
|
-
interface File extends Blob {
|
|
6
|
-
readonly lastModified: number;
|
|
7
|
-
readonly name: string;
|
|
8
|
-
}
|
|
9
|
-
interface FileList {
|
|
10
|
-
readonly length: number;
|
|
11
|
-
item(index: number): File | null;
|
|
12
|
-
[index: number]: File;
|
|
13
|
-
}
|
|
14
|
-
type BrowserNativeObject = Date | FileList | File;
|
|
15
|
-
type IsTuple<T extends ReadonlyArray<any>> = number extends T["length"] ? false : true;
|
|
16
|
-
type TupleKeys<T extends ReadonlyArray<any>> = Exclude<keyof T, keyof any[]>;
|
|
17
|
-
type AnyIsEqual<T1, T2> = T1 extends T2 ? (IsEqual<T1, T2> extends true ? true : never) : never;
|
|
18
|
-
type PathImpl<K extends string | number, V, TraversedTypes> = V extends Primitive | BrowserNativeObject ? `${K}` : true extends AnyIsEqual<TraversedTypes, V> ? `${K}` : `${K}` | `${K}.${PathInternal<V, TraversedTypes | V>}`;
|
|
19
|
-
type ArrayKey = number;
|
|
20
|
-
type PathInternal<T, TraversedTypes = T> = T extends ReadonlyArray<infer V> ? IsTuple<T> extends true ? {
|
|
21
|
-
[K in TupleKeys<T>]-?: PathImpl<K & string, T[K], TraversedTypes>;
|
|
22
|
-
}[TupleKeys<T>] : PathImpl<ArrayKey, V, TraversedTypes> : {
|
|
23
|
-
[K in keyof T]-?: PathImpl<K & string, T[K], TraversedTypes>;
|
|
24
|
-
}[keyof T];
|
|
25
|
-
type Path<T> = T extends any ? PathInternal<T> : never;
|
|
26
|
-
type PathType<T, K extends keyof any> = K extends `${infer Key}.${infer Rest}` ? Key extends keyof T ? Rest extends keyof any ? PathType<T[Key], Rest> : never : never : K extends keyof T ? T[K] : never;
|
|
27
|
-
|
|
28
|
-
/**
|
|
29
|
-
* Supported comparison operators for DynamoDB conditions.
|
|
30
|
-
* @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html AWS DynamoDB - Comparison Operator Reference}
|
|
31
|
-
*
|
|
32
|
-
* - eq: Equals (=)
|
|
33
|
-
* - ne: Not equals (≠ / <>)
|
|
34
|
-
* - lt: Less than (<)
|
|
35
|
-
* - lte: Less than or equal to (≤)
|
|
36
|
-
* - gt: Greater than (>)
|
|
37
|
-
* - gte: Greater than or equal to (≥)
|
|
38
|
-
* - between: Between two values (inclusive)
|
|
39
|
-
* - beginsWith: Checks if string attribute begins with specified substring
|
|
40
|
-
* - contains: Checks if string/set attribute contains specified value
|
|
41
|
-
* - attributeExists: Checks if attribute exists
|
|
42
|
-
* - attributeNotExists: Checks if attribute does not exist
|
|
43
|
-
*/
|
|
44
|
-
type ComparisonOperator = "eq" | "ne" | "lt" | "lte" | "gt" | "gte" | "between" | "beginsWith" | "contains" | "attributeExists" | "attributeNotExists";
|
|
45
|
-
/**
|
|
46
|
-
* Logical operators for combining multiple conditions.
|
|
47
|
-
* @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Logical AWS DynamoDB - Logical Operator Reference}
|
|
48
|
-
*
|
|
49
|
-
* - and: Evaluates to true if all conditions are true
|
|
50
|
-
* - or: Evaluates to true if any condition is true
|
|
51
|
-
* - not: Negate the result of a condition
|
|
52
|
-
*/
|
|
53
|
-
type LogicalOperator = "and" | "or" | "not";
|
|
54
|
-
/**
|
|
55
|
-
* Represents a DynamoDB condition expression.
|
|
56
|
-
* Can be either a comparison condition or a logical combination of conditions.
|
|
57
|
-
*
|
|
58
|
-
* @example
|
|
59
|
-
* // Simple comparison condition
|
|
60
|
-
* const condition: Condition = {
|
|
61
|
-
* type: "eq",
|
|
62
|
-
* attr: "status",
|
|
63
|
-
* value: "ACTIVE"
|
|
64
|
-
* };
|
|
65
|
-
*
|
|
66
|
-
* @example
|
|
67
|
-
* // Logical combination of conditions
|
|
68
|
-
* const condition: Condition = {
|
|
69
|
-
* type: "and",
|
|
70
|
-
* conditions: [
|
|
71
|
-
* { type: "eq", attr: "status", value: "ACTIVE" },
|
|
72
|
-
* { type: "gt", attr: "age", value: 5 }
|
|
73
|
-
* ]
|
|
74
|
-
* };
|
|
75
|
-
*/
|
|
76
|
-
interface Condition {
|
|
77
|
-
/** The type of condition (comparison or logical operator) */
|
|
78
|
-
type: ComparisonOperator | LogicalOperator;
|
|
79
|
-
/** The attribute name for comparison conditions */
|
|
80
|
-
attr?: string;
|
|
81
|
-
/** The value to compare against for comparison conditions */
|
|
82
|
-
value?: unknown;
|
|
83
|
-
/** Array of conditions for logical operators (and/or) */
|
|
84
|
-
conditions?: Condition[];
|
|
85
|
-
/** Single condition for the 'not' operator */
|
|
86
|
-
condition?: Condition;
|
|
87
|
-
}
|
|
88
|
-
/**
|
|
89
|
-
* Parameters used to build DynamoDB expression strings.
|
|
90
|
-
* @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ExpressionAttributeNames.html Expression Attribute Names}
|
|
91
|
-
* @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ExpressionAttributeValues.html Expression Attribute Values}
|
|
92
|
-
*/
|
|
93
|
-
interface ExpressionParams {
|
|
94
|
-
/** Map of attribute name placeholders to actual attribute names */
|
|
95
|
-
expressionAttributeNames: Record<string, string>;
|
|
96
|
-
/** Map of value placeholders to actual values */
|
|
97
|
-
expressionAttributeValues: DynamoItem;
|
|
98
|
-
/** Counter for generating unique value placeholders */
|
|
99
|
-
valueCounter: {
|
|
100
|
-
count: number;
|
|
101
|
-
};
|
|
102
|
-
}
|
|
103
|
-
/**
|
|
104
|
-
* Creates a comparison condition builder function for the specified operator.
|
|
105
|
-
* @internal
|
|
106
|
-
*/
|
|
107
|
-
declare const createComparisonCondition: (type: ComparisonOperator) => (attr: string, value: unknown) => Condition;
|
|
108
|
-
/**
|
|
109
|
-
* Creates an equals (=) condition
|
|
110
|
-
* @example
|
|
111
|
-
* eq("status", "ACTIVE") // status = "ACTIVE"
|
|
112
|
-
* @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html}
|
|
113
|
-
*/
|
|
114
|
-
declare const eq: (attr: string, value: unknown) => Condition;
|
|
115
|
-
/**
|
|
116
|
-
* Creates a not equals (≠) condition
|
|
117
|
-
* @example
|
|
118
|
-
* ne("status", "DELETED") // status <> "DELETED"
|
|
119
|
-
* @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html}
|
|
120
|
-
*/
|
|
121
|
-
declare const ne: (attr: string, value: unknown) => Condition;
|
|
122
|
-
/**
|
|
123
|
-
* Creates a less than (<) condition
|
|
124
|
-
* @example
|
|
125
|
-
* lt("age", 18) // age < 18
|
|
126
|
-
* @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html}
|
|
127
|
-
*/
|
|
128
|
-
declare const lt: (attr: string, value: unknown) => Condition;
|
|
129
|
-
/**
|
|
130
|
-
* Creates a less than or equal to (≤) condition
|
|
131
|
-
* @example
|
|
132
|
-
* lte("age", 18) // age <= 18
|
|
133
|
-
* @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html}
|
|
134
|
-
*/
|
|
135
|
-
declare const lte: (attr: string, value: unknown) => Condition;
|
|
136
|
-
/**
|
|
137
|
-
* Creates a greater than (>) condition
|
|
138
|
-
* @example
|
|
139
|
-
* gt("price", 100) // price > 100
|
|
140
|
-
* @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html}
|
|
141
|
-
*/
|
|
142
|
-
declare const gt: (attr: string, value: unknown) => Condition;
|
|
143
|
-
/**
|
|
144
|
-
* Creates a greater than or equal to (≥) condition
|
|
145
|
-
* @example
|
|
146
|
-
* gte("price", 100) // price >= 100
|
|
147
|
-
* @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html}
|
|
148
|
-
*/
|
|
149
|
-
declare const gte: (attr: string, value: unknown) => Condition;
|
|
150
|
-
/**
|
|
151
|
-
* Creates a between condition that checks if a value is within a range (inclusive)
|
|
152
|
-
* @example
|
|
153
|
-
* between("age", 18, 65) // age BETWEEN 18 AND 65
|
|
154
|
-
* @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Comparators AWS DynamoDB - BETWEEN}
|
|
155
|
-
*/
|
|
156
|
-
declare const between: (attr: string, lower: unknown, upper: unknown) => Condition;
|
|
157
|
-
/**
|
|
158
|
-
* Creates a begins_with condition that checks if a string attribute starts with a substring
|
|
159
|
-
* @example
|
|
160
|
-
* beginsWith("email", "@example.com") // begins_with(email, "@example.com")
|
|
161
|
-
* @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Functions AWS DynamoDB - begins_with}
|
|
162
|
-
*/
|
|
163
|
-
declare const beginsWith: (attr: string, value: unknown) => Condition;
|
|
164
|
-
/**
|
|
165
|
-
* Creates a contains condition that checks if a string contains a substring or if a set contains an element
|
|
166
|
-
* @example
|
|
167
|
-
* contains("tags", "important") // contains(tags, "important")
|
|
168
|
-
* @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Functions AWS DynamoDB - contains}
|
|
169
|
-
*/
|
|
170
|
-
declare const contains: (attr: string, value: unknown) => Condition;
|
|
171
|
-
/**
|
|
172
|
-
* Creates a condition that checks if an attribute exists
|
|
173
|
-
* @example
|
|
174
|
-
* attributeExists("email") // attribute_exists(email)
|
|
175
|
-
* @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Functions AWS DynamoDB - attribute_exists}
|
|
176
|
-
*/
|
|
177
|
-
declare const attributeExists: (attr: string) => Condition;
|
|
178
|
-
/**
|
|
179
|
-
* Creates a condition that checks if an attribute does not exist
|
|
180
|
-
* @example
|
|
181
|
-
* attributeNotExists("deletedAt") // attribute_not_exists(deletedAt)
|
|
182
|
-
* @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Functions AWS DynamoDB - attribute_not_exists}
|
|
183
|
-
*/
|
|
184
|
-
declare const attributeNotExists: (attr: string) => Condition;
|
|
185
|
-
/**
|
|
186
|
-
* Combines multiple conditions with AND operator
|
|
187
|
-
* @example
|
|
188
|
-
* and(
|
|
189
|
-
* eq("status", "ACTIVE"),
|
|
190
|
-
* gt("age", 18)
|
|
191
|
-
* ) // status = "ACTIVE" AND age > 18
|
|
192
|
-
* @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Logical AWS DynamoDB - AND}
|
|
193
|
-
*/
|
|
194
|
-
declare const and: (...conditions: Condition[]) => Condition;
|
|
195
|
-
/**
|
|
196
|
-
* Combines multiple conditions with OR operator
|
|
197
|
-
* @example
|
|
198
|
-
* or(
|
|
199
|
-
* eq("status", "PENDING"),
|
|
200
|
-
* eq("status", "PROCESSING")
|
|
201
|
-
* ) // status = "PENDING" OR status = "PROCESSING"
|
|
202
|
-
* @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Logical AWS DynamoDB - OR}
|
|
203
|
-
*/
|
|
204
|
-
declare const or: (...conditions: Condition[]) => Condition;
|
|
205
|
-
/**
|
|
206
|
-
* Negates a condition
|
|
207
|
-
* @example
|
|
208
|
-
* not(eq("status", "DELETED")) // NOT status = "DELETED"
|
|
209
|
-
* @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Logical AWS DynamoDB - NOT}
|
|
210
|
-
*/
|
|
211
|
-
declare const not: (condition: Condition) => Condition;
|
|
212
|
-
/**
|
|
213
|
-
* Type-safe operators for building key conditions in DynamoDB queries.
|
|
214
|
-
* Only includes operators that are valid for key conditions.
|
|
215
|
-
* @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html#Query.KeyConditionExpressions AWS DynamoDB - Key Condition Expressions}
|
|
216
|
-
*
|
|
217
|
-
* @example
|
|
218
|
-
* // Using with sort key conditions
|
|
219
|
-
* table.query({
|
|
220
|
-
* pk: "USER#123",
|
|
221
|
-
* sk: op => op.beginsWith("ORDER#")
|
|
222
|
-
* })
|
|
223
|
-
*/
|
|
224
|
-
type KeyConditionOperator = {
|
|
225
|
-
/** Equals comparison for key attributes */
|
|
226
|
-
eq: (value: unknown) => Condition;
|
|
227
|
-
/** Less than comparison for key attributes */
|
|
228
|
-
lt: (value: unknown) => Condition;
|
|
229
|
-
/** Less than or equal comparison for key attributes */
|
|
230
|
-
lte: (value: unknown) => Condition;
|
|
231
|
-
/** Greater than comparison for key attributes */
|
|
232
|
-
gt: (value: unknown) => Condition;
|
|
233
|
-
/** Greater than or equal comparison for key attributes */
|
|
234
|
-
gte: (value: unknown) => Condition;
|
|
235
|
-
/** Between range comparison for key attributes */
|
|
236
|
-
between: (lower: unknown, upper: unknown) => Condition;
|
|
237
|
-
/** Begins with comparison for key attributes */
|
|
238
|
-
beginsWith: (value: unknown) => Condition;
|
|
239
|
-
/** Combines multiple key conditions with AND */
|
|
240
|
-
and: (...conditions: Condition[]) => Condition;
|
|
241
|
-
};
|
|
242
|
-
/**
|
|
243
|
-
* Type-safe operators for building conditions in DynamoDB operations.
|
|
244
|
-
* Includes all available condition operators with proper type inference.
|
|
245
|
-
* @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html AWS DynamoDB - Condition Expressions}
|
|
246
|
-
*
|
|
247
|
-
* @example
|
|
248
|
-
* // Using with type-safe conditions
|
|
249
|
-
* interface User {
|
|
250
|
-
* status: string;
|
|
251
|
-
* age: number;
|
|
252
|
-
* email?: string;
|
|
253
|
-
* }
|
|
254
|
-
*
|
|
255
|
-
* table.scan<User>()
|
|
256
|
-
* .where(op => op.and(
|
|
257
|
-
* op.eq("status", "ACTIVE"),
|
|
258
|
-
* op.gt("age", 18),
|
|
259
|
-
* op.attributeExists("email")
|
|
260
|
-
* ))
|
|
261
|
-
*
|
|
262
|
-
* @template T The type of the item being operated on
|
|
263
|
-
*/
|
|
264
|
-
type ConditionOperator<T extends DynamoItem> = {
|
|
265
|
-
eq: <K extends Path<T>>(attr: K, value: PathType<T, K>) => Condition;
|
|
266
|
-
ne: <K extends Path<T>>(attr: K, value: PathType<T, K>) => Condition;
|
|
267
|
-
lt: <K extends Path<T>>(attr: K, value: PathType<T, K>) => Condition;
|
|
268
|
-
lte: <K extends Path<T>>(attr: K, value: PathType<T, K>) => Condition;
|
|
269
|
-
gt: <K extends Path<T>>(attr: K, value: PathType<T, K>) => Condition;
|
|
270
|
-
gte: <K extends Path<T>>(attr: K, value: PathType<T, K>) => Condition;
|
|
271
|
-
between: <K extends Path<T>>(attr: K, lower: PathType<T, K>, upper: PathType<T, K>) => Condition;
|
|
272
|
-
beginsWith: <K extends Path<T>>(attr: K, value: PathType<T, K>) => Condition;
|
|
273
|
-
contains: <K extends Path<T>>(attr: K, value: PathType<T, K>) => Condition;
|
|
274
|
-
attributeExists: <K extends Path<T>>(attr: K) => Condition;
|
|
275
|
-
attributeNotExists: <K extends Path<T>>(attr: K) => Condition;
|
|
276
|
-
and: (...conditions: Condition[]) => Condition;
|
|
277
|
-
or: (...conditions: Condition[]) => Condition;
|
|
278
|
-
not: (condition: Condition) => Condition;
|
|
279
|
-
};
|
|
280
|
-
/**
|
|
281
|
-
* Primary key type for QUERY operations.
|
|
282
|
-
* Allows building complex key conditions for the sort key.
|
|
283
|
-
* @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html AWS DynamoDB - Query Operations}
|
|
284
|
-
*
|
|
285
|
-
* @example
|
|
286
|
-
* // Query items with a specific partition key and sort key prefix
|
|
287
|
-
* table.query({
|
|
288
|
-
* pk: "USER#123",
|
|
289
|
-
* sk: op => op.beginsWith("ORDER#2023")
|
|
290
|
-
* })
|
|
291
|
-
*
|
|
292
|
-
* @example
|
|
293
|
-
* // Query items within a specific sort key range
|
|
294
|
-
* table.query({
|
|
295
|
-
* pk: "USER#123",
|
|
296
|
-
* sk: op => op.between("ORDER#2023-01", "ORDER#2023-12")
|
|
297
|
-
* })
|
|
298
|
-
*/
|
|
299
|
-
type PrimaryKey = {
|
|
300
|
-
/** Partition key value */
|
|
301
|
-
pk: string;
|
|
302
|
-
/** Optional sort key condition builder */
|
|
303
|
-
sk?: (op: KeyConditionOperator) => Condition;
|
|
304
|
-
};
|
|
305
|
-
/**
|
|
306
|
-
* Primary key type for GET and DELETE operations.
|
|
307
|
-
* Used when you need to specify exact key values without conditions.
|
|
308
|
-
* @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html AWS DynamoDB - Working with Items}
|
|
309
|
-
*
|
|
310
|
-
* @example
|
|
311
|
-
* // Get a specific item by its complete primary key
|
|
312
|
-
* table.get({
|
|
313
|
-
* pk: "USER#123",
|
|
314
|
-
* sk: "PROFILE#123"
|
|
315
|
-
* })
|
|
316
|
-
*
|
|
317
|
-
* @example
|
|
318
|
-
* // Delete a specific item by its complete primary key
|
|
319
|
-
* table.delete({
|
|
320
|
-
* pk: "USER#123",
|
|
321
|
-
* sk: "ORDER#456"
|
|
322
|
-
* })
|
|
323
|
-
*/
|
|
324
|
-
type PrimaryKeyWithoutExpression = {
|
|
325
|
-
/** Partition key value */
|
|
326
|
-
pk: string;
|
|
327
|
-
/** Optional sort key value */
|
|
328
|
-
sk?: string;
|
|
329
|
-
};
|
|
330
|
-
|
|
331
|
-
export { type Condition as C, type ExpressionParams as E, type KeyConditionOperator as K, type LogicalOperator as L, type PrimaryKeyWithoutExpression as P, type PrimaryKey as a, type ConditionOperator as b, type Path as c, type PathType as d, type ComparisonOperator as e, createComparisonCondition as f, eq as g, lte as h, gt as i, gte as j, between as k, lt as l, beginsWith as m, ne as n, contains as o, attributeExists as p, attributeNotExists as q, and as r, or as s, not as t };
|
package/dist/conditions.cjs
DELETED
|
@@ -1,59 +0,0 @@
|
|
|
1
|
-
'use strict';
|
|
2
|
-
|
|
3
|
-
// src/conditions.ts
|
|
4
|
-
var createComparisonCondition = (type) => (attr, value) => ({
|
|
5
|
-
type,
|
|
6
|
-
attr,
|
|
7
|
-
value
|
|
8
|
-
});
|
|
9
|
-
var eq = createComparisonCondition("eq");
|
|
10
|
-
var ne = createComparisonCondition("ne");
|
|
11
|
-
var lt = createComparisonCondition("lt");
|
|
12
|
-
var lte = createComparisonCondition("lte");
|
|
13
|
-
var gt = createComparisonCondition("gt");
|
|
14
|
-
var gte = createComparisonCondition("gte");
|
|
15
|
-
var between = (attr, lower, upper) => ({
|
|
16
|
-
type: "between",
|
|
17
|
-
attr,
|
|
18
|
-
value: [lower, upper]
|
|
19
|
-
});
|
|
20
|
-
var beginsWith = createComparisonCondition("beginsWith");
|
|
21
|
-
var contains = createComparisonCondition("contains");
|
|
22
|
-
var attributeExists = (attr) => ({
|
|
23
|
-
type: "attributeExists",
|
|
24
|
-
attr
|
|
25
|
-
});
|
|
26
|
-
var attributeNotExists = (attr) => ({
|
|
27
|
-
type: "attributeNotExists",
|
|
28
|
-
attr
|
|
29
|
-
});
|
|
30
|
-
var and = (...conditions) => ({
|
|
31
|
-
type: "and",
|
|
32
|
-
conditions
|
|
33
|
-
});
|
|
34
|
-
var or = (...conditions) => ({
|
|
35
|
-
type: "or",
|
|
36
|
-
conditions
|
|
37
|
-
});
|
|
38
|
-
var not = (condition) => ({
|
|
39
|
-
type: "not",
|
|
40
|
-
condition
|
|
41
|
-
});
|
|
42
|
-
|
|
43
|
-
exports.and = and;
|
|
44
|
-
exports.attributeExists = attributeExists;
|
|
45
|
-
exports.attributeNotExists = attributeNotExists;
|
|
46
|
-
exports.beginsWith = beginsWith;
|
|
47
|
-
exports.between = between;
|
|
48
|
-
exports.contains = contains;
|
|
49
|
-
exports.createComparisonCondition = createComparisonCondition;
|
|
50
|
-
exports.eq = eq;
|
|
51
|
-
exports.gt = gt;
|
|
52
|
-
exports.gte = gte;
|
|
53
|
-
exports.lt = lt;
|
|
54
|
-
exports.lte = lte;
|
|
55
|
-
exports.ne = ne;
|
|
56
|
-
exports.not = not;
|
|
57
|
-
exports.or = or;
|
|
58
|
-
//# sourceMappingURL=conditions.cjs.map
|
|
59
|
-
//# sourceMappingURL=conditions.cjs.map
|
package/dist/conditions.cjs.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/conditions.ts"],"names":[],"mappings":";;;AA+FO,IAAM,yBACX,GAAA,CAAC,IACD,KAAA,CAAC,MAAc,KAA+B,MAAA;AAAA,EAC5C,IAAA;AAAA,EACA,IAAA;AAAA,EACA;AACF,CAAA;AAQW,IAAA,EAAA,GAAK,0BAA0B,IAAI;AAQnC,IAAA,EAAA,GAAK,0BAA0B,IAAI;AAQnC,IAAA,EAAA,GAAK,0BAA0B,IAAI;AAQnC,IAAA,GAAA,GAAM,0BAA0B,KAAK;AAQrC,IAAA,EAAA,GAAK,0BAA0B,IAAI;AAQnC,IAAA,GAAA,GAAM,0BAA0B,KAAK;AAQ3C,IAAM,OAAU,GAAA,CAAC,IAAc,EAAA,KAAA,EAAgB,KAA+B,MAAA;AAAA,EACnF,IAAM,EAAA,SAAA;AAAA,EACN,IAAA;AAAA,EACA,KAAA,EAAO,CAAC,KAAA,EAAO,KAAK;AACtB,CAAA;AAQa,IAAA,UAAA,GAAa,0BAA0B,YAAY;AAQnD,IAAA,QAAA,GAAW,0BAA0B,UAAU;AAQ/C,IAAA,eAAA,GAAkB,CAAC,IAA6B,MAAA;AAAA,EAC3D,IAAM,EAAA,iBAAA;AAAA,EACN;AACF,CAAA;AAQa,IAAA,kBAAA,GAAqB,CAAC,IAA6B,MAAA;AAAA,EAC9D,IAAM,EAAA,oBAAA;AAAA,EACN;AACF,CAAA;AAaa,IAAA,GAAA,GAAM,IAAI,UAAwC,MAAA;AAAA,EAC7D,IAAM,EAAA,KAAA;AAAA,EACN;AACF,CAAA;AAWa,IAAA,EAAA,GAAK,IAAI,UAAwC,MAAA;AAAA,EAC5D,IAAM,EAAA,IAAA;AAAA,EACN;AACF,CAAA;AAQa,IAAA,GAAA,GAAM,CAAC,SAAqC,MAAA;AAAA,EACvD,IAAM,EAAA,KAAA;AAAA,EACN;AACF,CAAA","file":"conditions.cjs","sourcesContent":["import type { Path, PathType } from \"./builders/types\";\nimport type { DynamoItem } from \"./types\";\n\n/**\n * Supported comparison operators for DynamoDB conditions.\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html AWS DynamoDB - Comparison Operator Reference}\n *\n * - eq: Equals (=)\n * - ne: Not equals (≠ / <>)\n * - lt: Less than (<)\n * - lte: Less than or equal to (≤)\n * - gt: Greater than (>)\n * - gte: Greater than or equal to (≥)\n * - between: Between two values (inclusive)\n * - beginsWith: Checks if string attribute begins with specified substring\n * - contains: Checks if string/set attribute contains specified value\n * - attributeExists: Checks if attribute exists\n * - attributeNotExists: Checks if attribute does not exist\n */\nexport type ComparisonOperator =\n | \"eq\"\n | \"ne\"\n | \"lt\"\n | \"lte\"\n | \"gt\"\n | \"gte\"\n | \"between\"\n | \"beginsWith\"\n | \"contains\"\n | \"attributeExists\"\n | \"attributeNotExists\";\n\n/**\n * Logical operators for combining multiple conditions.\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Logical AWS DynamoDB - Logical Operator Reference}\n *\n * - and: Evaluates to true if all conditions are true\n * - or: Evaluates to true if any condition is true\n * - not: Negate the result of a condition\n */\nexport type LogicalOperator = \"and\" | \"or\" | \"not\";\n\n/**\n * Represents a DynamoDB condition expression.\n * Can be either a comparison condition or a logical combination of conditions.\n *\n * @example\n * // Simple comparison condition\n * const condition: Condition = {\n * type: \"eq\",\n * attr: \"status\",\n * value: \"ACTIVE\"\n * };\n *\n * @example\n * // Logical combination of conditions\n * const condition: Condition = {\n * type: \"and\",\n * conditions: [\n * { type: \"eq\", attr: \"status\", value: \"ACTIVE\" },\n * { type: \"gt\", attr: \"age\", value: 5 }\n * ]\n * };\n */\nexport interface Condition {\n /** The type of condition (comparison or logical operator) */\n type: ComparisonOperator | LogicalOperator;\n /** The attribute name for comparison conditions */\n attr?: string;\n /** The value to compare against for comparison conditions */\n value?: unknown;\n /** Array of conditions for logical operators (and/or) */\n conditions?: Condition[];\n /** Single condition for the 'not' operator */\n condition?: Condition;\n}\n\n/**\n * Parameters used to build DynamoDB expression strings.\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ExpressionAttributeNames.html Expression Attribute Names}\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ExpressionAttributeValues.html Expression Attribute Values}\n */\nexport interface ExpressionParams {\n /** Map of attribute name placeholders to actual attribute names */\n expressionAttributeNames: Record<string, string>;\n /** Map of value placeholders to actual values */\n expressionAttributeValues: DynamoItem;\n /** Counter for generating unique value placeholders */\n valueCounter: { count: number };\n}\n\n/**\n * Creates a comparison condition builder function for the specified operator.\n * @internal\n */\nexport const createComparisonCondition =\n (type: ComparisonOperator) =>\n (attr: string, value: unknown): Condition => ({\n type,\n attr,\n value,\n });\n\n/**\n * Creates an equals (=) condition\n * @example\n * eq(\"status\", \"ACTIVE\") // status = \"ACTIVE\"\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html}\n */\nexport const eq = createComparisonCondition(\"eq\");\n\n/**\n * Creates a not equals (≠) condition\n * @example\n * ne(\"status\", \"DELETED\") // status <> \"DELETED\"\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html}\n */\nexport const ne = createComparisonCondition(\"ne\");\n\n/**\n * Creates a less than (<) condition\n * @example\n * lt(\"age\", 18) // age < 18\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html}\n */\nexport const lt = createComparisonCondition(\"lt\");\n\n/**\n * Creates a less than or equal to (≤) condition\n * @example\n * lte(\"age\", 18) // age <= 18\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html}\n */\nexport const lte = createComparisonCondition(\"lte\");\n\n/**\n * Creates a greater than (>) condition\n * @example\n * gt(\"price\", 100) // price > 100\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html}\n */\nexport const gt = createComparisonCondition(\"gt\");\n\n/**\n * Creates a greater than or equal to (≥) condition\n * @example\n * gte(\"price\", 100) // price >= 100\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html}\n */\nexport const gte = createComparisonCondition(\"gte\");\n\n/**\n * Creates a between condition that checks if a value is within a range (inclusive)\n * @example\n * between(\"age\", 18, 65) // age BETWEEN 18 AND 65\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Comparators AWS DynamoDB - BETWEEN}\n */\nexport const between = (attr: string, lower: unknown, upper: unknown): Condition => ({\n type: \"between\",\n attr,\n value: [lower, upper],\n});\n\n/**\n * Creates a begins_with condition that checks if a string attribute starts with a substring\n * @example\n * beginsWith(\"email\", \"@example.com\") // begins_with(email, \"@example.com\")\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Functions AWS DynamoDB - begins_with}\n */\nexport const beginsWith = createComparisonCondition(\"beginsWith\");\n\n/**\n * Creates a contains condition that checks if a string contains a substring or if a set contains an element\n * @example\n * contains(\"tags\", \"important\") // contains(tags, \"important\")\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Functions AWS DynamoDB - contains}\n */\nexport const contains = createComparisonCondition(\"contains\");\n\n/**\n * Creates a condition that checks if an attribute exists\n * @example\n * attributeExists(\"email\") // attribute_exists(email)\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Functions AWS DynamoDB - attribute_exists}\n */\nexport const attributeExists = (attr: string): Condition => ({\n type: \"attributeExists\",\n attr,\n});\n\n/**\n * Creates a condition that checks if an attribute does not exist\n * @example\n * attributeNotExists(\"deletedAt\") // attribute_not_exists(deletedAt)\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Functions AWS DynamoDB - attribute_not_exists}\n */\nexport const attributeNotExists = (attr: string): Condition => ({\n type: \"attributeNotExists\",\n attr,\n});\n\n// --- Logical Operators ---\n\n/**\n * Combines multiple conditions with AND operator\n * @example\n * and(\n * eq(\"status\", \"ACTIVE\"),\n * gt(\"age\", 18)\n * ) // status = \"ACTIVE\" AND age > 18\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Logical AWS DynamoDB - AND}\n */\nexport const and = (...conditions: Condition[]): Condition => ({\n type: \"and\",\n conditions,\n});\n\n/**\n * Combines multiple conditions with OR operator\n * @example\n * or(\n * eq(\"status\", \"PENDING\"),\n * eq(\"status\", \"PROCESSING\")\n * ) // status = \"PENDING\" OR status = \"PROCESSING\"\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Logical AWS DynamoDB - OR}\n */\nexport const or = (...conditions: Condition[]): Condition => ({\n type: \"or\",\n conditions,\n});\n\n/**\n * Negates a condition\n * @example\n * not(eq(\"status\", \"DELETED\")) // NOT status = \"DELETED\"\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Logical AWS DynamoDB - NOT}\n */\nexport const not = (condition: Condition): Condition => ({\n type: \"not\",\n condition,\n});\n\n/**\n * Type-safe operators for building key conditions in DynamoDB queries.\n * Only includes operators that are valid for key conditions.\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html#Query.KeyConditionExpressions AWS DynamoDB - Key Condition Expressions}\n *\n * @example\n * // Using with sort key conditions\n * table.query({\n * pk: \"USER#123\",\n * sk: op => op.beginsWith(\"ORDER#\")\n * })\n */\nexport type KeyConditionOperator = {\n /** Equals comparison for key attributes */\n eq: (value: unknown) => Condition;\n /** Less than comparison for key attributes */\n lt: (value: unknown) => Condition;\n /** Less than or equal comparison for key attributes */\n lte: (value: unknown) => Condition;\n /** Greater than comparison for key attributes */\n gt: (value: unknown) => Condition;\n /** Greater than or equal comparison for key attributes */\n gte: (value: unknown) => Condition;\n /** Between range comparison for key attributes */\n between: (lower: unknown, upper: unknown) => Condition;\n /** Begins with comparison for key attributes */\n beginsWith: (value: unknown) => Condition;\n /** Combines multiple key conditions with AND */\n and: (...conditions: Condition[]) => Condition;\n};\n\n/**\n * Type-safe operators for building conditions in DynamoDB operations.\n * Includes all available condition operators with proper type inference.\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html AWS DynamoDB - Condition Expressions}\n *\n * @example\n * // Using with type-safe conditions\n * interface User {\n * status: string;\n * age: number;\n * email?: string;\n * }\n *\n * table.scan<User>()\n * .where(op => op.and(\n * op.eq(\"status\", \"ACTIVE\"),\n * op.gt(\"age\", 18),\n * op.attributeExists(\"email\")\n * ))\n *\n * @template T The type of the item being operated on\n */\nexport type ConditionOperator<T extends DynamoItem> = {\n eq: <K extends Path<T>>(attr: K, value: PathType<T, K>) => Condition;\n ne: <K extends Path<T>>(attr: K, value: PathType<T, K>) => Condition;\n lt: <K extends Path<T>>(attr: K, value: PathType<T, K>) => Condition;\n lte: <K extends Path<T>>(attr: K, value: PathType<T, K>) => Condition;\n gt: <K extends Path<T>>(attr: K, value: PathType<T, K>) => Condition;\n gte: <K extends Path<T>>(attr: K, value: PathType<T, K>) => Condition;\n between: <K extends Path<T>>(attr: K, lower: PathType<T, K>, upper: PathType<T, K>) => Condition;\n beginsWith: <K extends Path<T>>(attr: K, value: PathType<T, K>) => Condition;\n contains: <K extends Path<T>>(attr: K, value: PathType<T, K>) => Condition;\n attributeExists: <K extends Path<T>>(attr: K) => Condition;\n attributeNotExists: <K extends Path<T>>(attr: K) => Condition;\n and: (...conditions: Condition[]) => Condition;\n or: (...conditions: Condition[]) => Condition;\n not: (condition: Condition) => Condition;\n};\n\n/**\n * Primary key type for QUERY operations.\n * Allows building complex key conditions for the sort key.\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html AWS DynamoDB - Query Operations}\n *\n * @example\n * // Query items with a specific partition key and sort key prefix\n * table.query({\n * pk: \"USER#123\",\n * sk: op => op.beginsWith(\"ORDER#2023\")\n * })\n *\n * @example\n * // Query items within a specific sort key range\n * table.query({\n * pk: \"USER#123\",\n * sk: op => op.between(\"ORDER#2023-01\", \"ORDER#2023-12\")\n * })\n */\nexport type PrimaryKey = {\n /** Partition key value */\n pk: string;\n /** Optional sort key condition builder */\n sk?: (op: KeyConditionOperator) => Condition;\n};\n\n/**\n * Primary key type for GET and DELETE operations.\n * Used when you need to specify exact key values without conditions.\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html AWS DynamoDB - Working with Items}\n *\n * @example\n * // Get a specific item by its complete primary key\n * table.get({\n * pk: \"USER#123\",\n * sk: \"PROFILE#123\"\n * })\n *\n * @example\n * // Delete a specific item by its complete primary key\n * table.delete({\n * pk: \"USER#123\",\n * sk: \"ORDER#456\"\n * })\n */\nexport type PrimaryKeyWithoutExpression = {\n /** Partition key value */\n pk: string;\n /** Optional sort key value */\n sk?: string;\n};\n"]}
|
package/dist/conditions.d.cts
DELETED
|
@@ -1,3 +0,0 @@
|
|
|
1
|
-
export { e as ComparisonOperator, C as Condition, b as ConditionOperator, E as ExpressionParams, K as KeyConditionOperator, L as LogicalOperator, a as PrimaryKey, P as PrimaryKeyWithoutExpression, r as and, p as attributeExists, q as attributeNotExists, m as beginsWith, k as between, o as contains, f as createComparisonCondition, g as eq, i as gt, j as gte, l as lt, h as lte, n as ne, t as not, s as or } from './conditions-ChhQWd6z.cjs';
|
|
2
|
-
import './types.cjs';
|
|
3
|
-
import '@aws-sdk/lib-dynamodb';
|
package/dist/conditions.d.ts
DELETED
|
@@ -1,3 +0,0 @@
|
|
|
1
|
-
export { e as ComparisonOperator, C as Condition, b as ConditionOperator, E as ExpressionParams, K as KeyConditionOperator, L as LogicalOperator, a as PrimaryKey, P as PrimaryKeyWithoutExpression, r as and, p as attributeExists, q as attributeNotExists, m as beginsWith, k as between, o as contains, f as createComparisonCondition, g as eq, i as gt, j as gte, l as lt, h as lte, n as ne, t as not, s as or } from './conditions--ld9a78i.js';
|
|
2
|
-
import './types.js';
|
|
3
|
-
import '@aws-sdk/lib-dynamodb';
|
package/dist/conditions.js
DELETED
|
@@ -1,43 +0,0 @@
|
|
|
1
|
-
// src/conditions.ts
|
|
2
|
-
var createComparisonCondition = (type) => (attr, value) => ({
|
|
3
|
-
type,
|
|
4
|
-
attr,
|
|
5
|
-
value
|
|
6
|
-
});
|
|
7
|
-
var eq = createComparisonCondition("eq");
|
|
8
|
-
var ne = createComparisonCondition("ne");
|
|
9
|
-
var lt = createComparisonCondition("lt");
|
|
10
|
-
var lte = createComparisonCondition("lte");
|
|
11
|
-
var gt = createComparisonCondition("gt");
|
|
12
|
-
var gte = createComparisonCondition("gte");
|
|
13
|
-
var between = (attr, lower, upper) => ({
|
|
14
|
-
type: "between",
|
|
15
|
-
attr,
|
|
16
|
-
value: [lower, upper]
|
|
17
|
-
});
|
|
18
|
-
var beginsWith = createComparisonCondition("beginsWith");
|
|
19
|
-
var contains = createComparisonCondition("contains");
|
|
20
|
-
var attributeExists = (attr) => ({
|
|
21
|
-
type: "attributeExists",
|
|
22
|
-
attr
|
|
23
|
-
});
|
|
24
|
-
var attributeNotExists = (attr) => ({
|
|
25
|
-
type: "attributeNotExists",
|
|
26
|
-
attr
|
|
27
|
-
});
|
|
28
|
-
var and = (...conditions) => ({
|
|
29
|
-
type: "and",
|
|
30
|
-
conditions
|
|
31
|
-
});
|
|
32
|
-
var or = (...conditions) => ({
|
|
33
|
-
type: "or",
|
|
34
|
-
conditions
|
|
35
|
-
});
|
|
36
|
-
var not = (condition) => ({
|
|
37
|
-
type: "not",
|
|
38
|
-
condition
|
|
39
|
-
});
|
|
40
|
-
|
|
41
|
-
export { and, attributeExists, attributeNotExists, beginsWith, between, contains, createComparisonCondition, eq, gt, gte, lt, lte, ne, not, or };
|
|
42
|
-
//# sourceMappingURL=conditions.js.map
|
|
43
|
-
//# sourceMappingURL=conditions.js.map
|
package/dist/conditions.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/conditions.ts"],"names":[],"mappings":";AA+FO,IAAM,yBACX,GAAA,CAAC,IACD,KAAA,CAAC,MAAc,KAA+B,MAAA;AAAA,EAC5C,IAAA;AAAA,EACA,IAAA;AAAA,EACA;AACF,CAAA;AAQW,IAAA,EAAA,GAAK,0BAA0B,IAAI;AAQnC,IAAA,EAAA,GAAK,0BAA0B,IAAI;AAQnC,IAAA,EAAA,GAAK,0BAA0B,IAAI;AAQnC,IAAA,GAAA,GAAM,0BAA0B,KAAK;AAQrC,IAAA,EAAA,GAAK,0BAA0B,IAAI;AAQnC,IAAA,GAAA,GAAM,0BAA0B,KAAK;AAQ3C,IAAM,OAAU,GAAA,CAAC,IAAc,EAAA,KAAA,EAAgB,KAA+B,MAAA;AAAA,EACnF,IAAM,EAAA,SAAA;AAAA,EACN,IAAA;AAAA,EACA,KAAA,EAAO,CAAC,KAAA,EAAO,KAAK;AACtB,CAAA;AAQa,IAAA,UAAA,GAAa,0BAA0B,YAAY;AAQnD,IAAA,QAAA,GAAW,0BAA0B,UAAU;AAQ/C,IAAA,eAAA,GAAkB,CAAC,IAA6B,MAAA;AAAA,EAC3D,IAAM,EAAA,iBAAA;AAAA,EACN;AACF,CAAA;AAQa,IAAA,kBAAA,GAAqB,CAAC,IAA6B,MAAA;AAAA,EAC9D,IAAM,EAAA,oBAAA;AAAA,EACN;AACF,CAAA;AAaa,IAAA,GAAA,GAAM,IAAI,UAAwC,MAAA;AAAA,EAC7D,IAAM,EAAA,KAAA;AAAA,EACN;AACF,CAAA;AAWa,IAAA,EAAA,GAAK,IAAI,UAAwC,MAAA;AAAA,EAC5D,IAAM,EAAA,IAAA;AAAA,EACN;AACF,CAAA;AAQa,IAAA,GAAA,GAAM,CAAC,SAAqC,MAAA;AAAA,EACvD,IAAM,EAAA,KAAA;AAAA,EACN;AACF,CAAA","file":"conditions.js","sourcesContent":["import type { Path, PathType } from \"./builders/types\";\nimport type { DynamoItem } from \"./types\";\n\n/**\n * Supported comparison operators for DynamoDB conditions.\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html AWS DynamoDB - Comparison Operator Reference}\n *\n * - eq: Equals (=)\n * - ne: Not equals (≠ / <>)\n * - lt: Less than (<)\n * - lte: Less than or equal to (≤)\n * - gt: Greater than (>)\n * - gte: Greater than or equal to (≥)\n * - between: Between two values (inclusive)\n * - beginsWith: Checks if string attribute begins with specified substring\n * - contains: Checks if string/set attribute contains specified value\n * - attributeExists: Checks if attribute exists\n * - attributeNotExists: Checks if attribute does not exist\n */\nexport type ComparisonOperator =\n | \"eq\"\n | \"ne\"\n | \"lt\"\n | \"lte\"\n | \"gt\"\n | \"gte\"\n | \"between\"\n | \"beginsWith\"\n | \"contains\"\n | \"attributeExists\"\n | \"attributeNotExists\";\n\n/**\n * Logical operators for combining multiple conditions.\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Logical AWS DynamoDB - Logical Operator Reference}\n *\n * - and: Evaluates to true if all conditions are true\n * - or: Evaluates to true if any condition is true\n * - not: Negate the result of a condition\n */\nexport type LogicalOperator = \"and\" | \"or\" | \"not\";\n\n/**\n * Represents a DynamoDB condition expression.\n * Can be either a comparison condition or a logical combination of conditions.\n *\n * @example\n * // Simple comparison condition\n * const condition: Condition = {\n * type: \"eq\",\n * attr: \"status\",\n * value: \"ACTIVE\"\n * };\n *\n * @example\n * // Logical combination of conditions\n * const condition: Condition = {\n * type: \"and\",\n * conditions: [\n * { type: \"eq\", attr: \"status\", value: \"ACTIVE\" },\n * { type: \"gt\", attr: \"age\", value: 5 }\n * ]\n * };\n */\nexport interface Condition {\n /** The type of condition (comparison or logical operator) */\n type: ComparisonOperator | LogicalOperator;\n /** The attribute name for comparison conditions */\n attr?: string;\n /** The value to compare against for comparison conditions */\n value?: unknown;\n /** Array of conditions for logical operators (and/or) */\n conditions?: Condition[];\n /** Single condition for the 'not' operator */\n condition?: Condition;\n}\n\n/**\n * Parameters used to build DynamoDB expression strings.\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ExpressionAttributeNames.html Expression Attribute Names}\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ExpressionAttributeValues.html Expression Attribute Values}\n */\nexport interface ExpressionParams {\n /** Map of attribute name placeholders to actual attribute names */\n expressionAttributeNames: Record<string, string>;\n /** Map of value placeholders to actual values */\n expressionAttributeValues: DynamoItem;\n /** Counter for generating unique value placeholders */\n valueCounter: { count: number };\n}\n\n/**\n * Creates a comparison condition builder function for the specified operator.\n * @internal\n */\nexport const createComparisonCondition =\n (type: ComparisonOperator) =>\n (attr: string, value: unknown): Condition => ({\n type,\n attr,\n value,\n });\n\n/**\n * Creates an equals (=) condition\n * @example\n * eq(\"status\", \"ACTIVE\") // status = \"ACTIVE\"\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html}\n */\nexport const eq = createComparisonCondition(\"eq\");\n\n/**\n * Creates a not equals (≠) condition\n * @example\n * ne(\"status\", \"DELETED\") // status <> \"DELETED\"\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html}\n */\nexport const ne = createComparisonCondition(\"ne\");\n\n/**\n * Creates a less than (<) condition\n * @example\n * lt(\"age\", 18) // age < 18\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html}\n */\nexport const lt = createComparisonCondition(\"lt\");\n\n/**\n * Creates a less than or equal to (≤) condition\n * @example\n * lte(\"age\", 18) // age <= 18\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html}\n */\nexport const lte = createComparisonCondition(\"lte\");\n\n/**\n * Creates a greater than (>) condition\n * @example\n * gt(\"price\", 100) // price > 100\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html}\n */\nexport const gt = createComparisonCondition(\"gt\");\n\n/**\n * Creates a greater than or equal to (≥) condition\n * @example\n * gte(\"price\", 100) // price >= 100\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html}\n */\nexport const gte = createComparisonCondition(\"gte\");\n\n/**\n * Creates a between condition that checks if a value is within a range (inclusive)\n * @example\n * between(\"age\", 18, 65) // age BETWEEN 18 AND 65\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Comparators AWS DynamoDB - BETWEEN}\n */\nexport const between = (attr: string, lower: unknown, upper: unknown): Condition => ({\n type: \"between\",\n attr,\n value: [lower, upper],\n});\n\n/**\n * Creates a begins_with condition that checks if a string attribute starts with a substring\n * @example\n * beginsWith(\"email\", \"@example.com\") // begins_with(email, \"@example.com\")\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Functions AWS DynamoDB - begins_with}\n */\nexport const beginsWith = createComparisonCondition(\"beginsWith\");\n\n/**\n * Creates a contains condition that checks if a string contains a substring or if a set contains an element\n * @example\n * contains(\"tags\", \"important\") // contains(tags, \"important\")\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Functions AWS DynamoDB - contains}\n */\nexport const contains = createComparisonCondition(\"contains\");\n\n/**\n * Creates a condition that checks if an attribute exists\n * @example\n * attributeExists(\"email\") // attribute_exists(email)\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Functions AWS DynamoDB - attribute_exists}\n */\nexport const attributeExists = (attr: string): Condition => ({\n type: \"attributeExists\",\n attr,\n});\n\n/**\n * Creates a condition that checks if an attribute does not exist\n * @example\n * attributeNotExists(\"deletedAt\") // attribute_not_exists(deletedAt)\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Functions AWS DynamoDB - attribute_not_exists}\n */\nexport const attributeNotExists = (attr: string): Condition => ({\n type: \"attributeNotExists\",\n attr,\n});\n\n// --- Logical Operators ---\n\n/**\n * Combines multiple conditions with AND operator\n * @example\n * and(\n * eq(\"status\", \"ACTIVE\"),\n * gt(\"age\", 18)\n * ) // status = \"ACTIVE\" AND age > 18\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Logical AWS DynamoDB - AND}\n */\nexport const and = (...conditions: Condition[]): Condition => ({\n type: \"and\",\n conditions,\n});\n\n/**\n * Combines multiple conditions with OR operator\n * @example\n * or(\n * eq(\"status\", \"PENDING\"),\n * eq(\"status\", \"PROCESSING\")\n * ) // status = \"PENDING\" OR status = \"PROCESSING\"\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Logical AWS DynamoDB - OR}\n */\nexport const or = (...conditions: Condition[]): Condition => ({\n type: \"or\",\n conditions,\n});\n\n/**\n * Negates a condition\n * @example\n * not(eq(\"status\", \"DELETED\")) // NOT status = \"DELETED\"\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Logical AWS DynamoDB - NOT}\n */\nexport const not = (condition: Condition): Condition => ({\n type: \"not\",\n condition,\n});\n\n/**\n * Type-safe operators for building key conditions in DynamoDB queries.\n * Only includes operators that are valid for key conditions.\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html#Query.KeyConditionExpressions AWS DynamoDB - Key Condition Expressions}\n *\n * @example\n * // Using with sort key conditions\n * table.query({\n * pk: \"USER#123\",\n * sk: op => op.beginsWith(\"ORDER#\")\n * })\n */\nexport type KeyConditionOperator = {\n /** Equals comparison for key attributes */\n eq: (value: unknown) => Condition;\n /** Less than comparison for key attributes */\n lt: (value: unknown) => Condition;\n /** Less than or equal comparison for key attributes */\n lte: (value: unknown) => Condition;\n /** Greater than comparison for key attributes */\n gt: (value: unknown) => Condition;\n /** Greater than or equal comparison for key attributes */\n gte: (value: unknown) => Condition;\n /** Between range comparison for key attributes */\n between: (lower: unknown, upper: unknown) => Condition;\n /** Begins with comparison for key attributes */\n beginsWith: (value: unknown) => Condition;\n /** Combines multiple key conditions with AND */\n and: (...conditions: Condition[]) => Condition;\n};\n\n/**\n * Type-safe operators for building conditions in DynamoDB operations.\n * Includes all available condition operators with proper type inference.\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html AWS DynamoDB - Condition Expressions}\n *\n * @example\n * // Using with type-safe conditions\n * interface User {\n * status: string;\n * age: number;\n * email?: string;\n * }\n *\n * table.scan<User>()\n * .where(op => op.and(\n * op.eq(\"status\", \"ACTIVE\"),\n * op.gt(\"age\", 18),\n * op.attributeExists(\"email\")\n * ))\n *\n * @template T The type of the item being operated on\n */\nexport type ConditionOperator<T extends DynamoItem> = {\n eq: <K extends Path<T>>(attr: K, value: PathType<T, K>) => Condition;\n ne: <K extends Path<T>>(attr: K, value: PathType<T, K>) => Condition;\n lt: <K extends Path<T>>(attr: K, value: PathType<T, K>) => Condition;\n lte: <K extends Path<T>>(attr: K, value: PathType<T, K>) => Condition;\n gt: <K extends Path<T>>(attr: K, value: PathType<T, K>) => Condition;\n gte: <K extends Path<T>>(attr: K, value: PathType<T, K>) => Condition;\n between: <K extends Path<T>>(attr: K, lower: PathType<T, K>, upper: PathType<T, K>) => Condition;\n beginsWith: <K extends Path<T>>(attr: K, value: PathType<T, K>) => Condition;\n contains: <K extends Path<T>>(attr: K, value: PathType<T, K>) => Condition;\n attributeExists: <K extends Path<T>>(attr: K) => Condition;\n attributeNotExists: <K extends Path<T>>(attr: K) => Condition;\n and: (...conditions: Condition[]) => Condition;\n or: (...conditions: Condition[]) => Condition;\n not: (condition: Condition) => Condition;\n};\n\n/**\n * Primary key type for QUERY operations.\n * Allows building complex key conditions for the sort key.\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html AWS DynamoDB - Query Operations}\n *\n * @example\n * // Query items with a specific partition key and sort key prefix\n * table.query({\n * pk: \"USER#123\",\n * sk: op => op.beginsWith(\"ORDER#2023\")\n * })\n *\n * @example\n * // Query items within a specific sort key range\n * table.query({\n * pk: \"USER#123\",\n * sk: op => op.between(\"ORDER#2023-01\", \"ORDER#2023-12\")\n * })\n */\nexport type PrimaryKey = {\n /** Partition key value */\n pk: string;\n /** Optional sort key condition builder */\n sk?: (op: KeyConditionOperator) => Condition;\n};\n\n/**\n * Primary key type for GET and DELETE operations.\n * Used when you need to specify exact key values without conditions.\n * @see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html AWS DynamoDB - Working with Items}\n *\n * @example\n * // Get a specific item by its complete primary key\n * table.get({\n * pk: \"USER#123\",\n * sk: \"PROFILE#123\"\n * })\n *\n * @example\n * // Delete a specific item by its complete primary key\n * table.delete({\n * pk: \"USER#123\",\n * sk: \"ORDER#456\"\n * })\n */\nexport type PrimaryKeyWithoutExpression = {\n /** Partition key value */\n pk: string;\n /** Optional sort key value */\n sk?: string;\n};\n"]}
|