npm - @backstage/plugin-search-backend-module-pg - Versions diffs - 0.5.51 → 0.5.52-next.1 - Mend

@backstage/plugin-search-backend-module-pg 0.5.51 → 0.5.52-next.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

package/CHANGELOG.md +19 -0
package/dist/PgSearchEngine/PgSearchEngine.cjs.js +6 -1
package/dist/PgSearchEngine/PgSearchEngine.cjs.js.map +1 -1
package/dist/database/DatabaseDocumentStore.cjs.js +1 -0
package/dist/database/DatabaseDocumentStore.cjs.js.map +1 -1
package/dist/index.d.ts +4 -0
package/package.json +7 -7

package/CHANGELOG.md CHANGED Viewed

@@ -1,5 +1,24 @@
 # @backstage/plugin-search-backend-module-pg
+## 0.5.52-next.1
+### Patch Changes
+- 2ee354a: Return `numberOfResults` count with search query responses
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.7.0-next.1
+## 0.5.52-next.0
+### Patch Changes
+- 7455dae: Use node prefix on native imports
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.7.0-next.0
+  - @backstage/plugin-search-backend-node@1.4.1-next.0
+  - @backstage/plugin-search-common@1.2.22-next.0
+  - @backstage/config@1.3.6
 ## 0.5.51
 ### Patch Changes

package/dist/PgSearchEngine/PgSearchEngine.cjs.js CHANGED Viewed

@@ -142,7 +142,12 @@ class PgSearchEngine {
         }
       })
     );
