@folklore/ads 0.0.124 → 0.0.127

package/types/Ad.d.ts

@@ -1,30 +0,0 @@
-import { Ref } from 'react';
-import AdSlot from './AdSlot';
-import { AdSize, AdSizeMapping, AdsTargeting } from './types';
-export interface AdProps {
-    slot: string;
-    path?: string | null;
-    size?: AdSize[] | null;
-    sizeMapping?: AdSizeMapping[] | null;
-    viewport?: string | null;
-    targeting?: AdsTargeting | null;
-    refreshInterval?: number | null;
-    alwaysRender?: boolean;
-    disabled?: boolean;
-    disableTracking?: boolean;
-    shouldKeepSize?: boolean;
-    withoutStyle?: boolean;
-    withoutMinimumSize?: boolean;
-    withReactId?: boolean;
-    className?: string | null;
-    emptyClassName?: string | null;
-    adClassName?: string | null;
-    richAdClassName?: string | null;
-    richAdIframeClassName?: string | null;
-    onRender?: ((event: any) => void) | null;
-    onDestroy?: (() => void) | null;
-    onRichAd?: ((richAd: any) => void) | null;
-    slotRef?: Ref<AdSlot> | null;
-}
-declare function Ad({ slot: slotName, path: providedPath, size: providedSize, sizeMapping: providedSizeMapping, viewport: providedViewport, targeting: providedTargeting, refreshInterval: providedRefreshInterval, alwaysRender, disabled: providedDisabled, disableTracking, shouldKeepSize, withoutStyle, withoutMinimumSize, withReactId, className, emptyClassName, adClassName, richAdClassName, richAdIframeClassName, onRender, onDestroy, onRichAd, slotRef, }: AdProps): import("react/jsx-runtime").JSX.Element;
-export default Ad;

package/types/AdSlot.d.ts

@@ -1,57 +0,0 @@
-import EventEmitter from 'wolfy87-eventemitter';
-import { AdSizeMapping } from './types';
-export interface AdSlotOptions {
-    sizeMapping?: null | AdSizeMapping[];
-    targeting?: {
-        [key: string]: string | Array<string>;
-    };
-    categoryExclusions?: Array<string>;
-    visible?: boolean;
-}
-declare class AdSlot extends EventEmitter {
-    options: AdSlotOptions;
-    elementId: string;
-    adPath: string;
-    adSize: string | Array<string>;
-    visible: boolean;
-    wasVisible: boolean;
-    adSlot: any;
-    rendered: boolean;
-    displayed: boolean;
-    viewable: boolean;
-    renderEvent: any;
-    refreshDisabled: boolean;
-    destroyed: boolean;
-    constructor(id: any, path: any, size: any, opts?: {});
-    updateAdSlot(): void;
-    setAdSlot(slot: any): this;
-    setRenderEvent(event: any): this;
-    setViewable(viewable: any): void;
-    setDisplayed(displayed: any): this;
-    setVisible(visible: any): this;
-    setRefreshDisabled(): void;
-    setTargeting(targeting: any): void;
-    destroy(): void;
-    getElementId(): string;
-    getAdSlot(): any;
-    getAdPath(): string;
-    getAdSize(): string | string[];
-    getTargeting(): {
-        [key: string]: string | string[];
-    };
-    isVisible(): boolean;
-    isDefined(): boolean;
-    isDisplayed(): boolean;
-    isViewable(): boolean;
-    isRendered(): boolean;
-    isRefreshDisabled(): boolean;
-    isDestroyed(): boolean;
-    isEmpty(): any;
-    canBeDisplayed(): boolean;
-    getRenderedSize(): {
-        width: any;
-        height: any;
-        isFluid: boolean;
-    };
-}
-export default AdSlot;

package/types/AdsContext.d.ts

@@ -1,37 +0,0 @@
-import React from 'react';
-import AdsManager from './AdsManager';
-import { Slots, SlotsDefinition, Viewports } from './types';
-interface AdsContextType {
-    ready: boolean;
-    ads?: AdsManager;
-    viewports?: Viewports;
-    viewport?: string | null;
-    slots?: Slots;
-    slotsPath?: Record<string, string>;
-    trackingDisabled?: boolean;
-    richAdComponents?: Record<string, React.ElementType>;
-}
-declare const AdsContext: React.Context<AdsContextType>;
-export declare const useAdsContext: () => AdsContextType;
-interface AdsProviderProps {
-    children: React.ReactNode;
-    defaultSlotPath?: string | null;
-    slotsPath?: Record<string, string> | null;
-    disableSingleRequest?: boolean;
-    disableVideoAds?: boolean;
-    disableLazyLoad?: boolean;
-    autoInit?: boolean;
-    resizeDebounceDelay?: number;
-    refreshOnResize?: boolean;
-    mobileScaling?: number;
-    renderMarginPercent?: number;
-    fetchMarginPercent?: number;
-    viewport?: string | null;
-    viewports?: Viewports;
-    slots?: SlotsDefinition;
-    richAdComponents?: Record<string, React.ElementType> | null;
-    disabled?: boolean;
-    disableTracking?: boolean;
-}
-export declare function AdsProvider({ children, defaultSlotPath, slotsPath, disableSingleRequest, disableVideoAds, disableLazyLoad, autoInit, resizeDebounceDelay, refreshOnResize, mobileScaling, renderMarginPercent, fetchMarginPercent, viewport, viewports, slots, richAdComponents, disabled, disableTracking, }: AdsProviderProps): import("react/jsx-runtime").JSX.Element;
-export default AdsContext;

