@backstage/plugin-search-backend-node 1.3.17 → 1.4.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @backstage/plugin-search-backend-node
 
+## 1.4.0-next.1
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.6.0-next.1
+  - @backstage/config@1.3.6
+  - @backstage/errors@1.2.7
+  - @backstage/plugin-permission-common@0.9.3
+  - @backstage/plugin-search-common@1.2.21
+
+## 1.4.0-next.0
+
+### Minor Changes
+
+- 4d3ddb9: Improving method that search tokenizer breaks apart entity names
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.5.1-next.0
+  - @backstage/config@1.3.6
+  - @backstage/errors@1.2.7
+  - @backstage/plugin-permission-common@0.9.3
+  - @backstage/plugin-search-common@1.2.21
+
 ## 1.3.17
 
 ### Patch Changes

package/dist/alpha.d.ts

@@ -64,4 +64,5 @@ declare const searchEngineRegistryExtensionPoint: _backstage_backend_plugin_api.
  */
 declare const searchIndexRegistryExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<SearchIndexRegistryExtensionPoint>;
 
-export { type SearchEngineRegistryExtensionPoint, type SearchIndexRegistryExtensionPoint, type SearchIndexService, type SearchIndexServiceInitOptions, searchEngineRegistryExtensionPoint, searchIndexRegistryExtensionPoint, searchIndexServiceRef };
+export { searchEngineRegistryExtensionPoint, searchIndexRegistryExtensionPoint, searchIndexServiceRef };
+export type { SearchEngineRegistryExtensionPoint, SearchIndexRegistryExtensionPoint, SearchIndexService, SearchIndexServiceInitOptions };

package/dist/engines/LunrSearchEngineIndexer.cjs.js

