@qrvey/data-persistence 0.0.1

package/README.md

@@ -0,0 +1,77 @@
+
+# @qrvey/data-persistence
+
+![install size](https://packagephobia.com/badge?p=%40qrvey%2Fdata-persistence)
+
+
+## Installation
+
+You can install the package using npm or yarn:
+
+```bash
+npm install @qrvey/data-persistence
+```
+
+Or with yarn:
+
+```bash
+yarn add @qrvey/data-persistence
+```
+
+## Peer Dependencies
+
+This package has the following peer dependencies:
+
+- `@aws-sdk/client-dynamodb` (v3.x) and `@aws-sdk/lib-dynamodb` (v3.x) for interacting with **DynamoDB**.
+- `pg` (v8.x) and `pg-format` (v1.x) for interacting with **PostgreSQL** databases.
+
+## Concepts
+### CrudService: 
+This class serves as the foundation for interacting with your database. It exposes methods for performing CRUD operations on entities (data objects).
+
+#### Basic Functions
+
+- `create(entity: T)`: Creates a new entity in the database.
+- find(options: IFindOptions): Retrieves entities based on specified options (filters, sorting, pagination).
+- `findAll(options: IFindOptions)`: Retrieves all entities based on specified options, this function make an internal pagination to load all data.
+- `findItem (options: IFindOptions)`: Fetches a single entity by a specified filter.
+- `update(filters: IFilter[], data: Partial<T>)`: Updates entities matching the provided filters with the given data.
+- `remove(filters: IFilter[])`: Deletes entities that satisfy the specified filters.
+
+#### Helper Functions:
+These methods assist in constructing filters, query indexes, and sorting criteria for use within your CRUD operations.
+
+- `buildFilter(attribute: string, value: string, operator = 'EQUAL')`: Creates a filter object for a specific attribute.
+- `buildQueryIndex(indexName: string, columns: string[])`: Constructs a query index for efficient data retrieval.
+- `buildSort(column: string, direction: SortDirection)`: Generates a sorting object for ordering results.
+
+
+### CrudSchema: 
+This interface defines the structure of a database table. It allows you to specify the table name, columns, and optional schema and pool usage.
+
+#### Properties:
+
+- `static table: string | ITableName`: This property defines the name of the database table that the CrudService will interact with. It can be a simple string (e.g., "users") or an object implementing the ITableName interface (discussed later).
+
+- `static columns: ITableColumns`: This property represents an array of column definitions for the table. It should conform to the ITableColumns interface (discussed later). Each column definition likely specifies details like column name, data type, and potentially constraints.
+
+- `static usePool?: boolean = false`: This optional boolean property (defaulting to false) indicates whether to use a connection pool for database interactions. Setting it to true can improve performance for frequent queries.
+
+- `static schema: string | null = null`: This optional string property allows specifying the schema name (if applicable) where the table resides. It can be a string (e.g., "public") or null if the default schema is used.
+
+### Supported Filter Operators
+This library provides a set of filter operators for performing comparisons on entity attributes within your database. These operators allow you to construct filters for your CRUD operations.
+
+#### Available Operators
+The FilterOperator enum defines the following operators:
+
+- EQUAL.
+- NOT_EQUAL.
+- CONTAINS: This operator checks if the attribute value contains the specified string as a substring.
+-NOT_CONTAINS: This operator checks if the attribute value does not contain the specified string as a substring.
+- GREATER_THAN.
+- GREATER_THAN_EQUAL.
+- LESS_THAN.
+- LESS_THAN_EQUAL.
+- IN: This operator checks if the attribute value is present within a specified list of values.
+- STARTS_WITH: This operator checks if the attribute value starts with the provided string. It uses parameterized query syntax for security.

package/dist/cjs/helpers/crudHelpers.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildSort = exports.buildQueryIndex = exports.buildFilter = void 0;
+const constants_1 = require("../utils/constants");
+function buildFilter(attribute, value, operator = 'EQUAL') {
+    return {
+        attribute,
+        operator,
+        value,
+    };
+}
+exports.buildFilter = buildFilter;
+function buildQueryIndex(indexName, columns) {
+    return {
+        indexName,
+        columns,
+    };
+}
+exports.buildQueryIndex = buildQueryIndex;
+function buildSort(column, direction = constants_1.SORT_DIRECTIONS.ASC) {
+    return {
+        column,
+        direction,
+    };
+}
+exports.buildSort = buildSort;
+//# sourceMappingURL=crudHelpers.js.map

package/dist/cjs/helpers/crudHelpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"crudHelpers.js","sourceRoot":"","sources":["../../../src/helpers/crudHelpers.ts"],"names":[],"mappings":";;;AAEA,kDAAqD;AAErD,SAAgB,WAAW,CACvB,SAAiB,EACjB,KAAa,EACb,QAAQ,GAAG,OAAO;IAElB,OAAO;QACH,SAAS;QACT,QAAQ;QACR,KAAK;KACR,CAAC;AACN,CAAC;AAVD,kCAUC;AAED,SAAgB,eAAe,CAAC,SAAiB,EAAE,OAAiB;IAChE,OAAO;QACH,SAAS;QACT,OAAO;KACV,CAAC;AACN,CAAC;AALD,0CAKC;AAED,SAAgB,SAAS,CACrB,MAAc,EACd,YAA2B,2BAAe,CAAC,GAAG;IAE9C,OAAO;QACH,MAAM;QACN,SAAS;KACZ,CAAC;AACN,CAAC;AARD,8BAQC"}

