@openapi-qraft/react 1.0.0-beta.6 → 1.0.1

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @openapi-qraft/react
 
+## 1.0.1
+
+### Major Changes
+
+- c545cb2: chore: First release of the `@openapi-qraft/*` packages.
+
+### Patch Changes
+
+- 269e464: feature: Add support for `useSuspenseQuery(..)` hook
+- 8f0359d: Add a 'use client' header for compatibility with Next.js /app
+- 0640daf: feature: Add support for `useMutationState(..)` hook
+- ddb4d87: docs: Update README
+- cc93fc3: feature: Add support for `useSuspenseInfiniteQuery(..)` hook
+- 2509822: refactor: `getMutationKey` type, and change key composition logic if parameters are `undefined`
+- fb6b450: chore: Bump
+
 ## 1.0.0-beta.6
 
 ### Patch Changes

package/README.md

@@ -21,7 +21,7 @@ hooks with typed parameters, ensuring that your API requests are both type-safe
 First, install the core package for your project:
 
 ```bash
-npm install @openapi-qraft/react@beta
+npm install @openapi-qraft/react
 ```
 
 If your project doesn't already include `@tanstack/react-query`, you'll also need to install it. This package is
@@ -60,7 +60,7 @@ Next, use `@openapi-qraft/cli` to generate the services and typed Tanstack Query
 to the TypeScript definitions generated in the previous step.
 
 ```bash
-npx @openapi-qraft/cli@beta https://api.dev.monite.com/openapi.json?version=2023-09-01 --output-dir src/api --openapi-types-import-path '../openapi.d.ts'
+npx @openapi-qraft/cli https://api.dev.monite.com/openapi.json?version=2023-09-01 --output-dir src/api --openapi-types-import-path '../openapi.d.ts'
 ```
 
 By completing these steps, you will generate `openapi.d.ts`, which serves as a TypeScript representation of the
@@ -265,7 +265,7 @@ const mutationState = qraft.entities.postEntitiesIdDocuments
   ?.at(0);
 
 useEffect(() => {
-  if (mutationState?.status === 'iddle') {
+  if (!mutationState || mutationState.status === 'iddle') {
     mutate({ company_tax_id_verification: ['verification-id'] });
   }
 }, [mutate, mutationState?.status]);
@@ -285,6 +285,7 @@ useEffect(() => {
 const infiniteQuery = qraft.posts.getPosts.useInfiniteQuery(
   { query: { limit: 10 } },
   {
+    // * required by Tanstack Query
     getNextPageParam: (lastPage, allPages, lastPageParams) => {
       if (lastPage.length < 10) return; // if less than 10 items, there are no more pages
       return {
@@ -293,6 +294,7 @@ const infiniteQuery = qraft.posts.getPosts.useInfiniteQuery(
         },
       };
     },
+    // * required by Tanstack Query
     initialPageParam: {
       query: {
         page: 1, // will be used in initial request

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openapi-qraft/react",
-  "version": "1.0.0-beta.6",
+  "version": "1.0.1",
   "description": "API client for React, providing type-safe requests and dynamic Tanstack Query React Hooks via a modular, Proxy-based architecture.",
   "scripts": {
     "build": "rimraf dist/ && tsc --project tsconfig.build.json",
@@ -13,8 +13,8 @@
   "type": "module",
   "sideEffects": false,
   "devDependencies": {
-    "@openapi-qraft/cli": "~1.0.0-beta.4",
-    "@openapi-qraft/openapi-typescript": "^1.0.0-beta.1",
+    "@openapi-qraft/cli": "~1.0.1",
+    "@openapi-qraft/openapi-typescript": "^1.0.0",
     "@tanstack/react-query": "^5.17.3",
     "@testing-library/jest-dom": "^5.17.0",
     "@testing-library/react": "^13.4.0",