dynamo-document-builder 0.6.0 → 0.7.0

package/dist/conditions/contains.d.ts

@@ -1,6 +1,9 @@
 import { NativeAttributeValue } from '@aws-sdk/util-dynamodb';
-import { ContainsExpressionTemplate } from './condition-types.js';
+import { ContainsExpressionTemplate } from './index.js';
 
+/**
+ * Creates a CONTAINS expression template.
+ */
 declare function contains(substringOrElement: NativeAttributeValue): ContainsExpressionTemplate;
 
 export { contains };

package/dist/conditions/contains.mjs

@@ -1,5 +1,8 @@
 import { $contains } from './condition-symbols.mjs';
 
+/**
+ * Creates a CONTAINS expression template.
+ */
 function contains(substringOrElement) {
     return {
         type: $contains,

package/dist/conditions/contains.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"contains.mjs","sources":["../../src/conditions/contains.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAIM,SAAU,QAAQ,CAAC,kBAAwC,EAAA;IAC/D,OAAO;AACL,QAAA,IAAI,EAAE,SAAS;QACf,kBAAkB;KACnB;AACH;;;;"}
+{"version":3,"file":"contains.mjs","sources":["../../src/conditions/contains.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAIA;;AAEG;AACG,SAAU,QAAQ,CAAC,kBAAwC,EAAA;IAC/D,OAAO;AACL,QAAA,IAAI,EAAE,SAAS;QACf,kBAAkB;KACnB;AACH;;;;"}

package/dist/conditions/equals.cjs

@@ -2,6 +2,9 @@
 
 var conditions_conditionSymbols = require('./condition-symbols.cjs');
 
+/**
+ * Creates an EQUALS comparison expression template.
+ */
 function equals(value) {
     return {
         type: conditions_conditionSymbols.$comparison,

package/dist/conditions/equals.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"equals.cjs","sources":["../../src/conditions/equals.ts"],"sourcesContent":[null],"names":["$comparison"],"mappings":";;;;AAGM,SAAU,MAAM,CAAC,KAAsB,EAAA;IAC3C,OAAO;AACL,QAAA,IAAI,EAAEA,uCAAW;AACjB,QAAA,QAAQ,EAAE,GAAG;QACb,KAAK;KACN;AACH;;;;"}
+{"version":3,"file":"equals.cjs","sources":["../../src/conditions/equals.ts"],"sourcesContent":[null],"names":["$comparison"],"mappings":";;;;AAGA;;AAEG;AACG,SAAU,MAAM,CAAC,KAAsB,EAAA;IAC3C,OAAO;AACL,QAAA,IAAI,EAAEA,uCAAW;AACjB,QAAA,QAAQ,EAAE,GAAG;QACb,KAAK;KACN;AACH;;;;"}

package/dist/conditions/equals.d.ts

@@ -1,5 +1,8 @@
-import { ValueExpression, ComparisonExpressionTemplate } from './condition-types.js';
+import { ValueExpression, ComparisonExpressionTemplate } from './index.js';
 
+/**
+ * Creates an EQUALS comparison expression template.
+ */
 declare function equals(value: ValueExpression): ComparisonExpressionTemplate;
 
 export { equals };

package/dist/conditions/equals.mjs

@@ -1,5 +1,8 @@
 import { $comparison } from './condition-symbols.mjs';
 
+/**
+ * Creates an EQUALS comparison expression template.
+ */
 function equals(value) {
     return {
         type: $comparison,

package/dist/conditions/equals.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"equals.mjs","sources":["../../src/conditions/equals.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAGM,SAAU,MAAM,CAAC,KAAsB,EAAA;IAC3C,OAAO;AACL,QAAA,IAAI,EAAE,WAAW;AACjB,QAAA,QAAQ,EAAE,GAAG;QACb,KAAK;KACN;AACH;;;;"}
+{"version":3,"file":"equals.mjs","sources":["../../src/conditions/equals.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAGA;;AAEG;AACG,SAAU,MAAM,CAAC,KAAsB,EAAA;IAC3C,OAAO;AACL,QAAA,IAAI,EAAE,WAAW;AACjB,QAAA,QAAQ,EAAE,GAAG;QACb,KAAK;KACN;AACH;;;;"}

package/dist/conditions/exists.cjs

@@ -2,6 +2,9 @@
 
 var conditions_conditionSymbols = require('./condition-symbols.cjs');
 
+/**
+ * Creates an EXISTS expression template.
+ */
 function exists() {
     return {
         type: conditions_conditionSymbols.$exists,

package/dist/conditions/exists.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"exists.cjs","sources":["../../src/conditions/exists.ts"],"sourcesContent":[null],"names":["$exists"],"mappings":";;;;SAGgB,MAAM,GAAA;IACpB,OAAO;AACL,QAAA,IAAI,EAAEA,mCAAO;KACd;AACH;;;;"}
+{"version":3,"file":"exists.cjs","sources":["../../src/conditions/exists.ts"],"sourcesContent":[null],"names":["$exists"],"mappings":";;;;AAGA;;AAEG;SACa,MAAM,GAAA;IACpB,OAAO;AACL,QAAA,IAAI,EAAEA,mCAAO;KACd;AACH;;;;"}

package/dist/conditions/exists.d.ts

@@ -1,5 +1,8 @@
-import { ExistsExpressionTemplate } from './condition-types.js';
+import { ExistsExpressionTemplate } from './index.js';
 
+/**
+ * Creates an EXISTS expression template.
+ */
 declare function exists(): ExistsExpressionTemplate;
 
 export { exists };

package/dist/conditions/exists.mjs

@@ -1,5 +1,8 @@
 import { $exists } from './condition-symbols.mjs';
 
+/**
+ * Creates an EXISTS expression template.
+ */
 function exists() {
     return {
         type: $exists,

package/dist/conditions/exists.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"exists.mjs","sources":["../../src/conditions/exists.ts"],"sourcesContent":[null],"names":[],"mappings":";;SAGgB,MAAM,GAAA;IACpB,OAAO;AACL,QAAA,IAAI,EAAE,OAAO;KACd;AACH;;;;"}
+{"version":3,"file":"exists.mjs","sources":["../../src/conditions/exists.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAGA;;AAEG;SACa,MAAM,GAAA;IACpB,OAAO;AACL,QAAA,IAAI,EAAE,OAAO;KACd;AACH;;;;"}

package/dist/conditions/greater-than-or-equal.cjs

@@ -2,6 +2,9 @@
 
 var conditions_conditionSymbols = require('./condition-symbols.cjs');
 
+/**
+ * Creates a "greater than or equal to" `>=` comparison expression template.
+ */
 function greaterThanOrEqual(value) {
     return {
         type: conditions_conditionSymbols.$comparison,

package/dist/conditions/greater-than-or-equal.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"greater-than-or-equal.cjs","sources":["../../src/conditions/greater-than-or-equal.ts"],"sourcesContent":[null],"names":["$comparison"],"mappings":";;;;AAGM,SAAU,kBAAkB,CAAC,KAAsB,EAAA;IACvD,OAAO;AACL,QAAA,IAAI,EAAEA,uCAAW;AACjB,QAAA,QAAQ,EAAE,IAAI;QACd,KAAK;KACN;AACH;;;;"}
+{"version":3,"file":"greater-than-or-equal.cjs","sources":["../../src/conditions/greater-than-or-equal.ts"],"sourcesContent":[null],"names":["$comparison"],"mappings":";;;;AAGA;;AAEG;AACG,SAAU,kBAAkB,CAAC,KAAsB,EAAA;IACvD,OAAO;AACL,QAAA,IAAI,EAAEA,uCAAW;AACjB,QAAA,QAAQ,EAAE,IAAI;QACd,KAAK;KACN;AACH;;;;"}

package/dist/conditions/greater-than-or-equal.d.ts

@@ -1,5 +1,8 @@
-import { ValueExpression, ComparisonExpressionTemplate } from './condition-types.js';
+import { ValueExpression, ComparisonExpressionTemplate } from './index.js';
 
+/**
+ * Creates a "greater than or equal to" `>=` comparison expression template.
+ */
 declare function greaterThanOrEqual(value: ValueExpression): ComparisonExpressionTemplate;
 
 export { greaterThanOrEqual };

package/dist/conditions/greater-than-or-equal.mjs

@@ -1,5 +1,8 @@
 import { $comparison } from './condition-symbols.mjs';
 
+/**
+ * Creates a "greater than or equal to" `>=` comparison expression template.
+ */
 function greaterThanOrEqual(value) {
     return {
         type: $comparison,

package/dist/conditions/greater-than-or-equal.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"greater-than-or-equal.mjs","sources":["../../src/conditions/greater-than-or-equal.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAGM,SAAU,kBAAkB,CAAC,KAAsB,EAAA;IACvD,OAAO;AACL,QAAA,IAAI,EAAE,WAAW;AACjB,QAAA,QAAQ,EAAE,IAAI;QACd,KAAK;KACN;AACH;;;;"}
+{"version":3,"file":"greater-than-or-equal.mjs","sources":["../../src/conditions/greater-than-or-equal.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAGA;;AAEG;AACG,SAAU,kBAAkB,CAAC,KAAsB,EAAA;IACvD,OAAO;AACL,QAAA,IAAI,EAAE,WAAW;AACjB,QAAA,QAAQ,EAAE,IAAI;QACd,KAAK;KACN;AACH;;;;"}

package/dist/conditions/greater-than.cjs

@@ -2,6 +2,9 @@
 
 var conditions_conditionSymbols = require('./condition-symbols.cjs');
 
+/**
+ * Creates a "greater than" `>` comparison expression template.
+ */
 function greaterThan(value) {
     return {
         type: conditions_conditionSymbols.$comparison,

package/dist/conditions/greater-than.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"greater-than.cjs","sources":["../../src/conditions/greater-than.ts"],"sourcesContent":[null],"names":["$comparison"],"mappings":";;;;AAGM,SAAU,WAAW,CAAC,KAAsB,EAAA;IAChD,OAAO;AACL,QAAA,IAAI,EAAEA,uCAAW;AACjB,QAAA,QAAQ,EAAE,GAAG;QACb,KAAK;KACN;AACH;;;;"}
+{"version":3,"file":"greater-than.cjs","sources":["../../src/conditions/greater-than.ts"],"sourcesContent":[null],"names":["$comparison"],"mappings":";;;;AAGA;;AAEG;AACG,SAAU,WAAW,CAAC,KAAsB,EAAA;IAChD,OAAO;AACL,QAAA,IAAI,EAAEA,uCAAW;AACjB,QAAA,QAAQ,EAAE,GAAG;QACb,KAAK;KACN;AACH;;;;"}

package/dist/conditions/greater-than.d.ts

@@ -1,5 +1,8 @@
-import { ValueExpression, ComparisonExpressionTemplate } from './condition-types.js';
+import { ValueExpression, ComparisonExpressionTemplate } from './index.js';
 
+/**
+ * Creates a "greater than" `>` comparison expression template.
+ */
 declare function greaterThan(value: ValueExpression): ComparisonExpressionTemplate;
 
 export { greaterThan };

package/dist/conditions/greater-than.mjs

@@ -1,5 +1,8 @@
 import { $comparison } from './condition-symbols.mjs';
 
+/**
+ * Creates a "greater than" `>` comparison expression template.
+ */
 function greaterThan(value) {
     return {
         type: $comparison,

package/dist/conditions/greater-than.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"greater-than.mjs","sources":["../../src/conditions/greater-than.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAGM,SAAU,WAAW,CAAC,KAAsB,EAAA;IAChD,OAAO;AACL,QAAA,IAAI,EAAE,WAAW;AACjB,QAAA,QAAQ,EAAE,GAAG;QACb,KAAK;KACN;AACH;;;;"}
+{"version":3,"file":"greater-than.mjs","sources":["../../src/conditions/greater-than.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAGA;;AAEG;AACG,SAAU,WAAW,CAAC,KAAsB,EAAA;IAChD,OAAO;AACL,QAAA,IAAI,EAAE,WAAW;AACjB,QAAA,QAAQ,EAAE,GAAG;QACb,KAAK;KACN;AACH;;;;"}

package/dist/conditions/index.cjs

@@ -1,9 +1,9 @@
 'use strict';
 
+var conditions_conditionParser = require('./condition-parser.cjs');
 var conditions_and = require('./and.cjs');
 var conditions_beginsWith = require('./begins-with.cjs');
 var conditions_between = require('./between.cjs');
-var conditions_conditionParser = require('./condition-parser.cjs');
 var conditions_contains = require('./contains.cjs');
 var conditions_equals = require('./equals.cjs');
 var conditions_exists = require('./exists.cjs');
@@ -21,10 +21,10 @@ var conditions_typeIs = require('./type-is.cjs');
 
 
 
+exports.parseCondition = conditions_conditionParser.parseCondition;
 exports.and = conditions_and.and;
 exports.beginsWith = conditions_beginsWith.beginsWith;
 exports.between = conditions_between.between;
-exports.parseCondition = conditions_conditionParser.parseCondition;
 exports.contains = conditions_contains.contains;
 exports.equals = conditions_equals.equals;
 exports.exists = conditions_exists.exists;

package/dist/conditions/index.d.ts

@@ -1,8 +1,9 @@
+import { NativeAttributeValue } from '@aws-sdk/lib-dynamodb';
+import { $comparison, $size, $logical, $between, $in, $not, $exists, $type, $beginsWith, $contains } from './condition-symbols.js';
+export { ConditionParserResult, parseCondition } from './condition-parser.js';
 export { and } from './and.js';
 export { beginsWith } from './begins-with.js';
 export { between } from './between.js';
-export { ConditionParserResult, parseCondition } from './condition-parser.js';
-export { BeginsWithExpression, BeginsWithExpressionTemplate, BetweenExpression, BetweenExpressionTemplate, BooleanExpression, ComparisonExpression, ComparisonExpressionTemplate, ComparisonOperator, Condition, ConditionExpression, ConditionExpressionTemplate, ConditionTemplate, ContainsExpression, ContainsExpressionTemplate, DynamoAttributeType, ExistsExpression, ExistsExpressionTemplate, FunctionExpression, InExpression, InExpressionTemplate, LogicalExpression, LogicalOperator, NotExpression, Operand, SizeConditionExpression, SizeConditionExpressionTemplate, SizeExpression, TemplateExpression, TypeCheckExpression, TypeCheckExpressionTemplate, ValueExpression } from './condition-types.js';
 export { contains } from './contains.js';
 export { equals } from './equals.js';
 export { exists } from './exists.js';
@@ -17,3 +18,185 @@ export { notExists } from './not-exists.js';
 export { or } from './or.js';
 export { size } from './size.js';
 export { typeIs } from './type-is.js';
+
+/**
+ * These are the basic building block types for constructing DynamoDB condition expressions.
+ *
+ * See: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html
+ */
+/**
+ * Represends a top-level attribute in a Dynamo item OR a nested attribute using dot notation.
+ *
+ * {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Syntax}
+ */
+type Operand = string;
+/**
+ * Type for representing comparison operators in DynamoDB condition expressions.
+ */
+type ComparisonOperator = '=' | '<>' | '<' | '<=' | '>' | '>=';
+/**
+ * Type for representing logical operators for combining two or more conditions in DynamoDB condition expressions.
+ */
+type LogicalOperator = 'AND' | 'OR';
+/**
+ * Type for representing DynamoDB attribute type descriptors used to check attribute types in condition expressions.
+ */
+type DynamoAttributeType = 'B' | 'BOOL' | 'BS' | 'L' | 'M' | 'N' | 'NS' | 'NULL' | 'S' | 'SS';
+/**
+ * Value expressions can be either native attribute values or size expressions in the context of a condition expression.
+ */
+type ValueExpression = NativeAttributeValue | SizeExpression;
+/**
+ * Represents a comparison between an operand and a value using a comparison operator.
+ */
+type ComparisonExpression = {
+    type: typeof $comparison;
+    operand: Operand;
+    operator: ComparisonOperator;
+    value: ValueExpression;
+};
+/**
+ * Same as ComparisonExpression but without the operand (for use in templates)
+ */
+type ComparisonExpressionTemplate = Omit<ComparisonExpression, 'operand'>;
+/**
+ * Represents a logical combination of multiple condition expressions using a logical operator.
+ */
+type LogicalExpression = {
+    type: typeof $logical;
+    operator: LogicalOperator;
+    subConditions: ConditionExpressionTemplate[];
+};
+/**
+ * Represents a BETWEEN expression: `<operand>` BETWEEN `<lowerValue>` AND `<upperValue>`
+ */
+type BetweenExpression = {
+    type: typeof $between;
+    operand: Operand;
+    lowerValue: ValueExpression;
+    upperValue: ValueExpression;
+};
+/**
+ * Same as BetweenExpression but without the operand (for use in templates)
+ */
+type BetweenExpressionTemplate = Omit<BetweenExpression, 'operand'>;
+/**
+ * Represents an IN expression: `<operand>` IN (`<value1>`, `<value2>`, ...)
+ */
+type InExpression = {
+    type: typeof $in;
+    operand: Operand;
+    values: ValueExpression[];
+};
+/**
+ * Same as InExpression but without the operand (for use in templates)
+ */
+type InExpressionTemplate = Omit<InExpression, 'operand'>;
+/**
+ * Represents a NOT expression that negates a condition expression.
+ */
+type NotExpression = {
+    type: typeof $not;
+    condition: ConditionExpressionTemplate;
+};
+/**
+ * Represents an EXISTS expression: attribute_exists(`<operand>`) or attribute_not_exists(`<operand>`)
+ */
+type ExistsExpression = {
+    type: typeof $exists;
+    operand: Operand;
+    not?: true;
+};
+/**
+ * Same as ExistsExpression but without the operand (for use in templates)
+ */
+type ExistsExpressionTemplate = Omit<ExistsExpression, 'operand'>;
+/**
+ * Represents a TYPE check expression: attribute_type(`<operand>`, `<attributeType>`)
+ */
+type TypeCheckExpression = {
+    type: typeof $type;
+    operand: Operand;
+    attributeType: DynamoAttributeType;
+};
+/**
+ * Same as TypeCheckExpression but without the operand (for use in templates)
+ */
+type TypeCheckExpressionTemplate = Omit<TypeCheckExpression, 'operand'>;
+/**
+ * Represents a BEGINS WITH expression: begins_with(`<operand>`, `<prefix>`)
+ */
+type BeginsWithExpression = {
+    type: typeof $beginsWith;
+    operand: Operand;
+    prefix: string;
+};
+/**
+ * Same as BeginsWithExpression but without the operand (for use in templates)
+ */
+type BeginsWithExpressionTemplate = Omit<BeginsWithExpression, 'operand'>;
+/**
+ * Represents a CONTAINS expression: contains(`<operand>`, `<substringOrElement>`)
+ */
+type ContainsExpression = {
+    type: typeof $contains;
+    operand: Operand;
+    substringOrElement: NativeAttributeValue;
+};
+/**
+ * Same as ContainsExpression but without the operand (for use in templates)
+ */
+type ContainsExpressionTemplate = Omit<ContainsExpression, 'operand'>;
+/**
+ * Represents a SIZE expression: size(`<operand>`)
+ */
+type SizeExpression = {
+    type: typeof $size;
+    attribute: Operand;
+};
+/**
+ * Represents a SIZE condition expression: size(`<operand>`) `<operator>` `<value>`
+ */
+type SizeConditionExpression = {
+    type: typeof $size;
+    operand: Operand;
+    operator: ComparisonOperator;
+    value: NativeAttributeValue;
+};
+/**
+ * Same as SizeConditionExpression but without the operand (for use in templates)
+ */
+type SizeConditionExpressionTemplate = Omit<SizeConditionExpression, 'operand'>;
+/**
+ * All functions that evaluate to a boolean value in condition expressions
+ */
+type BooleanExpression = ExistsExpression | TypeCheckExpression | BeginsWithExpression | ContainsExpression;
+/**
+ * All function expressions that return a value
+ */
+type FunctionExpression = BooleanExpression | SizeExpression;
+/**
+ * All expressions that can be used within a condition template
+ */
+type TemplateExpression = Omit<ComparisonExpression | BetweenExpression | InExpression | BooleanExpression | SizeConditionExpression, 'operand'>;
+/**
+ * Implicit AND between all attributes in the template
+ * This is an object where keys are operands and values are either values or template expressions
+ */
+type ConditionTemplate = Record<Operand, ValueExpression | TemplateExpression>;
+/**
+ * All expressions that result in a boolean
+ */
+type ConditionExpression = ComparisonExpression | LogicalExpression | BetweenExpression | InExpression | NotExpression | BooleanExpression | SizeConditionExpression;
+/**
+ * A condition template or a condition expression.
+ * - A template is an object where keys are operands and values are either values or template expressions.
+ * - An expression is a structured representation of a condition using the defined expression types.
+ */
+type ConditionExpressionTemplate = ConditionExpression | ConditionTemplate;
+/**
+ * A condition can be a single condition expression/template or an array of them (implicitly ANDed)
+ */
+type Condition = ConditionExpressionTemplate | ConditionExpressionTemplate[];
+
+export type { BeginsWithExpression, BeginsWithExpressionTemplate, BetweenExpression, BetweenExpressionTemplate, BooleanExpression, ComparisonExpression, ComparisonExpressionTemplate, ComparisonOperator, Condition, ConditionExpression, ConditionExpressionTemplate, ConditionTemplate, ContainsExpression, ContainsExpressionTemplate, DynamoAttributeType, ExistsExpression, ExistsExpressionTemplate, FunctionExpression, InExpression, InExpressionTemplate, LogicalExpression, LogicalOperator, NotExpression, Operand, SizeConditionExpression, SizeConditionExpressionTemplate, SizeExpression, TemplateExpression, TypeCheckExpression, TypeCheckExpressionTemplate, ValueExpression };

package/dist/conditions/index.mjs

@@ -1,7 +1,7 @@
+export { parseCondition } from './condition-parser.mjs';
 export { and } from './and.mjs';
 export { beginsWith } from './begins-with.mjs';
 export { between } from './between.mjs';
-export { parseCondition } from './condition-parser.mjs';
 export { contains } from './contains.mjs';
 export { equals } from './equals.mjs';
 export { exists } from './exists.mjs';

package/dist/conditions/is-in.cjs

@@ -2,6 +2,9 @@
 
 var conditions_conditionSymbols = require('./condition-symbols.cjs');
 
+/**
+ * Creates an IN expression template.
+ */
 function isIn(firstValue, secondValue, ...additionalValues) {
     return {
         type: conditions_conditionSymbols.$in,

package/dist/conditions/is-in.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"is-in.cjs","sources":["../../src/conditions/is-in.ts"],"sourcesContent":[null],"names":["$in"],"mappings":";;;;AAGM,SAAU,IAAI,CAClB,UAA2B,EAC3B,WAA4B,EAC5B,GAAG,gBAAmC,EAAA;IAEtC,OAAO;AACL,QAAA,IAAI,EAAEA,+BAAG;QACT,MAAM,EAAE,CAAC,UAAU,EAAE,WAAW,EAAE,GAAG,gBAAgB,CAAC;KACvD;AACH;;;;"}
+{"version":3,"file":"is-in.cjs","sources":["../../src/conditions/is-in.ts"],"sourcesContent":[null],"names":["$in"],"mappings":";;;;AAGA;;AAEG;AACG,SAAU,IAAI,CAClB,UAA2B,EAC3B,WAA4B,EAC5B,GAAG,gBAAmC,EAAA;IAEtC,OAAO;AACL,QAAA,IAAI,EAAEA,+BAAG;QACT,MAAM,EAAE,CAAC,UAAU,EAAE,WAAW,EAAE,GAAG,gBAAgB,CAAC;KACvD;AACH;;;;"}

package/dist/conditions/is-in.d.ts

@@ -1,5 +1,8 @@
-import { ValueExpression, InExpressionTemplate } from './condition-types.js';
+import { ValueExpression, InExpressionTemplate } from './index.js';
 
+/**
+ * Creates an IN expression template.
+ */
 declare function isIn(firstValue: ValueExpression, secondValue: ValueExpression, ...additionalValues: ValueExpression[]): InExpressionTemplate;
 
 export { isIn };

package/dist/conditions/is-in.mjs

@@ -1,5 +1,8 @@
 import { $in } from './condition-symbols.mjs';
 
+/**
+ * Creates an IN expression template.
+ */
 function isIn(firstValue, secondValue, ...additionalValues) {
     return {
         type: $in,

package/dist/conditions/is-in.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"is-in.mjs","sources":["../../src/conditions/is-in.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAGM,SAAU,IAAI,CAClB,UAA2B,EAC3B,WAA4B,EAC5B,GAAG,gBAAmC,EAAA;IAEtC,OAAO;AACL,QAAA,IAAI,EAAE,GAAG;QACT,MAAM,EAAE,CAAC,UAAU,EAAE,WAAW,EAAE,GAAG,gBAAgB,CAAC;KACvD;AACH;;;;"}
+{"version":3,"file":"is-in.mjs","sources":["../../src/conditions/is-in.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAGA;;AAEG;AACG,SAAU,IAAI,CAClB,UAA2B,EAC3B,WAA4B,EAC5B,GAAG,gBAAmC,EAAA;IAEtC,OAAO;AACL,QAAA,IAAI,EAAE,GAAG;QACT,MAAM,EAAE,CAAC,UAAU,EAAE,WAAW,EAAE,GAAG,gBAAgB,CAAC;KACvD;AACH;;;;"}

package/dist/conditions/less-than-or-equal.cjs

@@ -2,6 +2,9 @@
 
 var conditions_conditionSymbols = require('./condition-symbols.cjs');
 
+/**
+ * Creates a "less than or equal to" `<=` comparison expression template.
+ */
 function lessThanOrEqual(value) {
     return {
         type: conditions_conditionSymbols.$comparison,

package/dist/conditions/less-than-or-equal.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"less-than-or-equal.cjs","sources":["../../src/conditions/less-than-or-equal.ts"],"sourcesContent":[null],"names":["$comparison"],"mappings":";;;;AAGM,SAAU,eAAe,CAAC,KAAsB,EAAA;IACpD,OAAO;AACL,QAAA,IAAI,EAAEA,uCAAW;AACjB,QAAA,QAAQ,EAAE,IAAI;QACd,KAAK;KACN;AACH;;;;"}
+{"version":3,"file":"less-than-or-equal.cjs","sources":["../../src/conditions/less-than-or-equal.ts"],"sourcesContent":[null],"names":["$comparison"],"mappings":";;;;AAGA;;AAEG;AACG,SAAU,eAAe,CAAC,KAAsB,EAAA;IACpD,OAAO;AACL,QAAA,IAAI,EAAEA,uCAAW;AACjB,QAAA,QAAQ,EAAE,IAAI;QACd,KAAK;KACN;AACH;;;;"}

package/dist/conditions/less-than-or-equal.d.ts

@@ -1,5 +1,8 @@
-import { ValueExpression, ComparisonExpressionTemplate } from './condition-types.js';
+import { ValueExpression, ComparisonExpressionTemplate } from './index.js';
 
+/**
+ * Creates a "less than or equal to" `<=` comparison expression template.
+ */
 declare function lessThanOrEqual(value: ValueExpression): ComparisonExpressionTemplate;
 
 export { lessThanOrEqual };

package/dist/conditions/less-than-or-equal.mjs

@@ -1,5 +1,8 @@
 import { $comparison } from './condition-symbols.mjs';
 
+/**
+ * Creates a "less than or equal to" `<=` comparison expression template.
+ */
 function lessThanOrEqual(value) {
     return {
         type: $comparison,

package/dist/conditions/less-than-or-equal.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"less-than-or-equal.mjs","sources":["../../src/conditions/less-than-or-equal.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAGM,SAAU,eAAe,CAAC,KAAsB,EAAA;IACpD,OAAO;AACL,QAAA,IAAI,EAAE,WAAW;AACjB,QAAA,QAAQ,EAAE,IAAI;QACd,KAAK;KACN;AACH;;;;"}
+{"version":3,"file":"less-than-or-equal.mjs","sources":["../../src/conditions/less-than-or-equal.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAGA;;AAEG;AACG,SAAU,eAAe,CAAC,KAAsB,EAAA;IACpD,OAAO;AACL,QAAA,IAAI,EAAE,WAAW;AACjB,QAAA,QAAQ,EAAE,IAAI;QACd,KAAK;KACN;AACH;;;;"}

package/dist/conditions/less-than.cjs

@@ -2,6 +2,9 @@
 
 var conditions_conditionSymbols = require('./condition-symbols.cjs');
 
+/**
+ * Creates a "less than" `<` comparison expression template.
+ */
 function lessThan(value) {
     return {
         type: conditions_conditionSymbols.$comparison,

package/dist/conditions/less-than.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"less-than.cjs","sources":["../../src/conditions/less-than.ts"],"sourcesContent":[null],"names":["$comparison"],"mappings":";;;;AAGM,SAAU,QAAQ,CAAC,KAAsB,EAAA;IAC7C,OAAO;AACL,QAAA,IAAI,EAAEA,uCAAW;AACjB,QAAA,QAAQ,EAAE,GAAG;QACb,KAAK;KACN;AACH;;;;"}
+{"version":3,"file":"less-than.cjs","sources":["../../src/conditions/less-than.ts"],"sourcesContent":[null],"names":["$comparison"],"mappings":";;;;AAGA;;AAEG;AACG,SAAU,QAAQ,CAAC,KAAsB,EAAA;IAC7C,OAAO;AACL,QAAA,IAAI,EAAEA,uCAAW;AACjB,QAAA,QAAQ,EAAE,GAAG;QACb,KAAK;KACN;AACH;;;;"}

package/dist/conditions/less-than.d.ts

@@ -1,5 +1,8 @@
-import { ValueExpression, ComparisonExpressionTemplate } from './condition-types.js';
+import { ValueExpression, ComparisonExpressionTemplate } from './index.js';
 
+/**
+ * Creates a "less than" `<` comparison expression template.
+ */
 declare function lessThan(value: ValueExpression): ComparisonExpressionTemplate;
 
 export { lessThan };

package/dist/conditions/less-than.mjs

@@ -1,5 +1,8 @@
 import { $comparison } from './condition-symbols.mjs';
 
+/**
+ * Creates a "less than" `<` comparison expression template.
+ */
 function lessThan(value) {
     return {
         type: $comparison,

package/dist/conditions/less-than.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"less-than.mjs","sources":["../../src/conditions/less-than.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAGM,SAAU,QAAQ,CAAC,KAAsB,EAAA;IAC7C,OAAO;AACL,QAAA,IAAI,EAAE,WAAW;AACjB,QAAA,QAAQ,EAAE,GAAG;QACb,KAAK;KACN;AACH;;;;"}
+{"version":3,"file":"less-than.mjs","sources":["../../src/conditions/less-than.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAGA;;AAEG;AACG,SAAU,QAAQ,CAAC,KAAsB,EAAA;IAC7C,OAAO;AACL,QAAA,IAAI,EAAE,WAAW;AACjB,QAAA,QAAQ,EAAE,GAAG;QACb,KAAK;KACN;AACH;;;;"}

package/dist/conditions/not-equals.cjs

@@ -2,6 +2,9 @@
 
 var conditions_conditionSymbols = require('./condition-symbols.cjs');
 
+/**
+ * Creates a "not equals" `<>` comparison expression template.
+ */
 function notEquals(value) {
     return {
         type: conditions_conditionSymbols.$comparison,

package/dist/conditions/not-equals.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"not-equals.cjs","sources":["../../src/conditions/not-equals.ts"],"sourcesContent":[null],"names":["$comparison"],"mappings":";;;;AAGM,SAAU,SAAS,CAAC,KAAsB,EAAA;IAC9C,OAAO;AACL,QAAA,IAAI,EAAEA,uCAAW;AACjB,QAAA,QAAQ,EAAE,IAAI;QACd,KAAK;KACN;AACH;;;;"}
+{"version":3,"file":"not-equals.cjs","sources":["../../src/conditions/not-equals.ts"],"sourcesContent":[null],"names":["$comparison"],"mappings":";;;;AAGA;;AAEG;AACG,SAAU,SAAS,CAAC,KAAsB,EAAA;IAC9C,OAAO;AACL,QAAA,IAAI,EAAEA,uCAAW;AACjB,QAAA,QAAQ,EAAE,IAAI;QACd,KAAK;KACN;AACH;;;;"}

package/dist/conditions/not-equals.d.ts

@@ -1,5 +1,8 @@
-import { ValueExpression, ComparisonExpressionTemplate } from './condition-types.js';
+import { ValueExpression, ComparisonExpressionTemplate } from './index.js';
 
+/**
+ * Creates a "not equals" `<>` comparison expression template.
+ */
 declare function notEquals(value: ValueExpression): ComparisonExpressionTemplate;
 
 export { notEquals };

package/dist/conditions/not-equals.mjs

@@ -1,5 +1,8 @@
 import { $comparison } from './condition-symbols.mjs';
 
+/**
+ * Creates a "not equals" `<>` comparison expression template.
+ */
 function notEquals(value) {
     return {
         type: $comparison,

package/dist/conditions/not-equals.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"not-equals.mjs","sources":["../../src/conditions/not-equals.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAGM,SAAU,SAAS,CAAC,KAAsB,EAAA;IAC9C,OAAO;AACL,QAAA,IAAI,EAAE,WAAW;AACjB,QAAA,QAAQ,EAAE,IAAI;QACd,KAAK;KACN;AACH;;;;"}
+{"version":3,"file":"not-equals.mjs","sources":["../../src/conditions/not-equals.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAGA;;AAEG;AACG,SAAU,SAAS,CAAC,KAAsB,EAAA;IAC9C,OAAO;AACL,QAAA,IAAI,EAAE,WAAW;AACjB,QAAA,QAAQ,EAAE,IAAI;QACd,KAAK;KACN;AACH;;;;"}

package/dist/conditions/not-exists.cjs

@@ -2,6 +2,9 @@
 
 var conditions_conditionSymbols = require('./condition-symbols.cjs');
 
+/**
+ * Creates a NOT EXISTS expression template.
+ */
 function notExists() {
     return {
         type: conditions_conditionSymbols.$exists,

package/dist/conditions/not-exists.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"not-exists.cjs","sources":["../../src/conditions/not-exists.ts"],"sourcesContent":[null],"names":["$exists"],"mappings":";;;;SAGgB,SAAS,GAAA;IACvB,OAAO;AACL,QAAA,IAAI,EAAEA,mCAAO;AACb,QAAA,GAAG,EAAE,IAAI;KACV;AACH;;;;"}
+{"version":3,"file":"not-exists.cjs","sources":["../../src/conditions/not-exists.ts"],"sourcesContent":[null],"names":["$exists"],"mappings":";;;;AAGA;;AAEG;SACa,SAAS,GAAA;IACvB,OAAO;AACL,QAAA,IAAI,EAAEA,mCAAO;AACb,QAAA,GAAG,EAAE,IAAI;KACV;AACH;;;;"}

package/dist/conditions/not-exists.d.ts

@@ -1,5 +1,8 @@
-import { ExistsExpressionTemplate } from './condition-types.js';
+import { ExistsExpressionTemplate } from './index.js';
 
+/**
+ * Creates a NOT EXISTS expression template.
+ */
 declare function notExists(): ExistsExpressionTemplate;
 
 export { notExists };

package/dist/conditions/not-exists.mjs

@@ -1,5 +1,8 @@
 import { $exists } from './condition-symbols.mjs';
 
+/**
+ * Creates a NOT EXISTS expression template.
+ */
 function notExists() {
     return {
         type: $exists,