@comapeo/core-react 4.2.1 → 4.3.0

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

@@ -634,3 +634,103 @@ export declare function useSetAutostopDataSyncTimeout({ projectId, }: {
     reset: () => void;
     status: "pending" | "success" | "idle";
 };
+/**
+ * Creates a GeoJson file with all the observations and/or tracks in the project.
+ *
+ * @param opts.projectId Public ID of the project to apply changes to.
+ */
+export declare function useExportGeoJSON({ projectId }: {
+    projectId: string;
+}): {
+    error: Error;
+    mutate: import("@tanstack/react-query").UseMutateFunction<string, Error, {
+        path: string;
+        exportOptions: {
+            observations?: boolean;
+            tracks?: boolean;
+            lang?: string;
+        };
+    }, unknown>;
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<string, Error, {
+        path: string;
+        exportOptions: {
+            observations?: boolean;
+            tracks?: boolean;
+            lang?: string;
+        };
+    }, unknown>;
+    reset: () => void;
+    status: "error";
+} | {
+    error: null;
+    mutate: import("@tanstack/react-query").UseMutateFunction<string, Error, {
+        path: string;
+        exportOptions: {
+            observations?: boolean;
+            tracks?: boolean;
+            lang?: string;
+        };
+    }, unknown>;
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<string, Error, {
+        path: string;
+        exportOptions: {
+            observations?: boolean;
+            tracks?: boolean;
+            lang?: string;
+        };
+    }, unknown>;
+    reset: () => void;
+    status: "pending" | "success" | "idle";
+};
+/**
+ * Creates a zip file containing a GeoJson file with all the observations and/or tracks in the project and all associated attachments (photos and audio).
+ *
+ * @param opts.projectId Public ID of the project to apply changes to.
+ */
+export declare function useExportZipFile({ projectId }: {
+    projectId: string;
+}): {
+    error: Error;
+    mutate: import("@tanstack/react-query").UseMutateFunction<string, Error, {
+        path: string;
+        exportOptions: {
+            observations?: boolean;
+            tracks?: boolean;
+            lang?: string;
+            attachments?: boolean;
+        };
+    }, unknown>;
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<string, Error, {
+        path: string;
+        exportOptions: {
+            observations?: boolean;
+            tracks?: boolean;
+            lang?: string;
+            attachments?: boolean;
+        };
+    }, unknown>;
+    reset: () => void;
+    status: "error";
+} | {
+    error: null;
+    mutate: import("@tanstack/react-query").UseMutateFunction<string, Error, {
+        path: string;
+        exportOptions: {
+            observations?: boolean;
+            tracks?: boolean;
+            lang?: string;
+            attachments?: boolean;
+        };
+    }, unknown>;
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<string, Error, {
+        path: string;
+        exportOptions: {
+            observations?: boolean;
+            tracks?: boolean;
+            lang?: string;
+            attachments?: boolean;
+        };
+    }, unknown>;
+    reset: () => void;
+    status: "pending" | "success" | "idle";
+};

package/dist/commonjs/hooks/projects.js

@@ -23,6 +23,8 @@ exports.useStopSync = useStopSync;
 exports.useConnectSyncServers = useConnectSyncServers;
 exports.useDisconnectSyncServers = useDisconnectSyncServers;
 exports.useSetAutostopDataSyncTimeout = useSetAutostopDataSyncTimeout;
+exports.useExportGeoJSON = useExportGeoJSON;
+exports.useExportZipFile = useExportZipFile;
 const react_query_1 = require("@tanstack/react-query");
 const react_1 = require("react");
 const projects_js_1 = require("../lib/react-query/projects.js");
@@ -450,3 +452,27 @@ function useSetAutostopDataSyncTimeout({ projectId, }) {
         ? { error, mutate, mutateAsync, reset, status }
         : { error: null, mutate, mutateAsync, reset, status };
 }
+/**
+ * Creates a GeoJson file with all the observations and/or tracks in the project.
+ *
+ * @param opts.projectId Public ID of the project to apply changes to.
+ */
+function useExportGeoJSON({ projectId }) {
+    const { data: projectApi } = useSingleProject({ projectId });
+    const { error, mutate, mutateAsync, reset, status } = (0, react_query_1.useMutation)((0, projects_js_1.exportGeoJSONMutationOptions)({ projectApi }));
+    return status === 'error'
+        ? { error, mutate, mutateAsync, reset, status }
+        : { error: null, mutate, mutateAsync, reset, status };
+}
+/**
+ * Creates a zip file containing a GeoJson file with all the observations and/or tracks in the project and all associated attachments (photos and audio).
+ *
+ * @param opts.projectId Public ID of the project to apply changes to.
+ */
+function useExportZipFile({ projectId }) {
+    const { data: projectApi } = useSingleProject({ projectId });
+    const { error, mutate, mutateAsync, reset, status } = (0, react_query_1.useMutation)((0, projects_js_1.exportZipFileMutationOptions)({ projectApi }));
+    return status === 'error'
+        ? { error, mutate, mutateAsync, reset, status }
+        : { error: null, mutate, mutateAsync, reset, status };
+}

package/dist/commonjs/index.d.ts

@@ -3,6 +3,6 @@ export { useClientApi, useIsArchiveDevice, useOwnDeviceInfo, useSetIsArchiveDevi
 export { useCreateDocument, useDeleteDocument, useManyDocs, useSingleDocByDocId, useSingleDocByVersionId, useUpdateDocument, } from './hooks/documents.js';
 export { useAcceptInvite, useManyInvites, useRejectInvite, useRequestCancelInvite, useSendInvite, useSetUpInvitesListeners, useSingleInvite, } from './hooks/invites.js';
 export { useMapStyleUrl } from './hooks/maps.js';
-export { useAddServerPeer, useAttachmentUrl, useConnectSyncServers, useCreateBlob, useCreateProject, useDataSyncProgress, useDisconnectSyncServers, useDocumentCreatedBy, useIconUrl, useImportProjectConfig, useLeaveProject, useManyMembers, useManyProjects, useOwnRoleInProject, useProjectSettings, useRemoveServerPeer, useSetAutostopDataSyncTimeout, useSingleMember, useSingleProject, useStartSync, useStopSync, useSyncState, useUpdateProjectSettings, } from './hooks/projects.js';
+export { useAddServerPeer, useAttachmentUrl, useConnectSyncServers, useCreateBlob, useCreateProject, useDataSyncProgress, useDisconnectSyncServers, useDocumentCreatedBy, useIconUrl, useImportProjectConfig, useLeaveProject, useManyMembers, useManyProjects, useOwnRoleInProject, useProjectSettings, useRemoveServerPeer, useSetAutostopDataSyncTimeout, useSingleMember, useSingleProject, useStartSync, useStopSync, useSyncState, useUpdateProjectSettings, useExportGeoJSON, useExportZipFile, } 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,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useUpdateProjectSettings = exports.useSyncState = exports.useStopSync = exports.useStartSync = exports.useSingleProject = exports.useSingleMember = exports.useSetAutostopDataSyncTimeout = exports.useRemoveServerPeer = exports.useProjectSettings = exports.useOwnRoleInProject = exports.useManyProjects = exports.useManyMembers = exports.useLeaveProject = exports.useImportProjectConfig = exports.useIconUrl = exports.useDocumentCreatedBy = exports.useDisconnectSyncServers = exports.useDataSyncProgress = exports.useCreateProject = exports.useCreateBlob = exports.useConnectSyncServers = exports.useAttachmentUrl = exports.useAddServerPeer = exports.useMapStyleUrl = exports.useSingleInvite = exports.useSetUpInvitesListeners = exports.useSendInvite = exports.useRequestCancelInvite = exports.useRejectInvite = exports.useManyInvites = 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.useExportZipFile = exports.useExportGeoJSON = exports.useUpdateProjectSettings = exports.useSyncState = exports.useStopSync = exports.useStartSync = exports.useSingleProject = exports.useSingleMember = exports.useSetAutostopDataSyncTimeout = exports.useRemoveServerPeer = exports.useProjectSettings = exports.useOwnRoleInProject = exports.useManyProjects = exports.useManyMembers = exports.useLeaveProject = exports.useImportProjectConfig = exports.useIconUrl = exports.useDocumentCreatedBy = exports.useDisconnectSyncServers = exports.useDataSyncProgress = exports.useCreateProject = exports.useCreateBlob = exports.useConnectSyncServers = exports.useAttachmentUrl = exports.useAddServerPeer = exports.useMapStyleUrl = exports.useSingleInvite = exports.useSetUpInvitesListeners = exports.useSendInvite = exports.useRequestCancelInvite = exports.useRejectInvite = exports.useManyInvites = 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; } });
@@ -51,3 +51,5 @@ Object.defineProperty(exports, "useStartSync", { enumerable: true, get: function
 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; } });
