@selfcommunity/react-core 0.4.50 → 0.4.51-alpha.0

package/lib/cjs/utils/validator.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateOptions = exports.validOptions = exports.voteOptions = exports.preferencesOptions = exports.notificationsMobileNativePushMessagingOptions = exports.notificationsWebPushMessagingOptions = exports.notificationsWebSocketOptions = exports.notificationsOptions = exports.localeOptions = exports.sessionOptions = exports.settingsOptions = exports.validateVote = exports.validateReactions = exports.validatePreferences = exports.validateFeatures = exports.validateGlobalPreferences = exports.validateContextProviders = exports.validateHandleAnonymousAction = exports.validateTheme = exports.validateRouter = exports.validateLocale = exports.validateLocaleMessages = exports.validateLocaleDefault = exports.validatePortal = exports.validateMobileNativePushMessagingDisable = exports.validateMobileNativePushMessaging = exports.validateWebPushMessagingApplicationServerKey = exports.validateWebPushMessagingDisableToastMessage = exports.validateWebPushMessaging = exports.validateWebSocketSecure = exports.validateWebSocketDisableToastMessage = exports.validateWebSocket = exports.validateNotifications = exports.validateHandleLogout = exports.validateHandleRefreshToken = exports.validateSessionAuthTokenOption = exports.validateSessionClientId = exports.validateSessionType = exports.validateSession = void 0;
+exports.validateOptions = exports.validOptions = exports.integrationsOpenAIOptions = exports.integrationsOptions = exports.voteOptions = exports.preferencesOptions = exports.notificationsMobileNativePushMessagingOptions = exports.notificationsWebPushMessagingOptions = exports.notificationsWebSocketOptions = exports.notificationsOptions = exports.localeOptions = exports.sessionOptions = exports.settingsOptions = exports.validateOpenAISecretKey = exports.validateOpenAI = exports.validateIntegrations = exports.validateVote = exports.validateReactions = exports.validatePreferences = exports.validateFeatures = exports.validateGlobalPreferences = exports.validateContextProviders = exports.validateHandleAnonymousAction = exports.validateTheme = exports.validateRouter = exports.validateLocale = exports.validateLocaleMessages = exports.validateLocaleDefault = exports.validatePortal = exports.validateMobileNativePushMessagingDisable = exports.validateMobileNativePushMessaging = exports.validateWebPushMessagingApplicationServerKey = exports.validateWebPushMessagingDisableToastMessage = exports.validateWebPushMessaging = exports.validateWebSocketSecure = exports.validateWebSocketDisableToastMessage = exports.validateWebSocket = exports.validateNotifications = exports.validateHandleLogout = exports.validateHandleRefreshToken = exports.validateSessionAuthTokenOption = exports.validateSessionClientId = exports.validateSessionType = exports.validateSession = void 0;
 const tslib_1 = require("tslib");
 const Locale = tslib_1.__importStar(require("../constants/Locale"));
 const utils_1 = require("@selfcommunity/utils");
@@ -15,9 +15,10 @@ const Actions = tslib_1.__importStar(require("../constants/Actions"));
 const Preferences = tslib_1.__importStar(require("../constants/Preferences"));
 const Features = tslib_1.__importStar(require("../constants/Features"));
 const Vote = tslib_1.__importStar(require("../constants/Vote"));
