Revision control
Copy as Markdown
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
*/
use serde::{Deserialize, Serialize};
// Locales supported by Merino Curated Recommendations
#[derive(Debug, Serialize, PartialEq, uniffi::Enum)]
pub enum Locale {
#[serde(rename = "fr")]
Fr,
#[serde(rename = "fr-FR")]
FrFr,
#[serde(rename = "es")]
Es,
#[serde(rename = "es-ES")]
EsEs,
#[serde(rename = "it")]
It,
#[serde(rename = "it-IT")]
ItIt,
#[serde(rename = "en")]
En,
#[serde(rename = "en-CA")]
EnCa,
#[serde(rename = "en-GB")]
EnGb,
#[serde(rename = "en-US")]
EnUs,
#[serde(rename = "de")]
De,
#[serde(rename = "de-DE")]
DeDe,
#[serde(rename = "de-AT")]
DeAt,
#[serde(rename = "de-CH")]
DeCh,
}
// Configuration settings for a Section
#[derive(Debug, Serialize, Deserialize, PartialEq, uniffi::Record)]
pub struct SectionSettings {
#[serde(rename = "sectionId")]
pub section_id: String,
#[serde(rename = "isFollowed")]
pub is_followed: bool,
#[serde(rename = "isBlocked")]
pub is_blocked: bool,
}
// Information required to request curated recommendations
#[derive(Debug, Serialize, PartialEq, uniffi::Record)]
pub struct CuratedRecommendationsRequest {
pub locale: Locale,
#[uniffi(default = None)]
pub region: Option<String>,
#[uniffi(default = "Some(100)")]
pub count: Option<i32>,
#[uniffi(default = None)]
pub topics: Option<Vec<String>>,
#[uniffi(default = None)]
pub feeds: Option<Vec<String>>,
#[uniffi(default = None)]
pub sections: Option<Vec<SectionSettings>>,
#[serde(rename = "experimentName")]
#[uniffi(default = None)]
pub experiment_name: Option<String>,
#[serde(rename = "experimentBranch")]
#[uniffi(default = None)]
pub experiment_branch: Option<String>,
#[serde(rename = "enableInterestPicker")]
#[uniffi(default = false)]
pub enable_interest_picker: bool,
}
// Response schema for a list of curated recommendations
#[derive(Debug, Deserialize, PartialEq, uniffi::Record)]
pub struct CuratedRecommendationsResponse {
#[serde(rename = "recommendedAt")]
pub recommended_at: i64,
pub data: Vec<RecommendationDataItem>,
#[uniffi(default = None)]
pub feeds: Option<Feeds>,
#[serde(rename = "interestPicker")]
#[uniffi(default = None)]
pub interest_picker: Option<InterestPicker>,
}
#[derive(Debug, Deserialize, PartialEq, uniffi::Record)]
pub struct InterestPicker {
#[serde(rename = "receivedFeedRank")]
pub received_feed_rank: i32,
pub title: String,
pub subtitle: String,
pub sections: Vec<InterestPickerSection>,
}
#[derive(Debug, Deserialize, PartialEq, uniffi::Record)]
pub struct InterestPickerSection {
#[serde(rename = "sectionId")]
pub section_id: String,
}
// Multiple list of curated recommendations
#[derive(Debug, Deserialize, PartialEq, uniffi::Record)]
pub struct Feeds {
#[uniffi(default = None)]
pub need_to_know: Option<CuratedRecommendationsBucket>,
#[uniffi(default = None)]
pub fakespot: Option<FakespotFeed>,
#[uniffi(default = None)]
pub top_stories_section: Option<FeedSection>,
#[uniffi(default = None)]
pub business: Option<FeedSection>,
#[uniffi(default = None)]
pub career: Option<FeedSection>,
#[uniffi(default = None)]
pub arts: Option<FeedSection>,
#[uniffi(default = None)]
pub food: Option<FeedSection>,
#[uniffi(default = None)]
pub health: Option<FeedSection>,
#[uniffi(default = None)]
pub home: Option<FeedSection>,
#[uniffi(default = None)]
pub finance: Option<FeedSection>,
#[uniffi(default = None)]
pub government: Option<FeedSection>,
#[uniffi(default = None)]
pub sports: Option<FeedSection>,
#[uniffi(default = None)]
pub tech: Option<FeedSection>,
#[uniffi(default = None)]
pub travel: Option<FeedSection>,
#[uniffi(default = None)]
pub education: Option<FeedSection>,
#[uniffi(default = None)]
pub hobbies: Option<FeedSection>,
#[serde(rename = "society-parenting")]
#[uniffi(default = None)]
pub society_parenting: Option<FeedSection>,
#[serde(rename = "education-science")]
#[uniffi(default = None)]
pub education_science: Option<FeedSection>,
#[uniffi(default = None)]
pub society: Option<FeedSection>,
}
// Curated Recommendation Information
#[derive(Debug, Deserialize, PartialEq, uniffi::Record)]
pub struct RecommendationDataItem {
#[serde(rename = "corpusItemId")]
pub corpus_item_id: String,
#[serde(rename = "scheduledCorpusItemId")]
pub schdeuled_corpus_item_id: String,
pub url: String,
pub title: String,
pub excerpt: String,
#[uniffi(default = None)]
pub topic: Option<String>,
pub publisher: String,
#[serde(rename = "isTimeSensitive")]
pub is_time_sensitive: bool,
#[serde(rename = "imageUrl")]
pub image_url: String,
#[serde(rename = "iconUrl")]
pub icon_url: Option<String>,
#[serde(rename = "tileId")]
pub tile_id: i64,
#[serde(rename = "receivedRank")]
pub received_rank: i64,
}
// Ranked list of curated recommendations
#[derive(Debug, Deserialize, PartialEq, uniffi::Record)]
pub struct CuratedRecommendationsBucket {
pub recommendations: Vec<RecommendationDataItem>,
#[uniffi(default = None)]
pub title: Option<String>,
}
// Fakespot product reccomendations
#[derive(Debug, Deserialize, PartialEq, uniffi::Record)]
pub struct FakespotFeed {
pub products: Vec<FakespotProduct>,
#[serde(rename = "defaultCategoryName")]
pub default_category_name: String,
#[serde(rename = "headerCopy")]
pub header_copy: String,
#[serde(rename = "footerCopy")]
pub footer_copy: String,
pub cta: FakespotCta,
}
// Fakespot product details
#[derive(Debug, Deserialize, PartialEq, uniffi::Record)]
pub struct FakespotProduct {
id: String,
title: String,
category: String,
#[serde(rename = "imageUrl")]
image_url: String,
url: String,
}
// Fakespot CTA
#[derive(Debug, Deserialize, PartialEq, uniffi::Record)]
pub struct FakespotCta {
#[serde(rename = "ctaCopy")]
pub cta_copy: String,
pub url: String,
}
// Ranked list of curated recommendations with responsive layout configs
#[derive(Debug, Deserialize, PartialEq, uniffi::Record)]
pub struct FeedSection {
#[serde(rename = "receivedFeedRank")]
pub received_feed_rank: i32,
pub recommendations: Vec<RecommendationDataItem>,
pub title: String,
#[uniffi(default = None)]
pub subtitle: Option<String>,
pub layout: Layout,
#[serde(rename = "isFollowed")]
pub is_followed: bool,
#[serde(rename = "isBlocked")]
pub is_blocked: bool,
}
// Representation of a responsive layout configuration with multiple column layouts
#[derive(Debug, Deserialize, PartialEq, uniffi::Record)]
pub struct Layout {
pub name: String,
#[serde(rename = "responsiveLayouts")]
pub responsive_layouts: Vec<ResponsiveLayout>,
}
// Layout configurations within a column
#[derive(Debug, Deserialize, PartialEq, uniffi::Record)]
pub struct ResponsiveLayout {
#[serde(rename = "columnCount")]
pub column_count: i32,
pub tiles: Vec<Tile>,
}
// Properties for a single tile in a responsive layout
#[derive(Debug, Deserialize, PartialEq, uniffi::Record)]
pub struct Tile {
pub size: String,
pub position: i32,
#[serde(rename = "hasAd")]
pub has_ad: bool,
#[serde(rename = "hasExcerpt")]
pub has_excerpt: bool,
}