@selfcommunity/react-core/lib/cjs/utils/validator.d.ts

React Core Components useful for integrating UI Community components (react-ui).

import { SCGeocodingType, SCIntegrationsOpenAIType, SCIntegrationsType, SCNotificationsMobileNativePushMessagingType, SCNotificationsType, SCNotificationsWebPushMessagingType, SCNotificationsWebSocketType, SCSettingsType } from '../types/context';
import { ValidationResult } from './errors';
import { SCLocaleType } from '../types';
/**
 * Validate session option
 * @param v
 * @return {}
 */
export declare function validateSession(v: Record<string, any>): {
    errors: any[];
    warnings: any[];
    value: Record<string, any>;
};
/**
 * Validate session type
 * @param value
 * @param session
 * @return {}
 */
export declare const validateSessionType: (value: any, session: any) => {
    errors: any[];
    warnings: any[];
    value: any;
};
/**
 * Validate session client id
 * @param value
 * @param session
 * @return {}
 */
export declare const validateSessionClientId: (value: any, session: any) => {
    errors: any[];
    warnings: any[];
    value: any;
};
/**
 * Validate session auth token
 * @param value
 * @param session
 * @return {}
 */
export declare const validateSessionAuthTokenOption: (value: any, session: any) => {
    errors: any[];
    warnings: any[];
    value: any;
};
/**
 * Validate handleRefreshToken option
 * @param value
 * @param session
 * @return {}
 */
export declare const validateHandleRefreshToken: (value: any, session: any) => {
    errors: any[];
    warnings: any[];
    value: any;
};
/**
 * Validate handleLogout option
 * @param value
 * @param session
 * @return {}
 */
export declare const validateHandleLogout: (value: any, session: any) => {
    errors: any[];
    warnings: any[];
    value: any;
};
/**
 * Validate notifications option
 * @param v
 * @return {}
 */
export declare function validateNotifications(v: SCNotificationsType): {
    errors: any[];
    warnings: any[];
    value: SCNotificationsType;
};
/**
 * Validate webSocket
 * @param v
 */
export declare const validateWebSocket: (v: any) => {
    errors: any[];
    warnings: any[];
    v: any;
    value?: undefined;
} | {
    errors: any[];
    warnings: any[];
    value: SCNotificationsWebSocketType;
    v?: undefined;
};
/**
 * Validate default disableToastMessage (webSocket)
 * @param value
 */
export declare const validateWebSocketDisableToastMessage: (value: any) => {
    errors: any[];
    warnings: any[];
    value: any;
};
/**
 * Validate default secure (webSocket)
 * @param value
 */
export declare const validateWebSocketSecure: (value: any) => {
    errors: any[];
    warnings: any[];
    value: any;
};
/**
 * Validate prefixPath (webSocket)
 * @param value
 */
export declare const validateWebSocketPrefixPath: (value: any) => {
    errors: any[];
    warnings: any[];
    value: any;
};
/**
 * Validate webPushMessaging
 * @param v
 */
export declare const validateWebPushMessaging: (v: any) => {
    errors: any[];
    warnings: any[];
    v: any;
    value?: undefined;
} | {
    errors: any[];
    warnings: any[];
    value: SCNotificationsWebPushMessagingType;
    v?: undefined;
};
/**
 * Validate default disableToastMessage (webPushMessaging)
 * @param value
 */
export declare const validateWebPushMessagingDisableToastMessage: (value: any) => {
    errors: any[];
    warnings: any[];
    value: any;
};
/**
 * Validate default applicationServerKey (webPushMessaging)
 * @param value
 */
export declare const validateWebPushMessagingApplicationServerKey: (value: any) => {
    errors: any[];
    warnings: any[];
    value: any;
};
/**
 * Validate mobile native
 * @param v
 */
