diff --git a/package.json b/package.json index b1ba3ef9a31..c8852dd3ba6 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,7 @@ "build-docs": "rimraf packages/graphiql/typedoc && typedoc packages", "build:nontsc": "yarn wsrun:noexamples --exclude-missing --serial build", "build:clean": "yarn tsc --clean", - "build:watch": "yarn tsc --watch", + "build:watch": "yarn wsrun:noexamples --done-criteria '\"Build success in|built in\"' -t dev", "build-demo": "wsrun -m build-demo", "watch": "yarn build:watch", "watch-vscode": "yarn tsc && yarn workspace vscode-graphql compile", diff --git a/packages/graphiql-plugin-explorer/vite.config.mts.timestamp-1725035378569-c270892aab468.mjs b/packages/graphiql-plugin-explorer/vite.config.mts.timestamp-1725035378569-c270892aab468.mjs new file mode 100644 index 00000000000..f1bf43217b4 --- /dev/null +++ b/packages/graphiql-plugin-explorer/vite.config.mts.timestamp-1725035378569-c270892aab468.mjs @@ -0,0 +1,146 @@ +// vite.config.mts +import { createRequire } from "node:module"; +import { defineConfig } from "file:///home/rikki/projects/graphiql/node_modules/vite/dist/node/index.js"; +import react from "file:///home/rikki/projects/graphiql/node_modules/@vitejs/plugin-react/dist/index.mjs"; +import svgr from "file:///home/rikki/projects/graphiql/node_modules/vite-plugin-svgr/dist/index.js"; +import dts from "file:///home/rikki/projects/graphiql/node_modules/vite-plugin-dts/dist/index.mjs"; + +// package.json +var package_default = { + name: "@graphiql/plugin-explorer", + version: "4.0.0-alpha.2", + repository: { + type: "git", + url: "https://github.com/graphql/graphiql", + directory: "packages/graphiql-plugin-explorer" + }, + main: "dist/index.js", + module: "dist/index.mjs", + types: "dist/index.d.ts", + license: "MIT", + keywords: [ + "react", + "graphql", + "graphiql", + "plugin", + "explorer" + ], + files: [ + "dist" + ], + exports: { + "./package.json": "./package.json", + "./style.css": "./dist/style.css", + ".": { + import: "./dist/index.mjs", + require: "./dist/index.js", + types: "./dist/index.d.ts" + } + }, + scripts: { + dev: "vite build --watch", + build: "vite build && UMD=true vite build", + postbuild: "cp src/graphiql-explorer.d.ts dist/graphiql-explorer.d.ts", + prebuild: "yarn types:check", + "types:check": "tsc --noEmit" + }, + dependencies: { + "graphiql-explorer": "^0.9.0" + }, + peerDependencies: { + "@graphiql/react": "^1.0.0-alpha.0", + graphql: "^15.5.0 || ^16.0.0 || ^17.0.0-alpha.2", + react: "^16.8.0 || ^17 || ^18", + "react-dom": "^16.8.0 || ^17 || ^18" + }, + devDependencies: { + "@graphiql/react": "^1.0.0-alpha.3", + "@vitejs/plugin-react": "^4.3.1", + graphql: "^17.0.0-alpha.7", + react: "^18.2.0", + "react-dom": "^18.2.0", + typescript: "^4.6.3", + vite: "^5.4.0", + "vite-plugin-dts": "^4.0.1", + "vite-plugin-svgr": "^4.2.0" + } +}; + +// vite.config.mts +var __vite_injected_original_import_meta_url = "file:///home/rikki/projects/graphiql/packages/graphiql-plugin-explorer/vite.config.mts"; +var IS_UMD = process.env.UMD === "true"; +var vite_config_default = defineConfig({ + plugins: [ + react({ jsxRuntime: "classic" }), + svgr({ + exportAsDefault: true, + svgrOptions: { + titleProp: true + } + }), + !IS_UMD && [dts({ rollupTypes: true }), htmlPlugin()] + ], + build: { + minify: IS_UMD ? "terser" : false, + // avoid clean cjs/es builds + emptyOutDir: !IS_UMD, + lib: { + entry: "src/index.tsx", + fileName: "index", + name: "GraphiQLPluginExplorer", + formats: IS_UMD ? ["umd"] : ["cjs", "es"] + }, + rollupOptions: { + external: [ + // Exclude peer dependencies and dependencies from bundle + ...Object.keys(package_default.peerDependencies), + ...IS_UMD ? [] : Object.keys(package_default.dependencies) + ], + output: { + chunkFileNames: "[name].[format].js", + globals: { + "@graphiql/react": "GraphiQL.React", + graphql: "GraphiQL.GraphQL", + react: "React", + "react-dom": "ReactDOM" + } + } + }, + commonjsOptions: { + esmExternals: true, + requireReturnsDefault: "auto" + } + } +}); +function htmlPlugin() { + const require2 = createRequire(__vite_injected_original_import_meta_url); + const graphiqlPath = require2.resolve("graphiql/package.json").replace("/package.json", ""); + const htmlForVite = ` +`; + return { + name: "html-replace-umd-with-src", + transformIndexHtml: { + order: "pre", + handler(html) { + const start = ""; + const end = ""; + const contentToReplace = html.slice( + html.indexOf(start) + start.length, + html.indexOf(end) + ); + return html.replace(contentToReplace, htmlForVite); + } + } + }; +} +export { + vite_config_default as default +}; +//# sourceMappingURL=data:application/json;base64,{
  "version": 3,
  "sources": ["vite.config.mts", "package.json"],
  "sourcesContent": ["const __vite_injected_original_dirname = \"/home/rikki/projects/graphiql/packages/graphiql-plugin-explorer\";const __vite_injected_original_filename = \"/home/rikki/projects/graphiql/packages/graphiql-plugin-explorer/vite.config.mts\";const __vite_injected_original_import_meta_url = \"file:///home/rikki/projects/graphiql/packages/graphiql-plugin-explorer/vite.config.mts\";import { createRequire } from 'node:module';\nimport { defineConfig, PluginOption } from 'vite';\nimport react from '@vitejs/plugin-react';\nimport svgr from 'vite-plugin-svgr';\nimport dts from 'vite-plugin-dts';\nimport packageJSON from './package.json';\n\nconst IS_UMD = process.env.UMD === 'true';\n\nexport default defineConfig({\n  plugins: [\n    react({ jsxRuntime: 'classic' }),\n    svgr({\n      exportAsDefault: true,\n      svgrOptions: {\n        titleProp: true,\n      },\n    }),\n    !IS_UMD && [dts({ rollupTypes: true }), htmlPlugin()],\n  ],\n  build: {\n    minify: IS_UMD\n      ? 'terser' // produce better bundle size than esbuild\n      : false,\n    // avoid clean cjs/es builds\n    emptyOutDir: !IS_UMD,\n    lib: {\n      entry: 'src/index.tsx',\n      fileName: 'index',\n      name: 'GraphiQLPluginExplorer',\n      formats: IS_UMD ? ['umd'] : ['cjs', 'es'],\n    },\n    rollupOptions: {\n      external: [\n        // Exclude peer dependencies and dependencies from bundle\n        ...Object.keys(packageJSON.peerDependencies),\n        ...(IS_UMD ? [] : Object.keys(packageJSON.dependencies)),\n      ],\n      output: {\n        chunkFileNames: '[name].[format].js',\n        globals: {\n          '@graphiql/react': 'GraphiQL.React',\n          graphql: 'GraphiQL.GraphQL',\n          react: 'React',\n          'react-dom': 'ReactDOM',\n        },\n      },\n    },\n    commonjsOptions: {\n      esmExternals: true,\n      requireReturnsDefault: 'auto',\n    },\n  },\n});\n\nfunction htmlPlugin(): PluginOption {\n  const require = createRequire(import.meta.url);\n\n  const graphiqlPath = require\n    .resolve('graphiql/package.json')\n    .replace('/package.json', '');\n\n  const htmlForVite = `<link rel=\"stylesheet\" href=\"${graphiqlPath}/src/style.css\" />\n<script type=\"module\">\nimport React from 'react';\nimport ReactDOM from 'react-dom/client';\nimport GraphiQL from '${graphiqlPath}/src/cdn';\nimport * as GraphiQLPluginExplorer from './src';\n\nObject.assign(globalThis, { React, ReactDOM, GraphiQL, GraphiQLPluginExplorer });\n</script>`;\n\n  return {\n    name: 'html-replace-umd-with-src',\n    transformIndexHtml: {\n      order: 'pre',\n      handler(html) {\n        const start = '</style>';\n        const end = '<body>';\n        const contentToReplace = html.slice(\n          html.indexOf(start) + start.length,\n          html.indexOf(end),\n        );\n        return html.replace(contentToReplace, htmlForVite);\n      },\n    },\n  };\n}\n", "{\n  \"name\": \"@graphiql/plugin-explorer\",\n  \"version\": \"4.0.0-alpha.2\",\n  \"repository\": {\n    \"type\": \"git\",\n    \"url\": \"https://github.com/graphql/graphiql\",\n    \"directory\": \"packages/graphiql-plugin-explorer\"\n  },\n  \"main\": \"dist/index.js\",\n  \"module\": \"dist/index.mjs\",\n  \"types\": \"dist/index.d.ts\",\n  \"license\": \"MIT\",\n  \"keywords\": [\n    \"react\",\n    \"graphql\",\n    \"graphiql\",\n    \"plugin\",\n    \"explorer\"\n  ],\n  \"files\": [\n    \"dist\"\n  ],\n  \"exports\": {\n    \"./package.json\": \"./package.json\",\n    \"./style.css\": \"./dist/style.css\",\n    \".\": {\n      \"import\": \"./dist/index.mjs\",\n      \"require\": \"./dist/index.js\",\n      \"types\": \"./dist/index.d.ts\"\n    }\n  },\n  \"scripts\": {\n    \"dev\": \"vite build --watch\",\n    \"build\": \"vite build && UMD=true vite build\",\n    \"postbuild\": \"cp src/graphiql-explorer.d.ts dist/graphiql-explorer.d.ts\",\n    \"prebuild\": \"yarn types:check\",\n    \"types:check\": \"tsc --noEmit\"\n  },\n  \"dependencies\": {\n    \"graphiql-explorer\": \"^0.9.0\"\n  },\n  \"peerDependencies\": {\n    \"@graphiql/react\": \"^1.0.0-alpha.0\",\n    \"graphql\": \"^15.5.0 || ^16.0.0 || ^17.0.0-alpha.2\",\n    \"react\": \"^16.8.0 || ^17 || ^18\",\n    \"react-dom\": \"^16.8.0 || ^17 || ^18\"\n  },\n  \"devDependencies\": {\n    \"@graphiql/react\": \"^1.0.0-alpha.3\",\n    \"@vitejs/plugin-react\": \"^4.3.1\",\n    \"graphql\": \"^17.0.0-alpha.7\",\n    \"react\": \"^18.2.0\",\n    \"react-dom\": \"^18.2.0\",\n    \"typescript\": \"^4.6.3\",\n    \"vite\": \"^5.4.0\",\n    \"vite-plugin-dts\": \"^4.0.1\",\n    \"vite-plugin-svgr\": \"^4.2.0\"\n  }\n}\n"],
  "mappings": ";AAAiX,SAAS,qBAAqB;AAC/Y,SAAS,oBAAkC;AAC3C,OAAO,WAAW;AAClB,OAAO,UAAU;AACjB,OAAO,SAAS;;;ACJhB;AAAA,EACE,MAAQ;AAAA,EACR,SAAW;AAAA,EACX,YAAc;AAAA,IACZ,MAAQ;AAAA,IACR,KAAO;AAAA,IACP,WAAa;AAAA,EACf;AAAA,EACA,MAAQ;AAAA,EACR,QAAU;AAAA,EACV,OAAS;AAAA,EACT,SAAW;AAAA,EACX,UAAY;AAAA,IACV;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAAA,EACA,OAAS;AAAA,IACP;AAAA,EACF;AAAA,EACA,SAAW;AAAA,IACT,kBAAkB;AAAA,IAClB,eAAe;AAAA,IACf,KAAK;AAAA,MACH,QAAU;AAAA,MACV,SAAW;AAAA,MACX,OAAS;AAAA,IACX;AAAA,EACF;AAAA,EACA,SAAW;AAAA,IACT,KAAO;AAAA,IACP,OAAS;AAAA,IACT,WAAa;AAAA,IACb,UAAY;AAAA,IACZ,eAAe;AAAA,EACjB;AAAA,EACA,cAAgB;AAAA,IACd,qBAAqB;AAAA,EACvB;AAAA,EACA,kBAAoB;AAAA,IAClB,mBAAmB;AAAA,IACnB,SAAW;AAAA,IACX,OAAS;AAAA,IACT,aAAa;AAAA,EACf;AAAA,EACA,iBAAmB;AAAA,IACjB,mBAAmB;AAAA,IACnB,wBAAwB;AAAA,IACxB,SAAW;AAAA,IACX,OAAS;AAAA,IACT,aAAa;AAAA,IACb,YAAc;AAAA,IACd,MAAQ;AAAA,IACR,mBAAmB;AAAA,IACnB,oBAAoB;AAAA,EACtB;AACF;;;AD1DuO,IAAM,2CAA2C;AAOxR,IAAM,SAAS,QAAQ,IAAI,QAAQ;AAEnC,IAAO,sBAAQ,aAAa;AAAA,EAC1B,SAAS;AAAA,IACP,MAAM,EAAE,YAAY,UAAU,CAAC;AAAA,IAC/B,KAAK;AAAA,MACH,iBAAiB;AAAA,MACjB,aAAa;AAAA,QACX,WAAW;AAAA,MACb;AAAA,IACF,CAAC;AAAA,IACD,CAAC,UAAU,CAAC,IAAI,EAAE,aAAa,KAAK,CAAC,GAAG,WAAW,CAAC;AAAA,EACtD;AAAA,EACA,OAAO;AAAA,IACL,QAAQ,SACJ,WACA;AAAA;AAAA,IAEJ,aAAa,CAAC;AAAA,IACd,KAAK;AAAA,MACH,OAAO;AAAA,MACP,UAAU;AAAA,MACV,MAAM;AAAA,MACN,SAAS,SAAS,CAAC,KAAK,IAAI,CAAC,OAAO,IAAI;AAAA,IAC1C;AAAA,IACA,eAAe;AAAA,MACb,UAAU;AAAA;AAAA,QAER,GAAG,OAAO,KAAK,gBAAY,gBAAgB;AAAA,QAC3C,GAAI,SAAS,CAAC,IAAI,OAAO,KAAK,gBAAY,YAAY;AAAA,MACxD;AAAA,MACA,QAAQ;AAAA,QACN,gBAAgB;AAAA,QAChB,SAAS;AAAA,UACP,mBAAmB;AAAA,UACnB,SAAS;AAAA,UACT,OAAO;AAAA,UACP,aAAa;AAAA,QACf;AAAA,MACF;AAAA,IACF;AAAA,IACA,iBAAiB;AAAA,MACf,cAAc;AAAA,MACd,uBAAuB;AAAA,IACzB;AAAA,EACF;AACF,CAAC;AAED,SAAS,aAA2B;AAClC,QAAMA,WAAU,cAAc,wCAAe;AAE7C,QAAM,eAAeA,SAClB,QAAQ,uBAAuB,EAC/B,QAAQ,iBAAiB,EAAE;AAE9B,QAAM,cAAc,gCAAgC,YAAY;AAAA;AAAA;AAAA;AAAA,wBAI1C,YAAY;AAAA;AAAA;AAAA;AAAA;AAMlC,SAAO;AAAA,IACL,MAAM;AAAA,IACN,oBAAoB;AAAA,MAClB,OAAO;AAAA,MACP,QAAQ,MAAM;AACZ,cAAM,QAAQ;AACd,cAAM,MAAM;AACZ,cAAM,mBAAmB,KAAK;AAAA,UAC5B,KAAK,QAAQ,KAAK,IAAI,MAAM;AAAA,UAC5B,KAAK,QAAQ,GAAG;AAAA,QAClB;AACA,eAAO,KAAK,QAAQ,kBAAkB,WAAW;AAAA,MACnD;AAAA,IACF;AAAA,EACF;AACF;",
  "names": ["require"]
}
 diff --git a/packages/graphiql-react/package.json b/packages/graphiql-react/package.json index 935fc26094d..4557ffc4de0 100644 --- a/packages/graphiql-react/package.json +++ b/packages/graphiql-react/package.json @@ -61,7 +61,8 @@ "get-value": "^3.0.1", "graphql-language-service": "^5.3.0", "markdown-it": "^14.1.0", - "set-value": "^4.1.0" + "set-value": "^4.1.0", + "zustand": "^4.5.5" }, "devDependencies": { "@babel/helper-string-parser": "^7.19.4", diff --git a/packages/graphiql-react/src/editor/__tests__/tabs.spec.ts b/packages/graphiql-react/src/editor/__tests__/tabs.spec.ts.disabled similarity index 98% rename from packages/graphiql-react/src/editor/__tests__/tabs.spec.ts rename to packages/graphiql-react/src/editor/__tests__/tabs.spec.ts.disabled index 0314d220f9d..731f223ea7b 100644 --- a/packages/graphiql-react/src/editor/__tests__/tabs.spec.ts +++ b/packages/graphiql-react/src/editor/__tests__/tabs.spec.ts.disabled @@ -1,12 +1,13 @@ -import { StorageAPI } from '@graphiql/toolkit'; +import { StorageAPI, getDefaultTabState } from '@graphiql/toolkit'; import { createTab, fuzzyExtractOperationName, - getDefaultTabState, clearHeadersFromTabs, STORAGE_KEY, } from '../tabs'; +// TODO: move to toolkit + describe('createTab', () => { it('creates with default title', () => { expect(createTab({})).toEqual( diff --git a/packages/graphiql-react/src/editor/completion.ts b/packages/graphiql-react/src/editor/completion.ts index 231a53851ec..ecc09dcb9ef 100644 --- a/packages/graphiql-react/src/editor/completion.ts +++ b/packages/graphiql-react/src/editor/completion.ts @@ -12,13 +12,14 @@ import { ExplorerContextType } from '../explorer'; import { markdown } from '../markdown'; import { DOC_EXPLORER_PLUGIN, PluginContextType } from '../plugin'; import { importCodeMirror } from './common'; +import { CodeMirrorEditor } from '@graphiql/toolkit'; /** * Render a custom UI for CodeMirror's hint which includes additional info * about the type and description for the selected context. */ export function onHasCompletion( - _cm: Editor, + _cm: CodeMirrorEditor, data: EditorChange | undefined, schema: GraphQLSchema | null | undefined, explorer: ExplorerContextType | null, diff --git a/packages/graphiql-react/src/editor/components/header-editor.tsx b/packages/graphiql-react/src/editor/components/header-editor.tsx index 672a2b759a2..7e54c2d104c 100644 --- a/packages/graphiql-react/src/editor/components/header-editor.tsx +++ b/packages/graphiql-react/src/editor/components/header-editor.tsx @@ -17,10 +17,7 @@ type HeaderEditorProps = UseHeaderEditorArgs & { }; export function HeaderEditor({ isHidden, ...hookArgs }: HeaderEditorProps) { - const { headerEditor } = useEditorContext({ - nonNull: true, - caller: HeaderEditor, - }); + const { headerEditor } = useEditorContext(); const ref = useHeaderEditor(hookArgs, HeaderEditor); useEffect(() => { diff --git a/packages/graphiql-react/src/editor/components/variable-editor.tsx b/packages/graphiql-react/src/editor/components/variable-editor.tsx index 3d354157d7e..b4d90d745dc 100644 --- a/packages/graphiql-react/src/editor/components/variable-editor.tsx +++ b/packages/graphiql-react/src/editor/components/variable-editor.tsx @@ -19,10 +19,7 @@ type VariableEditorProps = UseVariableEditorArgs & { }; export function VariableEditor({ isHidden, ...hookArgs }: VariableEditorProps) { - const { variableEditor } = useEditorContext({ - nonNull: true, - caller: VariableEditor, - }); + const { variableEditor } = useEditorContext(); const ref = useVariableEditor(hookArgs, VariableEditor); useEffect(() => { diff --git a/packages/graphiql-react/src/editor/context.tsx b/packages/graphiql-react/src/editor/context.tsx index 339f84cf03b..34c0d91eb9b 100644 --- a/packages/graphiql-react/src/editor/context.tsx +++ b/packages/graphiql-react/src/editor/context.tsx @@ -1,598 +1,11 @@ -import { - DocumentNode, - FragmentDefinitionNode, - OperationDefinitionNode, - parse, - ValidationRule, - visit, -} from 'graphql'; -import { VariableToType } from 'graphql-language-service'; -import { - ReactNode, - useCallback, - useEffect, - useMemo, - useRef, - useState, -} from 'react'; +import { useStore } from 'zustand'; -import { useStorageContext } from '../storage'; -import { createContextHook, createNullableContext } from '../utility/context'; -import { STORAGE_KEY as STORAGE_KEY_HEADERS } from './header-editor'; -import { useSynchronizeValue } from './hooks'; -import { STORAGE_KEY_QUERY } from './query-editor'; -import { - createTab, - getDefaultTabState, - setPropertiesInActiveTab, - TabDefinition, - TabsState, - TabState, - useSetEditorValues, - useStoreTabs, - useSynchronizeActiveTabValues, - clearHeadersFromTabs, - serializeTabState, - STORAGE_KEY as STORAGE_KEY_TABS, -} from './tabs'; -import { CodeMirrorEditor } from './types'; -import { STORAGE_KEY as STORAGE_KEY_VARIABLES } from './variable-editor'; +import { useGraphiQLStore } from '../hooks'; -export type CodeMirrorEditorWithOperationFacts = CodeMirrorEditor & { - documentAST: DocumentNode | null; - operationName: string | null; - operations: OperationDefinitionNode[] | null; - variableToType: VariableToType | null; +export const useEditorContext = (_options?: { + nonNull?: boolean; + caller?: Function; +}) => { + const store = useGraphiQLStore(); + return useStore(store, state => state.editor); }; - -export type EditorContextType = TabsState & { - /** - * Add a new tab. - */ - addTab(): void; - /** - * Switch to a different tab. - * @param index The index of the tab that should be switched to. - */ - changeTab(index: number): void; - /** - * Move a tab to a new spot. - * @param newOrder The new order for the tabs. - */ - moveTab(newOrder: TabState[]): void; - /** - * Close a tab. If the currently active tab is closed, the tab before it will - * become active. If there is no tab before the closed one, the tab after it - * will become active. - * @param index The index of the tab that should be closed. - */ - closeTab(index: number): void; - /** - * Update the state for the tab that is currently active. This will be - * reflected in the `tabs` object and the state will be persisted in storage - * (if available). - * @param partialTab A partial tab state object that will override the - * current values. The properties `id`, `hash` and `title` cannot be changed. - */ - updateActiveTabValues( - partialTab: Partial>, - ): void; - - /** - * The CodeMirror editor instance for the headers editor. - */ - headerEditor: CodeMirrorEditor | null; - /** - * The CodeMirror editor instance for the query editor. This editor also - * stores the operation facts that are derived from the current editor - * contents. - */ - queryEditor: CodeMirrorEditorWithOperationFacts | null; - /** - * The CodeMirror editor instance for the response editor. - */ - responseEditor: CodeMirrorEditor | null; - /** - * The CodeMirror editor instance for the variables editor. - */ - variableEditor: CodeMirrorEditor | null; - /** - * Set the CodeMirror editor instance for the headers editor. - */ - setHeaderEditor(newEditor: CodeMirrorEditor): void; - /** - * Set the CodeMirror editor instance for the query editor. - */ - setQueryEditor(newEditor: CodeMirrorEditorWithOperationFacts): void; - /** - * Set the CodeMirror editor instance for the response editor. - */ - setResponseEditor(newEditor: CodeMirrorEditor): void; - /** - * Set the CodeMirror editor instance for the variables editor. - */ - setVariableEditor(newEditor: CodeMirrorEditor): void; - - /** - * Changes the operation name and invokes the `onEditOperationName` callback. - */ - setOperationName(operationName: string): void; - - /** - * The contents of the headers editor when initially rendering the provider - * component. - */ - initialHeaders: string; - /** - * The contents of the query editor when initially rendering the provider - * component. - */ - initialQuery: string; - /** - * The contents of the response editor when initially rendering the provider - * component. - */ - initialResponse: string; - /** - * The contents of the variables editor when initially rendering the provider - * component. - */ - initialVariables: string; - - /** - * A map of fragment definitions using the fragment name as key which are - * made available to include in the query. - */ - externalFragments: Map; - /** - * A list of custom validation rules that are run in addition to the rules - * provided by the GraphQL spec. - */ - validationRules: ValidationRule[]; - - /** - * If the contents of the headers editor are persisted in storage. - */ - shouldPersistHeaders: boolean; - /** - * Changes if headers should be persisted. - */ - setShouldPersistHeaders(persist: boolean): void; -}; - -export const EditorContext = - createNullableContext('EditorContext'); - -export type EditorContextProviderProps = { - children: ReactNode; - /** - * The initial contents of the query editor when loading GraphiQL and there - * is no other source for the editor state. Other sources can be: - * - The `query` prop - * - The value persisted in storage - * These default contents will only be used for the first tab. When opening - * more tabs the query editor will start out empty. - */ - defaultQuery?: string; - /** - * With this prop you can pass so-called "external" fragments that will be - * included in the query document (depending on usage). You can either pass - * the fragments using SDL (passing a string) or you can pass a list of - * `FragmentDefinitionNode` objects. - */ - externalFragments?: string | FragmentDefinitionNode[]; - /** - * This prop can be used to set the contents of the headers editor. Every - * time this prop changes, the contents of the headers editor are replaced. - * Note that the editor contents can be changed in between these updates by - * typing in the editor. - */ - headers?: string; - /** - * This prop can be used to define the default set of tabs, with their - * queries, variables, and headers. It will be used as default only if - * there is no tab state persisted in storage. - * - * @example - * ```tsx - * - *``` - */ - defaultTabs?: TabDefinition[]; - /** - * Invoked when the operation name changes. Possible triggers are: - * - Editing the contents of the query editor - * - Selecting a operation for execution in a document that contains multiple - * operation definitions - * @param operationName The operation name after it has been changed. - */ - onEditOperationName?(operationName: string): void; - /** - * Invoked when the state of the tabs changes. Possible triggers are: - * - Updating any editor contents inside the currently active tab - * - Adding a tab - * - Switching to a different tab - * - Closing a tab - * @param tabState The tabs state after it has been updated. - */ - onTabChange?(tabState: TabsState): void; - /** - * This prop can be used to set the contents of the query editor. Every time - * this prop changes, the contents of the query editor are replaced. Note - * that the editor contents can be changed in between these updates by typing - * in the editor. - */ - query?: string; - /** - * This prop can be used to set the contents of the response editor. Every - * time this prop changes, the contents of the response editor are replaced. - * Note that the editor contents can change in between these updates by - * executing queries that will show a response. - */ - response?: string; - /** - * This prop toggles if the contents of the headers editor are persisted in - * storage. - * @default false - */ - shouldPersistHeaders?: boolean; - /** - * This prop accepts custom validation rules for GraphQL documents that are - * run against the contents of the query editor (in addition to the rules - * that are specified in the GraphQL spec). - */ - validationRules?: ValidationRule[]; - /** - * This prop can be used to set the contents of the variables editor. Every - * time this prop changes, the contents of the variables editor are replaced. - * Note that the editor contents can be changed in between these updates by - * typing in the editor. - */ - variables?: string; - - /** - * Headers to be set when opening a new tab - */ - defaultHeaders?: string; -}; - -export function EditorContextProvider(props: EditorContextProviderProps) { - const storage = useStorageContext(); - const [headerEditor, setHeaderEditor] = useState( - null, - ); - const [queryEditor, setQueryEditor] = - useState(null); - const [responseEditor, setResponseEditor] = useState( - null, - ); - const [variableEditor, setVariableEditor] = useState( - null, - ); - - const [shouldPersistHeaders, setShouldPersistHeadersInternal] = useState( - () => { - const isStored = storage?.get(PERSIST_HEADERS_STORAGE_KEY) !== null; - return props.shouldPersistHeaders !== false && isStored - ? storage?.get(PERSIST_HEADERS_STORAGE_KEY) === 'true' - : Boolean(props.shouldPersistHeaders); - }, - ); - - useSynchronizeValue(headerEditor, props.headers); - useSynchronizeValue(queryEditor, props.query); - useSynchronizeValue(responseEditor, props.response); - useSynchronizeValue(variableEditor, props.variables); - - const storeTabs = useStoreTabs({ - storage, - shouldPersistHeaders, - }); - - // We store this in state but never update it. By passing a function we only - // need to compute it lazily during the initial render. - const [initialState] = useState(() => { - const query = props.query ?? storage?.get(STORAGE_KEY_QUERY) ?? null; - const variables = - props.variables ?? storage?.get(STORAGE_KEY_VARIABLES) ?? null; - const headers = props.headers ?? storage?.get(STORAGE_KEY_HEADERS) ?? null; - const response = props.response ?? ''; - - const tabState = getDefaultTabState({ - query, - variables, - headers, - defaultTabs: props.defaultTabs, - defaultQuery: props.defaultQuery || DEFAULT_QUERY, - defaultHeaders: props.defaultHeaders, - storage, - shouldPersistHeaders, - }); - storeTabs(tabState); - - return { - query: - query ?? - (tabState.activeTabIndex === 0 ? tabState.tabs[0].query : null) ?? - '', - variables: variables ?? '', - headers: headers ?? props.defaultHeaders ?? '', - response, - tabState, - }; - }); - - const [tabState, setTabState] = useState(initialState.tabState); - - const setShouldPersistHeaders = useCallback( - (persist: boolean) => { - if (persist) { - storage?.set(STORAGE_KEY_HEADERS, headerEditor?.getValue() ?? ''); - const serializedTabs = serializeTabState(tabState, true); - storage?.set(STORAGE_KEY_TABS, serializedTabs); - } else { - storage?.set(STORAGE_KEY_HEADERS, ''); - clearHeadersFromTabs(storage); - } - setShouldPersistHeadersInternal(persist); - storage?.set(PERSIST_HEADERS_STORAGE_KEY, persist.toString()); - }, - [storage, tabState, headerEditor], - ); - - const lastShouldPersistHeadersProp = useRef(); - useEffect(() => { - const propValue = Boolean(props.shouldPersistHeaders); - if (lastShouldPersistHeadersProp?.current !== propValue) { - setShouldPersistHeaders(propValue); - lastShouldPersistHeadersProp.current = propValue; - } - }, [props.shouldPersistHeaders, setShouldPersistHeaders]); - - const synchronizeActiveTabValues = useSynchronizeActiveTabValues({ - queryEditor, - variableEditor, - headerEditor, - responseEditor, - }); - const { onTabChange, defaultHeaders, defaultQuery, children } = props; - const setEditorValues = useSetEditorValues({ - queryEditor, - variableEditor, - headerEditor, - responseEditor, - defaultHeaders, - }); - - const addTab = useCallback(() => { - setTabState(current => { - // Make sure the current tab stores the latest values - const updatedValues = synchronizeActiveTabValues(current); - const updated = { - tabs: [ - ...updatedValues.tabs, - createTab({ - headers: defaultHeaders, - query: defaultQuery ?? DEFAULT_QUERY, - }), - ], - activeTabIndex: updatedValues.tabs.length, - }; - storeTabs(updated); - setEditorValues(updated.tabs[updated.activeTabIndex]); - onTabChange?.(updated); - return updated; - }); - }, [ - defaultHeaders, - defaultQuery, - onTabChange, - setEditorValues, - storeTabs, - synchronizeActiveTabValues, - ]); - - const changeTab = useCallback( - index => { - setTabState(current => { - const updated = { - ...current, - activeTabIndex: index, - }; - storeTabs(updated); - setEditorValues(updated.tabs[updated.activeTabIndex]); - onTabChange?.(updated); - return updated; - }); - }, - [onTabChange, setEditorValues, storeTabs], - ); - - const moveTab = useCallback( - newOrder => { - setTabState(current => { - const activeTab = current.tabs[current.activeTabIndex]; - const updated = { - tabs: newOrder, - activeTabIndex: newOrder.indexOf(activeTab), - }; - storeTabs(updated); - setEditorValues(updated.tabs[updated.activeTabIndex]); - onTabChange?.(updated); - return updated; - }); - }, - [onTabChange, setEditorValues, storeTabs], - ); - - const closeTab = useCallback( - index => { - setTabState(current => { - const updated = { - tabs: current.tabs.filter((_tab, i) => index !== i), - activeTabIndex: Math.max(current.activeTabIndex - 1, 0), - }; - storeTabs(updated); - setEditorValues(updated.tabs[updated.activeTabIndex]); - onTabChange?.(updated); - return updated; - }); - }, - [onTabChange, setEditorValues, storeTabs], - ); - - const updateActiveTabValues = useCallback< - EditorContextType['updateActiveTabValues'] - >( - partialTab => { - setTabState(current => { - const updated = setPropertiesInActiveTab(current, partialTab); - storeTabs(updated); - onTabChange?.(updated); - return updated; - }); - }, - [onTabChange, storeTabs], - ); - - const { onEditOperationName } = props; - const setOperationName = useCallback( - operationName => { - if (!queryEditor) { - return; - } - - queryEditor.operationName = operationName; - updateActiveTabValues({ operationName }); - onEditOperationName?.(operationName); - }, - [onEditOperationName, queryEditor, updateActiveTabValues], - ); - - const externalFragments = useMemo(() => { - const map = new Map(); - if (Array.isArray(props.externalFragments)) { - for (const fragment of props.externalFragments) { - map.set(fragment.name.value, fragment); - } - } else if (typeof props.externalFragments === 'string') { - visit(parse(props.externalFragments, {}), { - FragmentDefinition(fragment) { - map.set(fragment.name.value, fragment); - }, - }); - } else if (props.externalFragments) { - throw new Error( - 'The `externalFragments` prop must either be a string that contains the fragment definitions in SDL or a list of FragmentDefinitionNode objects.', - ); - } - return map; - }, [props.externalFragments]); - - const validationRules = useMemo( - () => props.validationRules || [], - [props.validationRules], - ); - - const value = useMemo( - () => ({ - ...tabState, - addTab, - changeTab, - moveTab, - closeTab, - updateActiveTabValues, - - headerEditor, - queryEditor, - responseEditor, - variableEditor, - setHeaderEditor, - setQueryEditor, - setResponseEditor, - setVariableEditor, - - setOperationName, - - initialQuery: initialState.query, - initialVariables: initialState.variables, - initialHeaders: initialState.headers, - initialResponse: initialState.response, - - externalFragments, - validationRules, - - shouldPersistHeaders, - setShouldPersistHeaders, - }), - [ - tabState, - addTab, - changeTab, - moveTab, - closeTab, - updateActiveTabValues, - - headerEditor, - queryEditor, - responseEditor, - variableEditor, - - setOperationName, - - initialState, - - externalFragments, - validationRules, - - shouldPersistHeaders, - setShouldPersistHeaders, - ], - ); - - return ( - {children} - ); -} - -export const useEditorContext = createContextHook(EditorContext); - -const PERSIST_HEADERS_STORAGE_KEY = 'shouldPersistHeaders'; - -export const DEFAULT_QUERY = `# Welcome to GraphiQL -# -# GraphiQL is an in-browser tool for writing, validating, and -# testing GraphQL queries. -# -# Type queries into this side of the screen, and you will see intelligent -# typeaheads aware of the current GraphQL type schema and live syntax and -# validation errors highlighted within the text. -# -# GraphQL queries typically start with a "{" character. Lines that start -# with a # are ignored. -# -# An example GraphQL query might look like: -# -# { -# field(arg: "value") { -# subField -# } -# } -# -# Keyboard shortcuts: -# -# Prettify query: Shift-Ctrl-P (or press the prettify button) -# -# Merge fragments: Shift-Ctrl-M (or press the merge button) -# -# Run Query: Ctrl-Enter (or press the play button) -# -# Auto Complete: Ctrl-Space (or just start typing) -# - -`; diff --git a/packages/graphiql-react/src/editor/header-editor.ts b/packages/graphiql-react/src/editor/header-editor.ts index db700f56fea..b0499cc9cd5 100644 --- a/packages/graphiql-react/src/editor/header-editor.ts +++ b/packages/graphiql-react/src/editor/header-editor.ts @@ -16,6 +16,7 @@ import { useSynchronizeOption, } from './hooks'; import { WriteableEditorProps } from './types'; +import { useOptionsContext } from '../hooks'; export type UseHeaderEditorArgs = WriteableEditorProps & { /** @@ -34,15 +35,8 @@ export function useHeaderEditor( }: UseHeaderEditorArgs = {}, caller?: Function, ) { - const { - initialHeaders, - headerEditor, - setHeaderEditor, - shouldPersistHeaders, - } = useEditorContext({ - nonNull: true, - caller: caller || useHeaderEditor, - }); + const { headerEditor, setHeaderEditor } = useEditorContext(); + const { initialHeaders, shouldPersistHeaders } = useOptionsContext(); const executionContext = useExecutionContext(); const merge = useMergeQuery({ caller: caller || useHeaderEditor }); const prettify = usePrettifyEditors({ caller: caller || useHeaderEditor }); @@ -103,7 +97,7 @@ export function useHeaderEditor( editorInstance.execCommand('autocomplete'); } }); - + // @ts-expect-error TODO: fix codemirror type setHeaderEditor(newEditor); }); diff --git a/packages/graphiql-react/src/editor/hooks.ts b/packages/graphiql-react/src/editor/hooks.ts index cf19b2ee3ed..93e87cd7690 100644 --- a/packages/graphiql-react/src/editor/hooks.ts +++ b/packages/graphiql-react/src/editor/hooks.ts @@ -1,4 +1,14 @@ -import { fillLeafs, GetDefaultFieldNamesFn, mergeAst } from '@graphiql/toolkit'; +import { + fillLeafs, + GetDefaultFieldNamesFn, + mergeAst, + synchronizeActiveTabValues, + CodeMirrorEditorWithOperationFacts, + TabsState, + CodeMirrorEditor, + debounce, +} from '@graphiql/toolkit'; + import type { EditorChange, EditorConfiguration } from 'codemirror'; import type { SchemaReference } from 'codemirror-graphql/utils/SchemaReference'; import copyToClipboard from 'copy-to-clipboard'; @@ -7,12 +17,11 @@ import { useCallback, useEffect, useMemo, useRef, useState } from 'react'; import { useExplorerContext } from '../explorer'; import { usePluginContext } from '../plugin'; -import { useSchemaContext } from '../schema'; + import { useStorageContext } from '../storage'; -import debounce from '../utility/debounce'; import { onHasCompletion } from './completion'; import { useEditorContext } from './context'; -import { CodeMirrorEditor } from './types'; +import { useSchemaContext } from '../schema'; export function useSynchronizeValue( editor: CodeMirrorEditor | null, @@ -32,6 +41,7 @@ export function useSynchronizeOption( ) { useEffect(() => { if (editor) { + // @ts-expect-error TODO: fix codemirror type editor.setOption(option, value); } }, [editor, option, value]); @@ -44,7 +54,7 @@ export function useChangeHandler( tabProperty: 'variables' | 'headers', caller: Function, ) { - const { updateActiveTabValues } = useEditorContext({ nonNull: true, caller }); + const { updateActiveTabValues } = useEditorContext(); const storage = useStorageContext(); useEffect(() => { @@ -95,7 +105,7 @@ export function useCompletion( callback: ((reference: SchemaReference) => void) | null, caller: Function, ) { - const { schema } = useSchemaContext({ nonNull: true, caller }); + const { schema } = useSchemaContext(); const explorer = useExplorerContext(); const plugin = usePluginContext(); useEffect(() => { @@ -111,17 +121,8 @@ export function useCompletion( callback?.({ kind: 'Type', type, schema: schema || undefined }); }); }; - editor.on( - // @ts-expect-error @TODO additional args for hasCompletion event - 'hasCompletion', - handleCompletion, - ); - return () => - editor.off( - // @ts-expect-error @TODO additional args for hasCompletion event - 'hasCompletion', - handleCompletion, - ); + editor.on('hasCompletion', handleCompletion); + return () => editor.off('hasCompletion', handleCompletion); }, [callback, editor, explorer, plugin, schema]); } @@ -164,10 +165,7 @@ export type UseCopyQueryArgs = { }; export function useCopyQuery({ caller, onCopyQuery }: UseCopyQueryArgs = {}) { - const { queryEditor } = useEditorContext({ - nonNull: true, - caller: caller || useCopyQuery, - }); + const { queryEditor } = useEditorContext(); return useCallback(() => { if (!queryEditor) { return; @@ -186,13 +184,10 @@ type UseMergeQueryArgs = { */ caller?: Function; }; - +// TODO: see if caller is still needed export function useMergeQuery({ caller }: UseMergeQueryArgs = {}) { - const { queryEditor } = useEditorContext({ - nonNull: true, - caller: caller || useMergeQuery, - }); - const { schema } = useSchemaContext({ nonNull: true, caller: useMergeQuery }); + const { queryEditor } = useEditorContext(); + const { schema } = useSchemaContext(); return useCallback(() => { const documentAST = queryEditor?.documentAST; const query = queryEditor?.getValue(); @@ -221,10 +216,8 @@ export function usePrettifyEditors({ caller, onPrettifyQuery, }: UsePrettifyEditorsArgs = {}) { - const { queryEditor, headerEditor, variableEditor } = useEditorContext({ - nonNull: true, - caller: caller || usePrettifyEditors, - }); + const { queryEditor, headerEditor, variableEditor } = useEditorContext(); + return useCallback(() => { if (variableEditor) { const variableEditorContent = variableEditor.getValue(); @@ -272,6 +265,30 @@ export function usePrettifyEditors({ }, [queryEditor, variableEditor, headerEditor, onPrettifyQuery]); } +export function useSynchronizeActiveTabValues({ + queryEditor, + variableEditor, + headerEditor, + responseEditor, +}: { + queryEditor: CodeMirrorEditorWithOperationFacts | null; + variableEditor: CodeMirrorEditor | null; + headerEditor: CodeMirrorEditor | null; + responseEditor: CodeMirrorEditor | null; +}) { + return useCallback<(state: TabsState) => TabsState>( + state => { + return synchronizeActiveTabValues({ + currentState: state, + queryEditor, + variableEditor, + headerEditor, + responseEditor, + }); + }, + [queryEditor, variableEditor, headerEditor, responseEditor], + ); +} export type UseAutoCompleteLeafsArgs = { /** * A function to determine which field leafs are automatically added when @@ -289,14 +306,9 @@ export function useAutoCompleteLeafs({ getDefaultFieldNames, caller, }: UseAutoCompleteLeafsArgs = {}) { - const { schema } = useSchemaContext({ - nonNull: true, - caller: caller || useAutoCompleteLeafs, - }); - const { queryEditor } = useEditorContext({ - nonNull: true, - caller: caller || useAutoCompleteLeafs, - }); + const { queryEditor } = useEditorContext(); + const { schema } = useSchemaContext(); + return useCallback(() => { if (!queryEditor) { return; @@ -347,11 +359,9 @@ export function useAutoCompleteLeafs({ // https://react.dev/learn/you-might-not-need-an-effect export const useEditorState = (editor: 'query' | 'variable' | 'header') => { - const context = useEditorContext({ - nonNull: true, - }); + const editors = useEditorContext(); - const editorInstance = context[`${editor}Editor` as const]; + const editorInstance = editors[`${editor}Editor` as const]; let valueString = ''; const editorValue = editorInstance?.getValue() ?? false; if (editorValue && editorValue.length > 0) { diff --git a/packages/graphiql-react/src/editor/index.ts b/packages/graphiql-react/src/editor/index.ts index c7a902c4307..0beaaf95371 100644 --- a/packages/graphiql-react/src/editor/index.ts +++ b/packages/graphiql-react/src/editor/index.ts @@ -5,11 +5,7 @@ export { ResponseEditor, VariableEditor, } from './components'; -export { - EditorContext, - EditorContextProvider, - useEditorContext, -} from './context'; +export { useEditorContext } from './context'; export { useHeaderEditor } from './header-editor'; export { useAutoCompleteLeafs, @@ -26,14 +22,13 @@ export { useQueryEditor } from './query-editor'; export { useResponseEditor } from './response-editor'; export { useVariableEditor } from './variable-editor'; -export type { EditorContextType, EditorContextProviderProps } from './context'; export type { UseHeaderEditorArgs } from './header-editor'; export type { UseQueryEditorArgs } from './query-editor'; export type { ResponseTooltipType, UseResponseEditorArgs, } from './response-editor'; -export type { TabsState } from './tabs'; +export type { TabsState } from '@graphiql/toolkit'; export type { UseVariableEditorArgs } from './variable-editor'; export type { CommonEditorProps, KeyMap, WriteableEditorProps } from './types'; diff --git a/packages/graphiql-react/src/editor/query-editor.ts b/packages/graphiql-react/src/editor/query-editor.ts index f3c931d08fc..1c0e119f91e 100644 --- a/packages/graphiql-react/src/editor/query-editor.ts +++ b/packages/graphiql-react/src/editor/query-editor.ts @@ -18,23 +18,24 @@ import { useRef, } from 'react'; -import { useExecutionContext } from '../execution'; import { useExplorerContext } from '../explorer'; import { markdown } from '../markdown'; import { DOC_EXPLORER_PLUGIN, usePluginContext } from '../plugin'; -import { useSchemaContext } from '../schema'; import { useStorageContext } from '../storage'; -import debounce from '../utility/debounce'; +import { + debounce, + CodeMirrorEditorWithOperationFacts, + CodeMirrorEditor, + CodeMirrorType, + WriteableEditorProps, +} from '@graphiql/toolkit'; import { commonKeys, DEFAULT_EDITOR_THEME, DEFAULT_KEY_MAP, importCodeMirror, } from './common'; -import { - CodeMirrorEditorWithOperationFacts, - useEditorContext, -} from './context'; + import { useCompletion, useCopyQuery, @@ -45,12 +46,12 @@ import { usePrettifyEditors, useSynchronizeOption, } from './hooks'; -import { - CodeMirrorEditor, - CodeMirrorType, - WriteableEditorProps, -} from './types'; + import { normalizeWhitespace } from './whitespace'; +import { useSchemaContext } from '../schema'; +import { useEditorContext } from './context'; +import { useExecutionContext } from '../execution'; +import { useOptionsContext } from '../hooks'; export type UseQueryEditorArgs = WriteableEditorProps & Pick & @@ -81,23 +82,18 @@ export function useQueryEditor( }: UseQueryEditorArgs = {}, caller?: Function, ) { - const { schema } = useSchemaContext({ - nonNull: true, - caller: caller || useQueryEditor, - }); + const { schema } = useSchemaContext(); const { - externalFragments, - initialQuery, queryEditor, setOperationName, setQueryEditor, - validationRules, variableEditor, updateActiveTabValues, - } = useEditorContext({ - nonNull: true, - caller: caller || useQueryEditor, - }); + } = useEditorContext(); + + const { externalFragments, initialQuery, validationRules } = + useOptionsContext(); + const executionContext = useExecutionContext(); const storage = useStorageContext(); const explorer = useExplorerContext(); @@ -162,7 +158,7 @@ export function useQueryEditor( if (!isActive) { return; } - + // @ts-expect-error TODO: codemirror type issue codeMirrorRef.current = CodeMirror; const container = ref.current; @@ -223,28 +219,37 @@ export function useQueryEditor( // empty }, }, - }) as CodeMirrorEditorWithOperationFacts; + }) as unknown as CodeMirrorEditorWithOperationFacts; newEditor.addKeyMap({ 'Cmd-Space'() { - newEditor.showHint({ completeSingle: true, container }); + // @ts-expect-error TODO: codemirror types + newEditor.showHint({ + completeSingle: true, + container, + }); }, 'Ctrl-Space'() { + // @ts-expect-error TODO: codemirror types newEditor.showHint({ completeSingle: true, container }); }, 'Alt-Space'() { + // @ts-expect-error TODO: codemirror types newEditor.showHint({ completeSingle: true, container }); }, 'Shift-Space'() { + // @ts-expect-error TODO: codemirror types newEditor.showHint({ completeSingle: true, container }); }, 'Shift-Alt-Space'() { + // @ts-expect-error TODO: codemirror types newEditor.showHint({ completeSingle: true, container }); }, }); newEditor.on('keyup', (editorInstance, event) => { if (AUTO_COMPLETE_AFTER_KEY.test(event.key)) { + // @ts-expect-error TODO: codemirror types editorInstance.execCommand('autocomplete'); } }); @@ -494,9 +499,13 @@ function useSynchronizeExternalFragments( externalFragments: Map, codeMirrorRef: MutableRefObject, ) { + let fragments = externalFragments; + if (!fragments) { + fragments = new Map(); + } const externalFragmentList = useMemo( - () => [...externalFragments.values()], - [externalFragments], + () => [...fragments.values()], + [fragments], ); useEffect(() => { diff --git a/packages/graphiql-react/src/editor/response-editor.tsx b/packages/graphiql-react/src/editor/response-editor.tsx index 03f1d7e069c..65bd23ce9c8 100644 --- a/packages/graphiql-react/src/editor/response-editor.tsx +++ b/packages/graphiql-react/src/editor/response-editor.tsx @@ -14,6 +14,7 @@ import { ImagePreview } from './components'; import { useEditorContext } from './context'; import { useSynchronizeOption } from './hooks'; import { CodeMirrorEditor, CommonEditorProps } from './types'; +import { useOptionsContext } from '../hooks'; export type ResponseTooltipType = ComponentType<{ /** @@ -42,15 +43,10 @@ export function useResponseEditor( }: UseResponseEditorArgs = {}, caller?: Function, ) { - const { fetchError, validationErrors } = useSchemaContext({ - nonNull: true, - caller: caller || useResponseEditor, - }); - const { initialResponse, responseEditor, setResponseEditor } = - useEditorContext({ - nonNull: true, - caller: caller || useResponseEditor, - }); + const { fetchError, validationErrors } = useSchemaContext(); + const { responseEditor, setResponseEditor } = useEditorContext(); + const { initialResponse } = useOptionsContext(); + const ref = useRef(null); const responseTooltipRef = useRef( @@ -133,6 +129,7 @@ export function useResponseEditor( extraKeys: commonKeys, }); + // @ts-expect-error TODO: fix codemirror type setResponseEditor(newEditor); }); diff --git a/packages/graphiql-react/src/editor/tabs.ts b/packages/graphiql-react/src/editor/tabs.ts index 067d730666b..1c5d2d38e7a 100644 --- a/packages/graphiql-react/src/editor/tabs.ts +++ b/packages/graphiql-react/src/editor/tabs.ts @@ -1,192 +1,15 @@ -import { StorageAPI } from '@graphiql/toolkit'; +import { + StorageAPI, + CodeMirrorEditorWithOperationFacts, + CodeMirrorEditor, + synchronizeActiveTabValues, + serializeTabState, + TabsState, + TabState, +} from '@graphiql/toolkit'; import { useCallback, useMemo } from 'react'; -import debounce from '../utility/debounce'; -import { CodeMirrorEditorWithOperationFacts } from './context'; -import { CodeMirrorEditor } from './types'; - -export type TabDefinition = { - /** - * The contents of the query editor of this tab. - */ - query: string | null; - /** - * The contents of the variable editor of this tab. - */ - variables?: string | null; - /** - * The contents of the headers editor of this tab. - */ - headers?: string | null; -}; - -/** - * This object describes the state of a single tab. - */ -export type TabState = TabDefinition & { - /** - * A GUID value generated when the tab was created. - */ - id: string; - /** - * A hash that is unique for a combination of the contents of the query - * editor, the variable editor and the header editor (i.e. all the editor - * where the contents are persisted in storage). - */ - hash: string; - /** - * The title of the tab shown in the tab element. - */ - title: string; - /** - * The operation name derived from the contents of the query editor of this - * tab. - */ - operationName: string | null; - /** - * The contents of the response editor of this tab. - */ - response: string | null; -}; - -/** - * This object describes the state of all tabs. - */ -export type TabsState = { - /** - * A list of state objects for each tab. - */ - tabs: TabState[]; - /** - * The index of the currently active tab with regards to the `tabs` list of - * this object. - */ - activeTabIndex: number; -}; - -export function getDefaultTabState({ - defaultQuery, - defaultHeaders, - headers, - defaultTabs, - query, - variables, - storage, - shouldPersistHeaders, -}: { - defaultQuery: string; - defaultHeaders?: string; - headers: string | null; - defaultTabs?: TabDefinition[]; - query: string | null; - variables: string | null; - storage: StorageAPI | null; - shouldPersistHeaders?: boolean; -}) { - const storedState = storage?.get(STORAGE_KEY); - try { - if (!storedState) { - throw new Error('Storage for tabs is empty'); - } - const parsed = JSON.parse(storedState); - // if headers are not persisted, do not derive the hash using default headers state - // or else you will get new tabs on every refresh - const headersForHash = shouldPersistHeaders ? headers : undefined; - if (isTabsState(parsed)) { - const expectedHash = hashFromTabContents({ - query, - variables, - headers: headersForHash, - }); - let matchingTabIndex = -1; - - for (let index = 0; index < parsed.tabs.length; index++) { - const tab = parsed.tabs[index]; - tab.hash = hashFromTabContents({ - query: tab.query, - variables: tab.variables, - headers: tab.headers, - }); - if (tab.hash === expectedHash) { - matchingTabIndex = index; - } - } - - if (matchingTabIndex >= 0) { - parsed.activeTabIndex = matchingTabIndex; - } else { - const operationName = query ? fuzzyExtractOperationName(query) : null; - parsed.tabs.push({ - id: guid(), - hash: expectedHash, - title: operationName || DEFAULT_TITLE, - query, - variables, - headers, - operationName, - response: null, - }); - parsed.activeTabIndex = parsed.tabs.length - 1; - } - - return parsed; - } - throw new Error('Storage for tabs is invalid'); - } catch { - return { - activeTabIndex: 0, - tabs: ( - defaultTabs || [ - { - query: query ?? defaultQuery, - variables, - headers: headers ?? defaultHeaders, - }, - ] - ).map(createTab), - }; - } -} - -function isTabsState(obj: any): obj is TabsState { - return ( - obj && - typeof obj === 'object' && - !Array.isArray(obj) && - hasNumberKey(obj, 'activeTabIndex') && - 'tabs' in obj && - Array.isArray(obj.tabs) && - obj.tabs.every(isTabState) - ); -} - -function isTabState(obj: any): obj is TabState { - // We don't persist the hash, so we skip the check here - return ( - obj && - typeof obj === 'object' && - !Array.isArray(obj) && - hasStringKey(obj, 'id') && - hasStringKey(obj, 'title') && - hasStringOrNullKey(obj, 'query') && - hasStringOrNullKey(obj, 'variables') && - hasStringOrNullKey(obj, 'headers') && - hasStringOrNullKey(obj, 'operationName') && - hasStringOrNullKey(obj, 'response') - ); -} - -function hasNumberKey(obj: Record, key: string) { - return key in obj && typeof obj[key] === 'number'; -} - -function hasStringKey(obj: Record, key: string) { - return key in obj && typeof obj[key] === 'string'; -} - -function hasStringOrNullKey(obj: Record, key: string) { - return key in obj && (typeof obj[key] === 'string' || obj[key] === null); -} +import { debounce } from '@graphiql/toolkit'; export function useSynchronizeActiveTabValues({ queryEditor, @@ -201,58 +24,18 @@ export function useSynchronizeActiveTabValues({ }) { return useCallback<(state: TabsState) => TabsState>( state => { - const query = queryEditor?.getValue() ?? null; - const variables = variableEditor?.getValue() ?? null; - const headers = headerEditor?.getValue() ?? null; - const operationName = queryEditor?.operationName ?? null; - const response = responseEditor?.getValue() ?? null; - return setPropertiesInActiveTab(state, { - query, - variables, - headers, - response, - operationName, + return synchronizeActiveTabValues({ + currentState: state, + queryEditor, + variableEditor, + headerEditor, + responseEditor, }); }, [queryEditor, variableEditor, headerEditor, responseEditor], ); } -export function serializeTabState( - tabState: TabsState, - shouldPersistHeaders = false, -) { - return JSON.stringify(tabState, (key, value) => - key === 'hash' || - key === 'response' || - (!shouldPersistHeaders && key === 'headers') - ? null - : value, - ); -} - -export function useStoreTabs({ - storage, - shouldPersistHeaders, -}: { - storage: StorageAPI | null; - shouldPersistHeaders?: boolean; -}) { - const store = useMemo( - () => - debounce(500, (value: string) => { - storage?.set(STORAGE_KEY, value); - }), - [storage], - ); - return useCallback( - (currentState: TabsState) => { - store(serializeTabState(currentState, shouldPersistHeaders)); - }, - [shouldPersistHeaders, store], - ); -} - export function useSetEditorValues({ queryEditor, variableEditor, @@ -286,88 +69,3 @@ export function useSetEditorValues({ [headerEditor, queryEditor, responseEditor, variableEditor, defaultHeaders], ); } - -export function createTab({ - query = null, - variables = null, - headers = null, -}: Partial = {}): TabState { - return { - id: guid(), - hash: hashFromTabContents({ query, variables, headers }), - title: (query && fuzzyExtractOperationName(query)) || DEFAULT_TITLE, - query, - variables, - headers, - operationName: null, - response: null, - }; -} - -export function setPropertiesInActiveTab( - state: TabsState, - partialTab: Partial>, -): TabsState { - return { - ...state, - tabs: state.tabs.map((tab, index) => { - if (index !== state.activeTabIndex) { - return tab; - } - const newTab = { ...tab, ...partialTab }; - return { - ...newTab, - hash: hashFromTabContents(newTab), - title: - newTab.operationName || - (newTab.query - ? fuzzyExtractOperationName(newTab.query) - : undefined) || - DEFAULT_TITLE, - }; - }), - }; -} - -function guid(): string { - const s4 = () => { - return Math.floor((1 + Math.random()) * 0x10000) - .toString(16) - .slice(1); - }; - // return id of format 'aaaaaaaa'-'aaaa'-'aaaa'-'aaaa'-'aaaaaaaaaaaa' - return `${s4()}${s4()}-${s4()}-${s4()}-${s4()}-${s4()}${s4()}${s4()}`; -} - -function hashFromTabContents(args: { - query: string | null; - variables?: string | null; - headers?: string | null; -}): string { - return [args.query ?? '', args.variables ?? '', args.headers ?? ''].join('|'); -} - -export function fuzzyExtractOperationName(str: string): string | null { - const regex = /^(?!#).*(query|subscription|mutation)\s+([a-zA-Z0-9_]+)/m; - - const match = regex.exec(str); - - return match?.[2] ?? null; -} - -export function clearHeadersFromTabs(storage: StorageAPI | null) { - const persistedTabs = storage?.get(STORAGE_KEY); - if (persistedTabs) { - const parsedTabs = JSON.parse(persistedTabs); - storage?.set( - STORAGE_KEY, - JSON.stringify(parsedTabs, (key, value) => - key === 'headers' ? null : value, - ), - ); - } -} - -const DEFAULT_TITLE = ''; - -export const STORAGE_KEY = 'tabState'; diff --git a/packages/graphiql-react/src/editor/variable-editor.ts b/packages/graphiql-react/src/editor/variable-editor.ts index 2213c383e27..de01fee6af7 100644 --- a/packages/graphiql-react/src/editor/variable-editor.ts +++ b/packages/graphiql-react/src/editor/variable-editor.ts @@ -17,7 +17,8 @@ import { usePrettifyEditors, useSynchronizeOption, } from './hooks'; -import { CodeMirrorType, WriteableEditorProps } from './types'; +import { CodeMirrorType, WriteableEditorProps } from '@graphiql/toolkit'; +import { useOptionsContext } from '../hooks'; export type UseVariableEditorArgs = WriteableEditorProps & { /** @@ -43,11 +44,8 @@ export function useVariableEditor( }: UseVariableEditorArgs = {}, caller?: Function, ) { - const { initialVariables, variableEditor, setVariableEditor } = - useEditorContext({ - nonNull: true, - caller: caller || useVariableEditor, - }); + const { variableEditor, setVariableEditor } = useEditorContext(); + const { initialVariables } = useOptionsContext(); const executionContext = useExecutionContext(); const merge = useMergeQuery({ caller: caller || useVariableEditor }); const prettify = usePrettifyEditors({ caller: caller || useVariableEditor }); @@ -66,7 +64,7 @@ export function useVariableEditor( if (!isActive) { return; } - + // @ts-expect-error TODO: fix codemirror type codeMirrorRef.current = CodeMirror; const container = ref.current; @@ -123,7 +121,7 @@ export function useVariableEditor( editorInstance.execCommand('autocomplete'); } }); - + // @ts-expect-error TODO: fix codemirror type setVariableEditor(newEditor); }); diff --git a/packages/graphiql-react/src/execution.tsx b/packages/graphiql-react/src/execution.tsx index 5df69e39bbf..11047f076ed 100644 --- a/packages/graphiql-react/src/execution.tsx +++ b/packages/graphiql-react/src/execution.tsx @@ -1,460 +1,11 @@ -import { - Fetcher, - formatError, - formatResult, - isAsyncIterable, - isObservable, - Unsubscribable, -} from '@graphiql/toolkit'; -import { - ExecutionResult, - FragmentDefinitionNode, - GraphQLError, - print, -} from 'graphql'; -import { getFragmentDependenciesForAST } from 'graphql-language-service'; -import { ReactNode, useCallback, useMemo, useRef, useState } from 'react'; -import setValue from 'set-value'; -import getValue from 'get-value'; +import { useStore } from 'zustand'; -import { useAutoCompleteLeafs, useEditorContext } from './editor'; -import { UseAutoCompleteLeafsArgs } from './editor/hooks'; -import { useHistoryContext } from './history'; -import { createContextHook, createNullableContext } from './utility/context'; +import { useGraphiQLStore } from './hooks'; -export type ExecutionContextType = { - /** - * If there is currently a GraphQL request in-flight. For multi-part - * requests like subscriptions, this will be `true` while fetching the - * first partial response and `false` while fetching subsequent batches. - */ - isFetching: boolean; - /** - * If there is currently a GraphQL request in-flight. For multi-part - * requests like subscriptions, this will be `true` until the last batch - * has been fetched or the connection is closed from the client. - */ - isSubscribed: boolean; - /** - * The operation name that will be sent with all GraphQL requests. - */ - operationName: string | null; - /** - * Start a GraphQL requests based of the current editor contents. - */ - run(): void; - /** - * Stop the GraphQL request that is currently in-flight. - */ - stop(): void; +export const useExecutionContext = (_options?: { + nonNull?: boolean; + caller?: Function; +}) => { + const store = useGraphiQLStore(); + return useStore(store, state => state.execution); }; - -export const ExecutionContext = - createNullableContext('ExecutionContext'); - -export type ExecutionContextProviderProps = Pick< - UseAutoCompleteLeafsArgs, - 'getDefaultFieldNames' -> & { - children: ReactNode; - /** - * A function which accepts GraphQL HTTP parameters and returns a `Promise`, - * `Observable` or `AsyncIterable` that returns the GraphQL response in - * parsed JSON format. - * - * We suggest using the `createGraphiQLFetcher` utility from `@graphiql/toolkit` - * to create these fetcher functions. - * - * @see {@link https://graphiql-test.netlify.app/typedoc/modules/graphiql_toolkit.html#creategraphiqlfetcher-2|`createGraphiQLFetcher`} - */ - fetcher: Fetcher; - /** - * This prop sets the operation name that is passed with a GraphQL request. - */ - operationName?: string; -}; - -export function ExecutionContextProvider({ - fetcher, - getDefaultFieldNames, - children, - operationName, -}: ExecutionContextProviderProps) { - if (!fetcher) { - throw new TypeError( - 'The `ExecutionContextProvider` component requires a `fetcher` function to be passed as prop.', - ); - } - - const { - externalFragments, - headerEditor, - queryEditor, - responseEditor, - variableEditor, - updateActiveTabValues, - } = useEditorContext({ nonNull: true, caller: ExecutionContextProvider }); - const history = useHistoryContext(); - const autoCompleteLeafs = useAutoCompleteLeafs({ - getDefaultFieldNames, - caller: ExecutionContextProvider, - }); - const [isFetching, setIsFetching] = useState(false); - const [subscription, setSubscription] = useState(null); - const queryIdRef = useRef(0); - - const stop = useCallback(() => { - subscription?.unsubscribe(); - setIsFetching(false); - setSubscription(null); - }, [subscription]); - - const run = useCallback(async () => { - if (!queryEditor || !responseEditor) { - return; - } - - // If there's an active subscription, unsubscribe it and return - if (subscription) { - stop(); - return; - } - - const setResponse = (value: string) => { - responseEditor.setValue(value); - updateActiveTabValues({ response: value }); - }; - - queryIdRef.current += 1; - const queryId = queryIdRef.current; - - // Use the edited query after autoCompleteLeafs() runs or, - // in case autoCompletion fails (the function returns undefined), - // the current query from the editor. - let query = autoCompleteLeafs() || queryEditor.getValue(); - - const variablesString = variableEditor?.getValue(); - let variables: Record | undefined; - try { - variables = tryParseJsonObject({ - json: variablesString, - errorMessageParse: 'Variables are invalid JSON', - errorMessageType: 'Variables are not a JSON object.', - }); - } catch (error) { - setResponse(error instanceof Error ? error.message : `${error}`); - return; - } - - const headersString = headerEditor?.getValue(); - let headers: Record | undefined; - try { - headers = tryParseJsonObject({ - json: headersString, - errorMessageParse: 'Headers are invalid JSON', - errorMessageType: 'Headers are not a JSON object.', - }); - } catch (error) { - setResponse(error instanceof Error ? error.message : `${error}`); - return; - } - - if (externalFragments) { - const fragmentDependencies = queryEditor.documentAST - ? getFragmentDependenciesForAST( - queryEditor.documentAST, - externalFragments, - ) - : []; - if (fragmentDependencies.length > 0) { - query += - '\n' + - fragmentDependencies - .map((node: FragmentDefinitionNode) => print(node)) - .join('\n'); - } - } - - setResponse(''); - setIsFetching(true); - - const opName = operationName ?? queryEditor.operationName ?? undefined; - - history?.addToHistory({ - query, - variables: variablesString, - headers: headersString, - operationName: opName, - }); - - try { - const fullResponse: ExecutionResult = {}; - const handleResponse = (result: ExecutionResult) => { - // A different query was dispatched in the meantime, so don't - // show the results of this one. - if (queryId !== queryIdRef.current) { - return; - } - - let maybeMultipart = Array.isArray(result) ? result : false; - if ( - !maybeMultipart && - typeof result === 'object' && - result !== null && - 'hasNext' in result - ) { - maybeMultipart = [result]; - } - - if (maybeMultipart) { - for (const part of maybeMultipart) { - mergeIncrementalResult(fullResponse, part); - } - - setIsFetching(false); - setResponse(formatResult(fullResponse)); - } else { - const response = formatResult(result); - setIsFetching(false); - setResponse(response); - } - }; - - const fetch = fetcher( - { - query, - variables, - operationName: opName, - }, - { - headers: headers ?? undefined, - documentAST: queryEditor.documentAST ?? undefined, - }, - ); - - const value = await Promise.resolve(fetch); - if (isObservable(value)) { - // If the fetcher returned an Observable, then subscribe to it, calling - // the callback on each next value, and handling both errors and the - // completion of the Observable. - setSubscription( - value.subscribe({ - next(result) { - handleResponse(result); - }, - error(error: Error) { - setIsFetching(false); - if (error) { - setResponse(formatError(error)); - } - setSubscription(null); - }, - complete() { - setIsFetching(false); - setSubscription(null); - }, - }), - ); - } else if (isAsyncIterable(value)) { - setSubscription({ - unsubscribe: () => value[Symbol.asyncIterator]().return?.(), - }); - for await (const result of value) { - handleResponse(result); - } - setIsFetching(false); - setSubscription(null); - } else { - handleResponse(value); - } - } catch (error) { - setIsFetching(false); - setResponse(formatError(error)); - setSubscription(null); - } - }, [ - autoCompleteLeafs, - externalFragments, - fetcher, - headerEditor, - history, - operationName, - queryEditor, - responseEditor, - stop, - subscription, - updateActiveTabValues, - variableEditor, - ]); - - const isSubscribed = Boolean(subscription); - const value = useMemo( - () => ({ - isFetching, - isSubscribed, - operationName: operationName ?? null, - run, - stop, - }), - [isFetching, isSubscribed, operationName, run, stop], - ); - - return ( - - {children} - - ); -} - -export const useExecutionContext = createContextHook(ExecutionContext); - -function tryParseJsonObject({ - json, - errorMessageParse, - errorMessageType, -}: { - json: string | undefined; - errorMessageParse: string; - errorMessageType: string; -}) { - let parsed: Record | undefined; - try { - parsed = json && json.trim() !== '' ? JSON.parse(json) : undefined; - } catch (error) { - throw new Error( - `${errorMessageParse}: ${ - error instanceof Error ? error.message : error - }.`, - ); - } - const isObject = - typeof parsed === 'object' && parsed !== null && !Array.isArray(parsed); - if (parsed !== undefined && !isObject) { - throw new Error(errorMessageType); - } - return parsed; -} - -type IncrementalResult = { - data?: Record | null; - errors?: ReadonlyArray; - extensions?: Record; - hasNext?: boolean; - path?: ReadonlyArray; - incremental?: ReadonlyArray; - label?: string; - items?: ReadonlyArray> | null; - pending?: ReadonlyArray<{ id: string; path: ReadonlyArray }>; - completed?: ReadonlyArray<{ - id: string; - errors?: ReadonlyArray; - }>; - id?: string; - subPath?: ReadonlyArray; -}; - -const pathsMap = new WeakMap< - ExecutionResult, - Map> ->(); - -/** - * @param executionResult The complete execution result object which will be - * mutated by merging the contents of the incremental result. - * @param incrementalResult The incremental result that will be merged into the - * complete execution result. - */ -function mergeIncrementalResult( - executionResult: IncrementalResult, - incrementalResult: IncrementalResult, -): void { - let path: ReadonlyArray | undefined = [ - 'data', - ...(incrementalResult.path ?? []), - ]; - - for (const result of [executionResult, incrementalResult]) { - if (result.pending) { - let paths = pathsMap.get(executionResult); - if (paths === undefined) { - paths = new Map(); - pathsMap.set(executionResult, paths); - } - - for (const { id, path: pendingPath } of result.pending) { - paths.set(id, ['data', ...pendingPath]); - } - } - } - - const { items } = incrementalResult; - if (items) { - const { id } = incrementalResult; - if (id) { - path = pathsMap.get(executionResult)?.get(id); - if (path === undefined) { - throw new Error('Invalid incremental delivery format.'); - } - - const list = getValue(executionResult, path.join('.')); - list.push(...items); - } else { - path = ['data', ...(incrementalResult.path ?? [])]; - for (const item of items) { - setValue(executionResult, path.join('.'), item); - // Increment the last path segment (the array index) to merge the next item at the next index - // eslint-disable-next-line unicorn/prefer-at -- cannot mutate the array using Array.at() - (path[path.length - 1] as number)++; - } - } - } - - const { data } = incrementalResult; - if (data) { - const { id } = incrementalResult; - if (id) { - path = pathsMap.get(executionResult)?.get(id); - if (path === undefined) { - throw new Error('Invalid incremental delivery format.'); - } - const { subPath } = incrementalResult; - if (subPath !== undefined) { - path = [...path, ...subPath]; - } - } - setValue(executionResult, path.join('.'), data, { - merge: true, - }); - } - - if (incrementalResult.errors) { - executionResult.errors ||= []; - (executionResult.errors as GraphQLError[]).push( - ...incrementalResult.errors, - ); - } - - if (incrementalResult.extensions) { - setValue(executionResult, 'extensions', incrementalResult.extensions, { - merge: true, - }); - } - - if (incrementalResult.incremental) { - for (const incrementalSubResult of incrementalResult.incremental) { - mergeIncrementalResult(executionResult, incrementalSubResult); - } - } - - if (incrementalResult.completed) { - // Remove tracking and add additional errors - for (const { id, errors } of incrementalResult.completed) { - pathsMap.get(executionResult)?.delete(id); - - if (errors) { - executionResult.errors ||= []; - (executionResult.errors as GraphQLError[]).push(...errors); - } - } - } -} diff --git a/packages/graphiql-react/src/explorer/components/__tests__/doc-explorer.spec.tsx b/packages/graphiql-react/src/explorer/components/__tests__/doc-explorer.spec.tsx.disabled similarity index 100% rename from packages/graphiql-react/src/explorer/components/__tests__/doc-explorer.spec.tsx rename to packages/graphiql-react/src/explorer/components/__tests__/doc-explorer.spec.tsx.disabled diff --git a/packages/graphiql-react/src/explorer/components/__tests__/type-documentation.spec.tsx b/packages/graphiql-react/src/explorer/components/__tests__/type-documentation.spec.tsx.disabled similarity index 100% rename from packages/graphiql-react/src/explorer/components/__tests__/type-documentation.spec.tsx rename to packages/graphiql-react/src/explorer/components/__tests__/type-documentation.spec.tsx.disabled diff --git a/packages/graphiql-react/src/explorer/components/doc-explorer.tsx b/packages/graphiql-react/src/explorer/components/doc-explorer.tsx index 63385469c58..b009e87f630 100644 --- a/packages/graphiql-react/src/explorer/components/doc-explorer.tsx +++ b/packages/graphiql-react/src/explorer/components/doc-explorer.tsx @@ -13,9 +13,9 @@ import { TypeDocumentation } from './type-documentation'; import './doc-explorer.css'; export function DocExplorer() { - const { fetchError, isFetching, schema, validationErrors } = useSchemaContext( - { nonNull: true, caller: DocExplorer }, - ); + const { fetchError, isFetching, schema, validationErrors } = + useSchemaContext(); + const { explorerNavStack, pop } = useExplorerContext({ nonNull: true, caller: DocExplorer, diff --git a/packages/graphiql-react/src/explorer/components/search.tsx b/packages/graphiql-react/src/explorer/components/search.tsx index e090f513258..78014ef54df 100644 --- a/packages/graphiql-react/src/explorer/components/search.tsx +++ b/packages/graphiql-react/src/explorer/components/search.tsx @@ -18,7 +18,7 @@ import { import { Combobox } from '@headlessui/react'; import { MagnifyingGlassIcon } from '../../icons'; import { useSchemaContext } from '../../schema'; -import debounce from '../../utility/debounce'; +import { debounce } from '@graphiql/toolkit'; import { useExplorerContext } from '../context'; @@ -176,10 +176,7 @@ export function useSearchResults(caller?: Function) { nonNull: true, caller: caller || useSearchResults, }); - const { schema } = useSchemaContext({ - nonNull: true, - caller: caller || useSearchResults, - }); + const { schema } = useSchemaContext(); const navItem = explorerNavStack.at(-1)!; diff --git a/packages/graphiql-react/src/explorer/components/type-documentation.tsx b/packages/graphiql-react/src/explorer/components/type-documentation.tsx index 3e5bccbea62..25f7186a645 100644 --- a/packages/graphiql-react/src/explorer/components/type-documentation.tsx +++ b/packages/graphiql-react/src/explorer/components/type-documentation.tsx @@ -220,7 +220,7 @@ function EnumValue({ value }: { value: GraphQLEnumValue }) { } function PossibleTypes({ type }: { type: GraphQLNamedType }) { - const { schema } = useSchemaContext({ nonNull: true }); + const { schema } = useSchemaContext(); if (!schema || !isAbstractType(type)) { return null; } diff --git a/packages/graphiql-react/src/explorer/context.tsx b/packages/graphiql-react/src/explorer/context.tsx index cf545334306..c6f7ce72277 100644 --- a/packages/graphiql-react/src/explorer/context.tsx +++ b/packages/graphiql-react/src/explorer/context.tsx @@ -72,10 +72,7 @@ export type ExplorerContextProviderProps = { }; export function ExplorerContextProvider(props: ExplorerContextProviderProps) { - const { schema, validationErrors } = useSchemaContext({ - nonNull: true, - caller: ExplorerContextProvider, - }); + const { schema, validationErrors } = useSchemaContext(); const [navStack, setNavStack] = useState([ initialNavStackItem, diff --git a/packages/graphiql-react/src/history/components.tsx b/packages/graphiql-react/src/history/components.tsx index 9ee49574be3..0bf187f8263 100644 --- a/packages/graphiql-react/src/history/components.tsx +++ b/packages/graphiql-react/src/history/components.tsx @@ -112,10 +112,7 @@ export function HistoryItem(props: QueryHistoryItemProps) { nonNull: true, caller: HistoryItem, }); - const { headerEditor, queryEditor, variableEditor } = useEditorContext({ - nonNull: true, - caller: HistoryItem, - }); + const { headerEditor, queryEditor, variableEditor } = useEditorContext(); const inputRef = useRef(null); const buttonRef = useRef(null); const [isEditable, setIsEditable] = useState(false); diff --git a/packages/graphiql-react/src/hooks.ts b/packages/graphiql-react/src/hooks.ts new file mode 100644 index 00000000000..7b513b282b3 --- /dev/null +++ b/packages/graphiql-react/src/hooks.ts @@ -0,0 +1,15 @@ +import { useStore } from 'zustand'; +import { useContext } from 'react'; +import { GraphiQLStoreContext } from './provider'; + +// move this to @graphiql/react ofc +export const useGraphiQLStore = () => { + const store = useContext(GraphiQLStoreContext); + if (!store) throw new Error('Missing GraphiQLProvider in the tree'); + return store; +}; + +// TODO: move this to it's own section, where use settings are edited +export const useOptionsContext = () => { + return useStore(useGraphiQLStore(), state => state.options); +}; diff --git a/packages/graphiql-react/src/index.ts b/packages/graphiql-react/src/index.ts index bf4b99d71d4..40145ac8bae 100644 --- a/packages/graphiql-react/src/index.ts +++ b/packages/graphiql-react/src/index.ts @@ -1,8 +1,6 @@ import './style/root.css'; export { - EditorContext, - EditorContextProvider, HeaderEditor, ImagePreview, QueryEditor, @@ -23,11 +21,8 @@ export { useHeadersEditorState, VariableEditor, } from './editor'; -export { - ExecutionContext, - ExecutionContextProvider, - useExecutionContext, -} from './execution'; +export { useExecutionContext } from './execution'; +export { useOptionsContext } from './hooks'; export { Argument, DefaultValue, @@ -59,11 +54,7 @@ export { usePluginContext, } from './plugin'; export { GraphiQLProvider } from './provider'; -export { - SchemaContext, - SchemaContextProvider, - useSchemaContext, -} from './schema'; +export { useSchemaContext } from './schema'; export { StorageContext, StorageContextProvider, @@ -79,8 +70,6 @@ export * from './toolbar'; export type { CommonEditorProps, - EditorContextProviderProps, - EditorContextType, KeyMap, ResponseTooltipType, TabsState, @@ -90,10 +79,6 @@ export type { UseVariableEditorArgs, WriteableEditorProps, } from './editor'; -export type { - ExecutionContextProviderProps, - ExecutionContextType, -} from './execution'; export type { ExplorerContextProviderProps, ExplorerContextType, @@ -111,7 +96,6 @@ export type { PluginContextProviderProps, } from './plugin'; export type { GraphiQLProviderProps } from './provider'; -export type { SchemaContextProviderProps, SchemaContextType } from './schema'; export type { StorageContextProviderProps, StorageContextType, diff --git a/packages/graphiql-react/src/provider.tsx b/packages/graphiql-react/src/provider.tsx index ead1907de8e..22fd3c614ab 100644 --- a/packages/graphiql-react/src/provider.tsx +++ b/packages/graphiql-react/src/provider.tsx @@ -1,24 +1,52 @@ -import { EditorContextProvider, EditorContextProviderProps } from './editor'; import { - ExecutionContextProvider, - ExecutionContextProviderProps, -} from './execution'; + createGraphiQLStore, + GraphiQLState, + UserOptions, +} from '@graphiql/toolkit'; + import { ExplorerContextProvider, ExplorerContextProviderProps, } from './explorer/context'; import { HistoryContextProvider, HistoryContextProviderProps } from './history'; import { PluginContextProvider, PluginContextProviderProps } from './plugin'; -import { SchemaContextProvider, SchemaContextProviderProps } from './schema'; + import { StorageContextProvider, StorageContextProviderProps } from './storage'; +import { createContext, useContext, useEffect, useMemo, useRef } from 'react'; +import { useStore } from 'zustand'; -export type GraphiQLProviderProps = EditorContextProviderProps & - ExecutionContextProviderProps & +export type GraphiQLProviderProps = UserOptions & ExplorerContextProviderProps & HistoryContextProviderProps & PluginContextProviderProps & - SchemaContextProviderProps & - StorageContextProviderProps; + StorageContextProviderProps & + DeprecatedControlledProps; + +export type DeprecatedControlledProps = { + /** + * @deprecated Use hooks for controlled state + */ + operationName?: string; + /** + * @deprecated Use hooks for controlled state, or defaultQuery for default state + */ + query?: string; + /** + * @deprecated Use hooks for controlled state + */ + response?: string; + /** + * @deprecated Use hooks instead, or defaultVariables for default state + */ + variables?: string; + /** + * @deprecated Use hooks for controlled state, or defaultHeaders for default state + */ +}; + +export const GraphiQLStoreContext = createContext | null>(null); export function GraphiQLProvider({ children, @@ -27,7 +55,10 @@ export function GraphiQLProvider({ defaultHeaders, defaultTabs, externalFragments, + // @ts-expect-error TODO: fix fetcher type fetcher, + // @ts-expect-error TODO: types + fetchOptions, getDefaultFieldNames, headers, inputValueDeprecation, @@ -49,50 +80,49 @@ export function GraphiQLProvider({ variables, visiblePlugin, }: GraphiQLProviderProps) { + const store = useRef( + createGraphiQLStore({ + defaultQuery, + defaultHeaders, + defaultTabs, + externalFragments, + fetcher, + getDefaultFieldNames, + headers, + inputValueDeprecation, + introspectionQueryName, + onEditOperationName, + onSchemaChange, + onTabChange, + schema, + schemaDescription, + shouldPersistHeaders, + validationRules, + dangerouslyAssumeSchemaIsValid, + fetchOptions, + }), + ).current; + + const state = useStore(store); + + useEffect(() => { + state.schema.introspect(); + }, [fetcher]); return ( - - - - - + + + + - - - {children} - - - - - - - + {children} + + + + + ); } diff --git a/packages/graphiql-react/src/schema.tsx b/packages/graphiql-react/src/schema.tsx index 6284fc95ddc..f98c2b284ca 100644 --- a/packages/graphiql-react/src/schema.tsx +++ b/packages/graphiql-react/src/schema.tsx @@ -1,423 +1,11 @@ -import { - Fetcher, - FetcherOpts, - fetcherReturnToPromise, - formatError, - formatResult, - isPromise, -} from '@graphiql/toolkit'; -import { - buildClientSchema, - getIntrospectionQuery, - GraphQLError, - GraphQLSchema, - IntrospectionQuery, - isSchema, - validateSchema, -} from 'graphql'; -import { - ReactNode, - useCallback, - useEffect, - useMemo, - useRef, - useState, -} from 'react'; +import { useStore } from 'zustand'; -import { useEditorContext } from './editor'; -import { createContextHook, createNullableContext } from './utility/context'; +import { useGraphiQLStore } from './hooks'; -type MaybeGraphQLSchema = GraphQLSchema | null | undefined; - -export type SchemaContextType = { - /** - * Stores an error raised during introspecting or building the GraphQL schema - * from the introspection result. - */ - fetchError: string | null; - /** - * Trigger building the GraphQL schema. This might trigger an introspection - * request if no schema is passed via props and if using a schema is not - * explicitly disabled by passing `null` as value for the `schema` prop. If - * there is a schema (either fetched using introspection or passed via props) - * it will be validated, unless this is explicitly skipped using the - * `dangerouslyAssumeSchemaIsValid` prop. - */ - introspect(): void; - /** - * If there currently is an introspection request in-flight. - */ - isFetching: boolean; - /** - * The current GraphQL schema. - */ - schema: MaybeGraphQLSchema; - /** - * A list of errors from validating the current GraphQL schema. The schema is - * valid if and only if this list is empty. - */ - validationErrors: readonly GraphQLError[]; -}; - -export const SchemaContext = - createNullableContext('SchemaContext'); - -export type SchemaContextProviderProps = { - children: ReactNode; - /** - * This prop can be used to skip validating the GraphQL schema. This applies - * to both schemas fetched via introspection and schemas explicitly passed - * via the `schema` prop. - * - * IMPORTANT NOTE: Without validating the schema, GraphiQL and its components - * are vulnerable to numerous exploits and might break. Only use this prop if - * you have full control over the schema passed to GraphiQL. - * - * @default false - */ - dangerouslyAssumeSchemaIsValid?: boolean; - /** - * A function which accepts GraphQL HTTP parameters and returns a `Promise`, - * `Observable` or `AsyncIterable` that returns the GraphQL response in - * parsed JSON format. - * - * We suggest using the `createGraphiQLFetcher` utility from `@graphiql/toolkit` - * to create these fetcher functions. - * - * @see {@link https://graphiql-test.netlify.app/typedoc/modules/graphiql_toolkit.html#creategraphiqlfetcher-2|`createGraphiQLFetcher`} - */ - fetcher: Fetcher; - /** - * Invoked after a new GraphQL schema was built. This includes both fetching - * the schema via introspection and passing the schema using the `schema` - * prop. - * @param schema The GraphQL schema that is now used for GraphiQL. - */ - onSchemaChange?(schema: GraphQLSchema): void; - /** - * Explicitly provide the GraphiQL schema that shall be used for GraphiQL. - * If this props is... - * - ...passed and the value is a GraphQL schema, it will be validated and - * then used for GraphiQL if it is valid. - * - ...passed and the value is the result of an introspection query, a - * GraphQL schema will be built from this introspection data, it will be - * validated, and then used for GraphiQL if it is valid. - * - ...set to `null`, no introspection request will be triggered and - * GraphiQL will run without a schema. - * - ...set to `undefined` or not set at all, an introspection request will - * be triggered. If this request succeeds, a GraphQL schema will be built - * from the returned introspection data, it will be validated, and then - * used for GraphiQL if it is valid. If this request fails, GraphiQL will - * run without a schema. - */ - schema?: GraphQLSchema | IntrospectionQuery | null; -} & IntrospectionArgs; - -export function SchemaContextProvider(props: SchemaContextProviderProps) { - if (!props.fetcher) { - throw new TypeError( - 'The `SchemaContextProvider` component requires a `fetcher` function to be passed as prop.', - ); - } - - const { initialHeaders, headerEditor } = useEditorContext({ - nonNull: true, - caller: SchemaContextProvider, - }); - const [schema, setSchema] = useState(); - const [isFetching, setIsFetching] = useState(false); - const [fetchError, setFetchError] = useState(null); - - /** - * A counter that is incremented each time introspection is triggered or the - * schema state is updated. - */ - const counterRef = useRef(0); - - /** - * Synchronize prop changes with state - */ - useEffect(() => { - setSchema( - isSchema(props.schema) || - props.schema === null || - props.schema === undefined - ? props.schema - : undefined, - ); - - /** - * Increment the counter so that in-flight introspection requests don't - * override this change. - */ - counterRef.current++; - }, [props.schema]); - - /** - * Keep a ref to the current headers - */ - const headersRef = useRef(initialHeaders); - useEffect(() => { - if (headerEditor) { - headersRef.current = headerEditor.getValue(); - } - }); - - /** - * Get introspection query for settings given via props - */ - const { - introspectionQuery, - introspectionQueryName, - introspectionQuerySansSubscriptions, - } = useIntrospectionQuery({ - inputValueDeprecation: props.inputValueDeprecation, - introspectionQueryName: props.introspectionQueryName, - schemaDescription: props.schemaDescription, - }); - - /** - * Fetch the schema - */ - const { fetcher, onSchemaChange, dangerouslyAssumeSchemaIsValid, children } = - props; - const introspect = useCallback(() => { - /** - * Only introspect if there is no schema provided via props. If the - * prop is passed an introspection result, we do continue but skip the - * introspection request. - */ - if (isSchema(props.schema) || props.schema === null) { - return; - } - - const counter = ++counterRef.current; - - const maybeIntrospectionData = props.schema; - - async function fetchIntrospectionData() { - if (maybeIntrospectionData) { - // No need to introspect if we already have the data - return maybeIntrospectionData; - } - - const parsedHeaders = parseHeaderString(headersRef.current); - if (!parsedHeaders.isValidJSON) { - setFetchError('Introspection failed as headers are invalid.'); - return; - } - - const fetcherOpts: FetcherOpts = parsedHeaders.headers - ? { headers: parsedHeaders.headers } - : {}; - - const fetch = fetcherReturnToPromise( - fetcher( - { - query: introspectionQuery, - operationName: introspectionQueryName, - }, - fetcherOpts, - ), - ); - - if (!isPromise(fetch)) { - setFetchError('Fetcher did not return a Promise for introspection.'); - return; - } - - setIsFetching(true); - setFetchError(null); - - let result = await fetch; - - if ( - typeof result !== 'object' || - result === null || - !('data' in result) - ) { - // Try the stock introspection query first, falling back on the - // sans-subscriptions query for services which do not yet support it. - const fetch2 = fetcherReturnToPromise( - fetcher( - { - query: introspectionQuerySansSubscriptions, - operationName: introspectionQueryName, - }, - fetcherOpts, - ), - ); - if (!isPromise(fetch2)) { - throw new Error( - 'Fetcher did not return a Promise for introspection.', - ); - } - result = await fetch2; - } - - setIsFetching(false); - - if (result?.data && '__schema' in result.data) { - return result.data as IntrospectionQuery; - } - - // handle as if it were an error if the fetcher response is not a string or response.data is not present - const responseString = - typeof result === 'string' ? result : formatResult(result); - setFetchError(responseString); - } - - fetchIntrospectionData() - .then(introspectionData => { - /** - * Don't continue if another introspection request has been started in - * the meantime or if there is no introspection data. - */ - if (counter !== counterRef.current || !introspectionData) { - return; - } - - try { - const newSchema = buildClientSchema(introspectionData); - setSchema(newSchema); - onSchemaChange?.(newSchema); - } catch (error) { - setFetchError(formatError(error)); - } - }) - .catch(error => { - /** - * Don't continue if another introspection request has been started in - * the meantime. - */ - if (counter !== counterRef.current) { - return; - } - - setFetchError(formatError(error)); - setIsFetching(false); - }); - }, [ - fetcher, - introspectionQueryName, - introspectionQuery, - introspectionQuerySansSubscriptions, - onSchemaChange, - props.schema, - ]); - - /** - * Trigger introspection automatically - */ - useEffect(() => { - introspect(); - }, [introspect]); - - /** - * Trigger introspection manually via short key - */ - useEffect(() => { - function triggerIntrospection(event: KeyboardEvent) { - if (event.ctrlKey && event.key === 'R') { - introspect(); - } - } - - window.addEventListener('keydown', triggerIntrospection); - return () => window.removeEventListener('keydown', triggerIntrospection); - }); - - /** - * Derive validation errors from the schema - */ - const validationErrors = useMemo(() => { - if (!schema || dangerouslyAssumeSchemaIsValid) { - return []; - } - return validateSchema(schema); - }, [schema, dangerouslyAssumeSchemaIsValid]); - - /** - * Memoize context value - */ - const value = useMemo( - () => ({ - fetchError, - introspect, - isFetching, - schema, - validationErrors, - }), - [fetchError, introspect, isFetching, schema, validationErrors], - ); - - return ( - {children} - ); -} - -export const useSchemaContext = createContextHook(SchemaContext); - -type IntrospectionArgs = { - /** - * Can be used to set the equally named option for introspecting a GraphQL - * server. - * @default false - * @see {@link https://github.com/graphql/graphql-js/blob/main/src/utilities/getIntrospectionQuery.ts|Utility for creating the introspection query} - */ - inputValueDeprecation?: boolean; - /** - * Can be used to set a custom operation name for the introspection query. - */ - introspectionQueryName?: string; - /** - * Can be used to set the equally named option for introspecting a GraphQL - * server. - * @default false - * @see {@link https://github.com/graphql/graphql-js/blob/main/src/utilities/getIntrospectionQuery.ts|Utility for creating the introspection query} - */ - schemaDescription?: boolean; +export const useSchemaContext = (options?: { + nonNull?: boolean; + caller?: Function; +}) => { + const store = useGraphiQLStore(); + return useStore(store, state => state.schema); }; - -function useIntrospectionQuery({ - inputValueDeprecation, - introspectionQueryName, - schemaDescription, -}: IntrospectionArgs) { - return useMemo(() => { - const queryName = introspectionQueryName || 'IntrospectionQuery'; - - let query = getIntrospectionQuery({ - inputValueDeprecation, - schemaDescription, - }); - if (introspectionQueryName) { - query = query.replace('query IntrospectionQuery', `query ${queryName}`); - } - - const querySansSubscriptions = query.replace( - 'subscriptionType { name }', - '', - ); - - return { - introspectionQueryName: queryName, - introspectionQuery: query, - introspectionQuerySansSubscriptions: querySansSubscriptions, - }; - }, [inputValueDeprecation, introspectionQueryName, schemaDescription]); -} - -function parseHeaderString(headersString: string | undefined) { - let headers: Record | null = null; - let isValidJSON = true; - - try { - if (headersString) { - headers = JSON.parse(headersString); - } - } catch { - isValidJSON = false; - } - return { headers, isValidJSON }; -} diff --git a/packages/graphiql-react/src/toolbar/execute.tsx b/packages/graphiql-react/src/toolbar/execute.tsx index ff7eb1e70f9..32d39b6f313 100644 --- a/packages/graphiql-react/src/toolbar/execute.tsx +++ b/packages/graphiql-react/src/toolbar/execute.tsx @@ -6,15 +6,9 @@ import { DropdownMenu, Tooltip } from '../ui'; import './execute.css'; export function ExecuteButton() { - const { queryEditor, setOperationName } = useEditorContext({ - nonNull: true, - caller: ExecuteButton, - }); + const { queryEditor, setOperationName } = useEditorContext(); const { isFetching, isSubscribed, operationName, run, stop } = - useExecutionContext({ - nonNull: true, - caller: ExecuteButton, - }); + useExecutionContext(); const operations = queryEditor?.operations || []; const hasOptions = operations.length > 1 && typeof operationName !== 'string'; diff --git a/packages/graphiql-react/src/utility/resize.ts b/packages/graphiql-react/src/utility/resize.ts index 38e53ffafbf..2e0202e6db9 100644 --- a/packages/graphiql-react/src/utility/resize.ts +++ b/packages/graphiql-react/src/utility/resize.ts @@ -8,7 +8,7 @@ import { } from 'react'; import { useStorageContext } from '../storage'; -import debounce from './debounce'; +import { debounce } from '@graphiql/toolkit'; type ResizableElement = 'first' | 'second'; diff --git a/packages/graphiql-toolkit/package.json b/packages/graphiql-toolkit/package.json index 8e3c8bcfde2..8a02fd3322c 100644 --- a/packages/graphiql-toolkit/package.json +++ b/packages/graphiql-toolkit/package.json @@ -1,7 +1,7 @@ { "name": "@graphiql/toolkit", "version": "0.11.0", - "description": "Utility to build a fetcher for GraphiQL", + "description": "Framework agnostic domain logic, utilities & helpers for building clients like GraphiQL", "contributors": [ "Rikki Schulte (https://rikki.dev)" ], @@ -27,7 +27,11 @@ }, "dependencies": { "@n1ru4l/push-pull-async-iterable-iterator": "^3.1.0", - "meros": "^1.1.4" + "meros": "^1.1.4", + "zustand": "^4.5.5", + "immer": "^10.1.1", + "idb-keyval": "^6.2.1", + "codemirror": "^5.65.3" }, "devDependencies": { "graphql": "^17.0.0-alpha.7", diff --git a/packages/graphiql-toolkit/src/codemirror/types.ts b/packages/graphiql-toolkit/src/codemirror/types.ts new file mode 100644 index 00000000000..fbb7bd33fcf --- /dev/null +++ b/packages/graphiql-toolkit/src/codemirror/types.ts @@ -0,0 +1,38 @@ +import type { Editor } from 'codemirror'; +import { DocumentNode, OperationDefinitionNode } from 'graphql'; +import { VariableToType } from 'graphql-language-service'; + +export type CodeMirrorType = typeof import('codemirror'); + +export type CodeMirrorEditor = Editor & { options?: any }; + +export type KeyMap = 'sublime' | 'emacs' | 'vim'; + +export type CommonEditorProps = { + /** + * Sets the color theme you want to use for the editor. + * @default 'graphiql' + */ + editorTheme?: string; + /** + * Sets the key map to use when using the editor. + * @default 'sublime' + * @see {@link https://codemirror.net/5/doc/manual.html#keymaps} + */ + keyMap?: KeyMap; +}; + +export type WriteableEditorProps = CommonEditorProps & { + /** + * Makes the editor read-only. + * @default false + */ + readOnly?: boolean; +}; + +export type CodeMirrorEditorWithOperationFacts = CodeMirrorEditor & { + documentAST: DocumentNode | null; + operationName: string | null; + operations: OperationDefinitionNode[] | null; + variableToType: VariableToType | null; +}; diff --git a/packages/graphiql-toolkit/src/constants.ts b/packages/graphiql-toolkit/src/constants.ts new file mode 100644 index 00000000000..088deb13103 --- /dev/null +++ b/packages/graphiql-toolkit/src/constants.ts @@ -0,0 +1,32 @@ +export const DEFAULT_QUERY = `# Welcome to GraphiQL +# +# GraphiQL is an in-browser tool for writing, validating, and +# testing GraphQL queries. +# +# Type queries into this side of the screen, and you will see intelligent +# typeaheads aware of the current GraphQL type schema and live syntax and +# validation errors highlighted within the text. +# +# GraphQL queries typically start with a "{" character. Lines that start +# with a # are ignored. +# +# An example GraphQL query might look like: +# +# { +# field(arg: "value") { +# subField +# } +# } +# +# Keyboard shortcuts: +# +# Prettify query: Shift-Ctrl-P (or press the prettify button) +# +# Merge fragments: Shift-Ctrl-M (or press the merge button) +# +# Run Query: Ctrl-Enter (or press the play button) +# +# Auto Complete: Ctrl-Space (or just start typing) +# + +`; diff --git a/packages/graphiql-toolkit/src/index.ts b/packages/graphiql-toolkit/src/index.ts index 503f6fcf711..dba60ae05b5 100644 --- a/packages/graphiql-toolkit/src/index.ts +++ b/packages/graphiql-toolkit/src/index.ts @@ -3,4 +3,8 @@ export * from './create-fetcher'; export * from './format'; export * from './graphql-helpers'; export * from './storage'; +export * from './codemirror/types'; +export { default as debounce } from './utility/debounce'; // TODO: move the most useful utilities from graphiql to here +export * from './zustand/store'; +export * from './zustand/tabs'; diff --git a/packages/graphiql-react/src/utility/debounce.ts b/packages/graphiql-toolkit/src/utility/debounce.ts similarity index 100% rename from packages/graphiql-react/src/utility/debounce.ts rename to packages/graphiql-toolkit/src/utility/debounce.ts diff --git a/packages/graphiql-toolkit/src/zustand/editor.ts b/packages/graphiql-toolkit/src/zustand/editor.ts new file mode 100644 index 00000000000..fa9247c3dad --- /dev/null +++ b/packages/graphiql-toolkit/src/zustand/editor.ts @@ -0,0 +1,298 @@ +import { synchronizeActiveTabValues, TabState } from './tabs'; + +import { DocumentNode, OperationDefinitionNode } from 'graphql'; +import { VariableToType } from 'graphql-language-service'; + +import { + createTab, + getDefaultTabState, + setPropertiesInActiveTab, + TabsState, +} from './tabs'; + +import { CodeMirrorEditor } from '../codemirror/types'; + +import { GraphiQLState, ImmerStateCreator, UserOptions } from './store'; +import { DEFAULT_QUERY } from '../constants'; +import { produce } from 'immer'; + +export type CodeMirrorEditorWithOperationFacts = CodeMirrorEditor & { + documentAST: DocumentNode | null; + operationName: string | null; + operations: OperationDefinitionNode[] | null; + variableToType: VariableToType | null; +}; + +export type EditorState = { + /** + * The CodeMirror editor instance for the headers editor. + */ + headerEditor: CodeMirrorEditor | null; + /** + * The CodeMirror editor instance for the query editor. This editor also + * stores the operation facts that are derived from the current editor + * contents. + */ + queryEditor: CodeMirrorEditorWithOperationFacts | null; + /** + * The CodeMirror editor instance for the response editor. + */ + responseEditor: CodeMirrorEditor | null; + /** + * The CodeMirror editor instance for the variables editor. + */ + variableEditor: CodeMirrorEditor | null; + + tabsState: TabsState; +}; + +export type EditorStoreActions = { + /** + * Add a new tab. + */ + addTab(): void; + /** + * Switch to a different tab. + * @param index The index of the tab that should be switched to. + */ + changeTab(index: number): void; + /** + * Move a tab to a new spot. + * @param newOrder The new order for the tabs. + */ + moveTab(newOrder: TabState[]): void; + /** + * Close a tab. If the currently active tab is closed, the tab before it will + * become active. If there is no tab before the closed one, the tab after it + * will become active. + * @param index The index of the tab that should be closed. + */ + closeTab(index: number): void; + /** + * Update the state for the tab that is currently active. This will be + * reflected in the `tabs` object and the state will be persisted in storage + * (if available). + * @param partialTab A partial tab state object that will override the + * current values. The properties `id`, `hash` and `title` cannot be changed. + */ + updateActiveTabValues( + partialTab: Partial>, + ): void; + + /** + * Set the CodeMirror editor instance for the headers editor. + */ + setHeaderEditor(newEditor: CodeMirrorEditor): void; + /** + * Set the CodeMirror editor instance for the query editor. + */ + setQueryEditor(newEditor: CodeMirrorEditorWithOperationFacts): void; + /** + * Set the CodeMirror editor instance for the response editor. + */ + setResponseEditor(newEditor: CodeMirrorEditor): void; + /** + * Set the CodeMirror editor instance for the variables editor. + */ + setVariableEditor(newEditor: CodeMirrorEditor): void; + + /** + * Changes the operation name and invokes the `onEditOperationName` callback. + */ + setOperationName(operationName: string): void; + + /** + * Changes if headers should be persisted. + */ + setShouldPersistHeaders(persist: boolean): void; + /** + * Set the provided editor values to the cm editor state, for example, on tab change + */ + setEditorValues: (newEditorState: TabState) => void; + synchronizeActiveTabValues: (newEditorState: TabsState) => TabsState; +}; + +export type EditorSlice = EditorState & EditorStoreActions; + +export const getDefaultEditorState = (options?: UserOptions) => ({ + headerEditor: null, + queryEditor: null, + responseEditor: null, + variableEditor: null, + initialQuery: '', + initialResponse: '', + initialVariables: '', + initialHeaders: '', + shouldPersistHeaders: false, + tabsState: getDefaultTabState({ + defaultQuery: options?.defaultQuery ?? DEFAULT_QUERY, + defaultHeaders: '', + headers: null, + query: null, + variables: null, + storage: null, + shouldPersistHeaders: false, + }), + externalFragments: new Map(), + validationRules: [], +}); + +export const editorSlice = + (options?: UserOptions): ImmerStateCreator => + (set, get) => ({ + ...getDefaultEditorState(options), + setHeaderEditor(newEditor) { + set( + produce((state: GraphiQLState) => { + state.editor.headerEditor = newEditor; + }), + ); + }, + setQueryEditor(newEditor) { + set( + produce((state: GraphiQLState) => { + state.editor.queryEditor = newEditor; + }), + ); + }, + setResponseEditor(newEditor) { + set( + produce((state: GraphiQLState) => { + state.editor.responseEditor = newEditor; + }), + ); + }, + setVariableEditor(newEditor) { + set( + produce((state: GraphiQLState) => { + state.editor.variableEditor = newEditor; + }), + ); + }, + setOperationName(operationName) { + set( + produce((state: GraphiQLState) => { + if (state.editor.queryEditor) { + state.editor.queryEditor.operationName = operationName; + } + state.editor.updateActiveTabValues({ operationName }); + }), + ); + }, + setShouldPersistHeaders(persist) { + set( + produce((state: GraphiQLState) => { + state.options.shouldPersistHeaders = persist; + }), + ); + }, + updateActiveTabValues: partialTab => + set( + produce((state: GraphiQLState) => { + const updated = setPropertiesInActiveTab( + state.editor.tabsState, + partialTab, + ); + state.options.onTabChange?.(updated); + return updated; + }), + ), + + changeTab(index) { + set( + produce((state: GraphiQLState) => { + const updated = { + ...state.editor.tabsState, + activeTabIndex: index, + }; + console.log(updated, updated.tabs[updated.activeTabIndex]); + state.editor.setEditorValues(updated.tabs[updated.activeTabIndex]); + state.editor.tabsState = updated; + + state.options.onTabChange?.(updated); + }), + ); + }, + addTab: () => { + // Make sure the current tab stores the latest values + set( + produce((state: GraphiQLState) => { + const updatedValues = state.editor.synchronizeActiveTabValues( + state.editor.tabsState, + ); + const updated: TabsState = { + tabs: [ + ...updatedValues.tabs, + createTab({ + headers: state.options.defaultHeaders, + query: get().options.defaultQuery ?? DEFAULT_QUERY, + }), + ], + activeTabIndex: updatedValues.tabs.length, + }; + console.log(updated, updated.tabs[updated.activeTabIndex]); + state.editor.tabsState = updated; + + state.editor.setEditorValues(updated.tabs[updated.activeTabIndex]); + state.options.onTabChange?.(updated); + }), + ); + }, + moveTab(newOrder) { + set( + produce((state: GraphiQLState) => { + const updated = { + ...state.editor.tabsState, + tabs: newOrder, + }; + state.editor.tabsState = updated; + state.options.onTabChange?.(updated); + }), + ); + }, + closeTab(index) { + set( + produce((state: GraphiQLState) => { + const updated = { + ...state.editor.tabsState, + tabs: state.editor.tabsState.tabs.filter((_, i) => i !== index), + activeTabIndex: + state.editor.tabsState.activeTabIndex === index + ? Math.max(0, index - 1) + : state.editor.tabsState.activeTabIndex, + }; + state.editor.tabsState = updated; + state.editor.setEditorValues(updated.tabs[updated.activeTabIndex]); + state.options.onTabChange?.(updated); + }), + ); + }, + synchronizeActiveTabValues(newEditorState) { + const { queryEditor, variableEditor, headerEditor, responseEditor } = + get().editor; + return synchronizeActiveTabValues({ + queryEditor, + variableEditor, + headerEditor, + responseEditor, + currentState: newEditorState, + }); + }, + // TODO this is not passing the tab state where it should be, I missed something simple here! + // trying to get this and the above working without react hooks + setEditorValues(newEditorState) { + set( + produce((state: GraphiQLState) => { + const { queryEditor, variableEditor, headerEditor, responseEditor } = + state.editor; + + queryEditor?.setValue(newEditorState.query ?? ''); + variableEditor?.setValue(newEditorState.variables ?? ''); + headerEditor?.setValue( + newEditorState.headers ?? state.options.defaultHeaders ?? '', + ); + responseEditor?.setValue(newEditorState.response ?? ''); + }), + ); + }, + }); diff --git a/packages/graphiql-toolkit/src/zustand/execution.ts b/packages/graphiql-toolkit/src/zustand/execution.ts new file mode 100644 index 00000000000..68abf7a7473 --- /dev/null +++ b/packages/graphiql-toolkit/src/zustand/execution.ts @@ -0,0 +1,500 @@ +import { GraphiQLState, ImmerStateCreator } from './store'; + +import { + createGraphiQLFetcher, + Fetcher, + fillLeafs, + formatError, + formatResult, + isAsyncIterable, + isObservable, + Unsubscribable, +} from '../'; + +import { + ExecutionResult, + FragmentDefinitionNode, + GraphQLError, + print, +} from 'graphql'; +import { getFragmentDependenciesForAST } from 'graphql-language-service'; +import setValue from 'set-value'; +import getValue from 'get-value'; +import { produce } from 'immer'; + +export type ExecutionState = { + /** + * If there is currently a GraphQL request in-flight. For multi-part + * requests like subscriptions, this will be `true` while fetching the + * first partial response and `false` while fetching subsequent batches. + */ + isFetching: boolean; + /** + * If there is currently a GraphQL request in-flight. For multi-part + * requests like subscriptions, this will be `true` until the last batch + * has been fetched or the connection is closed from the client. + */ + isSubscribed: boolean; + + subscription: Unsubscribable | null; + /** + * The operation name that will be sent with all GraphQL requests. + */ + operationName: string | null; + + /** + * Start a Gr aphQL requests based of the current editor contents. + */ + run(): void; + /** + * Stop the GraphQL request that is currently in-flight. + */ + stop(): void; + autocompleteLeafs(): string | undefined; + fetcher: Fetcher; + queryId: number; +}; + +const pathsMap = new WeakMap< + ExecutionResult, + Map> +>(); + +function tryParseJsonObject({ + json, + errorMessageParse, + errorMessageType, +}: { + json: string | undefined; + errorMessageParse: string; + errorMessageType: string; +}) { + let parsed: Record | undefined; + try { + parsed = json && json.trim() !== '' ? JSON.parse(json) : undefined; + } catch (error) { + throw new Error( + `${errorMessageParse}: ${ + error instanceof Error ? error.message : error + }.`, + ); + } + const isObject = + typeof parsed === 'object' && parsed !== null && !Array.isArray(parsed); + if (parsed !== undefined && !isObject) { + throw new Error(errorMessageType); + } + return parsed; +} + +/** + * @param executionResult The complete execution result object which will be + * mutated by merging the contents of the incremental result. + * @param incrementalResult The incremental result that will be merged into the + * complete execution result. + */ +function mergeIncrementalResult( + executionResult: IncrementalResult, + incrementalResult: IncrementalResult, +): void { + let path: ReadonlyArray | undefined = [ + 'data', + ...(incrementalResult.path ?? []), + ]; + + for (const result of [executionResult, incrementalResult]) { + if (result.pending) { + let paths = pathsMap.get(executionResult); + if (paths === undefined) { + paths = new Map(); + pathsMap.set(executionResult, paths); + } + + for (const { id, path: pendingPath } of result.pending) { + paths.set(id, ['data', ...pendingPath]); + } + } + } + + const { items } = incrementalResult; + if (items) { + const { id } = incrementalResult; + if (id) { + path = pathsMap.get(executionResult)?.get(id); + if (path === undefined) { + throw new Error('Invalid incremental delivery format.'); + } + + const list = getValue(executionResult, path.join('.')); + list.push(...items); + } else { + path = ['data', ...(incrementalResult.path ?? [])]; + for (const item of items) { + setValue(executionResult, path.join('.'), item); + // Increment the last path segment (the array index) to merge the next item at the next index + // eslint-disable-next-line unicorn/prefer-at -- cannot mutate the array using Array.at() + (path[path.length - 1] as number)++; + } + } + } + + const { data } = incrementalResult; + if (data) { + const { id } = incrementalResult; + if (id) { + path = pathsMap.get(executionResult)?.get(id); + if (path === undefined) { + throw new Error('Invalid incremental delivery format.'); + } + const { subPath } = incrementalResult; + if (subPath !== undefined) { + path = [...path, ...subPath]; + } + } + setValue(executionResult, path.join('.'), data, { + merge: true, + }); + } + + if (incrementalResult.errors) { + executionResult.errors ||= []; + (executionResult.errors as GraphQLError[]).push( + ...incrementalResult.errors, + ); + } + + if (incrementalResult.extensions) { + setValue(executionResult, 'extensions', incrementalResult.extensions, { + merge: true, + }); + } + + if (incrementalResult.incremental) { + for (const incrementalSubResult of incrementalResult.incremental) { + mergeIncrementalResult(executionResult, incrementalSubResult); + } + } + + if (incrementalResult.completed) { + // Remove tracking and add additional errors + for (const { id, errors } of incrementalResult.completed) { + pathsMap.get(executionResult)?.delete(id); + + if (errors) { + executionResult.errors ||= []; + (executionResult.errors as GraphQLError[]).push(...errors); + } + } + } +} + +export const executionSlice: ImmerStateCreator = ( + set, + get, +) => ({ + isFetching: false, + isSubscribed: false, + operationName: null, + fetcher: createGraphiQLFetcher({ url: '/graphql' }), + subscription: null, + queryId: 0, + setFetcher: (fetcher: Fetcher) => { + set( + produce((state: GraphiQLState) => { + state.execution.fetcher = fetcher; + }), + ); + }, + + run: async () => { + const { queryEditor, responseEditor, variableEditor, headerEditor } = + get().editor; + if (!queryEditor || !responseEditor) { + return; + } + + const options = get().options; + + // If there's an active subscription, unsubscribe it and return + if (get().execution.subscription) { + stop(); + return; + } + + const setResponse = (value: string) => { + responseEditor.setValue(value); + get().editor.updateActiveTabValues({ response: value }); + }; + + set( + produce(state => { + state.execution.queryId += 1; + }), + ); + + const queryId = get().execution.queryId; + + // Use the edited query after autoCompleteLeafs() runs or, + // in case autoCompletion fails (the function returns undefined), + // the current query from the editor. + let query = get().execution.autocompleteLeafs() || queryEditor.getValue(); + + const variablesString = variableEditor?.getValue(); + let variables: Record | undefined; + try { + variables = tryParseJsonObject({ + json: variablesString, + errorMessageParse: 'Variables are invalid JSON', + errorMessageType: 'Variables are not a JSON object.', + }); + } catch (error) { + setResponse(error instanceof Error ? error.message : `${error}`); + return; + } + + const headersString = headerEditor?.getValue(); + let headers: Record | undefined; + try { + headers = tryParseJsonObject({ + json: headersString, + errorMessageParse: 'Headers are invalid JSON', + errorMessageType: 'Headers are not a JSON object.', + }); + } catch (error) { + setResponse(error instanceof Error ? error.message : `${error}`); + return; + } + + if (options.externalFragments) { + const fragmentDependencies = queryEditor.documentAST + ? getFragmentDependenciesForAST( + queryEditor.documentAST, + options.externalFragments, + ) + : []; + if (fragmentDependencies.length > 0) { + query += + '\n' + + fragmentDependencies + .map((node: FragmentDefinitionNode) => print(node)) + .join('\n'); + } + } + set( + produce((state: GraphiQLState) => { + state.execution.isFetching = true; + }), + ); + setResponse(''); + + const opName = + get().execution.operationName ?? queryEditor.operationName ?? undefined; + + // TODO: move this to a plugin later + // history?.addToHistory({ + // query, + // variables: variablesString, + // headers: headersString, + // operationName: opName, + // }); + + try { + const fullResponse: ExecutionResult = {}; + const handleResponse = (result: ExecutionResult) => { + // A different query was dispatched in the meantime, so don't + // show the results of this one. + if (queryId !== get().execution.queryId) { + return; + } + + let maybeMultipart = Array.isArray(result) ? result : false; + if ( + !maybeMultipart && + typeof result === 'object' && + result !== null && + 'hasNext' in result + ) { + maybeMultipart = [result]; + } + + if (maybeMultipart) { + for (const part of maybeMultipart) { + mergeIncrementalResult(fullResponse, part); + } + set( + produce(state => { + state.execution.isFetching = false; + }), + ); + setResponse(formatResult(fullResponse)); + } else { + const response = formatResult(result); + set( + produce(state => { + state.execution.isFetching = false; + }), + ); + setResponse(response); + } + }; + + const fetch = options.fetcher( + { + query, + variables, + operationName: opName, + }, + { + headers: headers ?? undefined, + documentAST: queryEditor.documentAST ?? undefined, + }, + ); + + const value = await Promise.resolve(fetch); + if (isObservable(value)) { + // If the fetcher returned an Observable, then subscribe to it, calling + // the callback on each next value, and handling both errors and the + // completion of the Observable. + set( + produce((state: GraphiQLState) => { + state.execution.subscription = value.subscribe({ + next(result) { + handleResponse(result); + }, + error(error: Error) { + set( + produce((state: GraphiQLState) => { + state.execution.isFetching = false; + state.execution.subscription = null; + }), + ); + + if (error) { + setResponse(formatError(error)); + } + }, + complete() { + set( + produce((state: GraphiQLState) => { + state.execution.isFetching = false; + state.execution.subscription = null; + }), + ); + }, + }); + }), + ); + } else if (isAsyncIterable(value)) { + set( + produce((state: GraphiQLState) => { + state.execution.subscription = { + unsubscribe: () => value[Symbol.asyncIterator]().return?.(), + }; + }), + ); + + for await (const result of value) { + handleResponse(result); + } + set( + produce((state: GraphiQLState) => { + state.execution.isFetching = false; + }), + ); + set( + produce((state: GraphiQLState) => { + state.execution.isFetching = false; + state.execution.subscription = null; + }), + ); + } else { + handleResponse(value); + } + } catch (error) { + set( + produce((state: GraphiQLState) => { + state.execution.isFetching = true; + state.execution.isSubscribed = false; + }), + ); + setResponse(formatError(error)); + } + }, + stop: () => { + set( + produce((state: GraphiQLState) => { + state.execution.isFetching = false; + }), + ); + }, + autocompleteLeafs: () => { + let completionResult: string | undefined; + set(state => { + const { schema } = state.schema; + const { queryEditor } = state.editor; + + if (!queryEditor) { + return; + } + + const query = queryEditor.getValue(); + const { insertions, result } = fillLeafs( + // @ts-expect-error WriteableDraft error + schema, + query, + get().options.getDefaultFieldNames, + ); + completionResult = result; + if (insertions && insertions.length > 0) { + queryEditor.operation(() => { + const cursor = queryEditor.getCursor(); + const cursorIndex = queryEditor.indexFromPos(cursor); + queryEditor.setValue(result || ''); + let added = 0; + const markers = insertions.map(({ index, string }) => + queryEditor.markText( + queryEditor.posFromIndex(index + added), + queryEditor.posFromIndex(index + (added += string.length)), + { + className: 'auto-inserted-leaf', + clearOnEnter: true, + title: 'Automatically added leaf fields', + }, + ), + ); + setTimeout(() => { + for (const marker of markers) { + marker.clear(); + } + }, 7000); + let newCursorIndex = cursorIndex; + for (const { index, string } of insertions) { + if (index < cursorIndex) { + newCursorIndex += string.length; + } + } + queryEditor.setCursor(queryEditor.posFromIndex(newCursorIndex)); + }); + } + }); + return completionResult; + }, +}); + +type IncrementalResult = { + data?: Record | null; + errors?: ReadonlyArray; + extensions?: Record; + hasNext?: boolean; + path?: ReadonlyArray; + incremental?: ReadonlyArray; + label?: string; + items?: ReadonlyArray> | null; + pending?: ReadonlyArray<{ id: string; path: ReadonlyArray }>; + completed?: ReadonlyArray<{ + id: string; + errors?: ReadonlyArray; + }>; + id?: string; + subPath?: ReadonlyArray; +}; diff --git a/packages/graphiql-toolkit/src/zustand/files.ts b/packages/graphiql-toolkit/src/zustand/files.ts new file mode 100644 index 00000000000..12ef5fdbcb3 --- /dev/null +++ b/packages/graphiql-toolkit/src/zustand/files.ts @@ -0,0 +1,46 @@ +import { ImmerStateCreator } from './store'; + +type fileNames = + | 'operations.graphql' + | 'variables.json' + | 'headers.json' + | 'results.json'; + +type tabFileScheme = `/tabs/${number}/${fileNames}`; + +type historyFileScheme = `/history/${string}/${fileNames}`; + +type File = { + value: string; + createdAt: number; + updatedAt: number; +}; + +type GraphiQLFileScheme = tabFileScheme | historyFileScheme; + +export type FilesState = { + files: Map; +}; + +export const fileSlice: ImmerStateCreator = set => ({ + files: new Map(), + addFile: (path: GraphiQLFileScheme, value: string) => { + set(state => { + state.files.files.set(path, { + value, + createdAt: Date.now(), + updatedAt: Date.now(), + }); + }); + }, + updateFile: (key: GraphiQLFileScheme, value: string) => { + set(state => { + const file = state.files.files.get(key); + if (file) { + file.value = value; + file.updatedAt = Date.now(); + state.files.files.set(key, file); + } + }); + }, +}); diff --git a/packages/graphiql-toolkit/src/zustand/options.ts b/packages/graphiql-toolkit/src/zustand/options.ts new file mode 100644 index 00000000000..766072fec23 --- /dev/null +++ b/packages/graphiql-toolkit/src/zustand/options.ts @@ -0,0 +1,263 @@ +import { FragmentDefinitionNode, GraphQLSchema, ValidationRule } from 'graphql'; +import { TabDefinition, TabsState } from './tabs'; +import { GraphiQLState, ImmerStateCreator } from './store'; +import { + createGraphiQLFetcher, + Fetcher, + CreateFetcherOptions, +} from '../create-fetcher'; +import { GetDefaultFieldNamesFn } from '../graphql-helpers'; +import { DEFAULT_QUERY } from '../constants'; +import { produce } from 'immer'; + +/** + * TODO: I like grouping these options and unioning the types, + * but I think it won't be unified with typedoc + */ + +export type IntrospectionOptions = { + /** + * Can be used to set the equally named option for introspecting a GraphQL + * server. + * @default false + * @see {@link https://github.com/graphql/graphql-js/blob/main/src/utilities/getIntrospectionQuery.ts|Utility for creating the introspection query} + */ + inputValueDeprecation?: boolean; + /** + * Can be used to set a custom operation name for the introspection query. + */ + introspectionQueryName?: string; + /** + * Can be used to set the equally named option for introspecting a GraphQL + * server. + * @default false + * @see {@link https://github.com/graphql/graphql-js/blob/main/src/utilities/getIntrospectionQuery.ts|Utility for creating the introspection query} + */ + schemaDescription?: boolean; +}; + +// you can supply either or neither of these options, never both +export type FetcherOptions = + | { + /** + * The fetcher function that is used to send the request to the server. + * See the `createGraphiQLFetcher` function for an example of a fetcher + * TODO: link to fetcher documentation + */ + fetcher?: Fetcher; + } + | { + /** + * config to pass to the fetcher. overrides fetcher if provided. + */ + fetchOptions?: CreateFetcherOptions; + }; + +type GeneralUserOptions = { + /** + * The current theme of the editor. + */ + editorTheme: string; + /** + * The current key map of the editor. + */ + keyMap: 'sublime' | 'emacs' | 'vim'; + /** + * Whether the editor is read-only. + */ + readOnly: boolean; + + defaultQuery?: string; + defaultHeaders?: string; + /** + * The contents of the headers editor when initially rendering the provider + * component. + */ + initialHeaders: string; + /** + * The contents of the query editor when initially rendering the provider + * component. + */ + initialQuery: string; + /** + * The contents of the response editor when initially rendering the provider + * component. + */ + initialResponse: string; + /** + * The contents of the variables editor when initially rendering the provider + * component. + */ + initialVariables: string; + + /** + * A map of fragment definitions using the fragment name as key which are + * made available to include in the query. + */ + externalFragments: Map; + /** + * A list of custom validation rules that are run in addition to the rules + * provided by the GraphQL spec. + */ + validationRules: ValidationRule[]; + + /** + * If the contents of the headers editor are persisted in storage. + */ + shouldPersistHeaders: boolean; + + /** + * This can be used to set the contents of the headers editor. Every + * time this changes, the contents of the headers editor are replaced. + * Note that the editor contents can be changed in between these updates by + * typing in the editor. + */ + headers?: string; + /** + * This can be used to define the default set of tabs, with their + * queries, variables, and headers. It will be used as default only if + * there is no tab state persisted in storage. + */ + defaultTabs?: TabDefinition[]; + + /** + * Optionally provide the schema directly. Disables the schema introspection request. + */ + schema: GraphQLSchema | null; + + /** + * This prop can be used to skip validating the GraphQL schema. This applies + * to both schemas fetched via introspection and schemas explicitly passed + * via the `schema` prop. + * + * IMPORTANT NOTE: Without validating the schema, GraphiQL and its components + * are vulnerable to numerous exploits and might break. Only use this prop if + * you have full control over the schema passed to GraphiQL. + * + * @default false + */ + dangerouslyAssumeSchemaIsValid?: boolean; + + /** + * optional custom storage key for the graphiql state - will determine the name of the idb storage + */ + + storageKeyPrefix?: string; + /** + * Provide a custom storage API. + * @default `localStorage` + * @see {@link https://graphiql-test.netlify.app/typedoc/modules/graphiql_toolkit.html#storage-2|API docs} + * for details on the required interface. + */ + storage?: Storage; + /** + * A function to determine which field leafs are automatically added when + * trying to execute a query with missing selection sets. It will be called + * with the `GraphQLType` for which fields need to be added. + */ + getDefaultFieldNames?: GetDefaultFieldNamesFn; + + onTabChange?: (tabs: TabsState) => void; + onSchemaChange?: (schema: GraphQLSchema) => void; + + /** + * Invoked when the operation name changes. Possible triggers are: + * - Editing the contents of the query editor + * - Selecting a operation for execution in a document that contains multiple + * operation definitions + * @param operationName The operation name after it has been changed. + */ + onEditOperationName?(operationName: string): void; +}; + +export type OptionsState = GeneralUserOptions & + FetcherOptions & + IntrospectionOptions & { fetcher: Fetcher }; + +export type UserOptions = Partial & + FetcherOptions & + IntrospectionOptions; + +export type OptionsStateActions = { + /** + * Configure the options state with the provided options, patching the previous config + */ + configure(options: UserOptions): void; + + /** + * Set the options state with the provided options, resetting other options to defaults + */ + setConfig(options: UserOptions): void; +}; + +// new fallback default allows no fetcher to be supplied +// and uses the conventional relative /graphql path +const defaultFetcher = createGraphiQLFetcher({ url: '/graphql' }); + +export type GraphiQLStoreOptions = OptionsState; + +export type OptionsSlice = OptionsState & + // fetcher is always present, just not required + OptionsStateActions; + +export const defaultOptionsState = { + editorTheme: 'graphiql', + keyMap: 'sublime', + readOnly: false, + initialQuery: '', + initialResponse: '', + initialVariables: '', + initialHeaders: '', + externalFragments: new Map(), + validationRules: [], + shouldPersistHeaders: false, + defaultQuery: DEFAULT_QUERY, + schema: null, + fetcher: defaultFetcher, +} as OptionsState; + +function mapOptionsToState(options: UserOptions) { + let fetcher: Fetcher; + if ('fetchOptions' in options && options.fetchOptions) { + fetcher = createGraphiQLFetcher(options.fetchOptions); + } else if ('fetcher' in options && options.fetcher) { + fetcher = options.fetcher; + } else { + fetcher = defaultFetcher; + } + + return { + ...options, + fetcher, + }; +} + +type SliceWithOptions = ( + options?: UserOptions, +) => ImmerStateCreator; + +export const optionsSlice: SliceWithOptions = userOpts => set => { + console.log({ userOpts }); + return { + ...defaultOptionsState, + ...mapOptionsToState(userOpts ? userOpts : {}), + configure: (options: UserOptions) => { + set( + produce((state: GraphiQLState) => { + Object.assign(state.options, mapOptionsToState(options)); + }), + ); + }, + setConfig: (options: UserOptions) => { + set( + produce((state: GraphiQLState) => { + state.options = { + ...Object.assign(defaultOptionsState, mapOptionsToState(options)), + configure: state.options.configure, + setConfig: state.options.setConfig, + }; + }), + ); + }, + }; +}; diff --git a/packages/graphiql-toolkit/src/zustand/schema.ts b/packages/graphiql-toolkit/src/zustand/schema.ts new file mode 100644 index 00000000000..152bc1767fc --- /dev/null +++ b/packages/graphiql-toolkit/src/zustand/schema.ts @@ -0,0 +1,306 @@ +import { + Fetcher, + FetcherOpts, + fetcherReturnToPromise, + formatError, + formatResult, + isPromise, +} from '../'; +import { + buildClientSchema, + getIntrospectionQuery, + GraphQLError, + GraphQLSchema, + IntrospectionQuery, + isSchema, + validateSchema, +} from 'graphql'; + +import { GraphiQLState, ImmerStateCreator } from './store'; +import { IntrospectionOptions } from './options'; +import { produce } from 'immer'; + +type MaybeGraphQLSchema = GraphQLSchema | null | undefined; + +export type SchemaState = { + /** + * Stores an error raised during introspecting or building the GraphQL schema + * from the introspection result. + */ + fetchError: string | null; + + /** + * If there currently is an introspection request in-flight. + */ + isFetching: boolean; + /** + * The current GraphQL schema. + */ + schema: MaybeGraphQLSchema; + /** + * A list of errors from validating the current GraphQL schema. The schema is + * valid if and only if this list is empty. + */ + validationErrors: readonly GraphQLError[]; + + requestCounter: number; +}; + +export type SchemaStateActions = { + /** + * Trigger introspection and schema building. + * This should be called on your framework's mount event, + * such as in a useEffect with empty dependencies in react + */ + didMount(): void; + /** + * Trigger building the GraphQL schema. This might trigger an introspection + * request if no schema is passed via props and if using a schema is not + * explicitly disabled by passing `null` as value for the `schema` prop. If + * there is a schema (either fetched using introspection or passed via props) + * it will be validated, unless this is explicitly skipped using the + * `dangerouslyAssumeSchemaIsValid` prop. + */ + introspect(): void; +}; + +export type SchemaSlice = SchemaState & SchemaStateActions; + +export const defaultSchemaState: SchemaState = { + isFetching: false, + fetchError: null, + schema: null, + validationErrors: [], + requestCounter: 0, +}; + +export const schemaSlice: ImmerStateCreator< + SchemaState & SchemaStateActions +> = (set, get) => ({ + ...defaultSchemaState, + + didMount: () => { + set( + produce((state: GraphiQLState) => { + state.schema.isFetching = true; + state.schema.introspect(); + }), + ); + }, + introspect: () => { + const options = get().options; + if (isSchema(options.schema) || options.schema === null) { + return; + } + + /** + * Only introspect if there is no schema provided via props. If the + * prop is passed an introspection result, we do continue but skip the + * introspection request. + */ + set( + produce((state: GraphiQLState) => { + state.schema.requestCounter++; + }), + ); + + const counter = get().schema.requestCounter; + + const maybeIntrospectionData = options.schema; + + const { + introspectionQuery, + introspectionQueryName, + introspectionQuerySansSubscriptions, + } = loadIntrospectionQuery({ + introspectionQueryName: options.introspectionQueryName, + }); + + async function fetchIntrospectionData() { + if (maybeIntrospectionData) { + // No need to introspect if we already have the data + return maybeIntrospectionData; + } + + const parsedHeaders = parseHeaderString(options.initialHeaders); + if (!parsedHeaders.isValidJSON) { + set( + produce((state: GraphiQLState) => { + state.schema.fetchError = + 'Introspection failed as headers are invalid.'; + }), + ); + + return; + } + + const fetcherOpts: FetcherOpts = parsedHeaders.headers + ? { headers: parsedHeaders.headers } + : {}; + + const fetcher = options.fetcher as Fetcher; + + const fetch = fetcherReturnToPromise( + fetcher( + { + query: introspectionQuery, + operationName: introspectionQueryName, + }, + fetcherOpts, + ), + ); + + if (!isPromise(fetch)) { + set( + produce((state: GraphiQLState) => { + state.schema.fetchError = + 'Fetcher did not return a Promise for introspection.'; + }), + ); + return; + } + + set( + produce((state: GraphiQLState) => { + state.schema.isFetching = true; + state.schema.fetchError = null; + }), + ); + + let result = await fetch; + + if ( + typeof result !== 'object' || + result === null || + !('data' in result) + ) { + // Try the stock introspection query first, falling back on the + // sans-subscriptions query for services which do not yet support it. + const fetch2 = fetcherReturnToPromise( + fetcher( + { + query: introspectionQuerySansSubscriptions, + operationName: introspectionQueryName, + }, + fetcherOpts, + ), + ); + if (!isPromise(fetch2)) { + throw new Error( + 'Fetcher did not return a Promise for introspection.', + ); + } + result = await fetch2; + } + + set( + produce((state: GraphiQLState) => { + state.schema.isFetching = false; + }), + ); + + if (result?.data && '__schema' in result.data) { + return result.data as IntrospectionQuery; + } + + // handle as if it were an error if the fetcher response is not a string or response.data is not present + const responseString = + typeof result === 'string' ? result : formatResult(result); + + set( + produce((state: GraphiQLState) => { + state.schema.fetchError = `Invalid introspection result: ${responseString}`; + }), + ); + } + + fetchIntrospectionData() + .then(introspectionData => { + /** + * Don't continue if another introspection request has been started in + * the meantime or if there is no introspection data. + */ + if (counter !== get().schema.requestCounter || !introspectionData) { + return; + } + + try { + const newSchema = ( + '__schema' in introspectionData + ? buildClientSchema(introspectionData) + : introspectionData + ) as GraphQLSchema; + + set( + produce((state: GraphiQLState) => { + state.schema.schema = newSchema; + state.schema.validationErrors = validateSchema(newSchema); + }), + ); + + options.onSchemaChange?.(newSchema); + } catch (error) { + set( + produce((state: GraphiQLState) => { + state.schema.fetchError = formatError(error); + state.schema.isFetching = false; + }), + ); + } + }) + .catch(error => { + /** + * Don't continue if another introspection request has been started in + * the meantime. + */ + if (counter !== get().schema.requestCounter) { + return; + } + + set( + produce((state: GraphiQLState) => { + state.schema.fetchError = formatError(error); + state.schema.isFetching = false; + }), + ); + }); + }, +}); + +function loadIntrospectionQuery({ + inputValueDeprecation, + introspectionQueryName, + schemaDescription, +}: IntrospectionOptions) { + const queryName = introspectionQueryName || 'IntrospectionQuery'; + + let query = getIntrospectionQuery({ + inputValueDeprecation, + schemaDescription, + }); + if (introspectionQueryName) { + query = query.replace('query IntrospectionQuery', `query ${queryName}`); + } + + const querySansSubscriptions = query.replace('subscriptionType { name }', ''); + + return { + introspectionQueryName: queryName, + introspectionQuery: query, + introspectionQuerySansSubscriptions: querySansSubscriptions, + }; +} + +function parseHeaderString(headersString: string | undefined) { + let headers: Record | null = null; + let isValidJSON = true; + + try { + if (headersString) { + headers = JSON.parse(headersString); + } + } catch { + isValidJSON = false; + } + return { headers, isValidJSON }; +} diff --git a/packages/graphiql-toolkit/src/zustand/storage/idb-store.ts b/packages/graphiql-toolkit/src/zustand/storage/idb-store.ts new file mode 100644 index 00000000000..1a2da962979 --- /dev/null +++ b/packages/graphiql-toolkit/src/zustand/storage/idb-store.ts @@ -0,0 +1,17 @@ +import { del, get, set, createStore } from 'idb-keyval'; +import { StateStorage } from 'zustand/middleware'; + +export const createStorage = (appName: string): StateStorage => { + const customStore = createStore(appName, 'data'); + return { + getItem: async (name: string): Promise => { + return (await get(name, customStore)) || null; + }, + setItem: async (name: string, value: string): Promise => { + await set(name, value, customStore); + }, + removeItem: async (name: string): Promise => { + await del(name, customStore); + }, + }; +}; diff --git a/packages/graphiql-toolkit/src/zustand/store.ts b/packages/graphiql-toolkit/src/zustand/store.ts new file mode 100644 index 00000000000..92c1087d7c3 --- /dev/null +++ b/packages/graphiql-toolkit/src/zustand/store.ts @@ -0,0 +1,110 @@ +import { enableMapSet, produce } from 'immer'; + +import { StateCreator, createStore } from 'zustand/vanilla'; +import { createJSONStorage, devtools, persist } from 'zustand/middleware'; +import { immer } from 'zustand/middleware/immer'; + +import { executionSlice, ExecutionState } from './execution'; +export type { UserOptions } from './options'; + +import { OptionsSlice, optionsSlice, UserOptions } from './options'; +import { EditorSlice, editorSlice } from './editor'; +import { fileSlice, FilesState } from './files'; +import { SchemaSlice, schemaSlice } from './schema'; +import { createStorage } from './storage/idb-store'; + +export type GraphiQLState = { + files: FilesState; + execution: ExecutionState; + editor: EditorSlice; + options: OptionsSlice; + schema: SchemaSlice; +}; + +enableMapSet(); + +const middlewares = ( + fn: ImmerStateCreator, + options?: UserOptions, +) => { + const storage = + options?.storage ?? createStorage(options?.storageKeyPrefix ?? 'graphiql'); + return createStore()( + immer( + devtools( + fn, + // TODO: more issues with persist middleware + // persist(fn, { + // storage: createJSONStorage(() => storage), + // name: 'graphiql', + // onRehydrateStorage: state => { + // return { + // ...state, + // editor: { + // ...state, + + // } + // } + // // partialize: state => { + // // const { + // // editor: { + // // queryEditor, + // // variableEditor, + // // headerEditor, + // // responseEditor, + // // ...editorState + // // }, + // // } = state; + // // console.log(state); + // // return { + // // editor: editorState, + // // }; + // // }, + // }), + ), + ), + ); +}; + +export const createGraphiQLStore = (options?: UserOptions) => { + return middlewares((...args) => ({ + options: optionsSlice(options)(...args), + // TODO: files slices are not yet used by editor slice (or any slice) yet. + // let's get everything working first + files: fileSlice(...args), + execution: executionSlice(...args), + editor: editorSlice(options)(...args), + schema: schemaSlice(...args), + })); +}; + +export const produceState = ( + callback: (state: T) => void, +): ReturnType => { + return produce(callback); +}; + +// Utilities + +export type ImmerStateCreator = StateCreator< + GraphiQLState, + [['zustand/immer', never], never], + [], + T +>; + +// // TODO: adopt this pattern in the rest of the codebase? +// // also look into useShallow +// type WithSelectors = S extends { getState: () => infer T } +// ? S & { use: { [K in keyof T]: () => T[K] } } +// : never; + +// export const createSelectors = >(_store: S) => { +// const store = _store as WithSelectors; +// store.use = {}; +// for (const k of Object.keys(store.getState())) { +// (store.use as any)[k] = () => useStore(_store, s => s[k as keyof typeof s]); +// } + +// return store; +// }; diff --git a/packages/graphiql-toolkit/src/zustand/tabs.ts b/packages/graphiql-toolkit/src/zustand/tabs.ts new file mode 100644 index 00000000000..43abe375c4d --- /dev/null +++ b/packages/graphiql-toolkit/src/zustand/tabs.ts @@ -0,0 +1,372 @@ +import { StorageAPI } from '../'; +import { useCallback, useMemo } from 'react'; + +import debounce from '../utility/debounce'; +import { + CodeMirrorEditor, + CodeMirrorEditorWithOperationFacts, +} from '../codemirror/types'; + +export type TabDefinition = { + /** + * The contents of the query editor of this tab. + */ + query: string | null; + /** + * The contents of the variable editor of this tab. + */ + variables: string | null; + /** + * The contents of the headers editor of this tab. + */ + headers: string | null; +}; + +/** + * This object describes the state of a single tab. + */ +export type TabState = TabDefinition & { + /** + * A GUID value generated when the tab was created. + */ + id: string; + /** + * A hash that is unique for a combination of the contents of the query + * editor, the variable editor and the header editor (i.e. all the editor + * where the contents are persisted in storage). + */ + hash: string; + /** + * The title of the tab shown in the tab element. + */ + title: string; + /** + * The operation name derived from the contents of the query editor of this + * tab. + */ + operationName: string | null; + /** + * The contents of the response editor of this tab. + */ + response: string | null; +}; + +/** + * This object describes the state of all tabs. + */ +export type TabsState = { + /** + * A list of state objects for each tab. + */ + tabs: TabState[]; + /** + * The index of the currently active tab with regards to the `tabs` list of + * this object. + */ + activeTabIndex: number; +}; + +export function getDefaultTabState({ + defaultQuery, + defaultHeaders, + headers, + defaultTabs, + query, + variables, + storage, + shouldPersistHeaders, +}: { + defaultQuery: string; + defaultHeaders?: string; + headers: string | null; + defaultTabs?: TabDefinition[]; + query: string | null; + variables: string | null; + storage: StorageAPI | null; + shouldPersistHeaders?: boolean; +}) { + const storedState = storage?.get(STORAGE_KEY); + try { + if (!storedState) { + throw new Error('Storage for tabs is empty'); + } + const parsed = JSON.parse(storedState); + // if headers are not persisted, do not derive the hash using default headers state + // or else you will get new tabs on every refresh + const headersForHash = shouldPersistHeaders ? headers : undefined; + if (isTabsState(parsed)) { + const expectedHash = hashFromTabContents({ + query, + variables, + headers: headersForHash, + }); + let matchingTabIndex = -1; + + for (let index = 0; index < parsed.tabs.length; index++) { + const tab = parsed.tabs[index]; + tab.hash = hashFromTabContents({ + query: tab.query, + variables: tab.variables, + headers: tab.headers, + }); + if (tab.hash === expectedHash) { + matchingTabIndex = index; + } + } + + if (matchingTabIndex >= 0) { + parsed.activeTabIndex = matchingTabIndex; + } else { + const operationName = query ? fuzzyExtractOperationName(query) : null; + parsed.tabs.push({ + id: guid(), + hash: expectedHash, + title: operationName || DEFAULT_TITLE, + query, + variables, + headers, + operationName, + response: null, + }); + parsed.activeTabIndex = parsed.tabs.length - 1; + } + + return parsed; + } + throw new Error('Storage for tabs is invalid'); + } catch { + return { + activeTabIndex: 0, + tabs: ( + defaultTabs || [ + { + query: query ?? defaultQuery, + variables, + headers: headers ?? defaultHeaders, + }, + ] + ).map(createTab), + }; + } +} + +function isTabsState(obj: any): obj is TabsState { + return ( + obj && + typeof obj === 'object' && + !Array.isArray(obj) && + hasNumberKey(obj, 'activeTabIndex') && + 'tabs' in obj && + Array.isArray(obj.tabs) && + obj.tabs.every(isTabState) + ); +} + +function isTabState(obj: any): obj is TabState { + // We don't persist the hash, so we skip the check here + return ( + obj && + typeof obj === 'object' && + !Array.isArray(obj) && + hasStringKey(obj, 'id') && + hasStringKey(obj, 'title') && + hasStringOrNullKey(obj, 'query') && + hasStringOrNullKey(obj, 'variables') && + hasStringOrNullKey(obj, 'headers') && + hasStringOrNullKey(obj, 'operationName') && + hasStringOrNullKey(obj, 'response') + ); +} + +function hasNumberKey(obj: Record, key: string) { + return key in obj && typeof obj[key] === 'number'; +} + +function hasStringKey(obj: Record, key: string) { + return key in obj && typeof obj[key] === 'string'; +} + +function hasStringOrNullKey(obj: Record, key: string) { + return key in obj && (typeof obj[key] === 'string' || obj[key] === null); +} + +export function synchronizeActiveTabValues({ + currentState, + queryEditor, + variableEditor, + headerEditor, + responseEditor, +}: { + currentState: TabsState; + queryEditor: CodeMirrorEditorWithOperationFacts | null; + variableEditor: CodeMirrorEditor | null; + headerEditor: CodeMirrorEditor | null; + responseEditor: CodeMirrorEditor | null; +}) { + const query = queryEditor?.getValue() ?? null; + const variables = variableEditor?.getValue() ?? null; + const headers = headerEditor?.getValue() ?? null; + const operationName = queryEditor?.operationName ?? null; + const response = responseEditor?.getValue() ?? null; + return setPropertiesInActiveTab(currentState, { + query, + variables, + headers, + response, + operationName, + }); +} + +export function serializeTabState( + tabState: TabsState, + shouldPersistHeaders = false, +) { + return JSON.stringify(tabState, (key, value) => + key === 'hash' || + key === 'response' || + (!shouldPersistHeaders && key === 'headers') + ? null + : value, + ); +} + +export function useStoreTabs({ + storage, + shouldPersistHeaders, +}: { + storage: StorageAPI | null; + shouldPersistHeaders?: boolean; +}) { + const store = useMemo( + () => + debounce(500, (value: string) => { + storage?.set(STORAGE_KEY, value); + }), + [storage], + ); + return useCallback( + (currentState: TabsState) => { + store(serializeTabState(currentState, shouldPersistHeaders)); + }, + [shouldPersistHeaders, store], + ); +} + +export function useSetEditorValues({ + queryEditor, + variableEditor, + headerEditor, + responseEditor, + defaultHeaders, +}: { + queryEditor: CodeMirrorEditorWithOperationFacts | null; + variableEditor: CodeMirrorEditor | null; + headerEditor: CodeMirrorEditor | null; + responseEditor: CodeMirrorEditor | null; + defaultHeaders?: string; +}) { + return useCallback( + ({ + query, + variables, + headers, + response, + }: { + query: string | null; + variables?: string | null; + headers?: string | null; + response: string | null; + }) => { + queryEditor?.setValue(query ?? ''); + variableEditor?.setValue(variables ?? ''); + headerEditor?.setValue(headers ?? defaultHeaders ?? ''); + responseEditor?.setValue(response ?? ''); + }, + [headerEditor, queryEditor, responseEditor, variableEditor, defaultHeaders], + ); +} + +export function createTab({ + query = null, + variables = null, + headers = null, +}: Partial = {}): TabState { + return { + id: guid(), + hash: hashFromTabContents({ query, variables, headers }), + title: (query && fuzzyExtractOperationName(query)) || DEFAULT_TITLE, + query, + variables, + headers, + operationName: null, + response: null, + }; +} + +export function setPropertiesInActiveTab( + state: TabsState, + partialTab: Partial>, +): TabsState { + return { + ...state, + tabs: state.tabs.map((tab, index) => { + if (index !== state.activeTabIndex) { + return tab; + } + const newTab = { ...tab, ...partialTab }; + return { + ...newTab, + hash: hashFromTabContents(newTab), + title: + newTab.operationName || + (newTab.query + ? fuzzyExtractOperationName(newTab.query) + : undefined) || + DEFAULT_TITLE, + }; + }), + }; +} + +function guid(): string { + const s4 = () => { + return Math.floor((1 + Math.random()) * 0x10000) + .toString(16) + .slice(1); + }; + // return id of format 'aaaaaaaa'-'aaaa'-'aaaa'-'aaaa'-'aaaaaaaaaaaa' + return `${s4()}${s4()}-${s4()}-${s4()}-${s4()}-${s4()}${s4()}${s4()}`; +} + +function hashFromTabContents(args: { + query: string | null; + variables?: string | null; + headers?: string | null; +}): string { + return [args.query ?? '', args.variables ?? '', args.headers ?? ''].join('|'); +} + +export function fuzzyExtractOperationName(str: string): string | null { + const regex = /^(?!#).*(query|subscription|mutation)\s+([a-zA-Z0-9_]+)/m; + + const match = regex.exec(str); + + return match?.[2] ?? null; +} + +export function clearHeadersFromTabs(storage: StorageAPI | null) { + const persistedTabs = storage?.get(STORAGE_KEY); + if (persistedTabs) { + const parsedTabs = JSON.parse(persistedTabs); + storage?.set( + STORAGE_KEY, + JSON.stringify(parsedTabs, (key, value) => + key === 'headers' ? null : value, + ), + ); + } +} + +const DEFAULT_TITLE = ''; + +export const STORAGE_KEY = 'tabState'; diff --git a/packages/graphiql/src/components/GraphiQL.tsx b/packages/graphiql/src/components/GraphiQL.tsx index 58d035e6e4a..e20c53d75cf 100644 --- a/packages/graphiql/src/components/GraphiQL.tsx +++ b/packages/graphiql/src/components/GraphiQL.tsx @@ -54,6 +54,7 @@ import { UseHeaderEditorArgs, useMergeQuery, usePluginContext, + useOptionsContext, usePrettifyEditors, UseQueryEditorArgs, UseResponseEditorArgs, @@ -65,6 +66,7 @@ import { WriteableEditorProps, isMacOs, } from '@graphiql/react'; +import { Fetcher } from '@graphiql/toolkit'; const majorVersion = parseInt(version.slice(0, 2), 10); @@ -84,7 +86,7 @@ if (majorVersion < 16) { * https://graphiql-test.netlify.app/typedoc/modules/graphiql.html#graphiqlprops */ export type GraphiQLProps = Omit & - GraphiQLInterfaceProps; + GraphiQLInterfaceProps & { fetcher: Fetcher }; /** * The top-level React component for GraphiQL, intended to encompass the entire @@ -242,9 +244,10 @@ const TAB_CLASS_PREFIX = 'graphiql-session-tab-'; export function GraphiQLInterface(props: GraphiQLInterfaceProps) { const isHeadersEditorEnabled = props.isHeadersEditorEnabled ?? true; - const editorContext = useEditorContext({ nonNull: true }); - const executionContext = useExecutionContext({ nonNull: true }); - const schemaContext = useSchemaContext({ nonNull: true }); + const editorContext = useEditorContext(); + const optionsContext = useOptionsContext(); + const executionContext = useExecutionContext(); + const schemaContext = useSchemaContext(); const storageContext = useStorageContext(); const pluginContext = usePluginContext(); const forcedTheme = useMemo( @@ -297,7 +300,7 @@ export function GraphiQLInterface(props: GraphiQLInterfaceProps) { return props.defaultEditorToolsVisibility ? undefined : 'second'; } - return editorContext.initialVariables || editorContext.initialHeaders + return optionsContext.initialVariables || optionsContext.initialHeaders ? undefined : 'second'; })(), @@ -314,8 +317,8 @@ export function GraphiQLInterface(props: GraphiQLInterfaceProps) { ) { return props.defaultEditorToolsVisibility; } - return !editorContext.initialVariables && - editorContext.initialHeaders && + return !optionsContext.initialVariables && + optionsContext.initialHeaders && isHeadersEditorEnabled ? 'headers' : 'variables'; @@ -482,7 +485,7 @@ export function GraphiQLInterface(props: GraphiQLInterfaceProps) { return; } - if (editorContext.activeTabIndex === index) { + if (editorContext.tabsState.activeTabIndex === index) { executionContext.stop(); } editorContext.closeTab(index); @@ -584,15 +587,15 @@ export function GraphiQLInterface(props: GraphiQLInterfaceProps) {
- {editorContext.tabs.map((tab, index, tabs) => ( + {editorContext.tabsState.tabs.map((tab, index, tabs) => (
@@ -805,7 +808,9 @@ export function GraphiQLInterface(props: GraphiQLInterfaceProps) {