@schibsted/advertory 2.69.0 → 2.70.0

package/types/config/aftonbladetv2.d.ts

@@ -1,4 +1,5 @@
 import { updateAdvertory } from 'core/handlers/ad-server';
 import { getVideoPPIDs } from '../features/tracker';
+import { getAdsConfig } from '../features/video';
 declare const initAdvertoryPackage: (config: import("core/interface/config").SiteConfig) => Promise<void>;
-export { initAdvertoryPackage, updateAdvertory, getVideoPPIDs };
+export { initAdvertoryPackage, updateAdvertory, getVideoPPIDs, getAdsConfig };

package/types/core/handlers/country-prefix/index.d.ts

@@ -1,4 +1,4 @@
-import { CountryPrefix } from 'core/interface/countries';
-declare const getCountryPrefix: () => CountryPrefix;
+import { CountryPrefix, Country } from 'core/interface/countries';
+declare const getCountryPrefix: (country?: Country) => CountryPrefix;
 declare const getCountryCountPrefix: () => string;
 export { getCountryPrefix, getCountryCountPrefix };

package/types/core/interface/device.d.ts

@@ -11,3 +11,16 @@ export interface DeviceParams {
     isHybridApp: boolean;
     appMode: string;
 }
+export declare const DevicesKeywordTypes: {
+    readonly DESKTOP: "web_desktop";
+    readonly MOBILE: "web_phone";
+    readonly TABLET: "web_tablet";
+    readonly APP: "app_phone";
+};
+export type DevicesKeywordType = (typeof DevicesKeywordTypes)[keyof typeof DevicesKeywordTypes];
+export declare const DevicesCodes: {
+    readonly DESKTOP: "wde";
+    readonly MOBILE: "wph";
+    readonly TABLETE: "wtb";
+    readonly APP: "wph";
+};

package/types/core/logger/index.d.ts

@@ -1,2 +1,3 @@
 declare const log: (message: string, params?: any) => void;
-export { log };
+declare const warn: (message: string, params?: any) => void;
+export { log, warn };

package/types/features/glimr/glimr-core-handler.d.ts

@@ -1,3 +1,4 @@
-declare const isGlimrConsentGiven: () => Promise<boolean>;
+import { SiteConfig } from 'core/interface/config';
+declare const isGlimrConsentGiven: (consentConfig?: Partial<SiteConfig>) => Promise<boolean>;
 declare const updateGlimr: () => Promise<void>;
 export { updateGlimr, isGlimrConsentGiven };

package/types/features/glimr/glimr-tag-filters.d.ts

@@ -1,4 +1,5 @@
+import { SiteConfig } from 'core/interface/config';
 declare const getWeatherGlimrTags: (glimrTags?: Array<string>) => Array<string>;
 declare const getGeofenceGlimrTags: (glimrTags?: Array<string>) => Array<string>;
-declare const getGeoGlimrTags: (glimrTags?: Array<string>, addPublisherToGeo?: boolean) => Array<string>;
+declare const getGeoGlimrTags: (glimrTags?: Array<string>, customConfig?: Partial<SiteConfig>, addPublisherToGeo?: boolean) => Array<string>;
 export { getWeatherGlimrTags, getGeoGlimrTags, getGeofenceGlimrTags };

package/types/features/glimr/glimr-tags-handler.d.ts

@@ -1,4 +1,5 @@
 import { NoGlimrKeywords, SeGlimrKeywords } from 'core/interface/keywords';
 import { GlimrKeywordsOptions } from 'features/interface/glimr';
-declare const getGlimrKeywords: (options?: GlimrKeywordsOptions) => Promise<NoGlimrKeywords | SeGlimrKeywords | object>;
+import { SiteConfig } from 'core/interface/config';
+declare const getGlimrKeywords: (customConfig: Partial<SiteConfig>, options?: GlimrKeywordsOptions) => Promise<NoGlimrKeywords | SeGlimrKeywords | object>;
 export { getGlimrKeywords };

