@tryghost/referrer-parser 0.1.15 → 0.1.17

package/dist/index.d.ts

@@ -1,127 +1,28 @@
-/**
- * Parse a referrer URL to get source, medium and hostname
- *
- * @param referrerUrl - URL of the referrer to parse
- * @param options - Configuration options
- * @param referrerSource - Optional source to override URL parameters
- * @param referrerMedium - Optional medium to override URL parameters
- * @returns Parsed referrer data with source, medium and URL
- *
- * @example
- * // Basic usage
- * const result = parse('https://www.google.com/search?q=ghost+cms');
- * // result: { referrerSource: 'Google', referrerMedium: 'search', referrerUrl: 'www.google.com' }
- *
- * @example
- * // With site configuration
- * const result = parse('https://example.com/blog?utm_source=newsletter', {
- *   siteUrl: 'https://example.com'
- * });
- *
- * @example
- * // With explicit source and medium
- * const result = parse('https://example.com', {}, 'newsletter', 'email');
- */
-export declare function parse(referrerUrl: string, options?: ParserOptions, referrerSource?: string, referrerMedium?: string): ReferrerData;
-
-/**
- * Configuration options for the parser
- */
-export declare interface ParserOptions {
-    /** URL of the site for identifying internal traffic */
-    siteUrl?: string;
-    /** URL of the admin panel for identifying admin traffic */
-    adminUrl?: string;
-}
-
-/**
- * Interface for parsed referrer data
- */
-export declare interface ReferrerData {
-    /** The identified source of the referral traffic */
-    referrerSource: string | null;
-    /** The identified medium of the referral traffic */
-    referrerMedium: string | null;
-    /** The hostname of the referral URL */
-    referrerUrl: string | null;
-}
-
-/**
- * Parses referrer URLs to determine source and medium
- */
-export declare class ReferrerParser {
-    private adminUrl;
-    private siteUrl;
-    /**
-     * Creates a new referrer parser instance
-     *
-     * @param options - Configuration options
-     */
-    constructor(options?: ParserOptions);
-    /**
-     * Parse a referrer URL to get source, medium and hostname
-     *
-     * @param referrerUrlStr - URL of the referrer
-     * @param referrerSource - Source of the referrer
-     * @param referrerMedium - Medium of the referrer
-     * @returns Parsed referrer data with source, medium and URL. Internal referrers return null values.
-     */
-    parse(referrerUrlStr: string, referrerSource?: string, referrerMedium?: string): ReferrerData;
-    /**
-     * Fetches referrer data from known external URLs
-     *
-     * @param url - The URL to match against known referrers
-     * @returns Matched referrer data or null if not found
-     */
-    getDataFromUrl(url: URL | null): ReferrerSourceData | null;
-    /**
-     * Return URL object for provided URL string
-     *
-     * @param url - URL string to parse
-     * @returns Parsed URL object or null if invalid
-     */
-    getUrlFromStr(url: string): URL | null;
-    /**
-     * Determine whether the provided URL is a link to the site
-     *
-     * @param url - URL to check
-     * @returns True if the URL belongs to the configured site
-     */
-    isSiteDomain(url: URL | null): boolean;
-    /**
-     * Determine whether referrer is a Ghost newsletter
-     *
-     * @param deps - Input parameters
-     * @returns True if the referrer is a Ghost newsletter
-     */
-    isGhostNewsletter({ referrerSource }: {
-        referrerSource: string | null;
-    }): boolean;
-    /**
-     * Determine whether referrer is a Ghost.org URL
-     *
-     * @param referrerUrl - The referrer URL to check
-     * @returns True if the referrer is from Ghost.org
-     */
-    isGhostOrgUrl(referrerUrl: URL | null): boolean;
-    /**
-     * Determine whether referrer is Ghost Explore
-     *
-     * @param deps - Input parameters
-     * @returns True if the referrer is from Ghost Explore
-     */
-    isGhostExploreRef({ referrerUrl, referrerSource }: {
-        referrerUrl: URL | null;
-        referrerSource?: string | null;
-    }): boolean;
-}
-
-/**
- * Interface for referrer source data
- */
-declare interface ReferrerSourceData {
-    source: string;
-    medium: string;
-}
-
-export { }
+import { ReferrerParser, ReferrerData, ParserOptions } from './lib/ReferrerParser';
+/**
+ * Parse a referrer URL to get source, medium and hostname
+ *
+ * @param referrerUrl - URL of the referrer to parse
+ * @param options - Configuration options
+ * @param referrerSource - Optional source to override URL parameters
+ * @param referrerMedium - Optional medium to override URL parameters
+ * @returns Parsed referrer data with source, medium and URL
+ *
+ * @example
+ * // Basic usage
+ * const result = parse('https://www.google.com/search?q=ghost+cms');
+ * // result: { referrerSource: 'Google', referrerMedium: 'search', referrerUrl: 'www.google.com' }
+ *
+ * @example
+ * // With site configuration
+ * const result = parse('https://example.com/blog?utm_source=newsletter', {
+ *   siteUrl: 'https://example.com'
+ * });
+ *
+ * @example
+ * // With explicit source and medium
+ * const result = parse('https://example.com', {}, 'newsletter', 'email');
+ */
+declare function parse(referrerUrl: string, options?: ParserOptions, referrerSource?: string, referrerMedium?: string): ReferrerData;
+export { parse, ReferrerParser };
+export type { ReferrerData, ParserOptions };