airalo-sdk-type 0.0.1

package/README.md

@@ -0,0 +1,59 @@
+# CloudHub
+
+CloudHub is an API wrapper for managing authentication, products, and orders seamlessly. It is built with TypeScript and designed for flexibility and scalability.
+
+## Installation
+
+Install the package using npm or yarn:
+
+```bash
+npm install cloudhub.mn
+```
+
+## Usage
+
+Import CloudHub and configure it for your application:
+
+```ts
+import CloudHub from "cloudhub";
+
+// Set host and logger
+await CloudHub.setHost("https://api.example.com");
+await CloudHub.setLogger(true);
+
+// Authenticate
+const authResult = await CloudHub.auth.LOGIN({
+  email: "user@example.com",
+  password: "password123",
+});
+console.log(authResult);
+```
+
+## Features
+
+- **Authentication**: Login and manage tokens.
+- **Item Management**: Retrieve and manage items.
+- **Product Management**: Retrieve products and details.
+- **Order Verification**: Verify orders by ID.
+
+## API
+
+### `CloudHub.setHost(url: string)`
+
+Set the API host URL.
+
+### `CloudHub.setLogger(status: boolean)`
+
+Enable or disable logging.
+
+### `CloudHub.auth.LOGIN(body: { email: string; password: string })`
+
+Authenticate a user and retrieve an access token.
+
+### `CloudHub.auth.getToken()`
+
+Retrieve a new authentication token using stored credentials.
+
+## License
+
+MIT License

package/dist/auth.d.ts

@@ -0,0 +1,13 @@
+type AuthType = {
+    client_id: string;
+    client_secret: string;
+};
+type TokenResponse = {
+    success: boolean;
+    message: string;
+};
+export declare const getToken: () => Promise<string>;
+declare const _default: {
+    TOKEN: (auth: AuthType) => Promise<TokenResponse>;
+};
+export default _default;

package/dist/auth.js

@@ -0,0 +1,99 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getToken = void 0;
+const _1 = require("./");
+const axios_master_1 = require("axios-master");
+const form_data_1 = __importDefault(require("form-data"));
+const TOKEN = async (auth) => {
+    try {
+        let data = new form_data_1.default();
+        data.append("client_id", auth.client_id);
+        data.append("client_secret", auth.client_secret);
+        data.append("grant_type", "client_credentials");
+        const response = await (0, axios_master_1.axiosMasterLogger)({
+            method: "POST",
+            url: `${_1.config.host}/v2/token`,
+            headers: {
+                Accept: "application/json",
+                ...data.getHeaders(),
+            },
+            data: data,
+        }, {
+            name: "Token",
+            timeout: 20000,
+            logger: (data) => {
+                if (_1.config.logger)
+                    console.log(data);
+            },
+        });
+        if (response?.data?.access_token) {
+            _1.config.token = response?.data?.access_token;
+            _1.config.auth = auth;
+            return {
+                success: true,
+                message: "Token retrieved successfully.",
+            };
+        }
+        return {
+            success: false,
+            message: "Failed to retrieve token.",
+        };
+    }
+    catch (error) {
+        const axiosError = error;
+        if (axiosError?.response) {
+            console.log(axiosError.response);
+        }
+        else {
+            console.error("Token Request Failed:", axiosError);
+        }
+        return {
+            success: false,
+            message: axiosError?.response?.data?.meta?.message || "An error occurred.",
+        };
+    }
+};
+const getToken = async () => {
+    try {
+        const data = new form_data_1.default();
+        data.append("client_id", _1.config.auth.client_id);
+        data.append("client_secret", _1.config.auth.client_secret);
+        data.append("grant_type", "client_credentials");
+        const response = await (0, axios_master_1.axiosMasterLogger)({
+            method: "POST",
+            url: `${_1.config.host}/v2/token`,
+            headers: {
+                Accept: "application/json",
+                ...data.getHeaders(),
+            },
+            data: data,
+        }, {
+            name: "Token",
+            timeout: 20000,
+            logger: (data) => {
+                if (_1.config.logger)
+                    console.log(data);
+            },
+        });
+        if (response?.data?.access_token) {
+            _1.config.token = response?.data?.access_token;
+            return response?.data?.access_token;
+        }
+        return "";
+    }
+    catch (error) {
+        const axiosError = error;
+        if (axiosError?.response) {
+            console.log(axiosError.response);
+        }
+        else {
+            console.error("Token Request Failed:", axiosError);
+        }
+        return "";
+    }
+};
+exports.getToken = getToken;
+exports.default = { TOKEN };

package/dist/balance.d.ts

