vwo-fme-react-sdk 0.1.0

package/dist/VWOProvider.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Copyright 2025 Wingify Software Pvt. Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { ReactNode } from 'react';
+/**
+ * Props for VWOProvider
+ */
+interface VWOProviderProps {
+  client?: any;
+  config?: any;
+  context: any;
+  children: ReactNode;
+}
+/**
+ * VWOProvider component to provide the VWO SDK instance and context to the app
+ * @param client - VWO SDK instance
+ * @param config - VWO SDK config (initialization config)
+ * @param context - VWO SDK context (userContext)
+ * @param children - React children (ReactNode)
+ * @returns VWOProvider component
+ */
+export declare const VWOProvider: ({ client, config, context, children }: VWOProviderProps) => any;
+export {};

package/dist/index.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Copyright 2025 Wingify Software Pvt. Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export { VWOProvider } from './VWOProvider';
+export { useVWOClient } from './useVWOClient';
+export { useGetFlag } from './useGetFlag';
+export { useGetFlagVariable } from './useGetFlagVariable';
+export { useGetFlagVariables } from './useGetFlagVariable';
+export { useTrackEvent } from './useTrackEvent';
+export { useSetAttribute } from './useSetAttribute';
+export { init } from 'vwo-fme-node-sdk';

package/dist/index.js

@@ -0,0 +1,8 @@
+
+'use strict'
+
+if (process.env.NODE_ENV === 'production') {
+  module.exports = require('./vwo-fme-react-sdk.cjs.production.min.js')
+} else {
+  module.exports = require('./vwo-fme-react-sdk.cjs.development.js')
+}

package/dist/logger/LogMessageBuilder.d.ts

@@ -0,0 +1,63 @@
+/**
+ * Copyright 2025 Wingify Software Pvt. Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { dynamic } from '../types/Common';
+/**
+ * Interface defining the structure for a log message builder.
+ */
+interface ILogMessageBuilder {
+  loggerConfig: Record<string, dynamic>;
+  transportConfig: Record<string, dynamic>;
+  prefix: string;
+  dateTimeFormat: dynamic;
+  formatMessage(level: string, message: string): string;
+  getFormattedLevel(level: string): string;
+  getFormattedDateTime(): string;
+}
+/**
+ * Implements the ILogMessageBuilder interface to provide a concrete log message builder.
+ */
+export declare class LogMessageBuilder implements ILogMessageBuilder {
+  loggerConfig: Record<string, any>;
+  transportConfig: Record<string, any>;
+  prefix: string;
+  dateTimeFormat: any;
+  /**
+   * Constructs a new LogMessageBuilder instance.
+   * @param {Record<string, any>} loggerConfig - Configuration for the logger.
+   * @param {Record<string, any>} transportConfig - Configuration for the transport mechanism.
+   */
+  constructor(loggerConfig: Record<string, any>, transportConfig: Record<string, any>);
+  /**
+   * Formats a log message combining level, prefix, date/time, and the actual message.
+   * @param {string} level - The log level.
+   * @param {string} message - The message to log.
+   * @returns {string} The formatted log message.
+   */
+  formatMessage(level: string, message: string): string;
+  getFormattedPrefix(prefix: string): string;
+  /**
+   * Returns the formatted log level with appropriate coloring based on the log level.
+   * @param {string} level - The log level.
+   * @returns {string} The formatted log level.
+   */
+  getFormattedLevel(level: string): string;
+  /**
+   * Retrieves the current date and time formatted according to the specified format.
+   * @returns {string} The formatted date and time.
+   */
+  getFormattedDateTime(): string;
+}
+export {};

package/dist/logger/Logger.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Copyright 2025 Wingify Software Pvt. Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Abstract class representing a logger.
+ * This class provides the structure for logging mechanisms and should be extended by specific logger implementations.
+ */
+export declare abstract class Logger {
+  /**
+   * Logs a message at the trace level.
+   * @param {string} message - The message to log.
+   */
+  abstract trace(message: string): void;
+  /**
+   * Logs a message at the debug level.
+   * @param {string} message - The message to log.
+   */
+  abstract debug(message: string): void;
+  /**
+   * Logs a message at the info level.
+   * @param {string} message - The message to log.
+   */
+  abstract info(message: string): void;
+  /**
+   * Logs a message at the warn level.
+   * @param {string} message - The message to log.
+   */
+  abstract warn(message: string): void;
+  /**
+   * Logs a message at the error level.
+   * @param {string} message - The message to log.
+   */
+  abstract error(message: string): void;
+}

package/dist/logger/core/LogManager.d.ts

