@api-client/core 0.19.0 → 0.19.2

package/src/models/AiSession.ts

@@ -0,0 +1,160 @@
+import type { IDeletion } from './store/Deletion.js'
+import { AiSessionKind } from './kinds.js'
+import { nanoid } from '../nanoid.js'
+import type { AiModelMessage } from './AiMessage.js'
+
+export type AiSessionApp = 'domain' | 'api' | 'general'
+
+export interface AiSessionSchema {
+  /**
+   * The kind of the schema
+   * This is set by the API and is used to identify the schema.
+   * @readonly
+   */
+  readonly kind: typeof AiSessionKind
+  /**
+   * The key of the session
+   * This is set by the API and is used to identify the session.
+   */
+  key: string
+  /**
+   * The application the session is for.
+   * Each app must query for its own sessions.
+   */
+  app: AiSessionApp
+  /**
+   * The title of the session.
+   */
+  title: string
+  /**
+   * Whether the session is pinned.
+   */
+  pinned: boolean
+  /**
+   * Whether the user has renamed the session.
+   */
+  userRenamed: boolean
+  /**
+   * The creation timestamp of the session.
+   */
+  createdAt: number
+  /**
+   * The update timestamp of the session.
+   */
+  updatedAt: number
+  /**
+   * Whether the file object is deleted.
+   */
+  deleted?: boolean
+  /**
+   * The information about the delete information.
+   * Always set when the `delete` is true.
+   */
+  deletedInfo?: IDeletion
+}
+
+export class AiSession implements AiSessionSchema {
+  static get Kind(): typeof AiSessionKind {
+    return AiSessionKind
+  }
+
+  get kind(): typeof AiSessionKind {
+    return AiSessionKind
+  }
+
+  key: string
+  app: AiSessionApp
+  title: string
+  pinned: boolean
+  userRenamed: boolean
+  createdAt: number
+  updatedAt: number
+  deleted: boolean
+  deletedInfo?: IDeletion
+
+  /**
+   * Checks if the given value is a valid AiSessionApp.
+   */
+  static isSessionApp(app: unknown): app is AiSessionApp {
+    return ['domain', 'api', 'general'].includes(app as string)
+  }
+
+  static createSchema(input: Partial<AiSessionSchema>): AiSessionSchema {
+    const { key = nanoid(), app, title = '', createdAt = 0, updatedAt = 0, pinned = false, userRenamed = false } = input
+    if (!app) {
+      throw new Error('App is required to create an AiSession schema.')
+    }
+    if (!AiSession.isSessionApp(app)) {
+      throw new Error(`Invalid app: ${app}`)
+    }
+    const result: AiSessionSchema = {
+      key,
+      kind: AiSessionKind,
+      app,
+      title,
+      pinned,
+      userRenamed,
+      createdAt,
+      updatedAt,
+    }
+    if (input.deleted) {
+      result.deleted = input.deleted
+      result.deletedInfo = input.deletedInfo
+    }
+    return result
+  }
+
+  constructor(input: Partial<AiSessionSchema> = {}) {
+    const init = AiSession.createSchema(input)
+    this.key = init.key
+    this.app = init.app
+    this.title = init.title
+    this.pinned = init.pinned
+    this.userRenamed = init.userRenamed
+    this.createdAt = init.createdAt
+    this.updatedAt = init.updatedAt
+    this.deleted = init.deleted || false
+    this.deletedInfo = init.deletedInfo
+  }
+
+  toJSON(): AiSessionSchema {
+    const result: AiSessionSchema = {
+      kind: this.kind,
+      key: this.key,
+      app: this.app,
+      title: this.title,
+      pinned: this.pinned,
+      userRenamed: this.userRenamed,
+      createdAt: this.createdAt,
+      updatedAt: this.updatedAt,
+    }
+    if (this.deleted && this.deletedInfo) {
+      result.deleted = this.deleted
+      result.deletedInfo = { ...this.deletedInfo }
+    }
+    return result
+  }
+
+  /**
+   * Processes the agent response and extracts the session title if available.
+   * It looks for a JSON object in the response text and extracts the `sessionTitle`.
+   *
+   * @param message The agent response.
+   * @returns {string | null} The session title if found, otherwise null.
+   */
+  static extractSessionTitle(message: AiModelMessage): string | null {
+    const txt = message.text
+    if (!txt) {
+      return null
+    }
+    try {
+      const json = JSON.parse(txt)
+      if (json.sessionTitle) {
+        return String(json.sessionTitle)
+      }
+    } catch {
+      // ignore
+    }
+    return null
+  }
+}