@@ -16,6 +16,7 @@ class LunrSearchEngineIndexer extends BatchSearchEngineIndexer.BatchSearchEngine
   constructor() {
     super({ batchSize: 1e3 });
     this.builder = new lunr__default.default.Builder();
+    this.builder.tokenizer.separator = /[^\p{L}\p{N}]+/u;
     this.builder.pipeline.add(lunr__default.default.trimmer, lunr__default.default.stopWordFilter, lunr__default.default.stemmer);
     this.builder.searchPipeline.add(lunr__default.default.stemmer);
     this.builder.metadataWhitelist = ["position"];

package/dist/engines/LunrSearchEngineIndexer.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"LunrSearchEngineIndexer.cjs.js","sources":["../../src/engines/LunrSearchEngineIndexer.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { IndexableDocument } from '@backstage/plugin-search-common';\nimport lunr from 'lunr';\nimport { BatchSearchEngineIndexer } from '../indexing';\n\n/**\n * Lunr specific search engine indexer\n * @public\n */\nexport class LunrSearchEngineIndexer extends BatchSearchEngineIndexer {\n  private schemaInitialized = false;\n  private builder: lunr.Builder;\n  private docStore: Record<string, IndexableDocument> = {};\n\n  constructor() {\n    super({ batchSize: 1000 });\n\n    this.builder = new lunr.Builder();\n    this.builder.pipeline.add(lunr.trimmer, lunr.stopWordFilter, lunr.stemmer);\n    this.builder.searchPipeline.add(lunr.stemmer);\n    this.builder.metadataWhitelist = ['position'];\n  }\n\n  // No async initialization required.\n  async initialize(): Promise<void> {}\n  async finalize(): Promise<void> {}\n\n  async index(documents: IndexableDocument[]): Promise<void> {\n    if (!this.schemaInitialized) {\n      // Make this lunr index aware of all relevant fields.\n      Object.keys(documents[0]).forEach(field => {\n        this.builder.field(field);\n      });\n\n      // Set \"location\" field as reference field\n      this.builder.ref('location');\n\n      this.schemaInitialized = true;\n    }\n\n    documents.forEach(document => {\n      // Add document to Lunar index\n      this.builder.add(document);\n\n      // Store documents in memory to be able to look up document using the ref during query time\n      // This is not how you should implement your SearchEngine implementation! Do not copy!\n      this.docStore[document.location] = document;\n    });\n  }\n\n  buildIndex() {\n    return this.builder.build();\n  }\n\n  getDocumentStore() {\n    return this.docStore;\n  }\n}\n"],"names":["BatchSearchEngineIndexer","lunr"],"mappings":";;;;;;;;;;;AAwBO,MAAM,gCAAgCA,iDAAA,CAAyB;AAAA,EAC5D,iBAAA,GAAoB,KAAA;AAAA,EACpB,OAAA;AAAA,EACA,WAA8C,EAAC;AAAA,EAEvD,WAAA,GAAc;AACZ,IAAA,KAAA,CAAM,EAAE,SAAA,EAAW,GAAA,EAAM,CAAA;AAEzB,IAAA,IAAA,CAAK,OAAA,GAAU,IAAIC,qBAAA,CAAK,OAAA,EAAQ;AAChC,IAAA,IAAA,CAAK,OAAA,CAAQ,SAAS,GAAA,CAAIA,qBAAA,CAAK,SAASA,qBAAA,CAAK,cAAA,EAAgBA,sBAAK,OAAO,CAAA;AACzE,IAAA,IAAA,CAAK,OAAA,CAAQ,cAAA,CAAe,GAAA,CAAIA,qBAAA,CAAK,OAAO,CAAA;AAC5C,IAAA,IAAA,CAAK,OAAA,CAAQ,iBAAA,GAAoB,CAAC,UAAU,CAAA;AAAA,EAC9C;AAAA;AAAA,EAGA,MAAM,UAAA,GAA4B;AAAA,EAAC;AAAA,EACnC,MAAM,QAAA,GAA0B;AAAA,EAAC;AAAA,EAEjC,MAAM,MAAM,SAAA,EAA+C;AACzD,IAAA,IAAI,CAAC,KAAK,iBAAA,EAAmB;AAE3B,MAAA,MAAA,CAAO,KAAK,SAAA,CAAU,CAAC,CAAC,CAAA,CAAE,QAAQ,CAAA,KAAA,KAAS;AACzC,QAAA,IAAA,CAAK,OAAA,CAAQ,MAAM,KAAK,CAAA;AAAA,MAC1B,CAAC,CAAA;AAGD,MAAA,IAAA,CAAK,OAAA,CAAQ,IAAI,UAAU,CAAA;AAE3B,MAAA,IAAA,CAAK,iBAAA,GAAoB,IAAA;AAAA,IAC3B;AAEA,IAAA,SAAA,CAAU,QAAQ,CAAA,QAAA,KAAY;AAE5B,MAAA,IAAA,CAAK,OAAA,CAAQ,IAAI,QAAQ,CAAA;AAIzB,MAAA,IAAA,CAAK,QAAA,CAAS,QAAA,CAAS,QAAQ,CAAA,GAAI,QAAA;AAAA,IACrC,CAAC,CAAA;AAAA,EACH;AAAA,EAEA,UAAA,GAAa;AACX,IAAA,OAAO,IAAA,CAAK,QAAQ,KAAA,EAAM;AAAA,EAC5B;AAAA,EAEA,gBAAA,GAAmB;AACjB,IAAA,OAAO,IAAA,CAAK,QAAA;AAAA,EACd;AACF;;;;"}
+{"version":3,"file":"LunrSearchEngineIndexer.cjs.js","sources":["../../src/engines/LunrSearchEngineIndexer.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { IndexableDocument } from '@backstage/plugin-search-common';\nimport lunr from 'lunr';\nimport { BatchSearchEngineIndexer } from '../indexing';\n\n/**\n * Lunr specific search engine indexer\n * @public\n */\nexport class LunrSearchEngineIndexer extends BatchSearchEngineIndexer {\n  private schemaInitialized = false;\n  private builder: lunr.Builder;\n  private docStore: Record<string, IndexableDocument> = {};\n\n  constructor() {\n    super({ batchSize: 1000 });\n    this.builder = new lunr.Builder();\n    this.builder.tokenizer.separator = /[^\\p{L}\\p{N}]+/u;\n    this.builder.pipeline.add(lunr.trimmer, lunr.stopWordFilter, lunr.stemmer);\n    this.builder.searchPipeline.add(lunr.stemmer);\n    this.builder.metadataWhitelist = ['position'];\n  }\n\n  // No async initialization required.\n  async initialize(): Promise<void> {}\n  async finalize(): Promise<void> {}\n\n  async index(documents: IndexableDocument[]): Promise<void> {\n    if (!this.schemaInitialized) {\n      // Make this lunr index aware of all relevant fields.\n      Object.keys(documents[0]).forEach(field => {\n        this.builder.field(field);\n      });\n\n      // Set \"location\" field as reference field\n      this.builder.ref('location');\n\n      this.schemaInitialized = true;\n    }\n\n    documents.forEach(document => {\n      // Add document to Lunar index\n      this.builder.add(document);\n\n      // Store documents in memory to be able to look up document using the ref during query time\n      // This is not how you should implement your SearchEngine implementation! Do not copy!\n      this.docStore[document.location] = document;\n    });\n  }\n\n  buildIndex() {\n    return this.builder.build();\n  }\n\n  getDocumentStore() {\n    return this.docStore;\n  }\n}\n"],"names":["BatchSearchEngineIndexer","lunr"],"mappings":";;;;;;;;;;;AAwBO,MAAM,gCAAgCA,iDAAA,CAAyB;AAAA,EAC5D,iBAAA,GAAoB,KAAA;AAAA,EACpB,OAAA;AAAA,EACA,WAA8C,EAAC;AAAA,EAEvD,WAAA,GAAc;AACZ,IAAA,KAAA,CAAM,EAAE,SAAA,EAAW,GAAA,EAAM,CAAA;AACzB,IAAA,IAAA,CAAK,OAAA,GAAU,IAAIC,qBAAA,CAAK,OAAA,EAAQ;AAChC,IAAA,IAAA,CAAK,OAAA,CAAQ,UAAU,SAAA,GAAY,iBAAA;AACnC,IAAA,IAAA,CAAK,OAAA,CAAQ,SAAS,GAAA,CAAIA,qBAAA,CAAK,SAASA,qBAAA,CAAK,cAAA,EAAgBA,sBAAK,OAAO,CAAA;AACzE,IAAA,IAAA,CAAK,OAAA,CAAQ,cAAA,CAAe,GAAA,CAAIA,qBAAA,CAAK,OAAO,CAAA;AAC5C,IAAA,IAAA,CAAK,OAAA,CAAQ,iBAAA,GAAoB,CAAC,UAAU,CAAA;AAAA,EAC9C;AAAA;AAAA,EAGA,MAAM,UAAA,GAA4B;AAAA,EAAC;AAAA,EACnC,MAAM,QAAA,GAA0B;AAAA,EAAC;AAAA,EAEjC,MAAM,MAAM,SAAA,EAA+C;AACzD,IAAA,IAAI,CAAC,KAAK,iBAAA,EAAmB;AAE3B,MAAA,MAAA,CAAO,KAAK,SAAA,CAAU,CAAC,CAAC,CAAA,CAAE,QAAQ,CAAA,KAAA,KAAS;AACzC,QAAA,IAAA,CAAK,OAAA,CAAQ,MAAM,KAAK,CAAA;AAAA,MAC1B,CAAC,CAAA;AAGD,MAAA,IAAA,CAAK,OAAA,CAAQ,IAAI,UAAU,CAAA;AAE3B,MAAA,IAAA,CAAK,iBAAA,GAAoB,IAAA;AAAA,IAC3B;AAEA,IAAA,SAAA,CAAU,QAAQ,CAAA,QAAA,KAAY;AAE5B,MAAA,IAAA,CAAK,OAAA,CAAQ,IAAI,QAAQ,CAAA;AAIzB,MAAA,IAAA,CAAK,QAAA,CAAS,QAAA,CAAS,QAAQ,CAAA,GAAI,QAAA;AAAA,IACrC,CAAC,CAAA;AAAA,EACH;AAAA,EAEA,UAAA,GAAa;AACX,IAAA,OAAO,IAAA,CAAK,QAAQ,KAAA,EAAM;AAAA,EAC5B;AAAA,EAEA,gBAAA,GAAmB;AACjB,IAAA,OAAO,IAAA,CAAK,QAAA;AAAA,EACd;AACF;;;;"}

