@uniformdev/canvas-next-rsc-client 20.80.0 → 20.80.1-alpha.10.sha-e0cfb4ce44

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { ManifestV2, PersonalizationEvent, TestEvent, CompositionMetadata, Quirks, ScoreVector } from '@uniformdev/context';
+import { ManifestV2, CookieTransitionDataStoreOptions, VisitorDataStoreOptions, PersonalizationEvent, TestEvent, CompositionMetadata, Quirks, ScoreVector } from '@uniformdev/context';
 import * as react from 'react';
 import { ReactNode, PropsWithChildren } from 'react';
 import { PureContextualEditingComponentWrapperProps } from '@uniformdev/canvas-react/core';
@@ -24,6 +24,23 @@ type ClientContextComponentProps = {
      * Whether or not to enable the experimental quirk serialization
      */
     experimentalQuirkSerialization: boolean;
+    /**
+     * Ceiling on the size in bytes of the visitor data cookie. Unbounded when unset.
+     */
+    cookieMaxBytes?: CookieTransitionDataStoreOptions['maxBytes'];
+    /**
+     * Whether to remove stored A/B test assignments for tests that are no longer in the manifest
+     */
+    pruneUnknownTests?: VisitorDataStoreOptions['pruneUnknownTests'];
+    /**
+     * Whether to remove stored dimensions that are no longer in the manifest
+     */
+    pruneUnknownDimensions?: VisitorDataStoreOptions['pruneUnknownDimensions'];
+    /**
+     * Whether to remove stored dimensions whose score is zero.
+     * `'round'` also removes any score whose magnitude is below 1.
+     */
+    pruneZeroScores?: VisitorDataStoreOptions['pruneZeroScores'];
 };
 type ClientContextComponent = (props: ClientContextComponentProps) => ReactNode;
 

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ManifestV2, PersonalizationEvent, TestEvent, CompositionMetadata, Quirks, ScoreVector } from '@uniformdev/context';
+import { ManifestV2, CookieTransitionDataStoreOptions, VisitorDataStoreOptions, PersonalizationEvent, TestEvent, CompositionMetadata, Quirks, ScoreVector } from '@uniformdev/context';
 import * as react from 'react';
 import { ReactNode, PropsWithChildren } from 'react';
 import { PureContextualEditingComponentWrapperProps } from '@uniformdev/canvas-react/core';
@@ -24,6 +24,23 @@ type ClientContextComponentProps = {
      * Whether or not to enable the experimental quirk serialization
      */
     experimentalQuirkSerialization: boolean;
+    /**
+     * Ceiling on the size in bytes of the visitor data cookie. Unbounded when unset.
+     */
+    cookieMaxBytes?: CookieTransitionDataStoreOptions['maxBytes'];
+    /**
+     * Whether to remove stored A/B test assignments for tests that are no longer in the manifest
+     */
+    pruneUnknownTests?: VisitorDataStoreOptions['pruneUnknownTests'];
+    /**
+     * Whether to remove stored dimensions that are no longer in the manifest
+     */
+    pruneUnknownDimensions?: VisitorDataStoreOptions['pruneUnknownDimensions'];
+    /**
+     * Whether to remove stored dimensions whose score is zero.
+     * `'round'` also removes any score whose magnitude is below 1.
+     */
+    pruneZeroScores?: VisitorDataStoreOptions['pruneZeroScores'];
 };
 type ClientContextComponent = (props: ClientContextComponentProps) => ReactNode;
 

package/dist/index.esm.js

@@ -482,14 +482,17 @@ var s2b = new Array(123);
 for (let i = 0; i < alphabet.length; i++) {
   s2b[alphabet.charCodeAt(i)] = i;
 }
+var isZeroCookieScore = (score) => Math.abs(score) < 1;
 var _cookieName;
 var _quirkCookieName;
 var _cookieAttributes;
 var _quirksEnabled;
+var _maxBytes;
 _cookieName = /* @__PURE__ */ new WeakMap();
 _quirkCookieName = /* @__PURE__ */ new WeakMap();
 _cookieAttributes = /* @__PURE__ */ new WeakMap();
 _quirksEnabled = /* @__PURE__ */ new WeakMap();
+_maxBytes = /* @__PURE__ */ new WeakMap();
 var _EdgeTransitionDataStore_instances;
 var fetchData_fn;
 _EdgeTransitionDataStore_instances = /* @__PURE__ */ new WeakSet();
@@ -503,6 +506,7 @@ fetchData_fn = async function() {
     this.signalAsyncDataUpdate(serviceData);
   }
 };