package/types/AdsManager.d.ts

@@ -1,72 +0,0 @@
-import EventEmitter from 'wolfy87-eventemitter';
-import AdSlot, { AdSlotOptions as BaseAdSlotOptions } from './AdSlot';
-import { AdSize } from './types';
-declare global {
-    interface Window {
-        googletag?: any;
-        refreshDisabledLineItems?: string[];
-    }
-}
-interface AdSlotOptions extends BaseAdSlotOptions {
-    id?: string;
-}
-declare class AdsManager extends EventEmitter {
-    static ID_PREFIX: string;
-    disabled: boolean;
-    personnalizedAdsDisabled: boolean;
-    ready: boolean;
-    enabled: boolean;
-    googletag: any;
-    slots: AdSlot[];
-    index: number;
-    options: {
-        disabled: boolean;
-        disablePersonnalizedAds: boolean;
-        disableSingleRequest: boolean;
-        disableLazyLoad: boolean;
-        disableVideoAds: boolean;
-        autoInit: boolean;
-        mobileScaling?: number;
-        renderMarginPercent?: number;
-        fetchMarginPercent?: number;
-    };
-    static getArticleTargeting(article: any): {
-        title: any;
-        slug: any;
-        postID: any;
-        categories: any;
-        authors: any;
-        sponsors: any;
-        GoogleSafeTargeting: any;
-    };
-    static getSectionTargeting(section: any): {
-        section: any;
-    };
-    static getIndexTargeting(index: any): {
-        index: any;
-    };
-    static getIndexItemTargeting(index: any, item: any): {
-        [index.id]: any[];
-    };
-    constructor(opts?: {});
-    createAdId(): string;
-    init(): void;
-    initGpt(): void;
-    onSlotRenderEnded(event: any): void;
-    onSlotImpressionViewable(event: any): void;
-    onSlotVisibleChange(visible: any, slot: any): void;
-    isReady(): boolean;
-    isDisabled(): boolean;
-    setDisabled(disabled: any): void;
-    disablePersonnalizedAds(disablePersonnalizedAds: any): void;
-    createSlot(path: string, size: AdSize, opts?: AdSlotOptions): AdSlot;
-    defineSlot(slot: any): void;
-    displaySlots(): boolean;
-    displaySlot(slot: any): void;
-    callDisplaySlot(slot: any): void;
-    destroySlot(id: any): void;
-    refreshSlot(id: any): void;
-    refreshSlots(ids: any): void;
-    refreshAllSlots(): void;
-}
-export default AdsManager;

package/types/AdsTargetingContext.d.ts

@@ -1,11 +0,0 @@
-import { ReactNode } from 'react';
-import { AdsTargeting } from './types';
-interface AdsTargetingProviderProps {
-    children: ReactNode;
-    targeting?: AdsTargeting;
-    replace?: boolean;
-}
-declare const AdsTargetingContext: import("react").Context<AdsTargeting>;
-export declare const useAdsTargeting: () => AdsTargeting | null;
-export declare function AdsTargetingProvider({ children, targeting, replace, }: AdsTargetingProviderProps): import("react/jsx-runtime").JSX.Element;
-export default AdsTargetingContext;

package/types/RichAd.d.ts

@@ -1,7 +0,0 @@
-import { RichAd as RichAdType } from './types';
-export interface RichAdProps {
-    richAd: RichAdType;
-    [key: string]: any;
-}
-declare function RichAd({ richAd, ...props }: RichAdProps): import("react/jsx-runtime").JSX.Element;
-export default RichAd;

package/types/__tests__/utils.test.d.ts

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

package/types/defaults.d.ts

@@ -1,3 +0,0 @@
-import { SlotsDefinition, Viewports } from './types';
-export declare const viewports: Viewports;
-export declare const slots: SlotsDefinition;

package/types/index.d.ts

