@comapeo/core-react 9.0.2 → 10.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (73) hide show
  1. package/README.md +1 -1
  2. package/dist/commonjs/contexts/ClientApi.d.ts +1 -3
  3. package/dist/commonjs/contexts/ClientApi.js +2 -2
  4. package/dist/commonjs/hooks/client.d.ts +74 -33
  5. package/dist/commonjs/hooks/client.js +40 -11
  6. package/dist/commonjs/hooks/documents.d.ts +41 -429
  7. package/dist/commonjs/hooks/documents.js +101 -51
  8. package/dist/commonjs/hooks/invites.d.ts +153 -55
  9. package/dist/commonjs/hooks/invites.js +69 -20
  10. package/dist/commonjs/hooks/maps.d.ts +96 -225
  11. package/dist/commonjs/hooks/maps.js +104 -37
  12. package/dist/commonjs/hooks/projects.d.ts +666 -223
  13. package/dist/commonjs/hooks/projects.js +264 -131
  14. package/dist/commonjs/index.d.ts +2 -2
  15. package/dist/commonjs/lib/map-shares-stores.d.ts +1 -1
  16. package/dist/commonjs/lib/map-shares-stores.js +2 -2
  17. package/dist/commonjs/lib/presets.d.ts +1 -3
  18. package/dist/commonjs/lib/react-query.d.ts +103 -0
  19. package/dist/commonjs/lib/react-query.js +187 -0
  20. package/dist/commonjs/lib/sync.d.ts +2 -5
  21. package/dist/commonjs/lib/sync.js +0 -1
  22. package/dist/commonjs/lib/types.d.ts +4 -6
  23. package/dist/esm/contexts/ClientApi.d.ts +1 -3
  24. package/dist/esm/contexts/ClientApi.js +1 -1
  25. package/dist/esm/hooks/client.d.ts +74 -33
  26. package/dist/esm/hooks/client.js +40 -11
  27. package/dist/esm/hooks/documents.d.ts +41 -429
  28. package/dist/esm/hooks/documents.js +101 -51
  29. package/dist/esm/hooks/invites.d.ts +153 -55
  30. package/dist/esm/hooks/invites.js +69 -20
  31. package/dist/esm/hooks/maps.d.ts +96 -225
  32. package/dist/esm/hooks/maps.js +105 -38
  33. package/dist/esm/hooks/projects.d.ts +666 -223
  34. package/dist/esm/hooks/projects.js +262 -129
  35. package/dist/esm/index.d.ts +2 -2
  36. package/dist/esm/lib/map-shares-stores.d.ts +1 -1
  37. package/dist/esm/lib/map-shares-stores.js +1 -1
  38. package/dist/esm/lib/presets.d.ts +1 -3
  39. package/dist/esm/lib/react-query.d.ts +103 -0
  40. package/dist/esm/lib/react-query.js +162 -0
  41. package/dist/esm/lib/sync.d.ts +2 -5
  42. package/dist/esm/lib/sync.js +1 -1
  43. package/dist/esm/lib/types.d.ts +4 -6
  44. package/docs/API.md +137 -81
  45. package/package.json +39 -35
  46. package/dist/commonjs/lib/react-query/client.d.ts +0 -65
  47. package/dist/commonjs/lib/react-query/client.js +0 -68
  48. package/dist/commonjs/lib/react-query/documents.d.ts +0 -1484
  49. package/dist/commonjs/lib/react-query/documents.js +0 -149
  50. package/dist/commonjs/lib/react-query/invites.d.ts +0 -88
  51. package/dist/commonjs/lib/react-query/invites.js +0 -95
  52. package/dist/commonjs/lib/react-query/maps.d.ts +0 -104
  53. package/dist/commonjs/lib/react-query/maps.js +0 -129
  54. package/dist/commonjs/lib/react-query/mutation-result.d.ts +0 -8
  55. package/dist/commonjs/lib/react-query/mutation-result.js +0 -22
  56. package/dist/commonjs/lib/react-query/projects.d.ts +0 -316
  57. package/dist/commonjs/lib/react-query/projects.js +0 -359
  58. package/dist/commonjs/lib/react-query/shared.d.ts +0 -9
  59. package/dist/commonjs/lib/react-query/shared.js +0 -23
  60. package/dist/esm/lib/react-query/client.d.ts +0 -65
  61. package/dist/esm/lib/react-query/client.js +0 -59
  62. package/dist/esm/lib/react-query/documents.d.ts +0 -1484
  63. package/dist/esm/lib/react-query/documents.js +0 -137
  64. package/dist/esm/lib/react-query/invites.d.ts +0 -88
  65. package/dist/esm/lib/react-query/invites.js +0 -85
  66. package/dist/esm/lib/react-query/maps.d.ts +0 -104
  67. package/dist/esm/lib/react-query/maps.js +0 -119
  68. package/dist/esm/lib/react-query/mutation-result.d.ts +0 -8
  69. package/dist/esm/lib/react-query/mutation-result.js +0 -19
  70. package/dist/esm/lib/react-query/projects.d.ts +0 -316
  71. package/dist/esm/lib/react-query/projects.js +0 -324
  72. package/dist/esm/lib/react-query/shared.d.ts +0 -9
  73. package/dist/esm/lib/react-query/shared.js +0 -18
@@ -1,12 +1,7 @@
1
- import type { BlobApi, IconApi } from '@comapeo/core' with {
2
- 'resolution-mode': 'import'
3
- };
4
- import type { RoleChangeEvent } from '@comapeo/core/dist/mapeo-project.js' with {
5
- 'resolution-mode': 'import'
6
- };
7
- import type { MapeoProjectApi } from '@comapeo/ipc' with {
8
- 'resolution-mode': 'import'
9
- };
1
+ import type { BlobApi, EditableProjectSettings, IconApi, MemberApi } from '@comapeo/core';
2
+ import type { MapeoClientApi, MapeoProjectApi } from '@comapeo/ipc';
3
+ import { UseMutationResult, type UseSuspenseQueryResult } from '@tanstack/react-query';
4
+ import { type FilteredMutationResult } from '../lib/react-query.js';
10
5
  import { type SyncState } from '../lib/sync.js';
11
6
  /**
12
7
  * Retrieve the project settings for a project.
@@ -22,13 +17,9 @@ import { type SyncState } from '../lib/sync.js';
22
17
  * }
23
18
  * ```
24
19
  */
