@nhost/nhost-js 3.3.1 → 4.0.0

package/dist/src/fetch/middlewareUpdateSessionFromResponse.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Session response middleware for the Nhost SDK.
+ *
+ * This module provides middleware functionality to automatically extract
+ * and persist session information from authentication responses, ensuring
+ * that new sessions are properly stored after sign-in operations.
+ */
+import type { SessionStorage } from "../session/storage";
+import type { ChainFunction } from "./fetch";
+/**
+ * Creates a fetch middleware that automatically extracts and stores session data from API responses.
+ *
+ * This middleware:
+ * 1. Monitors responses from authentication-related endpoints
+ * 2. Extracts session information when present
+ * 3. Stores the session in the provided storage implementation
+ * 4. Handles session removal on sign-out
+ *
+ * This ensures that session data is always up-to-date in storage after operations
+ * that create or invalidate sessions.
+ *
+ * @param storage - Storage implementation for persisting session data
+ * @returns A middleware function that can be used in the fetch chain
+ */
+export declare const updateSessionFromResponseMiddleware: (storage: SessionStorage) => ChainFunction;
+//# sourceMappingURL=middlewareUpdateSessionFromResponse.d.ts.map

package/dist/src/fetch/middlewareUpdateSessionFromResponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"middlewareUpdateSessionFromResponse.d.ts","sourceRoot":"","sources":["../../../src/fetch/middlewareUpdateSessionFromResponse.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7C;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,mCAAmC,GAC9C,SAAS,cAAc,KACtB,aAuEF,CAAC"}

package/dist/src/fetch/middlewareUpdateSessionFromResponse.js

@@ -0,0 +1,79 @@
+/**
+ * Session response middleware for the Nhost SDK.
+ *
+ * This module provides middleware functionality to automatically extract
+ * and persist session information from authentication responses, ensuring
+ * that new sessions are properly stored after sign-in operations.
+ */
+/**
+ * Creates a fetch middleware that automatically extracts and stores session data from API responses.
+ *
+ * This middleware:
+ * 1. Monitors responses from authentication-related endpoints
+ * 2. Extracts session information when present
+ * 3. Stores the session in the provided storage implementation
+ * 4. Handles session removal on sign-out
+ *
+ * This ensures that session data is always up-to-date in storage after operations
+ * that create or invalidate sessions.
+ *
+ * @param storage - Storage implementation for persisting session data
+ * @returns A middleware function that can be used in the fetch chain
+ */
+export const updateSessionFromResponseMiddleware = (storage) => {
+    /**
+     * Helper function to extract session data from various response formats
+     *
+     * @param body - Response data to extract session from
+     * @returns Session object if found, null otherwise
+     */
+    const sessionExtractor = (body) => {
+        if (typeof body === "string") {
+            return null;
+        }
+        if ("session" in body) {
+            // SessionPayload
+            return body.session || null;
+        }
+        if ("accessToken" in body && "refreshToken" in body) {
+            // Session
+            return body;
+        }
+        return null;
+    };
+    return (next) => async (url, options) => {
+        // Call the next middleware in the chain
+        const response = await next(url, options);
+        try {
+            // Check if this is a logout request
+            if (url.endsWith("/signout")) {
+                // Remove session on sign-out
+                storage.remove();
+                return response;
+            }
+            // Check if this is an auth-related endpoint that might return session data
+            if (url.endsWith("/token") ||
+                url.includes("/signin/") ||
+                url.includes("/signup/")) {
+                // Clone the response to avoid consuming it
+                const clonedResponse = response.clone();
+                // Parse the JSON data
+                const body = (await clonedResponse.json().catch(() => null));
+                if (body) {
+                    // Extract session data from response using provided extractor
+                    const session = sessionExtractor(body);
+                    // If session data is found, store it
+                    if (session?.accessToken && session.refreshToken) {
+                        storage.set(session);
+                    }
+                }
+            }
+        }
+        catch (error) {
+            console.warn("Error in session response middleware:", error);
+        }
+        // Return the original response
+        return response;
+    };
+};
+//# sourceMappingURL=middlewareUpdateSessionFromResponse.js.map

