@zyphr-dev/node-sdk 0.1.48 → 0.1.49

package/dist/index.js

@@ -8565,30 +8565,38 @@ function OrganizationResponseToJSONTyped(value, ignoreDiscriminator = false) {
   };
 }
 
-// src/src/models/PasswordRequirements.ts
-function instanceOfPasswordRequirements(value) {
+// src/src/models/PasswordPolicy.ts
+function instanceOfPasswordPolicy(value) {
+  if (!("minLength" in value) || value["minLength"] === void 0) return false;
+  if (!("maxLength" in value) || value["maxLength"] === void 0) return false;
+  if (!("requireUppercase" in value) || value["requireUppercase"] === void 0) return false;
+  if (!("requireLowercase" in value) || value["requireLowercase"] === void 0) return false;
+  if (!("requireNumbers" in value) || value["requireNumbers"] === void 0) return false;
+  if (!("requireSpecial" in value) || value["requireSpecial"] === void 0) return false;
+  if (!("disallowCommon" in value) || value["disallowCommon"] === void 0) return false;
   return true;
 }
-function PasswordRequirementsFromJSON(json) {
-  return PasswordRequirementsFromJSONTyped(json, false);
+function PasswordPolicyFromJSON(json) {
+  return PasswordPolicyFromJSONTyped(json, false);
 }
-function PasswordRequirementsFromJSONTyped(json, ignoreDiscriminator) {
+function PasswordPolicyFromJSONTyped(json, ignoreDiscriminator) {
   if (json == null) {
     return json;
   }
   return {
-    "minLength": json["min_length"] == null ? void 0 : json["min_length"],
-    "maxLength": json["max_length"] == null ? void 0 : json["max_length"],
-    "requireUppercase": json["require_uppercase"] == null ? void 0 : json["require_uppercase"],
-    "requireLowercase": json["require_lowercase"] == null ? void 0 : json["require_lowercase"],
-    "requireNumbers": json["require_numbers"] == null ? void 0 : json["require_numbers"],
-    "requireSpecial": json["require_special"] == null ? void 0 : json["require_special"]
+    "minLength": json["min_length"],
+    "maxLength": json["max_length"],
+    "requireUppercase": json["require_uppercase"],
+    "requireLowercase": json["require_lowercase"],
+    "requireNumbers": json["require_numbers"],
+    "requireSpecial": json["require_special"],
+    "disallowCommon": json["disallow_common"]
   };
 }
-function PasswordRequirementsToJSON(json) {
-  return PasswordRequirementsToJSONTyped(json, false);
+function PasswordPolicyToJSON(json) {
+  return PasswordPolicyToJSONTyped(json, false);
 }
-function PasswordRequirementsToJSONTyped(value, ignoreDiscriminator = false) {
+function PasswordPolicyToJSONTyped(value, ignoreDiscriminator = false) {
   if (value == null) {
     return value;
   }
@@ -8598,12 +8606,15 @@ function PasswordRequirementsToJSONTyped(value, ignoreDiscriminator = false) {
     "require_uppercase": value["requireUppercase"],
     "require_lowercase": value["requireLowercase"],
     "require_numbers": value["requireNumbers"],
-    "require_special": value["requireSpecial"]
+    "require_special": value["requireSpecial"],
+    "disallow_common": value["disallowCommon"]
   };
 }
 
 // src/src/models/PasswordRequirementsResponseData.ts
 function instanceOfPasswordRequirementsResponseData(value) {
+  if (!("policy" in value) || value["policy"] === void 0) return false;
+  if (!("requirements" in value) || value["requirements"] === void 0) return false;
   return true;
 }
 function PasswordRequirementsResponseDataFromJSON(json) {
@@ -8614,7 +8625,8 @@ function PasswordRequirementsResponseDataFromJSONTyped(json, ignoreDiscriminator
     return json;
   }
   return {
-    "requirements": json["requirements"] == null ? void 0 : PasswordRequirementsFromJSON(json["requirements"])
+    "policy": PasswordPolicyFromJSON(json["policy"]),
+    "requirements": json["requirements"]
   };
 }
 function PasswordRequirementsResponseDataToJSON(json) {
@@ -8625,7 +8637,8 @@ function PasswordRequirementsResponseDataToJSONTyped(value, ignoreDiscriminator
     return value;
   }
   return {
-    "requirements": PasswordRequirementsToJSON(value["requirements"])
+    "policy": PasswordPolicyToJSON(value["policy"]),
+    "requirements": value["requirements"]
   };
 }
 
@@ -8658,6 +8671,108 @@ function PasswordRequirementsResponseToJSONTyped(value, ignoreDiscriminator = fa
   };
 }
 
+// src/src/models/PasswordStrength.ts
+var PasswordStrengthLabelEnum = {
+  WEAK: "weak",
+  FAIR: "fair",
+  GOOD: "good",
+  STRONG: "strong"
+};
+function instanceOfPasswordStrength(value) {
+  if (!("valid" in value) || value["valid"] === void 0) return false;
+  if (!("score" in value) || value["score"] === void 0) return false;
+  if (!("label" in value) || value["label"] === void 0) return false;
+  if (!("feedback" in value) || value["feedback"] === void 0) return false;
+  return true;
+}
+function PasswordStrengthFromJSON(json) {
+  return PasswordStrengthFromJSONTyped(json, false);
+}
+function PasswordStrengthFromJSONTyped(json, ignoreDiscriminator) {
+  if (json == null) {
+    return json;
+  }
+  return {
+    "valid": json["valid"],
+    "score": json["score"],
+    "label": json["label"],
+    "feedback": json["feedback"]
+  };
+}
+function PasswordStrengthToJSON(json) {
+  return PasswordStrengthToJSONTyped(json, false);
+}
+function PasswordStrengthToJSONTyped(value, ignoreDiscriminator = false) {
+  if (value == null) {
+    return value;
+  }
+  return {
+    "valid": value["valid"],
+    "score": value["score"],
+    "label": value["label"],
+    "feedback": value["feedback"]
+  };
+}
+
+// src/src/models/PasswordStrengthRequest.ts
+function instanceOfPasswordStrengthRequest(value) {
+  if (!("password" in value) || value["password"] === void 0) return false;
+  return true;
+}
+function PasswordStrengthRequestFromJSON(json) {
+  return PasswordStrengthRequestFromJSONTyped(json, false);
+}
+function PasswordStrengthRequestFromJSONTyped(json, ignoreDiscriminator) {
+  if (json == null) {
+    return json;
+  }
+  return {
+    "password": json["password"],
+    "email": json["email"] == null ? void 0 : json["email"]
+  };
+}
+function PasswordStrengthRequestToJSON(json) {
+  return PasswordStrengthRequestToJSONTyped(json, false);
+}
+function PasswordStrengthRequestToJSONTyped(value, ignoreDiscriminator = false) {
+  if (value == null) {
+    return value;
+  }
+  return {
+    "password": value["password"],
+    "email": value["email"]
+  };
+}
+
+// src/src/models/PasswordStrengthResponse.ts
+function instanceOfPasswordStrengthResponse(value) {
+  return true;
+}
+function PasswordStrengthResponseFromJSON(json) {
+  return PasswordStrengthResponseFromJSONTyped(json, false);
+}
+function PasswordStrengthResponseFromJSONTyped(json, ignoreDiscriminator) {
+  if (json == null) {
+    return json;
+  }
+  return {
+    "data": json["data"] == null ? void 0 : PasswordStrengthFromJSON(json["data"]),
+    "meta": json["meta"] == null ? void 0 : RequestMetaFromJSON(json["meta"])
+  };
+}
+function PasswordStrengthResponseToJSON(json) {
+  return PasswordStrengthResponseToJSONTyped(json, false);
+}
+function PasswordStrengthResponseToJSONTyped(value, ignoreDiscriminator = false) {
+  if (value == null) {
+    return value;
+  }
+  return {
+    "data": PasswordStrengthToJSON(value["data"]),
+    "meta": RequestMetaToJSON(value["meta"])
+  };
+}
+
 // src/src/models/PayloadTooLargeErrorErrorDetails.ts
 function instanceOfPayloadTooLargeErrorErrorDetails(value) {
   return true;
@@ -23690,7 +23805,41 @@ var TopicsApi = class extends BaseAPI {
 // src/src/apis/UtilityApi.ts
 var UtilityApi = class extends BaseAPI {
   /**
-   * Get password requirements for the application. Useful for client-side validation before registration.
+   * Pre-submit password check for a live registration/reset experience. Returns whether the password would be accepted by the server (`valid`), a strength `score` (0-100) and `label`, and actionable `feedback`. When an `email` is supplied, a password that resembles the email\'s local-part is flagged and marked invalid. The password is never logged or persisted.
+   * Check password strength
+   */
+  async checkPasswordStrengthRaw(requestParameters, initOverrides) {
+    if (requestParameters["passwordStrengthRequest"] == null) {
+      throw new RequiredError(
+        "passwordStrengthRequest",
+        'Required parameter "passwordStrengthRequest" was null or undefined when calling checkPasswordStrength().'
+      );
+    }
+    const queryParameters = {};
+    const headerParameters = {};
+    headerParameters["Content-Type"] = "application/json";
+    if (this.configuration && this.configuration.apiKey) {
+      headerParameters["X-Application-Key"] = await this.configuration.apiKey("X-Application-Key");
+    }
+    const response = await this.request({
+      path: `/auth/password-strength`,
+      method: "POST",
+      headers: headerParameters,
+      query: queryParameters,
+      body: PasswordStrengthRequestToJSON(requestParameters["passwordStrengthRequest"])
+    }, initOverrides);
+    return new JSONApiResponse(response, (jsonValue) => PasswordStrengthResponseFromJSON(jsonValue));
+  }
+  /**
+   * Pre-submit password check for a live registration/reset experience. Returns whether the password would be accepted by the server (`valid`), a strength `score` (0-100) and `label`, and actionable `feedback`. When an `email` is supplied, a password that resembles the email\'s local-part is flagged and marked invalid. The password is never logged or persisted.
+   * Check password strength
+   */
+  async checkPasswordStrength(passwordStrengthRequest, initOverrides) {
+    const response = await this.checkPasswordStrengthRaw({ passwordStrengthRequest }, initOverrides);
+    return await response.value();
+  }
+  /**
+   * Get password requirements for the application. Returns both a structured `policy` object (for driving a live requirements checklist) and human-readable `requirements` display strings. Useful for client-side validation before registration.
    * Get password requirements
    */
   async getPasswordRequirementsRaw(initOverrides) {
@@ -23708,7 +23857,7 @@ var UtilityApi = class extends BaseAPI {
     return new JSONApiResponse(response, (jsonValue) => PasswordRequirementsResponseFromJSON(jsonValue));
   }
   /**
-   * Get password requirements for the application. Useful for client-side validation before registration.
+   * Get password requirements for the application. Returns both a structured `policy` object (for driving a live requirements checklist) and human-readable `requirements` display strings. Useful for client-side validation before registration.
    * Get password requirements
    */
   async getPasswordRequirements(initOverrides) {
@@ -26206,6 +26355,8 @@ var Zyphr = class {
   webhooks;
   topics;
   devices;
+  /** Publishable-key-safe utilities: password policy + pre-submit strength check. */
+  utility;
   domains;
   /** Inbound (received) email — read access. Requires the `email:read` scope. */
   inbound;
@@ -26233,6 +26384,7 @@ var Zyphr = class {
     this.webhooks = new WebhooksApi(config);
     this.topics = new TopicsApi(config);
     this.devices = new DevicesApi(config);
+    this.utility = new UtilityApi(config);
     this.domains = new DomainsApi(config);
     this.inbound = new InboundEmailApi(config);
     this.waas = {
@@ -26319,6 +26471,12 @@ var ZyphrClient = class {
   auth;
   /** Device registration for push (takes an OS-acquired token). */
   devices;
+  /**
+   * Utility endpoints that are publishable-key-safe: the application's password
+   * policy (`getPasswordRequirements`) and a pre-submit password strength check
+   * (`checkPasswordStrength`). Useful for building a live registration UX.
+   */
+  utility;
   applicationKey;
   accessToken;
   constructor(options) {
@@ -26369,6 +26527,7 @@ var ZyphrClient = class {
       webauthn: new AuthWebAuthnApi(config)
     };
     this.devices = new DevicesApi(config);
+    this.utility = new UtilityApi(config);
   }
   /** Store the end-user access token; it is applied automatically to subsequent user-scoped calls. */
   setAccessToken(accessToken) {
@@ -27403,8 +27562,10 @@ export {
   PaginationMetaFromJSONTyped,
   PaginationMetaToJSON,
   PaginationMetaToJSONTyped,
-  PasswordRequirementsFromJSON,
-  PasswordRequirementsFromJSONTyped,
+  PasswordPolicyFromJSON,
+  PasswordPolicyFromJSONTyped,
+  PasswordPolicyToJSON,
+  PasswordPolicyToJSONTyped,
   PasswordRequirementsResponseDataFromJSON,
   PasswordRequirementsResponseDataFromJSONTyped,
   PasswordRequirementsResponseDataToJSON,
@@ -27413,8 +27574,19 @@ export {
   PasswordRequirementsResponseFromJSONTyped,
   PasswordRequirementsResponseToJSON,
   PasswordRequirementsResponseToJSONTyped,
-  PasswordRequirementsToJSON,
-  PasswordRequirementsToJSONTyped,
+  PasswordStrengthFromJSON,
+  PasswordStrengthFromJSONTyped,
+  PasswordStrengthLabelEnum,
+  PasswordStrengthRequestFromJSON,
+  PasswordStrengthRequestFromJSONTyped,
+  PasswordStrengthRequestToJSON,
+  PasswordStrengthRequestToJSONTyped,
+  PasswordStrengthResponseFromJSON,
+  PasswordStrengthResponseFromJSONTyped,
+  PasswordStrengthResponseToJSON,
+  PasswordStrengthResponseToJSONTyped,
+  PasswordStrengthToJSON,
+  PasswordStrengthToJSONTyped,
   PayloadTooLargeErrorErrorCodeEnum,
   PayloadTooLargeErrorErrorDetailsFromJSON,
   PayloadTooLargeErrorErrorDetailsFromJSONTyped,
@@ -28779,9 +28951,12 @@ export {
   instanceOfOrganizationMembershipWithUser,
   instanceOfOrganizationResponse,
   instanceOfPaginationMeta,
-  instanceOfPasswordRequirements,
+  instanceOfPasswordPolicy,
   instanceOfPasswordRequirementsResponse,
   instanceOfPasswordRequirementsResponseData,
+  instanceOfPasswordStrength,
+  instanceOfPasswordStrengthRequest,
+  instanceOfPasswordStrengthResponse,
   instanceOfPayloadTooLargeError,
   instanceOfPayloadTooLargeErrorError,
   instanceOfPayloadTooLargeErrorErrorDetails,