@twin.org/api-auth-entity-storage-service 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 (13) hide show
  1. package/docs/changelog.md +16 -0
  2. package/docs/reference/classes/AuthHeaderProcessor.md +9 -9
  3. package/docs/reference/classes/AuthenticationUser.md +6 -6
  4. package/docs/reference/classes/EntityStorageAuthenticationAdminService.md +8 -8
  5. package/docs/reference/classes/EntityStorageAuthenticationService.md +7 -7
  6. package/docs/reference/classes/TokenHelper.md +10 -10
  7. package/docs/reference/interfaces/IAuthHeaderProcessorConfig.md +16 -4
  8. package/docs/reference/interfaces/IAuthHeaderProcessorConstructorOptions.md +10 -4
  9. package/docs/reference/interfaces/IEntityStorageAuthenticationAdminServiceConfig.md +8 -2
  10. package/docs/reference/interfaces/IEntityStorageAuthenticationAdminServiceConstructorOptions.md +10 -4
  11. package/docs/reference/interfaces/IEntityStorageAuthenticationServiceConfig.md +16 -4
  12. package/docs/reference/interfaces/IEntityStorageAuthenticationServiceConstructorOptions.md +26 -8
  13. 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-service-v0.0.3-next.21...api-auth-entity-storage-service-v0.0.3-next.22) (2026-03-27)
4
+
5
+
6
+ ### Miscellaneous Chores
7
+
8
+ * **api-auth-entity-storage-service:** 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-service-v0.0.3-next.20...api-auth-entity-storage-service-v0.0.3-next.21) (2026-03-11)
4
20
 
5
21
 
package/docs/reference/classes/AuthHeaderProcessor.md CHANGED
@@ -28,7 +28,7 @@ Options for the processor.
28
28
 
29
29
  ## Properties
30
30
 
31
- ### CLASS\_NAME
31
+ ### CLASS\_NAME {#class_name}
32
32
 
33
33
  > `readonly` `static` **CLASS\_NAME**: `string`
34
34
 
@@ -36,7 +36,7 @@ Runtime name for the class.
36
36
 
37
37
  ## Methods
38
38
 
39
- ### className()
39
+ ### className() {#classname}
40
40
 
41
41
  > **className**(): `string`
42
42
 
@@ -54,7 +54,7 @@ The class name of the component.
54
54
 
55
55
  ***
56
56
 
57
- ### start()
57
+ ### start() {#start}
58
58
 
59
59
  > **start**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
60
60
 
@@ -80,7 +80,7 @@ Nothing.
80
80
 
81
81
  ***
82
82
 
83
- ### pre()
83
+ ### pre() {#pre}
84
84
 
85
85
  > **pre**(`request`, `response`, `route`, `contextIds`, `processorState`): `Promise`\<`void`\>
86
86
 
@@ -102,9 +102,9 @@ The outgoing response.
102
102
 
103
103
  ##### route
104
104
 
105
- The route to process.
105
+ `IBaseRoute` \| `undefined`
106
106
 
107
- `IBaseRoute` | `undefined`
107
+ The route to process.
108
108
 
109
109
  ##### contextIds
110
110
 
@@ -126,7 +126,7 @@ The state handed through the processors.
126
126
 
127
127
  ***
128
128
 
129
- ### post()
129
+ ### post() {#post}
130
130
 
131
131
  > **post**(`request`, `response`, `route`, `contextIds`, `processorState`): `Promise`\<`void`\>
132
132
 
@@ -148,9 +148,9 @@ The outgoing response.
148
148
 
149
149
  ##### route
150
150
 
151
- The route to process.
151
+ `IBaseRoute` \| `undefined`
152
152
 
153
- `IBaseRoute` | `undefined`
153
+ The route to process.
154
154
 
155
155
  ##### contextIds
156
156
 
package/docs/reference/classes/AuthenticationUser.md CHANGED
@@ -14,7 +14,7 @@ Class defining the storage for user login credentials.
14
14
 
