Skip to content

Latest commit

 

History

History
1565 lines (916 loc) · 98.5 KB

CHANGELOG.md

File metadata and controls

1565 lines (916 loc) · 98.5 KB

Change Log

3.7.2

Patch Changes

3.7.1

Patch Changes

  • #3751 b8538d8 Thanks @dimaMachina! - replace deprecated navigator.platform with navigator.userAgent

    fix placeholder ⌘ K in doc explorer search input for non mac devices, replace by Ctrl K

  • Updated dependencies [b8538d8]:

3.7.0

Minor Changes

  • #3619 9aef83a Thanks @Yahkob! - add new prop defaultTheme to set the default color preference theme

Patch Changes

  • #3441 959ed21 Thanks @cimdalli! - fix: set query editor to defaultQuery while adding a new tab or GraphiQL's default query

    # Welcome to GraphiQL
#
# GraphiQL is an in-browser tool for writing, validating, and
# testing GraphQL queries.

...

  • Updated dependencies [959ed21, 9aef83a]:

3.6.0

Minor Changes

Patch Changes

3.5.0

Minor Changes

Patch Changes

3.4.1

Patch Changes

3.4.0

Minor Changes

  • #3643 82f1ecc Thanks @dimaMachina! - add className prop. Additional class names which will be appended to the GraphiQL container element

Patch Changes

3.3.2

Patch Changes

3.3.1

Patch Changes

3.3.0

Minor Changes

  • #3407 115c1c02 Thanks @TuvalSimha! - Add a new prop to GraphiQL component: forcedTheme to force the theme and hide the theme switcher.

3.2.3

Patch Changes

3.2.2

Patch Changes

3.2.1

Patch Changes

3.2.0

Minor Changes

Patch Changes

3.1.2

Patch Changes

3.1.1

Patch Changes

3.1.0

Minor Changes

3.0.10

Patch Changes

3.0.9

Patch Changes

3.0.8

Patch Changes

3.0.7

Patch Changes

3.0.6

Patch Changes

3.0.5

Patch Changes

  • #3371 2348641c Thanks @acao! - Solves #2825, an old bug where new tabs were created on every refresh

    the bug occurred when:

    1. shouldPersistHeaders is not set to true
    2. headers or defaultHeaders are provided as props
    3. the user refreshes the browser

  • Updated dependencies [2348641c]:

3.0.4

Patch Changes

3.0.3

Patch Changes

3.0.2

Patch Changes

3.0.1

Patch Changes

3.0.0

Major Changes

Patch Changes

3.0.0-alpha.1

Patch Changes

3.0.0-alpha.0

Major Changes

Patch Changes

2.4.7

Patch Changes

2.4.6

Patch Changes

2.4.5

Patch Changes

2.4.4

Patch Changes

2.4.3

Patch Changes

2.4.2

Patch Changes

2.4.1

Patch Changes

2.4.0

Minor Changes

  • #3012 65f5176a Thanks @benjie! - GraphiQL now maintains the DocExplorer navigation stack as best it can when the schema is updated

Patch Changes

2.3.0

Minor Changes

Patch Changes

2.2.0

Minor Changes

Patch Changes

2.1.0

Minor Changes

Patch Changes

2.0.13

Patch Changes

2.0.12

Patch Changes

2.0.11

Patch Changes

2.0.10

Patch Changes

2.0.9

Patch Changes

2.0.8

Patch Changes

2.0.7

Patch Changes

2.0.6

Patch Changes

2.0.5

Patch Changes

2.0.4

Patch Changes

  • #2745 92a17490 Thanks @acao! - Specify MIT license for @graphiql/plugin-explorer package.json

2.0.3

Patch Changes

  • #2715 c922719e Thanks @thomasheyenbrock! - Add the contents of graphql and @graphiql/react as static properties to the GraphiQL component in CDN bundles so that these modules can be reused from plugin CDN bundles.

2.0.2

Patch Changes

2.0.1

Patch Changes

2.0.0

