@sheetxl/sdk 0.8.0-beta.1 → 0.8.0-beta.11

package/types/src/shape/GeometryPreset.d.ts

@@ -0,0 +1,197 @@
+/**
+ * GENERATED by scripts/shapes/encodePresetShapes.mts - do not edit.
+ *
+ * Source: scripts/shapes/source/presetShapeDefinitions.xml (sha256 eaff19f4405b3be6822428c96ef46cc685499217366fd58e5e63a5a24739f02f, LF-normalized)
+ * Patches: scripts/shapes/presetShapes.patch.json
+ */
+/** Every preset's `prstGeom/@prst` name, by a PascalCase key: `IGeometry.Preset`. */
+export declare const GeometryPreset: Readonly<{
+    readonly AccentBorderCallout1: "accentBorderCallout1";
+    readonly AccentBorderCallout2: "accentBorderCallout2";
+    readonly AccentBorderCallout3: "accentBorderCallout3";
+    readonly AccentCallout1: "accentCallout1";
+    readonly AccentCallout2: "accentCallout2";
+    readonly AccentCallout3: "accentCallout3";
+    readonly ActionButtonBackPrevious: "actionButtonBackPrevious";
+    readonly ActionButtonBeginning: "actionButtonBeginning";
+    readonly ActionButtonBlank: "actionButtonBlank";
+    readonly ActionButtonDocument: "actionButtonDocument";
+    readonly ActionButtonEnd: "actionButtonEnd";
+    readonly ActionButtonForwardNext: "actionButtonForwardNext";
+    readonly ActionButtonHelp: "actionButtonHelp";
+    readonly ActionButtonHome: "actionButtonHome";
+    readonly ActionButtonInformation: "actionButtonInformation";
+    readonly ActionButtonMovie: "actionButtonMovie";
+    readonly ActionButtonReturn: "actionButtonReturn";
+    readonly ActionButtonSound: "actionButtonSound";
+    readonly Arc: "arc";
+    readonly BentArrow: "bentArrow";
+    readonly BentConnector2: "bentConnector2";
+    readonly BentConnector3: "bentConnector3";
+    readonly BentConnector4: "bentConnector4";
+    readonly BentConnector5: "bentConnector5";
+    readonly BentUpArrow: "bentUpArrow";
+    readonly Bevel: "bevel";
+    readonly BlockArc: "blockArc";
+    readonly BorderCallout1: "borderCallout1";
+    readonly BorderCallout2: "borderCallout2";
+    readonly BorderCallout3: "borderCallout3";
+    readonly BracePair: "bracePair";
+    readonly BracketPair: "bracketPair";
+    readonly Callout1: "callout1";
+    readonly Callout2: "callout2";
+    readonly Callout3: "callout3";
+    readonly Can: "can";
+    readonly ChartPlus: "chartPlus";
+    readonly ChartStar: "chartStar";
+    readonly ChartX: "chartX";
+    readonly Chevron: "chevron";
+    readonly Chord: "chord";
+    readonly CircularArrow: "circularArrow";
+    readonly Cloud: "cloud";
+    readonly CloudCallout: "cloudCallout";
+    readonly Corner: "corner";
+    readonly CornerTabs: "cornerTabs";
+    readonly Cube: "cube";
+    readonly CurvedConnector2: "curvedConnector2";
+    readonly CurvedConnector3: "curvedConnector3";
+    readonly CurvedConnector4: "curvedConnector4";
+    readonly CurvedConnector5: "curvedConnector5";
+    readonly CurvedDownArrow: "curvedDownArrow";
+    readonly CurvedLeftArrow: "curvedLeftArrow";
+    readonly CurvedRightArrow: "curvedRightArrow";
+    readonly CurvedUpArrow: "curvedUpArrow";
+    readonly Decagon: "decagon";
+    readonly DiagStripe: "diagStripe";
+    readonly Diamond: "diamond";
+    readonly Dodecagon: "dodecagon";
+    readonly Donut: "donut";
+    readonly DoubleWave: "doubleWave";
+    readonly DownArrow: "downArrow";
+    readonly DownArrowCallout: "downArrowCallout";
+    readonly Ellipse: "ellipse";
+    readonly EllipseRibbon: "ellipseRibbon";
+    readonly EllipseRibbon2: "ellipseRibbon2";
+    readonly FlowChartAlternateProcess: "flowChartAlternateProcess";
+    readonly FlowChartCollate: "flowChartCollate";
+    readonly FlowChartConnector: "flowChartConnector";
+    readonly FlowChartDecision: "flowChartDecision";
+    readonly FlowChartDelay: "flowChartDelay";
+    readonly FlowChartDisplay: "flowChartDisplay";
+    readonly FlowChartDocument: "flowChartDocument";
+    readonly FlowChartExtract: "flowChartExtract";
+    readonly FlowChartInputOutput: "flowChartInputOutput";
+    readonly FlowChartInternalStorage: "flowChartInternalStorage";
+    readonly FlowChartMagneticDisk: "flowChartMagneticDisk";
+    readonly FlowChartMagneticDrum: "flowChartMagneticDrum";
+    readonly FlowChartMagneticTape: "flowChartMagneticTape";
+    readonly FlowChartManualInput: "flowChartManualInput";
+    readonly FlowChartManualOperation: "flowChartManualOperation";
+    readonly FlowChartMerge: "flowChartMerge";
+    readonly FlowChartMultidocument: "flowChartMultidocument";
+    readonly FlowChartOfflineStorage: "flowChartOfflineStorage";
+    readonly FlowChartOffpageConnector: "flowChartOffpageConnector";
+    readonly FlowChartOnlineStorage: "flowChartOnlineStorage";
+    readonly FlowChartOr: "flowChartOr";
+    readonly FlowChartPredefinedProcess: "flowChartPredefinedProcess";
+    readonly FlowChartPreparation: "flowChartPreparation";
+    readonly FlowChartProcess: "flowChartProcess";
+    readonly FlowChartPunchedCard: "flowChartPunchedCard";
+    readonly FlowChartPunchedTape: "flowChartPunchedTape";
+    readonly FlowChartSort: "flowChartSort";
+    readonly FlowChartSummingJunction: "flowChartSummingJunction";
+    readonly FlowChartTerminator: "flowChartTerminator";
+    readonly FoldedCorner: "foldedCorner";
+    readonly Frame: "frame";
+    readonly Funnel: "funnel";
+    readonly Gear6: "gear6";
+    readonly Gear9: "gear9";
+    readonly HalfFrame: "halfFrame";
+    readonly Heart: "heart";
+    readonly Heptagon: "heptagon";
+    readonly Hexagon: "hexagon";
+    readonly HomePlate: "homePlate";
+    readonly HorizontalScroll: "horizontalScroll";
+    readonly IrregularSeal1: "irregularSeal1";
+    readonly IrregularSeal2: "irregularSeal2";
+    readonly LeftArrow: "leftArrow";
+    readonly LeftArrowCallout: "leftArrowCallout";
+    readonly LeftBrace: "leftBrace";
+    readonly LeftBracket: "leftBracket";
+    readonly LeftCircularArrow: "leftCircularArrow";
+    readonly LeftRightArrow: "leftRightArrow";
+    readonly LeftRightArrowCallout: "leftRightArrowCallout";
+    readonly LeftRightCircularArrow: "leftRightCircularArrow";
+    readonly LeftRightRibbon: "leftRightRibbon";
+    readonly LeftRightUpArrow: "leftRightUpArrow";
+    readonly LeftUpArrow: "leftUpArrow";
+    readonly LightningBolt: "lightningBolt";
+    readonly Line: "line";
+    readonly LineInv: "lineInv";
+    readonly MathDivide: "mathDivide";
+    readonly MathEqual: "mathEqual";
+    readonly MathMinus: "mathMinus";
+    readonly MathMultiply: "mathMultiply";
+    readonly MathNotEqual: "mathNotEqual";
+    readonly MathPlus: "mathPlus";
+    readonly Moon: "moon";
+    readonly NoSmoking: "noSmoking";
+    readonly NonIsoscelesTrapezoid: "nonIsoscelesTrapezoid";
+    readonly NotchedRightArrow: "notchedRightArrow";
+    readonly Octagon: "octagon";
+    readonly Parallelogram: "parallelogram";
+    readonly Pentagon: "pentagon";
+    readonly Pie: "pie";
+    readonly PieWedge: "pieWedge";
+    readonly Plaque: "plaque";
+    readonly PlaqueTabs: "plaqueTabs";
+    readonly Plus: "plus";
+    readonly QuadArrow: "quadArrow";
+    readonly QuadArrowCallout: "quadArrowCallout";
+    readonly Rect: "rect";
+    readonly Ribbon: "ribbon";
+    readonly Ribbon2: "ribbon2";
+    readonly RightArrow: "rightArrow";
+    readonly RightArrowCallout: "rightArrowCallout";
+    readonly RightBrace: "rightBrace";
+    readonly RightBracket: "rightBracket";
+    readonly Round1Rect: "round1Rect";
+    readonly Round2DiagRect: "round2DiagRect";
+    readonly Round2SameRect: "round2SameRect";
+    readonly RoundRect: "roundRect";
+    readonly RtTriangle: "rtTriangle";
+    readonly SmileyFace: "smileyFace";
+    readonly Snip1Rect: "snip1Rect";
+    readonly Snip2DiagRect: "snip2DiagRect";
+    readonly Snip2SameRect: "snip2SameRect";
+    readonly SnipRoundRect: "snipRoundRect";
+    readonly SquareTabs: "squareTabs";
+    readonly Star10: "star10";
+    readonly Star12: "star12";
+    readonly Star16: "star16";
+    readonly Star24: "star24";
+    readonly Star32: "star32";
+    readonly Star4: "star4";
+    readonly Star5: "star5";
+    readonly Star6: "star6";
+    readonly Star7: "star7";
+    readonly Star8: "star8";
+    readonly StraightConnector1: "straightConnector1";
+    readonly StripedRightArrow: "stripedRightArrow";
+    readonly Sun: "sun";
+    readonly SwooshArrow: "swooshArrow";
+    readonly Teardrop: "teardrop";
+    readonly Trapezoid: "trapezoid";
+    readonly Triangle: "triangle";
+    readonly UpArrow: "upArrow";
+    readonly UpArrowCallout: "upArrowCallout";
+    readonly UpDownArrow: "upDownArrow";
+    readonly UpDownArrowCallout: "upDownArrowCallout";
+    readonly UturnArrow: "uturnArrow";
+    readonly VerticalScroll: "verticalScroll";
+    readonly Wave: "wave";
+    readonly WedgeEllipseCallout: "wedgeEllipseCallout";
+    readonly WedgeRectCallout: "wedgeRectCallout";
+    readonly WedgeRoundRectCallout: "wedgeRoundRectCallout";
+}>;
+//# sourceMappingURL=GeometryPreset.d.ts.map

