@ariary/notification 3.0.1 → 3.0.2

package/README.md

@@ -1,56 +1,102 @@
+# @ariary/notification
 
-Simple SDK for sending SMS notifications.
+SMS and notification task SDK for the Ariary API.
 
-## Installation
+## Install
 
 ```bash
-npm install @ariary/notification
+yarn add @ariary/notification
 ```
 
-## Imports
+## Setup
 
-```typescript
-import { Ariari, Task } from '@ariary/notification';
-```
-## Configuration
+```ts
+import Ariari from '@ariary/notification'
 
-```typescript
 Ariari.config({
   projectId: 'your-project-id',
-  secretId: 'your-secret-id'
-});
+  secret: 'your-secret',
+})
 ```
 
-## Send Messages
+## Send SMS
+
+`Ariari.send()` accepts one or more messages. Phone numbers are automatically normalized (`+261340000000`, `261340000000`, `0340000000` all work).
+
+```ts
+// single recipient
+const task = await Ariari.send({ phone: '0340000000', message: 'Hello!' })
 
-```typescript
+// multiple recipients, same message
+const task = await Ariari.send({ phone: ['0340000000', '0330000000'], message: 'Hello!' })
+
+// multiple messages at once
 const task = await Ariari.send(
-  { phone: '+261123456789', message: 'Message 1' },
-  { phone: ['+261987654321', '+261555555555'], message: 'Message 2' }
-);
+  { phone: '0340000000', message: 'Hello!' },
+  { phone: '+261330000000', message: 'Hi there!' }
+)
+```
+
+## Track a Task
+
+`send()` returns a `Task` object. Call `.status()` to check delivery progress.
+
+```ts
+const task = await Ariari.send({ phone: '0340000000', message: 'Hello!' })
+
+// status counters only
+const status = await task.status()
+// { total: 1, sent: 1, failed: 0, delivered: 1 }
+
+// status + all SMS details
+const details = await task.status(100)
+// { task: { _id, status, createdAt, ... }, sms: [{ smsId, phone, message, status, retryCount }], total: 1 }
+
+// paginated: 20 per page, page 2
+const page2 = await task.status(20, 2)
 ```
 
-## Check Task Status
+SMS statuses: `SCHEDULED` | `PENDING` | `SENT` | `DELIVERED` | `FAILED`
+
+## Retrieve an existing Task
 
-```typescript
-const status = await task.status();
-// Returns TaskSummary: { total: 1, sent: 1, failed: 0, pending: 0 }
+Store `task.id` to retrieve it later with `.getTask()`.
 
-const details = await task.smsDetails();
-// Returns TaskDetails object with notifTaskId, projectId, summary, smsDetails array, and createdAt
+```ts
+// after sending
+const task = await Ariari.send({ phone: '0340000000', message: 'Hello!' })
+const taskId = task.id // save this
+
+// later
+const task = await Ariari.getTask(taskId)
+const status = await task.status()
 ```
 
-## List Tasks
+## Multiple instances
+
+Use `name` to manage separate Ariari instances with different credentials. `Ariari.config()` returns the instance directly.
 
-```typescript
-const result = await Ariari.tasks({
-  from: 0,
-  count: 20,
-  order: -1
-});
+```ts
+const marketing = Ariari.config({
+  name: 'marketing',
+  projectId: 'project-a',
+  secret: 'secret-a',
+})
 
-const fetchTasks = (from) => Ariari.tasks({ from, count: 20, order: -1 });
+const alerts = Ariari.config({
+  name: 'alerts',
+  projectId: 'project-b',
+  secret: 'secret-b',
+})
 
-const nextResult = await fetchTasks(result.next);
-const prevResult = await fetchTasks(result.prev);
+await marketing.send({ phone: '0340000000', message: 'Promo!' })
+await alerts.send({ phone: '0330000000', message: 'Server down' })
 ```