+var isSystemDimension = (dimension) => dimension.startsWith("$");
 var emptyVisitorData = () => ({
   quirks: {},
   scores: {},
@@ -531,6 +535,9 @@ var replaceData_fn;
 var setVisitTimeout_fn;
 var isExpired_fn;
 var handleCaps_fn;
+var pruningManifest_get;
+var handlePruning_fn;
+var pruneScores_fn;
 var defaultData_fn;
 _mitt2 = /* @__PURE__ */ new WeakMap();
 _persist = /* @__PURE__ */ new WeakMap();
@@ -553,6 +560,7 @@ replaceData_fn = function(data, quiet = false) {
     sessionScores: data.sessionScores,
     onLogMessage: __privateGet(this, _options).onLogMessage
   });
+  __privateMethod(this, _VisitorDataStore_instances, handlePruning_fn).call(this, data);
   const haveScoresChanged = !dequal(oldData == null ? void 0 : oldData.visitorData.scores, data.scores);
   const haveSessionScoresChanged = !dequal(oldData == null ? void 0 : oldData.visitorData.sessionScores, data.sessionScores);
   const haveQuirksChanged = !dequal(oldData == null ? void 0 : oldData.visitorData.quirks, data.quirks);
@@ -625,6 +633,48 @@ handleCaps_fn = function(scores) {
     }
   }
 };
