@webex/contact-center 3.13.0-next.1 → 3.13.0-next.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.repo-context.json +704 -0
- package/.sdd/manifest.json +1065 -339
- package/AGENTS.md +935 -60
- package/dist/webex.js +1 -1
- package/docs/adr/0001-spec-source-policy.md +97 -0
- package/{ai-docs/features/consult-transfer-list-policy/spec/feature-spec.md → docs/adr/0002-consult-transfer-list-policy.md} +227 -244
- package/docs/adr/0003-repo-standards-migration.md +104 -0
- package/docs/adr/index.md +35 -0
- package/docs/architecture.md +460 -0
- package/docs/getting-started.md +142 -0
- package/docs/index.md +53 -0
- package/docs/specs/README.md +98 -0
- package/package.json +10 -9
- package/schemas/repo-context.schema.json +796 -0
- package/src/docs/README.md +727 -0
- package/src/metrics/docs/README.md +710 -0
- package/src/services/agent/docs/README.md +673 -0
- package/src/services/config/docs/README.md +530 -0
- package/src/services/core/docs/README.md +993 -0
- package/src/services/docs/README.md +765 -0
- package/src/services/task/docs/README.md +1569 -0
- package/src/services/task/state-machine/docs/README.md +1388 -0
- package/src/utils/AGENTS.md +6 -4
- package/src/utils/docs/README.md +413 -0
- package/umd/contact-center.min.js +2 -2
- package/umd/contact-center.min.js.map +1 -1
- package/ai-docs/ARCHITECTURE.md +0 -168
- package/ai-docs/CONTRACTS.md +0 -64
- package/ai-docs/GETTING_STARTED.md +0 -168
- package/ai-docs/GLOSSARY.md +0 -43
- package/ai-docs/README.md +0 -138
- package/ai-docs/REVIEW_CHECKLIST.md +0 -41
- package/ai-docs/RULES.md +0 -444
- package/ai-docs/SECURITY.md +0 -52
- package/ai-docs/SERVICE_STATE.md +0 -52
- package/ai-docs/SPEC_INDEX.md +0 -65
- package/ai-docs/adr/0001-spec-source-policy.md +0 -55
- package/ai-docs/adr/README.md +0 -8
- package/ai-docs/adr/_adr-template.md +0 -31
- package/ai-docs/contact-center-spec.md +0 -388
- package/ai-docs/features/contact-owner-change-refactor.md +0 -78
- package/ai-docs/features/generated-spec-conformance-fidelity-remediation/spec/feature-spec.md +0 -117
- package/ai-docs/features/residual-warning-coverage-completion/spec/feature-spec.md +0 -203
- package/ai-docs/features/validator-code-fidelity-drift-fix/spec/feature-spec.md +0 -315
- package/ai-docs/patterns/event-driven-patterns.md +0 -485
- package/ai-docs/patterns/testing-patterns.md +0 -480
- package/ai-docs/patterns/typescript-patterns.md +0 -365
- package/ai-docs/templates/README.md +0 -102
- package/ai-docs/templates/documentation/create-agents-md.md +0 -240
- package/ai-docs/templates/documentation/create-architecture-md.md +0 -295
- package/ai-docs/templates/existing-service/bug-fix.md +0 -254
- package/ai-docs/templates/existing-service/feature-enhancement.md +0 -450
- package/ai-docs/templates/new-method/00-master.md +0 -80
- package/ai-docs/templates/new-method/01-requirements.md +0 -232
- package/ai-docs/templates/new-method/02-implementation.md +0 -295
- package/ai-docs/templates/new-method/03-tests.md +0 -201
- package/ai-docs/templates/new-method/04-validation.md +0 -141
- package/ai-docs/templates/new-service/00-master.md +0 -109
- package/ai-docs/templates/new-service/01-pre-questions.md +0 -159
- package/ai-docs/templates/new-service/02-code-generation.md +0 -346
- package/ai-docs/templates/new-service/03-integration.md +0 -178
- package/ai-docs/templates/new-service/04-test-generation.md +0 -205
- package/ai-docs/templates/new-service/05-validation.md +0 -145
- package/src/metrics/ai-docs/AGENTS.md +0 -350
- package/src/metrics/ai-docs/ARCHITECTURE.md +0 -338
- package/src/metrics/ai-docs/metrics-spec.md +0 -971
- package/src/services/agent/ai-docs/AGENTS.md +0 -240
- package/src/services/agent/ai-docs/ARCHITECTURE.md +0 -304
- package/src/services/agent/ai-docs/agent-spec.md +0 -505
- package/src/services/ai-docs/AGENTS.md +0 -386
- package/src/services/ai-docs/services-spec.md +0 -512
- package/src/services/config/ai-docs/AGENTS.md +0 -250
- package/src/services/config/ai-docs/ARCHITECTURE.md +0 -413
- package/src/services/config/ai-docs/config-spec.md +0 -669
- package/src/services/core/ai-docs/AGENTS.md +0 -381
- package/src/services/core/ai-docs/ARCHITECTURE.md +0 -698
- package/src/services/core/ai-docs/core-spec.md +0 -797
- package/src/services/task/ai-docs/AGENTS.md +0 -457
- package/src/services/task/ai-docs/ARCHITECTURE.md +0 -595
- package/src/services/task/ai-docs/task-spec.md +0 -1501
- package/src/services/task/state-machine/ai-docs/AGENTS.md +0 -460
- package/src/services/task/state-machine/ai-docs/ARCHITECTURE.md +0 -1156
- package/src/services/task/state-machine/ai-docs/task-state-machine-spec.md +0 -2247
- package/src/utils/ai-docs/utils-spec.md +0 -391
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
---
|
|
2
|
+
type: Getting Started
|
|
3
|
+
title: Getting started
|
|
4
|
+
description: Local setup, build, run, and test routing for @webex/contact-center.
|
|
5
|
+
tags: [onboarding]
|
|
6
|
+
---
|
|
7
|
+
<!-- sdd-generated-metadata
|
|
8
|
+
doc_kind: standing-doc
|
|
9
|
+
generated_from: getting-started@0.3.0
|
|
10
|
+
generated_by: claude-code
|
|
11
|
+
approved_by: rarajes2@cisco.com
|
|
12
|
+
updated_at: 2026-11-17T03:03:58Z
|
|
13
|
+
validation_status: pass-with-warnings
|
|
14
|
+
-->
|
|
15
|
+
|
|
16
|
+
# Getting started
|
|
17
|
+
|
|
18
|
+
Onboarding for **@webex/contact-center**, a package inside the `webex-js-sdk` Yarn workspace. Run every
|
|
19
|
+
command from the workspace root. The package scripts run through `yarn workspace @webex/contact-center`
|
|
20
|
+
followed by the script name; `package.json` in `packages/@webex/contact-center` defines them.
|
|
21
|
+
|
|
22
|
+
## Prerequisites
|
|
23
|
+
|
|
24
|
+
| Tool or access | Version or requirement |
|
|
25
|
+
| -------------- | ---------------------- |
|
|
26
|
+
| Node.js | 22.14 (workspace root `AGENTS.md`; the workspace `.nvmrc` selects `lts/jod`); `engines.node` in `package.json` is `>=20.x` |
|
|
27
|
+
| Yarn | 3.4.1 (`packageManager` in the workspace root `package.json`) |
|
|
28
|
+
| Webex access | N/A for building, unit tests, and linting. Running against Contact Center needs a Webex access token for a Contact Center agent |
|
|
29
|
+
|
|
30
|
+
## Install
|
|
31
|
+
|
|
32
|
+
Clone the workspace repository (https://github.com/webex/webex-js-sdk.git), change into its root
|
|
33
|
+
folder, and install the workspace:
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
yarn
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
The workspace `deploy.yml` and `pull-request.yml` workflows install with the same command.
|
|
40
|
+
|
|
41
|
+
## Build
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
yarn workspace @webex/contact-center build:src
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
`build:src` compiles `src/` (JavaScript and TypeScript) to `dist/` with source maps through
|
|
48
|
+
`webex-legacy-tools`, then runs the `build` script. `yarn workspace @webex/contact-center build` runs `build:src` for
|
|
49
|
+
`@webex/calling` and then `tsc` with declarations, writing `dist/types`, which the `types` entry
|
|
50
|
+
points at.
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
yarn workspace @webex/contact-center build
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
To build this package and its workspace dependencies in order:
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
yarn workspace @webex/contact-center compile
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## Run
|
|
63
|
+
|
|
64
|
+
| Task | Command |
|
|
65
|
+
|---|---|
|
|
66
|
+
| Run locally | Consume through a Webex SDK host/application; this package has no standalone server. |
|
|
67
|
+
|
|
68
|
+
The workspace webpack build bundles `src/webex.js` into `umd/contact-center.min.js`, which the
|
|
69
|
+
Contact Center sample app in the workspace `docs/samples/contact-center` folder loads. The API
|
|
70
|
+
reference is generated by typedoc into the workspace `docs/wxcc` folder:
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
yarn workspace @webex/contact-center build:docs
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
## Tests
|
|
77
|
+
|
|
78
|
+
```bash
|
|
79
|
+
yarn workspace @webex/contact-center test:unit
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
```bash
|
|
83
|
+
yarn workspace @webex/contact-center test:style
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
`yarn workspace @webex/contact-center test` runs `test:style` and then `test:unit`:
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
yarn workspace @webex/contact-center test
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
To run one spec file, pass `--targets` with a path relative to `test/unit/spec`, as the workspace root
|
|
93
|
+
`AGENTS.md` describes (for example the path `cc.ts` for `test/unit/spec/cc.ts`). The unit specs import
|
|
94
|
+
`src/` directly; the sibling workspace packages they load resolve to those packages' `dist/`, so build
|
|
95
|
+
the workspace before trusting a result.
|
|
96
|
+
|
|
97
|
+
| Tier | Command | Test location | Framework | External dependencies |
|
|
98
|
+
| ------------ | -------------------- | ------------- | ----------- | ----------------------------------- |
|
|
99
|
+
| Unit | `yarn workspace @webex/contact-center test:unit` | `test/unit/spec` | jest (`webex-legacy-tools test --unit --runner jest`), jsdom | None |
|
|
100
|
+
| System / E2E | `yarn workspace @webex/contact-center test:e2e` | Workspace `cc_playwright` folder | Playwright, workspace `playwright.config.ts` | The sample app on `https://localhost:8000` and Contact Center test credentials in `cc_playwright/.env` |
|
|
101
|
+
|
|
102
|
+
- Coverage or quality gate: 85% global lines, functions, branches, and statements, set by
|
|
103
|
+
`coverageThreshold` in `jest.config.js` with `collectCoverage: true`
|
|
104
|
+
- Enforcement source: `yarn workspace @webex/contact-center test:unit` exits nonzero below the threshold; the pull-request workflow
|
|
105
|
+
runs `test:style` and `test:unit` for changed packages and their dependents
|
|
106
|
+
- Test environment or QA dependencies: none for unit tests; the E2E tier is run from the workspace
|
|
107
|
+
`e2e.yml` workflow
|
|
108
|
+
|
|
109
|
+
Fix commands for lint and formatting findings:
|
|
110
|
+
|
|
111
|
+
```bash
|
|
112
|
+
yarn workspace @webex/contact-center fix:lint
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
```bash
|
|
116
|
+
yarn workspace @webex/contact-center fix:prettier
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
## Configuration and secrets
|
|
120
|
+
|
|
121
|
+
- Runtime credentials and service routing come from the host Webex SDK and its environment configuration. Never hardcode or log tokens.
|
|
122
|
+
- Required configuration: none to build or test. At runtime the host passes `config.cc`; the defaults
|
|
123
|
+
are in `src/config.ts` (`allowMultiLogin`, `allowAutomatedRelogin`, `disableWebRTCRegistration`,
|
|
124
|
+
`enableWxBetterTogether`, `clientType`, `isKeepAliveEnabled`, `force`, `metrics`)
|
|
125
|
+
- The package builds inside the Yarn workspace and consumes sibling `@webex/*` packages through workspace dependencies.
|
|
126
|
+
- Package or artifact access: publishing uses `yarn workspace @webex/contact-center deploy:npm` from the workspace release workflow
|
|
127
|
+
- Platform, simulator, device, or SDK setup: none; browser calling needs a browser with WebRTC
|
|
128
|
+
- Never commit credentials or copy production secrets into a local config.
|
|
129
|
+
|
|
130
|
+
## First-run verification
|
|
131
|
+
|
|
132
|
+
1. Run `yarn workspace @webex/contact-center build:src`.
|
|
133
|
+
2. Run `yarn workspace @webex/contact-center test:unit` and confirm Jest enforces the package's 85% global thresholds from `jest.config.js`.
|
|
134
|
+
3. Run `yarn workspace @webex/contact-center test:style`.
|
|
135
|
+
|
|
136
|
+
Expected result: all three commands exit zero and Jest prints no coverage threshold message.
|
|
137
|
+
|
|
138
|
+
## Next steps
|
|
139
|
+
|
|
140
|
+
- Agent entry: [`AGENTS.md`](../AGENTS.md) · System shape: [package architecture](architecture.md) · Routing: [specification registry](specs/README.md)
|
|
141
|
+
- Conventions: the coding patterns and rules in [`AGENTS.md`](../AGENTS.md), and the manifest-routed module specification for the target capability.
|
|
142
|
+
- [Documentation index](index.md)
|
package/docs/index.md
ADDED
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
---
|
|
2
|
+
okf_version: '0.1'
|
|
3
|
+
---
|
|
4
|
+
<!-- sdd-generated-metadata
|
|
5
|
+
doc_kind: standing-doc
|
|
6
|
+
generated_from: docs-index@0.3.0
|
|
7
|
+
generated_by: claude-code
|
|
8
|
+
approved_by: rarajes2@cisco.com
|
|
9
|
+
updated_at: 2026-11-17T03:03:58Z
|
|
10
|
+
validation_status: pass-with-warnings
|
|
11
|
+
-->
|
|
12
|
+
|
|
13
|
+
# @webex/contact-center documentation
|
|
14
|
+
|
|
15
|
+
Doc map for developers and agents working on the Contact Center SDK plugin (`webex.cc`). The package
|
|
16
|
+
overview, technologies, and runtime composition are in the [package architecture](architecture.md).
|
|
17
|
+
|
|
18
|
+
## Start here
|
|
19
|
+
|
|
20
|
+
- [Getting started](getting-started.md)
|
|
21
|
+
- [Package architecture](architecture.md)
|
|
22
|
+
|
|
23
|
+
Start with the package [`AGENTS.md`](../AGENTS.md) for critical repository rules and the developer workflow, then use the [specification registry](specs/README.md) to classify the task by owning module and open its module specification.
|
|
24
|
+
|
|
25
|
+
This package is a library, so there is no service specification and no OpenAPI document.
|
|
26
|
+
|
|
27
|
+
## Decisions
|
|
28
|
+
|
|
29
|
+
- [adr/](adr/index.md) — architectural decision records
|
|
30
|
+
|
|
31
|
+
## Specifications and contracts
|
|
32
|
+
|
|
33
|
+
- [architecture.md](architecture.md) — canonical package architecture and the contract index
|
|
34
|
+
- [specs/README.md](specs/README.md) — manifest-backed module and contract registry
|
|
35
|
+
- `docs/README.md` inside each module directory — each manifest-routed module has one canonical
|
|
36
|
+
module specification beside its code, listed in the [Module registry](specs/README.md#module-registry);
|
|
37
|
+
the retained module-level `src/utils/AGENTS.md` guide is a reference-only migration source, as recorded in
|
|
38
|
+
[ADR-0003](adr/0003-repo-standards-migration.md)
|
|
39
|
+
- [adr/](adr/index.md) — concrete architectural decisions; blank ADR templates remain under the
|
|
40
|
+
monorepo root `.sdd/`
|
|
41
|
+
|
|
42
|
+
Exact contract details live in the native sources linked from the architecture contract index:
|
|
43
|
+
`package.json` for the published entry points, `src/index.ts` for the exports, and the TypeScript type
|
|
44
|
+
files named there for the events and payloads. To change behavior, follow the Working Method in
|
|
45
|
+
[`AGENTS.md`](../AGENTS.md); update the package `AGENTS.md` when task routing or critical rules change, and do not update the retained `src/utils/AGENTS.md` as an independent source of truth.
|
|
46
|
+
|
|
47
|
+
## Related repository resources
|
|
48
|
+
|
|
49
|
+
- [`README.md`](../README.md) — npm package page
|
|
50
|
+
- [`typedoc.md`](../typedoc.md) — landing page of the generated API reference (`yarn workspace @webex/contact-center build:docs`)
|
|
51
|
+
- [`src/utils/AGENTS.md`](../src/utils/AGENTS.md) — retained Utils guide; reference-only
|
|
52
|
+
- The Contact Center sample app is in the workspace `docs/samples/contact-center` folder; the
|
|
53
|
+
end-to-end suite in the workspace `cc_playwright` folder drives it.
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
---
|
|
2
|
+
type: Reference
|
|
3
|
+
title: Specification registry
|
|
4
|
+
description: Canonical specification registry and change-routing guide.
|
|
5
|
+
tags: [specifications, registry]
|
|
6
|
+
---
|
|
7
|
+
<!-- sdd-generated-metadata
|
|
8
|
+
doc_kind: standing-doc
|
|
9
|
+
generated_from: spec-index@0.3.0
|
|
10
|
+
generated_by: claude-code
|
|
11
|
+
approved_by: rarajes2@cisco.com
|
|
12
|
+
updated_at: 2026-11-17T03:03:58Z
|
|
13
|
+
validation_status: pass-with-warnings
|
|
14
|
+
-->
|
|
15
|
+
|
|
16
|
+
# Specification registry
|
|
17
|
+
|
|
18
|
+
Use this page to find the canonical package architecture and every instantiated module specification
|
|
19
|
+
plus native contract for `@webex/contact-center`. Keep technical facts in one owning document and use
|
|
20
|
+
this page only for navigation, ownership, status, and change/test routing. This registry mirrors
|
|
21
|
+
`.sdd/manifest.json`, which stays authoritative.
|
|
22
|
+
|
|
23
|
+
Start with the [package architecture](../architecture.md). No service specification exists because
|
|
24
|
+
this package is a library: `package.json` has no start script or deployment descriptor
|
|
25
|
+
(`layout.artifact_decisions` in `.sdd/manifest.json`).
|
|
26
|
+
|
|
27
|
+
## Document roles
|
|
28
|
+
|
|
29
|
+
| Document | Canonical ownership |
|
|
30
|
+
| -------- | ------------------- |
|
|
31
|
+
| [Package architecture](../architecture.md) | Package boundaries, resource inventory, interactions, dependency topology, cross-cutting architecture, the contract index, domain language, and the security architecture |
|
|
32
|
+
| [Getting started](../getting-started.md) | Prerequisites, install, build, and the test router with the manifest commands |
|
|
33
|
+
| Module specifications | Stable behavior and design at each manifest-routed `docs/README.md` beside the module code |
|
|
34
|
+
| [ADR](../adr/index.md) | A durable decision, its deciders, rationale, consequences, and supersession lineage |
|
|
35
|
+
| [Package agent instructions](../../AGENTS.md) | Agent rules, the development workflow, coding patterns, and the review checklist |
|
|
36
|
+
|
|
37
|
+
## Instantiated specification registry
|
|
38
|
+
|
|
39
|
+
| Resource | Role | Canonical path | Owner | Status | Last verified |
|
|
40
|
+
| -------- | ---- | -------------- | ----- | ------ | ------------- |
|
|
41
|
+
| Package | Architecture | `docs/architecture.md` | @webex/web-sdk | Active | 2026-11-16 |
|
|
42
|
+
| Contact Center public plugin | Module | `src/docs/README.md` | @webex/web-sdk | Active | 2026-11-16 |
|
|
43
|
+
| Metrics | Module | `src/metrics/docs/README.md` | @webex/web-sdk | Active | 2026-11-16 |
|
|
44
|
+
| Services composition | Module | `src/services/docs/README.md` | @webex/web-sdk | Active | 2026-11-16 |
|
|
45
|
+
| Agent | Module | `src/services/agent/docs/README.md` | @webex/web-sdk | Active | 2026-11-16 |
|
|
46
|
+
| Config | Module | `src/services/config/docs/README.md` | @webex/web-sdk | Active | 2026-11-16 |
|
|
47
|
+
| Core | Module | `src/services/core/docs/README.md` | @webex/web-sdk | Active | 2026-11-16 |
|
|
48
|
+
| Task | Module | `src/services/task/docs/README.md` | @webex/web-sdk | Active | 2026-11-16 |
|
|
49
|
+
| Task state machine | Module | `src/services/task/state-machine/docs/README.md` | @webex/web-sdk | Active | 2026-11-16 |
|
|
50
|
+
| Utils | Module | `src/utils/docs/README.md` | @webex/web-sdk | Active | 2026-11-16 |
|
|
51
|
+
| Spec source policy | ADR | `docs/adr/0001-spec-source-policy.md` | @webex/web-sdk | Superseded | 2026-11-16 |
|
|
52
|
+
| Consult and transfer list policy | ADR | `docs/adr/0002-consult-transfer-list-policy.md` | @webex/web-sdk | Accepted | 2026-11-16 |
|
|
53
|
+
| Repo-standards migration | ADR | `docs/adr/0003-repo-standards-migration.md` | @webex/web-sdk | Accepted | 2026-11-16 |
|
|
54
|
+
|
|
55
|
+
### Module registry
|
|
56
|
+
|
|
57
|
+
| Module | Responsibility | Manifest coverage state | Start here |
|
|
58
|
+
| --- | --- | --- | --- |
|
|
59
|
+
| `src/` | Own the published Webex Contact Center SDK plugin surface, registration lifecycle, public method delegation, and application-facing event routing. | Partial | `src/docs/README.md` |
|
|
60
|
+
| ↳ `src/metrics/` | Own timing, taxonomy, queuing, payload preparation, and submission for Contact Center behavioral, operational, and business telemetry. | Partial | `src/metrics/docs/README.md` |
|
|
61
|
+
| ↳ `src/services/` | Own composition and bootstrap order for backend request and realtime collaborators (the Services singleton), plus the direct REST data, user preference, AI assistant, and WebRTC service classes that ContactCenter constructs. | Partial | `src/services/docs/README.md` |
|
|
62
|
+
| ↳ ↳ `src/services/agent/` | Own agent login, logout, state-change, buddy-agent, and reload request contracts; ContactCenter uses reload for silent relogin and stationLogin for device updates. | Partial | `src/services/agent/docs/README.md` |
|
|
63
|
+
| ↳ ↳ `src/services/config/` | Own retrieval and aggregation of remote organization, agent, team, profile, auxiliary-code, dial-plan, and feature configuration. | Partial | `src/services/config/docs/README.md` |
|
|
64
|
+
| ↳ ↳ `src/services/core/` | Own authenticated HTTP, realtime WebSocket lifecycle, AQM request correlation, reconnect/keepalive behavior, and shared error normalization. | Partial | `src/services/core/docs/README.md` |
|
|
65
|
+
| ↳ ↳ `src/services/task/` | Own task creation, media-specific behavior, call-control operations, lifecycle orchestration, task events, and integration with the task state machine. | Partial | `src/services/task/docs/README.md` |
|
|
66
|
+
| ↳ ↳ ↳ `src/services/task/state-machine/` | Own deterministic task lifecycle states, transition guards/actions, typed internal events, and state-derived UI-control availability. | Partial | `src/services/task/state-machine/docs/README.md` |
|
|
67
|
+
| ↳ `src/utils/` | Own shared pagination contracts and the bounded in-memory page cache used by Contact Center data services. | Partial | `src/utils/docs/README.md` |
|
|
68
|
+
|
|
69
|
+
All nine modules remain `Partial` in `.sdd/manifest.json`; coverage review is pending. Independent
|
|
70
|
+
validation on 2026-11-17 passed with warnings (0 Blocking, 0 Important, 4 Minor). No coverage promotion was performed.
|
|
71
|
+
|
|
72
|
+
Three documentation-only correction records from July 2026 (a validator drift fix, a residual-warning
|
|
73
|
+
completion, and a conformance and fidelity remediation) are folded into the nine module specifications.
|
|
74
|
+
|
|
75
|
+
## Change and verification routing
|
|
76
|
+
|
|
77
|
+
| Change affects | Load and update | Verification route |
|
|
78
|
+
| -------------- | --------------- | ------------------ |
|
|
79
|
+
| Package boundaries or cross-cutting architecture | `docs/architecture.md` and applicable ADRs | `yarn workspace @webex/contact-center build:src`, `yarn workspace @webex/contact-center test:unit`, and `yarn workspace @webex/contact-center test:style`, plus the affected module specs |
|
|
80
|
+
| A stable code, package, or component boundary | Its module spec from the Module registry | Module tests under `test/unit/spec`, plus affected contracts |
|
|
81
|
+
| A public API, event, or exported type | The owning module spec, the contract index in `docs/architecture.md`, `src/index.ts`, and `.sdd/manifest.json` `contract_catalog` | `yarn workspace @webex/contact-center build` for declarations, then `yarn workspace @webex/contact-center test:unit`; `test/unit/spec/index.ts` covers the root exports |
|
|
82
|
+
| Consult and transfer destination lists or controls | ADR-0002, the Contact Center, Services, Utils, Task, and Task state machine specs | `test/unit/spec/cc.ts`, `test/unit/spec/services/Queue.ts`, `test/unit/spec/services/EntryPoint.ts`, `test/unit/spec/services/AddressBook.ts`, `test/unit/spec/services/task/state-machine/uiControlsComputer.ts` |
|
|
83
|
+
| Task state or lifecycle transitions | The Task and Task state machine module specs | `test/unit/spec/services/task/state-machine/TaskStateMachine.ts`, `test/unit/spec/services/task/TaskManager.ts` |
|
|
84
|
+
| Transport, reconnect, or recovery | The Core module spec and the security architecture in `docs/architecture.md` | `test/unit/spec/services/core/aqm-reqs.ts`, `test/unit/spec/services/core/websocket/connection-service.ts`, `test/unit/spec/cc.ts` |
|
|
85
|
+
| A new feature or defect | The affected module specs, then the Working Method in `AGENTS.md` | The verification route of each affected row above |
|
|
86
|
+
|
|
87
|
+
## Module and contract registration
|
|
88
|
+
|
|
89
|
+
Each module specification is generated at the exact `modules[].canonical_spec` path recorded in
|
|
90
|
+
`.sdd/manifest.json`. Register every module and submodule in the Module registry above in manifest
|
|
91
|
+
tree order; a new module needs a manifest entry, its module spec, and its contracts.
|
|
92
|
+
|
|
93
|
+
Contracts are registered in `.sdd/manifest.json` `contract_catalog` with a stable ID, publication
|
|
94
|
+
state, native source, and owning module, and indexed in the
|
|
95
|
+
[package architecture](../architecture.md#public-and-consumer-surfaces). The published surface is the
|
|
96
|
+
npm package (`contact-center-sdk`, native source `package.json`) and its event enums; the Contact
|
|
97
|
+
Center REST and WebSocket contracts are external and consumed, so the package has no OpenAPI document.
|
|
98
|
+
This page provides navigation and ownership rather than a copied contract.
|
package/package.json
CHANGED
|
@@ -42,17 +42,18 @@
|
|
|
42
42
|
"test": "yarn test:style && yarn test:unit",
|
|
43
43
|
"test:style": "eslint 'src/**/*.ts'",
|
|
44
44
|
"test:unit": "webex-legacy-tools test --unit --runner jest",
|
|
45
|
+
"test:e2e": "yarn run -T playwright test --config=../../../playwright.config.ts",
|
|
45
46
|
"deploy:npm": "yarn npm publish"
|
|
46
47
|
},
|
|
47
48
|
"dependencies": {
|
|
48
49
|
"@types/platform": "1.3.4",
|
|
49
|
-
"@webex/calling": "3.
|
|
50
|
-
"@webex/internal-plugin-mercury": "3.
|
|
51
|
-
"@webex/internal-plugin-metrics": "3.
|
|
52
|
-
"@webex/internal-plugin-support": "3.13.0-next.
|
|
53
|
-
"@webex/plugin-authorization": "3.
|
|
54
|
-
"@webex/plugin-logger": "3.
|
|
55
|
-
"@webex/webex-core": "3.
|
|
50
|
+
"@webex/calling": "3.13.0-next.7",
|
|
51
|
+
"@webex/internal-plugin-mercury": "3.13.0-next.5",
|
|
52
|
+
"@webex/internal-plugin-metrics": "3.13.0-next.5",
|
|
53
|
+
"@webex/internal-plugin-support": "3.13.0-next.9",
|
|
54
|
+
"@webex/plugin-authorization": "3.13.0-next.5",
|
|
55
|
+
"@webex/plugin-logger": "3.13.0-next.5",
|
|
56
|
+
"@webex/webex-core": "3.13.0-next.5",
|
|
56
57
|
"jest-html-reporters": "3.0.11",
|
|
57
58
|
"lodash": "^4.17.21",
|
|
58
59
|
"uuid": "^3.3.2",
|
|
@@ -68,7 +69,7 @@
|
|
|
68
69
|
"@webex/eslint-config-legacy": "0.0.0",
|
|
69
70
|
"@webex/jest-config-legacy": "0.0.0",
|
|
70
71
|
"@webex/legacy-tools": "0.0.0",
|
|
71
|
-
"@webex/test-helper-mock-webex": "3.
|
|
72
|
+
"@webex/test-helper-mock-webex": "3.13.0-next.1",
|
|
72
73
|
"@xstate/inspect": "^0.8.0",
|
|
73
74
|
"eslint": "^8.24.0",
|
|
74
75
|
"eslint-config-airbnb-base": "15.0.0",
|
|
@@ -84,5 +85,5 @@
|
|
|
84
85
|
"typedoc": "^0.25.0",
|
|
85
86
|
"typescript": "5.4.5"
|
|
86
87
|
},
|
|
87
|
-
"version": "3.13.0-next.
|
|
88
|
+
"version": "3.13.0-next.11"
|
|
88
89
|
}
|