@modelhealth/modelhealth 0.2.0 → 0.3.0

package/dist/index.d.ts

@@ -16,7 +16,7 @@
  * const sessions = await client.sessionList();
  * ```
  */
-import type { CheckerboardDetails, Session, Subject, SubjectParameters, Activity, ActivitySort, ActivityTag, VideoVersion, MotionDataType, MotionData, AnalysisDataType, AnalysisData, AnalysisType, Analysis, AnalysisStatus, ActivityStatus, CalibrationStatus } from "./types.js";
+import type { CheckerboardDetails, Session, SessionConfig, Subject, SubjectParameters, Activity, ActivitySort, ActivityTag, VideoVersion, MotionDataType, MotionData, AnalysisDataType, AnalysisData, ActivityType, ActivityConfig, Analysis, AnalysisStatus, ActivityStatus, CalibrationStatus, ImportStatus, Archive, ArchiveStatus } from "./types.js";
 /**
  * Configuration options for the Model Health client.
  */
@@ -27,7 +27,7 @@ export interface ModelHealthConfig {
      * This is required to use the SDK. Get your API key from the
      * ModelHealth dashboard.
      *
-     * @required
+     * Required.
      */
     apiKey: string;
     /**
@@ -147,7 +147,7 @@ export declare class ModelHealthService {
      * Creates a session.
      *
      * A session is the parent container for a movement capture workflow. It links
-     * related entities such as activities and subjects, and provides the context
+     * related entities such as activities and subjects and provides the context
      * used by subsequent operations.
      *
      * @returns A new `Session` with a unique identifier.
@@ -159,6 +159,31 @@ export declare class ModelHealthService {
      * ```
      */
     createSession(): Promise<Session>;
+    /**
+     * Applies settings to an existing session.
+     *
+     * Call this after `createSession` and before calibration to override any
+     * default settings. If not called, the session retains the defaults applied
+     * during creation.
+     *
+     * All fields in `config` are optional — omit any field to keep its default.
+     *
+     * @param session The session to configure.
+     * @param config The settings to apply. Pass `{}` to keep all defaults.
+     * @throws On network failure or authentication error.
+     *
+     * @example
+     * ```typescript
+     * const session = await client.createSession();
+     *
+     * // Override frame rate and data sharing only
+     * await client.configureSession(session, {
+     *   framerate: 60,
+     *   dataSharing: "Share no data"
+     * });
+     * ```
+     */
+    configureSession(session: Session, config?: SessionConfig): Promise<void>;
     /**
      * Calibrates cameras using a checkerboard pattern.
      *
@@ -217,7 +242,7 @@ export declare class ModelHealthService {
      * Retrieves all subjects associated with the API key.
      *
      * Subjects represent individuals being monitored or assessed. Each subject may
-     * contain demographic information, physical measurements, and categorization tags.
+     * contain demographic information, physical measurements and categorization tags.
      *
      * @returns An array of `Subject` objects, or an empty array if none exist.
      * @throws If the request fails due to network or authentication issues.
@@ -276,7 +301,7 @@ export declare class ModelHealthService {
      * ```typescript
      * // First page
      * const page1 = await client.activitiesForSubject(
-     *   "subject-123",
+     *   subject.id,
      *   0,
      *   20,
      *   "updated_at"
@@ -284,14 +309,14 @@ export declare class ModelHealthService {
      *
      * // Next page
      * const page2 = await client.activitiesForSubject(
-     *   "subject-123",
+     *   subject.id,
      *   20,
      *   20,
      *   "updated_at"
      * );
      * ```
      */
