@ikatec/digisac-api-sdk 1.4.0 → 2.1.0

package/src/apis/terms/TermsApi.test.ts

@@ -0,0 +1,196 @@
+import { beforeEach, describe, expect, it, vi } from 'vitest'
+import { TermsApi } from './TermsApi'
+import type { ApiClient } from '../../core/ApiClient'
+import type { Term, CreateTermPayload } from './types'
+import type { Paginated } from '../../core/types'
+
+// ── Mock client factory ──────────────────────────────────────────────
+
+function createMockClient(): ApiClient {
+  return {
+    setAccessToken: vi.fn().mockReturnThis(),
+    request: vi.fn(),
+    get: vi.fn(),
+    post: vi.fn(),
+    put: vi.fn(),
+    patch: vi.fn(),
+    delete: vi.fn(),
+  }
+}
+
+// ── Fixtures ─────────────────────────────────────────────────────────
+
+const term: Term = {
+  id: 'term-1',
+  title: { en: 'Terms of Service' },
+  text: { en: 'You agree to...' },
+  expirationDate: '2025-01-01',
+  version: '1.0',
+  agnusId: 'agnus-1',
+  accountId: null,
+  userId: null,
+  agreementDate: null,
+  createdAt: '2024-01-01T00:00:00Z',
+  updatedAt: '2024-01-01T00:00:00Z',
+}
+
+const paginated: Paginated<Term> = {
+  data: [term],
+  total: 1,
+  limit: 10,
+  skip: 0,
+  currentPage: 1,
+  lastPage: 1,
+  from: 1,
+  to: 1,
+}
+
+// ── Tests ────────────────────────────────────────────────────────────
+
+describe('TermsApi', () => {
+  let client: ReturnType<typeof createMockClient>
+  let api: TermsApi
+
+  beforeEach(() => {
+    client = createMockClient()
+    api = new TermsApi(client)
+  })
+
+  // ── getMany ──────────────────────────────────────────────────────
+
+  describe('getMany', () => {
+    it('calls client.get with /terms when no query is provided', async () => {
+      vi.mocked(client.get).mockResolvedValue(paginated)
+      const result = await api.getMany()
+      expect(client.get).toHaveBeenCalledWith('/terms', undefined)
+      expect(result).toEqual(paginated)
+    })
+
+    it('serializes query parameters', async () => {
+      vi.mocked(client.get).mockResolvedValue(paginated)
+      await api.getMany({ page: 2 })
+      const url = vi.mocked(client.get).mock.calls[0][0] as string
+      expect(url).toContain('/terms?')
+      expect(url).toContain('page=2')
+    })
+
+    it('forwards custom headers', async () => {
+      vi.mocked(client.get).mockResolvedValue(paginated)
+      const headers = { 'X-Custom': 'value' }
+      await api.getMany(undefined, headers)
+      expect(client.get).toHaveBeenCalledWith('/terms', headers)
+    })
+  })
+
+  // ── getById ──────────────────────────────────────────────────────
+
+  describe('getById', () => {
+    it('calls client.get with /terms/:id', async () => {
+      vi.mocked(client.get).mockResolvedValue(term)
+      const result = await api.getById('term-1')
+      expect(client.get).toHaveBeenCalledWith('/terms/term-1', undefined)
+      expect(result).toEqual(term)
+    })
+
+    it('forwards custom headers', async () => {
+      vi.mocked(client.get).mockResolvedValue(term)
+      const headers = { 'X-Tenant': 'abc' }
+      await api.getById('term-1', undefined, headers)
+      expect(client.get).toHaveBeenCalledWith('/terms/term-1', headers)
+    })
+  })
+
+  // ── create ───────────────────────────────────────────────────────
+
+  describe('create', () => {
+    it('calls client.post with /terms and body', async () => {
+      vi.mocked(client.post).mockResolvedValue(term)
+      const body: CreateTermPayload = {
+        title: { en: 'ToS' },
+        text: { en: 'Text' },
+        expirationDate: '2025-01-01',
+        version: '1.0',
+        agnusId: 'agnus-1',
+      }
+      const result = await api.create(body)
+      expect(client.post).toHaveBeenCalledWith('/terms', body, undefined)
+      expect(result).toEqual(term)
+    })
+  })
+
+  // ── updateById ───────────────────────────────────────────────────
+
+  describe('updateById', () => {
+    it('calls client.put with /terms/:id and body', async () => {
+      vi.mocked(client.put).mockResolvedValue(term)
+      const result = await api.updateById('term-1', { version: '1.1' })
+      expect(client.put).toHaveBeenCalledWith('/terms/term-1', { version: '1.1' }, undefined)
+      expect(result).toEqual(term)
+    })
+
+    it('forwards custom headers', async () => {
+      vi.mocked(client.put).mockResolvedValue(term)
+      const headers = { 'If-Match': 'etag' }
+      await api.updateById('term-1', { version: '2.0' }, headers)
+      expect(client.put).toHaveBeenCalledWith('/terms/term-1', { version: '2.0' }, headers)
+    })
+  })
+
+  // ── deleteById ───────────────────────────────────────────────────
+
+  describe('deleteById', () => {
+    it('calls client.delete with /terms/:id', async () => {
+      vi.mocked(client.delete).mockResolvedValue(term)
+      const result = await api.deleteById('term-1')
+      expect(client.delete).toHaveBeenCalledWith('/terms/term-1', undefined)
+      expect(result).toEqual(term)
+    })
+
+    it('forwards custom headers', async () => {
+      vi.mocked(client.delete).mockResolvedValue(term)
+      const headers = { 'X-Reason': 'cleanup' }
+      await api.deleteById('term-1', headers)
+      expect(client.delete).toHaveBeenCalledWith('/terms/term-1', headers)
+    })
+  })
+
+  // ── getNotAgreed ─────────────────────────────────────────────────
+
+  describe('getNotAgreed', () => {
+    it('calls client.get with /terms/terms-not-agreed when no query is provided', async () => {
+      vi.mocked(client.get).mockResolvedValue(paginated)
+      const result = await api.getNotAgreed()
+      expect(client.get).toHaveBeenCalledWith('/terms/terms-not-agreed', undefined)
+      expect(result).toEqual(paginated)
+    })
+
+    it('serializes query parameters', async () => {
+      vi.mocked(client.get).mockResolvedValue(paginated)
+      await api.getNotAgreed({ page: 1, perPage: 5 })
+      const url = vi.mocked(client.get).mock.calls[0][0] as string
+      expect(url).toContain('/terms/terms-not-agreed?')
+      expect(url).toContain('page=1')
+    })
+
+    it('forwards custom headers', async () => {
+      vi.mocked(client.get).mockResolvedValue(paginated)
+      const headers = { 'X-Custom': 'h' }
+      await api.getNotAgreed(undefined, headers)
+      expect(client.get).toHaveBeenCalledWith('/terms/terms-not-agreed', headers)
+    })
+  })
+
+  // ── Error propagation ────────────────────────────────────────────
+
+  describe('error propagation', () => {
+    it('propagates errors from getMany', async () => {
+      vi.mocked(client.get).mockRejectedValue(new Error('Network error'))
+      await expect(api.getMany()).rejects.toThrow('Network error')
+    })
+
+    it('propagates errors from getNotAgreed', async () => {
+      vi.mocked(client.get).mockRejectedValue(new Error('Forbidden'))
+      await expect(api.getNotAgreed()).rejects.toThrow('Forbidden')
+    })
+  })
+})

