docs(contact-center): add SDD templates for new method creation by ciscoRankush · Pull Request #4735 · webex/webex-js-sdk

ciscoRankush · 2026-02-23T08:54:28Z

COMPLETES #SPARK-775697

This pull request addresses

AI agents need structured templates to guide new method addition in the @webex/contact-center SDK, ensuring they gather complete requirements including API contracts, event contracts, and metrics before implementation.

by making the following changes

Adds ai-docs/templates/new-method/ with 5 template files:

00-master.md — Orchestrator with workflow overview and pattern links
01-requirements.md — STOP gate with 12 interrogative questions covering method identity, signature, API integration, event contract, metrics, and behavior details. Includes completion gate, spec summary template, and getBuddyAgents example
02-implementation.md — Method implementation patterns
03-tests.md — Unit test generation patterns
04-validation.md — Quality checklist with correct workspace commands (test:styles, test:unit, build:src)

Change Type

Documentation update

The following scenarios were tested

Simulated "Add getBuddyAgents method" prompt — verified STOP gate, all 12 questions interrogative, event contract table present, completion gate, and spec summary with example
Link validation — all relative paths verified correct (pattern links use ../../patterns/)
Workspace commands verified against actual package.json scripts

The GAI Coding Policy And Copyright Annotation Best Practices

GAI was used to create a draft that was subsequently customized or modified
Tool used for AI assistance (GitHub Copilot / Other - specify)
- Other - Claude Code (Claude Opus 4.6)
This PR is related to
- Tech Debt

I certified that

I have read and followed contributing guidelines
I discussed changes with code owners prior to submitting this pull request
I have not skipped any automated checks
All existing and new tests passed
I have updated the documentation accordingly

Add Spec-Driven Development templates for adding new methods: - 00-master.md — Orchestrator with workflow overview - 01-requirements.md — STOP gate with 12 interrogative questions, event contract table, metrics section, spec summary with example - 02-implementation.md — Method implementation patterns - 03-tests.md — Unit test generation patterns - 04-validation.md — Quality checklist with correct workspace commands Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Shreyas281299 · 2026-02-24T06:25:20Z

packages/@webex/contact-center/ai-docs/templates/new-method/00-master.md

@@ -0,0 +1,80 @@
+# New Method - Master Template
+
+> **Purpose**: Orchestrator for adding new methods to existing services.


Suggested change

> **Purpose**: Orchestrator for adding new methods to existing services.

> **Purpose**: Orchestrator for adding new methods to existing services and utils.

Shreyas281299 · 2026-02-24T06:25:50Z

packages/@webex/contact-center/ai-docs/templates/new-method/00-master.md

