@devicechain/widgets 0.14.0-0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright The DeviceChain Authors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,159 @@
+<!--
+Copyright The DeviceChain Authors
+SPDX-License-Identifier: Apache-2.0
+-->
+
+# @devicechain/widgets
+
+React dashboard widgets for DeviceChain, plus the renderer that lays a board out.
+Eleven widgets across five channels — charts, gauges, tables, alarm views, a
+command button, an entity selector and a map — all bound to live data through
+[`@devicechain/dashboards`](https://www.npmjs.com/package/@devicechain/dashboards).
+
+Themed entirely with CSS custom properties. No Tailwind, no global styles, no
+opinions about your app's shell — these are meant to be embedded.
+
+```bash
+npm install @devicechain/widgets @devicechain/dashboards @devicechain/client graphql react react-dom
+```
+
+## Render a board
+
+```tsx
+import { DashboardRenderer } from '@devicechain/widgets';
+import { DashboardHub, parseDashboardDefinition } from '@devicechain/dashboards';
+
+const hub = new DashboardHub({ resolver, authorities: user.scopes });
+const definition = parseDashboardDefinition(json);
+
+<DashboardRenderer definition={definition} hub={hub} actions={hub} />;
+```
+
+Omit `actions` for a strictly read-only mount and the acting widgets — alarm
+acknowledge, command send — render without their controls. That is the whole
+opt-in: a viewer that never passes `actions` cannot write, regardless of what the
+board contains.
+
+Or drive a single widget yourself with `ConnectedWidget`, and look components up
+by type through `WIDGET_REGISTRY` and its per-channel siblings.
+
+## The widgets
+
+| channel | widgets |
+| --- | --- |
+| measurement | `timeseries-chart`, `gauge`, `latest-card`, `table`, `label`, `image` |
+| alarm | `alarm-table`, `alarm-count` |
+| control | `command-button` |
+| selection | `entity-selector` |
+| location | `map` |
+
+Charts and gauges are [Apache ECharts](https://echarts.apache.org); the map is
+[MapLibre GL](https://maplibre.org), loaded lazily so a board with no map on it
+downloads none of it.
+
+`WIDGET_OPTIONS` is the typed schema for every widget's options bag —
+`validateWidgetOptions` reports exactly where a stored bag disagrees with what the
+renderer expects, which is what lets an authoring UI show a problem instead of
+rendering something wrong.
+
+## Rendering a map: one required piece of host wiring
+
+MapLibre parses tiles in a web worker, and it derives that worker's URL at
+**runtime** from its own module URL — a computed string no bundler can trace. So
+no bundler emits the file, the browser 404s it, `new Worker()` does not throw, and
+the map renders as an empty box with nothing in the console. It is a famously
+quiet failure, and it is not something this package can paper over: only your
+bundler can emit that file.
+
+So the worker URL comes from you, through a provider. **On Vite that is one
+import:**
+
+```tsx
+import { MapRuntimeProvider } from '@devicechain/widgets';
+import { viteMapRuntime } from '@devicechain/widgets/vite';
+
+<MapRuntimeProvider runtime={viteMapRuntime}>
+  <DashboardRenderer definition={definition} hub={hub} />
+</MapRuntimeProvider>;
+```
+
+On any other bundler you supply the URL yourself. There is one requirement, and
+it is the whole of the difficulty: MapLibre loads that URL as a **module worker**,
+so whatever you serve there must be a module with no unresolved imports left in
+it. `maplibre-gl/dist/maplibre-gl-worker.mjs` is not one on its own — its first
+line imports a sibling, `maplibre-gl-shared.mjs`.
+
+**So do not point at a lone copy of the worker file**, and in particular do not
+reach for `new URL('maplibre-gl/dist/maplibre-gl-worker.mjs', import.meta.url)`.
+It looks right and it is not: webpack copies the file as an asset, the sibling is
+never emitted, and the worker dies on its own first line — with a 200 on the
+worker URL, a canvas on screen, markers placed, the build exited 0 and nothing in
+the console. The map just has no map in it.
+
+Two recipes that work. On webpack, give the worker its own entry, so webpack
+bundles its imports into it:
+
+```js
+entry: {
+  main: './src/index.tsx',
+  'maplibre-worker': 'maplibre-gl/dist/maplibre-gl-worker.mjs',
+},
+output: {
+  filename: (data) =>
+    data.chunk.name === 'maplibre-worker' ? 'maplibre-worker.js' : '[name].[contenthash].js',
+},
+```
+
+…and point at the filename you chose:
+
+```tsx
+const runtime = { workerUrl: '/maplibre-worker.js' };
+```
+
+Or, on any bundler at all, copy the two files yourself:
+
+```tsx
+// BOTH, under their own names, into one served directory:
+//   maplibre-gl/dist/maplibre-gl-worker.mjs  ->  public/vendor/
+//   maplibre-gl/dist/maplibre-gl-shared.mjs  ->  public/vendor/
+const runtime = {
+  workerUrl: '/vendor/maplibre-gl-worker.mjs',
+  loadStyles: () => import('maplibre-gl/dist/maplibre-gl.css'),
+};
+```
+
+`loadStyles` is optional — import MapLibre's stylesheet yourself if you would
+rather have it eagerly. Supplying it here keeps the 83 KB (10.7 KB gzipped) on the
+map's lazy chunk, so a viewer who opens no map downloads none of it.
+
+**A map widget with no provider above it renders a visible notice, not a blank
+canvas.** That is deliberate: an unwired host should be able to see what is
+missing.
+
+`maplibre-gl` is a peer dependency, so your app and this package share exactly one
+copy. A worker built from one version driving a main thread on another is the same
+blank map by a different route.
+
+## Basemap tiles
+
+`TenantBasemapProvider` supplies the tile source. It is genuinely optional — with
+no provider the map falls back to a plain view — and the resolution cascade lives
+in `@devicechain/client` so every DeviceChain surface resolves an override over
+the tenant default identically.
+
+## Theming
+
+Every colour, radius and font comes from a CSS custom property, so a host restyles
+widgets by setting variables on any ancestor. The DeviceChain values ship as
+[`@devicechain/brand`](https://www.npmjs.com/package/@devicechain/brand); nothing
+here requires them.
+
+## Compatibility
+
+React 19, ESM only, built for bundler resolution (Vite, webpack, Rollup, esbuild).
+The emitted declarations use extensionless specifiers, which resolve under
+TypeScript's `bundler` module resolution and **not** under `node16`/`nodenext`.
+
+## License
+
+Apache-2.0. See [LICENSE](./LICENSE).

package/dist/basemap-context.d.ts

@@ -0,0 +1,27 @@
+import { type ReactNode } from 'react';
+import type { Basemap } from '@devicechain/client';
+/**
+ * Supplies the tenant's effective basemap to every map widget beneath it.
+ *
+ * Both hosts install this ONCE, high in the tree, rather than at each place they
+ * render a widget: the console from its TenantProvider, the /dash viewer app from the
+ * one place it mounts a DashboardRenderer.
+ *
+ * 🔴 That placement is the whole safety argument, because a host that forgets this
+ * does NOT fail loudly — its maps simply render as they did before the tenant setting
+ * existed, on that surface only. Wrapping individual render sites is the version that
+ * silently half-works; there is no render site to forget from the top of the tree.
+ */
+export declare function TenantBasemapProvider({ basemap, children, }: {
+    basemap: Basemap | null;
+    children: ReactNode;
+}): import("react").JSX.Element;
+/**
+ * The tenant's effective basemap, or null when no host supplied one.
+ *
+ * Null means "no tenant basemap in force" — either the host installs no provider, or
+ * neither the tenant nor the operator has configured one. Both cases resolve the same
+ * way downstream (fall back to the per-widget override, then to a plain panel), so
+ * callers do not need to distinguish them.
+ */
+export declare function useTenantBasemap(): Basemap | null;

package/dist/chart-options.d.ts

@@ -0,0 +1,14 @@
+import type { MeasurementSample } from '@devicechain/dashboards';
+import type { EChartOption } from './echart';
+import type { ElementSize } from './hooks';
+import type { ChartTheme } from './theme';
+export interface LineChartOptions {
+    measurements?: string[];
+}
+export declare function buildLineOption(samples: MeasurementSample[], theme: ChartTheme, options?: LineChartOptions, size?: ElementSize): EChartOption;
+export interface GaugeChartOptions {
+    min?: number;
+    max?: number;
+    unit?: string;
+}
+export declare function buildGaugeOption(value: number | null, theme: ChartTheme, options?: GaugeChartOptions, size?: ElementSize): EChartOption;