@powerhousedao/analytics-engine-core 6.0.0-dev.105 → 6.0.0-dev.107

package/dist/index.d.ts

@@ -0,0 +1,130 @@
+import { AnalyticsDimension, AnalyticsGranularity, AnalyticsPath, AnalyticsPathSegment, AnalyticsPeriod, AnalyticsQuery, AnalyticsSerializerTypes, AnalyticsSeries, AnalyticsSeriesInput, AnalyticsSeriesQuery, AnalyticsUpdateCallback, CompoundAnalyticsQuery, IAnalyticsStore, MultiCurrencyConversion } from "@powerhousedao/shared/analytics";
+import { DateTime } from "luxon";
+
+//#region src/AnalyticsProfiler.d.ts
+interface IAnalyticsProfiler {
+  get prefix(): string;
+  push: (system: string) => void;
+  pop: () => void;
+  popAndReturn: (result: any) => any;
+  record: <T>(metric: string, fn: () => Promise<T>) => Promise<T>;
+  recordSync: <T>(metric: string, fn: () => T) => T;
+}
+declare class AnalyticsProfiler implements IAnalyticsProfiler {
+  private readonly _ns;
+  private readonly _logger;
+  private readonly _stack;
+  private _prefix;
+  constructor(_ns: string, _logger: (metricName: string, ms: number) => void);
+  get prefix(): string;
+  push(system: string): void;
+  pop(): void;
+  popAndReturn(result: any): any;
+  record<T>(metric: string, fn: () => Promise<T>): Promise<T>;
+  recordSync<T>(metric: string, fn: () => T): T;
+  updatePrefix(): void;
+}
+declare class PassthroughAnalyticsProfiler implements IAnalyticsProfiler {
+  get prefix(): string;
+  push(system: string): void;
+  pop(): void;
+  popAndReturn(result: any): any;
+  record<T>(metric: string, fn: () => Promise<T>): Promise<T>;
+  recordSync<T>(metric: string, fn: () => T): T;
+}
+//#endregion
+//#region src/AnalyticsDiscretizer.d.ts
+type GroupedPeriodResult = {
+  period: string;
+  start: DateTime;
+  end: DateTime;
+  rows: Array<{
+    dimensions: Record<string, AnalyticsDimension>;
+    metric: string;
+    unit: string | null;
+    value: number;
+    /**
+     * The sum of all metric values over this period?
+     */
+    sum: number;
+  }>;
+};
+type GroupedPeriodResults = Array<GroupedPeriodResult>;
+//#endregion
+//#region src/AnalyticsQueryEngine.d.ts
+declare class AnalyticsQueryEngine {
+  private readonly _analyticsStore;
+  private readonly _profiler;
+  constructor(_analyticsStore: IAnalyticsStore, profiler?: IAnalyticsProfiler);
+  executeCompound(query: CompoundAnalyticsQuery): Promise<GroupedPeriodResults>;
+  execute(query: AnalyticsQuery): Promise<GroupedPeriodResults>;
+  executeMultiCurrency(query: AnalyticsQuery, mcc: MultiCurrencyConversion): Promise<GroupedPeriodResults>;
+  private _applyVectorOperator;
+  private _applyScalarOperator;
+  private _calculateOutputValue;
+  private _executeSeriesQuery;
+  private _applyLods;
+  private _applyDimensionsLods;
+  getDimensions(): Promise<any>;
+}
+//#endregion
+//#region src/AnalyticsSubscriptionManager.d.ts
+declare class NotificationError extends Error {
+  readonly innerErrors: Error[];
+  constructor(errors: Error[]);
+}
+/**
+ * Manages subscriptions for analytics paths.
+ */
+declare class AnalyticsSubscriptionManager {
+  private _subscriptions;
+  /**
+   * Subscribe to updates for an analytics path. A subscribed function will be
+   * called for:
+   *
+   * - exact path matches
+   * - matching child paths (i.e. an update to /a/b/c will trigger a callback
+   *   for /a/b/c, /a/b, and /a)
+   * - wildcard matches
+   *
+   * @param path The analytics path to subscribe to.
+   * @param callback Function to be called when the path is updated.
+   *
+   * @returns A function that, when called, unsubscribes from the updates.
+   */
+  subscribeToPath(path: AnalyticsPath, callback: AnalyticsUpdateCallback): () => void;
+  /**
+   * Notifies subscribers about updates to paths.
+   *
+   * @param paths The paths that were updated.
+   */
+  notifySubscribers(paths: AnalyticsPath[]): void;
+  /**
+   * Normalizes a path string to ensure consistent comparison.
+   */
+  private normalizePath;
+  /**
+   * Checks if a path matches a subscription pattern that may contain wildcards.
+   */
+  private pathMatchesWildcardPattern;
+  /**
+   * Gets all path prefixes for a given path.
+   *
+   * For example, for '/a/b/c' it returns ['/a', '/a/b', '/a/b/c'].
+   */
+  private getPathPrefixes;
+}
+//#endregion
+//#region src/types.d.ts
+type SqlQueryLogger = (index: number, query: string) => void;
+type SqlResultsLogger = (index: number, results: any) => void;
+interface ISqlExecutor {
+  execute(rawSql: string, params?: unknown[]): Promise<any>;
+}
+//#endregion
+//#region src/util.d.ts
+declare const defaultQueryLogger: (tag: string) => SqlQueryLogger;
+declare const defaultResultsLogger: (tag: string) => SqlResultsLogger;
+//#endregion
+export { type AnalyticsDimension, AnalyticsGranularity, AnalyticsPath, AnalyticsPathSegment, AnalyticsPeriod, AnalyticsProfiler, type AnalyticsQuery, AnalyticsQueryEngine, AnalyticsSerializerTypes, type AnalyticsSeries, type AnalyticsSeriesInput, type AnalyticsSeriesQuery, AnalyticsSubscriptionManager, type AnalyticsUpdateCallback, type GroupedPeriodResult, type GroupedPeriodResults, type IAnalyticsProfiler, type IAnalyticsStore, ISqlExecutor, NotificationError, PassthroughAnalyticsProfiler, SqlQueryLogger, SqlResultsLogger, defaultQueryLogger, defaultResultsLogger };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/AnalyticsProfiler.ts","../src/AnalyticsDiscretizer.ts","../src/AnalyticsQueryEngine.ts","../src/AnalyticsSubscriptionManager.ts","../src/types.ts","../src/util.ts"],"mappings":";;;;UAAiB,kBAAA;EAAA,IACX,MAAA;EAEJ,IAAA,GAAO,MAAA;EACP,GAAA;EACA,YAAA,GAAe,MAAA;EAEf,MAAA,MAAY,MAAA,UAAgB,EAAA,QAAU,OAAA,CAAQ,CAAA,MAAO,OAAA,CAAQ,CAAA;EAC7D,UAAA,MAAgB,MAAA,UAAgB,EAAA,QAAU,CAAA,KAAM,CAAA;AAAA;AAAA,cAGrC,iBAAA,YAA6B,kBAAA;EAAA,iBAKrB,GAAA;EAAA,iBACA,OAAA;EAAA,iBALF,MAAA;EAAA,QACT,OAAA;cAGW,GAAA,UACA,OAAA,GAAU,UAAA,UAAoB,EAAA;EAAA,IAK7C,MAAA,CAAA;EAIJ,IAAA,CAAK,MAAA;EAML,GAAA,CAAA;EAMA,YAAA,CAAa,MAAA;EAMP,MAAA,GAAA,CAAU,MAAA,UAAgB,EAAA,QAAU,OAAA,CAAQ,CAAA,IAAK,OAAA,CAAQ,CAAA;EAW/D,UAAA,GAAA,CAAc,MAAA,UAAgB,EAAA,QAAU,CAAA,GAAI,CAAA;EAW5C,YAAA,CAAA;AAAA;AAAA,cASW,4BAAA,YAAwC,kBAAA;EAAA,IAC/C,MAAA,CAAA;EAIJ,IAAA,CAAK,MAAA;EAIL,GAAA,CAAA;EAIA,YAAA,CAAa,MAAA;EAIP,MAAA,GAAA,CAAU,MAAA,UAAgB,EAAA,QAAU,OAAA,CAAQ,CAAA,IAAE,OAAA,CAAA,CAAA;EAIpD,UAAA,GAAA,CAAc,MAAA,UAAgB,EAAA,QAAU,CAAA,GAAC,CAAA;AAAA;;;KC9E/B,mBAAA;EACV,MAAA;EACA,KAAA,EAAO,QAAA;EACP,GAAA,EAAK,QAAA;EACL,IAAA,EAAM,KAAA;IACJ,UAAA,EAAY,MAAA,SAAe,kBAAA;IAC3B,MAAA;IACA,IAAA;IACA,KAAA;IDlB+C;;;ICuB/C,GAAA;EAAA;AAAA;AAAA,KAIQ,oBAAA,GAAuB,KAAA,CAAM,mBAAA;;;cCd5B,oBAAA;EAAA,iBAIQ,eAAA;EAAA,iBAHF,SAAA;cAGE,eAAA,EAAiB,eAAA,EAClC,QAAA,GAAW,kBAAA;EAKA,eAAA,CACX,KAAA,EAAO,sBAAA,GACN,OAAA,CAAQ,oBAAA;EA0DE,OAAA,CAAQ,KAAA,EAAO,cAAA,GAAiB,OAAA,CAAQ,oBAAA;EAsBxC,oBAAA,CACX,KAAA,EAAO,cAAA,EACP,GAAA,EAAK,uBAAA,GACJ,OAAA,CAAQ,oBAAA;EAAA,QAwCG,oBAAA;EAAA,QAgBA,oBAAA;EAAA,QAoDN,qBAAA;EAAA,QAiBM,mBAAA;EAAA,QAcN,UAAA;EAAA,QAUA,oBAAA;EAmBK,aAAA,CAAA,GAAiB,OAAA;AAAA;;;cCzRnB,iBAAA,SAA0B,KAAA;EAAA,SACrB,WAAA,EAAa,KAAA;cAEjB,MAAA,EAAQ,KAAA;AAAA;;;;cAWT,4BAAA;EAAA,QACH,cAAA;EHVkC;;;;;;;;;;;;;;EG0BnC,eAAA,CACL,IAAA,EAAM,aAAA,EACN,QAAA,EAAU,uBAAA;EH7BgB;;;;;EGyDrB,iBAAA,CAAkB,KAAA,EAAO,aAAA;EHxDU;;;EAAA,QG0HlC,aAAA;EH1HyC;AAGnD;;EAHmD,QGoIzC,0BAAA;EHhG0C;;;;;EAAA,QG+I1C,eAAA;AAAA;;;KC3LE,cAAA,IAAkB,KAAA,UAAe,KAAA;AAAA,KAEjC,gBAAA,IAAoB,KAAA,UAAe,OAAA;AAAA,UAE9B,YAAA;EACf,OAAA,CAAQ,MAAA,UAAgB,MAAA,eAAqB,OAAA;AAAA;;;cCHlC,kBAAA,GACV,GAAA,aAAc,cAAA;AAAA,cAKJ,oBAAA,GACV,GAAA,aAAc,gBAAA"}