package/dist/src/fetch/middlewareUpdateSessionFromResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"middlewareUpdateSessionFromResponse.js","sourceRoot":"","sources":["../../../src/fetch/middlewareUpdateSessionFromResponse.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAMH;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,mCAAmC,GAAG,CACjD,OAAuB,EACR,EAAE;IACjB;;;;;OAKG;IACH,MAAM,gBAAgB,GAAG,CACvB,IAAuC,EACvB,EAAE;QAClB,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IAAI,SAAS,IAAI,IAAI,EAAE,CAAC;YACtB,iBAAiB;YACjB,OAAO,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC;QAC9B,CAAC;QAED,IAAI,aAAa,IAAI,IAAI,IAAI,cAAc,IAAI,IAAI,EAAE,CAAC;YACpD,UAAU;YACV,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO,CAAC,IAA+D,EAAE,EAAE,CACzE,KAAK,EAAE,GAAW,EAAE,OAAqB,EAAE,EAAE;QAC3C,wCAAwC;QACxC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QAE1C,IAAI,CAAC;YACH,oCAAoC;YACpC,IAAI,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC7B,6BAA6B;gBAC7B,OAAO,CAAC,MAAM,EAAE,CAAC;gBACjB,OAAO,QAAQ,CAAC;YAClB,CAAC;YAED,2EAA2E;YAC3E,IACE,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC;gBACtB,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC;gBACxB,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,EACxB,CAAC;gBACD,2CAA2C;gBAC3C,MAAM,cAAc,GAAG,QAAQ,CAAC,KAAK,EAAE,CAAC;gBAExC,sBAAsB;gBACtB,MAAM,IAAI,GAAG,CAAC,MAAM,cAAc,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAEzC,CAAC;gBAEnB,IAAI,IAAI,EAAE,CAAC;oBACT,8DAA8D;oBAC9D,MAAM,OAAO,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;oBAEvC,qCAAqC;oBACrC,IAAI,OAAO,EAAE,WAAW,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;wBACjD,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;oBACvB,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CAAC,uCAAuC,EAAE,KAAK,CAAC,CAAC;QAC/D,CAAC;QAED,+BAA+B;QAC/B,OAAO,QAAQ,CAAC;IAClB,CAAC,CAAC;AACN,CAAC,CAAC"}

package/dist/src/functions/client.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Functions client for the Nhost JavaScript SDK.
+ *
+ * This module provides functionality for executing serverless function calls
+ * against Nhost serverless functions.
+ */
+import { type ChainFunction, type FetchResponse } from "../fetch";
+/**
+ * Functions client interface providing methods for executing serverless function calls
+ */
+export interface Client {
+    baseURL: string;
+    /**
+     * Execute a request to a serverless function
+     * The response body will be automatically parsed based on the content type into the following types:
+     *   - Object if the response is application/json
+     *   - string text string if the response is text/*
+     *   - Blob if the response is any other type
+     *
+     * @param path - The path to the serverless function
+     * @param options - Additional fetch options to apply to the request
+     * @returns Promise with the function response and metadata.    */
+    fetch<T = unknown>(path: string, options?: RequestInit): Promise<FetchResponse<T>>;
+    /**
+     * Executes a POST request to a serverless function with a JSON body
+     *
+     * This is a convenience method assuming the request is a POST with JSON body
+     * setting the `Content-Type` and 'Accept' headers to `application/json` and
+     * automatically stringifying the body.
+     *
+     * For a more generic request, use the `fetch` method instead.
+     *
+     * @param path - The path to the serverless function
+     * @param body - The JSON body to send in the request
+     * @param options - Additional fetch options to apply to the request
+     * @returns Promise with the function response and metadata
+     */
+    post<T = unknown>(path: string, body?: unknown, options?: RequestInit): Promise<FetchResponse<T>>;
+}
+/**
+ * Creates a Functions API client for interacting with serverless functions.
+ *
+ * This client provides methods for executing requests against serverless functions,
+ * with support for middleware functions to handle authentication, error handling,
+ * and other cross-cutting concerns.
+ *
+ * @param baseURL - Base URL for the functions endpoint
+ * @param chainFunctions - Array of middleware functions for the fetch chain
+ * @returns Functions client with fetch method
+ */
+export declare const createAPIClient: (baseURL: string, chainFunctions?: ChainFunction[]) => Client;
+//# sourceMappingURL=client.d.ts.map

