@comapeo/core-react 9.0.2 → 10.0.1
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.
- package/README.md +1 -1
- package/dist/commonjs/contexts/ClientApi.d.ts +1 -3
- package/dist/commonjs/contexts/ClientApi.js +2 -2
- package/dist/commonjs/hooks/client.d.ts +74 -33
- package/dist/commonjs/hooks/client.js +40 -11
- package/dist/commonjs/hooks/documents.d.ts +42 -429
- package/dist/commonjs/hooks/documents.js +100 -51
- package/dist/commonjs/hooks/invites.d.ts +153 -55
- package/dist/commonjs/hooks/invites.js +69 -20
- package/dist/commonjs/hooks/maps.d.ts +96 -225
- package/dist/commonjs/hooks/maps.js +104 -37
- package/dist/commonjs/hooks/projects.d.ts +666 -223
- package/dist/commonjs/hooks/projects.js +264 -131
- package/dist/commonjs/index.d.ts +2 -2
- package/dist/commonjs/lib/map-shares-stores.d.ts +1 -1
- package/dist/commonjs/lib/map-shares-stores.js +2 -2
- package/dist/commonjs/lib/presets.d.ts +1 -3
- package/dist/commonjs/lib/react-query.d.ts +103 -0
- package/dist/commonjs/lib/react-query.js +187 -0
- package/dist/commonjs/lib/sync.d.ts +2 -5
- package/dist/commonjs/lib/sync.js +0 -1
- package/dist/commonjs/lib/types.d.ts +4 -6
- package/dist/esm/contexts/ClientApi.d.ts +1 -3
- package/dist/esm/contexts/ClientApi.js +1 -1
- package/dist/esm/hooks/client.d.ts +74 -33
- package/dist/esm/hooks/client.js +40 -11
- package/dist/esm/hooks/documents.d.ts +42 -429
- package/dist/esm/hooks/documents.js +100 -51
- package/dist/esm/hooks/invites.d.ts +153 -55
- package/dist/esm/hooks/invites.js +69 -20
- package/dist/esm/hooks/maps.d.ts +96 -225
- package/dist/esm/hooks/maps.js +105 -38
- package/dist/esm/hooks/projects.d.ts +666 -223
- package/dist/esm/hooks/projects.js +262 -129
- package/dist/esm/index.d.ts +2 -2
- package/dist/esm/lib/map-shares-stores.d.ts +1 -1
- package/dist/esm/lib/map-shares-stores.js +1 -1
- package/dist/esm/lib/presets.d.ts +1 -3
- package/dist/esm/lib/react-query.d.ts +103 -0
- package/dist/esm/lib/react-query.js +162 -0
- package/dist/esm/lib/sync.d.ts +2 -5
- package/dist/esm/lib/sync.js +1 -1
- package/dist/esm/lib/types.d.ts +4 -6
- package/docs/API.md +137 -81
- package/package.json +39 -35
- package/dist/commonjs/lib/react-query/client.d.ts +0 -65
- package/dist/commonjs/lib/react-query/client.js +0 -68
- package/dist/commonjs/lib/react-query/documents.d.ts +0 -1484
- package/dist/commonjs/lib/react-query/documents.js +0 -149
- package/dist/commonjs/lib/react-query/invites.d.ts +0 -88
- package/dist/commonjs/lib/react-query/invites.js +0 -95
- package/dist/commonjs/lib/react-query/maps.d.ts +0 -104
- package/dist/commonjs/lib/react-query/maps.js +0 -129
- package/dist/commonjs/lib/react-query/mutation-result.d.ts +0 -8
- package/dist/commonjs/lib/react-query/mutation-result.js +0 -22
- package/dist/commonjs/lib/react-query/projects.d.ts +0 -316
- package/dist/commonjs/lib/react-query/projects.js +0 -359
- package/dist/commonjs/lib/react-query/shared.d.ts +0 -9
- package/dist/commonjs/lib/react-query/shared.js +0 -23
- package/dist/esm/lib/react-query/client.d.ts +0 -65
- package/dist/esm/lib/react-query/client.js +0 -59
- package/dist/esm/lib/react-query/documents.d.ts +0 -1484
- package/dist/esm/lib/react-query/documents.js +0 -137
- package/dist/esm/lib/react-query/invites.d.ts +0 -88
- package/dist/esm/lib/react-query/invites.js +0 -85
- package/dist/esm/lib/react-query/maps.d.ts +0 -104
- package/dist/esm/lib/react-query/maps.js +0 -119
- package/dist/esm/lib/react-query/mutation-result.d.ts +0 -8
- package/dist/esm/lib/react-query/mutation-result.js +0 -19
- package/dist/esm/lib/react-query/projects.d.ts +0 -316
- package/dist/esm/lib/react-query/projects.js +0 -324
- package/dist/esm/lib/react-query/shared.d.ts +0 -9
- package/dist/esm/lib/react-query/shared.js +0 -18
package/dist/esm/hooks/maps.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import type { AbortMapShareOptions, CancelMapShareOptions, CreateAndSendMapShareOptions, DeclineMapShareOptions, DownloadMapShareOptions, ReceivedMapShareState, SentMapShareState } from '../lib/map-shares-stores.js';
|
|
2
2
|
/**
|
|
3
3
|
* Get a URL that points to a StyleJSON resource served by the embedded HTTP server.
|
|
4
4
|
*
|
|
@@ -30,6 +30,10 @@ export declare function useMapStyleUrl(): {
|
|
|
30
30
|
error: Error | null;
|
|
31
31
|
isRefetching: boolean;
|
|
32
32
|
};
|
|
33
|
+
type CompatFile = Omit<File, 'lastModified' | 'webkitRelativePath'>;
|
|
34
|
+
type ExpoFileDuckType = CompatFile & {
|
|
35
|
+
exists: boolean;
|
|
36
|
+
};
|
|
33
37
|
/**
|
|
34
38
|
* Import a custom SMP map file, replacing any existing custom map. The mutation
|
|
35
39
|
* resolves once the file is successfully uploaded and processed by the server.
|
|
@@ -43,176 +47,44 @@ export declare function useMapStyleUrl(): {
|
|
|
43
47
|
* ```
|
|
44
48
|
*/
|
|
45
49
|
export declare function useImportCustomMapFile(): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<Response, Error, {
|
|
46
|
-
file: File |
|
|
47
|
-
readonly name: string;
|
|
48
|
-
slice: (start?: number, end?: number, contentType?: string) => Blob;
|
|
49
|
-
readonly type: string;
|
|
50
|
-
text: () => Promise<string>;
|
|
51
|
-
readonly size: number;
|
|
52
|
-
arrayBuffer: () => Promise<ArrayBuffer>;
|
|
53
|
-
bytes: () => Promise<Uint8Array<ArrayBuffer>>;
|
|
54
|
-
stream: () => ReadableStream<Uint8Array<ArrayBuffer>>;
|
|
55
|
-
} & {
|
|
56
|
-
exists: boolean;
|
|
57
|
-
});
|
|
50
|
+
file: File | ExpoFileDuckType;
|
|
58
51
|
}, unknown>, {
|
|
59
52
|
mutate: import("@tanstack/react-query").UseMutateFunction<Response, Error, {
|
|
60
|
-
file: File |
|
|
61
|
-
readonly name: string;
|
|
62
|
-
slice: (start?: number, end?: number, contentType?: string) => Blob;
|
|
63
|
-
readonly type: string;
|
|
64
|
-
text: () => Promise<string>;
|
|
65
|
-
readonly size: number;
|
|
66
|
-
arrayBuffer: () => Promise<ArrayBuffer>;
|
|
67
|
-
bytes: () => Promise<Uint8Array<ArrayBuffer>>;
|
|
68
|
-
stream: () => ReadableStream<Uint8Array<ArrayBuffer>>;
|
|
69
|
-
} & {
|
|
70
|
-
exists: boolean;
|
|
71
|
-
});
|
|
53
|
+
file: File | ExpoFileDuckType;
|
|
72
54
|
}, unknown>;
|
|
73
55
|
}> & {
|
|
74
56
|
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Response, Error, {
|
|
75
|
-
file: File |
|
|
76
|
-
readonly name: string;
|
|
77
|
-
slice: (start?: number, end?: number, contentType?: string) => Blob;
|
|
78
|
-
readonly type: string;
|
|
79
|
-
text: () => Promise<string>;
|
|
80
|
-
readonly size: number;
|
|
81
|
-
arrayBuffer: () => Promise<ArrayBuffer>;
|
|
82
|
-
bytes: () => Promise<Uint8Array<ArrayBuffer>>;
|
|
83
|
-
stream: () => ReadableStream<Uint8Array<ArrayBuffer>>;
|
|
84
|
-
} & {
|
|
85
|
-
exists: boolean;
|
|
86
|
-
});
|
|
57
|
+
file: File | ExpoFileDuckType;
|
|
87
58
|
}, unknown>;
|
|
88
59
|
}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<Response, Error, {
|
|
89
|
-
file: File |
|
|
90
|
-
readonly name: string;
|
|
91
|
-
slice: (start?: number, end?: number, contentType?: string) => Blob;
|
|
92
|
-
readonly type: string;
|
|
93
|
-
text: () => Promise<string>;
|
|
94
|
-
readonly size: number;
|
|
95
|
-
arrayBuffer: () => Promise<ArrayBuffer>;
|
|
96
|
-
bytes: () => Promise<Uint8Array<ArrayBuffer>>;
|
|
97
|
-
stream: () => ReadableStream<Uint8Array<ArrayBuffer>>;
|
|
98
|
-
} & {
|
|
99
|
-
exists: boolean;
|
|
100
|
-
});
|
|
60
|
+
file: File | ExpoFileDuckType;
|
|
101
61
|
}, unknown>, {
|
|
102
62
|
mutate: import("@tanstack/react-query").UseMutateFunction<Response, Error, {
|
|
103
|
-
file: File |
|
|
104
|
-
readonly name: string;
|
|
105
|
-
slice: (start?: number, end?: number, contentType?: string) => Blob;
|
|
106
|
-
readonly type: string;
|
|
107
|
-
text: () => Promise<string>;
|
|
108
|
-
readonly size: number;
|
|
109
|
-
arrayBuffer: () => Promise<ArrayBuffer>;
|
|
110
|
-
bytes: () => Promise<Uint8Array<ArrayBuffer>>;
|
|
111
|
-
stream: () => ReadableStream<Uint8Array<ArrayBuffer>>;
|
|
112
|
-
} & {
|
|
113
|
-
exists: boolean;
|
|
114
|
-
});
|
|
63
|
+
file: File | ExpoFileDuckType;
|
|
115
64
|
}, unknown>;
|
|
116
65
|
}> & {
|
|
117
66
|
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Response, Error, {
|
|
118
|
-
file: File |
|
|
119
|
-
readonly name: string;
|
|
120
|
-
slice: (start?: number, end?: number, contentType?: string) => Blob;
|
|
121
|
-
readonly type: string;
|
|
122
|
-
text: () => Promise<string>;
|
|
123
|
-
readonly size: number;
|
|
124
|
-
arrayBuffer: () => Promise<ArrayBuffer>;
|
|
125
|
-
bytes: () => Promise<Uint8Array<ArrayBuffer>>;
|
|
126
|
-
stream: () => ReadableStream<Uint8Array<ArrayBuffer>>;
|
|
127
|
-
} & {
|
|
128
|
-
exists: boolean;
|
|
129
|
-
});
|
|
67
|
+
file: File | ExpoFileDuckType;
|
|
130
68
|
}, unknown>;
|
|
131
69
|
}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<Response, Error, {
|
|
132
|
-
file: File |
|
|
133
|
-
readonly name: string;
|
|
134
|
-
slice: (start?: number, end?: number, contentType?: string) => Blob;
|
|
135
|
-
readonly type: string;
|
|
136
|
-
text: () => Promise<string>;
|
|
137
|
-
readonly size: number;
|
|
138
|
-
arrayBuffer: () => Promise<ArrayBuffer>;
|
|
139
|
-
bytes: () => Promise<Uint8Array<ArrayBuffer>>;
|
|
140
|
-
stream: () => ReadableStream<Uint8Array<ArrayBuffer>>;
|
|
141
|
-
} & {
|
|
142
|
-
exists: boolean;
|
|
143
|
-
});
|
|
70
|
+
file: File | ExpoFileDuckType;
|
|
144
71
|
}, unknown>, {
|
|
145
72
|
mutate: import("@tanstack/react-query").UseMutateFunction<Response, Error, {
|
|
146
|
-
file: File |
|
|
147
|
-
readonly name: string;
|
|
148
|
-
slice: (start?: number, end?: number, contentType?: string) => Blob;
|
|
149
|
-
readonly type: string;
|
|
150
|
-
text: () => Promise<string>;
|
|
151
|
-
readonly size: number;
|
|
152
|
-
arrayBuffer: () => Promise<ArrayBuffer>;
|
|
153
|
-
bytes: () => Promise<Uint8Array<ArrayBuffer>>;
|
|
154
|
-
stream: () => ReadableStream<Uint8Array<ArrayBuffer>>;
|
|
155
|
-
} & {
|
|
156
|
-
exists: boolean;
|
|
157
|
-
});
|
|
73
|
+
file: File | ExpoFileDuckType;
|
|
158
74
|
}, unknown>;
|
|
159
75
|
}> & {
|
|
160
76
|
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Response, Error, {
|
|
161
|
-
file: File |
|
|
162
|
-
readonly name: string;
|
|
163
|
-
slice: (start?: number, end?: number, contentType?: string) => Blob;
|
|
164
|
-
readonly type: string;
|
|
165
|
-
text: () => Promise<string>;
|
|
166
|
-
readonly size: number;
|
|
167
|
-
arrayBuffer: () => Promise<ArrayBuffer>;
|
|
168
|
-
bytes: () => Promise<Uint8Array<ArrayBuffer>>;
|
|
169
|
-
stream: () => ReadableStream<Uint8Array<ArrayBuffer>>;
|
|
170
|
-
} & {
|
|
171
|
-
exists: boolean;
|
|
172
|
-
});
|
|
77
|
+
file: File | ExpoFileDuckType;
|
|
173
78
|
}, unknown>;
|
|
174
79
|
}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<Response, Error, {
|
|
175
|
-
file: File |
|
|
176
|
-
readonly name: string;
|
|
177
|
-
slice: (start?: number, end?: number, contentType?: string) => Blob;
|
|
178
|
-
readonly type: string;
|
|
179
|
-
text: () => Promise<string>;
|
|
180
|
-
readonly size: number;
|
|
181
|
-
arrayBuffer: () => Promise<ArrayBuffer>;
|
|
182
|
-
bytes: () => Promise<Uint8Array<ArrayBuffer>>;
|
|
183
|
-
stream: () => ReadableStream<Uint8Array<ArrayBuffer>>;
|
|
184
|
-
} & {
|
|
185
|
-
exists: boolean;
|
|
186
|
-
});
|
|
80
|
+
file: File | ExpoFileDuckType;
|
|
187
81
|
}, unknown>, {
|
|
188
82
|
mutate: import("@tanstack/react-query").UseMutateFunction<Response, Error, {
|
|
189
|
-
file: File |
|
|
190
|
-
readonly name: string;
|
|
191
|
-
slice: (start?: number, end?: number, contentType?: string) => Blob;
|
|
192
|
-
readonly type: string;
|
|
193
|
-
text: () => Promise<string>;
|
|
194
|
-
readonly size: number;
|
|
195
|
-
arrayBuffer: () => Promise<ArrayBuffer>;
|
|
196
|
-
bytes: () => Promise<Uint8Array<ArrayBuffer>>;
|
|
197
|
-
stream: () => ReadableStream<Uint8Array<ArrayBuffer>>;
|
|
198
|
-
} & {
|
|
199
|
-
exists: boolean;
|
|
200
|
-
});
|
|
83
|
+
file: File | ExpoFileDuckType;
|
|
201
84
|
}, unknown>;
|
|
202
85
|
}> & {
|
|
203
86
|
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Response, Error, {
|
|
204
|
-
file: File |
|
|
205
|
-
readonly name: string;
|
|
206
|
-
slice: (start?: number, end?: number, contentType?: string) => Blob;
|
|
207
|
-
readonly type: string;
|
|
208
|
-
text: () => Promise<string>;
|
|
209
|
-
readonly size: number;
|
|
210
|
-
arrayBuffer: () => Promise<ArrayBuffer>;
|
|
211
|
-
bytes: () => Promise<Uint8Array<ArrayBuffer>>;
|
|
212
|
-
stream: () => ReadableStream<Uint8Array<ArrayBuffer>>;
|
|
213
|
-
} & {
|
|
214
|
-
exists: boolean;
|
|
215
|
-
});
|
|
87
|
+
file: File | ExpoFileDuckType;
|
|
216
88
|
}, unknown>;
|
|
217
89
|
}, "error" | "status" | "mutate" | "reset" | "mutateAsync">;
|
|
218
90
|
export declare function useRemoveCustomMapFile(): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<Response, Error, void, unknown>, {
|
|
@@ -234,13 +106,9 @@ export declare function useRemoveCustomMapFile(): Pick<import("@tanstack/react-q
|
|
|
234
106
|
}, "error" | "status" | "mutate" | "reset" | "mutateAsync">;
|
|
235
107
|
export declare function useGetCustomMapInfo(): {
|
|
236
108
|
data: {
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
bounds: readonly [number, number, number, number];
|
|
241
|
-
minzoom: number;
|
|
242
|
-
maxzoom: number;
|
|
243
|
-
mapCreatedAt: number;
|
|
109
|
+
name: string;
|
|
110
|
+
size: number;
|
|
111
|
+
created: number;
|
|
244
112
|
} | undefined;
|
|
245
113
|
error: Error | null;
|
|
246
114
|
isRefetching: boolean;
|
|
@@ -302,22 +170,22 @@ export declare function useSingleReceivedMapShare({ shareId }: {
|
|
|
302
170
|
* }
|
|
303
171
|
* ```
|
|
304
172
|
*/
|
|
305
|
-
export declare function useDownloadReceivedMapShare(): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<
|
|
306
|
-
mutate: import("@tanstack/react-query").UseMutateFunction<
|
|
173
|
+
export declare function useDownloadReceivedMapShare(): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<void, Error, DownloadMapShareOptions, unknown>, {
|
|
174
|
+
mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, DownloadMapShareOptions, unknown>;
|
|
307
175
|
}> & {
|
|
308
|
-
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<
|
|
309
|
-
}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<
|
|
310
|
-
mutate: import("@tanstack/react-query").UseMutateFunction<
|
|
176
|
+
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, DownloadMapShareOptions, unknown>;
|
|
177
|
+
}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<void, Error, DownloadMapShareOptions, unknown>, {
|
|
178
|
+
mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, DownloadMapShareOptions, unknown>;
|
|
311
179
|
}> & {
|
|
312
|
-
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<
|
|
313
|
-
}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<
|
|
314
|
-
mutate: import("@tanstack/react-query").UseMutateFunction<
|
|
180
|
+
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, DownloadMapShareOptions, unknown>;
|
|
181
|
+
}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<void, Error, DownloadMapShareOptions, unknown>, {
|
|
182
|
+
mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, DownloadMapShareOptions, unknown>;
|
|
315
183
|
}> & {
|
|
316
|
-
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<
|
|
317
|
-
}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<
|
|
318
|
-
mutate: import("@tanstack/react-query").UseMutateFunction<
|
|
184
|
+
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, DownloadMapShareOptions, unknown>;
|
|
185
|
+
}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<void, Error, DownloadMapShareOptions, unknown>, {
|
|
186
|
+
mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, DownloadMapShareOptions, unknown>;
|
|
319
187
|
}> & {
|
|
320
|
-
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<
|
|
188
|
+
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, DownloadMapShareOptions, unknown>;
|
|
321
189
|
}, "error" | "status" | "mutate" | "reset" | "mutateAsync">;
|
|
322
190
|
/**
|
|
323
191
|
* Decline a map share that has been received. Notifies the sender that the
|
|
@@ -341,22 +209,22 @@ export declare function useDownloadReceivedMapShare(): Pick<import("@tanstack/re
|
|
|
341
209
|
* }
|
|
342
210
|
* ```
|
|
343
211
|
*/
|
|
344
|
-
export declare function useDeclineReceivedMapShare(): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<
|
|
345
|
-
mutate: import("@tanstack/react-query").UseMutateFunction<
|
|
212
|
+
export declare function useDeclineReceivedMapShare(): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<void, Error, DeclineMapShareOptions, unknown>, {
|
|
213
|
+
mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, DeclineMapShareOptions, unknown>;
|
|
346
214
|
}> & {
|
|
347
|
-
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<
|
|
348
|
-
}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<
|
|
349
|
-
mutate: import("@tanstack/react-query").UseMutateFunction<
|
|
215
|
+
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, DeclineMapShareOptions, unknown>;
|
|
216
|
+
}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<void, Error, DeclineMapShareOptions, unknown>, {
|
|
217
|
+
mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, DeclineMapShareOptions, unknown>;
|
|
350
218
|
}> & {
|
|
351
|
-
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<
|
|
352
|
-
}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<
|
|
353
|
-
mutate: import("@tanstack/react-query").UseMutateFunction<
|
|
219
|
+
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, DeclineMapShareOptions, unknown>;
|
|
220
|
+
}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<void, Error, DeclineMapShareOptions, unknown>, {
|
|
221
|
+
mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, DeclineMapShareOptions, unknown>;
|
|
354
222
|
}> & {
|
|
355
|
-
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<
|
|
356
|
-
}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<
|
|
357
|
-
mutate: import("@tanstack/react-query").UseMutateFunction<
|
|
223
|
+
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, DeclineMapShareOptions, unknown>;
|
|
224
|
+
}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<void, Error, DeclineMapShareOptions, unknown>, {
|
|
225
|
+
mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, DeclineMapShareOptions, unknown>;
|
|
358
226
|
}> & {
|
|
359
|
-
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<
|
|
227
|
+
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, DeclineMapShareOptions, unknown>;
|
|
360
228
|
}, "error" | "status" | "mutate" | "reset" | "mutateAsync">;
|
|
361
229
|
/**
|
|
362
230
|
* Abort an in-progress map share download.
|
|
@@ -373,22 +241,22 @@ export declare function useDeclineReceivedMapShare(): Pick<import("@tanstack/rea
|
|
|
373
241
|
* }
|
|
374
242
|
* ```
|
|
375
243
|
*/
|
|
376
|
-
export declare function useAbortReceivedMapShareDownload(): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<
|
|
377
|
-
mutate: import("@tanstack/react-query").UseMutateFunction<
|
|
244
|
+
export declare function useAbortReceivedMapShareDownload(): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<void, Error, AbortMapShareOptions, unknown>, {
|
|
245
|
+
mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, AbortMapShareOptions, unknown>;
|
|
378
246
|
}> & {
|
|
379
|
-
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<
|
|
380
|
-
}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<
|
|
381
|
-
mutate: import("@tanstack/react-query").UseMutateFunction<
|
|
247
|
+
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, AbortMapShareOptions, unknown>;
|
|
248
|
+
}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<void, Error, AbortMapShareOptions, unknown>, {
|
|
249
|
+
mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, AbortMapShareOptions, unknown>;
|
|
382
250
|
}> & {
|
|
383
|
-
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<
|
|
384
|
-
}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<
|
|
385
|
-
mutate: import("@tanstack/react-query").UseMutateFunction<
|
|
251
|
+
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, AbortMapShareOptions, unknown>;
|
|
252
|
+
}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<void, Error, AbortMapShareOptions, unknown>, {
|
|
253
|
+
mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, AbortMapShareOptions, unknown>;
|
|
386
254
|
}> & {
|
|
387
|
-
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<
|
|
388
|
-
}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<
|
|
389
|
-
mutate: import("@tanstack/react-query").UseMutateFunction<
|
|
255
|
+
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, AbortMapShareOptions, unknown>;
|
|
256
|
+
}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<void, Error, AbortMapShareOptions, unknown>, {
|
|
257
|
+
mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, AbortMapShareOptions, unknown>;
|
|
390
258
|
}> & {
|
|
391
|
-
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<
|
|
259
|
+
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, AbortMapShareOptions, unknown>;
|
|
392
260
|
}, "error" | "status" | "mutate" | "reset" | "mutateAsync">;
|
|
393
261
|
/**
|
|
394
262
|
* Share a map with a device. The mutation resolves immediately after sending
|
|
@@ -401,38 +269,40 @@ export declare function useAbortReceivedMapShareDownload(): Pick<import("@tansta
|
|
|
401
269
|
* @example
|
|
402
270
|
* ```tsx
|
|
403
271
|
* function SendMapButton({ projectId, deviceId }: { projectId: string; deviceId: string }) {
|
|
404
|
-
*
|
|
405
|
-
*
|
|
406
|
-
*
|
|
407
|
-
*
|
|
408
|
-
*
|
|
409
|
-
*
|
|
410
|
-
*
|
|
411
|
-
*
|
|
412
|
-
*
|
|
413
|
-
*
|
|
414
|
-
*
|
|
272
|
+
* const { mutate: send } = useSendMapShare()
|
|
273
|
+
*
|
|
274
|
+
* return (
|
|
275
|
+
* <button
|
|
276
|
+
* onClick={() =>
|
|
277
|
+
* send({ projectId, receiverDeviceId: deviceId, mapId: 'custom' }, {
|
|
278
|
+
* onSuccess: (mapShare) => {
|
|
279
|
+
* console.log('Share sent with id', mapShare.shareId)
|
|
280
|
+
* }
|
|
281
|
+
* )
|
|
282
|
+
* }
|
|
283
|
+
* >
|
|
284
|
+
* Send Map
|
|
285
|
+
* </button>
|
|
286
|
+
* )
|
|
415
287
|
* }
|
|
416
288
|
* ```
|
|
417
289
|
*/
|
|
418
|
-
export declare function useSendMapShare(
|
|
419
|
-
|
|
420
|
-
}): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<Promise<import("@comapeo/map-server").MapShareState>, Error, import("../lib/map-shares-stores.js").CreateAndSendMapShareOptions, unknown>, {
|
|
421
|
-
mutate: import("@tanstack/react-query").UseMutateFunction<Promise<import("@comapeo/map-server").MapShareState>, Error, import("../lib/map-shares-stores.js").CreateAndSendMapShareOptions, unknown>;
|
|
290
|
+
export declare function useSendMapShare(): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<import("@comapeo/map-server").MapShareState, Error, CreateAndSendMapShareOptions, unknown>, {
|
|
291
|
+
mutate: import("@tanstack/react-query").UseMutateFunction<import("@comapeo/map-server").MapShareState, Error, CreateAndSendMapShareOptions, unknown>;
|
|
422
292
|
}> & {
|
|
423
|
-
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<
|
|
424
|
-
}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<
|
|
425
|
-
mutate: import("@tanstack/react-query").UseMutateFunction<
|
|
293
|
+
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<import("@comapeo/map-server").MapShareState, Error, CreateAndSendMapShareOptions, unknown>;
|
|
294
|
+
}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<import("@comapeo/map-server").MapShareState, Error, CreateAndSendMapShareOptions, unknown>, {
|
|
295
|
+
mutate: import("@tanstack/react-query").UseMutateFunction<import("@comapeo/map-server").MapShareState, Error, CreateAndSendMapShareOptions, unknown>;
|
|
426
296
|
}> & {
|
|
427
|
-
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<
|
|
428
|
-
}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<
|
|
429
|
-
mutate: import("@tanstack/react-query").UseMutateFunction<
|
|
297
|
+
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<import("@comapeo/map-server").MapShareState, Error, CreateAndSendMapShareOptions, unknown>;
|
|
298
|
+
}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<import("@comapeo/map-server").MapShareState, Error, CreateAndSendMapShareOptions, unknown>, {
|
|
299
|
+
mutate: import("@tanstack/react-query").UseMutateFunction<import("@comapeo/map-server").MapShareState, Error, CreateAndSendMapShareOptions, unknown>;
|
|
430
300
|
}> & {
|
|
431
|
-
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<
|
|
432
|
-
}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<
|
|
433
|
-
mutate: import("@tanstack/react-query").UseMutateFunction<
|
|
301
|
+
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<import("@comapeo/map-server").MapShareState, Error, CreateAndSendMapShareOptions, unknown>;
|
|
302
|
+
}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<import("@comapeo/map-server").MapShareState, Error, CreateAndSendMapShareOptions, unknown>, {
|
|
303
|
+
mutate: import("@tanstack/react-query").UseMutateFunction<import("@comapeo/map-server").MapShareState, Error, CreateAndSendMapShareOptions, unknown>;
|
|
434
304
|
}> & {
|
|
435
|
-
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<
|
|
305
|
+
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<import("@comapeo/map-server").MapShareState, Error, CreateAndSendMapShareOptions, unknown>;
|
|
436
306
|
}, "error" | "status" | "mutate" | "reset" | "mutateAsync">;
|
|
437
307
|
/**
|
|
438
308
|
* Cancel a map share that was previously sent. If the recipient has not yet
|
|
@@ -452,22 +322,22 @@ export declare function useSendMapShare({ projectId }: {
|
|
|
452
322
|
* }
|
|
453
323
|
* ```
|
|
454
324
|
*/
|
|
455
|
-
export declare function useCancelSentMapShare(): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<
|
|
456
|
-
mutate: import("@tanstack/react-query").UseMutateFunction<
|
|
325
|
+
export declare function useCancelSentMapShare(): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<void, Error, CancelMapShareOptions, unknown>, {
|
|
326
|
+
mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, CancelMapShareOptions, unknown>;
|
|
457
327
|
}> & {
|
|
458
|
-
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<
|
|
459
|
-
}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<
|
|
460
|
-
mutate: import("@tanstack/react-query").UseMutateFunction<
|
|
328
|
+
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, CancelMapShareOptions, unknown>;
|
|
329
|
+
}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<void, Error, CancelMapShareOptions, unknown>, {
|
|
330
|
+
mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, CancelMapShareOptions, unknown>;
|
|
461
331
|
}> & {
|
|
462
|
-
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<
|
|
463
|
-
}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<
|
|
464
|
-
mutate: import("@tanstack/react-query").UseMutateFunction<
|
|
332
|
+
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, CancelMapShareOptions, unknown>;
|
|
333
|
+
}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<void, Error, CancelMapShareOptions, unknown>, {
|
|
334
|
+
mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, CancelMapShareOptions, unknown>;
|
|
465
335
|
}> & {
|
|
466
|
-
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<
|
|
467
|
-
}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<
|
|
468
|
-
mutate: import("@tanstack/react-query").UseMutateFunction<
|
|
336
|
+
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, CancelMapShareOptions, unknown>;
|
|
337
|
+
}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<void, Error, CancelMapShareOptions, unknown>, {
|
|
338
|
+
mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, CancelMapShareOptions, unknown>;
|
|
469
339
|
}> & {
|
|
470
|
-
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<
|
|
340
|
+
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, CancelMapShareOptions, unknown>;
|
|
471
341
|
}, "error" | "status" | "mutate" | "reset" | "mutateAsync">;
|
|
472
342
|
/**
|
|
473
343
|
* Track the status and progress of a sent map share. Returns the current state
|
|
@@ -496,3 +366,4 @@ export declare function useCancelSentMapShare(): Pick<import("@tanstack/react-qu
|
|
|
496
366
|
export declare function useSingleSentMapShare({ shareId, }: {
|
|
497
367
|
shareId: string;
|
|
498
368
|
}): SentMapShareState;
|
|
369
|
+
export {};
|