@netacea/f5 4.3.122 → 4.3.124

package/dist/package.json

@@ -1,50 +0,0 @@
-{
-    "name": "@netacea/f5",
-    "version": "4.3.122",
-    "description": "Netacea F5 CDN integration",
-    "main": "dist/src/index.js",
-    "types": "dist/src/index.d.ts",
-    "scripts": {
-        "build": "npx tsc --project tsconfig.build.json",
-        "lint:fix": "npx eslint . --ext ts --fix",
-        "lint": "npx eslint . --ext ts",
-        "prepublishOnly": "npm run build",
-        "test:integration:no-clean": "NODE_OPTIONS='--import tsx' npx nyc --no-clean -r=lcov -r=html -r=text mocha --timeout 60000 './tests/mocha/*.test.ts'",
-        "test:integration": "NODE_OPTIONS='--import tsx' npx nyc -r=lcov -r=html -r=text mocha --timeout 60000 './tests/mocha/*.test.ts'",
-        "test:unit": "NODE_OPTIONS='--import tsx' npx nyc tape './tests/tape/*.test.ts'",
-        "test": "npm run test:unit && npm run test:integration:no-clean",
-        "postpack": "npx netacea-bundler postpack",
-        "prepack": "npx netacea-bundler prepack"
-    },
-    "author": "Netacea <npm@netacea.com> (https://netacea.com)",
-    "publishConfig": {
-        "access": "public"
-    },
-    "license": "ISC",
-    "devDependencies": {
-        "@netacea/bundler": "^1.0.22",
-        "@netacea/netaceaintegrationtestrunner": "^1.8.49",
-        "@netacea/test-runner-scenarios": "^1.0.22",
-        "@netacea/test-runner-transforms": "^1.0.22",
-        "@netacea/test-runner-types": "^1.0.22",
-        "@types/chai": "^4.3.5",
-        "@types/mocha": "^10.0.1",
-        "@types/node": "^14.11.2",
-        "@types/proxyquire": "^1.3.28",
-        "@types/sinon": "^9.0.8",
-        "@types/tape": "^4.13.0",
-        "chai": "^4.3.7",
-        "mocha": "^10.2.0",
-        "nyc": "^15.1.0",
-        "proxyquire": "^2.1.3",
-        "sinon": "^9.1.0",
-        "tape": "^5.0.1",
-        "typescript": "^5.4.5"
-    },
-    "dependencies": {
-        "@netacea/kinesisingest": "^1.5.122",
-        "@netacea/netaceaintegrationbase": "^2.0.104",
-        "f5-nodejs": "^1.0.0"
-    },
-    "gitHead": "c0854fe16b2b9da29614a1fe4428423325787bbb"
-}

package/dist/src/F5.d.ts

