@comapeo/core-react 8.0.0 → 9.0.0

package/docs/API.md

@@ -6,6 +6,17 @@
 - [useIsArchiveDevice](#useisarchivedevice)
 - [useSetOwnDeviceInfo](#usesetowndeviceinfo)
 - [useSetIsArchiveDevice](#usesetisarchivedevice)
+- [ReceivedMapSharesProvider](#receivedmapsharesprovider)
+- [SentMapSharesProvider](#sentmapsharesprovider)
+- [useReceivedMapSharesActions](#usereceivedmapsharesactions)
+- [useReceivedMapSharesState](#usereceivedmapsharesstate)
+- [useReceivedMapSharesState](#usereceivedmapsharesstate)
+- [useReceivedMapSharesState](#usereceivedmapsharesstate)
+- [useSentMapSharesActions](#usesentmapsharesactions)
+- [useSentMapSharesState](#usesentmapsharesstate)
+- [createMapServerApi](#createmapserverapi)
+- [MapServerProvider](#mapserverprovider)
+- [useMapServerApi](#usemapserverapi)
 - [useProjectSettings](#useprojectsettings)
 - [useSingleProject](#usesingleproject)
 - [useManyProjects](#usemanyprojects)
@@ -19,8 +30,12 @@
 - [useRemoveServerPeer](#useremoveserverpeer)
 - [useCreateProject](#usecreateproject)
 - [useLeaveProject](#useleaveproject)
+- [useImportProjectCategories](#useimportprojectcategories)
 - [useImportProjectConfig](#useimportprojectconfig)
 - [useUpdateProjectSettings](#useupdateprojectsettings)
+- [useChangeMemberRole](#usechangememberrole)
+- [useRemoveMember](#useremovemember)
+- [useProjectOwnRoleChangeListener](#useprojectownrolechangelistener)
 - [useCreateBlob](#usecreateblob)
 - [useSyncState](#usesyncstate)
 - [useDataSyncProgress](#usedatasyncprogress)
@@ -37,7 +52,7 @@
 - [useCreateDocument](#usecreatedocument)
 - [useUpdateDocument](#useupdatedocument)
 - [useDeleteDocument](#usedeletedocument)
-- [useSetUpInvitesListeners](#usesetupinviteslisteners)
+- [usePresetsSelection](#usepresetsselection)
 - [useManyInvites](#usemanyinvites)
 - [useSingleInvite](#usesingleinvite)
 - [useAcceptInvite](#useacceptinvite)
@@ -45,6 +60,14 @@
 - [useSendInvite](#usesendinvite)
 - [useRequestCancelInvite](#userequestcancelinvite)
 - [useMapStyleUrl](#usemapstyleurl)
+- [useManyReceivedMapShares](#usemanyreceivedmapshares)
+- [useSingleReceivedMapShare](#usesinglereceivedmapshare)
+- [useDownloadReceivedMapShare](#usedownloadreceivedmapshare)
+- [useDeclineReceivedMapShare](#usedeclinereceivedmapshare)
+- [useAbortReceivedMapShareDownload](#useabortreceivedmapsharedownload)
+- [useSendMapShare](#usesendmapshare)
+- [useCancelSentMapShare](#usecancelsentmapshare)
+- [useSingleSentMapShare](#usesinglesentmapshare)
 
 ### ClientApiProvider
 
@@ -52,7 +75,7 @@ Create a context provider that holds a CoMapeo API client instance.
 
 | Function | Type |
 | ---------- | ---------- |
-| `ClientApiProvider` | `({ children, clientApi, }: { children: ReactNode; clientApi: MapeoClientApi; }) => Element` |
+| `ClientApiProvider` | `({ children, clientApi, }: PropsWithChildren<{ clientApi: any; }>) => Element` |
 
 Parameters:
 
@@ -67,7 +90,11 @@ set up, it will throw an error.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useClientApi` | `() => MapeoClientApi` |
+| `useClientApi` | `() => any` |
+
+Returns:
+
+Client API instance
 
 Examples:
 
@@ -95,7 +122,7 @@ Retrieve info about the current device.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useOwnDeviceInfo` | `() => { data: { deviceId: string; deviceType: "UNRECOGNIZED" or "device_type_unspecified" or "mobile" or "tablet" or "desktop" or "selfHostedServer"; } and Partial<DeviceInfoParam>; error: Error or null; isRefetching: boolean; }` |
+| `useOwnDeviceInfo` | `() => { data: any; error: Error or null; isRefetching: boolean; }` |
 
 Examples:
 
@@ -112,7 +139,7 @@ Retrieve whether the current device is an archive device or not.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useIsArchiveDevice` | `() => { data: boolean; error: Error or null; isRefetching: boolean; }` |
+| `useIsArchiveDevice` | `() => { data: any; error: Error or null; isRefetching: boolean; }` |
 
 Examples:
 
@@ -129,7 +156,7 @@ Update the device info for the current device.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useSetOwnDeviceInfo` | `() => { error: Error; mutate: UseMutateFunction<void, Error, { name: string; deviceType: "UNRECOGNIZED" or "device_type_unspecified" or "mobile" or "tablet" or "desktop" or "selfHostedServer"; }, unknown>; mutateAsync: UseMutateAsyncFunction<...>; reset: () => void; status: "error"; } or { ...; }` |
+| `useSetOwnDeviceInfo` | `() => { error: Error; mutate: UseMutateFunction<any, Error, { name: string; deviceType: "device_type_unspecified" or "mobile" or "tablet" or "desktop" or "selfHostedServer" or "UNRECOGNIZED"; }, unknown>; mutateAsync: UseMutateAsyncFunction<...>; reset: () => void; status: "error"; } or { ...; }` |
 
 ### useSetIsArchiveDevice
 
@@ -137,7 +164,120 @@ Set or unset the current device as an archive device.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useSetIsArchiveDevice` | `() => { error: Error; mutate: UseMutateFunction<void, Error, { isArchiveDevice: boolean; }, unknown>; mutateAsync: UseMutateAsyncFunction<void, Error, { isArchiveDevice: boolean; }, unknown>; reset: () => void; status: "error"; } or { ...; }` |
+| `useSetIsArchiveDevice` | `() => { error: Error; mutate: UseMutateFunction<any, Error, { isArchiveDevice: boolean; }, unknown>; mutateAsync: UseMutateAsyncFunction<any, Error, { isArchiveDevice: boolean; }, unknown>; reset: () => void; status: "error"; } or { ...; }` |
+
+### ReceivedMapSharesProvider
+
+| Function | Type |
+| ---------- | ---------- |
+| `ReceivedMapSharesProvider` | `({ children, clientApi, mapServerApi, }: MapSharesProviderProps) => Element` |
+
+### SentMapSharesProvider
+
+| Function | Type |
+| ---------- | ---------- |
+| `SentMapSharesProvider` | `({ children, clientApi, mapServerApi, }: MapSharesProviderProps) => Element` |
+
+### useReceivedMapSharesActions
+
+| Function | Type |
+| ---------- | ---------- |
+| `useReceivedMapSharesActions` | `() => { download({ shareId }: DownloadMapShareOptions): Promise<void>; decline({ shareId, reason }: DeclineMapShareOptions): Promise<void>; abort({ shareId }: AbortMapShareOptions): Promise<...>; }` |
+
+### useReceivedMapSharesState
+
+| Function | Type |
+| ---------- | ---------- |
+| `useReceivedMapSharesState` | `{ (): any[]; <T>(selector: (state: any[]) => T): T; }` |
+
+### useReceivedMapSharesState
+
+| Function | Type |
+| ---------- | ---------- |
+| `useReceivedMapSharesState` | `{ (): any[]; <T>(selector: (state: any[]) => T): T; }` |
+
+### useReceivedMapSharesState
+
+| Function | Type |
+| ---------- | ---------- |
+| `useReceivedMapSharesState` | `{ (): any[]; <T>(selector: (state: any[]) => T): T; }` |
+
+### useSentMapSharesActions
+
+| Function | Type |
+| ---------- | ---------- |
+| `useSentMapSharesActions` | `() => { createAndSend({ projectId, receiverDeviceId, mapId, }: CreateAndSendMapShareOptions): Promise<ServerMapShareState>; cancel({ shareId }: CancelMapShareOptions): Promise<...>; }` |
+
+### useSentMapSharesState
+
+| Function | Type |
+| ---------- | ---------- |
+| `useSentMapSharesState` | `<T>(selector?: ((state: ServerMapShareState[]) => T) or undefined) => T` |
+
+### createMapServerApi
+
+Utility function to create a MapServerApi instance.
+Only exported for unit testing purposes.
+
+| Function | Type |
+| ---------- | ---------- |
+| `createMapServerApi` | `({ getBaseUrl, fetch, }: MapServerApiOptions) => MapServerApi` |
+
+Parameters:
+
+* `opts.getBaseUrl`: A function that returns a promise that resolves to the base URL of the map server.
+* `opts.fetch`: An optional custom fetch function to use for making requests to the map server. If not provided, the global `fetch` will be used.
+
+
+### MapServerProvider
+
+Create a context provider that holds a `MapServerFetch` function, which waits
+for the map server to be ready before making requests.
+
+| Function | Type |
+| ---------- | ---------- |
+| `MapServerProvider` | `({ children, getBaseUrl, fetch, }: MapServerProviderProps) => Element` |
+
+Parameters:
+
+* `opts.children`: React children node
+* `opts.getBaseUrl`: A function that returns a promise that resolves to the base URL of the map server.
+* `opts.fetch`: An optional custom fetch function to use for making requests to the map server. If not provided, the global `fetch` will be used.
+
+
+Examples:
+
+```tsx
+import { createServer } from '@comapeo/map-server'
+
+const server = createServer()
+const listenPromise = server.listen()
+
+const getBaseUrl = async () => {
+  const { localPort } = await listenPromise
+  return new URL(`http://localhost:${localPort}/`)
+}
+
+const mapServerApi = createMapServerApi({ getBaseUrl })
+
+function App() {
+  return (
+    <MapServerProvider mapServerApi={mapServerApi}>
+      <MyApp />
+    </MapServerProvider>
+  )
+}
+```
+
+
+### useMapServerApi
+
+Internal hook to get the MapServerApi (instance of ky) from context.
+Throws if used outside of MapServerProvider.
+
+| Function | Type |
+| ---------- | ---------- |
+| `useMapServerApi` | `() => MapServerApi` |
 
 ### useProjectSettings
 
@@ -145,7 +285,7 @@ Retrieve the project settings for a project.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useProjectSettings` | `({ projectId }: { projectId: string; }) => { data: EditableProjectSettings; error: Error or null; isRefetching: boolean; }` |
+| `useProjectSettings` | `({ projectId }: { projectId: string; }) => { data: any; error: Error or null; isRefetching: boolean; }` |
 
 Parameters:
 
@@ -171,7 +311,7 @@ This is mostly used internally by the other hooks and should only be used if cer
 
 | Function | Type |
 | ---------- | ---------- |
-| `useSingleProject` | `({ projectId }: { projectId: string; }) => { data: ClientApi<MapeoProject>; error: Error or null; isRefetching: boolean; }` |
+| `useSingleProject` | `({ projectId }: { projectId: string; }) => { data: any; error: Error or null; isRefetching: boolean; }` |
 
 Parameters:
 
@@ -193,7 +333,7 @@ Retrieve project information for each project that exists.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useManyProjects` | `() => { data: (Pick<{ schemaName: "projectSettings"; name?: string or undefined; defaultPresets?: { point: string[]; area: string[]; vertex: string[]; line: string[]; relation: string[]; } or undefined; configMetadata?: { ...; } or undefined; }, "name"> and { ...; })[]; error: Error or null; isRefetching: boolean; }` |
+| `useManyProjects` | `() => { data: any; error: Error or null; isRefetching: boolean; }` |
 
 Examples:
 
@@ -212,7 +352,7 @@ Retrieve a single member of a project.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useSingleMember` | `({ projectId, deviceId, }: { projectId: string; deviceId: string; }) => { data: MemberInfo; error: Error or null; isRefetching: boolean; }` |
+| `useSingleMember` | `({ projectId, deviceId, }: { projectId: string; deviceId: string; }) => { data: any; error: Error or null; isRefetching: boolean; }` |
 
 Parameters:
 
@@ -237,7 +377,7 @@ Retrieve all members of a project.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useManyMembers` | `({ projectId }: { projectId: string; }) => { data: MemberInfo[]; error: Error or null; isRefetching: boolean; }` |
+| `useManyMembers` | `({ projectId }: { projectId: string; }) => { data: any; error: Error or null; isRefetching: boolean; }` |
 
 Parameters:
 
@@ -367,7 +507,7 @@ Retrieve the device ID that created a document.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useDocumentCreatedBy` | `({ projectId, originalVersionId, }: { projectId: string; originalVersionId: string; }) => { data: string; error: Error or null; isRefetching: boolean; }` |
+| `useDocumentCreatedBy` | `({ projectId, originalVersionId, }: { projectId: string; originalVersionId: string; }) => { data: any; error: Error or null; isRefetching: boolean; }` |
 
 Parameters:
 
@@ -394,7 +534,7 @@ This is a more convenient alternative to using the `useOwnDeviceInfo` and `useMa
 
 | Function | Type |
 | ---------- | ---------- |
-| `useOwnRoleInProject` | `({ projectId }: { projectId: string; }) => { data: Role<"a12a6702b93bd7ff" or "f7c150f5a3a9a855" or "012fd2d431c0bf60" or "9e6d29263cba36c9" or "8ced989b1904606b" or "a24eaca65ab5d5d0" or "08e4251e36f6e7ed">; error: Error or null; isRefetching: boolean; }` |
+| `useOwnRoleInProject` | `({ projectId }: { projectId: string; }) => { data: any; error: Error or null; isRefetching: boolean; }` |
 
 Parameters:
 
@@ -416,13 +556,13 @@ function BasicExample() {
 
 | Function | Type |
 | ---------- | ---------- |
-| `useAddServerPeer` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<void, Error, { baseUrl: string; dangerouslyAllowInsecureConnections?: boolean or undefined; }, unknown>; mutateAsync: UseMutateAsyncFunction<...>; reset: () => void; status: "error"; } or { ...; }` |
+| `useAddServerPeer` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<any, Error, { baseUrl: string; dangerouslyAllowInsecureConnections?: boolean or undefined; }, unknown>; mutateAsync: UseMutateAsyncFunction<...>; reset: () => void; status: "error"; } or { ...; }` |
 
 ### useRemoveServerPeer
 
 | Function | Type |
 | ---------- | ---------- |
-| `useRemoveServerPeer` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<void, Error, { serverDeviceId: string; dangerouslyAllowInsecureConnections?: boolean or undefined; }, unknown>; mutateAsync: UseMutateAsyncFunction<...>; reset: () => void; status: "error"; } or { ...; }` |
+| `useRemoveServerPeer` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<any, Error, { serverDeviceId: string; dangerouslyAllowInsecureConnections?: boolean or undefined; }, unknown>; mutateAsync: UseMutateAsyncFunction<...>; reset: () => void; status: "error"; } or { ...; }` |
 
 ### useCreateProject
 
@@ -430,7 +570,7 @@ Create a new project.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useCreateProject` | `() => { error: Error; mutate: UseMutateFunction<string, Error, { name?: string or undefined; configPath?: string or undefined; } or undefined, unknown>; mutateAsync: UseMutateAsyncFunction<...>; reset: () => void; status: "error"; } or { ...; }` |
+| `useCreateProject` | `() => { error: Error; mutate: UseMutateFunction<any, Error, { name?: string or undefined; configPath?: string or undefined; } or undefined, unknown>; mutateAsync: UseMutateAsyncFunction<...>; reset: () => void; status: "error"; } or { ...; }` |
 
 ### useLeaveProject
 
@@ -438,7 +578,20 @@ Leave an existing project.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useLeaveProject` | `() => { error: Error; mutate: UseMutateFunction<void, Error, { projectId: string; }, unknown>; mutateAsync: UseMutateAsyncFunction<void, Error, { projectId: string; }, unknown>; reset: () => void; status: "error"; } or { ...; }` |
+| `useLeaveProject` | `() => { error: Error; mutate: UseMutateFunction<any, Error, { projectId: string; }, unknown>; mutateAsync: UseMutateAsyncFunction<any, Error, { projectId: string; }, unknown>; reset: () => void; status: "error"; } or { ...; }` |
+
+### useImportProjectCategories
+
+Update the categories of a project using an external file.
+
+| Function | Type |
+| ---------- | ---------- |
+| `useImportProjectCategories` | `({ projectId, }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<unknown, Error, { filePath: string; }, unknown>; mutateAsync: UseMutateAsyncFunction<unknown, Error, { filePath: string; }, unknown>; reset: () => void; status: "error"; } or { ...; }` |
+
+Parameters:
+
+* `opts.projectId`: Public ID of the project to apply changes to.
+
 
 ### useImportProjectConfig
 
@@ -446,7 +599,7 @@ Update the configuration of a project using an external file.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useImportProjectConfig` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<Error[], Error, { configPath: string; }, unknown>; mutateAsync: UseMutateAsyncFunction<Error[], Error, { ...; }, unknown>; reset: () => void; status: "error"; } or { ...; }` |
+| `useImportProjectConfig` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<unknown, Error, { configPath: string; }, unknown>; mutateAsync: UseMutateAsyncFunction<unknown, Error, { configPath: string; }, unknown>; reset: () => void; status: "error"; } or { ...; }` |
 
 Parameters:
 
@@ -459,20 +612,108 @@ Update the settings of a project.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useUpdateProjectSettings` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<EditableProjectSettings, Error, { name?: string or undefined; configMetadata?: { ...; } or undefined; defaultPresets?: { ...; } or undefined; projectColor?: string or undefined; projectDescription?: string or undefined; }, unknown>; muta...` |
+| `useUpdateProjectSettings` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<any, Error, Partial<EditableProjectSettings>, unknown>; mutateAsync: UseMutateAsyncFunction<...>; reset: () => void; status: "error"; } or { ...; }` |
 
 Parameters:
 
 * `opts.projectId`: Public ID of the project to apply changes to.
 
 
+### useChangeMemberRole
+
+Change a project member's role.
+
+| Function | Type |
+| ---------- | ---------- |
+| `useChangeMemberRole` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<any, Error, { deviceId: string; roleId: "f7c150f5a3a9a855" or "012fd2d431c0bf60" or "9e6d29263cba36c9"; }, unknown>; mutateAsync: UseMutateAsyncFunction<...>; reset: () => void; status: "error"; } or { ...; }` |
+
+Parameters:
+
+* `opts.projectId`: Project public ID
+
+
+Examples:
+
+```tsx
+function BasicExample() {
+  const { mutate } = useChangeMemberRole({ projectId: '...' })
+  // Use one of: COORDINATOR_ROLE_ID, MEMBER_ROLE_ID, BLOCKED_ROLE_ID
+  mutate({ deviceId: '...', roleId: COORDINATOR_ROLE_ID })
+}
+```
+
+
+### useRemoveMember
+
+Remove a member from a project, providing an optional reason for removal.
+
+Do NOT use this for removing your own device from a project. Use `useLeaveProject` instead.
+
+| Function | Type |
+| ---------- | ---------- |
+| `useRemoveMember` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<any, Error, { deviceId: string; reason?: string or undefined; }, unknown>; mutateAsync: UseMutateAsyncFunction<...>; reset: () => void; status: "error"; } or { ...; }` |
+
+Parameters:
+
+* `opts.projectId`: Project public ID
+
+
+Examples:
+
+```tsx
+function BasicExample() {
+  const { mutate } = useRemoveMember({ projectId: '...' })
+  mutate({
+    deviceId: '...',
+    // Optional
+    reason: '...',
+  })
+}
+```
+
+
+### useProjectOwnRoleChangeListener
+
+Set up listener for changes to your own role in a project.
+It is necessary to use this if you want the project role-related read hooks to update
+based on role change events that are received in the background.
+
+| Function | Type |
+| ---------- | ---------- |
+| `useProjectOwnRoleChangeListener` | `({ projectId, listener, }: { projectId: string; listener?: ((event: RoleChangeEvent) => void) or undefined; }) => void` |
+
+Parameters:
+
+* `opts.listener`: Optional listener to invoke when role changes
+
+
+Examples:
+
+```tsx
+function SomeComponent({ projectId }: { projectId: string }) {
+  useProjectOwnRoleChangeListener({ projectId })
+}
+```
+```tsx
+function ComponentWithListener({ projectId }: { projectId: string }) {
+  useProjectOwnRoleChangeListener({
+    projectId,
+    listener: (event) => {
+      // Handle role change, e.g., navigate to default project
+      console.log('New role:', event.role)
+    }
+  })
+}
+```
+
+
 ### useCreateBlob
 
 Create a blob for a project.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useCreateBlob` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<{ driveId: string; name: string; type: "photo" or "audio" or "video"; hash: string; }, Error, { original: string; preview?: string or undefined; thumbnail?: string or undefined; metadata: Metadata; }, unknown>; mutateAsync: UseMutateAsy...` |
+| `useCreateBlob` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<any, Error, { original: string; preview?: string or undefined; thumbnail?: string or undefined; metadata: Metadata; }, unknown>; mutateAsync: UseMutateAsyncFunction<...>; reset: () => void; status: "error"; } or { ...; }` |
 
 Parameters:
 
@@ -489,7 +730,7 @@ additional listeners across the IPC channel.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useSyncState` | `({ projectId, }: { projectId: string; }) => State or null` |
+| `useSyncState` | `({ projectId, }: { projectId: string; }) => any` |
 
 Parameters:
 
@@ -519,35 +760,39 @@ Provides the progress of data sync for sync-enabled connected peers
 | ---------- | ---------- |
 | `useDataSyncProgress` | `({ projectId, }: { projectId: string; }) => number or null` |
 
+Returns:
+
+`null` if no sync state events have been received. Otherwise returns a value between 0 and 1 (inclusive)
+
 ### useStartSync
 
 | Function | Type |
 | ---------- | ---------- |
-| `useStartSync` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<void, Error, { autostopDataSyncAfter: number or null; } or undefined, unknown>; mutateAsync: UseMutateAsyncFunction<...>; reset: () => void; status: "error"; } or { ...; }` |
+| `useStartSync` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<any, Error, { autostopDataSyncAfter: number or null; } or undefined, unknown>; mutateAsync: UseMutateAsyncFunction<...>; reset: () => void; status: "error"; } or { ...; }` |
 
 ### useStopSync
 
 | Function | Type |
 | ---------- | ---------- |
-| `useStopSync` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<void, Error, void, unknown>; mutateAsync: UseMutateAsyncFunction<void, Error, void, unknown>; reset: () => void; status: "error"; } or { ...; }` |
+| `useStopSync` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<any, Error, void, unknown>; mutateAsync: UseMutateAsyncFunction<any, Error, void, unknown>; reset: () => void; status: "error"; } or { ...; }` |
 
 ### useConnectSyncServers
 
 | Function | Type |
 | ---------- | ---------- |
-| `useConnectSyncServers` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<void, Error, void, unknown>; mutateAsync: UseMutateAsyncFunction<void, Error, void, unknown>; reset: () => void; status: "error"; } or { ...; }` |
+| `useConnectSyncServers` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<any, Error, void, unknown>; mutateAsync: UseMutateAsyncFunction<any, Error, void, unknown>; reset: () => void; status: "error"; } or { ...; }` |
 
 ### useDisconnectSyncServers
 
 | Function | Type |
 | ---------- | ---------- |
-| `useDisconnectSyncServers` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<void, Error, void, unknown>; mutateAsync: UseMutateAsyncFunction<void, Error, void, unknown>; reset: () => void; status: "error"; } or { ...; }` |
+| `useDisconnectSyncServers` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<any, Error, void, unknown>; mutateAsync: UseMutateAsyncFunction<any, Error, void, unknown>; reset: () => void; status: "error"; } or { ...; }` |
 
 ### useSetAutostopDataSyncTimeout
 
 | Function | Type |
 | ---------- | ---------- |
-| `useSetAutostopDataSyncTimeout` | `({ projectId, }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<void, Error, { after: number or null; }, unknown>; mutateAsync: UseMutateAsyncFunction<void, Error, { ...; }, unknown>; reset: () => void; status: "error"; } or { ...; }` |
+| `useSetAutostopDataSyncTimeout` | `({ projectId, }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<any, Error, { after: number or null; }, unknown>; mutateAsync: UseMutateAsyncFunction<any, Error, { ...; }, unknown>; reset: () => void; status: "error"; } or { ...; }` |
 
 ### useExportGeoJSON
 
@@ -555,7 +800,7 @@ Creates a GeoJson file with all the observations and/or tracks in the project.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useExportGeoJSON` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<string, Error, { path: string; exportOptions: { observations?: boolean or undefined; tracks?: boolean or undefined; lang?: string or undefined; }; }, unknown>; mutateAsync: UseMutateAsyncFunction<...>; reset: () => void; status: "error...` |
+| `useExportGeoJSON` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<any, Error, { path: string; exportOptions: { observations?: boolean or undefined; tracks?: boolean or undefined; lang?: string or undefined; }; }, unknown>; mutateAsync: UseMutateAsyncFunction<...>; reset: () => void; status: "error"; ...` |
 
 Parameters:
 
@@ -568,7 +813,7 @@ Creates a zip file containing a GeoJson file with all the observations and/or tr
 
 | Function | Type |
 | ---------- | ---------- |
-| `useExportZipFile` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<string, Error, { path: string; exportOptions: { observations?: boolean or undefined; tracks?: boolean or undefined; lang?: string or undefined; attachments?: boolean or undefined; }; }, unknown>; mutateAsync: UseMutateAsyncFunction<...>...` |
+| `useExportZipFile` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<any, Error, { path: string; exportOptions: { observations?: boolean or undefined; tracks?: boolean or undefined; lang?: string or undefined; attachments?: boolean or undefined; }; }, unknown>; mutateAsync: UseMutateAsyncFunction<...>; r...` |
 
 Parameters:
 
@@ -583,7 +828,7 @@ Triggers the closest error boundary if the document cannot be found
 
 | Function | Type |
 | ---------- | ---------- |
-| `useSingleDocByDocId` | `<D extends WriteableDocumentType>({ projectId, docType, docId, lang, }: { projectId: string; docType: D; docId: string; lang?: string or undefined; }) => ReadHookResult<Extract<{ schemaName: "deviceInfo"; name: string; deviceType: "UNRECOGNIZED" or ... 4 more ... or "selfHostedServer"; ... 7 more ...; deleted: boolean;...` |
+| `useSingleDocByDocId` | `<D extends WriteableDocumentType>({ projectId, docType, docId, lang, }: { projectId: string; docType: D; docId: string; lang?: string or undefined; }) => { data: any; error: Error or null; isRefetching: boolean; }` |
 
 Parameters:
 
@@ -616,7 +861,7 @@ Triggers the closest error boundary if the document cannot be found.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useSingleDocByVersionId` | `<D extends WriteableDocumentType>({ projectId, docType, versionId, lang, }: { projectId: string; docType: D; versionId: string; lang?: string or undefined; }) => ReadHookResult<Extract<{ schemaName: "deviceInfo"; name: string; deviceType: "UNRECOGNIZED" or ... 4 more ... or "selfHostedServer"; ... 7 more ...; deleted: ...` |
+| `useSingleDocByVersionId` | `<D extends WriteableDocumentType>({ projectId, docType, versionId, lang, }: { projectId: string; docType: D; versionId: string; lang?: string or undefined; }) => { data: any; error: Error or null; isRefetching: boolean; }` |
 
 Parameters:
 
@@ -649,7 +894,7 @@ Retrieve all documents of a specific `docType`.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useManyDocs` | `<D extends WriteableDocumentType>({ projectId, docType, includeDeleted, lang, }: { projectId: string; docType: D; includeDeleted?: boolean or undefined; lang?: string or undefined; }) => ReadHookResult<(Extract<{ schemaName: "deviceInfo"; name: string; deviceType: "UNRECOGNIZED" or ... 4 more ... or "selfHostedServer"; ...` |
+| `useManyDocs` | `<D extends WriteableDocumentType>({ projectId, docType, includeDeleted, lang, }: { projectId: string; docType: D; includeDeleted?: boolean or undefined; lang?: string or undefined; }) => { data: any; error: Error or null; isRefetching: boolean; }` |
 
 Parameters:
 
@@ -693,7 +938,7 @@ Create a document for a project.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useCreateDocument` | `<D extends WriteableDocumentType>({ docType, projectId, }: { docType: D; projectId: string; }) => { error: Error; mutate: UseMutateFunction<WriteableDocument<D> and { forks: string[]; }, Error, { ...; }, unknown>; mutateAsync: UseMutateAsyncFunction<...>; reset: () => void; status: "error"; } or { ...; }` |
+| `useCreateDocument` | `<D extends WriteableDocumentType>({ docType, projectId, }: { docType: D; projectId: string; }) => { error: Error; mutate: UseMutateFunction<WriteableDocument<D> and DerivedDocFields, Error, { ...; }, unknown>; mutateAsync: UseMutateAsyncFunction<...>; reset: () => void; status: "error"; } or { ...; }` |
 
 Parameters:
 
@@ -707,7 +952,7 @@ Update a document within a project.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useUpdateDocument` | `<D extends WriteableDocumentType>({ docType, projectId, }: { docType: D; projectId: string; }) => { error: Error; mutate: UseMutateFunction<WriteableDocument<D> and { forks: string[]; }, Error, { ...; }, unknown>; mutateAsync: UseMutateAsyncFunction<...>; reset: () => void; status: "error"; } or { ...; }` |
+| `useUpdateDocument` | `<D extends WriteableDocumentType>({ docType, projectId, }: { docType: D; projectId: string; }) => { error: Error; mutate: UseMutateFunction<WriteableDocument<D> and DerivedDocFields, Error, { ...; }, unknown>; mutateAsync: UseMutateAsyncFunction<...>; reset: () => void; status: "error"; } or { ...; }` |
 
 Parameters:
 
@@ -721,7 +966,7 @@ Delete a document within a project.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useDeleteDocument` | `<D extends WriteableDocumentType>({ docType, projectId, }: { docType: D; projectId: string; }) => { error: Error; mutate: UseMutateFunction<WriteableDocument<D> and { forks: string[]; }, Error, { ...; }, unknown>; mutateAsync: UseMutateAsyncFunction<...>; reset: () => void; status: "error"; } or { ...; }` |
+| `useDeleteDocument` | `<D extends WriteableDocumentType>({ docType, projectId, }: { docType: D; projectId: string; }) => { error: Error; mutate: UseMutateFunction<WriteableDocument<D> and DerivedDocFields, Error, { ...; }, unknown>; mutateAsync: UseMutateAsyncFunction<...>; reset: () => void; status: "error"; } or { ...; }` |
 
 Parameters:
 
@@ -729,24 +974,41 @@ Parameters:
 * `opts.projectId`: Public ID of project document belongs to.
 
 
-### useSetUpInvitesListeners
+### usePresetsSelection
 
-Set up listeners for received and updated invites.
-It is necessary to use this if you want the invites-related read hooks to update
-based on invites that are received or changed in the background.
+Retrieve presets for category selection, ordered by project settings.
+
+Returns presets in the order defined by `projectSettings.defaultPresets` for the
+specified data type. Falls back to alphabetical order (by preset name) if no defaults are configured.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useSetUpInvitesListeners` | `() => void` |
+| `usePresetsSelection` | `({ projectId, dataType, lang, }: { projectId: string; dataType: "track" or "observation"; lang?: string or undefined; }) => { schemaName: "preset"; name: string; geometry: ("point" or "vertex" or "line" or "area" or "relation")[]; ... 13 more ...; deleted: boolean; }[]` |
+
+Parameters:
+
+* `opts.projectId`: Project public ID
+* `opts.dataType`: Type of data being created ('observation' or 'track')
+* `opts.lang`: Language to translate presets into
+
 
 Examples:
 
 ```tsx
-function App() {
-  // Use this somewhere near the root of the application
-  useSetUpInvitesListeners()
+function ObservationCategoryChooser() {
+  const presets = usePresetsSelection({
+    projectId: '...',
+    dataType: 'observation',
+  })
+}
+```
 
-  return <RestOfApp />
+```tsx
+function TrackCategoryChooser() {
+  const presets = usePresetsSelection({
+    projectId: '...',
+    dataType: 'track',
+  })
 }
 ```
 
@@ -757,7 +1019,7 @@ Get all invites that the device has received.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useManyInvites` | `() => { data: Invite[]; error: Error or null; isRefetching: boolean; }` |
+| `useManyInvites` | `() => { data: any; error: Error or null; isRefetching: boolean; }` |
 
 Examples:
 
@@ -774,7 +1036,7 @@ Get a single invite based on its ID.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useSingleInvite` | `({ inviteId }: { inviteId: string; }) => { data: Invite; error: Error or null; isRefetching: boolean; }` |
+| `useSingleInvite` | `({ inviteId }: { inviteId: string; }) => { data: any; error: Error or null; isRefetching: boolean; }` |
 
 Parameters:
 
@@ -796,7 +1058,7 @@ Accept an invite that has been received.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useAcceptInvite` | `() => { error: Error; mutate: UseMutateFunction<string, Error, { inviteId: string; }, unknown>; mutateAsync: UseMutateAsyncFunction<string, Error, { inviteId: string; }, unknown>; reset: () => void; status: "error"; } or { ...; }` |
+| `useAcceptInvite` | `() => { error: Error; mutate: UseMutateFunction<any, Error, { inviteId: string; }, unknown>; mutateAsync: UseMutateAsyncFunction<any, Error, { inviteId: string; }, unknown>; reset: () => void; status: "error"; } or { ...; }` |
 
 ### useRejectInvite
 
@@ -804,7 +1066,7 @@ Reject an invite that has been received.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useRejectInvite` | `() => { error: Error; mutate: UseMutateFunction<void, Error, { inviteId: string; }, unknown>; mutateAsync: UseMutateAsyncFunction<void, Error, { inviteId: string; }, unknown>; reset: () => void; status: "error"; } or { ...; }` |
+| `useRejectInvite` | `() => { error: Error; mutate: UseMutateFunction<any, Error, { inviteId: string; }, unknown>; mutateAsync: UseMutateAsyncFunction<any, Error, { inviteId: string; }, unknown>; reset: () => void; status: "error"; } or { ...; }` |
 
 ### useSendInvite
 
@@ -812,7 +1074,7 @@ Send an invite for a project.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useSendInvite` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<"ACCEPT" or "REJECT" or "ALREADY", Error, { deviceId: string; roleDescription?: string or undefined; roleId: "f7c150f5a3a9a855" or "012fd2d431c0bf60" or "9e6d29263cba36c9"; roleName?: string or undefined; }, unknown>; mutateAsync: UseMuta...` |
+| `useSendInvite` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<any, Error, { deviceId: string; roleDescription?: string or undefined; roleId: "f7c150f5a3a9a855" or "012fd2d431c0bf60" or "9e6d29263cba36c9"; roleName?: string or undefined; }, unknown>; mutateAsync: UseMutateAsyncFunction<...>; reset:...` |
 
 Parameters:
 
@@ -825,7 +1087,7 @@ Request a cancellation of an invite sent to another device.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useRequestCancelInvite` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<void, Error, { deviceId: string; }, unknown>; mutateAsync: UseMutateAsyncFunction<void, Error, { ...; }, unknown>; reset: () => void; status: "error"; } or { ...; }` |
+| `useRequestCancelInvite` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<any, Error, { deviceId: string; }, unknown>; mutateAsync: UseMutateAsyncFunction<any, Error, { ...; }, unknown>; reset: () => void; status: "error"; } or { ...; }` |
 
 Parameters:
 
@@ -868,40 +1130,285 @@ function ExampleWithRefreshToken() {
 ```
 
 
+### useManyReceivedMapShares
+
+Get all map shares that the device has received. Automatically updates when
+new shares arrive or share states change.
+
+IMPORTANT: This hook will not trigger a re-render when download progress
+updates, only when the status changes. This is to avoid excessive re-renders
+during downloads. Use `useSingleReceivedMapShare` to get real-time updates on
+a specific share, including download progress.
+
+| Function | Type |
+| ---------- | ---------- |
+| `useManyReceivedMapShares` | `() => any[]` |
+
+Examples:
+
+```tsx
+function MapSharesList() {
+  const shares = useManyReceivedMapShares()
+
+  return shares.map(share => (
+    <div key={share.shareId}>
+      {share.mapName} from {share.senderDeviceName} - {share.state}
+    </div>
+  ))
+}
+```
+
+
+### useSingleReceivedMapShare
+
+Get a single received map share based on its shareId.
+
+| Function | Type |
+| ---------- | ---------- |
+| `useSingleReceivedMapShare` | `({ shareId }: { shareId: string; }) => any` |
+
+Parameters:
+
+* `opts.shareId`: ID of the map share
+
+
+Examples:
+
+```tsx
+function MapShareDetail({ shareId }: { shareId: string }) {
+  const share = useSingleReceivedMapShare({ shareId })
+
+  return <div>{share.mapName} - {share.state}</div>
+}
+```
+
+
+### useDownloadReceivedMapShare
+
+Accept and download a map share that has been received. The mutate promise
+resolves once the map _starts_ downloading, before it finishes downloading.
+Use `useManyMapShares` or `useSingleMapShare` to track download progress.
+
+Throws if the share is not in `status="pending"` or if the download fails to
+start (e.g. if the shareId if invalid).
+
+| Function | Type |
+| ---------- | ---------- |
+| `useDownloadReceivedMapShare` | `() => Pick<Override<MutationObserverIdleResult<Promise<void>, Error, Omit<DownloadMapShareOptions, "projectId">, unknown>, { ...; }> and { ...; }, "error" or ... 3 more ... or "mutateAsync"> or Pick<...> or Pick<...> or Pick<...>` |
+
+Examples:
+
+```tsx
+function AcceptButton({ shareId }: { shareId: string }) {
+  const { mutate: accept } = useAcceptMapShare()
+
+  return <button onClick={() => accept({ shareId })}>Accept</button>
+}
+```
+
+
+### useDeclineReceivedMapShare
+
+Decline a map share that has been received. Notifies the sender that the
+share was declined.
+
+Throws if the share is not with `status="pending"`
+Throws if shareId is invalid
+Throws if decline request fails (e.g. network error)
+
+| Function | Type |
+| ---------- | ---------- |
+| `useDeclineReceivedMapShare` | `() => Pick<Override<MutationObserverIdleResult<Promise<void>, Error, Omit<DeclineMapShareOptions, "projectId">, unknown>, { ...; }> and { ...; }, "error" or ... 3 more ... or "mutateAsync"> or Pick<...> or Pick<...> or Pick<...>` |
+
+Examples:
+
+```tsx
+function DeclineButton({ shareId }: { shareId: string }) {
+  const { mutate: decline } = useDeclineMapShare()
+
+  return (
+    <button onClick={() => decline({ shareId, reason: 'user_rejected' })}>
+      Decline
+    </button>
+  )
+}
+```
+
+
+### useAbortReceivedMapShareDownload
+
+Abort an in-progress map share download.
+
+Throws if the share is not in `status="downloading"`
+Throws if shareId is invalid
+
+| Function | Type |
+| ---------- | ---------- |
+| `useAbortReceivedMapShareDownload` | `() => Pick<Override<MutationObserverIdleResult<Promise<void>, Error, Omit<AbortMapShareOptions, "projectId">, unknown>, { ...; }> and { ...; }, "error" or ... 3 more ... or "mutateAsync"> or Pick<...> or Pick<...> or Pick<...>` |
+
+Examples:
+
+```tsx
+function AbortButton({ shareId }: { shareId: string }) {
+  const { mutate: abort } = useAbortMapShareDownload()
+
+  return <button onClick={() => abort({ shareId })}>Cancel Download</button>
+}
+```
+
+
+### useSendMapShare
+
+Share a map with a device. The mutation resolves immediately after sending
+the share offer, without waiting for the recipient to accept or reject. The
+mutation resolves with the created map share object, including its ID, which
+can be used to track the share status with `useSingleSentMapShare`.
+
+| Function | Type |
+| ---------- | ---------- |
+| `useSendMapShare` | `({ projectId }: { projectId: string; }) => Pick<Override<MutationObserverIdleResult<Promise<ServerMapShareState>, Error, CreateAndSendMapShareOptions, unknown>, { ...; }> and { ...; }, "error" or ... 3 more ... or "mutateAsync"> or Pick<...> or Pick<...> or Pick<...>` |
+
+Parameters:
+
+* `opts.projectId`: Public ID of project for sending the map share: you can only send map shares to users on the same project
+
+
+Examples:
+
+```tsx
+function SendMapButton({ projectId, deviceId }: { projectId: string; deviceId: string }) {
+  const { mutate: send } = useSendMapShare({ projectId }, {
+    onSuccess: (mapShare) => {
+ 	   console.log('Share sent with id', mapShare.shareId)
+    }
+  })
+
+  return (
+    <button onClick={() => send({ receiverDeviceId: deviceId, mapId: 'custom' })}>
+      Send Map
+    </button>
+  )
+}
+```
+
+
+### useCancelSentMapShare
+
+Cancel a map share that was previously sent. If the recipient has not yet
+started downloading the share, they will not be notified until they attempt
+to accept the share and begin downloading it. If they are already downloading
+the share, the download will be canceled before completion. If the download
+is already complete, this action will throw an error.
+
+| Function | Type |
+| ---------- | ---------- |
+| `useCancelSentMapShare` | `() => Pick<Override<MutationObserverIdleResult<Promise<void>, Error, Omit<CancelMapShareOptions, "projectId">, unknown>, { ...; }> and { ...; }, "error" or ... 3 more ... or "mutateAsync"> or Pick<...> or Pick<...> or Pick<...>` |
+
+Parameters:
+
+* `opts.projectId`: Public ID of project to request the map share cancellation for.
+
+
+Examples:
+
+```tsx
+function CancelShareButton({ projectId, shareId }: { projectId: string; shareId: string }) {
+  const { mutate: cancel } = useRequestCancelMapShare({ projectId })
+
+  return <button onClick={() => cancel({ shareId })}>Cancel Share</button>
+}
+```
+
+
+### useSingleSentMapShare
+
+Track the status and progress of a sent map share. Returns the current state
+of the share, updated in real-time. When the recipient starts downloading, or
+if they decline the share, then the returned share will update.
+
+Throws if no share with the specified ID is found.
+
+| Function | Type |
+| ---------- | ---------- |
+| `useSingleSentMapShare` | `({ shareId, }: { shareId: string; }) => ServerMapShareState` |
+
+Parameters:
+
+* `opts.shareId`: ID of the sent map share
+
+
+Examples:
+
+```tsx
+function SentShareStatus({ shareId }: { shareId: string }) {
+  const mapShare = useSingleSentMapShare({ shareId })
+
+  return (<div>
+		<div>Share status: {mapShare.status}</div>
+   {mapShare.status === 'pending' && <div>Waiting for recipient to accept...</div>}
+  	{mapShare.status === 'downloading' && (<div>Download in progress: {mapShare.downloadProgress}%</div>)}
+  	{mapShare.status === 'declined' && <div>Share was declined by recipient</div>}
+	  {mapShare.status === 'canceled' && <div>Share was canceled</div>}
+  </div>)
+}
+```
+
+
 
 ## Constants
 
 - [ClientApiContext](#clientapicontext)
+- [ReceivedMapSharesContext](#receivedmapsharescontext)
+- [SentMapSharesContext](#sentmapsharescontext)
+- [MapServerContext](#mapservercontext)
 
 ### ClientApiContext
 
 | Constant | Type |
 | ---------- | ---------- |
-| `ClientApiContext` | `Context<MapeoClientApi or null>` |
+| `ClientApiContext` | `Context<any>` |
+
+### ReceivedMapSharesContext
+
+| Constant | Type |
+| ---------- | ---------- |
+| `ReceivedMapSharesContext` | `Context<{ subscribe: (listener: () => void) => () => boolean; getSnapshot: () => any[]; actions: { download({ shareId }: DownloadMapShareOptions): Promise<void>; decline({ shareId, reason }: DeclineMapShareOptions): Promise<...>; abort({ shareId }: AbortMapShareOptions): Promise<...>; }; } or null>` |
+
+### SentMapSharesContext
+
+| Constant | Type |
+| ---------- | ---------- |
+| `SentMapSharesContext` | `Context<{ subscribe: (listener: () => void) => () => boolean; getSnapshot: () => ServerMapShareState[]; actions: { createAndSend({ projectId, receiverDeviceId, mapId, }: CreateAndSendMapShareOptions): Promise<ServerMapShareState>; cancel({ shareId }: CancelMapShareOptions): Promise<...>; }; } or null>` |
+
+### MapServerContext
+
+| Constant | Type |
+| ---------- | ---------- |
+| `MapServerContext` | `Context<MapServerApi or null>` |
 
 
 
 ## Types
 
-- [WriteableDocumentType](#writeabledocumenttype)
-- [WriteableValue](#writeablevalue)
-- [WriteableDocument](#writeabledocument)
+- [MapServerApiOptions](#mapserverapioptions)
+- [MapServerApi](#mapserverapi)
+- [MapServerProviderProps](#mapserverproviderprops)
 
-### WriteableDocumentType
+### MapServerApiOptions
 
 | Type | Type |
 | ---------- | ---------- |
-| `WriteableDocumentType` | `Extract< MapeoDoc['schemaName'], 'field' or 'observation' or 'preset' or 'track' or 'remoteDetectionAlert' >` |
+| `MapServerApiOptions` | `{ getBaseUrl(): Promise<URL> fetch?( input: string or URL or Request, options?: RequestInit, ): Promise<Response> }` |
 
-### WriteableValue
+### MapServerApi
 
 | Type | Type |
 | ---------- | ---------- |
-| `WriteableValue` | `Extract< MapeoValue, { schemaName: D } >` |
+| `MapServerApi` | `KyInstance and { createEventSource(options: EventSourceOptions): EventSourceClient getMapStyleJsonUrl(mapId: string): Promise<string> }` |
 
-### WriteableDocument
+### MapServerProviderProps
 
 | Type | Type |
 | ---------- | ---------- |
-| `WriteableDocument` | `Extract< MapeoDoc, { schemaName: D } >` |
+| `MapServerProviderProps` | `PropsWithChildren<MapServerApiOptions>` |