@3sixty/api-auth-entity-storage-models 0.0.0-stage → 0.20.0-next.1

package/dist/types/models/api/IAdminUserCreateRequest.d.ts

@@ -0,0 +1,12 @@
+import type { IAuthenticationUser } from "../IAuthenticationUser.js";
+/**
+ * Create a new user as an admin.
+ */
+export interface IAdminUserCreateRequest {
+    /**
+     * The body of the request.
+     */
+    body: IAuthenticationUser & {
+        password: string;
+    };
+}

package/dist/types/models/api/IAdminUserGetByIdentityRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Get a user as an admin.
+ */
+export interface IAdminUserGetByIdentityRequest {
+    /**
+     * The path parameters for the request.
+     */
+    pathParams: {
+        /**
+         * The user identity.
+         */
+        identity: string;
+    };
+}

package/dist/types/models/api/IAdminUserGetRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Get a user as an admin.
+ */
+export interface IAdminUserGetRequest {
+    /**
+     * The path parameters for the request.
+     */
+    pathParams: {
+        /**
+         * The user email.
+         */
+        email: string;
+    };
+}

package/dist/types/models/api/IAdminUserGetResponse.d.ts

@@ -0,0 +1,10 @@
+import type { IAuthenticationUser } from "../IAuthenticationUser.js";
+/**
+ * Get a user as an admin.
+ */
+export interface IAdminUserGetResponse {
+    /**
+     * The body of the request.
+     */
+    body: IAuthenticationUser;
+}

package/dist/types/models/api/IAdminUserRemoveRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Remove a user as an admin.
+ */
+export interface IAdminUserRemoveRequest {
+    /**
+     * The path parameters for the request.
+     */
+    pathParams: {
+        /**
+         * The user email.
+         */
+        email: string;
+    };
+}

package/dist/types/models/api/IAdminUserUpdatePasswordRequest.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Update a users password as an admin.
+ */
+export interface IAdminUserUpdatePasswordRequest {
+    /**
+     * The path parameters for the request.
+     */
+    pathParams: {
+        /**
+         * The user email.
+         */
+        email: string;
+    };
+    /**
+     * The body of the request.
+     */
+    body: {
+        /**
+         * The new password for the user.
+         */
+        newPassword: string;
+        /**
+         * The current password for the user.
+         */
+        currentPassword?: string;
+    };
+}

package/dist/types/models/api/IAdminUserUpdateRequest.d.ts

@@ -0,0 +1,19 @@
+import type { IAuthenticationUser } from "../IAuthenticationUser.js";
+/**
+ * Update a user as an admin.
+ */
+export interface IAdminUserUpdateRequest {
+    /**
+     * The path parameters for the request.
+     */
+    pathParams: {
+        /**
+         * The user email.
+         */
+        email: string;
+    };
+    /**
+     * The body of the request.
+     */
+    body: Partial<Omit<IAuthenticationUser, "email">>;
+}

package/dist/types/models/api/ILoginRequest.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Perform a login on the server.
+ */
+export interface ILoginRequest {
+    /**
+     * The login details.
+     */
+    body: {
+        /**
+         * The email address for the user.
+         */
+        email: string;
+        /**
+         * The password for the user.
+         */
+        password: string;
+    };
+}

package/dist/types/models/api/ILoginResponse.d.ts

@@ -0,0 +1,24 @@
+import type { HeaderTypes } from "@3sixty/web";
+/**
+ * Response from a login on the server.
+ */
+export interface ILoginResponse {
+    /**
+     * Response headers.
+     */
+    headers?: {
+        /**
+         * The cookie containing the auth token.
+         */
+        [HeaderTypes.SetCookie]?: string;
+    };
+    /**
+     * The login response details.
+     */
+    body: {
+        /**
+         * The expiry time of the token.
+         */
+        expiry: number;
+    };
+}

