@getpimms/analytics 0.0.27

package/dist/react/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/react.tsx","../../package.json","../../src/utils.tsx","../../src/generic.ts"],"sourcesContent":["import { useEffect } from 'react';\nimport { inject } from './generic';\nimport type { AnalyticsProps } from './types';\n\n/**\n * Injects the PIMMS Web Analytics script into the page head.\n * @param props - Analytics options.\n * ```js\n * import { Analytics as PimmsAnalytics } from '@getpimms/analytics/react';\n *\n * export default function App() {\n *  return (\n *    <div>\n *      <PimmsAnalytics />\n *      <h1>My App</h1>\n *    </div>\n *  );\n * }\n * ```\n */\nfunction Analytics(props: AnalyticsProps): null {\n  useEffect(() => {\n    inject(props);\n  }, [props]);\n\n  return null;\n}\n\nexport { Analytics };\nexport type { AnalyticsProps };\n","{\n  \"name\": \"@getpimms/analytics\",\n  \"version\": \"0.0.27\",\n  \"description\": \"\",\n  \"keywords\": [\n    \"analytics\",\n    \"pimms\"\n  ],\n  \"repository\": {\n    \"url\": \"github:getpimms/analytics\",\n    \"directory\": \"packages/web\"\n  },\n  \"license\": \"MPL-2.0\",\n  \"type\": \"module\",\n  \"exports\": {\n    \"./package.json\": \"./package.json\",\n    \".\": {\n      \"browser\": \"./dist/index.js\",\n      \"import\": \"./dist/index.js\",\n      \"require\": \"./dist/index.cjs\"\n    },\n    \"./react\": {\n      \"browser\": \"./dist/react/index.js\",\n      \"import\": \"./dist/react/index.js\",\n      \"require\": \"./dist/react/index.cjs\"\n    }\n  },\n  \"main\": \"dist/index.js\",\n  \"types\": \"dist/index.d.ts\",\n  \"typesVersions\": {\n    \"*\": {\n      \"*\": [\n        \"dist/index.d.ts\"\n      ],\n      \"react\": [\n        \"dist/react/index.d.ts\"\n      ]\n    }\n  },\n  \"scripts\": {\n    \"build\": \"tsup\",\n    \"dev\": \"tsup --watch\",\n    \"lint\": \"eslint .\",\n    \"lint-fix\": \"eslint . --fix\",\n    \"type-check\": \"tsc --noEmit\"\n  },\n  \"eslintConfig\": {\n    \"extends\": [\n      \"@dub/eslint-config\"\n    ],\n    \"rules\": {\n      \"tsdoc/syntax\": \"off\"\n    }\n  },\n  \"dependencies\": {\n    \"server-only\": \"^0.0.1\"\n  },\n  \"devDependencies\": {\n    \"@dub/eslint-config\": \"workspace:0.0.0\",\n    \"@swc/core\": \"^1.3.66\",\n    \"@types/node\": \"^20.3.1\",\n    \"@types/react\": \"^18.2.14\",\n    \"react\": \"^18.2.0\",\n    \"react-dom\": \"^18.2.0\",\n    \"tsup\": \"7.1.0\"\n  },\n  \"publishConfig\": {\n    \"access\": \"public\"\n  }\n}","export function isBrowser() {\n  return typeof window !== 'undefined';\n}\n","import { name, version } from '../package.json';\nimport type { AnalyticsProps } from './types';\nimport { isBrowser } from './utils';\n\n/**\n * Injects the PIMMS Web Analytics script into the page head.\n */\nfunction inject(props: AnalyticsProps): void {\n  if (!isBrowser()) return;\n\n  // Determine script source based on enabled features\n  const baseUrl = 'https://cdn.pimms.io/analytics/script';\n  const features = [];\n\n  if (props.domainsConfig?.site) features.push('site-visit');\n  if (props.domainsConfig?.outbound) features.push('outbound-domains');\n\n  const src =\n    props.scriptProps?.src ||\n    (features.length > 0\n      ? `${baseUrl}.${features.join('.')}.js`\n      : `${baseUrl}.js`);\n\n  if (document.head.querySelector(`script[src*=\"${src}\"]`)) return;\n\n  const script = document.createElement('script');\n  script.src = src;\n  script.defer = props.scriptProps?.defer ?? true;\n  script.setAttribute('data-sdkn', name);\n  script.setAttribute('data-sdkv', version);\n\n  if (props.apiHost) {\n    script.setAttribute('data-api-host', props.apiHost);\n  }\n\n  if (props.domainsConfig) {\n    script.setAttribute('data-domains', JSON.stringify(props.domainsConfig));\n  }\n\n  if (props.shortDomain) {\n    script.setAttribute('data-short-domain', props.shortDomain);\n  }\n\n  if (props.attributionModel) {\n    script.setAttribute('data-attribution-model', props.attributionModel);\n  }\n\n  if (props.cookieOptions && Object.keys(props.cookieOptions).length > 0) {\n    script.setAttribute(\n      'data-cookie-options',\n      JSON.stringify(props.cookieOptions),\n    );\n  }\n\n  if (props.queryParam) {\n    script.setAttribute('data-query-param', props.queryParam);\n  }\n\n  if (props.scriptProps) {\n    const { src: _, ...restProps } = props.scriptProps; // we already set the src above\n    Object.assign(script, restProps);\n  }\n\n  script.onerror = (): void => {\n    // eslint-disable-next-line no-console -- Logging to console is intentional\n    console.log(`[PIMMS Web Analytics] failed to load script from ${src}.`);\n  };\n\n  document.head.appendChild(script);\n}\n\nexport { inject };\nexport type { AnalyticsProps };\n\n// eslint-disable-next-line import/no-default-export -- Default export is intentional\nexport default {\n  inject,\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,mBAA0B;;;ACCxB,WAAQ;AACR,cAAW;;;ACFN,SAAS,YAAY;AAC1B,SAAO,OAAO,WAAW;AAC3B;;;ACKA,SAAS,OAAO,OAA6B;AAP7C;AAQE,MAAI,CAAC,UAAU;AAAG;AAGlB,QAAM,UAAU;AAChB,QAAM,WAAW,CAAC;AAElB,OAAI,WAAM,kBAAN,mBAAqB;AAAM,aAAS,KAAK,YAAY;AACzD,OAAI,WAAM,kBAAN,mBAAqB;AAAU,aAAS,KAAK,kBAAkB;AAEnE,QAAM,QACJ,WAAM,gBAAN,mBAAmB,SAClB,SAAS,SAAS,IACf,GAAG,OAAO,IAAI,SAAS,KAAK,GAAG,CAAC,QAChC,GAAG,OAAO;AAEhB,MAAI,SAAS,KAAK,cAAc,gBAAgB,GAAG,IAAI;AAAG;AAE1D,QAAM,SAAS,SAAS,cAAc,QAAQ;AAC9C,SAAO,MAAM;AACb,SAAO,UAAQ,WAAM,gBAAN,mBAAmB,UAAS;AAC3C,SAAO,aAAa,aAAa,IAAI;AACrC,SAAO,aAAa,aAAa,OAAO;AAExC,MAAI,MAAM,SAAS;AACjB,WAAO,aAAa,iBAAiB,MAAM,OAAO;AAAA,EACpD;AAEA,MAAI,MAAM,eAAe;AACvB,WAAO,aAAa,gBAAgB,KAAK,UAAU,MAAM,aAAa,CAAC;AAAA,EACzE;AAEA,MAAI,MAAM,aAAa;AACrB,WAAO,aAAa,qBAAqB,MAAM,WAAW;AAAA,EAC5D;AAEA,MAAI,MAAM,kBAAkB;AAC1B,WAAO,aAAa,0BAA0B,MAAM,gBAAgB;AAAA,EACtE;AAEA,MAAI,MAAM,iBAAiB,OAAO,KAAK,MAAM,aAAa,EAAE,SAAS,GAAG;AACtE,WAAO;AAAA,MACL;AAAA,MACA,KAAK,UAAU,MAAM,aAAa;AAAA,IACpC;AAAA,EACF;AAEA,MAAI,MAAM,YAAY;AACpB,WAAO,aAAa,oBAAoB,MAAM,UAAU;AAAA,EAC1D;AAEA,MAAI,MAAM,aAAa;AACrB,UAAM,EAAE,KAAK,GAAG,GAAG,UAAU,IAAI,MAAM;AACvC,WAAO,OAAO,QAAQ,SAAS;AAAA,EACjC;AAEA,SAAO,UAAU,MAAY;AAE3B,YAAQ,IAAI,oDAAoD,GAAG,GAAG;AAAA,EACxE;AAEA,WAAS,KAAK,YAAY,MAAM;AAClC;;;AHjDA,SAAS,UAAU,OAA6B;AAC9C,8BAAU,MAAM;AACd,WAAO,KAAK;AAAA,EACd,GAAG,CAAC,KAAK,CAAC;AAEV,SAAO;AACT;","names":[]}

