@stashfin/mysql2 1.4.35 → 1.4.37

package/README.md

@@ -0,0 +1,55 @@
+# MySQL Package
+
+This is a local package for MySQL database operations.
+
+### Installation
+
+To install this package, run the following command in your terminal:
+
+```bash
+npm install @stashfin/mysql2
+```
+
+### Table Interface
+
+The package includes a table interface located in the model folder. This interface defines the structure of the tables in the MySQL database.
+
+````
+
+## Table Interface (model/table.ts)
+
+```typescript
+export interface Table {
+  id: number;
+  name: string;
+  // Add other table fields here
+}
+
+export interface TableModel extends Table, RowDataPacket {}
+
+````
+
+### Local Development
+
+To publish this package locally for development purposes, run the following command in your terminal:
+
+```
+npm run build
+cd dist
+npm link
+```
+
+### Production Package Publish
+
+To publish this package, run the following command in your terminal:
+
+```
+npm run publish:patch
+```
+
+### Generate the Interfaces from mysql table
+
+```
+npx mysql-schema-ts mysql://root:root123@localhost/stashfin --table journey_steps
+npx mysql-schema-ts mysql://root:root123@localhost/stashfin --table journey_steps > src/models/JourneySteps.ts
+```

package/dist/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@stashfin/mysql2",
+  "version": "1.4.35",
+  "description": "",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc --build",
+    "build:ws": "tsc --build && copy package.json dist/",
+    "postbuild": "cp package.json dist/ ",
+    "publish:patch": "npm version patch && npm run build && cd dist && npm publish --access public",
+    "publish:minor": "npm version minor && npm run build && cd dist && npm publish --access public"
+  },
+  "keywords": [],
+  "author": "Yogesh Randive",
+  "license": "ISC",
+  "dependencies": {
+    "mysql2": "^3.9.9"
+  },
+  "devDependencies": {
+    "cpy-cli": "^5.0.0"
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stashfin/mysql2",
-  "version": "1.4.35",
+  "version": "1.4.37",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/index.ts

@@ -0,0 +1,128 @@
+import mysql, {
+  Pool,
+  RowDataPacket,
+  PoolOptions,
+  ResultSetHeader,
+} from 'mysql2';
+
+// define options
+export interface MysqlConnectorOptions extends PoolOptions {}
+
+//define class
+export class MysqlConnector {
+  private pool: Pool;
+  private credentials: PoolOptions;
+
+  constructor(credentials: PoolOptions) {
+    this.credentials = credentials;
+    this.pool = mysql.createPool(this.credentials);
+  }
+
+  /** A random method to simulate a step before to get the class methods */
+  public getPoolConnection() {
+    if (!this?.pool) this.pool = mysql.createPool(this.credentials);
+    return this.pool;
+  }
+
+  public getConnection() {
+    if (!this?.pool) this.pool = mysql.createPool(this.credentials);
+    return this.pool.promise().getConnection();
+  }
+
+  public async queryRow<T extends RowDataPacket>(
+    sql: string,
+    values?: Array<string | number>,
+  ): Promise<T | undefined> {
+    const pool = this.getPoolConnection();
+
+    return new Promise((resolve, reject) => {
+      pool.query<T[]>(sql, values, function (err, results, fields) {
+        if (err) reject(err);
+        // Connection is automatically released when query resolves
+        else resolve(results[0] || undefined);
+      });
+    });
+  }
+
+  public async queryRows<T extends RowDataPacket>(
+    sql: string,
+    values?: Array<string | number>,
+  ): Promise<T[]> {
+    const pool = this.getPoolConnection();
+    return new Promise((resolve, reject) => {
+      pool.query<T[]>(sql, values, function (err, results, fields) {
+        // Connection is automatically released when query resolves
+        if (err) reject(err);
+        else resolve(results);
+      });
+    });
+  }
+
+  public async queryArray<T extends RowDataPacket>(
+    sql: string,
+    values?: Array<string | number>,
+  ): Promise<T[]> {
+    const pool = this.getPoolConnection();
+    return new Promise((resolve, reject) => {
+      pool.query<T[]>(
+        { sql, values, rowsAsArray: true },
+        function (err, results, fields) {
+          // Connection is automatically released when query resolves
+          if (err) reject(err);
+          else resolve(results);
+        },
+      );
+    });
+  }
+
+  public async executeResult(
+    sql: string,
+    values?: unknown[],
+  ): Promise<ResultSetHeader> {
+    const pool = this.getPoolConnection();
+
+    return new Promise((resolve, reject) => {
+      pool.query<ResultSetHeader>(sql, values, function (err, results, fields) {
+        // Connection is automatically released when query resolves
+        if (err) reject(err);
+        else resolve(results || undefined);
+      });
+    });
+  }
+
+  public async insertData(
+    tableName: string,
+    data: Record<string, string | number>,
+  ): Promise<ResultSetHeader> {
+    const keys = Object.keys(data);
+    const values = Object.values(data);
+
+    const sql = `INSERT INTO ${tableName} (${keys.join(', ')}) VALUES (${keys
+      .map(() => '?')
+      .join(', ')})`;
+
+    return this.executeResult(sql, values);
+  }
+
+  public async updateData(
+    tableName: string,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    data: Record<string, any>,
+    condition: string,
+    conditionValues?: Array<string | number>,
+  ): Promise<ResultSetHeader> {
+    const keys = Object.keys(data);
+    const values = Object.values(data);
+
+    const sql = `UPDATE ${tableName} SET ${keys
+      .map((key) => `${key} = ?`)
+      .join(', ')} WHERE ${condition}`;
+
+    const finalValues = [...values, ...(conditionValues || [])];
+    return this.executeResult(sql, finalValues);
+  }
+
+  public async close() {
+    await this.pool.end();
+  }
+}

package/src/indexPromise.ts

@@ -0,0 +1,112 @@
+import mysql, {
+  Pool,
+  RowDataPacket,
+  PoolOptions,
+  ResultSetHeader,
+} from 'mysql2/promise';
+
+// define options
+export interface MysqlConnectorOptions extends PoolOptions {}
+
+//define class
+export class MysqlConnector {
+  private pool: Pool;
+  private credentials: PoolOptions;
+
+  constructor(credentials: PoolOptions) {
+    this.credentials = credentials;
+    this.pool = mysql.createPool(this.credentials);
+  }
+
+  /** A random method to simulate a step before to get the class methods */
+  public getConnection() {
+    if (!this?.pool) this.pool = mysql.createPool(this.credentials);
+    return this.pool.getConnection();
+  }
+
+  public async queryRow<T extends RowDataPacket>(
+    sql: string,
+    values?: Array<string | number>,
+  ): Promise<T | undefined> {
+    const connection = await this.getConnection();
+    const [rows] = await connection.query<T[]>(sql, values);
+    await connection.release();
+    return rows[0] || undefined;
+  }
+
+  public async queryRows<T extends RowDataPacket>(
+    sql: string,
+    values?: Array<string | number>,
+  ): Promise<T[]> {
+    const connection = await this.getConnection();
+
+    const [rows] = await connection.query<T[]>(sql, values);
+
+    await connection.release();
+    return rows;
+  }
+
+  public async queryArray<T extends RowDataPacket>(
+    sql: string,
+    values?: Array<string | number>,
+  ): Promise<T[]> {
+    const connection = await this.getConnection();
+
+    const [rows] = await connection.query<T[]>({
+      sql,
+      values,
+      rowsAsArray: true,
+    });
+
+    await connection.release();
+    return rows;
+  }
+
+  public async executeResult(
+    sql: string,
+    values?: unknown[],
+  ): Promise<ResultSetHeader> {
+    const connection = await this.pool.getConnection();
+
+    const [rows] = await connection.query<ResultSetHeader>(sql, values);
+
+    await connection.release();
+    return rows;
+  }
+
+  public async insertData(
+    tableName: string,
+    data: Record<string, string | number>,
+  ): Promise<ResultSetHeader> {
+    const keys = Object.keys(data);
+    const values = Object.values(data);
+
+    const sql = `INSERT INTO ${tableName} (${keys.join(', ')}) VALUES (${keys
+      .map(() => '?')
+      .join(', ')})`;
+
+    return this.executeResult(sql, values);
+  }
+
+  public async updateData(
+    tableName: string,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    data: Record<string, any>,
+    condition: string,
+    conditionValues?: Array<string | number>,
+  ): Promise<ResultSetHeader> {
+    const keys = Object.keys(data);
+    const values = Object.values(data);
+
+    const sql = `UPDATE ${tableName} SET ${keys
+      .map((key) => `${key} = ?`)
+      .join(', ')} WHERE ${condition}`;
+
+    const finalValues = [...values, ...(conditionValues || [])];
+    return this.executeResult(sql, finalValues);
+  }
+
+  public async close() {
+    await this.pool.end();
+  }
+}

package/src/models/BBPSCustomerBillProviders.ts

@@ -0,0 +1,27 @@
+import { RowDataPacket } from 'mysql2';
+
+export interface CustomerParams {
+    name: string;
+    value: string;
+  }
+  export type CustomerParamsArray = CustomerParams[];
+
+export interface BBPSCustomerBillProviderTable {
+    id: number;
+    customer_id: number;
+    biller_id: string;
+    utility_id: number;
+    utility_name: string;
+    provider_name: string;
+    provider_logo: string;
+    customer_name: string;
+    account_no: number;
+    bill_amount: number;
+    bill_number: string;
+    customer_params: CustomerParamsArray;
+    bill_date: Date;
+    created_at: Date;
+    updated_at: Date;
+  }
+
+export interface BBPSCustomerBillProviderModel extends BBPSCustomerBillProviderTable, RowDataPacket {}

package/src/models/BBPSProviders.ts

@@ -0,0 +1,24 @@
+import { RowDataPacket } from 'mysql2';
+
+export type JSONPrimitive = string | number | boolean | null;
+export type JSONValue = JSONObject | JSONArray;
+export type JSONObject = { [member: string]: JSONPrimitive };
+export type JSONArray = Array<JSONValue>;
+
+export interface BBPSProvidersTable {
+    id: number;
+    name: string;
+    alias: string;
+    logo: string;
+    state: string;
+    customer_params: JSONValue;
+    utilityid: number;
+    vendorid: number;
+    billerid: string;
+    created_at: Date;
+    updated_at: Date;
+    is_active: number;
+    is_deleted: number;
+}
+
+export interface BBPSProvidersModel extends BBPSProvidersTable, RowDataPacket {}

package/src/models/BBPSTransactions.ts

@@ -0,0 +1,28 @@
+import { RowDataPacket } from 'mysql2';
+
+export interface BBPSTransactionsTable {
+    id: number;
+    customerid: number;
+    utilityid: number;
+    providerid: number;
+    account: string;
+    billamount: number;
+    amount: number;
+    discount: number;
+    promo: string;
+    duedate: Date;
+    status: string;
+    mode: string;
+    paymentid: string;
+    txnid: string;
+    attempted_at: Date;
+    paid_at: Date;
+    processed_at: Date;
+    created_at: Date;
+    updated_at: Date;
+    is_due: number;
+    is_active: number;
+    is_deleted: number;
+  }
+
+  export interface BBPSTransactionsModel extends BBPSTransactionsTable, RowDataPacket {}

package/src/models/BBPSUtilities.ts

@@ -0,0 +1,14 @@
+import { RowDataPacket } from 'mysql2';
+
+export interface BBPSUtilitiesTable {
+    id: number;
+    name: string;
+    logo: string;
+    vendorid: number;
+    created_at: Date;
+    updated_at: Date;
+    is_active: number;
+    is_deleted: number;
+}
+
+export interface BBPSUtilitiesModel extends BBPSUtilitiesTable, RowDataPacket {}

package/src/models/BBPSVendor.ts

@@ -0,0 +1,12 @@
+import { RowDataPacket } from 'mysql2';
+
+export interface BBPSVendorsTable {
+    id: number;
+    name: string;
+    created_at: Date;
+    updated_at: Date;
+    is_active: number;
+    is_deleted: number;
+}
+
+export interface BBPSVendorsModel extends BBPSVendorsTable, RowDataPacket {}

package/src/models/Common.ts

@@ -0,0 +1,21 @@
+export interface Rule {
+    key: string;
+    value: string | number;
+    operator: string;
+}
+
+export interface Rules {
+    data: Rule[];
+}
+
+export interface MetaData {
+    icon: string;
+    title: string;
+    eligibilityCriteria: string;
+    steps: string[]
+}
+
+export interface Stat {
+    count: number;
+    total: number;
+}

package/src/models/Customer.ts

@@ -0,0 +1,169 @@
+import { RowDataPacket } from 'mysql2';
+export type JSONPrimitive = string | number | boolean | null;
+export type JSONValue = JSONObject | JSONArray;
+export type JSONObject = { [member: string]: JSONPrimitive };
+export type JSONArray = Array<JSONValue>;
+
+// Interface for the customers table
+export interface CustomerTable {
+  id: number;
+  mobile: string;
+  email?: string | null;
+  first_name?: string | null;
+  middle_name?: string | null;
+  last_name?: string | null;
+  father_name?: string | null;
+  mother_maiden_name?: string | null;
+  dob?: Date | null;
+  company_name?: string | null;
+  official_email?: string | null;
+  pincode?: string | null;
+  mpin?: string | null;
+  pan?: string | null;
+  aadhaar?: string | null;
+  mobile_verified?: number | null;
+  email_verified?: number | null;
+  ip?: string | null;
+  device_id?: string | null;
+  is_registered?: number | null;
+  mobile_hash?: string | null;
+  email_hash?: string | null;
+  os_version?: string | null;
+  push_id?: string | null;
+  auth_token?: string | null;
+  app_version?: string | null;
+  biometric_enabled?: number | null;
+  journey_sequence?: number | null;
+  category?: string | null;
+  loc_limit?: number | null;
+  /**  Defaults to: active. */
+  status?: 'active' | 'inactive' | null;
+  source?: string | null;
+  tnc_version?: string | null;
+  login_date?: Date | null;
+  min_tenure?: number | null;
+  max_tenure?: number | null;
+  roi?: number | null;
+  processing_rate?: number | null;
+  agent_id?: number | null;
+  /** Defaults to: new  */
+  application_type?: string | null;
+  /** Defaults to: incomplete  */
+  application_status?: string | null;
+  /** Defaults to: organic */
+  customer_type?: string | null;
+  /**  Defaults to: CURRENT_TIMESTAMP. */
+  created_at?: Date | null;
+  /**  Defaults to: CURRENT_TIMESTAMP. */
+  updated_at?: Date | null;
+  /**  Defaults to: 1. */
+  is_active?: number | null;
+  /**  Defaults to: 0. */
+  is_deleted?: number | null;
+  journey_updated_at?: Date | null;  
+}
+
+// Interface for the demographics table
+export interface DemographicsTable {
+  id?: number;
+  customer_id: number;
+  aadhaar_name?: string | null;
+  crn?: string | null;
+  device?: JSONValue | null;
+  gender?: string | null;
+  gst_no?: string | null;
+  language?: string | null;
+  latitude?: number | null;
+  longitude?: number | null;
+  marital_status?: string | null;
+  occupation?: string | null;
+  office_addr?: JSONValue | null;
+  organization?: string | null;
+  pan_url?: string | null;
+  perm_addr?: JSONValue | null;
+  res_addr?: JSONValue | null;
+  salary?: number | null;
+  salary_date?: Date | null;
+  salary_mode?: string | null;
+  selfie_url?: string | null;
+  kyc_type?: string | null;
+  emi_date?: Date | null;
+  phone_matched?: number | null;
+  dob_matched?: number | null;
+  /**  Defaults to: CURRENT_TIMESTAMP. */
+  created_at?: Date | null;
+  updated_at?: Date | null;
+  nsdl_dob_matched?: number | null;  
+  okyc_dob?: string | null;          
+  dob_attempts?: number | null;      
+  is_upgradable?: number | null;     
+  has_imps?: number | null;          
+  journey_inactive?: number | null;  
+  repeat_journey?: number | null;  
+}
+
+export interface CustomerBanksTable {
+  id?: number;
+  customer_id: number;
+  account_number: string;
+  address?: string | null;
+  bank_name?: string | null;
+  ifsc_code?: string | null;
+  /**  Defaults to: active. */
+  status?: 'active' | 'inactive';
+  is_primary?: boolean;
+  /**  Defaults to: CURRENT_TIMESTAMP. */
+  created_at?: Date | null;
+  updated_at?: Date | null;
+}
+export interface CustomerReferenceTable {
+  id: number;
+  customer_id: number;
+  reference_name: string;
+  relationship: 'Family' | 'Friend' | 'Colleague' | 'Other';
+  mobile_number: string;
+  email?: string;
+  address: string;
+  state_id: number;
+  city_id: number;
+  pincode: string;
+  created_at?: Date | null;
+}
+
+export interface CustomerDocumentsTable {
+  id?: number;
+  customer_id?: number | null;
+  pan_url?: string | null;
+  aadhaar_url?: string | null;
+  address_proof_url?: string | null;
+  created_at?: Date | null;
+  updated_at?: Date | null;
+}
+
+// Interface for the customer_device_history table
+export interface CustomerDeviceHistoryTable {
+  id: number;
+  customer_id: number;
+  device?: string | null;
+  device_id: string;
+  ip?: string | null;
+  os_version?: string | null;
+  push_id?: string | null;
+  app_version?: string | null;
+  is_rooted?: boolean;
+  created_at?: Date | null;
+  updated_at?: Date | null;
+}
+
+// MySQL-specific interfaces extending RowDataPacket
+export interface CustomerModel extends CustomerTable, RowDataPacket { }
+export interface CustomerBanksModel extends CustomerBanksTable, RowDataPacket { }
+export interface CustomerDocumentsModel
+  extends CustomerDocumentsTable,
+  RowDataPacket { }
+export interface DemographicsModel extends DemographicsTable, RowDataPacket { }
+export interface CustomerReferenceModel
+  extends CustomerReferenceTable,
+  RowDataPacket { }
+
+  export interface CustomerDeviceHistoryModel extends CustomerDeviceHistoryTable, RowDataPacket {} 

package/src/models/DashboardBlock.ts

@@ -0,0 +1,32 @@
+import { RowDataPacket } from 'mysql2';
+export type JSONPrimitive = string | number | boolean | null;
+export type JSONValue = JSONObject | JSONArray;
+export type JSONObject = { [member: string]: JSONPrimitive };
+export type JSONArray = Array<JSONValue>;
+
+export interface DashboardBlock {
+  block_name: string;
+  block_title: string;
+  block_code: string;
+  text: string; 
+  sub_text: string;
+  image_url: string;
+  video_url?: string;
+  video_length?: number;
+  action_url?: string;
+  landing_page?: string;
+  api_mode?: string;
+  app_version: string;
+  old_customers: boolean;
+  is_new?: boolean;
+  action_type?: string;
+  color1?: string;
+  color2?: string;
+  image_trailing?: string;
+  tag?: JSONValue ;
+  overlay_image?: string;
+ 
+}
+
+
+export interface DashboardBlockModel extends DashboardBlock, RowDataPacket {}

package/src/models/Installments.ts

@@ -0,0 +1,37 @@
+import { RowDataPacket } from 'mysql2';
+export type JSONPrimitive = string | number | boolean | null;
+export type JSONValue = JSONObject | JSONArray;
+export type JSONObject = { [member: string]: JSONPrimitive };
+export type JSONArray = Array<JSONValue>;
+
+// Interface for the Installments table
+export interface InstallmentsTable {
+  id?: number | null;
+  customer_id: number | null;
+  loan_id?: number | null;
+  seq_no: number | null;
+  amount?: number | null;
+  principal?: number | null;
+  interest?: number | null;
+  penalty?: number | null;
+  r_principal?: number | null;
+  r_interest?: number | null;
+  r_penalty?: number | null;
+  r_pif_principal?: number | null;
+  r_pif_interest?: number | null;
+  r_pif_penalty?: number | null;
+  status?: 'active' | 'closed' | 'delayed' | 'paid' | 'future' | null;
+  dpd?: number | null;
+  due_date?: Date | null;
+  discount?: number | null;
+  starting_balance?: number | null;
+  ending_balance?: number | null;
+  closed_at?: Date | null;
+  created_at?: Date | null;
+  updated_at?: Date | null;
+  is_active?: number | null;
+  is_deleted?: number | null;
+}
+
+// MySQL-specific interfaces extending RowDataPacket
+export interface InstallmentsModel extends InstallmentsTable, RowDataPacket {}