@@ -0,0 +1,29 @@
+export declare const Balance: () => Promise<{
+    success: boolean;
+    data: {
+        balances: {
+            name: "balance";
+            availableBalance: {
+                amount: number;
+                currency: string;
+            };
+        };
+    } | null;
+    message: string;
+}>;
+declare const _default: {
+    Balance: () => Promise<{
+        success: boolean;
+        data: {
+            balances: {
+                name: "balance";
+                availableBalance: {
+                    amount: number;
+                    currency: string;
+                };
+            };
+        } | null;
+        message: string;
+    }>;
+};
+export default _default;

package/dist/balance.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Balance = void 0;
+const _1 = require("./");
+const axios_master_1 = require("axios-master");
+const auth_1 = require("./auth");
+const Balance = async () => {
+    try {
+        const result = await (0, axios_master_1.axiosMasterLogger)({
+            method: "GET",
+            maxBodyLength: Infinity,
+            url: `${_1.config.host}/v2/balance`,
+            headers: {
+                Accept: "application/json",
+                "Content-Type": "application/json",
+                Authorization: `Bearer ${_1.config.token}`,
+            },
+        }, {
+            name: "Balance",
+            timeout: 20000,
+            retryFunction: auth_1.getToken,
+            shouldRetry: true,
+            shouldRetryStatus: [401],
+            logger: (data) => _1.config.logger && console.log("Balance:", data.json),
+        });
+        return {
+            success: true,
+            data: result?.data || null,
+            message: "Successfully",
+        };
+    }
+    catch (error) {
+        const axiosError = error;
+        if (axiosError?.response) {
+            console.log(axiosError.response);
+        }
+        else {
+            console.error("Balance Request Failed:", axiosError);
+        }
+        return {
+            success: false,
+            message: axiosError?.response?.data?.meta?.message || "An error occurred.",
+            data: null,
+        };
+    }
+};
+exports.Balance = Balance;
+exports.default = { Balance: exports.Balance };

package/dist/index.d.ts

@@ -0,0 +1,42 @@
+export declare const jsonToQueryString: (params: {
+    [key: string]: any;
+}) => string;
+export declare const config: {
+    token: string;
+    env: "PROD" | "STAGING";
+    host: string;
+    auth: {
+        client_id: string;
+        client_secret: string;
+    };
+    logger: boolean;
+};
+export declare const setHost: (url: string) => void;
+export declare const setLogger: (status: boolean) => void;
+declare const _default: {
+    auth: {
+        TOKEN: (auth: {
+            client_id: string;
+            client_secret: string;
+        }) => Promise<{
+            success: boolean;
+            message: string;
+        }>;
+    };
+    config: {
+        token: string;
+        env: "PROD" | "STAGING";
+        host: string;
+        auth: {
+            client_id: string;
+            client_secret: string;
+        };
+        logger: boolean;
+    };
+    ObjectId: () => string;
+    setHost: (url: string) => void;
+    setLogger: (status: boolean) => void;
+};
+export default _default;
+export { default as Package } from "./package";
+export { default as Order } from "./order";

package/dist/index.js

@@ -0,0 +1,59 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Order = exports.Package = exports.setLogger = exports.setHost = exports.config = exports.jsonToQueryString = void 0;
+const auth_1 = __importDefault(require("./auth"));
+const jsonToQueryString = (params) => {
+    const query = Object.keys(params)
+        .map((key) => `${encodeURIComponent(key)}=${encodeURIComponent(params[key])}`)
+        .join("&");
+    return query ? `?${query}` : "";
+};
+exports.jsonToQueryString = jsonToQueryString;
+const ObjectId = function () {
+    var timestamp = ((new Date().getTime() / 1000) | 0).toString(16);
+    return (timestamp +
+        "xxxxxxxxxxxxxxxx"
+            .replace(/[x]/g, function () {
+            return ((Math.random() * 16) | 0).toString(16);
+        })
+            .toLowerCase());
+};
+exports.config = {
+    token: "",
+    env: "STAGING",
+    host: "https://sandbox-partners-api.airalo.com", // https://sandbox-partners-api.airalo.com, https://partners-api.airalo.com
+    auth: {
+        client_id: "",
+        client_secret: "",
+    },
+    logger: false,
+};
+// Function to set the host URL for API requests
+const setHost = (url) => {
+    exports.config.host = url;
+    if (url == "https://partners-api.airalo.com") {
+        exports.config.env = "PROD";
+    }
+    console.log("Host set to:", url);
+};
+exports.setHost = setHost;
+// Function to enable or disable logging
+const setLogger = (status) => {
+    exports.config.logger = status;
+    console.log("Logger status set to:", status);
+};
+exports.setLogger = setLogger;
+exports.default = {
+    auth: auth_1.default,
+    config: exports.config,
+    ObjectId,
+    setHost: exports.setHost,
+    setLogger: exports.setLogger,
+};
+var package_1 = require("./package");
+Object.defineProperty(exports, "Package", { enumerable: true, get: function () { return __importDefault(package_1).default; } });
+var order_1 = require("./order");
+Object.defineProperty(exports, "Order", { enumerable: true, get: function () { return __importDefault(order_1).default; } });