15
15
  ## Properties
16
16
 
17
- ### email
17
+ ### email {#email}
18
18
 
19
19
  > **email**: `string`
20
20
 
@@ -22,7 +22,7 @@ The user e-mail address.
22
22
 
23
23
  ***
24
24
 
25
- ### password
25
+ ### password {#password}
26
26
 
27
27
  > **password**: `string`
28
28
 
@@ -30,7 +30,7 @@ The encrypted password for the user.
30
30
 
31
31
  ***
32
32
 
33
- ### salt
33
+ ### salt {#salt}
34
34
 
35
35
  > **salt**: `string`
36
36
 
@@ -38,7 +38,7 @@ The salt for the password.
38
38
 
39
39
  ***
40
40
 
41
- ### identity
41
+ ### identity {#identity}
42
42
 
43
43
  > **identity**: `string`
44
44
 
@@ -46,7 +46,7 @@ The user identity.
46
46
 
47
47
  ***
48
48
 
49
- ### organization
49
+ ### organization {#organization}
50
50
 
51
51
  > **organization**: `string`
52
52
 
@@ -54,7 +54,7 @@ The users organization.
54
54
 
55
55
  ***
56
56
 
57
- ### scope
57
+ ### scope {#scope}
58
58
 
59
59
  > **scope**: `string`
60
60
 
package/docs/reference/classes/EntityStorageAuthenticationAdminService.md CHANGED
@@ -28,7 +28,7 @@ The dependencies for the identity connector.
28
28
 
29
29
  ## Properties
30
30
 
31
- ### CLASS\_NAME
31
+ ### CLASS\_NAME {#class_name}
32
32
 
33
33
  > `readonly` `static` **CLASS\_NAME**: `string`
34
34
 
@@ -36,7 +36,7 @@ Runtime name for the class.
36
36
 
37
37
  ## Methods
38
38
 
39
- ### className()
39
+ ### className() {#classname}
40
40
 
41
41
  > **className**(): `string`
42
42
 
@@ -54,7 +54,7 @@ The class name of the component.
54
54
 
55
55
  ***
56
56
 
57
- ### create()
57
+ ### create() {#create}
58
58
 
59
59
  > **create**(`user`): `Promise`\<`void`\>
60
60
 
@@ -80,7 +80,7 @@ Nothing.
80
80
 
81
81
  ***
82
82
 
83
- ### update()
83
+ ### update() {#update}
84
84
 
85
85
  > **update**(`user`): `Promise`\<`void`\>
86
86
 
@@ -106,7 +106,7 @@ Nothing.
106
106
 
107
107
  ***
108
108
 
109
- ### get()
109
+ ### get() {#get}
110
110
 
111
111
  > **get**(`email`): `Promise`\<`Omit`\<`IAuthenticationUser`, `"salt"` \| `"password"`\>\>
112
112
 
@@ -132,7 +132,7 @@ The user details.
132
132
 
133
133
  ***
134
134
 
135
- ### getByIdentity()
135
+ ### getByIdentity() {#getbyidentity}
136
136
 
137
137
  > **getByIdentity**(`identity`): `Promise`\<`Omit`\<`IAuthenticationUser`, `"salt"` \| `"password"`\>\>
138
138
 
@@ -158,7 +158,7 @@ The user details.
158
158
 
159
159
  ***
160
160
 
161
- ### remove()
161
+ ### remove() {#remove}
162
162
 
163
163
  > **remove**(`email`): `Promise`\<`void`\>
164
164
 
@@ -184,7 +184,7 @@ Nothing.
184
184
 
185
185
  ***
186
186
 
187
- ### updatePassword()
187
+ ### updatePassword() {#updatepassword}
188
188
 
189
189
  > **updatePassword**(`email`, `newPassword`, `currentPassword?`): `Promise`\<`void`\>
190
190
 
package/docs/reference/classes/EntityStorageAuthenticationService.md CHANGED
@@ -28,7 +28,7 @@ The dependencies for the identity connector.
28
28
 