+## Workflow Overview
+
+```
+Step 1: Requirements → Step 2: Implementation → Step 3: Tests → Step 4: Validation


Lets make this a flowchart

Shreyas281299 · 2026-02-24T06:27:50Z

packages/@webex/contact-center/ai-docs/templates/new-method/01-requirements.md

+   | Endpoint | "What is the full endpoint path?" |
+   | Request Payload | "What fields does the request body contain? Which are required vs optional?" |
+   | Response Structure | "What does the response look like?" |
+   | Error Shape | "What error reason codes can this return?" |


Where is the response received? WS or in response of the request?

Shreyas281299 · 2026-02-24T06:29:57Z

packages/@webex/contact-center/ai-docs/templates/new-method/02-implementation.md

+
+---
+
+## Method Template (for cc.ts)


We should remove 'for cc.ts' part from the heading. The same tmeplate can be used anywhere in the sdk

Shreyas281299 · 2026-02-24T06:30:43Z

packages/@webex/contact-center/ai-docs/templates/new-method/02-implementation.md

+    );
+
+    // 11. Throw augmented error
+    throw detailedError;


In this template can we emit an event so that there is an example of emitting events. A success and failure event

Shreyas281299 · 2026-02-24T06:32:09Z

packages/@webex/contact-center/ai-docs/templates/new-method/03-tests.md

+Add tests to existing test file or create new one:
+- For `cc.ts` methods: `test/unit/spec/cc.ts`
+- For service methods: `test/unit/spec/services/[service]/index.ts`
+


We should also have an entry for files not in service fodler.

Shreyas281299 · 2026-02-24T06:33:31Z

packages/@webex/contact-center/ai-docs/templates/new-method/03-tests.md

+yarn workspace @webex/contact-center test -- --testPathPattern=cc --testNamePattern="methodName"
+
+# Run with coverage
+yarn workspace @webex/contact-center test -- --coverage


Suggested change

yarn workspace @webex/contact-center test -- --testPathPattern=cc --testNamePattern="methodName"

# Run with coverage

yarn workspace @webex/contact-center test -- --coverage

yarn workspace @webex/contact-center test:unit -- <path_to_specific-file>

# Run with coverage

yarn workspace @webex/contact-center test:unit --coverage

Shreyas281299 · 2026-02-24T06:33:52Z

packages/@webex/contact-center/ai-docs/templates/new-method/00-master.md

+1. [`../../patterns/typescript-patterns.md`](../../patterns/typescript-patterns.md)
+2. [`../../patterns/sdk-plugin-patterns.md`](../../patterns/sdk-plugin-patterns.md) - For cc.ts methods
+3. [`../../patterns/testing-patterns.md`](../../patterns/testing-patterns.md)


This needs update now

Kesari3008 · 2026-02-23T18:34:54Z

packages/@webex/contact-center/ai-docs/templates/new-method/00-master.md

+## Use Case
+
+Use this template when:
+- Adding a new method to an existing service


It should be adding a new method or feature

Kesari3008 · 2026-02-23T18:35:30Z

packages/@webex/contact-center/ai-docs/templates/new-method/00-master.md

+
+Use this template when:
+- Adding a new method to an existing service
+- Adding a new public API method to `cc.ts`


Same update here as well adding public method from cc or taks object

Kesari3008 · 2026-02-24T09:46:39Z

packages/@webex/contact-center/ai-docs/templates/new-method/01-requirements.md

+```
+## Spec Summary — New Method
+
+**Method**: `getBuddyAgents(data: BuddyAgents): Promise<BuddyAgentsResponse>`


We should also be talking about where and ho BuddyAgent, BuddyAgnetresponse type are defined and how that data can be figured

Kesari3008 · 2026-02-24T09:54:17Z

packages/@webex/contact-center/ai-docs/templates/new-method/02-implementation.md

+    }
+
+    // 4. Call service method
+    const result = await this.services.someService.method({


For method implementations, there is also this small note we should add that actula method implementation sometime shappen in the service module but we still need to write a method from public object like cc or task and we do internal invocation if service method. And soemtimes we could be directly calling cc.service.method also.

Kesari3008 · 2026-02-24T09:55:39Z

packages/@webex/contact-center/ai-docs/templates/new-method/04-validation.md

+
+## Pattern Verification
+
+### Correct Logging Pattern


Error logging section should be added too under logging pattern and also dofferentiation ebtween when to use warn and when to use error

Kesari3008 · 2026-02-24T09:59:46Z

packages/@webex/contact-center/ai-docs/templates/new-method/03-tests.md

+
+```bash
+# Run specific test
+yarn workspace @webex/contact-center test -- --testPathPattern=cc --testNamePattern="methodName"


These should be test:unit

Kesari3008 · 2026-02-24T10:01:05Z

packages/@webex/contact-center/ai-docs/templates/new-method/03-tests.md

+
+      // Assert
+      expect(mockServicesInstance.someService.method).toHaveBeenCalledWith({
+        data: expect.objectContaining({


We should avoid using objectcontaining. We should highlight that expect statement macthes should be accurate in most cases

ciscoRankush requested a review from a team as a code owner February 23, 2026 08:54

Shreyas281299 added the validated If the pull request is validated for automation. label Feb 23, 2026

Shreyas281299 requested changes Feb 24, 2026

View reviewed changes

Kesari3008 requested changes Feb 24, 2026

View reviewed changes

		@@ -0,0 +1,80 @@
		# New Method - Master Template

		> Purpose: Orchestrator for adding new methods to existing services.

Comments

Conversation

ciscoRankush commented Feb 23, 2026

COMPLETES #SPARK-775697

This pull request addresses

by making the following changes

Change Type

The following scenarios were tested

The GAI Coding Policy And Copyright Annotation Best Practices

I certified that

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants