@twin.org/api-auth-entity-storage-rest-client 0.0.3-next.21 → 0.0.3-next.22

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 (5) hide show
  1. package/docs/changelog.md +16 -0
  2. package/docs/reference/classes/EntityStorageAuthenticationAdminRestClient.md +10 -10
  3. package/docs/reference/classes/EntityStorageAuthenticationRestClient.md +8 -8
  4. package/docs/reference/interfaces/IEntityStorageAuthenticationRestClientConstructorOptions.md +17 -11
  5. package/package.json +4 -4
package/docs/changelog.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # Changelog
2
2
 
3
+ ## [0.0.3-next.22](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-rest-client-v0.0.3-next.21...api-auth-entity-storage-rest-client-v0.0.3-next.22) (2026-03-27)
4
+
5
+
6
+ ### Miscellaneous Chores
7
+
8
+ * **api-auth-entity-storage-rest-client:** Synchronize repo versions
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.3-next.21 to 0.0.3-next.22
16
+ * @twin.org/api-core bumped from 0.0.3-next.21 to 0.0.3-next.22
17
+ * @twin.org/api-models bumped from 0.0.3-next.21 to 0.0.3-next.22
18
+
3
19
  ## [0.0.3-next.21](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-rest-client-v0.0.3-next.20...api-auth-entity-storage-rest-client-v0.0.3-next.21) (2026-03-11)
4
20
 
5
21
 
package/docs/reference/classes/EntityStorageAuthenticationAdminRestClient.md CHANGED
@@ -36,7 +36,7 @@ The configuration for the client.
36
36
 
37
37
  ## Properties
38
38
 
39
- ### CLASS\_NAME
39
+ ### CLASS\_NAME {#class_name}
40
40
 
41
41
  > `readonly` `static` **CLASS\_NAME**: `string`
42
42
 
@@ -44,7 +44,7 @@ Runtime name for the class.
44
44
 
45
45
  ## Methods
46
46
 
47
- ### className()
47
+ ### className() {#classname}
48
48
 
49
49
  > **className**(): `string`
50
50
 
@@ -62,7 +62,7 @@ The class name of the component.
62
62
 
63
63
  ***
64
64
 
65
- ### create()
65
+ ### create() {#create}
66
66
 
67
67
  > **create**(`user`): `Promise`\<`void`\>
68
68
 
@@ -88,7 +88,7 @@ Nothing.
88
88
 
89
89
  ***
90
90
 
91
- ### update()
91
+ ### update() {#update}
92
92
 
93
93
  > **update**(`user`): `Promise`\<`void`\>
94
94
 
@@ -114,7 +114,7 @@ Nothing.
114
114
 
115
115
  ***
116
116
 
117
- ### get()
117
+ ### get() {#get}
118
118
 
119
119
  > **get**(`email`): `Promise`\<`Omit`\<`IAuthenticationUser`, `"salt"` \| `"password"`\>\>
120
120
 
@@ -140,7 +140,7 @@ The user details.
140
140
 
141
141
  ***
142
142
 
143
- ### getByIdentity()
143
+ ### getByIdentity() {#getbyidentity}
144
144
 
145
145
  > **getByIdentity**(`identity`): `Promise`\<`Omit`\<`IAuthenticationUser`, `"salt"` \| `"password"`\>\>
146
146
 
@@ -166,7 +166,7 @@ The user details.
166
166
 
167
167
  ***
168
168
 
169
- ### remove()
169
+ ### remove() {#remove}
170
170
 
171
171
  > **remove**(`email`): `Promise`\<`void`\>
172
172
 
@@ -192,7 +192,7 @@ Nothing.
192
192
 
193
193
  ***
194
194
 
195
- ### updatePassword()
195
+ ### updatePassword() {#updatepassword}
196
196
 
197
197
  > **updatePassword**(`email`, `newPassword`, `currentPassword?`): `Promise`\<`void`\>
198
198
 
@@ -230,7 +230,7 @@ Nothing.
230
230
 
231
231
  ***
232
232
 
233
- ### getEndpointWithPrefix()
233
+ ### getEndpointWithPrefix() {#getendpointwithprefix}
234
234
 
235
235
  > **getEndpointWithPrefix**(): `string`
236
236
 
@@ -248,7 +248,7 @@ The endpoint with namespace prefix attached.
248
248
 
249
249
  ***
250
250
 
251
- ### fetch()
251
+ ### fetch() {#fetch}
252
252
 
253
253
  > **fetch**\<`T`, `U`\>(`route`, `method`, `request?`): `Promise`\<`U`\>
254
254
 
package/docs/reference/classes/EntityStorageAuthenticationRestClient.md CHANGED
@@ -36,7 +36,7 @@ The configuration for the client.
36
36
 
37
37
  ## Properties
38
38
 
39
- ### CLASS\_NAME
39
+ ### CLASS\_NAME {#class_name}
40
40
 
41
41
  > `readonly` `static` **CLASS\_NAME**: `string`
42
42
 
@@ -44,7 +44,7 @@ Runtime name for the class.
44
44
 
45
45
  ## Methods
46
46
 
47
- ### className()
47
+ ### className() {#classname}
48
48
 
