@twin.org/api-auth-entity-storage-models 0.0.2-next.9 → 0.0.3-next.2

package/dist/es/index.js

@@ -0,0 +1,11 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./models/api/ILoginRequest.js";
+export * from "./models/api/ILoginResponse.js";
+export * from "./models/api/ILogoutRequest.js";
+export * from "./models/api/IRefreshTokenRequest.js";
+export * from "./models/api/IRefreshTokenResponse.js";
+export * from "./models/api/IUpdatePasswordRequest.js";
+export * from "./models/IAuthenticationAdminComponent.js";
+export * from "./models/IAuthenticationComponent.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sCAAsC,CAAC;AACrD,cAAc,uCAAuC,CAAC;AACtD,cAAc,wCAAwC,CAAC;AACvD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,sCAAsC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./models/api/ILoginRequest.js\";\nexport * from \"./models/api/ILoginResponse.js\";\nexport * from \"./models/api/ILogoutRequest.js\";\nexport * from \"./models/api/IRefreshTokenRequest.js\";\nexport * from \"./models/api/IRefreshTokenResponse.js\";\nexport * from \"./models/api/IUpdatePasswordRequest.js\";\nexport * from \"./models/IAuthenticationAdminComponent.js\";\nexport * from \"./models/IAuthenticationComponent.js\";\n"]}

package/dist/es/models/IAuthenticationAdminComponent.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IAuthenticationAdminComponent.js.map

package/dist/es/models/IAuthenticationAdminComponent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAuthenticationAdminComponent.js","sourceRoot":"","sources":["../../../src/models/IAuthenticationAdminComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\n\n/**\n * Contract definition for authentication admin component.\n */\nexport interface IAuthenticationAdminComponent extends IComponent {\n\t/**\n\t * Create a login for the user.\n\t * @param email The email address for the user.\n\t * @param password The password for the user.\n\t * @param userIdentity The DID to associate with the account.\n\t * @param organizationIdentity The organization of the user.\n\t * @returns Nothing.\n\t */\n\tcreate(\n\t\temail: string,\n\t\tpassword: string,\n\t\tuserIdentity: string,\n\t\torganizationIdentity: string\n\t): Promise<void>;\n\n\t/**\n\t * Remove the current user.\n\t * @param email The email address of the user to remove.\n\t * @returns Nothing.\n\t */\n\tremove(email: string): Promise<void>;\n\n\t/**\n\t * Update the user's password.\n\t * @param email The email address of the user to update.\n\t * @param newPassword The new password for the user.\n\t * @param currentPassword The current password, optional, if supplied will check against existing.\n\t * @returns Nothing.\n\t */\n\tupdatePassword(email: string, newPassword: string, currentPassword?: string): Promise<void>;\n}\n"]}

package/dist/es/models/IAuthenticationComponent.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IAuthenticationComponent.js.map

package/dist/es/models/IAuthenticationComponent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAuthenticationComponent.js","sourceRoot":"","sources":["../../../src/models/IAuthenticationComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\n\n/**\n * Contract definition for authentication component.\n */\nexport interface IAuthenticationComponent extends IComponent {\n\t/**\n\t * Perform a login for the user.\n\t * @param email The email address for the user.\n\t * @param password The password for the user.\n\t * @returns The authentication token for the user, if it uses a mechanism with public access.\n\t */\n\tlogin(\n\t\temail: string,\n\t\tpassword: string\n\t): Promise<{\n\t\ttoken?: string;\n\t\texpiry: number;\n\t}>;\n\n\t/**\n\t * Logout the current user.\n\t * @param token The token to logout, if it uses a mechanism with public access.\n\t * @returns Nothing.\n\t */\n\tlogout(token?: string): Promise<void>;\n\n\t/**\n\t * Refresh the token.\n\t * @param token The token to refresh, if it uses a mechanism with public access.\n\t * @returns The refreshed token, if it uses a mechanism with public access.\n\t */\n\trefresh(token?: string): Promise<{\n\t\ttoken?: string;\n\t\texpiry: number;\n\t}>;\n\n\t/**\n\t * Update the user's password.\n\t * @param email The email address of the user to update.\n\t * @param currentPassword The current password for the user.\n\t * @param newPassword The new password for the user.\n\t * @returns Nothing.\n\t */\n\tupdatePassword(email: string, currentPassword: string, newPassword: string): Promise<void>;\n}\n"]}

package/dist/es/models/api/ILoginRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=ILoginRequest.js.map

