jwero-backend-helpers

Table of Contents

- Installation
- Utility Functions
- Remove Duplicates in an Array
- Example Usage
- Convert object to Array by Structure
- Example Usage
- Remove Falsy Values from Object
- Example Usage
- Integrations
-MSG91
- OTP Functions using MSG91 API
- sendMSG91OTPTemplate(params)
- Example Usage
- verifyMSG91OTPTemplate(params)
- Example Usage
- Order Functions
- createJweroOrder(params)
- Example Usage
- updateJweroOrder(params)
- Example Usage
- fetchJweroOrders(params)
- Example Usage
- Helpers
-Socials
-Email
-Email functions
-sendEmailFromJwero(params)
- Example Usage
-sendEmailFromZeptoMail(params)
- Example Usage
- MySQl Functions
-Table
-getRowsFromTableDynamic(params)
- Example Usage
-deleteRowsFromTableDynamic(params)
- Example Usage
-updateRowsInTableDynamic(params)
- Example Usage
-addRowsInTableDynamic(params)
- Example Usage
-Auth
-authenticateJWT(params)
- Example Usage
-getDBdetailsFromTable(params)
- Example Usage
-getDBInfoFromToken(params)
- Example Usage
-Row
-isValidROwStructure(params)
- Example Usage
-Utils
-encryptWithAES256(params)
- Example Usage
-decryptWithAES256(params)
- Example Usage
- Media
-S3 functions
-uploadS3File(params)
- Example Usage
-getMediaFiles(params)
- Example Usage
-uploadS3Link(params)
- Example Usage
-getFolderNames(params)
- Example Usage
-createNewFolder(params)
- Example Usage
-uploadS3FileFromPath(params)
- Example Usage
-Crm
-function
-getJweroCustomerPhoneNumber
-Example Usage
-chat_users
-utils
-getPhoneNumberFromChatUser(params)
- -Example Usage

installation

``
npm install jwero-backend-helpers

`

Utility functions

Remove Duplicates in an array

removeDuplicates utility function removes duplicates from the array and return the array

Example usage

`
const removeDuplicates = require('./src/removeDuplicates');

const arr = [1, 2, 3, 1, 2, 4, 5, 6, 5];
console.log(removeDuplicates(arr));

`

Convert Object to an Array

converts an object to an array based on a given structure, ensuring that data types match the specified structure.

Example usage

`javascript
const structure = {
name: { data_types: ["string"] },
age: { data_types: ["number"] },
isActive: { data_types: ["boolean"] },
};

const dataObject = {
name: "John Doe",
age: 30,
isActive: true,
};

const arrayResult = convertObjectToArrayByStructure(structure, dataObject);

console.log(arrayResult);

`

Remove Falsy Values from Object

The removeFalsyValuesFromObj function removes falsy values (e.g., false, null, 0, "", undefined, and NaN) from a JavaScript object or array, and returns the cleaned object or array.

Example usage

`
const removeFalsyValuesFromObj = require('./src/javascript/object/index');

const obj = {
a: 1,
b: null,
c: false,
d: "",
e: {
f: "value",
g: 0,
h: undefined
}
};

console.log(removeFalsyValuesFromObj(obj));
// Output: { a: 1, e: { f: "value" } }

`

Integrations

MSG91

OTP Functions using MSG91 API

This repository contains functions for sending and verifying OTP (One-Time Password) using the MSG91 OTP API.

$3

#### sendMSG91OTPTemplate(params)

This function sends an OTP to a mobile number using the MSG91 OTP API.

Parameters:
- template_id: The template ID of the OTP message.
- mobile: The mobile number to which OTP will be sent.
- otp: The OTP (One-Time Password) to be sent.
- authkey: The authentication key for accessing the MSG91 API.

Returns:
- A promise that resolves with the response data from the API.

$3

`javascript

const { sendMSG91OTPTemplate, verifyMSG91OTPTemplate } = require('./src/integrations/msg91/otp/index');

