@microsoft/agents-activity/src/entity/productInfo.ts

Microsoft 365 Agents SDK for JavaScript. Activity Protocol serialization and deserialization.

/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License.
 */

import { Activity } from '../activity'
import { Entity } from './entity'

export interface ProductInfo extends Entity {
  type: 'ProductInfo';
  id: string;
}

/**
 * Remove any ProductInfo entities from the activity
 * @param activity
 */
export const clearProductInfoFromActivity = (activity: Activity): void => {
  if (activity && activity.entities && activity.entities.length) {
    activity.entities = activity.entities.filter(e => e.type !== 'ProductInfo')
  }
}

/**
 * Add a new ProductInfo entity to the activity and ensure only one exists
 * @param activity
 * @param id
 */
export const addProductInfoToActivity = (activity: Activity, id: string) : void => {
  const productInfo: ProductInfo = {
    type: 'ProductInfo',
    id
  }
  activity.entities ??= []
  clearProductInfoFromActivity(activity)
  activity.entities?.push(productInfo)
}