@selfcommunity/react-core 0.4.55 → 0.5.0-alpha.0

package/lib/esm/index.js

@@ -58,6 +58,8 @@ import useSCFetchUserBlockedBy from './hooks/useSCFetchUserBlockedBy';
 import useSCUserIsBlocked from './hooks/useSCUserIsBlocked';
 import useSCFetchGroup from './hooks/useSCFetchGroup';
 import useSCFetchGroups from './hooks/useSCFetchGroups';
+import useSCFetchEvent from './hooks/useSCFetchEvent';
+import useSCFetchEvents from './hooks/useSCFetchEvents';
 /**
  * Routing component
  */
@@ -68,13 +70,16 @@ import * as SCRoutes from './constants/Routes';
  * User, hooks (useIsComponentMountedRef)
  */
 import * as UserUtils from './utils/user';
+import getTheme from './themes/theme';
 import { useIsComponentMountedRef, usePreviousValue, useIsomorphicLayoutEffect, useEffectOnce, useNoInitialEffect } from './utils/hooks';
+import { getEventStatus } from './utils/event';
 /**
  * Constants:
- * Locale
+ * Locale, Preferences
  */
 import * as Locale from './constants/Locale';
+import * as Preferences from './constants/Preferences';
 /**
  * List all exports
  */
-export { SCContext, SCUserContext, SCThemeContext, SCRoutingContext, SCLocaleContext, SCPreferencesContext, useSCContext, SCContextProvider, SCUserProvider, useSCUser, useSCPreferences, SCThemeProvider, useSCTheme, withSCTheme, SCRoutingProvider, useSCRouting, SCLocaleProvider, useSCLocale, withSCLocale, SCPreferencesProvider, SCPreferences, SCFeatures, SCNotification, SCNotificationProvider, SCNotificationContext, useSCNotification, SCAlertMessagesProvider, SCAlertMessagesContext, useSCAlertMessages, Link, SCRoutes, SCCache, UserUtils, Locale, useSCFetchUser, useSCFetchUserProviders, useSCFetchVote, useSCFetchFeedObject, useSCFetchCommentObject, useSCFetchCommentObjects, useSCFetchCustomAdv, useSCFetchTag, useSCFetchAddressingTagList, useSCFetchCategory, useSCFetchCategories, useSCFetchIncubator, useSCMediaClick, useSCFetchContributors, useSCFetchFeed, useIsComponentMountedRef, usePreviousValue, useIsomorphicLayoutEffect, useEffectOnce, useNoInitialEffect, useSCFetchPrivateMessageSnippets, useSCFetchBroadcastMessages, useSCFetchUserBlockedBy, useSCUserIsBlocked, useSCFetchGroup, useSCFetchGroups, };
+export { SCContext, SCUserContext, SCThemeContext, SCRoutingContext, SCLocaleContext, SCPreferencesContext, useSCContext, SCContextProvider, SCUserProvider, useSCUser, useSCPreferences, SCThemeProvider, useSCTheme, withSCTheme, getTheme, SCRoutingProvider, useSCRouting, SCLocaleProvider, useSCLocale, withSCLocale, SCPreferencesProvider, SCPreferences, SCFeatures, SCNotification, SCNotificationProvider, SCNotificationContext, useSCNotification, SCAlertMessagesProvider, SCAlertMessagesContext, useSCAlertMessages, Link, SCRoutes, SCCache, UserUtils, getEventStatus, Locale, Preferences, useSCFetchUser, useSCFetchUserProviders, useSCFetchVote, useSCFetchFeedObject, useSCFetchCommentObject, useSCFetchCommentObjects, useSCFetchCustomAdv, useSCFetchTag, useSCFetchAddressingTagList, useSCFetchCategory, useSCFetchCategories, useSCFetchIncubator, useSCMediaClick, useSCFetchContributors, useSCFetchFeed, useIsComponentMountedRef, usePreviousValue, useIsomorphicLayoutEffect, useEffectOnce, useNoInitialEffect, useSCFetchPrivateMessageSnippets, useSCFetchBroadcastMessages, useSCFetchUserBlockedBy, useSCUserIsBlocked, useSCFetchGroup, useSCFetchGroups, useSCFetchEvent, useSCFetchEvents, };

package/lib/esm/types/context.d.ts

@@ -1,5 +1,5 @@
 import React, { ReactNode } from 'react';
