@sanity/sdk-react 3.0.0-rc.0 → 3.0.0-rc.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (160) hide show
  1. package/README.md +103 -155
  2. package/dist/index.d.ts +1564 -682
  3. package/dist/index.js +1118 -612
  4. package/dist/index.js.map +1 -1
  5. package/package.json +51 -54
  6. package/src/_exports/index.ts +2 -4
  7. package/src/_exports/sdk-react.ts +26 -17
  8. package/src/components/SDKProvider.test.tsx +173 -32
  9. package/src/components/SDKProvider.tsx +87 -28
  10. package/src/components/SanityApp.test.tsx +68 -12
  11. package/src/components/SanityApp.tsx +94 -87
  12. package/src/components/auth/AuthBoundary.recovery.test.tsx +86 -0
  13. package/src/components/auth/AuthBoundary.test.tsx +26 -8
  14. package/src/components/auth/AuthBoundary.tsx +28 -6
  15. package/src/components/auth/DashboardAccessRequest.tsx +37 -0
  16. package/src/components/auth/LoginError.test.tsx +191 -5
  17. package/src/components/auth/LoginError.tsx +103 -59
  18. package/src/components/errors/ChunkLoadError.test.tsx +59 -0
  19. package/src/components/errors/ChunkLoadError.tsx +56 -0
  20. package/src/components/errors/CorsErrorComponent.tsx +2 -2
  21. package/src/components/errors/chunkReloadStorage.ts +57 -0
  22. package/src/config/handles.ts +29 -27
  23. package/src/constants.ts +5 -0
  24. package/src/context/ComlinkTokenRefresh.test.tsx +10 -27
  25. package/src/context/DefaultResourceContext.ts +3 -3
  26. package/src/context/OrganizationResourcesProvider.test.tsx +189 -0
  27. package/src/context/OrganizationResourcesProvider.tsx +111 -0
  28. package/src/context/PerspectiveContext.ts +3 -3
  29. package/src/context/ProjectContext.ts +15 -0
  30. package/src/context/ResourceProvider.test.tsx +72 -90
  31. package/src/context/ResourceProvider.tsx +59 -93
  32. package/src/context/SDKStudioContext.test.tsx +28 -33
  33. package/src/context/SanityInstanceProvider.test.tsx +100 -0
  34. package/src/context/SanityInstanceProvider.tsx +71 -0
  35. package/src/context/WorkbenchTokenRefresh.test.tsx +106 -0
  36. package/src/context/WorkbenchTokenRefresh.tsx +61 -0
  37. package/src/context/renderSanityApp.test.tsx +151 -49
  38. package/src/context/renderSanityApp.tsx +12 -8
  39. package/src/context/workbenchToken.ts +63 -0
  40. package/src/hooks/access/useCheckPermissions.test-d.ts +15 -0
  41. package/src/hooks/access/useCheckPermissions.test.tsx +53 -0
  42. package/src/hooks/access/useCheckPermissions.ts +24 -0
  43. package/src/hooks/agent/agentActions.test.tsx +1 -1
  44. package/src/hooks/agent/agentActions.ts +51 -71
  45. package/src/hooks/applications/useApplication.test-d.ts +30 -0
  46. package/src/hooks/applications/useApplication.ts +22 -0
  47. package/src/hooks/applications/useApplications.test-d.ts +31 -0
  48. package/src/hooks/applications/useApplications.ts +25 -0
  49. package/src/hooks/applications/useCreateUserApplication.test-d.ts +14 -0
  50. package/src/hooks/applications/useCreateUserApplication.ts +11 -0
  51. package/src/hooks/applications/useDeleteApplication.test-d.ts +12 -0
  52. package/src/hooks/applications/useDeleteApplication.ts +11 -0
  53. package/src/hooks/applications/useDeleteUserApplication.test-d.ts +14 -0
  54. package/src/hooks/applications/useDeleteUserApplication.ts +11 -0
  55. package/src/hooks/applications/useUpdateApplication.test-d.ts +12 -0
  56. package/src/hooks/applications/useUpdateApplication.ts +11 -0
  57. package/src/hooks/applications/useUpdateUserApplication.test-d.ts +14 -0
  58. package/src/hooks/applications/useUpdateUserApplication.ts +11 -0
  59. package/src/hooks/applications/useUserApplication.test-d.ts +11 -0
  60. package/src/hooks/applications/useUserApplication.ts +14 -0
  61. package/src/hooks/applications/useUserApplications.test-d.ts +11 -0
  62. package/src/hooks/applications/useUserApplications.ts +14 -0
  63. package/src/hooks/auth/useDashboardOrganizationId.test.tsx +2 -8
  64. package/src/hooks/auth/useVerifyOrgProjects.test.tsx +8 -32
  65. package/src/hooks/auth/useVerifyOrgProjects.tsx +13 -6
  66. package/src/hooks/client/useClient.test.tsx +1 -4
  67. package/src/hooks/client/useClient.ts +1 -0
  68. package/src/hooks/context/useResource.test.tsx +32 -0
  69. package/src/hooks/context/useResource.ts +24 -0
  70. package/src/hooks/context/useSanityInstance.test.tsx +72 -3
  71. package/src/hooks/context/useSanityInstance.ts +30 -8
  72. package/src/hooks/dashboard/useManageFavorite.test.tsx +110 -46
  73. package/src/hooks/dashboard/useManageFavorite.ts +10 -16
  74. package/src/hooks/dashboard/useNavigateToStudioDocument.test.ts +5 -7
  75. package/src/hooks/dashboard/useNavigateToStudioDocument.ts +2 -6
  76. package/src/hooks/dashboard/useRecordDocumentHistoryEvent.test.ts +0 -2
  77. package/src/hooks/dashboard/useRecordDocumentHistoryEvent.ts +1 -2
  78. package/src/hooks/dashboard/useWindowTitle.test.ts +244 -0
  79. package/src/hooks/dashboard/useWindowTitle.ts +114 -0
  80. package/src/hooks/datasets/useDatasets.test.tsx +116 -0
  81. package/src/hooks/datasets/useDatasets.ts +33 -13
  82. package/src/hooks/document/useApplyDocumentActions.test.tsx +48 -0
  83. package/src/hooks/document/useApplyDocumentActions.ts +66 -48
  84. package/src/hooks/document/useCreateDocument.test.tsx +83 -0
  85. package/src/hooks/document/useCreateDocument.ts +117 -0
  86. package/src/hooks/document/useDocument.test.tsx +37 -8
  87. package/src/hooks/document/useDocument.ts +131 -66
  88. package/src/hooks/document/useDocumentEvent.test.tsx +16 -4
  89. package/src/hooks/document/useDocumentEvent.ts +16 -10
  90. package/src/hooks/document/useDocumentPermissions.test.tsx +8 -7
  91. package/src/hooks/document/useDocumentPermissions.ts +71 -39
  92. package/src/hooks/document/useDocumentSyncStatus.test.ts +1 -0
  93. package/src/hooks/document/useDocumentSyncStatus.ts +13 -9
  94. package/src/hooks/document/useEditDocument.test.tsx +21 -14
  95. package/src/hooks/document/useEditDocument.ts +163 -17
  96. package/src/hooks/documents/useDocuments.test.tsx +64 -44
  97. package/src/hooks/documents/useDocuments.ts +36 -20
  98. package/src/hooks/helpers/createCallbackHook.test.tsx +13 -19
  99. package/src/hooks/helpers/createFetcherHook.test.tsx +180 -0
  100. package/src/hooks/helpers/createFetcherHook.ts +69 -0
  101. package/src/hooks/helpers/createMutationHook.test.tsx +125 -0
  102. package/src/hooks/helpers/createMutationHook.tsx +93 -0
  103. package/src/hooks/helpers/createStateSourceHook.test.tsx +10 -10
  104. package/src/hooks/helpers/createStateSourceHook.tsx +2 -1
  105. package/src/hooks/{document/useApplyDocumentActions.test.ts → helpers/useApplyActions.test.tsx} +92 -53
  106. package/src/hooks/helpers/useApplyActions.ts +68 -0
  107. package/src/hooks/helpers/useNormalizedResourceOptions.test.tsx +253 -0
  108. package/src/hooks/helpers/useNormalizedResourceOptions.ts +92 -50
  109. package/src/hooks/helpers/useResolvedProjectId.test.tsx +59 -0
  110. package/src/hooks/helpers/useResolvedProjectId.ts +35 -0
  111. package/src/hooks/helpers/useTrackHookUsage.ts +37 -0
  112. package/src/hooks/installations/useInstallation.test-d.ts +19 -0
  113. package/src/hooks/installations/useInstallation.ts +22 -0
  114. package/src/hooks/installations/useInstallations.test-d.ts +26 -0
  115. package/src/hooks/installations/useInstallations.ts +25 -0
  116. package/src/hooks/organizations/useOrganization.test-d.ts +60 -0
  117. package/src/hooks/organizations/useOrganization.test.ts +63 -0
  118. package/src/hooks/organizations/useOrganization.ts +34 -0
  119. package/src/hooks/organizations/useOrganizations.test-d.ts +68 -0
  120. package/src/hooks/organizations/useOrganizations.test.ts +63 -0
  121. package/src/hooks/organizations/useOrganizations.ts +39 -0
  122. package/src/hooks/paginatedDocuments/usePaginatedDocuments.test.tsx +34 -27
  123. package/src/hooks/paginatedDocuments/usePaginatedDocuments.ts +40 -22
  124. package/src/hooks/presence/usePresence.test.tsx +0 -15
  125. package/src/hooks/presence/usePresence.ts +9 -20
  126. package/src/hooks/preview/useDocumentPreview.test.tsx +0 -1
  127. package/src/hooks/preview/useDocumentPreview.tsx +10 -8
  128. package/src/hooks/projection/useDocumentProjection.test.tsx +78 -9
  129. package/src/hooks/projection/useDocumentProjection.ts +81 -2
  130. package/src/hooks/projects/useProject.test-d.ts +56 -0
  131. package/src/hooks/projects/useProject.test.tsx +120 -0
  132. package/src/hooks/projects/useProject.ts +42 -43
  133. package/src/hooks/projects/useProjects.test-d.ts +60 -0
  134. package/src/hooks/projects/useProjects.test.ts +45 -98
  135. package/src/hooks/projects/useProjects.ts +19 -26
  136. package/src/hooks/query/useQuery.test.tsx +6 -5
  137. package/src/hooks/query/useQuery.ts +91 -9
  138. package/src/hooks/releases/useActiveReleases.test.tsx +13 -7
  139. package/src/hooks/releases/useActiveReleases.ts +28 -24
  140. package/src/hooks/releases/useAllReleases.test.tsx +93 -0
  141. package/src/hooks/releases/useAllReleases.ts +62 -0
  142. package/src/hooks/releases/useApplyReleaseActions.test.tsx +66 -0
  143. package/src/hooks/releases/useApplyReleaseActions.ts +82 -0
  144. package/src/hooks/releases/usePerspective.test.tsx +18 -10
  145. package/src/hooks/releases/usePerspective.ts +13 -17
  146. package/src/hooks/users/useUser.test.tsx +3 -9
  147. package/src/hooks/users/useUser.ts +2 -0
  148. package/src/hooks/users/useUsers.test.tsx +103 -7
  149. package/src/hooks/users/useUsers.ts +37 -3
  150. package/src/utils/resolveOrgResources.test.ts +111 -0
  151. package/src/utils/resolveOrgResources.ts +69 -0
  152. package/src/hooks/context/useDefaultResource.test.tsx +0 -25
  153. package/src/hooks/context/useDefaultResource.ts +0 -30
  154. package/src/hooks/dashboard/useDispatchIntent.test.ts +0 -254
  155. package/src/hooks/dashboard/useDispatchIntent.ts +0 -157
  156. package/src/hooks/dashboard/utils/useResourceIdFromDocumentHandle.test.ts +0 -107
  157. package/src/hooks/dashboard/utils/useResourceIdFromDocumentHandle.ts +0 -39
  158. package/src/hooks/datasets/useDatasets.test.ts +0 -66
  159. package/src/hooks/helpers/useNormalizedResourceOptions.test.ts +0 -65
  160. package/src/hooks/projects/useProject.test.ts +0 -79
