@kravc/dos-dynamodb 1.0.0-alpha.0

package/dist/src/Table/helpers/getTableOptions.js

@@ -0,0 +1,144 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LOCAL_REGION = void 0;
+const config_1 = __importDefault(require("config"));
+const dos_1 = require("@kravc/dos");
+const lodash_1 = require("lodash");
+const node_path_1 = require("node:path");
+const node_fs_1 = require("node:fs");
+exports.LOCAL_REGION = 'local';
+const PRIVATE_PROFILE = 'private';
+/** Returns default table name. */
+const getDefaultName = () => {
+    const ROOT_PATH = process.cwd();
+    const { NODE_APP_INSTANCE } = process.env;
+    const { name } = JSON.parse((0, node_fs_1.readFileSync)((0, node_path_1.join)(ROOT_PATH, 'package.json'), 'utf-8'));
+    const prefix = name.replace('@', '').replace('/', '-');
+    return [prefix, NODE_APP_INSTANCE].filter(value => !!value).join('-');
+};
+/** Returns options for DynamoDB table creation. */
+const getTableOptions = (partitionKey, sortKey) => {
+    const tableConfig = config_1.default.get('dynamodb');
+    const tableOptions = JSON.parse(JSON.stringify(tableConfig));
+    const name = (0, lodash_1.get)(tableConfig, 'name', getDefaultName());
+    const indexKeys = (0, lodash_1.get)(tableConfig, 'indexKeys', {});
+    const region = (0, lodash_1.get)(config_1.default, 'aws.region', exports.LOCAL_REGION);
+    const profile = (0, lodash_1.get)(config_1.default, 'aws.profile', PRIVATE_PROFILE);
+    const primaryKey = {
+        sortKey,
+        partitionKey,
+    };
+    tableOptions.name = name;
+    tableOptions.region = region;
+    tableOptions.profile = profile;
+    tableOptions.indexKeys = indexKeys;
+    tableOptions.primaryKey = primaryKey;
+    tableOptions.isLocalhost = region === exports.LOCAL_REGION;
+    tableOptions.localSecondaryIndexes = (0, lodash_1.get)(config_1.default, 'localSecondaryIndexes', [
+        {
+            name: 'lsi1',
+            sortKey: '_lsi1SortKey',
+        },
+        {
+            name: 'lsi2',
+            sortKey: '_lsi2SortKey',
+        },
+        {
+            name: 'lsi3',
+            sortKey: '_lsi3SortKey',
+        },
+    ]);
+    tableOptions.globalSecondaryIndexes = (0, lodash_1.get)(config_1.default, 'globalSecondaryIndexes', [
+        {
+            name: 'gsi1',
+            partitionKey: '_gsi1PartitionKey',
+            sortKey: '_gsi1SortKey',
+        },
+        {
+            name: 'gsi2',
+            partitionKey: '_gsi2PartitionKey',
+            sortKey: '_gsi2SortKey',
+        },
+        {
+            name: 'gsi3',
+            partitionKey: '_gsi3PartitionKey',
+            sortKey: '_gsi3SortKey',
+        },
+    ]);
+    /** Returns sort key name for a local secondary index. */
+    const getLocalIndexSortKeyName = (indexName) => {
+        const { localSecondaryIndexes } = tableOptions;
+        const index = localSecondaryIndexes.find(({ name }) => name === indexName);
+        const indexesJson = JSON.stringify(localSecondaryIndexes, null, 2);
+        if (!index) {
+            throw new Error(`Local secondary index "${indexName}" is not defined, local indexes: ${indexesJson}`);
+        }
+        return (0, dos_1.got)(index, 'sortKey');
+    };
+    /** Returns partition key name for a global secondary index. */
+    const getGlobalIndexPartitionKeyName = (indexName) => {
+        const { globalSecondaryIndexes } = tableOptions;
+        const index = globalSecondaryIndexes.find(({ name }) => name === indexName);
+        const indexesJson = JSON.stringify(globalSecondaryIndexes, null, 2);
+        if (!index) {
+            throw new Error(`Global secondary index "${indexName}" is not defined, global indexes: ${indexesJson}`);
+        }
+        return (0, dos_1.got)(index, 'partitionKey');
+    };
+    /** Returns sort key name for a global secondary index. */
+    const getGlobalIndexSortKeyName = (indexName) => {
+        const { globalSecondaryIndexes } = tableOptions;
+        const index = globalSecondaryIndexes.find(({ name }) => name === indexName);
+        const indexesJson = JSON.stringify(globalSecondaryIndexes, null, 2);
+        if (!index) {
+            throw new Error(`Global secondary index "${indexName}" is not defined, global indexes: ${indexesJson}`);
+        }
+        return (0, dos_1.got)(index, 'sortKey');
+    };
+    /** Returns true if local secondary index, false if global secondary index; throws if not found. */
+    const isLocalSecondaryIndex = (indexName) => {
+        const { localSecondaryIndexes, globalSecondaryIndexes } = tableOptions;
+        const lsi = localSecondaryIndexes.find(({ name }) => name === indexName);
+        if (lsi) {
+            return true;
+        }
+        const gsi = globalSecondaryIndexes.find(({ name }) => name === indexName);
+        if (gsi) {
+            return false;
+        }
+        const indexesJson = JSON.stringify({ localSecondaryIndexes, globalSecondaryIndexes }, null, 2);
+        throw new Error(`Index "${indexName}" is not defined, indexes: ${indexesJson}`);
+    };
+    /** Returns props for a local index by name. */
+    const getLocalIndexProps = (indexName) => {
+        isLocalSecondaryIndex(indexName);
+        const sortKeyName = getLocalIndexSortKeyName(indexName);
+        return {
+            indexName,
+            sortKeyName,
+        };
+    };
+    /** Returns props for a global index by name. */
+    const getGlobalIndexProps = (indexName) => {
+        isLocalSecondaryIndex(indexName);
+        const sortKeyName = getGlobalIndexSortKeyName(indexName);
+        const partitionKeyName = getGlobalIndexPartitionKeyName(indexName);
+        return {
+            indexName,
+            sortKeyName,
+            partitionKeyName,
+        };
+    };
+    tableOptions.getLocalIndexSortKeyName = getLocalIndexSortKeyName;
+    tableOptions.getGlobalIndexPartitionKeyName = getGlobalIndexPartitionKeyName;
+    tableOptions.getGlobalIndexSortKeyName = getGlobalIndexSortKeyName;
+    tableOptions.isLocalSecondaryIndex = isLocalSecondaryIndex;
+    tableOptions.getGlobalIndexProps = getGlobalIndexProps;
+    tableOptions.getLocalIndexProps = getLocalIndexProps;
+    return tableOptions;
+};
+exports.default = getTableOptions;
+//# sourceMappingURL=getTableOptions.js.map