-import { SCAuthTokenType, SCIncubatorType, SCCategoryType, SCUserType, SCUserSettingsType, SCReactionType, SCGroupType } from '@selfcommunity/types';
+import { SCAuthTokenType, SCIncubatorType, SCCategoryType, SCUserType, SCUserSettingsType, SCReactionType, SCGroupType, SCEventType } from '@selfcommunity/types';
 import { SCThemeType } from './theme';
 /**
  * Interface SCSettingsType
@@ -37,6 +37,10 @@ export interface SCSettingsType {
      * Object conf of notification.
      */
     notifications?: SCNotificationsType;
+    /**
+     * Integrations conf
+     */
+    integrations?: SCIntegrationsType;
     /**
      * Callback to handle anonymous action
      * Ex. an anonymous user attempt to post a comment
@@ -143,6 +147,7 @@ export interface SCUserContextType {
         incubators?: SCSubscribedIncubatorsManagerType;
         blockedUsers?: SCBlockedUsersManagerType;
         groups?: SCSubscribedGroupsManagerType;
+        events?: SCSubscribedEventsManagerType;
     };
 }
 export interface SCSettingsManagerType {
@@ -249,6 +254,44 @@ export interface SCFollowedCategoriesManagerType {
      */
     emptyCache?: () => void;
 }
+export interface SCSubscribedEventsManagerType {
+    /**
+     * List of all events ids followed by the authenticated user
+     */
+    events: number[];
+    /**
+     * List of all events in loading state
+     */
+    loading: number[];
+    /**
+     * List of current events in loading state
+     */
+    isLoading: (event: SCEventType) => boolean;
+    /**
+     * Handle user subscription to an event
+     */
+    subscribe?: (event: SCEventType, userId?: number) => Promise<any>;
+    /**
+     * Handle user going to an event
+     */
+    toggleEventAttendance?: (event: SCEventType, userId?: number) => Promise<any>;
+    /**
+     * Handle user not going to an event
+     */
+    toggleEventNonattendance?: (event: SCEventType, userId?: number) => Promise<any>;
+    /**
+     * Handles a user subscription status to an event, caching data
+     */
+    subscriptionStatus?: (event: SCEventType) => string;
+    /**
+     * Refresh groups
+     */
+    refresh?: () => void;
+    /**
+     * Empty cache to revalidate all groups
+     */
+    emptyCache?: () => void;
+}
 export interface SCSubscribedGroupsManagerType {
     /**
      * List of all groups ids followed by the authenticated user
@@ -444,6 +487,18 @@ export interface SCPreferencesContextType {
      * List of all community enabled features
      */
     features: string[];
+    /**
+     * Set prefrerences
+     */
+    setPreferences: (preferences: Record<string, any>) => void;
+    /**
+     * Set features
+     */
+    setFeatures: (features: string[]) => void;
+    /**
+     * Force refresh
+     */
+    refresh: () => void;
 }
 /**
  * Interface SCVoteContextType
@@ -628,9 +683,13 @@ export interface SCIntegrationsType {
      * OpenAI
      */
     openai?: SCIntegrationsOpenAIType;
+    /**
+     * Geocoding
+     */
+    geocoding?: SCGeocodingType;
 }
 /**
- * Interface SCNotificationsWebSocketType
+ * Interface SCIntegrationsOpenAIType
  */
 export interface SCIntegrationsOpenAIType {
     /**
@@ -639,3 +698,13 @@ export interface SCIntegrationsOpenAIType {
      */
     secretKey: string | null;
 }
+/**
+ * Interface SCGeocodingType
+ */
+export interface SCGeocodingType {
+    /**
+     * Set secretKey geocoding service
+     * Default: null
+     */
+    apiKey: string | null;
+}

package/lib/esm/types/index.d.ts

@@ -1,3 +1,3 @@
-import { SCUserContextType, SCFollowedManagerType, SCFollowersManagerType, SCFollowedCategoriesManagerType, SCSettingsManagerType, SCSubscribedIncubatorsManagerType, SCConnectionsManagerType, SCBlockedUsersManagerType, SCContextProviderType, SCContextType, SCSettingsType, SCSessionType, SCPreferencesContextType, SCNotificationContextType, SCLocaleType, SCVoteType, SCVoteContextType, SCThemeContextType, SCRoutingContextType, SCLocaleContextType, SCAlertMessagesContextType, SCSubscribedGroupsManagerType } from './context';
+import { SCUserContextType, SCFollowedManagerType, SCFollowersManagerType, SCFollowedCategoriesManagerType, SCSettingsManagerType, SCSubscribedIncubatorsManagerType, SCConnectionsManagerType, SCBlockedUsersManagerType, SCContextProviderType, SCContextType, SCSettingsType, SCSessionType, SCPreferencesContextType, SCNotificationContextType, SCLocaleType, SCVoteType, SCVoteContextType, SCThemeContextType, SCRoutingContextType, SCLocaleContextType, SCAlertMessagesContextType, SCSubscribedGroupsManagerType, SCSubscribedEventsManagerType } from './context';
 import { SCThemeAvatarVariableType, SCThemeUserVariableType, SCThemeCategoryIconVariableType, SCThemeCategoryVariableType, SCThemeVariablesType, SCThemeType } from './theme';