package/dist/es/models/api/ILoginRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ILoginRequest.js","sourceRoot":"","sources":["../../../../src/models/api/ILoginRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Perform a login on the server.\n */\nexport interface ILoginRequest {\n\t/**\n\t * The login details.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The email address for the user.\n\t\t */\n\t\temail: string;\n\n\t\t/**\n\t\t * The password for the user.\n\t\t */\n\t\tpassword: string;\n\t};\n}\n"]}

package/dist/es/models/api/ILoginResponse.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=ILoginResponse.js.map

package/dist/es/models/api/ILoginResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ILoginResponse.js","sourceRoot":"","sources":["../../../../src/models/api/ILoginResponse.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Response from a login on the server.\n */\nexport interface ILoginResponse {\n\t/**\n\t * The login response details.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The access token, if it uses a mechanism with public access.\n\t\t */\n\t\ttoken?: string;\n\n\t\t/**\n\t\t * The expiry time of the token.\n\t\t */\n\t\texpiry: number;\n\t};\n}\n"]}

package/dist/es/models/api/ILogoutRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=ILogoutRequest.js.map

package/dist/es/models/api/ILogoutRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ILogoutRequest.js","sourceRoot":"","sources":["../../../../src/models/api/ILogoutRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Perform a logout on the auth token.\n */\nexport interface ILogoutRequest {\n\t/**\n\t * The logout token details.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * The token to logout, if it uses a mechanism with public access.\n\t\t */\n\t\ttoken?: string;\n\t};\n}\n"]}

package/dist/es/models/api/IRefreshTokenRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IRefreshTokenRequest.js.map

package/dist/es/models/api/IRefreshTokenRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IRefreshTokenRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IRefreshTokenRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Perform a refresh of the auth token.\n */\nexport interface IRefreshTokenRequest {\n\t/**\n\t * The refresh token details.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * The token to refresh, if it uses a mechanism with public access.\n\t\t */\n\t\ttoken?: string;\n\t};\n}\n"]}

package/dist/es/models/api/IRefreshTokenResponse.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IRefreshTokenResponse.js.map

package/dist/es/models/api/IRefreshTokenResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IRefreshTokenResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IRefreshTokenResponse.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Response from a refresh on the auth token.\n */\nexport interface IRefreshTokenResponse {\n\t/**\n\t * The refresh token details.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The refreshed token, if it uses a mechanism with public access.\n\t\t */\n\t\ttoken?: string;\n\n\t\t/**\n\t\t * The expiry time of the token.\n\t\t */\n\t\texpiry: number;\n\t};\n}\n"]}

package/dist/es/models/api/IUpdatePasswordRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IUpdatePasswordRequest.js.map

package/dist/es/models/api/IUpdatePasswordRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IUpdatePasswordRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IUpdatePasswordRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Update a users password.\n */\nexport interface IUpdatePasswordRequest {\n\t/**\n\t * The path parameters for the request.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The user email.\n\t\t */\n\t\temail: string;\n\t};\n\n\t/**\n\t * The body of the request.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The current password for the user.\n\t\t */\n\t\tcurrentPassword: string;\n\n\t\t/**\n\t\t * The new password for the user.\n\t\t */\n\t\tnewPassword: string;\n\t};\n}\n"]}

package/dist/types/index.d.ts

@@ -1,8 +1,8 @@
-export * from "./models/api/ILoginRequest";
-export * from "./models/api/ILoginResponse";
-export * from "./models/api/ILogoutRequest";
-export * from "./models/api/IRefreshTokenRequest";
-export * from "./models/api/IRefreshTokenResponse";
-export * from "./models/api/IUpdatePasswordRequest";
-export * from "./models/IAuthenticationAdminComponent";
-export * from "./models/IAuthenticationComponent";
+export * from "./models/api/ILoginRequest.js";
+export * from "./models/api/ILoginResponse.js";
+export * from "./models/api/ILogoutRequest.js";
+export * from "./models/api/IRefreshTokenRequest.js";
+export * from "./models/api/IRefreshTokenResponse.js";
+export * from "./models/api/IUpdatePasswordRequest.js";
+export * from "./models/IAuthenticationAdminComponent.js";
+export * from "./models/IAuthenticationComponent.js";

package/dist/types/models/IAuthenticationAdminComponent.d.ts

