@comapeo/core-react 4.2.1 → 5.0.0

package/dist/commonjs/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", { with: { "resolution-mode": "import" } }).ListedProject[], Error, import("@comapeo/core/dist/mapeo-manager.js", { with: { "resolution-mode": "import" } }).ListedProject[], readonly ["@comapeo/core-react", "projects"]>, "queryFn"> & {
+    queryFn?: import("@tanstack/react-query").QueryFunction<import("@comapeo/core/dist/mapeo-manager.js", { with: { "resolution-mode": "import" } }).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", { with: { "resolution-mode": "import" } }).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/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/contexts/ClientApi.d.ts

@@ -1,6 +1,8 @@
 import type { MapeoClientApi } from '@comapeo/ipc' with { 'resolution-mode': 'import' };
 import { type JSX, type ReactNode } from 'react';
-export declare const ClientApiContext: import("react").Context<import("@comapeo/ipc/dist/client.js").MapeoClientApi | null>;
+export declare const ClientApiContext: import("react").Context<import("rpc-reflector/lib/types.js").ClientApi<Omit<import("@comapeo/core").MapeoManager, "getProject"> & {
+    getProject: (projectPublicId: string) => Promise<import("@comapeo/ipc/dist/client.js").MapeoProjectApi>;
+}> | null>;
 /**
  * Create a context provider that holds a CoMapeo API client instance.
  *

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

@@ -23,7 +23,9 @@
  * ```
  *
  */
-export declare function useClientApi(): import("@comapeo/ipc/dist/client.js").MapeoClientApi;
+export declare function useClientApi(): import("rpc-reflector/lib/types.js").ClientApi<Omit<import("@comapeo/core").MapeoManager, "getProject"> & {
+    getProject: (projectPublicId: string) => Promise<import("@comapeo/ipc/dist/client.js").MapeoProjectApi>;
+}>;
 /**
  * Retrieve info about the current device.
  *
@@ -37,7 +39,7 @@ export declare function useClientApi(): import("@comapeo/ipc/dist/client.js").Ma
 export declare function useOwnDeviceInfo(): {
     data: {
         deviceId: string;
-        deviceType: "UNRECOGNIZED" | "device_type_unspecified" | "mobile" | "tablet" | "desktop" | "selfHostedServer";
+        deviceType: import("@comapeo/core/dist/schema/client.js").DeviceInfoParam["deviceType"];
     } & Partial<import("@comapeo/core/dist/schema/client.js").DeviceInfoParam>;
     error: Error | null;
     isRefetching: boolean;

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

@@ -56,27 +56,7 @@ export declare function useSingleProject({ projectId }: {
  * ```
  */
 export declare function useManyProjects(): {
-    data: (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;
-    })[];
+    data: import("@comapeo/core/dist/mapeo-manager.js").ListedProject[];
     error: Error | null;
     isRefetching: boolean;
 };
@@ -634,3 +614,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/client.d.ts

@@ -8,20 +8,20 @@ export declare function deviceInfoQueryOptions({ clientApi, }: {
     clientApi: MapeoClientApi;
 }): import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<{
     deviceId: string;
-    deviceType: "UNRECOGNIZED" | "device_type_unspecified" | "mobile" | "tablet" | "desktop" | "selfHostedServer";
+    deviceType: import("@comapeo/core/dist/schema/client.js").DeviceInfoParam["deviceType"];
 } & Partial<import("@comapeo/core/dist/schema/client.js").DeviceInfoParam>, Error, {
     deviceId: string;
-    deviceType: "UNRECOGNIZED" | "device_type_unspecified" | "mobile" | "tablet" | "desktop" | "selfHostedServer";
+    deviceType: import("@comapeo/core/dist/schema/client.js").DeviceInfoParam["deviceType"];
 } & Partial<import("@comapeo/core/dist/schema/client.js").DeviceInfoParam>, readonly ["@comapeo/core-react", "client", "device_info"]>, "queryFn"> & {
     queryFn?: import("@tanstack/react-query").QueryFunction<{
         deviceId: string;
-        deviceType: "UNRECOGNIZED" | "device_type_unspecified" | "mobile" | "tablet" | "desktop" | "selfHostedServer";
+        deviceType: import("@comapeo/core/dist/schema/client.js").DeviceInfoParam["deviceType"];
     } & Partial<import("@comapeo/core/dist/schema/client.js").DeviceInfoParam>, readonly ["@comapeo/core-react", "client", "device_info"], never> | undefined;
 } & {
     queryKey: readonly ["@comapeo/core-react", "client", "device_info"] & {
         [dataTagSymbol]: {
             deviceId: string;
-            deviceType: "UNRECOGNIZED" | "device_type_unspecified" | "mobile" | "tablet" | "desktop" | "selfHostedServer";
+            deviceType: import("@comapeo/core/dist/schema/client.js").DeviceInfoParam["deviceType"];
         } & Partial<import("@comapeo/core/dist/schema/client.js").DeviceInfoParam>;
         [dataTagErrorSymbol]: Error;
     };