@kumbify/sdk 1.1.5 → 1.2.0

package/README.md

@@ -168,7 +168,8 @@ await smsClient.sendSMS({
 #### Create an OAuth2 Client
 
 ```ts
-const oauthClient = new OAuth2Client({
+
+const oauthClient = new KOAuth2Client({
   clientId: process.env.KUMBIFY_CLIENT_ID,
   clientSecret: process.env.KUMBIFY_CLIENT_SECRET,
   redirectUri: {
@@ -177,7 +178,7 @@ const oauthClient = new OAuth2Client({
   },
   scopes: {
     account: ["profile", "subscription.read"],
-    services: ["gmail.send.email"],
+    service: ["gmail.send.email"],
   },
   api: {
     lang: "pt",

package/dist/clients/kmail/KMailClient.d.ts

@@ -0,0 +1,12 @@
+import { IAPIConfig, IKMailResponseMail, IKMailSendMailSimpleMessage, IKMailSendMailTemplateMessage } from "../../utils/types";
+interface IKMailParams {
+    apiKey: string;
+    api?: IAPIConfig;
+}
+export declare class KMailClient {
+    private config;
+    constructor({ ...data }: IKMailParams);
+    sendSimpleMail({ ...data }: IKMailSendMailSimpleMessage): Promise<IKMailResponseMail>;
+    sendTemplateMail({ ...data }: IKMailSendMailTemplateMessage): Promise<IKMailResponseMail>;
+}
+export {};

package/dist/clients/kmail/KMailClient.js

@@ -0,0 +1,68 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KMailClient = void 0;
+const helpers_1 = require("../../utils/helpers");
+const api_1 = require("../../api/api");
+const APIError_1 = __importDefault(require("../../errors/APIError"));
+class KMailClient {
+    config = {
+        apiKey: "",
+        api: {
+            lang: "pt",
+            version: "v1",
+        },
+    };
+    constructor({ ...data }) {
+        this.config = data;
+    }
+    async sendSimpleMail({ ...data }) {
+        try {
+            const response = await (0, api_1.fetchRequest)({
+                url: helpers_1.APP_CONFIG.KMAIL_URL + "/send",
+                method: "post",
+                body: {
+                    from_address: data.from,
+                    to_address: data.to,
+                    subject: data.subject,
+                    body_html: data.body.html,
+                    body_text: data.body.text,
+                },
+                headers: {
+                    "kumbi-api-key": "Bearer " + this.config.apiKey,
+                    "accept-language": this.config.api.lang,
+                },
+            });
+            return response;
+        }
+        catch (error) {
+            APIError_1.default.CatchError({ error, section: "mail" });
+        }
+    }
+    async sendTemplateMail({ ...data }) {
+        try {
+            const response = await (0, api_1.fetchRequest)({
+                url: helpers_1.APP_CONFIG.KMAIL_URL + "/send",
+                method: "post",
+                body: {
+                    from_address: data.from,
+                    to_address: data.to,
+                    template_name: data.template.name,
+                    template_data: data.template.data,
+                },
+                headers: {
+                    "kumbi-api-key": "Bearer " + this.config.apiKey,
+                    "accept-language": this.config.api.lang,
+                },
+            });
+            return response;
+        }
+        catch (error) {
+            APIError_1.default.CatchError({ error, section: "mail" });
+        }
+    }
+}
+exports.KMailClient = KMailClient;
+//# sourceMappingURL=KMailClient.js.map

package/dist/clients/ksms/KSMSClient.d.ts

@@ -0,0 +1,11 @@
+import { IAPIConfig, IKSMSResponseMessage, IKSMSSendMessage } from "../../utils/types";
+interface IKSMSParams {
+    apiKey: string;
+    api?: IAPIConfig;
+}
+export declare class KSMSClient {
+    private config;
+    constructor({ ...data }: IKSMSParams);
+    sendSMS({ ...data }: IKSMSSendMessage): Promise<IKSMSResponseMessage>;
+}
+export {};

package/dist/clients/ksms/KSMSClient.js

@@ -0,0 +1,44 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KSMSClient = void 0;
+const helpers_1 = require("../../utils/helpers");
+const api_1 = require("../../api/api");
+const APIError_1 = __importDefault(require("../../errors/APIError"));
+class KSMSClient {
+    config = {
+        apiKey: "",
+        api: {
+            lang: "pt",
+            version: "v1",
+        },
+    };
+    constructor({ ...data }) {
+        this.config = data;
+    }
+    async sendSMS({ ...data }) {
+        try {
+            const response = await (0, api_1.fetchRequest)({
+                url: helpers_1.APP_CONFIG.KSMS_URL + "/send",
+                method: "post",
+                body: {
+                    body: data.message,
+                    to: data.to,
+                    from: data.from,
+                },
+                headers: {
+                    "kumbi-api-key": "Bearer " + this.config.apiKey,
+                    "accept-language": this.config.api.lang,
+                },
+            });
+            return response;
+        }
+        catch (error) {
+            APIError_1.default.CatchError({ error, section: "sms" });
+        }
+    }
+}
+exports.KSMSClient = KSMSClient;
+//# sourceMappingURL=KSMSClient.js.map

package/dist/clients/oauth/KOAuth2Client.d.ts

@@ -0,0 +1,49 @@
+import { IAPIConfig, IOAuthUserInfoResponse, IOAuthUserTokenReponse } from "../../utils/types";
+interface IOAuthClientTokenParams {
+    type: "services" | "account";
+    code: string;
+    grant_type: "authorization_code" | "refresh_token";
+    refresh_token?: string;
+    redirect?: IOAuthRedirect;
+    expires_in: "1h" | "1d" | "7d" | "never";
+}
+interface IOAuthRedirect {
+    account?: string;
+    service?: string;
+}
+interface IOAuthScopes {
+    account?: OAuthAccountScopes[];
+    service?: OAuthServiceScopes[];
+}
+interface IOAuthClientProps {
+    clientId: string;
+    clientSecret: string;
+    scopes: IOAuthScopes;
+    redirectUri: IOAuthRedirect;
+    api?: IAPIConfig;
+}
+type OAuthServiceScopes = "gmail.send.email";
+type OAuthAccountScopes = "profile" | "subscription.read";
+export declare class KOAuth2Client {
+    private clientId;
+    private clientSecret;
+    private redirectUri;
+    private scopes;
+    private api;
+    constructor({ clientId, clientSecret, redirectUri, scopes, api, }: IOAuthClientProps);
+    generateOAuthAccountUrl({ state }: {
+        state?: string;
+    }): {
+        url: string;
+    };
+    generateOAuthServiceUrl({ state }: {
+        state?: string;
+    }): {
+        url: string;
+    };
+    generateToken({ ...data }: IOAuthClientTokenParams): Promise<IOAuthUserTokenReponse>;
+    userInfo({ accessToken }: {
+        accessToken: string;
+    }): Promise<IOAuthUserInfoResponse>;
+}
+export {};

package/dist/clients/oauth/KOAuth2Client.js

@@ -0,0 +1,81 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KOAuth2Client = void 0;
+const helpers_1 = require("../../utils/helpers");
+const api_1 = require("../../api/api");
+const APIError_1 = __importDefault(require("../../errors/APIError"));
+class KOAuth2Client {
+    clientId;
+    clientSecret;
+    redirectUri;
+    scopes;
+    api = { lang: "pt", version: "v1" };
+    constructor({ clientId, clientSecret, redirectUri, scopes, api, }) {
+        this.clientId = clientId;
+        this.clientSecret = clientSecret;
+        this.redirectUri = redirectUri;
+        this.scopes = scopes;
+        this.api = api;
+    }
+    generateOAuthAccountUrl({ state }) {
+        const url = `https://kumbify.com/${this.api.lang}/oauth?client_id=${this.clientId}&scopes=${this.scopes.account.join(",")}${state ? `&state=${state}` : ""}&redirect=${this.redirectUri.account}`;
+        return { url };
+    }
+    generateOAuthServiceUrl({ state }) {
+        const url = `https://kumbify.com/${this.api.lang}/oauth/services?client_id=${this.clientId}&scopes=${this.scopes.service.join(",")}${state ? `&state=${state}` : ""}&redirect=${this.redirectUri.service}`;
+        return { url };
+    }
+    async generateToken({ ...data }) {
+        try {
+            const redirectUri = data.redirect
+                ? data.type == "account"
+                    ? data.redirect.account
+                    : data.redirect.service
+                : "";
+            const response = await (0, api_1.fetchRequest)({
+                url: helpers_1.APP_CONFIG.OAUTH.API_BASE_URL + "/u/tokens/generate",
+                method: "post",
+                body: {
+                    code: data.code,
+                    grant_type: data.grant_type,
+                    refresh_token: data.refresh_token,
+                    client_id: this.clientId,
+                    redirect_uri: redirectUri,
+                    expires_in: data.expires_in,
+                },
+                headers: {
+                    "kumbi-app-key": `Bearer ${this.clientSecret}`,
+                    "accept-language": this.api.lang,
+                },
+            });
+            return response;
+        }
+        catch (error) {
+            APIError_1.default.CatchError({ error, section: "oauth" });
+        }
+    }
+    async userInfo({ accessToken }) {
+        try {
+            const response = await (0, api_1.fetchRequest)({
+                url: helpers_1.APP_CONFIG.OAUTH.API_BASE_URL + "/u/me",
+                method: "post",
+                body: {
+                    token: accessToken,
+                },
+                headers: {
+                    "kumbi-app-key": `Bearer ${this.clientSecret}`,
+                    "accept-language": this.api.lang,
+                },
+            });
+            return response;
+        }
+        catch (error) {
+            APIError_1.default.CatchError({ error, section: "oauth" });
+        }
+    }
+}
+exports.KOAuth2Client = KOAuth2Client;
+//# sourceMappingURL=KOAuth2Client.js.map

