@itly/plugin-iteratively - npm Package Compare versions

Comparing version 2.1.0 to 2.2.0

CHANGELOG.md

@@ -6,2 +6,10 @@ # Change Log
 
+# [2.2.0](https://github.com/iterativelyhq/itly-sdk/compare/v2.1.0...v2.2.0) (2021-04-08)
+
+**Note:** Version bump only for package @itly/plugin-iteratively
+
+
+
+
+
 # [2.1.0](https://github.com/iterativelyhq/itly-sdk/compare/v2.0.9...v2.1.0) (2021-04-01)
@@ -8,0 +16,0 @@

dist/cjs/index.d.ts

 import { Environment, Event, Properties, RequestLoggerPlugin, ValidationResponse, PluginLoadOptions } from '@itly/sdk';
 export declare type IterativelyOptions = {
+    /**
+     * The server endpoint to send messages.
+     * @default: https://data-us-east1.iterative.ly/t
+     */
     url?: string;
-    /** @deprecated left for backward compatibility and should be removed in one of the next versions */
-    environment?: Environment;
+    /**
+     * Tracking plan branch name (e.g. feature/demo).
+     */
     branch?: string;
+    /**
+     * Tracking plan version number (e.g. 1.0.0).
+     */
     version?: string;
+    /**
+     * Remove all property values and validation error details from messages before enqueueing.
+     * @default: false
+     */
     omitValues?: boolean;
+    /**
+     * The maximum number of messages grouped together into a single network request.
+     * @default: 100
+     */
     batchSize?: number;
+    /**
+     * The number of messages that triggers unconditional queue flushing.
+     * It works independently from flushInterval.
+     * @default: 10
+     */
     flushAt?: number;
+    /**
+     * Time in milliseconds to wait before flushing the queue.
+     * @default: 1000
+     */
     flushInterval?: number;
+    /**
+     * Disable the plugin. When disabled it doesn't enqueue or send messages.
+     * Default value depends on the environment option provided to the load() method:
+     * - If development: false
+     * - If production: true (the plugin is disabled by default)
+     */
     disabled?: boolean;
+    /**
+     * @deprecated left for backward compatibility only and should be removed in one of the next versions.
+     */
+    environment?: Environment;
 };
@@ -14,0 +49,0 @@ export declare type IterativelyOptionsPartial = IterativelyOptions;

dist/esm/index.d.ts

 import { Environment, Event, Properties, RequestLoggerPlugin, ValidationResponse, PluginLoadOptions } from '@itly/sdk';
 export declare type IterativelyOptions = {
+    /**
+     * The server endpoint to send messages.
+     * @default: https://data-us-east1.iterative.ly/t
+     */
     url?: string;
-    /** @deprecated left for backward compatibility and should be removed in one of the next versions */
-    environment?: Environment;
+    /**
+     * Tracking plan branch name (e.g. feature/demo).
+     */
     branch?: string;
+    /**
+     * Tracking plan version number (e.g. 1.0.0).
+     */
     version?: string;
+    /**
+     * Remove all property values and validation error details from messages before enqueueing.
+     * @default: false
+     */
     omitValues?: boolean;
+    /**
+     * The maximum number of messages grouped together into a single network request.
+     * @default: 100
+     */
     batchSize?: number;
+    /**
+     * The number of messages that triggers unconditional queue flushing.
+     * It works independently from flushInterval.
+     * @default: 10
+     */
     flushAt?: number;
+    /**
+     * Time in milliseconds to wait before flushing the queue.
+     * @default: 1000
+     */
     flushInterval?: number;
+    /**
+     * Disable the plugin. When disabled it doesn't enqueue or send messages.
+     * Default value depends on the environment option provided to the load() method:
+     * - If development: false
+     * - If production: true (the plugin is disabled by default)
+     */
     disabled?: boolean;
+    /**
+     * @deprecated left for backward compatibility only and should be removed in one of the next versions.
+     */
+    environment?: Environment;
 };
@@ -14,0 +49,0 @@ export declare type IterativelyOptionsPartial = IterativelyOptions;

package.json

 {
   "name": "@itly/plugin-iteratively",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Iteratively Browser Plugin for Iteratively SDK",
@@ -49,3 +49,3 @@ "main": "dist/cjs/index.js",
   },
-  "gitHead": "05fa010c6f065a705f4bd788d836cb9ade961a90"
+  "gitHead": "54d2a5a00856f7f69d28cbce893a4dbd40c662fc"
 }

New alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Fixed alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

38572

6.31%

Lines of code

591

13.44%

No dependency changes