@trichidata/react 0.4.3 → 0.5.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -23
- package/dist/index.cjs +44 -57
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +18 -12
- package/dist/index.d.ts +18 -12
- package/dist/index.js +45 -15
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -27,12 +27,7 @@ function Dashboard() {
|
|
|
27
27
|
const client = useTrichiData();
|
|
28
28
|
|
|
29
29
|
const handleClick = async () => {
|
|
30
|
-
await client.
|
|
31
|
-
type: 'page',
|
|
32
|
-
eventId: crypto.randomUUID(),
|
|
33
|
-
timestamp: Date.now(),
|
|
34
|
-
properties: { url: '/dashboard' },
|
|
35
|
-
});
|
|
30
|
+
await client.page({ url: '/dashboard' });
|
|
36
31
|
};
|
|
37
32
|
|
|
38
33
|
return <button onClick={handleClick}>Track page view</button>;
|
|
@@ -42,22 +37,13 @@ function Dashboard() {
|
|
|
42
37
|
## Standalone client (without Provider)
|
|
43
38
|
|
|
44
39
|
```ts
|
|
45
|
-
import { TrichiDataClient
|
|
40
|
+
import { TrichiDataClient } from '@trichidata/react';
|
|
46
41
|
|
|
47
42
|
const client = new TrichiDataClient({
|
|
48
43
|
apiKey: 'prj_ak_xxxxxxxxxxxx',
|
|
49
|
-
baseUrl: 'https://sdk-api.trichidata.com',
|
|
50
|
-
sessionStrategy: 'browser',
|
|
51
44
|
});
|
|
52
45
|
|
|
53
|
-
await client.init(
|
|
54
|
-
timestamp: Date.now(),
|
|
55
|
-
device: {
|
|
56
|
-
ip: '0.0.0.0',
|
|
57
|
-
userAgent: navigator.userAgent,
|
|
58
|
-
},
|
|
59
|
-
sdkVersion: SDK_VERSION,
|
|
60
|
-
});
|
|
46
|
+
await client.init();
|
|
61
47
|
```
|
|
62
48
|
|
|
63
49
|
## Scripts
|
|
@@ -69,9 +55,3 @@ await client.init({
|
|
|
69
55
|
| `npm run lint` | Run ESLint |
|
|
70
56
|
| `npm run format` | Format with Prettier |
|
|
71
57
|
| `npm run typecheck` | TypeScript check |
|
|
72
|
-
|
|
73
|
-
## Breaking changes in 0.2.0
|
|
74
|
-
|
|
75
|
-
- `TrichiDataSdk` renamed to `TrichiDataClient` (from `@trichidata/core`)
|
|
76
|
-
- `TrichiDataApiError` renamed to `TrichiDataError` (alias kept for compatibility)
|
|
77
|
-
- Core logic moved to `@trichidata/core@^0.2.0`
|
package/dist/index.cjs
CHANGED
|
@@ -25,27 +25,57 @@ function getPageContext() {
|
|
|
25
25
|
referrer: document.referrer || void 0
|
|
26
26
|
};
|
|
27
27
|
}
|
|
28
|
+
|
|
29
|
+
// src/client.ts
|
|
30
|
+
var TrichiDataClient = class extends core.TrichiDataClient {
|
|
31
|
+
constructor(options) {
|
|
32
|
+
super({ ...options, sessionStrategy: "browser" });
|
|
33
|
+
}
|
|
34
|
+
async init(params) {
|
|
35
|
+
const device = { ...getDefaultDeviceInfo(), ...params?.device };
|
|
36
|
+
const autoTracking = getDefaultTrackingContext();
|
|
37
|
+
const tracking = core.mergeTracking(autoTracking, params?.tracking);
|
|
38
|
+
return super.init({
|
|
39
|
+
timestamp: params?.timestamp,
|
|
40
|
+
device,
|
|
41
|
+
tracking
|
|
42
|
+
});
|
|
43
|
+
}
|
|
44
|
+
async page(properties, options) {
|
|
45
|
+
const pageContext = getPageContext();
|
|
46
|
+
return super.page(
|
|
47
|
+
{
|
|
48
|
+
url: properties?.url ?? pageContext.url,
|
|
49
|
+
referrer: properties?.referrer ?? pageContext.referrer,
|
|
50
|
+
title: properties?.title ?? pageContext.title
|
|
51
|
+
},
|
|
52
|
+
options
|
|
53
|
+
);
|
|
54
|
+
}
|
|
55
|
+
};
|
|
56
|
+
function getDefaultTrackingContext() {
|
|
57
|
+
if (typeof document === "undefined") {
|
|
58
|
+
return {};
|
|
59
|
+
}
|
|
60
|
+
return core.parseTrackingFromCookies({
|
|
61
|
+
cookieHeader: document.cookie,
|
|
62
|
+
url: typeof window !== "undefined" ? window.location.href : void 0
|
|
63
|
+
});
|
|
64
|
+
}
|
|
28
65
|
var TrichiDataContext = react.createContext(null);
|
|
29
66
|
function TrichiDataProvider({
|
|
30
67
|
children,
|
|
31
68
|
autoInit = true,
|
|
32
69
|
apiKey,
|
|
33
|
-
|
|
34
|
-
|
|
70
|
+
device,
|
|
71
|
+
tracking
|
|
35
72
|
}) {
|
|
36
|
-
const client = react.useMemo(
|
|
37
|
-
() => new core.TrichiDataClient({ apiKey, baseUrl, sessionStrategy: "browser" }),
|
|
38
|
-
[apiKey, baseUrl]
|
|
39
|
-
);
|
|
73
|
+
const client = react.useMemo(() => new TrichiDataClient({ apiKey }), [apiKey]);
|
|
40
74
|
react.useEffect(() => {
|
|
41
75
|
if (autoInit) {
|
|
42
|
-
void client.init({
|
|
43
|
-
timestamp: Date.now(),
|
|
44
|
-
device: { ...getDefaultDeviceInfo(), ...device },
|
|
45
|
-
sdkVersion: core.SDK_VERSION
|
|
46
|
-
});
|
|
76
|
+
void client.init({ device, tracking });
|
|
47
77
|
}
|
|
48
|
-
}, [autoInit, client, device]);
|
|
78
|
+
}, [autoInit, client, device, tracking]);
|
|
49
79
|
return /* @__PURE__ */ jsxRuntime.jsx(TrichiDataContext.Provider, { value: client, children });
|
|
50
80
|
}
|
|
51
81
|
function useTrichiData() {
|
|
@@ -56,60 +86,17 @@ function useTrichiData() {
|
|
|
56
86
|
return client;
|
|
57
87
|
}
|
|
58
88
|
|
|
59
|
-
Object.defineProperty(exports, "API_PREFIX", {
|
|
60
|
-
enumerable: true,
|
|
61
|
-
get: function () { return core.API_PREFIX; }
|
|
62
|
-
});
|
|
63
|
-
Object.defineProperty(exports, "DEFAULT_BASE_URL", {
|
|
64
|
-
enumerable: true,
|
|
65
|
-
get: function () { return core.DEFAULT_BASE_URL; }
|
|
66
|
-
});
|
|
67
|
-
Object.defineProperty(exports, "HttpClient", {
|
|
68
|
-
enumerable: true,
|
|
69
|
-
get: function () { return core.HttpClient; }
|
|
70
|
-
});
|
|
71
|
-
Object.defineProperty(exports, "SDK_VERSION", {
|
|
72
|
-
enumerable: true,
|
|
73
|
-
get: function () { return core.SDK_VERSION; }
|
|
74
|
-
});
|
|
75
89
|
Object.defineProperty(exports, "TrichiDataApiError", {
|
|
76
90
|
enumerable: true,
|
|
77
91
|
get: function () { return core.TrichiDataError; }
|
|
78
92
|
});
|
|
79
|
-
Object.defineProperty(exports, "TrichiDataClient", {
|
|
80
|
-
enumerable: true,
|
|
81
|
-
get: function () { return core.TrichiDataClient; }
|
|
82
|
-
});
|
|
83
93
|
Object.defineProperty(exports, "TrichiDataError", {
|
|
84
94
|
enumerable: true,
|
|
85
95
|
get: function () { return core.TrichiDataError; }
|
|
86
96
|
});
|
|
87
|
-
|
|
88
|
-
enumerable: true,
|
|
89
|
-
get: function () { return core.createEventId; }
|
|
90
|
-
});
|
|
91
|
-
Object.defineProperty(exports, "identify", {
|
|
92
|
-
enumerable: true,
|
|
93
|
-
get: function () { return core.identify; }
|
|
94
|
-
});
|
|
95
|
-
Object.defineProperty(exports, "initSdk", {
|
|
96
|
-
enumerable: true,
|
|
97
|
-
get: function () { return core.initSdk; }
|
|
98
|
-
});
|
|
99
|
-
Object.defineProperty(exports, "nowTimestamp", {
|
|
100
|
-
enumerable: true,
|
|
101
|
-
get: function () { return core.nowTimestamp; }
|
|
102
|
-
});
|
|
103
|
-
Object.defineProperty(exports, "trackEvent", {
|
|
104
|
-
enumerable: true,
|
|
105
|
-
get: function () { return core.trackEvent; }
|
|
106
|
-
});
|
|
107
|
-
Object.defineProperty(exports, "trackEventsBatch", {
|
|
108
|
-
enumerable: true,
|
|
109
|
-
get: function () { return core.trackEventsBatch; }
|
|
110
|
-
});
|
|
97
|
+
exports.TrichiDataClient = TrichiDataClient;
|
|
111
98
|
exports.TrichiDataProvider = TrichiDataProvider;
|
|
112
|
-
exports.
|
|
99
|
+
exports.getDefaultTrackingContext = getDefaultTrackingContext;
|
|
113
100
|
exports.getPageContext = getPageContext;
|
|
114
101
|
exports.useTrichiData = useTrichiData;
|
|
115
102
|
//# sourceMappingURL=index.cjs.map
|
package/dist/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/utils.ts","../src/react/TrichiDataProvider.tsx"],"names":["
|
|
1
|
+
{"version":3,"sources":["../src/utils.ts","../src/client.ts","../src/react/TrichiDataProvider.tsx"],"names":["CoreClient","mergeTracking","parseTrackingFromCookies","createContext","useMemo","useEffect","useContext"],"mappings":";;;;;;;;;AAAO,SAAS,oBAAA,GAKd;AACA,EAAA,OAAO;AAAA,IACL,EAAA,EAAI,SAAA;AAAA,IACJ,SAAA,EAAW,OAAO,SAAA,KAAc,WAAA,GAAc,UAAU,SAAA,GAAY,SAAA;AAAA,IACpE,MAAA,EAAQ,OAAO,SAAA,KAAc,WAAA,GAAc,UAAU,QAAA,GAAW,OAAA;AAAA,IAChE,QAAA,EACE,OAAO,IAAA,KAAS,WAAA,GAAc,KAAK,cAAA,EAAe,CAAE,eAAA,EAAgB,CAAE,QAAA,GAAW;AAAA,GACrF;AACF;AAEO,SAAS,cAAA,GAId;AACA,EAAA,IAAI,OAAO,QAAA,KAAa,WAAA,IAAe,OAAO,WAAW,WAAA,EAAa;AACpE,IAAA,OAAO,EAAC;AAAA,EACV;AAEA,EAAA,OAAO;AAAA,IACL,OAAO,QAAA,CAAS,KAAA;AAAA,IAChB,GAAA,EAAK,OAAO,QAAA,CAAS,IAAA;AAAA,IACrB,QAAA,EAAU,SAAS,QAAA,IAAY;AAAA,GACjC;AACF;;;ACTO,IAAM,gBAAA,GAAN,cAA+BA,qBAAA,CAAW;AAAA,EAC/C,YAAY,OAAA,EAAkC;AAC5C,IAAA,KAAA,CAAM,EAAE,GAAG,OAAA,EAAS,eAAA,EAAiB,WAAW,CAAA;AAAA,EAClD;AAAA,EAEA,MAAM,KAAK,MAAA,EAAgD;AACzD,IAAA,MAAM,SAAS,EAAE,GAAG,sBAAqB,EAAG,GAAG,QAAQ,MAAA,EAAO;AAC9D,IAAA,MAAM,eAAe,yBAAA,EAA0B;AAC/C,IAAA,MAAM,QAAA,GAAWC,kBAAA,CAAc,YAAA,EAAc,MAAA,EAAQ,QAAQ,CAAA;AAE7D,IAAA,OAAO,MAAM,IAAA,CAAK;AAAA,MAChB,WAAW,MAAA,EAAQ,SAAA;AAAA,MACnB,MAAA;AAAA,MACA;AAAA,KACD,CAAA;AAAA,EACH;AAAA,EAEA,MAAe,IAAA,CACb,UAAA,EACA,OAAA,EACyB;AACzB,IAAA,MAAM,cAAc,cAAA,EAAe;AACnC,IAAA,OAAO,KAAA,CAAM,IAAA;AAAA,MACX;AAAA,QACE,GAAA,EAAK,UAAA,EAAY,GAAA,IAAO,WAAA,CAAY,GAAA;AAAA,QACpC,QAAA,EAAU,UAAA,EAAY,QAAA,IAAY,WAAA,CAAY,QAAA;AAAA,QAC9C,KAAA,EAAO,UAAA,EAAY,KAAA,IAAS,WAAA,CAAY;AAAA,OAC1C;AAAA,MACA;AAAA,KACF;AAAA,EACF;AACF;AAEO,SAAS,yBAAA,GAA6C;AAC3D,EAAA,IAAI,OAAO,aAAa,WAAA,EAAa;AACnC,IAAA,OAAO,EAAC;AAAA,EACV;AAEA,EAAA,OAAOC,6BAAA,CAAyB;AAAA,IAC9B,cAAc,QAAA,CAAS,MAAA;AAAA,IACvB,KAAK,OAAO,MAAA,KAAW,WAAA,GAAc,MAAA,CAAO,SAAS,IAAA,GAAO;AAAA,GAC7D,CAAA;AACH;AC1DA,IAAM,iBAAA,GAAoBC,oBAAuC,IAAI,CAAA;AAS9D,SAAS,kBAAA,CAAmB;AAAA,EACjC,QAAA;AAAA,EACA,QAAA,GAAW,IAAA;AAAA,EACX,MAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAA,EAA4B;AAC1B,EAAA,MAAM,MAAA,GAASC,aAAA,CAAQ,MAAM,IAAI,gBAAA,CAAiB,EAAE,MAAA,EAAQ,CAAA,EAAG,CAAC,MAAM,CAAC,CAAA;AAEvE,EAAAC,eAAA,CAAU,MAAM;AACd,IAAA,IAAI,QAAA,EAAU;AACZ,MAAA,KAAK,MAAA,CAAO,IAAA,CAAK,EAAE,MAAA,EAAQ,UAAU,CAAA;AAAA,IACvC;AAAA,EACF,GAAG,CAAC,QAAA,EAAU,MAAA,EAAQ,MAAA,EAAQ,QAAQ,CAAC,CAAA;AAEvC,EAAA,sCAAQ,iBAAA,CAAkB,QAAA,EAAlB,EAA2B,KAAA,EAAO,QAAS,QAAA,EAAS,CAAA;AAC9D;AAEO,SAAS,aAAA,GAAkC;AAChD,EAAA,MAAM,MAAA,GAASC,iBAAW,iBAAiB,CAAA;AAE3C,EAAA,IAAI,CAAC,MAAA,EAAQ;AACX,IAAA,MAAM,IAAI,MAAM,wDAAwD,CAAA;AAAA,EAC1E;AAEA,EAAA,OAAO,MAAA;AACT","file":"index.cjs","sourcesContent":["export function getDefaultDeviceInfo(): {\n ip: string;\n userAgent: string;\n locale: string;\n timezone: string;\n} {\n return {\n ip: '0.0.0.0',\n userAgent: typeof navigator !== 'undefined' ? navigator.userAgent : 'unknown',\n locale: typeof navigator !== 'undefined' ? navigator.language : 'en-US',\n timezone:\n typeof Intl !== 'undefined' ? Intl.DateTimeFormat().resolvedOptions().timeZone : 'UTC',\n };\n}\n\nexport function getPageContext(): {\n title?: string;\n url?: string;\n referrer?: string;\n} {\n if (typeof document === 'undefined' || typeof window === 'undefined') {\n return {};\n }\n\n return {\n title: document.title,\n url: window.location.href,\n referrer: document.referrer || undefined,\n };\n}\n","import {\n TrichiDataClient as CoreClient,\n mergeTracking,\n parseTrackingFromCookies,\n type DeviceInfo,\n type InitSdkData,\n type PageProperties,\n type TrackEventData,\n type TrackingContext,\n type TrackOptions,\n type TrichiDataClientOptions,\n} from '@trichidata/core';\nimport { getDefaultDeviceInfo, getPageContext } from './utils';\n\nexport interface ReactInitParams {\n timestamp?: number;\n device?: Partial<DeviceInfo>;\n tracking?: TrackingContext;\n}\n\nexport class TrichiDataClient extends CoreClient {\n constructor(options: TrichiDataClientOptions) {\n super({ ...options, sessionStrategy: 'browser' });\n }\n\n async init(params?: ReactInitParams): Promise<InitSdkData> {\n const device = { ...getDefaultDeviceInfo(), ...params?.device };\n const autoTracking = getDefaultTrackingContext();\n const tracking = mergeTracking(autoTracking, params?.tracking);\n\n return super.init({\n timestamp: params?.timestamp,\n device,\n tracking,\n });\n }\n\n override async page(\n properties?: PageProperties,\n options?: Omit<TrackOptions, 'page'>,\n ): Promise<TrackEventData> {\n const pageContext = getPageContext();\n return super.page(\n {\n url: properties?.url ?? pageContext.url,\n referrer: properties?.referrer ?? pageContext.referrer,\n title: properties?.title ?? pageContext.title,\n },\n options,\n );\n }\n}\n\nexport function getDefaultTrackingContext(): TrackingContext {\n if (typeof document === 'undefined') {\n return {};\n }\n\n return parseTrackingFromCookies({\n cookieHeader: document.cookie,\n url: typeof window !== 'undefined' ? window.location.href : undefined,\n });\n}\n","import { createContext, useContext, useEffect, useMemo, type ReactNode } from 'react';\nimport type { DeviceInfo, TrackingContext, TrichiDataClientOptions } from '@trichidata/core';\nimport { TrichiDataClient } from '../client';\n\nconst TrichiDataContext = createContext<TrichiDataClient | null>(null);\n\nexport interface TrichiDataProviderProps extends TrichiDataClientOptions {\n children: ReactNode;\n autoInit?: boolean;\n device?: Partial<DeviceInfo>;\n tracking?: TrackingContext;\n}\n\nexport function TrichiDataProvider({\n children,\n autoInit = true,\n apiKey,\n device,\n tracking,\n}: TrichiDataProviderProps) {\n const client = useMemo(() => new TrichiDataClient({ apiKey }), [apiKey]);\n\n useEffect(() => {\n if (autoInit) {\n void client.init({ device, tracking });\n }\n }, [autoInit, client, device, tracking]);\n\n return <TrichiDataContext.Provider value={client}>{children}</TrichiDataContext.Provider>;\n}\n\nexport function useTrichiData(): TrichiDataClient {\n const client = useContext(TrichiDataContext);\n\n if (!client) {\n throw new Error('useTrichiData must be used within a TrichiDataProvider');\n }\n\n return client;\n}\n"]}
|
package/dist/index.d.cts
CHANGED
|
@@ -1,27 +1,33 @@
|
|
|
1
1
|
import * as react from 'react';
|
|
2
2
|
import { ReactNode } from 'react';
|
|
3
|
-
import {
|
|
4
|
-
export
|
|
5
|
-
export { API_PREFIX, DEFAULT_BASE_URL, HttpClient, SDK_VERSION, TrichiDataError as TrichiDataApiError, TrichiDataClient, TrichiDataError, createEventId, identify, initSdk, nowTimestamp, trackEvent, trackEventsBatch } from '@trichidata/core';
|
|
3
|
+
import { DeviceInfo, TrackingContext, TrichiDataClient as TrichiDataClient$1, TrichiDataClientOptions, InitSdkData, PageProperties, TrackOptions, TrackEventData } from '@trichidata/core';
|
|
4
|
+
export { AchievementUnlockedProperties, AdClickedProperties, AdImpressionProperties, AdType, CheckoutStartedProperties, DeviceInfo, IdentifyData, IdentifyRequest, InitSdkData, InitSdkParams, LeadSubmittedProperties, LevelAchievedProperties, LoggedInProperties, OrderCompletedProperties, OrderRefundedProperties, PageContext, PageProperties, PaymentInfoEnteredProperties, ProductAddedProperties, ProductItem, ProductRemovedProperties, ProductViewedProperties, SearchedProperties, SignedUpProperties, SpentCreditsProperties, TrackEventData, TrackOptions, TrackingContext, TrichiDataError as TrichiDataApiError, TrichiDataClientOptions, TrichiDataError, TutorialCompletedProperties } from '@trichidata/core';
|
|
6
5
|
|
|
7
|
-
interface
|
|
6
|
+
interface ReactInitParams {
|
|
7
|
+
timestamp?: number;
|
|
8
|
+
device?: Partial<DeviceInfo>;
|
|
9
|
+
tracking?: TrackingContext;
|
|
10
|
+
}
|
|
11
|
+
declare class TrichiDataClient extends TrichiDataClient$1 {
|
|
12
|
+
constructor(options: TrichiDataClientOptions);
|
|
13
|
+
init(params?: ReactInitParams): Promise<InitSdkData>;
|
|
14
|
+
page(properties?: PageProperties, options?: Omit<TrackOptions, 'page'>): Promise<TrackEventData>;
|
|
15
|
+
}
|
|
16
|
+
declare function getDefaultTrackingContext(): TrackingContext;
|
|
17
|
+
|
|
18
|
+
interface TrichiDataProviderProps extends TrichiDataClientOptions {
|
|
8
19
|
children: ReactNode;
|
|
9
20
|
autoInit?: boolean;
|
|
10
21
|
device?: Partial<DeviceInfo>;
|
|
22
|
+
tracking?: TrackingContext;
|
|
11
23
|
}
|
|
12
|
-
declare function TrichiDataProvider({ children, autoInit, apiKey,
|
|
24
|
+
declare function TrichiDataProvider({ children, autoInit, apiKey, device, tracking, }: TrichiDataProviderProps): react.JSX.Element;
|
|
13
25
|
declare function useTrichiData(): TrichiDataClient;
|
|
14
26
|
|
|
15
|
-
declare function getDefaultDeviceInfo(): {
|
|
16
|
-
ip: string;
|
|
17
|
-
userAgent: string;
|
|
18
|
-
locale: string;
|
|
19
|
-
timezone: string;
|
|
20
|
-
};
|
|
21
27
|
declare function getPageContext(): {
|
|
22
28
|
title?: string;
|
|
23
29
|
url?: string;
|
|
24
30
|
referrer?: string;
|
|
25
31
|
};
|
|
26
32
|
|
|
27
|
-
export { TrichiDataProvider, type TrichiDataProviderProps,
|
|
33
|
+
export { type ReactInitParams, TrichiDataClient, TrichiDataProvider, type TrichiDataProviderProps, getDefaultTrackingContext, getPageContext, useTrichiData };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,27 +1,33 @@
|
|
|
1
1
|
import * as react from 'react';
|
|
2
2
|
import { ReactNode } from 'react';
|
|
3
|
-
import {
|
|
4
|
-
export
|
|
5
|
-
export { API_PREFIX, DEFAULT_BASE_URL, HttpClient, SDK_VERSION, TrichiDataError as TrichiDataApiError, TrichiDataClient, TrichiDataError, createEventId, identify, initSdk, nowTimestamp, trackEvent, trackEventsBatch } from '@trichidata/core';
|
|
3
|
+
import { DeviceInfo, TrackingContext, TrichiDataClient as TrichiDataClient$1, TrichiDataClientOptions, InitSdkData, PageProperties, TrackOptions, TrackEventData } from '@trichidata/core';
|
|
4
|
+
export { AchievementUnlockedProperties, AdClickedProperties, AdImpressionProperties, AdType, CheckoutStartedProperties, DeviceInfo, IdentifyData, IdentifyRequest, InitSdkData, InitSdkParams, LeadSubmittedProperties, LevelAchievedProperties, LoggedInProperties, OrderCompletedProperties, OrderRefundedProperties, PageContext, PageProperties, PaymentInfoEnteredProperties, ProductAddedProperties, ProductItem, ProductRemovedProperties, ProductViewedProperties, SearchedProperties, SignedUpProperties, SpentCreditsProperties, TrackEventData, TrackOptions, TrackingContext, TrichiDataError as TrichiDataApiError, TrichiDataClientOptions, TrichiDataError, TutorialCompletedProperties } from '@trichidata/core';
|
|
6
5
|
|
|
7
|
-
interface
|
|
6
|
+
interface ReactInitParams {
|
|
7
|
+
timestamp?: number;
|
|
8
|
+
device?: Partial<DeviceInfo>;
|
|
9
|
+
tracking?: TrackingContext;
|
|
10
|
+
}
|
|
11
|
+
declare class TrichiDataClient extends TrichiDataClient$1 {
|
|
12
|
+
constructor(options: TrichiDataClientOptions);
|
|
13
|
+
init(params?: ReactInitParams): Promise<InitSdkData>;
|
|
14
|
+
page(properties?: PageProperties, options?: Omit<TrackOptions, 'page'>): Promise<TrackEventData>;
|
|
15
|
+
}
|
|
16
|
+
declare function getDefaultTrackingContext(): TrackingContext;
|
|
17
|
+
|
|
18
|
+
interface TrichiDataProviderProps extends TrichiDataClientOptions {
|
|
8
19
|
children: ReactNode;
|
|
9
20
|
autoInit?: boolean;
|
|
10
21
|
device?: Partial<DeviceInfo>;
|
|
22
|
+
tracking?: TrackingContext;
|
|
11
23
|
}
|
|
12
|
-
declare function TrichiDataProvider({ children, autoInit, apiKey,
|
|
24
|
+
declare function TrichiDataProvider({ children, autoInit, apiKey, device, tracking, }: TrichiDataProviderProps): react.JSX.Element;
|
|
13
25
|
declare function useTrichiData(): TrichiDataClient;
|
|
14
26
|
|
|
15
|
-
declare function getDefaultDeviceInfo(): {
|
|
16
|
-
ip: string;
|
|
17
|
-
userAgent: string;
|
|
18
|
-
locale: string;
|
|
19
|
-
timezone: string;
|
|
20
|
-
};
|
|
21
27
|
declare function getPageContext(): {
|
|
22
28
|
title?: string;
|
|
23
29
|
url?: string;
|
|
24
30
|
referrer?: string;
|
|
25
31
|
};
|
|
26
32
|
|
|
27
|
-
export { TrichiDataProvider, type TrichiDataProviderProps,
|
|
33
|
+
export { type ReactInitParams, TrichiDataClient, TrichiDataProvider, type TrichiDataProviderProps, getDefaultTrackingContext, getPageContext, useTrichiData };
|
package/dist/index.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { createContext, useMemo, useEffect, useContext } from 'react';
|
|
2
|
-
import { TrichiDataClient,
|
|
3
|
-
export {
|
|
2
|
+
import { TrichiDataClient as TrichiDataClient$1, mergeTracking, parseTrackingFromCookies } from '@trichidata/core';
|
|
3
|
+
export { TrichiDataError as TrichiDataApiError, TrichiDataError } from '@trichidata/core';
|
|
4
4
|
import { jsx } from 'react/jsx-runtime';
|
|
5
5
|
|
|
6
6
|
// src/react/TrichiDataProvider.tsx
|
|
@@ -24,27 +24,57 @@ function getPageContext() {
|
|
|
24
24
|
referrer: document.referrer || void 0
|
|
25
25
|
};
|
|
26
26
|
}
|
|
27
|
+
|
|
28
|
+
// src/client.ts
|
|
29
|
+
var TrichiDataClient = class extends TrichiDataClient$1 {
|
|
30
|
+
constructor(options) {
|
|
31
|
+
super({ ...options, sessionStrategy: "browser" });
|
|
32
|
+
}
|
|
33
|
+
async init(params) {
|
|
34
|
+
const device = { ...getDefaultDeviceInfo(), ...params?.device };
|
|
35
|
+
const autoTracking = getDefaultTrackingContext();
|
|
36
|
+
const tracking = mergeTracking(autoTracking, params?.tracking);
|
|
37
|
+
return super.init({
|
|
38
|
+
timestamp: params?.timestamp,
|
|
39
|
+
device,
|
|
40
|
+
tracking
|
|
41
|
+
});
|
|
42
|
+
}
|
|
43
|
+
async page(properties, options) {
|
|
44
|
+
const pageContext = getPageContext();
|
|
45
|
+
return super.page(
|
|
46
|
+
{
|
|
47
|
+
url: properties?.url ?? pageContext.url,
|
|
48
|
+
referrer: properties?.referrer ?? pageContext.referrer,
|
|
49
|
+
title: properties?.title ?? pageContext.title
|
|
50
|
+
},
|
|
51
|
+
options
|
|
52
|
+
);
|
|
53
|
+
}
|
|
54
|
+
};
|
|
55
|
+
function getDefaultTrackingContext() {
|
|
56
|
+
if (typeof document === "undefined") {
|
|
57
|
+
return {};
|
|
58
|
+
}
|
|
59
|
+
return parseTrackingFromCookies({
|
|
60
|
+
cookieHeader: document.cookie,
|
|
61
|
+
url: typeof window !== "undefined" ? window.location.href : void 0
|
|
62
|
+
});
|
|
63
|
+
}
|
|
27
64
|
var TrichiDataContext = createContext(null);
|
|
28
65
|
function TrichiDataProvider({
|
|
29
66
|
children,
|
|
30
67
|
autoInit = true,
|
|
31
68
|
apiKey,
|
|
32
|
-
|
|
33
|
-
|
|
69
|
+
device,
|
|
70
|
+
tracking
|
|
34
71
|
}) {
|
|
35
|
-
const client = useMemo(
|
|
36
|
-
() => new TrichiDataClient({ apiKey, baseUrl, sessionStrategy: "browser" }),
|
|
37
|
-
[apiKey, baseUrl]
|
|
38
|
-
);
|
|
72
|
+
const client = useMemo(() => new TrichiDataClient({ apiKey }), [apiKey]);
|
|
39
73
|
useEffect(() => {
|
|
40
74
|
if (autoInit) {
|
|
41
|
-
void client.init({
|
|
42
|
-
timestamp: Date.now(),
|
|
43
|
-
device: { ...getDefaultDeviceInfo(), ...device },
|
|
44
|
-
sdkVersion: SDK_VERSION
|
|
45
|
-
});
|
|
75
|
+
void client.init({ device, tracking });
|
|
46
76
|
}
|
|
47
|
-
}, [autoInit, client, device]);
|
|
77
|
+
}, [autoInit, client, device, tracking]);
|
|
48
78
|
return /* @__PURE__ */ jsx(TrichiDataContext.Provider, { value: client, children });
|
|
49
79
|
}
|
|
50
80
|
function useTrichiData() {
|
|
@@ -55,6 +85,6 @@ function useTrichiData() {
|
|
|
55
85
|
return client;
|
|
56
86
|
}
|
|
57
87
|
|
|
58
|
-
export { TrichiDataProvider,
|
|
88
|
+
export { TrichiDataClient, TrichiDataProvider, getDefaultTrackingContext, getPageContext, useTrichiData };
|
|
59
89
|
//# sourceMappingURL=index.js.map
|
|
60
90
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/utils.ts","../src/react/TrichiDataProvider.tsx"],"names":[],"mappings":";;;;;;;;AAAO,SAAS,oBAAA,GAKd;AACA,EAAA,OAAO;AAAA,IACL,EAAA,EAAI,SAAA;AAAA,IACJ,SAAA,EAAW,OAAO,SAAA,KAAc,WAAA,GAAc,UAAU,SAAA,GAAY,SAAA;AAAA,IACpE,MAAA,EAAQ,OAAO,SAAA,KAAc,WAAA,GAAc,UAAU,QAAA,GAAW,OAAA;AAAA,IAChE,QAAA,EACE,OAAO,IAAA,KAAS,WAAA,GAAc,KAAK,cAAA,EAAe,CAAE,eAAA,EAAgB,CAAE,QAAA,GAAW;AAAA,GACrF;AACF;AAEO,SAAS,cAAA,GAId;AACA,EAAA,IAAI,OAAO,QAAA,KAAa,WAAA,IAAe,OAAO,WAAW,WAAA,EAAa;AACpE,IAAA,OAAO,EAAC;AAAA,EACV;AAEA,EAAA,OAAO;AAAA,IACL,OAAO,QAAA,CAAS,KAAA;AAAA,IAChB,GAAA,EAAK,OAAO,QAAA,CAAS,IAAA;AAAA,IACrB,QAAA,EAAU,SAAS,QAAA,IAAY;AAAA,GACjC;AACF;
|
|
1
|
+
{"version":3,"sources":["../src/utils.ts","../src/client.ts","../src/react/TrichiDataProvider.tsx"],"names":["CoreClient"],"mappings":";;;;;;;;AAAO,SAAS,oBAAA,GAKd;AACA,EAAA,OAAO;AAAA,IACL,EAAA,EAAI,SAAA;AAAA,IACJ,SAAA,EAAW,OAAO,SAAA,KAAc,WAAA,GAAc,UAAU,SAAA,GAAY,SAAA;AAAA,IACpE,MAAA,EAAQ,OAAO,SAAA,KAAc,WAAA,GAAc,UAAU,QAAA,GAAW,OAAA;AAAA,IAChE,QAAA,EACE,OAAO,IAAA,KAAS,WAAA,GAAc,KAAK,cAAA,EAAe,CAAE,eAAA,EAAgB,CAAE,QAAA,GAAW;AAAA,GACrF;AACF;AAEO,SAAS,cAAA,GAId;AACA,EAAA,IAAI,OAAO,QAAA,KAAa,WAAA,IAAe,OAAO,WAAW,WAAA,EAAa;AACpE,IAAA,OAAO,EAAC;AAAA,EACV;AAEA,EAAA,OAAO;AAAA,IACL,OAAO,QAAA,CAAS,KAAA;AAAA,IAChB,GAAA,EAAK,OAAO,QAAA,CAAS,IAAA;AAAA,IACrB,QAAA,EAAU,SAAS,QAAA,IAAY;AAAA,GACjC;AACF;;;ACTO,IAAM,gBAAA,GAAN,cAA+BA,kBAAA,CAAW;AAAA,EAC/C,YAAY,OAAA,EAAkC;AAC5C,IAAA,KAAA,CAAM,EAAE,GAAG,OAAA,EAAS,eAAA,EAAiB,WAAW,CAAA;AAAA,EAClD;AAAA,EAEA,MAAM,KAAK,MAAA,EAAgD;AACzD,IAAA,MAAM,SAAS,EAAE,GAAG,sBAAqB,EAAG,GAAG,QAAQ,MAAA,EAAO;AAC9D,IAAA,MAAM,eAAe,yBAAA,EAA0B;AAC/C,IAAA,MAAM,QAAA,GAAW,aAAA,CAAc,YAAA,EAAc,MAAA,EAAQ,QAAQ,CAAA;AAE7D,IAAA,OAAO,MAAM,IAAA,CAAK;AAAA,MAChB,WAAW,MAAA,EAAQ,SAAA;AAAA,MACnB,MAAA;AAAA,MACA;AAAA,KACD,CAAA;AAAA,EACH;AAAA,EAEA,MAAe,IAAA,CACb,UAAA,EACA,OAAA,EACyB;AACzB,IAAA,MAAM,cAAc,cAAA,EAAe;AACnC,IAAA,OAAO,KAAA,CAAM,IAAA;AAAA,MACX;AAAA,QACE,GAAA,EAAK,UAAA,EAAY,GAAA,IAAO,WAAA,CAAY,GAAA;AAAA,QACpC,QAAA,EAAU,UAAA,EAAY,QAAA,IAAY,WAAA,CAAY,QAAA;AAAA,QAC9C,KAAA,EAAO,UAAA,EAAY,KAAA,IAAS,WAAA,CAAY;AAAA,OAC1C;AAAA,MACA;AAAA,KACF;AAAA,EACF;AACF;AAEO,SAAS,yBAAA,GAA6C;AAC3D,EAAA,IAAI,OAAO,aAAa,WAAA,EAAa;AACnC,IAAA,OAAO,EAAC;AAAA,EACV;AAEA,EAAA,OAAO,wBAAA,CAAyB;AAAA,IAC9B,cAAc,QAAA,CAAS,MAAA;AAAA,IACvB,KAAK,OAAO,MAAA,KAAW,WAAA,GAAc,MAAA,CAAO,SAAS,IAAA,GAAO;AAAA,GAC7D,CAAA;AACH;AC1DA,IAAM,iBAAA,GAAoB,cAAuC,IAAI,CAAA;AAS9D,SAAS,kBAAA,CAAmB;AAAA,EACjC,QAAA;AAAA,EACA,QAAA,GAAW,IAAA;AAAA,EACX,MAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAA,EAA4B;AAC1B,EAAA,MAAM,MAAA,GAAS,OAAA,CAAQ,MAAM,IAAI,gBAAA,CAAiB,EAAE,MAAA,EAAQ,CAAA,EAAG,CAAC,MAAM,CAAC,CAAA;AAEvE,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,IAAI,QAAA,EAAU;AACZ,MAAA,KAAK,MAAA,CAAO,IAAA,CAAK,EAAE,MAAA,EAAQ,UAAU,CAAA;AAAA,IACvC;AAAA,EACF,GAAG,CAAC,QAAA,EAAU,MAAA,EAAQ,MAAA,EAAQ,QAAQ,CAAC,CAAA;AAEvC,EAAA,2BAAQ,iBAAA,CAAkB,QAAA,EAAlB,EAA2B,KAAA,EAAO,QAAS,QAAA,EAAS,CAAA;AAC9D;AAEO,SAAS,aAAA,GAAkC;AAChD,EAAA,MAAM,MAAA,GAAS,WAAW,iBAAiB,CAAA;AAE3C,EAAA,IAAI,CAAC,MAAA,EAAQ;AACX,IAAA,MAAM,IAAI,MAAM,wDAAwD,CAAA;AAAA,EAC1E;AAEA,EAAA,OAAO,MAAA;AACT","file":"index.js","sourcesContent":["export function getDefaultDeviceInfo(): {\n ip: string;\n userAgent: string;\n locale: string;\n timezone: string;\n} {\n return {\n ip: '0.0.0.0',\n userAgent: typeof navigator !== 'undefined' ? navigator.userAgent : 'unknown',\n locale: typeof navigator !== 'undefined' ? navigator.language : 'en-US',\n timezone:\n typeof Intl !== 'undefined' ? Intl.DateTimeFormat().resolvedOptions().timeZone : 'UTC',\n };\n}\n\nexport function getPageContext(): {\n title?: string;\n url?: string;\n referrer?: string;\n} {\n if (typeof document === 'undefined' || typeof window === 'undefined') {\n return {};\n }\n\n return {\n title: document.title,\n url: window.location.href,\n referrer: document.referrer || undefined,\n };\n}\n","import {\n TrichiDataClient as CoreClient,\n mergeTracking,\n parseTrackingFromCookies,\n type DeviceInfo,\n type InitSdkData,\n type PageProperties,\n type TrackEventData,\n type TrackingContext,\n type TrackOptions,\n type TrichiDataClientOptions,\n} from '@trichidata/core';\nimport { getDefaultDeviceInfo, getPageContext } from './utils';\n\nexport interface ReactInitParams {\n timestamp?: number;\n device?: Partial<DeviceInfo>;\n tracking?: TrackingContext;\n}\n\nexport class TrichiDataClient extends CoreClient {\n constructor(options: TrichiDataClientOptions) {\n super({ ...options, sessionStrategy: 'browser' });\n }\n\n async init(params?: ReactInitParams): Promise<InitSdkData> {\n const device = { ...getDefaultDeviceInfo(), ...params?.device };\n const autoTracking = getDefaultTrackingContext();\n const tracking = mergeTracking(autoTracking, params?.tracking);\n\n return super.init({\n timestamp: params?.timestamp,\n device,\n tracking,\n });\n }\n\n override async page(\n properties?: PageProperties,\n options?: Omit<TrackOptions, 'page'>,\n ): Promise<TrackEventData> {\n const pageContext = getPageContext();\n return super.page(\n {\n url: properties?.url ?? pageContext.url,\n referrer: properties?.referrer ?? pageContext.referrer,\n title: properties?.title ?? pageContext.title,\n },\n options,\n );\n }\n}\n\nexport function getDefaultTrackingContext(): TrackingContext {\n if (typeof document === 'undefined') {\n return {};\n }\n\n return parseTrackingFromCookies({\n cookieHeader: document.cookie,\n url: typeof window !== 'undefined' ? window.location.href : undefined,\n });\n}\n","import { createContext, useContext, useEffect, useMemo, type ReactNode } from 'react';\nimport type { DeviceInfo, TrackingContext, TrichiDataClientOptions } from '@trichidata/core';\nimport { TrichiDataClient } from '../client';\n\nconst TrichiDataContext = createContext<TrichiDataClient | null>(null);\n\nexport interface TrichiDataProviderProps extends TrichiDataClientOptions {\n children: ReactNode;\n autoInit?: boolean;\n device?: Partial<DeviceInfo>;\n tracking?: TrackingContext;\n}\n\nexport function TrichiDataProvider({\n children,\n autoInit = true,\n apiKey,\n device,\n tracking,\n}: TrichiDataProviderProps) {\n const client = useMemo(() => new TrichiDataClient({ apiKey }), [apiKey]);\n\n useEffect(() => {\n if (autoInit) {\n void client.init({ device, tracking });\n }\n }, [autoInit, client, device, tracking]);\n\n return <TrichiDataContext.Provider value={client}>{children}</TrichiDataContext.Provider>;\n}\n\nexport function useTrichiData(): TrichiDataClient {\n const client = useContext(TrichiDataContext);\n\n if (!client) {\n throw new Error('useTrichiData must be used within a TrichiDataProvider');\n }\n\n return client;\n}\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@trichidata/react",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.5.2",
|
|
4
4
|
"description": "TrichiData analytics SDK for React",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.cjs",
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
"react": ">=18.0.0"
|
|
30
30
|
},
|
|
31
31
|
"dependencies": {
|
|
32
|
-
"@trichidata/core": "^0.
|
|
32
|
+
"@trichidata/core": "^0.5.1"
|
|
33
33
|
},
|
|
34
34
|
"devDependencies": {
|
|
35
35
|
"@eslint/js": "^9.28.0",
|