package/dist/clients/payment/KPaymentClient.d.ts

@@ -0,0 +1,8 @@
+import { IMakeAngolanPaymentParams, IMakeAngolanPaymentResponse, IMakeCryptoPaymentParams, IMakeCryptoPaymentResponse, IMakeStripePaymentParams, IMakeStripePaymentResponse, IPaymentParams } from "./interfaces";
+export declare class KPaymentClient {
+    private config;
+    constructor({ ...data }: IPaymentParams);
+    makeStripePayment({ ...data }: IMakeStripePaymentParams): Promise<IMakeStripePaymentResponse>;
+    makeCryptoPayment({ ...data }: IMakeCryptoPaymentParams): Promise<IMakeCryptoPaymentResponse>;
+    makeAngolanPayment({ ...data }: IMakeAngolanPaymentParams): Promise<IMakeAngolanPaymentResponse>;
+}

package/dist/clients/payment/KPaymentClient.js

@@ -0,0 +1,94 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KPaymentClient = void 0;
+const api_1 = require("../../api/api");
+const helpers_1 = require("../../utils/helpers");
+const APIError_1 = __importDefault(require("../../errors/APIError"));
+class KPaymentClient {
+    config = {
+        apiKey: "",
+        provider: {
+            angolan: {
+                seller: "paypay",
+            },
+            type: "angolan",
+        },
+        api: {
+            lang: "pt",
+            version: "v1",
+        },
+    };
+    constructor({ ...data }) {
+        this.config = data;
+    }
+    async makeStripePayment({ ...data }) {
+        try {
+            const response = await (0, api_1.fetchRequest)({
+                url: `${helpers_1.APP_CONFIG.PAYMENT.API_BASE_URL}/pay/${this.config.provider.international.seller}`,
+                method: "post",
+                body: data,
+                headers: {
+                    "kumbi-api-key": `Bearer ${this.config.apiKey}`,
+                    "accept-language": this.config.api.lang,
+                },
+            });
+            return response;
+        }
+        catch (error) {
+            APIError_1.default.CatchError({ error, section: "payment" });
+        }
+    }
+    async makeCryptoPayment({ ...data }) {
+        try {
+            const response = await (0, api_1.fetchRequest)({
+                url: `${helpers_1.APP_CONFIG.PAYMENT.API_BASE_URL}/pay/${this.config.provider.international.seller}`,
+                method: "post",
+                body: data,
+                headers: {
+                    "kumbi-api-key": `Bearer ${this.config.apiKey}`,
+                    "accept-language": this.config.api.lang,
+                },
+            });
+            return response;
+        }
+        catch (error) {
+            APIError_1.default.CatchError({ error, section: "payment" });
+        }
+    }
+    async makeAngolanPayment({ ...data }) {
+        try {
+            if (this.config.provider.angolan.seller == "paypay" &&
+                data.method == "multicaixa") {
+                let message = {
+                    pt: "O método de pagamento via multicaixa express está indisponível para PayPay",
+                    en: "The Multicaixa Express payment method is unavailable for PayPay",
+                };
+                APIError_1.default.ErrorMessage({
+                    section: "payment",
+                    message: this.config.api.lang == "en" ? message.en : message.pt,
+                });
+            }
+            const url = `${helpers_1.APP_CONFIG.PAYMENT.API_BASE_URL}/pay/${this.config.provider.angolan}`;
+            const response = await (0, api_1.fetchRequest)({
+                url: url,
+                method: "post",
+                body: {
+                    ...data,
+                },
+                headers: {
+                    "kumbi-api-key": `Bearer ${this.config.apiKey}`,
+                    "accept-language": this.config.api.lang,
+                },
+            });
+            return response;
+        }
+        catch (error) {
+            APIError_1.default.CatchError({ error, section: "payment" });
+        }
+    }
+}
+exports.KPaymentClient = KPaymentClient;
+//# sourceMappingURL=KPaymentClient.js.map

