@object-ui/plugin-dashboard 17.3.0 → 17.6.0

package/dist/schemaHostProps.d.ts

@@ -0,0 +1,80 @@
+/**
+ * ObjectUI
+ * Copyright (c) 2024-present ObjectStack Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+/**
+ * The props `SchemaRenderer` hands a widget that are NOT DOM attributes
+ * (objectui#4357).
+ *
+ * A dashboard widget is two things at once: an SDUI block reached through
+ * `SchemaRenderer`, and a plain React component a host may render directly.
+ * The React half wants a `...props` spread onto its root element so callers can
+ * pass `aria-*`, `data-*`, `id`, `role`, `className`. The SDUI half means that
+ * spread also receives the node's own metadata — and React writes unknown
+ * lowercase attributes straight to the DOM, stringifying object values. That is
+ * how every KPI card ended up with `schema="[object Object]"`.
+ *
+ * MEASURED at the call site (`packages/react/src/SchemaRenderer.tsx`, the
+ * `React.createElement(Component, …)` block), one render carrying every SDUI key
+ * at once. What a widget receives, and the attribute each one emitted:
+ *
+ *   | prop              | emitted as                   | what it is                           |
+ *   |-------------------|------------------------------|--------------------------------------|
+ *   | `schema`          | `schema="[object Object]"`   | the node itself, injected EVERY render |
+ *   | `events`          | `events="[object Object]"`   | SDUI action metadata (`onClick: […]`) |
+ *   | `props`           | `props="[object Object]"`    | the props container — the renderer already spreads its CONTENTS separately, so the container is pure metadata |
+ *   | `bind`            | `bind="data.revenue"`        | SDUI data-binding path                |
+ *   | `ariaLabel`       | `arialabel="…"`              | camelCase authored form; the renderer already emits the resolved `aria-label` |
+ *   | `ariaDescribedBy` | `ariadescribedby="…"`        | ditto for `aria-describedby`          |
+ *   | `dataSource`      | `datasource="[object Object]"` | the injected data-source ADAPTER    |
+ *
+ * `dataSource` is the one a schema-only measurement misses, and the only one
+ * that leaks on a *production* dashboard rather than an authored edge case.
+ * It does not come from the node: `SchemaRenderer` strips the schema's own
+ * `dataSource` BINDING by name (objectstack#5576) — this is the adapter object
+ * `DashboardRenderer` hands its `SchemaRenderer` call, which arrives through the
+ * renderer's trailing `...props` and lands on whatever the widget spreads onto.
+ * A dashboard rendered without a data source (every test fixture) leaves it
+ * `undefined` and nothing shows; a dashboard rendered with one — every live
+ * deployment — put `datasource="[object Object]"` on the card.
+ *
+ * The line this type draws is **"is the key an HTML attribute name"**. None of
+ * the seven is (the two dashed `aria-*` forms the renderer emits itself are, and
+ * they keep flowing). Everything that IS one stays in the spread and reaches the
+ * DOM exactly as before: `id`, `name`, `role`, `disabled`, `aria-*`, `data-*`,
+ * `className`. Removing the spread instead would have been the wrong fix — it is
+ * the component's only accessibility passthrough.
+ *
+ * The renderer strips its own schema metadata (`type` / `children` / `visible` /
+ * the schema's `dataSource` binding / …) before spreading, so those never
+ * arrive; this type covers only what survives that strip — including the
+ * adapter, which arrives by a different door. Declared here rather than in each component
+ * because two copies of one key list is how a list becomes two disagreeing
+ * lists — the same reason `colorVariants` was extracted. The pin that keeps the
+ * declaration honest for BOTH components is
+ * `__tests__/MetricWidget.domProps.test.tsx`.
+ */
+export interface SchemaHostProps {
+    /** The widget's own schema node, injected by `SchemaRenderer` on every render. */
+    schema?: unknown;
+    /** SDUI data-binding path (`'user.address.city'`). */
+    bind?: unknown;
+    /** SDUI event handlers (`{ onClick: [ActionDef, …] }`) — data, not DOM. */
+    events?: unknown;
+    /** The schema's props container; its contents are spread separately. */
+    props?: unknown;
+    /** Authored camelCase ARIA; the renderer emits the resolved `aria-label`. */
+    ariaLabel?: unknown;
+    /** Authored camelCase ARIA; the renderer emits `aria-describedby`. */
+    ariaDescribedBy?: unknown;
+    /**
+     * The injected data-source adapter, forwarded by `DashboardRenderer` through
+     * `SchemaRenderer`'s trailing props. Neither metric component reads it — the
+     * async, object-aware KPI is `ObjectMetricWidget`.
+     */
+    dataSource?: unknown;
+}
+//# sourceMappingURL=schemaHostProps.d.ts.map