package/dist/src/Table/helpers/getTableOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getTableOptions.js","sourceRoot":"","sources":["../../../../src/Table/helpers/getTableOptions.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA4B;AAC5B,oCAAiC;AACjC,mCAA6B;AAC7B,yCAAiC;AACjC,qCAAuC;AAE1B,QAAA,YAAY,GAAG,OAAO,CAAC;AACpC,MAAM,eAAe,GAAG,SAAS,CAAC;AAiDlC,kCAAkC;AAClC,MAAM,cAAc,GAAG,GAAW,EAAE;IAClC,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAChC,MAAM,EAAE,iBAAiB,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAE1C,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,KAAK,CACzB,IAAA,sBAAY,EAAC,IAAA,gBAAI,EAAC,SAAS,EAAE,cAAc,CAAC,EAAE,OAAO,CAAC,CAClC,CAAC;IAEvB,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAEvD,OAAO,CAAE,MAAM,EAAE,iBAAiB,CAAE,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC1E,CAAC,CAAC;AAEF,mDAAmD;AACnD,MAAM,eAAe,GAAG,CAAC,YAAoB,EAAE,OAAe,EAAgB,EAAE;IAC9E,MAAM,WAAW,GAAG,gBAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC3C,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAiB,CAAC;IAE7E,MAAM,IAAI,GAAG,IAAA,YAAG,EAAC,WAAW,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC,CAAC;IACxD,MAAM,SAAS,GAAG,IAAA,YAAG,EAAC,WAAW,EAAE,WAAW,EAAE,EAAE,CAAC,CAAC;IAEpD,MAAM,MAAM,GAAG,IAAA,YAAG,EAAC,gBAAM,EAAE,YAAY,EAAE,oBAAY,CAAC,CAAC;IACvD,MAAM,OAAO,GAAG,IAAA,YAAG,EAAC,gBAAM,EAAE,aAAa,EAAE,eAAe,CAAC,CAAC;IAE5D,MAAM,UAAU,GAAG;QACjB,OAAO;QACP,YAAY;KACb,CAAC;IAEF,YAAY,CAAC,IAAI,GAAG,IAAI,CAAC;IACzB,YAAY,CAAC,MAAM,GAAG,MAAM,CAAC;IAC7B,YAAY,CAAC,OAAO,GAAG,OAAO,CAAC;IAC/B,YAAY,CAAC,SAAS,GAAG,SAAS,CAAC;IACnC,YAAY,CAAC,UAAU,GAAG,UAAU,CAAC;IACrC,YAAY,CAAC,WAAW,GAAG,MAAM,KAAK,oBAAY,CAAC;IAEnD,YAAY,CAAC,qBAAqB,GAAG,IAAA,YAAG,EAAC,gBAAM,EAAE,uBAAuB,EAAE;QACxE;YACE,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,cAAc;SACxB;QACD;YACE,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,cAAc;SACxB;QACD;YACE,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,cAAc;SACxB;KACF,CAAU,CAAC;IAEZ,YAAY,CAAC,sBAAsB,GAAG,IAAA,YAAG,EAAC,gBAAM,EAAE,wBAAwB,EAAE;QAC1E;YACE,IAAI,EAAE,MAAM;YACZ,YAAY,EAAE,mBAAmB;YACjC,OAAO,EAAE,cAAc;SACxB;QACD;YACE,IAAI,EAAE,MAAM;YACZ,YAAY,EAAE,mBAAmB;YACjC,OAAO,EAAE,cAAc;SACxB;QACD;YACE,IAAI,EAAE,MAAM;YACZ,YAAY,EAAE,mBAAmB;YACjC,OAAO,EAAE,cAAc;SACxB;KACF,CAAU,CAAC;IAEZ,yDAAyD;IACzD,MAAM,wBAAwB,GAAG,CAAC,SAAiB,EAAU,EAAE;QAC7D,MAAM,EAAE,qBAAqB,EAAE,GAAG,YAAY,CAAC;QAE/C,MAAM,KAAK,GAAG,qBAAqB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;QAC3E,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,qBAAqB,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAEnE,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,0BAA0B,SAAS,oCAAoC,WAAW,EAAE,CAAC,CAAC;QACxG,CAAC;QAED,OAAO,IAAA,SAAG,EAAC,KAAK,EAAE,SAAS,CAAW,CAAC;IACzC,CAAC,CAAC;IAEF,+DAA+D;IAC/D,MAAM,8BAA8B,GAAG,CAAC,SAAiB,EAAU,EAAE;QACnE,MAAM,EAAE,sBAAsB,EAAE,GAAG,YAAY,CAAC;QAEhD,MAAM,KAAK,GAAG,sBAAsB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;QAC5E,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,sBAAsB,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAEpE,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,2BAA2B,SAAS,qCAAqC,WAAW,EAAE,CAAC,CAAC;QAC1G,CAAC;QAED,OAAO,IAAA,SAAG,EAAC,KAAK,EAAE,cAAc,CAAW,CAAC;IAC9C,CAAC,CAAC;IAEF,0DAA0D;IAC1D,MAAM,yBAAyB,GAAG,CAAC,SAAiB,EAAU,EAAE;QAC9D,MAAM,EAAE,sBAAsB,EAAE,GAAG,YAAY,CAAC;QAEhD,MAAM,KAAK,GAAG,sBAAsB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;QAC5E,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,sBAAsB,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAEpE,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,2BAA2B,SAAS,qCAAqC,WAAW,EAAE,CAAC,CAAC;QAC1G,CAAC;QAED,OAAO,IAAA,SAAG,EAAC,KAAK,EAAE,SAAS,CAAW,CAAC;IACzC,CAAC,CAAC;IAEF,mGAAmG;IACnG,MAAM,qBAAqB,GAAG,CAAC,SAAiB,EAAW,EAAE;QAC3D,MAAM,EACJ,qBAAqB,EACrB,sBAAsB,EACvB,GAAG,YAAY,CAAC;QAEjB,MAAM,GAAG,GAAG,qBAAqB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;QAEzE,IAAI,GAAG,EAAE,CAAC;YACR,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,GAAG,GAAG,sBAAsB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;QAE1E,IAAI,GAAG,EAAE,CAAC;YACR,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAC/F,MAAM,IAAI,KAAK,CAAC,UAAU,SAAS,8BAA8B,WAAW,EAAE,CAAC,CAAC;IAClF,CAAC,CAAC;IAEF,+CAA+C;IAC/C,MAAM,kBAAkB,GAAG,CAAC,SAAiB,EAAmB,EAAE;QAChE,qBAAqB,CAAC,SAAS,CAAC,CAAC;QAEjC,MAAM,WAAW,GAAG,wBAAwB,CAAC,SAAS,CAAC,CAAC;QAExD,OAAO;YACL,SAAS;YACT,WAAW;SACZ,CAAC;IACJ,CAAC,CAAC;IAEF,gDAAgD;IAChD,MAAM,mBAAmB,GAAG,CAAC,SAAiB,EAAoB,EAAE;QAClE,qBAAqB,CAAC,SAAS,CAAC,CAAC;QAEjC,MAAM,WAAW,GAAG,yBAAyB,CAAC,SAAS,CAAC,CAAC;QACzD,MAAM,gBAAgB,GAAG,8BAA8B,CAAC,SAAS,CAAC,CAAC;QAEnE,OAAO;YACL,SAAS;YACT,WAAW;YACX,gBAAgB;SACjB,CAAC;IACJ,CAAC,CAAC;IAEF,YAAY,CAAC,wBAAwB,GAAG,wBAAwB,CAAC;IACjE,YAAY,CAAC,8BAA8B,GAAG,8BAA8B,CAAC;IAC7E,YAAY,CAAC,yBAAyB,GAAG,yBAAyB,CAAC;IACnE,YAAY,CAAC,qBAAqB,GAAG,qBAAqB,CAAC;IAC3D,YAAY,CAAC,mBAAmB,GAAG,mBAAmB,CAAC;IACvD,YAAY,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;IAErD,OAAO,YAAY,CAAC;AACtB,CAAC,CAAC;AAEF,kBAAe,eAAe,CAAC"}