@@ -1,166 +0,0 @@
-import { type APICallResponse, type ComposeResultResponse, type FindBestMitigationResponse, type IngestArgs, type InjectResponse, type MakeRequestArgs, type MakeRequestResponse, type MitigateResponse, type NetaceaBaseArgs, NetaceaIngestType, type NetaceaMitigationResponse, NetaceaMitigationType, type NetaceaResponseBase, type NetaceaWorker, type ProcessMitigateRequestArgs, type WebLog } from '@netacea/netaceaintegrationbase';
-import NetaceaKinesis from '@netacea/kinesisingest';
-export interface F5ConstructorArgs extends NetaceaBaseArgs {
-    maxSockets?: number;
-}
-export interface F5Response {
-    body?: string;
-    status: number;
-    apiCallStatus: number;
-    mitigation: string;
-    mitigated: boolean;
-}
-export interface F5MitigateArgs {
-    ip: string;
-    userAgent: string;
-    url: string;
-    method: string;
-    mitataCookie?: string;
-    mitataCaptchaCookie?: string;
-    body?: any;
-}
-export interface F5IngestArgs {
-    ip: string;
-    userAgent: string;
-    status: string;
-    method: string;
-    path: string;
-    protocol: string;
-    referer: string;
-    bytesSent: string;
-    requestTime: string;
-    mitataCookie?: string;
-    sessionStatus?: string;
-}
-export type IngestRequestParams = [
-    string | undefined,
-    // ip
-    string | undefined,
-    // userAgent
-    string | undefined,
-    // status
-    string | undefined,
-    // method
-    string | undefined,
-    // path
-    string | undefined,
-    // protocol
-    string | undefined,
-    // referer
-    string | undefined,
-    // bytesSent
-    string | undefined,
-    // requestTime
-    string | undefined,
-    // mitataCookie
-    string | undefined
-];
-export type HandleRequestParams = [
-    string,
-    string,
-    string,
-    string,
-    // url
-    string | null,
-    // cookies
-    string | undefined
-];
-export type NetaceaF5InjectHeaders = [
-    string,
-    string,
-    string,
-    string
-] | [];
-export interface F5Request<T extends unknown[]> {
-    params: () => T;
-}
-export interface F5Res {
-    reply: (args: [
-        string,
-        number,
-        string[],
-        string,
-        boolean,
-        string,
-        NetaceaF5InjectHeaders
-    ] | string) => void;
-}
-export interface IlxServer {
-    addMethod: <T extends any[]>(handler: string, func: (req: F5Request<T>, res: F5Res) => Promise<void> | void) => void;
-    listen: () => void;
-}
-declare abstract class NetaceaBase<RequestArgs = unknown, Response = unknown> implements NetaceaWorker<RequestArgs, Response> {
-    protected mitataCookieExpirySeconds: number;
-    protected apiKey: string;
-    protected secretKey?: string;
-    protected mitigationServiceUrl: string;
-    protected ingestServiceUrl: string;
-    protected readonly timeout: number;
-    protected readonly captchaSiteKey?: string;
-    protected readonly captchaSecretKey?: string;
-    protected readonly ingestType: NetaceaIngestType;
-    protected readonly kinesis?: NetaceaKinesis;
-    protected readonly mitigationType: NetaceaMitigationType;
-    protected readonly encryptedCookies: string[];
-    protected readonly netaceaCookieName: string;
-    protected readonly netaceaCaptchaCookieName: string;
-    protected abstract makeRequest(args: MakeRequestArgs): Promise<MakeRequestResponse>;
-    protected abstract mitigate(args: RequestArgs): Promise<MitigateResponse<Response>>;
-    protected abstract inject(args: RequestArgs): Promise<InjectResponse>;
-    abstract ingest(...args: any[]): Promise<any>;
-    abstract getCookieHeader(args: RequestArgs): string | null | undefined;
-    constructor({ apiKey, secretKey, timeout, mitigationServiceUrl, ingestServiceUrl, mitigationType, captchaSiteKey, captchaSecretKey, ingestType, kinesis, mitataCookieExpirySeconds, netaceaCookieExpirySeconds, netaceaCookieName, netaceaCaptchaCookieName }: NetaceaBaseArgs);
-    runMitigation(args: RequestArgs): Promise<NetaceaMitigationResponse<Response>>;
-    /**
-     * Returns the value of the cookie with the given name from a string or list of cookies.
-     * If the cookie name is included in the encryptedCookies class property,
-     * then the cookie value will be decrypted automatically.
-     * The method may operate of either the HTTP Cookie or Set-Cookie headers.
-     * @param cookieName the name of the cookie to find.
-     * @param cookies the full list of cookies, either as a string or an array of strings.
-     * @returns the value of the cookie, if found.
-     */
-    protected readCookie(cookieName: string, cookies: string | string[] | null | undefined): Promise<string | undefined>;
-    protected callIngest(args: IngestArgs): Promise<void>;
-    private makeIngestApiCall;
-    private constructV1WebLog;
-    protected constructWebLog(args: IngestArgs): WebLog;
-    protected check(netaceaCookie: string | undefined, clientIP: string, userAgent: string, captchaCookie?: string): Promise<ComposeResultResponse>;
-    protected createMitata(clientIP: string, userId: string | undefined, match: string, mitigate: string, captcha: string, maxAge?: number, expiry?: number | undefined): Promise<string>;
-    private processCaptcha;
-    private getMitataCaptchaFromHeaders;
-    private makeCaptchaAPICall;
-    private getApiCallResponseFromResponse;
-    private buildCookieFromValues;
-    private buildCookieHeader;
-    private makeMitigateAPICall;
-    private composeResult;
-    protected findBestMitigation(match: string, mitigate: string, captcha: string, isCaptchaPost: boolean): FindBestMitigationResponse;
-    protected APIError(response: APICallResponse): Error;
-    protected isUrlCaptchaPost(url: string, method: string): boolean;
-    protected processMitigateRequest(args: ProcessMitigateRequestArgs): Promise<ComposeResultResponse>;
-    protected setIngestOnlyMitataCookie(userId: string | undefined): Promise<NetaceaResponseBase>;
-    protected processIngest(args: RequestArgs): Promise<NetaceaResponseBase>;
-    protected encryptCookieValue(cookieValue: string): Promise<string>;
-    protected decryptCookieValue(encryptedCookieValue: string): Promise<string>;
-}
-export default class F5 extends NetaceaBase<F5MitigateArgs | F5IngestArgs, F5Response> {
-    private readonly httpsAgent;
-    private readonly mitataCookieName;
-    private readonly mitataCaptchaCookieName;
-    constructor(args: F5ConstructorArgs);
-    private getInjectHeaders;
-    registerMitigateHandler(ilx: IlxServer): void;
-    private getValueOrDefault;
-    private getArrayValueOrDefault;
-    private getMitataCookies;
-    private getCookie;
-    registerIngestHandler(ilx: IlxServer): void;
-    protected makeRequest(args: MakeRequestArgs): Promise<MakeRequestResponse>;
-    protected mitigate(args: F5MitigateArgs): Promise<MitigateResponse<F5Response>>;
-    protected inject(args: F5MitigateArgs): Promise<InjectResponse>;
-    private getMitigationResponse;
-    ingest({ ip, userAgent, status, method, path, protocol, referer, bytesSent, requestTime, mitataCookie, sessionStatus }: F5IngestArgs): Promise<any>;
-    getCookieHeader(args: F5IngestArgs): string | undefined;
-}
-export {};