package/src/models/kinds.ts

@@ -24,3 +24,5 @@ export const ApiModelKind = 'Core#ApiModel'
 export const ExposedEntityKind = 'Core#ExposedEntity'
 export const ApiFileKind = 'Core#ApiFile'
 export const GroupKind = 'Core#Group'
+export const AiSessionKind = 'Core#AiSession'
+export const AiMessageKind = 'Core#AiMessage'

package/src/sdk/AiSdk.ts

@@ -0,0 +1,395 @@
+import type { ContextListOptions, ContextListResult } from '../events/BaseEvents.js'
+import { Exception } from '../exceptions/exception.js'
+import type { AiStreamEvent } from '../modeling/ai/types.js'
+import type { AiMessage, AiMessageSchema } from '../models/AiMessage.js'
+import type { AiSessionApp, AiSessionSchema } from '../models/AiSession.js'
+import { AiMessageKind, AiSessionKind } from '../models/kinds.js'
+import { RouteBuilder } from './RouteBuilder.js'
+import {
+  E_INVALID_JSON,
+  E_RESPONSE_NO_VALUE,
+  E_RESPONSE_STATUS,
+  E_RESPONSE_UNKNOWN,
+  SdkBase,
+  type SdkOptions,
+} from './SdkBase.js'
+
+export class AiSdk extends SdkBase {
+  /**
+   * Modifies the domain of a file.
+   * @param oid The organization id.
+   * @param fid The domain file id.
+   * @param goal The goal to modify the domain for.
+   * @param sid The conversation session id, if any. When provided it will be used to continue the conversation.
+   * @param request The request options.
+   */
+  async *modifyDomain(
+    oid: string,
+    fid: string,
+    goal: string,
+    sid?: string,
+    request: SdkOptions = {}
+  ): AsyncGenerator<AiStreamEvent> {
+    const { token = this.sdk.token, signal } = request
+    const url = this.sdk.getUrl(RouteBuilder.aiModifyDomain(oid, fid))
+    const body = JSON.stringify({ goal, sid })
+    const init: RequestInit = {
+      method: 'POST',
+      headers: {
+        'content-type': 'application/json',
+        'accept': 'text/event-stream',
+        'authorization': `Bearer ${token}`,
+      },
+      redirect: 'follow',
+      credentials: 'include',
+      body,
+      signal,
+    }
+    const result = await fetch(url, init)
+    if (!result.ok) {
+      const errText = await result.text()
+      throw new Exception(`Failed to modify domain: ${result.status} ${errText}`)
+    }
+
+    const reader = result.body?.getReader()
+    if (!reader) {
+      throw new Exception('Failed to get reader from response')
+    }
+
+    const decoder = new TextDecoder()
+    let buffer = ''
+    while (true) {
+      const { done, value } = await reader.read()
+      if (done) {
+        return
+      }
+      buffer += decoder.decode(value, { stream: true })
+      let newlineIndex: number
+      while ((newlineIndex = buffer.indexOf('\n\n')) >= 0) {
+        const messageChunk = buffer.slice(0, newlineIndex)
+        buffer = buffer.slice(newlineIndex + 2)
+        if (!messageChunk.trim()) continue
+
+        const lines = messageChunk.split('\n')
+        let eventName = 'message'
+        let eventDataStr = ''
+
+        for (const line of lines) {
+          if (line.startsWith('event:')) {
+            eventName = line.substring(6).trim()
+          } else if (line.startsWith('data:')) {
+            eventDataStr += line.substring(5).trim()
+          }
+        }
+
+        if (!eventDataStr) continue
+
+        let eventData
+        try {
+          eventData = JSON.parse(eventDataStr)
+        } catch {
+          // eslint-disable-next-line no-console
+          console.error('Failed to parse SSE JSON data:', eventDataStr)
+          continue
+        }
+
+        switch (eventName) {
+          case 'user-message':
+          case 'agent-message':
+            // Assume the data is a full AiMessage
+            yield { event: eventName, data: eventData as AiMessage }
+            break
+          case 'thought-chunk':
+          case 'text-chunk':
+            // Assume the data is string diff chunks
+            yield { event: eventName, data: eventData as string }
+            break
+          case 'done':
+            yield { event: eventName, data: eventData as AiMessage }
+            return
+          case 'error':
+            yield { event: eventName, data: Exception.fromRawException(eventData, 'Failed to generate results') }
+            break
+          case 'session-updated':
+            yield { event: eventName, data: eventData as AiSessionSchema }
+            break
+          default:
+            // eslint-disable-next-line no-console
+            console.warn(`Unknown SSE event: ${eventName}`)
+        }
+      }
+    }
+  }
+
+  sessions = {
+    /**
+     * Lists the AI sessions for the given organization and application.
+     * @param oid The organization id.
+     * @param app The application id.
+     * @param options The list options.
+     * @param request The request options.
+     * @returns The list of AI sessions.
+     */
+    list: async (
+      oid: string,
+      app: AiSessionApp,
+      options: ContextListOptions = {},
+      request: SdkOptions = {}
+    ): Promise<ContextListResult<AiSessionSchema>> => {
+      const { token = this.sdk.token } = request
+      const url = this.sdk.getUrl(RouteBuilder.aiSessions(oid, app))
+      this.sdk.appendListOptions(url, options)
+      const result = await this.sdk.http.get(url.toString(), { token })
+      this.inspectCommonStatusCodes(result)
+      const E_PREFIX = 'Unable to list sessions. '
+      if (result.status !== 200) {
+        this.logInvalidResponse(result)
+        throw this.createApiError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.body)
+      }
+      if (!result.body) {
+        throw new Exception(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`, { code: 'E_RESPONSE_NO_VALUE', status: result.status })
+      }
+      let data: ContextListResult<AiSessionSchema>
+      try {
+        data = JSON.parse(result.body)
+      } catch {
+        throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
+      }
+      if (!Array.isArray(data.items)) {
+        throw new Exception(`${E_PREFIX}${E_RESPONSE_UNKNOWN}`, { code: 'E_RESPONSE_UNKNOWN', status: result.status })
+      }
+      return data
+    },
+
+    /**
+     * Reads the AI session for the given organization, application and session id.
+     * @param oid The organization id.
+     * @param app The application id.
+     * @param sid The session id.
+     * @param request The request options.
+     * @returns The AI session.
+     */
+    read: async (oid: string, app: AiSessionApp, sid: string, request: SdkOptions = {}): Promise<AiSessionSchema> => {
+      const { token = this.sdk.token } = request
+      const url = this.sdk.getUrl(RouteBuilder.aiSession(oid, app, sid))
+      const result = await this.sdk.http.get(url.toString(), { token })
+      this.inspectCommonStatusCodes(result)
+      const E_PREFIX = 'Unable to read session. '
+      if (result.status !== 200) {
+        this.logInvalidResponse(result)
+        throw this.createApiError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.body)
+      }
+      if (!result.body) {
+        throw new Exception(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`, { code: 'E_RESPONSE_NO_VALUE', status: result.status })
+      }
+      let data: AiSessionSchema
+      try {
+        data = JSON.parse(result.body)
+      } catch {
+        throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
+      }
+      if (data.kind !== AiSessionKind) {
+        throw new Exception(`${E_PREFIX}${E_RESPONSE_UNKNOWN}`, { code: 'E_RESPONSE_UNKNOWN', status: result.status })
+      }
+      return data
+    },
+
+    /**
+     * Creates the AI session for the given organization, application and session id.
+     * @param oid The organization id.
+     * @param app The application id.
+     * @param session The AI session to create.
+     * @param request The request options.
+     * @returns The created AI session.
+     */
+    create: async (
+      oid: string,
+      app: AiSessionApp,
+      session: Partial<AiSessionSchema>,
+      request: SdkOptions = {}
+    ): Promise<AiSessionSchema> => {
+      const { token = this.sdk.token } = request
+      const url = this.sdk.getUrl(RouteBuilder.aiSessions(oid, app))
+      const body = JSON.stringify(session)
+      const result = await this.sdk.http.post(url.toString(), { token, body })
+      this.inspectCommonStatusCodes(result)
+      const E_PREFIX = 'Unable to create session. '
+      if (result.status !== 201) {
+        this.logInvalidResponse(result)
+        throw this.createApiError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.body)
+      }
+      if (!result.body) {
+        throw new Exception(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`, { code: 'E_RESPONSE_NO_VALUE', status: result.status })
+      }
+      let data: AiSessionSchema
+      try {
+        data = JSON.parse(result.body)
+      } catch {
+        throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
+      }
+      if (data.kind !== AiSessionKind) {
+        throw new Exception(`${E_PREFIX}${E_RESPONSE_UNKNOWN}`, { code: 'E_RESPONSE_UNKNOWN', status: result.status })
+      }
+      return data
+    },
+
+    /**
+     * Deletes the AI session for the given organization, application and session id.
+     * The API performs a soft delete of the session.
+     * @param oid The organization id.
+     * @param app The application id.
+     * @param sid The session id.
+     * @param request The request options.
+     */
+    delete: async (oid: string, app: AiSessionApp, sid: string, request: SdkOptions = {}): Promise<void> => {
+      const { token = this.sdk.token } = request
+      const url = this.sdk.getUrl(RouteBuilder.aiSession(oid, app, sid))
+      const result = await this.sdk.http.delete(url.toString(), { token })
+      this.inspectCommonStatusCodes(result)
+      const E_PREFIX = 'Unable to delete session. '
+      if (result.status !== 204) {
+        this.logInvalidResponse(result)
+        throw this.createApiError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.body)
+      }
+    },
+
+    /**
+     * Updates the AI session for the given organization, application and session id.
+     * @param oid The organization id.
+     * @param app The application id.
+     * @param session The AI session to update.
+     * @param request The request options.
+     * @returns The updated AI session.
+     */
+    update: async (
+      oid: string,
+      app: AiSessionApp,
+      session: AiSessionSchema,
+      request: SdkOptions = {}
+    ): Promise<AiSessionSchema> => {
+      const { token = this.sdk.token } = request
+      const url = this.sdk.getUrl(RouteBuilder.aiSession(oid, app, session.key))
+      const body = JSON.stringify(session)
+      const result = await this.sdk.http.put(url.toString(), { token, body })
+      this.inspectCommonStatusCodes(result)
+      const E_PREFIX = 'Unable to update session. '
+      if (result.status !== 200) {
+        this.logInvalidResponse(result)
+        throw this.createApiError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.body)
+      }
+      if (!result.body) {
+        throw new Exception(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`, { code: 'E_RESPONSE_NO_VALUE', status: result.status })
+      }
+      let data: AiSessionSchema
+      try {
+        data = JSON.parse(result.body)
+      } catch {
+        throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
+      }
+      if (data.kind !== AiSessionKind) {
+        throw new Exception(`${E_PREFIX}${E_RESPONSE_UNKNOWN}`, { code: 'E_RESPONSE_UNKNOWN', status: result.status })
+      }
+      return data
+    },
+  }
+
+  messages = {
+    /**
+     * Lists the AI messages for the given organization and session id.
+     * @param oid The organization id.
+     * @param sid The session id.
+     * @param options The list options.
+     * @param request The request options.
+     * @returns The list of AI messages.
+     */
+    list: async (
+      oid: string,
+      sid: string,
+      options: ContextListOptions = {},
+      request: SdkOptions = {}
+    ): Promise<ContextListResult<AiMessageSchema>> => {
+      const { token = this.sdk.token } = request
+      const url = this.sdk.getUrl(RouteBuilder.aiMessages(oid, sid))
+      this.sdk.appendListOptions(url, options)
+      const result = await this.sdk.http.get(url.toString(), { token })
+      this.inspectCommonStatusCodes(result)
+      const E_PREFIX = 'Unable to list messages. '
+      if (result.status !== 200) {
+        this.logInvalidResponse(result)
+        throw this.createApiError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.body)
+      }
+      if (!result.body) {
+        throw new Exception(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`, { code: 'E_RESPONSE_NO_VALUE', status: result.status })
+      }
+      let data: ContextListResult<AiMessageSchema>
+      try {
+        data = JSON.parse(result.body)
+      } catch {
+        throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
+      }
+      if (!Array.isArray(data.items)) {
+        throw new Exception(`${E_PREFIX}${E_RESPONSE_UNKNOWN}`, { code: 'E_RESPONSE_UNKNOWN', status: result.status })
+      }
+      return data
+    },
+
+    /**
+     * Deletes the AI message for the given organization, session and message id.
+     * The API performs a soft delete of the message.
+     * @param oid The organization id.
+     * @param sid The session id.
+     * @param mid The message id.
+     * @param request The request options.
+     */
+    delete: async (oid: string, sid: string, mid: string, request: SdkOptions = {}): Promise<void> => {
+      const { token = this.sdk.token } = request
+      const url = this.sdk.getUrl(RouteBuilder.aiMessage(oid, sid, mid))
+      const result = await this.sdk.http.delete(url.toString(), { token })
+      this.inspectCommonStatusCodes(result)
+      const E_PREFIX = 'Unable to delete message. '
+      if (result.status !== 204) {
+        this.logInvalidResponse(result)
+        throw this.createApiError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.body)
+      }
+    },
+
+    /**
+     * Updates the AI message for the given organization, session and message id.
+     * @param oid The organization id.
+     * @param sid The session id.
+     * @param message The AI message to update.
+     * @param request The request options.
+     * @returns The updated AI message.
+     */
+    update: async (
+      oid: string,
+      sid: string,
+      message: AiMessageSchema,
+      request: SdkOptions = {}
+    ): Promise<AiMessageSchema> => {
+      const { token = this.sdk.token } = request
+      const url = this.sdk.getUrl(RouteBuilder.aiMessage(oid, sid, message.key))
+      const body = JSON.stringify(message)
+      const result = await this.sdk.http.put(url.toString(), { token, body })
+      this.inspectCommonStatusCodes(result)
+      const E_PREFIX = 'Unable to update message. '
+      if (result.status !== 200) {
+        this.logInvalidResponse(result)
+        throw this.createApiError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.body)
+      }
+      if (!result.body) {
+        throw new Exception(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`, { code: 'E_RESPONSE_NO_VALUE', status: result.status })
+      }
+      let data: AiMessageSchema
+      try {
+        data = JSON.parse(result.body)
+      } catch {
+        throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
+      }
+      if (data.kind !== AiMessageKind) {
+        throw new Exception(`${E_PREFIX}${E_RESPONSE_UNKNOWN}`, { code: 'E_RESPONSE_UNKNOWN', status: result.status })
+      }
+      return data
+    },
+  }
+}