package/dist/src/Table/helpers/index.d.ts

@@ -0,0 +1,10 @@
+import buildTableSchema from './buildTableSchema';
+import getRawClientConfig from './getRawClientConfig';
+import buildUpdateExpression from './buildUpdateExpression';
+import buildQueryCommandInput from './buildQueryCommandInput';
+import buildConditionExpression from './buildConditionExpression';
+import filterConditionExpression from './filterConditionExpression';
+import getTableOptions, { type TableOptions } from './getTableOptions';
+export { getTableOptions, buildTableSchema, getRawClientConfig, buildUpdateExpression, buildQueryCommandInput, buildConditionExpression, filterConditionExpression, };
+export type { TableOptions, };
+//# sourceMappingURL=index.d.ts.map

package/dist/src/Table/helpers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/Table/helpers/index.ts"],"names":[],"mappings":"AAAA,OAAO,gBAAgB,MAAM,oBAAoB,CAAC;AAClD,OAAO,kBAAkB,MAAM,sBAAsB,CAAC;AACtD,OAAO,qBAAqB,MAAM,yBAAyB,CAAC;AAC5D,OAAO,sBAAsB,MAAM,0BAA0B,CAAC;AAC9D,OAAO,wBAAwB,MAAM,4BAA4B,CAAC;AAClE,OAAO,yBAAyB,MAAM,6BAA6B,CAAC;AACpE,OAAO,eAAe,EAAE,EAAE,KAAK,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEvE,OAAO,EACL,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EAClB,qBAAqB,EACrB,sBAAsB,EACtB,wBAAwB,EACxB,yBAAyB,GAC1B,CAAC;AAEF,YAAY,EACV,YAAY,GACb,CAAC"}