Major Changes

  • #2694 e59ec32e Thanks @acao! - BREAKING: The GraphiQL component does no longer set a property g on the window object.
  • #2694 e59ec32e Thanks @acao! - BREAKING: Implement a new design for the GraphiQL UI. This changes both DOM structure and class names. We consider this a breaking change as custom GraphQL IDEs built on top of GraphiQL relied on these internals, e.g. overriding styles using certain class names.
  • #2694 e59ec32e Thanks @acao! - BREAKING: The following static properties of the GraphiQL component have been removed:
    • GraphiQL.formatResult: You can use the function formatResult from @graphiql/toolkit instead.
    • GraphiQL.formatError: You can use the function formatError from @graphiql/toolkit instead.
    • GraphiQL.QueryEditor: You can use the QueryEditor component from @graphiql/react instead.
    • GraphiQL.VariableEditor: You can use the VariableEditor component from @graphiql/react instead.
    • GraphiQL.HeaderEditor: You can use the HeaderEditor component from @graphiql/react instead.
    • GraphiQL.ResultViewer: You can use the ResponseEditor component from @graphiql/react instead.
    • GraphiQL.Button: You can use the ToolbarButton component from @graphiql/react instead.
    • GraphiQL.ToolbarButton: This exposed the same component as GraphiQL.Button.
    • GraphiQL.Menu: You can use the ToolbarMenu component from @graphiql/react instead.
    • GraphiQL.MenuItem: You can use the ToolbarMenu.Item component from @graphiql/react instead.
    • GraphiQL.Group: Grouping multiple buttons side-by-side is not provided out-of-the box anymore in the new GraphiQL UI. If you want to implement a similar feature in the new vertical toolbar you can do so by adding your own styles for your custom toolbar elements. Example: 
      import { GraphiQL } from 'graphiql';
function CustomGraphiQL() {
  return (
    <GraphiQL>
      <GraphiQL.Toolbar>
        {/* Add custom styles for your buttons using the given class */}
        <div className="button-group">
          <button>1</button>
          <button>2</button>
          <button>3</button>
        </div>
      </GraphiQL.Toolbar>
    </GraphiQL>
  );
}
  • #2694 e59ec32e Thanks @acao! - BREAKING: The following exports of the graphiql package have been removed:
    • DocExplorer: Now exported from @graphiql/react as DocExplorer
      • The schema prop has been removed, the component now uses the schema provided by the ExplorerContext
    • fillLeafs: Now exported from @graphiql/toolkit as fillLeafs
    • getSelectedOperationName: Now exported from @graphiql/toolkit as getSelectedOperationName
    • mergeAst: Now exported from @graphiql/toolkit as mergeAst
    • onHasCompletion: Now exported from @graphiql/react as onHasCompletion
    • QueryEditor: Now exported from @graphiql/react as QueryEditor
    • ToolbarMenu: Now exported from @graphiql/react as ToolbarMenu
    • ToolbarMenuItem: Now exported from @graphiql/react as ToolbarMenu.Item
    • ToolbarSelect: Now exported from @graphiql/react as ToolbarListbox
    • ToolbarSelectOption: Now exported from @graphiql/react as ToolbarListbox.Option
    • VariableEditor: Now exported from @graphiql/react as VariableEditor
    • type Fetcher: Now exported from @graphiql/toolkit
    • type FetcherOpts: Now exported from @graphiql/toolkit
    • type FetcherParams: Now exported from @graphiql/toolkit
    • type FetcherResult: Now exported from @graphiql/toolkit
    • type FetcherReturnType: Now exported from @graphiql/toolkit
    • type Observable: Now exported from @graphiql/toolkit
    • type Storage: Now exported from @graphiql/toolkit
    • type SyncFetcherResult: Now exported from @graphiql/toolkit
  • #2694 e59ec32e Thanks @acao! - BREAKING: The GraphiQL component has been refactored to be a function component. Attaching a ref to this component will no longer provide access to props, state or class methods. In order to interact with or change GraphiQL state you need to use the contexts and hooks provided by the @graphiql/react package. More details and examples can be found in the migration guide.
  • #2694 e59ec32e Thanks @acao! - BREAKING: The following props of the GraphiQL component have been changed:
    • The props defaultVariableEditorOpen and defaultSecondaryEditorOpen have been merged into one prop defaultEditorToolsVisibility. The default behavior if this prop is not passed is that the editor tools are shown if at least one of the secondary editors has contents. You can pass the following values to the prop:
      • Passing false hides the editor tools.
      • Passing true shows the editor tools.
      • Passing "variables" explicitly shows the variables editor.
      • Passing "headers" explicitly shows the headers editor.
    • The props docExplorerOpen, onToggleDocs and onToggleHistory have been removed. They are replaced by the more generic props visiblePlugin (for controlling which plugin is visible) and onTogglePluginVisibility (which is called each time the visibility of any plugin changes).
    • The headerEditorEnabled prop has been renamed to isHeadersEditorEnabled.
    • The ResultsTooltip prop has been renamed to responseTooltip.
    • Tabs are now always enabled. The tabs prop has therefore been replaced with a prop onTabChange. If you used the tabs prop before to pass this function you can change your implementation like so: 
      <GraphiQL
