Skip to content

Commit 1e45f1b

Browse files
amplitude-sdk-botamplitude-sdk-bot
committed
chore(release): publish v1.3.0
1 parent dbab7e8 commit 1e45f1b

17 files changed

+225
-38
lines changed

‎CHANGELOG.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,17 @@
33
All notable changes to this project will be documented in this file.
44
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
55

6+
# [1.3.0](https://github.com/amplitude/experiment-js-client/compare/v1.2.0...v1.3.0) (2021-10-18)
7+
8+
9+
### Features
10+
11+
* unset user properties when variant evaluates to none or is a fallback ([#13](https://github.com/amplitude/experiment-js-client/issues/13)) ([dbab7e8](https://github.com/amplitude/experiment-js-client/commit/dbab7e83659628edcd4fca71e001fc38cae6b27b))
12+
13+
14+
15+
16+
617
# [1.2.0](https://github.com/amplitude/experiment-js-client/compare/v1.1.1...v1.2.0) (2021-08-12)
718

819

‎docs/assets/js/search.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/classes/amplitudeanalyticsprovider.html‎

Lines changed: 74 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
<head>
44
<meta charset="utf-8">
55
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6-
<title>AmplitudeAnalyticsProvider | Experiment JS Client Documentation - v1.2.0</title>
7-
<meta name="description" content="Documentation for Experiment JS Client Documentation - v1.2.0">
6+
<title>AmplitudeAnalyticsProvider | Experiment JS Client Documentation - v1.3.0</title>
7+
<meta name="description" content="Documentation for Experiment JS Client Documentation - v1.3.0">
88
<meta name="viewport" content="width=device-width, initial-scale=1">
99
<style type="text/css">:root {
1010
--color-background: #fdfdfd;
@@ -2674,7 +2674,7 @@
26742674
<div class="container">
26752675
<div class="table-wrap">
26762676
<div class="table-cell">
2677-
<strong><a href="../index.html">Experiment JS Client Documentation - v1.2.0</a></strong>
2677+
<strong><a href="../index.html">Experiment JS Client Documentation - v1.3.0</a></strong>
26782678
</div>
26792679
<div class="table-cell" id="tsd-widgets">
26802680
<div id="tsd-filter">
@@ -2713,9 +2713,15 @@
27132713
<li class=" tsd-kind-constructor tsd-parent-kind-class">
27142714
<a href="amplitudeanalyticsprovider.html#constructor" class="tsd-kind-icon">constructor</a>
27152715
</li>
2716+
<li class=" tsd-kind-method tsd-parent-kind-class">
2717+
<a href="amplitudeanalyticsprovider.html#setuserproperty" class="tsd-kind-icon">set<wbr>User<wbr>Property</a>
2718+
</li>
27162719
<li class=" tsd-kind-method tsd-parent-kind-class">
27172720
<a href="amplitudeanalyticsprovider.html#track" class="tsd-kind-icon">track</a>
27182721
</li>
2722+
<li class=" tsd-kind-method tsd-parent-kind-class">
2723+
<a href="amplitudeanalyticsprovider.html#unsetuserproperty" class="tsd-kind-icon">unset<wbr>User<wbr>Property</a>
2724+
</li>
27192725
</ul>
27202726
</li>
27212727
<li class=" tsd-kind-class">
@@ -2790,7 +2796,9 @@ <h3>Constructors</h3>
27902796
<section class="tsd-index-section ">
27912797
<h3>Methods</h3>
27922798
<ul class="tsd-index-list">
2799+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="amplitudeanalyticsprovider.html#setuserproperty" class="tsd-kind-icon">set<wbr>User<wbr>Property</a></li>
27932800
<li class="tsd-kind-method tsd-parent-kind-class"><a href="amplitudeanalyticsprovider.html#track" class="tsd-kind-icon">track</a></li>
2801+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="amplitudeanalyticsprovider.html#unsetuserproperty" class="tsd-kind-icon">unset<wbr>User<wbr>Property</a></li>
27942802
</ul>
27952803
</section>
27962804
</div>
@@ -2821,6 +2829,34 @@ <h4 class="tsd-returns-title">Returns <a href="amplitudeanalyticsprovider.html"
28212829
</section>
28222830
<section class="tsd-panel-group tsd-member-group ">
28232831
<h2>Methods</h2>
2832+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
2833+
<a name="setuserproperty" class="tsd-anchor"></a>
2834+
<h3>set<wbr>User<wbr>Property</h3>
2835+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
2836+
<li class="tsd-signature tsd-kind-icon">set<wbr>User<wbr>Property<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExperimentAnalyticsEvent</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
2837+
</ul>
2838+
<ul class="tsd-descriptions">
2839+
<li class="tsd-description">
2840+
<aside class="tsd-sources">
2841+
<p>Implementation of <a href="../interfaces/experimentanalyticsprovider.html">ExperimentAnalyticsProvider</a>.<a href="../interfaces/experimentanalyticsprovider.html#setuserproperty">setUserProperty</a></p>
2842+
</aside>
2843+
<div class="tsd-comment tsd-typography">
2844+
<div class="lead">
2845+
<p>Wraps an analytics identify or set user property call. This is typically
2846+
called by the experiment client before sending an
2847+
&quot;[Experiment] Exposure&quot; event.</p>
2848+
</div>
2849+
</div>
2850+
<h4 class="tsd-parameters-title">Parameters</h4>
2851+
<ul class="tsd-parameters">
2852+
<li>
2853+
<h5>event: <span class="tsd-signature-type">ExperimentAnalyticsEvent</span></h5>
2854+
</li>
2855+
</ul>
2856+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
2857+
</li>
2858+
</ul>
2859+
</section>
28242860
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
28252861
<a name="track" class="tsd-anchor"></a>
28262862
<h3>track</h3>
@@ -2832,6 +2868,41 @@ <h3>track</h3>
28322868
<aside class="tsd-sources">
28332869
<p>Implementation of <a href="../interfaces/experimentanalyticsprovider.html">ExperimentAnalyticsProvider</a>.<a href="../interfaces/experimentanalyticsprovider.html#track">track</a></p>
28342870
</aside>
2871+
<div class="tsd-comment tsd-typography">
2872+
<div class="lead">
2873+
<p>Wraps an analytics event track call. This is typically called by the
2874+
experiment client after setting user properties to track an
2875+
&quot;[Experiment] Exposure&quot; event</p>
2876+
</div>
2877+
</div>
2878+
<h4 class="tsd-parameters-title">Parameters</h4>
2879+
<ul class="tsd-parameters">
2880+
<li>
2881+
<h5>event: <span class="tsd-signature-type">ExperimentAnalyticsEvent</span></h5>
2882+
</li>
2883+
</ul>
2884+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
2885+
</li>
2886+
</ul>
2887+
</section>
2888+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
2889+
<a name="unsetuserproperty" class="tsd-anchor"></a>
2890+
<h3>unset<wbr>User<wbr>Property</h3>
2891+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
2892+
<li class="tsd-signature tsd-kind-icon">unset<wbr>User<wbr>Property<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExperimentAnalyticsEvent</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
2893+
</ul>
2894+
<ul class="tsd-descriptions">
2895+
<li class="tsd-description">
2896+
<aside class="tsd-sources">
2897+
<p>Implementation of <a href="../interfaces/experimentanalyticsprovider.html">ExperimentAnalyticsProvider</a>.<a href="../interfaces/experimentanalyticsprovider.html#unsetuserproperty">unsetUserProperty</a></p>
2898+
</aside>
2899+
<div class="tsd-comment tsd-typography">
2900+
<div class="lead">
2901+
<p>Wraps an analytics unset user property call. This is typically
2902+
called by the experiment client when a user has been evaluated to use
2903+
a fallback variant.</p>
2904+
</div>
2905+
</div>
28352906
<h4 class="tsd-parameters-title">Parameters</h4>
28362907
<ul class="tsd-parameters">
28372908
<li>

‎docs/classes/amplitudeuserprovider.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
<head>
44
<meta charset="utf-8">
55
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6-
<title>AmplitudeUserProvider | Experiment JS Client Documentation - v1.2.0</title>
7-
<meta name="description" content="Documentation for Experiment JS Client Documentation - v1.2.0">
6+
<title>AmplitudeUserProvider | Experiment JS Client Documentation - v1.3.0</title>
7+
<meta name="description" content="Documentation for Experiment JS Client Documentation - v1.3.0">
88
<meta name="viewport" content="width=device-width, initial-scale=1">
99
<style type="text/css">:root {
1010
--color-background: #fdfdfd;
@@ -2674,7 +2674,7 @@
26742674
<div class="container">
26752675
<div class="table-wrap">
26762676
<div class="table-cell">
2677-
<strong><a href="../index.html">Experiment JS Client Documentation - v1.2.0</a></strong>
2677+
<strong><a href="../index.html">Experiment JS Client Documentation - v1.3.0</a></strong>
26782678
</div>
26792679
<div class="table-cell" id="tsd-widgets">
26802680
<div id="tsd-filter">

‎docs/classes/experimentclient.html‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
<head>
44
<meta charset="utf-8">
55
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6-
<title>ExperimentClient | Experiment JS Client Documentation - v1.2.0</title>
7-
<meta name="description" content="Documentation for Experiment JS Client Documentation - v1.2.0">
6+
<title>ExperimentClient | Experiment JS Client Documentation - v1.3.0</title>
7+
<meta name="description" content="Documentation for Experiment JS Client Documentation - v1.3.0">
88
<meta name="viewport" content="width=device-width, initial-scale=1">
99
<style type="text/css">:root {
1010
--color-background: #fdfdfd;
@@ -2674,7 +2674,7 @@
26742674
<div class="container">
26752675
<div class="table-wrap">
26762676
<div class="table-cell">
2677-
<strong><a href="../index.html">Experiment JS Client Documentation - v1.2.0</a></strong>
2677+
<strong><a href="../index.html">Experiment JS Client Documentation - v1.3.0</a></strong>
26782678
</div>
26792679
<div class="table-cell" id="tsd-widgets">
26802680
<div id="tsd-filter">
@@ -3068,9 +3068,9 @@ <h3>variant</h3>
30683068
</div>
30693069
<p>Access the variant from <a href="../enums/source.html">Source</a>, falling back on the given
30703070
fallback, then the configured fallbackVariant.</p>
3071-
<p>If an <a href="../interfaces/experimentanalyticsprovider.html">ExperimentAnalyticsProvider</a> is configured, this function will
3072-
call the provider with an {@link ExposureEvent}. The exposure event does
3073-
not count towards your event volume within Amplitude.</p>
3071+
<p>If an <a href="../interfaces/experimentanalyticsprovider.html">ExperimentAnalyticsProvider</a> is configured and trackExposure is
3072+
true, this function will call the provider with an {@link ExposureEvent}.
3073+
The exposure event does not count towards your event volume within Amplitude.</p>
30743074
<dl class="tsd-comment-tags">
30753075
<dt>see</dt>
30763076
<dd><p>ExperimentConfig</p>

‎docs/classes/stubexperimentclient.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
<head>
44
<meta charset="utf-8">
55
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6-
<title>StubExperimentClient | Experiment JS Client Documentation - v1.2.0</title>
7-
<meta name="description" content="Documentation for Experiment JS Client Documentation - v1.2.0">
6+
<title>StubExperimentClient | Experiment JS Client Documentation - v1.3.0</title>
7+
<meta name="description" content="Documentation for Experiment JS Client Documentation - v1.3.0">
88
<meta name="viewport" content="width=device-width, initial-scale=1">
99
<style type="text/css">:root {
1010
--color-background: #fdfdfd;
@@ -2674,7 +2674,7 @@
26742674
<div class="container">
26752675
<div class="table-wrap">
26762676
<div class="table-cell">
2677-
<strong><a href="../index.html">Experiment JS Client Documentation - v1.2.0</a></strong>
2677+
<strong><a href="../index.html">Experiment JS Client Documentation - v1.3.0</a></strong>
26782678
</div>
26792679
<div class="table-cell" id="tsd-widgets">
26802680
<div id="tsd-filter">

‎docs/enums/source.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
<head>
44
<meta charset="utf-8">
55
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6-
<title>Source | Experiment JS Client Documentation - v1.2.0</title>
7-
<meta name="description" content="Documentation for Experiment JS Client Documentation - v1.2.0">
6+
<title>Source | Experiment JS Client Documentation - v1.3.0</title>
7+
<meta name="description" content="Documentation for Experiment JS Client Documentation - v1.3.0">
88
<meta name="viewport" content="width=device-width, initial-scale=1">
99
<style type="text/css">:root {
1010
--color-background: #fdfdfd;
@@ -2674,7 +2674,7 @@
26742674
<div class="container">
26752675
<div class="table-wrap">
26762676
<div class="table-cell">
2677-
<strong><a href="../index.html">Experiment JS Client Documentation - v1.2.0</a></strong>
2677+
<strong><a href="../index.html">Experiment JS Client Documentation - v1.3.0</a></strong>
26782678
</div>
26792679
<div class="table-cell" id="tsd-widgets">
26802680
<div id="tsd-filter">

‎docs/index.html‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
<head>
44
<meta charset="utf-8">
55
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6-
<title>Experiment JS Client Documentation - v1.2.0 | Experiment JS Client Documentation - v1.2.0</title>
7-
<meta name="description" content="Documentation for Experiment JS Client Documentation - v1.2.0">
6+
<title>Experiment JS Client Documentation - v1.3.0 | Experiment JS Client Documentation - v1.3.0</title>
7+
<meta name="description" content="Documentation for Experiment JS Client Documentation - v1.3.0">
88
<meta name="viewport" content="width=device-width, initial-scale=1">
99
<style type="text/css">:root {
1010
--color-background: #fdfdfd;
@@ -2674,7 +2674,7 @@
26742674
<div class="container">
26752675
<div class="table-wrap">
26762676
<div class="table-cell">
2677-
<strong><a href="index.html">Experiment JS Client Documentation - v1.2.0</a></strong>
2677+
<strong><a href="index.html">Experiment JS Client Documentation - v1.3.0</a></strong>
26782678
</div>
26792679
<div class="table-cell" id="tsd-widgets">
26802680
<div id="tsd-filter">
@@ -2771,7 +2771,6 @@ <h3>Core Usage</h3>
27712771
<section class="tsd-index-section">
27722772
<h3>Configuration</h3>
27732773
<ul class="tsd-index-list">
2774-
<li class="tsd-kind-enum"><a href="enums/source.html" class="tsd-kind-icon">Source</a></li>
27752774
<li class="tsd-kind-interface"><a href="interfaces/experimentconfig.html" class="tsd-kind-icon">Experiment<wbr>Config</a></li>
27762775
</ul>
27772776
</section>
@@ -2803,6 +2802,12 @@ <h3>Provider</h3>
28032802
<li class="tsd-kind-interface"><a href="interfaces/experimentuserprovider.html" class="tsd-kind-icon">Experiment<wbr>User<wbr>Provider</a></li>
28042803
</ul>
28052804
</section>
2805+
<section class="tsd-index-section">
2806+
<h3>Source</h3>
2807+
<ul class="tsd-index-list">
2808+
<li class="tsd-kind-enum"><a href="enums/source.html" class="tsd-kind-icon">Source</a></li>
2809+
</ul>
2810+
</section>
28062811
</div>
28072812
</section>
28082813
</section>

‎docs/interfaces/client.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
<head>
44
<meta charset="utf-8">
55
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6-
<title>Client | Experiment JS Client Documentation - v1.2.0</title>
7-
<meta name="description" content="Documentation for Experiment JS Client Documentation - v1.2.0">
6+
<title>Client | Experiment JS Client Documentation - v1.3.0</title>
7+
<meta name="description" content="Documentation for Experiment JS Client Documentation - v1.3.0">
88
<meta name="viewport" content="width=device-width, initial-scale=1">
99
<style type="text/css">:root {
1010
--color-background: #fdfdfd;
@@ -2674,7 +2674,7 @@
26742674
<div class="container">
26752675
<div class="table-wrap">
26762676
<div class="table-cell">
2677-
<strong><a href="../index.html">Experiment JS Client Documentation - v1.2.0</a></strong>
2677+
<strong><a href="../index.html">Experiment JS Client Documentation - v1.3.0</a></strong>
26782678
</div>
26792679
<div class="table-cell" id="tsd-widgets">
26802680
<div id="tsd-filter">

0 commit comments

Comments
 (0)