package/dist/src/Table/helpers/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.filterConditionExpression = exports.buildConditionExpression = exports.buildQueryCommandInput = exports.buildUpdateExpression = exports.getRawClientConfig = exports.buildTableSchema = exports.getTableOptions = void 0;
+const buildTableSchema_1 = __importDefault(require("./buildTableSchema"));
+exports.buildTableSchema = buildTableSchema_1.default;
+const getRawClientConfig_1 = __importDefault(require("./getRawClientConfig"));
+exports.getRawClientConfig = getRawClientConfig_1.default;
+const buildUpdateExpression_1 = __importDefault(require("./buildUpdateExpression"));
+exports.buildUpdateExpression = buildUpdateExpression_1.default;
+const buildQueryCommandInput_1 = __importDefault(require("./buildQueryCommandInput"));
+exports.buildQueryCommandInput = buildQueryCommandInput_1.default;
+const buildConditionExpression_1 = __importDefault(require("./buildConditionExpression"));
+exports.buildConditionExpression = buildConditionExpression_1.default;
+const filterConditionExpression_1 = __importDefault(require("./filterConditionExpression"));
+exports.filterConditionExpression = filterConditionExpression_1.default;
+const getTableOptions_1 = __importDefault(require("./getTableOptions"));
+exports.getTableOptions = getTableOptions_1.default;
+//# sourceMappingURL=index.js.map

