@neuracore/types 3.0.0 → 4.0.0

package/dist/neuracore_types.d.ts

@@ -485,6 +485,41 @@ export interface ParallelGripperOpenAmountData {
     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.
  *
@@ -554,32 +589,20 @@ export interface Recording {
     data_types?: DataType[];
 }
 /**
- * Metadata details for a recording.
+ * Represents a single data trace belonging to a recording.
  *
- * Attributes:
- *     name: Name of the recording.
- *     notes: Optional notes about the recording.
- *     status: Current RecordingStatus of the recording
+ * This is used to track upload completion for each trace so that
+ * a recording can be saved once all traces are uploaded.
  */
-export interface RecordingMetadata {
-    name?: string;
-    notes?: string;
-    status?: RecordingStatus;
-}
-/**
- * Represents a single data stream 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.
- */
-export interface RecordingDataStream {
+export interface RecordingDataTrace {
     id: string;
     recording_id: string;
     data_type: DataType;
-    status?: RecordingDataStreamStatus;
-    upload_progress: number;
+    status?: RecordingDataTraceStatus;
     created_at?: number;
     uploaded_at: number | null;
+    uploaded_bytes?: number;
+    total_bytes?: number;
 }
 /**
  * Notification message for recording lifecycle events.
@@ -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.0.0",
   "description": "Shared TypeScript type definitions for Neuracore robotics platform",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",