@memberjunction/core-actions 2.107.0 → 2.109.0

package/dist/custom/visualization/shared/svg-types.d.ts

@@ -0,0 +1,354 @@
+/**
+ * @fileoverview Type definitions for server-rendered SVG visualizations.
+ * These types support the MemberJunction infographic system and provide
+ * consistent interfaces across all visualization actions.
+ *
+ * @module @memberjunction/actions-core/visualization
+ * @since 2.107.0
+ */
+import { ActionResultSimple } from '@memberjunction/actions-base';
+/**
+ * ViewBox configuration for SVG canvas dimensions and padding
+ */
+export interface ViewBox {
+    /** Final pixel width of the SVG */
+    width: number;
+    /** Final pixel height of the SVG */
+    height: number;
+    /** Padding around content (uniform or per-side) */
+    padding?: number | {
+        top?: number;
+        right?: number;
+        bottom?: number;
+        left?: number;
+    };
+}
+/**
+ * Font specification for text rendering
+ */
+export interface FontSpec {
+    /** Font family stack (e.g., 'Inter, Arial, sans-serif') */
+    family?: string;
+    /** Font size in pixels (default: 12-14) */
+    size?: number;
+    /** Font weight (400, 600, 'bold', etc.) */
+    weight?: number | string;
+    /** Line height in em units */
+    lineHeight?: number;
+}
+/**
+ * Color palette configuration
+ */
+export type Palette = {
+    type: 'named';
+    name: 'mjDefault' | 'gray' | 'pastel' | 'highContrast';
+} | {
+    type: 'manual';
+    background?: string;
+    foreground?: string;
+    categorical?: string[];
+    sequential?: string[];
+};
+/**
+ * Branding and visual identity configuration
+ */
+export interface Branding {
+    /** Color palette to use */
+    palette?: Palette;
+    /** Font specification */
+    font?: FontSpec;
+    /** Optional logo SVG snippet to place in corner */
+    logoSvg?: string;
+    /** Optional watermark text */
+    watermarkText?: string;
+}
+/**
+ * Accessibility configuration for WCAG compliance
+ */
+export interface Accessibility {
+    /** Title for <title> element */
+    title?: string;
+    /** Description for <desc> element */
+    desc?: string;
+    /** ARIA role for root SVG */
+    ariaRole?: 'img' | 'graphics-document';
+    /** Include data table for screen readers */
+    includeDataTable?: boolean;
+}
+/**
+ * Animation configuration (primarily for web display)
+ */
+export interface AnimationOptions {
+    /** Enable animations (default: false for print-first) */
+    enabled?: boolean;
+    /** Prefer CSS animations over inline JS */
+    preferCSS?: boolean;
+    /** Animation duration in milliseconds */
+    durationMs?: number;
+    /** Easing function */
+    ease?: 'linear' | 'ease' | 'ease-in' | 'ease-out' | 'ease-in-out';
+    /** Stagger delay between items in milliseconds */
+    staggerMs?: number;
+}
+/**
+ * Interactivity configuration (requires inline JS)
+ */
+export interface InteractivityOptions {
+    /** Enable interactivity (default: false) */
+    enabled?: boolean;
+    /** Show tooltips on hover */
+    tooltips?: boolean;
+    /** Enable expand/collapse for trees */
+    expandCollapse?: boolean;
+    /** Enable pan and zoom */
+    panZoom?: boolean;
+    /** Minimum zoom scale (default: 0.5) */
+    panZoomMinScale?: number;
+    /** Maximum zoom scale (default: 3) */
+    panZoomMaxScale?: number;
+    /** Show zoom control buttons (default: false) */
+    panZoomShowControls?: boolean;
+    /** Highlight connected nodes on hover (network graphs) */
+    highlightConnected?: boolean;
+}
+/**
+ * Export and rendering controls
+ */
+export interface ExportControls {
+    /** Inline CSS in <style> tag (default: true) */
+    embedCSS?: boolean;
+    /** Inline JavaScript in <script> tag (default: false) */
+    embedJS?: boolean;
+    /** Prefix for element IDs to ensure uniqueness */
+    idPrefix?: string;
+    /** Seed for deterministic random layouts */
+    seed?: number;
+    /** Wrap SVG in scrollable HTML container */
+    wrapWithContainer?: boolean;
+    /** Maximum container width (default: 1200) */
+    maxContainerWidth?: number;
+    /** Maximum container height (default: 800) */
+    maxContainerHeight?: number;
+}
+/**
+ * Base configuration shared by all SVG actions
+ */
+export interface ActionBase {
+    /** ViewBox dimensions and padding */
+    viewBox: ViewBox;
+    /** Branding and visual identity */
+    branding?: Branding;
+    /** Accessibility configuration */
+    a11y?: Accessibility;
+    /** Animation options */
+    animation?: AnimationOptions;
+    /** Interactivity options */
+    interactivity?: InteractivityOptions;
+    /** Export controls */
+    export?: ExportControls;
+    /** Pass-through metadata for tracing/debugging */
+    meta?: Record<string, unknown>;
+}
+/**
+ * Standardized result from SVG actions
+ */
+export interface SVGActionResult extends ActionResultSimple {
+    /** SVG XML string ready to embed */
+    svg?: string;
+    /** Width in pixels */
+    width?: number;
+    /** Height in pixels */
+    height?: number;
+    /** Warnings about rendering issues */
+    warnings?: string[];
+    /** Diagnostic information */
+    diagnostics?: Record<string, unknown>;
+}
+/**
+ * Types of nodes in flowcharts
+ */
+export type FlowNodeKind = 'start' | 'end' | 'process' | 'decision' | 'input' | 'output' | 'subprocess';
+/**
+ * Node in a flowchart
+ */
+export interface FlowNode {
+    /** Unique node identifier */
+    id: string;
+    /** Node type/shape */
+    kind: FlowNodeKind;
+    /** Display label */
+    label: string;
+    /** Optional note/description */
+    note?: string;
+    /** Optional icon SVG */
+    icon?: string;
+    /** Override width (auto-calculated if not provided) */
+    width?: number;
+    /** Override height (auto-calculated if not provided) */
+    height?: number;
+}
+/**
+ * Edge connecting flowchart nodes
+ */
+export interface FlowEdge {
+    /** Source node ID */
+    from: string;
+    /** Target node ID */
+    to: string;
+    /** Optional edge label */
+    label?: string;
+    /** Render as dashed line */
+    dashed?: boolean;
+}
+/**
+ * Layout configuration for flowcharts
+ */
+export interface FlowLayout {
+    /** Layout direction */
+    direction?: 'TB' | 'LR' | 'RL' | 'BT';
+    /** Vertical spacing between ranks */
+    rankSep?: number;
+    /** Horizontal spacing between nodes */
+    nodeSep?: number;
+}
+/**
+ * Node in an org chart
+ */
+export interface OrgNode {
+    /** Unique node identifier */
+    id: string;
+    /** Person/position name */
+    label: string;
+    /** Job title/role */
+    role?: string;
+    /** Avatar URL (data URI or omitted) */
+    avatarUrl?: string;
+    /** Child nodes in hierarchy */
+    children?: OrgNode[];
+    /** Highlight this node */
+    highlight?: boolean;
+}
+/**
+ * Attribute in an entity
+ */
+export interface ERAttribute {
+    /** Attribute name */
+    name: string;
+    /** Data type */
+    type?: string;
+    /** Primary key indicator */
+    pk?: boolean;
+    /** Foreign key indicator */
+    fk?: boolean;
+}
+/**
+ * Table/Entity in ER diagram
+ */
+export interface ERTable {
+    /** Unique table identifier */
+    id: string;
+    /** Table display name */
+    name: string;
+    /** Table attributes/columns */
+    attrs: ERAttribute[];
+}
+/**
+ * Relationship between entities
+ */
+export interface ERRelation {
+    /** Source table ID */
+    from: string;
+    /** Target table ID */
+    to: string;
+    /** Relationship cardinality */
+    label?: '1-1' | '1-N' | 'N-M';
+}
+/**
+ * Word with weight for cloud/tag visualization
+ */
+export interface WordItem {
+    /** The word/term */
+    text: string;
+    /** Weight/frequency/importance */
+    weight: number;
+}
+/**
+ * Word cloud layout configuration
+ */
+export interface CloudLayout {
+    /** Rotation strategy */
+    rotate?: 'none' | 'few' | 'mixed';
+    /** Padding between words */
+    padding?: number;
+    /** Spiral algorithm type */
+    spiral?: 'archimedean' | 'rectangular';
+    /** Minimum font size */
+    minFont?: number;
+    /** Maximum font size */
+    maxFont?: number;
+}
+/**
+ * Node in a network graph
+ */
+export interface GraphNode {
+    /** Unique node identifier */
+    id: string;
+    /** Display label */
+    label?: string;
+    /** Group/category for coloring */
+    group?: string;
+    /** Node size (auto-calculated if not provided) */
+    size?: number;
+}
+/**
+ * Edge connecting graph nodes
+ */
+export interface GraphEdge {
+    /** Optional edge identifier */
+    id?: string;
+    /** Source node ID */
+    source: string;
+    /** Target node ID */
+    target: string;
+    /** Edge weight/strength */
+    weight?: number;
+    /** Directed edge (arrow) */
+    directed?: boolean;
+}
+/**
+ * Network layout type
+ */
+export type NetworkLayoutType = 'force' | 'radial' | 'tree' | 'grid';
+/**
+ * Physics simulation parameters for force-directed layouts
+ */
+export interface PhysicsParams {
+    /** Charge/repulsion strength (negative = repel) */
+    charge?: number;
+    /** Ideal distance between connected nodes */
+    linkDistance?: number;
+    /** Number of simulation iterations */
+    iterations?: number;
+}
+/**
+ * Decision tree node (hierarchical)
+ */
+export interface DecisionNode {
+    /** Unique node identifier */
+    id: string;
+    /** Node label */
+    label: string;
+    /** Optional value/probability */
+    value?: number;
+    /** Child nodes in tree */
+    children?: DecisionNode[];
+    /** Collapsed state (if interactivity enabled) */
+    collapsed?: boolean;
+    /** Optional note */
+    note?: string;
+}
+/**
+ * Node shape for decision trees
+ */
+export type NodeShape = 'rect' | 'circle' | 'pill';
+//# sourceMappingURL=svg-types.d.ts.map

