fix: typings for GraphQLError on the client (#12464)

mattkrick · web-flow · commit 2d83bfbab1ab · 2025-12-17T11:52:47.000-08:00
Signed-off-by: Matt Krick &lt;matt.krick@gmail.com&gt;
diff --git a/packages/client/Atmosphere.ts b/packages/client/Atmosphere.ts
@@ -17,6 +17,7 @@ import {
   type NormalizationLinkedField,
   Observable,
   type OperationType,
+  type PayloadError,
   RecordSource,
   RelayFeatureFlags,
   type RequestParameters,
@@ -187,10 +188,10 @@ export default class Atmosphere extends Environment {
     return Observable.create<GraphQLResponse>((sink) => {
       const _next = sink.next
       const _error = sink.error
-      sink.error = (error: Error | Error[] | CloseEvent) => {
+      sink.error = (error: Error | Error[] | CloseEvent | PayloadError) => {
         if (Array.isArray(error)) {
           const invalidSessionError = error.find(
-            (e) => (e as any).extensions?.code === 'SESSION_INVALIDATED'
+            (e) => (e as PayloadError).extensions?.code === 'SESSION_INVALIDATED'
           )
           if (invalidSessionError) {
             this.invalidateSession(invalidSessionError.message)
diff --git a/packages/client/client.tsx b/packages/client/client.tsx
@@ -1,7 +1,6 @@
 import {render} from 'react-dom'
 import Root from './Root'
 import './scrollIntoViewIfNeeded'
-import './types/modules.d'
 
 render(<Root />, document.getElementById('root'))
 if (__PRODUCTION__ && 'serviceWorker' in navigator) {
diff --git a/packages/client/modules/pages/PageAccessCombobox.tsx b/packages/client/modules/pages/PageAccessCombobox.tsx
@@ -45,7 +45,7 @@ export const PageAccessCombobox = (props: Props) => {
       onCompleted(_res, errors) {
         const firstError = errors?.[0]
         if (firstError) {
-          if ((firstError as any).extensions?.code === 'UNAPPROVED_UNLINK') {
+          if (firstError.extensions?.code === 'UNAPPROVED_UNLINK') {
             setAttemptedRole(role)
             return
           }
diff --git a/packages/client/modules/pages/RequestPageAccess.tsx b/packages/client/modules/pages/RequestPageAccess.tsx
@@ -40,7 +40,7 @@ export const RequestPageAccess = (props: Props) => {
       onCompleted: (_result, errors) => {
         const firstError = errors?.[0]
         if (firstError) {
-          const code = (firstError as any).extensions?.code
+          const code = firstError.extensions?.code
           if (code === 'NOT_FOUND') {
             atmosphere.eventEmitter.emit('addSnackbar', {
               message: 'Page not found',
diff --git a/packages/client/polyfills.ts b/packages/client/polyfills.ts
@@ -1,5 +1,3 @@
-import './types/modules.d'
-
 if (__PRODUCTION__) {
   __webpack_public_path__ = window.__ACTION__.publicPath
 }
diff --git a/packages/client/serviceWorker/modules.d.ts b/packages/client/serviceWorker/modules.d.ts
diff --git a/packages/client/types/reactHTML4.d.ts b/packages/client/types/reactHTML4.d.ts
diff --git a/packages/client/types/shared.d.ts b/packages/client/types/shared.d.ts
diff --git a/packages/client/utils/relay/getGraphQLError.ts b/packages/client/utils/relay/getGraphQLError.ts
@@ -1,4 +1,4 @@
-import type {PayloadError} from 'relay-runtime/lib/network/RelayNetworkTypes'
+import type {PayloadError} from 'relay-runtime'
 
 const getServerError = (errors: ReadonlyArray<PayloadError> | null | undefined) =>
   (errors && errors[0]) || undefined
diff --git a/packages/embedder/inferLanguage.ts b/packages/embedder/inferLanguage.ts
@@ -1,4 +1,4 @@
-import franc from 'franc-min'
+import {franc} from 'franc-min'
 import {type ISO6391, iso6393To1} from './iso6393To1'
 import {URLRegex} from './regex'
 
diff --git a/packages/embedder/types/modules.d.ts b/packages/embedder/types/modules.d.ts
diff --git a/packages/embedder/types/shared.d.ts b/packages/embedder/types/shared.d.ts
diff --git a/packages/mattermost-plugin/types/modules.d.ts b/packages/mattermost-plugin/types/modules.d.ts
diff --git a/packages/server/graphql/public/types/User.ts b/packages/server/graphql/public/types/User.ts
@@ -44,8 +44,6 @@ import {pageInsights} from '../fields/pageInsights'
 import getSignOnURL from '../mutations/helpers/SAMLHelpers/getSignOnURL'
 import type {ReqResolvers} from './ReqResolvers'
 
-declare const __PRODUCTION__: string
-
 const MODEL = 'Embeddings_ember_1'
 const EMBED_URL = (() => {
   try {
diff --git a/packages/server/initPublicPath.ts b/packages/server/initPublicPath.ts
@@ -1,8 +1,5 @@
 import appOrigin from './appOrigin'
 
-declare let __webpack_public_path__: string
-declare const __PRODUCTION__: boolean
-
 const {CDN_BASE_URL, SOCKET_PORT} = process.env
 
 if (CDN_BASE_URL) {
diff --git a/packages/server/types/custom.d.ts b/packages/server/types/custom.d.ts
@@ -1,19 +1,5 @@
-import 'react'
 import type ScheduledJobMeetingStageTimeLimit from '../database/types/ScheduledJobMetingStageTimeLimit'
 import type ScheduledTeamLimitsJob from '../database/types/ScheduledTeamLimitsJob'
-declare module 'react' {
-  interface TdHTMLAttributes<_T> {
-    height?: string | number
-    width?: string | number
-    bgcolor?: string
-  }
-  interface TableHTMLAttributes<_T> {
-    align?: 'center' | 'left' | 'right'
-    bgcolor?: string
-    height?: string | number
-    width?: string | number
-  }
-}
 
 export interface OAuth2Success {
   access_token: string
diff --git a/packages/server/types/modules.d.ts b/packages/server/types/modules.d.ts
diff --git a/packages/types/augments/index.d.ts b/packages/types/augments/index.d.ts
@@ -0,0 +1,50 @@
+// globally declare this so other declaration files can reference this
+// if a declaration files calls import, then it is regarded as an ESModule and the scope
+// of the declaration is limited to that module, instead of being hoisted globally
+type ParabolGraphQLErrorCodes =
+  | 'MAX_PAGE_DEPTH_REACHED'
+  | 'NOT_FOUND'
+  | 'SESSION_INVALIDATED'
+  | 'TOO_MANY_REQUESTS'
+  | 'UNAPPROVED_UNLINK'
+  | 'UNAUTHORIZED'
+
+declare module 'graphql' {
+  interface GraphQLErrorExtensions {
+    code?: ParabolGraphQLErrorCodes
+  }
+}
+
+declare module 'relay-runtime' {
+  interface PayloadError extends Error {
+    message: string
+    locations?:
+      | Array<{
+          line: number
+          column: number
+        }>
+      | undefined
+    path?: Array<string | number>
+    extensions?: {
+      code?: ParabolGraphQLErrorCodes
+    }
+  }
+}
+
+declare module 'react' {
+  interface TdHTMLAttributes<_T> {
+    height?: string | number
+    width?: string | number
+    bgcolor?: string
+  }
+  interface TableHTMLAttributes<_T> {
+    align?: 'center' | 'left' | 'right'
+    bgcolor?: string
+    height?: string | number
+    width?: string | number
+  }
+}
+
+// Adding this tells typescript this is an ESModule which means the declarations in this file will get merged
+// with the modules, instead of overwrite them
+export {}
diff --git a/packages/types/globals/index.d.ts b/packages/types/globals/index.d.ts
@@ -1,5 +1,3 @@
-// this is just to get typescript to stop complaining about imports
-// declare module '*'
 declare module '*.jpeg'
 declare module '*.jpg'
 declare module '*.png' {
@@ -9,19 +7,32 @@ declare module '*.png' {
 declare module '*.svg'
 declare module '*.mp3'
 declare module '*.woff2'
-declare module 'json2csv/lib/JSON2CSVParser'
-declare module 'string-score'
+
 declare module 'babel-plugin-relay/macro' {
   export {graphql as default} from 'react-relay'
 }
+
+declare module '*.graphql' {
+  const value: string
+  export = value
+}
+
 declare module 'react-textarea-autosize'
 declare module 'react-copy-to-clipboard'
-declare module 'tayden-clusterfck'
 declare module 'react/jsx-runtime'
+declare module '@authenio/samlify-node-xmllint'
+declare module 'node-env-flag'
+declare module '*getProjectRoot'
+declare module 'tayden-clusterfck'
+declare module 'jest-extended'
+declare module 'object-hash'
+declare module 'string-score'
+declare module 'md-to-adf'
 
 declare let __webpack_public_path__: string
-declare const __PRODUCTION__: string
+declare const __PRODUCTION__: boolean
 declare const __APP_VERSION__: string
+
 interface Window {
   __ACTION__: {
     atlassian: string
diff --git a/scripts/toolboxSrc/applyEnvVarsToClientAssets.ts b/scripts/toolboxSrc/applyEnvVarsToClientAssets.ts
@@ -6,8 +6,6 @@ import logo192 from '../../static/images/brand/mark-cropped-192.png'
 import logo512 from '../../static/images/brand/mark-cropped-512.png'
 import getProjectRoot from '../webpack/utils/getProjectRoot'
 
-declare const __webpack_public_path__: string
-
 const PROJECT_ROOT = getProjectRoot()
 const clientDir = path.join(PROJECT_ROOT, 'build')
 
diff --git a/tsconfig.base.json b/tsconfig.base.json
@@ -1,5 +1,6 @@
 {
   "compilerOptions": {
+    "typeRoots": ["./node_modules/@types", "./packages/types"],
     // allowJs causes some bugs using ts-loader, if we decide to use that in the future
     // "allowJs": true,
     "checkJs": false,

Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ export const PageAccessCombobox = (props: Props) => {`
`45`	`45`	`onCompleted(_res, errors) {`
`46`	`46`	`const firstError = errors?.[0]`
`47`	`47`	`if (firstError) {`
`48`		`- if ((firstError as any).extensions?.code === 'UNAPPROVED_UNLINK') {`
	`48`	`+ if (firstError.extensions?.code === 'UNAPPROVED_UNLINK') {`
`49`	`49`	`setAttemptedRole(role)`
`50`	`50`	`return`
`51`	`51`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-import './types/modules.d'`
`2`		`-`
`3`	`1`	`if (__PRODUCTION__) {`
`4`	`2`	`__webpack_public_path__ = window.__ACTION__.publicPath`
`5`	`3`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import type {PayloadError} from 'relay-runtime/lib/network/RelayNetworkTypes'`
	`1`	`+import type {PayloadError} from 'relay-runtime'`
`2`	`2`
`3`	`3`	`const getServerError = (errors: ReadonlyArray<PayloadError> \| null \| undefined) =>`
`4`	`4`	`(errors && errors[0]) \|\| undefined`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import franc from 'franc-min'`
	`1`	`+import {franc} from 'franc-min'`
`2`	`2`	`import {type ISO6391, iso6393To1} from './iso6393To1'`
`3`	`3`	`import {URLRegex} from './regex'`
`4`	`4`