package/dist/index.d.ts

@@ -433,4 +433,5 @@ declare class TestPipeline {
     execute(): Promise<TestPipelineResult>;
 }
 
-export { BatchSearchEngineIndexer, type BatchSearchEngineOptions, type ConcreteLunrQuery, DecoratorBase, IndexBuilder, type IndexBuilderOptions, type LunrQueryTranslator, LunrSearchEngine, LunrSearchEngineIndexer, MissingIndexError, NewlineDelimitedJsonCollatorFactory, type NewlineDelimitedJsonCollatorFactoryOptions, type QueryRequestOptions, type QueryTranslator, type RegisterCollatorParameters, type RegisterDecoratorParameters, type ScheduleTaskParameters, Scheduler, type SearchEngine, TestPipeline, type TestPipelineResult };
+export { BatchSearchEngineIndexer, DecoratorBase, IndexBuilder, LunrSearchEngine, LunrSearchEngineIndexer, MissingIndexError, NewlineDelimitedJsonCollatorFactory, Scheduler, TestPipeline };
+export type { BatchSearchEngineOptions, ConcreteLunrQuery, IndexBuilderOptions, LunrQueryTranslator, NewlineDelimitedJsonCollatorFactoryOptions, QueryRequestOptions, QueryTranslator, RegisterCollatorParameters, RegisterDecoratorParameters, ScheduleTaskParameters, SearchEngine, TestPipelineResult };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-search-backend-node",
-  "version": "1.3.17",
+  "version": "1.4.0-next.1",
   "description": "A library for Backstage backend plugins that want to interact with the search backend plugin",
   "backstage": {
     "role": "node-library",
@@ -61,11 +61,11 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "^1.5.0",
-    "@backstage/config": "^1.3.6",
-    "@backstage/errors": "^1.2.7",
-    "@backstage/plugin-permission-common": "^0.9.3",
-    "@backstage/plugin-search-common": "^1.2.21",
+    "@backstage/backend-plugin-api": "1.6.0-next.1",
+    "@backstage/config": "1.3.6",
+    "@backstage/errors": "1.2.7",
+    "@backstage/plugin-permission-common": "0.9.3",
+    "@backstage/plugin-search-common": "1.2.21",
     "@types/lunr": "^2.3.3",
     "lodash": "^4.17.21",
     "lunr": "^2.3.9",
@@ -73,9 +73,9 @@
     "uuid": "^11.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-defaults": "^0.13.1",
-    "@backstage/backend-test-utils": "^1.10.0",
-    "@backstage/cli": "^0.34.5",
+    "@backstage/backend-defaults": "0.14.0-next.1",
+    "@backstage/backend-test-utils": "1.10.2-next.1",
+    "@backstage/cli": "0.35.0-next.2",
     "@types/ndjson": "^2.0.1"
   }
 }