package/dist/src/Table/helpers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/Table/helpers/index.ts"],"names":[],"mappings":";;;;;;AAAA,0EAAkD;AAUhD,2BAVK,0BAAgB,CAUL;AATlB,8EAAsD;AAUpD,6BAVK,4BAAkB,CAUL;AATpB,oFAA4D;AAU1D,gCAVK,+BAAqB,CAUL;AATvB,sFAA8D;AAU5D,iCAVK,gCAAsB,CAUL;AATxB,0FAAkE;AAUhE,mCAVK,kCAAwB,CAUL;AAT1B,4FAAoE;AAUlE,oCAVK,mCAAyB,CAUL;AAT3B,wEAAuE;AAGrE,0BAHK,yBAAe,CAGL"}

package/dist/src/Table/index.d.ts

@@ -0,0 +1,8 @@
+import { ExpressionKey } from './helpers/buildConditionExpression';
+import { SortExpressionKey } from './helpers/buildQueryConditionExpression';
+import Table, { type ItemAttributes } from './Table';
+import type { TableOptions, LocalIndexKeyComposer, GlobalIndexKeyComposer } from './helpers/getTableOptions';
+export default Table;
+export { ExpressionKey, SortExpressionKey, };
+export type { TableOptions, ItemAttributes, LocalIndexKeyComposer, GlobalIndexKeyComposer };
+//# sourceMappingURL=index.d.ts.map

package/dist/src/Table/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Table/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAC;AACnE,OAAO,EAAE,iBAAiB,EAAE,MAAM,yCAAyC,CAAC;AAC5E,OAAO,KAAK,EAAE,EAAE,KAAK,cAAc,EAAE,MAAM,SAAS,CAAC;AACrD,OAAO,KAAK,EAAE,YAAY,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAC;AAE7G,eAAe,KAAK,CAAC;AAErB,OAAO,EACL,aAAa,EACb,iBAAiB,GAClB,CAAC;AAEF,YAAY,EACV,YAAY,EACZ,cAAc,EACd,qBAAqB,EACrB,sBAAsB,EACvB,CAAC"}

package/dist/src/Table/index.js

@@ -0,0 +1,13 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SortExpressionKey = exports.ExpressionKey = void 0;
+const buildConditionExpression_1 = require("./helpers/buildConditionExpression");
+Object.defineProperty(exports, "ExpressionKey", { enumerable: true, get: function () { return buildConditionExpression_1.ExpressionKey; } });
+const buildQueryConditionExpression_1 = require("./helpers/buildQueryConditionExpression");
+Object.defineProperty(exports, "SortExpressionKey", { enumerable: true, get: function () { return buildQueryConditionExpression_1.SortExpressionKey; } });
+const Table_1 = __importDefault(require("./Table"));
+exports.default = Table_1.default;
+//# sourceMappingURL=index.js.map

package/dist/src/Table/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Table/index.ts"],"names":[],"mappings":";;;;;;AAAA,iFAAmE;AAQjE,8FARO,wCAAa,OAQP;AAPf,2FAA4E;AAQ1E,kGARO,iDAAiB,OAQP;AAPnB,oDAAqD;AAGrD,kBAAe,eAAK,CAAC"}

package/dist/src/index.d.ts

