@backstage/plugin-search 1.3.6-next.0 → 1.4.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # @backstage/plugin-search
 
+## 1.4.0-next.1
+
+### Minor Changes
+
+- b78f570f44d3: The SearchPage component can now be configured via app-config.yaml with default query parameters to define how it behaves when it is first loaded or reset. Check out the following example:
+
+  ```yaml
+  search:
+    query:
+      pageLimit: 50
+  ```
+
+  Acceptable values for `pageLimit` are `10`, `25`, `50` or `100`.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-catalog-react@1.8.4-next.1
+  - @backstage/core-components@0.13.5-next.1
+  - @backstage/config@1.1.0-next.0
+  - @backstage/plugin-search-react@1.7.0-next.1
+  - @backstage/catalog-model@1.4.2-next.0
+  - @backstage/core-plugin-api@1.6.0-next.1
+  - @backstage/errors@1.2.1
+  - @backstage/theme@0.4.1
+  - @backstage/types@1.1.0
+  - @backstage/version-bridge@1.0.4
+  - @backstage/plugin-search-common@1.2.6-next.0
+
 ## 1.3.6-next.0
 
 ### Patch Changes

package/README.md

@@ -8,6 +8,22 @@ Development is ongoing. You can follow the progress and contribute at the Backst
 
 Run `yarn dev` in the root directory, and then navigate to [/search](http://localhost:3000/search) to check out the plugin.
 
+### Optional Settings
+
+Configure the search query values via `app-config.yaml` to define how it behaves by default.
+
+```yaml
+# app-config.yaml
+search:
+  query:
+    pageLimit: 50
+```
+
+Acceptable values for `pageLimit` are `10`, `25`, `50` or `100`.
+
+**NOTE**: Currently this configuration only reflects the initial state of the Search React components. This means that
+it defines how it behaves when it is first loaded or reset.
+
 ### Areas of Responsibility
 
 This search plugin is primarily responsible for the following:

package/config.d.ts

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export interface Config {
+  /** Configuration options for the search plugin */
+  search?: {
+    /**
+     * An object representing the default search query configuration.
+     * By configuring and modifying the values of this object,
+     * you can customize the default values of the search queries
+     * and define how it behaves by default.
+     */
+    query?: {
+      /**
+       * A number indicating the maximum number of results to be returned
+       * per page during pagination.
+       * @visibility frontend
+       */
+      pageLimit?: 10 | 25 | 50 | 100;
+    };
+  };
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-search",
   "description": "The Backstage plugin that provides your backstage app with search",
-  "version": "1.3.6-next.0",
+  "version": "1.4.0-next.1",
   "main": "dist/index.esm.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -32,14 +32,14 @@
     "clean": "backstage-cli package clean"
   },
   "dependencies": {
-    "@backstage/catalog-model": "^1.4.1",
-    "@backstage/config": "^1.0.8",
-    "@backstage/core-components": "^0.13.5-next.0",
-    "@backstage/core-plugin-api": "^1.6.0-next.0",
+    "@backstage/catalog-model": "^1.4.2-next.0",
+    "@backstage/config": "^1.1.0-next.0",
+    "@backstage/core-components": "^0.13.5-next.1",
+    "@backstage/core-plugin-api": "^1.6.0-next.1",
     "@backstage/errors": "^1.2.1",
-    "@backstage/plugin-catalog-react": "^1.8.3-next.0",
-    "@backstage/plugin-search-common": "^1.2.5",
-    "@backstage/plugin-search-react": "^1.6.5-next.0",
+    "@backstage/plugin-catalog-react": "^1.8.4-next.1",
+    "@backstage/plugin-search-common": "^1.2.6-next.0",
+    "@backstage/plugin-search-react": "^1.7.0-next.1",
     "@backstage/theme": "^0.4.1",
     "@backstage/types": "^1.1.0",
     "@backstage/version-bridge": "^1.0.4",
@@ -56,10 +56,10 @@
     "react-router-dom": "6.0.0-beta.0 || ^6.3.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.22.12-next.0",
-    "@backstage/core-app-api": "^1.10.0-next.0",
-    "@backstage/dev-utils": "^1.0.20-next.0",
-    "@backstage/test-utils": "^1.4.3-next.0",
+    "@backstage/cli": "^0.22.13-next.1",
+    "@backstage/core-app-api": "^1.10.0-next.1",
+    "@backstage/dev-utils": "^1.0.21-next.1",
+    "@backstage/test-utils": "^1.4.3-next.1",
     "@testing-library/dom": "^8.0.0",
     "@testing-library/jest-dom": "^5.10.1",
     "@testing-library/react": "^12.1.3",
@@ -70,7 +70,9 @@
     "msw": "^1.0.0"
   },
   "files": [
-    "dist"
+    "dist",
+    "config.d.ts"
   ],
+  "configSchema": "config.d.ts",
   "module": "./dist/index.esm.js"
 }