@uniformdev/next-app-router-shared 20.7.1-alpha.118

package/dist/index.esm.js

@@ -0,0 +1,297 @@
+// src/placements/evaluatePersonalization.ts
+var evaluatePersonalization = ({
+  personalization,
+  context,
+  compositionContext
+}) => {
+  const indexes = [];
+  const variantIds = [];
+  const componentIds = [];
+  const { variations } = context.personalize(personalization);
+  for (const v of variations) {
+    indexes.push(v.index);
+    variantIds.push({
+      id: v.id,
+      control: v.control
+    });
+    componentIds.push(v.componentId);
+  }
+  const event = {
+    name: personalization.name,
+    variantIds,
+    changed: true,
+    control: context.storage.data.controlGroup || variantIds.every((v) => v.control),
+    compositionMetadata: {
+      compositionId: compositionContext._id,
+      matchedRoute: compositionContext.matchedRoute,
+      dynamicInputs: compositionContext.dynamicInputs
+    }
+  };
+  return {
+    indexes,
+    event,
+    componentIds
+  };
+};
+
+// src/placements/evaluateTest.ts
+var evaluateTest = ({
+  test,
+  context,
+  compositionContext
+}) => {
+  var _a, _b, _c;
+  const isTestDefined = Boolean((_a = context == null ? void 0 : context.manifest.data.project.test) == null ? void 0 : _a[test.name]);
+  if (!isTestDefined && process.env.NODE_ENV !== "production") {
+    console.warn(`Test "${test}" is not defined in Uniform manifest.`);
+    return {
+      index: null,
+      componentId: null,
+      event: null
+    };
+  }
+  let index = null;
+  let variantId = null;
+  let componentId = null;
+  if (context) {
+    const { result } = context.test(test);
+    if (result) {
+      index = result.index;
+      variantId = result.id;
+      componentId = result.componentId;
+    }
+  }
+  if (!variantId) {
+    const [first] = test.variations;
+    if (first) {
+      index = first.index;
+      variantId = first.id;
+      componentId = first.componentId;
+    }
+  }
+  const event = {
+    name: test.name,
+    control: (_c = (_b = test.variations.find((v) => v.id === variantId)) == null ? void 0 : _b.control) != null ? _c : false,
+    variantAssigned: true,
+    variantId: variantId != null ? variantId : "NO_VARIANTS",
+    compositionMetadata: {
+      compositionId: compositionContext._id,
+      matchedRoute: compositionContext.matchedRoute,
+      dynamicInputs: compositionContext.dynamicInputs
+    }
+  };
+  return {
+    index,
+    componentId,
+    event
+  };
+};
+
+// src/placements/extractPersonalizationName.ts
+var extractPersonalizationName = ({
+  component
+}) => {
+  var _a;
+  const trackingEventNameParameter = (_a = component.parameters) == null ? void 0 : _a.trackingEventName;
+  return (trackingEventNameParameter == null ? void 0 : trackingEventNameParameter.value) || "unknown";
+};
+
+// src/placements/extractTestName.ts
+var extractTestName = ({ component }) => {
+  var _a, _b;
+  const testName = (_a = component.parameters) == null ? void 0 : _a.test;
+  return (_b = testName == null ? void 0 : testName.value) != null ? _b : "unknown";
+};
+
+// src/serialization.ts
+import { v5 } from "uuid";
+var ENCODED_RESERVED_CHARACTERS = [
+  {
+    character: "/",
+    replacement: "_"
+  },
+  {
+    character: "+",
+    replacement: "-"
+  }
+];
+var isNotARegularUuid = (id) => {
+  return id.length !== 36;
+};
+var resolveComponentFromPageState = ({
+  pageState,
+  componentId: providedComponentId
+}) => {
+  const componentId = isNotARegularUuid(providedComponentId) ? v5(providedComponentId, NAMESPACE_UUID) : providedComponentId;
+  let component = pageState.components[componentId];
+  if (!component) {
+    const componentIds = Object.keys(pageState.components);
+    for (let i = 0; i < componentIds.length; i++) {
+      const id = componentIds[i];
+      if (componentId.startsWith(id)) {
+        component = pageState.components[id];
+        break;
+      }
+    }
+  }
+  return component;
+};
+var getRuleId = (rule) => {
+  return v5(JSON.stringify(rule), NAMESPACE_UUID);
+};
+var resolveRuleFromPageState = ({
+  pageState,
+  rule
+}) => {
+  if (!pageState.rules) {
+    return void 0;
+  }
+  const ruleId = getRuleId(rule);
+  let value = pageState.rules[ruleId];
+  if (typeof value === "undefined") {
+    const ruleIds = Object.keys(pageState.rules);
+    for (let i = 0; i < ruleIds.length; i++) {
+      const id = ruleIds[i];
+      if (ruleId.startsWith(id)) {
+        value = pageState.rules[id];
+        break;
+      }
+    }
+  }
+  return value;
+};
+var replaceReservedCharacters = (value) => {
+  return ENCODED_RESERVED_CHARACTERS.reduce((acc, char) => {
+    return acc.replaceAll(char.character, char.replacement);
+  }, value);
+};
+var unreplaceReservedCharacters = (value) => {
+  return ENCODED_RESERVED_CHARACTERS.reduce((acc, char) => {
+    return acc.replaceAll(char.replacement, char.character);
+  }, value);
+};
+var encodeWithReplacements = (value) => {
+  return replaceReservedCharacters(btoa(value));
+};
+var decodeWithReplacements = (value) => {
+  const urlDecoded = decodeURIComponent(value);
+  return atob(unreplaceReservedCharacters(urlDecoded));
+};
+var compressIds = (ids) => {
+  const uuidV4Length = 36;
+  let compressedRegistry;
+  for (let i = 0; i < uuidV4Length; i++) {
+    const registry = {};
+    let success = true;
+    for (let j = 0; j < ids.length; j++) {
+      const listId = ids[j];
+      const id = listId.slice(0, i + 1);
+      if (registry[id]) {
+        success = false;
+        break;
+      }
+      registry[id] = listId;
+    }
+    if (success) {
+      compressedRegistry = registry;
+      break;
+    }
+  }
+  return compressedRegistry != null ? compressedRegistry : ids.reduce(
+    (acc, listId) => {
+      acc[listId] = listId;
+      return acc;
+    },
+    {}
+  );
+};
+var NAMESPACE_UUID = "00000000-0000-0000-0000-000000000000";
+var serializeEvaluationResult = ({
+  payload,
+  encode = true
+}) => {
+  const compressedPageState = {
+    cs: payload.compositionState,
+    r: payload.routePath,
+    c: {},
+    k: payload.keys,
+    ri: payload.releaseId,
+    dc: typeof payload.defaultConsent !== "undefined" ? payload.defaultConsent ? 1 : 0 : void 0,
+    pm: payload.previewMode === "editor" ? "e" : payload.previewMode === "preview" ? "p" : void 0,
+    rl: void 0
+  };
+  const componentKeys = Object.keys(payload.components);
+  const sortedKeys = componentKeys.sort();
+  const sortedComponents = sortedKeys.map((key) => ({
+    _id: isNotARegularUuid(key) ? v5(key, NAMESPACE_UUID) : key,
+    ...payload.components[key]
+  }));
+  const compressedComponentIds = compressIds(sortedComponents.map((c) => c._id));
+  Object.keys(compressedComponentIds).forEach((compressedId) => {
+    var _a;
+    const originalId = compressedComponentIds[compressedId];
+    const component = sortedComponents.find((c) => c._id === originalId);
+    if (!component) {
+      throw new Error(`Component ${originalId} not found`);
+    }
+    compressedPageState.c[compressedId] = {
+      i: ((_a = component.indexes) == null ? void 0 : _a.length) ? component.indexes : void 0
+    };
+  });
+  if (typeof payload.rules !== "undefined") {
+    const ruleKeys = Object.keys(payload.rules);
+    if (ruleKeys.length !== 0) {
+      compressedPageState.rl = {};
+      const sortedRuleKeys = ruleKeys.sort();
+      const compressedRuleKeys = compressIds(sortedRuleKeys);
+      Object.keys(compressedRuleKeys).forEach((compressedId) => {
+        const originalId = compressedRuleKeys[compressedId];
+        compressedPageState.rl[compressedId] = payload.rules[originalId] ? 1 : 0;
+      });
+    }
+  }
+  const result = JSON.stringify(compressedPageState);
+  return encode ? encodeWithReplacements(result) : result;
+};
+var deserializeEvaluationResult = ({
+  input: providedInput,
+  decode = true
+}) => {
+  var _a, _b;
+  const input = decode ? decodeWithReplacements(providedInput) : providedInput;
+  const parsed = JSON.parse(input);
+  const pageState = {
+    compositionState: parsed.cs,
+    routePath: parsed.r,
+    components: {},
+    keys: (_a = parsed.k) != null ? _a : {},
+    releaseId: (_b = parsed.ri) != null ? _b : void 0,
+    defaultConsent: typeof parsed.dc !== "undefined" ? parsed.dc === 1 : void 0,
+    previewMode: parsed.pm === "e" ? "editor" : parsed.pm === "p" ? "preview" : void 0,
+    rules: parsed.rl ? Object.fromEntries(Object.entries(parsed.rl).map(([key, value]) => [key, value === 1])) : void 0
+  };
+  Object.keys(parsed.c).forEach((id) => {
+    const component = parsed.c[id];
+    pageState.components[id] = {
+      indexes: component.i
+    };
+  });
+  return pageState;
+};
+
+// src/index.ts
+var UNIFORM_MIDDLEWARE_SCORE_COOKIE_NAME = "ufsc";
+var UNIFORM_MIDDLEWARE_QUIRK_COOKIE_NAME = "ufqc";
+export {
+  UNIFORM_MIDDLEWARE_QUIRK_COOKIE_NAME,
+  UNIFORM_MIDDLEWARE_SCORE_COOKIE_NAME,
+  deserializeEvaluationResult,
+  evaluatePersonalization,
+  evaluateTest,
+  extractPersonalizationName,
+  extractTestName,
+  getRuleId,
+  resolveComponentFromPageState,
+  resolveRuleFromPageState,
+  serializeEvaluationResult
+};

