@powerhousedao/analytics-engine-knex 0.1.0

package/dist/KnexAnalyticsStore.d.ts

@@ -0,0 +1,45 @@
+import { Knex } from "knex";
+import { AnalyticsPath, AnalyticsSeries, AnalyticsSeriesInput, AnalyticsSeriesQuery, IAnalyticsStore } from "@powerhousedao/analytics-engine-core";
+export type AnalyticsSeriesRecord = {
+    id: number;
+    source: string;
+    start: Date;
+    end: Date | null;
+    metric: string;
+    value: number;
+    unit: string | null;
+    fn: string;
+    params: Record<string, any> | null;
+    [dimension: `dim_${string}`]: string;
+    dimensionMetadata?: Record<string, string>;
+};
+/**
+ * Using an interface here, so that a null implementation can be used in production,
+ * without the added overhead of calling toString().
+ */
+export interface IQuery {
+    toString(): string;
+}
+export interface IKnexQueryExecutor {
+    execute<T extends {}, U>(query: Knex.QueryBuilder<T, U>): Promise<any>;
+}
+export declare class KnexAnalyticsStore implements IAnalyticsStore {
+    protected readonly _executor: IKnexQueryExecutor;
+    protected readonly _knex: Knex;
+    constructor(_executor: IKnexQueryExecutor, knex?: Knex);
+    destroy(): void;
+    clearSeriesBySource(source: AnalyticsPath, cleanUpDimensions?: boolean): Promise<any>;
+    clearEmptyAnalyticsDimensions(): Promise<any>;
+    getMatchingSeries(query: AnalyticsSeriesQuery): Promise<AnalyticsSeries[]>;
+    addSeriesValue(input: AnalyticsSeriesInput): Promise<void>;
+    addSeriesValues(inputs: AnalyticsSeriesInput[]): Promise<void>;
+    private _formatQueryRecords;
+    private _buildViewQuery;
+    private _buildDimensionQuery;
+    private _linkDimensions;
+    private _createDimensionPath;
+    private addDimensionMetadata;
+    getDimensions(): Promise<any>;
+    getMetrics(): Promise<any>;
+    getCurrencies(): Promise<any>;
+}

package/dist/KnexAnalyticsStore.js

