@d-dash/builder 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,39 @@
+import type { PersistedDashboard, PersistedWidget, PersistedVariable, LayoutItem, PersistedTimeRange, VisualizationKind, JsonObject } from "@d-dash/core";
+export declare class WidgetBuilder {
+    private _id;
+    private _layoutId;
+    private _datasource;
+    private _query;
+    private _visualization;
+    private _display?;
+    private _timeRange?;
+    private _options?;
+    constructor(id: string, layoutId: string);
+    datasource(datasource: string): this;
+    query(metric: string, filters?: JsonObject): this;
+    visualization(type: VisualizationKind): this;
+    display(title: string, description?: string): this;
+    timeRange(timeRange: PersistedTimeRange): this;
+    options(options: JsonObject): this;
+    build(): PersistedWidget;
+}
+export declare class DashboardBuilder {
+    private _dashboardId;
+    private _meta;
+    private _timeRange;
+    private _layout;
+    private _widgets;
+    private _variables;
+    constructor(dashboardId: string);
+    title(title: string): this;
+    description(description: string): this;
+    tags(tags: string[]): this;
+    folder(folder: string): this;
+    tenant(tenant: string): this;
+    timeRange(timeRange: PersistedTimeRange): this;
+    addVariable(variable: PersistedVariable): this;
+    addWidget(widget: PersistedWidget | WidgetBuilder): this;
+    addLayoutItem(item: LayoutItem): this;
+    build(): PersistedDashboard;
+}
+//# 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,KAAK,EAEV,kBAAkB,EAClB,eAAe,EACf,iBAAiB,EACjB,UAAU,EAIV,kBAAkB,EAClB,iBAAiB,EACjB,UAAU,EACX,MAAM,cAAc,CAAC;AAEtB,qBAAa,aAAa;IACxB,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,WAAW,CAAU;IAC7B,OAAO,CAAC,MAAM,CAAe;IAC7B,OAAO,CAAC,cAAc,CAAuB;IAC7C,OAAO,CAAC,QAAQ,CAAC,CAAgB;IACjC,OAAO,CAAC,UAAU,CAAC,CAAqB;IACxC,OAAO,CAAC,QAAQ,CAAC,CAAa;gBAElB,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAKxC,UAAU,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAKpC,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,IAAI;IAKjD,aAAa,CAAC,IAAI,EAAE,iBAAiB,GAAG,IAAI;IAK5C,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI;IAKlD,SAAS,CAAC,SAAS,EAAE,kBAAkB,GAAG,IAAI;IAK9C,OAAO,CAAC,OAAO,EAAE,UAAU,GAAG,IAAI;IAKlC,KAAK,IAAI,eAAe;CAgBzB;AAED,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,KAAK,CAAgC;IAC7C,OAAO,CAAC,UAAU,CAA6D;IAC/E,OAAO,CAAC,OAAO,CAAoB;IACnC,OAAO,CAAC,QAAQ,CAAyB;IACzC,OAAO,CAAC,UAAU,CAA2B;gBAEjC,WAAW,EAAE,MAAM;IAI/B,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAK1B,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;IAKtC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI;IAK1B,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAK5B,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAK5B,SAAS,CAAC,SAAS,EAAE,kBAAkB,GAAG,IAAI;IAK9C,WAAW,CAAC,QAAQ,EAAE,iBAAiB,GAAG,IAAI;IAK9C,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,aAAa,GAAG,IAAI;IASxD,aAAa,CAAC,IAAI,EAAE,UAAU,GAAG,IAAI;IAKrC,KAAK,IAAI,kBAAkB;CAoB5B"}

package/dist/index.js

