@tryghost/referrer-parser 0.1.1 → 0.1.3

package/dist/index.d.ts

@@ -1,29 +1,127 @@
-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 };
+/**
+ * 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 { }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryghost/referrer-parser",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Simple library for parsing referrer URLs",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -8,9 +8,9 @@
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
+      "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
-      "require": "./dist/index.cjs",
-      "types": "./dist/index.d.ts"
+      "require": "./dist/index.cjs"
     }
   },
   "files": [
@@ -50,22 +50,21 @@
     "@types/node": "^22.0.0",
     "@types/should": "^13.0.0",
     "@types/sinon": "^17.0.3",
-    "@typescript-eslint/eslint-plugin": "^6.9.0",
-    "@typescript-eslint/parser": "^6.9.0",
-    "@vitest/coverage-v8": "^1.6.1",
+    "@typescript-eslint/eslint-plugin": "^8.0.0",
+    "@typescript-eslint/parser": "^8.0.0",
+    "@vitest/coverage-v8": "^3.0.0",
     "eslint": "^8.52.0",
     "should": "13.2.3",
     "sinon": "20.0.0",
     "typescript": "5.4.3",
     "vite": "^6.0.0",
-    "vite-plugin-dts": "^3.9.1",
-    "vitest": "^1.6.1"
+    "vite-plugin-dts": "^4.0.0",
+    "vitest": "^3.0.0"
   },
   "engines": {
     "node": ">=16.0.0"
   },
   "publishConfig": {
     "access": "public"
-  },
-  "gitHead": "42a1892311fd717a5fb87a07b96197455100d3b8"
+  }
 }

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2013-2025 Ghost Foundation
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/dist/lib/ReferrerParser.d.ts

@@ -1,97 +0,0 @@
-/**
- * Interface for parsed referrer data
- */
-export 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;
-}
-/**
- * Configuration options for the parser
- */
-export 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 referrer source data
- */
-interface ReferrerSourceData {
-    source: string;
-    medium: string;
-}
-/**
- * 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;
-}
-export {};