a11y-password-strength-meter 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,135 @@
+//#region src/lib/password-strength.d.ts
+declare const DEFAULT_REQUIREMENT_IDS: readonly ["length", "uppercase", "lowercase", "number", "symbol"];
+declare const PASSWORD_STRENGTH_LEVELS: Readonly<{
+  readonly notRated: "not-rated";
+  readonly tooWeak: "too-weak";
+  readonly weak: "weak";
+  readonly fair: "fair";
+  readonly strong: "strong";
+  readonly veryStrong: "very-strong";
+}>;
+type PasswordRequirementId = (typeof DEFAULT_REQUIREMENT_IDS)[number];
+type PasswordStrengthLevel = (typeof PASSWORD_STRENGTH_LEVELS)[keyof typeof PASSWORD_STRENGTH_LEVELS];
+interface PasswordRequirementInput {
+  id: PasswordRequirementId | string;
+  label?: string;
+  minLength?: number | string;
+}
+type PasswordRequirementConfig = string | PasswordRequirementInput;
+interface PasswordRequirement {
+  id: PasswordRequirementId;
+  label: string;
+  minLength?: number;
+  met: boolean;
+}
+interface PasswordStrengthOptions {
+  minLength?: number | string;
+  requirements?: PasswordRequirementConfig[];
+}
+interface PasswordStrengthResult {
+  score: number;
+  maxScore: number;
+  level: PasswordStrengthLevel;
+  requirements: PasswordRequirement[];
+}
+declare function getPasswordStrength(password: string, options?: PasswordStrengthOptions): PasswordStrengthResult;
+//#endregion
+//#region src/index.d.ts
+type StrengthLabelKey = "notRated" | "tooWeak" | "weak" | "fair" | "strong" | "veryStrong";
+type RequirementStatusKey = "met" | "needed";
+type TemplateKey = "strength" | "requirementsSummary" | "live" | "progressValue";
+type AriaMessageKey = "progressLabel" | "requirementsLabel";
+type ErrorMessageKey = "inputUnconfigured" | "inputMissing";
+interface PasswordStrengthMessages {
+  strengthLabels?: Partial<Record<StrengthLabelKey, string>>;
+  requirementStatus?: Partial<Record<RequirementStatusKey, string>>;
+  templates?: Partial<Record<TemplateKey, string>>;
+  aria?: Partial<Record<AriaMessageKey, string>>;
+  errors?: Partial<Record<ErrorMessageKey, string>>;
+  requirements?: Record<string, string>;
+}
+interface PasswordStrengthMeterOptions {
+  announce?: boolean | string;
+  feedbackId?: string;
+  inputId?: string;
+  messages?: PasswordStrengthMessages;
+  minLength?: number | string;
+}
+interface PasswordStrengthMeterInstance {
+  readonly element: HTMLElement;
+  readonly root: HTMLElement;
+  destroy(): void;
+  update(options?: PasswordStrengthMeterUpdateOptions): void;
+}
+interface PasswordStrengthMeterUpdateOptions {
+  announce?: boolean;
+  dispatchChange?: boolean;
+}
+interface PasswordStrengthMeterLifecycleDetail {
+  instance: A11yPasswordStrengthMeter;
+}
+interface PasswordStrengthMeterChangeDetail extends PasswordStrengthMeterLifecycleDetail {
+  label: string;
+  metCount: number;
+  result: PasswordStrengthResult;
+}
+declare const PASSWORD_STRENGTH_METER_EVENTS: Readonly<{
+  init: "a11y-password-strength-meter:init";
+  change: "a11y-password-strength-meter:change";
+  destroy: "a11y-password-strength-meter:destroy";
+}>;
+declare class A11yPasswordStrengthMeter implements PasswordStrengthMeterInstance {
+  private static readonly instances;
+  static getInstance(root: HTMLElement): A11yPasswordStrengthMeter | null;
+  readonly root: HTMLElement;
+  private input;
+  private meter;
+  private label;
+  private count;
+  private progress;
+  private requirementsList;
+  private liveRegion;
+  private options;
+  private lastAnnouncedLabel;
+  private customMessages;
+  private addedFeedbackDescriptionId;
+  private initialized;
+  private readonly boundHandleInput;
+  constructor(root: HTMLElement, options?: PasswordStrengthMeterOptions);
+  get element(): HTMLElement;
+  set messages(value: PasswordStrengthMessages);
+  get messages(): PasswordStrengthMessages;
+  configure(options?: PasswordStrengthMeterOptions): void;
+  update({
+    announce,
+    dispatchChange
+  }?: PasswordStrengthMeterUpdateOptions): void;
+  destroy(): void;
+  private initialize;
+  private teardown;
+  private get feedbackId();
+  private get inputId();
+  private get shouldAnnounce();
+  private get minLength();
+  private get resolvedMessages();
+  private render;
+  private connectInput;
+  private disconnectInput;
+  private ensureInputDescription;
+  private removeInputDescription;
+  private handleInput;
+  private renderRequirements;
+  private getAuthoredRequirements;
+  private announce;
+  private showUnavailableState;
+  private resetRequirements;
+  private refreshMessages;
+  private getUnavailableMessage;
+  private normalizeRequirementMarkup;
+  private dispatchLifecycleEvent;
+}
+declare function createPasswordStrengthMeter(root: HTMLElement, options?: PasswordStrengthMeterOptions): PasswordStrengthMeterInstance;
+declare function initPasswordStrengthMeters(options?: PasswordStrengthMeterOptions): PasswordStrengthMeterInstance[];
+//#endregion
+export { A11yPasswordStrengthMeter, PASSWORD_STRENGTH_LEVELS, PASSWORD_STRENGTH_METER_EVENTS, type PasswordRequirement, type PasswordRequirementConfig, type PasswordRequirementId, type PasswordRequirementInput, type PasswordStrengthLevel, PasswordStrengthMessages, PasswordStrengthMeterChangeDetail, PasswordStrengthMeterInstance, PasswordStrengthMeterLifecycleDetail, PasswordStrengthMeterOptions, PasswordStrengthMeterUpdateOptions, type PasswordStrengthOptions, type PasswordStrengthResult, createPasswordStrengthMeter, getPasswordStrength, initPasswordStrengthMeters };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/lib/password-strength.ts","../src/index.ts"],"mappings":";cAcM,uBAAA;AAAA,cAQO,wBAAA,EAAwB,QAAA;EAAA;;;;;;;KASzB,qBAAA,WAAgC,uBAAuB;AAAA,KAEvD,qBAAA,WACF,wBAAA,eAAuC,wBAAwB;AAAA,UAExD,wBAAA;EACf,EAAA,EAAI,qBAAqB;EACzB,KAAA;EACA,SAAA;AAAA;AAAA,KAGU,yBAAA,YAER,wBAAwB;AAAA,UAEX,mBAAA;EACf,EAAA,EAAI,qBAAqB;EACzB,KAAA;EACA,SAAA;EACA,GAAA;AAAA;AAAA,UAGe,uBAAA;EACf,SAAA;EACA,YAAA,GAAe,yBAAyB;AAAA;AAAA,UAGzB,sBAAA;EACf,KAAA;EACA,QAAA;EACA,KAAA,EAAO,qBAAA;EACP,YAAA,EAAc,mBAAmB;AAAA;AAAA,iBAgBnB,mBAAA,CACd,QAAA,UACA,OAAA,GAAS,uBAAA,GACR,sBAAsB;;;KCbpB,gBAAA;AAAA,KAQA,oBAAA;AAAA,KAEA,WAAA;AAAA,KAMA,cAAA;AAAA,KAEA,eAAA;AAAA,UAsBY,wBAAA;EACf,cAAA,GAAiB,OAAA,CAAQ,MAAA,CAAO,gBAAA;EAChC,iBAAA,GAAoB,OAAA,CAAQ,MAAA,CAAO,oBAAA;EACnC,SAAA,GAAY,OAAA,CAAQ,MAAA,CAAO,WAAA;EAC3B,IAAA,GAAO,OAAA,CAAQ,MAAA,CAAO,cAAA;EACtB,MAAA,GAAS,OAAA,CAAQ,MAAA,CAAO,eAAA;EACxB,YAAA,GAAe,MAAA;AAAA;AAAA,UAGA,4BAAA;EACf,QAAA;EACA,UAAA;EACA,OAAA;EACA,QAAA,GAAW,wBAAwB;EACnC,SAAA;AAAA;AAAA,UAGe,6BAAA;EAAA,SACN,OAAA,EAAS,WAAA;EAAA,SACT,IAAA,EAAM,WAAA;EACf,OAAA;EACA,MAAA,CAAO,OAAA,GAAU,kCAAA;AAAA;AAAA,UAGF,kCAAA;EACf,QAAA;EACA,cAAc;AAAA;AAAA,UAGC,oCAAA;EACf,QAAA,EAAU,yBAAyB;AAAA;AAAA,UAGpB,iCAAA,SACP,oCAAoC;EAC5C,KAAA;EACA,QAAA;EACA,MAAA,EAAQ,sBAAA;AAAA;AAAA,cAqCG,8BAAA,EAA8B,QAAA;;;;;cAQ9B,yBAAA,YACA,6BAAA;EAAA,wBAEa,SAAA;EAAA,OAKjB,WAAA,CAAY,IAAA,EAAM,WAAA,GAAc,yBAAA;EAAA,SAI9B,IAAA,EAAO,WAAA;EAAA,QACR,KAAA;EAAA,QACA,KAAA;EAAA,QACA,KAAA;EAAA,QACA,KAAA;EAAA,QACA,QAAA;EAAA,QACA,gBAAA;EAAA,QACA,UAAA;EAAA,QACA,OAAA;EAAA,QAGA,kBAAA;EAAA,QACA,cAAA;EAAA,QACA,0BAAA;EAAA,QACA,WAAA;EAAA,iBACS,gBAAA;cAEL,IAAA,EAAM,WAAA,EAAa,OAAA,GAAS,4BAAA;EAAA,IAqBpC,OAAA,IAAW,WAAA;EAAA,IAIX,QAAA,CAAS,KAAA,EAAO,wBAAA;EAAA,IAgBhB,QAAA,IAAY,wBAAA;EAIhB,SAAA,CAAU,OAAA,GAAS,4BAAA;EAiBnB,MAAA;IACE,QAAA;IACA;EAAA,IACC,kCAAA;EAyDH,OAAA;EAAA,QAIQ,UAAA;EAAA,QAaA,QAAA;EAAA,YAaI,UAAA;EAAA,YAIA,OAAA;EAAA,YAIA,cAAA;EAAA,YAIA,SAAA;EAAA,YAIA,gBAAA;EAAA,QAIJ,MAAA;EAAA,QAmEA,YAAA;EAAA,QAkBA,eAAA;EAAA,QAUA,sBAAA;EAAA,QAgBA,sBAAA;EAAA,QAoBA,WAAA;EAAA,QAIA,kBAAA;EAAA,QAgCA,uBAAA;EAAA,QAwBA,QAAA;EAAA,QAeA,oBAAA;EAAA,QA2BA,iBAAA;EAAA,QAcA,eAAA;EAAA,QAgBA,qBAAA;EAAA,QAQA,0BAAA;EAAA,QAoBA,sBAAA;AAAA;AAAA,iBAmBM,2BAAA,CACd,IAAA,EAAM,WAAA,EACN,OAAA,GAAS,4BAAA,GACR,6BAAA;AAAA,iBAUa,0BAAA,CACd,OAAA,GAAS,4BAAA,GACR,6BAA6B"}