@webiny/db-dynamodb 5.15.0-beta.3 → 5.16.0-beta.2

package/README.md

@@ -11,10 +11,57 @@ For more information, please visit
   
 ## Install
 ```
-npm install --save @webiny/db-dynamodb
-```
-
-Or if you prefer yarn: 
-```
 yarn add @webiny/db-dynamodb
 ```
+
+
+### Helper functions
+We have a number [helper](./src/utils) functions that ease the use of either dynamodb-toolbox, filtering, sorting or just creating proper response.
+
+#### [batchRead](./src/utils/batchRead.ts)
+Read a batch of records from the DynamoDB table.
+
+This function accepts [table](https://github.com/jeremydaly/dynamodb-toolbox/blob/main/src/classes/Table.ts) and items, an array of objects created by [Entity.getBatch()](https://github.com/jeremydaly/dynamodb-toolbox/blob/main/src/classes/Entity.ts#L313).
+
+Internally it reads records until there are no more to read and returns a list of read records.
+
+#### [batchWrite](./src/utils/batchWrite.ts)
+Write a batch of records to the DynamoDB table.
+
+This function accepts [table](https://github.com/jeremydaly/dynamodb-toolbox/blob/main/src/classes/Table.ts) and items, an array of objects created by [Entity.putBatch()](https://github.com/jeremydaly/dynamodb-toolbox/blob/main/src/classes/Entity.ts#L989).
+It also accepts a number which defines a number of items to be written in one request. DO NOT put that number over the official DynamoDB maximum.
+
+Internally it loops through the items received (in chunks of `maxChunks` parameter) and does not return anything.
+
+
+#### [cleanupItem and cleanupItems](./src/utils/cleanup.ts)
+Clean up records received from the DynamoDB table. 
+
+This function accepts [entity](https://github.com/jeremydaly/dynamodb-toolbox/blob/main/src/classes/Entity.ts) and item to be cleaned up, in case of the cleanupItem.
+In case of `cleanupItems` it accepts an array of items to clean up.
+
+We use this to remove the properties that dynamodb-toolbox puts on the record automatically.
+
+#### [get](./src/utils/get.ts)
+Get a single record from the DynamoDB table with given keys.
+
+This function accepts [entity](https://github.com/jeremydaly/dynamodb-toolbox/blob/main/src/classes/Entity.ts) and keys to fetch the record by.
+
+It returns either record or null. By default, [entity.get()](https://github.com/jeremydaly/dynamodb-toolbox/blob/main/src/classes/Entity.ts#L281) returns a object with some meta data and `Item` property, which contains the record (or null if no record).
+
+#### [queryOne and queryAll](./src/utils/query.ts)
+Query the DynamoDB table for record(s) by given partition key and query options.
+
+This function accepts [entity](https://github.com/jeremydaly/dynamodb-toolbox/blob/main/src/classes/Entity.ts) to perform the query on, `partitionKey` to query by and [options](https://github.com/jeremydaly/dynamodb-toolbox/blob/main/src/classes/Table.ts#L65) to define the query parameters with.
+
+The `queryAll` method accepts `limit`, a number with which you can load only a certain amount of records. The `queryOne` method does not have that property.
+
+#### [filter](./src/utils/filter.ts)
+Filter the DynamoDB records by given where condition.
+
+This function accepts items (records) to be filtered, a definition of fields to filter by (not required by default if no field modification is required), where conditions (eg. `{published: true, date_gte: "2021-01-01"}`) and filtering plugins.
+
+#### [sort](./src/utils/sort.ts)
+Sort the DynamoDB records by given sort condition.
+
+This function accepts items (records) to be sorted, sort options (eg. createdBy_ASC, id_DESC, etc.) and a definitions of fields to sort by (not required by default if no field modification is required).

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@webiny/db-dynamodb",
-	"version": "5.15.0-beta.3",
+	"version": "5.16.0-beta.2",
 	"main": "index.js",
 	"repository": {
 		"type": "git",
@@ -10,11 +10,11 @@
 	"author": "Webiny Ltd",
 	"license": "MIT",
 	"dependencies": {
-		"@webiny/db": "5.15.0-beta.3",
-		"@webiny/error": "5.15.0-beta.3",
-		"@webiny/handler": "5.15.0-beta.3",
-		"@webiny/handler-db": "5.15.0-beta.3",
-		"@webiny/plugins": "5.15.0-beta.3",
+		"@webiny/db": "5.16.0-beta.2",
+		"@webiny/error": "5.16.0-beta.2",
+		"@webiny/handler": "5.16.0-beta.2",
+		"@webiny/handler-db": "5.16.0-beta.2",
+		"@webiny/plugins": "5.16.0-beta.2",
 		"date-fns": "2.23.0",
 		"dot-prop": "6.0.1",
 		"fuse.js": "6.4.6",
@@ -24,8 +24,8 @@
 	"devDependencies": {
 		"@babel/cli": "^7.5.5",
 		"@babel/core": "^7.5.5",
-		"@webiny/cli": "^5.15.0-beta.3",
-		"@webiny/project-utils": "^5.15.0-beta.3",
+		"@webiny/cli": "^5.16.0-beta.2",
+		"@webiny/project-utils": "^5.16.0-beta.2",
 		"dynamodb-toolbox": "^0.3.4",
 		"jest": "^26.6.3",
 		"jest-dynalite": "^3.2.0",
@@ -41,5 +41,5 @@
 		"build": "yarn webiny run build",
 		"watch": "yarn webiny run watch"
 	},
-	"gitHead": "50bbde7aa0b1bea0277ca01dcaf3e8e09e0f4a52"
+	"gitHead": "f8ca0ffc49737da9d2f797382c4df9c701d6f037"
 }

package/plugins/definitions/FieldPlugin.d.ts

@@ -1,6 +1,9 @@
 import { Plugin } from "@webiny/plugins";
 import { DynamoDBTypes } from "dynamodb-toolbox/dist/classes/Table";
 export declare type FieldType = DynamoDBTypes & "date" & any;
+export interface TransformValueCb {
+    (value: any): any;
+}
 export interface Params {
     /**
      * Default is string.
@@ -12,6 +15,7 @@ export interface Params {
      * Default is true.
      */
     sortable?: boolean;
+    transformValue?: TransformValueCb;
 }
 export declare abstract class FieldPlugin extends Plugin {
     private readonly path;
@@ -19,6 +23,7 @@ export declare abstract class FieldPlugin extends Plugin {
     private readonly fieldType;
     private readonly dynamoDbType;
     private readonly sortable;
+    private readonly _transformValue;
     constructor(params: Params);
     getPath(): string;
     getType(): FieldType;

package/plugins/definitions/FieldPlugin.js

@@ -19,11 +19,13 @@ class FieldPlugin extends _plugins.Plugin {
     (0, _defineProperty2.default)(this, "fieldType", void 0);
     (0, _defineProperty2.default)(this, "dynamoDbType", void 0);
     (0, _defineProperty2.default)(this, "sortable", void 0);
+    (0, _defineProperty2.default)(this, "_transformValue", void 0);
     this.fieldType = params.type || "string";
     this.dynamoDbType = params.type === "date" ? "string" : params.type;
     this.field = params.field;
     this.path = params.path;
     this.sortable = params.sortable === undefined ? true : params.sortable;
+    this._transformValue = params.transformValue;
   }
 
   getPath() {
@@ -39,11 +41,19 @@ class FieldPlugin extends _plugins.Plugin {
   }
 
   transformValue(value) {
+    if (this._transformValue) {
+      return this.transformValue(value);
+    }
+
     switch (this.fieldType) {
       case "number":
         return Number(value);
 
       case "date":
+        if (!value) {
+          return null;
+        }
+
         return new Date(value);
     }
 

package/plugins/definitions/FieldPlugin.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/plugins/definitions/FieldPlugin.ts"],"names":["FieldPlugin","Plugin","constructor","params","fieldType","type","dynamoDbType","field","path","sortable","undefined","getPath","getType","getField","transformValue","value","Number","Date","isSortable"],"mappings":";;;;;;;;;;;AAAA;;AAkBO,MAAeA,WAAf,SAAmCC,eAAnC,CAA0C;AAOtCC,EAAAA,WAAW,CAACC,MAAD,EAAiB;AAC/B;AAD+B;AAAA;AAAA;AAAA;AAAA;AAE/B,SAAKC,SAAL,GAAiBD,MAAM,CAACE,IAAP,IAAe,QAAhC;AACA,SAAKC,YAAL,GAAoBH,MAAM,CAACE,IAAP,KAAgB,MAAhB,GAAyB,QAAzB,GAAoCF,MAAM,CAACE,IAA/D;AACA,SAAKE,KAAL,GAAaJ,MAAM,CAACI,KAApB;AACA,SAAKC,IAAL,GAAYL,MAAM,CAACK,IAAnB;AACA,SAAKC,QAAL,GAAgBN,MAAM,CAACM,QAAP,KAAoBC,SAApB,GAAgC,IAAhC,GAAuCP,MAAM,CAACM,QAA9D;AACH;;AAEME,EAAAA,OAAO,GAAW;AACrB,WAAO,KAAKH,IAAL,IAAa,KAAKD,KAAzB;AACH;;AAEMK,EAAAA,OAAO,GAAc;AACxB,WAAO,KAAKR,SAAZ;AACH;;AAEMS,EAAAA,QAAQ,GAAW;AACtB,WAAO,KAAKN,KAAZ;AACH;;AAEMO,EAAAA,cAAc,CAACC,KAAD,EAAkB;AACnC,YAAQ,KAAKX,SAAb;AACI,WAAK,QAAL;AACI,eAAOY,MAAM,CAACD,KAAD,CAAb;;AACJ,WAAK,MAAL;AACI,eAAO,IAAIE,IAAJ,CAASF,KAAT,CAAP;AAJR;;AAMA,WAAOA,KAAP;AACH;;AAEMG,EAAAA,UAAU,GAAY;AACzB,WAAO,KAAKT,QAAZ;AACH;;AAxC4C","sourcesContent":["import { Plugin } from \"@webiny/plugins\";\nimport { DynamoDBTypes } from \"dynamodb-toolbox/dist/classes/Table\";\n\nexport type FieldType = DynamoDBTypes & \"date\" & any;\n\nexport interface Params {\n    /**\n     * Default is string.\n     */\n    type?: FieldType;\n    field: string;\n    path?: string;\n    /**\n     * Default is true.\n     */\n    sortable?: boolean;\n}\n\nexport abstract class FieldPlugin extends Plugin {\n    private readonly path: string;\n    private readonly field: string;\n    private readonly fieldType: FieldType;\n    private readonly dynamoDbType: DynamoDBTypes;\n    private readonly sortable: boolean;\n\n    public constructor(params: Params) {\n        super();\n        this.fieldType = params.type || \"string\";\n        this.dynamoDbType = params.type === \"date\" ? \"string\" : params.type;\n        this.field = params.field;\n        this.path = params.path;\n        this.sortable = params.sortable === undefined ? true : params.sortable;\n    }\n\n    public getPath(): string {\n        return this.path || this.field;\n    }\n\n    public getType(): FieldType {\n        return this.fieldType;\n    }\n\n    public getField(): string {\n        return this.field;\n    }\n\n    public transformValue(value: any): any {\n        switch (this.fieldType) {\n            case \"number\":\n                return Number(value);\n            case \"date\":\n                return new Date(value);\n        }\n        return value;\n    }\n\n    public isSortable(): boolean {\n        return this.sortable;\n    }\n}\n"],"file":"FieldPlugin.js"}
+{"version":3,"sources":["../../../src/plugins/definitions/FieldPlugin.ts"],"names":["FieldPlugin","Plugin","constructor","params","fieldType","type","dynamoDbType","field","path","sortable","undefined","_transformValue","transformValue","getPath","getType","getField","value","Number","Date","isSortable"],"mappings":";;;;;;;;;;;AAAA;;AAwBO,MAAeA,WAAf,SAAmCC,eAAnC,CAA0C;AAQtCC,EAAAA,WAAW,CAACC,MAAD,EAAiB;AAC/B;AAD+B;AAAA;AAAA;AAAA;AAAA;AAAA;AAE/B,SAAKC,SAAL,GAAiBD,MAAM,CAACE,IAAP,IAAe,QAAhC;AACA,SAAKC,YAAL,GAAoBH,MAAM,CAACE,IAAP,KAAgB,MAAhB,GAAyB,QAAzB,GAAoCF,MAAM,CAACE,IAA/D;AACA,SAAKE,KAAL,GAAaJ,MAAM,CAACI,KAApB;AACA,SAAKC,IAAL,GAAYL,MAAM,CAACK,IAAnB;AACA,SAAKC,QAAL,GAAgBN,MAAM,CAACM,QAAP,KAAoBC,SAApB,GAAgC,IAAhC,GAAuCP,MAAM,CAACM,QAA9D;AACA,SAAKE,eAAL,GAAuBR,MAAM,CAACS,cAA9B;AACH;;AAEMC,EAAAA,OAAO,GAAW;AACrB,WAAO,KAAKL,IAAL,IAAa,KAAKD,KAAzB;AACH;;AAEMO,EAAAA,OAAO,GAAc;AACxB,WAAO,KAAKV,SAAZ;AACH;;AAEMW,EAAAA,QAAQ,GAAW;AACtB,WAAO,KAAKR,KAAZ;AACH;;AAEMK,EAAAA,cAAc,CAACI,KAAD,EAAkB;AACnC,QAAI,KAAKL,eAAT,EAA0B;AACtB,aAAO,KAAKC,cAAL,CAAoBI,KAApB,CAAP;AACH;;AACD,YAAQ,KAAKZ,SAAb;AACI,WAAK,QAAL;AACI,eAAOa,MAAM,CAACD,KAAD,CAAb;;AACJ,WAAK,MAAL;AACI,YAAI,CAACA,KAAL,EAAY;AACR,iBAAO,IAAP;AACH;;AACD,eAAO,IAAIE,IAAJ,CAASF,KAAT,CAAP;AAPR;;AASA,WAAOA,KAAP;AACH;;AAEMG,EAAAA,UAAU,GAAY;AACzB,WAAO,KAAKV,QAAZ;AACH;;AAhD4C","sourcesContent":["import { Plugin } from \"@webiny/plugins\";\nimport { DynamoDBTypes } from \"dynamodb-toolbox/dist/classes/Table\";\n\nexport type FieldType = DynamoDBTypes & \"date\" & any;\n\nexport interface TransformValueCb {\n    (value: any): any;\n}\n\nexport interface Params {\n    /**\n     * Default is string.\n     */\n    type?: FieldType;\n    field: string;\n    path?: string;\n    /**\n     * Default is true.\n     */\n    sortable?: boolean;\n\n    transformValue?: TransformValueCb;\n}\n\nexport abstract class FieldPlugin extends Plugin {\n    private readonly path: string;\n    private readonly field: string;\n    private readonly fieldType: FieldType;\n    private readonly dynamoDbType: DynamoDBTypes;\n    private readonly sortable: boolean;\n    private readonly _transformValue: TransformValueCb | undefined;\n\n    public constructor(params: Params) {\n        super();\n        this.fieldType = params.type || \"string\";\n        this.dynamoDbType = params.type === \"date\" ? \"string\" : params.type;\n        this.field = params.field;\n        this.path = params.path;\n        this.sortable = params.sortable === undefined ? true : params.sortable;\n        this._transformValue = params.transformValue;\n    }\n\n    public getPath(): string {\n        return this.path || this.field;\n    }\n\n    public getType(): FieldType {\n        return this.fieldType;\n    }\n\n    public getField(): string {\n        return this.field;\n    }\n\n    public transformValue(value: any): any {\n        if (this._transformValue) {\n            return this.transformValue(value);\n        }\n        switch (this.fieldType) {\n            case \"number\":\n                return Number(value);\n            case \"date\":\n                if (!value) {\n                    return null;\n                }\n                return new Date(value);\n        }\n        return value;\n    }\n\n    public isSortable(): boolean {\n        return this.sortable;\n    }\n}\n"],"file":"FieldPlugin.js"}

package/utils/attributes.d.ts

@@ -1,3 +1,8 @@
 import { ContextInterface } from "@webiny/handler/types";
 import { DefinitionParams } from "../plugins/definitions/AttributePlugin";
+/**
+ * Will be removed in favor of directly assigning attributes to a certain entity when creating the storage operations.
+ *
+ * @deprecated
+ */
 export declare const getExtraAttributes: (context: ContextInterface, entity: string) => Record<string, DefinitionParams>;

package/utils/attributes.js

@@ -15,6 +15,11 @@ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (O
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
 
+/**
+ * Will be removed in favor of directly assigning attributes to a certain entity when creating the storage operations.
+ *
+ * @deprecated
+ */
 const getExtraAttributes = (context, entity) => {
   return context.plugins.byType(_AttributePlugin.AttributePlugin.type).filter(plugin => plugin.entity === entity).reduce((attributes, plugin) => {
     return _objectSpread(_objectSpread({}, attributes), plugin.getDefinition());

package/utils/attributes.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utils/attributes.ts"],"names":["getExtraAttributes","context","entity","plugins","byType","AttributePlugin","type","filter","plugin","reduce","attributes","getDefinition"],"mappings":";;;;;;;;;;;AACA;;;;;;AAEO,MAAMA,kBAAkB,GAAG,CAC9BC,OAD8B,EAE9BC,MAF8B,KAGK;AACnC,SAAOD,OAAO,CAACE,OAAR,CACFC,MADE,CACsBC,iCAAgBC,IADtC,EAEFC,MAFE,CAEKC,MAAM,IAAIA,MAAM,CAACN,MAAP,KAAkBA,MAFjC,EAGFO,MAHE,CAGK,CAACC,UAAD,EAAaF,MAAb,KAAwB;AAC5B,2CACOE,UADP,GAEOF,MAAM,CAACG,aAAP,EAFP;AAIH,GARE,EAQA,EARA,CAAP;AASH,CAbM","sourcesContent":["import { ContextInterface } from \"@webiny/handler/types\";\nimport { AttributePlugin, DefinitionParams } from \"~/plugins/definitions/AttributePlugin\";\n\nexport const getExtraAttributes = (\n    context: ContextInterface,\n    entity: string\n): Record<string, DefinitionParams> => {\n    return context.plugins\n        .byType<AttributePlugin>(AttributePlugin.type)\n        .filter(plugin => plugin.entity === entity)\n        .reduce((attributes, plugin) => {\n            return {\n                ...attributes,\n                ...plugin.getDefinition()\n            };\n        }, {});\n};\n"],"file":"attributes.js"}
+{"version":3,"sources":["../../src/utils/attributes.ts"],"names":["getExtraAttributes","context","entity","plugins","byType","AttributePlugin","type","filter","plugin","reduce","attributes","getDefinition"],"mappings":";;;;;;;;;;;AACA;;;;;;AAEA;AACA;AACA;AACA;AACA;AACO,MAAMA,kBAAkB,GAAG,CAC9BC,OAD8B,EAE9BC,MAF8B,KAGK;AACnC,SAAOD,OAAO,CAACE,OAAR,CACFC,MADE,CACsBC,iCAAgBC,IADtC,EAEFC,MAFE,CAEKC,MAAM,IAAIA,MAAM,CAACN,MAAP,KAAkBA,MAFjC,EAGFO,MAHE,CAGK,CAACC,UAAD,EAAaF,MAAb,KAAwB;AAC5B,2CACOE,UADP,GAEOF,MAAM,CAACG,aAAP,EAFP;AAIH,GARE,EAQA,EARA,CAAP;AASH,CAbM","sourcesContent":["import { ContextInterface } from \"@webiny/handler/types\";\nimport { AttributePlugin, DefinitionParams } from \"~/plugins/definitions/AttributePlugin\";\n\n/**\n * Will be removed in favor of directly assigning attributes to a certain entity when creating the storage operations.\n *\n * @deprecated\n */\nexport const getExtraAttributes = (\n    context: ContextInterface,\n    entity: string\n): Record<string, DefinitionParams> => {\n    return context.plugins\n        .byType<AttributePlugin>(AttributePlugin.type)\n        .filter(plugin => plugin.entity === entity)\n        .reduce((attributes, plugin) => {\n            return {\n                ...attributes,\n                ...plugin.getDefinition()\n            };\n        }, {});\n};\n"],"file":"attributes.js"}

package/utils/documentClient.d.ts

@@ -1,3 +1,8 @@
 import { DocumentClient } from "aws-sdk/clients/dynamodb";
 import { DbContext } from "@webiny/handler-db/types";
+/**
+ * Will be removed in favor of directly passing the documentClient to the storage operations.
+ *
+ * @deprecated
+ */
 export declare const getDocumentClient: <T extends DbContext>(context: T) => DocumentClient;

package/utils/documentClient.js

@@ -9,6 +9,11 @@ exports.getDocumentClient = void 0;
 
 var _error = _interopRequireDefault(require("@webiny/error"));
 
+/**
+ * Will be removed in favor of directly passing the documentClient to the storage operations.
+ *
+ * @deprecated
+ */
 const getDocumentClient = context => {
   if (!context.db) {
     throw new _error.default("Missing db on context.", "DB_ERROR");

package/utils/documentClient.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utils/documentClient.ts"],"names":["getDocumentClient","context","db","WebinyError","driver","documentClient"],"mappings":";;;;;;;;;AACA;;AAIO,MAAMA,iBAAiB,GAAyBC,OAAtB,IAAqD;AAClF,MAAI,CAACA,OAAO,CAACC,EAAb,EAAiB;AACb,UAAM,IAAIC,cAAJ,CAAgB,wBAAhB,EAA0C,UAA1C,CAAN;AACH,GAFD,MAEO,IAAI,CAACF,OAAO,CAACC,EAAR,CAAWE,MAAhB,EAAwB;AAC3B,UAAM,IAAID,cAAJ,CAAiB,4CAAjB,EAA8D,cAA9D,CAAN;AACH;;AACD,QAAMC,MAAM,GAAGH,OAAO,CAACC,EAAR,CAAWE,MAA1B;;AACA,MAAI,CAACA,MAAM,CAACC,cAAZ,EAA4B;AACxB,UAAM,IAAIF,cAAJ,CACD,2DADC,EAEF,uBAFE,CAAN;AAIH;;AACD,SAAOC,MAAM,CAACC,cAAd;AACH,CAdM","sourcesContent":["import { DocumentClient } from \"aws-sdk/clients/dynamodb\";\nimport WebinyError from \"@webiny/error\";\nimport { DbContext } from \"@webiny/handler-db/types\";\nimport DynamoDbDriver from \"~/DynamoDbDriver\";\n\nexport const getDocumentClient = <T extends DbContext>(context: T): DocumentClient => {\n    if (!context.db) {\n        throw new WebinyError(\"Missing db on context.\", \"DB_ERROR\");\n    } else if (!context.db.driver) {\n        throw new WebinyError(`Missing driver on the context.db property.`, \"DRIVER_ERROR\");\n    }\n    const driver = context.db.driver as DynamoDbDriver;\n    if (!driver.documentClient) {\n        throw new WebinyError(\n            `Missing documentClient on the context.db.driver property.`,\n            \"DOCUMENT_CLIENT_ERROR\"\n        );\n    }\n    return driver.documentClient;\n};\n"],"file":"documentClient.js"}
+{"version":3,"sources":["../../src/utils/documentClient.ts"],"names":["getDocumentClient","context","db","WebinyError","driver","documentClient"],"mappings":";;;;;;;;;AACA;;AAIA;AACA;AACA;AACA;AACA;AACO,MAAMA,iBAAiB,GAAyBC,OAAtB,IAAqD;AAClF,MAAI,CAACA,OAAO,CAACC,EAAb,EAAiB;AACb,UAAM,IAAIC,cAAJ,CAAgB,wBAAhB,EAA0C,UAA1C,CAAN;AACH,GAFD,MAEO,IAAI,CAACF,OAAO,CAACC,EAAR,CAAWE,MAAhB,EAAwB;AAC3B,UAAM,IAAID,cAAJ,CAAiB,4CAAjB,EAA8D,cAA9D,CAAN;AACH;;AACD,QAAMC,MAAM,GAAGH,OAAO,CAACC,EAAR,CAAWE,MAA1B;;AACA,MAAI,CAACA,MAAM,CAACC,cAAZ,EAA4B;AACxB,UAAM,IAAIF,cAAJ,CACD,2DADC,EAEF,uBAFE,CAAN;AAIH;;AACD,SAAOC,MAAM,CAACC,cAAd;AACH,CAdM","sourcesContent":["import { DocumentClient } from \"aws-sdk/clients/dynamodb\";\nimport WebinyError from \"@webiny/error\";\nimport { DbContext } from \"@webiny/handler-db/types\";\nimport DynamoDbDriver from \"~/DynamoDbDriver\";\n\n/**\n * Will be removed in favor of directly passing the documentClient to the storage operations.\n *\n * @deprecated\n */\nexport const getDocumentClient = <T extends DbContext>(context: T): DocumentClient => {\n    if (!context.db) {\n        throw new WebinyError(\"Missing db on context.\", \"DB_ERROR\");\n    } else if (!context.db.driver) {\n        throw new WebinyError(`Missing driver on the context.db property.`, \"DRIVER_ERROR\");\n    }\n    const driver = context.db.driver as DynamoDbDriver;\n    if (!driver.documentClient) {\n        throw new WebinyError(\n            `Missing documentClient on the context.db.driver property.`,\n            \"DOCUMENT_CLIENT_ERROR\"\n        );\n    }\n    return driver.documentClient;\n};\n"],"file":"documentClient.js"}

package/utils/filter.d.ts

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

package/utils/filter.js

@@ -14,7 +14,7 @@ var _error = _interopRequireDefault(require("@webiny/error"));
 var _ValueFilterPlugin = require("../plugins/definitions/ValueFilterPlugin");
 
 const getMappedPlugins = params => {
-  return params.context.plugins.byType(params.type).reduce((plugins, plugin) => {
+  return params.plugins.byType(params.type).reduce((plugins, plugin) => {
     const op = plugin[params.property];
     plugins[op] = plugin;
     return plugins;
@@ -60,7 +60,7 @@ const multiSearchFieldOperations = ["contains", "fuzzy"];
 
 const createFilters = params => {
   const {
-    context,
+    plugins,
     where,
     fields
   } = params;
@@ -74,7 +74,7 @@ const createFilters = params => {
   }
 
   const filterPlugins = getMappedPlugins({
-    context,
+    plugins,
     type: _ValueFilterPlugin.ValueFilterPlugin.type,
     property: "operation"
   });

package/utils/filter.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utils/filter.ts"],"names":["getMappedPlugins","params","context","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","push","filterPlugin","path","transform","Array","isArray","v","createFilterCallable","item","filter","some","dotProp","get","matched","matches","filterItems","items"],"mappings":";;;;;;;;;AAAA;;AACA;;AAEA;;AA4BA,MAAMA,gBAAgB,GAAsBC,MAAnB,IAAqE;AAC1F,SAAOA,MAAM,CAACC,OAAP,CAAeC,OAAf,CAAuBC,MAAvB,CAAiCH,MAAM,CAACI,IAAxC,EAA8CC,MAA9C,CAAqD,CAACH,OAAD,EAAUI,MAAV,KAAqB;AAC7E,UAAMC,EAAE,GAAGD,MAAM,CAACN,MAAM,CAACQ,QAAR,CAAjB;AACAN,IAAAA,OAAO,CAACK,EAAD,CAAP,GAAcD,MAAd;AACA,WAAOJ,OAAP;AACH,GAJM,EAIJ,EAJI,CAAP;AAKH,CAND;;AAQA,MAAMO,gBAAgB,GAAIC,GAAD,IAAiB;AACtC,QAAMC,MAAM,GAAGD,GAAG,CAACE,KAAJ,CAAU,GAAV,CAAf;AACA,QAAMC,KAAK,GAAGF,MAAM,CAACG,KAAP,EAAd;AACA,QAAMC,KAAK,GAAGJ,MAAM,CAACK,MAAP,KAAkB,CAAlB,GAAsB,IAAtB,GAA6BL,MAAM,CAACM,IAAP,CAAY,GAAZ,CAA3C;AACA;AACJ;AACA;;AACI,MAAIF,KAAK,KAAK,KAAd,EAAqB;AACjB,WAAO;AACHF,MAAAA,KADG;AAEHK,MAAAA,SAAS,EAAE,IAFR;AAGHC,MAAAA,MAAM,EAAE;AAHL,KAAP;AAKH;;AACD,QAAMA,MAAM,GAAGJ,KAAK,CAACK,KAAN,CAAY,MAAZ,MAAwB,IAAvC;AACA,QAAMF,SAAS,GAAGH,KAAK,CAACM,OAAN,CAAc,MAAd,EAAsB,EAAtB,CAAlB;AACA,SAAO;AAAER,IAAAA,KAAF;AAASK,IAAAA,SAAT;AAAoBC,IAAAA;AAApB,GAAP;AACH,CAjBD;;AAmBA,MAAMG,gBAAgB,GAAG,CACrBpB,OADqB,EAErBgB,SAFqB,KAGD;AACpB,MAAIhB,OAAO,CAACgB,SAAD,CAAX,EAAwB;AACpB,WAAOhB,OAAO,CAACgB,SAAD,CAAd;AACH;;AACD,QAAM,IAAIK,cAAJ,CAAiB,mCAAjB,EAAqD,qBAArD,EAA4E;AAC9EL,IAAAA;AAD8E,GAA5E,CAAN;AAGH,CAVD;;AAYA,MAAMM,0BAA0B,GAAG,CAAC,UAAD,EAAa,OAAb,CAAnC;;AAEA,MAAMC,aAAa,GAAIzB,MAAD,IAA6C;AAC/D,QAAM;AAAEC,IAAAA,OAAF;AAAWyB,IAAAA,KAAX;AAAkBC,IAAAA;AAAlB,MAA6B3B,MAAnC;AAEA,QAAM4B,IAAI,GAAGC,MAAM,CAACD,IAAP,CAAYF,KAAZ,CAAb;AACA;AACJ;AACA;;AACI,MAAIE,IAAI,CAACZ,MAAL,KAAgB,CAApB,EAAuB;AACnB,WAAO,EAAP;AACH;;AACD,QAAMc,aAAa,GAAG/B,gBAAgB,CAAoB;AACtDE,IAAAA,OADsD;AAEtDG,IAAAA,IAAI,EAAE2B,qCAAkB3B,IAF8B;AAGtDI,IAAAA,QAAQ,EAAE;AAH4C,GAApB,CAAtC;AAMA,SAAOoB,IAAI,CAACvB,MAAL,CAAY,CAAC2B,OAAD,EAAUtB,GAAV,KAAkB;AACjC,UAAMuB,YAAY,GAAGP,KAAK,CAAChB,GAAD,CAA1B;;AACA,QAAIuB,YAAY,KAAKC,SAArB,EAAgC;AAC5B,aAAOF,OAAP;AACH;AACD;AACR;AACA;;;AACQ,QAAIR,0BAA0B,CAACW,QAA3B,CAAoCzB,GAApC,MAA6C,IAAjD,EAAuD;AACnD,YAAM0B,IAA4B,GAAGH,YAArC;AACA,UAAII,cAA8B,GAAGH,SAArC;AACA,YAAMI,KAAK,GAAGF,IAAI,CAACT,MAAL,CAAYY,GAAZ,CAAgB1B,KAAK,IAAI;AACnC,cAAM2B,WAAW,GAAGb,MAAM,CAACc,IAAP,CAAYnC,MAAM,IAAIA,MAAM,CAACoC,QAAP,OAAsB7B,KAA5C,CAApB;;AACA,YAAI2B,WAAJ,EAAiB;AACbH,UAAAA,cAAc,GAAIM,KAAD,IAAgB;AAC7B,mBAAOH,WAAW,CAACH,cAAZ,CAA2BM,KAA3B,CAAP;AACH,WAFD;;AAGA,iBAAOH,WAAW,CAACI,OAAZ,EAAP;AACH;;AACD,eAAO/B,KAAP;AACH,OATa,CAAd;AAUAmB,MAAAA,OAAO,CAACa,IAAR,CAAa;AACTZ,QAAAA,YAAY,EAAEG,IAAI,CAACO,KADV;AAETG,QAAAA,YAAY,EAAExB,gBAAgB,CAACQ,aAAD,EAAgBpB,GAAhB,CAFrB;AAGT2B,QAAAA,cAHS;AAITC,QAAAA,KAJS;AAKTnB,QAAAA,MAAM,EAAE;AALC,OAAb;AAOA,aAAOa,OAAP;AACH;;AAED,UAAM;AAAEnB,MAAAA,KAAF;AAASK,MAAAA,SAAT;AAAoBC,MAAAA;AAApB,QAA+BV,gBAAgB,CAACC,GAAD,CAArD;AAEA,UAAMoC,YAAY,GAAGxB,gBAAgB,CAACQ,aAAD,EAAgBZ,SAAhB,CAArC;AAEA,UAAMsB,WAAW,GAAGb,MAAM,CAACc,IAAP,CAAYnC,MAAM,IAAIA,MAAM,CAACoC,QAAP,OAAsB7B,KAA5C,CAApB;AACA,QAAIkC,IAAY,GAAGlC,KAAnB;AACA,QAAIwB,cAA8B,GAAGH,SAArC;;AACA,QAAIM,WAAJ,EAAiB;AACbH,MAAAA,cAAc,GAAIM,KAAD,IAAgB;AAC7B,eAAOH,WAAW,CAACH,cAAZ,CAA2BM,KAA3B,CAAP;AACH,OAFD;;AAGAI,MAAAA,IAAI,GAAGP,WAAW,CAACI,OAAZ,EAAP;AACH;;AAEDZ,IAAAA,OAAO,CAACa,IAAR,CAAa;AACTZ,MAAAA,YADS;AAETa,MAAAA,YAFS;AAGTT,MAAAA,cAHS;AAITC,MAAAA,KAAK,EAAE,CAACS,IAAD,CAJE;AAKT5B,MAAAA;AALS,KAAb;AAQA,WAAOa,OAAP;AACH,GAtDM,EAsDJ,EAtDI,CAAP;AAuDH,CAvED;AAwEA;AACA;AACA;;;AACA,MAAMgB,SAAS,GAAG,CAACL,KAAD,EAAaN,cAAb,KAAsD;AACpE,MAAI,CAACA,cAAL,EAAqB;AACjB,WAAOM,KAAP;AACH;;AACD,MAAIM,KAAK,CAACC,OAAN,CAAcP,KAAd,CAAJ,EAA0B;AACtB,WAAOA,KAAK,CAACJ,GAAN,CAAUY,CAAC,IAAId,cAAc,CAACc,CAAD,CAA7B,CAAP;AACH;;AACD,SAAOd,cAAc,CAACM,KAAD,CAArB;AACH,CARD;AASA;AACA;AACA;;;AACA,MAAMS,oBAAoB,GAAIpD,MAAD,IAAoE;AAC7F,QAAMgC,OAAO,GAAGP,aAAa,CAACzB,MAAD,CAA7B;AACA;AACJ;AACA;AACA;;AACI,MAAIgC,OAAO,CAAChB,MAAR,KAAmB,CAAvB,EAA0B;AACtB,WAAO,IAAP;AACH;;AAED,SAAQqC,IAAD,IAAe;AAClB,SAAK,MAAMC,MAAX,IAAqBtB,OAArB,EAA8B;AAC1B,YAAMrB,MAAM,GAAG2C,MAAM,CAAChB,KAAP,CAAaiB,IAAb,CAAkBR,IAAI,IAAI;AACrC,cAAMJ,KAAK,GAAGK,SAAS,CAACQ,iBAAQC,GAAR,CAAYJ,IAAZ,EAAkBN,IAAlB,CAAD,EAA0BO,MAAM,CAACjB,cAAjC,CAAvB;AACA,cAAMJ,YAAY,GAAGe,SAAS,CAACM,MAAM,CAACrB,YAAR,EAAsBqB,MAAM,CAACjB,cAA7B,CAA9B;AACA,cAAMqB,OAAO,GAAGJ,MAAM,CAACR,YAAP,CAAoBa,OAApB,CAA4B;AACxChB,UAAAA,KADwC;AAExCV,UAAAA;AAFwC,SAA5B,CAAhB;AAKA,eAAOqB,MAAM,CAACnC,MAAP,GAAgB,CAACuC,OAAjB,GAA2BA,OAAlC;AACH,OATc,CAAf;;AAUA,UAAI/C,MAAM,KAAK,KAAf,EAAsB;AAClB,eAAO,KAAP;AACH;AACJ;;AACD,WAAO,IAAP;AACH,GAjBD;AAkBH,CA5BD;;AA8BO,MAAMiD,WAAW,GAAyB5D,MAAtB,IAAiD;AACxE,QAAMsD,MAAM,GAAGF,oBAAoB,CAACpD,MAAD,CAAnC;AACA;AACJ;AACA;;AACI,MAAI,CAACsD,MAAL,EAAa;AACT,WAAOtD,MAAM,CAAC6D,KAAd;AACH;;AACD,SAAO7D,MAAM,CAAC6D,KAAP,CAAaP,MAAb,CAAoBA,MAApB,CAAP;AACH,CATM","sourcesContent":["import dotProp from \"dot-prop\";\nimport WebinyError from \"@webiny/error\";\nimport { Plugin } from \"@webiny/plugins\";\nimport { ValueFilterPlugin } from \"~/plugins/definitions/ValueFilterPlugin\";\nimport { ContextInterface } from \"@webiny/handler/types\";\nimport { FieldPlugin } from \"~/plugins/definitions/FieldPlugin\";\nimport { DynamoDbContainsFilter } from \"~/types\";\n\ntype TransformValue = (value: any) => any;\n\nexport interface Params<T extends any = any> {\n    items: T[];\n    where: Record<string, any>;\n    context: ContextInterface;\n    fields: FieldPlugin[];\n}\n\ninterface MappedPluginParams {\n    context: ContextInterface;\n    type: string;\n    property: string;\n}\n\ninterface Filter {\n    compareValue: any;\n    filterPlugin: ValueFilterPlugin;\n    transformValue: TransformValue;\n    paths: string[];\n    negate: boolean;\n}\n\nconst getMappedPlugins = <T extends Plugin>(params: MappedPluginParams): Record<string, T> => {\n    return params.context.plugins.byType<T>(params.type).reduce((plugins, plugin) => {\n        const op = plugin[params.property];\n        plugins[op] = plugin;\n        return plugins;\n    }, {});\n};\n\nconst extractWhereArgs = (key: string) => {\n    const result = key.split(\"_\");\n    const field = result.shift();\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 { field, operation, negate };\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 { context, 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        context,\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;\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            filters.push({\n                compareValue: data.value,\n                filterPlugin: findFilterPlugin(filterPlugins, key),\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;\n        if (fieldPlugin) {\n            transformValue = (value: any) => {\n                return fieldPlugin.transformValue(value);\n            };\n            path = fieldPlugin.getPath();\n        }\n\n        filters.push({\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 const filterItems = <T extends any = 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"],"file":"filter.js"}
+{"version":3,"sources":["../../src/utils/filter.ts"],"names":["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","push","filterPlugin","path","transform","Array","isArray","v","createFilterCallable","item","filter","some","dotProp","get","matched","matches","filterItems","items"],"mappings":";;;;;;;;;AAAA;;AACA;;AAEA;;AA2BA,MAAMA,gBAAgB,GAAsBC,MAAnB,IAAqE;AAC1F,SAAOA,MAAM,CAACC,OAAP,CAAeC,MAAf,CAAyBF,MAAM,CAACG,IAAhC,EAAsCC,MAAtC,CAA6C,CAACH,OAAD,EAAUI,MAAV,KAAqB;AACrE,UAAMC,EAAE,GAAGD,MAAM,CAACL,MAAM,CAACO,QAAR,CAAjB;AACAN,IAAAA,OAAO,CAACK,EAAD,CAAP,GAAcD,MAAd;AACA,WAAOJ,OAAP;AACH,GAJM,EAIJ,EAJI,CAAP;AAKH,CAND;;AAQA,MAAMO,gBAAgB,GAAIC,GAAD,IAAiB;AACtC,QAAMC,MAAM,GAAGD,GAAG,CAACE,KAAJ,CAAU,GAAV,CAAf;AACA,QAAMC,KAAK,GAAGF,MAAM,CAACG,KAAP,EAAd;AACA,QAAMC,KAAK,GAAGJ,MAAM,CAACK,MAAP,KAAkB,CAAlB,GAAsB,IAAtB,GAA6BL,MAAM,CAACM,IAAP,CAAY,GAAZ,CAA3C;AACA;AACJ;AACA;;AACI,MAAIF,KAAK,KAAK,KAAd,EAAqB;AACjB,WAAO;AACHF,MAAAA,KADG;AAEHK,MAAAA,SAAS,EAAE,IAFR;AAGHC,MAAAA,MAAM,EAAE;AAHL,KAAP;AAKH;;AACD,QAAMA,MAAM,GAAGJ,KAAK,CAACK,KAAN,CAAY,MAAZ,MAAwB,IAAvC;AACA,QAAMF,SAAS,GAAGH,KAAK,CAACM,OAAN,CAAc,MAAd,EAAsB,EAAtB,CAAlB;AACA,SAAO;AAAER,IAAAA,KAAF;AAASK,IAAAA,SAAT;AAAoBC,IAAAA;AAApB,GAAP;AACH,CAjBD;;AAmBA,MAAMG,gBAAgB,GAAG,CACrBpB,OADqB,EAErBgB,SAFqB,KAGD;AACpB,MAAIhB,OAAO,CAACgB,SAAD,CAAX,EAAwB;AACpB,WAAOhB,OAAO,CAACgB,SAAD,CAAd;AACH;;AACD,QAAM,IAAIK,cAAJ,CAAiB,mCAAjB,EAAqD,qBAArD,EAA4E;AAC9EL,IAAAA;AAD8E,GAA5E,CAAN;AAGH,CAVD;;AAYA,MAAMM,0BAA0B,GAAG,CAAC,UAAD,EAAa,OAAb,CAAnC;;AAEA,MAAMC,aAAa,GAAIxB,MAAD,IAA6C;AAC/D,QAAM;AAAEC,IAAAA,OAAF;AAAWwB,IAAAA,KAAX;AAAkBC,IAAAA;AAAlB,MAA6B1B,MAAnC;AAEA,QAAM2B,IAAI,GAAGC,MAAM,CAACD,IAAP,CAAYF,KAAZ,CAAb;AACA;AACJ;AACA;;AACI,MAAIE,IAAI,CAACZ,MAAL,KAAgB,CAApB,EAAuB;AACnB,WAAO,EAAP;AACH;;AACD,QAAMc,aAAa,GAAG9B,gBAAgB,CAAoB;AACtDE,IAAAA,OADsD;AAEtDE,IAAAA,IAAI,EAAE2B,qCAAkB3B,IAF8B;AAGtDI,IAAAA,QAAQ,EAAE;AAH4C,GAApB,CAAtC;AAMA,SAAOoB,IAAI,CAACvB,MAAL,CAAY,CAAC2B,OAAD,EAAUtB,GAAV,KAAkB;AACjC,UAAMuB,YAAY,GAAGP,KAAK,CAAChB,GAAD,CAA1B;;AACA,QAAIuB,YAAY,KAAKC,SAArB,EAAgC;AAC5B,aAAOF,OAAP;AACH;AACD;AACR;AACA;;;AACQ,QAAIR,0BAA0B,CAACW,QAA3B,CAAoCzB,GAApC,MAA6C,IAAjD,EAAuD;AACnD,YAAM0B,IAA4B,GAAGH,YAArC;AACA,UAAII,cAA8B,GAAGH,SAArC;AACA,YAAMI,KAAK,GAAGF,IAAI,CAACT,MAAL,CAAYY,GAAZ,CAAgB1B,KAAK,IAAI;AACnC,cAAM2B,WAAW,GAAGb,MAAM,CAACc,IAAP,CAAYnC,MAAM,IAAIA,MAAM,CAACoC,QAAP,OAAsB7B,KAA5C,CAApB;;AACA,YAAI2B,WAAJ,EAAiB;AACbH,UAAAA,cAAc,GAAIM,KAAD,IAAgB;AAC7B,mBAAOH,WAAW,CAACH,cAAZ,CAA2BM,KAA3B,CAAP;AACH,WAFD;;AAGA,iBAAOH,WAAW,CAACI,OAAZ,EAAP;AACH;;AACD,eAAO/B,KAAP;AACH,OATa,CAAd;AAUAmB,MAAAA,OAAO,CAACa,IAAR,CAAa;AACTZ,QAAAA,YAAY,EAAEG,IAAI,CAACO,KADV;AAETG,QAAAA,YAAY,EAAExB,gBAAgB,CAACQ,aAAD,EAAgBpB,GAAhB,CAFrB;AAGT2B,QAAAA,cAHS;AAITC,QAAAA,KAJS;AAKTnB,QAAAA,MAAM,EAAE;AALC,OAAb;AAOA,aAAOa,OAAP;AACH;;AAED,UAAM;AAAEnB,MAAAA,KAAF;AAASK,MAAAA,SAAT;AAAoBC,MAAAA;AAApB,QAA+BV,gBAAgB,CAACC,GAAD,CAArD;AAEA,UAAMoC,YAAY,GAAGxB,gBAAgB,CAACQ,aAAD,EAAgBZ,SAAhB,CAArC;AAEA,UAAMsB,WAAW,GAAGb,MAAM,CAACc,IAAP,CAAYnC,MAAM,IAAIA,MAAM,CAACoC,QAAP,OAAsB7B,KAA5C,CAApB;AACA,QAAIkC,IAAY,GAAGlC,KAAnB;AACA,QAAIwB,cAA8B,GAAGH,SAArC;;AACA,QAAIM,WAAJ,EAAiB;AACbH,MAAAA,cAAc,GAAIM,KAAD,IAAgB;AAC7B,eAAOH,WAAW,CAACH,cAAZ,CAA2BM,KAA3B,CAAP;AACH,OAFD;;AAGAI,MAAAA,IAAI,GAAGP,WAAW,CAACI,OAAZ,EAAP;AACH;;AAEDZ,IAAAA,OAAO,CAACa,IAAR,CAAa;AACTZ,MAAAA,YADS;AAETa,MAAAA,YAFS;AAGTT,MAAAA,cAHS;AAITC,MAAAA,KAAK,EAAE,CAACS,IAAD,CAJE;AAKT5B,MAAAA;AALS,KAAb;AAQA,WAAOa,OAAP;AACH,GAtDM,EAsDJ,EAtDI,CAAP;AAuDH,CAvED;AAwEA;AACA;AACA;;;AACA,MAAMgB,SAAS,GAAG,CAACL,KAAD,EAAaN,cAAb,KAAsD;AACpE,MAAI,CAACA,cAAL,EAAqB;AACjB,WAAOM,KAAP;AACH;;AACD,MAAIM,KAAK,CAACC,OAAN,CAAcP,KAAd,CAAJ,EAA0B;AACtB,WAAOA,KAAK,CAACJ,GAAN,CAAUY,CAAC,IAAId,cAAc,CAACc,CAAD,CAA7B,CAAP;AACH;;AACD,SAAOd,cAAc,CAACM,KAAD,CAArB;AACH,CARD;AASA;AACA;AACA;;;AACA,MAAMS,oBAAoB,GAAInD,MAAD,IAAoE;AAC7F,QAAM+B,OAAO,GAAGP,aAAa,CAACxB,MAAD,CAA7B;AACA;AACJ;AACA;AACA;;AACI,MAAI+B,OAAO,CAAChB,MAAR,KAAmB,CAAvB,EAA0B;AACtB,WAAO,IAAP;AACH;;AAED,SAAQqC,IAAD,IAAe;AAClB,SAAK,MAAMC,MAAX,IAAqBtB,OAArB,EAA8B;AAC1B,YAAMrB,MAAM,GAAG2C,MAAM,CAAChB,KAAP,CAAaiB,IAAb,CAAkBR,IAAI,IAAI;AACrC,cAAMJ,KAAK,GAAGK,SAAS,CAACQ,iBAAQC,GAAR,CAAYJ,IAAZ,EAAkBN,IAAlB,CAAD,EAA0BO,MAAM,CAACjB,cAAjC,CAAvB;AACA,cAAMJ,YAAY,GAAGe,SAAS,CAACM,MAAM,CAACrB,YAAR,EAAsBqB,MAAM,CAACjB,cAA7B,CAA9B;AACA,cAAMqB,OAAO,GAAGJ,MAAM,CAACR,YAAP,CAAoBa,OAApB,CAA4B;AACxChB,UAAAA,KADwC;AAExCV,UAAAA;AAFwC,SAA5B,CAAhB;AAKA,eAAOqB,MAAM,CAACnC,MAAP,GAAgB,CAACuC,OAAjB,GAA2BA,OAAlC;AACH,OATc,CAAf;;AAUA,UAAI/C,MAAM,KAAK,KAAf,EAAsB;AAClB,eAAO,KAAP;AACH;AACJ;;AACD,WAAO,IAAP;AACH,GAjBD;AAkBH,CA5BD;;AA8BO,MAAMiD,WAAW,GAAyB3D,MAAtB,IAAiD;AACxE,QAAMqD,MAAM,GAAGF,oBAAoB,CAACnD,MAAD,CAAnC;AACA;AACJ;AACA;;AACI,MAAI,CAACqD,MAAL,EAAa;AACT,WAAOrD,MAAM,CAAC4D,KAAd;AACH;;AACD,SAAO5D,MAAM,CAAC4D,KAAP,CAAaP,MAAb,CAAoBA,MAApB,CAAP;AACH,CATM","sourcesContent":["import dotProp from \"dot-prop\";\nimport WebinyError from \"@webiny/error\";\nimport { Plugin, PluginsContainer } from \"@webiny/plugins\";\nimport { ValueFilterPlugin } from \"~/plugins/definitions/ValueFilterPlugin\";\nimport { FieldPlugin } from \"~/plugins/definitions/FieldPlugin\";\nimport { DynamoDbContainsFilter } from \"~/types\";\n\ntype TransformValue = (value: any) => any;\n\nexport interface Params<T extends any = any> {\n    plugins: PluginsContainer;\n    items: T[];\n    where: Record<string, any>;\n    fields: FieldPlugin[];\n}\n\ninterface MappedPluginParams {\n    plugins: PluginsContainer;\n    type: string;\n    property: string;\n}\n\ninterface Filter {\n    compareValue: any;\n    filterPlugin: ValueFilterPlugin;\n    transformValue: TransformValue;\n    paths: string[];\n    negate: boolean;\n}\n\nconst getMappedPlugins = <T extends Plugin>(params: MappedPluginParams): Record<string, T> => {\n    return params.plugins.byType<T>(params.type).reduce((plugins, plugin) => {\n        const op = plugin[params.property];\n        plugins[op] = plugin;\n        return plugins;\n    }, {});\n};\n\nconst extractWhereArgs = (key: string) => {\n    const result = key.split(\"_\");\n    const field = result.shift();\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 { field, operation, negate };\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;\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            filters.push({\n                compareValue: data.value,\n                filterPlugin: findFilterPlugin(filterPlugins, key),\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;\n        if (fieldPlugin) {\n            transformValue = (value: any) => {\n                return fieldPlugin.transformValue(value);\n            };\n            path = fieldPlugin.getPath();\n        }\n\n        filters.push({\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 const filterItems = <T extends any = 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"],"file":"filter.js"}

package/utils/get.d.ts

@@ -0,0 +1,17 @@
+import { Entity } from "dynamodb-toolbox";
+export interface Params {
+    entity: Entity<any>;
+    keys: {
+        PK: string;
+        SK: string;
+    };
+}
+/**
+ * Gets a single record from the DynamoDB table.
+ * Returns either record or null.
+ *
+ * Be aware to wrap in try/catch to avoid the error killing your app.
+ *
+ * @throws
+ */
+export declare const get: <T>(params: Params) => Promise<T>;

package/utils/get.js

@@ -0,0 +1,31 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.get = void 0;
+
+/**
+ * Gets a single record from the DynamoDB table.
+ * Returns either record or null.
+ *
+ * Be aware to wrap in try/catch to avoid the error killing your app.
+ *
+ * @throws
+ */
+const get = async params => {
+  const {
+    entity,
+    keys
+  } = params;
+  const result = await entity.get(keys);
+
+  if (!result || !result.Item) {
+    return null;
+  }
+
+  return result.Item;
+};
+
+exports.get = get;
+//# sourceMappingURL=get.js.map

package/utils/get.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/utils/get.ts"],"names":["get","params","entity","keys","result","Item"],"mappings":";;;;;;;AAUA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMA,GAAG,GAAG,MAAUC,MAAV,IAAgD;AAC/D,QAAM;AAAEC,IAAAA,MAAF;AAAUC,IAAAA;AAAV,MAAmBF,MAAzB;AAEA,QAAMG,MAAM,GAAG,MAAMF,MAAM,CAACF,GAAP,CAAWG,IAAX,CAArB;;AAEA,MAAI,CAACC,MAAD,IAAW,CAACA,MAAM,CAACC,IAAvB,EAA6B;AACzB,WAAO,IAAP;AACH;;AACD,SAAOD,MAAM,CAACC,IAAd;AACH,CATM","sourcesContent":["import { Entity } from \"dynamodb-toolbox\";\n\nexport interface Params {\n    entity: Entity<any>;\n    keys: {\n        PK: string;\n        SK: string;\n    };\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: Params): Promise<T | null> => {\n    const { entity, keys } = params;\n\n    const result = await entity.get(keys);\n\n    if (!result || !result.Item) {\n        return null;\n    }\n    return result.Item;\n};\n"],"file":"get.js"}

package/utils/sort.js

@@ -31,8 +31,9 @@ const extractSort = (sortBy, fields) => {
   }
 
   const fieldPlugin = fields.find(f => f.getField() === field);
+  const isSortable = fieldPlugin ? fieldPlugin.isSortable() : true;
 
-  if (!fieldPlugin || fieldPlugin.isSortable() === false) {
+  if (isSortable === false) {
     throw new _error.default(`Cannot sort by given field: "${field}".`, "UNSUPPORTED_SORT_ERROR", {
       fields,
       field
@@ -51,11 +52,12 @@ const sortItems = params => {
     sort: initialSort = [],
     fields
   } = params;
+  /**
+   * Skip sorting if nothing was passed to sort by or nothing to sort.
+   */
 
-  if (items.length <= 1) {
+  if (items.length <= 1 || Array.isArray(initialSort) === false || initialSort.length === 0) {
     return items;
-  } else if (initialSort.length === 0) {
-    initialSort.push("createdOn_DESC");
   }
 
   const info = {
@@ -64,6 +66,9 @@ const sortItems = params => {
   };
 
   for (const sort of initialSort) {
+    /**
+     * Possibly empty array item was passed.
+     */
     if (!sort) {
       continue;
     }
@@ -78,6 +83,10 @@ const sortItems = params => {
     info.orders.push(reverse === true ? "desc" : "asc");
   }
 
+  if (info.sorters.length === 0) {
+    return items;
+  }
+
   return (0, _orderBy.default)(items, info.sorters, info.orders);
 };
 

package/utils/sort.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utils/sort.ts"],"names":["extractSort","sortBy","fields","result","split","length","WebinyError","field","order","fieldPlugin","find","f","getField","isSortable","reverse","toUpperCase","sortItems","params","items","sort","initialSort","push","info","sorters","orders","path","getPath"],"mappings":";;;;;;;;;AAAA;;AACA;;AAYA,MAAMA,WAAW,GAAG,CAACC,MAAD,EAAiBC,MAAjB,KAA8D;AAC9E,QAAMC,MAAM,GAAGF,MAAM,CAACG,KAAP,CAAa,GAAb,CAAf;;AACA,MAAID,MAAM,CAACE,MAAP,KAAkB,CAAtB,EAAyB;AACrB,UAAM,IAAIC,cAAJ,CACF,yDADE,EAEF,YAFE,EAGF;AACIL,MAAAA;AADJ,KAHE,CAAN;AAOH;;AACD,QAAM,CAACM,KAAD,EAAQC,KAAR,IAAiBL,MAAvB;;AAEA,MAAI,CAACI,KAAL,EAAY;AACR,UAAM,IAAID,cAAJ,CAAgB,+BAAhB,EAAiD,qBAAjD,EAAwE;AAC1EC,MAAAA,KAD0E;AAE1EC,MAAAA,KAF0E;AAG1EN,MAAAA;AAH0E,KAAxE,CAAN;AAKH;;AACD,QAAMO,WAAW,GAAGP,MAAM,CAACQ,IAAP,CAAYC,CAAC,IAAIA,CAAC,CAACC,QAAF,OAAiBL,KAAlC,CAApB;;AACA,MAAI,CAACE,WAAD,IAAgBA,WAAW,CAACI,UAAZ,OAA6B,KAAjD,EAAwD;AACpD,UAAM,IAAIP,cAAJ,CAAiB,gCAA+BC,KAAM,IAAtD,EAA2D,wBAA3D,EAAqF;AACvFL,MAAAA,MADuF;AAEvFK,MAAAA;AAFuF,KAArF,CAAN;AAIH;;AAED,SAAO;AACHA,IAAAA,KADG;AAEHO,IAAAA,OAAO,EAAEN,KAAK,CAACO,WAAN,OAAwB;AAF9B,GAAP;AAIH,CAhCD;;AAgDO,MAAMC,SAAS,GAAyBC,MAAtB,IAAiD;AACtE,QAAM;AAAEC,IAAAA,KAAF;AAASC,IAAAA,IAAI,EAAEC,WAAW,GAAG,EAA7B;AAAiClB,IAAAA;AAAjC,MAA4Ce,MAAlD;;AACA,MAAIC,KAAK,CAACb,MAAN,IAAgB,CAApB,EAAuB;AACnB,WAAOa,KAAP;AACH,GAFD,MAEO,IAAIE,WAAW,CAACf,MAAZ,KAAuB,CAA3B,EAA8B;AACjCe,IAAAA,WAAW,CAACC,IAAZ,CAAiB,gBAAjB;AACH;;AAED,QAAMC,IAAa,GAAG;AAClBC,IAAAA,OAAO,EAAE,EADS;AAElBC,IAAAA,MAAM,EAAE;AAFU,GAAtB;;AAKA,OAAK,MAAML,IAAX,IAAmBC,WAAnB,EAAgC;AAC5B,QAAI,CAACD,IAAL,EAAW;AACP;AACH;;AACD,UAAM;AAAEZ,MAAAA,KAAF;AAASO,MAAAA;AAAT,QAAqBd,WAAW,CAACmB,IAAD,EAAOjB,MAAP,CAAtC;AACA,UAAMO,WAAW,GAAGP,MAAM,CAACQ,IAAP,CAAYC,CAAC,IAAIA,CAAC,CAACC,QAAF,OAAiBL,KAAlC,CAApB;AACA,UAAMkB,IAAI,GAAGhB,WAAW,GAAGA,WAAW,CAACiB,OAAZ,EAAH,GAA2BnB,KAAnD;AAEAe,IAAAA,IAAI,CAACC,OAAL,CAAaF,IAAb,CAAkBI,IAAlB;AACAH,IAAAA,IAAI,CAACE,MAAL,CAAYH,IAAZ,CAAiBP,OAAO,KAAK,IAAZ,GAAmB,MAAnB,GAA4B,KAA7C;AACH;;AAED,SAAO,sBAAcI,KAAd,EAAqBI,IAAI,CAACC,OAA1B,EAAmCD,IAAI,CAACE,MAAxC,CAAP;AACH,CA1BM","sourcesContent":["import lodashOrderBy from \"lodash/orderBy\";\nimport WebinyError from \"@webiny/error\";\nimport { FieldPlugin } from \"~/plugins/definitions/FieldPlugin\";\n\ninterface Sorters {\n    sorters: string[];\n    orders: string[];\n}\n\ninterface ExtractSortResult {\n    reverse: boolean;\n    field: string;\n}\nconst extractSort = (sortBy: string, fields: FieldPlugin[]): ExtractSortResult => {\n    const result = sortBy.split(\"_\");\n    if (result.length !== 2) {\n        throw new WebinyError(\n            \"Problem in determining the sorting for the entry items.\",\n            \"SORT_ERROR\",\n            {\n                sortBy\n            }\n        );\n    }\n    const [field, order] = result;\n\n    if (!field) {\n        throw new WebinyError(\"Sorting field does not exist.\", \"SORTING_FIELD_ERROR\", {\n            field,\n            order,\n            fields\n        });\n    }\n    const fieldPlugin = fields.find(f => f.getField() === field);\n    if (!fieldPlugin || fieldPlugin.isSortable() === false) {\n        throw new WebinyError(`Cannot sort by given field: \"${field}\".`, \"UNSUPPORTED_SORT_ERROR\", {\n            fields,\n            field\n        });\n    }\n\n    return {\n        field,\n        reverse: order.toUpperCase() === \"DESC\"\n    };\n};\n\ninterface Params<T> {\n    /**\n     * The items we are sorting.\n     */\n    items: T[];\n    /**\n     * Sort options. For example: [\"id_ASC\"]\n     */\n    sort: string[];\n    /**\n     * Fields we can sort by.\n     */\n    fields: FieldPlugin[];\n}\nexport const sortItems = <T extends any = any>(params: Params<T>): T[] => {\n    const { items, sort: initialSort = [], fields } = params;\n    if (items.length <= 1) {\n        return items;\n    } else if (initialSort.length === 0) {\n        initialSort.push(\"createdOn_DESC\");\n    }\n\n    const info: Sorters = {\n        sorters: [],\n        orders: []\n    };\n\n    for (const sort of initialSort) {\n        if (!sort) {\n            continue;\n        }\n        const { field, reverse } = extractSort(sort, fields);\n        const fieldPlugin = fields.find(f => f.getField() === field);\n        const path = fieldPlugin ? fieldPlugin.getPath() : field;\n\n        info.sorters.push(path);\n        info.orders.push(reverse === true ? \"desc\" : \"asc\");\n    }\n\n    return lodashOrderBy(items, info.sorters, info.orders);\n};\n"],"file":"sort.js"}
+{"version":3,"sources":["../../src/utils/sort.ts"],"names":["extractSort","sortBy","fields","result","split","length","WebinyError","field","order","fieldPlugin","find","f","getField","isSortable","reverse","toUpperCase","sortItems","params","items","sort","initialSort","Array","isArray","info","sorters","orders","path","getPath","push"],"mappings":";;;;;;;;;AAAA;;AACA;;AAaA,MAAMA,WAAW,GAAG,CAACC,MAAD,EAAiBC,MAAjB,KAAqD;AACrE,QAAMC,MAAM,GAAGF,MAAM,CAACG,KAAP,CAAa,GAAb,CAAf;;AACA,MAAID,MAAM,CAACE,MAAP,KAAkB,CAAtB,EAAyB;AACrB,UAAM,IAAIC,cAAJ,CACF,yDADE,EAEF,YAFE,EAGF;AACIL,MAAAA;AADJ,KAHE,CAAN;AAOH;;AACD,QAAM,CAACM,KAAD,EAAQC,KAAR,IAAiBL,MAAvB;;AAEA,MAAI,CAACI,KAAL,EAAY;AACR,UAAM,IAAID,cAAJ,CAAgB,+BAAhB,EAAiD,qBAAjD,EAAwE;AAC1EC,MAAAA,KAD0E;AAE1EC,MAAAA,KAF0E;AAG1EN,MAAAA;AAH0E,KAAxE,CAAN;AAKH;;AACD,QAAMO,WAAW,GAAGP,MAAM,CAACQ,IAAP,CAAYC,CAAC,IAAIA,CAAC,CAACC,QAAF,OAAiBL,KAAlC,CAApB;AACA,QAAMM,UAAU,GAAGJ,WAAW,GAAGA,WAAW,CAACI,UAAZ,EAAH,GAA8B,IAA5D;;AACA,MAAIA,UAAU,KAAK,KAAnB,EAA0B;AACtB,UAAM,IAAIP,cAAJ,CAAiB,gCAA+BC,KAAM,IAAtD,EAA2D,wBAA3D,EAAqF;AACvFL,MAAAA,MADuF;AAEvFK,MAAAA;AAFuF,KAArF,CAAN;AAIH;;AAED,SAAO;AACHA,IAAAA,KADG;AAEHO,IAAAA,OAAO,EAAEN,KAAK,CAACO,WAAN,OAAwB;AAF9B,GAAP;AAIH,CAjCD;;AAkDO,MAAMC,SAAS,GAAyBC,MAAtB,IAAiD;AACtE,QAAM;AAAEC,IAAAA,KAAF;AAASC,IAAAA,IAAI,EAAEC,WAAW,GAAG,EAA7B;AAAiClB,IAAAA;AAAjC,MAA4Ce,MAAlD;AACA;AACJ;AACA;;AACI,MAAIC,KAAK,CAACb,MAAN,IAAgB,CAAhB,IAAqBgB,KAAK,CAACC,OAAN,CAAcF,WAAd,MAA+B,KAApD,IAA6DA,WAAW,CAACf,MAAZ,KAAuB,CAAxF,EAA2F;AACvF,WAAOa,KAAP;AACH;;AAED,QAAMK,IAAU,GAAG;AACfC,IAAAA,OAAO,EAAE,EADM;AAEfC,IAAAA,MAAM,EAAE;AAFO,GAAnB;;AAKA,OAAK,MAAMN,IAAX,IAAmBC,WAAnB,EAAgC;AAC5B;AACR;AACA;AACQ,QAAI,CAACD,IAAL,EAAW;AACP;AACH;;AACD,UAAM;AAAEZ,MAAAA,KAAF;AAASO,MAAAA;AAAT,QAAqBd,WAAW,CAACmB,IAAD,EAAOjB,MAAP,CAAtC;AACA,UAAMO,WAAW,GAAGP,MAAM,CAACQ,IAAP,CAAYC,CAAC,IAAIA,CAAC,CAACC,QAAF,OAAiBL,KAAlC,CAApB;AACA,UAAMmB,IAAI,GAAGjB,WAAW,GAAGA,WAAW,CAACkB,OAAZ,EAAH,GAA2BpB,KAAnD;AAEAgB,IAAAA,IAAI,CAACC,OAAL,CAAaI,IAAb,CAAkBF,IAAlB;AACAH,IAAAA,IAAI,CAACE,MAAL,CAAYG,IAAZ,CAAiBd,OAAO,KAAK,IAAZ,GAAmB,MAAnB,GAA4B,KAA7C;AACH;;AAED,MAAIS,IAAI,CAACC,OAAL,CAAanB,MAAb,KAAwB,CAA5B,EAA+B;AAC3B,WAAOa,KAAP;AACH;;AAED,SAAO,sBAAcA,KAAd,EAAqBK,IAAI,CAACC,OAA1B,EAAmCD,IAAI,CAACE,MAAxC,CAAP;AACH,CAlCM","sourcesContent":["import lodashOrderBy from \"lodash/orderBy\";\nimport WebinyError from \"@webiny/error\";\nimport { FieldPlugin } from \"~/plugins/definitions/FieldPlugin\";\n\ninterface Info {\n    sorters: string[];\n    orders: string[];\n}\n\ninterface Response {\n    reverse: boolean;\n    field: string;\n}\n\nconst extractSort = (sortBy: string, fields: FieldPlugin[]): Response => {\n    const result = sortBy.split(\"_\");\n    if (result.length !== 2) {\n        throw new WebinyError(\n            \"Problem in determining the sorting for the entry items.\",\n            \"SORT_ERROR\",\n            {\n                sortBy\n            }\n        );\n    }\n    const [field, order] = result;\n\n    if (!field) {\n        throw new WebinyError(\"Sorting field does not exist.\", \"SORTING_FIELD_ERROR\", {\n            field,\n            order,\n            fields\n        });\n    }\n    const fieldPlugin = fields.find(f => f.getField() === field);\n    const isSortable = fieldPlugin ? fieldPlugin.isSortable() : true;\n    if (isSortable === false) {\n        throw new WebinyError(`Cannot sort by given field: \"${field}\".`, \"UNSUPPORTED_SORT_ERROR\", {\n            fields,\n            field\n        });\n    }\n\n    return {\n        field,\n        reverse: order.toUpperCase() === \"DESC\"\n    };\n};\n\ninterface Params<T> {\n    /**\n     * The items we are sorting.\n     */\n    items: T[];\n    /**\n     * Sort options. For example: [\"id_ASC\"]\n     */\n    sort: string[];\n    /**\n     * Fields we can sort by.\n     */\n    fields: FieldPlugin[];\n}\n\nexport const sortItems = <T extends any = any>(params: Params<T>): T[] => {\n    const { items, sort: initialSort = [], fields } = params;\n    /**\n     * Skip sorting if nothing was passed to sort by or nothing to sort.\n     */\n    if (items.length <= 1 || Array.isArray(initialSort) === false || initialSort.length === 0) {\n        return items;\n    }\n\n    const info: Info = {\n        sorters: [],\n        orders: []\n    };\n\n    for (const sort of initialSort) {\n        /**\n         * Possibly empty array item was passed.\n         */\n        if (!sort) {\n            continue;\n        }\n        const { field, reverse } = extractSort(sort, fields);\n        const fieldPlugin = fields.find(f => f.getField() === field);\n        const path = fieldPlugin ? fieldPlugin.getPath() : field;\n\n        info.sorters.push(path);\n        info.orders.push(reverse === true ? \"desc\" : \"asc\");\n    }\n\n    if (info.sorters.length === 0) {\n        return items;\n    }\n\n    return lodashOrderBy(items, info.sorters, info.orders);\n};\n"],"file":"sort.js"}

package/utils/table.d.ts

@@ -1,2 +1,7 @@
 import { DbContext } from "@webiny/handler-db/types";
+/**
+ * Will be removed in favor of passing the table name directly to the storage operations.
+ *
+ * @deprecated
+ */
 export declare const getTable: <T extends DbContext>(context: T) => string;

package/utils/table.js

@@ -9,6 +9,11 @@ exports.getTable = void 0;
 
 var _error = _interopRequireDefault(require("@webiny/error"));
 
+/**
+ * Will be removed in favor of passing the table name directly to the storage operations.
+ *
+ * @deprecated
+ */
 const getTable = context => {
   if (!context.db) {
     throw new _error.default("Missing db on context.", "DB_ERROR");

package/utils/table.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utils/table.ts"],"names":["getTable","context","db","WebinyError","table"],"mappings":";;;;;;;;;AAAA;;AAGO,MAAMA,QAAQ,GAAyBC,OAAtB,IAA6C;AACjE,MAAI,CAACA,OAAO,CAACC,EAAb,EAAiB;AACb,UAAM,IAAIC,cAAJ,CAAgB,wBAAhB,EAA0C,UAA1C,CAAN;AACH,GAFD,MAEO,IAAI,CAACF,OAAO,CAACC,EAAR,CAAWE,KAAhB,EAAuB;AAC1B,UAAM,IAAID,cAAJ,CAAgB,8BAAhB,EAAgD,aAAhD,CAAN;AACH;;AACD,SAAOF,OAAO,CAACC,EAAR,CAAWE,KAAlB;AACH,CAPM","sourcesContent":["import WebinyError from \"@webiny/error\";\nimport { DbContext } from \"@webiny/handler-db/types\";\n\nexport const getTable = <T extends DbContext>(context: T): string => {\n    if (!context.db) {\n        throw new WebinyError(\"Missing db on context.\", \"DB_ERROR\");\n    } else if (!context.db.table) {\n        throw new WebinyError(\"Missing table on context.db.\", \"TABLE_ERROR\");\n    }\n    return context.db.table;\n};\n"],"file":"table.js"}
+{"version":3,"sources":["../../src/utils/table.ts"],"names":["getTable","context","db","WebinyError","table"],"mappings":";;;;;;;;;AAAA;;AAGA;AACA;AACA;AACA;AACA;AACO,MAAMA,QAAQ,GAAyBC,OAAtB,IAA6C;AACjE,MAAI,CAACA,OAAO,CAACC,EAAb,EAAiB;AACb,UAAM,IAAIC,cAAJ,CAAgB,wBAAhB,EAA0C,UAA1C,CAAN;AACH,GAFD,MAEO,IAAI,CAACF,OAAO,CAACC,EAAR,CAAWE,KAAhB,EAAuB;AAC1B,UAAM,IAAID,cAAJ,CAAgB,8BAAhB,EAAgD,aAAhD,CAAN;AACH;;AACD,SAAOF,OAAO,CAACC,EAAR,CAAWE,KAAlB;AACH,CAPM","sourcesContent":["import WebinyError from \"@webiny/error\";\nimport { DbContext } from \"@webiny/handler-db/types\";\n\n/**\n * Will be removed in favor of passing the table name directly to the storage operations.\n *\n * @deprecated\n */\nexport const getTable = <T extends DbContext>(context: T): string => {\n    if (!context.db) {\n        throw new WebinyError(\"Missing db on context.\", \"DB_ERROR\");\n    } else if (!context.db.table) {\n        throw new WebinyError(\"Missing table on context.db.\", \"TABLE_ERROR\");\n    }\n    return context.db.table;\n};\n"],"file":"table.js"}