package/dist/src/functions/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/functions/client.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EACL,KAAK,aAAa,EAGlB,KAAK,aAAa,EACnB,MAAM,UAAU,CAAC;AAElB;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;;;;;sEASkE;IAClE,KAAK,CAAC,CAAC,GAAG,OAAO,EACf,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;IAE7B;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,CAAC,GAAG,OAAO,EACd,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,OAAO,EACd,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;CAC9B;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe,GAC1B,SAAS,MAAM,EACf,iBAAgB,aAAa,EAAO,KACnC,MAiFF,CAAC"}

package/dist/src/functions/client.js

@@ -0,0 +1,89 @@
+/**
+ * Functions client for the Nhost JavaScript SDK.
+ *
+ * This module provides functionality for executing serverless function calls
+ * against Nhost serverless functions.
+ */
+import { createEnhancedFetch, FetchError, } from "../fetch";
+/**
+ * Creates a Functions API client for interacting with serverless functions.
+ *
+ * This client provides methods for executing requests against serverless functions,
+ * with support for middleware functions to handle authentication, error handling,
+ * and other cross-cutting concerns.
+ *
+ * @param baseURL - Base URL for the functions endpoint
+ * @param chainFunctions - Array of middleware functions for the fetch chain
+ * @returns Functions client with fetch method
+ */
+export const createAPIClient = (baseURL, chainFunctions = []) => {
+    const enhancedFetch = createEnhancedFetch(chainFunctions);
+    /**
+     * Executes a request to a serverless function and processes the response
+     *
+     * @param path - The path to the serverless function
+     * @param options - Additional fetch options to apply to the request
+     * @returns Promise with the function response and metadata. Body will be either
+     *   - JSON object if the response is application/json
+         - text string if the response is text/*
+         - Blob if the response is any other type
+     */
+    const fetch = async (path, options) => {
+        const resp = await enhancedFetch(`${baseURL}${path}`, options);
+        let body;
+        // Process response based on content type
+        if (resp.headers.get("content-type")?.includes("application/json")) {
+            body = (await resp.json());
+        }
+        else if (resp.headers.get("content-type")?.startsWith("text/")) {
+            body = await resp.text();
+        }
+        else {
+            body = await resp.blob();
+        }
+        // Throw error for non-OK responses
+        if (!resp.ok) {
+            throw new FetchError(body, resp.status, resp.headers);
+        }
+        return {
+            status: resp.status,
+            body,
+            headers: resp.headers,
+        };
+    };
+    /**
+     * Executes a POST request to a serverless function with a JSON body
+     *
+     * This is a convenience method assuming the request is a POST with JSON body
+     * setting the `Content-Type` and 'Accept' headers to `application/json` and
+     * automatically stringifying the body.
+     *
+     * For a more generic request, use the `fetch` method instead.
+     *
+     * @param path - The path to the serverless function
+     * @param body - The JSON body to send in the request
+     * @param options - Additional fetch options to apply to the request
+     * @returns Promise with the function response and metadata
+     */
+    const post = async (path, body, options = {}) => {
+        // Ensure the method is POST and set the body
+        const requestOptions = {
+            ...options,
+            method: "POST",
+            headers: {
+                Accept: "application/json",
+                "Content-Type": "application/json",
+                ...options.headers,
+            },
+            body: body ? JSON.stringify(body) : undefined,
+        };
+        return fetch(path, requestOptions);
+    };
+    // Return client object with the fetch method
+    return {
+        baseURL,
+        fetch,
+        post,
+    };
+};
+//# sourceMappingURL=client.js.map

