@twin.org/api-auth-entity-storage-models 0.0.3-next.20 → 0.0.3-next.21

package/README.md

@@ -1,6 +1,6 @@
-# TWIN Auth Entity Storage Models
+# TWIN API Auth Entity Storage Models
 
-Models which define the structure of the Auth Entity Storage contracts.
+This package provides contracts for authentication flows and admin user management with entity storage.
 
 ## Installation
 

package/docs/changelog.md

@@ -1,4 +1,11 @@
-# @twin.org/api-auth-entity-storage-models - Changelog
+# Changelog
+
+## [0.0.3-next.21](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.3-next.20...api-auth-entity-storage-models-v0.0.3-next.21) (2026-03-11)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
 
 ## [0.0.3-next.20](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.3-next.19...api-auth-entity-storage-models-v0.0.3-next.20) (2026-02-09)
 

package/docs/examples.md

@@ -1 +1,80 @@
-# @twin.org/api-auth-entity-storage-models - Examples
+# Auth Entity Storage Models Examples
+
+Use these snippets to shape request and response data consistently across sign-in flows, admin operations, and token refresh handling.
+
+## Authentication Requests
+
+```typescript
+import type {
+  ILoginRequest,
+  IRefreshTokenRequest,
+  IUpdatePasswordRequest
+} from '@twin.org/api-auth-entity-storage-models';
+
+const loginRequest: ILoginRequest = {
+  body: {
+    email: 'alice@example.org',
+    password: 'correct-horse-battery-staple'
+  }
+};
+
+const refreshRequest: IRefreshTokenRequest = {
+  query: {
+    token: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.refresh'
+  }
+};
+
+const updatePasswordRequest: IUpdatePasswordRequest = {
+  body: {
+    currentPassword: 'old-password',
+    newPassword: 'new-password-2026'
+  }
+};
+
+console.log(loginRequest.body.email); // alice@example.org
+```
+
+## Admin User Models
+
+```typescript
+import type {
+  IAdminUserCreateRequest,
+  IAdminUserUpdateRequest
+} from '@twin.org/api-auth-entity-storage-models';
+
+const createRequest: IAdminUserCreateRequest = {
+  body: {
+    email: 'bob@example.org',
+    password: 'initial-password',
+    userIdentity: 'did:example:bob',
+    organizationIdentity: 'did:example:org',
+    scope: ['admin', 'auditor']
+  }
+};
+
+const updateRequest: IAdminUserUpdateRequest = {
+  pathParams: {
+    email: 'bob@example.org'
+  },
+  body: {
+    userIdentity: 'did:example:bob:ops',
+    scope: ['admin']
+  }
+};
+
+console.log(createRequest.body.scope.length); // 2
+```
+
+## Authentication Responses
+
+```typescript
+import type { ILoginResponse } from '@twin.org/api-auth-entity-storage-models';
+
+const loginResponse: ILoginResponse = {
+  body: {
+    expiry: 3600
+  }
+};
+
+console.log(loginResponse.body.expiry); // 3600
+```

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@twin.org/api-auth-entity-storage-models",
-	"version": "0.0.3-next.20",
-	"description": "Models which define the structure of the Auth Entity Storage contracts.",
+	"version": "0.0.3-next.21",
+	"description": "Contracts for authentication flows and admin user management with entity storage.",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/api.git",