@webiny/db-dynamodb 0.0.0-mt-2 → 0.0.0-unstable.06b2ede40f

package/utils/entity/index.js

@@ -0,0 +1,84 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _Entity = require("./Entity");
+Object.keys(_Entity).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _Entity[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _Entity[key];
+    }
+  });
+});
+var _EntityReadBatch = require("./EntityReadBatch");
+Object.keys(_EntityReadBatch).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _EntityReadBatch[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _EntityReadBatch[key];
+    }
+  });
+});
+var _EntityReadBatchBuilder = require("./EntityReadBatchBuilder");
+Object.keys(_EntityReadBatchBuilder).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _EntityReadBatchBuilder[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _EntityReadBatchBuilder[key];
+    }
+  });
+});
+var _EntityWriteBatch = require("./EntityWriteBatch");
+Object.keys(_EntityWriteBatch).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _EntityWriteBatch[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _EntityWriteBatch[key];
+    }
+  });
+});
+var _EntityWriteBatchBuilder = require("./EntityWriteBatchBuilder");
+Object.keys(_EntityWriteBatchBuilder).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _EntityWriteBatchBuilder[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _EntityWriteBatchBuilder[key];
+    }
+  });
+});
+var _getEntity = require("./getEntity");
+Object.keys(_getEntity).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _getEntity[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _getEntity[key];
+    }
+  });
+});
+var _types = require("./types");
+Object.keys(_types).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _types[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _types[key];
+    }
+  });
+});
+
+//# sourceMappingURL=index.js.map

package/utils/entity/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_Entity","require","Object","keys","forEach","key","exports","defineProperty","enumerable","get","_EntityReadBatch","_EntityReadBatchBuilder","_EntityWriteBatch","_EntityWriteBatchBuilder","_getEntity","_types"],"sources":["index.ts"],"sourcesContent":["export * from \"./Entity\";\nexport * from \"./EntityReadBatch\";\nexport * from \"./EntityReadBatchBuilder\";\nexport * from \"./EntityWriteBatch\";\nexport * from \"./EntityWriteBatchBuilder\";\nexport * from \"./getEntity\";\nexport * from \"./types\";\n"],"mappings":";;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAH,OAAA,EAAAI,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAL,OAAA,CAAAK,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAT,OAAA,CAAAK,GAAA;IAAA;EAAA;AAAA;AACA,IAAAK,gBAAA,GAAAT,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAO,gBAAA,EAAAN,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAK,gBAAA,CAAAL,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAC,gBAAA,CAAAL,GAAA;IAAA;EAAA;AAAA;AACA,IAAAM,uBAAA,GAAAV,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAQ,uBAAA,EAAAP,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAM,uBAAA,CAAAN,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAE,uBAAA,CAAAN,GAAA;IAAA;EAAA;AAAA;AACA,IAAAO,iBAAA,GAAAX,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAS,iBAAA,EAAAR,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAO,iBAAA,CAAAP,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAG,iBAAA,CAAAP,GAAA;IAAA;EAAA;AAAA;AACA,IAAAQ,wBAAA,GAAAZ,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAU,wBAAA,EAAAT,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAQ,wBAAA,CAAAR,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAI,wBAAA,CAAAR,GAAA;IAAA;EAAA;AAAA;AACA,IAAAS,UAAA,GAAAb,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAW,UAAA,EAAAV,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAS,UAAA,CAAAT,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAK,UAAA,CAAAT,GAAA;IAAA;EAAA;AAAA;AACA,IAAAU,MAAA,GAAAd,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAY,MAAA,EAAAX,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAU,MAAA,CAAAV,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAM,MAAA,CAAAV,GAAA;IAAA;EAAA;AAAA","ignoreList":[]}

package/utils/entity/types.d.ts

