@comapeo/core-react 9.0.2 → 10.0.0

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

@@ -1,7 +1,7 @@
-import type { Preset } from '@comapeo/schema' with {
-    'resolution-mode': 'import'
-};
-import type { WriteableDocumentType } from '../lib/types.js';
+import type { MapeoProjectApi } from '@comapeo/ipc';
+import { type UseMutationResult, type UseSuspenseQueryResult } from '@tanstack/react-query';
+import { type FilteredMutationResult } from '../lib/react-query.js';
+import type { WriteableDocumentType, WriteableValue } from '../lib/types.js';
 /**
  * Retrieve a single document from the database based on the document's document ID.
  *
@@ -30,125 +30,7 @@ export declare function useSingleDocByDocId<D extends WriteableDocumentType>({ p
     docType: D;
     docId: string;
     lang?: string;
-}): {
-    data: Extract<({
-        schemaName: "track";
-        locations: [import("@comapeo/schema/dist/schema/track.js").Position, import("@comapeo/schema/dist/schema/track.js").Position, ...import("@comapeo/schema/dist/schema/track.js").Position[]];
-        observationRefs: {
-            docId: string;
-            versionId: string;
-        }[];
-        tags: {
-            [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
-        };
-        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: "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: "preset";
-        name: string;
-        geometry: ("point" | "vertex" | "line" | "area" | "relation")[];
-        tags: import("@comapeo/schema/dist/schema/preset.js").Tags;
-        addTags: import("@comapeo/schema/dist/schema/preset.js").Tags1;
-        removeTags: import("@comapeo/schema/dist/schema/preset.js").Tags2;
-        fieldRefs: {
-            docId: string;
-            versionId: string;
-        }[];
-        iconRef?: {
-            docId: string;
-            versionId: string;
-        } | undefined;
-        terms: string[];
-        color?: 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: "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;
-        type: "type_unspecified" | "text" | "number" | "selectOne" | "selectMultiple" | "UNRECOGNIZED";
-        label: string;
-        appearance?: ("appearance_unspecified" | "singleline" | "multiline" | "UNRECOGNIZED") | undefined;
-        snakeCase?: boolean | undefined;
-        options?: {
-            label: string;
-            value: string | boolean | number | null;
-        }[] | undefined;
-        universal?: boolean | undefined;
-        placeholder?: string | undefined;
-        helperText?: 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: D;
-    }>;
-    error: Error | null;
-    isRefetching: boolean;
-};
+}): Pick<UseSuspenseQueryResult<Awaited<ReturnType<MapeoProjectApi[D]['getByDocId']>>>, 'data' | 'error' | 'isRefetching'>;
 /**
  * Retrieve a single document from the database based on the document's version ID.
  *
@@ -177,125 +59,7 @@ export declare function useSingleDocByVersionId<D extends WriteableDocumentType>
     docType: D;
     versionId: string;
     lang?: string;
-}): {
-    data: Extract<({
-        schemaName: "track";
-        locations: [import("@comapeo/schema/dist/schema/track.js").Position, import("@comapeo/schema/dist/schema/track.js").Position, ...import("@comapeo/schema/dist/schema/track.js").Position[]];
-        observationRefs: {
-            docId: string;
-            versionId: string;
-        }[];
-        tags: {
-            [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
-        };
-        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: "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: "preset";
-        name: string;
-        geometry: ("point" | "vertex" | "line" | "area" | "relation")[];
-        tags: import("@comapeo/schema/dist/schema/preset.js").Tags;
-        addTags: import("@comapeo/schema/dist/schema/preset.js").Tags1;
-        removeTags: import("@comapeo/schema/dist/schema/preset.js").Tags2;
-        fieldRefs: {
-            docId: string;
-            versionId: string;
-        }[];
-        iconRef?: {
-            docId: string;
-            versionId: string;
-        } | undefined;
-        terms: string[];
-        color?: 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: "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;
-        type: "type_unspecified" | "text" | "number" | "selectOne" | "selectMultiple" | "UNRECOGNIZED";
-        label: string;
-        appearance?: ("appearance_unspecified" | "singleline" | "multiline" | "UNRECOGNIZED") | undefined;
-        snakeCase?: boolean | undefined;
-        options?: {
-            label: string;
-            value: string | boolean | number | null;
-        }[] | undefined;
-        universal?: boolean | undefined;
-        placeholder?: string | undefined;
-        helperText?: 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: D;
-    }>;
-    error: Error | null;
-    isRefetching: boolean;
-};
+}): Pick<UseSuspenseQueryResult<Awaited<ReturnType<MapeoProjectApi[D]['getByVersionId']>>>, 'data' | 'error' | 'isRefetching'>;
 /**
  * Retrieve all documents of a specific `docType`.
  *
@@ -335,125 +99,7 @@ export declare function useManyDocs<D extends WriteableDocumentType>({ projectId
     docType: D;
     includeDeleted?: boolean;
     lang?: string;
-}): {
-    data: Extract<({
-        schemaName: "track";
-        locations: [import("@comapeo/schema/dist/schema/track.js").Position, import("@comapeo/schema/dist/schema/track.js").Position, ...import("@comapeo/schema/dist/schema/track.js").Position[]];
-        observationRefs: {
-            docId: string;
-            versionId: string;
-        }[];
-        tags: {
-            [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
-        };
-        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: "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: "preset";
-        name: string;
-        geometry: ("point" | "vertex" | "line" | "area" | "relation")[];
-        tags: import("@comapeo/schema/dist/schema/preset.js").Tags;
-        addTags: import("@comapeo/schema/dist/schema/preset.js").Tags1;
-        removeTags: import("@comapeo/schema/dist/schema/preset.js").Tags2;
-        fieldRefs: {
-            docId: string;
-            versionId: string;
-        }[];
-        iconRef?: {
-            docId: string;
-            versionId: string;
-        } | undefined;
-        terms: string[];
-        color?: 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: "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;
-        type: "type_unspecified" | "text" | "number" | "selectOne" | "selectMultiple" | "UNRECOGNIZED";
-        label: string;
-        appearance?: ("appearance_unspecified" | "singleline" | "multiline" | "UNRECOGNIZED") | undefined;
-        snakeCase?: boolean | undefined;
-        options?: {
-            label: string;
-            value: string | boolean | number | null;
-        }[] | undefined;
-        universal?: boolean | undefined;
-        placeholder?: string | undefined;
-        helperText?: string | undefined;
-        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;
-    }>>;
-    error: Error | null;
-    isRefetching: boolean;
-};
+}): Pick<UseSuspenseQueryResult<Awaited<ReturnType<MapeoProjectApi[D]['getMany']>>>, 'data' | 'error' | 'isRefetching'>;
 /**
  * Create a document for a project.
  *
@@ -463,27 +109,9 @@ export declare function useManyDocs<D extends WriteableDocumentType>({ projectId
 export declare function useCreateDocument<D extends WriteableDocumentType>({ docType, projectId, }: {
     docType: D;
     projectId: string;
-}): {
-    error: Error;
-    mutate: import("@tanstack/react-query").UseMutateFunction<import("../lib/types.js").WriteableDocument<D> & import("@comapeo/core/dist/datatype/index.js").DerivedDocFields, Error, {
-        value: Omit<import("../lib/types.js").WriteableValue<D>, "schemaName">;
-    }, unknown>;
-    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<import("../lib/types.js").WriteableDocument<D> & import("@comapeo/core/dist/datatype/index.js").DerivedDocFields, Error, {
-        value: Omit<import("../lib/types.js").WriteableValue<D>, "schemaName">;
-    }, unknown>;
-    reset: () => void;
-    status: "error";
-} | {
-    error: null;
-    mutate: import("@tanstack/react-query").UseMutateFunction<import("../lib/types.js").WriteableDocument<D> & import("@comapeo/core/dist/datatype/index.js").DerivedDocFields, Error, {
-        value: Omit<import("../lib/types.js").WriteableValue<D>, "schemaName">;
-    }, unknown>;
-    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<import("../lib/types.js").WriteableDocument<D> & import("@comapeo/core/dist/datatype/index.js").DerivedDocFields, Error, {
-        value: Omit<import("../lib/types.js").WriteableValue<D>, "schemaName">;
-    }, unknown>;
-    reset: () => void;
-    status: "pending" | "success" | "idle";
-};
+}): FilteredMutationResult<UseMutationResult<Awaited<ReturnType<MapeoProjectApi[D]['create']>>, Error, {
+    value: Omit<WriteableValue<D>, 'schemaName'>;
+}>>;
 /**
  * Update a document within a project.
  *
@@ -493,31 +121,9 @@ export declare function useCreateDocument<D extends WriteableDocumentType>({ doc
 export declare function useUpdateDocument<D extends WriteableDocumentType>({ docType, projectId, }: {
     docType: D;
     projectId: string;
-}): {
-    error: Error;
-    mutate: import("@tanstack/react-query").UseMutateFunction<import("../lib/types.js").WriteableDocument<D> & import("@comapeo/core/dist/datatype/index.js").DerivedDocFields, Error, {
-        versionId: string;
-        value: Omit<import("../lib/types.js").WriteableValue<D>, "schemaName">;
-    }, unknown>;
-    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<import("../lib/types.js").WriteableDocument<D> & import("@comapeo/core/dist/datatype/index.js").DerivedDocFields, Error, {
-        versionId: string;
-        value: Omit<import("../lib/types.js").WriteableValue<D>, "schemaName">;
-    }, unknown>;
-    reset: () => void;
-    status: "error";
-} | {
-    error: null;
-    mutate: import("@tanstack/react-query").UseMutateFunction<import("../lib/types.js").WriteableDocument<D> & import("@comapeo/core/dist/datatype/index.js").DerivedDocFields, Error, {
-        versionId: string;
-        value: Omit<import("../lib/types.js").WriteableValue<D>, "schemaName">;
-    }, unknown>;
-    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<import("../lib/types.js").WriteableDocument<D> & import("@comapeo/core/dist/datatype/index.js").DerivedDocFields, Error, {
-        versionId: string;
-        value: Omit<import("../lib/types.js").WriteableValue<D>, "schemaName">;
-    }, unknown>;
-    reset: () => void;
-    status: "pending" | "success" | "idle";
-};
+}): FilteredMutationResult<UseMutationResult<Awaited<ReturnType<MapeoProjectApi[D]['update']>>, Error, {
+    value: Omit<WriteableValue<D>, 'schemaName'>;
+}>>;
 /**
  * Delete a document within a project.
  *
@@ -527,27 +133,9 @@ export declare function useUpdateDocument<D extends WriteableDocumentType>({ doc
 export declare function useDeleteDocument<D extends WriteableDocumentType>({ docType, projectId, }: {
     docType: D;
     projectId: string;
-}): {
-    error: Error;
-    mutate: import("@tanstack/react-query").UseMutateFunction<import("../lib/types.js").WriteableDocument<D> & import("@comapeo/core/dist/datatype/index.js").DerivedDocFields, Error, {
-        docId: string;
-    }, unknown>;
-    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<import("../lib/types.js").WriteableDocument<D> & import("@comapeo/core/dist/datatype/index.js").DerivedDocFields, Error, {
-        docId: string;
-    }, unknown>;
-    reset: () => void;
-    status: "error";
-} | {
-    error: null;
-    mutate: import("@tanstack/react-query").UseMutateFunction<import("../lib/types.js").WriteableDocument<D> & import("@comapeo/core/dist/datatype/index.js").DerivedDocFields, Error, {
-        docId: string;
-    }, unknown>;
-    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<import("../lib/types.js").WriteableDocument<D> & import("@comapeo/core/dist/datatype/index.js").DerivedDocFields, Error, {
-        docId: string;
-    }, unknown>;
-    reset: () => void;
-    status: "pending" | "success" | "idle";
-};
+}): FilteredMutationResult<UseMutationResult<Awaited<ReturnType<MapeoProjectApi[D]['delete']>>, Error, {
+    docId: string;
+}>>;
 /**
  * Retrieve presets for category selection, ordered by project settings.
  *
@@ -581,4 +169,28 @@ export declare function usePresetsSelection({ projectId, dataType, lang, }: {
     projectId: string;
     dataType: 'observation' | 'track';
     lang?: string;
-}): Array<Preset>;
+}): {
+    schemaName: "preset";
+    name: string;
+    geometry: ("point" | "vertex" | "line" | "area" | "relation")[];
+    tags: import("@comapeo/schema/dist/schema/preset.js").Tags;
+    addTags: import("@comapeo/schema/dist/schema/preset.js").Tags1;
+    removeTags: import("@comapeo/schema/dist/schema/preset.js").Tags2;
+    fieldRefs: {
+        docId: string;
+        versionId: string;
+    }[];
+    iconRef?: {
+        docId: string;
+        versionId: string;
+    } | undefined;
+    terms: string[];
+    color?: string | undefined;
+    docId: string;
+    versionId: string;
+    originalVersionId: string;
+    createdAt: string;
+    updatedAt: string;
+    links: string[];
+    deleted: boolean;
+}[];