@@ -0,0 +1,37 @@
1
+ import {SDK_CHANNEL_NAME, SDK_NODE_NAME} from '@sanity/message-protocol'
2
+ import {useEffect} from 'react'
3
+
4
+ import {useWindowConnection} from '../../hooks/comlink/useWindowConnection'
5
+
6
+ interface DashboardAccessRequestProps {
7
+ projectId: string
8
+ }
9
+
10
+ /**
11
+ * Sends a `dashboard/v1/auth/access/request` message to the dashboard via
12
+ * comlink so the user can request access to a project they don't belong to.
13
+ *
14
+ * This is intentionally isolated in its own component because
15
+ * `useWindowConnection` suspends until a comlink node is available, which
16
+ * never happens outside the dashboard. Callers must gate rendering on
17
+ * `getIsInDashboardState(...).getCurrent()` and wrap this in a
18
+ * {@link https://react.dev/reference/react/Suspense | Suspense} boundary
19
+ * so the suspension stays local instead of bubbling up to the app shell.
20
+ *
21
+ * @internal
22
+ */
23
+ export function DashboardAccessRequest({projectId}: DashboardAccessRequestProps): null {
24
+ const {fetch} = useWindowConnection({
25
+ name: SDK_NODE_NAME,
26
+ connectTo: SDK_CHANNEL_NAME,
27
+ })
28
+
29
+ useEffect(() => {
30
+ fetch('dashboard/v1/auth/access/request', {
31
+ resourceType: 'project',
32
+ resourceId: projectId,
33
+ })
34
+ }, [fetch, projectId])
35
+
36
+ return null
37
+ }
@@ -1,19 +1,51 @@
1
+ import {ClientError} from '@sanity/client'
2
+ import {getIsInDashboardState} from '@sanity/sdk'
1
3
  import {fireEvent, render, screen, waitFor} from '@testing-library/react'
