@empathyco/x-adapter 7.0.0-alpha.10 → 7.0.0-alpha.13

package/dist/cjs/empathy/requestors/beacon-tracking.requestor.js

@@ -10,13 +10,25 @@ var inversify_1 = require("inversify");
  */
 var BeaconTrackingRequestor = /** @class */ (function () {
     function BeaconTrackingRequestor() {
+        var _this = this;
+        this.isAdblockPresent = false;
+        this.detectAdblock()
+            .then(function () {
+            _this.isAdblockPresent = false;
+        })
+            .catch(function () {
+            _this.isAdblockPresent = true;
+        });
     }
     BeaconTrackingRequestor.prototype.request = function (trackingRequest) {
         var url = this.buildUrl(trackingRequest);
-        if (navigator.sendBeacon(url)) {
+        if (!this.isAdblockPresent && navigator.sendBeacon(url)) {
             return Promise.resolve();
         }
         else {
+            if (this.isAdblockPresent) {
+                return fetch(url);
+            }
             return Promise.reject('Beacon not queued');
         }
     };
@@ -28,8 +40,19 @@ var BeaconTrackingRequestor = /** @class */ (function () {
         });
         return url.href;
     };
+    BeaconTrackingRequestor.prototype.detectAdblock = function () {
+        var flaggedURL = 'https://google.com/pagead/js/adsbygoogle.js';
+        if (!('fetch' in window)) {
+            return Promise.resolve();
+        }
+        return fetch(new Request(flaggedURL, {
+            method: 'HEAD',
+            mode: 'no-cors'
+        }));
+    };
     BeaconTrackingRequestor = tslib_1.__decorate([
-        inversify_1.injectable()
+        inversify_1.injectable(),
+        tslib_1.__metadata("design:paramtypes", [])
     ], BeaconTrackingRequestor);
     return BeaconTrackingRequestor;
 }());

package/dist/cjs/empathy/requestors/beacon-tracking.requestor.js.map

