@comapeo/core-react 1.0.1 → 2.0.0

package/dist/{lib → esm/lib}/react-query/projects.js

@@ -1,5 +1,5 @@
-import { queryOptions } from '@tanstack/react-query';
-import { baseQueryOptions, ROOT_QUERY_KEY } from './shared';
+import { queryOptions, } from '@tanstack/react-query';
+import { baseMutationOptions, baseQueryOptions, ROOT_QUERY_KEY, } from './shared.js';
 export function getProjectsQueryKey() {
     return [ROOT_QUERY_KEY, 'projects'];
 }
@@ -125,3 +125,85 @@ export function attachmentUrlQueryOptions({ projectApi, projectId, blobId, }) {
         },
     });
 }
+export function addServerPeerMutationOptions({ projectApi, projectId, queryClient, }) {
+    return {
+        ...baseMutationOptions(),
+        mutationFn: async ({ baseUrl, dangerouslyAllowInsecureConnections }) => {
+            return projectApi.$member.addServerPeer(baseUrl, {
+                dangerouslyAllowInsecureConnections,
+            });
+        },
+        onSuccess: () => {
+            queryClient.invalidateQueries({
+                queryKey: getMembersQueryKey({ projectId }),
+            });
+        },
+    };
+}
+export function createProjectMutationOptions({ clientApi, queryClient, }) {
+    return {
+        ...baseMutationOptions(),
+        mutationFn: async (opts) => {
+            // Have to avoid passing `undefined` explicitly
+            // See https://github.com/digidem/rpc-reflector/issues/21
+            return opts
+                ? clientApi.createProject({
+                    configPath: opts.configPath,
+                    name: opts.name,
+                })
+                : clientApi.createProject();
+        },
+        onSuccess: () => {
+            queryClient.invalidateQueries({
+                queryKey: getProjectsQueryKey(),
+            });
+        },
+    };
+}
+export function leaveProjectMutationOptions({ clientApi, queryClient, }) {
+    return {
+        ...baseMutationOptions(),
+        mutationFn: async ({ projectId }) => {
+            return clientApi.leaveProject(projectId);
+        },
+        onSuccess: () => {
+            queryClient.invalidateQueries({
+                queryKey: getProjectsQueryKey(),
+            });
+        },
+    };
+}
+export function importProjectConfigMutationOptions({ projectApi, projectId, queryClient, }) {
+    return {
+        ...baseMutationOptions(),
+        mutationFn: ({ configPath }) => {
+            return projectApi.importConfig({ configPath });
+        },
+        onSuccess: () => {
+            queryClient.invalidateQueries({
+                queryKey: getProjectByIdQueryKey({ projectId }),
+            });
+        },
+    };
+}
+export function updateProjectSettingsMutationOptions({ projectApi, queryClient, }) {
+    return {
+        ...baseMutationOptions(),
+        mutationFn: async (value) => {
+            return projectApi.$setProjectSettings(value);
+        },
+        onSuccess: () => {
+            queryClient.invalidateQueries({
+                queryKey: getProjectsQueryKey(),
+            });
+        },
+    };
+}
+export function createBlobMutationOptions({ projectApi, }) {
+    return {
+        ...baseMutationOptions(),
+        mutationFn: async ({ original, preview, thumbnail, metadata }) => {
+            return projectApi.$blobs.create({ original, preview, thumbnail }, metadata);
+        },
+    };
+}

package/dist/esm/lib/react-query/shared.d.ts

@@ -0,0 +1,9 @@
+export declare const ROOT_QUERY_KEY = "@comapeo/core-react";
+export declare function baseQueryOptions(): {
+    networkMode: "always";
+    retry: false;
+};
+export declare function baseMutationOptions(): {
+    networkMode: "always";
+    retry: false;
+};

package/dist/{lib → esm/lib}/react-query/shared.js

@@ -7,6 +7,12 @@ export const ROOT_QUERY_KEY = '@comapeo/core-react';
 export function baseQueryOptions() {
     return {
         networkMode: 'always',
-        retry: 0,
+        retry: false,
+    };
+}
+export function baseMutationOptions() {
+    return {
+        networkMode: 'always',
+        retry: false,
     };
 }