-  tabs={{ onTabChange: (tabState) => {/* do something */} }}
+  onTabChange={(tabState) => {/* do something */}}
/>

Minor Changes

  • #2694 e59ec32e Thanks @acao! - GraphiQL now ships with a dark theme. By default the interface respects the system settings, the theme can also be explicitly chosen via the new settings dialog.

Patch Changes

1.11.6

Patch Changes

1.11.5

Patch Changes

1.11.4

Patch Changes

1.11.3

Patch Changes

1.11.2

Patch Changes

1.11.1

Patch Changes

1.11.0

Minor Changes

Patch Changes

1.10.0

Minor Changes

Patch Changes

1.9.13

Patch Changes

1.9.12

Patch Changes

1.9.11

Patch Changes

1.9.10

Patch Changes

1.9.9

Patch Changes

1.9.8

Patch Changes

1.9.7

Patch Changes

1.9.6

Patch Changes

1.9.5

Patch Changes

  • #2454 a53bec64 Thanks @thomasheyenbrock! - Deprecate the public methods getQueryEditor, getVariableEditor, getHeaderEditor, and refresh on the GraphiQL class.

1.9.4

Patch Changes

  • #2435 89f0244f Thanks @thomasheyenbrock! - Move the logic for deriving operation facts from the current query to @graphiql/react and store these facts as properties on the query editor instance
  • #2436 3e5295f0 Thanks @thomasheyenbrock! - Inline logic for clicking a reference to open the docs and remove the onClickReference and onHintInformationRender props of the editor components and hooks

1.9.3

Patch Changes

  • #2419 84d8985b Thanks @thomasheyenbrock! - Move the fillLeafs utility function from graphiql into @graphiql/toolkit and deprecate the export from graphiql
  • #2413 8be164b1 Thanks @thomasheyenbrock! - Add a StorageContext and a HistoryContext to @graphiql/react that replaces the logic in the graphiql package
  • #2419 84d8985b Thanks @thomasheyenbrock! - Move the mergeAst utility function from graphiql into @graphiql/toolkit and deprecate the export from graphiql
  • #2420 3467cd33 Thanks @thomasheyenbrock! - Deprecate the autoCompleteLeafs method of the GraphiQL component in favor of the function provided by the EditorContext from @graphiql/react
  • #2420 3467cd33 Thanks @thomasheyenbrock! - Add a SchemaContext to @graphiql/react that replaces the logic for fetching and validating the schema in the graphiql package

1.9.2

Patch Changes

1.9.1

Patch Changes

1.9.0

Minor Changes

  • #2409 f2025ba0 Thanks @thomasheyenbrock! - Move the logic of the variable editor from the graphiql package into a hook useVariableEditor provided by @graphiql/react
  • #2408 d825bb75 Thanks @thomasheyenbrock! - Move the logic of the query editor from the graphiql package into a hook useQueryEditor provided by @graphiql/react
  • #2411 ad448693 Thanks @thomasheyenbrock! - Move the logic of the result viewer from the graphiql package into a hook useResponseEditor provided by @graphiql/react
  • #2370 7f695b10 Thanks @thomasheyenbrock! - Include the context provider for the explorer from @graphiql/react and replace the local state for the nav stack of the docs with methods provided by hooks from @graphiql/react.
  • #2404 029ddf82 Thanks @thomasheyenbrock! - Add a context provider for editors and move the logic of the headers editor from the graphiql package into a hook useHeaderEditor provided by @graphiql/react

