@x12i/analytix-dashboard 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,51 @@
+import { CataloxCommonFields, AnalytixRunResult, AnalytixError } from "@x12i/analytix-contracts";
+export interface DashboardWidget {
+    widgetId: string;
+    type: "metric" | "table" | "matrix" | "trend" | "markdown" | "functionOutput" | "reportSection" | "drilldownList";
+    title?: string;
+    analyticRef?: string;
+    staticContent?: string;
+    paramsOverride?: Record<string, any>;
+    widgetProfileRef?: string;
+    failurePolicy: "fail-widget" | "fail-dashboard";
+}
+export interface DashboardDefinition extends CataloxCommonFields {
+    dashboardId: string;
+    params?: any;
+    widgets: DashboardWidget[];
+    layout?: Array<{
+        widgetId: string;
+        x: number;
+        y: number;
+        w: number;
+        h: number;
+    }>;
+    snapshot: {
+        enabled: boolean;
+        retentionDays?: number;
+    };
+}
+export type DashboardRunResult = {
+    dashboardId: string;
+    version: number;
+    widgets: Array<{
+        widgetId: string;
+        status: "success" | "error";
+        result?: AnalytixRunResult;
+        error?: AnalytixError;
+    }>;
+    meta: {
+        startedAt: string;
+        finishedAt: string;
+        durationMs: number;
+        traceId: string;
+        failedWidgetCount: number;
+    };
+};
+export declare class DashboardRunner {
+    static run(definition: DashboardDefinition, params: Record<string, any>, runAnalytic: (ref: string, params: Record<string, any>) => Promise<AnalytixRunResult>, options?: {
+        widgetIds?: string[] | null;
+        traceId?: string;
+    }): Promise<DashboardRunResult>;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAEjG,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,QAAQ,GAAG,OAAO,GAAG,QAAQ,GAAG,OAAO,GAAG,UAAU,GAAG,gBAAgB,GAAG,eAAe,GAAG,eAAe,CAAC;IAClH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACrC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,aAAa,EAAE,aAAa,GAAG,gBAAgB,CAAC;CACjD;AAED,MAAM,WAAW,mBAAoB,SAAQ,mBAAmB;IAC9D,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,GAAG,CAAC;IACb,OAAO,EAAE,eAAe,EAAE,CAAC;IAC3B,MAAM,CAAC,EAAE,KAAK,CAAC;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACjF,QAAQ,EAAE;QACR,OAAO,EAAE,OAAO,CAAC;QACjB,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC;CACH;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,KAAK,CAAC;QACb,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC;QAC5B,MAAM,CAAC,EAAE,iBAAiB,CAAC;QAC3B,KAAK,CAAC,EAAE,aAAa,CAAC;KACvB,CAAC,CAAC;IACH,IAAI,EAAE;QACJ,SAAS,EAAE,MAAM,CAAC;QAClB,UAAU,EAAE,MAAM,CAAC;QACnB,UAAU,EAAE,MAAM,CAAC;QACnB,OAAO,EAAE,MAAM,CAAC;QAChB,iBAAiB,EAAE,MAAM,CAAC;KAC3B,CAAC;CACH,CAAC;AAEF,qBAAa,eAAe;WACb,GAAG,CACd,UAAU,EAAE,mBAAmB,EAC/B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC3B,WAAW,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,OAAO,CAAC,iBAAiB,CAAC,EACrF,OAAO,GAAE;QAAE,SAAS,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAO,GAC9D,OAAO,CAAC,kBAAkB,CAAC;CAsF/B"}

package/dist/index.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DashboardRunner = void 0;
+class DashboardRunner {
+    static async run(definition, params, runAnalytic, options = {}) {
+        const startedAt = new Date().toISOString();
+        const traceId = options.traceId || "trace-id";
+        // Filter widgets if widgetIds filter is provided
+        const widgetsToRun = options.widgetIds
+            ? definition.widgets.filter((w) => options.widgetIds.includes(w.widgetId))
+            : definition.widgets;
+        const runWidgets = [];
+        let failedWidgetCount = 0;
+        for (const widget of widgetsToRun) {
+            // If it is markdown static type with no analyticRef, return success instantly
+            if (widget.type === "markdown" && !widget.analyticRef && widget.staticContent) {
+                runWidgets.push({
+                    widgetId: widget.widgetId,
+                    status: "success",
+                    result: {
+                        analyticId: widget.widgetId,
+                        analyticType: "trend",
+                        version: 1,
+                        status: "active",
+                        data: widget.staticContent,
+                        meta: {
+                            cache: { hit: false, key: "" },
+                            probes: [],
+                            execution: { durationMs: 0, startedAt, finishedAt: startedAt, traceId },
+                        },
+                    },
+                });
+                continue;
+            }
+            if (!widget.analyticRef) {
+                continue;
+            }
+            const mergedParams = { ...params, ...(widget.paramsOverride || {}) };
+            try {
+                const result = await runAnalytic(widget.analyticRef, mergedParams);
+                runWidgets.push({
+                    widgetId: widget.widgetId,
+                    status: "success",
+                    result,
+                });
+            }
+            catch (err) {
+                failedWidgetCount++;
+                const errObj = {
+                    error: {
+                        code: "INTERNAL_ERROR",
+                        message: err.message || "Widget execution failed",
+                        httpStatus: 500,
+                        traceId,
+                    },
+                };
+                if (widget.failurePolicy === "fail-dashboard") {
+                    throw new Error(JSON.stringify(errObj));
+                }
+                runWidgets.push({
+                    widgetId: widget.widgetId,
+                    status: "error",
+                    error: errObj,
+                });
+            }
+        }
+        const finishedAt = new Date().toISOString();
+        const durationMs = new Date(finishedAt).getTime() - new Date(startedAt).getTime();
+        return {
+            dashboardId: definition.dashboardId,
+            version: definition.version,
+            widgets: runWidgets,
+            meta: {
+                startedAt,
+                finishedAt,
+                durationMs,
+                traceId,
+                failedWidgetCount,
+            },
+        };
+    }
+}
+exports.DashboardRunner = DashboardRunner;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AA0CA,MAAa,eAAe;IAC1B,MAAM,CAAC,KAAK,CAAC,GAAG,CACd,UAA+B,EAC/B,MAA2B,EAC3B,WAAqF,EACrF,UAA6D,EAAE;QAE/D,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QAC3C,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,UAAU,CAAC;QAE9C,iDAAiD;QACjD,MAAM,YAAY,GAAG,OAAO,CAAC,SAAS;YACpC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,SAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;YAC3E,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC;QAEvB,MAAM,UAAU,GAAkC,EAAE,CAAC;QACrD,IAAI,iBAAiB,GAAG,CAAC,CAAC;QAE1B,KAAK,MAAM,MAAM,IAAI,YAAY,EAAE,CAAC;YAClC,8EAA8E;YAC9E,IAAI,MAAM,CAAC,IAAI,KAAK,UAAU,IAAI,CAAC,MAAM,CAAC,WAAW,IAAI,MAAM,CAAC,aAAa,EAAE,CAAC;gBAC9E,UAAU,CAAC,IAAI,CAAC;oBACd,QAAQ,EAAE,MAAM,CAAC,QAAQ;oBACzB,MAAM,EAAE,SAAS;oBACjB,MAAM,EAAE;wBACN,UAAU,EAAE,MAAM,CAAC,QAAQ;wBAC3B,YAAY,EAAE,OAAO;wBACrB,OAAO,EAAE,CAAC;wBACV,MAAM,EAAE,QAAQ;wBAChB,IAAI,EAAE,MAAM,CAAC,aAAa;wBAC1B,IAAI,EAAE;4BACJ,KAAK,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE;4BAC9B,MAAM,EAAE,EAAE;4BACV,SAAS,EAAE,EAAE,UAAU,EAAE,CAAC,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,OAAO,EAAE;yBACxE;qBACK;iBACT,CAAC,CAAC;gBACH,SAAS;YACX,CAAC;YAED,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;gBACxB,SAAS;YACX,CAAC;YAED,MAAM,YAAY,GAAG,EAAE,GAAG,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,cAAc,IAAI,EAAE,CAAC,EAAE,CAAC;YAErE,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,MAAM,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;gBACnE,UAAU,CAAC,IAAI,CAAC;oBACd,QAAQ,EAAE,MAAM,CAAC,QAAQ;oBACzB,MAAM,EAAE,SAAS;oBACjB,MAAM;iBACP,CAAC,CAAC;YACL,CAAC;YAAC,OAAO,GAAQ,EAAE,CAAC;gBAClB,iBAAiB,EAAE,CAAC;gBACpB,MAAM,MAAM,GAAkB;oBAC5B,KAAK,EAAE;wBACL,IAAI,EAAE,gBAAgB;wBACtB,OAAO,EAAE,GAAG,CAAC,OAAO,IAAI,yBAAyB;wBACjD,UAAU,EAAE,GAAG;wBACf,OAAO;qBACR;iBACF,CAAC;gBAEF,IAAI,MAAM,CAAC,aAAa,KAAK,gBAAgB,EAAE,CAAC;oBAC9C,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;gBAC1C,CAAC;gBAED,UAAU,CAAC,IAAI,CAAC;oBACd,QAAQ,EAAE,MAAM,CAAC,QAAQ;oBACzB,MAAM,EAAE,OAAO;oBACf,KAAK,EAAE,MAAM;iBACd,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,MAAM,UAAU,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QAC5C,MAAM,UAAU,GAAG,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,OAAO,EAAE,GAAG,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,CAAC;QAElF,OAAO;YACL,WAAW,EAAE,UAAU,CAAC,WAAW;YACnC,OAAO,EAAE,UAAU,CAAC,OAAO;YAC3B,OAAO,EAAE,UAAU;YACnB,IAAI,EAAE;gBACJ,SAAS;gBACT,UAAU;gBACV,UAAU;gBACV,OAAO;gBACP,iBAAiB;aAClB;SACF,CAAC;IACJ,CAAC;CACF;AA5FD,0CA4FC"}

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@x12i/analytix-dashboard",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "dependencies": {
+    "@x12i/analytix-contracts": "^1.0.0",
+    "@x12i/analytix": "^1.0.0"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json"
+  }
+}