@powerhousedao/analytics-engine-browser 0.1.0

package/README.md

@@ -0,0 +1,5 @@
+### Memory
+
+The in-memory implementation uses a WASM build of a SQLite3 database.
+
+#### Tests

package/dist/BrowserAnalyticsStore.d.ts

@@ -0,0 +1,9 @@
+import { MemoryAnalyticsStore } from "./MemoryAnalyticsStore.js";
+import { SqlQueryLogger, SqlResultsLogger } from "@powerhousedao/analytics-engine-knex";
+import { IAnalyticsProfiler } from "@powerhousedao/analytics-engine-core";
+import { PGlite } from "@electric-sql/pglite";
+export declare class BrowserAnalyticsStore extends MemoryAnalyticsStore {
+    private _dbName;
+    constructor(databaseName: string, queryLogger?: SqlQueryLogger, resultsLogger?: SqlResultsLogger, profiler?: IAnalyticsProfiler);
+    instance(): Promise<PGlite>;
+}

package/dist/BrowserAnalyticsStore.js

@@ -0,0 +1,16 @@
+import { MemoryAnalyticsStore } from "./MemoryAnalyticsStore.js";
+import { IdbFs, PGlite } from "@electric-sql/pglite";
+export class BrowserAnalyticsStore extends MemoryAnalyticsStore {
+    _dbName;
+    constructor(databaseName, queryLogger, resultsLogger, profiler) {
+        super(queryLogger, resultsLogger, profiler);
+        this._dbName = databaseName;
+    }
+    async instance() {
+        return await PGlite.create({
+            fs: new IdbFs(this._dbName),
+            relaxedDurability: true,
+        });
+    }
+}
+//# sourceMappingURL=BrowserAnalyticsStore.js.map

package/dist/BrowserAnalyticsStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BrowserAnalyticsStore.js","sourceRoot":"","sources":["../src/BrowserAnalyticsStore.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAMjE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAErD,MAAM,OAAO,qBAAsB,SAAQ,oBAAoB;IACrD,OAAO,CAAS;IAExB,YACE,YAAoB,EACpB,WAA4B,EAC5B,aAAgC,EAChC,QAA6B;QAE7B,KAAK,CAAC,WAAW,EAAE,aAAa,EAAE,QAAQ,CAAC,CAAC;QAE5C,IAAI,CAAC,OAAO,GAAG,YAAY,CAAC;IAC9B,CAAC;IAEQ,KAAK,CAAC,QAAQ;QACrB,OAAO,MAAM,MAAM,CAAC,MAAM,CAAC;YACzB,EAAE,EAAE,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC;YAC3B,iBAAiB,EAAE,IAAI;SACxB,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/MemoryAnalyticsStore.d.ts

@@ -0,0 +1,15 @@
+import { IAnalyticsProfiler } from "@powerhousedao/analytics-engine-core";
+import { KnexAnalyticsStore, SqlQueryLogger, SqlResultsLogger } from "@powerhousedao/analytics-engine-knex";
+import { PGlite } from "@electric-sql/pglite";
+export declare class MemoryAnalyticsStore extends KnexAnalyticsStore {
+    private _queryLogger;
+    private _resultsLogger;
+    private _pgExecutor;
+    private _profiler;
+    private _sql;
+    constructor(queryLogger?: SqlQueryLogger, resultsLogger?: SqlResultsLogger, profiler?: IAnalyticsProfiler);
+    init(): Promise<void>;
+    protected instance(): Promise<PGlite>;
+    raw(sql: string): Promise<any[]>;
+    destroy(): Promise<void>;
+}

package/dist/MemoryAnalyticsStore.js

