@sanity/sdk-react 3.3.0-rc.1 → 3.4.0-rc.0

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 (30) hide show
  1. package/dist/_exports/dashboard-internal.d.ts +2 -2
  2. package/dist/_exports/dashboard.d.ts +57 -1
  3. package/dist/_exports/dashboard.d.ts.map +1 -1
  4. package/dist/_exports/dashboard.js +69 -38
  5. package/dist/_exports/dashboard.js.map +1 -1
  6. package/dist/index.d.ts +3 -0
  7. package/dist/index.d.ts.map +1 -1
  8. package/dist/index.js +2 -2
  9. package/dist/{useStudioWorkspacesByProjectIdDataset-BZ_Ud887.js → useStudioWorkspacesByProjectIdDataset-B5A5kBH9.js} +85 -5
  10. package/dist/useStudioWorkspacesByProjectIdDataset-B5A5kBH9.js.map +1 -0
  11. package/package.json +8 -8
  12. package/src/_exports/dashboard-internal.ts +6 -1
  13. package/src/_exports/dashboard.test-d.ts +30 -4
  14. package/src/_exports/dashboard.ts +3 -0
  15. package/src/hooks/dashboard/useApplicationBasePath.test.tsx +77 -0
  16. package/src/hooks/dashboard/useApplicationBasePath.ts +23 -0
  17. package/src/hooks/dashboard/useApplications.test.tsx +12 -3
  18. package/src/hooks/dashboard/useApplications.ts +5 -24
  19. package/src/hooks/dashboard/useAuthToken.test.tsx +48 -0
  20. package/src/hooks/dashboard/useAuthToken.ts +20 -0
  21. package/src/hooks/dashboard/useCurrentUser.test.tsx +57 -0
  22. package/src/hooks/dashboard/useCurrentUser.ts +22 -0
  23. package/src/hooks/dashboard/useOrganizationId.test.tsx +52 -1
  24. package/src/hooks/dashboard/useOrganizationId.tsx +15 -2
  25. package/src/hooks/dashboard/useStudioWorkspacesByProjectIdDataset.test.tsx +142 -1
  26. package/src/hooks/dashboard/useStudioWorkspacesByProjectIdDataset.ts +58 -1
  27. package/src/hooks/dashboard/useWindowTitle.test.ts +23 -0
  28. package/src/hooks/dashboard/useWindowTitle.ts +14 -0
  29. package/src/hooks/installations/useInstallations.test-d.ts +10 -0
  30. package/dist/useStudioWorkspacesByProjectIdDataset-BZ_Ud887.js.map +0 -1
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useStudioWorkspacesByProjectIdDataset-B5A5kBH9.js","names":["SanityInstance","createContext","SanityInstanceContext","SanityInstance","useContext","SanityInstanceContext","useSanityInstance","instance","Error","SanityConfig","SanityInstance","StateSource","useSyncExternalStore","useSanityInstance","StateSourceFactory","instance","params","TParams","TState","CreateStateSourceHookOptions","getState","shouldSuspend","suspender","Promise","getConfig","createStateSourceHook","options","suspense","undefined","useHook","t0","$","_c","t1","state","subscribe","getCurrent","AuthState","getAuthState","createStateSourceHook","useAuthState","MessageData","NodeInput","SanityInstance","StateSource","FrameMessage","getNodeState","NodeState","WindowMessage","useCallback","useEffect","useRef","filter","firstValueFrom","useSanityInstance","createStateSourceHook","WindowMessageHandler","event","TFrameMessage","UseWindowConnectionOptions","name","connectTo","onMessage","Record","TMessage","WindowConnection","sendMessage","type","TType","data","Extract","fetch","options","signal","AbortSignal","suppressWarnings","responseTimeout","Promise","TResponse","useNodeState","getState","instance","nodeInput","shouldSuspend","getCurrent","undefined","suspender","observable","pipe","Boolean","useWindowConnection","t0","$","_c","t1","node","t2","Symbol","for","messageUnsubscribers","t3","Object","entries","forEach","t4","handler","messageUnsubscribe","on","current","push","_temp","t5","type_0","post","t6","type_1","data_0","fetchOptions","t7","unsubscribe","React","MODULE_SLOT_KEY","Symbol","for","ModuleContext","Context","ModuleSlot","WeakMap","createContext","getDashboardModuleContext","globals","globalThis","slot","key","context","get","undefined","set","ClientError","AuthStateType","setAuthToken","getDashboardMessageBus","MessageBus","React","PropsWithChildren","useContext","useEffect","useRef","useState","defer","of","catchError","getDashboardModuleContext","useAuthState","useSanityInstance","DashboardTokenRefresh","t0","$","_c","children","messageBus","instance","authState","processed401ErrorRef","t1","t2","subscription","subscribe","pipe","_temp","token","unsubscribe","t3","error","type","has401Error","ERROR","statusCode","current","emit","undefined","catch","_temp2","t4","console","warn","DashboardTokenRefreshProvider","FC","Symbol","for","moduleId","getDashboardOrganizationId","OrganizationBase","getTopicState","isDashboardEnvironment","useMemo","useSyncExternalStore","useSanityInstance","CurrentOrganization","Pick","useOrganizationId","$","_c","instance","t0","bb0","t1","source","t2","getCurrent","id","undefined","t3","subscribe","getTopicState","resolveTopic","StateTopic","TopicData","createStateSourceHook","useTopic","getState","shouldSuspend","instance","topic","getCurrent","undefined","suspender","K","SDK_CHANNEL_NAME","SDK_NODE_NAME","getApplicationOrigin","isDashboardEnvironment","TopicData","useEffect","useMemo","useState","useWindowConnection","useTopic","DashboardResource","id","name","title","basePath","projectId","dataset","type","userApplicationId","url","WorkspacesByProjectIdDataset","key","StudioWorkspacesResult","workspacesByProjectIdAndDataset","error","DashboardApplications","NonNullable","useStudioWorkspacesByProjectIdDataset","useBusStudioWorkspaces","useComlinkStudioWorkspaces","toResources","application","activeDeployment","workspaces","map","workspace","toWorkspaceMap","applications","workspaceMap","resource","flatMap","const","push","$","_c","t0","t1","t2","Symbol","for","setWorkspacesByProjectIdAndDataset","setError","connectTo","fetch","t3","fetchWorkspaces","signal","data","undefined","noProjectIdAndDataset","context","availableResources","forEach","length","t4","err","Error","controller","AbortController","abort"],"sources":["../src/context/SanityInstanceContext.ts","../src/hooks/context/useSanityInstance.ts","../src/hooks/helpers/createStateSourceHook.tsx","../src/hooks/auth/useAuthState.tsx","../src/hooks/comlink/useWindowConnection.ts","../src/dashboard/module.ts","../src/context/DashboardTokenRefresh.tsx","../src/hooks/dashboard/useOrganizationId.tsx","../src/hooks/dashboard/useTopic.ts","../src/hooks/dashboard/useStudioWorkspacesByProjectIdDataset.ts"],"sourcesContent":["import {type SanityInstance} from '@sanity/sdk'\nimport {createContext} from 'react'\n\nexport const SanityInstanceContext = createContext<SanityInstance | null>(null)\n","import {type SanityInstance} from '@sanity/sdk'\nimport {useContext} from 'react'\n\nimport {SanityInstanceContext} from '../../context/SanityInstanceContext'\n\n/**\n * Retrieves the current Sanity instance from context\n *\n * @public\n *\n * @category Platform\n * @returns The current Sanity instance\n *\n * @remarks\n * This hook accesses the nearest Sanity instance from the React context.\n * The hook must be used within a component wrapped by a `ResourceProvider` or `SanityApp`.\n *\n * @example Get the current instance\n * ```tsx\n * const instance = useSanityInstance()\n * console.log(instance.config.projectId)\n * ```\n *\n * @throws Error if no SanityInstance is found in context\n */\nexport const useSanityInstance = (): SanityInstance => {\n const instance = useContext(SanityInstanceContext)\n\n if (!instance) {\n throw new Error(\n `SanityInstance context not found. Please ensure that your component is wrapped in a ResourceProvider or a SanityApp component.`,\n )\n }\n\n return instance\n}\n","import {type SanityConfig, type SanityInstance, type StateSource} from '@sanity/sdk'\nimport {useSyncExternalStore} from 'react'\n\nimport {useSanityInstance} from '../context/useSanityInstance'\n\ntype StateSourceFactory<TParams extends unknown[], TState> = (\n instance: SanityInstance,\n ...params: TParams\n) => StateSource<TState>\n\ninterface CreateStateSourceHookOptions<TParams extends unknown[], TState> {\n getState: StateSourceFactory<TParams, TState>\n shouldSuspend?: (instance: SanityInstance, ...params: TParams) => boolean\n suspender?: (instance: SanityInstance, ...params: TParams) => Promise<unknown>\n getConfig?: (...params: TParams) => SanityConfig | undefined\n}\n\nexport function createStateSourceHook<TParams extends unknown[], TState>(\n options: StateSourceFactory<TParams, TState> | CreateStateSourceHookOptions<TParams, TState>,\n): (...params: TParams) => TState {\n const getState = typeof options === 'function' ? options : options.getState\n const suspense = 'shouldSuspend' in options && 'suspender' in options ? options : undefined\n\n function useHook(...params: TParams) {\n const instance = useSanityInstance()\n\n if (suspense?.suspender && suspense?.shouldSuspend?.(instance, ...params)) {\n throw suspense.suspender(instance, ...params)\n }\n\n const state = getState(instance, ...params)\n return useSyncExternalStore(state.subscribe, state.getCurrent)\n }\n\n return useHook\n}\n","import {type AuthState, getAuthState} from '@sanity/sdk'\n\nimport {createStateSourceHook} from '../helpers/createStateSourceHook'\n\n/**\n * @internal\n * A React hook that subscribes to authentication state changes.\n *\n * This hook provides access to the current authentication state type from the Sanity auth store.\n * It automatically re-renders when the authentication state changes.\n *\n * @remarks\n * The hook uses `useSyncExternalStore` to safely subscribe to auth state changes\n * and ensure consistency between server and client rendering.\n *\n * @returns The current authentication state type\n *\n * @example\n * ```tsx\n * function AuthStatus() {\n * const authState = useAuthState()\n * return <div>Current auth state: {authState}</div>\n * }\n * ```\n */\nexport const useAuthState: () => AuthState = createStateSourceHook(getAuthState)\n","import {type MessageData, type NodeInput} from '@sanity/comlink'\nimport {type SanityInstance, type StateSource} from '@sanity/sdk'\nimport {\n type FrameMessage,\n getNodeState,\n type NodeState,\n type WindowMessage,\n} from '@sanity/sdk/comlink'\nimport {useCallback, useEffect, useRef} from 'react'\nimport {filter, firstValueFrom} from 'rxjs'\n\nimport {useSanityInstance} from '../context/useSanityInstance'\nimport {createStateSourceHook} from '../helpers/createStateSourceHook'\n\n/**\n * @internal\n */\nexport type WindowMessageHandler<TFrameMessage extends FrameMessage> = (\n event: TFrameMessage['data'],\n) => TFrameMessage['response']\n\n/**\n * @internal\n */\nexport interface UseWindowConnectionOptions<TMessage extends FrameMessage> {\n name: string\n connectTo: string\n onMessage?: Record<TMessage['type'], WindowMessageHandler<TMessage>>\n}\n\n/**\n * @internal\n */\nexport interface WindowConnection<TMessage extends WindowMessage> {\n sendMessage: <TType extends TMessage['type']>(\n type: TType,\n data?: Extract<TMessage, {type: TType}>['data'],\n ) => void\n fetch: <TResponse>(\n type: string,\n data?: MessageData,\n options?: {\n signal?: AbortSignal\n suppressWarnings?: boolean\n responseTimeout?: number\n },\n ) => Promise<TResponse>\n}\n\nconst useNodeState = createStateSourceHook({\n getState: getNodeState as (\n instance: SanityInstance,\n nodeInput: NodeInput,\n ) => StateSource<NodeState>,\n shouldSuspend: (instance: SanityInstance, nodeInput: NodeInput) =>\n getNodeState(instance, nodeInput).getCurrent() === undefined,\n suspender: (instance: SanityInstance, nodeInput: NodeInput) => {\n return firstValueFrom(getNodeState(instance, nodeInput).observable.pipe(filter(Boolean)))\n },\n})\n\n/**\n * @internal\n * Hook to wrap a Comlink node in a React hook.\n * Our store functionality takes care of the lifecycle of the node,\n * as well as sharing a single node between invocations if they share the same name.\n *\n * Generally not to be used directly, but to be used as a dependency of\n * Comlink-powered hooks like `useStudioWorkspacesByProjectIdDataset`.\n */\nexport function useWindowConnection<\n TWindowMessage extends WindowMessage,\n TFrameMessage extends FrameMessage,\n>({\n name,\n connectTo,\n onMessage,\n}: UseWindowConnectionOptions<TFrameMessage>): WindowConnection<TWindowMessage> {\n const {node} = useNodeState({name, connectTo})\n const messageUnsubscribers = useRef<(() => void)[]>([])\n const instance = useSanityInstance()\n\n useEffect(() => {\n if (onMessage) {\n Object.entries(onMessage).forEach(([type, handler]) => {\n const messageUnsubscribe = node.on(type, handler as WindowMessageHandler<TFrameMessage>)\n if (messageUnsubscribe) {\n messageUnsubscribers.current.push(messageUnsubscribe)\n }\n })\n }\n\n return () => {\n messageUnsubscribers.current.forEach((unsubscribe) => unsubscribe())\n messageUnsubscribers.current = []\n }\n }, [instance, name, onMessage, node])\n\n const sendMessage = useCallback(\n (type: TWindowMessage['type'], data?: Extract<TWindowMessage, {type: typeof type}>['data']) => {\n node.post(type, data)\n },\n [node],\n )\n\n const fetch = useCallback(\n <TResponse>(\n type: string,\n data?: MessageData,\n fetchOptions?: {\n responseTimeout?: number\n signal?: AbortSignal\n suppressWarnings?: boolean\n },\n ): Promise<TResponse> => {\n return node.fetch(type, data, fetchOptions ?? {}) as Promise<TResponse>\n },\n [node],\n )\n return {\n sendMessage,\n fetch,\n }\n}\n","import * as React from 'react'\n\nconst MODULE_SLOT_KEY = Symbol.for('sanity.os.module')\n\ntype ModuleContext = React.Context<string | undefined>\ntype ModuleSlot = WeakMap<typeof React.createContext, ModuleContext>\n\n/**\n * Returns the React context that carries the current federation module id.\n *\n * @remarks\n * This is the slot the CLI-generated wrapper populates with\n * `renderOptions.moduleId`. The context lives in a per-React-copy slot on\n * `globalThis` so the CLI wrapper and the SDK share the same context even\n * across module copies. Each React copy gets its own context, since a context\n * created by one copy is inert in another.\n *\n * The slot is keyed on `React.createContext` rather than the `React` namespace\n * object: `import * as React` and `import React from 'react'` can yield\n * different wrapper objects for the same React copy under bundler interop,\n * whereas the `createContext` function is the same reference under both.\n *\n * The provider side lives in the CLI, which must not import the SDK:\n * `packages/@sanity/workbench-cli/src/actions/build/render-remote.ts` in\n * `sanity-io/cli` reconstructs this accessor (same symbol, same key) and\n * wraps `App` in the context's `Provider`. Nothing in this repo exports it.\n * @internal\n */\nexport function getDashboardModuleContext(): ModuleContext {\n const globals = globalThis as {[MODULE_SLOT_KEY]?: ModuleSlot}\n const slot = (globals[MODULE_SLOT_KEY] ??= new WeakMap())\n const key = React.createContext\n let context = slot.get(key)\n if (!context) {\n context = React.createContext<string | undefined>(undefined)\n slot.set(key, context)\n }\n return context\n}\n","import {type ClientError} from '@sanity/client'\nimport {AuthStateType, setAuthToken} from '@sanity/sdk'\nimport {getDashboardMessageBus} from '@sanity/sdk/_internal'\nimport {type MessageBus} from '@sanity/sdk/dashboard'\nimport React, {type PropsWithChildren, useContext, useEffect, useRef, useState} from 'react'\nimport {defer, of} from 'rxjs'\nimport {catchError} from 'rxjs/operators'\n\nimport {getDashboardModuleContext} from '../dashboard/module'\nimport {useAuthState} from '../hooks/auth/useAuthState'\nimport {useSanityInstance} from '../hooks/context/useSanityInstance'\n\n/**\n * Keeps the SDK auth token in sync with the dashboard \"OS\".\n *\n * When running inside the dashboard the OS owns the session, so we subscribe\n * to its `auth.token` stream and mirror each value into\n * the auth store — a token logs us in, `null` logs us out, and later OS\n * sign-in/out propagates automatically. When a request is rejected with a 401\n * (the token expired), we ask the OS to reissue rather than tearing the session\n * down; the new token arrives back through the same subscription.\n */\nfunction DashboardTokenRefresh({\n children,\n messageBus,\n}: PropsWithChildren<{messageBus: MessageBus}>) {\n const instance = useSanityInstance()\n const authState = useAuthState()\n const processed401ErrorRef = useRef<unknown | null>(null)\n\n useEffect(() => {\n const subscription = defer(() => messageBus.subscribe('auth.token'))\n .pipe(catchError(() => of(null)))\n .subscribe((token) => setAuthToken(instance, token))\n return () => subscription.unsubscribe()\n }, [instance, messageBus])\n\n useEffect(() => {\n const has401Error =\n authState.type === AuthStateType.ERROR && (authState.error as ClientError)?.statusCode === 401\n\n if (has401Error && processed401ErrorRef.current !== authState.error) {\n processed401ErrorRef.current = authState.error\n // Event topics have no replay, so a missing responder or timeout is otherwise dropped silently.\n messageBus.emit('auth.token.refresh', undefined).catch((error) => {\n // eslint-disable-next-line no-console\n console.warn('[sanity/sdk] Dashboard token refresh failed:', error)\n })\n } else if (!has401Error) {\n processed401ErrorRef.current = null\n }\n }, [authState, messageBus])\n\n return children\n}\n\n/**\n * Authenticates the SDK with the Sanity Dashboard's session when the app runs\n * inside the dashboard.\n *\n * The dashboard owns the session there: this provider subscribes to the token\n * the dashboard issues, writes each new value into the SDK's auth store (where\n * SDK hooks read it from), and asks the dashboard for a fresh token when a\n * request fails with a 401. Outside the dashboard it renders children\n * unchanged and the app's normal auth flow applies.\n *\n * @remarks\n * `AuthBoundary` mounts this automatically, so most apps never need it\n * directly. Mount it yourself only when your app runs inside the dashboard\n * without `AuthBoundary` — that is, the app renders its own loading and error\n * UI instead of the SDK's login flow — but still uses SDK hooks such as\n * `useQuery`, which need the dashboard's token in the auth store to\n * authenticate their requests.\n *\n * Mount it once, inside the provider that creates the Sanity instance whose\n * store should receive the token.\n *\n * @example\n * ```tsx\n * import {ResourceProvider} from '@sanity/sdk-react'\n * import {TokenRefreshProvider} from '@sanity/sdk-react/dashboard'\n *\n * function EmbeddedApp() {\n * return (\n * <ResourceProvider fallback={<Loading />}>\n * <TokenRefreshProvider>\n * <App />\n * </TokenRefreshProvider>\n * </ResourceProvider>\n * )\n * }\n * ```\n *\n * @public\n */\nexport const DashboardTokenRefreshProvider: React.FC<PropsWithChildren> = ({children}) => {\n const instance = useSanityInstance()\n const moduleId = useContext(getDashboardModuleContext())\n // The connection is first-caller-wins per instance, and hooks below read it during their\n // render, before any effect here could run. Connecting in the first render pins the module\n // identity before they do; nothing has subscribed to the store yet, so the write is safe.\n // The module id is read once: the CLI wrapper provides it statically above this tree.\n // No retry: the host installs the bus at module evaluation, before any remote renders, and\n // a standalone app has no host to wait for.\n const [messageBus] = useState(() => getDashboardMessageBus(instance, moduleId))\n if (messageBus) {\n return <DashboardTokenRefresh messageBus={messageBus}>{children}</DashboardTokenRefresh>\n }\n\n return children\n}\n","import {getDashboardOrganizationId, type OrganizationBase} from '@sanity/sdk'\nimport {getTopicState, isDashboardEnvironment} from '@sanity/sdk/_internal'\nimport {useMemo, useSyncExternalStore} from 'react'\n\nimport {useSanityInstance} from '../context/useSanityInstance'\n\ntype CurrentOrganization = Pick<OrganizationBase, 'id' | 'name' | 'slug'> | null | undefined\n\n/**\n * @public\n *\n * A React hook that retrieves the dashboard organization ID that is currently selected in the Sanity Dashboard.\n *\n * Works in both Dashboard runtimes: it reads the `organizations.current` message bus topic when a\n * host has installed the bus, and falls back to the Comlink connection otherwise.\n *\n * @example\n * ```tsx\n * function DashboardComponent() {\n * const orgId = useOrganizationId()\n *\n * if (!orgId) return null\n *\n * return <div>Organization ID: {String(orgId)}</div>\n * }\n * ```\n *\n * @category Dashboard\n * @returns The dashboard organization ID (string | undefined)\n */\nexport function useOrganizationId(): string | undefined {\n const instance = useSanityInstance()\n const {subscribe, getCurrent} = useMemo(() => {\n if (!isDashboardEnvironment()) return getDashboardOrganizationId(instance)\n const source = getTopicState(instance, 'organizations.current')\n return {\n subscribe: source.subscribe,\n getCurrent: () => (source.getCurrent() as CurrentOrganization)?.id ?? undefined,\n }\n }, [instance])\n\n return useSyncExternalStore(subscribe, getCurrent)\n}\n","import {getTopicState, resolveTopic} from '@sanity/sdk/_internal'\nimport {type StateTopic, type TopicData} from '@sanity/sdk/dashboard'\n\nimport {createStateSourceHook} from '../helpers/createStateSourceHook'\n\n/**\n * Returns the current value of a dashboard state topic and follows later updates.\n *\n * The hook suspends until the topic publishes its first value, using the message bus query\n * deadline. A topic declared with `TopicResult` resolves to its successful value; a\n * failed result throws a `TopicError` to the nearest error boundary.\n *\n * @example\n * ```tsx\n * function ForegroundApplication() {\n * const foregroundId = useTopic('applications.foreground')\n * return <span>{foregroundId ?? 'No application in the foreground'}</span>\n * }\n * ```\n *\n * @public\n */\nexport const useTopic = createStateSourceHook({\n getState: getTopicState,\n // `getCurrent` throws a recorded read failure, which surfaces it from render like a thrown value.\n shouldSuspend: (instance, topic: StateTopic) =>\n getTopicState(instance, topic).getCurrent() === undefined,\n suspender: resolveTopic,\n}) as <K extends StateTopic>(topic: K) => TopicData<K>\n","/* eslint-disable react-compiler/react-compiler -- the transport branch in `useStudioWorkspacesByProjectIdDataset` is a deliberate rules-of-hooks exception; the compiler refuses files that disable it */\nimport {SDK_CHANNEL_NAME, SDK_NODE_NAME} from '@sanity/message-protocol'\nimport {getApplicationOrigin, isDashboardEnvironment} from '@sanity/sdk/_internal'\nimport {type TopicData} from '@sanity/sdk/dashboard'\nimport {useEffect, useMemo, useState} from 'react'\n\nimport {useWindowConnection} from '../comlink/useWindowConnection'\nimport {useTopic} from './useTopic'\n\nexport interface DashboardResource {\n id: string\n name: string\n title: string\n basePath: string\n projectId: string\n dataset: string\n type: string\n userApplicationId: string\n url: string\n}\n\ninterface WorkspacesByProjectIdDataset {\n [key: `${string}:${string}`]: DashboardResource[] // key format: `${projectId}:${dataset}`\n}\n\ninterface StudioWorkspacesResult {\n workspacesByProjectIdAndDataset: WorkspacesByProjectIdDataset\n error: string | null\n}\n\ntype DashboardApplications = NonNullable<TopicData<'applications.list'>>\n\n/**\n * Hook that fetches studio workspaces and organizes them by projectId:dataset\n *\n * Works in both Dashboard runtimes: it derives workspaces from the `applications.list` message\n * bus topic when a host has installed the bus, and falls back to the Comlink connection otherwise.\n * @internal\n *\n * @example\n * ```tsx\n * import {useStudioWorkspacesByProjectIdDataset} from '@sanity/sdk-react'\n * import {Card, Code, Button} from '@sanity/ui'\n * import {Suspense} from 'react'\n *\n * function WorkspacesCard() {\n * const {workspacesByProjectIdAndDataset, error} = useStudioWorkspacesByProjectIdDataset()\n * if (error) {\n * return <div>Error: {error}</div>\n * }\n * return (\n * <Card padding={4} radius={2} shadow={1}>\n * <Code language=\"json\">\n * {JSON.stringify(workspacesByProjectIdAndDataset, null, 2)}\n * </Code>\n * </Card>\n * )\n * }\n *\n * // Wrap the component with Suspense since the hook may suspend\n * function DashboardWorkspaces() {\n * return (\n * <Suspense fallback={<Button text=\"Loading...\" disabled />}>\n * <WorkspacesCard />\n * </Suspense>\n * )\n * }\n * ```\n */\nexport function useStudioWorkspacesByProjectIdDataset(): StudioWorkspacesResult {\n // The branch is stable: the transport is fixed for the page lifetime, so one set of hooks\n // always runs and the other never does.\n // eslint-disable-next-line react-hooks/rules-of-hooks -- transport is fixed for the page lifetime\n if (isDashboardEnvironment()) return useBusStudioWorkspaces()\n // eslint-disable-next-line react-hooks/rules-of-hooks -- transport is fixed for the page lifetime\n return useComlinkStudioWorkspaces()\n}\n\n// The legacy Comlink protocol models studios at the workspace level, so each workspace of a\n// studio's active deployment becomes one resource, addressed by the studio's origin.\nfunction toResources(application: DashboardApplications[number]): DashboardResource[] {\n if (application.type !== 'studio') return []\n const url = getApplicationOrigin(application) ?? ''\n return (application.activeDeployment?.workspaces ?? []).map((workspace) => ({\n id: workspace.id,\n name: workspace.name,\n title: workspace.title ?? application.title,\n basePath: workspace.basePath ?? '',\n projectId: workspace.projectId,\n dataset: workspace.dataset,\n type: 'studio',\n userApplicationId: application.id,\n url,\n }))\n}\n\nfunction toWorkspaceMap(applications: DashboardApplications): WorkspacesByProjectIdDataset {\n const workspaceMap: WorkspacesByProjectIdDataset = {}\n for (const resource of applications.flatMap(toResources)) {\n const key = `${resource.projectId}:${resource.dataset}` as const\n workspaceMap[key] ??= []\n workspaceMap[key].push(resource)\n }\n return workspaceMap\n}\n\n// Suspends until the host publishes its application list and throws a `TopicError` on failure,\n// like every bus hook, so `error` is always `null` on this path.\nfunction useBusStudioWorkspaces(): StudioWorkspacesResult {\n const applications = useTopic('applications.list')\n const workspacesByProjectIdAndDataset = useMemo(\n () => toWorkspaceMap(applications ?? []),\n [applications],\n )\n return {workspacesByProjectIdAndDataset, error: null}\n}\n\nfunction useComlinkStudioWorkspaces(): StudioWorkspacesResult {\n const [workspacesByProjectIdAndDataset, setWorkspacesByProjectIdAndDataset] =\n useState<WorkspacesByProjectIdDataset>({})\n const [error, setError] = useState<string | null>(null)\n\n const {fetch} = useWindowConnection({\n name: SDK_NODE_NAME,\n connectTo: SDK_CHANNEL_NAME,\n })\n\n // Once computed, this should probably be in a store and poll for changes\n // However, our stores are currently being refactored\n useEffect(() => {\n if (!fetch) return\n\n async function fetchWorkspaces(signal: AbortSignal) {\n try {\n const data = await fetch<{\n context: {availableResources: Array<DashboardResource>}\n }>('dashboard/v1/context', undefined, {signal})\n\n const workspaceMap: WorkspacesByProjectIdDataset = {}\n const noProjectIdAndDataset: DashboardResource[] = []\n\n data.context.availableResources.forEach((resource) => {\n if (resource.type !== 'studio') return\n if (!resource.projectId || !resource.dataset) {\n noProjectIdAndDataset.push(resource)\n return\n }\n const key = `${resource.projectId}:${resource.dataset}` as const\n if (!workspaceMap[key]) {\n workspaceMap[key] = []\n }\n workspaceMap[key].push(resource)\n })\n\n if (noProjectIdAndDataset.length > 0) {\n workspaceMap['NO_PROJECT_ID:NO_DATASET'] = noProjectIdAndDataset\n }\n\n setWorkspacesByProjectIdAndDataset(workspaceMap)\n setError(null)\n } catch (err: unknown) {\n if (err instanceof Error) {\n if (err.name === 'AbortError') {\n return\n }\n setError('Failed to fetch workspaces')\n }\n }\n }\n\n const controller = new AbortController()\n fetchWorkspaces(controller.signal)\n\n return () => {\n controller.abort()\n }\n }, [fetch])\n\n return {\n workspacesByProjectIdAndDataset,\n error,\n }\n}\n"],"mappings":";;;;;;;;;;;;AAGA,MAAaE,wBAAwBD,cAAqC,IAAI,GCsBjEK,0BAAoB;CAC/B,IAAAC,WAAiBH,WAAWC,qBAAqB;CAEjD,IAAI,CAACE,UACH,MAAUC,MACR,gIACF;CACD,OAEMD;AAAQ;ACjBjB,SAAgBkB,sBACdC,SACgC;CAChC,IAAMN,WAAW,OAAOM,WAAY,aAAaA,UAAUA,QAAQN,UAC7DO,WAAW,mBAAmBD,WAAW,eAAeA,UAAUA,UAAUE,KAAAA;CAElF,SAAAC,QAAA,GAAAC,IAAA;EAAA,IAAAC,IAAAC,EAAA,CAAA,GAAiBhB,SAAAc,IACff,WAAiBF,kBAAkB;EAEnC,IAAIc,UAAQL,aAAeK,UAAQN,gBAAkBN,UAAQ,GAAKC,MAAM,GACtE,MAAMW,SAAQL,UAAWP,UAAQ,GAAKC,MAAM;EAC7C,IAAAiB;EAAA,AAAAF,EAAA,OAAAhB,YAAAgB,EAAA,OAAAf,UAEaiB,KAAAb,SAASL,UAAQ,GAAKC,MAAM,GAACe,EAAA,KAAAhB,UAAAgB,EAAA,KAAAf,QAAAe,EAAA,KAAAE,MAAAA,KAAAF,EAAA;EAA3C,IAAAG,QAAcD;EAA6B,OACpCrB,qBAAqBsB,MAAKC,WAAYD,MAAKE,UAAW;CAAC;CAGhE,OAAOP;AACT;;;;;;;;;;;;;;;;;;;;;;ACVA,MAAaW,eAAgCD,sBAAsBD,YAAY,GCwBzEyC,eAAexB,sBAAsB;CACzCyB,UAAUlC;CAIVqC,gBAAgBF,UAA0BC,cACxCpC,aAAamC,UAAUC,SAAS,CAAC,CAACE,WAAW,MAAMC,KAAAA;CACrDC,YAAYL,UAA0BC,cAC7B7B,eAAeP,aAAamC,UAAUC,SAAS,CAAC,CAACK,WAAWC,KAAKpC,OAAOqC,OAAO,CAAC,CAAC;AAE5F,CAAC;;;;;;;;;;AAWD,SAAOC,oBAAAC,IAAA;CAAA,IAAAC,IAAAC,EAAA,EAAA,GAGL,EAAAjC,MAAAC,WAAAC,cAAA6B,IAI0CG;CAAA,AAAAF,EAAA,OAAA/B,aAAA+B,EAAA,OAAAhC,QACdkC,KAAA;EAAAlC;EAAAC;CAAgB,GAAC+B,EAAA,KAAA/B,WAAA+B,EAAA,KAAAhC,MAAAgC,EAAA,KAAAE,MAAAA,KAAAF,EAAA;CAA7C,IAAA,EAAAG,SAAehB,aAAae,EAAiB,GAACE;CAAA,AAAAJ,EAAA,OAAAK,OAAAC,IAAA,2BAAA,KACMF,KAAA,CAAA,GAAEJ,EAAA,KAAAI,MAAAA,KAAAJ,EAAA;CAAtD,IAAAO,uBAA6BhD,OAAuB6C,EAAE,GACtDf,WAAiB3B,kBAAkB,GAAC8C;CAAA,AAAAR,EAAA,OAAAG,QAAAH,EAAA,OAAA9B,aAE1BsC,YACJtC,aACFuC,OAAMC,QAASxC,SAAS,CAAC,CAAAyC,SAASC,OAAA;EAAC,IAAA,CAAArC,MAAAsC,WAAAD,IACjCE,qBAA2BX,KAAIY,GAAIxC,MAAMsC,OAA8C;EACvF,AAAIC,sBACFP,qBAAoBS,QAAQC,KAAMH,kBAAkB;CACrD,CACF,SAGI;EAELP,AADAA,qBAAoBS,QAAQL,QAASO,OAA8B,GACnEX,qBAAoBS,UAAW,CAAA;CAAH,IAE/BhB,EAAA,KAAAG,MAAAH,EAAA,KAAA9B,WAAA8B,EAAA,KAAAQ,MAAAA,KAAAR,EAAA;CAAA,IAAAY;CAdDtD,AAcC0C,EAAA,OAAAX,YAAAW,EAAA,OAAAhC,QAAAgC,EAAA,OAAAG,QAAAH,EAAA,QAAA9B,aAAE0C,KAAA;EAACvB;EAAUrB;EAAME;EAAWiC;CAAI,GAACH,EAAA,KAAAX,UAAAW,EAAA,KAAAhC,MAAAgC,EAAA,KAAAG,MAAAH,EAAA,MAAA9B,WAAA8B,EAAA,MAAAY,MAAAA,KAAAZ,EAAA,KAdpC1C,UAAUkD,IAcPI,EAAiC;CAAC,IAAAO;CAAA,AAAAnB,EAAA,QAAAG,OAKlCgB,KAAAnB,EAAA,OAFDmB,MAAAC,QAAA3C,SAAA;EACE0B,KAAIkB,KAAM9C,QAAME,IAAI;CAAC,GACtBuB,EAAA,MAAAG,MAAAH,EAAA,MAAAmB;CAHH,IAAA7C,cAAoB6C,IAKnBG;CAAA,AAAAtB,EAAA,QAAAG,OAaEmB,KAAAtB,EAAA,OAVDsB,MAAAC,QAAAC,QAAAC,iBASStB,KAAIxB,MAAOJ,QAAME,QAAMgD,gBAAA,CAAiB,CAAC,GACjDzB,EAAA,MAAAG,MAAAH,EAAA,MAAAsB;CAXH,IAAA3C,QAAc2C,IAabI;CAIA,OAJA1B,EAAA,QAAArB,SAAAqB,EAAA,QAAA1B,eACMoD,KAAA;EAAApD;EAAAK;CAGP,GAACqB,EAAA,MAAArB,OAAAqB,EAAA,MAAA1B,aAAA0B,EAAA,MAAA0B,MAAAA,KAAA1B,EAAA,KAHM0B;AAGN;AApDI,SAAAR,QAAAS,aAAA;CAAA,OAuBqDA,YAAY;AAAC;AC3FzE,MAAME,kBAAkBC,OAAOC,IAAI,kBAAkB;;;;;;;;;;;;;;;;;;;;;;AA0BrD,SAAgBM,4BAA2C;CACzD,IAAMC,UAAUC,YACVC,OAAQF,QAAQT,qCAAqB,IAAIM,QAAQ,GACjDM,MAAMb,QAAMQ,eACdM,UAAUF,KAAKG,IAAIF,GAAG;CAK1B,OAJKC,YACHA,UAAUd,QAAMQ,cAAkCQ,KAAAA,CAAS,GAC3DJ,KAAKK,IAAIJ,KAAKC,OAAO,IAEhBA;AACT;;;;;;;;;;;AChBA,SAAAqB,sBAAAC,IAAA;CAAA,IAAAC,IAAAC,EAAA,EAAA,GAA+B,EAAAC,UAAAC,eAAAJ,IAI7BK,WAAiBP,kBAAkB,GACnCQ,YAAkBT,aAAa,GAC/BU,uBAA6BhB,OAAuB,IAAI,GAACiB,IAAAC;CAEzDnB,AAFyDW,EAAA,OAAAI,YAAAJ,EAAA,OAAAG,cAE/CI,WAAA;EACR,IAAAE,eAAqBjB,YAAYW,WAAUO,UAAW,YAAY,CAAC,CAAC,CAAAC,KAC5DjB,WAAWkB,KAAc,CAAC,CAAC,CAAAF,WACtBG,UAAW9B,aAAaqB,UAAUS,KAAK,CAAC;EAAC,aACzCJ,aAAYK,YAAa;CAAC,GACtCN,KAAA,CAACJ,UAAUD,UAAU,GAACH,EAAA,KAAAI,UAAAJ,EAAA,KAAAG,YAAAH,EAAA,KAAAO,IAAAP,EAAA,KAAAQ,OAAAD,KAAAP,EAAA,IAAAQ,KAAAR,EAAA,KALzBX,UAAUkB,IAKPC,EAAsB;CAAC,IAAAO;CAAA,AAAAf,EAAA,OAAAK,UAAAW,SAAAhB,EAAA,OAAAK,UAAAY,QAAAjB,EAAA,OAAAG,cAEhBY,WAAA;EACR,IAAAG,cACEb,UAASY,SAAUnC,cAAaqC,SAAWd,UAASW,OAAkCI,eAAK;EAE7F,AAAIF,eAAeZ,qBAAoBe,YAAahB,UAASW,SAC3DV,qBAAoBe,UAAWhB,UAASW,OAExCb,WAAUmB,KAAM,sBAAsBC,KAAAA,CAAS,CAAC,CAAAC,MAAOC,MAGtD,KACSP,gBACVZ,qBAAoBe,UAAW;CAChC,GACFrB,EAAA,KAAAK,UAAAW,OAAAhB,EAAA,KAAAK,UAAAY,MAAAjB,EAAA,KAAAG,YAAAH,EAAA,KAAAe,MAAAA,KAAAf,EAAA;CAAA,IAAA0B;CAA0B,OAA1B1B,EAAA,OAAAK,aAAAL,EAAA,OAAAG,cAAEuB,KAAA,CAACrB,WAAWF,UAAU,GAACH,EAAA,KAAAK,WAAAL,EAAA,KAAAG,YAAAH,EAAA,MAAA0B,MAAAA,KAAA1B,EAAA,KAd1BX,UAAU0B,IAcPW,EAAuB,GAEnBxB;AAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA/BjB,SAAAuB,OAAAT,OAAA;CAwBQW,QAAOC,KAAM,gDAAgDZ,KAAK;AAAC;AAxB3E,SAAAJ,QAAA;CAAA,OAU6BnB,GAAG,IAAI;AAAC;AA+DrC,MAAaoC,iCAA6D9B,OAAA;CAAA,IAAAC,IAAAC,EAAA,CAAA,GAAC,EAAAC,aAAAH,IACzEK,WAAiBP,kBAAkB,GAACU;CAAA,AAAAP,EAAA,OAAA+B,OAAAC,IAAA,2BAAA,KACRzB,KAAAZ,0BAA0B,GAACK,EAAA,KAAAO,MAAAA,KAAAP,EAAA;CAAvD,IAAAiC,WAAiB7C,WAAWmB,EAA2B,GAACC;CAAA,AAAAR,EAAA,OAAAI,YAAAJ,EAAA,OAAAiC,YAO1BzB,WAAMxB,uBAAuBoB,UAAU6B,QAAQ,GAACjC,EAAA,KAAAI,UAAAJ,EAAA,KAAAiC,UAAAjC,EAAA,KAAAQ,MAAAA,KAAAR,EAAA;CAA9E,IAAA,CAAAG,cAAqBZ,SAASiB,EAAgD;CAC9E,IAAIL,YAAU;EAAA,IAAAY;EAC4E,OAD5Ef,EAAA,OAAAE,YAAAF,EAAA,OAAAG,cACLY,KAAA,oBAAC,uBAAD;GAAmCZ;GAAaD;EAA1B,CAAA,GAA2DF,EAAA,KAAAE,UAAAF,EAAA,KAAAG,YAAAH,EAAA,KAAAe,MAAAA,KAAAf,EAAA,IAAjFe;CAAiF;CACzF,OAEMb;AAAQ;;;;;;;;;;;;;;;;;;;;;;;AC/EjB,SAAOyC,oBAAA;CAAA,IAAAC,IAAAC,EAAA,CAAA,GACLC,WAAiBN,kBAAkB,GAACO;CAAAC,KAAA;EAElC,IAAI,CAACX,uBAAuB,GAAC;GAAA,IAAAY;GAAEF,AAAFH,EAAA,OAAAE,WAA6CG,KAAAL,EAAA,MAApCK,KAAAf,2BAA2BY,QAAQ,GAACF,EAAA,KAAAE,UAAAF,EAAA,KAAAK,KAA3CF,KAAOE;GAAP,MAAAD;EAA2C;EAAA,IAAAC;EAAA,AAAAL,EAAA,OAAAE,WACXG,KAAAL,EAAA,MAAhDK,KAAAb,cAAcU,UAAU,uBAAuB,GAACF,EAAA,KAAAE,UAAAF,EAAA,KAAAK;EAA/D,IAAAC,SAAeD,IAAgDE;EAAA,AAAAP,EAAA,OAAAM,SAGkBC,KAAAP,EAAA,MAAnEO,WAAOD,OAAME,WAAY,CAAC,EAA4BC,MAAhDC,KAAAA,GAA6DV,EAAA,KAAAM,QAAAN,EAAA,KAAAO;EAAA,IAAAI;EAFjFR,AAEiFH,EAAA,OAAAM,OAAAM,aAAAZ,EAAA,OAAAO,MAF1EI,KAAA;GAAAC,WACMN,OAAMM;GAAUJ,YACfD;EACd,GAACP,EAAA,KAAAM,OAAAM,WAAAZ,EAAA,KAAAO,IAAAP,EAAA,KAAAW,MAAAA,KAAAX,EAAA,IAHDG,KAAOQ;CAGN;CANH,IAAA,EAAAC,WAAAJ,eAAgCL;CAOlB,OAEPR,qBAAqBiB,WAAWJ,UAAU;AAAC;;;;;;;;;;;;;;;;;;ACnBpD,MAAaU,WAAWD,sBAAsB;CAC5CE,UAAUN;CAEVO,gBAAgBC,UAAUC,UACxBT,cAAcQ,UAAUC,KAAK,CAAC,CAACC,WAAW,MAAMC,KAAAA;CAClDC,WAAWX;AACb,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACyCD,SAAgBwC,wCAAgE;CAM9E,OAFIxB,uBAAuB,IAAUyB,uBAAuB,IAErDC,2BAA2B;AACpC;AAIA,SAASC,YAAYC,aAAiE;CACpF,IAAIA,YAAYd,SAAS,UAAU,OAAO,CAAA;CAC1C,IAAME,MAAMjB,qBAAqB6B,WAAW,KAAK;CACjD,QAAQA,YAAYC,kBAAkBC,cAAc,CAAA,EAAA,CAAIC,KAAKC,eAAe;EAC1ExB,IAAIwB,UAAUxB;EACdC,MAAMuB,UAAUvB;EAChBC,OAAOsB,UAAUtB,SAASkB,YAAYlB;EACtCC,UAAUqB,UAAUrB,YAAY;EAChCC,WAAWoB,UAAUpB;EACrBC,SAASmB,UAAUnB;EACnBC,MAAM;EACNC,mBAAmBa,YAAYpB;EAC/BQ;CACF,EAAE;AACJ;AAEA,SAASiB,eAAeC,cAAmE;CACzF,IAAMC,eAA6C,CAAC;CACpD,KAAK,IAAMC,YAAYF,aAAaG,QAAQV,WAAW,GAAG;EACxD,IAAMT,MAAM,GAAGkB,SAASxB,UAAS,GAAIwB,SAASvB;EAE9CsB,AADAA,aAAajB,SAAS,CAAA,GACtBiB,aAAajB,IAAI,CAACqB,KAAKH,QAAQ;CACjC;CACA,OAAOD;AACT;AAIA,SAAAV,yBAAA;CAAA,IAAAe,IAAAC,EAAA,CAAA,GACEP,eAAqB5B,SAAS,mBAAmB,GAACoC;CAAA,AAAAF,EAAA,OAAAN,eAETQ,KAAAF,EAAA,MAAlBE,KAAAR,gBAAA,CAAA,GAAkBM,EAAA,KAAAN,cAAAM,EAAA,KAAAE;CAAA,IAAAC;CAAA,AAAAH,EAAA,OAAAE,KAACC,KAAAH,EAAA,MAAlCG,KAAAV,eAAeS,EAAkB,GAACF,EAAA,KAAAE,IAAAF,EAAA,KAAAG;CAD1C,IAAAvB,kCACQuB,IAEPC;CACoD,OADpDJ,EAAA,OAAApB,kCACoDwB,KAAAJ,EAAA,MAA9CI,KAAA;EAAAxB;EAAAC,OAAyC;CAAI,GAACmB,EAAA,KAAApB,iCAAAoB,EAAA,KAAAI,KAA9CA;AAA8C;AAGvD,SAAAlB,6BAAA;CAAA,IAAAc,IAAAC,EAAA,CAAA,GAAAC;CAAA,AAAAF,EAAA,OAAAK,OAAAC,IAAA,2BAAA,KAE2CJ,KAAA,CAAC,GAACF,EAAA,KAAAE,MAAAA,KAAAF,EAAA;CAD3C,IAAA,CAAApB,iCAAA2B,sCACE3C,SAAuCsC,EAAE,GAC3C,CAAArB,OAAA2B,YAA0B5C,SAAwB,IAAI,GAACuC;CAAA,AAAAH,EAAA,OAAAK,OAAAC,IAAA,2BAAA,KAEnBH,KAAA;EAAAlC,MAC5BX;EAAamD,WACRpD;CACb,GAAC2C,EAAA,KAAAG,MAAAA,KAAAH,EAAA;CAHD,IAAA,EAAAU,UAAgB7C,oBAAoBsC,EAGnC,GAACC,IAAAO;CAIFjD,AAJEsC,EAAA,OAAAU,SAmDQN,KAAAJ,EAAA,IAAAW,KAAAX,EAAA,OA/CAI,WAAA;EACR,IAAI,CAACM,OAAK;EAEV,IAAAE,kBAAA,eAAAA,gBAAAC,QAAA;GACE,IAAA;IACE,IAAAC,OAAa,MAAMJ,MAEhB,wBAAwBK,KAAAA,GAAW,EAAAF,OAAO,CAAC,GAE9ClB,eAAmD,CAAC,GACpDqB,wBAAmD,CAAA;IAoBnDR,AAlBAM,KAAIG,QAAQC,mBAAmBC,SAASvB,aAAA;KACtC,IAAIA,SAAQtB,SAAU,UAAQ;KAC9B,IAAI,CAACsB,SAAQxB,aAAT,CAAwBwB,SAAQvB,SAAQ;MAC1C2C,sBAAqBjB,KAAMH,QAAQ;MAAC;KAAA;KAGtC,IAAAlB,MAAY,GAAGkB,SAAQxB,UAAU,GAAIwB,SAAQvB;KAI7CsB,AAHKA,aAAajB,SAChBiB,aAAajB,OAAO,CAAA,IAEtBiB,aAAajB,IAAI,CAAAqB,KAAMH,QAAQ;IAAC,CACjC,GAEGoB,sBAAqBI,SAAU,MACjCzB,aAAa,8BAA8BqB,wBAG7CT,mCAAmCZ,YAAY,GAC/Ca,SAAS,IAAI;GAAC,SAAAa,IAAA;IACPC,IAAAA,MAAAA;IACP,IAAIA,eAAeC,OAAK;KACtB,IAAID,IAAGrD,SAAU,cAAY;KAG7BuC,SAAS,4BAA4B;IAAC;GACvC;EACF,GAGHgB,aAAmB,IAAIC,gBAAgB;EACL,OAAlCb,gBAAgBY,WAAUX,MAAO,SAE1B;GACLW,WAAUE,MAAO;EAAC;CACnB,GACAf,KAAA,CAACD,KAAK,GAACV,EAAA,KAAAU,OAAAV,EAAA,KAAAI,IAAAJ,EAAA,KAAAW,KA/CVjD,UAAU0C,IA+CPO,EAAO;CAAC,IAAAU;CAKV,OALUrB,EAAA,OAAAnB,SAAAmB,EAAA,OAAApB,mCAEJyC,KAAA;EAAAzC;EAAAC;CAGP,GAACmB,EAAA,KAAAnB,OAAAmB,EAAA,KAAApB,iCAAAoB,EAAA,KAAAqB,MAAAA,KAAArB,EAAA,IAHMqB;AAGN"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sanity/sdk-react",
3
- "version": "3.3.0-rc.1",
3
+ "version": "3.4.0-rc.0",
4
4
  "private": false,
5
5
  "description": "Sanity SDK React toolkit for Content OS",
6
6
  "keywords": [
@@ -43,10 +43,10 @@
43
43
  },
44
44
  "dependencies": {
45
45
  "@module-federation/runtime": "^2.9.0",
46
- "@sanity/client": "^8.6.1",
46
+ "@sanity/client": "^8.6.2",
47
47
  "@sanity/message-protocol": "^0.24.0",
48
- "@sanity/sdk": "3.3.0-rc.1",
49
- "@sanity/types": "^6.13.2",
48
+ "@sanity/sdk": "3.4.0-rc.0",
49
+ "@sanity/types": "^6.14.1",
50
50
  "react-compiler-runtime": "^1.0.0",
51
51
  "react-error-boundary": "^6.1.5",
52
52
  "rxjs": "^7.8.2"
@@ -62,23 +62,23 @@
62
62
  "@sanity/pkg-utils": "^13.0.0",
63
63
  "@testing-library/jest-dom": "^7.0.1",
64
64
  "@testing-library/react": "^16.3.3",
65
- "@types/node": "^24.13.4",
65
+ "@types/node": "^24.13.5",
66
66
  "@types/react": "^19.3.0",
67
67
  "@types/react-dom": "^19.3.0",
68
68
  "@vitejs/plugin-react": "^6.1.1",
69
- "@vitest/coverage-v8": "^5.0.0",
69
+ "@vitest/coverage-v8": "^5.0.1",
70
70
  "babel-plugin-react-compiler": "^1.0.0",
71
71
  "eslint": "^10.10.0",
72
72
  "groq": "^6.13.2",
73
73
  "groq-js": "^2.0.0",
74
74
  "jsdom": "^30.0.1",
75
- "oxfmt": "^0.67.0",
75
+ "oxfmt": "^0.68.0",
76
76
  "react": "^19.3.0",
77
77
  "react-dom": "^19.3.0",
78
78
  "rolldown": "^1.2.8",
79
79
  "typescript": "^6.0.3",
80
80
  "vite": "^8.3.0",
81
- "vitest": "^5.0.0",
81
+ "vitest": "^5.0.1",
82
82
  "xstate": "5.32.6"
83
83
  },
84
84
  "peerDependencies": {
@@ -1 +1,6 @@
1
- export {installMessageBus, resetMessageBus} from '@sanity/sdk/_internal'
1
+ export {
2
+ type ApplicationStatus,
3
+ type ApplicationStatusUpdate,
4
+ installMessageBus,
5
+ resetMessageBus,
6
+ } from '@sanity/sdk/_internal'
@@ -10,6 +10,7 @@ import {
10
10
  type MessageBusEmitResult,
11
11
  type MessageBusError,
12
12
  type MessageBusErrorCode,
13
+ type MessageBusHost,
13
14
  type MessageBusMessage,
14
15
  type MessageBusMeta,
15
16
  type MessageBusQueryOptions,
@@ -18,8 +19,14 @@ import {
18
19
  type StateTopicDef,
19
20
  type TopicName,
20
21
  type Topics,
22
+ useApplicationBasePath,
21
23
  } from './dashboard'
22
- import {type installMessageBus, type resetMessageBus} from './dashboard-internal'
24
+ import {
25
+ type ApplicationStatus,
26
+ type ApplicationStatusUpdate,
27
+ type installMessageBus,
28
+ type resetMessageBus,
29
+ } from './dashboard-internal'
23
30
 
24
31
  // Guards issue #1: every `@public` message bus type must be reachable from the
25
32
  // `@sanity/sdk-react/dashboard` entrypoint. A missing export fails `ts:check`
@@ -54,11 +61,30 @@ test('dashboard entrypoint exposes the message bus public types', () => {
54
61
  expectTypeOf<MessageBusQueryOptions['timeout']>().toEqualTypeOf<number | null | undefined>()
55
62
  expectTypeOf<MessageBusEmitResult<string>>().toExtend<PromiseLike<string>>()
56
63
  expectTypeOf<MessageBus['query']>().toBeFunction()
64
+ expectTypeOf<ReturnType<typeof useApplicationBasePath>>().toEqualTypeOf<string>()
65
+ expectTypeOf<MessageBusHost['connections']['subscribe']>().toBeFunction()
57
66
  })
58
67
 
59
- // Guards issue #3: the test-isolation helpers stay on the internal entrypoint,
60
- // not the public one.
61
- test('internal entrypoint exposes install and reset', () => {
68
+ test('internal entrypoint exposes dashboard internals', () => {
69
+ expectTypeOf<ApplicationStatus>().toEqualTypeOf<{label: string | null}>()
70
+ expectTypeOf<ApplicationStatusUpdate>().toEqualTypeOf<{
71
+ name: string
72
+ value: ApplicationStatus
73
+ }>()
74
+ expectTypeOf<PayloadOf<'applications.status.update'>>().toEqualTypeOf<ApplicationStatusUpdate>()
75
+ const emitApplicationStatus = (messageBus: ReturnType<typeof installMessageBus>) => {
76
+ messageBus.emit('applications.status.update', {name: 'list', value: {label: null}})
77
+ // @ts-expect-error application statuses always carry a label field
78
+ messageBus.emit('applications.status.update', {name: 'list', value: null})
79
+ }
80
+ const subscribeToApplicationStatus = (messageBus: ReturnType<typeof installMessageBus>) => {
81
+ messageBus.subscribe('applications.status.update')
82
+ messageBus.subscribe('applications.status.update', (message) => {
83
+ expectTypeOf(message.type).toEqualTypeOf<'applications.status.update'>()
84
+ })
85
+ }
86
+ expectTypeOf(emitApplicationStatus).toBeFunction()
87
+ expectTypeOf(subscribeToApplicationStatus).toBeFunction()
62
88
  expectTypeOf<typeof installMessageBus>().toBeFunction()
63
89
  expectTypeOf<typeof resetMessageBus>().toBeFunction()
64
90
  })
@@ -25,6 +25,7 @@ export {
25
25
  useAgentResourceContext,
26
26
  } from '../hooks/dashboard/useAgentResourceContext'
27
27
  export {useApplication} from '../hooks/dashboard/useApplication'
28
+ export {useApplicationBasePath} from '../hooks/dashboard/useApplicationBasePath'
28
29
  export {
29
30
  type ApplicationConfigSelector,
30
31
  useApplicationConfig,
@@ -37,6 +38,8 @@ export {
37
38
  type DashboardWebWorker,
38
39
  useApplications,
39
40
  } from '../hooks/dashboard/useApplications'
41
+ export {useAuthToken} from '../hooks/dashboard/useAuthToken'
42
+ export {useCurrentUser} from '../hooks/dashboard/useCurrentUser'
40
43
  export {type TopicEmitter, useEmit} from '../hooks/dashboard/useEmit'
41
44
  export {useNavigate} from '../hooks/dashboard/useNavigate'
42
45
  export {
@@ -0,0 +1,77 @@
1
+ import {installMessageBus, resetMessageBus} from '@sanity/sdk/_internal'
2
+ import {type MessageBusHost, TopicError} from '@sanity/sdk/dashboard'
3
+ import {Suspense} from 'react'
4
+ import {ErrorBoundary} from 'react-error-boundary'
5
+ import {afterEach, beforeEach, describe, expect, expectTypeOf, it, vi} from 'vitest'
6
+
7
+ import {act, render, screen} from '../../../test/test-utils'
8
+ import {useApplicationBasePath} from './useApplicationBasePath'
9
+
10
+ const MESSAGE_BUS_KEY = Symbol.for('sanity.os.bus')
11
+
12
+ let host: MessageBusHost
13
+
14
+ describe('useApplicationBasePath', () => {
15
+ beforeEach(() => {
16
+ vi.stubGlobal('__SANITY_APP_ID__', 'app')
17
+ host = installMessageBus({appId: 'dashboard'})
18
+ })
19
+
20
+ afterEach(() => {
21
+ resetMessageBus()
22
+ delete (globalThis as {[MESSAGE_BUS_KEY]?: unknown})[MESSAGE_BUS_KEY]
23
+ vi.unstubAllGlobals()
24
+ })
25
+
26
+ it('suspends until Dashboard publishes, then follows updates', async () => {
27
+ function BasePath() {
28
+ const basePath = useApplicationBasePath()
29
+ expectTypeOf(basePath).toEqualTypeOf<string>()
30
+ return <span>{basePath}</span>
31
+ }
32
+
33
+ render(
34
+ <Suspense fallback="Loading">
35
+ <BasePath />
36
+ </Suspense>,
37
+ )
38
+
39
+ expect(screen.getByText('Loading')).toBeInTheDocument()
40
+
41
+ await act(async () => {
42
+ host.connections.subscribe((client) =>
43
+ client.emit('applications.base-path', {ok: true, value: '/application/app'}),
44
+ )
45
+ })
46
+ expect(await screen.findByText('/application/app')).toBeInTheDocument()
47
+
48
+ act(() =>
49
+ host.connections.subscribe((client) =>
50
+ client.emit('applications.base-path', {ok: true, value: '/application/app-2'}),
51
+ ),
52
+ )
53
+ expect(screen.getByText('/application/app-2')).toBeInTheDocument()
54
+ })
55
+
56
+ it('throws a TopicError when the application is unknown', () => {
57
+ host.connections.subscribe((client) => client.emit('applications.base-path', {ok: false}))
58
+ const onError = vi.fn()
59
+
60
+ function BasePath() {
61
+ return <span>{useApplicationBasePath()}</span>
62
+ }
63
+
64
+ render(
65
+ <ErrorBoundary fallback={<span>Failed</span>} onError={onError}>
66
+ <Suspense fallback="Loading">
67
+ <BasePath />
68
+ </Suspense>
69
+ </ErrorBoundary>,
70
+ )
71
+
72
+ expect(screen.getByText('Failed')).toBeInTheDocument()
73
+ const error = onError.mock.calls[0][0] as TopicError
74
+ expect(error).toBeInstanceOf(TopicError)
75
+ expect(error.topic).toBe('applications.base-path')
76
+ })
77
+ })
@@ -0,0 +1,23 @@
1
+ import {type TopicData} from '@sanity/sdk/dashboard'
2
+
3
+ import {useTopic} from './useTopic'
4
+
5
+ /**
6
+ * Returns the base path for an application.
7
+ *
8
+ * Suspends until Dashboard publishes the path and throws a `TopicError` when the application is
9
+ * unknown.
10
+ *
11
+ * @example
12
+ * ```tsx
13
+ * function ApplicationBasePath() {
14
+ * const basePath = useApplicationBasePath()
15
+ * return <span>{basePath}</span>
16
+ * }
17
+ * ```
18
+ *
19
+ * @public
20
+ */
21
+ export function useApplicationBasePath(): TopicData<'applications.base-path'> {
22
+ return useTopic('applications.base-path')
23
+ }
@@ -134,15 +134,24 @@ describe('useApplications', () => {
134
134
  vi.restoreAllMocks()
135
135
  })
136
136
 
137
- it('returns minimal applications with loadable views and web workers', () => {
137
+ it('returns full applications with loadable views and web workers', () => {
138
138
  emitApplications([application, nonFederatedApplication, nonSingletonApplication])
139
139
 
140
140
  const {result} = renderHook(() => useApplications())
141
141
 
142
142
  expectTypeOf(result.current).toEqualTypeOf<DashboardApplication[]>()
143
+ expectTypeOf<
144
+ Extract<keyof DashboardApplication, 'activeDeployment' | 'config'>
145
+ >().toEqualTypeOf<'activeDeployment' | 'config'>()
143
146
  const [federated, nonFederated, nonSingleton] = result.current
144
- expect(federated).not.toHaveProperty('activeDeployment')
145
- expect(federated).not.toHaveProperty('config')
147
+ expect(federated).toMatchObject({
148
+ activeDeployment: {id: 'deployment-1'},
149
+ config: {mfManifest: {}},
150
+ })
151
+ expect(federated?.views[0]?.application).not.toHaveProperty('activeDeployment')
152
+ expect(federated?.views[0]?.application).not.toHaveProperty('config')
153
+ expect(federated?.webWorkers[0]?.application).not.toHaveProperty('activeDeployment')
154
+ expect(federated?.webWorkers[0]?.application).not.toHaveProperty('config')
146
155
  expect(federated?.views).toEqual([
147
156
  expect.objectContaining({
148
157
  application: expect.objectContaining({id: 'application-1'}),
@@ -1,4 +1,5 @@
1
1
  import {type ApplicationBase} from '@sanity/sdk'
2
+ import {getApplicationOrigin} from '@sanity/sdk/_internal'
2
3
  import {type RemoteModuleRef, type ValueOf} from '@sanity/sdk/dashboard'
3
4
  import {useMemo} from 'react'
4
5
 
@@ -38,31 +39,11 @@ export type DashboardWebWorker = Extract<DashboardApplicationInterface, {type: '
38
39
  * The minimal Brett application fields with its loadable views and web workers.
39
40
  * @public
40
41
  */
41
- export type DashboardApplication = ApplicationBase & {
42
+ export type DashboardApplication = DashboardTopicApplication & {
42
43
  readonly views: DashboardView[]
43
44
  readonly webWorkers: DashboardWebWorker[]
44
45
  }
45
46
 
46
- type SanityGlobal = typeof globalThis & {__SANITY_STAGING__?: boolean}
47
-
48
- // `null` when neither address exists: the caller exposes no modules for that application
49
- // rather than failing the whole list on one bad record.
50
- const applicationOrigin = (application: ApplicationBase): string | null => {
51
- if (application.externalUrl !== null) return new URL(application.externalUrl).origin
52
- if (application.slug === null) return null
53
-
54
- // Read at runtime, not via a bundler define: a remote is built once and runs in whichever
55
- // host page loaded it, and the host sets this flag. Mirrors workbench's `getSanityEnv`.
56
- const staging = (globalThis as SanityGlobal).__SANITY_STAGING__ === true
57
- if (application.isSingleton) {
58
- const domain = staging ? 'run.sanity.work' : 'sanity.run'
59
- return `https://${application.slug}-apps-${application.organizationId}.${domain}`
60
- }
61
-
62
- const domain = staging ? 'studio.sanity.work' : 'sanity.studio'
63
- return `https://${application.slug}.${domain}`
64
- }
65
-
66
47
  // Only a federated deployment (one with a module federation manifest) exposes loadable modules.
67
48
  const loadableInterfaces = ({
68
49
  activeDeployment,
@@ -74,8 +55,8 @@ const toApplication = (application: DashboardTopicApplication): DashboardApplica
74
55
  const {activeDeployment: _activeDeployment, config: _config, ...applicationBase} = application
75
56
  const interfaces = loadableInterfaces(application)
76
57
  // Nothing to load without interfaces or an origin to load them from.
77
- const entry = interfaces.length === 0 ? null : applicationOrigin(applicationBase)
78
- if (entry === null) return {...applicationBase, views: [], webWorkers: []}
58
+ const entry = interfaces.length === 0 ? null : getApplicationOrigin(applicationBase)
59
+ if (entry === null) return {...application, views: [], webWorkers: []}
79
60
 
80
61
  const views: DashboardView[] = []
81
62
  const webWorkers: DashboardWebWorker[] = []
@@ -103,7 +84,7 @@ const toApplication = (application: DashboardTopicApplication): DashboardApplica
103
84
  } as DashboardView)
104
85
  }
105
86
 
106
- return {...applicationBase, views, webWorkers}
87
+ return {...application, views, webWorkers}
107
88
  }
108
89
 
109
90
  /**
@@ -0,0 +1,48 @@
1
+ import {installMessageBus, resetMessageBus} from '@sanity/sdk/_internal'
2
+ import {type MessageBusHost} from '@sanity/sdk/dashboard'
3
+ import {Suspense} from 'react'
4
+ import {afterEach, beforeEach, describe, expect, expectTypeOf, it, vi} from 'vitest'
5
+
6
+ import {act, render, screen} from '../../../test/test-utils'
7
+ import {useAuthToken} from './useAuthToken'
8
+
9
+ const MESSAGE_BUS_KEY = Symbol.for('sanity.os.bus')
10
+
11
+ let host: MessageBusHost
12
+
13
+ describe('useAuthToken', () => {
14
+ beforeEach(() => {
15
+ // The SDK resolves its own app ID from the CLI-embedded global.
16
+ vi.stubGlobal('__SANITY_APP_ID__', 'app')
17
+ host = installMessageBus({appId: 'dashboard'})
18
+ })
19
+
20
+ afterEach(() => {
21
+ resetMessageBus()
22
+ delete (globalThis as {[MESSAGE_BUS_KEY]?: unknown})[MESSAGE_BUS_KEY]
23
+ vi.unstubAllGlobals()
24
+ })
25
+
26
+ it('suspends until Dashboard publishes, then follows updates', async () => {
27
+ function Token() {
28
+ const token = useAuthToken()
29
+ expectTypeOf(token).toEqualTypeOf<string | null>()
30
+ return <span>{token ?? 'none'}</span>
31
+ }
32
+ render(
33
+ <Suspense fallback="Loading">
34
+ <Token />
35
+ </Suspense>,
36
+ )
37
+
38
+ expect(screen.getByText('Loading')).toBeInTheDocument()
39
+
40
+ await act(async () => {
41
+ host.connections.subscribe((client) => client.emit('auth.token', null))
42
+ })
43
+ expect(await screen.findByText('none')).toBeInTheDocument()
44
+
45
+ act(() => host.connections.subscribe((client) => client.emit('auth.token', 'token-1')))
46
+ expect(screen.getByText('token-1')).toBeInTheDocument()
47
+ })
48
+ })
@@ -0,0 +1,20 @@
1
+ import {useTopic} from './useTopic'
2
+
3
+ /**
4
+ * Returns the session token for the reading connection, or `null` while signed out.
5
+ *
6
+ * Suspends until Dashboard publishes the token.
7
+ *
8
+ * @example
9
+ * ```tsx
10
+ * function AuthToken() {
11
+ * const token = useAuthToken()
12
+ * return <span>{token ?? 'Signed out'}</span>
13
+ * }
14
+ * ```
15
+ *
16
+ * @public
17
+ */
18
+ export function useAuthToken(): string | null {
19
+ return useTopic('auth.token')
20
+ }
@@ -0,0 +1,57 @@
1
+ import {installMessageBus, resetMessageBus} from '@sanity/sdk/_internal'
2
+ import {type MessageBusHost} from '@sanity/sdk/dashboard'
3
+ import {type CurrentUser} from '@sanity/types'
4
+ import {Suspense} from 'react'
5
+ import {afterEach, beforeEach, describe, expect, expectTypeOf, it, vi} from 'vitest'
6
+
7
+ import {act, render, screen} from '../../../test/test-utils'
8
+ import {useCurrentUser} from './useCurrentUser'
9
+
10
+ const MESSAGE_BUS_KEY = Symbol.for('sanity.os.bus')
11
+
12
+ const user: CurrentUser = {
13
+ id: 'user-1',
14
+ name: 'Ada Lovelace',
15
+ email: 'ada@example.com',
16
+ role: '',
17
+ roles: [],
18
+ }
19
+
20
+ let host: MessageBusHost
21
+
22
+ describe('useCurrentUser', () => {
23
+ beforeEach(() => {
24
+ // The SDK resolves its own app ID from the CLI-embedded global.
25
+ vi.stubGlobal('__SANITY_APP_ID__', 'app')
26
+ host = installMessageBus({appId: 'dashboard'})
27
+ })
28
+
29
+ afterEach(() => {
30
+ resetMessageBus()
31
+ delete (globalThis as {[MESSAGE_BUS_KEY]?: unknown})[MESSAGE_BUS_KEY]
32
+ vi.unstubAllGlobals()
33
+ })
34
+
35
+ it('suspends until Dashboard publishes, then follows updates', async () => {
36
+ function User() {
37
+ const current = useCurrentUser()
38
+ expectTypeOf(current).toEqualTypeOf<CurrentUser | null>()
39
+ return <span>{current?.name ?? 'none'}</span>
40
+ }
41
+ render(
42
+ <Suspense fallback="Loading">
43
+ <User />
44
+ </Suspense>,
45
+ )
46
+
47
+ expect(screen.getByText('Loading')).toBeInTheDocument()
48
+
49
+ await act(async () => {
50
+ host.connections.subscribe((client) => client.emit('users.current', null))
51
+ })
52
+ expect(await screen.findByText('none')).toBeInTheDocument()
53
+
54
+ act(() => host.connections.subscribe((client) => client.emit('users.current', user)))
55
+ expect(screen.getByText('Ada Lovelace')).toBeInTheDocument()
56
+ })
57
+ })
@@ -0,0 +1,22 @@
1
+ import {type CurrentUser} from '@sanity/types'
2
+
3
+ import {useTopic} from './useTopic'
4
+
5
+ /**
6
+ * Returns the signed-in user, or `null` while signed out.
7
+ *
8
+ * Suspends until Dashboard publishes the current user.
9
+ *
10
+ * @example
11
+ * ```tsx
12
+ * function CurrentUser() {
13
+ * const user = useCurrentUser()
14
+ * return <span>{user?.name ?? 'Signed out'}</span>
15
+ * }
16
+ * ```
17
+ *
18
+ * @public
19
+ */
20
+ export function useCurrentUser(): CurrentUser | null {
21
+ return useTopic('users.current')
22
+ }
@@ -1,8 +1,11 @@
1
1
  import {getDashboardOrganizationId} from '@sanity/sdk'
2
+ import {installMessageBus, resetMessageBus} from '@sanity/sdk/_internal'
3
+ import {type MessageBusHost} from '@sanity/sdk/dashboard'
2
4
  import {renderHook} from '@testing-library/react'
3
5
  import {throwError} from 'rxjs'
4
- import {describe, expect, it, vi} from 'vitest'
6
+ import {afterEach, beforeEach, describe, expect, it, vi} from 'vitest'
5
7
 
8
+ import {act} from '../../../test/test-utils'
6
9
  import {ResourceProvider} from '../../context/ResourceProvider'
7
10
  import {useOrganizationId} from './useOrganizationId'
8
11
 
@@ -11,6 +14,8 @@ vi.mock('@sanity/sdk', async (importOriginal) => {
11
14
  return {...(actual || {}), getDashboardOrganizationId: vi.fn()}
12
15
  })
13
16
 
17
+ const MESSAGE_BUS_KEY = Symbol.for('sanity.os.bus')
18
+
14
19
  describe('useOrganizationId', () => {
15
20
  it('should return undefined when no organization ID is set', () => {
16
21
  const subscribe = vi.fn()
@@ -49,3 +54,49 @@ describe('useOrganizationId', () => {
49
54
  expect(result.current).toBe(mockOrgId)
50
55
  })
51
56
  })
57
+
58
+ describe('useOrganizationId (message bus)', () => {
59
+ let host: MessageBusHost
60
+
61
+ beforeEach(() => {
62
+ vi.stubGlobal('__SANITY_APP_ID__', 'app')
63
+ host = installMessageBus({appId: 'dashboard'})
64
+ })
65
+
66
+ afterEach(() => {
67
+ resetMessageBus()
68
+ delete (globalThis as {[MESSAGE_BUS_KEY]?: unknown})[MESSAGE_BUS_KEY]
69
+ vi.unstubAllGlobals()
70
+ })
71
+
72
+ const wrapper = ({children}: {children: React.ReactNode}) => (
73
+ <ResourceProvider projectId="test-project" dataset="test-dataset" fallback={null}>
74
+ {children}
75
+ </ResourceProvider>
76
+ )
77
+
78
+ it('is undefined before the host publishes the current organization', () => {
79
+ const {result} = renderHook(() => useOrganizationId(), {wrapper})
80
+ expect(result.current).toBeUndefined()
81
+ })
82
+
83
+ it('returns the organization id once the host publishes it', () => {
84
+ const {result} = renderHook(() => useOrganizationId(), {wrapper})
85
+
86
+ act(() =>
87
+ host.connections.subscribe((client) =>
88
+ client.emit('organizations.current', {id: 'org_123', name: 'Org', slug: 'org'}),
89
+ ),
90
+ )
91
+
92
+ expect(result.current).toBe('org_123')
93
+ })
94
+
95
+ it('is undefined when the host publishes no active organization', () => {
96
+ const {result} = renderHook(() => useOrganizationId(), {wrapper})
97
+
98
+ act(() => host.connections.subscribe((client) => client.emit('organizations.current', null)))
99
+
100
+ expect(result.current).toBeUndefined()
101
+ })
102
+ })