forwardfig 0.0.0-stage → 0.1.1

package/dist/index.d.ts

@@ -0,0 +1,66 @@
+import * as api from './api';
+import { layout } from './layout';
+import { THEMES } from './render';
+import type { Diagram } from './types';
+export * from './api';
+export type { Diagram, Node, Edge, Group, Dir } from './types';
+/** Drawing core: lay out and render a plain Diagram (what Figure.diagram() returns). */
+export declare function draw(d: Diagram, options?: {
+    theme?: string;
+    materials?: boolean;
+}): string;
+export { layout, THEMES };
+declare const _default: {
+    draw: typeof draw;
+    layout: typeof layout;
+    THEMES: Record<string, import("./render").Theme>;
+    layer<O extends api.NodeOptions>(shape: api.Shape, label: string, options: O, kind?: string, defaults?: api.NodeOptions): api.Layer<O>;
+    preset<O extends api.NodeOptions = api.NodeOptions>(shape: api.Shape, label?: string, defaults?: string | (api.NodeOptions & {
+        kind?: string;
+    })): api.Factory<O>;
+    vector(values: string[], a?: string | api.NodeOptions, b?: api.NodeOptions): api.Layer<api.NodeOptions>;
+    waveform(a?: string | api.WaveformOptions, b?: api.WaveformOptions): api.Layer<api.WaveformOptions>;
+    image(src: api.ImageSource | api.ImageSource[], a?: string | api.ImageOptions, b?: api.ImageOptions): api.Layer<api.ImageOptions>;
+    magnify(a?: string | api.MagnifyOptions, b?: api.MagnifyOptions): api.Layer<api.MagnifyOptions>;
+    matrix(a?: string | api.MatrixOptions, b?: api.MatrixOptions): api.Layer<api.MatrixOptions>;
+    voxels(a?: string | api.VoxelOptions, b?: api.VoxelOptions): api.Layer<api.VoxelOptions>;
+    configure(config: api.Config | null): api.FigureOptions;
+    figure(build: (fig: api.Figure) => unknown): api.Figure;
+    figure(options: api.FigureOptions, build: (fig: api.Figure) => unknown): api.Figure;
+    Graph: typeof api.Graph;
+    Tensor: typeof api.Tensor;
+    block: api.Factory<api.NodeOptions>;
+    thin: api.Factory<api.NodeOptions>;
+    text: api.Factory<api.NodeOptions>;
+    circle: api.Factory<api.NodeOptions>;
+    op: api.Factory<api.NodeOptions>;
+    enc: api.Factory<api.NodeOptions>;
+    dec: api.Factory<api.NodeOptions>;
+    tensor: api.Factory<api.TensorOptions>;
+    stack: api.Factory<api.StackOptions>;
+    neurons: api.Factory<api.NeuronOptions>;
+    mha: api.Factory<api.NodeOptions>;
+    attention: api.Factory<api.NodeOptions>;
+    ffn: api.Factory<api.NodeOptions>;
+    mlp: api.Factory<api.NodeOptions>;
+    norm: api.Factory<api.NodeOptions>;
+    embed: api.Factory<api.NodeOptions>;
+    linear: api.Factory<api.NodeOptions>;
+    softmax: api.Factory<api.NodeOptions>;
+    matmul: api.Factory<api.NodeOptions>;
+    concat: api.Factory<api.NodeOptions>;
+    conv: api.Factory<api.NodeOptions>;
+    pool: api.Factory<api.NodeOptions>;
+    act: api.Factory<api.NodeOptions>;
+    dropout: api.Factory<api.NodeOptions>;
+    loss: api.Factory<api.NodeOptions>;
+    gaussian: api.Factory<api.GaussianOptions>;
+    space: api.Factory<api.SpaceOptions>;
+    sphere: api.Factory<api.SphereOptions>;
+    pointcloud: api.Factory<api.PointCloudOptions>;
+    add: (...xs: api.Tensor[]) => api.Tensor;
+    mul: (...xs: api.Tensor[]) => api.Tensor;
+    Module: typeof api.Module;
+    Figure: typeof api.Figure;
+};
+export default _default;

package/dist/layout.d.ts

@@ -0,0 +1,17 @@
+import type { Diagram, Node } from './types';
+export declare const FS = 13;
+export declare const OUTSIDE: Set<string>;
+export declare const values: (n: Node) => string[];
+/** label size of a block: its own fontSize, else derived from the figure's base size */
+export declare const labelSize: (n: Node, base: number) => number;
+/**
+ * Linear part [a, b, c, d] of an image's transform (x' = a·x + c·y, y' = b·x + d·y).
+ * tilt: turn around the vertical axis, drawn obliquely (x shrinks, the far side rises,
+ * as depth does in an oblique drawing);
+ * rotate: in-plane. Both in degrees.
+ */
+export declare const imageMatrix: (attrs: Record<string, string>) => [number, number, number, number];
+export declare const nums: (s: string | undefined, def: number[]) => number[];
+export type Box = [number, number, number, number];
+export declare const hits: (a: Box, b: Box) => boolean;
+export declare function layout(d: Diagram): Diagram;

package/dist/materials.d.ts

@@ -0,0 +1,3 @@
+export type Material = 'ice' | 'heat' | 'glass' | 'metal' | 'noise';
+/** Bake `kind` for a w×h block into an image URL (cached per size). */
+export declare function bake(kind: Material, w: number, h: number, seed?: number): string | null;

