feat (packages/nhost-js): graphql.post -> graphql.request (#41)

dbarrosop · web-flow · commit ea160409d77c · 2025-06-30T14:12:28.000+02:00
diff --git a/demos/ReactNativeDemo/app/profile.tsx b/demos/ReactNativeDemo/app/profile.tsx
@@ -29,7 +29,7 @@ export default function Profile() {
 
       try {
         // Correctly structure GraphQL query with parameters
-        const response = await nhost.graphql.post<MfaStatusResponse>({
+        const response = await nhost.graphql.request<MfaStatusResponse>({
           query: `
               query GetUserMfaStatus($userId: uuid!) {
                 user(id: $userId) {
diff --git a/demos/ReactNativeDemo/app/upload.tsx b/demos/ReactNativeDemo/app/upload.tsx
@@ -47,7 +47,7 @@ export default function Upload() {
 
     try {
       // Fetch files using GraphQL query
-      const response = await nhost.graphql.post<GraphqlGetFilesResponse>({
+      const response = await nhost.graphql.request<GraphqlGetFilesResponse>({
         query: `query GetFiles {
           files {
             id
diff --git a/demos/express/src/index.ts b/demos/express/src/index.ts
@@ -73,7 +73,7 @@ app.post("/cookies", async (req: Request, res: Response) => {
   const nhost = nhostClientFromCookies(req);
 
   try {
-    const response = await nhost.graphql.post<GraphqlGetFilesResponse>({
+    const response = await nhost.graphql.request<GraphqlGetFilesResponse>({
       query: `query GetFiles {
             files {
               id
@@ -99,7 +99,7 @@ app.post("/cookies", async (req: Request, res: Response) => {
 app.post("/auth-header", async (req: Request, res: Response) => {
   const nhost = nhostClientFromAuthHeader(req);
   try {
-    const response = await nhost.graphql.post<GraphqlGetFilesResponse>({
+    const response = await nhost.graphql.request<GraphqlGetFilesResponse>({
       query: `query GetFiles {
               files {
                 id
diff --git a/demos/nextjs-ssr-demo/src/app/components/SecurityKeyClient.tsx b/demos/nextjs-ssr-demo/src/app/components/SecurityKeyClient.tsx
@@ -52,7 +52,7 @@ export default function SecurityKeyClient({
 
     try {
       // Send request to server to delete the security key
-      await nhost.graphql.post({
+      await nhost.graphql.request({
         query: `
           mutation DeleteSecurityKey($keyId: uuid!) {
             deleteAuthUserSecurityKey(id: $keyId) {
diff --git a/demos/nextjs-ssr-demo/src/app/profile/page.tsx b/demos/nextjs-ssr-demo/src/app/profile/page.tsx
@@ -19,7 +19,7 @@ export default async function Profile() {
 
   if (session?.user?.id) {
     try {
-      const response = await nhost.graphql.post<GetUserMfaStatusResponse>({
+      const response = await nhost.graphql.request<GetUserMfaStatusResponse>({
         query: `
           query GetUserMfaStatus($userId: uuid!) {
             user(id: $userId) {
diff --git a/demos/nextjs-ssr-demo/src/app/profile/security-keys.tsx b/demos/nextjs-ssr-demo/src/app/profile/security-keys.tsx
@@ -40,7 +40,7 @@ export default async function SecurityKeys() {
 
     try {
       // Server-side fetch of security keys
-      const response = await nhost.graphql.post<SecurityKeysData>({
+      const response = await nhost.graphql.request<SecurityKeysData>({
         query: `
           query GetUserSecurityKeys($userId: uuid!) {
             user(id: $userId) {
diff --git a/demos/nextjs-ssr-demo/src/app/upload/page.tsx b/demos/nextjs-ssr-demo/src/app/upload/page.tsx
@@ -15,7 +15,7 @@ export default async function UploadPage() {
   let error: string | null = null;
 
   try {
-    const response = await nhost.graphql.post<GetFilesResponse>({
+    const response = await nhost.graphql.request<GetFilesResponse>({
       query: `
         query GetFiles {
           files {
diff --git a/demos/react-demo/src/components/SecurityKeys.tsx b/demos/react-demo/src/components/SecurityKeys.tsx
@@ -55,7 +55,7 @@ export default function SecurityKeys() {
     try {
       // Query the database for all security keys registered to this user
       const response: FetchResponse<SecurityKeysResponse> =
-        await nhost.graphql.post({
+        await nhost.graphql.request({
           query: `
           query GetUserSecurityKeys($userId: uuid!) {
             user(id: $userId) {
@@ -95,7 +95,7 @@ export default function SecurityKeys() {
       // Send request to server to delete the security key
       // This removes the stored public key from the server database
       // so it can no longer be used for authentication
-      const response = await nhost.graphql.post({
+      const response = await nhost.graphql.request({
         query: `
           mutation DeleteSecurityKey($keyId: uuid!) {
             deleteAuthUserSecurityKey(id: $keyId) {
diff --git a/demos/react-demo/src/pages/Profile.tsx b/demos/react-demo/src/pages/Profile.tsx
@@ -27,7 +27,7 @@ export default function Profile(): JSX.Element {
       try {
         // Correctly structure GraphQL query with parameters
         const response: FetchResponse<MfaStatusResponse> =
-          await nhost.graphql.post({
+          await nhost.graphql.request({
             query: `
             query GetUserMfaStatus($userId: uuid!) {
               user(id: $userId) {
diff --git a/demos/react-demo/src/pages/Upload.tsx b/demos/react-demo/src/pages/Upload.tsx
@@ -32,7 +32,7 @@ export default function Upload(): JSX.Element {
 
     try {
       // Fetch files using GraphQL query
-      const response = await nhost.graphql.post<GraphqlGetFilesResponse>({
+      const response = await nhost.graphql.request<GraphqlGetFilesResponse>({
         query: `query GetFiles {
             files {
               id
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 ## main
 
+- 20250627 feat (packages/nhost-js): graphql.post -> graphql.request #41
 - 20250624 feat (packages/nhost-js): add decoded token to session storage #37
 - 20250623 fix (packages/nhost-js): added missing endpoints (storage) and baseURL (functions) #35
 - 20250617 fix (packages/nhost-js): improve some function names, webauthn types and added elevate endpoints #32
diff --git a/docs/reference/javascript/nhost-js/graphql.mdx b/docs/reference/javascript/nhost-js/graphql.mdx
@@ -23,7 +23,7 @@ const nhost = createClient({
 });
 
 try {
-  await nhost.graphql.post({
+  await nhost.graphql.request({
     query: `
       query GetRestrictedObject {
         restrictedObject {
@@ -73,12 +73,12 @@ URL for the GraphQL endpoint.
 
 #### Methods
 
-##### post()
+##### request()
 
 ###### Call Signature
 
 ```ts
-post<TResponseData, TVariables>(request: GraphQLRequest<TVariables>, options?: RequestInit): Promise<FetchResponse<GraphQLResponse<TResponseData>>>;
+request<TResponseData, TVariables>(request: GraphQLRequest<TVariables>, options?: RequestInit): Promise<FetchResponse<GraphQLResponse<TResponseData>>>;
 ```
 
 Execute a GraphQL query operation
@@ -108,7 +108,7 @@ Promise with the GraphQL response and metadata
 ###### Call Signature
 
 ```ts
-post<TResponseData, TVariables>(
+request<TResponseData, TVariables>(
    document: TypedDocumentNode<TResponseData, TVariables>,
    variables?: TVariables,
    options?: RequestInit): Promise<FetchResponse<GraphQLResponse<TResponseData>>>;
diff --git a/docs/reference/javascript/nhost-js/main.mdx b/docs/reference/javascript/nhost-js/main.mdx
@@ -79,7 +79,7 @@ console.log(JSON.stringify(uplFilesResp, null, 2));
 //   }
 // }
 
-const graphResp = await nhost.graphql.post({
+const graphResp = await nhost.graphql.request({
   query: `
    query {
      files {
diff --git a/guides/react-query/README.md b/guides/react-query/README.md
@@ -228,7 +228,7 @@ export const useAuthenticatedFetcher = <TData, TVariables>(
         typeof document === "object" ? document.variables : undefined;
       const mergedVariables = variables || documentVariables;
 
-      const resp = await nhost.graphql.post<TData>({
+      const resp = await nhost.graphql.request<TData>({
         query,
         variables: mergedVariables as Record<string, unknown>,
       });
diff --git a/guides/react-query/src/lib/graphql/queryHooks.ts b/guides/react-query/src/lib/graphql/queryHooks.ts
@@ -15,7 +15,7 @@ export const useAuthenticatedFetcher = <TData, TVariables>(
         typeof document === "object" ? document.variables : undefined;
       const mergedVariables = variables || documentVariables;
 
-      const resp = await nhost.graphql.post<TData>({
+      const resp = await nhost.graphql.request<TData>({
         query,
         variables: mergedVariables as Record<string, unknown>,
       });
diff --git a/packages/nhost-js/CHANGELOG.md b/packages/nhost-js/CHANGELOG.md
@@ -1,6 +1,7 @@
 # dev
 
 - feat (packages/nhost-js): add decoded token to session storage #37
+- feat (packages/nhost-js): graphql.post -> graphql.request #41
 
 # 5.0.0-beta.7
 
diff --git a/packages/nhost-js/README.md b/packages/nhost-js/README.md
@@ -37,7 +37,7 @@ if (response.body.session) {
 }
 
 // Use GraphQL features
-const response = await nhost.graphql.post({
+const response = await nhost.graphql.request({
   query: `
     query GetUsers {
       users {
diff --git a/packages/nhost-js/src/__tests__/docstrings.test.ts b/packages/nhost-js/src/__tests__/docstrings.test.ts
@@ -70,7 +70,7 @@ test("mainExample", async () => {
   //   }
   // }
 
-  const graphResp = await nhost.graphql.post({
+  const graphResp = await nhost.graphql.request({
     query: `
      query {
        files {
diff --git a/packages/nhost-js/src/__tests__/graphql.test.ts b/packages/nhost-js/src/__tests__/graphql.test.ts
@@ -50,7 +50,7 @@ describe("Nhost - Sign Up with Email and Password and upload file", () => {
   });
 
   it("query", async () => {
-    const users = await nhost.graphql.post<GetUsersResponse>({
+    const users = await nhost.graphql.request<GetUsersResponse>({
       query: `query GetUsers {
           users {
             id
@@ -70,7 +70,7 @@ describe("Nhost - Sign Up with Email and Password and upload file", () => {
   });
 
   it("mutate", async () => {
-    const resp = await nhost.graphql.post<UpdateUsersDisplayNameResponse>({
+    const resp = await nhost.graphql.request<UpdateUsersDisplayNameResponse>({
       query: `mutation UpdateUsersDisplayName($id: uuid!, $displayName: String!) {
           updateUser(pk_columns: {id: $id}, _set: {displayName: $displayName}) {
             id
@@ -91,7 +91,7 @@ describe("Nhost - Sign Up with Email and Password and upload file", () => {
 
   it("errors: bad query", async () => {
     try {
-      await nhost.graphql.post({
+      await nhost.graphql.request({
         query: `wrong query`,
       });
 
@@ -111,7 +111,7 @@ describe("Nhost - Sign Up with Email and Password and upload file", () => {
 
   it("errors: no permissions or doesn't exist", async () => {
     try {
-      await nhost.graphql.post({
+      await nhost.graphql.request({
         query: `query { restricted { id } }`,
       });
 
@@ -143,9 +143,12 @@ describe("Nhost - Sign Up with Email and Password and upload file", () => {
       }
     `;
 
-    const users = await nhost.graphql.post<GetUsersResponse>(GetUsersDocument, {
-      limit: 10,
-    });
+    const users = await nhost.graphql.request<GetUsersResponse>(
+      GetUsersDocument,
+      {
+        limit: 10,
+      },
+    );
 
     console.log(users.body.data?.users);
 
@@ -167,7 +170,8 @@ describe("Nhost - Sign Up with Email and Password and upload file", () => {
       }
     `;
 
-    const users = await nhost.graphql.post<GetUsersResponse>(GetUsersDocument);
+    const users =
+      await nhost.graphql.request<GetUsersResponse>(GetUsersDocument);
 
     console.log(users.body.data?.users);
 
@@ -186,7 +190,7 @@ describe("Nhost - Sign Up with Email and Password and upload file", () => {
           }
         }
       `;
-      await nhost.graphql.post(RestrictedQuery);
+      await nhost.graphql.request(RestrictedQuery);
 
       expect(true).toBe(false);
     } catch (error) {
diff --git a/packages/nhost-js/src/graphql/__tests__/docstrings.test.ts b/packages/nhost-js/src/graphql/__tests__/docstrings.test.ts
@@ -23,7 +23,7 @@ test("error handling for graphql", async () => {
   });
 
   try {
-    await nhost.graphql.post({
+    await nhost.graphql.request({
       query: `
         query GetRestrictedObject {
           restrictedObject {
diff --git a/packages/nhost-js/src/graphql/client.ts b/packages/nhost-js/src/graphql/client.ts
@@ -72,7 +72,7 @@ export interface Client {
    * @returns Promise with the GraphQL response and metadata
    */
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  post<TResponseData = any, TVariables = GraphQLVariables>(
+  request<TResponseData = any, TVariables = GraphQLVariables>(
     request: GraphQLRequest<TVariables>,
     options?: RequestInit,
   ): Promise<FetchResponse<GraphQLResponse<TResponseData>>>;
@@ -85,7 +85,7 @@ export interface Client {
    * @param options - Additional fetch options to apply to the request
    * @returns Promise with the GraphQL response and metadata
    */
-  post<TResponseData, TVariables = GraphQLVariables>(
+  request<TResponseData, TVariables = GraphQLVariables>(
     document: TypedDocumentNode<TResponseData, TVariables>,
     variables?: TVariables,
     options?: RequestInit,
@@ -150,16 +150,16 @@ export const createAPIClient = (
   };
 
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  function post<TResponseData = any, TVariables = GraphQLVariables>(
+  function request<TResponseData = any, TVariables = GraphQLVariables>(
     request: GraphQLRequest<TVariables>,
     options?: RequestInit,
   ): Promise<FetchResponse<GraphQLResponse<TResponseData>>>;
-  function post<TResponseData, TVariables = GraphQLVariables>(
+  function request<TResponseData, TVariables = GraphQLVariables>(
     document: TypedDocumentNode<TResponseData, TVariables>,
     variables?: TVariables,
     options?: RequestInit,
   ): Promise<FetchResponse<GraphQLResponse<TResponseData>>>;
-  function post<TResponseData, TVariables = GraphQLVariables>(
+  function request<TResponseData, TVariables = GraphQLVariables>(
     requestOrDocument:
       | GraphQLRequest<TVariables>
       | TypedDocumentNode<TResponseData, TVariables>,
@@ -187,7 +187,7 @@ export const createAPIClient = (
   }
 
   return {
-    post,
+    request,
     url,
   } as Client;
 };