package/dist/react/index.d.cts

@@ -0,0 +1,155 @@
+interface AnalyticsProps {
+    /**
+     * The API endpoint to send analytics data to.
+     * @default 'https://api.pimms.io'
+     */
+    apiHost?: string;
+    /**
+     * This is a JSON object that configures the domains that PIMMS will track.
+     *
+     * - `refer`: The PIMMS short domain for referral program client-side click tracking (previously `shortDomain`). @see: https://d.to/clicks/refer
+     * - `site`: The PIMMS short domain for tracking site visits. @see: https://d.to/clicks/site
+     * - `outbound`: An array of domains for cross-domain tracking. When configured, the existing `pimms_id` cookie
+     *               will be automatically appended to all outbound links targeting these domains to enable
+     *               cross-domain tracking across different applications.
+     *
+     * @example {
+     *   refer: "refer.pimms.io",
+     *   site: "site.pimms.io",
+     *   outbound: "pim.ms"
+     * }
+     */
+    domainsConfig?: {
+        refer?: string;
+        site?: string;
+        outbound?: string | string[];
+    };
+    /**
+     * The custom domain you're using on PIMMS for your short links (for client-side click tracking).
+     * @example 'go.example.com'
+     * @deprecated Use domainsConfig.refer instead
+     */
+    shortDomain?: string;
+    /**
+     * The Attribution Model to use for the analytics event.
+     *
+     * @default 'last-click'
+     *
+     * - `first-click` - The first click model gives all the credit to the first touchpoint in the customer journey.
+     * - `last-click` - The last click model gives all the credit to the last touchpoint in the customer journey.
+     */
+    attributionModel?: 'first-click' | 'last-click';
+    /**
+     * The cookie options to use for the analytics event.
+     */
+    cookieOptions?: {
+        /**
+         * Specifies the value for the {@link https://tools.ietf.org/html/rfc6265#section-5.2.3|Domain Set-Cookie attribute}. By default, no
+         * domain is set, and most clients will consider the cookie to apply to only the current domain.
+         * By default, the domain is set to the current hostname (including all subdomains).
+         *
+         * @default `.` + window.location.hostname
+         */
+        domain?: string | undefined;
+        /**
+         * Specifies the `Date` object to be the value for the {@link https://tools.ietf.org/html/rfc6265#section-5.2.1|`Expires` `Set-Cookie` attribute}. By default,
+         * no expiration is set, and most clients will consider this a "non-persistent cookie" and will delete
+         * it on a condition like exiting a web browser application.
+         *
+         * *Note* the {@link https://tools.ietf.org/html/rfc6265#section-5.3|cookie storage model specification}
+         * states that if both `expires` and `maxAge` are set, then `maxAge` takes precedence, but it is
+         * possible not all clients by obey this, so if both are set, they should
+         * point to the same date and time.
+         */
+        expires?: Date | undefined;
+        /**
+         * Specifies the number of days until the cookie expires.
+         *
+         * @default 90
+         */
+        expiresInDays?: number | undefined;
+        /**
+         * Specifies the boolean value for the {@link https://tools.ietf.org/html/rfc6265#section-5.2.6|`HttpOnly` `Set-Cookie` attribute}.
+         * When truthy, the `HttpOnly` attribute is set, otherwise it is not. By
+         * default, the `HttpOnly` attribute is not set.
+         *
+         * *Note* be careful when setting this to true, as compliant clients will
+         * not allow client-side JavaScript to see the cookie in `document.cookie`.
+         */
+        httpOnly?: boolean | undefined;
+        /**
+         * Specifies the number (in seconds) to be the value for the `Max-Age`
+         * `Set-Cookie` attribute. The given number will be converted to an integer
+         * by rounding down. By default, no maximum age is set.
+         *
+         * *Note* the {@link https://tools.ietf.org/html/rfc6265#section-5.3|cookie storage model specification}
+         * states that if both `expires` and `maxAge` are set, then `maxAge` takes precedence, but it is
+         * possible not all clients by obey this, so if both are set, they should
+         * point to the same date and time.
+         */
+        maxAge?: number | undefined;
+        /**
+         * Specifies the value for the {@link https://tools.ietf.org/html/rfc6265#section-5.2.4|`Path` `Set-Cookie` attribute}.
+         * By default, the path is considered the "default path".
+         */
+        path?: string | undefined;
+        /**
+         * Specifies the boolean or string to be the value for the {@link https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-03#section-4.1.2.7|`SameSite` `Set-Cookie` attribute}.
+         *
+         * - `true` will set the `SameSite` attribute to `Strict` for strict same
+         * site enforcement.
+         * - `false` will not set the `SameSite` attribute.
+         * - `'lax'` will set the `SameSite` attribute to Lax for lax same site
+         * enforcement.
+         * - `'strict'` will set the `SameSite` attribute to Strict for strict same
+         * site enforcement.
+         *  - `'none'` will set the SameSite attribute to None for an explicit
+         *  cross-site cookie.
+         *
+         * More information about the different enforcement levels can be found in {@link https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-03#section-4.1.2.7|the specification}.
+         *
+         * *note* This is an attribute that has not yet been fully standardized, and may change in the future. This also means many clients may ignore this attribute until they understand it.
+         */
+        sameSite?: true | false | 'lax' | 'strict' | 'none' | undefined;
+        /**
+         * Specifies the boolean value for the {@link https://tools.ietf.org/html/rfc6265#section-5.2.5|`Secure` `Set-Cookie` attribute}. When truthy, the
+         * `Secure` attribute is set, otherwise it is not. By default, the `Secure` attribute is not set.
+         *
+         * *Note* be careful when setting this to `true`, as compliant clients will
+         * not send the cookie back to the server in the future if the browser does
+         * not have an HTTPS connection.
+         */
+        secure?: boolean | undefined;
+    };
+    /**
+     * The query parameter to listen to for client-side click-tracking (e.g. `?via=john`, `?ref=jane`).
+     *
+     * @default 'via'
+     */
+    queryParam?: string;
+    /**
+     * Custom properties to pass to the script.
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLScriptElement
+     */
+    scriptProps?: React.DetailedHTMLProps<React.ScriptHTMLAttributes<HTMLScriptElement>, HTMLScriptElement>;
+}
+
+/**
+ * Injects the PIMMS Web Analytics script into the page head.
+ * @param props - Analytics options.
+ * ```js
+ * import { Analytics as PimmsAnalytics } from '@getpimms/analytics/react';
+ *
+ * export default function App() {
+ *  return (
+ *    <div>
+ *      <PimmsAnalytics />
+ *      <h1>My App</h1>
+ *    </div>
+ *  );
+ * }
+ * ```
+ */
+declare function Analytics(props: AnalyticsProps): null;
+
+export { Analytics, AnalyticsProps };

