- BREAKING CHANGE: replace default import with named import.

- upgrade dependencies
- rename `query` to `body` in search method to avoid confusion

Author: jimmyn

README.md

@@ -14,7 +14,7 @@ yarn add aws-elasticsearch-model
 
 ```typescript
 import AWS from 'aws-sdk';
-import ElasticModel from 'aws-elasticsearch-model';
+import {ElasticModel} from 'aws-elasticsearch-model';
 
 /*
  ElasticModel uses aws-sdk's default behaviour to obtain region + credentials from your environment. 
@@ -61,7 +61,7 @@ Attach this lambda handler to your DynamoDB table and it will sync all the data
 
 ```typescript
 import {DynamoDBStreamEvent} from 'aws-lambda';
-import ElasticModel from 'aws-elasticsearch-model';
+import {ElasticModel} from 'aws-elasticsearch-model';
 
 const elasticModel = new ElasticModel({
   host: 'https://my-aws-elasticsearch-domain.eu-west-1.es.amazonaws.com',

package.json

@@ -56,25 +56,25 @@
     }
   },
   "devDependencies": {
-    "@types/aws-lambda": "^8.10.39",
+    "@types/aws-lambda": "^8.10.40",
     "@types/elasticsearch": "^5.0.36",
-    "@types/faker": "^4.1.8",
+    "@types/faker": "^4.1.9",
     "@types/http-aws-es": "^6.0.0",
-    "@types/jest": "^24.0.25",
-    "aws-lambda": "latest",
-    "aws-sdk": "^2.597.0",
+    "@types/jest": "^25.1.0",
+    "aws-lambda": "1.0.5",
+    "aws-sdk": "^2.610.0",
     "dotenv": "^8.2.0",
     "faker": "latest",
-    "husky": "^3.1.0",
+    "husky": "^4.2.1",
     "release-it": "^12.4.3",
-    "tsdx": "^0.12.1",
+    "tsdx": "^0.12.3",
     "tslib": "^1.10.0",
-    "typescript": "^3.7.4"
+    "typescript": "^3.7.5"
   },
   "dependencies": {
     "bodybuilder": "^2.2.20",
     "dynamodb-data-types": "^3.0.1",
-    "elasticsearch": "^16.5.0",
+    "elasticsearch": "16.6.0",
     "http-aws-es": "^6.0.0"
   }
 }

src/index.ts

@@ -61,7 +61,7 @@ export interface IElasticModelConfig {
   excludedFields?: string[];
 }
 
-class ElasticModel<T extends Item> {
+export class ElasticModel<T extends Item> {
   client: Client;
   protected index: string;
   protected idField: string;
@@ -116,12 +116,12 @@ class ElasticModel<T extends Item> {
 
   /**
    * Executes search query
-   * @param query - search query
+   * @param body - search request body
    */
-  async search(query: Query): Promise<ISearchResult<T>> {
+  async search(body: Query): Promise<ISearchResult<T>> {
     const params = {
       index: this.index,
-      body: query
+      body
     };
     const response = await this.client.search<T>(params);
     let total: number;
@@ -230,5 +230,3 @@ class ElasticModel<T extends Item> {
     return this.client.indices.create(params);
   }
 }
-
-export default ElasticModel;