49
49
  > **className**(): `string`
50
50
 
@@ -62,7 +62,7 @@ The class name of the component.
62
62
 
63
63
  ***
64
64
 
65
- ### login()
65
+ ### login() {#login}
66
66
 
67
67
  > **login**(`email`, `password`): `Promise`\<\{ `token?`: `string`; `expiry`: `number`; \}\>
68
68
 
@@ -94,7 +94,7 @@ The authentication token for the user, if it uses a mechanism with public access
94
94
 
95
95
  ***
96
96
 
97
- ### logout()
97
+ ### logout() {#logout}
98
98
 
99
99
  > **logout**(`token?`): `Promise`\<`void`\>
100
100
 
@@ -120,7 +120,7 @@ Nothing.
120
120
 
121
121
  ***
122
122
 
123
- ### refresh()
123
+ ### refresh() {#refresh}
124
124
 
125
125
  > **refresh**(`token?`): `Promise`\<\{ `token?`: `string`; `expiry`: `number`; \}\>
126
126
 
@@ -146,7 +146,7 @@ The refreshed token, if it uses a mechanism with public access.
146
146
 
147
147
  ***
148
148
 
149
- ### updatePassword()
149
+ ### updatePassword() {#updatepassword}
150
150
 
151
151
  > **updatePassword**(`currentPassword`, `newPassword`): `Promise`\<`void`\>
152
152
 
@@ -178,7 +178,7 @@ Nothing.
178
178
 
179
179
  ***
180
180
 
181
- ### getEndpointWithPrefix()
181
+ ### getEndpointWithPrefix() {#getendpointwithprefix}
182
182
 
183
183
  > **getEndpointWithPrefix**(): `string`
184
184
 
@@ -196,7 +196,7 @@ The endpoint with namespace prefix attached.
196
196
 
197
197
  ***
198
198
 
199
- ### fetch()
199
+ ### fetch() {#fetch}
200
200
 
201
201
  > **fetch**\<`T`, `U`\>(`route`, `method`, `request?`): `Promise`\<`U`\>
202
202
 
package/docs/reference/interfaces/IEntityStorageAuthenticationRestClientConstructorOptions.md CHANGED
@@ -8,15 +8,21 @@ Options for the Entity Storage Authentication REST client constructor.
8
8
 
9
9
  ## Properties
10
10
 
11
- ### cookieName?
11
+ ### cookieName? {#cookiename}
12
12
 
13
- > `optional` **cookieName**: `string`
13
+ > `optional` **cookieName?**: `string`
14
14
 
15
15
  The name of the cookie to use for storing the auth token.
16
16
 
17
+ #### Default
18
+
19
+ ```ts
20
+ access_token
21
+ ```
22
+
17
23
  ***
18
24
 
19
- ### endpoint
25
+ ### endpoint {#endpoint}
20
26
 
21
27
  > **endpoint**: `string`
22
28
 
@@ -28,9 +34,9 @@ The endpoint where the api is hosted.
28
34
 
29
35
  ***
30
36
 
31
- ### pathPrefix?
37
+ ### pathPrefix? {#pathprefix}
32
38
 
33
- > `optional` **pathPrefix**: `string`
39
+ > `optional` **pathPrefix?**: `string`
34
40
 
35
41
  The prefix to the routes.
36
42
 
@@ -40,9 +46,9 @@ The prefix to the routes.
40
46
 
41
47
  ***
42
48
 
43
- ### headers?
49
+ ### headers? {#headers}
44
50
 
45
- > `optional` **headers**: `IHttpHeaders`
51
+ > `optional` **headers?**: `IHttpHeaders`
46
52
 
47
53
  The headers to include in requests.
48
54
 
@@ -52,9 +58,9 @@ The headers to include in requests.
52
58
 
53
59
  ***
54
60
 
55
- ### timeout?
61
+ ### timeout? {#timeout}
56
62
 
57
- > `optional` **timeout**: `number`
63
+ > `optional` **timeout?**: `number`
58
64
 
59
65
  Timeout for requests in ms.
60
66
 
@@ -64,9 +70,9 @@ Timeout for requests in ms.
64
70
 
65
71
  ***
66
72
 
67
- ### includeCredentials?
73
+ ### includeCredentials? {#includecredentials}
68
74
 
69
- > `optional` **includeCredentials**: `boolean`
75
+ > `optional` **includeCredentials?**: `boolean`
70
76
 
71
77
  Include credentials in the request, defaults to true.
72
78
 
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.3-next.21",
3
+ "version": "0.0.3-next.22",
4
4
  "description": "REST clients for authentication and admin operations against entity storage endpoints.",
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.3-next.21",
18
- "@twin.org/api-core": "0.0.3-next.21",
19
- "@twin.org/api-models": "0.0.3-next.21",
17
+ "@twin.org/api-auth-entity-storage-models": "0.0.3-next.22",
18
+ "@twin.org/api-core": "0.0.3-next.22",
19
+ "@twin.org/api-models": "0.0.3-next.22",
20
20
  "@twin.org/core": "next",
21
21
  "@twin.org/nameof": "next",
22
22
  "@twin.org/web": "next"