package/dist/react/index.d.ts

@@ -0,0 +1,155 @@
+interface AnalyticsProps {
+    /**
+     * The API endpoint to send analytics data to.
+     * @default 'https://api.pimms.io'
+     */
+    apiHost?: string;
+    /**
+     * This is a JSON object that configures the domains that PIMMS will track.
+     *
+     * - `refer`: The PIMMS short domain for referral program client-side click tracking (previously `shortDomain`). @see: https://d.to/clicks/refer
+     * - `site`: The PIMMS short domain for tracking site visits. @see: https://d.to/clicks/site
+     * - `outbound`: An array of domains for cross-domain tracking. When configured, the existing `pimms_id` cookie
+     *               will be automatically appended to all outbound links targeting these domains to enable
+     *               cross-domain tracking across different applications.
+     *
+     * @example {
+     *   refer: "refer.pimms.io",
+     *   site: "site.pimms.io",
+     *   outbound: "pim.ms"
+     * }
+     */
+    domainsConfig?: {
+        refer?: string;
+        site?: string;
+        outbound?: string | string[];
+    };
+    /**
+     * The custom domain you're using on PIMMS for your short links (for client-side click tracking).
+     * @example 'go.example.com'
+     * @deprecated Use domainsConfig.refer instead
+     */
+    shortDomain?: string;
+    /**
+     * The Attribution Model to use for the analytics event.
+     *
+     * @default 'last-click'
+     *
+     * - `first-click` - The first click model gives all the credit to the first touchpoint in the customer journey.
+     * - `last-click` - The last click model gives all the credit to the last touchpoint in the customer journey.
+     */
+    attributionModel?: 'first-click' | 'last-click';
+    /**
+     * The cookie options to use for the analytics event.
+     */
+    cookieOptions?: {
+        /**
+         * Specifies the value for the {@link https://tools.ietf.org/html/rfc6265#section-5.2.3|Domain Set-Cookie attribute}. By default, no
+         * domain is set, and most clients will consider the cookie to apply to only the current domain.
+         * By default, the domain is set to the current hostname (including all subdomains).
+         *
+         * @default `.` + window.location.hostname
+         */
+        domain?: string | undefined;
+        /**
+         * Specifies the `Date` object to be the value for the {@link https://tools.ietf.org/html/rfc6265#section-5.2.1|`Expires` `Set-Cookie` attribute}. By default,
+         * no expiration is set, and most clients will consider this a "non-persistent cookie" and will delete
+         * it on a condition like exiting a web browser application.
+         *
+         * *Note* the {@link https://tools.ietf.org/html/rfc6265#section-5.3|cookie storage model specification}
+         * states that if both `expires` and `maxAge` are set, then `maxAge` takes precedence, but it is
+         * possible not all clients by obey this, so if both are set, they should
+         * point to the same date and time.
+         */
+        expires?: Date | undefined;
+        /**
+         * Specifies the number of days until the cookie expires.
+         *
+         * @default 90
+         */
+        expiresInDays?: number | undefined;
+        /**
+         * Specifies the boolean value for the {@link https://tools.ietf.org/html/rfc6265#section-5.2.6|`HttpOnly` `Set-Cookie` attribute}.
+         * When truthy, the `HttpOnly` attribute is set, otherwise it is not. By
+         * default, the `HttpOnly` attribute is not set.
+         *
+         * *Note* be careful when setting this to true, as compliant clients will
+         * not allow client-side JavaScript to see the cookie in `document.cookie`.
+         */
+        httpOnly?: boolean | undefined;
+        /**
+         * Specifies the number (in seconds) to be the value for the `Max-Age`
+         * `Set-Cookie` attribute. The given number will be converted to an integer
+         * by rounding down. By default, no maximum age is set.
+         *
+         * *Note* the {@link https://tools.ietf.org/html/rfc6265#section-5.3|cookie storage model specification}
+         * states that if both `expires` and `maxAge` are set, then `maxAge` takes precedence, but it is
+         * possible not all clients by obey this, so if both are set, they should
+         * point to the same date and time.
+         */
+        maxAge?: number | undefined;
+        /**
+         * Specifies the value for the {@link https://tools.ietf.org/html/rfc6265#section-5.2.4|`Path` `Set-Cookie` attribute}.
+         * By default, the path is considered the "default path".
+         */
+        path?: string | undefined;
+        /**
+         * Specifies the boolean or string to be the value for the {@link https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-03#section-4.1.2.7|`SameSite` `Set-Cookie` attribute}.
+         *
+         * - `true` will set the `SameSite` attribute to `Strict` for strict same
+         * site enforcement.
+         * - `false` will not set the `SameSite` attribute.
+         * - `'lax'` will set the `SameSite` attribute to Lax for lax same site
+         * enforcement.
+         * - `'strict'` will set the `SameSite` attribute to Strict for strict same
+         * site enforcement.
+         *  - `'none'` will set the SameSite attribute to None for an explicit
+         *  cross-site cookie.
+         *
+         * More information about the different enforcement levels can be found in {@link https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-03#section-4.1.2.7|the specification}.
+         *
+         * *note* This is an attribute that has not yet been fully standardized, and may change in the future. This also means many clients may ignore this attribute until they understand it.
+         */
+        sameSite?: true | false | 'lax' | 'strict' | 'none' | undefined;
+        /**
+         * Specifies the boolean value for the {@link https://tools.ietf.org/html/rfc6265#section-5.2.5|`Secure` `Set-Cookie` attribute}. When truthy, the
+         * `Secure` attribute is set, otherwise it is not. By default, the `Secure` attribute is not set.
+         *
+         * *Note* be careful when setting this to `true`, as compliant clients will
+         * not send the cookie back to the server in the future if the browser does
+         * not have an HTTPS connection.
+         */
+        secure?: boolean | undefined;
+    };
+    /**
+     * The query parameter to listen to for client-side click-tracking (e.g. `?via=john`, `?ref=jane`).
+     *
+     * @default 'via'
+     */
+    queryParam?: string;
+    /**
+     * Custom properties to pass to the script.
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLScriptElement
+     */
+    scriptProps?: React.DetailedHTMLProps<React.ScriptHTMLAttributes<HTMLScriptElement>, HTMLScriptElement>;
+}
+
+/**
+ * Injects the PIMMS Web Analytics script into the page head.
+ * @param props - Analytics options.
+ * ```js
+ * import { Analytics as PimmsAnalytics } from '@getpimms/analytics/react';
+ *
+ * export default function App() {
+ *  return (
+ *    <div>
+ *      <PimmsAnalytics />
+ *      <h1>My App</h1>
+ *    </div>
+ *  );
+ * }
+ * ```
+ */
+declare function Analytics(props: AnalyticsProps): null;
+
+export { Analytics, AnalyticsProps };

