npm - @toclocoinc/lattice-grid - Versions diffs - 1.65.0 → 1.67.0 - Mend

@toclocoinc/lattice-grid 1.65.0 → 1.67.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (177) hide show

package/README.md +6 -4
package/angular/LICENSE +111 -0
package/angular/README.md +78 -0
package/angular/fesm2022/toclocoinc-lattice-grid-angular.mjs +2843 -0
package/angular/package.json +16 -0
package/angular/types/toclocoinc-lattice-grid-angular.d.ts +1366 -0
package/docs/API.html +741 -27
package/docs/api-detail.html +137 -4
package/lattice-grid.d.ts +9 -6
package/lattice-grid.esm.min.js +26 -10
package/lattice-grid.min.cjs +26 -10
package/lattice-grid.min.css +1 -1
package/lattice-grid.min.js +26 -10
package/modules/ai.d.ts +1 -1
package/modules/ai.esm.min.js +3 -3
package/modules/ai.min.cjs +3 -3
package/modules/ai.min.js +3 -3
package/modules/angular.d.ts +1 -1
package/modules/angular.esm.min.js +7 -7
package/modules/angular.min.cjs +7 -7
package/modules/angular.min.js +7 -7
package/modules/chart-alluvial.d.ts +1 -1
package/modules/chart-alluvial.esm.min.js +1 -1
package/modules/chart-alluvial.min.cjs +1 -1
package/modules/chart-alluvial.min.js +1 -1
package/modules/chart-arc.d.ts +1 -1
package/modules/chart-arc.esm.min.js +1 -1
package/modules/chart-arc.min.cjs +1 -1
package/modules/chart-arc.min.js +1 -1
package/modules/chart-bubblemap.d.ts +1 -1
package/modules/chart-bubblemap.esm.min.js +1 -1
package/modules/chart-bubblemap.min.cjs +1 -1
package/modules/chart-bubblemap.min.js +1 -1
package/modules/chart-bump.d.ts +1 -1
package/modules/chart-bump.esm.min.js +1 -1
package/modules/chart-bump.min.cjs +1 -1
package/modules/chart-bump.min.js +1 -1
package/modules/chart-calendar.d.ts +1 -1
package/modules/chart-calendar.esm.min.js +1 -1
package/modules/chart-calendar.min.cjs +1 -1
package/modules/chart-calendar.min.js +1 -1
package/modules/chart-decomposition.d.ts +1 -1
package/modules/chart-decomposition.esm.min.js +1 -1
package/modules/chart-decomposition.min.cjs +1 -1
package/modules/chart-decomposition.min.js +1 -1
package/modules/chart-diverging.d.ts +1 -1
package/modules/chart-diverging.esm.min.js +1 -1
package/modules/chart-diverging.min.cjs +1 -1
package/modules/chart-diverging.min.js +1 -1
package/modules/chart-dumbbell.d.ts +1 -1
package/modules/chart-dumbbell.esm.min.js +1 -1
package/modules/chart-dumbbell.min.cjs +1 -1
package/modules/chart-dumbbell.min.js +1 -1
package/modules/chart-fan.d.ts +1 -1
package/modules/chart-fan.esm.min.js +1 -1
package/modules/chart-fan.min.cjs +1 -1
package/modules/chart-fan.min.js +1 -1
package/modules/chart-hexbin.d.ts +1 -1
package/modules/chart-hexbin.esm.min.js +1 -1
package/modules/chart-hexbin.min.cjs +1 -1
package/modules/chart-hexbin.min.js +1 -1
package/modules/chart-hexmap.d.ts +1 -1
package/modules/chart-hexmap.esm.min.js +1 -1
package/modules/chart-hexmap.min.cjs +1 -1
package/modules/chart-hexmap.min.js +1 -1
package/modules/chart-icicle.d.ts +1 -1
package/modules/chart-icicle.esm.min.js +1 -1
package/modules/chart-icicle.min.cjs +1 -1
package/modules/chart-icicle.min.js +1 -1
package/modules/chart-markermap.d.ts +1 -1
package/modules/chart-markermap.esm.min.js +1 -1
package/modules/chart-markermap.min.cjs +1 -1
package/modules/chart-markermap.min.js +1 -1
package/modules/chart-parallel.d.ts +1 -1
package/modules/chart-parallel.esm.min.js +1 -1
package/modules/chart-parallel.min.cjs +1 -1
package/modules/chart-parallel.min.js +1 -1
package/modules/chart-ridgeline.d.ts +1 -1
package/modules/chart-ridgeline.esm.min.js +1 -1
package/modules/chart-ridgeline.min.cjs +1 -1
package/modules/chart-ridgeline.min.js +1 -1
package/modules/chart-roc.d.ts +1 -1
package/modules/chart-roc.esm.min.js +1 -1
package/modules/chart-roc.min.cjs +1 -1
package/modules/chart-roc.min.js +1 -1
package/modules/chart-slope.d.ts +1 -1
package/modules/chart-slope.esm.min.js +1 -1
package/modules/chart-slope.min.cjs +1 -1
package/modules/chart-slope.min.js +1 -1
package/modules/chart-splom.d.ts +1 -1
package/modules/chart-splom.esm.min.js +1 -1
package/modules/chart-splom.min.cjs +1 -1
package/modules/chart-splom.min.js +1 -1
package/modules/chart-waffle.d.ts +1 -1
package/modules/chart-waffle.esm.min.js +1 -1
package/modules/chart-waffle.min.cjs +1 -1
package/modules/chart-waffle.min.js +1 -1
package/modules/charts.d.ts +1 -1
package/modules/charts.esm.min.js +261 -48
package/modules/charts.min.cjs +261 -48
package/modules/charts.min.js +261 -48
package/modules/data-router.d.ts +8 -3
package/modules/data-router.esm.min.js +28 -6
package/modules/data-router.min.cjs +28 -6
package/modules/data-router.min.js +28 -6
package/modules/devtools.d.ts +1 -1
package/modules/devtools.esm.min.js +1 -1
package/modules/devtools.min.cjs +1 -1
package/modules/devtools.min.js +1 -1
package/modules/dhtmlx-compat.d.ts +1 -1
package/modules/dhtmlx-compat.esm.min.js +3 -3
package/modules/dhtmlx-compat.min.cjs +3 -3
package/modules/dhtmlx-compat.min.js +3 -3
package/modules/gantt.d.ts +8 -3
package/modules/gantt.esm.min.js +27 -4
package/modules/gantt.min.cjs +27 -4
package/modules/gantt.min.js +27 -4
package/modules/geo-europe-nuts.d.ts +1 -1
package/modules/geo-europe-nuts.esm.min.js +1 -1
package/modules/geo-uk.d.ts +1 -1
package/modules/geo-uk.esm.min.js +1 -1
package/modules/geo-us-states.d.ts +1 -1
package/modules/geo-us-states.esm.min.js +1 -1
package/modules/geo-world-110m.d.ts +1 -1
package/modules/geo-world-110m.esm.min.js +1 -1
package/modules/geo-world-50m.d.ts +1 -1
package/modules/geo-world-50m.esm.min.js +1 -1
package/modules/htmx.d.ts +1 -1
package/modules/htmx.esm.min.js +26 -10
package/modules/htmx.min.cjs +26 -10
package/modules/htmx.min.js +26 -10
package/modules/kanban.d.ts +10 -3
package/modules/kanban.esm.min.js +24 -4
package/modules/kanban.min.cjs +24 -4
package/modules/kanban.min.js +24 -4
package/modules/kpi.d.ts +10 -3
package/modules/kpi.esm.min.js +27 -4
package/modules/kpi.min.cjs +27 -4
package/modules/kpi.min.js +27 -4
package/modules/layout.d.ts +1 -1
package/modules/layout.esm.min.js +3 -3
package/modules/layout.min.cjs +3 -3
package/modules/layout.min.js +3 -3
package/modules/mock-socket.d.ts +1 -1
package/modules/mock-socket.esm.min.js +1 -1
package/modules/mock-socket.min.cjs +1 -1
package/modules/mock-socket.min.js +1 -1
package/modules/react.d.ts +1 -1
package/modules/react.esm.min.js +3 -3
package/modules/react.min.cjs +3 -3
package/modules/react.min.js +3 -3
package/modules/svelte.d.ts +251 -2
package/modules/svelte.esm.min.js +960 -6
package/modules/svelte.min.cjs +942 -5
package/modules/svelte.min.js +942 -5
package/modules/tabs.d.ts +1 -1
package/modules/tabs.esm.min.js +3 -3
package/modules/tabs.min.cjs +3 -3
package/modules/tabs.min.js +3 -3
package/modules/vue.d.ts +398 -9
package/modules/vue.esm.min.js +1163 -31
package/modules/vue.min.cjs +1147 -30
package/modules/vue.min.js +1147 -30
package/modules/webcomponent.d.ts +233 -1
package/modules/webcomponent.esm.min.js +1274 -41
package/modules/webcomponent.min.cjs +1256 -41
package/modules/webcomponent.min.js +1256 -41
package/package.json +27 -2
package/svelte/Chart.svelte +34 -0
package/svelte/Gantt.svelte +34 -0
package/svelte/Grid.svelte +30 -0
package/svelte/GridProvider.svelte +13 -0
package/svelte/KPI.svelte +34 -0
package/svelte/Kanban.svelte +34 -0
package/svelte/Layout.svelte +34 -0
package/svelte/Router.svelte +16 -0
package/svelte/Tabs.svelte +53 -0

