@singi-labs/sifa-sdk 0.20.1 → 0.20.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (35) hide show
  1. package/dist/index.cjs +53 -1
  2. package/dist/index.cjs.map +1 -1
  3. package/dist/index.d.cts +11 -1
  4. package/dist/index.d.ts +11 -1
  5. package/dist/index.js +5 -1
  6. package/dist/index.js.map +1 -1
  7. package/dist/query/fetchers/index.cjs +55 -5
  8. package/dist/query/fetchers/index.cjs.map +1 -1
  9. package/dist/query/fetchers/index.d.cts +1 -1
  10. package/dist/query/fetchers/index.d.ts +1 -1
  11. package/dist/query/fetchers/index.js +6 -0
  12. package/dist/query/fetchers/index.js.map +1 -1
  13. package/dist/query/fetchers/roadmap.js +56 -3
  14. package/dist/query/fetchers/roadmap.js.map +1 -1
  15. package/dist/query/hooks/index.cjs +66 -5
  16. package/dist/query/hooks/index.cjs.map +1 -1
  17. package/dist/query/hooks/index.d.cts +2 -2
  18. package/dist/query/hooks/index.d.ts +2 -2
  19. package/dist/query/hooks/index.js +8 -1
  20. package/dist/query/hooks/index.js.map +1 -1
  21. package/dist/query/hooks/use-roadmap-mutations.js +36 -0
  22. package/dist/query/hooks/use-roadmap-mutations.js.map +1 -1
  23. package/dist/query/index.cjs +89 -5
  24. package/dist/query/index.cjs.map +1 -1
  25. package/dist/query/index.d.cts +3 -3
  26. package/dist/query/index.d.ts +3 -3
  27. package/dist/query/index.js +14 -1
  28. package/dist/query/index.js.map +1 -1
  29. package/dist/roadmap/board-body.js +55 -0
  30. package/dist/roadmap/board-body.js.map +1 -0
  31. package/dist/{use-user-settings-YIv1C3qN.d.cts → use-user-settings-Cq_AHkkM.d.cts} +14 -2
  32. package/dist/{use-user-settings-CrS3ZXoW.d.ts → use-user-settings-DoNP3tNl.d.ts} +14 -2
  33. package/dist/{user-settings-Bvafly0r.d.ts → user-settings-CBtacio1.d.ts} +52 -1
  34. package/dist/{user-settings-DWq91Gj-.d.cts → user-settings-DDP76dZH.d.cts} +52 -1
  35. package/package.json +1 -1