-    return { results, nextPageCursor, previousPageCursor };
+    return {
+      results,
+      numberOfResults: rows.length > 0 ? parseInt(rows[0].total_count, 10) : 0,
+      nextPageCursor,
+      previousPageCursor
+    };
   }
 }
 function decodePageCursor(pageCursor) {

package/dist/PgSearchEngine/PgSearchEngine.cjs.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"PgSearchEngine.cjs.js","sources":["../../src/PgSearchEngine/PgSearchEngine.ts"],"sourcesContent":["/\n Copyright 2021 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 { SearchEngine } from '@backstage/plugin-search-backend-node';\nimport {\n SearchQuery,\n IndexableResultSet,\n IndexableResult,\n} from '@backstage/plugin-search-common';\nimport { PgSearchEngineIndexer } from './PgSearchEngineIndexer';\nimport {\n DatabaseDocumentStore,\n DatabaseStore,\n PgSearchQuery,\n} from '../database';\nimport { v4 as uuid } from 'uuid';\nimport { Config } from '@backstage/config';\nimport { DatabaseService, LoggerService } from '@backstage/backend-plugin-api';\n\n/\n Search query that the Postgres search engine understands.\n * @public\n /\nexport type ConcretePgSearchQuery = {\n pgQuery: PgSearchQuery;\n pageSize: number;\n};\n\n/\n Options available for the Postgres specific query translator.\n * @public\n /\nexport type PgSearchQueryTranslatorOptions = {\n highlightOptions: PgSearchHighlightOptions;\n normalization?: number;\n};\n\n/\n Postgres specific query translator.\n * @public\n /\nexport type PgSearchQueryTranslator = (\n query: SearchQuery,\n options: PgSearchQueryTranslatorOptions,\n) => ConcretePgSearchQuery;\n\n/\n Options to instantiate PgSearchEngine\n * @public\n /\nexport type PgSearchOptions = {\n database: DatabaseService;\n logger?: LoggerService;\n};\n\n/\n Options for highlighting search terms\n * @public\n /\nexport type PgSearchHighlightOptions = {\n useHighlight?: boolean;\n maxWords?: number;\n minWords?: number;\n shortWord?: number;\n highlightAll?: boolean;\n maxFragments?: number;\n fragmentDelimiter?: string;\n preTag: string;\n postTag: string;\n};\n\n/* @public /\nexport class PgSearchEngine implements SearchEngine {\n private readonly logger?: LoggerService;\n private readonly highlightOptions: PgSearchHighlightOptions;\n private readonly indexerBatchSize: number;\n private readonly normalization: number;\n private readonly databaseStore: DatabaseStore;\n\n /\n @deprecated This will be marked as private in a future release, please us fromConfig instead\n /\n constructor(\n databaseStore: DatabaseStore,\n config: Config,\n logger?: LoggerService,\n ) {\n this.databaseStore = databaseStore;\n const uuidTag = uuid();\n const highlightConfig = config.getOptionalConfig(\n 'search.pg.highlightOptions',\n );\n\n const highlightOptions: PgSearchHighlightOptions = {\n preTag: `<${uuidTag}>`,\n postTag: `</${uuidTag}>`,\n useHighlight: highlightConfig?.getOptionalBoolean('useHighlight') ?? true,\n maxWords: highlightConfig?.getOptionalNumber('maxWords') ?? 35,\n minWords: highlightConfig?.getOptionalNumber('minWords') ?? 15,\n shortWord: highlightConfig?.getOptionalNumber('shortWord') ?? 3,\n highlightAll:\n highlightConfig?.getOptionalBoolean('highlightAll') ?? false,\n maxFragments: highlightConfig?.getOptionalNumber('maxFragments') ?? 0,\n fragmentDelimiter:\n highlightConfig?.getOptionalString('fragmentDelimiter') ?? ' ... ',\n };\n this.highlightOptions = highlightOptions;\n this.indexerBatchSize =\n config.getOptionalNumber('search.pg.indexerBatchSize') ?? 1000;\n\n this.normalization = this.getNormalizationValue(config);\n this.logger = logger;\n }\n\n private getNormalizationValue(config: Config) {\n const normalizationConfig =\n config.getOptional('search.pg.normalization') ?? 0;\n if (typeof normalizationConfig === 'number') {\n return normalizationConfig;\n } else if (typeof normalizationConfig === 'string') {\n return this.evaluateBitwiseOrExpression(normalizationConfig);\n }\n this.logger?.error(\n `Unknown normalization configuration: ${normalizationConfig}`,\n );\n\n return 0;\n }\n\n private evaluateBitwiseOrExpression(expression: string) {\n const tokens = expression.split('\|').map(token => token.trim());\n\n const numbers = tokens.map(token => {\n const num = parseInt(token, 10);\n if (isNaN(num)) {\n this.logger?.error(\n `Unknown expression for normalization: ${expression}`,\n );\n return 0;\n }\n return num;\n });\n return numbers.reduce((acc, num) => acc \| num, 0);\n }\n\n /\n @deprecated This will be removed in a future release, please use fromConfig instead\n /\n static async from(options: {\n database: DatabaseService;\n config: Config;\n logger?: LoggerService;\n }): Promise<PgSearchEngine> {\n return new PgSearchEngine(\n await DatabaseDocumentStore.create(options.database),\n options.config,\n options.logger,\n );\n }\n\n static async fromConfig(config: Config, options: PgSearchOptions) {\n return new PgSearchEngine(\n await DatabaseDocumentStore.create(options.database),\n config,\n options.logger,\n );\n }\n\n static async supported(database: DatabaseService): Promise<boolean> {\n return await DatabaseDocumentStore.supported(await database.getClient());\n }\n\n translator(\n query: SearchQuery,\n options: PgSearchQueryTranslatorOptions,\n ): ConcretePgSearchQuery {\n const pageSize = query.pageLimit \|\| 25;\n const { page } = decodePageCursor(query.pageCursor);\n const offset = page pageSize;\n // We request more result to know whether there is another page\n const limit = pageSize + 1;\n const normalization = options.normalization \|\| 0;\n\n return {\n pgQuery: {\n pgTerm: query.term\n .split(/\\s/)\n .map(p => p.replace(/[\\0()\|&:!<]/g, '').trim())\n .filter(p => p !== '')\n .map(p => `(${JSON.stringify(p)} \| ${JSON.stringify(p)}:)`)\n .join('&'),\n fields: query.filters as Record<string, string \| string[]>,\n types: query.types,\n offset,\n limit,\n normalization,\n options: options.highlightOptions,\n },\n pageSize,\n };\n }\n\n setTranslator(translator: PgSearchQueryTranslator) {\n this.translator = translator;\n }\n\n async getIndexer(type: string) {\n return new PgSearchEngineIndexer({\n batchSize: this.indexerBatchSize,\n type,\n databaseStore: this.databaseStore,\n logger: this.logger?.child({ documentType: type }),\n });\n }\n\n async query(query: SearchQuery): Promise<IndexableResultSet> {\n const { pgQuery, pageSize } = this.translator(query, {\n highlightOptions: this.highlightOptions,\n normalization: this.normalization,\n });\n\n const rows = await this.databaseStore.transaction(async tx =>\n this.databaseStore.query(tx, pgQuery),\n );\n\n // We requested one result more than the page size to know whether there is\n // another page.\n const { page } = decodePageCursor(query.pageCursor);\n const hasNextPage = rows.length > pageSize;\n const hasPreviousPage = page > 0;\n const pageRows = rows.slice(0, pageSize);\n const nextPageCursor = hasNextPage\n ? encodePageCursor({ page: page + 1 })\n : undefined;\n const previousPageCursor = hasPreviousPage\n ? encodePageCursor({ page: page - 1 })\n : undefined;\n\n const results = pageRows.map(\n ({ type, document, highlight }, index): IndexableResult => ({\n type,\n document,\n rank: page * pageSize + index + 1,\n highlight: {\n preTag: pgQuery.options.preTag,\n postTag: pgQuery.options.postTag,\n fields: highlight\n ? {\n text: highlight.text,\n title: highlight.title,\n location: highlight.location,\n path: '',\n }\n : {},\n },\n }),\n );\n\n return { results, nextPageCursor, previousPageCursor };\n }\n}\n\nexport function decodePageCursor(pageCursor?: string): { page: number } {\n if (!pageCursor) {\n return { page: 0 };\n }\n\n return {\n page: Number(Buffer.from(pageCursor, 'base64').toString('utf-8')),\n };\n}\n\nexport function encodePageCursor({ page }: { page: number }): string {\n return Buffer.from(`${page}`, 'utf-8').toString('base64');\n}\n"],"names":["uuid","DatabaseDocumentStore","PgSearchEngineIndexer"],"mappings":";;;;;;AAqFO,MAAM,cAAA,CAAuC;AAAA,EACjC,MAAA;AAAA,EACA,gBAAA;AAAA,EACA,gBAAA;AAAA,EACA,aAAA;AAAA,EACA,aAAA;AAAA;AAAA;AAAA;AAAA,EAKjB,WAAA,CACE,aAAA,EACA,MAAA,EACA,MAAA,EACA;AACA,IAAA,IAAA,CAAK,aAAA,GAAgB,aAAA;AACrB,IAAA,MAAM,UAAUA,OAAA,EAAK;AACrB,IAAA,MAAM,kBAAkB,MAAA,CAAO,iBAAA;AAAA,MAC7B;AAAA,KACF;AAEA,IAAA,MAAM,gBAAA,GAA6C;AAAA,MACjD,MAAA,EAAQ,IAAI,OAAO,CAAA,CAAA,CAAA;AAAA,MACnB,OAAA,EAAS,KAAK,OAAO,CAAA,CAAA,CAAA;AAAA,MACrB,YAAA,EAAc,eAAA,EAAiB,kBAAA,CAAmB,cAAc,CAAA,IAAK,IAAA;AAAA,MACrE,QAAA,EAAU,eAAA,EAAiB,iBAAA,CAAkB,UAAU,CAAA,IAAK,EAAA;AAAA,MAC5D,QAAA,EAAU,eAAA,EAAiB,iBAAA,CAAkB,UAAU,CAAA,IAAK,EAAA;AAAA,MAC5D,SAAA,EAAW,eAAA,EAAiB,iBAAA,CAAkB,WAAW,CAAA,IAAK,CAAA;AAAA,MAC9D,YAAA,EACE,eAAA,EAAiB,kBAAA,CAAmB,cAAc,CAAA,IAAK,KAAA;AAAA,MACzD,YAAA,EAAc,eAAA,EAAiB,iBAAA,CAAkB,cAAc,CAAA,IAAK,CAAA;AAAA,MACpE,iBAAA,EACE,eAAA,EAAiB,iBAAA,CAAkB,mBAAmB,CAAA,IAAK;AAAA,KAC/D;AACA,IAAA,IAAA,CAAK,gBAAA,GAAmB,gBAAA;AACxB,IAAA,IAAA,CAAK,gBAAA,GACH,MAAA,CAAO,iBAAA,CAAkB,4BAA4B,CAAA,IAAK,GAAA;AAE5D,IAAA,IAAA,CAAK,aAAA,GAAgB,IAAA,CAAK,qBAAA,CAAsB,MAAM,CAAA;AACtD,IAAA,IAAA,CAAK,MAAA,GAAS,MAAA;AAAA,EAChB;AAAA,EAEQ,sBAAsB,MAAA,EAAgB;AAC5C,IAAA,MAAM,mBAAA,GACJ,MAAA,CAAO,WAAA,CAAY,yBAAyB,CAAA,IAAK,CAAA;AACnD,IAAA,IAAI,OAAO,wBAAwB,QAAA,EAAU;AAC3C,MAAA,OAAO,mBAAA;AAAA,IACT,CAAA,MAAA,IAAW,OAAO,mBAAA,KAAwB,QAAA,EAAU;AAClD,MAAA,OAAO,IAAA,CAAK,4BAA4B,mBAAmB,CAAA;AAAA,IAC7D;AACA,IAAA,IAAA,CAAK,MAAA,EAAQ,KAAA;AAAA,MACX,wCAAwC,mBAAmB,CAAA;AAAA,KAC7D;AAEA,IAAA,OAAO,CAAA;AAAA,EACT;AAAA,EAEQ,4BAA4B,UAAA,EAAoB;AACtD,IAAA,MAAM,MAAA,GAAS,WAAW,KAAA,CAAM,GAAG,EAAE,GAAA,CAAI,CAAA,KAAA,KAAS,KAAA,CAAM,IAAA,EAAM,CAAA;AAE9D,IAAA,MAAM,OAAA,GAAU,MAAA,CAAO,GAAA,CAAI,CAAA,KAAA,KAAS;AAClC,MAAA,MAAM,GAAA,GAAM,QAAA,CAAS,KAAA,EAAO,EAAE,CAAA;AAC9B,MAAA,IAAI,KAAA,CAAM,GAAG,CAAA,EAAG;AACd,QAAA,IAAA,CAAK,MAAA,EAAQ,KAAA;AAAA,UACX,yCAAyC,UAAU,CAAA;AAAA,SACrD;AACA,QAAA,OAAO,CAAA;AAAA,MACT;AACA,MAAA,OAAO,GAAA;AAAA,IACT,CAAC,CAAA;AACD,IAAA,OAAO,QAAQ,MAAA,CAAO,CAAC,KAAK,GAAA,KAAQ,GAAA,GAAM,KAAK,CAAC,CAAA;AAAA,EAClD;AAAA;AAAA;AAAA;AAAA,EAKA,aAAa,KAAK,OAAA,EAIU;AAC1B,IAAA,OAAO,IAAI,cAAA;AAAA,MACT,MAAMC,2CAAA,CAAsB,MAAA,CAAO,OAAA,CAAQ,QAAQ,CAAA;AAAA,MACnD,OAAA,CAAQ,MAAA;AAAA,MACR,OAAA,CAAQ;AAAA,KACV;AAAA,EACF;AAAA,EAEA,aAAa,UAAA,CAAW,MAAA,EAAgB,OAAA,EAA0B;AAChE,IAAA,OAAO,IAAI,cAAA;AAAA,MACT,MAAMA,2CAAA,CAAsB,MAAA,CAAO,OAAA,CAAQ,QAAQ,CAAA;AAAA,MACnD,MAAA;AAAA,MACA,OAAA,CAAQ;AAAA,KACV;AAAA,EACF;AAAA,EAEA,aAAa,UAAU,QAAA,EAA6C;AAClE,IAAA,OAAO,MAAMA,2CAAA,CAAsB,SAAA,CAAU,MAAM,QAAA,CAAS,WAAW,CAAA;AAAA,EACzE;AAAA,EAEA,UAAA,CACE,OACA,OAAA,EACuB;AACvB,IAAA,MAAM,QAAA,GAAW,MAAM,SAAA,IAAa,EAAA;AACpC,IAAA,MAAM,EAAE,IAAA,EAAK,GAAI,gBAAA,CAAiB,MAAM,UAAU,CAAA;AAClD,IAAA,MAAM,SAAS,IAAA,GAAO,QAAA;AAEtB,IAAA,MAAM,QAAQ,QAAA,GAAW,CAAA;AACzB,IAAA,MAAM,aAAA,GAAgB,QAAQ,aAAA,IAAiB,CAAA;AAE/C,IAAA,OAAO;AAAA,MACL,OAAA,EAAS;AAAA,QACP,QAAQ,KAAA,CAAM,IAAA,CACX,KAAA,CAAM,IAAI,EACV,GAAA,CAAI,CAAA,CAAA,KAAK,CAAA,CAAE,OAAA,CAAQ,iBAAiB,EAAE,CAAA,CAAE,IAAA,EAAM,EAC9C,MAAA,CAAO,CAAA,CAAA,KAAK,CAAA,KAAM,EAAE,EACpB,GAAA,CAAI,CAAA,CAAA,KAAK,CAAA,CAAA,EAAI,IAAA,CAAK,UAAU,CAAC,CAAC,CAAA,GAAA,EAAM,IAAA,CAAK,UAAU,CAAC,CAAC,CAAA,GAAA,CAAK,CAAA,CAC1D,KAAK,GAAG,CAAA;AAAA,QACX,QAAQ,KAAA,CAAM,OAAA;AAAA,QACd,OAAO,KAAA,CAAM,KAAA;AAAA,QACb,MAAA;AAAA,QACA,KAAA;AAAA,QACA,aAAA;AAAA,QACA,SAAS,OAAA,CAAQ;AAAA,OACnB;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,cAAc,UAAA,EAAqC;AACjD,IAAA,IAAA,CAAK,UAAA,GAAa,UAAA;AAAA,EACpB;AAAA,EAEA,MAAM,WAAW,IAAA,EAAc;AAC7B,IAAA,OAAO,IAAIC,2CAAA,CAAsB;AAAA,MAC/B,WAAW,IAAA,CAAK,gBAAA;AAAA,MAChB,IAAA;AAAA,MACA,eAAe,IAAA,CAAK,aAAA;AAAA,MACpB,QAAQ,IAAA,CAAK,MAAA,EAAQ,MAAM,EAAE,YAAA,EAAc,MAAM;AAAA,KAClD,CAAA;AAAA,EACH;AAAA,EAEA,MAAM,MAAM,KAAA,EAAiD;AAC3D,IAAA,MAAM,EAAE,OAAA,EAAS,QAAA,EAAS,GAAI,IAAA,CAAK,WAAW,KAAA,EAAO;AAAA,MACnD,kBAAkB,IAAA,CAAK,gBAAA;AAAA,MACvB,eAAe,IAAA,CAAK;AAAA,KACrB,CAAA;AAED,IAAA,MAAM,IAAA,GAAO,MAAM,IAAA,CAAK,aAAA,CAAc,WAAA;AAAA,MAAY,OAAM,EAAA,KACtD,IAAA,CAAK,aAAA,CAAc,KAAA,CAAM,IAAI,OAAO;AAAA,KACtC;AAIA,IAAA,MAAM,EAAE,IAAA,EAAK,GAAI,gBAAA,CAAiB,MAAM,UAAU,CAAA;AAClD,IAAA,MAAM,WAAA,GAAc,KAAK,MAAA,GAAS,QAAA;AAClC,IAAA,MAAM,kBAAkB,IAAA,GAAO,CAAA;AAC/B,IAAA,MAAM,QAAA,GAAW,IAAA,CAAK,KAAA,CAAM,CAAA,EAAG,QAAQ,CAAA;AACvC,IAAA,MAAM,cAAA,GAAiB,cACnB,gBAAA,CAAiB,EAAE,MAAM,IAAA,GAAO,CAAA,EAAG,CAAA,GACnC,MAAA;AACJ,IAAA,MAAM,kBAAA,GAAqB,kBACvB,gBAAA,CAAiB,EAAE,MAAM,IAAA,GAAO,CAAA,EAAG,CAAA,GACnC,MAAA;AAEJ,IAAA,MAAM,UAAU,QAAA,CAAS,GAAA;AAAA,MACvB,CAAC,EAAE,IAAA,EAAM,QAAA,EAAU,SAAA,IAAa,KAAA,MAA4B;AAAA,QAC1D,IAAA;AAAA,QACA,QAAA;AAAA,QACA,IAAA,EAAM,IAAA,GAAO,QAAA,GAAW,KAAA,GAAQ,CAAA;AAAA,QAChC,SAAA,EAAW;AAAA,UACT,MAAA,EAAQ,QAAQ,OAAA,CAAQ,MAAA;AAAA,UACxB,OAAA,EAAS,QAAQ,OAAA,CAAQ,OAAA;AAAA,UACzB,QAAQ,SAAA,GACJ;AAAA,YACE,MAAM,SAAA,CAAU,IAAA;AAAA,YAChB,OAAO,SAAA,CAAU,KAAA;AAAA,YACjB,UAAU,SAAA,CAAU,QAAA;AAAA,YACpB,IAAA,EAAM;AAAA,cAER;AAAC;AACP,OACF;AAAA,KACF;AAEA,IAAA,OAAO,EAAE,OAAA,EAAS,cAAA,EAAgB,kBAAA,EAAmB;AAAA,EACvD;AACF;AAEO,SAAS,iBAAiB,UAAA,EAAuC;AACtE,EAAA,IAAI,CAAC,UAAA,EAAY;AACf,IAAA,OAAO,EAAE,MAAM,CAAA,EAAE;AAAA,EACnB;AAEA,EAAA,OAAO;AAAA,IACL,IAAA,EAAM,OAAO,MAAA,CAAO,IAAA,CAAK,YAAY,QAAQ,CAAA,CAAE,QAAA,CAAS,OAAO,CAAC;AAAA,GAClE;AACF;AAEO,SAAS,gBAAA,CAAiB,EAAE,IAAA,EAAK,EAA6B;AACnE,EAAA,OAAO,MAAA,CAAO,KAAK,CAAA,EAAG,IAAI,IAAI,OAAO,CAAA,CAAE,SAAS,QAAQ,CAAA;AAC1D;;;;;;"}
1	+ {"version":3,"file":"PgSearchEngine.cjs.js","sources":["../../src/PgSearchEngine/PgSearchEngine.ts"],"sourcesContent":["/\n Copyright 2021 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 { SearchEngine } from '@backstage/plugin-search-backend-node';\nimport {\n SearchQuery,\n IndexableResultSet,\n IndexableResult,\n} from '@backstage/plugin-search-common';\nimport { PgSearchEngineIndexer } from './PgSearchEngineIndexer';\nimport {\n DatabaseDocumentStore,\n DatabaseStore,\n PgSearchQuery,\n} from '../database';\nimport { v4 as uuid } from 'uuid';\nimport { Config } from '@backstage/config';\nimport { DatabaseService, LoggerService } from '@backstage/backend-plugin-api';\n\n/\n Search query that the Postgres search engine understands.\n * @public\n /\nexport type ConcretePgSearchQuery = {\n pgQuery: PgSearchQuery;\n pageSize: number;\n};\n\n/\n Options available for the Postgres specific query translator.\n * @public\n /\nexport type PgSearchQueryTranslatorOptions = {\n highlightOptions: PgSearchHighlightOptions;\n normalization?: number;\n};\n\n/\n Postgres specific query translator.\n * @public\n /\nexport type PgSearchQueryTranslator = (\n query: SearchQuery,\n options: PgSearchQueryTranslatorOptions,\n) => ConcretePgSearchQuery;\n\n/\n Options to instantiate PgSearchEngine\n * @public\n /\nexport type PgSearchOptions = {\n database: DatabaseService;\n logger?: LoggerService;\n};\n\n/\n Options for highlighting search terms\n * @public\n /\nexport type PgSearchHighlightOptions = {\n useHighlight?: boolean;\n maxWords?: number;\n minWords?: number;\n shortWord?: number;\n highlightAll?: boolean;\n maxFragments?: number;\n fragmentDelimiter?: string;\n preTag: string;\n postTag: string;\n};\n\n/* @public /\nexport class PgSearchEngine implements SearchEngine {\n private readonly logger?: LoggerService;\n private readonly highlightOptions: PgSearchHighlightOptions;\n private readonly indexerBatchSize: number;\n private readonly normalization: number;\n private readonly databaseStore: DatabaseStore;\n\n /\n @deprecated This will be marked as private in a future release, please us fromConfig instead\n /\n constructor(\n databaseStore: DatabaseStore,\n config: Config,\n logger?: LoggerService,\n ) {\n this.databaseStore = databaseStore;\n const uuidTag = uuid();\n const highlightConfig = config.getOptionalConfig(\n 'search.pg.highlightOptions',\n );\n\n const highlightOptions: PgSearchHighlightOptions = {\n preTag: `<${uuidTag}>`,\n postTag: `</${uuidTag}>`,\n useHighlight: highlightConfig?.getOptionalBoolean('useHighlight') ?? true,\n maxWords: highlightConfig?.getOptionalNumber('maxWords') ?? 35,\n minWords: highlightConfig?.getOptionalNumber('minWords') ?? 15,\n shortWord: highlightConfig?.getOptionalNumber('shortWord') ?? 3,\n highlightAll:\n highlightConfig?.getOptionalBoolean('highlightAll') ?? false,\n maxFragments: highlightConfig?.getOptionalNumber('maxFragments') ?? 0,\n fragmentDelimiter:\n highlightConfig?.getOptionalString('fragmentDelimiter') ?? ' ... ',\n };\n this.highlightOptions = highlightOptions;\n this.indexerBatchSize =\n config.getOptionalNumber('search.pg.indexerBatchSize') ?? 1000;\n\n this.normalization = this.getNormalizationValue(config);\n this.logger = logger;\n }\n\n private getNormalizationValue(config: Config) {\n const normalizationConfig =\n config.getOptional('search.pg.normalization') ?? 0;\n if (typeof normalizationConfig === 'number') {\n return normalizationConfig;\n } else if (typeof normalizationConfig === 'string') {\n return this.evaluateBitwiseOrExpression(normalizationConfig);\n }\n this.logger?.error(\n `Unknown normalization configuration: ${normalizationConfig}`,\n );\n\n return 0;\n }\n\n private evaluateBitwiseOrExpression(expression: string) {\n const tokens = expression.split('\|').map(token => token.trim());\n\n const numbers = tokens.map(token => {\n const num = parseInt(token, 10);\n if (isNaN(num)) {\n this.logger?.error(\n `Unknown expression for normalization: ${expression}`,\n );\n return 0;\n }\n return num;\n });\n return numbers.reduce((acc, num) => acc \| num, 0);\n }\n\n /\n @deprecated This will be removed in a future release, please use fromConfig instead\n /\n static async from(options: {\n database: DatabaseService;\n config: Config;\n logger?: LoggerService;\n }): Promise<PgSearchEngine> {\n return new PgSearchEngine(\n await DatabaseDocumentStore.create(options.database),\n options.config,\n options.logger,\n );\n }\n\n static async fromConfig(config: Config, options: PgSearchOptions) {\n return new PgSearchEngine(\n await DatabaseDocumentStore.create(options.database),\n config,\n options.logger,\n );\n }\n\n static async supported(database: DatabaseService): Promise<boolean> {\n return await DatabaseDocumentStore.supported(await database.getClient());\n }\n\n translator(\n query: SearchQuery,\n options: PgSearchQueryTranslatorOptions,\n ): ConcretePgSearchQuery {\n const pageSize = query.pageLimit \|\| 25;\n const { page } = decodePageCursor(query.pageCursor);\n const offset = page pageSize;\n // We request more result to know whether there is another page\n const limit = pageSize + 1;\n const normalization = options.normalization \|\| 0;\n\n return {\n pgQuery: {\n pgTerm: query.term\n .split(/\\s/)\n .map(p => p.replace(/[\\0()\|&:!<]/g, '').trim())\n .filter(p => p !== '')\n .map(p => `(${JSON.stringify(p)} \| ${JSON.stringify(p)}:)`)\n .join('&'),\n fields: query.filters as Record<string, string \| string[]>,\n types: query.types,\n offset,\n limit,\n normalization,\n options: options.highlightOptions,\n },\n pageSize,\n };\n }\n\n setTranslator(translator: PgSearchQueryTranslator) {\n this.translator = translator;\n }\n\n async getIndexer(type: string) {\n return new PgSearchEngineIndexer({\n batchSize: this.indexerBatchSize,\n type,\n databaseStore: this.databaseStore,\n logger: this.logger?.child({ documentType: type }),\n });\n }\n\n async query(query: SearchQuery): Promise<IndexableResultSet> {\n const { pgQuery, pageSize } = this.translator(query, {\n highlightOptions: this.highlightOptions,\n normalization: this.normalization,\n });\n\n const rows = await this.databaseStore.transaction(async tx =>\n this.databaseStore.query(tx, pgQuery),\n );\n\n // We requested one result more than the page size to know whether there is\n // another page.\n const { page } = decodePageCursor(query.pageCursor);\n const hasNextPage = rows.length > pageSize;\n const hasPreviousPage = page > 0;\n const pageRows = rows.slice(0, pageSize);\n const nextPageCursor = hasNextPage\n ? encodePageCursor({ page: page + 1 })\n : undefined;\n const previousPageCursor = hasPreviousPage\n ? encodePageCursor({ page: page - 1 })\n : undefined;\n\n const results = pageRows.map(\n ({ type, document, highlight }, index): IndexableResult => ({\n type,\n document,\n rank: page * pageSize + index + 1,\n highlight: {\n preTag: pgQuery.options.preTag,\n postTag: pgQuery.options.postTag,\n fields: highlight\n ? {\n text: highlight.text,\n title: highlight.title,\n location: highlight.location,\n path: '',\n }\n : {},\n },\n }),\n );\n\n return {\n results,\n numberOfResults: rows.length > 0 ? parseInt(rows[0].total_count, 10) : 0,\n nextPageCursor,\n previousPageCursor,\n };\n }\n}\n\nexport function decodePageCursor(pageCursor?: string): { page: number } {\n if (!pageCursor) {\n return { page: 0 };\n }\n\n return {\n page: Number(Buffer.from(pageCursor, 'base64').toString('utf-8')),\n };\n}\n\nexport function encodePageCursor({ page }: { page: number }): string {\n return Buffer.from(`${page}`, 'utf-8').toString('base64');\n}\n"],"names":["uuid","DatabaseDocumentStore","PgSearchEngineIndexer"],"mappings":";;;;;;AAqFO,MAAM,cAAA,CAAuC;AAAA,EACjC,MAAA;AAAA,EACA,gBAAA;AAAA,EACA,gBAAA;AAAA,EACA,aAAA;AAAA,EACA,aAAA;AAAA;AAAA;AAAA;AAAA,EAKjB,WAAA,CACE,aAAA,EACA,MAAA,EACA,MAAA,EACA;AACA,IAAA,IAAA,CAAK,aAAA,GAAgB,aAAA;AACrB,IAAA,MAAM,UAAUA,OAAA,EAAK;AACrB,IAAA,MAAM,kBAAkB,MAAA,CAAO,iBAAA;AAAA,MAC7B;AAAA,KACF;AAEA,IAAA,MAAM,gBAAA,GAA6C;AAAA,MACjD,MAAA,EAAQ,IAAI,OAAO,CAAA,CAAA,CAAA;AAAA,MACnB,OAAA,EAAS,KAAK,OAAO,CAAA,CAAA,CAAA;AAAA,MACrB,YAAA,EAAc,eAAA,EAAiB,kBAAA,CAAmB,cAAc,CAAA,IAAK,IAAA;AAAA,MACrE,QAAA,EAAU,eAAA,EAAiB,iBAAA,CAAkB,UAAU,CAAA,IAAK,EAAA;AAAA,MAC5D,QAAA,EAAU,eAAA,EAAiB,iBAAA,CAAkB,UAAU,CAAA,IAAK,EAAA;AAAA,MAC5D,SAAA,EAAW,eAAA,EAAiB,iBAAA,CAAkB,WAAW,CAAA,IAAK,CAAA;AAAA,MAC9D,YAAA,EACE,eAAA,EAAiB,kBAAA,CAAmB,cAAc,CAAA,IAAK,KAAA;AAAA,MACzD,YAAA,EAAc,eAAA,EAAiB,iBAAA,CAAkB,cAAc,CAAA,IAAK,CAAA;AAAA,MACpE,iBAAA,EACE,eAAA,EAAiB,iBAAA,CAAkB,mBAAmB,CAAA,IAAK;AAAA,KAC/D;AACA,IAAA,IAAA,CAAK,gBAAA,GAAmB,gBAAA;AACxB,IAAA,IAAA,CAAK,gBAAA,GACH,MAAA,CAAO,iBAAA,CAAkB,4BAA4B,CAAA,IAAK,GAAA;AAE5D,IAAA,IAAA,CAAK,aAAA,GAAgB,IAAA,CAAK,qBAAA,CAAsB,MAAM,CAAA;AACtD,IAAA,IAAA,CAAK,MAAA,GAAS,MAAA;AAAA,EAChB;AAAA,EAEQ,sBAAsB,MAAA,EAAgB;AAC5C,IAAA,MAAM,mBAAA,GACJ,MAAA,CAAO,WAAA,CAAY,yBAAyB,CAAA,IAAK,CAAA;AACnD,IAAA,IAAI,OAAO,wBAAwB,QAAA,EAAU;AAC3C,MAAA,OAAO,mBAAA;AAAA,IACT,CAAA,MAAA,IAAW,OAAO,mBAAA,KAAwB,QAAA,EAAU;AAClD,MAAA,OAAO,IAAA,CAAK,4BAA4B,mBAAmB,CAAA;AAAA,IAC7D;AACA,IAAA,IAAA,CAAK,MAAA,EAAQ,KAAA;AAAA,MACX,wCAAwC,mBAAmB,CAAA;AAAA,KAC7D;AAEA,IAAA,OAAO,CAAA;AAAA,EACT;AAAA,EAEQ,4BAA4B,UAAA,EAAoB;AACtD,IAAA,MAAM,MAAA,GAAS,WAAW,KAAA,CAAM,GAAG,EAAE,GAAA,CAAI,CAAA,KAAA,KAAS,KAAA,CAAM,IAAA,EAAM,CAAA;AAE9D,IAAA,MAAM,OAAA,GAAU,MAAA,CAAO,GAAA,CAAI,CAAA,KAAA,KAAS;AAClC,MAAA,MAAM,GAAA,GAAM,QAAA,CAAS,KAAA,EAAO,EAAE,CAAA;AAC9B,MAAA,IAAI,KAAA,CAAM,GAAG,CAAA,EAAG;AACd,QAAA,IAAA,CAAK,MAAA,EAAQ,KAAA;AAAA,UACX,yCAAyC,UAAU,CAAA;AAAA,SACrD;AACA,QAAA,OAAO,CAAA;AAAA,MACT;AACA,MAAA,OAAO,GAAA;AAAA,IACT,CAAC,CAAA;AACD,IAAA,OAAO,QAAQ,MAAA,CAAO,CAAC,KAAK,GAAA,KAAQ,GAAA,GAAM,KAAK,CAAC,CAAA;AAAA,EAClD;AAAA;AAAA;AAAA;AAAA,EAKA,aAAa,KAAK,OAAA,EAIU;AAC1B,IAAA,OAAO,IAAI,cAAA;AAAA,MACT,MAAMC,2CAAA,CAAsB,MAAA,CAAO,OAAA,CAAQ,QAAQ,CAAA;AAAA,MACnD,OAAA,CAAQ,MAAA;AAAA,MACR,OAAA,CAAQ;AAAA,KACV;AAAA,EACF;AAAA,EAEA,aAAa,UAAA,CAAW,MAAA,EAAgB,OAAA,EAA0B;AAChE,IAAA,OAAO,IAAI,cAAA;AAAA,MACT,MAAMA,2CAAA,CAAsB,MAAA,CAAO,OAAA,CAAQ,QAAQ,CAAA;AAAA,MACnD,MAAA;AAAA,MACA,OAAA,CAAQ;AAAA,KACV;AAAA,EACF;AAAA,EAEA,aAAa,UAAU,QAAA,EAA6C;AAClE,IAAA,OAAO,MAAMA,2CAAA,CAAsB,SAAA,CAAU,MAAM,QAAA,CAAS,WAAW,CAAA;AAAA,EACzE;AAAA,EAEA,UAAA,CACE,OACA,OAAA,EACuB;AACvB,IAAA,MAAM,QAAA,GAAW,MAAM,SAAA,IAAa,EAAA;AACpC,IAAA,MAAM,EAAE,IAAA,EAAK,GAAI,gBAAA,CAAiB,MAAM,UAAU,CAAA;AAClD,IAAA,MAAM,SAAS,IAAA,GAAO,QAAA;AAEtB,IAAA,MAAM,QAAQ,QAAA,GAAW,CAAA;AACzB,IAAA,MAAM,aAAA,GAAgB,QAAQ,aAAA,IAAiB,CAAA;AAE/C,IAAA,OAAO;AAAA,MACL,OAAA,EAAS;AAAA,QACP,QAAQ,KAAA,CAAM,IAAA,CACX,KAAA,CAAM,IAAI,EACV,GAAA,CAAI,CAAA,CAAA,KAAK,CAAA,CAAE,OAAA,CAAQ,iBAAiB,EAAE,CAAA,CAAE,IAAA,EAAM,EAC9C,MAAA,CAAO,CAAA,CAAA,KAAK,CAAA,KAAM,EAAE,EACpB,GAAA,CAAI,CAAA,CAAA,KAAK,CAAA,CAAA,EAAI,IAAA,CAAK,UAAU,CAAC,CAAC,CAAA,GAAA,EAAM,IAAA,CAAK,UAAU,CAAC,CAAC,CAAA,GAAA,CAAK,CAAA,CAC1D,KAAK,GAAG,CAAA;AAAA,QACX,QAAQ,KAAA,CAAM,OAAA;AAAA,QACd,OAAO,KAAA,CAAM,KAAA;AAAA,QACb,MAAA;AAAA,QACA,KAAA;AAAA,QACA,aAAA;AAAA,QACA,SAAS,OAAA,CAAQ;AAAA,OACnB;AAAA,MACA;AAAA,KACF;AAAA,EACF;AAAA,EAEA,cAAc,UAAA,EAAqC;AACjD,IAAA,IAAA,CAAK,UAAA,GAAa,UAAA;AAAA,EACpB;AAAA,EAEA,MAAM,WAAW,IAAA,EAAc;AAC7B,IAAA,OAAO,IAAIC,2CAAA,CAAsB;AAAA,MAC/B,WAAW,IAAA,CAAK,gBAAA;AAAA,MAChB,IAAA;AAAA,MACA,eAAe,IAAA,CAAK,aAAA;AAAA,MACpB,QAAQ,IAAA,CAAK,MAAA,EAAQ,MAAM,EAAE,YAAA,EAAc,MAAM;AAAA,KAClD,CAAA;AAAA,EACH;AAAA,EAEA,MAAM,MAAM,KAAA,EAAiD;AAC3D,IAAA,MAAM,EAAE,OAAA,EAAS,QAAA,EAAS,GAAI,IAAA,CAAK,WAAW,KAAA,EAAO;AAAA,MACnD,kBAAkB,IAAA,CAAK,gBAAA;AAAA,MACvB,eAAe,IAAA,CAAK;AAAA,KACrB,CAAA;AAED,IAAA,MAAM,IAAA,GAAO,MAAM,IAAA,CAAK,aAAA,CAAc,WAAA;AAAA,MAAY,OAAM,EAAA,KACtD,IAAA,CAAK,aAAA,CAAc,KAAA,CAAM,IAAI,OAAO;AAAA,KACtC;AAIA,IAAA,MAAM,EAAE,IAAA,EAAK,GAAI,gBAAA,CAAiB,MAAM,UAAU,CAAA;AAClD,IAAA,MAAM,WAAA,GAAc,KAAK,MAAA,GAAS,QAAA;AAClC,IAAA,MAAM,kBAAkB,IAAA,GAAO,CAAA;AAC/B,IAAA,MAAM,QAAA,GAAW,IAAA,CAAK,KAAA,CAAM,CAAA,EAAG,QAAQ,CAAA;AACvC,IAAA,MAAM,cAAA,GAAiB,cACnB,gBAAA,CAAiB,EAAE,MAAM,IAAA,GAAO,CAAA,EAAG,CAAA,GACnC,MAAA;AACJ,IAAA,MAAM,kBAAA,GAAqB,kBACvB,gBAAA,CAAiB,EAAE,MAAM,IAAA,GAAO,CAAA,EAAG,CAAA,GACnC,MAAA;AAEJ,IAAA,MAAM,UAAU,QAAA,CAAS,GAAA;AAAA,MACvB,CAAC,EAAE,IAAA,EAAM,QAAA,EAAU,SAAA,IAAa,KAAA,MAA4B;AAAA,QAC1D,IAAA;AAAA,QACA,QAAA;AAAA,QACA,IAAA,EAAM,IAAA,GAAO,QAAA,GAAW,KAAA,GAAQ,CAAA;AAAA,QAChC,SAAA,EAAW;AAAA,UACT,MAAA,EAAQ,QAAQ,OAAA,CAAQ,MAAA;AAAA,UACxB,OAAA,EAAS,QAAQ,OAAA,CAAQ,OAAA;AAAA,UACzB,QAAQ,SAAA,GACJ;AAAA,YACE,MAAM,SAAA,CAAU,IAAA;AAAA,YAChB,OAAO,SAAA,CAAU,KAAA;AAAA,YACjB,UAAU,SAAA,CAAU,QAAA;AAAA,YACpB,IAAA,EAAM;AAAA,cAER;AAAC;AACP,OACF;AAAA,KACF;AAEA,IAAA,OAAO;AAAA,MACL,OAAA;AAAA,MACA,eAAA,EAAiB,IAAA,CAAK,MAAA,GAAS,CAAA,GAAI,QAAA,CAAS,KAAK,CAAC,CAAA,CAAE,WAAA,EAAa,EAAE,CAAA,GAAI,CAAA;AAAA,MACvE,cAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF;AACF;AAEO,SAAS,iBAAiB,UAAA,EAAuC;AACtE,EAAA,IAAI,CAAC,UAAA,EAAY;AACf,IAAA,OAAO,EAAE,MAAM,CAAA,EAAE;AAAA,EACnB;AAEA,EAAA,OAAO;AAAA,IACL,IAAA,EAAM,OAAO,MAAA,CAAO,IAAA,CAAK,YAAY,QAAQ,CAAA,CAAE,QAAA,CAAS,OAAO,CAAC;AAAA,GAClE;AACF;AAEO,SAAS,gBAAA,CAAiB,EAAE,IAAA,EAAK,EAA6B;AACnE,EAAA,OAAO,MAAA,CAAO,KAAK,CAAA,EAAG,IAAI,IAAI,OAAO,CAAA,CAAE,SAAS,QAAQ,CAAA;AAC1D;;;;;;"}