package/dist/order.d.ts

@@ -0,0 +1,26 @@
+import { Order } from "./types/order";
+export declare const SubmitOrder: (body: {
+    quantity: string;
+    package_id: string;
+    type: string;
+    description?: string;
+    brand_settings_name?: string;
+}) => Promise<{
+    success: boolean;
+    data: Order;
+    message: string;
+}>;
+declare const _default: {
+    SubmitOrder: (body: {
+        quantity: string;
+        package_id: string;
+        type: string;
+        description?: string;
+        brand_settings_name?: string;
+    }) => Promise<{
+        success: boolean;
+        data: Order;
+        message: string;
+    }>;
+};
+export default _default;

package/dist/order.js

@@ -0,0 +1,64 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubmitOrder = void 0;
+const _1 = require(".");
+const axios_master_1 = require("axios-master");
+const form_data_1 = __importDefault(require("form-data"));
+const auth_1 = require("./auth");
+const SubmitOrder = async (body) => {
+    try {
+        const data = new form_data_1.default();
+        data.append("client_id", _1.config.auth.client_id);
+        data.append("quantity", body.quantity);
+        data.append("package_id", body.package_id);
+        data.append("type", body.type);
+        if (body.description) {
+            data.append("description", body.description);
+        }
+        if (body.brand_settings_name) {
+            data.append("brand_settings_name", body.brand_settings_name);
+        }
+        const result = await (0, axios_master_1.axiosMasterLogger)({
+            method: "POST",
+            maxBodyLength: Infinity,
+            url: `${_1.config.host}/v2/orders`,
+            headers: {
+                Accept: "application/json",
+                "Content-Type": "application/json",
+                Authorization: `Bearer ${_1.config.token}`,
+            },
+            data: data,
+        }, {
+            name: "SubmitOrder",
+            timeout: 20000,
+            retryFunction: auth_1.getToken,
+            shouldRetry: true,
+            shouldRetryStatus: [401],
+            logger: (data) => _1.config.logger && console.log("SubmitOrder:", data.json),
+        });
+        return {
+            success: true,
+            data: result.data || null,
+            message: "Successfully",
+        };
+    }
+    catch (error) {
+        const axiosError = error;
+        if (axiosError?.response) {
+            console.log(axiosError.response);
+        }
+        else {
+            console.error("Packages Request Failed:", axiosError);
+        }
+        return {
+            success: false,
+            message: axiosError?.response?.data?.meta?.message || "An error occurred.",
+            data: null,
+        };
+    }
+};
+exports.SubmitOrder = SubmitOrder;
+exports.default = { SubmitOrder: exports.SubmitOrder };

package/dist/package.d.ts

@@ -0,0 +1,14 @@
+import { CountryData } from "./types/package";
+export declare const Packages: () => Promise<{
+    success: boolean;
+    data: CountryData[];
+    message: string;
+}>;
+declare const _default: {
+    Packages: () => Promise<{
+        success: boolean;
+        data: CountryData[];
+        message: string;
+    }>;
+};
+export default _default;

package/dist/package.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Packages = void 0;
+const _1 = require(".");
+const axios_master_1 = require("axios-master");
+const auth_1 = require("./auth");
+const Packages = async () => {
+    try {
+        const result = await (0, axios_master_1.axiosMasterLogger)({
+            method: "GET",
+            maxBodyLength: Infinity,
+            url: `${_1.config.host}/v2/packages`,
+            headers: {
+                Accept: "application/json",
+                "Content-Type": "application/json",
+                Authorization: `Bearer ${_1.config.token}`,
+            },
+        }, {
+            name: "Packages",
+            timeout: 20000,
+            retryFunction: auth_1.getToken,
+            shouldRetry: true,
+            shouldRetryStatus: [401],
+            logger: (data) => _1.config.logger && console.log("Packages:", data.json),
+        });
+        return {
+            success: true,
+            data: result.data || null,
+            message: "Successfully",
+        };
+    }
+    catch (error) {
+        const axiosError = error;
+        if (axiosError?.response) {
+            console.log(axiosError.response);
+        }
+        else {
+            console.error("Packages Request Failed:", axiosError);
+        }
+        return {
+            success: false,
+            message: axiosError?.response?.data?.meta?.message || "An error occurred.",
+            data: null,
+        };
+    }
+};
+exports.Packages = Packages;
+exports.default = { Packages: exports.Packages };