-export { SCUserContextType, SCFollowedCategoriesManagerType, SCSettingsManagerType, SCContextProviderType, SCContextType, SCSettingsType, SCSessionType, SCFollowedManagerType, SCFollowersManagerType, SCConnectionsManagerType, SCBlockedUsersManagerType, SCSubscribedIncubatorsManagerType, SCLocaleType, SCVoteType, SCVoteContextType, SCNotificationContextType, SCPreferencesContextType, SCThemeContextType, SCRoutingContextType, SCLocaleContextType, SCAlertMessagesContextType, SCThemeAvatarVariableType, SCThemeUserVariableType, SCThemeCategoryIconVariableType, SCThemeCategoryVariableType, SCThemeVariablesType, SCThemeType, SCSubscribedGroupsManagerType, };
+export { SCUserContextType, SCFollowedCategoriesManagerType, SCSettingsManagerType, SCContextProviderType, SCContextType, SCSettingsType, SCSessionType, SCFollowedManagerType, SCFollowersManagerType, SCConnectionsManagerType, SCBlockedUsersManagerType, SCSubscribedIncubatorsManagerType, SCLocaleType, SCVoteType, SCVoteContextType, SCNotificationContextType, SCPreferencesContextType, SCThemeContextType, SCRoutingContextType, SCLocaleContextType, SCAlertMessagesContextType, SCThemeAvatarVariableType, SCThemeUserVariableType, SCThemeCategoryIconVariableType, SCThemeCategoryVariableType, SCThemeVariablesType, SCThemeType, SCSubscribedGroupsManagerType, SCSubscribedEventsManagerType, };

package/lib/esm/utils/errors.d.ts

