@contractspec/example.analytics-dashboard 1.57.0 → 1.58.0

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.
Files changed (173) hide show
  1. package/dist/browser/dashboard/dashboard.enum.js +34 -0
  2. package/dist/browser/dashboard/dashboard.operation.js +289 -0
  3. package/dist/browser/dashboard/dashboard.presentation.js +197 -0
  4. package/dist/browser/dashboard/dashboard.schema.js +126 -0
  5. package/dist/browser/dashboard/dashboard.test-spec.js +213 -0
  6. package/dist/browser/dashboard/index.js +299 -0
  7. package/dist/browser/dashboard.feature.js +84 -0
  8. package/dist/browser/datasource/posthog-datasource.js +289 -0
  9. package/dist/browser/docs/analytics-dashboard.docblock.js +103 -0
  10. package/dist/browser/docs/index.js +103 -0
  11. package/dist/browser/events.js +81 -0
  12. package/dist/browser/example.js +42 -0
  13. package/dist/browser/handlers/analytics.handlers.js +278 -0
  14. package/dist/browser/handlers/index.js +571 -0
  15. package/dist/browser/handlers/query.handlers.js +294 -0
  16. package/dist/browser/index.js +1677 -0
  17. package/dist/browser/query/index.js +159 -0
  18. package/dist/browser/query/query.enum.js +11 -0
  19. package/dist/browser/query/query.operation.js +154 -0
  20. package/dist/browser/query/query.presentation.js +119 -0
  21. package/dist/browser/query/query.schema.js +70 -0
  22. package/dist/browser/query/query.test-spec.js +113 -0
  23. package/dist/browser/query-engine/index.js +491 -0
  24. package/dist/browser/seeders/index.js +20 -0
  25. package/dist/browser/ui/AnalyticsDashboard.js +394 -0
  26. package/dist/browser/ui/hooks/index.js +69 -0
  27. package/dist/browser/ui/hooks/useAnalyticsData.js +66 -0
  28. package/dist/browser/ui/index.js +671 -0
  29. package/dist/browser/ui/renderers/analytics.markdown.js +275 -0
  30. package/dist/browser/ui/renderers/index.js +275 -0
  31. package/dist/dashboard/dashboard.enum.d.ts +3 -8
  32. package/dist/dashboard/dashboard.enum.d.ts.map +1 -1
  33. package/dist/dashboard/dashboard.enum.js +31 -39
  34. package/dist/dashboard/dashboard.operation.d.ts +444 -450
  35. package/dist/dashboard/dashboard.operation.d.ts.map +1 -1
  36. package/dist/dashboard/dashboard.operation.js +284 -207
  37. package/dist/dashboard/dashboard.presentation.d.ts +3 -8
  38. package/dist/dashboard/dashboard.presentation.d.ts.map +1 -1
  39. package/dist/dashboard/dashboard.presentation.js +193 -85
  40. package/dist/dashboard/dashboard.schema.d.ts +289 -294
  41. package/dist/dashboard/dashboard.schema.d.ts.map +1 -1
  42. package/dist/dashboard/dashboard.schema.js +119 -228
  43. package/dist/dashboard/dashboard.test-spec.d.ts +4 -9
  44. package/dist/dashboard/dashboard.test-spec.d.ts.map +1 -1
  45. package/dist/dashboard/dashboard.test-spec.js +209 -228
  46. package/dist/dashboard/index.d.ts +7 -4
  47. package/dist/dashboard/index.d.ts.map +1 -0
  48. package/dist/dashboard/index.js +299 -4
  49. package/dist/dashboard.feature.d.ts +1 -6
  50. package/dist/dashboard.feature.d.ts.map +1 -1
  51. package/dist/dashboard.feature.js +83 -175
  52. package/dist/datasource/posthog-datasource.d.ts +15 -19
  53. package/dist/datasource/posthog-datasource.d.ts.map +1 -1
  54. package/dist/datasource/posthog-datasource.js +274 -238
  55. package/dist/docs/analytics-dashboard.docblock.d.ts +2 -1
  56. package/dist/docs/analytics-dashboard.docblock.d.ts.map +1 -0
  57. package/dist/docs/analytics-dashboard.docblock.js +45 -56
  58. package/dist/docs/index.d.ts +2 -1
  59. package/dist/docs/index.d.ts.map +1 -0
  60. package/dist/docs/index.js +104 -1
  61. package/dist/events.d.ts +109 -115
  62. package/dist/events.d.ts.map +1 -1
  63. package/dist/events.js +74 -120
  64. package/dist/example.d.ts +2 -6
  65. package/dist/example.d.ts.map +1 -1
  66. package/dist/example.js +41 -55
  67. package/dist/handlers/analytics.handlers.d.ts +110 -109
  68. package/dist/handlers/analytics.handlers.d.ts.map +1 -1
  69. package/dist/handlers/analytics.handlers.js +267 -298
  70. package/dist/handlers/index.d.ts +3 -3
  71. package/dist/handlers/index.d.ts.map +1 -0
  72. package/dist/handlers/index.js +571 -3
  73. package/dist/handlers/query.handlers.d.ts +7 -11
  74. package/dist/handlers/query.handlers.d.ts.map +1 -1
  75. package/dist/handlers/query.handlers.js +292 -7
  76. package/dist/index.d.ts +12 -13
  77. package/dist/index.d.ts.map +1 -0
  78. package/dist/index.js +1678 -14
  79. package/dist/node/dashboard/dashboard.enum.js +34 -0
  80. package/dist/node/dashboard/dashboard.operation.js +289 -0
  81. package/dist/node/dashboard/dashboard.presentation.js +197 -0
  82. package/dist/node/dashboard/dashboard.schema.js +126 -0
  83. package/dist/node/dashboard/dashboard.test-spec.js +213 -0
  84. package/dist/node/dashboard/index.js +299 -0
  85. package/dist/node/dashboard.feature.js +84 -0
  86. package/dist/node/datasource/posthog-datasource.js +289 -0
  87. package/dist/node/docs/analytics-dashboard.docblock.js +103 -0
  88. package/dist/node/docs/index.js +103 -0
  89. package/dist/node/events.js +81 -0
  90. package/dist/node/example.js +42 -0
  91. package/dist/node/handlers/analytics.handlers.js +278 -0
  92. package/dist/node/handlers/index.js +571 -0
  93. package/dist/node/handlers/query.handlers.js +294 -0
  94. package/dist/node/index.js +1677 -0
  95. package/dist/node/query/index.js +159 -0
  96. package/dist/node/query/query.enum.js +11 -0
  97. package/dist/node/query/query.operation.js +154 -0
  98. package/dist/node/query/query.presentation.js +119 -0
  99. package/dist/node/query/query.schema.js +70 -0
  100. package/dist/node/query/query.test-spec.js +113 -0
  101. package/dist/node/query-engine/index.js +491 -0
  102. package/dist/node/seeders/index.js +20 -0
  103. package/dist/node/ui/AnalyticsDashboard.js +394 -0
  104. package/dist/node/ui/hooks/index.js +69 -0
  105. package/dist/node/ui/hooks/useAnalyticsData.js +66 -0
  106. package/dist/node/ui/index.js +671 -0
  107. package/dist/node/ui/renderers/analytics.markdown.js +275 -0
  108. package/dist/node/ui/renderers/index.js +275 -0
  109. package/dist/query/index.d.ts +7 -4
  110. package/dist/query/index.d.ts.map +1 -0
  111. package/dist/query/index.js +159 -4
  112. package/dist/query/query.enum.d.ts +1 -6
  113. package/dist/query/query.enum.d.ts.map +1 -1
  114. package/dist/query/query.enum.js +10 -14
  115. package/dist/query/query.operation.d.ts +148 -154
  116. package/dist/query/query.operation.d.ts.map +1 -1
  117. package/dist/query/query.operation.js +151 -109
  118. package/dist/query/query.presentation.d.ts +2 -7
  119. package/dist/query/query.presentation.d.ts.map +1 -1
  120. package/dist/query/query.presentation.js +116 -56
  121. package/dist/query/query.schema.d.ts +121 -126
  122. package/dist/query/query.schema.d.ts.map +1 -1
  123. package/dist/query/query.schema.js +66 -152
  124. package/dist/query/query.test-spec.d.ts +2 -7
  125. package/dist/query/query.test-spec.d.ts.map +1 -1
  126. package/dist/query/query.test-spec.js +111 -121
  127. package/dist/query-engine/index.d.ts +84 -88
  128. package/dist/query-engine/index.d.ts.map +1 -1
  129. package/dist/query-engine/index.js +489 -188
  130. package/dist/seeders/index.d.ts +4 -8
  131. package/dist/seeders/index.d.ts.map +1 -1
  132. package/dist/seeders/index.js +18 -16
  133. package/dist/ui/AnalyticsDashboard.d.ts +1 -6
  134. package/dist/ui/AnalyticsDashboard.d.ts.map +1 -1
  135. package/dist/ui/AnalyticsDashboard.js +389 -259
  136. package/dist/ui/hooks/index.d.ts +2 -2
  137. package/dist/ui/hooks/index.d.ts.map +1 -0
  138. package/dist/ui/hooks/index.js +69 -4
  139. package/dist/ui/hooks/useAnalyticsData.d.ts +16 -20
  140. package/dist/ui/hooks/useAnalyticsData.d.ts.map +1 -1
  141. package/dist/ui/hooks/useAnalyticsData.js +63 -69
  142. package/dist/ui/index.d.ts +7 -6
  143. package/dist/ui/index.d.ts.map +1 -0
  144. package/dist/ui/index.js +671 -5
  145. package/dist/ui/renderers/analytics.markdown.d.ts +13 -14
  146. package/dist/ui/renderers/analytics.markdown.d.ts.map +1 -1
  147. package/dist/ui/renderers/analytics.markdown.js +266 -254
  148. package/dist/ui/renderers/index.d.ts +2 -2
  149. package/dist/ui/renderers/index.d.ts.map +1 -0
  150. package/dist/ui/renderers/index.js +275 -2
  151. package/package.json +328 -67
  152. package/dist/dashboard/dashboard.enum.js.map +0 -1
  153. package/dist/dashboard/dashboard.operation.js.map +0 -1
  154. package/dist/dashboard/dashboard.presentation.js.map +0 -1
  155. package/dist/dashboard/dashboard.schema.js.map +0 -1
  156. package/dist/dashboard/dashboard.test-spec.js.map +0 -1
  157. package/dist/dashboard.feature.js.map +0 -1
  158. package/dist/datasource/posthog-datasource.js.map +0 -1
  159. package/dist/docs/analytics-dashboard.docblock.js.map +0 -1
  160. package/dist/events.js.map +0 -1
  161. package/dist/example.js.map +0 -1
  162. package/dist/handlers/analytics.handlers.js.map +0 -1
  163. package/dist/handlers/query.handlers.js.map +0 -1
  164. package/dist/query/query.enum.js.map +0 -1
  165. package/dist/query/query.operation.js.map +0 -1
  166. package/dist/query/query.presentation.js.map +0 -1
  167. package/dist/query/query.schema.js.map +0 -1
  168. package/dist/query/query.test-spec.js.map +0 -1
  169. package/dist/query-engine/index.js.map +0 -1
  170. package/dist/seeders/index.js.map +0 -1
  171. package/dist/ui/AnalyticsDashboard.js.map +0 -1
  172. package/dist/ui/hooks/useAnalyticsData.js.map +0 -1
  173. package/dist/ui/renderers/analytics.markdown.js.map +0 -1