package/types/{core/handlers/user/index.d.ts → features/identity/user.d.ts}

@@ -1,4 +1,5 @@
+import { SiteConfig } from 'core/interface/config';
 declare const getCookie: (cookieName: string) => string | null;
-declare const getAdUserId: () => Promise<string | undefined>;
+declare const getAdUserId: (config: Partial<SiteConfig>) => Promise<string | undefined>;
 declare const getUserId: () => string | undefined;
 export { getUserId, getAdUserId, getCookie };

package/types/features/interface/video.d.ts

@@ -0,0 +1,97 @@
+import { Country } from 'core/interface/countries';
+import { DeviceType } from 'core/interface/device';
+import { Keywords } from 'core/interface/ast';
+import { TCFConfig, GlimrConfig } from 'core/interface/config';
+export type ValidPlayerAspectRatios = '1-1' | '16-9' | '9-16' | 'responsive';
+export type ValidInstreamAspectRatios = '1-1' | '16-9' | '9-16' | '3-4';
+export type AdFormatKeywordCreator = (position: string) => string | undefined;
+export type AdFormationInvCodeCreator = (position: string, isUserPresentOnFrontPage?: boolean) => string;
+export interface BaseTag {
+    slug?: string;
+    enabled?: boolean;
+    id: string;
+    title: string;
+    metadata?: [{
+        url: string;
+        type: string;
+    }];
+}
+export interface Tag extends BaseTag {
+    type?: 'descriptor' | 'organization' | 'person' | 'place' | 'location' | 'event';
+}
+export interface VideoSection {
+    title: string;
+    id: string;
+    shortPath: string;
+    metadata: {
+        podcast_author?: string;
+        podcast_categoryTree?: string;
+        actingEditor?: string;
+        afp?: 'true';
+        sponsored?: 'true';
+        [property: string]: unknown;
+    };
+    parent: VideoSection;
+}
+export interface SiteVideoConfig {
+    publisher: string;
+    memberId: number;
+    sectionKeyword: string;
+    frontpageInvCodeTemplate: string;
+    additionalFilterKeys: Array<string>;
+    tcf: TCFConfig;
+    glimr: GlimrConfig;
+    country: Country;
+}
+export interface VideoAdParams {
+    invCode: string;
+    videoOverlayInvCode: string;
+    sections: string;
+}
+export interface GetVideoAdsKeywordsParams {
+    pageAdsKeywords?: Keywords;
+    tags: string;
+    sections: string;
+    isUserLoggedIn: boolean;
+    isUserPresentOnFrontPage: boolean;
+    isInitialVideo: boolean;
+    currentVideoId?: string;
+    instreamAspectRatio: number;
+    playerAspectRatio: number;
+    isApp: boolean;
+    isAndroidApp: boolean;
+    deviceType: DeviceType;
+}
+export type VideoParamsCreator = (section: VideoSection, isLiveStudio: boolean) => VideoAdParams | null;
+export interface ViewportInfo {
+    height: number;
+    width: number;
+}
+export interface VideoAdsConfigParams {
+    aspectRatio?: string;
+    tags: Array<Tag>;
+    assetSection: VideoSection;
+    publisher: string;
+    isApp: boolean;
+    pageAdsKeywords?: Keywords;
+    startMode: 'manual' | 'auto' | 'silent';
+    isUserLoggedIn: boolean;
+    isUsedInOverlayVideoPlayer?: boolean;
+    isLiveStudio: boolean;
+    assetId: string;
+    isAndroidApp: boolean;
+    deviceType: DeviceType;
+}
+export interface VideoStream {
+    attributes?: {
+        id?: number;
+    };
+}
+export interface GatheredAdData {
+    siteConfig: SiteVideoConfig;
+    siteVideoParams: VideoAdParams | null;
+    isUserPresentOnFrontPage: boolean;
+    adsKeywords: Keywords;
+    prerollPlacementFormat: string;
+    playbackMethod: number;
+}

package/types/features/video/aftonbladet.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/features/video/aspect-ratios.d.ts

