@anddone/coretestautomation 1.0.1

package/.github/workflows/npm-release.yml

@@ -0,0 +1,102 @@
+name: Release CoreTestAutomation
+
+on:
+  workflow_dispatch:
+    inputs:
+      release_type:
+        description: "Release type (semantic versioning)"
+        required: true
+        default: patch
+        type: choice
+        options:
+          - patch
+          - minor
+          - major
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    steps:
+      # 1. Checkout repo
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      # 2. Setup Node
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          registry-url: https://registry.npmjs.org/
+
+      # 3. Install dependencies
+      - run: npm install
+
+      # 4. Build project
+      - run: npm run build
+
+      # 5. Configure Git for tags/commits
+      - name: Configure Git
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+
+      # 6. Bump version safely
+      - name: Bump version
+        run: |
+          # Get release type (patch/minor/major)
+          RELEASE_TYPE=${{ inputs.release_type }}
+
+          # Get current version
+          CURRENT_VERSION=$(node -p "require('./package.json').version")
+
+          # Calculate new version without creating a tag yet
+          NEW_VERSION=$(npm version $RELEASE_TYPE --no-git-tag-version)
+
+          echo "Current version: $CURRENT_VERSION"
+          echo "New version: $NEW_VERSION"
+
+          # Commit package.json changes
+          git add package.json
+          git commit -m "chore(release): $NEW_VERSION"
+
+          # Delete tag if exists (avoid errors in CI)
+          if git rev-parse "v$NEW_VERSION" >/dev/null 2>&1; then
+            git tag -d "v$NEW_VERSION"
+            git push origin :refs/tags/v$NEW_VERSION
+          fi
+
+          # Create new tag
+          git tag "v$NEW_VERSION"
+
+          # Push commit + tag
+          git push origin master --follow-tags
+
+      # 7. Publish to npm
+      - name: Publish to npm
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.TESTAUTOMATIONAUTH }}
+
+      # 8. Slack Success Notification
+      - name: Slack Success
+        if: success()
+        run: |
+          PACKAGE_NAME="@anddone/coretestautomation"
+          VERSION=$(node -p "require('./package.json').version")
+          curl -X POST -H 'Content-type: application/json' \
+          --data "{
+            \"username\": \"CoreTestAutomation\",
+            \"text\": \":white_check_mark: npm package published!\n*Package:* $PACKAGE_NAME\n*Version:* $VERSION\n*Release Notes:*\n• Added Core Test Automation\n• Payment Page methods\"
+
+
+          }" \
+          ${{ secrets.SLACK_WEBHOOK_URL }}
+
+      # 9. Slack Failure Notification
+      - name: Slack Failure
+        if: failure()
+        run: |
+          curl -X POST -H 'Content-type: application/json' \
+          --data '{"text":":x: npm publish failed. Check GitHub Actions logs."}' \
+          ${{ secrets.SLACK_WEBHOOK_URL }}

package/dist/api/base.api.d.ts

@@ -0,0 +1,32 @@
+export type Header = {
+    origin?: string;
+    contentType?: string;
+    authorization?: string;
+    appKey?: string;
+    apiKey?: string;
+    xVersion?: string;
+};
+export type Customer = {
+    firstName?: string;
+    lastName?: string;
+    phone?: string;
+    email?: string;
+};
+export type Reference = {
+    referenceType?: string;
+    referenceKey?: string;
+    referenceNumber?: string;
+};
+export type Split = {
+    virtualAccount?: string;
+    amount?: number | string;
+    reference?: string;
+    chargeIndicator?: string;
+};
+export type Login = {
+    userName?: string;
+    password?: string;
+};
+export declare class BaseAPI {
+}
+//# sourceMappingURL=base.api.d.ts.map

package/dist/api/base.api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.api.d.ts","sourceRoot":"","sources":["../../src/api/base.api.ts"],"names":[],"mappings":"AACA,MAAM,MAAM,MAAM,GAAG;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,KAAK,GAAG;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,KAAK,GAAG;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB,CAAA;AAED,qBAAa,OAAO;CAGnB"}

