next-graphql-react

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.

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.

Patch

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

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.

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.

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.

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.

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.

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.

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.

Major

• Updated Node.js support to ^12.0.0 || >= 13.7.0.
• Stopped supporting Internet Explorer.
• Updated the graphql-react peer dependency to ^13.0.0.
• Updated the react peer dependency to 16.14 - 17.
• Use the new React JSX runtime.
• Reorganized file structure. Deep import paths beginning with next-graphql-react/universal must be updated to next-graphql-react/public.
• The withGraphQLApp higher order function has changed:
  • It’s been renamed withGraphQLReact.
  • It now automatically sets the context required for the new graphql-react v13 API.
  • It now uses async/await instead of Promise chains.
  • The React class component it returns has been refactored to a functional component using React hooks.
• Published modules now contain JSDoc comments, which might affect TypeScript projects.

Minor

• Allow React component displayName to be removed in production builds.

Patch

• Updated dev dependencies.
• Removed the redundant object-assign dependency.
• Removed Babel and related dependencies and config.
• Refactored experimental syntax to what is supported for the Browserslist query.
• Restructured tests to mirror the published file structure.
• Updated the package description.
• Updated a Next.js docs link URL.
• Internal JSDoc tweaks.
• Readme edits, including:
  • Updated the “Setup” section.
  • Updated the “Support” section.

Patch

• Updated dependencies.
• Removed redundant dev dependencies.
• Stop using hard-rejection to detect unhandled Promise rejections in tests, as Node.js v15+ does this natively.
• Tweaked the v8.0.3 changelog entry.
• Always use regex u mode.
• Use the Next.js JS API instead of the CLI to start Next.js in tests, fixing Next.js start detection in tests broken since Next.js v10.0.6-canary.8.
• Asynchronously create test fixture files.
• Fixed incorrect console output indentation following certain test failures.
• Added tests for SSR GraphQL response Link header forwarding to the client.
• Fixed errors that can happen during a Next.js build or SSR due to unparsable Link headers.
• Internal JSDoc tweaks.
• Updated GitHub Actions CI config:
  • Updated actions/checkout to v2.
  • Updated actions/setup-node to v2.
  • Don’t specify the CI environment variable as it’s set by default.

Patch

• Updated the next peer dependency to 9.0.3 - 10.
• Updated the react peer dependency to 16.8 - 17.
• Updated dependencies.
• Moved disposable-directory to dev dependencies.
• Also run GitHub Actions with Node.js v15.
• Fixed a test hanging in Node.js v15.

Patch

• Updated dependencies.
• Updated the graphql-react peer dependency to 11 - 12.

Patch

• Updated dependencies.
• Derive fixture dependency versions from dev dependency versions.
• No longer separately build ESM and CJS to simplify package scripts, Babel and ESLint config.
• Use require instead of dynamic import in withGraphQLApp source, as since v7.0.0 the module is only published as CJS.
• Removed unnecessary .js file extensions from require paths.
• Simplified the GitHub Actions CI config with the npm install-test command.
• Clearly documented ways to import and require the package exports.
• Removed npm-debug.log from the .gitignore file as npm v4.2.0+ doesn’t create it in the current working directory.

Major

• Updated supported Node.js versions to ^10.17.0 || ^12.0.0 || >= 13.7.0.
• Added integration tests. These use modern Node.js APIs, increasing the minimum supported Node.js version.

Patch

• Updated dependencies.
• Stop testing with Node.js v13.
• Added missing file extensions to dynamic imports from Next.js.
• Removed documentation relating to polyfilling Promise and fetch, as they are automatically polyfilled by recent versions of Next.js.
• Updated the .editorconfig file.

Patch

• Corrected the package description to match the current API.
• Updated JSDoc code examples:
  • Prettier formatting.
  • Import React in examples containing JSX.

Major

• Added a package exports field to support native ESM in Node.js.
• Some source and published files are now .js (CJS) instead of .mjs (ESM), so undocumented deep imports may no longer work. This approach avoids the dual package hazard.
• Updated Node.js support from v10+ to 10 - 12 || >= 13.7 to reflect the package exports related breaking changes.
• Updated the graphql-react peer dependency to ^11.0.0.
• Removed withGraphQLConfig; withGraphQLApp now uses dynamic import to only load certain dependencies in a server environment.

Patch

• Updated dependencies.
• Removed the @babel/plugin-proposal-object-rest-spread and babel-plugin-transform-replace-object-assign dev dependencies and simplified Babel config.
• Improved the package prepare:prettier and test:prettier scripts.
• Reordered the package test:eslint script args for consistency with test:prettier.
• Configured Prettier option semi to the default, true.
• Lint fixes for prettier v2.
• Reorder Babel config fields.
• Ensure GitHub Actions run on pull request.
• Also run GitHub Actions with Node.js v14.
• Support Next.js static HTML export, fixing #4.

Patch

• Updated dev dependencies.
• Fixed a bug relating to ESM/CJS interoperability and default imports.

Major

• Updated Node.js support from v8.10+ to v10+.
• Updated dev dependencies, some of which now require Node.js v10+.

Patch

• Updated dependencies.
• Removed the now redundant eslint-plugin-import-order-alphabetical dev dependency.
• Stop using husky and lint-staged.
• Use strict mode for scripts.
• Fixed page getInitialProps not working when withGraphQLApp decorates an app that doesn’t have getInitialProps.