@@ -0,0 +1,7 @@
+import Document from './Document/Document';
+import DocumentWithHashId from './Document/DocumentWithHashId';
+import type { DefaultAttributes } from './Document/DefaultAttributes';
+import { ExpressionKey, SortExpressionKey } from './Table';
+export { Document, ExpressionKey, SortExpressionKey, DocumentWithHashId, };
+export type { DefaultAttributes, };
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,qBAAqB,CAAC;AAC3C,OAAO,kBAAkB,MAAM,+BAA+B,CAAC;AAC/D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACtE,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAE3D,OAAO,EACL,QAAQ,EACR,aAAa,EACb,iBAAiB,EACjB,kBAAkB,GACnB,CAAC;AAEF,YAAY,EACV,iBAAiB,GAClB,CAAC"}

package/dist/src/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentWithHashId = exports.SortExpressionKey = exports.ExpressionKey = exports.Document = void 0;
+const Document_1 = __importDefault(require("./Document/Document"));
+exports.Document = Document_1.default;
+const DocumentWithHashId_1 = __importDefault(require("./Document/DocumentWithHashId"));
+exports.DocumentWithHashId = DocumentWithHashId_1.default;
+const Table_1 = require("./Table");
+Object.defineProperty(exports, "ExpressionKey", { enumerable: true, get: function () { return Table_1.ExpressionKey; } });
+Object.defineProperty(exports, "SortExpressionKey", { enumerable: true, get: function () { return Table_1.SortExpressionKey; } });
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,mEAA2C;AAMzC,mBANK,kBAAQ,CAML;AALV,uFAA+D;AAQ7D,6BARK,4BAAkB,CAQL;AANpB,mCAA2D;AAIzD,8FAJO,qBAAa,OAIP;AACb,kGALsB,yBAAiB,OAKtB"}

package/docker-compose.yaml

@@ -0,0 +1,10 @@
+networks:
+  main:
+services:
+  dynamo:
+    image: amazon/dynamodb-local:latest
+    container_name: dynamo
+    ports:
+      - "8000:8000"
+    networks:
+      main:

package/eslint.config.mjs

@@ -0,0 +1,35 @@
+import jsdoc from 'eslint-plugin-jsdoc';
+import eslint from '@eslint/js';
+import globals from 'globals';
+import tseslint from 'typescript-eslint';
+import { globalIgnores } from 'eslint/config';
+
+export default tseslint.config(
+  globalIgnores([ '**/dist/', '**/coverage/' ]),
+  {
+    languageOptions: {
+      globals: {
+        ...globals.node,
+      },
+    },
+    plugins: {
+      jsdoc,
+    },
+    rules: {
+      semi: ['error', 'always'],
+      quotes: ['error', 'single'],
+      'jsdoc/require-jsdoc': ['error', {
+        require: {
+          ArrowFunctionExpression: true,
+          ClassDeclaration: true,
+          ClassExpression: true,
+          FunctionDeclaration: true,
+          FunctionExpression: true,
+          MethodDefinition: true,
+        },
+      }],
+    }
+  },
+  eslint.configs.recommended,
+  tseslint.configs.recommended
+);

package/example/Activity.ts