package/dist/cjs/helpers/queryHelpers.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.METHOD_TO_QUERY = void 0;
+var METHOD_TO_QUERY;
+(function (METHOD_TO_QUERY) {
+    METHOD_TO_QUERY["where"] = "where";
+    METHOD_TO_QUERY["filter"] = "filter";
+    METHOD_TO_QUERY["update"] = "update";
+})(METHOD_TO_QUERY || (exports.METHOD_TO_QUERY = METHOD_TO_QUERY = {}));
+//# sourceMappingURL=queryHelpers.js.map

package/dist/cjs/helpers/queryHelpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryHelpers.js","sourceRoot":"","sources":["../../../src/helpers/queryHelpers.ts"],"names":[],"mappings":";;;AAAA,IAAY,eAIX;AAJD,WAAY,eAAe;IACvB,kCAAe,CAAA;IACf,oCAAiB,CAAA;IACjB,oCAAiB,CAAA;AACrB,CAAC,EAJW,eAAe,+BAAf,eAAe,QAI1B"}

package/dist/cjs/helpers/tableHelper.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPrimaryKeyColumns = exports.getTableName = exports.findIdColumnName = exports.getTableColumnNames = void 0;
+function getTableColumnNames(columns) {
+    return Object.keys(columns);
+}
+exports.getTableColumnNames = getTableColumnNames;
+function findIdColumnName(columns) {
+    return getTableColumnNames(columns).find((columnName) => columns[columnName].columnId === true);
+}
+exports.findIdColumnName = findIdColumnName;
+function getTableName(table, property = 'name') {
+    if (!table)
+        throw new Error('missing table property');
+    if (typeof table === 'string')
+        return table;
+    const { name, alias } = table;
+    return property === 'alias' && alias ? alias : name;
+}
+exports.getTableName = getTableName;
+function getPrimaryKeyColumns(columns) {
+    return getTableColumnNames(columns).filter((columnName) => columns[columnName].primary === true);
+}
+exports.getPrimaryKeyColumns = getPrimaryKeyColumns;
+//# sourceMappingURL=tableHelper.js.map