29
29
  ## Properties
30
30
 
31
- ### CLASS\_NAME
31
+ ### CLASS\_NAME {#class_name}
32
32
 
33
33
  > `readonly` `static` **CLASS\_NAME**: `string`
34
34
 
@@ -36,7 +36,7 @@ Runtime name for the class.
36
36
 
37
37
  ## Methods
38
38
 
39
- ### className()
39
+ ### className() {#classname}
40
40
 
41
41
  > **className**(): `string`
42
42
 
@@ -54,7 +54,7 @@ The class name of the component.
54
54
 
55
55
  ***
56
56
 
57
- ### start()
57
+ ### start() {#start}
58
58
 
59
59
  > **start**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
60
60
 
@@ -80,7 +80,7 @@ Nothing.
80
80
 
81
81
  ***
82
82
 
83
- ### login()
83
+ ### login() {#login}
84
84
 
85
85
  > **login**(`email`, `password`): `Promise`\<\{ `token?`: `string`; `expiry`: `number`; \}\>
86
86
 
@@ -112,7 +112,7 @@ The authentication token for the user, if it uses a mechanism with public access
112
112
 
113
113
  ***
114
114
 
115
- ### logout()
115
+ ### logout() {#logout}
116
116
 
117
117
  > **logout**(`token?`): `Promise`\<`void`\>
118
118
 
@@ -138,7 +138,7 @@ Nothing.
138
138
 
139
139
  ***
140
140
 
141
- ### refresh()
141
+ ### refresh() {#refresh}
142
142
 
143
143
  > **refresh**(`token?`): `Promise`\<\{ `token?`: `string`; `expiry`: `number`; \}\>
144
144
 
@@ -164,7 +164,7 @@ The refreshed token, if it uses a mechanism with public access.
164
164
 
165
165
  ***
166
166
 
167
- ### updatePassword()
167
+ ### updatePassword() {#updatepassword}
168
168
 
169
169
  > **updatePassword**(`currentPassword`, `newPassword`): `Promise`\<`void`\>
170
170
 
package/docs/reference/classes/TokenHelper.md CHANGED
@@ -14,7 +14,7 @@ Helper class for token operations.
14
14
 
15
15
  ## Properties
16
16
 
17
- ### CLASS\_NAME
17
+ ### CLASS\_NAME {#class_name}
18
18
 
19
19
  > `readonly` `static` **CLASS\_NAME**: `string`
20
20
 
@@ -22,7 +22,7 @@ Runtime name for the class.
22
22
 
23
23
  ## Methods
24
24
 
25
- ### createToken()
25
+ ### createToken() {#createtoken}
26
26
 
27
27
  > `static` **createToken**(`vaultConnector`, `signingKeyName`, `userIdentity`, `organizationIdentity`, `tenantId`, `ttlMinutes`, `scope?`): `Promise`\<\{ `token`: `string`; `expiry`: `number`; \}\>
28
28
 
@@ -50,15 +50,15 @@ The subject for the token.
50
50
 
51
51
  ##### organizationIdentity
52
52
 
53
- The organization for the token.
53
+ `string` \| `undefined`
54
54
 
55
- `string` | `undefined`
55
+ The organization for the token.
56
56
 
57
57
  ##### tenantId
58
58
 
59
- The tenant id for the token.
59
+ `string` \| `undefined`
60
60
 
61
- `string` | `undefined`
61
+ The tenant id for the token.
62
62
 
63
63
  ##### ttlMinutes
64
64
 
@@ -80,7 +80,7 @@ The new token and its expiry date.
80
80
 
81
81
  ***
82
82
 
83
- ### verify()
83
+ ### verify() {#verify}
84
84
 
85
85
  > `static` **verify**(`vaultConnector`, `signingKeyName`, `token`, `requiredScopes?`): `Promise`\<\{ `header`: `JWTHeaderParameters`; `payload`: `JWTPayload`; \}\>
86
86
 