package/dist/types/models/api/ILogoutRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Perform a logout on the auth token.
+ */
+export interface ILogoutRequest {
+    /**
+     * The logout token details.
+     */
+    body?: {
+        /**
+         * The token to logout, if it uses a mechanism with public access.
+         */
+        token?: string;
+    };
+}

package/dist/types/models/api/IPasswordPolicyResponse.d.ts

@@ -0,0 +1,10 @@
+import type { IPasswordOptions } from "../IPasswordOptions.js";
+/**
+ * Get the password policy.
+ */
+export interface IPasswordPolicyResponse {
+    /**
+     * The body of the response.
+     */
+    body: IPasswordOptions;
+}

package/dist/types/models/api/IRefreshTokenRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Perform a refresh of the auth token.
+ */
+export interface IRefreshTokenRequest {
+    /**
+     * The refresh token details.
+     */
+    body?: {
+        /**
+         * The token to refresh, if it uses a mechanism with public access.
+         */
+        token?: string;
+    };
+}

package/dist/types/models/api/IRefreshTokenResponse.d.ts

@@ -0,0 +1,24 @@
+import type { HeaderTypes } from "@3sixty/web";
+/**
+ * Response from a refresh on the auth token.
+ */
+export interface IRefreshTokenResponse {
+    /**
+     * Response headers.
+     */
+    headers?: {
+        /**
+         * The cookie containing the auth token.
+         */
+        [HeaderTypes.SetCookie]?: string;
+    };
+    /**
+     * The refresh token details.
+     */
+    body: {
+        /**
+         * The expiry time of the token.
+         */
+        expiry: number;
+    };
+}

package/dist/types/models/api/IUpdatePasswordRequest.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Update the current user's password.
+ */
+export interface IUpdatePasswordRequest {
+    /**
+     * The body of the request.
+     */
+    body: {
+        /**
+         * The current password for the user.
+         */
+        currentPassword: string;
+        /**
+         * The new password for the user.
+         */
+        newPassword: string;
+    };
+}

package/docs/changelog.md

