@uniformdev/context 20.20.3 → 20.22.1-alpha.0

package/dist/index.d.mts

@@ -56,6 +56,12 @@ type CookieTransitionDataStoreOptions = {
      * local storage is the master copy. Defaults to SameSite=Lax.
      */
     cookieAttributes?: Cookies.CookieAttributes;
+    /**
+     * Whether to omit dimensions with a score of zero from the transition store state.
+     * When enabled, dimensions with an explicit score of zero will not be included in the cookie.
+     * Defaults to false.
+     */
+    omitZeroScores?: boolean;
 };
 declare const UNIFORM_DEFAULT_COOKIE_NAME = "ufvd";
 declare const UNIFORM_DEFAULT_QUIRK_COOKIE_NAME = "ufvdqk";
@@ -65,7 +71,7 @@ declare const UNIFORM_DEFAULT_QUIRK_COOKIE_NAME = "ufvdqk";
  */
 declare class CookieTransitionDataStore extends TransitionDataStore {
     #private;
-    constructor({ serverCookieValue, experimental_quirksEnabled, quirkCookieValue, quirkCookieName, cookieName, cookieAttributes, }: CookieTransitionDataStoreOptions);
+    constructor({ serverCookieValue, experimental_quirksEnabled, quirkCookieValue, quirkCookieName, cookieName, cookieAttributes, omitZeroScores, }: CookieTransitionDataStoreOptions);
     handleDelete(): Promise<void>;
     handleUpdateData(_: StorageCommands[], computedValue: VisitorData): Promise<void>;
 }
@@ -78,10 +84,10 @@ declare function parseQuirkCookie(quirkCookieValue: string): Quirks;
 declare function parseCookieScores(type: string | undefined): Record<string, string>;
 declare function parseCookieType(type: string | undefined): Record<string, string>;
 declare function decodeCookieType(type: Record<string, string>): Record<string, number>;
-declare function serializeCookie(data: VisitorData): string;
+declare function serializeCookie(data: VisitorData, omitZeroScores?: boolean): string;
 declare function serializePersonalizeVariants({ personalizeVariants, }: Pick<VisitorData, 'personalizeVariants'>): string;
 declare function decodePersonalizeVariants(data: string | undefined): VisitorData['personalizeVariants'];
-declare function encodeCookieType(type: Record<string, number>): Record<string, string>;
+declare function encodeCookieType(type: Record<string, number>, omitZeroScores?: boolean): Record<string, string>;
 declare function serializeCookieType(type: Record<string, string>): string;
 declare function serializeQuirks(quirks: Quirks): string;
 

package/dist/index.d.ts

@@ -56,6 +56,12 @@ type CookieTransitionDataStoreOptions = {
      * local storage is the master copy. Defaults to SameSite=Lax.
      */
     cookieAttributes?: Cookies.CookieAttributes;
+    /**
+     * Whether to omit dimensions with a score of zero from the transition store state.
+     * When enabled, dimensions with an explicit score of zero will not be included in the cookie.
+     * Defaults to false.
+     */
+    omitZeroScores?: boolean;
 };
 declare const UNIFORM_DEFAULT_COOKIE_NAME = "ufvd";
 declare const UNIFORM_DEFAULT_QUIRK_COOKIE_NAME = "ufvdqk";
@@ -65,7 +71,7 @@ declare const UNIFORM_DEFAULT_QUIRK_COOKIE_NAME = "ufvdqk";
  */
 declare class CookieTransitionDataStore extends TransitionDataStore {
     #private;
-    constructor({ serverCookieValue, experimental_quirksEnabled, quirkCookieValue, quirkCookieName, cookieName, cookieAttributes, }: CookieTransitionDataStoreOptions);
+    constructor({ serverCookieValue, experimental_quirksEnabled, quirkCookieValue, quirkCookieName, cookieName, cookieAttributes, omitZeroScores, }: CookieTransitionDataStoreOptions);
     handleDelete(): Promise<void>;
     handleUpdateData(_: StorageCommands[], computedValue: VisitorData): Promise<void>;
 }
@@ -78,10 +84,10 @@ declare function parseQuirkCookie(quirkCookieValue: string): Quirks;
 declare function parseCookieScores(type: string | undefined): Record<string, string>;
 declare function parseCookieType(type: string | undefined): Record<string, string>;
 declare function decodeCookieType(type: Record<string, string>): Record<string, number>;
-declare function serializeCookie(data: VisitorData): string;
+declare function serializeCookie(data: VisitorData, omitZeroScores?: boolean): string;
 declare function serializePersonalizeVariants({ personalizeVariants, }: Pick<VisitorData, 'personalizeVariants'>): string;
 declare function decodePersonalizeVariants(data: string | undefined): VisitorData['personalizeVariants'];
