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

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/useSCFetchCommentObject.d.ts

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

package/lib/cjs/hooks/useSCFetchCommentObject.js

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

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

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

package/lib/cjs/hooks/useSCFetchCustomAdv.js

@@ -11,9 +11,9 @@ const Cache_1 = require("../constants/Cache");
  :::info
  This custom hook is used to fetch a custom adv object.
  :::
- * @param object
- * @param object.position
- * @param object.categoryId
+ * @param id
+ * @param position
+ * @param categoriesId
  * @param cacheStrategy
  */
 function useSCFetchCustomAdv({ id = null, position = null, categoriesId = null, cacheStrategy = utils_1.CacheStrategies.CACHE_FIRST, }) {

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/useSCFetchUser.d.ts

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

package/lib/cjs/hooks/useSCFetchUser.js

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

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

@@ -5,6 +5,7 @@ import { SCUserType } from '@selfcommunity/types';
  :::
  * @param user
  * @param blockedByUser
+ * @param sync
  */
 export default function useSCFetchUserBlockedBy({ user, blockedByUser, sync, }: {
     user: SCUserType;

package/lib/cjs/hooks/useSCFetchUserBlockedBy.js

@@ -11,6 +11,7 @@ const SCUserProvider_1 = require("../components/provider/SCUserProvider");
  :::
  * @param user
  * @param blockedByUser
+ * @param sync
  */
 function useSCFetchUserBlockedBy({ user = null, blockedByUser = null, sync = true, }) {
     const [blockedBy, setBlockedBy] = (0, react_1.useState)(null);

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

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

package/lib/cjs/hooks/useSCFetchUserProviders.js

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

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/useSCFetchCommentObject.d.ts

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

package/lib/esm/hooks/useSCFetchCommentObject.js

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

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

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

package/lib/esm/hooks/useSCFetchCustomAdv.js

@@ -8,9 +8,9 @@ import { getAdvObjectCacheKey } from '../constants/Cache';
  :::info
  This custom hook is used to fetch a custom adv object.
  :::
- * @param object
- * @param object.position
- * @param object.categoryId
+ * @param id
+ * @param position
+ * @param categoriesId
  * @param cacheStrategy
  */
 export default function useSCFetchCustomAdv({ id = null, position = null, categoriesId = null, cacheStrategy = CacheStrategies.CACHE_FIRST, }) {

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/useSCFetchUser.d.ts

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

package/lib/esm/hooks/useSCFetchUser.js

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

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

@@ -5,6 +5,7 @@ import { SCUserType } from '@selfcommunity/types';
  :::
  * @param user
  * @param blockedByUser
+ * @param sync
  */
 export default function useSCFetchUserBlockedBy({ user, blockedByUser, sync, }: {
     user: SCUserType;

package/lib/esm/hooks/useSCFetchUserBlockedBy.js

@@ -9,6 +9,7 @@ import { useSCUser } from '../components/provider/SCUserProvider';
  :::
  * @param user
  * @param blockedByUser
+ * @param sync
  */
 export default function useSCFetchUserBlockedBy({ user = null, blockedByUser = null, sync = true, }) {
     const [blockedBy, setBlockedBy] = useState(null);

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

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

package/lib/esm/hooks/useSCFetchUserProviders.js

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