@@ -0,0 +1,258 @@
+import knexFactory from "knex";
+import { DateTime } from "luxon";
+import { AnalyticsPath, } from "@powerhousedao/analytics-engine-core";
+function toPascalCase(str) {
+    return str
+        .replace(/\w+/g, function (word) {
+        return word[0].toUpperCase() + word.slice(1);
+    })
+        .replace(/\s+/g, "");
+}
+export class KnexAnalyticsStore {
+    _executor;
+    _knex;
+    constructor(_executor, knex) {
+        this._executor = _executor;
+        this._knex =
+            knex ||
+                knexFactory({
+                    client: "sqlite3",
+                });
+    }
+    destroy() {
+        this._knex.destroy();
+    }
+    async clearSeriesBySource(source, cleanUpDimensions = false) {
+        const query = this._knex("AnalyticsSeries")
+            .whereLike("source", source.toString("/%"))
+            .delete();
+        let result = await this._executor.execute(query);
+        if (cleanUpDimensions) {
+            result += await this.clearEmptyAnalyticsDimensions();
+        }
+        return result;
+    }
+    async clearEmptyAnalyticsDimensions() {
+        const query = this._knex("AnalyticsDimension AS AD")
+            .whereNotExists((q) => q
+            .select("*")
+            .from("AnalyticsSeries_AnalyticsDimension AS ASAD")
+            .where("ASAD.dimensionId", this._knex.ref("AD.id")))
+            .delete();
+        return await this._executor.execute(query);
+    }
+    async getMatchingSeries(query) {
+        const analyticsView = this._buildViewQuery("AV", Object.keys(query.select), query.metrics.map((m) => m), query.currency.firstSegment().filters, query.end);
+        const baseQuery = this._knex(this._knex.raw(analyticsView)).select("AV.*");
+        // Add dimension filter(s)
+        for (const [dimension, paths] of Object.entries(query.select)) {
+            baseQuery.leftJoin(`AnalyticsDimension as ${dimension}`, (q) => {
+                q.on(`${dimension}.path`, `dim_${dimension}`);
+            });
+            baseQuery.select(`${dimension}.icon as dim_icon`);
+            baseQuery.select(`${dimension}.description as dim_description`);
+            baseQuery.select(`${dimension}.label as dim_label`);
+            if (paths.length == 1) {
+                baseQuery.andWhereLike(`dim_${dimension}`, paths[0].toString("/%"));
+            }
+            else if (paths.length > 1) {
+                baseQuery.andWhere((q) => {
+                    paths.forEach((p) => q.orWhereLike(`dim_${dimension}`, p.toString("/%")));
+                    return q;
+                });
+            }
+        }
+        baseQuery.orderBy("start");
+        const results = await this._executor.execute(baseQuery);
+        return this._formatQueryRecords(results, Object.keys(query.select));
+    }
+    async addSeriesValue(input) {
+        return this.addSeriesValues([input]);
+    }
+    async addSeriesValues(inputs) {
+        const dimensionsMap = {};
+        for (let i = 0; i < inputs.length; i++) {
+            const input = inputs[i];
+            const query = this._knex("AnalyticsSeries").insert({
+                start: input.start.toJSDate(),
+                end: input.end ? input.end.toJSDate() : null,
+                source: input.source.toString("/"),
+                metric: toPascalCase(input.metric),
+                value: input.value,
+                unit: input.unit || null,
+                fn: input.fn || "Single",
+                params: input.params || null,
+            }, "id");
+            const record = await this._executor.execute(query);
+            for (const [dim, path] of Object.entries(inputs[i].dimensions || {})) {
+                if (!dimensionsMap[dim]) {
+                    dimensionsMap[dim] = {};
+                }
+                const pKey = path.toString("/");
+                if (!dimensionsMap[dim][pKey]) {
+                    dimensionsMap[dim][pKey] = [];
+                }
+                dimensionsMap[dim][pKey].push(record[0].id);
+            }
+        }
+        for (const [dim, pathMap] of Object.entries(dimensionsMap)) {
+            await this._linkDimensions(dim, pathMap);
+        }
+        // Adding dimension metadata
+        for (let i = 0; i < inputs.length; i++) {
+            const metaDimension = inputs[i].dimensionMetadata;
+            if (!metaDimension) {
+                continue;
+            }
+            await this.addDimensionMetadata(metaDimension.path, metaDimension.icon, metaDimension.label, metaDimension.description);
+        }
+    }
+    _formatQueryRecords(records, dimensions) {
+        const formatted = records.map((r) => {
+            const result = {
+                id: r.id,
+                source: AnalyticsPath.fromString(r.source.slice(0, -1)),
+                start: DateTime.fromJSDate(r.start),
+                end: r.end ? DateTime.fromJSDate(r.end) : null,
+                metric: r.metric,
+                value: r.value,
+                unit: r.unit,
+                fn: r.fn,
+                params: r.params,
+                dimensions: {},
+            };
+            dimensions.forEach((d) => (result.dimensions[d] = {
+                path: AnalyticsPath.fromString(r[`dim_${d}`] ? r[`dim_${d}`].slice(0, -1) : "?"),
+                icon: r[`dim_icon`] ? r[`dim_icon`] : "",
+                label: r[`dim_label`] ? r[`dim_label`] : "",
+                description: r[`dim_description`] ? r[`dim_description`] : "",
+            }));
+            return result;
+        });
+        // sort by id
+        return formatted.sort((a, b) => a.id - b.id);
+    }
+    _buildViewQuery(name, dimensions, metrics, units, until) {
+        const baseQuery = this._knex("AnalyticsSeries as AS_inner")
+            .select("*")
+            .whereIn("metric", metrics);
+        for (const dimension of dimensions) {
+            baseQuery.select(this._buildDimensionQuery(dimension));
+        }
+        if (units && units[0] !== "") {
+            baseQuery.whereIn("unit", units);
+        }
+        if (until) {
+            baseQuery.where("start", "<", until.toISO());
+        }
+        return `(${baseQuery.toString()}) AS "${name}"`;
+    }
+    _buildDimensionQuery(dimension) {
+        const seriesIdRef = this._knex.ref("AS_inner.id");
+        return this._knex("AnalyticsSeries_AnalyticsDimension as ASAD")
+            .leftJoin("AnalyticsDimension as AD", "AD.id", "ASAD.dimensionId")
+            .where("ASAD.seriesId", seriesIdRef)
+            .where("AD.dimension", dimension)
+            .select("path")
+            .as(`dim_${dimension}`);
+    }
+    async _linkDimensions(dimension, pathMap) {
+        const query = this._knex("AnalyticsDimension")
+            .select("path", "id")
+            .where("dimension", dimension)
+            .whereIn("path", Object.keys(pathMap));
+        const dimensionIds = await this._executor.execute(query);
+        for (const [path, ids] of Object.entries(pathMap)) {
+            const i = dimensionIds.findIndex((record) => record.path == path);
+            const dimensionId = i < 0
+                ? await this._createDimensionPath(dimension, path)
+                : dimensionIds[i].id;
+            for (let j = 0; j < ids.length; j++) {
+                const query = this._knex("AnalyticsSeries_AnalyticsDimension").insert({
+                    seriesId: ids[j],
+                    dimensionId,
+                });
+                await this._executor.execute(query);
+            }
+        }
+    }
+    async _createDimensionPath(dimension, path) {
+        const query = this._knex("AnalyticsDimension").insert({ dimension, path }, "id");
+        const result = await this._executor.execute(query);
+        return result[0].id;
+    }
+    async addDimensionMetadata(path, icon, label, description) {
+        if (!icon && !label && !description) {
+            return;
+        }
+        const query = this._knex("AnalyticsDimension")
+            .where("path", `${path.toString()}/`)
+            .update({
+            icon: icon ? icon : "",
+            label: label ? label : "",
+            description: description ? description : "",
+        });
+        await this._executor.execute(query);
+    }
+    async getDimensions() {
+        // Fetch all rows from the database
+        const query = this._knex
+            .select("dimension", "path", "icon", "label", "description")
+            .from("AnalyticsDimension")
+            .whereNotNull("path")
+            .whereNot("path", "")
+            .whereNot("path", "/");
+        const rows = await this._executor.execute(query);
+        // Process the rows to group them by dimension and format them
+        const grouped = rows.reduce((acc, row) => {
+            // If the dimension is not yet in the accumulator, add it
+            if (!acc[row.dimension]) {
+                acc[row.dimension] = {
+                    name: row.dimension,
+                    values: [],
+                };
+            }
+            // Add the path, icon, label, and description to the dimension's values
+            acc[row.dimension].values.push({
+                path: row.path,
+                icon: row.icon,
+                label: row.label,
+                description: row.description,
+            });
+            return acc;
+        }, {});
+        // Convert the grouped object to an array
+        const dimensionPaths = Object.values(grouped);
+        return dimensionPaths;
+    }
+    async getMetrics() {
+        const query = this._knex("AnalyticsSeries")
+            .select("metric")
+            .distinct()
+            .whereNotNull("metric");
+        const list = await this._executor.execute(query);
+        const filtered = list.map((l) => l.metric);
+        const metrics = [
+            "Budget",
+            "Forecast",
+            "Actuals",
+            "PaymentsOnChain",
+            "PaymentsOffChainIncluded",
+        ];
+        metrics.forEach((metric) => {
+            if (!filtered.includes(metric)) {
+                filtered.push(metric);
+            }
+        });
+        return filtered;
+    }
+    async getCurrencies() {
+        const query = this._knex("AnalyticsSeries")
+            .select("unit")
+            .distinct()
+            .whereNotNull("unit");
+        const currencies = await this._executor.execute(query);
+        return currencies.map((c) => c.unit);
+    }
+}
+//# sourceMappingURL=KnexAnalyticsStore.js.map