package/dist/custom/visualization/shared/svg-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"svg-types.d.ts","sourceRoot":"","sources":["../../../../src/custom/visualization/shared/svg-types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAElE;;GAEG;AACH,MAAM,WAAW,OAAO;IACpB,mCAAmC;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,oCAAoC;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,mDAAmD;IACnD,OAAO,CAAC,EAAE,MAAM,GAAG;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CACvF;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACrB,2DAA2D;IAC3D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2CAA2C;IAC3C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,2CAA2C;IAC3C,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB,8BAA8B;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,MAAM,OAAO,GACb;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,IAAI,EAAE,WAAW,GAAG,MAAM,GAAG,QAAQ,GAAG,cAAc,CAAA;CAAE,GACzE;IACI,IAAI,EAAE,QAAQ,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB,CAAC;AAER;;GAEG;AACH,MAAM,WAAW,QAAQ;IACrB,2BAA2B;IAC3B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,yBAAyB;IACzB,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,mDAAmD;IACnD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,8BAA8B;IAC9B,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B,gCAAgC;IAChC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qCAAqC;IACrC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,6BAA6B;IAC7B,QAAQ,CAAC,EAAE,KAAK,GAAG,mBAAmB,CAAC;IACvC,4CAA4C;IAC5C,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,yDAAyD;IACzD,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,2CAA2C;IAC3C,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,yCAAyC;IACzC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,sBAAsB;IACtB,IAAI,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,SAAS,GAAG,UAAU,GAAG,aAAa,CAAC;IAClE,kDAAkD;IAClD,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACjC,4CAA4C;IAC5C,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,6BAA6B;IAC7B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,uCAAuC;IACvC,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,0BAA0B;IAC1B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,wCAAwC;IACxC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,sCAAsC;IACtC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,iDAAiD;IACjD,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,0DAA0D;IAC1D,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC3B,gDAAgD;IAChD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,yDAAyD;IACzD,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,kDAAkD;IAClD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,4CAA4C;IAC5C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,4CAA4C;IAC5C,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,8CAA8C;IAC9C,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,8CAA8C;IAC9C,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACvB,qCAAqC;IACrC,OAAO,EAAE,OAAO,CAAC;IACjB,mCAAmC;IACnC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,kCAAkC;IAClC,IAAI,CAAC,EAAE,aAAa,CAAC;IACrB,wBAAwB;IACxB,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAC7B,4BAA4B;IAC5B,aAAa,CAAC,EAAE,oBAAoB,CAAC;IACrC,sBAAsB;IACtB,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,kDAAkD;IAClD,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,kBAAkB;IACvD,oCAAoC;IACpC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,sBAAsB;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,uBAAuB;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,sCAAsC;IACtC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,6BAA6B;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACzC;AAMD;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG,KAAK,GAAG,SAAS,GAAG,UAAU,GAAG,OAAO,GAAG,QAAQ,GAAG,YAAY,CAAC;AAExG;;GAEG;AACH,MAAM,WAAW,QAAQ;IACrB,6BAA6B;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,sBAAsB;IACtB,IAAI,EAAE,YAAY,CAAC;IACnB,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,gCAAgC;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,wBAAwB;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uDAAuD;IACvD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,wDAAwD;IACxD,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACrB,qBAAqB;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,qBAAqB;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,0BAA0B;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,4BAA4B;IAC5B,MAAM,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACvB,uBAAuB;IACvB,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;IACtC,qCAAqC;IACrC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,uCAAuC;IACvC,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACpB,6BAA6B;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,2BAA2B;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,qBAAqB;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uCAAuC;IACvC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,+BAA+B;IAC/B,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;IACrB,0BAA0B;IAC1B,SAAS,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IACxB,qBAAqB;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,gBAAgB;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,4BAA4B;IAC5B,EAAE,CAAC,EAAE,OAAO,CAAC;IACb,4BAA4B;IAC5B,EAAE,CAAC,EAAE,OAAO,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACpB,8BAA8B;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,yBAAyB;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,+BAA+B;IAC/B,KAAK,EAAE,WAAW,EAAE,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACvB,sBAAsB;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,sBAAsB;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,+BAA+B;IAC/B,KAAK,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;CACjC;AAMD;;GAEG;AACH,MAAM,WAAW,QAAQ;IACrB,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,kCAAkC;IAClC,MAAM,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IACxB,wBAAwB;IACxB,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,OAAO,CAAC;IAClC,4BAA4B;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,4BAA4B;IAC5B,MAAM,CAAC,EAAE,aAAa,GAAG,aAAa,CAAC;IACvC,wBAAwB;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,wBAAwB;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAMD;;GAEG;AACH,MAAM,WAAW,SAAS;IACtB,6BAA6B;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,oBAAoB;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,kCAAkC;IAClC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,kDAAkD;IAClD,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACtB,+BAA+B;IAC/B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,qBAAqB;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,qBAAqB;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,2BAA2B;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,4BAA4B;IAC5B,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,CAAC;AAErE;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B,mDAAmD;IACnD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,6CAA6C;IAC7C,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,sCAAsC;IACtC,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB,6BAA6B;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,iBAAiB;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,iCAAiC;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAC;IAC1B,iDAAiD;IACjD,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,oBAAoB;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,CAAC"}

