@powerhousedao/analytics-engine-knex 0.6.2 → 0.6.4

package/dist/src/KnexAnalyticsStore.d.ts

@@ -0,0 +1,52 @@
+import type { Knex } from "knex";
+import { AnalyticsPath, type AnalyticsSeries, type AnalyticsSeriesInput, type AnalyticsSeriesQuery, type IAnalyticsStore, type AnalyticsUpdateCallback } 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 type KnexAnalyticsStoreOptions = {
+    executor: IKnexQueryExecutor;
+    knex: Knex;
+};
+export declare class KnexAnalyticsStore implements IAnalyticsStore {
+    protected readonly _executor: IKnexQueryExecutor;
+    protected readonly _knex: Knex;
+    private readonly _subscriptionManager;
+    constructor({ executor, knex }: KnexAnalyticsStoreOptions);
+    destroy(): void;
+    clearSeriesBySource(source: AnalyticsPath, cleanUpDimensions?: boolean): Promise<number>;
+    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>;
+    subscribeToSource(path: AnalyticsPath, callback: AnalyticsUpdateCallback): () => void;
+}
+//# sourceMappingURL=KnexAnalyticsStore.d.ts.map

package/dist/src/KnexAnalyticsStore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"KnexAnalyticsStore.d.ts","sourceRoot":"","sources":["../../src/KnexAnalyticsStore.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAEjC,OAAO,EACL,aAAa,EACb,KAAK,eAAe,EACpB,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EAEzB,KAAK,eAAe,EACpB,KAAK,uBAAuB,EAE7B,MAAM,sCAAsC,CAAC;AAK9C,MAAM,MAAM,qBAAqB,GAAG;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,IAAI,CAAC;IACZ,GAAG,EAAE,IAAI,GAAG,IAAI,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;IACnC,CAAC,SAAS,EAAE,OAAO,MAAM,EAAE,GAAG,MAAM,CAAC;IACrC,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC5C,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,MAAM;IACrB,QAAQ,IAAI,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;CACxE;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,IAAI,EAAE,IAAI,CAAC;CACZ,CAAC;AAEF,qBAAa,kBAAmB,YAAW,eAAe;IACxD,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAC;IACjD,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC;IAC/B,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CACA;gBAElB,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,yBAAyB;IAKzD,OAAO;IAID,mBAAmB,CAC9B,MAAM,EAAE,aAAa,EACrB,iBAAiB,GAAE,OAAe,GACjC,OAAO,CAAC,MAAM,CAAC;IAgBL,6BAA6B;IAa7B,iBAAiB,CAC5B,KAAK,EAAE,oBAAoB,GAC1B,OAAO,CAAC,eAAe,EAAE,CAAC;IAuChB,cAAc,CAAC,KAAK,EAAE,oBAAoB;IAI1C,eAAe,CAAC,MAAM,EAAE,oBAAoB,EAAE;IAyD3D,OAAO,CAAC,mBAAmB;IAoC3B,OAAO,CAAC,eAAe;IA0BvB,OAAO,CAAC,oBAAoB;YAWd,eAAe;YA8Bf,oBAAoB;YAUpB,oBAAoB;IAoBrB,aAAa;IAqCb,UAAU;IAuBV,aAAa;IAUnB,iBAAiB,CACtB,IAAI,EAAE,aAAa,EACnB,QAAQ,EAAE,uBAAuB,GAChC,MAAM,IAAI;CAGd"}

package/dist/src/KnexQueryExecutor.d.ts

@@ -0,0 +1,12 @@
+import { type IAnalyticsProfiler } from "@powerhousedao/analytics-engine-core";
+import type { Knex } from "knex";
+import { type IKnexQueryExecutor } from "./KnexAnalyticsStore.js";
+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>;
+}
+//# sourceMappingURL=KnexQueryExecutor.d.ts.map

package/dist/src/KnexQueryExecutor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"KnexQueryExecutor.d.ts","sourceRoot":"","sources":["../../src/KnexQueryExecutor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAC/E,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AACjC,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAElE,qBAAa,iBAAkB,YAAW,kBAAkB;IAIxD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC;IAC9B,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC;IAChC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC;IAL7B,OAAO,CAAC,MAAM,CAAa;gBAGR,YAAY,CAAC,GAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,aAAA,EACrD,cAAc,CAAC,GAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,IAAI,aAAA,EACtD,SAAS,CAAC,EAAE,kBAAkB,YAAA;IAO3C,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC;CAqB7E"}

package/dist/src/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./KnexAnalyticsStore.js";
+export { KnexQueryExecutor } from "./KnexQueryExecutor.js";
+export type { IKnexQueryExecutor, KnexAnalyticsStoreOptions, } from "./KnexAnalyticsStore.js";
+export type { SqlQueryLogger, SqlResultsLogger } from "./util.js";
+export { defaultQueryLogger, defaultResultsLogger } from "./util.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC;AACxC,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,YAAY,EACV,kBAAkB,EAClB,yBAAyB,GAC1B,MAAM,yBAAyB,CAAC;AACjC,YAAY,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAClE,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC"}

package/{build → dist/src}/index.js

@@ -4444,7 +4444,7 @@ function friendlyDateTime(dateTimeish) {
   }
 }
 
-// ../core/build/index.js
+// ../core/dist/src/index.js
 var AnalyticsSerializerTypes;
 ((AnalyticsSerializerTypes2) => {
   AnalyticsSerializerTypes2[AnalyticsSerializerTypes2["AnalyticsPath"] = 0] = "AnalyticsPath";
@@ -9409,6 +9409,3 @@ export {
   KnexQueryExecutor,
   KnexAnalyticsStore
 };
-
-//# debugId=23B59978D43E742764756E2164756E21
-//# sourceMappingURL=index.js.map

package/dist/src/util.d.ts

@@ -0,0 +1,6 @@
+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;
+export declare function toPascalCase(str: string): string;
+//# sourceMappingURL=util.d.ts.map

package/dist/src/util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../src/util.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;AACpE,MAAM,MAAM,gBAAgB,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,IAAI,CAAC;AAErE,eAAO,MAAM,kBAAkB,GAC5B,KAAK,MAAM,KAAG,cAGd,CAAC;AAEJ,eAAO,MAAM,oBAAoB,GAC9B,KAAK,MAAM,KAAG,gBAOd,CAAC;AAEJ,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,UAMvC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@powerhousedao/analytics-engine-knex",
-  "version": "0.6.2",
+  "version": "0.6.4",
   "license": "AGPL-3.0-only",
   "repository": {
     "type": "git",
@@ -13,20 +13,18 @@
   "exports": {
     ".": {
       "types": "./dist/src/index.d.ts",
-      "default": "./build/index.js"
+      "default": "./dist/src/index.js"
     }
   },
   "files": [
-    "./build/index.js",
-    "./build/index.js.map",
-    "./dist/index.d.ts"
+    "dist/src"
   ],
   "dependencies": {
     "date-fns": "4.1.0",
     "knex": "3.1.0",
     "luxon": "3.7.2",
     "pg": "8.18.0",
-    "@powerhousedao/analytics-engine-core": "0.6.2"
+    "@powerhousedao/analytics-engine-core": "0.6.4"
   },
   "devDependencies": {
     "@types/pg": "8.16.0",