@@ -7,10 +7,11 @@ export interface IAuthenticationAdminComponent extends IComponent {
      * Create a login for the user.
      * @param email The email address for the user.
      * @param password The password for the user.
-     * @param identity The DID to associate with the account.
+     * @param userIdentity The DID to associate with the account.
+     * @param organizationIdentity The organization of the user.
      * @returns Nothing.
      */
-    create(email: string, password: string, identity: string): Promise<void>;
+    create(email: string, password: string, userIdentity: string, organizationIdentity: string): Promise<void>;
     /**
      * Remove the current user.
      * @param email The email address of the user to remove.

package/docs/changelog.md

@@ -1,5 +1,57 @@
 # @twin.org/api-auth-entity-storage-models - Changelog
 
+## [0.0.3-next.2](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.3-next.1...api-auth-entity-storage-models-v0.0.3-next.2) (2025-11-12)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
+
+## [0.0.3-next.1](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.3-next.0...api-auth-entity-storage-models-v0.0.3-next.1) (2025-11-10)
+
+
+### Features
+
+* add context id features ([#42](https://github.com/twinfoundation/api/issues/42)) ([0186055](https://github.com/twinfoundation/api/commit/0186055c48afde842a4254b4df9ac9249c40fe40))
+* add json-ld mime type processor and auth admin component ([8861791](https://github.com/twinfoundation/api/commit/88617916e23bfbca023dbae1976fe421983a02ff))
+* add validate-locales ([cdba610](https://github.com/twinfoundation/api/commit/cdba610a0acb5022d2e3ce729732e6646a297e5e))
+* eslint migration to flat config ([0dd5820](https://github.com/twinfoundation/api/commit/0dd5820e3af97350fd08b8d226f4a6c1a9246805))
+* improve description ([d28185c](https://github.com/twinfoundation/api/commit/d28185c799a97455fee72fb23c744c8e71325f0b))
+* improve socket route logging ([b8d9519](https://github.com/twinfoundation/api/commit/b8d95199f838ac6ba9f45c30ef7c4e613201ff53))
+* remove unused namespace ([08478f2](https://github.com/twinfoundation/api/commit/08478f27efda9beb0271fdb22f6972e918361965))
+* update dependencies ([1171dc4](https://github.com/twinfoundation/api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
+* update framework core ([d8eebf2](https://github.com/twinfoundation/api/commit/d8eebf267fa2a0abaa84e58590496e9d20490cfa))
+* update IComponent signatures ([915ce37](https://github.com/twinfoundation/api/commit/915ce37712326ab4aa6869c350eabaa4622e8430))
+* use shared store mechanism ([#19](https://github.com/twinfoundation/api/issues/19)) ([32116df](https://github.com/twinfoundation/api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
+
+## [0.0.2-next.13](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.2-next.12...api-auth-entity-storage-models-v0.0.2-next.13) (2025-10-09)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
+
+## [0.0.2-next.12](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.2-next.11...api-auth-entity-storage-models-v0.0.2-next.12) (2025-10-09)
+
+
+### Features
+
+* add validate-locales ([cdba610](https://github.com/twinfoundation/api/commit/cdba610a0acb5022d2e3ce729732e6646a297e5e))
+
+## [0.0.2-next.11](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.2-next.10...api-auth-entity-storage-models-v0.0.2-next.11) (2025-09-29)
+
+
+### Features
+
+* update IComponent signatures ([915ce37](https://github.com/twinfoundation/api/commit/915ce37712326ab4aa6869c350eabaa4622e8430))
+
+## [0.0.2-next.10](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.2-next.9...api-auth-entity-storage-models-v0.0.2-next.10) (2025-09-23)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
+
 ## [0.0.2-next.9](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.2-next.8...api-auth-entity-storage-models-v0.0.2-next.9) (2025-08-29)
 
 

package/docs/reference/interfaces/IAuthenticationAdminComponent.md

@@ -10,7 +10,7 @@ Contract definition for authentication admin component.
 
 ### create()
 
-> **create**(`email`, `password`, `identity`): `Promise`\<`void`\>
+> **create**(`email`, `password`, `userIdentity`, `organizationIdentity`): `Promise`\<`void`\>
 
 Create a login for the user.
 
@@ -28,12 +28,18 @@ The email address for the user.
 
 The password for the user.
 
-##### identity
+##### userIdentity
 
 `string`
 
 The DID to associate with the account.
 
+##### organizationIdentity
+
+`string`
+
+The organization of the user.
+
 #### Returns
 
 `Promise`\<`void`\>

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-auth-entity-storage-models",
-	"version": "0.0.2-next.9",
+	"version": "0.0.3-next.2",
 	"description": "Models which define the structure of the Auth Entity Storage contracts.",
 	"repository": {
 		"type": "git",
@@ -18,21 +18,38 @@
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		}
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"
-	]
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"api",
+		"entity",
+		"storage",
+		"persistence",
+		"database",
+		"models",
+		"types",
+		"schemas"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/api/issues"
+	},
+	"homepage": "https://twindev.org"
 }

package/dist/cjs/index.cjs

@@ -1,2 +0,0 @@
-'use strict';
-

package/dist/esm/index.mjs

@@ -1 +0,0 @@
-