package/dist/custom/visualization/shared/svg-types.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * @fileoverview Type definitions for server-rendered SVG visualizations.
+ * These types support the MemberJunction infographic system and provide
+ * consistent interfaces across all visualization actions.
+ *
+ * @module @memberjunction/actions-core/visualization
+ * @since 2.107.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=svg-types.js.map

package/dist/custom/visualization/shared/svg-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"svg-types.js","sourceRoot":"","sources":["../../../../src/custom/visualization/shared/svg-types.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG"}

package/dist/custom/visualization/shared/svg-utils.d.ts

@@ -0,0 +1,166 @@
+/**
+ * @fileoverview Utility functions for SVG creation, manipulation, and sanitization.
+ * These utilities provide security, consistency, and convenience for all visualization actions.
+ *
+ * @module @memberjunction/actions-core/visualization
+ * @since 2.107.0
+ */
+import { ViewBox, Accessibility } from './svg-types';
+/**
+ * Utility class for SVG operations
+ */
+export declare class SVGUtils {
+    /**
+     * Creates a base SVG element with proper namespace and dimensions
+     *
+     * @param width - SVG width in pixels
+     * @param height - SVG height in pixels
+     * @param idPrefix - Optional ID prefix for the root SVG element
+     * @returns JSDOM Document containing the SVG
+     */
+    static createSVG(width: number, height: number, idPrefix?: string): Document;
+    /**
+     * Sanitizes text content to prevent XSS attacks
+     *
+     * @param text - Raw text content
+     * @returns HTML-safe text
+     */
+    static sanitizeText(text: string): string;
+    /**
+     * Sanitizes SVG string to remove potentially malicious content
+     * - Removes event handlers (on*)
+     * - Removes external image references
+     * - Removes external use references
+     * - Restricts href to # and mailto: only
+     *
+     * @param svgString - Raw SVG XML string
+     * @returns Sanitized SVG string
+     */
+    static sanitizeSVG(svgString: string): string;
+    /**
+     * Generates a unique ID with prefix and timestamp
+     *
+     * @param prefix - ID prefix (e.g., 'flow', 'node')
+     * @param index - Index or identifier
+     * @returns Unique ID string
+     */
+    static generateId(prefix: string, index: number | string): string;
+    /**
+     * Adds accessibility elements to SVG root
+     *
+     * @param svg - SVG element to enhance
+     * @param a11y - Accessibility configuration
+     */
+    static addA11y(svg: SVGElement, a11y: Accessibility): void;
+    /**
+     * Injects inline CSS styles into SVG
+     *
+     * @param svg - SVG element
+     * @param css - CSS string to inject
+     */
+    static addStyles(svg: SVGElement, css: string): void;
+    /**
+     * Calculates viewBox with padding applied
+     *
+     * @param viewBox - ViewBox configuration
+     * @returns Padding-adjusted dimensions and offsets
+     */
+    static calculateViewBox(viewBox: ViewBox): {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+        contentWidth: number;
+        contentHeight: number;
+    };
+    /**
+     * Creates a <defs> element if it doesn't exist in SVG
+     *
+     * @param svg - SVG element
+     * @returns The defs element (existing or newly created)
+     */
+    static getOrCreateDefs(svg: SVGElement): SVGDefsElement;
+    /**
+     * Adds an arrowhead marker definition to SVG
+     *
+     * @param svg - SVG element
+     * @param id - Marker ID
+     * @param color - Arrow color
+     * @returns Marker ID for use in marker-end attribute
+     */
+    static addArrowMarker(svg: SVGElement, id: string, color?: string): string;
+    /**
+     * Creates a seeded pseudo-random number generator
+     * Uses simple Linear Congruential Generator for deterministic output
+     *
+     * @param seed - Random seed
+     * @returns Function that returns random numbers between 0 and 1
+     */
+    static seededRandom(seed: number): () => number;
+    /**
+     * Wraps text to fit within a specified width
+     *
+     * @param text - Text to wrap
+     * @param maxWidth - Maximum width in characters (approximate)
+     * @returns Array of text lines
+     */
+    static wrapText(text: string, maxWidth: number): string[];
+    /**
+     * Calculates text width (approximate based on character count and font size)
+     * More accurate measurement would require actual rendering
+     *
+     * @param text - Text content
+     * @param fontSize - Font size in pixels
+     * @returns Estimated width in pixels
+     */
+    static estimateTextWidth(text: string, fontSize?: number): number;
+    /**
+     * Creates a rounded rectangle path
+     *
+     * @param x - X coordinate
+     * @param y - Y coordinate
+     * @param width - Width
+     * @param height - Height
+     * @param radius - Corner radius
+     * @returns SVG path data string
+     */
+    static roundedRectPath(x: number, y: number, width: number, height: number, radius: number): string;
+    /**
+     * Wraps SVG string in a scrollable HTML container
+     * Useful for large visualizations that exceed viewport size
+     *
+     * @param svgString - The SVG XML string to wrap
+     * @param maxWidth - Maximum container width in pixels (default: 1200)
+     * @param maxHeight - Maximum container height in pixels (default: 800)
+     * @param showBorder - Whether to show container border (default: true)
+     * @param borderColor - Border color (default: #ddd)
+     * @returns HTML string with SVG wrapped in scrollable div
+     */
+    static wrapWithScrollContainer(svgString: string, maxWidth?: number, maxHeight?: number, showBorder?: boolean, borderColor?: string): string;
+    /**
+     * Generates self-contained pan/zoom script for SVG
+     * No external dependencies - fully embedded JavaScript
+     *
+     * @param containerId - ID of the SVG group to apply transform to
+     * @param minScale - Minimum zoom level (default: 0.5)
+     * @param maxScale - Maximum zoom level (default: 3)
+     * @param showControls - Show zoom in/out/reset buttons (default: false)
+     * @returns Script tag with pan/zoom implementation
+     */
+    static generatePanZoomScript(containerId?: string, minScale?: number, maxScale?: number, showControls?: boolean): string;
+    /**
+     * Generates zoom control buttons script
+     * @returns Script code for zoom controls (internal use)
+     */
+    private static generateZoomControlsScript;
+    /**
+     * Generates interactive tooltip script for SVG elements
+     * Elements must have data-tooltip attribute
+     *
+     * @param svg - SVG element to add tooltip to
+     * @param doc - Document to create elements in
+     * @returns Script tag with tooltip implementation
+     */
+    static addTooltipSupport(svg: SVGElement, doc: Document): void;
+}
+//# sourceMappingURL=svg-utils.d.ts.map