package/dist/KnexAnalyticsStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"KnexAnalyticsStore.js","sourceRoot":"","sources":["../src/KnexAnalyticsStore.ts"],"names":[],"mappings":"AAAA,OAAO,WAAqB,MAAM,MAAM,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACjC,OAAO,EACL,aAAa,GAMd,MAAM,sCAAsC,CAAC;AAE9C,SAAS,YAAY,CAAC,GAAW;IAC/B,OAAO,GAAG;SACP,OAAO,CAAC,MAAM,EAAE,UAAU,IAAI;QAC7B,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC/C,CAAC,CAAC;SACD,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AACzB,CAAC;AA8BD,MAAM,OAAO,kBAAkB;IAIR;IAHF,KAAK,CAAO;IAE/B,YACqB,SAA6B,EAChD,IAAW;QADQ,cAAS,GAAT,SAAS,CAAoB;QAGhD,IAAI,CAAC,KAAK;YACR,IAAI;gBACJ,WAAW,CAAC;oBACV,MAAM,EAAE,SAAS;iBAClB,CAAC,CAAC;IACP,CAAC;IAEM,OAAO;QACZ,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;IACvB,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAC9B,MAAqB,EACrB,oBAA6B,KAAK;QAElC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC;aACxC,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;aAC1C,MAAM,EAAE,CAAC;QAEZ,IAAI,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAEjD,IAAI,iBAAiB,EAAE,CAAC;YACtB,MAAM,IAAI,MAAM,IAAI,CAAC,6BAA6B,EAAE,CAAC;QACvD,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAEM,KAAK,CAAC,6BAA6B;QACxC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,0BAA0B,CAAC;aACjD,cAAc,CAAC,CAAC,CAAC,EAAE,EAAE,CACpB,CAAC;aACE,MAAM,CAAC,GAAG,CAAC;aACX,IAAI,CAAC,4CAA4C,CAAC;aAClD,KAAK,CAAC,kBAAkB,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CACtD;aACA,MAAM,EAAE,CAAC;QAEZ,OAAO,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC7C,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAC5B,KAA2B;QAE3B,MAAM,aAAa,GAAG,IAAI,CAAC,eAAe,CACxC,IAAI,EACJ,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,EACzB,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAC3B,KAAK,CAAC,QAAQ,CAAC,YAAY,EAAE,CAAC,OAAO,EACrC,KAAK,CAAC,GAAG,CACV,CAAC;QAEF,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAC1B,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,aAAa,CAAC,CAC9B,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAEjB,0BAA0B;QAC1B,KAAK,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;YAC9D,SAAS,CAAC,QAAQ,CAAC,yBAAyB,SAAS,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE;gBAC7D,CAAC,CAAC,EAAE,CAAC,GAAG,SAAS,OAAO,EAAE,OAAO,SAAS,EAAE,CAAC,CAAC;YAChD,CAAC,CAAC,CAAC;YACH,SAAS,CAAC,MAAM,CAAC,GAAG,SAAS,mBAAmB,CAAC,CAAC;YAClD,SAAS,CAAC,MAAM,CAAC,GAAG,SAAS,iCAAiC,CAAC,CAAC;YAChE,SAAS,CAAC,MAAM,CAAC,GAAG,SAAS,qBAAqB,CAAC,CAAC;YACpD,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;gBACtB,SAAS,CAAC,YAAY,CAAC,OAAO,SAAS,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;YACtE,CAAC;iBAAM,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC5B,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,EAAE;oBACvB,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAClB,CAAC,CAAC,WAAW,CAAC,OAAO,SAAS,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CACpD,CAAC;oBACF,OAAO,CAAC,CAAC;gBACX,CAAC,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QACD,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAE3B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACxD,OAAO,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IACtE,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,KAA2B;QACrD,OAAO,IAAI,CAAC,eAAe,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IACvC,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,MAA8B;QACzD,MAAM,aAAa,GAAkB,EAAE,CAAC;QAExC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACvC,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;YACxB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAwB,iBAAiB,CAAC,CAAC,MAAM,CACvE;gBACE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE;gBAC7B,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI;gBAC5C,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC;gBAClC,MAAM,EAAE,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC;gBAClC,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,IAAI;gBACxB,EAAE,EAAE,KAAK,CAAC,EAAE,IAAI,QAAQ;gBACxB,MAAM,EAAE,KAAK,CAAC,MAAM,IAAI,IAAI;aAC7B,EACD,IAAI,CACL,CAAC;YAEF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YACnD,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,UAAU,IAAI,EAAE,CAAC,EAAE,CAAC;gBACrE,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;oBACxB,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;gBAC1B,CAAC;gBAED,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;gBAChC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC9B,aAAa,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;gBAChC,CAAC;gBAED,aAAa,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YAC9C,CAAC;QACH,CAAC;QAED,KAAK,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;YAC3D,MAAM,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QAC3C,CAAC;QAED,4BAA4B;QAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACvC,MAAM,aAAa,GAAQ,MAAM,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC;YACvD,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,SAAS;YACX,CAAC;YACD,MAAM,IAAI,CAAC,oBAAoB,CAC7B,aAAa,CAAC,IAAI,EAClB,aAAa,CAAC,IAAI,EAClB,aAAa,CAAC,KAAK,EACnB,aAAa,CAAC,WAAW,CAC1B,CAAC;QACJ,CAAC;IACH,CAAC;IAEO,mBAAmB,CACzB,OAAgC,EAChC,UAAoB;QAEpB,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAwB,EAAE,EAAE;YACzD,MAAM,MAAM,GAAG;gBACb,EAAE,EAAE,CAAC,CAAC,EAAE;gBACR,MAAM,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;gBACvD,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC;gBACnC,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI;gBAC9C,MAAM,EAAE,CAAC,CAAC,MAAM;gBAChB,KAAK,EAAE,CAAC,CAAC,KAAK;gBACd,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,EAAE,EAAE,CAAC,CAAC,EAAE;gBACR,MAAM,EAAE,CAAC,CAAC,MAAM;gBAChB,UAAU,EAAE,EAA8C;aAC3D,CAAC;YAEF,UAAU,CAAC,OAAO,CAChB,CAAC,CAAC,EAAE,EAAE,CACJ,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG;gBACtB,IAAI,EAAE,aAAa,CAAC,UAAU,CAC5B,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CACjD;gBACD,IAAI,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE;gBACxC,KAAK,EAAE,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE;gBAC3C,WAAW,EAAE,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,EAAE;aAC9D,CAAC,CACL,CAAC;YACF,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC,CAAC;QAEH,aAAa;QACb,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC;IAC/C,CAAC;IAEO,eAAe,CACrB,IAAY,EACZ,UAAoB,EACpB,OAAiB,EACjB,KAAsB,EACtB,KAAsB;QAEtB,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,6BAA6B,CAAC;aACxD,MAAM,CAAC,GAAG,CAAC;aACX,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAE9B,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACnC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC,CAAC;QACzD,CAAC;QAED,IAAI,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC;YAC7B,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QACnC,CAAC;QAED,IAAI,KAAK,EAAE,CAAC;YACV,SAAS,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;QAC/C,CAAC;QAED,OAAO,IAAI,SAAS,CAAC,QAAQ,EAAE,SAAS,IAAI,GAAG,CAAC;IAClD,CAAC;IAEO,oBAAoB,CAAC,SAAiB;QAC5C,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QAElD,OAAO,IAAI,CAAC,KAAK,CAAC,4CAA4C,CAAC;aAC5D,QAAQ,CAAC,0BAA0B,EAAE,OAAO,EAAE,kBAAkB,CAAC;aACjE,KAAK,CAAC,eAAe,EAAE,WAAW,CAAC;aACnC,KAAK,CAAC,cAAc,EAAE,SAAS,CAAC;aAChC,MAAM,CAAC,MAAM,CAAC;aACd,EAAE,CAAC,OAAO,SAAS,EAAE,CAAC,CAAC;IAC5B,CAAC;IAEO,KAAK,CAAC,eAAe,CAC3B,SAAiB,EACjB,OAAiC;QAEjC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC;aAC3C,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC;aACpB,KAAK,CAAC,WAAW,EAAE,SAAS,CAAC;aAC7B,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QAEzC,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAEzD,KAAK,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YAClD,MAAM,CAAC,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC,MAAW,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC;YAEvE,MAAM,WAAW,GACf,CAAC,GAAG,CAAC;gBACH,CAAC,CAAC,MAAM,IAAI,CAAC,oBAAoB,CAAC,SAAS,EAAE,IAAI,CAAC;gBAClD,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAEzB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACpC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAC,MAAM,CAAC;oBACpE,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC;oBAChB,WAAW;iBACZ,CAAC,CAAC;gBAEH,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YACtC,CAAC;QACH,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,oBAAoB,CAAC,SAAiB,EAAE,IAAY;QAChE,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,MAAM,CACnD,EAAE,SAAS,EAAE,IAAI,EAAE,EACnB,IAAI,CACL,CAAC;QAEF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACnD,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACtB,CAAC;IAEO,KAAK,CAAC,oBAAoB,CAChC,IAAY,EACZ,IAA+B,EAC/B,KAAgC,EAChC,WAAsC;QAEtC,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK,IAAI,CAAC,WAAW,EAAE,CAAC;YACpC,OAAO;QACT,CAAC;QACD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC;aAC3C,KAAK,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC;aACpC,MAAM,CAAC;YACN,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE;YACtB,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;YACzB,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE;SAC5C,CAAC,CAAC;QAEL,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC;IAEM,KAAK,CAAC,aAAa;QACxB,mCAAmC;QACnC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK;aACrB,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,CAAC;aAC3D,IAAI,CAAC,oBAAoB,CAAC;aAC1B,YAAY,CAAC,MAAM,CAAC;aACpB,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC;aACpB,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAEzB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAEjD,8DAA8D;QAC9D,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,GAAQ,EAAE,GAAQ,EAAE,EAAE;YACjD,yDAAyD;YACzD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;gBACxB,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG;oBACnB,IAAI,EAAE,GAAG,CAAC,SAAS;oBACnB,MAAM,EAAE,EAAE;iBACX,CAAC;YACJ,CAAC;YAED,uEAAuE;YACvE,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;gBAC7B,IAAI,EAAE,GAAG,CAAC,IAAI;gBACd,IAAI,EAAE,GAAG,CAAC,IAAI;gBACd,KAAK,EAAE,GAAG,CAAC,KAAK;gBAChB,WAAW,EAAE,GAAG,CAAC,WAAW;aAC7B,CAAC,CAAC;YAEH,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAE,CAAC,CAAC;QAEP,yCAAyC;QACzC,MAAM,cAAc,GAAQ,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACnD,OAAO,cAAc,CAAC;IACxB,CAAC;IAEM,KAAK,CAAC,UAAU;QACrB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC;aACxC,MAAM,CAAC,QAAQ,CAAC;aAChB,QAAQ,EAAE;aACV,YAAY,CAAC,QAAQ,CAAC,CAAC;QAE1B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACjD,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QAChD,MAAM,OAAO,GAAG;YACd,QAAQ;YACR,UAAU;YACV,SAAS;YACT,iBAAiB;YACjB,0BAA0B;SAC3B,CAAC;QACF,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACzB,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC/B,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACxB,CAAC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEM,KAAK,CAAC,aAAa;QACxB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC;aACxC,MAAM,CAAC,MAAM,CAAC;aACd,QAAQ,EAAE;aACV,YAAY,CAAC,MAAM,CAAC,CAAC;QAExB,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACvD,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAC5C,CAAC;CACF"}