package/dist/index.js

@@ -0,0 +1,334 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  UNIFORM_MIDDLEWARE_QUIRK_COOKIE_NAME: () => UNIFORM_MIDDLEWARE_QUIRK_COOKIE_NAME,
+  UNIFORM_MIDDLEWARE_SCORE_COOKIE_NAME: () => UNIFORM_MIDDLEWARE_SCORE_COOKIE_NAME,
+  deserializeEvaluationResult: () => deserializeEvaluationResult,
+  evaluatePersonalization: () => evaluatePersonalization,
+  evaluateTest: () => evaluateTest,
+  extractPersonalizationName: () => extractPersonalizationName,
+  extractTestName: () => extractTestName,
+  getRuleId: () => getRuleId,
+  resolveComponentFromPageState: () => resolveComponentFromPageState,
+  resolveRuleFromPageState: () => resolveRuleFromPageState,
+  serializeEvaluationResult: () => serializeEvaluationResult
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/placements/evaluatePersonalization.ts
+var evaluatePersonalization = ({
+  personalization,
+  context,
+  compositionContext
+}) => {
+  const indexes = [];
+  const variantIds = [];
+  const componentIds = [];
+  const { variations } = context.personalize(personalization);
+  for (const v of variations) {
+    indexes.push(v.index);
+    variantIds.push({
+      id: v.id,
+      control: v.control
+    });
+    componentIds.push(v.componentId);
+  }
+  const event = {
+    name: personalization.name,
+    variantIds,
+    changed: true,
+    control: context.storage.data.controlGroup || variantIds.every((v) => v.control),
+    compositionMetadata: {
+      compositionId: compositionContext._id,
+      matchedRoute: compositionContext.matchedRoute,
+      dynamicInputs: compositionContext.dynamicInputs
+    }
+  };
+  return {
+    indexes,
+    event,
+    componentIds
+  };
+};
+
+// src/placements/evaluateTest.ts
+var evaluateTest = ({
+  test,
+  context,
+  compositionContext
+}) => {
+  var _a, _b, _c;
+  const isTestDefined = Boolean((_a = context == null ? void 0 : context.manifest.data.project.test) == null ? void 0 : _a[test.name]);
+  if (!isTestDefined && process.env.NODE_ENV !== "production") {
+    console.warn(`Test "${test}" is not defined in Uniform manifest.`);
+    return {
+      index: null,
+      componentId: null,
+      event: null
+    };
+  }
+  let index = null;
+  let variantId = null;
+  let componentId = null;
+  if (context) {
+    const { result } = context.test(test);
+    if (result) {
+      index = result.index;
+      variantId = result.id;
+      componentId = result.componentId;
+    }
+  }
+  if (!variantId) {
+    const [first] = test.variations;
+    if (first) {
+      index = first.index;
+      variantId = first.id;
+      componentId = first.componentId;
+    }
+  }
+  const event = {
+    name: test.name,
+    control: (_c = (_b = test.variations.find((v) => v.id === variantId)) == null ? void 0 : _b.control) != null ? _c : false,
+    variantAssigned: true,
+    variantId: variantId != null ? variantId : "NO_VARIANTS",
+    compositionMetadata: {
+      compositionId: compositionContext._id,
+      matchedRoute: compositionContext.matchedRoute,
+      dynamicInputs: compositionContext.dynamicInputs
+    }
+  };
+  return {
+    index,
+    componentId,
+    event
+  };
+};
+
+// src/placements/extractPersonalizationName.ts
+var extractPersonalizationName = ({
+  component
+}) => {
+  var _a;
+  const trackingEventNameParameter = (_a = component.parameters) == null ? void 0 : _a.trackingEventName;
+  return (trackingEventNameParameter == null ? void 0 : trackingEventNameParameter.value) || "unknown";
+};
+
+// src/placements/extractTestName.ts
+var extractTestName = ({ component }) => {
+  var _a, _b;
+  const testName = (_a = component.parameters) == null ? void 0 : _a.test;
+  return (_b = testName == null ? void 0 : testName.value) != null ? _b : "unknown";
+};
+
+// src/serialization.ts
+var import_uuid = require("uuid");
+var ENCODED_RESERVED_CHARACTERS = [
+  {
+    character: "/",
+    replacement: "_"
+  },
+  {
+    character: "+",
+    replacement: "-"
+  }
+];
+var isNotARegularUuid = (id) => {
+  return id.length !== 36;
+};
+var resolveComponentFromPageState = ({
+  pageState,
+  componentId: providedComponentId
+}) => {
+  const componentId = isNotARegularUuid(providedComponentId) ? (0, import_uuid.v5)(providedComponentId, NAMESPACE_UUID) : providedComponentId;
+  let component = pageState.components[componentId];
+  if (!component) {
+    const componentIds = Object.keys(pageState.components);
+    for (let i = 0; i < componentIds.length; i++) {
+      const id = componentIds[i];
+      if (componentId.startsWith(id)) {
+        component = pageState.components[id];
+        break;
+      }
+    }
+  }
+  return component;
+};
+var getRuleId = (rule) => {
+  return (0, import_uuid.v5)(JSON.stringify(rule), NAMESPACE_UUID);
+};
+var resolveRuleFromPageState = ({
+  pageState,
+  rule
+}) => {
+  if (!pageState.rules) {
+    return void 0;
+  }
+  const ruleId = getRuleId(rule);
+  let value = pageState.rules[ruleId];
+  if (typeof value === "undefined") {
+    const ruleIds = Object.keys(pageState.rules);
+    for (let i = 0; i < ruleIds.length; i++) {
+      const id = ruleIds[i];
+      if (ruleId.startsWith(id)) {
+        value = pageState.rules[id];
+        break;
+      }
+    }
+  }
+  return value;
+};
+var replaceReservedCharacters = (value) => {
+  return ENCODED_RESERVED_CHARACTERS.reduce((acc, char) => {
+    return acc.replaceAll(char.character, char.replacement);
+  }, value);
+};
+var unreplaceReservedCharacters = (value) => {
+  return ENCODED_RESERVED_CHARACTERS.reduce((acc, char) => {
+    return acc.replaceAll(char.replacement, char.character);
+  }, value);
+};
+var encodeWithReplacements = (value) => {
+  return replaceReservedCharacters(btoa(value));
+};
+var decodeWithReplacements = (value) => {
+  const urlDecoded = decodeURIComponent(value);
+  return atob(unreplaceReservedCharacters(urlDecoded));
+};
+var compressIds = (ids) => {
+  const uuidV4Length = 36;
+  let compressedRegistry;
+  for (let i = 0; i < uuidV4Length; i++) {
+    const registry = {};
+    let success = true;
+    for (let j = 0; j < ids.length; j++) {
+      const listId = ids[j];
+      const id = listId.slice(0, i + 1);
+      if (registry[id]) {
+        success = false;
+        break;
+      }
+      registry[id] = listId;
+    }
+    if (success) {
+      compressedRegistry = registry;
+      break;
+    }
+  }
+  return compressedRegistry != null ? compressedRegistry : ids.reduce(
+    (acc, listId) => {
+      acc[listId] = listId;
+      return acc;
+    },
+    {}
+  );
+};
+var NAMESPACE_UUID = "00000000-0000-0000-0000-000000000000";
+var serializeEvaluationResult = ({
+  payload,
+  encode = true
+}) => {
+  const compressedPageState = {
+    cs: payload.compositionState,
+    r: payload.routePath,
+    c: {},
+    k: payload.keys,
+    ri: payload.releaseId,
+    dc: typeof payload.defaultConsent !== "undefined" ? payload.defaultConsent ? 1 : 0 : void 0,
+    pm: payload.previewMode === "editor" ? "e" : payload.previewMode === "preview" ? "p" : void 0,
+    rl: void 0
+  };
+  const componentKeys = Object.keys(payload.components);
+  const sortedKeys = componentKeys.sort();
+  const sortedComponents = sortedKeys.map((key) => ({
+    _id: isNotARegularUuid(key) ? (0, import_uuid.v5)(key, NAMESPACE_UUID) : key,
+    ...payload.components[key]
+  }));
+  const compressedComponentIds = compressIds(sortedComponents.map((c) => c._id));
+  Object.keys(compressedComponentIds).forEach((compressedId) => {
+    var _a;
+    const originalId = compressedComponentIds[compressedId];
+    const component = sortedComponents.find((c) => c._id === originalId);
+    if (!component) {
+      throw new Error(`Component ${originalId} not found`);
+    }
+    compressedPageState.c[compressedId] = {
+      i: ((_a = component.indexes) == null ? void 0 : _a.length) ? component.indexes : void 0
+    };
+  });
+  if (typeof payload.rules !== "undefined") {
+    const ruleKeys = Object.keys(payload.rules);
+    if (ruleKeys.length !== 0) {
+      compressedPageState.rl = {};
+      const sortedRuleKeys = ruleKeys.sort();
+      const compressedRuleKeys = compressIds(sortedRuleKeys);
+      Object.keys(compressedRuleKeys).forEach((compressedId) => {
+        const originalId = compressedRuleKeys[compressedId];
+        compressedPageState.rl[compressedId] = payload.rules[originalId] ? 1 : 0;
+      });
+    }
+  }
+  const result = JSON.stringify(compressedPageState);
+  return encode ? encodeWithReplacements(result) : result;
+};
+var deserializeEvaluationResult = ({
+  input: providedInput,
+  decode = true
+}) => {
+  var _a, _b;
+  const input = decode ? decodeWithReplacements(providedInput) : providedInput;
+  const parsed = JSON.parse(input);
+  const pageState = {
+    compositionState: parsed.cs,
+    routePath: parsed.r,
+    components: {},
+    keys: (_a = parsed.k) != null ? _a : {},
+    releaseId: (_b = parsed.ri) != null ? _b : void 0,
+    defaultConsent: typeof parsed.dc !== "undefined" ? parsed.dc === 1 : void 0,
+    previewMode: parsed.pm === "e" ? "editor" : parsed.pm === "p" ? "preview" : void 0,
+    rules: parsed.rl ? Object.fromEntries(Object.entries(parsed.rl).map(([key, value]) => [key, value === 1])) : void 0
+  };
+  Object.keys(parsed.c).forEach((id) => {
+    const component = parsed.c[id];
+    pageState.components[id] = {
+      indexes: component.i
+    };
+  });
+  return pageState;
+};
+
+// src/index.ts
+var UNIFORM_MIDDLEWARE_SCORE_COOKIE_NAME = "ufsc";
+var UNIFORM_MIDDLEWARE_QUIRK_COOKIE_NAME = "ufqc";
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  UNIFORM_MIDDLEWARE_QUIRK_COOKIE_NAME,
+  UNIFORM_MIDDLEWARE_SCORE_COOKIE_NAME,
+  deserializeEvaluationResult,
+  evaluatePersonalization,
+  evaluateTest,
+  extractPersonalizationName,
+  extractTestName,
+  getRuleId,
+  resolveComponentFromPageState,
+  resolveRuleFromPageState,
+  serializeEvaluationResult
+});