@comapeo/core-react 6.4.0 → 7.0.0

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

@@ -158,6 +158,18 @@ export declare function leaveProjectMutationOptions({ clientApi, queryClient, }:
     networkMode: "always";
     retry: false;
 };
+export declare function importProjectCategoriesMutationOptions({ projectApi, projectId, queryClient, }: {
+    projectApi: MapeoProjectApi;
+    projectId: string;
+    queryClient: QueryClient;
+}): {
+    mutationFn: ({ filePath }: {
+        filePath: string;
+    }) => Promise<void>;
+    onSuccess: () => void;
+    networkMode: "always";
+    retry: false;
+};
 export declare function importProjectConfigMutationOptions({ projectApi, projectId, queryClient, }: {
     projectApi: MapeoProjectApi;
     projectId: string;

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

@@ -20,6 +20,7 @@ exports.addServerPeerMutationOptions = addServerPeerMutationOptions;
 exports.removeServerPeerMutationOptions = removeServerPeerMutationOptions;
 exports.createProjectMutationOptions = createProjectMutationOptions;
 exports.leaveProjectMutationOptions = leaveProjectMutationOptions;
+exports.importProjectCategoriesMutationOptions = importProjectCategoriesMutationOptions;
 exports.importProjectConfigMutationOptions = importProjectConfigMutationOptions;
 exports.updateProjectSettingsMutationOptions = updateProjectSettingsMutationOptions;
 exports.changeMemberRoleMutationOptions = changeMemberRoleMutationOptions;
@@ -222,6 +223,19 @@ function leaveProjectMutationOptions({ clientApi, queryClient, }) {
         },
     };
 }
