@ikatec/digisac-api-sdk 2.1.1 → 2.2.0

package/src/core/BaseCrudApi.test.ts

@@ -131,6 +131,37 @@ describe('BaseCrudApi', () => {
     })
   })
 
+  // ── getOne ───────────────────────────────────────────────────────
+
+  describe('getOne', () => {
+    it('requests limit 1 (non-paginated) and returns the first item', async () => {
+      const item: Item = { id: '1', name: 'Test' }
+      vi.mocked(client.get).mockResolvedValue([item])
+
+      const result = await api.getOne()
+      const calledUrl = vi.mocked(client.get).mock.calls.at(0)?.at(0) as string
+      expect(calledUrl).toContain('/items?')
+      expect(calledUrl).toContain('limit=1')
+      expect(calledUrl).toContain('paginate=false')
+      expect(result).toEqual(item)
+    })
+
+    it('returns null when no records match', async () => {
+      vi.mocked(client.get).mockResolvedValue([])
+
+      const result = await api.getOne({ where: { name: 'missing' } })
+      expect(result).toBeNull()
+    })
+
+    it('forwards custom headers', async () => {
+      vi.mocked(client.get).mockResolvedValue([])
+      const headers = { 'X-Custom': 'value' }
+
+      await api.getOne(undefined, headers)
+      expect(vi.mocked(client.get).mock.calls.at(0)?.at(1)).toEqual(headers)
+    })
+  })
+
   // ── getById ──────────────────────────────────────────────────────
 
   describe('getById', () => {

package/src/core/BaseCrudApi.ts

@@ -28,6 +28,7 @@ export class BaseCrudApi<
     this.client = client
     this.basePath = basePath.replace(/\/$/, '')
     this.getMany = this.getMany.bind(this)
+    this.getOne = this.getOne.bind(this)
     this.getById = this.getById.bind(this)
     this.create = this.create.bind(this)
     this.updateById = this.updateById.bind(this)
@@ -53,6 +54,19 @@ export class BaseCrudApi<
     )
   }
 
+  /**
+   * Returns the first resource matching the query, or `null` when none match.
+   * Convenience over `getMany` with `limit: 1`.
+   * @permissions $resourceName.view
+   */
+  async getOne(query?: TQuery, headers?: Record<string, string>): Promise<TResponse | null> {
+    const results = await this.getMany(
+      { ...query, limit: 1, paginate: false } as TQuery & { paginate: false },
+      headers,
+    )
+    return results[0] ?? null
+  }
+
   /**
    * Returns a single resource by ID.
    * @permissions $resourceName.view

package/src/core/index.ts

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