@xyd-js/analytics 0.1.0-xyd.2

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,27 @@
+import React from 'react';
+import { PlugAnalytics } from 'pluganalytics';
+import { Settings } from '@xyd-js/core';
+import { Example } from '@xyd-js/uniform';
+
+interface XYDAnalyticsProps {
+    children: React.ReactNode;
+    settings: Settings;
+    loader: any;
+}
+declare function XYDAnalytics({ children, settings, loader }: XYDAnalyticsProps): React.JSX.Element;
+declare function useAnalytics(): PlugAnalytics;
+
+declare const useEvents: () => {
+    CodeExampleChange: (args: {
+        example: Example;
+    }) => void;
+    CodeTabChange: (args: {
+        lang: string;
+    }) => void;
+    CodeCopy: (args: {
+        text: string;
+    }) => void;
+    CopyPage: (args: {}) => void;
+};
+
+export { XYDAnalytics, useAnalytics, useEvents };

package/dist/index.js

@@ -0,0 +1,105 @@
+// 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 XYDAnalyticsContext = createContext({});
+function XYDAnalytics({ 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(
+    XYDAnalyticsContext,
+    {
+      value: { analytics: plugAnalyticsInstance }
+    },
+    /* @__PURE__ */ React.createElement(UXAnalytics, { analytics: plugAnalyticsInstance }, children)
+  );
+}
+function useAnalytics() {
+  const ctx = useContext(XYDAnalyticsContext);
+  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;
+    }
+    if (Array.isArray(providerOptions)) {
+      return module(...providerOptions);
+    }
+    return module(providerOptions);
+  });
+  const providerModules = await Promise.all(loadingProviderModules);
+  return providerModules;
+}
+
+// src/events.ts
+import { defineEvents } from "openux-js";
+var useEvents = defineEvents({
+  CodeExampleChange(args, { APIRefSample, Framework }) {
+    var _a;
+    return {
+      ...commonUniformProps({ Framework }),
+      example: (_a = args == null ? void 0 : args.example) == null ? void 0 : _a.description
+    };
+  },
+  CodeTabChange(args, { APIRefSample, Framework }) {
+    return {
+      ...commonCodeTabsProps({ APIRefSample, Framework }),
+      lang: args.lang
+    };
+  },
+  CodeCopy(args, { APIRefSample, CodeSample, Framework }) {
+    return {
+      ...commonCodeTabsProps({ APIRefSample, Framework }),
+      lang: CodeSample == null ? void 0 : CodeSample.activeCodeblock.lang
+    };
+  },
+  CopyPage(args, { Framework }) {
+    return {
+      ...commonUniformProps({ Framework })
+    };
+  }
+});
+function commonCodeTabsProps({
+  APIRefSample,
+  Framework
+}) {
+  var _a;
+  return {
+    example: (_a = APIRefSample == null ? void 0 : APIRefSample.activeExample) == null ? void 0 : _a.description,
+    ...commonUniformProps({ Framework })
+  };
+}
+function commonUniformProps({
+  Framework
+}) {
+  return {
+    location: Framework == null ? void 0 : Framework.location,
+    uniformRegion: Framework == null ? void 0 : Framework.uniformRegion
+  };
+}
+export {
+  XYDAnalytics,
+  useAnalytics,
+  useEvents
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/Analytics.tsx","../src/events.ts"],"sourcesContent":["import React, { createContext, useContext, useEffect, useState } from \"react\";\nimport { useLocation } from \"react-router\";\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 XYDAnalyticsContextProps {\n    analytics: PlugAnalytics\n}\n\nconst XYDAnalyticsContext = createContext<XYDAnalyticsContextProps>({} as XYDAnalyticsContextProps)\n\nexport function XYDAnalytics({ 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 <XYDAnalyticsContext\n        value={{ analytics: plugAnalyticsInstance }}\n    >\n        <UXAnalytics analytics={plugAnalyticsInstance}>\n            {children}\n        </UXAnalytics>\n    </XYDAnalyticsContext>\n}\n\n\nexport function useAnalytics() {\n    const ctx = useContext(XYDAnalyticsContext)\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        if (Array.isArray(providerOptions)) {\n            return module(...providerOptions)\n        }\n\n        return module(providerOptions)\n    })\n\n    const providerModules = await Promise.all(loadingProviderModules)\n\n    return providerModules\n}\n","import { Example } from \"@xyd-js/uniform\";\n\nimport { defineEvents } from 'openux-js'\n\nexport class NodeAPIRefSample {\n    activeExample!: Example\n}\n\nexport class NodeCodeSample {\n    activeCodeblock!: {\n        lang: string;\n        code: string;\n    }\n}\n\nexport class NodeFramework {\n    location!: string\n    uniformRegion!: string\n}\n\nexport const AnalyticsNodes = {\n    APIRefSample: NodeAPIRefSample,\n    CodeSample: NodeCodeSample,\n    Framework: NodeFramework,\n} as const\n\nexport interface EventsSchema {\n    CodeExampleChange: { example: Example }\n    CodeTabChange: { lang: string }\n    CodeCopy: { text: string }\n\n    CopyPage: {}\n}\n\nexport const useEvents = defineEvents<EventsSchema, typeof AnalyticsNodes>({\n    CodeExampleChange(args, { APIRefSample, Framework }) {\n        return {\n            ...commonUniformProps({ Framework }),\n            example: args?.example?.description!,\n        }\n    },\n    CodeTabChange(args, { APIRefSample, Framework }) {\n        return {\n            ...commonCodeTabsProps({ APIRefSample, Framework }),\n            lang: args.lang!,\n        }\n    },\n    CodeCopy(args, { APIRefSample, CodeSample, Framework }) {\n        return {\n            ...commonCodeTabsProps({ APIRefSample, Framework }),\n            lang: CodeSample?.activeCodeblock.lang!,\n        }\n    },\n\n    CopyPage(args, { Framework }) {\n        return {\n            ...commonUniformProps({ Framework }),\n        }\n    }\n})\n\nfunction commonCodeTabsProps({\n    APIRefSample,\n    Framework\n}: {\n    APIRefSample: NodeAPIRefSample | undefined\n    Framework: NodeFramework | undefined\n}) {\n    return {\n        example: APIRefSample?.activeExample?.description!,\n        ...commonUniformProps({ Framework }),\n    }\n}\n\nfunction commonUniformProps({\n    Framework\n}: {\n    Framework: NodeFramework | undefined\n}) {\n    return {\n        location: Framework?.location!,\n        uniformRegion: Framework?.uniformRegion!,\n    }\n}\n"],"mappings":";AAAA,OAAO,SAAS,eAAe,YAAY,WAAW,gBAAgB;AACtE,SAAS,mBAAmB;AAC5B,SAAS,mBAAmB;AAC5B,SAAS,qBAA4D;AAcrE,IAAM,sBAAsB,cAAwC,CAAC,CAA6B;AAE3F,SAAS,aAAa,EAAE,UAAU,UAAU,OAAO,GAAsB;AAC5E,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;AAGO,SAAS,eAAe;AAC3B,QAAM,MAAM,WAAW,mBAAmB;AAE1C,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;AAEA,QAAI,MAAM,QAAQ,eAAe,GAAG;AAChC,aAAO,OAAO,GAAG,eAAe;AAAA,IACpC;AAEA,WAAO,OAAO,eAAe;AAAA,EACjC,CAAC;AAED,QAAM,kBAAkB,MAAM,QAAQ,IAAI,sBAAsB;AAEhE,SAAO;AACX;;;AC/EA,SAAS,oBAAoB;AAgCtB,IAAM,YAAY,aAAkD;AAAA,EACvE,kBAAkB,MAAM,EAAE,cAAc,UAAU,GAAG;AAnCzD;AAoCQ,WAAO;AAAA,MACH,GAAG,mBAAmB,EAAE,UAAU,CAAC;AAAA,MACnC,UAAS,kCAAM,YAAN,mBAAe;AAAA,IAC5B;AAAA,EACJ;AAAA,EACA,cAAc,MAAM,EAAE,cAAc,UAAU,GAAG;AAC7C,WAAO;AAAA,MACH,GAAG,oBAAoB,EAAE,cAAc,UAAU,CAAC;AAAA,MAClD,MAAM,KAAK;AAAA,IACf;AAAA,EACJ;AAAA,EACA,SAAS,MAAM,EAAE,cAAc,YAAY,UAAU,GAAG;AACpD,WAAO;AAAA,MACH,GAAG,oBAAoB,EAAE,cAAc,UAAU,CAAC;AAAA,MAClD,MAAM,yCAAY,gBAAgB;AAAA,IACtC;AAAA,EACJ;AAAA,EAEA,SAAS,MAAM,EAAE,UAAU,GAAG;AAC1B,WAAO;AAAA,MACH,GAAG,mBAAmB,EAAE,UAAU,CAAC;AAAA,IACvC;AAAA,EACJ;AACJ,CAAC;AAED,SAAS,oBAAoB;AAAA,EACzB;AAAA,EACA;AACJ,GAGG;AAnEH;AAoEI,SAAO;AAAA,IACH,UAAS,kDAAc,kBAAd,mBAA6B;AAAA,IACtC,GAAG,mBAAmB,EAAE,UAAU,CAAC;AAAA,EACvC;AACJ;AAEA,SAAS,mBAAmB;AAAA,EACxB;AACJ,GAEG;AACC,SAAO;AAAA,IACH,UAAU,uCAAW;AAAA,IACrB,eAAe,uCAAW;AAAA,EAC9B;AACJ;","names":["_a"]}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@xyd-js/analytics",
+  "version": "0.1.0-xyd.2",
+  "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.1.0-xyd.15",
+    "@xyd-js/uniform": "0.1.0-xyd.17"
+  },
+  "peerDependencies": {
+    "openux-js": "0.0.0-pre.0",
+    "pluganalytics": "0.0.0-pre.3",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "react-router": "^7.5.0"
+  },
+  "devDependencies": {
+    "@types/node": "22.5.5",
+    "@types/react": "^19.0.0",
+    "@types/react-dom": "^19.0.0",
+    "rimraf": "^3.0.2",
+    "tsup": "^8.3.0",
+    "typescript": "5.6.2",
+    "vite": "^6.1.0"
+  },
+  "scripts": {
+    "clean": "rimraf build",
+    "prebuild": "pnpm clean",
+    "build": "tsup",
+    "watch": "tsup --watch",
+    "playground": "cd playground && pnpm dev"
+  }
+}