package/dist/KnexQueryExecutor.d.ts

@@ -0,0 +1,11 @@
+import { IAnalyticsProfiler } from "@powerhousedao/analytics-engine-core";
+import { Knex } from "knex";
+import { IKnexQueryExecutor } from "./KnexAnalyticsStore";
+export declare class KnexQueryExecutor implements IKnexQueryExecutor {
+    private readonly _queryLogger?;
+    private readonly _resultsLogger?;
+    private readonly _profiler?;
+    private _index;
+    constructor(_queryLogger?: ((index: number, query: string) => void) | undefined, _resultsLogger?: ((index: number, results: any) => void) | undefined, _profiler?: IAnalyticsProfiler | undefined);
+    execute<T extends {}, U>(query: Knex.QueryBuilder<T, U>): Promise<any>;
+}

package/dist/KnexQueryExecutor.js

@@ -0,0 +1,33 @@
+export class KnexQueryExecutor {
+    _queryLogger;
+    _resultsLogger;
+    _profiler;
+    _index = 0;
+    constructor(_queryLogger, _resultsLogger, _profiler) {
+        this._queryLogger = _queryLogger;
+        this._resultsLogger = _resultsLogger;
+        this._profiler = _profiler;
+        if (this._profiler) {
+            this._profiler.push("Knex");
+        }
+    }
+    async execute(query) {
+        const index = this._index++;
+        if (this._queryLogger) {
+            this._queryLogger(index, query.toString());
+        }
+        let results;
+        if (this._profiler) {
+            // profile the query
+            results = await this._profiler.record("Query", async () => await query);
+        }
+        else {
+            results = await query;
+        }
+        if (this._resultsLogger) {
+            this._resultsLogger(index, results);
+        }
+        return results;
+    }
+}
+//# sourceMappingURL=KnexQueryExecutor.js.map

