@healthcloudai/hc-login-connector 0.2.0 → 0.2.1

package/README.md

@@ -114,7 +114,7 @@ The usage example above reads the value from local state.
 `getBaseUrl()` returns the currently configured base URL from local state.
 
 ```txt
-https://dev-api-healthcheck.healthcloud-services.com/api
+https://dev-api-healthcheck.healthcloud-services.com
 ```
 
 ---
@@ -247,6 +247,10 @@ list expected by the integration.
 - If `verifyEmailCode` is `true`, the client sends `VERIFY_EMAIL_CODE: "true"`.
 - If `verifyEmailCode` is `false` or omitted, `VERIFY_EMAIL_CODE` is not sent.
 
+#### OTP-based registration
+
+Use this when email verification should be handled through an OTP code. In this case, `verifyEmailCode` should be `true`.
+
 ```ts
 await loginClient.register(
   "john.smith@example.com",
@@ -268,7 +272,7 @@ await loginClient.register(
 ```
 
 #### Full API request
-Request sent for the usage example above:
+Request sent for the OTP example above:
 
 ```json
 {
@@ -295,6 +299,39 @@ Request sent for the usage example above:
 }
 ```
 
+#### Link-based registration
+
+Use this when email verification should be handled through an email link. In this case, `verifyEmailCode` should be omitted or `false`.
+
+```ts
+await loginClient.register(
+  "john.smith@example.com",
+  "ExamplePassword123!",
+  "John",
+  "Smith"
+);
+```
+
+Effective request body:
+
+```json
+{
+  "Data": {
+    "TenantID": "test-tenant",
+    "Credentials": {
+      "Email": "john.smith@example.com",
+      "Password": "ExamplePassword123!"
+    },
+    "User": {
+      "FirstName": "John",
+      "LastName": "Smith",
+      "Email": "john.smith@example.com",
+      "Attributes": {}
+    }
+  }
+}
+```
+
 #### API response
 
 Status:
@@ -332,6 +369,10 @@ Registers a patient for the configured tenant using the richer registration payl
 `verifyEmailCode` behaves the same way as in `register(...)`:
 when enabled, the client injects `VERIFY_EMAIL_CODE: "true"` into `User.Attributes`.
 
+#### OTP-based registration
+
+Use this when email verification should be handled through an OTP code. In this case, `verifyEmailCode` should be `true`.
+
 ```ts
 await loginClient.registerFull({
   email: "john.smith@example.com",
@@ -406,6 +447,40 @@ Request sent for the usage example above:
 }
 ```
 
+#### Link-based registration
+
+Use this when email verification should be handled through an email link. In this case, `verifyEmailCode` should be omitted or `false`.
+
+```ts
+await loginClient.registerFull({
+  email: "john.smith@example.com",
+  password: "ExamplePassword123!",
+  firstName: "John",
+  lastName: "Smith"
+});
+```
+
+Effective request body:
+
+```json
+{
+  "Data": {
+    "TenantID": "test-tenant",
+    "Credentials": {
+      "Email": "john.smith@example.com",
+      "Password": "ExamplePassword123!",
+      "TenantID": "test-tenant"
+    },
+    "User": {
+      "FirstName": "John",
+      "LastName": "Smith",
+      "Email": "john.smith@example.com",
+      "Attributes": {}
+    }
+  }
+}
+```
+
 #### API response
 
 Status:
@@ -440,6 +515,10 @@ when email verification should be handled through an OTP code, the client sends
 - If `options.verifyEmailCode` is `false` or omitted, `VERIFY_EMAIL_CODE` is not sent.
 - Calling `verifyEmail(...)` without `options` keeps OTP email verification disabled by default.
 
+#### OTP-based email verification
+
+Use this when email verification should be handled through an OTP code. In this case, `options.verifyEmailCode` should be `true`.
+
 ```ts
 await loginClient.verifyEmail(
   "john.smith@example.com",
@@ -452,7 +531,7 @@ await loginClient.verifyEmail(
 ```
 
 #### Full API request
-Request sent for the usage example above:
+Request sent for the OTP example above:
 
 ```json
 {
@@ -471,6 +550,34 @@ Request sent for the usage example above:
 }
 ```
 
+#### Link-based email verification
+
+Use this when email verification should be handled through an email link. In this case, `options.verifyEmailCode` should be omitted or `false`.
+
+```ts
+await loginClient.verifyEmail(
+  "john.smith@example.com",
+  "123456",
+  "en"
+);
+```
+
+Effective request body:
+
+```json
+{
+  "Data": {
+    "Data": "123456",
+    "Step": "EMAIL_VERIFY",
+    "User": {
+      "Email": "john.smith@example.com",
+      "TenantID": "test-tenant"
+    },
+    "Language": "en"
+  }
+}
+```
+
 #### API response
 
 Status:
