@folklore/ads 0.0.35 → 0.0.37

package/dist/cjs.js

@@ -11,8 +11,8 @@ var isArray = require('lodash/isArray');
 var sortBy = require('lodash/sortBy');
 var uniqBy = require('lodash/uniqBy');
 var debounce = require('lodash/debounce');
-var EventEmitter = require('wolfy87-eventemitter');
 var createDebug = require('debug');
+var EventEmitter = require('wolfy87-eventemitter');
 var jsxRuntime = require('react/jsx-runtime');
 var hooks = require('@folklore/hooks');
 var tracking = require('@folklore/tracking');
@@ -28,8 +28,8 @@ var isArray__default = /*#__PURE__*/_interopDefaultLegacy(isArray);
 var sortBy__default = /*#__PURE__*/_interopDefaultLegacy(sortBy);
 var uniqBy__default = /*#__PURE__*/_interopDefaultLegacy(uniqBy);
 var debounce__default = /*#__PURE__*/_interopDefaultLegacy(debounce);
-var EventEmitter__default = /*#__PURE__*/_interopDefaultLegacy(EventEmitter);
 var createDebug__default = /*#__PURE__*/_interopDefaultLegacy(createDebug);
+var EventEmitter__default = /*#__PURE__*/_interopDefaultLegacy(EventEmitter);
 
 const adPath = PropTypes__default["default"].string;
 const adSize = PropTypes__default["default"].oneOfType([PropTypes__default["default"].arrayOf(PropTypes__default["default"].number), PropTypes__default["default"].arrayOf(PropTypes__default["default"].string), PropTypes__default["default"].string, PropTypes__default["default"].arrayOf(PropTypes__default["default"].oneOfType([PropTypes__default["default"].arrayOf(PropTypes__default["default"].number), PropTypes__default["default"].arrayOf(PropTypes__default["default"].string), PropTypes__default["default"].string]))]);
