@memberjunction/core-actions 2.107.0 → 2.108.0

package/dist/custom/visualization/create-svg-diagram.action.d.ts

@@ -0,0 +1,151 @@
+import { RunActionParams } from '@memberjunction/actions-base';
+import { BaseAction } from '@memberjunction/actions';
+import { SVGActionResult } from './shared/svg-types';
+/**
+ * Action that generates SVG diagrams including flowcharts, org charts, and ER diagrams.
+ *
+ * This action provides server-side SVG generation for structured diagrams, designed for
+ * AI agents and workflows to create publication-quality visualizations from structured data.
+ *
+ * @example
+ * ```typescript
+ * // Flowchart example
+ * await runAction({
+ *   ActionName: 'Create SVG Diagram',
+ *   Params: [
+ *     { Name: 'DiagramType', Value: 'flow' },
+ *     { Name: 'Nodes', Value: JSON.stringify([
+ *       { id: '1', kind: 'start', label: 'Start' },
+ *       { id: '2', kind: 'process', label: 'Process Data' },
+ *       { id: '3', kind: 'end', label: 'End' }
+ *     ]) },
+ *     { Name: 'Edges', Value: JSON.stringify([
+ *       { from: '1', to: '2', label: 'Begin' },
+ *       { from: '2', to: '3' }
+ *     ]) },
+ *     { Name: 'Direction', Value: 'TB' },
+ *     { Name: 'Width', Value: '800' },
+ *     { Name: 'Height', Value: '600' }
+ *   ]
+ * });
+ *
+ * // Org chart example
+ * await runAction({
+ *   ActionName: 'Create SVG Diagram',
+ *   Params: [
+ *     { Name: 'DiagramType', Value: 'org' },
+ *     { Name: 'Nodes', Value: JSON.stringify({
+ *       id: '1',
+ *       label: 'CEO',
+ *       role: 'Chief Executive Officer',
+ *       children: [
+ *         { id: '2', label: 'CTO', role: 'Technology' },
+ *         { id: '3', label: 'CFO', role: 'Finance' }
+ *       ]
+ *     }) }
+ *   ]
+ * });
+ * ```
+ */
+export declare class CreateSVGDiagramAction extends BaseAction {
+    /**
+     * Generates an SVG diagram from the provided data and configuration
+     *
+     * @param params - The action parameters containing:
+     *   - DiagramType: Type of diagram ('flow' | 'org' | 'er')
+     *   - Nodes: JSON array or object of nodes
+     *   - Edges: JSON array of edges (for flow and ER diagrams)
+     *   - Direction: Layout direction ('TB' | 'LR' | 'RL' | 'BT') for flow diagrams
+     *   - Width: Diagram width in pixels (optional, default: 800)
+     *   - Height: Diagram height in pixels (optional, default: 600)
+     *   - Title: Diagram title (optional)
+     *   - Palette: Color palette ('mjDefault' | 'gray' | 'pastel' | 'highContrast')
+     *   - Seed: Random seed for deterministic layouts (optional)
+     *
+     * @returns A promise resolving to an SVGActionResult with:
+     *   - Success: true if diagram was generated successfully
+     *   - ResultCode: "SUCCESS" or error code
+     *   - Message: The SVG string or error message
+     *   - svg: The SVG XML string
+     *   - width: Diagram width in pixels
+     *   - height: Diagram height in pixels
+     */
+    protected InternalRunAction(params: RunActionParams): Promise<SVGActionResult>;
+    /**
+     * Renders a flowchart using dagre layout
+     */
+    private renderFlowDiagram;
+    /**
+     * Gets dimensions for flow node based on kind
+     */
+    private getNodeDimensions;
+    /**
+     * Renders a single flow node
+     */
+    private renderFlowNode;
+    /**
+     * Gets color index for node kind
+     */
+    private getNodeColorIndex;
+    /**
+     * Renders an ellipse shape
+     */
+    private renderEllipse;
+    /**
+     * Renders a diamond shape
+     */
+    private renderDiamond;
+    /**
+     * Renders a rounded rectangle
+     */
+    private renderRoundedRect;
+    /**
+     * Renders a flow edge
+     */
+    private renderFlowEdge;
+    /**
+     * Renders an org chart using d3-hierarchy
+     */
+    private renderOrgChart;
+    /**
+     * Renders an org chart link
+     */
+    private renderOrgLink;
+    /**
+     * Renders an org chart node
+     */
+    private renderOrgNode;
+    /**
+     * Renders an ER diagram using dagre layout
+     */
+    private renderERDiagram;
+    /**
+     * Renders an ER table
+     */
+    private renderERTable;
+    /**
+     * Renders an ER relation
+     */
+    private renderERRelation;
+    /**
+     * Adds a title to the SVG
+     */
+    private addTitle;
+    /**
+     * Helper to safely parse JSON that might already be an object
+     */
+    private parseJSON;
+    /**
+     * Helper to ensure a parameter value is a string, with type conversion and validation
+     */
+    private ensureString;
+    /**
+     * Helper to get parameter value by name (case-insensitive)
+     */
+    private getParamValue;
+}
+/**
+ * Loader function to ensure the CreateSVGDiagramAction class is included in the bundle.
+ */
+export declare function LoadCreateSVGDiagramAction(): void;
+//# sourceMappingURL=create-svg-diagram.action.d.ts.map

package/dist/custom/visualization/create-svg-diagram.action.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-svg-diagram.action.d.ts","sourceRoot":"","sources":["../../../src/custom/visualization/create-svg-diagram.action.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,eAAe,EAAE,MAAM,8BAA8B,CAAC;AACnF,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAKrD,OAAO,EAOH,eAAe,EAIlB,MAAM,oBAAoB,CAAC;AAI5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,qBACa,sBAAuB,SAAQ,UAAU;IAClD;;;;;;;;;;;;;;;;;;;;;OAqBG;cACa,iBAAiB,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;IAsEpF;;OAEG;YACW,iBAAiB;IA0F/B;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAmBzB;;OAEG;IACH,OAAO,CAAC,cAAc;IAgDtB;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAazB;;OAEG;IACH,OAAO,CAAC,aAAa;IAarB;;OAEG;IACH,OAAO,CAAC,aAAa;IAarB;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAUzB;;OAEG;IACH,OAAO,CAAC,cAAc;IAuCtB;;OAEG;YACW,cAAc;IA+D5B;;OAEG;IACH,OAAO,CAAC,aAAa;IAwBrB;;OAEG;IACH,OAAO,CAAC,aAAa;IAuErB;;OAEG;YACW,eAAe;IA2F7B;;OAEG;IACH,OAAO,CAAC,aAAa;IAgFrB;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAmCxB;;OAEG;IACH,OAAO,CAAC,QAAQ;IAahB;;OAEG;IACH,OAAO,CAAC,SAAS;IAuBjB;;OAEG;IACH,OAAO,CAAC,YAAY;IAqBpB;;OAEG;IACH,OAAO,CAAC,aAAa;CAQxB;AAED;;GAEG;AACH,wBAAgB,0BAA0B,SAEzC"}