25
- export declare function useProjectSettings({ projectId }: {
20
+ export declare function useProjectSettings({ projectId, }: {
26
21
  projectId: string;
27
- }): {
28
- data: import("@comapeo/core/dist/mapeo-project.js", { with: { "resolution-mode": "import" } }).EditableProjectSettings;
29
- error: Error | null;
30
- isRefetching: boolean;
31
- };
22
+ }): Pick<UseSuspenseQueryResult<Awaited<ReturnType<MapeoProjectApi['$getProjectSettings']>>>, 'data' | 'error' | 'isRefetching'>;
32
23
  /**
33
24
  * Retrieve a project API instance for a project.
34
25
  *
@@ -43,13 +34,9 @@ export declare function useProjectSettings({ projectId }: {
43
34
  * }
44
35
  * ```
45
36
  */
46
- export declare function useSingleProject({ projectId }: {
37
+ export declare function useSingleProject({ projectId, }: {
47
38
  projectId: string;
48
- }): {
49
- data: MapeoProjectApi;
50
- error: Error | null;
51
- isRefetching: boolean;
52
- };
39
+ }): Pick<UseSuspenseQueryResult<MapeoProjectApi>, 'data' | 'error' | 'isRefetching'>;
53
40
  /**
54
41
  * Retrieve project information for each project that exists.
55
42
  *
@@ -62,11 +49,7 @@ export declare function useSingleProject({ projectId }: {
62
49
  * }
63
50
  * ```
64
51
  */
65
- export declare function useManyProjects(): {
66
- data: import("@comapeo/core/dist/mapeo-manager.js", { with: { "resolution-mode": "import" } }).ListedProject[];
67
- error: Error | null;
68
- isRefetching: boolean;
69
- };
52
+ export declare function useManyProjects(): Pick<UseSuspenseQueryResult<Awaited<ReturnType<MapeoClientApi['listProjects']>>>, 'data' | 'error' | 'isRefetching'>;
70
53
  /**
71
54
  * Retrieve a single member of a project.
72
55
  *
@@ -85,11 +68,7 @@ export declare function useManyProjects(): {
85
68
  export declare function useSingleMember({ projectId, deviceId, }: {
86
69
  projectId: string;
87
70
  deviceId: string;
88
- }): {
89
- data: import("@comapeo/core/dist/member-api.js", { with: { "resolution-mode": "import" } }).MemberInfo;
90
- error: Error | null;
91
- isRefetching: boolean;
92
- };
71
+ }): Pick<UseSuspenseQueryResult<Awaited<ReturnType<MapeoProjectApi['$member']['getById']>>>, 'data' | 'error' | 'isRefetching'>;
93
72
  /**
94
73
  * Retrieve all members of a project.
95
74
  *
@@ -98,19 +77,17 @@ export declare function useSingleMember({ projectId, deviceId, }: {
98
77
  * @example
99
78
  * ```tsx
100
79
  * function BasicExample() {
101
- * const { data } = useManyMembers({ projectId: '...' })
80
+ * const activeMembers1 = useManyMembers({ projectId: '...' })
81
+ * const activeMembers2 = useManyMembers({ projectId: '...', includeLeft: false })
102
82
  *
103
- * console.log(data.role)
83
+ * const allMembers = useManyMembers({ projectId: '...', includeLeft: true })
104
84
  * }
105
85
  * ```
106
86
  */
107
- export declare function useManyMembers({ projectId }: {
87
+ export declare function useManyMembers<T extends boolean>({ projectId, includeLeft, }: {
108
88
  projectId: string;
109
- }): {
110
- data: import("@comapeo/core/dist/member-api.js", { with: { "resolution-mode": "import" } }).MemberInfo[];
111
- error: Error | null;
112
- isRefetching: boolean;
113
- };
89
+ includeLeft?: T;
90
+ }): Pick<UseSuspenseQueryResult<T extends true ? Array<MemberApi.MemberInfo> : Array<MemberApi.ActiveMemberInfo>>, 'data' | 'error' | 'isRefetching'>;
114
91
  /**
115
92
  * Retrieve a URL that points to icon resources served by the embedded HTTP server.
116
93
  *
@@ -254,129 +231,243 @@ export declare function useDocumentCreatedBy({ projectId, originalVersionId, }:
254
231
  * }
255
232
  * ```
256
233
  */
257
- export declare function useOwnRoleInProject({ projectId }: {
234
+ export declare function useOwnRoleInProject({ projectId, }: {
258
235
  projectId: string;
259
- }): {
260
- data: import("@comapeo/core/dist/roles.js", { with: { "resolution-mode": "import" } }).Role & {
261
- reason: string | undefined;
262
- };
263
- error: Error | null;
264
- isRefetching: boolean;
265
- };
236
+ }): Pick<UseSuspenseQueryResult<Awaited<ReturnType<MapeoProjectApi['$getOwnRole']>>>, 'data' | 'error' | 'isRefetching'>;
266
237
  export declare function useAddServerPeer({ projectId }: {
267
238
  projectId: string;
268
- }): {
269
- error: Error;
239
+ }): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<void, Error, {
240
+ baseUrl: string;
241
+ dangerouslyAllowInsecureConnections?: boolean;
242
+ }, unknown>, {
270
243
  mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
271
244
  baseUrl: string;
272
245
  dangerouslyAllowInsecureConnections?: boolean;
273
246
  }, unknown>;
247
+ }> & {
274
248
  mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
275
249
  baseUrl: string;
276
250
  dangerouslyAllowInsecureConnections?: boolean;
277
251
  }, unknown>;
278
- reset: () => void;
279
- status: "error";
280
- } | {
281
- error: null;
252
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<void, Error, {
253
+ baseUrl: string;
254
+ dangerouslyAllowInsecureConnections?: boolean;
255
+ }, unknown>, {
282
256
  mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
283
257
  baseUrl: string;
284
258
  dangerouslyAllowInsecureConnections?: boolean;
285
259
  }, unknown>;
260
+ }> & {
286
261
  mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
287
262
  baseUrl: string;
288
263
  dangerouslyAllowInsecureConnections?: boolean;
289
264
  }, unknown>;
