@comapeo/core-react 4.2.1 → 5.0.0

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

@@ -46,6 +46,10 @@ export declare function documentsQueryOptions<D extends WriteableDocumentType>({
     tags: {
         [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
     };
+    presetRef?: {
+        docId: string;
+        versionId: string;
+    } | undefined;
     docId: string;
     versionId: string;
     originalVersionId: string;
@@ -59,12 +63,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)[];
     };
@@ -169,6 +168,10 @@ export declare function documentsQueryOptions<D extends WriteableDocumentType>({
     tags: {
         [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
     };
+    presetRef?: {
+        docId: string;
+        versionId: string;
+    } | undefined;
     docId: string;
     versionId: string;
     originalVersionId: string;
@@ -182,12 +185,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)[];
     };
@@ -296,6 +294,10 @@ export declare function documentsQueryOptions<D extends WriteableDocumentType>({
         tags: {
             [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
         };
+        presetRef?: {
+            docId: string;
+            versionId: string;
+        } | undefined;
         docId: string;
         versionId: string;
         originalVersionId: string;
@@ -309,12 +311,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)[];
         };
@@ -428,6 +425,10 @@ export declare function documentsQueryOptions<D extends WriteableDocumentType>({
             tags: {
                 [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
             };
+            presetRef?: {
+                docId: string;
+                versionId: string;
+            } | undefined;
             docId: string;
             versionId: string;
             originalVersionId: string;
@@ -441,12 +442,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)[];
             };
@@ -561,6 +557,10 @@ export declare function documentByDocumentIdQueryOptions<D extends WriteableDocu
     tags: {
         [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
     };
+    presetRef?: {
+        docId: string;
+        versionId: string;
+    } | undefined;
     docId: string;
     versionId: string;
     originalVersionId: string;
@@ -574,12 +574,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)[];
     };
@@ -684,6 +679,10 @@ export declare function documentByDocumentIdQueryOptions<D extends WriteableDocu
     tags: {
         [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
     };
+    presetRef?: {
+        docId: string;
+        versionId: string;
+    } | undefined;
     docId: string;
     versionId: string;
     originalVersionId: string;
@@ -697,12 +696,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)[];
     };
@@ -810,6 +804,10 @@ export declare function documentByDocumentIdQueryOptions<D extends WriteableDocu
         tags: {
             [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
         };
+        presetRef?: {
+            docId: string;
+            versionId: string;
+        } | undefined;
         docId: string;
         versionId: string;
         originalVersionId: string;
@@ -823,12 +821,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)[];
         };
@@ -940,6 +933,10 @@ export declare function documentByDocumentIdQueryOptions<D extends WriteableDocu
             tags: {
                 [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
             };
+            presetRef?: {
+                docId: string;
+                versionId: string;
+            } | undefined;
             docId: string;
             versionId: string;
             originalVersionId: string;
@@ -953,12 +950,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)[];
             };
@@ -1073,6 +1065,10 @@ export declare function documentByVersionIdQueryOptions<D extends WriteableDocum
     tags: {
         [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
     };
+    presetRef?: {
+        docId: string;
+        versionId: string;
+    } | undefined;
     docId: string;
     versionId: string;
     originalVersionId: string;
@@ -1084,12 +1080,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)[];
     };
@@ -1186,6 +1177,10 @@ export declare function documentByVersionIdQueryOptions<D extends WriteableDocum
     tags: {
         [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
     };
+    presetRef?: {
+        docId: string;
+        versionId: string;
+    } | undefined;
     docId: string;
     versionId: string;
     originalVersionId: string;
@@ -1197,12 +1192,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)[];
     };
@@ -1302,6 +1292,10 @@ export declare function documentByVersionIdQueryOptions<D extends WriteableDocum
         tags: {
             [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
         };
+        presetRef?: {
+            docId: string;
+            versionId: string;
+        } | undefined;
         docId: string;
         versionId: string;
         originalVersionId: string;
@@ -1313,12 +1307,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)[];
         };