package/dist/react/index.js

@@ -0,0 +1,75 @@
+"use client";
+
+// src/react.tsx
+import { useEffect } from "react";
+
+// package.json
+var name = "@getpimms/analytics";
+var version = "0.0.27";
+
+// src/utils.tsx
+function isBrowser() {
+  return typeof window !== "undefined";
+}
+
+// src/generic.ts
+function inject(props) {
+  var _a, _b, _c, _d;
+  if (!isBrowser())
+    return;
+  const baseUrl = "https://cdn.pimms.io/analytics/script";
+  const features = [];
+  if ((_a = props.domainsConfig) == null ? void 0 : _a.site)
+    features.push("site-visit");
+  if ((_b = props.domainsConfig) == null ? void 0 : _b.outbound)
+    features.push("outbound-domains");
+  const src = ((_c = props.scriptProps) == null ? void 0 : _c.src) || (features.length > 0 ? `${baseUrl}.${features.join(".")}.js` : `${baseUrl}.js`);
+  if (document.head.querySelector(`script[src*="${src}"]`))
+    return;
+  const script = document.createElement("script");
+  script.src = src;
+  script.defer = ((_d = props.scriptProps) == null ? void 0 : _d.defer) ?? true;
+  script.setAttribute("data-sdkn", name);
+  script.setAttribute("data-sdkv", version);
+  if (props.apiHost) {
+    script.setAttribute("data-api-host", props.apiHost);
+  }
+  if (props.domainsConfig) {
+    script.setAttribute("data-domains", JSON.stringify(props.domainsConfig));
+  }
+  if (props.shortDomain) {
+    script.setAttribute("data-short-domain", props.shortDomain);
+  }
+  if (props.attributionModel) {
+    script.setAttribute("data-attribution-model", props.attributionModel);
+  }
+  if (props.cookieOptions && Object.keys(props.cookieOptions).length > 0) {
+    script.setAttribute(
+      "data-cookie-options",
+      JSON.stringify(props.cookieOptions)
+    );
+  }
+  if (props.queryParam) {
+    script.setAttribute("data-query-param", props.queryParam);
+  }
+  if (props.scriptProps) {
+    const { src: _, ...restProps } = props.scriptProps;
+    Object.assign(script, restProps);
+  }
+  script.onerror = () => {
+    console.log(`[PIMMS Web Analytics] failed to load script from ${src}.`);
+  };
+  document.head.appendChild(script);
+}
+
+// src/react.tsx
+function Analytics(props) {
+  useEffect(() => {
+    inject(props);
+  }, [props]);
+  return null;
+}
+export {
+  Analytics
+};
+//# sourceMappingURL=index.js.map