-    activitiesForSubject(subjectId: string, startIndex: number, count: number, sort: ActivitySort): Promise<Activity[]>;
+    activitiesForSubject(subjectId: number, startIndex: number, count: number, sort: ActivitySort): Promise<Activity[]>;
     /**
      * Retrieves an activity by its ID.
      *
@@ -332,7 +357,7 @@ export declare class ModelHealthService {
     /**
      * Deletes an activity.
      *
-     * Permanently removes the activity and all associated videos, results, and metadata.
+     * Permanently removes the activity and all associated videos, results and metadata.
      *
      * @param activity The activity to delete.
      * @throws If the deletion fails or the request fails.
@@ -343,7 +368,7 @@ export declare class ModelHealthService {
      * await client.deleteActivity(activity);
      * ```
      *
-     * @warning This operation is irreversible.
+     * **Warning:** This operation is irreversible.
      */
     deleteActivity(activity: Activity): Promise<void>;
     /**
@@ -409,7 +434,7 @@ export declare class ModelHealthService {
      * }
      * ```
      *
-     * @note Downloads run concurrently. Individual download failures do not affect other requests.
+     * Downloads run concurrently. Individual download failures do not affect other requests.
      */
     videosForActivity(activity: Activity, version?: VideoVersion): Promise<Uint8Array[]>;
     /**
@@ -419,8 +444,8 @@ export declare class ModelHealthService {
      * such as kinematics, marker data, or an OpenSim model. Downloads run concurrently and
      * failed downloads are silently excluded from results.
      *
-     * @param dataTypes The motion data types to download (for example, `"kinematics_mot"`, `"markers"`, `"animation"`).
      * @param activity The activity to download data from. Must have completed processing.
+     * @param dataTypes The motion data types to download (for example, `"kinematics_mot"`, `"markers"`, `"animation"`).
      * @returns An array of `MotionData`, one entry per successfully downloaded type. May be empty
      *   if no results are available or all downloads fail.
      *
@@ -430,7 +455,7 @@ export declare class ModelHealthService {
      * const results = await client.motionDataForActivity(activity, ["kinematics_mot"]);
      *
      * for (const result of results) {
-     *   switch (result.resultDataType) {
+     *   switch (result.type) {
      *     case "kinematics_mot":
      *       // Use result.data directly as a .mot file
      *       break;
@@ -447,8 +472,8 @@ export declare class ModelHealthService {
      * a report, or raw data. Downloads run concurrently and failed downloads are silently
      * excluded from results.
      *
-     * @param dataTypes The analysis result data types to download (for example, `"metrics"`, `"report"`, `"data"`).
      * @param activity The activity to download analysis results from. Must have a completed analysis.
+     * @param dataTypes The analysis result data types to download (for example, `"metrics"`, `"report"`, `"data"`).
      * @returns An array of `AnalysisData`, one entry per successfully downloaded type.
      *   May be empty if no results are available or all downloads fail.
      *
@@ -460,7 +485,7 @@ export declare class ModelHealthService {
      * );
      *
      * for (const result of results) {
-     *   switch (result.resultDataType) {
+     *   switch (result.type) {
      *     case "metrics":
      *       const json = JSON.parse(new TextDecoder().decode(result.data));
      *       break;
@@ -484,17 +509,18 @@ export declare class ModelHealthService {
      *
      * @param activityName A descriptive name for this activity (e.g., `"cmj"`, `"squat"`).
      * @param session The session this activity is associated with.
+     * @param config Optional recording configuration.
      * @returns The newly created `Activity`.
      * @throws If recording cannot start (e.g., missing calibration).
      *
      * @example
      * ```typescript
-     * const activity = await client.startRecording("cmj", session);
+     * const activity = await client.startRecording("cmj", session, { activityType: ActivityType.CounterMovementJump });
      * // Subject performs movement...
      * await client.stopRecording(session);
      * ```
      */
-    startRecording(activityName: string, session: Session): Promise<Activity>;
+    startRecording(activityName: string, session: Session, config?: ActivityConfig): Promise<Activity>;
     /**
      * Stops the active recording for a movement trial.
      *
@@ -547,7 +573,7 @@ export declare class ModelHealthService {
      * Call this after `activityStatus` returns `ready`. Use the
      * returned `Analysis` with `analysisStatus` to poll progress.
      *
-     * @param analysisType The type of analysis to run (for example, `"gait"`, `"counter_movement_jump"`).
+     * @param activityType The type of analysis to run (for example, `"gait"`, `"counter_movement_jump"`).
      * @param activity The activity to analyze.
      * @param session The session context containing the activity.
      * @returns An `Analysis` for tracking analysis progress.
@@ -559,7 +585,7 @@ export declare class ModelHealthService {
      * const status = await client.analysisStatus(task);
      * ```
      */
