netanalyzer/constants.js
Joseph McQueen b3c37bd7df feat: st command suite, Webex phone + Atlas AV integrations, dockerized remote agent
Rebrand NetAnalyzer -> StoreHealthAnalyzer and consolidate the store
reporting surface into a single `st [number]` command with focused
sub-modes.

Commands
- st [number]                - general info (SIW + brands + Meraki net link)
- st [number] network        - switches, APs, store server
- st [number] pos            - registers, payment terminals, customer display
- st [number] ios            - MDM-tracked iOS hardware
- st [number] phone          - wired 78xx + DECT basestations/handsets with
                               registration state, extensions and main DID
- st [number] av             - Atlas AMPs + MDM-tracked Apple TVs, video
                               walls, music players, LED displays
- Removed `analyze` in favor of the unified `st` surface

Integrations
- integrations/webex: Service App OAuth with rotating refresh tokens,
  seed + cleanup scripts, tokens/ storage (git-ignored)
- integrations/atlas: Xyte client + cached device discovery keyed on
  zero-padded 6-digit store numbers, cold-cache failure -> unavailable
  banner instead of a misleading empty result
- services/webexPhone, services/webexService, services/avService: shape
  raw upstream data into the report layer's contract
- utils/merakiMatcher: FQDN hostname extraction so payment terminals
  match Meraki descriptions; case-insensitive lookup
- utils/chunkReport: split long markdown replies at 7000-char boundaries

Reliability / ops
- server.js: awaited framework.stop() + 8s hard-kill timer so nodemon /
  Docker restarts don't leak WDM device registrations ("excessive device
  registrations")
- nodemon.json: SIGINT so the graceful path always runs
- scripts/cleanupWebexDevices.js: one-shot WDM cleanup utility
- Group-space routing: hears() regexes tolerate the leading @BotName
  prefix Webex prepends to mentions
- Replaced HTML-unsafe <number> placeholders with [number] in all help
  strings

Remote agent containerization
- docker/remote-agent/: multi-stage node:22-alpine image, non-root user,
  tini for signal handling, minimal deps (ws/axios/dotenv)
- docker/remote-agent/package.sh: docker buildx build defaulting to
  linux/amd64 (with override), saves image + assembles deploy/ + writes
  SHA256 + zips for offline transfer
- docker/remote-agent/deploy/: runtime docker-compose.yml, install.sh
  with platform sanity check, remote-host README
- .dockerignore + .gitignore updates for build artifacts and dist bundles
- npm run agent:package convenience script

Cleanup
- Dropped storeHealth.js / HealthReport.js and their tests/mocks in favor
  of the shared storeDetail pipeline
- Store model handles null SIW records gracefully; toSummary always
  ends with a newline so the Meraki link sits on its own line

Tests
- 144 tests across 14 suites passing; new coverage for atlasClient,
  atlasDevices, avService, avCategory classification, webexPhone,
  webexServiceAppAuth, storeDetail integration, siw, chunkReport and
  the updated meraki matcher

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-07-06 09:54:41 -04:00

81 lines
2.6 KiB
JavaScript

/**
* Shared constants used across the bot, integrations, and services.
*/
const STORE_MODES = Object.freeze({
INFO: 'info', // bare `st <n>` — just the Store header (location + general)
NETWORK: 'network', // switches, APs, and store server(s)
POS: 'pos', // store server + registers + mobile registers + printers + payment terminals
IOS: 'ios', // iOS devices (iPhones)
PHONE: 'phone', // placeholder — simplified phone-device view (CollabSupport-style)
AV: 'av', // placeholder — simplified A/V-device view (CollabSupport-style)
});
/**
* MDM (Workspace ONE) device-name conventions.
* Devices are classified by substring on UserName or DeviceFriendlyName.
*/
const MDM_DEVICE_TYPES = Object.freeze({
SERVER: 'SRV',
MOBILE_REGISTER: 'MR',
CUSTOMER_DISPLAY: 'CD',
IPHONE: 'IPH',
});
/**
* MDM-side AV hardware buckets. Names are matched (case-insensitive) against
* the device's friendly name. AppleTV is checked first because the others
* are short substrings that could appear inside an Apple TV's name.
* Mirrors collabFinder `STRICT_AV_PATTERN` (services/enrichment/filters.js).
*/
const AV_CATEGORIES = Object.freeze({
APPLE_TV: 'AppleTV',
VIDEO_WALL: 'VW',
MUSIC: 'MSC',
LED: 'LED',
});
const AV_FRIENDLY_NAME_PATTERN = /(VW|MSC|LED|AppleTV)/i;
/**
* Return the canonical device-name string used to classify an MDM device.
*/
function mdmDeviceName(device) {
if (!device) return '';
return (device.UserName || device.DeviceFriendlyName || '').toString();
}
/**
* Filter MDM devices whose name contains the given marker (SRV/MR/CD/IPH).
*/
function filterMdmByType(devices, marker) {
if (!Array.isArray(devices) || !marker) return [];
return devices.filter(d => mdmDeviceName(d).includes(marker));
}
/**
* Classify an MDM device into one of the AV categories, or null if it is
* not an AV device. Order of checks matters: AppleTV is most specific, so
* if a device name accidentally contains both "AppleTV" and one of the
* short markers, it's still classified as an Apple TV.
*/
function classifyMdmAvDevice(deviceOrName) {
const name = typeof deviceOrName === 'string' ? deviceOrName : mdmDeviceName(deviceOrName);
if (!name) return null;
if (/AppleTV/i.test(name)) return AV_CATEGORIES.APPLE_TV;
if (/VW/.test(name)) return AV_CATEGORIES.VIDEO_WALL;
if (/MSC/.test(name)) return AV_CATEGORIES.MUSIC;
if (/LED/.test(name)) return AV_CATEGORIES.LED;
return null;
}
module.exports = {
STORE_MODES,
MDM_DEVICE_TYPES,
AV_CATEGORIES,
AV_FRIENDLY_NAME_PATTERN,
mdmDeviceName,
filterMdmByType,
classifyMdmAvDevice,
};