@@ -1 +1 @@
-{"version":3,"file":"beacon-tracking.requestor.js","sourceRoot":"","sources":["../../../../src/empathy/requestors/beacon-tracking.requestor.ts"],"names":[],"mappings":";;;;AAAA,uCAAuC;AAIvC;;;;GAIG;AAEH;IAAA;IAiBA,CAAC;IAfC,yCAAO,GAAP,UAAQ,eAAgC;QACtC,IAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;QAE3C,IAAI,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YAC7B,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;SAC1B;aAAM;YACL,OAAO,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;SAC5C;IACH,CAAC;IAEO,0CAAQ,GAAhB,UAAiB,eAAgC;QAC/C,IAAM,GAAG,GAAG,IAAI,GAAG,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;QACzC,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,UAAC,EAAY;gBAAX,GAAG,QAAA,EAAE,KAAK,QAAA;YAAM,OAAA,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC;QAAnC,CAAmC,CAAC,CAAC;QACtG,OAAO,GAAG,CAAC,IAAI,CAAC;IAClB,CAAC;IAhBU,uBAAuB;QADnC,sBAAU,EAAE;OACA,uBAAuB,CAiBnC;IAAD,8BAAC;CAAA,AAjBD,IAiBC;AAjBY,0DAAuB","sourcesContent":["import { injectable } from 'inversify';\nimport { TrackingRequest } from '../../types';\nimport { Requestor } from '../empathy-adapter.types';\n\n/**\n * TODO https://searchbroker.atlassian.net/browse/EX-2163\n *\n * @public\n */\n@injectable()\nexport class BeaconTrackingRequestor implements Requestor<TrackingRequest, void> {\n\n  request(trackingRequest: TrackingRequest): Promise<void> {\n    const url = this.buildUrl(trackingRequest);\n\n    if (navigator.sendBeacon(url)) {\n      return Promise.resolve();\n    } else {\n      return Promise.reject('Beacon not queued');\n    }\n  }\n\n  private buildUrl(trackingRequest: TrackingRequest): string {\n    const url = new URL(trackingRequest.url);\n    Object.entries(trackingRequest.params).forEach(([key, value]) => url.searchParams.append(key, value));\n    return url.href;\n  }\n}\n"]}
+{"version":3,"file":"beacon-tracking.requestor.js","sourceRoot":"","sources":["../../../../src/empathy/requestors/beacon-tracking.requestor.ts"],"names":[],"mappings":";;;;AAAA,uCAAuC;AAIvC;;;;GAIG;AAEH;IAGE;QAAA,iBAQC;QAVO,qBAAgB,GAAG,KAAK,CAAC;QAG/B,IAAI,CAAC,aAAa,EAAE;aACjB,IAAI,CAAC;YACJ,KAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC;QAChC,CAAC,CAAC;aACD,KAAK,CAAC;YACL,KAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAC/B,CAAC,CAAC,CAAC;IACP,CAAC;IAED,yCAAO,GAAP,UAAQ,eAAgC;QACtC,IAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;QAE3C,IAAI,CAAC,IAAI,CAAC,gBAAgB,IAAI,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YACvD,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;SAC1B;aAAM;YACL,IAAI,IAAI,CAAC,gBAAgB,EAAE;gBACzB,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC;aACnB;YACD,OAAO,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;SAC5C;IACH,CAAC;IAEO,0CAAQ,GAAhB,UAAiB,eAAgC;QAC/C,IAAM,GAAG,GAAG,IAAI,GAAG,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;QACzC,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,UAAC,EAAY;gBAAX,GAAG,QAAA,EAAE,KAAK,QAAA;YACzD,OAAA,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC;QAAnC,CAAmC,CACpC,CAAC;QACF,OAAO,GAAG,CAAC,IAAI,CAAC;IAClB,CAAC;IAEO,+CAAa,GAArB;QACE,IAAM,UAAU,GAAG,6CAA6C,CAAC;QAEjE,IAAI,CAAC,CAAC,OAAO,IAAI,MAAM,CAAC,EAAE;YACxB,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;SAC1B;QAED,OAAO,KAAK,CACV,IAAI,OAAO,CAAC,UAAU,EAAE;YACtB,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,SAAS;SAChB,CAAC,CACH,CAAC;IACJ,CAAC;IA/CU,uBAAuB;QADnC,sBAAU,EAAE;;OACA,uBAAuB,CAgDnC;IAAD,8BAAC;CAAA,AAhDD,IAgDC;AAhDY,0DAAuB","sourcesContent":["import { injectable } from 'inversify';\nimport { TrackingRequest } from '../../types';\nimport { Requestor } from '../empathy-adapter.types';\n\n/**\n * TODO https://searchbroker.atlassian.net/browse/EX-2163\n *\n * @public\n */\n@injectable()\nexport class BeaconTrackingRequestor implements Requestor<TrackingRequest, Response | void> {\n  private isAdblockPresent = false;\n\n  constructor() {\n    this.detectAdblock()\n      .then(() => {\n        this.isAdblockPresent = false;\n      })\n      .catch(() => {\n        this.isAdblockPresent = true;\n      });\n  }\n\n  request(trackingRequest: TrackingRequest): Promise<Response | void> {\n    const url = this.buildUrl(trackingRequest);\n\n    if (!this.isAdblockPresent && navigator.sendBeacon(url)) {\n      return Promise.resolve();\n    } else {\n      if (this.isAdblockPresent) {\n        return fetch(url);\n      }\n      return Promise.reject('Beacon not queued');\n    }\n  }\n\n  private buildUrl(trackingRequest: TrackingRequest): string {\n    const url = new URL(trackingRequest.url);\n    Object.entries(trackingRequest.params).forEach(([key, value]) =>\n      url.searchParams.append(key, value)\n    );\n    return url.href;\n  }\n\n  private detectAdblock(): Promise<Response | void> {\n    const flaggedURL = 'https://google.com/pagead/js/adsbygoogle.js';\n\n    if (!('fetch' in window)) {\n      return Promise.resolve();\n    }\n\n    return fetch(\n      new Request(flaggedURL, {\n        method: 'HEAD',\n        mode: 'no-cors'\n      })\n    );\n  }\n}\n"]}

package/dist/esm/empathy/requestors/beacon-tracking.requestor.js

