@adhese/sdk 0.3.0 → 0.5.0

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import { ComputedRef, Ref, MaybeRef } from '@vue/runtime-core';
 import * as zod from 'zod';
 import { TypeOf, ZodType } from 'zod';
 
@@ -62,7 +63,7 @@ type SlotManager = {
     /**
      * Adds a new slot to the Adhese instance and renders it.
      */
-    add(slot: Omit<AdheseSlotOptions, 'context'>): Promise<Readonly<AdheseSlot>>;
+    add(slot: Omit<AdheseSlotOptions, 'context'>): Readonly<AdheseSlot>;
     /**
      * Finds all slots in the DOM and adds them to the Adhese instance.
      */
@@ -86,13 +87,8 @@ type SlotManagerOptions = {
     context: AdheseContext;
 };
 
-declare const baseAdResponseScheme: zod.ZodObject<{
+declare const baseSchema: 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>>;
@@ -104,13 +100,12 @@ declare const baseAdResponseScheme: zod.ZodObject<{
     advertiserId: zod.ZodOptional<zod.ZodString>;
     altText: zod.ZodOptional<zod.ZodString>;
     auctionable: zod.ZodOptional<zod.ZodUnion<[zod.ZodBoolean, zod.ZodLiteral<"">]>>;
-    body: zod.ZodOptional<zod.ZodString>;
+    body: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodUnion<[zod.ZodEffects<zod.ZodString, Record<string, unknown> | readonly unknown[], string>, zod.ZodEffects<zod.ZodString, string, string>]>]>, string | Record<string, unknown> | readonly unknown[] | undefined, string>>;
     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;
@@ -122,22 +117,16 @@ declare const baseAdResponseScheme: zod.ZodObject<{
         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>>;
+    height: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">, zod.ZodNumber]>, string | undefined, string | number>>;
     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>;
+    origin: zod.ZodUnion<[zod.ZodLiteral<"JERLICIA">, zod.ZodLiteral<"DALE">]>;
     originData: zod.ZodOptional<zod.ZodUnknown>;
+    originInstance: zod.ZodOptional<zod.ZodString>;
     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>>;
@@ -145,12 +134,7 @@ declare const baseAdResponseScheme: zod.ZodObject<{
     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;
+    tag: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodUnion<[zod.ZodEffects<zod.ZodString, Record<string, unknown> | readonly unknown[], string>, zod.ZodEffects<zod.ZodString, string, string>]>]>, string | Record<string, unknown> | readonly unknown[] | undefined, string>>;
     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>>;
@@ -158,23 +142,14 @@ declare const baseAdResponseScheme: zod.ZodObject<{
     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>>;
+    width: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">, zod.ZodNumber]>, string | undefined, string | number>>;
+    widthLarge: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">, zod.ZodNumber]>, string | undefined, string | number>>;
 }, "strip", zod.ZodTypeAny, {
+    origin: "JERLICIA" | "DALE";
     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;
@@ -185,44 +160,32 @@ declare const baseAdResponseScheme: zod.ZodObject<{
     advertiserId?: string | undefined;
     altText?: string | undefined;
     auctionable?: boolean | "" | undefined;
-    body?: string | undefined;
+    body?: string | Record<string, unknown> | readonly unknown[] | 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;
+    height?: string | undefined;
     id?: string | undefined;
     impressionCounter?: URL | undefined;
     libId?: string | undefined;
     orderId?: string | undefined;
     orderName?: string | undefined;
     orderProperty?: string | undefined;
-    origin?: string | undefined;
     originData?: unknown;
+    originInstance?: string | undefined;
     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;
+    tag?: string | Record<string, unknown> | readonly unknown[] | undefined;
     tagUrl?: URL | undefined;
     timeStamp?: Date | undefined;
     trackedImpressionCounter?: URL | undefined;
@@ -230,23 +193,14 @@ declare const baseAdResponseScheme: zod.ZodObject<{
     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;
+    width?: string | undefined;
+    widthLarge?: string | undefined;
 }, {
+    origin: "JERLICIA" | "DALE";
     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;
@@ -263,38 +217,26 @@ declare const baseAdResponseScheme: zod.ZodObject<{
     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;
+    height?: string | number | undefined;
     id?: string | undefined;
     impressionCounter?: string | undefined;
     libId?: string | undefined;
     orderId?: string | undefined;
     orderName?: string | undefined;
     orderProperty?: string | undefined;
-    origin?: string | undefined;
     originData?: unknown;
+    originInstance?: string | undefined;
     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;
+    tag?: string | undefined;
     tagUrl?: string | undefined;
     timeStamp?: string | undefined;
     trackedImpressionCounter?: string | undefined;
@@ -302,19 +244,18 @@ declare const baseAdResponseScheme: zod.ZodObject<{
     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;
+    width?: string | number | undefined;
+    widthLarge?: string | number | undefined;
 }>;
-type AdResponse = TypeOf<typeof baseAdResponseScheme> & {
+type AdResponse = (TypeOf<typeof baseSchema> & {
     additionalCreatives?: ReadonlyArray<AdResponse> | string;
-};
+});
 declare const adResponseSchema: ZodType<AdResponse>;
-type Ad = TypeOf<typeof adResponseSchema> & {
-    additionalCreatives?: ReadonlyArray<Ad> | string;
+type PreParsedAd = TypeOf<typeof adResponseSchema> & {
+    additionalCreatives?: ReadonlyArray<PreParsedAd> | string;
+};
+type Ad<T = string | Record<string, unknown> | ReadonlyArray<unknown>> = Omit<PreParsedAd, 'tag'> & {
+    tag: T;
 };
 
 type RenderMode = 'iframe' | 'inline';
@@ -361,6 +302,15 @@ type AdheseSlotOptions = {
      * Callback that is called when the format of the slot changes.
      */
     onNameChange?(newName: string, oldName: string): void;
+    /**
+     * Callback that is called when the slot is rendered.
+     */
+    onRender?(element: HTMLElement): void;
+    /**
+     * Callback that is called before the ad is rendered. This can be used to modify the ad before it is rendered.
+     * Particularly useful for rendering ads with custom HTML if the ad tag contains a JSON object.
+     */
+    onBeforeRender?(ad: Ad): Ad | void;
 } & ({
     /**
      * If the slot should be lazy loaded. This means that the ad will only be requested when the slot is in the viewport.
@@ -379,49 +329,48 @@ type AdheseSlotOptions = {
 });
 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.
+     * The name of the slot. This is used to identify the slot in the Adhese instance.
+     *
+     * The name is generated based on the location, format, and slot of the slot.
      */
-    render(ad?: Ad): Promise<HTMLElement>;
+    name: ComputedRef<string>;
     /**
-     * Returns the rendered element.
+     * 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.
+     *
+     * When you change the format, the slot will request a new ad from the API automatically.
      */
-    getElement(): HTMLElement | null;
+    format: Ref<string>;
     /**
-     * Returns the name of the slot.
+     * The location of the slot. This is the location that is used to determine the current page URL.
      */
-    getName(): string;
+    location: string;
     /**
-     * Returns the ad that is to be rendered in the slot or is currently rendered in the slot.
+     * The parameters that are used to render the ad.
      */
-    getAd(): Ad | null;
+    parameters: Map<string, ReadonlyArray<string> | string>;
     /**
-     * Sets the ad that is to be rendered in the slot. If the slot is in the viewport, the ad will be rendered immediately.
+     * Whether the viewability tracking pixel has been fired.
      */
-    setAd(ad: Ad): Promise<void>;
+    isViewabilityTracked: ComputedRef<boolean>;
     /**
-     * Returns whether the viewability tracking pixel has been fired.
+     * Whether the impression tracking pixel has been fired.
      */
-    isViewabilityTracked(): boolean;
+    isImpressionTracked: ComputedRef<boolean>;
     /**
-     * Returns whether the impression tracking pixel has been fired.
+     * Ad object that is fetched from the API.
      */
-    isImpressionTracked(): boolean;
+    ad: Ref<Ad | null>;
     /**
-     * Sets the format of the slot. This is used to change the format of the slot after it has been created.
+     * Renders the slot in the containing element. If no ad is provided, a new ad will be requested from the API.
      */
-    setFormat(format: string): Promise<void>;
+    render(ad?: Ad): Promise<HTMLElement>;
     /**
-     * Returns the format of the slot.
+     * Returns the rendered element.
      */
-    getFormat(): string;
+    getElement(): HTMLElement | null;
     /**
      * Removes the slot from the DOM and cleans up the slot instance.
      */
@@ -432,41 +381,13 @@ 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>;
+    slots: ReadonlyArray<{
+        name: MaybeRef<string>;
+        parameters: Map<string, ReadonlyArray<string> | string>;
+    }>;
+    context: AdheseContext;
 };
 
-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
  */
@@ -660,7 +581,7 @@ type Adhese = Omit<AdheseOptions, 'location' | 'parameters' | 'consent'> & Merge
     /**
      * The parameters that are used for all ads.
      */
-    parameters: MapWithEvents<string, ReadonlyArray<string> | string>;
+    parameters: Map<string, ReadonlyArray<string> | string>;
     /**
      * The event manager for the Adhese instance.
      */
@@ -731,6 +652,6 @@ type AdheseContext = Partial<Pick<Adhese, 'events' | 'getAll' | 'get' | 'paramet
  *
  * @return Promise<Adhese> The Adhese instance.
  */
-declare function createAdhese(options: AdheseOptions): Promise<Readonly<Adhese>>;
+declare function createAdhese(options: AdheseOptions): Readonly<Adhese>;
 
 export { type Ad, type AdRequestOptions, type Adhese, type AdheseContext, type AdheseOptions, type AdheseSlot, type AdheseSlotOptions, createAdhese };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@adhese/sdk",
   "type": "module",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "description": "Adhese SDK",
   "license": "GPL-3.0",
   "repository": {
@@ -22,10 +22,11 @@
     "lint:fix": "eslint --fix .",
     "clean": "rm -rf dist",
     "typecheck": "tsc --noEmit",
-    "release": "npm publish --access public"
+    "prepareRelease": "npm run build"
   },
   "dependencies": {
-    "@adhese/sdk-devtools": "^0.3.0",
+    "@adhese/sdk-devtools": "^0.5.0",
+    "@vue/runtime-core": "^3.4.21",
     "lodash-es": "^4.17.21",
     "zod": "^3.22.4"
   }