@semapps/activitypub-components 1.1.3 → 1.2.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.
package/dist/index.d.ts CHANGED
@@ -1,257 +1,206 @@
1
- import { RefObject, MutableRefObject } from 'react';
2
- import {
3
- RefetchOptions,
4
- RefetchQueryFilters,
5
- InfiniteData,
6
- QueryObserverResult,
7
- FetchNextPageOptions,
8
- InfiniteQueryObserverResult
9
- } from 'react-query';
10
- import { Identifier } from 'react-admin';
11
- import { JSX } from 'react/jsx-runtime';
12
- export declare namespace ACTIVITY_TYPES {
13
- let ACCEPT: string;
14
- let ADD: string;
15
- let ANNOUNCE: string;
16
- let ARRIVE: string;
17
- let BLOCK: string;
18
- let CREATE: string;
19
- let DELETE: string;
20
- let DISLIKE: string;
21
- let FLAG: string;
22
- let FOLLOW: string;
23
- let IGNORE: string;
24
- let INVITE: string;
25
- let JOIN: string;
26
- let LEAVE: string;
27
- let LIKE: string;
28
- let LISTEN: string;
29
- let MOVE: string;
30
- let OFFER: string;
31
- let QUESTION: string;
32
- let REJECT: string;
33
- let READ: string;
34
- let REMOVE: string;
35
- let TENTATIVE_REJECT: string;
36
- let TENTATIVE_ACCEPT: string;
37
- let TRAVEL: string;
38
- let UNDO: string;
39
- let UPDATE: string;
40
- let VIEW: string;
41
- }
42
- export declare namespace ACTOR_TYPES {
43
- let APPLICATION: string;
44
- let GROUP: string;
45
- let ORGANIZATION: string;
46
- let PERSON: string;
47
- let SERVICE: string;
48
- }
49
- export declare namespace OBJECT_TYPES {
50
- let ARTICLE: string;
51
- let AUDIO: string;
52
- let DOCUMENT: string;
53
- let EVENT: string;
54
- let IMAGE: string;
55
- let NOTE: string;
56
- let PAGE: string;
57
- let PLACE: string;
58
- let PROFILE: string;
59
- let RELATIONSHIP: string;
60
- let TOMBSTONE: string;
61
- let VIDEO: string;
62
- }
63
- export const PUBLIC_URI: 'https://www.w3.org/ns/activitystreams#Public';
1
+ import { RefObject, MutableRefObject } from "react";
2
+ import { RefetchOptions, InfiniteData, QueryObserverResult, FetchNextPageOptions, InfiniteQueryObserverResult, FetchPreviousPageOptions, FetchStatus } from "@tanstack/react-query";
3
+ import { RefetchOptions as _RefetchOptions1, InfiniteData as _InfiniteData1, QueryObserverResult as _QueryObserverResult1, FetchNextPageOptions as _FetchNextPageOptions1, InfiniteQueryObserverResult as _InfiniteQueryObserverResult1 } from "@tanstack/query-core";
4
+ import { Identifier } from "react-admin";
5
+ import { JSX } from "react/jsx-runtime";
6
+ import { LdoBase, ShapeType } from "@ldo/ldo";
7
+ import { SolidConnectedPlugin } from "@ldo/connected-solid";
8
+ import { ConnectedLdoDataset } from "@ldo/connected";
9
+ import { OrderedCollectionPage } from "@activitypods/ldo-shapes";
10
+ export const ACTIVITY_TYPES: {
11
+ ACCEPT: string;
12
+ ADD: string;
13
+ ANNOUNCE: string;
14
+ ARRIVE: string;
15
+ BLOCK: string;
16
+ CREATE: string;
17
+ DELETE: string;
18
+ DISLIKE: string;
19
+ FLAG: string;
20
+ FOLLOW: string;
21
+ IGNORE: string;
22
+ INVITE: string;
23
+ JOIN: string;
24
+ LEAVE: string;
25
+ LIKE: string;
26
+ LISTEN: string;
27
+ MOVE: string;
28
+ OFFER: string;
29
+ QUESTION: string;
30
+ REJECT: string;
31
+ READ: string;
32
+ REMOVE: string;
33
+ TENTATIVE_REJECT: string;
34
+ TENTATIVE_ACCEPT: string;
35
+ TRAVEL: string;
36
+ UNDO: string;
37
+ UPDATE: string;
38
+ VIEW: string;
39
+ };
40
+ export const ACTOR_TYPES: {
41
+ APPLICATION: string;
42
+ GROUP: string;
43
+ ORGANIZATION: string;
44
+ PERSON: string;
45
+ SERVICE: string;
46
+ };
47
+ export const OBJECT_TYPES: {
48
+ ARTICLE: string;
49
+ AUDIO: string;
50
+ DOCUMENT: string;
51
+ EVENT: string;
52
+ IMAGE: string;
53
+ NOTE: string;
54
+ PAGE: string;
55
+ PLACE: string;
56
+ PROFILE: string;
57
+ RELATIONSHIP: string;
58
+ TOMBSTONE: string;
59
+ VIDEO: string;
60
+ };
61
+ export const PUBLIC_URI = "https://www.w3.org/ns/activitystreams#Public";
64
62
  interface UseCollectionOptions {
65
- dereferenceItems?: boolean;
66
- liveUpdates?: boolean;
67
- shaclShapeUri?: string;
63
+ dereferenceItems?: boolean;
64
+ liveUpdates?: boolean;
65
+ shaclShapeUri?: string;
68
66
  }
69
67
  interface AwaitActivityOptions {
70
- timeout?: number;
71
- checkExistingActivities?: boolean;
68
+ timeout?: number;
69
+ checkExistingActivities?: boolean;
72
70
  }
73
71
  /**
74
72
  * NodeInfo schema version 2.1.
75
73
  */