package/dist/cjs/helpers/tableHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tableHelper.js","sourceRoot":"","sources":["../../../src/helpers/tableHelper.ts"],"names":[],"mappings":";;;AAEA,SAAgB,mBAAmB,CAAC,OAAsB;IACtD,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AAChC,CAAC;AAFD,kDAEC;AAED,SAAgB,gBAAgB,CAAC,OAAsB;IACnD,OAAO,mBAAmB,CAAC,OAAO,CAAC,CAAC,IAAI,CACpC,CAAC,UAAU,EAAE,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,QAAQ,KAAK,IAAI,CACxD,CAAC;AACN,CAAC;AAJD,4CAIC;AAED,SAAgB,YAAY,CACxB,KAA0B,EAC1B,QAAQ,GAAG,MAAM;IAEjB,IAAI,CAAC,KAAK;QAAE,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAEtD,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAE5C,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC;IAC9B,OAAO,QAAQ,KAAK,OAAO,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;AACxD,CAAC;AAVD,oCAUC;AAED,SAAgB,oBAAoB,CAAC,OAAsB;IACvD,OAAO,mBAAmB,CAAC,OAAO,CAAC,CAAC,MAAM,CACtC,CAAC,UAAU,EAAE,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,OAAO,KAAK,IAAI,CACvD,CAAC;AACN,CAAC;AAJD,oDAIC"}

package/dist/cjs/index.js

@@ -0,0 +1,15 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildSort = exports.buildQueryIndex = exports.buildFilter = exports.CrudSchema = exports.CrudService = void 0;
+var crud_service_1 = require("./services/crud.service");
+Object.defineProperty(exports, "CrudService", { enumerable: true, get: function () { return __importDefault(crud_service_1).default; } });
+var crudSchema_1 = require("./schemas/crudSchema");
+Object.defineProperty(exports, "CrudSchema", { enumerable: true, get: function () { return crudSchema_1.CrudSchema; } });
+var crudHelpers_1 = require("./helpers/crudHelpers");
+Object.defineProperty(exports, "buildFilter", { enumerable: true, get: function () { return crudHelpers_1.buildFilter; } });
+Object.defineProperty(exports, "buildQueryIndex", { enumerable: true, get: function () { return crudHelpers_1.buildQueryIndex; } });
+Object.defineProperty(exports, "buildSort", { enumerable: true, get: function () { return crudHelpers_1.buildSort; } });
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,wDAAiE;AAAxD,4HAAA,OAAO,OAAe;AAC/B,mDAAkD;AAAzC,wGAAA,UAAU,OAAA;AAGnB,qDAAgF;AAAvE,0GAAA,WAAW,OAAA;AAAE,8GAAA,eAAe,OAAA;AAAE,wGAAA,SAAS,OAAA"}

package/dist/cjs/interfaces/compoundFilter.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=compoundFilter.interface.js.map

package/dist/cjs/interfaces/compoundFilter.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"compoundFilter.interface.js","sourceRoot":"","sources":["../../../src/interfaces/compoundFilter.interface.ts"],"names":[],"mappings":""}

package/dist/cjs/interfaces/crudService.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=crudService.interface.js.map

package/dist/cjs/interfaces/crudService.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"crudService.interface.js","sourceRoot":"","sources":["../../../src/interfaces/crudService.interface.ts"],"names":[],"mappings":""}

package/dist/cjs/interfaces/filter.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=filter.interface.js.map

package/dist/cjs/interfaces/filter.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filter.interface.js","sourceRoot":"","sources":["../../../src/interfaces/filter.interface.ts"],"names":[],"mappings":""}

package/dist/cjs/interfaces/findIndex.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=findIndex.interface.js.map

package/dist/cjs/interfaces/findIndex.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"findIndex.interface.js","sourceRoot":"","sources":["../../../src/interfaces/findIndex.interface.ts"],"names":[],"mappings":""}

package/dist/cjs/interfaces/findOptions.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=findOptions.interface.js.map

package/dist/cjs/interfaces/findOptions.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"findOptions.interface.js","sourceRoot":"","sources":["../../../src/interfaces/findOptions.interface.ts"],"names":[],"mappings":""}

package/dist/cjs/interfaces/findPagination.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=findPagination.interface.js.map

package/dist/cjs/interfaces/findPagination.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"findPagination.interface.js","sourceRoot":"","sources":["../../../src/interfaces/findPagination.interface.ts"],"names":[],"mappings":""}

package/dist/cjs/interfaces/findResult.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=findResult.interface.js.map

package/dist/cjs/interfaces/findResult.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"findResult.interface.js","sourceRoot":"","sources":["../../../src/interfaces/findResult.interface.ts"],"names":[],"mappings":""}

