@twin.org/api-auth-entity-storage-models 0.0.3-next.4 → 0.0.3-next.40

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

@@ -0,0 +1,18 @@
+import type { IAuthenticationUser } from "./IAuthenticationUser.js";
+/**
+ * Contract definition for authentication user.
+ */
+export interface IAuthenticationUserSecure extends IAuthenticationUser {
+    /**
+     * The encrypted password for the user.
+     */
+    password: string;
+    /**
+     * The salt for the password.
+     */
+    salt: string;
+    /**
+     * The tenant ID associated with the user, optional in single tenant contexts.
+     */
+    tenantId: string;
+}

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/IAuditCreateRequest.d.ts

@@ -0,0 +1,10 @@
+import type { IAuthenticationAuditEntry } from "../IAuthenticationAuditEntry.js";
+/**
+ * Create an authentication audit entry.
+ */
+export interface IAuditCreateRequest {
+    /**
+     * The body of the request.
+     */
+    body: Omit<IAuthenticationAuditEntry, "id" | "dateCreated">;
+}

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

@@ -0,0 +1,47 @@
+import type { AuthAuditEvent } from "../authAuditEvent.js";
+/**
+ * Query authentication audit entries.
+ */
+export interface IAuditQueryRequest {
+    /**
+     * The query parameters for the request.
+     */
+    query?: {
+        /**
+         * The actor identifier to filter by.
+         */
+        actorId?: string;
+        /**
+         * The organization identifier to filter by.
+         */
+        organizationId?: string;
+        /**
+         * The tenant identifier to filter by.
+         */
+        tenantId?: string;
+        /**
+         * The node identifier to filter by.
+         */
+        nodeId?: string;
+        /**
+         * The event to filter by.
+         */
+        event?: AuthAuditEvent | string;
+        /**
+         * The inclusive start date for filtering, in ISO 8601 format.
+         */
+        startDate?: string;
+        /**
+         * The inclusive end date for filtering, in ISO 8601 format.
+         */
+        endDate?: string;
+        /**
+         * The pagination cursor.
+         */
+        cursor?: string;
+        /**
+         * The maximum number of results to return.
+         */
+        limit?: string;
+    };
+}

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

@@ -0,0 +1,19 @@
+import type { IAuthenticationAuditEntry } from "../IAuthenticationAuditEntry.js";
+/**
+ * Response from querying authentication audit entries.
+ */
+export interface IAuditQueryResponse {
+    /**
+     * The response body.
+     */
+    body: {
+        /**
+         * The returned audit entries.
+         */
+        entries: IAuthenticationAuditEntry[];
+        /**
+         * The cursor to retrieve the next page, if any.
+         */
+        cursor?: string;
+    };
+}

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

@@ -1,15 +1,21 @@
+import type { HeaderTypes } from "@twin.org/web";
 /**
  * Response from a login on the server.
  */
 export interface ILoginResponse {
     /**
-     * The login response details.
+     * Response headers.
      */
-    body: {
+    headers?: {
         /**
-         * The access token, if it uses a mechanism with public access.
+         * The cookie containing the auth token.
          */
-        token?: string;
+        [HeaderTypes.SetCookie]?: string;
+    };
+    /**
+     * The login response details.
+     */
+    body: {
         /**
          * The expiry time of the token.
          */

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

@@ -5,7 +5,7 @@ export interface ILogoutRequest {
     /**
      * The logout token details.
      */
-    query?: {
+    body?: {
         /**
          * The token to logout, if it uses a mechanism with public access.
          */

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

@@ -5,7 +5,7 @@ export interface IRefreshTokenRequest {
     /**
      * The refresh token details.
      */
-    query?: {
+    body?: {
         /**
          * The token to refresh, if it uses a mechanism with public access.
          */

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

@@ -1,15 +1,21 @@
+import type { HeaderTypes } from "@twin.org/web";
 /**
  * Response from a refresh on the auth token.
  */
 export interface IRefreshTokenResponse {
     /**
-     * The refresh token details.
+     * Response headers.
      */
-    body: {
+    headers?: {
         /**
-         * The refreshed token, if it uses a mechanism with public access.
+         * The cookie containing the auth token.
          */
-        token?: string;
+        [HeaderTypes.SetCookie]?: string;
+    };
+    /**
+     * The refresh token details.
+     */
+    body: {
         /**
          * The expiry time of the token.
          */

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

@@ -1,16 +1,7 @@
 /**
- * Update a users password.
+ * Update the current user's password.
  */
 export interface IUpdatePasswordRequest {
-    /**
-     * The path parameters for the request.
-     */
-    pathParams: {
-        /**
-         * The user email.
-         */
-        email: string;
-    };
     /**
      * The body of the request.
      */

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];