+
+You can also retrieve a named instance later with `Ariari.get()`.
+
+```ts
+const marketing = Ariari.get('marketing')
+```
+
+Without `name`, the instance defaults to `"main"` and is used by static methods (`Ariari.send`, `Ariari.getTask`).

package/dist/index.d.mts

@@ -1,46 +1,73 @@
+type Data = {
+    body?: Record<string, any>;
+    params?: Record<string, any>;
+    public?: boolean;
+};
+type PData = Omit<Data, 'body'>;
 type Config = {
     projectId: string;
-    secretId: string;
+    secret: string;
+    baseUrl?: string;
+};
+declare const createRequester: (config: Config) => {
+    get: <T = any>(url: string, data?: PData) => Promise<T>;
+    post: <T = any>(url: string, data?: Data) => Promise<T>;
+    patch: <T = any>(url: string, data?: Data) => Promise<T>;
+    put: <T = any>(url: string, data?: Data) => Promise<T>;
+    delete: <T = any>(url: string, data?: PData) => Promise<T>;
 };
+
 type Message = {
     phone: string[] | string;
     message: string;
 };
-type GetTaskParam = {
-    from: number;
-    count: number;
-    order: -1 | 1;
-};
-type TaskSummary = {
+type SmsStatus = 'SCHEDULED' | 'PENDING' | 'SENT' | 'DELIVERED' | 'FAILED';
+type TaskStatus = {
     total: number;
     sent: number;
     failed: number;
-    pending: number;
+    delivered: number;
 };
-type TaskDetails = {
-    notifTaskId: string;
+type TaskResponse = {
+    _id: string;
     projectId: string;
-    summary: TaskSummary;
-    smsDetails: Array<{
-        smsId: string;
-        phone: string;
-        message: string;
-        status: 'PENDING' | 'SENT' | 'FAILED';
-        retryCount: number;
-    }>;
+    status: TaskStatus;
     createdAt: string;
+    scheduledAt?: string;
+};
+type SmsDetail = {
+    smsId: string;
+    phone: string;
+    message: string;
+    status: SmsStatus;
+    retryCount: number;
+};
+type TaskWithDetails = {
+    task: TaskResponse;
+    sms: SmsDetail[];
+    total: number;
 };
 
 declare class Task {
     id: string;
-    constructor(id: string);
-    status(): Promise<TaskSummary>;
-    smsDetails(): Promise<TaskDetails>;
+    private _requester;
+    constructor(id: string, requester: ReturnType<typeof createRequester>);
+    get(): Promise<TaskStatus>;
+    get(count: number, page?: number): Promise<TaskWithDetails>;
 }
 declare class Ariari {
-    static config(config: Config): void;
-    static send(...data: Message[]): Promise<Task>;
-    static tasks(param: GetTaskParam): Promise<unknown>;
+    private _config;
+    private _requester;
+    private constructor();
+    static config(nameAndConfig: Config & {
+        name?: string;
+    }): Ariari;
+    static init: typeof Ariari.config;
+    static get: (name?: string) => Ariari;
+    send: (...data: Message[]) => Promise<Task>;
+    getTask: (taskId: string) => Task;
+    static send: (...data: Message[]) => Promise<Task>;
+    static getTask: (taskId: string) => Promise<Task>;
 }
 
-export { Ariari, type GetTaskParam, type Message, Task, type TaskDetails, type TaskSummary };
+export { Ariari as default };

package/dist/index.d.ts

@@ -1,46 +1,73 @@
+type Data = {
+    body?: Record<string, any>;
+    params?: Record<string, any>;
+    public?: boolean;
+};
+type PData = Omit<Data, 'body'>;
 type Config = {
     projectId: string;
-    secretId: string;
+    secret: string;
+    baseUrl?: string;
+};
+declare const createRequester: (config: Config) => {
+    get: <T = any>(url: string, data?: PData) => Promise<T>;
+    post: <T = any>(url: string, data?: Data) => Promise<T>;
+    patch: <T = any>(url: string, data?: Data) => Promise<T>;
+    put: <T = any>(url: string, data?: Data) => Promise<T>;
+    delete: <T = any>(url: string, data?: PData) => Promise<T>;
 };
+
 type Message = {
     phone: string[] | string;
     message: string;
 };
-type GetTaskParam = {
-    from: number;
-    count: number;
-    order: -1 | 1;
-};
-type TaskSummary = {
+type SmsStatus = 'SCHEDULED' | 'PENDING' | 'SENT' | 'DELIVERED' | 'FAILED';
+type TaskStatus = {
     total: number;
     sent: number;
     failed: number;
-    pending: number;
+    delivered: number;
 };
-type TaskDetails = {
-    notifTaskId: string;
+type TaskResponse = {
+    _id: string;
     projectId: string;
-    summary: TaskSummary;
-    smsDetails: Array<{
-        smsId: string;
-        phone: string;
-        message: string;
-        status: 'PENDING' | 'SENT' | 'FAILED';
-        retryCount: number;
-    }>;
+    status: TaskStatus;
     createdAt: string;
+    scheduledAt?: string;
+};
+type SmsDetail = {
+    smsId: string;
+    phone: string;
+    message: string;
+    status: SmsStatus;
+    retryCount: number;
+};
+type TaskWithDetails = {
+    task: TaskResponse;
+    sms: SmsDetail[];
+    total: number;
 };
 
 declare class Task {
     id: string;
-    constructor(id: string);
-    status(): Promise<TaskSummary>;
-    smsDetails(): Promise<TaskDetails>;
+    private _requester;
+    constructor(id: string, requester: ReturnType<typeof createRequester>);
+    get(): Promise<TaskStatus>;
+    get(count: number, page?: number): Promise<TaskWithDetails>;
 }
 declare class Ariari {
-    static config(config: Config): void;
-    static send(...data: Message[]): Promise<Task>;
-    static tasks(param: GetTaskParam): Promise<unknown>;
+    private _config;
+    private _requester;
+    private constructor();
+    static config(nameAndConfig: Config & {
+        name?: string;
+    }): Ariari;
+    static init: typeof Ariari.config;
+    static get: (name?: string) => Ariari;
+    send: (...data: Message[]) => Promise<Task>;
+    getTask: (taskId: string) => Task;
+    static send: (...data: Message[]) => Promise<Task>;
+    static getTask: (taskId: string) => Promise<Task>;
 }
 
-export { Ariari, type GetTaskParam, type Message, Task, type TaskDetails, type TaskSummary };
+export { Ariari as default };

package/dist/index.js

@@ -20,40 +20,21 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
-  Ariari: () => Ariari,
-  Task: () => Task
+  default: () => src_default
 });
 module.exports = __toCommonJS(src_exports);
 
-// src/config/index.ts
-var config = null;
-function setConfig(cfg) {
-  config = cfg;
-}
-function getConfig() {
-  return config;
-}
-
-// src/http/index.ts
-async function request(method, endpoint, options = {}) {
-  const config2 = getConfig();
-  if (!config2) {
-    throw new Error("Ariari not configured. Call Ariari.config() first.");
+// ../common/http.ts
+async function request(verb, endpoint, options, config) {
+  if (!config) throw new Error("Ariari package not configured.");
+  const url = `${config.baseUrl || "https://back.ariari.mg"}${endpoint}`;
+  const headers = { "Content-Type": "application/json" };
+  if (!options.public) {
+    headers["x-project-id"] = config.projectId;
+    headers["x-secret"] = config.secret;
   }
-  const baseUrl = config2.baseUrl || "https://back.ariari.mg";
-  const url = `${baseUrl}${endpoint}`;
-  const headers = {
-    "Content-Type": "application/json",
-    "x-project-id": config2.projectId
-  };
-  if (options.requiresSecret !== false) {
-    headers["x-secret-id"] = config2.secretId;
-  }
-  const fetchOptions = {
-    method,
-    headers
-  };
-  if (options.body && (method === "POST" || method === "PATCH" || method === "PUT")) {
+  const fetchOptions = { method: verb, headers };
+  if ("body" in options && options.body) {
     fetchOptions.body = JSON.stringify(options.body);
   }
   try {
@@ -71,57 +52,68 @@ async function request(method, endpoint, options = {}) {
     throw new Error("Network error");
   }
 }
-async function httpGet(endpoint, requiresSecret = true) {
-  return request("GET", endpoint, { requiresSecret });
-}
-async function httpPost(endpoint, body, requiresSecret = true) {
-  return request("POST", endpoint, { body, requiresSecret });
-}
+var createRequester = (config) => ({
+  get: (url, data = {}) => request("GET", url, data, config),
+  post: (url, data = {}) => request("POST", url, data, config),
+  patch: (url, data = {}) => request("PATCH", url, data, config),
+  put: (url, data = {}) => request("PUT", url, data, config),
+  delete: (url, data = {}) => request("DELETE", url, data, config)
+});
 
-// src/index.ts
-function normalizePhoneNumber(phone) {
+// ../common/phone.ts
+var normalizePhoneNumber = (phone) => {
   let normalized = phone.replace(/\D/g, "");
-  if (normalized.startsWith("261")) {
-    normalized = "0" + normalized.slice(3);
-  }
+  if (normalized.startsWith("261")) normalized = "0" + normalized.slice(3);
   return normalized;
-}
+};
+
+// src/index.ts
+var instances = {};
 var Task = class {
-  constructor(id) {
+  constructor(id, requester) {
     this.id = id;
+    this._requester = requester;
   }
-  async status() {
-    const response = await httpGet(`/api/notif-task/${this.id}/sms-details`);
-    return response.summary;
-  }
-  async smsDetails() {
-    return httpGet(`/api/notif-task/${this.id}/sms-details`);
+  async get(count, page) {
+    if (count === void 0) {
+      const response = await this._requester.get(`/api/notif-task/${this.id}`);
+      return response.status;
+    }
+    const details = page ? `${count},${page}` : `${count}`;
+    return this._requester.get(`/api/notif-task/${this.id}?details=${details}`);
   }
 };
-var Ariari = class {
-  static config(config2) {
-    setConfig(config2);
+var _Ariari = class _Ariari {
+  constructor({ name = "main", ...config }) {
+    this.send = async (...data) => {
+      const messages = data.map((item) => ({
+        phones: (Array.isArray(item.phone) ? item.phone : [item.phone]).map(normalizePhoneNumber),
+        message: item.message
+      }));
+      const response = await this._requester.post("/api/sms/bulk", { body: { messages } });
+      if (!response.data || !Array.isArray(response.data) || response.data.length === 0) {
+        throw new Error("Invalid response: no SMS IDs returned");
+      }
+      if (!response.notifTaskId) {
+        throw new Error("Invalid response: no notifTaskId returned");
+      }
+      return new Task(response.notifTaskId, this._requester);
+    };
+    this.getTask = (taskId) => new Task(taskId, this._requester);
+    this._config = config;
+    this._requester = createRequester(config);
+    instances[name] = this;
   }
-  static async send(...data) {
-    const messages = data.map((item) => ({
-      phones: (Array.isArray(item.phone) ? item.phone : [item.phone]).map(normalizePhoneNumber),
-      message: item.message
-    }));
-    const response = await httpPost("/api/sms/bulk", { messages });
-    if (!response.data || !Array.isArray(response.data) || response.data.length === 0) {
-      throw new Error("Invalid response: no SMS IDs returned");
-    }
-    if (!response.notifTaskId) {
-      throw new Error("Invalid response: no notifTaskId returned");
-    }
-    return new Task(response.notifTaskId);
-  }
-  static async tasks(param) {
-    return httpGet(`/api/sms?from=${param.from}&count=${param.count}&order=${param.order}`);
+  static config(nameAndConfig) {
+    return new _Ariari(nameAndConfig);
   }
 };
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  Ariari,
-  Task
-});
+_Ariari.init = _Ariari.config;
+_Ariari.get = (name = "main") => {
+  if (!instances[name]) throw new Error(`The instance of Ariari with the name "${name}" doesn't exist yet. Call Ariari.config(...  )`);
+  return instances[name];
+};
+_Ariari.send = async (...data) => await _Ariari.get("main")?.send(...data);
+_Ariari.getTask = async (taskId) => _Ariari.get("main")?.getTask(taskId);
+var Ariari = _Ariari;
+var src_default = Ariari;

package/dist/index.mjs

@@ -1,32 +1,14 @@
-// src/config/index.ts
-var config = null;
-function setConfig(cfg) {
-  config = cfg;
-}
-function getConfig() {
-  return config;
-}
-
-// src/http/index.ts
-async function request(method, endpoint, options = {}) {
-  const config2 = getConfig();
-  if (!config2) {
-    throw new Error("Ariari not configured. Call Ariari.config() first.");
+// ../common/http.ts
+async function request(verb, endpoint, options, config) {
+  if (!config) throw new Error("Ariari package not configured.");
+  const url = `${config.baseUrl || "https://back.ariari.mg"}${endpoint}`;
+  const headers = { "Content-Type": "application/json" };
+  if (!options.public) {
+    headers["x-project-id"] = config.projectId;
+    headers["x-secret"] = config.secret;
   }
-  const baseUrl = config2.baseUrl || "https://back.ariari.mg";
-  const url = `${baseUrl}${endpoint}`;
-  const headers = {
-    "Content-Type": "application/json",
-    "x-project-id": config2.projectId
-  };
-  if (options.requiresSecret !== false) {
-    headers["x-secret-id"] = config2.secretId;
-  }
-  const fetchOptions = {
-    method,
-    headers
-  };
-  if (options.body && (method === "POST" || method === "PATCH" || method === "PUT")) {
+  const fetchOptions = { method: verb, headers };
+  if ("body" in options && options.body) {
     fetchOptions.body = JSON.stringify(options.body);
   }
   try {
@@ -44,56 +26,71 @@ async function request(method, endpoint, options = {}) {
     throw new Error("Network error");
   }
 }
-async function httpGet(endpoint, requiresSecret = true) {
-  return request("GET", endpoint, { requiresSecret });
-}
-async function httpPost(endpoint, body, requiresSecret = true) {
-  return request("POST", endpoint, { body, requiresSecret });
-}
+var createRequester = (config) => ({
+  get: (url, data = {}) => request("GET", url, data, config),
+  post: (url, data = {}) => request("POST", url, data, config),
+  patch: (url, data = {}) => request("PATCH", url, data, config),
+  put: (url, data = {}) => request("PUT", url, data, config),
+  delete: (url, data = {}) => request("DELETE", url, data, config)
+});
 
-// src/index.ts
-function normalizePhoneNumber(phone) {
+// ../common/phone.ts
+var normalizePhoneNumber = (phone) => {
   let normalized = phone.replace(/\D/g, "");
-  if (normalized.startsWith("261")) {
-    normalized = "0" + normalized.slice(3);
-  }
+  if (normalized.startsWith("261")) normalized = "0" + normalized.slice(3);
   return normalized;
-}
+};
+
+// src/index.ts
+var instances = {};
 var Task = class {
-  constructor(id) {
+  constructor(id, requester) {
     this.id = id;
+    this._requester = requester;
   }
-  async status() {
-    const response = await httpGet(`/api/notif-task/${this.id}/sms-details`);
-    return response.summary;
-  }
-  async smsDetails() {
-    return httpGet(`/api/notif-task/${this.id}/sms-details`);
+  async get(count, page) {
+    if (count === void 0) {
+      const response = await this._requester.get(`/api/notif-task/${this.id}`);
+      return response.status;
+    }
+    const details = page ? `${count},${page}` : `${count}`;
+    return this._requester.get(`/api/notif-task/${this.id}?details=${details}`);
   }
 };
-var Ariari = class {
-  static config(config2) {
-    setConfig(config2);
+var _Ariari = class _Ariari {
+  constructor({ name = "main", ...config }) {
+    this.send = async (...data) => {
+      const messages = data.map((item) => ({
+        phones: (Array.isArray(item.phone) ? item.phone : [item.phone]).map(normalizePhoneNumber),
+        message: item.message
+      }));
+      const response = await this._requester.post("/api/sms/bulk", { body: { messages } });
+      if (!response.data || !Array.isArray(response.data) || response.data.length === 0) {
+        throw new Error("Invalid response: no SMS IDs returned");
+      }
+      if (!response.notifTaskId) {
+        throw new Error("Invalid response: no notifTaskId returned");
+      }
+      return new Task(response.notifTaskId, this._requester);
+    };
+    this.getTask = (taskId) => new Task(taskId, this._requester);
+    this._config = config;
+    this._requester = createRequester(config);
+    instances[name] = this;
   }
-  static async send(...data) {
-    const messages = data.map((item) => ({
-      phones: (Array.isArray(item.phone) ? item.phone : [item.phone]).map(normalizePhoneNumber),
-      message: item.message
-    }));
-    const response = await httpPost("/api/sms/bulk", { messages });
-    if (!response.data || !Array.isArray(response.data) || response.data.length === 0) {
-      throw new Error("Invalid response: no SMS IDs returned");
-    }
-    if (!response.notifTaskId) {
-      throw new Error("Invalid response: no notifTaskId returned");
-    }
-    return new Task(response.notifTaskId);
-  }
-  static async tasks(param) {
-    return httpGet(`/api/sms?from=${param.from}&count=${param.count}&order=${param.order}`);
+  static config(nameAndConfig) {
+    return new _Ariari(nameAndConfig);
   }
 };
+_Ariari.init = _Ariari.config;
+_Ariari.get = (name = "main") => {
+  if (!instances[name]) throw new Error(`The instance of Ariari with the name "${name}" doesn't exist yet. Call Ariari.config(...  )`);
+  return instances[name];
+};
+_Ariari.send = async (...data) => await _Ariari.get("main")?.send(...data);
+_Ariari.getTask = async (taskId) => _Ariari.get("main")?.getTask(taskId);
+var Ariari = _Ariari;
+var src_default = Ariari;
 export {
-  Ariari,
-  Task
+  src_default as default
 };

package/package.json

@@ -1,49 +1,34 @@
-{
-  "name": "@ariary/notification",
-  "version": "3.0.1",
-  "description": "SMS et Notification Task SDK pour l'API Ariary",
-  "main": "dist/index.js",
-  "module": "dist/index.mjs",
-  "types": "dist/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.js"
-    }
-  },
-  "files": [
-    "dist"
-  ],
-  "tsup": {
-    "entry": {
-      "index": "src/index.ts"
-    },
-    "format": [
-      "cjs",
-      "esm"
-    ],
-    "outDir": "dist",
-    "dts": true,
-    "splitting": false,
-    "sourcemap": false,
-    "clean": true,
-    "minify": false
-  },
-  "scripts": {
-    "build": "tsup"
-  },
-  "keywords": [
-    "ariary",
-    "sms",
-    "notification",
-    "api"
-  ],
-  "author": "Ariary",
-  "license": "ISC",
-  "dependencies": {},
-  "devDependencies": {
-    "tsup": "^8.5.1",
-    "typescript": "^5.9.3"
-  }
-}
+{
+  "name": "@ariary/notification",
+  "version": "3.0.2",
+  "description": "SMS et Notification Task SDK pour l'API Ariary",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup"
+  },
+  "keywords": [
+    "ariary",
+    "sms",
+    "notification",
+    "api"
+  ],
+  "author": "Ariary",
+  "license": "ISC",
+  "dependencies": {},
+  "devDependencies": {
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3"
+  }
+}