package/dist/src/functions/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../src/functions/client.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAEL,mBAAmB,EACnB,UAAU,GAEX,MAAM,UAAU,CAAC;AA4ClB;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,OAAe,EACf,iBAAkC,EAAE,EAC5B,EAAE;IACV,MAAM,aAAa,GAAG,mBAAmB,CAAC,cAAc,CAAC,CAAC;IAE1D;;;;;;;;;OASG;IACH,MAAM,KAAK,GAAG,KAAK,EACjB,IAAY,EACZ,OAAqB,EACsB,EAAE;QAC7C,MAAM,IAAI,GAAG,MAAM,aAAa,CAAC,GAAG,OAAO,GAAG,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;QAE/D,IAAI,IAAuB,CAAC;QAC5B,yCAAyC;QACzC,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACnE,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAM,CAAC;QAClC,CAAC;aAAM,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YACjE,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QAC3B,CAAC;aAAM,CAAC;YACN,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QAC3B,CAAC;QAED,mCAAmC;QACnC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;YACb,MAAM,IAAI,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACxD,CAAC;QAED,OAAO;YACL,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,IAAI;YACJ,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC;IACJ,CAAC,CAAC;IAEF;;;;;;;;;;;;;OAaG;IACH,MAAM,IAAI,GAAG,KAAK,EAChB,IAAY,EACZ,IAAc,EACd,UAAuB,EAAE,EACkB,EAAE;QAC7C,6CAA6C;QAC7C,MAAM,cAAc,GAAgB;YAClC,GAAG,OAAO;YACV,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,MAAM,EAAE,kBAAkB;gBAC1B,cAAc,EAAE,kBAAkB;gBAClC,GAAG,OAAO,CAAC,OAAO;aACnB;YACD,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;SAC9C,CAAC;QAEF,OAAO,KAAK,CAAI,IAAI,EAAE,cAAc,CAAC,CAAC;IACxC,CAAC,CAAC;IAEF,6CAA6C;IAC7C,OAAO;QACL,OAAO;QACP,KAAK;QACL,IAAI;KACK,CAAC;AACd,CAAC,CAAC"}

package/dist/src/functions/index.d.ts

@@ -0,0 +1,43 @@
+/**
+ * This is the main module to interact with Nhost's Functions service.
+ * Typically you would use this module via the main [Nhost client](main#createclient)
+ * but you can also use it directly if you have a specific use case.
+ *
+ * ## Import
+ *
+ * You can import and use this package with:
+ *
+ * ```ts
+ * import { createClient } from "@nhost/nhost-js/functions";
+ * ```
+ *
+ * ## Usage
+ *
+ * You can use this library by passing the path to the function you want to call and any body
+ * or fetch options you want to apply (optional):
+ *
+ * {@includeCode ./__tests__/docstrings.test.ts:2,4,9-20}
+ *
+ * The post method above is a convenience method for executing a POST request with a JSON body.
+ * For more generic requests, you can use the `fetch` method instead:
+ *
+ * {@includeCode ./__tests__/docstrings.test.ts:2,4,30-43}
+ *
+ * ## Error handling
+ *
+ * The SDK will throw errors in most operations if the request returns a status >=300 or
+ * if the request fails entirely (i.e., due to network errors). The type of the error
+ * will be a `FetchError<T>`:
+ *
+ * {@includeCode ./__tests__/docstrings.test.ts:2-4,53-64,67-79,84}
+ *
+ * This type extends the standard `Error` type so if you want to just log the error you can
+ * do so like this:
+ *
+ * {@includeCode ./__tests__/docstrings.test.ts:2-4,91-102,105-112,115}
+ *
+ * @module functions
+ * @packageDocumentation
+ */
+export * from "./client";
+//# sourceMappingURL=index.d.ts.map

package/dist/src/functions/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/functions/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AAEH,cAAc,UAAU,CAAC"}

package/dist/src/functions/index.js