+function importProjectCategoriesMutationOptions({ projectApi, projectId, queryClient, }) {
+    return {
+        ...(0, shared_js_1.baseMutationOptions)(),
+        mutationFn: ({ filePath }) => {
+            return projectApi.$importCategories({ filePath });
+        },
+        onSuccess: () => {
+            queryClient.invalidateQueries({
+                queryKey: getProjectByIdQueryKey({ projectId }),
+            });
+        },
+    };
+}
 function importProjectConfigMutationOptions({ projectApi, projectId, queryClient, }) {
     return {
         ...(0, shared_js_1.baseMutationOptions)(),

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

@@ -51,28 +51,14 @@ export declare function useSingleDocByDocId<D extends WriteableDocumentType>({ p
         links: string[];
         deleted: boolean;
     } & import("@comapeo/core/dist/datatype/index.js").DerivedDocFields) | ({
-        schemaName: "observation";
-        lat?: number | undefined;
-        lon?: number | undefined;
-        attachments: import("@comapeo/schema/dist/schema/observation.js").Attachment[];
-        tags: {
+        schemaName: "remoteDetectionAlert";
+        detectionDateStart: string;
+        detectionDateEnd: string;
+        sourceId: string;
+        metadata: {
             [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
         };
-        metadata?: {
-            manualLocation?: boolean;
-            position?: import("@comapeo/schema/dist/schema/observation.js").Position;
-            lastSavedPosition?: import("@comapeo/schema/dist/schema/observation.js").Position;
-            positionProvider?: {
-                gpsAvailable?: boolean;
-                passiveAvailable?: boolean;
-                locationServicesEnabled: boolean;
-                networkAvailable?: boolean;
-            };
-        } | undefined;
-        presetRef?: {
-            docId: string;
-            versionId: string;
-        } | undefined;
+        geometry: import("@comapeo/schema/dist/schema/remoteDetectionAlert.js").Geometry;
         docId: string;
         versionId: string;
         originalVersionId: string;
@@ -104,6 +90,36 @@ export declare function useSingleDocByDocId<D extends WriteableDocumentType>({ p
         updatedAt: string;
         links: string[];
         deleted: boolean;
+    } & import("@comapeo/core/dist/datatype/index.js").DerivedDocFields) | ({
+        schemaName: "observation";
+        lat?: number | undefined;
+        lon?: number | undefined;
+        attachments: import("@comapeo/schema/dist/schema/observation.js").Attachment[];
+        tags: {
+            [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
+        };
+        metadata?: {
+            manualLocation?: boolean;
+            position?: import("@comapeo/schema/dist/schema/observation.js").Position;
+            lastSavedPosition?: import("@comapeo/schema/dist/schema/observation.js").Position;
+            positionProvider?: {
+                gpsAvailable?: boolean;
+                passiveAvailable?: boolean;
+                locationServicesEnabled: boolean;
+                networkAvailable?: boolean;
+            };
+        } | undefined;
+        presetRef?: {
+            docId: string;
+            versionId: string;
+        } | undefined;
+        docId: string;
+        versionId: string;
+        originalVersionId: string;
+        createdAt: string;
+        updatedAt: string;
+        links: string[];
+        deleted: boolean;
     } & import("@comapeo/core/dist/datatype/index.js").DerivedDocFields) | ({
         schemaName: "field";
         tagKey: string;
@@ -125,22 +141,6 @@ export declare function useSingleDocByDocId<D extends WriteableDocumentType>({ p
         updatedAt: string;
         links: string[];
         deleted: boolean;
-    } & import("@comapeo/core/dist/datatype/index.js").DerivedDocFields) | ({
-        schemaName: "remoteDetectionAlert";
-        detectionDateStart: string;
-        detectionDateEnd: string;
-        sourceId: string;
-        metadata: {
-            [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
-        };
-        geometry: import("@comapeo/schema/dist/schema/remoteDetectionAlert.js").Geometry;
-        docId: string;
-        versionId: string;
-        originalVersionId: string;
-        createdAt: string;
-        updatedAt: string;
-        links: string[];
-        deleted: boolean;
     } & import("@comapeo/core/dist/datatype/index.js").DerivedDocFields), {
         schemaName: D;
     }>;
@@ -198,28 +198,14 @@ export declare function useSingleDocByVersionId<D extends WriteableDocumentType>
         links: string[];
         deleted: boolean;
     } & import("@comapeo/core/dist/datatype/index.js").DerivedDocFields) | ({
-        schemaName: "observation";
-        lat?: number | undefined;
-        lon?: number | undefined;
-        attachments: import("@comapeo/schema/dist/schema/observation.js").Attachment[];
-        tags: {
+        schemaName: "remoteDetectionAlert";
+        detectionDateStart: string;
+        detectionDateEnd: string;
+        sourceId: string;
+        metadata: {
             [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
         };
-        metadata?: {
-            manualLocation?: boolean;
-            position?: import("@comapeo/schema/dist/schema/observation.js").Position;
-            lastSavedPosition?: import("@comapeo/schema/dist/schema/observation.js").Position;
-            positionProvider?: {
-                gpsAvailable?: boolean;
-                passiveAvailable?: boolean;
-                locationServicesEnabled: boolean;
-                networkAvailable?: boolean;
-            };
-        } | undefined;
-        presetRef?: {
-            docId: string;
-            versionId: string;
-        } | undefined;
+        geometry: import("@comapeo/schema/dist/schema/remoteDetectionAlert.js").Geometry;
         docId: string;
         versionId: string;
         originalVersionId: string;
@@ -251,6 +237,36 @@ export declare function useSingleDocByVersionId<D extends WriteableDocumentType>
         updatedAt: string;
         links: string[];
         deleted: boolean;
+    } & import("@comapeo/core/dist/datatype/index.js").DerivedDocFields) | ({
+        schemaName: "observation";
+        lat?: number | undefined;
+        lon?: number | undefined;
+        attachments: import("@comapeo/schema/dist/schema/observation.js").Attachment[];
+        tags: {
+            [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
+        };
+        metadata?: {
+            manualLocation?: boolean;
+            position?: import("@comapeo/schema/dist/schema/observation.js").Position;
+            lastSavedPosition?: import("@comapeo/schema/dist/schema/observation.js").Position;
+            positionProvider?: {
+                gpsAvailable?: boolean;
+                passiveAvailable?: boolean;
+                locationServicesEnabled: boolean;
+                networkAvailable?: boolean;
+            };
+        } | undefined;
+        presetRef?: {
+            docId: string;
+            versionId: string;
+        } | undefined;
+        docId: string;
+        versionId: string;
+        originalVersionId: string;
+        createdAt: string;
+        updatedAt: string;
+        links: string[];
+        deleted: boolean;
     } & import("@comapeo/core/dist/datatype/index.js").DerivedDocFields) | ({
         schemaName: "field";
         tagKey: string;
@@ -272,22 +288,6 @@ export declare function useSingleDocByVersionId<D extends WriteableDocumentType>
         updatedAt: string;
         links: string[];
         deleted: boolean;
-    } & import("@comapeo/core/dist/datatype/index.js").DerivedDocFields) | ({
-        schemaName: "remoteDetectionAlert";
-        detectionDateStart: string;
-        detectionDateEnd: string;
-        sourceId: string;
-        metadata: {
-            [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
-        };
-        geometry: import("@comapeo/schema/dist/schema/remoteDetectionAlert.js").Geometry;
-        docId: string;
-        versionId: string;
-        originalVersionId: string;
-        createdAt: string;
-        updatedAt: string;
-        links: string[];
-        deleted: boolean;
     } & import("@comapeo/core/dist/datatype/index.js").DerivedDocFields), {
         schemaName: D;
     }>;
@@ -356,28 +356,14 @@ export declare function useManyDocs<D extends WriteableDocumentType>({ projectId
         links: string[];
         deleted: boolean;
     } & import("@comapeo/core/dist/datatype/index.js").DerivedDocFields)[] | ({
-        schemaName: "observation";
-        lat?: number | undefined;
-        lon?: number | undefined;
-        attachments: import("@comapeo/schema/dist/schema/observation.js").Attachment[];
-        tags: {
+        schemaName: "remoteDetectionAlert";
+        detectionDateStart: string;
+        detectionDateEnd: string;
+        sourceId: string;
+        metadata: {
             [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
         };
-        metadata?: {
-            manualLocation?: boolean;
-            position?: import("@comapeo/schema/dist/schema/observation.js").Position;
-            lastSavedPosition?: import("@comapeo/schema/dist/schema/observation.js").Position;
-            positionProvider?: {
-                gpsAvailable?: boolean;
-                passiveAvailable?: boolean;
-                locationServicesEnabled: boolean;
-                networkAvailable?: boolean;
-            };
-        } | undefined;
-        presetRef?: {
-            docId: string;
-            versionId: string;
-        } | undefined;
+        geometry: import("@comapeo/schema/dist/schema/remoteDetectionAlert.js").Geometry;
         docId: string;
         versionId: string;
         originalVersionId: string;
@@ -409,6 +395,36 @@ export declare function useManyDocs<D extends WriteableDocumentType>({ projectId
         updatedAt: string;
         links: string[];
         deleted: boolean;
+    } & import("@comapeo/core/dist/datatype/index.js").DerivedDocFields)[] | ({
+        schemaName: "observation";
+        lat?: number | undefined;
+        lon?: number | undefined;
+        attachments: import("@comapeo/schema/dist/schema/observation.js").Attachment[];
+        tags: {
+            [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
+        };
+        metadata?: {
+            manualLocation?: boolean;
+            position?: import("@comapeo/schema/dist/schema/observation.js").Position;
+            lastSavedPosition?: import("@comapeo/schema/dist/schema/observation.js").Position;
+            positionProvider?: {
+                gpsAvailable?: boolean;
+                passiveAvailable?: boolean;
+                locationServicesEnabled: boolean;
+                networkAvailable?: boolean;
+            };
+        } | undefined;
+        presetRef?: {
+            docId: string;
+            versionId: string;
+        } | undefined;
+        docId: string;
+        versionId: string;
+        originalVersionId: string;
+        createdAt: string;
+        updatedAt: string;
+        links: string[];
+        deleted: boolean;
     } & import("@comapeo/core/dist/datatype/index.js").DerivedDocFields)[] | ({
         schemaName: "field";
         tagKey: string;
@@ -430,22 +446,6 @@ export declare function useManyDocs<D extends WriteableDocumentType>({ projectId
         updatedAt: string;
         links: string[];
         deleted: boolean;
-    } & import("@comapeo/core/dist/datatype/index.js").DerivedDocFields)[] | ({
-        schemaName: "remoteDetectionAlert";
-        detectionDateStart: string;
-        detectionDateEnd: string;
-        sourceId: string;
-        metadata: {
-            [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
-        };
-        geometry: import("@comapeo/schema/dist/schema/remoteDetectionAlert.js").Geometry;
-        docId: string;
-        versionId: string;
-        originalVersionId: string;
-        createdAt: string;
-        updatedAt: string;
-        links: string[];
-        deleted: boolean;
     } & import("@comapeo/core/dist/datatype/index.js").DerivedDocFields)[], Array<{
         schemaName: D;
     }>>;

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

@@ -360,9 +360,38 @@ export declare function useLeaveProject(): {
     reset: () => void;
     status: "pending" | "success" | "idle";
 };
+/**
+ * Update the categories of a project using an external file.
+ *
+ * @param opts.projectId Public ID of the project to apply changes to.
+ */
+export declare function useImportProjectCategories({ projectId, }: {
+    projectId: string;
+}): {
+    error: Error;
+    mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
+        filePath: string;
+    }, unknown>;
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
+        filePath: string;
+    }, unknown>;
+    reset: () => void;
+    status: "error";
+} | {
+    error: null;
+    mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
+        filePath: string;
+    }, unknown>;
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
+        filePath: string;
+    }, unknown>;
+    reset: () => void;
+    status: "pending" | "success" | "idle";
+};
 /**
  * Update the configuration of a project using an external file.
  *
+ * @deprecated Use `useImportProjectCategories` instead.
  * @param opts.projectId Public ID of the project to apply changes to.
  */
 export declare function useImportProjectConfig({ projectId }: {

package/dist/esm/hooks/projects.js

@@ -1,6 +1,6 @@
 import { useMutation, useQueryClient, useSuspenseQuery, } from '@tanstack/react-query';
 import { useSyncExternalStore } from 'react';
-import { addServerPeerMutationOptions, changeMemberRoleMutationOptions, connectSyncServersMutationOptions, createBlobMutationOptions, createProjectMutationOptions, disconnectSyncServersMutationOptions, documentCreatedByQueryOptions, exportGeoJSONMutationOptions, exportZipFileMutationOptions, importProjectConfigMutationOptions, leaveProjectMutationOptions, mediaServerOriginQueryOptions, projectByIdQueryOptions, projectMemberByIdQueryOptions, projectMembersQueryOptions, projectOwnRoleQueryOptions, projectSettingsQueryOptions, projectsQueryOptions, removeServerPeerMutationOptions, setAutostopDataSyncTimeoutMutationOptions, startSyncMutationOptions, stopSyncMutationOptions, updateProjectSettingsMutationOptions, } from '../lib/react-query/projects.js';
+import { addServerPeerMutationOptions, changeMemberRoleMutationOptions, connectSyncServersMutationOptions, createBlobMutationOptions, createProjectMutationOptions, disconnectSyncServersMutationOptions, documentCreatedByQueryOptions, exportGeoJSONMutationOptions, exportZipFileMutationOptions, importProjectCategoriesMutationOptions, importProjectConfigMutationOptions, leaveProjectMutationOptions, mediaServerOriginQueryOptions, projectByIdQueryOptions, projectMemberByIdQueryOptions, projectMembersQueryOptions, projectOwnRoleQueryOptions, projectSettingsQueryOptions, projectsQueryOptions, removeServerPeerMutationOptions, setAutostopDataSyncTimeoutMutationOptions, startSyncMutationOptions, stopSyncMutationOptions, updateProjectSettingsMutationOptions, } from '../lib/react-query/projects.js';
 import { SyncStore } from '../lib/sync.js';
 import { getBlobUrl, getIconUrl } from '../lib/urls.js';
 import { useClientApi } from './client.js';
@@ -317,9 +317,27 @@ export function useLeaveProject() {
         ? { error, mutate, mutateAsync, reset, status }
         : { error: null, mutate, mutateAsync, reset, status };
 }
+/**
+ * Update the categories of a project using an external file.
+ *
+ * @param opts.projectId Public ID of the project to apply changes to.
+ */
+export function useImportProjectCategories({ projectId, }) {
+    const queryClient = useQueryClient();
+    const { data: projectApi } = useSingleProject({ projectId });
+    const { error, mutate, mutateAsync, reset, status } = useMutation(importProjectCategoriesMutationOptions({
+        queryClient,
+        projectApi,
+        projectId,
+    }));
+    return status === 'error'
+        ? { error, mutate, mutateAsync, reset, status }
+        : { error: null, mutate, mutateAsync, reset, status };
+}
 /**
  * Update the configuration of a project using an external file.
  *
+ * @deprecated Use `useImportProjectCategories` instead.
  * @param opts.projectId Public ID of the project to apply changes to.
  */
 export function useImportProjectConfig({ projectId }) {

package/dist/esm/index.d.ts

@@ -3,6 +3,6 @@ export { useClientApi, useIsArchiveDevice, useOwnDeviceInfo, useSetIsArchiveDevi
 export { useCreateDocument, useDeleteDocument, useManyDocs, usePresetsSelection, 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, useChangeMemberRole, useExportGeoJSON, useExportZipFile, } from './hooks/projects.js';
+export { useAddServerPeer, useAttachmentUrl, useConnectSyncServers, useCreateBlob, useCreateProject, useDataSyncProgress, useDisconnectSyncServers, useDocumentCreatedBy, useIconUrl, useImportProjectCategories, useImportProjectConfig, useLeaveProject, useManyMembers, useManyProjects, useOwnRoleInProject, useProjectSettings, useRemoveServerPeer, useSetAutostopDataSyncTimeout, useSingleMember, useSingleProject, useStartSync, useStopSync, useSyncState, useUpdateProjectSettings, useChangeMemberRole, 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, usePresetsSelection, 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, useChangeMemberRole, useExportGeoJSON, useExportZipFile, } from './hooks/projects.js';
+export { useAddServerPeer, useAttachmentUrl, useConnectSyncServers, useCreateBlob, useCreateProject, useDataSyncProgress, useDisconnectSyncServers, useDocumentCreatedBy, useIconUrl, useImportProjectCategories, useImportProjectConfig, useLeaveProject, useManyMembers, useManyProjects, useOwnRoleInProject, useProjectSettings, useRemoveServerPeer, useSetAutostopDataSyncTimeout, useSingleMember, useSingleProject, useStartSync, useStopSync, useSyncState, useUpdateProjectSettings, useChangeMemberRole, useExportGeoJSON, useExportZipFile, } from './hooks/projects.js';