@adobe/alloy 2.31.1 → 2.31.2-beta.0

package/libEs5/components/RulesEngine/createEventRegistry.js

@@ -1,163 +0,0 @@
-"use strict";
-
-exports.default = void 0;
-var _index = require("./utils/index.js");
-var _eventType = require("../../constants/eventType.js");
-var _decisionProvider = require("../../constants/decisionProvider.js");
-var _index2 = require("./constants/index.js");
-/*
-Copyright 2023 Adobe. All rights reserved.
-This file is licensed to you under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License. You may obtain a copy
-of the License at http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software distributed under
-the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
-OF ANY KIND, either express or implied. See the License for the specific language
-governing permissions and limitations under the License.
-*/
-/** @import { EventData, EventPayload, EventRecord, EventRegistry } from './types.js' */
-/**
- * Creates an event registry to track and manage events
- * @param {Object} options - The options object
- * @param {Object} options.storage - The storage object used to persist events
- * @param {Object} options.logger - The logger object used for logging
- * @returns {Object} The event registry interface
- */
-var _default = ({
-  storage,
-  logger
-}) => {
-  let currentStorage = storage;
-  let save;
-
-  /** @type {EventRegistry} */
-  let eventRegistry;
-
-  /** @type {number} */
-  let eventRegistrySize;
-
-  /**
-   * Sets a new storage object for the event registry
-   * @param {Object} newStorage
-   */
-  const setStorage = newStorage => {
-    currentStorage = newStorage;
-    const restore = (0, _index.createRestoreStorage)(currentStorage, _index2.EVENT_HISTORY_STORAGE_KEY);
-    save = (0, _index.createSaveStorage)(currentStorage, _index2.EVENT_HISTORY_STORAGE_KEY);
-    [eventRegistry, eventRegistrySize] = restore({});
-    if (eventRegistrySize > _index2.EVENT_HISTORY_MAX_LENGTH) {
-      const eventPruner = (0, _index.createEventPruner)();
-      eventRegistry = eventPruner(eventRegistry);
-      save(eventRegistry);
-    }
-  };
-  setStorage(storage);
-
-  /**
-   * Adds a single event to the event registry
-   * @param {EventData} event
-   * @param {string} operation
-   * @returns {EventRecord|undefined}
-   */
-  const addEvent = (event = {
-    eventType: null,
-    eventId: null
-  }, operation = _index2.INSERT_OPERATION) => {
-    const {
-      eventType,
-      eventId
-    } = event;
-    if (!eventType || !eventId) {
-      return undefined;
-    }
-    const eventHash = (0, _index.generateEventHash)(event);
-    if (operation === _index2.INSERT_IF_NOT_EXISTS_OPERATION && eventRegistry[eventHash]) {
-      return undefined;
-    }
-    if (!eventRegistry[eventHash] || !Array.isArray(eventRegistry[eventHash].timestamps)) {
-      eventRegistry[eventHash] = {
-        timestamps: []
-      };
-    }
-    const timestamp = new Date().getTime();
-    eventRegistry[eventHash].timestamps.push(timestamp);
-    eventRegistry[eventHash].timestamps.sort();
-    logger.info("[Event History] Added event for", event, "with hash", eventHash, "and timestamp", timestamp);
-    save(eventRegistry);
-    return eventRegistry[eventHash];
-  };
-
-  /**
-   * Adds multiple events to the event registry
-   * @param {Array<EventPayload>} eventPayloads
-   * @returns {Array<EventRecord>}
-   */
-  const addEventPayloads = (eventPayloads = []) => eventPayloads.map(({
-    operation,
-    event
-  }) => addEvent(event, operation));
-
-  /**
-   * Processes and adds Experience Edge events to the registry
-   * @param {Object} event - The Experience Edge event object
-   * @returns {void}
-   */
-  const addExperienceEdgeEvent = event => {
-    const {
-      xdm
-    } = event.getContent();
-    if (!(0, _index.hasExperienceData)(xdm)) {
-      return;
-    }
-    const {
-      _experience: {
-        decisioning: {
-          propositionEventType = {},
-          propositionAction: {
-            id: action
-          } = {},
-          propositions = []
-        } = {}
-      }
-    } = xdm;
-    Object.keys(propositionEventType).filter(eventType => propositionEventType[eventType] === _eventType.EVENT_TYPE_TRUE).forEach(eventType => {
-      propositions.forEach(proposition => {
-        if ((0, _index.getDecisionProvider)(proposition) !== _decisionProvider.ADOBE_JOURNEY_OPTIMIZER) {
-          return;
-        }
-        addEvent({
-          eventId: (0, _index.getActivityId)(proposition),
-          eventType,
-          action
-        });
-      });
-    });
-  };
-
-  /**
-   * Retrieves an event from the registry based on type and ID
-   * @param {string} eventType - The type of the event to retrieve
-   * @param {string} eventId - The ID of the event to retrieve
-   * @returns {EventRecord|undefined} The event object if found, otherwise undefined
-   */
-  const getEvent = (eventType, eventId) => {
-    const h = (0, _index.generateEventHash)({
-      eventType,
-      eventId
-    });
-    if (!eventRegistry[h]) {
-      return undefined;
-    }
-    return eventRegistry[h];
-  };
-  return {
-    addExperienceEdgeEvent,
-    addEvent,
-    addEventPayloads,
-    getEvent,
-    toJSON: () => eventRegistry,
-    setStorage
-  };
-};
-exports.default = _default;