package/src/apis/transcripts/TranscriptsApi.test.ts

@@ -0,0 +1,63 @@
+import { beforeEach, describe, expect, it, vi } from 'vitest'
+import { TranscriptsApi } from './TranscriptsApi'
+import type { ApiClient } from '../../core/ApiClient'
+import type { TranscriptResponse } from './types'
+
+// ── Mock client factory ──────────────────────────────────────────────
+
+function createMockClient(): ApiClient {
+  return {
+    setAccessToken: vi.fn().mockReturnThis(),
+    request: vi.fn(),
+    get: vi.fn(),
+    post: vi.fn(),
+    put: vi.fn(),
+    patch: vi.fn(),
+    delete: vi.fn(),
+  }
+}
+
+// ── Tests ────────────────────────────────────────────────────────────
+
+describe('TranscriptsApi', () => {
+  let client: ReturnType<typeof createMockClient>
+  let api: TranscriptsApi
+
+  beforeEach(() => {
+    client = createMockClient()
+    api = new TranscriptsApi(client)
+  })
+
+  // ── getById ──────────────────────────────────────────────────────
+
+  describe('getById', () => {
+    it('calls client.get with /transcripts/:id', async () => {
+      const response: TranscriptResponse = {
+        id: 'msg-1',
+        isTranscribing: true,
+        transcribeError: false,
+      }
+      vi.mocked(client.get).mockResolvedValue(response)
+      const result = await api.getById('msg-1')
+      expect(client.get).toHaveBeenCalledWith('/transcripts/msg-1', undefined)
+      expect(result).toEqual(response)
+    })
+
+    it('forwards custom headers', async () => {
+      const response: TranscriptResponse = {
+        id: 'msg-2',
+        isTranscribing: false,
+        transcribeError: true,
+      }
+      vi.mocked(client.get).mockResolvedValue(response)
+      const headers = { 'X-Custom': 'h' }
+      await api.getById('msg-2', headers)
+      expect(client.get).toHaveBeenCalledWith('/transcripts/msg-2', headers)
+    })
+
+    it('propagates errors from client.get', async () => {
+      vi.mocked(client.get).mockRejectedValue(new Error('Not found'))
+      await expect(api.getById('missing')).rejects.toThrow('Not found')
+    })
+  })
+})