@@ -0,0 +1,5 @@
+import type { ValidPlayerAspectRatios, ValidInstreamAspectRatios } from 'features/interface/video';
+declare const getClosestPlayerAspectRatio: (playerAspectRatio?: number) => ValidPlayerAspectRatios;
+declare const getClosestInstreamAspectRatio: (instreamAspectRatio?: number) => ValidInstreamAspectRatios;
+declare const getPlayerAspectRatio: () => number;
+export { getClosestPlayerAspectRatio, getClosestInstreamAspectRatio, getPlayerAspectRatio };

package/types/features/video/aspect-ratios.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/features/video/builder.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/features/video/config.d.ts

@@ -0,0 +1,3 @@
+import { VideoAdsConfigParams, VideoStream } from 'features/interface/video';
+declare const getAdsConfig: (videoParams: VideoAdsConfigParams) => (stream: VideoStream) => Promise<Record<string, unknown>>;
+export { getAdsConfig };

package/types/features/video/constants.d.ts

@@ -0,0 +1,30 @@
+import type { ValidPlayerAspectRatios, ValidInstreamAspectRatios } from 'features/interface/video';
+declare const SE_GENERIC = "se-generic";
+declare const MANDATORY_PREFIX = "aa-sch";
+declare const KEY_PREFIX = "kv_";
+declare const Positions: {
+    PAUSE: string;
+};
+declare const DEVICE_TYPE_PLACEHOLDER = "{deviceType}";
+declare const POSITION_PLACEHOLDER = "{position}";
+declare const AFP_PREFIX = "afp_";
+declare const TV_SEGMENT = "tv-";
+declare const AFP_UNDERSCORE = "-afp_";
+declare const AFP_HYPHEN = "-afp-";
+declare const ARTICLE_REPLACEMENT = "-article-";
+declare const FrontpagePositions: {
+    readonly PREROLL: "preroll";
+    readonly BUMPER: "bumper";
+    readonly MIDROLL: "midroll";
+};
+declare const FRONTPAGE_POSITIONS: Set<string>;
+declare const AspectRations: {
+    readonly '1:1': "1-1";
+    readonly '16:9': "16-9";
+    readonly '3:4': "3-4";
+    readonly '9:16': "9-16";
+    readonly RESPONSIVE: "responsive";
+};
+declare const playerAspectRatios: Record<ValidPlayerAspectRatios, number>;
+declare const streamAspectRatios: Record<ValidInstreamAspectRatios, number>;
+export { SE_GENERIC, MANDATORY_PREFIX, KEY_PREFIX, Positions, DEVICE_TYPE_PLACEHOLDER, POSITION_PLACEHOLDER, AFP_PREFIX, TV_SEGMENT, AFP_UNDERSCORE, AFP_HYPHEN, ARTICLE_REPLACEMENT, FrontpagePositions, FRONTPAGE_POSITIONS, playerAspectRatios, streamAspectRatios, AspectRations };

package/types/features/video/device.d.ts

@@ -0,0 +1,5 @@
+import { DeviceType, DevicesKeywordType } from 'core/interface/device';
+import { ViewportInfo } from 'features/interface/video';
+declare const getSupplyType: (deviceType: DeviceType) => DevicesKeywordType;
+declare const getViewportInfo: () => ViewportInfo;
+export { getSupplyType, getViewportInfo };

package/types/features/video/filters.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/features/video/index.d.ts

@@ -1 +1,2 @@
 export { getTcfConsentKeywords } from './tcf';
+export { getAdsConfig } from './config';

package/types/features/video/inv-code.d.ts

@@ -0,0 +1,5 @@
+import { AdFormationInvCodeCreator, AdFormatKeywordCreator, SiteVideoConfig, VideoAdParams } from 'features/interface/video';
+import { DeviceType } from 'core/interface/device';
+declare const adFormatKeywordCreator: (invCodeTemplate?: string) => AdFormatKeywordCreator;
+declare const adFormatInvCodeCreator: (videoParams: VideoAdParams | null, siteConfig: SiteVideoConfig, deviceType: DeviceType, isUsedInOverlayVideoPlayer?: boolean) => AdFormationInvCodeCreator;
+export { adFormatKeywordCreator, adFormatInvCodeCreator };

