@stack-spot/portal-network 0.100.0 → 0.102.0

package/src/api/cloudPlatform.ts

@@ -24,7 +24,7 @@ export type FoundationResponse = {
     stackSpotAccountId: string;
     foundationId: string;
     details: FoundationDetails;
-    status: "READY" | "PENDING" | "ERROR";
+    status: "READY" | "PENDING" | "PENDING_APPROVAL" | "ERROR";
     createdAt: string;
     updatedAt: string;
     deletedAt?: string;
@@ -40,6 +40,35 @@ export type CreateFoundationRequest = {
     cloudProvider: string;
     region: string;
 };
+export type TunnelStatus = {
+    tunnel1?: string;
+    tunnel2?: string;
+};
+export type VpnDetails = {
+    peerCustomerGatewayIp: string;
+    destinationCidrBlock: string;
+    tunnelStatus: TunnelStatus;
+};
+export type VpnResponse = {
+    stackSpotAccountId: string;
+    foundationId: string;
+    vpnId: string;
+    details: VpnDetails;
+    status: "READY" | "PENDING" | "PENDING_APPROVAL" | "ERROR";
+    createdAt: string;
+    updatedAt: string;
+    deletedAt?: string;
+};
+export type ListVpnResponse = {
+    stackSpotAccountId: string;
+    foundationId: string;
+    pendingResources: boolean;
+    content: VpnResponse[];
+};
+export type CreateVpnRequest = {
+    peerCustomerGatewayIp: string;
+    destinationCidrBlock: string;
+};
 export type ProjectDetails = {
     name: string;
     folderName: string;
@@ -50,7 +79,7 @@ export type ProjectResponse = {
     parentFolderId: string;
     projectId: string;
     details: ProjectDetails;
-    status: "READY" | "PENDING" | "ERROR";
+    status: "READY" | "PENDING" | "PENDING_APPROVAL" | "ERROR";
     createdAt: string;
     updatedAt: string;
     deletedAt?: string;
@@ -78,7 +107,7 @@ export type NetworkResponse = {
     projectId: string;
     networkId: string;
     details: NetworkDetails;
-    status: "READY" | "PENDING" | "ERROR";
+    status: "READY" | "PENDING" | "PENDING_APPROVAL" | "ERROR";
     createdAt: string;
     updatedAt: string;
     deletedAt?: string;
@@ -110,7 +139,7 @@ export type NetworkConnectionResponse = {
     requesterProjectId: string;
     networkConnectionId: string;
     details: NetworkConnectionDetails;
-    status: "READY" | "PENDING" | "ERROR";
+    status: "READY" | "PENDING" | "PENDING_APPROVAL" | "ERROR";
     createdAt: string;
     updatedAt: string;
     deletedAt?: string;
@@ -138,7 +167,7 @@ export type InboundResponse = {
     projectId: string;
     inboundId: string;
     details: InboundDetails;
-    status: "READY" | "PENDING" | "ERROR";
+    status: "READY" | "PENDING" | "PENDING_APPROVAL" | "ERROR";
     createdAt: string;
     updatedAt: string;
     deletedAt?: string;
@@ -159,7 +188,7 @@ export type FolderContent = {
     "type": "FOLDER" | "PROJECT";
     id: string;
     name: string;
-    status: "READY" | "PENDING" | "ERROR";
+    status: "READY" | "PENDING" | "PENDING_APPROVAL" | "ERROR";
 };
 export type FolderDetails = {
     name: string;
@@ -172,7 +201,7 @@ export type FolderResponse = {
     parentFolderId: string;
     folderId: string;
     details: FolderDetails;
-    status: "READY" | "PENDING" | "ERROR";
+    status: "READY" | "PENDING" | "PENDING_APPROVAL" | "ERROR";
     createdAt: string;
     updatedAt: string;
     deletedAt?: string;
@@ -190,7 +219,7 @@ export type DnsZoneResponse = {
     foundationId: string;
     dnsZoneId: string;
     details: DnsZoneDetails;
-    status: "READY" | "PENDING" | "ERROR";
+    status: "READY" | "PENDING" | "PENDING_APPROVAL" | "ERROR";
     createdAt: string;
     updatedAt: string;
     deletedAt?: string;
@@ -219,7 +248,7 @@ export type DnsRecordResponse = {
     dnsZoneId: string;
     dnsRecordId: string;
     details: DnsRecordDetails;
-    status: "READY" | "PENDING" | "ERROR";
+    status: "READY" | "PENDING" | "PENDING_APPROVAL" | "ERROR";
     createdAt: string;
     updatedAt: string;
     deletedAt?: string;
@@ -254,7 +283,7 @@ export type CidrResponse = {
     foundationId: string;
     cidrId: string;
     details: CidrDetails;
-    status: "READY" | "PENDING" | "ERROR";
+    status: "READY" | "PENDING" | "PENDING_APPROVAL" | "ERROR";
     createdAt: string;
     updatedAt: string;
     deletedAt?: string;
@@ -291,7 +320,7 @@ export type CertificateResponse = {
     foundationId: string;
     certificateId: string;
     details: CertificateDetails;
-    status: "READY" | "PENDING" | "ERROR";
+    status: "READY" | "PENDING" | "PENDING_APPROVAL" | "ERROR";
     createdAt: string;
     updatedAt: string;
     deletedAt?: string;
@@ -325,6 +354,15 @@ export type ImportCertificateRequest = {
     certificatePrivateKey?: string;
     certificateChain?: string;
 };
+export type Configuration = {
+    ikev1: string;
+    ikev2: string;
+};
+export type VpnConfigurationResponse = {
+    vpnId: string;
+    foundationId: string;
+    configuration: Configuration;
+};
 export function listFoundations({ authorization }: {
     authorization: string;
 }, opts?: Oazapfts.RequestOpts) {
@@ -354,6 +392,37 @@ export function createFoundation({ authorization, createFoundationRequest }: {
         })
     })));
 }
+export function listVpns({ authorization, foundationId }: {
+    authorization: string;
+    foundationId: string;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: ListVpnResponse;
+    }>(`/v1/foundations/${encodeURIComponent(foundationId)}/vpns`, {
+        ...opts,
+        headers: oazapfts.mergeHeaders(opts?.headers, {
+            Authorization: authorization
+        })
+    }));
+}
+export function createVpn({ authorization, foundationId, createVpnRequest }: {
+    authorization: string;
+    foundationId: string;
+    createVpnRequest: CreateVpnRequest;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: VpnResponse;
+    }>(`/v1/foundations/${encodeURIComponent(foundationId)}/vpns`, oazapfts.json({
+        ...opts,
+        method: "POST",
+        body: createVpnRequest,
+        headers: oazapfts.mergeHeaders(opts?.headers, {
+            Authorization: authorization
+        })
+    })));
+}
 export function listProject({ authorization, foundationId, parentFolderId }: {
     authorization: string;
     foundationId: string;
@@ -694,6 +763,36 @@ export function getFoundation({ authorization, foundationId }: {
         })
     }));
 }
+export function getVpn({ authorization, foundationId, vpnId }: {
+    authorization: string;
+    foundationId: string;
+    vpnId: string;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: VpnResponse;
+    }>(`/v1/foundations/${encodeURIComponent(foundationId)}/vpns/${encodeURIComponent(vpnId)}`, {
+        ...opts,
+        headers: oazapfts.mergeHeaders(opts?.headers, {
+            Authorization: authorization
+        })
+    }));
+}
+export function getVpnConfiguration({ authorization, foundationId, vpnId }: {
+    authorization: string;
+    foundationId: string;
+    vpnId: string;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: VpnConfigurationResponse;
+    }>(`/v1/foundations/${encodeURIComponent(foundationId)}/vpns/${encodeURIComponent(vpnId)}/configuration`, {
+        ...opts,
+        headers: oazapfts.mergeHeaders(opts?.headers, {
+            Authorization: authorization
+        })
+    }));
+}
 export function getProject({ authorization, foundationId, projectId }: {
     authorization: string;
     foundationId: string;

package/src/client/ai.ts

@@ -1,7 +1,7 @@
 import { HttpError } from '@oazapfts/runtime'
+import { last } from 'lodash'
 import {
   addFavoriteV1FavoritesPost,
-  ChatResponse3,
   conversationHistoryV1ConversationsConversationIdGet,
   defaults,
   deleteConversationV1ConversationsConversationIdDelete,
@@ -30,7 +30,16 @@ import { StackspotAPIError } from '../error/StackspotAPIError'
 import { ReactQueryNetworkClient } from '../network/ReactQueryNetworkClient'
 import { removeAuthorizationParam } from '../utils/remove-authorization-param'
 import { StreamedJson } from '../utils/StreamedJson'
-import { FixedChatRequest, FixedConversationResponse, FixedDependencyResponse, ReplaceResult } from './types'
+import { agentClient } from './agent'
+import {
+  ChatAgentTool,
+  ChatResponseWithSteps,
+  FixedChatRequest,
+  FixedChatResponse,
+  FixedConversationResponse,
+  FixedDependencyResponse,
+  ReplaceResult,
+} from './types'
 
 class AIClient extends ReactQueryNetworkClient {
   constructor() {
@@ -46,42 +55,107 @@ class AIClient extends ReactQueryNetworkClient {
     })
   }
 
+  /**
+   * Chat: runs a quick action.
+   */
   runQuickAction = this.mutation(removeAuthorizationParam(quickActionsV1QuickActionsPost))
+  /**
+   * Lists the AI Stacks according to their visibilities.
+   */
   aiStacks = this.query(removeAuthorizationParam(listAiStacksV1AiStacksGet))
+  /**
+   * Gets a workspace by its id.
+   */
   workspace = this.query(removeAuthorizationParam(listAssociationV1WorkspaceWorkspaceIdGet))
+  /**
+   * Lists the quick commands according to filters passed as parameter.
+   */
   quickCommands = this.query(removeAuthorizationParam(listAllV1QuickCommandsAllGet))
+  /**
+   * Gets a quick command by its slug.
+   */
   quickCommand = this.query(removeAuthorizationParam(getQuickCommandV1QuickCommandsSlugGet))
+  /**
+   * Lists the knowledge sources according to filters passed as parameter.
+   */
   knowledgeSources = this.query(removeAuthorizationParam(listKnowledgeSourcesV1KnowledgeSourcesGet))
+  /**
+   * Gets a knowledge source by its slug.
+   */
   knowledgeSource = this.query(removeAuthorizationParam(findKnowledgeSourceV1KnowledgeSourcesSlugGet))
+  /**
+   * Gets a knowledge source document by the slug of the parent knowledge source and the document id.
+   */
   knowledgeSourceDocument = this.query(removeAuthorizationParam(findKnowledgeObjectByCustomIdV1KnowledgeSourcesSlugObjectsCustomIdGet))
+  /**
+   * Gets the chat history. This is a paginated resource.
+   */
   chats = this.infiniteQuery(removeAuthorizationParam(listConversationsV1ConversationsGet))
+  /**
+   * Gets a specific chat from the history according to its id.
+   */
   chat = this.query(removeAuthorizationParam(
     conversationHistoryV1ConversationsConversationIdGet as ReplaceResult<
       typeof conversationHistoryV1ConversationsConversationIdGet,
       FixedConversationResponse
     >,
   ))
+  /**
+   * Deletes a chat from the chat history.
+   */
   deleteChat = this.mutation(removeAuthorizationParam(deleteConversationV1ConversationsConversationIdDelete))
+  /**
+   * Gets a plain text version of the chat with id passed as parameter.
+   */
   downloadChat = this.mutation(removeAuthorizationParam(downloadConversationV1ConversationsConversationIdDownloadGet))
+  /**
+   * Renames a chat.
+   */
   renameChat = this.mutation(removeAuthorizationParam(updateTitleV1ConversationsConversationIdPatch))
+  /**
+   * Creates an event so it can be used as metric by the product designers (analytics).
+   */
   createEvent = this.mutation(removeAuthorizationParam(postEventV1EventsPost))
+  /**
+   * Runs a step of type "fetch" of a quick command.
+   */
   fetchStepOfQuickCommand = this.mutation(removeAuthorizationParam(formatFetchStepV1QuickCommandsSlugStepsStepSlugFetchFormatPost))
+  /**
+   * Runs a step of type "llm" of a quick command.
+   */
   llmStepOfQuickCommand = this.mutation(removeAuthorizationParam(quickCommandsRunV2V2QuickCommandsSlugStepsStepSlugRunPost))
+  /**
+   * Formats the result of a quick command into a human-readable text (markdown).
+   */
   formatResultOfQuickCommand = this.mutation(removeAuthorizationParam(formatResultV1QuickCommandsSlugResultFormatPost))
   /**
-     * List of favorites by type
-     */
+   * Lists the resources of type "$type" marked as favorites.
+   */
   listFavoritesByType = this.query(removeAuthorizationParam(getFavoritesByTypeV1FavoritesGet)) 
   /**
-     * Remove favorite from list
-     */
+   * Removes the resource of type "favoriteRequest.type" from the list of favorites.
+   */
   removeFavorite = this.mutation(removeAuthorizationParam(deleteFavoriteV1FavoritesDelete)) 
   /**
-     * Add favorite to list
-     */
+   * Adds the resource of type "favoriteRequest.type" to the list of favorites.
+   */
   addFavorite = this.mutation(removeAuthorizationParam(addFavoriteV1FavoritesPost)) 
 
-  sendChatMessage(request: FixedChatRequest, minChangeIntervalMS?: number): StreamedJson<ChatResponse3> {
+  private static async toolsOfAgent(agentId?: string) {
+    try {
+      const agent = agentId ? await agentClient.agent.query({ agentId }) : undefined
+      if (!agent) return []
+      const tools: (Omit<ChatAgentTool, 'duration' | 'prompt' | 'output'>)[] = []
+      agent.toolkits?.builtins?.forEach(kit => kit.tools?.forEach(({ id, name, description }) => {
+        if (id) tools.push({ image: kit.image_url, id, name: name || id, description })
+      }))
+      return tools
+    } catch {
+      return []
+    }
+  }
+
+  sendChatMessage(request: FixedChatRequest, minChangeIntervalMS?: number): StreamedJson<ChatResponseWithSteps> {
     const abortController = new AbortController()
     const headers = {
       'Content-Type': 'application/json',
@@ -91,7 +165,92 @@ class AIClient extends ReactQueryNetworkClient {
       this.resolveURL('v3/chat'),
       { method: 'post', body: JSON.stringify(request), headers, signal: abortController.signal },
     )
-    return new StreamedJson(events, abortController, minChangeIntervalMS)
+
+    /**
+     * This function treats events in the streaming that deals with the execution of tools. Since these events are not concatenated like
+     * normal streamings of data, we need this separate function to deal with them. It transforms the internal data model of the
+     * StreamedJson object whenever an event is triggered.
+     */
+    async function transform(event: Partial<FixedChatResponse>, data: Partial<ChatResponseWithSteps>) {
+      const info = event.agent_info
+      if (!info) return
+      data.steps = data.steps ? [...data.steps] : []
+      
+      if (info.type === 'planning' && info.action === 'end') {
+        const tools = await AIClient.toolsOfAgent(request.context?.agent_id)
+        data.steps.push(
+          { id: 'planning', type: 'planning', duration: info.duration, input: info.data?.plan_goal ?? '', status: 'success' },
+        )
+        info.data?.steps.forEach(s => data.steps?.push({
+          id: s.id,
+          type: 'step',
+          input: s.goal,
+          status: 'pending',
+          tools: s.tools?.map(t => ({
+            ...(tools.find(({ id }) => id === t.tool_id) ?? { id: t.tool_id, name: t.tool_id }),
+            executionId: t.tool_execution_id,
+          })),
+        }))
+        data.steps.push({ id: 'answer', type: 'answer', status: 'pending' })
+      }
+
+      if (info.type === 'step' && info.action === 'start') {
+        const step = data.steps.find(s => s.id === info.id)
+        if (step) step.status = 'running'
+      }
+
+      if (info.type === 'step' && info.action === 'end') {
+        const step = data.steps.find(s => s.id === info.id)
+        if (step) {
+          step.status = 'success'
+          step.duration = info.duration
+          step.output = last(step.tools)?.output
+        }
+      }
+
+      if (info.type === 'tool' && info.action === 'start') {
+        const currentStep = data.steps.find(s => s.status === 'running')
+        const tool = currentStep?.tools?.find(t => t.executionId === info.id)
+        if (tool) {
+          tool.input = info.data ? JSON.stringify(info.data.input, null, 2) : undefined
+        }
+      }
+
+      if (info.type === 'tool' && info.action === 'end') {
+        const currentStep = data.steps.find(s => s.status === 'running')
+        const tool = currentStep?.tools?.find(t => t.executionId === info.id)
+        if (tool) {
+          tool.output = info.data?.output
+          tool.duration ??= 0
+          tool.duration += info.duration ?? 0
+        }
+      }
+
+      if (info.type === 'final_answer' && info.action === 'start') {
+        // if we get a "final_answer" event while there's a previous step still running, it means that step has failed.
+        data.steps?.forEach((s) => {
+          if (s.type === 'step' && s.status === 'running') s.status = 'error'
+        })
+        const answerStep = last(data.steps)
+        if (answerStep) answerStep.status = 'running'
+      }
+
+      if (info.type === 'final_answer' && info.action === 'end') {
+        const answerStep = last(data.steps)
+        if (answerStep) {
+          answerStep.status = 'success'
+          answerStep.duration = info.duration
+        }
+      }
+    }
+
+    return new StreamedJson({
+      eventsPromise: events,
+      abortController,
+      minChangeIntervalMS,
+      ignoreKeys: ['agent_info'],
+      transform,
+    })
   }
   
   contentDependencies = this.query(removeAuthorizationParam(

package/src/client/cloud-platform.ts

@@ -12,11 +12,13 @@ import
   createNetwork,
   createNetworkConnection,
   createProject,
+  createVpn,
   defaults,
   getCertificate,
   getFolder,
   getFoundation,
   getProject,
+  getVpnConfiguration,
   listCertificates,
   listCidr,
   listDnsRecord,
@@ -25,6 +27,7 @@ import
   listInbound,
   listNetwork,
   listNetworkConnection,
+  listVpns,
   providers,
 } from '../api/cloudPlatform'
 import apis from '../apis.json'
@@ -138,6 +141,18 @@ class CloudPlatformClient extends ReactQueryNetworkClient {
    * Accept a network connection
    */
   acceptNetworkConnection = this.mutation(removeAuthorizationParam(acceptNetworkConnection))
+  /**
+   * Get a list of vpn's
+   */
+  listVpns = this.query(removeAuthorizationParam(listVpns))
+  /**
+   * Get vpn configuration
+   */
+  getVpnConfiguration = this.query(removeAuthorizationParam(getVpnConfiguration))
+  /**
+   * Create a vpn
+   */
+  createVpn = this.mutation(removeAuthorizationParam(createVpn))
 }
 
 export const cloudPlatformClient = new CloudPlatformClient()

package/src/client/types.ts

@@ -227,6 +227,78 @@ export interface FixedAddResourceToWorkspaceAi {
   error_id: string[],
 }
 
+export interface ChatAgentTool {
+  id: string,
+  executionId?: string,
+  duration?: number,
+  name: string,
+  description?: string,
+  image?: string,
+  input?: string,
+  output?: string,
+}
+
+export interface ChatStep {
+  id: string,
+  type: 'planning' | 'step' | 'answer',
+  duration?: number,
+  input?: string,
+  output?: string,
+  status: 'pending' | 'running' | 'success' | 'error',
+  tools?: ChatAgentTool[],
+}
+
+export interface BaseAgentInfo {
+  type: 'chat' | 'planning' | 'step' | 'tool' | 'final_answer',
+  action: 'start' | 'end',
+  duration?: number,
+}
+
+export interface PlanningAgentInfo extends BaseAgentInfo {
+  type: 'planning',
+  data?: {
+    plan_goal: string,
+    total_steps: number,
+    steps: {
+      id: string,
+      goal: string,
+      tools?: {
+        tool_id: string,
+        tool_execution_id: string,
+      }[],
+    }[],
+  },
+}
+
+export interface StepAgentInfo extends BaseAgentInfo {
+  type: 'step',
+  id: string,
+}
+
+export interface ToolAgentInfo extends BaseAgentInfo {
+  type: 'tool',
+  id: string,
+  data?: {
+    input?: any,
+    attempt: number,
+    output?: string,
+  },
+}
+
+export interface GenericAgentInfo extends BaseAgentInfo {
+  type: 'chat' | 'final_answer',
+}
+
+export type AgentInfo = GenericAgentInfo | PlanningAgentInfo | StepAgentInfo | ToolAgentInfo
+
+export interface FixedChatResponse extends ChatResponse3 {
+  agent_info: AgentInfo,
+}
+
+export interface ChatResponseWithSteps extends FixedChatResponse {
+  steps: ChatStep[],
+}
+
 export type OazapftsFunction<Variables = any, Result = any> = (variables: Variables, opts?: RequestOpts) => Promise<Result>
 
 type Unpromisify<T> = T extends Promise<infer R> ? Unpromisify<R> : T

package/src/utils/StreamedJson.tsx

@@ -7,6 +7,32 @@ import { FetchEventStream } from '../network/types'
 type StreamingStatus = 'pending' | 'success' | 'error'
 type OnChangeListener<T> = (value: Partial<T>) => void
 
+interface ConstructorParams<T> {
+  /**
+   * The promise that results in the EventStream to build the final json.
+   */
+  eventsPromise: Promise<FetchEventStream>,
+  /**
+   * A controller to abort the streaming.
+   */
+  abortController: AbortController,
+  /**
+   * A minimum number of milliseconds to wait before calling onChange listeners.
+   * @default 50
+   */
+  minChangeIntervalMS?: number,
+  /**
+   * Optional. If set, this function will be called with every streaming event and must transform the current data object according to the
+   * message received.
+   */
+  transform?: (event: Partial<T>, data: Partial<T>) => void | Promise<void>,
+  /**
+   * Optional. Keys to ignore when merging the result with the current event. Ignored keys are always replaced by the newest value instead
+   * of merged.
+   */
+  ignoreKeys?: (keyof T)[],
+}
+
 /**
  * An object represented by a JSON stream. This can be watched as the stream runs.
  */
@@ -16,13 +42,17 @@ export class StreamedJson<T> {
   private data: Partial<T> = {}
   private fullPromise = new CompletablePromise<T>()
   private abortController: AbortController | undefined
+  private transform?: (event: Partial<T>, data: Partial<T>) => void | Promise<void>
+  private ignoreKeys?: (keyof T)[]
 
   /**
    * @param response the fetch response.
    * @param minChangeIntervalMS a stream can be too fast. This sets a minimum interval between running the listeners. The default is 50ms.
    */
-  constructor(eventsPromise: Promise<FetchEventStream>, abortController: AbortController, minChangeIntervalMS = 50) {
+  constructor({ eventsPromise, abortController, minChangeIntervalMS = 50, transform, ignoreKeys }: ConstructorParams<T>) {
     this.abortController = abortController
+    this.transform = transform
+    this.ignoreKeys = ignoreKeys
     this.run(eventsPromise, minChangeIntervalMS)
   }
 
@@ -35,7 +65,8 @@ export class StreamedJson<T> {
         if (this.error) return
         if (event.data) {
           const json = JSON.parse(event.data)
-          StreamedJson.merge(json, this.data)
+          await this.transform?.(json, this.data)
+          this.merge(json, this.data)
           if (new Date().getTime() - lastChangeCall >= minChangeIntervalMS) {
             this.onChangeListeners.forEach(l => l(this.data))
             lastChangeCall = new Date().getTime()
@@ -55,9 +86,9 @@ export class StreamedJson<T> {
     if (!this.error) this.complete()
   }
 
-  private static merge(source: Record<string, any>, target: Record<string, any>) {
+  private merge(source: Record<string, any>, target: Record<string, any>) {
     Object.keys(source).forEach((k) => {
-      if (typeof source[k] !== typeof target[k]) target[k] = source[k]
+      if (this.ignoreKeys?.includes(k as keyof T) || typeof source[k] !== typeof target[k]) target[k] = source[k]
       else if (typeof source[k] === 'string') target[k] += source[k]
       else if (Array.isArray(source[k])) target[k].push(...source[k])
       else if (typeof source[k] === 'number') parseFloat(target[k] + source[k])