package/dist/clients/payment/interfaces.d.ts

@@ -0,0 +1,87 @@
+import { IAPIConfig } from "../../utils/types";
+type EAngolanPaymentProviders = "paypay";
+type EInternationalPaymentProviders = "stripe" | "crypto";
+export interface IPaymentParams {
+    api?: IAPIConfig;
+    apiKey: string;
+    provider: {
+        angolan?: {
+            seller: EAngolanPaymentProviders;
+        };
+        international?: {
+            seller: EInternationalPaymentProviders;
+        };
+        type: "angolan" | "international";
+    };
+}
+export interface IMakeAngolanPaymentParams {
+    amount: number;
+    subject: string;
+    method: "reference" | "multicaixa";
+    transfer?: {
+        iban: string;
+        owner_name: string;
+    };
+    payment?: {
+        customer?: {
+            phone: string;
+        };
+    };
+    transaction: {
+        id: string;
+        type: "payment" | "transfer";
+    };
+}
+export interface IMakeAngolanPaymentResponse {
+    transactionId: string;
+    trade: {
+        entity?: string;
+        reference?: number;
+        timestamp: string;
+        status: "pending" | "success" | "failed";
+    };
+}
+export interface IProduct {
+    amount: number;
+    name?: string;
+    description?: string;
+    quantity: number;
+}
+/**
+ * Stripe Types
+ */
+export type StripeCurrencies = "USD" | "EUR";
+export interface IMakeStripePaymentParams {
+    transactionId: string;
+    customer: {
+        email: string;
+        name: string;
+    };
+    product: IProduct[];
+    redirect: {
+        success_url?: string;
+        cancel_url?: string;
+    };
+    currency: StripeCurrencies;
+}
+export interface IMakeStripePaymentResponse {
+    url: string;
+}
+/**
+ * Crypto types
+ */
+type CryptoCurrencies = "USDC" | "ETH" | "BTC" | "USDT";
+export interface IMakeCryptoPaymentParams {
+    transactionId: string;
+    customer: {
+        email: string;
+        name: string;
+        phone: string;
+    };
+    products: IProduct[];
+    currency: CryptoCurrencies;
+}
+export interface IMakeCryptoPaymentResponse {
+    address: string;
+}
+export {};