@@ -0,0 +1,127 @@
+import { PassthroughAnalyticsProfiler, } from "@powerhousedao/analytics-engine-core";
+import { KnexAnalyticsStore, } from "@powerhousedao/analytics-engine-knex";
+import knexFactory from "knex";
+import { parseRawResults, PGLiteQueryExecutor } from "./PgLiteExecutor.js";
+import { PGlite } from "@electric-sql/pglite";
+const initSql = `
+
+  create table if not exists "AnalyticsSeries"
+  (
+    id     serial       primary key,
+    source varchar(255) not null,
+    start  timestamp    not null,
+    "end"  timestamp,
+    metric varchar(255) not null,
+    value  real         not null,
+    unit   varchar(255),
+    fn     varchar(255) not null,
+    params json
+  );
+
+  create unique index if not exists "AnalyticsSeries_pkey"
+    on "AnalyticsSeries" (id);
+
+  create index if not exists analyticsseries_end_index
+      on "AnalyticsSeries" ("end");
+
+  create index if not exists analyticsseries_fn_index
+      on "AnalyticsSeries" (fn);
+
+  create index if not exists analyticsseries_metric_index
+      on "AnalyticsSeries" (metric);
+
+  create index if not exists analyticsseries_source_index
+      on "AnalyticsSeries" (source);
+
+  create index if not exists analyticsseries_start_index
+      on "AnalyticsSeries" (start);
+
+  create index if not exists analyticsseries_unit_index
+      on "AnalyticsSeries" (unit);
+
+  create index if not exists analyticsseries_value_index
+      on "AnalyticsSeries" (value);
+
+  create table if not exists "AnalyticsDimension"
+  (
+    id          serial        primary key,
+    dimension   varchar(255)  not null,
+    path        varchar(255)  not null,
+    label       varchar(255),
+    icon        varchar(1000),
+    description text
+  );
+
+  create unique index if not exists "AnalyticsDimension_pkey"
+    on "AnalyticsDimension" (id);
+
+  create index if not exists analyticsdimension_dimension_index
+      on "AnalyticsDimension" (dimension);
+
+  create index if not exists analyticsdimension_path_index
+      on "AnalyticsDimension" (path);
+
+  create table if not exists "AnalyticsSeries_AnalyticsDimension"
+  (
+    "seriesId"    integer not null
+      constraint analyticsseries_analyticsdimension_seriesid_foreign
+        references "AnalyticsSeries"
+        on delete cascade,
+    "dimensionId" integer not null
+      constraint analyticsseries_analyticsdimension_dimensionid_foreign
+        references "AnalyticsDimension"
+        on delete cascade
+  );
+
+  create index if not exists analyticsseries_analyticsdimension_dimensionid_index
+    on "AnalyticsSeries_AnalyticsDimension" ("dimensionId");
+
+  create index if not exists analyticsseries_analyticsdimension_seriesid_index
+      on "AnalyticsSeries_AnalyticsDimension" ("seriesId");
+
+`;
+export class MemoryAnalyticsStore extends KnexAnalyticsStore {
+    _queryLogger;
+    _resultsLogger;
+    _pgExecutor;
+    _profiler;
+    _sql = null;
+    constructor(queryLogger, resultsLogger, profiler) {
+        const knex = knexFactory({
+            client: "pg",
+            useNullAsDefault: true,
+        });
+        if (!profiler) {
+            profiler = new PassthroughAnalyticsProfiler();
+        }
+        const executor = new PGLiteQueryExecutor(profiler, queryLogger, resultsLogger);
+        super(executor, knex);
+        this._queryLogger = queryLogger || (() => { });
+        this._resultsLogger = resultsLogger || (() => { });
+        this._profiler = profiler;
+        this._pgExecutor = executor;
+    }
+    async init() {
+        this._sql = await this.instance();
+        // init executor
+        this._pgExecutor.init(this._sql);
+        // create tables if they do not exist
+        await this._sql.exec(initSql);
+    }
+    instance() {
+        return PGlite.create();
+    }
+    async raw(sql) {
+        this._queryLogger(-1, sql);
+        return await this._profiler.record("QueryRaw", async () => {
+            const results = await this._sql?.exec(sql);
+            this._resultsLogger(-1, results);
+            return parseRawResults(results || []);
+        });
+    }
+    async destroy() {
+        super.destroy();
+        this._sql?.close();
+    }
+}
+//# sourceMappingURL=MemoryAnalyticsStore.js.map

