pelias-schema - npm Package Compare versions

Comparing version 5.3.0 to 5.4.0

mappings/document.js

@@ -29,3 +29,4 @@ const admin = require('./partial/admin');
           analyzer: 'keyword',
-          search_analyzer: 'keyword'
+          search_analyzer: 'keyword',
+          similarity: 'peliasDefaultSimilarity'
         },
@@ -35,3 +36,4 @@ unit: {
           analyzer: 'peliasUnit',
-          search_analyzer: 'peliasUnit'
+          search_analyzer: 'peliasUnit',
+          similarity: 'peliasDefaultSimilarity'
         },
@@ -41,3 +43,4 @@ number: {
           analyzer: 'peliasHousenumber',
-          search_analyzer: 'peliasHousenumber'
+          search_analyzer: 'peliasHousenumber',
+          similarity: 'peliasDefaultSimilarity'
         },
@@ -47,3 +50,4 @@ street: {
           analyzer: 'peliasStreet',
-          search_analyzer: 'peliasStreet'
+          search_analyzer: 'peliasStreet',
+          similarity: 'peliasDefaultSimilarity'
         },
@@ -53,3 +57,4 @@ cross_street: {
           analyzer: 'peliasStreet',
-          search_analyzer: 'peliasStreet'
+          search_analyzer: 'peliasStreet',
+          similarity: 'peliasDefaultSimilarity'
         },
@@ -59,3 +64,4 @@ zip: {
           analyzer: 'peliasZip',
-          search_analyzer: 'peliasZip'
+          search_analyzer: 'peliasZip',
+          similarity: 'peliasDefaultSimilarity'
         },
@@ -168,3 +174,4 @@ }
         analyzer: 'peliasIndexOneEdgeGram',
-        search_analyzer: 'peliasQuery'
+        search_analyzer: 'peliasQuery',
+        similarity: 'peliasDefaultSimilarity'
       }
@@ -179,3 +186,4 @@ },
         analyzer: 'peliasPhrase',
-        search_analyzer: 'peliasQuery'
+        search_analyzer: 'peliasQuery',
+        similarity: 'peliasDefaultSimilarity'
       }
@@ -182,0 +190,0 @@ }

mappings/partial/admin.json