2
- import {describe, expect, it, vi} from 'vitest'
4
+ import {afterEach, beforeEach, describe, expect, it, type Mock, vi} from 'vitest'
3
5
 
4
6
  import {ResourceProvider} from '../../context/ResourceProvider'
5
7
  import {AuthError} from './AuthError'
6
8
  import {LoginError} from './LoginError'
7
9
 
10
+ vi.mock('@sanity/sdk', async () => {
11
+ const actual = await vi.importActual('@sanity/sdk')
12
+ return {
13
+ ...actual,
14
+ getIsInDashboardState: vi.fn(() => ({getCurrent: vi.fn(() => false)})),
15
+ }
16
+ })
17
+
18
+ const mockLogout = vi.fn(async () => {})
8
19
  vi.mock('../../hooks/auth/useLogOut', () => ({
9
- useLogOut: vi.fn(() => async () => {}),
20
+ useLogOut: vi.fn(() => mockLogout),
10
21
  }))
11
22
 
23
+ const mockWindowConnectionFetch = vi.fn()
12
24
  vi.mock('../../hooks/comlink/useWindowConnection', () => ({
13
- useWindowConnection: vi.fn(() => ({fetch: vi.fn()})),
25
+ useWindowConnection: vi.fn(() => ({fetch: mockWindowConnectionFetch})),
14
26
  }))