@@ -0,0 +1,43 @@
+/**
+ * This is the main module to interact with Nhost's Functions service.
+ * Typically you would use this module via the main [Nhost client](main#createclient)
+ * but you can also use it directly if you have a specific use case.
+ *
+ * ## Import
+ *
+ * You can import and use this package with:
+ *
+ * ```ts
+ * import { createClient } from "@nhost/nhost-js/functions";
+ * ```
+ *
+ * ## Usage
+ *
+ * You can use this library by passing the path to the function you want to call and any body
+ * or fetch options you want to apply (optional):
+ *
+ * {@includeCode ./__tests__/docstrings.test.ts:2,4,9-20}
+ *
+ * The post method above is a convenience method for executing a POST request with a JSON body.
+ * For more generic requests, you can use the `fetch` method instead:
+ *
+ * {@includeCode ./__tests__/docstrings.test.ts:2,4,30-43}
+ *
+ * ## Error handling
+ *
+ * The SDK will throw errors in most operations if the request returns a status >=300 or
+ * if the request fails entirely (i.e., due to network errors). The type of the error
+ * will be a `FetchError<T>`:
+ *
+ * {@includeCode ./__tests__/docstrings.test.ts:2-4,53-64,67-79,84}
+ *
+ * This type extends the standard `Error` type so if you want to just log the error you can
+ * do so like this:
+ *
+ * {@includeCode ./__tests__/docstrings.test.ts:2-4,91-102,105-112,115}
+ *
+ * @module functions
+ * @packageDocumentation
+ */
+export * from "./client";
+//# sourceMappingURL=index.js.map

package/dist/src/functions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/functions/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AAEH,cAAc,UAAU,CAAC"}

package/dist/src/graphql/client.d.ts

@@ -0,0 +1,93 @@
+/**
+ * GraphQL client for the Nhost JavaScript SDK.
+ *
+ * This module provides functionality for executing GraphQL operations against
+ * a Hasura GraphQL API.
+ */
+import type { TypedDocumentNode } from "@graphql-typed-document-node/core";
+import { type ChainFunction, type FetchResponse } from "../fetch";
+/**
+ * Variables object for GraphQL operations.
+ * Key-value pairs of variable names and their values.
+ */
+export type GraphQLVariables = Record<string, unknown>;
+/**
+ * GraphQL request object used for queries and mutations.
+ */
+export interface GraphQLRequest<TVariables = GraphQLVariables> {
+    /** The GraphQL query or mutation string */
+    query: string;
+    /** Optional variables for parameterized queries */
+    variables?: TVariables;
+    /** Optional name of the operation to execute */
+    operationName?: string;
+}
+/**
+ * Represents a GraphQL error returned from the server.
+ */
+export interface GraphQLError {
+    /** Error message */
+    message: string;
+    /** Source locations in the GraphQL document where the error occurred */
+    locations?: {
+        line: number;
+        column: number;
+    }[];
+    /** Path in the query where the error occurred */
+    path?: string[];
+    /** Additional error information specific to the GraphQL implementation */
+    extensions?: {
+        path: string;
+        code: string;
+    };
+}
+/**
+ * Standard GraphQL response format as defined by the GraphQL specification.
+ */
+export interface GraphQLResponse<TResponseData = unknown> {
+    /** The data returned from successful execution */
+    data?: TResponseData;
+    /** Array of errors if execution was unsuccessful or partially successful */
+    errors?: GraphQLError[];
+}
+/**
+ * GraphQL client interface providing methods for executing queries and mutations
+ */
+export interface Client {
+    /**
+     * Execute a GraphQL query operation
+     *
+     * Queries are used to fetch data and should not modify any data on the server.
+     *
+     * @param request - GraphQL request object containing query and optional variables
+     * @param options - Additional fetch options to apply to the request
+     * @returns Promise with the GraphQL response and metadata
+     */
+    request<TResponseData = unknown, TVariables = GraphQLVariables>(request: GraphQLRequest<TVariables>, options?: RequestInit): Promise<FetchResponse<GraphQLResponse<TResponseData>>>;
+    /**
+     * Execute a GraphQL query operation using a typed document node
+     *
+     * @param document - TypedDocumentNode containing the query and type information
+     * @param variables - Variables for the GraphQL operation
+     * @param options - Additional fetch options to apply to the request
+     * @returns Promise with the GraphQL response and metadata
+     */
+    request<TResponseData, TVariables = GraphQLVariables>(document: TypedDocumentNode<TResponseData, TVariables>, variables?: TVariables, options?: RequestInit): Promise<FetchResponse<GraphQLResponse<TResponseData>>>;
+    /**
+     * URL for the GraphQL endpoint.
+     */
+    url: string;
+}
+/**
+ * Creates a GraphQL API client for interacting with a GraphQL endpoint.
+ *
+ * This client provides methods for executing queries and mutations against
+ * a GraphQL API, with support for middleware functions to handle authentication,
+ * error handling, and other cross-cutting concerns.
+ *
+ * @param url - Base URL for the GraphQL endpoint
+ * @param chainFunctions - Array of middleware functions for the fetch chain
+ * @returns GraphQL client with query and mutation methods
+ */
+export declare const createAPIClient: (url: string, chainFunctions?: ChainFunction[]) => Client;
+//# sourceMappingURL=client.d.ts.map

