@adhese/sdk 0.21.1 → 1.0.0

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @adhese/sdk
 
+## 1.0.0
+
+### Major Changes
+
+- ff93b63: 🎉🎉🎉 – Release 1.0.0 – 🎉🎉🎉
+
+  This release marks the first stable release of the Adhese SDK packages. From here on out we will follow semantic
+  versioning, meaning that all patch and minor updates will be backwards compatible. Major updates will introduce
+  breaking changes.
+
+### Patch Changes
+
+- 21aad18: Move render functions to @adhese/sdk-shared
+- Updated dependencies [ff93b63]
+- Updated dependencies [21aad18]
+  - @adhese/sdk-shared@1.0.0
+
+## 0.22.0
+
+### Minor Changes
+
+- 3ba6fd6: Add isVissible property to slots
+
 ## 0.21.1
 
 ### Patch Changes

package/dist/cjs/package.json.cjs

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const name = "@adhese/sdk";
-const version = "0.21.1";
+const version = "1.0.0";
 exports.name = name;
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.map

package/dist/cjs/requestAds/requestAds.cjs

@@ -13,7 +13,7 @@ const runRequestAdsBatch = sdkShared.debounce(async (context) => {
     context
   });
   for (const { options, resolve } of batch.values()) {
-    const ad = ads.find(({ slotName }) => sdkShared.toValue(slotName) === sdkShared.toValue(options.slot.name));
+    const ad = ads.find(({ slotName }) => slotName === options.slot.name);
     if (ad)
       resolve(ad);
     else
@@ -28,7 +28,7 @@ const runRequestAdsBatch = sdkShared.debounce(async (context) => {
 async function requestAd(options) {
   const promise = new Promise(
     (resolve) => {
-      batch.set(sdkShared.toValue(options.slot.name), { options, resolve });
+      batch.set(options.slot.name, { options, resolve });
     }
   );
   await runRequestAdsBatch.call(options.context);

package/dist/cjs/requestAds/requestAds.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"requestAds.cjs","sources":["../../../src/requestAds/requestAds.ts"],"sourcesContent":["import { type MaybeRef, debounce, toValue } from '@adhese/sdk-shared';\nimport type { AdheseContext } from '../main.types';\nimport { logger } from '../logger/logger';\nimport type { AdheseAd } from './requestAds.schema';\nimport { requestPreviews } from './requestAds.preview';\nimport { requestWithGet, requestWithPost } from './requestAds.utils';\n\nexport type AdRequestOptions = {\n  /**\n   * Slot you want to fetch the ad for\n   */\n  slot: {\n    name: MaybeRef<string>;\n    parameters: Map<string, ReadonlyArray<string> | string>;\n  };\n  context: AdheseContext;\n};\n\nexport type AdMultiRequestOptions = Omit<AdRequestOptions, 'slot'> & {\n  slots: ReadonlyArray<AdRequestOptions['slot']>;\n};\n\nconst batch = new Map<string, {\n  options: AdRequestOptions;\n  resolve(ad: AdheseAd | null): void;\n}>();\n\n/**\n * Debounced function to request ads in batches. This function is debounced to prevent multiple requests for the same ad.\n */\nconst runRequestAdsBatch = debounce(async (context: AdheseContext) => {\n  if (batch.size === 0)\n    return [];\n\n  const ads = await requestAds({\n    slots: Array.from(batch.values()).map(({ options }) => options.slot),\n    context,\n  });\n\n  for (const { options, resolve } of batch.values()) {\n    const ad = ads.find(({ slotName }) => toValue(slotName) === toValue(options.slot.name));\n\n    if (ad)\n      resolve(ad);\n    else\n      resolve(null);\n  }\n\n  batch.clear();\n\n  return ads;\n}, {\n  waitMs: 20,\n  timing: 'trailing',\n});\n\n/**\n * Request a single ad from the API. If you need to fetch multiple ads at once use the `requestAds` function.\n */\nexport async function requestAd(options: AdRequestOptions): Promise<AdheseAd | null> {\n  const promise = new Promise<AdheseAd | null>((resolve) => {\n    batch.set(toValue(options.slot.name), { options, resolve });\n  },\n  );\n\n  await runRequestAdsBatch.call(options.context);\n\n  return promise;\n}\n\n/**\n * Request multiple ads from the API. If you need to fetch a single ad use the `requestAd` function.\n */\nexport async function requestAds(requestOptions: AdMultiRequestOptions): Promise<ReadonlyArray<AdheseAd>> {\n  const options = await requestOptions.context.hooks.runOnRequest(requestOptions);\n\n  const { context } = options;\n\n  try {\n    context?.events?.requestAd.dispatch({\n      ...options,\n      context,\n    });\n\n    const [response, previews, parseResponse] = await Promise.all([\n      context.options.requestType?.toUpperCase() === 'POST'\n        ? requestWithPost(options)\n        : requestWithGet(options),\n      requestPreviews(context.options.account),\n      import('./requestAds.schema').then(module => module.parseResponse),\n    ]);\n\n    logger.debug('Received response', response);\n\n    if (!response.ok)\n      throw new Error(`Failed to request ad: ${response.status} ${response.statusText}`);\n\n    const result = parseResponse((await response.json() as unknown));\n    logger.debug('Parsed ad', result);\n\n    if (previews.length > 0)\n      logger.info(`Found ${previews.length} ${previews.length === 1 ? 'preview' : 'previews'}. Replacing ads in response with preview items`, previews);\n\n    const matchedPreviews = previews.map(({ slotName, ...preview }) => {\n      const partnerAd = result.find(ad => ad.libId === preview.libId);\n\n      return ({\n        slotName: `${partnerAd?.slotName ?? slotName}`,\n        ...preview,\n      });\n    });\n\n    if (matchedPreviews.length > 0)\n      context.events?.previewReceived.dispatch(matchedPreviews);\n\n    const mergedResult = await context.hooks.runOnResponse([\n      ...result.filter(ad => !previews.some(preview => preview.libId === ad.libId)),\n      ...matchedPreviews,\n    ]);\n\n    context.events?.responseReceived.dispatch(mergedResult);\n\n    return mergedResult;\n  }\n  catch (error) {\n    logger.error(String(error));\n    context?.events?.requestError.dispatch(error as Error);\n\n    throw error;\n  }\n}\n"],"names":["debounce","toValue","requestWithPost","requestWithGet","requestPreviews","module","logger"],"mappings":";;;;;;AAsBA,MAAM,4BAAY;AAQlB,MAAM,qBAAqBA,UAAAA,SAAS,OAAO,YAA2B;AACpE,MAAI,MAAM,SAAS;AACjB,WAAO;AAEH,QAAA,MAAM,MAAM,WAAW;AAAA,IAC3B,OAAO,MAAM,KAAK,MAAM,OAAQ,CAAA,EAAE,IAAI,CAAC,EAAE,cAAc,QAAQ,IAAI;AAAA,IACnE;AAAA,EAAA,CACD;AAED,aAAW,EAAE,SAAS,QAAa,KAAA,MAAM,UAAU;AACjD,UAAM,KAAK,IAAI,KAAK,CAAC,EAAE,SAAS,MAAMC,UAAAA,QAAQ,QAAQ,MAAMA,UAAAA,QAAQ,QAAQ,KAAK,IAAI,CAAC;AAElF,QAAA;AACF,cAAQ,EAAE;AAAA;AAEV,cAAQ,IAAI;AAAA,EAChB;AAEA,QAAM,MAAM;AAEL,SAAA;AACT,GAAG;AAAA,EACD,QAAQ;AAAA,EACR,QAAQ;AACV,CAAC;AAKD,eAAsB,UAAU,SAAqD;AACnF,QAAM,UAAU,IAAI;AAAA,IAAyB,CAAC,YAAY;AAClD,YAAA,IAAIA,kBAAQ,QAAQ,KAAK,IAAI,GAAG,EAAE,SAAS,QAAA,CAAS;AAAA,IAC5D;AAAA,EAAA;AAGM,QAAA,mBAAmB,KAAK,QAAQ,OAAO;AAEtC,SAAA;AACT;AAKA,eAAsB,WAAW,gBAAyE;;AACxG,QAAM,UAAU,MAAM,eAAe,QAAQ,MAAM,aAAa,cAAc;AAExE,QAAA,EAAE,QAAY,IAAA;AAEhB,MAAA;AACO,6CAAA,WAAA,mBAAQ,UAAU,SAAS;AAAA,MAClC,GAAG;AAAA,MACH;AAAA,IAAA;AAGF,UAAM,CAAC,UAAU,UAAU,aAAa,IAAI,MAAM,QAAQ,IAAI;AAAA,QAC5D,aAAQ,QAAQ,gBAAhB,mBAA6B,mBAAkB,SAC3CC,iBAAAA,gBAAgB,OAAO,IACvBC,iBAAA,eAAe,OAAO;AAAA,MAC1BC,mCAAgB,QAAQ,QAAQ,OAAO;AAAA,MACvC,QAAO,QAAA,EAAA,KAAA,MAAA,QAAA,yBAAqB,CAAA,EAAE,KAAK,CAAAC,YAAUA,QAAO,aAAa;AAAA,IAAA,CAClE;AAEMC,WAAAA,OAAA,MAAM,qBAAqB,QAAQ;AAE1C,QAAI,CAAC,SAAS;AACN,YAAA,IAAI,MAAM,yBAAyB,SAAS,MAAM,IAAI,SAAS,UAAU,EAAE;AAEnF,UAAM,SAAS,cAAe,MAAM,SAAS,KAAkB,CAAA;AACxDA,WAAAA,OAAA,MAAM,aAAa,MAAM;AAEhC,QAAI,SAAS,SAAS;AACbA,aAAA,OAAA,KAAK,SAAS,SAAS,MAAM,IAAI,SAAS,WAAW,IAAI,YAAY,UAAU,kDAAkD,QAAQ;AAE5I,UAAA,kBAAkB,SAAS,IAAI,CAAC,EAAE,UAAU,GAAG,cAAc;AACjE,YAAM,YAAY,OAAO,KAAK,QAAM,GAAG,UAAU,QAAQ,KAAK;AAEtD,aAAA;AAAA,QACN,UAAU,IAAG,uCAAW,aAAY,QAAQ;AAAA,QAC5C,GAAG;AAAA,MAAA;AAAA,IACL,CACD;AAED,QAAI,gBAAgB,SAAS;AACnB,oBAAA,WAAA,mBAAQ,gBAAgB,SAAS;AAE3C,UAAM,eAAe,MAAM,QAAQ,MAAM,cAAc;AAAA,MACrD,GAAG,OAAO,OAAO,CAAA,OAAM,CAAC,SAAS,KAAK,CAAA,YAAW,QAAQ,UAAU,GAAG,KAAK,CAAC;AAAA,MAC5E,GAAG;AAAA,IAAA,CACJ;AAEO,kBAAA,WAAA,mBAAQ,iBAAiB,SAAS;AAEnC,WAAA;AAAA,WAEF,OAAO;AACLA,WAAAA,OAAA,MAAM,OAAO,KAAK,CAAC;AACjB,6CAAA,WAAA,mBAAQ,aAAa,SAAS;AAEjC,UAAA;AAAA,EACR;AACF;;;"}
+{"version":3,"file":"requestAds.cjs","sources":["../../../src/requestAds/requestAds.ts"],"sourcesContent":["import { debounce } from '@adhese/sdk-shared';\nimport type { AdheseContext } from '../main.types';\nimport { logger } from '../logger/logger';\nimport type { AdheseAd } from './requestAds.schema';\nimport { requestPreviews } from './requestAds.preview';\nimport { requestWithGet, requestWithPost } from './requestAds.utils';\n\nexport type AdRequestOptions = {\n  /**\n   * Slot you want to fetch the ad for\n   */\n  slot: {\n    name: string;\n    parameters: Map<string, ReadonlyArray<string> | string>;\n  };\n  context: AdheseContext;\n};\n\nexport type AdMultiRequestOptions = Omit<AdRequestOptions, 'slot'> & {\n  slots: ReadonlyArray<AdRequestOptions['slot']>;\n};\n\nconst batch = new Map<string, {\n  options: AdRequestOptions;\n  resolve(ad: AdheseAd | null): void;\n}>();\n\n/**\n * Debounced function to request ads in batches. This function is debounced to prevent multiple requests for the same ad.\n */\nconst runRequestAdsBatch = debounce(async (context: AdheseContext) => {\n  if (batch.size === 0)\n    return [];\n\n  const ads = await requestAds({\n    slots: Array.from(batch.values()).map(({ options }) => options.slot),\n    context,\n  });\n\n  for (const { options, resolve } of batch.values()) {\n    const ad = ads.find(({ slotName }) => slotName === options.slot.name);\n\n    if (ad)\n      resolve(ad);\n    else\n      resolve(null);\n  }\n\n  batch.clear();\n\n  return ads;\n}, {\n  waitMs: 20,\n  timing: 'trailing',\n});\n\n/**\n * Request a single ad from the API. If you need to fetch multiple ads at once use the `requestAds` function.\n */\nexport async function requestAd(options: AdRequestOptions): Promise<AdheseAd | null> {\n  const promise = new Promise<AdheseAd | null>((resolve) => {\n    batch.set(options.slot.name, { options, resolve });\n  },\n  );\n\n  await runRequestAdsBatch.call(options.context);\n\n  return promise;\n}\n\n/**\n * Request multiple ads from the API. If you need to fetch a single ad use the `requestAd` function.\n */\nexport async function requestAds(requestOptions: AdMultiRequestOptions): Promise<ReadonlyArray<AdheseAd>> {\n  const options = await requestOptions.context.hooks.runOnRequest(requestOptions);\n\n  const { context } = options;\n\n  try {\n    context?.events?.requestAd.dispatch({\n      ...options,\n      context,\n    });\n\n    const [response, previews, parseResponse] = await Promise.all([\n      context.options.requestType?.toUpperCase() === 'POST'\n        ? requestWithPost(options)\n        : requestWithGet(options),\n      requestPreviews(context.options.account),\n      import('./requestAds.schema').then(module => module.parseResponse),\n    ]);\n\n    logger.debug('Received response', response);\n\n    if (!response.ok)\n      throw new Error(`Failed to request ad: ${response.status} ${response.statusText}`);\n\n    const result = parseResponse((await response.json() as unknown));\n    logger.debug('Parsed ad', result);\n\n    if (previews.length > 0)\n      logger.info(`Found ${previews.length} ${previews.length === 1 ? 'preview' : 'previews'}. Replacing ads in response with preview items`, previews);\n\n    const matchedPreviews = previews.map(({ slotName, ...preview }) => {\n      const partnerAd = result.find(ad => ad.libId === preview.libId);\n\n      return ({\n        slotName: `${partnerAd?.slotName ?? slotName}`,\n        ...preview,\n      });\n    });\n\n    if (matchedPreviews.length > 0)\n      context.events?.previewReceived.dispatch(matchedPreviews);\n\n    const mergedResult = await context.hooks.runOnResponse([\n      ...result.filter(ad => !previews.some(preview => preview.libId === ad.libId)),\n      ...matchedPreviews,\n    ]);\n\n    context.events?.responseReceived.dispatch(mergedResult);\n\n    return mergedResult;\n  }\n  catch (error) {\n    logger.error(String(error));\n    context?.events?.requestError.dispatch(error as Error);\n\n    throw error;\n  }\n}\n"],"names":["debounce","requestWithPost","requestWithGet","requestPreviews","module","logger"],"mappings":";;;;;;AAsBA,MAAM,4BAAY;AAQlB,MAAM,qBAAqBA,UAAAA,SAAS,OAAO,YAA2B;AACpE,MAAI,MAAM,SAAS;AACjB,WAAO;AAEH,QAAA,MAAM,MAAM,WAAW;AAAA,IAC3B,OAAO,MAAM,KAAK,MAAM,OAAQ,CAAA,EAAE,IAAI,CAAC,EAAE,cAAc,QAAQ,IAAI;AAAA,IACnE;AAAA,EAAA,CACD;AAED,aAAW,EAAE,SAAS,QAAa,KAAA,MAAM,UAAU;AAC3C,UAAA,KAAK,IAAI,KAAK,CAAC,EAAE,eAAe,aAAa,QAAQ,KAAK,IAAI;AAEhE,QAAA;AACF,cAAQ,EAAE;AAAA;AAEV,cAAQ,IAAI;AAAA,EAChB;AAEA,QAAM,MAAM;AAEL,SAAA;AACT,GAAG;AAAA,EACD,QAAQ;AAAA,EACR,QAAQ;AACV,CAAC;AAKD,eAAsB,UAAU,SAAqD;AACnF,QAAM,UAAU,IAAI;AAAA,IAAyB,CAAC,YAAY;AACxD,YAAM,IAAI,QAAQ,KAAK,MAAM,EAAE,SAAS,SAAS;AAAA,IACnD;AAAA,EAAA;AAGM,QAAA,mBAAmB,KAAK,QAAQ,OAAO;AAEtC,SAAA;AACT;AAKA,eAAsB,WAAW,gBAAyE;;AACxG,QAAM,UAAU,MAAM,eAAe,QAAQ,MAAM,aAAa,cAAc;AAExE,QAAA,EAAE,QAAY,IAAA;AAEhB,MAAA;AACO,6CAAA,WAAA,mBAAQ,UAAU,SAAS;AAAA,MAClC,GAAG;AAAA,MACH;AAAA,IAAA;AAGF,UAAM,CAAC,UAAU,UAAU,aAAa,IAAI,MAAM,QAAQ,IAAI;AAAA,QAC5D,aAAQ,QAAQ,gBAAhB,mBAA6B,mBAAkB,SAC3CC,iBAAAA,gBAAgB,OAAO,IACvBC,iBAAA,eAAe,OAAO;AAAA,MAC1BC,mCAAgB,QAAQ,QAAQ,OAAO;AAAA,MACvC,QAAO,QAAA,EAAA,KAAA,MAAA,QAAA,yBAAqB,CAAA,EAAE,KAAK,CAAAC,YAAUA,QAAO,aAAa;AAAA,IAAA,CAClE;AAEMC,WAAAA,OAAA,MAAM,qBAAqB,QAAQ;AAE1C,QAAI,CAAC,SAAS;AACN,YAAA,IAAI,MAAM,yBAAyB,SAAS,MAAM,IAAI,SAAS,UAAU,EAAE;AAEnF,UAAM,SAAS,cAAe,MAAM,SAAS,KAAkB,CAAA;AACxDA,WAAAA,OAAA,MAAM,aAAa,MAAM;AAEhC,QAAI,SAAS,SAAS;AACbA,aAAA,OAAA,KAAK,SAAS,SAAS,MAAM,IAAI,SAAS,WAAW,IAAI,YAAY,UAAU,kDAAkD,QAAQ;AAE5I,UAAA,kBAAkB,SAAS,IAAI,CAAC,EAAE,UAAU,GAAG,cAAc;AACjE,YAAM,YAAY,OAAO,KAAK,QAAM,GAAG,UAAU,QAAQ,KAAK;AAEtD,aAAA;AAAA,QACN,UAAU,IAAG,uCAAW,aAAY,QAAQ;AAAA,QAC5C,GAAG;AAAA,MAAA;AAAA,IACL,CACD;AAED,QAAI,gBAAgB,SAAS;AACnB,oBAAA,WAAA,mBAAQ,gBAAgB,SAAS;AAE3C,UAAM,eAAe,MAAM,QAAQ,MAAM,cAAc;AAAA,MACrD,GAAG,OAAO,OAAO,CAAA,OAAM,CAAC,SAAS,KAAK,CAAA,YAAW,QAAQ,UAAU,GAAG,KAAK,CAAC;AAAA,MAC5E,GAAG;AAAA,IAAA,CACJ;AAEO,kBAAA,WAAA,mBAAQ,iBAAiB,SAAS;AAEnC,WAAA;AAAA,WAEF,OAAO;AACLA,WAAAA,OAAA,MAAM,OAAO,KAAK,CAAC;AACjB,6CAAA,WAAA,mBAAQ,aAAa,SAAS;AAEjC,UAAA;AAAA,EACR;AACF;;;"}

package/dist/cjs/requestAds/requestAds.utils.cjs

@@ -9,7 +9,7 @@ function requestWithPost({
   const payload = {
     ...options,
     slots: options.slots.map((slot) => ({
-      slotname: sdkShared.toValue(slot.name),
+      slotname: slot.name,
       parameters: parseParameters(slot.parameters)
     })),
     parameters: context.parameters && parseParameters(context.parameters)

package/dist/cjs/requestAds/requestAds.utils.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"requestAds.utils.cjs","sources":["../../../src/requestAds/requestAds.utils.ts"],"sourcesContent":["import { toValue } from '@adhese/sdk-shared';\nimport { logger } from '../logger/logger';\nimport type { AdMultiRequestOptions } from './requestAds';\n\ntype AdPostPayload = {\n  slots: ReadonlyArray<{\n    slotname: string;\n    parameters?: Record<string, ReadonlyArray<string> | string>;\n  }>;\n  parameters?: Record<string, ReadonlyArray<string> | string>;\n};\n\nexport function requestWithPost({\n  context,\n  ...options\n}: Omit<AdMultiRequestOptions, 'method'>): Promise<Response> {\n  const payload = {\n    ...options,\n    slots: options.slots.map(slot => ({\n      slotname: toValue(slot.name),\n      parameters: parseParameters(slot.parameters),\n    })),\n    parameters: context.parameters && parseParameters(context.parameters),\n  } satisfies AdPostPayload;\n\n  return fetch(`${new URL(context.options.host).href}json`, {\n    method: 'POST',\n    body: JSON.stringify(payload),\n    headers: {\n      // eslint-disable-next-line ts/naming-convention\n      'Content-Type': 'application/json',\n    },\n  });\n}\n\nexport async function requestWithGet({ context, slots }: Omit<AdMultiRequestOptions, 'method'>): Promise<Response> {\n  return fetch(new URL(`${context.options.host}/json/sl${slots.map(slot => toValue(slot.name)).join('/sl')}`), {\n    method: 'GET',\n    headers: {\n      // eslint-disable-next-line ts/naming-convention\n      'Content-Type': 'application/json',\n    },\n  });\n}\n\nexport function parseParameters<T extends string | ReadonlyArray<string>>(parameters: Map<string, T>): Record<string, T> {\n  return Object.fromEntries(Array.from(parameters.entries()).filter(([key]) => {\n    if (key.length === 2)\n      return true;\n\n    logger.warn(`Invalid parameter key: ${key}. Key should be exactly 2 characters long. Key will be ignored.`);\n    return false;\n  }).map(([key, value]): [string, T] => {\n    if (typeof value === 'string')\n      return [key, filterSpecialChars(value) as T];\n\n    return [key, value.map(filterSpecialChars) as unknown as T];\n  }));\n}\n\nfunction filterSpecialChars(value: string): string {\n  const specialRegex = /[^\\p{L}\\p{N}_]/gu;\n\n  return value.replaceAll(specialRegex, '_');\n}\n"],"names":["toValue","logger"],"mappings":";;;;AAYO,SAAS,gBAAgB;AAAA,EAC9B;AAAA,EACA,GAAG;AACL,GAA6D;AAC3D,QAAM,UAAU;AAAA,IACd,GAAG;AAAA,IACH,OAAO,QAAQ,MAAM,IAAI,CAAS,UAAA;AAAA,MAChC,UAAUA,UAAAA,QAAQ,KAAK,IAAI;AAAA,MAC3B,YAAY,gBAAgB,KAAK,UAAU;AAAA,IAAA,EAC3C;AAAA,IACF,YAAY,QAAQ,cAAc,gBAAgB,QAAQ,UAAU;AAAA,EAAA;AAG/D,SAAA,MAAM,GAAG,IAAI,IAAI,QAAQ,QAAQ,IAAI,EAAE,IAAI,QAAQ;AAAA,IACxD,QAAQ;AAAA,IACR,MAAM,KAAK,UAAU,OAAO;AAAA,IAC5B,SAAS;AAAA;AAAA,MAEP,gBAAgB;AAAA,IAClB;AAAA,EAAA,CACD;AACH;AAEA,eAAsB,eAAe,EAAE,SAAS,SAAmE;AAC1G,SAAA,MAAM,IAAI,IAAI,GAAG,QAAQ,QAAQ,IAAI,WAAW,MAAM,IAAI,UAAQA,UAAAA,QAAQ,KAAK,IAAI,CAAC,EAAE,KAAK,KAAK,CAAC,EAAE,GAAG;AAAA,IAC3G,QAAQ;AAAA,IACR,SAAS;AAAA;AAAA,MAEP,gBAAgB;AAAA,IAClB;AAAA,EAAA,CACD;AACH;AAEO,SAAS,gBAA0D,YAA+C;AACvH,SAAO,OAAO,YAAY,MAAM,KAAK,WAAW,QAAA,CAAS,EAAE,OAAO,CAAC,CAAC,GAAG,MAAM;AAC3E,QAAI,IAAI,WAAW;AACV,aAAA;AAEFC,WAAA,OAAA,KAAK,0BAA0B,GAAG,iEAAiE;AACnG,WAAA;AAAA,EACR,CAAA,EAAE,IAAI,CAAC,CAAC,KAAK,KAAK,MAAmB;AACpC,QAAI,OAAO,UAAU;AACnB,aAAO,CAAC,KAAK,mBAAmB,KAAK,CAAM;AAE7C,WAAO,CAAC,KAAK,MAAM,IAAI,kBAAkB,CAAiB;AAAA,EAC3D,CAAA,CAAC;AACJ;AAEA,SAAS,mBAAmB,OAAuB;AACjD,QAAM,eAAe;AAEd,SAAA,MAAM,WAAW,cAAc,GAAG;AAC3C;;;;"}
+{"version":3,"file":"requestAds.utils.cjs","sources":["../../../src/requestAds/requestAds.utils.ts"],"sourcesContent":["import { toValue } from '@adhese/sdk-shared';\nimport { logger } from '../logger/logger';\nimport type { AdMultiRequestOptions } from './requestAds';\n\ntype AdPostPayload = {\n  slots: ReadonlyArray<{\n    slotname: string;\n    parameters?: Record<string, ReadonlyArray<string> | string>;\n  }>;\n  parameters?: Record<string, ReadonlyArray<string> | string>;\n};\n\nexport function requestWithPost({\n  context,\n  ...options\n}: Omit<AdMultiRequestOptions, 'method'>): Promise<Response> {\n  const payload = {\n    ...options,\n    slots: options.slots.map(slot => ({\n      slotname: slot.name,\n      parameters: parseParameters(slot.parameters),\n    })),\n    parameters: context.parameters && parseParameters(context.parameters),\n  } satisfies AdPostPayload;\n\n  return fetch(`${new URL(context.options.host).href}json`, {\n    method: 'POST',\n    body: JSON.stringify(payload),\n    headers: {\n      // eslint-disable-next-line ts/naming-convention\n      'Content-Type': 'application/json',\n    },\n  });\n}\n\nexport async function requestWithGet({ context, slots }: Omit<AdMultiRequestOptions, 'method'>): Promise<Response> {\n  return fetch(new URL(`${context.options.host}/json/sl${slots.map(slot => toValue(slot.name)).join('/sl')}`), {\n    method: 'GET',\n    headers: {\n      // eslint-disable-next-line ts/naming-convention\n      'Content-Type': 'application/json',\n    },\n  });\n}\n\nexport function parseParameters<T extends string | ReadonlyArray<string>>(parameters: Map<string, T>): Record<string, T> {\n  return Object.fromEntries(Array.from(parameters.entries()).filter(([key]) => {\n    if (key.length === 2)\n      return true;\n\n    logger.warn(`Invalid parameter key: ${key}. Key should be exactly 2 characters long. Key will be ignored.`);\n    return false;\n  }).map(([key, value]): [string, T] => {\n    if (typeof value === 'string')\n      return [key, filterSpecialChars(value) as T];\n\n    return [key, value.map(filterSpecialChars) as unknown as T];\n  }));\n}\n\nfunction filterSpecialChars(value: string): string {\n  const specialRegex = /[^\\p{L}\\p{N}_]/gu;\n\n  return value.replaceAll(specialRegex, '_');\n}\n"],"names":["toValue","logger"],"mappings":";;;;AAYO,SAAS,gBAAgB;AAAA,EAC9B;AAAA,EACA,GAAG;AACL,GAA6D;AAC3D,QAAM,UAAU;AAAA,IACd,GAAG;AAAA,IACH,OAAO,QAAQ,MAAM,IAAI,CAAS,UAAA;AAAA,MAChC,UAAU,KAAK;AAAA,MACf,YAAY,gBAAgB,KAAK,UAAU;AAAA,IAAA,EAC3C;AAAA,IACF,YAAY,QAAQ,cAAc,gBAAgB,QAAQ,UAAU;AAAA,EAAA;AAG/D,SAAA,MAAM,GAAG,IAAI,IAAI,QAAQ,QAAQ,IAAI,EAAE,IAAI,QAAQ;AAAA,IACxD,QAAQ;AAAA,IACR,MAAM,KAAK,UAAU,OAAO;AAAA,IAC5B,SAAS;AAAA;AAAA,MAEP,gBAAgB;AAAA,IAClB;AAAA,EAAA,CACD;AACH;AAEA,eAAsB,eAAe,EAAE,SAAS,SAAmE;AAC1G,SAAA,MAAM,IAAI,IAAI,GAAG,QAAQ,QAAQ,IAAI,WAAW,MAAM,IAAI,UAAQA,UAAAA,QAAQ,KAAK,IAAI,CAAC,EAAE,KAAK,KAAK,CAAC,EAAE,GAAG;AAAA,IAC3G,QAAQ;AAAA,IACR,SAAS;AAAA;AAAA,MAEP,gBAAgB;AAAA,IAClB;AAAA,EAAA,CACD;AACH;AAEO,SAAS,gBAA0D,YAA+C;AACvH,SAAO,OAAO,YAAY,MAAM,KAAK,WAAW,QAAA,CAAS,EAAE,OAAO,CAAC,CAAC,GAAG,MAAM;AAC3E,QAAI,IAAI,WAAW;AACV,aAAA;AAEFC,WAAA,OAAA,KAAK,0BAA0B,GAAG,iEAAiE;AACnG,WAAA;AAAA,EACR,CAAA,EAAE,IAAI,CAAC,CAAC,KAAK,KAAK,MAAmB;AACpC,QAAI,OAAO,UAAU;AACnB,aAAO,CAAC,KAAK,mBAAmB,KAAK,CAAM;AAE7C,WAAO,CAAC,KAAK,MAAM,IAAI,kBAAkB,CAAiB;AAAA,EAC3D,CAAA,CAAC;AACJ;AAEA,SAAS,mBAAmB,OAAuB;AACjD,QAAM,eAAe;AAEd,SAAA,MAAM,WAAW,cAAc,GAAG;AAC3C;;;;"}

package/dist/cjs/slot/slot.cjs

@@ -4,11 +4,10 @@ const sdkShared = require("@adhese/sdk-shared");
 const requestAds = require("../requestAds/requestAds.cjs");
 const logger = require("../logger/logger.cjs");
 const queryDetector = require("../queryDetector/queryDetector.cjs");
-const slot_utils = require("./slot.utils.cjs");
 const slot_composables = require("./slot.composables.cjs");
 const renderFunctions = {
-  iframe: slot_utils.renderIframe,
-  inline: slot_utils.renderInline,
+  iframe: sdkShared.renderIframe,
+  inline: sdkShared.renderInline,
   none: sdkShared.doNothing
 };
 const defaultOptions = {
@@ -201,6 +200,7 @@ function createSlot(slotOptions) {
       isDisposed,
       id,
       pluginOptions,
+      isVisible: isInViewport,
       render,
       request,
       dispose,

package/dist/cjs/slot/slot.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"slot.cjs","sources":["../../../src/slot/slot.ts"],"sourcesContent":["import {\n  type Ref,\n  type UnwrapRef,\n  addTrackingPixel,\n  computed,\n  doNothing,\n  effectScope,\n  generateName,\n  isDeepEqual,\n  omit,\n  reactive,\n  ref,\n  uniqueId,\n  waitForDomLoad,\n  watch,\n} from '@adhese/sdk-shared';\nimport type { AdheseAd } from '@adhese/sdk';\nimport { requestAd as extRequestAd } from '../requestAds/requestAds';\nimport { logger } from '../logger/logger';\nimport { useQueryDetector } from '../queryDetector/queryDetector';\nimport type { AdheseSlot, AdheseSlotContext, AdheseSlotOptions, RenderMode } from './slot.types';\nimport { renderIframe, renderInline } from './slot.utils';\nimport {\n  useDomLoaded,\n  useRenderIntersectionObserver,\n  useSlotHooks,\n  useViewabilityObserver,\n} from './slot.composables';\n\nconst renderFunctions: Record<RenderMode, (ad: AdheseAd, element: HTMLElement) => void> = {\n  iframe: renderIframe,\n  inline: renderInline,\n  none: doNothing,\n};\n\nconst defaultOptions = {\n  renderMode: 'iframe',\n  type: 'normal',\n} satisfies Partial<AdheseSlotOptions>;\n\n/**\n * Create a new slot instance. This slot instance can be used to request and render ads.\n *\n * @param slotOptions {AdheseSlotOptions} The options to create the slot with.\n *\n * @return AdheseSlot The created slot instance.\n */\nexport function createSlot(slotOptions: AdheseSlotOptions): AdheseSlot {\n  const scope = effectScope();\n\n  return scope.run(() => {\n    const slotContext = ref<AdheseSlotContext | null>(null);\n    const options = slotOptions.context.hooks.runOnSlotCreate({\n      ...defaultOptions,\n      ...slotOptions,\n    });\n\n    const {\n      containingElement,\n      slot,\n      context,\n      pluginOptions,\n      renderMode = 'iframe',\n      type = 'normal',\n    } = options;\n\n    const id = uniqueId();\n    const {\n      runOnBeforeRender,\n      runOnRender,\n      runOnBeforeRequest,\n      runOnRequest,\n      runOnInit,\n      runOnDispose,\n      ...hooks\n    } = useSlotHooks(options, slotContext);\n\n    const isDisposed = ref(false);\n    const parameters = reactive(new Map(Object.entries(options.parameters ?? {})));\n\n    const [device, disposeQueryDetector] = useQueryDetector(context, typeof options.format === 'string'\n      ? {\n          [options.format]: '(min-width: 0px)',\n        }\n      : Object.fromEntries(options.format.map(item => [item.format, item.query])));\n\n    const format = computed(() => typeof options.format === 'string' ? options.format : device.value);\n\n    const data = ref<AdheseAd | null>(null) as Ref<AdheseAd | null>;\n    const originalData = ref(data.value) as Ref<AdheseAd | null>;\n    const name = computed(() => generateName(options.context.location, format.value, options.slot));\n\n    watch(name, async (newName, oldName) => {\n      if (newName === oldName)\n        return;\n\n      const newAd = await slotContext.value?.request();\n\n      if (!newAd)\n        return;\n\n      slotContext.value?.cleanElement();\n\n      data.value = newAd;\n      originalData.value = newAd;\n    });\n\n    const isDomLoaded = useDomLoaded(context);\n\n    const element = computed(() => {\n      if (!(typeof options.containingElement === 'string' || !options.containingElement))\n        return options.containingElement;\n\n      if (!isDomLoaded.value || slotContext.value?.isDisposed)\n        return null;\n\n      return document.querySelector<HTMLElement>(`.adunit[data-format=\"${format.value}\"]#${options.containingElement}${options.slot ? `[data-slot=\"${options.slot}\"]` : ''}`);\n    },\n    );\n\n    const isInViewport = useRenderIntersectionObserver({\n      options,\n      element,\n      hooks,\n    });\n\n    const status = ref<UnwrapRef<AdheseSlot>['status']>('initializing');\n\n    watch([data, isInViewport], async ([newData, newIsInViewport], [oldData]) => {\n      if ((!newData || (oldData && isDeepEqual(newData, oldData))) && status.value === 'rendered')\n        return;\n\n      if (newIsInViewport)\n        await slotContext.value?.render(newData ?? undefined);\n    });\n\n    hooks.onDispose(() => {\n      disposeQueryDetector();\n    });\n\n    const isViewabilityTracked = useViewabilityObserver({\n      context,\n      slotContext,\n      hooks,\n      onTracked(trackingPixel) {\n        if (slotContext.value?.data?.viewableImpressionCounter) {\n          trackingPixel.value = addTrackingPixel(slotContext.value?.data?.viewableImpressionCounter);\n\n          context.logger.debug(`Viewability tracking pixel fired for ${slotContext.value?.name}`);\n        }\n      },\n    });\n\n    const impressionTrackingPixelElement = ref<HTMLImageElement | null>(null);\n    const isImpressionTracked = ref(false);\n    hooks.onDispose(() => {\n      if (impressionTrackingPixelElement.value)\n        impressionTrackingPixelElement.value.remove();\n    });\n\n    async function request(): Promise<AdheseAd | null> {\n      if (options.lazyLoading && !isInViewport.value)\n        return null;\n\n      status.value = 'loading';\n\n      let response = await runOnBeforeRequest(null);\n\n      if (!response) {\n        response = await extRequestAd({\n          slot: {\n            name: name.value,\n            parameters,\n          },\n          context,\n        });\n      }\n\n      if (response)\n        response = await runOnRequest(response);\n\n      data.value = response;\n\n      if (!originalData.value)\n        originalData.value = response;\n\n      status.value = response ? 'loaded' : 'empty';\n\n      if (!response)\n        cleanElement();\n\n      return response;\n    }\n\n    async function render(adToRender?: AdheseAd): Promise<HTMLElement | null> {\n      status.value = 'rendering';\n\n      await waitForDomLoad();\n\n      let renderAd = adToRender ?? data.value ?? originalData.value ?? await request();\n\n      renderAd = renderAd && await runOnBeforeRender(renderAd);\n\n      if (!renderAd) {\n        status.value = 'empty';\n        logger.debug(`No ad to render for slot ${name.value}`);\n\n        return null;\n      }\n\n      if (!element.value) {\n        const error = `Could not create slot for format ${format.value}. No element found.`;\n        logger.error(error, options);\n        throw new Error(error);\n      }\n\n      if (context.debug)\n        element.value.style.position = 'relative';\n\n      if (typeof renderAd?.tag !== 'string') {\n        const error = `Could not render slot for slot ${name.value}. A valid tag doesn't exist or is not HTML string.`;\n        logger.error(error, options);\n\n        status.value = 'error';\n        throw new Error(error);\n      }\n\n      renderFunctions[renderMode](renderAd, element.value);\n\n      if (renderAd.impressionCounter && !impressionTrackingPixelElement.value)\n        impressionTrackingPixelElement.value = addTrackingPixel(renderAd.impressionCounter);\n\n      isImpressionTracked.value = true;\n\n      logger.debug(`Slot rendered ${name.value}`, {\n        renderedElement: element,\n        location: context.location,\n        format,\n        containingElement,\n      });\n\n      // eslint-disable-next-line require-atomic-updates\n      data.value = renderAd;\n\n      status.value = 'rendered';\n\n      runOnRender(renderAd);\n\n      return element.value;\n    }\n\n    function cleanElement(): void {\n      if (!element.value)\n        return;\n\n      element.value.innerHTML = '';\n      element.value.style.position = '';\n      element.value.style.width = '';\n      element.value.style.height = '';\n\n      data.value = null;\n      originalData.value = null;\n    }\n\n    function dispose(): void {\n      cleanElement();\n\n      data.value = null;\n\n      runOnDispose();\n\n      isDisposed.value = true;\n\n      scope.stop();\n    }\n\n    const state = reactive({\n      location: context.location ?? '',\n      lazyLoading: options.lazyLoading ?? false,\n      type,\n      slot,\n      parameters,\n      format,\n      name,\n      data,\n      isViewabilityTracked,\n      isImpressionTracked,\n      status,\n      element,\n      isDisposed,\n      id,\n      pluginOptions,\n      render,\n      request,\n      dispose,\n      cleanElement,\n      options: omit(options, ['context']),\n      ...hooks,\n    });\n\n    watch(state, (newState) => {\n      slotContext.value = newState;\n    }, {\n      deep: true,\n      immediate: true,\n    });\n\n    context.hooks.onInit(async () => {\n      status.value = 'initialized';\n\n      runOnInit();\n\n      if (options.lazyLoading)\n        return;\n\n      data.value = await slotContext.value?.request() ?? null;\n    });\n\n    return state;\n  })!;\n}\n"],"names":["renderIframe","renderInline","doNothing","effectScope","ref","uniqueId","useSlotHooks","reactive","useQueryDetector","computed","generateName","watch","useDomLoaded","useRenderIntersectionObserver","isDeepEqual","useViewabilityObserver","addTrackingPixel","extRequestAd","waitForDomLoad","logger","omit"],"mappings":";;;;;;;;AA6BA,MAAM,kBAAoF;AAAA,EACxF,QAAQA,WAAA;AAAA,EACR,QAAQC,WAAA;AAAA,EACR,MAAMC,UAAA;AACR;AAEA,MAAM,iBAAiB;AAAA,EACrB,YAAY;AAAA,EACZ,MAAM;AACR;AASO,SAAS,WAAW,aAA4C;AACrE,QAAM,QAAQC,UAAAA;AAEP,SAAA,MAAM,IAAI,MAAM;AACf,UAAA,cAAcC,cAA8B,IAAI;AACtD,UAAM,UAAU,YAAY,QAAQ,MAAM,gBAAgB;AAAA,MACxD,GAAG;AAAA,MACH,GAAG;AAAA,IAAA,CACJ;AAEK,UAAA;AAAA,MACJ;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,aAAa;AAAA,MACb,OAAO;AAAA,IACL,IAAA;AAEJ,UAAM,KAAKC,UAAAA;AACL,UAAA;AAAA,MACJ;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,GAAG;AAAA,IAAA,IACDC,iBAAa,aAAA,SAAS,WAAW;AAE/B,UAAA,aAAaF,cAAI,KAAK;AACtB,UAAA,aAAaG,UAAAA,SAAS,IAAI,IAAI,OAAO,QAAQ,QAAQ,cAAc,EAAE,CAAC,CAAC;AAEvE,UAAA,CAAC,QAAQ,oBAAoB,IAAIC,cAAAA,iBAAiB,SAAS,OAAO,QAAQ,WAAW,WACvF;AAAA,MACE,CAAC,QAAQ,MAAM,GAAG;AAAA,IAEpB,IAAA,OAAO,YAAY,QAAQ,OAAO,IAAI,CAAA,SAAQ,CAAC,KAAK,QAAQ,KAAK,KAAK,CAAC,CAAC,CAAC;AAEvE,UAAA,SAASC,UAAAA,SAAS,MAAM,OAAO,QAAQ,WAAW,WAAW,QAAQ,SAAS,OAAO,KAAK;AAE1F,UAAA,OAAOL,cAAqB,IAAI;AAChC,UAAA,eAAeA,UAAAA,IAAI,KAAK,KAAK;AAC7B,UAAA,OAAOK,UAAAA,SAAS,MAAMC,UAAAA,aAAa,QAAQ,QAAQ,UAAU,OAAO,OAAO,QAAQ,IAAI,CAAC;AAExFC,cAAAA,MAAA,MAAM,OAAO,SAAS,YAAY;;AACtC,UAAI,YAAY;AACd;AAEF,YAAM,QAAQ,QAAM,iBAAY,UAAZ,mBAAmB;AAEvC,UAAI,CAAC;AACH;AAEF,wBAAY,UAAZ,mBAAmB;AAEnB,WAAK,QAAQ;AACb,mBAAa,QAAQ;AAAA,IAAA,CACtB;AAEK,UAAA,cAAcC,8BAAa,OAAO;AAExC,UAAM,UAAUH,UAAA;AAAA,MAAS,MAAM;;AAC7B,YAAI,EAAE,OAAO,QAAQ,sBAAsB,YAAY,CAAC,QAAQ;AAC9D,iBAAO,QAAQ;AAEjB,YAAI,CAAC,YAAY,WAAS,iBAAY,UAAZ,mBAAmB;AACpC,iBAAA;AAET,eAAO,SAAS,cAA2B,wBAAwB,OAAO,KAAK,MAAM,QAAQ,iBAAiB,GAAG,QAAQ,OAAO,eAAe,QAAQ,IAAI,OAAO,EAAE,EAAE;AAAA,MACxK;AAAA,IAAA;AAGA,UAAM,eAAeI,iBAAAA,8BAA8B;AAAA,MACjD;AAAA,MACA;AAAA,MACA;AAAA,IAAA,CACD;AAEK,UAAA,SAAST,cAAqC,cAAc;AAE5DO,oBAAA,CAAC,MAAM,YAAY,GAAG,OAAO,CAAC,SAAS,eAAe,GAAG,CAAC,OAAO,MAAM;;AACtE,WAAA,CAAC,WAAY,WAAWG,UAAA,YAAY,SAAS,OAAO,MAAO,OAAO,UAAU;AAC/E;AAEE,UAAA;AACF,gBAAM,iBAAY,UAAZ,mBAAmB,OAAO,WAAW;AAAA,IAAS,CACvD;AAED,UAAM,UAAU,MAAM;AACC;IAAA,CACtB;AAED,UAAM,uBAAuBC,iBAAAA,uBAAuB;AAAA,MAClD;AAAA,MACA;AAAA,MACA;AAAA,MACA,UAAU,eAAe;;AACnB,aAAA,uBAAY,UAAZ,mBAAmB,SAAnB,mBAAyB,2BAA2B;AACtD,wBAAc,QAAQC,4BAAiB,uBAAY,UAAZ,mBAAmB,SAAnB,mBAAyB,yBAAyB;AAEzF,kBAAQ,OAAO,MAAM,yCAAwC,iBAAY,UAAZ,mBAAmB,IAAI,EAAE;AAAA,QACxF;AAAA,MACF;AAAA,IAAA,CACD;AAEK,UAAA,iCAAiCZ,cAA6B,IAAI;AAClE,UAAA,sBAAsBA,cAAI,KAAK;AACrC,UAAM,UAAU,MAAM;AACpB,UAAI,+BAA+B;AACjC,uCAA+B,MAAM;IAAO,CAC/C;AAED,mBAAe,UAAoC;AAC7C,UAAA,QAAQ,eAAe,CAAC,aAAa;AAChC,eAAA;AAET,aAAO,QAAQ;AAEX,UAAA,WAAW,MAAM,mBAAmB,IAAI;AAE5C,UAAI,CAAC,UAAU;AACb,mBAAW,MAAMa,WAAAA,UAAa;AAAA,UAC5B,MAAM;AAAA,YACJ,MAAM,KAAK;AAAA,YACX;AAAA,UACF;AAAA,UACA;AAAA,QAAA,CACD;AAAA,MACH;AAEI,UAAA;AACS,mBAAA,MAAM,aAAa,QAAQ;AAExC,WAAK,QAAQ;AAEb,UAAI,CAAC,aAAa;AAChB,qBAAa,QAAQ;AAEhB,aAAA,QAAQ,WAAW,WAAW;AAErC,UAAI,CAAC;AACU;AAER,aAAA;AAAA,IACT;AAEA,mBAAe,OAAO,YAAoD;AACxE,aAAO,QAAQ;AAEf,YAAMC,UAAe,eAAA;AAErB,UAAI,WAAW,cAAc,KAAK,SAAS,aAAa,SAAS,MAAM;AAE5D,iBAAA,YAAY,MAAM,kBAAkB,QAAQ;AAEvD,UAAI,CAAC,UAAU;AACb,eAAO,QAAQ;AACfC,eAAA,OAAO,MAAM,4BAA4B,KAAK,KAAK,EAAE;AAE9C,eAAA;AAAA,MACT;AAEI,UAAA,CAAC,QAAQ,OAAO;AACZ,cAAA,QAAQ,oCAAoC,OAAO,KAAK;AACvDA,eAAAA,OAAA,MAAM,OAAO,OAAO;AACrB,cAAA,IAAI,MAAM,KAAK;AAAA,MACvB;AAEA,UAAI,QAAQ;AACF,gBAAA,MAAM,MAAM,WAAW;AAE7B,UAAA,QAAO,qCAAU,SAAQ,UAAU;AAC/B,cAAA,QAAQ,kCAAkC,KAAK,KAAK;AACnDA,eAAAA,OAAA,MAAM,OAAO,OAAO;AAE3B,eAAO,QAAQ;AACT,cAAA,IAAI,MAAM,KAAK;AAAA,MACvB;AAEA,sBAAgB,UAAU,EAAE,UAAU,QAAQ,KAAK;AAE/C,UAAA,SAAS,qBAAqB,CAAC,+BAA+B;AACjC,uCAAA,QAAQH,UAAAA,iBAAiB,SAAS,iBAAiB;AAEpF,0BAAoB,QAAQ;AAE5BG,aAAA,OAAO,MAAM,iBAAiB,KAAK,KAAK,IAAI;AAAA,QAC1C,iBAAiB;AAAA,QACjB,UAAU,QAAQ;AAAA,QAClB;AAAA,QACA;AAAA,MAAA,CACD;AAGD,WAAK,QAAQ;AAEb,aAAO,QAAQ;AAEf,kBAAY,QAAQ;AAEpB,aAAO,QAAQ;AAAA,IACjB;AAEA,aAAS,eAAqB;AAC5B,UAAI,CAAC,QAAQ;AACX;AAEF,cAAQ,MAAM,YAAY;AAClB,cAAA,MAAM,MAAM,WAAW;AACvB,cAAA,MAAM,MAAM,QAAQ;AACpB,cAAA,MAAM,MAAM,SAAS;AAE7B,WAAK,QAAQ;AACb,mBAAa,QAAQ;AAAA,IACvB;AAEA,aAAS,UAAgB;AACV;AAEb,WAAK,QAAQ;AAEA;AAEb,iBAAW,QAAQ;AAEnB,YAAM,KAAK;AAAA,IACb;AAEA,UAAM,QAAQZ,UAAAA,SAAS;AAAA,MACrB,UAAU,QAAQ,YAAY;AAAA,MAC9B,aAAa,QAAQ,eAAe;AAAA,MACpC;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,SAASa,UAAA,KAAK,SAAS,CAAC,SAAS,CAAC;AAAA,MAClC,GAAG;AAAA,IAAA,CACJ;AAEKT,oBAAA,OAAO,CAAC,aAAa;AACzB,kBAAY,QAAQ;AAAA,IAAA,GACnB;AAAA,MACD,MAAM;AAAA,MACN,WAAW;AAAA,IAAA,CACZ;AAEO,YAAA,MAAM,OAAO,YAAY;;AAC/B,aAAO,QAAQ;AAEL;AAEV,UAAI,QAAQ;AACV;AAEF,WAAK,QAAQ,QAAM,iBAAY,UAAZ,mBAAmB,cAAa;AAAA,IAAA,CACpD;AAEM,WAAA;AAAA,EAAA,CACR;AACH;;"}
+{"version":3,"file":"slot.cjs","sources":["../../../src/slot/slot.ts"],"sourcesContent":["import {\n  type Ref,\n  type RenderOptions,\n  type UnwrapRef,\n  addTrackingPixel,\n  computed,\n  doNothing,\n  effectScope,\n  generateName,\n  isDeepEqual,\n  omit,\n  reactive,\n  ref,\n  renderIframe,\n  renderInline,\n  uniqueId,\n  waitForDomLoad,\n  watch,\n} from '@adhese/sdk-shared';\nimport type { AdheseAd } from '@adhese/sdk';\nimport { requestAd as extRequestAd } from '../requestAds/requestAds';\nimport { logger } from '../logger/logger';\nimport { useQueryDetector } from '../queryDetector/queryDetector';\nimport type { AdheseSlot, AdheseSlotContext, AdheseSlotOptions, RenderMode } from './slot.types';\nimport {\n  useDomLoaded,\n  useRenderIntersectionObserver,\n  useSlotHooks,\n  useViewabilityObserver,\n} from './slot.composables';\n\nconst renderFunctions: Record<RenderMode, (ad: RenderOptions, element: HTMLElement) => void> = {\n  iframe: renderIframe,\n  inline: renderInline,\n  none: doNothing,\n};\n\nconst defaultOptions = {\n  renderMode: 'iframe',\n  type: 'normal',\n} satisfies Partial<AdheseSlotOptions>;\n\n/**\n * Create a new slot instance. This slot instance can be used to request and render ads.\n *\n * @param slotOptions {AdheseSlotOptions} The options to create the slot with.\n *\n * @return AdheseSlot The created slot instance.\n */\nexport function createSlot(slotOptions: AdheseSlotOptions): AdheseSlot {\n  const scope = effectScope();\n\n  return scope.run(() => {\n    const slotContext = ref<AdheseSlotContext | null>(null);\n    const options = slotOptions.context.hooks.runOnSlotCreate({\n      ...defaultOptions,\n      ...slotOptions,\n    });\n\n    const {\n      containingElement,\n      slot,\n      context,\n      pluginOptions,\n      renderMode = 'iframe',\n      type = 'normal',\n    } = options;\n\n    const id = uniqueId();\n    const {\n      runOnBeforeRender,\n      runOnRender,\n      runOnBeforeRequest,\n      runOnRequest,\n      runOnInit,\n      runOnDispose,\n      ...hooks\n    } = useSlotHooks(options, slotContext);\n\n    const isDisposed = ref(false);\n    const parameters = reactive(new Map(Object.entries(options.parameters ?? {})));\n\n    const [device, disposeQueryDetector] = useQueryDetector(context, typeof options.format === 'string'\n      ? {\n          [options.format]: '(min-width: 0px)',\n        }\n      : Object.fromEntries(options.format.map(item => [item.format, item.query])));\n\n    const format = computed(() => typeof options.format === 'string' ? options.format : device.value);\n\n    const data = ref<AdheseAd | null>(null) as Ref<AdheseAd | null>;\n    const originalData = ref(data.value) as Ref<AdheseAd | null>;\n    const name = computed(() => generateName(options.context.location, format.value, options.slot));\n\n    watch(name, async (newName, oldName) => {\n      if (newName === oldName)\n        return;\n\n      const newAd = await slotContext.value?.request();\n\n      if (!newAd)\n        return;\n\n      slotContext.value?.cleanElement();\n\n      data.value = newAd;\n      originalData.value = newAd;\n    });\n\n    const isDomLoaded = useDomLoaded(context);\n\n    const element = computed(() => {\n      if (!(typeof options.containingElement === 'string' || !options.containingElement))\n        return options.containingElement;\n\n      if (!isDomLoaded.value || slotContext.value?.isDisposed)\n        return null;\n\n      return document.querySelector<HTMLElement>(`.adunit[data-format=\"${format.value}\"]#${options.containingElement}${options.slot ? `[data-slot=\"${options.slot}\"]` : ''}`);\n    },\n    );\n\n    const isInViewport = useRenderIntersectionObserver({\n      options,\n      element,\n      hooks,\n    });\n\n    const status = ref<UnwrapRef<AdheseSlot>['status']>('initializing');\n\n    watch([data, isInViewport], async ([newData, newIsInViewport], [oldData]) => {\n      if ((!newData || (oldData && isDeepEqual(newData, oldData))) && status.value === 'rendered')\n        return;\n\n      if (newIsInViewport)\n        await slotContext.value?.render(newData ?? undefined);\n    });\n\n    hooks.onDispose(() => {\n      disposeQueryDetector();\n    });\n\n    const isViewabilityTracked = useViewabilityObserver({\n      context,\n      slotContext,\n      hooks,\n      onTracked(trackingPixel) {\n        if (slotContext.value?.data?.viewableImpressionCounter) {\n          trackingPixel.value = addTrackingPixel(slotContext.value?.data?.viewableImpressionCounter);\n\n          context.logger.debug(`Viewability tracking pixel fired for ${slotContext.value?.name}`);\n        }\n      },\n    });\n\n    const impressionTrackingPixelElement = ref<HTMLImageElement | null>(null);\n    const isImpressionTracked = ref(false);\n    hooks.onDispose(() => {\n      if (impressionTrackingPixelElement.value)\n        impressionTrackingPixelElement.value.remove();\n    });\n\n    async function request(): Promise<AdheseAd | null> {\n      if (options.lazyLoading && !isInViewport.value)\n        return null;\n\n      status.value = 'loading';\n\n      let response = await runOnBeforeRequest(null);\n\n      if (!response) {\n        response = await extRequestAd({\n          slot: {\n            name: name.value,\n            parameters,\n          },\n          context,\n        });\n      }\n\n      if (response)\n        response = await runOnRequest(response);\n\n      data.value = response;\n\n      if (!originalData.value)\n        originalData.value = response;\n\n      status.value = response ? 'loaded' : 'empty';\n\n      if (!response)\n        cleanElement();\n\n      return response;\n    }\n\n    async function render(adToRender?: AdheseAd): Promise<HTMLElement | null> {\n      status.value = 'rendering';\n\n      await waitForDomLoad();\n\n      let renderAd = adToRender ?? data.value ?? originalData.value ?? await request();\n\n      renderAd = renderAd && await runOnBeforeRender(renderAd);\n\n      if (!renderAd) {\n        status.value = 'empty';\n        logger.debug(`No ad to render for slot ${name.value}`);\n\n        return null;\n      }\n\n      if (!element.value) {\n        const error = `Could not create slot for format ${format.value}. No element found.`;\n        logger.error(error, options);\n        throw new Error(error);\n      }\n\n      if (context.debug)\n        element.value.style.position = 'relative';\n\n      if (typeof renderAd?.tag !== 'string') {\n        const error = `Could not render slot for slot ${name.value}. A valid tag doesn't exist or is not HTML string.`;\n        logger.error(error, options);\n\n        status.value = 'error';\n        throw new Error(error);\n      }\n\n      renderFunctions[renderMode](renderAd as RenderOptions, element.value);\n\n      if (renderAd.impressionCounter && !impressionTrackingPixelElement.value)\n        impressionTrackingPixelElement.value = addTrackingPixel(renderAd.impressionCounter);\n\n      isImpressionTracked.value = true;\n\n      logger.debug(`Slot rendered ${name.value}`, {\n        renderedElement: element,\n        location: context.location,\n        format,\n        containingElement,\n      });\n\n      // eslint-disable-next-line require-atomic-updates\n      data.value = renderAd;\n\n      status.value = 'rendered';\n\n      runOnRender(renderAd);\n\n      return element.value;\n    }\n\n    function cleanElement(): void {\n      if (!element.value)\n        return;\n\n      element.value.innerHTML = '';\n      element.value.style.position = '';\n      element.value.style.width = '';\n      element.value.style.height = '';\n\n      data.value = null;\n      originalData.value = null;\n    }\n\n    function dispose(): void {\n      cleanElement();\n\n      data.value = null;\n\n      runOnDispose();\n\n      isDisposed.value = true;\n\n      scope.stop();\n    }\n\n    const state = reactive({\n      location: context.location ?? '',\n      lazyLoading: options.lazyLoading ?? false,\n      type,\n      slot,\n      parameters,\n      format,\n      name,\n      data,\n      isViewabilityTracked,\n      isImpressionTracked,\n      status,\n      element,\n      isDisposed,\n      id,\n      pluginOptions,\n      isVisible: isInViewport,\n      render,\n      request,\n      dispose,\n      cleanElement,\n      options: omit(options, ['context']),\n      ...hooks,\n    });\n\n    watch(state, (newState) => {\n      slotContext.value = newState;\n    }, {\n      deep: true,\n      immediate: true,\n    });\n\n    context.hooks.onInit(async () => {\n      status.value = 'initialized';\n\n      runOnInit();\n\n      if (options.lazyLoading)\n        return;\n\n      data.value = await slotContext.value?.request() ?? null;\n    });\n\n    return state;\n  })!;\n}\n"],"names":["renderIframe","renderInline","doNothing","effectScope","ref","uniqueId","useSlotHooks","reactive","useQueryDetector","computed","generateName","watch","useDomLoaded","useRenderIntersectionObserver","isDeepEqual","useViewabilityObserver","addTrackingPixel","extRequestAd","waitForDomLoad","logger","omit"],"mappings":";;;;;;;AA+BA,MAAM,kBAAyF;AAAA,EAC7F,QAAQA,UAAA;AAAA,EACR,QAAQC,UAAA;AAAA,EACR,MAAMC,UAAA;AACR;AAEA,MAAM,iBAAiB;AAAA,EACrB,YAAY;AAAA,EACZ,MAAM;AACR;AASO,SAAS,WAAW,aAA4C;AACrE,QAAM,QAAQC,UAAAA;AAEP,SAAA,MAAM,IAAI,MAAM;AACf,UAAA,cAAcC,cAA8B,IAAI;AACtD,UAAM,UAAU,YAAY,QAAQ,MAAM,gBAAgB;AAAA,MACxD,GAAG;AAAA,MACH,GAAG;AAAA,IAAA,CACJ;AAEK,UAAA;AAAA,MACJ;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,aAAa;AAAA,MACb,OAAO;AAAA,IACL,IAAA;AAEJ,UAAM,KAAKC,UAAAA;AACL,UAAA;AAAA,MACJ;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,GAAG;AAAA,IAAA,IACDC,iBAAa,aAAA,SAAS,WAAW;AAE/B,UAAA,aAAaF,cAAI,KAAK;AACtB,UAAA,aAAaG,UAAAA,SAAS,IAAI,IAAI,OAAO,QAAQ,QAAQ,cAAc,EAAE,CAAC,CAAC;AAEvE,UAAA,CAAC,QAAQ,oBAAoB,IAAIC,cAAAA,iBAAiB,SAAS,OAAO,QAAQ,WAAW,WACvF;AAAA,MACE,CAAC,QAAQ,MAAM,GAAG;AAAA,IAEpB,IAAA,OAAO,YAAY,QAAQ,OAAO,IAAI,CAAA,SAAQ,CAAC,KAAK,QAAQ,KAAK,KAAK,CAAC,CAAC,CAAC;AAEvE,UAAA,SAASC,UAAAA,SAAS,MAAM,OAAO,QAAQ,WAAW,WAAW,QAAQ,SAAS,OAAO,KAAK;AAE1F,UAAA,OAAOL,cAAqB,IAAI;AAChC,UAAA,eAAeA,UAAAA,IAAI,KAAK,KAAK;AAC7B,UAAA,OAAOK,UAAAA,SAAS,MAAMC,UAAAA,aAAa,QAAQ,QAAQ,UAAU,OAAO,OAAO,QAAQ,IAAI,CAAC;AAExFC,cAAAA,MAAA,MAAM,OAAO,SAAS,YAAY;;AACtC,UAAI,YAAY;AACd;AAEF,YAAM,QAAQ,QAAM,iBAAY,UAAZ,mBAAmB;AAEvC,UAAI,CAAC;AACH;AAEF,wBAAY,UAAZ,mBAAmB;AAEnB,WAAK,QAAQ;AACb,mBAAa,QAAQ;AAAA,IAAA,CACtB;AAEK,UAAA,cAAcC,8BAAa,OAAO;AAExC,UAAM,UAAUH,UAAA;AAAA,MAAS,MAAM;;AAC7B,YAAI,EAAE,OAAO,QAAQ,sBAAsB,YAAY,CAAC,QAAQ;AAC9D,iBAAO,QAAQ;AAEjB,YAAI,CAAC,YAAY,WAAS,iBAAY,UAAZ,mBAAmB;AACpC,iBAAA;AAET,eAAO,SAAS,cAA2B,wBAAwB,OAAO,KAAK,MAAM,QAAQ,iBAAiB,GAAG,QAAQ,OAAO,eAAe,QAAQ,IAAI,OAAO,EAAE,EAAE;AAAA,MACxK;AAAA,IAAA;AAGA,UAAM,eAAeI,iBAAAA,8BAA8B;AAAA,MACjD;AAAA,MACA;AAAA,MACA;AAAA,IAAA,CACD;AAEK,UAAA,SAAST,cAAqC,cAAc;AAE5DO,oBAAA,CAAC,MAAM,YAAY,GAAG,OAAO,CAAC,SAAS,eAAe,GAAG,CAAC,OAAO,MAAM;;AACtE,WAAA,CAAC,WAAY,WAAWG,UAAA,YAAY,SAAS,OAAO,MAAO,OAAO,UAAU;AAC/E;AAEE,UAAA;AACF,gBAAM,iBAAY,UAAZ,mBAAmB,OAAO,WAAW;AAAA,IAAS,CACvD;AAED,UAAM,UAAU,MAAM;AACC;IAAA,CACtB;AAED,UAAM,uBAAuBC,iBAAAA,uBAAuB;AAAA,MAClD;AAAA,MACA;AAAA,MACA;AAAA,MACA,UAAU,eAAe;;AACnB,aAAA,uBAAY,UAAZ,mBAAmB,SAAnB,mBAAyB,2BAA2B;AACtD,wBAAc,QAAQC,4BAAiB,uBAAY,UAAZ,mBAAmB,SAAnB,mBAAyB,yBAAyB;AAEzF,kBAAQ,OAAO,MAAM,yCAAwC,iBAAY,UAAZ,mBAAmB,IAAI,EAAE;AAAA,QACxF;AAAA,MACF;AAAA,IAAA,CACD;AAEK,UAAA,iCAAiCZ,cAA6B,IAAI;AAClE,UAAA,sBAAsBA,cAAI,KAAK;AACrC,UAAM,UAAU,MAAM;AACpB,UAAI,+BAA+B;AACjC,uCAA+B,MAAM;IAAO,CAC/C;AAED,mBAAe,UAAoC;AAC7C,UAAA,QAAQ,eAAe,CAAC,aAAa;AAChC,eAAA;AAET,aAAO,QAAQ;AAEX,UAAA,WAAW,MAAM,mBAAmB,IAAI;AAE5C,UAAI,CAAC,UAAU;AACb,mBAAW,MAAMa,WAAAA,UAAa;AAAA,UAC5B,MAAM;AAAA,YACJ,MAAM,KAAK;AAAA,YACX;AAAA,UACF;AAAA,UACA;AAAA,QAAA,CACD;AAAA,MACH;AAEI,UAAA;AACS,mBAAA,MAAM,aAAa,QAAQ;AAExC,WAAK,QAAQ;AAEb,UAAI,CAAC,aAAa;AAChB,qBAAa,QAAQ;AAEhB,aAAA,QAAQ,WAAW,WAAW;AAErC,UAAI,CAAC;AACU;AAER,aAAA;AAAA,IACT;AAEA,mBAAe,OAAO,YAAoD;AACxE,aAAO,QAAQ;AAEf,YAAMC,UAAe,eAAA;AAErB,UAAI,WAAW,cAAc,KAAK,SAAS,aAAa,SAAS,MAAM;AAE5D,iBAAA,YAAY,MAAM,kBAAkB,QAAQ;AAEvD,UAAI,CAAC,UAAU;AACb,eAAO,QAAQ;AACfC,eAAA,OAAO,MAAM,4BAA4B,KAAK,KAAK,EAAE;AAE9C,eAAA;AAAA,MACT;AAEI,UAAA,CAAC,QAAQ,OAAO;AACZ,cAAA,QAAQ,oCAAoC,OAAO,KAAK;AACvDA,eAAAA,OAAA,MAAM,OAAO,OAAO;AACrB,cAAA,IAAI,MAAM,KAAK;AAAA,MACvB;AAEA,UAAI,QAAQ;AACF,gBAAA,MAAM,MAAM,WAAW;AAE7B,UAAA,QAAO,qCAAU,SAAQ,UAAU;AAC/B,cAAA,QAAQ,kCAAkC,KAAK,KAAK;AACnDA,eAAAA,OAAA,MAAM,OAAO,OAAO;AAE3B,eAAO,QAAQ;AACT,cAAA,IAAI,MAAM,KAAK;AAAA,MACvB;AAEA,sBAAgB,UAAU,EAAE,UAA2B,QAAQ,KAAK;AAEhE,UAAA,SAAS,qBAAqB,CAAC,+BAA+B;AACjC,uCAAA,QAAQH,UAAAA,iBAAiB,SAAS,iBAAiB;AAEpF,0BAAoB,QAAQ;AAE5BG,aAAA,OAAO,MAAM,iBAAiB,KAAK,KAAK,IAAI;AAAA,QAC1C,iBAAiB;AAAA,QACjB,UAAU,QAAQ;AAAA,QAClB;AAAA,QACA;AAAA,MAAA,CACD;AAGD,WAAK,QAAQ;AAEb,aAAO,QAAQ;AAEf,kBAAY,QAAQ;AAEpB,aAAO,QAAQ;AAAA,IACjB;AAEA,aAAS,eAAqB;AAC5B,UAAI,CAAC,QAAQ;AACX;AAEF,cAAQ,MAAM,YAAY;AAClB,cAAA,MAAM,MAAM,WAAW;AACvB,cAAA,MAAM,MAAM,QAAQ;AACpB,cAAA,MAAM,MAAM,SAAS;AAE7B,WAAK,QAAQ;AACb,mBAAa,QAAQ;AAAA,IACvB;AAEA,aAAS,UAAgB;AACV;AAEb,WAAK,QAAQ;AAEA;AAEb,iBAAW,QAAQ;AAEnB,YAAM,KAAK;AAAA,IACb;AAEA,UAAM,QAAQZ,UAAAA,SAAS;AAAA,MACrB,UAAU,QAAQ,YAAY;AAAA,MAC9B,aAAa,QAAQ,eAAe;AAAA,MACpC;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,WAAW;AAAA,MACX;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,SAASa,UAAA,KAAK,SAAS,CAAC,SAAS,CAAC;AAAA,MAClC,GAAG;AAAA,IAAA,CACJ;AAEKT,oBAAA,OAAO,CAAC,aAAa;AACzB,kBAAY,QAAQ;AAAA,IAAA,GACnB;AAAA,MACD,MAAM;AAAA,MACN,WAAW;AAAA,IAAA,CACZ;AAEO,YAAA,MAAM,OAAO,YAAY;;AAC/B,aAAO,QAAQ;AAEL;AAEV,UAAI,QAAQ;AACV;AAEF,WAAK,QAAQ,QAAM,iBAAY,UAAZ,mBAAmB,cAAa;AAAA,IAAA,CACpD;AAEM,WAAA;AAAA,EAAA,CACR;AACH;;"}

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as _adhese_sdk_shared from '@adhese/sdk-shared';
-import { createAsyncHook, createPassiveHook, Ref, Merge, MaybeRef, UrlString, EventManager } from '@adhese/sdk-shared';
+import { createAsyncHook, createPassiveHook, Ref, Merge, UrlString, EventManager } from '@adhese/sdk-shared';
 import * as _adhese_sdk_shared_validators from '@adhese/sdk-shared/validators';
 import { TypeOf, ZodType } from '@adhese/sdk-shared/validators';
 
@@ -165,6 +165,10 @@ type BaseAdheseSlot = Merge<Omit<AdheseSlotOptions, 'onDispose' | 'context' | 'o
      * Options slot was created with
      */
     options: Omit<AdheseSlotOptions, 'context'>;
+    /**
+     * Is the slot visible in the viewport.
+     */
+    isVisible: boolean;
     /**
      * Renders the slot in the containing element. If no data is provided, new data will be requested from the API.
      */
@@ -397,7 +401,7 @@ type AdRequestOptions = {
      * Slot you want to fetch the ad for
      */
     slot: {
-        name: MaybeRef<string>;
+        name: string;
         parameters: Map<string, ReadonlyArray<string> | string>;
     };
     context: AdheseContext;

package/dist/package.json.js

@@ -1,5 +1,5 @@
 const name = "@adhese/sdk";
-const version = "0.21.1";
+const version = "1.0.0";
 export {
   name,
   version

package/dist/requestAds/requestAds.js

@@ -1,4 +1,4 @@
-import { debounce, toValue } from "@adhese/sdk-shared";
+import { debounce } from "@adhese/sdk-shared";
 import { logger } from "../logger/logger.js";
 import { requestPreviews } from "./requestAds.preview.js";
 import { requestWithPost, requestWithGet } from "./requestAds.utils.js";
@@ -11,7 +11,7 @@ const runRequestAdsBatch = debounce(async (context) => {
     context
   });
   for (const { options, resolve } of batch.values()) {
-    const ad = ads.find(({ slotName }) => toValue(slotName) === toValue(options.slot.name));
+    const ad = ads.find(({ slotName }) => slotName === options.slot.name);
     if (ad)
       resolve(ad);
     else
@@ -26,7 +26,7 @@ const runRequestAdsBatch = debounce(async (context) => {
 async function requestAd(options) {
   const promise = new Promise(
     (resolve) => {
-      batch.set(toValue(options.slot.name), { options, resolve });
+      batch.set(options.slot.name, { options, resolve });
     }
   );
   await runRequestAdsBatch.call(options.context);

package/dist/requestAds/requestAds.js.map

@@ -1 +1 @@
-{"version":3,"file":"requestAds.js","sources":["../../src/requestAds/requestAds.ts"],"sourcesContent":["import { type MaybeRef, debounce, toValue } from '@adhese/sdk-shared';\nimport type { AdheseContext } from '../main.types';\nimport { logger } from '../logger/logger';\nimport type { AdheseAd } from './requestAds.schema';\nimport { requestPreviews } from './requestAds.preview';\nimport { requestWithGet, requestWithPost } from './requestAds.utils';\n\nexport type AdRequestOptions = {\n  /**\n   * Slot you want to fetch the ad for\n   */\n  slot: {\n    name: MaybeRef<string>;\n    parameters: Map<string, ReadonlyArray<string> | string>;\n  };\n  context: AdheseContext;\n};\n\nexport type AdMultiRequestOptions = Omit<AdRequestOptions, 'slot'> & {\n  slots: ReadonlyArray<AdRequestOptions['slot']>;\n};\n\nconst batch = new Map<string, {\n  options: AdRequestOptions;\n  resolve(ad: AdheseAd | null): void;\n}>();\n\n/**\n * Debounced function to request ads in batches. This function is debounced to prevent multiple requests for the same ad.\n */\nconst runRequestAdsBatch = debounce(async (context: AdheseContext) => {\n  if (batch.size === 0)\n    return [];\n\n  const ads = await requestAds({\n    slots: Array.from(batch.values()).map(({ options }) => options.slot),\n    context,\n  });\n\n  for (const { options, resolve } of batch.values()) {\n    const ad = ads.find(({ slotName }) => toValue(slotName) === toValue(options.slot.name));\n\n    if (ad)\n      resolve(ad);\n    else\n      resolve(null);\n  }\n\n  batch.clear();\n\n  return ads;\n}, {\n  waitMs: 20,\n  timing: 'trailing',\n});\n\n/**\n * Request a single ad from the API. If you need to fetch multiple ads at once use the `requestAds` function.\n */\nexport async function requestAd(options: AdRequestOptions): Promise<AdheseAd | null> {\n  const promise = new Promise<AdheseAd | null>((resolve) => {\n    batch.set(toValue(options.slot.name), { options, resolve });\n  },\n  );\n\n  await runRequestAdsBatch.call(options.context);\n\n  return promise;\n}\n\n/**\n * Request multiple ads from the API. If you need to fetch a single ad use the `requestAd` function.\n */\nexport async function requestAds(requestOptions: AdMultiRequestOptions): Promise<ReadonlyArray<AdheseAd>> {\n  const options = await requestOptions.context.hooks.runOnRequest(requestOptions);\n\n  const { context } = options;\n\n  try {\n    context?.events?.requestAd.dispatch({\n      ...options,\n      context,\n    });\n\n    const [response, previews, parseResponse] = await Promise.all([\n      context.options.requestType?.toUpperCase() === 'POST'\n        ? requestWithPost(options)\n        : requestWithGet(options),\n      requestPreviews(context.options.account),\n      import('./requestAds.schema').then(module => module.parseResponse),\n    ]);\n\n    logger.debug('Received response', response);\n\n    if (!response.ok)\n      throw new Error(`Failed to request ad: ${response.status} ${response.statusText}`);\n\n    const result = parseResponse((await response.json() as unknown));\n    logger.debug('Parsed ad', result);\n\n    if (previews.length > 0)\n      logger.info(`Found ${previews.length} ${previews.length === 1 ? 'preview' : 'previews'}. Replacing ads in response with preview items`, previews);\n\n    const matchedPreviews = previews.map(({ slotName, ...preview }) => {\n      const partnerAd = result.find(ad => ad.libId === preview.libId);\n\n      return ({\n        slotName: `${partnerAd?.slotName ?? slotName}`,\n        ...preview,\n      });\n    });\n\n    if (matchedPreviews.length > 0)\n      context.events?.previewReceived.dispatch(matchedPreviews);\n\n    const mergedResult = await context.hooks.runOnResponse([\n      ...result.filter(ad => !previews.some(preview => preview.libId === ad.libId)),\n      ...matchedPreviews,\n    ]);\n\n    context.events?.responseReceived.dispatch(mergedResult);\n\n    return mergedResult;\n  }\n  catch (error) {\n    logger.error(String(error));\n    context?.events?.requestError.dispatch(error as Error);\n\n    throw error;\n  }\n}\n"],"names":[],"mappings":";;;;AAsBA,MAAM,4BAAY;AAQlB,MAAM,qBAAqB,SAAS,OAAO,YAA2B;AACpE,MAAI,MAAM,SAAS;AACjB,WAAO;AAEH,QAAA,MAAM,MAAM,WAAW;AAAA,IAC3B,OAAO,MAAM,KAAK,MAAM,OAAQ,CAAA,EAAE,IAAI,CAAC,EAAE,cAAc,QAAQ,IAAI;AAAA,IACnE;AAAA,EAAA,CACD;AAED,aAAW,EAAE,SAAS,QAAa,KAAA,MAAM,UAAU;AACjD,UAAM,KAAK,IAAI,KAAK,CAAC,EAAE,SAAS,MAAM,QAAQ,QAAQ,MAAM,QAAQ,QAAQ,KAAK,IAAI,CAAC;AAElF,QAAA;AACF,cAAQ,EAAE;AAAA;AAEV,cAAQ,IAAI;AAAA,EAChB;AAEA,QAAM,MAAM;AAEL,SAAA;AACT,GAAG;AAAA,EACD,QAAQ;AAAA,EACR,QAAQ;AACV,CAAC;AAKD,eAAsB,UAAU,SAAqD;AACnF,QAAM,UAAU,IAAI;AAAA,IAAyB,CAAC,YAAY;AAClD,YAAA,IAAI,QAAQ,QAAQ,KAAK,IAAI,GAAG,EAAE,SAAS,QAAA,CAAS;AAAA,IAC5D;AAAA,EAAA;AAGM,QAAA,mBAAmB,KAAK,QAAQ,OAAO;AAEtC,SAAA;AACT;AAKA,eAAsB,WAAW,gBAAyE;;AACxG,QAAM,UAAU,MAAM,eAAe,QAAQ,MAAM,aAAa,cAAc;AAExE,QAAA,EAAE,QAAY,IAAA;AAEhB,MAAA;AACO,6CAAA,WAAA,mBAAQ,UAAU,SAAS;AAAA,MAClC,GAAG;AAAA,MACH;AAAA,IAAA;AAGF,UAAM,CAAC,UAAU,UAAU,aAAa,IAAI,MAAM,QAAQ,IAAI;AAAA,QAC5D,aAAQ,QAAQ,gBAAhB,mBAA6B,mBAAkB,SAC3C,gBAAgB,OAAO,IACvB,eAAe,OAAO;AAAA,MAC1B,gBAAgB,QAAQ,QAAQ,OAAO;AAAA,MACvC,OAAO,wBAAqB,EAAE,KAAK,CAAA,WAAU,OAAO,aAAa;AAAA,IAAA,CAClE;AAEM,WAAA,MAAM,qBAAqB,QAAQ;AAE1C,QAAI,CAAC,SAAS;AACN,YAAA,IAAI,MAAM,yBAAyB,SAAS,MAAM,IAAI,SAAS,UAAU,EAAE;AAEnF,UAAM,SAAS,cAAe,MAAM,SAAS,KAAkB,CAAA;AACxD,WAAA,MAAM,aAAa,MAAM;AAEhC,QAAI,SAAS,SAAS;AACb,aAAA,KAAK,SAAS,SAAS,MAAM,IAAI,SAAS,WAAW,IAAI,YAAY,UAAU,kDAAkD,QAAQ;AAE5I,UAAA,kBAAkB,SAAS,IAAI,CAAC,EAAE,UAAU,GAAG,cAAc;AACjE,YAAM,YAAY,OAAO,KAAK,QAAM,GAAG,UAAU,QAAQ,KAAK;AAEtD,aAAA;AAAA,QACN,UAAU,IAAG,uCAAW,aAAY,QAAQ;AAAA,QAC5C,GAAG;AAAA,MAAA;AAAA,IACL,CACD;AAED,QAAI,gBAAgB,SAAS;AACnB,oBAAA,WAAA,mBAAQ,gBAAgB,SAAS;AAE3C,UAAM,eAAe,MAAM,QAAQ,MAAM,cAAc;AAAA,MACrD,GAAG,OAAO,OAAO,CAAA,OAAM,CAAC,SAAS,KAAK,CAAA,YAAW,QAAQ,UAAU,GAAG,KAAK,CAAC;AAAA,MAC5E,GAAG;AAAA,IAAA,CACJ;AAEO,kBAAA,WAAA,mBAAQ,iBAAiB,SAAS;AAEnC,WAAA;AAAA,WAEF,OAAO;AACL,WAAA,MAAM,OAAO,KAAK,CAAC;AACjB,6CAAA,WAAA,mBAAQ,aAAa,SAAS;AAEjC,UAAA;AAAA,EACR;AACF;"}
+{"version":3,"file":"requestAds.js","sources":["../../src/requestAds/requestAds.ts"],"sourcesContent":["import { debounce } from '@adhese/sdk-shared';\nimport type { AdheseContext } from '../main.types';\nimport { logger } from '../logger/logger';\nimport type { AdheseAd } from './requestAds.schema';\nimport { requestPreviews } from './requestAds.preview';\nimport { requestWithGet, requestWithPost } from './requestAds.utils';\n\nexport type AdRequestOptions = {\n  /**\n   * Slot you want to fetch the ad for\n   */\n  slot: {\n    name: string;\n    parameters: Map<string, ReadonlyArray<string> | string>;\n  };\n  context: AdheseContext;\n};\n\nexport type AdMultiRequestOptions = Omit<AdRequestOptions, 'slot'> & {\n  slots: ReadonlyArray<AdRequestOptions['slot']>;\n};\n\nconst batch = new Map<string, {\n  options: AdRequestOptions;\n  resolve(ad: AdheseAd | null): void;\n}>();\n\n/**\n * Debounced function to request ads in batches. This function is debounced to prevent multiple requests for the same ad.\n */\nconst runRequestAdsBatch = debounce(async (context: AdheseContext) => {\n  if (batch.size === 0)\n    return [];\n\n  const ads = await requestAds({\n    slots: Array.from(batch.values()).map(({ options }) => options.slot),\n    context,\n  });\n\n  for (const { options, resolve } of batch.values()) {\n    const ad = ads.find(({ slotName }) => slotName === options.slot.name);\n\n    if (ad)\n      resolve(ad);\n    else\n      resolve(null);\n  }\n\n  batch.clear();\n\n  return ads;\n}, {\n  waitMs: 20,\n  timing: 'trailing',\n});\n\n/**\n * Request a single ad from the API. If you need to fetch multiple ads at once use the `requestAds` function.\n */\nexport async function requestAd(options: AdRequestOptions): Promise<AdheseAd | null> {\n  const promise = new Promise<AdheseAd | null>((resolve) => {\n    batch.set(options.slot.name, { options, resolve });\n  },\n  );\n\n  await runRequestAdsBatch.call(options.context);\n\n  return promise;\n}\n\n/**\n * Request multiple ads from the API. If you need to fetch a single ad use the `requestAd` function.\n */\nexport async function requestAds(requestOptions: AdMultiRequestOptions): Promise<ReadonlyArray<AdheseAd>> {\n  const options = await requestOptions.context.hooks.runOnRequest(requestOptions);\n\n  const { context } = options;\n\n  try {\n    context?.events?.requestAd.dispatch({\n      ...options,\n      context,\n    });\n\n    const [response, previews, parseResponse] = await Promise.all([\n      context.options.requestType?.toUpperCase() === 'POST'\n        ? requestWithPost(options)\n        : requestWithGet(options),\n      requestPreviews(context.options.account),\n      import('./requestAds.schema').then(module => module.parseResponse),\n    ]);\n\n    logger.debug('Received response', response);\n\n    if (!response.ok)\n      throw new Error(`Failed to request ad: ${response.status} ${response.statusText}`);\n\n    const result = parseResponse((await response.json() as unknown));\n    logger.debug('Parsed ad', result);\n\n    if (previews.length > 0)\n      logger.info(`Found ${previews.length} ${previews.length === 1 ? 'preview' : 'previews'}. Replacing ads in response with preview items`, previews);\n\n    const matchedPreviews = previews.map(({ slotName, ...preview }) => {\n      const partnerAd = result.find(ad => ad.libId === preview.libId);\n\n      return ({\n        slotName: `${partnerAd?.slotName ?? slotName}`,\n        ...preview,\n      });\n    });\n\n    if (matchedPreviews.length > 0)\n      context.events?.previewReceived.dispatch(matchedPreviews);\n\n    const mergedResult = await context.hooks.runOnResponse([\n      ...result.filter(ad => !previews.some(preview => preview.libId === ad.libId)),\n      ...matchedPreviews,\n    ]);\n\n    context.events?.responseReceived.dispatch(mergedResult);\n\n    return mergedResult;\n  }\n  catch (error) {\n    logger.error(String(error));\n    context?.events?.requestError.dispatch(error as Error);\n\n    throw error;\n  }\n}\n"],"names":[],"mappings":";;;;AAsBA,MAAM,4BAAY;AAQlB,MAAM,qBAAqB,SAAS,OAAO,YAA2B;AACpE,MAAI,MAAM,SAAS;AACjB,WAAO;AAEH,QAAA,MAAM,MAAM,WAAW;AAAA,IAC3B,OAAO,MAAM,KAAK,MAAM,OAAQ,CAAA,EAAE,IAAI,CAAC,EAAE,cAAc,QAAQ,IAAI;AAAA,IACnE;AAAA,EAAA,CACD;AAED,aAAW,EAAE,SAAS,QAAa,KAAA,MAAM,UAAU;AAC3C,UAAA,KAAK,IAAI,KAAK,CAAC,EAAE,eAAe,aAAa,QAAQ,KAAK,IAAI;AAEhE,QAAA;AACF,cAAQ,EAAE;AAAA;AAEV,cAAQ,IAAI;AAAA,EAChB;AAEA,QAAM,MAAM;AAEL,SAAA;AACT,GAAG;AAAA,EACD,QAAQ;AAAA,EACR,QAAQ;AACV,CAAC;AAKD,eAAsB,UAAU,SAAqD;AACnF,QAAM,UAAU,IAAI;AAAA,IAAyB,CAAC,YAAY;AACxD,YAAM,IAAI,QAAQ,KAAK,MAAM,EAAE,SAAS,SAAS;AAAA,IACnD;AAAA,EAAA;AAGM,QAAA,mBAAmB,KAAK,QAAQ,OAAO;AAEtC,SAAA;AACT;AAKA,eAAsB,WAAW,gBAAyE;;AACxG,QAAM,UAAU,MAAM,eAAe,QAAQ,MAAM,aAAa,cAAc;AAExE,QAAA,EAAE,QAAY,IAAA;AAEhB,MAAA;AACO,6CAAA,WAAA,mBAAQ,UAAU,SAAS;AAAA,MAClC,GAAG;AAAA,MACH;AAAA,IAAA;AAGF,UAAM,CAAC,UAAU,UAAU,aAAa,IAAI,MAAM,QAAQ,IAAI;AAAA,QAC5D,aAAQ,QAAQ,gBAAhB,mBAA6B,mBAAkB,SAC3C,gBAAgB,OAAO,IACvB,eAAe,OAAO;AAAA,MAC1B,gBAAgB,QAAQ,QAAQ,OAAO;AAAA,MACvC,OAAO,wBAAqB,EAAE,KAAK,CAAA,WAAU,OAAO,aAAa;AAAA,IAAA,CAClE;AAEM,WAAA,MAAM,qBAAqB,QAAQ;AAE1C,QAAI,CAAC,SAAS;AACN,YAAA,IAAI,MAAM,yBAAyB,SAAS,MAAM,IAAI,SAAS,UAAU,EAAE;AAEnF,UAAM,SAAS,cAAe,MAAM,SAAS,KAAkB,CAAA;AACxD,WAAA,MAAM,aAAa,MAAM;AAEhC,QAAI,SAAS,SAAS;AACb,aAAA,KAAK,SAAS,SAAS,MAAM,IAAI,SAAS,WAAW,IAAI,YAAY,UAAU,kDAAkD,QAAQ;AAE5I,UAAA,kBAAkB,SAAS,IAAI,CAAC,EAAE,UAAU,GAAG,cAAc;AACjE,YAAM,YAAY,OAAO,KAAK,QAAM,GAAG,UAAU,QAAQ,KAAK;AAEtD,aAAA;AAAA,QACN,UAAU,IAAG,uCAAW,aAAY,QAAQ;AAAA,QAC5C,GAAG;AAAA,MAAA;AAAA,IACL,CACD;AAED,QAAI,gBAAgB,SAAS;AACnB,oBAAA,WAAA,mBAAQ,gBAAgB,SAAS;AAE3C,UAAM,eAAe,MAAM,QAAQ,MAAM,cAAc;AAAA,MACrD,GAAG,OAAO,OAAO,CAAA,OAAM,CAAC,SAAS,KAAK,CAAA,YAAW,QAAQ,UAAU,GAAG,KAAK,CAAC;AAAA,MAC5E,GAAG;AAAA,IAAA,CACJ;AAEO,kBAAA,WAAA,mBAAQ,iBAAiB,SAAS;AAEnC,WAAA;AAAA,WAEF,OAAO;AACL,WAAA,MAAM,OAAO,KAAK,CAAC;AACjB,6CAAA,WAAA,mBAAQ,aAAa,SAAS;AAEjC,UAAA;AAAA,EACR;AACF;"}

package/dist/requestAds/requestAds.utils.js

@@ -7,7 +7,7 @@ function requestWithPost({
   const payload = {
     ...options,
     slots: options.slots.map((slot) => ({
-      slotname: toValue(slot.name),
+      slotname: slot.name,
       parameters: parseParameters(slot.parameters)
     })),
     parameters: context.parameters && parseParameters(context.parameters)

package/dist/requestAds/requestAds.utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"requestAds.utils.js","sources":["../../src/requestAds/requestAds.utils.ts"],"sourcesContent":["import { toValue } from '@adhese/sdk-shared';\nimport { logger } from '../logger/logger';\nimport type { AdMultiRequestOptions } from './requestAds';\n\ntype AdPostPayload = {\n  slots: ReadonlyArray<{\n    slotname: string;\n    parameters?: Record<string, ReadonlyArray<string> | string>;\n  }>;\n  parameters?: Record<string, ReadonlyArray<string> | string>;\n};\n\nexport function requestWithPost({\n  context,\n  ...options\n}: Omit<AdMultiRequestOptions, 'method'>): Promise<Response> {\n  const payload = {\n    ...options,\n    slots: options.slots.map(slot => ({\n      slotname: toValue(slot.name),\n      parameters: parseParameters(slot.parameters),\n    })),\n    parameters: context.parameters && parseParameters(context.parameters),\n  } satisfies AdPostPayload;\n\n  return fetch(`${new URL(context.options.host).href}json`, {\n    method: 'POST',\n    body: JSON.stringify(payload),\n    headers: {\n      // eslint-disable-next-line ts/naming-convention\n      'Content-Type': 'application/json',\n    },\n  });\n}\n\nexport async function requestWithGet({ context, slots }: Omit<AdMultiRequestOptions, 'method'>): Promise<Response> {\n  return fetch(new URL(`${context.options.host}/json/sl${slots.map(slot => toValue(slot.name)).join('/sl')}`), {\n    method: 'GET',\n    headers: {\n      // eslint-disable-next-line ts/naming-convention\n      'Content-Type': 'application/json',\n    },\n  });\n}\n\nexport function parseParameters<T extends string | ReadonlyArray<string>>(parameters: Map<string, T>): Record<string, T> {\n  return Object.fromEntries(Array.from(parameters.entries()).filter(([key]) => {\n    if (key.length === 2)\n      return true;\n\n    logger.warn(`Invalid parameter key: ${key}. Key should be exactly 2 characters long. Key will be ignored.`);\n    return false;\n  }).map(([key, value]): [string, T] => {\n    if (typeof value === 'string')\n      return [key, filterSpecialChars(value) as T];\n\n    return [key, value.map(filterSpecialChars) as unknown as T];\n  }));\n}\n\nfunction filterSpecialChars(value: string): string {\n  const specialRegex = /[^\\p{L}\\p{N}_]/gu;\n\n  return value.replaceAll(specialRegex, '_');\n}\n"],"names":[],"mappings":";;AAYO,SAAS,gBAAgB;AAAA,EAC9B;AAAA,EACA,GAAG;AACL,GAA6D;AAC3D,QAAM,UAAU;AAAA,IACd,GAAG;AAAA,IACH,OAAO,QAAQ,MAAM,IAAI,CAAS,UAAA;AAAA,MAChC,UAAU,QAAQ,KAAK,IAAI;AAAA,MAC3B,YAAY,gBAAgB,KAAK,UAAU;AAAA,IAAA,EAC3C;AAAA,IACF,YAAY,QAAQ,cAAc,gBAAgB,QAAQ,UAAU;AAAA,EAAA;AAG/D,SAAA,MAAM,GAAG,IAAI,IAAI,QAAQ,QAAQ,IAAI,EAAE,IAAI,QAAQ;AAAA,IACxD,QAAQ;AAAA,IACR,MAAM,KAAK,UAAU,OAAO;AAAA,IAC5B,SAAS;AAAA;AAAA,MAEP,gBAAgB;AAAA,IAClB;AAAA,EAAA,CACD;AACH;AAEA,eAAsB,eAAe,EAAE,SAAS,SAAmE;AAC1G,SAAA,MAAM,IAAI,IAAI,GAAG,QAAQ,QAAQ,IAAI,WAAW,MAAM,IAAI,UAAQ,QAAQ,KAAK,IAAI,CAAC,EAAE,KAAK,KAAK,CAAC,EAAE,GAAG;AAAA,IAC3G,QAAQ;AAAA,IACR,SAAS;AAAA;AAAA,MAEP,gBAAgB;AAAA,IAClB;AAAA,EAAA,CACD;AACH;AAEO,SAAS,gBAA0D,YAA+C;AACvH,SAAO,OAAO,YAAY,MAAM,KAAK,WAAW,QAAA,CAAS,EAAE,OAAO,CAAC,CAAC,GAAG,MAAM;AAC3E,QAAI,IAAI,WAAW;AACV,aAAA;AAEF,WAAA,KAAK,0BAA0B,GAAG,iEAAiE;AACnG,WAAA;AAAA,EACR,CAAA,EAAE,IAAI,CAAC,CAAC,KAAK,KAAK,MAAmB;AACpC,QAAI,OAAO,UAAU;AACnB,aAAO,CAAC,KAAK,mBAAmB,KAAK,CAAM;AAE7C,WAAO,CAAC,KAAK,MAAM,IAAI,kBAAkB,CAAiB;AAAA,EAC3D,CAAA,CAAC;AACJ;AAEA,SAAS,mBAAmB,OAAuB;AACjD,QAAM,eAAe;AAEd,SAAA,MAAM,WAAW,cAAc,GAAG;AAC3C;"}
+{"version":3,"file":"requestAds.utils.js","sources":["../../src/requestAds/requestAds.utils.ts"],"sourcesContent":["import { toValue } from '@adhese/sdk-shared';\nimport { logger } from '../logger/logger';\nimport type { AdMultiRequestOptions } from './requestAds';\n\ntype AdPostPayload = {\n  slots: ReadonlyArray<{\n    slotname: string;\n    parameters?: Record<string, ReadonlyArray<string> | string>;\n  }>;\n  parameters?: Record<string, ReadonlyArray<string> | string>;\n};\n\nexport function requestWithPost({\n  context,\n  ...options\n}: Omit<AdMultiRequestOptions, 'method'>): Promise<Response> {\n  const payload = {\n    ...options,\n    slots: options.slots.map(slot => ({\n      slotname: slot.name,\n      parameters: parseParameters(slot.parameters),\n    })),\n    parameters: context.parameters && parseParameters(context.parameters),\n  } satisfies AdPostPayload;\n\n  return fetch(`${new URL(context.options.host).href}json`, {\n    method: 'POST',\n    body: JSON.stringify(payload),\n    headers: {\n      // eslint-disable-next-line ts/naming-convention\n      'Content-Type': 'application/json',\n    },\n  });\n}\n\nexport async function requestWithGet({ context, slots }: Omit<AdMultiRequestOptions, 'method'>): Promise<Response> {\n  return fetch(new URL(`${context.options.host}/json/sl${slots.map(slot => toValue(slot.name)).join('/sl')}`), {\n    method: 'GET',\n    headers: {\n      // eslint-disable-next-line ts/naming-convention\n      'Content-Type': 'application/json',\n    },\n  });\n}\n\nexport function parseParameters<T extends string | ReadonlyArray<string>>(parameters: Map<string, T>): Record<string, T> {\n  return Object.fromEntries(Array.from(parameters.entries()).filter(([key]) => {\n    if (key.length === 2)\n      return true;\n\n    logger.warn(`Invalid parameter key: ${key}. Key should be exactly 2 characters long. Key will be ignored.`);\n    return false;\n  }).map(([key, value]): [string, T] => {\n    if (typeof value === 'string')\n      return [key, filterSpecialChars(value) as T];\n\n    return [key, value.map(filterSpecialChars) as unknown as T];\n  }));\n}\n\nfunction filterSpecialChars(value: string): string {\n  const specialRegex = /[^\\p{L}\\p{N}_]/gu;\n\n  return value.replaceAll(specialRegex, '_');\n}\n"],"names":[],"mappings":";;AAYO,SAAS,gBAAgB;AAAA,EAC9B;AAAA,EACA,GAAG;AACL,GAA6D;AAC3D,QAAM,UAAU;AAAA,IACd,GAAG;AAAA,IACH,OAAO,QAAQ,MAAM,IAAI,CAAS,UAAA;AAAA,MAChC,UAAU,KAAK;AAAA,MACf,YAAY,gBAAgB,KAAK,UAAU;AAAA,IAAA,EAC3C;AAAA,IACF,YAAY,QAAQ,cAAc,gBAAgB,QAAQ,UAAU;AAAA,EAAA;AAG/D,SAAA,MAAM,GAAG,IAAI,IAAI,QAAQ,QAAQ,IAAI,EAAE,IAAI,QAAQ;AAAA,IACxD,QAAQ;AAAA,IACR,MAAM,KAAK,UAAU,OAAO;AAAA,IAC5B,SAAS;AAAA;AAAA,MAEP,gBAAgB;AAAA,IAClB;AAAA,EAAA,CACD;AACH;AAEA,eAAsB,eAAe,EAAE,SAAS,SAAmE;AAC1G,SAAA,MAAM,IAAI,IAAI,GAAG,QAAQ,QAAQ,IAAI,WAAW,MAAM,IAAI,UAAQ,QAAQ,KAAK,IAAI,CAAC,EAAE,KAAK,KAAK,CAAC,EAAE,GAAG;AAAA,IAC3G,QAAQ;AAAA,IACR,SAAS;AAAA;AAAA,MAEP,gBAAgB;AAAA,IAClB;AAAA,EAAA,CACD;AACH;AAEO,SAAS,gBAA0D,YAA+C;AACvH,SAAO,OAAO,YAAY,MAAM,KAAK,WAAW,QAAA,CAAS,EAAE,OAAO,CAAC,CAAC,GAAG,MAAM;AAC3E,QAAI,IAAI,WAAW;AACV,aAAA;AAEF,WAAA,KAAK,0BAA0B,GAAG,iEAAiE;AACnG,WAAA;AAAA,EACR,CAAA,EAAE,IAAI,CAAC,CAAC,KAAK,KAAK,MAAmB;AACpC,QAAI,OAAO,UAAU;AACnB,aAAO,CAAC,KAAK,mBAAmB,KAAK,CAAM;AAE7C,WAAO,CAAC,KAAK,MAAM,IAAI,kBAAkB,CAAiB;AAAA,EAC3D,CAAA,CAAC;AACJ;AAEA,SAAS,mBAAmB,OAAuB;AACjD,QAAM,eAAe;AAEd,SAAA,MAAM,WAAW,cAAc,GAAG;AAC3C;"}

package/dist/slot/slot.js

@@ -1,8 +1,7 @@
-import { effectScope, ref, uniqueId, reactive, computed, generateName, watch, isDeepEqual, omit, addTrackingPixel, waitForDomLoad, doNothing } from "@adhese/sdk-shared";
+import { effectScope, ref, uniqueId, reactive, computed, generateName, watch, isDeepEqual, omit, addTrackingPixel, waitForDomLoad, renderIframe, renderInline, doNothing } from "@adhese/sdk-shared";
 import { requestAd } from "../requestAds/requestAds.js";
 import { logger } from "../logger/logger.js";
 import { useQueryDetector } from "../queryDetector/queryDetector.js";
-import { renderIframe, renderInline } from "./slot.utils.js";
 import { useSlotHooks, useDomLoaded, useRenderIntersectionObserver, useViewabilityObserver } from "./slot.composables.js";
 const renderFunctions = {
   iframe: renderIframe,
@@ -199,6 +198,7 @@ function createSlot(slotOptions) {
       isDisposed,
       id,
       pluginOptions,
+      isVisible: isInViewport,
       render,
       request,
       dispose,

package/dist/slot/slot.js.map

@@ -1 +1 @@
-{"version":3,"file":"slot.js","sources":["../../src/slot/slot.ts"],"sourcesContent":["import {\n  type Ref,\n  type UnwrapRef,\n  addTrackingPixel,\n  computed,\n  doNothing,\n  effectScope,\n  generateName,\n  isDeepEqual,\n  omit,\n  reactive,\n  ref,\n  uniqueId,\n  waitForDomLoad,\n  watch,\n} from '@adhese/sdk-shared';\nimport type { AdheseAd } from '@adhese/sdk';\nimport { requestAd as extRequestAd } from '../requestAds/requestAds';\nimport { logger } from '../logger/logger';\nimport { useQueryDetector } from '../queryDetector/queryDetector';\nimport type { AdheseSlot, AdheseSlotContext, AdheseSlotOptions, RenderMode } from './slot.types';\nimport { renderIframe, renderInline } from './slot.utils';\nimport {\n  useDomLoaded,\n  useRenderIntersectionObserver,\n  useSlotHooks,\n  useViewabilityObserver,\n} from './slot.composables';\n\nconst renderFunctions: Record<RenderMode, (ad: AdheseAd, element: HTMLElement) => void> = {\n  iframe: renderIframe,\n  inline: renderInline,\n  none: doNothing,\n};\n\nconst defaultOptions = {\n  renderMode: 'iframe',\n  type: 'normal',\n} satisfies Partial<AdheseSlotOptions>;\n\n/**\n * Create a new slot instance. This slot instance can be used to request and render ads.\n *\n * @param slotOptions {AdheseSlotOptions} The options to create the slot with.\n *\n * @return AdheseSlot The created slot instance.\n */\nexport function createSlot(slotOptions: AdheseSlotOptions): AdheseSlot {\n  const scope = effectScope();\n\n  return scope.run(() => {\n    const slotContext = ref<AdheseSlotContext | null>(null);\n    const options = slotOptions.context.hooks.runOnSlotCreate({\n      ...defaultOptions,\n      ...slotOptions,\n    });\n\n    const {\n      containingElement,\n      slot,\n      context,\n      pluginOptions,\n      renderMode = 'iframe',\n      type = 'normal',\n    } = options;\n\n    const id = uniqueId();\n    const {\n      runOnBeforeRender,\n      runOnRender,\n      runOnBeforeRequest,\n      runOnRequest,\n      runOnInit,\n      runOnDispose,\n      ...hooks\n    } = useSlotHooks(options, slotContext);\n\n    const isDisposed = ref(false);\n    const parameters = reactive(new Map(Object.entries(options.parameters ?? {})));\n\n    const [device, disposeQueryDetector] = useQueryDetector(context, typeof options.format === 'string'\n      ? {\n          [options.format]: '(min-width: 0px)',\n        }\n      : Object.fromEntries(options.format.map(item => [item.format, item.query])));\n\n    const format = computed(() => typeof options.format === 'string' ? options.format : device.value);\n\n    const data = ref<AdheseAd | null>(null) as Ref<AdheseAd | null>;\n    const originalData = ref(data.value) as Ref<AdheseAd | null>;\n    const name = computed(() => generateName(options.context.location, format.value, options.slot));\n\n    watch(name, async (newName, oldName) => {\n      if (newName === oldName)\n        return;\n\n      const newAd = await slotContext.value?.request();\n\n      if (!newAd)\n        return;\n\n      slotContext.value?.cleanElement();\n\n      data.value = newAd;\n      originalData.value = newAd;\n    });\n\n    const isDomLoaded = useDomLoaded(context);\n\n    const element = computed(() => {\n      if (!(typeof options.containingElement === 'string' || !options.containingElement))\n        return options.containingElement;\n\n      if (!isDomLoaded.value || slotContext.value?.isDisposed)\n        return null;\n\n      return document.querySelector<HTMLElement>(`.adunit[data-format=\"${format.value}\"]#${options.containingElement}${options.slot ? `[data-slot=\"${options.slot}\"]` : ''}`);\n    },\n    );\n\n    const isInViewport = useRenderIntersectionObserver({\n      options,\n      element,\n      hooks,\n    });\n\n    const status = ref<UnwrapRef<AdheseSlot>['status']>('initializing');\n\n    watch([data, isInViewport], async ([newData, newIsInViewport], [oldData]) => {\n      if ((!newData || (oldData && isDeepEqual(newData, oldData))) && status.value === 'rendered')\n        return;\n\n      if (newIsInViewport)\n        await slotContext.value?.render(newData ?? undefined);\n    });\n\n    hooks.onDispose(() => {\n      disposeQueryDetector();\n    });\n\n    const isViewabilityTracked = useViewabilityObserver({\n      context,\n      slotContext,\n      hooks,\n      onTracked(trackingPixel) {\n        if (slotContext.value?.data?.viewableImpressionCounter) {\n          trackingPixel.value = addTrackingPixel(slotContext.value?.data?.viewableImpressionCounter);\n\n          context.logger.debug(`Viewability tracking pixel fired for ${slotContext.value?.name}`);\n        }\n      },\n    });\n\n    const impressionTrackingPixelElement = ref<HTMLImageElement | null>(null);\n    const isImpressionTracked = ref(false);\n    hooks.onDispose(() => {\n      if (impressionTrackingPixelElement.value)\n        impressionTrackingPixelElement.value.remove();\n    });\n\n    async function request(): Promise<AdheseAd | null> {\n      if (options.lazyLoading && !isInViewport.value)\n        return null;\n\n      status.value = 'loading';\n\n      let response = await runOnBeforeRequest(null);\n\n      if (!response) {\n        response = await extRequestAd({\n          slot: {\n            name: name.value,\n            parameters,\n          },\n          context,\n        });\n      }\n\n      if (response)\n        response = await runOnRequest(response);\n\n      data.value = response;\n\n      if (!originalData.value)\n        originalData.value = response;\n\n      status.value = response ? 'loaded' : 'empty';\n\n      if (!response)\n        cleanElement();\n\n      return response;\n    }\n\n    async function render(adToRender?: AdheseAd): Promise<HTMLElement | null> {\n      status.value = 'rendering';\n\n      await waitForDomLoad();\n\n      let renderAd = adToRender ?? data.value ?? originalData.value ?? await request();\n\n      renderAd = renderAd && await runOnBeforeRender(renderAd);\n\n      if (!renderAd) {\n        status.value = 'empty';\n        logger.debug(`No ad to render for slot ${name.value}`);\n\n        return null;\n      }\n\n      if (!element.value) {\n        const error = `Could not create slot for format ${format.value}. No element found.`;\n        logger.error(error, options);\n        throw new Error(error);\n      }\n\n      if (context.debug)\n        element.value.style.position = 'relative';\n\n      if (typeof renderAd?.tag !== 'string') {\n        const error = `Could not render slot for slot ${name.value}. A valid tag doesn't exist or is not HTML string.`;\n        logger.error(error, options);\n\n        status.value = 'error';\n        throw new Error(error);\n      }\n\n      renderFunctions[renderMode](renderAd, element.value);\n\n      if (renderAd.impressionCounter && !impressionTrackingPixelElement.value)\n        impressionTrackingPixelElement.value = addTrackingPixel(renderAd.impressionCounter);\n\n      isImpressionTracked.value = true;\n\n      logger.debug(`Slot rendered ${name.value}`, {\n        renderedElement: element,\n        location: context.location,\n        format,\n        containingElement,\n      });\n\n      // eslint-disable-next-line require-atomic-updates\n      data.value = renderAd;\n\n      status.value = 'rendered';\n\n      runOnRender(renderAd);\n\n      return element.value;\n    }\n\n    function cleanElement(): void {\n      if (!element.value)\n        return;\n\n      element.value.innerHTML = '';\n      element.value.style.position = '';\n      element.value.style.width = '';\n      element.value.style.height = '';\n\n      data.value = null;\n      originalData.value = null;\n    }\n\n    function dispose(): void {\n      cleanElement();\n\n      data.value = null;\n\n      runOnDispose();\n\n      isDisposed.value = true;\n\n      scope.stop();\n    }\n\n    const state = reactive({\n      location: context.location ?? '',\n      lazyLoading: options.lazyLoading ?? false,\n      type,\n      slot,\n      parameters,\n      format,\n      name,\n      data,\n      isViewabilityTracked,\n      isImpressionTracked,\n      status,\n      element,\n      isDisposed,\n      id,\n      pluginOptions,\n      render,\n      request,\n      dispose,\n      cleanElement,\n      options: omit(options, ['context']),\n      ...hooks,\n    });\n\n    watch(state, (newState) => {\n      slotContext.value = newState;\n    }, {\n      deep: true,\n      immediate: true,\n    });\n\n    context.hooks.onInit(async () => {\n      status.value = 'initialized';\n\n      runOnInit();\n\n      if (options.lazyLoading)\n        return;\n\n      data.value = await slotContext.value?.request() ?? null;\n    });\n\n    return state;\n  })!;\n}\n"],"names":["extRequestAd"],"mappings":";;;;;;AA6BA,MAAM,kBAAoF;AAAA,EACxF,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,MAAM;AACR;AAEA,MAAM,iBAAiB;AAAA,EACrB,YAAY;AAAA,EACZ,MAAM;AACR;AASO,SAAS,WAAW,aAA4C;AACrE,QAAM,QAAQ;AAEP,SAAA,MAAM,IAAI,MAAM;AACf,UAAA,cAAc,IAA8B,IAAI;AACtD,UAAM,UAAU,YAAY,QAAQ,MAAM,gBAAgB;AAAA,MACxD,GAAG;AAAA,MACH,GAAG;AAAA,IAAA,CACJ;AAEK,UAAA;AAAA,MACJ;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,aAAa;AAAA,MACb,OAAO;AAAA,IACL,IAAA;AAEJ,UAAM,KAAK;AACL,UAAA;AAAA,MACJ;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,GAAG;AAAA,IAAA,IACD,aAAa,SAAS,WAAW;AAE/B,UAAA,aAAa,IAAI,KAAK;AACtB,UAAA,aAAa,SAAS,IAAI,IAAI,OAAO,QAAQ,QAAQ,cAAc,EAAE,CAAC,CAAC;AAEvE,UAAA,CAAC,QAAQ,oBAAoB,IAAI,iBAAiB,SAAS,OAAO,QAAQ,WAAW,WACvF;AAAA,MACE,CAAC,QAAQ,MAAM,GAAG;AAAA,IAEpB,IAAA,OAAO,YAAY,QAAQ,OAAO,IAAI,CAAA,SAAQ,CAAC,KAAK,QAAQ,KAAK,KAAK,CAAC,CAAC,CAAC;AAEvE,UAAA,SAAS,SAAS,MAAM,OAAO,QAAQ,WAAW,WAAW,QAAQ,SAAS,OAAO,KAAK;AAE1F,UAAA,OAAO,IAAqB,IAAI;AAChC,UAAA,eAAe,IAAI,KAAK,KAAK;AAC7B,UAAA,OAAO,SAAS,MAAM,aAAa,QAAQ,QAAQ,UAAU,OAAO,OAAO,QAAQ,IAAI,CAAC;AAExF,UAAA,MAAM,OAAO,SAAS,YAAY;;AACtC,UAAI,YAAY;AACd;AAEF,YAAM,QAAQ,QAAM,iBAAY,UAAZ,mBAAmB;AAEvC,UAAI,CAAC;AACH;AAEF,wBAAY,UAAZ,mBAAmB;AAEnB,WAAK,QAAQ;AACb,mBAAa,QAAQ;AAAA,IAAA,CACtB;AAEK,UAAA,cAAc,aAAa,OAAO;AAExC,UAAM,UAAU;AAAA,MAAS,MAAM;;AAC7B,YAAI,EAAE,OAAO,QAAQ,sBAAsB,YAAY,CAAC,QAAQ;AAC9D,iBAAO,QAAQ;AAEjB,YAAI,CAAC,YAAY,WAAS,iBAAY,UAAZ,mBAAmB;AACpC,iBAAA;AAET,eAAO,SAAS,cAA2B,wBAAwB,OAAO,KAAK,MAAM,QAAQ,iBAAiB,GAAG,QAAQ,OAAO,eAAe,QAAQ,IAAI,OAAO,EAAE,EAAE;AAAA,MACxK;AAAA,IAAA;AAGA,UAAM,eAAe,8BAA8B;AAAA,MACjD;AAAA,MACA;AAAA,MACA;AAAA,IAAA,CACD;AAEK,UAAA,SAAS,IAAqC,cAAc;AAE5D,UAAA,CAAC,MAAM,YAAY,GAAG,OAAO,CAAC,SAAS,eAAe,GAAG,CAAC,OAAO,MAAM;;AACtE,WAAA,CAAC,WAAY,WAAW,YAAY,SAAS,OAAO,MAAO,OAAO,UAAU;AAC/E;AAEE,UAAA;AACF,gBAAM,iBAAY,UAAZ,mBAAmB,OAAO,WAAW;AAAA,IAAS,CACvD;AAED,UAAM,UAAU,MAAM;AACC;IAAA,CACtB;AAED,UAAM,uBAAuB,uBAAuB;AAAA,MAClD;AAAA,MACA;AAAA,MACA;AAAA,MACA,UAAU,eAAe;;AACnB,aAAA,uBAAY,UAAZ,mBAAmB,SAAnB,mBAAyB,2BAA2B;AACtD,wBAAc,QAAQ,kBAAiB,uBAAY,UAAZ,mBAAmB,SAAnB,mBAAyB,yBAAyB;AAEzF,kBAAQ,OAAO,MAAM,yCAAwC,iBAAY,UAAZ,mBAAmB,IAAI,EAAE;AAAA,QACxF;AAAA,MACF;AAAA,IAAA,CACD;AAEK,UAAA,iCAAiC,IAA6B,IAAI;AAClE,UAAA,sBAAsB,IAAI,KAAK;AACrC,UAAM,UAAU,MAAM;AACpB,UAAI,+BAA+B;AACjC,uCAA+B,MAAM;IAAO,CAC/C;AAED,mBAAe,UAAoC;AAC7C,UAAA,QAAQ,eAAe,CAAC,aAAa;AAChC,eAAA;AAET,aAAO,QAAQ;AAEX,UAAA,WAAW,MAAM,mBAAmB,IAAI;AAE5C,UAAI,CAAC,UAAU;AACb,mBAAW,MAAMA,UAAa;AAAA,UAC5B,MAAM;AAAA,YACJ,MAAM,KAAK;AAAA,YACX;AAAA,UACF;AAAA,UACA;AAAA,QAAA,CACD;AAAA,MACH;AAEI,UAAA;AACS,mBAAA,MAAM,aAAa,QAAQ;AAExC,WAAK,QAAQ;AAEb,UAAI,CAAC,aAAa;AAChB,qBAAa,QAAQ;AAEhB,aAAA,QAAQ,WAAW,WAAW;AAErC,UAAI,CAAC;AACU;AAER,aAAA;AAAA,IACT;AAEA,mBAAe,OAAO,YAAoD;AACxE,aAAO,QAAQ;AAEf,YAAM,eAAe;AAErB,UAAI,WAAW,cAAc,KAAK,SAAS,aAAa,SAAS,MAAM;AAE5D,iBAAA,YAAY,MAAM,kBAAkB,QAAQ;AAEvD,UAAI,CAAC,UAAU;AACb,eAAO,QAAQ;AACf,eAAO,MAAM,4BAA4B,KAAK,KAAK,EAAE;AAE9C,eAAA;AAAA,MACT;AAEI,UAAA,CAAC,QAAQ,OAAO;AACZ,cAAA,QAAQ,oCAAoC,OAAO,KAAK;AACvD,eAAA,MAAM,OAAO,OAAO;AACrB,cAAA,IAAI,MAAM,KAAK;AAAA,MACvB;AAEA,UAAI,QAAQ;AACF,gBAAA,MAAM,MAAM,WAAW;AAE7B,UAAA,QAAO,qCAAU,SAAQ,UAAU;AAC/B,cAAA,QAAQ,kCAAkC,KAAK,KAAK;AACnD,eAAA,MAAM,OAAO,OAAO;AAE3B,eAAO,QAAQ;AACT,cAAA,IAAI,MAAM,KAAK;AAAA,MACvB;AAEA,sBAAgB,UAAU,EAAE,UAAU,QAAQ,KAAK;AAE/C,UAAA,SAAS,qBAAqB,CAAC,+BAA+B;AACjC,uCAAA,QAAQ,iBAAiB,SAAS,iBAAiB;AAEpF,0BAAoB,QAAQ;AAE5B,aAAO,MAAM,iBAAiB,KAAK,KAAK,IAAI;AAAA,QAC1C,iBAAiB;AAAA,QACjB,UAAU,QAAQ;AAAA,QAClB;AAAA,QACA;AAAA,MAAA,CACD;AAGD,WAAK,QAAQ;AAEb,aAAO,QAAQ;AAEf,kBAAY,QAAQ;AAEpB,aAAO,QAAQ;AAAA,IACjB;AAEA,aAAS,eAAqB;AAC5B,UAAI,CAAC,QAAQ;AACX;AAEF,cAAQ,MAAM,YAAY;AAClB,cAAA,MAAM,MAAM,WAAW;AACvB,cAAA,MAAM,MAAM,QAAQ;AACpB,cAAA,MAAM,MAAM,SAAS;AAE7B,WAAK,QAAQ;AACb,mBAAa,QAAQ;AAAA,IACvB;AAEA,aAAS,UAAgB;AACV;AAEb,WAAK,QAAQ;AAEA;AAEb,iBAAW,QAAQ;AAEnB,YAAM,KAAK;AAAA,IACb;AAEA,UAAM,QAAQ,SAAS;AAAA,MACrB,UAAU,QAAQ,YAAY;AAAA,MAC9B,aAAa,QAAQ,eAAe;AAAA,MACpC;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,SAAS,KAAK,SAAS,CAAC,SAAS,CAAC;AAAA,MAClC,GAAG;AAAA,IAAA,CACJ;AAEK,UAAA,OAAO,CAAC,aAAa;AACzB,kBAAY,QAAQ;AAAA,IAAA,GACnB;AAAA,MACD,MAAM;AAAA,MACN,WAAW;AAAA,IAAA,CACZ;AAEO,YAAA,MAAM,OAAO,YAAY;;AAC/B,aAAO,QAAQ;AAEL;AAEV,UAAI,QAAQ;AACV;AAEF,WAAK,QAAQ,QAAM,iBAAY,UAAZ,mBAAmB,cAAa;AAAA,IAAA,CACpD;AAEM,WAAA;AAAA,EAAA,CACR;AACH;"}
+{"version":3,"file":"slot.js","sources":["../../src/slot/slot.ts"],"sourcesContent":["import {\n  type Ref,\n  type RenderOptions,\n  type UnwrapRef,\n  addTrackingPixel,\n  computed,\n  doNothing,\n  effectScope,\n  generateName,\n  isDeepEqual,\n  omit,\n  reactive,\n  ref,\n  renderIframe,\n  renderInline,\n  uniqueId,\n  waitForDomLoad,\n  watch,\n} from '@adhese/sdk-shared';\nimport type { AdheseAd } from '@adhese/sdk';\nimport { requestAd as extRequestAd } from '../requestAds/requestAds';\nimport { logger } from '../logger/logger';\nimport { useQueryDetector } from '../queryDetector/queryDetector';\nimport type { AdheseSlot, AdheseSlotContext, AdheseSlotOptions, RenderMode } from './slot.types';\nimport {\n  useDomLoaded,\n  useRenderIntersectionObserver,\n  useSlotHooks,\n  useViewabilityObserver,\n} from './slot.composables';\n\nconst renderFunctions: Record<RenderMode, (ad: RenderOptions, element: HTMLElement) => void> = {\n  iframe: renderIframe,\n  inline: renderInline,\n  none: doNothing,\n};\n\nconst defaultOptions = {\n  renderMode: 'iframe',\n  type: 'normal',\n} satisfies Partial<AdheseSlotOptions>;\n\n/**\n * Create a new slot instance. This slot instance can be used to request and render ads.\n *\n * @param slotOptions {AdheseSlotOptions} The options to create the slot with.\n *\n * @return AdheseSlot The created slot instance.\n */\nexport function createSlot(slotOptions: AdheseSlotOptions): AdheseSlot {\n  const scope = effectScope();\n\n  return scope.run(() => {\n    const slotContext = ref<AdheseSlotContext | null>(null);\n    const options = slotOptions.context.hooks.runOnSlotCreate({\n      ...defaultOptions,\n      ...slotOptions,\n    });\n\n    const {\n      containingElement,\n      slot,\n      context,\n      pluginOptions,\n      renderMode = 'iframe',\n      type = 'normal',\n    } = options;\n\n    const id = uniqueId();\n    const {\n      runOnBeforeRender,\n      runOnRender,\n      runOnBeforeRequest,\n      runOnRequest,\n      runOnInit,\n      runOnDispose,\n      ...hooks\n    } = useSlotHooks(options, slotContext);\n\n    const isDisposed = ref(false);\n    const parameters = reactive(new Map(Object.entries(options.parameters ?? {})));\n\n    const [device, disposeQueryDetector] = useQueryDetector(context, typeof options.format === 'string'\n      ? {\n          [options.format]: '(min-width: 0px)',\n        }\n      : Object.fromEntries(options.format.map(item => [item.format, item.query])));\n\n    const format = computed(() => typeof options.format === 'string' ? options.format : device.value);\n\n    const data = ref<AdheseAd | null>(null) as Ref<AdheseAd | null>;\n    const originalData = ref(data.value) as Ref<AdheseAd | null>;\n    const name = computed(() => generateName(options.context.location, format.value, options.slot));\n\n    watch(name, async (newName, oldName) => {\n      if (newName === oldName)\n        return;\n\n      const newAd = await slotContext.value?.request();\n\n      if (!newAd)\n        return;\n\n      slotContext.value?.cleanElement();\n\n      data.value = newAd;\n      originalData.value = newAd;\n    });\n\n    const isDomLoaded = useDomLoaded(context);\n\n    const element = computed(() => {\n      if (!(typeof options.containingElement === 'string' || !options.containingElement))\n        return options.containingElement;\n\n      if (!isDomLoaded.value || slotContext.value?.isDisposed)\n        return null;\n\n      return document.querySelector<HTMLElement>(`.adunit[data-format=\"${format.value}\"]#${options.containingElement}${options.slot ? `[data-slot=\"${options.slot}\"]` : ''}`);\n    },\n    );\n\n    const isInViewport = useRenderIntersectionObserver({\n      options,\n      element,\n      hooks,\n    });\n\n    const status = ref<UnwrapRef<AdheseSlot>['status']>('initializing');\n\n    watch([data, isInViewport], async ([newData, newIsInViewport], [oldData]) => {\n      if ((!newData || (oldData && isDeepEqual(newData, oldData))) && status.value === 'rendered')\n        return;\n\n      if (newIsInViewport)\n        await slotContext.value?.render(newData ?? undefined);\n    });\n\n    hooks.onDispose(() => {\n      disposeQueryDetector();\n    });\n\n    const isViewabilityTracked = useViewabilityObserver({\n      context,\n      slotContext,\n      hooks,\n      onTracked(trackingPixel) {\n        if (slotContext.value?.data?.viewableImpressionCounter) {\n          trackingPixel.value = addTrackingPixel(slotContext.value?.data?.viewableImpressionCounter);\n\n          context.logger.debug(`Viewability tracking pixel fired for ${slotContext.value?.name}`);\n        }\n      },\n    });\n\n    const impressionTrackingPixelElement = ref<HTMLImageElement | null>(null);\n    const isImpressionTracked = ref(false);\n    hooks.onDispose(() => {\n      if (impressionTrackingPixelElement.value)\n        impressionTrackingPixelElement.value.remove();\n    });\n\n    async function request(): Promise<AdheseAd | null> {\n      if (options.lazyLoading && !isInViewport.value)\n        return null;\n\n      status.value = 'loading';\n\n      let response = await runOnBeforeRequest(null);\n\n      if (!response) {\n        response = await extRequestAd({\n          slot: {\n            name: name.value,\n            parameters,\n          },\n          context,\n        });\n      }\n\n      if (response)\n        response = await runOnRequest(response);\n\n      data.value = response;\n\n      if (!originalData.value)\n        originalData.value = response;\n\n      status.value = response ? 'loaded' : 'empty';\n\n      if (!response)\n        cleanElement();\n\n      return response;\n    }\n\n    async function render(adToRender?: AdheseAd): Promise<HTMLElement | null> {\n      status.value = 'rendering';\n\n      await waitForDomLoad();\n\n      let renderAd = adToRender ?? data.value ?? originalData.value ?? await request();\n\n      renderAd = renderAd && await runOnBeforeRender(renderAd);\n\n      if (!renderAd) {\n        status.value = 'empty';\n        logger.debug(`No ad to render for slot ${name.value}`);\n\n        return null;\n      }\n\n      if (!element.value) {\n        const error = `Could not create slot for format ${format.value}. No element found.`;\n        logger.error(error, options);\n        throw new Error(error);\n      }\n\n      if (context.debug)\n        element.value.style.position = 'relative';\n\n      if (typeof renderAd?.tag !== 'string') {\n        const error = `Could not render slot for slot ${name.value}. A valid tag doesn't exist or is not HTML string.`;\n        logger.error(error, options);\n\n        status.value = 'error';\n        throw new Error(error);\n      }\n\n      renderFunctions[renderMode](renderAd as RenderOptions, element.value);\n\n      if (renderAd.impressionCounter && !impressionTrackingPixelElement.value)\n        impressionTrackingPixelElement.value = addTrackingPixel(renderAd.impressionCounter);\n\n      isImpressionTracked.value = true;\n\n      logger.debug(`Slot rendered ${name.value}`, {\n        renderedElement: element,\n        location: context.location,\n        format,\n        containingElement,\n      });\n\n      // eslint-disable-next-line require-atomic-updates\n      data.value = renderAd;\n\n      status.value = 'rendered';\n\n      runOnRender(renderAd);\n\n      return element.value;\n    }\n\n    function cleanElement(): void {\n      if (!element.value)\n        return;\n\n      element.value.innerHTML = '';\n      element.value.style.position = '';\n      element.value.style.width = '';\n      element.value.style.height = '';\n\n      data.value = null;\n      originalData.value = null;\n    }\n\n    function dispose(): void {\n      cleanElement();\n\n      data.value = null;\n\n      runOnDispose();\n\n      isDisposed.value = true;\n\n      scope.stop();\n    }\n\n    const state = reactive({\n      location: context.location ?? '',\n      lazyLoading: options.lazyLoading ?? false,\n      type,\n      slot,\n      parameters,\n      format,\n      name,\n      data,\n      isViewabilityTracked,\n      isImpressionTracked,\n      status,\n      element,\n      isDisposed,\n      id,\n      pluginOptions,\n      isVisible: isInViewport,\n      render,\n      request,\n      dispose,\n      cleanElement,\n      options: omit(options, ['context']),\n      ...hooks,\n    });\n\n    watch(state, (newState) => {\n      slotContext.value = newState;\n    }, {\n      deep: true,\n      immediate: true,\n    });\n\n    context.hooks.onInit(async () => {\n      status.value = 'initialized';\n\n      runOnInit();\n\n      if (options.lazyLoading)\n        return;\n\n      data.value = await slotContext.value?.request() ?? null;\n    });\n\n    return state;\n  })!;\n}\n"],"names":["extRequestAd"],"mappings":";;;;;AA+BA,MAAM,kBAAyF;AAAA,EAC7F,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,MAAM;AACR;AAEA,MAAM,iBAAiB;AAAA,EACrB,YAAY;AAAA,EACZ,MAAM;AACR;AASO,SAAS,WAAW,aAA4C;AACrE,QAAM,QAAQ;AAEP,SAAA,MAAM,IAAI,MAAM;AACf,UAAA,cAAc,IAA8B,IAAI;AACtD,UAAM,UAAU,YAAY,QAAQ,MAAM,gBAAgB;AAAA,MACxD,GAAG;AAAA,MACH,GAAG;AAAA,IAAA,CACJ;AAEK,UAAA;AAAA,MACJ;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,aAAa;AAAA,MACb,OAAO;AAAA,IACL,IAAA;AAEJ,UAAM,KAAK;AACL,UAAA;AAAA,MACJ;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,GAAG;AAAA,IAAA,IACD,aAAa,SAAS,WAAW;AAE/B,UAAA,aAAa,IAAI,KAAK;AACtB,UAAA,aAAa,SAAS,IAAI,IAAI,OAAO,QAAQ,QAAQ,cAAc,EAAE,CAAC,CAAC;AAEvE,UAAA,CAAC,QAAQ,oBAAoB,IAAI,iBAAiB,SAAS,OAAO,QAAQ,WAAW,WACvF;AAAA,MACE,CAAC,QAAQ,MAAM,GAAG;AAAA,IAEpB,IAAA,OAAO,YAAY,QAAQ,OAAO,IAAI,CAAA,SAAQ,CAAC,KAAK,QAAQ,KAAK,KAAK,CAAC,CAAC,CAAC;AAEvE,UAAA,SAAS,SAAS,MAAM,OAAO,QAAQ,WAAW,WAAW,QAAQ,SAAS,OAAO,KAAK;AAE1F,UAAA,OAAO,IAAqB,IAAI;AAChC,UAAA,eAAe,IAAI,KAAK,KAAK;AAC7B,UAAA,OAAO,SAAS,MAAM,aAAa,QAAQ,QAAQ,UAAU,OAAO,OAAO,QAAQ,IAAI,CAAC;AAExF,UAAA,MAAM,OAAO,SAAS,YAAY;;AACtC,UAAI,YAAY;AACd;AAEF,YAAM,QAAQ,QAAM,iBAAY,UAAZ,mBAAmB;AAEvC,UAAI,CAAC;AACH;AAEF,wBAAY,UAAZ,mBAAmB;AAEnB,WAAK,QAAQ;AACb,mBAAa,QAAQ;AAAA,IAAA,CACtB;AAEK,UAAA,cAAc,aAAa,OAAO;AAExC,UAAM,UAAU;AAAA,MAAS,MAAM;;AAC7B,YAAI,EAAE,OAAO,QAAQ,sBAAsB,YAAY,CAAC,QAAQ;AAC9D,iBAAO,QAAQ;AAEjB,YAAI,CAAC,YAAY,WAAS,iBAAY,UAAZ,mBAAmB;AACpC,iBAAA;AAET,eAAO,SAAS,cAA2B,wBAAwB,OAAO,KAAK,MAAM,QAAQ,iBAAiB,GAAG,QAAQ,OAAO,eAAe,QAAQ,IAAI,OAAO,EAAE,EAAE;AAAA,MACxK;AAAA,IAAA;AAGA,UAAM,eAAe,8BAA8B;AAAA,MACjD;AAAA,MACA;AAAA,MACA;AAAA,IAAA,CACD;AAEK,UAAA,SAAS,IAAqC,cAAc;AAE5D,UAAA,CAAC,MAAM,YAAY,GAAG,OAAO,CAAC,SAAS,eAAe,GAAG,CAAC,OAAO,MAAM;;AACtE,WAAA,CAAC,WAAY,WAAW,YAAY,SAAS,OAAO,MAAO,OAAO,UAAU;AAC/E;AAEE,UAAA;AACF,gBAAM,iBAAY,UAAZ,mBAAmB,OAAO,WAAW;AAAA,IAAS,CACvD;AAED,UAAM,UAAU,MAAM;AACC;IAAA,CACtB;AAED,UAAM,uBAAuB,uBAAuB;AAAA,MAClD;AAAA,MACA;AAAA,MACA;AAAA,MACA,UAAU,eAAe;;AACnB,aAAA,uBAAY,UAAZ,mBAAmB,SAAnB,mBAAyB,2BAA2B;AACtD,wBAAc,QAAQ,kBAAiB,uBAAY,UAAZ,mBAAmB,SAAnB,mBAAyB,yBAAyB;AAEzF,kBAAQ,OAAO,MAAM,yCAAwC,iBAAY,UAAZ,mBAAmB,IAAI,EAAE;AAAA,QACxF;AAAA,MACF;AAAA,IAAA,CACD;AAEK,UAAA,iCAAiC,IAA6B,IAAI;AAClE,UAAA,sBAAsB,IAAI,KAAK;AACrC,UAAM,UAAU,MAAM;AACpB,UAAI,+BAA+B;AACjC,uCAA+B,MAAM;IAAO,CAC/C;AAED,mBAAe,UAAoC;AAC7C,UAAA,QAAQ,eAAe,CAAC,aAAa;AAChC,eAAA;AAET,aAAO,QAAQ;AAEX,UAAA,WAAW,MAAM,mBAAmB,IAAI;AAE5C,UAAI,CAAC,UAAU;AACb,mBAAW,MAAMA,UAAa;AAAA,UAC5B,MAAM;AAAA,YACJ,MAAM,KAAK;AAAA,YACX;AAAA,UACF;AAAA,UACA;AAAA,QAAA,CACD;AAAA,MACH;AAEI,UAAA;AACS,mBAAA,MAAM,aAAa,QAAQ;AAExC,WAAK,QAAQ;AAEb,UAAI,CAAC,aAAa;AAChB,qBAAa,QAAQ;AAEhB,aAAA,QAAQ,WAAW,WAAW;AAErC,UAAI,CAAC;AACU;AAER,aAAA;AAAA,IACT;AAEA,mBAAe,OAAO,YAAoD;AACxE,aAAO,QAAQ;AAEf,YAAM,eAAe;AAErB,UAAI,WAAW,cAAc,KAAK,SAAS,aAAa,SAAS,MAAM;AAE5D,iBAAA,YAAY,MAAM,kBAAkB,QAAQ;AAEvD,UAAI,CAAC,UAAU;AACb,eAAO,QAAQ;AACf,eAAO,MAAM,4BAA4B,KAAK,KAAK,EAAE;AAE9C,eAAA;AAAA,MACT;AAEI,UAAA,CAAC,QAAQ,OAAO;AACZ,cAAA,QAAQ,oCAAoC,OAAO,KAAK;AACvD,eAAA,MAAM,OAAO,OAAO;AACrB,cAAA,IAAI,MAAM,KAAK;AAAA,MACvB;AAEA,UAAI,QAAQ;AACF,gBAAA,MAAM,MAAM,WAAW;AAE7B,UAAA,QAAO,qCAAU,SAAQ,UAAU;AAC/B,cAAA,QAAQ,kCAAkC,KAAK,KAAK;AACnD,eAAA,MAAM,OAAO,OAAO;AAE3B,eAAO,QAAQ;AACT,cAAA,IAAI,MAAM,KAAK;AAAA,MACvB;AAEA,sBAAgB,UAAU,EAAE,UAA2B,QAAQ,KAAK;AAEhE,UAAA,SAAS,qBAAqB,CAAC,+BAA+B;AACjC,uCAAA,QAAQ,iBAAiB,SAAS,iBAAiB;AAEpF,0BAAoB,QAAQ;AAE5B,aAAO,MAAM,iBAAiB,KAAK,KAAK,IAAI;AAAA,QAC1C,iBAAiB;AAAA,QACjB,UAAU,QAAQ;AAAA,QAClB;AAAA,QACA;AAAA,MAAA,CACD;AAGD,WAAK,QAAQ;AAEb,aAAO,QAAQ;AAEf,kBAAY,QAAQ;AAEpB,aAAO,QAAQ;AAAA,IACjB;AAEA,aAAS,eAAqB;AAC5B,UAAI,CAAC,QAAQ;AACX;AAEF,cAAQ,MAAM,YAAY;AAClB,cAAA,MAAM,MAAM,WAAW;AACvB,cAAA,MAAM,MAAM,QAAQ;AACpB,cAAA,MAAM,MAAM,SAAS;AAE7B,WAAK,QAAQ;AACb,mBAAa,QAAQ;AAAA,IACvB;AAEA,aAAS,UAAgB;AACV;AAEb,WAAK,QAAQ;AAEA;AAEb,iBAAW,QAAQ;AAEnB,YAAM,KAAK;AAAA,IACb;AAEA,UAAM,QAAQ,SAAS;AAAA,MACrB,UAAU,QAAQ,YAAY;AAAA,MAC9B,aAAa,QAAQ,eAAe;AAAA,MACpC;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,WAAW;AAAA,MACX;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,SAAS,KAAK,SAAS,CAAC,SAAS,CAAC;AAAA,MAClC,GAAG;AAAA,IAAA,CACJ;AAEK,UAAA,OAAO,CAAC,aAAa;AACzB,kBAAY,QAAQ;AAAA,IAAA,GACnB;AAAA,MACD,MAAM;AAAA,MACN,WAAW;AAAA,IAAA,CACZ;AAEO,YAAA,MAAM,OAAO,YAAY;;AAC/B,aAAO,QAAQ;AAEL;AAEV,UAAI,QAAQ;AACV;AAEF,WAAK,QAAQ,QAAM,iBAAY,UAAZ,mBAAmB,cAAa;AAAA,IAAA,CACpD;AAEM,WAAA;AAAA,EAAA,CACR;AACH;"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@adhese/sdk",
   "type": "module",
-  "version": "0.21.1",
+  "version": "1.0.0",
   "description": "Adhese SDK",
   "license": "GPL-3.0",
   "repository": {
@@ -32,6 +32,6 @@
     "prepareRelease": "npm run build"
   },
   "dependencies": {
-    "@adhese/sdk-shared": "^0.10.0"
+    "@adhese/sdk-shared": "^1.0.0"
   }
 }

package/dist/cjs/slot/slot.utils.cjs

@@ -1,31 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-function renderIframe(ad, element) {
-  const iframe = document.createElement("iframe");
-  iframe.srcdoc = `
-      <!DOCTYPE html>
-      <html>
-        <head>
-          <style>
-            body {
-              margin: 0;
-              padding: 0;
-              overflow: hidden;
-            }
-          </style>
-        </head>
-        <body>
-          ${String(ad.tag)}
-        </body>
-      `.replaceAll(/\s+/g, " ").trim();
-  iframe.style.border = "none";
-  iframe.style.width = ad.width ? `${ad.width}px` : "auto";
-  iframe.style.height = ad.height ? `${ad.height}px` : "auto";
-  element.replaceChildren(iframe);
-}
-function renderInline(ad, element) {
-  element.innerHTML = String(ad.tag);
-}
-exports.renderIframe = renderIframe;
-exports.renderInline = renderInline;
-//# sourceMappingURL=slot.utils.cjs.map

package/dist/cjs/slot/slot.utils.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"slot.utils.cjs","sources":["../../../src/slot/slot.utils.ts"],"sourcesContent":["import type { AdheseAd } from '@adhese/sdk';\n\nexport function renderIframe(ad: AdheseAd, element: HTMLElement): void {\n  const iframe = document.createElement('iframe');\n\n  iframe.srcdoc = `\n      <!DOCTYPE html>\n      <html>\n        <head>\n          <style>\n            body {\n              margin: 0;\n              padding: 0;\n              overflow: hidden;\n            }\n          </style>\n        </head>\n        <body>\n          ${String(ad.tag)}\n        </body>\n      `.replaceAll(/\\s+/g, ' ').trim();\n\n  iframe.style.border = 'none';\n  iframe.style.width = ad.width ? `${ad.width}px` : 'auto';\n  iframe.style.height = ad.height ? `${ad.height}px` : 'auto';\n  element.replaceChildren(iframe);\n}\n\nexport function renderInline(ad: AdheseAd, element: HTMLElement): void {\n  element.innerHTML = String(ad.tag);\n}\n"],"names":[],"mappings":";;AAEgB,SAAA,aAAa,IAAc,SAA4B;AAC/D,QAAA,SAAS,SAAS,cAAc,QAAQ;AAE9C,SAAO,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,YAaN,OAAO,GAAG,GAAG,CAAC;AAAA;AAAA,QAElB,WAAW,QAAQ,GAAG,EAAE,KAAK;AAEnC,SAAO,MAAM,SAAS;AACtB,SAAO,MAAM,QAAQ,GAAG,QAAQ,GAAG,GAAG,KAAK,OAAO;AAClD,SAAO,MAAM,SAAS,GAAG,SAAS,GAAG,GAAG,MAAM,OAAO;AACrD,UAAQ,gBAAgB,MAAM;AAChC;AAEgB,SAAA,aAAa,IAAc,SAA4B;AAC7D,UAAA,YAAY,OAAO,GAAG,GAAG;AACnC;;;"}

package/dist/slot/slot.utils.js

@@ -1,31 +0,0 @@
-function renderIframe(ad, element) {
-  const iframe = document.createElement("iframe");
-  iframe.srcdoc = `
-      <!DOCTYPE html>
-      <html>
-        <head>
-          <style>
-            body {
-              margin: 0;
-              padding: 0;
-              overflow: hidden;
-            }
-          </style>
-        </head>
-        <body>
-          ${String(ad.tag)}
-        </body>
-      `.replaceAll(/\s+/g, " ").trim();
-  iframe.style.border = "none";
-  iframe.style.width = ad.width ? `${ad.width}px` : "auto";
-  iframe.style.height = ad.height ? `${ad.height}px` : "auto";
-  element.replaceChildren(iframe);
-}
-function renderInline(ad, element) {
-  element.innerHTML = String(ad.tag);
-}
-export {
-  renderIframe,
-  renderInline
-};
-//# sourceMappingURL=slot.utils.js.map

package/dist/slot/slot.utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"slot.utils.js","sources":["../../src/slot/slot.utils.ts"],"sourcesContent":["import type { AdheseAd } from '@adhese/sdk';\n\nexport function renderIframe(ad: AdheseAd, element: HTMLElement): void {\n  const iframe = document.createElement('iframe');\n\n  iframe.srcdoc = `\n      <!DOCTYPE html>\n      <html>\n        <head>\n          <style>\n            body {\n              margin: 0;\n              padding: 0;\n              overflow: hidden;\n            }\n          </style>\n        </head>\n        <body>\n          ${String(ad.tag)}\n        </body>\n      `.replaceAll(/\\s+/g, ' ').trim();\n\n  iframe.style.border = 'none';\n  iframe.style.width = ad.width ? `${ad.width}px` : 'auto';\n  iframe.style.height = ad.height ? `${ad.height}px` : 'auto';\n  element.replaceChildren(iframe);\n}\n\nexport function renderInline(ad: AdheseAd, element: HTMLElement): void {\n  element.innerHTML = String(ad.tag);\n}\n"],"names":[],"mappings":"AAEgB,SAAA,aAAa,IAAc,SAA4B;AAC/D,QAAA,SAAS,SAAS,cAAc,QAAQ;AAE9C,SAAO,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,YAaN,OAAO,GAAG,GAAG,CAAC;AAAA;AAAA,QAElB,WAAW,QAAQ,GAAG,EAAE,KAAK;AAEnC,SAAO,MAAM,SAAS;AACtB,SAAO,MAAM,QAAQ,GAAG,QAAQ,GAAG,GAAG,KAAK,OAAO;AAClD,SAAO,MAAM,SAAS,GAAG,SAAS,GAAG,GAAG,MAAM,OAAO;AACrD,UAAQ,gBAAgB,MAAM;AAChC;AAEgB,SAAA,aAAa,IAAc,SAA4B;AAC7D,UAAA,YAAY,OAAO,GAAG,GAAG;AACnC;"}