package/libEs5/components/RulesEngine/createOnResponseHandler.js

@@ -1,49 +0,0 @@
-"use strict";
-
-exports.default = void 0;
-var _decisionProvider = require("../../constants/decisionProvider.js");
-var _flattenObject = require("../../utils/flattenObject.js");
-/*
-Copyright 2023 Adobe. All rights reserved.
-This file is licensed to you under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License. You may obtain a copy
-of the License at http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software distributed under
-the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
-OF ANY KIND, either express or implied. See the License for the specific language
-governing permissions and limitations under the License.
-*/
-var _default = ({
-  renderDecisions,
-  decisionProvider,
-  applyResponse,
-  event,
-  personalization,
-  decisionContext
-}) => {
-  const context = {
-    ...(0, _flattenObject.default)(event.getContent()),
-    ...decisionContext
-  };
-  return ({
-    response
-  }) => {
-    decisionProvider.addPayloads(response.getPayloadsByType(_decisionProvider.PERSONALIZATION_DECISIONS_HANDLE));
-
-    // only evaluate events that include a personalization query
-    if (!event.hasQuery()) {
-      return {
-        propositions: []
-      };
-    }
-    const propositions = decisionProvider.evaluate(context);
-    return applyResponse({
-      renderDecisions,
-      propositions,
-      event,
-      personalization
-    });
-  };
-};
-exports.default = _default;

package/libEs5/components/RulesEngine/createSubscribeRulesetItems.js

