@dszp/netsapiens-lib 0.3.1 → 0.5.0

package/src/nsClient.selftest.ts

@@ -168,6 +168,52 @@ const ok = (c: boolean, msg: string) => {
     ok(noDevicesSnap.deviceReadFailures === undefined, 'without includeDevices, deviceReadFailures is absent entirely');
   }
 
+  // -- per-user SMS numbers: one call per REAL extension, opt-in, failures named like device reads --
+  {
+    const seen: string[] = [];
+    const client = { get: async (p: string) => {
+      seen.push(p);
+      if (p.endsWith('/users')) return [{ user: '100', 'service-code': '' }, { user: '101', 'service-code': '' }, { user: '700', 'service-code': 'system-aa' }];
+      if (p.endsWith('/users/100/smsnumbers')) return [{ number: '13175550100' }];
+      if (p.endsWith('/users/101/smsnumbers')) throw new NsApiError('GET .../smsnumbers → 500', 500, p, null);
+      if (/\/domains\/[^/]+$/.test(p)) return [{ domain: 'acme.example' }];
+      return [];
+    } } as unknown as NsClient;
+    const snap = await fetchDomainSnapshot(client, 'acme.example', { includeAttendantMenus: false, includeUserSmsNumbers: true });
+    ok(JSON.stringify(snap.smsNumbersByUser) === JSON.stringify({ '100': [{ number: '13175550100' }] }), 'per-user SMS numbers are filed under the extension');
+    ok(JSON.stringify(snap.smsReadFailures) === JSON.stringify(['101']), 'a failed per-user SMS read is named');
+    ok(!seen.some((p) => p.endsWith('/users/700/smsnumbers')), 'system users are not read');
+    const plain = await fetchDomainSnapshot(client, 'acme.example', { includeAttendantMenus: false });
+    ok(plain.smsNumbersByUser === undefined && plain.smsReadFailures === undefined, 'without the option neither field is present');
+
+    // PRESENT AND EMPTY when every read answered — the same contract deviceReadFailures has, and the
+    // distinction a consumer needs: absent means nobody asked, empty means nothing failed. An absent
+    // field read as "nothing failed" would be a page claiming a clean read it never performed.
+    const allOk = { get: async (p: string) => {
+      if (p.endsWith('/users')) return [{ user: '100', 'service-code': '' }];
+      if (p.endsWith('/users/100/smsnumbers')) return [{ number: '13175550100' }];
+      if (/\/domains\/[^/]+$/.test(p)) return [{ domain: 'acme.example' }];
+      return [];
+    } } as unknown as NsClient;
+    const clean = await fetchDomainSnapshot(allOk, 'acme.example', { includeAttendantMenus: false, includeUserSmsNumbers: true });
+    ok(Array.isArray(clean.smsReadFailures) && clean.smsReadFailures.length === 0,
+      'no failures - smsReadFailures is an empty array, not absent');
+
+    // SORTED, not in completion order. These fill under mapLimit, so the fixture makes the FIRST-sorting
+    // extension answer last; an unsorted list would come back ['101','100'] and the panel that prints it
+    // would reshuffle between two reads of the same broken domain.
+    const twoFails = { get: async (p: string) => {
+      if (p.endsWith('/users')) return [{ user: '100', 'service-code': '' }, { user: '101', 'service-code': '' }];
+      if (p.endsWith('/users/100/smsnumbers')) { await new Promise((r) => setTimeout(r, 10)); throw new NsApiError('GET .../smsnumbers → 500', 500, p, null); }
+      if (p.endsWith('/users/101/smsnumbers')) throw new NsApiError('GET .../smsnumbers → 500', 500, p, null);
+      if (/\/domains\/[^/]+$/.test(p)) return [{ domain: 'acme.example' }];
+      return [];
+    } } as unknown as NsClient;
+    const sorted = await fetchDomainSnapshot(twoFails, 'acme.example', { includeAttendantMenus: false, includeUserSmsNumbers: true });
+    ok(JSON.stringify(sorted.smsReadFailures) === JSON.stringify(['100', '101']),
+      'two failures come back sorted, whichever order they completed in');
+  }
+
   console.log(`\n${pass} passed, ${fail} failed`);
   process.exit(fail ? 1 : 0);
 })();

package/src/nsClient.ts

@@ -183,6 +183,12 @@ export interface FetchSnapshotOptions {
    * auto attendants and queues, and they hold no seat.
    */
   includeDevices?: boolean;
+  /**
+   * Also read each REAL extension's SMS-enabled numbers into `smsNumbersByUser`. One call per
+   * extension, like `includeDevices`, and for the same reason: the domain-level list does not say
+   * which user a number belongs to, and a consumer splitting a domain by site needs to know.
+   */
+  includeUserSmsNumbers?: boolean;
 }
 
 /**
@@ -258,6 +264,30 @@ export async function fetchDomainSnapshot(client: NsClient, domain: string, opts
       });
       if (devs.length) devicesByUser![ext] = devs;
     });
+    // SORTED before it leaves. These fill under `mapLimit`, so the order is whichever read failed first —
+    // a list that reshuffles between two reads of the same broken domain reads as data that changed, and a
+    // consumer prints this straight at an operator.
+    deviceReadFailures.sort();
+  }
+
+  // Per-user SMS numbers, same shape and reason as devices above: the domain-level list (see
+  // includeSmsNumbers) does not say which user a number belongs to.
+  let smsNumbersByUser: Record<string, Rec[]> | undefined;
+  let smsReadFailures: string[] | undefined;
+  if (opts.includeUserSmsNumbers) {
+    smsNumbersByUser = {};
+    smsReadFailures = [];
+    const seats = users.filter((u) => !String(u['service-code'] ?? '').trim().toLowerCase().startsWith('system-'));
+    await mapLimit(seats, conc, async (u) => {
+      const ext = String(u.user ?? '');
+      if (!ext) return;
+      const list = await soft(`${base}/users/${enc(ext)}/smsnumbers`).catch(() => {
+        smsReadFailures!.push(ext);
+        return [];
+      });
+      if (list.length) smsNumbersByUser![ext] = list;
+    });
+    smsReadFailures.sort();   // same reason as deviceReadFailures above
   }
 
   const answerrulesByUser: Record<string, Rec[]> = {};
@@ -316,6 +346,8 @@ export async function fetchDomainSnapshot(client: NsClient, domain: string, opts
     ...(smsnumbers ? { smsnumbers } : {}),
     ...(devicesByUser ? { devicesByUser } : {}),
     ...(deviceReadFailures ? { deviceReadFailures } : {}),
+    ...(smsNumbersByUser ? { smsNumbersByUser } : {}),
+    ...(smsReadFailures ? { smsReadFailures } : {}),
     ...(attendantDetailsByUser && Object.keys(attendantDetailsByUser).length ? { attendantDetailsByUser } : {}),
     ...(attendantDialrulesByExt && Object.keys(attendantDialrulesByExt).length ? { attendantDialrulesByExt } : {}),
     ...(dialrulesByPlan ? { dialrulesByPlan } : {}),