package/dist/cjs/interfaces/index.js

@@ -0,0 +1,29 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./compoundFilter.interface"), exports);
+__exportStar(require("./crudService.interface"), exports);
+__exportStar(require("./filter.interface"), exports);
+__exportStar(require("./findOptions.interface"), exports);
+__exportStar(require("./findPagination.interface"), exports);
+__exportStar(require("./queryOptions.interface"), exports);
+__exportStar(require("./findResult.interface"), exports);
+__exportStar(require("./findIndex.interface"), exports);
+__exportStar(require("./sorting.interface"), exports);
+__exportStar(require("./tableName.interface"), exports);
+__exportStar(require("./tableColumns.interface"), exports);
+__exportStar(require("./updateOptions.interface"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/interfaces/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/interfaces/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6DAA2C;AAC3C,0DAAwC;AACxC,qDAAmC;AACnC,0DAAwC;AACxC,6DAA2C;AAC3C,2DAAyC;AACzC,yDAAuC;AACvC,wDAAsC;AACtC,sDAAoC;AACpC,wDAAsC;AACtC,2DAAyC;AACzC,4DAA0C"}

package/dist/cjs/interfaces/queryBuilder.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=queryBuilder.interface.js.map

package/dist/cjs/interfaces/queryBuilder.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryBuilder.interface.js","sourceRoot":"","sources":["../../../src/interfaces/queryBuilder.interface.ts"],"names":[],"mappings":""}

package/dist/cjs/interfaces/queryBuilderCondition.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=queryBuilderCondition.interface.js.map

package/dist/cjs/interfaces/queryBuilderCondition.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryBuilderCondition.interface.js","sourceRoot":"","sources":["../../../src/interfaces/queryBuilderCondition.interface.ts"],"names":[],"mappings":""}

package/dist/cjs/interfaces/queryOptions.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=queryOptions.interface.js.map

package/dist/cjs/interfaces/queryOptions.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryOptions.interface.js","sourceRoot":"","sources":["../../../src/interfaces/queryOptions.interface.ts"],"names":[],"mappings":""}

package/dist/cjs/interfaces/sorting.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=sorting.interface.js.map

package/dist/cjs/interfaces/sorting.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sorting.interface.js","sourceRoot":"","sources":["../../../src/interfaces/sorting.interface.ts"],"names":[],"mappings":""}

package/dist/cjs/interfaces/tableColumns.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=tableColumns.interface.js.map

package/dist/cjs/interfaces/tableColumns.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tableColumns.interface.js","sourceRoot":"","sources":["../../../src/interfaces/tableColumns.interface.ts"],"names":[],"mappings":""}

package/dist/cjs/interfaces/tableName.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=tableName.interface.js.map

package/dist/cjs/interfaces/tableName.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tableName.interface.js","sourceRoot":"","sources":["../../../src/interfaces/tableName.interface.ts"],"names":[],"mappings":""}

package/dist/cjs/interfaces/updateOptions.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=updateOptions.interface.js.map

package/dist/cjs/interfaces/updateOptions.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"updateOptions.interface.js","sourceRoot":"","sources":["../../../src/interfaces/updateOptions.interface.ts"],"names":[],"mappings":""}

package/dist/cjs/schemas/crudSchema.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CrudSchema = void 0;
+class CrudSchema {
+}
+exports.CrudSchema = CrudSchema;
+CrudSchema.usePool = false;
+CrudSchema.schema = null;
+//# sourceMappingURL=crudSchema.js.map

package/dist/cjs/schemas/crudSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"crudSchema.js","sourceRoot":"","sources":["../../../src/schemas/crudSchema.ts"],"names":[],"mappings":";;;AAEA,MAAa,UAAU;;AAAvB,gCAKC;AAFU,kBAAO,GAAa,KAAK,CAAC;AAC1B,iBAAM,GAAkB,IAAI,CAAC"}

package/dist/cjs/schemas/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./crudSchema"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/schemas/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/schemas/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B"}

package/dist/cjs/services/crud.service.js

