diff --git a/CHANGELOG.md b/CHANGELOG.md
index 4390b46e..f5e6bd8e 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,3 +1,6 @@
+## 24.4.1
+- Added types for the SDK
+
## 24.4.0
! Minor breaking change ! For implementations using `salt` the browser compatability is tied to SubtleCrypto's `digest` method support
diff --git a/examples/Angular/countly.d.ts b/examples/Angular/countly.d.ts
deleted file mode 100644
index 4c21fb8c..00000000
--- a/examples/Angular/countly.d.ts
+++ /dev/null
@@ -1,25 +0,0 @@
-declare module 'countly-sdk-web' {
-
- namespace Countly {
- /**
- * It initializes the SDK and exposes it to the window object. It should be called before any other SDK methods in sync implementations.
- *
- * @param {object} config - Configuration object. Determines the SDK behavior. Some essential keys are:
- *
- * app_key : "app key" from your Countly server application. (MANDATORY!)
- *
- * url : Your Countly server URL. You may also use your own server URL or IP here. (MANDATORY!)
- *
- * debug : Enables SDK logs to be printed into the browser console. (default: false)
- *
- * For the full list of configuration options, see https://support.count.ly/hc/en-us/articles/360037441932-Web-analytics-JavaScript#h_01HABTQ439HZN7Y6A6F07Y6G0K
- */
- function init(config: object): void;
- }
-
- export default Countly;
-}
-
-interface Window {
- Countly: any;
-}
diff --git a/examples/Angular/main.ts b/examples/Angular/main.ts
index bc6a4a84..1a0555a2 100644
--- a/examples/Angular/main.ts
+++ b/examples/Angular/main.ts
@@ -1,8 +1,6 @@
-import { enableProdMode } from '@angular/core';
-import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
-
-import { AppModule } from './app/app.module';
-import { environment } from './environments/environment';
+import { bootstrapApplication } from '@angular/platform-browser';
+import { appConfig } from './app/app.config';
+import { AppComponent } from './app/app.component';
import Countly from 'countly-sdk-web';
@@ -17,15 +15,64 @@ if (COUNTLY_APP_KEY === "YOUR_APP_KEY" || COUNTLY_SERVER_KEY === "https://your.s
// initializing countly with params
Countly.init({
app_key: COUNTLY_APP_KEY,
- url: COUNTLY_SERVER_KEY, //your server goes here
+ url: COUNTLY_SERVER_KEY,
debug: true
});
+
+// Automatic tracking
Countly.track_sessions();
+Countly.track_clicks();
+Countly.track_links();
+Countly.track_forms();
+Countly.track_errors();
+Countly.track_scrolls();
+Countly.track_pageview();
-if (environment.production) {
- enableProdMode();
+// Showing a feedback widget
+Countly.get_available_feedback_widgets(function (widgets, err) {
+ console.log('Available feedback widgets:', widgets);
+ if (widgets && widgets.length) {
+ console.log('Presenting feedback widget:', widgets[0]);
+ Countly.present_feedback_widget(widgets[0]); // Show the first widget
+ }
+});
-}
+// Reporting a feedback widget's result manually
+Countly.get_available_feedback_widgets(function (widgets, err) {
+ console.log('Available feedback widgets:', widgets);
+ if (widgets && widgets.length) {
+ console.log('Reporting feedback widget:', widgets[0]);
+ Countly.getFeedbackWidgetData(widgets[0], function (data, err) {
+ console.log('Feedback widget data:', data);
+ Countly.reportFeedbackWidgetManually(widgets[0], data, null); // Report the first widget's data as null
+ });
+ }
+});
+
+// add a custom event
+Countly.add_event({
+ key: "test",
+ count: 1,
+ dur: 50,
+ sum: 0.99,
+ segmentation: {
+ "Country": "Germany",
+ "Age": "28"
+ }
+});
+
+// send some user properties
+Countly.user_details({
+ name: "John Doe",
+ username: "johndoe",
+ organization: "Countly",
+ phone: "1234567890",
+ picture: "https://path.to/picture",
+});
+
+// set custom user property
+Countly.userData.set("key", "value");
+Countly.userData.save();
-platformBrowserDynamic().bootstrapModule(AppModule)
- .catch(err => console.error(err));
+bootstrapApplication(AppComponent, appConfig)
+ .catch((err) => console.error(err));
diff --git a/lib/countly.d.ts b/lib/countly.d.ts
new file mode 100644
index 00000000..5860cf2d
--- /dev/null
+++ b/lib/countly.d.ts
@@ -0,0 +1,516 @@
+declare module "countly-sdk-web" {
+ namespace Countly {
+ /**
+ * It initializes the SDK and exposes it to the window object. It should be called before any other SDK methods in sync implementations.
+ * @param {object} config - Configuration object. Determines the SDK behavior. Some essential keys are:
+ *
+ * app_key : "app key" from your Countly server application. (MANDATORY!)
+ *
+ * url : Your Countly server URL. You may also use your own server URL or IP here. (MANDATORY!)
+ *
+ * debug : Enables SDK logs to be printed into the browser console. (default: false)
+ *
+ * For the full list of configuration options, see https://support.count.ly/hc/en-us/articles/360037441932-Web-analytics-JavaScript#h_01HABTQ439HZN7Y6A6F07Y6G0K
+ */
+ function init(config: object): void;
+
+ /**
+ * Modify feature groups for consent management. Allows you to group multiple features under one feature group
+ * @param {object} features - object to define feature name as key and core features as value
+ * @example Adding all features under one group
+ * Countly.group_features({all:["sessions","events","views","scrolls","clicks","forms","crashes","attribution","users"]});
+ * //After this call Countly.add_consent("all") to allow all features
+ * @example Grouping features
+ * Countly.group_features({
+ * activity:["sessions","events","views"],
+ * interaction:["scrolls","clicks","forms"]
+ * });
+ * //After this call Countly.add_consent("activity") to allow "sessions","events","views"
+ * //or call Countly.add_consent("interaction") to allow "scrolls","clicks","forms"
+ * //or call Countly.add_consent("crashes") to allow some separate feature
+ */
+ function group_features(features: object): void;
+
+ /**
+ * Check if consent is given for specific feature (either core feature of from custom feature group)
+ * @param {string} feature - name of the feature, possible values, "sessions","events","views","scrolls","clicks","forms","crashes","attribution","users" or custom provided through {@link Countly.group_features}
+ * @returns {Boolean} true if consent was given for the feature or false if it was not
+ */
+ function check_consent(feature: string): boolean;
+
+ enum DeviceIdType {
+ DEVELOPER_SUPPLIED,
+ SDK_GENERATED,
+ TEMPORARY_ID,
+ }
+
+ /**
+ * Countly SDK async queue
+ * You can push methods here to be executed after Countly SDK is fully loaded
+ * @example
+ * Countly.q.push(['track_sessions']);
+ * Countly.q.push(['add_event',{
+ * "key": "click",
+ * "count": 1,
+ * "sum": 1.5,
+ * "dur": 30,
+ * "segmentation": {
+ * "key1": "value1",
+ * "key2": "value2"
+ * }
+ * }]);
+ * @type {Array}
+ */
+ let q: any[];
+
+ /**
+ * Checks and return the current device id type
+ * @returns {DeviceIdType|number} a number that indicates the device id type (or -1 if not set)
+ */
+ function get_device_id_type(): DeviceIdType;
+
+ /**
+ * Gives the current device id (of the CountlyClass instance)
+ * @returns {string} device id
+ */
+ function get_device_id(): string;
+
+ /**
+ * Add consent for specific feature, meaning, user allowed to track that data (either core feature or from custom feature group)
+ * @param {string | string[]} feature - name of the feature, possible values: "sessions", "events", "views", "scrolls", "clicks", "forms", "crashes", "attribution", "users", etc. or custom provided through {@link Countly.group_features}
+ */
+ function add_consent(feature: string | string[]): void;
+
+ /**
+ * Remove consent for specific feature, meaning, user opted out to track that data (either core feature or from custom feature group)
+ * @param {string | string[]} feature - name of the feature, possible values: "sessions", "events", "views", "scrolls", "clicks", "forms", "crashes", "attribution", "users", etc. or custom provided through {@link Countly.group_features}
+ */
+ function remove_consent(feature: string | string[]): void;
+
+ /**
+ * Enable offline mode, which disables data tracking and temporarily changes the device ID.
+ */
+ function enable_offline_mode(): void;
+
+ /**
+ * Disable offline mode, re-enabling data tracking and potentially changing the device ID.
+ * @param {string} [device_id] - Optional new device ID to use when disabling offline mode. If not provided, a new ID will be generated.
+ */
+ function disable_offline_mode(device_id?: string): void;
+
+ /**
+ * Start session
+ * @param {boolean} noHeartBeat - true if you don't want to use internal heartbeat to manage session
+ * @param {boolean} force - force begin session request even if session cookie is enabled
+ */
+ function begin_session(noHeartBeat: boolean, force: boolean): void;
+
+ /**
+ * Report session duration
+ * @param {number} sec - amount of seconds to report for current session
+ */
+ function session_duration(sec: number): void;
+
+ /**
+ * End current session
+ * @param {number} sec - amount of seconds to report for current session, before ending it
+ * @param {boolean} force - force end session request even if session cookie is enabled
+ */
+ function end_session(sec: number, force: boolean): void;
+
+ /**
+ * Change current user/device id
+ * @param {string} newId - new user/device ID to use. Must be a non-empty string value. Invalid values (like null, empty string or undefined) will be rejected
+ * @param {boolean} merge - move data from old ID to new ID on server
+ */
+ function change_id(newId: string, merge: boolean): void;
+
+ /**
+ * Report custom event
+ * @param {Object} event - Countly {@link Event} object
+ * @param {string} event.key - name or id of the event
+ * @param {number} [event.count=1] - how many times did event occur
+ * @param {number} [event.sum] - sum to report with event (if any)
+ * @param {number} [event.dur] - duration to report with event (if any)
+ * @param {Object} [event.segmentation] - object with segments key/values
+ */
+ function add_event(event: {
+ key: string;
+ count?: number;
+ sum?: number;
+ dur?: number;
+ segmentation?: { [key: string]: any };
+ }): void;
+
+ /**
+ * Start timed event, which will fill in duration property upon ending automatically
+ * This works basically as a timer and does not create an event till end_event is called
+ * @param {string} key - event name that will be used as key property
+ */
+ function start_event(key: string): void;
+
+ /**
+ * Cancel timed event, cancels a timed event if it exists
+ * @param {string} key - event name that will be canceled
+ * @returns {boolean} - returns true if the event was canceled and false if no event with that key was found
+ */
+ function cancel_event(key: string): boolean;
+
+ /**
+ * End timed event
+ * @param {string | Object} event - event key if string or Countly event same as passed to {@link Countly.add_event}
+ */
+ function end_event(
+ event:
+ | string
+ | {
+ key: string;
+ count?: number;
+ sum?: number;
+ dur?: number;
+ segmentation?: { [key: string]: any };
+ }
+ ): void;
+
+ /**
+ * Report user conversion to the server (when user signup or made a purchase, or whatever your conversion is), if there is no campaign data, user will be reported as organic
+ * @param {string} [campaign_id] - id of campaign, or will use the one that is stored after campaign link click
+ * @param {string} [campaign_user_id] - id of user's click on campaign, or will use the one that is stored after campaign link click
+ */
+ function recordDirectAttribution(
+ campaign_id?: string,
+ campaign_user_id?: string
+ ): void;
+
+ /**
+ * Provide information about user
+ * @param {Object} user - Countly {@link UserDetails} object
+ * @param {string} [user.name] - user's full name
+ * @param {string} [user.username] - user's username or nickname
+ * @param {string} [user.email] - user's email address
+ * @param {string} [user.organization] - user's organization or company
+ * @param {string} [user.phone] - user's phone number
+ * @param {string} [user.picture] - url to user's picture
+ * @param {string} [user.gender] - M value for male and F value for female
+ * @param {number} [user.byear] - user's birth year used to calculate current age
+ * @param {Object} [user.custom] - object with custom key value properties you want to save with user
+ */
+ function user_details(user: {
+ name?: string;
+ username?: string;
+ email?: string;
+ organization?: string;
+ phone?: string;
+ picture?: string;
+ gender?: string;
+ byear?: number;
+ custom?: { [key: string]: any };
+ }): void;
+
+ namespace userData {
+ /**
+ * Sets user's custom property value
+ * @param {string} key - name of the property to attach to user
+ * @param {string|number} value - value to store under provided property
+ */
+ function set(key: string, value: string | number): void;
+
+ /**
+ * Unset/deletes user's custom property
+ * @param {string} key - name of the property to delete
+ */
+ function unset(key: string): void;
+
+ /**
+ * Sets user's custom property value only if it was not set before
+ * @param {string} key - name of the property to attach to user
+ * @param {string|number} value - value to store under provided property
+ */
+ function set_once(key: string, value: string | number): void;
+
+ /**
+ * Increment value under the key of this user's custom properties by one
+ * @param {string} key - name of the property to attach to user
+ */
+ function increment(key: string): void;
+
+ /**
+ * Increment value under the key of this user's custom properties by provided value
+ * @param {string} key - name of the property to attach to user
+ * @param {number} value - value by which to increment server value
+ */
+ function increment_by(key: string, value: number): void;
+
+ /**
+ * Multiply value under the key of this user's custom properties by provided value
+ * @param {string} key - name of the property to attach to user
+ * @param {number} value - value by which to multiply server value
+ */
+ function multiply(key: string, value: number): void;
+
+ /**
+ * Save maximal value under the key of this user's custom properties
+ * @param {string} key - name of the property to attach to user
+ * @param {number} value - value which to compare to server's value and store maximal value of both provided
+ */
+ function max(key: string, value: number): void;
+
+ /**
+ * Save minimal value under the key of this user's custom properties
+ * @param {string} key - name of the property to attach to user
+ * @param {number} value - value which to compare to server's value and store minimal value of both provided
+ */
+ function min(key: string, value: number): void;
+
+ /**
+ * Add value to array under the key of this user's custom properties. If property is not an array, it will be converted to array
+ * @param {string} key - name of the property to attach to user
+ * @param {string|number} value - value which to add to array
+ */
+ function push(key: string, value: string | number): void;
+
+ /**
+ * Add value to array under the key of this user's custom properties, storing only unique values. If property is not an array, it will be converted to array
+ * @param {string} key - name of the property to attach to user
+ * @param {string|number} value - value which to add to array
+ */
+ function push_unique(key: string, value: string | number): void;
+
+ /**
+ * Remove value from array under the key of this user's custom properties
+ * @param {string} key - name of the property
+ * @param {string|number} value - value which to remove from array
+ */
+ function pull(key: string, value: string | number): void;
+
+ /**
+ * Save changes made to user's custom properties object and send them to server
+ */
+ function save(): void;
+ }
+
+ /**
+ * Report performance trace
+ * @param {Object} trace - apm trace object
+ * @param {string} trace.type - device or network
+ * @param {string} trace.name - url or view of the trace
+ * @param {number} trace.stz - start timestamp
+ * @param {number} trace.etz - end timestamp
+ * @param {Object} trace.app_metrics - key/value metrics like duration, to report with trace where value is number
+ * @param {Object} [trace.apm_attr] - object profiling attributes (not yet supported)
+ */
+ function report_trace(trace: {
+ type: string;
+ name: string;
+ stz: number;
+ etz: number;
+ app_metrics: { [key: string]: number };
+ apm_attr?: { [key: string]: any };
+ }): void;
+
+ /**
+ * Automatically track JavaScript errors that happen on the website and report them to the server
+ * @param {Object} [segments] - additional key-value pairs you want to provide with error report, like versions of libraries used, etc.
+ */
+ function track_errors(segments?: Object): void;
+
+ /**
+ * Log an exception that you caught through try and catch block and handled yourself and just want to report it to server
+ * @param {Object} err - error exception object provided in catch block
+ * @param {Object} [segments] - additional key-value pairs you want to provide with error report, like versions of libraries used, etc.
+ */
+ function log_error(err: Object, segments?: Object): void;
+
+ /**
+ * Add new line in the log of breadcrumbs of what user did, will be included together with error report
+ * @param {string} record - any text describing what user did
+ */
+ function add_log(record: string): void;
+
+ /**
+ * Fetch remote config from the server
+ * @param {string[]} [keys] - Array of keys to fetch, if not provided will fetch all keys
+ * @param {string[]} [omit_keys] - Array of keys to omit, if provided will fetch all keys except provided ones
+ * @param {Function} [callback] - Callback to notify with first param error and second param remote config object
+ */
+ function fetch_remote_config(
+ keys?: string[],
+ omit_keys?: string[],
+ callback?: (error: any, config: any) => void
+ ): void;
+
+ /**
+ * AB testing key provider, opts the user in for the selected keys
+ * @param {string[]} [keys] - Array of keys opt in FOR
+ */
+ function enrollUserToAb(keys?: string[]): void;
+
+ /**
+ * Gets remote config object (all key/value pairs) or specific value for provided key from the storage
+ * @param {string} [key] - if provided, will return value for key, or return whole object
+ * @returns {object} remote configs
+ */
+ function get_remote_config(key?: string): object;
+
+ /**
+ * Track user sessions automatically, including time user spent on your website
+ */
+ function track_sessions(): void;
+
+ /**
+ * Track page views user visits
+ * @param {string} [page] - optional name of the page, by default uses current url path
+ * @param {string[]} [ignoreList] - optional array of strings or regexps to test for the url/view name to ignore and not report
+ * @param {object} [viewSegments] - optional key value object with segments to report with the view
+ */
+ function track_pageview(
+ page?: string,
+ ignoreList?: string[],
+ viewSegments?: object
+ ): void;
+
+ /**
+ * Track all clicks on this page
+ * @param {Object} [parent] - DOM object whose children to track, by default it is document body
+ */
+ function track_clicks(parent?: Object): void;
+
+ /**
+ * Track all scrolls on this page
+ * @param {Object} [parent] - DOM object whose children to track, by default it is document body
+ */
+ function track_scrolls(parent?: Object): void;
+
+ /**
+ * Generate custom event for all links that were clicked on this page
+ * @param {Object} [parent] - DOM object whose children to track, by default it is document body
+ */
+ function track_links(parent?: Object): void;
+
+ /**
+ * Generate custom event for all forms that were submitted on this page
+ * @param {Object} [parent] - DOM object whose children to track, by default it is document body
+ * @param {boolean} [trackHidden] - provide true to also track hidden inputs, default false
+ */
+ function track_forms(parent?: Object, trackHidden?: boolean): void;
+
+ /**
+ * Collect possible user data from submitted forms. Add cly_user_ignore class to ignore inputs in forms or cly_user_{key} to collect data from this input as specified key, as cly_user_username to save collected value from this input as username property. If no class is provided, Countly SDK will try to determine type of information automatically.
+ * @param {Object} [parent] - DOM object whose children to track, by default it is document body
+ * @param {boolean} [useCustom=false] - submit collected data as custom user properties, by default collects as main user properties
+ */
+ function collect_from_forms(parent?: Object, useCustom?: boolean): void;
+
+ /**
+ * Collect information about user from Facebook, if your website integrates Facebook SDK. Call this method after Facebook SDK is loaded and user is authenticated.
+ * @param {Object} [custom] - Custom keys to collect from Facebook, key will be used to store as key in custom user properties and value as key in Facebook graph object. For example, {"tz":"timezone"} will collect Facebook's timezone property, if it is available and store it in custom user's property under "tz" key. If you want to get value from some sub-object properties, then use dot as delimiter, for example, {"location":"location.name"} will collect data from Facebook's {"location":{"name":"MyLocation"}} object and store it in user's custom property "location" key.
+ */
+ function collect_from_facebook(custom?: { [key: string]: string }): void;
+
+ /**
+ * Report information about survey, NPS, or rating widget answers/results
+ * @param {Object} CountlyFeedbackWidget - it is the widget object retrieved from get_available_feedback_widgets
+ * @param {Object} CountlyWidgetData - it is the widget data object retrieved from getFeedbackWidgetData
+ * @param {Object|null} widgetResult - it is the widget results that need to be reported, different for all widgets, if provided as null it means the widget was closed
+ * widgetResult For NPS
+ * Should include rating and comment from the NPS. Example:
+ * widgetResult = {rating: 3, comment: "comment"}
+ *
+ * widgetResult For Survey
+ * Should include questions ids and their answers as key/value pairs. Keys should be formed as “answ-”+[question.id]. Example:
+ * widgetResult = {
+ * "answ-1602694029-0": "Some text field long answer", //for text fields
+ * "answ-1602694029-1": 7, //for rating
+ * "answ-1602694029-2": "ch1602694029-0", //There is a question with choices like multi or radio. It is a choice key.
+ * "answ-1602694029-3": "ch1602694030-0,ch1602694030-1" //In case 2 selected
+ * }
+ *
+ * widgetResult For Rating Widget
+ * Should include rating, email, comment and contact consent information. Example:
+ * widgetResult = {
+ * rating: 2,
+ * email: "email@mail.com",
+ * contactMe: true,
+ * comment: "comment"
+ * }
+ */
+ function reportFeedbackWidgetManually(
+ CountlyFeedbackWidget: { _id: string; type: string },
+ CountlyWidgetData: object,
+ widgetResult:
+ | { rating: number; comment?: string }
+ | { [key: string]: string | number }
+ | {
+ rating: number;
+ email?: string;
+ contactMe?: boolean;
+ comment?: string;
+ }
+ | null
+ ): void;
+
+ /**
+ * This function retrieves all associated widget information (IDs, type, name etc in an array/list of objects) of your app
+ * @param {Function} callback - Callback function with two parameters, 1st for returned list, 2nd for error
+ * @returns {void}
+ */
+ function get_available_feedback_widgets(
+ callback: (
+ widgets: Array<{ _id: string; type: string; name: string }>,
+ error: Error | null
+ ) => void
+ ): void;
+
+ /**
+ * Get feedback (nps, survey or rating) widget data, like questions, message etc.
+ * @param {Object} CountlyFeedbackWidget - Widget object, retrieved from 'get_available_feedback_widgets'
+ * @param {string} CountlyFeedbackWidget._id - The unique identifier of the widget
+ * @param {string} CountlyFeedbackWidget.type - The type of the widget (nps, survey, rating)
+ * @param {string} CountlyFeedbackWidget.name - The name of the widget
+ * @param {Function} callback - Callback function with two parameters, 1st for returned widget data, 2nd for error
+ * @returns {void}
+ */
+ function getFeedbackWidgetData(
+ CountlyFeedbackWidget: { _id: string; type: string; name: string },
+ callback: (widgetData: Object, error: Error | null) => void
+ ): void;
+
+ /**
+ * Present the feedback widget in webview
+ * @param {Object} presentableFeedback - Current presentable feedback
+ * @param {string} [id] - DOM id to append the feedback widget (optional, in case not used pass undefined)
+ * @param {string} [className] - Class name to append the feedback widget (optional, in case not used pass undefined)
+ * @param {Object} [feedbackWidgetSegmentation] - Segmentation object to be passed to the feedback widget (optional)
+ */
+ function present_feedback_widget(
+ presentableFeedback: object,
+ id?: string,
+ className?: string,
+ feedbackWidgetSegmentation?: object
+ ): void;
+
+ /**
+ * Overwrite a way to retrieve view name
+ * @return {string} view name
+ */
+ function getViewName(): string;
+
+ /**
+ * Overwrite a way to retrieve view url
+ * @return {string} view url
+ */
+ function getViewUrl(): string;
+
+ /**
+ * Overwrite a way to get search query
+ * @return {string} search query
+ */
+ function getSearchQuery(): string;
+ }
+
+ export default Countly;
+}
+
+interface Window {
+ Countly: any;
+}
diff --git a/lib/countly.js b/lib/countly.js
index 867cd160..b9451f51 100644
--- a/lib/countly.js
+++ b/lib/countly.js
@@ -1562,13 +1562,17 @@
/**
* Remove consent for specific feature, meaning, user opted out to track that data (either core feature of from custom feature group)
* @param {string|array} feature - name of the feature, possible values, "sessions","events","views","scrolls","clicks","forms","crashes","attribution","users", etc or custom provided through {@link Countly.group_features}
- * @param {Boolean} enforceConsentUpdate - regulates if a request will be sent to the server or not. If true, removing consents will send a request to the server and if false, consents will be removed without a request
*/
this.remove_consent = function (feature) {
log(logLevelEnums.INFO, "remove_consent, Removing consent for [" + feature + "]");
this.remove_consent_internal(feature, true);
};
- // removes consent without updating
+
+ /**
+ * Remove consent for specific feature, meaning, user opted out to track that data (either core feature of from custom feature group)
+ * @param {string|array} feature - name of the feature, possible values, "sessions","events","views","scrolls","clicks","forms","crashes","attribution","users", etc or custom provided through {@link Countly.group_features}
+ * @param {Boolean} enforceConsentUpdate - regulates if a request will be sent to the server or not. If true, removing consents will send a request to the server and if false, consents will be removed without a request
+ */
this.remove_consent_internal = function (feature, enforceConsentUpdate) {
// if true updateConsent will execute when possible
enforceConsentUpdate = enforceConsentUpdate || false;
@@ -2286,7 +2290,7 @@
/**
* Automatically track javascript errors that happen on the website and report them to the server
- * @param {string=} segments - additional key value pairs you want to provide with error report, like versions of libraries used, etc.
+ * @param {Object} segments - additional key value pairs you want to provide with error report, like versions of libraries used, etc.
* */
this.track_errors = function (segments) {
if (!isBrowser) {
@@ -2352,7 +2356,7 @@
/**
* Log an exception that you caught through try and catch block and handled yourself and just want to report it to server
* @param {Object} err - error exception object provided in catch block
- * @param {string=} segments - additional key value pairs you want to provide with error report, like versions of libraries used, etc.
+ * @param {Object} segments - additional key value pairs you want to provide with error report, like versions of libraries used, etc.
* */
this.log_error = function (err, segments) {
log(logLevelEnums.INFO, "log_error, Logging errors");
diff --git a/package.json b/package.json
index 7ba38946..5ed38bb0 100644
--- a/package.json
+++ b/package.json
@@ -3,6 +3,7 @@
"version": "24.4.0",
"description": "Countly Web SDK",
"main": "lib/countly.js",
+ "types": "lib/countly.d.ts",
"directories": {
"example": "examples",
"lib": "lib",