@@ -0,0 +1,11 @@
+# Changelog
+
+## [0.20.0-next.1](https://github.com/3sixtyglobal/api-auth/compare/api-auth-entity-storage-models-v0.20.0-next.0...api-auth-entity-storage-models-v0.20.0-next.1) (2026-10-23)
+
+
+### Features
+
+* authorization ([#3](https://github.com/3sixtyglobal/api-auth/issues/3)) ([5688693](https://github.com/3sixtyglobal/api-auth/commit/568869364065b9d2c82c5c17c81f07cbdc64ec8b))
+* initial commit ([b9112fb](https://github.com/3sixtyglobal/api-auth/commit/b9112fb6994758b43effdde1b9e41435ff50fe50))
+* publish packages under the [@3sixty](https://github.com/3sixty) namespace ([6c22482](https://github.com/3sixtyglobal/api-auth/commit/6c2248295620000807ff91087c3b1dfc9b018b31))
+* updated ts compile ([83c72bd](https://github.com/3sixtyglobal/api-auth/commit/83c72bd5d2e9d81208b7a2755450d96fbbb04004))

package/docs/examples.md

@@ -0,0 +1,89 @@
+# 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 '@3sixty/api-auth-entity-storage-models';
+
+const loginRequest: ILoginRequest = {
+  body: {
+    email: 'alice@example.org',
+    password: 'correct-horse-battery-staple'
+  }
+};
+
+const refreshRequest: IRefreshTokenRequest = {
+  body: {
+    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 '@3sixty/api-auth-entity-storage-models';
+
+const createRequest: IAdminUserCreateRequest = {
+  body: {
+    email: 'bob@example.org',
+    password: 'initial-password',
+    userIdentity: 'did:example:bob',
+    organizationIdentity: 'did:example:org'
+  }
+};
+
+const updateRequest: IAdminUserUpdateRequest = {
+  pathParams: {
+    email: 'bob@example.org'
+  },
+  body: {
+    userIdentity: 'did:example:bob:ops'
+  }
+};
+
+console.log(updateRequest.body.userIdentity); // did:example:bob:ops
+```
+
+## Authentication Responses
+
+```typescript
+import type {
+  ILoginResponse,
+  IPasswordPolicyResponse
+} from '@3sixty/api-auth-entity-storage-models';
+
+const loginResponse: ILoginResponse = {
+  body: {
+    expiry: 3600
+  }
+};
+
+const passwordPolicyResponse: IPasswordPolicyResponse = {
+  body: {
+    minPasswordLength: 8,
+    maxPasswordLength: 128
+  }
+};
+
+console.log(loginResponse.body.expiry); // 3600
+console.log(passwordPolicyResponse.body.minPasswordLength); // 8
+```

package/docs/reference/index.md

@@ -0,0 +1,23 @@
+# @3sixty/api-auth-entity-storage-models
+
+## Interfaces
+
+- [IAuthenticationAdminComponent](interfaces/IAuthenticationAdminComponent.md)
+- [IAuthenticationComponent](interfaces/IAuthenticationComponent.md)
+- [IAuthenticationUser](interfaces/IAuthenticationUser.md)
+- [IAuthenticationUserSecure](interfaces/IAuthenticationUserSecure.md)
+- [IPasswordOptions](interfaces/IPasswordOptions.md)
+- [IAdminUserCreateRequest](interfaces/IAdminUserCreateRequest.md)
+- [IAdminUserGetByIdentityRequest](interfaces/IAdminUserGetByIdentityRequest.md)
+- [IAdminUserGetRequest](interfaces/IAdminUserGetRequest.md)
+- [IAdminUserGetResponse](interfaces/IAdminUserGetResponse.md)
+- [IAdminUserRemoveRequest](interfaces/IAdminUserRemoveRequest.md)
+- [IAdminUserUpdatePasswordRequest](interfaces/IAdminUserUpdatePasswordRequest.md)
+- [IAdminUserUpdateRequest](interfaces/IAdminUserUpdateRequest.md)
+- [ILoginRequest](interfaces/ILoginRequest.md)
+- [ILoginResponse](interfaces/ILoginResponse.md)
+- [ILogoutRequest](interfaces/ILogoutRequest.md)
+- [IPasswordPolicyResponse](interfaces/IPasswordPolicyResponse.md)
+- [IRefreshTokenRequest](interfaces/IRefreshTokenRequest.md)
+- [IRefreshTokenResponse](interfaces/IRefreshTokenResponse.md)
+- [IUpdatePasswordRequest](interfaces/IUpdatePasswordRequest.md)

package/docs/reference/interfaces/IAdminUserCreateRequest.md

@@ -0,0 +1,17 @@
+# Interface: IAdminUserCreateRequest
+
+Create a new user as an admin.
+
+## Properties
+
+### body {#body}
+
+> **body**: [`IAuthenticationUser`](IAuthenticationUser.md) & `object`
+
+The body of the request.
+
+#### Type Declaration
+
+##### password
+
+> **password**: `string`

package/docs/reference/interfaces/IAdminUserGetByIdentityRequest.md

@@ -0,0 +1,17 @@
+# Interface: IAdminUserGetByIdentityRequest
+
+Get a user as an admin.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters for the request.
+
+#### identity
+
+> **identity**: `string`
+
+The user identity.

package/docs/reference/interfaces/IAdminUserGetRequest.md

@@ -0,0 +1,17 @@
+# Interface: IAdminUserGetRequest
+
+Get a user as an admin.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters for the request.
+
+#### email
+
+> **email**: `string`
+
+The user email.

package/docs/reference/interfaces/IAdminUserGetResponse.md

@@ -0,0 +1,11 @@
+# Interface: IAdminUserGetResponse
+
+Get a user as an admin.
+
+## Properties
+
+### body {#body}
+
+> **body**: [`IAuthenticationUser`](IAuthenticationUser.md)
+
+The body of the request.

package/docs/reference/interfaces/IAdminUserRemoveRequest.md

@@ -0,0 +1,17 @@
+# Interface: IAdminUserRemoveRequest
+
+Remove a user as an admin.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters for the request.
+
+#### email
+
+> **email**: `string`
+
+The user email.

package/docs/reference/interfaces/IAdminUserUpdatePasswordRequest.md

@@ -0,0 +1,37 @@
+# Interface: IAdminUserUpdatePasswordRequest
+
+Update a users password as an admin.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters for the request.
+
+#### email
+
+> **email**: `string`
+
+The user email.
+
+***
+
+### body {#body}
+
+> **body**: `object`
+
+The body of the request.
+
+#### newPassword
+
+> **newPassword**: `string`
+
+The new password for the user.
+
+#### currentPassword?
+
+> `optional` **currentPassword?**: `string`
+
+The current password for the user.

package/docs/reference/interfaces/IAdminUserUpdateRequest.md

@@ -0,0 +1,25 @@
+# Interface: IAdminUserUpdateRequest
+
+Update a user as an admin.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters for the request.
+
+#### email
+
+> **email**: `string`
+
+The user email.
+
+***
+
+### body {#body}
+
+> **body**: `Partial`\<`Omit`\<[`IAuthenticationUser`](IAuthenticationUser.md), `"email"`\>\>
+
+The body of the request.

package/docs/reference/interfaces/IAuthenticationAdminComponent.md

@@ -0,0 +1,151 @@
+# Interface: IAuthenticationAdminComponent
+
+Contract definition for authentication admin component.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### create() {#create}
+
+> **create**(`user`): `Promise`\<`void`\>
+
+Create a login for the user.
+
+#### Parameters
+
+##### user
+
+[`IAuthenticationUser`](IAuthenticationUser.md) & `object`
+
+The user to create.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the user account has been created.
+
+***
+
+### update() {#update}
+
+> **update**(`user`): `Promise`\<`void`\>
+
+Update a login for the user.
+
+#### Parameters
+
+##### user
+
+`Partial`\<[`IAuthenticationUser`](IAuthenticationUser.md)\>
+
+The user to update.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the user account has been updated.
+
+***
+
+### get() {#get}
+
+> **get**(`email`): `Promise`\<[`IAuthenticationUser`](IAuthenticationUser.md)\>
+
+Get a user by email.
+
+#### Parameters
+
+##### email
+
+`string`
+
+The email address of the user to get.
+
+#### Returns
+
+`Promise`\<[`IAuthenticationUser`](IAuthenticationUser.md)\>
+
+The user details.
+
+***
+
+### getByIdentity() {#getbyidentity}
+
+> **getByIdentity**(`identity`): `Promise`\<[`IAuthenticationUser`](IAuthenticationUser.md)\>
+
+Get a user by identity.
+
+#### Parameters
+
+##### identity
+
+`string`
+
+The identity of the user to get.
+
+#### Returns
+
+`Promise`\<[`IAuthenticationUser`](IAuthenticationUser.md)\>
+
+The user details.
+
+***
+
+### remove() {#remove}
+
+> **remove**(`email`): `Promise`\<`void`\>
+
+Remove a user.
+
+#### Parameters
+
+##### email
+
+`string`
+
+The email address of the user to remove.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the user account has been removed.
+
+***
+
+### updatePassword() {#updatepassword}
+
+> **updatePassword**(`email`, `newPassword`, `currentPassword?`): `Promise`\<`void`\>
+
+Update the user's password.
+
+#### Parameters
+
+##### email
+
+`string`
+
+The email address of the user to update.
+
+##### newPassword
+
+`string`
+
+The new password for the user.
+
+##### currentPassword?
+
+`string`
+
+The current password, optional, if supplied will check against existing.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the password has been updated.