Apollo Link HTTP Common Utilities

Common errors

• Cannot find module 'apollo-link-http-common' or its corresponding type declarations.

  cause Attempting to use `apollo-link-http-common` in a modern Apollo Client (v3+) project where it has been deprecated and removed.
  fix Remove the `apollo-link-http-common` dependency. The functionality is now integrated into `@apollo/client/link/http`. Adapt your code to use `@apollo/client`'s native HTTP link functionality.

• Error: Cannot find module 'graphql'

  cause The `graphql` peer dependency is not installed or its version does not satisfy the specified range (`^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0`).
  fix Install `graphql` as a dependency: `npm install graphql` or `yarn add graphql`. Ensure its version is compatible with the peer dependency range specified.

Warnings

• breaking The `apollo-link` ecosystem, including `apollo-link-http-common`, is deprecated as of Apollo Client 3.0. Its functionalities have been moved directly into `@apollo/client`. Direct usage of this package is strongly discouraged, and existing implementations should migrate.
  Fix: Migrate your application to use `@apollo/client/link/http` and other `@apollo/client` features directly. Remove all `apollo-link`, `apollo-link-http`, and `apollo-link-http-common` dependencies.
• breaking The README explicitly states that the API of `apollo-link-http-common` is subject to change and versions may not follow SemVer. This means breaking changes can occur even between minor or patch versions.
  Fix: Avoid direct reliance on this package if possible. If you must use it (e.g., in a legacy `apollo-link` setup), pin exact versions and rigorously test updates. The recommended fix is to migrate to `@apollo/client`.
• gotcha This package is primarily an internal utility. It never reached a 1.0 stable release, indicating it was always considered experimental or unstable for external consumption. Direct usage by end-users is not its intended purpose.
  Fix: Recognize this package's internal role. For user-facing HTTP links, use the stable `HttpLink` from `@apollo/client` (since v3) or `apollo-link-http` (for older Apollo Client versions).

Install

• npm install apollo-link-http-common npm
• yarn add apollo-link-http-common yarn
• pnpm add apollo-link-http-common pnpm

Imports

• selectHttpOptionsAndBody
  wrong:

  const { selectHttpOptionsAndBody } = require('apollo-link-http-common');

  correct:

  import { selectHttpOptionsAndBody } from 'apollo-link-http-common'

  This package is not intended for direct end-user consumption. Use ESM-style imports if absolutely necessary for internal development, but migration to @apollo/client is recommended.
• parseAndCheckHttpResponse
  wrong:

  import parseAndCheckHttpResponse from 'apollo-link-http-common';

  correct:

  import { parseAndCheckHttpResponse } from 'apollo-link-http-common'

  This is a named export, not a default. The package is generally deprecated, and these utilities are now found within @apollo/client.
• serializeFetchParameter
  wrong:

  const serializeFetchParameter = require('apollo-link-http-common').serializeFetchParameter;

  correct:

  import { serializeFetchParameter } from 'apollo-link-http-common'

  Primarily for internal use by other `apollo-link` packages. Direct use is discouraged due to the package's deprecated status and unstable API.

Quickstart

This example demonstrates how an internal utility like `parseAndCheckHttpResponse` from `apollo-link-http-common` would process a mock HTTP response into a GraphQL result. It highlights the package's internal, lower-level role in handling network responses, not its direct use in creating an Apollo Link. This package is deprecated; for actual Apollo Client HTTP networking, use `@apollo/client/link/http`.

import { parseAndCheckHttpResponse } from 'apollo-link-http-common';
import { print } from 'graphql';

const mockOperation = {
  query: print(`query GetGreeting { greeting }`),
  variables: {},
  operationName: 'GetGreeting',
  extensions: {}
};

async function handleMockResponse() {
  // This is a simplified example demonstrating an internal utility function.
  // In a real scenario, you'd have a 'Response' object from a fetch call.
  const mockResponse = new Response(JSON.stringify({
    data: { greeting: 'Hello World!' }
  }), {
    status: 200,
    headers: { 'Content-Type': 'application/json' }
  });

  try {
    const result = await parseAndCheckHttpResponse(mockOperation, mockResponse);
    console.log('Parsed GraphQL result:', result);
  } catch (error) {
    console.error('Error parsing response:', error);
  }
}

handleMockResponse();