@enigmax/primitives 0.23.0 → 0.24.0

package/dist/password-C8lG4Zm9.d.ts

@@ -1,71 +0,0 @@
-/**
- * Making a password, and judging one.
- *
- * Both are opt-in. A sign-in form wants neither: offering to generate a password where one
- * already exists is noise, and scoring one the visitor cannot change is worse. They belong
- * on a registration form and a change-password form, which is where an agent should switch
- * them on.
- */
-/** Character classes a generated password can draw from. */
-interface PasswordAlphabet {
-    lowercase?: boolean;
-    uppercase?: boolean;
-    digits?: boolean;
-    symbols?: boolean;
-}
-interface GeneratePasswordOptions extends PasswordAlphabet {
-    /** Default 20. Long beats clever: length is the only term that scales. */
-    length?: number;
-    /**
-     * Drop the characters that are read wrong off a screen or off paper - I l 1 O 0.
-     * Worth it when the password will be typed by hand, not worth the entropy otherwise.
-     */
-    excludeAmbiguous?: boolean;
-    /** Characters to remove from every class, e.g. ones your backend rejects. */
-    exclude?: string;
-    /**
-     * Guarantee at least one character from every class asked for. Most password policies
-     * demand it; it costs a little entropy, because it removes every password that happens
-     * to lack one.
-     */
-    requireEachClass?: boolean;
-}
-/**
- * A random password from the classes asked for.
- *
- * @throws when the runtime has no CSPRNG, or when the options ask for something impossible
- *         (every class excluded, or a length too short to hold one of each).
- */
-declare function generatePassword(options?: GeneratePasswordOptions): string;
-type PasswordScore = 0 | 1 | 2 | 3 | 4;
-interface PasswordStrengthReport {
-    /** 0 worst, 4 best. What the bars under the field render. */
-    score: PasswordScore;
-    /** Estimated bits of entropy after the penalties below. */
-    bits: number;
-    /**
-     * Why it scored what it scored, worst first. Show the first one; showing all of them
-     * turns a hint into a lecture.
-     */
-    warnings: string[];
-    /** Empty field. Render nothing rather than a zero score, which reads as a failure. */
-    empty: boolean;
-}
-interface EstimateOptions {
-    /**
-     * Values the visitor has already typed elsewhere - email, name, company. A password
-     * containing one of them is guessable by anyone who has the sign-up form in front of
-     * them, and no character-class rule catches it.
-     */
-    userInputs?: string[];
-}
-/**
- * Score a password.
- *
- * The bits are an estimate and the bands are a convention, not a measurement - they exist
- * to move a bar, not to certify anything. Swap this out for zxcvbn where the number has to
- * mean something, and check the breach corpus for the cases no estimator can see.
- */
-declare function estimatePasswordStrength(password: string, options?: EstimateOptions): PasswordStrengthReport;
-
-export { type EstimateOptions as E, type GeneratePasswordOptions as G, type PasswordAlphabet as P, type PasswordScore as a, type PasswordStrengthReport as b, estimatePasswordStrength as e, generatePassword as g };