package/src/sdk/RouteBuilder.ts

@@ -1,4 +1,7 @@
 /* eslint-disable @typescript-eslint/no-extraneous-class */
+
+import type { AiSessionApp } from '../models/AiSession.js'
+
 /**
  * A helper class to make sure routes user and reported by this service are consistent.
  */
@@ -299,4 +302,28 @@ export class RouteBuilder {
   static groupUsers(oid: string, gid: string): string {
     return `/v1/orgs/${oid}/groups/${gid}/users`
   }
+
+  static aiModifyDomain(oid: string, fid: string): string | undefined {
+    return `${this.organization(oid)}/ai/domains/${fid}/modify/stream`
+  }
+
+  static aiModifyApi(oid: string, fid: string): string | undefined {
+    return `${this.organization(oid)}/ai/apis/${fid}/modify/stream`
+  }
+
+  static aiSessions(oid: string, app: AiSessionApp): string {
+    return `${this.organization(oid)}/ai/sessions/${app}`
+  }
+
+  static aiSession(oid: string, app: AiSessionApp, sid: string): string {
+    return `${RouteBuilder.aiSessions(oid, app)}/${sid}`
+  }
+
+  static aiMessages(oid: string, sid: string): string {
+    return `${this.organization(oid)}/ai/messages/${sid}`
+  }
+
+  static aiMessage(oid: string, sid: string, mid: string): string {
+    return `${RouteBuilder.aiMessages(oid, sid)}/${mid}`
+  }
 }

package/src/sdk/Sdk.ts

@@ -12,6 +12,7 @@ import { ProjectExecutionSdk } from './ProjectExecutionsSdk.js'
 import { OrganizationsSdk } from './OrganizationsSdk.js'
 import { DataCatalogSdk } from './DataCatalogSdk.js'
 import { GroupsSdk } from './GroupsSdk.js'
+import { AiSdk } from './AiSdk.js'
 
 const baseUriSymbol = Symbol('baseUri')
 
@@ -81,6 +82,8 @@ export abstract class Sdk {
   dataCatalog = new DataCatalogSdk(this)
 
   groups = new GroupsSdk(this)
+
+  ai = new AiSdk(this)
   /**
    * When set it limits log output to minimum.
    */

package/src/sdk/SdkBase.ts

@@ -14,6 +14,10 @@ export interface SdkOptions {
    * Uses the provided token for authentication.
    */
   token?: string
+  /**
+   * The abort signal.
+   */
+  signal?: AbortSignal
 }
 
 export interface IStoreRequestOptions extends SdkOptions {