@comapeo/core-react 6.4.0 → 7.0.0

package/dist/commonjs/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", { with: { "resolution-mode": "import" } }).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", { with: { "resolution-mode": "import" } }).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", { with: { "resolution-mode": "import" } }).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", { with: { "resolution-mode": "import" } }).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", { with: { "resolution-mode": "import" } }).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", { with: { "resolution-mode": "import" } }).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", { with: { "resolution-mode": "import" } }).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", { with: { "resolution-mode": "import" } }).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", { with: { "resolution-mode": "import" } }).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", { with: { "resolution-mode": "import" } }).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", { with: { "resolution-mode": "import" } }).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", { with: { "resolution-mode": "import" } }).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", { with: { "resolution-mode": "import" } }).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", { with: { "resolution-mode": "import" } }).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", { with: { "resolution-mode": "import" } }).DerivedDocFields)[], Array<{
         schemaName: D;
     }>>;

package/dist/commonjs/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/commonjs/hooks/projects.js

@@ -13,6 +13,7 @@ exports.useAddServerPeer = useAddServerPeer;
 exports.useRemoveServerPeer = useRemoveServerPeer;
 exports.useCreateProject = useCreateProject;
 exports.useLeaveProject = useLeaveProject;
+exports.useImportProjectCategories = useImportProjectCategories;
 exports.useImportProjectConfig = useImportProjectConfig;
 exports.useUpdateProjectSettings = useUpdateProjectSettings;
 exports.useChangeMemberRole = useChangeMemberRole;
@@ -345,9 +346,27 @@ 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.
+ */
+function useImportProjectCategories({ projectId, }) {
+    const queryClient = (0, react_query_1.useQueryClient)();
+    const { data: projectApi } = useSingleProject({ projectId });
+    const { error, mutate, mutateAsync, reset, status } = (0, react_query_1.useMutation)((0, projects_js_1.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.
  */
 function useImportProjectConfig({ projectId }) {

package/dist/commonjs/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/commonjs/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useExportZipFile = exports.useExportGeoJSON = exports.useChangeMemberRole = 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.usePresetsSelection = 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.useChangeMemberRole = 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.useImportProjectCategories = 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.usePresetsSelection = 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; } });
@@ -38,6 +38,7 @@ Object.defineProperty(exports, "useDataSyncProgress", { enumerable: true, get: f
 Object.defineProperty(exports, "useDisconnectSyncServers", { enumerable: true, get: function () { return projects_js_1.useDisconnectSyncServers; } });
 Object.defineProperty(exports, "useDocumentCreatedBy", { enumerable: true, get: function () { return projects_js_1.useDocumentCreatedBy; } });
 Object.defineProperty(exports, "useIconUrl", { enumerable: true, get: function () { return projects_js_1.useIconUrl; } });
+Object.defineProperty(exports, "useImportProjectCategories", { enumerable: true, get: function () { return projects_js_1.useImportProjectCategories; } });
 Object.defineProperty(exports, "useImportProjectConfig", { enumerable: true, get: function () { return projects_js_1.useImportProjectConfig; } });
 Object.defineProperty(exports, "useLeaveProject", { enumerable: true, get: function () { return projects_js_1.useLeaveProject; } });
 Object.defineProperty(exports, "useManyMembers", { enumerable: true, get: function () { return projects_js_1.useManyMembers; } });