@btndprojects/loam-icons 0.0.0-stage → 0.1.1

package/dist/index.d.ts

@@ -0,0 +1,963 @@
+/** The icon registry data: name → ordered SVG primitives, drawn from lucide. */
+declare const iconData: {
+    check: {
+        t: "path";
+        d: string;
+    }[];
+    x: {
+        t: "path";
+        d: string;
+    }[];
+    'chevron-down': {
+        t: "path";
+        d: string;
+    }[];
+    'chevron-up': {
+        t: "path";
+        d: string;
+    }[];
+    'chevron-left': {
+        t: "path";
+        d: string;
+    }[];
+    'chevron-right': {
+        t: "path";
+        d: string;
+    }[];
+    plus: {
+        t: "path";
+        d: string;
+    }[];
+    minus: {
+        t: "path";
+        d: string;
+    }[];
+    'arrow-right': {
+        t: "path";
+        d: string;
+    }[];
+    'arrow-left': {
+        t: "path";
+        d: string;
+    }[];
+    search: ({
+        t: "path";
+        d: string;
+        cx?: undefined;
+        cy?: undefined;
+        r?: undefined;
+    } | {
+        t: "circle";
+        cx: number;
+        cy: number;
+        r: number;
+        d?: undefined;
+    })[];
+    info: ({
+        t: "circle";
+        cx: number;
+        cy: number;
+        r: number;
+        d?: undefined;
+    } | {
+        t: "path";
+        d: string;
+        cx?: undefined;
+        cy?: undefined;
+        r?: undefined;
+    })[];
+    'alert-triangle': {
+        t: "path";
+        d: string;
+    }[];
+    'alert-circle': ({
+        t: "circle";
+        cx: number;
+        cy: number;
+        r: number;
+        x1?: undefined;
+        y1?: undefined;
+        x2?: undefined;
+        y2?: undefined;
+    } | {
+        t: "line";
+        x1: number;
+        y1: number;
+        x2: number;
+        y2: number;
+        cx?: undefined;
+        cy?: undefined;
+        r?: undefined;
+    })[];
+    'check-circle': ({
+        t: "circle";
+        cx: number;
+        cy: number;
+        r: number;
+        d?: undefined;
+    } | {
+        t: "path";
+        d: string;
+        cx?: undefined;
+        cy?: undefined;
+        r?: undefined;
+    })[];
+    star: {
+        t: "path";
+        d: string;
+    }[];
+    heart: {
+        t: "path";
+        d: string;
+    }[];
+    menu: {
+        t: "path";
+        d: string;
+    }[];
+    'more-horizontal': {
+        t: "circle";
+        cx: number;
+        cy: number;
+        r: number;
+    }[];
+    'more-vertical': {
+        t: "circle";
+        cx: number;
+        cy: number;
+        r: number;
+    }[];
+    settings: ({
+        t: "path";
+        d: string;
+        cx?: undefined;
+        cy?: undefined;
+        r?: undefined;
+    } | {
+        t: "circle";
+        cx: number;
+        cy: number;
+        r: number;
+        d?: undefined;
+    })[];
+    user: ({
+        t: "path";
+        d: string;
+        cx?: undefined;
+        cy?: undefined;
+        r?: undefined;
+    } | {
+        t: "circle";
+        cx: number;
+        cy: number;
+        r: number;
+        d?: undefined;
+    })[];
+    bell: {
+        t: "path";
+        d: string;
+    }[];
+    calendar: ({
+        t: "path";
+        d: string;
+        x?: undefined;
+        y?: undefined;
+        width?: undefined;
+        height?: undefined;
+        rx?: undefined;
+    } | {
+        t: "rect";
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+        rx: number;
+        d?: undefined;
+    })[];
+    clock: ({
+        t: "circle";
+        cx: number;
+        cy: number;
+        r: number;
+        d?: undefined;
+    } | {
+        t: "path";
+        d: string;
+        cx?: undefined;
+        cy?: undefined;
+        r?: undefined;
+    })[];
+    trash: {
+        t: "path";
+        d: string;
+    }[];
+    edit: {
+        t: "path";
+        d: string;
+    }[];
+    copy: ({
+        t: "rect";
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+        rx: number;
+        ry: number;
+        d?: undefined;
+    } | {
+        t: "path";
+        d: string;
+        x?: undefined;
+        y?: undefined;
+        width?: undefined;
+        height?: undefined;
+        rx?: undefined;
+        ry?: undefined;
+    })[];
+    'external-link': {
+        t: "path";
+        d: string;
+    }[];
+    eye: ({
+        t: "path";
+        d: string;
+        cx?: undefined;
+        cy?: undefined;
+        r?: undefined;
+    } | {
+        t: "circle";
+        cx: number;
+        cy: number;
+        r: number;
+        d?: undefined;
+    })[];
+    loader: {
+        t: "path";
+        d: string;
+    }[];
+    home: {
+        t: "path";
+        d: string;
+    }[];
+    folder: {
+        t: "path";
+        d: string;
+    }[];
+    grid: ({
+        t: "path";
+        d: string;
+        x?: undefined;
+        y?: undefined;
+        width?: undefined;
+        height?: undefined;
+        rx?: undefined;
+    } | {
+        t: "rect";
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+        rx: number;
+        d?: undefined;
+    })[];
+    users: ({
+        t: "path";
+        d: string;
+        cx?: undefined;
+        cy?: undefined;
+        r?: undefined;
+    } | {
+        t: "circle";
+        cx: number;
+        cy: number;
+        r: number;
+        d?: undefined;
+    })[];
+    tag: ({
+        t: "path";
+        d: string;
+        cx?: undefined;
+        cy?: undefined;
+        r?: undefined;
+        fill?: undefined;
+    } | {
+        t: "circle";
+        cx: number;
+        cy: number;
+        r: number;
+        fill: true;
+        d?: undefined;
+    })[];
+    'chart-bar': {
+        t: "path";
+        d: string;
+    }[];
+    download: {
+        t: "path";
+        d: string;
+    }[];
+    upload: {
+        t: "path";
+        d: string;
+    }[];
+    filter: {
+        t: "path";
+        d: string;
+    }[];
+    refresh: {
+        t: "path";
+        d: string;
+    }[];
+    lock: ({
+        t: "rect";
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+        rx: number;
+        ry: number;
+        d?: undefined;
+    } | {
+        t: "path";
+        d: string;
+        x?: undefined;
+        y?: undefined;
+        width?: undefined;
+        height?: undefined;
+        rx?: undefined;
+        ry?: undefined;
+    })[];
+    mail: ({
+        t: "path";
+        d: string;
+        x?: undefined;
+        y?: undefined;
+        width?: undefined;
+        height?: undefined;
+        rx?: undefined;
+    } | {
+        t: "rect";
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+        rx: number;
+        d?: undefined;
+    })[];
+    link: {
+        t: "path";
+        d: string;
+    }[];
+    sun: ({
+        t: "circle";
+        cx: number;
+        cy: number;
+        r: number;
+        d?: undefined;
+    } | {
+        t: "path";
+        d: string;
+        cx?: undefined;
+        cy?: undefined;
+        r?: undefined;
+    })[];
+    moon: {
+        t: "path";
+        d: string;
+    }[];
+    'log-out': {
+        t: "path";
+        d: string;
+    }[];
+    circle: {
+        t: "circle";
+        cx: number;
+        cy: number;
+        r: number;
+    }[];
+    filedoc: {
+        t: "path";
+        d: string;
+    }[];
+    play: {
+        t: "path";
+        d: string;
+    }[];
+    pause: {
+        t: "rect";
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+        rx: number;
+    }[];
+    'skip-back': {
+        t: "path";
+        d: string;
+    }[];
+    'skip-forward': {
+        t: "path";
+        d: string;
+    }[];
+    volume: {
+        t: "path";
+        d: string;
+    }[];
+    'volume-off': ({
+        t: "path";
+        d: string;
+        x1?: undefined;
+        y1?: undefined;
+        x2?: undefined;
+        y2?: undefined;
+    } | {
+        t: "line";
+        x1: number;
+        y1: number;
+        x2: number;
+        y2: number;
+        d?: undefined;
+    })[];
+    captions: ({
+        t: "rect";
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+        rx: number;
+        ry: number;
+        d?: undefined;
+    } | {
+        t: "path";
+        d: string;
+        x?: undefined;
+        y?: undefined;
+        width?: undefined;
+        height?: undefined;
+        rx?: undefined;
+        ry?: undefined;
+    })[];
+    maximize: {
+        t: "path";
+        d: string;
+    }[];
+    image: ({
+        t: "rect";
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+        rx: number;
+        ry: number;
+        cx?: undefined;
+        cy?: undefined;
+        r?: undefined;
+        d?: undefined;
+    } | {
+        t: "circle";
+        cx: number;
+        cy: number;
+        r: number;
+        x?: undefined;
+        y?: undefined;
+        width?: undefined;
+        height?: undefined;
+        rx?: undefined;
+        ry?: undefined;
+        d?: undefined;
+    } | {
+        t: "path";
+        d: string;
+        x?: undefined;
+        y?: undefined;
+        width?: undefined;
+        height?: undefined;
+        rx?: undefined;
+        ry?: undefined;
+        cx?: undefined;
+        cy?: undefined;
+        r?: undefined;
+    })[];
+    wifi: {
+        t: "path";
+        d: string;
+    }[];
+    'wifi-off': {
+        t: "path";
+        d: string;
+    }[];
+    'cloud-off': {
+        t: "path";
+        d: string;
+    }[];
+    wrench: {
+        t: "path";
+        d: string;
+    }[];
+    pipette: {
+        t: "path";
+        d: string;
+    }[];
+    'map-pin': ({
+        t: "path";
+        d: string;
+        cx?: undefined;
+        cy?: undefined;
+        r?: undefined;
+    } | {
+        t: "circle";
+        cx: number;
+        cy: number;
+        r: number;
+        d?: undefined;
+    })[];
+    navigation: {
+        t: "polygon";
+        points: string;
+    }[];
+    'bell-off': {
+        t: "path";
+        d: string;
+    }[];
+    pin: {
+        t: "path";
+        d: string;
+    }[];
+    'arrow-up': {
+        t: "path";
+        d: string;
+    }[];
+    'arrow-down': {
+        t: "path";
+        d: string;
+    }[];
+    at: ({
+        t: "circle";
+        cx: number;
+        cy: number;
+        r: number;
+        d?: undefined;
+    } | {
+        t: "path";
+        d: string;
+        cx?: undefined;
+        cy?: undefined;
+        r?: undefined;
+    })[];
+    code: {
+        t: "path";
+        d: string;
+    }[];
+    globe: ({
+        t: "circle";
+        cx: number;
+        cy: number;
+        r: number;
+        d?: undefined;
+    } | {
+        t: "path";
+        d: string;
+        cx?: undefined;
+        cy?: undefined;
+        r?: undefined;
+    })[];
+    layers: {
+        t: "path";
+        d: string;
+    }[];
+    shield: {
+        t: "path";
+        d: string;
+    }[];
+    'list-ul': {
+        t: "path";
+        d: string;
+    }[];
+    'list-ol': {
+        t: "path";
+        d: string;
+    }[];
+    archive: ({
+        t: "rect";
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+        rx: number;
+        d?: undefined;
+    } | {
+        t: "path";
+        d: string;
+        x?: undefined;
+        y?: undefined;
+        width?: undefined;
+        height?: undefined;
+        rx?: undefined;
+    })[];
+    quote: {
+        t: "path";
+        d: string;
+    }[];
+    columns: ({
+        t: "rect";
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+        rx: number;
+        d?: undefined;
+    } | {
+        t: "path";
+        d: string;
+        x?: undefined;
+        y?: undefined;
+        width?: undefined;
+        height?: undefined;
+        rx?: undefined;
+    })[];
+    card: ({
+        t: "rect";
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+        rx: number;
+        x1?: undefined;
+        y1?: undefined;
+        x2?: undefined;
+        y2?: undefined;
+    } | {
+        t: "line";
+        x1: number;
+        y1: number;
+        x2: number;
+        y2: number;
+        x?: undefined;
+        y?: undefined;
+        width?: undefined;
+        height?: undefined;
+        rx?: undefined;
+    })[];
+    grip: {
+        t: "circle";
+        cx: number;
+        cy: number;
+        r: number;
+    }[];
+    'mouse-pointer-2': {
+        t: "path";
+        d: string;
+    }[];
+    wallet: {
+        t: "path";
+        d: string;
+    }[];
+    coins: ({
+        t: "path";
+        d: string;
+        cx?: undefined;
+        cy?: undefined;
+        r?: undefined;
+    } | {
+        t: "circle";
+        cx: number;
+        cy: number;
+        r: number;
+        d?: undefined;
+    })[];
+    bank: {
+        t: "path";
+        d: string;
+    }[];
+    invoice: {
+        t: "path";
+        d: string;
+    }[];
+    receipt: {
+        t: "path";
+        d: string;
+    }[];
+    phone: ({
+        t: "rect";
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+        rx: number;
+        ry: number;
+        d?: undefined;
+    } | {
+        t: "path";
+        d: string;
+        x?: undefined;
+        y?: undefined;
+        width?: undefined;
+        height?: undefined;
+        rx?: undefined;
+        ry?: undefined;
+    })[];
+    monitor: ({
+        t: "rect";
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+        rx: number;
+        x1?: undefined;
+        y1?: undefined;
+        x2?: undefined;
+        y2?: undefined;
+    } | {
+        t: "line";
+        x1: number;
+        y1: number;
+        x2: number;
+        y2: number;
+        x?: undefined;
+        y?: undefined;
+        width?: undefined;
+        height?: undefined;
+        rx?: undefined;
+    })[];
+    camera: ({
+        t: "path";
+        d: string;
+        cx?: undefined;
+        cy?: undefined;
+        r?: undefined;
+    } | {
+        t: "circle";
+        cx: number;
+        cy: number;
+        r: number;
+        d?: undefined;
+    })[];
+    barcode: {
+        t: "path";
+        d: string;
+    }[];
+    scan: {
+        t: "path";
+        d: string;
+    }[];
+    flash: {
+        t: "path";
+        d: string;
+    }[];
+    'flash-off': {
+        t: "path";
+        d: string;
+    }[];
+    flip: ({
+        t: "path";
+        d: string;
+        cx?: undefined;
+        cy?: undefined;
+        r?: undefined;
+    } | {
+        t: "circle";
+        cx: number;
+        cy: number;
+        r: number;
+        d?: undefined;
+    })[];
+    sliders: {
+        t: "path";
+        d: string;
+    }[];
+    leaf: {
+        t: "path";
+        d: string;
+    }[];
+    file: {
+        t: "path";
+        d: string;
+    }[];
+    bolt: {
+        t: "path";
+        d: string;
+    }[];
+    split: {
+        t: "path";
+        d: string;
+    }[];
+    branch: ({
+        t: "path";
+        d: string;
+        cx?: undefined;
+        cy?: undefined;
+        r?: undefined;
+    } | {
+        t: "circle";
+        cx: number;
+        cy: number;
+        r: number;
+        d?: undefined;
+    })[];
+    undo: {
+        t: "path";
+        d: string;
+    }[];
+    redo: {
+        t: "path";
+        d: string;
+    }[];
+    'zoom-in': ({
+        t: "circle";
+        cx: number;
+        cy: number;
+        r: number;
+        x1?: undefined;
+        y1?: undefined;
+        x2?: undefined;
+        y2?: undefined;
+    } | {
+        t: "line";
+        x1: number;
+        y1: number;
+        x2: number;
+        y2: number;
+        cx?: undefined;
+        cy?: undefined;
+        r?: undefined;
+    })[];
+    'zoom-out': ({
+        t: "circle";
+        cx: number;
+        cy: number;
+        r: number;
+        x1?: undefined;
+        y1?: undefined;
+        x2?: undefined;
+        y2?: undefined;
+    } | {
+        t: "line";
+        x1: number;
+        y1: number;
+        x2: number;
+        y2: number;
+        cx?: undefined;
+        cy?: undefined;
+        r?: undefined;
+    })[];
+    sparkle: ({
+        t: "path";
+        d: string;
+        cx?: undefined;
+        cy?: undefined;
+        r?: undefined;
+    } | {
+        t: "circle";
+        cx: number;
+        cy: number;
+        r: number;
+        d?: undefined;
+    })[];
+    print: ({
+        t: "path";
+        d: string;
+        x?: undefined;
+        y?: undefined;
+        width?: undefined;
+        height?: undefined;
+        rx?: undefined;
+    } | {
+        t: "rect";
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+        rx: number;
+        d?: undefined;
+    })[];
+};
+
+/**
+ * `@btndprojects/loam-icons` — the shared Loam icon set as framework-agnostic primitive data.
+ *
+ * Each icon is a list of SVG primitive descriptors on a `0 0 24 24` viewBox,
+ * drawn as 1.5px round strokes in `currentColor`. Web (`<svg>`) and native
+ * (`react-native-svg`) renderers each map these primitives to their elements,
+ * so both platforms draw from one source.
+ *
+ * The geometry is lucide's, transcribed statically into {@link iconData} (the
+ * generated `./icon-data.ts`) so the runtime carries no lucide dependency and
+ * stays tree-shakeable. Add or re-point an icon in `scripts/generate-icons.mjs`
+ * and run `pnpm --filter @btndprojects/loam-icons gen`, never by editing the data by hand.
+ * @module
+ */
+
+/**
+ * A single SVG primitive within an icon — one of the element kinds lucide
+ * emits. Both renderers (web `<svg>` and native `react-native-svg`) map every
+ * variant here to a concrete element.
+ */
+type IconPrimitive = {
+    t: 'path';
+    d: string;
+} | {
+    t: 'circle';
+    cx: number;
+    cy: number;
+    r: number;
+    fill?: boolean;
+} | {
+    t: 'line';
+    x1: number;
+    y1: number;
+    x2: number;
+    y2: number;
+} | {
+    t: 'rect';
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    rx?: number;
+    ry?: number;
+} | {
+    t: 'polyline';
+    points: string;
+} | {
+    t: 'polygon';
+    points: string;
+} | {
+    t: 'ellipse';
+    cx: number;
+    cy: number;
+    rx: number;
+    ry: number;
+};
+/** A valid icon name. */
+type IconName = keyof typeof iconData;
+/** The icon registry: name → ordered primitives. */
+declare const icons: Record<IconName, IconPrimitive[]>;
+/** All icon names, ordered as declared. */
+declare const iconNames: IconName[];
+/** The viewBox every Loam icon is drawn on. */
+declare const ICON_VIEWBOX = "0 0 24 24";
+/**
+ * Narrow an arbitrary string to a name the set actually carries.
+ *
+ * Every registry-driven surface has the same problem: a node type, a workflow
+ * step or a capture profile names its glyph as a plain `string` — deliberately,
+ * because those registries are host-extensible and must not depend on
+ * `@btndprojects/loam-icons` — so the *renderer* is the one that has to cope with a name the
+ * set does not carry. A fallback glyph is better than a thrown render.
+ *
+ * This lived as an identical two-line guard called `flowIconName` in
+ * `@btndprojects/loam-ui-web` and `@btndprojects/loam-ui-native`. The domain-specific fallback is worth
+ * keeping per caller (a workflow node falls back to `circle`), but the
+ * membership test is not something two packages should each own — the set is
+ * this package's, and only this package knows when it changes.
+ *
+ * @param name - A candidate glyph name, from a registry or a host.
+ * @param fallback - The glyph to use when `name` is not in the set.
+ * @returns `name` when the set carries it, otherwise `fallback`.
+ * @example
+ * ```ts
+ * <Icon name={iconNameOr(type.icon, 'circle')} />
+ * ```
+ */
+declare function iconNameOr(name: string, fallback: IconName): IconName;
+
+export { ICON_VIEWBOX, type IconName, type IconPrimitive, iconNameOr, iconNames, icons };