chore(release): publish v1.8.0

amplitude · Dec 1, 2023 · 4660753 · 4660753
1 parent 5443a7a
commit 4660753
Show file tree

Hide file tree

Showing 28 changed files with 239 additions and 101 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [1.8.0](https://github.com/amplitude/experiment-node-server/compare/v1.7.8...v1.8.0) (2023-12-01)
+
+
+### Features
+
+* evaluation v2 ([#36](https://github.com/amplitude/experiment-node-server/issues/36)) ([5443a7a](https://github.com/amplitude/experiment-node-server/commit/5443a7a95cea956502e1722673b473591ed0d82b))
+
+
+
+
+
 ## [1.7.8](https://github.com/amplitude/experiment-node-server/compare/v1.7.7...v1.7.8) (2023-10-26)
 
 

diff --git a/docs/assets/search.js b/docs/assets/search.js
diff --git a/docs/classes/AmplitudeCookie.html b/docs/classes/AmplitudeCookie.html
@@ -1,18 +1,18 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AmplitudeCookie | Experiment JS Server Documentation - v1.7.8</title><meta name="description" content="Documentation for Experiment JS Server Documentation - v1.7.8"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
+<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AmplitudeCookie | Experiment JS Server Documentation - v1.8.0</title><meta name="description" content="Documentation for Experiment JS Server Documentation - v1.8.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
 <div class="tsd-toolbar-contents container">
 <div class="table-cell" id="tsd-search" data-base="..">
 <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
 <div class="field">
 <div id="tsd-toolbar-links"></div></div>
 <ul class="results">
 <li class="state loading">Preparing search index...</li>
-<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Experiment JS Server Documentation - v1.7.8</a></div>
+<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Experiment JS Server Documentation - v1.8.0</a></div>
 <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
 <div class="container container-main">
 <div class="col-8 col-content">
 <div class="tsd-page-title">
 <ul class="tsd-breadcrumb">
-<li><a href="../index.html">Experiment JS Server Documentation - v1.7.8</a></li>
+<li><a href="../index.html">Experiment JS Server Documentation - v1.8.0</a></li>
 <li><a href="AmplitudeCookie.html">AmplitudeCookie</a></li></ul>
 <h1>Class AmplitudeCookie</h1></div>
 <section class="tsd-panel tsd-comment">
@@ -128,7 +128,7 @@ <h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option
 <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
 <div class="tsd-accordion-details">
 <ul>
-<li><a href="../index.html">Experiment JS <wbr/>Server <wbr/>Documentation -<wbr/> v1.7.8</a>
+<li><a href="../index.html">Experiment JS <wbr/>Server <wbr/>Documentation -<wbr/> v1.8.0</a>
 <ul></ul></li></ul></div></details></nav>
 <nav class="tsd-navigation secondary menu-sticky">
 <ul>

diff --git a/docs/classes/ExperimentClient.html b/docs/classes/ExperimentClient.html
@@ -1,18 +1,18 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ExperimentClient | Experiment JS Server Documentation - v1.7.8</title><meta name="description" content="Documentation for Experiment JS Server Documentation - v1.7.8"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
+<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ExperimentClient | Experiment JS Server Documentation - v1.8.0</title><meta name="description" content="Documentation for Experiment JS Server Documentation - v1.8.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
 <div class="tsd-toolbar-contents container">
 <div class="table-cell" id="tsd-search" data-base="..">
 <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
 <div class="field">
 <div id="tsd-toolbar-links"></div></div>
 <ul class="results">
 <li class="state loading">Preparing search index...</li>
-<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Experiment JS Server Documentation - v1.7.8</a></div>
+<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Experiment JS Server Documentation - v1.8.0</a></div>
 <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
 <div class="container container-main">
 <div class="col-8 col-content">
 <div class="tsd-page-title">
 <ul class="tsd-breadcrumb">
-<li><a href="../index.html">Experiment JS Server Documentation - v1.7.8</a></li>
+<li><a href="../index.html">Experiment JS Server Documentation - v1.8.0</a></li>
 <li><a href="ExperimentClient.html">ExperimentClient</a></li></ul>
 <h1>Class ExperimentClient</h1></div>
 <section class="tsd-panel tsd-comment">
@@ -37,6 +37,7 @@ <h3 class="tsd-index-heading">Constructors</h3>
 <section class="tsd-index-section">
 <h3 class="tsd-index-heading">Methods</h3>
 <div class="tsd-index-list"><a href="ExperimentClient.html#fetch" class="tsd-index-link deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-2048-path"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)" id="icon-2048-text"></path></svg><span>fetch</span></a>
+<a href="ExperimentClient.html#fetchV2" class="tsd-index-link deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>fetch<wbr/>V2</span></a>
 </div></section></div></details></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Constructors</h2>
@@ -66,6 +67,8 @@ <h3 class="tsd-anchor-link"><span class="deprecated">fetch</span><a href="#fetch
 
 <h3>Returns</h3><p>The <a href="../types/Variants.html">Variants</a> for the user on success, empty
 <a href="../types/Variants.html">Variants</a> on error.</p>
+
+<h3>Deprecated</h3><p>use fetchV2 instead</p>
 </div>
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
@@ -79,7 +82,32 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../t
 <div class="tsd-comment tsd-typography"><p>The <a href="../types/FetchOptions.html">FetchOptions</a> for this specific fetch request.</p>
 </div></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/Variants.html" class="tsd-signature-type" data-tsd-kind="Type alias">Variants</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
-<p>Inherited from <a href="RemoteEvaluationClient.html">RemoteEvaluationClient</a>.<a href="RemoteEvaluationClient.html#fetch">fetch</a></p></aside></li></ul></section></section></div>
+<p>Inherited from <a href="RemoteEvaluationClient.html">RemoteEvaluationClient</a>.<a href="RemoteEvaluationClient.html#fetch">fetch</a></p></aside></li></ul></section>
+<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="fetchV2" class="tsd-anchor"></a>
+<h3 class="tsd-anchor-link"><span class="deprecated">fetch<wbr/>V2</span><a href="#fetchV2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
+<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
+<li class="tsd-signature tsd-anchor-link" id="fetchV2.fetchV2-1">fetch<wbr/>V2<span class="tsd-signature-symbol">(</span>user<span class="tsd-signature-symbol">: </span><a href="../types/ExperimentUser.html" class="tsd-signature-type" data-tsd-kind="Type alias">ExperimentUser</a>, options<span class="tsd-signature-symbol">?: </span><a href="../types/FetchOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">FetchOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../types/Variant.html" class="tsd-signature-type" data-tsd-kind="Type alias">Variant</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#fetchV2.fetchV2-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
+<li class="tsd-description">
+<div class="tsd-comment tsd-typography"><p>Fetch remote evaluated variants for a user. This function can
+automatically retry the request on failure (if configured), and will
+throw the original error if all retries fail.</p>
+<p>Unlike <a href="ExperimentClient.html#fetch">fetch</a>, this function returns a default variant object
+if the flag or experiment was evaluated, but the user was not assigned a
+variant (i.e. &#39;off&#39;).</p>
+</div>
+<div class="tsd-parameters">
+<h4 class="tsd-parameters-title">Parameters</h4>
+<ul class="tsd-parameter-list">
+<li>
+<h5>user: <a href="../types/ExperimentUser.html" class="tsd-signature-type" data-tsd-kind="Type alias">ExperimentUser</a></h5>
+<div class="tsd-comment tsd-typography"><p>The user to fetch variants for.</p>
+</div></li>
+<li>
+<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../types/FetchOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">FetchOptions</a></h5>
+<div class="tsd-comment tsd-typography"><p>Options to configure the fetch request.</p>
+</div></li></ul></div>
+<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../types/Variant.html" class="tsd-signature-type" data-tsd-kind="Type alias">Variant</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
+<p>Inherited from <a href="RemoteEvaluationClient.html">RemoteEvaluationClient</a>.<a href="RemoteEvaluationClient.html#fetchV2">fetchV2</a></p></aside></li></ul></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -97,12 +125,13 @@ <h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option
 <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
 <div class="tsd-accordion-details">
 <ul>
-<li><a href="../index.html">Experiment JS <wbr/>Server <wbr/>Documentation -<wbr/> v1.7.8</a>
+<li><a href="../index.html">Experiment JS <wbr/>Server <wbr/>Documentation -<wbr/> v1.8.0</a>
 <ul></ul></li></ul></div></details></nav>
 <nav class="tsd-navigation secondary menu-sticky">
 <ul>
 <li class="deprecated current tsd-kind-class"><a href="ExperimentClient.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg><span>Experiment<wbr/>Client</span></a>
 <ul>
 <li class="deprecated tsd-kind-constructor tsd-parent-kind-class"><a href="ExperimentClient.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-512-path"></use><use href="#icon-512-text"></use></svg>constructor</a></li>
-<li class="deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ExperimentClient.html#fetch" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>fetch</a></li></ul></li></ul></nav></div></div>
+<li class="deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ExperimentClient.html#fetch" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>fetch</a></li>
+<li class="deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ExperimentClient.html#fetchV2" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>fetch<wbr/>V2</a></li></ul></li></ul></nav></div></div>
 <div class="overlay"></div><script src="../assets/main.js"></script></body></html>