@algebrakit/sdk 1.0.0 → 1.1.0

package/README.md

@@ -1,142 +1,140 @@
-# Algebrakit Webservice API SDK
+# Algebrakit SDK for Node.js and TypeScript
 
-Official Node.js/TypeScript SDK for the Algebrakit Webservice API. It provides methods for creating sessions, retrieving scores, locking/unlocking sessions, and fetching session information.
+[![npm](https://img.shields.io/npm/v/@algebrakit/sdk)](https://www.npmjs.com/package/@algebrakit/sdk)
+[![CI](https://github.com/algebrakit/sdk-typescript/actions/workflows/ci.yml/badge.svg)](https://github.com/algebrakit/sdk-typescript/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
 
-## Installation
+The official server-side SDK for the [Algebrakit](https://algebrakit.com) API. Your server uses it to create exercise sessions, get scores and manage sessions. Students then work on the exercises in your web page, through the Algebrakit widget.
+
+For how Algebrakit works, the full API reference and the widget's options, see the [Algebrakit documentation](https://docs.algebrakit.com/).
+
+> **Want to see it working first?** [algebrakit-examples](https://github.com/algebrakit/algebrakit-examples/tree/main/minimal/typescript) has a small web app built on this SDK that runs on localhost in a few minutes.
+
+## Before you start
+
+- Node.js 18 or newer.
+- An Algebrakit API key. Don't have one yet? [Contact Algebrakit](https://algebrakit.com/contact-us).
+
+Keep the API key on your server. Never send it to the browser.
+
+## Install
 
 ```bash
 npm install @algebrakit/sdk
 ```
 
-Requires Node.js 18 or newer.
-
-## Usage
+## Quick start
 
-### Initialize the API Client
+Create a client and a session for an exercise:
 
 ```typescript
 import { ApiClient } from '@algebrakit/sdk';
 
-const apiClient = new ApiClient('https://api.algebrakit.com', 'your-api-key');
-```
-
-### Create a Session
+const client = new ApiClient({ apiKey: process.env.ALGEBRAKIT_API_KEY! });
 
-```typescript
-import { CreateSessionRequest } from '@algebrakit/sdk';
-
-const request: CreateSessionRequest = {
-  exercises: [
-    { exerciseId: 'fa42e943-8213-41a6-8a91-8c22a929ffe9', version: 'latest' },
-  ],
-  apiVersion: 2,
-};
-
-apiClient.createSession(request).then(response => {
-  console.log('Session created:', response);
-}).catch(error => {
-  console.error('Error creating session:', error);
+const [result] = await client.createSession({
+  exercises: [{ exerciseId: 'fa42e943-8213-41a6-8a91-8c22a929ffe9' }],
 });
+const sessionId = result.sessions[0].sessionId;
 ```
 
-### Retrieve Session Scores
+A session holds one student's work on one exercise. Store its ID with the student, so they can continue later and you can get their score.
 
-```typescript
-import { SessionScoreRequest } from '@algebrakit/sdk';
+### Show the session to a student
 
-const request: SessionScoreRequest = {
-  sessionId: '0a405901-8b89-4665-9ea0-6dbdff3602fc',
-  lockSession: true,
-};
+In your web page, the Algebrakit widget shows the session:
 
-apiClient.getSessionScore(request).then(response => {
-  console.log('Session scores:', response);
-}).catch(error => {
-  console.error('Error retrieving scores:', error);
-});
+```html
+<script>
+  AlgebraKIT = { config: { proxy: { url: '/proxy/algebrakit' } } };
+</script>
+<script src="https://widgets.algebrakit.com"></script>
+
+<akit-exercise session-id="SESSION_ID"></akit-exercise>
 ```
 
-### Lock or Unlock Sessions
+The widget sends its API calls to `/proxy/algebrakit/*` on your server. Your server adds the API key and forwards them to the Algebrakit API. The [minimal TypeScript example](https://github.com/algebrakit/algebrakit-examples/tree/main/minimal/typescript) implements all of this; for production, see [Proxy setup](https://docs.algebrakit.com/pages/420-proxy-setup/).
 
-```typescript
-import { SessionLockRequest } from '@algebrakit/sdk';
+## API
 
-const request: SessionLockRequest = {
-  action: 'LOCK',
-  sessionIds: ['f2f62104-3b5a-4156-aeaf-291167e5f9e3'],
-};
+Every method takes one request object and returns a promise. The request and response types are exported, for example `CreateSessionRequest` and `SessionScoreResponse`.
 
-apiClient.lockSession(request).then(response => {
-  console.log('Session locked:', response);
-}).catch(error => {
-  console.error('Error locking session:', error);
-});
-```
+| Method | Endpoint | What it does |
+|---|---|---|
+| `createSession` | `POST /session/create` | Create sessions for one or more exercises: by `exerciseId`, by `exerciseSpec` (an exercise defined in code) or by `sessionId` (a copy of an existing session's exercise) |
+| `getSessionScore` | `POST /session/score` | Get a session's score, and optionally lock it |
+| `getSessionInfo` | `POST /session/info` | Get a session's details: its elements, the student's work and the scoring |
+| `lockSession` | `POST /sessions/lock` | `LOCK`, `UNLOCK` or `FINALIZE` sessions |
+| `retrieveSession` | `POST /session/retrieve` | Get existing sessions by ID |
+| `validateExercise` | `POST /exercise/validate` | Check an exercise ID or specification before you use it |
+| `getExercisePublishedInfo` | `POST /exercise/published-info` | Get the published versions and structure of an exercise |
 
-### Retrieve Session Information
+### Get the score
 
 ```typescript
-import { SessionInfoRequest } from '@algebrakit/sdk';
-
-const request: SessionInfoRequest = {
-  sessionId: '0a405901-8b89-4665-9ea0-6dbdff3602fc',
-};
-
-apiClient.getSessionInfo(request).then(response => {
-  console.log('Session info:', response);
-}).catch(error => {
-  console.error('Error retrieving session info:', error);
-});
+const { scoring } = await client.getSessionScore({ sessionId, lockSession: true });
+console.log(`${scoring.marksEarned} of ${scoring.marksTotal} marks`);
 ```
 
-## Running the Demos
+### Lock a session
 
-Each demo lives in its own folder under `demo/` with its own configuration.
+```typescript
+await client.lockSession({ action: 'LOCK', sessionIds: [sessionId] });
+```
 
-### CLI Demo (`demo/cli/`)
+## Configuration
 
-Demonstrates SDK API calls with text output.
+```typescript
+const client = new ApiClient({
+  apiKey: process.env.ALGEBRAKIT_API_KEY!,
+  baseUrl: 'https://prod.api.sg-1.algebrakit.com', // optional, see the regions below
+  timeout: 10_000, // optional, in milliseconds; the default is 30000
+});
+```
 
-1. Set up your API key:
-   ```bash
-   npm run demo:setup
-   # Then edit demo/cli/.env with your actual API key
-   ```
+| Region | Base URL |
+|---|---|
+| EU (default) | `https://api.algebrakit.com` |
+| Singapore | `https://prod.api.sg-1.algebrakit.com` |
 
-2. Run the demo:
-   ```bash
-   npm run demo
-   ```
+The older form `new ApiClient(baseUrl, apiKey)` still works.
 
-### Web Demo (`demo/play-exercise/`)
+## Error handling
 
-Renders a working Algebrakit exercise in the browser with learning event logging.
+The methods throw when a request fails. `handleApiError` turns any error into a readable line:
 
-1. Set up your API key:
-   ```bash
-   npm run play-exercise:setup
-   # Then edit demo/play-exercise/.env with your actual API key
-   ```
+```typescript
+import { handleApiError } from '@algebrakit/sdk';
 
-2. Run the web demo:
-   ```bash
-   npm run play-exercise
-   ```
+try {
+  await client.getSessionInfo({ sessionId });
+} catch (error) {
+  console.error(handleApiError(error));
+  // API Error: 401 - Could not validate credentials: the provided api-key is not valid
+}
+```
 
-3. Open `http://localhost:3000` in your browser.
+The thrown error is an [`AxiosError`](https://axios-http.com/docs/handling_errors), so `error.response.status` and `error.response.data` are available too.
 
-## Error Handling
+## More
 
-Use the `handleApiError` utility to standardize error messages:
+- [algebrakit-examples](https://github.com/algebrakit/algebrakit-examples): runnable examples in TypeScript, PHP and .NET
+- [Documentation](https://docs.algebrakit.com/): [SDKs](https://docs.algebrakit.com/pages/320-SDK/), [API reference](https://docs.algebrakit.com/pages/310-API/), [web components](https://docs.algebrakit.com/pages/410-webcomponents/) and [learning events](https://docs.algebrakit.com/pages/450-learning-events/)
+- [OpenAPI specification](https://api.algebrakit.com/openapi/yaml)
+- SDKs for other languages: [PHP](https://github.com/algebrakit/sdk-php) and [.NET](https://github.com/algebrakit/sdk-dotnet)
+- A tour of every API call: [`demo/cli`](demo/cli/demo.ts). Run `npm run demo:setup`, add your API key to `demo/cli/.env`, then run `npm run demo`.
 
-```typescript
-import { handleApiError } from '@algebrakit/sdk';
+## Development
 
-apiClient.createSession(request).catch(error => {
-  console.error(handleApiError(error));
-});
+```bash
+npm install
+npm test            # unit tests, no API key needed
+npm run typecheck
+npm run build
 ```
 
+To release: update the version in `package.json` and [CHANGELOG.md](CHANGELOG.md), then push a tag such as `v1.1.0`. GitHub Actions tests the package, publishes it to npm and creates a GitHub release.
+
 ## License
 
-Licensed under the [MIT License](LICENSE).
+[MIT](LICENSE)

package/dist/ApiClient.d.ts

@@ -1,22 +1,38 @@
-import { CreateSessionRequest, CreateSessionResponse, SessionScoreRequest, SessionScoreResponse, SessionLockRequest, SessionLockResponse, SessionInfoRequest, SessionInfoResponse, SessionRetrieveRequest, ExerciseValidateRequest, ExerciseInfoRequest } from './types/ApiTypes';
-import { SessionRetrieveResponse, ExerciseValidateResponse, ExerciseInfoResponse } from './types/ApiTypes';
+import { CreateSessionRequest, CreateSessionResponse, SessionScoreRequest, SessionScoreResponse, SessionLockRequest, SessionLockResponse, SessionInfoRequest, SessionInfoResponse, SessionRetrieveRequest, SessionRetrieveResponse, ExerciseValidateRequest, ExerciseValidateResponse, ExerciseInfoRequest, ExerciseInfoResponse } from './types/ApiTypes';
+/** The Algebrakit API in the default region (Ireland). */
+export declare const DEFAULT_BASE_URL = "https://api.algebrakit.com";
+/** Options for creating an {@link ApiClient}. */
+export interface ApiClientOptions {
+    /** Your Algebrakit API key. Keep it on your server; never send it to the browser. */
+    apiKey: string;
+    /** Base URL of the Algebrakit API. Defaults to {@link DEFAULT_BASE_URL}. */
+    baseUrl?: string;
+    /** Request timeout in milliseconds. Defaults to 30000. */
+    timeout?: number;
+}
 /**
- * ApiClient is a wrapper around Axios to interact with the Algebrakit Webservice API.
+ * Client for the Algebrakit web service API.
+ *
+ * @example
+ * const client = new ApiClient({ apiKey: process.env.ALGEBRAKIT_API_KEY! });
  */
 export declare class ApiClient {
-    private baseUrl;
-    private apiKey;
     private axiosInstance;
     /**
-     * Initialize the API client with a base URL and API key.
-     * @param baseUrl The base URL of the Algebrakit Webservice API.
-     * @param apiKey The API key for authentication.
+     * Creates a client for the Algebrakit API.
+     * @param options The API key and, optionally, the base URL and timeout.
+     */
+    constructor(options: ApiClientOptions);
+    /**
+     * Creates a client for the Algebrakit API.
+     * @param baseUrl The base URL of the Algebrakit API, for example {@link DEFAULT_BASE_URL}.
+     * @param apiKey Your Algebrakit API key.
      */
     constructor(baseUrl: string, apiKey: string);
     /**
      * Create new exercise sessions.
-     * @param request The request payload for creating sessions.
-     * @returns The response containing session creation results.
+     * @param request The exercises to create sessions for. `apiVersion` defaults to 2.
+     * @returns For each exercise, whether it succeeded and the created sessions.
      */
     createSession(request: CreateSessionRequest): Promise<CreateSessionResponse>;
     /**

package/dist/ApiClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ApiClient.d.ts","sourceRoot":"","sources":["../src/ApiClient.ts"],"names":[],"mappings":"AACA,OAAO,EACL,oBAAoB,EACpB,qBAAqB,EACrB,mBAAmB,EACnB,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACnB,kBAAkB,EAClB,mBAAmB,EACnB,sBAAsB,EACtB,uBAAuB,EACvB,mBAAmB,EACpB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACL,uBAAuB,EACvB,wBAAwB,EACxB,oBAAoB,EACrB,MAAM,kBAAkB,CAAC;AAE1B;;GAEG;AACH,qBAAa,SAAS;IAQR,OAAO,CAAC,OAAO;IAAU,OAAO,CAAC,MAAM;IAPnD,OAAO,CAAC,aAAa,CAAgB;IAErC;;;;OAIG;gBACiB,OAAO,EAAE,MAAM,EAAU,MAAM,EAAE,MAAM;IAU3D;;;;OAIG;IACU,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAIzF;;;;OAIG;IACU,eAAe,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAIzF;;;;OAIG;IACU,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAInF;;;;OAIG;IACU,cAAc,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAItF;;;;OAIG;IACU,eAAe,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAI/F;;;;OAIG;IACU,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAIlG;;;;OAIG;IACU,wBAAwB,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;CAGnG"}
+{"version":3,"file":"ApiClient.d.ts","sourceRoot":"","sources":["../src/ApiClient.ts"],"names":[],"mappings":"AACA,OAAO,EACL,oBAAoB,EACpB,qBAAqB,EACrB,mBAAmB,EACnB,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACnB,kBAAkB,EAClB,mBAAmB,EACnB,sBAAsB,EACtB,uBAAuB,EACvB,uBAAuB,EACvB,wBAAwB,EACxB,mBAAmB,EACnB,oBAAoB,EACrB,MAAM,kBAAkB,CAAC;AAG1B,0DAA0D;AAC1D,eAAO,MAAM,gBAAgB,+BAA+B,CAAC;AAE7D,iDAAiD;AACjD,MAAM,WAAW,gBAAgB;IAC/B,qFAAqF;IACrF,MAAM,EAAE,MAAM,CAAC;IACf,4EAA4E;IAC5E,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,0DAA0D;IAC1D,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;GAKG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,aAAa,CAAgB;IAErC;;;OAGG;gBACS,OAAO,EAAE,gBAAgB;IACrC;;;;OAIG;gBACS,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAwB3C;;;;OAIG;IACU,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAMzF;;;;OAIG;IACU,eAAe,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAIzF;;;;OAIG;IACU,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAInF;;;;OAIG;IACU,cAAc,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAItF;;;;OAIG;IACU,eAAe,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAI/F;;;;OAIG;IACU,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAIlG;;;;OAIG;IACU,wBAAwB,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;CAGnG"}

package/dist/ApiClient.js

@@ -1,108 +1,97 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiClient = void 0;
+exports.ApiClient = exports.DEFAULT_BASE_URL = void 0;
 const axios_1 = __importDefault(require("axios"));
+const apiErrorMessage_1 = require("./utils/apiErrorMessage");
+/** The Algebrakit API in the default region (Ireland). */
+exports.DEFAULT_BASE_URL = 'https://api.algebrakit.com';
 /**
- * ApiClient is a wrapper around Axios to interact with the Algebrakit Webservice API.
+ * Client for the Algebrakit web service API.
+ *
+ * @example
+ * const client = new ApiClient({ apiKey: process.env.ALGEBRAKIT_API_KEY! });
  */
 class ApiClient {
-    /**
-     * Initialize the API client with a base URL and API key.
-     * @param baseUrl The base URL of the Algebrakit Webservice API.
-     * @param apiKey The API key for authentication.
-     */
-    constructor(baseUrl, apiKey) {
-        this.baseUrl = baseUrl;
-        this.apiKey = apiKey;
+    axiosInstance;
+    constructor(optionsOrBaseUrl, apiKey) {
+        const options = typeof optionsOrBaseUrl === 'string' ? { baseUrl: optionsOrBaseUrl, apiKey: apiKey ?? '' } : optionsOrBaseUrl;
         this.axiosInstance = axios_1.default.create({
-            baseURL: baseUrl,
+            baseURL: options.baseUrl ?? exports.DEFAULT_BASE_URL,
+            timeout: options.timeout ?? 30000,
             headers: {
                 'Content-Type': 'application/json',
-                'x-api-key': apiKey
+                'x-api-key': options.apiKey,
             },
         });
+        // Put the API's own error message in the error, for example
+        // "Algebrakit API error 401: Could not validate credentials: the provided api-key is not valid"
+        this.axiosInstance.interceptors.response.use(undefined, (error) => {
+            if (axios_1.default.isAxiosError(error) && error.response) {
+                error.message = `Algebrakit API error ${error.response.status}: ${(0, apiErrorMessage_1.apiErrorMessage)(error.response.data)}`;
+            }
+            return Promise.reject(error);
+        });
     }
     /**
      * Create new exercise sessions.
-     * @param request The request payload for creating sessions.
-     * @returns The response containing session creation results.
+     * @param request The exercises to create sessions for. `apiVersion` defaults to 2.
+     * @returns For each exercise, whether it succeeded and the created sessions.
      */
-    createSession(request) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.axiosInstance.post('/session/create', request).then(r => r.data);
-        });
+    async createSession(request) {
+        return this.axiosInstance
+            .post('/session/create', { apiVersion: 2, ...request })
+            .then(r => r.data);
     }
     /**
      * Retrieve results from exercise sessions.
      * @param request The request payload for retrieving session scores.
      * @returns The response containing session scores.
      */
-    getSessionScore(request) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.axiosInstance.post('/session/score', request).then(r => r.data);
-        });
+    async getSessionScore(request) {
+        return this.axiosInstance.post('/session/score', request).then(r => r.data);
     }
     /**
      * Lock or unlock exercise sessions.
      * @param request The request payload for locking/unlocking sessions.
      * @returns The response confirming the action.
      */
-    lockSession(request) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.axiosInstance.post('/sessions/lock', request).then(r => r.data);
-        });
+    async lockSession(request) {
+        return this.axiosInstance.post('/sessions/lock', request).then(r => r.data);
     }
     /**
      * Retrieve detailed information about a session.
      * @param request The request payload for retrieving session information.
      * @returns The response containing session details.
      */
-    getSessionInfo(request) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.axiosInstance.post('/session/info', request).then(r => r.data);
-        });
+    async getSessionInfo(request) {
+        return this.axiosInstance.post('/session/info', request).then(r => r.data);
     }
     /**
      * Retrieve existing sessions by their IDs.
      * @param request The request payload containing session IDs.
      * @returns The response containing session data for each ID.
      */
-    retrieveSession(request) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.axiosInstance.post('/session/retrieve', request).then(r => r.data);
-        });
+    async retrieveSession(request) {
+        return this.axiosInstance.post('/session/retrieve', request).then(r => r.data);
     }
     /**
      * Validate an exercise definition or ID.
      * @param request The request payload for exercise validation.
      * @returns The response containing validation results and details.
      */