290
- reset: () => void;
291
- status: "pending" | "success" | "idle";
292
- };
265
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<void, Error, {
266
+ baseUrl: string;
267
+ dangerouslyAllowInsecureConnections?: boolean;
268
+ }, unknown>, {
269
+ mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
270
+ baseUrl: string;
271
+ dangerouslyAllowInsecureConnections?: boolean;
272
+ }, unknown>;
273
+ }> & {
274
+ mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
275
+ baseUrl: string;
276
+ dangerouslyAllowInsecureConnections?: boolean;
277
+ }, unknown>;
278
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<void, Error, {
279
+ baseUrl: string;
280
+ dangerouslyAllowInsecureConnections?: boolean;
281
+ }, unknown>, {
282
+ mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
283
+ baseUrl: string;
284
+ dangerouslyAllowInsecureConnections?: boolean;
285
+ }, unknown>;
286
+ }> & {
287
+ mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
288
+ baseUrl: string;
289
+ dangerouslyAllowInsecureConnections?: boolean;
290
+ }, unknown>;
291
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync">;
293
292
  export declare function useRemoveServerPeer({ projectId }: {
294
293
  projectId: string;
295
- }): {
296
- error: Error;
294
+ }): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<void, Error, {
295
+ serverDeviceId: string;
296
+ dangerouslyAllowInsecureConnections?: boolean;
297
+ }, unknown>, {
297
298
  mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
298
299
  serverDeviceId: string;
299
300
  dangerouslyAllowInsecureConnections?: boolean;
300
301
  }, unknown>;
302
+ }> & {
301
303
  mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
302
304
  serverDeviceId: string;
303
305
  dangerouslyAllowInsecureConnections?: boolean;
304
306
  }, unknown>;
305
- reset: () => void;
306
- status: "error";
307
- } | {
308
- error: null;
307
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<void, Error, {
308
+ serverDeviceId: string;
309
+ dangerouslyAllowInsecureConnections?: boolean;
310
+ }, unknown>, {
309
311
  mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
310
312
  serverDeviceId: string;
311
313
  dangerouslyAllowInsecureConnections?: boolean;
312
314
  }, unknown>;
315
+ }> & {
313
316
  mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
314
317
  serverDeviceId: string;
315
318
  dangerouslyAllowInsecureConnections?: boolean;
316
319
  }, unknown>;
317
- reset: () => void;
318
- status: "pending" | "success" | "idle";
319
- };
320
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<void, Error, {
321
+ serverDeviceId: string;
322
+ dangerouslyAllowInsecureConnections?: boolean;
323
+ }, unknown>, {
324
+ mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
325
+ serverDeviceId: string;
326
+ dangerouslyAllowInsecureConnections?: boolean;
327
+ }, unknown>;
328
+ }> & {
329
+ mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
330
+ serverDeviceId: string;
331
+ dangerouslyAllowInsecureConnections?: boolean;
332
+ }, unknown>;
333
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<void, Error, {
334
+ serverDeviceId: string;
335
+ dangerouslyAllowInsecureConnections?: boolean;
336
+ }, unknown>, {
337
+ mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
338
+ serverDeviceId: string;
339
+ dangerouslyAllowInsecureConnections?: boolean;
340
+ }, unknown>;
341
+ }> & {
342
+ mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
343
+ serverDeviceId: string;
344
+ dangerouslyAllowInsecureConnections?: boolean;
345
+ }, unknown>;
346
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync">;
320
347
  /**
321
348
  * Create a new project.
322
349
  */
323
- export declare function useCreateProject(): {
324
- error: Error;
350
+ export declare function useCreateProject(): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<string, Error, {
351
+ name?: string;
352
+ configPath?: string;
353
+ projectColor?: string;
354
+ projectDescription?: string;
355
+ } | undefined, unknown>, {
325
356
  mutate: import("@tanstack/react-query").UseMutateFunction<string, Error, {
326
357
  name?: string;
327
358
  configPath?: string;
328
359
  projectColor?: string;
329
360
  projectDescription?: string;
330
361
  } | undefined, unknown>;
362
+ }> & {
331
363
  mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<string, Error, {
332
364
  name?: string;
333
365
  configPath?: string;
334
366
  projectColor?: string;
335
367
  projectDescription?: string;
336
368
  } | undefined, unknown>;
337
- reset: () => void;
338
- status: "error";
339
- } | {
340
- error: null;
369
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<string, Error, {
370
+ name?: string;
371
+ configPath?: string;
372
+ projectColor?: string;
373
+ projectDescription?: string;
374
+ } | undefined, unknown>, {
341
375
  mutate: import("@tanstack/react-query").UseMutateFunction<string, Error, {
342
376
  name?: string;
343
377
  configPath?: string;
344
378
  projectColor?: string;
345
379
  projectDescription?: string;
346
380
  } | undefined, unknown>;
381
+ }> & {
347
382
  mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<string, Error, {
348
383
  name?: string;
349
384
  configPath?: string;
350
385
  projectColor?: string;
351
386
  projectDescription?: string;
352
387
  } | undefined, unknown>;
353
- reset: () => void;
354
- status: "pending" | "success" | "idle";
355
- };
388
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<string, Error, {
389
+ name?: string;
390
+ configPath?: string;
391
+ projectColor?: string;
392
+ projectDescription?: string;
393
+ } | undefined, unknown>, {
394
+ mutate: import("@tanstack/react-query").UseMutateFunction<string, Error, {
395
+ name?: string;
396
+ configPath?: string;
397
+ projectColor?: string;
398
+ projectDescription?: string;
399
+ } | undefined, unknown>;
400
+ }> & {
401
+ mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<string, Error, {
402
+ name?: string;
403
+ configPath?: string;
404
+ projectColor?: string;
405
+ projectDescription?: string;
406
+ } | undefined, unknown>;
407
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<string, Error, {
408
+ name?: string;
409
+ configPath?: string;
410
+ projectColor?: string;
411
+ projectDescription?: string;
412
+ } | undefined, unknown>, {
413
+ mutate: import("@tanstack/react-query").UseMutateFunction<string, Error, {
414
+ name?: string;
415
+ configPath?: string;
416
+ projectColor?: string;
417
+ projectDescription?: string;
418
+ } | undefined, unknown>;
419
+ }> & {
420
+ mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<string, Error, {
421
+ name?: string;
422
+ configPath?: string;
423
+ projectColor?: string;
424
+ projectDescription?: string;
425
+ } | undefined, unknown>;
426
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync">;
356
427
  /**
357
428
  * Leave an existing project.
358
429
  */
359
- export declare function useLeaveProject(): {
360
- error: Error;
430
+ export declare function useLeaveProject(): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<void, Error, {
431
+ projectId: string;
432
+ }, unknown>, {
361
433
  mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
362
434
  projectId: string;
363
435
  }, unknown>;
436
+ }> & {
364
437
  mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
365
438
  projectId: string;
366
439
  }, unknown>;
367
- reset: () => void;
368
- status: "error";
369
- } | {
370
- error: null;
440
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<void, Error, {
441
+ projectId: string;
442
+ }, unknown>, {
371
443
  mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
372
444
  projectId: string;
373
445
  }, unknown>;
446
+ }> & {
374
447
  mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
375
448
  projectId: string;
376
449
  }, unknown>;
377
- reset: () => void;
378
- status: "pending" | "success" | "idle";
379
- };
450
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<void, Error, {
451
+ projectId: string;
452
+ }, unknown>, {
453
+ mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
454
+ projectId: string;
455
+ }, unknown>;
456
+ }> & {
457
+ mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
458
+ projectId: string;
459
+ }, unknown>;
460
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<void, Error, {
461
+ projectId: string;
462
+ }, unknown>, {
463
+ mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
464
+ projectId: string;
465
+ }, unknown>;
466
+ }> & {
467
+ mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
468
+ projectId: string;
469
+ }, unknown>;
470
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync">;
380
471
  /**
381
472
  * Update the categories of a project using an external file.
382
473
  *
@@ -384,27 +475,47 @@ export declare function useLeaveProject(): {
384
475
  */
