Version 16.0.0

Major

• Updated Node.js support to ^18.17.0 || >=20.4.0.
• Updated dev dependencies, some of which require newer Node.js versions than previously supported.
• Use the Node.js test runner API and remove the dev dependency test-director.
• Refactored tests to no longer polyfill the standard AbortController, AbortSignal, Event, EventTarget, and performance APIs available in modern Node.js and removed the dev dependencies abort-controller and event-target-shim.

Patch

• Updated the next peer dependency to 12 - 14, fixing #7.
• Updated dependencies.
• Updated the package.json field repository to conform to new npm requirements.
• Integrated the ESLint plugin eslint-plugin-optimal-modules.
• Updated GitHub Actions CI config:
  • The workflow still triggers on push, but no longer on pull request.
  • The workflow can now be manually triggered.
  • Run tests with Node.js v18, v20, v21.
  • Updated actions/checkout to v4.
  • Updated actions/setup-node to v4.
• Improved the types for test fixture Next.js config.
• For the function withGraphQLReact tests:
  • Temporarily disabled the tests for Node.js v18 due to the Node.js test runner bug nodejs/node#48845 that will be fixed in a future Node.js v18 release.
  • Use the new Puppeteer headless mode.
  • For the client side page load test:
    • Attempt to wait until the JS has loaded and the React app has mounted before clicking the navigation link.
    • Simulate fast 3G network conditions to ensure GraphQL query loading state can render and be asserted.
  • Migrated use of the deprecated Next.js CLI next export to the new Next.js static export API.
  • Removed an apparently no longer necessary workaround that forced the process to exit after tests; older Next.js used to stay running after closing it’s server.
• Fixed bugs in the test helper function startNext.
• Added tests for the internal function cjsDefaultImport.
• Updated link URLs in the readme.

Version 15.0.2

Patch

• Use a new internal helper function cjsDefaultImport to normalize the default import value from the CJS module next/app.js that has a default property, preserving the type for the various ways TypeScript may be configured.

Version 15.0.1

Patch

• Updated the next peer dependency to 12 - 13.
• Updated dev dependencies.
• Fixed a link in the v14.0.0 changelog entry.

Version 15.0.0

Major

• Updated the graphql-react peer dependency to ^20.0.0.
• Updated the react-waterfall-render dependency to v5.

Patch

• Updated dev dependencies.
• Use the node: URL scheme for Node.js builtin module imports in tests.
• Migrated from the Node.js builtin module fs to node:fs/promises in tests.
• Replaced the test helper function fsPathRemove with the function rm from the Node.js builtin module node:fs/promises.
• Tweaked the readme.

Version 14.0.0

Major

• Updated the graphql-react peer dependency to ^19.0.0.
• Updated the react and react-dom peer dependencies to ^18.0.0.
• Updated react-dom/server imports to suit React v18.

Patch

• Updated dependencies.
• Removed the now redundant not IE > 0 from the Browserslist query.
• Use the TypeScript type for Next.js config in test fixtures.
• Revamped the readme:
  • Removed the badges.
  • Better installation instructions that don’t assume the Next.js custom app module has a .js file extension.
  • Added information about TypeScript config and optimal JavaScript module design.

Version 13.0.0

Major

• Updated Node.js support to ^14.17.0 || ^16.0.0 || >= 18.0.0.
• Updated the graphql-react peer dependency to ^18.0.0.
• Updated dependencies.
• Implemented TypeScript types via JSDoc comments.

Patch

• Simplified dev dependencies and config for ESLint.
• Removed the jsdoc-md dev dependency and the package docs-update and docs-check scripts, replacing the readme “API” section with a manually written “Exports” section.
• Check TypeScript types via a new package types script.
• Support Next.js page response Link header array values.
• Use React.createElement instead of the the new React JSX runtime in tests.
• Updated GitHub Actions CI config:
  • Run tests with Node.js v14, v16, v18.
  • Updated actions/checkout to v3.
  • Updated actions/setup-node to v3.
• Use the .mjs file extension for Next.js pages in test fixtures.
• Removed the readme section “Examples”.
• Fixed a readme typo.
• Added a license.md MIT License file.

Version 12.0.0

Major

• Updated Node.js support to ^12.22.0 || ^14.17.0 || >= 16.0.0.
• Updated the graphql-react peer dependency to ^16.0.0.
• Updated the next peer dependency to ^12.0.0.
• Updated dependencies, some of which require newer Node.js versions than previously supported.
• Public modules are now individually listed in the package files and exports fields.
• Removed ./package from the package exports field; the full package.json filename must be used in a require path.
• Removed the package main index module; deep imports must be used.
• Shortened public module deep import paths, removing the /public/.
• The API is now ESM in .mjs files instead of CJS in .js files, accessible via import but not require.
• Switched back to using React.createElement instead of the the new React JSX runtime.

Patch

• Also run GitHub Actions CI with Node.js v17.
• Removed the redundant graphql dev dependency.
• Simplified package scripts.
• Reorganized the test file structure.
• Workaround Next.js not gracefully closing in tests.
• Removed a redundant prepare step that’s a no-op in current Next.js versions when programmatically starting Next.js in tests.
• Fixed an internal JSDoc type.
• Configured Prettier option singleQuote to the default, false.

Version 11.0.0

Major

• Updated the next peer dependency to 9.5 - 11.
• Removed Head.rewind() within the function withGraphQLReact, as it was made a noop in Next.js v9.5 and was removed in Next.js v11.

Patch

• Updated dev dependencies.
• Added the eslint-config-next dev dependency for next v11.

Version 10.0.1

Patch

• Updated the graphql-react peer dependency to 14 - 15.
• Updated dev dependencies.
• Renamed imports in the test index module.
• Use improved static fixtures instead of creating fixtures each test run, removing the disposable-directory and install-from dev dependencies.
• Use the NEXT_TELEMETRY_DISABLED environment variable to disable Next.js telemetry for tests.
• Amended the changelog entries for v3.0.1, v3.0.2, v7.0.0, v8.0.1, v9.0.0, and v10.0.0.
• Documentation tweaks.

Version 10.0.0

Major

• Updated Node.js support to ^12.20 || >= 14.13.
• Updated the graphql-react peer dependency to ^14.0.0.
• Updated dependencies, some of which require newer Node.js versions than were previously supported.
• Replaced the the package.json exports field public subpath folder mapping (deprecated by Node.js) with a subpath pattern. Deep require paths within next-graphql-react/public/ must now include the .js file extension.
• The tests are now ESM in .mjs files instead of CJS in .js files.

Minor

• Added a package sideEffects field.

Patch

• Updated GitHub Actions CI config to run tests with Node.js v12, v14, v16.
• Simplified JSDoc related package scripts now that jsdoc-md v10+ automatically generates a Prettier formatted readme.
• Added a package test:jsdoc script that checks the readme API docs are up to date with the source JSDoc.
• Use the .js file extension in internal require paths.
• Updated the example Next.js app URL in the readme.
• Documentation tweaks.
• The file changelog.md is no longer published.