@schibsted/advertory 2.63.16 → 2.63.18

package/features/kilkaya/es/index.d.ts

@@ -0,0 +1,428 @@
+import { ReactNode } from 'react';
+
+type AstAdType = 'banner' | 'video' | 'native' | 'outstream';
+type AstKeywordValue = Array<string> | string | number | Array<number> | undefined;
+type AstKeywords = Record<string, AstKeywordValue> & {
+    'se-generic-adformat'?: Array<string>;
+    'se-generic-targetid'?: Array<string>;
+    'se-sch-supply_type'?: Array<string>;
+    'no-sno-adformat'?: Array<string>;
+    'no-sno-targetid'?: Array<string>;
+    'aa-sch-dynamic-outstream'?: Array<string>;
+};
+interface SafeFrameConfig {
+    allowExpansionByPush?: boolean;
+    allowExpansionByOverlay?: boolean;
+}
+interface EidsUserSource {
+    id: string;
+    source: string;
+}
+interface AstUserIds {
+    type: string;
+    eids: Array<EidsUserSource>;
+}
+interface AstUser {
+    externalUid?: string;
+    dnt?: boolean;
+    userIds?: Array<AstUserIds>;
+}
+interface AstTrackingManagement {
+    native?: {
+        loadViewabilityScriptAt?: 'adresponse' | 'impression';
+    };
+}
+interface AstUserSync {
+    disabled: boolean;
+}
+interface AstRenderingManagement {
+    sandboxAdIframe: boolean;
+    sandboxAttributes: Array<string>;
+}
+interface AstPageOptions {
+    keywords: Record<string, AstKeywordValue>;
+    enableSafeFrame?: boolean;
+    disablePsa?: boolean;
+    user?: AstUser;
+    member?: number;
+    publisherId: number;
+    trackingManagement?: AstTrackingManagement;
+    renderingManagement?: AstRenderingManagement;
+    userSync?: AstUserSync;
+}
+
+declare const DeviceTypes: {
+    readonly MOBILE: "mobile";
+    readonly TABLET: "tablet";
+    readonly DESKTOP: "desktop";
+};
+type DeviceType = (typeof DeviceTypes)[keyof typeof DeviceTypes];
+
+declare const Countries: {
+    readonly NO: "no";
+    readonly SE: "se";
+};
+type Country = (typeof Countries)[keyof typeof Countries];
+
+declare const PageTypes: {
+    readonly FRONT: "front";
+    readonly ARTICLE: "article";
+    readonly SECTION: "section";
+    readonly COLLECTION: "collection";
+    readonly OTHER: "other";
+};
+type PageType = (typeof PageTypes)[keyof typeof PageTypes];
+
+interface AdvertisingIdentifiers {
+    xandr?: {
+        ppId1?: string;
+        ppId2?: string;
+    };
+}
+interface TrackerInstance {
+    getAdvertisingIdentifiers: () => Promise<AdvertisingIdentifiers>;
+    getUserId: () => Promise<undefined | string | number>;
+    getEnvironmentId: () => Promise<undefined | string>;
+    getActor: () => Promise<undefined | unknown>;
+    state?: {
+        pageViewId?: string;
+    };
+}
+interface PulseInstance extends TrackerInstance {
+    pulseTracker?: TrackerInstance;
+    trackElementView?: (eventInput: unknown) => Promise<void>;
+    trackElementClick?: (eventInput: unknown) => Promise<void>;
+    trackClickUIElement?: (eventInput: unknown) => Promise<void>;
+    trackViewUIElement?: (eventInput: unknown) => Promise<void>;
+    trackLegacyClickUIElement?: (eventInput: unknown) => Promise<void>;
+    trackLegacyViewUIElement?: (eventInput: unknown) => Promise<void>;
+}
+interface Tracker {
+    clientId: string;
+    instance: TrackerInstance;
+    hasherUrl?: string;
+}
+interface Pulse {
+    clientId: string;
+    instance: PulseInstance;
+}
+
+type DistributionTypes = 'REALESTATE' | 'REALESTATE_RETARGET' | 'REALESTATE_LEISURE' | 'REALESTATE_LEISURE_RETARGET' | 'REALESTATE_PROJECT' | 'REALESTATE_PROJECT_RETARGET' | 'CAR' | 'JOB';
+
+declare const Newsrooms: {
+    readonly SVD: "svd";
+    readonly VG: "vg";
+    readonly GODARE: "godare";
+    readonly AFTENPOSTEN: "aftenposten";
+    readonly SA: "sa";
+    readonly BT: "bt";
+    readonly AFTONBLADET: "aftonbladet";
+    readonly E24: "e24";
+    readonly MINMOTE: "minmote";
+    readonly PENT: "pent";
+    readonly GODT: "godt";
+    readonly TEK: "tekno";
+    readonly KLART: "klart";
+    readonly TVNU: "tvnu";
+    readonly POLARIS: "polaris";
+    readonly KOKET: "koket";
+    readonly TV4: "tv4";
+    readonly FOTBOLLSKANALEN: "fotbollskanalen";
+};
+type Newsroom = (typeof Newsrooms)[keyof typeof Newsrooms];
+
+interface SiteConfig {
+    publisher: string;
+    country: Country;
+    astUrl?: string;
+    gptUrl?: string;
+    testMember?: number;
+    pageType: PageType;
+    pageOptions: AstPageOptions;
+    placements: Placements;
+    keywordsConfig?: KeywordsConfig;
+    deviceType: DeviceType;
+    isMobileApp?: boolean;
+    glimr?: GlimrConfig;
+    tcf?: TCFConfig;
+    prebid?: PrebidConfig;
+    tracker?: Tracker;
+    pulse?: Pulse;
+    finnBlink?: FinnBlinkConfig;
+    wallpaper?: WallpaperConfig;
+    fullscreenScroll?: FullscreenScrollConfig;
+    appearanceConfig: AppearanceConfig;
+    queryConfig?: QueryConfig;
+    refreshConfig?: RefreshConfig;
+    takeover?: TakeoverConfig;
+    brandmetrics?: BrandmetricsConfig;
+    gdpr?: GdprConfig;
+    norstat?: NorstatConfig;
+    siteSpecificConfig?: SiteSpecificConfig;
+    sponsorstripe?: SponsorstripeConfig;
+    drEdition?: DrEditionConfig;
+    kilkaya?: KilkayaConfig;
+    forwardExternalImpId?: boolean;
+    requestSize?: number;
+    nativeTrackingConfig?: NativeTrackingConfig;
+    sandboxAdIframeEnabled?: boolean;
+    pageSectionsSelectors?: PageSectionsSelectors;
+    rightColumnSplit?: RightColumnSplitConfig;
+    editableConfiguration?: {
+        useS3Config?: boolean;
+        pageTypeToFetch?: string;
+    };
+    useAppTabletInvCode?: boolean;
+    adScaleConfig?: AdScaleConfig;
+    widescreenSwitching?: WidescreenSwitchingConfig;
+}
+interface NativeTrackingConfig {
+    nativeTrackingEnabled?: boolean;
+    fireImpressionsBasedOnAppearanceThreshold?: boolean;
+}
+interface SiteSpecificConfig {
+    publisherClassName?: Newsroom;
+    fullWidthFormatClassName?: 'netboard' | 'panorama';
+    classesToRemoveOnRefresh?: Array<string>;
+    mainColumnWidth?: number;
+}
+interface Placement {
+    id: string;
+    sizes: Array<Array<number>>;
+    allowedFormats: Array<AstAdType>;
+    invCode: string;
+    keywords: any;
+    refresh?: boolean;
+    bfCacheRefresh?: boolean;
+    ssa?: boolean;
+    threshold?: number;
+    finnBlink?: FinnBlinkPlacementConfig;
+    nativeCustomProperties?: Array<string>;
+    minViewWidth?: number;
+    dynamicSizeWidthCheck?: boolean;
+    safeframeConfig?: SafeFrameConfig;
+    positionConfig?: Array<PositionConfig>;
+    drEdition?: DrEditionPlacementConfig;
+    isBackfill?: boolean;
+    takeoverCookieCapForSharedPlacement?: boolean;
+}
+interface Placements {
+    desktop: Array<Placement>;
+    tablet: Array<Placement>;
+    mobile: Array<Placement>;
+}
+interface AppearanceConfig {
+    defaultThreshold: {
+        mobile: number;
+        tablet: number;
+        desktop: number;
+    };
+    clearProbableDimensionsEnabled?: boolean;
+    isDarkModeEnabled?: boolean;
+    mainColumnWidth?: number;
+}
+interface PageSectionsSelectors {
+    top?: string;
+    left?: string;
+    right?: string;
+    main?: string;
+    mainFirstColumn?: string;
+    mainSecondColumn?: string;
+}
+interface KeywordsConfig {
+    includeCountingKeywordInTags?: boolean;
+    sponsors?: string;
+}
+interface QueryConfig {
+    queryByDataDevice?: boolean;
+    lazyLoadingV3?: {
+        enabled: boolean;
+        rootMargin: string;
+    };
+    placementBatches?: PlacementBatchesConfig;
+}
+interface PositionConfig {
+    adPositionIndex: number;
+    sizes?: Array<Array<number>>;
+    keywords?: AstKeywords;
+}
+type FinnBlinkTheme = 'light' | 'dark';
+interface FinnBlinkConfig {
+    enabled?: boolean;
+    channel?: string;
+    userId?: string;
+    uuid?: string;
+    identifierUrl?: string;
+    theme?: FinnBlinkTheme;
+    replacementConfig?: {
+        adsToReplace?: Array<Array<string>>;
+        sizes?: {
+            width: number;
+            height: number;
+        };
+    };
+}
+interface FinnBlinkPlacementConfig {
+    enabled: boolean;
+    renderOnlyWithAdBlock?: boolean;
+    position: string;
+    distributionTypes?: Array<DistributionTypes>;
+    height?: number;
+    limit?: number;
+    offset?: number;
+    requireImage?: boolean;
+    rec?: boolean;
+    theme?: FinnBlinkTheme;
+    advertoryTheme?: string;
+    loadOnlyFinnBlink?: boolean;
+}
+interface PrebidConfig {
+    enabled: boolean;
+    url: string;
+    id: string;
+    externalUidInAuctionEnabled: boolean;
+    relevantCbTimeout?: number;
+    forwardGlimrTags?: boolean;
+}
+interface TCFConfig {
+    enabled: boolean;
+    schibstedAdChoicesEnabled?: boolean;
+    schibstedConsentToPayEnabled?: boolean;
+    schibstedAdChoicesOverrideValue?: string;
+    timeout?: number;
+}
+interface GlimrConfig {
+    enabled: boolean;
+    clientId: string;
+}
+interface WallpaperConfig {
+    enabled: boolean;
+    options?: WallpaperConfigOptions;
+}
+interface WallpaperConfigOptions {
+    appMainContainerSelector?: string;
+    wallpaperAnchorSelector?: string;
+}
+interface BrandmetricsConfig {
+    enabled: boolean;
+    url: string;
+}
+interface GdprConfig {
+    url?: string;
+    allowHidingAds?: boolean;
+}
+interface FullscreenScrollConfig {
+    fadingHeaderEnabled: boolean;
+    headerSelectors: Array<string>;
+    skyscraperSelectors?: Array<string>;
+    headerZIndex: number;
+    overlayStyles?: OverlayStyles;
+    moveCogwheelToTheLeft?: boolean;
+    iosSafeAreaTopFix?: string;
+}
+interface OverlayStyles {
+    backgroundColor?: string;
+    foregroundColor?: string;
+    articlesContainerWidth?: number;
+    margin?: string;
+    beforeContentValue?: string;
+}
+interface RefreshConfig {
+    delayTime?: number;
+    scrollRefreshEnabled?: boolean;
+    visibilityStateRefreshEnabled?: boolean;
+    backForwardNavigationRefreshEnabled?: boolean;
+}
+interface WelcomePageConfig {
+    showArrowIcon?: boolean;
+    headerElementSelector?: string;
+    buttonLabel?: string;
+    showCloseButton?: boolean;
+}
+interface SplashConfig {
+    themeColors?: ThemeColors;
+    buttonLabel: string;
+    logotype: Logotype;
+    showArrowIcon?: boolean;
+    showAnnonsLabel?: boolean;
+}
+interface TakeoverConfig {
+    enabled?: boolean;
+    secondVisitEnabled?: boolean;
+    splash?: SplashConfig;
+    welcomePage?: WelcomePageConfig;
+    topscroller?: WelcomePageConfig;
+    cookieCapName?: string | null;
+    cookieCapTime?: number;
+    setCookieCapForNotShownAd?: boolean;
+}
+interface Logotype {
+    url: string;
+    alt: string;
+}
+interface ThemeColors {
+    backgroundColor: string;
+    color: string;
+}
+interface NorstatConfig {
+    enabled: true;
+}
+interface SponsorstripeConfig {
+    toggleEnabled: boolean;
+    headerSelector?: string;
+    containersSelectors?: Array<string>;
+}
+interface RightColumnSplitConfig {
+    enabled: boolean;
+    splitPointIDs: Array<string>;
+    adSelector: string;
+    trackSelector?: string;
+}
+interface KilkayaConfig {
+    enabled: boolean;
+    url: string;
+}
+interface DrEditionConfig {
+    enabled: boolean;
+    containerSelector: string;
+    wrapperSelector: string;
+    fallbackGlobalEditionName?: string;
+    videoScriptUrl?: string;
+    addPreviewVideo?: (videoElement: HTMLElement) => void;
+}
+interface DrEditionPlacementConfig {
+    editionName: string;
+}
+interface AdScaleConfig {
+    enabled: boolean;
+    adsToBeScaled: Partial<Record<DeviceType, Array<string>>>;
+    offset?: Record<string, number>;
+}
+interface DevicePlacementBatches {
+    [key: string]: Array<string>;
+}
+type PlacementBatchesConfig = {
+    [device in DeviceType]: DevicePlacementBatches;
+};
+interface WidescreenSwitchingConfig {
+    enabled: boolean;
+    rotationInterval?: number;
+    widescreenIdPrefix?: string;
+}
+
+interface KilkayaComponentProps {
+    placementName: string;
+    fallbackTargetId: string;
+    children: ReactNode;
+    pulseData?: DrEditionHtmlAttributes;
+    htmlAttributes?: DrEditionHtmlAttributes;
+}
+interface DrEditionHtmlAttributes {
+    [key: string]: string | boolean | number;
+}
+
+declare const Kilkaya: ({ placementName, fallbackTargetId, children, pulseData, htmlAttributes }: KilkayaComponentProps) => ReactNode;
+
+declare const runKilkaya: (siteConfig: SiteConfig) => Promise<void>;
+
+export { Kilkaya, runKilkaya };