// Sending OTP
sendMSG91OTPTemplate({
template_id: "your_template_id",
mobile: "recipient_mobile_number",
otp: "generated_otp",
authkey: "your_auth_key",
}).then(response => {
console.log("OTP Sent:", response);
}).catch(error => {
console.error("Error sending OTP:", error);
});
`
#### verifyMSG91OTPTemplate(params)

This function verifies an OTP for a mobile number using the MSG91 OTP API.

Parameters:
- otp: The OTP (One-Time Password) to be verified.
- mobile: The mobile number for which OTP was sent.
- authkey: The authentication key for accessing the MSG91 API.

Returns:
- A promise that resolves with the verification result. If an error occurs, it returns false.

$3

`javascript
const { sendMSG91OTPTemplate, verifyMSG91OTPTemplate } = require("'./src/integrations/msg91/otp/index'");

// Verifying OTP
verifyMSG91OTPTemplate({
otp: "entered_otp",
mobile: "recipient_mobile_number",
authkey: "your_auth_key",
}).then(response => {
console.log("OTP Verification Result:", response);
}).catch(error => {
console.error("Error verifying OTP:", error);
});

`

Order functions

This repository contains functions for creating, updating and fetching order

$3

#### createJweroOrder(params)

Creates an order in the JWERO system.

Parameters:

- customer: Details of the customer placing the order.
- line_items: Array of line items in the order.
- meta_data: Additional metadata for the order.
- key: The API key for accessing the JWERO API.
- secret: The API secret for accessing the JWERO API.
- website: The website URL where the JWERO API is hosted.
- token: The authentication token for accessing the JWERO API.
- status: The status of the order (default: "pending").

Returns:
- The created order object if successful, otherwise false.

$3

`javascript
const { createJweroOrder } = require('./src/orders/old/index');

// Creating an order
createJweroOrder({
customer: {
// Customer details
},
line_items: [
// Line items
],
meta_data: [
// Additional metadata
],
key: "your_api_key",
secret: "your_api_secret",
website: "your_website_url",
token: "your_authentication_token",
status: "pending"
}).then(order => {
console.log("Order created:", order);
}).catch(error => {
console.error("Error creating order:", error);
});
`

#### updateJweroOrder(params)

Updates an existing order in the JWERO system.

Parameters:

- payload: The updated payload containing the changes to be applied to the order.
- website: The website URL where the JWERO API is hosted.
- id: The ID of the order to be updated.
- token: The authentication token for accessing the JWERO API.
- key: The API key for accessing the JWERO API.
- secret: The API secret for accessing the JWERO API.

Returns:
- The updated order object if successful, otherwise false.

$3

`javascript
const { updateJweroOrder } = require('./src/orders/old/index');

// Updating an order
updateJweroOrder({
payload: {
// Updated order payload
},
website: "your_website_url",
id: "order_id",
token: "your_authentication_token",
key: "your_api_key",
secret: "your_api_secret"
}).then(updatedOrder => {
console.log("Order updated:", updatedOrder);
}).catch(error => {
console.error("Error updating order:", error);
});
`


#### fetchJweroOrders(params)

Fetches orders from the JWERO system.

Parameters:

- website: The website URL where the JWERO API is hosted.
- token: The authentication token for accessing the JWERO API.
- params: Additional parameters for the request.
- key: The API key for accessing the JWERO API.
- secret: The API secret for accessing the JWERO API.
- payload: Payload data for the request.

Returns:
- The fetched orders if successful, otherwise false.

$3

`javascript
const { fetchJweroOrders } = require('./src/orders/old/index');