package/dist/MemoryAnalyticsStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MemoryAnalyticsStore.js","sourceRoot":"","sources":["../src/MemoryAnalyticsStore.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,4BAA4B,GAC7B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACL,kBAAkB,GAGnB,MAAM,sCAAsC,CAAC;AAE9C,OAAO,WAAW,MAAM,MAAM,CAAC;AAC/B,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC3E,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAE9C,MAAM,OAAO,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4Ef,CAAC;AAEF,MAAM,OAAO,oBAAqB,SAAQ,kBAAkB;IAClD,YAAY,CAAiB;IAC7B,cAAc,CAAmB;IACjC,WAAW,CAAsB;IACjC,SAAS,CAAqB;IAC9B,IAAI,GAAkB,IAAI,CAAC;IAEnC,YACE,WAA4B,EAC5B,aAAgC,EAChC,QAA6B;QAE7B,MAAM,IAAI,GAAG,WAAW,CAAC;YACvB,MAAM,EAAE,IAAI;YACZ,gBAAgB,EAAE,IAAI;SACvB,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,QAAQ,GAAG,IAAI,4BAA4B,EAAE,CAAC;QAChD,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,mBAAmB,CACtC,QAAQ,EACR,WAAW,EACX,aAAa,CACd,CAAC;QAEF,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAEtB,IAAI,CAAC,YAAY,GAAG,WAAW,IAAI,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QAC9C,IAAI,CAAC,cAAc,GAAG,aAAa,IAAI,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QAClD,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC;IAC9B,CAAC;IAEM,KAAK,CAAC,IAAI;QACf,IAAI,CAAC,IAAI,GAAG,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;QAElC,gBAAgB;QAChB,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEjC,qCAAqC;QACrC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC;IAES,QAAQ;QAChB,OAAO,MAAM,CAAC,MAAM,EAAE,CAAC;IACzB,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,GAAW;QAC1B,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;QAE3B,OAAO,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,UAAU,EAAE,KAAK,IAAI,EAAE;YACxD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;YAE3C,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;YAEjC,OAAO,eAAe,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,OAAO;QAClB,KAAK,CAAC,OAAO,EAAE,CAAC;QAEhB,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC;IACrB,CAAC;CACF"}

package/dist/PgLiteExecutor.d.ts

@@ -0,0 +1,15 @@
+import { PGlite } from "@electric-sql/pglite";
+import { IAnalyticsProfiler } from "@powerhousedao/analytics-engine-core";
+import { IKnexQueryExecutor, SqlQueryLogger, SqlResultsLogger } from "@powerhousedao/analytics-engine-knex";
+import { Knex } from "knex";
+export declare const parseRawResults: (rawResults: any[]) => any[];
+export declare class PGLiteQueryExecutor implements IKnexQueryExecutor {
+    private readonly _profiler;
+    private readonly _queryLogger?;
+    private readonly _resultsLogger?;
+    private _index;
+    private _sql;
+    constructor(_profiler: IAnalyticsProfiler, _queryLogger?: SqlQueryLogger | undefined, _resultsLogger?: SqlResultsLogger | undefined);
+    init(sql: PGlite): void;
+    execute<T extends {}, U>(query: Knex.QueryBuilder<T, U>): Promise<any>;
+}

package/dist/PgLiteExecutor.js

@@ -0,0 +1,58 @@
+export const parseRawResults = (rawResults) => {
+    const allValues = [];
+    for (const returnValue of rawResults.values() || []) {
+        const { fields, rows } = returnValue;
+        const values = new Array(rows.length);
+        for (let i = 0, iLen = values.length; i < iLen; i++) {
+            const row = rows[i];
+            const value = {};
+            for (let j = 0, jLen = fields.length; j < jLen; j++) {
+                // todo: switch on dataTypeID
+                const { name, dataTypeID } = fields[j];
+                value[name] = row[name];
+            }
+            values[i] = value;
+        }
+        allValues.push(...values);
+    }
+    return allValues;
+};
+export class PGLiteQueryExecutor {
+    _profiler;
+    _queryLogger;
+    _resultsLogger;
+    _index = 0;
+    _sql = null;
+    constructor(_profiler, _queryLogger, _resultsLogger) {
+        this._profiler = _profiler;
+        this._queryLogger = _queryLogger;
+        this._resultsLogger = _resultsLogger;
+        //
+    }
+    init(sql) {
+        this._sql = sql;
+    }
+    async execute(query) {
+        if (!this._sql) {
+            throw new Error("PGLiteQueryExecutor not initialized");
+        }
+        const raw = query.toString();
+        const index = this._index++;
+        if (this._queryLogger) {
+            this._queryLogger(index, raw);
+        }
+        const results = await this._profiler.record("Query", async () => {
+            const rawResults = await this._sql?.exec(raw);
+            if (!rawResults) {
+                return;
+            }
+            const allValues = parseRawResults(rawResults);
+            return allValues;
+        });
+        if (this._resultsLogger) {
+            this._resultsLogger(index, results);
+        }
+        return results;
+    }
+}
+//# sourceMappingURL=PgLiteExecutor.js.map