package/dist/api/base.api.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseAPI = void 0;
+class BaseAPI {
+}
+exports.BaseAPI = BaseAPI;
+//# sourceMappingURL=base.api.js.map

package/dist/api/base.api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.api.js","sourceRoot":"","sources":["../../src/api/base.api.ts"],"names":[],"mappings":";;;AAmCA,MAAa,OAAO;CAGnB;AAHD,0BAGC"}

package/dist/api/headers.d.ts

@@ -0,0 +1,6 @@
+import { Header } from "./base.api";
+export declare class Headers {
+    static headers: Record<string, string>;
+    static getHeaders(options?: Header): Record<string, string>;
+}
+//# sourceMappingURL=headers.d.ts.map

package/dist/api/headers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"headers.d.ts","sourceRoot":"","sources":["../../src/api/headers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEpC,qBAAa,OAAO;IAClB,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEvC,MAAM,CAAC,UAAU,CAAC,OAAO,GAAE,MAAW;CAWvC"}

package/dist/api/headers.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Headers = void 0;
+class Headers {
+    static getHeaders(options = {}) {
+        this.headers = {};
+        if (options.origin)
+            this.headers["Origin"] = options.origin;
+        if (options.contentType)
+            this.headers["Content-Type"] = options.contentType;
+        if (options.authorization)
+            this.headers["Authorization"] = "Bearer " + options.authorization;
+        if (options.xVersion)
+            this.headers["x-version"] = options.xVersion;
+        if (options.apiKey)
+            this.headers["x-api-key"] = options.apiKey;
+        if (options.appKey)
+            this.headers["x-app-key"] = options.appKey;
+        return this.headers;
+    }
+}
+exports.Headers = Headers;
+//# sourceMappingURL=headers.js.map

package/dist/api/headers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"headers.js","sourceRoot":"","sources":["../../src/api/headers.ts"],"names":[],"mappings":";;;AAEA,MAAa,OAAO;IAGlB,MAAM,CAAC,UAAU,CAAC,UAAkB,EAAE;QACpC,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,OAAO,CAAC,MAAM;YAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;QAC5D,IAAI,OAAO,CAAC,WAAW;YAAE,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC;QAC5E,IAAI,OAAO,CAAC,aAAa;YACvB,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,GAAG,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC;QACpE,IAAI,OAAO,CAAC,QAAQ;YAAE,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC;QACnE,IAAI,OAAO,CAAC,MAAM;YAAE,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;QAC/D,IAAI,OAAO,CAAC,MAAM;YAAE,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;CACF;AAdD,0BAcC"}

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+export * from "./pages/basepage";
+export * from "./utils/apiUtils";
+export * from "./utils/assertionUtils";
+export * from "./utils/commonUtils";
+export * from "./utils/fakerStaticData";
+export * from "./utils/fileCommonUtils";
+export * from "./utils/generationUtils";
+export * from "./utils/pageUtils";
+export * from "./utils/tableUtils";
+export * from "./utils/validationUtils";
+export * from "./api/base.api";
+export * from "./api/headers";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC;AACxC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC"}

package/dist/index.js

