@geenius/ai-workflow 0.4.0 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.5.0
+
+### Minor Changes
+
+- 6f2c2b2: Bring package to A+++ golden-standard compliance with full documentation, cleanup, and structural alignment.
+
 ## 0.4.0
 
 ### Minor Changes

package/README.md

@@ -57,7 +57,7 @@ export function WorkflowBuilderScreen() {
 
 - React Storybook app: [`apps/storybook-react`](./apps/storybook-react)
 - SolidJS Storybook app: [`apps/storybook-solidjs`](./apps/storybook-solidjs)
-- Both apps use the shared `@geenius/storybook` shell bridge and Vite preset, and include Tailwind/CSS variant comparison stories.
+- Both apps use the shared `@geenius/storybook` shell bridge and Vite preset, and render the Tailwind and vanilla CSS variants side by side for parity review.
 
 ## Notes
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@geenius/ai-workflow",
   "type": "module",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "sideEffects": false,
   "description": "Geenius AI Workflow — Chained AI pipelines for Convex apps (React + SolidJS)",
   "author": "Mehdi Nabhani",
@@ -92,15 +92,15 @@
   },
   "scripts": {
     "changeset": "changeset",
-    "dev": "pnpm -r --parallel --filter './packages/*' type-check",
+    "dev": "pnpm --filter ./packages/shared build && pnpm -r --parallel --filter './packages/*' type-check",
     "build": "pnpm --filter ./packages/shared build && pnpm -r --filter './packages/*' --filter '!./packages/shared' build",
     "clean": "pnpm -r --filter './packages/*' clean",
     "test": "pnpm build && pnpm run test:unit && pnpm run test:exports && pnpm run test:types",
     "test:exports": "vitest run __tests__/exports.test.ts --passWithNoTests",
     "test:types": "npm_config_cache=/tmp/.npm-cache attw --pack --ignore-rules cjs-resolves-to-esm --ignore-rules no-resolution",
-    "lint": "pnpm -r --filter './packages/*' type-check",
+    "lint": "pnpm --filter ./packages/shared build && pnpm -r --filter './packages/*' type-check",
     "lint:pub": "publint",
-    "type-check": "pnpm -r --filter './packages/*' type-check",
+    "type-check": "pnpm --filter ./packages/shared build && pnpm -r --filter './packages/*' type-check",
     "format": "prettier --write \"packages/*/src/**/*.{ts,tsx}\"",
     "test:unit": "pnpm -r --filter './packages/*' test && vitest run __tests__/parity.test.ts --passWithNoTests"
   }

package/packages/react/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { WorkflowEngineOptions, WorkflowDefinition, WorkflowRun, WorkflowError, StepResult, WorkflowStepDef, StepConnection, RunStatus, StepStatus, WorkflowTemplate, StepType } from '@geenius/ai-workflow-shared';
-export { RunStatus, StepConfig, StepResult, StepStatus, StepType, WORKFLOW_TEMPLATES, WorkflowBuilderState, WorkflowDefinition, WorkflowEngine, WorkflowRun, WorkflowStatus, WorkflowStepDef, validateWorkflow } from '@geenius/ai-workflow-shared';
+export { RunStatus, StepConfig, StepResult, StepStatus, StepType, WORKFLOW_TEMPLATES, WorkflowBuilderState, WorkflowDefinition, WorkflowEngine, WorkflowRun, WorkflowStatus, WorkflowStepDef, getTemplate, getTemplatesByCategory, validateRun, validateWorkflow } from '@geenius/ai-workflow-shared';
 import { ReactElement } from 'react';
 
 /**
@@ -12,6 +12,12 @@ import { ReactElement } from 'react';
 
 /**
  * Runtime integrations accepted by the React workflow hook.
+ *
+ * @property callLLM Optional LLM execution callback inherited from `WorkflowEngineOptions`.
+ * @property callWebhook Optional webhook execution callback inherited from `WorkflowEngineOptions`.
+ * @property onApprovalRequired Optional approval callback inherited from `WorkflowEngineOptions`.
+ * @property onStepComplete Optional per-step completion callback inherited from `WorkflowEngineOptions`.
+ * @property customHandlers Optional custom step-handler registry inherited from `WorkflowEngineOptions`.
  */
 interface UseWorkflowOptions extends WorkflowEngineOptions {
 }
