@xyd-js/analytics 0.0.0-build

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 xyd
+
+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/index.d.ts

@@ -0,0 +1,33 @@
+import React from 'react';
+import { PlugAnalytics } from 'pluganalytics';
+import { Settings } from '@xyd-js/core';
+
+interface XYDAnalyticsProps {
+    children: React.ReactNode;
+    settings: Settings;
+    loader: any;
+}
+declare function Analytics({ children, settings, loader }: XYDAnalyticsProps): React.JSX.Element;
+declare function useAnalytics(): PlugAnalytics;
+
+declare const useUXEvents: () => {
+    docs: {
+        copy_page: (args: unknown) => void;
+        search: {
+            open: (args: unknown) => void;
+            result_click: (args: {
+                title: string;
+                description: string;
+            }) => void;
+            query_change: (args: {
+                term: string;
+            }) => void;
+        };
+        github_star: {
+            hover: (args: unknown) => void;
+            click: (args: unknown) => void;
+        };
+    };
+};
+
+export { Analytics, useAnalytics, useUXEvents };

package/dist/index.js

@@ -0,0 +1,117 @@
+// src/Analytics.tsx
+import React, { createContext, useContext, useEffect, useState } from "react";
+import { useLocation } from "react-router";
+import { UXAnalytics } from "openux-js";
+import { plugAnalytics } from "pluganalytics";
+var AnalyticsContext = createContext({});
+function Analytics({ children, settings, loader }) {
+  const location = useLocation();
+  const [plugAnalyticsInstance, setPlugAnalyticsInstance] = useState(() => plugAnalytics({ providers: [] }));
+  async function loadAnalytics() {
+    const providers = await loadAnalyticsModules(settings, loader);
+    const validProviders = providers.filter(Boolean);
+    const plug = plugAnalytics({ providers: validProviders });
+    plug.page();
+    setPlugAnalyticsInstance(plug);
+  }
+  useEffect(() => {
+    loadAnalytics();
+  }, []);
+  useEffect(() => {
+    plugAnalyticsInstance.page();
+  }, [location.pathname]);
+  return /* @__PURE__ */ React.createElement(
+    AnalyticsContext,
+    {
+      value: { analytics: plugAnalyticsInstance }
+    },
+    /* @__PURE__ */ React.createElement(UXAnalytics, { analytics: plugAnalyticsInstance }, children)
+  );
+}
+function useAnalytics() {
+  const ctx = useContext(AnalyticsContext);
+  return ctx.analytics;
+}
+async function loadAnalyticsModules(settings, loader) {
+  var _a;
+  const loadingProviderModules = Object.keys(((_a = settings == null ? void 0 : settings.integrations) == null ? void 0 : _a.analytics) || {}).map(async (provider) => {
+    var _a2, _b;
+    const providerOptions = ((_b = (_a2 = settings == null ? void 0 : settings.integrations) == null ? void 0 : _a2.analytics) == null ? void 0 : _b[provider]) || [];
+    const module = await loader(provider);
+    if (!module) {
+      console.error(`Cannot load provider ${provider} module`);
+      return;
+    }
+    let options = providerOptions;
+    if (provider === "livesession") {
+      options = providerOptions.trackId;
+    }
+    if (Array.isArray(options)) {
+      return module(...options);
+    }
+    return module(options);
+  });
+  const providerModules = await Promise.all(loadingProviderModules);
+  return providerModules;
+}
+
+// src/useUXEvents.ts
+import { defineEvents } from "openux-js";
+var useUXEvents = defineEvents(({ Framework }) => ({
+  docs: {
+    copy_page() {
+      return {
+        ...commonUniformProps({ Framework })
+      };
+    },
+    search: {
+      open() {
+        return {};
+      },
+      result_click({ title, description }) {
+        let sanitizeDescription = (description || "").slice(0, 100);
+        if (sanitizeDescription.length < description.length) {
+          sanitizeDescription += "...";
+        }
+        return {
+          title,
+          description: sanitizeDescription
+        };
+      },
+      query_change({ term }) {
+        let sanitizeTerm = term.slice(0, 100);
+        if (sanitizeTerm.length < term.length) {
+          sanitizeTerm += "...";
+        }
+        return {
+          term: sanitizeTerm
+        };
+      }
+    },
+    github_star: {
+      hover() {
+        return {
+          ...commonUniformProps({ Framework })
+        };
+      },
+      click() {
+        return {
+          ...commonUniformProps({ Framework })
+        };
+      }
+    }
+  }
+}));
+function commonUniformProps({
+  Framework
+}) {
+  return {
+    location: Framework == null ? void 0 : Framework.location
+  };
+}
+export {
+  Analytics,
+  useAnalytics,
+  useUXEvents
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/Analytics.tsx","../src/useUXEvents.ts"],"sourcesContent":["import React, { createContext, useContext, useEffect, useState } from \"react\";\nimport { useLocation } from \"react-router\";\n\nimport { UXAnalytics } from \"openux-js\";\nimport { plugAnalytics, type AnalyticsProvider, PlugAnalytics } from \"pluganalytics\"\n\nimport { Settings } from \"@xyd-js/core\";\n\ninterface XYDAnalyticsProps {\n    children: React.ReactNode\n    settings: Settings\n    loader: any // TODO: types\n}\n\ninterface AnalyticsContextProps {\n    analytics: PlugAnalytics\n}\n\nconst AnalyticsContext = createContext<AnalyticsContextProps>({} as AnalyticsContextProps)\n\nexport function Analytics({ children, settings, loader }: XYDAnalyticsProps) {\n    const location = useLocation()\n    const [plugAnalyticsInstance, setPlugAnalyticsInstance] = useState(() => plugAnalytics({ providers: [] }))\n\n    async function loadAnalytics() {\n        const providers = await loadAnalyticsModules(settings, loader)\n        const validProviders = providers.filter(Boolean) as AnalyticsProvider[]\n        const plug = plugAnalytics({ providers: validProviders })\n\n        plug.page()\n        setPlugAnalyticsInstance(plug)\n    }\n\n    // TODO: in the future better mechanism to load analytics - allow SSR\n    useEffect(() => {\n        loadAnalytics()\n    }, [])\n\n    useEffect(() => {\n        plugAnalyticsInstance.page()\n    }, [location.pathname])\n\n    return <AnalyticsContext\n        value={{ analytics: plugAnalyticsInstance }}\n    >\n        <UXAnalytics analytics={plugAnalyticsInstance}>\n            {children}\n        </UXAnalytics>\n    </AnalyticsContext>\n}\n\nexport function useAnalytics() {\n    const ctx = useContext(AnalyticsContext)\n\n    return ctx.analytics\n}\n\n// TODO: better, more reusable loader\nasync function loadAnalyticsModules(\n    settings: Settings,\n    loader: any // TODO: types\n) {\n    const loadingProviderModules = Object.keys(settings?.integrations?.analytics || {}).map(async provider => {\n        const providerOptions = settings?.integrations?.analytics?.[provider] || []\n        const module = await loader(provider)\n        if (!module) {\n            console.error(`Cannot load provider ${provider} module`)\n\n            return\n        }\n\n\n        let options = providerOptions\n\n        // TODO: in the future better API\n        if (provider === \"livesession\") {\n            options = providerOptions.trackId\n        }\n\n        if (Array.isArray(options)) {\n            return module(...options)\n        }\n\n        return module(options)\n    })\n\n    const providerModules = await Promise.all(loadingProviderModules)\n\n    return providerModules\n}\n","import { defineEvents } from 'openux-js'\n\ninterface NodeFramework {\n    location: string\n    uniformRegion?: string\n}\n\ninterface AnalyticsNodes {\n    Framework: NodeFramework\n}\n\n// TODO: in the future + maybe better API\nexport const useUXEvents = defineEvents(({ Framework }: AnalyticsNodes) => ({\n    docs: {\n        copy_page() {\n            return {\n                ...commonUniformProps({ Framework }),\n            }\n        },\n        search: {\n            open() {\n                return {\n                }\n            },\n            result_click({ title, description }: { title: string, description: string }) {\n                let sanitizeDescription = (description || \"\").slice(0, 100)\n                if (sanitizeDescription.length < description.length) {\n                    sanitizeDescription += \"...\"\n                }\n                return {\n                    title,\n                    description: sanitizeDescription,\n                }\n            },\n            query_change({ term }: { term: string }) {\n                let sanitizeTerm = term.slice(0, 100)\n                if (sanitizeTerm.length < term.length) {\n                    sanitizeTerm += \"...\"\n                }\n                \n                return {\n                    term: sanitizeTerm,\n                }\n            }\n        },\n        github_star: {\n            hover() {\n                return {\n                    ...commonUniformProps({ Framework }),\n                }\n            },\n            click() {\n                return {\n                    ...commonUniformProps({ Framework }),\n                }\n            }\n        }\n    }\n}))\n\n\nfunction commonUniformProps({\n    Framework\n}: {\n    Framework: NodeFramework | undefined\n}) {\n    return {\n        location: Framework?.location!\n    }\n}\n"],"mappings":";AAAA,OAAO,SAAS,eAAe,YAAY,WAAW,gBAAgB;AACtE,SAAS,mBAAmB;AAE5B,SAAS,mBAAmB;AAC5B,SAAS,qBAA4D;AAcrE,IAAM,mBAAmB,cAAqC,CAAC,CAA0B;AAElF,SAAS,UAAU,EAAE,UAAU,UAAU,OAAO,GAAsB;AACzE,QAAM,WAAW,YAAY;AAC7B,QAAM,CAAC,uBAAuB,wBAAwB,IAAI,SAAS,MAAM,cAAc,EAAE,WAAW,CAAC,EAAE,CAAC,CAAC;AAEzG,iBAAe,gBAAgB;AAC3B,UAAM,YAAY,MAAM,qBAAqB,UAAU,MAAM;AAC7D,UAAM,iBAAiB,UAAU,OAAO,OAAO;AAC/C,UAAM,OAAO,cAAc,EAAE,WAAW,eAAe,CAAC;AAExD,SAAK,KAAK;AACV,6BAAyB,IAAI;AAAA,EACjC;AAGA,YAAU,MAAM;AACZ,kBAAc;AAAA,EAClB,GAAG,CAAC,CAAC;AAEL,YAAU,MAAM;AACZ,0BAAsB,KAAK;AAAA,EAC/B,GAAG,CAAC,SAAS,QAAQ,CAAC;AAEtB,SAAO;AAAA,IAAC;AAAA;AAAA,MACJ,OAAO,EAAE,WAAW,sBAAsB;AAAA;AAAA,IAE1C,oCAAC,eAAY,WAAW,yBACnB,QACL;AAAA,EACJ;AACJ;AAEO,SAAS,eAAe;AAC3B,QAAM,MAAM,WAAW,gBAAgB;AAEvC,SAAO,IAAI;AACf;AAGA,eAAe,qBACX,UACA,QACF;AA7DF;AA8DI,QAAM,yBAAyB,OAAO,OAAK,0CAAU,iBAAV,mBAAwB,cAAa,CAAC,CAAC,EAAE,IAAI,OAAM,aAAY;AA9D9G,QAAAA,KAAA;AA+DQ,UAAM,oBAAkB,MAAAA,MAAA,qCAAU,iBAAV,gBAAAA,IAAwB,cAAxB,mBAAoC,cAAa,CAAC;AAC1E,UAAM,SAAS,MAAM,OAAO,QAAQ;AACpC,QAAI,CAAC,QAAQ;AACT,cAAQ,MAAM,wBAAwB,QAAQ,SAAS;AAEvD;AAAA,IACJ;AAGA,QAAI,UAAU;AAGd,QAAI,aAAa,eAAe;AAC5B,gBAAU,gBAAgB;AAAA,IAC9B;AAEA,QAAI,MAAM,QAAQ,OAAO,GAAG;AACxB,aAAO,OAAO,GAAG,OAAO;AAAA,IAC5B;AAEA,WAAO,OAAO,OAAO;AAAA,EACzB,CAAC;AAED,QAAM,kBAAkB,MAAM,QAAQ,IAAI,sBAAsB;AAEhE,SAAO;AACX;;;ACzFA,SAAS,oBAAoB;AAYtB,IAAM,cAAc,aAAa,CAAC,EAAE,UAAU,OAAuB;AAAA,EACxE,MAAM;AAAA,IACF,YAAY;AACR,aAAO;AAAA,QACH,GAAG,mBAAmB,EAAE,UAAU,CAAC;AAAA,MACvC;AAAA,IACJ;AAAA,IACA,QAAQ;AAAA,MACJ,OAAO;AACH,eAAO,CACP;AAAA,MACJ;AAAA,MACA,aAAa,EAAE,OAAO,YAAY,GAA2C;AACzE,YAAI,uBAAuB,eAAe,IAAI,MAAM,GAAG,GAAG;AAC1D,YAAI,oBAAoB,SAAS,YAAY,QAAQ;AACjD,iCAAuB;AAAA,QAC3B;AACA,eAAO;AAAA,UACH;AAAA,UACA,aAAa;AAAA,QACjB;AAAA,MACJ;AAAA,MACA,aAAa,EAAE,KAAK,GAAqB;AACrC,YAAI,eAAe,KAAK,MAAM,GAAG,GAAG;AACpC,YAAI,aAAa,SAAS,KAAK,QAAQ;AACnC,0BAAgB;AAAA,QACpB;AAEA,eAAO;AAAA,UACH,MAAM;AAAA,QACV;AAAA,MACJ;AAAA,IACJ;AAAA,IACA,aAAa;AAAA,MACT,QAAQ;AACJ,eAAO;AAAA,UACH,GAAG,mBAAmB,EAAE,UAAU,CAAC;AAAA,QACvC;AAAA,MACJ;AAAA,MACA,QAAQ;AACJ,eAAO;AAAA,UACH,GAAG,mBAAmB,EAAE,UAAU,CAAC;AAAA,QACvC;AAAA,MACJ;AAAA,IACJ;AAAA,EACJ;AACJ,EAAE;AAGF,SAAS,mBAAmB;AAAA,EACxB;AACJ,GAEG;AACC,SAAO;AAAA,IACH,UAAU,uCAAW;AAAA,EACzB;AACJ;","names":["_a"]}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@xyd-js/analytics",
+  "version": "0.0.0-build+6952c2c-20250813013245",
+  "description": "",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "package.json",
+    "dist"
+  ],
+  "author": "",
+  "dependencies": {
+    "@xyd-js/core": "0.0.0-build+6952c2c-20250813013245"
+  },
+  "peerDependencies": {
+    "openux-js": "0.0.0-pre.1",
+    "pluganalytics": "0.0.0-pre.3",
+    "react": "^19.1.0",
+    "react-router": "^7.7.1",
+    "@xyd-js/uniform": "0.0.0-build+6952c2c-20250813013245"
+  },
+  "devDependencies": {
+    "@types/react": "^19.1.0",
+    "rimraf": "^3.0.2",
+    "tsup": "^8.3.0",
+    "typescript": "5.6.2"
+  },
+  "scripts": {
+    "clean": "rimraf build",
+    "prebuild": "pnpm clean",
+    "build": "tsup",
+    "watch": "tsup --watch",
+    "playground": "cd playground && pnpm dev"
+  }
+}