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

package/CHANGELOG.md

@@ -1,38 +1,50 @@
 # @backstage/plugin-search
 
-## 1.3.6
+## 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.3
-  - @backstage/catalog-model@1.4.1
-  - @backstage/config@1.0.8
-  - @backstage/core-components@0.13.4
-  - @backstage/core-plugin-api@1.5.3
+  - @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.5
-  - @backstage/plugin-search-react@1.6.4
+  - @backstage/plugin-search-common@1.2.6-next.0
 
-## 1.3.5
+## 1.3.6-next.0
 
 ### Patch Changes
 
 - Updated dependencies
-  - @backstage/plugin-catalog-react@1.8.2
+  - @backstage/core-plugin-api@1.6.0-next.0
+  - @backstage/core-components@0.13.5-next.0
   - @backstage/catalog-model@1.4.1
   - @backstage/config@1.0.8
-  - @backstage/core-components@0.13.4
-  - @backstage/core-plugin-api@1.5.3
   - @backstage/errors@1.2.1
   - @backstage/theme@0.4.1
   - @backstage/types@1.1.0
   - @backstage/version-bridge@1.0.4
+  - @backstage/plugin-catalog-react@1.8.3-next.0
   - @backstage/plugin-search-common@1.2.5
-  - @backstage/plugin-search-react@1.6.4
+  - @backstage/plugin-search-react@1.6.5-next.0
 
 ## 1.3.4
 

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/dist/index.d.ts

@@ -1,7 +1,8 @@
 /// <reference types="react" />
 import * as _backstage_plugin_search_react from '@backstage/plugin-search-react';
 import { SearchBarBaseProps } from '@backstage/plugin-search-react';
-import { ReactNode } from 'react';
+import * as React from 'react';
+import React__default, { ReactNode } from 'react';
 import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
 import { IconComponent } from '@backstage/core-plugin-api';
 
@@ -50,7 +51,7 @@ interface SearchModalProps {
 /**
  * @public
  */
-declare const SearchModal: (props: SearchModalProps) => JSX.Element;
+declare const SearchModal: (props: SearchModalProps) => React__default.JSX.Element;
 
 /**
  * The state of the search modal, as well as functions for changing the modal's
@@ -109,7 +110,7 @@ type SearchModalProviderProps = {
  *
  * @public
  */
-declare const SearchModalProvider: (props: SearchModalProviderProps) => JSX.Element;
+declare const SearchModalProvider: (props: SearchModalProviderProps) => React__default.JSX.Element;
 /**
  * Use this hook to manage the state of {@link SearchModal}
  * and change its visibility. Monitors route changes setting the hidden state
@@ -126,7 +127,7 @@ declare function useSearchModal(initialState?: boolean): SearchModalValue;
 /**
  * @public
  */
-declare const SearchPage$1: () => JSX.Element;
+declare const SearchPage$1: () => React__default.JSX.Element;
 
 /**
  * @public
@@ -168,19 +169,19 @@ type SearchTypeProps = {
  * @public
  */
 declare const SearchType: {
-    (props: SearchTypeProps): JSX.Element;
+    (props: SearchTypeProps): React__default.JSX.Element;
     /**
      * A control surface for the search query's "types" property, displayed as a
      * single-select collapsible accordion suitable for use in faceted search UIs.
      * @public
      */
-    Accordion(props: SearchTypeAccordionProps): JSX.Element;
+    Accordion(props: SearchTypeAccordionProps): React__default.JSX.Element;
     /**
      * A control surface for the search query's "types" property, displayed as a
      * tabs suitable for use in faceted search UIs.
      * @public
      */
-    Tabs(props: SearchTypeTabsProps): JSX.Element;
+    Tabs(props: SearchTypeTabsProps): React__default.JSX.Element;
 };
 
 /**
@@ -194,7 +195,7 @@ type SidebarSearchProps = {
 /**
  * @public
  */
-declare const SidebarSearch: (props: SidebarSearchProps) => JSX.Element;
+declare const SidebarSearch: (props: SidebarSearchProps) => React__default.JSX.Element;
 
 /**
  * Props for {@link SidebarSearchModal}.
@@ -215,14 +216,14 @@ declare const searchPlugin: _backstage_core_plugin_api.BackstagePlugin<{
 /**
  * @public
  */
-declare const SearchPage: () => JSX.Element;
+declare const SearchPage: () => React.JSX.Element;
 /**
  * @public
  */
-declare const SidebarSearchModal: (props: SidebarSearchModalProps) => JSX.Element;
+declare const SidebarSearchModal: (props: SidebarSearchModalProps) => React.JSX.Element;
 /**
  * @public
  */
-declare const HomePageSearchBar: (props: Partial<Omit<_backstage_plugin_search_react.SearchBarBaseProps, "onChange" | "onSubmit">>) => JSX.Element;
+declare const HomePageSearchBar: (props: Partial<Omit<_backstage_plugin_search_react.SearchBarBaseProps, "onChange" | "onSubmit">>) => React.JSX.Element;
 
 export { HomePageSearchBar, HomePageSearchBarProps, SearchPage$1 as Router, SearchModal, SearchModalChildrenProps, SearchModalProps, SearchModalProvider, SearchModalProviderProps, SearchModalValue, SearchPage, SearchType, SearchTypeAccordionProps, SearchTypeProps, SearchTypeTabsProps, SidebarSearch, SidebarSearchModal, SidebarSearchModalProps, SidebarSearchProps, searchPlugin as plugin, searchPlugin, useSearchModal };

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",
+  "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.4",
-    "@backstage/core-plugin-api": "^1.5.3",
+    "@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",
-    "@backstage/plugin-search-common": "^1.2.5",
-    "@backstage/plugin-search-react": "^1.6.4",
+    "@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",
-    "@backstage/core-app-api": "^1.9.1",
-    "@backstage/dev-utils": "^1.0.20",
-    "@backstage/test-utils": "^1.4.2",
+    "@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"
 }