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

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

@@ -1,9 +1,9 @@
-import { SCNotificationsMobileNativePushMessagingType, SCNotificationsType, SCNotificationsWebPushMessagingType, SCNotificationsWebSocketType, SCSettingsType } from '../types/context';
+import { SCIntegrationsOpenAIType, SCIntegrationsType, SCNotificationsMobileNativePushMessagingType, SCNotificationsType, SCNotificationsWebPushMessagingType, SCNotificationsWebSocketType, SCSettingsType } from '../types/context';
 import { ValidationResult } from './errors';
 import { SCLocaleType } from '../types';
 /**
  * Validate session option
- * @param session
+ * @param v
  * @return {}
  */
 export declare function validateSession(v: Record<string, any>): {
@@ -14,6 +14,7 @@ export declare function validateSession(v: Record<string, any>): {
 /**
  * Validate session type
  * @param value
+ * @param session
  * @return {}
  */
 export declare const validateSessionType: (value: any, session: any) => {
@@ -24,6 +25,7 @@ export declare const validateSessionType: (value: any, session: any) => {
 /**
  * Validate session client id
  * @param value
+ * @param session
  * @return {}
  */
 export declare const validateSessionClientId: (value: any, session: any) => {
@@ -34,6 +36,7 @@ export declare const validateSessionClientId: (value: any, session: any) => {
 /**
  * Validate session auth token
  * @param value
+ * @param session
  * @return {}
  */
 export declare const validateSessionAuthTokenOption: (value: any, session: any) => {
@@ -55,6 +58,7 @@ export declare const validateHandleRefreshToken: (value: any, session: any) => {
 /**
  * Validate handleLogout option
  * @param value
+ * @param session
  * @return {}
  */
 export declare const validateHandleLogout: (value: any, session: any) => {
@@ -64,7 +68,7 @@ export declare const validateHandleLogout: (value: any, session: any) => {
 };
 /**
  * Validate notifications option
- * @param notifications
+ * @param v
  * @return {}
  */
 export declare function validateNotifications(v: SCNotificationsType): {
@@ -74,8 +78,7 @@ export declare function validateNotifications(v: SCNotificationsType): {
 };
 /**
  * Validate webSocket
- * @param value
- * @param {}
+ * @param v
  */
 export declare const validateWebSocket: (v: any) => {
     errors: any[];
@@ -91,9 +94,8 @@ export declare const validateWebSocket: (v: any) => {
 /**
  * Validate default disableToastMessage (webSocket)
  * @param value
- * @param {}
  */
-export declare const validateWebSocketDisableToastMessage: (value: any, notifications: any) => {
+export declare const validateWebSocketDisableToastMessage: (value: any) => {
     errors: any[];
     warnings: any[];
     value: any;
@@ -101,17 +103,15 @@ export declare const validateWebSocketDisableToastMessage: (value: any, notifica
 /**
  * Validate default secure (webSocket)
  * @param value
- * @param {}
  */
-export declare const validateWebSocketSecure: (value: any, notifications: any) => {
+export declare const validateWebSocketSecure: (value: any) => {
     errors: any[];
     warnings: any[];
     value: any;
 };
 /**
  * Validate webPushMessaging
- * @param value
- * @param {}
+ * @param v
  */
 export declare const validateWebPushMessaging: (v: any) => {
     errors: any[];
@@ -127,9 +127,8 @@ export declare const validateWebPushMessaging: (v: any) => {
 /**
  * Validate default disableToastMessage (webPushMessaging)
  * @param value
- * @param {}
  */
-export declare const validateWebPushMessagingDisableToastMessage: (value: any, notifications: any) => {
+export declare const validateWebPushMessagingDisableToastMessage: (value: any) => {
     errors: any[];
     warnings: any[];
     value: any;
@@ -137,17 +136,15 @@ export declare const validateWebPushMessagingDisableToastMessage: (value: any, n
 /**
  * Validate default applicationServerKey (webPushMessaging)
  * @param value
- * @param {}
  */
-export declare const validateWebPushMessagingApplicationServerKey: (value: any, notifications: any) => {
+export declare const validateWebPushMessagingApplicationServerKey: (value: any) => {
     errors: any[];
     warnings: any[];
     value: any;
 };
 /**
  * Validate mobile native
- * @param value
- * @param {}
+ * @param v
  */
 export declare const validateMobileNativePushMessaging: (v: any) => {
     errors: any[];
@@ -163,16 +160,15 @@ export declare const validateMobileNativePushMessaging: (v: any) => {
 /**
  * Validate default disable (mobileNativePushMessaging)
  * @param value
- * @param {}
  */
-export declare const validateMobileNativePushMessagingDisable: (value: any, notifications: any) => {
+export declare const validateMobileNativePushMessagingDisable: (value: any) => {
     errors: any[];
     warnings: any[];
     value: any;
 };
 /**
  * Validate portal option
- * @param portal
+ * @param value
  * @return {}
  */
 export declare const validatePortal: (value: any) => {
@@ -183,7 +179,7 @@ export declare const validatePortal: (value: any) => {
 /**
  * Validate default locale
  * @param value
- * @param {}
+ * @param locale
  */
 export declare const validateLocaleDefault: (value: any, locale: any) => {
     errors: any[];
@@ -193,7 +189,6 @@ export declare const validateLocaleDefault: (value: any, locale: any) => {
 /**
  * Validate default locale
  * @param value
- * @param {}
  */
 export declare const validateLocaleMessages: (value: any) => {
     errors: any[];
@@ -202,7 +197,7 @@ export declare const validateLocaleMessages: (value: any) => {
 };
 /**
  * Validate locale option
- * @param locale
+ * @param v
  * @return {}
  */
 export declare const validateLocale: (v: any) => {
@@ -218,7 +213,7 @@ export declare const validateLocale: (v: any) => {
 };
 /**
  * Validate router option
- * @param router
+ * @param value
  * @return {}
  */
 export declare const validateRouter: (value: any) => {
@@ -228,7 +223,7 @@ export declare const validateRouter: (value: any) => {
 };
 /**
  * Validate theme option
- * @param theme
+ * @param value
  * @return {}
  */
 export declare const validateTheme: (value: any) => {
@@ -238,7 +233,7 @@ export declare const validateTheme: (value: any) => {
 };
 /**
  * Validate handleAnonymousAction option
- * @param handleAnonymousAction
+ * @param v
  * @return {}
  */
 export declare const validateHandleAnonymousAction: (v: any) => {
@@ -248,7 +243,7 @@ export declare const validateHandleAnonymousAction: (v: any) => {
 };
 /**
  * Validate contextProviders option
- * @param contextProviders
+ * @param value
  * @return [...contextProviders]
  */
 export declare const validateContextProviders: (value: any) => {
@@ -304,6 +299,45 @@ export declare function validateVote(v: Record<string, any>): {
     warnings: any[];
     value: Record<string, any>;
 };
+/**
+ * Validate integrations option
+ * @param v
+ * @return {}
+ */
+export declare function validateIntegrations(v: SCIntegrationsType): {
+    errors: any[];
+    warnings: any[];
+    value: {
+        openai: {
+            secretKey: any;
+        };
+    };
+};
+/**
+ * Validate OpenAI Option
+ * @param v
+ */
+export declare const validateOpenAI: (v: any) => {
+    errors: any[];
+    warnings: any[];
+    v: any;
+    value?: undefined;
+} | {
+    errors: any[];
+    warnings: any[];
+    value: SCIntegrationsOpenAIType;
+    v?: undefined;
+};
+/**
+ * Validate OpenAI secret key option
+ * @param value
+ * @return {}
+ */
+export declare const validateOpenAISecretKey: (value: any) => {
+    errors: any[];
+    warnings: any[];
+    value: any;
+};
 /**
  * Valid options
  * @type {{}}
@@ -317,12 +351,15 @@ export declare const notificationsWebPushMessagingOptions: Record<string, any>;
 export declare const notificationsMobileNativePushMessagingOptions: Record<string, any>;
 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 validOptions: {
     [x: string]: any;
 };
 /**
  * Validate all options by type
- * @param options
+ * @param values
+ * @param schemaOptions
  * @return {options hydrated}
  */
 export declare const validateOptions: (values: SCSettingsType, schemaOptions: Record<string, any>) => {

package/lib/esm/utils/validator.js

@@ -11,9 +11,10 @@ import * as Actions from '../constants/Actions';
 import * as Preferences from '../constants/Preferences';
 import * as Features from '../constants/Features';
 import * as Vote from '../constants/Vote';
+import * as Integrations from '../constants/Integrations';
 /**
  * Validate session option
- * @param session
+ * @param v
  * @return {}
  */
 export function validateSession(v) {
@@ -38,6 +39,7 @@ export function validateSession(v) {
 /**
  * Validate session type
  * @param value
+ * @param session
  * @return {}
  */
 export const validateSessionType = (value, session) => {
@@ -51,6 +53,7 @@ export const validateSessionType = (value, session) => {
 /**
  * Validate session client id
  * @param value
+ * @param session
  * @return {}
  */
 export const validateSessionClientId = (value, session) => {
@@ -68,6 +71,7 @@ export const validateSessionClientId = (value, session) => {
 /**
  * Validate session auth token
  * @param value
+ * @param session
  * @return {}
  */
 export const validateSessionAuthTokenOption = (value, session) => {
@@ -104,6 +108,7 @@ export const validateHandleRefreshToken = (value, session) => {
 /**
  * Validate handleLogout option
  * @param value
+ * @param session
  * @return {}
  */
 export const validateHandleLogout = (value, session) => {
@@ -116,7 +121,7 @@ export const validateHandleLogout = (value, session) => {
 };
 /**
  * Validate notifications option
- * @param notifications
+ * @param v
  * @return {}
  */
 export function validateNotifications(v) {
@@ -135,12 +140,11 @@ export 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) };
 }
 /**
  * Validate webSocket
- * @param value
- * @param {}
+ * @param v
  */
 export const validateWebSocket = (v) => {
     const errors = [];
@@ -164,9 +168,8 @@ export const validateWebSocket = (v) => {
 /**
  * Validate default disableToastMessage (webSocket)
  * @param value
- * @param {}
  */
-export const validateWebSocketDisableToastMessage = (value, notifications) => {
+export const validateWebSocketDisableToastMessage = (value) => {
     const errors = [];
     const warnings = [];
     if (value) {
@@ -186,9 +189,8 @@ export const validateWebSocketDisableToastMessage = (value, notifications) => {
 /**
  * Validate default secure (webSocket)
  * @param value
- * @param {}
  */
-export const validateWebSocketSecure = (value, notifications) => {
+export const validateWebSocketSecure = (value) => {
     const errors = [];
     const warnings = [];
     if (value) {
@@ -207,8 +209,7 @@ export const validateWebSocketSecure = (value, notifications) => {
 };
 /**
  * Validate webPushMessaging
- * @param value
- * @param {}
+ * @param v
  */
 export const validateWebPushMessaging = (v) => {
     const errors = [];
@@ -232,9 +233,8 @@ export const validateWebPushMessaging = (v) => {
 /**
  * Validate default disableToastMessage (webPushMessaging)
  * @param value
- * @param {}
  */
-export const validateWebPushMessagingDisableToastMessage = (value, notifications) => {
+export const validateWebPushMessagingDisableToastMessage = (value) => {
     const errors = [];
     const warnings = [];
     if (value !== undefined) {
@@ -254,9 +254,8 @@ export const validateWebPushMessagingDisableToastMessage = (value, notifications
 /**
  * Validate default applicationServerKey (webPushMessaging)
  * @param value
- * @param {}
  */
-export const validateWebPushMessagingApplicationServerKey = (value, notifications) => {
+export const validateWebPushMessagingApplicationServerKey = (value) => {
     const errors = [];
     const warnings = [];
     if (value) {
@@ -268,8 +267,7 @@ export const validateWebPushMessagingApplicationServerKey = (value, notification
 };
 /**
  * Validate mobile native
- * @param value
- * @param {}
+ * @param v
  */
 export const validateMobileNativePushMessaging = (v) => {
     const errors = [];
@@ -293,9 +291,8 @@ export const validateMobileNativePushMessaging = (v) => {
 /**
  * Validate default disable (mobileNativePushMessaging)
  * @param value
- * @param {}
  */
-export const validateMobileNativePushMessagingDisable = (value, notifications) => {
+export const validateMobileNativePushMessagingDisable = (value) => {
     const errors = [];
     const warnings = [];
     if (value !== undefined) {
@@ -314,7 +311,7 @@ export const validateMobileNativePushMessagingDisable = (value, notifications) =
 };
 /**
  * Validate portal option
- * @param portal
+ * @param value
  * @return {}
  */
 export const validatePortal = (value) => {
@@ -328,7 +325,7 @@ export const validatePortal = (value) => {
 /**
  * Validate default locale
  * @param value
- * @param {}
+ * @param locale
  */
 export const validateLocaleDefault = (value, locale) => {
     const errors = [];
@@ -346,7 +343,6 @@ export const validateLocaleDefault = (value, locale) => {
 /**
  * Validate default locale
  * @param value
- * @param {}
  */
 export const validateLocaleMessages = (value) => {
     const errors = [];
@@ -358,7 +354,7 @@ export const validateLocaleMessages = (value) => {
 };
 /**
  * Validate locale option
- * @param locale
+ * @param v
  * @return {}
  */
 export const validateLocale = (v) => {
@@ -382,7 +378,7 @@ export const validateLocale = (v) => {
 };
 /**
  * Validate router option
- * @param router
+ * @param value
  * @return {}
  */
 export const validateRouter = (value) => {
@@ -405,7 +401,7 @@ export const validateRouter = (value) => {
 };
 /**
  * Validate theme option
- * @param theme
+ * @param value
  * @return {}
  */
 export const validateTheme = (value) => {
@@ -418,7 +414,7 @@ export const validateTheme = (value) => {
 };
 /**
  * Validate handleAnonymousAction option
- * @param handleAnonymousAction
+ * @param v
  * @return {}
  */
 export const validateHandleAnonymousAction = (v) => {
@@ -443,7 +439,7 @@ export const validateHandleAnonymousAction = (v) => {
 };
 /**
  * Validate contextProviders option
- * @param contextProviders
+ * @param value
  * @return [...contextProviders]
  */
 export const validateContextProviders = (value) => {
@@ -585,6 +581,66 @@ export function validateVote(v) {
     }
     return { errors, warnings, value: defaultValue };
 }
+/**
+ * Validate integrations option
+ * @param v
+ * @return {}
+ */
+export function validateIntegrations(v) {
+    const errors = [];
+    const warnings = [];
+    if (!v || !isObject(v)) {
+        return { errors, warnings, value: Integrations.DEFAULT_INTEGRATIONS_OPTION };
+    }
+    const _options = Object.keys(integrationsOptions);
+    const value = Object.keys(v)
+        .filter((key) => _options.includes(key))
+        .reduce((obj, key) => {
+        const res = 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) };
+}
+/**
+ * Validate OpenAI Option
+ * @param v
+ */
+export const validateOpenAI = (v) => {
+    console.log(v);
+    const errors = [];
+    const warnings = [];
+    if (v && !isObject(v)) {
+        errors.push(ValidationError.ERROR_INVALID_INTEGRATIONS_OPENAI);
+        return { errors, warnings, v };
+    }
+    const _options = Object.keys(integrationsOpenAIOptions);
+    const value = Object.keys(v)
+        .filter((key) => _options.includes(key))
+        .reduce((obj, key) => {
+        const res = 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 };
+};
+/**
+ * Validate OpenAI secret key option
+ * @param value
+ * @return {}
+ */
+export const validateOpenAISecretKey = (value) => {
+    const errors = [];
+    const warnings = [];
+    if (!value || !isString(value)) {
+        errors.push(ValidationError.ERROR_INVALID_INTEGRATIONS_OPENAI_SECRETKEY);
+    }
+    return { errors, warnings, value };
+};
 /**
  * Components Widget
  */
@@ -628,6 +684,10 @@ const VoteOption = {
     name: Vote.VOTE_OPTION,
     validator: validateVote,
 };
+const IntegrationsOption = {
+    name: Integrations.INTEGRATIONS_OPTION,
+    validator: validateIntegrations,
+};
 /**
  * Session options
  */
@@ -703,6 +763,14 @@ const ReactionsOption = {
     name: Vote.VOTE_REACTIONS_OPTION,
     validator: validateReactions,
 };
+const IntegrationOpenAIOption = {
+    name: Integrations.INTEGRATIONS_OPENAI_OPTION,
+    validator: validateOpenAI,
+};
+const IntegrationOpenAISecretKeyOption = {
+    name: Integrations.INTEGRATIONS_OPENAI_SECRETKEY_OPTION,
+    validator: validateOpenAISecretKey,
+};
 /**
  * Valid options
  * @type {{}}
@@ -718,6 +786,7 @@ export const settingsOptions = {
     [ContextProvidersOption.name]: ContextProvidersOption,
     [PreferencesOption.name]: PreferencesOption,
     [VoteOption.name]: VoteOption,
+    [IntegrationsOption.name]: IntegrationsOption,
 };
 export const sessionOptions = {
     [SessionTypeOption.name]: SessionTypeOption,
@@ -753,10 +822,17 @@ export const preferencesOptions = {
 export const voteOptions = {
     [ReactionsOption.name]: ReactionsOption,
 };
+export const integrationsOptions = {
+    [IntegrationOpenAIOption.name]: IntegrationOpenAIOption,
+};
+export const integrationsOpenAIOptions = {
+    [IntegrationOpenAISecretKeyOption.name]: IntegrationOpenAISecretKeyOption,
+};
 export const validOptions = Object.assign({}, settingsOptions);
 /**
  * Validate all options by type
- * @param options
+ * @param values
+ * @param schemaOptions
  * @return {options hydrated}
  */
 export const validateOptions = (values, schemaOptions) => {