dynamo-document-builder 0.5.0 → 0.6.1

package/dist/core/key.cjs

@@ -1,8 +1,56 @@
 'use strict';
 
+var errors = require('../errors.cjs');
+
+/**
+ * Builds a DynamoDB key from the given parts by concatenating them with a `#` separator.
+ * At least one part must be provided, or a DocumentBuilderError will be thrown.
+ *
+ * @param parts - The parts to combine into a key.
+ * @returns The combined key as a string.
+ *
+ * @example
+ * ```ts
+ * const key1 = key('USER', 123) // 'USER#123'
+ * const key2 = key('METADATA') // 'METADATA'
+ * ```
+ */
 function key(...parts) {
+    if (!parts.length) {
+        throw new errors.DocumentBuilderError('At least one key part must be provided');
+    }
     return parts.join('#');
 }
+/**
+ * Builds a DynamoDB key from the given parts. This function is specifically for secondary index keys,
+ * where any part can be undefined. If any part is undefined, the function returns undefined.
+ *
+ * For primary keys, use the `key` function instead.
+ *
+ * This is specifically useful for building keys for queries on secondary indexes, or for sparse indexes.
+ *
+ * @param parts - The parts to combine into a key.
+ * @returns The combined key as a string, or undefined if any part is undefined.
+ *
+ * @example
+ * ```ts
+ * const key1 = indexKey('part1', 'part2', 'part3') // 'part1#part2#part3'
+ * const key2 = indexKey('part1', undefined, 'part3') // undefined
+ * const key3 = indexKey(undefined, 'part2', 'part3') // undefined
+ * const key4 = indexKey('part1', 'part2', undefined) // undefined
+ * ```
+ */
+function indexKey(...parts) {
+    let key = '';
+    for (const part of parts) {
+        if (part === undefined) {
+            return undefined;
+        }
+        key += key ? `#${part}` : part;
+    }
+    return key;
+}
 
+exports.indexKey = indexKey;
 exports.key = key;
 //# sourceMappingURL=key.cjs.map

package/dist/core/key.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"key.cjs","sources":["../../src/core/key.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAsBM,SAAU,GAAG,CAAC,GAAG,KAA2B,EAAA;AAChD,IAAA,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;AACxB;;;;"}
+{"version":3,"file":"key.cjs","sources":["../../src/core/key.ts"],"sourcesContent":[null],"names":["DocumentBuilderError"],"mappings":";;;;AAsDA;;;;;;;;;;;;AAYG;AACG,SAAU,GAAG,CAAC,GAAG,KAA2B,EAAA;AAChD,IAAA,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;AACjB,QAAA,MAAM,IAAIA,2BAAoB,CAAC,wCAAwC,CAAC;IAC1E;AACA,IAAA,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;AACxB;AAEA;;;;;;;;;;;;;;;;;;AAkBG;AACG,SAAU,QAAQ,CAAC,GAAG,KAAgC,EAAA;IAC1D,IAAI,GAAG,GAAW,EAAE;AACpB,IAAA,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;AACxB,QAAA,IAAI,IAAI,KAAK,SAAS,EAAE;AACtB,YAAA,OAAO,SAAS;QAClB;AACA,QAAA,GAAG,IAAI,GAAG,GAAG,CAAA,CAAA,EAAI,IAAI,CAAA,CAAE,GAAG,IAAI;IAChC;AACA,IAAA,OAAO,GAAG;AACZ;;;;;"}

package/dist/core/key.d.ts

@@ -1,16 +1,76 @@
-import { IndexName } from './core-types.js';
+import { IndexName } from './index.js';
 
+/**
+ * Represents a value that can be used as a DynamoDB primary key.
+ */
 type DynamoKeyableValue = string | number | Buffer;
+/**
+ * Represents a value that can be used as a DynamoDB secondary index key.
+ */
+type DynamoIndexKeyableValue = string | number | Buffer | undefined;
+/**
+ * A function that builds a DynamoDB primary key from an item.
+ */
 type DynamoKeyBuilder<Item> = (item: Item) => DynamoKeyableValue;
+/**
+ * A function that builds a DynamoDB secondary index key from an item.
+ */
+type DynamoIndexKeyBuilder<Item> = (item: Item) => DynamoIndexKeyableValue;
+/**
+ * A mapping type of global secondary index names to their key builders.
+ */
 type GlobalSecondaryIndexKeyBuilders<Item> = Record<IndexName, {
-    partitionKey: DynamoKeyBuilder<Item>;
-    sortKey?: DynamoKeyBuilder<Item>;
+    partitionKey: DynamoIndexKeyBuilder<Item>;
+    sortKey?: DynamoIndexKeyBuilder<Item>;
 }>;
+/**
+ * A mapping type of local secondary index names to their key builders.
+ */
 type LocalSecondaryIndexKeyBuilders<Item> = Record<IndexName, {
-    sortKey: DynamoKeyBuilder<Item>;
+    sortKey: DynamoIndexKeyBuilder<Item>;
 }>;
+/**
+ * Record type representing a DynamoDB primary key.
+ */
 type DynamoKey = Record<string, DynamoKeyableValue>;
+/**
+ * Record type representing a DynamoDB secondary index key.
+ */
+type DynamoIndexKey = Record<string, DynamoIndexKeyableValue>;
+/**
+ * Builds a DynamoDB key from the given parts by concatenating them with a `#` separator.
+ * At least one part must be provided, or a DocumentBuilderError will be thrown.
+ *
+ * @param parts - The parts to combine into a key.
+ * @returns The combined key as a string.
+ *
+ * @example
+ * ```ts
+ * const key1 = key('USER', 123) // 'USER#123'
+ * const key2 = key('METADATA') // 'METADATA'
+ * ```
+ */
 declare function key(...parts: DynamoKeyableValue[]): string;