-    validateExercise(request) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.axiosInstance.post('/exercise/validate', request).then(r => r.data);
-        });
+    async validateExercise(request) {
+        return this.axiosInstance.post('/exercise/validate', request).then(r => r.data);
     }
     /**
      * Retrieve published information about an exercise (structure, versions, history).
      * @param request The request payload containing the exercise ID.
      * @returns The response containing published info about the exercise.
      */
-    getExercisePublishedInfo(request) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.axiosInstance.post('/exercise/published-info', request).then(r => r.data);
-        });
+    async getExercisePublishedInfo(request) {
+        return this.axiosInstance.post('/exercise/published-info', request).then(r => r.data);
     }
 }
 exports.ApiClient = ApiClient;

package/dist/ApiClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"ApiClient.js","sourceRoot":"","sources":["../src/ApiClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,kDAA6C;AAoB7C;;GAEG;AACH,MAAa,SAAS;IAGpB;;;;OAIG;IACH,YAAoB,OAAe,EAAU,MAAc;QAAvC,YAAO,GAAP,OAAO,CAAQ;QAAU,WAAM,GAAN,MAAM,CAAQ;QACzD,IAAI,CAAC,aAAa,GAAG,eAAK,CAAC,MAAM,CAAC;YAChC,OAAO,EAAE,OAAO;YAChB,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,WAAW,EAAE,MAAM;aACpB;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACU,aAAa,CAAC,OAA6B;;YACtD,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAwB,iBAAiB,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACtG,CAAC;KAAA;IAED;;;;OAIG;IACU,eAAe,CAAC,OAA4B;;YACvD,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAuB,gBAAgB,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACpG,CAAC;KAAA;IAED;;;;OAIG;IACU,WAAW,CAAC,OAA2B;;YAClD,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAsB,gBAAgB,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACnG,CAAC;KAAA;IAED;;;;OAIG;IACU,cAAc,CAAC,OAA2B;;YACrD,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAsB,eAAe,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAClG,CAAC;KAAA;IAED;;;;OAIG;IACU,eAAe,CAAC,OAA+B;;YAC1D,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAA0B,mBAAmB,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC1G,CAAC;KAAA;IAED;;;;OAIG;IACU,gBAAgB,CAAC,OAAgC;;YAC5D,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAA2B,oBAAoB,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC5G,CAAC;KAAA;IAED;;;;OAIG;IACU,wBAAwB,CAAC,OAA4B;;YAChE,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAuB,0BAA0B,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC9G,CAAC;KAAA;CACF;AAhFD,8BAgFC"}
+{"version":3,"file":"ApiClient.js","sourceRoot":"","sources":["../src/ApiClient.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA6C;AAiB7C,6DAA0D;AAE1D,0DAA0D;AAC7C,QAAA,gBAAgB,GAAG,4BAA4B,CAAC;AAY7D;;;;;GAKG;AACH,MAAa,SAAS;IACZ,aAAa,CAAgB;IAarC,YAAY,gBAA2C,EAAE,MAAe;QACtE,MAAM,OAAO,GACX,OAAO,gBAAgB,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC;QAEhH,IAAI,CAAC,aAAa,GAAG,eAAK,CAAC,MAAM,CAAC;YAChC,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,wBAAgB;YAC5C,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,KAAK;YACjC,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,WAAW,EAAE,OAAO,CAAC,MAAM;aAC5B;SACF,CAAC,CAAC;QAEH,4DAA4D;QAC5D,gGAAgG;QAChG,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,KAAc,EAAE,EAAE;YACzE,IAAI,eAAK,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;gBAChD,KAAK,CAAC,OAAO,GAAG,wBAAwB,KAAK,CAAC,QAAQ,CAAC,MAAM,KAAK,IAAA,iCAAe,EAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3G,CAAC;YACD,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,aAAa,CAAC,OAA6B;QACtD,OAAO,IAAI,CAAC,aAAa;aACtB,IAAI,CAAwB,iBAAiB,EAAE,EAAE,UAAU,EAAE,CAAC,EAAE,GAAG,OAAO,EAAE,CAAC;aAC7E,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,eAAe,CAAC,OAA4B;QACvD,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAuB,gBAAgB,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACpG,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,WAAW,CAAC,OAA2B;QAClD,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAsB,gBAAgB,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACnG,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,cAAc,CAAC,OAA2B;QACrD,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAsB,eAAe,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAClG,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,eAAe,CAAC,OAA+B;QAC1D,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAA0B,mBAAmB,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAC1G,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,gBAAgB,CAAC,OAAgC;QAC5D,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAA2B,oBAAoB,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAC5G,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,wBAAwB,CAAC,OAA4B;QAChE,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAuB,0BAA0B,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAC9G,CAAC;CACF;AArGD,8BAqGC"}

package/dist/types/request/RequestTypes.d.ts

@@ -1,27 +1,46 @@
 import { IAK_Exercise } from '../exercise/AK_ExerciseTypes';
+/** How much feedback a student receives on their answers. */
 export type AK_StudentFeedbackType = 'ALL' | 'ICONS_ONLY' | 'ERRORS_ONLY' | 'NONE';
 export interface CreateSessionOptions {
     validate?: boolean;
     productionMode?: boolean;
+    /** Include debug information about the item in the response. */
     generateDebugInfo?: boolean;
 }
 export interface CreateSessionRequest {
+    /**
+     * The exercises to create sessions for. Identify each exercise in one of three ways:
+     * - `exerciseId` (and optionally `version`): an exercise created in the Algebrakit CMS;
+     * - `exerciseSpec`: a JSON specification of the exercise;
+     * - `sessionId`: reuse the exercise of an existing session, for example to create identical sessions from a random exercise.
+     */
     exercises: Array<{
+        /** Unique identifier of an exercise created in the Algebrakit CMS. */
         exerciseId?: string;
+        /** Version of the exercise, or `'latest'` (the default) for the most recent version. */
         version?: string;
+        /** JSON specification of the exercise, for example in the AK_Exercise format. */
         exerciseSpec?: IAK_Exercise | Record<string, unknown>;
+        /** Identifier of an existing session whose exercise to reuse. */
         sessionId?: string;
+        /** Number of sessions to create from `sessionId`. */
         nr?: number;
     }>;
     options?: CreateSessionOptions;
+    /** Reference to a predefined scoring model. */
     scoringModel?: string;
+    /** Turns off step-by-step evaluation, hints and feedback for the student. */
     assessmentMode?: boolean;
+    /** Prevents obtaining the solution before the session is locked. */
     requireLockForSolution?: boolean;
+    /** How much feedback the student receives on their answers. Defaults to `'ALL'`. */
     studentFeedbackType?: AK_StudentFeedbackType;
-    apiVersion: 2;
+    /** API version. The SDK sets this to 2; you don't need to pass it. */
+    apiVersion?: 2;
 }
 export interface SessionScoreRequest {
     sessionId: string;
+    /** Lock the session, so that the student can't change it anymore. */
     lockSession?: boolean;
 }
 export interface SessionLockRequest {

package/dist/types/request/RequestTypes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RequestTypes.d.ts","sourceRoot":"","sources":["../../../src/types/request/RequestTypes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAE5D,MAAM,MAAM,sBAAsB,GAAG,KAAK,GAAG,YAAY,GAAG,aAAa,GAAG,MAAM,CAAC;AAEnF,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,KAAK,CAAC;QACf,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,YAAY,CAAC,EAAE,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACtD,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,EAAE,CAAC,EAAE,MAAM,CAAC;KACb,CAAC,CAAC;IACH,OAAO,CAAC,EAAE,oBAAoB,CAAC;IAC/B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,mBAAmB,CAAC,EAAE,sBAAsB,CAAC;IAC7C,UAAU,EAAE,CAAC,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAC;IACvC,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB;AAED,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB;AAED,MAAM,WAAW,uBAAuB;IACtC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1B,YAAY,CAAC,EAAE,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACvD;AAED,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;CACZ"}
+{"version":3,"file":"RequestTypes.d.ts","sourceRoot":"","sources":["../../../src/types/request/RequestTypes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAE5D,6DAA6D;AAC7D,MAAM,MAAM,sBAAsB,GAAG,KAAK,GAAG,YAAY,GAAG,aAAa,GAAG,MAAM,CAAC;AAEnF,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,gEAAgE;IAChE,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,SAAS,EAAE,KAAK,CAAC;QACf,sEAAsE;QACtE,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,wFAAwF;QACxF,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,iFAAiF;QACjF,YAAY,CAAC,EAAE,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACtD,iEAAiE;QACjE,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,qDAAqD;QACrD,EAAE,CAAC,EAAE,MAAM,CAAC;KACb,CAAC,CAAC;IACH,OAAO,CAAC,EAAE,oBAAoB,CAAC;IAC/B,+CAA+C;IAC/C,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,6EAA6E;IAC7E,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,oEAAoE;IACpE,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,oFAAoF;IACpF,mBAAmB,CAAC,EAAE,sBAAsB,CAAC;IAC7C,sEAAsE;IACtE,UAAU,CAAC,EAAE,CAAC,CAAC;CAChB;AAED,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,MAAM,CAAC;IAClB,qEAAqE;IACrE,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAC;IACvC,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB;AAED,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB;AAED,MAAM,WAAW,uBAAuB;IACtC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1B,YAAY,CAAC,EAAE,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACvD;AAED,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;CACZ"}

package/dist/types/response/ResponseTypes.d.ts

@@ -13,6 +13,7 @@ export interface SessionLockResponse {
 }
 export interface SessionInfoResponse {
     success?: boolean;
+    /** When the session was created, as a Unix timestamp in seconds. */
     creationTimestamp?: number;
     elements: Array<ElementInfo>;
     tagDescriptions: Record<string, TagDescription>;

package/dist/types/response/ResponseTypes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ResponseTypes.d.ts","sourceRoot":"","sources":["../../../src/types/response/ResponseTypes.ts"],"names":[],"mappings":"AACA,OAAO,EAAmB,kBAAkB,EAAE,cAAc,EAAE,cAAc,EAAE,WAAW,EAAE,sBAAsB,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAE9J,MAAM,MAAM,qBAAqB,GAAG,KAAK,CAAC;IACxC,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;CAC9B,CAAC,CAAC;AAEH,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IACjC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAChD,OAAO,EAAE,kBAAkB,CAAC;CAC7B;AAED,MAAM,WAAW,mBAAmB;CAAG;AAEvC,MAAM,WAAW,mBAAmB;IAClC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAC7B,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAChD,OAAO,CAAC,EAAE,kBAAkB,CAAC;CAC9B;AAED,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC;AAEzD,MAAM,WAAW,wBAAwB;IACvC,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,OAAO,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC;CACvD;AAED,MAAM,WAAW,oBAAoB;IACnC,aAAa,EAAE,sBAAsB,EAAE,CAAC;IACxC,EAAE,EAAE,MAAM,CAAC;IACX,iBAAiB,EAAE,4BAA4B,EAAE,CAAC;IAClD,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,sBAAsB;IACrC,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,4BAA4B;IAC3C,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,GAAG,QAAQ,CAAC;IAChC,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,EAAE,uBAAuB,EAAE,CAAC;IACxC,SAAS,EAAE,oBAAoB,EAAE,CAAC;CACnC;AAED,MAAM,WAAW,uBAAuB;IACtC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB"}
+{"version":3,"file":"ResponseTypes.d.ts","sourceRoot":"","sources":["../../../src/types/response/ResponseTypes.ts"],"names":[],"mappings":"AACA,OAAO,EAAmB,kBAAkB,EAAE,cAAc,EAAE,cAAc,EAAE,WAAW,EAAE,sBAAsB,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAE9J,MAAM,MAAM,qBAAqB,GAAG,KAAK,CAAC;IACxC,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;CAC9B,CAAC,CAAC;AAEH,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IACjC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAChD,OAAO,EAAE,kBAAkB,CAAC;CAC7B;AAED,MAAM,WAAW,mBAAmB;CAAG;AAEvC,MAAM,WAAW,mBAAmB;IAClC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,oEAAoE;IACpE,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAC7B,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAChD,OAAO,CAAC,EAAE,kBAAkB,CAAC;CAC9B;AAED,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC;AAEzD,MAAM,WAAW,wBAAwB;IACvC,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,OAAO,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC;CACvD;AAED,MAAM,WAAW,oBAAoB;IACnC,aAAa,EAAE,sBAAsB,EAAE,CAAC;IACxC,EAAE,EAAE,MAAM,CAAC;IACX,iBAAiB,EAAE,4BAA4B,EAAE,CAAC;IAClD,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,sBAAsB;IACrC,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,4BAA4B;IAC3C,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,GAAG,QAAQ,CAAC;IAChC,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,EAAE,uBAAuB,EAAE,CAAC;IACxC,SAAS,EAAE,oBAAoB,EAAE,CAAC;CACnC;AAED,MAAM,WAAW,uBAAuB;IACtC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB"}

package/dist/utils/apiErrorMessage.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Extracts the error message from an Algebrakit API error response body,
+ * for example `{"success":false,"error":"Could not validate credentials: ..."}`.
+ */
+export declare function apiErrorMessage(data: unknown): string;
+//# sourceMappingURL=apiErrorMessage.d.ts.map

package/dist/utils/apiErrorMessage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"apiErrorMessage.d.ts","sourceRoot":"","sources":["../../src/utils/apiErrorMessage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,OAAO,GAAG,MAAM,CAOrD"}

package/dist/utils/apiErrorMessage.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.apiErrorMessage = apiErrorMessage;
+/**
+ * Extracts the error message from an Algebrakit API error response body,
+ * for example `{"success":false,"error":"Could not validate credentials: ..."}`.
+ */
+function apiErrorMessage(data) {
+    if (data && typeof data === 'object') {
+        const body = data;
+        const message = body.error ?? body.msg ?? body.message;
+        return typeof message === 'string' ? message : JSON.stringify(data);
+    }
+    return data === undefined || data === '' ? 'no response body' : String(data);
+}
+//# sourceMappingURL=apiErrorMessage.js.map

package/dist/utils/apiErrorMessage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apiErrorMessage.js","sourceRoot":"","sources":["../../src/utils/apiErrorMessage.ts"],"names":[],"mappings":";;AAIA,0CAOC;AAXD;;;GAGG;AACH,SAAgB,eAAe,CAAC,IAAa;IAC3C,IAAI,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,IAA6D,CAAC;QAC3E,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC;QACvD,OAAO,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACtE,CAAC;IACD,OAAO,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;AAC/E,CAAC"}

package/dist/utils/errorHandler.d.ts

@@ -1,8 +1,7 @@
-import { AxiosError } from 'axios';
 /**
- * Handles errors from Axios requests and provides a standardized error message.
- * @param error The Axios error object.
- * @returns A standardized error message.
+ * Turns an error from an {@link ApiClient} call into a readable message.
+ * @param error The error thrown by an `ApiClient` method.
+ * @returns A message such as `API Error: 401 - Could not validate credentials: the provided api-key is not valid`.
  */
-export declare function handleApiError(error: AxiosError): string;
+export declare function handleApiError(error: unknown): string;
 //# sourceMappingURL=errorHandler.d.ts.map

package/dist/utils/errorHandler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errorHandler.d.ts","sourceRoot":"","sources":["../../src/utils/errorHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AAEnC;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAWxD"}
+{"version":3,"file":"errorHandler.d.ts","sourceRoot":"","sources":["../../src/utils/errorHandler.ts"],"names":[],"mappings":"AAGA;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAarD"}