@@ -1,13 +0,0 @@
-export * as PropTypes from "./propTypes";
-export { default as Ad } from "./Ad";
-export { default as RichAd } from "./RichAd";
-export * from "./AdsContext";
-export * from "./AdsTargetingContext";
-export * from "./defaults";
-export * from "./utils";
-export * from "./types";
-export { default as AdSlot } from "./AdSlot";
-export { default as AdsManager } from "./AdsManager";
-export { default as useAd } from "./useAd";
-export { default as useAdsTracking } from "./useAdsTracking";
-export { default as useRichAd } from "./useRichAd";

package/types/propTypes.d.ts

@@ -1,7 +0,0 @@
-export const adPath: any;
-export const adSize: any;
-export const adSizeMapping: any;
-export const adViewports: any;
-export const adSlot: any;
-export const adSlots: any;
-export const adTargeting: any;

package/types/types.d.ts

@@ -1,34 +0,0 @@
-export type AdSize = [number, number] | 'fluid';
-export type Viewport = [number, number];
-export type AdSizeMapping = [Viewport, AdSize[]];
-export interface Size {
-    width: number;
-    height: number;
-}
-export interface Viewports {
-    [name: string]: Viewport;
-}
-export interface SlotDefinition {
-    sizeMapping?: Record<string, AdSize[]> | boolean | null | AdSizeMapping[] | null;
-    size?: AdSize[];
-    path?: string | null;
-}
-export interface Slot extends SlotDefinition {
-    sizeMapping?: AdSizeMapping[] | null;
-}
-export interface Slots {
-    [name: string]: Slot;
-}
-export interface SlotsDefinition {
-    [name: string]: SlotDefinition;
-}
-export interface AdsTargeting {
-    refreshAds?: 'inactive' | false | null | number;
-    disabled?: boolean;
-    viewport?: string | null;
-    [key: string]: any;
-}
-export interface RichAd {
-    type: string;
-    [key: string]: any;
-}

package/types/useAd.d.ts

@@ -1,30 +0,0 @@
-import AdSlot from './AdSlot';
-import { AdSizeMapping, AdsTargeting } from './types';
-interface UseAdOptions {
-    id?: string;
-    sizeMapping?: AdSizeMapping[] | null;
-    viewport?: string | null;
-    targeting?: AdsTargeting | null;
-    categoryExclusions?: string[] | null;
-    refreshInterval?: number | null;
-    alwaysRender?: boolean;
-    onRender?: (event: any) => void | null;
-    onDestroy?: (event: any) => void | null;
-    disabled?: boolean;
-    disableTracking?: boolean;
-    rootMargin?: string;
-}
-declare function useAd(path: string, size: any, { id, sizeMapping, viewport, targeting, categoryExclusions, refreshInterval, alwaysRender, onRender, onDestroy, disabled, disableTracking, rootMargin, }?: UseAdOptions): {
-    width: any;
-    height: any;
-    isFluid: boolean;
-    refObserver: import("react").RefObject<any>;
-    slot: AdSlot;
-    disabled: boolean;
-    id: string;
-    isRendered: boolean;
-    isEmpty: any;
-    isVisible: boolean;
-    renderEvent: any;
-};
-export default useAd;

package/types/useAdsTracking.d.ts

@@ -1,2 +0,0 @@
-import AdSlot from './AdSlot';
-export default function useAdsTracking(): (action: string, slot?: AdSlot, renderEvent?: any) => void;

package/types/useRichAd.d.ts

@@ -1,6 +0,0 @@
-import { RichAd } from './types';
-interface UseRichAdOptions {
-    onRichAd?: (richAd: RichAd) => void | null;
-}
-declare function useRichAd(containerRef: any, id: string, opts?: UseRichAdOptions): any;
-export default useRichAd;

package/types/utils.d.ts

@@ -1,10 +0,0 @@
-import { AdSize, AdSizeMapping, Size, Slot, SlotDefinition, Viewport, Viewports } from './types';
-export declare function normalizeAdSizes(size: any): AdSize[];
-export declare function getAdSizes(sizes: any): AdSize[];
-export declare function getMinimumAdSize(sizes: any): Size;
-export declare function sizeFitsInViewport(size: AdSize, viewport: Viewport): boolean;
-export declare function getSortedViewports(viewports: Viewports): any;
-export declare function buildSizeMappingFromViewports(sizeMapping: any, viewports: any): AdSizeMapping[];
-export declare function buildSizeMappingFromSizes(sizes: any, viewports: any): AdSizeMapping[];
-export declare function getSizeMappingFromSlot({ size: allSizes, sizeMapping }: Slot | SlotDefinition, viewports: Viewports): AdSizeMapping[] | null;
-export declare function getSizeFromSizeMapping(sizeMapping: any): AdSize[] | null;