@selfcommunity/react-core 0.4.9-alpha.44 → 0.4.9-alpha.46

package/lib/cjs/hooks/useSCFetchAddressingTagList.d.ts

@@ -3,8 +3,7 @@ import { SCTagType } from '@selfcommunity/types';
  :::info
  This custom hook is used to fetch the addressing tag list for the session user
  :::
-*  @param object
- * @param object.fetch
+ * @param fetch
  */
 export default function useSCFetchAddressingTagList({ fetch }: {
     fetch?: boolean;

package/lib/cjs/hooks/useSCFetchAddressingTagList.js

@@ -9,8 +9,7 @@ const SCUserProvider_1 = require("../components/provider/SCUserProvider");
  :::info
  This custom hook is used to fetch the addressing tag list for the session user
  :::
-*  @param object
- * @param object.fetch
+ * @param fetch
  */
 function useSCFetchAddressingTagList({ fetch = false }) {
     const [scAddressingTags, setSCAddressingTags] = (0, react_1.useState)([]);

package/lib/cjs/hooks/useSCFetchBroadcastMessages.d.ts

@@ -4,8 +4,6 @@ import { CacheStrategies } from '@selfcommunity/utils';
 /**
  :::info
  This custom hook is used to fetch broadcast messages.
- @param object
- @param object.cacheStrategy
 
  :::tip Context can be consumed in this way:
 
@@ -13,6 +11,7 @@ import { CacheStrategies } from '@selfcommunity/utils';
  const {messages, isLoading} = useSCFetchBroadcastMessages();
  ```
  :::
+ * @param props
  */
 declare const useSCFetchBroadcastMessages: (props?: {
     cacheStrategy?: CacheStrategies;

package/lib/cjs/hooks/useSCFetchBroadcastMessages.js

@@ -21,8 +21,6 @@ const initialData = { results: [], next: broadcastMessagesRefreshUrl, previous:
 /**
  :::info
  This custom hook is used to fetch broadcast messages.
- @param object
- @param object.cacheStrategy
 
  :::tip Context can be consumed in this way:
 
@@ -30,6 +28,7 @@ const initialData = { results: [], next: broadcastMessagesRefreshUrl, previous:
  const {messages, isLoading} = useSCFetchBroadcastMessages();
  ```
  :::
+ * @param props
  */
 const useSCFetchBroadcastMessages = (props) => {
     // PROPS

package/lib/cjs/hooks/useSCFetchCommentObject.d.ts

@@ -5,9 +5,10 @@ import { CacheStrategies } from '@selfcommunity/utils';
  :::info
  This custom hooks is used to fetch a comment.
  :::
- * @param id
- * @param commentObject
- * @param cacheStrategy
+ * @param object
+ * @param object.id
+ * @param object.commentObject
+ * @param object.cacheStrategy
  */
 export default function useSCFetchCommentObject({ id, commentObject, cacheStrategy, }: {
     id?: number;

package/lib/cjs/hooks/useSCFetchCommentObject.js

@@ -10,9 +10,10 @@ const use_deep_compare_effect_1 = require("use-deep-compare-effect");
  :::info
  This custom hooks is used to fetch a comment.
  :::
- * @param id
- * @param commentObject
- * @param cacheStrategy
+ * @param object
+ * @param object.id
+ * @param object.commentObject
+ * @param object.cacheStrategy
  */
 function useSCFetchCommentObject({ id = null, commentObject = null, cacheStrategy = utils_1.CacheStrategies.CACHE_FIRST, }) {
     const __commentObjectId = commentObject ? commentObject.id : id;

package/lib/cjs/hooks/useSCFetchCustomAdv.d.ts

@@ -5,10 +5,11 @@ import { SCCustomAdvPosition, SCCustomAdvType } from '@selfcommunity/types';
  :::info
  This custom hook is used to fetch a custom adv object.
  :::
- * @param id
- * @param position
- * @param categoriesId
- * @param cacheStrategy
+ * @param object
+ * @param object.id
+ * @param object.position
+ * @param object.categoriesId
+ * @param object.cacheStrategy
  */
 export default function useSCFetchCustomAdv({ id, position, categoriesId, cacheStrategy, }: {
     id?: number;

package/lib/cjs/hooks/useSCFetchCustomAdv.js

@@ -11,10 +11,11 @@ const Cache_1 = require("../constants/Cache");
  :::info
  This custom hook is used to fetch a custom adv object.
  :::
- * @param id
- * @param position
- * @param categoriesId
- * @param cacheStrategy
+ * @param object
+ * @param object.id
+ * @param object.position
+ * @param object.categoriesId
+ * @param object.cacheStrategy
  */
 function useSCFetchCustomAdv({ id = null, position = null, categoriesId = null, cacheStrategy = utils_1.CacheStrategies.CACHE_FIRST, }) {
     const [scCustomAdv, setSCCustomAdv] = (0, react_1.useState)(id !== null && cacheStrategy === utils_1.CacheStrategies.CACHE_FIRST && utils_1.LRUCache.get((0, Cache_1.getAdvObjectCacheKey)(id))

package/lib/cjs/hooks/useSCFetchUser.d.ts

@@ -4,8 +4,9 @@ import { SCUserType } from '@selfcommunity/types';
  :::info
  This custom hook is used to fetch a user object.
  :::
- * @param id
- * @param user
+ * @param object
+ * @param object.id
+ * @param object.user
  */
 export default function useSCFetchUser({ id, user }: {
     id?: number | string;

package/lib/cjs/hooks/useSCFetchUser.js

@@ -9,8 +9,9 @@ const SCUserProvider_1 = require("../components/provider/SCUserProvider");
  :::info
  This custom hook is used to fetch a user object.
  :::
- * @param id
- * @param user
+ * @param object
+ * @param object.id
+ * @param object.user
  */
 function useSCFetchUser({ id = null, user = null }) {
     // CONTEXT

package/lib/cjs/hooks/useSCFetchUserBlockedBy.d.ts

@@ -3,9 +3,10 @@ import { SCUserType } from '@selfcommunity/types';
  :::info
  This custom hook is used to fetch if a user is blocked by another user.
  :::
- * @param user
- * @param blockedByUser
- * @param sync
+ * @param object
+ * @param object.user
+ * @param object.blockedByUser
+ * @param object.sync
  */
 export default function useSCFetchUserBlockedBy({ user, blockedByUser, sync, }: {
     user: SCUserType;

package/lib/cjs/hooks/useSCFetchUserBlockedBy.js

@@ -9,9 +9,10 @@ const SCUserProvider_1 = require("../components/provider/SCUserProvider");
  :::info
  This custom hook is used to fetch if a user is blocked by another user.
  :::
- * @param user
- * @param blockedByUser
- * @param sync
+ * @param object
+ * @param object.user
+ * @param object.blockedByUser
+ * @param object.sync
  */
 function useSCFetchUserBlockedBy({ user = null, blockedByUser = null, sync = true, }) {
     const [blockedBy, setBlockedBy] = (0, react_1.useState)(null);

package/lib/cjs/hooks/useSCFetchUserProviders.d.ts

@@ -2,10 +2,11 @@
 import { SCUserProviderAssociationType } from '@selfcommunity/types';
 /**
  :::info
- This custom hook is used to fetch the listo of user providers.
+ This custom hook is used to fetch the list of user providers.
  :::
- * @param id
- * @param providers
+ * @param object
+ * @param object.id
+ * @param object.providers
  */
 export default function useSCFetchUserProviders({ id, providers }: {
     id: number | string;

package/lib/cjs/hooks/useSCFetchUserProviders.js

@@ -6,10 +6,11 @@ const api_services_1 = require("@selfcommunity/api-services");
 const utils_1 = require("@selfcommunity/utils");
 /**
  :::info
- This custom hook is used to fetch the listo of user providers.
+ This custom hook is used to fetch the list of user providers.
  :::
- * @param id
- * @param providers
+ * @param object
+ * @param object.id
+ * @param object.providers
  */
 function useSCFetchUserProviders({ id, providers = null }) {
     const [scUserProviders, setSCUserProviders] = (0, react_1.useState)(providers || []);

package/lib/cjs/hooks/useSCFetchVote.d.ts

@@ -31,6 +31,12 @@ interface FetchVoteProps {
  :::info
  This custom hook is used to fetch a contribution vote.
  :::
+ * @param object
+ * @param object.id
+ * @param object.contribution
+ * @param object.contributionType
+ * @param object.onVote
+ * @param object.cacheStrategy
  */
 export default function useSCFetchVote({ id, contribution, contributionType, onVote, cacheStrategy, }: FetchVoteProps): {
     isLoading: boolean;

package/lib/cjs/hooks/useSCFetchVote.js

@@ -13,6 +13,12 @@ const SCVoteProvider_1 = require("../components/provider/SCVoteProvider");
  :::info
  This custom hook is used to fetch a contribution vote.
  :::
+ * @param object
+ * @param object.id
+ * @param object.contribution
+ * @param object.contributionType
+ * @param object.onVote
+ * @param object.cacheStrategy
  */
 function useSCFetchVote({ id, contribution = null, contributionType, onVote = null, cacheStrategy = utils_1.CacheStrategies.CACHE_FIRST, }) {
     // MEMO

package/lib/esm/hooks/useSCFetchAddressingTagList.d.ts

@@ -3,8 +3,7 @@ import { SCTagType } from '@selfcommunity/types';
  :::info
  This custom hook is used to fetch the addressing tag list for the session user
  :::
-*  @param object
- * @param object.fetch
+ * @param fetch
  */
 export default function useSCFetchAddressingTagList({ fetch }: {
     fetch?: boolean;

package/lib/esm/hooks/useSCFetchAddressingTagList.js

@@ -7,8 +7,7 @@ import { useSCUser } from '../components/provider/SCUserProvider';
  :::info
  This custom hook is used to fetch the addressing tag list for the session user
  :::
-*  @param object
- * @param object.fetch
+ * @param fetch
  */
 export default function useSCFetchAddressingTagList({ fetch = false }) {
     const [scAddressingTags, setSCAddressingTags] = useState([]);

package/lib/esm/hooks/useSCFetchBroadcastMessages.d.ts

@@ -4,8 +4,6 @@ import { CacheStrategies } from '@selfcommunity/utils';
 /**
  :::info
  This custom hook is used to fetch broadcast messages.
- @param object
- @param object.cacheStrategy
 
  :::tip Context can be consumed in this way:
 
@@ -13,6 +11,7 @@ import { CacheStrategies } from '@selfcommunity/utils';
  const {messages, isLoading} = useSCFetchBroadcastMessages();
  ```
  :::
+ * @param props
  */
 declare const useSCFetchBroadcastMessages: (props?: {
     cacheStrategy?: CacheStrategies;

package/lib/esm/hooks/useSCFetchBroadcastMessages.js

@@ -19,8 +19,6 @@ const initialData = { results: [], next: broadcastMessagesRefreshUrl, previous:
 /**
  :::info
  This custom hook is used to fetch broadcast messages.
- @param object
- @param object.cacheStrategy
 
  :::tip Context can be consumed in this way:
 
@@ -28,6 +26,7 @@ const initialData = { results: [], next: broadcastMessagesRefreshUrl, previous:
  const {messages, isLoading} = useSCFetchBroadcastMessages();
  ```
  :::
+ * @param props
  */
 const useSCFetchBroadcastMessages = (props) => {
     // PROPS

package/lib/esm/hooks/useSCFetchCommentObject.d.ts

@@ -5,9 +5,10 @@ import { CacheStrategies } from '@selfcommunity/utils';
  :::info
  This custom hooks is used to fetch a comment.
  :::
- * @param id
- * @param commentObject
- * @param cacheStrategy
+ * @param object
+ * @param object.id
+ * @param object.commentObject
+ * @param object.cacheStrategy
  */
 export default function useSCFetchCommentObject({ id, commentObject, cacheStrategy, }: {
     id?: number;

package/lib/esm/hooks/useSCFetchCommentObject.js

@@ -8,9 +8,10 @@ import { useDeepCompareEffectNoCheck } from 'use-deep-compare-effect';
  :::info
  This custom hooks is used to fetch a comment.
  :::
- * @param id
- * @param commentObject
- * @param cacheStrategy
+ * @param object
+ * @param object.id
+ * @param object.commentObject
+ * @param object.cacheStrategy
  */
 export default function useSCFetchCommentObject({ id = null, commentObject = null, cacheStrategy = CacheStrategies.CACHE_FIRST, }) {
     const __commentObjectId = commentObject ? commentObject.id : id;

package/lib/esm/hooks/useSCFetchCustomAdv.d.ts

@@ -5,10 +5,11 @@ import { SCCustomAdvPosition, SCCustomAdvType } from '@selfcommunity/types';
  :::info
  This custom hook is used to fetch a custom adv object.
  :::
- * @param id
- * @param position
- * @param categoriesId
- * @param cacheStrategy
+ * @param object
+ * @param object.id
+ * @param object.position
+ * @param object.categoriesId
+ * @param object.cacheStrategy
  */
 export default function useSCFetchCustomAdv({ id, position, categoriesId, cacheStrategy, }: {
     id?: number;

package/lib/esm/hooks/useSCFetchCustomAdv.js

@@ -8,10 +8,11 @@ import { getAdvObjectCacheKey } from '../constants/Cache';
  :::info
  This custom hook is used to fetch a custom adv object.
  :::
- * @param id
- * @param position
- * @param categoriesId
- * @param cacheStrategy
+ * @param object
+ * @param object.id
+ * @param object.position
+ * @param object.categoriesId
+ * @param object.cacheStrategy
  */
 export default function useSCFetchCustomAdv({ id = null, position = null, categoriesId = null, cacheStrategy = CacheStrategies.CACHE_FIRST, }) {
     const [scCustomAdv, setSCCustomAdv] = useState(id !== null && cacheStrategy === CacheStrategies.CACHE_FIRST && LRUCache.get(getAdvObjectCacheKey(id))

package/lib/esm/hooks/useSCFetchUser.d.ts

@@ -4,8 +4,9 @@ import { SCUserType } from '@selfcommunity/types';
  :::info
  This custom hook is used to fetch a user object.
  :::
- * @param id
- * @param user
+ * @param object
+ * @param object.id
+ * @param object.user
  */
 export default function useSCFetchUser({ id, user }: {
     id?: number | string;

package/lib/esm/hooks/useSCFetchUser.js

@@ -7,8 +7,9 @@ import { useSCUser } from '../components/provider/SCUserProvider';
  :::info
  This custom hook is used to fetch a user object.
  :::
- * @param id
- * @param user
+ * @param object
+ * @param object.id
+ * @param object.user
  */
 export default function useSCFetchUser({ id = null, user = null }) {
     // CONTEXT

package/lib/esm/hooks/useSCFetchUserBlockedBy.d.ts

@@ -3,9 +3,10 @@ import { SCUserType } from '@selfcommunity/types';
  :::info
  This custom hook is used to fetch if a user is blocked by another user.
  :::
- * @param user
- * @param blockedByUser
- * @param sync
+ * @param object
+ * @param object.user
+ * @param object.blockedByUser
+ * @param object.sync
  */
 export default function useSCFetchUserBlockedBy({ user, blockedByUser, sync, }: {
     user: SCUserType;

package/lib/esm/hooks/useSCFetchUserBlockedBy.js

@@ -7,9 +7,10 @@ import { useSCUser } from '../components/provider/SCUserProvider';
  :::info
  This custom hook is used to fetch if a user is blocked by another user.
  :::
- * @param user
- * @param blockedByUser
- * @param sync
+ * @param object
+ * @param object.user
+ * @param object.blockedByUser
+ * @param object.sync
  */
 export default function useSCFetchUserBlockedBy({ user = null, blockedByUser = null, sync = true, }) {
     const [blockedBy, setBlockedBy] = useState(null);

package/lib/esm/hooks/useSCFetchUserProviders.d.ts

@@ -2,10 +2,11 @@
 import { SCUserProviderAssociationType } from '@selfcommunity/types';
 /**
  :::info
- This custom hook is used to fetch the listo of user providers.
+ This custom hook is used to fetch the list of user providers.
  :::
- * @param id
- * @param providers
+ * @param object
+ * @param object.id
+ * @param object.providers
  */
 export default function useSCFetchUserProviders({ id, providers }: {
     id: number | string;

package/lib/esm/hooks/useSCFetchUserProviders.js

@@ -4,10 +4,11 @@ import { UserService } from '@selfcommunity/api-services';
 import { Logger } from '@selfcommunity/utils';
 /**
  :::info
- This custom hook is used to fetch the listo of user providers.
+ This custom hook is used to fetch the list of user providers.
  :::
- * @param id
- * @param providers
+ * @param object
+ * @param object.id
+ * @param object.providers
  */
 export default function useSCFetchUserProviders({ id, providers = null }) {
     const [scUserProviders, setSCUserProviders] = useState(providers || []);

package/lib/esm/hooks/useSCFetchVote.d.ts

@@ -31,6 +31,12 @@ interface FetchVoteProps {
  :::info
  This custom hook is used to fetch a contribution vote.
  :::
+ * @param object
+ * @param object.id
+ * @param object.contribution
+ * @param object.contributionType
+ * @param object.onVote
+ * @param object.cacheStrategy
  */
 export default function useSCFetchVote({ id, contribution, contributionType, onVote, cacheStrategy, }: FetchVoteProps): {
     isLoading: boolean;

package/lib/esm/hooks/useSCFetchVote.js

@@ -11,6 +11,12 @@ import { useSCVote } from '../components/provider/SCVoteProvider';
  :::info
  This custom hook is used to fetch a contribution vote.
  :::
+ * @param object
+ * @param object.id
+ * @param object.contribution
+ * @param object.contributionType
+ * @param object.onVote
+ * @param object.cacheStrategy
  */
 export default function useSCFetchVote({ id, contribution = null, contributionType, onVote = null, cacheStrategy = CacheStrategies.CACHE_FIRST, }) {
     // MEMO

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@selfcommunity/react-core",
-  "version": "0.4.9-alpha.44",
+  "version": "0.4.9-alpha.46",
   "description": "React Core Components useful for integrating UI Community components (react-ui).",
   "author": "SelfCommunity <https://www.selfcommunity.com>",
   "homepage": "https://www.selfcommunity.com",
@@ -68,10 +68,10 @@
     "react-intl": "^6.4.7"
   },
   "dependencies": {
-    "@selfcommunity/api-services": "^0.4.9-alpha.18",
-    "@selfcommunity/react-i18n": "^0.5.9-alpha.24",
-    "@selfcommunity/types": "^0.5.9-alpha.11",
-    "@selfcommunity/utils": "^0.2.9-alpha.0",
+    "@selfcommunity/api-services": "^0.4.9-alpha.19",
+    "@selfcommunity/react-i18n": "^0.5.9-alpha.25",
+    "@selfcommunity/types": "^0.5.9-alpha.12",
+    "@selfcommunity/utils": "^0.2.9-alpha.1",
     "js-cookie": "^3.0.5",
     "pubsub-js": "^1.9.4",
     "use-deep-compare-effect": "^1.8.1",
@@ -125,5 +125,5 @@
   "bugs": {
     "url": "https://github.com/selfcommunity/community-js/issues"
   },
-  "gitHead": "d5dc3d29b0cefc82e2919919ad417f2cfff4ac39"
+  "gitHead": "0098b014f6c947da317ff96fb0809ad65edff179"
 }