@selfcommunity/react-core 0.4.9-alpha.43 → 0.4.9-alpha.45

package/lib/cjs/components/provider/SCContextProvider/index.d.ts

@@ -18,9 +18,8 @@ import { SCContextProviderType, SCContextType } from '../../../types';
 export declare const SCContext: React.Context<SCContextType>;
 /**
  * This component imports all providers
- * @param object
- * @param object.conf
- * @param object.children
+ * @param conf
+ * @param children
  * @return
  * ```jsx
  * <SCContext.Provider value={{settings}}>

package/lib/cjs/components/provider/SCContextProvider/index.js

@@ -25,9 +25,8 @@ const useIsComponentMountedRef_1 = tslib_1.__importDefault(require("../../../uti
 exports.SCContext = (0, react_1.createContext)({});
 /**
  * This component imports all providers
- * @param object
- * @param object.conf
- * @param object.children
+ * @param conf
+ * @param children
  * @return
  * ```jsx
  * <SCContext.Provider value={{settings}}>

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

@@ -8,7 +8,7 @@ import { CacheStrategies } from '@selfcommunity/utils';
  * @param object
  * @param object.id
  * @param object.commentObject
- * @param cacheStrategy
+ * @param object.cacheStrategy
  */
 export default function useSCFetchCommentObject({ id, commentObject, cacheStrategy, }: {
     id?: number;

package/lib/cjs/hooks/useSCFetchCommentObject.js

@@ -13,7 +13,7 @@ const use_deep_compare_effect_1 = require("use-deep-compare-effect");
  * @param object
  * @param object.id
  * @param object.commentObject
- * @param cacheStrategy
+ * @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/useSCFetchCommentObjects.d.ts

@@ -34,13 +34,7 @@ export declare const commentsObjectActionTypes: {
  :::info
  This custom hooks is used to fetch paginated comments.
  :::
- * @param id
- * @param feedObject
- * @param feedObjectType
- * @param offset
- * @param pageSize
- * @param orderBy
- * @param parent
+ * @param props
  */
 export default function useSCFetchCommentObjects(props: {
     id?: number;

package/lib/cjs/hooks/useSCFetchCommentObjects.js

@@ -98,20 +98,13 @@ function stateInitializer(data) {
  :::info
  This custom hooks is used to fetch paginated comments.
  :::
- * @param id
- * @param feedObject
- * @param feedObjectType
- * @param offset
- * @param pageSize
- * @param orderBy
- * @param parent
+ * @param props
  */
 function useSCFetchCommentObjects(props) {
     // PROPS
     const { id, feedObject, feedObjectType, offset = 0, pageSize = 5, orderBy = types_1.SCCommentsOrderBy.ADDED_AT_DESC, parent, onChangePage, cacheStrategy = utils_1.CacheStrategies.NETWORK_ONLY, } = props;
     // FeedObject
     const { obj, setObj } = (0, useSCFetchFeedObject_1.default)({ id, feedObject, feedObjectType, cacheStrategy });
-    const objId = obj ? obj.id : null;
     /**
      * Get next url
      */

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

@@ -33,11 +33,7 @@ export declare const contributorsObjectActionTypes: {
  :::info
  This custom hooks is used to fetch paginated contributors.
  :::
- * @param id
- * @param feedObject
- * @param feedObjectType
- * @param offset
- * @param pageSize
+ * @param props
  */
 export default function useSCFetchContributors(props: {
     id?: number;

package/lib/cjs/hooks/useSCFetchContributors.js

@@ -76,11 +76,7 @@ function stateInitializer(data) {
  :::info
  This custom hooks is used to fetch paginated contributors.
  :::
- * @param id
- * @param feedObject
- * @param feedObjectType
- * @param offset
- * @param pageSize
+ * @param props
  */
 function useSCFetchContributors(props) {
     // PROPS

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

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

package/lib/cjs/hooks/useSCFetchCustomAdv.js

@@ -12,9 +12,10 @@ const Cache_1 = require("../constants/Cache");
  This custom hook is used to fetch a custom adv object.
  :::
  * @param object
+ * @param object.id
  * @param object.position
- * @param object.categoryId
- * @param cacheStrategy
+ * @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/useSCFetchFeed.d.ts

@@ -38,11 +38,7 @@ export declare const feedDataActionTypes: {
  :::info
  This custom hooks is used to fetch paginated Data.
  :::
- * @param endpoint
- * @param offset
- * @param pageSize
- * @param onChangePage
- * @param cacheStrategy
+ * @param props
  */
 export default function useSCFetchFeed(props: {
     id: string;

package/lib/cjs/hooks/useSCFetchFeed.js

@@ -90,11 +90,7 @@ function stateInitializer(data) {
  :::info
  This custom hooks is used to fetch paginated Data.
  :::
- * @param endpoint
- * @param offset
- * @param pageSize
- * @param onChangePage
- * @param cacheStrategy
+ * @param props
  */
 function useSCFetchFeed(props) {
     // PROPS

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

@@ -3,8 +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 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,8 +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 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,11 +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 object
  * @param object.id
- * @param object.user
+ * @param object.providers
  */
 export default function useSCFetchUserProviders({ id, providers }: {
     id: number | string;

package/lib/cjs/hooks/useSCFetchUserProviders.js

@@ -6,11 +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 object
  * @param object.id
- * @param object.user
+ * @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/components/provider/SCContextProvider/index.d.ts

@@ -18,9 +18,8 @@ import { SCContextProviderType, SCContextType } from '../../../types';
 export declare const SCContext: React.Context<SCContextType>;
 /**
  * This component imports all providers
- * @param object
- * @param object.conf
- * @param object.children
+ * @param conf
+ * @param children
  * @return
  * ```jsx
  * <SCContext.Provider value={{settings}}>

package/lib/esm/components/provider/SCContextProvider/index.js

@@ -21,9 +21,8 @@ import useIsComponentMountedRef from '../../../utils/hooks/useIsComponentMounted
 export const SCContext = createContext({});
 /**
  * This component imports all providers
- * @param object
- * @param object.conf
- * @param object.children
+ * @param conf
+ * @param children
  * @return
  * ```jsx
  * <SCContext.Provider value={{settings}}>

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

@@ -8,7 +8,7 @@ import { CacheStrategies } from '@selfcommunity/utils';
  * @param object
  * @param object.id
  * @param object.commentObject
- * @param cacheStrategy
+ * @param object.cacheStrategy
  */
 export default function useSCFetchCommentObject({ id, commentObject, cacheStrategy, }: {
     id?: number;

package/lib/esm/hooks/useSCFetchCommentObject.js

@@ -11,7 +11,7 @@ import { useDeepCompareEffectNoCheck } from 'use-deep-compare-effect';
  * @param object
  * @param object.id
  * @param object.commentObject
- * @param cacheStrategy
+ * @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/useSCFetchCommentObjects.d.ts

@@ -34,13 +34,7 @@ export declare const commentsObjectActionTypes: {
  :::info
  This custom hooks is used to fetch paginated comments.
  :::
- * @param id
- * @param feedObject
- * @param feedObjectType
- * @param offset
- * @param pageSize
- * @param orderBy
- * @param parent
+ * @param props
  */
 export default function useSCFetchCommentObjects(props: {
     id?: number;

package/lib/esm/hooks/useSCFetchCommentObjects.js

@@ -94,20 +94,13 @@ function stateInitializer(data) {
  :::info
  This custom hooks is used to fetch paginated comments.
  :::
- * @param id
- * @param feedObject
- * @param feedObjectType
- * @param offset
- * @param pageSize
- * @param orderBy
- * @param parent
+ * @param props
  */
 export default function useSCFetchCommentObjects(props) {
     // PROPS
     const { id, feedObject, feedObjectType, offset = 0, pageSize = 5, orderBy = SCCommentsOrderBy.ADDED_AT_DESC, parent, onChangePage, cacheStrategy = CacheStrategies.NETWORK_ONLY, } = props;
     // FeedObject
     const { obj, setObj } = useSCFetchFeedObject({ id, feedObject, feedObjectType, cacheStrategy });
-    const objId = obj ? obj.id : null;
     /**
      * Get next url
      */

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

@@ -33,11 +33,7 @@ export declare const contributorsObjectActionTypes: {
  :::info
  This custom hooks is used to fetch paginated contributors.
  :::
- * @param id
- * @param feedObject
- * @param feedObjectType
- * @param offset
- * @param pageSize
+ * @param props
  */
 export default function useSCFetchContributors(props: {
     id?: number;

package/lib/esm/hooks/useSCFetchContributors.js

@@ -72,11 +72,7 @@ function stateInitializer(data) {
  :::info
  This custom hooks is used to fetch paginated contributors.
  :::
- * @param id
- * @param feedObject
- * @param feedObjectType
- * @param offset
- * @param pageSize
+ * @param props
  */
 export default function useSCFetchContributors(props) {
     // PROPS

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

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

package/lib/esm/hooks/useSCFetchCustomAdv.js

@@ -9,9 +9,10 @@ import { getAdvObjectCacheKey } from '../constants/Cache';
  This custom hook is used to fetch a custom adv object.
  :::
  * @param object
+ * @param object.id
  * @param object.position
- * @param object.categoryId
- * @param cacheStrategy
+ * @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/useSCFetchFeed.d.ts

@@ -38,11 +38,7 @@ export declare const feedDataActionTypes: {
  :::info
  This custom hooks is used to fetch paginated Data.
  :::
- * @param endpoint
- * @param offset
- * @param pageSize
- * @param onChangePage
- * @param cacheStrategy
+ * @param props
  */
 export default function useSCFetchFeed(props: {
     id: string;

package/lib/esm/hooks/useSCFetchFeed.js

@@ -86,11 +86,7 @@ function stateInitializer(data) {
  :::info
  This custom hooks is used to fetch paginated Data.
  :::
- * @param endpoint
- * @param offset
- * @param pageSize
- * @param onChangePage
- * @param cacheStrategy
+ * @param props
  */
 export default function useSCFetchFeed(props) {
     // PROPS

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

@@ -3,8 +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 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,8 +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 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,11 +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 object
  * @param object.id
- * @param object.user
+ * @param object.providers
  */
 export default function useSCFetchUserProviders({ id, providers }: {
     id: number | string;

package/lib/esm/hooks/useSCFetchUserProviders.js

@@ -4,11 +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 object
  * @param object.id
- * @param object.user
+ * @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