+pruningManifest_get = function() {
+  var _a, _b, _c, _d, _e;
+  const project = (_b = (_a = __privateGet(this, _options).manifest) == null ? void 0 : _a.data) == null ? void 0 : _b.project;
+  const populated = [(_c = project == null ? void 0 : project.pz) == null ? void 0 : _c.sig, (_d = project == null ? void 0 : project.pz) == null ? void 0 : _d.enr, (_e = project == null ? void 0 : project.pz) == null ? void 0 : _e.agg, project == null ? void 0 : project.test].some(
+    (definitions) => definitions && Object.keys(definitions).length > 0
+  );
+  return populated ? __privateGet(this, _options).manifest : void 0;
+};
+handlePruning_fn = function(data) {
+  var _a, _b;
+  const { pruneUnknownTests, pruneUnknownDimensions } = __privateGet(this, _options);
+  const manifest = pruneUnknownTests || pruneUnknownDimensions ? __privateGet(this, _VisitorDataStore_instances, pruningManifest_get) : void 0;
+  const pruned = [];
+  if (pruneUnknownTests && manifest) {
+    for (const test in data.tests) {
+      if (!manifest.getTest(test)) {
+        delete data.tests[test];
+        pruned.push(`tests.${test}`);
+      }
+    }
+  }
+  __privateMethod(this, _VisitorDataStore_instances, pruneScores_fn).call(this, data.scores, "scores", pruned, manifest);
+  __privateMethod(this, _VisitorDataStore_instances, pruneScores_fn).call(this, data.sessionScores, "sessionScores", pruned, manifest);
+  if (pruned.length) {
+    (_b = (_a = __privateGet(this, _options)).onLogMessage) == null ? void 0 : _b.call(_a, ["info", 150, pruned]);
+  }
+};
+pruneScores_fn = function(scores, bucket, pruned, manifest) {
+  const { pruneUnknownDimensions, pruneZeroScores } = __privateGet(this, _options);
+  if (!pruneUnknownDimensions && !pruneZeroScores) {
+    return;
+  }
+  const pruneUnknown = pruneUnknownDimensions && manifest;
+  for (const dim in scores) {
+    const isUnknown = pruneUnknown && !isSystemDimension(dim) && !manifest.getDimensionByKey(dim);
+    const isZero = pruneZeroScores && (pruneZeroScores === "round" ? isZeroCookieScore(scores[dim]) : scores[dim] === 0);
+    if (isUnknown || isZero) {
+      delete scores[dim];
+      pruned.push(`${bucket}.${dim}`);
+    }
+  }
+};
 defaultData_fn = function() {
   var _a, _b, _c;
   return {
@@ -844,7 +894,11 @@ var DefaultUniformClientContext = ({
   manifest,
   disableDevTools,
   defaultConsent,
-  experimentalQuirkSerialization
+  experimentalQuirkSerialization,
+  cookieMaxBytes,
+  pruneUnknownTests,
+  pruneUnknownDimensions,
+  pruneZeroScores
 }) => {
   const router = useRouter();
   useInitUniformContext(() => {
@@ -862,7 +916,11 @@ var DefaultUniformClientContext = ({
       manifest,
       plugins,
       defaultConsent,
-      experimental_quirksEnabled: experimentalQuirkSerialization
+      experimental_quirksEnabled: experimentalQuirkSerialization,
+      cookieMaxBytes,
+      pruneUnknownTests,
+      pruneUnknownDimensions,
+      pruneZeroScores
     });
   });
   return null;

package/dist/index.js

@@ -508,14 +508,17 @@ var s2b = new Array(123);
 for (let i = 0; i < alphabet.length; i++) {
   s2b[alphabet.charCodeAt(i)] = i;
 }
+var isZeroCookieScore = (score) => Math.abs(score) < 1;
 var _cookieName;
 var _quirkCookieName;
 var _cookieAttributes;
 var _quirksEnabled;
+var _maxBytes;
 _cookieName = /* @__PURE__ */ new WeakMap();
 _quirkCookieName = /* @__PURE__ */ new WeakMap();
 _cookieAttributes = /* @__PURE__ */ new WeakMap();
 _quirksEnabled = /* @__PURE__ */ new WeakMap();
+_maxBytes = /* @__PURE__ */ new WeakMap();
 var _EdgeTransitionDataStore_instances;
 var fetchData_fn;
 _EdgeTransitionDataStore_instances = /* @__PURE__ */ new WeakSet();
@@ -529,6 +532,7 @@ fetchData_fn = async function() {
     this.signalAsyncDataUpdate(serviceData);
   }
 };
+var isSystemDimension = (dimension) => dimension.startsWith("$");
 var emptyVisitorData = () => ({
   quirks: {},
   scores: {},
@@ -557,6 +561,9 @@ var replaceData_fn;
 var setVisitTimeout_fn;
 var isExpired_fn;
 var handleCaps_fn;
+var pruningManifest_get;
+var handlePruning_fn;
+var pruneScores_fn;
 var defaultData_fn;
 _mitt2 = /* @__PURE__ */ new WeakMap();
 _persist = /* @__PURE__ */ new WeakMap();
@@ -579,6 +586,7 @@ replaceData_fn = function(data, quiet = false) {
     sessionScores: data.sessionScores,
     onLogMessage: __privateGet(this, _options).onLogMessage
   });
+  __privateMethod(this, _VisitorDataStore_instances, handlePruning_fn).call(this, data);
   const haveScoresChanged = !dequal(oldData == null ? void 0 : oldData.visitorData.scores, data.scores);
   const haveSessionScoresChanged = !dequal(oldData == null ? void 0 : oldData.visitorData.sessionScores, data.sessionScores);
   const haveQuirksChanged = !dequal(oldData == null ? void 0 : oldData.visitorData.quirks, data.quirks);
@@ -651,6 +659,48 @@ handleCaps_fn = function(scores) {
     }
   }
 };
+pruningManifest_get = function() {
+  var _a, _b, _c, _d, _e;
+  const project = (_b = (_a = __privateGet(this, _options).manifest) == null ? void 0 : _a.data) == null ? void 0 : _b.project;
+  const populated = [(_c = project == null ? void 0 : project.pz) == null ? void 0 : _c.sig, (_d = project == null ? void 0 : project.pz) == null ? void 0 : _d.enr, (_e = project == null ? void 0 : project.pz) == null ? void 0 : _e.agg, project == null ? void 0 : project.test].some(
+    (definitions) => definitions && Object.keys(definitions).length > 0
+  );
+  return populated ? __privateGet(this, _options).manifest : void 0;
+};
+handlePruning_fn = function(data) {
+  var _a, _b;
+  const { pruneUnknownTests, pruneUnknownDimensions } = __privateGet(this, _options);
+  const manifest = pruneUnknownTests || pruneUnknownDimensions ? __privateGet(this, _VisitorDataStore_instances, pruningManifest_get) : void 0;
+  const pruned = [];
+  if (pruneUnknownTests && manifest) {
+    for (const test in data.tests) {
+      if (!manifest.getTest(test)) {
+        delete data.tests[test];
+        pruned.push(`tests.${test}`);
+      }
+    }
+  }
+  __privateMethod(this, _VisitorDataStore_instances, pruneScores_fn).call(this, data.scores, "scores", pruned, manifest);
+  __privateMethod(this, _VisitorDataStore_instances, pruneScores_fn).call(this, data.sessionScores, "sessionScores", pruned, manifest);
+  if (pruned.length) {
+    (_b = (_a = __privateGet(this, _options)).onLogMessage) == null ? void 0 : _b.call(_a, ["info", 150, pruned]);
+  }
+};
+pruneScores_fn = function(scores, bucket, pruned, manifest) {
+  const { pruneUnknownDimensions, pruneZeroScores } = __privateGet(this, _options);
+  if (!pruneUnknownDimensions && !pruneZeroScores) {
+    return;
+  }
+  const pruneUnknown = pruneUnknownDimensions && manifest;
+  for (const dim in scores) {
+    const isUnknown = pruneUnknown && !isSystemDimension(dim) && !manifest.getDimensionByKey(dim);
+    const isZero = pruneZeroScores && (pruneZeroScores === "round" ? isZeroCookieScore(scores[dim]) : scores[dim] === 0);
+    if (isUnknown || isZero) {
+      delete scores[dim];
+      pruned.push(`${bucket}.${dim}`);
+    }
+  }
+};
 defaultData_fn = function() {
   var _a, _b, _c;
   return {
@@ -870,7 +920,11 @@ var DefaultUniformClientContext = ({
   manifest,
   disableDevTools,
   defaultConsent,
-  experimentalQuirkSerialization
+  experimentalQuirkSerialization,
+  cookieMaxBytes,
+  pruneUnknownTests,
+  pruneUnknownDimensions,
+  pruneZeroScores
 }) => {
   const router = (0, import_navigation3.useRouter)();
   useInitUniformContext(() => {
@@ -888,7 +942,11 @@ var DefaultUniformClientContext = ({
       manifest,
       plugins,
       defaultConsent,
-      experimental_quirksEnabled: experimentalQuirkSerialization
+      experimental_quirksEnabled: experimentalQuirkSerialization,
+      cookieMaxBytes,
+      pruneUnknownTests,
+      pruneUnknownDimensions,
+      pruneZeroScores
     });
   });
   return null;

package/dist/index.mjs

@@ -482,14 +482,17 @@ var s2b = new Array(123);
 for (let i = 0; i < alphabet.length; i++) {
   s2b[alphabet.charCodeAt(i)] = i;
 }
+var isZeroCookieScore = (score) => Math.abs(score) < 1;
 var _cookieName;
 var _quirkCookieName;
 var _cookieAttributes;
 var _quirksEnabled;
+var _maxBytes;
 _cookieName = /* @__PURE__ */ new WeakMap();
 _quirkCookieName = /* @__PURE__ */ new WeakMap();
 _cookieAttributes = /* @__PURE__ */ new WeakMap();
 _quirksEnabled = /* @__PURE__ */ new WeakMap();
+_maxBytes = /* @__PURE__ */ new WeakMap();
 var _EdgeTransitionDataStore_instances;
 var fetchData_fn;
 _EdgeTransitionDataStore_instances = /* @__PURE__ */ new WeakSet();
@@ -503,6 +506,7 @@ fetchData_fn = async function() {
     this.signalAsyncDataUpdate(serviceData);
   }
 };
+var isSystemDimension = (dimension) => dimension.startsWith("$");
 var emptyVisitorData = () => ({
   quirks: {},
   scores: {},
@@ -531,6 +535,9 @@ var replaceData_fn;
 var setVisitTimeout_fn;
 var isExpired_fn;
 var handleCaps_fn;
+var pruningManifest_get;
+var handlePruning_fn;
+var pruneScores_fn;
 var defaultData_fn;
 _mitt2 = /* @__PURE__ */ new WeakMap();
 _persist = /* @__PURE__ */ new WeakMap();
@@ -553,6 +560,7 @@ replaceData_fn = function(data, quiet = false) {
     sessionScores: data.sessionScores,
     onLogMessage: __privateGet(this, _options).onLogMessage
   });
+  __privateMethod(this, _VisitorDataStore_instances, handlePruning_fn).call(this, data);
   const haveScoresChanged = !dequal(oldData == null ? void 0 : oldData.visitorData.scores, data.scores);
   const haveSessionScoresChanged = !dequal(oldData == null ? void 0 : oldData.visitorData.sessionScores, data.sessionScores);
   const haveQuirksChanged = !dequal(oldData == null ? void 0 : oldData.visitorData.quirks, data.quirks);
@@ -625,6 +633,48 @@ handleCaps_fn = function(scores) {
     }
   }
 };
+pruningManifest_get = function() {
+  var _a, _b, _c, _d, _e;
+  const project = (_b = (_a = __privateGet(this, _options).manifest) == null ? void 0 : _a.data) == null ? void 0 : _b.project;
+  const populated = [(_c = project == null ? void 0 : project.pz) == null ? void 0 : _c.sig, (_d = project == null ? void 0 : project.pz) == null ? void 0 : _d.enr, (_e = project == null ? void 0 : project.pz) == null ? void 0 : _e.agg, project == null ? void 0 : project.test].some(
+    (definitions) => definitions && Object.keys(definitions).length > 0
+  );
+  return populated ? __privateGet(this, _options).manifest : void 0;
+};
+handlePruning_fn = function(data) {
+  var _a, _b;
+  const { pruneUnknownTests, pruneUnknownDimensions } = __privateGet(this, _options);
+  const manifest = pruneUnknownTests || pruneUnknownDimensions ? __privateGet(this, _VisitorDataStore_instances, pruningManifest_get) : void 0;
+  const pruned = [];
+  if (pruneUnknownTests && manifest) {
+    for (const test in data.tests) {
+      if (!manifest.getTest(test)) {
+        delete data.tests[test];
+        pruned.push(`tests.${test}`);
+      }
+    }
+  }
+  __privateMethod(this, _VisitorDataStore_instances, pruneScores_fn).call(this, data.scores, "scores", pruned, manifest);
+  __privateMethod(this, _VisitorDataStore_instances, pruneScores_fn).call(this, data.sessionScores, "sessionScores", pruned, manifest);
+  if (pruned.length) {
+    (_b = (_a = __privateGet(this, _options)).onLogMessage) == null ? void 0 : _b.call(_a, ["info", 150, pruned]);
+  }
+};
+pruneScores_fn = function(scores, bucket, pruned, manifest) {
+  const { pruneUnknownDimensions, pruneZeroScores } = __privateGet(this, _options);
+  if (!pruneUnknownDimensions && !pruneZeroScores) {
+    return;
+  }
+  const pruneUnknown = pruneUnknownDimensions && manifest;
+  for (const dim in scores) {
+    const isUnknown = pruneUnknown && !isSystemDimension(dim) && !manifest.getDimensionByKey(dim);
+    const isZero = pruneZeroScores && (pruneZeroScores === "round" ? isZeroCookieScore(scores[dim]) : scores[dim] === 0);
+    if (isUnknown || isZero) {
+      delete scores[dim];
+      pruned.push(`${bucket}.${dim}`);
+    }
+  }
+};
 defaultData_fn = function() {
   var _a, _b, _c;
   return {
@@ -844,7 +894,11 @@ var DefaultUniformClientContext = ({
   manifest,
   disableDevTools,
   defaultConsent,
-  experimentalQuirkSerialization
+  experimentalQuirkSerialization,
+  cookieMaxBytes,
+  pruneUnknownTests,
+  pruneUnknownDimensions,
+  pruneZeroScores
 }) => {
   const router = useRouter();
   useInitUniformContext(() => {
@@ -862,7 +916,11 @@ var DefaultUniformClientContext = ({
       manifest,
       plugins,
       defaultConsent,
-      experimental_quirksEnabled: experimentalQuirkSerialization
+      experimental_quirksEnabled: experimentalQuirkSerialization,
+      cookieMaxBytes,
+      pruneUnknownTests,
+      pruneUnknownDimensions,
+      pruneZeroScores
     });
   });
   return null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/canvas-next-rsc-client",
-  "version": "20.80.0",
+  "version": "20.80.1-alpha.10.sha-e0cfb4ce44",
   "license": "SEE LICENSE IN LICENSE.txt",
   "scripts": {
     "build": "tsup",
@@ -34,9 +34,9 @@
     "typescript": "6.0.3"
   },
   "dependencies": {
-    "@uniformdev/canvas": "20.80.0",
-    "@uniformdev/canvas-next-rsc-shared": "20.80.0",
-    "@uniformdev/canvas-react": "20.80.0",
+    "@uniformdev/canvas": "20.80.1-alpha.10.sha-e0cfb4ce44",
+    "@uniformdev/canvas-next-rsc-shared": "20.80.1-alpha.10.sha-e0cfb4ce44",
+    "@uniformdev/canvas-react": "20.80.1-alpha.10.sha-e0cfb4ce44",
     "js-cookie": "3.0.8"
   },
   "engines": {
@@ -50,5 +50,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "6eec8f028463f30667b59af913a74d56960dde11"
+  "gitHead": "e0cfb4ce4435ea507f36d3246fc886c24f8ebe16"
 }