package/dist/react/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/react.tsx","../../package.json","../../src/utils.tsx","../../src/generic.ts"],"sourcesContent":["import { useEffect } from 'react';\nimport { inject } from './generic';\nimport type { AnalyticsProps } from './types';\n\n/**\n * Injects the PIMMS Web Analytics script into the page head.\n * @param props - Analytics options.\n * ```js\n * import { Analytics as PimmsAnalytics } from '@getpimms/analytics/react';\n *\n * export default function App() {\n *  return (\n *    <div>\n *      <PimmsAnalytics />\n *      <h1>My App</h1>\n *    </div>\n *  );\n * }\n * ```\n */\nfunction Analytics(props: AnalyticsProps): null {\n  useEffect(() => {\n    inject(props);\n  }, [props]);\n\n  return null;\n}\n\nexport { Analytics };\nexport type { AnalyticsProps };\n","{\n  \"name\": \"@getpimms/analytics\",\n  \"version\": \"0.0.27\",\n  \"description\": \"\",\n  \"keywords\": [\n    \"analytics\",\n    \"pimms\"\n  ],\n  \"repository\": {\n    \"url\": \"github:getpimms/analytics\",\n    \"directory\": \"packages/web\"\n  },\n  \"license\": \"MPL-2.0\",\n  \"type\": \"module\",\n  \"exports\": {\n    \"./package.json\": \"./package.json\",\n    \".\": {\n      \"browser\": \"./dist/index.js\",\n      \"import\": \"./dist/index.js\",\n      \"require\": \"./dist/index.cjs\"\n    },\n    \"./react\": {\n      \"browser\": \"./dist/react/index.js\",\n      \"import\": \"./dist/react/index.js\",\n      \"require\": \"./dist/react/index.cjs\"\n    }\n  },\n  \"main\": \"dist/index.js\",\n  \"types\": \"dist/index.d.ts\",\n  \"typesVersions\": {\n    \"*\": {\n      \"*\": [\n        \"dist/index.d.ts\"\n      ],\n      \"react\": [\n        \"dist/react/index.d.ts\"\n      ]\n    }\n  },\n  \"scripts\": {\n    \"build\": \"tsup\",\n    \"dev\": \"tsup --watch\",\n    \"lint\": \"eslint .\",\n    \"lint-fix\": \"eslint . --fix\",\n    \"type-check\": \"tsc --noEmit\"\n  },\n  \"eslintConfig\": {\n    \"extends\": [\n      \"@dub/eslint-config\"\n    ],\n    \"rules\": {\n      \"tsdoc/syntax\": \"off\"\n    }\n  },\n  \"dependencies\": {\n    \"server-only\": \"^0.0.1\"\n  },\n  \"devDependencies\": {\n    \"@dub/eslint-config\": \"workspace:0.0.0\",\n    \"@swc/core\": \"^1.3.66\",\n    \"@types/node\": \"^20.3.1\",\n    \"@types/react\": \"^18.2.14\",\n    \"react\": \"^18.2.0\",\n    \"react-dom\": \"^18.2.0\",\n    \"tsup\": \"7.1.0\"\n  },\n  \"publishConfig\": {\n    \"access\": \"public\"\n  }\n}","export function isBrowser() {\n  return typeof window !== 'undefined';\n}\n","import { name, version } from '../package.json';\nimport type { AnalyticsProps } from './types';\nimport { isBrowser } from './utils';\n\n/**\n * Injects the PIMMS Web Analytics script into the page head.\n */\nfunction inject(props: AnalyticsProps): void {\n  if (!isBrowser()) return;\n\n  // Determine script source based on enabled features\n  const baseUrl = 'https://cdn.pimms.io/analytics/script';\n  const features = [];\n\n  if (props.domainsConfig?.site) features.push('site-visit');\n  if (props.domainsConfig?.outbound) features.push('outbound-domains');\n\n  const src =\n    props.scriptProps?.src ||\n    (features.length > 0\n      ? `${baseUrl}.${features.join('.')}.js`\n      : `${baseUrl}.js`);\n\n  if (document.head.querySelector(`script[src*=\"${src}\"]`)) return;\n\n  const script = document.createElement('script');\n  script.src = src;\n  script.defer = props.scriptProps?.defer ?? true;\n  script.setAttribute('data-sdkn', name);\n  script.setAttribute('data-sdkv', version);\n\n  if (props.apiHost) {\n    script.setAttribute('data-api-host', props.apiHost);\n  }\n\n  if (props.domainsConfig) {\n    script.setAttribute('data-domains', JSON.stringify(props.domainsConfig));\n  }\n\n  if (props.shortDomain) {\n    script.setAttribute('data-short-domain', props.shortDomain);\n  }\n\n  if (props.attributionModel) {\n    script.setAttribute('data-attribution-model', props.attributionModel);\n  }\n\n  if (props.cookieOptions && Object.keys(props.cookieOptions).length > 0) {\n    script.setAttribute(\n      'data-cookie-options',\n      JSON.stringify(props.cookieOptions),\n    );\n  }\n\n  if (props.queryParam) {\n    script.setAttribute('data-query-param', props.queryParam);\n  }\n\n  if (props.scriptProps) {\n    const { src: _, ...restProps } = props.scriptProps; // we already set the src above\n    Object.assign(script, restProps);\n  }\n\n  script.onerror = (): void => {\n    // eslint-disable-next-line no-console -- Logging to console is intentional\n    console.log(`[PIMMS Web Analytics] failed to load script from ${src}.`);\n  };\n\n  document.head.appendChild(script);\n}\n\nexport { inject };\nexport type { AnalyticsProps };\n\n// eslint-disable-next-line import/no-default-export -- Default export is intentional\nexport default {\n  inject,\n};\n"],"mappings":";;;AAAA,SAAS,iBAAiB;;;ACCxB,WAAQ;AACR,cAAW;;;ACFN,SAAS,YAAY;AAC1B,SAAO,OAAO,WAAW;AAC3B;;;ACKA,SAAS,OAAO,OAA6B;AAP7C;AAQE,MAAI,CAAC,UAAU;AAAG;AAGlB,QAAM,UAAU;AAChB,QAAM,WAAW,CAAC;AAElB,OAAI,WAAM,kBAAN,mBAAqB;AAAM,aAAS,KAAK,YAAY;AACzD,OAAI,WAAM,kBAAN,mBAAqB;AAAU,aAAS,KAAK,kBAAkB;AAEnE,QAAM,QACJ,WAAM,gBAAN,mBAAmB,SAClB,SAAS,SAAS,IACf,GAAG,OAAO,IAAI,SAAS,KAAK,GAAG,CAAC,QAChC,GAAG,OAAO;AAEhB,MAAI,SAAS,KAAK,cAAc,gBAAgB,GAAG,IAAI;AAAG;AAE1D,QAAM,SAAS,SAAS,cAAc,QAAQ;AAC9C,SAAO,MAAM;AACb,SAAO,UAAQ,WAAM,gBAAN,mBAAmB,UAAS;AAC3C,SAAO,aAAa,aAAa,IAAI;AACrC,SAAO,aAAa,aAAa,OAAO;AAExC,MAAI,MAAM,SAAS;AACjB,WAAO,aAAa,iBAAiB,MAAM,OAAO;AAAA,EACpD;AAEA,MAAI,MAAM,eAAe;AACvB,WAAO,aAAa,gBAAgB,KAAK,UAAU,MAAM,aAAa,CAAC;AAAA,EACzE;AAEA,MAAI,MAAM,aAAa;AACrB,WAAO,aAAa,qBAAqB,MAAM,WAAW;AAAA,EAC5D;AAEA,MAAI,MAAM,kBAAkB;AAC1B,WAAO,aAAa,0BAA0B,MAAM,gBAAgB;AAAA,EACtE;AAEA,MAAI,MAAM,iBAAiB,OAAO,KAAK,MAAM,aAAa,EAAE,SAAS,GAAG;AACtE,WAAO;AAAA,MACL;AAAA,MACA,KAAK,UAAU,MAAM,aAAa;AAAA,IACpC;AAAA,EACF;AAEA,MAAI,MAAM,YAAY;AACpB,WAAO,aAAa,oBAAoB,MAAM,UAAU;AAAA,EAC1D;AAEA,MAAI,MAAM,aAAa;AACrB,UAAM,EAAE,KAAK,GAAG,GAAG,UAAU,IAAI,MAAM;AACvC,WAAO,OAAO,QAAQ,SAAS;AAAA,EACjC;AAEA,SAAO,UAAU,MAAY;AAE3B,YAAQ,IAAI,oDAAoD,GAAG,GAAG;AAAA,EACxE;AAEA,WAAS,KAAK,YAAY,MAAM;AAClC;;;AHjDA,SAAS,UAAU,OAA6B;AAC9C,YAAU,MAAM;AACd,WAAO,KAAK;AAAA,EACd,GAAG,CAAC,KAAK,CAAC;AAEV,SAAO;AACT;","names":[]}

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@getpimms/analytics",
+  "version": "0.0.27",
+  "description": "",
+  "keywords": [
+    "analytics",
+    "pimms"
+  ],
+  "repository": {
+    "url": "github:getpimms/analytics",
+    "directory": "packages/web"
+  },
+  "license": "MPL-2.0",
+  "type": "module",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "browser": "./dist/index.js",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./react": {
+      "browser": "./dist/react/index.js",
+      "import": "./dist/react/index.js",
+      "require": "./dist/react/index.cjs"
+    }
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "*": [
+        "dist/index.d.ts"
+      ],
+      "react": [
+        "dist/react/index.d.ts"
+      ]
+    }
+  },
+  "eslintConfig": {
+    "extends": [
+      "@dub/eslint-config"
+    ],
+    "rules": {
+      "tsdoc/syntax": "off"
+    }
+  },
+  "dependencies": {
+    "server-only": "^0.0.1"
+  },
+  "devDependencies": {
+    "@dub/eslint-config": "0.0.0",
+    "@swc/core": "^1.3.66",
+    "@types/node": "^20.3.1",
+    "@types/react": "^18.2.14",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "tsup": "7.1.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "lint": "eslint .",
+    "lint-fix": "eslint . --fix",
+    "type-check": "tsc --noEmit"
+  }
+}