385
476
  export declare function useImportProjectCategories({ projectId, }: {
386
477
  projectId: string;
387
- }): {
388
- error: Error;
478
+ }): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<void, Error, {
479
+ filePath: string;
480
+ }, unknown>, {
389
481
  mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
390
482
  filePath: string;
391
483
  }, unknown>;
484
+ }> & {
392
485
  mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
393
486
  filePath: string;
394
487
  }, unknown>;
395
- reset: () => void;
396
- status: "error";
397
- } | {
398
- error: null;
488
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<void, Error, {
489
+ filePath: string;
490
+ }, unknown>, {
399
491
  mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
400
492
  filePath: string;
401
493
  }, unknown>;
494
+ }> & {
402
495
  mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
403
496
  filePath: string;
404
497
  }, unknown>;
405
- reset: () => void;
406
- status: "pending" | "success" | "idle";
407
- };
498
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<void, Error, {
499
+ filePath: string;
500
+ }, unknown>, {
501
+ mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
502
+ filePath: string;
503
+ }, unknown>;
504
+ }> & {
505
+ mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
506
+ filePath: string;
507
+ }, unknown>;
508
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<void, Error, {
509
+ filePath: string;
510
+ }, unknown>, {
511
+ mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
512
+ filePath: string;
513
+ }, unknown>;
514
+ }> & {
515
+ mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
516
+ filePath: string;
517
+ }, unknown>;
518
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync">;
408
519
  /**
409
520
  * Update the configuration of a project using an external file.
410
521
  *
@@ -413,47 +524,55 @@ export declare function useImportProjectCategories({ projectId, }: {
413
524
  */
414
525
  export declare function useImportProjectConfig({ projectId }: {
415
526
  projectId: string;
416
- }): {
417
- error: Error;
527
+ }): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<Error[], Error, {
528
+ configPath: string;
529
+ }, unknown>, {
418
530
  mutate: import("@tanstack/react-query").UseMutateFunction<Error[], Error, {
419
531
  configPath: string;
420
532
  }, unknown>;
533
+ }> & {
421
534
  mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Error[], Error, {
422
535
  configPath: string;
423
536
  }, unknown>;
424
- reset: () => void;
425
- status: "error";
426
- } | {
427
- error: null;
537
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<Error[], Error, {
538
+ configPath: string;
539
+ }, unknown>, {
428
540
  mutate: import("@tanstack/react-query").UseMutateFunction<Error[], Error, {
429
541
  configPath: string;
430
542
  }, unknown>;
543
+ }> & {
431
544
  mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Error[], Error, {
432
545
  configPath: string;
433
546
  }, unknown>;
434
- reset: () => void;
435
- status: "pending" | "success" | "idle";
436
- };
547
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<Error[], Error, {
548
+ configPath: string;
549
+ }, unknown>, {
550
+ mutate: import("@tanstack/react-query").UseMutateFunction<Error[], Error, {
551
+ configPath: string;
552
+ }, unknown>;
553
+ }> & {
554
+ mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Error[], Error, {
555
+ configPath: string;
556
+ }, unknown>;
557
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<Error[], Error, {
558
+ configPath: string;
559
+ }, unknown>, {
560
+ mutate: import("@tanstack/react-query").UseMutateFunction<Error[], Error, {
561
+ configPath: string;
562
+ }, unknown>;
563
+ }> & {
564
+ mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Error[], Error, {
565
+ configPath: string;
566
+ }, unknown>;
567
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync">;
437
568
  /**
438
569
  * Update the settings of a project.
439
570
  *
440
571
  * @param opts.projectId Public ID of the project to apply changes to.
441
572
  */
442
- export declare function useUpdateProjectSettings({ projectId }: {
573
+ export declare function useUpdateProjectSettings({ projectId, }: {
443
574
  projectId: string;
444
- }): {
445
- error: Error;
446
- mutate: import("@tanstack/react-query").UseMutateFunction<import("@comapeo/core/dist/mapeo-project.js", { with: { "resolution-mode": "import" } }).EditableProjectSettings, Error, Partial<import("@comapeo/core/dist/mapeo-project.js", { with: { "resolution-mode": "import" } }).EditableProjectSettings>, unknown>;
447
- mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<import("@comapeo/core/dist/mapeo-project.js", { with: { "resolution-mode": "import" } }).EditableProjectSettings, Error, Partial<import("@comapeo/core/dist/mapeo-project.js", { with: { "resolution-mode": "import" } }).EditableProjectSettings>, unknown>;
448
- reset: () => void;
449
- status: "error";
450
- } | {
451
- error: null;
452
- mutate: import("@tanstack/react-query").UseMutateFunction<import("@comapeo/core/dist/mapeo-project.js", { with: { "resolution-mode": "import" } }).EditableProjectSettings, Error, Partial<import("@comapeo/core/dist/mapeo-project.js", { with: { "resolution-mode": "import" } }).EditableProjectSettings>, unknown>;
453
- mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<import("@comapeo/core/dist/mapeo-project.js", { with: { "resolution-mode": "import" } }).EditableProjectSettings, Error, Partial<import("@comapeo/core/dist/mapeo-project.js", { with: { "resolution-mode": "import" } }).EditableProjectSettings>, unknown>;
454
- reset: () => void;
455
- status: "pending" | "success" | "idle";
456
- };
575
+ }): FilteredMutationResult<UseMutationResult<EditableProjectSettings, Error, Partial<EditableProjectSettings>>>;
457
576
  /**
458
577
  * Change a project member's role.
459
578
  *
@@ -470,31 +589,59 @@ export declare function useUpdateProjectSettings({ projectId }: {
470
589
  */
471
590
  export declare function useChangeMemberRole({ projectId }: {
472
591
  projectId: string;
473
- }): {
474
- error: Error;
592
+ }): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<void, Error, {
593
+ deviceId: string;
594
+ roleId: MemberApi.RoleIdAssignableToOthers;
595
+ }, unknown>, {
475
596
  mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
476
597
  deviceId: string;
477
- roleId: import("@comapeo/core", { with: { "resolution-mode": "import" } }).MemberApi.RoleIdAssignableToOthers;
598
+ roleId: MemberApi.RoleIdAssignableToOthers;
478
599
  }, unknown>;
600
+ }> & {
479
601
  mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
480
602
  deviceId: string;
481
- roleId: import("@comapeo/core", { with: { "resolution-mode": "import" } }).MemberApi.RoleIdAssignableToOthers;
603
+ roleId: MemberApi.RoleIdAssignableToOthers;
482
604
  }, unknown>;
483
- reset: () => void;
484
- status: "error";
485
- } | {
486
- error: null;
605
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<void, Error, {
606
+ deviceId: string;
607
+ roleId: MemberApi.RoleIdAssignableToOthers;
608
+ }, unknown>, {
487
609
  mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
488
610
  deviceId: string;
489
- roleId: import("@comapeo/core", { with: { "resolution-mode": "import" } }).MemberApi.RoleIdAssignableToOthers;
611
+ roleId: MemberApi.RoleIdAssignableToOthers;
490
612
  }, unknown>;
613
+ }> & {
491
614
  mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
492
615
  deviceId: string;
493
- roleId: import("@comapeo/core", { with: { "resolution-mode": "import" } }).MemberApi.RoleIdAssignableToOthers;
616
+ roleId: MemberApi.RoleIdAssignableToOthers;
494
617
  }, unknown>;