export declare const validateMobileNativePushMessaging: (v: any) => {
    errors: any[];
    warnings: any[];
    v: any;
    value?: undefined;
} | {
    errors: any[];
    warnings: any[];
    value: SCNotificationsMobileNativePushMessagingType;
    v?: undefined;
};
/**
 * Validate default disable (mobileNativePushMessaging)
 * @param value
 */
export declare const validateMobileNativePushMessagingDisable: (value: any) => {
    errors: any[];
    warnings: any[];
    value: any;
};
/**
 * Validate portal option
 * @param value
 * @return {}
 */
export declare const validatePortal: (value: any) => {
    errors: any[];
    warnings: any[];
    value: any;
};
/**
 * Validate default locale
 * @param value
 * @param locale
 */
export declare const validateLocaleDefault: (value: any, locale: any) => {
    errors: any[];
    warnings: any[];
    value: any;
};
/**
 * Validate default locale
 * @param value
 */
export declare const validateLocaleMessages: (value: any) => {
    errors: any[];
    warnings: any[];
    value: any;
};
/**
 * Validate locale option
 * @param v
 * @return {}
 */
export declare const validateLocale: (v: any) => {
    errors: any[];
    warnings: any[];
    v: any;
    value?: undefined;
} | {
    errors: any[];
    warnings: any[];
    value: SCLocaleType;
    v?: undefined;
};
/**
 * Validate router option
 * @param value
 * @return {}
 */
export declare const validateRouter: (value: any) => {
    errors: any[];
    warnings: any[];
    value: any;
};
/**
 * Validate theme option
 * @param value
 * @return {}
 */
export declare const validateTheme: (value: any) => {
    errors: any[];
    warnings: any[];
    value: any;
};
/**
 * Validate handleAnonymousAction option
 * @param v
 * @return {}
 */
export declare const validateHandleAnonymousAction: (v: any) => {
    errors: any[];
    warnings: any[];
    value: any;
};
/**
 * Validate contextProviders option
 * @param value
 * @return [...contextProviders]
 */
export declare const validateContextProviders: (value: any) => {
    errors: any[];
    warnings: any[];
    value: any;
};
/**
 * Validate global preferences
 * @param value
 * @param preferences
 */
export declare const validateGlobalPreferences: (value: any, preferences: any) => {
    errors: any[];
    warnings: any[];
    value: any;
};
/**
 * Validate features
 * @param value
 * @param preferences
 */
export declare const validateFeatures: (value: any, preferences: any) => {
    errors: any[];
    warnings: any[];
    value: any;
};
/**
 * Validate preferences option
 * @param v
 */
export declare function validatePreferences(v: Record<string, any>): {
    errors: any[];
    warnings: any[];
    value: Record<string, any>;
};
/**
 * Validate reactions
 * @param value
 * @param vote
 */
export declare const validateReactions: (value: any, vote: any) => {
    errors: any[];
    warnings: any[];
    value: any;
};
/**
 * Validate vote option
 * @param v
 */
export declare function validateVote(v: Record<string, any>): {
    errors: 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;
        };
        geocoding: {
            apiKey: 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 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
 * @return {}
 */
export declare const validateOpenAISecretKey: (value: any) => {
    errors: 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 {{}}
 */
export declare const settingsOptions: Record<string, any>;
export declare const sessionOptions: Record<string, any>;
export declare const localeOptions: Record<string, any>;
export declare const notificationsOptions: Record<string, any>;
export declare const notificationsWebSocketOptions: Record<string, any>;
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 integrationsGeocodingOptions: Record<string, any>;
export declare const validOptions: {
    [x: string]: any;
};
/**
 * Validate all options by type
 * @param values
 * @param schemaOptions
 * @return {options hydrated}
 */
export declare const validateOptions: (values: SCSettingsType, schemaOptions: Record<string, any>) => {
    validationResult: ValidationResult;
    values: SCSettingsType;
    settings?: undefined;
} | {
    validationResult: ValidationResult;
    settings: SCSettingsType;
    values?: undefined;
};