package/dist/database/DatabaseDocumentStore.cjs.js CHANGED Viewed

@@ -112,6 +112,7 @@ class DatabaseDocumentStore {
       });
     }
     query.select("type", "document");
+    query.select(tx.raw("COUNT(*) OVER() AS total_count"));
     if (pgTerm && options.useHighlight) {
       const headlineOptions = `MaxWords=${options.maxWords}, MinWords=${options.minWords}, ShortWord=${options.shortWord}, HighlightAll=${options.highlightAll}, MaxFragments=${options.maxFragments}, FragmentDelimiter=${options.fragmentDelimiter}, StartSel=${options.preTag}, StopSel=${options.postTag}`;
       query.select(tx.raw(`ts_rank_cd(body, query, ${normalization}) AS "rank"`)).select(

package/dist/database/DatabaseDocumentStore.cjs.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"DatabaseDocumentStore.cjs.js","sources":["../../src/database/DatabaseDocumentStore.ts"],"sourcesContent":["/\n Copyright 2021 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 /\nimport {\n DatabaseService,\n resolvePackagePath,\n} from '@backstage/backend-plugin-api';\nimport { IndexableDocument } from '@backstage/plugin-search-common';\nimport { Knex } from 'knex';\nimport {\n DatabaseStore,\n DocumentResultRow,\n PgSearchQuery,\n RawDocumentRow,\n} from './types';\nimport { queryPostgresMajorVersion } from './util';\n\nconst migrationsDir = resolvePackagePath(\n '@backstage/plugin-search-backend-module-pg',\n 'migrations',\n);\n\n/* @public */\nexport class DatabaseDocumentStore implements DatabaseStore {\n static async create(\n database: DatabaseService,\n ): Promise<DatabaseDocumentStore> {\n const knex = await database.getClient();\n try {\n const majorVersion = await queryPostgresMajorVersion(knex);\n\n if (majorVersion < 12) {\n // We are using some features (like generated columns) that aren't\n // available in older postgres versions.\n throw new Error(\n `The PgSearchEngine requires at least postgres version 12 (but is running on ${majorVersion})`,\n );\n }\n } catch {\n // Actually both mysql and sqlite have a full text search, too. We could\n // implement them separately or add them here.\n throw new Error(\n 'The PgSearchEngine is only supported when using a postgres database (>=12.x)',\n );\n }\n\n if (!database.migrations?.skip) {\n await knex.migrate.latest({\n directory: migrationsDir,\n });\n }\n\n return new DatabaseDocumentStore(knex);\n }\n\n static async supported(knex: Knex): Promise<boolean> {\n try {\n const majorVersion = await queryPostgresMajorVersion(knex);\n\n return majorVersion >= 12;\n } catch {\n return false;\n }\n }\n\n private readonly db: Knex;\n\n constructor(db: Knex) {\n this.db = db;\n }\n\n async transaction<T>(fn: (tx: Knex.Transaction) => Promise<T>): Promise<T> {\n return await this.db.transaction(fn);\n }\n\n async getTransaction(): Promise<Knex.Transaction> {\n return this.db.transaction();\n }\n\n async prepareInsert(tx: Knex.Transaction): Promise<void> {\n // We create a temporary table to collect the hashes of the documents that\n // we expect to be in the documents table at the end. The table is deleted\n // at the end of the transaction.\n // The hash makes sure that we generate a new row for every change.\n await tx.raw(\n 'CREATE TEMP TABLE documents_to_insert (' +\n 'type text NOT NULL, ' +\n 'document jsonb NOT NULL, ' +\n // Generating the hash requires a trick, as the text to bytea\n // conversation runs into errors in case the text contains a backslash.\n // Therefore we have to escape them.\n \"hash bytea NOT NULL GENERATED ALWAYS AS (sha256(replace(document::text \|\| type, '\\\\', '\\\\\\\\')::bytea)) STORED\" +\n ') ON COMMIT DROP',\n );\n }\n\n async completeInsert(\n tx: Knex.Transaction,\n type: string,\n truncate = false,\n ): Promise<void> {\n const documentSelect = truncate\n ? tx.raw(\n `jsonb_set(document, '{text}', to_jsonb(LEFT(document->>'text', 50000))) as document`,\n )\n : 'document';\n\n // Copy all new rows into the documents table\n await tx\n .insert(\n tx<RawDocumentRow>('documents_to_insert').select(\n 'type',\n documentSelect,\n 'hash',\n ),\n )\n .into(tx.raw('documents (type, document, hash)'))\n .onConflict('hash')\n .ignore();\n\n // Delete all documents that we don't expect (deleted and changed)\n const rowsToDelete = tx<RawDocumentRow>('documents')\n .select('documents.hash')\n .leftJoin<RawDocumentRow>('documents_to_insert', {\n 'documents.hash': 'documents_to_insert.hash',\n })\n .whereNull('documents_to_insert.hash');\n\n await tx<RawDocumentRow>('documents')\n .where({ type })\n .whereIn('hash', rowsToDelete)\n .delete();\n }\n\n async insertDocuments(\n tx: Knex.Transaction,\n type: string,\n documents: IndexableDocument[],\n ): Promise<void> {\n // Insert all documents into the temporary table to process them later\n await tx<DocumentResultRow>('documents_to_insert').insert(\n documents.map(document => ({\n type,\n document: {\n ...document,\n // text: truncateDocsText(document.text),\n },\n })),\n );\n }\n\n async query(\n tx: Knex.Transaction,\n searchQuery: PgSearchQuery,\n ): Promise<DocumentResultRow[]> {\n const {\n types,\n pgTerm,\n fields,\n offset,\n limit,\n normalization = 0,\n options,\n } = searchQuery;\n // TODO(awanlin): We should make the language a parameter so that we can support more then just english\n // Builds a query like:\n // SELECT ts_rank_cd(body, query, 0) AS rank, type, document,\n // ts_headline('english', document, query) AS highlight\n // FROM documents, to_tsquery('english', 'consent') query\n // WHERE query @@ body AND (document @> '{\"kind\": \"API\"}')\n // ORDER BY rank DESC\n // LIMIT 10;\n const query = tx<DocumentResultRow>('documents');\n\n if (pgTerm) {\n query\n .from(tx.raw(\"documents, to_tsquery('english', ?) query\", pgTerm))\n .whereRaw('query @@ body');\n } else {\n query.from('documents');\n }\n\n if (types) {\n query.whereIn('type', types);\n }\n\n if (fields) {\n Object.keys(fields).forEach(key => {\n const value = fields[key];\n const valueArray = Array.isArray(value) ? value : [value];\n const fieldValueCompare = valueArray\n .map(v => ({ [key]: v }))\n .map(v => JSON.stringify(v));\n const arrayValueCompare = valueArray\n .map(v => ({ [key]: [v] }))\n .map(v => JSON.stringify(v));\n const valueCompare = [...fieldValueCompare, ...arrayValueCompare];\n query.whereRaw(\n `(${valueCompare.map(() => 'document @> ?').join(' OR ')})`,\n valueCompare,\n );\n });\n }\n\n query.select('type', 'document');\n\n if (pgTerm && options.useHighlight) {\n const headlineOptions = `MaxWords=${options.maxWords}, MinWords=${options.minWords}, ShortWord=${options.shortWord}, HighlightAll=${options.highlightAll}, MaxFragments=${options.maxFragments}, FragmentDelimiter=${options.fragmentDelimiter}, StartSel=${options.preTag}, StopSel=${options.postTag}`;\n query\n .select(tx.raw(`ts_rank_cd(body, query, ${normalization}) AS \"rank\"`))\n .select(\n tx.raw(\n `ts_headline(\\'english\\', document, query, '${headlineOptions}') as \"highlight\"`,\n ),\n )\n .orderBy('rank', 'desc');\n } else if (pgTerm && !options.useHighlight) {\n query\n .select(tx.raw(`ts_rank_cd(body, query, ${normalization}) AS \"rank\"`))\n .orderBy('rank', 'desc');\n } else {\n query.select(tx.raw('1 as rank'));\n }\n\n return await query.offset(offset).limit(limit);\n }\n}\n"],"names":["resolvePackagePath","queryPostgresMajorVersion"],"mappings":";;;;;AA6BA,MAAM,aAAA,GAAgBA,mCAAA;AAAA,EACpB,4CAAA;AAAA,EACA;AACF,CAAA;AAGO,MAAM,qBAAA,CAA+C;AAAA,EAC1D,aAAa,OACX,QAAA,EACgC;AAChC,IAAA,MAAM,IAAA,GAAO,MAAM,QAAA,CAAS,SAAA,EAAU;AACtC,IAAA,IAAI;AACF,MAAA,MAAM,YAAA,GAAe,MAAMC,8BAAA,CAA0B,IAAI,CAAA;AAEzD,MAAA,IAAI,eAAe,EAAA,EAAI;AAGrB,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,+EAA+E,YAAY,CAAA,CAAA;AAAA,SAC7F;AAAA,MACF;AAAA,IACF,CAAA,CAAA,MAAQ;AAGN,MAAA,MAAM,IAAI,KAAA;AAAA,QACR;AAAA,OACF;AAAA,IACF;AAEA,IAAA,IAAI,CAAC,QAAA,CAAS,UAAA,EAAY,IAAA,EAAM;AAC9B,MAAA,MAAM,IAAA,CAAK,QAAQ,MAAA,CAAO;AAAA,QACxB,SAAA,EAAW;AAAA,OACZ,CAAA;AAAA,IACH;AAEA,IAAA,OAAO,IAAI,sBAAsB,IAAI,CAAA;AAAA,EACvC;AAAA,EAEA,aAAa,UAAU,IAAA,EAA8B;AACnD,IAAA,IAAI;AACF,MAAA,MAAM,YAAA,GAAe,MAAMA,8BAAA,CAA0B,IAAI,CAAA;AAEzD,MAAA,OAAO,YAAA,IAAgB,EAAA;AAAA,IACzB,CAAA,CAAA,MAAQ;AACN,MAAA,OAAO,KAAA;AAAA,IACT;AAAA,EACF;AAAA,EAEiB,EAAA;AAAA,EAEjB,YAAY,EAAA,EAAU;AACpB,IAAA,IAAA,CAAK,EAAA,GAAK,EAAA;AAAA,EACZ;AAAA,EAEA,MAAM,YAAe,EAAA,EAAsD;AACzE,IAAA,OAAO,MAAM,IAAA,CAAK,EAAA,CAAG,WAAA,CAAY,EAAE,CAAA;AAAA,EACrC;AAAA,EAEA,MAAM,cAAA,GAA4C;AAChD,IAAA,OAAO,IAAA,CAAK,GAAG,WAAA,EAAY;AAAA,EAC7B;AAAA,EAEA,MAAM,cAAc,EAAA,EAAqC;AAKvD,IAAA,MAAM,EAAA,CAAG,GAAA;AAAA,MACP;AAAA,KAQF;AAAA,EACF;AAAA,EAEA,MAAM,cAAA,CACJ,EAAA,EACA,IAAA,EACA,WAAW,KAAA,EACI;AACf,IAAA,MAAM,cAAA,GAAiB,WACnB,EAAA,CAAG,GAAA;AAAA,MACD,CAAA,mFAAA;AAAA,KACF,GACA,UAAA;AAGJ,IAAA,MAAM,EAAA,CACH,MAAA;AAAA,MACC,EAAA,CAAmB,qBAAqB,CAAA,CAAE,MAAA;AAAA,QACxC,MAAA;AAAA,QACA,cAAA;AAAA,QACA;AAAA;AACF,KACF,CACC,IAAA,CAAK,EAAA,CAAG,GAAA,CAAI,kCAAkC,CAAC,CAAA,CAC/C,UAAA,CAAW,MAAM,CAAA,CACjB,MAAA,EAAO;AAGV,IAAA,MAAM,YAAA,GAAe,GAAmB,WAAW,CAAA,CAChD,OAAO,gBAAgB,CAAA,CACvB,SAAyB,qBAAA,EAAuB;AAAA,MAC/C,gBAAA,EAAkB;AAAA,KACnB,CAAA,CACA,SAAA,CAAU,0BAA0B,CAAA;AAEvC,IAAA,MAAM,EAAA,CAAmB,WAAW,CAAA,CACjC,KAAA,CAAM,EAAE,IAAA,EAAM,CAAA,CACd,OAAA,CAAQ,MAAA,EAAQ,YAAY,CAAA,CAC5B,MAAA,EAAO;AAAA,EACZ;AAAA,EAEA,MAAM,eAAA,CACJ,EAAA,EACA,IAAA,EACA,SAAA,EACe;AAEf,IAAA,MAAM,EAAA,CAAsB,qBAAqB,CAAA,CAAE,MAAA;AAAA,MACjD,SAAA,CAAU,IAAI,CAAA,QAAA,MAAa;AAAA,QACzB,IAAA;AAAA,QACA,QAAA,EAAU;AAAA,UACR,GAAG;AAAA;AAAA;AAEL,OACF,CAAE;AAAA,KACJ;AAAA,EACF;AAAA,EAEA,MAAM,KAAA,CACJ,EAAA,EACA,WAAA,EAC8B;AAC9B,IAAA,MAAM;AAAA,MACJ,KAAA;AAAA,MACA,MAAA;AAAA,MACA,MAAA;AAAA,MACA,MAAA;AAAA,MACA,KAAA;AAAA,MACA,aAAA,GAAgB,CAAA;AAAA,MAChB;AAAA,KACF,GAAI,WAAA;AASJ,IAAA,MAAM,KAAA,GAAQ,GAAsB,WAAW,CAAA;AAE/C,IAAA,IAAI,MAAA,EAAQ;AACV,MAAA,KAAA,CACG,IAAA,CAAK,GAAG,GAAA,CAAI,2CAAA,EAA6C,MAAM,CAAC,CAAA,CAChE,SAAS,eAAe,CAAA;AAAA,IAC7B,CAAA,MAAO;AACL,MAAA,KAAA,CAAM,KAAK,WAAW,CAAA;AAAA,IACxB;AAEA,IAAA,IAAI,KAAA,EAAO;AACT,MAAA,KAAA,CAAM,OAAA,CAAQ,QAAQ,KAAK,CAAA;AAAA,IAC7B;AAEA,IAAA,IAAI,MAAA,EAAQ;AACV,MAAA,MAAA,CAAO,IAAA,CAAK,MAAM,CAAA,CAAE,OAAA,CAAQ,CAAA,GAAA,KAAO;AACjC,QAAA,MAAM,KAAA,GAAQ,OAAO,GAAG,CAAA;AACxB,QAAA,MAAM,aAAa,KAAA,CAAM,OAAA,CAAQ,KAAK,CAAA,GAAI,KAAA,GAAQ,CAAC,KAAK,CAAA;AACxD,QAAA,MAAM,oBAAoB,UAAA,CACvB,GAAA,CAAI,CAAA,CAAA,MAAM,EAAE,CAAC,GAAG,GAAG,CAAA,EAAE,CAAE,EACvB,GAAA,CAAI,CAAA,CAAA,KAAK,IAAA,CAAK,SAAA,CAAU,CAAC,CAAC,CAAA;AAC7B,QAAA,MAAM,oBAAoB,UAAA,CACvB,GAAA,CAAI,QAAM,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,CAAA,GAAI,CAAA,CACzB,GAAA,CAAI,OAAK,IAAA,CAAK,SAAA,CAAU,CAAC,CAAC,CAAA;AAC7B,QAAA,MAAM,YAAA,GAAe,CAAC,GAAG,iBAAA,EAAmB,GAAG,iBAAiB,CAAA;AAChE,QAAA,KAAA,CAAM,QAAA;AAAA,UACJ,CAAA,CAAA,EAAI,aAAa,GAAA,CAAI,MAAM,eAAe,CAAA,CAAE,IAAA,CAAK,MAAM,CAAC,CAAA,CAAA,CAAA;AAAA,UACxD;AAAA,SACF;AAAA,MACF,CAAC,CAAA;AAAA,IACH;AAEA,IAAA,KAAA,CAAM,MAAA,CAAO,QAAQ,UAAU,CAAA;AAE/B,IAAA,IAAI,MAAA,IAAU,QAAQ,YAAA,EAAc;AAClC,MAAA,MAAM,eAAA,GAAkB,CAAA,SAAA,EAAY,OAAA,CAAQ,QAAQ,CAAA,WAAA,EAAc,QAAQ,QAAQ,CAAA,YAAA,EAAe,OAAA,CAAQ,SAAS,CAAA,eAAA,EAAkB,OAAA,CAAQ,YAAY,CAAA,eAAA,EAAkB,OAAA,CAAQ,YAAY,CAAA,oBAAA,EAAuB,OAAA,CAAQ,iBAAiB,cAAc,OAAA,CAAQ,MAAM,CAAA,UAAA,EAAa,OAAA,CAAQ,OAAO,CAAA,CAAA;AACtS,MAAA,KAAA,CACG,OAAO,EAAA,CAAG,GAAA,CAAI,2BAA2B,aAAa,CAAA,WAAA,CAAa,CAAC,CAAA,CACpE,MAAA;AAAA,QACC,EAAA,CAAG,GAAA;AAAA,UACD,4CAA8C,eAAe,CAAA,iBAAA;AAAA;AAC/D,OACF,CACC,OAAA,CAAQ,MAAA,EAAQ,MAAM,CAAA;AAAA,IAC3B,CAAA,MAAA,IAAW,MAAA,IAAU,CAAC,OAAA,CAAQ,YAAA,EAAc;AAC1C,MAAA,KAAA,CACG,MAAA,CAAO,EAAA,CAAG,GAAA,CAAI,CAAA,wBAAA,EAA2B,aAAa,aAAa,CAAC,CAAA,CACpE,OAAA,CAAQ,MAAA,EAAQ,MAAM,CAAA;AAAA,IAC3B,CAAA,MAAO;AACL,MAAA,KAAA,CAAM,MAAA,CAAO,EAAA,CAAG,GAAA,CAAI,WAAW,CAAC,CAAA;AAAA,IAClC;AAEA,IAAA,OAAO,MAAM,KAAA,CAAM,MAAA,CAAO,MAAM,CAAA,CAAE,MAAM,KAAK,CAAA;AAAA,EAC/C;AACF;;;;"}
1	+ {"version":3,"file":"DatabaseDocumentStore.cjs.js","sources":["../../src/database/DatabaseDocumentStore.ts"],"sourcesContent":["/\n Copyright 2021 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 /\nimport {\n DatabaseService,\n resolvePackagePath,\n} from '@backstage/backend-plugin-api';\nimport { IndexableDocument } from '@backstage/plugin-search-common';\nimport { Knex } from 'knex';\nimport {\n DatabaseStore,\n DocumentResultRow,\n PgSearchQuery,\n RawDocumentRow,\n} from './types';\nimport { queryPostgresMajorVersion } from './util';\n\nconst migrationsDir = resolvePackagePath(\n '@backstage/plugin-search-backend-module-pg',\n 'migrations',\n);\n\n/* @public /\nexport class DatabaseDocumentStore implements DatabaseStore {\n static async create(\n database: DatabaseService,\n ): Promise<DatabaseDocumentStore> {\n const knex = await database.getClient();\n try {\n const majorVersion = await queryPostgresMajorVersion(knex);\n\n if (majorVersion < 12) {\n // We are using some features (like generated columns) that aren't\n // available in older postgres versions.\n throw new Error(\n `The PgSearchEngine requires at least postgres version 12 (but is running on ${majorVersion})`,\n );\n }\n } catch {\n // Actually both mysql and sqlite have a full text search, too. We could\n // implement them separately or add them here.\n throw new Error(\n 'The PgSearchEngine is only supported when using a postgres database (>=12.x)',\n );\n }\n\n if (!database.migrations?.skip) {\n await knex.migrate.latest({\n directory: migrationsDir,\n });\n }\n\n return new DatabaseDocumentStore(knex);\n }\n\n static async supported(knex: Knex): Promise<boolean> {\n try {\n const majorVersion = await queryPostgresMajorVersion(knex);\n\n return majorVersion >= 12;\n } catch {\n return false;\n }\n }\n\n private readonly db: Knex;\n\n constructor(db: Knex) {\n this.db = db;\n }\n\n async transaction<T>(fn: (tx: Knex.Transaction) => Promise<T>): Promise<T> {\n return await this.db.transaction(fn);\n }\n\n async getTransaction(): Promise<Knex.Transaction> {\n return this.db.transaction();\n }\n\n async prepareInsert(tx: Knex.Transaction): Promise<void> {\n // We create a temporary table to collect the hashes of the documents that\n // we expect to be in the documents table at the end. The table is deleted\n // at the end of the transaction.\n // The hash makes sure that we generate a new row for every change.\n await tx.raw(\n 'CREATE TEMP TABLE documents_to_insert (' +\n 'type text NOT NULL, ' +\n 'document jsonb NOT NULL, ' +\n // Generating the hash requires a trick, as the text to bytea\n // conversation runs into errors in case the text contains a backslash.\n // Therefore we have to escape them.\n \"hash bytea NOT NULL GENERATED ALWAYS AS (sha256(replace(document::text \|\| type, '\\\\', '\\\\\\\\')::bytea)) STORED\" +\n ') ON COMMIT DROP',\n );\n }\n\n async completeInsert(\n tx: Knex.Transaction,\n type: string,\n truncate = false,\n ): Promise<void> {\n const documentSelect = truncate\n ? tx.raw(\n `jsonb_set(document, '{text}', to_jsonb(LEFT(document->>'text', 50000))) as document`,\n )\n : 'document';\n\n // Copy all new rows into the documents table\n await tx\n .insert(\n tx<RawDocumentRow>('documents_to_insert').select(\n 'type',\n documentSelect,\n 'hash',\n ),\n )\n .into(tx.raw('documents (type, document, hash)'))\n .onConflict('hash')\n .ignore();\n\n // Delete all documents that we don't expect (deleted and changed)\n const rowsToDelete = tx<RawDocumentRow>('documents')\n .select('documents.hash')\n .leftJoin<RawDocumentRow>('documents_to_insert', {\n 'documents.hash': 'documents_to_insert.hash',\n })\n .whereNull('documents_to_insert.hash');\n\n await tx<RawDocumentRow>('documents')\n .where({ type })\n .whereIn('hash', rowsToDelete)\n .delete();\n }\n\n async insertDocuments(\n tx: Knex.Transaction,\n type: string,\n documents: IndexableDocument[],\n ): Promise<void> {\n // Insert all documents into the temporary table to process them later\n await tx<DocumentResultRow>('documents_to_insert').insert(\n documents.map(document => ({\n type,\n document: {\n ...document,\n // text: truncateDocsText(document.text),\n },\n })),\n );\n }\n\n async query(\n tx: Knex.Transaction,\n searchQuery: PgSearchQuery,\n ): Promise<DocumentResultRow[]> {\n const {\n types,\n pgTerm,\n fields,\n offset,\n limit,\n normalization = 0,\n options,\n } = searchQuery;\n // TODO(awanlin): We should make the language a parameter so that we can support more then just english\n // Builds a query like:\n // SELECT ts_rank_cd(body, query, 0) AS rank, type, document,\n // ts_headline('english', document, query) AS highlight\n // FROM documents, to_tsquery('english', 'consent') query\n // WHERE query @@ body AND (document @> '{\"kind\": \"API\"}')\n // ORDER BY rank DESC\n // LIMIT 10;\n const query = tx<DocumentResultRow>('documents');\n\n if (pgTerm) {\n query\n .from(tx.raw(\"documents, to_tsquery('english', ?) query\", pgTerm))\n .whereRaw('query @@ body');\n } else {\n query.from('documents');\n }\n\n if (types) {\n query.whereIn('type', types);\n }\n\n if (fields) {\n Object.keys(fields).forEach(key => {\n const value = fields[key];\n const valueArray = Array.isArray(value) ? value : [value];\n const fieldValueCompare = valueArray\n .map(v => ({ [key]: v }))\n .map(v => JSON.stringify(v));\n const arrayValueCompare = valueArray\n .map(v => ({ [key]: [v] }))\n .map(v => JSON.stringify(v));\n const valueCompare = [...fieldValueCompare, ...arrayValueCompare];\n query.whereRaw(\n `(${valueCompare.map(() => 'document @> ?').join(' OR ')})`,\n valueCompare,\n );\n });\n }\n\n query.select('type', 'document');\n query.select(tx.raw('COUNT() OVER() AS total_count'));\n\n if (pgTerm && options.useHighlight) {\n const headlineOptions = `MaxWords=${options.maxWords}, MinWords=${options.minWords}, ShortWord=${options.shortWord}, HighlightAll=${options.highlightAll}, MaxFragments=${options.maxFragments}, FragmentDelimiter=${options.fragmentDelimiter}, StartSel=${options.preTag}, StopSel=${options.postTag}`;\n query\n .select(tx.raw(`ts_rank_cd(body, query, ${normalization}) AS \"rank\"`))\n .select(\n tx.raw(\n `ts_headline(\\'english\\', document, query, '${headlineOptions}') as \"highlight\"`,\n ),\n )\n .orderBy('rank', 'desc');\n } else if (pgTerm && !options.useHighlight) {\n query\n .select(tx.raw(`ts_rank_cd(body, query, ${normalization}) AS \"rank\"`))\n .orderBy('rank', 'desc');\n } else {\n query.select(tx.raw('1 as rank'));\n }\n\n return await query.offset(offset).limit(limit);\n }\n}\n"],"names":["resolvePackagePath","queryPostgresMajorVersion"],"mappings":";;;;;AA6BA,MAAM,aAAA,GAAgBA,mCAAA;AAAA,EACpB,4CAAA;AAAA,EACA;AACF,CAAA;AAGO,MAAM,qBAAA,CAA+C;AAAA,EAC1D,aAAa,OACX,QAAA,EACgC;AAChC,IAAA,MAAM,IAAA,GAAO,MAAM,QAAA,CAAS,SAAA,EAAU;AACtC,IAAA,IAAI;AACF,MAAA,MAAM,YAAA,GAAe,MAAMC,8BAAA,CAA0B,IAAI,CAAA;AAEzD,MAAA,IAAI,eAAe,EAAA,EAAI;AAGrB,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,+EAA+E,YAAY,CAAA,CAAA;AAAA,SAC7F;AAAA,MACF;AAAA,IACF,CAAA,CAAA,MAAQ;AAGN,MAAA,MAAM,IAAI,KAAA;AAAA,QACR;AAAA,OACF;AAAA,IACF;AAEA,IAAA,IAAI,CAAC,QAAA,CAAS,UAAA,EAAY,IAAA,EAAM;AAC9B,MAAA,MAAM,IAAA,CAAK,QAAQ,MAAA,CAAO;AAAA,QACxB,SAAA,EAAW;AAAA,OACZ,CAAA;AAAA,IACH;AAEA,IAAA,OAAO,IAAI,sBAAsB,IAAI,CAAA;AAAA,EACvC;AAAA,EAEA,aAAa,UAAU,IAAA,EAA8B;AACnD,IAAA,IAAI;AACF,MAAA,MAAM,YAAA,GAAe,MAAMA,8BAAA,CAA0B,IAAI,CAAA;AAEzD,MAAA,OAAO,YAAA,IAAgB,EAAA;AAAA,IACzB,CAAA,CAAA,MAAQ;AACN,MAAA,OAAO,KAAA;AAAA,IACT;AAAA,EACF;AAAA,EAEiB,EAAA;AAAA,EAEjB,YAAY,EAAA,EAAU;AACpB,IAAA,IAAA,CAAK,EAAA,GAAK,EAAA;AAAA,EACZ;AAAA,EAEA,MAAM,YAAe,EAAA,EAAsD;AACzE,IAAA,OAAO,MAAM,IAAA,CAAK,EAAA,CAAG,WAAA,CAAY,EAAE,CAAA;AAAA,EACrC;AAAA,EAEA,MAAM,cAAA,GAA4C;AAChD,IAAA,OAAO,IAAA,CAAK,GAAG,WAAA,EAAY;AAAA,EAC7B;AAAA,EAEA,MAAM,cAAc,EAAA,EAAqC;AAKvD,IAAA,MAAM,EAAA,CAAG,GAAA;AAAA,MACP;AAAA,KAQF;AAAA,EACF;AAAA,EAEA,MAAM,cAAA,CACJ,EAAA,EACA,IAAA,EACA,WAAW,KAAA,EACI;AACf,IAAA,MAAM,cAAA,GAAiB,WACnB,EAAA,CAAG,GAAA;AAAA,MACD,CAAA,mFAAA;AAAA,KACF,GACA,UAAA;AAGJ,IAAA,MAAM,EAAA,CACH,MAAA;AAAA,MACC,EAAA,CAAmB,qBAAqB,CAAA,CAAE,MAAA;AAAA,QACxC,MAAA;AAAA,QACA,cAAA;AAAA,QACA;AAAA;AACF,KACF,CACC,IAAA,CAAK,EAAA,CAAG,GAAA,CAAI,kCAAkC,CAAC,CAAA,CAC/C,UAAA,CAAW,MAAM,CAAA,CACjB,MAAA,EAAO;AAGV,IAAA,MAAM,YAAA,GAAe,GAAmB,WAAW,CAAA,CAChD,OAAO,gBAAgB,CAAA,CACvB,SAAyB,qBAAA,EAAuB;AAAA,MAC/C,gBAAA,EAAkB;AAAA,KACnB,CAAA,CACA,SAAA,CAAU,0BAA0B,CAAA;AAEvC,IAAA,MAAM,EAAA,CAAmB,WAAW,CAAA,CACjC,KAAA,CAAM,EAAE,IAAA,EAAM,CAAA,CACd,OAAA,CAAQ,MAAA,EAAQ,YAAY,CAAA,CAC5B,MAAA,EAAO;AAAA,EACZ;AAAA,EAEA,MAAM,eAAA,CACJ,EAAA,EACA,IAAA,EACA,SAAA,EACe;AAEf,IAAA,MAAM,EAAA,CAAsB,qBAAqB,CAAA,CAAE,MAAA;AAAA,MACjD,SAAA,CAAU,IAAI,CAAA,QAAA,MAAa;AAAA,QACzB,IAAA;AAAA,QACA,QAAA,EAAU;AAAA,UACR,GAAG;AAAA;AAAA;AAEL,OACF,CAAE;AAAA,KACJ;AAAA,EACF;AAAA,EAEA,MAAM,KAAA,CACJ,EAAA,EACA,WAAA,EAC8B;AAC9B,IAAA,MAAM;AAAA,MACJ,KAAA;AAAA,MACA,MAAA;AAAA,MACA,MAAA;AAAA,MACA,MAAA;AAAA,MACA,KAAA;AAAA,MACA,aAAA,GAAgB,CAAA;AAAA,MAChB;AAAA,KACF,GAAI,WAAA;AASJ,IAAA,MAAM,KAAA,GAAQ,GAAsB,WAAW,CAAA;AAE/C,IAAA,IAAI,MAAA,EAAQ;AACV,MAAA,KAAA,CACG,IAAA,CAAK,GAAG,GAAA,CAAI,2CAAA,EAA6C,MAAM,CAAC,CAAA,CAChE,SAAS,eAAe,CAAA;AAAA,IAC7B,CAAA,MAAO;AACL,MAAA,KAAA,CAAM,KAAK,WAAW,CAAA;AAAA,IACxB;AAEA,IAAA,IAAI,KAAA,EAAO;AACT,MAAA,KAAA,CAAM,OAAA,CAAQ,QAAQ,KAAK,CAAA;AAAA,IAC7B;AAEA,IAAA,IAAI,MAAA,EAAQ;AACV,MAAA,MAAA,CAAO,IAAA,CAAK,MAAM,CAAA,CAAE,OAAA,CAAQ,CAAA,GAAA,KAAO;AACjC,QAAA,MAAM,KAAA,GAAQ,OAAO,GAAG,CAAA;AACxB,QAAA,MAAM,aAAa,KAAA,CAAM,OAAA,CAAQ,KAAK,CAAA,GAAI,KAAA,GAAQ,CAAC,KAAK,CAAA;AACxD,QAAA,MAAM,oBAAoB,UAAA,CACvB,GAAA,CAAI,CAAA,CAAA,MAAM,EAAE,CAAC,GAAG,GAAG,CAAA,EAAE,CAAE,EACvB,GAAA,CAAI,CAAA,CAAA,KAAK,IAAA,CAAK,SAAA,CAAU,CAAC,CAAC,CAAA;AAC7B,QAAA,MAAM,oBAAoB,UAAA,CACvB,GAAA,CAAI,QAAM,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,CAAA,GAAI,CAAA,CACzB,GAAA,CAAI,OAAK,IAAA,CAAK,SAAA,CAAU,CAAC,CAAC,CAAA;AAC7B,QAAA,MAAM,YAAA,GAAe,CAAC,GAAG,iBAAA,EAAmB,GAAG,iBAAiB,CAAA;AAChE,QAAA,KAAA,CAAM,QAAA;AAAA,UACJ,CAAA,CAAA,EAAI,aAAa,GAAA,CAAI,MAAM,eAAe,CAAA,CAAE,IAAA,CAAK,MAAM,CAAC,CAAA,CAAA,CAAA;AAAA,UACxD;AAAA,SACF;AAAA,MACF,CAAC,CAAA;AAAA,IACH;AAEA,IAAA,KAAA,CAAM,MAAA,CAAO,QAAQ,UAAU,CAAA;AAC/B,IAAA,KAAA,CAAM,MAAA,CAAO,EAAA,CAAG,GAAA,CAAI,gCAAgC,CAAC,CAAA;AAErD,IAAA,IAAI,MAAA,IAAU,QAAQ,YAAA,EAAc;AAClC,MAAA,MAAM,eAAA,GAAkB,CAAA,SAAA,EAAY,OAAA,CAAQ,QAAQ,CAAA,WAAA,EAAc,QAAQ,QAAQ,CAAA,YAAA,EAAe,OAAA,CAAQ,SAAS,CAAA,eAAA,EAAkB,OAAA,CAAQ,YAAY,CAAA,eAAA,EAAkB,OAAA,CAAQ,YAAY,CAAA,oBAAA,EAAuB,OAAA,CAAQ,iBAAiB,cAAc,OAAA,CAAQ,MAAM,CAAA,UAAA,EAAa,OAAA,CAAQ,OAAO,CAAA,CAAA;AACtS,MAAA,KAAA,CACG,OAAO,EAAA,CAAG,GAAA,CAAI,2BAA2B,aAAa,CAAA,WAAA,CAAa,CAAC,CAAA,CACpE,MAAA;AAAA,QACC,EAAA,CAAG,GAAA;AAAA,UACD,4CAA8C,eAAe,CAAA,iBAAA;AAAA;AAC/D,OACF,CACC,OAAA,CAAQ,MAAA,EAAQ,MAAM,CAAA;AAAA,IAC3B,CAAA,MAAA,IAAW,MAAA,IAAU,CAAC,OAAA,CAAQ,YAAA,EAAc;AAC1C,MAAA,KAAA,CACG,MAAA,CAAO,EAAA,CAAG,GAAA,CAAI,CAAA,wBAAA,EAA2B,aAAa,aAAa,CAAC,CAAA,CACpE,OAAA,CAAQ,MAAA,EAAQ,MAAM,CAAA;AAAA,IAC3B,CAAA,MAAO;AACL,MAAA,KAAA,CAAM,MAAA,CAAO,EAAA,CAAG,GAAA,CAAI,WAAW,CAAC,CAAA;AAAA,IAClC;AAEA,IAAA,OAAO,MAAM,KAAA,CAAM,MAAA,CAAO,MAAM,CAAA,CAAE,MAAM,KAAK,CAAA;AAAA,EAC/C;AACF;;;;"}

package/dist/index.d.ts CHANGED Viewed

@@ -131,6 +131,10 @@ interface RawDocumentRow {
 }
 /** @public */
 interface DocumentResultRow {
+    /**
+     * Total number of documents matching the query, regardless of pagination.
+     */
+    total_count: string;
     document: IndexableDocument;
     type: string;
     highlight: IndexableDocument;

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-search-backend-module-pg",
-  "version": "0.5.51",
+  "version": "0.5.52-next.1",
   "description": "A module for the search backend that implements search using PostgreSQL",
   "backstage": {
     "role": "backend-plugin-module",
@@ -63,17 +63,17 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "^1.6.0",
-    "@backstage/config": "^1.3.6",
-    "@backstage/plugin-search-backend-node": "^1.4.0",
-    "@backstage/plugin-search-common": "^1.2.21",
+    "@backstage/backend-plugin-api": "1.7.0-next.1",
+    "@backstage/config": "1.3.6",
+    "@backstage/plugin-search-backend-node": "1.4.1-next.0",
+    "@backstage/plugin-search-common": "1.2.22-next.0",
     "knex": "^3.0.0",
     "lodash": "^4.17.21",
     "uuid": "^11.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^1.10.2",
-    "@backstage/cli": "^0.35.0"
+    "@backstage/backend-test-utils": "1.10.5-next.0",
+    "@backstage/cli": "0.35.4-next.1"
   },
   "configSchema": "config.d.ts"
 }