Registry / devops / altair-graphql-core

altair-graphql-core

library8.5.7jsnpmunverified

Core logic library for the Altair GraphQL client ecosystem (version 8.5.7, npm-only, no releases since Oct 2024). Provides shared utilities including request building, response parsing, introspection helpers, and state management primitives used by altair-gql and altair-express-middleware. Unlike larger alternatives like graphql-request or Apollo Client, this is a lightweight, framework-agnostic core intended to be consumed by Altair wrappers. Auto-generated TypeScript definitions included; ESM-only since v8, with Node 12+ requirement.

devops

npm install altair-graphql-core

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · ALTAIR-GRAPHQL-COR

altair-graphql-core

devopsjavascriptv8.5.7

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

createClient

✓ import { createClient } from 'altair-graphql-core'

✗ const createClient = require('altair-graphql-core')

Package is ESM-only since v8; CJS require() will throw ERR_REQUIRE_ESM.

AltairGraphQLConfig

✓ import type { AltairGraphQLConfig } from 'altair-graphql-core'

✗ import { AltairGraphQLConfig } from 'altair-graphql-core'

Type imports require explicit `import type` in TypeScript with 'verbatimModuleSyntax'.

default

✓ import AltairCore from 'altair-graphql-core'

✗ import { default as AltairCore } from 'altair-graphql-core'

Default export is available but not documented; prefer named exports.

Shows creating a client with URL and optional auth headers, then executing a GraphQL query.

import { createClient } from 'altair-graphql-core'; const client = createClient({ url: process.env.GRAPHQL_URL ?? 'http://localhost:4000/graphql', headers: { Authorization: `Bearer ${process.env.TOKEN ?? ''}` } }); async function run() { const query = ` query GetUsers { users { id name } } `; const result = await client.request({ query }); console.log(result.data); } run().catch(console.error);

Debug

Known issues

breakingPackage is ESM-only from v8 onwards. CommonJS require() will fail with ERR_REQUIRE_ESM.

fix

Migrate to ESM (use import syntax) or use dynamic import() inside CJS.

affects: >=8.0.0

gotchaTypeScript types are auto-generated and may have subtle inaccuracies. IntelliSense may not match runtime behavior for complex unions.

fix

Runtime test your GraphQL operations; don't rely solely on types.

affects: all

deprecatedThe `request` method signature changed in v7 to accept a configuration object instead of positional args. Old code may break silently.

fix

Update to use { query, variables, operationName } object.

affects: <8.0.0

gotchaGlobal fetch is assumed. In Node <18, polyfill is required (e.g., 'cross-fetch'). No graceful error if missing.

fix

Install cross-fetch and import it at entry point.

affects: >=5.0.0

Errors

Common errors & fixes

Error [ERR_REQUIRE_ESM]: require() of ES Module not supported

Using CommonJS require() to import an ESM-only package.

fix

Change to import syntax: `import ... from 'altair-graphql-core'` or use dynamic import: `const m = await import('altair-graphql-core')`.

TypeError: client.request is not a function

Calling request() on a client created with an outdated signature or incorrect import.

fix

Ensure correct import and that client is created with `createClient()` per docs.

ReferenceError: fetch is not defined

Node.js version <18 does not have global fetch. The package uses fetch internally but doesn't polyfill.

fix

Install `cross-fetch` and add `import 'cross-fetch/polyfill'` at your app entry point.

Upgrade

Version history

8.5.7latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

21 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/altair-graphql/altair ↗

packagealtair-graphql-core ↗

homepagehttps://github.com/altair-graphql/altair#readme ↗