package/dist/PgLiteExecutor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PgLiteExecutor.js","sourceRoot":"","sources":["../src/PgLiteExecutor.ts"],"names":[],"mappings":"AASA,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,UAAiB,EAAE,EAAE;IACnD,MAAM,SAAS,GAAG,EAAE,CAAC;IACrB,KAAK,MAAM,WAAW,IAAI,UAAU,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,CAAC;QACpD,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC;QACrC,MAAM,MAAM,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACtC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC;YACpD,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YACpB,MAAM,KAAK,GAAQ,EAAE,CAAC;YACtB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC;gBACpD,6BAA6B;gBAC7B,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;gBACvC,KAAK,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC;YAC1B,CAAC;YAED,MAAM,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;QACpB,CAAC;QAED,SAAS,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC;IAC5B,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,OAAO,mBAAmB;IAKX;IACA;IACA;IANX,MAAM,GAAW,CAAC,CAAC;IACnB,IAAI,GAAkB,IAAI,CAAC;IAEnC,YACmB,SAA6B,EAC7B,YAA6B,EAC7B,cAAiC;QAFjC,cAAS,GAAT,SAAS,CAAoB;QAC7B,iBAAY,GAAZ,YAAY,CAAiB;QAC7B,mBAAc,GAAd,cAAc,CAAmB;QAElD,EAAE;IACJ,CAAC;IAED,IAAI,CAAC,GAAW;QACd,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;IAClB,CAAC;IAED,KAAK,CAAC,OAAO,CAAkB,KAA8B;QAC3D,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzD,CAAC;QAED,MAAM,GAAG,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;QAC7B,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAE5B,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QAChC,CAAC;QAED,MAAM,OAAO,GAAQ,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE;YACnE,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;YAC9C,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChB,OAAO;YACT,CAAC;YAED,MAAM,SAAS,GAAG,eAAe,CAAC,UAAU,CAAC,CAAC;YAC9C,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC,CAAC;QAEH,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,2 @@
+export { MemoryAnalyticsStore } from "./MemoryAnalyticsStore.js";
+export { BrowserAnalyticsStore } from "./BrowserAnalyticsStore.js";

package/dist/index.js

@@ -0,0 +1,3 @@
+export { MemoryAnalyticsStore } from "./MemoryAnalyticsStore.js";
+export { BrowserAnalyticsStore } from "./BrowserAnalyticsStore.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,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC"}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@powerhousedao/analytics-engine-browser",
+  "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": {
+    "@electric-sql/pglite": "^0.2.12",
+    "@powerhousedao/analytics-engine-core": "0.1.0",
+    "@powerhousedao/analytics-engine-knex": "0.1.0",
+    "date-fns": "^3.6.0",
+    "events": "^3.3.0",
+    "knex": "^3.1.0",
+    "luxon": "^3.5.0",
+    "util": "^0.12.5"
+  },
+  "devDependencies": {
+    "@types/luxon": "^3.4.2",
+    "@types/node": "^22.4.2",
+    "@vitest/browser": "^2.1.1",
+    "playwright": "^1.47.2",
+    "tsc-watch": "^6.2.0",
+    "typescript": "^5.6.3",
+    "vitest": "^2.1.1"
+  }
+}