package/src/core/BaseCrudApi.test.ts

@@ -147,7 +147,7 @@ describe('BaseCrudApi', () => {
       vi.mocked(client.get).mockResolvedValue({ id: '1', name: 'x' })
       const headers = { 'X-Tenant': '123' }
 
-      await api.getById('1', headers)
+      await api.getById('1', undefined, headers)
       expect(client.get).toHaveBeenCalledWith('/items/1', headers)
     })
   })

package/src/core/BaseCrudApi.ts

@@ -1,10 +1,11 @@
 import qs from 'qs'
 import type { ApiClient } from './ApiClient'
-import type { CrudApi, ListQuery, Paginated } from './types'
+import type { CrudApi, GetByIdQuery, ListQuery, Paginated } from './types'
 export type {
   WhereClause,
   IncludeItem,
   ListQuery,
+  GetByIdQuery,
   Paginated,
   HasGetMany,
   HasGetById,
@@ -20,12 +21,17 @@ export class BaseCrudApi<
   TUpdate = TCreate,
   TQuery extends ListQuery<TResponse> = ListQuery<TResponse>,
 > implements CrudApi<TResponse, TCreate, TUpdate, TQuery> {
-  protected readonly client: ApiClient
-  protected readonly basePath: string
+  public readonly client: ApiClient
+  public readonly basePath: string
 
   constructor(client: ApiClient, basePath: string) {
     this.client = client
     this.basePath = basePath.replace(/\/$/, '')
+    this.getMany = this.getMany.bind(this)
+    this.getById = this.getById.bind(this)
+    this.create = this.create.bind(this)
+    this.updateById = this.updateById.bind(this)
+    this.deleteById = this.deleteById.bind(this)
   }
 
   getMany(
@@ -51,8 +57,13 @@ export class BaseCrudApi<
    * Returns a single resource by ID.
    * @permissions $resourceName.view
    */
-  getById(id: string, headers?: Record<string, string>): Promise<TResponse> {
-    return this.client.get<TResponse>(`${this.basePath}/${id}`, headers)
+  getById(
+    id: string,
+    query?: GetByIdQuery<TResponse>,
+    headers?: Record<string, string>,
+  ): Promise<TResponse> {
+    const queryString = query ? `?${qs.stringify(query)}` : ''
+    return this.client.get<TResponse>(`${this.basePath}/${id}${queryString}`, headers)
   }
 
   /**

package/src/core/index.ts

@@ -2,4 +2,4 @@ export type { ApiClient, HttpMethod } from './ApiClient'
 export { BaseApiClient, ApiError } from './BaseApiClient'
 export type { ValidationError } from './BaseApiClient'
 export { BaseCrudApi } from './BaseCrudApi'
-export type { WhereClause, IncludeItem, ListQuery, Paginated } from './types'
+export type { WhereClause, IncludeItem, ListQuery, GetByIdQuery, Paginated } from './types'

package/src/core/types.ts

@@ -74,6 +74,7 @@ type TypedIncludeObject<T> = {
   [K in AssociationKeys<T>]: {
     model: K
     as?: string
+    attributes?: (keyof Unwrap<T[K]> & string)[]
     include?: IncludeItem<Unwrap<T[K]>>[]
     required?: boolean
     where?: WhereClause<Unwrap<T[K]>>
@@ -126,8 +127,14 @@ export interface HasGetMany<TResponse, TQuery extends ListQuery<TResponse> = Lis
   ): Promise<Paginated<TResponse>>
 }
 
+export type GetByIdQuery<T = Record<string, unknown>> = Pick<ListQuery<T>, 'include' | 'attributes'>
+
 export interface HasGetById<TResponse> {
-  getById(id: string, headers?: Record<string, string>): Promise<TResponse>
+  getById(
+    id: string,
+    query?: GetByIdQuery<TResponse>,
+    headers?: Record<string, string>,
+  ): Promise<TResponse>
 }
 
 export interface HasCreate<TResponse, TCreate> {