@@ -1,134 +0,0 @@
-"use strict";
-
-exports.default = void 0;
-var _index = require("../../utils/validation/index.js");
-var _createSubscription = require("../../utils/createSubscription.js");
-var _propositionEventType = require("../../constants/propositionEventType.js");
-/*
-Copyright 2023 Adobe. All rights reserved.
-This file is licensed to you under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License. You may obtain a copy
-of the License at http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software distributed under
-the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
-OF ANY KIND, either express or implied. See the License for the specific language
-governing permissions and limitations under the License.
-*/
-
-const validateOptions = ({
-  options
-}) => {
-  const validator = (0, _index.objectOf)({
-    surfaces: (0, _index.arrayOf)((0, _index.string)()).uniqueItems(),
-    schemas: (0, _index.arrayOf)((0, _index.string)()).uniqueItems(),
-    callback: (0, _index.callback)().required()
-  }).noUnknownFields();
-  return validator(options);
-};
-const getAnalyticsDetail = proposition => {
-  const {
-    id,
-    scope,
-    scopeDetails
-  } = proposition;
-  return {
-    id,
-    scope,
-    scopeDetails
-  };
-};
-var _default = ({
-  collect
-}) => {
-  let emitPropositions = () => undefined;
-  const collectedEventsThisSession = new Set();
-  const shouldAlwaysCollect = propositionEventType => [_propositionEventType.PropositionEventType.INTERACT, _propositionEventType.PropositionEventType.DISMISS].includes(propositionEventType);
-  const shouldCollect = (propositionEventType, analyticsMetaId, collectedEventsThisRequest) => {
-    const eventId = [propositionEventType, analyticsMetaId].join("-");
-    const result = !collectedEventsThisRequest.has(eventId) && (shouldAlwaysCollect(propositionEventType) || !collectedEventsThisSession.has(eventId));
-    collectedEventsThisRequest.add(eventId);
-    collectedEventsThisSession.add(eventId);
-    return result;
-  };
-  const collectEvent = (propositionEventType, propositions = []) => {
-    if (!(propositions instanceof Array)) {
-      return Promise.resolve();
-    }
-    if (!Object.values(_propositionEventType.PropositionEventType).includes(propositionEventType)) {
-      return Promise.resolve();
-    }
-    const decisionsMeta = [];
-    const collectedEventsThisRequest = new Set();
-    propositions.forEach(proposition => {
-      const analyticsMeta = getAnalyticsDetail(proposition);
-      if (!shouldCollect(propositionEventType, analyticsMeta.id, collectedEventsThisRequest)) {
-        return;
-      }
-      decisionsMeta.push(analyticsMeta);
-    });
-    return decisionsMeta.length > 0 ? collect({
-      decisionsMeta,
-      eventType: (0, _propositionEventType.getEventType)(propositionEventType),
-      documentMayUnload: true
-    }) : Promise.resolve();
-  };
-  const subscriptions = (0, _createSubscription.default)();
-  const emissionPreprocessor = (params, propositions) => {
-    const {
-      surfacesFilter,
-      schemasFilter
-    } = params;
-    const result = {
-      propositions: propositions.filter(payload => surfacesFilter ? surfacesFilter.includes(payload.scope) : true).map(payload => {
-        const {
-          items = []
-        } = payload;
-        return {
-          ...payload,
-          items: items.filter(item => schemasFilter ? schemasFilter.includes(item.schema) : true)
-        };
-      }).filter(payload => payload.items.length > 0)
-    };
-    return [result, collectEvent];
-  };
-  subscriptions.setEmissionPreprocessor(emissionPreprocessor);
-  const run = ({
-    surfaces,
-    schemas,
-    callback
-  }) => {
-    const {
-      id,
-      unsubscribe
-    } = subscriptions.add(callback, {
-      surfacesFilter: surfaces instanceof Array ? surfaces : undefined,
-      schemasFilter: schemas instanceof Array ? schemas : undefined
-    });
-    emitPropositions(id);
-    return Promise.resolve({
-      unsubscribe
-    });
-  };
-  const optionsValidator = options => validateOptions({
-    options
-  });
-  const refresh = propositions => {
-    emitPropositions = subscriptionId => {
-      if (subscriptionId) {
-        subscriptions.emitOne(subscriptionId, propositions);
-        return;
-      }
-      subscriptions.emit(propositions);
-    };
-    emitPropositions();
-  };
-  return {
-    refresh,
-    command: {
-      optionsValidator,
-      run
-    }
-  };
-};
-exports.default = _default;

package/libEs5/components/RulesEngine/index.js

