NOISSUE - Sync Users service with Magistrala core (#79)

* update useres client Signed-off-by: Musilah <[email protected]> * fix comments and params Signed-off-by: Musilah <[email protected]> * update issuetoken example Signed-off-by: Musilah <[email protected]> * modify issue token function Signed-off-by: Musilah <[email protected]> * rename password back to secret in credentials Signed-off-by: Musilah <[email protected]> --------- Signed-off-by: Musilah <[email protected]>
absmach · Nov 5, 2024 · e754d29 · e754d29
1 parent b888d96
commit e754d29
Show file tree

Hide file tree

Showing 14 changed files with 280 additions and 95 deletions.
diff --git a/.changeset/early-forks-mate.md b/.changeset/early-forks-mate.md
@@ -0,0 +1,5 @@
+---
+"@absmach/magistrala-sdk": minor
+---
+
+update users client to match Magistrala with new fields and functions
diff --git a/.changeset/five-planes-reply.md b/.changeset/five-planes-reply.md
@@ -0,0 +1,5 @@
+---
+"@absmach/magistrala-sdk": patch
+---
+
+update createToken example
diff --git a/.changeset/serious-toys-smash.md b/.changeset/serious-toys-smash.md
@@ -0,0 +1,5 @@
+---
+"@absmach/magistrala-sdk": patch
+---
+
+rename password back to secret in credentials
diff --git a/.changeset/twelve-pants-bathe.md b/.changeset/twelve-pants-bathe.md
@@ -0,0 +1,5 @@
+---
+"@absmach/magistrala-sdk": patch
+---
+
+modify issue token function to use identity instead of username
diff --git a/examples/users.ts b/examples/users.ts
@@ -11,9 +11,11 @@ const token = '<token>'
 
 mySdk.users
   .Create({
-    name: '<name>',
+    first_name: '<firstName>',
+    last_name: '<lastName>',
+    email: '<email>',
     credentials: {
-      identity: '<useremail>',
+      username: '<username>',
       secret: '<password>'
     }
   })
@@ -46,7 +48,7 @@ mySdk.users.UserProfile(
   })
 
 mySdk.users.CreateToken(
-  { identity: '<userEmail>', secret: '<password>', domain_id: '<domainId>' }
+  { identity: '<username | email>', secret: '<password>' }
 )
   .then((response: any) => {
     console.log('response: ', response)
@@ -56,7 +58,6 @@ mySdk.users.CreateToken(
   })
 
 mySdk.users.RefreshToken(
-  { identity: '<userId>' },
   '<refreshToken>'
 )
   .then((response: any) => {
@@ -67,7 +68,7 @@ mySdk.users.RefreshToken(
   })
 
 mySdk.users.Update(
-  { id: '<userId>', name: '<userName>' },
+  { id: '<userId>', first_name: '<firstName>', last_name: '<lastName>' },
   token
 )
   .then((response: any) => {
@@ -77,8 +78,30 @@ mySdk.users.Update(
     console.log(error)
   })
 
-mySdk.users.UpdateUserIdentity(
-  { id: '<userId>', credentials: { identity: '<userIdentity>' } },
+mySdk.users.UpdateEmail(
+  { id: '<userId>', email: '<email>' },
+  token
+)
+  .then((response: any) => {
+    console.log('response: ', response)
+  })
+  .catch((error) => {
+    console.log(error)
+  })
+
+mySdk.users.UpdateUsername(
+  { id: '<userId>', credentials: { username: '<username>' } },
+  token
+)
+  .then((response: any) => {
+    console.log('response: ', response)
+  })
+  .catch((error) => {
+    console.log(error)
+  })
+
+mySdk.users.UpdateProfilePicture(
+  { id: '<userId>', profile_picture: '<profilePicture>' },
   token
 )
   .then((response: any) => {
@@ -100,7 +123,7 @@ mySdk.users.UpdateUserTags(
   })
 
 mySdk.users.UpdateUserRole(
-  { id: '<userId>', role: '<userRole>' },
+  { id: '<userId>', role: '<role>' },
   token
 )
   .then((response: any) => {
@@ -155,6 +178,7 @@ mySdk.users.UpdateUserPassword(
   })
 
 mySdk.users.ListUserChannels(
+  '<domainId>',
   '<userId>',
   { offset: 0, limit: 10 },
   token
@@ -167,6 +191,7 @@ mySdk.users.ListUserChannels(
   })
 
 mySdk.users.ListUserThings(
+  '<domainId>',
   '<userId>',
   { offset: 0, limit: 10 },
   token
@@ -179,6 +204,7 @@ mySdk.users.ListUserThings(
   })
 
 mySdk.users.ListUserGroups(
+  '<domainId>',
   '<userId>',
   { offset: 0, limit: 10 },
   token
@@ -224,7 +250,7 @@ mySdk.users.DeleteUser(
   })
 
 mySdk.users.SearchUsers(
-  { name: '<userName>', id: '<userId>' },
+  { username: '<username>' },
   token
 )
   .then((response: any) => {

diff --git a/package-lock.json b/package-lock.json
diff --git a/src/defs.ts b/src/defs.ts
@@ -1,8 +1,11 @@
 export interface UserBasicInfo {
   id?: string
-  name?: string
+  first_name?: string
+  last_name?: string
+  email?: string
   credentials?: credentials
   status?: Status
+  profile_picture?: string
 }
 
 export interface User extends UserBasicInfo {
@@ -22,14 +25,19 @@ export interface UsersPage {
 }
 
 export interface credentials {
+  username?: string
+  secret?: string
+}
+
+export interface thingcredentials {
   identity?: string
   secret?: string
 }
 
 export interface ThingBasicInfo {
   id?: string
   name?: string
-  credentials?: credentials
+  credentials?: thingcredentials
   status?: Status
 }
 
@@ -106,7 +114,6 @@ export interface ChannelsPage {
 export interface Login {
   identity?: string
   secret?: string
-  domain_id?: string
 }
 
 export interface Token {
@@ -181,8 +188,10 @@ export interface PageMetadata {
   order?: string
   direction?: string
   level?: number
-  identity?: string
-  name?: string
+  email?: string
+  username?: string
+  first_name?: string
+  last_name?: string
   type?: string
   metadata?: Record<string, any>
   status?: string

diff --git a/src/sdk.ts b/src/sdk.ts
@@ -35,6 +35,7 @@ export type {
   Relation,
   GroupRelation,
   credentials,
+  thingcredentials,
   UserBasicInfo,
   DomainBasicInfo,
   Permissions,