-    startAnalysis(analysisType: AnalysisType, activity: Activity, session: Session): Promise<Analysis>;
+    startAnalysis(activityType: ActivityType, activity: Activity, session: Session): Promise<Analysis>;
     /**
      * Retrieves the current status of an analysis task.
      *
@@ -588,6 +614,116 @@ export declare class ModelHealthService {
      * ```
      */
     analysisStatus(task: Analysis): Promise<AnalysisStatus>;
+    /**
+     * Imports a set of trials into a new session.
+     *
+     * Performs the full import workflow: session creation, configuration,
+     * subject association, trial creation, video download and upload, processing
+     * trigger and polling until complete for each trial.
+     *
+     * Progress is reported via `statusCallback` with `ImportStatus` values.
+     *
+     * @param activitiesJson A JSON array of trial objects to import.
+     * @param subject The subject to associate with the session.
+     * @param config Session configuration. Pass `{}` for defaults.
+     * @param statusCallback Callback called with progress updates. Defaults to no-op.
+     * @returns The `Session` containing all imported trials.
+     * @throws If any step of the import fails.
+     *
+     * @example
+     * ```typescript
+     * const session = await client.importSession(
+     *   activitiesJson,
+     *   subject,
+     *   null,
+     *   { framerate: 60 },
+     *   (status) => {
+     *     switch (status.type) {
+     *       case "creating_session":
+     *         console.log("Creating session...");
+     *         break;
+     *       case "uploading_video":
+     *         console.log(`[${status.trial}] ${status.uploaded}/${status.total}`);
+     *         break;
+     *       case "processing":
+     *         console.log("Processing...");
+     *         break;
+     *     }
+     *   }
+     * );
+     * ```
+     */
+    importSession(activitiesJson: string, subject: Subject, config?: SessionConfig, statusCallback?: (status: ImportStatus) => void): Promise<Session>;
+    /**
+     * Begins preparing a session archive.
+     *
+     * Kicks off a server-side task that packages the session data into a ZIP file.
+     * Poll `archiveStatus` until the status is `ready`, then download the archive
+     * with `archiveData`.
+     *
+     * @param session The session to archive.
+     * @param withVideos Whether to include raw videos in the archive. Defaults to `false`.
+     * @returns An `Archive` for tracking archive preparation progress.
+     * @throws If the request fails.
+     *
+     * @example
+     * ```typescript
+     * const archive = await client.prepareArchive(session);
+     *
+     * let status: ArchiveStatus;
+     * do {
+     *   status = await client.archiveStatus(archive);
+     * } while (status.type === "processing");
+     *
+     * const zipData = await client.archiveData(archive);
+     * ```
+     */
+    prepareArchive(session: Session, withVideos?: boolean): Promise<Archive>;
+    /**
+     * Retrieves the current status of an archive preparation task.
+     *
+     * Poll this method after `prepareArchive` until the status is `ready`,
+     * then download the archive with `archiveData`.
+     *
+     * @param archive The archive returned from `prepareArchive`.
+     * @returns The current `ArchiveStatus`.
+     * @throws If the request fails.
+     *
+     * @example
+     * ```typescript
+     * const status = await client.archiveStatus(archive);
+     *
+     * switch (status.type) {
+     *   case "processing":
+     *     console.log("Archive being prepared...");
+     *     break;
+     *   case "ready":
+     *     console.log("Archive ready to download");
+     *     break;
+     *   case "failed":
+     *     console.log("Archive preparation failed");
+     *     break;
+     * }
+     * ```
+     */
+    archiveStatus(archive: Archive): Promise<ArchiveStatus>;
+    /**
+     * Downloads the prepared archive as raw ZIP data.
+     *
+     * Call this after `archiveStatus` returns `ready`. The download URL is
+     * managed internally and cached for the lifetime of the WASM instance.
+     *
+     * @param archive The archive returned from `prepareArchive`.
+     * @returns The raw ZIP file bytes as a `Uint8Array`.
+     * @throws If the archive is not yet ready or the download fails.
+     *
+     * @example
+     * ```typescript
+     * const zipData = await client.archiveData(archive);
+     * // Write zipData to a file or process it in memory
+     * ```
+     */
+    archiveData(archive: Archive): Promise<Uint8Array>;
     /**
      * Parse a WASM response and normalise object keys to camelCase.
      *

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,KAAK,EACV,mBAAmB,EACnB,OAAO,EACP,OAAO,EACP,iBAAiB,EACjB,QAAQ,EACR,YAAY,EACZ,WAAW,EACX,YAAY,EACZ,cAAc,EACd,UAAU,EACV,gBAAgB,EAChB,YAAY,EACZ,YAAY,EACZ,QAAQ,EACR,cAAc,EACd,cAAc,EACd,iBAAiB,EAClB,MAAM,YAAY,CAAC;AA0FpB;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;;;OAOG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,MAAM,CAA8B;IAC5C,OAAO,CAAC,WAAW,CAAS;IAE5B;;;;;;;;;;;;;;;;;;;;OAoBG;gBACS,MAAM,EAAE,iBAAiB;IAkBrC;;;;;;;;;;;;;;;;OAgBG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAgB3B;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;IAYzB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAMvC;;;;;;;;;;;;;;OAcG;IACG,aAAa,IAAI,OAAO,CAAC,OAAO,CAAC;IAMvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,eAAe,CACnB,OAAO,EAAE,OAAO,EAChB,mBAAmB,EAAE,mBAAmB,EACxC,cAAc,EAAE,CAAC,MAAM,EAAE,iBAAiB,KAAK,IAAI,GAClD,OAAO,CAAC,IAAI,CAAC;IAehB;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,gBAAgB,CACpB,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,OAAO,EAChB,cAAc,EAAE,CAAC,MAAM,EAAE,iBAAiB,KAAK,IAAI,GAClD,OAAO,CAAC,IAAI,CAAC;IAiBhB;;;;;;;;;;;;;;;;OAgBG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAMvC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,aAAa,CAAC,UAAU,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC;IAQpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,oBAAoB,CACxB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,YAAY,GACjB,OAAO,CAAC,QAAQ,EAAE,CAAC;IAWtB;;;;;;;;;;;;;;;;OAgBG;IACG,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAM1D;;;;;;;;;;;;;;;;;OAiBG;IACG,cAAc,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IAM3D;;;;;;;;;;;;;;;OAeG;IACG,cAAc,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAKvD;;;;;;;;;;;;;;;;OAgBG;IACG,YAAY,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;IAQ5C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAM1D;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,iBAAiB,CACrB,QAAQ,EAAE,QAAQ,EAClB,OAAO,GAAE,YAAuB,GAC/B,OAAO,CAAC,UAAU,EAAE,CAAC;IAgBxB;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,qBAAqB,CACzB,QAAQ,EAAE,QAAQ,EAClB,SAAS,EAAE,cAAc,EAAE,GAC1B,OAAO,CAAC,UAAU,EAAE,CAAC;IAWxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACG,uBAAuB,CAC3B,QAAQ,EAAE,QAAQ,EAClB,SAAS,EAAE,gBAAgB,EAAE,GAC5B,OAAO,CAAC,YAAY,EAAE,CAAC;IAa1B;;;;;;;;;;;;;;;;;OAiBG;IACG,cAAc,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC;IAM/E;;;;;;;;;;;;;OAaG;IACG,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAKpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,cAAc,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,cAAc,CAAC;IAMjE;;;;;;;;;;;;;;;;;OAiBG;IACG,aAAa,CACjB,YAAY,EAAE,YAAY,EAC1B,QAAQ,EAAE,QAAQ,EAClB,OAAO,EAAE,OAAO,GACf,OAAO,CAAC,QAAQ,CAAC;IAYpB;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,cAAc,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAC,cAAc,CAAC;IAQ7D;;;;;;;;;;OAUG;IACH,OAAO,CAAC,aAAa;CAItB;AAID,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,KAAK,EACV,mBAAmB,EACnB,OAAO,EACP,aAAa,EACb,OAAO,EACP,iBAAiB,EACjB,QAAQ,EACR,YAAY,EACZ,WAAW,EACX,YAAY,EACZ,cAAc,EACd,UAAU,EACV,gBAAgB,EAChB,YAAY,EACZ,YAAY,EACZ,cAAc,EACd,QAAQ,EACR,cAAc,EACd,cAAc,EACd,iBAAiB,EACjB,YAAY,EACZ,OAAO,EACP,aAAa,EACd,MAAM,YAAY,CAAC;AA0FpB;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;;;OAOG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,MAAM,CAA8B;IAC5C,OAAO,CAAC,WAAW,CAAS;IAE5B;;;;;;;;;;;;;;;;;;;;OAoBG;gBACS,MAAM,EAAE,iBAAiB;IAkBrC;;;;;;;;;;;;;;;;OAgBG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAgB3B;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;IAYzB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAMvC;;;;;;;;;;;;;;OAcG;IACG,aAAa,IAAI,OAAO,CAAC,OAAO,CAAC;IAMvC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,GAAE,aAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAQnF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,eAAe,CACnB,OAAO,EAAE,OAAO,EAChB,mBAAmB,EAAE,mBAAmB,EACxC,cAAc,EAAE,CAAC,MAAM,EAAE,iBAAiB,KAAK,IAAI,GAClD,OAAO,CAAC,IAAI,CAAC;IAehB;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,gBAAgB,CACpB,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,OAAO,EAChB,cAAc,EAAE,CAAC,MAAM,EAAE,iBAAiB,KAAK,IAAI,GAClD,OAAO,CAAC,IAAI,CAAC;IAiBhB;;;;;;;;;;;;;;;;OAgBG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAMvC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,aAAa,CAAC,UAAU,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC;IAQpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,oBAAoB,CACxB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,YAAY,GACjB,OAAO,CAAC,QAAQ,EAAE,CAAC;IAWtB;;;;;;;;;;;;;;;;OAgBG;IACG,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAM1D;;;;;;;;;;;;;;;;;OAiBG;IACG,cAAc,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IAM3D;;;;;;;;;;;;;;;OAeG;IACG,cAAc,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAKvD;;;;;;;;;;;;;;;;OAgBG;IACG,YAAY,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;IAQ5C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAM1D;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,iBAAiB,CACrB,QAAQ,EAAE,QAAQ,EAClB,OAAO,GAAE,YAAuB,GAC/B,OAAO,CAAC,UAAU,EAAE,CAAC;IAgBxB;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,qBAAqB,CACzB,QAAQ,EAAE,QAAQ,EAClB,SAAS,EAAE,cAAc,EAAE,GAC1B,OAAO,CAAC,UAAU,EAAE,CAAC;IAWxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACG,uBAAuB,CAC3B,QAAQ,EAAE,QAAQ,EAClB,SAAS,EAAE,gBAAgB,EAAE,GAC5B,OAAO,CAAC,YAAY,EAAE,CAAC;IAa1B;;;;;;;;;;;;;;;;;;OAkBG;IACG,cAAc,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IAMxG;;;;;;;;;;;;;OAaG;IACG,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAKpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,cAAc,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,cAAc,CAAC;IAMjE;;;;;;;;;;;;;;;;;OAiBG;IACG,aAAa,CACjB,YAAY,EAAE,YAAY,EAC1B,QAAQ,EAAE,QAAQ,EAClB,OAAO,EAAE,OAAO,GACf,OAAO,CAAC,QAAQ,CAAC;IAYpB;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,cAAc,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAC,cAAc,CAAC;IAQ7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACG,aAAa,CACjB,cAAc,EAAE,MAAM,EACtB,OAAO,EAAE,OAAO,EAChB,MAAM,GAAE,aAAkB,EAC1B,cAAc,GAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAe,GACxD,OAAO,CAAC,OAAO,CAAC;IAuCnB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,UAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAM5E;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC;IAM7D;;;;;;;;;;;;;;;OAeG;IACG,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC;IAQxD;;;;;;;;;;OAUG;IACH,OAAO,CAAC,aAAa;CAItB;AAID,cAAc,YAAY,CAAC"}

package/dist/index.js

@@ -236,7 +236,7 @@ export class ModelHealthService {
      * Creates a session.
      *
      * A session is the parent container for a movement capture workflow. It links
-     * related entities such as activities and subjects, and provides the context
+     * related entities such as activities and subjects and provides the context
      * used by subsequent operations.
      *
      * @returns A new `Session` with a unique identifier.
@@ -252,6 +252,34 @@ export class ModelHealthService {
         const result = await this.wasmClient.createSession();
         return this.parseResponse(result);
     }
+    /**
+     * Applies settings to an existing session.
+     *
+     * Call this after `createSession` and before calibration to override any
+     * default settings. If not called, the session retains the defaults applied
+     * during creation.
+     *
+     * All fields in `config` are optional — omit any field to keep its default.
+     *
+     * @param session The session to configure.
+     * @param config The settings to apply. Pass `{}` to keep all defaults.
+     * @throws On network failure or authentication error.
+     *
+     * @example
+     * ```typescript
+     * const session = await client.createSession();
+     *
+     * // Override frame rate and data sharing only
+     * await client.configureSession(session, {
+     *   framerate: 60,
+     *   dataSharing: "Share no data"
+     * });
+     * ```
+     */
+    async configureSession(session, config = {}) {
+        this.ensureInitialized();
+        await this.wasmClient.configureSession(decamelizeKeys(session), decamelizeKeys(config));
+    }
     /**
      * Calibrates cameras using a checkerboard pattern.
      *
@@ -323,7 +351,7 @@ export class ModelHealthService {
      * Retrieves all subjects associated with the API key.
      *
      * Subjects represent individuals being monitored or assessed. Each subject may
-     * contain demographic information, physical measurements, and categorization tags.
+     * contain demographic information, physical measurements and categorization tags.
      *
      * @returns An array of `Subject` objects, or an empty array if none exist.
      * @throws If the request fails due to network or authentication issues.
@@ -391,7 +419,7 @@ export class ModelHealthService {
      * ```typescript
      * // First page
      * const page1 = await client.activitiesForSubject(
-     *   "subject-123",
+     *   subject.id,
      *   0,
      *   20,
      *   "updated_at"
@@ -399,7 +427,7 @@ export class ModelHealthService {
      *
      * // Next page
      * const page2 = await client.activitiesForSubject(
-     *   "subject-123",
+     *   subject.id,
      *   20,
      *   20,
      *   "updated_at"
@@ -459,7 +487,7 @@ export class ModelHealthService {
     /**
      * Deletes an activity.
      *
-     * Permanently removes the activity and all associated videos, results, and metadata.
+     * Permanently removes the activity and all associated videos, results and metadata.
      *
      * @param activity The activity to delete.
      * @throws If the deletion fails or the request fails.
@@ -470,7 +498,7 @@ export class ModelHealthService {
      * await client.deleteActivity(activity);
      * ```
      *
-     * @warning This operation is irreversible.
+     * **Warning:** This operation is irreversible.
      */
     async deleteActivity(activity) {
         this.ensureInitialized();
@@ -548,7 +576,7 @@ export class ModelHealthService {
      * }
      * ```
      *
-     * @note Downloads run concurrently. Individual download failures do not affect other requests.
+     * Downloads run concurrently. Individual download failures do not affect other requests.
      */
     async videosForActivity(activity, version = "synced") {
         this.ensureInitialized();
@@ -566,8 +594,8 @@ export class ModelHealthService {
      * such as kinematics, marker data, or an OpenSim model. Downloads run concurrently and
      * failed downloads are silently excluded from results.
      *
-     * @param dataTypes The motion data types to download (for example, `"kinematics_mot"`, `"markers"`, `"animation"`).
      * @param activity The activity to download data from. Must have completed processing.
+     * @param dataTypes The motion data types to download (for example, `"kinematics_mot"`, `"markers"`, `"animation"`).
      * @returns An array of `MotionData`, one entry per successfully downloaded type. May be empty
      *   if no results are available or all downloads fail.
      *
@@ -577,7 +605,7 @@ export class ModelHealthService {
      * const results = await client.motionDataForActivity(activity, ["kinematics_mot"]);
      *
      * for (const result of results) {
-     *   switch (result.resultDataType) {
+     *   switch (result.type) {
      *     case "kinematics_mot":
      *       // Use result.data directly as a .mot file
      *       break;
@@ -598,8 +626,8 @@ export class ModelHealthService {
      * a report, or raw data. Downloads run concurrently and failed downloads are silently
      * excluded from results.
      *
-     * @param dataTypes The analysis result data types to download (for example, `"metrics"`, `"report"`, `"data"`).
      * @param activity The activity to download analysis results from. Must have a completed analysis.
+     * @param dataTypes The analysis result data types to download (for example, `"metrics"`, `"report"`, `"data"`).
      * @returns An array of `AnalysisData`, one entry per successfully downloaded type.
      *   May be empty if no results are available or all downloads fail.
      *
@@ -611,7 +639,7 @@ export class ModelHealthService {
      * );
      *
      * for (const result of results) {
-     *   switch (result.resultDataType) {
+     *   switch (result.type) {
      *     case "metrics":
      *       const json = JSON.parse(new TextDecoder().decode(result.data));
      *       break;
@@ -640,19 +668,20 @@ export class ModelHealthService {
      *
      * @param activityName A descriptive name for this activity (e.g., `"cmj"`, `"squat"`).
      * @param session The session this activity is associated with.
+     * @param config Optional recording configuration.
      * @returns The newly created `Activity`.
      * @throws If recording cannot start (e.g., missing calibration).
      *
      * @example
      * ```typescript
-     * const activity = await client.startRecording("cmj", session);
+     * const activity = await client.startRecording("cmj", session, { activityType: ActivityType.CounterMovementJump });
      * // Subject performs movement...
      * await client.stopRecording(session);
      * ```
      */
-    async startRecording(activityName, session) {
+    async startRecording(activityName, session, config) {
         this.ensureInitialized();
-        const result = await this.wasmClient.startRecording(activityName, decamelizeKeys(session));
+        const result = await this.wasmClient.startRecording(activityName, decamelizeKeys(session), config?.activityType ?? null);
         return this.parseResponse(result);
     }
     /**
@@ -714,7 +743,7 @@ export class ModelHealthService {
      * Call this after `activityStatus` returns `ready`. Use the
      * returned `Analysis` with `analysisStatus` to poll progress.
      *
-     * @param analysisType The type of analysis to run (for example, `"gait"`, `"counter_movement_jump"`).
+     * @param activityType The type of analysis to run (for example, `"gait"`, `"counter_movement_jump"`).
      * @param activity The activity to analyze.
      * @param session The session context containing the activity.
      * @returns An `Analysis` for tracking analysis progress.
@@ -726,9 +755,9 @@ export class ModelHealthService {
      * const status = await client.analysisStatus(task);
      * ```
      */
-    async startAnalysis(analysisType, activity, session) {
+    async startAnalysis(activityType, activity, session) {
         this.ensureInitialized();
-        const result = await this.wasmClient.startAnalysis(analysisType, decamelizeKeys(activity), decamelizeKeys(session));
+        const result = await this.wasmClient.startAnalysis(activityType, decamelizeKeys(activity), decamelizeKeys(session));
         return this.parseResponse(result);
     }
     /**
@@ -763,6 +792,159 @@ export class ModelHealthService {
         const result = await this.wasmClient.analysisStatus(decamelizeKeys(task));
         return this.parseResponse(result);
     }
+    // MARK: - Import
+    /**
+     * Imports a set of trials into a new session.
+     *
+     * Performs the full import workflow: session creation, configuration,
+     * subject association, trial creation, video download and upload, processing
+     * trigger and polling until complete for each trial.
+     *
+     * Progress is reported via `statusCallback` with `ImportStatus` values.
+     *
+     * @param activitiesJson A JSON array of trial objects to import.
+     * @param subject The subject to associate with the session.
+     * @param config Session configuration. Pass `{}` for defaults.
+     * @param statusCallback Callback called with progress updates. Defaults to no-op.
+     * @returns The `Session` containing all imported trials.
+     * @throws If any step of the import fails.
+     *
+     * @example
+     * ```typescript
+     * const session = await client.importSession(
+     *   activitiesJson,
+     *   subject,
+     *   null,
+     *   { framerate: 60 },
+     *   (status) => {
+     *     switch (status.type) {
+     *       case "creating_session":
+     *         console.log("Creating session...");
+     *         break;
+     *       case "uploading_video":
+     *         console.log(`[${status.trial}] ${status.uploaded}/${status.total}`);
+     *         break;
+     *       case "processing":
+     *         console.log("Processing...");
+     *         break;
+     *     }
+     *   }
+     * );
+     * ```
+     */
+    async importSession(activitiesJson, subject, config = {}, statusCallback = () => { }) {
+        this.ensureInitialized();
+        const jsCallback = (statusJson) => {
+            let status;
+            if (typeof statusJson === "string") {
+                // Unit variants serialise as plain strings via serde external tagging
+                status = { type: statusJson };
+            }
+            else if (statusJson !== null && typeof statusJson === "object") {
+                const obj = statusJson;
+                if ("created_session" in obj) {
+                    const payload = obj["created_session"];
+                    status = { type: "created_session", session_id: payload.session_id };
+                }
+                else if ("uploading_video" in obj) {
+                    const payload = obj["uploading_video"];
+                    status = { type: "uploading_video", trial: payload.trial, uploaded: payload.uploaded, total: payload.total };
+                }
+                else {
+                    return;
+                }
+            }
+            else {
+                return;
+            }
+            statusCallback(status);
+        };
+        const result = await this.wasmClient.importSession(activitiesJson, decamelizeKeys(subject), decamelizeKeys(config), jsCallback);
+        return this.parseResponse(result);
+    }
+    // MARK: - Archive
+    /**
+     * Begins preparing a session archive.
+     *
+     * Kicks off a server-side task that packages the session data into a ZIP file.
+     * Poll `archiveStatus` until the status is `ready`, then download the archive
+     * with `archiveData`.
+     *
+     * @param session The session to archive.
+     * @param withVideos Whether to include raw videos in the archive. Defaults to `false`.
+     * @returns An `Archive` for tracking archive preparation progress.
+     * @throws If the request fails.
+     *
+     * @example
+     * ```typescript
+     * const archive = await client.prepareArchive(session);
+     *
+     * let status: ArchiveStatus;
+     * do {
+     *   status = await client.archiveStatus(archive);
+     * } while (status.type === "processing");
+     *
+     * const zipData = await client.archiveData(archive);
+     * ```
+     */
+    async prepareArchive(session, withVideos = false) {
+        this.ensureInitialized();
+        const result = await this.wasmClient.prepareArchive(decamelizeKeys(session), withVideos);
+        return this.parseResponse(result);
+    }
+    /**
+     * Retrieves the current status of an archive preparation task.
+     *
+     * Poll this method after `prepareArchive` until the status is `ready`,
+     * then download the archive with `archiveData`.
+     *
+     * @param archive The archive returned from `prepareArchive`.
+     * @returns The current `ArchiveStatus`.
+     * @throws If the request fails.
+     *
+     * @example
+     * ```typescript
+     * const status = await client.archiveStatus(archive);
+     *
+     * switch (status.type) {
+     *   case "processing":
+     *     console.log("Archive being prepared...");
+     *     break;
+     *   case "ready":
+     *     console.log("Archive ready to download");
+     *     break;
+     *   case "failed":
+     *     console.log("Archive preparation failed");
+     *     break;
+     * }
+     * ```
+     */
+    async archiveStatus(archive) {
+        this.ensureInitialized();
+        const result = await this.wasmClient.archiveStatus(decamelizeKeys(archive));
+        return this.parseResponse(result);
+    }
+    /**
+     * Downloads the prepared archive as raw ZIP data.
+     *
+     * Call this after `archiveStatus` returns `ready`. The download URL is
+     * managed internally and cached for the lifetime of the WASM instance.
+     *
+     * @param archive The archive returned from `prepareArchive`.
+     * @returns The raw ZIP file bytes as a `Uint8Array`.
+     * @throws If the archive is not yet ready or the download fails.
+     *
+     * @example
+     * ```typescript
+     * const zipData = await client.archiveData(archive);
+     * // Write zipData to a file or process it in memory
+     * ```
+     */
+    async archiveData(archive) {
+        this.ensureInitialized();
+        const result = await this.wasmClient.archiveData(decamelizeKeys(archive));
+        return new Uint8Array(result);
+    }
     // MARK: - Utilities
     /**
      * Parse a WASM response and normalise object keys to camelCase.