@@ -1,155 +0,0 @@
-"use strict";
-
-exports.default = void 0;
-var _index = require("../../utils/index.js");
-var _createOnResponseHandler = require("./createOnResponseHandler.js");
-var _createDecisionProvider = require("./createDecisionProvider.js");
-var _createApplyResponse = require("./createApplyResponse.js");
-var _createEventRegistry = require("./createEventRegistry.js");
-var _createContextProvider = require("./createContextProvider.js");
-var _createSubscribeRulesetItems = require("./createSubscribeRulesetItems.js");
-var _index2 = require("./constants/index.js");
-var _createEvaluateRulesetsCommand = require("./createEvaluateRulesetsCommand.js");
-var _storage = require("./utils/storage.js");
-var _index3 = require("../../utils/validation/index.js");
-var _createCollect = require("../../utils/createCollect.js");
-var _event = require("../../utils/event.js");
-/*
-Copyright 2023 Adobe. All rights reserved.
-This file is licensed to you under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License. You may obtain a copy
-of the License at http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software distributed under
-the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
-OF ANY KIND, either express or implied. See the License for the specific language
-governing permissions and limitations under the License.
-*/
-
-const createRulesEngine = ({
-  config,
-  eventManager,
-  createNamespacedStorage,
-  consent,
-  getBrowser,
-  logger
-}) => {
-  const {
-    orgId,
-    personalizationStorageEnabled
-  } = config;
-  const collect = (0, _createCollect.default)({
-    eventManager,
-    mergeDecisionsMeta: _event.mergeDecisionsMeta
-  });
-  const storage = createNamespacedStorage((0, _index.sanitizeOrgIdForCookieName)(orgId) + ".decisioning.");
-  if (!personalizationStorageEnabled) {
-    (0, _storage.clearLocalStorage)(storage.persistent);
-  }
-  const eventRegistry = (0, _createEventRegistry.default)({
-    storage: (0, _storage.createInMemoryStorage)(),
-    logger
-  });
-  const decisionProvider = (0, _createDecisionProvider.default)({
-    eventRegistry
-  });
-  const contextProvider = (0, _createContextProvider.default)({
-    eventRegistry,
-    window,
-    getBrowser
-  });
-  const evaluateRulesetsCommand = (0, _createEvaluateRulesetsCommand.default)({
-    contextProvider,
-    decisionProvider
-  });
-  const subscribeRulesetItems = (0, _createSubscribeRulesetItems.default)({
-    collect
-  });
-  let applyResponse;
-  return {
-    lifecycle: {
-      onDecision({
-        propositions
-      }) {
-        subscribeRulesetItems.refresh(propositions);
-      },
-      onComponentsRegistered(tools) {
-        applyResponse = (0, _createApplyResponse.default)({
-          lifecycle: tools.lifecycle,
-          eventRegistry
-        });
-        if (personalizationStorageEnabled) {
-          consent.awaitConsent().then(() => {
-            eventRegistry.setStorage(storage.persistent);
-          }).catch(() => {
-            if (storage) {
-              (0, _storage.clearLocalStorage)(storage.persistent);
-            }
-          });
-        }
-      },
-      onBeforeEvent({
-        event,
-        renderDecisions,
-        personalization = {},
-        onResponse = _index.noop
-      }) {
-        const {
-          decisionContext = {}
-        } = personalization;
-        onResponse((0, _createOnResponseHandler.default)({
-          renderDecisions,
-          decisionProvider,
-          applyResponse,
-          event,
-          personalization,
-          decisionContext: contextProvider.getContext({
-            [_index2.CONTEXT_KEY.TYPE]: _index2.CONTEXT_EVENT_TYPE.EDGE,
-            [_index2.CONTEXT_KEY.SOURCE]: _index2.CONTEXT_EVENT_SOURCE.REQUEST,
-            ...decisionContext
-          })
-        }));
-      },
-      onBeforeRequest({
-        request
-      }) {
-        const payload = request.getPayload().toJSON();
-        const {
-          events = []
-        } = payload;
-        if (events.length === 0) {
-          return;
-        }
-        events.forEach(event => eventRegistry.addExperienceEdgeEvent(event));
-      }
-    },
-    commands: {
-      evaluateRulesets: {
-        run: ({
-          renderDecisions,
-          personalization = {}
-        }) => {
-          const {
-            decisionContext = {}
-          } = personalization;
-          return evaluateRulesetsCommand.run({
-            renderDecisions,
-            decisionContext: {
-              [_index2.CONTEXT_KEY.TYPE]: _index2.CONTEXT_EVENT_TYPE.RULES_ENGINE,
-              [_index2.CONTEXT_KEY.SOURCE]: _index2.CONTEXT_EVENT_SOURCE.REQUEST,
-              ...decisionContext
-            },
-            applyResponse
-          });
-        },
-        optionsValidator: evaluateRulesetsCommand.optionsValidator
-      },
-      subscribeRulesetItems: subscribeRulesetItems.command
-    }
-  };
-};
-createRulesEngine.namespace = "RulesEngine";
-createRulesEngine.configValidators = (0, _index3.objectOf)({
-  personalizationStorageEnabled: (0, _index3.boolean)().default(false)
-});
-var _default = exports.default = createRulesEngine;

package/libEs5/components/RulesEngine/types.js

@@ -1,91 +0,0 @@
-"use strict";
-
-exports.Types = void 0;
-/*
-Copyright 2025 Adobe. All rights reserved.
-This file is licensed to you under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License. You may obtain a copy
-of the License at http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software distributed under
-the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
-OF ANY KIND, either express or implied. See the License for the specific language
-governing permissions and limitations under the License.
-*/
-
-/**
- * @typedef {Record<string, EventRecord>} EventRegistry
- */
-
-/**
- * @typedef {object} EventPayload
- * @property {string} operation
- * @property {EventData} event
- */
-
-/**
- * @typedef {Record<string, string>} EventData
- * @property {string} eventType
- * @property {string} eventId
- * @property {string} [action]
- */
-
-/**
- * @typedef {object} EventRecord
- * @property {Array<number>} timestamps
- */
-
-/**
- * @typedef {Array<Proposition>} PropositionList
- */
-
-/**
- * @typedef {Object} Proposition
- * @property {string} id
- * @property {string} scope
- * @property {ScopeDetails} scopeDetails
- * @property {Array<PropositionItem>} items
- */
-
-/**
- * @typedef {Object} ScopeDetails
- * @property {string} decisionProvider
- * @property {string} correlationID
- * @property {Characteristics} characteristics
- * @property {number} rank
- * @property {Activity} activity
- */
-
-/**
- * @typedef {Object} Characteristics
- * @property {string} eventToken
- */
-
-/**
- * @typedef {Object} Activity
- * @property {string} id
- * @property {number} priority
- * @property {Array<string>} matchedSurfaces
- */
-
-/**
- * @typedef {Object} PropositionItem
- * @property {string} schema
- * @property {EventHistoryOperationData|Object} data
- * @property {string} id
- */
-
-/**
- * @typedef {Object} EventHistoryOperationData
- * @property {string} operation
- * @property {RulesEventPayload} content
- * @property {number} qualifiedDate
- */
-
-/**
- * @typedef {Record<string, string>} RulesEventPayload
- * @property {string} iam.eventType
- * @property {string} iam.id
- */
-
-const Types = exports.Types = {};

