@twin.org/api-auth-entity-storage-rest-client 0.0.1-next.9 → 0.0.1
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.
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,101 @@
|
|
|
1
1
|
# @twin.org/api-auth-entity-storage-rest-client - Changelog
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## 0.0.1 (2025-07-03)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* release to production ([70ee2d5](https://github.com/twinfoundation/api/commit/70ee2d56a1dc9537d7c9c154d4cb78a235678a3a))
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Dependencies
|
|
12
|
+
|
|
13
|
+
* The following workspace dependencies were updated
|
|
14
|
+
* dependencies
|
|
15
|
+
* @twin.org/api-auth-entity-storage-models bumped from ^0.0.0 to ^0.0.1
|
|
16
|
+
* @twin.org/api-core bumped from ^0.0.0 to ^0.0.1
|
|
17
|
+
* @twin.org/api-models bumped from ^0.0.0 to ^0.0.1
|
|
18
|
+
|
|
19
|
+
## [0.0.1-next.36](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-rest-client-v0.0.1-next.35...api-auth-entity-storage-rest-client-v0.0.1-next.36) (2025-06-17)
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
### Miscellaneous Chores
|
|
23
|
+
|
|
24
|
+
* **api-auth-entity-storage-rest-client:** Synchronize repo versions
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
### Dependencies
|
|
28
|
+
|
|
29
|
+
* The following workspace dependencies were updated
|
|
30
|
+
* dependencies
|
|
31
|
+
* @twin.org/api-auth-entity-storage-models bumped from 0.0.1-next.35 to 0.0.1-next.36
|
|
32
|
+
* @twin.org/api-core bumped from 0.0.1-next.35 to 0.0.1-next.36
|
|
33
|
+
* @twin.org/api-models bumped from 0.0.1-next.35 to 0.0.1-next.36
|
|
34
|
+
|
|
35
|
+
## [0.0.1-next.35](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-rest-client-v0.0.1-next.34...api-auth-entity-storage-rest-client-v0.0.1-next.35) (2025-06-11)
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
### Features
|
|
39
|
+
|
|
40
|
+
* update dependencies ([1171dc4](https://github.com/twinfoundation/api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
### Dependencies
|
|
44
|
+
|
|
45
|
+
* The following workspace dependencies were updated
|
|
46
|
+
* dependencies
|
|
47
|
+
* @twin.org/api-auth-entity-storage-models bumped from 0.0.1-next.34 to 0.0.1-next.35
|
|
48
|
+
* @twin.org/api-core bumped from 0.0.1-next.34 to 0.0.1-next.35
|
|
49
|
+
* @twin.org/api-models bumped from 0.0.1-next.34 to 0.0.1-next.35
|
|
50
|
+
|
|
51
|
+
## [0.0.1-next.34](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-rest-client-v0.0.1-next.33...api-auth-entity-storage-rest-client-v0.0.1-next.34) (2025-05-27)
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
### Miscellaneous Chores
|
|
55
|
+
|
|
56
|
+
* **api-auth-entity-storage-rest-client:** Synchronize repo versions
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
### Dependencies
|
|
60
|
+
|
|
61
|
+
* The following workspace dependencies were updated
|
|
62
|
+
* dependencies
|
|
63
|
+
* @twin.org/api-auth-entity-storage-models bumped from 0.0.1-next.33 to 0.0.1-next.34
|
|
64
|
+
* @twin.org/api-core bumped from 0.0.1-next.33 to 0.0.1-next.34
|
|
65
|
+
* @twin.org/api-models bumped from 0.0.1-next.33 to 0.0.1-next.34
|
|
66
|
+
|
|
67
|
+
## [0.0.1-next.33](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-rest-client-v0.0.1-next.32...api-auth-entity-storage-rest-client-v0.0.1-next.33) (2025-04-17)
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
### Features
|
|
71
|
+
|
|
72
|
+
* use shared store mechanism ([#19](https://github.com/twinfoundation/api/issues/19)) ([32116df](https://github.com/twinfoundation/api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
### Dependencies
|
|
76
|
+
|
|
77
|
+
* The following workspace dependencies were updated
|
|
78
|
+
* dependencies
|
|
79
|
+
* @twin.org/api-auth-entity-storage-models bumped from 0.0.1-next.32 to 0.0.1-next.33
|
|
80
|
+
* @twin.org/api-core bumped from 0.0.1-next.32 to 0.0.1-next.33
|
|
81
|
+
* @twin.org/api-models bumped from 0.0.1-next.32 to 0.0.1-next.33
|
|
82
|
+
|
|
83
|
+
## [0.0.1-next.32](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-rest-client-v0.0.1-next.31...api-auth-entity-storage-rest-client-v0.0.1-next.32) (2025-03-28)
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
### Miscellaneous Chores
|
|
87
|
+
|
|
88
|
+
* **api-auth-entity-storage-rest-client:** Synchronize repo versions
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
### Dependencies
|
|
92
|
+
|
|
93
|
+
* The following workspace dependencies were updated
|
|
94
|
+
* dependencies
|
|
95
|
+
* @twin.org/api-auth-entity-storage-models bumped from 0.0.1-next.31 to 0.0.1-next.32
|
|
96
|
+
* @twin.org/api-core bumped from 0.0.1-next.31 to 0.0.1-next.32
|
|
97
|
+
* @twin.org/api-models bumped from 0.0.1-next.31 to 0.0.1-next.32
|
|
98
|
+
|
|
99
|
+
## v0.0.1-next.31
|
|
4
100
|
|
|
5
101
|
- Initial Release
|
|
@@ -12,21 +12,23 @@ The client to connect to the authentication service.
|
|
|
12
12
|
|
|
13
13
|
## Constructors
|
|
14
14
|
|
|
15
|
-
###
|
|
15
|
+
### Constructor
|
|
16
16
|
|
|
17
|
-
> **new EntityStorageAuthenticationClient**(`config`):
|
|
17
|
+
> **new EntityStorageAuthenticationClient**(`config`): `EntityStorageAuthenticationClient`
|
|
18
18
|
|
|
19
19
|
Create a new instance of EntityStorageAuthenticationClient.
|
|
20
20
|
|
|
21
21
|
#### Parameters
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
##### config
|
|
24
|
+
|
|
25
|
+
`IBaseRestClientConfig`
|
|
24
26
|
|
|
25
27
|
The configuration for the client.
|
|
26
28
|
|
|
27
29
|
#### Returns
|
|
28
30
|
|
|
29
|
-
|
|
31
|
+
`EntityStorageAuthenticationClient`
|
|
30
32
|
|
|
31
33
|
#### Overrides
|
|
32
34
|
|
|
@@ -48,34 +50,30 @@ Runtime name for the class.
|
|
|
48
50
|
|
|
49
51
|
### login()
|
|
50
52
|
|
|
51
|
-
> **login**(`email`, `password`): `Promise
|
|
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
|
-
|
|
59
|
+
##### email
|
|
60
|
+
|
|
61
|
+
`string`
|
|
58
62
|
|
|
59
63
|
The email address for the user.
|
|
60
64
|
|
|
61
|
-
|
|
65
|
+
##### password
|
|
66
|
+
|
|
67
|
+
`string`
|
|
62
68
|
|
|
63
69
|
The password for the user.
|
|
64
70
|
|
|
65
71
|
#### Returns
|
|
66
72
|
|
|
67
|
-
`Promise
|
|
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`
|
|
@@ -84,13 +82,15 @@ The authentication token for the user, if it uses a mechanism with public access
|
|
|
84
82
|
|
|
85
83
|
### logout()
|
|
86
84
|
|
|
87
|
-
> **logout**(`token
|
|
85
|
+
> **logout**(`token?`): `Promise`\<`void`\>
|
|
88
86
|
|
|
89
87
|
Logout the current user.
|
|
90
88
|
|
|
91
89
|
#### Parameters
|
|
92
90
|
|
|
93
|
-
|
|
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
|
|
111
|
+
> **refresh**(`token?`): `Promise`\<\{ `token?`: `string`; `expiry`: `number`; \}\>
|
|
112
112
|
|
|
113
113
|
Refresh the token.
|
|
114
114
|
|
|
115
115
|
#### Parameters
|
|
116
116
|
|
|
117
|
-
|
|
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
|
|
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
|
|
3
|
+
"version": "0.0.1",
|
|
4
4
|
"description": "Perform REST authentication using entity storage.",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -14,21 +14,21 @@
|
|
|
14
14
|
"node": ">=20.0.0"
|
|
15
15
|
},
|
|
16
16
|
"dependencies": {
|
|
17
|
-
"@twin.org/api-auth-entity-storage-models": "0.0.1
|
|
18
|
-
"@twin.org/api-core": "0.0.1
|
|
19
|
-
"@twin.org/api-models": "0.0.1
|
|
20
|
-
"@twin.org/core": "
|
|
21
|
-
"@twin.org/nameof": "
|
|
22
|
-
"@twin.org/web": "
|
|
17
|
+
"@twin.org/api-auth-entity-storage-models": "^0.0.1",
|
|
18
|
+
"@twin.org/api-core": "^0.0.1",
|
|
19
|
+
"@twin.org/api-models": "^0.0.1",
|
|
20
|
+
"@twin.org/core": "^0.0.1",
|
|
21
|
+
"@twin.org/nameof": "^0.0.1",
|
|
22
|
+
"@twin.org/web": "^0.0.1"
|
|
23
23
|
},
|
|
24
24
|
"main": "./dist/cjs/index.cjs",
|
|
25
25
|
"module": "./dist/esm/index.mjs",
|
|
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": [
|