package/dist/schemaHostProps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemaHostProps.d.ts","sourceRoot":"","sources":["../src/schemaHostProps.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,MAAM,WAAW,eAAe;IAC9B,kFAAkF;IAClF,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,sDAAsD;IACtD,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,2EAA2E;IAC3E,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,wEAAwE;IACxE,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,6EAA6E;IAC7E,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,sEAAsE;IACtE,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB"}

package/dist/useConfigPanelTranslation.d.ts

@@ -0,0 +1,35 @@
+/**
+ * ObjectUI
+ * Copyright (c) 2024-present ObjectStack Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+/**
+ * Default English translations for the dashboard config panels.
+ *
+ * Used as the fallback when no `I18nProvider` is available (standalone embeds,
+ * the preview gallery, this package's own unit tests). Every row's key exists
+ * in all ten packs and every row's value equals the `en` pack's.
+ */
+export declare const CONFIG_PANEL_DEFAULT_TRANSLATIONS: Record<string, string>;
+/**
+ * Safe translation hook for the dashboard config panels.
+ *
+ * Falls back to {@link CONFIG_PANEL_DEFAULT_TRANSLATIONS} when no
+ * `I18nProvider` is mounted. The name matches the repo's `use*Translation`
+ * convention, which is what `scripts/check-i18n-call-site-keys.mjs` classifies
+ * as a pack-backed translator — so every key the panels ask for is checked
+ * against the `en` pack, and `scripts/check-i18n-dead-keys.mjs` sees the
+ * namespace as read.
+ */
+export declare const useConfigPanelTranslation: () => {
+    t: (key: string, options?: Record<string, unknown>) => string;
+    language: string;
+} | {
+    t: import('i18next').TFunction<string, undefined>;
+    language: string;
+};
+/** The translate function the schema builders receive. */
+export type ConfigPanelTranslate = (key: string, options?: Record<string, unknown>) => string;
+//# sourceMappingURL=useConfigPanelTranslation.d.ts.map

package/dist/useConfigPanelTranslation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useConfigPanelTranslation.d.ts","sourceRoot":"","sources":["../src/useConfigPanelTranslation.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AA+CH;;;;;;GAMG;AACH,eAAO,MAAM,iCAAiC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAuHpE,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,yBAAyB;4BA1LrC,CAAC;;;;;CA6LD,CAAC;AAEF,0DAA0D;AAC1D,MAAM,MAAM,oBAAoB,GAAG,CACjC,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAC9B,MAAM,CAAC"}

package/dist/utils.d.ts

@@ -12,6 +12,40 @@ export declare function isObjectProvider(widgetData: unknown): widgetData is {
     aggregate?: any;
     filter?: any;
 };