15
27
 
28
+ const mockGetIsInDashboardState = getIsInDashboardState as Mock
29
+
30
+ function makeClientError(statusCode: number, body: unknown): ClientError {
31
+ return new ClientError({
32
+ statusCode,
33
+ headers: {},
34
+ body,
35
+ url: 'https://example.test',
36
+ method: 'GET',
37
+ } as ConstructorParameters<typeof ClientError>[0])
38
+ }
39
+
16
40
  describe('LoginError', () => {
41
+ beforeEach(() => {
42
+ mockGetIsInDashboardState.mockReturnValue({getCurrent: vi.fn(() => false)})
43
+ })
44
+
45
+ afterEach(() => {
46
+ vi.clearAllMocks()
47
+ })
48
+
17
49
  it('shows authentication error and retry button', async () => {
18
50
  const mockReset = vi.fn()
19
51
  const error = new AuthError(new Error('Test error'))
@@ -38,7 +70,6 @@ describe('LoginError', () => {
38
70
  const mockReset = vi.fn()
39
71
  const nonAuthError = new Error('Non-auth error')
40
72
 
41
- // Suppress console.error during this test
42
73
  const consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(() => {})
43
74
 
44
75
  expect(() => {
@@ -49,6 +80,161 @@ describe('LoginError', () => {
49
80
  )
50
81
  }).toThrow('Non-auth error')
51
82
 
52
- consoleErrorSpy.mockRestore() // Restore original console.error behavior
83
+ consoleErrorSpy.mockRestore()
84
+ })
85
+
86
+ // In a standalone app (not embedded in the dashboard) the dashboard access
87
+ // request path must not render, because useWindowConnection would suspend
88
+ // waiting for a comlink node that never arrives.
89
+ it('renders synchronously on a 401 projectUserNotFound error outside the dashboard', async () => {
90
+ mockGetIsInDashboardState.mockReturnValue({getCurrent: vi.fn(() => false)})
91
+
92
+ const error = makeClientError(401, {
93
+ error: {
94
+ type: 'projectUserNotFoundError',
95
+ description: 'User is not a member of this project.',
96
+ },
97
+ })
98
+
99
+ render(
100
+ <ResourceProvider fallback={<div>SUSPENDED</div>}>
101
+ <LoginError error={error} resetErrorBoundary={vi.fn()} />
102
+ </ResourceProvider>,
103
+ )
104
+
105
+ await waitFor(() => {
106
+ expect(screen.getByText('User is not a member of this project.')).toBeInTheDocument()
107
+ })
108
+ // ClientError must render under the "Authentication Error" heading; it is
109
+ // not a ConfigurationError.
110
+ expect(screen.getByText('Authentication Error')).toBeInTheDocument()
111
+ expect(screen.queryByText('Configuration Error')).not.toBeInTheDocument()
112
+ expect(screen.queryByText('SUSPENDED')).not.toBeInTheDocument()
113
+ expect(mockWindowConnectionFetch).not.toHaveBeenCalled()
114
+ })
115
+
116
+ it('fires the dashboard access request on a 401 projectUserNotFound error inside the dashboard', async () => {
117
+ mockGetIsInDashboardState.mockReturnValue({getCurrent: vi.fn(() => true)})
118
+
119
+ const error = makeClientError(401, {
120
+ error: {
121
+ type: 'projectUserNotFoundError',
122
+ description: 'User is not a member of this project.',
123
+ },
124
+ })
125
+
126
+ render(
127
+ <ResourceProvider projectId="abc123" dataset="production" fallback={<div>SUSPENDED</div>}>
128
+ <LoginError error={error} resetErrorBoundary={vi.fn()} />
129
+ </ResourceProvider>,
130
+ )
131
+
132
+ await waitFor(() => {
133
+ expect(mockWindowConnectionFetch).toHaveBeenCalledWith('dashboard/v1/auth/access/request', {
134
+ resourceType: 'project',
135
+ resourceId: 'abc123',
136
+ })
137
+ })
138
+ })
139
+
140
+ // Mirrors the real production chain: AuthBoundary wraps the ClientError in
141
+ // an AuthError before the error boundary hands it to LoginError. The
142
+ // `.cause` unwrap is what makes the dashboard access request path reachable
143
+ // at runtime (without it, the previous `error instanceof ClientError` check
144
+ // was dead code in the dashboard).
145
+ it('fires the dashboard access request when the projectUserNotFound ClientError is wrapped in an AuthError', async () => {
146
+ mockGetIsInDashboardState.mockReturnValue({getCurrent: vi.fn(() => true)})
147
+
148
+ const clientError = makeClientError(401, {
149
+ error: {
150
+ type: 'projectUserNotFoundError',
151
+ description: 'User is not a member of this project.',
152
+ },
153
+ })
154
+ const error = new AuthError(clientError)
155
+ const mockReset = vi.fn()
156
+
157
+ render(
158
+ <ResourceProvider projectId="abc123" dataset="production" fallback={<div>SUSPENDED</div>}>
159
+ <LoginError error={error} resetErrorBoundary={mockReset} />
160
+ </ResourceProvider>,
161
+ )
162
+
163
+ await waitFor(() => {
164
+ expect(mockWindowConnectionFetch).toHaveBeenCalledWith('dashboard/v1/auth/access/request', {
165
+ resourceType: 'project',
166
+ resourceId: 'abc123',
167
+ })
168
+ })
169
+
170
+ expect(screen.getByText('Authentication Error')).toBeInTheDocument()
171
+ expect(screen.getByText('User is not a member of this project.')).toBeInTheDocument()
172
+ // projectUserNotFound intentionally hides the Retry CTA: the user can't
173
+ // fix it by retrying, only by getting access granted through the
174
+ // dashboard access request flow above.
175
+ expect(screen.queryByRole('button', {name: 'Retry'})).not.toBeInTheDocument()
176
+ // Dashboard flow must never auto-log-out; ComlinkTokenRefreshProvider is
177
+ // responsible for any token mutation, not LoginError.
178
+ expect(mockLogout).not.toHaveBeenCalled()
179
+ expect(mockReset).not.toHaveBeenCalled()
180
+ })
181
+
182
+ // In a standalone app, an invalid-token 401 (anything other than
183
+ // `projectUserNotFoundError`) should silently log the user out so that
184
+ // AuthBoundary's LOGGED_OUT effect redirects to the Sanity login URL.
185
+ // AuthBoundary wraps the real ClientError in an AuthError before it reaches
186
+ // the error boundary, so the component must unwrap `.cause` to see it.
187
+ it('auto-logs-out on a non-projectUserNotFound 401 outside the dashboard', async () => {
188
+ mockGetIsInDashboardState.mockReturnValue({getCurrent: vi.fn(() => false)})
189
+
190
+ const mockReset = vi.fn()
191
+ const clientError = makeClientError(401, {
192
+ error: {type: 'someOther401Type', description: 'Token is invalid'},
193
+ })
194
+ const error = new AuthError(clientError)
195
+
196
+ render(
197
+ <ResourceProvider fallback={null}>
198
+ <LoginError error={error} resetErrorBoundary={mockReset} />
199
+ </ResourceProvider>,
200
+ )
201
+
202
+ expect(screen.getByText('Authentication Error')).toBeInTheDocument()
203
+ expect(await screen.findByText('Signing you out and returning to login...')).toBeInTheDocument()
204
+ await waitFor(() => {
205
+ expect(mockLogout).toHaveBeenCalled()
206
+ })
207
+ await waitFor(() => {
208
+ expect(mockReset).toHaveBeenCalled()
209
+ })
210
+ })
211
+
212
+ // In the dashboard we must not auto-log-out on a generic 401.
213
+ // ComlinkTokenRefreshProvider is responsible for asking the parent window
214
+ // for a fresh token; the Retry button stays as a manual fallback.
215
+ it('does not auto-log-out on a non-projectUserNotFound 401 inside the dashboard', async () => {
216
+ mockGetIsInDashboardState.mockReturnValue({getCurrent: vi.fn(() => true)})
217
+
218
+ const mockReset = vi.fn()
219
+ const clientError = makeClientError(401, {
220
+ error: {type: 'someOther401Type', description: 'Token is invalid'},
221
+ })
222
+ const error = new AuthError(clientError)
223
+
224
+ render(
225
+ <ResourceProvider projectId="abc123" dataset="production" fallback={null}>
226
+ <LoginError error={error} resetErrorBoundary={mockReset} />
227
+ </ResourceProvider>,
228
+ )
229
+
230
+ expect(screen.getByText('Authentication Error')).toBeInTheDocument()
231
+ expect(
232
+ screen.getByText('Please try again or contact support if the problem persists.'),
233
+ ).toBeInTheDocument()
234
+ expect(screen.getByRole('button', {name: 'Retry'})).toBeInTheDocument()
235
+ expect(mockLogout).not.toHaveBeenCalled()
236
+ expect(mockReset).not.toHaveBeenCalled()
237
+ // Generic 401s should not trigger the dashboard access request flow.
238
+ expect(mockWindowConnectionFetch).not.toHaveBeenCalled()
53
239
  })
54
240
  })
@@ -1,22 +1,21 @@
1
1
  import {ClientError} from '@sanity/client'
2
- import {SDK_CHANNEL_NAME, SDK_NODE_NAME} from '@sanity/message-protocol'
3
2
  import {
4
3
  AuthStateType,
5
4
  getClientErrorApiBody,
6
5
  getClientErrorApiDescription,
7
- isDatasetResource,
6
+ getIsInDashboardState,
8
7
  isProjectUserNotFoundClientError,
9
8
  } from '@sanity/sdk'
10
- import {useCallback, useContext, useEffect, useState} from 'react'
9
+ import {Suspense, useCallback, useEffect, useMemo, useRef} from 'react'
11
10
  import {type FallbackProps} from 'react-error-boundary'
12
11
 
13
- import {ResourceContext} from '../../context/DefaultResourceContext'
14
12
  import {useAuthState} from '../../hooks/auth/useAuthState'
15
13
  import {useLogOut} from '../../hooks/auth/useLogOut'
16
- import {useWindowConnection} from '../../hooks/comlink/useWindowConnection'
14
+ import {useSanityInstance} from '../../hooks/context/useSanityInstance'
17
15
  import {Error} from '../errors/Error'
18
16
  import {AuthError} from './AuthError'
19
17
  import {ConfigurationError} from './ConfigurationError'
18
+ import {DashboardAccessRequest} from './DashboardAccessRequest'
20
19
  /**
21
20
  * @alpha
22
21
  */
@@ -40,74 +39,119 @@ export function LoginError({error, resetErrorBoundary}: LoginErrorProps): React.
40
39
 
41
40
  const logout = useLogOut()
42
41
  const authState = useAuthState()
43
- const resource = useContext(ResourceContext)
44
- const projectId = resource && isDatasetResource(resource) ? resource.projectId : undefined
42
+ const instance = useSanityInstance()
43
+ const {
44
+ config: {projectId},
45
+ } = instance
45
46
 
46
- const [authErrorMessage, setAuthErrorMessage] = useState(
47
- 'Please try again or contact support if the problem persists.',
48
- )
49
- const [showRetryCta, setShowRetryCta] = useState(true)
47
+ // Errors surfaced through `AuthBoundary` arrive wrapped in `AuthError`, with
48
+ // the original `ClientError` tucked under `.cause`. Unwrapping it here lets
49
+ // the 401/404 branches below respond to the real status code instead of
50
+ // silently skipping because `error instanceof ClientError` is false.
51
+ const clientError: ClientError | null =
52
+ error instanceof ClientError
53
+ ? error
54
+ : error instanceof AuthError && error.cause instanceof ClientError
55
+ ? error.cause
56
+ : null
57
+
58
+ const isInDashboard = getIsInDashboardState(instance).getCurrent()
50
59
 
51
- /**
52
- * TODO: before merge update message-protocol package to include the new message type
53
- */
54
- const {fetch} = useWindowConnection({
55
- name: SDK_NODE_NAME,
56
- connectTo: SDK_CHANNEL_NAME,
57
- })
60
+ const isProjectUserNotFound =
61
+ !!clientError && clientError.statusCode === 401 && isProjectUserNotFoundClientError(clientError)
62
+
63
+ // The dashboard access request flow relies on a comlink connection to the
64
+ // parent window. In standalone apps that connection never materializes, so
65
+ // we must skip it entirely to avoid suspending forever on the parent's
66
+ // Suspense boundary. Resolving to the projectId (or null) here lets the JSX
67
+ // render the child with a single non-null guard.
68
+ const dashboardAccessProjectId =
69
+ isProjectUserNotFound && projectId && isInDashboard ? projectId : null
58
70
 
59
71
  const handleRetry = useCallback(async () => {
60
72
  await logout()
61
73
  resetErrorBoundary()
62
74
  }, [logout, resetErrorBoundary])
63
75
 
64
- useEffect(() => {
65
- if (error instanceof ClientError) {
66
- if (error.statusCode === 401) {
67
- // Surface a friendly message for projectUserNotFoundError (do not logout/refresh)
68
- if (isProjectUserNotFoundClientError(error)) {
69
- const description = getClientErrorApiDescription(error)
70
- if (description) setAuthErrorMessage(description)
71
- setShowRetryCta(false)
72
- /**
73
- * Handoff to dashboard to enable the request access flow for the project.
74
- */
75
- fetch('dashboard/v1/auth/access/request', {
76
- resourceType: 'project',
77
- resourceId: projectId,
78
- })
79
- } else {
80
- setShowRetryCta(true)
81
- handleRetry()
82
- }
83
- } else if (error.statusCode === 404) {
84
- const errorMessage = getClientErrorApiBody(error)?.message || ''
85
- if (errorMessage.startsWith('Session with sid') && errorMessage.endsWith('not found')) {
86
- setAuthErrorMessage('The session ID is invalid or expired.')
87
- } else {
88
- setAuthErrorMessage('The login link is invalid or expired. Please try again.')
76
+ // Display state is fully derived from the inputs above, so we don't need
77
+ // to mirror it through useState/useEffect.
78
+ const {authErrorMessage, showRetryCta} = useMemo(() => {
79
+ let message = 'Please try again or contact support if the problem persists.'
80
+ let retry = true
81
+
82
+ if (clientError) {
83
+ if (clientError.statusCode === 401) {
84
+ if (isProjectUserNotFound) {
85
+ const description = getClientErrorApiDescription(clientError)
86
+ if (description) message = description
87
+ retry = false
88
+ } else if (!isInDashboard) {
89
+ message = 'Signing you out and returning to login...'
90
+ retry = true
89
91
  }
90
- setShowRetryCta(true)
92
+ // Dashboard non-projectUserNotFound 401: leave the current UI in place
93
+ // and let ComlinkTokenRefreshProvider request a fresh token from the
94
+ // parent window. The Retry button remains as a manual fallback.
95
+ } else if (clientError.statusCode === 404) {
96
+ const errorMessage = getClientErrorApiBody(clientError)?.message || ''
97
+ message =
98
+ errorMessage.startsWith('Session with sid') && errorMessage.endsWith('not found')
99
+ ? 'The session ID is invalid or expired.'
100
+ : 'The login link is invalid or expired. Please try again.'
101
+ retry = true
91
102
  }
92
103
  }
93
104
  if (authState.type !== AuthStateType.ERROR && error instanceof ConfigurationError) {
94
- setAuthErrorMessage(error.message)
95
- setShowRetryCta(true)
105
+ message = error.message
106
+ retry = true
96
107
  }
97
- }, [authState, handleRetry, error, fetch, projectId])
108
+ return {authErrorMessage: message, showRetryCta: retry}
109
+ }, [authState, clientError, error, isInDashboard, isProjectUserNotFound])
110
+
111
+ // Guards against re-entering the standalone auto-logout branch below. Once
112
+ // `logout()` flips the auth store to LOGGED_OUT, `useAuthState` emits a new
113
+ // `authState` reference and re-runs this effect; without the ref we'd call
114
+ // `handleRetry` again on every emission and React eventually aborts with
115
+ // "Maximum update depth exceeded", leaving a blank page.
116
+ const hasAutoLoggedOutRef = useRef(false)
117
+
118
+ // Standalone apps: the token is bad and there's no parent window to mint a
119
+ // new one, so log the user out and let `AuthBoundary`'s LOGGED_OUT effect
120
+ // redirect to the Sanity login URL.
121
+ useEffect(() => {
122
+ if (
123
+ clientError &&
124
+ clientError.statusCode === 401 &&
125
+ !isProjectUserNotFound &&
126
+ !isInDashboard &&
127
+ !hasAutoLoggedOutRef.current
128
+ ) {
129
+ hasAutoLoggedOutRef.current = true
130
+ handleRetry()
131
+ }
132
+ }, [clientError, handleRetry, isInDashboard, isProjectUserNotFound])
98
133
 
99
134
  return (
100
- <Error
101
- heading={error instanceof AuthError ? 'Authentication Error' : 'Configuration Error'}
102
- description={authErrorMessage}
103
- cta={
104
- showRetryCta
105
- ? {
106
- text: 'Retry',
107
- onClick: handleRetry,
108
- }
109
- : undefined
110
- }
111
- />
135
+ <>
136
+ {dashboardAccessProjectId && (
137
+ <Suspense fallback={null}>
138
+ <DashboardAccessRequest projectId={dashboardAccessProjectId} />
139
+ </Suspense>
140
+ )}
141
+ <Error
142
+ heading={
143
+ error instanceof ConfigurationError ? 'Configuration Error' : 'Authentication Error'
144
+ }
145
+ description={authErrorMessage}
146
+ cta={
147
+ showRetryCta
148
+ ? {
149
+ text: 'Retry',
150
+ onClick: handleRetry,
151
+ }
152
+ : undefined
153
+ }
154
+ />
155
+ </>
112
156
  )
113
157
  }
@@ -0,0 +1,59 @@
1
+ import {afterEach, beforeEach, describe, expect, it, vi} from 'vitest'
2
+
3
+ import {render, screen} from '../../../test/test-utils'
4
+ import {ChunkLoadError} from './ChunkLoadError'
5
+ import {CHUNK_RELOAD_STORAGE_KEY} from './chunkReloadStorage'
6
+
7
+ const noop = (): void => {}
8
+
9
+ describe('ChunkLoadError', () => {
10
+ const reloadSpy = vi.fn()
11
+ const originalLocation = window.location
12
+
13
+ beforeEach(() => {
14
+ reloadSpy.mockReset()
15
+ window.sessionStorage.clear()
16
+ Object.defineProperty(window, 'location', {
17
+ configurable: true,
18
+ value: {...originalLocation, reload: reloadSpy},
19
+ })
20
+ })
21
+
22
+ afterEach(() => {
23
+ Object.defineProperty(window, 'location', {configurable: true, value: originalLocation})
24
+ window.sessionStorage.clear()
25
+ })
26
+
27
+ it('triggers an automatic reload and renders nothing on the first occurrence', () => {
28
+ render(
29
+ <ChunkLoadError
30
+ error={new Error('Failed to fetch dynamically imported module')}
31
+ resetErrorBoundary={noop}
32
+ />,
33
+ )
34
+
35
+ expect(reloadSpy).toHaveBeenCalledTimes(1)
36
+ expect(window.sessionStorage.getItem(CHUNK_RELOAD_STORAGE_KEY)).toBe('1')
37
+ expect(screen.queryByText(/new version/i)).toBeNull()
38
+ })
39
+
40
+ it('renders the manual reload UI when the flag is already set', () => {
41
+ window.sessionStorage.setItem(CHUNK_RELOAD_STORAGE_KEY, '1')
42
+
43
+ render(
44
+ <ChunkLoadError
45
+ error={new Error('Failed to fetch dynamically imported module')}
46
+ resetErrorBoundary={noop}
47
+ />,
48
+ )
49
+
50
+ expect(reloadSpy).not.toHaveBeenCalled()
51
+ expect(screen.getByText('A new version is available')).toBeInTheDocument()
52
+
53
+ const button = screen.getByRole('button', {name: 'Reload page'})
54
+ button.click()
55
+
56
+ expect(reloadSpy).toHaveBeenCalledTimes(1)
57
+ expect(window.sessionStorage.getItem(CHUNK_RELOAD_STORAGE_KEY)).toBeNull()
58
+ })
59
+ })
@@ -0,0 +1,56 @@
1
+ import {useEffect} from 'react'
2
+ import {type FallbackProps} from 'react-error-boundary'
3
+
4
+ import {clearChunkReloadFlag, readChunkReloadFlag, setChunkReloadFlag} from './chunkReloadStorage'
5
+ import {Error} from './Error'
6
+
7
+ function reload(): void {
8
+ try {
9
+ window.location.reload()
10
+ } catch {
11
+ // No-op: nothing useful we can do if reload itself throws.
12
+ }
13
+ }
14
+
15
+ /**
16
+ * Default fallback rendered when a dynamic-import or chunk-load error
17
+ * bubbles up to the SDK's top-level error boundary.
18
+ *
19
+ * On the first occurrence in a session we set a flag and trigger
20
+ * window.location.reload(), since chunk-load errors almost always indicate a
21
+ * stale tab that simply needs a fresh index.html. If the flag is already set
22
+ * we render a manual reload UI instead, which prevents an infinite reload
23
+ * loop in the rare case the error is genuinely unrecoverable (network
24
+ * outage, CSP, etc.).
25
+ *
26
+ * @internal
27
+ */
28
+ export function ChunkLoadError(_props: FallbackProps): React.ReactNode {
29
+ const alreadyAttempted = readChunkReloadFlag()
30
+
31
+ useEffect(() => {
32
+ if (alreadyAttempted) return
33
+ setChunkReloadFlag()
34
+ reload()
35
+ }, [alreadyAttempted])
36
+
37
+ if (!alreadyAttempted) {
38
+ // Render nothing during the brief window before the page reloads so the
39
+ // user does not see a flash of error UI.
40
+ return null
41
+ }
42
+
43
+ return (
44
+ <Error
45
+ heading="A new version is available"
46
+ description="The page tried to load an asset that no longer exists. Reload to continue with the latest version."
47
+ cta={{
48
+ text: 'Reload page',
49
+ onClick: () => {
50
+ clearChunkReloadFlag()
51
+ reload()
52
+ },
53
+ }}
54
+ />
55
+ )
56
+ }
@@ -1,5 +1,5 @@
1
1
  import {useMemo} from 'react'
2
- import {type FallbackProps} from 'react-error-boundary'
2
+ import {type FallbackProps, getErrorMessage} from 'react-error-boundary'
3
3
 
4
4
  import {Error} from './Error'
5
5
 
@@ -30,7 +30,7 @@ export function CorsErrorComponent({projectId, error}: CorsErrorComponentProps):
30
30
  },
31
31
  }
32
32
  : {
33
- description: error?.message,
33
+ description: getErrorMessage(error),
34
34
  })}
35
35
  />
36
36
  )
