@comapeo/core-react 2.0.1 → 3.1.0

package/dist/commonjs/contexts/ClientApi.d.ts

@@ -1,14 +1,14 @@
 import type { MapeoClientApi } from '@comapeo/ipc' with { 'resolution-mode': 'import' };
-import { type ReactNode } from 'react';
+import { type JSX, type ReactNode } from 'react';
 export declare const ClientApiContext: import("react").Context<import("@comapeo/ipc/dist/client.js", { with: { "resolution-mode": "import" } }).MapeoClientApi | null>;
 /**
  * Create a context provider that holds a CoMapeo API client instance.
  *
- * @param opts
- * @param {ReactNode} opts.children React children node
- * @param {MapeoClientApi} opts.clientApi Client API instance
+ * @param opts.children React children node
+ * @param opts.clientApi Client API instance
+ *
  */
 export declare function ClientApiProvider({ children, clientApi, }: {
     children: ReactNode;
     clientApi: MapeoClientApi;
-}): import("react").FunctionComponentElement<import("react").ProviderProps<import("@comapeo/ipc/dist/client.js", { with: { "resolution-mode": "import" } }).MapeoClientApi | null>>;
+}): JSX.Element;

package/dist/commonjs/contexts/ClientApi.js

@@ -7,9 +7,9 @@ exports.ClientApiContext = (0, react_1.createContext)(null);
 /**
  * Create a context provider that holds a CoMapeo API client instance.
  *
- * @param opts
- * @param {ReactNode} opts.children React children node
- * @param {MapeoClientApi} opts.clientApi Client API instance
+ * @param opts.children React children node
+ * @param opts.clientApi Client API instance
+ *
  */
 function ClientApiProvider({ children, clientApi, }) {
     return (0, react_1.createElement)(exports.ClientApiContext.Provider, { value: clientApi }, children);

package/dist/commonjs/hooks/documents.d.ts

@@ -1,5 +1,5 @@
 import type { MapeoDoc } from '@comapeo/schema' with { 'resolution-mode': 'import' };
-import { type WriteableDocumentType } from '../lib/react-query/documents.js';
+import type { WriteableDocumentType } from '../lib/types.js';
 type ReadHookResult<D> = {
     data: D;
     error: Error | null;
@@ -119,10 +119,10 @@ export declare function useCreateDocument<D extends WriteableDocumentType>({ doc
     docType: D;
     projectId: string;
 }): {
-    mutate: import("@tanstack/react-query").UseMutateFunction<import("../lib/react-query/documents.js").WriteableDocument<D> & {
+    mutate: import("@tanstack/react-query").UseMutateFunction<import("../lib/types.js").WriteableDocument<D> & {
         forks: Array<string>;
     }, Error, {
-        value: Omit<import("../lib/react-query/documents.js").WriteableValue<D>, "schemaName">;
+        value: Omit<import("../lib/types.js").WriteableValue<D>, "schemaName">;
     }, unknown>;
     reset: () => void;
     status: "pending" | "error" | "success" | "idle";
@@ -137,11 +137,11 @@ export declare function useUpdateDocument<D extends WriteableDocumentType>({ doc
     docType: D;
     projectId: string;
 }): {
-    mutate: import("@tanstack/react-query").UseMutateFunction<import("../lib/react-query/documents.js").WriteableDocument<D> & {
+    mutate: import("@tanstack/react-query").UseMutateFunction<import("../lib/types.js").WriteableDocument<D> & {
         forks: Array<string>;
     }, Error, {
         versionId: string;
-        value: Omit<import("../lib/react-query/documents.js").WriteableValue<D>, "schemaName">;
+        value: Omit<import("../lib/types.js").WriteableValue<D>, "schemaName">;
     }, unknown>;
     reset: () => void;
     status: "pending" | "error" | "success" | "idle";
@@ -156,7 +156,7 @@ export declare function useDeleteDocument<D extends WriteableDocumentType>({ doc
     docType: D;
     projectId: string;
 }): {
-    mutate: import("@tanstack/react-query").UseMutateFunction<import("../lib/react-query/documents.js").WriteableDocument<D> & {
+    mutate: import("@tanstack/react-query").UseMutateFunction<import("../lib/types.js").WriteableDocument<D> & {
         forks: Array<string>;
     }, Error, {
         docId: string;

package/dist/commonjs/hooks/projects.d.ts

@@ -1,5 +1,6 @@
 import type { BitmapOpts, SvgOpts } from '@comapeo/core/dist/icon-api.js' with { 'resolution-mode': 'import' };
 import type { BlobId } from '@comapeo/core/dist/types.js' with { 'resolution-mode': 'import' };
+import { type SyncState } from '../lib/sync.js';
 /**
  * Retrieve the project settings for a project.
  *
@@ -249,6 +250,28 @@ export declare function useDocumentCreatedBy({ projectId, originalVersionId, }:
     error: Error | null;
     isRefetching: boolean;
 };
+/**
+ * Get the role for the current device in a specified project.
+ * This is a more convenient alternative to using the `useOwnDeviceInfo` and `useManyMembers` hooks.
+ *
+ * @param opts.projectId Project public ID
+ *
+ * @example
+ * ```tsx
+ * function BasicExample() {
+ *   const { data } = useOwnRoleInProject({
+ *     projectId: '...',
+ *   })
+ * }
+ * ```
+ */
+export declare function useOwnRoleInProject({ projectId }: {
+    projectId: string;
+}): {
+    data: import("@comapeo/core/dist/roles.js", { with: { "resolution-mode": "import" } }).Role<"a12a6702b93bd7ff" | "f7c150f5a3a9a855" | "012fd2d431c0bf60" | "9e6d29263cba36c9" | "8ced989b1904606b" | "08e4251e36f6e7ed">;
+    error: Error | null;
+    isRefetching: boolean;
+};
 export declare function useAddServerPeer({ projectId }: {
     projectId: string;
 }): {
@@ -332,3 +355,52 @@ export declare function useCreateBlob({ projectId }: {
     reset: () => void;
     status: "pending" | "error" | "success" | "idle";
 };
+/**
+ * Hook to subscribe to the current sync state.
+ *
+ * Creates a global singleton for each project, to minimize traffic over IPC -
+ * this hook can safely be used in more than one place without attaching
+ * additional listeners across the IPC channel.
+ *
+ * @example
+ * ```ts
+ * function Example() {
+ *     const syncState = useSyncState({ projectId });
+ *
+ *     if (!syncState) {
+ *         // Sync information hasn't been loaded yet
+ *     }
+ *
+ *     // Actual info about sync state is available...
+ * }
+ * ```
+ *
+ * @param opts.projectId Project public ID
+ */
+export declare function useSyncState({ projectId, }: {
+    projectId: string;
+}): SyncState | null;
+/**
+ * Provides the progress of data sync for sync-enabled connected peers
+ *
+ * @returns `null` if no sync state events have been received. Otherwise returns a value between 0 and 1 (inclusive)
+ */
+export declare function useDataSyncProgress({ projectId, }: {
+    projectId: string;
+}): number | null;
+export declare function useStartSync({ projectId }: {
+    projectId: string;
+}): {
+    mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
+        autostopDataSyncAfter: number | null;
+    } | undefined, unknown>;
+    reset: () => void;
+    status: "pending" | "error" | "success" | "idle";
+};
+export declare function useStopSync({ projectId }: {
+    projectId: string;
+}): {
+    mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, void, unknown>;
+    reset: () => void;
+    status: "pending" | "error" | "success" | "idle";
+};

package/dist/commonjs/hooks/projects.js

@@ -8,14 +8,21 @@ exports.useManyMembers = useManyMembers;
 exports.useIconUrl = useIconUrl;
 exports.useAttachmentUrl = useAttachmentUrl;
 exports.useDocumentCreatedBy = useDocumentCreatedBy;
+exports.useOwnRoleInProject = useOwnRoleInProject;
 exports.useAddServerPeer = useAddServerPeer;
 exports.useCreateProject = useCreateProject;
 exports.useLeaveProject = useLeaveProject;
 exports.useImportProjectConfig = useImportProjectConfig;
 exports.useUpdateProjectSettings = useUpdateProjectSettings;
 exports.useCreateBlob = useCreateBlob;
+exports.useSyncState = useSyncState;
+exports.useDataSyncProgress = useDataSyncProgress;
+exports.useStartSync = useStartSync;
+exports.useStopSync = useStopSync;
 const react_query_1 = require("@tanstack/react-query");
+const react_1 = require("react");
 const projects_js_1 = require("../lib/react-query/projects.js");
+const sync_js_1 = require("../lib/sync.js");
 const client_js_1 = require("./client.js");
 /**
  * Retrieve the project settings for a project.
@@ -262,6 +269,26 @@ function useDocumentCreatedBy({ projectId, originalVersionId, }) {
     const { data, error, isRefetching } = (0, react_query_1.useSuspenseQuery)((0, projects_js_1.documentCreatedByQueryOptions)({ projectApi, projectId, originalVersionId }));
     return { data, error, isRefetching };
 }
+/**
+ * Get the role for the current device in a specified project.
+ * This is a more convenient alternative to using the `useOwnDeviceInfo` and `useManyMembers` hooks.
+ *
+ * @param opts.projectId Project public ID
+ *
+ * @example
+ * ```tsx
+ * function BasicExample() {
+ *   const { data } = useOwnRoleInProject({
+ *     projectId: '...',
+ *   })
+ * }
+ * ```
+ */
+function useOwnRoleInProject({ projectId }) {
+    const { data: projectApi } = useSingleProject({ projectId });
+    const { data, error, isRefetching } = (0, react_query_1.useSuspenseQuery)((0, projects_js_1.projectOwnRoleQueryOptions)({ projectApi, projectId }));
+    return { data, error, isRefetching };
+}
 function useAddServerPeer({ projectId }) {
     const queryClient = (0, react_query_1.useQueryClient)();
     const { data: projectApi } = useSingleProject({ projectId });
@@ -318,3 +345,59 @@ function useCreateBlob({ projectId }) {
     const { mutate, reset, status } = (0, react_query_1.useMutation)((0, projects_js_1.createBlobMutationOptions)({ projectApi }));
     return { mutate, reset, status };
 }
+const PROJECT_SYNC_STORE_MAP = new WeakMap();
+function useSyncStore({ projectId }) {
+    const { data: projectApi } = useSingleProject({ projectId });
+    let syncStore = PROJECT_SYNC_STORE_MAP.get(projectApi);
+    if (!syncStore) {
+        syncStore = new sync_js_1.SyncStore(projectApi);
+        PROJECT_SYNC_STORE_MAP.set(projectApi, syncStore);
+    }
+    return syncStore;
+}
+/**
+ * Hook to subscribe to the current sync state.
+ *
+ * Creates a global singleton for each project, to minimize traffic over IPC -
+ * this hook can safely be used in more than one place without attaching
+ * additional listeners across the IPC channel.
+ *
+ * @example
+ * ```ts
+ * function Example() {
+ *     const syncState = useSyncState({ projectId });
+ *
+ *     if (!syncState) {
+ *         // Sync information hasn't been loaded yet
+ *     }
+ *
+ *     // Actual info about sync state is available...
+ * }
+ * ```
+ *
+ * @param opts.projectId Project public ID
+ */
+function useSyncState({ projectId, }) {
+    const syncStore = useSyncStore({ projectId });
+    const { subscribe, getStateSnapshot } = syncStore;
+    return (0, react_1.useSyncExternalStore)(subscribe, getStateSnapshot);
+}
+/**
+ * Provides the progress of data sync for sync-enabled connected peers
+ *
+ * @returns `null` if no sync state events have been received. Otherwise returns a value between 0 and 1 (inclusive)
+ */
+function useDataSyncProgress({ projectId, }) {
+    const { subscribe, getDataProgressSnapshot } = useSyncStore({ projectId });
+    return (0, react_1.useSyncExternalStore)(subscribe, getDataProgressSnapshot);
+}
+function useStartSync({ projectId }) {
+    const { data: projectApi } = useSingleProject({ projectId });
+    const { mutate, reset, status } = (0, react_query_1.useMutation)((0, projects_js_1.startSyncMutationOptions)({ projectApi }));
+    return { mutate, reset, status };
+}
+function useStopSync({ projectId }) {
+    const { data: projectApi } = useSingleProject({ projectId });
+    const { mutate, reset, status } = (0, react_query_1.useMutation)((0, projects_js_1.stopSyncMutationOptions)({ projectApi }));
+    return { mutate, reset, status };
+}

package/dist/commonjs/index.d.ts

@@ -3,10 +3,6 @@ export { useClientApi, useIsArchiveDevice, useOwnDeviceInfo, useSetIsArchiveDevi
 export { useCreateDocument, useDeleteDocument, useManyDocs, useSingleDocByDocId, useSingleDocByVersionId, useUpdateDocument, } from './hooks/documents.js';
 export { useAcceptInvite, useRejectInvite, useRequestCancelInvite, useSendInvite, } from './hooks/invites.js';
 export { useMapStyleUrl } from './hooks/maps.js';
-export { useAddServerPeer, useAttachmentUrl, useCreateBlob, useCreateProject, useDocumentCreatedBy, useIconUrl, useImportProjectConfig, useLeaveProject, useManyMembers, useManyProjects, useProjectSettings, useSingleMember, useSingleProject, useUpdateProjectSettings, } from './hooks/projects.js';
-export { getClientQueryKey, getDeviceInfoQueryKey, getIsArchiveDeviceQueryKey, } from './lib/react-query/client.js';
-export { getDocumentByDocIdQueryKey, getDocumentByVersionIdQueryKey, getDocumentsQueryKey, getManyDocumentsQueryKey, type WriteableDocument, type WriteableDocumentType, type WriteableValue, } from './lib/react-query/documents.js';
-export { getInvitesQueryKey, getPendingInvitesQueryKey, } from './lib/react-query/invites.js';
-export { getMapsQueryKey, getStyleJsonUrlQueryKey, } from './lib/react-query/maps.js';
-export { getAttachmentUrlQueryKey, getDocumentCreatedByQueryKey, getIconUrlQueryKey, getMemberByIdQueryKey, getMembersQueryKey, getProjectByIdQueryKey, getProjectRoleQueryKey, getProjectSettingsQueryKey, getProjectsQueryKey, } from './lib/react-query/projects.js';
-export { ROOT_QUERY_KEY } from './lib/react-query/shared.js';
+export { useAddServerPeer, useAttachmentUrl, useCreateBlob, useCreateProject, useDataSyncProgress, useDocumentCreatedBy, useIconUrl, useImportProjectConfig, useLeaveProject, useManyMembers, useManyProjects, useOwnRoleInProject, useProjectSettings, useSingleMember, useSingleProject, useStartSync, useStopSync, useSyncState, useUpdateProjectSettings, } from './hooks/projects.js';
+export { type SyncState } from './lib/sync.js';
+export { type WriteableDocument, type WriteableDocumentType, type WriteableValue, } from './lib/types.js';

package/dist/commonjs/index.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getProjectRoleQueryKey = exports.getProjectByIdQueryKey = exports.getMembersQueryKey = exports.getMemberByIdQueryKey = exports.getIconUrlQueryKey = exports.getDocumentCreatedByQueryKey = exports.getAttachmentUrlQueryKey = exports.getStyleJsonUrlQueryKey = exports.getMapsQueryKey = exports.getPendingInvitesQueryKey = exports.getInvitesQueryKey = exports.getManyDocumentsQueryKey = exports.getDocumentsQueryKey = exports.getDocumentByVersionIdQueryKey = exports.getDocumentByDocIdQueryKey = exports.getIsArchiveDeviceQueryKey = exports.getDeviceInfoQueryKey = exports.getClientQueryKey = exports.useUpdateProjectSettings = exports.useSingleProject = exports.useSingleMember = exports.useProjectSettings = exports.useManyProjects = exports.useManyMembers = exports.useLeaveProject = exports.useImportProjectConfig = exports.useIconUrl = exports.useDocumentCreatedBy = exports.useCreateProject = exports.useCreateBlob = exports.useAttachmentUrl = exports.useAddServerPeer = exports.useMapStyleUrl = exports.useSendInvite = exports.useRequestCancelInvite = exports.useRejectInvite = exports.useAcceptInvite = exports.useUpdateDocument = exports.useSingleDocByVersionId = exports.useSingleDocByDocId = exports.useManyDocs = exports.useDeleteDocument = exports.useCreateDocument = exports.useSetOwnDeviceInfo = exports.useSetIsArchiveDevice = exports.useOwnDeviceInfo = exports.useIsArchiveDevice = exports.useClientApi = exports.ClientApiProvider = exports.ClientApiContext = void 0;
-exports.ROOT_QUERY_KEY = exports.getProjectsQueryKey = exports.getProjectSettingsQueryKey = void 0;
+exports.useUpdateProjectSettings = exports.useSyncState = exports.useStopSync = exports.useStartSync = exports.useSingleProject = exports.useSingleMember = exports.useProjectSettings = exports.useOwnRoleInProject = exports.useManyProjects = exports.useManyMembers = exports.useLeaveProject = exports.useImportProjectConfig = exports.useIconUrl = exports.useDocumentCreatedBy = exports.useDataSyncProgress = exports.useCreateProject = exports.useCreateBlob = exports.useAttachmentUrl = exports.useAddServerPeer = exports.useMapStyleUrl = exports.useSendInvite = exports.useRequestCancelInvite = exports.useRejectInvite = exports.useAcceptInvite = exports.useUpdateDocument = exports.useSingleDocByVersionId = exports.useSingleDocByDocId = exports.useManyDocs = exports.useDeleteDocument = exports.useCreateDocument = exports.useSetOwnDeviceInfo = exports.useSetIsArchiveDevice = exports.useOwnDeviceInfo = exports.useIsArchiveDevice = exports.useClientApi = exports.ClientApiProvider = exports.ClientApiContext = void 0;
 var ClientApi_js_1 = require("./contexts/ClientApi.js");
 Object.defineProperty(exports, "ClientApiContext", { enumerable: true, get: function () { return ClientApi_js_1.ClientApiContext; } });
 Object.defineProperty(exports, "ClientApiProvider", { enumerable: true, get: function () { return ClientApi_js_1.ClientApiProvider; } });
@@ -30,40 +29,18 @@ Object.defineProperty(exports, "useAddServerPeer", { enumerable: true, get: func
 Object.defineProperty(exports, "useAttachmentUrl", { enumerable: true, get: function () { return projects_js_1.useAttachmentUrl; } });
 Object.defineProperty(exports, "useCreateBlob", { enumerable: true, get: function () { return projects_js_1.useCreateBlob; } });
 Object.defineProperty(exports, "useCreateProject", { enumerable: true, get: function () { return projects_js_1.useCreateProject; } });
+Object.defineProperty(exports, "useDataSyncProgress", { enumerable: true, get: function () { return projects_js_1.useDataSyncProgress; } });
 Object.defineProperty(exports, "useDocumentCreatedBy", { enumerable: true, get: function () { return projects_js_1.useDocumentCreatedBy; } });
 Object.defineProperty(exports, "useIconUrl", { enumerable: true, get: function () { return projects_js_1.useIconUrl; } });
 Object.defineProperty(exports, "useImportProjectConfig", { enumerable: true, get: function () { return projects_js_1.useImportProjectConfig; } });
 Object.defineProperty(exports, "useLeaveProject", { enumerable: true, get: function () { return projects_js_1.useLeaveProject; } });
 Object.defineProperty(exports, "useManyMembers", { enumerable: true, get: function () { return projects_js_1.useManyMembers; } });
 Object.defineProperty(exports, "useManyProjects", { enumerable: true, get: function () { return projects_js_1.useManyProjects; } });
+Object.defineProperty(exports, "useOwnRoleInProject", { enumerable: true, get: function () { return projects_js_1.useOwnRoleInProject; } });
 Object.defineProperty(exports, "useProjectSettings", { enumerable: true, get: function () { return projects_js_1.useProjectSettings; } });
 Object.defineProperty(exports, "useSingleMember", { enumerable: true, get: function () { return projects_js_1.useSingleMember; } });
 Object.defineProperty(exports, "useSingleProject", { enumerable: true, get: function () { return projects_js_1.useSingleProject; } });
+Object.defineProperty(exports, "useStartSync", { enumerable: true, get: function () { return projects_js_1.useStartSync; } });
+Object.defineProperty(exports, "useStopSync", { enumerable: true, get: function () { return projects_js_1.useStopSync; } });
+Object.defineProperty(exports, "useSyncState", { enumerable: true, get: function () { return projects_js_1.useSyncState; } });
 Object.defineProperty(exports, "useUpdateProjectSettings", { enumerable: true, get: function () { return projects_js_1.useUpdateProjectSettings; } });
-var client_js_2 = require("./lib/react-query/client.js");
-Object.defineProperty(exports, "getClientQueryKey", { enumerable: true, get: function () { return client_js_2.getClientQueryKey; } });
-Object.defineProperty(exports, "getDeviceInfoQueryKey", { enumerable: true, get: function () { return client_js_2.getDeviceInfoQueryKey; } });
-Object.defineProperty(exports, "getIsArchiveDeviceQueryKey", { enumerable: true, get: function () { return client_js_2.getIsArchiveDeviceQueryKey; } });
-var documents_js_2 = require("./lib/react-query/documents.js");
-Object.defineProperty(exports, "getDocumentByDocIdQueryKey", { enumerable: true, get: function () { return documents_js_2.getDocumentByDocIdQueryKey; } });
-Object.defineProperty(exports, "getDocumentByVersionIdQueryKey", { enumerable: true, get: function () { return documents_js_2.getDocumentByVersionIdQueryKey; } });
-Object.defineProperty(exports, "getDocumentsQueryKey", { enumerable: true, get: function () { return documents_js_2.getDocumentsQueryKey; } });
-Object.defineProperty(exports, "getManyDocumentsQueryKey", { enumerable: true, get: function () { return documents_js_2.getManyDocumentsQueryKey; } });
-var invites_js_2 = require("./lib/react-query/invites.js");
-Object.defineProperty(exports, "getInvitesQueryKey", { enumerable: true, get: function () { return invites_js_2.getInvitesQueryKey; } });
-Object.defineProperty(exports, "getPendingInvitesQueryKey", { enumerable: true, get: function () { return invites_js_2.getPendingInvitesQueryKey; } });
-var maps_js_2 = require("./lib/react-query/maps.js");
-Object.defineProperty(exports, "getMapsQueryKey", { enumerable: true, get: function () { return maps_js_2.getMapsQueryKey; } });
-Object.defineProperty(exports, "getStyleJsonUrlQueryKey", { enumerable: true, get: function () { return maps_js_2.getStyleJsonUrlQueryKey; } });
-var projects_js_2 = require("./lib/react-query/projects.js");
-Object.defineProperty(exports, "getAttachmentUrlQueryKey", { enumerable: true, get: function () { return projects_js_2.getAttachmentUrlQueryKey; } });
-Object.defineProperty(exports, "getDocumentCreatedByQueryKey", { enumerable: true, get: function () { return projects_js_2.getDocumentCreatedByQueryKey; } });
-Object.defineProperty(exports, "getIconUrlQueryKey", { enumerable: true, get: function () { return projects_js_2.getIconUrlQueryKey; } });
-Object.defineProperty(exports, "getMemberByIdQueryKey", { enumerable: true, get: function () { return projects_js_2.getMemberByIdQueryKey; } });
-Object.defineProperty(exports, "getMembersQueryKey", { enumerable: true, get: function () { return projects_js_2.getMembersQueryKey; } });
-Object.defineProperty(exports, "getProjectByIdQueryKey", { enumerable: true, get: function () { return projects_js_2.getProjectByIdQueryKey; } });
-Object.defineProperty(exports, "getProjectRoleQueryKey", { enumerable: true, get: function () { return projects_js_2.getProjectRoleQueryKey; } });
-Object.defineProperty(exports, "getProjectSettingsQueryKey", { enumerable: true, get: function () { return projects_js_2.getProjectSettingsQueryKey; } });
-Object.defineProperty(exports, "getProjectsQueryKey", { enumerable: true, get: function () { return projects_js_2.getProjectsQueryKey; } });
-var shared_js_1 = require("./lib/react-query/shared.js");
-Object.defineProperty(exports, "ROOT_QUERY_KEY", { enumerable: true, get: function () { return shared_js_1.ROOT_QUERY_KEY; } });

package/dist/commonjs/lib/react-query/documents.d.ts

@@ -1,13 +1,6 @@
 import type { MapeoProjectApi } from '@comapeo/ipc' with { 'resolution-mode': 'import' };
-import type { MapeoDoc, MapeoValue } from '@comapeo/schema' with { 'resolution-mode': 'import' };
 import { type QueryClient } from '@tanstack/react-query';
-export type WriteableDocumentType = Extract<MapeoDoc['schemaName'], 'field' | 'observation' | 'preset' | 'track' | 'remoteDetectionAlert'>;
-export type WriteableValue<D extends WriteableDocumentType> = Extract<MapeoValue, {
-    schemaName: D;
-}>;
-export type WriteableDocument<D extends WriteableDocumentType> = Extract<MapeoDoc, {
-    schemaName: D;
-}>;
+import { WriteableDocument, WriteableDocumentType, WriteableValue } from '../types.js';
 export declare function getDocumentsQueryKey<D extends WriteableDocumentType>({ projectId, docType, }: {
     projectId: string;
     docType: D;

package/dist/commonjs/lib/react-query/projects.d.ts

@@ -330,3 +330,19 @@ export declare function createBlobMutationOptions({ projectApi, }: {
     networkMode: "always";
     retry: false;
 };
+export declare function startSyncMutationOptions({ projectApi, }: {
+    projectApi: MapeoProjectApi;
+}): {
+    mutationFn: (opts: {
+        autostopDataSyncAfter: number | null;
+    } | undefined) => Promise<void>;
+    networkMode: "always";
+    retry: false;
+};
+export declare function stopSyncMutationOptions({ projectApi, }: {
+    projectApi: MapeoProjectApi;
+}): {
+    mutationFn: () => Promise<void>;
+    networkMode: "always";
+    retry: false;
+};

package/dist/commonjs/lib/react-query/projects.js

@@ -24,6 +24,8 @@ exports.leaveProjectMutationOptions = leaveProjectMutationOptions;
 exports.importProjectConfigMutationOptions = importProjectConfigMutationOptions;
 exports.updateProjectSettingsMutationOptions = updateProjectSettingsMutationOptions;
 exports.createBlobMutationOptions = createBlobMutationOptions;
+exports.startSyncMutationOptions = startSyncMutationOptions;
+exports.stopSyncMutationOptions = stopSyncMutationOptions;
 const react_query_1 = require("@tanstack/react-query");
 const shared_js_1 = require("./shared.js");
 function getProjectsQueryKey() {
@@ -233,3 +235,21 @@ function createBlobMutationOptions({ projectApi, }) {
         },
     };
 }
+function startSyncMutationOptions({ projectApi, }) {
+    return {
+        ...(0, shared_js_1.baseMutationOptions)(),
+        mutationFn: async (opts) => {
+            // Have to avoid passing `undefined` explicitly
+            // See https://github.com/digidem/rpc-reflector/issues/21
+            return opts ? projectApi.$sync.start(opts) : projectApi.$sync.start();
+        },
+    };
+}
+function stopSyncMutationOptions({ projectApi, }) {
+    return {
+        ...(0, shared_js_1.baseMutationOptions)(),
+        mutationFn: async () => {
+            return projectApi.$sync.stop();
+        },
+    };
+}

package/dist/commonjs/lib/sync.d.ts

@@ -0,0 +1,10 @@
+import type { MapeoProjectApi } from '@comapeo/ipc' with { 'resolution-mode': 'import' };
+export type SyncState = Awaited<ReturnType<MapeoProjectApi['$sync']['getState']>>;
+export declare function getDataSyncCountForDevice(syncStateForDevice: SyncState['remoteDeviceSyncState'][string]): number;
+export declare class SyncStore {
+    #private;
+    constructor(project: MapeoProjectApi);
+    subscribe: (listener: () => void) => () => void;
+    getStateSnapshot: () => import("@comapeo/core/dist/sync/sync-api.js", { with: { "resolution-mode": "import" } }).State | null;
+    getDataProgressSnapshot: () => number | null;
+}

package/dist/commonjs/lib/sync.js

@@ -0,0 +1,119 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SyncStore = void 0;
+exports.getDataSyncCountForDevice = getDataSyncCountForDevice;
+function getDataSyncCountForDevice(syncStateForDevice) {
+    const { data } = syncStateForDevice;
+    return data.want + data.wanted;
+}
+class SyncStore {
+    #project;
+    #listeners = new Set();
+    #isSubscribedInternal = false;
+    #error = null;
+    #state = null;
+    // Used for calculating sync progress
+    #perDeviceMaxSyncCount = new Map();
+    constructor(project) {
+        this.#project = project;
+    }
+    subscribe = (listener) => {
+        this.#listeners.add(listener);
+        if (!this.#isSubscribedInternal)
+            this.#startSubscription();
+        return () => {
+            this.#listeners.delete(listener);
+            if (this.#listeners.size === 0)
+                this.#stopSubscription();
+        };
+    };
+    getStateSnapshot = () => {
+        if (this.#error)
+            throw this.#error;
+        return this.#state;
+    };
+    getDataProgressSnapshot = () => {
+        if (this.#state === null) {
+            return null;
+        }
+        let currentSyncCount = 0;
+        let totalMaxSyncCount = 0;
+        let otherEnabledDevicesExist = false;
+        for (const [deviceId, deviceSyncState] of Object.entries(this.#state.remoteDeviceSyncState)) {
+            if (deviceSyncState.data.isSyncEnabled) {
+                otherEnabledDevicesExist = true;
+            }
+            else {
+                continue;
+            }
+            const existingMaxCount = this.#perDeviceMaxSyncCount.get(deviceId);
+            if (typeof existingMaxCount === 'number' && existingMaxCount > 0) {
+                currentSyncCount = getDataSyncCountForDevice(deviceSyncState);
+                totalMaxSyncCount += existingMaxCount;
+            }
+        }
+        if (!otherEnabledDevicesExist) {
+            return null;
+        }
+        if (totalMaxSyncCount === 0) {
+            return 1;
+        }
+        const ratio = (totalMaxSyncCount - currentSyncCount) / totalMaxSyncCount;
+        if (ratio <= 0)
+            return 0;
+        if (ratio >= 1)
+            return 1;
+        return clamp(ratio, 0.01, 0.99);
+    };
+    #notifyListeners() {
+        for (const listener of this.#listeners) {
+            listener();
+        }
+    }
+    #onSyncState = (state) => {
+        const dataSyncWasEnabled = this.#state
+            ? this.#state.data.isSyncEnabled
+            : false;
+        // Reset map keeping track of counts used for progress if data sync is toggled
+        if (dataSyncWasEnabled !== state.data.isSyncEnabled) {
+            this.#perDeviceMaxSyncCount.clear();
+        }
+        else {
+            // Remove devices from #perDeviceMaxSyncCount that are no longer found in the new sync state
+            for (const deviceId of this.#perDeviceMaxSyncCount.keys()) {
+                if (!Object.hasOwn(state.remoteDeviceSyncState, deviceId)) {
+                    this.#perDeviceMaxSyncCount.delete(deviceId);
+                }
+            }
+        }
+        for (const [deviceId, stateForDevice] of Object.entries(state.remoteDeviceSyncState)) {
+            const existingCount = this.#perDeviceMaxSyncCount.get(deviceId);
+            const newCount = getDataSyncCountForDevice(stateForDevice);
+            if (existingCount === undefined || existingCount < newCount) {
+                this.#perDeviceMaxSyncCount.set(deviceId, newCount);
+            }
+        }
+        this.#state = state;
+        this.#error = null;
+        this.#notifyListeners();
+    };
+    #startSubscription = () => {
+        this.#project.$sync.on('sync-state', this.#onSyncState);
+        this.#isSubscribedInternal = true;
+        this.#project.$sync
+            .getState()
+            .then(this.#onSyncState)
+            .catch((e) => {
+            this.#error = e;
+            this.#notifyListeners();
+        });
+    };
+    #stopSubscription = () => {
+        this.#isSubscribedInternal = false;
+        this.#project.$sync.off('sync-state', this.#onSyncState);
+    };
+}
+exports.SyncStore = SyncStore;
+function clamp(value, min, max) {
+    return Math.max(min, Math.min(value, max));
+}

package/dist/commonjs/lib/types.d.ts

@@ -0,0 +1,9 @@
+import type { MapeoDoc, MapeoValue } from '@comapeo/schema' with { 'resolution-mode': 'import' };
+export type WriteableDocumentType = Extract<MapeoDoc['schemaName'], 'field' | 'observation' | 'preset' | 'track' | 'remoteDetectionAlert'>;
+export type WriteableValue<D extends WriteableDocumentType> = Extract<MapeoValue, {
+    schemaName: D;
+}>;
+export type WriteableDocument<D extends WriteableDocumentType> = Extract<MapeoDoc, {
+    schemaName: D;
+}>;
+export {};

package/dist/commonjs/lib/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/esm/contexts/ClientApi.d.ts

@@ -1,14 +1,14 @@
 import type { MapeoClientApi } from '@comapeo/ipc' with { 'resolution-mode': 'import' };
-import { type ReactNode } from 'react';
+import { type JSX, type ReactNode } from 'react';
 export declare const ClientApiContext: import("react").Context<import("@comapeo/ipc/dist/client.js").MapeoClientApi | null>;
 /**
  * Create a context provider that holds a CoMapeo API client instance.
  *
- * @param opts
- * @param {ReactNode} opts.children React children node
- * @param {MapeoClientApi} opts.clientApi Client API instance
+ * @param opts.children React children node
+ * @param opts.clientApi Client API instance
+ *
  */
 export declare function ClientApiProvider({ children, clientApi, }: {
     children: ReactNode;
     clientApi: MapeoClientApi;
-}): import("react").FunctionComponentElement<import("react").ProviderProps<import("@comapeo/ipc/dist/client.js").MapeoClientApi | null>>;
+}): JSX.Element;

package/dist/esm/contexts/ClientApi.js

@@ -3,9 +3,9 @@ export const ClientApiContext = createContext(null);
 /**
  * Create a context provider that holds a CoMapeo API client instance.
  *
- * @param opts
- * @param {ReactNode} opts.children React children node
- * @param {MapeoClientApi} opts.clientApi Client API instance
+ * @param opts.children React children node
+ * @param opts.clientApi Client API instance
+ *
  */
 export function ClientApiProvider({ children, clientApi, }) {
     return createElement(ClientApiContext.Provider, { value: clientApi }, children);

package/dist/esm/hooks/documents.d.ts

@@ -1,5 +1,5 @@
 import type { MapeoDoc } from '@comapeo/schema' with { 'resolution-mode': 'import' };
-import { type WriteableDocumentType } from '../lib/react-query/documents.js';
+import type { WriteableDocumentType } from '../lib/types.js';
 type ReadHookResult<D> = {
     data: D;
     error: Error | null;
@@ -119,10 +119,10 @@ export declare function useCreateDocument<D extends WriteableDocumentType>({ doc
     docType: D;
     projectId: string;
 }): {
-    mutate: import("@tanstack/react-query").UseMutateFunction<import("../lib/react-query/documents.js").WriteableDocument<D> & {
+    mutate: import("@tanstack/react-query").UseMutateFunction<import("../lib/types.js").WriteableDocument<D> & {
         forks: Array<string>;
     }, Error, {
-        value: Omit<import("../lib/react-query/documents.js").WriteableValue<D>, "schemaName">;
+        value: Omit<import("../lib/types.js").WriteableValue<D>, "schemaName">;
     }, unknown>;
     reset: () => void;
     status: "pending" | "error" | "success" | "idle";
@@ -137,11 +137,11 @@ export declare function useUpdateDocument<D extends WriteableDocumentType>({ doc
     docType: D;
     projectId: string;
 }): {
-    mutate: import("@tanstack/react-query").UseMutateFunction<import("../lib/react-query/documents.js").WriteableDocument<D> & {
+    mutate: import("@tanstack/react-query").UseMutateFunction<import("../lib/types.js").WriteableDocument<D> & {
         forks: Array<string>;
     }, Error, {
         versionId: string;
-        value: Omit<import("../lib/react-query/documents.js").WriteableValue<D>, "schemaName">;
+        value: Omit<import("../lib/types.js").WriteableValue<D>, "schemaName">;
     }, unknown>;
     reset: () => void;
     status: "pending" | "error" | "success" | "idle";
@@ -156,7 +156,7 @@ export declare function useDeleteDocument<D extends WriteableDocumentType>({ doc
     docType: D;
     projectId: string;
 }): {
-    mutate: import("@tanstack/react-query").UseMutateFunction<import("../lib/react-query/documents.js").WriteableDocument<D> & {
+    mutate: import("@tanstack/react-query").UseMutateFunction<import("../lib/types.js").WriteableDocument<D> & {
         forks: Array<string>;
     }, Error, {
         docId: string;