@@ -82,6 +88,10 @@ declare function useWorkflowBuilder(initial?: Partial<WorkflowDefinition>): {
 
 /**
  * Runtime options for workflow run tracking.
+ *
+ * @property pollIntervalMs Reserved polling interval for future remote sync.
+ * @property onStepComplete Optional callback fired whenever a step result changes.
+ * @property onRunComplete Optional callback fired when the run reaches a terminal state.
  */
 interface UseWorkflowRunOptions {
     /** Poll interval for checking run status (ms) */
@@ -151,6 +161,12 @@ declare function useWorkflowStep(stepDef: WorkflowStepDef): UseWorkflowStepResul
  */
 /**
  * Pending approval request exposed to the UI layer.
+ *
+ * @property id Stable approval-request identifier.
+ * @property stepId Workflow step awaiting the operator decision.
+ * @property message Approval prompt shown to the operator.
+ * @property requestedAt Unix timestamp for when the approval was created.
+ * @property approvers Optional list of users or roles allowed to approve.
  */
 interface ApprovalRequest {
     id: string;
@@ -262,6 +278,11 @@ declare function StepNode({ step, isSelected, status, onClick, className, }: Ste
 
 /**
  * Props for a workflow step connector path.
+ *
+ * @property from Starting node position for the connector.
+ * @property to Ending node position for the connector.
+ * @property label Optional inline label rendered above the curve.
+ * @property isActive Whether the connector should use the emphasized active style.
  */
 interface StepConnectorProps {
     from: {
@@ -293,6 +314,11 @@ declare function StepConnector({ from, to, label, isActive }: StepConnectorProps
 
 /**
  * Props for the workflow step configuration panel.
+ *
+ * @property step Shared workflow step being edited in the panel.
+ * @property onUpdate Callback that persists partial step updates.
+ * @property onDelete Callback that removes the selected step.
+ * @property onClose Callback that closes the panel without mutating state.
  */
 interface StepConfigPanelProps {
     step: WorkflowStepDef;
@@ -338,6 +364,11 @@ declare function WorkflowRunPanel({ run, isRunning, onCancel, }: WorkflowRunPane
 
 /**
  * Props for the workflow approval dialog.
+ *
+ * @property request Pending approval request to render, or `null` when idle.
+ * @property onApprove Callback that approves the active request by id.
+ * @property onReject Callback that rejects the active request by id.
+ * @property onDismiss Optional callback used for Escape-key and dismiss flows.
  */
 interface ApprovalModalProps {
     request: ApprovalRequest | null;
@@ -363,6 +394,19 @@ declare function ApprovalModal(props: ApprovalModalProps): ReactElement;
 
 /**
  * Props for the workflow toolbar action surface.
+ *
+ * @property workflowName Human-readable workflow name shown in the title slot.
+ * @property isDirty Whether unsaved edits are currently present.
+ * @property isRunning Whether a run is currently active.
+ * @property canUndo Whether the undo action should be enabled.
+ * @property canRedo Whether the redo action should be enabled.
+ * @property onSave Callback that persists the current workflow definition.
+ * @property onRun Callback that starts a workflow run.
+ * @property onCancel Optional callback that stops an in-flight run.
+ * @property onUndo Callback that restores the previous builder snapshot.
+ * @property onRedo Callback that reapplies the next builder snapshot.
+ * @property onExport Optional callback that exports the workflow definition.
+ * @property className Optional class-name override for the toolbar container.
  */
 interface WorkflowToolbarProps {
     workflowName: string;
@@ -449,6 +493,10 @@ declare function WorkflowBuilderPage({ engineOptions, onSave, className, workflo
 
 /**
  * Props for the workflow runs history page.
+ *
+ * @property runs Workflow run records rendered on the page.
+ * @property onSelectRun Optional callback fired when a run card is selected.
+ * @property className Optional class-name override for the page container.
  */
 interface WorkflowRunsPageProps {
     runs: WorkflowRun[];