\n\n## Features\n\n- **Node.js**: >= 20.0.0\n- **GraphQL v16**: Full support for the latest GraphQL spec\n- **Concurrent batched operations** with [graphql-batch-executor](https://github.com/HydreIO/graphql-batch-executor)\n- **Server** built as a [Shimio](https://github.com/HydreIO/shimio) middleware\n- **Client** as an async iterator\n- **Real-time subscriptions** over multiplexed WebSocket channels\n\n## What's New in v6.0.0\n\n- โจ Upgraded to GraphQL v16.9.0 (from v15.4.0)\n- ๐ Node.js 20+ support with native language features\n- ๐ฆ Updated to @hydre/shimio v5.0.0 (ws v8)\n- ๐งน Removed Babel dependencies (no longer needed for modern Node.js)\n- ๐ง Modernized development dependencies\n- ๐ฏ All tests passing with GraphQL v16\n\n## Table of content \n\n- [Installation](#installation)\n- [Requirements](#requirements)\n- [Quick start](#quick-start)\n - [Server example](#server-example)\n - [Client example](#client-example)\n- [Migration from v5.x](#migration-from-v5x)\n\n## Installation\n\n```sh\nnpm install @hydre/shimio-graphql\n```\n\n## Requirements\n\n- **Node.js**: >= 20.0.0\n- **GraphQL**: v16.x\n- **@hydre/shimio**: v5.x\n\n## Quick start\n\n### Server example\n```js\nimport { readFileSync } from 'fs'\nimport { dirname, join } from 'path'\nimport { PassThrough } from 'stream'\nimport { fileURLToPath } from 'url'\nimport Server from '@hydre/shimio/server'\nimport Serve from '@hydre/shimio-graphql/serve'\nimport graphql from 'graphql'\nimport Koa from 'koa'\n\nconst directory = dirname(fileURLToPath(import.meta.url))\nconst WAIT = 150\nconst file = readFileSync(join(directory, 'schema.gql'), 'utf-8')\nconst server = Server({\n koa: new Koa(),\n // context here is an empty object created by Shimio server\n on_upgrade: ({ context }) => {\n context.through = new PassThrough({ objectMode: true })\n return true\n },\n on_socket: Serve({\n context: async ({\n // the raw upgraded socket\n socket,\n // the raw connection context (in allow_upgrade)\n context,\n // the raw first http request\n request\n }) => ({\n // put whatever you want here\n // this is to build a per-operation context\n // each batch of queries will have a clean context\n }),\n schema: graphql.buildSchema(file),\n query : {\n me() {\n return { name: 'pepeg' }\n },\n ping() {\n return 'ping pong chin chan'\n },\n },\n mutation: {\n sendMessage({ message }, { through }) {\n through.write({ onMessage: message })\n return 'message sent!'\n },\n },\n subscription: {\n async *onMessage(_, { through }) {\n for await (const chunk of through) {\n await new Promise(resolve =>\n setTimeout(resolve, WAIT))\n yield chunk\n }\n },\n },\n }),\n})\n\nawait server.listen(3000)\nconsole.log('running on :3000')\n```\n\n### Client example\n\n```js\nimport debug from 'debug'\nimport casual from 'casual'\nimport { inspect } from 'util'\nimport Client from '@hydre/shimio/client'\nimport Query from '@hydre/shimio-graphql/query'\n\n// || ===========================================\n// || When running in nodejs you need to provide a ws polyfill\n// || Browsers have it by default\n// ||\nimport ws from 'ws'\nglobalThis.WebSocket = ws\n// ||\n// || ===========================================\n\n// see options in @hydre/shimio\nconst client = Client({ host: 'ws://0.0.0.0:3000' })\nconst query = Query(client)\nconst END = 2000\n\nawait client.connect()\n\nconst {\n listen, // an asyncIterator yielding updates\n stop, // close the channel\n once // promise of the first result only\n} = await query(/* GraphQL */ `\n query pang {\n ping\n }\n\n mutation hello {\n first: sendMessage(message: \"howdy\")\n then: sendMessage(message: \"pls sir show vagana\")\n }\n\n subscription hey_listen {\n onMessage\n }\n`)\n\nsetTimeout(() => {\n stop() // unsubscribe from operation\n}, END)\n\nfor await (const chunk of listen())\n console.log('received', inspect(chunk, false, Infinity, true))\n\nclient.disconnect()\n```\n\n\n\n## Migration from v5.x\n\n### Breaking Changes\n\n#### GraphQL v16\n\nshimio-graphql v6.0.0 uses GraphQL v16, which has breaking changes from v15:\n\n1. **Type system changes**: Some internal type definitions have changed\n2. **Execution changes**: Minor improvements to subscription execution\n3. **Deprecated features removed**: Some v15 deprecations are now removed\n\n**Most users won't need code changes** - the GraphQL v16 upgrade is largely internal. If you use custom GraphQL directives or advanced schema manipulation, review the [GraphQL v16 changelog](https://github.com/graphql/graphql-js/releases/tag/v16.0.0).\n\n#### @hydre/shimio v5\n\nshimio-graphql v6 requires @hydre/shimio v5.x (which uses ws v8). See the [@hydre/shimio migration guide](https://github.com/HydreIO/shimio#migration-from-v4x) for details.\n\n**No code changes needed** if you only use `@hydre/shimio-graphql/serve` and `@hydre/shimio-graphql/query`.\n\n### Node.js Version\n\nUpgrade to Node.js >= 20.0.0 before upgrading to v6.0.0.\n\n### No API Changes\n\nThe shimio-graphql API remains unchanged:\n- `Serve()` server middleware: same API\n- `Query()` client: same API\n- All examples from v5 work in v6\n\nSimply update your dependencies:\n\n```sh\nnpm install @hydre/shimio@^5.0.0 @hydre/shimio-graphql@^6.0.0 graphql@^16.0.0\n```\n\n","readmeFilename":"README.md"}
![](\"https://img.shields.io/badge/license-Unlicense-blue.svg?style=for-the-badge\"){kind=icon}
\n ![](\"https://img.shields.io/codecov/c/github/hydreio/shimio-graphql/master?logo=codecov&style=for-the-badge\"/)
\n \n ![](\"https://img.shields.io/npm/v/@hydre/shimio-graphql.svg?logo=npm&style=for-the-badge\"){kind=spacer}
\n \n ![](\"https://img.shields.io/npm/dw/@hydre/shimio-graphql?logo=npm&style=for-the-badge\"){kind=spacer}
\n