@@ -505,6 +612,10 @@ when email verification should be handled through an OTP code, the client sends
 - If `options.verifyEmailCode` is `false` or omitted, `VERIFY_EMAIL_CODE` is not sent.
 - Calling `resendEmailVerify(...)` without `options` keeps OTP email verification disabled by default.
 
+#### OTP-based resend
+
+Use this when email verification should be handled through an OTP code. In this case, `options.verifyEmailCode` should be `true`.
+
 ```ts
 await loginClient.resendEmailVerify(
   "john.smith@example.com",
@@ -516,7 +627,7 @@ await loginClient.resendEmailVerify(
 ```
 
 #### Full API request
-Request sent for the usage example above:
+Request sent for the OTP example above:
 
 ```json
 {
@@ -535,6 +646,33 @@ Request sent for the usage example above:
 }
 ```
 
+#### Link-based resend
+
+Use this when email verification should be handled through an email link. In this case, `options.verifyEmailCode` should be omitted or `false`.
+
+```ts
+await loginClient.resendEmailVerify(
+  "john.smith@example.com",
+  "en"
+);
+```
+
+Effective request body:
+
+```json
+{
+  "Data": {
+    "Data": "",
+    "Step": "RESEND_EMAIL_VERIFY",
+    "User": {
+      "Email": "john.smith@example.com",
+      "TenantID": "test-tenant"
+    },
+    "Language": "en"
+  }
+}
+```
+
 #### API response
 
 Status:

package/dist/index.cjs