package/dist/src/graphql/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/graphql/client.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAC;AAC3E,OAAO,EACL,KAAK,aAAa,EAGlB,KAAK,aAAa,EACnB,MAAM,UAAU,CAAC;AAElB;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEvD;;GAEG;AACH,MAAM,WAAW,cAAc,CAAC,UAAU,GAAG,gBAAgB;IAC3D,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAC;IACd,mDAAmD;IACnD,SAAS,CAAC,EAAE,UAAU,CAAC;IACvB,gDAAgD;IAChD,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,oBAAoB;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,wEAAwE;IACxE,SAAS,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAC/C,iDAAiD;IACjD,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,0EAA0E;IAC1E,UAAU,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;CAC7C;AAED;;GAEG;AACH,MAAM,WAAW,eAAe,CAAC,aAAa,GAAG,OAAO;IACtD,kDAAkD;IAClD,IAAI,CAAC,EAAE,aAAa,CAAC;IACrB,4EAA4E;IAC5E,MAAM,CAAC,EAAE,YAAY,EAAE,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;;;;;;;OAQG;IACH,OAAO,CAAC,aAAa,GAAG,OAAO,EAAE,UAAU,GAAG,gBAAgB,EAC5D,OAAO,EAAE,cAAc,CAAC,UAAU,CAAC,EACnC,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,aAAa,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAE1D;;;;;;;OAOG;IACH,OAAO,CAAC,aAAa,EAAE,UAAU,GAAG,gBAAgB,EAClD,QAAQ,EAAE,iBAAiB,CAAC,aAAa,EAAE,UAAU,CAAC,EACtD,SAAS,CAAC,EAAE,UAAU,EACtB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,aAAa,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAE1D;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe,GAC1B,KAAK,MAAM,EACX,iBAAgB,aAAa,EAAO,KACnC,MA6EF,CAAC"}

package/dist/src/graphql/client.js

@@ -0,0 +1,66 @@
+/**
+ * GraphQL client for the Nhost JavaScript SDK.
+ *
+ * This module provides functionality for executing GraphQL operations against
+ * a Hasura GraphQL API.
+ */
+import { createEnhancedFetch, FetchError, } from "../fetch";
+/**
+ * Creates a GraphQL API client for interacting with a GraphQL endpoint.
+ *
+ * This client provides methods for executing queries and mutations against
+ * a GraphQL API, with support for middleware functions to handle authentication,
+ * error handling, and other cross-cutting concerns.
+ *
+ * @param url - Base URL for the GraphQL endpoint
+ * @param chainFunctions - Array of middleware functions for the fetch chain
+ * @returns GraphQL client with query and mutation methods
+ */
+export const createAPIClient = (url, chainFunctions = []) => {
+    const enhancedFetch = createEnhancedFetch(chainFunctions);
+    const executeOperation = async (request, options) => {
+        const response = await enhancedFetch(`${url}`, {
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: JSON.stringify(request),
+            ...options,
+        });
+        const body = await response.text();
+        const data = (body ? JSON.parse(body) : {});
+        const resp = {
+            body: data,
+            status: response.status,
+            headers: response.headers,
+        };
+        if (data.errors) {
+            throw new FetchError(data, response.status, response.headers);
+        }
+        return resp;
+    };
+    function request(requestOrDocument, variablesOrOptions, options) {
+        if (typeof requestOrDocument === "object" && "kind" in requestOrDocument) {
+            const definition = requestOrDocument.definitions[0];
+            const request = {
+                query: requestOrDocument.loc?.source.body || "",
+                variables: variablesOrOptions,
+                operationName: definition && "name" in definition
+                    ? definition.name?.value
+                    : undefined,
+            };
+            return executeOperation(request, options);
+        }
+        else {
+            // Handle GraphQLRequest
+            const request = requestOrDocument;
+            const requestOptions = variablesOrOptions;
+            return executeOperation(request, requestOptions);
+        }
+    }
+    return {
+        request,
+        url,
+    };
+};
+//# sourceMappingURL=client.js.map

