@backstage/plugin-search-common 0.3.1 → 0.3.3-next.1

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @backstage/plugin-search-common
 
+## 0.3.3-next.1
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-permission-common@0.6.0-next.0
+
+## 0.3.3-next.0
+
+### Patch Changes
+
+- c8b295f2fb: - Introduce `SearchDocument` type. This type contains the subset of `IndexableDocument` properties relevant to the frontend, and is intended to be used for documents returned to the frontend from the search API.
+  - `SearchResultSet` is now a wrapper for documents of type `SearchDocument`, and is intended to be used in the frontend. This isn't a breaking change, since `IndexableDocument`s are valid `SearchDocument`s, so the old and new types are compatible.
+  - Introduce `IndexableResultSet` type, which wraps `IndexableDocument` instances in the same way as `SearchResultSet`.
+
+## 0.3.2
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/types@1.0.0
+  - @backstage/plugin-permission-common@0.5.3
+
 ## 0.3.1
 
 ### Patch Changes

package/dist/index.d.ts

@@ -15,24 +15,39 @@ interface SearchQuery {
 /**
  * @beta
  */
-interface SearchResult {
+interface Result<TDocument extends SearchDocument> {
     type: string;
-    document: IndexableDocument;
+    document: TDocument;
 }
 /**
  * @beta
  */
-interface SearchResultSet {
-    results: SearchResult[];
+interface ResultSet<TDocument extends SearchDocument> {
+    results: Result<TDocument>[];
     nextPageCursor?: string;
     previousPageCursor?: string;
 }
 /**
- * Base properties that all indexed documents must include, as well as some
- * common properties that documents are encouraged to use where appropriate.
  * @beta
  */
-interface IndexableDocument {
+declare type SearchResult = Result<SearchDocument>;
+/**
+ * @beta
+ */
+declare type SearchResultSet = ResultSet<SearchDocument>;
+/**
+ * @beta
+ */
+declare type IndexableResult = Result<IndexableDocument>;
+/**
+ * @beta
+ */
+declare type IndexableResultSet = ResultSet<IndexableDocument>;
+/**
+ * Base properties that all search documents must include.
+ * @beta
+ */
+interface SearchDocument {
     /**
      * The primary name of the document (e.g. name, title, identifier, etc).
      */
@@ -46,6 +61,15 @@ interface IndexableDocument {
      * is clicked).
      */
     location: string;
+}
+/**
+ * Properties related to indexing of documents. This type is only useful for
+ * backends working directly with documents being inserted or retrieved from
+ * search indexes. When dealing with documents in the frontend, use
+ * {@link SearchDocument}.
+ * @beta
+ */
+declare type IndexableDocument = SearchDocument & {
     /**
      * Optional authorization information to be used when determining whether this
      * search result should be visible to a given user.
@@ -56,7 +80,7 @@ interface IndexableDocument {
          */
         resourceRef: string;
     };
-}
+};
 /**
  * Information about a specific document type. Intended to be used in the
  * {@link @backstage/search-backend-node#IndexBuilder} to collect information
@@ -143,7 +167,7 @@ interface SearchEngine {
     /**
      * Perform a search query against the SearchEngine.
      */
-    query(query: SearchQuery, options?: QueryRequestOptions): Promise<SearchResultSet>;
+    query(query: SearchQuery, options?: QueryRequestOptions): Promise<IndexableResultSet>;
 }
 
-export { DocumentCollatorFactory, DocumentDecoratorFactory, DocumentTypeInfo, IndexableDocument, QueryRequestOptions, QueryTranslator, SearchEngine, SearchQuery, SearchResult, SearchResultSet };
+export { DocumentCollatorFactory, DocumentDecoratorFactory, DocumentTypeInfo, IndexableDocument, IndexableResult, IndexableResultSet, QueryRequestOptions, QueryTranslator, Result, ResultSet, SearchDocument, SearchEngine, SearchQuery, SearchResult, SearchResultSet };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-search-common",
   "description": "Common functionalities for Search, to be shared between various search-enabled plugins",
-  "version": "0.3.1",
+  "version": "0.3.3-next.1",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "private": false,
@@ -39,16 +39,16 @@
     "url": "https://github.com/backstage/backstage/issues"
   },
   "dependencies": {
-    "@backstage/plugin-permission-common": "^0.5.2",
-    "@backstage/types": "^0.1.3"
+    "@backstage/plugin-permission-common": "^0.6.0-next.0",
+    "@backstage/types": "^1.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.15.2"
+    "@backstage/cli": "^0.17.0-next.1"
   },
   "jest": {
     "roots": [
       ".."
     ]
   },
-  "gitHead": "60c4e39d1fcaeb10d6488ada1d907f34dc2a105a"
+  "gitHead": "57d12dcc35aeb6c33b09e51d1efc3408c574f109"
 }