@dszp/netsapiens-lib 0.6.0 → 0.8.0

package/README.md

@@ -79,7 +79,7 @@ genuine zero from a read that never completed rather than silently undercounting
 
 ### Counting a domain: `countDomainInventory`
 
-`countDomainInventory(snapshot)` is pure — it fetches nothing, and turns a `Snapshot` (from
+`countDomainInventory(snapshot, opts?)` is pure — it fetches nothing, and turns a `Snapshot` (from
 `fetchDomainSnapshot`, a backup, or a fixture) into a fixed tree of numeric leaves along the dimensions a
 VoIP operator actually sells on:
 
@@ -90,9 +90,11 @@ VoIP operator actually sells on:
 - `systemUsers` — `system-aa`, `system-queue`, `system-tod` and friends: `total` and `byServiceCode`.
   Informational, never compared against a seat count.
 - `transcriptionEnabled` — extensions with voicemail transcription on.
-- `teamsConnected` — extensions with a Microsoft Teams connector device (SIP `aor` local part
-  `<ext>t`). That connector is excluded from `devices`/`deviceCount`: it is a connector, not a handset.
-- `dids` — phone numbers, `total` / `tollFree` / `local`.
+- `teamsConnected` — extensions with a Microsoft Teams connector device — one whose device-name suffix
+  the legend marks `teams` (`<ext>t` by default). That connector is excluded from `devices`/`deviceCount`:
+  it is a connector, not a handset. See [Device suffixes](#device-suffixes).
+- `dids` — phone numbers: `total` / `tollFree` / `local`, all three **excluding fax lines**, plus
+  `fax` and `all` (everything, `total + fax === all`). See [Fax lines](#fax-lines).
 - `e911Addresses`, `smsNumbers` — record counts.
 - `devices` — `total` and `byModel`, real extensions only (a system user's device is not a seat).
 
@@ -116,9 +118,61 @@ inventory.dids.tollFree;      // e.g. 3
 inventory.devices.byModel;    // e.g. { "Yealink T54W": 12, "(unknown)": 1 }
 ```
 
+#### Fax lines
+
+On the portal's **Fax Server** treatment a fax line is an ordinary phone number whose dial rule hands it
+to a fax server: `dial-rule-application: to-connection` and `dial-rule-translation-destination-host` set
+to that server's host. The API has no fax-account endpoint and the ATA is not a device on any user, so
+that host is the only thing that says "fax line" — and nothing in the API distinguishes an analog fax
+from a digital one.
+
+The host belongs to your deployment, so you supply it; **with no hosts, nothing is a fax line** and the
+counts are exactly what they were before 0.7.0:
+
+```ts
+const inventory = countDomainInventory(snapshot, { faxServerHosts: ['203.0.113.7'] });
+inventory.dids.fax;    // 2 — billed as fax lines
+inventory.dids.total;  // the DIDs, those two NOT among them
+inventory.dids.all;    // total + fax
+```
+
+Matching is on the trimmed host, case-insensitively, and on nothing else — never the
+`dial-rule-description`, which is a note the portal writes and an operator can edit. A fax line's
+`NumberItem.fax` is `true`, its `destination` reads `to fax server` (the host is deliberately not shown),
+and it keeps its `kind`: a fax number is local or toll-free like any other, it is simply not counted as a
+DID.
+
+#### Device suffixes
+
+A device's **suffix** is what its name carries after the extension number: `1001wp` on extension `1001`
+has suffix `wp`, a bare `1001` has none, and a name that does not start with the extension has none
+either. Three suffixes ship with NetSapiens, and `DEFAULT_DEVICE_SUFFIXES` is that table:
+
+```ts
+DEFAULT_DEVICE_SUFFIXES;  // { wp: {label:'SNAPmobile Web'}, m: {label:'SNAPmobile'}, t: {label:'Teams', teams:true} }
+```
+
+Each device in `ExtensionItem.devices` carries its `suffix` (lower-cased) and the legend's label for it as
+`kind` — `''` when the suffix is empty or the legend does not carry it, because an unlisted suffix is a
+name the deployment has not explained, not a device type to guess at. The suffix marked `teams: true` is
+what identifies a Microsoft Teams connector: that is the whole of the test, so `teamsConnected`,
+`ExtensionItem.teams` and the handset-only `deviceCount`/`deviceModels` all follow from the legend.
+
+Your own suffixes go in `deviceSuffixes`, which **replaces** the default rather than merging with it:
+
+```ts
+listDomainInventory(snapshot, { deviceSuffixes: { r: { label: 'Acme App' }, t: { label: 'Teams', teams: true } } });
+```
+
+Replace-wholesale is deliberate. A deployment without TeamMate omits `t`, and Teams detection is then off
+entirely — every `<ext>t` device is a handset and is counted as one — which a merge could not express.
+Comparison is case-insensitive on both sides. `resolveFlow` labels a simultaneous-ring device from the
+same default table (it takes no options — a call flow is drawn from a snapshot alone), so a suffix means
+one thing across this library.
+
 #### Listing a domain: `listDomainInventory`
 
-`countDomainInventory` is a fold over `listDomainInventory(snapshot)`, which returns the per-item lists
+`countDomainInventory` is a fold over `listDomainInventory(snapshot, opts?)` (same options), which returns the per-item lists
 behind those counts — for anything that shows an operator *which* extension or number a count refers to,
 not just how many. Same allowlist discipline as the counts: a device's MAC, SIP credentials and email
 never appear, though names and sites now do (that's the point of a list). Each item carries a stable
@@ -131,11 +185,13 @@ never appear, though names and sites now do (that's the point of a list). Each i
 | `e911Addresses` | `addr:<emergency-address-id>` |
 | `smsNumbers` | `sms:<number>` |
 
-A number carries `destination` — where it routes, in words (`to user 100 — Ann Lee`, `to queue 701 —
-Sales`), built by the exported `destinationOf(p, userByExt)` over `usersByExt(users)` — and `description`
-(`dial-rule-description`, trimmed); an extension carries `devices`, an `{ name, model, teams }` per
-device it has (handset and Teams connector alike), in record order — still never the MAC, SIP password
-or email.
+A number carries `fax` (see [Fax lines](#fax-lines)) and `destination` — where it routes, in words
+(`to user 100 — Ann Lee`, `to queue 701 — Sales`, `to fax server`), built by the exported
+`destinationOf(p, userByExt, faxServerHosts?)` over `usersByExt(users)` — and `description`
+(`dial-rule-description`, trimmed); an extension carries `devices`, an
+`{ name, model, teams, suffix, kind }` per device it has (handset and Teams connector alike), in record
+order — still never the MAC, SIP password or email. See [Device suffixes](#device-suffixes) for `suffix`
+and `kind`.
 
 `itemsFor(detail, path)` returns the items behind one of `countDomainInventory`'s dotted-path counts —
 the same vocabulary, so a UI that lets an operator drill from a count into the records behind it needs
@@ -150,7 +206,9 @@ no separate lookup table:
 | `extensions.withAnyDevice` / `extensions.withNoDevice` | extensions with / without any device (handset or Teams connector) |
 | `transcriptionEnabled` | extensions with transcription on |
 | `teamsConnected` | extensions with a Teams connector |
-| `dids.total` / `dids.tollFree` / `dids.local` | phone numbers |
+| `dids.total` / `dids.tollFree` / `dids.local` | phone numbers, **fax lines excluded** |
+| `dids.fax` | fax lines |
+| `dids.all` | every phone number, fax lines included |
 | `e911Addresses` | E911 addresses |
 | `smsNumbers` | SMS numbers |
 

package/dist/index.d.ts

@@ -16,7 +16,7 @@ export { THEMES, DEFAULT_LIGHT_THEME, DEFAULT_DARK_THEME, NODE_LIGHT, NODE_DARK,
 export { renderGalleryHtml, renderFlowCards, renderFlowCard, mermaidBootstrap, flowAnchorId, type GalleryOptions, type CardOptions, } from './html.js';
 export { resolveSvgSize, rasterizerScript } from './raster.js';
 export { NsClient, NsApiError, assertBareServer, fetchDomainSnapshot, listDomains, asArray, type NsClientConfig, type FetchSnapshotOptions } from './nsClient.js';
-export { countDomainInventory, countInventoryDetail, listDomainInventory, itemsFor, itemLabel, destinationOf, usersByExt, type DomainInventory, type DomainInventoryDetail, type ExtensionItem, type NumberItem, type AddressItem, type SmsItem, type InventoryItem } from './inventory.js';
+export { countDomainInventory, countInventoryDetail, listDomainInventory, itemsFor, itemLabel, destinationOf, usersByExt, DEFAULT_DEVICE_SUFFIXES, type DeviceSuffixLegend, type DomainInventory, type DomainInventoryDetail, type InventoryOptions, type ExtensionItem, type NumberItem, type AddressItem, type SmsItem, type InventoryItem } from './inventory.js';
 export { attributeDomainInventory, type DomainAttribution, type ItemAttribution } from './attribution.js';
 export { NsWriteClient, type NsWriteClientConfig } from './nsWriteClient.js';
 export { supportsSynchronous, SYNCHRONOUS_OPERATIONS, type SynchronousMethod, type SynchronousOperation, } from './nsSynchronous.js';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,YAAY,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AACnG,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,KAAK,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1E,OAAO,EAAE,SAAS,EAAE,KAAK,SAAS,EAAE,KAAK,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9E,OAAO,EACL,MAAM,EACN,mBAAmB,EACnB,kBAAkB,EAClB,UAAU,EACV,SAAS,EACT,UAAU,EACV,SAAS,EACT,KAAK,QAAQ,EACb,KAAK,WAAW,EAChB,KAAK,SAAS,EACd,KAAK,WAAW,GACjB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,iBAAiB,EACjB,eAAe,EACf,cAAc,EACd,gBAAgB,EAChB,YAAY,EACZ,KAAK,cAAc,EACnB,KAAK,WAAW,GACjB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,WAAW,EAAE,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAClK,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,QAAQ,EAAE,SAAS,EAAE,aAAa,EAAE,UAAU,EAAE,KAAK,eAAe,EAAE,KAAK,qBAAqB,EAAE,KAAK,aAAa,EAAE,KAAK,UAAU,EAAE,KAAK,WAAW,EAAE,KAAK,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC5R,OAAO,EAAE,wBAAwB,EAAE,KAAK,iBAAiB,EAAE,KAAK,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAC1G,OAAO,EAAE,aAAa,EAAE,KAAK,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAC7E,OAAO,EACL,mBAAmB,EACnB,sBAAsB,EACtB,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,GAC1B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,cAAc,EACd,mBAAmB,EACnB,YAAY,EACZ,KAAK,cAAc,EACnB,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,GAC1B,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,KAAK,kBAAkB,EAAE,KAAK,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC7G,OAAO,EACL,qBAAqB,EACrB,2BAA2B,EAC3B,mBAAmB,EACnB,mBAAmB,EACnB,UAAU,EACV,eAAe,EACf,oBAAoB,EACpB,iBAAiB,EACjB,iBAAiB,EACjB,iBAAiB,EACjB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,YAAY,EACjB,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,2BAA2B,EAChC,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,EACvB,KAAK,wBAAwB,GAC9B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,MAAM,EACN,iBAAiB,EACjB,cAAc,EACd,YAAY,EACZ,oBAAoB,EACpB,cAAc,EACd,QAAQ,EACR,kBAAkB,EAClB,KAAK,UAAU,EACf,KAAK,UAAU,EACf,KAAK,iBAAiB,EACtB,KAAK,YAAY,EACjB,KAAK,aAAa,EAClB,KAAK,YAAY,GAClB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,KAAK,eAAe,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAC1F,OAAO,EACL,WAAW,EACX,aAAa,EACb,eAAe,EACf,YAAY,EACZ,KAAK,SAAS,EACd,KAAK,QAAQ,EACb,KAAK,KAAK,GACX,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,WAAW,EACX,SAAS,EACT,GAAG,EACH,KAAK,UAAU,EACf,KAAK,MAAM,EACX,KAAK,eAAe,GACrB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,mBAAmB,EACnB,KAAK,YAAY,EACjB,KAAK,iBAAiB,EACtB,KAAK,QAAQ,EACb,KAAK,WAAW,EAChB,KAAK,QAAQ,EACb,KAAK,UAAU,GAChB,MAAM,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,YAAY,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AACnG,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,KAAK,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1E,OAAO,EAAE,SAAS,EAAE,KAAK,SAAS,EAAE,KAAK,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9E,OAAO,EACL,MAAM,EACN,mBAAmB,EACnB,kBAAkB,EAClB,UAAU,EACV,SAAS,EACT,UAAU,EACV,SAAS,EACT,KAAK,QAAQ,EACb,KAAK,WAAW,EAChB,KAAK,SAAS,EACd,KAAK,WAAW,GACjB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,iBAAiB,EACjB,eAAe,EACf,cAAc,EACd,gBAAgB,EAChB,YAAY,EACZ,KAAK,cAAc,EACnB,KAAK,WAAW,GACjB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,WAAW,EAAE,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAClK,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,QAAQ,EAAE,SAAS,EAAE,aAAa,EAAE,UAAU,EAAE,uBAAuB,EAAE,KAAK,kBAAkB,EAAE,KAAK,eAAe,EAAE,KAAK,qBAAqB,EAAE,KAAK,gBAAgB,EAAE,KAAK,aAAa,EAAE,KAAK,UAAU,EAAE,KAAK,WAAW,EAAE,KAAK,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,gBAAgB,CAAC;AACrW,OAAO,EAAE,wBAAwB,EAAE,KAAK,iBAAiB,EAAE,KAAK,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAC1G,OAAO,EAAE,aAAa,EAAE,KAAK,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAC7E,OAAO,EACL,mBAAmB,EACnB,sBAAsB,EACtB,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,GAC1B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,cAAc,EACd,mBAAmB,EACnB,YAAY,EACZ,KAAK,cAAc,EACnB,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,GAC1B,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,KAAK,kBAAkB,EAAE,KAAK,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC7G,OAAO,EACL,qBAAqB,EACrB,2BAA2B,EAC3B,mBAAmB,EACnB,mBAAmB,EACnB,UAAU,EACV,eAAe,EACf,oBAAoB,EACpB,iBAAiB,EACjB,iBAAiB,EACjB,iBAAiB,EACjB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,YAAY,EACjB,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,2BAA2B,EAChC,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,EACvB,KAAK,wBAAwB,GAC9B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,MAAM,EACN,iBAAiB,EACjB,cAAc,EACd,YAAY,EACZ,oBAAoB,EACpB,cAAc,EACd,QAAQ,EACR,kBAAkB,EAClB,KAAK,UAAU,EACf,KAAK,UAAU,EACf,KAAK,iBAAiB,EACtB,KAAK,YAAY,EACjB,KAAK,aAAa,EAClB,KAAK,YAAY,GAClB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,KAAK,eAAe,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAC1F,OAAO,EACL,WAAW,EACX,aAAa,EACb,eAAe,EACf,YAAY,EACZ,KAAK,SAAS,EACd,KAAK,QAAQ,EACb,KAAK,KAAK,GACX,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,WAAW,EACX,SAAS,EACT,GAAG,EACH,KAAK,UAAU,EACf,KAAK,MAAM,EACX,KAAK,eAAe,GACrB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,mBAAmB,EACnB,KAAK,YAAY,EACjB,KAAK,iBAAiB,EACtB,KAAK,QAAQ,EACb,KAAK,WAAW,EAChB,KAAK,QAAQ,EACb,KAAK,UAAU,GAChB,MAAM,kBAAkB,CAAC"}

package/dist/index.js

@@ -15,7 +15,7 @@ export { THEMES, DEFAULT_LIGHT_THEME, DEFAULT_DARK_THEME, NODE_LIGHT, NODE_DARK,
 export { renderGalleryHtml, renderFlowCards, renderFlowCard, mermaidBootstrap, flowAnchorId, } from './html.js';
 export { resolveSvgSize, rasterizerScript } from './raster.js';
 export { NsClient, NsApiError, assertBareServer, fetchDomainSnapshot, listDomains, asArray } from './nsClient.js';
-export { countDomainInventory, countInventoryDetail, listDomainInventory, itemsFor, itemLabel, destinationOf, usersByExt } from './inventory.js';
+export { countDomainInventory, countInventoryDetail, listDomainInventory, itemsFor, itemLabel, destinationOf, usersByExt, DEFAULT_DEVICE_SUFFIXES } from './inventory.js';
 export { attributeDomainInventory } from './attribution.js';
 export { NsWriteClient } from './nsWriteClient.js';
 export { supportsSynchronous, SYNCHRONOUS_OPERATIONS, } from './nsSynchronous.js';

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAGH,OAAO,EAAE,WAAW,EAAE,YAAY,EAAkB,MAAM,eAAe,CAAC;AAC1E,OAAO,EAAE,SAAS,EAAuC,MAAM,cAAc,CAAC;AAC9E,OAAO,EACL,MAAM,EACN,mBAAmB,EACnB,kBAAkB,EAClB,UAAU,EACV,SAAS,EACT,UAAU,EACV,SAAS,GAKV,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,iBAAiB,EACjB,eAAe,EACf,cAAc,EACd,gBAAgB,EAChB,YAAY,GAGb,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,WAAW,EAAE,OAAO,EAAkD,MAAM,eAAe,CAAC;AAClK,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,QAAQ,EAAE,SAAS,EAAE,aAAa,EAAE,UAAU,EAA6I,MAAM,gBAAgB,CAAC;AAC5R,OAAO,EAAE,wBAAwB,EAAgD,MAAM,kBAAkB,CAAC;AAC1G,OAAO,EAAE,aAAa,EAA4B,MAAM,oBAAoB,CAAC;AAC7E,OAAO,EACL,mBAAmB,EACnB,sBAAsB,GAGvB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,cAAc,EACd,mBAAmB,EACnB,YAAY,GAIb,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,YAAY,EAAE,WAAW,EAAiD,MAAM,mBAAmB,CAAC;AAC7G,OAAO,EACL,qBAAqB,EACrB,2BAA2B,EAC3B,mBAAmB,EACnB,mBAAmB,EACnB,UAAU,EACV,eAAe,EACf,oBAAoB,EACpB,iBAAiB,EACjB,iBAAiB,EACjB,iBAAiB,GAUlB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,MAAM,EACN,iBAAiB,EACjB,cAAc,EACd,YAAY,EACZ,oBAAoB,EACpB,cAAc,EACd,QAAQ,EACR,kBAAkB,GAOnB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAwB,cAAc,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAC1F,OAAO,EACL,WAAW,EACX,aAAa,EACb,eAAe,EACf,YAAY,GAIb,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,WAAW,EACX,SAAS,EACT,GAAG,GAIJ,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,mBAAmB,GAOpB,MAAM,kBAAkB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAGH,OAAO,EAAE,WAAW,EAAE,YAAY,EAAkB,MAAM,eAAe,CAAC;AAC1E,OAAO,EAAE,SAAS,EAAuC,MAAM,cAAc,CAAC;AAC9E,OAAO,EACL,MAAM,EACN,mBAAmB,EACnB,kBAAkB,EAClB,UAAU,EACV,SAAS,EACT,UAAU,EACV,SAAS,GAKV,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,iBAAiB,EACjB,eAAe,EACf,cAAc,EACd,gBAAgB,EAChB,YAAY,GAGb,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,WAAW,EAAE,OAAO,EAAkD,MAAM,eAAe,CAAC;AAClK,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,QAAQ,EAAE,SAAS,EAAE,aAAa,EAAE,UAAU,EAAE,uBAAuB,EAA6L,MAAM,gBAAgB,CAAC;AACrW,OAAO,EAAE,wBAAwB,EAAgD,MAAM,kBAAkB,CAAC;AAC1G,OAAO,EAAE,aAAa,EAA4B,MAAM,oBAAoB,CAAC;AAC7E,OAAO,EACL,mBAAmB,EACnB,sBAAsB,GAGvB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,cAAc,EACd,mBAAmB,EACnB,YAAY,GAIb,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,YAAY,EAAE,WAAW,EAAiD,MAAM,mBAAmB,CAAC;AAC7G,OAAO,EACL,qBAAqB,EACrB,2BAA2B,EAC3B,mBAAmB,EACnB,mBAAmB,EACnB,UAAU,EACV,eAAe,EACf,oBAAoB,EACpB,iBAAiB,EACjB,iBAAiB,EACjB,iBAAiB,GAUlB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,MAAM,EACN,iBAAiB,EACjB,cAAc,EACd,YAAY,EACZ,oBAAoB,EACpB,cAAc,EACd,QAAQ,EACR,kBAAkB,GAOnB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAwB,cAAc,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAC1F,OAAO,EACL,WAAW,EACX,aAAa,EACb,eAAe,EACf,YAAY,GAIb,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,WAAW,EACX,SAAS,EACT,GAAG,GAIJ,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,mBAAmB,GAOpB,MAAM,kBAAkB,CAAC"}

package/dist/inventory.d.ts

@@ -9,9 +9,9 @@
  * A device record from NetSapiens carries the SIP registration password. `listDomainInventory` builds
  * per-item lists — an extension's name and site, a number's kind and routing destination, an address's
  * label — from an allowlist of named fields, and `countDomainInventory` is a fold over those same
- * lists. The allowlist now includes a device's NAME (its `aor` local part, e.g. `101b` — the same
- * short id the portal shows) alongside its model; a device's MAC, SIP password and email never appear,
- * and nothing here should be added that carries one.
+ * lists. The allowlist now includes a device's NAME (the local part of its `device` SIP URI, falling back
+ * to `aor` — e.g. `101b`, the same short id the portal shows) alongside its model; a device's MAC, SIP
+ * password and email never appear, and nothing here should be added that carries one.
  *
  * ## Every countable dimension is a numeric leaf
  *
@@ -24,6 +24,20 @@
  * A user whose `service-code` is empty or does not begin with `system-`. NetSapiens models auto
  * attendants, queues and time-of-day routers as users, and counting them as seats would overstate
  * every domain that has any. They are counted separately, as information, and never compared.
+ *
+ * ## What counts as a fax line
+ *
+ * On the portal's "Fax Server" treatment a number is an ordinary phone number whose dial rule hands it
+ * to a fax server host — `dial-rule-application: to-connection` with
+ * `dial-rule-translation-destination-host` set to that host. There is no fax-account endpoint and the
+ * ATA is not a device on any user, so the host is the only thing in the API that says "this is a fax
+ * line", and nothing in the API can tell an analog fax from a digital one.
+ *
+ * The host is therefore the whole test, and it is the CALLER's: pass `{ faxServerHosts }` to
+ * {@link listDomainInventory} or {@link countDomainInventory}. Matching is on the trimmed host,
+ * case-insensitively, and on nothing else — not the `dial-rule-description`, which is a portal-written
+ * note an operator can edit. **With no hosts supplied nothing is a fax line**, because a library that
+ * hardcoded one deployment's fax server would be wrong everywhere else.
  */
 import type { Rec, Snapshot } from './model.js';
 export interface DomainInventory {
@@ -49,16 +63,30 @@ export interface DomainInventory {
     /** Extensions whose `voicemail-transcription-enabled` is anything but empty or `no`. */
     transcriptionEnabled: number;
     /**
-     * Extensions with a Microsoft Teams connector device — one whose SIP `aor` local part is the
-     * extension number followed by `t` (`1000t`), which is how the TeamMate connector registers.
-     * That device is NOT counted under `devices`: it is a connector, not a handset.
+     * Extensions with a Microsoft Teams connector device — one whose device-name SUFFIX the legend marks
+     * `teams: true`, which under {@link DEFAULT_DEVICE_SUFFIXES} is the extension number followed by `t`
+     * (`1000t`), how the TeamMate connector registers. See {@link deviceName} for which field that name is
+     * read from, and why reading the wrong one silently miscounted this. That device is NOT counted under
+     * `devices`: it is a connector, not a handset. A supplied legend with no `teams` suffix — a deployment
+     * without TeamMate — leaves this 0 and counts every device as a handset.
      */
     teamsConnected: number;
-    /** Phone numbers on the domain, split by NANP toll-free prefix. */
+    /**
+     * Phone numbers on the domain, split by NANP toll-free prefix — **fax lines excluded**.
+     *
+     * A number handed to the fax server is billed as a fax line, not as a DID, so `total`, `tollFree`
+     * and `local` all leave it out and `fax` counts it instead. `all` is every phone number the domain
+     * holds, fax lines included: `total + fax === all`.
+     *
+     * With no `faxServerHosts` supplied nothing is a fax line, `fax` is 0 and `total === all` — the
+     * numbers this returned before 0.7.0, unchanged.
+     */
     dids: {
         total: number;
         tollFree: number;
         local: number;
+        fax: number;
+        all: number;
     };
     /** E911 address records on the domain. */
     e911Addresses: number;
@@ -99,17 +127,27 @@ export interface ExtensionItem {
     /** `device-models-model` per handset, `(unknown)` when blank. Never the MAC. */
     deviceModels: string[];
     /**
-     * Every device on this extension, in record order, connector included: `name` is the `aor` local
-     * part (`sip:101b@acme.example` → `101b`) — the device NAME as the portal shows it — `model` is
+     * Every device on this extension, in record order, connector included: `name` is the local part of its
+     * `device` SIP URI, or of `aor` when that is all the record has (`sip:101b@acme.example` → `101b`) —
+     * the device NAME as the portal shows it — `model` is
      * `device-models-model` (`(unknown)` when blank on a handset, `''` for the Teams connector, which
      * has no model), and `teams` marks the connector entry itself. `deviceCount`/`deviceModels`/`teams`
      * above stay handset-only; this list is the one place a connector's own row shows up. Never the MAC
      * or the SIP password.
+     *
+     * `suffix` is what the name carries AFTER the extension number (`1001wp` on ext `1001` → `wp`; a bare
+     * `1001` → `''`), lower-cased; a name that does not start with the extension has no suffix, and neither
+     * does a device on an extension with no number. `kind` is that suffix's label from the legend in
+     * {@link InventoryOptions.deviceSuffixes} — `''` when the suffix is empty OR when the legend does not
+     * carry it, because an unlisted suffix is a name this deployment has not explained, not a device type
+     * to guess at.
      */
     devices: Array<{
         name: string;
         model: string;
         teams: boolean;
+        suffix: string;
+        kind: string;
     }>;
     /** `deviceCount > 0 || teams` — has a device of any kind, handset or connector. */
     anyDevice: boolean;
@@ -118,6 +156,14 @@ export interface NumberItem {
     key: string;
     number: string;
     kind: 'local' | 'tollFree';
+    /**
+     * This number is handed to a fax server — see the module doc. `false` whenever the caller supplied no
+     * `faxServerHosts`, since without a host list nothing here can tell a fax line from any other number.
+     *
+     * `kind` is still set on a fax line (a fax number is local or toll-free like any other), but the
+     * COUNTS exclude it from `dids.total`/`local`/`tollFree` and count it under `dids.fax` instead.
+     */
+    fax: boolean;
     /** Where the number routes, for a person: see {@link destinationOf}. `''` when the record says nothing. */
     destination: string;
     /** `dial-rule-description` trimmed — the note the portal writes ("Portal Created: User - 1001"); `''` when blank. */
@@ -141,6 +187,45 @@ export interface DomainInventoryDetail {
     e911Addresses: AddressItem[];
     smsNumbers: SmsItem[];
 }
+/** A device-name suffix legend: `suffix → { label, teams? }`. See {@link InventoryOptions.deviceSuffixes}. */
+export type DeviceSuffixLegend = Record<string, {
+    label: string;
+    teams?: boolean;
+}>;
+/**
+ * The three device-name suffixes NetSapiens itself ships — SNAPmobile Web, SNAPmobile, and the TeamMate
+ * Microsoft Teams connector. Used whenever a caller supplies no `deviceSuffixes`, and it is the same
+ * table `resolver.ts` names a simultaneous-ring device by, so a suffix means one thing in this library.
+ *
+ * A deployment's OWN suffixes (a white-labelled app, say) are not here and never will be: they belong to
+ * the operator, who supplies them through {@link InventoryOptions.deviceSuffixes}.
+ */
+export declare const DEFAULT_DEVICE_SUFFIXES: Readonly<DeviceSuffixLegend>;
+/**
+ * What the caller has to tell the counter that the API cannot. Optional in full: every option absent is
+ * the pre-0.7.0 behaviour, and no option changes what a snapshot has to contain.
+ */
+export interface InventoryOptions {
+    /**
+     * The hosts a fax line is handed to — an IP or a hostname, as it appears in
+     * `dial-rule-translation-destination-host`. Compared trimmed and case-insensitively; blanks are
+     * ignored. Absent or empty means NO number is a fax line. See the module doc for why this is the
+     * caller's to supply.
+     */
+    faxServerHosts?: readonly string[];
+    /**
+     * What a device-name SUFFIX means on this deployment: `suffix → { label, teams? }`. Compared
+     * case-insensitively, and it REPLACES {@link DEFAULT_DEVICE_SUFFIXES} wholesale rather than merging
+     * with it — a deployment that has no TeamMate omits `t` and Teams detection is then off entirely,
+     * which a merge could not express.
+     *
+     * `teams: true` marks the suffix that names a Microsoft Teams CONNECTOR rather than a handset: it is
+     * what {@link ExtensionItem.teams} and {@link DomainInventory.teamsConnected} test, and what keeps the
+     * connector out of `deviceCount`/`deviceModels`. At most one suffix normally carries it, but nothing
+     * here requires that.
+     */
+    deviceSuffixes?: DeviceSuffixLegend;
+}
 export declare const str: (v: unknown) => string;
 /** Is this user one of NetSapiens' internal routing objects rather than a seat? */
 export declare function isSystemUser(user: Rec): boolean;
@@ -170,8 +255,13 @@ export declare function usersByExt(users: Rec[]): Map<string, Rec>;
  * - No destination but an application is set → `to <application>` (`to-connection` → `to connection`,
  *   `to-voicemail` → `to voicemail`).
  * - Neither is set → `''`.
+ *
+ * A FAX LINE — a number whose destination host is one of `faxServerHosts` — short-circuits all of that
+ * and reads `to fax server`, host omitted. Otherwise it would render as `to connection` (which names
+ * plumbing, not a destination) or, on a rule that also carries a destination user, as a bare IP address
+ * beside a customer's phone number. Nobody reading this line needs the fax server's address.
  */
-export declare function destinationOf(p: Rec, userByExt: Map<string, Rec>): string;
+export declare function destinationOf(p: Rec, userByExt: Map<string, Rec>, faxServerHosts?: readonly string[]): string;
 /**
  * The items behind every count. Pure. Fields are copied by name from an allowlist; no record passes
  * through, so a device's MAC or SIP password cannot reach a consumer by accident.
@@ -189,9 +279,9 @@ export declare function destinationOf(p: Rec, userByExt: Map<string, Rec>): stri
  * countable thing, and one derived row is more honest than two that shuffle. A blank id is a
  * provisioning fault to fix; the fallback only keeps the distinguishable ones apart until it is.
  */
-export declare function listDomainInventory(snapshot: Snapshot): DomainInventoryDetail;
+export declare function listDomainInventory(snapshot: Snapshot, opts?: InventoryOptions): DomainInventoryDetail;
 /** The counts, as a fold over {@link listDomainInventory} so the two can never disagree. */
-export declare function countDomainInventory(snapshot: Snapshot): DomainInventory;
+export declare function countDomainInventory(snapshot: Snapshot, opts?: InventoryOptions): DomainInventory;
 /**
  * Count an item list. Exposed separately so a consumer that has FILTERED the lists — to one site, to
  * one billing account — gets counts that agree with what it kept, rather than re-counting the snapshot.

package/dist/inventory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"inventory.d.ts","sourceRoot":"","sources":["../src/inventory.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,OAAO,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEhD,MAAM,WAAW,eAAe;IAC9B,yEAAyE;IACzE,UAAU,EAAE;QACV,KAAK,EAAE,MAAM,CAAC;QACd,8DAA8D;QAC9D,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAChC,kEAAkE;QAClE,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACtC,sGAAsG;QACtG,aAAa,EAAE,MAAM,CAAC,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,IAAI,EAAE,MAAM,CAAC,CAAC;QACtD,oFAAoF;QACpF,aAAa,EAAE,MAAM,CAAC;QACtB,6FAA6F;QAC7F,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC;IACF,8FAA8F;IAC9F,WAAW,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,CAAC;IACtE,wFAAwF;IACxF,oBAAoB,EAAE,MAAM,CAAC;IAC7B;;;;OAIG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB,mEAAmE;IACnE,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IACzD,0CAA0C;IAC1C,aAAa,EAAE,MAAM,CAAC;IACtB,yCAAyC;IACzC,UAAU,EAAE,MAAM,CAAC;IACnB,wFAAwF;IACxF,OAAO,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,CAAC;CAC7D;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;OAKG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,+EAA+E;IAC/E,IAAI,EAAE,MAAM,CAAC;IACb,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,qCAAqC;IACrC,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,OAAO,CAAC;IACvB,kDAAkD;IAClD,KAAK,EAAE,OAAO,CAAC;IACf,uDAAuD;IACvD,WAAW,EAAE,MAAM,CAAC;IACpB,gFAAgF;IAChF,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB;;;;;;;OAOG;IACH,OAAO,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IAChE,mFAAmF;IACnF,SAAS,EAAE,OAAO,CAAC;CACpB;AACD,MAAM,WAAW,UAAU;IACzB,GAAG,EAAE,MAAM,CAAkE;IAC7E,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,OAAO,GAAG,UAAU,CAAC;IAC3B,2GAA2G;IAC3G,WAAW,EAAE,MAAM,CAAC;IACpB,qHAAqH;IACrH,WAAW,EAAE,MAAM,CAAC;CACrB;AACD,MAAM,WAAW,WAAW;IAAG,GAAG,EAAE,MAAM,CAAyE;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE;AACnI,MAAM,WAAW,OAAO;IAAG,GAAG,EAAE,MAAM,CAA6D;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE;AACpH,MAAM,MAAM,aAAa,GAAG,aAAa,GAAG,UAAU,GAAG,WAAW,GAAG,OAAO,CAAC;AAE/E,MAAM,WAAW,qBAAqB;IACpC,+CAA+C;IAC/C,UAAU,EAAE,aAAa,EAAE,CAAC;IAC5B,qCAAqC;IACrC,WAAW,EAAE,aAAa,EAAE,CAAC;IAC7B,IAAI,EAAE,UAAU,EAAE,CAAC;IACnB,aAAa,EAAE,WAAW,EAAE,CAAC;IAC7B,UAAU,EAAE,OAAO,EAAE,CAAC;CACvB;AAKD,eAAO,MAAM,GAAG,GAAI,GAAG,OAAO,KAAG,MAAgF,CAAC;AAiClH,mFAAmF;AACnF,wBAAgB,YAAY,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAE/C;AAmDD;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAOzD;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAmBzE;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,QAAQ,GAAG,qBAAqB,CAgD7E;AAED,4FAA4F;AAC5F,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,QAAQ,GAAG,eAAe,CAExE;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,EAAE,qBAAqB,GAAG,eAAe,CA0B9E;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,MAAM,EAAE,qBAAqB,EAAE,IAAI,EAAE,MAAM,GAAG,aAAa,EAAE,GAAG,SAAS,CAmBjG;AAED,8GAA8G;AAC9G,wBAAgB,SAAS,CAAC,IAAI,EAAE,aAAa,GAAG,MAAM,CAQrD"}
+{"version":3,"file":"inventory.d.ts","sourceRoot":"","sources":["../src/inventory.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,OAAO,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEhD,MAAM,WAAW,eAAe;IAC9B,yEAAyE;IACzE,UAAU,EAAE;QACV,KAAK,EAAE,MAAM,CAAC;QACd,8DAA8D;QAC9D,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAChC,kEAAkE;QAClE,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACtC,sGAAsG;QACtG,aAAa,EAAE,MAAM,CAAC,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,IAAI,EAAE,MAAM,CAAC,CAAC;QACtD,oFAAoF;QACpF,aAAa,EAAE,MAAM,CAAC;QACtB,6FAA6F;QAC7F,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC;IACF,8FAA8F;IAC9F,WAAW,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,CAAC;IACtE,wFAAwF;IACxF,oBAAoB,EAAE,MAAM,CAAC;IAC7B;;;;;;;OAOG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;;;;;;;;OASG;IACH,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;IACnF,0CAA0C;IAC1C,aAAa,EAAE,MAAM,CAAC;IACtB,yCAAyC;IACzC,UAAU,EAAE,MAAM,CAAC;IACnB,wFAAwF;IACxF,OAAO,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,CAAC;CAC7D;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;OAKG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,+EAA+E;IAC/E,IAAI,EAAE,MAAM,CAAC;IACb,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,qCAAqC;IACrC,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,OAAO,CAAC;IACvB,kDAAkD;IAClD,KAAK,EAAE,OAAO,CAAC;IACf,uDAAuD;IACvD,WAAW,EAAE,MAAM,CAAC;IACpB,gFAAgF;IAChF,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB;;;;;;;;;;;;;;;OAeG;IACH,OAAO,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,OAAO,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC9F,mFAAmF;IACnF,SAAS,EAAE,OAAO,CAAC;CACpB;AACD,MAAM,WAAW,UAAU;IACzB,GAAG,EAAE,MAAM,CAAkE;IAC7E,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,OAAO,GAAG,UAAU,CAAC;IAC3B;;;;;;OAMG;IACH,GAAG,EAAE,OAAO,CAAC;IACb,2GAA2G;IAC3G,WAAW,EAAE,MAAM,CAAC;IACpB,qHAAqH;IACrH,WAAW,EAAE,MAAM,CAAC;CACrB;AACD,MAAM,WAAW,WAAW;IAAG,GAAG,EAAE,MAAM,CAAyE;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE;AACnI,MAAM,WAAW,OAAO;IAAG,GAAG,EAAE,MAAM,CAA6D;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE;AACpH,MAAM,MAAM,aAAa,GAAG,aAAa,GAAG,UAAU,GAAG,WAAW,GAAG,OAAO,CAAC;AAE/E,MAAM,WAAW,qBAAqB;IACpC,+CAA+C;IAC/C,UAAU,EAAE,aAAa,EAAE,CAAC;IAC5B,qCAAqC;IACrC,WAAW,EAAE,aAAa,EAAE,CAAC;IAC7B,IAAI,EAAE,UAAU,EAAE,CAAC;IACnB,aAAa,EAAE,WAAW,EAAE,CAAC;IAC7B,UAAU,EAAE,OAAO,EAAE,CAAC;CACvB;AAED,8GAA8G;AAC9G,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC,CAAC;AAEpF;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB,EAAE,QAAQ,CAAC,kBAAkB,CAI/D,CAAC;AAEH;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;;OAKG;IACH,cAAc,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACnC;;;;;;;;;;OAUG;IACH,cAAc,CAAC,EAAE,kBAAkB,CAAC;CACrC;AAKD,eAAO,MAAM,GAAG,GAAI,GAAG,OAAO,KAAG,MAAgF,CAAC;AAiClH,mFAAmF;AACnF,wBAAgB,YAAY,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAE/C;AAqHD;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAOzD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,cAAc,CAAC,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,CAoB7G;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,gBAAgB,GAAG,qBAAqB,CAuDtG;AAED,4FAA4F;AAC5F,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,gBAAgB,GAAG,eAAe,CAEjG;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,EAAE,qBAAqB,GAAG,eAAe,CAkC9E;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,MAAM,EAAE,qBAAqB,EAAE,IAAI,EAAE,MAAM,GAAG,aAAa,EAAE,GAAG,SAAS,CAwBjG;AAED,8GAA8G;AAC9G,wBAAgB,SAAS,CAAC,IAAI,EAAE,aAAa,GAAG,MAAM,CAQrD"}

package/dist/inventory.js

@@ -1,3 +1,16 @@
+/**
+ * The three device-name suffixes NetSapiens itself ships — SNAPmobile Web, SNAPmobile, and the TeamMate
+ * Microsoft Teams connector. Used whenever a caller supplies no `deviceSuffixes`, and it is the same
+ * table `resolver.ts` names a simultaneous-ring device by, so a suffix means one thing in this library.
+ *
+ * A deployment's OWN suffixes (a white-labelled app, say) are not here and never will be: they belong to
+ * the operator, who supplies them through {@link InventoryOptions.deviceSuffixes}.
+ */
+export const DEFAULT_DEVICE_SUFFIXES = Object.freeze({
+    wp: { label: 'SNAPmobile Web' },
+    m: { label: 'SNAPmobile' },
+    t: { label: 'Teams', teams: true },
+});
 /** NANP toll-free area codes, 800 through 888. A number outside this set is counted local. */
 const TOLL_FREE = new Set(['800', '833', '844', '855', '866', '877', '888']);
 export const str = (v) => (typeof v === 'string' ? v.trim() : v == null ? '' : String(v).trim());
@@ -43,17 +56,83 @@ function isTollFree(raw) {
     const nanp = digits.length === 11 && digits.startsWith('1') ? digits.slice(1) : digits;
     return nanp.length === 10 && TOLL_FREE.has(nanp.slice(0, 3));
 }
-/** The local part of a device's `aor` (`sip:103t@acme.example` → `103t`), read only to test for Teams. */
-function aorLocal(device) {
-    const a = str(device.aor).replace(/^sip:/i, '');
+/** The fax-server hosts, trimmed, lower-cased and with blanks dropped — the shape {@link isFaxLine} tests against. */
+function faxHosts(hosts) {
+    const out = new Set();
+    for (const h of hosts ?? []) {
+        const v = str(h).toLowerCase();
+        if (v)
+            out.add(v);
+    }
+    return out;
+}
+/**
+ * Is this number handed to a fax server? The `dial-rule-translation-destination-host` alone, matched
+ * against the caller's list — never the `dial-rule-description`, which is a note the portal writes and
+ * an operator can edit. An empty host set answers `false` for everything, which is the point: this
+ * library knows no fax server of its own.
+ */
+function isFaxLine(p, hosts) {
+    if (!hosts.size)
+        return false;
+    return hosts.has(str(p['dial-rule-translation-destination-host']).toLowerCase());
+}
+/**
+ * A device's NAME — the local part of its SIP URI (`sip:103t@acme.example` → `103t`), which is the short
+ * id the portal shows and the string the Teams test matches against.
+ *
+ * **`device` first, `aor` second.** A live `/users/<ext>/devices` record names the device in `device` and
+ * frequently carries no `aor` at all; reading `aor` alone therefore returned `''` on live data, which
+ * blanked every device name on the page AND broke the `<ext>t` Teams test — so a Teams connector read as
+ * `teams: false` and was counted as a handset in `deviceCount` and `devices.total`. Some records carry
+ * both, and then `device` wins, being the field the system actually names the device by. Neither, and the
+ * name is `''` rather than a guess.
+ */
+function deviceName(device) {
+    const a = (str(device.device) || str(device.aor)).replace(/^sip:/i, '');
     const at = a.indexOf('@');
     return at === -1 ? a : a.slice(0, at);
 }
-function extensionItem(u, devices) {
+/**
+ * The legend, lower-cased once so every lookup is a case-insensitive hit rather than a scan. A caller's
+ * legend REPLACES the default; two keys differing only in case collapse, last one wins, which is the
+ * only sane reading of a case-insensitive table.
+ */
+function suffixLegend(opts) {
+    const src = opts?.deviceSuffixes ?? DEFAULT_DEVICE_SUFFIXES;
+    // Prototype-free: the key is a device-name suffix off a snapshot, so `constructor`, `toString` and
+    // `hasOwnProperty` are all reachable keys, and on a plain object each would answer with something
+    // inherited. `Object.entries` copies own enumerable keys only, so nothing inherited gets in either.
+    const out = Object.create(null);
+    for (const [k, v] of Object.entries(src))
+        out[k.trim().toLowerCase()] = v;
+    return out;
+}
+/**
+ * What a device's name carries AFTER the extension number, lower-cased: `1001wp` on ext `1001` → `wp`,
+ * a bare `1001` → `''`. A name that does not start with the extension has no suffix at all — `sales1` on
+ * ext `1001` is a differently-named device, not a device of kind `sales1` — and neither does anything on
+ * an extension with no number, which is what keeps a device NAMED a bare `t` off the Teams legend.
+ */
+function deviceSuffix(name, ext) {
+    if (!ext || !name.startsWith(ext))
+        return '';
+    return name.slice(ext.length).toLowerCase();
+}
+function extensionItem(u, devices, legend) {
     const ext = str(u.user);
-    // The Teams test is `<ext>t`, so a blank ext would read every device whose aor local part is a
-    // bare `t` as a connector. No extension number, no Teams claim.
-    const handsets = ext ? devices.filter((d) => aorLocal(d) !== `${ext}t`) : devices;
+    // Every device, once: its name, its suffix, and what the legend says that suffix is. Computed here and
+    // read three times below, so the Teams test, the handset filter and the display list cannot disagree.
+    const rows = devices.map((d) => {
+        const name = deviceName(d);
+        const suffix = deviceSuffix(name, ext);
+        const entry = suffix ? legend[suffix] : undefined;
+        return { d, name, suffix, kind: entry?.label ?? '', teams: entry?.teams === true };
+    });
+    // A CONNECTOR is a device whose suffix the legend marks `teams` — under the default legend that is
+    // `<ext>t` and nothing else, which is exactly the test this replaced. A legend without a `teams`
+    // suffix has no connectors, and every device on the extension is a handset.
+    const handsets = rows.filter((r) => !r.teams);
     const transcription = str(u['voicemail-transcription-enabled']).toLowerCase();
     const teams = handsets.length !== devices.length;
     const name = `${str(u['name-first-name'])} ${str(u['name-last-name'])}`.trim();
@@ -71,12 +150,15 @@ function extensionItem(u, devices) {
         deviceCount: handsets.length,
         // A device whose model is blank is listed under a named bucket rather than dropped: a missing
         // model is a provisioning gap worth seeing, and a silently smaller total hides it.
-        deviceModels: handsets.map((d) => str(d['device-models-model']) || '(unknown)'),
+        deviceModels: handsets.map((r) => str(r.d['device-models-model']) || '(unknown)'),
         // Every device, including the Teams connector — this is a display list, not a seat count.
-        devices: devices.map((d) => {
-            const isTeams = ext ? aorLocal(d) === `${ext}t` : false;
-            return { name: aorLocal(d), model: isTeams ? '' : str(d['device-models-model']) || '(unknown)', teams: isTeams };
-        }),
+        devices: rows.map((r) => ({
+            name: r.name,
+            model: r.teams ? '' : str(r.d['device-models-model']) || '(unknown)',
+            teams: r.teams,
+            suffix: r.suffix,
+            kind: r.kind,
+        })),
         anyDevice: handsets.length > 0 || teams,
     };
 }
@@ -114,8 +196,15 @@ export function usersByExt(users) {
  * - No destination but an application is set → `to <application>` (`to-connection` → `to connection`,
  *   `to-voicemail` → `to voicemail`).
  * - Neither is set → `''`.
+ *
+ * A FAX LINE — a number whose destination host is one of `faxServerHosts` — short-circuits all of that
+ * and reads `to fax server`, host omitted. Otherwise it would render as `to connection` (which names
+ * plumbing, not a destination) or, on a rule that also carries a destination user, as a bare IP address
+ * beside a customer's phone number. Nobody reading this line needs the fax server's address.
  */
-export function destinationOf(p, userByExt) {
+export function destinationOf(p, userByExt, faxServerHosts) {
+    if (isFaxLine(p, faxHosts(faxServerHosts)))
+        return 'to fax server';
     const dest = str(p['dial-rule-translation-destination-user']);
     const app = str(p['dial-rule-application']).replace(/^to-/i, '');
     const host = str(p['dial-rule-translation-destination-host']);
@@ -151,7 +240,7 @@ export function destinationOf(p, userByExt) {
  * countable thing, and one derived row is more honest than two that shuffle. A blank id is a
  * provisioning fault to fix; the fallback only keeps the distinguishable ones apart until it is.
  */
-export function listDomainInventory(snapshot) {
+export function listDomainInventory(snapshot, opts) {
     const users = Array.isArray(snapshot.users) ? snapshot.users : [];
     const devicesByUser = (snapshot.devicesByUser ?? {});
     const phonenumbers = Array.isArray(snapshot.phonenumbers) ? snapshot.phonenumbers : [];
@@ -159,6 +248,8 @@ export function listDomainInventory(snapshot) {
     const smsnumbers = Array.isArray(snapshot.smsnumbers) ? snapshot.smsnumbers : [];
     const extensions = [];
     const systemUsers = [];
+    // Normalised once, not per extension: the legend is the caller's and does not change mid-fold.
+    const legend = suffixLegend(opts);
     for (let i = 0; i < users.length; i++) {
         const u = users[i];
         const ext = str(u.user);
@@ -168,16 +259,21 @@ export function listDomainInventory(snapshot) {
         // from a backup or a fixture. Dropping it would read as a clean match on a domain that has
         // handsets nobody can see; two blank users sharing one list overcount instead, which is a
         // visible drift an operator investigates, and that is the failure worth having.
-        const item = extensionItem(u, devicesByUser[ext] ?? []);
+        const item = extensionItem(u, devicesByUser[ext] ?? [], legend);
         (isSystemUser(u) ? systemUsers : extensions).push(item);
     }
     const userByExt = usersByExt(users);
+    // Normalised once, not per number: the host list is the caller's and does not change mid-fold.
+    const hosts = faxHosts(opts?.faxServerHosts);
     const dids = phonenumbers.map((p) => {
         const number = str(p.phonenumber);
         const kind = isTollFree(number) ? 'tollFree' : 'local';
-        const destination = destinationOf(p, userByExt);
+        const fax = isFaxLine(p, hosts);
+        // The KEY does not carry `fax`. It is a fact about how the number is routed today, and routing a
+        // number to the fax server must not orphan every decision a consumer recorded against it.
+        const destination = fax ? 'to fax server' : destinationOf(p, userByExt);
         const description = str(p['dial-rule-description']);
-        return { key: identityKey('did', number, JSON.stringify({ number, kind })), number, kind, destination, description };
+        return { key: identityKey('did', number, JSON.stringify({ number, kind })), number, kind, fax, destination, description };
     });
     const e911Addresses = addresses.map((a, i) => {
         const id = str(a['emergency-address-id']);
@@ -200,8 +296,8 @@ export function listDomainInventory(snapshot) {
     return { extensions, systemUsers, dids, e911Addresses, smsNumbers };
 }
 /** The counts, as a fold over {@link listDomainInventory} so the two can never disagree. */
-export function countDomainInventory(snapshot) {
-    return countInventoryDetail(listDomainInventory(snapshot));
+export function countDomainInventory(snapshot, opts) {
+    return countInventoryDetail(listDomainInventory(snapshot, opts));
 }
 /**
  * Count an item list. Exposed separately so a consumer that has FILTERED the lists — to one site, to
@@ -213,7 +309,7 @@ export function countInventoryDetail(d) {
         systemUsers: { total: d.systemUsers.length, byServiceCode: {} },
         transcriptionEnabled: 0,
         teamsConnected: 0,
-        dids: { total: d.dids.length, tollFree: 0, local: 0 },
+        dids: { total: 0, tollFree: 0, local: 0, fax: 0, all: d.dids.length },
         e911Addresses: d.e911Addresses.length,
         smsNumbers: d.smsNumbers.length,
         devices: { total: 0, byModel: {} },
@@ -239,7 +335,16 @@ export function countInventoryDetail(d) {
         for (const m of x.deviceModels)
             bump(inv.devices.byModel, m);
     }
+    // A fax line is billed as a fax line, so it lands in `fax` and in NEITHER of the two DID buckets —
+    // counting it as both would bill one number twice on a rulebook that has a rule for each. `fax` is
+    // read off the item rather than recomputed: an item list a consumer FILTERED still carries it, and a
+    // list built by a pre-0.7.0 lib has no `fax` at all, which reads as false and counts as it always did.
     for (const n of d.dids) {
+        if (n.fax) {
+            inv.dids.fax++;
+            continue;
+        }
+        inv.dids.total++;
         if (n.kind === 'tollFree')
             inv.dids.tollFree++;
         else
@@ -276,12 +381,19 @@ export function itemsFor(detail, path) {
         return ex.filter((x) => x.transcription);
     if (path === 'teamsConnected')
         return ex.filter((x) => x.teams);
+    // The three DID paths exclude fax lines, exactly as the counts do — a `counts: "dids.total"` rule
+    // whose observed number left the fax lines out but whose item list showed them would offer an
+    // operator rows to accept that the number above them does not count.
     if (path === 'dids.total')
-        return detail.dids;
+        return detail.dids.filter((n) => !n.fax);
     if (path === 'dids.tollFree')
-        return detail.dids.filter((n) => n.kind === 'tollFree');
+        return detail.dids.filter((n) => !n.fax && n.kind === 'tollFree');
     if (path === 'dids.local')
-        return detail.dids.filter((n) => n.kind === 'local');
+        return detail.dids.filter((n) => !n.fax && n.kind === 'local');
+    if (path === 'dids.fax')
+        return detail.dids.filter((n) => n.fax);
+    if (path === 'dids.all')
+        return detail.dids;
     if (path === 'e911Addresses')
         return detail.e911Addresses;
     if (path === 'smsNumbers')