@@ -0,0 +1,100 @@
+/**
+ * Copyright 2025 Wingify Software Pvt. Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { dynamic } from '../../types/Common';
+import { Logger } from '../Logger';
+import { LogTransportManager } from './TransportManager';
+import { LogLevelEnum } from '../enums/LogLevelEnum';
+/**
+ * Interface defining the structure and methods for LogManager.
+ */
+export interface ILogManager {
+  transportManager?: LogTransportManager;
+  config?: Record<string, dynamic>;
+  name?: string;
+  requestId?: string;
+  level: string;
+  prefix?: string;
+  dateTimeFormat?: () => string;
+  transport?: Record<string, dynamic>;
+  transports?: Array<Record<string, dynamic>>;
+  addTransport?(transportObject: Record<string, dynamic>): void;
+  addTransports?(transportsList: Array<Record<string, dynamic>>): void;
+}
+/**
+ * LogManager class provides logging functionality with support for multiple transports.
+ * It is designed as a singleton to ensure a single instance throughout the application.
+ */
+export declare class LogManager extends Logger implements ILogManager {
+  private static instance;
+  transportManager: LogTransportManager;
+  config: Record<string, any>;
+  name: string;
+  requestId: string;
+  level: LogLevelEnum;
+  prefix: string;
+  dateTimeFormat(): string;
+  transport: Record<string, any>;
+  transports: Array<Record<string, any>>;
+  /**
+   * Constructor for LogManager.
+   * @param {Record<string, any>} config - Configuration object for LogManager.
+   */
+  constructor(config?: Record<string, any>);
+  /**
+   * Provides access to the singleton instance of LogManager.
+   * @returns {LogManager} The singleton instance.
+   */
+  static get Instance(): LogManager;
+  /**
+   * Handles the initialization and setup of transports based on configuration.
+   */
+  handleTransports(): void;
+  /**
+   * Adds a single transport to the LogManager.
+   * @param {Record<any, any>} transport - The transport object to add.
+   */
+  addTransport(transport: Record<any, any>): void;
+  /**
+   * Adds multiple transports to the LogManager.
+   * @param {Array<Record<any, any>>} transports - The list of transport objects to add.
+   */
+  addTransports(transports: Record<any, any>): void;
+  /**
+   * Logs a trace message.
+   * @param {string} message - The message to log at trace level.
+   */
+  trace(message: string): void;
+  /**
+   * Logs a debug message.
+   * @param {string} message - The message to log at debug level.
+   */
+  debug(message: string): void;
+  /**
+   * Logs an informational message.
+   * @param {string} message - The message to log at info level.
+   */
+  info(message: string): void;
+  /**
+   * Logs a warning message.
+   * @param {string} message - The message to log at warn level.
+   */
+  warn(message: string): void;
+  /**
+   * Logs an error message.
+   * @param {string} message - The message to log at error level.
+   */
+  error(message: string): void;
+}

package/dist/logger/core/TransportManager.d.ts

@@ -0,0 +1,80 @@
+/**
+ * Copyright 2025 Wingify Software Pvt. Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { dynamic } from '../../types/Common';
+import { Logger } from '../Logger';
+interface IlogTransport extends Logger {
+  transports: Array<Record<string, dynamic>>;
+  config: Record<string, dynamic>;
+  shouldLog(transportLevel: string, configLevel: string): boolean;
+  log(level: string, message: string): void;
+}
+/**
+ * Manages logging transports and delegates logging messages to them based on configuration.
+ * Implements the IlogTransport interface.
+ */
+export declare class LogTransportManager implements IlogTransport {
+  transports: Array<Record<string, any>>;
+  config: Record<string, any>;
+  /**
+   * Initializes the manager with a configuration object.
+   * @param {Record<string, any>} config - Configuration settings for the log manager.
+   */
+  constructor(config: Record<string, any>);
+  /**
+   * Adds a new transport to the manager.
+   * @param {Record<string, any>} transport - The transport object to be added.
+   */
+  addTransport(transport: Record<string, any>): void;
+  /**
+   * Determines if the log should be processed based on the transport and configuration levels.
+   * @param {string} transportLevel - The log level set for the transport.
+   * @param {string} configLevel - The log level set in the configuration.
+   * @returns {boolean} - Returns true if the log level is appropriate for logging, false otherwise.
+   */
+  shouldLog(transportLevel: string, configLevel: string): boolean;
+  /**
+   * Logs a message at TRACE level.
+   * @param {string} message - The message to log.
+   */
+  trace(message: string): void;
+  /**
+   * Logs a message at DEBUG level.
+   * @param {string} message - The message to log.
+   */
+  debug(message: string): void;
+  /**
+   * Logs a message at INFO level.
+   * @param {string} message - The message to log.
+   */
+  info(message: string): void;
+  /**
+   * Logs a message at WARN level.
+   * @param {string} message - The message to log.
+   */
+  warn(message: string): void;
+  /**
+   * Logs a message at ERROR level.
+   * @param {string} message - The message to log.
+   */
+  error(message: string): void;
+  /**
+   * Delegates the logging of messages to the appropriate transports.
+   * @param {string} level - The level at which to log the message.
+   * @param {string} message - The message to log.
+   */
+  log(level: string, message: string): void;
+}
+export {};

package/dist/logger/enums/LogLevelEnum.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Copyright 2025 Wingify Software Pvt. Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export declare enum LogLevelEnum {
+  TRACE = 'trace',
+  DEBUG = 'debug',
+  INFO = 'info',
+  WARN = 'warn',
+  ERROR = 'error',
+}