package/dist/src/graphql/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../src/graphql/client.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAEL,mBAAmB,EACnB,UAAU,GAEX,MAAM,UAAU,CAAC;AAkFlB;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,GAAW,EACX,iBAAkC,EAAE,EAC5B,EAAE;IACV,MAAM,aAAa,GAAG,mBAAmB,CAAC,cAAc,CAAC,CAAC;IAE1D,MAAM,gBAAgB,GAAG,KAAK,EAI5B,OAAmC,EACnC,OAAqB,EACmC,EAAE;QAC1D,MAAM,QAAQ,GAAG,MAAM,aAAa,CAAC,GAAG,GAAG,EAAE,EAAE;YAC7C,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC7B,GAAG,OAAO;SACX,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACnC,MAAM,IAAI,GAAmC,CAC3C,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CACK,CAAC;QAEpC,MAAM,IAAI,GAAG;YACX,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,QAAQ,CAAC,MAAM;YACvB,OAAO,EAAE,QAAQ,CAAC,OAAO;SAC1B,CAAC;QAEF,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,IAAI,UAAU,CAAC,IAAI,EAAE,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;QAChE,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IAWF,SAAS,OAAO,CACd,iBAEgD,EAChD,kBAA6C,EAC7C,OAAqB;QAErB,IAAI,OAAO,iBAAiB,KAAK,QAAQ,IAAI,MAAM,IAAI,iBAAiB,EAAE,CAAC;YACzE,MAAM,UAAU,GAAG,iBAAiB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;YAEpD,MAAM,OAAO,GAA+B;gBAC1C,KAAK,EAAE,iBAAiB,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,IAAI,EAAE;gBAC/C,SAAS,EAAE,kBAAgC;gBAC3C,aAAa,EACX,UAAU,IAAI,MAAM,IAAI,UAAU;oBAChC,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK;oBACxB,CAAC,CAAC,SAAS;aAChB,CAAC;YACF,OAAO,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC5C,CAAC;aAAM,CAAC;YACN,wBAAwB;YACxB,MAAM,OAAO,GAAG,iBAAiB,CAAC;YAClC,MAAM,cAAc,GAAG,kBAAiC,CAAC;YACzD,OAAO,gBAAgB,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;IAED,OAAO;QACL,OAAO;QACP,GAAG;KACM,CAAC;AACd,CAAC,CAAC"}

package/dist/src/graphql/index.d.ts