Patch Changes

1.8.10

Patch Changes

1.8.9

Patch Changes

  • #2388 d3ae074c Thanks @benjie! - Add 'pointer-events: none' to SVG style for dropdown arrow in GraphiQL.Menu component

1.8.8

Patch Changes

1.8.7

Patch Changes

1.8.6

Patch Changes

1.8.5

Patch Changes

1.8.4

Patch Changes

1.8.3

Patch Changes

  • #2265 9458e10b Thanks @acao! - fix codemirror import bug for onHasCompletion for #2263. for esm/cjs users on autocomplete (umd bundle users not impacted)

1.8.2

Patch Changes

1.8.1

Patch Changes

  • #2257 6cc95851 Thanks @acao! - security fix: replace the vulnerable dset dependency with set-value

    dset is vulnerable to prototype pollution attacks. this is only possible if you are doing all of the following:

    1. running graphiql with an experimental graphql-js release tag that supports @stream and @defer
    2. executing a properly @streamed or @deferred query ala IncrementalDelivery spec, with multipart chunks
    3. consuming a malicious schema that contains field names like proto, prototype, or constructor that return malicious data designed to exploit a prototype pollution attack

1.8.0

Minor Changes

  • #2197 3137a6c4 Thanks @n1ru4l! - Now featuring: tabs! 🥳 🍾 just opt-in with new prop <GraphiQL tabs />. You can also both opt-in and provide a handler via <GraphiQL tabs={{ onTabsChange }} />!

Patch Changes

  • #2249 1540fd3d Thanks @acao! - Finally remove inline require() for codemirror addon imports, replace with modern dynamic import() (which enables esbuild, vite, etc).

    This change should allow your bundler to code split codemirror-graphql and the codemirror addons based on which you import. For SSR support, GraphiQL must load these modules dynamically.

    If you want to use other codemirror addons (vim, etc) for non-ssr you can just import them top level, or for SSR, you can just dynamically import them.

1.7.2

Patch Changes

1.7.1

Patch Changes

1.7.0

Minor Changes

Patch Changes

  • #2205 91500d4e Thanks @francisu! - Fixed problem where 'global' variable is referenced when it might not be present (#2155)

1.6.0

Minor Changes

  • #2191 eb8af7b5 Thanks @n1ru4l! - Allow inserting content before the topBar element via the beforeTopBarContent property.

    <GraphiQL beforeTopBarContent={<SomeComponent />} />
  • #2189 96d47267 Thanks @n1ru4l! - Apply variable editor title text styles via class variable-editor-title-text instead of using inline-styles. This allows better customization of styles. An active element also has the class active. This allows overriding the inactive state color using the selector .graphiql-container .variable-editor-title-text and overriding the active state color using the selector .graphiql-container .variable-editor-title-text.active.

  • #2190 d5179899 Thanks @n1ru4l! - New callback property onSchemaChange for GraphiQL.

    The callback is invoked with the successfully fetched schema from the remote.

    Usage example:

    <GraphiQL onSchemaChange={schema => console.log(schema)} />

1.5.20

Patch Changes

1.5.19

Patch Changes

1.5.18

Patch Changes

  • #2156 ae5ea77b Thanks @francisu! - Fixed problem where 'global' variable is referenced when it might not be present (#2155)

1.5.17

Patch Changes

1.5.16

Patch Changes

1.5.15

Patch Changes

1.5.14

Patch Changes

1.5.13

Patch Changes

1.5.12

Patch Changes

1.5.11

Patch Changes

1.5.10

Patch Changes

  • #2087 45a9075d Thanks @acao! - Fix issue with introspection in servers which don't support inputValueDeprecation. make inputValueDeprecation an opt-in prop for DocExplorer features

1.5.9

