@20minutes/tyr 0.1.2

package/dist/index.d.ts

@@ -0,0 +1,320 @@
+/// <reference types="react" />
+import { AwsRumConfig, AwsRum } from 'aws-rum-web';
+import * as React$1 from 'react';
+import { LayoutType } from '@20minutes/hela';
+
+interface ContentDataLayerType {
+    signature?: string;
+    nbParagraphs?: number;
+    pageType?: string;
+    tags?: string;
+    article_section?: string;
+    content_id?: string;
+}
+
+interface DefaultDataLayerType {
+    page_uri: string;
+    page_type?: string;
+    libelle?: string;
+    chapter1?: string;
+    chapter2?: string;
+    chapter3?: string;
+    chapter4?: string;
+    ac?: string;
+    an?: string;
+}
+
+interface UserDataLayerType {
+    darkmode: string;
+    adblock: string;
+    referrer: string;
+    source_type: string;
+    user_status: string;
+}
+
+interface DataLayerType extends DefaultDataLayerType, UserDataLayerType, ContentDataLayerType {
+}
+
+declare type VariablesDataLayerType = ContentDataLayerType;
+
+interface AwsRumVariablesType {
+    APPLICATION_ID: string;
+    APPLICATION_VERSION: string;
+    APPLICATION_REGION: string;
+    config: AwsRumConfig;
+}
+
+declare type Slot = {
+    slotElementId: string;
+    path: string;
+    sizes: string;
+};
+
+declare enum AdSizesType {
+    HEADER_AD = "[[1,1], \"fluid\"]",
+    BAN_ATF = "[[1,1], [728,90], [970,250], [980,250], [1000,90], [1000,250], [1600,1200]]",
+    PAVE_ATF = "[[1,1], [300,250], [300,600], [600,250], [600,600], [770,250]]",
+    BAN_BTF = "[[1,1], [728,90], [970,90], [970,250], [980,250], [1000,90], [1000,250]]",
+    ARTICLE_BTF = "[[1,1], [300,168], [300,250], [320,50], [320,100], [320,480]]"
+}
+declare type AdSizesTypeKey = keyof typeof AdSizesType;
+
+declare enum pageType {
+    UNKNOWN = "Non connu",
+    SLIDESHOW_COVER = "Slideshow cover",
+    SLIDESHOW_COVER_LISTING_PAGE = "Slideshow listing page",
+    SLIDESHOW_PAGE = "Slideshow page",
+    ARTICLE = "article",
+    MISC = "divers",
+    HOME = "home",
+    LIVE = "live",
+    SECTION = "section",
+    TAG = "tag"
+}
+declare enum tagsType {
+    MISC = "divers",
+    HOME = "home",
+    LOCAL = "local",
+    PLANET = "plan\u00E8te"
+}
+declare enum TargetingKeys {
+    PAGETYPE = "pageType",
+    TAGS = "tags"
+}
+declare type Targeting = {
+    pageType: string;
+    tags: string;
+};
+
+declare type DfpDataLayerType = Targeting;
+
+declare type Purposes = 'Cookies' | 'CookiesAnalytics' | 'CookiesMarketing' | 'CookiesSocial' | 'AdvertisingPersonalization' | 'CookiesMarketing' | 'Analytics' | 'ContentPersonalization' | 'AdDelivery' | 'DeviceAccess' | 'OfflineMatch' | 'LinkDevices' | 'PreciseGeo' | 'SelectBasicAds' | 'CreateAdsProfile' | 'SelectPersonalizedAds' | 'CreateContentProfile' | 'SelectPersonalizedContent' | 'MeasureAdPerformance' | 'MeasureContentPerformance' | 'MarketResearch' | 'ImproveProducts' | 'mesureda-6qyqaZXC' | 'publicite-Nfb9aWMW';
+declare type PurposesList = {
+    [key in Purposes]: string;
+};
+declare type Notice = {
+    show: () => void;
+};
+interface Didomi {
+    CCPA: string[];
+    Purposes: PurposesList;
+    notice: Notice;
+    preferences: string[];
+    theme: string[];
+    version: string;
+    getUserConsentStatusForPurpose: (purpose: Purposes) => boolean;
+    reset: () => void;
+}
+declare type DidomiOnReady = (() => void)[];
+declare type EventListener = {
+    event: string;
+    listener: () => void;
+};
+declare type DidomiEventListeners = EventListener[];
+declare type CmpType = {
+    consentEventsCount: number;
+};
+
+declare type VariablesCmpType = {
+    Didomi: Didomi;
+    didomiOnReady: DidomiOnReady;
+    disapproveDidomiGTMEvents: boolean;
+    didomiEventListeners: DidomiEventListeners;
+};
+
+declare type Privacy = {
+    setVisitorMode: (authority: string, mode: string) => void;
+    getVisitorMode: () => Record<string, unknown>;
+    setVisitorOptin: () => void;
+};
+declare type CustomVars = {
+    set: (arg0: {
+        site: Record<number, unknown>;
+    }) => void;
+};
+declare type Props = Record<string, string | boolean>;
+declare type IdentifiedVisitor = {
+    set: (arg0: Record<string, unknown>) => void;
+};
+declare type PageDefaultKeys = {
+    name: string;
+    chapter1: string;
+    chapter2: string;
+    chapter3: string;
+    customObject: {
+        device: string;
+    };
+};
+declare type Tag = {
+    privacy: Privacy;
+    identifiedVisitor: IdentifiedVisitor;
+    customVars: CustomVars;
+    page: {
+        set: (pageDefaultKeys: PageDefaultKeys) => void;
+    };
+    setProps: (props: Props, persistent: boolean) => void;
+    dispatch: () => void;
+};
+interface TagConstructor {
+    new (): Tag;
+}
+interface Tracker {
+    Tag: TagConstructor;
+    instances: Tag[];
+}
+declare type ATInternetType = {
+    Tracker?: Tracker;
+    onTrackerLoad: () => void;
+};
+
+declare global {
+    interface Window extends VariablesDataLayerType, VariablesCmpType {
+        datalayer: Partial<DataLayerType>;
+        gtmDatalayer: Record<number, unknown>;
+        awsRumVariables: AwsRumVariablesType;
+        dfpVariables: DfpDataLayerType;
+        awsRum?: AwsRum;
+        dfp: {
+            slotsReady: boolean;
+            slots: Slot[];
+            targeting: Partial<Targeting>;
+        } | Record<string, never>;
+        cmpVariables: CmpType;
+        ATInternet: ATInternetType;
+    }
+}
+
+declare const enum ComponentNameCommon {
+    COMMON_HEADER = "common/header",
+    COMMON_FOOTER = "common/footer",
+    COMMON_NEWSLETTER = "common/newsletter"
+}
+declare const enum ComponentNameRubric {
+    RUBRIC_CATEGORY_CARDS = "rubric/category-cards",
+    RUBRIC_NEWS_CARDS = "rubric/news-cards",
+    RUBRIC_MOST_READ_ARTICLES = "rubric/most-read-articles",
+    RUBRIC_PARTNER_CARDS = "rubric/partner-cards",
+    ARTICLE_SCROLL_PROGRESS_BAR = "rubric/scroll-progress-bar"
+}
+declare const enum ComponentNameArticle {
+    ARTICLE_BREADCRUMB = "article/breadcrumb",
+    ARTICLE_OVERVIEW_BAR = "article/overview-bar",
+    ARTICLE_HEADER = "article/article-header",
+    ARTICLE_IMAGE_COVER = "article/article-image-cover",
+    ARTICLE_SOCIAL_BAR = "article/social-bar",
+    ARTICLE_SUMMARY = "article/article-summary",
+    ARTICLE_CONTENT = "article/article-content",
+    ARTICLE_TAG_BAR = "article/tag-bar",
+    ARTICLE_SIGNATURE = "article/signature"
+}
+declare const enum ComponentNameHoroscope {
+    HOROSCOPE_BREADCRUMB = "horoscope/breadcrumb",
+    HOROSCOPE_HEADER_PAGE = "horoscope/header-page",
+    HOROSCOPE_HEADER_BANNER = "horoscope/header-banner",
+    HOROSCOPE_HOROSCOPE_CONTENT = "horoscope/horoscope-content",
+    HOROSCOPE_HOMEPAGE_CONTENT = "horoscope/horoscope-homepage-content",
+    HOROSCOPE_LINK = "horoscope/link",
+    HOROSCOPE_HOROSCOPE_TILES = "horoscope/horoscope-tiles",
+    HOROSCOPE_HOROSCOPE_LINK_NEXT_TYPE = "horoscope/horoscope-link-next-type"
+}
+interface ComponentConfig<TComponentName = ComponentNameCommon | ComponentNameRubric | ComponentNameArticle | ComponentNameHoroscope, TComponent = React$1.FC<any>> {
+    componentName: TComponentName;
+    component: TComponent;
+    expiration?: number;
+}
+
+interface PageTemplateProps {
+    stylesheets?: {
+        name: string;
+        url: string;
+    }[];
+    criticalCss?: string;
+    didomiScript: string;
+    gtmScript: string;
+    gtmNoScript: string;
+    mainInlineScript?: string;
+    awsRum?: {
+        variables: AwsRumVariablesType;
+        inlineScript: string;
+    };
+    datalayerInlineScript?: string;
+    dfpInlineScript?: string;
+    gtmInlineScript: string;
+    callCriticalScripts?: string;
+    children: React$1.ReactNode;
+    datalayerVariables?: VariablesDataLayerType;
+    header: React$1.ReactNode;
+    footer: React$1.ReactNode;
+}
+declare const PageTemplate: React$1.FC<PageTemplateProps>;
+
+interface ArticlePageProps extends PageTemplateProps {
+    overviewBar: React$1.ReactNode;
+    breadcrumb: React$1.ReactNode;
+    articleHeader: React$1.ReactNode;
+    articleImageCover: React$1.ReactNode;
+    socialBarAdvanced: React$1.ReactNode;
+    signature: React$1.ReactNode;
+    articleSummary: React$1.ReactNode;
+    articleContent: React$1.ReactNode;
+    mostReadArticles: React$1.ReactNode;
+    tagBar: React$1.ReactNode;
+    categoryCards: React$1.ReactNode;
+    newsCards: React$1.ReactNode;
+    newsletter: React$1.ReactNode;
+    partnerCards: React$1.ReactNode;
+    scrollProgressBar: React$1.ReactNode;
+    layout?: LayoutType;
+}
+declare const ArticlePage: React$1.FC<ArticlePageProps>;
+
+interface HoroscopePageProps extends PageTemplateProps {
+    breadcrumb: React$1.ReactNode;
+    headerPage: React$1.ReactNode;
+    headerBanner: React$1.ReactNode;
+    horoscopeContent: React$1.ReactNode;
+    link: React$1.ReactNode;
+    horoscopeTiles: React$1.ReactNode;
+    horoscopeLinkNextType: React$1.ReactNode;
+    layout?: LayoutType;
+}
+declare const HoroscopePage: React$1.FC<HoroscopePageProps>;
+
+interface HoroscopeHomePageProps extends PageTemplateProps {
+    breadcrumb: React$1.ReactNode;
+    headerPage: React$1.ReactNode;
+    horoscopeTiles: React$1.ReactNode;
+    horoscopeLinkNextType: React$1.ReactNode;
+    horoscopeHomepageContent: React$1.ReactNode;
+    layout?: LayoutType;
+}
+declare const HoroscopeHomePage: React$1.FC<HoroscopeHomePageProps>;
+
+declare type PageComponentConfig<TComponentName = string, TPropName = string> = {
+    name: TComponentName;
+    propName: TPropName;
+    useKey: boolean;
+    required: boolean;
+};
+declare type PageConfig<TPageName = string, TComponentPage = React.FC<any>, TComponentName = string, TPropName = string> = {
+    name: TPageName;
+    component: TComponentPage;
+    expiration: number;
+    components: PageComponentConfig<TComponentName, TPropName>[];
+};
+declare type PageTemplateComponentConfigs = PageComponentConfig<ComponentNameCommon, keyof PageTemplateProps>[];
+declare type ArticlePageConfig = PageConfig<'article', typeof ArticlePage, ComponentNameCommon | ComponentNameRubric | ComponentNameArticle, keyof ArticlePageProps>;
+declare type HoroscopePageConfig = PageConfig<'horoscope', typeof HoroscopePage, ComponentNameCommon | ComponentNameRubric | ComponentNameHoroscope, keyof HoroscopePageProps>;
+declare type HoroscopeHomePageConfig = PageConfig<'horoscopeHome', typeof HoroscopeHomePage, ComponentNameCommon | ComponentNameRubric | ComponentNameHoroscope, keyof HoroscopeHomePageProps>;
+declare type PageConfigs = [ArticlePageConfig, HoroscopePageConfig, HoroscopeHomePageConfig];
+declare type PageConfigAvailable = PageConfigs[number];
+
+declare type HeaderScriptsType = 'callCriticalScripts' | 'dfpInlineScript' | 'datalayerInlineScript' | 'didomiScript' | 'gtmInlineScript' | 'gtmScript';
+
+declare type BodyScriptsType = 'gtmNoScript';
+
+declare const COMPONENT_CONFIGS: ComponentConfig[];
+
+declare const PAGE_CONFIGS: PageConfigs;
+
+export { AdSizesType, AdSizesTypeKey, ArticlePage, ArticlePageConfig, ArticlePageProps, BodyScriptsType, COMPONENT_CONFIGS, CmpType, ComponentConfig, ComponentNameArticle, ComponentNameCommon, ComponentNameHoroscope, ComponentNameRubric, ContentDataLayerType, DataLayerType, DefaultDataLayerType, DfpDataLayerType, Didomi, DidomiEventListeners, DidomiOnReady, HeaderScriptsType, HoroscopeHomePage, HoroscopeHomePageConfig, HoroscopeHomePageProps, HoroscopePage, HoroscopePageConfig, HoroscopePageProps, PAGE_CONFIGS, PageComponentConfig, PageConfig, PageConfigAvailable, PageConfigs, PageTemplate, PageTemplateComponentConfigs, PageTemplateProps, Slot, Targeting, TargetingKeys, UserDataLayerType, VariablesCmpType, VariablesDataLayerType, pageType, tagsType };