@@ -0,0 +1,51 @@
+import type { Entity as BaseEntity } from "dynamodb-toolbox";
+import type { BatchWriteItem, BatchWriteResult, IDeleteBatchItem, IPutBatchItem } from "../batch/types";
+import type { GenericRecord } from "@webiny/api/types";
+import type { TableDef } from "../../toolbox";
+import type { ITableWriteBatch } from "../table/types";
+import type { IPutParamsItem, put } from "../put";
+import type { QueryAllParams, QueryOneParams } from "../query";
+import type { get, getClean, GetRecordParamsKeys } from "../get";
+import type { deleteItem, IDeleteItemKeys } from "../delete";
+import type { batchReadAll } from "../batch/batchRead";
+export type IEntityQueryOneParams = Omit<QueryOneParams, "entity">;
+export type IEntityQueryAllParams = Omit<QueryAllParams, "entity">;
+export interface IEntity {
+    readonly entity: BaseEntity;
+    createEntityReader(): IEntityReadBatch;
+    createEntityWriter(): IEntityWriteBatch;
+    createTableWriter(): ITableWriteBatch;
+    put<T extends GenericRecord = GenericRecord>(item: IPutParamsItem<T>): ReturnType<typeof put>;
+    get<T>(keys: GetRecordParamsKeys): ReturnType<typeof get<T>>;
+    getClean<T>(keys: GetRecordParamsKeys): ReturnType<typeof getClean<T>>;
+    delete(keys: IDeleteItemKeys): ReturnType<typeof deleteItem>;
+    queryOne<T>(params: IEntityQueryOneParams): Promise<T | null>;
+    queryAll<T>(params: IEntityQueryAllParams): Promise<T[]>;
+}
+export interface IEntityWriteBatchBuilder {
+    put<T extends Record<string, any>>(item: IPutBatchItem<T>): BatchWriteItem;
+    delete(item: IDeleteBatchItem): BatchWriteItem;
+}
+export interface IEntityWriteBatch {
+    readonly total: number;
+    readonly items: BatchWriteItem[];
+    put(item: IPutBatchItem): void;
+    delete(item: IDeleteBatchItem): void;
+    execute(): Promise<BatchWriteResult>;
+    combine(items: BatchWriteItem[]): ITableWriteBatch;
+}
+export interface IEntityReadBatchKey {
+    PK: string;
+    SK: string;
+}
+export interface IEntityReadBatch {
+    get(input: IEntityReadBatchKey | IEntityReadBatchKey[]): void;
+    execute<T = GenericRecord>(): ReturnType<typeof batchReadAll<T>>;
+}
+export interface IEntityReadBatchBuilderGetResponse {
+    Table: TableDef;
+    Key: IEntityReadBatchKey;
+}
+export interface IEntityReadBatchBuilder {
+    get(item: IEntityReadBatchKey): IEntityReadBatchBuilderGetResponse;
+}

package/utils/entity/types.js

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

package/utils/entity/types.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["types.ts"],"sourcesContent":["import type { Entity as BaseEntity } from \"dynamodb-toolbox\";\nimport type {\n    BatchWriteItem,\n    BatchWriteResult,\n    IDeleteBatchItem,\n    IPutBatchItem\n} from \"~/utils/batch/types\";\nimport type { GenericRecord } from \"@webiny/api/types\";\nimport type { TableDef } from \"~/toolbox\";\nimport type { ITableWriteBatch } from \"~/utils/table/types\";\nimport type { IPutParamsItem, put } from \"~/utils/put\";\nimport type { QueryAllParams, QueryOneParams } from \"~/utils/query\";\nimport type { get, getClean, GetRecordParamsKeys } from \"~/utils/get\";\nimport type { deleteItem, IDeleteItemKeys } from \"~/utils/delete\";\nimport type { batchReadAll } from \"~/utils/batch/batchRead\";\n\nexport type IEntityQueryOneParams = Omit<QueryOneParams, \"entity\">;\n\nexport type IEntityQueryAllParams = Omit<QueryAllParams, \"entity\">;\n\nexport interface IEntity {\n    readonly entity: BaseEntity;\n    createEntityReader(): IEntityReadBatch;\n    createEntityWriter(): IEntityWriteBatch;\n    createTableWriter(): ITableWriteBatch;\n    put<T extends GenericRecord = GenericRecord>(item: IPutParamsItem<T>): ReturnType<typeof put>;\n    get<T>(keys: GetRecordParamsKeys): ReturnType<typeof get<T>>;\n    getClean<T>(keys: GetRecordParamsKeys): ReturnType<typeof getClean<T>>;\n    delete(keys: IDeleteItemKeys): ReturnType<typeof deleteItem>;\n    queryOne<T>(params: IEntityQueryOneParams): Promise<T | null>;\n    queryAll<T>(params: IEntityQueryAllParams): Promise<T[]>;\n}\n\nexport interface IEntityWriteBatchBuilder {\n    // readonly entity: Entity;\n    put<T extends Record<string, any>>(item: IPutBatchItem<T>): BatchWriteItem;\n    delete(item: IDeleteBatchItem): BatchWriteItem;\n}\n\nexport interface IEntityWriteBatch {\n    readonly total: number;\n    // readonly entity: Entity;\n    readonly items: BatchWriteItem[];\n    // readonly builder: IEntityWriteBatchBuilder;\n\n    put(item: IPutBatchItem): void;\n    delete(item: IDeleteBatchItem): void;\n    execute(): Promise<BatchWriteResult>;\n    combine(items: BatchWriteItem[]): ITableWriteBatch;\n}\n\nexport interface IEntityReadBatchKey {\n    PK: string;\n    SK: string;\n}\n\nexport interface IEntityReadBatch {\n    get(input: IEntityReadBatchKey | IEntityReadBatchKey[]): void;\n    execute<T = GenericRecord>(): ReturnType<typeof batchReadAll<T>>;\n}\n\nexport interface IEntityReadBatchBuilderGetResponse {\n    Table: TableDef;\n    Key: IEntityReadBatchKey;\n}\n\nexport interface IEntityReadBatchBuilder {\n    get(item: IEntityReadBatchKey): IEntityReadBatchBuilderGetResponse;\n}\n"],"mappings":"","ignoreList":[]}