495
- reset: () => void;
496
- status: "pending" | "success" | "idle";
497
- };
618
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<void, Error, {
619
+ deviceId: string;
620
+ roleId: MemberApi.RoleIdAssignableToOthers;
621
+ }, unknown>, {
622
+ mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
623
+ deviceId: string;
624
+ roleId: MemberApi.RoleIdAssignableToOthers;
625
+ }, unknown>;
626
+ }> & {
627
+ mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
628
+ deviceId: string;
629
+ roleId: MemberApi.RoleIdAssignableToOthers;
630
+ }, unknown>;
631
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<void, Error, {
632
+ deviceId: string;
633
+ roleId: MemberApi.RoleIdAssignableToOthers;
634
+ }, unknown>, {
635
+ mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
636
+ deviceId: string;
637
+ roleId: MemberApi.RoleIdAssignableToOthers;
638
+ }, unknown>;
639
+ }> & {
640
+ mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
641
+ deviceId: string;
642
+ roleId: MemberApi.RoleIdAssignableToOthers;
643
+ }, unknown>;
644
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync">;
498
645
  /**
499
646
  * Remove a member from a project, providing an optional reason for removal.
500
647
  *
@@ -516,61 +663,93 @@ export declare function useChangeMemberRole({ projectId }: {
516
663
  */
517
664
  export declare function useRemoveMember({ projectId }: {
518
665
  projectId: string;
519
- }): {
520
- error: Error;
666
+ }): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<void, Error, {
667
+ deviceId: string;
668
+ reason?: string;
669
+ }, unknown>, {
670
+ mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
671
+ deviceId: string;
672
+ reason?: string;
673
+ }, unknown>;
674
+ }> & {
675
+ mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
676
+ deviceId: string;
677
+ reason?: string;
678
+ }, unknown>;
679
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<void, Error, {
680
+ deviceId: string;
681
+ reason?: string;
682
+ }, unknown>, {
521
683
  mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
522
684
  deviceId: string;
523
685
  reason?: string;
524
686
  }, unknown>;
687
+ }> & {
525
688
  mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
526
689
  deviceId: string;
527
690
  reason?: string;
528
691
  }, unknown>;
529
- reset: () => void;
530
- status: "error";
531
- } | {
532
- error: null;
692
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<void, Error, {
693
+ deviceId: string;
694
+ reason?: string;
695
+ }, unknown>, {
533
696
  mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
534
697
  deviceId: string;
535
698
  reason?: string;
536
699
  }, unknown>;
700
+ }> & {
537
701
  mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
538
702
  deviceId: string;
539
703
  reason?: string;
540
704
  }, unknown>;
541
- reset: () => void;
542
- status: "pending" | "success" | "idle";
543
- };
705
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<void, Error, {
706
+ deviceId: string;
707
+ reason?: string;
708
+ }, unknown>, {
709
+ mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
710
+ deviceId: string;
711
+ reason?: string;
712
+ }, unknown>;
713
+ }> & {
714
+ mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
715
+ deviceId: string;
716
+ reason?: string;
717
+ }, unknown>;
718
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync">;
544
719
  /**
545
720
  * Set up listener for changes to your own role in a project.
546
721
  * It is necessary to use this if you want the project role-related read hooks to update
547
722
  * based on role change events that are received in the background.
548
723
  *
549
- * @param opts.listener Optional listener to invoke when role changes
724
+ *
550
725
  *
551
726
  * @example
552
727
  * ```tsx
553
- * function SomeComponent({ projectId }: { projectId: string }) {
728
+ * function ListenerComponent({ projectId }: { projectId: string }) {
729
+ * // Set up the listener
554
730
  * useProjectOwnRoleChangeListener({ projectId })
555
731
  * }
556
- * ```
557
732
  *
558
- * @example
559
- * ```tsx
560
- * function ComponentWithListener({ projectId }: { projectId: string }) {
561
- * useProjectOwnRoleChangeListener({
562
- * projectId,
563
- * listener: (event) => {
564
- * // Handle role change, e.g., navigate to default project
565
- * console.log('New role:', event.role)
733
+ * // Handle role change events separately
734
+ * function EventHandlerComponent() {
735
+ * const { data: projectApi } = useSingleProject({ projectId })
736
+ *
737
+ * useEffect(() => {
738
+ * function handleRoleChangeEvent(event) {
739
+ * // Do something with event...
566
740
  * }
567
- * })
741
+ *
742
+ * projectApi.addListener('own-role-change', handleRoleChangeEvent)
743
+ *
744
+ * return () => {
745
+ * projectApi.removeListener('own-role-change', handleRoleChangeEvent)
746
+ * }
747
+ * }, [projectApi])
568
748
  * }
569
749
  * ```
570
750
  */
