@comapeo/core-react 1.0.1 → 1.1.0

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

@@ -0,0 +1,1501 @@
+import type { MapeoProjectApi } from '@comapeo/ipc' with { 'resolution-mode': 'import' };
+import type { MapeoDoc } from '@comapeo/schema' with { 'resolution-mode': 'import' };
+export type DocumentType = Extract<MapeoDoc['schemaName'], 'field' | 'observation' | 'preset' | 'track' | 'remoteDetectionAlert'>;
+export declare function getDocumentsQueryKey<D extends DocumentType>({ projectId, docType, }: {
+    projectId: string;
+    docType: D;
+}): readonly ["@comapeo/core-react", "projects", string, D];
+export declare function getManyDocumentsQueryKey<D extends DocumentType>({ projectId, docType, includeDeleted, lang, }: {
+    projectId: string;
+    docType: D;
+    includeDeleted?: boolean;
+    lang?: string;
+}): readonly ["@comapeo/core-react", "projects", string, D, {
+    readonly includeDeleted: boolean | undefined;
+    readonly lang: string | undefined;
+}];
+export declare function getDocumentByDocIdQueryKey<D extends DocumentType>({ projectId, docType, docId, lang, }: {
+    projectId: string;
+    docType: D;
+    docId: string;
+    lang?: string;
+}): readonly ["@comapeo/core-react", "projects", string, D, string, {
+    readonly lang: string | undefined;
+}];
+export declare function getDocumentByVersionIdQueryKey<D extends DocumentType>({ projectId, docType, versionId, lang, }: {
+    projectId: string;
+    docType: D;
+    versionId: string;
+    lang?: string;
+}): readonly ["@comapeo/core-react", "projects", string, D, string, {
+    readonly lang: string | undefined;
+}];
+export declare function documentsQueryOptions<D extends DocumentType>({ projectApi, projectId, docType, includeDeleted, lang, }: {
+    projectApi: MapeoProjectApi;
+    projectId: string;
+    docType: D;
+    includeDeleted?: boolean;
+    lang?: string;
+}): import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<({
+    schemaName: "track";
+    locations: import("@comapeo/schema/dist/schema/track.js").Position[];
+    observationRefs: {
+        docId: string;
+        versionId: string;
+    }[];
+    tags: {
+        [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
+    };
+    docId: string;
+    versionId: string;
+    originalVersionId: string;
+    createdAt: string;
+    updatedAt: string;
+    links: string[];
+    deleted: boolean;
+} & {
+    forks: string[];
+})[] | ({
+    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;
+} & {
+    forks: string[];
+})[] | ({
+    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;
+} & {
+    forks: string[];
+})[] | ({
+    schemaName: "observation";
+    lat?: number | undefined;
+    lon?: number | undefined;
+    attachments: {
+        driveDiscoveryId: string;
+        name: string;
+        type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
+        hash: string;
+    }[];
+    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;
+} & {
+    forks: string[];
+})[] | ({
+    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;
+} & {
+    forks: string[];
+})[], Error, ({
+    schemaName: "track";
+    locations: import("@comapeo/schema/dist/schema/track.js").Position[];
+    observationRefs: {
+        docId: string;
+        versionId: string;
+    }[];
+    tags: {
+        [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
+    };
+    docId: string;
+    versionId: string;
+    originalVersionId: string;
+    createdAt: string;
+    updatedAt: string;
+    links: string[];
+    deleted: boolean;
+} & {
+    forks: string[];
+})[] | ({
+    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;
+} & {
+    forks: string[];
+})[] | ({
+    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;
+} & {
+    forks: string[];
+})[] | ({
+    schemaName: "observation";
+    lat?: number | undefined;
+    lon?: number | undefined;
+    attachments: {
+        driveDiscoveryId: string;
+        name: string;
+        type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
+        hash: string;
+    }[];
+    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;
+} & {
+    forks: string[];
+})[] | ({
+    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;
+} & {
+    forks: string[];
+})[], import("@tanstack/react-query").QueryKey>, "queryFn"> & {
+    queryFn?: import("@tanstack/react-query").QueryFunction<({
+        schemaName: "track";
+        locations: import("@comapeo/schema/dist/schema/track.js").Position[];
+        observationRefs: {
+            docId: string;
+            versionId: string;
+        }[];
+        tags: {
+            [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
+        };
+        docId: string;
+        versionId: string;
+        originalVersionId: string;
+        createdAt: string;
+        updatedAt: string;
+        links: string[];
+        deleted: boolean;
+    } & {
+        forks: string[];
+    })[] | ({
+        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;
+    } & {
+        forks: string[];
+    })[] | ({
+        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;
+    } & {
+        forks: string[];
+    })[] | ({
+        schemaName: "observation";
+        lat?: number | undefined;
+        lon?: number | undefined;
+        attachments: {
+            driveDiscoveryId: string;
+            name: string;
+            type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
+            hash: string;
+        }[];
+        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;
+    } & {
+        forks: string[];
+    })[] | ({
+        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;
+    } & {
+        forks: string[];
+    })[], import("@tanstack/react-query").QueryKey, never> | undefined;
+} & {
+    queryKey: import("@tanstack/react-query").DataTag<import("@tanstack/react-query").QueryKey, ({
+        schemaName: "track";
+        locations: import("@comapeo/schema/dist/schema/track.js").Position[];
+        observationRefs: {
+            docId: string;
+            versionId: string;
+        }[];
+        tags: {
+            [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
+        };
+        docId: string;
+        versionId: string;
+        originalVersionId: string;
+        createdAt: string;
+        updatedAt: string;
+        links: string[];
+        deleted: boolean;
+    } & {
+        forks: string[];
+    })[] | ({
+        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;
+    } & {
+        forks: string[];
+    })[] | ({
+        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;
+    } & {
+        forks: string[];
+    })[] | ({
+        schemaName: "observation";
+        lat?: number | undefined;
+        lon?: number | undefined;
+        attachments: {
+            driveDiscoveryId: string;
+            name: string;
+            type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
+            hash: string;
+        }[];
+        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;
+    } & {
+        forks: string[];
+    })[] | ({
+        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;
+    } & {
+        forks: string[];
+    })[]>;
+};
+export declare function documentByDocumentIdQueryOptions<D extends DocumentType>({ projectApi, projectId, docType, docId, lang, }: {
+    projectApi: MapeoProjectApi;
+    projectId: string;
+    docType: D;
+    docId: string;
+    lang?: string;
+}): import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<({
+    schemaName: "track";
+    locations: import("@comapeo/schema/dist/schema/track.js").Position[];
+    observationRefs: {
+        docId: string;
+        versionId: string;
+    }[];
+    tags: {
+        [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
+    };
+    docId: string;
+    versionId: string;
+    originalVersionId: string;
+    createdAt: string;
+    updatedAt: string;
+    links: string[];
+    deleted: boolean;
+} & {
+    forks: string[];
+}) | ({
+    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;
+} & {
+    forks: string[];
+}) | ({
+    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;
+} & {
+    forks: string[];
+}) | ({
+    schemaName: "observation";
+    lat?: number | undefined;
+    lon?: number | undefined;
+    attachments: {
+        driveDiscoveryId: string;
+        name: string;
+        type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
+        hash: string;
+    }[];
+    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;
+} & {
+    forks: string[];
+}) | ({
+    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;
+} & {
+    forks: string[];
+}), Error, ({
+    schemaName: "track";
+    locations: import("@comapeo/schema/dist/schema/track.js").Position[];
+    observationRefs: {
+        docId: string;
+        versionId: string;
+    }[];
+    tags: {
+        [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
+    };
+    docId: string;
+    versionId: string;
+    originalVersionId: string;
+    createdAt: string;
+    updatedAt: string;
+    links: string[];
+    deleted: boolean;
+} & {
+    forks: string[];
+}) | ({
+    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;
+} & {
+    forks: string[];
+}) | ({
+    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;
+} & {
+    forks: string[];
+}) | ({
+    schemaName: "observation";
+    lat?: number | undefined;
+    lon?: number | undefined;
+    attachments: {
+        driveDiscoveryId: string;
+        name: string;
+        type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
+        hash: string;
+    }[];
+    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;
+} & {
+    forks: string[];
+}) | ({
+    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;
+} & {
+    forks: string[];
+}), import("@tanstack/react-query").QueryKey>, "queryFn"> & {
+    queryFn?: import("@tanstack/react-query").QueryFunction<({
+        schemaName: "track";
+        locations: import("@comapeo/schema/dist/schema/track.js").Position[];
+        observationRefs: {
+            docId: string;
+            versionId: string;
+        }[];
+        tags: {
+            [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
+        };
+        docId: string;
+        versionId: string;
+        originalVersionId: string;
+        createdAt: string;
+        updatedAt: string;
+        links: string[];
+        deleted: boolean;
+    } & {
+        forks: string[];
+    }) | ({
+        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;
+    } & {
+        forks: string[];
+    }) | ({
+        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;
+    } & {
+        forks: string[];
+    }) | ({
+        schemaName: "observation";
+        lat?: number | undefined;
+        lon?: number | undefined;
+        attachments: {
+            driveDiscoveryId: string;
+            name: string;
+            type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
+            hash: string;
+        }[];
+        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;
+    } & {
+        forks: string[];
+    }) | ({
+        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;
+    } & {
+        forks: string[];
+    }), import("@tanstack/react-query").QueryKey, never> | undefined;
+} & {
+    queryKey: import("@tanstack/react-query").DataTag<import("@tanstack/react-query").QueryKey, ({
+        schemaName: "track";
+        locations: import("@comapeo/schema/dist/schema/track.js").Position[];
+        observationRefs: {
+            docId: string;
+            versionId: string;
+        }[];
+        tags: {
+            [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
+        };
+        docId: string;
+        versionId: string;
+        originalVersionId: string;
+        createdAt: string;
+        updatedAt: string;
+        links: string[];
+        deleted: boolean;
+    } & {
+        forks: string[];
+    }) | ({
+        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;
+    } & {
+        forks: string[];
+    }) | ({
+        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;
+    } & {
+        forks: string[];
+    }) | ({
+        schemaName: "observation";
+        lat?: number | undefined;
+        lon?: number | undefined;
+        attachments: {
+            driveDiscoveryId: string;
+            name: string;
+            type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
+            hash: string;
+        }[];
+        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;
+    } & {
+        forks: string[];
+    }) | ({
+        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;
+    } & {
+        forks: string[];
+    })>;
+};
+export declare function documentByVersionIdQueryOptions<D extends DocumentType>({ projectApi, projectId, docType, versionId, lang, }: {
+    projectApi: MapeoProjectApi;
+    projectId: string;
+    docType: D;
+    versionId: string;
+    lang?: string;
+}): import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<{
+    schemaName: "track";
+    locations: import("@comapeo/schema/dist/schema/track.js").Position[];
+    observationRefs: {
+        docId: string;
+        versionId: string;
+    }[];
+    tags: {
+        [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
+    };
+    docId: string;
+    versionId: string;
+    originalVersionId: string;
+    createdAt: string;
+    updatedAt: string;
+    links: string[];
+    deleted: boolean;
+} | {
+    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;
+} | {
+    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;
+} | {
+    schemaName: "observation";
+    lat?: number | undefined;
+    lon?: number | undefined;
+    attachments: {
+        driveDiscoveryId: string;
+        name: string;
+        type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
+        hash: string;
+    }[];
+    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;
+} | {
+    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;
+}, Error, {
+    schemaName: "track";
+    locations: import("@comapeo/schema/dist/schema/track.js").Position[];
+    observationRefs: {
+        docId: string;
+        versionId: string;
+    }[];
+    tags: {
+        [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
+    };
+    docId: string;
+    versionId: string;
+    originalVersionId: string;
+    createdAt: string;
+    updatedAt: string;
+    links: string[];
+    deleted: boolean;
+} | {
+    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;
+} | {
+    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;
+} | {
+    schemaName: "observation";
+    lat?: number | undefined;
+    lon?: number | undefined;
+    attachments: {
+        driveDiscoveryId: string;
+        name: string;
+        type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
+        hash: string;
+    }[];
+    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;
+} | {
+    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("@tanstack/react-query").QueryKey>, "queryFn"> & {
+    queryFn?: import("@tanstack/react-query").QueryFunction<{
+        schemaName: "track";
+        locations: import("@comapeo/schema/dist/schema/track.js").Position[];
+        observationRefs: {
+            docId: string;
+            versionId: string;
+        }[];
+        tags: {
+            [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
+        };
+        docId: string;
+        versionId: string;
+        originalVersionId: string;
+        createdAt: string;
+        updatedAt: string;
+        links: string[];
+        deleted: boolean;
+    } | {
+        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;
+    } | {
+        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;
+    } | {
+        schemaName: "observation";
+        lat?: number | undefined;
+        lon?: number | undefined;
+        attachments: {
+            driveDiscoveryId: string;
+            name: string;
+            type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
+            hash: string;
+        }[];
+        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;
+    } | {
+        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("@tanstack/react-query").QueryKey, never> | undefined;
+} & {
+    queryKey: import("@tanstack/react-query").DataTag<import("@tanstack/react-query").QueryKey, {
+        schemaName: "track";
+        locations: import("@comapeo/schema/dist/schema/track.js").Position[];
+        observationRefs: {
+            docId: string;
+            versionId: string;
+        }[];
+        tags: {
+            [k: string]: boolean | number | string | null | (boolean | number | string | null)[];
+        };
+        docId: string;
+        versionId: string;
+        originalVersionId: string;
+        createdAt: string;
+        updatedAt: string;
+        links: string[];
+        deleted: boolean;
+    } | {
+        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;
+    } | {
+        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;
+    } | {
+        schemaName: "observation";
+        lat?: number | undefined;
+        lon?: number | undefined;
+        attachments: {
+            driveDiscoveryId: string;
+            name: string;
+            type: "attachment_type_unspecified" | "photo" | "video" | "audio" | "UNRECOGNIZED";
+            hash: string;
+        }[];
+        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;
+    } | {
+        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;
+    }>;
+};