adamo-types 1.0.17 → 1.0.21

package/README.md

@@ -25,6 +25,28 @@ Describes web specific interfaces
 ### Summary
 Describes admind specific interfaces
 
+#### User Creation within SYS03/Infonova
+
+**Creation Request**
+```typescript
+interface UserCreationDTO {
+  name: string
+  email: string
+  language: string
+  givenName: string
+  familyName: string
+  workGroupName: string
+  password: string
+  role: string
+  channel: string[]
+  salesman: boolean
+}
+```
+
+**Creation Response**
+```json
+```
+
 ## Common
 ### Summary
 Describes common interfaces between the various tenents
@@ -33,7 +55,7 @@ Describes common interfaces between the various tenents
 ### Login
 **login request**
 ```typescript
-export interface LoginRequest {
+export interface UserLoginDTO {
   username: string
   password: string
 }
@@ -41,19 +63,25 @@ export interface LoginRequest {
 
 **login response**
 ```typescript
-export interface LoginResponse {
+export interface UserLoginAccessToken {
   username: string
-  channels: string[]
-  role: string
+  access_token: string
 }
 ```
 
+`access_token` - is a JWT consisting of metadata related to the user that signed in:
+- channels
+- roles
+- tenentPermissions
+- iat
+each `access_token` is valid (currently) for 24 hours
+
 **example**
 ```typescript
 try {
   import { LoginRequest, LoginResponse } from 'adamo-types/common/login'
 
-  const data: LoginRequest = {
+  const data: UserLoginDTO = {
     username: 'username',
     password: 'password'
   }
@@ -63,8 +91,7 @@ try {
     data
   })
 
-  const loginResponse: LoginResponse = response.data
-
+  const loginResponse: UserLoginDTO = response.data
 } catch(e: unknown) {
   // do something incase of error
 }

package/admin/user/request/admin.user.request.ts

@@ -0,0 +1,14 @@
+interface Users {
+  name: string
+  email: string
+  language: string
+  givenName: string
+  familyName: string
+  workGroupName: string
+  password: string
+  role: string
+  channel: string[]
+  salesman: boolean
+}
+
+export type UserCreationDTO = Users[]

package/common/login/index.ts

@@ -1,3 +1,3 @@
-export * from './interface/request/login.request.interface'
-export * from './interface/response/login.response.interface'
+export * from './request/login.request.interface'
+export * from './response/login.response.interface'
 

package/common/login/{interface/response → response}/login.response.interface.ts

@@ -2,6 +2,12 @@ export interface UserLoginPayload {
   username: string
   channels: string[]
   roles: string[]
+  tenentPermissions: string[]
+}
+
+export interface UserLoginAccessToken {
+  username: string
+  access_token: string
 }
 
 export interface AclUserRolesPayload {

package/common/user/auth/user.auth.ts

@@ -0,0 +1,8 @@
+export interface UserJWT {
+  username: string
+  channels: string[]
+  tenentPermissions: string[]
+  roles: string[]
+  iat: number
+}
+

package/common/user/data/user.data.ts

@@ -0,0 +1,12 @@
+export interface UserSessionRequest {
+  username: string
+  password: string
+}
+
+export interface DecodedJWTUser {
+  username: string
+  channels: string[]
+  tenentPermissions: string[]
+  roles: string[]
+  iat: number
+}

package/common/user/index.ts

@@ -0,0 +1,2 @@
+export * from './data/user.data'
+export * from './auth/user.auth'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adamo-types",
-  "version": "1.0.17",
+  "version": "1.0.21",
   "description": "A types library for api communication agreement",
   "main": "dist/index.js",
   "scripts": {

package/web/order/index.ts

@@ -0,0 +1,2 @@
+// export * from './request/web.order.request'
+// export * from './response/web.order.response'