task: add download artifacts method (#70)

* npmtask: add download artifacts method

* increase test coverage

* increase test coverage

Author: na66im

ATTRIBUTIONS.md

@@ -22320,6 +22320,25 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 
 ---
 
+## is-network-error
+
+**Version:** 1.3.1  
+**License:** MIT
+
+```
+MIT License
+
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+```
+
+---
+
 ## is-node-process
 
 **Version:** 1.2.0  
@@ -27227,6 +27246,25 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 
 ---
 
+## p-retry
+
+**Version:** 8.0.0  
+**License:** MIT
+
+```
+MIT License
+
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+```
+
+---
+
 ## p-try
 
 **Version:** 2.2.0  

package-lock.json

@@ -45,6 +45,7 @@
   "license": "MIT",
   "dependencies": {
     "axios": "^1.12.2",
+    "p-retry": "^8.0.0",
     "zod": "^4.0.17"
   },
   "engines": {

packages/sdk/package.json

@@ -14,6 +14,7 @@ function buildItem(
     termination_reason: overrides.termination_reason ?? undefined,
     error_code: null,
     error_message: null,
+    input_artifacts: [],
     output_artifacts: [],
   } as ItemResultReadResponse;
 }

packages/sdk/src/entities/run-item/process-run-item.spec.ts

@@ -1,7 +1,8 @@
 import { describe, it, expect, beforeEach, vi } from 'vitest';
+import { http, HttpResponse } from 'msw';
 import { PlatformSDKHttp } from './platform-sdk.js';
-import { AuthenticationError } from './errors.js';
-import { setMockScenario } from './test-utils/http-mocks.js';
+import { APIError, AuthenticationError } from './errors.js';
+import { setMockScenario, server } from './test-utils/http-mocks.js';
 import { ItemState, ItemTerminationReason } from './generated/api.js';
 
 describe('PlatformSDK', () => {
@@ -525,7 +526,6 @@ describe('PlatformSDK', () => {
         items: [],
       })
     ).rejects.toThrow(errorMessage);
-
     await expect(sdk.getRun('test-run-id')).rejects.toThrow(AuthenticationError);
     await expect(sdk.getRun('test-run-id')).rejects.toThrow(errorMessage);
 
@@ -535,4 +535,103 @@ describe('PlatformSDK', () => {
     await expect(sdk.listRunResults('test-run-id')).rejects.toThrow(AuthenticationError);
     await expect(sdk.listRunResults('test-run-id')).rejects.toThrow(errorMessage);
   });
+
+  it('should download artifact successfully', async () => {
+    mockTokenProvider.mockResolvedValue('mocked-token');
+    setMockScenario('success');
+
+    const result = await sdk.downloadArtifact('test-run-id', 'test-artifact-id');
+    expect(result).toBeDefined();
+    expect(result.byteLength).toBe(8);
+  });
+
+  it('should handle download artifact failure', async () => {
+    mockTokenProvider.mockResolvedValue('mocked-token');
+    setMockScenario('notFoundError');
+
+    await expect(sdk.downloadArtifact('test-run-id', 'test-artifact-id')).rejects.toThrow(
+      'Resource not found: '
+    );
+  });
+
+  it('should handle no token for download artifact', async () => {
+    mockTokenProvider.mockResolvedValue(null);
+
+    await expect(sdk.downloadArtifact('test-run-id', 'test-artifact-id')).rejects.toThrow(
+      AuthenticationError
+    );
+  });
+
+  it('should retry on transient 500 error and succeed on second attempt', async () => {
+    mockTokenProvider.mockResolvedValue('mocked-token');
+
+    let callCount = 0;
+    server.use(
+      http.get('*/v1/runs/:runId/artifacts/:artifactId/file', () => {
+        callCount++;
+        if (callCount === 1) {
+          return HttpResponse.json({}, { status: 500 });
+        }
+        return new HttpResponse(new ArrayBuffer(8), {
+          status: 200,
+          headers: { 'Content-Type': 'application/octet-stream' },
+        });
+      })
+    );
+
+    const result = await sdk.downloadArtifact('test-run-id', 'test-artifact-id');
+    expect(result.byteLength).toBe(8);
+    expect(callCount).toBe(2);
+  }, 10_000);
+
+  it('should not retry on 404 and make exactly one request', async () => {
+    mockTokenProvider.mockResolvedValue('mocked-token');
+
+    let callCount = 0;
+    server.use(
+      http.get('*/v1/runs/:runId/artifacts/:artifactId/file', () => {
+        callCount++;
+        return HttpResponse.json({}, { status: 404 });
+      })
+    );
+
+    await expect(sdk.downloadArtifact('test-run-id', 'test-artifact-id')).rejects.toThrow(
+      'Resource not found:'
+    );
+    expect(callCount).toBe(1);
+  });
+
+  it('should throw APIError with 422 status when validation error occurs', async () => {
+    mockTokenProvider.mockResolvedValue('mocked-token');
+    setMockScenario('validationError');
+
+    await expect(sdk.listApplications()).rejects.toThrow(APIError);
+    await expect(sdk.listApplications()).rejects.toThrow('Validation error:');
+  });
+
+  it('should throw APIError with 403 status when access is forbidden', async () => {
+    mockTokenProvider.mockResolvedValue('mocked-token');
+
+    server.use(
+      http.get('*/v1/applications', () => {
+        return HttpResponse.json({ detail: 'Forbidden' }, { status: 403 });
+      })
+    );
+
+    await expect(sdk.listApplications()).rejects.toThrow(APIError);
+    await expect(sdk.listApplications()).rejects.toThrow('Access forbidden:');
+  });
+
+  it('should throw APIError with 410 status when resource is gone', async () => {
+    mockTokenProvider.mockResolvedValue('mocked-token');
+
+    server.use(
+      http.get('*/v1/runs/:runId', () => {
+        return HttpResponse.json({ detail: 'Gone' }, { status: 410 });
+      })
+    );
+
+    await expect(sdk.getRun('test-run-id')).rejects.toThrow(APIError);
+    await expect(sdk.getRun('test-run-id')).rejects.toThrow('Resource gone:');
+  });
 });

