@netacea/captchafeedback 1.2.9 → 1.2.10

package/CHANGELOG.md

@@ -0,0 +1,57 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [1.2.10](https://github.com/Netacea/JavascriptATAIntegration/compare/@netacea/captchafeedback@1.2.9...@netacea/captchafeedback@1.2.10) (2022-12-07)
+
+
+### Bug Fixes
+
+* **captchafeedback:** INT-381: package correct captchafeedback files ([2cbe2ae](https://github.com/Netacea/JavascriptATAIntegration/commit/2cbe2ae52024104ca1271132d221441e8e6abc58))
+
+
+
+
+
+## [1.2.9](https://github.com/Netacea/JavascriptATAIntegration/compare/@netacea/captchafeedback@1.2.1...@netacea/captchafeedback@1.2.9) (2022-11-22)
+
+
+### Bug Fixes
+
+* **captchafeedback:** INT-337: create private makeUpdateCaptchaCall method ([602a94b](https://github.com/Netacea/JavascriptATAIntegration/commit/602a94b6946d3478959e641b17d7f1a1815e15fa))
+
+
+
+
+
+## [1.2.1](https://github.com/Netacea/JavascriptATAIntegration/compare/@netacea/captchafeedback@1.2.0...@netacea/captchafeedback@1.2.1) (2022-05-26)
+
+**Note:** Version bump only for package @netacea/captchafeedback
+
+
+
+
+
+# [1.2.0](https://github.com/Netacea/JavascriptATAIntegration/compare/@netacea/captchafeedback@1.1.0...@netacea/captchafeedback@1.2.0) (2022-04-29)
+
+
+### Features
+
+* **Akamai:** ING-155: remove all .npmrc files ([07774ad](https://github.com/Netacea/JavascriptATAIntegration/commit/07774ad034a9a3076adae131cf784e1e22fea73e))
+
+
+
+
+
+# 1.1.0 (2021-06-24)
+
+
+### Features
+
+* **PB-1758:** Captcha feedback module ([47f582d](https://github.com/Netacea/JavascriptATAIntegration/commit/47f582dbc25c250719fbd66daa96fec492bca76f))
+* **PB-1763:** better testing ([d39fb8c](https://github.com/Netacea/JavascriptATAIntegration/commit/d39fb8c5187561d224a094a618f8b7d6543e42c9))
+* **PB-1763:** Fix changelog and README ([0954f60](https://github.com/Netacea/JavascriptATAIntegration/commit/0954f6074e0ab118cb5a6218dfe1302b5ffdf8d5))
+* **PB-1763:** Fixing test ([01edfd4](https://github.com/Netacea/JavascriptATAIntegration/commit/01edfd4d0600de75bc7351a40fbbe3aeec22053d))
+* **PB-1763:** Passing headers correctly. ([006fcef](https://github.com/Netacea/JavascriptATAIntegration/commit/006fceffc0f92e99b605a37833acae9c9c015e3f))
+* **PB-1763:** Remove UAT and add mitserviceUrl test ([9a2151a](https://github.com/Netacea/JavascriptATAIntegration/commit/9a2151a5ed661db449747069a9148d966dcd45a5))

package/dist/captchafeedback/src/CaptchaFeedback.d.ts

@@ -0,0 +1,107 @@
+import { MitataCookie } from '@netacea/netaceaintegrationbase';
+export declare type MakeRequest = (args: MakeRequestArgs) => Promise<MakeRequestResponse>;
+export declare type CreateMitataCookie = (clientIP: string, userId: string | undefined, expiryTime: number, saltKey: string, mitCode: string) => string;
+export declare type MatchMitataCookie = (cookie: string | undefined) => MitataCookie;
+export interface CaptchaFeedbackArgs {
+    /**
+     * API Key provided by Netacea
+     */
+    apiKey: string;
+    /**
+     * Secret Key provided by Netacea
+    */
+    secretKey: string;
+    /**
+     * OPTIONAL - Mitigation Service URL provided by Netacea
+     */
+    mitigationServiceUrl?: string;
+    /**
+     * Overridable HTTP implementation
+     * If this is not provided - AXIOS shoulld be installed as a peer dependency.
+     * Error thrown if this is not provided and AXIOS is not installed.
+     * Install axios with `npm i axios --save`
+     */
+    makeRequest?: MakeRequest;
+    createMitataCookie?: CreateMitataCookie;
+    matchMitataCookie?: MatchMitataCookie;
+}
+export interface UpdateCaptchaArgs {
+    /**
+     * Incoming clients IP Address
+     */
+    clientIp: string;
+    /**
+     * Event ID that Netacea provided on the `x-netacea-event-id` header
+     * This should be the eventID in realtion to the event when a user was served captcha
+     */
+    eventId: string;
+    /**
+     * The entire `cookie` header received from the client
+     */
+    cookieHeader: string;
+    /**
+     * Client's user-agent header
+     */
+    userAgent: string;
+    /**
+     * Result of the captcha
+     * Captcha Passed = true
+     * Captcha Failed = false
+     */
+    result: boolean;
+}
+export interface UpdateCaptchaResponse {
+    /**
+     * The cookies object should be set as a set-cookie header in your origin server's response
+     * There will be a `_mitata` cookie and an optional `_mitatacaptcha` cookie set in this response.
+     * They follow the standard set-cookie header format.
+     */
+    cookies: string[];
+}
+export interface MakeRequestArgs {
+    /**
+     * The URL so send the request to. This includes the path.
+     */
+    url: string;
+    /**
+     * HTTP Method
+     */
+    method: 'POST';
+    /**
+     * Key, value of header values.
+     * These all need to be sent with the request.
+     */
+    headers: {
+        [key: string]: string;
+    };
+    /**
+     * Request body to send with the request
+     */
+    body: {
+        result: boolean;
+        eventId: string;
+    };
+}
+export interface MakeRequestResponse {
+    status: number;
+    headers: {
+        [key: string]: string;
+    };
+}
+export default class CaptchaFeedback {
+    private readonly apiKey;
+    private readonly secretKey;
+    private readonly mitigationServiceUrl;
+    private readonly makeRequest?;
+    private readonly createMitataCookie?;
+    private readonly matchMitataCookie?;
+    private axios;
+    constructor({ apiKey, secretKey, mitigationServiceUrl, makeRequest, createMitataCookie, matchMitataCookie }: CaptchaFeedbackArgs);
+    private makeUpdateCaptchaCall;
+    updateCaptcha({ clientIp, eventId, cookieHeader, result, userAgent }: UpdateCaptchaArgs): Promise<UpdateCaptchaResponse>;
+    private getAxios;
+    private makeAxiosRequest;
+    private makeOutboundCall;
+    private createCookie;
+    private matchCookie;
+}

package/dist/captchafeedback/src/CaptchaFeedback.js

@@ -0,0 +1,120 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const netaceaintegrationbase_1 = require("@netacea/netaceaintegrationbase");
+class CaptchaFeedback {
+    constructor({ apiKey, secretKey, mitigationServiceUrl = 'https://mitigations.netacea.net', makeRequest, createMitataCookie, matchMitataCookie }) {
+        if (apiKey === null || apiKey === undefined) {
+            throw new Error('Netacea: apiKey is a required parameter');
+        }
+        this.apiKey = apiKey;
+        this.secretKey = secretKey;
+        this.mitigationServiceUrl = mitigationServiceUrl;
+        this.makeRequest = makeRequest;
+        this.createMitataCookie = createMitataCookie;
+        this.matchMitataCookie = matchMitataCookie;
+    }
+    async makeUpdateCaptchaCall({ eventId, result, clientIp, userAgent, cookieHeader }) {
+        const response = await this.makeOutboundCall({
+            body: {
+                eventId,
+                result
+            },
+            headers: {
+                'content-type': 'application/json; charset=utf-8',
+                'x-netacea-api-key': this.apiKey,
+                'x-netacea-client-ip': clientIp,
+                'user-agent': userAgent,
+                'cookie': cookieHeader
+            },
+            method: 'POST',
+            url: `${this.mitigationServiceUrl}/UpdateCaptcha`
+        });
+        if (response.status !== 200) {
+            throw new Error(`Netacea: Non-200 status code returned from XHR call. Code was ${response.status}`);
+        }
+        return response;
+    }
+    async updateCaptcha({ clientIp, eventId, cookieHeader, result, userAgent }) {
+        var _a;
+        if (cookieHeader === undefined || cookieHeader.length === 0 || !cookieHeader.includes('_mitata=')) {
+            throw new Error('The cookie header must have a mitata cookie');
+        }
+        try {
+            const response = await this.makeUpdateCaptchaCall({
+                eventId,
+                result,
+                clientIp,
+                userAgent,
+                cookieHeader
+            });
+            const parsedCookieHeader = cookieHeader.substring('_mitata='.length);
+            const trimedParsedCookieHeader = parsedCookieHeader.includes('; Max-Age=')
+                ? parsedCookieHeader.split(';')[0] : parsedCookieHeader;
+            const mitataExpiry = response.headers['x-netacea-mitata-expiry'];
+            const mitataCaptchaValue = response.headers['x-netacea-mitatacaptcha-value'];
+            const mitataCaptchaExpiry = response.headers['x-netacea-mitatacaptcha-expiry'];
+            const mitataMatch = response.headers['x-netacea-match'];
+            const mitataMitigate = response.headers['x-netacea-mitigate'];
+            const mitataCaptcha = response.headers['x-netacea-captcha'];
+            const { userId } = (_a = this.matchCookie(trimedParsedCookieHeader)) !== null && _a !== void 0 ? _a : {};
+            const newCookie = this.createCookie(clientIp, userId, Math.floor(Date.now() / 1000) + 60, this.secretKey, `${mitataMatch}${mitataMitigate}${mitataCaptcha}`);
+            return {
+                cookies: [
+                    `_mitata=${newCookie}; Max-Age=${mitataExpiry}; Path=/;`,
+                    `_mitatacaptcha=${mitataCaptchaValue}; Max-Age=${mitataCaptchaExpiry}; Path=/;`
+                ]
+            };
+        }
+        catch (e) {
+            // eslint-disable-next-line no-console
+            console.error(e);
+            return { cookies: [] };
+        }
+    }
+    async getAxios() {
+        return await Promise.resolve().then(() => require('axios'));
+    }
+    async makeAxiosRequest({ body, headers, method, url }) {
+        if (this.axios === undefined) {
+            try {
+                // try to lazyload axios
+                this.axios = await this.getAxios();
+            }
+            catch {
+                // Throw error as axios req wasn't met by `peerDependencies` and makeRequest was not implemented
+                throw new Error(['Netacea: Axios must be installed `(npm i axios --save)`',
+                    'or makeRequest must be provided to override the default of axios being used.'].join(' '));
+            }
+        }
+        if (method === 'POST') {
+            const response = await this.axios.post(url, body, {
+                headers
+            });
+            return {
+                status: response.status,
+                headers: response.headers
+            };
+        }
+        throw new Error('Netacea: method not supported');
+    }
+    async makeOutboundCall(args) {
+        if (this.makeRequest !== undefined) {
+            return await this.makeRequest(args);
+        }
+        return await this.makeAxiosRequest(args);
+    }
+    createCookie(clientIP, userId, expiryTime, saltKey, mitCode) {
+        if (this.createMitataCookie !== undefined) {
+            return this.createMitataCookie(clientIP, userId, expiryTime, saltKey, mitCode);
+        }
+        return netaceaintegrationbase_1.createMitataCookie(clientIP, userId, expiryTime, saltKey, mitCode);
+    }
+    matchCookie(cookie) {
+        if (this.matchMitataCookie !== undefined) {
+            return this.matchMitataCookie(cookie);
+        }
+        return netaceaintegrationbase_1.matchMitataCookie(cookie);
+    }
+}
+exports.default = CaptchaFeedback;
+//# sourceMappingURL=CaptchaFeedback.js.map

package/dist/captchafeedback/src/CaptchaFeedback.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CaptchaFeedback.js","sourceRoot":"","sources":["../../../src/CaptchaFeedback.ts"],"names":[],"mappings":";;AAGA,4EAAqG;AAmGrG,MAAqB,eAAe;IAQlC,YAAa,EACX,MAAM,EACN,SAAS,EACT,oBAAoB,GAAG,iCAAiC,EACxD,WAAW,EACX,kBAAkB,EAClB,iBAAiB,EACG;QACpB,IAAI,MAAM,KAAK,IAAI,IAAI,MAAM,KAAK,SAAS,EAAE;YAC3C,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAA;SAC3D;QACD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC1B,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,CAAA;QAChD,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;QAC9B,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAA;QAC5C,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAA;IAC5C,CAAC;IAEO,KAAK,CAAC,qBAAqB,CAAE,EACnC,OAAO,EACP,MAAM,EACN,QAAQ,EACR,SAAS,EACT,YAAY,EACM;QAClB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC;YAC3C,IAAI,EAAE;gBACJ,OAAO;gBACP,MAAM;aACP;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,iCAAiC;gBACjD,mBAAmB,EAAE,IAAI,CAAC,MAAM;gBAChC,qBAAqB,EAAE,QAAQ;gBAC/B,YAAY,EAAE,SAAS;gBACvB,QAAQ,EAAE,YAAY;aACvB;YACD,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,GAAG,IAAI,CAAC,oBAAoB,gBAAgB;SAClD,CAAC,CAAA;QACF,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,iEAAiE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAA;SACpG;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAEM,KAAK,CAAC,aAAa,CAAE,EAC1B,QAAQ,EACR,OAAO,EACP,YAAY,EACZ,MAAM,EACN,SAAS,EACS;;QAClB,IAAI,YAAY,KAAK,SAAS,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE;YACjG,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;SAC/D;QACD,IAAI;YACF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC;gBAChD,OAAO;gBACP,MAAM;gBACN,QAAQ;gBACR,SAAS;gBACT,YAAY;aACb,CAAC,CAAA;YAEF,MAAM,kBAAkB,GAAG,YAAY,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;YACpE,MAAM,wBAAwB,GAAG,kBAAkB,CAAC,QAAQ,CAAC,YAAY,CAAC;gBACxE,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,kBAAkB,CAAA;YAEzD,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,CAAC,yBAAyB,CAAC,CAAA;YAChE,MAAM,kBAAkB,GAAG,QAAQ,CAAC,OAAO,CAAC,+BAA+B,CAAC,CAAA;YAC5E,MAAM,mBAAmB,GAAG,QAAQ,CAAC,OAAO,CAAC,gCAAgC,CAAC,CAAA;YAC9E,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAA;YACvD,MAAM,cAAc,GAAG,QAAQ,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAA;YAC7D,MAAM,aAAa,GAAG,QAAQ,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAA;YAE3D,MAAM,EAAE,MAAM,EAAE,SAAG,IAAI,CAAC,WAAW,CAAC,wBAAwB,CAAC,mCAAI,EAAE,CAAA;YAEnE,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,EAC1C,MAAM,EACN,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,GAAG,EAAE,EAClC,IAAI,CAAC,SAAS,EACd,GAAG,WAAW,GAAG,cAAc,GAAG,aAAa,EAAE,CAAC,CAAA;YAEpD,OAAO;gBACL,OAAO,EAAE;oBACP,WAAW,SAAS,aAAa,YAAY,WAAW;oBACxD,kBAAkB,kBAAkB,aAAa,mBAAmB,WAAW;iBAChF;aACF,CAAA;SACF;QAAC,OAAO,CAAC,EAAE;YACV,sCAAsC;YACtC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;YAChB,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,CAAA;SACvB;IACH,CAAC;IAEO,KAAK,CAAC,QAAQ;QACpB,OAAO,2CAAa,OAAO,EAA2B,CAAA;IACxD,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAE,EAC9B,IAAI,EACJ,OAAO,EACP,MAAM,EACN,GAAG,EACa;QAChB,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE;YAC5B,IAAI;gBACF,wBAAwB;gBACxB,IAAI,CAAC,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAA;aACnC;YAAC,MAAM;gBACN,gGAAgG;gBAChG,MAAM,IAAI,KAAK,CAAC,CAAC,yDAAyD;oBACxE,8EAA8E,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;aAC7F;SACF;QACD,IAAI,MAAM,KAAK,MAAM,EAAE;YACrB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE;gBAChD,OAAO;aACR,CAAC,CAAA;YACF,OAAO;gBACL,MAAM,EAAE,QAAQ,CAAC,MAAM;gBACvB,OAAO,EAAE,QAAQ,CAAC,OAAO;aAC1B,CAAA;SACF;QACD,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAA;IAClD,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAE,IAAqB;QACnD,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE;YAClC,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;SACpC;QACD,OAAO,MAAM,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA;IAC1C,CAAC;IAEO,YAAY,CAAE,QAAgB,EACpC,MAA0B,EAC1B,UAAkB,EAClB,OAAe,EACf,OAAe;QACf,IAAI,IAAI,CAAC,kBAAkB,KAAK,SAAS,EAAE;YACzC,OAAO,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EACrC,MAAM,EACN,UAAU,EACV,OAAO,EACP,OAAO,CAAC,CAAA;SACX;QACD,OAAO,2CAAkB,CAAC,QAAQ,EAChC,MAAM,EACN,UAAU,EACV,OAAO,EACP,OAAO,CAAC,CAAA;IACZ,CAAC;IAEO,WAAW,CAAE,MAAc;QACjC,IAAI,IAAI,CAAC,iBAAiB,KAAK,SAAS,EAAE;YACxC,OAAO,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAA;SACtC;QACD,OAAO,0CAAiB,CAAC,MAAM,CAAC,CAAA;IAClC,CAAC;CACF;AA1KD,kCA0KC"}

package/dist/captchafeedback/src/index.d.ts

@@ -0,0 +1,3 @@
+import CaptchaFeedback from './CaptchaFeedback';
+export default CaptchaFeedback;
+export { CaptchaFeedbackArgs, MakeRequest, MakeRequestArgs, MakeRequestResponse, UpdateCaptchaArgs, UpdateCaptchaResponse } from './CaptchaFeedback';

package/dist/captchafeedback/src/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const CaptchaFeedback_1 = require("./CaptchaFeedback");
+exports.default = CaptchaFeedback_1.default;
+//# sourceMappingURL=index.js.map

package/dist/captchafeedback/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":";;AAAA,uDAA+C;AAC/C,kBAAe,yBAAe,CAAA"}

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@netacea/captchafeedback",
-  "version": "1.2.9",
+  "version": "1.2.10",
   "description": "CAPTCHA feedback module to send CAPTCHA results back to Netacea.",
-  "main": "dist/src/index.js",
-  "types": "dist/src/index.d.ts",
+  "main": "dist/captchafeedback/src/index.js",
+  "types": "dist/captchafeedback/src/index.d.ts",
   "scripts": {
     "test": "npx nyc tape -r ts-node/register -r tsconfig-paths/register './tests/*.test.ts'",
     "lint": "npx eslint . --ext ts",
@@ -16,9 +16,8 @@
     "access": "public"
   },
   "files": [
-    "./dist/captchafeedback/src",
-    "./scripts",
-    "./CHANGELOG.md"
+    "dist/captchafeedback/src",
+    "CHANGELOG.md"
   ],
   "license": "ISC",
   "devDependencies": {
@@ -41,5 +40,5 @@
   "dependencies": {
     "@netacea/netaceaintegrationbase": "^1.11.1"
   },
-  "gitHead": "9d025c5c44074d6f586cc8e93c4180c5a3e260c7"
+  "gitHead": "0e101cc53cbdb313b787aa91f5ddba30828b9e8b"
 }