package/dist/logger/index.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Copyright 2025 Wingify Software Pvt. Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export { LogManager, ILogManager } from './core/LogManager';
+export { LogLevelEnum } from './enums/LogLevelEnum';

package/dist/logger/transports/ConsoleTransport.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Copyright 2025 Wingify Software Pvt. Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Logger } from '../Logger';
+/**
+ * ConsoleTransport class implements the Logger interface to provide logging functionality.
+ * It outputs logs to the console based on the log level set in the configuration.
+ */
+export declare class ConsoleTransport implements Logger {
+  config: Record<string, any>;
+  level: string;
+  /**
+   * Constructor initializes the ConsoleTransport with a configuration object.
+   * @param {Record<string, any>} config - Configuration settings for the logger, including 'level'.
+   */
+  constructor(config?: Record<string, any>);
+  /**
+   * Logs a trace message.
+   * @param {string} message - The message to log.
+   */
+  trace(message: string): void;
+  /**
+   * Logs a debug message.
+   * @param {string} message - The message to log.
+   */
+  debug(message: string): void;
+  /**
+   * Logs an informational message.
+   * @param {string} message - The message to log.
+   */
+  info(message: string): void;
+  /**
+   * Logs a warning message.
+   * @param {string} message - The message to log.
+   */
+  warn(message: string): void;
+  /**
+   * Logs an error message.
+   * @param {string} message - The message to log.
+   */
+  error(message: string): void;
+  /**
+   * Generic log function that logs messages to the console based on the log level.
+   * @param {string} level - The log level under which the message should be logged.
+   * @param {string} message - The message to log.
+   */
+  consoleLog(level: string, message: string): void;
+}

package/dist/services/loggerService.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Copyright 2025 Wingify Software Pvt. Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * logger.ts - Global Logger Singleton
+ */
+import { LogManager } from '../logger/core/LogManager';
+/**
+ * Initializes the global logger instance.
+ * This function should be called inside `VWOProvider` before logging is used anywhere in the application.
+ *
+ * @param {object} config - The logger configuration object.
+ * @param {object} config.logger - Optional logging configuration (e.g., log level, transports).
+ * @returns {void} No return value; initializes the logger instance.
+ */
+export declare function initLogger(config: any): void;
+/**
+ * Retrieves the global logger instance.
+ * Ensures that `initLogger` has been called before attempting to use logging.
+ *
+ * @returns {LogManager} The global logger instance.
+ */
+export declare function getLogger(): LogManager;

package/dist/types/Common.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Copyright 2025 Wingify Software Pvt. Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Defines a type `dynamic` which can be used to represent a variety of data types.
+ * This type is flexible and can handle multiple types including primitive types,
+ * complex objects, and collections.
+ */
+export declare type dynamic =
+  | boolean
+  | number
+  | string
+  | Date
+  | void
+  | undefined
+  | null
+  | Record<string, any>
+  | Array<dynamicArray>
+  | Map<string, dynamicArray>;
+/**
+ * Defines a type `dynamicArray` which is used within the `dynamic` type.
+ * This type is intended for use in arrays and supports several basic data types and objects.
+ */
+export declare type dynamicArray = boolean | number | string | Record<string, any>;

package/dist/useGetFlag.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Copyright 2025 Wingify Software Pvt. Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Hook to get a feature flag value
+ * @param featureKey - The key of the feature flag to get
+ * @returns The feature flag value
+ */
+export declare const useGetFlag: (featureKey: string) => any;

package/dist/useGetFlagVariable.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Copyright 2025 Wingify Software Pvt. Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Hook to get all variables from a flag
+ * @param flag - The flag to get the variables from
+ * @returns The variables from the flag
+ */
+export declare const useGetFlagVariables: (flag: any) => any;
+/**
+ * Hook to get a flag variable
+ * @param flag - The flag to get the variable from
+ * @param variableKey - The key of the variable to get
+ * @param defaultValue - The default value to return if the variable is not found
+ * @returns The value of the variable
+ */
+export declare const useGetFlagVariable: (flag: any, variableKey: string, defaultValue: any) => any;

package/dist/useSetAttribute.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Copyright 2025 Wingify Software Pvt. Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Hook to set attributes for the user
+ * @param attributeMap - The map of attributes to set
+ */
+export declare const useSetAttribute: (attributeMap: Record<string, string>) => {};

package/dist/useTrackEvent.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Copyright 2025 Wingify Software Pvt. Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Hook to track an event
+ * @param eventName - The name of the event to track
+ * @param eventProperties - The properties of the event to track (optional)
+ */
+export declare const useTrackEvent: (eventName: string, eventProperties?: Record<string, string>) => {};

package/dist/useVWOClient.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Copyright 2025 Wingify Software Pvt. Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Returns the VWO SDK client instance
+ * @returns VWO SDK client instance
+ */
+export declare const useVWOClient: () => any;