@flare-engine/analytics 0.4.6 → 0.4.8
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/dist/index.d.mts +6 -12
- package/dist/index.d.mts.map +1 -1
- package/dist/index.d.ts +6 -12
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +3 -6
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +3 -6
- package/dist/index.mjs.map +1 -1
- package/package.json +2 -2
package/dist/index.d.mts
CHANGED
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
//#region src/provider.d.ts
|
|
2
1
|
/** Free-form event properties — adapters serialize as needed. */
|
|
3
2
|
type AnalyticsProps = Record<string, unknown>;
|
|
4
3
|
/** A captured analytics event — the discriminated union the memory/console providers record. */
|
|
@@ -31,18 +30,14 @@ interface AnalyticsProvider {
|
|
|
31
30
|
flush(): Promise<void>;
|
|
32
31
|
}
|
|
33
32
|
/** Default no-op provider. Resolves immediately; retains nothing. */
|
|
34
|
-
declare const NoopAnalyticsProvider: AnalyticsProvider;
|
|
35
|
-
//#endregion
|
|
36
|
-
//#region src/context.d.ts
|
|
33
|
+
export declare const NoopAnalyticsProvider: AnalyticsProvider;
|
|
37
34
|
/**
|
|
38
35
|
* React context carrying the active `AnalyticsProvider`. Defaults to
|
|
39
36
|
* `NoopAnalyticsProvider`.
|
|
40
37
|
*/
|
|
41
|
-
declare const AnalyticsContext: import("react").Context<AnalyticsProvider>;
|
|
38
|
+
export declare const AnalyticsContext: import("react").Context<AnalyticsProvider>;
|
|
42
39
|
/** Hook returning the current `AnalyticsProvider`. */
|
|
43
|
-
declare function useAnalytics(): AnalyticsProvider;
|
|
44
|
-
//#endregion
|
|
45
|
-
//#region src/memory.d.ts
|
|
40
|
+
export declare function useAnalytics(): AnalyticsProvider;
|
|
46
41
|
/** Options for `createMemoryAnalytics`. */
|
|
47
42
|
interface MemoryAnalyticsOptions {
|
|
48
43
|
/** Ring-buffer capacity; clamped to >= 1. Defaults to 256. */
|
|
@@ -69,13 +64,12 @@ interface ConsoleAnalyticsOptions {
|
|
|
69
64
|
* Useful for tests and dev overlays. When the buffer is full the oldest
|
|
70
65
|
* event is dropped. `flush` is a no-op.
|
|
71
66
|
*/
|
|
72
|
-
declare function createMemoryAnalytics(opts?: MemoryAnalyticsOptions): MemoryAnalytics;
|
|
67
|
+
export declare function createMemoryAnalytics(opts?: MemoryAnalyticsOptions): MemoryAnalytics;
|
|
73
68
|
/**
|
|
74
69
|
* Create an analytics provider that logs each captured event to an injected
|
|
75
70
|
* sink (default `console.log`) as `log('[analytics]', event)`. `flush` is a
|
|
76
71
|
* no-op.
|
|
77
72
|
*/
|
|
78
|
-
declare function createConsoleAnalytics(opts?: ConsoleAnalyticsOptions): AnalyticsProvider;
|
|
79
|
-
|
|
80
|
-
export { AnalyticsContext, type AnalyticsEvent, type AnalyticsProps, type AnalyticsProvider, type ConsoleAnalyticsOptions, type MemoryAnalytics, type MemoryAnalyticsOptions, NoopAnalyticsProvider, createConsoleAnalytics, createMemoryAnalytics, useAnalytics };
|
|
73
|
+
export declare function createConsoleAnalytics(opts?: ConsoleAnalyticsOptions): AnalyticsProvider;
|
|
74
|
+
export type { AnalyticsEvent, AnalyticsProps, AnalyticsProvider, ConsoleAnalyticsOptions, MemoryAnalytics, MemoryAnalyticsOptions };
|
|
81
75
|
//# sourceMappingURL=index.d.mts.map
|
package/dist/index.d.mts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.mts","names":[],"sources":["../src/provider.ts","../src/context.ts","../src/memory.ts"],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.d.mts","names":[],"sources":["../src/provider.ts","../src/context.ts","../src/memory.ts"],"mappings":";KACY,iBAAiB;;KAGjB;WAEG;WACA;WACA,QAAQ;WACR;;WAGA;WACA;WACA,SAAS;WACT;;WAGA;WACA;WACA,QAAQ;WACR;;;;;;;;UASE;EACf,MAAM,eAAe,QAAQ,iBAAiB;EAC9C,SAAS,gBAAgB,SAAS,iBAAiB;EACnD,OAAO,cAAc,QAAQ,iBAAiB;EAC9C,SAAS;;;qBAIE,uBAAuB;;;;;qBC/BvB,kCAAgB,QAAA;;wBAGb,gBAAgB;;UCPf;;EAEf;;EAEA;;;UAIe,wBAAwB;;EAEvC,sBAAsB;;EAEtB;;;UAIe;;EAEf,UAAU;;EAEV;;;;;;;wBA0Bc,sBAAsB,OAAO,yBAAyB;;;;;;wBAqCtD,uBAAuB,OAAO,0BAA0B"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
//#region src/provider.d.ts
|
|
2
1
|
/** Free-form event properties — adapters serialize as needed. */
|
|
3
2
|
type AnalyticsProps = Record<string, unknown>;
|
|
4
3
|
/** A captured analytics event — the discriminated union the memory/console providers record. */
|
|
@@ -31,18 +30,14 @@ interface AnalyticsProvider {
|
|
|
31
30
|
flush(): Promise<void>;
|
|
32
31
|
}
|
|
33
32
|
/** Default no-op provider. Resolves immediately; retains nothing. */
|
|
34
|
-
declare const NoopAnalyticsProvider: AnalyticsProvider;
|
|
35
|
-
//#endregion
|
|
36
|
-
//#region src/context.d.ts
|
|
33
|
+
export declare const NoopAnalyticsProvider: AnalyticsProvider;
|
|
37
34
|
/**
|
|
38
35
|
* React context carrying the active `AnalyticsProvider`. Defaults to
|
|
39
36
|
* `NoopAnalyticsProvider`.
|
|
40
37
|
*/
|
|
41
|
-
declare const AnalyticsContext: import("react").Context<AnalyticsProvider>;
|
|
38
|
+
export declare const AnalyticsContext: import("react").Context<AnalyticsProvider>;
|
|
42
39
|
/** Hook returning the current `AnalyticsProvider`. */
|
|
43
|
-
declare function useAnalytics(): AnalyticsProvider;
|
|
44
|
-
//#endregion
|
|
45
|
-
//#region src/memory.d.ts
|
|
40
|
+
export declare function useAnalytics(): AnalyticsProvider;
|
|
46
41
|
/** Options for `createMemoryAnalytics`. */
|
|
47
42
|
interface MemoryAnalyticsOptions {
|
|
48
43
|
/** Ring-buffer capacity; clamped to >= 1. Defaults to 256. */
|
|
@@ -69,13 +64,12 @@ interface ConsoleAnalyticsOptions {
|
|
|
69
64
|
* Useful for tests and dev overlays. When the buffer is full the oldest
|
|
70
65
|
* event is dropped. `flush` is a no-op.
|
|
71
66
|
*/
|
|
72
|
-
declare function createMemoryAnalytics(opts?: MemoryAnalyticsOptions): MemoryAnalytics;
|
|
67
|
+
export declare function createMemoryAnalytics(opts?: MemoryAnalyticsOptions): MemoryAnalytics;
|
|
73
68
|
/**
|
|
74
69
|
* Create an analytics provider that logs each captured event to an injected
|
|
75
70
|
* sink (default `console.log`) as `log('[analytics]', event)`. `flush` is a
|
|
76
71
|
* no-op.
|
|
77
72
|
*/
|
|
78
|
-
declare function createConsoleAnalytics(opts?: ConsoleAnalyticsOptions): AnalyticsProvider;
|
|
79
|
-
|
|
80
|
-
export { AnalyticsContext, type AnalyticsEvent, type AnalyticsProps, type AnalyticsProvider, type ConsoleAnalyticsOptions, type MemoryAnalytics, type MemoryAnalyticsOptions, NoopAnalyticsProvider, createConsoleAnalytics, createMemoryAnalytics, useAnalytics };
|
|
73
|
+
export declare function createConsoleAnalytics(opts?: ConsoleAnalyticsOptions): AnalyticsProvider;
|
|
74
|
+
export type { AnalyticsEvent, AnalyticsProps, AnalyticsProvider, ConsoleAnalyticsOptions, MemoryAnalytics, MemoryAnalyticsOptions };
|
|
81
75
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","names":[],"sources":["../src/provider.ts","../src/context.ts","../src/memory.ts"],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.d.ts","names":[],"sources":["../src/provider.ts","../src/context.ts","../src/memory.ts"],"mappings":";KACY,iBAAiB;;KAGjB;WAEG;WACA;WACA,QAAQ;WACR;;WAGA;WACA;WACA,SAAS;WACT;;WAGA;WACA;WACA,QAAQ;WACR;;;;;;;;UASE;EACf,MAAM,eAAe,QAAQ,iBAAiB;EAC9C,SAAS,gBAAgB,SAAS,iBAAiB;EACnD,OAAO,cAAc,QAAQ,iBAAiB;EAC9C,SAAS;;;qBAIE,uBAAuB;;;;;qBC/BvB,kCAAgB,QAAA;;wBAGb,gBAAgB;;UCPf;;EAEf;;EAEA;;;UAIe,wBAAwB;;EAEvC,sBAAsB;;EAEtB;;;UAIe;;EAEf,UAAU;;EAEV;;;;;;;wBA0Bc,sBAAsB,OAAO,yBAAyB;;;;;;wBAqCtD,uBAAuB,OAAO,0BAA0B"}
|
package/dist/index.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
2
2
|
let react = require("react");
|
|
3
|
-
|
|
3
|
+
// src/provider.ts
|
|
4
4
|
/** Default no-op provider. Resolves immediately; retains nothing. */
|
|
5
5
|
const NoopAnalyticsProvider = {
|
|
6
6
|
async track() {},
|
|
@@ -8,8 +8,7 @@ const NoopAnalyticsProvider = {
|
|
|
8
8
|
async screen() {},
|
|
9
9
|
async flush() {}
|
|
10
10
|
};
|
|
11
|
-
|
|
12
|
-
//#region src/context.ts
|
|
11
|
+
// src/context.ts
|
|
13
12
|
/**
|
|
14
13
|
* React context carrying the active `AnalyticsProvider`. Defaults to
|
|
15
14
|
* `NoopAnalyticsProvider`.
|
|
@@ -19,8 +18,7 @@ const AnalyticsContext = (0, react.createContext)(NoopAnalyticsProvider);
|
|
|
19
18
|
function useAnalytics() {
|
|
20
19
|
return (0, react.useContext)(AnalyticsContext);
|
|
21
20
|
}
|
|
22
|
-
|
|
23
|
-
//#region src/memory.ts
|
|
21
|
+
// src/memory.ts
|
|
24
22
|
function trackEvent(name, timestamp, props) {
|
|
25
23
|
return props === void 0 ? {
|
|
26
24
|
type: "track",
|
|
@@ -110,7 +108,6 @@ function createConsoleAnalytics(opts) {
|
|
|
110
108
|
async flush() {}
|
|
111
109
|
};
|
|
112
110
|
}
|
|
113
|
-
//#endregion
|
|
114
111
|
exports.AnalyticsContext = AnalyticsContext;
|
|
115
112
|
exports.NoopAnalyticsProvider = NoopAnalyticsProvider;
|
|
116
113
|
exports.createConsoleAnalytics = createConsoleAnalytics;
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","names":[],"sources":["../src/provider.ts","../src/context.ts","../src/memory.ts"],"sourcesContent":["/** Free-form event properties — adapters serialize as needed. */\nexport type AnalyticsProps = Record<string, unknown>;\n\n/** A captured analytics event — the discriminated union the memory/console providers record. */\nexport type AnalyticsEvent =\n | {\n readonly type: 'track';\n readonly name: string;\n readonly props?: AnalyticsProps;\n readonly timestamp: number;\n }\n | {\n readonly type: 'identify';\n readonly userId: string;\n readonly traits?: AnalyticsProps;\n readonly timestamp: number;\n }\n | {\n readonly type: 'screen';\n readonly name: string;\n readonly props?: AnalyticsProps;\n readonly timestamp: number;\n };\n\n/**\n * Analytics provider interface. Consumers supply a concrete adapter (PostHog,\n * Amplitude, Segment, Firebase Analytics) at the app boundary. Batching,\n * sampling, and offline queueing are adapter concerns — the interface is\n * deliberately thin so any SDK can back it.\n */\nexport interface AnalyticsProvider {\n track(event: string, props?: AnalyticsProps): Promise<void>;\n identify(userId: string, traits?: AnalyticsProps): Promise<void>;\n screen(name: string, props?: AnalyticsProps): Promise<void>;\n flush(): Promise<void>;\n}\n\n/** Default no-op provider. Resolves immediately; retains nothing. */\nexport const NoopAnalyticsProvider: AnalyticsProvider = {\n async track(): Promise<void> {\n // no-op\n },\n async identify(): Promise<void> {\n // no-op\n },\n async screen(): Promise<void> {\n // no-op\n },\n async flush(): Promise<void> {\n // no-op\n },\n};\n","import { createContext, useContext } from 'react';\nimport { type AnalyticsProvider, NoopAnalyticsProvider } from './provider.js';\n\n/**\n * React context carrying the active `AnalyticsProvider`. Defaults to\n * `NoopAnalyticsProvider`.\n */\nexport const AnalyticsContext = createContext<AnalyticsProvider>(NoopAnalyticsProvider);\n\n/** Hook returning the current `AnalyticsProvider`. */\nexport function useAnalytics(): AnalyticsProvider {\n return useContext(AnalyticsContext);\n}\n","import type { AnalyticsEvent, AnalyticsProps, AnalyticsProvider } from './provider.js';\n\n/** Options for `createMemoryAnalytics`. */\nexport interface MemoryAnalyticsOptions {\n /** Ring-buffer capacity; clamped to >= 1. Defaults to 256. */\n capacity?: number;\n /** Timestamp source in unix ms. Defaults to `() => Date.now()`. */\n now?: () => number;\n}\n\n/** In-memory `AnalyticsProvider` that records events into a bounded ring buffer. */\nexport interface MemoryAnalytics extends AnalyticsProvider {\n /** Recorded events, oldest -> newest, as a defensive copy. */\n getEvents(): readonly AnalyticsEvent[];\n /** Drop all recorded events. */\n clear(): void;\n}\n\n/** Options for `createConsoleAnalytics`. */\nexport interface ConsoleAnalyticsOptions {\n /** Sink for captured events. Defaults to `console.log`. */\n log?: (...args: unknown[]) => void;\n /** Timestamp source in unix ms. Defaults to `() => Date.now()`. */\n now?: () => number;\n}\n\nfunction trackEvent(name: string, timestamp: number, props?: AnalyticsProps): AnalyticsEvent {\n return props === undefined\n ? { type: 'track', name, timestamp }\n : { type: 'track', name, props, timestamp };\n}\n\nfunction identifyEvent(userId: string, timestamp: number, traits?: AnalyticsProps): AnalyticsEvent {\n return traits === undefined\n ? { type: 'identify', userId, timestamp }\n : { type: 'identify', userId, traits, timestamp };\n}\n\nfunction screenEvent(name: string, timestamp: number, props?: AnalyticsProps): AnalyticsEvent {\n return props === undefined\n ? { type: 'screen', name, timestamp }\n : { type: 'screen', name, props, timestamp };\n}\n\n/**\n * Create an in-memory analytics provider backed by a bounded ring buffer.\n * Useful for tests and dev overlays. When the buffer is full the oldest\n * event is dropped. `flush` is a no-op.\n */\nexport function createMemoryAnalytics(opts?: MemoryAnalyticsOptions): MemoryAnalytics {\n const capacity = Math.max(1, opts?.capacity ?? 256);\n const now = opts?.now ?? ((): number => Date.now());\n let events: AnalyticsEvent[] = [];\n\n function push(event: AnalyticsEvent): void {\n events.push(event);\n if (events.length > capacity) events.shift();\n }\n\n return {\n async track(event: string, props?: AnalyticsProps): Promise<void> {\n push(trackEvent(event, now(), props));\n },\n async identify(userId: string, traits?: AnalyticsProps): Promise<void> {\n push(identifyEvent(userId, now(), traits));\n },\n async screen(name: string, props?: AnalyticsProps): Promise<void> {\n push(screenEvent(name, now(), props));\n },\n async flush(): Promise<void> {\n // no-op\n },\n getEvents(): readonly AnalyticsEvent[] {\n return events.slice();\n },\n clear(): void {\n events = [];\n },\n };\n}\n\n/**\n * Create an analytics provider that logs each captured event to an injected\n * sink (default `console.log`) as `log('[analytics]', event)`. `flush` is a\n * no-op.\n */\nexport function createConsoleAnalytics(opts?: ConsoleAnalyticsOptions): AnalyticsProvider {\n const log = opts?.log ?? console.log;\n const now = opts?.now ?? ((): number => Date.now());\n\n return {\n async track(event: string, props?: AnalyticsProps): Promise<void> {\n log('[analytics]', trackEvent(event, now(), props));\n },\n async identify(userId: string, traits?: AnalyticsProps): Promise<void> {\n log('[analytics]', identifyEvent(userId, now(), traits));\n },\n async screen(name: string, props?: AnalyticsProps): Promise<void> {\n log('[analytics]', screenEvent(name, now(), props));\n },\n async flush(): Promise<void> {\n // no-op\n },\n };\n}\n"],"mappings":";;;;AAsCA,MAAa,wBAA2C;CACtD,MAAM,QAAuB,CAE7B;CACA,MAAM,WAA0B,CAEhC;CACA,MAAM,SAAwB,CAE9B;CACA,MAAM,QAAuB,CAE7B;AACF
|
|
1
|
+
{"version":3,"file":"index.js","names":["createContext","useContext"],"sources":["../src/provider.ts","../src/context.ts","../src/memory.ts"],"sourcesContent":["/** Free-form event properties — adapters serialize as needed. */\nexport type AnalyticsProps = Record<string, unknown>;\n\n/** A captured analytics event — the discriminated union the memory/console providers record. */\nexport type AnalyticsEvent =\n | {\n readonly type: 'track';\n readonly name: string;\n readonly props?: AnalyticsProps;\n readonly timestamp: number;\n }\n | {\n readonly type: 'identify';\n readonly userId: string;\n readonly traits?: AnalyticsProps;\n readonly timestamp: number;\n }\n | {\n readonly type: 'screen';\n readonly name: string;\n readonly props?: AnalyticsProps;\n readonly timestamp: number;\n };\n\n/**\n * Analytics provider interface. Consumers supply a concrete adapter (PostHog,\n * Amplitude, Segment, Firebase Analytics) at the app boundary. Batching,\n * sampling, and offline queueing are adapter concerns — the interface is\n * deliberately thin so any SDK can back it.\n */\nexport interface AnalyticsProvider {\n track(event: string, props?: AnalyticsProps): Promise<void>;\n identify(userId: string, traits?: AnalyticsProps): Promise<void>;\n screen(name: string, props?: AnalyticsProps): Promise<void>;\n flush(): Promise<void>;\n}\n\n/** Default no-op provider. Resolves immediately; retains nothing. */\nexport const NoopAnalyticsProvider: AnalyticsProvider = {\n async track(): Promise<void> {\n // no-op\n },\n async identify(): Promise<void> {\n // no-op\n },\n async screen(): Promise<void> {\n // no-op\n },\n async flush(): Promise<void> {\n // no-op\n },\n};\n","import { createContext, useContext } from 'react';\nimport { type AnalyticsProvider, NoopAnalyticsProvider } from './provider.js';\n\n/**\n * React context carrying the active `AnalyticsProvider`. Defaults to\n * `NoopAnalyticsProvider`.\n */\nexport const AnalyticsContext = createContext<AnalyticsProvider>(NoopAnalyticsProvider);\n\n/** Hook returning the current `AnalyticsProvider`. */\nexport function useAnalytics(): AnalyticsProvider {\n return useContext(AnalyticsContext);\n}\n","import type { AnalyticsEvent, AnalyticsProps, AnalyticsProvider } from './provider.js';\n\n/** Options for `createMemoryAnalytics`. */\nexport interface MemoryAnalyticsOptions {\n /** Ring-buffer capacity; clamped to >= 1. Defaults to 256. */\n capacity?: number;\n /** Timestamp source in unix ms. Defaults to `() => Date.now()`. */\n now?: () => number;\n}\n\n/** In-memory `AnalyticsProvider` that records events into a bounded ring buffer. */\nexport interface MemoryAnalytics extends AnalyticsProvider {\n /** Recorded events, oldest -> newest, as a defensive copy. */\n getEvents(): readonly AnalyticsEvent[];\n /** Drop all recorded events. */\n clear(): void;\n}\n\n/** Options for `createConsoleAnalytics`. */\nexport interface ConsoleAnalyticsOptions {\n /** Sink for captured events. Defaults to `console.log`. */\n log?: (...args: unknown[]) => void;\n /** Timestamp source in unix ms. Defaults to `() => Date.now()`. */\n now?: () => number;\n}\n\nfunction trackEvent(name: string, timestamp: number, props?: AnalyticsProps): AnalyticsEvent {\n return props === undefined\n ? { type: 'track', name, timestamp }\n : { type: 'track', name, props, timestamp };\n}\n\nfunction identifyEvent(userId: string, timestamp: number, traits?: AnalyticsProps): AnalyticsEvent {\n return traits === undefined\n ? { type: 'identify', userId, timestamp }\n : { type: 'identify', userId, traits, timestamp };\n}\n\nfunction screenEvent(name: string, timestamp: number, props?: AnalyticsProps): AnalyticsEvent {\n return props === undefined\n ? { type: 'screen', name, timestamp }\n : { type: 'screen', name, props, timestamp };\n}\n\n/**\n * Create an in-memory analytics provider backed by a bounded ring buffer.\n * Useful for tests and dev overlays. When the buffer is full the oldest\n * event is dropped. `flush` is a no-op.\n */\nexport function createMemoryAnalytics(opts?: MemoryAnalyticsOptions): MemoryAnalytics {\n const capacity = Math.max(1, opts?.capacity ?? 256);\n const now = opts?.now ?? ((): number => Date.now());\n let events: AnalyticsEvent[] = [];\n\n function push(event: AnalyticsEvent): void {\n events.push(event);\n if (events.length > capacity) events.shift();\n }\n\n return {\n async track(event: string, props?: AnalyticsProps): Promise<void> {\n push(trackEvent(event, now(), props));\n },\n async identify(userId: string, traits?: AnalyticsProps): Promise<void> {\n push(identifyEvent(userId, now(), traits));\n },\n async screen(name: string, props?: AnalyticsProps): Promise<void> {\n push(screenEvent(name, now(), props));\n },\n async flush(): Promise<void> {\n // no-op\n },\n getEvents(): readonly AnalyticsEvent[] {\n return events.slice();\n },\n clear(): void {\n events = [];\n },\n };\n}\n\n/**\n * Create an analytics provider that logs each captured event to an injected\n * sink (default `console.log`) as `log('[analytics]', event)`. `flush` is a\n * no-op.\n */\nexport function createConsoleAnalytics(opts?: ConsoleAnalyticsOptions): AnalyticsProvider {\n const log = opts?.log ?? console.log;\n const now = opts?.now ?? ((): number => Date.now());\n\n return {\n async track(event: string, props?: AnalyticsProps): Promise<void> {\n log('[analytics]', trackEvent(event, now(), props));\n },\n async identify(userId: string, traits?: AnalyticsProps): Promise<void> {\n log('[analytics]', identifyEvent(userId, now(), traits));\n },\n async screen(name: string, props?: AnalyticsProps): Promise<void> {\n log('[analytics]', screenEvent(name, now(), props));\n },\n async flush(): Promise<void> {\n // no-op\n },\n };\n}\n"],"mappings":";;;;AAsCA,MAAa,wBAA2C;CACtD,MAAM,QAAuB,CAE7B;CACA,MAAM,WAA0B,CAEhC;CACA,MAAM,SAAwB,CAE9B;CACA,MAAM,QAAuB,CAE7B;AACF;;;;;;AC5CA,MAAa,oBAAA,GAAmBA,MAAAA,cAAAA,CAAiC,qBAAqB;;AAGtF,SAAgB,eAAkC;CAChD,QAAA,GAAOC,MAAAA,WAAAA,CAAW,gBAAgB;AACpC;;ACcA,SAAS,WAAW,MAAc,WAAmB,OAAwC;CAC3F,OAAO,UAAU,KAAA,IACb;EAAE,MAAM;EAAS;EAAM;CAAU,IACjC;EAAE,MAAM;EAAS;EAAM;EAAO;CAAU;AAC9C;AAEA,SAAS,cAAc,QAAgB,WAAmB,QAAyC;CACjG,OAAO,WAAW,KAAA,IACd;EAAE,MAAM;EAAY;EAAQ;CAAU,IACtC;EAAE,MAAM;EAAY;EAAQ;EAAQ;CAAU;AACpD;AAEA,SAAS,YAAY,MAAc,WAAmB,OAAwC;CAC5F,OAAO,UAAU,KAAA,IACb;EAAE,MAAM;EAAU;EAAM;CAAU,IAClC;EAAE,MAAM;EAAU;EAAM;EAAO;CAAU;AAC/C;;;;;;AAOA,SAAgB,sBAAsB,MAAgD;CACpF,MAAM,WAAW,KAAK,IAAI,GAAG,MAAM,YAAY,GAAG;CAClD,MAAM,MAAM,MAAM,cAAsB,KAAK,IAAI;CACjD,IAAI,SAA2B,CAAC;CAEhC,SAAS,KAAK,OAA6B;EACzC,OAAO,KAAK,KAAK;EACjB,IAAI,OAAO,SAAS,UAAU,OAAO,MAAM;CAC7C;CAEA,OAAO;EACL,MAAM,MAAM,OAAe,OAAuC;GAChE,KAAK,WAAW,OAAO,IAAI,GAAG,KAAK,CAAC;EACtC;EACA,MAAM,SAAS,QAAgB,QAAwC;GACrE,KAAK,cAAc,QAAQ,IAAI,GAAG,MAAM,CAAC;EAC3C;EACA,MAAM,OAAO,MAAc,OAAuC;GAChE,KAAK,YAAY,MAAM,IAAI,GAAG,KAAK,CAAC;EACtC;EACA,MAAM,QAAuB,CAE7B;EACA,YAAuC;GACrC,OAAO,OAAO,MAAM;EACtB;EACA,QAAc;GACZ,SAAS,CAAC;EACZ;CACF;AACF;;;;;;AAOA,SAAgB,uBAAuB,MAAmD;CACxF,MAAM,MAAM,MAAM,OAAO,QAAQ;CACjC,MAAM,MAAM,MAAM,cAAsB,KAAK,IAAI;CAEjD,OAAO;EACL,MAAM,MAAM,OAAe,OAAuC;GAChE,IAAI,eAAe,WAAW,OAAO,IAAI,GAAG,KAAK,CAAC;EACpD;EACA,MAAM,SAAS,QAAgB,QAAwC;GACrE,IAAI,eAAe,cAAc,QAAQ,IAAI,GAAG,MAAM,CAAC;EACzD;EACA,MAAM,OAAO,MAAc,OAAuC;GAChE,IAAI,eAAe,YAAY,MAAM,IAAI,GAAG,KAAK,CAAC;EACpD;EACA,MAAM,QAAuB,CAE7B;CACF;AACF"}
|
package/dist/index.mjs
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { createContext, useContext } from "react";
|
|
2
|
-
|
|
2
|
+
// src/provider.ts
|
|
3
3
|
/** Default no-op provider. Resolves immediately; retains nothing. */
|
|
4
4
|
const NoopAnalyticsProvider = {
|
|
5
5
|
async track() {},
|
|
@@ -7,8 +7,7 @@ const NoopAnalyticsProvider = {
|
|
|
7
7
|
async screen() {},
|
|
8
8
|
async flush() {}
|
|
9
9
|
};
|
|
10
|
-
|
|
11
|
-
//#region src/context.ts
|
|
10
|
+
// src/context.ts
|
|
12
11
|
/**
|
|
13
12
|
* React context carrying the active `AnalyticsProvider`. Defaults to
|
|
14
13
|
* `NoopAnalyticsProvider`.
|
|
@@ -18,8 +17,7 @@ const AnalyticsContext = createContext(NoopAnalyticsProvider);
|
|
|
18
17
|
function useAnalytics() {
|
|
19
18
|
return useContext(AnalyticsContext);
|
|
20
19
|
}
|
|
21
|
-
|
|
22
|
-
//#region src/memory.ts
|
|
20
|
+
// src/memory.ts
|
|
23
21
|
function trackEvent(name, timestamp, props) {
|
|
24
22
|
return props === void 0 ? {
|
|
25
23
|
type: "track",
|
|
@@ -109,7 +107,6 @@ function createConsoleAnalytics(opts) {
|
|
|
109
107
|
async flush() {}
|
|
110
108
|
};
|
|
111
109
|
}
|
|
112
|
-
//#endregion
|
|
113
110
|
export { AnalyticsContext, NoopAnalyticsProvider, createConsoleAnalytics, createMemoryAnalytics, useAnalytics };
|
|
114
111
|
|
|
115
112
|
//# sourceMappingURL=index.mjs.map
|
package/dist/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","names":[],"sources":["../src/provider.ts","../src/context.ts","../src/memory.ts"],"sourcesContent":["/** Free-form event properties — adapters serialize as needed. */\nexport type AnalyticsProps = Record<string, unknown>;\n\n/** A captured analytics event — the discriminated union the memory/console providers record. */\nexport type AnalyticsEvent =\n | {\n readonly type: 'track';\n readonly name: string;\n readonly props?: AnalyticsProps;\n readonly timestamp: number;\n }\n | {\n readonly type: 'identify';\n readonly userId: string;\n readonly traits?: AnalyticsProps;\n readonly timestamp: number;\n }\n | {\n readonly type: 'screen';\n readonly name: string;\n readonly props?: AnalyticsProps;\n readonly timestamp: number;\n };\n\n/**\n * Analytics provider interface. Consumers supply a concrete adapter (PostHog,\n * Amplitude, Segment, Firebase Analytics) at the app boundary. Batching,\n * sampling, and offline queueing are adapter concerns — the interface is\n * deliberately thin so any SDK can back it.\n */\nexport interface AnalyticsProvider {\n track(event: string, props?: AnalyticsProps): Promise<void>;\n identify(userId: string, traits?: AnalyticsProps): Promise<void>;\n screen(name: string, props?: AnalyticsProps): Promise<void>;\n flush(): Promise<void>;\n}\n\n/** Default no-op provider. Resolves immediately; retains nothing. */\nexport const NoopAnalyticsProvider: AnalyticsProvider = {\n async track(): Promise<void> {\n // no-op\n },\n async identify(): Promise<void> {\n // no-op\n },\n async screen(): Promise<void> {\n // no-op\n },\n async flush(): Promise<void> {\n // no-op\n },\n};\n","import { createContext, useContext } from 'react';\nimport { type AnalyticsProvider, NoopAnalyticsProvider } from './provider.js';\n\n/**\n * React context carrying the active `AnalyticsProvider`. Defaults to\n * `NoopAnalyticsProvider`.\n */\nexport const AnalyticsContext = createContext<AnalyticsProvider>(NoopAnalyticsProvider);\n\n/** Hook returning the current `AnalyticsProvider`. */\nexport function useAnalytics(): AnalyticsProvider {\n return useContext(AnalyticsContext);\n}\n","import type { AnalyticsEvent, AnalyticsProps, AnalyticsProvider } from './provider.js';\n\n/** Options for `createMemoryAnalytics`. */\nexport interface MemoryAnalyticsOptions {\n /** Ring-buffer capacity; clamped to >= 1. Defaults to 256. */\n capacity?: number;\n /** Timestamp source in unix ms. Defaults to `() => Date.now()`. */\n now?: () => number;\n}\n\n/** In-memory `AnalyticsProvider` that records events into a bounded ring buffer. */\nexport interface MemoryAnalytics extends AnalyticsProvider {\n /** Recorded events, oldest -> newest, as a defensive copy. */\n getEvents(): readonly AnalyticsEvent[];\n /** Drop all recorded events. */\n clear(): void;\n}\n\n/** Options for `createConsoleAnalytics`. */\nexport interface ConsoleAnalyticsOptions {\n /** Sink for captured events. Defaults to `console.log`. */\n log?: (...args: unknown[]) => void;\n /** Timestamp source in unix ms. Defaults to `() => Date.now()`. */\n now?: () => number;\n}\n\nfunction trackEvent(name: string, timestamp: number, props?: AnalyticsProps): AnalyticsEvent {\n return props === undefined\n ? { type: 'track', name, timestamp }\n : { type: 'track', name, props, timestamp };\n}\n\nfunction identifyEvent(userId: string, timestamp: number, traits?: AnalyticsProps): AnalyticsEvent {\n return traits === undefined\n ? { type: 'identify', userId, timestamp }\n : { type: 'identify', userId, traits, timestamp };\n}\n\nfunction screenEvent(name: string, timestamp: number, props?: AnalyticsProps): AnalyticsEvent {\n return props === undefined\n ? { type: 'screen', name, timestamp }\n : { type: 'screen', name, props, timestamp };\n}\n\n/**\n * Create an in-memory analytics provider backed by a bounded ring buffer.\n * Useful for tests and dev overlays. When the buffer is full the oldest\n * event is dropped. `flush` is a no-op.\n */\nexport function createMemoryAnalytics(opts?: MemoryAnalyticsOptions): MemoryAnalytics {\n const capacity = Math.max(1, opts?.capacity ?? 256);\n const now = opts?.now ?? ((): number => Date.now());\n let events: AnalyticsEvent[] = [];\n\n function push(event: AnalyticsEvent): void {\n events.push(event);\n if (events.length > capacity) events.shift();\n }\n\n return {\n async track(event: string, props?: AnalyticsProps): Promise<void> {\n push(trackEvent(event, now(), props));\n },\n async identify(userId: string, traits?: AnalyticsProps): Promise<void> {\n push(identifyEvent(userId, now(), traits));\n },\n async screen(name: string, props?: AnalyticsProps): Promise<void> {\n push(screenEvent(name, now(), props));\n },\n async flush(): Promise<void> {\n // no-op\n },\n getEvents(): readonly AnalyticsEvent[] {\n return events.slice();\n },\n clear(): void {\n events = [];\n },\n };\n}\n\n/**\n * Create an analytics provider that logs each captured event to an injected\n * sink (default `console.log`) as `log('[analytics]', event)`. `flush` is a\n * no-op.\n */\nexport function createConsoleAnalytics(opts?: ConsoleAnalyticsOptions): AnalyticsProvider {\n const log = opts?.log ?? console.log;\n const now = opts?.now ?? ((): number => Date.now());\n\n return {\n async track(event: string, props?: AnalyticsProps): Promise<void> {\n log('[analytics]', trackEvent(event, now(), props));\n },\n async identify(userId: string, traits?: AnalyticsProps): Promise<void> {\n log('[analytics]', identifyEvent(userId, now(), traits));\n },\n async screen(name: string, props?: AnalyticsProps): Promise<void> {\n log('[analytics]', screenEvent(name, now(), props));\n },\n async flush(): Promise<void> {\n // no-op\n },\n };\n}\n"],"mappings":";;;AAsCA,MAAa,wBAA2C;CACtD,MAAM,QAAuB,CAE7B;CACA,MAAM,WAA0B,CAEhC;CACA,MAAM,SAAwB,CAE9B;CACA,MAAM,QAAuB,CAE7B;AACF
|
|
1
|
+
{"version":3,"file":"index.mjs","names":[],"sources":["../src/provider.ts","../src/context.ts","../src/memory.ts"],"sourcesContent":["/** Free-form event properties — adapters serialize as needed. */\nexport type AnalyticsProps = Record<string, unknown>;\n\n/** A captured analytics event — the discriminated union the memory/console providers record. */\nexport type AnalyticsEvent =\n | {\n readonly type: 'track';\n readonly name: string;\n readonly props?: AnalyticsProps;\n readonly timestamp: number;\n }\n | {\n readonly type: 'identify';\n readonly userId: string;\n readonly traits?: AnalyticsProps;\n readonly timestamp: number;\n }\n | {\n readonly type: 'screen';\n readonly name: string;\n readonly props?: AnalyticsProps;\n readonly timestamp: number;\n };\n\n/**\n * Analytics provider interface. Consumers supply a concrete adapter (PostHog,\n * Amplitude, Segment, Firebase Analytics) at the app boundary. Batching,\n * sampling, and offline queueing are adapter concerns — the interface is\n * deliberately thin so any SDK can back it.\n */\nexport interface AnalyticsProvider {\n track(event: string, props?: AnalyticsProps): Promise<void>;\n identify(userId: string, traits?: AnalyticsProps): Promise<void>;\n screen(name: string, props?: AnalyticsProps): Promise<void>;\n flush(): Promise<void>;\n}\n\n/** Default no-op provider. Resolves immediately; retains nothing. */\nexport const NoopAnalyticsProvider: AnalyticsProvider = {\n async track(): Promise<void> {\n // no-op\n },\n async identify(): Promise<void> {\n // no-op\n },\n async screen(): Promise<void> {\n // no-op\n },\n async flush(): Promise<void> {\n // no-op\n },\n};\n","import { createContext, useContext } from 'react';\nimport { type AnalyticsProvider, NoopAnalyticsProvider } from './provider.js';\n\n/**\n * React context carrying the active `AnalyticsProvider`. Defaults to\n * `NoopAnalyticsProvider`.\n */\nexport const AnalyticsContext = createContext<AnalyticsProvider>(NoopAnalyticsProvider);\n\n/** Hook returning the current `AnalyticsProvider`. */\nexport function useAnalytics(): AnalyticsProvider {\n return useContext(AnalyticsContext);\n}\n","import type { AnalyticsEvent, AnalyticsProps, AnalyticsProvider } from './provider.js';\n\n/** Options for `createMemoryAnalytics`. */\nexport interface MemoryAnalyticsOptions {\n /** Ring-buffer capacity; clamped to >= 1. Defaults to 256. */\n capacity?: number;\n /** Timestamp source in unix ms. Defaults to `() => Date.now()`. */\n now?: () => number;\n}\n\n/** In-memory `AnalyticsProvider` that records events into a bounded ring buffer. */\nexport interface MemoryAnalytics extends AnalyticsProvider {\n /** Recorded events, oldest -> newest, as a defensive copy. */\n getEvents(): readonly AnalyticsEvent[];\n /** Drop all recorded events. */\n clear(): void;\n}\n\n/** Options for `createConsoleAnalytics`. */\nexport interface ConsoleAnalyticsOptions {\n /** Sink for captured events. Defaults to `console.log`. */\n log?: (...args: unknown[]) => void;\n /** Timestamp source in unix ms. Defaults to `() => Date.now()`. */\n now?: () => number;\n}\n\nfunction trackEvent(name: string, timestamp: number, props?: AnalyticsProps): AnalyticsEvent {\n return props === undefined\n ? { type: 'track', name, timestamp }\n : { type: 'track', name, props, timestamp };\n}\n\nfunction identifyEvent(userId: string, timestamp: number, traits?: AnalyticsProps): AnalyticsEvent {\n return traits === undefined\n ? { type: 'identify', userId, timestamp }\n : { type: 'identify', userId, traits, timestamp };\n}\n\nfunction screenEvent(name: string, timestamp: number, props?: AnalyticsProps): AnalyticsEvent {\n return props === undefined\n ? { type: 'screen', name, timestamp }\n : { type: 'screen', name, props, timestamp };\n}\n\n/**\n * Create an in-memory analytics provider backed by a bounded ring buffer.\n * Useful for tests and dev overlays. When the buffer is full the oldest\n * event is dropped. `flush` is a no-op.\n */\nexport function createMemoryAnalytics(opts?: MemoryAnalyticsOptions): MemoryAnalytics {\n const capacity = Math.max(1, opts?.capacity ?? 256);\n const now = opts?.now ?? ((): number => Date.now());\n let events: AnalyticsEvent[] = [];\n\n function push(event: AnalyticsEvent): void {\n events.push(event);\n if (events.length > capacity) events.shift();\n }\n\n return {\n async track(event: string, props?: AnalyticsProps): Promise<void> {\n push(trackEvent(event, now(), props));\n },\n async identify(userId: string, traits?: AnalyticsProps): Promise<void> {\n push(identifyEvent(userId, now(), traits));\n },\n async screen(name: string, props?: AnalyticsProps): Promise<void> {\n push(screenEvent(name, now(), props));\n },\n async flush(): Promise<void> {\n // no-op\n },\n getEvents(): readonly AnalyticsEvent[] {\n return events.slice();\n },\n clear(): void {\n events = [];\n },\n };\n}\n\n/**\n * Create an analytics provider that logs each captured event to an injected\n * sink (default `console.log`) as `log('[analytics]', event)`. `flush` is a\n * no-op.\n */\nexport function createConsoleAnalytics(opts?: ConsoleAnalyticsOptions): AnalyticsProvider {\n const log = opts?.log ?? console.log;\n const now = opts?.now ?? ((): number => Date.now());\n\n return {\n async track(event: string, props?: AnalyticsProps): Promise<void> {\n log('[analytics]', trackEvent(event, now(), props));\n },\n async identify(userId: string, traits?: AnalyticsProps): Promise<void> {\n log('[analytics]', identifyEvent(userId, now(), traits));\n },\n async screen(name: string, props?: AnalyticsProps): Promise<void> {\n log('[analytics]', screenEvent(name, now(), props));\n },\n async flush(): Promise<void> {\n // no-op\n },\n };\n}\n"],"mappings":";;;AAsCA,MAAa,wBAA2C;CACtD,MAAM,QAAuB,CAE7B;CACA,MAAM,WAA0B,CAEhC;CACA,MAAM,SAAwB,CAE9B;CACA,MAAM,QAAuB,CAE7B;AACF;;;;;;AC5CA,MAAa,mBAAmB,cAAiC,qBAAqB;;AAGtF,SAAgB,eAAkC;CAChD,OAAO,WAAW,gBAAgB;AACpC;;ACcA,SAAS,WAAW,MAAc,WAAmB,OAAwC;CAC3F,OAAO,UAAU,KAAA,IACb;EAAE,MAAM;EAAS;EAAM;CAAU,IACjC;EAAE,MAAM;EAAS;EAAM;EAAO;CAAU;AAC9C;AAEA,SAAS,cAAc,QAAgB,WAAmB,QAAyC;CACjG,OAAO,WAAW,KAAA,IACd;EAAE,MAAM;EAAY;EAAQ;CAAU,IACtC;EAAE,MAAM;EAAY;EAAQ;EAAQ;CAAU;AACpD;AAEA,SAAS,YAAY,MAAc,WAAmB,OAAwC;CAC5F,OAAO,UAAU,KAAA,IACb;EAAE,MAAM;EAAU;EAAM;CAAU,IAClC;EAAE,MAAM;EAAU;EAAM;EAAO;CAAU;AAC/C;;;;;;AAOA,SAAgB,sBAAsB,MAAgD;CACpF,MAAM,WAAW,KAAK,IAAI,GAAG,MAAM,YAAY,GAAG;CAClD,MAAM,MAAM,MAAM,cAAsB,KAAK,IAAI;CACjD,IAAI,SAA2B,CAAC;CAEhC,SAAS,KAAK,OAA6B;EACzC,OAAO,KAAK,KAAK;EACjB,IAAI,OAAO,SAAS,UAAU,OAAO,MAAM;CAC7C;CAEA,OAAO;EACL,MAAM,MAAM,OAAe,OAAuC;GAChE,KAAK,WAAW,OAAO,IAAI,GAAG,KAAK,CAAC;EACtC;EACA,MAAM,SAAS,QAAgB,QAAwC;GACrE,KAAK,cAAc,QAAQ,IAAI,GAAG,MAAM,CAAC;EAC3C;EACA,MAAM,OAAO,MAAc,OAAuC;GAChE,KAAK,YAAY,MAAM,IAAI,GAAG,KAAK,CAAC;EACtC;EACA,MAAM,QAAuB,CAE7B;EACA,YAAuC;GACrC,OAAO,OAAO,MAAM;EACtB;EACA,QAAc;GACZ,SAAS,CAAC;EACZ;CACF;AACF;;;;;;AAOA,SAAgB,uBAAuB,MAAmD;CACxF,MAAM,MAAM,MAAM,OAAO,QAAQ;CACjC,MAAM,MAAM,MAAM,cAAsB,KAAK,IAAI;CAEjD,OAAO;EACL,MAAM,MAAM,OAAe,OAAuC;GAChE,IAAI,eAAe,WAAW,OAAO,IAAI,GAAG,KAAK,CAAC;EACpD;EACA,MAAM,SAAS,QAAgB,QAAwC;GACrE,IAAI,eAAe,cAAc,QAAQ,IAAI,GAAG,MAAM,CAAC;EACzD;EACA,MAAM,OAAO,MAAc,OAAuC;GAChE,IAAI,eAAe,YAAY,MAAM,IAAI,GAAG,KAAK,CAAC;EACpD;EACA,MAAM,QAAuB,CAE7B;CACF;AACF"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@flare-engine/analytics",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.8",
|
|
4
4
|
"description": "Analytics provider interface (consumer-supplied adapter)",
|
|
5
5
|
"keywords": ["flare-engine", "analytics", "provider", "interface"],
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -37,7 +37,7 @@
|
|
|
37
37
|
"typecheck": "tsc --noEmit"
|
|
38
38
|
},
|
|
39
39
|
"devDependencies": {
|
|
40
|
-
"@types/react": "^19.
|
|
40
|
+
"@types/react": "^19.3.0"
|
|
41
41
|
},
|
|
42
42
|
"peerDependencies": {
|
|
43
43
|
"react": ">=19.0.0"
|