@uniformdev/context 18.18.1-alpha.12 → 18.19.0

package/dist/api/api.js

@@ -240,11 +240,13 @@ var _AggregateClient = class extends ApiClient {
   constructor(options) {
     super(options);
   }
+  /** Fetches all aggregates for a project */
   async get(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(__privateGet(_AggregateClient, _url), { ...options, projectId });
     return await this.apiClient(fetchUri);
   }
+  /** Updates or creates (based on id) an Aggregate */
   async upsert(body) {
     const fetchUri = this.createUrl(__privateGet(_AggregateClient, _url));
     await this.apiClient(fetchUri, {
@@ -253,6 +255,7 @@ var _AggregateClient = class extends ApiClient {
       expectNoContent: true
     });
   }
+  /** Deletes an Aggregate */
   async remove(body) {
     const fetchUri = this.createUrl(__privateGet(_AggregateClient, _url));
     await this.apiClient(fetchUri, {
@@ -317,6 +320,7 @@ var _DimensionClient = class extends ApiClient {
   constructor(options) {
     super(options);
   }
+  /** Fetches the known score dimensions for a project */
   async get(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(__privateGet(_DimensionClient, _url2), { ...options, projectId });
@@ -343,11 +347,13 @@ var _EnrichmentClient = class extends ApiClient {
   constructor(options) {
     super(options);
   }
+  /** Fetches all enrichments and values for a project, grouped by category */
   async get(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(__privateGet(_EnrichmentClient, _url3), { ...options, projectId });
     return await this.apiClient(fetchUri);
   }
+  /** Updates or creates (based on id) an enrichment category */
   async upsertCategory(body) {
     const fetchUri = this.createUrl(__privateGet(_EnrichmentClient, _url3));
     await this.apiClient(fetchUri, {
@@ -356,6 +362,7 @@ var _EnrichmentClient = class extends ApiClient {
       expectNoContent: true
     });
   }
+  /** Deletes an enrichment category */
   async removeCategory(body) {
     const fetchUri = this.createUrl(__privateGet(_EnrichmentClient, _url3));
     await this.apiClient(fetchUri, {
@@ -364,6 +371,7 @@ var _EnrichmentClient = class extends ApiClient {
       expectNoContent: true
     });
   }
+  /** Updates or creates (based on id) an enrichment value within an enrichment category */
   async upsertValue(body) {
     const fetchUri = this.createUrl(__privateGet(_EnrichmentClient, _valueUrl));
     await this.apiClient(fetchUri, {
@@ -372,6 +380,7 @@ var _EnrichmentClient = class extends ApiClient {
       expectNoContent: true
     });
   }
+  /** Deletes an enrichment value within an enrichment category. The category is left alone. */
   async removeValue(body) {
     const fetchUri = this.createUrl(__privateGet(_EnrichmentClient, _valueUrl));
     await this.apiClient(fetchUri, {
@@ -403,11 +412,13 @@ var _ManifestClient = class extends ApiClient {
   constructor(options) {
     super(options);
   }
+  /** Fetches the Context manifest for a project */
   async get(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(__privateGet(_ManifestClient, _url4), { ...options, projectId });
     return await this.apiClient(fetchUri);
   }
+  /** Publishes the Context manifest for a project */
   async publish() {
     const { projectId } = this.options;
     const fetchUri = this.createUrl("/api/v1/publish", { siteId: projectId });
@@ -437,11 +448,13 @@ var _QuirkClient = class extends ApiClient {
   constructor(options) {
     super(options);
   }
+  /** Fetches all Quirks for a project */
   async get(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(__privateGet(_QuirkClient, _url5), { ...options, projectId });
     return await this.apiClient(fetchUri);
   }
+  /** Updates or creates (based on id) a Quirk */
   async upsert(body) {
     const fetchUri = this.createUrl(__privateGet(_QuirkClient, _url5));
     await this.apiClient(fetchUri, {
@@ -450,6 +463,7 @@ var _QuirkClient = class extends ApiClient {
       expectNoContent: true
     });
   }
+  /** Deletes a Quirk */
   async remove(body) {
     const fetchUri = this.createUrl(__privateGet(_QuirkClient, _url5));
     await this.apiClient(fetchUri, {
@@ -479,11 +493,13 @@ var _SignalClient = class extends ApiClient {
   constructor(options) {
     super(options);
   }
+  /** Fetches all Signals for a project */
   async get(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(__privateGet(_SignalClient, _url6), { ...options, projectId });
     return await this.apiClient(fetchUri);
   }
+  /** Updates or creates (based on id) a Signal */
   async upsert(body) {
     const fetchUri = this.createUrl(__privateGet(_SignalClient, _url6));
     await this.apiClient(fetchUri, {
@@ -492,6 +508,7 @@ var _SignalClient = class extends ApiClient {
       expectNoContent: true
     });
   }
+  /** Deletes a Signal */
   async remove(body) {
     const fetchUri = this.createUrl(__privateGet(_SignalClient, _url6));
     await this.apiClient(fetchUri, {
@@ -521,11 +538,13 @@ var _TestClient = class extends ApiClient {
   constructor(options) {
     super(options);
   }
+  /** Fetches all Tests for a project */
   async get(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(__privateGet(_TestClient, _url7), { ...options, projectId });
     return await this.apiClient(fetchUri);
   }
+  /** Updates or creates (based on id) a Test */
   async upsert(body) {
     const fetchUri = this.createUrl(__privateGet(_TestClient, _url7));
     await this.apiClient(fetchUri, {
@@ -534,6 +553,7 @@ var _TestClient = class extends ApiClient {
       expectNoContent: true
     });
   }
+  /** Deletes a Test */
   async remove(body) {
     const fetchUri = this.createUrl(__privateGet(_TestClient, _url7));
     await this.apiClient(fetchUri, {

package/dist/api/api.mjs

@@ -186,11 +186,13 @@ var _AggregateClient = class extends ApiClient {
   constructor(options) {
     super(options);
   }
+  /** Fetches all aggregates for a project */
   async get(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(__privateGet(_AggregateClient, _url), { ...options, projectId });
     return await this.apiClient(fetchUri);
   }
+  /** Updates or creates (based on id) an Aggregate */
   async upsert(body) {
     const fetchUri = this.createUrl(__privateGet(_AggregateClient, _url));
     await this.apiClient(fetchUri, {
@@ -199,6 +201,7 @@ var _AggregateClient = class extends ApiClient {
       expectNoContent: true
     });
   }
+  /** Deletes an Aggregate */
   async remove(body) {
     const fetchUri = this.createUrl(__privateGet(_AggregateClient, _url));
     await this.apiClient(fetchUri, {
@@ -263,6 +266,7 @@ var _DimensionClient = class extends ApiClient {
   constructor(options) {
     super(options);
   }
+  /** Fetches the known score dimensions for a project */
   async get(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(__privateGet(_DimensionClient, _url2), { ...options, projectId });
@@ -289,11 +293,13 @@ var _EnrichmentClient = class extends ApiClient {
   constructor(options) {
     super(options);
   }
+  /** Fetches all enrichments and values for a project, grouped by category */
   async get(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(__privateGet(_EnrichmentClient, _url3), { ...options, projectId });
     return await this.apiClient(fetchUri);
   }
+  /** Updates or creates (based on id) an enrichment category */
   async upsertCategory(body) {
     const fetchUri = this.createUrl(__privateGet(_EnrichmentClient, _url3));
     await this.apiClient(fetchUri, {
@@ -302,6 +308,7 @@ var _EnrichmentClient = class extends ApiClient {
       expectNoContent: true
     });
   }
+  /** Deletes an enrichment category */
   async removeCategory(body) {
     const fetchUri = this.createUrl(__privateGet(_EnrichmentClient, _url3));
     await this.apiClient(fetchUri, {
@@ -310,6 +317,7 @@ var _EnrichmentClient = class extends ApiClient {
       expectNoContent: true
     });
   }
+  /** Updates or creates (based on id) an enrichment value within an enrichment category */
   async upsertValue(body) {
     const fetchUri = this.createUrl(__privateGet(_EnrichmentClient, _valueUrl));
     await this.apiClient(fetchUri, {
@@ -318,6 +326,7 @@ var _EnrichmentClient = class extends ApiClient {
       expectNoContent: true
     });
   }
+  /** Deletes an enrichment value within an enrichment category. The category is left alone. */
   async removeValue(body) {
     const fetchUri = this.createUrl(__privateGet(_EnrichmentClient, _valueUrl));
     await this.apiClient(fetchUri, {
@@ -349,11 +358,13 @@ var _ManifestClient = class extends ApiClient {
   constructor(options) {
     super(options);
   }
+  /** Fetches the Context manifest for a project */
   async get(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(__privateGet(_ManifestClient, _url4), { ...options, projectId });
     return await this.apiClient(fetchUri);
   }
+  /** Publishes the Context manifest for a project */
   async publish() {
     const { projectId } = this.options;
     const fetchUri = this.createUrl("/api/v1/publish", { siteId: projectId });
@@ -383,11 +394,13 @@ var _QuirkClient = class extends ApiClient {
   constructor(options) {
     super(options);
   }
+  /** Fetches all Quirks for a project */
   async get(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(__privateGet(_QuirkClient, _url5), { ...options, projectId });
     return await this.apiClient(fetchUri);
   }
+  /** Updates or creates (based on id) a Quirk */
   async upsert(body) {
     const fetchUri = this.createUrl(__privateGet(_QuirkClient, _url5));
     await this.apiClient(fetchUri, {
@@ -396,6 +409,7 @@ var _QuirkClient = class extends ApiClient {
       expectNoContent: true
     });
   }
+  /** Deletes a Quirk */
   async remove(body) {
     const fetchUri = this.createUrl(__privateGet(_QuirkClient, _url5));
     await this.apiClient(fetchUri, {
@@ -425,11 +439,13 @@ var _SignalClient = class extends ApiClient {
   constructor(options) {
     super(options);
   }
+  /** Fetches all Signals for a project */
   async get(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(__privateGet(_SignalClient, _url6), { ...options, projectId });
     return await this.apiClient(fetchUri);
   }
+  /** Updates or creates (based on id) a Signal */
   async upsert(body) {
     const fetchUri = this.createUrl(__privateGet(_SignalClient, _url6));
     await this.apiClient(fetchUri, {
@@ -438,6 +454,7 @@ var _SignalClient = class extends ApiClient {
       expectNoContent: true
     });
   }
+  /** Deletes a Signal */
   async remove(body) {
     const fetchUri = this.createUrl(__privateGet(_SignalClient, _url6));
     await this.apiClient(fetchUri, {
@@ -467,11 +484,13 @@ var _TestClient = class extends ApiClient {
   constructor(options) {
     super(options);
   }
+  /** Fetches all Tests for a project */
   async get(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(__privateGet(_TestClient, _url7), { ...options, projectId });
     return await this.apiClient(fetchUri);
   }
+  /** Updates or creates (based on id) a Test */
   async upsert(body) {
     const fetchUri = this.createUrl(__privateGet(_TestClient, _url7));
     await this.apiClient(fetchUri, {
@@ -480,6 +499,7 @@ var _TestClient = class extends ApiClient {
       expectNoContent: true
     });
   }
+  /** Deletes a Test */
   async remove(body) {
     const fetchUri = this.createUrl(__privateGet(_TestClient, _url7));
     await this.apiClient(fetchUri, {

package/dist/index.esm.js

@@ -87,6 +87,7 @@ var SignalInstance = class {
     __privateSet(this, _evaluator, evaluator);
     __privateSet(this, _onLogMessage, onLogMessage);
   }
+  /** Computes storage update commands to take based on a state update and the signal's criteria */
   computeSignal(update, commands) {
     const isAtCap = update.scores[this.signal.id] >= this.signal.cap;
     if (isAtCap && this.signal.dur !== "t") {
@@ -128,6 +129,7 @@ var ManifestInstance = class {
   constructor({
     manifest,
     evaluator = new GroupCriteriaEvaluator({}),
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
     onLogMessage = () => {
     }
   }) {
@@ -168,6 +170,9 @@ var ManifestInstance = class {
     }
     return commands;
   }
+  /**
+   * Computes aggregated scores based on other dimensions
+   */
   computeAggregateDimensions(primitiveScores) {
     var _a, _b;
     return computeAggregateDimensions(primitiveScores, (_b = (_a = __privateGet(this, _mf).pz) == null ? void 0 : _a.agg) != null ? _b : {});
@@ -709,6 +714,9 @@ var TransitionDataStore = class {
     __privateAdd(this, _data, void 0);
     __privateAdd(this, _initialData, void 0);
     __privateAdd(this, _mitt, mitt());
+    /**
+     * Subscribe to events from the transition storage
+     */
     __publicField(this, "events", {
       on: __privateGet(this, _mitt).on,
       off: __privateGet(this, _mitt).off
@@ -724,10 +732,20 @@ var TransitionDataStore = class {
   get initialData() {
     return __privateGet(this, _initialData);
   }
+  /**
+   * Updates data in the transition storage.
+   * @param commands Commands to execute against existing stored value (event based stores)
+   * @param computedValue Pre-computed new value against existing value (object based stores)
+   * @returns Resolved promise when the data has been updated
+   */
   updateData(commands, computedValue) {
     __privateSet(this, _data, computedValue);
     return this.handleUpdateData(commands, computedValue);
   }
+  /**
+   * Deletes a visitor's stored data, forgetting them.
+   * @param fromAllDevices - false: logout from this device ID. true: forget all data about the visitor and their identity.
+   */
   async delete(fromAllDevices) {
     __privateSet(this, _data, void 0);
     await this.handleDelete(fromAllDevices);
@@ -739,6 +757,12 @@ var TransitionDataStore = class {
     __privateSet(this, _data, newScores);
     __privateGet(this, _mitt).emit("dataUpdatedAsync", newScores);
   }
+  /**
+   * When we load on the client side after a server side rendering has occurred (server to client transition),
+   * we can have a page script (ID: __UNIFORM_DATA__) that contains the computed visitor data from the SSR/edge render.
+   * This data is injected into the first render to allow score syncing and the server to request commands be applied
+   * to the client side data store.
+   */
   getClientTransitionState() {
     if (typeof document === "undefined") {
       return;
@@ -833,6 +857,7 @@ function parseScoreCookie(cookieValue) {
     return;
   const [abTestData, sessionScores, visitorScores] = types;
   return {
+    // this is true since we're reading a cookie, which wouldn't exist if consent wasn't given
     consent: true,
     sessionScores: decodeCookieType(parseCookieType(sessionScores)),
     scores: decodeCookieType(parseCookieType(visitorScores)),
@@ -1049,16 +1074,30 @@ var STORAGE_KEY = "ufvisitor";
 var _mitt2, _persist, _visitTimeout, _options, _currentData, currentData_get, _replaceData, replaceData_fn, _setVisitTimeout, setVisitTimeout_fn, _isExpired, isExpired_fn, _handleCaps, handleCaps_fn, _defaultData, defaultData_fn;
 var VisitorDataStore = class {
   constructor(options) {
+    /** Gets the current client-side storage data. This property is always up to date. */
     __privateAdd(this, _currentData);
+    /**
+     * IMPORTANT: This function mutates the input data. This is done,
+     * because all the sources that call it have either already spread or cloned
+     * the data, so we can safely mutate it for better perf.
+     */
     __privateAdd(this, _replaceData);
     __privateAdd(this, _setVisitTimeout);
     __privateAdd(this, _isExpired);
+    /**
+     * IMPORTANT: This function mutates the input data. This is done,
+     * because all the sources that call it have either already spread or cloned
+     * the data, so we can safely mutate it for better perf.
+     */
     __privateAdd(this, _handleCaps);
     __privateAdd(this, _defaultData);
     __privateAdd(this, _mitt2, mitt2());
     __privateAdd(this, _persist, new LocalStorage());
     __privateAdd(this, _visitTimeout, void 0);
     __privateAdd(this, _options, void 0);
+    /**
+     * Subscribe to events from storage
+     */
     __publicField(this, "events", {
       on: __privateGet(this, _mitt2).on,
       off: __privateGet(this, _mitt2).off
@@ -1080,10 +1119,16 @@ var VisitorDataStore = class {
       });
       const transitionData = options.transitionStore.data;
       if (transitionData) {
-        __privateMethod(this, _replaceData, replaceData_fn).call(this, { ...__privateGet(this, _currentData, currentData_get).visitorData, ...transitionData }, true);
+        __privateMethod(this, _replaceData, replaceData_fn).call(
+          this,
+          // we know _currentData is not empty because we inited it above if it was
+          { ...__privateGet(this, _currentData, currentData_get).visitorData, ...transitionData },
+          true
+        );
       }
     }
   }
+  /** Gets the current visitor data. This property is always up to date. */
   get data() {
     var _a, _b;
     const data = __privateGet(this, _currentData, currentData_get);
@@ -1101,6 +1146,7 @@ var VisitorDataStore = class {
   get options() {
     return __privateGet(this, _options);
   }
+  /** Push data update command(s) into the visitor data */
   async updateData(commands) {
     var _a, _b, _c, _d;
     if (commands.length === 0) {
@@ -1114,6 +1160,11 @@ var VisitorDataStore = class {
     __privateMethod(this, _replaceData, replaceData_fn).call(this, newData);
     await ((_d = __privateGet(this, _options).transitionStore) == null ? void 0 : _d.updateData(commands, __privateGet(this, _currentData, currentData_get).visitorData));
   }
+  /**
+   * Deletes visitor data (forgetting them)
+   * In most cases you should use forget() on the Context instead of this function, which also clears the Context state.
+   * @param fromAllDevices for an identified user, whether to delete all their data (for the entire account) - true, or data for this device (sign out) - false
+   */
   async delete(fromAllDevices) {
     var _a, _b, _c, _d, _e;
     (_b = (_a = __privateGet(this, _options)).onLogMessage) == null ? void 0 : _b.call(_a, ["info", 103, "GROUP", fromAllDevices]);
@@ -1243,6 +1294,9 @@ var Context = class {
     __privateAdd(this, _state, void 0);
     __privateAdd(this, _pzCache, {});
     __privateAdd(this, _mitt3, mitt3());
+    /**
+     * Subscribe to events
+     */
     __publicField(this, "events", {
       on: __privateGet(this, _mitt3).on,
       off: __privateGet(this, _mitt3).off
@@ -1308,13 +1362,24 @@ var Context = class {
       __privateGet(this, _mitt3).emit("log", ["info", 1, "ENDGROUP"]);
     }
   }
+  /** Gets the current visitor's dimension score vector. */
   get scores() {
     return __privateGet(this, _scores);
   }
+  /** Gets the current visitor's quirks values. */
   get quirks() {
     var _a, _b;
     return (_b = (_a = __privateGet(this, _serverTransitionState)) == null ? void 0 : _a.quirks) != null ? _b : this.storage.data.quirks;
   }
+  /**
+   * Updates the Context with new data of any sort, such as
+   * new URLs, cookies, quirks, and enrichments.
+   *
+   * Only properties that are set in the data parameter will be updated.
+   * Properties that do not result in a changed state,
+   * i.e. pushing the same URL or cookies as before,
+   * will NOT result in a recomputation of signal state.
+   */
   async update(newData) {
     var _a, _b, _c;
     const commands = [];
@@ -1353,6 +1418,8 @@ var Context = class {
         "GROUP",
         {
           ...newData,
+          // need to convert url to string so it can be json serialized
+          // to go over postMessage to chrome extension
           url: (_c = newData.url) == null ? void 0 : _c.toString()
         }
       ]);
@@ -1386,6 +1453,9 @@ var Context = class {
           state: newData,
           previousState: __privateGet(this, _state),
           visitor: this.storage.data,
+          // re-compute using scores from storage instead of the current scores since
+          // server transition scores might have adjusted values already integrated into them,
+          // which causes issues when you are near limits.
           scores: __privateGet(this, _serverTransitionState) ? __privateMethod(this, _calculateScores, calculateScores_fn).call(this, this.storage.data) : __privateGet(this, _scores)
         })
       );
@@ -1410,6 +1480,7 @@ var Context = class {
       __privateGet(this, _mitt3).emit("log", ["info", 2, "ENDGROUP"]);
     }
   }
+  /** use test() instead */
   getTestVariantId(testName) {
     var _a, _b, _c, _d;
     const definition = this.manifest.getTest(testName);
@@ -1419,6 +1490,7 @@ var Context = class {
     }
     return (_d = (_c = definition.wv) != null ? _c : (_b = (_a = __privateGet(this, _serverTransitionState)) == null ? void 0 : _a.tests) == null ? void 0 : _b[testName]) != null ? _d : this.storage.data.tests[testName];
   }
+  /** use test() instead */
   setTestVariantId(testName, variantId) {
     this.storage.updateData([
       {
@@ -1430,9 +1502,14 @@ var Context = class {
       }
     ]);
   }
+  /**
+   * Writes a message to the Context log sink.
+   * Used by Uniform internal SDK; not intended for public use.
+   */
   log(...message) {
     __privateGet(this, _mitt3).emit("log", message);
   }
+  /** Executes an A/B test with a given set of variants, showing the visitor's assigned variant (or selecting one to assign, if none is set yet) */
   test(options) {
     var _a, _b;
     const value = testVariations({
@@ -1447,6 +1524,7 @@ var Context = class {
     });
     return value;
   }
+  /** Executes a personalized placement with a given set of variants */
   personalize(options) {
     const value = personalizeVariations({
       ...options,
@@ -1470,10 +1548,19 @@ var Context = class {
     __privateGet(this, _pzCache)[options.name] = eventData.variantIds;
     return value;
   }
+  /**
+   * Forgets the visitor's data and resets the Context to its initial state.
+   * @param fromAllDevices for an identified user, whether to delete all their data (for the entire account) - true, or data for this device (sign out) - false
+   */
   async forget(fromAllDevices) {
     __privateSet(this, _state, {});
     await this.storage.delete(fromAllDevices);
   }
+  /**
+   * Computes server to client transition state.
+   *
+   * Removes state from server-to-client if it came in initial state (cookies) to avoid double tracking on the client.
+   */
   getServerToClientTransitionState() {
     const transitionState = {
       quirks: this.storage.data.quirks,
@@ -1676,11 +1763,13 @@ import rfdc3 from "rfdc";
 
 // src/logging/messageContent.ts
 var messageContent = {
+  // CONTEXT
   1: () => ["context", "initializing Uniform Context"],
   2: (update) => ["context", "received update()", update],
   3: (scores) => ["context", "new score vector", scores],
   4: (quirks) => ["context", "updated quirks", quirks],
   5: (enrichment) => ["context", "ignored enrichment update for unknown enrichment category", enrichment.cat],
+  // STORAGE
   101: (commands) => ["storage", "received update commands", commands],
   102: (data) => ["storage", "data was updated", data],
   103: (fromAllDevices) => [
@@ -1700,6 +1789,7 @@ var messageContent = {
   ],
   131: () => ["storage", "server to client transition data was discarded"],
   140: (decayMessage) => ["storage", `score decay was applied: ${decayMessage}`],
+  // SIGNAL EVAL
   200: () => ["signals", "evaluating signals"],
   201: (signal) => ["signals", `evaluating signal ${signal.id} (${signal.dur})`],
   202: (group) => ["signals", group.op === "|" ? "OR" : "AND"],
@@ -1711,10 +1801,12 @@ var messageContent = {
     "signals",
     `group result: ${result.result} [${result.changed ? "CHANGED" : "unchanged"}]`
   ],
+  // PERSONALIZATION
   300: (placement) => ["personalization", `executing personalization '${placement.name}'`],
   301: ({ id, op }) => ["personalization", `testing variation ${id} (${op === "|" ? "OR" : "AND"})`],
   302: ({ matched, description }) => ["personalization", `${description} is ${matched}`],
   303: (selected) => ["personalization", selected ? "selected variation" : "did not select variation"],
+  // TESTING
   400: (name) => ["testing", `executing A/B test '${name}'`],
   401: (testName) => ["testing", `${testName} is not registered in the manifest; it will not be run.`],
   402: ({ missingVariant, variants }) => [
@@ -1725,6 +1817,7 @@ var messageContent = {
   ],
   403: (variant) => ["testing", `assigned new test variant '${variant}'`],
   404: (variant) => ["testing", `displaying variation '${variant}'`],
+  // GTAG
   700: () => [
     "gtag",
     "gtag is not defined, skipping analytics event emission. Ensure you have added the gtag script to your page."

package/dist/index.js

@@ -19,6 +19,10 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
   isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
   mod
 ));
@@ -151,6 +155,7 @@ var SignalInstance = class {
     __privateSet(this, _evaluator, evaluator);
     __privateSet(this, _onLogMessage, onLogMessage);
   }
+  /** Computes storage update commands to take based on a state update and the signal's criteria */
   computeSignal(update, commands) {
     const isAtCap = update.scores[this.signal.id] >= this.signal.cap;
     if (isAtCap && this.signal.dur !== "t") {
@@ -192,6 +197,7 @@ var ManifestInstance = class {
   constructor({
     manifest,
     evaluator = new GroupCriteriaEvaluator({}),
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
     onLogMessage = () => {
     }
   }) {
@@ -232,6 +238,9 @@ var ManifestInstance = class {
     }
     return commands;
   }
+  /**
+   * Computes aggregated scores based on other dimensions
+   */
   computeAggregateDimensions(primitiveScores) {
     var _a, _b;
     return computeAggregateDimensions(primitiveScores, (_b = (_a = __privateGet(this, _mf).pz) == null ? void 0 : _a.agg) != null ? _b : {});
@@ -773,6 +782,9 @@ var TransitionDataStore = class {
     __privateAdd(this, _data, void 0);
     __privateAdd(this, _initialData, void 0);
     __privateAdd(this, _mitt, (0, import_mitt.default)());
+    /**
+     * Subscribe to events from the transition storage
+     */
     __publicField(this, "events", {
       on: __privateGet(this, _mitt).on,
       off: __privateGet(this, _mitt).off
@@ -788,10 +800,20 @@ var TransitionDataStore = class {
   get initialData() {
     return __privateGet(this, _initialData);
   }
+  /**
+   * Updates data in the transition storage.
+   * @param commands Commands to execute against existing stored value (event based stores)
+   * @param computedValue Pre-computed new value against existing value (object based stores)
+   * @returns Resolved promise when the data has been updated
+   */
   updateData(commands, computedValue) {
     __privateSet(this, _data, computedValue);
     return this.handleUpdateData(commands, computedValue);
   }
+  /**
+   * Deletes a visitor's stored data, forgetting them.
+   * @param fromAllDevices - false: logout from this device ID. true: forget all data about the visitor and their identity.
+   */
   async delete(fromAllDevices) {
     __privateSet(this, _data, void 0);
     await this.handleDelete(fromAllDevices);
@@ -803,6 +825,12 @@ var TransitionDataStore = class {
     __privateSet(this, _data, newScores);
     __privateGet(this, _mitt).emit("dataUpdatedAsync", newScores);
   }
+  /**
+   * When we load on the client side after a server side rendering has occurred (server to client transition),
+   * we can have a page script (ID: __UNIFORM_DATA__) that contains the computed visitor data from the SSR/edge render.
+   * This data is injected into the first render to allow score syncing and the server to request commands be applied
+   * to the client side data store.
+   */
   getClientTransitionState() {
     if (typeof document === "undefined") {
       return;
@@ -897,6 +925,7 @@ function parseScoreCookie(cookieValue) {
     return;
   const [abTestData, sessionScores, visitorScores] = types;
   return {
+    // this is true since we're reading a cookie, which wouldn't exist if consent wasn't given
     consent: true,
     sessionScores: decodeCookieType(parseCookieType(sessionScores)),
     scores: decodeCookieType(parseCookieType(visitorScores)),
@@ -1113,16 +1142,30 @@ var STORAGE_KEY = "ufvisitor";
 var _mitt2, _persist, _visitTimeout, _options, _currentData, currentData_get, _replaceData, replaceData_fn, _setVisitTimeout, setVisitTimeout_fn, _isExpired, isExpired_fn, _handleCaps, handleCaps_fn, _defaultData, defaultData_fn;
 var VisitorDataStore = class {
   constructor(options) {
+    /** Gets the current client-side storage data. This property is always up to date. */
     __privateAdd(this, _currentData);
+    /**
+     * IMPORTANT: This function mutates the input data. This is done,
+     * because all the sources that call it have either already spread or cloned
+     * the data, so we can safely mutate it for better perf.
+     */
     __privateAdd(this, _replaceData);
     __privateAdd(this, _setVisitTimeout);
     __privateAdd(this, _isExpired);
+    /**
+     * IMPORTANT: This function mutates the input data. This is done,
+     * because all the sources that call it have either already spread or cloned
+     * the data, so we can safely mutate it for better perf.
+     */
     __privateAdd(this, _handleCaps);
     __privateAdd(this, _defaultData);
     __privateAdd(this, _mitt2, (0, import_mitt2.default)());
     __privateAdd(this, _persist, new LocalStorage());
     __privateAdd(this, _visitTimeout, void 0);
     __privateAdd(this, _options, void 0);
+    /**
+     * Subscribe to events from storage
+     */
     __publicField(this, "events", {
       on: __privateGet(this, _mitt2).on,
       off: __privateGet(this, _mitt2).off
@@ -1144,10 +1187,16 @@ var VisitorDataStore = class {
       });
       const transitionData = options.transitionStore.data;
       if (transitionData) {
-        __privateMethod(this, _replaceData, replaceData_fn).call(this, { ...__privateGet(this, _currentData, currentData_get).visitorData, ...transitionData }, true);
+        __privateMethod(this, _replaceData, replaceData_fn).call(
+          this,
+          // we know _currentData is not empty because we inited it above if it was
+          { ...__privateGet(this, _currentData, currentData_get).visitorData, ...transitionData },
+          true
+        );
       }
     }
   }
+  /** Gets the current visitor data. This property is always up to date. */
   get data() {
     var _a, _b;
     const data = __privateGet(this, _currentData, currentData_get);
@@ -1165,6 +1214,7 @@ var VisitorDataStore = class {
   get options() {
     return __privateGet(this, _options);
   }
+  /** Push data update command(s) into the visitor data */
   async updateData(commands) {
     var _a, _b, _c, _d;
     if (commands.length === 0) {
@@ -1178,6 +1228,11 @@ var VisitorDataStore = class {
     __privateMethod(this, _replaceData, replaceData_fn).call(this, newData);
     await ((_d = __privateGet(this, _options).transitionStore) == null ? void 0 : _d.updateData(commands, __privateGet(this, _currentData, currentData_get).visitorData));
   }
+  /**
+   * Deletes visitor data (forgetting them)
+   * In most cases you should use forget() on the Context instead of this function, which also clears the Context state.
+   * @param fromAllDevices for an identified user, whether to delete all their data (for the entire account) - true, or data for this device (sign out) - false
+   */
   async delete(fromAllDevices) {
     var _a, _b, _c, _d, _e;
     (_b = (_a = __privateGet(this, _options)).onLogMessage) == null ? void 0 : _b.call(_a, ["info", 103, "GROUP", fromAllDevices]);
@@ -1307,6 +1362,9 @@ var Context = class {
     __privateAdd(this, _state, void 0);
     __privateAdd(this, _pzCache, {});
     __privateAdd(this, _mitt3, (0, import_mitt3.default)());
+    /**
+     * Subscribe to events
+     */
     __publicField(this, "events", {
       on: __privateGet(this, _mitt3).on,
       off: __privateGet(this, _mitt3).off
@@ -1372,13 +1430,24 @@ var Context = class {
       __privateGet(this, _mitt3).emit("log", ["info", 1, "ENDGROUP"]);
     }
   }
+  /** Gets the current visitor's dimension score vector. */
   get scores() {
     return __privateGet(this, _scores);
   }
+  /** Gets the current visitor's quirks values. */
   get quirks() {
     var _a, _b;
     return (_b = (_a = __privateGet(this, _serverTransitionState)) == null ? void 0 : _a.quirks) != null ? _b : this.storage.data.quirks;
   }
+  /**
+   * Updates the Context with new data of any sort, such as
+   * new URLs, cookies, quirks, and enrichments.
+   *
+   * Only properties that are set in the data parameter will be updated.
+   * Properties that do not result in a changed state,
+   * i.e. pushing the same URL or cookies as before,
+   * will NOT result in a recomputation of signal state.
+   */
   async update(newData) {
     var _a, _b, _c;
     const commands = [];
@@ -1417,6 +1486,8 @@ var Context = class {
         "GROUP",
         {
           ...newData,
+          // need to convert url to string so it can be json serialized
+          // to go over postMessage to chrome extension
           url: (_c = newData.url) == null ? void 0 : _c.toString()
         }
       ]);
@@ -1450,6 +1521,9 @@ var Context = class {
           state: newData,
           previousState: __privateGet(this, _state),
           visitor: this.storage.data,
+          // re-compute using scores from storage instead of the current scores since
+          // server transition scores might have adjusted values already integrated into them,
+          // which causes issues when you are near limits.
           scores: __privateGet(this, _serverTransitionState) ? __privateMethod(this, _calculateScores, calculateScores_fn).call(this, this.storage.data) : __privateGet(this, _scores)
         })
       );
@@ -1474,6 +1548,7 @@ var Context = class {
       __privateGet(this, _mitt3).emit("log", ["info", 2, "ENDGROUP"]);
     }
   }
+  /** use test() instead */
   getTestVariantId(testName) {
     var _a, _b, _c, _d;
     const definition = this.manifest.getTest(testName);
@@ -1483,6 +1558,7 @@ var Context = class {
     }
     return (_d = (_c = definition.wv) != null ? _c : (_b = (_a = __privateGet(this, _serverTransitionState)) == null ? void 0 : _a.tests) == null ? void 0 : _b[testName]) != null ? _d : this.storage.data.tests[testName];
   }
+  /** use test() instead */
   setTestVariantId(testName, variantId) {
     this.storage.updateData([
       {
@@ -1494,9 +1570,14 @@ var Context = class {
       }
     ]);
   }
+  /**
+   * Writes a message to the Context log sink.
+   * Used by Uniform internal SDK; not intended for public use.
+   */
   log(...message) {
     __privateGet(this, _mitt3).emit("log", message);
   }
+  /** Executes an A/B test with a given set of variants, showing the visitor's assigned variant (or selecting one to assign, if none is set yet) */
   test(options) {
     var _a, _b;
     const value = testVariations({
@@ -1511,6 +1592,7 @@ var Context = class {
     });
     return value;
   }
+  /** Executes a personalized placement with a given set of variants */
   personalize(options) {
     const value = personalizeVariations({
       ...options,
@@ -1534,10 +1616,19 @@ var Context = class {
     __privateGet(this, _pzCache)[options.name] = eventData.variantIds;
     return value;
   }
+  /**
+   * Forgets the visitor's data and resets the Context to its initial state.
+   * @param fromAllDevices for an identified user, whether to delete all their data (for the entire account) - true, or data for this device (sign out) - false
+   */
   async forget(fromAllDevices) {
     __privateSet(this, _state, {});
     await this.storage.delete(fromAllDevices);
   }
+  /**
+   * Computes server to client transition state.
+   *
+   * Removes state from server-to-client if it came in initial state (cookies) to avoid double tracking on the client.
+   */
   getServerToClientTransitionState() {
     const transitionState = {
       quirks: this.storage.data.quirks,
@@ -1740,11 +1831,13 @@ var import_rfdc3 = __toESM(require("rfdc"));
 
 // src/logging/messageContent.ts
 var messageContent = {
+  // CONTEXT
   1: () => ["context", "initializing Uniform Context"],
   2: (update) => ["context", "received update()", update],
   3: (scores) => ["context", "new score vector", scores],
   4: (quirks) => ["context", "updated quirks", quirks],
   5: (enrichment) => ["context", "ignored enrichment update for unknown enrichment category", enrichment.cat],
+  // STORAGE
   101: (commands) => ["storage", "received update commands", commands],
   102: (data) => ["storage", "data was updated", data],
   103: (fromAllDevices) => [
@@ -1764,6 +1857,7 @@ var messageContent = {
   ],
   131: () => ["storage", "server to client transition data was discarded"],
   140: (decayMessage) => ["storage", `score decay was applied: ${decayMessage}`],
+  // SIGNAL EVAL
   200: () => ["signals", "evaluating signals"],
   201: (signal) => ["signals", `evaluating signal ${signal.id} (${signal.dur})`],
   202: (group) => ["signals", group.op === "|" ? "OR" : "AND"],
@@ -1775,10 +1869,12 @@ var messageContent = {
     "signals",
     `group result: ${result.result} [${result.changed ? "CHANGED" : "unchanged"}]`
   ],
+  // PERSONALIZATION
   300: (placement) => ["personalization", `executing personalization '${placement.name}'`],
   301: ({ id, op }) => ["personalization", `testing variation ${id} (${op === "|" ? "OR" : "AND"})`],
   302: ({ matched, description }) => ["personalization", `${description} is ${matched}`],
   303: (selected) => ["personalization", selected ? "selected variation" : "did not select variation"],
+  // TESTING
   400: (name) => ["testing", `executing A/B test '${name}'`],
   401: (testName) => ["testing", `${testName} is not registered in the manifest; it will not be run.`],
   402: ({ missingVariant, variants }) => [
@@ -1789,6 +1885,7 @@ var messageContent = {
   ],
   403: (variant) => ["testing", `assigned new test variant '${variant}'`],
   404: (variant) => ["testing", `displaying variation '${variant}'`],
+  // GTAG
   700: () => [
     "gtag",
     "gtag is not defined, skipping analytics event emission. Ensure you have added the gtag script to your page."

package/dist/index.mjs

@@ -87,6 +87,7 @@ var SignalInstance = class {
     __privateSet(this, _evaluator, evaluator);
     __privateSet(this, _onLogMessage, onLogMessage);
   }
+  /** Computes storage update commands to take based on a state update and the signal's criteria */
   computeSignal(update, commands) {
     const isAtCap = update.scores[this.signal.id] >= this.signal.cap;
     if (isAtCap && this.signal.dur !== "t") {
@@ -128,6 +129,7 @@ var ManifestInstance = class {
   constructor({
     manifest,
     evaluator = new GroupCriteriaEvaluator({}),
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
     onLogMessage = () => {
     }
   }) {
@@ -168,6 +170,9 @@ var ManifestInstance = class {
     }
     return commands;
   }
+  /**
+   * Computes aggregated scores based on other dimensions
+   */
   computeAggregateDimensions(primitiveScores) {
     var _a, _b;
     return computeAggregateDimensions(primitiveScores, (_b = (_a = __privateGet(this, _mf).pz) == null ? void 0 : _a.agg) != null ? _b : {});
@@ -709,6 +714,9 @@ var TransitionDataStore = class {
     __privateAdd(this, _data, void 0);
     __privateAdd(this, _initialData, void 0);
     __privateAdd(this, _mitt, mitt());
+    /**
+     * Subscribe to events from the transition storage
+     */
     __publicField(this, "events", {
       on: __privateGet(this, _mitt).on,
       off: __privateGet(this, _mitt).off
@@ -724,10 +732,20 @@ var TransitionDataStore = class {
   get initialData() {
     return __privateGet(this, _initialData);
   }
+  /**
+   * Updates data in the transition storage.
+   * @param commands Commands to execute against existing stored value (event based stores)
+   * @param computedValue Pre-computed new value against existing value (object based stores)
+   * @returns Resolved promise when the data has been updated
+   */
   updateData(commands, computedValue) {
     __privateSet(this, _data, computedValue);
     return this.handleUpdateData(commands, computedValue);
   }
+  /**
+   * Deletes a visitor's stored data, forgetting them.
+   * @param fromAllDevices - false: logout from this device ID. true: forget all data about the visitor and their identity.
+   */
   async delete(fromAllDevices) {
     __privateSet(this, _data, void 0);
     await this.handleDelete(fromAllDevices);
@@ -739,6 +757,12 @@ var TransitionDataStore = class {
     __privateSet(this, _data, newScores);
     __privateGet(this, _mitt).emit("dataUpdatedAsync", newScores);
   }
+  /**
+   * When we load on the client side after a server side rendering has occurred (server to client transition),
+   * we can have a page script (ID: __UNIFORM_DATA__) that contains the computed visitor data from the SSR/edge render.
+   * This data is injected into the first render to allow score syncing and the server to request commands be applied
+   * to the client side data store.
+   */
   getClientTransitionState() {
     if (typeof document === "undefined") {
       return;
@@ -833,6 +857,7 @@ function parseScoreCookie(cookieValue) {
     return;
   const [abTestData, sessionScores, visitorScores] = types;
   return {
+    // this is true since we're reading a cookie, which wouldn't exist if consent wasn't given
     consent: true,
     sessionScores: decodeCookieType(parseCookieType(sessionScores)),
     scores: decodeCookieType(parseCookieType(visitorScores)),
@@ -1049,16 +1074,30 @@ var STORAGE_KEY = "ufvisitor";
 var _mitt2, _persist, _visitTimeout, _options, _currentData, currentData_get, _replaceData, replaceData_fn, _setVisitTimeout, setVisitTimeout_fn, _isExpired, isExpired_fn, _handleCaps, handleCaps_fn, _defaultData, defaultData_fn;
 var VisitorDataStore = class {
   constructor(options) {
+    /** Gets the current client-side storage data. This property is always up to date. */
     __privateAdd(this, _currentData);
+    /**
+     * IMPORTANT: This function mutates the input data. This is done,
+     * because all the sources that call it have either already spread or cloned
+     * the data, so we can safely mutate it for better perf.
+     */
     __privateAdd(this, _replaceData);
     __privateAdd(this, _setVisitTimeout);
     __privateAdd(this, _isExpired);
+    /**
+     * IMPORTANT: This function mutates the input data. This is done,
+     * because all the sources that call it have either already spread or cloned
+     * the data, so we can safely mutate it for better perf.
+     */
     __privateAdd(this, _handleCaps);
     __privateAdd(this, _defaultData);
     __privateAdd(this, _mitt2, mitt2());
     __privateAdd(this, _persist, new LocalStorage());
     __privateAdd(this, _visitTimeout, void 0);
     __privateAdd(this, _options, void 0);
+    /**
+     * Subscribe to events from storage
+     */
     __publicField(this, "events", {
       on: __privateGet(this, _mitt2).on,
       off: __privateGet(this, _mitt2).off
@@ -1080,10 +1119,16 @@ var VisitorDataStore = class {
       });
       const transitionData = options.transitionStore.data;
       if (transitionData) {
-        __privateMethod(this, _replaceData, replaceData_fn).call(this, { ...__privateGet(this, _currentData, currentData_get).visitorData, ...transitionData }, true);
+        __privateMethod(this, _replaceData, replaceData_fn).call(
+          this,
+          // we know _currentData is not empty because we inited it above if it was
+          { ...__privateGet(this, _currentData, currentData_get).visitorData, ...transitionData },
+          true
+        );
       }
     }
   }
+  /** Gets the current visitor data. This property is always up to date. */
   get data() {
     var _a, _b;
     const data = __privateGet(this, _currentData, currentData_get);
@@ -1101,6 +1146,7 @@ var VisitorDataStore = class {
   get options() {
     return __privateGet(this, _options);
   }
+  /** Push data update command(s) into the visitor data */
   async updateData(commands) {
     var _a, _b, _c, _d;
     if (commands.length === 0) {
@@ -1114,6 +1160,11 @@ var VisitorDataStore = class {
     __privateMethod(this, _replaceData, replaceData_fn).call(this, newData);
     await ((_d = __privateGet(this, _options).transitionStore) == null ? void 0 : _d.updateData(commands, __privateGet(this, _currentData, currentData_get).visitorData));
   }
+  /**
+   * Deletes visitor data (forgetting them)
+   * In most cases you should use forget() on the Context instead of this function, which also clears the Context state.
+   * @param fromAllDevices for an identified user, whether to delete all their data (for the entire account) - true, or data for this device (sign out) - false
+   */
   async delete(fromAllDevices) {
     var _a, _b, _c, _d, _e;
     (_b = (_a = __privateGet(this, _options)).onLogMessage) == null ? void 0 : _b.call(_a, ["info", 103, "GROUP", fromAllDevices]);
@@ -1243,6 +1294,9 @@ var Context = class {
     __privateAdd(this, _state, void 0);
     __privateAdd(this, _pzCache, {});
     __privateAdd(this, _mitt3, mitt3());
+    /**
+     * Subscribe to events
+     */
     __publicField(this, "events", {
       on: __privateGet(this, _mitt3).on,
       off: __privateGet(this, _mitt3).off
@@ -1308,13 +1362,24 @@ var Context = class {
       __privateGet(this, _mitt3).emit("log", ["info", 1, "ENDGROUP"]);
     }
   }
+  /** Gets the current visitor's dimension score vector. */
   get scores() {
     return __privateGet(this, _scores);
   }
+  /** Gets the current visitor's quirks values. */
   get quirks() {
     var _a, _b;
     return (_b = (_a = __privateGet(this, _serverTransitionState)) == null ? void 0 : _a.quirks) != null ? _b : this.storage.data.quirks;
   }
+  /**
+   * Updates the Context with new data of any sort, such as
+   * new URLs, cookies, quirks, and enrichments.
+   *
+   * Only properties that are set in the data parameter will be updated.
+   * Properties that do not result in a changed state,
+   * i.e. pushing the same URL or cookies as before,
+   * will NOT result in a recomputation of signal state.
+   */
   async update(newData) {
     var _a, _b, _c;
     const commands = [];
@@ -1353,6 +1418,8 @@ var Context = class {
         "GROUP",
         {
           ...newData,
+          // need to convert url to string so it can be json serialized
+          // to go over postMessage to chrome extension
           url: (_c = newData.url) == null ? void 0 : _c.toString()
         }
       ]);
@@ -1386,6 +1453,9 @@ var Context = class {
           state: newData,
           previousState: __privateGet(this, _state),
           visitor: this.storage.data,
+          // re-compute using scores from storage instead of the current scores since
+          // server transition scores might have adjusted values already integrated into them,
+          // which causes issues when you are near limits.
           scores: __privateGet(this, _serverTransitionState) ? __privateMethod(this, _calculateScores, calculateScores_fn).call(this, this.storage.data) : __privateGet(this, _scores)
         })
       );
@@ -1410,6 +1480,7 @@ var Context = class {
       __privateGet(this, _mitt3).emit("log", ["info", 2, "ENDGROUP"]);
     }
   }
+  /** use test() instead */
   getTestVariantId(testName) {
     var _a, _b, _c, _d;
     const definition = this.manifest.getTest(testName);
@@ -1419,6 +1490,7 @@ var Context = class {
     }
     return (_d = (_c = definition.wv) != null ? _c : (_b = (_a = __privateGet(this, _serverTransitionState)) == null ? void 0 : _a.tests) == null ? void 0 : _b[testName]) != null ? _d : this.storage.data.tests[testName];
   }
+  /** use test() instead */
   setTestVariantId(testName, variantId) {
     this.storage.updateData([
       {
@@ -1430,9 +1502,14 @@ var Context = class {
       }
     ]);
   }
+  /**
+   * Writes a message to the Context log sink.
+   * Used by Uniform internal SDK; not intended for public use.
+   */
   log(...message) {
     __privateGet(this, _mitt3).emit("log", message);
   }
+  /** Executes an A/B test with a given set of variants, showing the visitor's assigned variant (or selecting one to assign, if none is set yet) */
   test(options) {
     var _a, _b;
     const value = testVariations({
@@ -1447,6 +1524,7 @@ var Context = class {
     });
     return value;
   }
+  /** Executes a personalized placement with a given set of variants */
   personalize(options) {
     const value = personalizeVariations({
       ...options,
@@ -1470,10 +1548,19 @@ var Context = class {
     __privateGet(this, _pzCache)[options.name] = eventData.variantIds;
     return value;
   }
+  /**
+   * Forgets the visitor's data and resets the Context to its initial state.
+   * @param fromAllDevices for an identified user, whether to delete all their data (for the entire account) - true, or data for this device (sign out) - false
+   */
   async forget(fromAllDevices) {
     __privateSet(this, _state, {});
     await this.storage.delete(fromAllDevices);
   }
+  /**
+   * Computes server to client transition state.
+   *
+   * Removes state from server-to-client if it came in initial state (cookies) to avoid double tracking on the client.
+   */
   getServerToClientTransitionState() {
     const transitionState = {
       quirks: this.storage.data.quirks,
@@ -1676,11 +1763,13 @@ import rfdc3 from "rfdc";
 
 // src/logging/messageContent.ts
 var messageContent = {
+  // CONTEXT
   1: () => ["context", "initializing Uniform Context"],
   2: (update) => ["context", "received update()", update],
   3: (scores) => ["context", "new score vector", scores],
   4: (quirks) => ["context", "updated quirks", quirks],
   5: (enrichment) => ["context", "ignored enrichment update for unknown enrichment category", enrichment.cat],
+  // STORAGE
   101: (commands) => ["storage", "received update commands", commands],
   102: (data) => ["storage", "data was updated", data],
   103: (fromAllDevices) => [
@@ -1700,6 +1789,7 @@ var messageContent = {
   ],
   131: () => ["storage", "server to client transition data was discarded"],
   140: (decayMessage) => ["storage", `score decay was applied: ${decayMessage}`],
+  // SIGNAL EVAL
   200: () => ["signals", "evaluating signals"],
   201: (signal) => ["signals", `evaluating signal ${signal.id} (${signal.dur})`],
   202: (group) => ["signals", group.op === "|" ? "OR" : "AND"],
@@ -1711,10 +1801,12 @@ var messageContent = {
     "signals",
     `group result: ${result.result} [${result.changed ? "CHANGED" : "unchanged"}]`
   ],
+  // PERSONALIZATION
   300: (placement) => ["personalization", `executing personalization '${placement.name}'`],
   301: ({ id, op }) => ["personalization", `testing variation ${id} (${op === "|" ? "OR" : "AND"})`],
   302: ({ matched, description }) => ["personalization", `${description} is ${matched}`],
   303: (selected) => ["personalization", selected ? "selected variation" : "did not select variation"],
+  // TESTING
   400: (name) => ["testing", `executing A/B test '${name}'`],
   401: (testName) => ["testing", `${testName} is not registered in the manifest; it will not be run.`],
   402: ({ missingVariant, variants }) => [
@@ -1725,6 +1817,7 @@ var messageContent = {
   ],
   403: (variant) => ["testing", `assigned new test variant '${variant}'`],
   404: (variant) => ["testing", `displaying variation '${variant}'`],
+  // GTAG
   700: () => [
     "gtag",
     "gtag is not defined, skipping analytics event emission. Ensure you have added the gtag script to your page."

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/context",
-  "version": "18.18.1-alpha.12+e9f4d7eda",
+  "version": "18.19.0",
   "description": "Uniform Context core package",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -46,7 +46,8 @@
     "format": "prettier --write \"src/**/*.{js,ts,tsx}\"",
     "update-openapi": "tsx ./scripts/update-openapi.cts",
     "benchmark:build": "tsup src/storage/__benchmarks__/storage.benchmark.ts",
-    "benchmark:run": "node ./dist/storage.benchmark.js"
+    "benchmark:run": "node ./dist/storage.benchmark.js",
+    "document": "api-extractor run --local"
   },
   "devDependencies": {
     "@types/js-cookie": "3.0.2",
@@ -65,5 +66,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e9f4d7eda7b1b425205d0be4ec736ebd5dbaed4d"
+  "gitHead": "bd4414826a6d38b928b5ba2ea68e58160b784562"
 }