Patch Changes

  • #2077 701ca13f Thanks @acao! - Include schema description in DocExplorer for schema introspection requests. Enables the schemaDescription option for getIntrospectionQuery(). Also includes deprecationReason support in DocExplorer for arguments! Enables inputValueDeprecation in getIntrospectionQuery() and displays deprecation section on field doc view.
  • Updated dependencies [9df315b4]:

1.5.8

Patch Changes

1.5.7

Patch Changes

1.5.6

Patch Changes

1.5.5

Patch Changes

1.5.4

Patch Changes

1.5.3

Patch Changes

1.5.2

Patch Changes

1.5.1

Patch Changes

1.5.0

Minor Changes

Patch Changes

1.4.8

Patch Changes

1.4.7

Patch Changes

1.4.6

Patch Changes

  • afaa36c1 #1883 Thanks @Sweetabix1! - Updating font colors for line numbers, comments & brackets from #999 to #666 for accessibility purposes. #666 passes AA accessibility standards for small text, with a contrast ratio of over 5:1.

1.4.5

Patch Changes

1.4.4

Patch Changes

1.4.3

Patch Changes

  • 6a459f4c #1968 Thanks @acao! - Remove optionalDependencies entirely, remove subscriptions-transport-ws which introduces vulnerabilities, upgrade @n1ru4l/push-pull-async-iterable-iterator to 3.0.0, upgrade graphql-ws several minor versions - the [email protected] upgrade will come in a later minor release.
  • eb2d91fa #1914 Thanks @harshithpabbati! - fix: history can now be saved even when query history panel is not opened feat: create a new maxHistoryLength prop to allow more than 20 queries in history panel

1.4.2

Patch Changes

1.4.1

Patch Changes

  • dd9397e4 #1819 Thanks @acao! - GraphiQL.createClient() accepts custom legacyClient, exports typescript types, fixes #1800.

    createGraphiQLFetcher now only attempts an graphql-ws connection when only subscriptionUrl is provided. In order to use graphql-transport-ws, you'll need to provide the legacyClient option only, and no subscriptionUrl or wsClient option.

  • 1f92d1dc #1804 Thanks @maraisr! - Fixes issue where with IncrementalDelivery directives objects wouldn't deep-merge.

1.4.0

Patch Changes

1.4.0