76
74
  interface NodeInfo {
77
- /**
78
- * The schema version, must be 2.1.
79
- */
80
- version: '2.1';
81
- /**
82
- * Metadata about server software in use.
83
- */
84
- software: {
85
- /**
86
- * The canonical name of this server software.
87
- */
88
- name: string;
89
75
  /**
90
- * The version of this server software.
76
+ * The schema version, must be 2.1.
91
77
  */
92
- version: string;
78
+ version: '2.1';
93
79
  /**
94
- * The url of the source code repository of this server software.
80
+ * Metadata about server software in use.
95
81
  */
96
- repository?: string;
82
+ software: {
83
+ /**
84
+ * The canonical name of this server software.
85
+ */
86
+ name: string;
87
+ /**
88
+ * The version of this server software.
89
+ */
90
+ version: string;
91
+ /**
92
+ * The url of the source code repository of this server software.
93
+ */
94
+ repository?: string;
95
+ /**
96
+ * The url of the homepage of this server software.
97
+ */
98
+ homepage?: string;
99
+ };
97
100
  /**
98
- * The url of the homepage of this server software.
101
+ * The protocols supported on this server.
99
102
  */
100
- homepage?: string;
101
- };
102
- /**
103
- * The protocols supported on this server.
104
- */
105
- protocols: [
106
- 'activitypub' | 'buddycloud' | 'dfrn' | 'diaspora' | 'libertree' | 'ostatus' | 'pumpio' | 'tent' | 'xmpp' | 'zot',
107
- ...(
108
- | 'activitypub'
109
- | 'buddycloud'
110
- | 'dfrn'
111
- | 'diaspora'
112
- | 'libertree'
113
- | 'ostatus'
114
- | 'pumpio'
115
- | 'tent'
116
- | 'xmpp'
117
- | 'zot'
118
- )[]
119
- ];
120
- /**
121
- * The third party sites this server can connect to via their application API.
122
- */
123
- services: {
103
+ protocols: [
104
+ 'activitypub' | 'buddycloud' | 'dfrn' | 'diaspora' | 'libertree' | 'ostatus' | 'pumpio' | 'tent' | 'xmpp' | 'zot',
105
+ ...('activitypub' | 'buddycloud' | 'dfrn' | 'diaspora' | 'libertree' | 'ostatus' | 'pumpio' | 'tent' | 'xmpp' | 'zot')[]
106
+ ];
124
107
  /**
125
- * The third party sites this server can retrieve messages from for combined display with regular traffic.
108
+ * The third party sites this server can connect to via their application API.
126
109
  */
127
- inbound: ('atom1.0' | 'gnusocial' | 'imap' | 'pnut' | 'pop3' | 'pumpio' | 'rss2.0' | 'twitter')[];
110
+ services: {
111
+ /**
112
+ * The third party sites this server can retrieve messages from for combined display with regular traffic.
113
+ */
114
+ inbound: ('atom1.0' | 'gnusocial' | 'imap' | 'pnut' | 'pop3' | 'pumpio' | 'rss2.0' | 'twitter')[];
115
+ /**
116
+ * The third party sites this server can publish messages to on the behalf of a user.
117
+ */
118
+ outbound: ('atom1.0' | 'blogger' | 'buddycloud' | 'diaspora' | 'dreamwidth' | 'drupal' | 'facebook' | 'friendica' | 'gnusocial' | 'google' | 'insanejournal' | 'libertree' | 'linkedin' | 'livejournal' | 'mediagoblin' | 'myspace' | 'pinterest' | 'pnut' | 'posterous' | 'pumpio' | 'redmatrix' | 'rss2.0' | 'smtp' | 'tent' | 'tumblr' | 'twitter' | 'wordpress' | 'xmpp')[];
119
+ };
128
120
  /**
129
- * The third party sites this server can publish messages to on the behalf of a user.
121
+ * Whether this server allows open self-registration.
130
122
  */
131
- outbound: (
132
- | 'atom1.0'
133
- | 'blogger'
134
- | 'buddycloud'
135
- | 'diaspora'
136
- | 'dreamwidth'
137
- | 'drupal'
138
- | 'facebook'
139
- | 'friendica'
140
- | 'gnusocial'
141
- | 'google'
142
- | 'insanejournal'
143
- | 'libertree'
144
- | 'linkedin'
145
- | 'livejournal'
146
- | 'mediagoblin'
147
- | 'myspace'
148
- | 'pinterest'
149
- | 'pnut'
150
- | 'posterous'
151
- | 'pumpio'
152
- | 'redmatrix'
153
- | 'rss2.0'
154
- | 'smtp'
155
- | 'tent'
156
- | 'tumblr'
157
- | 'twitter'
158
- | 'wordpress'
159
- | 'xmpp'
160
- )[];
161
- };
162
- /**
163
- * Whether this server allows open self-registration.
164
- */
165
- openRegistrations: boolean;
166
- /**
167
- * Usage statistics for this server.
168
- */
169
- usage: {
123
+ openRegistrations: boolean;
170
124
  /**
171
- * statistics about the users of this server.
125
+ * Usage statistics for this server.
172
126
  */
173
- users: {
174
- /**
175
- * The total amount of on this server registered users.
176
- */
177
- total?: number;
178
- /**
179
- * The amount of users that signed in at least once in the last 180 days.
180
- */
181
- activeHalfyear?: number;
182
- /**
183
- * The amount of users that signed in at least once in the last 30 days.
184
- */
185
- activeMonth?: number;
127
+ usage: {
128
+ /**
129
+ * statistics about the users of this server.
130
+ */
131
+ users: {
132
+ /**
133
+ * The total amount of on this server registered users.
134
+ */
135
+ total?: number;
136
+ /**
137
+ * The amount of users that signed in at least once in the last 180 days.
138
+ */
139
+ activeHalfyear?: number;
140
+ /**
141
+ * The amount of users that signed in at least once in the last 30 days.
142
+ */
143
+ activeMonth?: number;
144
+ };
145
+ /**
146
+ * The amount of posts that were made by users that are registered on this server.
147
+ */
148
+ localPosts?: number;
149
+ /**
150
+ * The amount of comments that were made by users that are registered on this server.
151
+ */
152
+ localComments?: number;
186
153
  };
187
154
  /**
188
- * The amount of posts that were made by users that are registered on this server.
189
- */
190
- localPosts?: number;
191
- /**
192
- * The amount of comments that were made by users that are registered on this server.
155
+ * Free form key value pairs for software specific values. Clients should not rely on any specific key present.
193
156
  */
194
- localComments?: number;
195
- };
196
- /**
197
- * Free form key value pairs for software specific values. Clients should not rely on any specific key present.
198
- */
199
- metadata: {
200
- [k: string]: unknown;
201
- };
157
+ metadata: {
158
+ [k: string]: unknown;
159
+ };
202
160
  }
203
161
  /**
204
- * Subscribe a collection. Supports pagination.
162
+ * Subscribe toa collection. Supports pagination.
205
163
  * @param predicateOrUrl The collection URI or the predicate to get the collection URI from the identity (webId).
206
164
  * @param {UseCollectionOptions} options Defaults to `{ dereferenceItems: false, liveUpdates: false }`
207
165
  */
208
- export const useCollection: (
209
- predicateOrUrl: string,
210
- options?: UseCollectionOptions
211
- ) =>
212
- | {
213
- items: any[];
214
- error: false | unknown[];
215
- refetch: <TPageData>(
216
- options?: (RefetchOptions & RefetchQueryFilters<TPageData>) | undefined
217
- ) => Promise<QueryObserverResult<InfiniteData<any>, unknown>>;
218
- fetchNextPage: (options?: FetchNextPageOptions | undefined) => Promise<InfiniteQueryObserverResult<any, unknown>>;
219
- addItem: (item: string | any, shouldRefetch?: boolean | number) => void;
220
- removeItem: (item: string | any, shouldRefetch?: boolean) => void;
221
- hasNextPage: boolean | undefined;
222
- isLoading: boolean;
223
- isFetching: boolean;
224
- isFetchingNextPage: boolean;
225
- url: any;
226
- hasLiveUpdates: {
166
+ export const useCollection: (predicateOrUrl: string, options?: UseCollectionOptions) => {
167
+ items: any[];
168
+ error: false | (Error | null)[];
169
+ refetch: (options?: RefetchOptions) => Promise<QueryObserverResult<InfiniteData<any, unknown>, Error>>;
170
+ fetchNextPage: (options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<InfiniteData<any, unknown>, Error>>;
171
+ addItem: (item: string | any, shouldRefetch?: boolean | number) => void;
172
+ removeItem: (item: string | any, shouldRefetch?: boolean) => void;
173
+ hasNextPage: boolean;
174
+ isLoading: boolean;
175
+ isFetching: boolean;
176
+ isFetchingNextPage: boolean;
177
+ url: any;
178
+ hasLiveUpdates: {
227
179
  status: string;
228
180
  error?: any;
229
- };
230
- awaitWebSocketConnection: (options?: AwaitActivityOptions) => Promise<RefObject<WebSocket>>;
231
- webSocketRef: MutableRefObject<WebSocket | null>;
232
- }
233
- | {
234
- totalItems: number;
235
- items: any[];
236
- error: false | unknown[];
237
- refetch: <TPageData>(
238
- options?: (RefetchOptions & RefetchQueryFilters<TPageData>) | undefined
239
- ) => Promise<QueryObserverResult<InfiniteData<any>, unknown>>;
240
- fetchNextPage: (options?: FetchNextPageOptions | undefined) => Promise<InfiniteQueryObserverResult<any, unknown>>;
241
- addItem: (item: string | any, shouldRefetch?: boolean | number) => void;
242
- removeItem: (item: string | any, shouldRefetch?: boolean) => void;
243
- hasNextPage: boolean | undefined;
244
- isLoading: boolean;
245
- isFetching: boolean;
246
- isFetchingNextPage: boolean;
247
- url: any;
248
- hasLiveUpdates: {
181
+ };
182
+ awaitWebSocketConnection: (options?: AwaitActivityOptions) => Promise<RefObject<WebSocket>>;
183
+ webSocketRef: MutableRefObject<WebSocket | null>;
184
+ } | {
185
+ totalItems: number;
186
+ items: any[];
187
+ error: false | (Error | null)[];
188
+ refetch: (options?: RefetchOptions) => Promise<QueryObserverResult<InfiniteData<any, unknown>, Error>>;
189
+ fetchNextPage: (options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<InfiniteData<any, unknown>, Error>>;
190
+ addItem: (item: string | any, shouldRefetch?: boolean | number) => void;
191
+ removeItem: (item: string | any, shouldRefetch?: boolean) => void;
192
+ hasNextPage: boolean;
193
+ isLoading: boolean;
194
+ isFetching: boolean;
195
+ isFetchingNextPage: boolean;
196
+ url: any;
197
+ hasLiveUpdates: {
249
198
  status: string;
250
199
  error?: any;
251
- };
252
- awaitWebSocketConnection: (options?: AwaitActivityOptions) => Promise<RefObject<WebSocket>>;
253
- webSocketRef: MutableRefObject<WebSocket | null>;
254
200
  };
201
+ awaitWebSocketConnection: (options?: AwaitActivityOptions) => Promise<RefObject<WebSocket>>;
202
+ webSocketRef: MutableRefObject<WebSocket | null>;
203
+ };
255
204
  /**
256
205
  * Hook to fetch and post to the outbox of the logged user.
257
206
  * Returns the same data as the useCollection hooks, plus:
@@ -261,99 +210,732 @@ export const useCollection: (
261
210
  * See https://semapps.org/docs/frontend/activitypub-components#useoutbox for usage
262
211
  * @param {UseCollectionOptions} options Defaults to `{ dereferenceItems: false, liveUpdates: false }`
263
212
  */
264
- export const useOutbox: (options?: UseCollectionOptions) =>
265
- | {
266
- error: false | unknown[];
267
- refetch: <TPageData>(
268
- options?: (RefetchOptions & RefetchQueryFilters<TPageData>) | undefined
269
- ) => Promise<QueryObserverResult<InfiniteData<any>, unknown>>;
270
- fetchNextPage: (options?: FetchNextPageOptions | undefined) => Promise<InfiniteQueryObserverResult<any, unknown>>;
271
- addItem: (item: any, shouldRefetch?: number | boolean) => void;
272
- removeItem: (item: any, shouldRefetch?: boolean) => void;
273
- hasNextPage: boolean | undefined;
274
- isLoading: boolean;
275
- isFetching: boolean;
276
- isFetchingNextPage: boolean;
277
- hasLiveUpdates: {
213
+ export const useOutbox: (options?: UseCollectionOptions) => {
214
+ error: false | (Error | null)[];
215
+ refetch: (options?: _RefetchOptions1) => Promise<_QueryObserverResult1<_InfiniteData1<any, unknown>, Error>>;
216
+ fetchNextPage: (options?: _FetchNextPageOptions1) => Promise<_InfiniteQueryObserverResult1<_InfiniteData1<any, unknown>, Error>>;
217
+ addItem: (item: string | any, shouldRefetch?: boolean | number) => void;
218
+ removeItem: (item: string | any, shouldRefetch?: boolean) => void;
219
+ hasNextPage: boolean;
220
+ isLoading: boolean;
221
+ isFetching: boolean;
222
+ isFetchingNextPage: boolean;
223
+ hasLiveUpdates: {
278
224
  status: string;
279
225
  error?: any;
280
- };
281
- webSocketRef: MutableRefObject<WebSocket | null>;
282
- url: any;
283
- items: any[];
284
- awaitWebSocketConnection: (options?: AwaitActivityOptions) => Promise<RefObject<WebSocket>>;
285
- post: (activity: object) => Promise<string | null>;
286
- awaitActivity: (matchActivity: (activity: object) => boolean, options?: AwaitActivityOptions) => Promise<unknown>;
287
- owner: Identifier | undefined;
288
- }
289
- | {
290
- totalItems: number;
291
- error: false | unknown[];
292
- refetch: <TPageData>(
293
- options?: (RefetchOptions & RefetchQueryFilters<TPageData>) | undefined
294
- ) => Promise<QueryObserverResult<InfiniteData<any>, unknown>>;
295
- fetchNextPage: (options?: FetchNextPageOptions | undefined) => Promise<InfiniteQueryObserverResult<any, unknown>>;
296
- addItem: (item: any, shouldRefetch?: number | boolean) => void;
297
- removeItem: (item: any, shouldRefetch?: boolean) => void;
298
- hasNextPage: boolean | undefined;
299
- isLoading: boolean;
300
- isFetching: boolean;
301
- isFetchingNextPage: boolean;
302
- hasLiveUpdates: {
226
+ };
227
+ webSocketRef: MutableRefObject<WebSocket | null>;
228
+ url: any;
229
+ items: any[];
230
+ awaitWebSocketConnection: (options?: AwaitActivityOptions) => Promise<RefObject<WebSocket>>;
231
+ post: (activity: object) => Promise<string | null>;
232
+ awaitActivity: (matchActivity: (activity: object) => boolean, options?: AwaitActivityOptions) => Promise<unknown>;
233
+ owner: Identifier | undefined;
234
+ } | {
235
+ totalItems: number;
236
+ error: false | (Error | null)[];
237
+ refetch: (options?: _RefetchOptions1) => Promise<_QueryObserverResult1<_InfiniteData1<any, unknown>, Error>>;
238
+ fetchNextPage: (options?: _FetchNextPageOptions1) => Promise<_InfiniteQueryObserverResult1<_InfiniteData1<any, unknown>, Error>>;
239
+ addItem: (item: string | any, shouldRefetch?: boolean | number) => void;
240
+ removeItem: (item: string | any, shouldRefetch?: boolean) => void;
241
+ hasNextPage: boolean;
242
+ isLoading: boolean;
243
+ isFetching: boolean;
244
+ isFetchingNextPage: boolean;
245
+ hasLiveUpdates: {
303
246
  status: string;
304
247
  error?: any;
305
- };
306
- webSocketRef: MutableRefObject<WebSocket | null>;
307
- url: any;
308
- items: any[];
309
- awaitWebSocketConnection: (options?: AwaitActivityOptions) => Promise<RefObject<WebSocket>>;
310
- post: (activity: object) => Promise<string | null>;
311
- awaitActivity: (matchActivity: (activity: object) => boolean, options?: AwaitActivityOptions) => Promise<unknown>;
312
- owner: Identifier | undefined;
313
248
  };
314
- export function CommentsField({
315
- source,
316
- context,
317
- helperText,
318
- placeholder,
319
- userResource,
320
- mentions
321
- }: {
322
- source: any;
323
- context: any;
324
- helperText: any;
325
- placeholder: any;
326
- userResource: any;
327
- mentions: any;
328
- }): JSX.Element;
329
- declare namespace CommentsField {
330
- namespace defaultProps {
331
- let label: string;
332
- let placeholder: string;
333
- let source: string;
334
- let context: string;
335
- }
249
+ webSocketRef: MutableRefObject<WebSocket | null>;
250
+ url: any;
251
+ items: any[];
252
+ awaitWebSocketConnection: (options?: AwaitActivityOptions) => Promise<RefObject<WebSocket>>;
253
+ post: (activity: object) => Promise<string | null>;
254
+ awaitActivity: (matchActivity: (activity: object) => boolean, options?: AwaitActivityOptions) => Promise<unknown>;
255
+ owner: Identifier | undefined;
256
+ };
257
+ export const CommentsField: ({ source, context, helperText, placeholder, userResource, mentions }: any) => JSX.Element;
258
+ export const CollectionList: ({ collectionUrl, resource, children }: any) => JSX.Element;
259
+ export const ReferenceCollectionField: ({ source, reference, children, ...rest }: any) => JSX.Element | null;
260
+ interface UseTypedCollectionOptions<ItemType extends LdoBase> {
261
+ shapeTypes: ShapeType<ItemType>[];
262
+ pageSize: number;
336
263
  }
337
- export function CollectionList({
338
- collectionUrl,
339
- resource,
340
- children
341
- }: {
342
- collectionUrl: any;
343
- resource: any;
344
- children: any;
345
- }): JSX.Element;
346
- export function ReferenceCollectionField({
347
- source,
348
- reference,
349
- children,
350
- ...rest
351
- }: {
352
- [x: string]: any;
353
- source: any;
354
- reference: any;
355
- children: any;
356
- }): JSX.Element | null;
264
+ /**
265
+ * Subscribe to a collection. Supports pagination.
266
+ * @param collectionUri The collection URI or the predicate to get the collection URI from the identity (webId).
267
+ * @param {UseCollectionOptions & UseTypedCollectionOptions} options Defaults to `{ dereferenceItems: false, liveUpdates: false, pageSize: 10 }` and requires at least one ldo @see {ShapeType}.
268
+ */
269
+ export const useTypedCollection: <ItemType extends LdoBase>(collectionUri: string, options: UseCollectionOptions & UseTypedCollectionOptions<ItemType>) => {
270
+ items: ItemType[];
271
+ liveUpdatesStatus: {
272
+ error?: any;
273
+ status: "error" | "closed" | "connected" | "connecting" | "disabled";
274
+ };
275
+ fetchNext: (noItems?: number) => void;
276
+ fetchPrevious: (noItems?: number) => void;
277
+ totalItems: number | undefined;
278
+ isPaginated: boolean | undefined;
279
+ data: InfiniteData<{
280
+ itemIds: never[];
281
+ dataset: null;
282
+ data: null;
283
+ pageUri?: undefined;
284
+ } | {
285
+ itemIds: string[];
286
+ dataset: null;
287
+ pageUri: string;
288
+ data: null;
289
+ } | {
290
+ dataset: ConnectedLdoDataset<SolidConnectedPlugin[]>;
291
+ itemIds: string[];
292
+ pageUri: string;
293
+ data: OrderedCollectionPage;
294
+ }, unknown>;
295
+ error: Error;
296
+ isError: true;
297
+ isPending: false;
298
+ isLoading: false;
299
+ isLoadingError: false;
300
+ isRefetchError: true;
301
+ isSuccess: false;
302
+ isPlaceholderData: false;
303
+ status: "error";
304
+ fetchNextPage: (options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<InfiniteData<{
305
+ itemIds: never[];
306
+ dataset: null;
307
+ data: null;
308
+ pageUri?: undefined;
309
+ } | {
310
+ itemIds: string[];
311
+ dataset: null;
312
+ pageUri: string;
313
+ data: null;
314
+ } | {
315
+ dataset: ConnectedLdoDataset<SolidConnectedPlugin[]>;
316
+ itemIds: string[];
317
+ pageUri: string;
318
+ data: OrderedCollectionPage;
319
+ }, unknown>, Error>>;
320
+ fetchPreviousPage: (options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<InfiniteData<{
321
+ itemIds: never[];
322
+ dataset: null;
323
+ data: null;
324
+ pageUri?: undefined;
325
+ } | {
326
+ itemIds: string[];
327
+ dataset: null;
328
+ pageUri: string;
329
+ data: null;
330
+ } | {
331
+ dataset: ConnectedLdoDataset<SolidConnectedPlugin[]>;
332
+ itemIds: string[];
333
+ pageUri: string;
334
+ data: OrderedCollectionPage;
335
+ }, unknown>, Error>>;
336
+ hasNextPage: boolean;
337
+ hasPreviousPage: boolean;
338
+ isFetchNextPageError: boolean;
339
+ isFetchingNextPage: boolean;
340
+ isFetchPreviousPageError: boolean;
341
+ isFetchingPreviousPage: boolean;
342
+ dataUpdatedAt: number;
343
+ errorUpdatedAt: number;
344
+ failureCount: number;
345
+ failureReason: Error | null;
346
+ errorUpdateCount: number;
347
+ isFetched: boolean;
348
+ isFetchedAfterMount: boolean;
349
+ isFetching: boolean;
350
+ isInitialLoading: boolean;
351
+ isPaused: boolean;
352
+ isRefetching: boolean;
353
+ isStale: boolean;
354
+ isEnabled: boolean;
355
+ refetch: (options?: RefetchOptions) => Promise<QueryObserverResult<InfiniteData<{
356
+ itemIds: never[];
357
+ dataset: null;
358
+ data: null;
359
+ pageUri?: undefined;
360
+ } | {
361
+ itemIds: string[];
362
+ dataset: null;
363
+ pageUri: string;
364
+ data: null;
365
+ } | {
366
+ dataset: ConnectedLdoDataset<SolidConnectedPlugin[]>;
367
+ itemIds: string[];
368
+ pageUri: string;
369
+ data: OrderedCollectionPage;
370
+ }, unknown>, Error>>;
371
+ fetchStatus: FetchStatus;
372
+ promise: Promise<InfiniteData<{
373
+ itemIds: never[];
374
+ dataset: null;
375
+ data: null;
376
+ pageUri?: undefined;
377
+ } | {
378
+ itemIds: string[];
379
+ dataset: null;
380
+ pageUri: string;
381
+ data: null;
382
+ } | {
383
+ dataset: ConnectedLdoDataset<SolidConnectedPlugin[]>;
384
+ itemIds: string[];
385
+ pageUri: string;
386
+ data: OrderedCollectionPage;
387
+ }, unknown>>;
388
+ } | {
389
+ items: ItemType[];
390
+ liveUpdatesStatus: {
391
+ error?: any;
392
+ status: "error" | "closed" | "connected" | "connecting" | "disabled";
393
+ };
394
+ fetchNext: (noItems?: number) => void;
395
+ fetchPrevious: (noItems?: number) => void;
396
+ totalItems: number | undefined;
397
+ isPaginated: boolean | undefined;
398
+ data: InfiniteData<{
399
+ itemIds: never[];
400
+ dataset: null;
401
+ data: null;
402
+ pageUri?: undefined;
403
+ } | {
404
+ itemIds: string[];
405
+ dataset: null;
406
+ pageUri: string;
407
+ data: null;
408
+ } | {
409
+ dataset: ConnectedLdoDataset<SolidConnectedPlugin[]>;
410
+ itemIds: string[];
411
+ pageUri: string;
412
+ data: OrderedCollectionPage;
413
+ }, unknown>;
414
+ error: null;
415
+ isError: false;
416
+ isPending: false;
417
+ isLoading: false;
418
+ isLoadingError: false;
419
+ isRefetchError: false;
420
+ isFetchNextPageError: false;
421
+ isFetchPreviousPageError: false;
422
+ isSuccess: true;
423
+ isPlaceholderData: false;
424
+ status: "success";
425
+ fetchNextPage: (options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<InfiniteData<{
426
+ itemIds: never[];
427
+ dataset: null;
428
+ data: null;
429
+ pageUri?: undefined;
430
+ } | {
431
+ itemIds: string[];
432
+ dataset: null;
433
+ pageUri: string;
434
+ data: null;
435
+ } | {
436
+ dataset: ConnectedLdoDataset<SolidConnectedPlugin[]>;
437
+ itemIds: string[];
438
+ pageUri: string;
439
+ data: OrderedCollectionPage;
440
+ }, unknown>, Error>>;
441
+ fetchPreviousPage: (options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<InfiniteData<{
442
+ itemIds: never[];
443
+ dataset: null;
444
+ data: null;
445
+ pageUri?: undefined;
446
+ } | {
447
+ itemIds: string[];
448
+ dataset: null;
449
+ pageUri: string;
450
+ data: null;
451
+ } | {
452
+ dataset: ConnectedLdoDataset<SolidConnectedPlugin[]>;
453
+ itemIds: string[];
454
+ pageUri: string;
455
+ data: OrderedCollectionPage;
456
+ }, unknown>, Error>>;
457
+ hasNextPage: boolean;
458
+ hasPreviousPage: boolean;
459
+ isFetchingNextPage: boolean;
460
+ isFetchingPreviousPage: boolean;
461
+ dataUpdatedAt: number;
462
+ errorUpdatedAt: number;
463
+ failureCount: number;
464
+ failureReason: Error | null;
465
+ errorUpdateCount: number;
466
+ isFetched: boolean;
467
+ isFetchedAfterMount: boolean;
468
+ isFetching: boolean;
469
+ isInitialLoading: boolean;
470
+ isPaused: boolean;
471
+ isRefetching: boolean;
472
+ isStale: boolean;
473
+ isEnabled: boolean;
474
+ refetch: (options?: RefetchOptions) => Promise<QueryObserverResult<InfiniteData<{
475
+ itemIds: never[];
476
+ dataset: null;
477
+ data: null;
478
+ pageUri?: undefined;
479
+ } | {
480
+ itemIds: string[];
481
+ dataset: null;
482
+ pageUri: string;
483
+ data: null;
484
+ } | {
485
+ dataset: ConnectedLdoDataset<SolidConnectedPlugin[]>;
486
+ itemIds: string[];
487
+ pageUri: string;
488
+ data: OrderedCollectionPage;
489
+ }, unknown>, Error>>;
490
+ fetchStatus: FetchStatus;
491
+ promise: Promise<InfiniteData<{
492
+ itemIds: never[];
493
+ dataset: null;
494
+ data: null;
495
+ pageUri?: undefined;
496
+ } | {
497
+ itemIds: string[];
498
+ dataset: null;
499
+ pageUri: string;
500
+ data: null;
501
+ } | {
502
+ dataset: ConnectedLdoDataset<SolidConnectedPlugin[]>;
503
+ itemIds: string[];
504
+ pageUri: string;
505
+ data: OrderedCollectionPage;
506
+ }, unknown>>;
507
+ } | {
508
+ items: ItemType[];
509
+ liveUpdatesStatus: {
510
+ error?: any;
511
+ status: "error" | "closed" | "connected" | "connecting" | "disabled";
512
+ };
513
+ fetchNext: (noItems?: number) => void;
514
+ fetchPrevious: (noItems?: number) => void;
515
+ totalItems: number | undefined;
516
+ isPaginated: boolean | undefined;
517
+ data: undefined;
518
+ error: Error;
519
+ isError: true;
520
+ isPending: false;
521
+ isLoading: false;
522
+ isLoadingError: true;
523
+ isRefetchError: false;
524
+ isFetchNextPageError: false;
525
+ isFetchPreviousPageError: false;
526
+ isSuccess: false;
527
+ isPlaceholderData: false;
528
+ status: "error";
529
+ fetchNextPage: (options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<InfiniteData<{
530
+ itemIds: never[];
531
+ dataset: null;
532
+ data: null;
533
+ pageUri?: undefined;
534
+ } | {
535
+ itemIds: string[];
536
+ dataset: null;
537
+ pageUri: string;
538
+ data: null;
539
+ } | {
540
+ dataset: ConnectedLdoDataset<SolidConnectedPlugin[]>;
541
+ itemIds: string[];
542
+ pageUri: string;
543
+ data: OrderedCollectionPage;
544
+ }, unknown>, Error>>;
545
+ fetchPreviousPage: (options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<InfiniteData<{
546
+ itemIds: never[];
547
+ dataset: null;
548
+ data: null;
549
+ pageUri?: undefined;
550
+ } | {
551
+ itemIds: string[];
552
+ dataset: null;
553
+ pageUri: string;
554
+ data: null;
555
+ } | {
556
+ dataset: ConnectedLdoDataset<SolidConnectedPlugin[]>;
557
+ itemIds: string[];
558
+ pageUri: string;
559
+ data: OrderedCollectionPage;
560
+ }, unknown>, Error>>;
561
+ hasNextPage: boolean;
562
+ hasPreviousPage: boolean;
563
+ isFetchingNextPage: boolean;
564
+ isFetchingPreviousPage: boolean;
565
+ dataUpdatedAt: number;
566
+ errorUpdatedAt: number;
567
+ failureCount: number;
568
+ failureReason: Error | null;
569
+ errorUpdateCount: number;
570
+ isFetched: boolean;
571
+ isFetchedAfterMount: boolean;
572
+ isFetching: boolean;
573
+ isInitialLoading: boolean;
574
+ isPaused: boolean;
575
+ isRefetching: boolean;
576
+ isStale: boolean;
577
+ isEnabled: boolean;
578
+ refetch: (options?: RefetchOptions) => Promise<QueryObserverResult<InfiniteData<{
579
+ itemIds: never[];
580
+ dataset: null;
581
+ data: null;
582
+ pageUri?: undefined;
583
+ } | {
584
+ itemIds: string[];
585
+ dataset: null;
586
+ pageUri: string;
587
+ data: null;
588
+ } | {
589
+ dataset: ConnectedLdoDataset<SolidConnectedPlugin[]>;
590
+ itemIds: string[];
591
+ pageUri: string;
592
+ data: OrderedCollectionPage;
593
+ }, unknown>, Error>>;
594
+ fetchStatus: FetchStatus;
595
+ promise: Promise<InfiniteData<{
596
+ itemIds: never[];
597
+ dataset: null;
598
+ data: null;
599
+ pageUri?: undefined;
600
+ } | {
601
+ itemIds: string[];
602
+ dataset: null;
603
+ pageUri: string;
604
+ data: null;
605
+ } | {
606
+ dataset: ConnectedLdoDataset<SolidConnectedPlugin[]>;
607
+ itemIds: string[];
608
+ pageUri: string;
609
+ data: OrderedCollectionPage;
610
+ }, unknown>>;
611
+ } | {
612
+ items: ItemType[];
613
+ liveUpdatesStatus: {
614
+ error?: any;
615
+ status: "error" | "closed" | "connected" | "connecting" | "disabled";
616
+ };
617
+ fetchNext: (noItems?: number) => void;
618
+ fetchPrevious: (noItems?: number) => void;
619
+ totalItems: number | undefined;
620
+ isPaginated: boolean | undefined;
621
+ data: undefined;
622
+ error: null;
623
+ isError: false;
624
+ isPending: true;
625
+ isLoading: true;
626
+ isLoadingError: false;
627
+ isRefetchError: false;
628
+ isFetchNextPageError: false;
629
+ isFetchPreviousPageError: false;
630
+ isSuccess: false;
631
+ isPlaceholderData: false;
632
+ status: "pending";
633
+ fetchNextPage: (options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<InfiniteData<{
634
+ itemIds: never[];
635
+ dataset: null;
636
+ data: null;
637
+ pageUri?: undefined;
638
+ } | {
639
+ itemIds: string[];
640
+ dataset: null;
641
+ pageUri: string;
642
+ data: null;
643
+ } | {
644
+ dataset: ConnectedLdoDataset<SolidConnectedPlugin[]>;
645
+ itemIds: string[];
646
+ pageUri: string;
647
+ data: OrderedCollectionPage;
648
+ }, unknown>, Error>>;
649
+ fetchPreviousPage: (options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<InfiniteData<{
650
+ itemIds: never[];
651
+ dataset: null;
652
+ data: null;
653
+ pageUri?: undefined;
654
+ } | {
655
+ itemIds: string[];
656
+ dataset: null;
657
+ pageUri: string;
658
+ data: null;
659
+ } | {
660
+ dataset: ConnectedLdoDataset<SolidConnectedPlugin[]>;
661
+ itemIds: string[];
662
+ pageUri: string;
663
+ data: OrderedCollectionPage;
664
+ }, unknown>, Error>>;
665
+ hasNextPage: boolean;
666
+ hasPreviousPage: boolean;
667
+ isFetchingNextPage: boolean;
668
+ isFetchingPreviousPage: boolean;
669
+ dataUpdatedAt: number;
670
+ errorUpdatedAt: number;
671
+ failureCount: number;
672
+ failureReason: Error | null;
673
+ errorUpdateCount: number;
674
+ isFetched: boolean;
675
+ isFetchedAfterMount: boolean;
676
+ isFetching: boolean;
677
+ isInitialLoading: boolean;
678
+ isPaused: boolean;
679
+ isRefetching: boolean;
680
+ isStale: boolean;
681
+ isEnabled: boolean;
682
+ refetch: (options?: RefetchOptions) => Promise<QueryObserverResult<InfiniteData<{
683
+ itemIds: never[];
684
+ dataset: null;
685
+ data: null;
686
+ pageUri?: undefined;
687
+ } | {
688
+ itemIds: string[];
689
+ dataset: null;
690
+ pageUri: string;
691
+ data: null;
692
+ } | {
693
+ dataset: ConnectedLdoDataset<SolidConnectedPlugin[]>;
694
+ itemIds: string[];
695
+ pageUri: string;
696
+ data: OrderedCollectionPage;
697
+ }, unknown>, Error>>;
698
+ fetchStatus: FetchStatus;
699
+ promise: Promise<InfiniteData<{
700
+ itemIds: never[];
701
+ dataset: null;
702
+ data: null;
703
+ pageUri?: undefined;
704
+ } | {
705
+ itemIds: string[];
706
+ dataset: null;
707
+ pageUri: string;
708
+ data: null;
709
+ } | {
710
+ dataset: ConnectedLdoDataset<SolidConnectedPlugin[]>;
711
+ itemIds: string[];
712
+ pageUri: string;
713
+ data: OrderedCollectionPage;
714
+ }, unknown>>;
715
+ } | {
716
+ items: ItemType[];
717
+ liveUpdatesStatus: {
718
+ error?: any;
719
+ status: "error" | "closed" | "connected" | "connecting" | "disabled";
720
+ };
721
+ fetchNext: (noItems?: number) => void;
722
+ fetchPrevious: (noItems?: number) => void;
723
+ totalItems: number | undefined;
724
+ isPaginated: boolean | undefined;
725
+ data: undefined;
726
+ error: null;
727
+ isError: false;
728
+ isPending: true;
729
+ isLoadingError: false;
730
+ isRefetchError: false;
731
+ isFetchNextPageError: false;
732
+ isFetchPreviousPageError: false;
733
+ isSuccess: false;
734
+ isPlaceholderData: false;
735
+ status: "pending";
736
+ fetchNextPage: (options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<InfiniteData<{
737
+ itemIds: never[];
738
+ dataset: null;
739
+ data: null;
740
+ pageUri?: undefined;
741
+ } | {
742
+ itemIds: string[];
743
+ dataset: null;
744
+ pageUri: string;
745
+ data: null;
746
+ } | {
747
+ dataset: ConnectedLdoDataset<SolidConnectedPlugin[]>;
748
+ itemIds: string[];
749
+ pageUri: string;
750
+ data: OrderedCollectionPage;
751
+ }, unknown>, Error>>;
752
+ fetchPreviousPage: (options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<InfiniteData<{
753
+ itemIds: never[];
754
+ dataset: null;
755
+ data: null;
756
+ pageUri?: undefined;
757
+ } | {
758
+ itemIds: string[];
759
+ dataset: null;
760
+ pageUri: string;
761
+ data: null;
762
+ } | {
763
+ dataset: ConnectedLdoDataset<SolidConnectedPlugin[]>;
764
+ itemIds: string[];
765
+ pageUri: string;
766
+ data: OrderedCollectionPage;
767
+ }, unknown>, Error>>;
768
+ hasNextPage: boolean;
769
+ hasPreviousPage: boolean;
770
+ isFetchingNextPage: boolean;
771
+ isFetchingPreviousPage: boolean;
772
+ dataUpdatedAt: number;
773
+ errorUpdatedAt: number;
774
+ failureCount: number;
775
+ failureReason: Error | null;
776
+ errorUpdateCount: number;
777
+ isFetched: boolean;
778
+ isFetchedAfterMount: boolean;
779
+ isFetching: boolean;
780
+ isLoading: boolean;
781
+ isInitialLoading: boolean;
782
+ isPaused: boolean;
783
+ isRefetching: boolean;
784
+ isStale: boolean;
785
+ isEnabled: boolean;
786
+ refetch: (options?: RefetchOptions) => Promise<QueryObserverResult<InfiniteData<{
787
+ itemIds: never[];
788
+ dataset: null;
789
+ data: null;
790
+ pageUri?: undefined;
791
+ } | {
792
+ itemIds: string[];
793
+ dataset: null;
794
+ pageUri: string;
795
+ data: null;
796
+ } | {
797
+ dataset: ConnectedLdoDataset<SolidConnectedPlugin[]>;
798
+ itemIds: string[];
799
+ pageUri: string;
800
+ data: OrderedCollectionPage;
801
+ }, unknown>, Error>>;
802
+ fetchStatus: FetchStatus;
803
+ promise: Promise<InfiniteData<{
804
+ itemIds: never[];
805
+ dataset: null;
806
+ data: null;
807
+ pageUri?: undefined;
808
+ } | {
809
+ itemIds: string[];
810
+ dataset: null;
811
+ pageUri: string;
812
+ data: null;
813
+ } | {
814
+ dataset: ConnectedLdoDataset<SolidConnectedPlugin[]>;
815
+ itemIds: string[];
816
+ pageUri: string;
817
+ data: OrderedCollectionPage;
818
+ }, unknown>>;
819
+ } | {
820
+ items: ItemType[];
821
+ liveUpdatesStatus: {
822
+ error?: any;
823
+ status: "error" | "closed" | "connected" | "connecting" | "disabled";
824
+ };
825
+ fetchNext: (noItems?: number) => void;
826
+ fetchPrevious: (noItems?: number) => void;
827
+ totalItems: number | undefined;
828
+ isPaginated: boolean | undefined;
829
+ data: InfiniteData<{
830
+ itemIds: never[];
831
+ dataset: null;
832
+ data: null;
833
+ pageUri?: undefined;
834
+ } | {
835
+ itemIds: string[];
836
+ dataset: null;
837
+ pageUri: string;
838
+ data: null;
839
+ } | {
840
+ dataset: ConnectedLdoDataset<SolidConnectedPlugin[]>;
841
+ itemIds: string[];
842
+ pageUri: string;
843
+ data: OrderedCollectionPage;
844
+ }, unknown>;
845
+ isError: false;
846
+ error: null;
847
+ isPending: false;
848
+ isLoading: false;
849
+ isLoadingError: false;
850
+ isRefetchError: false;
851
+ isSuccess: true;
852
+ isPlaceholderData: true;
853
+ isFetchNextPageError: false;
854
+ isFetchPreviousPageError: false;
855
+ status: "success";
856
+ fetchNextPage: (options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<InfiniteData<{
857
+ itemIds: never[];
858
+ dataset: null;
859
+ data: null;
860
+ pageUri?: undefined;
861
+ } | {
862
+ itemIds: string[];
863
+ dataset: null;
864
+ pageUri: string;
865
+ data: null;
866
+ } | {
867
+ dataset: ConnectedLdoDataset<SolidConnectedPlugin[]>;
868
+ itemIds: string[];
869
+ pageUri: string;
870
+ data: OrderedCollectionPage;
871
+ }, unknown>, Error>>;
872
+ fetchPreviousPage: (options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<InfiniteData<{
873
+ itemIds: never[];
874
+ dataset: null;
875
+ data: null;
876
+ pageUri?: undefined;
877
+ } | {
878
+ itemIds: string[];
879
+ dataset: null;
880
+ pageUri: string;
881
+ data: null;
882
+ } | {
883
+ dataset: ConnectedLdoDataset<SolidConnectedPlugin[]>;
884
+ itemIds: string[];
885
+ pageUri: string;
886
+ data: OrderedCollectionPage;
887
+ }, unknown>, Error>>;
888
+ hasNextPage: boolean;
889
+ hasPreviousPage: boolean;
890
+ isFetchingNextPage: boolean;
891
+ isFetchingPreviousPage: boolean;
892
+ dataUpdatedAt: number;
893
+ errorUpdatedAt: number;
894
+ failureCount: number;
895
+ failureReason: Error | null;
896
+ errorUpdateCount: number;
897
+ isFetched: boolean;
898
+ isFetchedAfterMount: boolean;
899
+ isFetching: boolean;
900
+ isInitialLoading: boolean;
901
+ isPaused: boolean;
902
+ isRefetching: boolean;
903
+ isStale: boolean;
904
+ isEnabled: boolean;
905
+ refetch: (options?: RefetchOptions) => Promise<QueryObserverResult<InfiniteData<{
906
+ itemIds: never[];
907
+ dataset: null;
908
+ data: null;
909
+ pageUri?: undefined;
910
+ } | {
911
+ itemIds: string[];
912
+ dataset: null;
913
+ pageUri: string;
914
+ data: null;
915
+ } | {
916
+ dataset: ConnectedLdoDataset<SolidConnectedPlugin[]>;
917
+ itemIds: string[];
918
+ pageUri: string;
919
+ data: OrderedCollectionPage;
920
+ }, unknown>, Error>>;
921
+ fetchStatus: FetchStatus;
922
+ promise: Promise<InfiniteData<{
923
+ itemIds: never[];
924
+ dataset: null;
925
+ data: null;
926
+ pageUri?: undefined;
927
+ } | {
928
+ itemIds: string[];
929
+ dataset: null;
930
+ pageUri: string;
931
+ data: null;
932
+ } | {
933
+ dataset: ConnectedLdoDataset<SolidConnectedPlugin[]>;
934
+ itemIds: string[];
935
+ pageUri: string;
936
+ data: OrderedCollectionPage;
937
+ }, unknown>>;
938
+ };
357
939
  /**
358
940
  * Hook to fetch the inbox of the logged user.
359
941
  * Returns the same data as the useCollection hooks, plus:
@@ -362,71 +944,63 @@ export function ReferenceCollectionField({
362
944
  * See https://semapps.org/docs/frontend/activitypub-components#useinbox for usage
363
945
  * @param {UseCollectionOptions} options Defaults to `{ dereferenceItems: false, liveUpdates: false }`
364
946
  */
365
- export const useInbox: (options?: UseCollectionOptions) =>
366
- | {
367
- error: false | unknown[];
368
- refetch: <TPageData>(
369
- options?: (RefetchOptions & RefetchQueryFilters<TPageData>) | undefined
370
- ) => Promise<QueryObserverResult<InfiniteData<any>, unknown>>;
371
- fetchNextPage: (options?: FetchNextPageOptions | undefined) => Promise<InfiniteQueryObserverResult<any, unknown>>;
372
- addItem: (item: any, shouldRefetch?: number | boolean) => void;
373
- removeItem: (item: any, shouldRefetch?: boolean) => void;
374
- hasNextPage: boolean | undefined;
375
- isLoading: boolean;
376
- isFetching: boolean;
377
- isFetchingNextPage: boolean;
378
- hasLiveUpdates: {
947
+ export const useInbox: (options?: UseCollectionOptions) => {
948
+ error: false | (Error | null)[];
949
+ refetch: (options?: _RefetchOptions1) => Promise<_QueryObserverResult1<_InfiniteData1<any, unknown>, Error>>;
950
+ fetchNextPage: (options?: _FetchNextPageOptions1) => Promise<_InfiniteQueryObserverResult1<_InfiniteData1<any, unknown>, Error>>;
951
+ addItem: (item: string | any, shouldRefetch?: boolean | number) => void;
952
+ removeItem: (item: string | any, shouldRefetch?: boolean) => void;
953
+ hasNextPage: boolean;
954
+ isLoading: boolean;
955
+ isFetching: boolean;
956
+ isFetchingNextPage: boolean;
957
+ hasLiveUpdates: {
379
958
  status: string;
380
959
  error?: any;
381
- };
382
- webSocketRef: MutableRefObject<WebSocket | null>;
383
- url: any;
384
- items: any[];
385
- awaitWebSocketConnection: (options?: AwaitActivityOptions) => Promise<RefObject<WebSocket>>;
386
- awaitActivity: (matchActivity: (activity: object) => boolean, options?: AwaitActivityOptions) => Promise<unknown>;
387
- owner: Identifier | undefined;
388
- }
389
- | {
390
- totalItems: number;
391
- error: false | unknown[];
392
- refetch: <TPageData>(
393
- options?: (RefetchOptions & RefetchQueryFilters<TPageData>) | undefined
394
- ) => Promise<QueryObserverResult<InfiniteData<any>, unknown>>;
395
- fetchNextPage: (options?: FetchNextPageOptions | undefined) => Promise<InfiniteQueryObserverResult<any, unknown>>;
396
- addItem: (item: any, shouldRefetch?: number | boolean) => void;
397
- removeItem: (item: any, shouldRefetch?: boolean) => void;
398
- hasNextPage: boolean | undefined;
399
- isLoading: boolean;
400
- isFetching: boolean;
401
- isFetchingNextPage: boolean;
402
- hasLiveUpdates: {
960
+ };
961
+ webSocketRef: MutableRefObject<WebSocket | null>;
962
+ url: any;
963
+ items: any[];
964
+ awaitWebSocketConnection: (options?: AwaitActivityOptions) => Promise<RefObject<WebSocket>>;
965
+ awaitActivity: (matchActivity: (activity: object) => boolean, options?: AwaitActivityOptions) => Promise<unknown>;
966
+ owner: Identifier | undefined;
967
+ } | {
968
+ totalItems: number;
969
+ error: false | (Error | null)[];
970
+ refetch: (options?: _RefetchOptions1) => Promise<_QueryObserverResult1<_InfiniteData1<any, unknown>, Error>>;
971
+ fetchNextPage: (options?: _FetchNextPageOptions1) => Promise<_InfiniteQueryObserverResult1<_InfiniteData1<any, unknown>, Error>>;
972
+ addItem: (item: string | any, shouldRefetch?: boolean | number) => void;
973
+ removeItem: (item: string | any, shouldRefetch?: boolean) => void;
974
+ hasNextPage: boolean;
975
+ isLoading: boolean;
976
+ isFetching: boolean;
977
+ isFetchingNextPage: boolean;
978
+ hasLiveUpdates: {
403
979
  status: string;
404
980
  error?: any;
405
- };
406
- webSocketRef: MutableRefObject<WebSocket | null>;
407
- url: any;
408
- items: any[];
409
- awaitWebSocketConnection: (options?: AwaitActivityOptions) => Promise<RefObject<WebSocket>>;
410
- awaitActivity: (matchActivity: (activity: object) => boolean, options?: AwaitActivityOptions) => Promise<unknown>;
411
- owner: Identifier | undefined;
412
981
  };
982
+ webSocketRef: MutableRefObject<WebSocket | null>;
983
+ url: any;
984
+ items: any[];
985
+ awaitWebSocketConnection: (options?: AwaitActivityOptions) => Promise<RefObject<WebSocket>>;
986
+ awaitActivity: (matchActivity: (activity: object) => boolean, options?: AwaitActivityOptions) => Promise<unknown>;
987
+ owner: Identifier | undefined;
988
+ };
413
989
  export const useNodeinfo: (host?: string, rel?: string) => NodeInfo | undefined;
414
- export function useWebfinger(): {
415
- fetch: (id: any) => Promise<any>;
990
+ export const useWebfinger: () => {
991
+ fetch: (id: any) => Promise<any>;
416
992
  };
417
- export function useMentions(userResource: any): {
418
- items:
419
- | (({ query }: { query: any }) => {
993
+ export const useMentions: (userResource: any) => {
994
+ items: (({ query }: any) => {
420
995
  id: any;
421
996
  label: any;
422
- }[])
423
- | undefined;
424
- render: () => {
425
- onStart: (props: any) => void;
426
- onUpdate(props: any): void;
427
- onKeyDown(props: any): any;
428
- onExit(): void;
429
- };
997
+ }[]) | undefined;
998
+ render: () => {
999
+ onStart: (props: any) => void;
1000
+ onUpdate(props: any): void;
1001
+ onKeyDown(props: any): any;
1002
+ onExit(): void;
1003
+ };
430
1004
  };
431
1005
 
432
1006
  //# sourceMappingURL=index.d.ts.map