CXoneSkillAgentsProvider | nice-cxone-acd-agent-apps

Provider that polls the CMA skill-agents API via a shared util-worker web worker and emits paged results via skillAgentsEvent. Using the worker offloads the HTTP fetch and JSON parsing off the main thread, preventing UI jank when the assigned-agents list is large (hundreds or thousands of agents).

example

provider.startPolling(skillId);
provider.skillAgentsEvent.subscribe((response) => { ... });
provider.stopPolling();

Hierarchy

CXoneSkillAgentsProvider

Constructors

constructor

new CXoneSkillAgentsProvider(): CXoneSkillAgentsProvider

- Defined in agent-sdk/src/lib/directory/provider/cxone-skill-agents-provider.ts:65
Creates the provider and wires up a REFRESH_TOKEN_SUCCESS listener so the worker is restarted whenever the auth token is refreshed.

example
-- const provider = new CXoneSkillAgentsProvider();

Returns CXoneSkillAgentsProvider

Properties

Private Readonly acdSession

acdSession: ACDSessionManager = ACDSessionManager.instance

Private Readonly apiParser

apiParser: SkillApiParser = ...

Private currentPageSize

currentPageSize: number = DEFAULT_PAGE_SIZE

Private currentPollingInterval

currentPollingInterval: number = 5000

Private currentSearchString

currentSearchString: string = ''

Private currentSkillId

currentSkillId: number

Private currentUpdatedSince

currentUpdatedSince: string = INITIAL_UPDATED_SINCE

Private Readonly logger

logger: Logger = ...

Private pollingTimer

pollingTimer: Timer

Timer handle for the main-thread polling interval (worker fires single-shot per tick).

pollingWorker

pollingWorker: any

The running web worker instance (util-worker).

skillAgentsEvent

skillAgentsEvent: Subject<SkillAgentsApiResponse> = ...

Subject that emits the active agent list after each poll cycle.

Private totalRecords

totalRecords: number

Private Readonly urlUtilsService

urlUtilsService: UrlUtilsService = ...

Private Readonly utilService

utilService: HttpUtilService = ...

Methods

Private applySearchFilter

applySearchFilter(agents: SkillAgentAssignment[], searchString: string): SkillAgentAssignment[]

- Defined in agent-sdk/src/lib/directory/provider/cxone-skill-agents-provider.ts:362
Filters an assignment list by agent name search string (case-insensitive). Returns the full list unchanged when searchString is empty.

Parameters
- agents: SkillAgentAssignment[]
- searchString: string
Returns SkillAgentAssignment[]

Private buildRequestParams

buildRequestParams(skillId: number): { id: string; request: HttpRequestInit; url: string }[]

- Defined in agent-sdk/src/lib/directory/provider/cxone-skill-agents-provider.ts:264
Builds the requestParams array expected by the util-worker directory-polling handler. Constructs the skill-agents API URL with all required query params and the auth header.
example
```
this.buildRequestParams(skillId)
```
Parameters
- skillId: number
  
  Skill identifier for the query
Returns { id: string; request: HttpRequestInit; url: string }[]
Array of one request descriptor, or null on failure

Private clearIdb

clearIdb(): Promise<void>

- Defined in agent-sdk/src/lib/directory/provider/cxone-skill-agents-provider.ts:404
Removes the IDB cache entry. Called on stopPolling so the next drill-down starts fresh rather than showing a stale list from a previous skill.

Returns Promise<void>

Private handleSkillAgentsApiResp

handleSkillAgentsApiResp(skillAgentsData: Map<string, { status: string; value: unknown }>): Promise<void>

- Defined in agent-sdk/src/lib/directory/provider/cxone-skill-agents-provider.ts:288
Handles the worker response: fetches the full active list, merges with any existing IDB cache (so polling updates state in-place), writes the full list back to IDB

Parameters
- skillAgentsData: Map<string, { status: string; value: unknown }>
  
  The Map<id, {status, value}> posted by the worker
Returns Promise<void>

initWorker

initWorker(): void

- Defined in agent-sdk/src/lib/directory/provider/cxone-skill-agents-provider.ts:212
Creates a new util-worker web worker and wires its onmessage / onerror handlers. Does not send any messages — call sendWorkerRequest after this to trigger the first fetch.
example
```
this.initWorker()
```
Returns void

loadMore

loadMore(): Promise<void>

- Defined in agent-sdk/src/lib/directory/provider/cxone-skill-agents-provider.ts:128
Expand the visible page by DEFAULT_PAGE_SIZE, reading the next slice from IDB.
example
```
startPolling(skillId);  // shows first 25
loadMore();             // shows first 50
```
Returns Promise<void>

Private mergeWithExistingIdb

mergeWithExistingIdb(updatedAgentListFromApi: SkillAgentAssignment[]): Promise<SkillAgentAssignment[]>

- Defined in agent-sdk/src/lib/directory/provider/cxone-skill-agents-provider.ts:336
Merges fresh API assignments into the existing IDB list so polling updates agent state

Parameters
- updatedAgentListFromApi: SkillAgentAssignment[]
Returns Promise<SkillAgentAssignment[]>
Merged list: all existing agents retained, changed agents updated in-place, new agents appended

Private readFromIdb

readFromIdb(): Promise<SkillAgentAssignment[]>

- Defined in agent-sdk/src/lib/directory/provider/cxone-skill-agents-provider.ts:378
Reads the full skill-agent list from IDB.

Returns Promise<SkillAgentAssignment[]>
The stored list, or null if nothing is cached yet.

