@neuracore/types 3.0.0 → 4.1.0

package/dist/neuracore_types.d.ts

@@ -55,8 +55,8 @@ export interface RobotStreamTrack {
     data_type: DataType;
     label: string;
     mid: string;
-    id?: string;
-    created_at?: string;
+    id: string;
+    created_at: string;
 }
 /**
  * Represents an update on the available capacity of all robots.
@@ -89,8 +89,8 @@ export interface BaseRecodingUpdatePayload {
  * is populated during dataset iteration for efficiency.
  */
 export interface CameraData {
-    timestamp?: number;
-    frame_idx?: number;
+    timestamp: number;
+    frame_idx: number;
     extrinsics?: unknown[] | null;
     intrinsics?: unknown[] | null;
     frame?: string | null;
@@ -99,7 +99,7 @@ export interface CameraData {
  * Statistics for CameraData.
  */
 export interface CameraDataStats {
-    type?: Type;
+    type: Type;
     frame: DataItemStats;
     extrinsics: DataItemStats;
     intrinsics: DataItemStats;
@@ -112,11 +112,11 @@ export interface CameraDataStats {
  * and model configuration purposes.
  */
 export interface DataItemStats {
-    mean?: unknown[] | null;
-    std?: unknown[] | null;
-    count?: unknown[] | null;
-    min?: unknown[] | null;
-    max?: unknown[] | null;
+    mean: unknown[] | null;
+    std: unknown[] | null;
+    count: unknown[] | null;
+    min: unknown[] | null;
+    max: unknown[] | null;
 }
 /**
  * Custom 1D numerical data for specialized applications.
@@ -125,15 +125,15 @@ export interface DataItemStats {
  * numerical information that is one-dimensional.
  */
 export interface Custom1DData {
-    timestamp?: number;
-    type?: Type1;
+    timestamp: number;
+    type: Type1;
     data: unknown[] | null;
 }
 /**
  * Statistics for Custom1DData.
  */
 export interface Custom1DDataStats {
-    type?: Type2;
+    type: Type2;
     data: DataItemStats;
 }
 /**
@@ -167,24 +167,24 @@ export interface Dataset {
     created_at: number;
     modified_at: number;
     description?: string | null;
-    tags?: string[];
-    num_demonstrations?: number;
-    total_duration_seconds?: number;
-    size_bytes?: number;
-    is_shared?: boolean;
-    metadata?: {
+    tags: string[];
+    num_demonstrations: number;
+    total_duration_seconds: number;
+    size_bytes: number;
+    is_shared: boolean;
+    metadata: {
         [k: string]: unknown;
     };
-    synced_dataset_ids?: {
+    synced_dataset_ids: {
         [k: string]: unknown;
     };
-    all_data_types?: {
+    all_data_types: {
         [k: string]: number;
     };
-    common_data_types?: {
+    common_data_types: {
         [k: string]: number;
     };
-    deleted?: boolean;
+    deleted: boolean;
 }
 /**
  * Depth camera data subclass.
@@ -192,12 +192,12 @@ export interface Dataset {
  * Specialization of CameraData for depth images.
  */
 export interface DepthCameraData {
-    timestamp?: number;
-    frame_idx?: number;
+    timestamp: number;
+    frame_idx: number;
     extrinsics?: unknown[] | null;
     intrinsics?: unknown[] | null;
     frame?: string | null;
-    type?: Type3;
+    type: Type3;
 }
 /**
  * End-effector pose data.
@@ -206,15 +206,15 @@ export interface DepthCameraData {
  * position and unit quaternion orientation [x, y, z, qx, qy, qz, qw].
  */
 export interface EndEffectorPoseData {
-    timestamp?: number;
-    type?: Type4;
+    timestamp: number;
+    type: Type4;
     pose: number[];
 }
 /**
  * Statistics for EndEffectorPoseData.
  */
 export interface EndEffectorPoseDataStats {
-    type?: Type5;
+    type: Type5;
     pose: DataItemStats;
 }
 /**
@@ -224,8 +224,8 @@ export interface EndEffectorPoseDataStats {
  * sensor counts, and episode length for analysis and processing.
  */
 export interface EpisodeStatistics {
-    episode_length?: number;
-    data?: {
+    episode_length: number;
+    data: {
         [k: string]: {
             [k: string]: DataItemStats;
         };
@@ -253,7 +253,7 @@ export interface HandshakeMessage {
     data: string;
     connection_id: string;
     type: MessageType;
-    id?: string;
+    id: string;
 }
 /**
  * Request model for starting a training job.
@@ -312,22 +312,22 @@ export interface SynchronizationDetails {
             [k: string]: string[];
         };
     } | null;
-    max_delay_s?: number;
-    allow_duplicates?: boolean;
+    max_delay_s: number;
+    allow_duplicates: boolean;
 }
 /**
  * Robot joint state data including positions, velocities, or torques.
  */
 export interface JointData {
-    timestamp?: number;
-    type?: Type6;
+    timestamp: number;
+    type: Type6;
     value: number;
 }
 /**
  * Statistics for JointData.
  */
 export interface JointDataStats {
-    type?: Type7;
+    type: Type7;
     value: DataItemStats;
 }
 /**
@@ -337,15 +337,15 @@ export interface JointDataStats {
  * or other linguistic data associated with robot demonstrations.
  */
 export interface LanguageData {
-    timestamp?: number;
-    type?: Type8;
+    timestamp: number;
+    type: Type8;
     text: string;
 }
 /**
  * Statistics for LanguageData.
  */
 export interface LanguageDataStats {
-    type?: Type9;
+    type: Type9;
     text: DataItemStats;
 }
 /**
@@ -355,7 +355,7 @@ export interface LanguageDataStats {
  *     metrics: A dictionary mapping metric names to their values/metaData
  */
 export interface Metrics {
-    metrics?: {
+    metrics: {
         [k: string]: MetricsData;
     };
 }
@@ -371,7 +371,7 @@ export interface MetricsData {
     data: {
         [k: string]: number;
     };
-    metadata?: {
+    metadata: {
         [k: string]: unknown;
     };
 }
@@ -399,27 +399,27 @@ export interface ModelInitDescription {
     dataset_statistics: {
         [k: string]: (JointDataStats | CameraDataStats | PoseDataStats | EndEffectorPoseDataStats | ParallelGripperOpenAmountDataStats | PointCloudDataStats | LanguageDataStats | Custom1DDataStats)[];
     };
-    output_prediction_horizon?: number;
+    output_prediction_horizon: number;
 }
 /**
  * Statistics for PoseData.
  */
 export interface PoseDataStats {
-    type?: Type10;
+    type: Type10;
     pose: DataItemStats;
 }
 /**
  * Statistics for ParallelGripperOpenAmountData.
  */
 export interface ParallelGripperOpenAmountDataStats {
-    type?: Type11;
+    type: Type11;
     open_amount: DataItemStats;
 }
 /**
  * Statistics for PointCloudData.
  */
 export interface PointCloudDataStats {
-    type?: Type12;
+    type: Type12;
     points: DataItemStats;
     rgb_points: DataItemStats;
     extrinsics: DataItemStats;
@@ -432,7 +432,7 @@ export interface PointCloudDataStats {
  * timestamp generation for temporal synchronization and data ordering.
  */
 export interface NCData {
-    timestamp?: number;
+    timestamp: number;
 }
 /**
  * Base class for statistics of Neuracore data types.
@@ -472,8 +472,8 @@ export interface OpenConnectionRequest {
     robot_id: string;
     robot_instance: number;
     video_format: VideoFormat;
-    id?: string;
-    created_at?: string;
+    id: string;
+    created_at: string;
 }
 /**
  * Open amount data for parallel end effector gripper.
@@ -481,10 +481,45 @@ export interface OpenConnectionRequest {
  * Contains the state of parallel gripper opening amounts.
  */
 export interface ParallelGripperOpenAmountData {
-    timestamp?: number;
-    type?: Type13;
+    timestamp: number;
+    type: Type13;
     open_amount: number;
 }
+/**
+ * Represents a pending recording.
+ *
+ * Attributes:
+ *     saved_dataset_id: ID of the dataset where the recording is saved
+ */
+export interface PendingRecording {
+    id: string;
+    robot_id: string;
+    instance: number;
+    org_id: string;
+    created_by: string;
+    start_time: number;
+    end_time?: number | null;
+    metadata: RecordingMetadata;
+    total_bytes: number;
+    is_shared: boolean;
+    data_types: DataType[];
+    saved_dataset_id: string;
+    status: PendingRecordingStatus;
+    progress: number;
+}
+/**
+ * Metadata details for a recording.
+ *
+ * Attributes:
+ *     name: Name of the recording.
+ *     notes: Optional notes about the recording.
+ *     status: Current RecordingStatus of the recording
+ */
+export interface RecordingMetadata {
+    name: string;
+    notes: string;
+    status: RecordingStatus;
+}
 /**
  * 3D point cloud data with optional RGB colouring and camera parameters.
  *
@@ -492,8 +527,8 @@ export interface ParallelGripperOpenAmountData {
  * optional colour information and camera calibration for registration.
  */
 export interface PointCloudData {
-    timestamp?: number;
-    type?: Type14;
+    timestamp: number;
+    type: Type14;
     points?: string | null;
     rgb_points?: string | null;
     extrinsics?: unknown[] | null;
@@ -507,8 +542,8 @@ export interface PointCloudData {
  * mapping pose names to [x, y, z, rx, ry, rz] values.
  */
 export interface PoseData {
-    timestamp?: number;
-    type?: Type15;
+    timestamp: number;
+    type: Type15;
     pose: number[];
 }
 /**
@@ -517,12 +552,12 @@ export interface PoseData {
  * Specialization of CameraData for RGB images.
  */
 export interface RGBCameraData {
-    timestamp?: number;
-    frame_idx?: number;
+    timestamp: number;
+    frame_idx: number;
     extrinsics?: unknown[] | null;
     intrinsics?: unknown[] | null;
     frame?: string | null;
-    type?: Type16;
+    type: Type16;
 }
 /**
  * Represents a robot recording with flat storage.
@@ -543,43 +578,31 @@ export interface RGBCameraData {
 export interface Recording {
     id: string;
     robot_id: string;
-    instance?: number;
+    instance: number;
     org_id: string;
-    created_by?: string;
-    start_time?: number;
+    created_by: string;
+    start_time: number;
     end_time?: number | null;
-    metadata?: RecordingMetadata;
-    total_bytes?: number;
-    is_shared?: boolean;
-    data_types?: DataType[];
-}
-/**
- * Metadata details for a recording.
- *
- * Attributes:
- *     name: Name of the recording.
- *     notes: Optional notes about the recording.
- *     status: Current RecordingStatus of the recording
- */
-export interface RecordingMetadata {
-    name?: string;
-    notes?: string;
-    status?: RecordingStatus;
+    metadata: RecordingMetadata;
+    total_bytes: number;
+    is_shared: boolean;
+    data_types: DataType[];
 }
 /**
- * Represents a single data stream belonging to a recording.
+ * Represents a single data trace belonging to a recording.
  *
- * This is used to track upload completion for each stream so that
- * a recording can be saved once all streams are uploaded.
+ * This is used to track upload completion for each trace so that
+ * a recording can be saved once all traces are uploaded.
  */
-export interface RecordingDataStream {
+export interface RecordingDataTrace {
     id: string;
     recording_id: string;
     data_type: DataType;
-    status?: RecordingDataStreamStatus;
-    upload_progress: number;
-    created_at?: number;
+    status: RecordingDataTraceStatus;
+    created_at: number;
     uploaded_at: number | null;
+    uploaded_bytes: number;
+    total_bytes: number;
 }
 /**
  * Notification message for recording lifecycle events.
@@ -590,7 +613,7 @@ export interface RecordingDataStream {
 export interface RecordingNotification {
     type: RecordingNotificationType;
     payload: RecordingStartPayload | RecordingStartPayload[] | BaseRecodingUpdatePayload;
-    id?: string;
+    id: string;
 }
 /**
  * Payload for recording start notifications.
@@ -600,8 +623,8 @@ export interface RecordingStartPayload {
     robot_id: string;
     instance: number;
     created_by: string;
-    dataset_ids?: string[];
-    data_types?: DataType[];
+    dataset_ids: string[];
+    data_types: DataType[];
     start_time: number;
 }
 /**
@@ -710,7 +733,7 @@ export interface SynchronizedDatasetStatistics {
             [k: string]: string[];
         };
     };
-    dataset_statistics?: {
+    dataset_statistics: {
         [k: string]: (JointDataStats | CameraDataStats | PoseDataStats | EndEffectorPoseDataStats | ParallelGripperOpenAmountDataStats | PointCloudDataStats | LanguageDataStats | Custom1DDataStats)[];
     };
 }
@@ -731,9 +754,9 @@ export interface SynchronizedEpisode {
  * and ensuring consistent data relationships across different sensors.
  */
 export interface SynchronizedPoint {
-    timestamp?: number;
+    timestamp: number;
     robot_id?: string | null;
-    data?: {
+    data: {
         [k: string]: {
             [k: string]: JointData | RGBCameraData | DepthCameraData | PoseData | EndEffectorPoseData | ParallelGripperOpenAmountData | PointCloudData | LanguageData | Custom1DData;
         };
@@ -781,23 +804,23 @@ export interface TrainingJob {
     launch_time: number;
     start_time?: number | null;
     end_time?: number | null;
-    epoch?: number;
-    step?: number;
-    algorithm_config?: {
+    epoch: number;
+    step: number;
+    algorithm_config: {
         [k: string]: unknown;
     };
-    gpu_type?: GPUType1;
-    num_gpus?: number;
+    gpu_type: GPUType1;
+    num_gpus: number;
     resumed_at?: number | null;
     previous_training_time?: number | null;
     error?: string | null;
-    resume_points?: number[];
-    input_robot_data_spec?: {
+    resume_points: number[];
+    input_robot_data_spec: {
         [k: string]: {
             [k: string]: string[];
         };
     };
-    output_robot_data_spec?: {
+    output_robot_data_spec: {
         [k: string]: {
             [k: string]: string[];
         };
@@ -935,6 +958,25 @@ export declare enum VideoFormat {
 export declare enum Type13 {
     ParallelGripperOpenAmountData = "ParallelGripperOpenAmountData"
 }
+/**
+ * Recording status options.
+ */
+export declare enum RecordingStatus {
+    NORMAL = "NORMAL",
+    FLAGGED = "FLAGGED"
+}
+/**
+ * Pending recording status.
+ *
+ * STARTED: recording in progress.
+ * UPLOADING: at least one trace has upload_progress between 0 and 99.
+ * UPLOADED: all traces are completely uploaded.
+ */
+export declare enum PendingRecordingStatus {
+    STARTED = "STARTED",
+    UPLOADING = "UPLOADING",
+    UPLOADED = "UPLOADED"
+}
 export declare enum Type14 {
     PointCloudData = "PointCloudData"
 }
@@ -945,17 +987,10 @@ export declare enum Type16 {
     RGBCameraData = "RGBCameraData"
 }
 /**
- * Recording status options.
+ * Status for a recording data trace upload lifecycle.
  */
-export declare enum RecordingStatus {
-    normal = "normal",
-    flagged = "flagged"
-}
-/**
- * Status for a recording data stream upload lifecycle.
- */
-export declare enum RecordingDataStreamStatus {
-    PENDING = "PENDING",
+export declare enum RecordingDataTraceStatus {
+    QUEUED = "QUEUED",
     UPLOAD_STARTED = "UPLOAD_STARTED",
     UPLOAD_COMPLETE = "UPLOAD_COMPLETE"
 }

package/dist/neuracore_types.js

@@ -6,7 +6,7 @@
 /* Do not modify it by hand - just update the pydantic models and then re-run the script
 */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GPUType1 = exports.TrainingJobStatus = exports.RecordingNotificationType = exports.RecordingDataStreamStatus = exports.RecordingStatus = exports.Type16 = exports.Type15 = exports.Type14 = exports.Type13 = exports.VideoFormat = exports.Type12 = exports.Type11 = exports.Type10 = exports.Type9 = exports.Type8 = exports.Type7 = exports.Type6 = exports.GPUType = exports.MessageType = exports.Type5 = exports.Type4 = exports.Type3 = exports.Type2 = exports.Type1 = exports.Type = exports.DataType = void 0;
+exports.GPUType1 = exports.TrainingJobStatus = exports.RecordingNotificationType = exports.RecordingDataTraceStatus = exports.Type16 = exports.Type15 = exports.Type14 = exports.PendingRecordingStatus = exports.RecordingStatus = exports.Type13 = exports.VideoFormat = exports.Type12 = exports.Type11 = exports.Type10 = exports.Type9 = exports.Type8 = exports.Type7 = exports.Type6 = exports.GPUType = exports.MessageType = exports.Type5 = exports.Type4 = exports.Type3 = exports.Type2 = exports.Type1 = exports.Type = exports.DataType = void 0;
 /**
  * Enumeration of supported data types in the Neuracore system.
  *
@@ -119,6 +119,27 @@ var Type13;
 (function (Type13) {
     Type13["ParallelGripperOpenAmountData"] = "ParallelGripperOpenAmountData";
 })(Type13 || (exports.Type13 = Type13 = {}));
+/**
+ * Recording status options.
+ */
+var RecordingStatus;
+(function (RecordingStatus) {
+    RecordingStatus["NORMAL"] = "NORMAL";
+    RecordingStatus["FLAGGED"] = "FLAGGED";
+})(RecordingStatus || (exports.RecordingStatus = RecordingStatus = {}));
+/**
+ * Pending recording status.
+ *
+ * STARTED: recording in progress.
+ * UPLOADING: at least one trace has upload_progress between 0 and 99.
+ * UPLOADED: all traces are completely uploaded.
+ */
+var PendingRecordingStatus;
+(function (PendingRecordingStatus) {
+    PendingRecordingStatus["STARTED"] = "STARTED";
+    PendingRecordingStatus["UPLOADING"] = "UPLOADING";
+    PendingRecordingStatus["UPLOADED"] = "UPLOADED";
+})(PendingRecordingStatus || (exports.PendingRecordingStatus = PendingRecordingStatus = {}));
 var Type14;
 (function (Type14) {
     Type14["PointCloudData"] = "PointCloudData";
@@ -132,22 +153,14 @@ var Type16;
     Type16["RGBCameraData"] = "RGBCameraData";
 })(Type16 || (exports.Type16 = Type16 = {}));
 /**
- * Recording status options.
- */
-var RecordingStatus;
-(function (RecordingStatus) {
-    RecordingStatus["normal"] = "normal";
-    RecordingStatus["flagged"] = "flagged";
-})(RecordingStatus || (exports.RecordingStatus = RecordingStatus = {}));
-/**
- * Status for a recording data stream upload lifecycle.
+ * Status for a recording data trace upload lifecycle.
  */
-var RecordingDataStreamStatus;
-(function (RecordingDataStreamStatus) {
-    RecordingDataStreamStatus["PENDING"] = "PENDING";
-    RecordingDataStreamStatus["UPLOAD_STARTED"] = "UPLOAD_STARTED";
-    RecordingDataStreamStatus["UPLOAD_COMPLETE"] = "UPLOAD_COMPLETE";
-})(RecordingDataStreamStatus || (exports.RecordingDataStreamStatus = RecordingDataStreamStatus = {}));
+var RecordingDataTraceStatus;
+(function (RecordingDataTraceStatus) {
+    RecordingDataTraceStatus["QUEUED"] = "QUEUED";
+    RecordingDataTraceStatus["UPLOAD_STARTED"] = "UPLOAD_STARTED";
+    RecordingDataTraceStatus["UPLOAD_COMPLETE"] = "UPLOAD_COMPLETE";
+})(RecordingDataTraceStatus || (exports.RecordingDataTraceStatus = RecordingDataTraceStatus = {}));
 /**
  * Types of recording lifecycle notifications.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neuracore/types",
-  "version": "3.0.0",
+  "version": "4.1.0",
   "description": "Shared TypeScript type definitions for Neuracore robotics platform",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",