package/dist/types/order.d.ts

@@ -0,0 +1,38 @@
+export type Order = {
+    package_id: string;
+    quantity: string;
+    type: string;
+    description: string;
+    esim_type: string;
+    validity: number;
+    package: string;
+    data: string;
+    price: number;
+    created_at: string;
+    id: number;
+    code: string;
+    currency: string;
+    manual_installation: string;
+    qrcode_installation: string;
+    installation_guides: {
+        [langCode: string]: string;
+    };
+    brand_settings_name: string;
+    sims: Sim[];
+};
+export type Sim = {
+    id: number;
+    created_at: string;
+    iccid: string;
+    lpa: string;
+    imsis: string | null;
+    matching_id: string;
+    qrcode: string;
+    qrcode_url: string;
+    direct_apple_installation_url: string;
+    airalo_code: string | null;
+    apn_type: string;
+    apn_value: string | null;
+    is_roaming: boolean;
+    confirmation_code: string | null;
+};

package/dist/types/order.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/package.d.ts

@@ -0,0 +1,84 @@
+export type CountryData = {
+    slug: string;
+    country_code: string;
+    title: string;
+    image: Image;
+    operators: Operator[];
+};
+type Image = {
+    width: number;
+    height: number;
+    url: string;
+};
+type Operator = {
+    id: number;
+    style: string;
+    gradient_start: string;
+    gradient_end: string;
+    type: string;
+    is_prepaid: boolean;
+    title: string;
+    esim_type: string;
+    warning: string | null;
+    apn_type: string;
+    apn_value: string | null;
+    is_roaming: boolean;
+    info: string[];
+    image: Image;
+    plan_type: string;
+    activation_policy: string;
+    is_kyc_verify: boolean;
+    rechargeability: boolean;
+    other_info: string | null;
+    coverages: Coverage[];
+    install_window_days: number | null;
+    topup_grace_window_days: number | null;
+    apn: {
+        ios: APN;
+        android: APN;
+    };
+    packages: Package[];
+    countries: {
+        country_code: string;
+        title: string;
+        image: Image;
+    }[];
+};
+type Coverage = {
+    name: string;
+    code: string;
+    networks: {
+        name: string;
+        types: string[];
+    }[];
+};
+type APN = {
+    apn_type: string;
+    apn_value: string | null;
+};
+type Package = {
+    id: string;
+    type: string;
+    price: number;
+    amount: number;
+    day: number;
+    is_unlimited: boolean;
+    title: string;
+    short_info: string | null;
+    qr_installation: string;
+    manual_installation: string;
+    is_fair_usage_policy: boolean;
+    fair_usage_policy: string | null;
+    data: string;
+    voice: string | null;
+    text: string | null;
+    net_price: number;
+    prices: {
+        net_price: CurrencyPrice;
+        recommended_retail_price: CurrencyPrice;
+    };
+};
+type CurrencyPrice = {
+    [currency: string]: number;
+};
+export {};

package/dist/types/package.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "airalo-sdk-type",
+  "version": "0.0.1",
+  "description": "UNOFFICIAL AIRALO API INTEGRATION FOR JAVASCRIPT/TYPESCRIPT",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "test": "jest",
+    "build-ts": "npx tsc",
+    "build": "npx tsc",
+    "debug": "npm run build && npm run watch-debug",
+    "lint": "tsc --noEmit && eslint \"**/*.{js,ts}\" --quiet --fix"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/togtokh-dev/airalo.git"
+  },
+  "keywords": [
+    "benefits",
+    "axios",
+    "api",
+    "toki"
+  ],
+  "author": "Buyantogtokh",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/togtokh-dev/airalo/issues"
+  },
+  "homepage": "https://github.com/togtokh-dev/airalo/#readme",
+  "dependencies": {
+    "axios": "^1.6.2",
+    "axios-master": "^2.0.4",
+    "https": "^1.0.0",
+    "node": "^23.4.0"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.14",
+    "@types/node": "^18.19.68",
+    "@typescript-eslint/eslint-plugin": "^6.4.0",
+    "@typescript-eslint/parser": "^6.4.0",
+    "eslint": "^8.47.0",
+    "jest": "^29.5.0",
+    "ts-jest": "^29.1.0",
+    "ts-node": "^10.9.2",
+    "tslib": "^2.6.3",
+    "typescript": "^5.5.4"
+  }
+}