@api-client/core 0.19.1 → 0.19.2

package/src/sdk/SdkMock.ts

@@ -25,6 +25,8 @@ import type { DataCatalogVersionSchema } from '../models/DataCatalogVersion.js'
 import { DataDomain, type DataDomainSchema } from '../modeling/DataDomain.js'
 import type { ForeignDomainDependency } from '../modeling/types.js'
 import { nanoid } from '../nanoid.js'
+import type { AiSessionSchema, AiSessionApp } from '../models/AiSession.js'
+import type { AiMessageSchema } from '../models/AiMessage.js'
 
 export interface MockResult {
   /**
@@ -770,6 +772,189 @@ export class SdkMock {
     },
   }
 
+  ai = {
+    sessions: {
+      list: async (init?: MockListResult, options?: InterceptOptions): Promise<void> => {
+        const { mock } = this
+        const respond = this.createDefaultResponse(
+          200,
+          { 'content-type': 'application/json' },
+          () => {
+            const obj: ContextListResult<AiSessionSchema> = {
+              items: this.gen.ai.sessions('general', init?.size ?? 5),
+              cursor: this.createCursorOption(init),
+            }
+            return JSON.stringify(obj)
+          },
+          init
+        )
+        await mock.add(
+          {
+            match: {
+              uri: RouteBuilder.aiSessions(':oid', ':app' as AiSessionApp),
+              methods: ['GET'],
+            },
+            respond,
+          },
+          options
+        )
+      },
+      create: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
+        const { mock } = this
+        const respond = this.createDefaultResponse(
+          201,
+          { 'content-type': 'application/json' },
+          () => JSON.stringify(this.gen.ai.session()),
+          init
+        )
+        await mock.add(
+          {
+            match: {
+              uri: RouteBuilder.aiSessions(':oid', ':app' as AiSessionApp),
+              methods: ['POST'],
+            },
+            respond,
+          },
+          options
+        )
+      },
+      read: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
+        const { mock } = this
+        const respond = this.createDefaultResponse(
+          200,
+          { 'content-type': 'application/json' },
+          () => JSON.stringify(this.gen.ai.session()),
+          init
+        )
+        await mock.add(
+          {
+            match: {
+              uri: RouteBuilder.aiSession(':oid', ':app' as AiSessionApp, ':sid'),
+              methods: ['GET'],
+            },
+            respond,
+          },
+          options
+        )
+      },
+      update: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
+        const { mock } = this
+        const respond = this.createDefaultResponse(
+          200,
+          { 'content-type': 'application/json' },
+          () => JSON.stringify(this.gen.ai.session()),
+          init
+        )
+        await mock.add(
+          {
+            match: {
+              uri: RouteBuilder.aiSession(':oid', ':app' as AiSessionApp, ':sid'),
+              methods: ['PUT'],
+            },
+            respond,
+          },
+          options
+        )
+      },
+      delete: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
+        const { mock } = this
+        const respond = this.createDefaultResponse(204, undefined, undefined, init)
+        await mock.add(
+          {
+            match: {
+              uri: RouteBuilder.aiSession(':oid', ':app' as AiSessionApp, ':sid'),
+              methods: ['DELETE'],
+            },
+            respond,
+          },
+          options
+        )
+      },
+    },
+
+    messages: {
+      list: async (init?: MockListResult, options?: InterceptOptions): Promise<void> => {
+        const { mock } = this
+        const respond = this.createDefaultResponse(
+          200,
+          { 'content-type': 'application/json' },
+          () => {
+            const obj: ContextListResult<AiMessageSchema> = {
+              items: this.gen.ai.messages(init?.size ?? 5),
+              cursor: this.createCursorOption(init),
+            }
+            return JSON.stringify(obj)
+          },
+          init
+        )
+        await mock.add(
+          {
+            match: {
+              uri: RouteBuilder.aiMessages(':oid', ':sid'),
+              methods: ['GET'],
+            },
+            respond,
+          },
+          options
+        )
+      },
+      update: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
+        const { mock } = this
+        const respond = this.createDefaultResponse(
+          200,
+          { 'content-type': 'application/json' },
+          () => JSON.stringify(this.gen.ai.message()),
+          init
+        )
+        await mock.add(
+          {
+            match: {
+              uri: RouteBuilder.aiMessage(':oid', ':sid', ':mid'),
+              methods: ['PUT'],
+            },
+            respond,
+          },
+          options
+        )
+      },
+      delete: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
+        const { mock } = this
+        const respond = this.createDefaultResponse(204, undefined, undefined, init)
+        await mock.add(
+          {
+            match: {
+              uri: RouteBuilder.aiMessage(':oid', ':sid', ':mid'),
+              methods: ['DELETE'],
+            },
+            respond,
+          },
+          options
+        )
+      },
+    },
+
+    modifyDomain: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
+      const { mock } = this
+      // Return a basic JSON response simulating the stream end state for simplicity if not overriding.
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'text/event-stream' },
+        () => 'event: done\ndata: {}\n\n',
+        init
+      )
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.aiModifyDomain(':oid', ':fid') as string,
+            methods: ['POST'],
+          },
+          respond,
+        },
+        options
+      )
+    },
+  }
+
   /**
    * User API mocks.
    */

package/tests/unit/mocking/current/Ai.spec.ts

@@ -0,0 +1,109 @@
+import { test } from '@japa/runner'
+import { Ai } from '../../../../src/mocking/lib/Ai.js'
+import { AiSessionKind, AiMessageKind } from '../../../../src/models/kinds.js'
+import type { AiSessionSchema } from '../../../../src/models/AiSession.js'
+import type { AiMessageSchema } from '../../../../src/models/AiMessage.js'
+
+test.group('Ai Mock Generator', (group) => {
+  let aiMock: Ai
+
+  group.each.setup(() => {
+    aiMock = new Ai()
+  })
+
+  test('session() returns a valid AiSession object', ({ assert }) => {
+    const result = aiMock.session()
+    assert.typeOf(result, 'object')
+    assert.equal(result.kind, AiSessionKind)
+    assert.equal(result.app, 'general')
+    assert.property(result, 'key')
+    assert.property(result, 'title')
+    assert.property(result, 'pinned')
+    assert.property(result, 'userRenamed')
+    assert.property(result, 'createdAt')
+    assert.property(result, 'updatedAt')
+  })
+
+  test('session(app, init) allows overriding properties', ({ assert }) => {
+    const init: Partial<AiSessionSchema> = {
+      title: 'Custom Title',
+      pinned: true,
+      app: 'domain',
+    }
+    const result = aiMock.session('domain', init)
+    assert.equal(result.app, 'domain')
+    assert.equal(result.title, 'Custom Title')
+    assert.isTrue(result.pinned)
+  })
+
+  test('sessions() returns a list defined by default size', ({ assert }) => {
+    const result = aiMock.sessions()
+    assert.isArray(result)
+    assert.lengthOf(result, 5)
+    result.forEach((item) => {
+      assert.equal(item.app, 'general')
+    })
+  })
+
+  test('sessions(app, size) overrides settings', ({ assert }) => {
+    const result = aiMock.sessions('api', 3)
+    assert.lengthOf(result, 3)
+    result.forEach((item) => {
+      assert.equal(item.app, 'api')
+    })
+  })
+
+  test("message('user') returns a valid AiUserMessage object", ({ assert }) => {
+    const result = aiMock.message('user')
+    assert.typeOf(result, 'object')
+    assert.equal(result.kind, AiMessageKind)
+    assert.equal(result.role, 'user')
+    assert.property(result, 'key')
+    assert.property(result, 'session')
+    assert.property(result, 'text')
+    assert.equal(result.state, 'complete')
+    assert.property(result, 'createdAt')
+    assert.property(result, 'updatedAt')
+  })
+
+  test("message('model') returns a valid AiModelMessage object", ({ assert }) => {
+    const result = aiMock.message('model')
+    assert.typeOf(result, 'object')
+    assert.equal(result.kind, AiMessageKind)
+    assert.equal(result.role, 'model')
+    assert.property(result, 'key')
+    assert.property(result, 'session')
+    assert.property(result, 'text')
+    assert.property(result, 'state')
+    assert.property(result, 'applied')
+    assert.property(result, 'thoughts')
+  })
+
+  test('message(role, init) allows overriding properties', ({ assert }) => {
+    const init: Partial<AiMessageSchema> = {
+      text: 'Custom Text',
+      session: 'session-123',
+    }
+    const result = aiMock.message('user', init)
+    assert.equal(result.text, 'Custom Text')
+    assert.equal(result.session, 'session-123')
+  })
+
+  test('messages() returns a list of mixed messages', ({ assert }) => {
+    const result = aiMock.messages(5)
+    assert.isArray(result)
+    assert.lengthOf(result, 5)
+    result.forEach((item) => {
+      assert.include(['user', 'model'], item.role)
+    })
+  })
+
+  test('messages(size, session) groups messages by session', ({ assert }) => {
+    const sessionId = 'test-session-id'
+    const result = aiMock.messages(3, sessionId)
+    assert.lengthOf(result, 3)
+    result.forEach((item) => {
+      assert.equal(item.session, sessionId)
+    })
+  })
+})