export interface PassioFoodAmount {
  /** The selected unit for the food amount. */
  selectedUnit: string
  /** The quantity of the selected unit. */
  selectedQuantity: number
  /** The weight of the food amount in grams. */
  weightGrams?: number
  /** An array of serving units available for the food. */
  servingUnits?: ServingUnit[]
  /** An array of serving sizes available for the food. */
  servingSizes?: ServingSize[]
  /** The weight of the food amount using a specified unit of mass. */
  weight: UnitMass
}

/*
 * The unit measuring the serving size of a food item
 */
export interface UnitMass {
  // The name of a unit (e.g. ounce, slice, container)
  unit: string
  // The mass of a  unit in grams (1 container = 60g)
  value: number
}

export interface PassioIngredient {
  // Reference code of Passio food item
  refCode: RefCode
  /** The name of the ingredient. */
  name: string
  /** The unique identifier of the ingredient. */
  id: string
  /** The identifier of the icon associated with the ingredient. */
  iconId: PassioID | string
  /** The weight of the ingredient. */
  weight: UnitMass
  /** The reference nutrients of the ingredient. */
  referenceNutrients: PassioNutrients
  /** The metadata associated with the ingredient. */
  metadata?: PassioFoodMetadata
  /** The amount of the ingredient. */
  amount: PassioFoodAmount
}

/*
 * The unit measuring the serving size of a food item
 */
export interface ServingUnit {
  // The name of a serving unit (e.g. ounce, slice, container)
  unitName: string
  // The mass of a serving unit in grams (1 container = 60g)
  value: number
  unit: string
}

export interface PassioFoodItem {
  // Reference code of Passio food item
  refCode: RefCode

  // Name of the food item
  name: string

  // Additional details or description of the food item
  details?: string

  // Icon identifier for the food item
  iconId: PassioID | string

  // Amount of the food item (e.g., quantity, volume)
  amount: PassioFoodAmount

  // List of ingredients used in the food item
  ingredients?: PassioIngredient[]

  // Weight of the food item, measured in units of mass
  ingredientWeight: UnitMass

  /**
   * food item credits to openfood.org when the data is coming from them
   */
  isOpenFood?: boolean

  /**
   * food item credits to openfood.org when the data is coming from them
   * Show food license name
   */
  openFoodLicense?: string

  id: string
}

export interface PassioNutrients {
  /** The weight of the nutrients. */
  weight: UnitMass
  /** The amount of vitamin A. */
  vitaminA?: UnitMass
  /** The amount of alcohol. */
  alcohol?: UnitMass
  /** The amount of calcium. */
  calcium?: UnitMass
  /** The amount of calories. */
  calories?: UnitMass
  /** The amount of carbohydrates. */
  carbs?: UnitMass
  /** The amount of cholesterol. */
  cholesterol?: UnitMass
  /** The amount of fat. */
  fat?: UnitMass
  /** The amount of dietary fiber. */
  fibers?: UnitMass
  /** The amount of iodine. */
  iodine?: UnitMass
  /** The amount of iron. */
  iron?: UnitMass
  /** The amount of magnesium. */
  magnesium?: UnitMass
  /** The amount of monounsaturated fat. */
  monounsaturatedFat?: UnitMass
  /** The amount of phosphorus. */
  phosphorus?: UnitMass
  /** The amount of polyunsaturated fat. */
  polyunsaturatedFat?: UnitMass
  /** The amount of potassium. */
  potassium?: UnitMass
  /** The amount of protein. */
  protein?: UnitMass
  /** The amount of saturated fat. */
  satFat?: UnitMass
  /** The amount of sodium. */
  sodium?: UnitMass
  /** The amount of sugar alcohol. */
  sugarAlcohol?: UnitMass
  /** The amount of sugars. */
  sugars?: UnitMass
  /** The amount of added sugars. */
  sugarsAdded?: UnitMass
  /** The amount of trans fat. */
  transFat?: UnitMass
  /** The amount of vitamin B12. */
  vitaminB12?: UnitMass
  /** The amount of added vitamin B12. */
  vitaminB12Added?: UnitMass
  /** The amount of vitamin B6. */
  vitaminB6?: UnitMass
  /** The amount of vitamin C. */
  vitaminC?: UnitMass
  /** The amount of vitamin D. */
  vitaminD?: UnitMass
  /** The amount of vitamin E. */
  vitaminE?: UnitMass
  /** The amount of added vitamin E. */
  vitaminEAdded?: UnitMass