package/dist/KnexQueryExecutor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"KnexQueryExecutor.js","sourceRoot":"","sources":["../src/KnexQueryExecutor.ts"],"names":[],"mappings":"AAIA,MAAM,OAAO,iBAAiB;IAIT;IACA;IACA;IALX,MAAM,GAAW,CAAC,CAAC;IAE3B,YACmB,YAAqD,EACrD,cAAsD,EACtD,SAA8B;QAF9B,iBAAY,GAAZ,YAAY,CAAyC;QACrD,mBAAc,GAAd,cAAc,CAAwC;QACtD,cAAS,GAAT,SAAS,CAAqB;QAE/C,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAED,KAAK,CAAC,OAAO,CAAkB,KAA8B;QAC3D,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAE5B,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC7C,CAAC;QAED,IAAI,OAAO,CAAC;QACZ,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,oBAAoB;YACpB,OAAO,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,CAAC;QAC1E,CAAC;aAAM,CAAC;YACN,OAAO,GAAG,MAAM,KAAK,CAAC;QACxB,CAAC;QAED,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QACtC,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;CACF"}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export { KnexAnalyticsStore } from "./KnexAnalyticsStore.js";
+export { KnexQueryExecutor } from "./KnexQueryExecutor.js";
+export type { IKnexQueryExecutor } from "./KnexAnalyticsStore.js";
+export type { SqlQueryLogger, SqlResultsLogger } from "./util.js";
+export { defaultQueryLogger, defaultResultsLogger } from "./util.js";

