@budiauktioner/buildi-primitives 0.1.0

package/dist/web/index.d.cts

@@ -0,0 +1,203 @@
+import { P as PrimitiveTypeInfo, T as TextCandidate } from '../text-candidate-qg2bD9PY.cjs';
+import { a as Country } from '../country-BhD51LDL.cjs';
+import { ValidationResult } from '../validation/index.cjs';
+
+/**
+ * Identifies the email service behind a domain when it belongs to a well-known
+ * public (consumer/free) email provider.
+ */
+declare const PublicEmailProvider: {
+    readonly Unknown: "Unknown";
+    readonly Gmail: "Gmail";
+    readonly Outlook: "Outlook";
+    readonly Yahoo: "Yahoo";
+    readonly ICloud: "ICloud";
+    readonly ProtonMail: "ProtonMail";
+    readonly Aol: "Aol";
+    readonly Gmx: "Gmx";
+    readonly MailCom: "MailCom";
+    readonly Yandex: "Yandex";
+    readonly Zoho: "Zoho";
+    readonly Tuta: "Tuta";
+    readonly Hey: "Hey";
+    readonly DuckDuckGoEmail: "DuckDuckGoEmail";
+    readonly SimpleLogin: "SimpleLogin";
+    readonly WebDe: "WebDe";
+    readonly MailRu: "MailRu";
+    readonly WirtualnaPolska: "WirtualnaPolska";
+    readonly Onet: "Onet";
+    readonly Interia: "Interia";
+    readonly Tlen: "Tlen";
+    readonly Seznam: "Seznam";
+    readonly Libero: "Libero";
+    readonly FreemailHu: "FreemailHu";
+    readonly Abv: "Abv";
+    readonly InboxLv: "InboxLv";
+    readonly UkrNet: "UkrNet";
+    readonly Naver: "Naver";
+    readonly Telia: "Telia";
+    readonly Tele2: "Tele2";
+    readonly Comhem: "Comhem";
+    readonly Bredbandsbolaget: "Bredbandsbolaget";
+    readonly Bredband2: "Bredband2";
+    readonly Ownit: "Ownit";
+    readonly Spray: "Spray";
+    readonly Passagen: "Passagen";
+    readonly Bahnhof: "Bahnhof";
+    readonly Glocalnet: "Glocalnet";
+    readonly OnlineNo: "OnlineNo";
+    readonly Kolumbus: "Kolumbus";
+    readonly Aland: "Aland";
+};
+type PublicEmailProvider = (typeof PublicEmailProvider)[keyof typeof PublicEmailProvider];
+/**
+ * An email address (e-postadress). Normalization trims whitespace and lowercases the entire
+ * address — including the local part — as a pragmatic interoperability and deduplication choice.
+ */
+declare class EmailAddress {
+    static readonly typeInfo: PrimitiveTypeInfo;
+    readonly value: string;
+    readonly localPart: string;
+    readonly domain: string;
+    readonly domainAscii: string;
+    readonly topLevelDomain: string;
+    readonly country: Country | null;
+    readonly provider: PublicEmailProvider | null;
+    readonly originalDomain: string | null;
+    get isPublicEmailProvider(): boolean;
+    get isInternationalizedDomain(): boolean;
+    get wasCorrected(): boolean;
+    private constructor();
+    /**
+     * Attempts to parse and normalize an email address.
+     *
+     * When `tryCorrectTypos` is `true`, common domain misspellings such as
+     * `gmail.con`, `gnail.com`, or `hotmil.com` are corrected automatically.
+     * The original domain is preserved in `originalDomain`. Typo correction is
+     * opt-in and should only be used when silent correction is acceptable.
+     */
+    static tryParse(input: string | null | undefined, options?: {
+        tryCorrectTypos?: boolean;
+    }): EmailAddress | null;
+    static parse(input: string, options?: {
+        tryCorrectTypos?: boolean;
+    }): EmailAddress;
+    static isValid(input: string | null | undefined): boolean;
+    /**
+     * Returns a `ValidationResult` describing why the input is invalid,
+     * or a valid result when the input is well-formed.
+     */
+    static validate(input: string | null | undefined): ValidationResult;
+    /**
+     * Returns the normalized email in lowercase, e.g. `user@example.com`.
+     * Returns `null` for invalid or empty input.
+     */
+    static format(input: string | null | undefined, options?: {
+        fallbackToTrimmedInputWhenInvalid?: boolean;
+        tryCorrectTypos?: boolean;
+    }): string | null;
+    /** Returns the normalized email, e.g. `user@example.com`, or `null` if invalid. */
+    static normalize(input: string | null | undefined, options?: {
+        fallbackToTrimmedInputWhenInvalid?: boolean;
+        tryCorrectTypos?: boolean;
+    }): string | null;
+    static isNormalized(input: string | null | undefined): boolean;
+    /** Returns the normalized email address, e.g. `user@example.com`. */
+    toNormalizedString(): string;
+    /** Returns the normalized email address, e.g. `user@example.com`. */
+    toString(): string;
+    /**
+     * Returns the email with the domain in ASCII (Punycode) form, e.g.
+     * `user@xn--rneholm-b1a.com`. Same as `toString()` for ASCII domains.
+     */
+    toAsciiString(): string;
+    /**
+     * Scans unstructured text for potential email addresses. Heuristic; may include false positives.
+     */
+    static findCandidatesInText(text: string): readonly TextCandidate<EmailAddress>[];
+    equals(other: EmailAddress | null | undefined): boolean;
+    compareTo(other: EmailAddress | null | undefined): number;
+}
+/**
+ * Returns a masked email showing the first character of the local part and the full domain,
+ * e.g. `peter@example.com` → `p***@example.com`.
+ * Set `maskDomain` to `true` to also mask the domain label: `p***@e***.com`.
+ */
+declare function maskEmailAddress(email: EmailAddress, options?: {
+    maskDomain?: boolean;
+}): string;
+/** Returns a `mailto:` URI, e.g. `mailto:info@example.com`. */
+declare function toMailtoUri(email: EmailAddress): string;
+
+/**
+ * A URL or URI (`webbadress`). Accepts any valid URI scheme — `http`, `https`,
+ * `mailto`, `tel`, `ssh`, custom schemes, etc. Bare domains like `example.com`
+ * are auto-prefixed with `https://`. Reserved example/test domains per
+ * RFC 2606 / RFC 6761 are flagged via `isExampleDomain`.
+ */
+declare class Url {
+    #private;
+    static readonly typeInfo: PrimitiveTypeInfo;
+    /** The normalized URL string, e.g. `https://www.example.com/path`. */
+    readonly value: string;
+    /** The URI scheme without `://`, e.g. `https`. */
+    readonly scheme: string;
+    /** The full hostname, e.g. `www.example.com`. Empty for non-hierarchical URIs. */
+    readonly host: string;
+    /** Explicit port, or `null` when the default port for the scheme is used. */
+    readonly port: number | null;
+    /** The path component, e.g. `/path/to/page`. Root paths are `/`. */
+    readonly path: string;
+    /** Query string without `?`, or `null` when absent. */
+    readonly query: string | null;
+    /** Fragment without `#`, or `null` when absent. */
+    readonly fragment: string | null;
+    /** Top-level domain without the dot, e.g. `com`, `se`. */
+    readonly topLevelDomain: string;
+    /** Country associated with a country-code TLD, or `null` for generic TLDs. */
+    readonly country: Country | null;
+    /** True when the scheme is `https`. */
+    readonly isSecure: boolean;
+    /** True when the host is a reserved example/test domain (RFC 2606 / RFC 6761). */
+    readonly isExampleDomain: boolean;
+    /** True when the host is an IP address. */
+    readonly isIpAddress: boolean;
+    private constructor();
+    static tryParse(input: string | null | undefined): Url | null;
+    static parse(input: string): Url;
+    /**
+     * The standard `URL` view of this value, for interop with `fetch` and other
+     * web APIs. The .NET port exposes the same thing as `ToUri()`.
+     */
+    toUrl(): URL;
+    /** Creates a {@link Url} from a standard `URL`. Throws when it cannot be represented. */
+    static fromUrl(url: URL): Url;
+    static isValid(input: string | null | undefined): boolean;
+    static format(input: string | null | undefined, options?: {
+        fallbackToTrimmedInputWhenInvalid?: boolean;
+    }): string | null;
+    static normalize(input: string | null | undefined, options?: {
+        fallbackToTrimmedInputWhenInvalid?: boolean;
+    }): string | null;
+    static isNormalized(input: string | null | undefined): boolean;
+    /** Returns the normalized URL, e.g. `https://www.example.com/path`. */
+    toNormalizedString(): string;
+    /** Returns the normalized URL, e.g. `https://www.example.com/path`. */
+    toString(): string;
+    /**
+     * Scans unstructured text for potential URLs. Heuristic — may include false positives.
+     */
+    static findCandidatesInText(text: string): readonly TextCandidate<Url>[];
+    equals(other: Url | null | undefined): boolean;
+    compareTo(other: Url | null | undefined): number;
+}
+/**
+ * Returns a masked URL showing the scheme and host but obscuring the path,
+ * query, and fragment, e.g.
+ * `https://www.example.com/my/secret/page?key=val` →
+ * `https://www.example.com/***?***`.
+ * For non-hierarchical URIs (mailto:, tel:), returns `scheme:***`.
+ */
+declare function maskUrl(url: Url): string;
+
+export { EmailAddress, PublicEmailProvider, Url, maskEmailAddress, maskUrl, toMailtoUri };

