Update Users Service to use Typescript #7

Musilah · 2024-03-25T14:19:32Z

What does this do?

Update Users Service to use Typescript

Which issue(s) does this PR fix/relate to?

Resolves #12

List any changes that modify/break current functionality

modify sdk.ts, errors.ts, examples.ts and users.ts

Have you included tests for your changes?

No

Did you document any new/modified functionality?

No

Notes

Signed-off-by: Musilah <[email protected]>

ianmuchyri · 2024-03-28T15:05:08Z

src/users.ts

+        'Content-Type': this.contentType,
+        Authorization: `Bearer ${token}`
+      },
+      body: JSON.stringify(user)


Magistrala only requires a string called identity, not the whole user. You can do sth like:

Suggested change

body: JSON.stringify(user)

body: JSON.stringify({ identity: user.credentials?.identity })

dborovcanin

Remove .vscode from the PR. You can add it to your global .gitignore so you keep it for yourself.

tsconfig.json

tsup.config.ts

ianmuchyri · 2024-03-28T15:11:41Z

src/users.ts

+        const errorRes = await response.json()
+        throw this.userError.HandleError(errorRes.error, response.status)
+      }
+      return 'User Disabled'


It should return a user back

ianmuchyri · 2024-03-28T15:11:53Z

src/users.ts

+        const errorRes = await response.json()
+        throw this.userError.HandleError(errorRes.error, response.status)
+      }
+      return 'User Enabled'


return a user back

ianmuchyri · 2024-03-28T15:26:18Z

examples/usersExamples.ts

@@ -0,0 +1,210 @@
+import SDK from '../src/sdk'


lets name the file users.ts, since we are already in the examples directory

ianmuchyri · 2024-03-28T15:27:17Z

examples/examples.ts

+
+const defaultUrl = 'http://localhost'
+
+const mySdk = new SDK({


remove this file since the code will be de-structured to the individual files

ianmuchyri · 2024-03-28T15:31:26Z

src/users.ts

+}
+
+interface Groups {
+  groups: Groups[]


This is not correct since this should be an array of values of type Group not Groups. Meaning the Group type should be imported from the groups.ts file. Same case for things and channels.

Also check the list user things/channels/groups functions, they don't seem to be functioning. I am getting this error:

SyntaxError: Unexpected non-whitespace character after JSON at position 4 at JSON.parse (<anonymous>) at parseJSONFromBytes (node:internal/deps/undici/undici:5329:19) at successSteps (node:internal/deps/undici/undici:5300:27) at fullyReadBody (node:internal/deps/undici/undici:1447:9) at processTicksAndRejections (node:internal/process/task_queues:95:5) at async specConsumeBody (node:internal/deps/undici/undici:5309:7)

ianmuchyri · 2024-03-28T15:33:56Z

src/users.ts

+        const errorRes = await response.json()
+        throw this.userError.HandleError(errorRes.error, response.status)
+      }
+      const userData = await response.json()


Enforce type for these responses. for example this should be

Suggested change

const userData = await response.json()

const userData : User = await response.json()

do sth similar for the rest

Signed-off-by: Musilah <[email protected]>

ianmuchyri · 2024-03-29T06:14:35Z

src/things.ts

@@ -0,0 +1,724 @@
+import Errors from './errors'


why do you have this file in this pr if it's just going to be having commented code. If it's being fixed in another pr remove it from this one.

Some users.ts functions need the things.ts interfaces and url so I added it. But I will remove the commented out code

ianmuchyri · 2024-03-29T06:15:23Z

src/sdk.ts

@@ -0,0 +1,59 @@
+import Users from './users'
+import Things from './things'


where are you using things in this pr?
Also remove the commented out code. It will be added in subsequent pr's as needed.

ianmuchyri · 2024-03-29T06:17:20Z

src/users.ts

+  page: PageRes
+}
+
+interface Group {


These interfaces should be imported from their respective files not created here and then being created in the groups file again. Same case for things, channels, and groups.

Or we can have a common defs.ts file where all the interfaces are defined and other files can import these interfaces from therer

since this is just a users.ts PR defining the interfaces here should be okay since the other files are still in .js format. Let me add a defs.ts file instead for more structure.

ianmuchyri · 2024-03-29T06:21:06Z

src/users.ts

+     * }
+     */
+
+    const rpr = { password, confPass, token }


Suggested change

const rpr = { password, confPass, token }

ianmuchyri · 2024-03-29T06:21:17Z

src/users.ts

+      headers: {
+        'Content-Type': this.contentType
+      },
+      body: JSON.stringify(rpr)


Suggested change

body: JSON.stringify(rpr)

body: JSON.stringify( { password : password, confirm_password : confPass, token : token })

ianmuchyri · 2024-03-29T06:23:29Z

src/users.ts

+      headers: {
+        'Content-Type': this.contentType
+      },
+      body: email


this should be a json object

Suggested change

body: email

body: JSON.stringify( { email: email } )

ianmuchyri · 2024-03-29T06:25:56Z

src/users.ts

+     *
+     */
+
+    const secret = { old_secret: oldSecret, new_secret: newSecret }