package/src/generic.ts

@@ -0,0 +1,78 @@
+import { name, version } from '../package.json';
+import type { AnalyticsProps } from './types';
+import { isBrowser } from './utils';
+
+/**
+ * Injects the PIMMS Web Analytics script into the page head.
+ */
+function inject(props: AnalyticsProps): void {
+  if (!isBrowser()) return;
+
+  // Determine script source based on enabled features
+  const baseUrl = 'https://cdn.pimms.io/analytics/script';
+  const features = [];
+
+  if (props.domainsConfig?.site) features.push('site-visit');
+  if (props.domainsConfig?.outbound) features.push('outbound-domains');
+
+  const src =
+    props.scriptProps?.src ||
+    (features.length > 0
+      ? `${baseUrl}.${features.join('.')}.js`
+      : `${baseUrl}.js`);
+
+  if (document.head.querySelector(`script[src*="${src}"]`)) return;
+
+  const script = document.createElement('script');
+  script.src = src;
+  script.defer = props.scriptProps?.defer ?? true;
+  script.setAttribute('data-sdkn', name);
+  script.setAttribute('data-sdkv', version);
+
+  if (props.apiHost) {
+    script.setAttribute('data-api-host', props.apiHost);
+  }
+
+  if (props.domainsConfig) {
+    script.setAttribute('data-domains', JSON.stringify(props.domainsConfig));
+  }
+
+  if (props.shortDomain) {
+    script.setAttribute('data-short-domain', props.shortDomain);
+  }
+
+  if (props.attributionModel) {
+    script.setAttribute('data-attribution-model', props.attributionModel);
+  }
+
+  if (props.cookieOptions && Object.keys(props.cookieOptions).length > 0) {
+    script.setAttribute(
+      'data-cookie-options',
+      JSON.stringify(props.cookieOptions),
+    );
+  }
+
+  if (props.queryParam) {
+    script.setAttribute('data-query-param', props.queryParam);
+  }
+
+  if (props.scriptProps) {
+    const { src: _, ...restProps } = props.scriptProps; // we already set the src above
+    Object.assign(script, restProps);
+  }
+
+  script.onerror = (): void => {
+    // eslint-disable-next-line no-console -- Logging to console is intentional
+    console.log(`[PIMMS Web Analytics] failed to load script from ${src}.`);
+  };
+
+  document.head.appendChild(script);
+}
+
+export { inject };
+export type { AnalyticsProps };
+
+// eslint-disable-next-line import/no-default-export -- Default export is intentional
+export default {
+  inject,
+};

package/src/react.tsx

@@ -0,0 +1,30 @@
+import { useEffect } from 'react';
+import { inject } from './generic';
+import type { AnalyticsProps } from './types';
+
+/**
+ * Injects the PIMMS Web Analytics script into the page head.
+ * @param props - Analytics options.
+ * ```js
+ * import { Analytics as PimmsAnalytics } from '@getpimms/analytics/react';
+ *
+ * export default function App() {
+ *  return (
+ *    <div>
+ *      <PimmsAnalytics />
+ *      <h1>My App</h1>
+ *    </div>
+ *  );
+ * }
+ * ```
+ */
+function Analytics(props: AnalyticsProps): null {
+  useEffect(() => {
+    inject(props);
+  }, [props]);
+
+  return null;
+}
+
+export { Analytics };
+export type { AnalyticsProps };