@@ -0,0 +1,294 @@
1
+ // src/datasource/posthog-datasource.ts
2
+ class PosthogQueryEngine {
3
+ reader;
4
+ defaultLimit;
5
+ constructor(reader, options = {}) {
6
+ this.reader = reader;
7
+ this.defaultLimit = options.defaultLimit ?? 100;
8
+ }
9
+ async execute(definition, params) {
10
+ const startTime = Date.now();
11
+ const validation = this.validateQuery(definition);
12
+ if (!validation.valid) {
13
+ return {
14
+ data: [],
15
+ columns: [],
16
+ rowCount: 0,
17
+ executionTimeMs: Date.now() - startTime,
18
+ cached: false,
19
+ error: validation.errors.join(", ")
20
+ };
21
+ }
22
+ if (!this.reader.queryHogQL) {
23
+ return {
24
+ data: [],
25
+ columns: [],
26
+ rowCount: 0,
27
+ executionTimeMs: Date.now() - startTime,
28
+ cached: false,
29
+ error: "Analytics reader does not support HogQL queries."
30
+ };
31
+ }
32
+ try {
33
+ const result = await this.executeHogQL(definition, params);
34
+ return {
35
+ data: result.data,
36
+ columns: result.columns,
37
+ rowCount: result.rowCount,
38
+ executionTimeMs: Date.now() - startTime,
39
+ cached: false
40
+ };
41
+ } catch (error) {
42
+ return {
43
+ data: [],
44
+ columns: [],
45
+ rowCount: 0,
46
+ executionTimeMs: Date.now() - startTime,
47
+ cached: false,
48
+ error: error instanceof Error ? error.message : "Unknown error"
49
+ };
50
+ }
51
+ }
52
+ validateQuery(definition) {
53
+ const errors = [];
54
+ if (definition.type === "SQL" && !definition.sql) {
55
+ errors.push("SQL query is missing.");
56
+ }
57
+ if (definition.type === "AGGREGATION" && !definition.aggregation) {
58
+ errors.push("Aggregation definition is missing.");
59
+ }
60
+ if (definition.type === "METRIC" && !definition.metricIds?.length) {
61
+ errors.push("Metric IDs are missing.");
62
+ }
63
+ if (definition.type === "CUSTOM" && !definition.custom?.handler) {
64
+ errors.push("Custom handler is missing.");
65
+ }
66
+ return { valid: errors.length === 0, errors };
67
+ }
68
+ async executeHogQL(definition, params) {
69
+ if (!this.reader.queryHogQL) {
70
+ throw new Error("Analytics reader does not support HogQL queries.");
71
+ }
72
+ if (definition.type === "SQL") {
73
+ const result = await this.reader.queryHogQL({
74
+ query: definition.sql ?? "",
75
+ values: params.parameters ?? {}
76
+ });
77
+ return mapHogqlResult(result);
78
+ }
79
+ if (definition.type === "AGGREGATION" && definition.aggregation) {
80
+ const { query, values } = buildAggregationQuery(definition.aggregation, params);
81
+ const result = await this.reader.queryHogQL({ query, values });
82
+ return mapHogqlResult(result);
83
+ }
84
+ if (definition.type === "METRIC" && definition.metricIds) {
85
+ const { query, values } = buildMetricQuery(definition.metricIds, params);
86
+ const result = await this.reader.queryHogQL({ query, values });
87
+ return mapHogqlResult(result);
88
+ }
89
+ throw new Error("Unsupported query type for PostHog datasource.");
90
+ }
91
+ }
92
+ function createPosthogQueryEngine(reader, options) {
93
+ return new PosthogQueryEngine(reader, options);
94
+ }
95
+ function buildMetricQuery(metricIds, params) {
96
+ const range = resolveDateRange(params);
97
+ const values = {
98
+ dateFrom: range?.from.toISOString(),
99
+ dateTo: range?.to.toISOString()
100
+ };
101
+ const metricClauses = metricIds.map((metricId, index) => {
102
+ values[`metric${index}`] = metricId;
103
+ return `event = {metric${index}}`;
104
+ });
105
+ const whereClauses = [
106
+ metricClauses.length ? `(${metricClauses.join(" or ")})` : "",
107
+ range ? "timestamp >= {dateFrom} and timestamp < {dateTo}" : ""
108
+ ].filter(Boolean).join(" and ");
109
+ return {
110
+ query: [
111
+ "select",
112
+ " event as metric,",
113
+ " count() as total",
114
+ "from events",
115
+ whereClauses ? `where ${whereClauses}` : "",
116
+ "group by metric"
117
+ ].filter(Boolean).join(`
118
+ `),
119
+ values
120
+ };
121
+ }
122
+ function buildAggregationQuery(aggregation, params) {
123
+ const measures = aggregation.measures.map((measure) => ({
124
+ ...measure,
125
+ expression: buildMeasureExpression(measure.field, measure.aggregation)
126
+ }));
127
+ const dimensions = aggregation.dimensions.map((dimension) => ({
128
+ ...dimension,
129
+ expression: buildDimensionExpression(dimension.field, dimension.type, dimension.granularity)
130
+ }));
131
+ const selections = [
132
+ ...dimensions.map((dimension) => `${dimension.expression} as ${dimension.name}`),
133
+ ...measures.map((measure) => `${measure.expression} as ${measure.name}`)
134
+ ];
135
+ const values = {};
136
+ const filters = buildFilterClauses(aggregation, params, values);
137
+ const limit = aggregation.limit ?? 100;
138
+ const orderBy = aggregation.orderBy?.length ? `order by ${aggregation.orderBy.map((order) => `${order.field} ${order.direction}`).join(", ")}` : "";
139
+ return {
140
+ query: [
141
+ "select",
142
+ ` ${selections.join(`,
143
+ `)}`,
144
+ `from ${aggregation.source}`,
145
+ filters.length ? `where ${filters.join(" and ")}` : "",
146
+ dimensions.length ? `group by ${dimensions.map((d) => d.name).join(", ")}` : "",
147
+ orderBy,
148
+ `limit ${limit}`
149
+ ].filter(Boolean).join(`
150
+ `),
151
+ values
152
+ };
153
+ }
154
+ function buildMeasureExpression(field, aggregation) {
155
+ switch (aggregation) {
156
+ case "COUNT":
157
+ return field === "*" ? "count()" : `count(${field})`;
158
+ case "COUNT_DISTINCT":
159
+ return `countDistinct(${field})`;
160
+ case "SUM":
161
+ return `sum(${field})`;
162
+ case "AVG":
163
+ return `avg(${field})`;
164
+ case "MIN":
165
+ return `min(${field})`;
166
+ case "MAX":
167
+ return `max(${field})`;
168
+ default:
169
+ return `count(${field})`;
170
+ }
171
+ }
172
+ function buildDimensionExpression(field, type, granularity) {
173
+ if (type === "TIME") {
174
+ switch (granularity) {
175
+ case "HOUR":
176
+ return `toStartOfHour(${field})`;
177
+ case "WEEK":
178
+ return `toStartOfWeek(${field})`;
179
+ case "MONTH":
180
+ return `toStartOfMonth(${field})`;
181
+ case "YEAR":
182
+ return `toStartOfYear(${field})`;
183
+ case "DAY":
184
+ default:
185
+ return `toStartOfDay(${field})`;
186
+ }
187
+ }
188
+ return field;
189
+ }
190
+ function buildFilterClauses(aggregation, params, values) {
191
+ const clauses = [];
192
+ const range = resolveDateRange(params);
193
+ if (range) {
194
+ values.dateFrom = range.from.toISOString();
195
+ values.dateTo = range.to.toISOString();
196
+ clauses.push(`timestamp >= {dateFrom} and timestamp < {dateTo}`);
197
+ }
198
+ aggregation.filters?.forEach((filter, index) => {
199
+ const key = `filter${index}`;
200
+ switch (filter.operator) {
201
+ case "eq":
202
+ values[key] = filter.value;
203
+ clauses.push(`${filter.field} = {${key}}`);
204
+ break;
205
+ case "neq":
206
+ values[key] = filter.value;
207
+ clauses.push(`${filter.field} != {${key}}`);
208
+ break;
209
+ case "gt":
210
+ values[key] = filter.value;
211
+ clauses.push(`${filter.field} > {${key}}`);
212
+ break;
213
+ case "gte":
214
+ values[key] = filter.value;
215
+ clauses.push(`${filter.field} >= {${key}}`);
216
+ break;
217
+ case "lt":
218
+ values[key] = filter.value;
219
+ clauses.push(`${filter.field} < {${key}}`);
220
+ break;
221
+ case "lte":
222
+ values[key] = filter.value;
223
+ clauses.push(`${filter.field} <= {${key}}`);
224
+ break;
225
+ case "contains":
226
+ values[key] = filter.value;
227
+ clauses.push(`${filter.field} LIKE '%' || {${key}} || '%'`);
228
+ break;
229
+ case "between": {
230
+ if (Array.isArray(filter.value) && filter.value.length >= 2) {
231
+ values[`${key}Start`] = filter.value[0];
232
+ values[`${key}End`] = filter.value[1];
233
+ clauses.push(`${filter.field} BETWEEN {${key}Start} AND {${key}End}`);
234
+ }
235
+ break;
236
+ }
237
+ case "in":
238
+ case "nin":
239
+ if (Array.isArray(filter.value)) {
240
+ const placeholders = [];
241
+ filter.value.forEach((value, valueIndex) => {
242
+ const valueKey = `${key}_${valueIndex}`;
243
+ values[valueKey] = value;
244
+ placeholders.push(`{${valueKey}}`);
245
+ });
246
+ if (placeholders.length) {
247
+ clauses.push(`${filter.field} ${filter.operator === "in" ? "IN" : "NOT IN"} (${placeholders.join(", ")})`);
248
+ }
249
+ }
250
+ break;
251
+ default:
252
+ break;
253
+ }
254
+ });
255
+ return clauses;
256
+ }
257
+ function resolveDateRange(params) {
258
+ const range = params.dateRange;
259
+ if (!range)
260
+ return null;
261
+ return { from: range.start, to: range.end };
262
+ }
263
+ function mapHogqlResult(result) {
264
+ if (!Array.isArray(result.results) || !Array.isArray(result.columns)) {
265
+ return { data: [], columns: [], rowCount: 0 };
266
+ }
267
+ const columns = result.columns.map((name) => ({
268
+ name,
269
+ type: "STRING"
270
+ }));
271
+ const data = result.results.map((row) => {
272
+ if (!Array.isArray(row))
273
+ return {};
274
+ const record = {};
275
+ result.columns?.forEach((column, index) => {
276
+ record[column] = row[index];
277
+ });
278
+ return record;
279
+ });
280
+ return {
281
+ data,
282
+ columns,
283
+ rowCount: data.length
284
+ };
285
+ }
286
+
287
+ // src/handlers/query.handlers.ts
288
+ async function executePosthogQuery(input) {
289
+ const engine = createPosthogQueryEngine(input.reader);
290
+ return engine.execute(input.definition, input.params);
291
+ }
292
+ export {
293
+ executePosthogQuery
294
+ };