package/libEs5/components/RulesEngine/utils/createEventPruner.js

@@ -1,57 +0,0 @@
-"use strict";
-
-exports.default = void 0;
-var _index = require("../constants/index.js");
-var _getExpirationDate = require("./getExpirationDate.js");
-/*
-Copyright 2025 Adobe. All rights reserved.
-This file is licensed to you under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License. You may obtain a copy
-of the License at http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software distributed under
-the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
-OF ANY KIND, either express or implied. See the License for the specific language
-governing permissions and limitations under the License.
-*/
-/**
- * Creates an event pruner function that filters events based on retention period and maximum count
- *
- * @param {number} [retentionPeriod=EVENT_HISTORY_RETENTION_PERIOD] - The retention period in days
- * @param {number} [limit=EVENT_HISTORY_MAX_RECORDS] - Maximum number of events to keep
- * @returns {Function} A function that takes an events object and returns a pruned version of it
- * @param {Object} events - Object containing events with timestamps
- * @returns {Object} Pruned events object with events filtered by retention period and limited to max count
- */
-var _default = (retentionPeriod = _index.EVENT_HISTORY_RETENTION_PERIOD, limit = _index.EVENT_HISTORY_MAX_RECORDS) => events => {
-  let eventsWithHash = Object.entries(events).reduce((accumulator, [key, {
-    timestamps = []
-  }]) => {
-    timestamps.forEach(timestamp => {
-      accumulator.push({
-        key,
-        timestamp
-      });
-    });
-    return accumulator;
-  }, []);
-  const expirationDate = (0, _getExpirationDate.default)(retentionPeriod);
-  eventsWithHash = eventsWithHash.filter(({
-    timestamp
-  }) => timestamp >= expirationDate);
-  eventsWithHash.sort((a, b) => a.timestamp - b.timestamp);
-  eventsWithHash = eventsWithHash.slice(-limit);
-  return eventsWithHash.reduce((accumulator, {
-    key,
-    timestamp
-  }) => {
-    if (!accumulator[key]) {
-      accumulator[key] = {
-        timestamps: []
-      };
-    }
-    accumulator[key].timestamps.push(timestamp);
-    return accumulator;
-  }, {});
-};
-exports.default = _default;

package/libEs5/components/RulesEngine/utils/extractPayloadsFromEventHistoryOperations.js

@@ -1,50 +0,0 @@
-"use strict";
-
-exports.default = void 0;
-var _schema = require("../../../constants/schema.js");
-/*
-Copyright 2025 Adobe. All rights reserved.
-This file is licensed to you under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License. You may obtain a copy
-of the License at http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software distributed under
-the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
-OF ANY KIND, either express or implied. See the License for the specific language
-governing permissions and limitations under the License.
-*/
-/** @import { PropositionList,  EventPayload } from '../types.js' */
-/**
- * Extracts event history operations from a proposition list and filters them out.
- *
- * This function processes the provided proposition list by:
- * 1. Identifying items with the EVENT_HISTORY_OPERATION schema
- * 2. Converting these items into event payloads and tie them with the operation
- * 3. Removing these items from the original propositions
- * 4. Returning an array of the extracted event payloads
- *
- * @param {PropositionList} propositionList - The list of propositions to process
- * @returns {Array<EventPayload>} Array of extracted event payloads with operation
- */
-var _default = propositionList => {
-  const result = [];
-  propositionList.forEach(proposition => {
-    const filteredItems = [];
-    proposition.items.forEach(item => {
-      if (item.schema === _schema.EVENT_HISTORY_OPERATION) {
-        result.push({
-          operation: item.data.operation,
-          event: {
-            eventId: item.data.content["iam.id"],
-            eventType: item.data.content["iam.eventType"]
-          }
-        });
-      } else {
-        filteredItems.push(item);
-      }
-    });
-    proposition.items = filteredItems;
-  });
-  return result;
-};
-exports.default = _default;