@adhese/sdk 0.6.4 → 0.7.0

package/dist/index.d.ts

@@ -212,9 +212,9 @@ declare const baseSchema: zod.ZodObject<{
     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, {
+    adType: string;
     id: string;
     origin: "JERLICIA" | "DALE";
-    adType: string;
     slotID: string;
     slotName: string;
     adDuration?: number | undefined;
@@ -264,9 +264,9 @@ declare const baseSchema: zod.ZodObject<{
     width?: number | undefined;
     widthLarge?: string | undefined;
 }, {
+    adType: string;
     id: string;
     origin: "JERLICIA" | "DALE";
-    adType: string;
     slotID: string;
     slotName: string;
     adDuration?: string | undefined;
@@ -602,6 +602,11 @@ type AdheseOptions = {
      */
     queries?: Record<string, string>;
     safeFrame?: boolean;
+    /**
+     * The plugins that are used for the Adhese instance. These plugins are called with the Adhese context and run during
+     * the initialization of the Adhese instance.
+     */
+    plugins?: ReadonlyArray<(context: AdheseContext) => void>;
 } & ({
     viewabilityTracking?: true;
     /**
@@ -725,4 +730,8 @@ type AdheseContext = Partial<Pick<Adhese, 'events' | 'getAll' | 'get' | 'paramet
  */
 declare function createAdhese(options: AdheseOptions): Readonly<Adhese>;
 
-export { type Ad, type AdRequestOptions, type Adhese, type AdheseContext, type AdheseOptions, type AdheseSlot, type AdheseSlotOptions, createAdhese };
+declare const onInit: (callback: Function) => void;
+
+declare const onDispose: (callback: Function) => void;
+
+export { type Ad, type AdRequestOptions, type Adhese, type AdheseContext, type AdheseOptions, type AdheseSlot, type AdheseSlotOptions, createAdhese, onDispose, onInit };

package/dist/index.js

@@ -1,10 +1,5 @@
-import { createDevtools } from "@adhese/sdk-devtools";
 import { effectScope, shallowReactive, watchEffect, watch, reactive, ref, computed, toValue } from "@vue/runtime-core";
-import uniqueId from "lodash/uniqueId";
-import debounce from "lodash/debounce";
-import random from "lodash/random";
-import isEqual from "lodash/isEqual";
-import round from "lodash/round";
+import { debounce, round, isDeepEqual } from "remeda";
 import { union, coerce, literal, number, string, ZodIssueCode, NEVER, object, unknown, lazy } from "zod";
 async function waitForDomLoad() {
   return new Promise((resolve) => {
@@ -65,6 +60,15 @@ function createEvent() {
     removeListener
   };
 }
+const savedIds = /* @__PURE__ */ new Set();
+function uniqueId() {
+  let id;
+  do
+    id = Math.random().toString(36).slice(2);
+  while (savedIds.has(id));
+  savedIds.add(id);
+  return id;
+}
 function createSafeFrame({
   renderFile,
   context
@@ -186,10 +190,10 @@ function createSlotManager({
       var _a;
       const slot = createSlot({
         ...options,
-        onDispose,
+        onDispose: onDispose2,
         context
       });
-      function onDispose() {
+      function onDispose2() {
         var _a2;
         slots.delete(slot.name.value);
         logger.debug("Slot removed", {
@@ -271,14 +275,16 @@ function createQueryDetector({
   const handleOnChange = debounce(() => {
     void (onChange == null ? void 0 : onChange(getQuery()));
     logger.debug(`Change device ${getQuery()}`);
-  }, 50);
+  }, {
+    waitMs: 50
+  });
   if (onChange) {
     for (const query of mediaMap.values())
-      query.addEventListener("change", handleOnChange);
+      query.addEventListener("change", handleOnChange.call);
   }
   function dispose() {
     for (const query of mediaMap.values())
-      query.removeEventListener("change", handleOnChange);
+      query.removeEventListener("change", handleOnChange.call);
   }
   return {
     queries: mediaMap,
@@ -370,7 +376,7 @@ function createParameters(options, queryDetector) {
     tl: options.consent ? "all" : "none",
     dt: queryDetector.getQuery(),
     br: queryDetector.getQuery(),
-    rn: random(1e4).toString()
+    rn: Math.round(Math.random() * 1e4).toString()
   }))
     parameters.set(key, value);
   return parameters;
@@ -389,7 +395,8 @@ function isPreviewMode() {
 }
 function createHook({
   onRun,
-  onAdd
+  onAdd,
+  onDispose: onDispose2
 }) {
   const callbacks = /* @__PURE__ */ new Set();
   function run() {
@@ -401,7 +408,11 @@ function createHook({
     callbacks.add(callback);
     onAdd == null ? void 0 : onAdd(callbacks);
   }
-  return [run, add];
+  function dispose() {
+    onDispose2 == null ? void 0 : onDispose2(callbacks);
+    callbacks.clear();
+  }
+  return [run, add, dispose];
 }
 let resolveOnInitPromise = () => {
 };
@@ -409,7 +420,7 @@ let isInit = false;
 const waitOnInit = new Promise((resolve) => {
   resolveOnInitPromise = resolve;
 });
-const [runOnInit, onInit] = createHook({
+const [runOnInit, onInit, disposeOnInit] = createHook({
   onRun(callbacks) {
     isInit = true;
     resolveOnInitPromise();
@@ -421,6 +432,24 @@ const [runOnInit, onInit] = createHook({
       runOnInit();
   }
 });
+let resolveOnDisposePromise = () => {
+};
+let isDisposed = false;
+new Promise((resolve) => {
+  resolveOnDisposePromise = resolve;
+});
+const [runOnDispose, onDispose, disposeOnDispose] = createHook({
+  onRun(callbacks) {
+    isDisposed = true;
+    resolveOnDisposePromise();
+    logger.debug("Disposal completed");
+    callbacks.clear();
+  },
+  onAdd() {
+    if (isDisposed)
+      runOnDispose();
+  }
+});
 function createAdhese(options) {
   const scope = effectScope();
   return scope.run(() => {
@@ -438,6 +467,7 @@ function createAdhese(options) {
       safeFrame: false,
       eagerRendering: false,
       viewabilityTracking: true,
+      plugins: [],
       ...options
     };
     setupLogging(mergedOptions);
@@ -534,19 +564,15 @@ function createAdhese(options) {
       }
       return domSlots;
     }
-    let unmountDevtools;
     async function toggleDebug() {
       var _a, _b;
       context.debug = !context.debug;
-      if (context.debug && !unmountDevtools) {
-        unmountDevtools = await createDevtools(context);
+      if (context.debug) {
         logger.setMinLogLevelThreshold("debug");
         logger.debug("Debug mode enabled");
         (_a = context.events) == null ? void 0 : _a.debugChange.dispatch(true);
       } else {
         logger.debug("Debug mode disabled");
-        unmountDevtools == null ? void 0 : unmountDevtools();
-        unmountDevtools = void 0;
         logger.setMinLogLevelThreshold("info");
         (_b = context.events) == null ? void 0 : _b.debugChange.dispatch(false);
       }
@@ -579,7 +605,6 @@ function createAdhese(options) {
     });
     function dispose() {
       var _a, _b;
-      unmountDevtools == null ? void 0 : unmountDevtools();
       queryDetector.dispose();
       slotManager.dispose();
       queryDetector.dispose();
@@ -588,18 +613,21 @@ function createAdhese(options) {
       logger.resetLogs();
       (_b = context.events) == null ? void 0 : _b.dispose();
       logger.info("Adhese instance disposed");
+      runOnDispose();
+      disposeOnInit();
+      disposeOnDispose();
       scope.stop();
     }
+    for (const plugin of mergedOptions.plugins)
+      plugin(context);
     onInit(async () => {
       var _a;
       if ((slotManager.getAll().length ?? 0) > 0)
         await fetchAndRenderAllSlots().catch(logger.error);
       if (mergedOptions.findDomSlotsOnLoad)
         await findDomSlots2();
-      if (mergedOptions.debug || window.location.search.includes("adhese_debug=true") || isPreviewMode()) {
-        unmountDevtools = await createDevtools(context);
+      if (mergedOptions.debug || window.location.search.includes("adhese_debug=true") || isPreviewMode())
         (_a = context.events) == null ? void 0 : _a.debugChange.dispatch(true);
-      }
       if (!scope.active)
         dispose();
     });
@@ -780,7 +808,7 @@ function createSlot(options) {
     });
     watch([ad, isInViewport], async ([newAd, newIsInViewport], [oldAd]) => {
       var _a, _b;
-      if (!newAd || isEqual(newAd, oldAd))
+      if (!newAd || oldAd && isDeepEqual(newAd, oldAd))
         return;
       if (newIsInViewport || context.options.eagerRendering)
         await render(newAd);
@@ -1118,8 +1146,16 @@ function parseParameters(parameters) {
       return true;
     logger.warn(`Invalid parameter key: ${key}. Key should be exactly 2 characters long. Key will be ignored.`);
     return false;
+  }).map(([key, value]) => {
+    if (typeof value === "string")
+      return [key, filterSpecialChars(value)];
+    return [key, value.map(filterSpecialChars)];
   }));
 }
+function filterSpecialChars(value) {
+  const specialRegex = /[^\p{L}\p{N}_]/gu;
+  return value.replaceAll(specialRegex, "_");
+}
 async function requestAds(options) {
   var _a, _b, _c, _d, _e;
   const { context } = options;
@@ -1170,6 +1206,8 @@ async function requestAd({
   return ad;
 }
 export {
-  createAdhese
+  createAdhese,
+  onDispose,
+  onInit
 };
 //# sourceMappingURL=index.js.map