@singi-labs/sifa-sdk 0.10.17 → 0.11.0

package/dist/query/hooks/index.d.cts

@@ -1,7 +1,7 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { ReactNode } from 'react';
-import { S as SifaApiConfig, s as sifaQueryKeys, W as WriteResult, a4 as RefreshPdsResult, ag as UpdateProfileOverrideInput, ah as UpdateProfileSelfInput, ai as UploadAvatarResult, i as CreateResult, T as ProfileLocationInput, j as ExternalAccountInput, h as CreateExternalAccountResult, aj as VerifyExternalAccountResult, E as EndorsementInput, a3 as RefreshOrcidPublicationsResult, B as BulkHideProfileItemInput, O as HideProfileItemInput, ad as StatsResponse, g as AppRegistryEntry, L as HiddenApp, v as FilterOptions, a8 as SearchFilters, a9 as SearchResponse, ac as SkillSearchResult, k as FeaturedProfile, ab as SimilarProfile, u as FetchSuggestionsOptions, af as SuggestionsResponse, z as FollowUserResult, n as FetchFollowListOptions, w as FollowListPage, G as FollowingResponse, p as FetchFollowingFeedOptions, o as FetchFollowProfilePageOptions, y as FollowProfilePageResponse, F as FeatureAllowlistResponse, l as FetchActivityFeedOptions, b as ActivityFeedResponse, e as ActivityTeaserResponse, K as HeatmapResponse, a as AccountCheckResult, a2 as ReactionStatus, a1 as ReactionResult, a0 as ReactionError, a7 as RoadmapVotesResponse, D as DeleteAccountResult } from '../../keys-CMaEcp0g.cjs';
-export { aa as SifaQueryKey } from '../../keys-CMaEcp0g.cjs';
+import { S as SifaApiConfig, s as sifaQueryKeys, W as WriteResult, a5 as RefreshPdsResult, aj as UpdateProfileOverrideInput, ak as UpdateProfileSelfInput, al as UploadAvatarResult, j as CreateResult, U as ProfileLocationInput, k as ExternalAccountInput, i as CreateExternalAccountResult, am as VerifyExternalAccountResult, E as EndorsementInput, a4 as RefreshOrcidPublicationsResult, B as BulkHideProfileItemInput, P as HideProfileItemInput, ag as StatsResponse, g as AppRegistryEntry, M as HiddenApp, w as FilterOptions, ab as SearchFilters, ac as SearchResponse, af as SkillSearchResult, l as FeaturedProfile, ae as SimilarProfile, v as FetchSuggestionsOptions, ai as SuggestionsResponse, G as FollowUserResult, o as FetchFollowListOptions, x as FollowListPage, H as FollowingResponse, q as FetchFollowingFeedOptions, p as FetchFollowProfilePageOptions, z as FollowProfilePageResponse, F as FeatureAllowlistResponse, m as FetchActivityFeedOptions, b as ActivityFeedResponse, e as ActivityTeaserResponse, L as HeatmapResponse, a as AccountCheckResult, a3 as ReactionStatus, a2 as ReactionResult, a1 as ReactionError, aa as RoadmapVotesResponse, C as CastRoadmapVoteResult, D as DeleteAccountResult } from '../../keys-BDzlCEo1.cjs';
+export { ad as SifaQueryKey } from '../../keys-BDzlCEo1.cjs';
 import * as _tanstack_react_query from '@tanstack/react-query';
 import { UseQueryOptions, UseMutationOptions, UseInfiniteQueryOptions, InfiniteData } from '@tanstack/react-query';
 import { c as Profile, r as ProfilePosition, w as SkillRef, E as ExternalAccount, S as SkillSuggestion } from '../../adult-content-o0BxhFzc.cjs';