@@ -1,4 +1,4 @@
-import { __decorate } from "tslib";
+import { __decorate, __metadata } from "tslib";
 import { injectable } from 'inversify';
 /**
  * TODO https://searchbroker.atlassian.net/browse/EX-2163
@@ -7,13 +7,25 @@ import { injectable } from 'inversify';
  */
 var BeaconTrackingRequestor = /** @class */ (function () {
     function BeaconTrackingRequestor() {
+        var _this = this;
+        this.isAdblockPresent = false;
+        this.detectAdblock()
+            .then(function () {
+            _this.isAdblockPresent = false;
+        })
+            .catch(function () {
+            _this.isAdblockPresent = true;
+        });
     }
     BeaconTrackingRequestor.prototype.request = function (trackingRequest) {
         var url = this.buildUrl(trackingRequest);
-        if (navigator.sendBeacon(url)) {
+        if (!this.isAdblockPresent && navigator.sendBeacon(url)) {
             return Promise.resolve();
         }
         else {
+            if (this.isAdblockPresent) {
+                return fetch(url);
+            }
             return Promise.reject('Beacon not queued');
         }
     };
@@ -25,8 +37,19 @@ var BeaconTrackingRequestor = /** @class */ (function () {
         });
         return url.href;
     };
+    BeaconTrackingRequestor.prototype.detectAdblock = function () {
+        var flaggedURL = 'https://google.com/pagead/js/adsbygoogle.js';
+        if (!('fetch' in window)) {
+            return Promise.resolve();
+        }
+        return fetch(new Request(flaggedURL, {
+            method: 'HEAD',
+            mode: 'no-cors'
+        }));
+    };
     BeaconTrackingRequestor = __decorate([
-        injectable()
+        injectable(),
+        __metadata("design:paramtypes", [])
     ], BeaconTrackingRequestor);
     return BeaconTrackingRequestor;
 }());

package/dist/esm/empathy/requestors/beacon-tracking.requestor.js.map