@@ -1422,6 +1411,10 @@ export declare function documentByVersionIdQueryOptions<D extends WriteableDocum
             tags: {
                 [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
             };
+            presetRef?: {
+                docId: string;
+                versionId: string;
+            } | undefined;
             docId: string;
             versionId: string;
             originalVersionId: string;
@@ -1433,12 +1426,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

@@ -45,91 +45,11 @@ export declare function getAttachmentUrlQueryKey({ projectId, blobId, }: {
 }): readonly ["@comapeo/core-react", "projects", string, "attachments", BlobId];
 export declare function projectsQueryOptions({ clientApi, }: {
     clientApi: MapeoClientApi;
-}): import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<(Pick<{
-    schemaName: "projectSettings";
-    name?: string | undefined;
-    defaultPresets?: {
-        point: string[];
-        area: string[];
-        vertex: string[];
-        line: string[];
-        relation: string[];
-    } | undefined;
-    configMetadata?: {
-        name: string;
-        buildDate: string;
-        importDate: string;
-        fileVersion: string;
-    } | undefined;
-}, "name"> & {
-    projectId: string;
-    createdAt?: string | undefined;
-    updatedAt?: string | undefined;
-})[], Error, (Pick<{
-    schemaName: "projectSettings";
-    name?: string | undefined;
-    defaultPresets?: {
-        point: string[];
-        area: string[];
-        vertex: string[];
-        line: string[];
-        relation: string[];
-    } | undefined;
-    configMetadata?: {
-        name: string;
-        buildDate: string;
-        importDate: string;
-        fileVersion: string;
-    } | undefined;
-}, "name"> & {
-    projectId: string;
-    createdAt?: string | undefined;
-    updatedAt?: string | undefined;
-})[], readonly ["@comapeo/core-react", "projects"]>, "queryFn"> & {
-    queryFn?: import("@tanstack/react-query").QueryFunction<(Pick<{
-        schemaName: "projectSettings";
-        name?: string | undefined;
-        defaultPresets?: {
-            point: string[];
-            area: string[];
-            vertex: string[];
-            line: string[];
-            relation: string[];
-        } | undefined;
-        configMetadata?: {
-            name: string;
-            buildDate: string;
-            importDate: string;
-            fileVersion: string;
-        } | undefined;
-    }, "name"> & {
-        projectId: string;
-        createdAt?: string | undefined;
-        updatedAt?: string | undefined;
-    })[], readonly ["@comapeo/core-react", "projects"], never> | undefined;
+}): import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("@comapeo/core/dist/mapeo-manager.js").ListedProject[], Error, import("@comapeo/core/dist/mapeo-manager.js").ListedProject[], readonly ["@comapeo/core-react", "projects"]>, "queryFn"> & {
+    queryFn?: import("@tanstack/react-query").QueryFunction<import("@comapeo/core/dist/mapeo-manager.js").ListedProject[], readonly ["@comapeo/core-react", "projects"], never> | undefined;
 } & {
     queryKey: readonly ["@comapeo/core-react", "projects"] & {
-        [dataTagSymbol]: (Pick<{
-            schemaName: "projectSettings";
-            name?: string | undefined;
-            defaultPresets?: {
-                point: string[];
-                area: string[];
-                vertex: string[];
-                line: string[];
-                relation: string[];
-            } | undefined;
-            configMetadata?: {
-                name: string;
-                buildDate: string;
-                importDate: string;
-                fileVersion: string;
-            } | undefined;
-        }, "name"> & {
-            projectId: string;
-            createdAt?: string | undefined;
-            updatedAt?: string | undefined;
-        })[];
+        [dataTagSymbol]: import("@comapeo/core/dist/mapeo-manager.js").ListedProject[];
         [dataTagErrorSymbol]: Error;
     };
 };
@@ -384,3 +304,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": "5.0.0",
 	"description": "React wrapper for working with @comapeo/core",
 	"repository": {
 		"type": "git",
@@ -57,44 +57,44 @@
 		"types": "tsc"
 	},
 	"peerDependencies": {
-		"@comapeo/core": "^3.1.0",
-		"@comapeo/ipc": "^3.0.0",
+		"@comapeo/core": "^4.0.0",
+		"@comapeo/ipc": "^4.0.0",
 		"@comapeo/schema": "*",
 		"@tanstack/react-query": "^5",
 		"react": "^18 || ^19"
 	},
 	"devDependencies": {
-		"@comapeo/core": "3.1.1",
-		"@comapeo/ipc": "3.0.0",
-		"@comapeo/schema": "1.5.0",
-		"@eslint/compat": "1.2.9",
-		"@eslint/js": "9.26.0",
-		"@ianvs/prettier-plugin-sort-imports": "4.4.1",
+		"@comapeo/core": "4.0.0",
+		"@comapeo/ipc": "4.0.0",
+		"@comapeo/schema": "2.0.0",
+		"@eslint/compat": "1.3.0",
+		"@eslint/js": "9.29.0",
+		"@ianvs/prettier-plugin-sort-imports": "4.4.2",
 		"@mapeo/crypto": "1.0.0-alpha.10",
-		"@tanstack/eslint-plugin-query": "5.74.7",
-		"@tanstack/react-query": "5.75.2",
+		"@tanstack/eslint-plugin-query": "5.78.0",
+		"@tanstack/react-query": "5.80.7",
 		"@testing-library/dom": "10.4.0",
 		"@testing-library/react": "16.3.0",
-		"@types/node": "22.15.3",
-		"@types/react": "19.0.12",
-		"@types/react-dom": "19.0.4",
-		"@vitest/eslint-plugin": "1.1.44",
-		"eslint": "9.26.0",
+		"@types/node": "22.15.19",
+		"@types/react": "19.1.8",
+		"@types/react-dom": "19.1.6",
+		"@vitest/eslint-plugin": "1.2.7",
+		"eslint": "9.29.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.5.3",
+		"fastify": "4.29.1",
+		"globals": "16.2.0",
 		"husky": "9.1.7",
 		"lint-staged": "15.5.1",
 		"npm-run-all2": "7.0.2",
 		"prettier": "3.5.3",
 		"random-access-memory": "6.2.1",
-		"react": "19.0.0",
-		"react-dom": "19.0.0",
+		"react": "19.1.0",
+		"react-dom": "19.1.0",
 		"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.34.1",
+		"vitest": "3.2.3"
 	}
 }