@superatomai/sdk-web 0.0.7 → 0.0.8

package/README.md

@@ -127,21 +127,42 @@ const verifyResponse = await client.sendAuthVerifyRequest(
 
 ```typescript
 // Create a new user
-const result = await client.createUser(username, password, timeout);
+const result = await client.createUser(
+  username,
+  password,
+  email?,      // Optional: User email
+  fullname?,   // Optional: User full name
+  role?,       // Optional: User role
+  timeout?
+);
+// Returns: { success, username?, email?, fullname?, role?, message?, error? }
 
 // Update an existing user
-const result = await client.updateUser(username, password, timeout);
+const result = await client.updateUser(
+  username,
+  {
+    password?: string,   // Optional: New password
+    email?: string,      // Optional: New email
+    fullname?: string,   // Optional: New full name
+    role?: string,       // Optional: New role
+  },
+  timeout?
+);
+// Returns: { success, username?, email?, fullname?, role?, message?, error? }
 
 // Delete a user
 const result = await client.deleteUser(username, timeout);
+// Returns: { success, username?, email?, fullname?, role?, message?, error? }
 
 // Get all users
 const result = await client.getAllUsers(timeout);
 // Returns: { success, users, count, error?, message? }
+// User object: { username, email?, fullname?, role?, wsIds }
 
 // Get a specific user
 const result = await client.getUser(username, timeout);
 // Returns: { success, user, error?, message? }
+// User object: { username, email?, fullname?, role?, wsIds }
 ```
 
 #### Dashboard Management
@@ -292,6 +313,67 @@ The SDK supports the following message types (all validated with Zod schemas):
 
 All message types are fully typed and validated using Zod v4 schemas.
 
+### USERS Schema
+
+The USERS message type supports comprehensive user management with the following structure:
+
+**Request Payload** (`USERS`):
+```typescript
+{
+  operation: 'create' | 'update' | 'delete' | 'getAll' | 'getOne',
+  data?: {
+    username?: string,        // Required for all operations except getAll
+    email?: string,           // Optional: User email (validated)
+    password?: string,        // Required for create, optional for update
+    fullname?: string,        // Optional: User's full name
+    role?: string,            // Optional: User's role
+  }
+}
+```
+
+**Response Payload** (`USERS_RES`):
+```typescript
+{
+  success: boolean,
+  error?: string,
+  data?: {
+    username?: string,
+    email?: string,
+    fullname?: string,
+    role?: string,
+    message?: string,
+    // For getAll operation
+    users?: Array<{
+      username: string,
+      email?: string,
+      fullname?: string,
+      role?: string,
+      wsIds: string[]
+    }>,
+    count?: number,
+    // For getOne operation
+    user?: {
+      username: string,
+      email?: string,
+      fullname?: string,
+      role?: string,
+      wsIds: string[]
+    }
+  }
+}
+```
+
+**User Object Structure**:
+```typescript
+interface User {
+  username: string;          // Required: Unique username
+  email?: string;            // Optional: Validated email address
+  fullname?: string;         // Optional: User's full name
+  role?: string;             // Optional: User role (e.g., 'admin', 'editor', 'viewer')
+  wsIds: string[];           // WebSocket connection IDs (in-memory only)
+}
+```
+
 ## Type Safety
 
 All messages are validated using Zod v4 schemas. The SDK exports comprehensive type definitions and schemas:
@@ -380,10 +462,19 @@ const client = new SuperatomClient({
 
 await client.connect();
 
-// Create a new user
-const createResult = await client.createUser('newuser', 'password123');
+// Create a new user with all fields
+const createResult = await client.createUser(
+  'newuser',
+  'password123',
+  'user@example.com',     // email
+  'John Doe',             // fullname
+  'editor'                // role
+);
 if (createResult.success) {
   console.log('User created:', createResult.username);
+  console.log('Email:', createResult.email);
+  console.log('Full name:', createResult.fullname);
+  console.log('Role:', createResult.role);
 }
 
 // Get all users
@@ -391,12 +482,25 @@ const usersResult = await client.getAllUsers();
 if (usersResult.success && usersResult.users) {
   console.log(`Found ${usersResult.count} users`);
   usersResult.users.forEach(user => {
-    console.log(`- ${user.username} (${user.wsIds.length} connections)`);
+    console.log(`- ${user.username} (${user.email || 'no email'})`);
+    console.log(`  Full name: ${user.fullname || 'N/A'}`);
+    console.log(`  Role: ${user.role || 'N/A'}`);
+    console.log(`  Connections: ${user.wsIds.length}`);
   });
 }
 
-// Update a user
-await client.updateUser('newuser', 'newpassword456');
+// Update a user - change multiple fields
+await client.updateUser('newuser', {
+  password: 'newpassword456',
+  email: 'newemail@example.com',
+  fullname: 'Jane Doe',
+  role: 'admin'
+});
+
+// Update a user - change only specific fields
+await client.updateUser('newuser', {
+  role: 'viewer'  // Only update role
+});
 
 // Delete a user
 await client.deleteUser('newuser');

package/dist/index.cjs

@@ -434,7 +434,10 @@ var UsersRequestPayloadSchema = zod.z.object({
   operation: zod.z.enum(["create", "update", "delete", "getAll", "getOne"]),
   data: zod.z.object({
     username: zod.z.string().optional(),
-    password: zod.z.string().optional()
+    email: zod.z.string().email("Invalid email format").optional(),
+    password: zod.z.string().optional(),
+    fullname: zod.z.string().optional(),
+    role: zod.z.string().optional()
   }).optional()
 });
 var UsersRequestMessageSchema = zod.z.object({
@@ -449,13 +452,22 @@ var UsersResponsePayloadSchema = zod.z.object({
   error: zod.z.string().optional(),
   data: zod.z.object({
     username: zod.z.string().optional(),
+    email: zod.z.string().optional(),
+    fullname: zod.z.string().optional(),
+    role: zod.z.string().optional(),
     message: zod.z.string().optional(),
     users: zod.z.array(zod.z.object({
       username: zod.z.string(),
+      email: zod.z.string().optional(),
+      fullname: zod.z.string().optional(),
+      role: zod.z.string().optional(),
       wsIds: zod.z.array(zod.z.string())
     })).optional(),
     user: zod.z.object({
       username: zod.z.string(),
+      email: zod.z.string().optional(),
+      fullname: zod.z.string().optional(),
+      role: zod.z.string().optional(),
       wsIds: zod.z.array(zod.z.string())
     }).optional(),
     count: zod.z.number().optional()
@@ -780,7 +792,7 @@ async function sendComponents(client, components) {
 }
 
 // src/services/users.ts
-async function createUser(client, username, password, timeout) {
+async function createUser(client, username, password, email, fullname, role, timeout) {
   const messageId = `users_create_${Date.now()}`;
   const message = UsersRequestMessageSchema.parse({
     id: messageId,
@@ -791,7 +803,10 @@ async function createUser(client, username, password, timeout) {
       operation: "create",
       data: {
         username,
-        password
+        password,
+        email,
+        fullname,
+        role
       }
     }
   });
@@ -801,10 +816,13 @@ async function createUser(client, username, password, timeout) {
     success: payload.success,
     error: payload.error,
     message: payload.data?.message,
-    username: payload.data?.username
+    username: payload.data?.username,
+    email: payload.data?.email,
+    fullname: payload.data?.fullname,
+    role: payload.data?.role
   };
 }
-async function updateUser(client, username, password, timeout) {
+async function updateUser(client, username, updates, timeout) {
   const messageId = `users_update_${Date.now()}`;
   const message = UsersRequestMessageSchema.parse({
     id: messageId,
@@ -815,7 +833,7 @@ async function updateUser(client, username, password, timeout) {
       operation: "update",
       data: {
         username,
-        password
+        ...updates
       }
     }
   });
@@ -825,7 +843,10 @@ async function updateUser(client, username, password, timeout) {
     success: payload.success,
     error: payload.error,
     message: payload.data?.message,
-    username: payload.data?.username
+    username: payload.data?.username,
+    email: payload.data?.email,
+    fullname: payload.data?.fullname,
+    role: payload.data?.role
   };
 }
 async function deleteUser(client, username, timeout) {
@@ -848,7 +869,10 @@ async function deleteUser(client, username, timeout) {
     success: payload.success,
     error: payload.error,
     message: payload.data?.message,
-    username: payload.data?.username
+    username: payload.data?.username,
+    email: payload.data?.email,
+    fullname: payload.data?.fullname,
+    role: payload.data?.role
   };
 }
 async function getAllUsers(client, timeout) {
@@ -1496,17 +1520,17 @@ var SuperatomClient = class {
    * Create a new user
    * Delegates to users service
    */
-  async createUser(username, password, timeout) {
+  async createUser(username, password, email, fullname, role, timeout) {
     this.log("info", "Creating user:", username);
-    return createUser(this, username, password, timeout);
+    return createUser(this, username, password, email, fullname, role, timeout);
   }
   /**
    * Update an existing user
    * Delegates to users service
    */
-  async updateUser(username, password, timeout) {
+  async updateUser(username, updates, timeout) {
     this.log("info", "Updating user:", username);
-    return updateUser(this, username, password, timeout);
+    return updateUser(this, username, updates, timeout);
   }
   /**
    * Delete a user