@webiny/db-dynamodb 0.0.0-unstable.9e825fd5fb → 0.0.0-unstable.9f53ea597d

package/DynamoDbDriver.d.ts

@@ -1,35 +1,21 @@
-/**
- * Remove this when no apps are using our internal db drivers anymore
- */
-import { DocumentClient } from "aws-sdk/clients/dynamodb";
-import BatchProcess from "./BatchProcess";
-import { DbDriver, Args, Result, ArgsBatch } from "@webiny/db";
-declare type ConstructorArgs = {
-    documentClient?: DocumentClient;
-};
-interface ReadLogsParams {
-    table: string;
+import type { DynamoDBDocument } from "@webiny/aws-sdk/client-dynamodb/index.js";
+import type { DbDriver, GetValueResult, GetValuesResult, IListValuesParams, ListValuesResult, RemoveValueResult, RemoveValuesResult, StorageKey, StoreValueResult, StoreValuesResult } from "@webiny/db";
+import type { GenericRecord } from "@webiny/api/types.js";
+interface ConstructorArgs {
+    documentClient: DynamoDBDocument;
 }
-interface CreateLogParams {
-    id: string;
-    operation: string;
-    /**
-     * TODO: determine the data type.
-     */
-    data: any;
-    table: string;
-}
-declare class DynamoDbDriver implements DbDriver {
-    batchProcesses: Record<string, BatchProcess>;
-    documentClient: DocumentClient;
-    constructor({ documentClient }?: ConstructorArgs);
-    getClient(): DocumentClient;
-    create({ table, data, meta, __batch: batch }: Args): Promise<Result>;
-    update({ query, data, table, meta, __batch: batch }: Args): Promise<Result>;
-    delete({ query, table, meta, __batch: batch }: Args): Promise<Result>;
-    read<T>({ table, query, sort, limit, keys, meta, __batch: batch }: Args): Promise<Result<T[]>>;
-    createLog({ id, operation, data, table }: CreateLogParams): Promise<Result>;
-    readLogs<T>({ table }: ReadLogsParams): Promise<Result<T[]>>;
-    getBatchProcess(__batch: ArgsBatch): BatchProcess;
+declare class DynamoDbDriver implements DbDriver<DynamoDBDocument> {
+    readonly documentClient: DynamoDBDocument;
+    readonly table: import("./utils").ITable<string, "PK", "SK">;
+    readonly entity: import("./store/types").IStoreEntity;
+    constructor({ documentClient }: ConstructorArgs);
+    getClient(): DynamoDBDocument;
+    storeValue<V>(key: string, input: V): Promise<StoreValueResult<V>>;
+    storeValues<V extends GenericRecord<StorageKey>>(values: V): Promise<StoreValuesResult<V>>;
+    getValue<V>(key: StorageKey): Promise<GetValueResult<V>>;
+    getValues<V extends GenericRecord<StorageKey>>(input: (keyof V)[]): Promise<GetValuesResult<V>>;
+    listValues<V extends GenericRecord<StorageKey>>(params?: IListValuesParams): Promise<ListValuesResult<V>>;
+    removeValue<V>(key: StorageKey): Promise<RemoveValueResult<V>>;
+    removeValues<V extends GenericRecord<StorageKey>>(input: (keyof V)[]): Promise<RemoveValuesResult<V>>;
 }
 export default DynamoDbDriver;

package/DynamoDbDriver.js

@@ -1,239 +1,228 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-var _dynamodb = require("aws-sdk/clients/dynamodb");
-var _BatchProcess = _interopRequireDefault(require("./BatchProcess"));
-var _QueryGenerator = _interopRequireDefault(require("./QueryGenerator"));
-/**
- * Remove this when no apps are using our internal db drivers anymore
- */
-// @ts-nocheck
-
-const LOG_KEYS = [{
-  primary: true,
-  unique: true,
-  name: "primary",
-  fields: [{
-    name: "PK"
-  }, {
-    name: "SK"
-  }]
-}];
+import { createTable } from "./utils/createTable.js";
+import { createEntity } from "./store/entity.js";
+import { createPartitionKey, createSortKey, createType } from "./store/keys.js";
 class DynamoDbDriver {
-  constructor({
-    documentClient
-  } = {}) {
-    (0, _defineProperty2.default)(this, "batchProcesses", void 0);
-    (0, _defineProperty2.default)(this, "documentClient", void 0);
-    this.batchProcesses = {};
-    this.documentClient = documentClient || new _dynamodb.DocumentClient();
-  }
-  getClient() {
-    return this.documentClient;
-  }
-  async create({
-    table,
-    data,
-    meta,
-    __batch: batch
-  }) {
-    if (!batch) {
-      const result = await this.documentClient.put({
-        TableName: table,
-        Item: data,
-        ReturnConsumedCapacity: meta ? "TOTAL" : "NONE"
-      }).promise();
-      return [true, {
-        response: result.$response
-      }];
-    }
-    const batchProcess = this.getBatchProcess(batch);
-    batchProcess.addBatchWrite({
-      table,
-      data
-    });
-    if (batchProcess.allOperationsAdded()) {
-      batchProcess.startExecution();
-    } else {
-      await batchProcess.waitStartExecution();
+    constructor({ documentClient }){
+        this.documentClient = documentClient;
+        this.table = createTable({
+            name: process.env.DB_TABLE,
+            documentClient
+        });
+        this.entity = createEntity({
+            table: this.table
+        });
     }
-    await batchProcess.waitExecution();
-    return [true, {
-      response: batchProcess.response
-    }];
-  }
-  async update({
-    query,
-    data,
-    table,
-    meta,
-    __batch: batch
-  }) {
-    if (!batch) {
-      const update = {
-        UpdateExpression: "SET ",
-        ExpressionAttributeNames: {},
-        ExpressionAttributeValues: {}
-      };
-      const updateExpression = [];
-      for (const key in data) {
-        updateExpression.push(`#${key} = :${key}`);
-        update.ExpressionAttributeNames[`#${key}`] = key;
-        update.ExpressionAttributeValues[`:${key}`] = data[key];
-      }
-      update.UpdateExpression += updateExpression.join(", ");
-      const result = await this.documentClient.update((0, _objectSpread2.default)({
-        TableName: table,
-        Key: query,
-        ReturnConsumedCapacity: meta ? "TOTAL" : "NONE"
-      }, update)).promise();
-      return [true, {
-        response: result.$response
-      }];
+    getClient() {
+        return this.documentClient;
     }
-    const batchProcess = this.getBatchProcess(batch);
-    batchProcess.addBatchWrite({
-      table,
-      data
-    });
-    if (batchProcess.allOperationsAdded()) {
-      batchProcess.startExecution();
-    } else {
-      await batchProcess.waitStartExecution();
+    async storeValue(key, input) {
+        let value;
+        try {
+            value = JSON.stringify(input);
+        } catch (ex) {
+            return {
+                key,
+                error: ex
+            };
+        }
+        try {
+            await this.entity.put({
+                PK: createPartitionKey(),
+                SK: createSortKey({
+                    key
+                }),
+                TYPE: createType(),
+                data: {
+                    key,
+                    value
+                }
+            });
+            return {
+                key,
+                data: input
+            };
+        } catch (ex) {
+            return {
+                key,
+                error: ex
+            };
+        }
     }
-    await batchProcess.waitExecution();
-    return [true, {
-      response: batchProcess.response
-    }];
-  }
-  async delete({
-    query,
-    table,
-    meta,
-    __batch: batch
-  }) {
-    if (!batch) {
-      const result = await this.documentClient.delete({
-        TableName: table,
-        Key: query,
-        ReturnConsumedCapacity: meta ? "TOTAL" : "NONE"
-      }).promise();
-      return [true, {
-        response: result.$response
-      }];
+    async storeValues(values) {
+        const keys = Object.keys(values);
+        const batchWrite = this.entity.createEntityWriter();
+        try {
+            for (const key of keys){
+                const input = values[key];
+                let value;
+                try {
+                    value = JSON.stringify(input);
+                } catch (ex) {
+                    throw ex;
+                }
+                batchWrite.put({
+                    PK: createPartitionKey(),
+                    SK: createSortKey({
+                        key
+                    }),
+                    TYPE: createType(),
+                    data: {
+                        key,
+                        value
+                    }
+                });
+            }
+            await batchWrite.execute();
+            return {
+                keys,
+                data: values
+            };
+        } catch (ex) {
+            return {
+                keys,
+                error: ex
+            };
+        }
     }
-    const batchProcess = this.getBatchProcess(batch);
-    batchProcess.addBatchDelete({
-      table,
-      query
-    });
-    if (batchProcess.allOperationsAdded()) {
-      batchProcess.startExecution();
-    } else {
-      await batchProcess.waitStartExecution();
+    async getValue(key) {
+        try {
+            const result = await this.entity.get({
+                PK: createPartitionKey(),
+                SK: createSortKey({
+                    key
+                })
+            });
+            return {
+                key,
+                data: result?.data?.value ? JSON.parse(result.data.value) : null
+            };
+        } catch (ex) {
+            return {
+                key,
+                error: ex
+            };
+        }
     }
-    await batchProcess.waitExecution();
-    return [true, {
-      response: batchProcess.response
-    }];
-  }
-  async read({
-    table,
-    query,
-    sort,
-    limit,
-    keys,
-    meta,
-    __batch: batch
-  }) {
-    if (!batch) {
-      const queryGenerator = new _QueryGenerator.default();
-      const queryParams = queryGenerator.generate({
-        query,
-        keys,
-        sort,
-        limit,
-        tableName: table
-      });
-      const response = await this.documentClient.query((0, _objectSpread2.default)((0, _objectSpread2.default)({}, queryParams), {}, {
-        ReturnConsumedCapacity: meta ? "TOTAL" : "NONE"
-      })).promise();
-      if (Array.isArray(response.Items)) {
-        return [response.Items, {
-          response: response.$response
-        }];
-      }
-      return [[], {
-        response: response.$response
-      }];
+    async getValues(input) {
+        const keys = [
+            ...input
+        ];
+        const batchRead = this.entity.createEntityReader({
+            read: keys.map((key)=>({
+                    PK: createPartitionKey(),
+                    SK: createSortKey({
+                        key
+                    })
+                }))
+        });
+        try {
+            const results = await batchRead.execute();
+            const data = keys.reduce((collection, initialKey)=>{
+                const key = initialKey;
+                const result = results.find((item)=>item.PK === createPartitionKey() && item.SK === createSortKey({
+                        key
+                    }));
+                if (!result?.data?.value) {
+                    collection[key] = null;
+                    return collection;
+                }
+                try {
+                    collection[key] = JSON.parse(result.data.value);
+                } catch  {
+                    collection[key] = null;
+                }
+                return collection;
+            }, {});
+            return {
+                keys,
+                data
+            };
+        } catch (ex) {
+            return {
+                keys,
+                error: ex
+            };
+        }
     }
-
-    // DynamoDb doesn't support batch queries, so we can immediately assume the GetRequest operation.
-    const batchProcess = this.getBatchProcess(batch);
-    const getResult = batchProcess.addBatchGet({
-      table,
-      query
-    });
-    if (batchProcess.allOperationsAdded()) {
-      batchProcess.startExecution();
-    } else {
-      await batchProcess.waitStartExecution();
+    async listValues(params) {
+        try {
+            const partitionKey = createPartitionKey();
+            const options = {
+                ...params
+            };
+            const results = await this.entity.queryAll({
+                partitionKey,
+                options
+            });
+            const data = results.reduce((collection, item)=>{
+                const key = item.data.key;
+                try {
+                    collection[key] = JSON.parse(item.data.value);
+                } catch  {
+                    collection[key] = null;
+                }
+                return collection;
+            }, {});
+            return {
+                keys: Object.keys(data),
+                data
+            };
+        } catch (ex) {
+            return {
+                error: ex
+            };
+        }
     }
-    await batchProcess.waitExecution();
-    const result = getResult();
-    if (result) {
-      return [[result], {
-        response: batchProcess.response
-      }];
+    async removeValue(key) {
+        const result = await this.getValue(key);
+        if (result.error) return {
+            key,
+            error: result.error
+        };
+        try {
+            await this.entity.delete({
+                PK: createPartitionKey(),
+                SK: createSortKey({
+                    key
+                })
+            });
+            return {
+                key,
+                data: result.data
+            };
+        } catch (ex) {
+            return {
+                key,
+                error: ex
+            };
+        }
     }
-    return [[], {
-      response: batchProcess.response
-    }];
-  }
-  async createLog({
-    id,
-    operation,
-    data,
-    table
-  }) {
-    await this.create({
-      table: table,
-      keys: LOG_KEYS,
-      data: (0, _objectSpread2.default)({
-        PK: "log",
-        SK: id,
-        id,
-        operation
-      }, data)
-    });
-    return [true, {}];
-  }
-  async readLogs({
-    table
-  }) {
-    return this.read({
-      table,
-      keys: LOG_KEYS,
-      query: {
-        PK: "log",
-        SK: {
-          $gte: " "
+    async removeValues(input) {
+        const keys = [
+            ...input
+        ];
+        const batchDelete = this.entity.createEntityWriter({
+            delete: keys.map((key)=>({
+                    PK: createPartitionKey(),
+                    SK: createSortKey({
+                        key
+                    })
+                }))
+        });
+        try {
+            await batchDelete.execute();
+            return {
+                keys
+            };
+        } catch (ex) {
+            return {
+                keys,
+                error: ex
+            };
         }
-      }
-    });
-  }
-  getBatchProcess(__batch) {
-    if (!this.batchProcesses[__batch.instance.id]) {
-      this.batchProcesses[__batch.instance.id] = new _BatchProcess.default(__batch.instance, this.documentClient);
     }
-    return this.batchProcesses[__batch.instance.id];
-  }
 }
-var _default = DynamoDbDriver;
-exports.default = _default;
+const src_DynamoDbDriver = DynamoDbDriver;
+export default src_DynamoDbDriver;
+
+//# sourceMappingURL=DynamoDbDriver.js.map

package/DynamoDbDriver.js.map

@@ -1 +1 @@
-{"version":3,"names":["LOG_KEYS","primary","unique","name","fields","DynamoDbDriver","constructor","documentClient","batchProcesses","DocumentClient","getClient","create","table","data","meta","__batch","batch","result","put","TableName","Item","ReturnConsumedCapacity","promise","response","$response","batchProcess","getBatchProcess","addBatchWrite","allOperationsAdded","startExecution","waitStartExecution","waitExecution","update","query","UpdateExpression","ExpressionAttributeNames","ExpressionAttributeValues","updateExpression","key","push","join","Key","delete","addBatchDelete","read","sort","limit","keys","queryGenerator","QueryGenerator","queryParams","generate","tableName","Array","isArray","Items","getResult","addBatchGet","createLog","id","operation","PK","SK","readLogs","$gte","instance","BatchProcess"],"sources":["DynamoDbDriver.ts"],"sourcesContent":["/**\n * Remove this when no apps are using our internal db drivers anymore\n */\n// @ts-nocheck\nimport { DocumentClient } from \"aws-sdk/clients/dynamodb\";\nimport BatchProcess from \"./BatchProcess\";\nimport QueryGenerator from \"./QueryGenerator\";\nimport { DbDriver, Args, Result, ArgsBatch } from \"@webiny/db\";\nimport { QueryKeys } from \"~/types\";\n\ntype ConstructorArgs = {\n    documentClient?: DocumentClient;\n};\n\nconst LOG_KEYS: QueryKeys = [\n    {\n        primary: true,\n        unique: true,\n        name: \"primary\",\n        fields: [{ name: \"PK\" }, { name: \"SK\" }]\n    }\n];\n\ninterface Update {\n    UpdateExpression: string;\n    ExpressionAttributeNames: Record<string, any>;\n    ExpressionAttributeValues: Record<string, any>;\n}\n\ninterface ReadLogsParams {\n    table: string;\n}\n\ninterface CreateLogParams {\n    id: string;\n    operation: string;\n    /**\n     * TODO: determine the data type.\n     */\n    data: any;\n    table: string;\n}\n\nclass DynamoDbDriver implements DbDriver {\n    batchProcesses: Record<string, BatchProcess>;\n    documentClient: DocumentClient;\n    constructor({ documentClient }: ConstructorArgs = {}) {\n        this.batchProcesses = {};\n        this.documentClient = documentClient || new DocumentClient();\n    }\n\n    getClient() {\n        return this.documentClient;\n    }\n\n    async create({ table, data, meta, __batch: batch }: Args): Promise<Result> {\n        if (!batch) {\n            const result = await this.documentClient\n                .put({\n                    TableName: table,\n                    Item: data,\n                    ReturnConsumedCapacity: meta ? \"TOTAL\" : \"NONE\"\n                })\n                .promise();\n            return [true, { response: result.$response }];\n        }\n\n        const batchProcess = this.getBatchProcess(batch);\n        batchProcess.addBatchWrite({ table, data });\n\n        if (batchProcess.allOperationsAdded()) {\n            batchProcess.startExecution();\n        } else {\n            await batchProcess.waitStartExecution();\n        }\n\n        await batchProcess.waitExecution();\n\n        return [true, { response: batchProcess.response }];\n    }\n\n    async update({ query, data, table, meta, __batch: batch }: Args): Promise<Result> {\n        if (!batch) {\n            const update: Update = {\n                UpdateExpression: \"SET \",\n                ExpressionAttributeNames: {},\n                ExpressionAttributeValues: {}\n            };\n\n            const updateExpression = [];\n            for (const key in data) {\n                updateExpression.push(`#${key} = :${key}`);\n                update.ExpressionAttributeNames[`#${key}`] = key;\n                update.ExpressionAttributeValues[`:${key}`] = data[key];\n            }\n\n            update.UpdateExpression += updateExpression.join(\", \");\n\n            const result = await this.documentClient\n                .update({\n                    TableName: table,\n                    Key: query,\n                    ReturnConsumedCapacity: meta ? \"TOTAL\" : \"NONE\",\n                    ...update\n                })\n                .promise();\n\n            return [true, { response: result.$response }];\n        }\n\n        const batchProcess = this.getBatchProcess(batch);\n\n        batchProcess.addBatchWrite({\n            table,\n            data\n        });\n\n        if (batchProcess.allOperationsAdded()) {\n            batchProcess.startExecution();\n        } else {\n            await batchProcess.waitStartExecution();\n        }\n\n        await batchProcess.waitExecution();\n\n        return [true, { response: batchProcess.response }];\n    }\n\n    async delete({ query, table, meta, __batch: batch }: Args): Promise<Result> {\n        if (!batch) {\n            const result = await this.documentClient\n                .delete({\n                    TableName: table,\n                    Key: query,\n                    ReturnConsumedCapacity: meta ? \"TOTAL\" : \"NONE\"\n                })\n                .promise();\n\n            return [true, { response: result.$response }];\n        }\n\n        const batchProcess = this.getBatchProcess(batch);\n        batchProcess.addBatchDelete({\n            table,\n            query\n        });\n\n        if (batchProcess.allOperationsAdded()) {\n            batchProcess.startExecution();\n        } else {\n            await batchProcess.waitStartExecution();\n        }\n\n        await batchProcess.waitExecution();\n\n        return [true, { response: batchProcess.response }];\n    }\n\n    async read<T>({\n        table,\n        query,\n        sort,\n        limit,\n        keys,\n        meta,\n        __batch: batch\n    }: Args): Promise<Result<T[]>> {\n        if (!batch) {\n            const queryGenerator = new QueryGenerator();\n            const queryParams = queryGenerator.generate({\n                query,\n                keys,\n                sort,\n                limit,\n                tableName: table\n            });\n\n            const response = await this.documentClient\n                .query({ ...queryParams, ReturnConsumedCapacity: meta ? \"TOTAL\" : \"NONE\" })\n                .promise();\n\n            if (Array.isArray(response.Items)) {\n                return [response.Items as T[], { response: response.$response }];\n            }\n            return [[], { response: response.$response }];\n        }\n\n        // DynamoDb doesn't support batch queries, so we can immediately assume the GetRequest operation.\n        const batchProcess = this.getBatchProcess(batch);\n        const getResult = batchProcess.addBatchGet({\n            table,\n            query\n        });\n\n        if (batchProcess.allOperationsAdded()) {\n            batchProcess.startExecution();\n        } else {\n            await batchProcess.waitStartExecution();\n        }\n\n        await batchProcess.waitExecution();\n\n        const result = getResult() as T;\n        if (result) {\n            return [[result], { response: batchProcess.response }];\n        }\n\n        return [[], { response: batchProcess.response }];\n    }\n\n    async createLog({ id, operation, data, table }: CreateLogParams): Promise<Result> {\n        await this.create({\n            table: table,\n            keys: LOG_KEYS,\n            data: {\n                PK: \"log\",\n                SK: id,\n                id,\n                operation,\n                ...data\n            }\n        });\n\n        return [true, {}];\n    }\n\n    async readLogs<T>({ table }: ReadLogsParams) {\n        return this.read<T>({\n            table,\n            keys: LOG_KEYS,\n            query: {\n                PK: \"log\",\n                SK: { $gte: \" \" }\n            }\n        });\n    }\n\n    getBatchProcess(__batch: ArgsBatch): BatchProcess {\n        if (!this.batchProcesses[__batch.instance.id]) {\n            this.batchProcesses[__batch.instance.id] = new BatchProcess(\n                __batch.instance,\n                this.documentClient\n            );\n        }\n\n        return this.batchProcesses[__batch.instance.id];\n    }\n}\n\nexport default DynamoDbDriver;\n"],"mappings":";;;;;;;;;AAIA;AACA;AACA;AANA;AACA;AACA;AACA;;AAWA,MAAMA,QAAmB,GAAG,CACxB;EACIC,OAAO,EAAE,IAAI;EACbC,MAAM,EAAE,IAAI;EACZC,IAAI,EAAE,SAAS;EACfC,MAAM,EAAE,CAAC;IAAED,IAAI,EAAE;EAAK,CAAC,EAAE;IAAEA,IAAI,EAAE;EAAK,CAAC;AAC3C,CAAC,CACJ;AAsBD,MAAME,cAAc,CAAqB;EAGrCC,WAAW,CAAC;IAAEC;EAAgC,CAAC,GAAG,CAAC,CAAC,EAAE;IAAA;IAAA;IAClD,IAAI,CAACC,cAAc,GAAG,CAAC,CAAC;IACxB,IAAI,CAACD,cAAc,GAAGA,cAAc,IAAI,IAAIE,wBAAc,EAAE;EAChE;EAEAC,SAAS,GAAG;IACR,OAAO,IAAI,CAACH,cAAc;EAC9B;EAEA,MAAMI,MAAM,CAAC;IAAEC,KAAK;IAAEC,IAAI;IAAEC,IAAI;IAAEC,OAAO,EAAEC;EAAY,CAAC,EAAmB;IACvE,IAAI,CAACA,KAAK,EAAE;MACR,MAAMC,MAAM,GAAG,MAAM,IAAI,CAACV,cAAc,CACnCW,GAAG,CAAC;QACDC,SAAS,EAAEP,KAAK;QAChBQ,IAAI,EAAEP,IAAI;QACVQ,sBAAsB,EAAEP,IAAI,GAAG,OAAO,GAAG;MAC7C,CAAC,CAAC,CACDQ,OAAO,EAAE;MACd,OAAO,CAAC,IAAI,EAAE;QAAEC,QAAQ,EAAEN,MAAM,CAACO;MAAU,CAAC,CAAC;IACjD;IAEA,MAAMC,YAAY,GAAG,IAAI,CAACC,eAAe,CAACV,KAAK,CAAC;IAChDS,YAAY,CAACE,aAAa,CAAC;MAAEf,KAAK;MAAEC;IAAK,CAAC,CAAC;IAE3C,IAAIY,YAAY,CAACG,kBAAkB,EAAE,EAAE;MACnCH,YAAY,CAACI,cAAc,EAAE;IACjC,CAAC,MAAM;MACH,MAAMJ,YAAY,CAACK,kBAAkB,EAAE;IAC3C;IAEA,MAAML,YAAY,CAACM,aAAa,EAAE;IAElC,OAAO,CAAC,IAAI,EAAE;MAAER,QAAQ,EAAEE,YAAY,CAACF;IAAS,CAAC,CAAC;EACtD;EAEA,MAAMS,MAAM,CAAC;IAAEC,KAAK;IAAEpB,IAAI;IAAED,KAAK;IAAEE,IAAI;IAAEC,OAAO,EAAEC;EAAY,CAAC,EAAmB;IAC9E,IAAI,CAACA,KAAK,EAAE;MACR,MAAMgB,MAAc,GAAG;QACnBE,gBAAgB,EAAE,MAAM;QACxBC,wBAAwB,EAAE,CAAC,CAAC;QAC5BC,yBAAyB,EAAE,CAAC;MAChC,CAAC;MAED,MAAMC,gBAAgB,GAAG,EAAE;MAC3B,KAAK,MAAMC,GAAG,IAAIzB,IAAI,EAAE;QACpBwB,gBAAgB,CAACE,IAAI,CAAE,IAAGD,GAAI,OAAMA,GAAI,EAAC,CAAC;QAC1CN,MAAM,CAACG,wBAAwB,CAAE,IAAGG,GAAI,EAAC,CAAC,GAAGA,GAAG;QAChDN,MAAM,CAACI,yBAAyB,CAAE,IAAGE,GAAI,EAAC,CAAC,GAAGzB,IAAI,CAACyB,GAAG,CAAC;MAC3D;MAEAN,MAAM,CAACE,gBAAgB,IAAIG,gBAAgB,CAACG,IAAI,CAAC,IAAI,CAAC;MAEtD,MAAMvB,MAAM,GAAG,MAAM,IAAI,CAACV,cAAc,CACnCyB,MAAM;QACHb,SAAS,EAAEP,KAAK;QAChB6B,GAAG,EAAER,KAAK;QACVZ,sBAAsB,EAAEP,IAAI,GAAG,OAAO,GAAG;MAAM,GAC5CkB,MAAM,EACX,CACDV,OAAO,EAAE;MAEd,OAAO,CAAC,IAAI,EAAE;QAAEC,QAAQ,EAAEN,MAAM,CAACO;MAAU,CAAC,CAAC;IACjD;IAEA,MAAMC,YAAY,GAAG,IAAI,CAACC,eAAe,CAACV,KAAK,CAAC;IAEhDS,YAAY,CAACE,aAAa,CAAC;MACvBf,KAAK;MACLC;IACJ,CAAC,CAAC;IAEF,IAAIY,YAAY,CAACG,kBAAkB,EAAE,EAAE;MACnCH,YAAY,CAACI,cAAc,EAAE;IACjC,CAAC,MAAM;MACH,MAAMJ,YAAY,CAACK,kBAAkB,EAAE;IAC3C;IAEA,MAAML,YAAY,CAACM,aAAa,EAAE;IAElC,OAAO,CAAC,IAAI,EAAE;MAAER,QAAQ,EAAEE,YAAY,CAACF;IAAS,CAAC,CAAC;EACtD;EAEA,MAAMmB,MAAM,CAAC;IAAET,KAAK;IAAErB,KAAK;IAAEE,IAAI;IAAEC,OAAO,EAAEC;EAAY,CAAC,EAAmB;IACxE,IAAI,CAACA,KAAK,EAAE;MACR,MAAMC,MAAM,GAAG,MAAM,IAAI,CAACV,cAAc,CACnCmC,MAAM,CAAC;QACJvB,SAAS,EAAEP,KAAK;QAChB6B,GAAG,EAAER,KAAK;QACVZ,sBAAsB,EAAEP,IAAI,GAAG,OAAO,GAAG;MAC7C,CAAC,CAAC,CACDQ,OAAO,EAAE;MAEd,OAAO,CAAC,IAAI,EAAE;QAAEC,QAAQ,EAAEN,MAAM,CAACO;MAAU,CAAC,CAAC;IACjD;IAEA,MAAMC,YAAY,GAAG,IAAI,CAACC,eAAe,CAACV,KAAK,CAAC;IAChDS,YAAY,CAACkB,cAAc,CAAC;MACxB/B,KAAK;MACLqB;IACJ,CAAC,CAAC;IAEF,IAAIR,YAAY,CAACG,kBAAkB,EAAE,EAAE;MACnCH,YAAY,CAACI,cAAc,EAAE;IACjC,CAAC,MAAM;MACH,MAAMJ,YAAY,CAACK,kBAAkB,EAAE;IAC3C;IAEA,MAAML,YAAY,CAACM,aAAa,EAAE;IAElC,OAAO,CAAC,IAAI,EAAE;MAAER,QAAQ,EAAEE,YAAY,CAACF;IAAS,CAAC,CAAC;EACtD;EAEA,MAAMqB,IAAI,CAAI;IACVhC,KAAK;IACLqB,KAAK;IACLY,IAAI;IACJC,KAAK;IACLC,IAAI;IACJjC,IAAI;IACJC,OAAO,EAAEC;EACP,CAAC,EAAwB;IAC3B,IAAI,CAACA,KAAK,EAAE;MACR,MAAMgC,cAAc,GAAG,IAAIC,uBAAc,EAAE;MAC3C,MAAMC,WAAW,GAAGF,cAAc,CAACG,QAAQ,CAAC;QACxClB,KAAK;QACLc,IAAI;QACJF,IAAI;QACJC,KAAK;QACLM,SAAS,EAAExC;MACf,CAAC,CAAC;MAEF,MAAMW,QAAQ,GAAG,MAAM,IAAI,CAAChB,cAAc,CACrC0B,KAAK,6DAAMiB,WAAW;QAAE7B,sBAAsB,EAAEP,IAAI,GAAG,OAAO,GAAG;MAAM,GAAG,CAC1EQ,OAAO,EAAE;MAEd,IAAI+B,KAAK,CAACC,OAAO,CAAC/B,QAAQ,CAACgC,KAAK,CAAC,EAAE;QAC/B,OAAO,CAAChC,QAAQ,CAACgC,KAAK,EAAS;UAAEhC,QAAQ,EAAEA,QAAQ,CAACC;QAAU,CAAC,CAAC;MACpE;MACA,OAAO,CAAC,EAAE,EAAE;QAAED,QAAQ,EAAEA,QAAQ,CAACC;MAAU,CAAC,CAAC;IACjD;;IAEA;IACA,MAAMC,YAAY,GAAG,IAAI,CAACC,eAAe,CAACV,KAAK,CAAC;IAChD,MAAMwC,SAAS,GAAG/B,YAAY,CAACgC,WAAW,CAAC;MACvC7C,KAAK;MACLqB;IACJ,CAAC,CAAC;IAEF,IAAIR,YAAY,CAACG,kBAAkB,EAAE,EAAE;MACnCH,YAAY,CAACI,cAAc,EAAE;IACjC,CAAC,MAAM;MACH,MAAMJ,YAAY,CAACK,kBAAkB,EAAE;IAC3C;IAEA,MAAML,YAAY,CAACM,aAAa,EAAE;IAElC,MAAMd,MAAM,GAAGuC,SAAS,EAAO;IAC/B,IAAIvC,MAAM,EAAE;MACR,OAAO,CAAC,CAACA,MAAM,CAAC,EAAE;QAAEM,QAAQ,EAAEE,YAAY,CAACF;MAAS,CAAC,CAAC;IAC1D;IAEA,OAAO,CAAC,EAAE,EAAE;MAAEA,QAAQ,EAAEE,YAAY,CAACF;IAAS,CAAC,CAAC;EACpD;EAEA,MAAMmC,SAAS,CAAC;IAAEC,EAAE;IAAEC,SAAS;IAAE/C,IAAI;IAAED;EAAuB,CAAC,EAAmB;IAC9E,MAAM,IAAI,CAACD,MAAM,CAAC;MACdC,KAAK,EAAEA,KAAK;MACZmC,IAAI,EAAE/C,QAAQ;MACda,IAAI;QACAgD,EAAE,EAAE,KAAK;QACTC,EAAE,EAAEH,EAAE;QACNA,EAAE;QACFC;MAAS,GACN/C,IAAI;IAEf,CAAC,CAAC;IAEF,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;EACrB;EAEA,MAAMkD,QAAQ,CAAI;IAAEnD;EAAsB,CAAC,EAAE;IACzC,OAAO,IAAI,CAACgC,IAAI,CAAI;MAChBhC,KAAK;MACLmC,IAAI,EAAE/C,QAAQ;MACdiC,KAAK,EAAE;QACH4B,EAAE,EAAE,KAAK;QACTC,EAAE,EAAE;UAAEE,IAAI,EAAE;QAAI;MACpB;IACJ,CAAC,CAAC;EACN;EAEAtC,eAAe,CAACX,OAAkB,EAAgB;IAC9C,IAAI,CAAC,IAAI,CAACP,cAAc,CAACO,OAAO,CAACkD,QAAQ,CAACN,EAAE,CAAC,EAAE;MAC3C,IAAI,CAACnD,cAAc,CAACO,OAAO,CAACkD,QAAQ,CAACN,EAAE,CAAC,GAAG,IAAIO,qBAAY,CACvDnD,OAAO,CAACkD,QAAQ,EAChB,IAAI,CAAC1D,cAAc,CACtB;IACL;IAEA,OAAO,IAAI,CAACC,cAAc,CAACO,OAAO,CAACkD,QAAQ,CAACN,EAAE,CAAC;EACnD;AACJ;AAAC,eAEctD,cAAc;AAAA"}
+{"version":3,"file":"DynamoDbDriver.js","sources":["../src/DynamoDbDriver.ts"],"sourcesContent":["import type { DynamoDBDocument } from \"@webiny/aws-sdk/client-dynamodb/index.js\";\nimport type {\n    DbDriver,\n    GetValueResult,\n    GetValuesResult,\n    IListValuesParams,\n    ListValuesResult,\n    RemoveValueResult,\n    RemoveValuesResult,\n    StorageKey,\n    StoreValueResult,\n    StoreValuesResult\n} from \"@webiny/db\";\nimport { createTable } from \"~/utils/createTable.js\";\nimport type { GenericRecord } from \"@webiny/api/types.js\";\nimport { createEntity } from \"~/store/entity.js\";\nimport { createPartitionKey, createSortKey, createType } from \"~/store/keys.js\";\n\ninterface ConstructorArgs {\n    documentClient: DynamoDBDocument;\n}\n\nclass DynamoDbDriver implements DbDriver<DynamoDBDocument> {\n    public readonly documentClient;\n\n    public readonly table;\n    public readonly entity;\n\n    constructor({ documentClient }: ConstructorArgs) {\n        this.documentClient = documentClient;\n        this.table = createTable({\n            name: process.env.DB_TABLE as string,\n            documentClient\n        });\n        this.entity = createEntity({\n            table: this.table\n        });\n    }\n\n    public getClient() {\n        return this.documentClient;\n    }\n\n    public async storeValue<V>(key: string, input: V): Promise<StoreValueResult<V>> {\n        let value: string | undefined;\n        try {\n            value = JSON.stringify(input);\n        } catch (ex) {\n            return {\n                key,\n                error: ex\n            };\n        }\n\n        try {\n            await this.entity.put({\n                PK: createPartitionKey(),\n                SK: createSortKey({ key }),\n                TYPE: createType(),\n                data: {\n                    key,\n                    value\n                }\n            });\n\n            return {\n                key,\n                data: input\n            };\n        } catch (ex) {\n            return {\n                key,\n                error: ex\n            };\n        }\n    }\n    public async storeValues<V extends GenericRecord<StorageKey>>(\n        values: V\n    ): Promise<StoreValuesResult<V>> {\n        const keys = Object.keys(values);\n\n        const batchWrite = this.entity.createEntityWriter();\n        try {\n            for (const key of keys) {\n                const input = values[key];\n                let value: string | undefined;\n                try {\n                    value = JSON.stringify(input);\n                } catch (ex) {\n                    throw ex;\n                }\n                batchWrite.put({\n                    PK: createPartitionKey(),\n                    SK: createSortKey({ key }),\n                    TYPE: createType(),\n                    data: {\n                        key,\n                        value\n                    }\n                });\n            }\n\n            await batchWrite.execute();\n            return {\n                keys,\n                data: values\n            };\n        } catch (ex) {\n            return {\n                keys,\n                error: ex\n            };\n        }\n    }\n    public async getValue<V>(key: StorageKey): Promise<GetValueResult<V>> {\n        try {\n            const result = await this.entity.get({\n                PK: createPartitionKey(),\n                SK: createSortKey({ key })\n            });\n            return {\n                key,\n                data: result?.data?.value ? JSON.parse(result.data.value) : null\n            };\n        } catch (ex) {\n            return {\n                key,\n                error: ex\n            };\n        }\n    }\n    public async getValues<V extends GenericRecord<StorageKey>>(\n        input: (keyof V)[]\n    ): Promise<GetValuesResult<V>> {\n        const keys = [...input] as string[];\n\n        const batchRead = this.entity.createEntityReader({\n            read: keys.map(key => {\n                return {\n                    PK: createPartitionKey(),\n                    SK: createSortKey({ key })\n                };\n            })\n        });\n\n        try {\n            const results = await batchRead.execute();\n            const data = keys.reduce((collection, initialKey) => {\n                const key = initialKey as keyof V;\n                const result = results.find(item => {\n                    return item.PK === createPartitionKey() && item.SK === createSortKey({ key });\n                });\n                if (!result?.data?.value) {\n                    collection[key] = null;\n                    return collection;\n                }\n                try {\n                    collection[key] = JSON.parse(result.data.value);\n                } catch {\n                    collection[key] = null;\n                }\n\n                return collection;\n            }, {} as GenericRecord);\n            return {\n                keys,\n                data\n            };\n        } catch (ex) {\n            return {\n                keys,\n                error: ex\n            };\n        }\n    }\n    public async listValues<V extends GenericRecord<StorageKey>>(\n        params?: IListValuesParams\n    ): Promise<ListValuesResult<V>> {\n        try {\n            const partitionKey = createPartitionKey();\n            const options = {\n                ...params\n            };\n            const results = await this.entity.queryAll({\n                partitionKey,\n                options\n            });\n\n            const data = results.reduce((collection, item) => {\n                const key = item.data.key as keyof V;\n                try {\n                    collection[key] = JSON.parse(item.data.value);\n                } catch {\n                    collection[key] = null;\n                }\n\n                return collection;\n            }, {} as GenericRecord);\n\n            return {\n                keys: Object.keys(data),\n                data\n            };\n        } catch (ex) {\n            return {\n                error: ex\n            };\n        }\n    }\n\n    public async removeValue<V>(key: StorageKey): Promise<RemoveValueResult<V>> {\n        const result = await this.getValue<V>(key);\n        if (result.error) {\n            return {\n                key,\n                error: result.error\n            };\n        }\n        try {\n            await this.entity.delete({\n                PK: createPartitionKey(),\n                SK: createSortKey({ key })\n            });\n            return {\n                key,\n                data: result.data\n            };\n        } catch (ex) {\n            return {\n                key,\n                error: ex\n            };\n        }\n    }\n\n    public async removeValues<V extends GenericRecord<StorageKey>>(\n        input: (keyof V)[]\n    ): Promise<RemoveValuesResult<V>> {\n        const keys = [...input] as string[];\n\n        const batchDelete = this.entity.createEntityWriter({\n            delete: keys.map(key => {\n                return {\n                    PK: createPartitionKey(),\n                    SK: createSortKey({ key })\n                };\n            })\n        });\n\n        try {\n            await batchDelete.execute();\n            return {\n                keys\n            };\n        } catch (ex) {\n            return {\n                keys,\n                error: ex\n            };\n        }\n    }\n}\n\nexport default DynamoDbDriver;\n"],"names":["DynamoDbDriver","documentClient","createTable","process","createEntity","key","input","value","JSON","ex","createPartitionKey","createSortKey","createType","values","keys","Object","batchWrite","result","batchRead","results","data","collection","initialKey","item","params","partitionKey","options","batchDelete"],"mappings":";;;AAsBA,MAAMA;IAMF,YAAY,EAAEC,cAAc,EAAmB,CAAE;QAC7C,IAAI,CAAC,cAAc,GAAGA;QACtB,IAAI,CAAC,KAAK,GAAGC,YAAY;YACrB,MAAMC,QAAQ,GAAG,CAAC,QAAQ;YAC1BF;QACJ;QACA,IAAI,CAAC,MAAM,GAAGG,aAAa;YACvB,OAAO,IAAI,CAAC,KAAK;QACrB;IACJ;IAEO,YAAY;QACf,OAAO,IAAI,CAAC,cAAc;IAC9B;IAEA,MAAa,WAAcC,GAAW,EAAEC,KAAQ,EAAgC;QAC5E,IAAIC;QACJ,IAAI;YACAA,QAAQC,KAAK,SAAS,CAACF;QAC3B,EAAE,OAAOG,IAAI;YACT,OAAO;gBACHJ;gBACA,OAAOI;YACX;QACJ;QAEA,IAAI;YACA,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC;gBAClB,IAAIC;gBACJ,IAAIC,cAAc;oBAAEN;gBAAI;gBACxB,MAAMO;gBACN,MAAM;oBACFP;oBACAE;gBACJ;YACJ;YAEA,OAAO;gBACHF;gBACA,MAAMC;YACV;QACJ,EAAE,OAAOG,IAAI;YACT,OAAO;gBACHJ;gBACA,OAAOI;YACX;QACJ;IACJ;IACA,MAAa,YACTI,MAAS,EACoB;QAC7B,MAAMC,OAAOC,OAAO,IAAI,CAACF;QAEzB,MAAMG,aAAa,IAAI,CAAC,MAAM,CAAC,kBAAkB;QACjD,IAAI;YACA,KAAK,MAAMX,OAAOS,KAAM;gBACpB,MAAMR,QAAQO,MAAM,CAACR,IAAI;gBACzB,IAAIE;gBACJ,IAAI;oBACAA,QAAQC,KAAK,SAAS,CAACF;gBAC3B,EAAE,OAAOG,IAAI;oBACT,MAAMA;gBACV;gBACAO,WAAW,GAAG,CAAC;oBACX,IAAIN;oBACJ,IAAIC,cAAc;wBAAEN;oBAAI;oBACxB,MAAMO;oBACN,MAAM;wBACFP;wBACAE;oBACJ;gBACJ;YACJ;YAEA,MAAMS,WAAW,OAAO;YACxB,OAAO;gBACHF;gBACA,MAAMD;YACV;QACJ,EAAE,OAAOJ,IAAI;YACT,OAAO;gBACHK;gBACA,OAAOL;YACX;QACJ;IACJ;IACA,MAAa,SAAYJ,GAAe,EAA8B;QAClE,IAAI;YACA,MAAMY,SAAS,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC;gBACjC,IAAIP;gBACJ,IAAIC,cAAc;oBAAEN;gBAAI;YAC5B;YACA,OAAO;gBACHA;gBACA,MAAMY,QAAQ,MAAM,QAAQT,KAAK,KAAK,CAACS,OAAO,IAAI,CAAC,KAAK,IAAI;YAChE;QACJ,EAAE,OAAOR,IAAI;YACT,OAAO;gBACHJ;gBACA,OAAOI;YACX;QACJ;IACJ;IACA,MAAa,UACTH,KAAkB,EACS;QAC3B,MAAMQ,OAAO;eAAIR;SAAM;QAEvB,MAAMY,YAAY,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;YAC7C,MAAMJ,KAAK,GAAG,CAACT,CAAAA,MACJ;oBACH,IAAIK;oBACJ,IAAIC,cAAc;wBAAEN;oBAAI;gBAC5B;QAER;QAEA,IAAI;YACA,MAAMc,UAAU,MAAMD,UAAU,OAAO;YACvC,MAAME,OAAON,KAAK,MAAM,CAAC,CAACO,YAAYC;gBAClC,MAAMjB,MAAMiB;gBACZ,MAAML,SAASE,QAAQ,IAAI,CAACI,CAAAA,OACjBA,KAAK,EAAE,KAAKb,wBAAwBa,KAAK,EAAE,KAAKZ,cAAc;wBAAEN;oBAAI;gBAE/E,IAAI,CAACY,QAAQ,MAAM,OAAO;oBACtBI,UAAU,CAAChB,IAAI,GAAG;oBAClB,OAAOgB;gBACX;gBACA,IAAI;oBACAA,UAAU,CAAChB,IAAI,GAAGG,KAAK,KAAK,CAACS,OAAO,IAAI,CAAC,KAAK;gBAClD,EAAE,OAAM;oBACJI,UAAU,CAAChB,IAAI,GAAG;gBACtB;gBAEA,OAAOgB;YACX,GAAG,CAAC;YACJ,OAAO;gBACHP;gBACAM;YACJ;QACJ,EAAE,OAAOX,IAAI;YACT,OAAO;gBACHK;gBACA,OAAOL;YACX;QACJ;IACJ;IACA,MAAa,WACTe,MAA0B,EACE;QAC5B,IAAI;YACA,MAAMC,eAAef;YACrB,MAAMgB,UAAU;gBACZ,GAAGF,MAAM;YACb;YACA,MAAML,UAAU,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;gBACvCM;gBACAC;YACJ;YAEA,MAAMN,OAAOD,QAAQ,MAAM,CAAC,CAACE,YAAYE;gBACrC,MAAMlB,MAAMkB,KAAK,IAAI,CAAC,GAAG;gBACzB,IAAI;oBACAF,UAAU,CAAChB,IAAI,GAAGG,KAAK,KAAK,CAACe,KAAK,IAAI,CAAC,KAAK;gBAChD,EAAE,OAAM;oBACJF,UAAU,CAAChB,IAAI,GAAG;gBACtB;gBAEA,OAAOgB;YACX,GAAG,CAAC;YAEJ,OAAO;gBACH,MAAMN,OAAO,IAAI,CAACK;gBAClBA;YACJ;QACJ,EAAE,OAAOX,IAAI;YACT,OAAO;gBACH,OAAOA;YACX;QACJ;IACJ;IAEA,MAAa,YAAeJ,GAAe,EAAiC;QACxE,MAAMY,SAAS,MAAM,IAAI,CAAC,QAAQ,CAAIZ;QACtC,IAAIY,OAAO,KAAK,EACZ,OAAO;YACHZ;YACA,OAAOY,OAAO,KAAK;QACvB;QAEJ,IAAI;YACA,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;gBACrB,IAAIP;gBACJ,IAAIC,cAAc;oBAAEN;gBAAI;YAC5B;YACA,OAAO;gBACHA;gBACA,MAAMY,OAAO,IAAI;YACrB;QACJ,EAAE,OAAOR,IAAI;YACT,OAAO;gBACHJ;gBACA,OAAOI;YACX;QACJ;IACJ;IAEA,MAAa,aACTH,KAAkB,EACY;QAC9B,MAAMQ,OAAO;eAAIR;SAAM;QAEvB,MAAMqB,cAAc,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;YAC/C,QAAQb,KAAK,GAAG,CAACT,CAAAA,MACN;oBACH,IAAIK;oBACJ,IAAIC,cAAc;wBAAEN;oBAAI;gBAC5B;QAER;QAEA,IAAI;YACA,MAAMsB,YAAY,OAAO;YACzB,OAAO;gBACHb;YACJ;QACJ,EAAE,OAAOL,IAAI;YACT,OAAO;gBACHK;gBACA,OAAOL;YACX;QACJ;IACJ;AACJ;AAEA,2BAAeT"}

package/README.md

@@ -1,67 +1,11 @@
 # @webiny/db-dynamodb
-[![](https://img.shields.io/npm/dw/webiny-data-dynamodb.svg)](https://www.npmjs.com/package/webiny-data-dynamodb) 
-[![](https://img.shields.io/npm/v/webiny-data-dynamodb.svg)](https://www.npmjs.com/package/webiny-data-dynamodb)
-[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
-[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
 
-A set of frequently used data-dynamodb higher order functions.
+> [!NOTE]
+> This package is part of the [Webiny](https://www.webiny.com) monorepo.
+> It’s **included in every Webiny project by default** and is not meant to be used as a standalone package.
 
-For more information, please visit 
-[the official docs](https://github.com/doitadrian/data-dynamodb). 
-  
-## Install
-```
-yarn add @webiny/db-dynamodb
-```
+📘 **Documentation:** [https://www.webiny.com/docs](https://www.webiny.com/docs)
 
+---
 
-### Helper functions
-We have a number [helper](./src/utils) functions that ease the use of either dynamodb-toolbox, filtering, sorting or just creating proper response.
-
-#### [batchRead](./src/utils/batchRead.ts)
-Read a batch of records from the DynamoDB table.
-
-This function accepts [table](https://github.com/jeremydaly/dynamodb-toolbox/blob/main/src/classes/Table.ts) and items, an array of objects created by [Entity.getBatch()](https://github.com/jeremydaly/dynamodb-toolbox/blob/main/src/classes/Entity.ts#L313).
-
-Internally it reads records until there are no more to read and returns a list of read records.
-
-#### [batchWrite](./src/utils/batchWrite.ts)
-Write a batch of records to the DynamoDB table.
-
-This function accepts [table](https://github.com/jeremydaly/dynamodb-toolbox/blob/main/src/classes/Table.ts) and items, an array of objects created by [Entity.putBatch()](https://github.com/jeremydaly/dynamodb-toolbox/blob/main/src/classes/Entity.ts#L989).
-It also accepts a number which defines a number of items to be written in one request. DO NOT put that number over the official DynamoDB maximum.
-
-Internally it loops through the items received (in chunks of `maxChunks` parameter) and does not return anything.
-
-
-#### [cleanupItem and cleanupItems](./src/utils/cleanup.ts)
-Clean up records received from the DynamoDB table. 
-
-This function accepts [entity](https://github.com/jeremydaly/dynamodb-toolbox/blob/main/src/classes/Entity.ts) and item to be cleaned up, in case of the cleanupItem.
-In case of `cleanupItems` it accepts an array of items to clean up.
-
-We use this to remove the properties that dynamodb-toolbox puts on the record automatically.
-
-#### [get](./src/utils/get.ts)
-Get a single record from the DynamoDB table with given keys.
-
-This function accepts [entity](https://github.com/jeremydaly/dynamodb-toolbox/blob/main/src/classes/Entity.ts) and keys to fetch the record by.
-
-It returns either record or null. By default, [entity.get()](https://github.com/jeremydaly/dynamodb-toolbox/blob/main/src/classes/Entity.ts#L281) returns a object with some meta data and `Item` property, which contains the record (or null if no record).
-
-#### [queryOne and queryAll](./src/utils/query.ts)
-Query the DynamoDB table for record(s) by given partition key and query options.
-
-This function accepts [entity](https://github.com/jeremydaly/dynamodb-toolbox/blob/main/src/classes/Entity.ts) to perform the query on, `partitionKey` to query by and [options](https://github.com/jeremydaly/dynamodb-toolbox/blob/main/src/classes/Table.ts#L65) to define the query parameters with.
-
-The `queryAll` method accepts `limit`, a number with which you can load only a certain amount of records. The `queryOne` method does not have that property.
-
-#### [filter](./src/utils/filter.ts)
-Filter the DynamoDB records by given where condition.
-
-This function accepts items (records) to be filtered, a definition of fields to filter by (not required by default if no field modification is required), where conditions (eg. `{published: true, date_gte: "2021-01-01"}`) and filtering plugins.
-
-#### [sort](./src/utils/sort.ts)
-Sort the DynamoDB records by given sort condition.
-
-This function accepts items (records) to be sorted, sort options (eg. createdBy_ASC, id_DESC, etc.) and a definitions of fields to sort by (not required by default if no field modification is required).
+_This README file is automatically generated during the publish process._

package/exports/api/db.d.ts

@@ -0,0 +1,3 @@
+export { DynamoDBClient } from "../../feature/DynamoDBClient/index.js";
+export { ValueFilter, ValueFilterRegistry } from "../../feature/ValueFilter/index.js";
+export { FilterUtil } from "../../feature/FilterUtil/index.js";

package/exports/api/db.js

@@ -0,0 +1,3 @@
+export { DynamoDBClient } from "../../feature/DynamoDBClient/index.js";
+export { ValueFilter, ValueFilterRegistry } from "../../feature/ValueFilter/index.js";
+export { FilterUtil } from "../../feature/FilterUtil/index.js";