@adhese/sdk 0.5.2 → 0.6.0

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-import { ComputedRef, Ref, MaybeRef } from '@vue/runtime-core';
 import * as zod from 'zod';
 import { TypeOf, ZodType } from 'zod';
+import { ComputedRef, Ref, MaybeRef } from '@vue/runtime-core';
 
 /**
  * Merge two types together. The resulting type will have all properties of both types, but if a property is present in
@@ -55,6 +55,72 @@ type EventManager<Events extends Record<string, unknown>> = {
  */
 declare function createEventManager<Events extends Record<Name, unknown>, Name extends Readonly<string | number | symbol> = keyof Events>(): EventManager<Events>;
 
+declare class Config {
+    auto?: boolean;
+    debug?: boolean;
+    renderFile?: string;
+    cdn?: string;
+    msgFile?: string;
+    root?: string;
+    to?: number;
+    constructor(options?: {
+        auto?: boolean;
+        debug?: boolean;
+        renderFile?: string;
+        cdn?: string;
+        msgFile?: string;
+        root?: string;
+        to?: number;
+    });
+}
+declare class Position {
+    html: string;
+    id: string;
+    src: string;
+    meta?: Record<string, unknown>;
+    config?: Record<string, unknown>;
+    constructor(config: {
+        id: string;
+        src?: string;
+        html: string;
+        config?: PosConfig;
+    });
+}
+declare class PosConfig {
+    id: string;
+    dest: string;
+    constructor(posIDorObj: string | {
+        bg?: string;
+        css?: string;
+        dest?: string;
+        h?: number;
+        id?: string;
+        size?: string;
+        tgt?: string;
+        w?: number;
+        z?: number;
+        supports?: Record<string, unknown>;
+    }, destID?: string, baseConf?: {
+        bg?: string;
+        css?: string;
+        dest?: string;
+        h?: number;
+        id?: string;
+        size?: string;
+        tgt?: string;
+        w?: number;
+        z?: number;
+        supports?: Record<string, unknown>;
+    });
+}
+
+type SafeFrame = {
+    config: Config;
+    addPosition(positions: Ad, element: HTMLElement): Position;
+    render(position: Position): Promise<void>;
+    dispose(): void;
+};
+
 type SlotManager = {
     /**
      * Returns all slots that are currently registered and rendered.
@@ -117,8 +183,8 @@ declare const baseSchema: zod.ZodObject<{
         mediaType: string;
         prebid?: unknown;
     }>>;
-    height: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">, zod.ZodNumber]>, string | undefined, string | number>>;
-    id: zod.ZodOptional<zod.ZodString>;
+    height: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, number | undefined, string>>;
+    id: 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>;
@@ -130,6 +196,7 @@ declare const baseSchema: zod.ZodObject<{
     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>>;
+    sfSrc: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, URL | undefined, string>>;
     share: zod.ZodOptional<zod.ZodString>;
     slotID: zod.ZodString;
     slotName: zod.ZodString;
@@ -142,9 +209,10 @@ declare const baseSchema: 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<"">, zod.ZodNumber]>, string | undefined, string | number>>;
+    width: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">]>, number | undefined, string>>;
     widthLarge: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodString, zod.ZodLiteral<"">, zod.ZodNumber]>, string | undefined, string | number>>;
 }, "strip", zod.ZodTypeAny, {
+    id: string;
     origin: "JERLICIA" | "DALE";
     adType: string;
     slotID: string;
@@ -171,8 +239,7 @@ declare const baseSchema: zod.ZodObject<{
         mediaType: string;
         prebid?: unknown;
     } | undefined;
-    height?: string | undefined;
-    id?: string | undefined;
+    height?: number | undefined;
     impressionCounter?: URL | undefined;
     libId?: string | undefined;
     orderId?: string | undefined;
@@ -183,6 +250,7 @@ declare const baseSchema: zod.ZodObject<{
     poolPath?: URL | undefined;
     preview?: boolean | "" | undefined;
     priority?: number | undefined;
+    sfSrc?: URL | undefined;
     share?: string | undefined;
     swfSrc?: URL | undefined;
     tag?: string | Record<string, unknown> | readonly unknown[] | undefined;
@@ -193,9 +261,10 @@ declare const baseSchema: zod.ZodObject<{
     trackingUrl?: URL | undefined;
     url?: URL | undefined;
     viewableImpressionCounter?: URL | undefined;
-    width?: string | undefined;
+    width?: number | undefined;
     widthLarge?: string | undefined;
 }, {
+    id: string;
     origin: "JERLICIA" | "DALE";
     adType: string;
     slotID: string;
@@ -222,8 +291,7 @@ declare const baseSchema: zod.ZodObject<{
         mediaType: string;
         prebid?: unknown;
     } | undefined;
-    height?: string | number | undefined;
-    id?: string | undefined;
+    height?: string | undefined;
     impressionCounter?: string | undefined;
     libId?: string | undefined;
     orderId?: string | undefined;
@@ -234,6 +302,7 @@ declare const baseSchema: zod.ZodObject<{
     poolPath?: string | undefined;
     preview?: boolean | "" | undefined;
     priority?: string | undefined;
+    sfSrc?: string | undefined;
     share?: string | undefined;
     swfSrc?: string | undefined;
     tag?: string | undefined;
@@ -244,7 +313,7 @@ declare const baseSchema: zod.ZodObject<{
     trackingUrl?: string | undefined;
     url?: string | undefined;
     viewableImpressionCounter?: string | undefined;
-    width?: string | number | undefined;
+    width?: string | undefined;
     widthLarge?: string | number | undefined;
 }>;
 type AdResponse = (TypeOf<typeof baseSchema> & {
@@ -532,6 +601,7 @@ type AdheseOptions = {
      * The query detector options for the Adhese instance.
      */
     queries?: Record<string, string>;
+    safeFrame?: boolean;
 } & ({
     viewabilityTracking?: true;
     /**
@@ -628,6 +698,7 @@ type AdheseContext = Partial<Pick<Adhese, 'events' | 'getAll' | 'get' | 'paramet
     options: Readonly<MergedOptions>;
     logger: typeof logger;
     debug: boolean;
+    safeFrame?: SafeFrame;
 };
 
 /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@adhese/sdk",
   "type": "module",
-  "version": "0.5.2",
+  "version": "0.6.0",
   "description": "Adhese SDK",
   "license": "GPL-3.0",
   "repository": {
@@ -25,9 +25,10 @@
     "prepareRelease": "npm run build"
   },
   "dependencies": {
-    "@adhese/sdk-devtools": "^0.5.2",
+    "@adhese/sdk-devtools": "^0.6.0",
     "@vue/runtime-core": "^3.4.21",
     "lodash-es": "^4.17.21",
+    "safeframe": "^1.1.3",
     "zod": "^3.22.4"
   }
 }