@@ -0,0 +1,57 @@
1
+ /**
2
+ * Session-storage key tracking whether the SDK has already attempted an
3
+ * automatic reload in response to a chunk-load error during this session.
4
+ *
5
+ * @internal
6
+ */
7
+ export const CHUNK_RELOAD_STORAGE_KEY = '__sanity_sdk_chunk_reload_attempted'
8
+
9
+ /**
10
+ * Returns true when this session has already triggered an automatic reload.
11
+ * Returns false if session storage is unreadable.
12
+ *
13
+ * @internal
14
+ */
15
+ export function readChunkReloadFlag(): boolean {
16
+ try {
17
+ if (typeof window === 'undefined' || typeof window.sessionStorage === 'undefined') {
18
+ return false
19
+ }
20
+ return window.sessionStorage.getItem(CHUNK_RELOAD_STORAGE_KEY) !== null
21
+ } catch {
22
+ return false
23
+ }
24
+ }
25
+
26
+ /**
27
+ * Marks the session as having attempted an automatic reload, so the next
28
+ * chunk-load error renders the manual reload UI instead of looping.
29
+ *
30
+ * @internal
31
+ */
32
+ export function setChunkReloadFlag(): void {
33
+ try {
34
+ if (typeof window === 'undefined' || typeof window.sessionStorage === 'undefined') return
35
+ window.sessionStorage.setItem(CHUNK_RELOAD_STORAGE_KEY, '1')
36
+ } catch {
37
+ // Storage may be unavailable (private mode quotas, disabled cookies).
38
+ // Falling through means the user sees the manual-reload UI instead of an
39
+ // automatic reload, which is the correct degradation.
40
+ }
41
+ }
42
+
43
+ /**
44
+ * Clears the chunk-reload flag. Called from SDKProvider once the SDK
45
+ * mounts successfully past the error boundary so a future incident in the
46
+ * same session can trigger another automatic reload.
47
+ *
48
+ * @internal
49
+ */
50
+ export function clearChunkReloadFlag(): void {
51
+ try {
52
+ if (typeof window === 'undefined' || typeof window.sessionStorage === 'undefined') return
53
+ window.sessionStorage.removeItem(CHUNK_RELOAD_STORAGE_KEY)
54
+ } catch {
55
+ // No-op: see setChunkReloadFlag.
56
+ }
57
+ }