@graphysdk/geom-sankey 0.0.0-stage → 0.1.0

package/dist/renderer/sankey-hover.d.ts

@@ -0,0 +1,16 @@
+import { GeomStyleReaders, HoverHit, SceneLayer } from '@graphysdk/react';
+interface HoveredObservationsProps {
+    layer: SceneLayer;
+    primary: HoverHit;
+    size: {
+        width: number;
+        height: number;
+    };
+    styleReaders: GeomStyleReaders;
+}
+/**
+ * Raises a hovered node with its flows and the nodes at their other ends, or a hovered flow with its two nodes, so
+ * the path through it reads as one.
+ */
+export declare const HoveredObservations: ({ layer, primary, size, styleReaders }: HoveredObservationsProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/renderer/sankey-layer.d.ts

@@ -0,0 +1,12 @@
+import { GeomStyleReaders, SceneLayer } from '@graphysdk/react';
+interface SankeyLayerProps {
+    layer: SceneLayer;
+    size: {
+        width: number;
+        height: number;
+    };
+    styleReaders: GeomStyleReaders;
+    shouldAnimateTransitions: boolean;
+}
+export declare const SankeyLayer: ({ layer, size, styleReaders, shouldAnimateTransitions }: SankeyLayerProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/renderer/sankey.d.ts

@@ -0,0 +1,13 @@
+import { BoundGeomRendererDefinition } from '@graphysdk/react';
+import { SankeyGeom } from '../engine/sankey.geom';
+/**
+ * The sankey plugin: pass it to `createGraphyKit({ plugins: [sankey] })` for `kit.geom.sankey()`.
+ *
+ * @example
+ *   const kit = createGraphyKit({ plugins: [sankey] });
+ *   const spec = kit.pipe(
+ *     kit.createSpec({ source: 'from', target: 'to', value: 'amount' }),
+ *     kit.geom.sankey()
+ *   );
+ */
+export declare const sankey: BoundGeomRendererDefinition<SankeyGeom>;

package/dist/renderer/utils/place-node-label.d.ts

@@ -0,0 +1,11 @@
+import { SankeyNodeObservation } from '../../utils/read-sankey';
+export interface NodeLabelPlacement {
+    /** Where the label is anchored, in unit space: the node's edge it sits beside, halfway down it. */
+    x: number;
+    y: number;
+    /** The gap off that edge, in pixels, signed towards the label. */
+    offsetX: number;
+    textAnchor: 'start' | 'end';
+}
+/** Places a node's label on the side facing the panel's middle, so the edge columns' labels run into the chart. */
+export declare const placeNodeLabel: (node: SankeyNodeObservation) => NodeLabelPlacement;

package/dist/utils/read-sankey.d.ts

@@ -0,0 +1,41 @@
+import { Observation } from '@graphysdk/react';
+/** A node's box in unit space, top-left origin. */
+export interface SankeyNodeObservation {
+    kind: 'node';
+    observation: Observation;
+    /** What keys the observation across a data change. */
+    key: string;
+    /** The node's own key, which its flows name as their ends. */
+    nodeKey: string;
+    x0: number;
+    x1: number;
+    y0: number;
+    y1: number;
+}
+/** A flow's band where it leaves its source, at `x0`, and where it reaches its target, at `x1`, in unit space. */
+export interface SankeyFlowObservation {
+    kind: 'flow';
+    observation: Observation;
+    key: string;
+    /** The key of the node the flow leaves. */
+    nodeKey: string;
+    /** The key of the node the flow reaches. */
+    targetKey: string;
+    x0: number;
+    x1: number;
+    y0: number;
+    y1: number;
+    targetY0: number;
+    targetY1: number;
+}
+export type SankeyObservation = SankeyNodeObservation | SankeyFlowObservation;
+export interface SankeyObservations {
+    readonly nodes: readonly SankeyNodeObservation[];
+    readonly flows: readonly SankeyFlowObservation[];
+}
+/** Reads one observation back into what it places, or `null` for one the layout placed nowhere. */
+export declare const readSankeyObservation: (observation: Observation) => SankeyObservation | null;
+/** Splits observations into nodes and flows, in order, cached: a layer's observations never change once compiled. */
+export declare const readSankeyObservations: (observations: Iterable<Observation>) => SankeyObservations;
+/** Whether a flow leaves or reaches a node. */
+export declare const isFlowOfNode: (flow: SankeyFlowObservation, node: SankeyNodeObservation) => boolean;

package/dist/utils/ribbon-geometry.d.ts

@@ -0,0 +1,19 @@
+import { SankeyFlowObservation } from './read-sankey';
+/** A ribbon's top and bottom at `progress`, 0 at its source and 1 at its target. Paint, hit test and anchor read it. */
+export declare const readRibbonEdges: (flow: SankeyFlowObservation, progress: number) => {
+    top: number;
+    bottom: number;
+};
+/** Whether a unit-space point lies on the ribbon. */
+export declare const isOnRibbon: (flow: SankeyFlowObservation, point: {
+    x: number;
+    y: number;
+}) => boolean;
+/**
+ * The ribbon's outline in pixels. A smoothstep edge is exactly a cubic Bézier with control points a third and two
+ * thirds along, level with the end they leave, so the path is the shape {@link isOnRibbon} tests.
+ */
+export declare const buildRibbonPath: (flow: SankeyFlowObservation, size: {
+    width: number;
+    height: number;
+}) => string;

package/dist/utils/sankey-variables.d.ts

@@ -0,0 +1,33 @@
+/**
+ * The columns the `sankey` stat writes and the renderer reads. They are internal: an author colors and highlights by
+ * the source and target columns, which the stat fills on node observations.
+ */
+export declare const SANKEY_VARIABLES: {
+    /** Whether an observation is a `'node'` or a `'flow'`. */
+    readonly kind: "sankeyKind";
+    /** What `nodeKey` names, in the source and target columns' type and format, so labels print it as the data does. */
+    readonly nodeName: "sankeyNodeName";
+    /** What identifies an observation across a data change: a node by its name, a flow by its two ends. */
+    readonly observationKey: "sankeyObservationKey";
+    /**
+     * The key of the node an observation belongs to: a node's own, and the node a flow leaves. What joins a node to its
+     * flows, and what color groups by when it reads the source column. Always categorical, so a date node is its ISO
+     * string and every node takes a palette color.
+     */
+    readonly nodeKey: "sankeyNodeKey";
+    /** The key of the node a flow reaches, and a node's own: what color groups by when it reads the target column. */
+    readonly targetKey: "sankeyTargetKey";
+    /** A node's left edge; a flow's start, its source's right edge. In unit space, like every column below. */
+    readonly x0: "sankeyX0";
+    /** A node's right edge; a flow's end, its target's left edge. */
+    readonly x1: "sankeyX1";
+    /** A node's top; a flow's top where it leaves its source. Unit space runs down from the top of the panel. */
+    readonly y0: "sankeyY0";
+    /** A node's bottom; a flow's bottom where it leaves its source. */
+    readonly y1: "sankeyY1";
+    /** A flow's top where it reaches its target. */
+    readonly targetY0: "sankeyTargetY0";
+    /** A flow's bottom where it reaches its target. */
+    readonly targetY1: "sankeyTargetY1";
+};
+export type SankeyKind = 'node' | 'flow';

package/licenses/PolyForm-Free-Trial-1.0.0.md

@@ -0,0 +1,93 @@
+# PolyForm Free Trial License 1.0.0
+
+<https://polyformproject.org/licenses/free-trial/1.0.0>
+
+## Acceptance
+
+In order to get any license under these terms, you must agree
+to them as both strict obligations and conditions to all
+your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the software
+to do everything you might do with the software that would
+otherwise infringe the licensor's copyright in it for any
+permitted purpose. However, you may only make changes or
+new works based on the software according to [Changes and New
+Works License](#changes-and-new-works-license), and you may
+not distribute copies of the software.
+
+## Changes and New Works License
+
+The licensor grants you an additional copyright license to
+make changes and new works based on the software for any
+permitted purpose.
+
+## Patent License
+
+The licensor grants you a patent license for the software that
+covers patent claims the licensor can license, or becomes able
+to license, that you would infringe by using the software.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the
+law. These terms do not limit them.
+
+## Free Trial
+
+Use to evaluate whether the software suits a particular
+application for less than 32 consecutive calendar days, on
+behalf of you or your company, is use for a permitted purpose.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of
+your licenses to anyone else, or prevent the licensor from
+granting licenses to anyone else. These terms do not imply
+any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes or
+contributes to infringement of any patent, your patent license
+for the software granted under these terms ends immediately. If
+your company makes such a claim, your patent license ends
+immediately for work on behalf of your company.
+
+## Violations
+
+If you violate any of these terms, or do anything with the
+software not covered by your licenses, all your licenses
+end immediately.
+
+## No Liability
+
+_**As far as the law allows, the software comes as is, without
+any warranty or condition, and the licensor will not be liable
+to you for any damages arising out of these terms or the use
+or nature of the software, under any kind of legal claim.**_
+
+## Definitions
+
+The **licensor** is the individual or entity offering these
+terms, and the **software** is the software the licensor makes
+available under these terms.
+
+**You** refers to the individual or entity agreeing to these
+terms.
+
+**Your company** is any legal entity, sole proprietorship,
+or other kind of organization that you work for, plus all
+organizations that have control over, are under the control of,
+or are under common control with that organization. **Control**
+means ownership of substantially all the assets of an entity,
+or the power to direct its management and policies by vote,
+contract, or otherwise. Control can be direct or indirect.
+
+**Your licenses** are all the licenses granted to you for the
+software under these terms.
+
+**Use** means anything you do with the software requiring one
+of your licenses.

package/licenses/PolyForm-NonCommercial-1.0.0.md

@@ -0,0 +1,131 @@
+# PolyForm Noncommercial License 1.0.0
+
+<https://polyformproject.org/licenses/noncommercial/1.0.0>
+
+## Acceptance
+
+In order to get any license under these terms, you must agree
+to them as both strict obligations and conditions to all
+your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the
+software to do everything you might do with the software
+that would otherwise infringe the licensor's copyright
+in it for any permitted purpose. However, you may
+only distribute the software according to [Distribution
+License](#distribution-license) and make changes or new works
+based on the software according to [Changes and New Works
+License](#changes-and-new-works-license).
+
+## Distribution License
+
+The licensor grants you an additional copyright license
+to distribute copies of the software. Your license
+to distribute covers distributing the software with
+changes and new works permitted by [Changes and New Works
+License](#changes-and-new-works-license).
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of
+the software from you also gets a copy of these terms or the
+URL for them above, as well as copies of any plain-text lines
+beginning with `Required Notice:` that the licensor provided
+with the software. For example:
+
+> Required Notice: Copyright Graphy Technologies Ltd. (https://graphy.dev)
+
+## Changes and New Works License
+
+The licensor grants you an additional copyright license to
+make changes and new works based on the software for any
+permitted purpose.
+
+## Patent License
+
+The licensor grants you a patent license for the software that
+covers patent claims the licensor can license, or becomes able
+to license, that you would infringe by using the software.
+
+## Noncommercial Purposes
+
+Any noncommercial purpose is a permitted purpose.
+
+## Personal Uses
+
+Personal use for research, experiment, and testing for
+the benefit of public knowledge, personal study, private
+entertainment, hobby projects, amateur pursuits, or religious
+observance, without any anticipated commercial application,
+is use for a permitted purpose.
+
+## Noncommercial Organizations
+
+Use by any charitable organization, educational institution,
+public research organization, public safety or health
+organization, environmental protection organization,
+or government institution is use for a permitted purpose
+regardless of the source of funding or obligations resulting
+from the funding.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the
+law. These terms do not limit them.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of
+your licenses to anyone else, or prevent the licensor from
+granting licenses to anyone else. These terms do not imply
+any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes or
+contributes to infringement of any patent, your patent license
+for the software granted under these terms ends immediately. If
+your company makes such a claim, your patent license ends
+immediately for work on behalf of your company.
+
+## Violations
+
+The first time you are notified in writing that you have
+violated any of these terms, or done anything with the software
+not covered by your licenses, your licenses can nonetheless
+continue if you come into full compliance with these terms,
+and take practical steps to correct past violations, within
+32 days of receiving notice. Otherwise, all your licenses
+end immediately.
+
+## No Liability
+
+_**As far as the law allows, the software comes as is, without
+any warranty or condition, and the licensor will not be liable
+to you for any damages arising out of these terms or the use
+or nature of the software, under any kind of legal claim.**_
+
+## Definitions
+
+The **licensor** is the individual or entity offering these
+terms, and the **software** is the software the licensor makes
+available under these terms.
+
+**You** refers to the individual or entity agreeing to these
+terms.
+
+**Your company** is any legal entity, sole proprietorship,
+or other kind of organization that you work for, plus all
+organizations that have control over, are under the control of,
+or are under common control with that organization. **Control**
+means ownership of substantially all the assets of an entity,
+or the power to direct its management and policies by vote,
+contract, or otherwise. Control can be direct or indirect.
+
+**Your licenses** are all the licenses granted to you for the
+software under these terms.
+
+**Use** means anything you do with the software requiring one
+of your licenses.

package/licenses/PolyForm-Small-Business-1.0.0.md

@@ -0,0 +1,121 @@
+# PolyForm Small Business License 1.0.0
+
+<https://polyformproject.org/licenses/small-business/1.0.0>
+
+## Acceptance
+
+In order to get any license under these terms, you must agree
+to them as both strict obligations and conditions to all
+your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the
+software to do everything you might do with the software
+that would otherwise infringe the licensor's copyright
+in it for any permitted purpose. However, you may
+only distribute the software according to [Distribution
+License](#distribution-license) and make changes or new works
+based on the software according to [Changes and New Works
+License](#changes-and-new-works-license).
+
+## Distribution License
+
+The licensor grants you an additional copyright license
+to distribute copies of the software. Your license
+to distribute covers distributing the software with
+changes and new works permitted by [Changes and New Works
+License](#changes-and-new-works-license).
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of
+the software from you also gets a copy of these terms or the
+URL for them above, as well as copies of any plain-text lines
+beginning with `Required Notice:` that the licensor provided
+with the software. For example:
+
+> Required Notice: Copyright Graphy Technologies Ltd. (https://graphy.dev)
+
+## Changes and New Works License
+
+The licensor grants you an additional copyright license to
+make changes and new works based on the software for any
+permitted purpose.
+
+## Patent License
+
+The licensor grants you a patent license for the software that
+covers patent claims the licensor can license, or becomes able
+to license, that you would infringe by using the software.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the
+law. These terms do not limit them.
+
+## Small Business
+
+Use of the software for the benefit of your company is use for
+a permitted purpose if your company has fewer than 100 total
+individuals working as employees and independent contractors,
+and less than 1,000,000 USD (2019) total revenue in the prior
+tax year. Adjust this revenue threshold for inflation according
+to the United States Bureau of Labor Statistics' consumer price
+index for all urban consumers, U.S. city average, for all items,
+not seasonally adjusted, with 1982–1984=100 reference base.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of
+your licenses to anyone else, or prevent the licensor from
+granting licenses to anyone else. These terms do not imply
+any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes or
+contributes to infringement of any patent, your patent license
+for the software granted under these terms ends immediately. If
+your company makes such a claim, your patent license ends
+immediately for work on behalf of your company.
+
+## Violations
+
+The first time you are notified in writing that you have
+violated any of these terms, or done anything with the software
+not covered by your licenses, your licenses can nonetheless
+continue if you come into full compliance with these terms,
+and take practical steps to correct past violations, within
+32 days of receiving notice. Otherwise, all your licenses
+end immediately.
+
+## No Liability
+
+_**As far as the law allows, the software comes as is, without
+any warranty or condition, and the licensor will not be liable
+to you for any damages arising out of these terms or the use
+or nature of the software, under any kind of legal claim.**_
+
+## Definitions
+
+The **licensor** is the individual or entity offering these
+terms, and the **software** is the software the licensor makes
+available under these terms.
+
+**You** refers to the individual or entity agreeing to these
+terms.
+
+**Your company** is any legal entity, sole proprietorship,
+or other kind of organization that you work for, plus all
+organizations that have control over, are under the control of,
+or are under common control with that organization. **Control**
+means ownership of substantially all the assets of an entity,
+or the power to direct its management and policies by vote,
+contract, or otherwise. Control can be direct or indirect.
+
+**Your licenses** are all the licenses granted to you for the
+software under these terms.
+
+**Use** means anything you do with the software requiring one
+of your licenses.

package/package.json

@@ -1,6 +1,79 @@
 {
   "name": "@graphysdk/geom-sankey",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "author": "Graphy",
+  "description": "Sankey geom for the Graphy charting SDK (beta)",
+  "homepage": "https://docs.graphy.dev/sdk-next/graph-types/sankey",
+  "license": "SEE LICENSE IN LICENSE.md",
+  "keywords": [
+    "graphy",
+    "chart",
+    "react",
+    "visualization",
+    "grammar-of-graphics",
+    "sankey",
+    "flow",
+    "alluvial"
+  ],
+  "version": "0.1.0",
+  "type": "module",
+  "sideEffects": false,
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "LICENSE.md",
+    "licenses",
+    "README.md"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "dependencies": {
+    "d3-sankey": "^0.12.3"
+  },
+  "peerDependencies": {
+    "react": "^19.0.0",
+    "@graphysdk/react": "^1.9.0-beta.1791969243405"
+  },
+  "devDependencies": {
+    "@testing-library/react": "^16.3.1",
+    "@types/d3-sankey": "^0.12.5",
+    "@types/react": "^19.2.14",
+    "@types/react-dom": "^19.2.3",
+    "react": "^19.2.4",
+    "react-dom": "^19.2.4",
+    "rollup-plugin-node-externals": "^8.1.1",
+    "vite": "^8.1.5",
+    "vite-plugin-dts": "^4.5.4",
+    "vitest": "^4.1.11",
+    "@graphysdk/viz-engine": "1.8.0",
+    "@graphysdk/react": "1.9.0-beta.1791969243405",
+    "@graphytools/eslint-config": "0.0.1",
+    "@graphytools/typescript-config": "0.0.1",
+    "@graphytools/vitest-config": "1.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "lint-staged": {
+    "*.{ts,tsx,js,jsx,json,css,md}": [
+      "prettier --write"
+    ],
+    "*.{ts,tsx}": [
+      "eslint --max-warnings=0 --fix"
+    ]
+  },
+  "scripts": {
+    "build": "vite build",
+    "test": "vitest run",
+    "test:watch": "TZ=utc vitest",
+    "lint": "eslint . --max-warnings 0",
+    "lint:fix": "eslint . --fix",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "typecheck": "tsc --noEmit"
+  }
 }