Bugfixes

  • Fixes the search icon misalignment. (#1776) by @iifawzi
  • run onToggleDocs when setting docExplorerOpen to false (#1768) by @ChiragKasat

Minor Changes

  • 1c119386: @defer, @stream, and graphql-ws support in a createGraphiQLFetcher utility (#1770)

    • support for @defer and @stream in GraphiQL itself on fetcher execution and when handling stream payloads
    • introduce @graphiql/toolkit for types and utilities used to compose GraphiQL and other related libraries
    • introduce @graphiql/create-fetcher to accept simplified parameters to generate a fetcher that covers the most commonly used graphql-over-http transport spec proposals. using meros for multipart http, and graphql-ws for websockets subscriptions.
    • use graphql and graphql-express experimental-defer-stream branch in development until it's merged
    • add cypress e2e tests for @stream in different scenarios
    • add some unit tests for createGraphiQLFetcher

Patch Changes

1.3.2 (2021-01-07)

Note: Version bump only for package graphiql

1.3.1 (2021-01-07)

Note: Version bump only for package graphiql

1.3.0 (2021-01-07)

Features

1.2.2 (2021-01-03)

Note: Version bump only for package graphiql

1.2.1 (2020-12-28)

Bug Fixes

  • display schema description if available (050c506)
  • fix linting issue (7117b7c)

1.2.0 (2020-12-08)

Features

1.1.0 (2020-11-28)

Bug Fixes

  • improve props in GraphiQL readme (b9b2c8d)

Features

  • graphiql: add prop for adding toolbar content while preserving the default buttons (ea81056)
  • deeper fragment merging (238d0b5)

1.0.6 (2020-10-20)

Bug Fixes

  • enable variable editor when header editor is not enabled (#1682) (205fbad)

1.0.5 (2020-09-18)

Note: Version bump only for package graphiql

1.0.4 (2020-09-11)

Bug Fixes

  • don't use initial query on every re-render (#1663) (5aa890f)

1.0.3 (2020-06-24)

Bug Fixes

  • headers tab - highlighting and schema fetch (#1593) (0d050ca)

1.0.2 (2020-06-19)

Note: Version bump only for package graphiql

1.0.1 (2020-06-17)

Bug Fixes

1.0.0 (2020-06-11)

Bug Fixes

  • call debounce statements as they are functions (#1571) (8541250)
  • fix server side rendering by using type only codemirror import (#1573) (1ee60a6), closes #118
  • Move all componentWillUnMount functionality to respective events (#1544) (046b09f)

1.0.0-alpha.13 (2020-06-04)

Note: Version bump only for package graphiql

1.0.0-alpha.12 (2020-06-04)

Bug Fixes

  • cleanup cache entry from lerna publish (4a26218)
  • display variable editor when headers are not enabled (ce7b2e2)

1.0.0-alpha.11 (2020-05-28)

Bug Fixes

Features

1.0.0-alpha.10 (2020-05-19)

Bug Fixes

1.0.0-alpha.9 (2020-05-17)

Bug Fixes

  • remove problematic file resolution module from webpack sco… (#1489) (8dab038)

Features

1.0.0-alpha.8 (2020-04-10)

Note: Version bump only for package graphiql

1.0.0-alpha.7 (2020-04-10)

Note: Version bump only for package graphiql

1.0.0-alpha.6 (2020-04-10)

Note: Version bump only for package graphiql

1.0.0-alpha.5 (2020-04-06)

Features

1.0.0-alpha.4 (2020-04-03)

Bug Fixes

  • fix query argument missing from onEditQuery call (#1440) (6c335a8)

1.0.0-alpha.3 (2020-03-20)

Note: Version bump only for package graphiql

1.0.0-alpha.2 (2020-03-20)

Bug Fixes

1.0.0-alpha.1 (2020-01-18)

Bug Fixes

Features

BREAKING CHANGES

  • Deprecate support for React 15. Please use React 16.8 or greater for hooks support. Co-authored-by: @ryan-m-walker, @acao Reviewed-by: @benjie

0.17.5 (2019-12-09)

Note: Version bump only for package graphiql

0.17.4 (2019-12-09)

Bug Fixes

  • graphiql babel test ignore paths (e1588d9)

0.17.3 (2019-12-09)

Bug Fixes

  • express-graphql version (e9848b0)
  • test output, webpack resolution, clean build (3b1c2c1)

0.17.2 (2019-12-03)

Bug Fixes

  • ensure css files move with babel dist (ca95547)
  • remove css from downstream components. soon to be replaced w styled (e765543)

0.17.1 (2019-12-03)

Bug Fixes

0.17.0 (2019-11-26)

Bug Fixes

  • security bump, resolves #1004, SNYK-JS-MARKDOWNIT-459438 (89c83db)
  • webpack resolutions for #882, add webpack example (ea9df3e)

Features

  • graphiql: Prettify also formats query variables (b7d0bfd)

0.16.0 (2019-10-19)

Bug Fixes

  • accessibility: improve accessibility of all components (#967) (73a3f90)
  • css: added minimum width for result panel in GraphiQL (#980) (0c8b7ad)
  • graphiql: better quota management (#764) (7efed6c)

Features

0.15.1 (2019-10-04)

Bug Fixes

0.15.0 (2019-10-04)

Bug Fixes

  • check window is defined before using it (#962) (e4866ad)
  • graphiql: prettify keybinding bug for Firefox. Fixes #905 (fdf98ba)
  • check this.editor exist before this.editor.off in QueryEditor (#669) (ca226ee), closes #665
  • extraKeys bugfix window regression (f3d0427)
  • preserve ctrl-f key for macOS (7c381f9)

Features

0.13.2 (2019-06-21)

0.14.3 (2019-09-01)

Bug Fixes

  • check this.editor exist before this.editor.off in QueryEditor (#669) (ca226ee), closes #665
  • extraKeys bugfix window regression (f3d0427)
  • preserve ctrl-f key for macOS (7c381f9)
  • remove newline (19f5d1d)

0.13.2 (2019-06-21)

0.13.2 (2019-06-21)