@salespark/mailerlite-api 1.0.1 → 1.0.3

package/README.md

@@ -2,26 +2,26 @@
 
 [MailerLite API v2](https://developers.mailerlite.com/docs/getting-started-with-mailerlite-api) [Node.js](https://nodejs.org/en/) SDK. It is mostly a thin wrapper on [axios](https://github.com/axios/axios) that provides [authentication](https://developers.mailerlite.com/docs/authentication), response/request camelCase transformations, Typescript type definitions and some handy shorthand methods.
 
-## Install
+---
 
-Using npm:
+## 📦 Installation
 
-```
-npm install @salespark/mailerlite-api
-```
+```bash
+yarn add @salespark/mailerlite-api
 
-Using yarn:
+# or
 
-```
-yarn add @salespark/mailerlite-api
+npm install @salespark/mailerlite-api
 ```
 
-## Usage
+---
+
+## 🚀 Usage
 
 In node:
 
 ```javascript
-const MailerLite = require('@salespark/mailerlite-api').default;
+const MailerLite = require('@salespark/mailerlite-api');
 
 const mailerLite = MailerLite('YOUR_API_KEY');
 
@@ -39,7 +39,7 @@ async function getAccountEmail() {
 
 It is important to note that the request is resolved to response body - it does not return the full axios response object.
 
-## Options
+## ⚙️ Options
 
 `axiosOptions`: `object` - additional [axios config](https://github.com/axios/axios#request-config). This config does not overwrite the explicit `baseURL` and `headers` options below.
 
@@ -49,7 +49,7 @@ It is important to note that the request is resolved to response body - it does
 
 `useCaseConverter`: `boolean` - should the library convert all query params, request body and response body to camelCase. Defaults to `true`.
 
-## Method reference
+## 📖 Method reference
 
 For complete reference, visit the [official MailerLite API reference](https://developers.mailerlite.com/reference).
 
@@ -189,20 +189,38 @@ Shorthand that resolves to a Promise<boolean>.
 
 #### `removeWebhook(webhookId)`
 
-## Tests
-
-Tests right now are quite limited, mostly concerned with reading data. To run them, you'll need to create a `config.ts` file and enter your API key in it (as per `config.example.ts`).
-
-```
-npm install
-npm test
-```
-
 ---
 
-###Fixed: CWE-918
+## Fixed: CWE-918
+
 [Server-Side Request Forgery (SSRF)](https://cwe.mitre.org/data/definitions/918.html)  
 [Axios Bug](https://github.com/axios/axios/issues/6463)
 
 Forked from:
 https://github.com/zygos/mailerlite-v2-node
+
+---
+
+### 🔒 Internal Usage Notice
+
+This package is primarily designed and maintained for internal use within the SalesPark ecosystem.
+While it can technically be used in other Node.js/Mongoose projects, no official support or guarantees are provided outside of SalesPark-managed projects.
+
+All code follows the same engineering standards applied across the SalesPark platform, ensuring consistency, reliability, and long-term maintainability of our internal systems.
+
+⚡ Note: This package is most efficient and works best when used together with other official SalesPark packages, where interoperability and optimizations are fully leveraged.
+
+Disclaimer: This software is provided “as is”, without warranties of any kind, express or implied. SalesPark shall not be held liable for any issues, damages, or losses arising from its use outside the intended SalesPark environment.
+
+Organization packages: https://www.npmjs.com/org/salespark
+
+---
+
+## 📄 License
+
+MIT © [SalesPark](https://salespark.io)
+
+---
+
+_Document version: 2_  
+_Last update: 21-08-2025_

package/dist/index.d.ts

@@ -1,61 +1 @@
-import { Options } from './@types';
-export default function MailerLite(apiKey: string, options?: Options): {
-    getWebhooks(): Promise<any[]>;
-    getWebhooksCount(): Promise<number>;
-    getWebhooksRaw(): Promise<import("./@types").WebhooksResponse>;
-    getWebhook(webhookId: number): Promise<import("axios").AxiosResponse<any, any>>;
-    createWebhook(webhook: import("./@types").WebhookData): Promise<import("axios").AxiosResponse<any, any>>;
-    updateWebhook(webhookId: number, webhook: import("./@types").WebhookData): Promise<import("axios").AxiosResponse<any, any>>;
-    removeWebhook(webhookId: number): Promise<import("axios").AxiosResponse<any, any>>;
-    getTimezones(): Promise<import("./@types").Timezone>;
-    getTimezone(timezoneId: number): Promise<import("./@types").Timezone>;
-    getSubscribers(params?: import("./@types").SubscriberQuery): Promise<import("axios").AxiosResponse<any, any>>;
-    addSubscriber(subscriber: import("./@types").SubscriberData): Promise<import("axios").AxiosResponse<any, any>>;
-    getSubscriber(identifier: number | string): Promise<import("axios").AxiosResponse<any, any>>;
-    updateSubscriber(identifier: number | string, subscriber: import("./@types").SubscriberDataUpdate): Promise<import("axios").AxiosResponse<any, any>>;
-    searchSubscribers(params?: import("./@types").SubscriberSearchQuery): Promise<import("axios").AxiosResponse<any, any>>;
-    getSubscriberActivity(identifier: number | string): Promise<import("axios").AxiosResponse<any, any>>;
-    getSubscriberActivityByType(identifier: number | string, activityType: import("./@types").SubscriberActivityType): Promise<import("axios").AxiosResponse<any, any>>;
-    getSubscriberGroups(identifier: number | string): Promise<import("axios").AxiosResponse<any, any>>;
-    removeSubscriber(identifier: number | string): Promise<import("axios").AxiosResponse<any, any>>;
-    getStats(): Promise<import("./@types").Stats>;
-    getDoubleOptinStatus(): Promise<import("./@types").DoubleOptinStatus>;
-    hasEnabledDoubleOptin(): Promise<boolean>;
-    setDoubleOptin(isEnabled: boolean): Promise<import("./@types").DoubleOptinStatus>;
-    enableDoubleOptin(): Promise<import("./@types").DoubleOptinStatus>;
-    disableDoubleOptin(): Promise<import("./@types").DoubleOptinStatus>;
-    getSegments(params?: import("./@types").SegmentQuery): Promise<any[]>;
-    getSegmentsCount(params?: import("./@types").SegmentQuery): Promise<number>;
-    getSegmentsRaw(params?: import("./@types").SegmentQuery): Promise<import("./@types").SegmentsResponse>;
-    getGroups(params?: import("./@types").GroupQuery): Promise<import("./api/groups").MailerLiteGroup[]>;
-    searchGroups(groupName: import("./@types").GroupSearchQuery["group_name"]): Promise<import("./api/groups").MailerLiteGroup[]>;
-    getGroup(groupId: number): Promise<import("./api/groups").MailerLiteGroup>;
-    createGroup(group: import("./@types").GroupData): Promise<import("./api/groups").MailerLiteGroup>;
-    updateGroup(groupId: number, groupUpdate: import("./@types").GroupData): Promise<import("axios").AxiosResponse<any, any>>;
-    removeGroup(groupId: number): Promise<{
-        success: boolean;
-    }>;
-    addSubscriberToGroup(groupId: number, subscriber: import("./@types").GroupSubscriberData): Promise<import("axios").AxiosResponse<any, any>>;
-    addSubscribersToGroup(groupId: number, subscribers: import("./@types").GroupSubscriberData[], importOptions?: import("./@types").GroupSubscriberFlags): Promise<import("axios").AxiosResponse<any, any>>;
-    getSubscribersGroupImport(groupId: number, importId: number): Promise<import("axios").AxiosResponse<any, any>>;
-    getGroupSubscriber(groupId: number, subscriberId: number): Promise<import("axios").AxiosResponse<any, any>>;
-    getGroupSubscribers(groupId: number, params?: import("./@types").SubscriberGroupQuery): Promise<import("axios").AxiosResponse<any, any>>;
-    getGroupSubscriberCount(groupId: number): Promise<number>;
-    getGroupSubscribersByType(groupId: number, subscriberType: import("./@types").SubscriberType, params?: import("./@types").GroupQuery): Promise<import("axios").AxiosResponse<any, any>>;
-    getGroupSubscribersCountByType(groupId: number, subscriberType: import("./@types").SubscriberType): Promise<number>;
-    removeGroupSubscriber(groupId: number, subscriberIdentifier: number | string): Promise<string>;
-    getFields(): Promise<import("axios").AxiosResponse<any, any>>;
-    createField(field: import("./@types").FieldData): Promise<import("axios").AxiosResponse<any, any>>;
-    updateField(fieldId: number, fieldUpdate: import("./@types").FieldUpdate): Promise<import("axios").AxiosResponse<any, any>>;
-    removeField(fieldId: number): Promise<import("axios").AxiosResponse<any, any>>;
-    actOnCampaign(campaignId: number, action: import("./@types").CampaignAction, data?: import("./@types").CampaignSendData): Promise<import("axios").AxiosResponse<any, any>>;
-    getCampaigns(status?: import("./@types").CampaignStatus, params?: import("./@types").CampaignQuery): Promise<import("axios").AxiosResponse<any, any>>;
-    getCampaignCount(status?: import("./@types").CampaignStatus): Promise<number>;
-    createCampaign(campaign: import("./@types").CampaignData): Promise<import("axios").AxiosResponse<any, any>>;
-    removeCampaign(campaignId: number): Promise<import("axios").AxiosResponse<any, any>>;
-    setCampaignContent(campaignId: number, content: import("./@types").CampaignContent): Promise<import("axios").AxiosResponse<any, any>>;
-    batch(requests: import("./@types").Batch[]): Promise<any[]>;
-    getAccountRaw(): Promise<import("./@types").AccountWrap>;
-    getAccount(): Promise<import("./@types").Account>;
-    getMe(): Promise<import("./@types").Account>;
-};
+export {};

package/dist/index.js

@@ -14,7 +14,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = MailerLite;
 var client_1 = __importDefault(require("./client"));
 var account_1 = __importDefault(require("./api/account"));
 var batch_1 = __importDefault(require("./api/batch"));
@@ -32,3 +31,4 @@ function MailerLite(apiKey, options) {
     var client = (0, client_1.default)(apiKey, options);
     return __assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign({}, (0, account_1.default)(client)), (0, batch_1.default)(client)), (0, campaigns_1.default)(client)), (0, fields_1.default)(client)), (0, groups_1.default)(client)), (0, segments_1.default)(client)), (0, settings_1.default)(client)), (0, stats_1.default)(client)), (0, subscribers_1.default)(client)), (0, timezones_1.default)(client)), (0, webhooks_1.default)(client));
 }