@@ -0,0 +1,65 @@
+/**
+ * This is the main module to interact with Nhost's GraphQL service.
+ * Typically you would use this module via the main [Nhost client](main#createclient)
+ * but you can also use it directly if you have a specific use case.
+ *
+ * ## Import
+ *
+ * ```ts
+ * import { createClient } from "@nhost/nhost-js/graphql";
+ * ```
+ *
+ * ## Usage
+ *
+ *  The `request` method provides type-safe GraphQL operations with full TypeScript support.
+ *  You can leverage generics to type your responses and use GraphQL document nodes for better
+ *  integration with third-party libraries.
+ *
+ * ### Basic Usage
+ *
+ * {@includeCode ./__tests__/docstrings.test.ts:2,6,11-25}
+ *
+ * ### Using Variables
+ *  You can pass variables to your GraphQL queries and mutations using the `variables` option:
+ *
+ * {@includeCode ./__tests__/docstrings.test.ts:2,6,195-228}
+ *
+ * This allows you to dynamically pass values to your queries and mutations, making them more
+ * flexible and reusable.
+ *
+ * ### Using String Queries with Type Generics
+ *
+ * You can type your GraphQL queries and responses using TypeScript generics:
+ *
+ * {@includeCode ./__tests__/docstrings.test.ts:2,6,97-123}
+ *
+ * ### Using GraphQL Document Nodes
+ *
+ * For better integration with third-party libraries like Apollo Client or The Guild's GraphQL
+ * Code Generator, you can use GraphQL document nodes created with `gql` template literal tags:
+ *
+ * {@includeCode ./__tests__/docstrings.test.ts:2,5,6,248-293}
+ *
+ * Using document nodes enables:
+ * - Better IDE support with syntax highlighting and validation
+ * - Integration with code generation tools
+ * - Compatibility with Apollo Client and other GraphQL libraries
+ *
+ * ## Error handling
+ *
+ * The SDK will throw errors in GraphQL operations that respond with an errors attribute
+ * with length > 0. The error will be an instance of `FetchError<GraphQLResponse>` and will
+ * contain the response body with the errors.
+ *
+ * {@includeCode ./__tests__/docstrings.test.ts:2-4,6,313-353,367}
+ *
+ * This type extends the standard `Error` type so if you want to just log the error you can
+ * do so like this:
+ *
+ * {@includeCode ./__tests__/docstrings.test.ts:2-4,6,371-394,399}
+ *
+ * @module graphql
+ * @packageDocumentation
+ */
+export * from "./client";
+//# sourceMappingURL=index.d.ts.map

package/dist/src/graphql/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/graphql/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8DG;AAEH,cAAc,UAAU,CAAC"}

package/dist/src/graphql/index.js

@@ -0,0 +1,65 @@
+/**
+ * This is the main module to interact with Nhost's GraphQL service.
+ * Typically you would use this module via the main [Nhost client](main#createclient)
+ * but you can also use it directly if you have a specific use case.
+ *
+ * ## Import
+ *
+ * ```ts
+ * import { createClient } from "@nhost/nhost-js/graphql";
+ * ```
+ *
+ * ## Usage
+ *
+ *  The `request` method provides type-safe GraphQL operations with full TypeScript support.
+ *  You can leverage generics to type your responses and use GraphQL document nodes for better
+ *  integration with third-party libraries.
+ *
+ * ### Basic Usage
+ *
+ * {@includeCode ./__tests__/docstrings.test.ts:2,6,11-25}
+ *
+ * ### Using Variables
+ *  You can pass variables to your GraphQL queries and mutations using the `variables` option:
+ *
+ * {@includeCode ./__tests__/docstrings.test.ts:2,6,195-228}
+ *
+ * This allows you to dynamically pass values to your queries and mutations, making them more
+ * flexible and reusable.
+ *
+ * ### Using String Queries with Type Generics
+ *
+ * You can type your GraphQL queries and responses using TypeScript generics:
+ *
+ * {@includeCode ./__tests__/docstrings.test.ts:2,6,97-123}
+ *
+ * ### Using GraphQL Document Nodes
+ *
+ * For better integration with third-party libraries like Apollo Client or The Guild's GraphQL
+ * Code Generator, you can use GraphQL document nodes created with `gql` template literal tags:
+ *
+ * {@includeCode ./__tests__/docstrings.test.ts:2,5,6,248-293}
+ *
+ * Using document nodes enables:
+ * - Better IDE support with syntax highlighting and validation
+ * - Integration with code generation tools
+ * - Compatibility with Apollo Client and other GraphQL libraries
+ *
+ * ## Error handling
+ *
+ * The SDK will throw errors in GraphQL operations that respond with an errors attribute
+ * with length > 0. The error will be an instance of `FetchError<GraphQLResponse>` and will
+ * contain the response body with the errors.
+ *
+ * {@includeCode ./__tests__/docstrings.test.ts:2-4,6,313-353,367}
+ *
+ * This type extends the standard `Error` type so if you want to just log the error you can
+ * do so like this:
+ *
+ * {@includeCode ./__tests__/docstrings.test.ts:2-4,6,371-394,399}
+ *
+ * @module graphql
+ * @packageDocumentation
+ */
+export * from "./client";
+//# sourceMappingURL=index.js.map