package/dist/web/index.d.ts

@@ -0,0 +1,203 @@
+import { P as PrimitiveTypeInfo, T as TextCandidate } from '../text-candidate-qg2bD9PY.js';
+import { a as Country } from '../country-p0n0EVQ9.js';
+import { ValidationResult } from '../validation/index.js';
+
+/**
+ * Identifies the email service behind a domain when it belongs to a well-known
+ * public (consumer/free) email provider.
+ */
+declare const PublicEmailProvider: {
+    readonly Unknown: "Unknown";
+    readonly Gmail: "Gmail";
+    readonly Outlook: "Outlook";
+    readonly Yahoo: "Yahoo";
+    readonly ICloud: "ICloud";
+    readonly ProtonMail: "ProtonMail";
+    readonly Aol: "Aol";
+    readonly Gmx: "Gmx";
+    readonly MailCom: "MailCom";
+    readonly Yandex: "Yandex";
+    readonly Zoho: "Zoho";
+    readonly Tuta: "Tuta";
+    readonly Hey: "Hey";
+    readonly DuckDuckGoEmail: "DuckDuckGoEmail";
+    readonly SimpleLogin: "SimpleLogin";
+    readonly WebDe: "WebDe";
+    readonly MailRu: "MailRu";
+    readonly WirtualnaPolska: "WirtualnaPolska";
+    readonly Onet: "Onet";
+    readonly Interia: "Interia";
+    readonly Tlen: "Tlen";
+    readonly Seznam: "Seznam";
+    readonly Libero: "Libero";
+    readonly FreemailHu: "FreemailHu";
+    readonly Abv: "Abv";
+    readonly InboxLv: "InboxLv";
+    readonly UkrNet: "UkrNet";
+    readonly Naver: "Naver";
+    readonly Telia: "Telia";
+    readonly Tele2: "Tele2";
+    readonly Comhem: "Comhem";
+    readonly Bredbandsbolaget: "Bredbandsbolaget";
+    readonly Bredband2: "Bredband2";
+    readonly Ownit: "Ownit";
+    readonly Spray: "Spray";
+    readonly Passagen: "Passagen";
+    readonly Bahnhof: "Bahnhof";
+    readonly Glocalnet: "Glocalnet";
+    readonly OnlineNo: "OnlineNo";
+    readonly Kolumbus: "Kolumbus";
+    readonly Aland: "Aland";
+};
+type PublicEmailProvider = (typeof PublicEmailProvider)[keyof typeof PublicEmailProvider];
+/**
+ * An email address (e-postadress). Normalization trims whitespace and lowercases the entire
+ * address — including the local part — as a pragmatic interoperability and deduplication choice.
+ */
+declare class EmailAddress {
+    static readonly typeInfo: PrimitiveTypeInfo;
+    readonly value: string;
+    readonly localPart: string;
+    readonly domain: string;
+    readonly domainAscii: string;
+    readonly topLevelDomain: string;
+    readonly country: Country | null;
+    readonly provider: PublicEmailProvider | null;
+    readonly originalDomain: string | null;
+    get isPublicEmailProvider(): boolean;
+    get isInternationalizedDomain(): boolean;
+    get wasCorrected(): boolean;
+    private constructor();
+    /**
+     * Attempts to parse and normalize an email address.
+     *
+     * When `tryCorrectTypos` is `true`, common domain misspellings such as
+     * `gmail.con`, `gnail.com`, or `hotmil.com` are corrected automatically.
+     * The original domain is preserved in `originalDomain`. Typo correction is
+     * opt-in and should only be used when silent correction is acceptable.
+     */
+    static tryParse(input: string | null | undefined, options?: {
+        tryCorrectTypos?: boolean;
+    }): EmailAddress | null;
+    static parse(input: string, options?: {
+        tryCorrectTypos?: boolean;
+    }): EmailAddress;
+    static isValid(input: string | null | undefined): boolean;
+    /**
+     * Returns a `ValidationResult` describing why the input is invalid,
+     * or a valid result when the input is well-formed.
+     */
+    static validate(input: string | null | undefined): ValidationResult;
+    /**
+     * Returns the normalized email in lowercase, e.g. `user@example.com`.
+     * Returns `null` for invalid or empty input.
+     */
+    static format(input: string | null | undefined, options?: {
+        fallbackToTrimmedInputWhenInvalid?: boolean;
+        tryCorrectTypos?: boolean;
+    }): string | null;
+    /** Returns the normalized email, e.g. `user@example.com`, or `null` if invalid. */
+    static normalize(input: string | null | undefined, options?: {
+        fallbackToTrimmedInputWhenInvalid?: boolean;
+        tryCorrectTypos?: boolean;
+    }): string | null;
+    static isNormalized(input: string | null | undefined): boolean;
+    /** Returns the normalized email address, e.g. `user@example.com`. */
+    toNormalizedString(): string;
+    /** Returns the normalized email address, e.g. `user@example.com`. */
+    toString(): string;
+    /**
+     * Returns the email with the domain in ASCII (Punycode) form, e.g.
+     * `user@xn--rneholm-b1a.com`. Same as `toString()` for ASCII domains.
+     */
+    toAsciiString(): string;
+    /**
+     * Scans unstructured text for potential email addresses. Heuristic; may include false positives.
+     */
+    static findCandidatesInText(text: string): readonly TextCandidate<EmailAddress>[];
+    equals(other: EmailAddress | null | undefined): boolean;
+    compareTo(other: EmailAddress | null | undefined): number;
+}
+/**
+ * Returns a masked email showing the first character of the local part and the full domain,
+ * e.g. `peter@example.com` → `p***@example.com`.
+ * Set `maskDomain` to `true` to also mask the domain label: `p***@e***.com`.
+ */
+declare function maskEmailAddress(email: EmailAddress, options?: {
+    maskDomain?: boolean;
+}): string;
+/** Returns a `mailto:` URI, e.g. `mailto:info@example.com`. */
+declare function toMailtoUri(email: EmailAddress): string;
+
+/**
+ * A URL or URI (`webbadress`). Accepts any valid URI scheme — `http`, `https`,
+ * `mailto`, `tel`, `ssh`, custom schemes, etc. Bare domains like `example.com`
+ * are auto-prefixed with `https://`. Reserved example/test domains per
+ * RFC 2606 / RFC 6761 are flagged via `isExampleDomain`.
+ */
+declare class Url {
+    #private;
+    static readonly typeInfo: PrimitiveTypeInfo;
+    /** The normalized URL string, e.g. `https://www.example.com/path`. */
+    readonly value: string;
+    /** The URI scheme without `://`, e.g. `https`. */
+    readonly scheme: string;
+    /** The full hostname, e.g. `www.example.com`. Empty for non-hierarchical URIs. */
+    readonly host: string;
+    /** Explicit port, or `null` when the default port for the scheme is used. */
+    readonly port: number | null;
+    /** The path component, e.g. `/path/to/page`. Root paths are `/`. */
+    readonly path: string;
+    /** Query string without `?`, or `null` when absent. */
+    readonly query: string | null;
+    /** Fragment without `#`, or `null` when absent. */
+    readonly fragment: string | null;
+    /** Top-level domain without the dot, e.g. `com`, `se`. */
+    readonly topLevelDomain: string;
+    /** Country associated with a country-code TLD, or `null` for generic TLDs. */
+    readonly country: Country | null;
+    /** True when the scheme is `https`. */
+    readonly isSecure: boolean;
+    /** True when the host is a reserved example/test domain (RFC 2606 / RFC 6761). */
+    readonly isExampleDomain: boolean;
+    /** True when the host is an IP address. */
+    readonly isIpAddress: boolean;
+    private constructor();
+    static tryParse(input: string | null | undefined): Url | null;
+    static parse(input: string): Url;
+    /**
+     * The standard `URL` view of this value, for interop with `fetch` and other
+     * web APIs. The .NET port exposes the same thing as `ToUri()`.
+     */
+    toUrl(): URL;
+    /** Creates a {@link Url} from a standard `URL`. Throws when it cannot be represented. */
+    static fromUrl(url: URL): Url;
+    static isValid(input: string | null | undefined): boolean;
+    static format(input: string | null | undefined, options?: {
+        fallbackToTrimmedInputWhenInvalid?: boolean;
+    }): string | null;
+    static normalize(input: string | null | undefined, options?: {
+        fallbackToTrimmedInputWhenInvalid?: boolean;
+    }): string | null;
+    static isNormalized(input: string | null | undefined): boolean;
+    /** Returns the normalized URL, e.g. `https://www.example.com/path`. */
+    toNormalizedString(): string;
+    /** Returns the normalized URL, e.g. `https://www.example.com/path`. */
+    toString(): string;
+    /**
+     * Scans unstructured text for potential URLs. Heuristic — may include false positives.
+     */
+    static findCandidatesInText(text: string): readonly TextCandidate<Url>[];
+    equals(other: Url | null | undefined): boolean;
+    compareTo(other: Url | null | undefined): number;
+}
+/**
+ * Returns a masked URL showing the scheme and host but obscuring the path,
+ * query, and fragment, e.g.
+ * `https://www.example.com/my/secret/page?key=val` →
+ * `https://www.example.com/***?***`.
+ * For non-hierarchical URIs (mailto:, tel:), returns `scheme:***`.
+ */
+declare function maskUrl(url: Url): string;
+
+export { EmailAddress, PublicEmailProvider, Url, maskEmailAddress, maskUrl, toMailtoUri };