+/**
+ * A record key → a human column header: `unit_price` / `unitPrice` → "Unit Price".
+ *
+ * Single home for the convention, because both halves of the `table` widget
+ * family need it and they must agree: the object-bound path normalizes an
+ * author's `string[]` shorthand with it (`normalizeColumns`), and the static
+ * path derives headers with it when no columns were declared at all.
+ */
+export declare function humanizeFieldKey(key: string): string;
+/**
+ * Columns for a STATIC (inline `options.data`) table widget whose author
+ * declared none — objectui#4618.
+ *
+ * `DataTableSchema.columns` is a REQUIRED key (`@object-ui/types`
+ * `data-display.ts`), and a `data-table` handed rows but no columns draws one
+ * empty `tr` per row: no `th`, no `td`, nothing readable. Both dashboard
+ * surfaces built exactly that node whenever the widget carried only
+ * `options.data`, so a documented authoring surface rendered a silent blank.
+ *
+ * The object-bound half of the same widget family has always derived columns
+ * from the fetched rows when none were declared (`ObjectDataTable`), so this is
+ * that behaviour reaching the static half — not a new capability. Keys come
+ * from the FIRST row for the same reason it does there: the first record is the
+ * shape the author is describing, and scanning every row would let one ragged
+ * record widen the table.
+ *
+ * `_`-prefixed keys are internal bookkeeping and stay out. Non-record rows
+ * (strings, numbers, arrays) have no keys to name, so they derive nothing and
+ * the table renders its own empty state rather than a header row of noise.
+ */
+export declare function deriveStaticTableColumns(rows: unknown): Array<{
+    header: string;
+    accessorKey: string;
+}>;
 export { resolveDateMacros, resolveFilterPlaceholders } from '@object-ui/core';
 export { shiftFilterByCompareTo, compareToTrendLabelKey, type CompareToConfig, } from '@object-ui/core';
 /**

package/dist/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,4FAA4F;AAC5F,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,OAAO,GAAG,UAAU,IAAI;IAAE,QAAQ,EAAE,QAAQ,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,GAAG,CAAC;IAAC,MAAM,CAAC,EAAE,GAAG,CAAA;CAAE,CAO1I;AAUD,OAAO,EAAE,iBAAiB,EAAE,yBAAyB,EAAE,MAAM,iBAAiB,CAAC;AAG/E,OAAO,EACL,sBAAsB,EACtB,sBAAsB,EACtB,KAAK,eAAe,GACrB,MAAM,iBAAiB,CAAC;AAEzB;;;;;;;;;;;;GAYG;AACH,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAClC,QAAQ,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAClC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,IAAI,GAAG,MAAM,GAAG,SAAS,CAAA;CAAE,GAAG,IAAI,CAkBhE"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,4FAA4F;AAC5F,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,OAAO,GAAG,UAAU,IAAI;IAAE,QAAQ,EAAE,QAAQ,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,GAAG,CAAC;IAAC,MAAM,CAAC,EAAE,GAAG,CAAA;CAAE,CAO1I;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CASpD;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,OAAO,GAAG,KAAK,CAAC;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,CAAC,CAOtG;AAUD,OAAO,EAAE,iBAAiB,EAAE,yBAAyB,EAAE,MAAM,iBAAiB,CAAC;AAG/E,OAAO,EACL,sBAAsB,EACtB,sBAAsB,EACtB,KAAK,eAAe,GACrB,MAAM,iBAAiB,CAAC;AAEzB;;;;;;;;;;;;GAYG;AACH,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAClC,QAAQ,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAClC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,IAAI,GAAG,MAAM,GAAG,SAAS,CAAA;CAAE,GAAG,IAAI,CAkBhE"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@object-ui/plugin-dashboard",
-  "version": "17.3.0",
+  "version": "17.6.0",
   "type": "module",
   "license": "MIT",
   "description": "Dashboard plugin for Object UI",
@@ -19,16 +19,16 @@
     "@dnd-kit/sortable": "^10.0.0",
     "@dnd-kit/utilities": "^3.2.2",
     "clsx": "^2.1.1",
-    "lucide-react": "^1.28.0",
+    "lucide-react": "^1.31.0",
     "react": "19.2.8",
     "react-dom": "19.2.8",
     "tailwind-merge": "^3.6.0",
-    "@object-ui/components": "17.3.0",
-    "@object-ui/core": "17.3.0",
-    "@object-ui/fields": "17.3.0",
-    "@object-ui/i18n": "17.3.0",
-    "@object-ui/react": "17.3.0",
-    "@object-ui/types": "17.3.0"
+    "@object-ui/components": "17.6.0",
+    "@object-ui/core": "17.6.0",
+    "@object-ui/fields": "17.6.0",
+    "@object-ui/i18n": "17.6.0",
+    "@object-ui/react": "17.6.0",
+    "@object-ui/types": "17.6.0"
   },
   "peerDependencies": {
     "react": "^18.0.0 || ^19.0.0",
@@ -36,13 +36,15 @@
     "react-grid-layout": "^2.2.0 || ^1.4.0"
   },
   "devDependencies": {
-    "@objectstack/spec": "^17.0.0-rc.2",
+    "@objectstack/spec": "^17.0.0",
     "@types/react-grid-layout": "^2.1.0",
     "@vitejs/plugin-react": "^6.0.5",
     "react-grid-layout": "^2.2.4",
     "typescript": "^6.0.3",
-    "vite": "^8.2.0",
-    "vite-plugin-dts": "^5.0.3"
+    "vite": "^8.2.1",
+    "vite-plugin-dts": "^5.0.3",
+    "@object-ui/plugin-charts": "17.6.0",
+    "@object-ui/sdui-parser": "17.6.0"
   },
   "keywords": [
     "objectui",
@@ -79,7 +81,7 @@
   ],
   "scripts": {
     "build": "vite build",
-    "type-check": "tsc --noEmit",
+    "type-check": "tsc --noEmit && tsc -p tsconfig.test.json",
     "test": "vitest run",
     "lint": "eslint ."
   }