@twin.org/api-auth-entity-storage-models 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.
Files changed (5) hide show
  1. package/dist/types/models/api/IRefreshTokenRequest.d.ts +1 -1
  2. package/docs/changelog.md +43 -1
  3. package/docs/reference/interfaces/IAuthenticationComponent.md +17 -25
  4. package/docs/reference/interfaces/IRefreshTokenRequest.md +1 -1
  5. package/package.json +6 -6
package/dist/types/models/api/IRefreshTokenRequest.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Perform a refresh on the auth token.
2
+ * Perform a refresh of the auth token.
3
3
  */
4
4
  export interface IRefreshTokenRequest {
5
5
  /**
package/docs/changelog.md CHANGED
@@ -1,5 +1,47 @@
1
1
  # @twin.org/api-auth-entity-storage-models - Changelog
2
2
 
3
- ## v0.0.1-next.9
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
+ ## [0.0.1-next.36](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.1-next.35...api-auth-entity-storage-models-v0.0.1-next.36) (2025-06-17)
11
+
12
+
13
+ ### Miscellaneous Chores
14
+
15
+ * **api-auth-entity-storage-models:** Synchronize repo versions
16
+
17
+ ## [0.0.1-next.35](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.1-next.34...api-auth-entity-storage-models-v0.0.1-next.35) (2025-06-11)
18
+
19
+
20
+ ### Features
21
+
22
+ * update dependencies ([1171dc4](https://github.com/twinfoundation/api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
23
+
24
+ ## [0.0.1-next.34](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.1-next.33...api-auth-entity-storage-models-v0.0.1-next.34) (2025-05-27)
25
+
26
+
27
+ ### Miscellaneous Chores
28
+
29
+ * **api-auth-entity-storage-models:** Synchronize repo versions
30
+
31
+ ## [0.0.1-next.33](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.1-next.32...api-auth-entity-storage-models-v0.0.1-next.33) (2025-04-17)
32
+
33
+
34
+ ### Features
35
+
36
+ * use shared store mechanism ([#19](https://github.com/twinfoundation/api/issues/19)) ([32116df](https://github.com/twinfoundation/api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
37
+
38
+ ## [0.0.1-next.32](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.1-next.31...api-auth-entity-storage-models-v0.0.1-next.32) (2025-03-28)
39
+
40
+
41
+ ### Features
42
+
43
+ * improve description ([d28185c](https://github.com/twinfoundation/api/commit/d28185c799a97455fee72fb23c744c8e71325f0b))
44
+
45
+ ## v0.0.1-next.31
4
46
 
5
47
  - Initial Release
package/docs/reference/interfaces/IAuthenticationComponent.md CHANGED
@@ -10,45 +10,43 @@ Contract definition for authentication component.
10
10
 
11
11
  ### login()
12
12
 
13
- > **login**(`email`, `password`): `Promise`\<`object`\>
13
+ > **login**(`email`, `password`): `Promise`\<\{ `token?`: `string`; `expiry`: `number`; \}\>
14
14
 
15
15
  Perform a login for the user.
16
16
 
17
17
  #### Parameters
18
18
 
19
- • **email**: `string`
19
+ ##### email
20
+
21
+ `string`
20
22
 
21
23
  The email address for the user.
22
24
 
23
- • **password**: `string`
25
+ ##### password
26
+
27
+ `string`
24
28
 
25
29
  The password for the user.
26
30
 
27
31
  #### Returns
28
32
 
29
- `Promise`\<`object`\>
33
+ `Promise`\<\{ `token?`: `string`; `expiry`: `number`; \}\>
30
34
 
31
35
  The authentication token for the user, if it uses a mechanism with public access.
32
36
 
33
- ##### token?
34
-
35
- > `optional` **token**: `string`
36
-
37
- ##### expiry
38
-
39
- > **expiry**: `number`
40
-
41
37
  ***
42
38
 
43
39
  ### logout()
44
40
 
45
- > **logout**(`token`?): `Promise`\<`void`\>
41
+ > **logout**(`token?`): `Promise`\<`void`\>
46
42
 
47
43
  Logout the current user.
48
44
 
49
45
  #### Parameters
50
46
 
51
- • **token?**: `string`
47
+ ##### token?
48
+
49
+ `string`
52
50
 
53
51
  The token to logout, if it uses a mechanism with public access.
54
52
 
@@ -62,26 +60,20 @@ Nothing.
62
60
 
63
61
  ### refresh()
64
62
 
65
- > **refresh**(`token`?): `Promise`\<`object`\>
63
+ > **refresh**(`token?`): `Promise`\<\{ `token?`: `string`; `expiry`: `number`; \}\>
66
64
 
67
65
  Refresh the token.
68
66
 
69
67
  #### Parameters
70
68
 
71
- • **token?**: `string`
69
+ ##### token?
70
+
71
+ `string`
72
72
 
73
73
  The token to refresh, if it uses a mechanism with public access.
74
74
 
75
75
  #### Returns
76
76
 
77
- `Promise`\<`object`\>
77
+ `Promise`\<\{ `token?`: `string`; `expiry`: `number`; \}\>
78
78
 
79
79
  The refreshed token, if it uses a mechanism with public access.
80
-
81
- ##### token?
82
-
83
- > `optional` **token**: `string`
84
-
85
- ##### expiry
86
-
87
- > **expiry**: `number`
package/docs/reference/interfaces/IRefreshTokenRequest.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Interface: IRefreshTokenRequest
2
2
 
3
- Perform a refresh on the auth token.
3
+ Perform a refresh of the auth token.
4
4
 
5
5
  ## Properties
6
6
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/api-auth-entity-storage-models",
3
- "version": "0.0.1-next.9",
3
+ "version": "0.0.1",
4
4
  "description": "Models which define the structure of the Auth Entity Storage contracts.",
5
5
  "repository": {
6
6
  "type": "git",
@@ -14,18 +14,18 @@
14
14
  "node": ">=20.0.0"
15
15
  },
16
16
  "dependencies": {
17
- "@twin.org/core": "next",
18
- "@twin.org/nameof": "next",
19
- "@twin.org/web": "next"
17
+ "@twin.org/core": "^0.0.1",
18
+ "@twin.org/nameof": "^0.0.1",
19
+ "@twin.org/web": "^0.0.1"
20
20
  },
21
21
  "main": "./dist/cjs/index.cjs",
22
22
  "module": "./dist/esm/index.mjs",
23
23
  "types": "./dist/types/index.d.ts",
24
24
  "exports": {
25
25
  ".": {
26
+ "types": "./dist/types/index.d.ts",
26
27
  "require": "./dist/cjs/index.cjs",
27
- "import": "./dist/esm/index.mjs",
28
- "types": "./dist/types/index.d.ts"
28
+ "import": "./dist/esm/index.mjs"
29
29
  }
30
30
  },
31
31
  "files": [