@stonecrop/stonecrop 0.10.7 → 0.10.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stonecrop/stonecrop",
-  "version": "0.10.7",
+  "version": "0.10.9",
   "license": "MIT",
   "type": "module",
   "author": {
@@ -34,7 +34,7 @@
     "pinia-shared-state": "^1.0.1",
     "pinia-xstate": "^3.0.0",
     "xstate": "^5.25.0",
-    "@stonecrop/schema": "0.10.7"
+    "@stonecrop/schema": "0.10.9"
   },
   "peerDependencies": {
     "pinia": "^3.0.4",
@@ -60,8 +60,8 @@
     "vue-router": "^5.0.2",
     "vite": "^7.3.1",
     "vitest": "^4.0.18",
-    "@stonecrop/atable": "0.10.7",
-    "@stonecrop/aform": "0.10.7",
+    "@stonecrop/aform": "0.10.9",
+    "@stonecrop/atable": "0.10.9",
     "stonecrop-rig": "0.7.0"
   },
   "description": "Schema-driven framework with XState workflows and HST state management",

package/src/doctype.ts

@@ -1,7 +1,7 @@
+import type { SchemaTypes } from '@stonecrop/aform'
+import type { WorkflowMeta } from '@stonecrop/schema'
 import { List, Map } from 'immutable'
 import { Component } from 'vue'
-
-import type { SchemaTypes } from '@stonecrop/aform'
 import type { UnknownMachineConfig } from 'xstate'
 
 import type { ImmutableDoctype } from './types'
@@ -20,8 +20,8 @@ export type DoctypeConfig = {
 	tableName?: string
 	/** Field definitions */
 	fields?: SchemaTypes[]
-	/** Workflow configuration */
-	workflow?: UnknownMachineConfig
+	/** Workflow configuration (XState format or simple WorkflowMeta) */
+	workflow?: UnknownMachineConfig | WorkflowMeta
 	/** Actions and their field triggers */
 	actions?: Record<string, string[]>
 	/** Parent doctype for inheritance */
@@ -183,7 +183,7 @@ export default class Doctype {
 
 	/**
 	 * Returns the transitions available from a given workflow state, derived from the
-	 * doctype's XState workflow configuration.
+	 * doctype's workflow configuration. Supports both XState format and WorkflowMeta format.
 	 *
 	 * @param currentState - The state name to read transitions from
 	 * @returns Array of transition descriptors with `name` and `targetState`
@@ -197,7 +197,34 @@ export default class Doctype {
 	 * @public
 	 */
 	getAvailableTransitions(currentState: string): Array<{ name: string; targetState: string }> {
-		const states = this.workflow?.states
+		const workflow = this.workflow
+		if (!workflow) return []
+
+		// Check if this is WorkflowMeta format (states is an array) or XState format (states is an object)
+		if (Array.isArray(workflow.states)) {
+			// WorkflowMeta format: validate state exists and filter actions by allowedStates
+			const states = workflow.states
+			if (!states.includes(currentState)) return []
+
+			const actions = (workflow as WorkflowMeta).actions
+			if (!actions) return []
+
+			return Object.entries(actions)
+				.filter(([, actionDef]) => {
+					const allowedStates = actionDef.allowedStates
+					// If no allowedStates specified, action is available in all valid states
+					if (!allowedStates || allowedStates.length === 0) return true
+					return allowedStates.includes(currentState)
+				})
+				.map(([name]) => ({
+					name,
+					// WorkflowMeta doesn't define target states - transitions are handled server-side
+					targetState: currentState,
+				}))
+		}
+
+		// XState format: use the on property of the state
+		const states = workflow.states
 		if (!states) return []
 		const stateConfig = states[currentState]
 		if (!stateConfig?.on) return []
@@ -207,6 +234,40 @@ export default class Doctype {
 		}))
 	}
 
+	/**
+	 * Returns metadata for a specific action, if available.
+	 * Only works with WorkflowMeta format; returns undefined for XState format.
+	 *
+	 * @param actionName - The action name to get metadata for
+	 * @returns Action metadata or undefined
+	 *
+	 * @example
+	 * ```ts
+	 * const actionMeta = doctype.getActionMeta('submit')
+	 * // { label: 'Submit', handler: 'plan:submit', allowedStates: ['draft'] }
+	 * ```
+	 *
+	 * @public
+	 */
+	getActionMeta(
+		actionName: string
+	):
+		| {
+				label: string
+				handler: string
+				requiredFields?: string[]
+				allowedStates?: string[]
+				confirm?: boolean
+				args?: Record<string, unknown>
+		  }
+		| undefined {
+		const workflow = this.workflow
+		if (!workflow || !Array.isArray(workflow.states)) return undefined
+
+		const actions = (workflow as WorkflowMeta).actions
+		return actions?.[actionName]
+	}
+
 	/**
 	 * Converts the registered doctype string to a slug (kebab-case). The following conversions are made:
 	 * - It replaces camelCase and PascalCase with kebab-case strings

package/src/stonecrop.ts

@@ -1,4 +1,4 @@
-import type { DataClient } from '@stonecrop/schema'
+import type { DataClient, WorkflowMeta } from '@stonecrop/schema'
 import { reactive } from 'vue'
 
 import Doctype from './doctype'
@@ -400,10 +400,20 @@ export class Stonecrop {
 		const record = this.getRecordById(slug, recordId)
 		const status = record?.get('status') as string | undefined
 
-		const initialState =
-			typeof meta.workflow.initial === 'string'
-				? meta.workflow.initial
-				: Object.keys(meta.workflow.states ?? {})[0] ?? ''
+		// Handle both XState format and WorkflowMeta format
+		const workflow = meta.workflow
+		let initialState: string
+
+		if (Array.isArray(workflow.states)) {
+			// WorkflowMeta format: states is a string array
+			initialState = workflow.states[0] ?? ''
+		} else {
+			// XState format: states is an object, use initial or first key
+			initialState =
+				typeof (workflow as { initial?: unknown }).initial === 'string'
+					? (workflow as { initial: string }).initial
+					: Object.keys(workflow.states ?? {})[0] ?? ''
+		}
 
 		return status || initialState
 	}

package/src/types/index.ts

@@ -1,4 +1,4 @@
-import type { DataClient } from '@stonecrop/schema'
+import type { DataClient, WorkflowMeta } from '@stonecrop/schema'
 import type { SchemaTypes } from '@stonecrop/aform'
 import { List, Map } from 'immutable'
 import type { Component } from 'vue'
@@ -16,7 +16,7 @@ import type { RouteContext } from './registry'
  */
 export type ImmutableDoctype = {
 	readonly schema?: List<SchemaTypes> // TODO: allow schema to be a function
-	readonly workflow?: UnknownMachineConfig | AnyStateNodeConfig
+	readonly workflow?: UnknownMachineConfig | AnyStateNodeConfig | WorkflowMeta
 	readonly actions?: Map<string, string[]>
 }
 
@@ -27,7 +27,7 @@ export type ImmutableDoctype = {
 export type MutableDoctype = {
 	doctype?: string
 	schema?: SchemaTypes[] // TODO: allow schema to be a function
-	workflow?: UnknownMachineConfig | AnyStateNodeConfig
+	workflow?: UnknownMachineConfig | AnyStateNodeConfig | WorkflowMeta
 	actions?: Record<string, string[]>
 }