@@ -459,8 +459,14 @@ declare function useRoadmapVotes(options?: Omit<UseQueryOptions<RoadmapVotesResp
 /** Roadmap items the authenticated viewer has voted on. Returns `[]` data on error. */
 declare function useMyRoadmapVotes(options?: Omit<UseQueryOptions<string[], Error, string[], ReturnType<typeof sifaQueryKeys.roadmap.myVotes>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<string[]>, Error>;
 
-/** React hook for casting a roadmap vote. Variable: the item key. */
-declare function useCastRoadmapVote(options?: Omit<UseMutationOptions<WriteResult, Error, string>, 'mutationFn'>): _tanstack_react_query.UseMutationResult<WriteResult, Error, string, unknown>;
+/**
+ * React hook for casting a roadmap vote. Variable: the item key.
+ *
+ * Returns the discriminated-union result so callers can detect
+ * `scope_insufficient` and trigger an OAuth scope-upgrade flow
+ * (see {@link castRoadmapVote}).
+ */
+declare function useCastRoadmapVote(options?: Omit<UseMutationOptions<CastRoadmapVoteResult, Error, string>, 'mutationFn'>): _tanstack_react_query.UseMutationResult<CastRoadmapVoteResult, Error, string, unknown>;
 /** React hook for retracting a previously-cast roadmap vote. */
 declare function useRetractRoadmapVote(options?: Omit<UseMutationOptions<WriteResult, Error, string>, 'mutationFn'>): _tanstack_react_query.UseMutationResult<WriteResult, Error, string, unknown>;
 

package/dist/query/hooks/index.d.ts

@@ -1,7 +1,7 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { ReactNode } from 'react';
-import { S as SifaApiConfig, s as sifaQueryKeys, W as WriteResult, a4 as RefreshPdsResult, ag as UpdateProfileOverrideInput, ah as UpdateProfileSelfInput, ai as UploadAvatarResult, i as CreateResult, T as ProfileLocationInput, j as ExternalAccountInput, h as CreateExternalAccountResult, aj as VerifyExternalAccountResult, E as EndorsementInput, a3 as RefreshOrcidPublicationsResult, B as BulkHideProfileItemInput, O as HideProfileItemInput, ad as StatsResponse, g as AppRegistryEntry, L as HiddenApp, v as FilterOptions, a8 as SearchFilters, a9 as SearchResponse, ac as SkillSearchResult, k as FeaturedProfile, ab as SimilarProfile, u as FetchSuggestionsOptions, af as SuggestionsResponse, z as FollowUserResult, n as FetchFollowListOptions, w as FollowListPage, G as FollowingResponse, p as FetchFollowingFeedOptions, o as FetchFollowProfilePageOptions, y as FollowProfilePageResponse, F as FeatureAllowlistResponse, l as FetchActivityFeedOptions, b as ActivityFeedResponse, e as ActivityTeaserResponse, K as HeatmapResponse, a as AccountCheckResult, a2 as ReactionStatus, a1 as ReactionResult, a0 as ReactionError, a7 as RoadmapVotesResponse, D as DeleteAccountResult } from '../../keys-B_Z735bY.js';
-export { aa as SifaQueryKey } from '../../keys-B_Z735bY.js';
+import { S as SifaApiConfig, s as sifaQueryKeys, W as WriteResult, a5 as RefreshPdsResult, aj as UpdateProfileOverrideInput, ak as UpdateProfileSelfInput, al as UploadAvatarResult, j as CreateResult, U as ProfileLocationInput, k as ExternalAccountInput, i as CreateExternalAccountResult, am as VerifyExternalAccountResult, E as EndorsementInput, a4 as RefreshOrcidPublicationsResult, B as BulkHideProfileItemInput, P as HideProfileItemInput, ag as StatsResponse, g as AppRegistryEntry, M as HiddenApp, w as FilterOptions, ab as SearchFilters, ac as SearchResponse, af as SkillSearchResult, l as FeaturedProfile, ae as SimilarProfile, v as FetchSuggestionsOptions, ai as SuggestionsResponse, G as FollowUserResult, o as FetchFollowListOptions, x as FollowListPage, H as FollowingResponse, q as FetchFollowingFeedOptions, p as FetchFollowProfilePageOptions, z as FollowProfilePageResponse, F as FeatureAllowlistResponse, m as FetchActivityFeedOptions, b as ActivityFeedResponse, e as ActivityTeaserResponse, L as HeatmapResponse, a as AccountCheckResult, a3 as ReactionStatus, a2 as ReactionResult, a1 as ReactionError, aa as RoadmapVotesResponse, C as CastRoadmapVoteResult, D as DeleteAccountResult } from '../../keys-D1qvOp5Q.js';
+export { ad as SifaQueryKey } from '../../keys-D1qvOp5Q.js';
 import * as _tanstack_react_query from '@tanstack/react-query';
 import { UseQueryOptions, UseMutationOptions, UseInfiniteQueryOptions, InfiniteData } from '@tanstack/react-query';
 import { c as Profile, r as ProfilePosition, w as SkillRef, E as ExternalAccount, S as SkillSuggestion } from '../../adult-content-o0BxhFzc.js';
@@ -459,8 +459,14 @@ declare function useRoadmapVotes(options?: Omit<UseQueryOptions<RoadmapVotesResp
 /** Roadmap items the authenticated viewer has voted on. Returns `[]` data on error. */
 declare function useMyRoadmapVotes(options?: Omit<UseQueryOptions<string[], Error, string[], ReturnType<typeof sifaQueryKeys.roadmap.myVotes>>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<NoInfer<string[]>, Error>;
 
-/** React hook for casting a roadmap vote. Variable: the item key. */
-declare function useCastRoadmapVote(options?: Omit<UseMutationOptions<WriteResult, Error, string>, 'mutationFn'>): _tanstack_react_query.UseMutationResult<WriteResult, Error, string, unknown>;
+/**
+ * React hook for casting a roadmap vote. Variable: the item key.
+ *
+ * Returns the discriminated-union result so callers can detect
+ * `scope_insufficient` and trigger an OAuth scope-upgrade flow
+ * (see {@link castRoadmapVote}).
+ */
+declare function useCastRoadmapVote(options?: Omit<UseMutationOptions<CastRoadmapVoteResult, Error, string>, 'mutationFn'>): _tanstack_react_query.UseMutationResult<CastRoadmapVoteResult, Error, string, unknown>;
 /** React hook for retracting a previously-cast roadmap vote. */
 declare function useRetractRoadmapVote(options?: Omit<UseMutationOptions<WriteResult, Error, string>, 'mutationFn'>): _tanstack_react_query.UseMutationResult<WriteResult, Error, string, unknown>;
 

package/dist/query/hooks/index.js

@@ -2143,8 +2143,36 @@ async function fetchMyRoadmapVotes(config, options = {}) {
     return [];
   }
 }
-function castRoadmapVote(config, key, options = {}) {
-  return apiWrite(config, `/api/roadmap/votes/${encodeURIComponent(key)}`, "POST", options);
+async function castRoadmapVote(config, key, options = {}) {
+  const fetchFn = config.fetch ?? globalThis.fetch;
+  const url = `${config.baseUrl}/api/roadmap/votes/${encodeURIComponent(key)}`;
+  try {
+    const res = await fetchFn(url, {
+      method: "POST",
+      headers: { "Content-Type": "application/json", ...options.headers ?? {} },
+      credentials: options.credentials ?? "include",
+      signal: options.signal ?? AbortSignal.timeout(options.timeoutMs ?? 1e4)
+    });
+    if (!res.ok) {
+      if (res.status === 403) {
+        try {
+          const body = await res.json();
+          if (body.error === "ScopeInsufficient") {
+            return {
+              ok: false,
+              error: { type: "scope_insufficient", requiredScope: body.requiredScope }
+            };
+          }
+        } catch {
+        }
+      }
+      return { ok: false, error: { type: "error" } };
+    }
+    const data = await res.json();
+    return { ok: true, data };
+  } catch {
+    return { ok: false, error: { type: "error" } };
+  }
 }
 function retractRoadmapVote(config, key, options = {}) {
   return apiWrite(config, `/api/roadmap/votes/${encodeURIComponent(key)}`, "DELETE", options);
@@ -2176,7 +2204,7 @@ function useCastRoadmapVote(options) {
   return useMutation({
     mutationFn: (key) => castRoadmapVote(config, key),
     onSuccess: async (result, variables, onMutateResult, context) => {
-      if (result.success) {
+      if (result.ok) {
         await invalidateRoadmap(queryClient);
       }
       await options?.onSuccess?.(result, variables, onMutateResult, context);