package/dist/custom/visualization/shared/svg-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"svg-utils.d.ts","sourceRoot":"","sources":["../../../../src/custom/visualization/shared/svg-utils.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,EAAE,OAAO,EAAE,aAAa,EAAW,MAAM,aAAa,CAAC;AAE9D;;GAEG;AACH,qBAAa,QAAQ;IACjB;;;;;;;OAOG;IACH,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,QAAQ;IAU5E;;;;;OAKG;IACH,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IASzC;;;;;;;;;OASG;IACH,MAAM,CAAC,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM;IAmB7C;;;;;;OAMG;IACH,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM;IAIjE;;;;;OAKG;IACH,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,UAAU,EAAE,IAAI,EAAE,aAAa,GAAG,IAAI;IAgC1D;;;;;OAKG;IACH,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAmBpD;;;;;OAKG;IACH,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG;QACvC,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;QACf,YAAY,EAAE,MAAM,CAAC;QACrB,aAAa,EAAE,MAAM,CAAC;KACzB;IA2BD;;;;;OAKG;IACH,MAAM,CAAC,eAAe,CAAC,GAAG,EAAE,UAAU,GAAG,cAAc;IASvD;;;;;;;OAOG;IACH,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,UAAU,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,GAAE,MAAe,GAAG,MAAM;IA6BlF;;;;;;OAMG;IACH,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,MAAM;IAQ/C;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE;IAmBzD;;;;;;;OAOG;IACH,MAAM,CAAC,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,GAAE,MAAW,GAAG,MAAM;IAKrE;;;;;;;;;OASG;IACH,MAAM,CAAC,eAAe,CAClB,CAAC,EAAE,MAAM,EACT,CAAC,EAAE,MAAM,EACT,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,GACf,MAAM;IAgBT;;;;;;;;;;OAUG;IACH,MAAM,CAAC,uBAAuB,CAC1B,SAAS,EAAE,MAAM,EACjB,QAAQ,GAAE,MAAa,EACvB,SAAS,GAAE,MAAY,EACvB,UAAU,GAAE,OAAc,EAC1B,WAAW,GAAE,MAAe,GAC7B,MAAM;IAKT;;;;;;;;;OASG;IACH,MAAM,CAAC,qBAAqB,CACxB,WAAW,GAAE,MAA6B,EAC1C,QAAQ,GAAE,MAAY,EACtB,QAAQ,GAAE,MAAU,EACpB,YAAY,GAAE,OAAe,GAC9B,MAAM;IAmGT;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,0BAA0B;IA4DzC;;;;;;;OAOG;IACH,MAAM,CAAC,iBAAiB,CAAC,GAAG,EAAE,UAAU,EAAE,GAAG,EAAE,QAAQ,GAAG,IAAI;CA+EjE"}