restartWorker

restartWorker(): void

- Defined in agent-sdk/src/lib/directory/provider/cxone-skill-agents-provider.ts:230
Restarts the worker when a new auth token is received from the refresh-token flow.
example
```
this.restartWorker()
```
Returns void

searchAgents

searchAgents(searchString: string): Promise<void>

- Defined in agent-sdk/src/lib/directory/provider/cxone-skill-agents-provider.ts:103
Filter the IDB-cached full list by search string and emit the first page.
example
```
searchAgents('ab')
```
Parameters
- searchString: string
  
  Agent name filter string (e.g. 'ab')
Returns Promise<void>

Private sendWorkerRequest

sendWorkerRequest(skillId: number): void

- Defined in agent-sdk/src/lib/directory/provider/cxone-skill-agents-provider.ts:193
Sends a single (non-repeating) directory-polling message to the live worker. Always re-builds the request params from scratch so updatedSince is fixed at epoch.
example
```
this.sendWorkerRequest(skillId)
```
Parameters
- skillId: number
  
  Skill identifier to fetch agents for
Returns void

startPolling

startPolling(skillId: number, pollingInterval?: number): void

- Defined in agent-sdk/src/lib/directory/provider/cxone-skill-agents-provider.ts:86
Start polling for agents assigned to the given skill. Any currently running poll (and its worker) is stopped first. Page size starts at DEFAULT_PAGE_SIZE and only grows when loadMore() is called.
example
```
startPolling(skillId, 5000)
```
Parameters
- skillId: number
  
  The skill identifier to poll agents for
- pollingInterval: number = 5000
  
  Milliseconds between polls (default 5000)
Returns void

Private startWorkerPolling

startWorkerPolling(skillId: number, pollingInterval: number): void

- Defined in agent-sdk/src/lib/directory/provider/cxone-skill-agents-provider.ts:172
Initialises the worker, fires an immediate request, then schedules a repeating poll.
example
```
this.startWorkerPolling(skillId, 5000)
```
Parameters
- skillId: number
  
  Skill identifier to poll
- pollingInterval: number
  
  Poll interval in milliseconds
Returns void

stopPolling

stopPolling(): void

- Defined in agent-sdk/src/lib/directory/provider/cxone-skill-agents-provider.ts:153
Stop the current polling worker, reset all state, and clear the IDB cache so the next drill-down starts fresh
example
```
stopPolling()
```
Returns void

Private syncSkillAgentsWithIdbAgentData

syncSkillAgentsWithIdbAgentData(assignments: SkillAgentAssignment[]): Promise<SkillAgentAssignment[]>

- Defined in agent-sdk/src/lib/directory/provider/cxone-skill-agents-provider.ts:420
Reads the IDB agent list, attaches the full AgentStateResponse record as idbAgentData on each matching assignment, and re-orders assignments to match the IDB sort order (state-based, then alphabetical). Assignments not found in IDB retain their relative order at the end.

Parameters
- assignments: SkillAgentAssignment[]
  
  Active skill-agent assignments from the API
Returns Promise<SkillAgentAssignment[]>
Assignments enriched with idbAgentData and IDB-ordered

Private terminateWorker

terminateWorker(): void

- Defined in agent-sdk/src/lib/directory/provider/cxone-skill-agents-provider.ts:245
Clears the main-thread polling timer and terminates the web worker, resetting both references. Safe to call when no polling is active.
example
```
this.terminateWorker()
```
Returns void

Private writeToIdb

writeToIdb(agents: SkillAgentAssignment[]): Promise<void>

- Defined in agent-sdk/src/lib/directory/provider/cxone-skill-agents-provider.ts:391
Persists the full skill-agent list to IDB.

Parameters
- agents: SkillAgentAssignment[]
Returns Promise<void>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns CXoneSkillAgentsProvider

Properties

Private Readonly acdSession

Private Readonly apiParser

Private currentPageSize

Private currentPollingInterval

Private currentSearchString

Private currentSkillId

Private currentUpdatedSince

Private Readonly logger

Private pollingTimer

pollingWorker

skillAgentsEvent

Private totalRecords

Private Readonly urlUtilsService

Private Readonly utilService

Methods

Private applySearchFilter

Parameters

agents: SkillAgentAssignment[]

searchString: string

Returns SkillAgentAssignment[]

Private buildRequestParams

Parameters

skillId: number

Returns { id: string; request: HttpRequestInit; url: string }[]

Private clearIdb

Returns Promise<void>

Private handleSkillAgentsApiResp

Parameters

skillAgentsData: Map<string, { status: string; value: unknown }>

Returns Promise<void>

initWorker

Returns void

loadMore

Returns Promise<void>

Private mergeWithExistingIdb

Parameters

updatedAgentListFromApi: SkillAgentAssignment[]

Returns Promise<SkillAgentAssignment[]>

Private readFromIdb

Returns Promise<SkillAgentAssignment[]>

restartWorker

Returns void

searchAgents

Parameters

searchString: string

Returns Promise<void>

Private sendWorkerRequest

Parameters

skillId: number

Returns void

startPolling

Parameters

skillId: number

pollingInterval: number = 5000

Returns void

Private startWorkerPolling

Parameters

skillId: number

pollingInterval: number

Returns void

stopPolling

Returns void

Private syncSkillAgentsWithIdbAgentData

Parameters

assignments: SkillAgentAssignment[]

Returns Promise<SkillAgentAssignment[]>

Private terminateWorker

Returns void

Private writeToIdb

Parameters

agents: SkillAgentAssignment[]