@bitsocial/bitsocial-react-hooks 0.1.0

package/dist/hooks/accounts/accounts.d.ts

@@ -0,0 +1,64 @@
+import type { Account, UseAccountCommunitiesOptions, UseAccountCommunitiesResult, UseAccountVoteOptions, UseAccountVoteResult, UseAccountVotesOptions, UseAccountVotesResult, UseAccountCommentsOptions, UseAccountCommentsResult, UseAccountCommentOptions, UseAccountCommentResult, UseNotificationsOptions, UseNotificationsResult, UseAccountEditsOptions, UseAccountEditsResult, UseEditedCommentOptions, UseEditedCommentResult, UseAccountOptions, UseAccountResult, UsePubsubSubscribeOptions, UsePubsubSubscribeResult } from "../../types.js";
+/**
+ * @param accountName - The nickname of the account, e.g. 'Account 1'. If no accountName is provided, return
+ * the active account id.
+ */
+export declare function useAccountId(accountName?: string): string | false | undefined;
+/**
+ * @param accountName - The nickname of the account, e.g. 'Account 1'. If no accountName is provided, return
+ * the active account.
+ */
+export declare function useAccount(options?: UseAccountOptions): UseAccountResult;
+/**
+ * Return all accounts in the order of `accountsStore.accountIds`. To reorder, use `accountsActions.setAccountsOrder(accountNames)`.
+ */
+export declare function useAccounts(): {
+    accounts: Account[];
+    state: string;
+    error: undefined;
+    errors: never[];
+};
+/**
+ * Returns all communities where the account is a creator or moderator
+ */
+export declare function useAccountCommunities(options?: UseAccountCommunitiesOptions): UseAccountCommunitiesResult;
+/**
+ * Returns an account's notifications in an array. Unread notifications have a field markedAsRead: false.
+ *
+ * @param accountName - The nickname of the account, e.g. 'Account 1'. If no accountName is provided, return
+ * the active account's notifications.
+ */
+export declare function useNotifications(options?: UseNotificationsOptions): UseNotificationsResult;
+export declare const haveAccountCommentStatesChanged: (nextStates: string[], previousStates: string[]) => boolean;
+export declare function useAccountComments(options?: UseAccountCommentsOptions): UseAccountCommentsResult;
+/**
+ * Returns an account's single comment, e.g. a pending comment they published.
+ */
+export declare function useAccountComment(options?: UseAccountCommentOptions): UseAccountCommentResult;
+/**
+ * Returns the own user's votes stored locally, even those not yet published by the community owner.
+ * Check UseAccountCommentsOptions type in types.tsx to filter them, e.g. filter = {communityAddresses: ['memes.eth']}.
+ */
+export declare function useAccountVotes(options?: UseAccountVotesOptions): UseAccountVotesResult;
+/**
+ * Returns an account's single vote on a comment, e.g. to know if you already voted on a comment.
+ */
+export declare function useAccountVote(options?: UseAccountVoteOptions): UseAccountVoteResult;
+/**
+ * Returns all the comment and community edits published by an account.
+ */
+export declare function useAccountEdits(options?: UseAccountEditsOptions): UseAccountEditsResult;
+/**
+ * Returns the comment edited (if has any edits), as well as the pending, succeeded or failed state of the edit.
+ */
+export declare function useEditedComment(options?: UseEditedCommentOptions): UseEditedCommentResult;
+/**
+ * This hook should be added to pages where the user is likely to publish something, i,e. the
+ * submit page and the /c/<commentCid> page, it improves the speed of publishing to the pubsub
+ * by subscribing to the pubsub right away.
+ *
+ * @param accountName - The nickname of the account, e.g. 'Account 1'.
+ * @param communityAddress - The community address to subscribe to, e.g. 'news.eth'.
+ */
+export declare function usePubsubSubscribe(options?: UsePubsubSubscribeOptions): UsePubsubSubscribeResult;
+//# sourceMappingURL=accounts.d.ts.map

package/dist/hooks/accounts/accounts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"accounts.d.ts","sourceRoot":"","sources":["../../../src/hooks/accounts/accounts.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAGV,OAAO,EAKP,4BAA4B,EAC5B,2BAA2B,EAC3B,qBAAqB,EACrB,oBAAoB,EACpB,sBAAsB,EACtB,qBAAqB,EACrB,yBAAyB,EACzB,wBAAwB,EACxB,wBAAwB,EACxB,uBAAuB,EACvB,uBAAuB,EACvB,sBAAsB,EACtB,sBAAsB,EACtB,qBAAqB,EACrB,uBAAuB,EACvB,sBAAsB,EACtB,iBAAiB,EACjB,gBAAgB,EAChB,yBAAyB,EACzB,wBAAwB,EACzB,MAAM,aAAa,CAAC;AAerB;;;GAGG;AACH,wBAAgB,YAAY,CAAC,WAAW,CAAC,EAAE,MAAM,8BAMhD;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,gBAAgB,CAoBxE;AAED;;GAEG;AACH,wBAAgB,WAAW;;;;;EAiC1B;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CACnC,OAAO,CAAC,EAAE,4BAA4B,GACrC,2BAA2B,CA+I7B;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,CAAC,EAAE,uBAAuB,GAAG,sBAAsB,CA2C1F;AAsCD,eAAO,MAAM,+BAA+B,GAAI,YAAY,MAAM,EAAE,EAAE,gBAAgB,MAAM,EAAE,YACzC,CAAC;AAYtD,wBAAgB,kBAAkB,CAAC,OAAO,CAAC,EAAE,yBAAyB,GAAG,wBAAwB,CAwJhG;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,CAAC,EAAE,wBAAwB,GAAG,uBAAuB,CA2C7F;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,OAAO,CAAC,EAAE,sBAAsB,GAAG,qBAAqB,CA8GvF;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,OAAO,CAAC,EAAE,qBAAqB,GAAG,oBAAoB,CAyBpF;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,OAAO,CAAC,EAAE,sBAAsB,GAAG,qBAAqB,CA0DvF;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,CAAC,EAAE,uBAAuB,GAAG,sBAAsB,CAoJ1F;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,CAAC,EAAE,yBAAyB,GAAG,wBAAwB,CA+ChG"}