@backstage/plugin-search-backend-module-pg 0.2.5-next.0 → 0.2.7

package/CHANGELOG.md

@@ -1,5 +1,44 @@
 # @backstage/plugin-search-backend-module-pg
 
+## 0.2.7
+
+### Patch Changes
+
+- c77c5c7eb6: Added `backstage.role` to `package.json`
+- Updated dependencies
+  - @backstage/backend-common@0.10.8
+  - @backstage/search-common@0.2.3
+  - @backstage/plugin-search-backend-node@0.4.6
+
+## 0.2.6
+
+### Patch Changes
+
+- 2441d1cf59: chore(deps): bump `knex` from 0.95.6 to 1.0.2
+
+  This also replaces `sqlite3` with `@vscode/sqlite3` 5.0.7
+
+- Updated dependencies
+  - @backstage/backend-common@0.10.7
+
+## 0.2.6-next.0
+
+### Patch Changes
+
+- 2441d1cf59: chore(deps): bump `knex` from 0.95.6 to 1.0.2
+
+  This also replaces `sqlite3` with `@vscode/sqlite3` 5.0.7
+
+- Updated dependencies
+  - @backstage/backend-common@0.10.7-next.0
+
+## 0.2.5
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-common@0.10.6
+
 ## 0.2.5-next.0
 
 ### Patch Changes

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-search-backend-module-pg",
   "description": "A module for the search backend that implements search using PostgreSQL",
-  "version": "0.2.5-next.0",
+  "version": "0.2.7",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -10,29 +10,32 @@
     "main": "dist/index.cjs.js",
     "types": "dist/index.d.ts"
   },
+  "backstage": {
+    "role": "backend-plugin-module"
+  },
   "scripts": {
-    "start": "backstage-cli backend:dev",
-    "build": "backstage-cli backend:build",
-    "lint": "backstage-cli lint",
-    "test": "backstage-cli test",
-    "prepack": "backstage-cli prepack",
-    "postpack": "backstage-cli postpack",
-    "clean": "backstage-cli clean"
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack",
+    "clean": "backstage-cli package clean"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.10.6-next.0",
-    "@backstage/plugin-search-backend-node": "^0.4.5",
-    "@backstage/search-common": "^0.2.2",
-    "knex": "^0.95.1",
+    "@backstage/backend-common": "^0.10.8",
+    "@backstage/plugin-search-backend-node": "^0.4.6",
+    "@backstage/search-common": "^0.2.3",
+    "knex": "^1.0.2",
     "lodash": "^4.17.21"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^0.1.16-next.1",
-    "@backstage/cli": "^0.13.1-next.1"
+    "@backstage/backend-test-utils": "^0.1.18",
+    "@backstage/cli": "^0.14.0"
   },
   "files": [
     "dist",
     "migrations"
   ],
-  "gitHead": "d6da97a1edeb21fcefc682d91916987ba9f3d89a"
+  "gitHead": "4805c3d13ce9bfc369e53c271b1b95e722b3b4dc"
 }

package/dist/index.d.ts

@@ -1,59 +0,0 @@
-import { IndexableDocument, SearchQuery, SearchResultSet } from '@backstage/search-common';
-import { Knex } from 'knex';
-import { PluginDatabaseManager } from '@backstage/backend-common';
-import { SearchEngine } from '@backstage/plugin-search-backend-node';
-
-interface PgSearchQuery {
-    fields?: Record<string, string | string[]>;
-    types?: string[];
-    pgTerm?: string;
-    offset: number;
-    limit: number;
-}
-interface DatabaseStore {
-    transaction<T>(fn: (tx: Knex.Transaction) => Promise<T>): Promise<T>;
-    prepareInsert(tx: Knex.Transaction): Promise<void>;
-    insertDocuments(tx: Knex.Transaction, type: string, documents: IndexableDocument[]): Promise<void>;
-    completeInsert(tx: Knex.Transaction, type: string): Promise<void>;
-    query(tx: Knex.Transaction, pgQuery: PgSearchQuery): Promise<DocumentResultRow[]>;
-}
-interface RawDocumentRow {
-    document: IndexableDocument;
-    type: string;
-    hash: unknown;
-}
-interface DocumentResultRow {
-    document: IndexableDocument;
-    type: string;
-}
-
-declare class DatabaseDocumentStore implements DatabaseStore {
-    private readonly db;
-    static create(knex: Knex): Promise<DatabaseDocumentStore>;
-    static supported(knex: Knex): Promise<boolean>;
-    constructor(db: Knex);
-    transaction<T>(fn: (tx: Knex.Transaction) => Promise<T>): Promise<T>;
-    prepareInsert(tx: Knex.Transaction): Promise<void>;
-    completeInsert(tx: Knex.Transaction, type: string): Promise<void>;
-    insertDocuments(tx: Knex.Transaction, type: string, documents: IndexableDocument[]): Promise<void>;
-    query(tx: Knex.Transaction, { types, pgTerm, fields, offset, limit }: PgSearchQuery): Promise<DocumentResultRow[]>;
-}
-
-declare type ConcretePgSearchQuery = {
-    pgQuery: PgSearchQuery;
-    pageSize: number;
-};
-declare class PgSearchEngine implements SearchEngine {
-    private readonly databaseStore;
-    constructor(databaseStore: DatabaseStore);
-    static from(options: {
-        database: PluginDatabaseManager;
-    }): Promise<PgSearchEngine>;
-    static supported(database: PluginDatabaseManager): Promise<boolean>;
-    translator(query: SearchQuery): ConcretePgSearchQuery;
-    setTranslator(translator: (query: SearchQuery) => ConcretePgSearchQuery): void;
-    index(type: string, documents: IndexableDocument[]): Promise<void>;
-    query(query: SearchQuery): Promise<SearchResultSet>;
-}
-
-export { ConcretePgSearchQuery, DatabaseDocumentStore, DatabaseStore, PgSearchEngine, PgSearchQuery, RawDocumentRow };