@atlasnpm/atlas-api-helper 0.2.12 → 0.2.13

package/README.md

@@ -45,6 +45,14 @@ interface ClientOptions {
 }
 ```
 
+## Service Operations
+
+```ts
+getRoot(): Promise<JsonRecord>
+getHealth(): Promise<JsonRecord>
+getReadiness(): Promise<JsonRecord>
+```
+
 ## Entity Operations
 
 ### Creating Entities
@@ -207,10 +215,10 @@ await client.failTask("mission-2", "Calibration failed", { code: "CAL-01" });
 
 | Method | Description |
 |--------|-------------|
-| `listTasks(limit?, status?)` | List tasks with optional status filter (default limit: 25) |
+| `listTasks(limit?, status?, offset?)` | List tasks with optional status filter (default limit: 25) and offset (default: 0) |
 | `getTask(taskId)` | Get task by ID |
 | `deleteTask(taskId)` | Delete a task |
-| `getTasksByEntity(entityId, limit?, status?)` | Get tasks for an entity |
+| `getTasksByEntity(entityId, limit?, status?, offset?)` | Get tasks for an entity with optional offset (default: 0) |
 
 ## Object Operations
 
@@ -234,6 +242,24 @@ const stored = await client.createObject(videoBlob, "mission-video", "mission_re
 ]);
 ```
 