packages/sdk/src/platform-sdk.test.ts

@@ -16,6 +16,7 @@ import { processApplicationRun } from './entities/application-run/process-applic
 import { ApplicationRun } from './entities/application-run/types.js';
 import { processRunItem } from './entities/run-item/process-run-item.js';
 import { ApplicationRunItem } from './entities/run-item/types.js';
+import { downloadWithRetry } from './utils/downloadWithRetry.js';
 
 const validationErrorSchema = z.object({
   detail: z.array(
@@ -50,6 +51,24 @@ function handleRequestError(error: unknown): never {
           statusCode: 404,
         });
       }
+      case 403: {
+        throw new APIError(`Access forbidden: ${error.message}`, {
+          context: {
+            responseBody: errorResponseSchema.parse(error.response?.data),
+          },
+          originalError: error,
+          statusCode: 403,
+        });
+      }
+      case 410: {
+        throw new APIError(`Resource gone: ${error.message}`, {
+          context: {
+            responseBody: errorResponseSchema.parse(error.response?.data),
+          },
+          originalError: error,
+          statusCode: 410,
+        });
+      }
       default: {
         throw new APIError(`API request failed: ${error.message}`, {
           context: {
@@ -121,6 +140,7 @@ export interface PlatformSDK {
     applicationId: string,
     version: string
   ): Promise<VersionReadResponse>;
+  downloadArtifact(runId: string, artifactId: string): Promise<ArrayBuffer>;
 }
 /**
  * Main SDK class for interacting with the Aignostics Platform
@@ -615,4 +635,58 @@ export class PlatformSDKHttp implements PlatformSDK {
   getConfig(): PlatformSDKConfig {
     return { ...this.#config };
   }
+
+  /**
+   * Download an artifact file from a completed application run
+   *
+   * This method retrieves the binary content of a specific artifact produced
+   * during an application run. Artifacts can include generated reports, processed
+   * images, or other output files from the AI model execution.
+   *
+   * The download is performed with automatic retries for transient failures.
+   * Non-retryable HTTP status codes (403, 404, 410, 422) will abort immediately.
+   *
+   * @param runId - The unique identifier of the application run
+   * @param artifactId - The unique identifier of the artifact to download
+   * @returns A promise that resolves to an ArrayBuffer containing the artifact's binary content
+   * @throws {AuthenticationError} If no valid authentication token is available
+   * @throws {APIError} If the API request fails (e.g., 403, 404, 410, 422, or other HTTP errors)
+   * @throws {UnexpectedError} If a non-HTTP error occurs
+   *
+   * @example
+   * ```typescript
+   * const sdk = new PlatformSDKHttp({ tokenProvider: () => 'your-token' });
+   *
+   * try {
+   *   const buffer = await sdk.downloadArtifact('run-123', 'artifact-456');
+   *   console.log(`Downloaded ${buffer.byteLength} bytes`);
+   *
+   *   // Write to file (Node.js)
+   *   fs.writeFileSync('output.bin', Buffer.from(buffer));
+   * } catch (error) {
+   *   console.error('Failed to download artifact:', error.message);
+   * }
+   * ```
+   */
+  async downloadArtifact(runId: string, artifactId: string): Promise<ArrayBuffer> {
+    const client = await this.#getClient();
+    try {
+      const response = await downloadWithRetry(
+        () =>
+          client.getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(
+            {
+              runId,
+              artifactId,
+            },
+            {
+              responseType: 'arraybuffer',
+            }
+          ),
+        [403, 404, 410, 422]
+      );
+      return response.data as ArrayBuffer;
+    } catch (error) {
+      handleRequestError(error);
+    }
+  }
 }