@@ -36,6 +36,8 @@ export declare class ValidationError {
     static ERROR_INVALID_INTEGRATIONS: number;
     static ERROR_INVALID_INTEGRATIONS_OPENAI: number;
     static ERROR_INVALID_INTEGRATIONS_OPENAI_SECRETKEY: number;
+    static ERROR_INVALID_INTEGRATIONS_GEOCODING: number;
+    static ERROR_INVALID_INTEGRATIONS_GEOCODING_APIKEY: number;
     static defaultErrorMessageMap: {
         [x: number]: string;
     };

package/lib/esm/utils/errors.js

@@ -48,6 +48,8 @@ ValidationError.ERROR_INVALID_VOTE_REACTIONS_STRUCTURE = 6002;
 ValidationError.ERROR_INVALID_INTEGRATIONS = 6100;
 ValidationError.ERROR_INVALID_INTEGRATIONS_OPENAI = 6101;
 ValidationError.ERROR_INVALID_INTEGRATIONS_OPENAI_SECRETKEY = 6102;
+ValidationError.ERROR_INVALID_INTEGRATIONS_GEOCODING = 6103;
+ValidationError.ERROR_INVALID_INTEGRATIONS_GEOCODING_APIKEY = 6104;
 ValidationError.defaultErrorMessageMap = {
     [ValidationError.ERROR_INVALID_CONF]: 'Invalid or missing library configuration. Check the configuration that is passed to the SCContextProvider.',
     [ValidationError.ERROR_INVALID_SESSION]: 'Invalid session format.',
@@ -82,6 +84,8 @@ ValidationError.defaultErrorMessageMap = {
     [ValidationError.ERROR_INVALID_INTEGRATIONS]: 'Invalid integrations conf.',
     [ValidationError.ERROR_INVALID_INTEGRATIONS_OPENAI]: 'Invalid integrations (openai) option.',
     [ValidationError.ERROR_INVALID_INTEGRATIONS_OPENAI_SECRETKEY]: 'Invalid integrations openai conf: secretKey must be a string value.',
+    [ValidationError.ERROR_INVALID_INTEGRATIONS_GEOCODING]: 'Invalid integrations (geocoding) option.',
+    [ValidationError.ERROR_INVALID_INTEGRATIONS_GEOCODING_APIKEY]: 'Invalid integrations geocoding conf: apiKey must be a string value.',
 };
 /**
  * Manage Validation Warnings

package/lib/esm/utils/event.d.ts

@@ -0,0 +1,8 @@
+import { SCEventSubscriptionStatusType, SCEventType } from '@selfcommunity/types';
+/**
+ * Get event status
+ * @returns status or null
+ * @param event
+ * @param going
+ */
+export declare function getEventStatus(event: SCEventType, going: boolean): SCEventSubscriptionStatusType | null;

package/lib/esm/utils/event.js

@@ -0,0 +1,25 @@
+import { SCEventPrivacyType, SCEventSubscriptionStatusType } from '@selfcommunity/types';
+/**
+ * Get event status
+ * @returns status or null
+ * @param event
+ * @param going
+ */
+export function getEventStatus(event, going) {
+    const { subscription_status: status, privacy } = event;
+    if (!status) {
+        return privacy === SCEventPrivacyType.PRIVATE ? SCEventSubscriptionStatusType.REQUESTED : SCEventSubscriptionStatusType.SUBSCRIBED;
+    }
+    switch (status) {
+        case SCEventSubscriptionStatusType.INVITED:
+        case SCEventSubscriptionStatusType.GOING:
+        case SCEventSubscriptionStatusType.NOT_GOING:
+            return SCEventSubscriptionStatusType.SUBSCRIBED;
+        case SCEventSubscriptionStatusType.SUBSCRIBED:
+            return going ? SCEventSubscriptionStatusType.GOING : SCEventSubscriptionStatusType.NOT_GOING;
+        case SCEventSubscriptionStatusType.REQUESTED:
+            return privacy === SCEventPrivacyType.PRIVATE ? null : SCEventSubscriptionStatusType.SUBSCRIBED;
+        default:
+            return null;
+    }
+}

package/lib/esm/utils/user.d.ts

@@ -6,6 +6,7 @@ import { SCUserType } from '@selfcommunity/types';
 export declare const ADMIN_ROLE = "admin";
 export declare const MODERATOR_ROLE = "moderator";
 export declare const EDITOR_ROLE = "editor";
+export declare const COMMUNITY_CREATOR = 1;
 /**
  * Get user role from roles(set)
  * @param user
@@ -18,6 +19,12 @@ export declare function getUserRole(user: SCUserType): string | null;
  * @returns boolean
  */
 export declare function isAdmin(user: SCUserType): boolean;
+/**
+ * Check if user is admin
+ * @param user
+ * @returns boolean
+ */
+export declare function isCommunityCreator(user: SCUserType): boolean;
 /**
  * Check if user is moderator
  * @param user

package/lib/esm/utils/user.js

@@ -6,6 +6,7 @@ import { SCUserStatus } from '@selfcommunity/types';
 export const ADMIN_ROLE = 'admin';
 export const MODERATOR_ROLE = 'moderator';
 export const EDITOR_ROLE = 'editor';
+export const COMMUNITY_CREATOR = 1;
 /**
  * Get user role from roles(set)
  * @param user
@@ -34,6 +35,14 @@ export function getUserRole(user) {
 export function isAdmin(user) {
     return getUserRole(user) === ADMIN_ROLE;
 }
+/**
+ * Check if user is admin
+ * @param user
+ * @returns boolean
+ */
+export function isCommunityCreator(user) {
+    return user && user.id === COMMUNITY_CREATOR;
+}
 /**
  * Check if user is moderator
  * @param user

package/lib/esm/utils/validator.d.ts

@@ -1,4 +1,4 @@
-import { SCIntegrationsOpenAIType, SCIntegrationsType, SCNotificationsMobileNativePushMessagingType, SCNotificationsType, SCNotificationsWebPushMessagingType, SCNotificationsWebSocketType, SCSettingsType } from '../types/context';
+import { SCGeocodingType, SCIntegrationsOpenAIType, SCIntegrationsType, SCNotificationsMobileNativePushMessagingType, SCNotificationsType, SCNotificationsWebPushMessagingType, SCNotificationsWebSocketType, SCSettingsType } from '../types/context';
 import { ValidationResult } from './errors';
 import { SCLocaleType } from '../types';
 /**
@@ -320,6 +320,9 @@ export declare function validateIntegrations(v: SCIntegrationsType): {
         openai: {
             secretKey: any;
         };
+        geocoding: {
+            apiKey: any;
+        };
     };
 };
 /**
@@ -337,6 +340,21 @@ export declare const validateOpenAI: (v: any) => {
     value: SCIntegrationsOpenAIType;
     v?: undefined;
 };
+/**
+ * Validate Geocoding Option
+ * @param v
+ */
+export declare const validateGeocoding: (v: any) => {
+    errors: any[];
+    warnings: any[];
+    v: any;
+    value?: undefined;
+} | {
+    errors: any[];
+    warnings: any[];
+    value: SCGeocodingType;
+    v?: undefined;
+};
 /**
  * Validate OpenAI secret key option
  * @param value
@@ -347,6 +365,16 @@ export declare const validateOpenAISecretKey: (value: any) => {
     warnings: any[];
     value: any;
 };
+/**
+ * Validate Geocoding api key option
+ * @param value
+ * @return {}
+ */
+export declare const validateGeocodingApiKey: (value: any) => {
+    errors: any[];
+    warnings: any[];
+    value: any;
+};
 /**
  * Valid options
  * @type {{}}
@@ -362,6 +390,7 @@ export declare const preferencesOptions: Record<string, any>;
 export declare const voteOptions: Record<string, any>;
 export declare const integrationsOptions: Record<string, any>;
 export declare const integrationsOpenAIOptions: Record<string, any>;
+export declare const integrationsGeocodingOptions: Record<string, any>;
 export declare const validOptions: {
     [x: string]: any;
 };

package/lib/esm/utils/validator.js

@@ -639,6 +639,30 @@ export const validateOpenAI = (v) => {
     }, {});
     return { errors, warnings, value };
 };
+/**
+ * Validate Geocoding Option
+ * @param v
+ */
+export const validateGeocoding = (v) => {
+    //console.log(v);
+    const errors = [];
+    const warnings = [];
+    if (v && !isObject(v)) {
+        errors.push(ValidationError.ERROR_INVALID_INTEGRATIONS_GEOCODING);
+        return { errors, warnings, v };
+    }
+    const _options = Object.keys(integrationsGeocodingOptions);
+    const value = Object.keys(v)
+        .filter((key) => _options.includes(key))
+        .reduce((obj, key) => {
+        const res = integrationsGeocodingOptions[key].validator(v[key], v);
+        res.errors.map((error) => errors.push(error));
+        res.warnings.map((warning) => warnings.push(warning));
+        obj[key] = res.value;
+        return obj;
+    }, {});
+    return { errors, warnings, value };
+};
 /**
  * Validate OpenAI secret key option
  * @param value
@@ -652,6 +676,19 @@ export const validateOpenAISecretKey = (value) => {
     }
     return { errors, warnings, value };
 };
+/**
+ * Validate Geocoding api key option
+ * @param value
+ * @return {}
+ */
+export const validateGeocodingApiKey = (value) => {
+    const errors = [];
+    const warnings = [];
+    if (!value || !isString(value)) {
+        errors.push(ValidationError.ERROR_INVALID_INTEGRATIONS_GEOCODING_APIKEY);
+    }
+    return { errors, warnings, value };
+};
 /**
  * Components Widget
  */
@@ -786,6 +823,14 @@ const IntegrationOpenAISecretKeyOption = {
     name: Integrations.INTEGRATIONS_OPENAI_SECRETKEY_OPTION,
     validator: validateOpenAISecretKey,
 };
+const IntegrationGeocodingOption = {
+    name: Integrations.INTEGRATIONS_GEOCODING_OPTION,
+    validator: validateGeocoding,
+};
+const IntegrationGeocodingApiKeyOption = {
+    name: Integrations.INTEGRATIONS_GEOCODING_APIKEY_OPTION,
+    validator: validateGeocodingApiKey,
+};
 /**
  * Valid options
  * @type {{}}
@@ -840,10 +885,14 @@ export const voteOptions = {
 };
 export const integrationsOptions = {
     [IntegrationOpenAIOption.name]: IntegrationOpenAIOption,
+    [IntegrationGeocodingOption.name]: IntegrationGeocodingOption,
 };
 export const integrationsOpenAIOptions = {
     [IntegrationOpenAISecretKeyOption.name]: IntegrationOpenAISecretKeyOption,
 };
+export const integrationsGeocodingOptions = {
+    [IntegrationGeocodingApiKeyOption.name]: IntegrationGeocodingApiKeyOption,
+};
 export const validOptions = Object.assign({}, settingsOptions);
 /**
  * Validate all options by type