  /** The amount of added zinc E. */
  zinc?: UnitMass
  /** The amount of added selenium. */
  selenium?: UnitMass
  /** The amount of added folicAcid. */
  folicAcid?: UnitMass
  /** The amount of added vitaminKPhylloquinone. */
  vitaminKPhylloquinone?: UnitMass
  /** The amount of added vitaminKMenaquinone4. */
  vitaminKMenaquinone4?: UnitMass
  /** The amount of added vitaminKDihydrophylloquinone. */
  vitaminKDihydrophylloquinone?: UnitMass
  /** The amount of added chromium. */
  chromium?: UnitMass
  /** The amount of added vitaminARAE. */
  vitaminARAE?: UnitMass
}

export interface PassioFoodDataInfo {
  // Property for the brand name of the food
  brandName?: string
  // Property for the name of the food
  foodName: string
  // Property for the icon ID of the food
  iconID: PassioID | string
  // Property for the label ID of the food
  labelId: string
  // Property for the nutrition preview of the food
  nutritionPreview?: PassioNutritionPreview
  // Property for the result ID of the food
  resultId: string
  // Property for the score of the food
  score?: number
  // Property for the scored name of the food
  scoredName?: string
  // Property for the type of the food
  type?: string
  // Property for indicating whether to use short name for the info
  isShortName?: boolean
  // tags
  tags?: string
}

export interface NutritionFacts {
  servingSizeQuantity?: number
  servingSizeUnitName?: string
  servingSizeUnit: ServingSizeUnit
  calories?: number
  fat?: number
  carbs?: number
  protein?: number
  saturatedFat?: number
  transFat?: number
  cholesterol?: number
  sugars?: number
  sugarAlcohol?: number
  servingSizeGram?: number
  dietaryFiber?: number
  sodium?: number
}

export interface NutritionDetectionEvent {
  nutritionFacts?: NutritionFacts
  text?: string
}

export interface DetectedCandidate {
  /**
   * The ID of the detected item
   */
  passioID: PassioID

  /**
   * Confidence of the classification candidate, ranging from 0.0 to 1.0
   */
  confidence: number

  /**
   * A box describing a detected object's location in the camera view
   */
  boundingBox: BoundingBox

  /**
   * Supported only in IOS
   * Scanned AmountEstimate
   */
  amountEstimate?: AmountEstimate

  /**
   * The nutritional data for this item in the database
   */
  foodName?: string

  /**
   * Related items above this item in the food heirarchy (more generic)
   */
  alternatives?: DetectedCandidate[] | null

  croppedImage?: ImagesInfo[] | null
}

/**
 * A UPC code captured by scanning a barcode
 */
export type Barcode = string

/**
 * A candidate resulting from barcode scanning
 */
export interface BarcodeCandidate {
  /**
   * The value of the scanned barcode
   */
  barcode: Barcode

  /**
   * A box describing the location of the barcode in the camera view
   */
  boundingBox: BoundingBox
}

/**
 * packagedFoodCode (typealias String) is the string representation of the PackagedFoodCode id
 */
export type PackagedFoodCode = string

export interface FoodCandidates {
  /**
   * Food candidate results from visual scanning. The array is sorted by confidence, with the most confident result at index 0.
   */
  detectedCandidates: DetectedCandidate[]

  /**
   * Food candidate results from barcode scanning.
   */
  barcodeCandidates?: BarcodeCandidate[]

  /**
   * Food candidate results from packagedFoodCode scanning.
   */
  packagedFoodCode?: PackagedFoodCode[]
}

export interface FoodDetectionEvent {
    /**
     * A collection of food candidates detected by the models.
     */
    candidates?: FoodCandidates;
}

/**
 * A collection of food candidates detected by the models.
 */
export interface FoodCandidates {
  /**
   * Food candidate results from visual scanning. The array is sorted by confidence, with the most confident result at index 0.
   */
  detectedCandidates: DetectedCandidate[]

  /**
   * Food candidate results from barcode scanning.
   */
  barcodeCandidates?: BarcodeCandidate[]

  /**
   * Food candidate results from packagedFoodCode scanning.
   */
  packagedFoodCode?: PackagedFoodCode[]
}