Prepare v3.0.0 release (#32)

* Eliminate any usage

* Update JSDoc documentation

* Add CHANGELOG.md

* Bump version

CHANGELOG.md

@@ -0,0 +1 @@
+Please check the [Github Releases](https://github.com/configcat/react-sdk/releases) page for the changelog of the ConfigCat SDK for React applications.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "configcat-react",
-  "version": "2.3.0",
+  "version": "3.0.0",
   "scripts": {
     "build": "npm run build:esm && npm run build:cjs",
     "build:esm": "tsc -p tsconfig.build.esm.json && gulp esm",

src/ConfigCatHOC.tsx

@@ -1,16 +1,16 @@
-import type { IConfigCatClient, User } from "configcat-common";
+import type { IConfigCatClient, SettingTypeOf, SettingValue, User } from "configcat-common";
 import React from "react";
 import type { ConfigCatContextData } from "./ConfigCatContext";
 import ConfigCatContext from "./ConfigCatContext";
 
-export type GetValueType = (
+export type GetValueType = <T extends SettingValue>(
   key: string,
-  defaultValue: any,
+  defaultValue: T,
   user?: User
-) => Promise<any>;
+) => Promise<SettingTypeOf<T>>;
 
 const getValueFunction = (client: IConfigCatClient) => {
-  return async function name(key: string, defaultValue: any, user?: User) {
+  return async function <T extends SettingValue>(key: string, defaultValue: T, user?: User) {
     return await client.getValueAsync(key, defaultValue, user);
   };
 };

src/ConfigCatHooks.tsx

@@ -1,16 +1,16 @@
-import type { IConfigCatClient, User } from "configcat-common";
+import type { IConfigCatClient, SettingTypeOf, SettingValue, User } from "configcat-common";
 import { useContext, useEffect, useState } from "react";
 import ConfigCatContext from "./ConfigCatContext";
 
-function useFeatureFlag(key: string, defaultValue: any, user?: User | undefined): {
-  value: any;
+function useFeatureFlag<T extends SettingValue>(key: string, defaultValue: T, user?: User): {
+  value: SettingTypeOf<T>;
   loading: boolean;
 } {
   const configCatContext = useContext(ConfigCatContext);
 
   if (configCatContext === void 0) throw Error("useFeatureFlag hook must be used in ConfigCatProvider!");
 
-  const [featureFlagValue, setFeatureFlag] = useState(defaultValue);
+  const [featureFlagValue, setFeatureFlag] = useState(defaultValue as SettingTypeOf<T>);
   const [loading, setLoading] = useState(true);
 
   useEffect(() => {

src/index.ts

@@ -6,18 +6,33 @@ import withConfigCatClient from "./ConfigCatHOC";
 import { useConfigCatClient, useFeatureFlag } from "./ConfigCatHooks";
 import ConfigCatProvider from "./ConfigCatProvider";
 
+/**
+ * Creates an instance of `ConfigCatConsoleLogger`.
+ * @param logLevel Log level (the minimum level to use for filtering log events).
+ */
 export function createConsoleLogger(logLevel: LogLevel): IConfigCatLogger {
   return configcatcommon.createConsoleLogger(logLevel);
 }
 
+/**
+ * Creates an instance of `FlagOverrides` that uses a map data source.
+ * @param map The map that contains the overrides.
+ * @param behaviour The override behaviour.
+ * Specifies whether the local values should override the remote values
+ * or local values should only be used when a remote value doesn't exist
+ * or the local values should be used only.
+ */
 export function createFlagOverridesFromMap(map: { [name: string]: NonNullable<SettingValue> }, behaviour: OverrideBehaviour): FlagOverrides {
   return new FlagOverrides(new MapOverrideDataSource(map), behaviour);
 }
 
+/** Options used to configure the ConfigCat SDK in the case of Auto Polling mode. */
 export type IReactAutoPollOptions = IAutoPollOptions;
 
+/** Options used to configure the ConfigCat SDK in the case of Lazy Loading mode. */
 export type IReactLazyLoadingOptions = ILazyLoadingOptions;
 
+/** Options used to configure the ConfigCat SDK in the case of Manual Polling mode. */
 export type IReactManualPollOptions = IManualPollOptions;
 
 export type IReactConfigCatLogger = IConfigCatLogger;