package/types/src/shape/IGeometry.d.ts

@@ -0,0 +1,380 @@
+/**
+ * A shape's geometry evaluated at one size: its paths, text rectangle, adjust handles and
+ * connection sites, in pixels in the shape's own frame (its top-left is 0,0).
+ *
+ * @remarks
+ * Returned by {@link IShape.getGeometry}, which loads whatever the shape needs to evaluate.
+ * Once it has resolved, everything here is synchronous: a renderer re-evaluates at a new size
+ * ({@link resize}) or with new adjust values ({@link withAdjustments}) on every frame of a drag.
+ *
+ * @example
+ * ```ts
+ * const geometry = await shape.getGeometry(200, 100);
+ * const parts: string[] = [];
+ * geometry?.forEachPath((path) => {
+ *   if (path.layer === IGeometry.PathLayer.Stroke) parts.push(`<path d="${path.d}" fill="none" stroke="black"/>`);
+ * });
+ * ```
+ */
+export interface IGeometry {
+    /** The width the geometry was evaluated at, in pixels. */
+    getWidth(): number;
+    /** The height the geometry was evaluated at, in pixels. */
+    getHeight(): number;
+    /** Where text is laid out: the definition's text rectangle, or the whole frame when it declares none. */
+    getTextRect(): IGeometry.Rect;
+    /**
+     * The box that holds every path, line ends included, in the shape's frame.
+     *
+     * @remarks
+     * It can reach outside the frame, as a callout's tail does, so its edges may be negative or past
+     * {@link getWidth} and {@link getHeight}. The line's own width is not included. A geometry
+     * that draws nothing answers its whole frame.
+     */
+    getPathBounds(): IGeometry.Rect;
+    /**
+     * Visits every path in paint order: a shape's fills, then its strokes, then its markers.
+     */
+    forEachPath(visit: (path: IGeometry.IPath) => void): void;
+    /** Visits the adjust handles, in the order {@link adjustmentsFromHandle} indexes them. */
+    forEachHandle(visit: (handle: IGeometry.IHandle) => void): void;
+    /** Visits the connection sites, in the order a connector's ends index them. */
+    forEachConnection(visit: (connection: IGeometry.IConnection) => void): void;
+    /** The same shape evaluated at another size. */
+    resize(width: number, height: number): IGeometry;
+    /**
+     * The same shape evaluated with other adjust values.
+     *
+     * @param adjustments Values by name, as {@link IShape.setAdjustments} takes them (what a
+     * handle drag produced); `null` for the preset's defaults.
+     */
+    withAdjustments(adjustments: Readonly<Record<string, number>> | null): IGeometry;
+    /**
+     * The adjust values that put a handle as near as it can go to a point: what dragging it there
+     * sets. Values the handle does not move are kept as they are.
+     *
+     * @param index The handle's {@link IGeometry.IHandle.index}.
+     * @param x In pixels, in the shape's frame.
+     * @param y In pixels, in the shape's frame.
+     * @returns Values to pass to {@link IShape.setAdjustments} or {@link withAdjustments}.
+     */
+    adjustmentsFromHandle(index: number, x: number, y: number): Record<string, number>;
+}
+/**
+ * {@inheritDoc IGeometry}
+ * @see
+ * ### **Interface**
+ *
+ * {@link IGeometry}
+ */
+export declare namespace IGeometry {
+    /**
+     * Every preset geometry, by the DrawingML name (`prstGeom/@prst`) a shape's
+     * {@link IShape.Properties.geometry} takes and {@link IShape.getShapeType} returns.
+     *
+     * @example
+     * ```ts
+     * await sheet.getMovables().add({ type: 'shape', json: { geometry: IGeometry.Preset.RoundRect }, bounds });
+     * ```
+     */
+    const Preset: Readonly<{
+        readonly AccentBorderCallout1: "accentBorderCallout1";
+        readonly AccentBorderCallout2: "accentBorderCallout2";
+        readonly AccentBorderCallout3: "accentBorderCallout3";
+        readonly AccentCallout1: "accentCallout1";
+        readonly AccentCallout2: "accentCallout2";
+        readonly AccentCallout3: "accentCallout3";
+        readonly ActionButtonBackPrevious: "actionButtonBackPrevious";
+        readonly ActionButtonBeginning: "actionButtonBeginning";
+        readonly ActionButtonBlank: "actionButtonBlank";
+        readonly ActionButtonDocument: "actionButtonDocument";
+        readonly ActionButtonEnd: "actionButtonEnd";
+        readonly ActionButtonForwardNext: "actionButtonForwardNext";
+        readonly ActionButtonHelp: "actionButtonHelp";
+        readonly ActionButtonHome: "actionButtonHome";
+        readonly ActionButtonInformation: "actionButtonInformation";
+        readonly ActionButtonMovie: "actionButtonMovie";
+        readonly ActionButtonReturn: "actionButtonReturn";
+        readonly ActionButtonSound: "actionButtonSound";
+        readonly Arc: "arc";
+        readonly BentArrow: "bentArrow";
+        readonly BentConnector2: "bentConnector2";
+        readonly BentConnector3: "bentConnector3";
+        readonly BentConnector4: "bentConnector4";
+        readonly BentConnector5: "bentConnector5";
+        readonly BentUpArrow: "bentUpArrow";
+        readonly Bevel: "bevel";
+        readonly BlockArc: "blockArc";
+        readonly BorderCallout1: "borderCallout1";
+        readonly BorderCallout2: "borderCallout2";
+        readonly BorderCallout3: "borderCallout3";
+        readonly BracePair: "bracePair";
+        readonly BracketPair: "bracketPair";
+        readonly Callout1: "callout1";
+        readonly Callout2: "callout2";
+        readonly Callout3: "callout3";
+        readonly Can: "can";
+        readonly ChartPlus: "chartPlus";
+        readonly ChartStar: "chartStar";
+        readonly ChartX: "chartX";
+        readonly Chevron: "chevron";
+        readonly Chord: "chord";
+        readonly CircularArrow: "circularArrow";
+        readonly Cloud: "cloud";
+        readonly CloudCallout: "cloudCallout";
+        readonly Corner: "corner";
+        readonly CornerTabs: "cornerTabs";
+        readonly Cube: "cube";
+        readonly CurvedConnector2: "curvedConnector2";
+        readonly CurvedConnector3: "curvedConnector3";
+        readonly CurvedConnector4: "curvedConnector4";
+        readonly CurvedConnector5: "curvedConnector5";
+        readonly CurvedDownArrow: "curvedDownArrow";
+        readonly CurvedLeftArrow: "curvedLeftArrow";
+        readonly CurvedRightArrow: "curvedRightArrow";
+        readonly CurvedUpArrow: "curvedUpArrow";
+        readonly Decagon: "decagon";
+        readonly DiagStripe: "diagStripe";
+        readonly Diamond: "diamond";
+        readonly Dodecagon: "dodecagon";
+        readonly Donut: "donut";
+        readonly DoubleWave: "doubleWave";
+        readonly DownArrow: "downArrow";
+        readonly DownArrowCallout: "downArrowCallout";
+        readonly Ellipse: "ellipse";
+        readonly EllipseRibbon: "ellipseRibbon";
+        readonly EllipseRibbon2: "ellipseRibbon2";
+        readonly FlowChartAlternateProcess: "flowChartAlternateProcess";
+        readonly FlowChartCollate: "flowChartCollate";
+        readonly FlowChartConnector: "flowChartConnector";
+        readonly FlowChartDecision: "flowChartDecision";
+        readonly FlowChartDelay: "flowChartDelay";
+        readonly FlowChartDisplay: "flowChartDisplay";
+        readonly FlowChartDocument: "flowChartDocument";
+        readonly FlowChartExtract: "flowChartExtract";
+        readonly FlowChartInputOutput: "flowChartInputOutput";
+        readonly FlowChartInternalStorage: "flowChartInternalStorage";
+        readonly FlowChartMagneticDisk: "flowChartMagneticDisk";
+        readonly FlowChartMagneticDrum: "flowChartMagneticDrum";
+        readonly FlowChartMagneticTape: "flowChartMagneticTape";
+        readonly FlowChartManualInput: "flowChartManualInput";
+        readonly FlowChartManualOperation: "flowChartManualOperation";
+        readonly FlowChartMerge: "flowChartMerge";
+        readonly FlowChartMultidocument: "flowChartMultidocument";
+        readonly FlowChartOfflineStorage: "flowChartOfflineStorage";
+        readonly FlowChartOffpageConnector: "flowChartOffpageConnector";
+        readonly FlowChartOnlineStorage: "flowChartOnlineStorage";
+        readonly FlowChartOr: "flowChartOr";
+        readonly FlowChartPredefinedProcess: "flowChartPredefinedProcess";
+        readonly FlowChartPreparation: "flowChartPreparation";
+        readonly FlowChartProcess: "flowChartProcess";
+        readonly FlowChartPunchedCard: "flowChartPunchedCard";
+        readonly FlowChartPunchedTape: "flowChartPunchedTape";
+        readonly FlowChartSort: "flowChartSort";
+        readonly FlowChartSummingJunction: "flowChartSummingJunction";
+        readonly FlowChartTerminator: "flowChartTerminator";
+        readonly FoldedCorner: "foldedCorner";
+        readonly Frame: "frame";
+        readonly Funnel: "funnel";
+        readonly Gear6: "gear6";
+        readonly Gear9: "gear9";
+        readonly HalfFrame: "halfFrame";
+        readonly Heart: "heart";
+        readonly Heptagon: "heptagon";
+        readonly Hexagon: "hexagon";
+        readonly HomePlate: "homePlate";
+        readonly HorizontalScroll: "horizontalScroll";
+        readonly IrregularSeal1: "irregularSeal1";
+        readonly IrregularSeal2: "irregularSeal2";
+        readonly LeftArrow: "leftArrow";
+        readonly LeftArrowCallout: "leftArrowCallout";
+        readonly LeftBrace: "leftBrace";
+        readonly LeftBracket: "leftBracket";
+        readonly LeftCircularArrow: "leftCircularArrow";
+        readonly LeftRightArrow: "leftRightArrow";
+        readonly LeftRightArrowCallout: "leftRightArrowCallout";
+        readonly LeftRightCircularArrow: "leftRightCircularArrow";
+        readonly LeftRightRibbon: "leftRightRibbon";
+        readonly LeftRightUpArrow: "leftRightUpArrow";
+        readonly LeftUpArrow: "leftUpArrow";
+        readonly LightningBolt: "lightningBolt";
+        readonly Line: "line";
+        readonly LineInv: "lineInv";
+        readonly MathDivide: "mathDivide";
+        readonly MathEqual: "mathEqual";
+        readonly MathMinus: "mathMinus";
+        readonly MathMultiply: "mathMultiply";
+        readonly MathNotEqual: "mathNotEqual";
+        readonly MathPlus: "mathPlus";
+        readonly Moon: "moon";
+        readonly NoSmoking: "noSmoking";
+        readonly NonIsoscelesTrapezoid: "nonIsoscelesTrapezoid";
+        readonly NotchedRightArrow: "notchedRightArrow";
+        readonly Octagon: "octagon";
+        readonly Parallelogram: "parallelogram";
+        readonly Pentagon: "pentagon";
+        readonly Pie: "pie";
+        readonly PieWedge: "pieWedge";
+        readonly Plaque: "plaque";
+        readonly PlaqueTabs: "plaqueTabs";
+        readonly Plus: "plus";
+        readonly QuadArrow: "quadArrow";
+        readonly QuadArrowCallout: "quadArrowCallout";
+        readonly Rect: "rect";
+        readonly Ribbon: "ribbon";
+        readonly Ribbon2: "ribbon2";
+        readonly RightArrow: "rightArrow";
+        readonly RightArrowCallout: "rightArrowCallout";
+        readonly RightBrace: "rightBrace";
+        readonly RightBracket: "rightBracket";
+        readonly Round1Rect: "round1Rect";
+        readonly Round2DiagRect: "round2DiagRect";
+        readonly Round2SameRect: "round2SameRect";
+        readonly RoundRect: "roundRect";
+        readonly RtTriangle: "rtTriangle";
+        readonly SmileyFace: "smileyFace";
+        readonly Snip1Rect: "snip1Rect";
+        readonly Snip2DiagRect: "snip2DiagRect";
+        readonly Snip2SameRect: "snip2SameRect";
+        readonly SnipRoundRect: "snipRoundRect";
+        readonly SquareTabs: "squareTabs";
+        readonly Star10: "star10";
+        readonly Star12: "star12";
+        readonly Star16: "star16";
+        readonly Star24: "star24";
+        readonly Star32: "star32";
+        readonly Star4: "star4";
+        readonly Star5: "star5";
+        readonly Star6: "star6";
+        readonly Star7: "star7";
+        readonly Star8: "star8";
+        readonly StraightConnector1: "straightConnector1";
+        readonly StripedRightArrow: "stripedRightArrow";
+        readonly Sun: "sun";
+        readonly SwooshArrow: "swooshArrow";
+        readonly Teardrop: "teardrop";
+        readonly Trapezoid: "trapezoid";
+        readonly Triangle: "triangle";
+        readonly UpArrow: "upArrow";
+        readonly UpArrowCallout: "upArrowCallout";
+        readonly UpDownArrow: "upDownArrow";
+        readonly UpDownArrowCallout: "upDownArrowCallout";
+        readonly UturnArrow: "uturnArrow";
+        readonly VerticalScroll: "verticalScroll";
+        readonly Wave: "wave";
+        readonly WedgeEllipseCallout: "wedgeEllipseCallout";
+        readonly WedgeRectCallout: "wedgeRectCallout";
+        readonly WedgeRoundRectCallout: "wedgeRoundRectCallout";
+    }>;
+    type Preset = typeof Preset[keyof typeof Preset];
+    /**
+     * A geometry definition, as DrawingML states one: adjust values, guides, handles, connection
+     * sites, text rectangle and paths. A shape drawn from its own geometry (a file's `custGeom`)
+     * gives one as its {@link IShape.Properties.geometry}; every {@link Preset} is one too.
+     *
+     * @remarks
+     * The definition is DrawingML's own formula language, kept verbatim (`'x1 +- hc dx1 0'`) so it
+     * reads like the markup it came from, and the way a file states a custom shape round-trips
+     * unchanged. SheetXL evaluates it rather than models it: lengths come out in the unit the shape
+     * is evaluated in (pixels), and angles in degrees. Inside the language, angles are 60,000ths of
+     * a degree and ratios are 100,000ths, which is what an adjust value is.
+     */
+    interface Def {
+        /** Adjust values, document order: `'name val N'`. */
+        av?: readonly string[];
+        /** Calculated guides, document order: `'name op a b c'`. A name may be rebound. */
+        gd?: readonly string[];
+        /**
+         * Adjust handles, document order.
+         *
+         * `'xy gdRefX gdRefY posX posY [minX maxX minY maxY]'` or
+         * `'polar gdRefR gdRefAng posX posY [minR maxR minAng maxAng]'`. An absent reference or bound
+         * is `_`; the bounds group is omitted when all four are absent.
+         */
+        ah?: readonly string[];
+        /** Connection sites, `'ang x y'` each. */
+        cxn?: readonly string[];
+        /** Text rectangle `'l t r b'`; absent is the whole frame. */
+        rect?: string;
+        paths: readonly DefPath[];
+    }
+    /** One path of a {@link Def}. */
+    interface DefPath {
+        /** `none` when the path is not filled, else its {@link PathFill | shading}; absent is `norm`. */
+        f?: 'none' | Exclude<PathFill, 'norm'>;
+        /** `0` when the path is not stroked. */
+        s?: 0;
+        /** Path coordinate space width; absent means the shape width. */
+        w?: number;
+        /** Path coordinate space height; absent means the shape height. */
+        h?: number;
+        /**
+         * Mini-path: `M x y | L x y | Q x1 y1 x2 y2 | C x1 y1 x2 y2 x3 y3 | A wR hR stAng swAng | Z`,
+         * space separated; coordinate tokens are guide names or integer literals.
+         */
+        d: string;
+    }
+    /** Edges of a rectangle in the shape's frame, in pixels. */
+    interface Rect {
+        l: number;
+        t: number;
+        r: number;
+        b: number;
+    }
+    /** Which paint a visited path takes. */
+    const PathLayer: {
+        /** The shape's fill, shaded as {@link IPath.fill} says. */
+        readonly Fill: "fill";
+        /** The shape's line. */
+        readonly Stroke: "stroke";
+        /** A marker at either end of the line (an arrowhead): a filled path painted with the line's paint. */
+        readonly Marker: "marker";
+    };
+    type PathLayer = typeof PathLayer[keyof typeof PathLayer];
+    /**
+     * How a fill is shaded: `norm` is the fill as it is; the others are the shaded faces of a cube,
+     * a can or a fold, each the fill through {@link FillTransfer}.
+     */
+    type PathFill = 'norm' | 'darken' | 'darkenLess' | 'lighten' | 'lightenLess';
+    /**
+     * Each shading's transfer, per color channel in sRGB: `c' = slope · c + intercept`, with `c` in
+     * `0..1`. As an SVG filter, `feFuncR`/`G`/`B` of `type="linear"`.
+     */
+    const FillTransfer: Readonly<Record<PathFill, readonly [slope: number, intercept: number]>>;
+    /** One path, as {@link IGeometry.forEachPath} visits it. */
+    interface IPath {
+        /** The visit's position in paint order: unique within one {@link IGeometry.forEachPath}. */
+        readonly index: number;
+        /** SVG path data, in pixels, in the frame of the shape. */
+        readonly d: string;
+        readonly layer: PathLayer;
+        /** The shading of a {@link PathLayer.Fill} path; `norm` on every other layer. */
+        readonly fill: PathFill;
+    }
+    /** How an adjust handle moves: along x and/or y, or by radius and/or angle about the shape's center. */
+    const HandleType: {
+        readonly XY: "xy";
+        readonly Polar: "polar";
+    };
+    type HandleType = typeof HandleType[keyof typeof HandleType];
+    /**
+     * An adjust handle, as {@link IGeometry.forEachHandle} visits it: where it is, in pixels in the
+     * shape's frame. What it moves and how far is the definition's business;
+     * {@link IGeometry.adjustmentsFromHandle} answers a drag.
+     */
+    interface IHandle {
+        readonly type: HandleType;
+        readonly index: number;
+        readonly x: number;
+        readonly y: number;
+    }
+    /** A point a connector may attach to, as {@link IGeometry.forEachConnection} visits it. */
+    interface IConnection {
+        readonly index: number;
+        readonly x: number;
+        readonly y: number;
+        /** The direction a connector leaves the site, in degrees clockwise from +x. */
+        readonly ang: number;
+    }
+}
+//# sourceMappingURL=IGeometry.d.ts.map