package/modules/svelte.d.ts CHANGED Viewed

@@ -1,9 +1,14 @@
 /*!
- * Lattice Grid 1.65.0, svelte module type declarations
+ * Lattice Grid 1.67.0, svelte module type declarations
  * Copyright (c) 2026 TOCLOCO Inc. All rights reserved.
  * https://latticegrid.dev
  */
 import type {
+  EventName,
+  Grid,
+  GridConfig,
+  GridEvent,
+  Row,
   createGrid,
 } from '../lattice-grid.js';
@@ -18,8 +23,252 @@ import type {
  * `detail`, so `on:ready={(e) => e.detail.grid}` hands you the same `Grid` a
  * turn after construction. Use `onGrid` when you need the instance during the
  * first render.
+ *
+ * The action is unchanged by the v2 components and stays
+ * supported: a host that wants a grid on an element it already owns needs
+ * nothing more, and no Svelte compiler is involved.
+ */
+export function createLatticeAction(deps: {
+  createGrid: (el: unknown, config: GridConfig) => Grid;
+  CustomEvent?: unknown;
+}): (node: unknown, params?: Record<string, unknown>) => {
+  update: (next: Record<string, unknown>) => void;
+  destroy: () => void;
+};
+/**
+ * An event name as the callback prop a Svelte 5 component takes:
+ * `'cell:changed'` becomes `'CellChanged'`, so the prop is `onCellChanged`.
+ *
+ * Svelte 5 removed component events — `createEventDispatcher` is deprecated
+ * and `on:` no longer applies to a component — so an instance event reaches a
+ * host as a callback prop. The all-lowercase spelling (`oncellchanged`) is
+ * accepted at runtime too, for hosts that prefer Svelte's DOM attribute
+ * style; only the canonical one is typed, because a union of both would make
+ * every misspelling type-check.
+ */
+export type CamelJoin<E extends string> =
+  E extends `${infer Head}:${infer Tail}`
+    ? `${Capitalize<Head>}${CamelJoin<Tail>}`
+    : Capitalize<E>;
+/** Every event of a set, as the optional callback props a caller may bind. */
+export type LatticeSvelteCallbacks<Events extends string, Payload> = {
+  [E in Events as `on${CamelJoin<E>}`]?: (payload: Payload) => void;
+};
+/** Host-element bindings every component here puts on its wrapper `div`. */
+export type LatticeSvelteHostProps = {
+  /** Applied to the host element rather than to the viewer. */
+  class?: string;
+  /** Applied to the host element rather than to the viewer. */
+  style?: string;
+  /** Applied to the host element rather than to the viewer. */
+  id?: string;
+};
+/**
+ * What `<LatticeGrid>` (`@toclocoinc/lattice-grid/svelte/Grid.svelte`) takes.
+ *
+ * Generic over the row type, so `rows`, `predicates` and the keyed-diff prop
+ * are checked against the host's own record shape rather than `unknown`.
+ *
+ * Every **grid configuration key** is accepted and diffed with `Object.is`:
+ * an inline `columns={[{ field: 'a' }]}` is a new array on every render and
+ * reconfigures the grid every time, so hoist it or hold it in `$state.raw`.
+ * `sort`, `filters`, `quickFilter` and `selectedKeys` are query and selection
+ * state rather than configuration and go through their own setters.
+ *
+ * The component types themselves are not declared here: a `.svelte` file is
+ * the source of its own component type, and Svelte's language tooling derives
+ * the props of `Grid.svelte` from the file the package ships. These are the
+ * prop *shapes*, for a host that wants to name them.
+ */
+export type LatticeSvelteGridProps<Row = unknown> =
+  Omit<GridConfig, 'rows'> & LatticeSvelteHostProps
+  & LatticeSvelteCallbacks<EventName, GridEvent> & {
+    /** The rows the grid holds. A new array replaces them; the same array is a no-op. */
+    rows?: Row[];
+    /** The name this grid publishes itself under in the registry. Mount-time. */
+    name?: string;
+    /** A keyed diff applied through `rows.apply()` whenever the object's identity changes. */
+    rowUpdates?: {
+      add?: Row[]; update?: Row[]; remove?: Array<string | Row>;
+    };
+    /** Named predicates, registered through `filters.where` so they compose with the reader's own filter. */
+    predicates?: Record<string, ((row: Row) => boolean) | null>;
+    /** The Data Router route this grid is attached to, when a `Router.svelte` is above it. */
+    route?: unknown;
+    /** Per-route options passed with `route`. */
+    routeOptions?: Record<string, unknown>;
+    /** Called once with the live grid, as soon as it exists. */
+    onGridReady?: (grid: Grid) => void;
+    /** Called as the component unmounts, before the grid is destroyed. */
+    onGridDestroyed?: () => void;
+  };
+/** What a grid-bound viewer component takes, on top of its own configuration. */
+export type LatticeSvelteViewerProps<Events extends string = string> =
+  LatticeSvelteHostProps & LatticeSvelteCallbacks<Events, unknown> & {
+    /** The grid to build against, when the host holds one itself. */
+    grid?: Grid;
+    /** Which published grid to take from the registry; the default name when absent. */
+    gridName?: string;
+    /** Called once with the live viewer, as soon as it is built. */
+    onReady?: (instance: unknown) => void;
+    /** Called when the viewer is torn down, including a rebuild onto a new grid. */
+    onDestroyed?: () => void;
+  };
+/** The registry `GridProvider.svelte` puts in context and every viewer reads. */
+export type LatticeSvelteGridRegistry = {
+  /** Publish a grid under a name, or withdraw it with `null`. */
+  publish: (name: string, grid: Grid | null) => void;
+  /** The grid published under a name, or null. */
+  get: (name?: string) => Grid | null;
+  /** Every published name. */
+  names: () => string[];
+  /** Hear about every publish and withdrawal; the return value unsubscribes. */
+  subscribe: (fn: () => void) => () => void;
+};
+/** The router handle `Router.svelte` puts in context. */
+export type LatticeSvelteRouterHandle = {
+  /** The live router, built on the first grid that asks to be routed. */
+  readonly router: unknown;
+  /** Attach a grid to a route. */
+  attach: (grid: Grid, route: unknown, routeOptions?: Record<string, unknown>) => void;
+  /** Detach a grid, before it is destroyed. */
+  detach: (grid: Grid) => void;
+  /** Destroy the router with the component that provided it. */
+  destroy: () => void;
+};
+/** The context key a grid registry is published under. */
+export const GRID_REGISTRY_KEY: symbol;
+/** The context key a Data Router handle is published under. */
+export const ROUTER_KEY: symbol;
+/** The name a grid publishes itself under when the host does not choose one. */
+export const DEFAULT_GRID_NAME: string;
+/**
+ * Own one grid for the life of a component: build once, diff props into the
+ * live instance, publish into the registry, attach to the router, and detach
+ * before destroying.
+ */
+export function bindGrid(opts: {
+  createGrid: (el: unknown, config: GridConfig) => Grid;
+  element: unknown;
+  props?: Record<string, unknown>;
+  registry?: LatticeSvelteGridRegistry | null;
+  router?: LatticeSvelteRouterHandle | null;
+}): {
+  grid: Grid;
+  update: (next: Record<string, unknown>) => void;
+  destroy: (props?: Record<string, unknown>) => void;
+};
+/**
+ * Own one viewer — KPI panel, chart, board, plan or layout — for the life of
+ * a component. `sync` builds it when everything it needs has arrived, pushes
+ * changed props into it, and rebuilds it onto a different grid.
+ */
+export function bindViewer(opts: {
+  viewer: 'kpi' | 'chart' | 'kanban' | 'gantt' | 'layout';
+  factory: (...args: never[]) => unknown;
+  element: unknown;
+  registry?: LatticeSvelteGridRegistry | null;
+}): {
+  readonly instance: unknown;
+  sync: (props: Record<string, unknown>) => void;
+  destroy: () => void;
+};
+/**
+ * Own one tab strip whose panels hold Svelte-rendered content. `place` moves
+ * a tab's `display: contents` holder into the panel the module made, which is
+ * how a snippet's content becomes a real child of the tab panel without a
+ * portal API Svelte does not have.
  */
-export function createLatticeAction(deps: { createGrid: unknown }): unknown;
+export function bindTabs(opts: {
+  createTabs: (el: unknown, config: Record<string, unknown>) => unknown;
+  element: unknown;
+  createGrid?: (el: unknown, config: GridConfig) => Grid;
+  onPanels?: (ids: string[]) => void;
+}): {
+  readonly instance: unknown;
+  sync: (props: Record<string, unknown>) => void;
+  place: (id: string, holder: unknown) => void;
+  destroy: (props?: Record<string, unknown>) => void;
+};
+/** A registry of live grids, keyed by the name each publishes itself under. */
+export function createGridRegistry(): LatticeSvelteGridRegistry;
+/**
+ * Own a Data Router for the life of the component that provides it: built on
+ * the first routed grid, destroyed with the component.
+ */
+export function createRouterHandle(opts: {
+  createDataRouter: (config: Record<string, unknown>) => unknown;
+  config?: Record<string, unknown> | (() => Record<string, unknown>);
+}): LatticeSvelteRouterHandle;
+/**
+ * Split a component's props into the configuration the instance gets and the
+ * props the adapter consumes itself, normalising either callback spelling.
+ */
+export function adaptProps(kind: string, props: Record<string, unknown>): {
+  config: Record<string, unknown>;
+  own: Record<string, unknown>;
+};
+/** A callback prop, accepted as `onCellChanged` or as `oncellchanged`. */
+export function pickCallback(
+  props: Record<string, unknown>, camel: string,
+): ((...args: never[]) => void) | null;
+/** The `(element, config)` call each module's factory actually wants. */
+export function viewerMount(
+  viewer: string, factory: (...args: never[]) => unknown,
+): (el: unknown, config: Record<string, unknown>) => unknown;
+/**
+ * Which tabs the host declared content for: the ids whose snippet prop is a
+ * function, in declaration order.
+ */
+export function snippetTabIds(
+  tabs: unknown, props: Record<string, unknown>,
+): string[];
+/** How each viewer is wired: its label, what it requires, and where its grid goes. */
+export const VIEWER_BINDING: Readonly<Record<string, {
+  label: string; requires: readonly string[]; fromContext: string | null;
+}>>;
+/** Every grid event name. */
 export const EVENT_NAMES: readonly string[];
+/** `cell:edit:start` → `cell-edit-start`, the name the action dispatches under. */
 export function dashedName(event: string): string;
+/** Every event each non-grid viewer emits, keyed by viewer name. */
+export const VIEWER_EVENTS: Readonly<Record<string, readonly string[]>>;
+/** The props each viewer can take live, and the instance call each becomes. */
+export const VIEWER_APPLY: Readonly<Record<string, Readonly<Record<string, unknown>>>>;
+/** `card:move` → `onCardMove`, the handler key the shared controller dispatches on. */
+export function viewerHandlerName(event: string): string;
+/**
+ * The framework-free viewer lifecycle every adapter drives an instance
+ * through: mount once, push changed props into the live instance, destroy.
+ */
+export function createViewerController(opts: {
+  viewer: string;
+  mount: (el: unknown, config: Record<string, unknown>) => unknown;
+  element: unknown;
+  props?: Record<string, unknown>;
+  name?: string;
+}): {
+  instance: unknown;
+  update: (next: Record<string, unknown>) => void;
+  destroy: () => void;
+};
 export default createLatticeAction;