@happyvertical/analytics 0.74.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/AGENT.md +33 -0
- package/LICENSE +7 -0
- package/dist/chunks/ga4-6gyDPZRn.js +863 -0
- package/dist/chunks/ga4-6gyDPZRn.js.map +1 -0
- package/dist/chunks/matomo-Ds_oRmZ6.js +1043 -0
- package/dist/chunks/matomo-Ds_oRmZ6.js.map +1 -0
- package/dist/chunks/plausible-BxpNa6qF.js +479 -0
- package/dist/chunks/plausible-BxpNa6qF.js.map +1 -0
- package/dist/cli/claude-context.d.ts +3 -0
- package/dist/cli/claude-context.d.ts.map +1 -0
- package/dist/cli/claude-context.js +21 -0
- package/dist/cli/claude-context.js.map +1 -0
- package/dist/index.d.ts +37 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +135 -0
- package/dist/index.js.map +1 -0
- package/dist/shared/factory.d.ts +48 -0
- package/dist/shared/factory.d.ts.map +1 -0
- package/dist/shared/providers/ga4.d.ts +68 -0
- package/dist/shared/providers/ga4.d.ts.map +1 -0
- package/dist/shared/providers/matomo-admin.d.ts +56 -0
- package/dist/shared/providers/matomo-admin.d.ts.map +1 -0
- package/dist/shared/providers/matomo.d.ts +49 -0
- package/dist/shared/providers/matomo.d.ts.map +1 -0
- package/dist/shared/providers/plausible.d.ts +50 -0
- package/dist/shared/providers/plausible.d.ts.map +1 -0
- package/dist/shared/types.d.ts +1235 -0
- package/dist/shared/types.d.ts.map +1 -0
- package/metadata.json +30 -0
- package/package.json +57 -0
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
import { AnalyticsCapabilities, AnalyticsInterface, ConfigOptions, CreateDataStreamOptions, CreatePropertyOptions, CustomDimension, CustomDimensionOptions, CustomMetric, CustomMetricOptions, DataStream, DimensionMetadata, KeyEvent, KeyEventOptions, ListPropertiesOptions, MatomoOptions, MetricMetadata, PageviewEvent, Property, RealtimeReportOptions, ReportOptions, ReportResult, SnippetOptions, TrackEvent, TrackingSnippet, UpdatePropertyOptions } from '../types.js';
|
|
2
|
+
import { MatomoAdmin } from './matomo-admin.js';
|
|
3
|
+
export declare class MatomoProvider implements AnalyticsInterface {
|
|
4
|
+
private readonly baseUrl;
|
|
5
|
+
private readonly reportingTransport;
|
|
6
|
+
readonly admin: MatomoAdmin;
|
|
7
|
+
constructor(options: MatomoOptions);
|
|
8
|
+
createProperty(_options: CreatePropertyOptions): Promise<Property>;
|
|
9
|
+
listProperties(_options?: ListPropertiesOptions): Promise<Property[]>;
|
|
10
|
+
getProperty(propertyId: string): Promise<Property>;
|
|
11
|
+
updateProperty(_propertyId: string, _data: UpdatePropertyOptions): Promise<Property>;
|
|
12
|
+
deleteProperty(propertyId: string): Promise<void>;
|
|
13
|
+
getCapabilities(): Promise<AnalyticsCapabilities>;
|
|
14
|
+
/**
|
|
15
|
+
* Generate a Matomo `_paq` tracking snippet.
|
|
16
|
+
*
|
|
17
|
+
* Note on `SnippetOptions.anonymizeIp`: Matomo handles IP anonymization
|
|
18
|
+
* **server-side** via the PrivacyManager plugin (Matomo admin → Privacy →
|
|
19
|
+
* Anonymize visitors' IP addresses). The JS tracker has no equivalent
|
|
20
|
+
* client-side directive — `setDoNotTrack` respects the browser's DNT
|
|
21
|
+
* signal but does not anonymize IPs, so we deliberately do not emit it
|
|
22
|
+
* here. The flag is preserved on the returned `config` object as a
|
|
23
|
+
* caller-visible signal, but its enforcement is the operator's
|
|
24
|
+
* responsibility on the Matomo install.
|
|
25
|
+
*/
|
|
26
|
+
generateTrackingSnippet(propertyId: string, options?: SnippetOptions): TrackingSnippet;
|
|
27
|
+
generateConfig(propertyId: string, options?: ConfigOptions): Record<string, unknown>;
|
|
28
|
+
getDataStreams(_propertyId: string): Promise<DataStream[]>;
|
|
29
|
+
createDataStream(_propertyId: string, _options: CreateDataStreamOptions): Promise<DataStream>;
|
|
30
|
+
deleteDataStream(_propertyId: string, _streamId: string): Promise<void>;
|
|
31
|
+
getCustomDimensions(_propertyId: string): Promise<CustomDimension[]>;
|
|
32
|
+
createCustomDimension(_propertyId: string, _options: CustomDimensionOptions): Promise<CustomDimension>;
|
|
33
|
+
archiveCustomDimension(_propertyId: string, _dimensionId: string): Promise<void>;
|
|
34
|
+
getCustomMetrics(_propertyId: string): Promise<CustomMetric[]>;
|
|
35
|
+
createCustomMetric(_propertyId: string, _options: CustomMetricOptions): Promise<CustomMetric>;
|
|
36
|
+
archiveCustomMetric(_propertyId: string, _metricId: string): Promise<void>;
|
|
37
|
+
getKeyEvents(_propertyId: string): Promise<KeyEvent[]>;
|
|
38
|
+
createKeyEvent(_propertyId: string, _options: KeyEventOptions): Promise<KeyEvent>;
|
|
39
|
+
deleteKeyEvent(_propertyId: string, _eventId: string): Promise<void>;
|
|
40
|
+
runReport(propertyId: string, options: ReportOptions): Promise<ReportResult>;
|
|
41
|
+
runRealtimeReport(propertyId: string, options?: RealtimeReportOptions): Promise<ReportResult>;
|
|
42
|
+
getMetrics(_propertyId: string): Promise<MetricMetadata[]>;
|
|
43
|
+
getDimensions(_propertyId: string): Promise<DimensionMetadata[]>;
|
|
44
|
+
track(_event: TrackEvent): Promise<void>;
|
|
45
|
+
trackPageview(_pageview: PageviewEvent): Promise<void>;
|
|
46
|
+
trackBatch(_events: TrackEvent[]): Promise<void>;
|
|
47
|
+
identify(_userId: string, _traits?: Record<string, unknown>): Promise<void>;
|
|
48
|
+
}
|
|
49
|
+
//# sourceMappingURL=matomo.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"matomo.d.ts","sourceRoot":"","sources":["../../../src/shared/providers/matomo.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,EACL,KAAK,qBAAqB,EAC1B,KAAK,kBAAkB,EACvB,KAAK,aAAa,EAClB,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,eAAe,EACpB,KAAK,sBAAsB,EAC3B,KAAK,YAAY,EACjB,KAAK,mBAAmB,EACxB,KAAK,UAAU,EACf,KAAK,iBAAiB,EACtB,KAAK,QAAQ,EACb,KAAK,eAAe,EACpB,KAAK,qBAAqB,EAC1B,KAAK,aAAa,EAClB,KAAK,cAAc,EAEnB,KAAK,aAAa,EAClB,KAAK,QAAQ,EAEb,KAAK,qBAAqB,EAC1B,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,UAAU,EACf,KAAK,eAAe,EACpB,KAAK,qBAAqB,EAC3B,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,WAAW,EAGZ,MAAM,mBAAmB,CAAC;AAI3B,qBAAa,cAAe,YAAW,kBAAkB;IACvD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAuB;IAC1D,SAAgB,KAAK,EAAE,WAAW,CAAC;gBAEvB,OAAO,EAAE,aAAa;IAkBlC,cAAc,CAAC,QAAQ,EAAE,qBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAU5D,cAAc,CAAC,QAAQ,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAKrE,WAAW,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAQlD,cAAc,CAClB,WAAW,EAAE,MAAM,EACnB,KAAK,EAAE,qBAAqB,GAC3B,OAAO,CAAC,QAAQ,CAAC;IAOd,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQjD,eAAe,IAAI,OAAO,CAAC,qBAAqB,CAAC;IAoBvD;;;;;;;;;;;OAWG;IACH,uBAAuB,CACrB,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE,cAAmB,GAC3B,eAAe;IAsClB,cAAc,CACZ,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE,aAAkB,GAC1B,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAiB1B,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAG1D,gBAAgB,CACd,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,uBAAuB,GAChC,OAAO,CAAC,UAAU,CAAC;IAGtB,gBAAgB,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAGvE,mBAAmB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAGpE,qBAAqB,CACnB,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,sBAAsB,GAC/B,OAAO,CAAC,eAAe,CAAC;IAG3B,sBAAsB,CACpB,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,IAAI,CAAC;IAGhB,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAG9D,kBAAkB,CAChB,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,mBAAmB,GAC5B,OAAO,CAAC,YAAY,CAAC;IAGxB,mBAAmB,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAG1E,YAAY,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAGtD,cAAc,CACZ,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,eAAe,GACxB,OAAO,CAAC,QAAQ,CAAC;IAGpB,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAG9D,SAAS,CACb,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,aAAa,GACrB,OAAO,CAAC,YAAY,CAAC;IAyClB,iBAAiB,CACrB,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE,qBAA0B,GAClC,OAAO,CAAC,YAAY,CAAC;IA4DxB,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAG1D,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAGhE,KAAK,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAGxC,aAAa,CAAC,SAAS,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAGtD,UAAU,CAAC,OAAO,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAGhD,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CAG5E"}
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
import { AnalyticsCapabilities, AnalyticsInterface, ConfigOptions, CreateDataStreamOptions, CreatePropertyOptions, CustomDimension, CustomDimensionOptions, CustomMetric, CustomMetricOptions, DataStream, DimensionMetadata, KeyEvent, KeyEventOptions, ListPropertiesOptions, MetricMetadata, PageviewEvent, PlausibleOptions, Property, RealtimeReportOptions, ReportOptions, ReportResult, SnippetOptions, TrackEvent, TrackingSnippet, UpdatePropertyOptions } from '../types.js';
|
|
2
|
+
/**
|
|
3
|
+
* Plausible Analytics provider
|
|
4
|
+
*/
|
|
5
|
+
export declare class PlausibleProvider implements AnalyticsInterface {
|
|
6
|
+
private options;
|
|
7
|
+
private baseUrl;
|
|
8
|
+
constructor(options: PlausibleOptions);
|
|
9
|
+
/**
|
|
10
|
+
* Make an authenticated API request
|
|
11
|
+
*/
|
|
12
|
+
private request;
|
|
13
|
+
createProperty(options: CreatePropertyOptions): Promise<Property>;
|
|
14
|
+
listProperties(_options?: ListPropertiesOptions): Promise<Property[]>;
|
|
15
|
+
getProperty(propertyId: string): Promise<Property>;
|
|
16
|
+
updateProperty(_propertyId: string, _data: UpdatePropertyOptions): Promise<Property>;
|
|
17
|
+
deleteProperty(propertyId: string): Promise<void>;
|
|
18
|
+
getDataStreams(_propertyId: string): Promise<DataStream[]>;
|
|
19
|
+
createDataStream(_propertyId: string, _options: CreateDataStreamOptions): Promise<DataStream>;
|
|
20
|
+
deleteDataStream(_propertyId: string, _streamId: string): Promise<void>;
|
|
21
|
+
getCustomDimensions(_propertyId: string): Promise<CustomDimension[]>;
|
|
22
|
+
createCustomDimension(_propertyId: string, _options: CustomDimensionOptions): Promise<CustomDimension>;
|
|
23
|
+
archiveCustomDimension(_propertyId: string, _dimensionId: string): Promise<void>;
|
|
24
|
+
getCustomMetrics(_propertyId: string): Promise<CustomMetric[]>;
|
|
25
|
+
createCustomMetric(_propertyId: string, _options: CustomMetricOptions): Promise<CustomMetric>;
|
|
26
|
+
archiveCustomMetric(_propertyId: string, _metricId: string): Promise<void>;
|
|
27
|
+
getKeyEvents(_propertyId: string): Promise<KeyEvent[]>;
|
|
28
|
+
createKeyEvent(propertyId: string, options: KeyEventOptions): Promise<KeyEvent>;
|
|
29
|
+
deleteKeyEvent(propertyId: string, eventId: string): Promise<void>;
|
|
30
|
+
runReport(propertyId: string, options: ReportOptions): Promise<ReportResult>;
|
|
31
|
+
runRealtimeReport(propertyId: string, _options?: RealtimeReportOptions): Promise<ReportResult>;
|
|
32
|
+
getMetrics(_propertyId: string): Promise<MetricMetadata[]>;
|
|
33
|
+
getDimensions(_propertyId: string): Promise<DimensionMetadata[]>;
|
|
34
|
+
/**
|
|
35
|
+
* Map GA4-style metric names to Plausible format
|
|
36
|
+
*/
|
|
37
|
+
private mapMetricName;
|
|
38
|
+
/**
|
|
39
|
+
* Map GA4-style dimension names to Plausible format
|
|
40
|
+
*/
|
|
41
|
+
private mapDimensionName;
|
|
42
|
+
track(event: TrackEvent): Promise<void>;
|
|
43
|
+
trackPageview(pageview: PageviewEvent): Promise<void>;
|
|
44
|
+
trackBatch(events: TrackEvent[]): Promise<void>;
|
|
45
|
+
identify(_userId: string, _traits?: Record<string, unknown>): Promise<void>;
|
|
46
|
+
generateTrackingSnippet(propertyId: string, _options?: SnippetOptions): TrackingSnippet;
|
|
47
|
+
generateConfig(propertyId: string, _options?: ConfigOptions): Record<string, unknown>;
|
|
48
|
+
getCapabilities(): Promise<AnalyticsCapabilities>;
|
|
49
|
+
}
|
|
50
|
+
//# sourceMappingURL=plausible.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"plausible.d.ts","sourceRoot":"","sources":["../../../src/shared/providers/plausible.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EACV,qBAAqB,EACrB,kBAAkB,EAClB,aAAa,EACb,uBAAuB,EACvB,qBAAqB,EACrB,eAAe,EACf,sBAAsB,EACtB,YAAY,EACZ,mBAAmB,EACnB,UAAU,EACV,iBAAiB,EACjB,QAAQ,EACR,eAAe,EACf,qBAAqB,EACrB,cAAc,EACd,aAAa,EACb,gBAAgB,EAChB,QAAQ,EACR,qBAAqB,EACrB,aAAa,EACb,YAAY,EACZ,cAAc,EACd,UAAU,EACV,eAAe,EACf,qBAAqB,EACtB,MAAM,aAAa,CAAC;AAcrB;;GAEG;AACH,qBAAa,iBAAkB,YAAW,kBAAkB;IAC1D,OAAO,CAAC,OAAO,CAAmB;IAClC,OAAO,CAAC,OAAO,CAAS;gBAEZ,OAAO,EAAE,gBAAgB;IAUrC;;OAEG;YACW,OAAO;IAoEf,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC;IA0BjE,cAAc,CAAC,QAAQ,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAMrE,WAAW,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAWlD,cAAc,CAClB,WAAW,EAAE,MAAM,EACnB,KAAK,EAAE,qBAAqB,GAC3B,OAAO,CAAC,QAAQ,CAAC;IAKd,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAUjD,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAI1D,gBAAgB,CACpB,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,uBAAuB,GAChC,OAAO,CAAC,UAAU,CAAC;IAIhB,gBAAgB,CACpB,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,IAAI,CAAC;IAQV,mBAAmB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAIpE,qBAAqB,CACzB,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,sBAAsB,GAC/B,OAAO,CAAC,eAAe,CAAC;IAIrB,sBAAsB,CAC1B,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,IAAI,CAAC;IAIV,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAI9D,kBAAkB,CACtB,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,mBAAmB,GAC5B,OAAO,CAAC,YAAY,CAAC;IAIlB,mBAAmB,CACvB,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,IAAI,CAAC;IAQV,YAAY,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAItD,cAAc,CAClB,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,eAAe,GACvB,OAAO,CAAC,QAAQ,CAAC;IA2Bd,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAUlE,SAAS,CACb,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,aAAa,GACrB,OAAO,CAAC,YAAY,CAAC;IAkFlB,iBAAiB,CACrB,UAAU,EAAE,MAAM,EAClB,QAAQ,CAAC,EAAE,qBAAqB,GAC/B,OAAO,CAAC,YAAY,CAAC;IAsBlB,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAgD1D,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IA6DtE;;OAEG;IACH,OAAO,CAAC,aAAa;IAarB;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAoBlB,KAAK,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IA2BvC,aAAa,CAAC,QAAQ,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IA0BrD,UAAU,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAO/C,QAAQ,CACZ,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAChC,OAAO,CAAC,IAAI,CAAC;IAShB,uBAAuB,CACrB,UAAU,EAAE,MAAM,EAClB,QAAQ,CAAC,EAAE,cAAc,GACxB,eAAe;IAuBlB,cAAc,CACZ,UAAU,EAAE,MAAM,EAClB,QAAQ,CAAC,EAAE,aAAa,GACvB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAWpB,eAAe,IAAI,OAAO,CAAC,qBAAqB,CAAC;CAexD"}
|