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

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/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/dist/types/models/authAuditEvent.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Supported authentication audit events.
+ */
+export declare const AuthAuditEvent: {
+    /**
+     * Login success.
+     */
+    readonly LoginSuccess: "login-success";
+    /**
+     * Login failure.
+     */
+    readonly LoginFailure: "login-failure";
+    /**
+     * Logout.
+     */
+    readonly Logout: "logout";
+    /**
+     * Token refreshed.
+     */
+    readonly TokenRefreshed: "token-refreshed";
+    /**
+     * Account created.
+     */
+    readonly AccountCreated: "account-created";
+    /**
+     * Account deleted.
+     */
+    readonly AccountDeleted: "account-deleted";
+    /**
+     * Account updated.
+     */
+    readonly AccountUpdated: "account-updated";
+    /**
+     * Account locked.
+     */
+    readonly AccountLocked: "account-locked";
+    /**
+     * Account unlocked.
+     */
+    readonly AccountUnlocked: "account-unlocked";
+    /**
+     * Password changed.
+     */
+    readonly PasswordChanged: "password-changed";
+};
+/**
+ * Supported authentication audit event values.
+ */
+export type AuthAuditEvent = (typeof AuthAuditEvent)[keyof typeof AuthAuditEvent];

package/docs/examples.md

@@ -0,0 +1,80 @@
+# 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',
+    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 '@3sixty/api-auth-entity-storage-models';
+
+const loginResponse: ILoginResponse = {
+  body: {
+    expiry: 3600
+  }
+};
+
+console.log(loginResponse.body.expiry); // 3600
+```

package/docs/reference/index.md

@@ -0,0 +1,40 @@
+# @3sixty/api-auth-entity-storage-models
+
+## Interfaces
+
+- [IAuthenticationAdminComponent](interfaces/IAuthenticationAdminComponent.md)
+- [IAuthenticationAuditComponent](interfaces/IAuthenticationAuditComponent.md)
+- [IAuthenticationAuditEntry](interfaces/IAuthenticationAuditEntry.md)
+- [IAuthenticationComponent](interfaces/IAuthenticationComponent.md)
+- [IAuthenticationRateActionConfig](interfaces/IAuthenticationRateActionConfig.md)
+- [IAuthenticationRateComponent](interfaces/IAuthenticationRateComponent.md)
+- [IAuthenticationUser](interfaces/IAuthenticationUser.md)
+- [IAuthenticationUserSecure](interfaces/IAuthenticationUserSecure.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)
+- [IAuditCreateRequest](interfaces/IAuditCreateRequest.md)
+- [IAuditGetRequest](interfaces/IAuditGetRequest.md)
+- [IAuditGetResponse](interfaces/IAuditGetResponse.md)
+- [IAuditQueryRequest](interfaces/IAuditQueryRequest.md)
+- [IAuditQueryResponse](interfaces/IAuditQueryResponse.md)
+- [IAuditRemoveRequest](interfaces/IAuditRemoveRequest.md)
+- [IAuditUpdateRequest](interfaces/IAuditUpdateRequest.md)
+- [ILoginRequest](interfaces/ILoginRequest.md)
+- [ILoginResponse](interfaces/ILoginResponse.md)
+- [ILogoutRequest](interfaces/ILogoutRequest.md)
+- [IRefreshTokenRequest](interfaces/IRefreshTokenRequest.md)
+- [IRefreshTokenResponse](interfaces/IRefreshTokenResponse.md)
+- [IUpdatePasswordRequest](interfaces/IUpdatePasswordRequest.md)
+
+## Type Aliases
+
+- [AuthAuditEvent](type-aliases/AuthAuditEvent.md)
+
+## Variables
+
+- [AuthAuditEvent](variables/AuthAuditEvent.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/IAuditCreateRequest.md

@@ -0,0 +1,11 @@
+# Interface: IAuditCreateRequest
+
+Create an authentication audit entry.
+
+## Properties
+
+### body {#body}
+
+> **body**: `Omit`\<[`IAuthenticationAuditEntry`](IAuthenticationAuditEntry.md), `"id"` \| `"dateCreated"`\>
+
+The body of the request.

package/docs/reference/interfaces/IAuditGetRequest.md

@@ -0,0 +1,17 @@
+# Interface: IAuditGetRequest
+
+Get an authentication audit entry by id.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters for the request.
+
+#### id
+
+> **id**: `string`
+
+The audit entry id.

package/docs/reference/interfaces/IAuditGetResponse.md

@@ -0,0 +1,11 @@
+# Interface: IAuditGetResponse
+
+Response from getting an authentication audit entry.
+
+## Properties
+
+### body {#body}
+
+> **body**: [`IAuthenticationAuditEntry`](IAuthenticationAuditEntry.md)
+
+The response body.

package/docs/reference/interfaces/IAuditQueryRequest.md

@@ -0,0 +1,65 @@
+# Interface: IAuditQueryRequest
+
+Query authentication audit entries.
+
+## Properties
+
+### query? {#query}
+
+> `optional` **query?**: `object`
+
+The query parameters for the request.
+
+#### actorId?
+
+> `optional` **actorId?**: `string`
+
+The actor identifier to filter by.
+
+#### organizationId?
+
+> `optional` **organizationId?**: `string`
+
+The organization identifier to filter by.
+
+#### tenantId?
+
+> `optional` **tenantId?**: `string`
+
+The tenant identifier to filter by.
+
+#### nodeId?
+
+> `optional` **nodeId?**: `string`
+
+The node identifier to filter by.
+
+#### event?
+
+> `optional` **event?**: `string`
+
+The event to filter by.
+
+#### startDate?
+
+> `optional` **startDate?**: `string`
+
+The inclusive start date for filtering, in ISO 8601 format.
+
+#### endDate?
+
+> `optional` **endDate?**: `string`
+
+The inclusive end date for filtering, in ISO 8601 format.
+
+#### cursor?
+
+> `optional` **cursor?**: `string`
+
+The pagination cursor.
+
+#### limit?
+
+> `optional` **limit?**: `string`
+
+The maximum number of results to return.

package/docs/reference/interfaces/IAuditQueryResponse.md

@@ -0,0 +1,23 @@
+# Interface: IAuditQueryResponse
+
+Response from querying authentication audit entries.
+
+## Properties
+
+### body {#body}
+
+> **body**: `object`
+
+The response body.
+
+#### entries
+
+> **entries**: [`IAuthenticationAuditEntry`](IAuthenticationAuditEntry.md)[]
+
+The returned audit entries.
+
+#### cursor?
+
+> `optional` **cursor?**: `string`
+
+The cursor to retrieve the next page, if any.

package/docs/reference/interfaces/IAuditRemoveRequest.md

@@ -0,0 +1,17 @@
+# Interface: IAuditRemoveRequest
+
+Remove an authentication audit entry.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters for the request.
+
+#### id
+
+> **id**: `string`
+
+The audit entry id.

package/docs/reference/interfaces/IAuditUpdateRequest.md

@@ -0,0 +1,25 @@
+# Interface: IAuditUpdateRequest
+
+Update an authentication audit entry.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters for the request.
+
+#### id
+
+> **id**: `string`
+
+The audit entry id.
+
+***
+
+### body {#body}
+
+> **body**: `Partial`\<`Omit`\<[`IAuthenticationAuditEntry`](IAuthenticationAuditEntry.md), `"id"` \| `"dateCreated"`\>\>
+
+The body of the request.