@@ -138,7 +138,7 @@ var HCLoginClient = class {
   // =========================================================================
   // Authentication
   // =========================================================================
-  async login(email, password, context = "PATIENT") {
+  async login(email, password) {
     if (!(email == null ? void 0 : email.trim())) {
       throw new import_hc_http.ValidationError({
         message: "Email is required.",
@@ -156,7 +156,7 @@ var HCLoginClient = class {
       "login",
       async () => {
         const response = await this.http.post(
-          `${this.config.baseUrl}/api/${this.resolveContextPath(context)}/login`,
+          `${this.config.baseUrl}/api/patient/login`,
           {
             Data: {
               Email: email,
@@ -180,7 +180,7 @@ var HCLoginClient = class {
       }
     );
   }
-  async refreshToken(refreshToken, context = "PATIENT") {
+  async refreshToken(refreshToken) {
     var _a, _b;
     const token = (_b = refreshToken == null ? void 0 : refreshToken.trim()) != null ? _b : (_a = this.tokens) == null ? void 0 : _a.refreshToken;
     if (!(token == null ? void 0 : token.trim())) {
@@ -200,7 +200,7 @@ var HCLoginClient = class {
           }
         };
         const response = await this.http.post(
-          `${this.config.baseUrl}/api/${this.resolveContextPath(context)}/refresh`,
+          `${this.config.baseUrl}/api/patient/refresh`,
           requestPayload,
           this.headers()
         );
@@ -266,7 +266,7 @@ var HCLoginClient = class {
       }
     );
   }
-  async requestPasswordReset(email, context = "PATIENT", isOTP = false) {
+  async requestPasswordReset(email, isOTP = false) {
     if (!(email == null ? void 0 : email.trim())) {
       throw new import_hc_http.ValidationError({
         message: "Email is required.",
@@ -277,19 +277,19 @@ var HCLoginClient = class {
     return this.execute(
       "requestPasswordReset",
       () => this.http.post(
-        `${this.config.baseUrl}/api/${this.resolveContextPath(context)}/resetpassword`,
+        `${this.config.baseUrl}/api/patient/resetpassword`,
         {
           Data: {
             Email: email,
             TenantID: this.config.tenantID,
-            IsPasswordResetWithOTP: isOTP
+            ...isOTP ? { IsPasswordResetWithOTP: true } : {}
           }
         },
         this.headers()
       )
     );
   }
-  async confirmPasswordReset(email, password, code, context = "PATIENT") {
+  async confirmPasswordReset(email, password, code) {
     if (!(email == null ? void 0 : email.trim())) {
       throw new import_hc_http.ValidationError({
         message: "Email is required.",
@@ -312,7 +312,7 @@ var HCLoginClient = class {
     return this.execute(
       "confirmPasswordReset",
       () => this.http.post(
-        `${this.config.baseUrl}/api/${this.resolveContextPath(context)}/password`,
+        `${this.config.baseUrl}/api/patient/password`,
         {
           Data: {
             Email: email,
@@ -336,6 +336,146 @@ var HCLoginClient = class {
     );
   }
   // =========================================================================
+  // Registration (full)
+  // =========================================================================
+  async registerFull(options = {}) {
+    var _a;
+    this.ensureConfigured();
+    const attributes = {
+      ...(_a = options.attributes) != null ? _a : {},
+      ...options.verifyEmailCode === true ? { VERIFY_EMAIL_CODE: "true" } : {}
+    };
+    return this.execute(
+      "registerFull",
+      () => {
+        var _a2, _b, _c, _d;
+        return this.http.post(
+          `${this.config.baseUrl}/api/patient/register`,
+          {
+            Data: {
+              TenantID: this.config.tenantID,
+              Credentials: {
+                Email: (_a2 = options.email) != null ? _a2 : "",
+                Password: (_b = options.password) != null ? _b : "",
+                TenantID: this.config.tenantID,
+                ...options.language ? { Language: options.language } : {}
+              },
+              User: {
+                FirstName: (_c = options.firstName) != null ? _c : "Unknown",
+                LastName: (_d = options.lastName) != null ? _d : "Unknown",
+                ...options.email ? { Email: options.email } : {},
+                ...options.phone ? { Phone: options.phone } : {},
+                ...options.birthDate ? { BirthDate: options.birthDate } : {},
+                ...options.gender ? { Gender: options.gender } : {},
+                ...options.middleName ? { MiddleName: options.middleName } : {},
+                ...options.race ? { Race: options.race } : {},
+                ...options.ethnicity ? { Ethnicity: options.ethnicity } : {},
+                ...options.sex ? { Sex: options.sex } : {},
+                ...options.genderIdentity ? { GenderIdentity: options.genderIdentity } : {},
+                ...options.status !== void 0 ? { Status: options.status } : {},
+                ...options.address ? { Address: options.address } : {},
+                Attributes: attributes
+              }
+            }
+          },
+          this.headers()
+        );
+      }
+    );
+  }
+  // =========================================================================
+  // Onboarding
+  // =========================================================================
+  async verifyEmail(email, code, language = "en", options = { verifyEmailCode: false }) {
+    return this.submitOnboardingStep(
+      "EMAIL_VERIFY",
+      this.buildEmailVerificationInput(email, options),
+      code,
+      language
+    );
+  }
+  async resendEmailVerify(email, language = "en", options = { verifyEmailCode: false }) {
+    return this.submitOnboardingStep(
+      "RESEND_EMAIL_VERIFY",
+      this.buildEmailVerificationInput(email, options),
+      "",
+      language
+    );
+  }
+  async resendSmsVerify(email, phone, language = "en") {
+    return this.submitOnboardingStep(
+      "RESEND_SMS_VERIFY",
+      { Email: email, Phone: phone },
+      "",
+      language
+    );
+  }
+  async verifySms(email, phone, code, language = "en") {
+    return this.submitOnboardingStep(
+      "SMS_VERIFY",
+      { Email: email, Phone: phone },
+      code,
+      language
+    );
+  }
+  async saveHealthProfile(profile, language = "en") {
+    return this.submitOnboardingStep(
+      "SAVE_HEALTH_PROFILE",
+      profile,
+      "",
+      language
+    );
+  }
+  async saveAddress(email, address, language = "en") {
+    return this.submitOnboardingStep(
+      "SAVE_ADDRESS",
+      { Email: email, Address: address },
+      "",
+      language
+    );
+  }
+  async submitOnboardingStep(step, user, data = "", language = "en") {
+    this.ensureConfigured();
+    const payload = {
+      Data: {
+        Data: data,
+        Step: step,
+        User: this.buildOnboardingUser(step, user),
+        Language: language
+      }
+    };
+    return this.execute(
+      `submitOnboardingStep(${step})`,
+      () => this.http.post(
+        `${this.config.baseUrl}/api/patient/onboard`,
+        payload,
+        this.headers()
+      )
+    );
+  }
+  // =========================================================================
+  // Password reset
+  // =========================================================================
+  async resetPassword(email, isPasswordResetWithOTP = false) {
+    return this.requestPasswordReset(email, isPasswordResetWithOTP);
+  }
+  async resetPasswordConfirm(payload) {
+    this.ensureConfigured();
+    return this.execute(
+      "resetPasswordConfirm",
+      () => this.http.post(
+        `${this.config.baseUrl}/api/patient/password`,
+        {
+          Data: {
+            ...payload.Data,
+            TenantID: this.config.tenantID
+          }
+        },
+        this.headers()
+      )
+    );
+  }
+  // =========================================================================
   // Private
   // =========================================================================
   async execute(operation, request) {
@@ -346,22 +486,6 @@ var HCLoginClient = class {
       if (err instanceof import_hc_http.APIError) {
         throw err;
       }
-      if (err instanceof TypeError) {
-        throw new import_hc_http.NetworkError({
-          message: `${operation}: network request failed`,
-          code: "NETWORK_ERROR",
-          details: err
-        });
-      }
-      if (err instanceof DOMException) {
-        if (err.name === "AbortError") {
-          throw new import_hc_http.NetworkError({
-            message: `${operation}: request aborted`,
-            code: "REQUEST_ABORTED",
-            details: err
-          });
-        }
-      }
       if (err instanceof Error) {
         throw new import_hc_http.APIError({
           message: `${operation}: ${err.message}`,
@@ -390,17 +514,14 @@ var HCLoginClient = class {
       });
     }
     if (!response.IsOK) {
-      throw this.mapBackendError(
-        operation,
-        response
-      );
+      throw this.mapBackendError(operation, response);
     }
     return response;
   }
   mapBackendError(operation, response) {
     return new import_hc_http.HCServiceError(
       operation,
-      response.ErrorMessage || "Unknown backend error",
+      response.ErrorMessage || "Unknown error",
       response
     );
   }
@@ -433,20 +554,6 @@ var HCLoginClient = class {
       [this.apiKeyHeaderName]: this.apiKeyValue
     };
   }
-  resolveContextPath(context) {
-    switch (context) {
-      case "PATIENT":
-        return "patient";
-      case "PROVIDER":
-        return "provider";
-      case "KB":
-        return "kb";
-      case "ADMIN_PLATFORM":
-        return "admin/platform";
-      default:
-        return "patient";
-    }
-  }
   ensureConfigured() {
     if (!this.config) {
       throw new import_hc_http.ConfigError(
@@ -475,6 +582,69 @@ var HCLoginClient = class {
     }
     return (_a = raw.ExpiresIn) != null ? _a : 0;
   }
+  buildOnboardingUser(step, user) {
+    var _a;
+    switch (step) {
+      case "EMAIL_VERIFY":
+      case "RESEND_EMAIL_VERIFY":
+        return {
+          Email: user.Email,
+          TenantID: this.config.tenantID,
+          ...user.Attributes ? { Attributes: user.Attributes } : {}
+        };
+      case "RESEND_SMS_VERIFY":
+      case "SMS_VERIFY":
+        return {
+          Email: user.Email,
+          TenantID: this.config.tenantID,
+          Phone: user.Phone
+        };
+      case "SAVE_HEALTH_PROFILE":
+        return {
+          Email: user.Email,
+          TenantID: this.config.tenantID,
+          FirstName: user.FirstName,
+          LastName: user.LastName,
+          BirthDate: user.BirthDate,
+          Gender: user.Gender,
+          Sex: user.Sex,
+          Status: (_a = user.Status) != null ? _a : 0,
+          Phone: user.Phone,
+          ...user.Race !== void 0 ? { Race: user.Race } : {},
+          ...user.Ethnicity !== void 0 ? { Ethnicity: user.Ethnicity } : {}
+        };
+      case "SAVE_ADDRESS":
+        return {
+          Email: user.Email,
+          TenantID: this.config.tenantID,
+          Address: user.Address ? {
+            StreetAndNumber: user.Address.StreetAndNumber,
+            Extension: user.Address.Extension,
+            City: user.Address.City,
+            State: user.Address.State,
+            PostalCode: user.Address.PostalCode,
+            Country: user.Address.Country
+          } : void 0
+        };
+    }
+  }
+  buildEmailVerificationInput(email, options) {
+    const attributes = this.buildEmailVerificationAttributes(options);
+    return {
+      Email: email,
+      ...attributes ? { Attributes: attributes } : {}
+    };
+  }
+  buildEmailVerificationAttributes(options) {
+    var _a;
+    const attributes = {
+      ...(_a = options.attributes) != null ? _a : {}
+    };
+    if (options.verifyEmailCode === true) {
+      attributes.VERIFY_EMAIL_CODE = "true";
+    }
+    return Object.keys(attributes).length > 0 ? attributes : void 0;
+  }
 };
 
 // src/errors.ts