@@ -5,2 +5,3 @@ {
   "search_analyzer": "peliasAdmin",
+  "similarity": "peliasDefaultSimilarity",
   "fields": {
@@ -11,2 +12,3 @@ "ngram": {
       "search_analyzer": "peliasAdmin",
+      "similarity": "peliasDefaultSimilarity",
       "doc_values": false
@@ -13,0 +15,0 @@ }

mappings/partial/postalcode.json

@@ -5,2 +5,3 @@ {
   "search_analyzer": "peliasZip",
+  "similarity": "peliasDefaultSimilarity",
   "fields": {
@@ -10,5 +11,6 @@ "ngram": {
       "analyzer": "peliasIndexOneEdgeGram",
-      "search_analyzer": "peliasZip"
+      "search_analyzer": "peliasZip",
+      "similarity": "peliasDefaultSimilarity"
     }
   }
 }

package.json

 {
   "name": "pelias-schema",
-  "version": "5.3.0",
+  "version": "5.4.0",
   "author": "pelias",
@@ -5,0 +5,0 @@ "description": "Elasticsearch schema files and tooling for Pelias",

settings.js

@@ -26,2 +26,11 @@ const _ = require('lodash');
   var settings = {
+    "index": {
+      "similarity": {
+        "peliasDefaultSimilarity": {
+          "type": "BM25",
+          "k1": 1.2,
+          "b": 0.75
+        }
+      }
+    },
     "analysis": {
@@ -215,15 +224,11 @@ "tokenizer": {
   // each filter is given the same name as the file, minus the extension.
-  for( var key in synonyms ){
+  _.each(synonyms, (synonym, key) => {
     settings.analysis.filter[key] = {
       "type": "synonym",
-      "synonyms": !!synonyms[key].length ? synonyms[key] : ['']
+      "synonyms": !_.isEmpty(synonym) ? synonym : ['']
     };
-  }
+  })
 
   // Merge settings from pelias/config
-  if( 'object' === typeof config &&
-      'object' === typeof config.elasticsearch &&
-      'object' === typeof config.elasticsearch.settings ){
-    return _.merge({}, settings, config.elasticsearch.settings);
-  }
+  settings = _.merge({}, settings, _.get(config, 'elasticsearch.settings', {}));
 
@@ -230,0 +235,0 @@ return settings;

test/compile.js

@@ -46,3 +46,4 @@ const _ = require('lodash');
       analyzer: 'peliasIndexOneEdgeGram',
-      search_analyzer: 'peliasQuery'
+      search_analyzer: 'peliasQuery',
+      similarity: 'peliasDefaultSimilarity'
     });
@@ -59,3 +60,4 @@ t.end();
       analyzer: 'peliasPhrase',
-      search_analyzer: 'peliasQuery'
+      search_analyzer: 'peliasQuery',
+      similarity: 'peliasDefaultSimilarity'
     });
@@ -62,0 +64,0 @@ t.end();

test/fixtures/expected.json

 {
   "settings": {
+    "index": {
+      "similarity": {
+        "peliasDefaultSimilarity": {
+          "type": "BM25",
+          "k1": 1.2,
+          "b": 0.75
+        }
+      },
+      "number_of_replicas": "999",
+      "number_of_shards": "5",
+      "refresh_interval": "1m"
+    },
     "analysis": {
@@ -567,7 +579,2 @@ "tokenizer": {
       }
-    },
-    "index": {
-      "number_of_replicas": "999",
-      "number_of_shards": "5",
-      "refresh_interval": "1m"
     }
@@ -598,3 +605,4 @@ },
             "analyzer": "keyword",
-            "search_analyzer": "keyword"
+            "search_analyzer": "keyword",
+            "similarity": "peliasDefaultSimilarity"
           },
@@ -604,3 +612,4 @@ "unit": {
             "analyzer": "peliasUnit",
-            "search_analyzer": "peliasUnit"
+            "search_analyzer": "peliasUnit",
+            "similarity": "peliasDefaultSimilarity"
           },
@@ -610,3 +619,4 @@ "number": {
             "analyzer": "peliasHousenumber",
-            "search_analyzer": "peliasHousenumber"
+            "search_analyzer": "peliasHousenumber",
+            "similarity": "peliasDefaultSimilarity"
           },
@@ -616,3 +626,4 @@ "street": {
             "analyzer": "peliasStreet",
-            "search_analyzer": "peliasStreet"
+            "search_analyzer": "peliasStreet",
+            "similarity": "peliasDefaultSimilarity"
           },
@@ -622,3 +633,4 @@ "cross_street": {
             "analyzer": "peliasStreet",
-            "search_analyzer": "peliasStreet"
+            "search_analyzer": "peliasStreet",
+            "similarity": "peliasDefaultSimilarity"
           },
@@ -628,3 +640,4 @@ "zip": {
             "analyzer": "peliasZip",
-            "search_analyzer": "peliasZip"
+            "search_analyzer": "peliasZip",
+            "similarity": "peliasDefaultSimilarity"
           }
@@ -641,2 +654,3 @@ }
             "search_analyzer": "peliasAdmin",
+            "similarity": "peliasDefaultSimilarity",
             "fields": {
@@ -647,2 +661,3 @@ "ngram": {
                 "search_analyzer": "peliasAdmin",
+                "similarity": "peliasDefaultSimilarity",
                 "doc_values": false
@@ -656,2 +671,3 @@ }
             "search_analyzer": "peliasAdmin",
+            "similarity": "peliasDefaultSimilarity",
             "fields": {
@@ -662,2 +678,3 @@ "ngram": {
                 "search_analyzer": "peliasAdmin",
+                "similarity": "peliasDefaultSimilarity",
                 "doc_values": false
@@ -675,2 +692,3 @@ }
             "search_analyzer": "peliasAdmin",
+            "similarity": "peliasDefaultSimilarity",
             "fields": {
@@ -681,2 +699,3 @@ "ngram": {
                 "search_analyzer": "peliasAdmin",
+                "similarity": "peliasDefaultSimilarity",
                 "doc_values": false
@@ -690,2 +709,3 @@ }
             "search_analyzer": "peliasAdmin",
+            "similarity": "peliasDefaultSimilarity",
             "fields": {
@@ -696,2 +716,3 @@ "ngram": {
                 "search_analyzer": "peliasAdmin",
+                "similarity": "peliasDefaultSimilarity",
                 "doc_values": false
@@ -709,2 +730,3 @@ }
             "search_analyzer": "peliasAdmin",
+            "similarity": "peliasDefaultSimilarity",
             "fields": {
@@ -715,2 +737,3 @@ "ngram": {
                 "search_analyzer": "peliasAdmin",
+                "similarity": "peliasDefaultSimilarity",
                 "doc_values": false
@@ -724,2 +747,3 @@ }
             "search_analyzer": "peliasAdmin",
+            "similarity": "peliasDefaultSimilarity",
             "fields": {
@@ -730,2 +754,3 @@ "ngram": {
                 "search_analyzer": "peliasAdmin",
+                "similarity": "peliasDefaultSimilarity",
                 "doc_values": false
@@ -743,2 +768,3 @@ }
             "search_analyzer": "peliasAdmin",
+            "similarity": "peliasDefaultSimilarity",
             "fields": {
@@ -749,2 +775,3 @@ "ngram": {
                 "search_analyzer": "peliasAdmin",
+                "similarity": "peliasDefaultSimilarity",
                 "doc_values": false
@@ -758,2 +785,3 @@ }
             "search_analyzer": "peliasAdmin",
+            "similarity": "peliasDefaultSimilarity",
             "fields": {
@@ -764,2 +792,3 @@ "ngram": {
                 "search_analyzer": "peliasAdmin",
+                "similarity": "peliasDefaultSimilarity",
                 "doc_values": false
@@ -777,2 +806,3 @@ }
             "search_analyzer": "peliasAdmin",
+            "similarity": "peliasDefaultSimilarity",
             "fields": {
@@ -783,2 +813,3 @@ "ngram": {
                 "search_analyzer": "peliasAdmin",
+                "similarity": "peliasDefaultSimilarity",
                 "doc_values": false
@@ -792,2 +823,3 @@ }
             "search_analyzer": "peliasAdmin",
+            "similarity": "peliasDefaultSimilarity",
             "fields": {
@@ -798,2 +830,3 @@ "ngram": {
                 "search_analyzer": "peliasAdmin",
+                "similarity": "peliasDefaultSimilarity",
                 "doc_values": false
@@ -811,2 +844,3 @@ }
             "search_analyzer": "peliasAdmin",
+            "similarity": "peliasDefaultSimilarity",
             "fields": {
@@ -817,2 +851,3 @@ "ngram": {
                 "search_analyzer": "peliasAdmin",
+                "similarity": "peliasDefaultSimilarity",
                 "doc_values": false
@@ -826,2 +861,3 @@ }
             "search_analyzer": "peliasAdmin",
+            "similarity": "peliasDefaultSimilarity",
             "fields": {
@@ -832,2 +868,3 @@ "ngram": {
                 "search_analyzer": "peliasAdmin",
+                "similarity": "peliasDefaultSimilarity",
                 "doc_values": false
@@ -845,2 +882,3 @@ }
             "search_analyzer": "peliasAdmin",
+            "similarity": "peliasDefaultSimilarity",
             "fields": {
@@ -851,2 +889,3 @@ "ngram": {
                 "search_analyzer": "peliasAdmin",
+                "similarity": "peliasDefaultSimilarity",
                 "doc_values": false
@@ -860,2 +899,3 @@ }
             "search_analyzer": "peliasAdmin",
+            "similarity": "peliasDefaultSimilarity",
             "fields": {
@@ -866,2 +906,3 @@ "ngram": {
                 "search_analyzer": "peliasAdmin",
+                "similarity": "peliasDefaultSimilarity",
                 "doc_values": false
@@ -879,2 +920,3 @@ }
             "search_analyzer": "peliasAdmin",
+            "similarity": "peliasDefaultSimilarity",
             "fields": {
@@ -885,2 +927,3 @@ "ngram": {
                 "search_analyzer": "peliasAdmin",
+                "similarity": "peliasDefaultSimilarity",
                 "doc_values": false
@@ -894,2 +937,3 @@ }
             "search_analyzer": "peliasAdmin",
+            "similarity": "peliasDefaultSimilarity",
             "fields": {
@@ -900,2 +944,3 @@ "ngram": {
                 "search_analyzer": "peliasAdmin",
+                "similarity": "peliasDefaultSimilarity",
                 "doc_values": false
@@ -913,2 +958,3 @@ }
             "search_analyzer": "peliasAdmin",
+            "similarity": "peliasDefaultSimilarity",
             "fields": {
@@ -919,2 +965,3 @@ "ngram": {
                 "search_analyzer": "peliasAdmin",
+                "similarity": "peliasDefaultSimilarity",
                 "doc_values": false
@@ -928,2 +975,3 @@ }
             "search_analyzer": "peliasAdmin",
+            "similarity": "peliasDefaultSimilarity",
             "fields": {
@@ -934,2 +982,3 @@ "ngram": {
                 "search_analyzer": "peliasAdmin",
+                "similarity": "peliasDefaultSimilarity",
                 "doc_values": false
@@ -947,2 +996,3 @@ }
             "search_analyzer": "peliasAdmin",
+            "similarity": "peliasDefaultSimilarity",
             "fields": {
@@ -953,2 +1003,3 @@ "ngram": {
                 "search_analyzer": "peliasAdmin",
+                "similarity": "peliasDefaultSimilarity",
                 "doc_values": false
@@ -962,2 +1013,3 @@ }
             "search_analyzer": "peliasAdmin",
+            "similarity": "peliasDefaultSimilarity",
             "fields": {
@@ -968,2 +1020,3 @@ "ngram": {
                 "search_analyzer": "peliasAdmin",
+                "similarity": "peliasDefaultSimilarity",
                 "doc_values": false
@@ -981,2 +1034,3 @@ }
             "search_analyzer": "peliasAdmin",
+            "similarity": "peliasDefaultSimilarity",
             "fields": {
@@ -987,2 +1041,3 @@ "ngram": {
                 "search_analyzer": "peliasAdmin",
+                "similarity": "peliasDefaultSimilarity",
                 "doc_values": false
@@ -996,2 +1051,3 @@ }
             "search_analyzer": "peliasAdmin",
+            "similarity": "peliasDefaultSimilarity",
             "fields": {
@@ -1002,2 +1058,3 @@ "ngram": {
                 "search_analyzer": "peliasAdmin",
+                "similarity": "peliasDefaultSimilarity",
                 "doc_values": false
@@ -1015,2 +1072,3 @@ }
             "search_analyzer": "peliasAdmin",
+            "similarity": "peliasDefaultSimilarity",
             "fields": {
@@ -1021,2 +1079,3 @@ "ngram": {
                 "search_analyzer": "peliasAdmin",
+                "similarity": "peliasDefaultSimilarity",
                 "doc_values": false
@@ -1030,2 +1089,3 @@ }
             "search_analyzer": "peliasAdmin",
+            "similarity": "peliasDefaultSimilarity",
             "fields": {
@@ -1036,2 +1096,3 @@ "ngram": {
                 "search_analyzer": "peliasAdmin",
+                "similarity": "peliasDefaultSimilarity",
                 "doc_values": false
@@ -1049,2 +1110,3 @@ }
             "search_analyzer": "peliasAdmin",
+            "similarity": "peliasDefaultSimilarity",
             "fields": {
@@ -1055,2 +1117,3 @@ "ngram": {
                 "search_analyzer": "peliasAdmin",
+                "similarity": "peliasDefaultSimilarity",
                 "doc_values": false
@@ -1064,2 +1127,3 @@ }
             "search_analyzer": "peliasAdmin",
+            "similarity": "peliasDefaultSimilarity",
             "fields": {
@@ -1070,2 +1134,3 @@ "ngram": {
                 "search_analyzer": "peliasAdmin",
+                "similarity": "peliasDefaultSimilarity",
                 "doc_values": false
@@ -1083,2 +1148,3 @@ }
             "search_analyzer": "peliasAdmin",
+            "similarity": "peliasDefaultSimilarity",
             "fields": {
@@ -1089,2 +1155,3 @@ "ngram": {
                 "search_analyzer": "peliasAdmin",
+                "similarity": "peliasDefaultSimilarity",
                 "doc_values": false
@@ -1098,2 +1165,3 @@ }
             "search_analyzer": "peliasAdmin",
+            "similarity": "peliasDefaultSimilarity",
             "fields": {
@@ -1104,2 +1172,3 @@ "ngram": {
                 "search_analyzer": "peliasAdmin",
+                "similarity": "peliasDefaultSimilarity",
                 "doc_values": false
@@ -1117,2 +1186,3 @@ }
             "search_analyzer": "peliasZip",
+            "similarity": "peliasDefaultSimilarity",
             "fields": {
@@ -1122,3 +1192,4 @@ "ngram": {
                 "analyzer": "peliasIndexOneEdgeGram",
-                "search_analyzer": "peliasZip"
+                "search_analyzer": "peliasZip",
+                "similarity": "peliasDefaultSimilarity"
               }
@@ -1131,2 +1202,3 @@ }
             "search_analyzer": "peliasZip",
+            "similarity": "peliasDefaultSimilarity",
             "fields": {
@@ -1136,3 +1208,4 @@ "ngram": {
                 "analyzer": "peliasIndexOneEdgeGram",
-                "search_analyzer": "peliasZip"
+                "search_analyzer": "peliasZip",
+                "similarity": "peliasDefaultSimilarity"
               }
@@ -1186,3 +1259,4 @@ }
             "analyzer": "peliasIndexOneEdgeGram",
-            "search_analyzer": "peliasQuery"
+            "search_analyzer": "peliasQuery",
+            "similarity": "peliasDefaultSimilarity"
           }
@@ -1198,3 +1272,4 @@ }
             "analyzer": "peliasPhrase",
-            "search_analyzer": "peliasQuery"
+            "search_analyzer": "peliasQuery",
+            "similarity": "peliasDefaultSimilarity"
           }
@@ -1201,0 +1276,0 @@ }

test/settings.js

@@ -470,2 +470,4 @@ var path = require('path'),
 
+    process.env['PELIAS_CONFIG'] = path.resolve(__dirname + '/fixtures/empty.json');
+
     var s = settings();
@@ -484,2 +486,20 @@ t.equal(s.index['number_of_replicas'], '0', 'unchanged');
   });
+  test('override similarity', function (t) {
+
+    process.env['PELIAS_CONFIG'] = path.resolve(__dirname + '/fixtures/empty.json');
+
+    var s = settings();
+    t.equal(s.index.similarity.peliasDefaultSimilarity.k1, 1.2, 'unchanged');
+
+    // set the PELIAS_CONFIG env var
+    process.env['PELIAS_CONFIG'] = path.resolve(__dirname + '/fixtures/similarity.json');
+
+    s = settings();
+    t.equal(s.index.similarity.peliasDefaultSimilarity.k1, 0, 'changed');
+    t.equal(s.index.similarity.peliasDefaultSimilarity.b, 0.75, 'changed');
+    t.end();
+
+    // unset the PELIAS_CONFIG env var
+    delete process.env['PELIAS_CONFIG'];
+  });
 };
@@ -486,0 +506,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

AI-detected potential malware

Supply chain risk

AI has identified this package as malware. This is a strong signal that the package may be malicious.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

220411

increased by2.11%

Number of package files

77

increased by2.67%

Lines of code

5569

increased by2.24%

Worsened metrics

Number of high supply chain risk alerts

1

increased byInfinity%

Number of low supply chain risk alerts

11

increased by57.14%

No dependency changes