package/dist/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/docs/API.md

@@ -1,40 +1,11 @@
 ## Functions
 
 - [ClientApiProvider](#clientapiprovider)
-- [baseQueryOptions](#basequeryoptions)
-- [getClientQueryKey](#getclientquerykey)
-- [getDeviceInfoQueryKey](#getdeviceinfoquerykey)
-- [getIsArchiveDeviceQueryKey](#getisarchivedevicequerykey)
-- [deviceInfoQueryOptions](#deviceinfoqueryoptions)
-- [isArchiveDeviceQueryOptions](#isarchivedevicequeryoptions)
 - [useClientApi](#useclientapi)
 - [useOwnDeviceInfo](#useowndeviceinfo)
 - [useIsArchiveDevice](#useisarchivedevice)
-- [getDocumentsQueryKey](#getdocumentsquerykey)
-- [getManyDocumentsQueryKey](#getmanydocumentsquerykey)
-- [getDocumentByDocIdQueryKey](#getdocumentbydocidquerykey)
-- [getDocumentByVersionIdQueryKey](#getdocumentbyversionidquerykey)
-- [documentsQueryOptions](#documentsqueryoptions)
-- [documentByDocumentIdQueryOptions](#documentbydocumentidqueryoptions)
-- [documentByVersionIdQueryOptions](#documentbyversionidqueryoptions)
-- [getProjectsQueryKey](#getprojectsquerykey)
-- [getProjectByIdQueryKey](#getprojectbyidquerykey)
-- [getProjectSettingsQueryKey](#getprojectsettingsquerykey)
-- [getProjectRoleQueryKey](#getprojectrolequerykey)
-- [getMembersQueryKey](#getmembersquerykey)
-- [getMemberByIdQueryKey](#getmemberbyidquerykey)
-- [getIconUrlQueryKey](#geticonurlquerykey)
-- [getDocumentCreatedByQueryKey](#getdocumentcreatedbyquerykey)
-- [getAttachmentUrlQueryKey](#getattachmenturlquerykey)
-- [projectsQueryOptions](#projectsqueryoptions)
-- [projectByIdQueryOptions](#projectbyidqueryoptions)
-- [projectSettingsQueryOptions](#projectsettingsqueryoptions)
-- [projectMembersQueryOptions](#projectmembersqueryoptions)
-- [projectMemberByIdQueryOptions](#projectmemberbyidqueryoptions)
-- [projectOwnRoleQueryOptions](#projectownrolequeryoptions)
-- [iconUrlQueryOptions](#iconurlqueryoptions)
-- [documentCreatedByQueryOptions](#documentcreatedbyqueryoptions)
-- [attachmentUrlQueryOptions](#attachmenturlqueryoptions)
+- [useSetOwnDeviceInfo](#usesetowndeviceinfo)
+- [useSetIsArchiveDevice](#usesetisarchivedevice)
 - [useProjectSettings](#useprojectsettings)
 - [useSingleProject](#usesingleproject)
 - [useManyProjects](#usemanyprojects)
@@ -43,16 +14,23 @@
 - [useIconUrl](#useiconurl)
 - [useAttachmentUrl](#useattachmenturl)
 - [useDocumentCreatedBy](#usedocumentcreatedby)
+- [useAddServerPeer](#useaddserverpeer)
+- [useCreateProject](#usecreateproject)
+- [useLeaveProject](#useleaveproject)
+- [useImportProjectConfig](#useimportprojectconfig)
+- [useUpdateProjectSettings](#useupdateprojectsettings)
+- [useCreateBlob](#usecreateblob)
 - [useSingleDocByDocId](#usesingledocbydocid)
 - [useSingleDocByVersionId](#usesingledocbyversionid)
 - [useManyDocs](#usemanydocs)
-- [getMapsQueryKey](#getmapsquerykey)
-- [getStyleJsonUrlQueryKey](#getstylejsonurlquerykey)
-- [mapStyleJsonUrlQueryOptions](#mapstylejsonurlqueryoptions)
+- [useCreateDocument](#usecreatedocument)
+- [useUpdateDocument](#useupdatedocument)
+- [useDeleteDocument](#usedeletedocument)
+- [useAcceptInvite](#useacceptinvite)
+- [useRejectInvite](#userejectinvite)
+- [useSendInvite](#usesendinvite)
+- [useRequestCancelInvite](#userequestcancelinvite)
 - [useMapStyleUrl](#usemapstyleurl)
-- [getInvitesQueryKey](#getinvitesquerykey)
-- [getPendingInvitesQueryKey](#getpendinginvitesquerykey)
-- [pendingInvitesQueryOptions](#pendinginvitesqueryoptions)
 
 ### ClientApiProvider
 
@@ -68,42 +46,6 @@ Parameters:
 * `opts.clientApi`: Client API instance
 
 
-### baseQueryOptions
-
-| Function | Type |
-| ---------- | ---------- |
-| `baseQueryOptions` | `() => { networkMode: "always"; retry: number; }` |
-
-### getClientQueryKey
-
-| Function | Type |
-| ---------- | ---------- |
-| `getClientQueryKey` | `() => readonly ["@comapeo/core-react", "client"]` |
-
-### getDeviceInfoQueryKey
-
-| Function | Type |
-| ---------- | ---------- |
-| `getDeviceInfoQueryKey` | `() => readonly ["@comapeo/core-react", "client", "device_info"]` |
-
-### getIsArchiveDeviceQueryKey
-
-| Function | Type |
-| ---------- | ---------- |
-| `getIsArchiveDeviceQueryKey` | `() => readonly ["@comapeo/core-react", "client", "is_archive_device"]` |
-
-### deviceInfoQueryOptions
-
-| Function | Type |
-| ---------- | ---------- |
-| `deviceInfoQueryOptions` | `({ clientApi, }: { clientApi: MapeoClientApi; }) => OmitKeyof<UseQueryOptions<{ deviceId: string; deviceType: "device_type_unspecified" or "mobile" or "tablet" or "desktop" or "selfHostedServer" or "UNRECOGNIZED"; } and Partial<...>, Error, { ...; } and Partial<...>, QueryKey>, "queryFn"> and { ...; } and { ...; }` |
-
-### isArchiveDeviceQueryOptions
-
-| Function | Type |
-| ---------- | ---------- |
-| `isArchiveDeviceQueryOptions` | `({ clientApi, }: { clientApi: MapeoClientApi; }) => OmitKeyof<UseQueryOptions<boolean, Error, boolean, QueryKey>, "queryFn"> and { ...; } and { ...; }` |
-
 ### useClientApi
 
 Access a client API instance. If a ClientApiContext provider is not
@@ -167,155 +109,21 @@ function IsArchiveDeviceExample() {
 ```
 
 
-### getDocumentsQueryKey
-
-| Function | Type |
-| ---------- | ---------- |
-| `getDocumentsQueryKey` | `<D extends DocumentType>({ projectId, docType, }: { projectId: string; docType: D; }) => readonly ["@comapeo/core-react", "projects", string, D]` |
-
-### getManyDocumentsQueryKey
-
-| Function | Type |
-| ---------- | ---------- |
-| `getManyDocumentsQueryKey` | `<D extends DocumentType>({ projectId, docType, includeDeleted, lang, }: { projectId: string; docType: D; includeDeleted?: boolean or undefined; lang?: string or undefined; }) => readonly ["@comapeo/core-react", "projects", string, D, { ...; }]` |
-
-### getDocumentByDocIdQueryKey
-
-| Function | Type |
-| ---------- | ---------- |
-| `getDocumentByDocIdQueryKey` | `<D extends DocumentType>({ projectId, docType, docId, lang, }: { projectId: string; docType: D; docId: string; lang?: string or undefined; }) => readonly ["@comapeo/core-react", "projects", string, D, string, { readonly lang: string or undefined; }]` |
-
-### getDocumentByVersionIdQueryKey
-
-| Function | Type |
-| ---------- | ---------- |
-| `getDocumentByVersionIdQueryKey` | `<D extends DocumentType>({ projectId, docType, versionId, lang, }: { projectId: string; docType: D; versionId: string; lang?: string or undefined; }) => readonly ["@comapeo/core-react", "projects", string, D, string, { readonly lang: string or undefined; }]` |
-
-### documentsQueryOptions
-
-| Function | Type |
-| ---------- | ---------- |
-| `documentsQueryOptions` | `<D extends DocumentType>({ projectApi, projectId, docType, includeDeleted, lang, }: { projectApi: ClientApi<MapeoProject>; projectId: string; docType: D; includeDeleted?: boolean or undefined; lang?: string or undefined; }) => OmitKeyof<...> and ... 1 more ... and { ...; }` |
-
-### documentByDocumentIdQueryOptions
-
-| Function | Type |
-| ---------- | ---------- |
-| `documentByDocumentIdQueryOptions` | `<D extends DocumentType>({ projectApi, projectId, docType, docId, lang, }: { projectApi: ClientApi<MapeoProject>; projectId: string; docType: D; docId: string; lang?: string or undefined; }) => OmitKeyof<UseQueryOptions<({ schemaName: "track"; ... 9 more ...; deleted: boolean; } and { ...; }) or ({ ...; } and { ...; }) or ...` |
-
-### documentByVersionIdQueryOptions
-
-| Function | Type |
-| ---------- | ---------- |
-| `documentByVersionIdQueryOptions` | `<D extends DocumentType>({ projectApi, projectId, docType, versionId, lang, }: { projectApi: ClientApi<MapeoProject>; projectId: string; docType: D; versionId: string; lang?: string or undefined; }) => OmitKeyof<UseQueryOptions<{ schemaName: "track"; ... 9 more ...; deleted: boolean; } or { ...; } or { ...; } or { ...; ...` |
-
-### getProjectsQueryKey
-
-| Function | Type |
-| ---------- | ---------- |
-| `getProjectsQueryKey` | `() => readonly ["@comapeo/core-react", "projects"]` |
-
-### getProjectByIdQueryKey
-
-| Function | Type |
-| ---------- | ---------- |
-| `getProjectByIdQueryKey` | `({ projectId }: { projectId: string; }) => readonly ["@comapeo/core-react", "projects", string]` |
-
-### getProjectSettingsQueryKey
-
-| Function | Type |
-| ---------- | ---------- |
-| `getProjectSettingsQueryKey` | `({ projectId, }: { projectId: string; }) => readonly ["@comapeo/core-react", "projects", string, "project_settings"]` |
-
-### getProjectRoleQueryKey
-
-| Function | Type |
-| ---------- | ---------- |
-| `getProjectRoleQueryKey` | `({ projectId }: { projectId: string; }) => readonly ["@comapeo/core-react", "projects", string, "role"]` |
-
-### getMembersQueryKey
-
-| Function | Type |
-| ---------- | ---------- |
-| `getMembersQueryKey` | `({ projectId }: { projectId: string; }) => readonly ["@comapeo/core-react", "projects", string, "members"]` |
-
-### getMemberByIdQueryKey
-
-| Function | Type |
-| ---------- | ---------- |
-| `getMemberByIdQueryKey` | `({ projectId, deviceId, }: { projectId: string; deviceId: string; }) => readonly ["@comapeo/core-react", "projects", string, "members", string]` |
-
-### getIconUrlQueryKey
-
-| Function | Type |
-| ---------- | ---------- |
-| `getIconUrlQueryKey` | `({ projectId, iconId, ...mimeBasedOpts }: { projectId: string; iconId: string; } and (BitmapOpts or SvgOpts)) => readonly ["@comapeo/core-react", "projects", string, "icons", string, { mimeType: "image/png"; pixelDensity: 2 or ... 1 more ... or 1; size: ValidSizes; } or { ...; }]` |
-
-### getDocumentCreatedByQueryKey
-
-| Function | Type |
-| ---------- | ---------- |
-| `getDocumentCreatedByQueryKey` | `({ projectId, originalVersionId, }: { projectId: string; originalVersionId: string; }) => readonly ["@comapeo/core-react", "projects", string, "document_created_by", string]` |
-
-### getAttachmentUrlQueryKey
-
-| Function | Type |
-| ---------- | ---------- |
-| `getAttachmentUrlQueryKey` | `({ projectId, blobId, }: { projectId: string; blobId: BlobId; }) => readonly ["@comapeo/core-react", "projects", string, "attachments", BlobId]` |
-
-### projectsQueryOptions
-
-| Function | Type |
-| ---------- | ---------- |
-| `projectsQueryOptions` | `({ clientApi, }: { clientApi: MapeoClientApi; }) => OmitKeyof<UseQueryOptions<(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 ...` |
-
-### projectByIdQueryOptions
-
-| Function | Type |
-| ---------- | ---------- |
-| `projectByIdQueryOptions` | `({ clientApi, projectId, }: { clientApi: MapeoClientApi; projectId: string; }) => OmitKeyof<UseQueryOptions<ClientApi<MapeoProject>, Error, ClientApi<MapeoProject>, QueryKey>, "queryFn"> and { ...; } and { ...; }` |
-
-### projectSettingsQueryOptions
-
-| Function | Type |
-| ---------- | ---------- |
-| `projectSettingsQueryOptions` | `({ projectApi, projectId, }: { projectApi: ClientApi<MapeoProject>; projectId: string; }) => OmitKeyof<UseQueryOptions<EditableProjectSettings, Error, EditableProjectSettings, QueryKey>, "queryFn"> and { ...; } and { ...; }` |
-
-### projectMembersQueryOptions
-
-| Function | Type |
-| ---------- | ---------- |
-| `projectMembersQueryOptions` | `({ projectApi, projectId, }: { projectApi: ClientApi<MapeoProject>; projectId: string; }) => OmitKeyof<UseQueryOptions<MemberInfo[], Error, MemberInfo[], QueryKey>, "queryFn"> and { ...; } and { ...; }` |
-
-### projectMemberByIdQueryOptions
-
-| Function | Type |
-| ---------- | ---------- |
-| `projectMemberByIdQueryOptions` | `({ projectApi, projectId, deviceId, }: { projectApi: ClientApi<MapeoProject>; projectId: string; deviceId: string; }) => OmitKeyof<UseQueryOptions<MemberInfo, Error, MemberInfo, QueryKey>, "queryFn"> and { ...; } and { ...; }` |
-
-### projectOwnRoleQueryOptions
-
-| Function | Type |
-| ---------- | ---------- |
-| `projectOwnRoleQueryOptions` | `({ projectApi, projectId, }: { projectApi: ClientApi<MapeoProject>; projectId: string; }) => OmitKeyof<UseQueryOptions<Role<"a12a6702b93bd7ff" or "f7c150f5a3a9a855" or "012fd2d431c0bf60" or "9e6d29263cba36c9" or "8ced989b1904606b" or "08e4251e36f6e7ed">, Error, Role<...>, QueryKey>, "queryFn"> and { ...; } and { ...; }` |
+### useSetOwnDeviceInfo
 
-### iconUrlQueryOptions
+Update the device info for the current device.
 
 | Function | Type |
 | ---------- | ---------- |
-| `iconUrlQueryOptions` | `({ projectApi, projectId, iconId, ...mimeBasedOpts }: { projectApi: ClientApi<MapeoProject>; projectId: string; iconId: string; } and (BitmapOpts or SvgOpts)) => OmitKeyof<UseQueryOptions<string, Error, string, QueryKey>, "queryFn"> and { ...; } and { ...; }` |
-
-### documentCreatedByQueryOptions
+| `useSetOwnDeviceInfo` | `() => { mutate: UseMutateFunction<void, Error, { name: string; deviceType: "device_type_unspecified" or "mobile" or "tablet" or "desktop" or "selfHostedServer" or "UNRECOGNIZED"; }, unknown>; reset: () => void; status: "pending" or ... 2 more ... or "idle"; }` |
 
-| Function | Type |
-| ---------- | ---------- |
-| `documentCreatedByQueryOptions` | `({ projectApi, projectId, originalVersionId, }: { projectApi: ClientApi<MapeoProject>; projectId: string; originalVersionId: string; }) => OmitKeyof<UseQueryOptions<string, Error, string, QueryKey>, "queryFn"> and { ...; } and { ...; }` |
+### useSetIsArchiveDevice
 
-### attachmentUrlQueryOptions
+Set or unset the current device as an archive device.
 
 | Function | Type |
 | ---------- | ---------- |
-| `attachmentUrlQueryOptions` | `({ projectApi, projectId, blobId, }: { projectApi: ClientApi<MapeoProject>; projectId: string; blobId: BlobId; }) => OmitKeyof<UseQueryOptions<string, Error, string, QueryKey>, "queryFn"> and { ...; } and { ...; }` |
+| `useSetIsArchiveDevice` | `() => { mutate: UseMutateFunction<void, Error, { isArchiveDevice: boolean; }, unknown>; reset: () => void; status: "pending" or "error" or "success" or "idle"; }` |
 
 ### useProjectSettings
 
@@ -565,6 +373,67 @@ function BasicExample() {
 ```
 
 
+### useAddServerPeer
+
+| Function | Type |
+| ---------- | ---------- |
+| `useAddServerPeer` | `({ projectId }: { projectId: string; }) => { mutate: UseMutateFunction<void, Error, { baseUrl: string; dangerouslyAllowInsecureConnections?: boolean or undefined; }, unknown>; reset: () => void; status: "pending" or ... 2 more ... or "idle"; }` |
+
+### useCreateProject
+
+Create a new project.
+
+| Function | Type |
+| ---------- | ---------- |
+| `useCreateProject` | `() => { mutate: UseMutateFunction<string, Error, { name?: string or undefined; configPath?: string or undefined; } or undefined, unknown>; reset: () => void; status: "pending" or ... 2 more ... or "idle"; }` |
+
+### useLeaveProject
+
+Leave an existing project.
+
+| Function | Type |
+| ---------- | ---------- |
+| `useLeaveProject` | `() => { mutate: UseMutateFunction<void, Error, { projectId: string; }, unknown>; reset: () => void; status: "pending" or "error" or "success" or "idle"; }` |
+
+### useImportProjectConfig
+
+Update the configuration of a project using an external file.
+
+| Function | Type |
+| ---------- | ---------- |
+| `useImportProjectConfig` | `({ projectId }: { projectId: string; }) => { mutate: UseMutateFunction<Error[], Error, { configPath: string; }, unknown>; reset: () => void; status: "pending" or "error" or "success" or "idle"; }` |
+
+Parameters:
+
+* `opts.projectId`: Public ID of the project to apply changes to.
+
+
+### useUpdateProjectSettings
+
+Update the settings of a project.
+
+| Function | Type |
+| ---------- | ---------- |
+| `useUpdateProjectSettings` | `({ projectId }: { projectId: string; }) => { mutate: UseMutateFunction<EditableProjectSettings, Error, { name?: string or undefined; configMetadata?: { name: string; buildDate: string; importDate: string; fileVersion: string; } or undefined; defaultPresets?: { ...; } or undefined; }, unknown>; reset: () => void; status...` |
+
+Parameters:
+
+* `opts.projectId`: Public ID of the project to apply changes to.
+
+
+### useCreateBlob
+
+Create a blob for a project.
+
+| Function | Type |
+| ---------- | ---------- |
+| `useCreateBlob` | `({ projectId }: { projectId: string; }) => { mutate: UseMutateFunction<{ driveId: string; name: string; type: "audio" or "video" or "photo"; hash: string; }, Error, { original: string; preview?: string or undefined; thumbnail?: string or undefined; metadata: Metadata; }, unknown>; reset: () => void; status: "pending" or ...` |
+
+Parameters:
+
+* `opts.projectId`: Public project ID of project to apply to changes to.
+
+
 ### useSingleDocByDocId
 
 Retrieve a single document from the database based on the document's document ID.
@@ -573,7 +442,7 @@ Triggers the closest error boundary if the document cannot be found
 
 | Function | Type |
 | ---------- | ---------- |
-| `useSingleDocByDocId` | `<D extends DocumentType>({ projectId, docType, docId, lang, }: { projectId: string; docType: D; docId: string; lang?: string or undefined; }) => ReadHookResult<Extract<{ schemaName: "translation"; docRef: { docId: string; versionId: string; }; docRefType: "track" or ... 7 more ... or "type_unspecified"; ... 10 more ......` |
+| `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: "device_type_unspecified" or ... 4 more ... or "UNRECOGNIZED"; ... 7 more ...; deleted: b...` |
 
 Parameters:
 
@@ -606,7 +475,7 @@ Triggers the closest error boundary if the document cannot be found.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useSingleDocByVersionId` | `<D extends DocumentType>({ projectId, docType, versionId, lang, }: { projectId: string; docType: D; versionId: string; lang?: string or undefined; }) => ReadHookResult<Extract<{ schemaName: "translation"; docRef: { docId: string; versionId: string; }; docRefType: "track" or ... 7 more ... or "type_unspecified"; ... 10 ...` |
+| `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: "device_type_unspecified" or ... 4 more ... or "UNRECOGNIZED"; ... 7 more ...; de...` |
 
 Parameters:
 
@@ -639,7 +508,7 @@ Retrieve all documents of a specific `docType`.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useManyDocs` | `<D extends DocumentType>({ projectId, docType, includeDeleted, lang, }: { projectId: string; docType: D; includeDeleted?: boolean or undefined; lang?: string or undefined; }) => ReadHookResult<Extract<{ schemaName: "translation"; docRef: { docId: string; versionId: string; }; ... 11 more ...; deleted: boolean; }, { .....` |
+| `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: "device_type_unspecified" or ... 4 more ... or "UNRECOGNI...` |
 
 Parameters:
 
@@ -677,23 +546,89 @@ function useAllPresets(opts) {
 ```
 
 
-### getMapsQueryKey
+### useCreateDocument
+
+Create a document for a project.
+
+| Function | Type |
+| ---------- | ---------- |
+| `useCreateDocument` | `<D extends WriteableDocumentType>({ docType, projectId, }: { docType: D; projectId: string; }) => { mutate: UseMutateFunction<WriteableDocument<D> and { forks: string[]; }, Error, { value: Omit<WriteableValue<D>, "schemaName">; }, unknown>; reset: () => void; status: "pending" or ... 2 more ... or "idle"; }` |
+
+Parameters:
+
+* `opts.docType`: Document type to create.
+* `opts.projectId`: Public ID of project to create document for.
+
+
+### useUpdateDocument
+
+Update a document within a project.
 
 | Function | Type |
 | ---------- | ---------- |
-| `getMapsQueryKey` | `() => readonly ["@comapeo/core-react", "maps"]` |
+| `useUpdateDocument` | `<D extends WriteableDocumentType>({ docType, projectId, }: { docType: D; projectId: string; }) => { mutate: UseMutateFunction<WriteableDocument<D> and { forks: string[]; }, Error, { versionId: string; value: Omit<...>; }, unknown>; reset: () => void; status: "pending" or ... 2 more ... or "idle"; }` |
 
-### getStyleJsonUrlQueryKey
+Parameters:
+
+* `opts.docType`: Document type to update.
+* `opts.projectId`: Public ID of project document belongs to.
+
+
+### useDeleteDocument
+
+Delete a document within a project.
+
+| Function | Type |
+| ---------- | ---------- |
+| `useDeleteDocument` | `<D extends WriteableDocumentType>({ docType, projectId, }: { docType: D; projectId: string; }) => { mutate: UseMutateFunction<WriteableDocument<D> and { forks: string[]; }, Error, { docId: string; }, unknown>; reset: () => void; status: "pending" or ... 2 more ... or "idle"; }` |
+
+Parameters:
+
+* `opts.docType`: Document type to delete.
+* `opts.projectId`: Public ID of project document belongs to.
+
+
+### useAcceptInvite
+
+Accept an invite that has been received.
 
 | Function | Type |
 | ---------- | ---------- |
-| `getStyleJsonUrlQueryKey` | `({ refreshToken, }: { refreshToken?: string or undefined; }) => readonly ["@comapeo/core-react", "maps", "stylejson_url", { readonly refreshToken: string or undefined; }]` |
+| `useAcceptInvite` | `() => { mutate: UseMutateFunction<string, Error, { inviteId: string; }, unknown>; reset: () => void; status: "pending" or "error" or "success" or "idle"; }` |
 
-### mapStyleJsonUrlQueryOptions
+### useRejectInvite
+
+Reject an invite that has been received.
 
 | Function | Type |
 | ---------- | ---------- |
-| `mapStyleJsonUrlQueryOptions` | `({ clientApi, refreshToken, }: { clientApi: MapeoClientApi; refreshToken?: string or undefined; }) => OmitKeyof<UseQueryOptions<string, Error, string, QueryKey>, "queryFn"> and { ...; } and { ...; }` |
+| `useRejectInvite` | `() => { mutate: UseMutateFunction<void, Error, { inviteId: string; }, unknown>; reset: () => void; status: "pending" or "error" or "success" or "idle"; }` |
+
+### useSendInvite
+
+Send an invite for a project.
+
+| Function | Type |
+| ---------- | ---------- |
+| `useSendInvite` | `({ projectId }: { projectId: string; }) => { 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>; reset: () => void; status: "pendin...` |
+
+Parameters:
+
+* `opts.projectId`: Public ID of project to send the invite on behalf of.
+
+
+### useRequestCancelInvite
+
+Request a cancellation of an invite sent to another device.
+
+| Function | Type |
+| ---------- | ---------- |
+| `useRequestCancelInvite` | `({ projectId }: { projectId: string; }) => { mutate: UseMutateFunction<void, Error, { deviceId: string; }, unknown>; reset: () => void; status: "pending" or "error" or "success" or "idle"; }` |
+
+Parameters:
+
+* `opts.projectId`: Public ID of project to request the invite cancellation for.
+
 
 ### useMapStyleUrl
 
@@ -731,29 +666,10 @@ function ExampleWithRefreshToken() {
 ```
 
 
-### getInvitesQueryKey
-
-| Function | Type |
-| ---------- | ---------- |
-| `getInvitesQueryKey` | `() => readonly ["@comapeo/core-react", "invites"]` |
-
-### getPendingInvitesQueryKey
-
-| Function | Type |
-| ---------- | ---------- |
-| `getPendingInvitesQueryKey` | `() => readonly ["@comapeo/core-react", "invites", { readonly status: "pending"; }]` |
-
-### pendingInvitesQueryOptions
-
-| Function | Type |
-| ---------- | ---------- |
-| `pendingInvitesQueryOptions` | `({ clientApi, }: { clientApi: MapeoClientApi; }) => OmitKeyof<UseQueryOptions<MapBuffers<InviteInternal>[], Error, MapBuffers<InviteInternal>[], QueryKey>, "queryFn"> and { ...; } and { ...; }` |
-
 
 ## Constants
 
 - [ClientApiContext](#clientapicontext)
-- [ROOT_QUERY_KEY](#root_query_key)
 
 ### ClientApiContext
 
@@ -761,21 +677,4 @@ function ExampleWithRefreshToken() {
 | ---------- | ---------- |
 | `ClientApiContext` | `Context<MapeoClientApi or null>` |
 
-### ROOT_QUERY_KEY
-
-| Constant | Type |
-| ---------- | ---------- |
-| `ROOT_QUERY_KEY` | `"@comapeo/core-react"` |
-
-
-
-## Types
-
-- [DocumentType](#documenttype)
-
-### DocumentType
-
-| Type | Type |
-| ---------- | ---------- |
-| `DocumentType` | `Extract< MapeoDoc['schemaName'], 'field' or 'observation' or 'preset' or 'track' or 'remoteDetectionAlert' >` |