Merge pull request #27 from polarityio/develop

Add search term normalization, remove v4, update dependencies, fix tests

Author: sarus

.github/workflows/run-int-dev-checklist.yml

@@ -10,14 +10,16 @@ jobs:
     container: 'rockylinux:8'
 
     steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-node@v1
-    - name: Test NPM Install
-      id: test-npm-install
-      run: |
-        npm ci
-    - name: Polarity Integration Development Checklist
-      id: int-dev-checklist
-      uses: polarityio/polarity-integration-development-checklist@main
-      with:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - uses: actions/checkout@v6
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '18'
+      - name: Test NPM Install
+        id: test-npm-install
+        run: |
+          npm ci
+      - name: Polarity Integration Development Checklist
+        id: int-dev-checklist
+        uses: polarityio/polarity-integration-development-checklist@main
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -58,19 +58,19 @@ You should not specify `size` and `from` parameters as these parameters are cont
 As an example, with the search query defined as:
 
 ```
-{"query": { "simple_query_string": { "query": "\"{{entity}}\"" } }, "sort": [ {"timestamp": "desc" } ] } }
+{"query": { "simple_query_string": { "query": "\"{{entity}}\"" } }, "sort": [ {"timestamp": "desc" } ] }
 ```
 
 If the user has the IP 8.8.8.8 on their screen the integration will execute the following query:
 
 ```
-{"query": { "simple_query_string": { "query": "\"8.8.8.8\"" } }, "sort": [ {"timestamp": "desc" } ] } }
+{"query": { "simple_query_string": { "query": "\"8.8.8.8\"" } }, "sort": [ {"timestamp": "desc" } ] }
 ```
 
 If you'd like to search certain fields you can use the `fields` property along with the `simple_query_string`.  For example, to only search the `ip` field you could use the following search:
 
 ```
-{"query": { "simple_query_string": { "query": "\"{{entity}}\"", "fields": ["ip"]}}, "sort": [ {"timestamp": "desc" } ] } }
+{"query": { "simple_query_string": { "query": "\"{{entity}}\"", "fields": ["ip"]}}, "sort": [ {"timestamp": "desc" } ] }
 ```
 
 If you'd like to search a specific time range you can do that using normal Elasticsearch JSON search syntax.  For example, do search data from the last 365 days you can use the following query assuming your timestamp field is called `timestamp`.  
@@ -143,6 +143,17 @@ Maximum number of concurrent search requests (defaults to 10). Integration must
 
 Minimum amount of time in milliseconds between each entity search (defaults to 50). Integration must be restarted after changing this option.
 
+### Search Term Normalization
+
+Normalize the search term by applying a normalization function to the entity. If set, all entities will be normalized. Defaults to "None".
+
+Valid options are:
+
+* Lowercase the search term
+* Uppercase the search term
+* Search term matches input
+* None - Use Polarity default casing
+
 ## Installation Instructions
 
 Installation instructions for integrations are provided on the [PolarityIO GitHub Page](https://polarityio.github.io/).

config/config.js

@@ -210,6 +210,37 @@
       "type": "boolean",
       "userCanEdit": false,
       "adminOnly": true
+    },
+    {
+      "key": "searchTermNormalization",
+      "name": "Search Term Normalization",
+      "description": "Modify the casing of the search term (i.e., {{ENTITY}}), by applying a normalization function to the entity.  If set, all entities will be normalized. Defaults to \"None\".",
+      "default": {
+        "value": "none",
+        "display": "None - use Polarity default casing"
+      },
+      "type": "select",
+      "options": [
+        {
+          "value": "none",
+          "display": "None - use Polarity default casing"
+        },
+        {
+          "value": "lower",
+          "display": "Lowercase the search term"
+        },
+        {
+          "value": "upper",
+          "display": "Uppercase the search term"
+        },
+        {
+          "value": "exact",
+          "display": "Search term matches input"
+        }
+      ],
+      "multiple": false,
+      "userCanEdit": false,
+      "adminOnly": true
     }
   ]
 }