@@ -0,0 +1,123 @@
+import { Document, SortExpressionKey } from '../src';
+import { schema, type ActivityAttributes } from './ActivityAttributes';
+import { got, type Context, type IndexOptions } from '@kravc/dos';
+
+/** Activity document class. */
+class Activity extends Document<ActivityAttributes> {
+  /** Returns index query and index name for parameters. */
+  static _getIndexQueryProps(
+    context: Context,
+    query: {
+      userId?: string;
+      endDate?: string;
+      startDate?: string;
+      operationId?: string;
+      [x: string]: unknown;
+    },
+  ) {
+    const {
+      userId,
+      endDate,
+      startDate,
+      operationId,
+      ...filterQuery
+    } = query;
+
+    /** Returns query for a global secondary index. */
+    const getGlobalIndexQuery = (indexName: string, partitionScope: string) => {
+      const {
+        sortKeyName,
+        partitionKeyName,
+      } = this.getGlobalIndexProps(indexName);
+
+      const indexQuery = {} as Record<string, string>;
+
+      const organizationId = got(context.identity, 'organizationId');
+      indexQuery[partitionKeyName] = `${organizationId}#${partitionScope}`;
+
+      if (startDate) {
+        indexQuery[`${sortKeyName}:${SortExpressionKey.GE}`] = `#${startDate}T00:00:00.000Z`;
+      }
+
+      if (endDate) {
+        indexQuery[`${sortKeyName}:${SortExpressionKey.LE}`] = `#${endDate}T23:59:99.999Z`;
+      }
+
+      return indexQuery;
+    };
+
+    if (userId) {
+      const indexName = 'gsi1';
+      const indexQuery = getGlobalIndexQuery(indexName, userId);
+
+      return { indexName, indexQuery: { ...indexQuery, ...filterQuery } };
+    }
+
+    if (operationId) {
+      const indexName = 'gsi2';
+      const indexQuery = getGlobalIndexQuery(indexName, operationId);
+
+      return { indexName, indexQuery: { ...indexQuery, ...filterQuery } };
+    }
+
+    const {
+      indexName,
+      sortKeyName
+    } = this.getLocalIndexProps('lsi3');
+
+    const indexQuery = {} as Record<string, string>;
+
+    if (startDate) {
+      indexQuery[`${sortKeyName}:${SortExpressionKey.GE}`] = `#${startDate}T00:00:00.000Z`;
+    }
+
+    if (endDate) {
+      indexQuery[`${sortKeyName}:${SortExpressionKey.LE}`] = `#${endDate}T23:59:99.999Z`;
+    }
+
+    return { indexName, indexQuery: { ...indexQuery, ...filterQuery } };
+  }
+
+  /** Returns activities. */
+  static async indexWithDateRange(
+    context: Context,
+    query: {
+      userId?: string;
+      endDate?: string;
+      startDate?: string;
+      operationId?: string;
+      [x: string]: unknown;
+    } = {},
+    options: IndexOptions = {}
+  ) {
+    const {
+      userId,
+      endDate,
+      startDate,
+      operationId,
+    } = query;
+
+    if (userId) {
+      const { indexQuery, indexName } = this._getIndexQueryProps(context, query);
+      return this.index(context, indexQuery, { ...options, indexName });
+    }
+
+    if (operationId) {
+      const { indexQuery, indexName } = this._getIndexQueryProps(context, query);
+      return this.index(context, indexQuery, { ...options, indexName });
+    }
+
+    const hasDateRange = !!startDate || !!endDate;
+
+    if (hasDateRange) {
+      const { indexQuery, indexName } = this._getIndexQueryProps(context, query);
+      return this.index(context, indexQuery, { ...options, indexName });
+    }
+
+    return this.index(context, query, options);
+  }
+}
+
+Activity.schema = schema;
+
+export default Activity;

package/example/ActivityAttributes.ts

@@ -0,0 +1,72 @@
+import { Schema } from '@kravc/schema';
+import { DefaultAttributes } from '../src';
+
+type Identity = {
+  sub: string;
+  email: string;
+  firstName: string;
+  lastName: string;
+  permissions: string[];
+}
+
+export interface ActivityAttributes extends DefaultAttributes {
+  operationId: string;
+  summaryTemplate: string;
+  parametersJson?: string;
+  resultDocumentJson?: string;
+  userId: string;
+  traceId: string;
+  userAgent: string;
+  ipAddress: string;
+  identity?: Identity
+}
+
+export const schema = new Schema({
+  operationId: {
+    required: true
+  },
+  summaryTemplate: {
+    required: true
+  },
+  parametersJson: {
+    type: 'string',
+  },
+  resultDocumentJson: {
+    type: 'string',
+  },
+  userId: {
+    required: true
+  },
+  traceId: {
+    required: true
+  },
+  userAgent: {
+    required: true
+  },
+  ipAddress: {
+    required: true
+  },
+  identity: {
+    type: 'object',
+    properties: {
+      sub: {
+        required: true
+      },
+      email: {
+        required: true
+      },
+      firstName: {
+        required: true
+      },
+      lastName: {
+        required: true
+      },
+      permissions: {
+        required: true,
+        items: {
+          type: 'string'
+        },
+      }
+    }
+  }
+}, 'ActivityBody');

package/example/Asset.ts