package/dist/render.d.ts

@@ -0,0 +1,20 @@
+import type { Diagram } from './types';
+type Pair = [fill: string, stroke: string];
+export interface Theme {
+    bg: string;
+    text: string;
+    sub: string;
+    edge: string;
+    halo: string;
+    group: Pair;
+    shadow: string;
+    dark: boolean;
+    /** blocks without a color: neutral grey, readable on light and dark pages */
+    none: Pair;
+    ice: [string, string, string, string];
+    fire: [string, string, string];
+    c: Record<string, Pair>;
+}
+export declare const THEMES: Record<string, Theme>;
+export declare function render(d: Diagram, theme?: string, materials?: boolean): string;
+export {};

package/dist/tex.d.ts

@@ -0,0 +1,37 @@
+export declare const SANS = "Inter,\"Helvetica Neue\",Helvetica,Arial,sans-serif";
+/** normal font weight, the default for labels */
+export declare const REGULAR = 400;
+export declare const SERIF = "\"Latin Modern Math\",\"STIX Two Math\",\"Cambria Math\",\"Times New Roman\",serif";
+export interface Run {
+    t: string;
+    x: number;
+    dy: number;
+    size: number;
+    it: boolean;
+    b: boolean;
+    serif: boolean;
+    /** typeset math from the TeX engine: inner SVG markup, its viewBox, and its box around the baseline */
+    math?: {
+        inner: string;
+        viewBox: string;
+        w: number;
+        asc: number;
+        desc: number;
+    };
+}
+/** tex source → an <svg viewBox="..."> string, as MathJax's tex2svg produces (1000 viewBox units per em). */
+export type TexEngine = (tex: string) => string;
+/** Use a TeX engine (null = always the built-in fallback, undefined = auto-detect MathJax). */
+export declare function setTex(e: TexEngine | null | undefined): void;
+export interface TextBox {
+    lines: Run[][];
+    widths: number[];
+    w: number;
+    h: number;
+    lh: number;
+    size: number;
+}
+export declare function font(size: number, it: boolean, b: boolean | number, serif: boolean, family?: string): string;
+export declare function measure(t: string, f: string, size: number): number;
+/** Lay out a label: newline, `\\` or `<br>` break lines, `$...$` switches to math. */
+export declare function layoutLabel(label: string, size: number, weight?: number, family?: string): TextBox;

package/dist/types.d.ts

@@ -0,0 +1,57 @@
+export type Dir = 'TB' | 'BT' | 'LR' | 'RL';
+export interface Node {
+    id: string;
+    shape: string;
+    label: string;
+    color?: string;
+    flags: Set<string>;
+    attrs: Record<string, string>;
+    groups: string[];
+    order: number;
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+}
+export interface Edge {
+    from: string;
+    to: string;
+    op: string;
+    label?: string;
+    flags: Set<string>;
+    attrs: Record<string, string>;
+    pts: [number, number][];
+    curve?: number;
+    fc?: boolean;
+    lx?: number;
+    ly?: number;
+}
+export interface Group {
+    id: string;
+    label: string;
+    parent?: string;
+    flags: Set<string>;
+    attrs: Record<string, string>;
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+}
+export interface Diagram {
+    dir: Dir;
+    theme: string;
+    gap?: [number, number];
+    /** base text size (px); blocks may set attrs.fontSize */
+    fontSize?: number;
+    /** base CSS font family; blocks may set attrs.fontFamily */
+    fontFamily?: string;
+    /** a key to the looks the figure uses (frozen, trainable, textures, crossed); labels override the names */
+    legend?: {
+        position?: 'bottom' | 'right';
+        labels?: Partial<Record<string, string>>;
+    };
+    nodes: Map<string, Node>;
+    edges: Edge[];
+    groups: Group[];
+    ranks: string[][];
+}

package/package.json

@@ -1,6 +1,48 @@
 {
   "name": "forwardfig",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.1",
+  "description": "Draw ML architecture figures in TypeScript, written the way you write the model. Zero dependencies, SVG out.",
+  "type": "module",
+  "main": "dist/forwardfig.js",
+  "module": "dist/forwardfig.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/forwardfig.js"
+    }
+  },
+  "bin": {
+    "forwardfig": "dist/cli.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "bun build src/index.ts --minify --outfile dist/forwardfig.js && bun build src/cli.ts --minify --target=node --external sharp --outfile dist/cli.js && bun build src/index.ts --minify --format=iife --outfile dist/forwardfig.iife.js && tsc --emitDeclarationOnly --declaration --outDir dist",
+    "test": "bun test",
+    "check": "tsc --noEmit",
+    "docs:build": "bun doc/site/build.mjs",
+    "docs:dev": "bun doc/site/build.mjs && bun doc/site/serve.mjs",
+    "prepublishOnly": "bun run check && bun test && bun run build"
+  },
+  "devDependencies": {
+    "@types/node": "^26.6.5",
+    "marked": "^18.1.1",
+    "sharp": "^0.35.5",
+    "typescript": "^5.6.0"
+  },
+  "peerDependencies": {
+    "sharp": ">=0.33"
+  },
+  "peerDependenciesMeta": {
+    "sharp": {
+      "optional": true
+    }
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/frinfo702/forwardfig.git"
+  }
+}