@@ -0,0 +1,51 @@
+"use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const crudHelpers_1 = require("../helpers/crudHelpers");
+const crudFactory_service_1 = require("./crudFactory.service");
+class CrudService {
+    constructor(crudSchema) {
+        this.crudService = crudFactory_service_1.CrudFactory.databaseClientService(crudSchema);
+    }
+    create(entity) {
+        return this.crudService.create(entity);
+    }
+    find(options) {
+        return this.crudService.find(options);
+    }
+    findItem(options) {
+        return this.crudService.findItem(options);
+    }
+    update(filters, data) {
+        return this.crudService.update(filters, data);
+    }
+    remove(filters) {
+        return this.crudService.remove(filters);
+    }
+    findAll(options) {
+        // eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars
+        const { pagination } = options, findAllOptions = __rest(options, ["pagination"]);
+        return this.crudService.findAll(findAllOptions);
+    }
+    buildFilter(attribute, value, operator = 'EQUAL') {
+        return (0, crudHelpers_1.buildFilter)(attribute, value, operator);
+    }
+    buildQueryIndex(indexName, columns) {
+        return (0, crudHelpers_1.buildQueryIndex)(indexName, columns);
+    }
+    buildSort(column, direction) {
+        return (0, crudHelpers_1.buildSort)(column, direction);
+    }
+}
+exports.default = CrudService;
+//# sourceMappingURL=crud.service.js.map

package/dist/cjs/services/crud.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"crud.service.js","sourceRoot":"","sources":["../../../src/services/crud.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,wDAIgC;AAUhC,+DAAoD;AAEpD,MAAM,WAAW;IAGb,YAAY,UAA6B;QACrC,IAAI,CAAC,WAAW,GAAG,iCAAW,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;IACrE,CAAC;IAED,MAAM,CAAC,MAAS;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IAED,IAAI,CAAC,OAAqB;QACtB,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC1C,CAAC;IAED,QAAQ,CAAC,OAAqB;QAC1B,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC9C,CAAC;IAED,MAAM,CACF,OAAoC,EACpC,IAAgB;QAEhB,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAClD,CAAC;IAED,MAAM,CAAC,OAAoC;QACvC,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC5C,CAAC;IAED,OAAO,CAAC,OAAqB;QACzB,6EAA6E;QAC7E,MAAM,EAAE,UAAU,KAAwB,OAAO,EAA1B,cAAc,UAAK,OAAO,EAA3C,cAAiC,CAAU,CAAC;QAClD,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IACpD,CAAC;IAED,WAAW,CAAC,SAAiB,EAAE,KAAa,EAAE,QAAQ,GAAG,OAAO;QAC5D,OAAO,IAAA,yBAAW,EAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IACnD,CAAC;IAED,eAAe,CAAC,SAAiB,EAAE,OAAiB;QAChD,OAAO,IAAA,6BAAe,EAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;IAED,SAAS,CAAC,MAAc,EAAE,SAAwB;QAC9C,OAAO,IAAA,uBAAS,EAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACxC,CAAC;CACJ;AAED,kBAAe,WAAW,CAAC"}

package/dist/cjs/services/crudFactory.service.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CrudFactory = void 0;
+const cruds_1 = require("./cruds");
+class CrudFactory {
+    static databaseClientService(crudSchema) {
+        var _a;
+        const isMultiPlatformMode = ((_a = process.env.PLATFORM_TYPE) === null || _a === void 0 ? void 0 : _a.toLowerCase()) === 'container';
+        if (isMultiPlatformMode)
+            return new cruds_1.PostgreSqlCrudService(crudSchema);
+        return new cruds_1.DynamoDbCrudService(crudSchema);
+    }
+}
+exports.CrudFactory = CrudFactory;
+//# sourceMappingURL=crudFactory.service.js.map

