@atlasnpm/atlas-api-helper 0.2.5 → 0.2.6

package/README.md

@@ -1,7 +1,5 @@
 # Atlas Command HTTP Client (TypeScript)
 
-`@atlasnpm/atlas-api-helper` has been updated to version 0.2.4 with a comprehensive HTTP client for the Atlas Command REST API. This version now includes full API parity with the Python `atlas_asset_ws_client` package.
-
 ## Installation
 
 ```bash
@@ -22,12 +20,12 @@ const client = new AtlasHttpClient({
 const entities = await client.listEntities();
 console.log("Entities", entities);
 
-await client.createEntity("asset-1", "asset", "Surveyor One", {
+await client.createEntity("asset-1", "asset", "Surveyor One", "drone", {
   telemetry: { latitude: 40.7, longitude: -74.0 },
 });
 await client.createTask("survey-1", { parameters: { latitude: 40.7, longitude: -74.0 } });
 
-// New API methods (version 0.2.1)
+// Entity telemetry updates
 const entity = await client.getEntityByAlias("drone-1");
 await client.updateEntityTelemetry("drone-1", {
   latitude: 40.7128,
@@ -46,7 +44,7 @@ await client.failTask("task-2", "Calibration failed", { code: "CAL-01" });
 const stored = await client.createObject(videoBlob, "mission-video", "mission_video", [
   { entity_id: "asset-1" },
 ]);
-await client.addObjectReference(stored.object_id, undefined, "task-1");
+await client.addObjectReference(stored["object_id"] as string, undefined, "task-1");
 await client.updateObject("mission-video", ["mission_video"], [
   { task_id: "task-1" },
 ]);
@@ -67,7 +65,7 @@ The client now exposes comprehensive helpers for every HTTP endpoint, matching t
 - `listEntities(limit?, offset?)` - List all entities with pagination
 - `getEntity(entityId)` - Get a specific entity by ID
 - `getEntityByAlias(alias)` - Get entity by alias (NEW in 0.2.1)
-- `createEntity(entityId, entityType, alias, components?)` - Create a new entity
+- `createEntity(entityId, entityType, alias, subtype, components?)` - Create a new entity
 - `updateEntity(entityId, components)` - Update an existing entity (components payload required)
 - `deleteEntity(entityId)` - Delete an entity
 - `updateEntityTelemetry(entityId, telemetry)` - Update entity telemetry with specific parameters (NEW in 0.2.1)
@@ -139,18 +137,6 @@ npm run test
 
 The build produces both ESM and CJS bundles plus `.d.ts` type definitions via `tsup`.
 
-## Version 0.2.1 Changes
-
-This update brings the TypeScript client to full feature parity with the Python `atlas_asset_ws_client` package:
-
-- ✅ Added `getEntityByAlias` method
-- ✅ Added `updateEntityTelemetry` with specific telemetry parameters
-- ✅ Added task lifecycle methods: `startTask`, `completeTask`, `failTask`
-- ✅ Added query methods: `getChangedSince`, `getFullDataset`
-- ✅ Enhanced type system with comprehensive interfaces
-- ✅ Updated to match Python API signatures and behavior
-- ✅ Version bump to 0.2.1 to match Python package
-
 ## Publishing
 
-Publishing is handled by `.github/workflows/publish-controller-websocket-client.yml`. The artifact now contains the comprehensive HTTP client described above. Ensure the `@atlasnpm` scope and automation token are set up as documented in the workflow README before triggering a release.
+Publishing is handled by `.github/workflows/publish-atlas-api-helper.yml`. The artifact now contains the comprehensive HTTP client described above. Ensure the `@atlasnpm` scope and automation token are set up as documented in the workflow README before triggering a release.

package/dist/index.cjs

@@ -99,20 +99,24 @@ var AtlasHttpClient = class {
   getEntityByAlias(alias) {
     return this.request("GET", `/entities/alias/${alias}`);
   }
-  createEntity(entityId, entityType, alias, components) {
+  createEntity(entityId, entityType, alias, subtype, components) {
     const payload = {
       entity_id: entityId,
       entity_type: entityType,
-      alias
+      alias,
+      subtype
     };
     if (components !== void 0) payload.components = components;
     return this.request("POST", "/entities", payload);
   }
-  updateEntity(entityId, components) {
-    if (components === void 0) {
-      throw new Error("AtlasHttpClient.updateEntity requires a components payload.");
+  updateEntity(entityId, components, options) {
+    if (components === void 0 && options?.subtype === void 0) {
+      throw new Error("AtlasHttpClient.updateEntity requires a components payload or subtype.");
     }
-    return this.request("PATCH", `/entities/${entityId}`, { components });
+    const payload = {};
+    if (components !== void 0) payload.components = components;
+    if (options?.subtype !== void 0) payload.subtype = options.subtype;
+    return this.request("PATCH", `/entities/${entityId}`, payload);
   }
   deleteEntity(entityId) {
     return this.request("DELETE", `/entities/${entityId}`);
@@ -133,19 +137,28 @@ var AtlasHttpClient = class {
   getTask(taskId) {
     return this.request("GET", `/tasks/${taskId}`);
   }
-  createTask(taskId, components) {
+  createTask(taskId, components, options) {
     const payload = {
       task_id: taskId,
-      status: "pending"
+      status: options?.status || "pending"
     };
+    if (options?.entity_id !== void 0) payload.entity_id = options.entity_id;
     if (components !== void 0) payload.components = components;
+    if (options?.extra !== void 0) payload.extra = options.extra;
     return this.request("POST", "/tasks", payload);
   }
-  updateTask(taskId, components) {
-    if (components === void 0) {
-      throw new Error("AtlasHttpClient.updateTask requires a components payload.");
+  updateTask(taskId, components, options) {
+    if (components === void 0 && options === void 0) {
+      throw new Error(
+        "AtlasHttpClient.updateTask requires a components payload or options."
+      );
     }
-    return this.request("PATCH", `/tasks/${taskId}`, { components });
+    const payload = {};
+    if (components !== void 0) payload.components = components;
+    if (options?.status !== void 0) payload.status = options.status;
+    if (options?.entity_id !== void 0) payload.entity_id = options.entity_id;
+    if (options?.extra !== void 0) payload.extra = options.extra;
+    return this.request("PATCH", `/tasks/${taskId}`, payload);
   }
   deleteTask(taskId) {
     return this.request("DELETE", `/tasks/${taskId}`);
@@ -166,8 +179,8 @@ var AtlasHttpClient = class {
     return this.request("POST", `/tasks/${taskId}/fail`, payload);
   }
   // Objects -------------------------------------------------------------------
-  listObjects(limit = 100, offset = 0, contentType) {
-    return this.request("GET", "/objects", null, { limit, offset, content_type: contentType });
+  listObjects(limit = 100, offset = 0, contentType, type) {
+    return this.request("GET", "/objects", null, { limit, offset, content_type: contentType, type });
   }
   getObject(objectId) {
     return this.request("GET", `/objects/${objectId}`);

package/dist/index.d.cts

@@ -19,8 +19,10 @@ declare class AtlasHttpClient {
     listEntities(limit?: number, offset?: number): Promise<unknown>;
     getEntity(entityId: string): Promise<unknown>;
     getEntityByAlias(alias: string): Promise<unknown>;
-    createEntity(entityId: string, entityType: string, alias: string, components?: JsonRecord): Promise<unknown>;
-    updateEntity(entityId: string, components?: JsonRecord): Promise<unknown>;
+    createEntity(entityId: string, entityType: string, alias: string, subtype: string, components?: JsonRecord): Promise<unknown>;
+    updateEntity(entityId: string, components?: JsonRecord, options?: {
+        subtype?: string;
+    }): Promise<unknown>;
     deleteEntity(entityId: string): Promise<unknown>;
     updateEntityTelemetry(entityId: string, options: {
         latitude?: number;
@@ -31,14 +33,22 @@ declare class AtlasHttpClient {
     }): Promise<unknown>;
     listTasks(limit?: number, status?: string): Promise<unknown>;
     getTask(taskId: string): Promise<unknown>;
-    createTask(taskId: string, components?: JsonRecord): Promise<unknown>;
-    updateTask(taskId: string, components?: JsonRecord): Promise<unknown>;
+    createTask(taskId: string, components?: JsonRecord, options?: {
+        status?: string;
+        entity_id?: string;
+        extra?: JsonRecord;
+    }): Promise<unknown>;
+    updateTask(taskId: string, components?: JsonRecord, options?: {
+        status?: string;
+        entity_id?: string;
+        extra?: JsonRecord;
+    }): Promise<unknown>;
     deleteTask(taskId: string): Promise<unknown>;
     getTasksByEntity(entityId: string, limit?: number, status?: string): Promise<unknown>;
     startTask(taskId: string): Promise<unknown>;
     completeTask(taskId: string): Promise<unknown>;
     failTask(taskId: string, errorMessage?: string, errorDetails?: JsonRecord): Promise<unknown>;
-    listObjects(limit?: number, offset?: number, contentType?: string): Promise<unknown>;
+    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;
@@ -67,9 +77,10 @@ declare class AtlasHttpClient {
 
 interface Entity {
     entity_id: string;
+    type: string;
+    subtype?: string;
+    alias?: string;
     json: {
-        type: "asset" | "track" | "geofeature" | string;
-        alias?: string;
         components?: Record<string, unknown>;
         [key: string]: unknown;
     };
@@ -78,8 +89,9 @@ interface Entity {
 }
 interface Task {
     task_id: string;
+    status: string;
+    entity_id?: string;
     json: {
-        status: string;
         components?: Record<string, unknown>;
         [key: string]: unknown;
     };
@@ -88,6 +100,9 @@ interface Task {
 }
 interface StoredObject {
     object_id: string;
+    path?: string;
+    content_type?: string;
+    type?: string;
     json: Record<string, unknown>;
     created_at?: string;
     updated_at?: string;
@@ -177,6 +192,7 @@ interface ObjectCreate {
     bucket?: string;
     size_bytes?: number;
     content_type?: string;
+    type?: string;
     usage_hints?: string[];
     referenced_by?: ObjectReference[];
     extra?: Record<string, unknown>;
@@ -186,6 +202,7 @@ interface ObjectUpdate {
     bucket?: string;
     size_bytes?: number;
     content_type?: string;
+    type?: string;
     usage_hints?: string[];
     referenced_by?: ObjectReference[];
     extra?: Record<string, unknown>;

package/dist/index.d.ts

@@ -19,8 +19,10 @@ declare class AtlasHttpClient {
     listEntities(limit?: number, offset?: number): Promise<unknown>;
     getEntity(entityId: string): Promise<unknown>;
     getEntityByAlias(alias: string): Promise<unknown>;
-    createEntity(entityId: string, entityType: string, alias: string, components?: JsonRecord): Promise<unknown>;
-    updateEntity(entityId: string, components?: JsonRecord): Promise<unknown>;
+    createEntity(entityId: string, entityType: string, alias: string, subtype: string, components?: JsonRecord): Promise<unknown>;
+    updateEntity(entityId: string, components?: JsonRecord, options?: {
+        subtype?: string;
+    }): Promise<unknown>;
     deleteEntity(entityId: string): Promise<unknown>;
     updateEntityTelemetry(entityId: string, options: {
         latitude?: number;
@@ -31,14 +33,22 @@ declare class AtlasHttpClient {
     }): Promise<unknown>;
     listTasks(limit?: number, status?: string): Promise<unknown>;
     getTask(taskId: string): Promise<unknown>;
-    createTask(taskId: string, components?: JsonRecord): Promise<unknown>;
-    updateTask(taskId: string, components?: JsonRecord): Promise<unknown>;
+    createTask(taskId: string, components?: JsonRecord, options?: {
+        status?: string;
+        entity_id?: string;
+        extra?: JsonRecord;
+    }): Promise<unknown>;
+    updateTask(taskId: string, components?: JsonRecord, options?: {
+        status?: string;
+        entity_id?: string;
+        extra?: JsonRecord;
+    }): Promise<unknown>;
     deleteTask(taskId: string): Promise<unknown>;
     getTasksByEntity(entityId: string, limit?: number, status?: string): Promise<unknown>;
     startTask(taskId: string): Promise<unknown>;
     completeTask(taskId: string): Promise<unknown>;
     failTask(taskId: string, errorMessage?: string, errorDetails?: JsonRecord): Promise<unknown>;
-    listObjects(limit?: number, offset?: number, contentType?: string): Promise<unknown>;
+    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;
@@ -67,9 +77,10 @@ declare class AtlasHttpClient {
 
 interface Entity {
     entity_id: string;
+    type: string;
+    subtype?: string;
+    alias?: string;
     json: {
-        type: "asset" | "track" | "geofeature" | string;
-        alias?: string;
         components?: Record<string, unknown>;
         [key: string]: unknown;
     };
@@ -78,8 +89,9 @@ interface Entity {
 }
 interface Task {
     task_id: string;
+    status: string;
+    entity_id?: string;
     json: {
-        status: string;
         components?: Record<string, unknown>;
         [key: string]: unknown;
     };
@@ -88,6 +100,9 @@ interface Task {
 }
 interface StoredObject {
     object_id: string;
+    path?: string;
+    content_type?: string;
+    type?: string;
     json: Record<string, unknown>;
     created_at?: string;
     updated_at?: string;
@@ -177,6 +192,7 @@ interface ObjectCreate {
     bucket?: string;
     size_bytes?: number;
     content_type?: string;
+    type?: string;
     usage_hints?: string[];
     referenced_by?: ObjectReference[];
     extra?: Record<string, unknown>;
@@ -186,6 +202,7 @@ interface ObjectUpdate {
     bucket?: string;
     size_bytes?: number;
     content_type?: string;
+    type?: string;
     usage_hints?: string[];
     referenced_by?: ObjectReference[];
     extra?: Record<string, unknown>;

package/dist/index.js

@@ -73,20 +73,24 @@ var AtlasHttpClient = class {
   getEntityByAlias(alias) {
     return this.request("GET", `/entities/alias/${alias}`);
   }
-  createEntity(entityId, entityType, alias, components) {
+  createEntity(entityId, entityType, alias, subtype, components) {
     const payload = {
       entity_id: entityId,
       entity_type: entityType,
-      alias
+      alias,
+      subtype
     };
     if (components !== void 0) payload.components = components;
     return this.request("POST", "/entities", payload);
   }
-  updateEntity(entityId, components) {
-    if (components === void 0) {
-      throw new Error("AtlasHttpClient.updateEntity requires a components payload.");
+  updateEntity(entityId, components, options) {
+    if (components === void 0 && options?.subtype === void 0) {
+      throw new Error("AtlasHttpClient.updateEntity requires a components payload or subtype.");
     }
-    return this.request("PATCH", `/entities/${entityId}`, { components });
+    const payload = {};
+    if (components !== void 0) payload.components = components;
+    if (options?.subtype !== void 0) payload.subtype = options.subtype;
+    return this.request("PATCH", `/entities/${entityId}`, payload);
   }
   deleteEntity(entityId) {
     return this.request("DELETE", `/entities/${entityId}`);
@@ -107,19 +111,28 @@ var AtlasHttpClient = class {
   getTask(taskId) {
     return this.request("GET", `/tasks/${taskId}`);
   }
-  createTask(taskId, components) {
+  createTask(taskId, components, options) {
     const payload = {
       task_id: taskId,
-      status: "pending"
+      status: options?.status || "pending"
     };
+    if (options?.entity_id !== void 0) payload.entity_id = options.entity_id;
     if (components !== void 0) payload.components = components;
+    if (options?.extra !== void 0) payload.extra = options.extra;
     return this.request("POST", "/tasks", payload);
   }
-  updateTask(taskId, components) {
-    if (components === void 0) {
-      throw new Error("AtlasHttpClient.updateTask requires a components payload.");
+  updateTask(taskId, components, options) {
+    if (components === void 0 && options === void 0) {
+      throw new Error(
+        "AtlasHttpClient.updateTask requires a components payload or options."
+      );
     }
-    return this.request("PATCH", `/tasks/${taskId}`, { components });
+    const payload = {};
+    if (components !== void 0) payload.components = components;
+    if (options?.status !== void 0) payload.status = options.status;
+    if (options?.entity_id !== void 0) payload.entity_id = options.entity_id;
+    if (options?.extra !== void 0) payload.extra = options.extra;
+    return this.request("PATCH", `/tasks/${taskId}`, payload);
   }
   deleteTask(taskId) {
     return this.request("DELETE", `/tasks/${taskId}`);
@@ -140,8 +153,8 @@ var AtlasHttpClient = class {
     return this.request("POST", `/tasks/${taskId}/fail`, payload);
   }
   // Objects -------------------------------------------------------------------
-  listObjects(limit = 100, offset = 0, contentType) {
-    return this.request("GET", "/objects", null, { limit, offset, content_type: contentType });
+  listObjects(limit = 100, offset = 0, contentType, type) {
+    return this.request("GET", "/objects", null, { limit, offset, content_type: contentType, type });
   }
   getObject(objectId) {
     return this.request("GET", `/objects/${objectId}`);

package/package.json

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