@contractspec/example.analytics-dashboard 3.9.9 → 3.9.10

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