@sibilance.is/client v0.1.0-alpha.4
@sibilance.is/client / index / SurveyStateActions
Class: SurveyStateActions
Defined in: CmdPr/sibilance/client/src/lib/survey-state.ts:46
Survey state actions
Constructors
Constructor
new SurveyStateActions(state, surveyConfig?): SurveyStateActions;Defined in: CmdPr/sibilance/client/src/lib/survey-state.ts:47
Parameters
| Parameter | Type |
|---|---|
state | SurveyState |
surveyConfig? | SurveyConfig | null |
Returns
SurveyStateActions
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
state | public | SurveyState | CmdPr/sibilance/client/src/lib/survey-state.ts:48 |
Methods
setSurveyConfig()
setSurveyConfig(config): void;Defined in: CmdPr/sibilance/client/src/lib/survey-state.ts:55
Update the survey config (called after it's fetched)
Parameters
| Parameter | Type |
|---|---|
config | SurveyConfig |
Returns
void
start()
start(startStepId, pathSteps): void;Defined in: CmdPr/sibilance/client/src/lib/survey-state.ts:73
Start the survey
Parameters
| Parameter | Type | Default value |
|---|---|---|
startStepId | string | undefined |
pathSteps | string[] | [] |
Returns
void
updateNodeResponse()
updateNodeResponse(
stepId,
response,
isMock): void;Defined in: CmdPr/sibilance/client/src/lib/survey-state.ts:117
Update node response
Parameters
| Parameter | Type | Default value |
|---|---|---|
stepId | string | undefined |
response | string | undefined |
isMock | boolean | false |
Returns
void
clearNodeResponse()
clearNodeResponse(stepId): void;Defined in: CmdPr/sibilance/client/src/lib/survey-state.ts:145
Clear node response - removes the response and marks step as unanswered
Parameters
| Parameter | Type |
|---|---|
stepId | string |
Returns
void
setCurrentStep()
setCurrentStep(stepId): void;Defined in: CmdPr/sibilance/client/src/lib/survey-state.ts:159
Set current step
Parameters
| Parameter | Type |
|---|---|
stepId | string |
Returns
void
recordInformation()
recordInformation(
field,
value,
sourceStep?): void;Defined in: CmdPr/sibilance/client/src/lib/survey-state.ts:193
Record information collected during survey
Parameters
| Parameter | Type |
|---|---|
field | string |
value | string |
sourceStep? | string |
Returns
void
logConversation()
logConversation(speaker, message): void;Defined in: CmdPr/sibilance/client/src/lib/survey-state.ts:206
Log conversation message
Parameters
| Parameter | Type |
|---|---|
speaker | "ai" | "user" |
message | string |
Returns
void
generateYAML()
generateYAML(): any[];Defined in: CmdPr/sibilance/client/src/lib/survey-state.ts:219
Generate YAML output from step responses and collected information Includes step metadata (label, script) to preserve context even if survey changes
Returns
any[]
markComplete()
markComplete(): void;Defined in: CmdPr/sibilance/client/src/lib/survey-state.ts:278
Mark survey as complete
Returns
void
pause()
pause(): void;Defined in: CmdPr/sibilance/client/src/lib/survey-state.ts:286
Pause the survey
Returns
void
stop()
stop(): void;Defined in: CmdPr/sibilance/client/src/lib/survey-state.ts:294
Stop/reset the survey
Returns
void
getNodesWithResponses()
getNodesWithResponses(): Set<string>;Defined in: CmdPr/sibilance/client/src/lib/survey-state.ts:308
Get nodes with responses
Returns
Set<string>
getNodeState()
getNodeState(stepId): NodeState | undefined;Defined in: CmdPr/sibilance/client/src/lib/survey-state.ts:322
Get node state by ID
Parameters
| Parameter | Type |
|---|---|
stepId | string |
Returns
NodeState | undefined