@@ -0,0 +1,29 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./pages/basepage"), exports);
+__exportStar(require("./utils/apiUtils"), exports);
+__exportStar(require("./utils/assertionUtils"), exports);
+__exportStar(require("./utils/commonUtils"), exports);
+__exportStar(require("./utils/fakerStaticData"), exports);
+__exportStar(require("./utils/fileCommonUtils"), exports);
+__exportStar(require("./utils/generationUtils"), exports);
+__exportStar(require("./utils/pageUtils"), exports);
+__exportStar(require("./utils/tableUtils"), exports);
+__exportStar(require("./utils/validationUtils"), exports);
+__exportStar(require("./api/base.api"), exports);
+__exportStar(require("./api/headers"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,mDAAiC;AACjC,yDAAuC;AACvC,sDAAoC;AACpC,0DAAwC;AACxC,0DAAwC;AACxC,0DAAwC;AACxC,oDAAkC;AAClC,qDAAmC;AACnC,0DAAwC;AACxC,iDAA+B;AAC/B,gDAA8B"}

package/dist/pages/basepage.d.ts

@@ -0,0 +1,6 @@
+import { Page } from "@playwright/test";
+export declare class BasePage {
+    readonly page: Page;
+    constructor(page: Page);
+}
+//# sourceMappingURL=basepage.d.ts.map

package/dist/pages/basepage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"basepage.d.ts","sourceRoot":"","sources":["../../src/pages/basepage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAExC,qBAAa,QAAQ;IAEjB,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;gBAER,IAAI,EAAE,IAAI;CAIzB"}

package/dist/pages/basepage.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BasePage = void 0;
+class BasePage {
+    constructor(page) {
+        this.page = page;
+    }
+}
+exports.BasePage = BasePage;
+//# sourceMappingURL=basepage.js.map

package/dist/pages/basepage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"basepage.js","sourceRoot":"","sources":["../../src/pages/basepage.ts"],"names":[],"mappings":";;;AAEA,MAAa,QAAQ;IAIjB,YAAY,IAAU;QAClB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACrB,CAAC;CAEJ;AARD,4BAQC"}

package/dist/testData/api.data.json

@@ -0,0 +1,6 @@
+{
+    "login": {
+        "method": "POST",
+        "path": "/users/sessions"
+    }
+}

package/dist/utils/apiUtils.d.ts

@@ -0,0 +1,123 @@
+import { APIRequestContext, APIResponse } from "@playwright/test";
+import apiData from "../testData/api.data.json";
+type ApiName = keyof typeof apiData;
+type RequestOptions = {
+    body?: unknown;
+    headers?: Record<string, string>;
+    queryParams?: Record<string, string | number | boolean>;
+    pathParams?: Record<string, string>;
+};
+export declare class EmptyApiResponse {
+    status(): number;
+    ok(): boolean;
+    url(): string;
+    json(): Promise<{}>;
+    text(): Promise<string>;
+}
+export declare class ApiUtils {
+    private static apiLogs;
+    private static request;
+    private static response;
+    private static apiMethod;
+    private static apiPath;
+    private static responseCode;
+    private static responseBody;
+    /**
+     * This is private method to print json value in pretty format.
+     * @param obj
+     * @returns
+     */
+    private static pretty;
+    /**
+     * This method to set APIRequestContext object.
+     * @param request APIRequestContext
+     */
+    static setRequest(request: APIRequestContext): void;
+    /**
+     * This method will returns APIRequestContext object.
+     * @returns APIRequestContext
+     */
+    static getRequest(): APIRequestContext;
+    /**
+     * This method set apiMethod and apiPath using apiData object of the json file.
+     * @param apiName ApiName
+     */
+    static setApiData(apiName: ApiName): void;
+    /**
+     * This method is to get api method.
+     * @returns string
+     */
+    static geApiMethod(): string;
+    /**
+     * This method is get api path.
+     * @returns string
+     */
+    static getApiPath(): string;
+    private static buildPath;
+    /**
+     * This method to log request details in console if apiLogs flag is true.
+     * @param method string | 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH'
+     * @param url string
+     * @param options RequestOptions
+     */
+    static logRequest(method: string | "GET" | "POST" | "PUT" | "DELETE" | "PATCH", url: string, options?: RequestOptions): void;
+    /**
+     * This method is set APIResponse object along with responseCode and responseBody.
+     * Also log response details in console if apiLogs flag is true.
+     * @param response APIResponse
+     */
+    static setResponse(response: APIResponse): Promise<void>;
+    /**
+     * This method is get APIResponse object.
+     * @returns APIResponse
+     */
+    static getResponse(): APIResponse;
+    /**
+     * This method is get response code.
+     * @returns number
+     */
+    static getResponseCode(): number;
+    /**
+     * This method is get response body.
+     * @returns T = unknown
+     */
+    static getResponseBody<T = unknown>(): T;
+    /**
+     * This method is log response details in console if apiLogs flag is true.
+     */
+    static logResponse(): void;
+    /**
+     * This method is to send respuest as per passed details and return response.
+     * @param method string | 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH'
+     * @param url string - passed Base Url and endpoint together, example: {BaseUrl}+{ApiPath}
+     * @param options RequestOptions - this is optional.
+     * @returns @link APIResponse
+     *
+     * Examples:
+     * const  response = sendRequest('POST', {BaseUrl}+{ApiPath}, {headers: {...headers}, body: {...payload}});
+     */
+    static sendRequest(method: string | "GET" | "POST" | "PUT" | "DELETE" | "PATCH", url: string, options?: RequestOptions): Promise<any>;
+    /**
+     * This method is get response object value as per passed path.
+     * Also if object value not found then you set return some defaultValue which is optional.
+     * @param path string - example 'token', 'intent.paymentTypes', 'customers[0].firstName'
+     * @param defaultValue T = any
+     * @returns T = any
+     */
+    static getResponseValue<T = any>(path: string, defaultValue?: T): Promise<T>;
+    /**
+     * This method is get response object value as array.
+     * @param path string - example 'customers'
+     * @returns T = any []
+     */
+    static getResponseArray<T = any>(path: string): Promise<T[]>;
+    /**
+     * Finds an object inside an array and returns its id where multiple fields match
+     * @param arrayPath Path to array. Example: "data"
+     * @param match Object with fields to match. Example: { allyName: "Zbook1201", status: "ACTIVE" }
+     * @param objectName Object name of which value return . "id"
+     */
+    static getResponseValueFromArray(arrayPath: string, objectName: string, match: Record<string, any>): Promise<string>;
+}
+export {};
+//# sourceMappingURL=apiUtils.d.ts.map

package/dist/utils/apiUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"apiUtils.d.ts","sourceRoot":"","sources":["../../src/utils/apiUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAClE,OAAO,OAAO,MAAM,2BAA2B,CAAC;AAEhD,KAAK,OAAO,GAAG,MAAM,OAAO,OAAO,CAAC;AAEpC,KAAK,cAAc,GAAG;IACpB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;IACxD,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACrC,CAAC;AAEF,qBAAa,gBAAgB;IAC3B,MAAM;IAGN,EAAE;IAGF,GAAG;IAGG,IAAI;IAGJ,IAAI;CAGX;AAED,qBAAa,QAAQ;IACnB,OAAO,CAAC,MAAM,CAAC,OAAO,CAAS;IAE/B,OAAO,CAAC,MAAM,CAAC,OAAO,CAAoB;IAC1C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAc;IAErC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAS;IACjC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAS;IAE/B,OAAO,CAAC,MAAM,CAAC,YAAY,CAAS;IACpC,OAAO,CAAC,MAAM,CAAC,YAAY,CAAM;IAEjC;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,MAAM;IAQrB;;;OAGG;IACH,MAAM,CAAC,UAAU,CAAC,OAAO,EAAE,iBAAiB;IAI5C;;;OAGG;IACH,MAAM,CAAC,UAAU;IAIjB;;;OAGG;IACH,MAAM,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO;IAKlC;;;OAGG;IACH,MAAM,CAAC,WAAW;IAIlB;;;OAGG;IACH,MAAM,CAAC,UAAU;IAIjB,OAAO,CAAC,MAAM,CAAC,SAAS;IAexB;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CACf,MAAM,EAAE,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,EAC5D,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,cAAc;IAa1B;;;;OAIG;WACU,WAAW,CAAC,QAAQ,EAAE,WAAW;IAe9C;;;OAGG;IACH,MAAM,CAAC,WAAW;IAIlB;;;OAGG;IACH,MAAM,CAAC,eAAe,IAAI,MAAM;IAIhC;;;OAGG;IACH,MAAM,CAAC,eAAe,CAAC,CAAC,GAAG,OAAO,KAAK,CAAC;IAIxC;;OAEG;IACH,MAAM,CAAC,WAAW;IAQlB;;;;;;;;;OASG;WACU,WAAW,CACtB,MAAM,EAAE,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,EAC5D,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,cAAc;IAyB1B;;;;;;OAMG;WACU,gBAAgB,CAAC,CAAC,GAAG,GAAG,EACnC,IAAI,EAAE,MAAM,EACZ,YAAY,CAAC,EAAE,CAAC,GACf,OAAO,CAAC,CAAC,CAAC;IAmBb;;;;OAIG;WACU,gBAAgB,CAAC,CAAC,GAAG,GAAG,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IAKlE;;;;;OAKG;WACU,yBAAyB,CACpC,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACzB,OAAO,CAAC,MAAM,CAAC;CA+BnB"}

package/dist/utils/apiUtils.js

@@ -0,0 +1,264 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiUtils = exports.EmptyApiResponse = void 0;
+const api_data_json_1 = __importDefault(require("../testData/api.data.json"));
+class EmptyApiResponse {
+    status() {
+        return 0;
+    }
+    ok() {
+        return false;
+    }
+    url() {
+        return "";
+    }
+    async json() {
+        return {};
+    }
+    async text() {
+        return "";
+    }
+}
+exports.EmptyApiResponse = EmptyApiResponse;
+class ApiUtils {
+    /**
+     * This is private method to print json value in pretty format.
+     * @param obj
+     * @returns
+     */
+    static pretty(obj) {
+        try {
+            return JSON.stringify(obj, null, 2);
+        }
+        catch {
+            return String(obj);
+        }
+    }
+    /**
+     * This method to set APIRequestContext object.
+     * @param request APIRequestContext
+     */
+    static setRequest(request) {
+        this.request = request;
+    }
+    /**
+     * This method will returns APIRequestContext object.
+     * @returns APIRequestContext
+     */
+    static getRequest() {
+        return this.request;
+    }
+    /**
+     * This method set apiMethod and apiPath using apiData object of the json file.
+     * @param apiName ApiName
+     */
+    static setApiData(apiName) {
+        this.apiMethod = api_data_json_1.default[apiName].method;
+        this.apiPath = api_data_json_1.default[apiName].path;
+    }
+    /**
+     * This method is to get api method.
+     * @returns string
+     */
+    static geApiMethod() {
+        return this.apiMethod;
+    }
+    /**
+     * This method is get api path.
+     * @returns string
+     */
+    static getApiPath() {
+        return this.apiPath;
+    }
+    static buildPath(apiPath, pathParams) {
+        if (!pathParams)
+            return apiPath;
+        let finalPath = apiPath;
+        for (const [key, value] of Object.entries(pathParams)) {
+            finalPath = finalPath.replace(new RegExp(`{${key}}`, "g"), encodeURIComponent(String(value)));
+        }
+        return finalPath;
+    }
+    /**
+     * This method to log request details in console if apiLogs flag is true.
+     * @param method string | 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH'
+     * @param url string
+     * @param options RequestOptions
+     */
+    static logRequest(method, url, options) {
+        if (this.apiLogs) {
+            console.log("Request:");
+            console.log(method, url);
+            if (options?.headers)
+                console.log("Headers:", this.pretty(options.headers));
+            if (options?.body)
+                console.log("Body:", this.pretty(options.body));
+            if (options?.queryParams)
+                console.log("Query Params:", this.pretty(options.queryParams));
+        }
+    }
+    /**
+     * This method is set APIResponse object along with responseCode and responseBody.
+     * Also log response details in console if apiLogs flag is true.
+     * @param response APIResponse
+     */
+    static async setResponse(response) {
+        this.response = response;
+        try {
+            this.responseCode = this.response?.status?.() ?? 0;
+        }
+        catch (e) {
+            this.responseCode = 0;
+        }
+        try {
+            this.responseBody = await response.json();
+        }
+        catch (e) {
+            this.responseBody = {};
+        }
+        this.logResponse();
+    }
+    /**
+     * This method is get APIResponse object.
+     * @returns APIResponse
+     */
+    static getResponse() {
+        return this.response;
+    }
+    /**
+     * This method is get response code.
+     * @returns number
+     */
+    static getResponseCode() {
+        return this.responseCode;
+    }
+    /**
+     * This method is get response body.
+     * @returns T = unknown
+     */
+    static getResponseBody() {
+        return this.responseBody;
+    }
+    /**
+     * This method is log response details in console if apiLogs flag is true.
+     */
+    static logResponse() {
+        if (this.apiLogs) {
+            console.log("Response:");
+            console.log("Status Code:", this.getResponseCode());
+            console.log("Body:", this.pretty(this.getResponseBody()));
+        }
+    }
+    /**
+     * This method is to send respuest as per passed details and return response.
+     * @param method string | 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH'
+     * @param url string - passed Base Url and endpoint together, example: {BaseUrl}+{ApiPath}
+     * @param options RequestOptions - this is optional.
+     * @returns @link APIResponse
+     *
+     * Examples:
+     * const  response = sendRequest('POST', {BaseUrl}+{ApiPath}, {headers: {...headers}, body: {...payload}});
+     */
+    static async sendRequest(method, url, options) {
+        url = this.buildPath(url, options?.pathParams);
+        this.logRequest(method, url, options);
+        const reqOptions = {};
+        if (options?.headers)
+            reqOptions.headers = options.headers;
+        if (options?.queryParams)
+            reqOptions.params = options.queryParams;
+        if (options?.body)
+            reqOptions.data = options.body;
+        try {
+            const response = await this.getRequest().fetch(url, {
+                method,
+                ...reqOptions,
+            });
+            return response;
+        }
+        catch (error) {
+            const empty = new EmptyApiResponse();
+            await this.setResponse(empty);
+            return empty;
+        }
+    }
+    /**
+     * This method is get response object value as per passed path.
+     * Also if object value not found then you set return some defaultValue which is optional.
+     * @param path string - example 'token', 'intent.paymentTypes', 'customers[0].firstName'
+     * @param defaultValue T = any
+     * @returns T = any
+     */
+    static async getResponseValue(path, defaultValue) {
+        try {
+            const body = (await this.getResponseBody());
+            if (!body || !path) {
+                return defaultValue !== undefined ? defaultValue : "";
+            }
+            const result = path
+                .replace(/\[(\d+)\]/g, ".$1")
+                .split(".")
+                .reduce((obj, key) => obj?.[key], body);
+            if (result === undefined || result === null) {
+                return defaultValue !== undefined ? defaultValue : "";
+            }
+            return result;
+        }
+        catch {
+            return defaultValue !== undefined ? defaultValue : "";
+        }
+    }
+    /**
+     * This method is get response object value as array.
+     * @param path string - example 'customers'
+     * @returns T = any []
+     */
+    static async getResponseArray(path) {
+        const value = await this.getResponseValue(path, []);
+        return Array.isArray(value) ? value : [];
+    }
+    /**
+     * Finds an object inside an array and returns its id where multiple fields match
+     * @param arrayPath Path to array. Example: "data"
+     * @param match Object with fields to match. Example: { allyName: "Zbook1201", status: "ACTIVE" }
+     * @param objectName Object name of which value return . "id"
+     */
+    static async getResponseValueFromArray(arrayPath, objectName, match) {
+        try {
+            if (!match || typeof match !== "object") {
+                return "";
+            }
+            let arr;
+            if (!arrayPath) {
+                const body = await this.getResponseBody();
+                arr = Array.isArray(body) ? body : [];
+            }
+            else {
+                arr = await this.getResponseArray(arrayPath);
+            }
+            if (!Array.isArray(arr) || arr.length === 0) {
+                return "";
+            }
+            const found = arr.find((item) => {
+                if (!item || typeof item !== "object")
+                    return false;
+                return Object.entries(match).every(([key, value]) => item?.[key] === value);
+            });
+            if (!found || typeof found !== "object") {
+                return "";
+            }
+            const result = found?.[objectName];
+            return result !== undefined && result !== null ? String(result) : "";
+        }
+        catch (error) {
+            // Optional: console.warn("⚠️ getResponseValueFromArray failed:", error);
+            return "";
+        }
+    }
+}
+exports.ApiUtils = ApiUtils;
+ApiUtils.apiLogs = false;
+//# sourceMappingURL=apiUtils.js.map