@@ -1582,6 +1582,57 @@ type CastRoadmapVoteResult = {
1582
1582
  declare function castRoadmapVote(config: SifaApiConfig, key: string, options?: ApiFetchOptions): Promise<CastRoadmapVoteResult>;
1583
1583
  /** Retract a previously-cast roadmap vote. */
1584
1584
  declare function retractRoadmapVote(config: SifaApiConfig, key: string, options?: ApiFetchOptions): Promise<WriteResult>;
1585
+ /** Roadmap group of a board item (sifa-api `GET /api/roadmap`). */
1586
+ type RoadmapBoardStatus = 'done' | 'in-progress' | 'planned' | 'later' | 'under-review';
1587
+ type RoadmapBoardSize = 'small' | 'medium' | 'epic';
1588
+ /** One item on the roadmap, read from Sifa's userinput.app board. */
1589
+ interface RoadmapBoardItem {
1590
+ /** The `app.userinput.discussion` record URI. */
1591
+ uri: string;
1592
+ /** Author of the discussion (sifa.id or anyone who posted an idea). */
1593
+ did: string;
1594
+ rkey: string;
1595
+ title: string;
1596
+ /** Free text from the record. Render as plain text. */
1597
+ body: string | null;
1598
+ /** Tags without the size tag. */
1599
+ tags: string[];
1600
+ size: RoadmapBoardSize | null;
1601
+ status: RoadmapBoardStatus;
1602
+ votable: boolean;
1603
+ votes: {
1604
+ count: number;
1605
+ voters: RoadmapVoter[];
1606
+ };
1607
+ createdAt: string;
1608
+ /** Whether the signed-in viewer voted. False without a session. */
1609
+ viewerVoted: boolean;
1610
+ }
1611
+ /** Identifies a board item for voting. */
1612
+ interface RoadmapItemRef {
1613
+ did: string;
1614
+ rkey: string;
1615
+ }
1616
+ interface FetchRoadmapOptions extends ApiFetchOptions {
1617
+ /**
1618
+ * Pass the caller's `Cookie` header on Next.js RSC server-side calls so
1619
+ * `viewerVoted` reflects the viewer.
1620
+ */
1621
+ cookieHeader?: string;
1622
+ }
1623
+ /**
1624
+ * The roadmap as built from Sifa's userinput.app board, grouped and ordered
1625
+ * by the API. Returns `null` on any error, so callers can tell an outage from
1626
+ * an empty roadmap.
1627
+ */
1628
+ declare function fetchRoadmap(config: SifaApiConfig, options?: FetchRoadmapOptions): Promise<RoadmapBoardItem[] | null>;
1629
+ /**
1630
+ * Vote on a roadmap board item. Same result shape and scope handling as
1631
+ * {@link castRoadmapVote}. Never throws.
1632
+ */
1633
+ declare function castRoadmapItemVote(config: SifaApiConfig, item: RoadmapItemRef, options?: ApiFetchOptions): Promise<CastRoadmapVoteResult>;
1634
+ /** Retract a vote on a roadmap board item. */
1635
+ declare function retractRoadmapItemVote(config: SifaApiConfig, item: RoadmapItemRef, options?: ApiFetchOptions): Promise<WriteResult>;
1585
1636
 
1586
1637
  /**
1587
1638
  * What the server managed to remove from the user's PDS.
@@ -1986,4 +2037,4 @@ declare function fetchUserSettings(config: SifaApiConfig, options?: FetchUserSet
1986
2037
  /** Save the given preferences. Returns the stored settings, or `null` on failure. */
1987
2038
  declare function updateUserSettings(config: SifaApiConfig, patch: UserSettingsPatch): Promise<UserSettings | null>;
1988
2039
 
1989
- export { type FollowingFeedVersion as $, type AccountCheckResult as A, type BulkHideProfileItemInput as B, type ConfirmEndorsementInput as C, type DeleteAccountResult as D, type EndorsementInput as E, type FeatureAllowlistResponse as F, type FetchFollowingFeedOptions as G, type FetchHiddenActivityItemsOptions as H, type FetchHiddenAppsOptions as I, type FetchInboxCountsOptions as J, type FetchMyGithubPullRequestsOptions as K, type FetchMyRoadmapVotesOptions as L, type FetchProfileCompletenessOptions as M, type FetchReactionStatusOptions as N, type FetchRpgClaimableOptions as O, type FetchRpgStatusOptions as P, type FetchSuggestionsOptions as Q, type FetchUnlinkedPositionsOptions as R, type FetchUserSettingsOptions as S, type FollowListPage as T, type FollowProfile as U, type FollowProfilePageResponse as V, type FollowUserResult as W, type FollowingFeedApp as X, type FollowingFeedBuild as Y, type FollowingFeedEmptyReason as Z, type FollowingFeedResponse as _, type ConfirmEndorsementResult as a, type SubCategoryBulkResult as a$, type FollowingResponse as a0, type GetAdminReviewQueuesOptions as a1, type GithubPullRequest as a2, type GivenConfirmation as a3, HIDDEN_ITEM_SOURCES as a4, HIDDEN_ITEM_TYPES as a5, type HeatmapDay as a6, type HeatmapResponse as a7, type HiddenActivityItem as a8, type HiddenApp as a9, QUOTED_POSTS_BATCH_MAX as aA, type QuotedPostAuthor as aB, type QuotedPostImage as aC, type QuotedPostResult as aD, type QuotedPostView as aE, type ReactionError as aF, type ReactionResult as aG, type ReactionStatus as aH, type RefreshOrcidPublicationsResult as aI, type RefreshPdsResult as aJ, type RepoDeleteInput as aK, type ResetProfileResult as aL, type ResolveQuotedPostsOptions as aM, type RoadmapVoteError as aN, type RoadmapVoteResult as aO, type RoadmapVoter as aP, type RoadmapVotesResponse as aQ, type RpgClaimableResponse as aR, RpgClaimableResponseSchema as aS, type RpgItemStatus as aT, RpgItemStatusSchema as aU, type RpgStatusResponse as aV, RpgStatusResponseSchema as aW, type SifaQueryKey as aX, type SimilarProfile as aY, type SiteActivityPresetResponse as aZ, type StatsResponse as a_, type HiddenItemSource as aa, type HiddenItemType as ab, type HideActivityItemInput as ac, type HideProfileItemInput as ad, type InboxCounts as ae, type ListFeatureAllowlistOptions as af, type MyGithubPullRequestsResponse as ag, type OrgClaimBinding as ah, type OrgClaimResult as ai, type OrgDomainChallengeResult as aj, type OrgDomainVerifyResult as ak, type OrgNotificationEmailAddResult as al, type OrgNotificationEmailRemoveResult as am, type OrgProfileEcho as an, type OrgProfileUpdateResult as ao, PROFILE_COMPLETENESS_SIGNALS as ap, type PdsWipeOutcome as aq, type PendingConfirmation as ar, type PendingConfirmationsPage as as, type PrimarySection as at, type ProfileCompleteness as au, type ProfileCompletenessSignal as av, type ProfileIndustryInput as aw, type ProfileLocationAddress as ax, type ProfileLocationInput as ay, type ProfileSelfLocation as az, type AccountSummary as b, fetchRoadmapVotes as b$, type SuggestionProfile as b0, type SuggestionsResponse as b1, type UnhideActivityItemInput as b2, type UnlinkedPosition as b3, type UnlinkedPositionsResult as b4, type UpdateActivityPreferencesInput as b5, type UpdateProfileOverrideInput as b6, type UpdateProfileSelfInput as b7, type UploadAvatarResult as b8, type UploadPronunciationAudioResult as b9, deleteReaction as bA, deleteRepoRecords as bB, deleteSkill as bC, dismissCompletenessSignal as bD, dismissConfirmation as bE, dismissUnlinkedPosition as bF, fetchAccounts as bG, fetchActivityFeed as bH, fetchActivityPreferences as bI, fetchActivityTeaser as bJ, fetchAppsRegistry as bK, fetchExternalAccounts as bL, fetchFeaturedProfile as bM, fetchFollowing as bN, fetchFollowingFeed as bO, fetchFollowingFeedVersion as bP, fetchGivenConfirmations as bQ, fetchHeatmapData as bR, fetchHiddenActivityItems as bS, fetchHiddenApps as bT, fetchInboxCounts as bU, fetchMyGithubPullRequests as bV, fetchMyRoadmapVotes as bW, fetchPendingConfirmations as bX, fetchProfileCompleteness as bY, fetchReactionStatus as bZ, fetchRepoInventory as b_, type UserSettings as ba, type UserSettingsPatch as bb, UserSettingsSchema as bc, type VerifyExternalAccountResult as bd, type WipePreview as be, addFeatureAllowlist as bf, addOrgNotificationEmail as bg, bulkHideProfileItems as bh, bulkHideStandardPublications as bi, bulkUnhideProfileItems as bj, bulkUnhideStandardPublications as bk, castRoadmapVote as bl, checkAppAccount as bm, clearCompletenessDismissals as bn, confirmEndorsement as bo, createConfirmation as bp, createEndorsement as bq, createExternalAccount as br, createProfileLocation as bs, createReaction as bt, createSkill as bu, deleteAccount as bv, deleteAvatarOverride as bw, deleteExternalAccount as bx, deleteNamePronunciationAudio as by, deleteProfileLocation as bz, type ActivityFeedResponse as c, fetchRpgClaimable as c0, fetchRpgStatus as c1, fetchSimilarProfiles as c2, fetchSiteActivityPreset as c3, fetchStats as c4, fetchSuggestionCount as c5, fetchSuggestions as c6, fetchUnlinkedPositions as c7, fetchUserSettings as c8, fetchViewerPositionConfirmations as c9, submitOrgClaim as cA, switchAccount as cB, unfollowUser as cC, unhideActivityItem as cD, unhideOrcidPublication as cE, unhideProfileItem as cF, unhideSifaPublication as cG, unhideStandardPublication as cH, unsetExternalAccountPrimary as cI, unsetSectionPrimary as cJ, updateActivityPreferences as cK, updateExternalAccount as cL, updateOrgProfile as cM, updateProfileLocation as cN, updateProfileOverride as cO, updateProfileSelf as cP, updateSkill as cQ, updateSkillSubCategories as cR, updateUserSettings as cS, uploadAvatar as cT, uploadNamePronunciationAudio as cU, verifyExternalAccount as cV, verifyOrgDomain as cW, fetchWipePreview as ca, followUser as cb, getAdminReviewQueues as cc, getBlueskySuggestions as cd, getFollowers as ce, getFollowing as cf, getMutuals as cg, hideActivityItem as ch, hideOrcidPublication as ci, hideProfileItem as cj, hideSifaPublication as ck, hideStandardPublication as cl, isNewerFollowingFeed as cm, listFeatureAllowlist as cn, refreshOrcidPublications as co, refreshPds as cp, removeFeatureAllowlist as cq, removeOrgNotificationEmail as cr, repoExportUrl as cs, requestOrgDomainChallenge as ct, resetProfile as cu, resolveQuotedPosts as cv, retractRoadmapVote as cw, revokeConfirmation as cx, setExternalAccountPrimary as cy, setSectionPrimary as cz, type ActivityItem as d, type ActivityItemLinkHealth as e, type ActivityPreferences as f, type ActivityTeaserResponse as g, type AdminReviewQueues as h, type AppRegistryEntry as i, type CastRoadmapVoteResult as j, type CheckAppAccountOptions as k, type ConfirmationInput as l, type ConfirmationSubjectInput as m, type CreateExternalAccountResult as n, type DismissCompletenessSignalInput as o, type DismissUnlinkedPositionInput as p, type ExternalAccountInput as q, type FeaturedProfile as r, sifaQueryKeys as s, type FetchAccountsOptions as t, type FetchActivityFeedOptions as u, type FetchActivityPreferencesOptions as v, type FetchActivityTeaserOptions as w, type FetchConfirmationsOptions as x, type FetchFollowListOptions as y, type FetchFollowProfilePageOptions as z };
2040
+ export { type FollowingFeedResponse as $, type AccountCheckResult as A, type BulkHideProfileItemInput as B, type ConfirmEndorsementInput as C, type DeleteAccountResult as D, type EndorsementInput as E, type FeatureAllowlistResponse as F, type FetchFollowingFeedOptions as G, type FetchHiddenActivityItemsOptions as H, type FetchHiddenAppsOptions as I, type FetchInboxCountsOptions as J, type FetchMyGithubPullRequestsOptions as K, type FetchMyRoadmapVotesOptions as L, type FetchProfileCompletenessOptions as M, type FetchReactionStatusOptions as N, type FetchRoadmapOptions as O, type FetchRpgClaimableOptions as P, type FetchRpgStatusOptions as Q, type FetchSuggestionsOptions as R, type FetchUnlinkedPositionsOptions as S, type FetchUserSettingsOptions as T, type FollowListPage as U, type FollowProfile as V, type FollowProfilePageResponse as W, type FollowUserResult as X, type FollowingFeedApp as Y, type FollowingFeedBuild as Z, type FollowingFeedEmptyReason as _, type ConfirmEndorsementResult as a, RpgStatusResponseSchema as a$, type FollowingFeedVersion as a0, type FollowingResponse as a1, type GetAdminReviewQueuesOptions as a2, type GithubPullRequest as a3, type GivenConfirmation as a4, HIDDEN_ITEM_SOURCES as a5, HIDDEN_ITEM_TYPES as a6, type HeatmapDay as a7, type HeatmapResponse as a8, type HiddenActivityItem as a9, type ProfileSelfLocation as aA, QUOTED_POSTS_BATCH_MAX as aB, type QuotedPostAuthor as aC, type QuotedPostImage as aD, type QuotedPostResult as aE, type QuotedPostView as aF, type ReactionError as aG, type ReactionResult as aH, type ReactionStatus as aI, type RefreshOrcidPublicationsResult as aJ, type RefreshPdsResult as aK, type RepoDeleteInput as aL, type ResetProfileResult as aM, type ResolveQuotedPostsOptions as aN, type RoadmapBoardItem as aO, type RoadmapBoardSize as aP, type RoadmapBoardStatus as aQ, type RoadmapItemRef as aR, type RoadmapVoteError as aS, type RoadmapVoteResult as aT, type RoadmapVoter as aU, type RoadmapVotesResponse as aV, type RpgClaimableResponse as aW, RpgClaimableResponseSchema as aX, type RpgItemStatus as aY, RpgItemStatusSchema as aZ, type RpgStatusResponse as a_, type HiddenApp as aa, type HiddenItemSource as ab, type HiddenItemType as ac, type HideActivityItemInput as ad, type HideProfileItemInput as ae, type InboxCounts as af, type ListFeatureAllowlistOptions as ag, type MyGithubPullRequestsResponse as ah, type OrgClaimBinding as ai, type OrgClaimResult as aj, type OrgDomainChallengeResult as ak, type OrgDomainVerifyResult as al, type OrgNotificationEmailAddResult as am, type OrgNotificationEmailRemoveResult as an, type OrgProfileEcho as ao, type OrgProfileUpdateResult as ap, PROFILE_COMPLETENESS_SIGNALS as aq, type PdsWipeOutcome as ar, type PendingConfirmation as as, type PendingConfirmationsPage as at, type PrimarySection as au, type ProfileCompleteness as av, type ProfileCompletenessSignal as aw, type ProfileIndustryInput as ax, type ProfileLocationAddress as ay, type ProfileLocationInput as az, type AccountSummary as b, fetchMyGithubPullRequests as b$, type SifaQueryKey as b0, type SimilarProfile as b1, type SiteActivityPresetResponse as b2, type StatsResponse as b3, type SubCategoryBulkResult as b4, type SuggestionProfile as b5, type SuggestionsResponse as b6, type UnhideActivityItemInput as b7, type UnlinkedPosition as b8, type UnlinkedPositionsResult as b9, createSkill as bA, deleteAccount as bB, deleteAvatarOverride as bC, deleteExternalAccount as bD, deleteNamePronunciationAudio as bE, deleteProfileLocation as bF, deleteReaction as bG, deleteRepoRecords as bH, deleteSkill as bI, dismissCompletenessSignal as bJ, dismissConfirmation as bK, dismissUnlinkedPosition as bL, fetchAccounts as bM, fetchActivityFeed as bN, fetchActivityPreferences as bO, fetchActivityTeaser as bP, fetchAppsRegistry as bQ, fetchExternalAccounts as bR, fetchFeaturedProfile as bS, fetchFollowing as bT, fetchFollowingFeed as bU, fetchFollowingFeedVersion as bV, fetchGivenConfirmations as bW, fetchHeatmapData as bX, fetchHiddenActivityItems as bY, fetchHiddenApps as bZ, fetchInboxCounts as b_, type UpdateActivityPreferencesInput as ba, type UpdateProfileOverrideInput as bb, type UpdateProfileSelfInput as bc, type UploadAvatarResult as bd, type UploadPronunciationAudioResult as be, type UserSettings as bf, type UserSettingsPatch as bg, UserSettingsSchema as bh, type VerifyExternalAccountResult as bi, type WipePreview as bj, addFeatureAllowlist as bk, addOrgNotificationEmail as bl, bulkHideProfileItems as bm, bulkHideStandardPublications as bn, bulkUnhideProfileItems as bo, bulkUnhideStandardPublications as bp, castRoadmapItemVote as bq, castRoadmapVote as br, checkAppAccount as bs, clearCompletenessDismissals as bt, confirmEndorsement as bu, createConfirmation as bv, createEndorsement as bw, createExternalAccount as bx, createProfileLocation as by, createReaction as bz, type ActivityFeedResponse as c, uploadAvatar as c$, fetchMyRoadmapVotes as c0, fetchPendingConfirmations as c1, fetchProfileCompleteness as c2, fetchReactionStatus as c3, fetchRepoInventory as c4, fetchRoadmap as c5, fetchRoadmapVotes as c6, fetchRpgClaimable as c7, fetchRpgStatus as c8, fetchSimilarProfiles as c9, requestOrgDomainChallenge as cA, resetProfile as cB, resolveQuotedPosts as cC, retractRoadmapItemVote as cD, retractRoadmapVote as cE, revokeConfirmation as cF, setExternalAccountPrimary as cG, setSectionPrimary as cH, submitOrgClaim as cI, switchAccount as cJ, unfollowUser as cK, unhideActivityItem as cL, unhideOrcidPublication as cM, unhideProfileItem as cN, unhideSifaPublication as cO, unhideStandardPublication as cP, unsetExternalAccountPrimary as cQ, unsetSectionPrimary as cR, updateActivityPreferences as cS, updateExternalAccount as cT, updateOrgProfile as cU, updateProfileLocation as cV, updateProfileOverride as cW, updateProfileSelf as cX, updateSkill as cY, updateSkillSubCategories as cZ, updateUserSettings as c_, fetchSiteActivityPreset as ca, fetchStats as cb, fetchSuggestionCount as cc, fetchSuggestions as cd, fetchUnlinkedPositions as ce, fetchUserSettings as cf, fetchViewerPositionConfirmations as cg, fetchWipePreview as ch, followUser as ci, getAdminReviewQueues as cj, getBlueskySuggestions as ck, getFollowers as cl, getFollowing as cm, getMutuals as cn, hideActivityItem as co, hideOrcidPublication as cp, hideProfileItem as cq, hideSifaPublication as cr, hideStandardPublication as cs, isNewerFollowingFeed as ct, listFeatureAllowlist as cu, refreshOrcidPublications as cv, refreshPds as cw, removeFeatureAllowlist as cx, removeOrgNotificationEmail as cy, repoExportUrl as cz, type ActivityItem as d, uploadNamePronunciationAudio as d0, verifyExternalAccount as d1, verifyOrgDomain as d2, type ActivityItemLinkHealth as e, type ActivityPreferences as f, type ActivityTeaserResponse as g, type AdminReviewQueues as h, type AppRegistryEntry as i, type CastRoadmapVoteResult as j, type CheckAppAccountOptions as k, type ConfirmationInput as l, type ConfirmationSubjectInput as m, type CreateExternalAccountResult as n, type DismissCompletenessSignalInput as o, type DismissUnlinkedPositionInput as p, type ExternalAccountInput as q, type FeaturedProfile as r, sifaQueryKeys as s, type FetchAccountsOptions as t, type FetchActivityFeedOptions as u, type FetchActivityPreferencesOptions as v, type FetchActivityTeaserOptions as w, type FetchConfirmationsOptions as x, type FetchFollowListOptions as y, type FetchFollowProfilePageOptions as z };
@@ -1582,6 +1582,57 @@ type CastRoadmapVoteResult = {
1582
1582
  declare function castRoadmapVote(config: SifaApiConfig, key: string, options?: ApiFetchOptions): Promise<CastRoadmapVoteResult>;
1583
1583
  /** Retract a previously-cast roadmap vote. */
1584
1584
  declare function retractRoadmapVote(config: SifaApiConfig, key: string, options?: ApiFetchOptions): Promise<WriteResult>;
1585
+ /** Roadmap group of a board item (sifa-api `GET /api/roadmap`). */
1586
+ type RoadmapBoardStatus = 'done' | 'in-progress' | 'planned' | 'later' | 'under-review';
1587
+ type RoadmapBoardSize = 'small' | 'medium' | 'epic';
1588
+ /** One item on the roadmap, read from Sifa's userinput.app board. */
1589
+ interface RoadmapBoardItem {
1590
+ /** The `app.userinput.discussion` record URI. */
1591
+ uri: string;
1592
+ /** Author of the discussion (sifa.id or anyone who posted an idea). */
1593
+ did: string;
1594
+ rkey: string;
1595
+ title: string;
1596
+ /** Free text from the record. Render as plain text. */
1597
+ body: string | null;
1598
+ /** Tags without the size tag. */
1599
+ tags: string[];
1600
+ size: RoadmapBoardSize | null;
1601
+ status: RoadmapBoardStatus;
1602
+ votable: boolean;
1603
+ votes: {
1604
+ count: number;
1605
+ voters: RoadmapVoter[];
1606
+ };
1607
+ createdAt: string;
1608
+ /** Whether the signed-in viewer voted. False without a session. */
1609
+ viewerVoted: boolean;
1610
+ }
1611
+ /** Identifies a board item for voting. */
1612
+ interface RoadmapItemRef {
1613
+ did: string;
1614
+ rkey: string;
1615
+ }
1616
+ interface FetchRoadmapOptions extends ApiFetchOptions {
1617
+ /**
1618
+ * Pass the caller's `Cookie` header on Next.js RSC server-side calls so
1619
+ * `viewerVoted` reflects the viewer.
1620
+ */
1621
+ cookieHeader?: string;
1622
+ }
1623
+ /**
1624
+ * The roadmap as built from Sifa's userinput.app board, grouped and ordered
1625
+ * by the API. Returns `null` on any error, so callers can tell an outage from
1626
+ * an empty roadmap.
1627
+ */
1628
+ declare function fetchRoadmap(config: SifaApiConfig, options?: FetchRoadmapOptions): Promise<RoadmapBoardItem[] | null>;
1629
+ /**
1630
+ * Vote on a roadmap board item. Same result shape and scope handling as
1631
+ * {@link castRoadmapVote}. Never throws.
1632
+ */
1633
+ declare function castRoadmapItemVote(config: SifaApiConfig, item: RoadmapItemRef, options?: ApiFetchOptions): Promise<CastRoadmapVoteResult>;
1634
+ /** Retract a vote on a roadmap board item. */
1635
+ declare function retractRoadmapItemVote(config: SifaApiConfig, item: RoadmapItemRef, options?: ApiFetchOptions): Promise<WriteResult>;
1585
1636
 
1586
1637
  /**
1587
1638
  * What the server managed to remove from the user's PDS.
@@ -1986,4 +2037,4 @@ declare function fetchUserSettings(config: SifaApiConfig, options?: FetchUserSet
1986
2037
  /** Save the given preferences. Returns the stored settings, or `null` on failure. */
1987
2038
  declare function updateUserSettings(config: SifaApiConfig, patch: UserSettingsPatch): Promise<UserSettings | null>;
1988
2039
 
1989
- export { type FollowingFeedVersion as $, type AccountCheckResult as A, type BulkHideProfileItemInput as B, type ConfirmEndorsementInput as C, type DeleteAccountResult as D, type EndorsementInput as E, type FeatureAllowlistResponse as F, type FetchFollowingFeedOptions as G, type FetchHiddenActivityItemsOptions as H, type FetchHiddenAppsOptions as I, type FetchInboxCountsOptions as J, type FetchMyGithubPullRequestsOptions as K, type FetchMyRoadmapVotesOptions as L, type FetchProfileCompletenessOptions as M, type FetchReactionStatusOptions as N, type FetchRpgClaimableOptions as O, type FetchRpgStatusOptions as P, type FetchSuggestionsOptions as Q, type FetchUnlinkedPositionsOptions as R, type FetchUserSettingsOptions as S, type FollowListPage as T, type FollowProfile as U, type FollowProfilePageResponse as V, type FollowUserResult as W, type FollowingFeedApp as X, type FollowingFeedBuild as Y, type FollowingFeedEmptyReason as Z, type FollowingFeedResponse as _, type ConfirmEndorsementResult as a, type SubCategoryBulkResult as a$, type FollowingResponse as a0, type GetAdminReviewQueuesOptions as a1, type GithubPullRequest as a2, type GivenConfirmation as a3, HIDDEN_ITEM_SOURCES as a4, HIDDEN_ITEM_TYPES as a5, type HeatmapDay as a6, type HeatmapResponse as a7, type HiddenActivityItem as a8, type HiddenApp as a9, QUOTED_POSTS_BATCH_MAX as aA, type QuotedPostAuthor as aB, type QuotedPostImage as aC, type QuotedPostResult as aD, type QuotedPostView as aE, type ReactionError as aF, type ReactionResult as aG, type ReactionStatus as aH, type RefreshOrcidPublicationsResult as aI, type RefreshPdsResult as aJ, type RepoDeleteInput as aK, type ResetProfileResult as aL, type ResolveQuotedPostsOptions as aM, type RoadmapVoteError as aN, type RoadmapVoteResult as aO, type RoadmapVoter as aP, type RoadmapVotesResponse as aQ, type RpgClaimableResponse as aR, RpgClaimableResponseSchema as aS, type RpgItemStatus as aT, RpgItemStatusSchema as aU, type RpgStatusResponse as aV, RpgStatusResponseSchema as aW, type SifaQueryKey as aX, type SimilarProfile as aY, type SiteActivityPresetResponse as aZ, type StatsResponse as a_, type HiddenItemSource as aa, type HiddenItemType as ab, type HideActivityItemInput as ac, type HideProfileItemInput as ad, type InboxCounts as ae, type ListFeatureAllowlistOptions as af, type MyGithubPullRequestsResponse as ag, type OrgClaimBinding as ah, type OrgClaimResult as ai, type OrgDomainChallengeResult as aj, type OrgDomainVerifyResult as ak, type OrgNotificationEmailAddResult as al, type OrgNotificationEmailRemoveResult as am, type OrgProfileEcho as an, type OrgProfileUpdateResult as ao, PROFILE_COMPLETENESS_SIGNALS as ap, type PdsWipeOutcome as aq, type PendingConfirmation as ar, type PendingConfirmationsPage as as, type PrimarySection as at, type ProfileCompleteness as au, type ProfileCompletenessSignal as av, type ProfileIndustryInput as aw, type ProfileLocationAddress as ax, type ProfileLocationInput as ay, type ProfileSelfLocation as az, type AccountSummary as b, fetchRoadmapVotes as b$, type SuggestionProfile as b0, type SuggestionsResponse as b1, type UnhideActivityItemInput as b2, type UnlinkedPosition as b3, type UnlinkedPositionsResult as b4, type UpdateActivityPreferencesInput as b5, type UpdateProfileOverrideInput as b6, type UpdateProfileSelfInput as b7, type UploadAvatarResult as b8, type UploadPronunciationAudioResult as b9, deleteReaction as bA, deleteRepoRecords as bB, deleteSkill as bC, dismissCompletenessSignal as bD, dismissConfirmation as bE, dismissUnlinkedPosition as bF, fetchAccounts as bG, fetchActivityFeed as bH, fetchActivityPreferences as bI, fetchActivityTeaser as bJ, fetchAppsRegistry as bK, fetchExternalAccounts as bL, fetchFeaturedProfile as bM, fetchFollowing as bN, fetchFollowingFeed as bO, fetchFollowingFeedVersion as bP, fetchGivenConfirmations as bQ, fetchHeatmapData as bR, fetchHiddenActivityItems as bS, fetchHiddenApps as bT, fetchInboxCounts as bU, fetchMyGithubPullRequests as bV, fetchMyRoadmapVotes as bW, fetchPendingConfirmations as bX, fetchProfileCompleteness as bY, fetchReactionStatus as bZ, fetchRepoInventory as b_, type UserSettings as ba, type UserSettingsPatch as bb, UserSettingsSchema as bc, type VerifyExternalAccountResult as bd, type WipePreview as be, addFeatureAllowlist as bf, addOrgNotificationEmail as bg, bulkHideProfileItems as bh, bulkHideStandardPublications as bi, bulkUnhideProfileItems as bj, bulkUnhideStandardPublications as bk, castRoadmapVote as bl, checkAppAccount as bm, clearCompletenessDismissals as bn, confirmEndorsement as bo, createConfirmation as bp, createEndorsement as bq, createExternalAccount as br, createProfileLocation as bs, createReaction as bt, createSkill as bu, deleteAccount as bv, deleteAvatarOverride as bw, deleteExternalAccount as bx, deleteNamePronunciationAudio as by, deleteProfileLocation as bz, type ActivityFeedResponse as c, fetchRpgClaimable as c0, fetchRpgStatus as c1, fetchSimilarProfiles as c2, fetchSiteActivityPreset as c3, fetchStats as c4, fetchSuggestionCount as c5, fetchSuggestions as c6, fetchUnlinkedPositions as c7, fetchUserSettings as c8, fetchViewerPositionConfirmations as c9, submitOrgClaim as cA, switchAccount as cB, unfollowUser as cC, unhideActivityItem as cD, unhideOrcidPublication as cE, unhideProfileItem as cF, unhideSifaPublication as cG, unhideStandardPublication as cH, unsetExternalAccountPrimary as cI, unsetSectionPrimary as cJ, updateActivityPreferences as cK, updateExternalAccount as cL, updateOrgProfile as cM, updateProfileLocation as cN, updateProfileOverride as cO, updateProfileSelf as cP, updateSkill as cQ, updateSkillSubCategories as cR, updateUserSettings as cS, uploadAvatar as cT, uploadNamePronunciationAudio as cU, verifyExternalAccount as cV, verifyOrgDomain as cW, fetchWipePreview as ca, followUser as cb, getAdminReviewQueues as cc, getBlueskySuggestions as cd, getFollowers as ce, getFollowing as cf, getMutuals as cg, hideActivityItem as ch, hideOrcidPublication as ci, hideProfileItem as cj, hideSifaPublication as ck, hideStandardPublication as cl, isNewerFollowingFeed as cm, listFeatureAllowlist as cn, refreshOrcidPublications as co, refreshPds as cp, removeFeatureAllowlist as cq, removeOrgNotificationEmail as cr, repoExportUrl as cs, requestOrgDomainChallenge as ct, resetProfile as cu, resolveQuotedPosts as cv, retractRoadmapVote as cw, revokeConfirmation as cx, setExternalAccountPrimary as cy, setSectionPrimary as cz, type ActivityItem as d, type ActivityItemLinkHealth as e, type ActivityPreferences as f, type ActivityTeaserResponse as g, type AdminReviewQueues as h, type AppRegistryEntry as i, type CastRoadmapVoteResult as j, type CheckAppAccountOptions as k, type ConfirmationInput as l, type ConfirmationSubjectInput as m, type CreateExternalAccountResult as n, type DismissCompletenessSignalInput as o, type DismissUnlinkedPositionInput as p, type ExternalAccountInput as q, type FeaturedProfile as r, sifaQueryKeys as s, type FetchAccountsOptions as t, type FetchActivityFeedOptions as u, type FetchActivityPreferencesOptions as v, type FetchActivityTeaserOptions as w, type FetchConfirmationsOptions as x, type FetchFollowListOptions as y, type FetchFollowProfilePageOptions as z };
2040
+ export { type FollowingFeedResponse as $, type AccountCheckResult as A, type BulkHideProfileItemInput as B, type ConfirmEndorsementInput as C, type DeleteAccountResult as D, type EndorsementInput as E, type FeatureAllowlistResponse as F, type FetchFollowingFeedOptions as G, type FetchHiddenActivityItemsOptions as H, type FetchHiddenAppsOptions as I, type FetchInboxCountsOptions as J, type FetchMyGithubPullRequestsOptions as K, type FetchMyRoadmapVotesOptions as L, type FetchProfileCompletenessOptions as M, type FetchReactionStatusOptions as N, type FetchRoadmapOptions as O, type FetchRpgClaimableOptions as P, type FetchRpgStatusOptions as Q, type FetchSuggestionsOptions as R, type FetchUnlinkedPositionsOptions as S, type FetchUserSettingsOptions as T, type FollowListPage as U, type FollowProfile as V, type FollowProfilePageResponse as W, type FollowUserResult as X, type FollowingFeedApp as Y, type FollowingFeedBuild as Z, type FollowingFeedEmptyReason as _, type ConfirmEndorsementResult as a, RpgStatusResponseSchema as a$, type FollowingFeedVersion as a0, type FollowingResponse as a1, type GetAdminReviewQueuesOptions as a2, type GithubPullRequest as a3, type GivenConfirmation as a4, HIDDEN_ITEM_SOURCES as a5, HIDDEN_ITEM_TYPES as a6, type HeatmapDay as a7, type HeatmapResponse as a8, type HiddenActivityItem as a9, type ProfileSelfLocation as aA, QUOTED_POSTS_BATCH_MAX as aB, type QuotedPostAuthor as aC, type QuotedPostImage as aD, type QuotedPostResult as aE, type QuotedPostView as aF, type ReactionError as aG, type ReactionResult as aH, type ReactionStatus as aI, type RefreshOrcidPublicationsResult as aJ, type RefreshPdsResult as aK, type RepoDeleteInput as aL, type ResetProfileResult as aM, type ResolveQuotedPostsOptions as aN, type RoadmapBoardItem as aO, type RoadmapBoardSize as aP, type RoadmapBoardStatus as aQ, type RoadmapItemRef as aR, type RoadmapVoteError as aS, type RoadmapVoteResult as aT, type RoadmapVoter as aU, type RoadmapVotesResponse as aV, type RpgClaimableResponse as aW, RpgClaimableResponseSchema as aX, type RpgItemStatus as aY, RpgItemStatusSchema as aZ, type RpgStatusResponse as a_, type HiddenApp as aa, type HiddenItemSource as ab, type HiddenItemType as ac, type HideActivityItemInput as ad, type HideProfileItemInput as ae, type InboxCounts as af, type ListFeatureAllowlistOptions as ag, type MyGithubPullRequestsResponse as ah, type OrgClaimBinding as ai, type OrgClaimResult as aj, type OrgDomainChallengeResult as ak, type OrgDomainVerifyResult as al, type OrgNotificationEmailAddResult as am, type OrgNotificationEmailRemoveResult as an, type OrgProfileEcho as ao, type OrgProfileUpdateResult as ap, PROFILE_COMPLETENESS_SIGNALS as aq, type PdsWipeOutcome as ar, type PendingConfirmation as as, type PendingConfirmationsPage as at, type PrimarySection as au, type ProfileCompleteness as av, type ProfileCompletenessSignal as aw, type ProfileIndustryInput as ax, type ProfileLocationAddress as ay, type ProfileLocationInput as az, type AccountSummary as b, fetchMyGithubPullRequests as b$, type SifaQueryKey as b0, type SimilarProfile as b1, type SiteActivityPresetResponse as b2, type StatsResponse as b3, type SubCategoryBulkResult as b4, type SuggestionProfile as b5, type SuggestionsResponse as b6, type UnhideActivityItemInput as b7, type UnlinkedPosition as b8, type UnlinkedPositionsResult as b9, createSkill as bA, deleteAccount as bB, deleteAvatarOverride as bC, deleteExternalAccount as bD, deleteNamePronunciationAudio as bE, deleteProfileLocation as bF, deleteReaction as bG, deleteRepoRecords as bH, deleteSkill as bI, dismissCompletenessSignal as bJ, dismissConfirmation as bK, dismissUnlinkedPosition as bL, fetchAccounts as bM, fetchActivityFeed as bN, fetchActivityPreferences as bO, fetchActivityTeaser as bP, fetchAppsRegistry as bQ, fetchExternalAccounts as bR, fetchFeaturedProfile as bS, fetchFollowing as bT, fetchFollowingFeed as bU, fetchFollowingFeedVersion as bV, fetchGivenConfirmations as bW, fetchHeatmapData as bX, fetchHiddenActivityItems as bY, fetchHiddenApps as bZ, fetchInboxCounts as b_, type UpdateActivityPreferencesInput as ba, type UpdateProfileOverrideInput as bb, type UpdateProfileSelfInput as bc, type UploadAvatarResult as bd, type UploadPronunciationAudioResult as be, type UserSettings as bf, type UserSettingsPatch as bg, UserSettingsSchema as bh, type VerifyExternalAccountResult as bi, type WipePreview as bj, addFeatureAllowlist as bk, addOrgNotificationEmail as bl, bulkHideProfileItems as bm, bulkHideStandardPublications as bn, bulkUnhideProfileItems as bo, bulkUnhideStandardPublications as bp, castRoadmapItemVote as bq, castRoadmapVote as br, checkAppAccount as bs, clearCompletenessDismissals as bt, confirmEndorsement as bu, createConfirmation as bv, createEndorsement as bw, createExternalAccount as bx, createProfileLocation as by, createReaction as bz, type ActivityFeedResponse as c, uploadAvatar as c$, fetchMyRoadmapVotes as c0, fetchPendingConfirmations as c1, fetchProfileCompleteness as c2, fetchReactionStatus as c3, fetchRepoInventory as c4, fetchRoadmap as c5, fetchRoadmapVotes as c6, fetchRpgClaimable as c7, fetchRpgStatus as c8, fetchSimilarProfiles as c9, requestOrgDomainChallenge as cA, resetProfile as cB, resolveQuotedPosts as cC, retractRoadmapItemVote as cD, retractRoadmapVote as cE, revokeConfirmation as cF, setExternalAccountPrimary as cG, setSectionPrimary as cH, submitOrgClaim as cI, switchAccount as cJ, unfollowUser as cK, unhideActivityItem as cL, unhideOrcidPublication as cM, unhideProfileItem as cN, unhideSifaPublication as cO, unhideStandardPublication as cP, unsetExternalAccountPrimary as cQ, unsetSectionPrimary as cR, updateActivityPreferences as cS, updateExternalAccount as cT, updateOrgProfile as cU, updateProfileLocation as cV, updateProfileOverride as cW, updateProfileSelf as cX, updateSkill as cY, updateSkillSubCategories as cZ, updateUserSettings as c_, fetchSiteActivityPreset as ca, fetchStats as cb, fetchSuggestionCount as cc, fetchSuggestions as cd, fetchUnlinkedPositions as ce, fetchUserSettings as cf, fetchViewerPositionConfirmations as cg, fetchWipePreview as ch, followUser as ci, getAdminReviewQueues as cj, getBlueskySuggestions as ck, getFollowers as cl, getFollowing as cm, getMutuals as cn, hideActivityItem as co, hideOrcidPublication as cp, hideProfileItem as cq, hideSifaPublication as cr, hideStandardPublication as cs, isNewerFollowingFeed as ct, listFeatureAllowlist as cu, refreshOrcidPublications as cv, refreshPds as cw, removeFeatureAllowlist as cx, removeOrgNotificationEmail as cy, repoExportUrl as cz, type ActivityItem as d, uploadNamePronunciationAudio as d0, verifyExternalAccount as d1, verifyOrgDomain as d2, type ActivityItemLinkHealth as e, type ActivityPreferences as f, type ActivityTeaserResponse as g, type AdminReviewQueues as h, type AppRegistryEntry as i, type CastRoadmapVoteResult as j, type CheckAppAccountOptions as k, type ConfirmationInput as l, type ConfirmationSubjectInput as m, type CreateExternalAccountResult as n, type DismissCompletenessSignalInput as o, type DismissUnlinkedPositionInput as p, type ExternalAccountInput as q, type FeaturedProfile as r, sifaQueryKeys as s, type FetchAccountsOptions as t, type FetchActivityFeedOptions as u, type FetchActivityPreferencesOptions as v, type FetchActivityTeaserOptions as w, type FetchConfirmationsOptions as x, type FetchFollowListOptions as y, type FetchFollowProfilePageOptions as z };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@singi-labs/sifa-sdk",
3
- "version": "0.20.1",
3
+ "version": "0.20.2",
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",