package/types/features/video/inv-code.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/features/video/keywords/builder.d.ts

@@ -0,0 +1,4 @@
+import { GetVideoAdsKeywordsParams, SiteVideoConfig } from 'features/interface/video';
+import { Keywords } from 'core/interface/ast';
+declare const getVideoAdsKeywords: (params: GetVideoAdsKeywordsParams, siteConfig: SiteVideoConfig) => Promise<Keywords>;
+export { getVideoAdsKeywords };

package/types/features/video/keywords/filters.d.ts

@@ -0,0 +1,8 @@
+import { SiteVideoConfig } from 'features/interface/video';
+import { Keywords } from 'core/interface/ast';
+declare const SHARED_KEYS_TO_FILTER: string[];
+declare const KEYS_TO_SEND_WITHOUT_KW_PREFIX: string[];
+declare const KEYS_KW_PREFIX_BLOCKED: string[];
+declare const filterAndAddKwPrefix: (adsKeywords: Keywords, siteConfig: SiteVideoConfig) => Record<string, unknown>;
+declare const filterKeysWithoutKwPrefix: (adsKeywords: Keywords) => Record<string, unknown>;
+export { filterAndAddKwPrefix, filterKeysWithoutKwPrefix, SHARED_KEYS_TO_FILTER, KEYS_TO_SEND_WITHOUT_KW_PREFIX, KEYS_KW_PREFIX_BLOCKED };

package/types/features/video/keywords/index.d.ts

@@ -0,0 +1,2 @@
+export { getVideoAdsKeywords } from './builder';
+export { filterAndAddKwPrefix, filterKeysWithoutKwPrefix } from './filters';

package/types/features/video/playback.d.ts

@@ -0,0 +1,3 @@
+declare const getVPlaybackMethod: (startMode: string) => number;
+declare const videoPlaybackMethodMap: Map<number, string>;
+export { getVPlaybackMethod, videoPlaybackMethodMap };

package/types/features/video/playback.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/features/video/pulse.d.ts

@@ -0,0 +1,3 @@
+declare const getPulseDataCookie: () => string;
+declare const getGenericExternalIdSrc: () => number;
+export { getPulseDataCookie, getGenericExternalIdSrc };

package/types/features/video/pulse.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/features/video/registry.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/features/video/sites/aftonbladet.d.ts

@@ -0,0 +1,4 @@
+import { VideoAdParams, SiteVideoConfig, VideoSection } from 'features/interface/video';
+export declare const aftonbladetVideoConfig: SiteVideoConfig;
+declare const createABVideoAdParams: (assetSection?: VideoSection, isLiveStudio?: boolean) => VideoAdParams | null;
+export { createABVideoAdParams };

package/types/features/video/sites/index.d.ts

@@ -0,0 +1,4 @@
+import { SiteVideoConfig, VideoParamsCreator } from 'features/interface/video';
+declare const getSiteConfig: (publisher: string) => SiteVideoConfig;
+declare const getParamsCreator: (publisher: string) => VideoParamsCreator;
+export { getSiteConfig, getParamsCreator };

package/types/features/video/tags.d.ts

@@ -0,0 +1,3 @@
+import { Tag } from 'features/interface/video';
+declare const getVideoTags: (tags: Array<Tag>) => string;
+export { getVideoTags };

package/types/features/video/url.d.ts

@@ -0,0 +1,5 @@
+import { Keywords } from 'core/interface/ast';
+declare const getArticleId: () => string;
+declare const adParamsInQueries: () => boolean;
+declare const getKeywords: () => Keywords | undefined;
+export { getArticleId, adParamsInQueries, getKeywords };

package/types/features/video/url.test.d.ts

@@ -0,0 +1 @@
+export {};