Suggested change

const secret = { old_secret: oldSecret, new_secret: newSecret }

ianmuchyri · 2024-03-29T06:26:09Z

src/users.ts

+        'Content-Type': this.contentType,
+        Authorization: `Bearer ${token}`
+      },
+      body: JSON.stringify(secret)


Suggested change

body: JSON.stringify(secret)

body: JSON.stringify( { old_secret: oldSecret, new_secret: newSecret } )

ianmuchyri · 2024-03-29T06:30:33Z

src/users.ts

+  domain_id?: string
+}
+
+interface QueryParams {


These are not the only query params available. Check the pageMetadata in go-sdk and add those as the query params

ianmuchyri · 2024-03-29T06:31:43Z

src/users.ts

+  limit: number
+}
+
+interface UsersInterface {


Suggested change

interface UsersInterface {

interface UsersPage {

arvindh123 · 2024-03-29T15:12:51Z

src/things.ts

+  }
+  owner: string
+  metadata: {
+    domain: string


Suggested change

domain: string

metadata?: Record<string, any>;

arvindh123 · 2024-03-29T15:13:41Z

src/users.ts

+  updatedAt?: string
+  updatedBy?: string


Suggested change

updatedAt?: string

updatedBy?: string

metadata?: Record<string, any>;

Signed-off-by: Musilah <[email protected]>

ianmuchyri · 2024-04-03T09:15:40Z

src/users.ts

@@ -24,14 +24,22 @@ export default class Users {
   * @returns {Object} - Users object.
   */
  private readonly usersUrl: URL
-  private readonly thingsUrl: URL
+  private readonly thingsUrl?: URL
+  private readonly hostUrl: URL


Host url is optional too

If I make hostUrl optional then the HeadersInit flags it as type undefined

ianmuchyri · 2024-04-03T09:16:52Z

src/users.ts

-    this.thingsUrl = new URL(thingsUrl)
+    if (thingsUrl !== undefined) {
+      this.thingsUrl = new URL(thingsUrl)
+    }


have an else statement for thingsurl too

ianmuchyri · 2024-04-03T09:17:53Z

src/users.ts

+        const errorRes = await response.json()
+        throw this.userError.HandleError(errorRes.error, response.status)
+      }
+      const resetRequestResponse: Response = { status: response.status, message: 'Email with reset link is sent' }


Suggested change

const resetRequestResponse: Response = { status: response.status, message: 'Email with reset link is sent' }

const resetRequestResponse: Response = { status: response.status, message: 'Email with reset link sent successfully' }

ianmuchyri · 2024-04-03T09:18:15Z

src/users.ts

+        const errorRes = await response.json()
+        throw this.userError.HandleError(errorRes.error, response.status)
+      }
+      const resetResponse: Response = { status: response.status, message: 'Password reset succesfully' }


Suggested change

const resetResponse: Response = { status: response.status, message: 'Password reset succesfully' }

const resetResponse: Response = { status: response.status, message: 'Password reset successfully' }

ianmuchyri · 2024-04-03T09:19:40Z

src/users.ts

+    /**
+     * @method ResetPasswordRequest - Sends a request
+     * @param {String} email - User email.
+     * @returns {Int} - Status.


fix the comments they are wrong

ianmuchyri · 2024-04-03T09:19:56Z

src/users.ts

+     * @param {String} password - User Password.
+     * @param {String} confPass - User to confirm the Password.
+     * @param {String} token - Access token.
+     * @returns {Int} - Status Created.


fix the comments

ianmuchyri · 2024-04-03T09:22:05Z

src/defs.ts

+  refreshToken: string
+}
+
+export interface Status {


Is this being used anywhere?

Signed-off-by: Musilah <[email protected]>

ianmuchyri

LGTM

arvindh123 · 2024-04-03T16:23:21Z

LGTM

Musilah added 6 commits March 25, 2024 17:14

change users.js to users.ts

44710d2

Signed-off-by: Musilah <[email protected]>

add functions to users svc

4c60908

Signed-off-by: Musilah <[email protected]>

update examples.ts and test.yml

228bca7

Signed-off-by: Musilah <[email protected]>

lint with prettier

24248ce

Signed-off-by: Musilah <[email protected]>

add es linter

fd65d14

Signed-off-by: Musilah <[email protected]>

fix node download

4e8a12d

Signed-off-by: Musilah <[email protected]>

Musilah marked this pull request as ready for review March 26, 2024 13:39

Musilah added 5 commits March 28, 2024 03:31

fix users service

802c7f7

Signed-off-by: Musilah <[email protected]>

change dir name to src

3f68d95

Signed-off-by: Musilah <[email protected]>

fix linter

6d4fbd0

Signed-off-by: Musilah <[email protected]>

fix lint errors

db304e7

Signed-off-by: Musilah <[email protected]>

fix linter

08cbffe

Signed-off-by: Musilah <[email protected]>

Musilah force-pushed the usersTS branch from 4a75f17 to 08cbffe Compare March 28, 2024 13:37

remove console.log

48aeea9

Signed-off-by: Musilah <[email protected]>

ianmuchyri requested changes Mar 28, 2024

View reviewed changes

dborovcanin requested changes Mar 28, 2024

View reviewed changes

tsconfig.json Show resolved Hide resolved

tsup.config.ts Show resolved Hide resolved

ianmuchyri requested changes Mar 28, 2024

View reviewed changes

Musilah added 2 commits March 28, 2024 23:03

restructure and pr comments

9c62edb

Signed-off-by: Musilah <[email protected]>

remove .vscode/

bfd427b

Signed-off-by: Musilah <[email protected]>

ianmuchyri requested changes Mar 29, 2024

View reviewed changes

arvindh123 reviewed Mar 29, 2024

View reviewed changes

src/things.ts Outdated

}

owner: string

metadata: {

domain: string

Copy link

arvindh123 Mar 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

domain: string

metadata?: Record<string, any>;

arvindh123 reviewed Mar 29, 2024

View reviewed changes

Musilah added 2 commits April 2, 2024 15:33

add defs.ts file

efbd6c7

Signed-off-by: Musilah <[email protected]>

fix reset password request

2b14fc4

Signed-off-by: Musilah <[email protected]>

ianmuchyri requested changes Apr 3, 2024

View reviewed changes

Musilah added 3 commits April 3, 2024 13:17

update comments

fbf9e7c

Signed-off-by: Musilah <[email protected]>

fix reset comments

5026477

Signed-off-by: Musilah <[email protected]>

delete things.js

78f9ca4

Signed-off-by: Musilah <[email protected]>

ianmuchyri approved these changes Apr 3, 2024

View reviewed changes

dborovcanin approved these changes Apr 3, 2024

View reviewed changes

dborovcanin approved these changes Apr 4, 2024

View reviewed changes

dborovcanin changed the title ~~NOISSUE - Update Users Service to use Typescript~~ Update Users Service to use Typescript Apr 4, 2024

dborovcanin merged commit 0f24bc5 into absmach:main Apr 4, 2024
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Users Service to use Typescript #7

Update Users Service to use Typescript #7

Musilah commented Mar 25, 2024 •

edited by ianmuchyri

Loading

ianmuchyri Mar 28, 2024

dborovcanin left a comment

ianmuchyri Mar 28, 2024

ianmuchyri Mar 28, 2024

ianmuchyri Mar 28, 2024

ianmuchyri Mar 28, 2024

ianmuchyri Mar 28, 2024

ianmuchyri Mar 28, 2024

ianmuchyri Mar 29, 2024

Musilah Apr 2, 2024

ianmuchyri Mar 29, 2024

ianmuchyri Mar 29, 2024

ianmuchyri Mar 29, 2024

Musilah Apr 2, 2024

ianmuchyri Mar 29, 2024

ianmuchyri Mar 29, 2024

ianmuchyri Mar 29, 2024

ianmuchyri Mar 29, 2024

ianmuchyri Mar 29, 2024

ianmuchyri Mar 29, 2024

ianmuchyri Mar 29, 2024

arvindh123 Mar 29, 2024

arvindh123 Mar 29, 2024

ianmuchyri Apr 3, 2024

Musilah Apr 3, 2024

ianmuchyri Apr 3, 2024

ianmuchyri Apr 3, 2024

ianmuchyri Apr 3, 2024

ianmuchyri Apr 3, 2024

ianmuchyri Apr 3, 2024

ianmuchyri Apr 3, 2024

ianmuchyri left a comment

arvindh123 commented Apr 3, 2024

	body: JSON.stringify(user)
	body: JSON.stringify({ identity: user.credentials?.identity })


		const defaultUrl = 'http://localhost'

		const mySdk = new SDK({

	const userData = await response.json()
	const userData : User = await response.json()

		@@ -0,0 +1,59 @@
		import Users from './users'
		import Things from './things'

	body: JSON.stringify(rpr)
	body: JSON.stringify( { password : password, confirm_password : confPass, token : token })

	body: JSON.stringify(secret)
	body: JSON.stringify( { old_secret: oldSecret, new_secret: newSecret } )

	updatedAt?: string
	updatedBy?: string
	metadata?: Record<string, any>;

	const resetRequestResponse: Response = { status: response.status, message: 'Email with reset link is sent' }
	const resetRequestResponse: Response = { status: response.status, message: 'Email with reset link sent successfully' }

	const resetResponse: Response = { status: response.status, message: 'Password reset succesfully' }
	const resetResponse: Response = { status: response.status, message: 'Password reset successfully' }

Update Users Service to use Typescript #7

Update Users Service to use Typescript #7

Conversation

Musilah commented Mar 25, 2024 • edited by ianmuchyri Loading

What does this do?

Which issue(s) does this PR fix/relate to?

List any changes that modify/break current functionality

Have you included tests for your changes?

Did you document any new/modified functionality?

Notes

Choose a reason for hiding this comment

dborovcanin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ianmuchyri left a comment

Choose a reason for hiding this comment

arvindh123 commented Apr 3, 2024

Musilah commented Mar 25, 2024 •

edited by ianmuchyri

Loading