@fragus/sam-types 1.2.5 → 1.2.6

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.2.5",
+  "version": "1.2.6",
   "name": "@fragus/sam-types",
   "description": "Typescript interfaces for all types used to communicate between SAM client(s) and the SAM API",
   "author": "Fragus",

package/types/admin/user/user.d.ts

@@ -7,6 +7,15 @@ export interface IAdminUserInfo {
   email: string
 }
 
+/**
+ * When the logged-in user's password was last set and when it expires, as ISO dates. Both are null for a password
+ * set before expiry was introduced and not dated yet, which never expires.
+ */
+export interface IPasswordStatus {
+  changedAt: string | null
+  expiresAt: string | null
+}
+
 export interface IUserPasswordChangeRequest {
   password: string
   newPassword: string

package/types/errorResponse.d.ts

@@ -9,6 +9,15 @@ export interface ApiError {
   messageReplacements?: { [key in string]: string }
 }
 
+/**
+ * The answer to a login whose password has expired. The token is a reset-password token, so the app can send the user
+ * to its reset-password page to choose a new one.
+ */
+export interface IPasswordExpiredError {
+  message: 'PASSWORD_EXPIRED'
+  resetToken: string
+}
+
 export interface INoContractsAvailableErrorParams {
   matchedData: VehiclePartial
   lookupCountry: null | {

package/types/responseErrors/passwordResponseErrors.d.ts

@@ -4,3 +4,9 @@ export type PasswordErrors =
   | 'WRONG_CURRENT_PASSWORD'
   | 'WRONG_PASSWORD'
   | 'MISSING_PASSWORD'
+  /** Login refused because the password is over a year old; see IPasswordExpiredError. */
+  | 'PASSWORD_EXPIRED'
+  /** A new password refused for being a common one, or for containing the user's email or name. */
+  | 'PASSWORD_TOO_COMMON'
+  /** A new password refused for being the same as the current one. */
+  | 'PASSWORD_UNCHANGED'

package/types/user.d.ts

@@ -7,4 +7,6 @@ export interface IUserResponse {
   contactPerson: IContactPersonResponse
   userRole: UserRole
   disabledAt: Date | null
+  /** Failed logins since the last successful one. */
+  failedLoginAttempts?: number
 }