+/**
+ * Builds a DynamoDB key from the given parts. This function is specifically for secondary index keys,
+ * where any part can be undefined. If any part is undefined, the function returns undefined.
+ *
+ * For primary keys, use the `key` function instead.
+ *
+ * This is specifically useful for building keys for queries on secondary indexes, or for sparse indexes.
+ *
+ * @param parts - The parts to combine into a key.
+ * @returns The combined key as a string, or undefined if any part is undefined.
+ *
+ * @example
+ * ```ts
+ * const key1 = indexKey('part1', 'part2', 'part3') // 'part1#part2#part3'
+ * const key2 = indexKey('part1', undefined, 'part3') // undefined
+ * const key3 = indexKey(undefined, 'part2', 'part3') // undefined
+ * const key4 = indexKey('part1', 'part2', undefined) // undefined
+ * ```
+ */
+declare function indexKey(...parts: DynamoIndexKeyableValue[]): string | undefined;
 
-export { key };
-export type { DynamoKey, DynamoKeyBuilder, DynamoKeyableValue, GlobalSecondaryIndexKeyBuilders, LocalSecondaryIndexKeyBuilders };
+export { indexKey, key };
+export type { DynamoIndexKey, DynamoIndexKeyBuilder, DynamoIndexKeyableValue, DynamoKey, DynamoKeyBuilder, DynamoKeyableValue, GlobalSecondaryIndexKeyBuilders, LocalSecondaryIndexKeyBuilders };

package/dist/core/key.mjs

@@ -1,6 +1,53 @@
+import { DocumentBuilderError } from '../errors.mjs';
+
+/**
+ * Builds a DynamoDB key from the given parts by concatenating them with a `#` separator.
+ * At least one part must be provided, or a DocumentBuilderError will be thrown.
+ *
+ * @param parts - The parts to combine into a key.
+ * @returns The combined key as a string.
+ *
+ * @example
+ * ```ts
+ * const key1 = key('USER', 123) // 'USER#123'
+ * const key2 = key('METADATA') // 'METADATA'
+ * ```
+ */
 function key(...parts) {
+    if (!parts.length) {
+        throw new DocumentBuilderError('At least one key part must be provided');
+    }
     return parts.join('#');
 }
+/**
+ * Builds a DynamoDB key from the given parts. This function is specifically for secondary index keys,
+ * where any part can be undefined. If any part is undefined, the function returns undefined.
+ *
+ * For primary keys, use the `key` function instead.
+ *
+ * This is specifically useful for building keys for queries on secondary indexes, or for sparse indexes.
+ *
+ * @param parts - The parts to combine into a key.
+ * @returns The combined key as a string, or undefined if any part is undefined.
+ *
+ * @example
+ * ```ts
+ * const key1 = indexKey('part1', 'part2', 'part3') // 'part1#part2#part3'
+ * const key2 = indexKey('part1', undefined, 'part3') // undefined
+ * const key3 = indexKey(undefined, 'part2', 'part3') // undefined
+ * const key4 = indexKey('part1', 'part2', undefined) // undefined
+ * ```
+ */
+function indexKey(...parts) {
+    let key = '';
+    for (const part of parts) {
+        if (part === undefined) {
+            return undefined;
+        }
+        key += key ? `#${part}` : part;
+    }
+    return key;
+}
 
-export { key };
+export { indexKey, key };
 //# sourceMappingURL=key.mjs.map

