@silverpoint/core 0.1.0 → 0.2.0

package/README.md

@@ -0,0 +1,37 @@
+# @silverpoint/core
+
+The framework-free engine of **silverpoint**: the geometry, scales, interaction and types behind
+every chart. The charts themselves are rendered by the adapters, and this package holds no DOM
+code and no framework code.
+
+You rarely install it by hand, because every adapter depends on it:
+
+| Framework | Install |
+|---|---|
+| React | `npm install @silverpoint/react @silverpoint/grounds @silverpoint/fonts` |
+| Vue | `npm install @silverpoint/vue @silverpoint/grounds @silverpoint/fonts` |
+| Angular | `npm install @silverpoint/angular @silverpoint/grounds @silverpoint/fonts` |
+
+Install it directly when you need its types in your own code:
+
+```sh
+npm install @silverpoint/core
+```
+
+```ts
+import type { ActiveItem, ProviderConfig, SubstrateName } from '@silverpoint/core';
+
+export const config: ProviderConfig = { ground: 'silverpoint', substrate: 'cream', mode: 'ink' };
+export const substrates: SubstrateName[] = ['cream', 'green', 'blue', 'ochre'];
+export const describe = (item: ActiveItem) => `${item.seriesKey} #${item.index}: ${item.value}`;
+```
+
+The geometry of the data is exact: the ground's hand-drawn inking only touches strokes that
+carry no data, and it is deterministic for a given seed.
+
+See [`@silverpoint/react`](https://www.npmjs.com/package/@silverpoint/react),
+[`@silverpoint/vue`](https://www.npmjs.com/package/@silverpoint/vue) and
+[`@silverpoint/angular`](https://www.npmjs.com/package/@silverpoint/angular) for usage, and the
+[repository](https://github.com/ecrespo/silverpoint) for the specifications.
+
+MIT.

package/dist/dashboard-demos.d.ts

@@ -0,0 +1,103 @@
+import { C as CommonChartProps, D as DashboardProps } from './types-D1hjElfL.js';
+
+/** One child of a reference dashboard: the catalog chart it holds, by name, and its props. */
+interface DashboardDemoChild {
+    readonly cell: string;
+    /** A catalog chart name (`LineChart`); each adapter maps it to its own component. */
+    readonly chart: string;
+    /** Props only: every chart renders its demo data (REQ-093), so no child carries rows. */
+    readonly props: Readonly<CommonChartProps & Record<string, unknown>>;
+}
+/** A reference dashboard: plain data, frozen (I-9), shared by fixtures, examples and docs. */
+interface DashboardDemo {
+    readonly props: DashboardProps;
+    readonly children: readonly DashboardDemoChild[];
+}
+/**
+ * The reference dashboards of Data Model §4. `ops` is the DD-007 weight reference; `mixed-spans`
+ * leaves a row-end gap at `md` to prove that cells are never reordered (REQ-203). Spans are given
+ * per breakpoint, so none is clamped at `sm`.
+ */
+declare const DASHBOARD_DEMOS: {
+    'kpi-strip': {
+        props: {
+            id: string;
+            title: string;
+            layout: {
+                cells: ({
+                    id: string;
+                    colSpan?: undefined;
+                } | {
+                    id: string;
+                    colSpan: {
+                        md: number;
+                        lg: number;
+                    };
+                })[];
+            };
+        };
+        children: DashboardDemoChild[];
+    };
+    ops: {
+        props: {
+            id: string;
+            title: string;
+            description: string;
+            link: {
+                key: string;
+            };
+            layout: {
+                cells: ({
+                    id: string;
+                    colSpan?: undefined;
+                    rowSpan?: undefined;
+                } | {
+                    id: string;
+                    colSpan: {
+                        md: number;
+                        lg: number;
+                    };
+                    rowSpan: number;
+                } | {
+                    id: string;
+                    colSpan: {
+                        md: number;
+                        lg: number;
+                    };
+                    rowSpan?: undefined;
+                })[];
+            };
+        };
+        children: DashboardDemoChild[];
+    };
+    'mixed-spans': {
+        props: {
+            id: string;
+            title: string;
+            layout: {
+                columns: {
+                    lg: number;
+                };
+                cells: ({
+                    id: string;
+                    colSpan?: undefined;
+                } | {
+                    id: string;
+                    colSpan: {
+                        md: number;
+                        lg: number;
+                    };
+                })[];
+            };
+        };
+        children: {
+            cell: string;
+            chart: string;
+            props: {
+                title: string;
+            };
+        }[];
+    };
+};
+
+export { DASHBOARD_DEMOS, type DashboardDemo, type DashboardDemoChild };

package/dist/dashboard-demos.js

@@ -0,0 +1,94 @@
+// src/dashboard/demo.ts
+function deepFreeze(value) {
+  if (value !== null && typeof value === "object") {
+    for (const inner of Object.values(value)) deepFreeze(inner);
+    Object.freeze(value);
+  }
+  return value;
+}
+var kpi = (cell, title, metric, delta) => ({ cell, chart: "KpiCard", props: { title, metric, delta } });
+var DASHBOARD_DEMOS = /* @__PURE__ */ deepFreeze({
+  "kpi-strip": {
+    props: {
+      id: "kpi-strip",
+      title: "This week",
+      layout: { cells: [{ id: "revenue" }, { id: "orders" }, { id: "users" }, { id: "refunds" }, { id: "trend", colSpan: { md: 2, lg: 4 } }] }
+    },
+    children: [
+      kpi("revenue", "Revenue", "thousands", 6.4),
+      kpi("orders", "Orders", "orders per day", 8.2),
+      kpi("users", "Active users", "hundreds", 2.1),
+      kpi("refunds", "Refunds", "per day", -1.5),
+      { cell: "trend", chart: "LineChart", props: { title: "Hits per hour" } }
+    ]
+  },
+  ops: {
+    props: {
+      id: "ops",
+      title: "Operations",
+      description: "Service health over the last day: headline figures, traffic, errors and load.",
+      link: { key: "hour" },
+      layout: {
+        cells: [
+          { id: "revenue" },
+          { id: "users" },
+          { id: "churn" },
+          { id: "nps" },
+          { id: "traffic", colSpan: { md: 2, lg: 3 }, rowSpan: 2 },
+          { id: "errors" },
+          { id: "share" },
+          { id: "load", colSpan: { md: 2, lg: 2 } },
+          { id: "hosts" },
+          { id: "uptime" },
+          { id: "activity", colSpan: { md: 2, lg: 2 } },
+          { id: "capacity" }
+        ]
+      }
+    },
+    children: [
+      kpi("revenue", "Revenue", "thousands", 6.4),
+      kpi("users", "Active users", "hundreds", 2.1),
+      kpi("churn", "Churn", "per cent", -0.4),
+      kpi("nps", "NPS", "points", 3),
+      { cell: "traffic", chart: "LineChart", props: { title: "Traffic", footerLeft: "hits per hour", footerRight: "last 24 h" } },
+      { cell: "errors", chart: "BarChart", props: { title: "Errors" } },
+      { cell: "share", chart: "DonutChart", props: { title: "Traffic share" } },
+      { cell: "load", chart: "HeatmapChart", props: { title: "Load by hour" } },
+      { cell: "hosts", chart: "SparklineRows", props: { title: "Hosts" } },
+      { cell: "uptime", chart: "GaugeArc", props: { title: "Uptime" } },
+      { cell: "activity", chart: "ActivityGrid", props: { title: "Deploys" } },
+      { cell: "capacity", chart: "MeterChart", props: { title: "Capacity" } }
+    ]
+  },
+  "mixed-spans": {
+    props: {
+      id: "mixed-spans",
+      title: "Mixed spans",
+      layout: {
+        columns: { lg: 3 },
+        cells: [
+          { id: "one" },
+          { id: "two", colSpan: { md: 2, lg: 2 } },
+          { id: "three" },
+          { id: "four", colSpan: { md: 2, lg: 3 } },
+          { id: "five" },
+          { id: "six", colSpan: { md: 2, lg: 2 } },
+          { id: "seven" }
+        ]
+      }
+    },
+    children: [
+      { cell: "one", chart: "StepChart", props: { title: "Step" } },
+      { cell: "two", chart: "AreaChart", props: { title: "Area" } },
+      { cell: "three", chart: "FunnelChart", props: { title: "Funnel" } },
+      { cell: "four", chart: "BarChart", props: { title: "Bars" } },
+      { cell: "five", chart: "RadarChart", props: { title: "Radar" } },
+      { cell: "six", chart: "StreamChart", props: { title: "Stream" } },
+      { cell: "seven", chart: "MeterChart", props: { title: "Meter" } }
+    ]
+  }
+});
+
+export { DASHBOARD_DEMOS };
+//# sourceMappingURL=dashboard-demos.js.map
+//# sourceMappingURL=dashboard-demos.js.map

package/dist/dashboard-demos.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/dashboard/demo.ts"],"names":[],"mappings":";AAkBA,SAAS,WAAc,KAAA,EAAa;AAClC,EAAA,IAAI,KAAA,KAAU,IAAA,IAAQ,OAAO,KAAA,KAAU,QAAA,EAAU;AAC/C,IAAA,KAAA,MAAW,SAAS,MAAA,CAAO,MAAA,CAAO,KAAK,CAAA,aAAc,KAAK,CAAA;AAC1D,IAAA,MAAA,CAAO,OAAO,KAAK,CAAA;AAAA,EACrB;AACA,EAAA,OAAO,KAAA;AACT;AAEA,IAAM,GAAA,GAAM,CAAC,IAAA,EAAc,KAAA,EAAe,QAAgB,KAAA,MAAuC,EAAE,IAAA,EAAM,KAAA,EAAO,WAAW,KAAA,EAAO,EAAE,KAAA,EAAO,MAAA,EAAQ,OAAM,EAAE,CAAA;AAOpJ,IAAM,kCAAkC,UAAA,CAAW;AAAA,EACxD,WAAA,EAAa;AAAA,IACX,KAAA,EAAO;AAAA,MACL,EAAA,EAAI,WAAA;AAAA,MACJ,KAAA,EAAO,WAAA;AAAA,MACP,MAAA,EAAQ,EAAE,KAAA,EAAO,CAAC,EAAE,EAAA,EAAI,SAAA,EAAU,EAAG,EAAE,EAAA,EAAI,QAAA,EAAS,EAAG,EAAE,EAAA,EAAI,OAAA,EAAQ,EAAG,EAAE,EAAA,EAAI,SAAA,EAAU,EAAG,EAAE,IAAI,OAAA,EAAS,OAAA,EAAS,EAAE,EAAA,EAAI,CAAA,EAAG,EAAA,EAAI,CAAA,EAAE,EAAG,CAAA;AAAE,KACzI;AAAA,IACA,QAAA,EAAU;AAAA,MACR,GAAA,CAAI,SAAA,EAAW,SAAA,EAAW,WAAA,EAAa,GAAG,CAAA;AAAA,MAC1C,GAAA,CAAI,QAAA,EAAU,QAAA,EAAU,gBAAA,EAAkB,GAAG,CAAA;AAAA,MAC7C,GAAA,CAAI,OAAA,EAAS,cAAA,EAAgB,UAAA,EAAY,GAAG,CAAA;AAAA,MAC5C,GAAA,CAAI,SAAA,EAAW,SAAA,EAAW,SAAA,EAAW,IAAI,CAAA;AAAA,MACzC,EAAE,MAAM,OAAA,EAAS,KAAA,EAAO,aAAa,KAAA,EAAO,EAAE,KAAA,EAAO,eAAA,EAAgB;AAAE;AACzE,GACF;AAAA,EACA,GAAA,EAAK;AAAA,IACH,KAAA,EAAO;AAAA,MACL,EAAA,EAAI,KAAA;AAAA,MACJ,KAAA,EAAO,YAAA;AAAA,MACP,WAAA,EAAa,+EAAA;AAAA,MACb,IAAA,EAAM,EAAE,GAAA,EAAK,MAAA,EAAO;AAAA,MACpB,MAAA,EAAQ;AAAA,QACN,KAAA,EAAO;AAAA,UACL,EAAE,IAAI,SAAA,EAAU;AAAA,UAChB,EAAE,IAAI,OAAA,EAAQ;AAAA,UACd,EAAE,IAAI,OAAA,EAAQ;AAAA,UACd,EAAE,IAAI,KAAA,EAAM;AAAA,UACZ,EAAE,EAAA,EAAI,SAAA,EAAW,OAAA,EAAS,EAAE,EAAA,EAAI,CAAA,EAAG,EAAA,EAAI,CAAA,EAAE,EAAG,OAAA,EAAS,CAAA,EAAE;AAAA,UACvD,EAAE,IAAI,QAAA,EAAS;AAAA,UACf,EAAE,IAAI,OAAA,EAAQ;AAAA,UACd,EAAE,IAAI,MAAA,EAAQ,OAAA,EAAS,EAAE,EAAA,EAAI,CAAA,EAAG,EAAA,EAAI,CAAA,EAAE,EAAE;AAAA,UACxC,EAAE,IAAI,OAAA,EAAQ;AAAA,UACd,EAAE,IAAI,QAAA,EAAS;AAAA,UACf,EAAE,IAAI,UAAA,EAAY,OAAA,EAAS,EAAE,EAAA,EAAI,CAAA,EAAG,EAAA,EAAI,CAAA,EAAE,EAAE;AAAA,UAC5C,EAAE,IAAI,UAAA;AAAW;AACnB;AACF,KACF;AAAA,IACA,QAAA,EAAU;AAAA,MACR,GAAA,CAAI,SAAA,EAAW,SAAA,EAAW,WAAA,EAAa,GAAG,CAAA;AAAA,MAC1C,GAAA,CAAI,OAAA,EAAS,cAAA,EAAgB,UAAA,EAAY,GAAG,CAAA;AAAA,MAC5C,GAAA,CAAI,OAAA,EAAS,OAAA,EAAS,UAAA,EAAY,IAAI,CAAA;AAAA,MACtC,GAAA,CAAI,KAAA,EAAO,KAAA,EAAO,QAAA,EAAU,CAAC,CAAA;AAAA,MAC7B,EAAE,IAAA,EAAM,SAAA,EAAW,KAAA,EAAO,WAAA,EAAa,KAAA,EAAO,EAAE,KAAA,EAAO,SAAA,EAAW,UAAA,EAAY,eAAA,EAAiB,WAAA,EAAa,aAAY,EAAE;AAAA,MAC1H,EAAE,MAAM,QAAA,EAAU,KAAA,EAAO,YAAY,KAAA,EAAO,EAAE,KAAA,EAAO,QAAA,EAAS,EAAE;AAAA,MAChE,EAAE,MAAM,OAAA,EAAS,KAAA,EAAO,cAAc,KAAA,EAAO,EAAE,KAAA,EAAO,eAAA,EAAgB,EAAE;AAAA,MACxE,EAAE,MAAM,MAAA,EAAQ,KAAA,EAAO,gBAAgB,KAAA,EAAO,EAAE,KAAA,EAAO,cAAA,EAAe,EAAE;AAAA,MACxE,EAAE,MAAM,OAAA,EAAS,KAAA,EAAO,iBAAiB,KAAA,EAAO,EAAE,KAAA,EAAO,OAAA,EAAQ,EAAE;AAAA,MACnE,EAAE,MAAM,QAAA,EAAU,KAAA,EAAO,YAAY,KAAA,EAAO,EAAE,KAAA,EAAO,QAAA,EAAS,EAAE;AAAA,MAChE,EAAE,MAAM,UAAA,EAAY,KAAA,EAAO,gBAAgB,KAAA,EAAO,EAAE,KAAA,EAAO,SAAA,EAAU,EAAE;AAAA,MACvE,EAAE,MAAM,UAAA,EAAY,KAAA,EAAO,cAAc,KAAA,EAAO,EAAE,KAAA,EAAO,UAAA,EAAW;AAAE;AACxE,GACF;AAAA,EACA,aAAA,EAAe;AAAA,IACb,KAAA,EAAO;AAAA,MACL,EAAA,EAAI,aAAA;AAAA,MACJ,KAAA,EAAO,aAAA;AAAA,MACP,MAAA,EAAQ;AAAA,QACN,OAAA,EAAS,EAAE,EAAA,EAAI,CAAA,EAAE;AAAA,QACjB,KAAA,EAAO;AAAA,UACL,EAAE,IAAI,KAAA,EAAM;AAAA,UACZ,EAAE,IAAI,KAAA,EAAO,OAAA,EAAS,EAAE,EAAA,EAAI,CAAA,EAAG,EAAA,EAAI,CAAA,EAAE,EAAE;AAAA,UACvC,EAAE,IAAI,OAAA,EAAQ;AAAA,UACd,EAAE,IAAI,MAAA,EAAQ,OAAA,EAAS,EAAE,EAAA,EAAI,CAAA,EAAG,EAAA,EAAI,CAAA,EAAE,EAAE;AAAA,UACxC,EAAE,IAAI,MAAA,EAAO;AAAA,UACb,EAAE,IAAI,KAAA,EAAO,OAAA,EAAS,EAAE,EAAA,EAAI,CAAA,EAAG,EAAA,EAAI,CAAA,EAAE,EAAE;AAAA,UACvC,EAAE,IAAI,OAAA;AAAQ;AAChB;AACF,KACF;AAAA,IACA,QAAA,EAAU;AAAA,MACR,EAAE,MAAM,KAAA,EAAO,KAAA,EAAO,aAAa,KAAA,EAAO,EAAE,KAAA,EAAO,MAAA,EAAO,EAAE;AAAA,MAC5D,EAAE,MAAM,KAAA,EAAO,KAAA,EAAO,aAAa,KAAA,EAAO,EAAE,KAAA,EAAO,MAAA,EAAO,EAAE;AAAA,MAC5D,EAAE,MAAM,OAAA,EAAS,KAAA,EAAO,eAAe,KAAA,EAAO,EAAE,KAAA,EAAO,QAAA,EAAS,EAAE;AAAA,MAClE,EAAE,MAAM,MAAA,EAAQ,KAAA,EAAO,YAAY,KAAA,EAAO,EAAE,KAAA,EAAO,MAAA,EAAO,EAAE;AAAA,MAC5D,EAAE,MAAM,MAAA,EAAQ,KAAA,EAAO,cAAc,KAAA,EAAO,EAAE,KAAA,EAAO,OAAA,EAAQ,EAAE;AAAA,MAC/D,EAAE,MAAM,KAAA,EAAO,KAAA,EAAO,eAAe,KAAA,EAAO,EAAE,KAAA,EAAO,QAAA,EAAS,EAAE;AAAA,MAChE,EAAE,MAAM,OAAA,EAAS,KAAA,EAAO,cAAc,KAAA,EAAO,EAAE,KAAA,EAAO,OAAA,EAAQ;AAAE;AAClE;AAEJ,CAAyC","file":"dashboard-demos.js","sourcesContent":["import type { CommonChartProps } from '../types';\nimport type { DashboardProps } from './types';\n\n/** One child of a reference dashboard: the catalog chart it holds, by name, and its props. */\nexport interface DashboardDemoChild {\n  readonly cell: string;\n  /** A catalog chart name (`LineChart`); each adapter maps it to its own component. */\n  readonly chart: string;\n  /** Props only: every chart renders its demo data (REQ-093), so no child carries rows. */\n  readonly props: Readonly<CommonChartProps & Record<string, unknown>>;\n}\n\n/** A reference dashboard: plain data, frozen (I-9), shared by fixtures, examples and docs. */\nexport interface DashboardDemo {\n  readonly props: DashboardProps;\n  readonly children: readonly DashboardDemoChild[];\n}\n\nfunction deepFreeze<T>(value: T): T {\n  if (value !== null && typeof value === 'object') {\n    for (const inner of Object.values(value)) deepFreeze(inner);\n    Object.freeze(value);\n  }\n  return value;\n}\n\nconst kpi = (cell: string, title: string, metric: string, delta: number): DashboardDemoChild => ({ cell, chart: 'KpiCard', props: { title, metric, delta } });\n\n/**\n * The reference dashboards of Data Model §4. `ops` is the DD-007 weight reference; `mixed-spans`\n * leaves a row-end gap at `md` to prove that cells are never reordered (REQ-203). Spans are given\n * per breakpoint, so none is clamped at `sm`.\n */\nexport const DASHBOARD_DEMOS = /* @__PURE__ */ deepFreeze({\n  'kpi-strip': {\n    props: {\n      id: 'kpi-strip',\n      title: 'This week',\n      layout: { cells: [{ id: 'revenue' }, { id: 'orders' }, { id: 'users' }, { id: 'refunds' }, { id: 'trend', colSpan: { md: 2, lg: 4 } }] },\n    },\n    children: [\n      kpi('revenue', 'Revenue', 'thousands', 6.4),\n      kpi('orders', 'Orders', 'orders per day', 8.2),\n      kpi('users', 'Active users', 'hundreds', 2.1),\n      kpi('refunds', 'Refunds', 'per day', -1.5),\n      { cell: 'trend', chart: 'LineChart', props: { title: 'Hits per hour' } },\n    ],\n  },\n  ops: {\n    props: {\n      id: 'ops',\n      title: 'Operations',\n      description: 'Service health over the last day: headline figures, traffic, errors and load.',\n      link: { key: 'hour' },\n      layout: {\n        cells: [\n          { id: 'revenue' },\n          { id: 'users' },\n          { id: 'churn' },\n          { id: 'nps' },\n          { id: 'traffic', colSpan: { md: 2, lg: 3 }, rowSpan: 2 },\n          { id: 'errors' },\n          { id: 'share' },\n          { id: 'load', colSpan: { md: 2, lg: 2 } },\n          { id: 'hosts' },\n          { id: 'uptime' },\n          { id: 'activity', colSpan: { md: 2, lg: 2 } },\n          { id: 'capacity' },\n        ],\n      },\n    },\n    children: [\n      kpi('revenue', 'Revenue', 'thousands', 6.4),\n      kpi('users', 'Active users', 'hundreds', 2.1),\n      kpi('churn', 'Churn', 'per cent', -0.4),\n      kpi('nps', 'NPS', 'points', 3),\n      { cell: 'traffic', chart: 'LineChart', props: { title: 'Traffic', footerLeft: 'hits per hour', footerRight: 'last 24 h' } },\n      { cell: 'errors', chart: 'BarChart', props: { title: 'Errors' } },\n      { cell: 'share', chart: 'DonutChart', props: { title: 'Traffic share' } },\n      { cell: 'load', chart: 'HeatmapChart', props: { title: 'Load by hour' } },\n      { cell: 'hosts', chart: 'SparklineRows', props: { title: 'Hosts' } },\n      { cell: 'uptime', chart: 'GaugeArc', props: { title: 'Uptime' } },\n      { cell: 'activity', chart: 'ActivityGrid', props: { title: 'Deploys' } },\n      { cell: 'capacity', chart: 'MeterChart', props: { title: 'Capacity' } },\n    ],\n  },\n  'mixed-spans': {\n    props: {\n      id: 'mixed-spans',\n      title: 'Mixed spans',\n      layout: {\n        columns: { lg: 3 },\n        cells: [\n          { id: 'one' },\n          { id: 'two', colSpan: { md: 2, lg: 2 } },\n          { id: 'three' },\n          { id: 'four', colSpan: { md: 2, lg: 3 } },\n          { id: 'five' },\n          { id: 'six', colSpan: { md: 2, lg: 2 } },\n          { id: 'seven' },\n        ],\n      },\n    },\n    children: [\n      { cell: 'one', chart: 'StepChart', props: { title: 'Step' } },\n      { cell: 'two', chart: 'AreaChart', props: { title: 'Area' } },\n      { cell: 'three', chart: 'FunnelChart', props: { title: 'Funnel' } },\n      { cell: 'four', chart: 'BarChart', props: { title: 'Bars' } },\n      { cell: 'five', chart: 'RadarChart', props: { title: 'Radar' } },\n      { cell: 'six', chart: 'StreamChart', props: { title: 'Stream' } },\n      { cell: 'seven', chart: 'MeterChart', props: { title: 'Meter' } },\n    ],\n  },\n} satisfies Record<string, DashboardDemo>);\n"]}