@ariary/notification 3.0.10 → 3.0.11

package/README.md

@@ -103,32 +103,40 @@ const estimate = await Ariari.estimate(
 
 `send()` returns a `Task` object. Call `.status()` to check delivery progress.
 
-### `task.status()` — TaskStatus
+All methods return the same response shape:
 
 | Field | Type | Description |
 |---|---|---|
-| `total` | number | Total SMS count |
-| `sent` | number | Successfully sent |
-| `failed` | number | Failed to send |
-| `delivered` | number | Confirmed delivered |
+| `task` | TaskData | Task metadata (see below) |
+| `sms` | SmsDetail[] | List of SMS details (`[]` when no details requested) |
+| `total` | number | Total SMS count for pagination (`0` when no details requested) |
 
-### `task.status(count, page?)` — TaskWithDetails
-
-| Field | Type | Description |
+| Method | Details query | Description |
 |---|---|---|
-| `task` | TaskResponse | Task metadata (see below) |
-| `sms` | SmsDetail[] | List of SMS details |
-| `total` | number | Total SMS count |
+| `task.status()` | *(none)* | Task only, `sms: []` |
+| `task.status(count)` | `?details=count,1` | Task + first `count` SMS |
+| `task.status(count, page)` | `?details=count,page` | Task + paginated SMS |
+| `task.fullStatus()` | `?details=-1` | Task + all SMS |
 
-### TaskResponse
+### TaskData
 
 | Field | Type | Description |
 |---|---|---|
 | `_id` | string | Task ID |
-| `status` | TaskStatus | Delivery counters per SMS |
-| `statusPage` | TaskStatus | Delivery counters per SMS page |
+| `status` | TaskCounters | Delivery counters per SMS |
+| `statusPage` | TaskCounters | Delivery counters per SMS page |
+| `projectId` | string | Project ID |
 | `createdAt` | string | Creation date |
-| `scheduledAt` | string? | Scheduled date |
+| `scheduledAt` | string? | Scheduled date (only if scheduled) |
+
+### TaskCounters
+
+| Field | Type | Description |
+|---|---|---|
+| `total` | number | Total SMS count |
+| `sent` | number | Successfully sent |
+| `failed` | number | Failed to send |
+| `delivered` | number | Confirmed delivered |
 
 ### SmsDetail
 
@@ -143,20 +151,20 @@ const estimate = await Ariari.estimate(
 ```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 }
+// task only (sms: [], total: 0)
+const res = await task.status()
+// res.task.status => { total: 1, sent: 1, failed: 0, delivered: 0 }
 
-// status + all SMS details
-const details = await task.status(100)
-// { task: { _id, status, createdAt, ... }, sms: [{ smsId, phone, message, status, retryCount }], total: 1 }
+// task + first 10 SMS
+const details = await task.status(10)
+// details.sms => [{ smsId, phone, message, status, retryCount }]
 
 // paginated: 20 per page, page 2
 const page2 = await task.status(20, 2)
 
-// all SMS details at once
+// all SMS at once
 const full = await task.fullStatus()
-// { task: { ... }, sms: [...all SMS], total: 50 }
+// full.sms => [...all SMS], full.total => 50
 ```
 
 SMS statuses: `SmsStatus.SCHEDULED` | `SmsStatus.PENDING` | `SmsStatus.SENT` | `SmsStatus.DELIVERED` | `SmsStatus.FAILED`

package/dist/index.d.mts

@@ -28,17 +28,17 @@ declare enum SmsStatus {
     DELIVERED = "DELIVERED",
     FAILED = "FAILED"
 }
-type TaskStatus = {
+type TaskCounters = {
     total: number;
     sent: number;
     failed: number;
     delivered: number;
 };
-type TaskResponse = {
+type TaskData = {
     _id: string;
     projectId: string;
-    status: TaskStatus;
-    statusPage: TaskStatus;
+    status: TaskCounters;
+    statusPage: TaskCounters;
     createdAt: string;
     scheduledAt?: string;
 };
@@ -49,8 +49,8 @@ type SmsDetail = {
     status: SmsStatus;
     retryCount: number;
 };
-type TaskWithDetails = {
-    task: TaskResponse;
+type TaskResponse = {
+    task: TaskData;
     sms: SmsDetail[];
     total: number;
 };
@@ -67,9 +67,9 @@ declare class Task {
     id: string;
     private _requester;
     constructor(id: string, requester: ReturnType<typeof createRequester>);
-    status(): Promise<TaskStatus>;
-    status(count: number, page?: number): Promise<TaskWithDetails>;
-    fullStatus(): Promise<TaskWithDetails>;
+    status(): Promise<TaskResponse>;
+    status(count: number, page?: number): Promise<TaskResponse>;
+    fullStatus(): Promise<TaskResponse>;
 }
 declare class Ariari {
     private _config;

package/dist/index.d.ts

@@ -28,17 +28,17 @@ declare enum SmsStatus {
     DELIVERED = "DELIVERED",
     FAILED = "FAILED"
 }
-type TaskStatus = {
+type TaskCounters = {
     total: number;
     sent: number;
     failed: number;
     delivered: number;
 };
-type TaskResponse = {
+type TaskData = {
     _id: string;
     projectId: string;
-    status: TaskStatus;
-    statusPage: TaskStatus;
+    status: TaskCounters;
+    statusPage: TaskCounters;
     createdAt: string;
     scheduledAt?: string;
 };
@@ -49,8 +49,8 @@ type SmsDetail = {
     status: SmsStatus;
     retryCount: number;
 };
-type TaskWithDetails = {
-    task: TaskResponse;
+type TaskResponse = {
+    task: TaskData;
     sms: SmsDetail[];
     total: number;
 };
@@ -67,9 +67,9 @@ declare class Task {
     id: string;
     private _requester;
     constructor(id: string, requester: ReturnType<typeof createRequester>);
-    status(): Promise<TaskStatus>;
-    status(count: number, page?: number): Promise<TaskWithDetails>;
-    fullStatus(): Promise<TaskWithDetails>;
+    status(): Promise<TaskResponse>;
+    status(count: number, page?: number): Promise<TaskResponse>;
+    fullStatus(): Promise<TaskResponse>;
 }
 declare class Ariari {
     private _config;

package/dist/index.js

@@ -98,12 +98,12 @@ var Task = class {
   }
   async status(count, page) {
     if (count === void 0) {
-      const response = await this._requester.get(`/api/notif-task/${this.id}`);
-      return response.status;
+      return this._requester.get(`/api/notif-task/${this.id}`);
     }
     const details = `${count},${page || 1}`;
     return this._requester.get(`/api/notif-task/${this.id}?details=${details}`);
   }
+  // All SMS at once
   async fullStatus() {
     return this._requester.get(`/api/notif-task/${this.id}?details=-1`);
   }

package/dist/index.mjs

@@ -71,12 +71,12 @@ var Task = class {
   }
   async status(count, page) {
     if (count === void 0) {
-      const response = await this._requester.get(`/api/notif-task/${this.id}`);
-      return response.status;
+      return this._requester.get(`/api/notif-task/${this.id}`);
     }
     const details = `${count},${page || 1}`;
     return this._requester.get(`/api/notif-task/${this.id}?details=${details}`);
   }
+  // All SMS at once
   async fullStatus() {
     return this._requester.get(`/api/notif-task/${this.id}?details=-1`);
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ariary/notification",
-  "version": "3.0.10",
+  "version": "3.0.11",
   "description": "Ariary SMS & Notification SDK (ariari.mg) — Send SMS in Madagascar with automatic phone normalization, bulk messaging, deferred/scheduled sending, delivery tracking, credit estimation. Supports Orange, Airtel, Telma. Multi-instance, TypeScript-first.",
   "main": "dist/index.js",
   "module": "dist/index.mjs",