+Object.defineProperty(exports, "useExportGeoJSON", { enumerable: true, get: function () { return projects_js_1.useExportGeoJSON; } });
+Object.defineProperty(exports, "useExportZipFile", { enumerable: true, get: function () { return projects_js_1.useExportZipFile; } });

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

@@ -59,12 +59,7 @@ export declare function documentsQueryOptions<D extends WriteableDocumentType>({
     schemaName: "observation";
     lat?: number | undefined;
     lon?: number | undefined;
-    attachments: {
-        driveDiscoveryId: string;
-        name: string;
-        type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
-        hash: string;
-    }[];
+    attachments: import("@comapeo/schema/dist/schema/observation.js").Attachment[];
     tags: {
         [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
     };
@@ -182,12 +177,7 @@ export declare function documentsQueryOptions<D extends WriteableDocumentType>({
     schemaName: "observation";
     lat?: number | undefined;
     lon?: number | undefined;
-    attachments: {
-        driveDiscoveryId: string;
-        name: string;
-        type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
-        hash: string;
-    }[];
+    attachments: import("@comapeo/schema/dist/schema/observation.js").Attachment[];
     tags: {
         [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
     };
@@ -309,12 +299,7 @@ export declare function documentsQueryOptions<D extends WriteableDocumentType>({
         schemaName: "observation";
         lat?: number | undefined;
         lon?: number | undefined;
-        attachments: {
-            driveDiscoveryId: string;
-            name: string;
-            type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
-            hash: string;
-        }[];
+        attachments: import("@comapeo/schema/dist/schema/observation.js").Attachment[];
         tags: {
             [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
         };
@@ -441,12 +426,7 @@ export declare function documentsQueryOptions<D extends WriteableDocumentType>({
             schemaName: "observation";
             lat?: number | undefined;
             lon?: number | undefined;
-            attachments: {
-                driveDiscoveryId: string;
-                name: string;
-                type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
-                hash: string;
-            }[];
+            attachments: import("@comapeo/schema/dist/schema/observation.js").Attachment[];
             tags: {
                 [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
             };
@@ -574,12 +554,7 @@ export declare function documentByDocumentIdQueryOptions<D extends WriteableDocu
     schemaName: "observation";
     lat?: number | undefined;
     lon?: number | undefined;
-    attachments: {
-        driveDiscoveryId: string;
-        name: string;
-        type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
-        hash: string;
-    }[];
+    attachments: import("@comapeo/schema/dist/schema/observation.js").Attachment[];
     tags: {
         [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
     };
@@ -697,12 +672,7 @@ export declare function documentByDocumentIdQueryOptions<D extends WriteableDocu
     schemaName: "observation";
     lat?: number | undefined;
     lon?: number | undefined;
-    attachments: {
-        driveDiscoveryId: string;
-        name: string;
-        type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
-        hash: string;
-    }[];
+    attachments: import("@comapeo/schema/dist/schema/observation.js").Attachment[];
     tags: {
         [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
     };
@@ -823,12 +793,7 @@ export declare function documentByDocumentIdQueryOptions<D extends WriteableDocu
         schemaName: "observation";
         lat?: number | undefined;
         lon?: number | undefined;
-        attachments: {
-            driveDiscoveryId: string;
-            name: string;
-            type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
-            hash: string;
-        }[];
+        attachments: import("@comapeo/schema/dist/schema/observation.js").Attachment[];
         tags: {
             [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
         };
@@ -953,12 +918,7 @@ export declare function documentByDocumentIdQueryOptions<D extends WriteableDocu
             schemaName: "observation";
             lat?: number | undefined;
             lon?: number | undefined;
-            attachments: {
-                driveDiscoveryId: string;
-                name: string;
-                type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
-                hash: string;
-            }[];
+            attachments: import("@comapeo/schema/dist/schema/observation.js").Attachment[];
             tags: {
                 [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
             };
@@ -1084,12 +1044,7 @@ export declare function documentByVersionIdQueryOptions<D extends WriteableDocum
     schemaName: "observation";
     lat?: number | undefined;
     lon?: number | undefined;
-    attachments: {
-        driveDiscoveryId: string;
-        name: string;
-        type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
-        hash: string;
-    }[];
+    attachments: import("@comapeo/schema/dist/schema/observation.js").Attachment[];
     tags: {
         [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
     };
@@ -1197,12 +1152,7 @@ export declare function documentByVersionIdQueryOptions<D extends WriteableDocum
     schemaName: "observation";
     lat?: number | undefined;
     lon?: number | undefined;
-    attachments: {
-        driveDiscoveryId: string;
-        name: string;
-        type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
-        hash: string;
-    }[];
+    attachments: import("@comapeo/schema/dist/schema/observation.js").Attachment[];
     tags: {
         [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
     };
@@ -1313,12 +1263,7 @@ export declare function documentByVersionIdQueryOptions<D extends WriteableDocum
         schemaName: "observation";
         lat?: number | undefined;
         lon?: number | undefined;
-        attachments: {
-            driveDiscoveryId: string;
-            name: string;
-            type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
-            hash: string;
-        }[];
+        attachments: import("@comapeo/schema/dist/schema/observation.js").Attachment[];
         tags: {
             [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
         };
@@ -1433,12 +1378,7 @@ export declare function documentByVersionIdQueryOptions<D extends WriteableDocum
             schemaName: "observation";
             lat?: number | undefined;
             lon?: number | undefined;
-            attachments: {
-                driveDiscoveryId: string;
-                name: string;
-                type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
-                hash: string;
-            }[];
+            attachments: import("@comapeo/schema/dist/schema/observation.js").Attachment[];
             tags: {
                 [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
             };

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

@@ -384,3 +384,32 @@ export declare function setAutostopDataSyncTimeoutMutationOptions({ projectApi,
     networkMode: "always";
     retry: false;
 };
+export declare function exportGeoJSONMutationOptions({ projectApi, }: {
+    projectApi: MapeoProjectApi;
+}): {
+    mutationFn: (opts: {
+        path: string;
+        exportOptions: {
+            observations?: boolean;
+            tracks?: boolean;
+            lang?: string;
+        };
+    }) => Promise<string>;
+    networkMode: "always";
+    retry: false;
+};
+export declare function exportZipFileMutationOptions({ projectApi, }: {
+    projectApi: MapeoProjectApi;
+}): {
+    mutationFn: (opts: {
+        path: string;
+        exportOptions: {
+            observations?: boolean;
+            tracks?: boolean;
+            lang?: string;
+            attachments?: boolean;
+        };
+    }) => Promise<string>;
+    networkMode: "always";
+    retry: false;
+};

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

@@ -30,6 +30,8 @@ exports.stopSyncMutationOptions = stopSyncMutationOptions;
 exports.connectSyncServersMutationOptions = connectSyncServersMutationOptions;
 exports.disconnectSyncServersMutationOptions = disconnectSyncServersMutationOptions;
 exports.setAutostopDataSyncTimeoutMutationOptions = setAutostopDataSyncTimeoutMutationOptions;
+exports.exportGeoJSONMutationOptions = exportGeoJSONMutationOptions;
+exports.exportZipFileMutationOptions = exportZipFileMutationOptions;
 const react_query_1 = require("@tanstack/react-query");
 const shared_js_1 = require("./shared.js");
 function getProjectsQueryKey() {
@@ -296,3 +298,19 @@ function setAutostopDataSyncTimeoutMutationOptions({ projectApi, }) {
         },
     };
 }
+function exportGeoJSONMutationOptions({ projectApi, }) {
+    return {
+        ...(0, shared_js_1.baseMutationOptions)(),
+        mutationFn: async (opts) => {
+            return projectApi.exportGeoJSONFile(opts.path, opts.exportOptions);
+        },
+    };
+}
+function exportZipFileMutationOptions({ projectApi, }) {
+    return {
+        ...(0, shared_js_1.baseMutationOptions)(),
+        mutationFn: async (opts) => {
+            return projectApi.exportZipFile(opts.path, opts.exportOptions);
+        },
+    };
+}

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

@@ -634,3 +634,103 @@ export declare function useSetAutostopDataSyncTimeout({ projectId, }: {
     reset: () => void;
     status: "pending" | "success" | "idle";
 };
+/**
+ * Creates a GeoJson file with all the observations and/or tracks in the project.
+ *
+ * @param opts.projectId Public ID of the project to apply changes to.
+ */
+export declare function useExportGeoJSON({ projectId }: {
+    projectId: string;
+}): {
+    error: Error;
+    mutate: import("@tanstack/react-query").UseMutateFunction<string, Error, {
+        path: string;
+        exportOptions: {
+            observations?: boolean;
+            tracks?: boolean;
+            lang?: string;
+        };
+    }, unknown>;
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<string, Error, {
+        path: string;
+        exportOptions: {
+            observations?: boolean;
+            tracks?: boolean;
+            lang?: string;
+        };
+    }, unknown>;
+    reset: () => void;
+    status: "error";
+} | {
+    error: null;
+    mutate: import("@tanstack/react-query").UseMutateFunction<string, Error, {
+        path: string;
+        exportOptions: {
+            observations?: boolean;
+            tracks?: boolean;
+            lang?: string;
+        };
+    }, unknown>;
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<string, Error, {
+        path: string;
+        exportOptions: {
+            observations?: boolean;
+            tracks?: boolean;
+            lang?: string;
+        };
+    }, unknown>;
+    reset: () => void;
+    status: "pending" | "success" | "idle";
+};
+/**
+ * Creates a zip file containing a GeoJson file with all the observations and/or tracks in the project and all associated attachments (photos and audio).
+ *
+ * @param opts.projectId Public ID of the project to apply changes to.
+ */
+export declare function useExportZipFile({ projectId }: {
+    projectId: string;
+}): {
+    error: Error;
+    mutate: import("@tanstack/react-query").UseMutateFunction<string, Error, {
+        path: string;
+        exportOptions: {
+            observations?: boolean;
+            tracks?: boolean;
+            lang?: string;
+            attachments?: boolean;
+        };
+    }, unknown>;
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<string, Error, {
+        path: string;
+        exportOptions: {
+            observations?: boolean;
+            tracks?: boolean;
+            lang?: string;
+            attachments?: boolean;
+        };
+    }, unknown>;
+    reset: () => void;
+    status: "error";
+} | {
+    error: null;
+    mutate: import("@tanstack/react-query").UseMutateFunction<string, Error, {
+        path: string;
+        exportOptions: {
+            observations?: boolean;
+            tracks?: boolean;
+            lang?: string;
+            attachments?: boolean;
+        };
+    }, unknown>;
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<string, Error, {
+        path: string;
+        exportOptions: {
+            observations?: boolean;
+            tracks?: boolean;
+            lang?: string;
+            attachments?: boolean;
+        };
+    }, unknown>;
+    reset: () => void;
+    status: "pending" | "success" | "idle";
+};

package/dist/esm/hooks/projects.js

@@ -1,6 +1,6 @@
 import { useMutation, useQueryClient, useSuspenseQuery, } from '@tanstack/react-query';
 import { useSyncExternalStore } from 'react';
-import { addServerPeerMutationOptions, attachmentUrlQueryOptions, connectSyncServersMutationOptions, createBlobMutationOptions, createProjectMutationOptions, disconnectSyncServersMutationOptions, documentCreatedByQueryOptions, iconUrlQueryOptions, importProjectConfigMutationOptions, leaveProjectMutationOptions, projectByIdQueryOptions, projectMemberByIdQueryOptions, projectMembersQueryOptions, projectOwnRoleQueryOptions, projectSettingsQueryOptions, projectsQueryOptions, removeServerPeerMutationOptions, setAutostopDataSyncTimeoutMutationOptions, startSyncMutationOptions, stopSyncMutationOptions, updateProjectSettingsMutationOptions, } from '../lib/react-query/projects.js';
+import { addServerPeerMutationOptions, attachmentUrlQueryOptions, connectSyncServersMutationOptions, createBlobMutationOptions, createProjectMutationOptions, disconnectSyncServersMutationOptions, documentCreatedByQueryOptions, exportGeoJSONMutationOptions, exportZipFileMutationOptions, iconUrlQueryOptions, importProjectConfigMutationOptions, leaveProjectMutationOptions, projectByIdQueryOptions, projectMemberByIdQueryOptions, projectMembersQueryOptions, projectOwnRoleQueryOptions, projectSettingsQueryOptions, projectsQueryOptions, removeServerPeerMutationOptions, setAutostopDataSyncTimeoutMutationOptions, startSyncMutationOptions, stopSyncMutationOptions, updateProjectSettingsMutationOptions, } from '../lib/react-query/projects.js';
 import { SyncStore } from '../lib/sync.js';
 import { useClientApi } from './client.js';
 /**
@@ -425,3 +425,27 @@ export function useSetAutostopDataSyncTimeout({ projectId, }) {
         ? { error, mutate, mutateAsync, reset, status }
         : { error: null, mutate, mutateAsync, reset, status };
 }
+/**
+ * Creates a GeoJson file with all the observations and/or tracks in the project.
+ *
+ * @param opts.projectId Public ID of the project to apply changes to.
+ */
+export function useExportGeoJSON({ projectId }) {
+    const { data: projectApi } = useSingleProject({ projectId });
+    const { error, mutate, mutateAsync, reset, status } = useMutation(exportGeoJSONMutationOptions({ projectApi }));
+    return status === 'error'
+        ? { error, mutate, mutateAsync, reset, status }
+        : { error: null, mutate, mutateAsync, reset, status };
+}
+/**
+ * Creates a zip file containing a GeoJson file with all the observations and/or tracks in the project and all associated attachments (photos and audio).
+ *
+ * @param opts.projectId Public ID of the project to apply changes to.
+ */
+export function useExportZipFile({ projectId }) {
+    const { data: projectApi } = useSingleProject({ projectId });
+    const { error, mutate, mutateAsync, reset, status } = useMutation(exportZipFileMutationOptions({ projectApi }));
+    return status === 'error'
+        ? { error, mutate, mutateAsync, reset, status }
+        : { error: null, mutate, mutateAsync, reset, status };
+}

package/dist/esm/index.d.ts

@@ -3,6 +3,6 @@ export { useClientApi, useIsArchiveDevice, useOwnDeviceInfo, useSetIsArchiveDevi
 export { useCreateDocument, useDeleteDocument, useManyDocs, useSingleDocByDocId, useSingleDocByVersionId, useUpdateDocument, } from './hooks/documents.js';
 export { useAcceptInvite, useManyInvites, useRejectInvite, useRequestCancelInvite, useSendInvite, useSetUpInvitesListeners, useSingleInvite, } from './hooks/invites.js';
 export { useMapStyleUrl } from './hooks/maps.js';
-export { useAddServerPeer, useAttachmentUrl, useConnectSyncServers, useCreateBlob, useCreateProject, useDataSyncProgress, useDisconnectSyncServers, useDocumentCreatedBy, useIconUrl, useImportProjectConfig, useLeaveProject, useManyMembers, useManyProjects, useOwnRoleInProject, useProjectSettings, useRemoveServerPeer, useSetAutostopDataSyncTimeout, useSingleMember, useSingleProject, useStartSync, useStopSync, useSyncState, useUpdateProjectSettings, } from './hooks/projects.js';
+export { useAddServerPeer, useAttachmentUrl, useConnectSyncServers, useCreateBlob, useCreateProject, useDataSyncProgress, useDisconnectSyncServers, useDocumentCreatedBy, useIconUrl, useImportProjectConfig, useLeaveProject, useManyMembers, useManyProjects, useOwnRoleInProject, useProjectSettings, useRemoveServerPeer, useSetAutostopDataSyncTimeout, useSingleMember, useSingleProject, useStartSync, useStopSync, useSyncState, useUpdateProjectSettings, useExportGeoJSON, useExportZipFile, } from './hooks/projects.js';
 export { type SyncState } from './lib/sync.js';
 export { type WriteableDocument, type WriteableDocumentType, type WriteableValue, } from './lib/types.js';

package/dist/esm/index.js

@@ -3,4 +3,4 @@ export { useClientApi, useIsArchiveDevice, useOwnDeviceInfo, useSetIsArchiveDevi
 export { useCreateDocument, useDeleteDocument, useManyDocs, useSingleDocByDocId, useSingleDocByVersionId, useUpdateDocument, } from './hooks/documents.js';
 export { useAcceptInvite, useManyInvites, useRejectInvite, useRequestCancelInvite, useSendInvite, useSetUpInvitesListeners, useSingleInvite, } from './hooks/invites.js';
 export { useMapStyleUrl } from './hooks/maps.js';
-export { useAddServerPeer, useAttachmentUrl, useConnectSyncServers, useCreateBlob, useCreateProject, useDataSyncProgress, useDisconnectSyncServers, useDocumentCreatedBy, useIconUrl, useImportProjectConfig, useLeaveProject, useManyMembers, useManyProjects, useOwnRoleInProject, useProjectSettings, useRemoveServerPeer, useSetAutostopDataSyncTimeout, useSingleMember, useSingleProject, useStartSync, useStopSync, useSyncState, useUpdateProjectSettings, } from './hooks/projects.js';
+export { useAddServerPeer, useAttachmentUrl, useConnectSyncServers, useCreateBlob, useCreateProject, useDataSyncProgress, useDisconnectSyncServers, useDocumentCreatedBy, useIconUrl, useImportProjectConfig, useLeaveProject, useManyMembers, useManyProjects, useOwnRoleInProject, useProjectSettings, useRemoveServerPeer, useSetAutostopDataSyncTimeout, useSingleMember, useSingleProject, useStartSync, useStopSync, useSyncState, useUpdateProjectSettings, useExportGeoJSON, useExportZipFile, } from './hooks/projects.js';

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

@@ -59,12 +59,7 @@ export declare function documentsQueryOptions<D extends WriteableDocumentType>({
     schemaName: "observation";
     lat?: number | undefined;
     lon?: number | undefined;
-    attachments: {
-        driveDiscoveryId: string;
-        name: string;
-        type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
-        hash: string;
-    }[];
+    attachments: import("@comapeo/schema/dist/schema/observation.js").Attachment[];
     tags: {
         [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
     };
@@ -182,12 +177,7 @@ export declare function documentsQueryOptions<D extends WriteableDocumentType>({
     schemaName: "observation";
     lat?: number | undefined;
     lon?: number | undefined;
-    attachments: {
-        driveDiscoveryId: string;
-        name: string;
-        type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
-        hash: string;
-    }[];
+    attachments: import("@comapeo/schema/dist/schema/observation.js").Attachment[];
     tags: {
         [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
     };
@@ -309,12 +299,7 @@ export declare function documentsQueryOptions<D extends WriteableDocumentType>({
         schemaName: "observation";
         lat?: number | undefined;
         lon?: number | undefined;
-        attachments: {
-            driveDiscoveryId: string;
-            name: string;
-            type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
-            hash: string;
-        }[];
+        attachments: import("@comapeo/schema/dist/schema/observation.js").Attachment[];
         tags: {
             [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
         };
@@ -441,12 +426,7 @@ export declare function documentsQueryOptions<D extends WriteableDocumentType>({
             schemaName: "observation";
             lat?: number | undefined;
             lon?: number | undefined;
-            attachments: {
-                driveDiscoveryId: string;
-                name: string;
-                type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
-                hash: string;
-            }[];
+            attachments: import("@comapeo/schema/dist/schema/observation.js").Attachment[];
             tags: {
                 [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
             };
@@ -574,12 +554,7 @@ export declare function documentByDocumentIdQueryOptions<D extends WriteableDocu
     schemaName: "observation";
     lat?: number | undefined;
     lon?: number | undefined;
-    attachments: {
-        driveDiscoveryId: string;
-        name: string;
-        type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
-        hash: string;
-    }[];
+    attachments: import("@comapeo/schema/dist/schema/observation.js").Attachment[];
     tags: {
         [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
     };
@@ -697,12 +672,7 @@ export declare function documentByDocumentIdQueryOptions<D extends WriteableDocu
     schemaName: "observation";
     lat?: number | undefined;
     lon?: number | undefined;
-    attachments: {
-        driveDiscoveryId: string;
-        name: string;
-        type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
-        hash: string;
-    }[];
+    attachments: import("@comapeo/schema/dist/schema/observation.js").Attachment[];
     tags: {
         [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
     };
@@ -823,12 +793,7 @@ export declare function documentByDocumentIdQueryOptions<D extends WriteableDocu
         schemaName: "observation";
         lat?: number | undefined;
         lon?: number | undefined;
-        attachments: {
-            driveDiscoveryId: string;
-            name: string;
-            type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
-            hash: string;
-        }[];
+        attachments: import("@comapeo/schema/dist/schema/observation.js").Attachment[];
         tags: {
             [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
         };
@@ -953,12 +918,7 @@ export declare function documentByDocumentIdQueryOptions<D extends WriteableDocu
             schemaName: "observation";
             lat?: number | undefined;
             lon?: number | undefined;
-            attachments: {
-                driveDiscoveryId: string;
-                name: string;
-                type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
-                hash: string;
-            }[];
+            attachments: import("@comapeo/schema/dist/schema/observation.js").Attachment[];
             tags: {
                 [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
             };
@@ -1084,12 +1044,7 @@ export declare function documentByVersionIdQueryOptions<D extends WriteableDocum
     schemaName: "observation";
     lat?: number | undefined;
     lon?: number | undefined;
-    attachments: {
-        driveDiscoveryId: string;
-        name: string;
-        type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
-        hash: string;
-    }[];
+    attachments: import("@comapeo/schema/dist/schema/observation.js").Attachment[];
     tags: {
         [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
     };
@@ -1197,12 +1152,7 @@ export declare function documentByVersionIdQueryOptions<D extends WriteableDocum
     schemaName: "observation";
     lat?: number | undefined;
     lon?: number | undefined;
-    attachments: {
-        driveDiscoveryId: string;
-        name: string;
-        type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
-        hash: string;
-    }[];
+    attachments: import("@comapeo/schema/dist/schema/observation.js").Attachment[];
     tags: {
         [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
     };
@@ -1313,12 +1263,7 @@ export declare function documentByVersionIdQueryOptions<D extends WriteableDocum
         schemaName: "observation";
         lat?: number | undefined;
         lon?: number | undefined;
-        attachments: {
-            driveDiscoveryId: string;
-            name: string;
-            type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
-            hash: string;
-        }[];
+        attachments: import("@comapeo/schema/dist/schema/observation.js").Attachment[];
         tags: {
             [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
         };
@@ -1433,12 +1378,7 @@ export declare function documentByVersionIdQueryOptions<D extends WriteableDocum
             schemaName: "observation";
             lat?: number | undefined;
             lon?: number | undefined;
-            attachments: {
-                driveDiscoveryId: string;
-                name: string;
-                type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
-                hash: string;
-            }[];
+            attachments: import("@comapeo/schema/dist/schema/observation.js").Attachment[];
             tags: {
                 [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
             };

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

@@ -384,3 +384,32 @@ export declare function setAutostopDataSyncTimeoutMutationOptions({ projectApi,
     networkMode: "always";
     retry: false;
 };
+export declare function exportGeoJSONMutationOptions({ projectApi, }: {
+    projectApi: MapeoProjectApi;
+}): {
+    mutationFn: (opts: {
+        path: string;
+        exportOptions: {
+            observations?: boolean;
+            tracks?: boolean;
+            lang?: string;
+        };
+    }) => Promise<string>;
+    networkMode: "always";
+    retry: false;
+};
+export declare function exportZipFileMutationOptions({ projectApi, }: {
+    projectApi: MapeoProjectApi;
+}): {
+    mutationFn: (opts: {
+        path: string;
+        exportOptions: {
+            observations?: boolean;
+            tracks?: boolean;
+            lang?: string;
+            attachments?: boolean;
+        };
+    }) => Promise<string>;
+    networkMode: "always";
+    retry: false;
+};

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

@@ -264,3 +264,19 @@ export function setAutostopDataSyncTimeoutMutationOptions({ projectApi, }) {
         },
     };
 }
+export function exportGeoJSONMutationOptions({ projectApi, }) {
+    return {
+        ...baseMutationOptions(),
+        mutationFn: async (opts) => {
+            return projectApi.exportGeoJSONFile(opts.path, opts.exportOptions);
+        },
+    };
+}
+export function exportZipFileMutationOptions({ projectApi, }) {
+    return {
+        ...baseMutationOptions(),
+        mutationFn: async (opts) => {
+            return projectApi.exportZipFile(opts.path, opts.exportOptions);
+        },
+    };
+}

package/docs/API.md

@@ -29,6 +29,8 @@
 - [useConnectSyncServers](#useconnectsyncservers)
 - [useDisconnectSyncServers](#usedisconnectsyncservers)
 - [useSetAutostopDataSyncTimeout](#usesetautostopdatasynctimeout)
+- [useExportGeoJSON](#useexportgeojson)
+- [useExportZipFile](#useexportzipfile)
 - [useSingleDocByDocId](#usesingledocbydocid)
 - [useSingleDocByVersionId](#usesingledocbyversionid)
 - [useManyDocs](#usemanydocs)
@@ -547,6 +549,32 @@ Provides the progress of data sync for sync-enabled connected peers
 | ---------- | ---------- |
 | `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 { ...; }` |
 
+### useExportGeoJSON
+
+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...` |
+
+Parameters:
+
+* `opts.projectId`: Public ID of the project to apply changes to.
+
+
+### useExportZipFile
+
+Creates a zip file containing a GeoJson file with all the observations and/or tracks in the project and all associated attachments (photos and audio).
+
+| 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<...>...` |
+
+Parameters:
+
+* `opts.projectId`: Public ID of the project to apply changes to.
+
+
 ### useSingleDocByDocId
 
 Retrieve a single document from the database based on the document's document ID.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@comapeo/core-react",
-	"version": "4.2.1",
+	"version": "4.3.0",
 	"description": "React wrapper for working with @comapeo/core",
 	"repository": {
 		"type": "git",
@@ -57,33 +57,33 @@
 		"types": "tsc"
 	},
 	"peerDependencies": {
-		"@comapeo/core": "^3.1.0",
+		"@comapeo/core": "^3.2.0",
 		"@comapeo/ipc": "^3.0.0",
 		"@comapeo/schema": "*",
 		"@tanstack/react-query": "^5",
 		"react": "^18 || ^19"
 	},
 	"devDependencies": {
-		"@comapeo/core": "3.1.1",
+		"@comapeo/core": "3.2.0",
 		"@comapeo/ipc": "3.0.0",
-		"@comapeo/schema": "1.5.0",
+		"@comapeo/schema": "1.6.0",
 		"@eslint/compat": "1.2.9",
-		"@eslint/js": "9.26.0",
+		"@eslint/js": "9.27.0",
 		"@ianvs/prettier-plugin-sort-imports": "4.4.1",
 		"@mapeo/crypto": "1.0.0-alpha.10",
 		"@tanstack/eslint-plugin-query": "5.74.7",
-		"@tanstack/react-query": "5.75.2",
+		"@tanstack/react-query": "5.76.1",
 		"@testing-library/dom": "10.4.0",
 		"@testing-library/react": "16.3.0",
-		"@types/node": "22.15.3",
+		"@types/node": "22.15.19",
 		"@types/react": "19.0.12",
 		"@types/react-dom": "19.0.4",
-		"@vitest/eslint-plugin": "1.1.44",
-		"eslint": "9.26.0",
+		"@vitest/eslint-plugin": "1.2.0",
+		"eslint": "9.27.0",
 		"eslint-plugin-react-hooks": "5.2.0",
-		"eslint-plugin-testing-library": "7.1.1",
-		"fastify": "4.29.0",
-		"globals": "16.0.0",
+		"eslint-plugin-testing-library": "7.2.1",
+		"fastify": "4.29.1",
+		"globals": "16.1.0",
 		"husky": "9.1.7",
 		"lint-staged": "15.5.1",
 		"npm-run-all2": "7.0.2",
@@ -94,7 +94,7 @@
 		"tsdoc-markdown": "1.2.0",
 		"tshy": "3.0.2",
 		"typescript": "5.8.3",
-		"typescript-eslint": "8.31.1",
-		"vitest": "3.1.3"
+		"typescript-eslint": "8.32.1",
+		"vitest": "3.1.4"
 	}
 }