@@ -0,0 +1,123 @@
+export class WidgetBuilder {
+    _id;
+    _layoutId;
+    _datasource;
+    _query;
+    _visualization;
+    _display;
+    _timeRange;
+    _options;
+    constructor(id, layoutId) {
+        this._id = id;
+        this._layoutId = layoutId;
+    }
+    datasource(datasource) {
+        this._datasource = datasource;
+        return this;
+    }
+    query(metric, filters) {
+        this._query = { metric, filters };
+        return this;
+    }
+    visualization(type) {
+        this._visualization = { type };
+        return this;
+    }
+    display(title, description) {
+        this._display = { title, description };
+        return this;
+    }
+    timeRange(timeRange) {
+        this._timeRange = timeRange;
+        return this;
+    }
+    options(options) {
+        this._options = options;
+        return this;
+    }
+    build() {
+        if (!this._datasource || !this._query || !this._visualization) {
+            throw new Error("Widget is missing required fields (datasource, query, visualization).");
+        }
+        return {
+            id: this._id,
+            layoutId: this._layoutId,
+            datasource: this._datasource,
+            query: this._query,
+            visualization: this._visualization,
+            display: this._display,
+            timeRange: this._timeRange,
+            options: this._options,
+        };
+    }
+}
+export class DashboardBuilder {
+    _dashboardId;
+    _meta = { title: "" };
+    _timeRange = { type: "relative", value: "now-6h" };
+    _layout = [];
+    _widgets = [];
+    _variables = [];
+    constructor(dashboardId) {
+        this._dashboardId = dashboardId;
+    }
+    title(title) {
+        this._meta.title = title;
+        return this;
+    }
+    description(description) {
+        this._meta.description = description;
+        return this;
+    }
+    tags(tags) {
+        this._meta.tags = tags;
+        return this;
+    }
+    folder(folder) {
+        this._meta.folder = folder;
+        return this;
+    }
+    tenant(tenant) {
+        this._meta.tenant = tenant;
+        return this;
+    }
+    timeRange(timeRange) {
+        this._timeRange = timeRange;
+        return this;
+    }
+    addVariable(variable) {
+        this._variables.push(variable);
+        return this;
+    }
+    addWidget(widget) {
+        if (widget instanceof WidgetBuilder) {
+            this._widgets.push(widget.build());
+        }
+        else {
+            this._widgets.push(widget);
+        }
+        return this;
+    }
+    addLayoutItem(item) {
+        this._layout.push(item);
+        return this;
+    }
+    build() {
+        if (!this._meta.title) {
+            throw new Error("Dashboard must have a title.");
+        }
+        const dashboard = {
+            schemaVersion: 1,
+            dashboardId: this._dashboardId,
+            meta: this._meta,
+            timeRange: this._timeRange,
+            layout: this._layout,
+            widgets: this._widgets,
+        };
+        if (this._variables.length > 0) {
+            dashboard.variables = this._variables;
+        }
+        return dashboard;
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAcA,MAAM,OAAO,aAAa;IAChB,GAAG,CAAS;IACZ,SAAS,CAAS;IAClB,WAAW,CAAU;IACrB,MAAM,CAAe;IACrB,cAAc,CAAuB;IACrC,QAAQ,CAAiB;IACzB,UAAU,CAAsB;IAChC,QAAQ,CAAc;IAE9B,YAAY,EAAU,EAAE,QAAgB;QACtC,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;QACd,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC5B,CAAC;IAED,UAAU,CAAC,UAAkB;QAC3B,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,MAAc,EAAE,OAAoB;QACxC,IAAI,CAAC,MAAM,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa,CAAC,IAAuB;QACnC,IAAI,CAAC,cAAc,GAAG,EAAE,IAAI,EAAE,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,CAAC,KAAa,EAAE,WAAoB;QACzC,IAAI,CAAC,QAAQ,GAAG,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,SAAS,CAAC,SAA6B;QACrC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,CAAC,OAAmB;QACzB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK;QACH,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YAC9D,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;QAC3F,CAAC;QAED,OAAO;YACL,EAAE,EAAE,IAAI,CAAC,GAAG;YACZ,QAAQ,EAAE,IAAI,CAAC,SAAS;YACxB,UAAU,EAAE,IAAI,CAAC,WAAW;YAC5B,KAAK,EAAE,IAAI,CAAC,MAAM;YAClB,aAAa,EAAE,IAAI,CAAC,cAAc;YAClC,OAAO,EAAE,IAAI,CAAC,QAAQ;YACtB,SAAS,EAAE,IAAI,CAAC,UAAU;YAC1B,OAAO,EAAE,IAAI,CAAC,QAAQ;SACvB,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,gBAAgB;IACnB,YAAY,CAAS;IACrB,KAAK,GAAkB,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;IACrC,UAAU,GAAuB,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;IACvE,OAAO,GAAiB,EAAE,CAAC;IAC3B,QAAQ,GAAsB,EAAE,CAAC;IACjC,UAAU,GAAwB,EAAE,CAAC;IAE7C,YAAY,WAAmB;QAC7B,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IAClC,CAAC;IAED,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,WAAW,CAAC,WAAmB;QAC7B,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,WAAW,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,CAAC,IAAc;QACjB,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,CAAC,MAAc;QACnB,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,CAAC,MAAc;QACnB,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,SAAS,CAAC,SAA6B;QACrC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,WAAW,CAAC,QAA2B;QACrC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,SAAS,CAAC,MAAuC;QAC/C,IAAI,MAAM,YAAY,aAAa,EAAE,CAAC;YACpC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;QACrC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC7B,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa,CAAC,IAAgB;QAC5B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK;QACH,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAClD,CAAC;QAED,MAAM,SAAS,GAAuB;YACpC,aAAa,EAAE,CAAC;YAChB,WAAW,EAAE,IAAI,CAAC,YAAY;YAC9B,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,SAAS,EAAE,IAAI,CAAC,UAAU;YAC1B,MAAM,EAAE,IAAI,CAAC,OAAO;YACpB,OAAO,EAAE,IAAI,CAAC,QAAQ;SACvB,CAAC;QAEF,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC/B,SAAS,CAAC,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC;QACxC,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;CACF"}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@d-dash/builder",
+  "version": "0.0.1",
+  "description": "Fluent TypeScript SDK for building d-dash dashboards programmatically",
+  "license": "LGPL-3.0-or-later",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/thienvu18/d-dash.git",
+    "directory": "packages/builder"
+  },
+  "bugs": {
+    "url": "https://github.com/thienvu18/d-dash/issues"
+  },
+  "homepage": "https://github.com/thienvu18/d-dash/tree/main/packages/builder#readme",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "test": "npm run build && node --test $(find tests -name '*.spec.js')"
+  },
+  "keywords": [
+    "dashboard",
+    "runtime",
+    "sdk",
+    "builder",
+    "d-dash"
+  ],
+  "dependencies": {
+    "@d-dash/core": "^0.3.0"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}