+module.exports = MailerLite;

package/package.json

@@ -1,17 +1,18 @@
 {
   "name": "@salespark/mailerlite-api",
-  "version": "1.0.1",
+  "description": "MailerLite API v2 Node.js SDK. It is mostly a thin wrapper on axios that provides authentication, response/request camelCase transformations, Typescript type definitions and some handy shorthand methods.",
+  "version": "1.0.3",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
-    "test": "npx jest --config jest.config.js",
-    "test:watch": "npx jest --config jest.config.js --watch",
     "lint": "npx eslint ./src --ext .ts,.tsx",
+    "clean": "rimraf dist",
     "lint:fix": "npx eslint ./src --fix --ext .ts,.tsx",
     "build": "tsc && cp -r src/@types dist",
-    "prepare": "npm run build"
+    "prepare": "npm run build",
+    "prepublishOnly": "yarn run clean && yarn run build"
   },
-  "author": "FBlade <dev@salespark.io>",
+  "author": "SalesPark",
   "license": "MIT",
   "dependencies": {
     "axios": "^1.10.0",
@@ -19,7 +20,6 @@
     "snakecase-keys": "^8.0.1"
   },
   "devDependencies": {
-    "@types/jest": "^30.0.0",
     "@types/node": "^24.0.6",
     "@typescript-eslint/eslint-plugin": "^8.35.0",
     "@typescript-eslint/parser": "^8.35.0",
@@ -30,20 +30,8 @@
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^7.2.1",
     "eslint-plugin-standard": "^5.0.0",
-    "husky": "^9.1.7",
-    "jest": "^30.0.3",
-    "jest-extended": "^6.0.0",
-    "ts-jest": "^29.4.0",
-    "typescript": "^5.3.3"
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "npm test",
-      "pre-push": "npm test"
-    }
-  },
-  "directories": {
-    "test": "test"
+    "typescript": "^5.3.3",
+    "rimraf": "^6.0.1"
   },
   "homepage": "https://salespark.io",
   "repository": {
@@ -53,7 +41,8 @@
   "keywords": [
     "mailerlite",
     "node",
-    "api"
+    "api",
+    "salespark"
   ],
   "files": [
     "dist/**/*"