@@ -1 +1 @@
-{"version":3,"file":"beacon-tracking.requestor.js","sourceRoot":"","sources":["../../../../src/empathy/requestors/beacon-tracking.requestor.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAIvC;;;;GAIG;AAEH;IAAA;IAiBA,CAAC;IAfC,yCAAO,GAAP,UAAQ,eAAgC;QACtC,IAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;QAE3C,IAAI,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YAC7B,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;SAC1B;aAAM;YACL,OAAO,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;SAC5C;IACH,CAAC;IAEO,0CAAQ,GAAhB,UAAiB,eAAgC;QAC/C,IAAM,GAAG,GAAG,IAAI,GAAG,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;QACzC,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,UAAC,EAAY;gBAAX,GAAG,QAAA,EAAE,KAAK,QAAA;YAAM,OAAA,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC;QAAnC,CAAmC,CAAC,CAAC;QACtG,OAAO,GAAG,CAAC,IAAI,CAAC;IAClB,CAAC;IAhBU,uBAAuB;QADnC,UAAU,EAAE;OACA,uBAAuB,CAiBnC;IAAD,8BAAC;CAAA,AAjBD,IAiBC;SAjBY,uBAAuB","sourcesContent":["import { injectable } from 'inversify';\nimport { TrackingRequest } from '../../types';\nimport { Requestor } from '../empathy-adapter.types';\n\n/**\n * TODO https://searchbroker.atlassian.net/browse/EX-2163\n *\n * @public\n */\n@injectable()\nexport class BeaconTrackingRequestor implements Requestor<TrackingRequest, void> {\n\n  request(trackingRequest: TrackingRequest): Promise<void> {\n    const url = this.buildUrl(trackingRequest);\n\n    if (navigator.sendBeacon(url)) {\n      return Promise.resolve();\n    } else {\n      return Promise.reject('Beacon not queued');\n    }\n  }\n\n  private buildUrl(trackingRequest: TrackingRequest): string {\n    const url = new URL(trackingRequest.url);\n    Object.entries(trackingRequest.params).forEach(([key, value]) => url.searchParams.append(key, value));\n    return url.href;\n  }\n}\n"]}
+{"version":3,"file":"beacon-tracking.requestor.js","sourceRoot":"","sources":["../../../../src/empathy/requestors/beacon-tracking.requestor.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAIvC;;;;GAIG;AAEH;IAGE;QAAA,iBAQC;QAVO,qBAAgB,GAAG,KAAK,CAAC;QAG/B,IAAI,CAAC,aAAa,EAAE;aACjB,IAAI,CAAC;YACJ,KAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC;QAChC,CAAC,CAAC;aACD,KAAK,CAAC;YACL,KAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAC/B,CAAC,CAAC,CAAC;IACP,CAAC;IAED,yCAAO,GAAP,UAAQ,eAAgC;QACtC,IAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;QAE3C,IAAI,CAAC,IAAI,CAAC,gBAAgB,IAAI,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YACvD,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;SAC1B;aAAM;YACL,IAAI,IAAI,CAAC,gBAAgB,EAAE;gBACzB,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC;aACnB;YACD,OAAO,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;SAC5C;IACH,CAAC;IAEO,0CAAQ,GAAhB,UAAiB,eAAgC;QAC/C,IAAM,GAAG,GAAG,IAAI,GAAG,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;QACzC,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,UAAC,EAAY;gBAAX,GAAG,QAAA,EAAE,KAAK,QAAA;YACzD,OAAA,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC;QAAnC,CAAmC,CACpC,CAAC;QACF,OAAO,GAAG,CAAC,IAAI,CAAC;IAClB,CAAC;IAEO,+CAAa,GAArB;QACE,IAAM,UAAU,GAAG,6CAA6C,CAAC;QAEjE,IAAI,CAAC,CAAC,OAAO,IAAI,MAAM,CAAC,EAAE;YACxB,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;SAC1B;QAED,OAAO,KAAK,CACV,IAAI,OAAO,CAAC,UAAU,EAAE;YACtB,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,SAAS;SAChB,CAAC,CACH,CAAC;IACJ,CAAC;IA/CU,uBAAuB;QADnC,UAAU,EAAE;;OACA,uBAAuB,CAgDnC;IAAD,8BAAC;CAAA,AAhDD,IAgDC;SAhDY,uBAAuB","sourcesContent":["import { injectable } from 'inversify';\nimport { TrackingRequest } from '../../types';\nimport { Requestor } from '../empathy-adapter.types';\n\n/**\n * TODO https://searchbroker.atlassian.net/browse/EX-2163\n *\n * @public\n */\n@injectable()\nexport class BeaconTrackingRequestor implements Requestor<TrackingRequest, Response | void> {\n  private isAdblockPresent = false;\n\n  constructor() {\n    this.detectAdblock()\n      .then(() => {\n        this.isAdblockPresent = false;\n      })\n      .catch(() => {\n        this.isAdblockPresent = true;\n      });\n  }\n\n  request(trackingRequest: TrackingRequest): Promise<Response | void> {\n    const url = this.buildUrl(trackingRequest);\n\n    if (!this.isAdblockPresent && navigator.sendBeacon(url)) {\n      return Promise.resolve();\n    } else {\n      if (this.isAdblockPresent) {\n        return fetch(url);\n      }\n      return Promise.reject('Beacon not queued');\n    }\n  }\n\n  private buildUrl(trackingRequest: TrackingRequest): string {\n    const url = new URL(trackingRequest.url);\n    Object.entries(trackingRequest.params).forEach(([key, value]) =>\n      url.searchParams.append(key, value)\n    );\n    return url.href;\n  }\n\n  private detectAdblock(): Promise<Response | void> {\n    const flaggedURL = 'https://google.com/pagead/js/adsbygoogle.js';\n\n    if (!('fetch' in window)) {\n      return Promise.resolve();\n    }\n\n    return fetch(\n      new Request(flaggedURL, {\n        method: 'HEAD',\n        mode: 'no-cors'\n      })\n    );\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empathyco/x-adapter",
-  "version": "7.0.0-alpha.10",
+  "version": "7.0.0-alpha.13",
   "description": "A search client for the Empathy search API ",
   "author": "Empathy Systems Corporation S.L.",
   "license": "Apache-2.0",
@@ -40,11 +40,11 @@
     "test:coverage": "jest --coverage"
   },
   "dependencies": {
-    "@empathyco/x-deep-merge": "^1.3.0-alpha.1",
+    "@empathyco/x-deep-merge": "^1.3.0-alpha.2",
     "@empathyco/x-get-safe-property-chain": "^1.3.0-alpha.1",
     "@empathyco/x-logger": "^1.1.0",
     "@empathyco/x-storage-service": "^2.0.0-alpha.0",
-    "@empathyco/x-types": "^10.0.0-alpha.15",
+    "@empathyco/x-types": "^10.0.0-alpha.17",
     "inversify": "~5.0.1",
     "reflect-metadata": "~0.1.13",
     "tslib": "~2.3.0"
@@ -52,9 +52,9 @@
   "devDependencies": {
     "@empathyco/x-jest-utils": "^1.4.0-alpha.1",
     "@microsoft/api-documenter": "~7.13.33",
-    "@microsoft/api-extractor": "~7.18.4",
+    "@microsoft/api-extractor": "~7.18.21",
     "@types/jest": "~27.0.3",
-    "@types/node": "~12.7.5",
+    "@types/node": "~16.4.12",
     "jest": "~27.3.1",
     "ts-jest": "~27.0.7",
     "typescript": "~4.3.5"
@@ -62,5 +62,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "6a28bcc0e540b1b76d754fe1085613e0798fa992"
+  "gitHead": "6a7be58f9dc77884fb11d3c38d97eb637ad3c0c8"
 }

package/report/x-adapter.api.json

@@ -345,12 +345,35 @@
             },
             {
               "kind": "Content",
-              "text": ", void> "
+              "text": ", "
+            },
+            {
+              "kind": "Reference",
+              "text": "Response",
+              "canonicalReference": "!Response:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | void> "
             }
           ],
           "releaseTag": "Public",
           "name": "BeaconTrackingRequestor",
           "members": [
+            {
+              "kind": "Constructor",
+              "canonicalReference": "@empathyco/x-adapter!BeaconTrackingRequestor:constructor(1)",
+              "docComment": "/**\n * Constructs a new instance of the `BeaconTrackingRequestor` class\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "constructor();"
+                }
+              ],
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": []
+            },
             {
               "kind": "Method",
               "canonicalReference": "@empathyco/x-adapter!BeaconTrackingRequestor#request:member(1)",
@@ -376,7 +399,16 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "<void>"
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Response",
+                  "canonicalReference": "!Response:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | void>"
                 },
                 {
                   "kind": "Content",
@@ -387,7 +419,7 @@
               "isStatic": false,
               "returnTypeTokenRange": {
                 "startIndex": 3,
-                "endIndex": 5
+                "endIndex": 7
               },
               "releaseTag": "Public",
               "overloadIndex": 1,
@@ -406,7 +438,7 @@
           "implementsTokenRanges": [
             {
               "startIndex": 1,
-              "endIndex": 5
+              "endIndex": 7
             }
           ]
         },

package/report/x-adapter.api.md

@@ -23,9 +23,10 @@ export interface AncestorConstantBinding<T = any> {
 }
 
 // @public
-export class BeaconTrackingRequestor implements Requestor<TrackingRequest, void> {
+export class BeaconTrackingRequestor implements Requestor<TrackingRequest, Response | void> {
+    constructor();
     // (undocumented)
-    request(trackingRequest: TrackingRequest): Promise<void>;
+    request(trackingRequest: TrackingRequest): Promise<Response | void>;
 }
 
 // @public

package/types/empathy/requestors/beacon-tracking.requestor.d.ts

@@ -5,7 +5,10 @@ import { Requestor } from '../empathy-adapter.types';
  *
  * @public
  */
-export declare class BeaconTrackingRequestor implements Requestor<TrackingRequest, void> {
-    request(trackingRequest: TrackingRequest): Promise<void>;
+export declare class BeaconTrackingRequestor implements Requestor<TrackingRequest, Response | void> {
+    private isAdblockPresent;
+    constructor();
+    request(trackingRequest: TrackingRequest): Promise<Response | void>;
     private buildUrl;
+    private detectAdblock;
 }