package/utils/filter.d.ts

@@ -1,6 +1,6 @@
-import { PluginsContainer } from "@webiny/plugins";
-import { FieldPlugin } from "../plugins/definitions/FieldPlugin";
-export interface Params<T extends any = any> {
+import type { PluginsContainer } from "@webiny/plugins";
+import type { FieldPlugin } from "../plugins/definitions/FieldPlugin";
+export interface Params<T = any> {
     plugins: PluginsContainer;
     items: T[];
     where: Record<string, any>;
@@ -9,4 +9,4 @@ export interface Params<T extends any = any> {
      */
     fields: FieldPlugin[];
 }
-export declare const filterItems: <T extends unknown = any>(params: Params<T>) => T[];
+export declare function filterItems<T = any>(params: Params<T>): T[];

package/utils/filter.js

@@ -1,26 +1,23 @@
 "use strict";
 
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.filterItems = void 0;
-
+exports.filterItems = filterItems;
 var _dotProp = _interopRequireDefault(require("dot-prop"));
-
 var _error = _interopRequireDefault(require("@webiny/error"));
-
 var _ValueFilterPlugin = require("../plugins/definitions/ValueFilterPlugin");
-
 const getMappedPlugins = params => {
   return params.plugins.byType(params.type).reduce((plugins, plugin) => {
+    /**
+     * We expect op to be a string, that is why we cast.
+     */
     const op = plugin[params.property];
     plugins[op] = plugin;
     return plugins;
   }, {});
 };
-
 const extractWhereArgs = key => {
   const result = key.split("_");
   const field = result.shift();
@@ -28,7 +25,6 @@ const extractWhereArgs = key => {
   /**
    * When rawOp is not, it means it is equal negated so just return that.
    */
-
   if (rawOp === "not") {
     return {
       field,
@@ -36,7 +32,6 @@ const extractWhereArgs = key => {
       negate: true
     };
   }
-
   const negate = rawOp.match("not_") !== null;
   const operation = rawOp.replace("not_", "");
   return {
@@ -45,19 +40,15 @@ const extractWhereArgs = key => {
     negate
   };
 };
-
 const findFilterPlugin = (plugins, operation) => {
   if (plugins[operation]) {
     return plugins[operation];
   }
-
   throw new _error.default(`Missing filter plugin definition.`, "FILTER_PLUGIN_ERROR", {
     operation
   });
 };
-
 const multiSearchFieldOperations = ["contains", "fuzzy"];
-
 const createFilters = params => {
   const {
     plugins,
@@ -68,11 +59,9 @@ const createFilters = params => {
   /**
    * Skip everything if there are no conditions to be applied.
    */
-
   if (keys.length === 0) {
     return [];
   }
-
   const filterPlugins = getMappedPlugins({
     plugins,
     type: _ValueFilterPlugin.ValueFilterPlugin.type,
@@ -80,41 +69,36 @@ const createFilters = params => {
   });
   return keys.reduce((filters, key) => {
     const compareValue = where[key];
-
     if (compareValue === undefined) {
       return filters;
     }
     /**
      * @see DynamoDbContainsFilter
      */
-
-
     if (multiSearchFieldOperations.includes(key) === true) {
       const data = compareValue;
       let transformValue = undefined;
       const paths = data.fields.map(field => {
         const fieldPlugin = fields.find(plugin => plugin.getField() === field);
-
         if (fieldPlugin) {
           transformValue = value => {
             return fieldPlugin.transformValue(value);
           };
-
           return fieldPlugin.getPath();
         }
-
         return field;
       });
+      const filterPlugin = findFilterPlugin(filterPlugins, key);
       filters.push({
+        operation: filterPlugin.operation,
         compareValue: data.value,
-        filterPlugin: findFilterPlugin(filterPlugins, key),
+        filterPlugin,
         transformValue,
         paths,
         negate: false
       });
       return filters;
     }
-
     const {
       field,
       operation,
@@ -124,16 +108,14 @@ const createFilters = params => {
     const fieldPlugin = fields.find(plugin => plugin.getField() === field);
     let path = field;
     let transformValue = undefined;
-
     if (fieldPlugin) {
       transformValue = value => {
         return fieldPlugin.transformValue(value);
       };
-
       path = fieldPlugin.getPath();
     }
-
     filters.push({
+      operation: filterPlugin.operation,
       compareValue,
       filterPlugin,
       transformValue,
@@ -146,35 +128,27 @@ const createFilters = params => {
 /**
  * Transforms the value with given transformer callable.
  */
-
-
 const transform = (value, transformValue) => {
   if (!transformValue) {
     return value;
   }
-
   if (Array.isArray(value)) {
     return value.map(v => transformValue(v));
   }
-
   return transformValue(value);
 };
 /**
  * Creates a filter callable that we can send to the .filter() method of the array.
  */
-
-
 const createFilterCallable = params => {
   const filters = createFilters(params);
   /**
    * Just return null so there are no filters to be applied.
    * Later in the code we check for null so we do not loop through the items.
    */
-
   if (filters.length === 0) {
     return null;
   }
-
   return item => {
     for (const filter of filters) {
       const result = filter.paths.some(path => {
@@ -186,27 +160,22 @@ const createFilterCallable = params => {
         });
         return filter.negate ? !matched : matched;
       });
-
       if (result === false) {
         return false;
       }
     }
-
     return true;
   };
 };
-
-const filterItems = params => {
+function filterItems(params) {
   const filter = createFilterCallable(params);
   /**
    * No point in going through all the items when there are no filters to be applied.
    */
-
   if (!filter) {
     return params.items;
   }
-
   return params.items.filter(filter);
-};
+}
 
-exports.filterItems = filterItems;
+//# sourceMappingURL=filter.js.map

package/utils/filter.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_dotProp","_interopRequireDefault","require","_error","_ValueFilterPlugin","getMappedPlugins","params","plugins","byType","type","reduce","plugin","op","property","extractWhereArgs","key","result","split","field","shift","rawOp","length","join","operation","negate","match","replace","findFilterPlugin","WebinyError","multiSearchFieldOperations","createFilters","where","fields","keys","Object","filterPlugins","ValueFilterPlugin","filters","compareValue","undefined","includes","data","transformValue","paths","map","fieldPlugin","find","getField","value","getPath","filterPlugin","push","path","transform","Array","isArray","v","createFilterCallable","item","filter","some","dotProp","get","matched","matches","filterItems","items"],"sources":["filter.ts"],"sourcesContent":["import dotProp from \"dot-prop\";\nimport WebinyError from \"@webiny/error\";\nimport type { Plugin, PluginsContainer } from \"@webiny/plugins\";\nimport { ValueFilterPlugin } from \"~/plugins/definitions/ValueFilterPlugin\";\nimport type { FieldPlugin } from \"~/plugins/definitions/FieldPlugin\";\nimport type { DynamoDbContainsFilter } from \"~/types\";\n\ntype TransformValue = (value: any) => any;\n\nexport interface Params<T = any> {\n    plugins: PluginsContainer;\n    items: T[];\n    where: Record<string, any>;\n    /**\n     * An array of fields that require some special operation.\n     */\n    fields: FieldPlugin[];\n}\n\ninterface MappedPluginParams<T extends Plugin = Plugin> {\n    plugins: PluginsContainer;\n    type: string;\n    property: keyof T;\n}\n\ninterface Filter {\n    operation: string;\n    compareValue: any;\n    filterPlugin: ValueFilterPlugin;\n    transformValue?: TransformValue;\n    paths: string[];\n    negate: boolean;\n}\n\nconst getMappedPlugins = <T extends Plugin>(params: MappedPluginParams<T>): Record<string, T> => {\n    return params.plugins.byType<T>(params.type).reduce((plugins, plugin) => {\n        /**\n         * We expect op to be a string, that is why we cast.\n         */\n        const op = plugin[params.property] as unknown as string;\n        plugins[op] = plugin;\n        return plugins;\n    }, {} as Record<string, T>);\n};\n\ninterface ExtractWhereArgsResult {\n    field: string;\n    operation: string;\n    negate: boolean;\n}\nconst extractWhereArgs = (key: string): ExtractWhereArgsResult => {\n    const result = key.split(\"_\");\n    const field = result.shift() as string;\n    const rawOp = result.length === 0 ? \"eq\" : result.join(\"_\");\n    /**\n     * When rawOp is not, it means it is equal negated so just return that.\n     */\n    if (rawOp === \"not\") {\n        return {\n            field,\n            operation: \"eq\",\n            negate: true\n        };\n    }\n    const negate = rawOp.match(\"not_\") !== null;\n    const operation = rawOp.replace(\"not_\", \"\");\n    return {\n        field,\n        operation,\n        negate\n    };\n};\n\nconst findFilterPlugin = (\n    plugins: Record<string, ValueFilterPlugin>,\n    operation: string\n): ValueFilterPlugin => {\n    if (plugins[operation]) {\n        return plugins[operation];\n    }\n    throw new WebinyError(`Missing filter plugin definition.`, \"FILTER_PLUGIN_ERROR\", {\n        operation\n    });\n};\n\nconst multiSearchFieldOperations = [\"contains\", \"fuzzy\"];\n\nconst createFilters = (params: Omit<Params, \"items\">): Filter[] => {\n    const { plugins, where, fields } = params;\n\n    const keys = Object.keys(where);\n    /**\n     * Skip everything if there are no conditions to be applied.\n     */\n    if (keys.length === 0) {\n        return [];\n    }\n    const filterPlugins = getMappedPlugins<ValueFilterPlugin>({\n        plugins,\n        type: ValueFilterPlugin.type,\n        property: \"operation\"\n    });\n\n    return keys.reduce((filters, key) => {\n        const compareValue = where[key];\n        if (compareValue === undefined) {\n            return filters;\n        }\n        /**\n         * @see DynamoDbContainsFilter\n         */\n        if (multiSearchFieldOperations.includes(key) === true) {\n            const data: DynamoDbContainsFilter = compareValue;\n            let transformValue: TransformValue | undefined = undefined;\n            const paths = data.fields.map(field => {\n                const fieldPlugin = fields.find(plugin => plugin.getField() === field);\n                if (fieldPlugin) {\n                    transformValue = (value: any) => {\n                        return fieldPlugin.transformValue(value);\n                    };\n                    return fieldPlugin.getPath();\n                }\n                return field;\n            });\n\n            const filterPlugin = findFilterPlugin(filterPlugins, key);\n            filters.push({\n                operation: filterPlugin.operation,\n                compareValue: data.value,\n                filterPlugin,\n                transformValue,\n                paths,\n                negate: false\n            });\n            return filters;\n        }\n\n        const { field, operation, negate } = extractWhereArgs(key);\n\n        const filterPlugin = findFilterPlugin(filterPlugins, operation);\n\n        const fieldPlugin = fields.find(plugin => plugin.getField() === field);\n        let path: string = field;\n        let transformValue: TransformValue | undefined = undefined;\n        if (fieldPlugin) {\n            transformValue = (value: any) => {\n                return fieldPlugin.transformValue(value);\n            };\n            path = fieldPlugin.getPath();\n        }\n\n        filters.push({\n            operation: filterPlugin.operation,\n            compareValue,\n            filterPlugin,\n            transformValue,\n            paths: [path],\n            negate\n        });\n\n        return filters;\n    }, [] as Filter[]);\n};\n/**\n * Transforms the value with given transformer callable.\n */\nconst transform = (value: any, transformValue?: TransformValue): any => {\n    if (!transformValue) {\n        return value;\n    }\n    if (Array.isArray(value)) {\n        return value.map(v => transformValue(v));\n    }\n    return transformValue(value);\n};\n/**\n * Creates a filter callable that we can send to the .filter() method of the array.\n */\nconst createFilterCallable = (params: Omit<Params, \"items\">): ((item: any) => boolean) | null => {\n    const filters = createFilters(params);\n    /**\n     * Just return null so there are no filters to be applied.\n     * Later in the code we check for null so we do not loop through the items.\n     */\n    if (filters.length === 0) {\n        return null;\n    }\n\n    return (item: any) => {\n        for (const filter of filters) {\n            const result = filter.paths.some(path => {\n                const value = transform(dotProp.get(item, path), filter.transformValue);\n                const compareValue = transform(filter.compareValue, filter.transformValue);\n                const matched = filter.filterPlugin.matches({\n                    value,\n                    compareValue\n                });\n\n                return filter.negate ? !matched : matched;\n            });\n            if (result === false) {\n                return false;\n            }\n        }\n        return true;\n    };\n};\n\nexport function filterItems<T = any>(params: Params<T>): T[] {\n    const filter = createFilterCallable(params);\n    /**\n     * No point in going through all the items when there are no filters to be applied.\n     */\n    if (!filter) {\n        return params.items;\n    }\n    return params.items.filter(filter);\n}\n"],"mappings":";;;;;;;AAAA,IAAAA,QAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,MAAA,GAAAF,sBAAA,CAAAC,OAAA;AAEA,IAAAE,kBAAA,GAAAF,OAAA;AA+BA,MAAMG,gBAAgB,GAAsBC,MAA6B,IAAwB;EAC7F,OAAOA,MAAM,CAACC,OAAO,CAACC,MAAM,CAAIF,MAAM,CAACG,IAAI,CAAC,CAACC,MAAM,CAAC,CAACH,OAAO,EAAEI,MAAM,KAAK;IACrE;AACR;AACA;IACQ,MAAMC,EAAE,GAAGD,MAAM,CAACL,MAAM,CAACO,QAAQ,CAAsB;IACvDN,OAAO,CAACK,EAAE,CAAC,GAAGD,MAAM;IACpB,OAAOJ,OAAO;EAClB,CAAC,EAAE,CAAC,CAAsB,CAAC;AAC/B,CAAC;AAOD,MAAMO,gBAAgB,GAAIC,GAAW,IAA6B;EAC9D,MAAMC,MAAM,GAAGD,GAAG,CAACE,KAAK,CAAC,GAAG,CAAC;EAC7B,MAAMC,KAAK,GAAGF,MAAM,CAACG,KAAK,CAAC,CAAW;EACtC,MAAMC,KAAK,GAAGJ,MAAM,CAACK,MAAM,KAAK,CAAC,GAAG,IAAI,GAAGL,MAAM,CAACM,IAAI,CAAC,GAAG,CAAC;EAC3D;AACJ;AACA;EACI,IAAIF,KAAK,KAAK,KAAK,EAAE;IACjB,OAAO;MACHF,KAAK;MACLK,SAAS,EAAE,IAAI;MACfC,MAAM,EAAE;IACZ,CAAC;EACL;EACA,MAAMA,MAAM,GAAGJ,KAAK,CAACK,KAAK,CAAC,MAAM,CAAC,KAAK,IAAI;EAC3C,MAAMF,SAAS,GAAGH,KAAK,CAACM,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;EAC3C,OAAO;IACHR,KAAK;IACLK,SAAS;IACTC;EACJ,CAAC;AACL,CAAC;AAED,MAAMG,gBAAgB,GAAGA,CACrBpB,OAA0C,EAC1CgB,SAAiB,KACG;EACpB,IAAIhB,OAAO,CAACgB,SAAS,CAAC,EAAE;IACpB,OAAOhB,OAAO,CAACgB,SAAS,CAAC;EAC7B;EACA,MAAM,IAAIK,cAAW,CAAC,mCAAmC,EAAE,qBAAqB,EAAE;IAC9EL;EACJ,CAAC,CAAC;AACN,CAAC;AAED,MAAMM,0BAA0B,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC;AAExD,MAAMC,aAAa,GAAIxB,MAA6B,IAAe;EAC/D,MAAM;IAAEC,OAAO;IAAEwB,KAAK;IAAEC;EAAO,CAAC,GAAG1B,MAAM;EAEzC,MAAM2B,IAAI,GAAGC,MAAM,CAACD,IAAI,CAACF,KAAK,CAAC;EAC/B;AACJ;AACA;EACI,IAAIE,IAAI,CAACZ,MAAM,KAAK,CAAC,EAAE;IACnB,OAAO,EAAE;EACb;EACA,MAAMc,aAAa,GAAG9B,gBAAgB,CAAoB;IACtDE,OAAO;IACPE,IAAI,EAAE2B,oCAAiB,CAAC3B,IAAI;IAC5BI,QAAQ,EAAE;EACd,CAAC,CAAC;EAEF,OAAOoB,IAAI,CAACvB,MAAM,CAAC,CAAC2B,OAAO,EAAEtB,GAAG,KAAK;IACjC,MAAMuB,YAAY,GAAGP,KAAK,CAAChB,GAAG,CAAC;IAC/B,IAAIuB,YAAY,KAAKC,SAAS,EAAE;MAC5B,OAAOF,OAAO;IAClB;IACA;AACR;AACA;IACQ,IAAIR,0BAA0B,CAACW,QAAQ,CAACzB,GAAG,CAAC,KAAK,IAAI,EAAE;MACnD,MAAM0B,IAA4B,GAAGH,YAAY;MACjD,IAAII,cAA0C,GAAGH,SAAS;MAC1D,MAAMI,KAAK,GAAGF,IAAI,CAACT,MAAM,CAACY,GAAG,CAAC1B,KAAK,IAAI;QACnC,MAAM2B,WAAW,GAAGb,MAAM,CAACc,IAAI,CAACnC,MAAM,IAAIA,MAAM,CAACoC,QAAQ,CAAC,CAAC,KAAK7B,KAAK,CAAC;QACtE,IAAI2B,WAAW,EAAE;UACbH,cAAc,GAAIM,KAAU,IAAK;YAC7B,OAAOH,WAAW,CAACH,cAAc,CAACM,KAAK,CAAC;UAC5C,CAAC;UACD,OAAOH,WAAW,CAACI,OAAO,CAAC,CAAC;QAChC;QACA,OAAO/B,KAAK;MAChB,CAAC,CAAC;MAEF,MAAMgC,YAAY,GAAGvB,gBAAgB,CAACQ,aAAa,EAAEpB,GAAG,CAAC;MACzDsB,OAAO,CAACc,IAAI,CAAC;QACT5B,SAAS,EAAE2B,YAAY,CAAC3B,SAAS;QACjCe,YAAY,EAAEG,IAAI,CAACO,KAAK;QACxBE,YAAY;QACZR,cAAc;QACdC,KAAK;QACLnB,MAAM,EAAE;MACZ,CAAC,CAAC;MACF,OAAOa,OAAO;IAClB;IAEA,MAAM;MAAEnB,KAAK;MAAEK,SAAS;MAAEC;IAAO,CAAC,GAAGV,gBAAgB,CAACC,GAAG,CAAC;IAE1D,MAAMmC,YAAY,GAAGvB,gBAAgB,CAACQ,aAAa,EAAEZ,SAAS,CAAC;IAE/D,MAAMsB,WAAW,GAAGb,MAAM,CAACc,IAAI,CAACnC,MAAM,IAAIA,MAAM,CAACoC,QAAQ,CAAC,CAAC,KAAK7B,KAAK,CAAC;IACtE,IAAIkC,IAAY,GAAGlC,KAAK;IACxB,IAAIwB,cAA0C,GAAGH,SAAS;IAC1D,IAAIM,WAAW,EAAE;MACbH,cAAc,GAAIM,KAAU,IAAK;QAC7B,OAAOH,WAAW,CAACH,cAAc,CAACM,KAAK,CAAC;MAC5C,CAAC;MACDI,IAAI,GAAGP,WAAW,CAACI,OAAO,CAAC,CAAC;IAChC;IAEAZ,OAAO,CAACc,IAAI,CAAC;MACT5B,SAAS,EAAE2B,YAAY,CAAC3B,SAAS;MACjCe,YAAY;MACZY,YAAY;MACZR,cAAc;MACdC,KAAK,EAAE,CAACS,IAAI,CAAC;MACb5B;IACJ,CAAC,CAAC;IAEF,OAAOa,OAAO;EAClB,CAAC,EAAE,EAAc,CAAC;AACtB,CAAC;AACD;AACA;AACA;AACA,MAAMgB,SAAS,GAAGA,CAACL,KAAU,EAAEN,cAA+B,KAAU;EACpE,IAAI,CAACA,cAAc,EAAE;IACjB,OAAOM,KAAK;EAChB;EACA,IAAIM,KAAK,CAACC,OAAO,CAACP,KAAK,CAAC,EAAE;IACtB,OAAOA,KAAK,CAACJ,GAAG,CAACY,CAAC,IAAId,cAAc,CAACc,CAAC,CAAC,CAAC;EAC5C;EACA,OAAOd,cAAc,CAACM,KAAK,CAAC;AAChC,CAAC;AACD;AACA;AACA;AACA,MAAMS,oBAAoB,GAAInD,MAA6B,IAAsC;EAC7F,MAAM+B,OAAO,GAAGP,aAAa,CAACxB,MAAM,CAAC;EACrC;AACJ;AACA;AACA;EACI,IAAI+B,OAAO,CAAChB,MAAM,KAAK,CAAC,EAAE;IACtB,OAAO,IAAI;EACf;EAEA,OAAQqC,IAAS,IAAK;IAClB,KAAK,MAAMC,MAAM,IAAItB,OAAO,EAAE;MAC1B,MAAMrB,MAAM,GAAG2C,MAAM,CAAChB,KAAK,CAACiB,IAAI,CAACR,IAAI,IAAI;QACrC,MAAMJ,KAAK,GAAGK,SAAS,CAACQ,gBAAO,CAACC,GAAG,CAACJ,IAAI,EAAEN,IAAI,CAAC,EAAEO,MAAM,CAACjB,cAAc,CAAC;QACvE,MAAMJ,YAAY,GAAGe,SAAS,CAACM,MAAM,CAACrB,YAAY,EAAEqB,MAAM,CAACjB,cAAc,CAAC;QAC1E,MAAMqB,OAAO,GAAGJ,MAAM,CAACT,YAAY,CAACc,OAAO,CAAC;UACxChB,KAAK;UACLV;QACJ,CAAC,CAAC;QAEF,OAAOqB,MAAM,CAACnC,MAAM,GAAG,CAACuC,OAAO,GAAGA,OAAO;MAC7C,CAAC,CAAC;MACF,IAAI/C,MAAM,KAAK,KAAK,EAAE;QAClB,OAAO,KAAK;MAChB;IACJ;IACA,OAAO,IAAI;EACf,CAAC;AACL,CAAC;AAEM,SAASiD,WAAWA,CAAU3D,MAAiB,EAAO;EACzD,MAAMqD,MAAM,GAAGF,oBAAoB,CAACnD,MAAM,CAAC;EAC3C;AACJ;AACA;EACI,IAAI,CAACqD,MAAM,EAAE;IACT,OAAOrD,MAAM,CAAC4D,KAAK;EACvB;EACA,OAAO5D,MAAM,CAAC4D,KAAK,CAACP,MAAM,CAACA,MAAM,CAAC;AACtC","ignoreList":[]}

package/utils/get.d.ts

@@ -1,10 +1,11 @@
-import { Entity } from "dynamodb-toolbox";
-export interface Params {
-    entity: Entity<any>;
-    keys: {
-        PK: string;
-        SK: string;
-    };
+import type { Entity } from "../toolbox";
+export interface GetRecordParamsKeys {
+    PK: string;
+    SK: string;
+}
+export interface GetRecordParams {
+    entity: Entity;
+    keys: GetRecordParamsKeys;
 }
 /**
  * Gets a single record from the DynamoDB table.
@@ -14,4 +15,5 @@ export interface Params {
  *
  * @throws
  */
-export declare const get: <T>(params: Params) => Promise<T>;
+export declare const get: <T>(params: GetRecordParams) => Promise<T | null>;
+export declare const getClean: <T>(params: GetRecordParams) => Promise<T | null>;

package/utils/get.js

@@ -3,8 +3,8 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.get = void 0;
-
+exports.getClean = exports.get = void 0;
+var _cleanup = require("./cleanup");
 /**
  * Gets a single record from the DynamoDB table.
  * Returns either record or null.
@@ -18,13 +18,22 @@ const get = async params => {
     entity,
     keys
   } = params;
-  const result = await entity.get(keys);
-
-  if (!result || !result.Item) {
+  const result = await entity.get(keys, {
+    execute: true
+  });
+  if (!result?.Item) {
     return null;
   }
-
   return result.Item;
 };
+exports.get = get;
+const getClean = async params => {
+  const result = await get(params);
+  if (!result) {
+    return null;
+  }
+  return (0, _cleanup.cleanupItem)(params.entity, result);
+};
+exports.getClean = getClean;
 
-exports.get = get;
+//# sourceMappingURL=get.js.map

package/utils/get.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_cleanup","require","get","params","entity","keys","result","execute","Item","exports","getClean","cleanupItem"],"sources":["get.ts"],"sourcesContent":["import type { Entity } from \"~/toolbox\";\nimport { cleanupItem } from \"~/utils/cleanup\";\n\nexport interface GetRecordParamsKeys {\n    PK: string;\n    SK: string;\n}\n\nexport interface GetRecordParams {\n    entity: Entity;\n    keys: GetRecordParamsKeys;\n}\n\n/**\n * Gets a single record from the DynamoDB table.\n * Returns either record or null.\n *\n * Be aware to wrap in try/catch to avoid the error killing your app.\n *\n * @throws\n */\nexport const get = async <T>(params: GetRecordParams): Promise<T | null> => {\n    const { entity, keys } = params;\n\n    const result = await entity.get(keys, {\n        execute: true\n    });\n\n    if (!result?.Item) {\n        return null;\n    }\n    return result.Item as T;\n};\n\nexport const getClean = async <T>(params: GetRecordParams): Promise<T | null> => {\n    const result = await get<T>(params);\n    if (!result) {\n        return null;\n    }\n    return cleanupItem<T>(params.entity, result);\n};\n"],"mappings":";;;;;;AACA,IAAAA,QAAA,GAAAC,OAAA;AAYA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMC,GAAG,GAAG,MAAUC,MAAuB,IAAwB;EACxE,MAAM;IAAEC,MAAM;IAAEC;EAAK,CAAC,GAAGF,MAAM;EAE/B,MAAMG,MAAM,GAAG,MAAMF,MAAM,CAACF,GAAG,CAACG,IAAI,EAAE;IAClCE,OAAO,EAAE;EACb,CAAC,CAAC;EAEF,IAAI,CAACD,MAAM,EAAEE,IAAI,EAAE;IACf,OAAO,IAAI;EACf;EACA,OAAOF,MAAM,CAACE,IAAI;AACtB,CAAC;AAACC,OAAA,CAAAP,GAAA,GAAAA,GAAA;AAEK,MAAMQ,QAAQ,GAAG,MAAUP,MAAuB,IAAwB;EAC7E,MAAMG,MAAM,GAAG,MAAMJ,GAAG,CAAIC,MAAM,CAAC;EACnC,IAAI,CAACG,MAAM,EAAE;IACT,OAAO,IAAI;EACf;EACA,OAAO,IAAAK,oBAAW,EAAIR,MAAM,CAACC,MAAM,EAAEE,MAAM,CAAC;AAChD,CAAC;AAACG,OAAA,CAAAC,QAAA,GAAAA,QAAA","ignoreList":[]}

package/utils/index.d.ts

@@ -0,0 +1,17 @@
+export * from "./cleanup";
+export * from "./createEntity";
+export * from "./createTable";
+export * from "./cursor";
+export * from "./filter";
+export * from "./get";
+export * from "./delete";
+export * from "./put";
+export * from "./listResponse";
+export * from "./query";
+export * from "./count";
+export * from "./scan";
+export * from "./sort";
+export * from "./update";
+export * from "./batch";
+export * from "./entity";
+export * from "./table";