@singi-labs/sifa-sdk 0.9.13 → 0.9.15
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.cjs +40 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +31 -1
- package/dist/index.d.ts +31 -1
- package/dist/index.js +39 -2
- package/dist/index.js.map +1 -1
- package/dist/query/index.d.cts +20 -20
- package/dist/query/index.d.ts +20 -20
- package/package.json +3 -3
package/dist/query/index.d.cts
CHANGED
|
@@ -37,7 +37,7 @@ declare function useSifaConfig(): SifaApiConfig;
|
|
|
37
37
|
* Pass `{ enabled: false }` (or an empty `handleOrDid`) to defer the
|
|
38
38
|
* fetch.
|
|
39
39
|
*/
|
|
40
|
-
declare function useProfile(handleOrDid: string | undefined | null, options?: Omit<UseQueryOptions<Profile | null, Error, Profile | null, ReturnType<typeof sifaQueryKeys.profile.byHandle>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<Profile | null
|
|
40
|
+
declare function useProfile(handleOrDid: string | undefined | null, options?: Omit<UseQueryOptions<Profile | null, Error, Profile | null, ReturnType<typeof sifaQueryKeys.profile.byHandle>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<Profile | null>, Error>;
|
|
41
41
|
/**
|
|
42
42
|
* React hook for a profile's AT Fund link. Returns `null` data on error
|
|
43
43
|
* or when the profile has no link configured.
|
|
@@ -162,7 +162,7 @@ declare function useUpdateProfileLocation(ownerHandleOrDid: string, options?: Om
|
|
|
162
162
|
declare function useDeleteProfileLocation(ownerHandleOrDid: string, options?: Omit<UseMutationOptions<WriteResult, Error, string>, 'mutationFn'>): _tanstack_react_query.UseMutationResult<WriteResult, Error, string, unknown>;
|
|
163
163
|
|
|
164
164
|
/** React hook for reading the external-accounts list. Returns `[]` data on error. */
|
|
165
|
-
declare function useExternalAccounts(handleOrDid: string | undefined | null, options?: Omit<UseQueryOptions<ExternalAccount[], Error, ExternalAccount[], ReturnType<typeof sifaQueryKeys.profile.externalAccounts>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<ExternalAccount[]
|
|
165
|
+
declare function useExternalAccounts(handleOrDid: string | undefined | null, options?: Omit<UseQueryOptions<ExternalAccount[], Error, ExternalAccount[], ReturnType<typeof sifaQueryKeys.profile.externalAccounts>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<ExternalAccount[]>, Error>;
|
|
166
166
|
/** React hook for creating an external account. */
|
|
167
167
|
declare function useCreateExternalAccount(ownerHandleOrDid: string, options?: Omit<UseMutationOptions<CreateExternalAccountResult, Error, ExternalAccountInput>, 'mutationFn'>): _tanstack_react_query.UseMutationResult<CreateExternalAccountResult, Error, ExternalAccountInput, unknown>;
|
|
168
168
|
/** Variables for {@link useUpdateExternalAccount}. */
|
|
@@ -230,43 +230,43 @@ declare const useBulkUnhideProfileItems: (ownerHandleOrDid: string, options?: Om
|
|
|
230
230
|
/**
|
|
231
231
|
* React hook for the public homepage stats. Returns `null` data on error.
|
|
232
232
|
*/
|
|
233
|
-
declare function useStats(options?: Omit<UseQueryOptions<StatsResponse | null, Error, StatsResponse | null, ReturnType<typeof sifaQueryKeys.stats.homepage>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<StatsResponse | null
|
|
233
|
+
declare function useStats(options?: Omit<UseQueryOptions<StatsResponse | null, Error, StatsResponse | null, ReturnType<typeof sifaQueryKeys.stats.homepage>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<StatsResponse | null>, Error>;
|
|
234
234
|
|
|
235
235
|
/** React hook for the public app registry. */
|
|
236
|
-
declare function useAppsRegistry(options?: Omit<UseQueryOptions<AppRegistryEntry[], Error, AppRegistryEntry[], ReturnType<typeof sifaQueryKeys.apps.registry>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<AppRegistryEntry[]
|
|
236
|
+
declare function useAppsRegistry(options?: Omit<UseQueryOptions<AppRegistryEntry[], Error, AppRegistryEntry[], ReturnType<typeof sifaQueryKeys.apps.registry>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<AppRegistryEntry[]>, Error>;
|
|
237
237
|
/**
|
|
238
238
|
* React hook for the authenticated user's hidden-apps list. Requires a
|
|
239
239
|
* client-side session (relies on `credentials: 'include'`).
|
|
240
240
|
*/
|
|
241
|
-
declare function useHiddenApps(options?: Omit<UseQueryOptions<HiddenApp[], Error, HiddenApp[], ReturnType<typeof sifaQueryKeys.apps.hidden>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<HiddenApp[]
|
|
241
|
+
declare function useHiddenApps(options?: Omit<UseQueryOptions<HiddenApp[], Error, HiddenApp[], ReturnType<typeof sifaQueryKeys.apps.hidden>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<HiddenApp[]>, Error>;
|
|
242
242
|
|
|
243
|
-
declare function useSearchProfiles(filters: SearchFilters, options?: Omit<UseQueryOptions<SearchResponse, Error, SearchResponse, ReturnType<typeof sifaQueryKeys.search.profiles>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<SearchResponse
|
|
244
|
-
declare function useSkillSuggestions(query: string, options?: Omit<UseQueryOptions<SkillSearchResult[], Error, SkillSearchResult[], ReturnType<typeof sifaQueryKeys.search.skills>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<SkillSearchResult[]
|
|
243
|
+
declare function useSearchProfiles(filters: SearchFilters, options?: Omit<UseQueryOptions<SearchResponse, Error, SearchResponse, ReturnType<typeof sifaQueryKeys.search.profiles>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<SearchResponse>, Error>;
|
|
244
|
+
declare function useSkillSuggestions(query: string, options?: Omit<UseQueryOptions<SkillSearchResult[], Error, SkillSearchResult[], ReturnType<typeof sifaQueryKeys.search.skills>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<SkillSearchResult[]>, Error>;
|
|
245
245
|
/**
|
|
246
246
|
* Canonical-skill search hook. Hits `/api/skills/search` (the
|
|
247
247
|
* canonical-skills DB lookup, distinct from {@link useSkillSuggestions}'s
|
|
248
248
|
* `/api/search/skills` profile-skill typeahead). Skips the network call
|
|
249
249
|
* when the query is empty.
|
|
250
250
|
*/
|
|
251
|
-
declare function useCanonicalSkillSearch(query: string, limit?: number, options?: Omit<UseQueryOptions<SkillSuggestion[], Error, SkillSuggestion[], ReturnType<typeof sifaQueryKeys.search.canonicalSkills>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<SkillSuggestion[]
|
|
252
|
-
declare function useSearchFilters(options?: Omit<UseQueryOptions<FilterOptions, Error, FilterOptions, ReturnType<typeof sifaQueryKeys.search.filters>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<FilterOptions
|
|
251
|
+
declare function useCanonicalSkillSearch(query: string, limit?: number, options?: Omit<UseQueryOptions<SkillSuggestion[], Error, SkillSuggestion[], ReturnType<typeof sifaQueryKeys.search.canonicalSkills>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<SkillSuggestion[]>, Error>;
|
|
252
|
+
declare function useSearchFilters(options?: Omit<UseQueryOptions<FilterOptions, Error, FilterOptions, ReturnType<typeof sifaQueryKeys.search.filters>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<FilterOptions>, Error>;
|
|
253
253
|
|
|
254
254
|
declare function useSimilarProfiles(did: string | undefined | null, opts?: {
|
|
255
255
|
limit?: number;
|
|
256
|
-
}, options?: Omit<UseQueryOptions<SimilarProfile[], Error, SimilarProfile[], ReturnType<typeof sifaQueryKeys.discovery.similar>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<SimilarProfile[]
|
|
257
|
-
declare function useSuggestions(opts?: Omit<FetchSuggestionsOptions, keyof Omit<FetchSuggestionsOptions, 'source' | 'includeDismissed' | 'cursor' | 'limit'>>, options?: Omit<UseQueryOptions<SuggestionsResponse, Error, SuggestionsResponse, ReturnType<typeof sifaQueryKeys.discovery.suggestions>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<SuggestionsResponse
|
|
256
|
+
}, options?: Omit<UseQueryOptions<SimilarProfile[], Error, SimilarProfile[], ReturnType<typeof sifaQueryKeys.discovery.similar>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<SimilarProfile[]>, Error>;
|
|
257
|
+
declare function useSuggestions(opts?: Omit<FetchSuggestionsOptions, keyof Omit<FetchSuggestionsOptions, 'source' | 'includeDismissed' | 'cursor' | 'limit'>>, options?: Omit<UseQueryOptions<SuggestionsResponse, Error, SuggestionsResponse, ReturnType<typeof sifaQueryKeys.discovery.suggestions>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<SuggestionsResponse>, Error>;
|
|
258
258
|
declare function useSuggestionCount(since?: string, options?: Omit<UseQueryOptions<number, Error, number, ReturnType<typeof sifaQueryKeys.discovery.suggestionCount>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<number, Error>;
|
|
259
|
-
declare function useFeaturedProfile(options?: Omit<UseQueryOptions<FeaturedProfile | null, Error, FeaturedProfile | null, ReturnType<typeof sifaQueryKeys.discovery.featured>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<FeaturedProfile | null
|
|
259
|
+
declare function useFeaturedProfile(options?: Omit<UseQueryOptions<FeaturedProfile | null, Error, FeaturedProfile | null, ReturnType<typeof sifaQueryKeys.discovery.featured>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<FeaturedProfile | null>, Error>;
|
|
260
260
|
|
|
261
261
|
declare function useFollowing(opts?: {
|
|
262
262
|
source?: string;
|
|
263
263
|
cursor?: string;
|
|
264
264
|
limit?: number;
|
|
265
|
-
}, options?: Omit<UseQueryOptions<FollowingResponse, Error, FollowingResponse, ReturnType<typeof sifaQueryKeys.follow.following>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<FollowingResponse
|
|
265
|
+
}, options?: Omit<UseQueryOptions<FollowingResponse, Error, FollowingResponse, ReturnType<typeof sifaQueryKeys.follow.following>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<FollowingResponse>, Error>;
|
|
266
266
|
|
|
267
|
-
declare function useHeatmapData(handleOrDid: string | undefined | null, days: number, options?: Omit<UseQueryOptions<HeatmapResponse | null, Error, HeatmapResponse | null, ReturnType<typeof sifaQueryKeys.activity.heatmap>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<HeatmapResponse | null
|
|
268
|
-
declare function useActivityTeaser(handleOrDid: string | undefined | null, options?: Omit<UseQueryOptions<ActivityTeaserResponse | null, Error, ActivityTeaserResponse | null, ReturnType<typeof sifaQueryKeys.activity.teaser>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<ActivityTeaserResponse | null
|
|
269
|
-
declare function useActivityFeed(handleOrDid: string | undefined | null, opts?: Pick<FetchActivityFeedOptions, 'category' | 'limit' | 'cursor'>, options?: Omit<UseQueryOptions<ActivityFeedResponse | null, Error, ActivityFeedResponse | null, ReturnType<typeof sifaQueryKeys.activity.feed>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<ActivityFeedResponse | null
|
|
267
|
+
declare function useHeatmapData(handleOrDid: string | undefined | null, days: number, options?: Omit<UseQueryOptions<HeatmapResponse | null, Error, HeatmapResponse | null, ReturnType<typeof sifaQueryKeys.activity.heatmap>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<HeatmapResponse | null>, Error>;
|
|
268
|
+
declare function useActivityTeaser(handleOrDid: string | undefined | null, options?: Omit<UseQueryOptions<ActivityTeaserResponse | null, Error, ActivityTeaserResponse | null, ReturnType<typeof sifaQueryKeys.activity.teaser>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<ActivityTeaserResponse | null>, Error>;
|
|
269
|
+
declare function useActivityFeed(handleOrDid: string | undefined | null, opts?: Pick<FetchActivityFeedOptions, 'category' | 'limit' | 'cursor'>, options?: Omit<UseQueryOptions<ActivityFeedResponse | null, Error, ActivityFeedResponse | null, ReturnType<typeof sifaQueryKeys.activity.feed>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<ActivityFeedResponse | null>, Error>;
|
|
270
270
|
|
|
271
271
|
/** Count of confirmed endorsements for a DID. Returns 0 on error. */
|
|
272
272
|
declare function useEndorsementCount(did: string | undefined | null, options?: Omit<UseQueryOptions<number, Error, number, ReturnType<typeof sifaQueryKeys.endorsement.count>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<number, Error>;
|
|
@@ -281,9 +281,9 @@ declare function useNetworkStreamCount(did: string | undefined | null, options?:
|
|
|
281
281
|
* Batch-look up reaction status for multiple URIs. Skips the network call
|
|
282
282
|
* when `uris` is empty.
|
|
283
283
|
*/
|
|
284
|
-
declare function useReactionStatus(uris: string[], options?: Omit<UseQueryOptions<Record<string, ReactionStatus> | null, Error, Record<string, ReactionStatus> | null, ReturnType<typeof sifaQueryKeys.reactions.status>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<Record<string, ReactionStatus> | null
|
|
284
|
+
declare function useReactionStatus(uris: string[], options?: Omit<UseQueryOptions<Record<string, ReactionStatus> | null, Error, Record<string, ReactionStatus> | null, ReturnType<typeof sifaQueryKeys.reactions.status>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<Record<string, ReactionStatus> | null>, Error>;
|
|
285
285
|
/** Check whether the authenticated viewer has an account on the given app. */
|
|
286
|
-
declare function useAppAccountCheck(appId: string | undefined | null, options?: Omit<UseQueryOptions<AccountCheckResult | null, Error, AccountCheckResult | null, ReturnType<typeof sifaQueryKeys.reactions.accountCheck>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<AccountCheckResult | null
|
|
286
|
+
declare function useAppAccountCheck(appId: string | undefined | null, options?: Omit<UseQueryOptions<AccountCheckResult | null, Error, AccountCheckResult | null, ReturnType<typeof sifaQueryKeys.reactions.accountCheck>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<AccountCheckResult | null>, Error>;
|
|
287
287
|
|
|
288
288
|
/** Variables for {@link useCreateReaction}. */
|
|
289
289
|
interface CreateReactionVariables {
|
|
@@ -323,9 +323,9 @@ interface DeleteReactionVariables {
|
|
|
323
323
|
declare function useDeleteReaction(options?: Omit<UseMutationOptions<WriteResult, Error, DeleteReactionVariables>, 'mutationFn'>): _tanstack_react_query.UseMutationResult<WriteResult, Error, DeleteReactionVariables, unknown>;
|
|
324
324
|
|
|
325
325
|
/** Public roadmap vote tallies. Returns `{}` data on error. */
|
|
326
|
-
declare function useRoadmapVotes(options?: Omit<UseQueryOptions<RoadmapVotesResponse, Error, RoadmapVotesResponse, ReturnType<typeof sifaQueryKeys.roadmap.votes>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<RoadmapVotesResponse
|
|
326
|
+
declare function useRoadmapVotes(options?: Omit<UseQueryOptions<RoadmapVotesResponse, Error, RoadmapVotesResponse, ReturnType<typeof sifaQueryKeys.roadmap.votes>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<RoadmapVotesResponse>, Error>;
|
|
327
327
|
/** Roadmap items the authenticated viewer has voted on. Returns `[]` data on error. */
|
|
328
|
-
declare function useMyRoadmapVotes(options?: Omit<UseQueryOptions<string[], Error, string[], ReturnType<typeof sifaQueryKeys.roadmap.myVotes>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<string[]
|
|
328
|
+
declare function useMyRoadmapVotes(options?: Omit<UseQueryOptions<string[], Error, string[], ReturnType<typeof sifaQueryKeys.roadmap.myVotes>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<string[]>, Error>;
|
|
329
329
|
|
|
330
330
|
/** React hook for casting a roadmap vote. Variable: the item key. */
|
|
331
331
|
declare function useCastRoadmapVote(options?: Omit<UseMutationOptions<WriteResult, Error, string>, 'mutationFn'>): _tanstack_react_query.UseMutationResult<WriteResult, Error, string, unknown>;
|
package/dist/query/index.d.ts
CHANGED
|
@@ -37,7 +37,7 @@ declare function useSifaConfig(): SifaApiConfig;
|
|
|
37
37
|
* Pass `{ enabled: false }` (or an empty `handleOrDid`) to defer the
|
|
38
38
|
* fetch.
|
|
39
39
|
*/
|
|
40
|
-
declare function useProfile(handleOrDid: string | undefined | null, options?: Omit<UseQueryOptions<Profile | null, Error, Profile | null, ReturnType<typeof sifaQueryKeys.profile.byHandle>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<Profile | null
|
|
40
|
+
declare function useProfile(handleOrDid: string | undefined | null, options?: Omit<UseQueryOptions<Profile | null, Error, Profile | null, ReturnType<typeof sifaQueryKeys.profile.byHandle>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<Profile | null>, Error>;
|
|
41
41
|
/**
|
|
42
42
|
* React hook for a profile's AT Fund link. Returns `null` data on error
|
|
43
43
|
* or when the profile has no link configured.
|
|
@@ -162,7 +162,7 @@ declare function useUpdateProfileLocation(ownerHandleOrDid: string, options?: Om
|
|
|
162
162
|
declare function useDeleteProfileLocation(ownerHandleOrDid: string, options?: Omit<UseMutationOptions<WriteResult, Error, string>, 'mutationFn'>): _tanstack_react_query.UseMutationResult<WriteResult, Error, string, unknown>;
|
|
163
163
|
|
|
164
164
|
/** React hook for reading the external-accounts list. Returns `[]` data on error. */
|
|
165
|
-
declare function useExternalAccounts(handleOrDid: string | undefined | null, options?: Omit<UseQueryOptions<ExternalAccount[], Error, ExternalAccount[], ReturnType<typeof sifaQueryKeys.profile.externalAccounts>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<ExternalAccount[]
|
|
165
|
+
declare function useExternalAccounts(handleOrDid: string | undefined | null, options?: Omit<UseQueryOptions<ExternalAccount[], Error, ExternalAccount[], ReturnType<typeof sifaQueryKeys.profile.externalAccounts>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<ExternalAccount[]>, Error>;
|
|
166
166
|
/** React hook for creating an external account. */
|
|
167
167
|
declare function useCreateExternalAccount(ownerHandleOrDid: string, options?: Omit<UseMutationOptions<CreateExternalAccountResult, Error, ExternalAccountInput>, 'mutationFn'>): _tanstack_react_query.UseMutationResult<CreateExternalAccountResult, Error, ExternalAccountInput, unknown>;
|
|
168
168
|
/** Variables for {@link useUpdateExternalAccount}. */
|
|
@@ -230,43 +230,43 @@ declare const useBulkUnhideProfileItems: (ownerHandleOrDid: string, options?: Om
|
|
|
230
230
|
/**
|
|
231
231
|
* React hook for the public homepage stats. Returns `null` data on error.
|
|
232
232
|
*/
|
|
233
|
-
declare function useStats(options?: Omit<UseQueryOptions<StatsResponse | null, Error, StatsResponse | null, ReturnType<typeof sifaQueryKeys.stats.homepage>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<StatsResponse | null
|
|
233
|
+
declare function useStats(options?: Omit<UseQueryOptions<StatsResponse | null, Error, StatsResponse | null, ReturnType<typeof sifaQueryKeys.stats.homepage>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<StatsResponse | null>, Error>;
|
|
234
234
|
|
|
235
235
|
/** React hook for the public app registry. */
|
|
236
|
-
declare function useAppsRegistry(options?: Omit<UseQueryOptions<AppRegistryEntry[], Error, AppRegistryEntry[], ReturnType<typeof sifaQueryKeys.apps.registry>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<AppRegistryEntry[]
|
|
236
|
+
declare function useAppsRegistry(options?: Omit<UseQueryOptions<AppRegistryEntry[], Error, AppRegistryEntry[], ReturnType<typeof sifaQueryKeys.apps.registry>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<AppRegistryEntry[]>, Error>;
|
|
237
237
|
/**
|
|
238
238
|
* React hook for the authenticated user's hidden-apps list. Requires a
|
|
239
239
|
* client-side session (relies on `credentials: 'include'`).
|
|
240
240
|
*/
|
|
241
|
-
declare function useHiddenApps(options?: Omit<UseQueryOptions<HiddenApp[], Error, HiddenApp[], ReturnType<typeof sifaQueryKeys.apps.hidden>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<HiddenApp[]
|
|
241
|
+
declare function useHiddenApps(options?: Omit<UseQueryOptions<HiddenApp[], Error, HiddenApp[], ReturnType<typeof sifaQueryKeys.apps.hidden>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<HiddenApp[]>, Error>;
|
|
242
242
|
|
|
243
|
-
declare function useSearchProfiles(filters: SearchFilters, options?: Omit<UseQueryOptions<SearchResponse, Error, SearchResponse, ReturnType<typeof sifaQueryKeys.search.profiles>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<SearchResponse
|
|
244
|
-
declare function useSkillSuggestions(query: string, options?: Omit<UseQueryOptions<SkillSearchResult[], Error, SkillSearchResult[], ReturnType<typeof sifaQueryKeys.search.skills>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<SkillSearchResult[]
|
|
243
|
+
declare function useSearchProfiles(filters: SearchFilters, options?: Omit<UseQueryOptions<SearchResponse, Error, SearchResponse, ReturnType<typeof sifaQueryKeys.search.profiles>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<SearchResponse>, Error>;
|
|
244
|
+
declare function useSkillSuggestions(query: string, options?: Omit<UseQueryOptions<SkillSearchResult[], Error, SkillSearchResult[], ReturnType<typeof sifaQueryKeys.search.skills>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<SkillSearchResult[]>, Error>;
|
|
245
245
|
/**
|
|
246
246
|
* Canonical-skill search hook. Hits `/api/skills/search` (the
|
|
247
247
|
* canonical-skills DB lookup, distinct from {@link useSkillSuggestions}'s
|
|
248
248
|
* `/api/search/skills` profile-skill typeahead). Skips the network call
|
|
249
249
|
* when the query is empty.
|
|
250
250
|
*/
|
|
251
|
-
declare function useCanonicalSkillSearch(query: string, limit?: number, options?: Omit<UseQueryOptions<SkillSuggestion[], Error, SkillSuggestion[], ReturnType<typeof sifaQueryKeys.search.canonicalSkills>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<SkillSuggestion[]
|
|
252
|
-
declare function useSearchFilters(options?: Omit<UseQueryOptions<FilterOptions, Error, FilterOptions, ReturnType<typeof sifaQueryKeys.search.filters>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<FilterOptions
|
|
251
|
+
declare function useCanonicalSkillSearch(query: string, limit?: number, options?: Omit<UseQueryOptions<SkillSuggestion[], Error, SkillSuggestion[], ReturnType<typeof sifaQueryKeys.search.canonicalSkills>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<SkillSuggestion[]>, Error>;
|
|
252
|
+
declare function useSearchFilters(options?: Omit<UseQueryOptions<FilterOptions, Error, FilterOptions, ReturnType<typeof sifaQueryKeys.search.filters>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<FilterOptions>, Error>;
|
|
253
253
|
|
|
254
254
|
declare function useSimilarProfiles(did: string | undefined | null, opts?: {
|
|
255
255
|
limit?: number;
|
|
256
|
-
}, options?: Omit<UseQueryOptions<SimilarProfile[], Error, SimilarProfile[], ReturnType<typeof sifaQueryKeys.discovery.similar>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<SimilarProfile[]
|
|
257
|
-
declare function useSuggestions(opts?: Omit<FetchSuggestionsOptions, keyof Omit<FetchSuggestionsOptions, 'source' | 'includeDismissed' | 'cursor' | 'limit'>>, options?: Omit<UseQueryOptions<SuggestionsResponse, Error, SuggestionsResponse, ReturnType<typeof sifaQueryKeys.discovery.suggestions>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<SuggestionsResponse
|
|
256
|
+
}, options?: Omit<UseQueryOptions<SimilarProfile[], Error, SimilarProfile[], ReturnType<typeof sifaQueryKeys.discovery.similar>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<SimilarProfile[]>, Error>;
|
|
257
|
+
declare function useSuggestions(opts?: Omit<FetchSuggestionsOptions, keyof Omit<FetchSuggestionsOptions, 'source' | 'includeDismissed' | 'cursor' | 'limit'>>, options?: Omit<UseQueryOptions<SuggestionsResponse, Error, SuggestionsResponse, ReturnType<typeof sifaQueryKeys.discovery.suggestions>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<SuggestionsResponse>, Error>;
|
|
258
258
|
declare function useSuggestionCount(since?: string, options?: Omit<UseQueryOptions<number, Error, number, ReturnType<typeof sifaQueryKeys.discovery.suggestionCount>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<number, Error>;
|
|
259
|
-
declare function useFeaturedProfile(options?: Omit<UseQueryOptions<FeaturedProfile | null, Error, FeaturedProfile | null, ReturnType<typeof sifaQueryKeys.discovery.featured>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<FeaturedProfile | null
|
|
259
|
+
declare function useFeaturedProfile(options?: Omit<UseQueryOptions<FeaturedProfile | null, Error, FeaturedProfile | null, ReturnType<typeof sifaQueryKeys.discovery.featured>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<FeaturedProfile | null>, Error>;
|
|
260
260
|
|
|
261
261
|
declare function useFollowing(opts?: {
|
|
262
262
|
source?: string;
|
|
263
263
|
cursor?: string;
|
|
264
264
|
limit?: number;
|
|
265
|
-
}, options?: Omit<UseQueryOptions<FollowingResponse, Error, FollowingResponse, ReturnType<typeof sifaQueryKeys.follow.following>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<FollowingResponse
|
|
265
|
+
}, options?: Omit<UseQueryOptions<FollowingResponse, Error, FollowingResponse, ReturnType<typeof sifaQueryKeys.follow.following>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<FollowingResponse>, Error>;
|
|
266
266
|
|
|
267
|
-
declare function useHeatmapData(handleOrDid: string | undefined | null, days: number, options?: Omit<UseQueryOptions<HeatmapResponse | null, Error, HeatmapResponse | null, ReturnType<typeof sifaQueryKeys.activity.heatmap>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<HeatmapResponse | null
|
|
268
|
-
declare function useActivityTeaser(handleOrDid: string | undefined | null, options?: Omit<UseQueryOptions<ActivityTeaserResponse | null, Error, ActivityTeaserResponse | null, ReturnType<typeof sifaQueryKeys.activity.teaser>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<ActivityTeaserResponse | null
|
|
269
|
-
declare function useActivityFeed(handleOrDid: string | undefined | null, opts?: Pick<FetchActivityFeedOptions, 'category' | 'limit' | 'cursor'>, options?: Omit<UseQueryOptions<ActivityFeedResponse | null, Error, ActivityFeedResponse | null, ReturnType<typeof sifaQueryKeys.activity.feed>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<ActivityFeedResponse | null
|
|
267
|
+
declare function useHeatmapData(handleOrDid: string | undefined | null, days: number, options?: Omit<UseQueryOptions<HeatmapResponse | null, Error, HeatmapResponse | null, ReturnType<typeof sifaQueryKeys.activity.heatmap>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<HeatmapResponse | null>, Error>;
|
|
268
|
+
declare function useActivityTeaser(handleOrDid: string | undefined | null, options?: Omit<UseQueryOptions<ActivityTeaserResponse | null, Error, ActivityTeaserResponse | null, ReturnType<typeof sifaQueryKeys.activity.teaser>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<ActivityTeaserResponse | null>, Error>;
|
|
269
|
+
declare function useActivityFeed(handleOrDid: string | undefined | null, opts?: Pick<FetchActivityFeedOptions, 'category' | 'limit' | 'cursor'>, options?: Omit<UseQueryOptions<ActivityFeedResponse | null, Error, ActivityFeedResponse | null, ReturnType<typeof sifaQueryKeys.activity.feed>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<ActivityFeedResponse | null>, Error>;
|
|
270
270
|
|
|
271
271
|
/** Count of confirmed endorsements for a DID. Returns 0 on error. */
|
|
272
272
|
declare function useEndorsementCount(did: string | undefined | null, options?: Omit<UseQueryOptions<number, Error, number, ReturnType<typeof sifaQueryKeys.endorsement.count>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<number, Error>;
|
|
@@ -281,9 +281,9 @@ declare function useNetworkStreamCount(did: string | undefined | null, options?:
|
|
|
281
281
|
* Batch-look up reaction status for multiple URIs. Skips the network call
|
|
282
282
|
* when `uris` is empty.
|
|
283
283
|
*/
|
|
284
|
-
declare function useReactionStatus(uris: string[], options?: Omit<UseQueryOptions<Record<string, ReactionStatus> | null, Error, Record<string, ReactionStatus> | null, ReturnType<typeof sifaQueryKeys.reactions.status>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<Record<string, ReactionStatus> | null
|
|
284
|
+
declare function useReactionStatus(uris: string[], options?: Omit<UseQueryOptions<Record<string, ReactionStatus> | null, Error, Record<string, ReactionStatus> | null, ReturnType<typeof sifaQueryKeys.reactions.status>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<Record<string, ReactionStatus> | null>, Error>;
|
|
285
285
|
/** Check whether the authenticated viewer has an account on the given app. */
|
|
286
|
-
declare function useAppAccountCheck(appId: string | undefined | null, options?: Omit<UseQueryOptions<AccountCheckResult | null, Error, AccountCheckResult | null, ReturnType<typeof sifaQueryKeys.reactions.accountCheck>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<AccountCheckResult | null
|
|
286
|
+
declare function useAppAccountCheck(appId: string | undefined | null, options?: Omit<UseQueryOptions<AccountCheckResult | null, Error, AccountCheckResult | null, ReturnType<typeof sifaQueryKeys.reactions.accountCheck>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<AccountCheckResult | null>, Error>;
|
|
287
287
|
|
|
288
288
|
/** Variables for {@link useCreateReaction}. */
|
|
289
289
|
interface CreateReactionVariables {
|
|
@@ -323,9 +323,9 @@ interface DeleteReactionVariables {
|
|
|
323
323
|
declare function useDeleteReaction(options?: Omit<UseMutationOptions<WriteResult, Error, DeleteReactionVariables>, 'mutationFn'>): _tanstack_react_query.UseMutationResult<WriteResult, Error, DeleteReactionVariables, unknown>;
|
|
324
324
|
|
|
325
325
|
/** Public roadmap vote tallies. Returns `{}` data on error. */
|
|
326
|
-
declare function useRoadmapVotes(options?: Omit<UseQueryOptions<RoadmapVotesResponse, Error, RoadmapVotesResponse, ReturnType<typeof sifaQueryKeys.roadmap.votes>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<RoadmapVotesResponse
|
|
326
|
+
declare function useRoadmapVotes(options?: Omit<UseQueryOptions<RoadmapVotesResponse, Error, RoadmapVotesResponse, ReturnType<typeof sifaQueryKeys.roadmap.votes>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<RoadmapVotesResponse>, Error>;
|
|
327
327
|
/** Roadmap items the authenticated viewer has voted on. Returns `[]` data on error. */
|
|
328
|
-
declare function useMyRoadmapVotes(options?: Omit<UseQueryOptions<string[], Error, string[], ReturnType<typeof sifaQueryKeys.roadmap.myVotes>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<string[]
|
|
328
|
+
declare function useMyRoadmapVotes(options?: Omit<UseQueryOptions<string[], Error, string[], ReturnType<typeof sifaQueryKeys.roadmap.myVotes>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<string[]>, Error>;
|
|
329
329
|
|
|
330
330
|
/** React hook for casting a roadmap vote. Variable: the item key. */
|
|
331
331
|
declare function useCastRoadmapVote(options?: Omit<UseMutationOptions<WriteResult, Error, string>, 'mutationFn'>): _tanstack_react_query.UseMutationResult<WriteResult, Error, string, unknown>;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@singi-labs/sifa-sdk",
|
|
3
|
-
"version": "0.9.
|
|
3
|
+
"version": "0.9.15",
|
|
4
4
|
"description": "Sifa SDK — public client library for the Sifa AppView on AT Protocol. Shared by sifa-web and sifa-app.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -142,7 +142,7 @@
|
|
|
142
142
|
"@changesets/cli": "2.31.0",
|
|
143
143
|
"@commitlint/cli": "21.0.1",
|
|
144
144
|
"@commitlint/config-conventional": "21.0.1",
|
|
145
|
-
"@tanstack/react-query": "5.100.
|
|
145
|
+
"@tanstack/react-query": "5.100.14",
|
|
146
146
|
"@testing-library/react": "16.3.2",
|
|
147
147
|
"@types/react": "19.2.14",
|
|
148
148
|
"@vitest/coverage-v8": "3.2.1",
|
|
@@ -154,7 +154,7 @@
|
|
|
154
154
|
"react-dom": "19.2.4",
|
|
155
155
|
"tsup": "8.5.1",
|
|
156
156
|
"typescript": "5.9.3",
|
|
157
|
-
"typescript-eslint": "8.
|
|
157
|
+
"typescript-eslint": "8.60.0",
|
|
158
158
|
"vitest": "3.2.1"
|
|
159
159
|
}
|
|
160
160
|
}
|