-declare function encodeCookieType(type: Record<string, number>): Record<string, string>;
+declare function encodeCookieType(type: Record<string, number>, omitZeroScores?: boolean): Record<string, string>;
 declare function serializeCookieType(type: Record<string, string>): string;
 declare function serializeQuirks(quirks: Quirks): string;
 

package/dist/index.esm.js

@@ -1072,7 +1072,7 @@ var bton = (base64) => {
 var ssr = typeof document === "undefined";
 var UNIFORM_DEFAULT_COOKIE_NAME = "ufvd";
 var UNIFORM_DEFAULT_QUIRK_COOKIE_NAME = `ufvdqk`;
-var _cookieName, _quirkCookieName, _cookieAttributes, _quirksEnabled;
+var _cookieName, _quirkCookieName, _cookieAttributes, _quirksEnabled, _omitZeroScores;
 var CookieTransitionDataStore = class extends TransitionDataStore {
   constructor({
     serverCookieValue,
@@ -1080,7 +1080,8 @@ var CookieTransitionDataStore = class extends TransitionDataStore {
     quirkCookieValue,
     quirkCookieName = UNIFORM_DEFAULT_QUIRK_COOKIE_NAME,
     cookieName = UNIFORM_DEFAULT_COOKIE_NAME,
-    cookieAttributes = { sameSite: "lax" }
+    cookieAttributes = { sameSite: "lax" },
+    omitZeroScores = false
   }) {
     super({
       initialData: ssr ? parseScoreCookie(serverCookieValue, experimental_quirksEnabled ? quirkCookieValue : void 0) : void 0
@@ -1089,10 +1090,12 @@ var CookieTransitionDataStore = class extends TransitionDataStore {
     __privateAdd(this, _quirkCookieName);
     __privateAdd(this, _cookieAttributes);
     __privateAdd(this, _quirksEnabled);
+    __privateAdd(this, _omitZeroScores);
     __privateSet(this, _cookieName, cookieName);
     __privateSet(this, _cookieAttributes, cookieAttributes);
     __privateSet(this, _quirkCookieName, quirkCookieName);
     __privateSet(this, _quirksEnabled, experimental_quirksEnabled || false);
+    __privateSet(this, _omitZeroScores, omitZeroScores);
   }
   handleDelete() {
     if (ssr) return Promise.resolve();
@@ -1102,7 +1105,11 @@ var CookieTransitionDataStore = class extends TransitionDataStore {
   async handleUpdateData(_, computedValue) {
     if (ssr) return;
     if (computedValue.consent) {
-      Cookies.set(__privateGet(this, _cookieName), serializeCookie(computedValue), __privateGet(this, _cookieAttributes));
+      Cookies.set(
+        __privateGet(this, _cookieName),
+        serializeCookie(computedValue, __privateGet(this, _omitZeroScores)),
+        __privateGet(this, _cookieAttributes)
+      );
       if (__privateGet(this, _quirksEnabled) && Object.keys(computedValue.quirks || {}).length) {
         const quirkCookieValue = serializeQuirks(computedValue.quirks || {});
         Cookies.set(__privateGet(this, _quirkCookieName), quirkCookieValue, __privateGet(this, _cookieAttributes));
@@ -1119,6 +1126,7 @@ _cookieName = new WeakMap();
 _quirkCookieName = new WeakMap();
 _cookieAttributes = new WeakMap();
 _quirksEnabled = new WeakMap();
+_omitZeroScores = new WeakMap();
 var TYPE_SEP = "~";
 var PAIR_SEP = "!";
 var KV_SEP = "-";
@@ -1190,11 +1198,11 @@ function decodeCookieType(type) {
     return acc;
   }, {});
 }
-function serializeCookie(data) {
+function serializeCookie(data, omitZeroScores) {
   return [
     serializeCookieType(data.tests),
-    serializeCookieType(encodeCookieType(data.sessionScores)),
-    serializeCookieType(encodeCookieType(data.scores)),
+    serializeCookieType(encodeCookieType(data.sessionScores, omitZeroScores)),
+    serializeCookieType(encodeCookieType(data.scores, omitZeroScores)),
     data.controlGroup ? "1" : "0",
     serializePersonalizeVariants(data)
   ].join(TYPE_SEP);
@@ -1236,8 +1244,11 @@ function decodePersonalizeVariants(data) {
   });
   return results;
 }
-function encodeCookieType(type) {
+function encodeCookieType(type, omitZeroScores) {
   return Object.entries(type).reduce((acc, [key, value]) => {
+    if (omitZeroScores && value === 0) {
+      return acc;
+    }
     acc[key] = ntob(value);
     return acc;
   }, {});

package/dist/index.js

@@ -1165,7 +1165,7 @@ var bton = (base64) => {
 var ssr = typeof document === "undefined";
 var UNIFORM_DEFAULT_COOKIE_NAME = "ufvd";
 var UNIFORM_DEFAULT_QUIRK_COOKIE_NAME = `ufvdqk`;
-var _cookieName, _quirkCookieName, _cookieAttributes, _quirksEnabled;
+var _cookieName, _quirkCookieName, _cookieAttributes, _quirksEnabled, _omitZeroScores;
 var CookieTransitionDataStore = class extends TransitionDataStore {
   constructor({
     serverCookieValue,
@@ -1173,7 +1173,8 @@ var CookieTransitionDataStore = class extends TransitionDataStore {
     quirkCookieValue,
     quirkCookieName = UNIFORM_DEFAULT_QUIRK_COOKIE_NAME,
     cookieName = UNIFORM_DEFAULT_COOKIE_NAME,
-    cookieAttributes = { sameSite: "lax" }
+    cookieAttributes = { sameSite: "lax" },
+    omitZeroScores = false
   }) {
     super({
       initialData: ssr ? parseScoreCookie(serverCookieValue, experimental_quirksEnabled ? quirkCookieValue : void 0) : void 0
@@ -1182,10 +1183,12 @@ var CookieTransitionDataStore = class extends TransitionDataStore {
     __privateAdd(this, _quirkCookieName);
     __privateAdd(this, _cookieAttributes);
     __privateAdd(this, _quirksEnabled);
+    __privateAdd(this, _omitZeroScores);
     __privateSet(this, _cookieName, cookieName);
     __privateSet(this, _cookieAttributes, cookieAttributes);
     __privateSet(this, _quirkCookieName, quirkCookieName);
     __privateSet(this, _quirksEnabled, experimental_quirksEnabled || false);
+    __privateSet(this, _omitZeroScores, omitZeroScores);
   }
   handleDelete() {
     if (ssr) return Promise.resolve();
@@ -1195,7 +1198,11 @@ var CookieTransitionDataStore = class extends TransitionDataStore {
   async handleUpdateData(_, computedValue) {
     if (ssr) return;
     if (computedValue.consent) {
-      import_js_cookie.default.set(__privateGet(this, _cookieName), serializeCookie(computedValue), __privateGet(this, _cookieAttributes));
+      import_js_cookie.default.set(
+        __privateGet(this, _cookieName),
+        serializeCookie(computedValue, __privateGet(this, _omitZeroScores)),
+        __privateGet(this, _cookieAttributes)
+      );
       if (__privateGet(this, _quirksEnabled) && Object.keys(computedValue.quirks || {}).length) {
         const quirkCookieValue = serializeQuirks(computedValue.quirks || {});
         import_js_cookie.default.set(__privateGet(this, _quirkCookieName), quirkCookieValue, __privateGet(this, _cookieAttributes));
@@ -1212,6 +1219,7 @@ _cookieName = new WeakMap();
 _quirkCookieName = new WeakMap();
 _cookieAttributes = new WeakMap();
 _quirksEnabled = new WeakMap();
+_omitZeroScores = new WeakMap();
 var TYPE_SEP = "~";
 var PAIR_SEP = "!";
 var KV_SEP = "-";
@@ -1283,11 +1291,11 @@ function decodeCookieType(type) {
     return acc;
   }, {});
 }
-function serializeCookie(data) {
+function serializeCookie(data, omitZeroScores) {
   return [
     serializeCookieType(data.tests),
-    serializeCookieType(encodeCookieType(data.sessionScores)),
-    serializeCookieType(encodeCookieType(data.scores)),
+    serializeCookieType(encodeCookieType(data.sessionScores, omitZeroScores)),
+    serializeCookieType(encodeCookieType(data.scores, omitZeroScores)),
     data.controlGroup ? "1" : "0",
     serializePersonalizeVariants(data)
   ].join(TYPE_SEP);
@@ -1329,8 +1337,11 @@ function decodePersonalizeVariants(data) {
   });
   return results;
 }
-function encodeCookieType(type) {
+function encodeCookieType(type, omitZeroScores) {
   return Object.entries(type).reduce((acc, [key, value]) => {
+    if (omitZeroScores && value === 0) {
+      return acc;
+    }
     acc[key] = ntob(value);
     return acc;
   }, {});

package/dist/index.mjs

@@ -1072,7 +1072,7 @@ var bton = (base64) => {
 var ssr = typeof document === "undefined";
 var UNIFORM_DEFAULT_COOKIE_NAME = "ufvd";
 var UNIFORM_DEFAULT_QUIRK_COOKIE_NAME = `ufvdqk`;
-var _cookieName, _quirkCookieName, _cookieAttributes, _quirksEnabled;
+var _cookieName, _quirkCookieName, _cookieAttributes, _quirksEnabled, _omitZeroScores;
 var CookieTransitionDataStore = class extends TransitionDataStore {
   constructor({
     serverCookieValue,
@@ -1080,7 +1080,8 @@ var CookieTransitionDataStore = class extends TransitionDataStore {
     quirkCookieValue,
     quirkCookieName = UNIFORM_DEFAULT_QUIRK_COOKIE_NAME,
     cookieName = UNIFORM_DEFAULT_COOKIE_NAME,
-    cookieAttributes = { sameSite: "lax" }
+    cookieAttributes = { sameSite: "lax" },
+    omitZeroScores = false
   }) {
     super({
       initialData: ssr ? parseScoreCookie(serverCookieValue, experimental_quirksEnabled ? quirkCookieValue : void 0) : void 0
@@ -1089,10 +1090,12 @@ var CookieTransitionDataStore = class extends TransitionDataStore {
     __privateAdd(this, _quirkCookieName);
     __privateAdd(this, _cookieAttributes);
     __privateAdd(this, _quirksEnabled);
+    __privateAdd(this, _omitZeroScores);
     __privateSet(this, _cookieName, cookieName);
     __privateSet(this, _cookieAttributes, cookieAttributes);
     __privateSet(this, _quirkCookieName, quirkCookieName);
     __privateSet(this, _quirksEnabled, experimental_quirksEnabled || false);
+    __privateSet(this, _omitZeroScores, omitZeroScores);
   }
   handleDelete() {
     if (ssr) return Promise.resolve();
@@ -1102,7 +1105,11 @@ var CookieTransitionDataStore = class extends TransitionDataStore {
   async handleUpdateData(_, computedValue) {
     if (ssr) return;
     if (computedValue.consent) {
-      Cookies.set(__privateGet(this, _cookieName), serializeCookie(computedValue), __privateGet(this, _cookieAttributes));
+      Cookies.set(
+        __privateGet(this, _cookieName),
+        serializeCookie(computedValue, __privateGet(this, _omitZeroScores)),
+        __privateGet(this, _cookieAttributes)
+      );
       if (__privateGet(this, _quirksEnabled) && Object.keys(computedValue.quirks || {}).length) {
         const quirkCookieValue = serializeQuirks(computedValue.quirks || {});
         Cookies.set(__privateGet(this, _quirkCookieName), quirkCookieValue, __privateGet(this, _cookieAttributes));
@@ -1119,6 +1126,7 @@ _cookieName = new WeakMap();
 _quirkCookieName = new WeakMap();
 _cookieAttributes = new WeakMap();
 _quirksEnabled = new WeakMap();
+_omitZeroScores = new WeakMap();
 var TYPE_SEP = "~";
 var PAIR_SEP = "!";
 var KV_SEP = "-";
@@ -1190,11 +1198,11 @@ function decodeCookieType(type) {
     return acc;
   }, {});
 }
-function serializeCookie(data) {
+function serializeCookie(data, omitZeroScores) {
   return [
     serializeCookieType(data.tests),
-    serializeCookieType(encodeCookieType(data.sessionScores)),
-    serializeCookieType(encodeCookieType(data.scores)),
+    serializeCookieType(encodeCookieType(data.sessionScores, omitZeroScores)),
+    serializeCookieType(encodeCookieType(data.scores, omitZeroScores)),
     data.controlGroup ? "1" : "0",
     serializePersonalizeVariants(data)
   ].join(TYPE_SEP);
@@ -1236,8 +1244,11 @@ function decodePersonalizeVariants(data) {
   });
   return results;
 }
-function encodeCookieType(type) {
+function encodeCookieType(type, omitZeroScores) {
   return Object.entries(type).reduce((acc, [key, value]) => {
+    if (omitZeroScores && value === 0) {
+      return acc;
+    }
     acc[key] = ntob(value);
     return acc;
   }, {});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/context",
-  "version": "20.20.3",
+  "version": "20.22.1-alpha.0+b02aa0b2f0",
   "description": "Uniform Context core package",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -68,5 +68,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "3e58ece2c26439f3ee48d2ff445898a3be59b349"
+  "gitHead": "b02aa0b2f0c3d94ec1f20953cb5bc36dfa9cdbc7"
 }