package/dist/cjs/services/crudFactory.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"crudFactory.service.js","sourceRoot":"","sources":["../../../src/services/crudFactory.service.ts"],"names":[],"mappings":";;;AAEA,mCAAqE;AACrE,MAAa,WAAW;IACpB,MAAM,CAAC,qBAAqB,CACxB,UAA6B;;QAE7B,MAAM,mBAAmB,GACrB,CAAA,MAAA,OAAO,CAAC,GAAG,CAAC,aAAa,0CAAE,WAAW,EAAE,MAAK,WAAW,CAAC;QAE7D,IAAI,mBAAmB;YACnB,OAAO,IAAI,6BAAqB,CAAI,UAAU,CAAC,CAAC;QACpD,OAAO,IAAI,2BAAmB,CAAI,UAAU,CAAC,CAAC;IAClD,CAAC;CACJ;AAXD,kCAWC"}

package/dist/cjs/services/cruds/dynamodb/dynamoDbClient.service.js

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const client_dynamodb_1 = require("@aws-sdk/client-dynamodb");
+const lib_dynamodb_1 = require("@aws-sdk/lib-dynamodb");
+const AWS_REGION = process.env.AWS_DEFAULT_REGION;
+/**
+ * Ref:
+ * - https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html
+ * - https://www.fernandomc.com/posts/eight-examples-of-fetching-data-from-dynamodb-with-node/
+ */
+class DynamoDbClientService {
+    constructor(tableName) {
+        if (!tableName)
+            throw new Error('The "tableName" is required to use a DynamoDbClientService.');
+        this.tableName = tableName;
+        const client = new client_dynamodb_1.DynamoDBClient({ region: AWS_REGION });
+        this.dynamoDBClient = lib_dynamodb_1.DynamoDBDocumentClient.from(client, {
+            marshallOptions: {
+                removeUndefinedValues: true,
+            },
+        });
+    }
+    /**
+     * Get an item by key
+     * @param {Object} keyObject - Ex: { jobId: 1234 }
+     * @param {GetCommandInput} options
+     */
+    async getByKey(
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    keyObject, options = {}) {
+        const params = Object.assign({ TableName: this.tableName, Key: keyObject }, options);
+        const result = await this.dynamoDBClient.send(new lib_dynamodb_1.GetCommand(params));
+        return result.Item;
+    }
+    /**
+     * Query a table
+     * @param {QueryCommandInput} options
+     */
+    async query(options = {}) {
+        const params = Object.assign({ TableName: this.tableName }, options);
+        const result = await this.dynamoDBClient.send(new lib_dynamodb_1.QueryCommand(params));
+        if (result.$metadata)
+            delete result.$metadata;
+        return result;
+    }
+    /**
+     * Scan a table
+     * @param {ScanInput} options
+     */
+    async scan(input) {
+        const params = Object.assign(Object.assign({}, input), { TableName: this.tableName });
+        const command = new lib_dynamodb_1.ScanCommand(params);
+        const response = await this.dynamoDBClient.send(command);
+        if (response.$metadata)
+            delete response.$metadata;
+        return response;
+    }
+    /**
+     * Create/Replace a item object
+     * To take care:
+     * - https://stackoverflow.com/questions/43667229/difference-between-dynamodb-putitem-vs-updateitem
+     * @param {Object} input
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    async put(input) {
+        const params = {
+            TableName: this.tableName,
+            Item: input,
+            ReturnValues: 'NONE',
+        };
+        return await this.dynamoDBClient.send(new lib_dynamodb_1.PutCommand(params));
+    }
+    /**
+     * Update a item object
+     * To take care:
+     * - https://stackoverflow.com/questions/43667229/difference-between-dynamodb-putitem-vs-updateitem
+     * @param {Object} keyObject - Ex: { jobId: 1234 }
+     * @param {UpdateCommandInput} updateObject
+     */
+    async update(
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    keyObject, options = {}) {
+        const params = Object.assign({ TableName: this.tableName, Key: keyObject, ReturnValues: 'NONE' }, options);
+        return await this.dynamoDBClient.send(new lib_dynamodb_1.UpdateCommand(params));
+    }
+    /**
+     * Delete/Remove an item object
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    async remove(keyObject) {
+        const params = {
+            TableName: this.tableName,
+            Key: keyObject,
+            ReturnValues: 'NONE',
+        };
+        return await this.dynamoDBClient.send(new lib_dynamodb_1.DeleteCommand(params));
+    }
+}
+exports.default = DynamoDbClientService;
+//# sourceMappingURL=dynamoDbClient.service.js.map

package/dist/cjs/services/cruds/dynamodb/dynamoDbClient.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dynamoDbClient.service.js","sourceRoot":"","sources":["../../../../../src/services/cruds/dynamodb/dynamoDbClient.service.ts"],"names":[],"mappings":";;AAAA,8DAA0D;AAC1D,wDAe+B;AAE/B,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC;AAElD;;;;GAIG;AACH,MAAqB,qBAAqB;IAItC,YAAY,SAAiB;QACzB,IAAI,CAAC,SAAS;YACV,MAAM,IAAI,KAAK,CACX,6DAA6D,CAChE,CAAC;QACN,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,MAAM,MAAM,GAAG,IAAI,gCAAc,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC;QAC1D,IAAI,CAAC,cAAc,GAAG,qCAAsB,CAAC,IAAI,CAAC,MAAM,EAAE;YACtD,eAAe,EAAE;gBACb,qBAAqB,EAAE,IAAI;aAC9B;SACJ,CAAC,CAAC;IACP,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,QAAQ;IACjB,8DAA8D;IAC9D,SAA8B,EAC9B,UAAoC,EAAE;QAEtC,MAAM,MAAM,mBACR,SAAS,EAAE,IAAI,CAAC,SAAS,EACzB,GAAG,EAAE,SAAS,IACX,OAAO,CACb,CAAC;QACF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,yBAAU,CAAC,MAAM,CAAC,CAAC,CAAC;QACtE,OAAO,MAAM,CAAC,IAAI,CAAC;IACvB,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,KAAK,CACd,UAAgD,EAAE;QAElD,MAAM,MAAM,mBACR,SAAS,EAAE,IAAI,CAAC,SAAS,IACtB,OAAO,CACb,CAAC;QACF,MAAM,MAAM,GACR,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,2BAAY,CAAC,MAAM,CAAC,CAAC,CAAC;QAE7D,IAAI,MAAM,CAAC,SAAS;YAAE,OAAO,MAAM,CAAC,SAAS,CAAC;QAC9C,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,IAAI,CACb,KAAuB;QAEvB,MAAM,MAAM,mCACL,KAAK,KACR,SAAS,EAAE,IAAI,CAAC,SAAS,GAC5B,CAAC;QAEF,MAAM,OAAO,GAAG,IAAI,0BAAW,CAAC,MAAM,CAAC,CAAC;QACxC,MAAM,QAAQ,GACV,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC5C,IAAI,QAAQ,CAAC,SAAS;YAAE,OAAO,QAAQ,CAAC,SAAS,CAAC;QAClD,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACH,8DAA8D;IACvD,KAAK,CAAC,GAAG,CAAC,KAA0B;QACvC,MAAM,MAAM,GAAoB;YAC5B,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,IAAI,EAAE,KAAK;YACX,YAAY,EAAE,MAAM;SACvB,CAAC;QACF,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,yBAAU,CAAC,MAAM,CAAC,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM;IACf,8DAA8D;IAC9D,SAA8B,EAC9B,UAAuC,EAAE;QAEzC,MAAM,MAAM,mBACR,SAAS,EAAE,IAAI,CAAC,SAAS,EACzB,GAAG,EAAE,SAAS,EACd,YAAY,EAAE,MAAM,IACjB,OAAO,CACb,CAAC;QACF,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,4BAAa,CAAC,MAAM,CAAC,CAAC,CAAC;IACrE,CAAC;IAED;;OAEG;IACH,8DAA8D;IACvD,KAAK,CAAC,MAAM,CAAC,SAA8B;QAC9C,MAAM,MAAM,GAAuB;YAC/B,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,GAAG,EAAE,SAAS;YACd,YAAY,EAAE,MAAM;SACvB,CAAC;QACF,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,4BAAa,CAAC,MAAM,CAAC,CAAC,CAAC;IACrE,CAAC;CACJ;AA3HD,wCA2HC"}