package/dist/clients/payment/interfaces.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=interfaces.js.map

package/dist/errors/APIError.d.ts

@@ -1,7 +1,12 @@
 declare class APIError {
+    SectionMessage(section: string): string;
     CatchError({ error, section, }: {
         error: any;
-        section: "mail" | "sms" | "oauth";
+        section: "mail" | "sms" | "oauth" | "payment";
+    }): void;
+    ErrorMessage({ section, message, }: {
+        section: "mail" | "sms" | "oauth" | "payment";
+        message?: string;
     }): void;
 }
 declare const _default: APIError;

package/dist/errors/APIError.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const axios_1 = __importDefault(require("axios"));
 class APIError {
-    CatchError({ error, section, }) {
+    SectionMessage(section) {
         let errorSection = "";
         switch (section) {
             case "mail":
@@ -17,7 +17,14 @@ class APIError {
             case "sms":
                 errorSection = "SMS Service: Failed =>";
                 break;
+            case "payment":
+                errorSection = "Payment Service: Failed =>";
+                break;
         }
+        return errorSection;
+    }
+    CatchError({ error, section, }) {
+        let errorSection = this.SectionMessage(section);
         if (axios_1.default.isAxiosError(error)) {
             const status = error.response?.status;
             const data = error.response?.data;
@@ -25,6 +32,10 @@ class APIError {
         }
         throw new Error(`${errorSection} ${String(error)}`);
     }
+    ErrorMessage({ section, message, }) {
+        let errorSection = this.SectionMessage(section);
+        throw new Error(`${errorSection} ${message}`);
+    }
 }
 exports.default = new APIError();
 //# sourceMappingURL=APIError.js.map

package/dist/index.d.ts

@@ -1,3 +1,4 @@
-export * from "./kmail/KMailClient";
-export * from "./ksms/KSMSClient";
-export * from "./oauth/OAuth2Client";
+export * from "./clients/kmail/KMailClient";
+export * from "./clients/ksms/KSMSClient";
+export * from "./clients/oauth/KOAuth2Client";
+export * from "./clients/payment/KPaymentClient";

package/dist/index.js

@@ -14,7 +14,8 @@ 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("./kmail/KMailClient"), exports);
-__exportStar(require("./ksms/KSMSClient"), exports);
-__exportStar(require("./oauth/OAuth2Client"), exports);
+__exportStar(require("./clients/kmail/KMailClient"), exports);
+__exportStar(require("./clients/ksms/KSMSClient"), exports);
+__exportStar(require("./clients/oauth/KOAuth2Client"), exports);
+__exportStar(require("./clients/payment/KPaymentClient"), exports);
 //# sourceMappingURL=index.js.map

package/dist/utils/helpers.d.ts

@@ -3,7 +3,8 @@ export declare const APP_CONFIG: {
     KMAIL_URL: string;
     OAUTH: {
         API_BASE_URL: string;
-        SERVICE: string;
-        ACCOUNT: string;
+    };
+    PAYMENT: {
+        API_BASE_URL: string;
     };
 };

package/dist/utils/helpers.js

@@ -6,8 +6,9 @@ exports.APP_CONFIG = {
     KMAIL_URL: "https://oi.kumbify.com/api/email",
     OAUTH: {
         API_BASE_URL: "https://8n8.kumbify.com/api/",
-        SERVICE: "https://kumbify.com/pt/oauth/services",
-        ACCOUNT: "https://kumbify.com/pt/oauth",
+    },
+    PAYMENT: {
+        API_BASE_URL: "https://oi.kumbify.com/api/pai",
     },
 };
 //# sourceMappingURL=helpers.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kumbify/sdk",
-  "version": "1.1.5",
+  "version": "1.2.0",
   "description": "Oficial Kumbify SDK to integrate our services in your applications",
   "homepage": "https://github.com/kumbify-oficial/kumbi-sdk#readme",
   "bugs": {