@twin.org/api-auth-entity-storage-rest-client 0.0.1-next.25 → 0.0.1-next.27

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/docs/changelog.md +1 -1
  2. package/docs/reference/classes/EntityStorageAuthenticationClient.md +19 -25
  3. package/package.json +6 -6
package/docs/changelog.md CHANGED
@@ -1,5 +1,5 @@
1
1
  # @twin.org/api-auth-entity-storage-rest-client - Changelog
2
2
 
3
- ## v0.0.1-next.25
3
+ ## v0.0.1-next.27
4
4
 
5
5
  - Initial Release
package/docs/reference/classes/EntityStorageAuthenticationClient.md CHANGED
@@ -20,7 +20,9 @@ Create a new instance of EntityStorageAuthenticationClient.
20
20
 
21
21
  #### Parameters
22
22
 
23
- • **config**: `IBaseRestClientConfig`
23
+ ##### config
24
+
25
+ `IBaseRestClientConfig`
24
26
 
25
27
  The configuration for the client.
26
28
 
@@ -48,34 +50,30 @@ Runtime name for the class.
48
50
 
49
51
  ### login()
50
52
 
51
- > **login**(`email`, `password`): `Promise`\<`object`\>
53
+ > **login**(`email`, `password`): `Promise`\<\{ `token`: `string`; `expiry`: `number`; \}\>
52
54
 
53
55
  Perform a login for the user.
54
56
 
55
57
  #### Parameters
56
58
 
57
- • **email**: `string`
59
+ ##### email
60
+
61
+ `string`
58
62
 
59
63
  The email address for the user.
60
64
 
61
- • **password**: `string`
65
+ ##### password
66
+
67
+ `string`
62
68
 
63
69
  The password for the user.
64
70
 
65
71
  #### Returns
66
72
 
67
- `Promise`\<`object`\>
73
+ `Promise`\<\{ `token`: `string`; `expiry`: `number`; \}\>
68
74
 
69
75
  The authentication token for the user, if it uses a mechanism with public access.
70
76
 
71
- ##### token?
72
-
73
- > `optional` **token**: `string`
74
-
75
- ##### expiry
76
-
77
- > **expiry**: `number`
78
-
79
77
  #### Implementation of
80
78
 
81
79
  `IAuthenticationComponent.login`
@@ -90,7 +88,9 @@ Logout the current user.
90
88
 
91
89
  #### Parameters
92
90
 
93
- • **token?**: `string`
91
+ ##### token?
92
+
93
+ `string`
94
94
 
95
95
  The token to logout, if it uses a mechanism with public access.
96
96
 
@@ -108,30 +108,24 @@ Nothing.
108
108
 
109
109
  ### refresh()
110
110
 
111
- > **refresh**(`token`?): `Promise`\<`object`\>
111
+ > **refresh**(`token`?): `Promise`\<\{ `token`: `string`; `expiry`: `number`; \}\>
112
112
 
113
113
  Refresh the token.
114
114
 
115
115
  #### Parameters
116
116
 
117
- • **token?**: `string`
117
+ ##### token?
118
+
119
+ `string`
118
120
 
119
121
  The token to refresh, if it uses a mechanism with public access.
120
122
 
121
123
  #### Returns
122
124
 
123
- `Promise`\<`object`\>
125
+ `Promise`\<\{ `token`: `string`; `expiry`: `number`; \}\>
124
126
 
125
127
  The refreshed token, if it uses a mechanism with public access.
126
128
 
127
- ##### token?
128
-
129
- > `optional` **token**: `string`
130
-
131
- ##### expiry
132
-
133
- > **expiry**: `number`
134
-
135
129
  #### Implementation of
136
130
 
137
131
  `IAuthenticationComponent.refresh`
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/api-auth-entity-storage-rest-client",
3
- "version": "0.0.1-next.25",
3
+ "version": "0.0.1-next.27",
4
4
  "description": "Perform REST authentication using entity storage.",
5
5
  "repository": {
6
6
  "type": "git",
@@ -14,9 +14,9 @@
14
14
  "node": ">=20.0.0"
15
15
  },
16
16
  "dependencies": {
17
- "@twin.org/api-auth-entity-storage-models": "0.0.1-next.25",
18
- "@twin.org/api-core": "0.0.1-next.25",
19
- "@twin.org/api-models": "0.0.1-next.25",
17
+ "@twin.org/api-auth-entity-storage-models": "0.0.1-next.27",
18
+ "@twin.org/api-core": "0.0.1-next.27",
19
+ "@twin.org/api-models": "0.0.1-next.27",
20
20
  "@twin.org/core": "next",
21
21
  "@twin.org/nameof": "next",
22
22
  "@twin.org/web": "next"
@@ -26,9 +26,9 @@
26
26
  "types": "./dist/types/index.d.ts",
27
27
  "exports": {
28
28
  ".": {
29
+ "types": "./dist/types/index.d.ts",
29
30
  "require": "./dist/cjs/index.cjs",
30
- "import": "./dist/esm/index.mjs",
31
- "types": "./dist/types/index.d.ts"
31
+ "import": "./dist/esm/index.mjs"
32
32
  }
33
33
  },
34
34
  "files": [