+const Integrations = tslib_1.__importStar(require("../constants/Integrations"));
 /**
  * Validate session option
- * @param session
+ * @param v
  * @return {}
  */
 function validateSession(v) {
@@ -43,6 +44,7 @@ exports.validateSession = validateSession;
 /**
  * Validate session type
  * @param value
+ * @param session
  * @return {}
  */
 const validateSessionType = (value, session) => {
@@ -57,6 +59,7 @@ exports.validateSessionType = validateSessionType;
 /**
  * Validate session client id
  * @param value
+ * @param session
  * @return {}
  */
 const validateSessionClientId = (value, session) => {
@@ -75,6 +78,7 @@ exports.validateSessionClientId = validateSessionClientId;
 /**
  * Validate session auth token
  * @param value
+ * @param session
  * @return {}
  */
 const validateSessionAuthTokenOption = (value, session) => {
@@ -113,6 +117,7 @@ exports.validateHandleRefreshToken = validateHandleRefreshToken;
 /**
  * Validate handleLogout option
  * @param value
+ * @param session
  * @return {}
  */
 const validateHandleLogout = (value, session) => {
@@ -126,7 +131,7 @@ const validateHandleLogout = (value, session) => {
 exports.validateHandleLogout = validateHandleLogout;
 /**
  * Validate notifications option
- * @param notifications
+ * @param v
  * @return {}
  */
 function validateNotifications(v) {
@@ -145,13 +150,12 @@ function validateNotifications(v) {
         obj[key] = res.value;
         return obj;
     }, {});
-    return { errors, warnings, value: Object.assign(Object.assign({}, Notifications.DEFAULT_NOTIFICATIONS), v) };
+    return { errors, warnings, value: Object.assign(Object.assign({}, Notifications.DEFAULT_NOTIFICATIONS), value) };
 }
 exports.validateNotifications = validateNotifications;
 /**
  * Validate webSocket
- * @param value
- * @param {}
+ * @param v
  */
 const validateWebSocket = (v) => {
     const errors = [];
@@ -176,9 +180,8 @@ exports.validateWebSocket = validateWebSocket;
 /**
  * Validate default disableToastMessage (webSocket)
  * @param value
- * @param {}
  */
-const validateWebSocketDisableToastMessage = (value, notifications) => {
+const validateWebSocketDisableToastMessage = (value) => {
     const errors = [];
     const warnings = [];
     if (value) {
@@ -199,9 +202,8 @@ exports.validateWebSocketDisableToastMessage = validateWebSocketDisableToastMess
 /**
  * Validate default secure (webSocket)
  * @param value
- * @param {}
  */
-const validateWebSocketSecure = (value, notifications) => {
+const validateWebSocketSecure = (value) => {
     const errors = [];
     const warnings = [];
     if (value) {
@@ -221,8 +223,7 @@ const validateWebSocketSecure = (value, notifications) => {
 exports.validateWebSocketSecure = validateWebSocketSecure;
 /**
  * Validate webPushMessaging
- * @param value
- * @param {}
+ * @param v
  */
 const validateWebPushMessaging = (v) => {
     const errors = [];
@@ -247,9 +248,8 @@ exports.validateWebPushMessaging = validateWebPushMessaging;
 /**
  * Validate default disableToastMessage (webPushMessaging)
  * @param value
- * @param {}
  */
-const validateWebPushMessagingDisableToastMessage = (value, notifications) => {
+const validateWebPushMessagingDisableToastMessage = (value) => {
     const errors = [];
     const warnings = [];
     if (value !== undefined) {
@@ -270,9 +270,8 @@ exports.validateWebPushMessagingDisableToastMessage = validateWebPushMessagingDi
 /**
  * Validate default applicationServerKey (webPushMessaging)
  * @param value
- * @param {}
  */
-const validateWebPushMessagingApplicationServerKey = (value, notifications) => {
+const validateWebPushMessagingApplicationServerKey = (value) => {
     const errors = [];
     const warnings = [];
     if (value) {
@@ -285,8 +284,7 @@ const validateWebPushMessagingApplicationServerKey = (value, notifications) => {
 exports.validateWebPushMessagingApplicationServerKey = validateWebPushMessagingApplicationServerKey;
 /**
  * Validate mobile native
- * @param value
- * @param {}
+ * @param v
  */
 const validateMobileNativePushMessaging = (v) => {
     const errors = [];
@@ -311,9 +309,8 @@ exports.validateMobileNativePushMessaging = validateMobileNativePushMessaging;
 /**
  * Validate default disable (mobileNativePushMessaging)
  * @param value
- * @param {}
  */
-const validateMobileNativePushMessagingDisable = (value, notifications) => {
+const validateMobileNativePushMessagingDisable = (value) => {
     const errors = [];
     const warnings = [];
     if (value !== undefined) {
@@ -333,7 +330,7 @@ const validateMobileNativePushMessagingDisable = (value, notifications) => {
 exports.validateMobileNativePushMessagingDisable = validateMobileNativePushMessagingDisable;
 /**
  * Validate portal option
- * @param portal
+ * @param value
  * @return {}
  */
 const validatePortal = (value) => {
@@ -348,7 +345,7 @@ exports.validatePortal = validatePortal;
 /**
  * Validate default locale
  * @param value
- * @param {}
+ * @param locale
  */
 const validateLocaleDefault = (value, locale) => {
     const errors = [];
@@ -367,7 +364,6 @@ exports.validateLocaleDefault = validateLocaleDefault;
 /**
  * Validate default locale
  * @param value
- * @param {}
  */
 const validateLocaleMessages = (value) => {
     const errors = [];
@@ -380,7 +376,7 @@ const validateLocaleMessages = (value) => {
 exports.validateLocaleMessages = validateLocaleMessages;
 /**
  * Validate locale option
- * @param locale
+ * @param v
  * @return {}
  */
 const validateLocale = (v) => {
@@ -405,7 +401,7 @@ const validateLocale = (v) => {
 exports.validateLocale = validateLocale;
 /**
  * Validate router option
- * @param router
+ * @param value
  * @return {}
  */
 const validateRouter = (value) => {
@@ -429,7 +425,7 @@ const validateRouter = (value) => {
 exports.validateRouter = validateRouter;
 /**
  * Validate theme option
- * @param theme
+ * @param value
  * @return {}
  */
 const validateTheme = (value) => {
@@ -443,7 +439,7 @@ const validateTheme = (value) => {
 exports.validateTheme = validateTheme;
 /**
  * Validate handleAnonymousAction option
- * @param handleAnonymousAction
+ * @param v
  * @return {}
  */
 const validateHandleAnonymousAction = (v) => {
@@ -469,7 +465,7 @@ const validateHandleAnonymousAction = (v) => {
 exports.validateHandleAnonymousAction = validateHandleAnonymousAction;
 /**
  * Validate contextProviders option
- * @param contextProviders
+ * @param value
  * @return [...contextProviders]
  */
 const validateContextProviders = (value) => {
@@ -617,6 +613,69 @@ function validateVote(v) {
     return { errors, warnings, value: defaultValue };
 }
 exports.validateVote = validateVote;
+/**
+ * Validate integrations option
+ * @param v
+ * @return {}
+ */
+function validateIntegrations(v) {
+    const errors = [];
+    const warnings = [];
+    if (!v || !(0, utils_1.isObject)(v)) {
+        return { errors, warnings, value: Integrations.DEFAULT_INTEGRATIONS_OPTION };
+    }
+    const _options = Object.keys(exports.integrationsOptions);
+    const value = Object.keys(v)
+        .filter((key) => _options.includes(key))
+        .reduce((obj, key) => {
+        const res = exports.integrationsOptions[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: Object.assign(Object.assign({}, Integrations.DEFAULT_INTEGRATIONS_OPTION), value) };
+}
+exports.validateIntegrations = validateIntegrations;
+/**
+ * Validate OpenAI Option
+ * @param v
+ */
+const validateOpenAI = (v) => {
+    console.log(v);
+    const errors = [];
+    const warnings = [];
+    if (v && !(0, utils_1.isObject)(v)) {
+        errors.push(errors_1.ValidationError.ERROR_INVALID_INTEGRATIONS_OPENAI);
+        return { errors, warnings, v };
+    }
+    const _options = Object.keys(exports.integrationsOpenAIOptions);
+    const value = Object.keys(v)
+        .filter((key) => _options.includes(key))
+        .reduce((obj, key) => {
+        const res = exports.integrationsOpenAIOptions[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 };
+};
+exports.validateOpenAI = validateOpenAI;
+/**
+ * Validate OpenAI secret key option
+ * @param value
+ * @return {}
+ */
+const validateOpenAISecretKey = (value) => {
+    const errors = [];
+    const warnings = [];
+    if (!value || !(0, utils_1.isString)(value)) {
+        errors.push(errors_1.ValidationError.ERROR_INVALID_INTEGRATIONS_OPENAI_SECRETKEY);
+    }
+    return { errors, warnings, value };
+};
+exports.validateOpenAISecretKey = validateOpenAISecretKey;
 /**
  * Components Widget
  */
@@ -660,6 +719,10 @@ const VoteOption = {
     name: Vote.VOTE_OPTION,
     validator: validateVote,
 };
+const IntegrationsOption = {
+    name: Integrations.INTEGRATIONS_OPTION,
+    validator: validateIntegrations,
+};
 /**
  * Session options
  */
@@ -735,6 +798,14 @@ const ReactionsOption = {
     name: Vote.VOTE_REACTIONS_OPTION,
     validator: exports.validateReactions,
 };
+const IntegrationOpenAIOption = {
+    name: Integrations.INTEGRATIONS_OPENAI_OPTION,
+    validator: exports.validateOpenAI,
+};
+const IntegrationOpenAISecretKeyOption = {
+    name: Integrations.INTEGRATIONS_OPENAI_SECRETKEY_OPTION,
+    validator: exports.validateOpenAISecretKey,
+};
 /**
  * Valid options
  * @type {{}}
@@ -750,6 +821,7 @@ exports.settingsOptions = {
     [ContextProvidersOption.name]: ContextProvidersOption,
     [PreferencesOption.name]: PreferencesOption,
     [VoteOption.name]: VoteOption,
+    [IntegrationsOption.name]: IntegrationsOption,
 };
 exports.sessionOptions = {
     [SessionTypeOption.name]: SessionTypeOption,
@@ -785,10 +857,17 @@ exports.preferencesOptions = {
 exports.voteOptions = {
     [ReactionsOption.name]: ReactionsOption,
 };
+exports.integrationsOptions = {
+    [IntegrationOpenAIOption.name]: IntegrationOpenAIOption,
+};
+exports.integrationsOpenAIOptions = {
+    [IntegrationOpenAISecretKeyOption.name]: IntegrationOpenAISecretKeyOption,
+};
 exports.validOptions = Object.assign({}, exports.settingsOptions);
 /**
  * Validate all options by type
- * @param options
+ * @param values
+ * @param schemaOptions
  * @return {options hydrated}
  */
 const validateOptions = (values, schemaOptions) => {

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

@@ -2,7 +2,7 @@ import React, { createContext, useContext, useEffect, useMemo, useRef } from 're
 import { UserService } from '@selfcommunity/api-services';
 import { SCContext } from '../SCContextProvider';
 import useSCAuth, { userActionTypes } from '../../../hooks/useSCAuth';
-import { isClientSideRendering, Logger } from '@selfcommunity/utils';
+import { Logger } from '@selfcommunity/utils';
 import PubSub from 'pubsub-js';
 import { SCOPE_SC_CORE } from '../../../constants/Errors';
 import { useDeepCompareEffectNoCheck } from 'use-deep-compare-effect';
@@ -100,17 +100,17 @@ export default function SCUserProvider({ children }) {
      * and document is in foreground refresh the cache
      */
     useEffect(() => {
-        typeof window !== 'undefined' && window.document.addEventListener('visibilitychange', handleVisibilityChange);
+        window.document.addEventListener('visibilitychange', handleVisibilityChange);
         return () => {
-            typeof window !== 'undefined' && window.document.removeEventListener('visibilitychange', handleVisibilityChange);
+            window.document.removeEventListener('visibilitychange', handleVisibilityChange);
         };
-    });
+    }, []);
     /**
      * handler handleVisibilityChange for this provider
      * Refresh followed categories, users, etc..
      */
     function handleVisibilityChange() {
-        if (isClientSideRendering() && !window.document.hidden && state.user) {
+        if (!window.document.hidden && state.user) {
             settingsManager.refresh && settingsManager.refresh();
             refreshCounters();
             categoriesManager.refresh && categoriesManager.refresh();

package/lib/esm/constants/Integrations.d.ts

@@ -0,0 +1,8 @@
+export declare const INTEGRATIONS_OPTION = "integrations";
+export declare const INTEGRATIONS_OPENAI_OPTION = "openai";
+export declare const INTEGRATIONS_OPENAI_SECRETKEY_OPTION = "secretKey";
+export declare const DEFAULT_INTEGRATIONS_OPTION: {
+    openai: {
+        secretKey: any;
+    };
+};

package/lib/esm/constants/Integrations.js

@@ -0,0 +1,9 @@
+// integrations
+export const INTEGRATIONS_OPTION = 'integrations';
+export const INTEGRATIONS_OPENAI_OPTION = 'openai';
+export const INTEGRATIONS_OPENAI_SECRETKEY_OPTION = 'secretKey';
+export const DEFAULT_INTEGRATIONS_OPTION = {
+    [INTEGRATIONS_OPENAI_OPTION]: {
+        [INTEGRATIONS_OPENAI_SECRETKEY_OPTION]: null,
+    },
+};

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

@@ -620,3 +620,22 @@ export interface SCAlertMessagesContextType {
      */
     setOptions: (options: any) => void;
 }
+/**
+ * Interface SCIntegrationsType
+ */
+export interface SCIntegrationsType {
+    /**
+     * OpenAI
+     */
+    openai?: SCIntegrationsOpenAIType;
+}
+/**
+ * Interface SCNotificationsWebSocketType
+ */
+export interface SCIntegrationsOpenAIType {
+    /**
+     * Set secretKey OpenAI
+     * Default: null
+     */
+    secretKey: string | null;
+}

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

@@ -32,6 +32,9 @@ export declare class ValidationError {
     static ERROR_INVALID_VOTE: number;
     static ERROR_INVALID_VOTE_REACTIONS: number;
     static ERROR_INVALID_VOTE_REACTIONS_STRUCTURE: number;
+    static ERROR_INVALID_INTEGRATIONS: number;
+    static ERROR_INVALID_INTEGRATIONS_OPENAI: number;
+    static ERROR_INVALID_INTEGRATIONS_OPENAI_SECRETKEY: number;
     static defaultErrorMessageMap: {
         [x: number]: string;
     };

package/lib/esm/utils/errors.js

@@ -44,6 +44,9 @@ ValidationError.ERROR_INVALID_PREFERENCES_FEATURES = 5002;
 ValidationError.ERROR_INVALID_VOTE = 6000;
 ValidationError.ERROR_INVALID_VOTE_REACTIONS = 6001;
 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.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.',
@@ -74,6 +77,9 @@ ValidationError.defaultErrorMessageMap = {
     [ValidationError.ERROR_INVALID_VOTE]: 'Invalid vote option.',
     [ValidationError.ERROR_INVALID_VOTE_REACTIONS]: "Invalid vote option. 'reactions' must be a valid array of reaction objects.",
     [ValidationError.ERROR_INVALID_VOTE_REACTIONS_STRUCTURE]: "Invalid vote option. 'reactions' must be a valid array of reaction with attributes (id, label, sentiment, image, active).",
+    [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.',
 };
 /**
  * Manage Validation Warnings

package/lib/esm/utils/hooks/useIsomorphicLayoutEffect.js

@@ -1,5 +1,6 @@
 import { useEffect, useLayoutEffect } from 'react';
+import { isClientSideRendering } from '@selfcommunity/utils';
 // Ensure that the SSR uses React.useEffect instead of React.useLayoutEffect
 // because document is undefined on the server-side.
-const useIsomorphicLayoutEffect = typeof window !== 'undefined' ? useLayoutEffect : useEffect;
+const useIsomorphicLayoutEffect = isClientSideRendering() ? useLayoutEffect : useEffect;
 export default useIsomorphicLayoutEffect;

package/lib/esm/utils/notification.js

@@ -1,10 +1,10 @@
 import { PLATFORM, PLATFORM_KEY, PLATFORMS } from '../constants/Device';
-import { LocalStorageDB } from '@selfcommunity/utils';
+import { isClientSideRendering, LocalStorageDB } from '@selfcommunity/utils';
 /**
  * Check if mobile native push notification is enabled
  */
 export function isMobileNativeNotificationEnabled() {
-    return ((typeof window !== 'undefined' && window[PLATFORM_KEY] && window[PLATFORM_KEY] in PLATFORM) ||
+    return ((isClientSideRendering() && window[PLATFORM_KEY] && window[PLATFORM_KEY] in PLATFORM) ||
         (LocalStorageDB.checkifSupport() && LocalStorageDB.get(PLATFORM_KEY) && PLATFORMS.includes(LocalStorageDB.get(PLATFORM_KEY))));
 }
 /**