package/dist/core/key.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"key.mjs","sources":["../../src/core/key.ts"],"sourcesContent":[null],"names":[],"mappings":"AAsBM,SAAU,GAAG,CAAC,GAAG,KAA2B,EAAA;AAChD,IAAA,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;AACxB;;;;"}
+{"version":3,"file":"key.mjs","sources":["../../src/core/key.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAsDA;;;;;;;;;;;;AAYG;AACG,SAAU,GAAG,CAAC,GAAG,KAA2B,EAAA;AAChD,IAAA,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;AACjB,QAAA,MAAM,IAAI,oBAAoB,CAAC,wCAAwC,CAAC;IAC1E;AACA,IAAA,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;AACxB;AAEA;;;;;;;;;;;;;;;;;;AAkBG;AACG,SAAU,QAAQ,CAAC,GAAG,KAAgC,EAAA;IAC1D,IAAI,GAAG,GAAW,EAAE;AACpB,IAAA,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;AACxB,QAAA,IAAI,IAAI,KAAK,SAAS,EAAE;AACtB,YAAA,OAAO,SAAS;QAClB;AACA,QAAA,GAAG,IAAI,GAAG,GAAG,CAAA,CAAA,EAAI,IAAI,CAAA,CAAE,GAAG,IAAI;IAChC;AACA,IAAA,OAAO,GAAG;AACZ;;;;"}

package/dist/core/table.cjs

@@ -3,6 +3,9 @@
 var tslib_es6 = require('../node_modules/tslib/tslib.es6.cjs');
 
 var _DynamoTable_tableName, _DynamoTable_documentClient, _DynamoTable_pk, _DynamoTable_sk, _DynamoTable_gsi, _DynamoTable_lsi;
+/**
+ * Core class that represents a DynamoDB table.
+ */
 class DynamoTable {
     constructor(config) {
         var _a, _b, _c, _d, _e, _f;
@@ -23,21 +26,40 @@ class DynamoTable {
         tslib_es6.__classPrivateFieldSet(this, _DynamoTable_gsi, (_d = (_c = config.keyNames) === null || _c === void 0 ? void 0 : _c.globalSecondaryIndexes) !== null && _d !== void 0 ? _d : {}, "f");
         tslib_es6.__classPrivateFieldSet(this, _DynamoTable_lsi, (_f = (_e = config.keyNames) === null || _e === void 0 ? void 0 : _e.localSecondaryIndexes) !== null && _f !== void 0 ? _f : {}, "f");
     }
+    /**
+     * The name of the DynamoDB table.
+     */
     get tableName() {
         return tslib_es6.__classPrivateFieldGet(this, _DynamoTable_tableName, "f");
     }
+    /**
+     * The DynamoDB Document Client instance used for operations.
+     */
     get documentClient() {
         return tslib_es6.__classPrivateFieldGet(this, _DynamoTable_documentClient, "f");
     }
+    /**
+     * The name of the partition key for the table.
+     */
     get partitionKeyName() {
         return tslib_es6.__classPrivateFieldGet(this, _DynamoTable_pk, "f");
     }
+    /**
+     * The name of the sort key for the table, or `null` if the table does not have a sort key
+     * (`null` would indicate a "simple" primary key).
+     */
     get sortKeyName() {
         return tslib_es6.__classPrivateFieldGet(this, _DynamoTable_sk, "f");
     }
+    /**
+     * The key names for the global secondary indexes defined on the table.
+     */
     get globalSecondaryIndexKeyNames() {
         return tslib_es6.__classPrivateFieldGet(this, _DynamoTable_gsi, "f");
     }
+    /**
+     * The key names for the local secondary indexes defined on the table.
+     */
     get localSecondaryIndexKeyNames() {
         return tslib_es6.__classPrivateFieldGet(this, _DynamoTable_lsi, "f");
     }

package/dist/core/table.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"table.cjs","sources":["../../src/core/table.ts"],"sourcesContent":[null],"names":["__classPrivateFieldSet","__classPrivateFieldGet"],"mappings":";;;;;MAiBa,WAAW,CAAA;AAUtB,IAAA,WAAA,CAAY,MAAyB,EAAA;;QATrC,sBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;QACA,2BAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;AAEA,QAAA,eAAA,CAAA,GAAA,CAAA,IAAA,EAAc,IAAI,CAAA;AAClB,QAAA,eAAA,CAAA,GAAA,CAAA,IAAA,EAAqB,IAAI,CAAA;QAEzB,gBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;QACA,gBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;AAGE,QAAAA,gCAAA,CAAA,IAAI,EAAA,sBAAA,EAAc,MAAM,CAAC,SAAS,MAAA;AAClC,QAAAA,gCAAA,CAAA,IAAI,EAAA,2BAAA,EAAmB,MAAM,CAAC,cAAc,MAAA;QAC5C,IAAI,CAAA,CAAA,EAAA,GAAA,MAAM,CAAC,QAAQ,0CAAE,YAAY,MAAK,SAAS,EAAE;YAC/CA,gCAAA,CAAA,IAAI,mBAAO,MAAM,CAAC,QAAQ,CAAC,YAAY,MAAA;QACzC;QACA,IAAI,CAAA,CAAA,EAAA,GAAA,MAAM,CAAC,QAAQ,0CAAE,OAAO,MAAK,SAAS,EAAE;YAC1CA,gCAAA,CAAA,IAAI,mBAAO,MAAM,CAAC,QAAQ,CAAC,OAAO,MAAA;QACpC;AACA,QAAAA,gCAAA,CAAA,IAAI,EAAA,gBAAA,EAAQ,CAAA,EAAA,GAAA,CAAA,EAAA,GAAA,MAAM,CAAC,QAAQ,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,MAAA,GAAA,EAAA,CAAE,sBAAsB,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,EAAA,GAAI,EAAE,EAAA,GAAA,CAAA;AACzD,QAAAA,gCAAA,CAAA,IAAI,EAAA,gBAAA,EAAQ,CAAA,EAAA,GAAA,CAAA,EAAA,GAAA,MAAM,CAAC,QAAQ,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,MAAA,GAAA,EAAA,CAAE,qBAAqB,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,EAAA,GAAI,EAAE,EAAA,GAAA,CAAA;IAC1D;AAEA,IAAA,IAAW,SAAS,GAAA;QAClB,OAAOC,gCAAA,CAAA,IAAI,EAAA,sBAAA,EAAA,GAAA,CAAW;IACxB;AAEA,IAAA,IAAW,cAAc,GAAA;QACvB,OAAOA,gCAAA,CAAA,IAAI,EAAA,2BAAA,EAAA,GAAA,CAAgB;IAC7B;AAEA,IAAA,IAAW,gBAAgB,GAAA;QACzB,OAAOA,gCAAA,CAAA,IAAI,EAAA,eAAA,EAAA,GAAA,CAAI;IACjB;AAEA,IAAA,IAAW,WAAW,GAAA;QACpB,OAAOA,gCAAA,CAAA,IAAI,EAAA,eAAA,EAAA,GAAA,CAAI;IACjB;AAEA,IAAA,IAAW,4BAA4B,GAAA;QACrC,OAAOA,gCAAA,CAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAK;IAClB;AAEA,IAAA,IAAW,2BAA2B,GAAA;QACpC,OAAOA,gCAAA,CAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAK;IAClB;AACD;;;;;"}
+{"version":3,"file":"table.cjs","sources":["../../src/core/table.ts"],"sourcesContent":[null],"names":["__classPrivateFieldSet","__classPrivateFieldGet"],"mappings":";;;;;AA0BA;;AAEG;MACU,WAAW,CAAA;AAUtB,IAAA,WAAA,CAAY,MAAyB,EAAA;;QATrC,sBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;QACA,2BAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;AAEA,QAAA,eAAA,CAAA,GAAA,CAAA,IAAA,EAAc,IAAI,CAAA;AAClB,QAAA,eAAA,CAAA,GAAA,CAAA,IAAA,EAAqB,IAAI,CAAA;QAEzB,gBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;QACA,gBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;AAGE,QAAAA,gCAAA,CAAA,IAAI,EAAA,sBAAA,EAAc,MAAM,CAAC,SAAS,MAAA;AAClC,QAAAA,gCAAA,CAAA,IAAI,EAAA,2BAAA,EAAmB,MAAM,CAAC,cAAc,MAAA;QAC5C,IAAI,CAAA,CAAA,EAAA,GAAA,MAAM,CAAC,QAAQ,0CAAE,YAAY,MAAK,SAAS,EAAE;YAC/CA,gCAAA,CAAA,IAAI,mBAAO,MAAM,CAAC,QAAQ,CAAC,YAAY,MAAA;QACzC;QACA,IAAI,CAAA,CAAA,EAAA,GAAA,MAAM,CAAC,QAAQ,0CAAE,OAAO,MAAK,SAAS,EAAE;YAC1CA,gCAAA,CAAA,IAAI,mBAAO,MAAM,CAAC,QAAQ,CAAC,OAAO,MAAA;QACpC;AACA,QAAAA,gCAAA,CAAA,IAAI,EAAA,gBAAA,EAAQ,CAAA,EAAA,GAAA,CAAA,EAAA,GAAA,MAAM,CAAC,QAAQ,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,MAAA,GAAA,EAAA,CAAE,sBAAsB,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,EAAA,GAAI,EAAE,EAAA,GAAA,CAAA;AACzD,QAAAA,gCAAA,CAAA,IAAI,EAAA,gBAAA,EAAQ,CAAA,EAAA,GAAA,CAAA,EAAA,GAAA,MAAM,CAAC,QAAQ,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,MAAA,GAAA,EAAA,CAAE,qBAAqB,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,EAAA,GAAI,EAAE,EAAA,GAAA,CAAA;IAC1D;AAEA;;AAEG;AACH,IAAA,IAAW,SAAS,GAAA;QAClB,OAAOC,gCAAA,CAAA,IAAI,EAAA,sBAAA,EAAA,GAAA,CAAW;IACxB;AAEA;;AAEG;AACH,IAAA,IAAW,cAAc,GAAA;QACvB,OAAOA,gCAAA,CAAA,IAAI,EAAA,2BAAA,EAAA,GAAA,CAAgB;IAC7B;AAEA;;AAEG;AACH,IAAA,IAAW,gBAAgB,GAAA;QACzB,OAAOA,gCAAA,CAAA,IAAI,EAAA,eAAA,EAAA,GAAA,CAAI;IACjB;AAEA;;;AAGG;AACH,IAAA,IAAW,WAAW,GAAA;QACpB,OAAOA,gCAAA,CAAA,IAAI,EAAA,eAAA,EAAA,GAAA,CAAI;IACjB;AAEA;;AAEG;AACH,IAAA,IAAW,4BAA4B,GAAA;QACrC,OAAOA,gCAAA,CAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAK;IAClB;AAEA;;AAEG;AACH,IAAA,IAAW,2BAA2B,GAAA;QACpC,OAAOA,gCAAA,CAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAK;IAClB;AACD;;;;;"}

package/dist/core/table.d.ts

@@ -1,6 +1,18 @@
 import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb';
-import { NamedGlobalSecondaryIndexKeyNames, NamedLocalSecondaryIndexKeyNames } from './core-types.js';
+import { NamedGlobalSecondaryIndexKeyNames, NamedLocalSecondaryIndexKeyNames } from './index.js';
 
+/**
+ * Configuration type for creating a DynamoTable.
+ *
+ * The table is assumed to have a primary key composed of a partition key named `"PK"` and
+ * a sort key named `"SK"` by default, unless overridden in the `keyNames` property.
+ *
+ * @template Schema - The Zod schema representing the entity's structure.
+ *
+ * @property tableName - The name of the DynamoDB table.
+ * @property documentClient - The DynamoDB Document Client instance to use for operations.
+ * @property keyNames - Key names object for the table's primary key and secondary indexes.
+ */
 type DynamoTableConfig = {
     tableName: string;
     documentClient: DynamoDBDocumentClient;
@@ -11,14 +23,36 @@ type DynamoTableConfig = {
         localSecondaryIndexes?: NamedLocalSecondaryIndexKeyNames;
     };
 };
+/**
+ * Core class that represents a DynamoDB table.
+ */
 declare class DynamoTable {
     #private;
     constructor(config: DynamoTableConfig);
+    /**
+     * The name of the DynamoDB table.
+     */
     get tableName(): string;
+    /**
+     * The DynamoDB Document Client instance used for operations.
+     */
     get documentClient(): DynamoDBDocumentClient;
+    /**
+     * The name of the partition key for the table.
+     */
     get partitionKeyName(): string;
+    /**
+     * The name of the sort key for the table, or `null` if the table does not have a sort key
+     * (`null` would indicate a "simple" primary key).
+     */
     get sortKeyName(): string | null;
+    /**
+     * The key names for the global secondary indexes defined on the table.
+     */
     get globalSecondaryIndexKeyNames(): NamedGlobalSecondaryIndexKeyNames;
+    /**
+     * The key names for the local secondary indexes defined on the table.
+     */
     get localSecondaryIndexKeyNames(): NamedLocalSecondaryIndexKeyNames;
 }
 

package/dist/core/table.mjs

@@ -1,6 +1,9 @@
 import { __classPrivateFieldSet, __classPrivateFieldGet } from '../node_modules/tslib/tslib.es6.mjs';
 
 var _DynamoTable_tableName, _DynamoTable_documentClient, _DynamoTable_pk, _DynamoTable_sk, _DynamoTable_gsi, _DynamoTable_lsi;
+/**
+ * Core class that represents a DynamoDB table.
+ */
 class DynamoTable {
     constructor(config) {
         var _a, _b, _c, _d, _e, _f;
@@ -21,21 +24,40 @@ class DynamoTable {
         __classPrivateFieldSet(this, _DynamoTable_gsi, (_d = (_c = config.keyNames) === null || _c === void 0 ? void 0 : _c.globalSecondaryIndexes) !== null && _d !== void 0 ? _d : {}, "f");
         __classPrivateFieldSet(this, _DynamoTable_lsi, (_f = (_e = config.keyNames) === null || _e === void 0 ? void 0 : _e.localSecondaryIndexes) !== null && _f !== void 0 ? _f : {}, "f");
     }
+    /**
+     * The name of the DynamoDB table.
+     */
     get tableName() {
         return __classPrivateFieldGet(this, _DynamoTable_tableName, "f");
     }
+    /**
+     * The DynamoDB Document Client instance used for operations.
+     */
     get documentClient() {
         return __classPrivateFieldGet(this, _DynamoTable_documentClient, "f");
     }
+    /**
+     * The name of the partition key for the table.
+     */
     get partitionKeyName() {
         return __classPrivateFieldGet(this, _DynamoTable_pk, "f");
     }
+    /**
+     * The name of the sort key for the table, or `null` if the table does not have a sort key
+     * (`null` would indicate a "simple" primary key).
+     */
     get sortKeyName() {
         return __classPrivateFieldGet(this, _DynamoTable_sk, "f");
     }
+    /**
+     * The key names for the global secondary indexes defined on the table.
+     */
     get globalSecondaryIndexKeyNames() {
         return __classPrivateFieldGet(this, _DynamoTable_gsi, "f");
     }
+    /**
+     * The key names for the local secondary indexes defined on the table.
+     */
     get localSecondaryIndexKeyNames() {
         return __classPrivateFieldGet(this, _DynamoTable_lsi, "f");
     }

package/dist/core/table.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"table.mjs","sources":["../../src/core/table.ts"],"sourcesContent":[null],"names":[],"mappings":";;;MAiBa,WAAW,CAAA;AAUtB,IAAA,WAAA,CAAY,MAAyB,EAAA;;QATrC,sBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;QACA,2BAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;AAEA,QAAA,eAAA,CAAA,GAAA,CAAA,IAAA,EAAc,IAAI,CAAA;AAClB,QAAA,eAAA,CAAA,GAAA,CAAA,IAAA,EAAqB,IAAI,CAAA;QAEzB,gBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;QACA,gBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;AAGE,QAAA,sBAAA,CAAA,IAAI,EAAA,sBAAA,EAAc,MAAM,CAAC,SAAS,MAAA;AAClC,QAAA,sBAAA,CAAA,IAAI,EAAA,2BAAA,EAAmB,MAAM,CAAC,cAAc,MAAA;QAC5C,IAAI,CAAA,CAAA,EAAA,GAAA,MAAM,CAAC,QAAQ,0CAAE,YAAY,MAAK,SAAS,EAAE;YAC/C,sBAAA,CAAA,IAAI,mBAAO,MAAM,CAAC,QAAQ,CAAC,YAAY,MAAA;QACzC;QACA,IAAI,CAAA,CAAA,EAAA,GAAA,MAAM,CAAC,QAAQ,0CAAE,OAAO,MAAK,SAAS,EAAE;YAC1C,sBAAA,CAAA,IAAI,mBAAO,MAAM,CAAC,QAAQ,CAAC,OAAO,MAAA;QACpC;AACA,QAAA,sBAAA,CAAA,IAAI,EAAA,gBAAA,EAAQ,CAAA,EAAA,GAAA,CAAA,EAAA,GAAA,MAAM,CAAC,QAAQ,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,MAAA,GAAA,EAAA,CAAE,sBAAsB,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,EAAA,GAAI,EAAE,EAAA,GAAA,CAAA;AACzD,QAAA,sBAAA,CAAA,IAAI,EAAA,gBAAA,EAAQ,CAAA,EAAA,GAAA,CAAA,EAAA,GAAA,MAAM,CAAC,QAAQ,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,MAAA,GAAA,EAAA,CAAE,qBAAqB,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,EAAA,GAAI,EAAE,EAAA,GAAA,CAAA;IAC1D;AAEA,IAAA,IAAW,SAAS,GAAA;QAClB,OAAO,sBAAA,CAAA,IAAI,EAAA,sBAAA,EAAA,GAAA,CAAW;IACxB;AAEA,IAAA,IAAW,cAAc,GAAA;QACvB,OAAO,sBAAA,CAAA,IAAI,EAAA,2BAAA,EAAA,GAAA,CAAgB;IAC7B;AAEA,IAAA,IAAW,gBAAgB,GAAA;QACzB,OAAO,sBAAA,CAAA,IAAI,EAAA,eAAA,EAAA,GAAA,CAAI;IACjB;AAEA,IAAA,IAAW,WAAW,GAAA;QACpB,OAAO,sBAAA,CAAA,IAAI,EAAA,eAAA,EAAA,GAAA,CAAI;IACjB;AAEA,IAAA,IAAW,4BAA4B,GAAA;QACrC,OAAO,sBAAA,CAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAK;IAClB;AAEA,IAAA,IAAW,2BAA2B,GAAA;QACpC,OAAO,sBAAA,CAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAK;IAClB;AACD;;;;;"}
+{"version":3,"file":"table.mjs","sources":["../../src/core/table.ts"],"sourcesContent":[null],"names":[],"mappings":";;;AA0BA;;AAEG;MACU,WAAW,CAAA;AAUtB,IAAA,WAAA,CAAY,MAAyB,EAAA;;QATrC,sBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;QACA,2BAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;AAEA,QAAA,eAAA,CAAA,GAAA,CAAA,IAAA,EAAc,IAAI,CAAA;AAClB,QAAA,eAAA,CAAA,GAAA,CAAA,IAAA,EAAqB,IAAI,CAAA;QAEzB,gBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;QACA,gBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;AAGE,QAAA,sBAAA,CAAA,IAAI,EAAA,sBAAA,EAAc,MAAM,CAAC,SAAS,MAAA;AAClC,QAAA,sBAAA,CAAA,IAAI,EAAA,2BAAA,EAAmB,MAAM,CAAC,cAAc,MAAA;QAC5C,IAAI,CAAA,CAAA,EAAA,GAAA,MAAM,CAAC,QAAQ,0CAAE,YAAY,MAAK,SAAS,EAAE;YAC/C,sBAAA,CAAA,IAAI,mBAAO,MAAM,CAAC,QAAQ,CAAC,YAAY,MAAA;QACzC;QACA,IAAI,CAAA,CAAA,EAAA,GAAA,MAAM,CAAC,QAAQ,0CAAE,OAAO,MAAK,SAAS,EAAE;YAC1C,sBAAA,CAAA,IAAI,mBAAO,MAAM,CAAC,QAAQ,CAAC,OAAO,MAAA;QACpC;AACA,QAAA,sBAAA,CAAA,IAAI,EAAA,gBAAA,EAAQ,CAAA,EAAA,GAAA,CAAA,EAAA,GAAA,MAAM,CAAC,QAAQ,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,MAAA,GAAA,EAAA,CAAE,sBAAsB,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,EAAA,GAAI,EAAE,EAAA,GAAA,CAAA;AACzD,QAAA,sBAAA,CAAA,IAAI,EAAA,gBAAA,EAAQ,CAAA,EAAA,GAAA,CAAA,EAAA,GAAA,MAAM,CAAC,QAAQ,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,MAAA,GAAA,EAAA,CAAE,qBAAqB,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,EAAA,GAAI,EAAE,EAAA,GAAA,CAAA;IAC1D;AAEA;;AAEG;AACH,IAAA,IAAW,SAAS,GAAA;QAClB,OAAO,sBAAA,CAAA,IAAI,EAAA,sBAAA,EAAA,GAAA,CAAW;IACxB;AAEA;;AAEG;AACH,IAAA,IAAW,cAAc,GAAA;QACvB,OAAO,sBAAA,CAAA,IAAI,EAAA,2BAAA,EAAA,GAAA,CAAgB;IAC7B;AAEA;;AAEG;AACH,IAAA,IAAW,gBAAgB,GAAA;QACzB,OAAO,sBAAA,CAAA,IAAI,EAAA,eAAA,EAAA,GAAA,CAAI;IACjB;AAEA;;;AAGG;AACH,IAAA,IAAW,WAAW,GAAA;QACpB,OAAO,sBAAA,CAAA,IAAI,EAAA,eAAA,EAAA,GAAA,CAAI;IACjB;AAEA;;AAEG;AACH,IAAA,IAAW,4BAA4B,GAAA;QACrC,OAAO,sBAAA,CAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAK;IAClB;AAEA;;AAEG;AACH,IAAA,IAAW,2BAA2B,GAAA;QACpC,OAAO,sBAAA,CAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAK;IAClB;AACD;;;;;"}

package/dist/errors.cjs

@@ -1,5 +1,8 @@
 'use strict';
 
+/**
+ * Custom error class for handling Document Builder related errors.
+ */
 class DocumentBuilderError extends Error {
     constructor(message) {
         super(`DocumentBuilderError: ${message}`);

package/dist/errors.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"errors.cjs","sources":["../src/errors.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAAM,MAAO,oBAAqB,SAAQ,KAAK,CAAA;AAC7C,IAAA,WAAA,CAAY,OAAe,EAAA;AACzB,QAAA,KAAK,CAAC,CAAA,sBAAA,EAAyB,OAAO,CAAA,CAAE,CAAC;AACzC,QAAA,IAAI,CAAC,IAAI,GAAG,sBAAsB;AAClC,QAAA,IAAI,CAAC,OAAO,GAAG,OAAO;IACxB;AACD;;;;"}
+{"version":3,"file":"errors.cjs","sources":["../src/errors.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAAA;;AAEG;AACG,MAAO,oBAAqB,SAAQ,KAAK,CAAA;AAC7C,IAAA,WAAA,CAAY,OAAe,EAAA;AACzB,QAAA,KAAK,CAAC,CAAA,sBAAA,EAAyB,OAAO,CAAA,CAAE,CAAC;AACzC,QAAA,IAAI,CAAC,IAAI,GAAG,sBAAsB;AAClC,QAAA,IAAI,CAAC,OAAO,GAAG,OAAO;IACxB;AACD;;;;"}

package/dist/errors.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Custom error class for handling Document Builder related errors.
+ */
 declare class DocumentBuilderError extends Error {
     constructor(message: string);
 }

package/dist/errors.mjs

@@ -1,3 +1,6 @@
+/**
+ * Custom error class for handling Document Builder related errors.
+ */
 class DocumentBuilderError extends Error {
     constructor(message) {
         super(`DocumentBuilderError: ${message}`);

package/dist/errors.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"errors.mjs","sources":["../src/errors.ts"],"sourcesContent":[null],"names":[],"mappings":"AAAM,MAAO,oBAAqB,SAAQ,KAAK,CAAA;AAC7C,IAAA,WAAA,CAAY,OAAe,EAAA;AACzB,QAAA,KAAK,CAAC,CAAA,sBAAA,EAAyB,OAAO,CAAA,CAAE,CAAC;AACzC,QAAA,IAAI,CAAC,IAAI,GAAG,sBAAsB;AAClC,QAAA,IAAI,CAAC,OAAO,GAAG,OAAO;IACxB;AACD;;;;"}
+{"version":3,"file":"errors.mjs","sources":["../src/errors.ts"],"sourcesContent":[null],"names":[],"mappings":"AAAA;;AAEG;AACG,MAAO,oBAAqB,SAAQ,KAAK,CAAA;AAC7C,IAAA,WAAA,CAAY,OAAe,EAAA;AACzB,QAAA,KAAK,CAAC,CAAA,sBAAA,EAAyB,OAAO,CAAA,CAAE,CAAC;AACzC,QAAA,IAAI,CAAC,IAAI,GAAG,sBAAsB;AAClC,QAAA,IAAI,CAAC,OAAO,GAAG,OAAO;IACxB;AACD;;;;"}

package/dist/index.cjs

@@ -1,6 +1,7 @@
 'use strict';
 
 var attributes_attributeMap = require('./attributes/attribute-map.cjs');
+var errors = require('./errors.cjs');
 var commands_get = require('./commands/get.cjs');
 var commands_query = require('./commands/query.cjs');
 var commands_scan = require('./commands/scan.cjs');
@@ -19,10 +20,10 @@ var commands_conditionalDelete = require('./commands/conditional-delete.cjs');
 var commands_batchWrite = require('./commands/batch-write.cjs');
 var commands_transactWrite = require('./commands/transact-write.cjs');
 var commands_conditionCheck = require('./commands/condition-check.cjs');
+var conditions_conditionParser = require('./conditions/condition-parser.cjs');
 var conditions_and = require('./conditions/and.cjs');
 var conditions_beginsWith = require('./conditions/begins-with.cjs');
 var conditions_between = require('./conditions/between.cjs');
-var conditions_conditionParser = require('./conditions/condition-parser.cjs');
 var conditions_contains = require('./conditions/contains.cjs');
 var conditions_equals = require('./conditions/equals.cjs');
 var conditions_exists = require('./conditions/exists.cjs');
@@ -40,7 +41,6 @@ var conditions_typeIs = require('./conditions/type-is.cjs');
 var core_entity = require('./core/entity.cjs');
 var core_key = require('./core/key.cjs');
 var core_table = require('./core/table.cjs');
-var errors = require('./errors.cjs');
 var projections_projectionParser = require('./projections/projection-parser.cjs');
 var updates_updateParser = require('./updates/update-parser.cjs');
 var updates_ref = require('./updates/ref.cjs');
@@ -55,6 +55,7 @@ var updates_removeFromSet = require('./updates/remove-from-set.cjs');
 
 
 exports.AttributeExpressionMap = attributes_attributeMap.AttributeExpressionMap;
+exports.DocumentBuilderError = errors.DocumentBuilderError;
 exports.Get = commands_get.Get;
 exports.Query = commands_query.Query;
 exports.Scan = commands_scan.Scan;
@@ -73,10 +74,10 @@ exports.ConditionalDelete = commands_conditionalDelete.ConditionalDelete;
 exports.BatchWrite = commands_batchWrite.BatchWrite;
 exports.TransactWrite = commands_transactWrite.TransactWrite;
 exports.ConditionCheck = commands_conditionCheck.ConditionCheck;
+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;
@@ -92,9 +93,9 @@ exports.or = conditions_or.or;
 exports.size = conditions_size.size;
 exports.typeIs = conditions_typeIs.typeIs;
 exports.DynamoEntity = core_entity.DynamoEntity;
+exports.indexKey = core_key.indexKey;
 exports.key = core_key.key;
 exports.DynamoTable = core_table.DynamoTable;
-exports.DocumentBuilderError = errors.DocumentBuilderError;
 exports.parseProjection = projections_projectionParser.parseProjection;
 exports.parseUpdate = updates_updateParser.parseUpdate;
 exports.ref = updates_ref.ref;

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/index.d.ts

@@ -1,5 +1,10 @@
 export { AttributeExpressionMap, AttributeNamePlaceholder, AttributeNames, AttributeValuePlaceholder, AttributeValues, DynamoAttributeExpression } from './attributes/attribute-map.js';
-export { BaseCommand, BaseConfig, BasePaginatable, BaseResult, WriteTransactable } from './commands/base-command.js';
+export { BaseCommand, BaseConfig, BasePaginatable, BaseResult, WriteTransactable } from './commands/index.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 './conditions/index.js';
+export { EncodedEntity, EncodedEntitySchema, Entity, EntitySchema, GlobalSecondaryIndexKeyName, IndexName, LocalSecondaryIndexKeyName, NamedGlobalSecondaryIndexKeyNames, NamedLocalSecondaryIndexKeyNames, TransactWriteOperation } from './core/index.js';
+export { DocumentBuilderError } from './errors.js';
+export { Projection } from './projections/index.js';
+export { AddExpression, AddToSetExpression, AppendExpression, DeleteExpression, PrependExpression, RemoveExpression, SubtractExpression, UpdateExpression, UpdateType, UpdateValues, ValueReference } from './updates/index.js';
 export { Get, GetConfig, GetResult } from './commands/get.js';
 export { Query, QueryConfig, QueryResult } from './commands/query.js';
 export { Scan, ScanConfig, ScanResult } from './commands/scan.js';
@@ -18,11 +23,10 @@ export { ConditionalDelete, ConditionalDeleteConfig, ConditionalDeleteResult } f
 export { BatchWrite, BatchWriteConfig, BatchWriteResult } from './commands/batch-write.js';
 export { TransactWrite, TransactWriteConfig, TransactWriteResult } from './commands/transact-write.js';
 export { ConditionCheck, ConditionCheckConfig } from './commands/condition-check.js';
+export { ConditionParserResult, parseCondition } from './conditions/condition-parser.js';
 export { and } from './conditions/and.js';
 export { beginsWith } from './conditions/begins-with.js';
 export { between } from './conditions/between.js';
-export { ConditionParserResult, parseCondition } from './conditions/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 './conditions/condition-types.js';
 export { contains } from './conditions/contains.js';
 export { equals } from './conditions/equals.js';
 export { exists } from './conditions/exists.js';
@@ -37,15 +41,11 @@ export { notExists } from './conditions/not-exists.js';
 export { or } from './conditions/or.js';
 export { size } from './conditions/size.js';
 export { typeIs } from './conditions/type-is.js';
-export { EncodedEntity, EncodedEntitySchema, Entity, EntitySchema, GlobalSecondaryIndexKeyName, IndexName, LocalSecondaryIndexKeyName, NamedGlobalSecondaryIndexKeyNames, NamedLocalSecondaryIndexKeyNames, TransactWriteOperation } from './core/core-types.js';
 export { DynamoEntity, DynamoEntityConfig, EntityKeyInput } from './core/entity.js';
-export { DynamoKey, DynamoKeyBuilder, DynamoKeyableValue, GlobalSecondaryIndexKeyBuilders, LocalSecondaryIndexKeyBuilders, key } from './core/key.js';
+export { DynamoIndexKey, DynamoIndexKeyBuilder, DynamoIndexKeyableValue, DynamoKey, DynamoKeyBuilder, DynamoKeyableValue, GlobalSecondaryIndexKeyBuilders, LocalSecondaryIndexKeyBuilders, indexKey, key } from './core/key.js';
 export { DynamoTable, DynamoTableConfig } from './core/table.js';
-export { DocumentBuilderError } from './errors.js';
-export { Projection } from './projections/projection-types.js';
 export { ProjectionResult, parseProjection } from './projections/projection-parser.js';
 export { UpdateParserResult, parseUpdate } from './updates/update-parser.js';
-export { AddExpression, AddToSetExpression, AppendExpression, DeleteExpression, PrependExpression, RemoveExpression, SubtractExpression, UpdateExpression, UpdateType, UpdateValues, ValueReference } from './updates/update-types.js';
 export { ref } from './updates/ref.js';
 export { remove } from './updates/remove.js';
 export { add } from './updates/add.js';

package/dist/index.mjs

@@ -1,4 +1,5 @@
 export { AttributeExpressionMap } from './attributes/attribute-map.mjs';
+export { DocumentBuilderError } from './errors.mjs';
 export { Get } from './commands/get.mjs';
 export { Query } from './commands/query.mjs';
 export { Scan } from './commands/scan.mjs';
@@ -17,10 +18,10 @@ export { ConditionalDelete } from './commands/conditional-delete.mjs';
 export { BatchWrite } from './commands/batch-write.mjs';
 export { TransactWrite } from './commands/transact-write.mjs';
 export { ConditionCheck } from './commands/condition-check.mjs';
+export { parseCondition } from './conditions/condition-parser.mjs';
 export { and } from './conditions/and.mjs';
 export { beginsWith } from './conditions/begins-with.mjs';
 export { between } from './conditions/between.mjs';
-export { parseCondition } from './conditions/condition-parser.mjs';
 export { contains } from './conditions/contains.mjs';
 export { equals } from './conditions/equals.mjs';
 export { exists } from './conditions/exists.mjs';
@@ -36,9 +37,8 @@ export { or } from './conditions/or.mjs';
 export { size } from './conditions/size.mjs';
 export { typeIs } from './conditions/type-is.mjs';
 export { DynamoEntity } from './core/entity.mjs';
-export { key } from './core/key.mjs';
+export { indexKey, key } from './core/key.mjs';
 export { DynamoTable } from './core/table.mjs';
-export { DocumentBuilderError } from './errors.mjs';
 export { parseProjection } from './projections/projection-parser.mjs';
 export { parseUpdate } from './updates/update-parser.mjs';
 export { ref } from './updates/ref.mjs';

package/dist/projections/index.d.ts

@@ -1,2 +1,8 @@
-export { Projection } from './projection-types.js';
 export { ProjectionResult, parseProjection } from './projection-parser.js';
+
+/**
+ * Type representing a DynamoDB projection (list of attribute names).
+ */
+type Projection = string[];
+
+export type { Projection };

package/dist/projections/projection-parser.d.ts

@@ -1,5 +1,5 @@
 import { AttributeExpressionMap } from '../attributes/attribute-map.js';
-import { Projection } from './projection-types.js';
+import { Projection } from './index.js';
 
 type ProjectionResult = {
     projectionExpression: string;

package/dist/updates/add-to-set.cjs

@@ -2,6 +2,11 @@
 
 var updates_updateSymbols = require('./update-symbols.cjs');
 
+/**
+ * Update function to add values to a set attribute.
+ *
+ * @param values - The values or reference to add to the set.
+ */
 function addToSet(values) {
     return {
         type: updates_updateSymbols.$add,

package/dist/updates/add-to-set.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"add-to-set.cjs","sources":["../../src/updates/add-to-set.ts"],"sourcesContent":[null],"names":["$add","$addToSet"],"mappings":";;;;AAIM,SAAU,QAAQ,CAAC,MAA+C,EAAA;IACtE,OAAO;AACL,QAAA,IAAI,EAAEA,0BAAI;AACV,QAAA,EAAE,EAAEC,+BAAS;QACb,MAAM;KACP;AACH;;;;"}
+{"version":3,"file":"add-to-set.cjs","sources":["../../src/updates/add-to-set.ts"],"sourcesContent":[null],"names":["$add","$addToSet"],"mappings":";;;;AAIA;;;;AAIG;AACG,SAAU,QAAQ,CAAC,MAA+C,EAAA;IACtE,OAAO;AACL,QAAA,IAAI,EAAEA,0BAAI;AACV,QAAA,EAAE,EAAEC,+BAAS;QACb,MAAM;KACP;AACH;;;;"}

package/dist/updates/add-to-set.d.ts

@@ -1,6 +1,11 @@
 import { NativeAttributeValue } from '@aws-sdk/lib-dynamodb';
-import { ValueReference, AddToSetExpression } from './update-types.js';
+import { ValueReference, AddToSetExpression } from './index.js';
 
+/**
+ * Update function to add values to a set attribute.
+ *
+ * @param values - The values or reference to add to the set.
+ */
 declare function addToSet(values: NativeAttributeValue[] | ValueReference): AddToSetExpression;
 
 export { addToSet };

package/dist/updates/add-to-set.mjs

@@ -1,5 +1,10 @@
 import { $addToSet, $add } from './update-symbols.mjs';
 
+/**
+ * Update function to add values to a set attribute.
+ *
+ * @param values - The values or reference to add to the set.
+ */
 function addToSet(values) {
     return {
         type: $add,

package/dist/updates/add-to-set.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"add-to-set.mjs","sources":["../../src/updates/add-to-set.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAIM,SAAU,QAAQ,CAAC,MAA+C,EAAA;IACtE,OAAO;AACL,QAAA,IAAI,EAAE,IAAI;AACV,QAAA,EAAE,EAAE,SAAS;QACb,MAAM;KACP;AACH;;;;"}
+{"version":3,"file":"add-to-set.mjs","sources":["../../src/updates/add-to-set.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAIA;;;;AAIG;AACG,SAAU,QAAQ,CAAC,MAA+C,EAAA;IACtE,OAAO;AACL,QAAA,IAAI,EAAE,IAAI;AACV,QAAA,EAAE,EAAE,SAAS;QACb,MAAM;KACP;AACH;;;;"}

package/dist/updates/add.cjs

@@ -2,6 +2,11 @@
 
 var updates_updateSymbols = require('./update-symbols.cjs');
 
+/**
+ * Update function to add a number to an attribute.
+ *
+ * @param value - The number or reference to add.
+ */
 function add(value) {
     return {
         type: updates_updateSymbols.$set,