@@ -102,9 +102,9 @@ The signing key name.
102
102
 
103
103
  ##### token
104
104
 
105
- The token to verify.
105
+ `string` \| `undefined`
106
106
 
107
- `string` | `undefined`
107
+ The token to verify.
108
108
 
109
109
  ##### requiredScopes?
110
110
 
@@ -124,7 +124,7 @@ UnauthorizedError if the token is missing, invalid or expired.
124
124
 
125
125
  ***
126
126
 
127
- ### extractTokenFromHeaders()
127
+ ### extractTokenFromHeaders() {#extracttokenfromheaders}
128
128
 
129
129
  > `static` **extractTokenFromHeaders**(`headers?`, `cookieName?`): \{ `token`: `string`; `location`: `"authorization"` \| `"cookie"`; \} \| `undefined`
130
130
 
package/docs/reference/interfaces/IAuthHeaderProcessorConfig.md CHANGED
@@ -4,16 +4,28 @@ Configuration for the authentication header processor
4
4
 
5
5
  ## Properties
6
6
 
7
- ### signingKeyName?
7
+ ### signingKeyName? {#signingkeyname}
8
8
 
9
- > `optional` **signingKeyName**: `string`
9
+ > `optional` **signingKeyName?**: `string`
10
10
 
11
11
  The name of the key to retrieve from the vault for signing JWT.
12
12
 
13
+ #### Default
14
+
15
+ ```ts
16
+ auth-signing
17
+ ```
18
+
13
19
  ***
14
20
 
15
- ### cookieName?
21
+ ### cookieName? {#cookiename}
16
22
 
17
- > `optional` **cookieName**: `string`
23
+ > `optional` **cookieName?**: `string`
18
24
 
19
25
  The name of the cookie to use for the token.
26
+
27
+ #### Default
28
+
29
+ ```ts
30
+ access_token
31
+ ```
package/docs/reference/interfaces/IAuthHeaderProcessorConstructorOptions.md CHANGED
@@ -4,16 +4,22 @@ Options for the AuthHeaderProcessor constructor.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### vaultConnectorType?
7
+ ### vaultConnectorType? {#vaultconnectortype}
8
8
 
9
- > `optional` **vaultConnectorType**: `string`
9
+ > `optional` **vaultConnectorType?**: `string`
10
10
 
11
11
  The vault for the private keys.
12
12
 
13
+ #### Default
14
+
15
+ ```ts
16
+ vault
17
+ ```
18
+
13
19
  ***
14
20
 
15
- ### config?
21
+ ### config? {#config}
16
22
 
17
- > `optional` **config**: [`IAuthHeaderProcessorConfig`](IAuthHeaderProcessorConfig.md)
23
+ > `optional` **config?**: [`IAuthHeaderProcessorConfig`](IAuthHeaderProcessorConfig.md)
18
24
 
19
25
  The configuration for the processor.
package/docs/reference/interfaces/IEntityStorageAuthenticationAdminServiceConfig.md CHANGED
@@ -4,8 +4,14 @@ Configuration for the entity storage authentication admin service.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### minPasswordLength?
7
+ ### minPasswordLength? {#minpasswordlength}
8
8
 
9
- > `optional` **minPasswordLength**: `number`
9
+ > `optional` **minPasswordLength?**: `number`
10
10
 
11
11
  The minimum password length.
12
+
13
+ #### Default
14
+
15
+ ```ts
16
+ 8
17
+ ```
package/docs/reference/interfaces/IEntityStorageAuthenticationAdminServiceConstructorOptions.md CHANGED
@@ -4,16 +4,22 @@ Options for the EntityStorageAuthenticationAdminService constructor.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### userEntityStorageType?
7
+ ### userEntityStorageType? {#userentitystoragetype}
8
8
 
9
- > `optional` **userEntityStorageType**: `string`
9
+ > `optional` **userEntityStorageType?**: `string`
10
10
 
11
11
  The entity storage for the users.
12
12
 
