@adhese/sdk 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,734 @@
+import * as zod from 'zod';
+import { TypeOf, ZodType } from 'zod';
+
+/**
+ * Merge two types together. The resulting type will have all properties of both types, but if a property is present in
+ * both types, the type of the second type will be used.
+ */
+type Merge<T, U> = Omit<T, keyof U> & U;
+
+/**
+ * Type that represents a URL string that starts with `http://` or `https://`.
+ */
+type UrlString = `https://${string}.${string}` | `http://${string}.${string}`;
+
+type Event<T> = {
+    /**
+     * The listeners for this event. This is a set of functions that will be called when the event is dispatched.
+     */
+    listeners: Set<(data: T) => void | Promise<void>>;
+    /**
+     * Dispatches the event to all listeners. This is a synchronous operation.
+     * @param data
+     */
+    dispatch(data: T): void;
+    /**
+     * Dispatches the event to all listeners. This is an asynchronous operation.
+     * @param data
+     */
+    dispatchAsync(data: T): Promise<void>;
+    /**
+     * Adds a listener to the event.
+     * @param listener
+     */
+    addListener(listener: (data: T) => void | Promise<void>): void;
+    /**
+     * Removes a listener from the event.
+     * @param listener
+     */
+    removeListener(listener: (data: T) => void | Promise<void>): void;
+};
+type EventManagerGroup<Events extends Record<string, unknown>> = {
+    [Key in keyof Events]: Readonly<Event<Events[Key]>>;
+};
+type EventManager<Events extends Record<string, unknown>> = {
+    /**
+     * Disposes of all listeners and clears the event manager. After calling this method, the event manager is no longer usable.
+     */
+    dispose(): void;
+} & EventManagerGroup<Events>;
+/**
+ * Creates a new event manager with the given event names.
+ *
+ * @typeParam Events The events that the event manager will handle and their data types.
+ */
+declare function createEventManager<Events extends Record<Name, unknown>, Name extends Readonly<string | number | symbol> = keyof Events>(): EventManager<Events>;
+
+type SlotManager = {
+    /**
+     * Returns all slots that are currently registered and rendered.
+     */
+    getAll(): ReadonlyArray<AdheseSlot>;
+    /**
+     * Adds a new slot to the Adhese instance and renders it.
+     */
+    add(slot: Omit<AdheseSlotOptions, 'context'>): Promise<Readonly<AdheseSlot>>;
+    /**
+     * Finds all slots in the DOM and adds them to the Adhese instance.
+     */
+    findDomSlots(): Promise<ReadonlyArray<AdheseSlot>>;
+    /**
+     * Returns the slot with the given name.
+     */
+    get(name: string): AdheseSlot | undefined;
+    /**
+     * Removes all slots from the Adhese instance and cleans up the slot manager.
+     */
+    dispose(): void;
+};
+type SlotManagerOptions = {
+    /**
+     * List of initial slots to add to the slot manager.
+     */
+    initialSlots?: ReadonlyArray<Merge<Omit<AdheseSlotOptions, 'containingElement' | 'context' | 'lazy'>, {
+        containingElement: string;
+    }>>;
+    context: AdheseContext;
+};
+
+declare const baseAdResponseScheme: zod.ZodObject<{
+    adDuration: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, number | undefined, string>>;
+    adDuration2nd: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, number | undefined, string>>;
+    adDuration3rd: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, number | undefined, string>>;
+    adDuration4th: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, number | undefined, string>>;
+    adDuration5th: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, number | undefined, string>>;
+    adDuration6th: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, number | undefined, string>>;
+    adFormat: zod.ZodOptional<zod.ZodString>;
+    adType: zod.ZodString;
+    additionalCreativeTracker: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, URL | undefined, string>>;
+    additionalViewableTracker: zod.ZodOptional<zod.ZodString>;
+    adspaceEnd: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, Date | undefined, string>>;
+    adspaceId: zod.ZodOptional<zod.ZodString>;
+    adspaceKey: zod.ZodOptional<zod.ZodString>;
+    adspaceStart: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, Date | undefined, string>>;
+    advertiserId: zod.ZodOptional<zod.ZodString>;
+    altText: zod.ZodOptional<zod.ZodString>;
+    auctionable: zod.ZodOptional<zod.ZodUnion<[zod.ZodBoolean, zod.ZodLiteral<"">]>>;
+    body: zod.ZodOptional<zod.ZodString>;
+    clickTag: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, URL | undefined, string>>;
+    comment: zod.ZodOptional<zod.ZodString>;
+    creativeName: zod.ZodOptional<zod.ZodString>;
+    deliveryGroupId: zod.ZodOptional<zod.ZodString>;
+    deliveryMultiples: zod.ZodOptional<zod.ZodString>;
+    dm: zod.ZodOptional<zod.ZodString>;
+    ext: zod.ZodOptional<zod.ZodString>;
+    extension: zod.ZodOptional<zod.ZodObject<{
+        mediaType: zod.ZodString;
+        prebid: zod.ZodOptional<zod.ZodUnknown>;
+    }, "strip", zod.ZodTypeAny, {
+        mediaType: string;
+        prebid?: unknown;
+    }, {
+        mediaType: string;
+        prebid?: unknown;
+    }>>;
+    extraField1: zod.ZodOptional<zod.ZodString>;
+    extraField2: zod.ZodOptional<zod.ZodString>;
+    height: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, number | undefined, string>>;
+    height3rd: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, number | undefined, string>>;
+    height4th: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, number | undefined, string>>;
+    height5th: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, number | undefined, string>>;
+    height6th: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, number | undefined, string>>;
+    heightLarge: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, number | undefined, string>>;
+    id: zod.ZodOptional<zod.ZodString>;
+    impressionCounter: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, URL | undefined, string>>;
+    libId: zod.ZodOptional<zod.ZodString>;
+    orderId: zod.ZodOptional<zod.ZodString>;
+    orderName: zod.ZodOptional<zod.ZodString>;
+    orderProperty: zod.ZodOptional<zod.ZodString>;
+    origin: zod.ZodOptional<zod.ZodString>;
+    originData: zod.ZodOptional<zod.ZodUnknown>;
+    poolPath: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, URL | undefined, string>>;
+    preview: zod.ZodOptional<zod.ZodUnion<[zod.ZodBoolean, zod.ZodLiteral<"">]>>;
+    priority: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, number | undefined, string>>;
+    share: zod.ZodOptional<zod.ZodString>;
+    slotID: zod.ZodString;
+    slotName: zod.ZodString;
+    swfSrc: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, URL | undefined, string>>;
+    swfSrc2nd: zod.ZodOptional<zod.ZodString>;
+    swfSrc3rd: zod.ZodOptional<zod.ZodString>;
+    swfSrc4th: zod.ZodOptional<zod.ZodString>;
+    swfSrc5th: zod.ZodOptional<zod.ZodString>;
+    swfSrc6th: zod.ZodOptional<zod.ZodString>;
+    tag: zod.ZodString;
+    tagUrl: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, URL | undefined, string>>;
+    timeStamp: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, Date | undefined, string>>;
+    trackedImpressionCounter: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, URL | undefined, string>>;
+    tracker: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, URL | undefined, string>>;
+    trackingUrl: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, URL | undefined, string>>;
+    url: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, URL | undefined, string>>;
+    viewableImpressionCounter: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, URL | undefined, string>>;
+    width: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, number | undefined, string>>;
+    width3rd: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, number | undefined, string>>;
+    width4th: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, number | undefined, string>>;
+    width5th: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, number | undefined, string>>;
+    width6th: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, number | undefined, string>>;
+    widthLarge: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, number | undefined, string>>;
+}, "strip", zod.ZodTypeAny, {
+    adType: string;
+    slotID: string;
+    slotName: string;
+    tag: string;
+    adDuration?: number | undefined;
+    adDuration2nd?: number | undefined;
+    adDuration3rd?: number | undefined;
+    adDuration4th?: number | undefined;
+    adDuration5th?: number | undefined;
+    adDuration6th?: number | undefined;
+    adFormat?: string | undefined;
+    additionalCreativeTracker?: URL | undefined;
+    additionalViewableTracker?: string | undefined;
+    adspaceEnd?: Date | undefined;
+    adspaceId?: string | undefined;
+    adspaceKey?: string | undefined;
+    adspaceStart?: Date | undefined;
+    advertiserId?: string | undefined;
+    altText?: string | undefined;
+    auctionable?: boolean | "" | undefined;
+    body?: string | undefined;
+    clickTag?: URL | undefined;
+    comment?: string | undefined;
+    creativeName?: string | undefined;
+    deliveryGroupId?: string | undefined;
+    deliveryMultiples?: string | undefined;
+    dm?: string | undefined;
+    ext?: string | undefined;
+    extension?: {
+        mediaType: string;
+        prebid?: unknown;
+    } | undefined;
+    extraField1?: string | undefined;
+    extraField2?: string | undefined;
+    height?: number | undefined;
+    height3rd?: number | undefined;
+    height4th?: number | undefined;
+    height5th?: number | undefined;
+    height6th?: number | undefined;
+    heightLarge?: number | undefined;
+    id?: string | undefined;
+    impressionCounter?: URL | undefined;
+    libId?: string | undefined;
+    orderId?: string | undefined;
+    orderName?: string | undefined;
+    orderProperty?: string | undefined;
+    origin?: string | undefined;
+    originData?: unknown;
+    poolPath?: URL | undefined;
+    preview?: boolean | "" | undefined;
+    priority?: number | undefined;
+    share?: string | undefined;
+    swfSrc?: URL | undefined;
+    swfSrc2nd?: string | undefined;
+    swfSrc3rd?: string | undefined;
+    swfSrc4th?: string | undefined;
+    swfSrc5th?: string | undefined;
+    swfSrc6th?: string | undefined;
+    tagUrl?: URL | undefined;
+    timeStamp?: Date | undefined;
+    trackedImpressionCounter?: URL | undefined;
+    tracker?: URL | undefined;
+    trackingUrl?: URL | undefined;
+    url?: URL | undefined;
+    viewableImpressionCounter?: URL | undefined;
+    width?: number | undefined;
+    width3rd?: number | undefined;
+    width4th?: number | undefined;
+    width5th?: number | undefined;
+    width6th?: number | undefined;
+    widthLarge?: number | undefined;
+}, {
+    adType: string;
+    slotID: string;
+    slotName: string;
+    tag: string;
+    adDuration?: string | undefined;
+    adDuration2nd?: string | undefined;
+    adDuration3rd?: string | undefined;
+    adDuration4th?: string | undefined;
+    adDuration5th?: string | undefined;
+    adDuration6th?: string | undefined;
+    adFormat?: string | undefined;
+    additionalCreativeTracker?: string | undefined;
+    additionalViewableTracker?: string | undefined;
+    adspaceEnd?: string | undefined;
+    adspaceId?: string | undefined;
+    adspaceKey?: string | undefined;
+    adspaceStart?: string | undefined;
+    advertiserId?: string | undefined;
+    altText?: string | undefined;
+    auctionable?: boolean | "" | undefined;
+    body?: string | undefined;
+    clickTag?: string | undefined;
+    comment?: string | undefined;
+    creativeName?: string | undefined;
+    deliveryGroupId?: string | undefined;
+    deliveryMultiples?: string | undefined;
+    dm?: string | undefined;
+    ext?: string | undefined;
+    extension?: {
+        mediaType: string;
+        prebid?: unknown;
+    } | undefined;
+    extraField1?: string | undefined;
+    extraField2?: string | undefined;
+    height?: string | undefined;
+    height3rd?: string | undefined;
+    height4th?: string | undefined;
+    height5th?: string | undefined;
+    height6th?: string | undefined;
+    heightLarge?: string | undefined;
+    id?: string | undefined;
+    impressionCounter?: string | undefined;
+    libId?: string | undefined;
+    orderId?: string | undefined;
+    orderName?: string | undefined;
+    orderProperty?: string | undefined;
+    origin?: string | undefined;
+    originData?: unknown;
+    poolPath?: string | undefined;
+    preview?: boolean | "" | undefined;
+    priority?: string | undefined;
+    share?: string | undefined;
+    swfSrc?: string | undefined;
+    swfSrc2nd?: string | undefined;
+    swfSrc3rd?: string | undefined;
+    swfSrc4th?: string | undefined;
+    swfSrc5th?: string | undefined;
+    swfSrc6th?: string | undefined;
+    tagUrl?: string | undefined;
+    timeStamp?: string | undefined;
+    trackedImpressionCounter?: string | undefined;
+    tracker?: string | undefined;
+    trackingUrl?: string | undefined;
+    url?: string | undefined;
+    viewableImpressionCounter?: string | undefined;
+    width?: string | undefined;
+    width3rd?: string | undefined;
+    width4th?: string | undefined;
+    width5th?: string | undefined;
+    width6th?: string | undefined;
+    widthLarge?: string | undefined;
+}>;
+type AdResponse = TypeOf<typeof baseAdResponseScheme> & {
+    additionalCreatives?: ReadonlyArray<AdResponse> | string;
+};
+declare const adResponseSchema: ZodType<AdResponse>;
+type Ad = TypeOf<typeof adResponseSchema> & {
+    additionalCreatives?: ReadonlyArray<Ad> | string;
+};
+
+type RenderMode = 'iframe' | 'inline';
+type AdheseSlotOptions = {
+    /**
+     * The format code of the slot. Used to find the correct element on the page to render the ad in. If the format is a
+     * string, it is used as the format code. If the format is an array, the format code is determined by the query
+     * detector.
+     */
+    format: string | ReadonlyArray<{
+        format: string;
+        query: string;
+    }>;
+    /**
+     * If we have multiple slots with the same format, we can use this to differentiate between them.
+     */
+    slot?: string;
+    /**
+     * The element that contains the slot. Used to find the correct element on the page to render the ad in.
+     */
+    containingElement?: string | HTMLElement;
+    /**
+     * The parameters that are used to render the ad.
+     */
+    parameters?: Record<string, ReadonlyArray<string> | string>;
+    /**
+     * The Adhese context
+     */
+    context: AdheseContext;
+    /**
+     * The render mode of the slot.
+     *
+     * - `iframe`: The ad will be rendered in an iframe.
+     * - `inline`: The ad will be rendered in the containing element.
+     *
+     * @default 'iframe'
+     */
+    renderMode?: RenderMode;
+    /**
+     * Callback that is called when the slot is disposed.
+     */
+    onDispose?(): void;
+    /**
+     * Callback that is called when the format of the slot changes.
+     */
+    onNameChange?(newName: string, oldName: string): void;
+} & ({
+    /**
+     * If the slot should be lazy loaded. This means that the ad will only be requested when the slot is in the viewport.
+     * If `true`, the slot will handle the request itself and render the ad.
+     */
+    lazyLoading: true;
+    lazyLoadingOptions?: {
+        /**
+         * The root margin of the intersection observer. This is used to determine when the slot is in the viewport.
+         */
+        rootMargin?: string;
+    };
+} | {
+    lazyLoading?: false;
+    lazyLoadingOptions?: never;
+});
+type AdheseSlot = Merge<Omit<AdheseSlotOptions, 'onDispose' | 'context' | 'onFormatChange' | 'format'>, {
+    /**
+     * The location of the slot. This is the location that is used to determine the current page URL.
+     */
+    location: string;
+    /**
+     * The parameters that are used to render the ad.
+     */
+    parameters: Map<string, ReadonlyArray<string> | string>;
+    /**
+     * Renders the slot in the containing element. If no ad is provided, a new ad will be requested from the API.
+     */
+    render(ad?: Ad): Promise<HTMLElement>;
+    /**
+     * Returns the rendered element.
+     */
+    getElement(): HTMLElement | null;
+    /**
+     * Returns the name of the slot.
+     */
+    getName(): string;
+    /**
+     * Returns the ad that is to be rendered in the slot or is currently rendered in the slot.
+     */
+    getAd(): Ad | null;
+    /**
+     * Sets the ad that is to be rendered in the slot. If the slot is in the viewport, the ad will be rendered immediately.
+     */
+    setAd(ad: Ad): Promise<void>;
+    /**
+     * Returns whether the viewability tracking pixel has been fired.
+     */
+    isViewabilityTracked(): boolean;
+    /**
+     * Returns whether the impression tracking pixel has been fired.
+     */
+    isImpressionTracked(): boolean;
+    /**
+     * Sets the format of the slot. This is used to change the format of the slot after it has been created.
+     */
+    setFormat(format: string): Promise<void>;
+    /**
+     * Returns the format of the slot.
+     */
+    getFormat(): string;
+    /**
+     * Removes the slot from the DOM and cleans up the slot instance.
+     */
+    dispose(): void;
+}>;
+
+type AdRequestOptions = {
+    /**
+     * List of slots you want to fetch the ad for
+     */
+    slots: ReadonlyArray<Pick<AdheseSlot, 'getName' | 'parameters'>>;
+    /**
+     * Host that you want to fetch the ads from
+     */
+    host: UrlString;
+    /**
+     * The Adhese account name.
+     */
+    account: string;
+    /**
+     * Request method to use for the requestAds
+     *
+     * @default 'POST'
+     */
+    method?: 'GET' | 'POST' | 'get' | 'post';
+    /**
+     * The parameters that are used for all ads.
+     */
+    parameters?: Map<string, ReadonlyArray<string> | string>;
+    context: Partial<Adhese>;
+};
+
+declare class MapWithEvents<T, U> extends Map<T, U> {
+    private readonly listeners;
+    addEventListener(listener: () => void): void;
+    removeEventListener(listener: () => void): void;
+    set(key: T, value: U): this;
+    clear(): void;
+    delete(key: T): boolean;
+    /**
+     * Remove all listeners and clear the map.
+     */
+    dispose(): void;
+}
+
+/**
+ * A log entry saved by the logger
+ */
+type Log<T extends string> = {
+    /**
+     * The scope of the logger that created this log entry
+     */
+    scope: string;
+    /**
+     * The log level of this log entry
+     */
+    level: T;
+    /**
+     * The message of this log entry
+     */
+    message: string;
+    /**
+     * The attributes of this log entry
+     */
+    attributes?: unknown;
+    /**
+     * The timestamp of this log entry
+     */
+    timestamp: number;
+    id: string;
+};
+type LogFunction = (message: string, attributes?: unknown) => void;
+type Logger<T extends string> = {
+    [key in T]: LogFunction;
+} & {
+    /**
+     * The scope of the logger
+     */
+    readonly scope: string;
+    /**
+     * The event manager of the logger
+     */
+    events: ReturnType<typeof createEventManager<{
+        log: Log<T>;
+        reset: void;
+    }>>;
+    /**
+     * Set the minimum log level threshold
+     */
+    setMinLogLevelThreshold(level: T): void;
+    /**
+     * Reset the minimum log level threshold to the default value
+     */
+    resetMinLogLevelThreshold(): void;
+    /**
+     * Get the current minimum log level threshold
+     */
+    getMinLogLevelThreshold(): T;
+    /**
+     * Get the logs that were created by this logger
+     */
+    getLogs(): ReadonlyArray<Log<T>>;
+    /**
+     * Reset the logs that were created by this logger
+     */
+    resetLogs(): void;
+};
+
+declare const logger: Logger<"error" | "debug" | "trace" | "info" | "warn">;
+
+type AdheseOptions = {
+    /**
+     * The Adhese account name.
+     */
+    account: string;
+    /**
+     * The url that is used to connect to the Adhese ad server. Pass a custom URL if you want to use your own domain for
+     * the connection.
+     *
+     * @default 'https://ads-{{account}}.adhese.com'
+     */
+    host?: UrlString;
+    /**
+     * The url that is used to connect to the Adhese pool server. Pass a custom URL if you want to use your own domain for
+     * the connection.
+     *
+     * @default 'https://pool-{{account}}.adhese.com'
+     */
+    poolHost?: UrlString;
+    /**
+     * The page location. This is used to determine the current page location identifier.
+     *
+     * @default location.pathname
+     */
+    location?: string;
+    /**
+     * The requestAds type to use for the Adhese API requests. This can be either `GET` or `POST`. `POST` is the default
+     * and offers the most options. `GET` is more limited as it needs pass its data as search parameters but can be used
+     * in environments where `POST` requests are not allowed.
+     *
+     * @default 'POST'
+     */
+    requestType?: 'GET' | 'POST';
+    /**
+     * Enable debug logging.
+     *
+     * @default false
+     */
+    debug?: boolean;
+    /**
+     * Find all slots in the DOM and add them to the Adhese instance during initialization.
+     *
+     * @default false
+     */
+    findDomSlotsOnLoad?: boolean;
+    /**
+     * Additional parameters to send with each request. Make sure that the keys of a parameter only contain `2` characters.
+     */
+    parameters?: Record<string, ReadonlyArray<string> | string>;
+    /**
+     * The consent type to use for the Adhese API requests. This can be either `true` or `false`. `false` is the default and
+     * will send all consent data to the Adhese API. `false` will send no consent data to the Adhese API.
+     *
+     * @default false
+     */
+    consent?: boolean;
+    /**
+     * Will log the `document.referrer` to the Adhese API in a BASE64 string with the `re` parameter.
+     *
+     * @default true
+     */
+    logReferrer?: boolean;
+    /**
+     * Will log the `window.location.href` to the Adhese API in a BASE64 string with the `ur` parameter.
+     *
+     * @default true
+     */
+    logUrl?: boolean;
+    /**
+     * If `true`, ads will be rendered immediately after they are fetched from the API. If `false`, ads will only be
+     * rendered when the slot is in the viewport.
+     *
+     * @default false
+     */
+    eagerRendering?: boolean;
+    /**
+     * The query detector options for the Adhese instance.
+     */
+    queries?: Record<string, string>;
+} & ({
+    viewabilityTracking?: true;
+    /**
+     * Options for the viewability tracking of the ads. If `true` or `undefined`, the default viewability tracking options will be used.
+     *
+     * @default true
+     */
+    viewabilityTrackingOptions?: {
+        /**
+         * Fraction of the ad that needs to be in the viewport for the ad to be considered viewable.
+         *
+         * @default 0.2
+         */
+        threshold?: number;
+        /**
+         * The duration the ad needs to be in the viewport for the ad to be considered viewable in milliseconds.
+         *
+         * @default 1000
+         */
+        duration?: number;
+        /**
+         * The margin around the viewport where the ad is considered viewable.
+         *
+         * @default '0px'
+         */
+        rootMargin?: string;
+    };
+} | {
+    viewabilityTracking?: false;
+    viewabilityTrackingOptions?: never;
+}) & Pick<SlotManagerOptions, 'initialSlots'>;
+type MergedOptions = Merge<AdheseOptions, Required<Pick<AdheseOptions, 'host' | 'poolHost' | 'location' | 'requestType' | 'debug' | 'initialSlots' | 'findDomSlotsOnLoad' | 'consent' | 'logUrl' | 'logReferrer' | 'eagerRendering' | 'viewabilityTracking'>>>;
+type AdheseEvents = {
+    locationChange: string;
+    consentChange: boolean;
+    addSlot: AdheseSlot;
+    removeSlot: AdheseSlot;
+    changeSlots: ReadonlyArray<AdheseSlot>;
+    responseReceived: ReadonlyArray<Ad>;
+    requestAd: AdRequestOptions;
+    requestError: Error;
+    previewReceived: ReadonlyArray<Ad>;
+    parametersChange: Map<string, ReadonlyArray<string> | string>;
+};
+type Adhese = Omit<AdheseOptions, 'location' | 'parameters' | 'consent'> & Merge<SlotManager, {
+    /**
+     * The parameters that are used for all ads.
+     */
+    parameters: MapWithEvents<string, ReadonlyArray<string> | string>;
+    /**
+     * The event manager for the Adhese instance.
+     */
+    events: EventManager<AdheseEvents>;
+    /**
+     * Returns the current page location.
+     */
+    getLocation(): string;
+    /**
+     * Sets the current page location.
+     */
+    setLocation(location: string): void;
+    /**
+     * Returns the current consent type.
+     */
+    getConsent(): boolean;
+    /**
+     * Sets the current consent type.
+     */
+    setConsent(consent: boolean): void;
+    /**
+     * Adds a new slot to the Adhese instance and renders it.
+     */
+    addSlot(slot: Omit<AdheseSlotOptions, 'location' | 'context'>): Promise<Readonly<AdheseSlot>>;
+    /**
+     * Finds all slots in the DOM and adds them to the Adhese instance.
+     */
+    findDomSlots(): Promise<ReadonlyArray<AdheseSlot>>;
+    /**
+     * Removes all slots from the Adhese instance and cleans up the Adhese instance.
+     *
+     * After calling this method, the Adhese instance is no longer usable.
+     */
+    dispose(): void;
+    /**
+     * Toggles the debug mode of the Adhese instance.
+     */
+    toggleDebug(): Promise<boolean>;
+}>;
+type AdheseContext = Partial<Pick<Adhese, 'events' | 'getAll' | 'get' | 'parameters'>> & {
+    location: string;
+    consent: boolean;
+    options: Readonly<MergedOptions>;
+    logger: typeof logger;
+    debug: boolean;
+};
+
+/**
+ * Creates an Adhese instance. This instance is your main entry point to the Adhese API.
+ *
+ * @param options
+ * @param options.account The Adhese account name.
+ * @param options.host The url that is used to connect to the Adhese ad server. Pass a custom URL if you want to use
+ * your own domain for the connection.
+ * @param options.poolHost The url that is used to connect to the Adhese pool server. Pass a custom URL if you want to
+ * use your own domain for the connection.
+ * @param options.location The page location. This is used to determine the current page location identifier.
+ * @param options.requestType The requestAds type to use for the Adhese API requests. This can be either `GET` or
+ * `POST`. `POST` is the default and offers the most options. `GET` is more limited as it needs pass its data as search
+ * parameters but can be used in environments where `POST` requests are not allowed.
+ * @param options.debug Enable debug logging.
+ * @param options.initialSlots The initial slots to add to the Adhese instance.
+ * @param options.findDomSlotsOnLoad Find all slots in the DOM and add them to the Adhese instance during
+ * initialization.
+ * @param options.parameters Base parameters that are used for all ads.
+ * @param options.consent The consent type to use for the Adhese API requests. This can be either `all` or `none`.
+ *
+ * @return Promise<Adhese> The Adhese instance.
+ */
+declare function createAdhese(options: AdheseOptions): Promise<Readonly<Adhese>>;
+
+export { type Ad, type AdRequestOptions, type Adhese, type AdheseContext, type AdheseOptions, type AdheseSlot, type AdheseSlotOptions, createAdhese };