+### Creating Object Metadata
+
+```ts
+createObjectMetadata(
+  objectId: string,
+  options?: {
+    path?: string;
+    bucket?: string;
+    size_bytes?: number;
+    content_type?: string;
+    type?: string;
+    usage_hints?: string[];
+    referenced_by?: Array<{ entity_id?: string; task_id?: string }>;
+    extra?: JsonRecord;
+  }
+): Promise<StoredObject>
+```
+
 ### Updating Object Metadata
 
 ```ts
@@ -269,9 +295,10 @@ await client.updateObject("mission-video", ["final_recording", "approved"], [
 |--------|-------------|
 | `listObjects(limit?, offset?, contentType?, type?)` | List objects with filters |
 | `getObject(objectId)` | Get object by ID |
+| `viewObject(objectId)` | Fetch viewable object content inline |
 | `deleteObject(objectId)` | Delete an object |
-| `getObjectsByEntity(entityId, limit?)` | Get objects referenced by an entity |
-| `getObjectsByTask(taskId, limit?)` | Get objects referenced by a task |
+| `getObjectsByEntity(entityId, limit?, offset?)` | Get objects referenced by an entity |
+| `getObjectsByTask(taskId, limit?, offset?)` | Get objects referenced by a task |
 | `findOrphanedObjects(limit?)` | Find objects with no references |
 
 ## Query Operations

package/dist/index.cjs

@@ -48,22 +48,34 @@ function validateEntityComponents(components) {
   }
 }
 function stripNulls(obj) {
-  const result = {};
-  for (const [key, value] of Object.entries(obj)) {
+  const stripValue = (value) => {
     if (value === null || value === void 0) {
-      continue;
+      return void 0;
     }
     if (Array.isArray(value)) {
-      result[key] = value.map(
-        (item) => typeof item === "object" && item !== null ? stripNulls(item) : item
-      );
-    } else if (typeof value === "object") {
-      result[key] = stripNulls(value);
-    } else {
-      result[key] = value;
+      return value.map((item) => {
+        if (item === null || item === void 0) {
+          return item;
+        }
+        return stripValue(item);
+      });
     }
-  }
-  return result;
+    if (typeof value === "object") {
+      const nested = {};
+      for (const [key, innerValue] of Object.entries(value)) {
+        if (innerValue === null || innerValue === void 0) {
+          continue;
+        }
+        const stripped = stripValue(innerValue);
+        if (stripped !== void 0) {
+          nested[key] = stripped;
+        }
+      }
+      return nested;
+    }
+    return value;
+  };
+  return stripValue(obj);
 }
 function componentsToRecord(components) {
   if (components === void 0) {
@@ -137,6 +149,16 @@ var AtlasHttpClient = class {
     }
     return await response.json();
   }
+  // Service ------------------------------------------------------------------
+  getRoot() {
+    return this.request("GET", "/");
+  }
+  getHealth() {
+    return this.request("GET", "/health");
+  }
+  getReadiness() {
+    return this.request("GET", "/readiness");
+  }
   // Entities ------------------------------------------------------------------
   listEntities(limit = 100, offset = 0) {
     return this.request("GET", "/entities", null, { limit, offset });
@@ -185,16 +207,24 @@ var AtlasHttpClient = class {
     return this.request("PATCH", `/entities/${entityId}/telemetry`, payload);
   }
   checkinEntity(entityId, telemetry, options) {
+    const payload = { ...telemetry };
+    if (options?.status !== void 0) {
+      payload.status = options.status;
+    }
     const params = {
       status_filter: options?.status_filter ?? "pending,in_progress",
       limit: options?.limit ?? 10,
       since: options?.since
     };
-    return this.request("POST", `/entities/${entityId}/checkin`, telemetry, params);
+    return this.request("POST", `/entities/${entityId}/checkin`, payload, params);
   }
   // Tasks ---------------------------------------------------------------------
-  listTasks(limit = 25, status) {
-    return this.request("GET", "/tasks", null, { limit, status });
+  listTasks(limit = 25, status, offset = 0) {
+    return this.request("GET", "/tasks", null, {
+      limit,
+      status,
+      offset
+    });
   }
   getTask(taskId) {
     return this.request("GET", `/tasks/${taskId}`);
@@ -225,8 +255,12 @@ var AtlasHttpClient = class {
   deleteTask(taskId) {
     return this.request("DELETE", `/tasks/${taskId}`);
   }
-  getTasksByEntity(entityId, limit = 25, status) {
-    return this.request("GET", `/entities/${entityId}/tasks`, null, { limit, status });
+  getTasksByEntity(entityId, limit = 25, status, offset = 0) {
+    return this.request("GET", `/entities/${entityId}/tasks`, null, {
+      limit,
+      status,
+      offset
+    });
   }
   startTask(taskId) {
     return this.request("POST", `/tasks/${taskId}/start`, {});
@@ -267,6 +301,21 @@ var AtlasHttpClient = class {
     const contentLength = lengthHeader && !Number.isNaN(Number(lengthHeader)) ? Number(lengthHeader) : void 0;
     return { data: new Uint8Array(buffer), contentType, contentLength };
   }
+  async viewObject(objectId) {
+    const url = new URL(`${this.baseUrl}/objects/${objectId}/view`);
+    const response = await this.fetchImpl(url.toString(), {
+      method: "GET",
+      headers: this.headers()
+    });
+    if (!response.ok) {
+      const detail = await response.text();
+      throw new Error(`HTTP ${response.status}: ${detail}`);
+    }
+    const contentType = response.headers.get("content-type") || void 0;
+    const lengthHeader = response.headers.get("content-length");
+    const contentLength = lengthHeader && !Number.isNaN(Number(lengthHeader)) ? Number(lengthHeader) : void 0;
+    return { data: await response.text(), contentType, contentLength };
+  }
   listObjects(limit = 100, offset = 0, contentType, type) {
     return this.request("GET", "/objects", null, { limit, offset, content_type: contentType, type });
   }
@@ -274,6 +323,10 @@ var AtlasHttpClient = class {
     return this.request("GET", `/objects/${objectId}`);
   }
   async createObject(file, objectId, usageHint, referencedBy) {
+    const contentType = "type" in file ? file.type : "";
+    if (!contentType) {
+      throw new Error("AtlasHttpClient.createObject requires a content type.");
+    }
     const formData = new FormData();
     formData.append("object_id", objectId);
     const filename = file.name ?? "upload.bin";
@@ -294,10 +347,26 @@ var AtlasHttpClient = class {
     }
     return stored;
   }
+  createObjectMetadata(objectId, options) {
+    const payload = {
+      object_id: objectId,
+      path: options?.path,
+      bucket: options?.bucket,
+      size_bytes: options?.size_bytes,
+      content_type: options?.content_type,
+      type: options?.type,
+      usage_hints: options?.usage_hints,
+      referenced_by: options?.referenced_by,
+      extra: options?.extra
+    };
+    return this.request("POST", "/objects", payload);
+  }
   updateObject(objectId, usageHints, referencedBy) {
     if (usageHints === void 0 && referencedBy === void 0) {
-      throw new Error(
-        "AtlasHttpClient.updateObject requires usageHints or referencedBy to make an update."
+      return Promise.reject(
+        new Error(
+          "AtlasHttpClient.updateObject requires usageHints or referencedBy to make an update."
+        )
       );
     }
     const payload = {};
@@ -308,11 +377,11 @@ var AtlasHttpClient = class {
   deleteObject(objectId) {
     return this.request("DELETE", `/objects/${objectId}`);
   }
-  getObjectsByEntity(entityId, limit = 50) {
-    return this.request("GET", `/entities/${entityId}/objects`, null, { limit });
+  getObjectsByEntity(entityId, limit = 50, offset = 0) {
+    return this.request("GET", `/entities/${entityId}/objects`, null, { limit, offset });
   }
-  getObjectsByTask(taskId, limit = 50) {
-    return this.request("GET", `/tasks/${taskId}/objects`, null, { limit });
+  getObjectsByTask(taskId, limit = 50, offset = 0) {
+    return this.request("GET", `/tasks/${taskId}/objects`, null, { limit, offset });
   }
   addObjectReference(objectId, entityId, taskId) {
     const payload = {};

package/dist/index.d.cts

@@ -359,6 +359,9 @@ declare class AtlasHttpClient {
     private multipartHeaders;
     private request;
     private multipartRequest;
+    getRoot(): Promise<unknown>;
+    getHealth(): Promise<unknown>;
+    getReadiness(): Promise<unknown>;
     listEntities(limit?: number, offset?: number): Promise<unknown>;
     getEntity(entityId: string): Promise<unknown>;
     getEntityByAlias(alias: string): Promise<unknown>;
@@ -381,11 +384,12 @@ declare class AtlasHttpClient {
         speed_m_s?: number;
         heading_deg?: number;
     }, options?: {
+        status?: string;
         status_filter?: string;
         limit?: number;
         since?: string;
     }): Promise<unknown>;
-    listTasks(limit?: number, status?: string): Promise<unknown>;
+    listTasks(limit?: number, status?: string, offset?: number): Promise<unknown>;
     getTask(taskId: string): Promise<unknown>;
     createTask(taskId: string, components?: TaskComponents | JsonRecord, options?: {
         status?: string;
@@ -398,7 +402,7 @@ declare class AtlasHttpClient {
         extra?: JsonRecord;
     }): Promise<unknown>;
     deleteTask(taskId: string): Promise<unknown>;
-    getTasksByEntity(entityId: string, limit?: number, status?: string): Promise<unknown>;
+    getTasksByEntity(entityId: string, limit?: number, status?: string, offset?: number): Promise<unknown>;
     startTask(taskId: string): Promise<unknown>;
     completeTask(taskId: string, result?: JsonRecord): Promise<unknown>;
     transitionTaskStatus(taskId: string, status: string, options?: {
@@ -411,19 +415,37 @@ declare class AtlasHttpClient {
         contentType?: string;
         contentLength?: number;
     }>;
+    viewObject(objectId: string): Promise<{
+        data: string;
+        contentType?: string;
+        contentLength?: number;
+    }>;
     listObjects(limit?: number, offset?: number, contentType?: string, type?: string): Promise<unknown>;
     getObject(objectId: string): Promise<unknown>;
     createObject(file: Blob | File, objectId: string, usageHint?: string, referencedBy?: Array<{
         entity_id?: string;
         task_id?: string;
     }>): Promise<JsonRecord>;
+    createObjectMetadata(objectId: string, options?: {
+        path?: string;
+        bucket?: string;
+        size_bytes?: number;
+        content_type?: string;
+        type?: string;
+        usage_hints?: string[];
+        referenced_by?: Array<{
+            entity_id?: string;
+            task_id?: string;
+        }>;
+        extra?: JsonRecord;
+    }): Promise<unknown>;
     updateObject(objectId: string, usageHints?: string[], referencedBy?: Array<{
         entity_id?: string;
         task_id?: string;
     }>): Promise<unknown>;
     deleteObject(objectId: string): Promise<unknown>;
-    getObjectsByEntity(entityId: string, limit?: number): Promise<unknown>;
-    getObjectsByTask(taskId: string, limit?: number): Promise<unknown>;
+    getObjectsByEntity(entityId: string, limit?: number, offset?: number): Promise<unknown>;
+    getObjectsByTask(taskId: string, limit?: number, offset?: number): Promise<unknown>;
     addObjectReference(objectId: string, entityId?: string, taskId?: string): Promise<unknown>;
     removeObjectReference(objectId: string, entityId?: string, taskId?: string): Promise<unknown>;
     findOrphanedObjects(limit?: number): Promise<unknown>;

package/dist/index.d.ts

@@ -359,6 +359,9 @@ declare class AtlasHttpClient {
     private multipartHeaders;
     private request;
     private multipartRequest;
+    getRoot(): Promise<unknown>;
+    getHealth(): Promise<unknown>;
+    getReadiness(): Promise<unknown>;
     listEntities(limit?: number, offset?: number): Promise<unknown>;
     getEntity(entityId: string): Promise<unknown>;
     getEntityByAlias(alias: string): Promise<unknown>;
@@ -381,11 +384,12 @@ declare class AtlasHttpClient {
         speed_m_s?: number;
         heading_deg?: number;
     }, options?: {
+        status?: string;
         status_filter?: string;
         limit?: number;
         since?: string;
     }): Promise<unknown>;
-    listTasks(limit?: number, status?: string): Promise<unknown>;
+    listTasks(limit?: number, status?: string, offset?: number): Promise<unknown>;
     getTask(taskId: string): Promise<unknown>;
     createTask(taskId: string, components?: TaskComponents | JsonRecord, options?: {
         status?: string;
@@ -398,7 +402,7 @@ declare class AtlasHttpClient {
         extra?: JsonRecord;
     }): Promise<unknown>;
     deleteTask(taskId: string): Promise<unknown>;
-    getTasksByEntity(entityId: string, limit?: number, status?: string): Promise<unknown>;
+    getTasksByEntity(entityId: string, limit?: number, status?: string, offset?: number): Promise<unknown>;
     startTask(taskId: string): Promise<unknown>;
     completeTask(taskId: string, result?: JsonRecord): Promise<unknown>;
     transitionTaskStatus(taskId: string, status: string, options?: {
@@ -411,19 +415,37 @@ declare class AtlasHttpClient {
         contentType?: string;
         contentLength?: number;
     }>;
+    viewObject(objectId: string): Promise<{
+        data: string;
+        contentType?: string;
+        contentLength?: number;
+    }>;
     listObjects(limit?: number, offset?: number, contentType?: string, type?: string): Promise<unknown>;
     getObject(objectId: string): Promise<unknown>;
     createObject(file: Blob | File, objectId: string, usageHint?: string, referencedBy?: Array<{
         entity_id?: string;
         task_id?: string;
     }>): Promise<JsonRecord>;
+    createObjectMetadata(objectId: string, options?: {
+        path?: string;
+        bucket?: string;
+        size_bytes?: number;
+        content_type?: string;
+        type?: string;
+        usage_hints?: string[];
+        referenced_by?: Array<{
+            entity_id?: string;
+            task_id?: string;
+        }>;
+        extra?: JsonRecord;
+    }): Promise<unknown>;
     updateObject(objectId: string, usageHints?: string[], referencedBy?: Array<{
         entity_id?: string;
         task_id?: string;
     }>): Promise<unknown>;
     deleteObject(objectId: string): Promise<unknown>;
-    getObjectsByEntity(entityId: string, limit?: number): Promise<unknown>;
-    getObjectsByTask(taskId: string, limit?: number): Promise<unknown>;
+    getObjectsByEntity(entityId: string, limit?: number, offset?: number): Promise<unknown>;
+    getObjectsByTask(taskId: string, limit?: number, offset?: number): Promise<unknown>;
     addObjectReference(objectId: string, entityId?: string, taskId?: string): Promise<unknown>;
     removeObjectReference(objectId: string, entityId?: string, taskId?: string): Promise<unknown>;
     findOrphanedObjects(limit?: number): Promise<unknown>;

package/dist/index.js

@@ -20,22 +20,34 @@ function validateEntityComponents(components) {
   }
 }
 function stripNulls(obj) {
-  const result = {};
-  for (const [key, value] of Object.entries(obj)) {
+  const stripValue = (value) => {
     if (value === null || value === void 0) {
-      continue;
+      return void 0;
     }
     if (Array.isArray(value)) {
-      result[key] = value.map(
-        (item) => typeof item === "object" && item !== null ? stripNulls(item) : item
-      );
-    } else if (typeof value === "object") {
-      result[key] = stripNulls(value);
-    } else {
-      result[key] = value;
+      return value.map((item) => {
+        if (item === null || item === void 0) {
+          return item;
+        }
+        return stripValue(item);
+      });
     }
-  }
-  return result;
+    if (typeof value === "object") {
+      const nested = {};
+      for (const [key, innerValue] of Object.entries(value)) {
+        if (innerValue === null || innerValue === void 0) {
+          continue;
+        }
+        const stripped = stripValue(innerValue);
+        if (stripped !== void 0) {
+          nested[key] = stripped;
+        }
+      }
+      return nested;
+    }
+    return value;
+  };
+  return stripValue(obj);
 }
 function componentsToRecord(components) {
   if (components === void 0) {
@@ -109,6 +121,16 @@ var AtlasHttpClient = class {
     }
     return await response.json();
   }
+  // Service ------------------------------------------------------------------
+  getRoot() {
+    return this.request("GET", "/");
+  }
+  getHealth() {
+    return this.request("GET", "/health");
+  }
+  getReadiness() {
+    return this.request("GET", "/readiness");
+  }
   // Entities ------------------------------------------------------------------
   listEntities(limit = 100, offset = 0) {
     return this.request("GET", "/entities", null, { limit, offset });
@@ -157,16 +179,24 @@ var AtlasHttpClient = class {
     return this.request("PATCH", `/entities/${entityId}/telemetry`, payload);
   }
   checkinEntity(entityId, telemetry, options) {
+    const payload = { ...telemetry };
+    if (options?.status !== void 0) {
+      payload.status = options.status;
+    }
     const params = {
       status_filter: options?.status_filter ?? "pending,in_progress",
       limit: options?.limit ?? 10,
       since: options?.since
     };
-    return this.request("POST", `/entities/${entityId}/checkin`, telemetry, params);
+    return this.request("POST", `/entities/${entityId}/checkin`, payload, params);
   }
   // Tasks ---------------------------------------------------------------------
-  listTasks(limit = 25, status) {
-    return this.request("GET", "/tasks", null, { limit, status });
+  listTasks(limit = 25, status, offset = 0) {
+    return this.request("GET", "/tasks", null, {
+      limit,
+      status,
+      offset
+    });
   }
   getTask(taskId) {
     return this.request("GET", `/tasks/${taskId}`);
@@ -197,8 +227,12 @@ var AtlasHttpClient = class {
   deleteTask(taskId) {
     return this.request("DELETE", `/tasks/${taskId}`);
   }
-  getTasksByEntity(entityId, limit = 25, status) {
-    return this.request("GET", `/entities/${entityId}/tasks`, null, { limit, status });
+  getTasksByEntity(entityId, limit = 25, status, offset = 0) {
+    return this.request("GET", `/entities/${entityId}/tasks`, null, {
+      limit,
+      status,
+      offset
+    });
   }
   startTask(taskId) {
     return this.request("POST", `/tasks/${taskId}/start`, {});
@@ -239,6 +273,21 @@ var AtlasHttpClient = class {
     const contentLength = lengthHeader && !Number.isNaN(Number(lengthHeader)) ? Number(lengthHeader) : void 0;
     return { data: new Uint8Array(buffer), contentType, contentLength };
   }
+  async viewObject(objectId) {
+    const url = new URL(`${this.baseUrl}/objects/${objectId}/view`);
+    const response = await this.fetchImpl(url.toString(), {
+      method: "GET",
+      headers: this.headers()
+    });
+    if (!response.ok) {
+      const detail = await response.text();
+      throw new Error(`HTTP ${response.status}: ${detail}`);
+    }
+    const contentType = response.headers.get("content-type") || void 0;
+    const lengthHeader = response.headers.get("content-length");
+    const contentLength = lengthHeader && !Number.isNaN(Number(lengthHeader)) ? Number(lengthHeader) : void 0;
+    return { data: await response.text(), contentType, contentLength };
+  }
   listObjects(limit = 100, offset = 0, contentType, type) {
     return this.request("GET", "/objects", null, { limit, offset, content_type: contentType, type });
   }
@@ -246,6 +295,10 @@ var AtlasHttpClient = class {
     return this.request("GET", `/objects/${objectId}`);
   }
   async createObject(file, objectId, usageHint, referencedBy) {
+    const contentType = "type" in file ? file.type : "";
+    if (!contentType) {
+      throw new Error("AtlasHttpClient.createObject requires a content type.");
+    }
     const formData = new FormData();
     formData.append("object_id", objectId);
     const filename = file.name ?? "upload.bin";
@@ -266,10 +319,26 @@ var AtlasHttpClient = class {
     }
     return stored;
   }
+  createObjectMetadata(objectId, options) {
+    const payload = {
+      object_id: objectId,
+      path: options?.path,
+      bucket: options?.bucket,
+      size_bytes: options?.size_bytes,
+      content_type: options?.content_type,
+      type: options?.type,
+      usage_hints: options?.usage_hints,
+      referenced_by: options?.referenced_by,
+      extra: options?.extra
+    };
+    return this.request("POST", "/objects", payload);
+  }
   updateObject(objectId, usageHints, referencedBy) {
     if (usageHints === void 0 && referencedBy === void 0) {
-      throw new Error(
-        "AtlasHttpClient.updateObject requires usageHints or referencedBy to make an update."
+      return Promise.reject(
+        new Error(
+          "AtlasHttpClient.updateObject requires usageHints or referencedBy to make an update."
+        )
       );
     }
     const payload = {};
@@ -280,11 +349,11 @@ var AtlasHttpClient = class {
   deleteObject(objectId) {
     return this.request("DELETE", `/objects/${objectId}`);
   }
-  getObjectsByEntity(entityId, limit = 50) {
-    return this.request("GET", `/entities/${entityId}/objects`, null, { limit });
+  getObjectsByEntity(entityId, limit = 50, offset = 0) {
+    return this.request("GET", `/entities/${entityId}/objects`, null, { limit, offset });
   }
-  getObjectsByTask(taskId, limit = 50) {
-    return this.request("GET", `/tasks/${taskId}/objects`, null, { limit });
+  getObjectsByTask(taskId, limit = 50, offset = 0) {
+    return this.request("GET", `/tasks/${taskId}/objects`, null, { limit, offset });
   }
   addObjectReference(objectId, entityId, taskId) {
     const payload = {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlasnpm/atlas-api-helper",
-  "version": "0.2.12",
+  "version": "0.2.13",
   "type": "module",
   "description": "HTTP client for the Atlas Command REST API.",
   "license": "MIT",