13
+ #### Default
14
+
15
+ ```ts
16
+ authentication-user
17
+ ```
18
+
13
19
  ***
14
20
 
15
- ### config?
21
+ ### config? {#config}
16
22
 
17
- > `optional` **config**: [`IEntityStorageAuthenticationAdminServiceConfig`](IEntityStorageAuthenticationAdminServiceConfig.md)
23
+ > `optional` **config?**: [`IEntityStorageAuthenticationAdminServiceConfig`](IEntityStorageAuthenticationAdminServiceConfig.md)
18
24
 
19
25
  The configuration for the authentication.
package/docs/reference/interfaces/IEntityStorageAuthenticationServiceConfig.md CHANGED
@@ -4,16 +4,28 @@ Configuration for the entity storage authentication service.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### signingKeyName?
7
+ ### signingKeyName? {#signingkeyname}
8
8
 
9
- > `optional` **signingKeyName**: `string`
9
+ > `optional` **signingKeyName?**: `string`
10
10
 
11
11
  The name of the key to retrieve from the vault for signing JWT.
12
12
 
13
+ #### Default
14
+
15
+ ```ts
16
+ auth-signing
17
+ ```
18
+
13
19
  ***
14
20
 
15
- ### defaultTtlMinutes?
21
+ ### defaultTtlMinutes? {#defaultttlminutes}
16
22
 
17
- > `optional` **defaultTtlMinutes**: `number`
23
+ > `optional` **defaultTtlMinutes?**: `number`
18
24
 
19
25
  The default time to live for the JWT.
26
+
27
+ #### Default
28
+
29
+ ```ts
30
+ 1440
31
+ ```
package/docs/reference/interfaces/IEntityStorageAuthenticationServiceConstructorOptions.md CHANGED
@@ -4,32 +4,50 @@ Options for the EntityStorageAuthenticationService constructor.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### userEntityStorageType?
7
+ ### userEntityStorageType? {#userentitystoragetype}
8
8
 
9
- > `optional` **userEntityStorageType**: `string`
9
+ > `optional` **userEntityStorageType?**: `string`
10
10
 
11
11
  The entity storage for the users.
12
12
 
13
+ #### Default
14
+
15
+ ```ts
16
+ authentication-user
17
+ ```
18
+
13
19
  ***
14
20
 
15
- ### vaultConnectorType?
21
+ ### vaultConnectorType? {#vaultconnectortype}
16
22
 
17
- > `optional` **vaultConnectorType**: `string`
23
+ > `optional` **vaultConnectorType?**: `string`
18
24
 
19
25
  The vault for the private keys.
20
26
 
27
+ #### Default
28
+
29
+ ```ts
30
+ vault
31
+ ```
32
+
21
33
  ***
22
34
 
23
- ### authenticationAdminServiceType?
35
+ ### authenticationAdminServiceType? {#authenticationadminservicetype}
24
36
 
25
- > `optional` **authenticationAdminServiceType**: `string`
37
+ > `optional` **authenticationAdminServiceType?**: `string`
26
38
 
27
39
  The admin service.
28
40
 
41
+ #### Default
42
+
43
+ ```ts
44
+ authentication-admin
45
+ ```
46
+
29
47
  ***
30
48
 
31
- ### config?
49
+ ### config? {#config}
32
50
 
33
- > `optional` **config**: [`IEntityStorageAuthenticationServiceConfig`](IEntityStorageAuthenticationServiceConfig.md)
51
+ > `optional` **config?**: [`IEntityStorageAuthenticationServiceConfig`](IEntityStorageAuthenticationServiceConfig.md)
34
52
 
35
53
  The configuration for the authentication.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/api-auth-entity-storage-service",
3
- "version": "0.0.3-next.21",
3
+ "version": "0.0.3-next.22",
4
4
  "description": "Authentication service implementation and REST routes backed by 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.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/context": "next",
21
21
  "@twin.org/core": "next",
22
22
  "@twin.org/crypto": "next",