@newheap/platform-ai-chat 0.19.0 → 0.20.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@newheap/platform-ai-chat",
-  "version": "0.19.0",
+  "version": "0.20.0",
   "peerDependencies": {
     "@angular/cdk": "^20.2.14",
     "@angular/common": "^20.3.28",

package/testing/index.d.ts

@@ -80,6 +80,24 @@ interface NhAssistantMockApprovalConsultation {
     /** The consulted agent's answer. Default none. */
     answer?: string | null;
 }
+/**
+ * Asks a question with `ask_question`: `tool.started`, `question.asked` and `turn.completed` with
+ * status `waiting-for-approval`, as the server's `run.AllowQuestions()` does. Only the addressee
+ * answers, with `POST conversations/{id}/questions/{questionId}/answer`; the answer resumes the turn
+ * with the `answered` steps, or with the steps that function returns for the chosen answer.
+ */
+interface NhAssistantMockQuestionStep {
+    question: {
+        question: string;
+        /** Two to six answers. */
+        choices: string[];
+        /** The person who answers; default the person whose turn asks. */
+        addresseeActorId?: string;
+        /** Default 900 seconds, the server's default wait. */
+        expiresInSeconds?: number;
+        answered: NhAssistantMockStep[] | ((answer: string, choice: number) => NhAssistantMockStep[]);
+    };
+}
 /** Ends the stream with an `error` event. */
 interface NhAssistantMockErrorStep {
     error: {
@@ -104,7 +122,7 @@ interface NhAssistantMockConnectionStep {
         text?: string;
     };
 }
-type NhAssistantMockStep = NhAssistantMockTextStep | NhAssistantMockToolStep | NhAssistantMockApprovalStep | NhAssistantMockErrorStep | NhAssistantMockFailStep | NhAssistantMockConnectionStep;
+type NhAssistantMockStep = NhAssistantMockTextStep | NhAssistantMockToolStep | NhAssistantMockApprovalStep | NhAssistantMockQuestionStep | NhAssistantMockErrorStep | NhAssistantMockFailStep | NhAssistantMockConnectionStep;
 /** A scripted assistant turn, chosen by matching the user's message. */
 interface NhAssistantMockTurn {
     /** Case-insensitive substring, regular expression or predicate. Omit to match every message. */
@@ -150,6 +168,11 @@ interface NhAssistantMockAgentMetadataEntry {
     maxBytes?: number;
     /** The field of the value whose text is its searchable value, as `IndexBy`. */
     indexBy?: string;
+    /**
+     * The field of the value whose texts are its searchable values, as `IndexByEach`; an entry names
+     * `indexBy` or `indexByEach`.
+     */
+    indexByEach?: string;
     /**
      * The fields of the entry's type: a value with another field is refused with `value: invalid`, as
      * the server refuses JSON that does not fit the type. Without it every field is accepted.
@@ -813,6 +836,7 @@ declare class NhAssistantMockBackend {
     private readonly config;
     private readonly conversations;
     private readonly pendingApprovals;
+    private readonly pendingQuestions;
     private readonly runs;
     /** Page context of the latest message per conversation, as the server stores it. */
     private readonly pageContexts;
@@ -906,9 +930,26 @@ declare class NhAssistantMockBackend {
      * (`consultation.movedToApprovalId`) and resumes the turn with the step's `left` steps.
      */
     private decide;
+    /**
+     * `POST conversations/{id}/approvals/{approvalId}/resolve`: the person who approved a proposal in this
+     * chat resolves its uncertain hand-off (`canResolve`), as the server does: `hand-to-application` hands
+     * it to the application again with a new report deadline, `mark-resolved` confirms it. Another action
+     * is refused, as are an approval in another status and one the caller may not resolve. Returns the
+     * conversation.
+     */
+    private resolve;
+    /**
+     * `POST conversations/{id}/questions/{questionId}/answer`: the addressee answers the question the
+     * turn waits for with the index of a choice, as on the server. Anyone else is refused, as are a
+     * choice the question does not offer and a question whose wait ended, which releases the
+     * conversation. The answer resumes the turn with the step's answered steps.
+     */
+    private answer;
     private cancel;
     private playSteps;
     private pauseForApproval;
+    /** Records the `ask_question` call and posts the question; the turn then waits for its answer. */
+    private pauseForQuestion;
     private stream;
     private findTurn;
     private update;
@@ -1017,4 +1058,4 @@ declare class NhAssistantMockLiveService implements NhAssistantLiveSurface {
 declare function provideNhAssistantMockApi(script: NhAssistantMockScenario): EnvironmentProviders;
 
 export { NH_ASSISTANT_MOCK_HUB_PATH, NH_ASSISTANT_MOCK_SCENARIO, NhAssistantMockAuthorizationWindow, NhAssistantMockBackend, NhAssistantMockLiveService, provideNhAssistantMockApi };
-export type { NhAssistantMockAdminAgent, NhAssistantMockAdminScenario, NhAssistantMockAgentGroup, NhAssistantMockAgentMetadataEntry, NhAssistantMockAgentPackage, NhAssistantMockApprovalConsultation, NhAssistantMockApprovalStep, NhAssistantMockCodeHandOff, NhAssistantMockCollaboration, NhAssistantMockConnectionStep, NhAssistantMockConsultation, NhAssistantMockConsultationCeiling, NhAssistantMockDataConsultation, NhAssistantMockDataSkill, NhAssistantMockDataTrigger, NhAssistantMockDivision, NhAssistantMockErrorStep, NhAssistantMockFailStep, NhAssistantMockHandOffCeiling, NhAssistantMockHandOffRule, NhAssistantMockInstructionAsset, NhAssistantMockLiveMessage, NhAssistantMockMcpServer, NhAssistantMockPerson, NhAssistantMockProposal, NhAssistantMockRemoteTool, NhAssistantMockRequest, NhAssistantMockRun, NhAssistantMockRunConfigurationPreset, NhAssistantMockRunNow, NhAssistantMockScenario, NhAssistantMockShadowVariantCeiling, NhAssistantMockStep, NhAssistantMockSubject, NhAssistantMockSubjectType, NhAssistantMockTextStep, NhAssistantMockTiming, NhAssistantMockToolStep, NhAssistantMockTurn, NhAssistantMockUpload };
+export type { NhAssistantMockAdminAgent, NhAssistantMockAdminScenario, NhAssistantMockAgentGroup, NhAssistantMockAgentMetadataEntry, NhAssistantMockAgentPackage, NhAssistantMockApprovalConsultation, NhAssistantMockApprovalStep, NhAssistantMockCodeHandOff, NhAssistantMockCollaboration, NhAssistantMockConnectionStep, NhAssistantMockConsultation, NhAssistantMockConsultationCeiling, NhAssistantMockDataConsultation, NhAssistantMockDataSkill, NhAssistantMockDataTrigger, NhAssistantMockDivision, NhAssistantMockErrorStep, NhAssistantMockFailStep, NhAssistantMockHandOffCeiling, NhAssistantMockHandOffRule, NhAssistantMockInstructionAsset, NhAssistantMockLiveMessage, NhAssistantMockMcpServer, NhAssistantMockPerson, NhAssistantMockProposal, NhAssistantMockQuestionStep, NhAssistantMockRemoteTool, NhAssistantMockRequest, NhAssistantMockRun, NhAssistantMockRunConfigurationPreset, NhAssistantMockRunNow, NhAssistantMockScenario, NhAssistantMockShadowVariantCeiling, NhAssistantMockStep, NhAssistantMockSubject, NhAssistantMockSubjectType, NhAssistantMockTextStep, NhAssistantMockTiming, NhAssistantMockToolStep, NhAssistantMockTurn, NhAssistantMockUpload };