Migrate react-ditto to Ditto v5

.github/workflows/ci.yml

@@ -16,18 +16,24 @@ jobs:
       - name: 'Setup Chrome'
         uses: browser-actions/setup-chrome@latest
 
-      - name: 'Install and Build'
+      - name: 'Install, lint and build library'
         run: |
           npm ci
-          cd examples/vite-typescript-example
-          npm ci
-          cd -
           npm run types
           npm run lint
           npm run build
 
-      - name: 'Run Tests'
-        run: CHROMIUM_BIN=$(which chrome) npm test
+      - name: 'Run library tests'
+        run: CHROME_BIN=$(which chrome) npm test
+
+      - name: 'Build and test example app'
+        working-directory: examples/vite-typescript-example
+        run: |
+          npm ci
+          npm run type-check
+          npm run lint
+          npm run build
+          npm test
 
       - name: 'Generate Documentation Website'
         run: npm run docs:generate

CHANGELOG.md

@@ -2,6 +2,34 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [1.0.0](https://github.com/getditto/react-ditto/compare/v0.11.2...v1.0.0)
+
+### ⚠ BREAKING CHANGES
+
+* Upgrade the `@dittolive/ditto` peer dependency to `^5.0.0`. This library now
+  targets the Ditto v5 SDK and uses DQL exclusively.
+* Remove the query-builder hooks (`usePendingCursorOperation`,
+  `useLazyPendingCursorOperation`, `usePendingIDSpecificOperation`,
+  `useLazyPendingIDSpecificOperation`, `useCollections`) and `useMutations`. The
+  underlying query-builder API was removed in Ditto v5; use the `useQuery` and
+  `useExecuteQuery` DQL hooks instead.
+* Remove the identity hooks (`useOfflinePlaygroundIdentity`, `useOnlineIdentity`,
+  `useOnlinePlaygroundIdentity`). Ditto v5 removed the `Identity` types;
+  configure connectivity through `DittoConfig` and authenticate via `ditto.auth`.
+
+### Features
+
+* Add the `useQuery` hook for continuously observing a non-mutating DQL query
+  (store observer + sync subscription).
+* Add the `useExecuteQuery` hook for running mutating and on-demand DQL queries.
+
+### Notes
+
+* The `DittoProvider` `setup` function should now return instances created with
+  `Ditto.open(new DittoConfig(...))`. Instances are registered by their
+  configured persistence directory (falling back to the resolved absolute
+  directory).
+
 ### [0.11.2](https://github.com/getditto/react-ditto/compare/v0.11.1...v0.11.2) (2024-12-02)
 
 ### [0.11.1](https://github.com/getditto/react-ditto/compare/v0.11.0...v0.11.1) (2024-05-22)