Version Packages (#801)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
sajari · May 24, 2022 · 9c10497 · 9c10497
1 parent 0e0e471
commit 9c10497
Show file tree

Hide file tree

Showing 7 changed files with 123 additions and 43 deletions.
diff --git a/.changeset/nasty-turtles-provide.md b/.changeset/nasty-turtles-provide.md
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -1,5 +1,43 @@
 # Change Log
 
+## 1.16.0
+
+### Minor Changes
+
+- [`0e0e4712`](https://github.com/sajari/sdk-react/commit/0e0e4712c0d5097476eb71fd562f077783d1b36e) [#794](https://github.com/sajari/sdk-react/pull/794) Thanks [@zlatanpham](https://github.com/zlatanpham)! - **Motivation**: It’s super useful to have the search UI state synchronizing with the browser URL and we had the functionality internally developed in the search widgets. However, when users build the search UI with React SDK (or JS SDK), they have to develop the feature by themselves and the work could be challenging even for an experienced developer. Thus, the goal of the change is to have the sync URLs functionality as a generic solution in the React SDK so it can be easily used by both our internal development (search-widgets, demo,…) and the outside world.
+
+  ### API proposal
+
+  The `URLStateSync` should be placed inside the `SearchProvider`. It will work out of box with any UI that consumes data from our hook components.
+
+  ```jsx
+  <SearchProvider {...}>
+    <URLStateSync />
+    <YourSearchUI />
+  </SearchProvider>
+  ```
+
+  By default, it supports state sync for the core params including `q`, `filters`, `sort` and `resultsPerPage` but we can extend other options via `extendedParams` prop:
+
+  ```jsx
+  const defaultViewType = 'list';
+  const [viewType, setViewType] = useState(defaultViewType);
+
+  <SearchProvider {...}>
+    <URLStateSync />
+    <YourSearchUI
+       extendedParams={[
+          {
+            key: 'viewType',
+            value: viewType,
+            defaultValue: defaultViewType,
+            callback: setViewType,
+          },
+        ]}
+     />
+  </SearchProvider>
+  ```
+
 ## 1.15.2
 
 ### Patch Changes

diff --git a/docs/package.json b/docs/package.json
@@ -1,6 +1,6 @@
 {
   "name": "sajari-sdk-docs",
-  "version": "1.15.2",
+  "version": "1.16.0",
   "private": true,
   "scripts": {
     "dev": "next dev",

diff --git a/packages/hooks/CHANGELOG.md b/packages/hooks/CHANGELOG.md
@@ -1,5 +1,43 @@
 # Change Log
 
+## 3.13.0
+
+### Minor Changes
+
+- [`0e0e4712`](https://github.com/sajari/sdk-react/commit/0e0e4712c0d5097476eb71fd562f077783d1b36e) [#794](https://github.com/sajari/sdk-react/pull/794) Thanks [@zlatanpham](https://github.com/zlatanpham)! - **Motivation**: It’s super useful to have the search UI state synchronizing with the browser URL and we had the functionality internally developed in the search widgets. However, when users build the search UI with React SDK (or JS SDK), they have to develop the feature by themselves and the work could be challenging even for an experienced developer. Thus, the goal of the change is to have the sync URLs functionality as a generic solution in the React SDK so it can be easily used by both our internal development (search-widgets, demo,…) and the outside world.
+
+  ### API proposal
+
+  The `URLStateSync` should be placed inside the `SearchProvider`. It will work out of box with any UI that consumes data from our hook components.
+
+  ```jsx
+  <SearchProvider {...}>
+    <URLStateSync />
+    <YourSearchUI />
+  </SearchProvider>
+  ```
+
+  By default, it supports state sync for the core params including `q`, `filters`, `sort` and `resultsPerPage` but we can extend other options via `extendedParams` prop:
+
+  ```jsx
+  const defaultViewType = 'list';
+  const [viewType, setViewType] = useState(defaultViewType);
+
+  <SearchProvider {...}>
+    <URLStateSync />
+    <YourSearchUI
+       extendedParams={[
+          {
+            key: 'viewType',
+            value: viewType,
+            defaultValue: defaultViewType,
+            callback: setViewType,
+          },
+        ]}
+     />
+  </SearchProvider>
+  ```
+
 ## 3.12.0
 
 ### Minor Changes

diff --git a/packages/hooks/package.json b/packages/hooks/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@sajari/react-hooks",
-  "version": "3.12.0",
+  "version": "3.13.0",
   "description": "Easy to use hooks that allow you to build a powerful search interface powered by Sajari using any component library.",
   "sideEffects": false,
   "scripts": {

diff --git a/packages/search-ui/CHANGELOG.md b/packages/search-ui/CHANGELOG.md
@@ -1,5 +1,48 @@
 # Change Log
 
+## 4.16.0
+
+### Minor Changes
+
+- [`0e0e4712`](https://github.com/sajari/sdk-react/commit/0e0e4712c0d5097476eb71fd562f077783d1b36e) [#794](https://github.com/sajari/sdk-react/pull/794) Thanks [@zlatanpham](https://github.com/zlatanpham)! - **Motivation**: It’s super useful to have the search UI state synchronizing with the browser URL and we had the functionality internally developed in the search widgets. However, when users build the search UI with React SDK (or JS SDK), they have to develop the feature by themselves and the work could be challenging even for an experienced developer. Thus, the goal of the change is to have the sync URLs functionality as a generic solution in the React SDK so it can be easily used by both our internal development (search-widgets, demo,…) and the outside world.
+
+  ### API proposal
+
+  The `URLStateSync` should be placed inside the `SearchProvider`. It will work out of box with any UI that consumes data from our hook components.
+
+  ```jsx
+  <SearchProvider {...}>
+    <URLStateSync />
+    <YourSearchUI />
+  </SearchProvider>
+  ```
+
+  By default, it supports state sync for the core params including `q`, `filters`, `sort` and `resultsPerPage` but we can extend other options via `extendedParams` prop:
+
+  ```jsx
+  const defaultViewType = 'list';
+  const [viewType, setViewType] = useState(defaultViewType);
+
+  <SearchProvider {...}>
+    <URLStateSync />
+    <YourSearchUI
+       extendedParams={[
+          {
+            key: 'viewType',
+            value: viewType,
+            defaultValue: defaultViewType,
+            callback: setViewType,
+          },
+        ]}
+     />
+  </SearchProvider>
+  ```
+
+### Patch Changes
+
+- Updated dependencies [[`0e0e4712`](https://github.com/sajari/sdk-react/commit/0e0e4712c0d5097476eb71fd562f077783d1b36e)]:
+  - @sajari/react-hooks@3.13.0
+
 ## 4.15.0
 
 ### Minor Changes

diff --git a/packages/search-ui/package.json b/packages/search-ui/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@sajari/react-search-ui",
-  "version": "4.15.0",
+  "version": "4.16.0",
   "description": "Easy to use search components to quickly build a beautiful search interface powered by Sajari.",
   "sideEffects": false,
   "repository": {
@@ -28,7 +28,7 @@
   "dependencies": {
     "@react-aria/utils": "3.5.0",
     "@sajari/react-components": "^1.14.4",
-    "@sajari/react-hooks": "^3.12.0",
+    "@sajari/react-hooks": "^3.13.0",
     "@sajari/react-sdk-utils": "^1.6.4",
     "dayjs": "^1.10.5",
     "i18next": "19.8.7",