// Fetching orders
fetchJweroOrders({
website: "https://yourwebsite.com",
token: "your_authentication_token",
params: {
per_page: 5
},
key: "your_api_key",
secret: "your_api_secret"
}).then(orders => {
console.log("Fetched orders:", orders);
}).catch(error => {
console.error("Error fetching orders:", error);
});
`

Helpers

Socials

Emails

$3

#### sendEmailFromJwero(params)

Function to send emails using Nodemailer

Parameters:

- to: The recipient's email address or an array of objects containing email addresses.
- subject: The subject of the email.
- html: The HTML content of the email.
- text: The plain text content of the email.
- config: Custom configuration for the Nodemailer transporter.
- removeDefaultConfig: If true, the default configuration will be removed.

Returns:
- A promise that resolves with the response data from Nodemailer, either a single response object or an array of response objects if multiple recipients are provided.

$3

`javascript

const { sendEmailFromJwero } = require('./src/helpers/socials/email/index');

// Sending email
sendEmailFromJwero({
to: "recipient@example.com",
subject: "Test Email",
html: "

This is a test email.

",
text: "This is a test email.",
}).then(response => {
console.log("Email sent successfully:", response);
}).catch(error => {
console.error("Error sending email:", error);
});
`


#### sendEmailFromZeptoMail(params)

A function to send emails using ZeptoMail.

Parameters:

- mail_template_key: The template key for the email template to be used.
- variables: Variables to be merged into the email template.
- emails: Array of recipient objects containing email addresses and names.

Returns:
- A promise that resolves when the email has been sent.

$3

`javascript

const { sendEmailFromZeptoMail } = require('./src/helpers/socials/email/zepto_mail');

// Sending email
sendEmailFromZeptoMail({
mail_template_key: "order_confirmation",
variables: {
name: "John Doe",
order_id: "12345"
},
emails: [
{ email: "recipient1@example.com", name: "Recipient 1" },
{ email: "recipient2@example.com", name: "Recipient 2" }
]
}).then(() => {
console.log("Email sent successfully");
}).catch(error => {
console.error("Error sending email:", error);
});


`

MySQL Functions

Table

$3

#### getRowsFromTableDynamic(params)
Retrieves rows from a specified table with dynamic conditions and optional counting.

Parameters:

- db (Object): The database connection object.
- tableName (string): The name of the table to query.
- conditions (Object, optional): Conditions to filter the rows. Default is {}.
- run_again (boolean, optional): Flag to determine if the function should retry on error Default is true.
- createTableQueries (string[]): Array of SQL queries to create missing tables.
- metaTableName (string): The name of the meta table for additional transformations.
- parentCondition (string, optional): The parent condition for combining conditions (e.g., "AND", "OR"). Default is "AND".
- order_by (string, optional): The order by clause for sorting the results.
- getCount (boolean, optional): If true, a count of the total rows is also returned.
- additionalWhereQuery (string, optional): Additional custom WHERE clause for the query.
- metaForeignKey (string, optional): Foreign key for meta table transformations.


Returns:
- Promise: A promise that resolves with the queried rows and optionally the total count.

$3

`javascript

const { getRowsFromTableDynamic } = require('./src/mysql/table/index');

// Example options object
const options = {
db: yourDatabaseConnection, // Replace with your actual DB connection object
tableName: 'users',
conditions: { age: 25 },
run_again: true,
createTableQueries: [
'CREATE TABLE IF NOT EXISTS users (id INT AUTO_INCREMENT PRIMARY KEY, name VARCHAR(255), age INT)'
],
metaTableName: 'meta_users',
parentCondition: 'AND',
order_by: 'age DESC',
getCount: true,
additionalWhereQuery: 'status = "active"',
metaForeignKey: 'user_id'
};

getRowsFromTableDynamic(options)
.then(result => {
console.log(result); // { rows: [...], total: 10 }
})
.catch(error => {
console.error(error);
});

`

#### deleteRowsInTableDynamic(params)
Deletes rows from a specified table based on dynamic conditions.

Parameters:

- db (Object): The database connection object.
- tableName (string): The name of the table from which to delete rows.
- conditions (Object): Conditions to determine which rows to delete. Supports arrays for the 'IN' clause.


Returns:
- Promise