@@ -321,7 +321,9 @@ class AdsManager extends EventEmitter__default["default"] {
     this.options = {
       disabled: false,
       disablePersonnalizedAds: false,
-      enableSingleRequest: false,
+      disableSingleRequest: false,
+      disableLazyLoad: false,
+      disableVideoAds: false,
       autoInit: false,
       ...opts
     };
@@ -352,30 +354,39 @@ class AdsManager extends EventEmitter__default["default"] {
         personnalizedAdsDisabled
       } = this;
       const {
-        enableSingleRequest
+        disableSingleRequest = false,
+        disableLazyLoad = false,
+        disableVideoAds = false,
+        mobileScaling = 1.0,
+        renderMarginPercent = 100,
+        fetchMarginPercent = 300
       } = this.options;
       if (disabled) {
         debug('Disable initial load');
         googletag.pubads().disableInitialLoad();
       }
-      if (enableSingleRequest) {
+      if (!disableSingleRequest) {
         debug('Enable single request');
-        googletag.pubads().enableSingleRequest();
+        googletag.pubads().disableSingleRequest();
       }
       if (personnalizedAdsDisabled) {
         debug('Disable personalized ads');
         googletag.pubads().setRequestNonPersonalizedAds(1);
       }
-      googletag.pubads().enableLazyLoad({
-        // Fetch slots within 5 viewports.
-        fetchMarginPercent: 300,
-        // Render slots within 2 viewports.
-        renderMarginPercent: 100,
-        // Double the above values on mobile, where viewports are smaller
-        // and users tend to scroll faster.
-        mobileScaling: 1.0
-      });
-      googletag.pubads().enableVideoAds();
+      if (!disableLazyLoad) {
+        googletag.pubads().enableLazyLoad({
+          // Fetch slots within 5 viewports.
+          fetchMarginPercent,
+          // Render slots within 2 viewports.
+          renderMarginPercent,
+          // Double the above values on mobile, where viewports are smaller
+          // and users tend to scroll faster.
+          mobileScaling
+        });
+      }
+      if (!disableVideoAds) {
+        googletag.pubads().enableVideoAds();
+      }
       googletag.pubads().addEventListener('slotRenderEnded', this.onSlotRenderEnded);
       googletag.pubads().addEventListener('impressionViewable', this.onSlotImpressionViewable);
       googletag.enableServices();
@@ -634,55 +645,75 @@ const propTypes$2 = {
   children: PropTypes__default["default"].node.isRequired,
   defaultSlotPath: PropTypes__default["default"].string,
   slotsPath: PropTypes__default["default"].objectOf(PropTypes__default["default"].string),
-  enableSingleRequest: PropTypes__default["default"].bool,
+  disableSingleRequest: PropTypes__default["default"].bool,
+  disableVideoAds: PropTypes__default["default"].bool,
+  disableLazyLoad: PropTypes__default["default"].bool,
   autoInit: PropTypes__default["default"].bool,
   resizeDebounceDelay: PropTypes__default["default"].number,
   refreshOnResize: PropTypes__default["default"].bool,
+  mobileScaling: PropTypes__default["default"].number,
+  renderMarginPercent: PropTypes__default["default"].number,
+  fetchMarginPercent: PropTypes__default["default"].number,
   slots: adSlots,
   viewports: adViewports,
   disabled: PropTypes__default["default"].bool,
-  trackingDisabled: PropTypes__default["default"].bool
+  disableTracking: PropTypes__default["default"].bool
 };
 const defaultProps$2 = {
   defaultSlotPath: null,
   slotsPath: null,
-  enableSingleRequest: true,
+  disableSingleRequest: false,
+  disableVideoAds: false,
+  disableLazyLoad: false,
   autoInit: true,
   resizeDebounceDelay: 500,
   refreshOnResize: false,
+  mobileScaling: 1.0,
+  renderMarginPercent: 100,
+  fetchMarginPercent: 300,
   slots: slots,
   viewports: viewports,
   disabled: false,
-  trackingDisabled: false
+  disableTracking: false
 };
 function AdsProvider(_ref) {
   let {
     children,
     defaultSlotPath,
     slotsPath,
-    enableSingleRequest,
+    disableSingleRequest,
+    disableVideoAds,
+    disableLazyLoad,
     autoInit,
     resizeDebounceDelay,
     refreshOnResize,
+    mobileScaling,
+    renderMarginPercent,
+    fetchMarginPercent,
     viewports,
     slots,
     disabled,
-    trackingDisabled
+    disableTracking
   } = _ref;
   const [ready, setReady] = React.useState(false);
   const adsRef = React.useRef(null);
   const ads = React.useMemo(() => {
     if (adsRef.current === null) {
       adsRef.current = new AdsManager({
-        enableSingleRequest,
         autoInit,
-        disabled
+        disabled,
+        disableSingleRequest,
+        disableVideoAds,
+        disableLazyLoad,
+        mobileScaling,
+        renderMarginPercent,
+        fetchMarginPercent
       });
     } else {
       adsRef.current.setDisabled(disabled);
     }
     return adsRef.current;
-  }, [enableSingleRequest, autoInit, disabled]);
+  }, [autoInit, disabled, disableSingleRequest, disableVideoAds, disableLazyLoad, mobileScaling, renderMarginPercent, fetchMarginPercent]);
   React.useEffect(() => {
     let onReady = null;
     if (!ads.isReady()) {
@@ -731,8 +762,8 @@ function AdsProvider(_ref) {
     } : {
       ...slotsPath
     },
-    trackingDisabled
-  }), [ready, ads, viewports, slots, slotsPath, defaultSlotPath, trackingDisabled, disabled]);
+    trackingDisabled: disableTracking
+  }), [ready, ads, viewports, slots, slotsPath, defaultSlotPath, disableTracking, disabled]);
   return /*#__PURE__*/jsxRuntime.jsx(AdsContext.Provider, {
     value: value,
     children: children
@@ -793,7 +824,7 @@ function useAd(path, size) {
     alwaysRender = false,
     onRender = null,
     disabled = false,
-    trackingDisabled = false,
+    disableTracking = false,
     rootMargin = '300px'
   } = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
   const {
@@ -803,10 +834,10 @@ function useAd(path, size) {
   } = useAdsContext();
   const trackAd = useAdsTracking();
   const track = React.useCallback(function () {
-    if (!trackingDisabled && !globalTrackingDisabled) {
+    if (!disableTracking && !globalTrackingDisabled) {
       trackAd(...arguments);
     }
-  }, [trackingDisabled, globalTrackingDisabled, trackAd]);
+  }, [disableTracking, globalTrackingDisabled, trackAd]);
 
   // Check for visibility
   const {
@@ -945,7 +976,7 @@ const propTypes = {
   refreshInterval: PropTypes__default["default"].number,
   alwaysRender: PropTypes__default["default"].bool,
   disabled: PropTypes__default["default"].bool,
-  trackingDisabled: PropTypes__default["default"].bool,
+  disableTracking: PropTypes__default["default"].bool,
   shouldKeepSize: PropTypes__default["default"].bool,
   withoutStyle: PropTypes__default["default"].bool,
   withoutMinimumSize: PropTypes__default["default"].bool,
@@ -963,7 +994,7 @@ const defaultProps = {
   refreshInterval: null,
   alwaysRender: true,
   disabled: false,
-  trackingDisabled: false,
+  disableTracking: false,
   shouldKeepSize: false,
   withoutStyle: false,
   withoutMinimumSize: false,
@@ -983,7 +1014,7 @@ function Ad(_ref) {
     refreshInterval,
     alwaysRender,
     disabled,
-    trackingDisabled,
+    disableTracking,
     shouldKeepSize,
     withoutStyle,
     withoutMinimumSize,
@@ -1085,7 +1116,7 @@ function Ad(_ref) {
     alwaysRender,
     onRender: onAdRender,
     disabled: finalDisabled,
-    trackingDisabled
+    disableTracking
   });
   if (slotRef !== null && isFunction__default["default"](slotRef)) {
     slotRef(slotObject);

package/dist/es.js

@@ -7,8 +7,8 @@ import isArray from 'lodash/isArray';
 import sortBy from 'lodash/sortBy';
 import uniqBy from 'lodash/uniqBy';
 import debounce from 'lodash/debounce';
-import EventEmitter from 'wolfy87-eventemitter';
 import createDebug from 'debug';
+import EventEmitter from 'wolfy87-eventemitter';
 import { jsx } from 'react/jsx-runtime';
 import { useIntersectionObserver, useWindowEvent } from '@folklore/hooks';
 import { useTracking } from '@folklore/tracking';
@@ -303,7 +303,9 @@ class AdsManager extends EventEmitter {
     this.options = {
       disabled: false,
       disablePersonnalizedAds: false,
-      enableSingleRequest: false,
+      disableSingleRequest: false,
+      disableLazyLoad: false,
+      disableVideoAds: false,
       autoInit: false,
       ...opts
     };
@@ -334,30 +336,39 @@ class AdsManager extends EventEmitter {
         personnalizedAdsDisabled
       } = this;
       const {
-        enableSingleRequest
+        disableSingleRequest = false,
+        disableLazyLoad = false,
+        disableVideoAds = false,
+        mobileScaling = 1.0,
+        renderMarginPercent = 100,
+        fetchMarginPercent = 300
       } = this.options;
       if (disabled) {
         debug('Disable initial load');
         googletag.pubads().disableInitialLoad();
       }
-      if (enableSingleRequest) {
+      if (!disableSingleRequest) {
         debug('Enable single request');
-        googletag.pubads().enableSingleRequest();
+        googletag.pubads().disableSingleRequest();
       }
       if (personnalizedAdsDisabled) {
         debug('Disable personalized ads');
         googletag.pubads().setRequestNonPersonalizedAds(1);
       }
-      googletag.pubads().enableLazyLoad({
-        // Fetch slots within 5 viewports.
-        fetchMarginPercent: 300,
-        // Render slots within 2 viewports.
-        renderMarginPercent: 100,
-        // Double the above values on mobile, where viewports are smaller
-        // and users tend to scroll faster.
-        mobileScaling: 1.0
-      });
-      googletag.pubads().enableVideoAds();
+      if (!disableLazyLoad) {
+        googletag.pubads().enableLazyLoad({
+          // Fetch slots within 5 viewports.
+          fetchMarginPercent,
+          // Render slots within 2 viewports.
+          renderMarginPercent,
+          // Double the above values on mobile, where viewports are smaller
+          // and users tend to scroll faster.
+          mobileScaling
+        });
+      }
+      if (!disableVideoAds) {
+        googletag.pubads().enableVideoAds();
+      }
       googletag.pubads().addEventListener('slotRenderEnded', this.onSlotRenderEnded);
       googletag.pubads().addEventListener('impressionViewable', this.onSlotImpressionViewable);
       googletag.enableServices();
@@ -616,55 +627,75 @@ const propTypes$2 = {
   children: PropTypes.node.isRequired,
   defaultSlotPath: PropTypes.string,
   slotsPath: PropTypes.objectOf(PropTypes.string),
-  enableSingleRequest: PropTypes.bool,
+  disableSingleRequest: PropTypes.bool,
+  disableVideoAds: PropTypes.bool,
+  disableLazyLoad: PropTypes.bool,
   autoInit: PropTypes.bool,
   resizeDebounceDelay: PropTypes.number,
   refreshOnResize: PropTypes.bool,
+  mobileScaling: PropTypes.number,
+  renderMarginPercent: PropTypes.number,
+  fetchMarginPercent: PropTypes.number,
   slots: adSlots,
   viewports: adViewports,
   disabled: PropTypes.bool,
-  trackingDisabled: PropTypes.bool
+  disableTracking: PropTypes.bool
 };
 const defaultProps$2 = {
   defaultSlotPath: null,
   slotsPath: null,
-  enableSingleRequest: true,
+  disableSingleRequest: false,
+  disableVideoAds: false,
+  disableLazyLoad: false,
   autoInit: true,
   resizeDebounceDelay: 500,
   refreshOnResize: false,
+  mobileScaling: 1.0,
+  renderMarginPercent: 100,
+  fetchMarginPercent: 300,
   slots: slots,
   viewports: viewports,
   disabled: false,
-  trackingDisabled: false
+  disableTracking: false
 };
 function AdsProvider(_ref) {
   let {
     children,
     defaultSlotPath,
     slotsPath,
-    enableSingleRequest,
+    disableSingleRequest,
+    disableVideoAds,
+    disableLazyLoad,
     autoInit,
     resizeDebounceDelay,
     refreshOnResize,
+    mobileScaling,
+    renderMarginPercent,
+    fetchMarginPercent,
     viewports,
     slots,
     disabled,
-    trackingDisabled
+    disableTracking
   } = _ref;
   const [ready, setReady] = useState(false);
   const adsRef = useRef(null);
   const ads = useMemo(() => {
     if (adsRef.current === null) {
       adsRef.current = new AdsManager({
-        enableSingleRequest,
         autoInit,
-        disabled
+        disabled,
+        disableSingleRequest,
+        disableVideoAds,
+        disableLazyLoad,
+        mobileScaling,
+        renderMarginPercent,
+        fetchMarginPercent
       });
     } else {
       adsRef.current.setDisabled(disabled);
     }
     return adsRef.current;
-  }, [enableSingleRequest, autoInit, disabled]);
+  }, [autoInit, disabled, disableSingleRequest, disableVideoAds, disableLazyLoad, mobileScaling, renderMarginPercent, fetchMarginPercent]);
   useEffect(() => {
     let onReady = null;
     if (!ads.isReady()) {
@@ -713,8 +744,8 @@ function AdsProvider(_ref) {
     } : {
       ...slotsPath
     },
-    trackingDisabled
-  }), [ready, ads, viewports, slots, slotsPath, defaultSlotPath, trackingDisabled, disabled]);
+    trackingDisabled: disableTracking
+  }), [ready, ads, viewports, slots, slotsPath, defaultSlotPath, disableTracking, disabled]);
   return /*#__PURE__*/jsx(AdsContext.Provider, {
     value: value,
     children: children
@@ -775,7 +806,7 @@ function useAd(path, size) {
     alwaysRender = false,
     onRender = null,
     disabled = false,
-    trackingDisabled = false,
+    disableTracking = false,
     rootMargin = '300px'
   } = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
   const {
@@ -785,10 +816,10 @@ function useAd(path, size) {
   } = useAdsContext();
   const trackAd = useAdsTracking();
   const track = useCallback(function () {
-    if (!trackingDisabled && !globalTrackingDisabled) {
+    if (!disableTracking && !globalTrackingDisabled) {
       trackAd(...arguments);
     }
-  }, [trackingDisabled, globalTrackingDisabled, trackAd]);
+  }, [disableTracking, globalTrackingDisabled, trackAd]);
 
   // Check for visibility
   const {
@@ -927,7 +958,7 @@ const propTypes = {
   refreshInterval: PropTypes.number,
   alwaysRender: PropTypes.bool,
   disabled: PropTypes.bool,
-  trackingDisabled: PropTypes.bool,
+  disableTracking: PropTypes.bool,
   shouldKeepSize: PropTypes.bool,
   withoutStyle: PropTypes.bool,
   withoutMinimumSize: PropTypes.bool,
@@ -945,7 +976,7 @@ const defaultProps = {
   refreshInterval: null,
   alwaysRender: true,
   disabled: false,
-  trackingDisabled: false,
+  disableTracking: false,
   shouldKeepSize: false,
   withoutStyle: false,
   withoutMinimumSize: false,
@@ -965,7 +996,7 @@ function Ad(_ref) {
     refreshInterval,
     alwaysRender,
     disabled,
-    trackingDisabled,
+    disableTracking,
     shouldKeepSize,
     withoutStyle,
     withoutMinimumSize,
@@ -1067,7 +1098,7 @@ function Ad(_ref) {
     alwaysRender,
     onRender: onAdRender,
     disabled: finalDisabled,
-    trackingDisabled
+    disableTracking
   });
   if (slotRef !== null && isFunction(slotRef)) {
     slotRef(slotObject);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@folklore/ads",
-    "version": "0.0.35",
+    "version": "0.0.37",
     "description": "Ads library",
     "keywords": [
         "javascript",
@@ -50,7 +50,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "gitHead": "157dafbef47cbe22779e58c62da89a0c46c06bc8",
+    "gitHead": "eb4be4e6692164f0fb4a7fc881cdac855698a2e7",
     "dependencies": {
         "@folklore/hooks": "^0.0.44",
         "@folklore/tracking": "^0.0.23",