@@ -0,0 +1,78 @@
+import { type AssetAttributes, AssetStatus, schema } from './AssetAttributes';
+import { Document, ExpressionKey, SortExpressionKey } from '../src';
+import { got, type Context, type QueryMap, type IndexOptions } from '@kravc/dos';
+
+/** Asset document class. */
+class Asset extends Document<AssetAttributes> {
+  /** Returns props for an index query. */
+  static _getIndexQueryProps(
+    context: Context,
+    query: {
+      createdBy?: string;
+      [x: string]: unknown;
+    },
+    status: AssetStatus
+  ) {
+    const indexQuery = {} as Record<string, string>;
+
+    let indexName = 'lsi2';
+    let sortKeyName = this.getLocalIndexSortKeyName(indexName);
+
+    const { createdBy, ...filterQuery } = query;
+
+    if (createdBy) {
+      indexName = 'gsi1';
+      sortKeyName = this.getGlobalIndexSortKeyName(indexName);
+
+      const organizationId = got(context.identity, 'organizationId');
+      const partitionKeyName = this.getGlobalIndexPartitionKeyName(indexName);
+
+      indexQuery[partitionKeyName] = `${organizationId}#${createdBy}`;
+    }
+
+    indexQuery[`${sortKeyName}:${SortExpressionKey.BW}`] = `#${status}`;
+
+    return {
+      indexQuery: { ...indexQuery, ...filterQuery },
+      indexName,
+    };
+  }
+
+  /** Returns active assets. */
+  static async indexActiveAssets(context: Context, query: QueryMap = {}, options: IndexOptions = {}) {
+    const { indexQuery, indexName } = this._getIndexQueryProps(context, query, AssetStatus.ACTIVE);
+    return this.index(context, indexQuery, { ...options, indexName });
+  }
+
+  /** Returns archived assets. */
+  static async indexArchivedAssets(context: Context, query: QueryMap = {}, options: IndexOptions = {}) {
+    const { indexQuery, indexName } = this._getIndexQueryProps(context, query, AssetStatus.ARCHIVED);
+    return this.index(context, indexQuery, { ...options, indexName });
+  }
+
+  /** Archives an asset. */
+  static async archive(context: Context, query: QueryMap) {
+    query[`status:${ExpressionKey.NOT}`] = AssetStatus.ARCHIVED;
+
+    const mutation = {
+      status: AssetStatus.ARCHIVED,
+    };
+
+    return this.update(context, query, mutation);
+  }
+
+  /** Unarchives the asset. */
+  static async unarchive(context: Context, query: QueryMap) {
+    query[`status:${ExpressionKey.NOT}`] = AssetStatus.ACTIVE;
+
+    const mutation = {
+      status: AssetStatus.ACTIVE,
+    };
+
+    return this.update(context, query, mutation);
+  }
+}
+
+Asset.schema = schema;
+
+export default Asset;

package/example/AssetAttributes.ts

@@ -0,0 +1,87 @@
+import { Schema } from '@kravc/schema';
+import { DefaultAttributes } from '../src';
+
+export enum AssetType {
+  FILE = 'FILE',
+  CONTENT = 'CONTENT'
+}
+
+export enum AssetStatus {
+  ACTIVE = 'ACTIVE',
+  ARCHIVED = 'ARCHIVED'
+}
+
+export interface AssetAttributes extends DefaultAttributes {
+  name: string;
+  tags: string[];
+  folderId?: string;
+  type: AssetType;
+  status: AssetStatus;
+  content?: string;
+  file?: {
+    url: string;
+    size: number;
+    name: string;
+    mimeType: string;
+    lastModifiedAt: string;
+    thumbnailUrl?: string;
+  }
+}
+
+export const schema = new Schema({
+  name: {
+    required: true
+  },
+  tags: {
+    items: {
+      type: 'string',
+    },
+    required: true
+  },
+  folderId: {
+    type: 'string',
+  },
+  thumbnailUrl: {
+    type: 'string',
+    format: 'url',
+  },
+  type: {
+    enum: [ AssetType.FILE, AssetType.CONTENT ],
+    required: true,
+  },
+  status: {
+    enum: [ AssetStatus.ACTIVE, AssetStatus.ARCHIVED ],
+    required: true,
+  },
+  content: {
+    type: 'string'
+  },
+  file: {
+    type: 'object',
+    properties: {
+      url: {
+        type: 'string',
+        format: 'url',
+        required: true,
+      },
+      size: {
+        type: 'integer',
+        min: 0,
+        required: true,
+      },
+      name: {
+        type: 'string',
+        required: true,
+      },
+      mimeType: {
+        type: 'string',
+        required: true,
+      },
+      lastModifiedAt: {
+        type: 'string',
+        format: 'date-time',
+        required: true,
+      },
+    }
+  }
+}, 'AssetBody');