package/dist/index.js

@@ -0,0 +1,4 @@
+export { KnexAnalyticsStore } from "./KnexAnalyticsStore.js";
+export { KnexQueryExecutor } from "./KnexQueryExecutor.js";
+export { defaultQueryLogger, defaultResultsLogger } from "./util.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAG3D,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC"}

package/dist/util.d.ts

@@ -0,0 +1,4 @@
+export type SqlQueryLogger = (index: number, query: string) => void;
+export type SqlResultsLogger = (index: number, results: any) => void;
+export declare const defaultQueryLogger: (tag: string) => SqlQueryLogger;
+export declare const defaultResultsLogger: (tag: string) => SqlResultsLogger;

package/dist/util.js

@@ -0,0 +1,12 @@
+export const defaultQueryLogger = (tag) => (index, query) => {
+    console.log(`[${tag}][Q:${index}]: ${query}\n`);
+};
+export const defaultResultsLogger = (tag) => (index, results) => {
+    if (Array.isArray(results)) {
+        console.log(`[${tag}][R:${index}]: ${results.length} results\n`);
+    }
+    else {
+        console.log(`[${tag}][R:${index}]: Received ${typeof results}.\n`);
+    }
+};
+//# sourceMappingURL=util.js.map

package/dist/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,MAAM,kBAAkB,GAC7B,CAAC,GAAW,EAAkB,EAAE,CAChC,CAAC,KAAa,EAAE,KAAa,EAAE,EAAE;IAC/B,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG,OAAO,KAAK,MAAM,KAAK,IAAI,CAAC,CAAC;AAClD,CAAC,CAAC;AAEJ,MAAM,CAAC,MAAM,oBAAoB,GAC/B,CAAC,GAAW,EAAoB,EAAE,CAClC,CAAC,KAAa,EAAE,OAAY,EAAE,EAAE;IAC9B,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QAC3B,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG,OAAO,KAAK,MAAM,OAAO,CAAC,MAAM,YAAY,CAAC,CAAC;IACnE,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG,OAAO,KAAK,eAAe,OAAO,OAAO,KAAK,CAAC,CAAC;IACrE,CAAC;AACH,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@powerhousedao/analytics-engine-knex",
+  "version": "0.1.0",
+  "license": "AGPL-3.0-only",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "dev": "tsc-watch",
+    "build": "rm -rf dist/ && tsc",
+    "test": "vitest"
+  },
+  "dependencies": {
+    "@powerhousedao/analytics-engine-core": "0.1.0",
+    "@types/luxon": "^3.4.2",
+    "@types/node": "^22.4.2",
+    "@types/pg": "^8.11.6",
+    "date-fns": "^3.6.0",
+    "knex": "^3.1.0",
+    "luxon": "^3.5.0",
+    "pg": "^8.12.0"
+  },
+  "devDependencies": {
+    "tsc-watch": "^6.2.0",
+    "typescript": "^5.6.3",
+    "vitest": "^2.0.5"
+  }
+}