571
- export declare function useProjectOwnRoleChangeListener({ projectId, listener, }: {
751
+ export declare function useProjectOwnRoleChangeListener({ projectId, }: {
572
752
  projectId: string;
573
- listener?: (event: RoleChangeEvent) => void;
574
753
  }): void;
575
754
  /**
576
755
  * Create a blob for a project.
@@ -579,8 +758,17 @@ export declare function useProjectOwnRoleChangeListener({ projectId, listener, }
579
758
  */
580
759
  export declare function useCreateBlob({ projectId }: {
581
760
  projectId: string;
582
- }): {
583
- error: Error;
761
+ }): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<{
762
+ driveId: string;
763
+ name: string;
764
+ type: "photo" | "video" | "audio";
765
+ hash: string;
766
+ }, Error, {
767
+ original: string;
768
+ preview?: string;
769
+ thumbnail?: string;
770
+ metadata: BlobApi.Metadata;
771
+ }, unknown>, {
584
772
  mutate: import("@tanstack/react-query").UseMutateFunction<{
585
773
  driveId: string;
586
774
  name: string;
@@ -592,6 +780,7 @@ export declare function useCreateBlob({ projectId }: {
592
780
  thumbnail?: string;
593
781
  metadata: BlobApi.Metadata;
594
782
  }, unknown>;
783
+ }> & {
595
784
  mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<{
596
785
  driveId: string;
597
786
  name: string;
@@ -603,10 +792,17 @@ export declare function useCreateBlob({ projectId }: {
603
792
  thumbnail?: string;
604
793
  metadata: BlobApi.Metadata;
605
794
  }, unknown>;
606
- reset: () => void;
607
- status: "error";
608
- } | {
609
- error: null;
795
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<{
796
+ driveId: string;
797
+ name: string;
798
+ type: "photo" | "video" | "audio";
799
+ hash: string;
800
+ }, Error, {
801
+ original: string;
802
+ preview?: string;
803
+ thumbnail?: string;
804
+ metadata: BlobApi.Metadata;
805
+ }, unknown>, {
610
806
  mutate: import("@tanstack/react-query").UseMutateFunction<{
611
807
  driveId: string;
612
808
  name: string;
@@ -618,6 +814,7 @@ export declare function useCreateBlob({ projectId }: {
618
814
  thumbnail?: string;
619
815
  metadata: BlobApi.Metadata;
620
816
  }, unknown>;
817
+ }> & {
621
818
  mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<{
622
819
  driveId: string;
623
820
  name: string;
@@ -629,9 +826,75 @@ export declare function useCreateBlob({ projectId }: {
629
826
  thumbnail?: string;
630
827
  metadata: BlobApi.Metadata;
631
828
  }, unknown>;
632
- reset: () => void;
633
- status: "pending" | "success" | "idle";
634
- };
829
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<{
830
+ driveId: string;
831
+ name: string;
832
+ type: "photo" | "video" | "audio";
833
+ hash: string;
834
+ }, Error, {
835
+ original: string;
836
+ preview?: string;
837
+ thumbnail?: string;
838
+ metadata: BlobApi.Metadata;
839
+ }, unknown>, {
840
+ mutate: import("@tanstack/react-query").UseMutateFunction<{
841
+ driveId: string;
842
+ name: string;
843
+ type: "photo" | "video" | "audio";
844
+ hash: string;
845
+ }, Error, {
846
+ original: string;
847
+ preview?: string;
848
+ thumbnail?: string;
849
+ metadata: BlobApi.Metadata;
850
+ }, unknown>;
851
+ }> & {
852
+ mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<{
853
+ driveId: string;
854
+ name: string;
855
+ type: "photo" | "video" | "audio";
856
+ hash: string;
857
+ }, Error, {
858
+ original: string;
859
+ preview?: string;
860
+ thumbnail?: string;
861
+ metadata: BlobApi.Metadata;
862
+ }, unknown>;
863
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<{
864
+ driveId: string;
865
+ name: string;
866
+ type: "photo" | "video" | "audio";
867
+ hash: string;
868
+ }, Error, {
869
+ original: string;
870
+ preview?: string;
871
+ thumbnail?: string;
872
+ metadata: BlobApi.Metadata;
873
+ }, unknown>, {
874
+ mutate: import("@tanstack/react-query").UseMutateFunction<{
875
+ driveId: string;
876
+ name: string;
877
+ type: "photo" | "video" | "audio";
878
+ hash: string;
879
+ }, Error, {
880
+ original: string;
881
+ preview?: string;
882
+ thumbnail?: string;
883
+ metadata: BlobApi.Metadata;
884
+ }, unknown>;
885
+ }> & {
886
+ mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<{
887
+ driveId: string;
888
+ name: string;
889
+ type: "photo" | "video" | "audio";
890
+ hash: string;
891
+ }, Error, {
892
+ original: string;
893
+ preview?: string;
894
+ thumbnail?: string;
895
+ metadata: BlobApi.Metadata;
896
+ }, unknown>;
897
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync">;
635
898
  /**
636
899
  * Hook to subscribe to the current sync state.
637
900
  *
@@ -667,95 +930,147 @@ export declare function useDataSyncProgress({ projectId, }: {
667
930
  }): number | null;
668
931
  export declare function useStartSync({ projectId }: {
669
932
  projectId: string;
670
- }): {
671
- error: Error;
933
+ }): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<void, Error, {
934
+ autostopDataSyncAfter: number | null;
935
+ } | undefined, unknown>, {
672
936
  mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
673
937
  autostopDataSyncAfter: number | null;
674
938
  } | undefined, unknown>;
939
+ }> & {
675
940
  mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
676
941
  autostopDataSyncAfter: number | null;
677
942
  } | undefined, unknown>;
678
- reset: () => void;
679
- status: "error";
680
- } | {
681
- error: null;
943
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<void, Error, {
944
+ autostopDataSyncAfter: number | null;
945
+ } | undefined, unknown>, {
682
946
  mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
683
947
  autostopDataSyncAfter: number | null;
684
948
  } | undefined, unknown>;
949
+ }> & {
685
950
  mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
686
951
  autostopDataSyncAfter: number | null;
687
952
  } | undefined, unknown>;
688
- reset: () => void;
689
- status: "pending" | "success" | "idle";
690
- };
953
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<void, Error, {
954
+ autostopDataSyncAfter: number | null;
955
+ } | undefined, unknown>, {
956
+ mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
957
+ autostopDataSyncAfter: number | null;
958
+ } | undefined, unknown>;
959
+ }> & {
960
+ mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
961
+ autostopDataSyncAfter: number | null;
962
+ } | undefined, unknown>;
963
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<void, Error, {
964
+ autostopDataSyncAfter: number | null;
965
+ } | undefined, unknown>, {
966
+ mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
967
+ autostopDataSyncAfter: number | null;
968
+ } | undefined, unknown>;
969
+ }> & {
970
+ mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
971
+ autostopDataSyncAfter: number | null;
972
+ } | undefined, unknown>;
973
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync">;
691
974
  export declare function useStopSync({ projectId }: {
692
975
  projectId: string;
693
- }): {
694
- error: Error;
976
+ }): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<void, Error, void, unknown>, {
695
977
  mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, void, unknown>;
978
+ }> & {
696
979
  mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, void, unknown>;
697
- reset: () => void;
698
- status: "error";
699
- } | {
700
- error: null;
980
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<void, Error, void, unknown>, {
701
981
  mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, void, unknown>;
982
+ }> & {
702
983
  mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, void, unknown>;
703
- reset: () => void;
704
- status: "pending" | "success" | "idle";
705
- };
984
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<void, Error, void, unknown>, {
985
+ mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, void, unknown>;
986
+ }> & {
987
+ mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, void, unknown>;
988
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<void, Error, void, unknown>, {
989
+ mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, void, unknown>;
990
+ }> & {
991
+ mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, void, unknown>;
992
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync">;
706
993
  export declare function useConnectSyncServers({ projectId }: {
707
994
  projectId: string;
708
- }): {
709
- error: Error;
995
+ }): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<void, Error, void, unknown>, {
710
996
  mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, void, unknown>;
997
+ }> & {
711
998
  mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, void, unknown>;
712
- reset: () => void;
713
- status: "error";
714
- } | {
715
- error: null;
999
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<void, Error, void, unknown>, {
716
1000
  mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, void, unknown>;
1001
+ }> & {
717
1002
  mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, void, unknown>;
718
- reset: () => void;
719
- status: "pending" | "success" | "idle";
720
- };
1003
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<void, Error, void, unknown>, {
1004
+ mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, void, unknown>;
1005
+ }> & {
1006
+ mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, void, unknown>;
1007
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<void, Error, void, unknown>, {
1008
+ mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, void, unknown>;
1009
+ }> & {
1010
+ mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, void, unknown>;
1011
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync">;
721
1012
  export declare function useDisconnectSyncServers({ projectId }: {
722
1013
  projectId: string;
723
- }): {
724
- error: Error;
1014
+ }): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<void, Error, void, unknown>, {
725
1015
  mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, void, unknown>;
1016
+ }> & {
726
1017
  mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, void, unknown>;
727
- reset: () => void;
728
- status: "error";
729
- } | {
730
- error: null;
1018
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<void, Error, void, unknown>, {
731
1019
  mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, void, unknown>;
1020
+ }> & {
732
1021
  mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, void, unknown>;
733
- reset: () => void;
734
- status: "pending" | "success" | "idle";
735
- };
1022
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<void, Error, void, unknown>, {
1023
+ mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, void, unknown>;
1024
+ }> & {
1025
+ mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, void, unknown>;
1026
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<void, Error, void, unknown>, {
1027
+ mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, void, unknown>;
1028
+ }> & {
1029
+ mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, void, unknown>;
1030
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync">;
736
1031
  export declare function useSetAutostopDataSyncTimeout({ projectId, }: {
737
1032
  projectId: string;
738
- }): {
739
- error: Error;
1033
+ }): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<void, Error, {
1034
+ after: number | null;
1035
+ }, unknown>, {
740
1036
  mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
741
1037
  after: number | null;
742
1038
  }, unknown>;
1039
+ }> & {
743
1040
  mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
744
1041
  after: number | null;
745
1042
  }, unknown>;
746
- reset: () => void;
747
- status: "error";
748
- } | {
749
- error: null;
1043
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<void, Error, {
1044
+ after: number | null;
1045
+ }, unknown>, {
750
1046
  mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
751
1047
  after: number | null;
752
1048
  }, unknown>;
1049
+ }> & {
753
1050
  mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
754
1051
  after: number | null;
755
1052
  }, unknown>;
756
- reset: () => void;
757
- status: "pending" | "success" | "idle";
758
- };
1053
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<void, Error, {
1054
+ after: number | null;
1055
+ }, unknown>, {
1056
+ mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
1057
+ after: number | null;
1058
+ }, unknown>;
1059
+ }> & {
1060
+ mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
1061
+ after: number | null;
1062
+ }, unknown>;
1063
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<void, Error, {
1064
+ after: number | null;
1065
+ }, unknown>, {
1066
+ mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
1067
+ after: number | null;
1068
+ }, unknown>;
1069
+ }> & {
1070
+ mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
1071
+ after: number | null;
1072
+ }, unknown>;
1073
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync">;
759
1074
  /**
760
1075
  * Creates a GeoJson file with all the observations and/or tracks in the project.
761
1076
  *
@@ -763,8 +1078,14 @@ export declare function useSetAutostopDataSyncTimeout({ projectId, }: {
763
1078
  */
764
1079
  export declare function useExportGeoJSON({ projectId }: {
765
1080
  projectId: string;
766
- }): {
767
- error: Error;
1081
+ }): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<string, Error, {
1082
+ path: string;
1083
+ exportOptions: {
1084
+ observations?: boolean;
1085
+ tracks?: boolean;
1086
+ lang?: string;
1087
+ };
1088
+ }, unknown>, {
768
1089
  mutate: import("@tanstack/react-query").UseMutateFunction<string, Error, {
769
1090
  path: string;
770
1091
  exportOptions: {
@@ -773,6 +1094,7 @@ export declare function useExportGeoJSON({ projectId }: {
773
1094
  lang?: string;
774
1095
  };
775
1096
  }, unknown>;
1097
+ }> & {
776
1098
  mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<string, Error, {
777
1099
  path: string;
778
1100
  exportOptions: {
@@ -781,10 +1103,14 @@ export declare function useExportGeoJSON({ projectId }: {
781
1103
  lang?: string;
782
1104
  };
783
1105
  }, unknown>;
784
- reset: () => void;
785
- status: "error";
786
- } | {
787
- error: null;
1106
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<string, Error, {
1107
+ path: string;
1108
+ exportOptions: {
1109
+ observations?: boolean;
1110
+ tracks?: boolean;
1111
+ lang?: string;
1112
+ };
1113
+ }, unknown>, {
788
1114
  mutate: import("@tanstack/react-query").UseMutateFunction<string, Error, {
789
1115
  path: string;
790
1116
  exportOptions: {
@@ -793,6 +1119,7 @@ export declare function useExportGeoJSON({ projectId }: {
793
1119
  lang?: string;
794
1120
  };
795
1121
  }, unknown>;
1122
+ }> & {
796
1123
  mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<string, Error, {
797
1124
  path: string;
798
1125
  exportOptions: {
@@ -801,9 +1128,57 @@ export declare function useExportGeoJSON({ projectId }: {
801
1128
  lang?: string;
802
1129
  };
803
1130
  }, unknown>;
804
- reset: () => void;
805
- status: "pending" | "success" | "idle";
806
- };
1131
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<string, Error, {
1132
+ path: string;
1133
+ exportOptions: {
1134
+ observations?: boolean;
1135
+ tracks?: boolean;
1136
+ lang?: string;
1137
+ };
1138
+ }, unknown>, {
1139
+ mutate: import("@tanstack/react-query").UseMutateFunction<string, Error, {
1140
+ path: string;
1141
+ exportOptions: {
1142
+ observations?: boolean;
1143
+ tracks?: boolean;
1144
+ lang?: string;
1145
+ };
1146
+ }, unknown>;
1147
+ }> & {
1148
+ mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<string, Error, {
1149
+ path: string;
1150
+ exportOptions: {
1151
+ observations?: boolean;
1152
+ tracks?: boolean;
1153
+ lang?: string;
1154
+ };
1155
+ }, unknown>;
1156
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<string, Error, {
1157
+ path: string;
1158
+ exportOptions: {
1159
+ observations?: boolean;
1160
+ tracks?: boolean;
1161
+ lang?: string;
1162
+ };
1163
+ }, unknown>, {
1164
+ mutate: import("@tanstack/react-query").UseMutateFunction<string, Error, {
1165
+ path: string;
1166
+ exportOptions: {
1167
+ observations?: boolean;
1168
+ tracks?: boolean;
1169
+ lang?: string;
1170
+ };
1171
+ }, unknown>;
1172
+ }> & {
1173
+ mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<string, Error, {
1174
+ path: string;
1175
+ exportOptions: {
1176
+ observations?: boolean;
1177
+ tracks?: boolean;
1178
+ lang?: string;
1179
+ };
1180
+ }, unknown>;
1181
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync">;
807
1182
  /**
808
1183
  * Creates a zip file containing a GeoJson file with all the observations and/or tracks in the project and all associated attachments (photos and audio).
809
1184
  *
@@ -811,8 +1186,15 @@ export declare function useExportGeoJSON({ projectId }: {
811
1186
  */
812
1187
  export declare function useExportZipFile({ projectId }: {
813
1188
  projectId: string;
814
- }): {
815
- error: Error;
1189
+ }): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<string, Error, {
1190
+ path: string;
1191
+ exportOptions: {
1192
+ observations?: boolean;
1193
+ tracks?: boolean;
1194
+ lang?: string;
1195
+ attachments?: boolean;
1196
+ };
1197
+ }, unknown>, {
816
1198
  mutate: import("@tanstack/react-query").UseMutateFunction<string, Error, {
817
1199
  path: string;
818
1200
  exportOptions: {
@@ -822,6 +1204,7 @@ export declare function useExportZipFile({ projectId }: {
822
1204
  attachments?: boolean;
823
1205
  };
824
1206
  }, unknown>;
1207
+ }> & {
825
1208
  mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<string, Error, {
826
1209
  path: string;
827
1210
  exportOptions: {
@@ -831,10 +1214,15 @@ export declare function useExportZipFile({ projectId }: {
831
1214
  attachments?: boolean;
832
1215
  };
833
1216
  }, unknown>;
834
- reset: () => void;
835
- status: "error";
836
- } | {
837
- error: null;
1217
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<string, Error, {
1218
+ path: string;
1219
+ exportOptions: {
1220
+ observations?: boolean;
1221
+ tracks?: boolean;
1222
+ lang?: string;
1223
+ attachments?: boolean;
1224
+ };
1225
+ }, unknown>, {
838
1226
  mutate: import("@tanstack/react-query").UseMutateFunction<string, Error, {
839
1227
  path: string;
840
1228
  exportOptions: {
@@ -844,6 +1232,7 @@ export declare function useExportZipFile({ projectId }: {
844
1232
  attachments?: boolean;
845
1233
  };
846
1234
  }, unknown>;
1235
+ }> & {
847
1236
  mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<string, Error, {
848
1237
  path: string;
849
1238
  exportOptions: {
@@ -853,6 +1242,60 @@ export declare function useExportZipFile({ projectId }: {
853
1242
  attachments?: boolean;
854
1243
  };
855
1244
  }, unknown>;
856
- reset: () => void;
857
- status: "pending" | "success" | "idle";
858
- };
1245
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<string, Error, {
1246
+ path: string;
1247
+ exportOptions: {
1248
+ observations?: boolean;
1249
+ tracks?: boolean;
1250
+ lang?: string;
1251
+ attachments?: boolean;
1252
+ };
1253
+ }, unknown>, {
1254
+ mutate: import("@tanstack/react-query").UseMutateFunction<string, Error, {
1255
+ path: string;
1256
+ exportOptions: {
1257
+ observations?: boolean;
1258
+ tracks?: boolean;
1259
+ lang?: string;
1260
+ attachments?: boolean;
1261
+ };
1262
+ }, unknown>;
1263
+ }> & {
1264
+ mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<string, Error, {
1265
+ path: string;
1266
+ exportOptions: {
1267
+ observations?: boolean;
1268
+ tracks?: boolean;
1269
+ lang?: string;
1270
+ attachments?: boolean;
1271
+ };
1272
+ }, unknown>;
1273
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<string, Error, {
1274
+ path: string;
1275
+ exportOptions: {
1276
+ observations?: boolean;
1277
+ tracks?: boolean;
1278
+ lang?: string;
1279
+ attachments?: boolean;
1280
+ };
1281
+ }, unknown>, {
1282
+ mutate: import("@tanstack/react-query").UseMutateFunction<string, Error, {
1283
+ path: string;
1284
+ exportOptions: {
1285
+ observations?: boolean;
1286
+ tracks?: boolean;
1287
+ lang?: string;
1288
+ attachments?: boolean;
1289
+ };
1290
+ }, unknown>;
1291
+ }> & {
1292
+ mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<string, Error, {
1293
+ path: string;
1294
+ exportOptions: {
1295
+ observations?: boolean;
1296
+ tracks?: boolean;
1297
+ lang?: string;
1298
+ attachments?: boolean;
1299
+ };
1300
+ }, unknown>;
1301
+ }, "error" | "status" | "mutate" | "reset" | "mutateAsync">;