@stonecrop/stonecrop 0.10.1 → 0.10.3

package/README.md

@@ -16,120 +16,108 @@ _This package is under active development / design._
 ```typescript
 import { createApp } from 'vue'
 import Stonecrop from '@stonecrop/stonecrop'
+import router from './router'
 
 const app = createApp(App)
 
 // Install the Stonecrop plugin
 app.use(Stonecrop, {
   router,
-  components: {
-    // Register custom components
+
+  // Lazy-load doctype metadata from your API given the current route context.
+  // routeContext = { path, segments } — adapt segments to your doctype naming.
+  getMeta: async ({ segments }) => {
+    return await fetchDoctypeMeta(segments[0])
+  },
+
+  // Optional: replace the default REST fetch() stub with your own transport.
+  // When provided, Stonecrop.getRecord() calls this instead of fetch(`/${slug}/${id}`).
+  fetchRecord: async (doctype, id) => {
+    return await myApiClient.getRecord(doctype, id)
+  },
+
+  // Optional: replace the default REST fetch() stub for lists.
+  fetchRecords: async (doctype) => {
+    return await myApiClient.getRecords(doctype)
   },
-  getMeta: async (doctype: string) => {
-    // Fetch doctype metadata from your API
-    return await fetchDoctypeMeta(doctype)
-  }
 })
 
 app.mount('#app')
 ```
 
+### Plugin Options
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `router` | `Router` | Vue Router instance. Required for route-based doctype resolution. |
+| `getMeta` | `(ctx: RouteContext) => DoctypeMeta \| Promise<DoctypeMeta>` | Lazy-loads doctype metadata for the current route. `ctx` has `path` and `segments`. |
+| `fetchRecord` | `(doctype, id) => Promise<Record \| null>` | Injectable replacement for `Stonecrop.getRecord()`'s default REST fetch. Use this to plug in GraphQL or any other transport. |
+| `fetchRecords` | `(doctype) => Promise<Record[]>` | Injectable replacement for `Stonecrop.getRecords()`'s default REST fetch. |
+| `components` | `Record<string, Component>` | Additional Vue components to register globally. |
+| `autoInitializeRouter` | `boolean` | Call `onRouterInitialized` automatically after mount. Default: `false`. |
+| `onRouterInitialized` | `(registry, stonecrop) => void` | Callback invoked after plugin install + mount. Receives the Registry and Stonecrop instances. |
+
 ### Available Imports
 
 ```typescript
-// Default export - Vue plugin
-import Stonecrop from '@stonecrop/stonecrop'
+// Default export - Vue plugin (install with app.use)
+import StonecropPlugin from '@stonecrop/stonecrop'
 
 // Named exports - utilities and classes
 import {
-  Stonecrop as StonecropClass, // Core class
-  Registry,                    // Doctype registry
-  useStonecrop,                // Vue composable
-  HST,                         // Hierarchical State Tree
-  createHST,                   // HST factory
-  DoctypeMeta                  // Doctype metadata class
+  Stonecrop,       // Core orchestration class
+  Registry,        // Doctype registry (singleton)
+  DoctypeMeta,     // Doctype definition class
+  useStonecrop,    // Vue composable — primary integration point
+  HST,             // HST store class
+  createHST,       // HST factory function
 } from '@stonecrop/stonecrop'
-```### Using the Composable
+```
+
+### Using the Composable
 
 ```typescript
 import { useStonecrop } from '@stonecrop/stonecrop'
 
 export default {
   setup() {
-    const { stonecrop } = useStonecrop()
+    // Base mode — operation log only, no HST record loading
+    const { stonecrop, operationLog } = useStonecrop()
+
+    // HST mode — pass doctype and optional recordId for full integration
+    const { stonecrop, formData, provideHSTPath, handleHSTChange } = useStonecrop({
+      doctype: myDoctype,
+      recordId: 'record-123', // omit or pass undefined for new records
+    })
 
     // Access HST store
     const store = stonecrop.value?.getStore()
 
-    // Work with records
-    const records = stonecrop.value?.records('doctype')
+    // Work with records directly
     const record = stonecrop.value?.getRecordById('doctype', recordId)
 
-    return { stonecrop, records, record }
+    return { stonecrop, formData }
   }
 }
 ```
 
 ## Design
-A context will define schema, workflow and actions.
-  - Schema describes the data model and layout of the document.
-  - Workflows are the events that are registered on it and will specific to the context. An application might have 'login', 'onAppLoad', 'beforeRouteChange' and 'logout' events.  A form/document context might define CRUD events. A table component, nested inside the form component might define its own events. I think we want Events to be FSM
-  - Actions are an ordered set of functions, called by Workflow
-  - [Router integration](https://pinia.vuejs.org/core-concepts/plugins.html#adding-new-external-properties). Stonecrop setup should expect a router or provide a default implementation
+A Doctype defines schema, workflow, and actions.
+  - **Schema** describes the data model and field layout — used by AForm for rendering.
+  - **Workflow** is an XState machine config expressing the states and transitions a record can go through.
+  - **Actions** are an ordered map of named functions, triggered by field changes (lowercase keys) or FSM transitions (UPPERCASE keys).
+  - **Registry** is the singleton catalog — all doctypes live here. Optional Vue Router integration allows automatic route creation per doctype.
+  - **Stem/`useStonecrop()`** is the Vue composable that wires components to HST and provides `formData`, `provideHSTPath`, `handleHSTChange`, and the operation log API.
 
-The context will be tree-shaped with a single root. Adding more nodes at the root level isn't a problem, but multiple roots would be disallowed.
+The data model is **two operations**: get data and run actions. There is no CRUD. Records change state through FSM transitions; those transitions have side effects (persistence, notifications, etc.) defined in action handlers registered by the application. The framework provides the pipeline; applications define what actions exist and what they do.
 
-Example APIs and paths
+HST path structure:
 
 ```
-app.schema <Record> // immutable
-app.workflow <FSM> // immutable
-app.actions <OrderedSet> // immutable
-app.value <Store> // mutable
-app.user // "tyler@agritheory.com"
-app.name // "My First Application"
-app.doctype.schema <Record> // `app.doctype` lazy loaded by Event in router?
-app.doctype.workflow <FSM>
-app.doctype.actions <OrderedSet>
-app.doctype.actions.value <Store>
-app.doctype.schema.field.workflow <FSM>
-app.doctype.schema.field.actions <OrderedSet>
-app.doctype.schema.field.value <Store>
-app.doctype.schema.field.value.field.value <Store> // a "sub-form"
-app.doctype.schema.field.value.field['a:1'].value <Store> // also a "sub-form", representing a table
+doctype.recordId.fieldname        // e.g. plan.abc-123.title
+doctype.recordId.nested.field     // deep nesting supported
 ```
 
-## Base Classes
-The Doctype aligns with a row, record or object in a database. It is required to specify its schema, a Finite State Machine that informs its workflow and a set of functions that are triggered by that FSM's state transitions.
-
-Registry is a map of all Doctypes, lazy loaded and is responsible for routing within the application
-
-Stem is a composable singleton that wraps Registry and provides application level state management
-
-
-## Story / Network diagram
-#### **Doctype | Record Story**
-
-- User is redirected after successful login
-- Base URL is configured at app level to serve a navigation page
-- User navigates to list view of `doctype`
-- Table component loads existing records of `doctype` from schema; record-level schema is added to registry with web worker
-- User navigates to specific record of `doctype`: schema is loaded from registry, data is loaded from server
-- User mutates data, changes are persisted to server / DB per FSM
-
-#### **App Level**
-- User is redirected after successful login
-- Base URL is configured at app level to serve a navigation page
-- User opens command palette from lower-right-docked tab interface
-- User can search for `doctype` by name or other server-enabled capabilities
-
-#### **Low Code**
-- User can define `doctype` and schema from UI
-- Fields are shown as rows in a table
-- FSM is shown as an editable diagram that validates itself
-
-___
-
 # Hierarchical State Tree (HST) Interface Requirements
 
 ## Core Requirements

package/dist/composables/operation-log.js

@@ -1,6 +1,6 @@
 import { useMagicKeys, whenever } from '@vueuse/core';
 import { storeToRefs } from 'pinia';
-import { inject } from 'vue';
+import { getCurrentInstance, inject } from 'vue';
 import { useOperationLogStore } from '../stores/operation-log';
 /**
  * Composable for operation log management
@@ -28,9 +28,12 @@ import { useOperationLogStore } from '../stores/operation-log';
  * @public
  */
 export function useOperationLog(config) {
-    // Try to use the injected store from the Stonecrop plugin first
-    // This ensures we use the same Pinia instance as the app
-    const injectedStore = inject('$operationLogStore', undefined);
+    // inject() is only valid inside a component setup() context. When this
+    // composable is called outside one (e.g. directly in test bodies or plain
+    // scripts) skip the injection entirely and fall back to the Pinia store.
+    const injectedStore = getCurrentInstance()
+        ? inject('$operationLogStore', undefined)
+        : undefined;
     const store = injectedStore || useOperationLogStore();
     // Apply configuration if provided
     if (config) {

package/dist/{composable.js → composables/stonecrop.js}

@@ -1,6 +1,5 @@
-// src/composable.ts
 import { inject, onMounted, ref, watch, provide, computed } from 'vue';
-import { Stonecrop } from './stonecrop';
+import { Stonecrop } from '../stonecrop';
 import { storeToRefs } from 'pinia';
 /**
  * @public
@@ -284,9 +283,9 @@ export function useStonecrop(options) {
      * Recursively save a record with all nested doctype fields
      * @param doctype - The doctype metadata
      * @param recordId - The record ID to save
-     * @returns Promise resolving to the complete save payload
+     * @returns The complete save payload
      */
-    const saveRecursive = async (doctype, recordId) => {
+    const saveRecursive = (doctype, recordId) => {
         if (!hstStore.value || !stonecrop.value) {
             throw new Error('HST store not initialized');
         }

package/dist/doctype.js

@@ -9,6 +9,14 @@ export default class DoctypeMeta {
      * @readonly
      */
     doctype;
+    /**
+     * Alias for doctype (for DoctypeLike interface compatibility)
+     * @public
+     * @readonly
+     */
+    get name() {
+        return this.doctype;
+    }
     /**
      * The doctype schema
      * @public
@@ -48,6 +56,33 @@ export default class DoctypeMeta {
         this.actions = actions;
         this.component = component;
     }
+    /**
+     * Returns the transitions available from a given workflow state, derived from the
+     * doctype's XState workflow configuration.
+     *
+     * @param currentState - The state name to read transitions from
+     * @returns Array of transition descriptors with `name` and `targetState`
+     *
+     * @example
+     * ```ts
+     * const transitions = doctype.getAvailableTransitions('draft')
+     * // [{ name: 'SUBMIT', targetState: 'submitted' }]
+     * ```
+     *
+     * @public
+     */
+    getAvailableTransitions(currentState) {
+        const states = this.workflow?.states;
+        if (!states)
+            return [];
+        const stateConfig = states[currentState];
+        if (!stateConfig?.on)
+            return [];
+        return Object.entries(stateConfig.on).map(([name, target]) => ({
+            name,
+            targetState: typeof target === 'string' ? target : 'unknown',
+        }));
+    }
     /**
      * 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/dist/index.js

@@ -1,4 +1,4 @@
-import { useStonecrop } from './composable';
+import { useStonecrop } from './composables/stonecrop';
 import { useOperationLog, useUndoRedoShortcuts, withBatch } from './composables/operation-log';
 import DoctypeMeta from './doctype';
 import { getGlobalTriggerEngine, markOperationIrreversible, registerGlobalAction, registerTransitionAction, setFieldRollback, triggerTransition, } from './field-triggers';

package/dist/plugins/index.js

@@ -24,14 +24,19 @@ async function setupAutoInitialization(registry, stonecrop, onRouterInitialized)
  * ```ts
  * import { createApp } from 'vue'
  * import Stonecrop from '@stonecrop/stonecrop'
+ * import { StonecropClient } from '@stonecrop/graphql-client'
  * import router from './router'
  *
+ * const client = new StonecropClient({ endpoint: '/graphql' })
+ *
  * const app = createApp(App)
  * app.use(Stonecrop, {
  *   router,
+ *   client,
  *   getMeta: async (routeContext) => {
  *     // routeContext contains: { path, segments }
- *     // fetch doctype meta from your API using the route context
+ *     // use the client to fetch doctype meta
+ *     return client.getMeta({ doctype: routeContext.segments[0] })
  *   },
  *   autoInitializeRouter: true,
  *   onRouterInitialized: async (registry, stonecrop) => {
@@ -56,7 +61,7 @@ const plugin = {
         app.provide('$registry', registry);
         app.config.globalProperties.$registry = registry;
         // Create and provide a global Stonecrop instance
-        const stonecrop = new Stonecrop(registry);
+        const stonecrop = new Stonecrop(registry, undefined, options?.client ? { client: options.client } : undefined);
         app.provide('$stonecrop', stonecrop);
         app.config.globalProperties.$stonecrop = stonecrop;
         // Initialize operation log store if Pinia is available
@@ -73,6 +78,7 @@ const plugin = {
         }
         catch (error) {
             // Pinia not available - operation log won't work, but app should still function
+            // eslint-disable-next-line no-console
             console.warn('Pinia not available - operation log features will be disabled:', error);
         }
         // Register custom components

package/dist/registry.js

@@ -235,4 +235,13 @@ export default class Registry {
         });
         return record;
     }
+    /**
+     * Get a registered doctype by slug
+     * @param slug - The doctype slug to look up
+     * @returns The DoctypeMeta instance if found, or undefined
+     * @public
+     */
+    getDoctype(slug) {
+        return this.registry[slug];
+    }
 }

package/dist/src/composables/operation-log.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"operation-log.d.ts","sourceRoot":"","sources":["../../../src/composables/operation-log.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AAE5C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAA;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,eAAe,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;qBAiB3C,OAAO,KAAG,OAAO;qBAOjB,OAAO,KAAG,OAAO;;gCAcN,MAAM,KAAG,MAAM,GAAG,IAAI;;;gCAqBtB,MAAM,aAAa,MAAM;;oCAgBrB,MAAM,UAAU,MAAM;yBAcnD,MAAM,cACH,MAAM,cACN,MAAM,EAAE,WACZ,SAAS,GAAG,SAAS,GAAG,SAAS,UACjC,MAAM,KACZ,MAAM;yBAQmB,OAAO,CAAC,kBAAkB,CAAC;EA2BvD;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,UAAO,QAqCrE;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAsB,SAAS,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAYzG"}
+{"version":3,"file":"operation-log.d.ts","sourceRoot":"","sources":["../../../src/composables/operation-log.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AAE5C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAA;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,eAAe,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;qBAoB3C,OAAO,KAAG,OAAO;qBAOjB,OAAO,KAAG,OAAO;;gCAcN,MAAM,KAAG,MAAM,GAAG,IAAI;;;gCAqBtB,MAAM,aAAa,MAAM;;oCAgBrB,MAAM,UAAU,MAAM;yBAcnD,MAAM,cACH,MAAM,cACN,MAAM,EAAE,WACZ,SAAS,GAAG,SAAS,GAAG,SAAS,UACjC,MAAM,KACZ,MAAM;yBAQmB,OAAO,CAAC,kBAAkB,CAAC;EA2BvD;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,UAAO,QAqCrE;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAsB,SAAS,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAYzG"}

package/dist/src/{composable.d.ts → composables/stonecrop.d.ts}

@@ -1,9 +1,9 @@
 import { Ref, ComputedRef } from 'vue';
-import Registry from './registry';
-import { Stonecrop } from './stonecrop';
-import DoctypeMeta from './doctype';
-import type { HSTNode } from './stores/hst';
-import type { HSTOperation, OperationLogConfig, OperationLogSnapshot } from './types/operation-log';
+import Registry from '../registry';
+import { Stonecrop } from '../stonecrop';
+import DoctypeMeta from '../doctype';
+import type { HSTNode } from '../stores/hst';
+import type { HSTOperation, OperationLogConfig, OperationLogSnapshot } from '../types/operation-log';
 import { SchemaTypes } from '@stonecrop/aform';
 /**
  * Operation Log API - nested object containing all operation log functionality
@@ -90,4 +90,4 @@ export declare function useStonecrop(options: {
     doctype: DoctypeMeta;
     recordId?: string;
 }): HSTStonecropReturn;
-//# sourceMappingURL=composable.d.ts.map
+//# sourceMappingURL=stonecrop.d.ts.map

package/dist/src/composables/stonecrop.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stonecrop.d.ts","sourceRoot":"","sources":["../../../src/composables/stonecrop.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,GAAG,EAAiC,WAAW,EAAE,MAAM,KAAK,CAAA;AAExF,OAAO,QAAQ,MAAM,aAAa,CAAA;AAClC,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AACxC,OAAO,WAAW,MAAM,YAAY,CAAA;AACpC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AAG5C,OAAO,KAAK,EAAE,YAAY,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AACpG,OAAO,EAAE,WAAW,EAAiB,MAAM,kBAAkB,CAAA;AAE7D;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAC7B,UAAU,EAAE,GAAG,CAAC,YAAY,EAAE,CAAC,CAAA;IAC/B,YAAY,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IACzB,aAAa,EAAE,WAAW,CAAC;QAC1B,OAAO,EAAE,OAAO,CAAA;QAChB,OAAO,EAAE,OAAO,CAAA;QAChB,SAAS,EAAE,MAAM,CAAA;QACjB,SAAS,EAAE,MAAM,CAAA;QACjB,YAAY,EAAE,MAAM,CAAA;KACpB,CAAC,CAAA;IACF,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC,CAAA;IAC7B,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC,CAAA;IAC7B,SAAS,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAC9B,SAAS,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAC9B,IAAI,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,OAAO,CAAA;IACpC,IAAI,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,OAAO,CAAA;IACpC,UAAU,EAAE,MAAM,IAAI,CAAA;IACtB,WAAW,EAAE,CAAC,WAAW,CAAC,EAAE,MAAM,KAAK,MAAM,GAAG,IAAI,CAAA;IACpD,WAAW,EAAE,MAAM,IAAI,CAAA;IACvB,KAAK,EAAE,MAAM,IAAI,CAAA;IACjB,gBAAgB,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,EAAE,CAAA;IACxE,WAAW,EAAE,MAAM,oBAAoB,CAAA;IACvC,gBAAgB,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,CAAA;IAC/D,SAAS,EAAE,CACV,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,SAAS,CAAC,EAAE,MAAM,EAAE,EACpB,MAAM,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,EAC1C,KAAK,CAAC,EAAE,MAAM,KACV,MAAM,CAAA;IACX,SAAS,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,kBAAkB,CAAC,KAAK,IAAI,CAAA;CACzD,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG;IACjC,SAAS,EAAE,GAAG,CAAC,SAAS,GAAG,SAAS,CAAC,CAAA;IACrC,YAAY,EAAE,eAAe,CAAA;CAC7B,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,mBAAmB,GAAG;IACtD,cAAc,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,MAAM,CAAA;IAChE,eAAe,EAAE,CAAC,UAAU,EAAE,aAAa,KAAK,IAAI,CAAA;IACpD,QAAQ,EAAE,GAAG,CAAC,OAAO,GAAG,SAAS,CAAC,CAAA;IAClC,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAA;IAClC,cAAc,EAAE,GAAG,CAAC,WAAW,EAAE,CAAC,CAAA;IAClC,cAAc,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,WAAW,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IACzG,aAAa,EAAE,CAAC,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAA;IACvF,mBAAmB,EAAE,CACpB,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,WAAW,KACrB;QACJ,cAAc,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,MAAM,CAAA;QAC7C,eAAe,EAAE,CAAC,UAAU,EAAE,aAAa,KAAK,IAAI,CAAA;KACpD,CAAA;CACD,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,GAAG,CAAA;IACV,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,IAAI,mBAAmB,GAAG,kBAAkB,CAAA;AACxE;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE;IACrC,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,OAAO,EAAE,WAAW,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAA;CACjB,GAAG,kBAAkB,CAAA"}

package/dist/src/doctype.d.ts

@@ -11,6 +11,12 @@ export default class DoctypeMeta {
      * @readonly
      */
     readonly doctype: string;
+    /**
+     * Alias for doctype (for DoctypeLike interface compatibility)
+     * @public
+     * @readonly
+     */
+    get name(): string;
     /**
      * The doctype schema
      * @public
@@ -44,6 +50,25 @@ export default class DoctypeMeta {
      * @param component - Optional Vue component for rendering the doctype
      */
     constructor(doctype: string, schema: ImmutableDoctype['schema'], workflow: ImmutableDoctype['workflow'], actions: ImmutableDoctype['actions'], component?: Component);
+    /**
+     * Returns the transitions available from a given workflow state, derived from the
+     * doctype's XState workflow configuration.
+     *
+     * @param currentState - The state name to read transitions from
+     * @returns Array of transition descriptors with `name` and `targetState`
+     *
+     * @example
+     * ```ts
+     * const transitions = doctype.getAvailableTransitions('draft')
+     * // [{ name: 'SUBMIT', targetState: 'submitted' }]
+     * ```
+     *
+     * @public
+     */
+    getAvailableTransitions(currentState: string): Array<{
+        name: string;
+        targetState: string;
+    }>;
     /**
      * 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/dist/src/doctype.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"doctype.d.ts","sourceRoot":"","sources":["../../src/doctype.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,KAAK,CAAA;AAE/B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAE/C;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,WAAW;IAC/B;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IAExB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC,QAAQ,CAAC,CAAA;IAE3C;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC,UAAU,CAAC,CAAA;IAE/C;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAA;IAE7C;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAA;IAE9B;;;;;;;OAOG;gBAEF,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,gBAAgB,CAAC,QAAQ,CAAC,EAClC,QAAQ,EAAE,gBAAgB,CAAC,UAAU,CAAC,EACtC,OAAO,EAAE,gBAAgB,CAAC,SAAS,CAAC,EACpC,SAAS,CAAC,EAAE,SAAS;IAStB;;;;;;;;;;;;;;;OAeG;IACH,IAAI,IAAI,WAKP;CACD"}
+{"version":3,"file":"doctype.d.ts","sourceRoot":"","sources":["../../src/doctype.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,KAAK,CAAA;AAE/B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAE/C;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,WAAW;IAC/B;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IAExB;;;;OAIG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC,QAAQ,CAAC,CAAA;IAE3C;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC,UAAU,CAAC,CAAA;IAE/C;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAA;IAE7C;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAA;IAE9B;;;;;;;OAOG;gBAEF,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,gBAAgB,CAAC,QAAQ,CAAC,EAClC,QAAQ,EAAE,gBAAgB,CAAC,UAAU,CAAC,EACtC,OAAO,EAAE,gBAAgB,CAAC,SAAS,CAAC,EACpC,SAAS,CAAC,EAAE,SAAS;IAStB;;;;;;;;;;;;;;OAcG;IACH,uBAAuB,CAAC,YAAY,EAAE,MAAM,GAAG,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC;IAW3F;;;;;;;;;;;;;;;OAeG;IACH,IAAI,IAAI,WAKP;CACD"}

package/dist/src/index.d.ts

@@ -1,21 +1,21 @@
 export type * from '@stonecrop/aform/types';
 export type * from '@stonecrop/atable/types';
-import { useStonecrop } from './composable';
+import { useStonecrop } from './composables/stonecrop';
 import { useOperationLog, useUndoRedoShortcuts, withBatch } from './composables/operation-log';
 import DoctypeMeta from './doctype';
 import { getGlobalTriggerEngine, markOperationIrreversible, registerGlobalAction, registerTransitionAction, setFieldRollback, triggerTransition } from './field-triggers';
 import plugin from './plugins';
 import Registry from './registry';
-import { Stonecrop } from './stonecrop';
+import { type StonecropOptions, Stonecrop } from './stonecrop';
 import { HST, createHST, type HSTNode } from './stores/hst';
 import { useOperationLogStore } from './stores/operation-log';
 import { SchemaValidator, createValidator, validateSchema } from './schema-validator';
 export type * from './types';
-export type { BaseStonecropReturn, HSTChangeData, HSTStonecropReturn, OperationLogAPI } from './composable';
+export type { BaseStonecropReturn, HSTChangeData, HSTStonecropReturn, OperationLogAPI } from './composables/stonecrop';
 export type { FieldTriggerEngine } from './field-triggers';
 export type { FieldChangeContext, TransitionChangeContext, FieldTriggerExecutionResult, ActionExecutionResult, TransitionExecutionResult, FieldActionFunction, TransitionActionFunction, } from './types/field-triggers';
 export type { ValidationIssue, ValidationResult, ValidatorOptions } from './schema-validator';
 export { ValidationSeverity } from './schema-validator';
-export { DoctypeMeta, Registry, Stonecrop, useStonecrop, HST, createHST, HSTNode, getGlobalTriggerEngine, registerGlobalAction, registerTransitionAction, setFieldRollback, triggerTransition, markOperationIrreversible, SchemaValidator, createValidator, validateSchema, useOperationLog, useOperationLogStore, useUndoRedoShortcuts, withBatch, };
+export { DoctypeMeta, Registry, Stonecrop, StonecropOptions, useStonecrop, HST, createHST, HSTNode, getGlobalTriggerEngine, registerGlobalAction, registerTransitionAction, setFieldRollback, triggerTransition, markOperationIrreversible, SchemaValidator, createValidator, validateSchema, useOperationLog, useOperationLogStore, useUndoRedoShortcuts, withBatch, };
 export default plugin;
 //# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,mBAAmB,wBAAwB,CAAA;AAC3C,mBAAmB,yBAAyB,CAAA;AAE5C,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAC3C,OAAO,EAAE,eAAe,EAAE,oBAAoB,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAA;AAC9F,OAAO,WAAW,MAAM,WAAW,CAAA;AACnC,OAAO,EACN,sBAAsB,EACtB,yBAAyB,EACzB,oBAAoB,EACpB,wBAAwB,EACxB,gBAAgB,EAChB,iBAAiB,EACjB,MAAM,kBAAkB,CAAA;AACzB,OAAO,MAAM,MAAM,WAAW,CAAA;AAC9B,OAAO,QAAQ,MAAM,YAAY,CAAA;AACjC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,KAAK,OAAO,EAAE,MAAM,cAAc,CAAA;AAC3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAE7D,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AACrF,mBAAmB,SAAS,CAAA;AAC5B,YAAY,EAAE,mBAAmB,EAAE,aAAa,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AAC3G,YAAY,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAA;AAC1D,YAAY,EACX,kBAAkB,EAClB,uBAAuB,EACvB,2BAA2B,EAC3B,qBAAqB,EACrB,yBAAyB,EACzB,mBAAmB,EACnB,wBAAwB,GACxB,MAAM,wBAAwB,CAAA;AAE/B,YAAY,EAAE,eAAe,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAC7F,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAA;AAEvD,OAAO,EACN,WAAW,EACX,QAAQ,EACR,SAAS,EACT,YAAY,EAEZ,GAAG,EACH,SAAS,EACT,OAAO,EAEP,sBAAsB,EACtB,oBAAoB,EACpB,wBAAwB,EACxB,gBAAgB,EAChB,iBAAiB,EACjB,yBAAyB,EAEzB,eAAe,EACf,eAAe,EACf,cAAc,EAEd,eAAe,EACf,oBAAoB,EACpB,oBAAoB,EACpB,SAAS,GACT,CAAA;AAGD,eAAe,MAAM,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,mBAAmB,wBAAwB,CAAA;AAC3C,mBAAmB,yBAAyB,CAAA;AAE5C,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAA;AACtD,OAAO,EAAE,eAAe,EAAE,oBAAoB,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAA;AAC9F,OAAO,WAAW,MAAM,WAAW,CAAA;AACnC,OAAO,EACN,sBAAsB,EACtB,yBAAyB,EACzB,oBAAoB,EACpB,wBAAwB,EACxB,gBAAgB,EAChB,iBAAiB,EACjB,MAAM,kBAAkB,CAAA;AACzB,OAAO,MAAM,MAAM,WAAW,CAAA;AAC9B,OAAO,QAAQ,MAAM,YAAY,CAAA;AACjC,OAAO,EAAE,KAAK,gBAAgB,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAC9D,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,KAAK,OAAO,EAAE,MAAM,cAAc,CAAA;AAC3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAE7D,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AACrF,mBAAmB,SAAS,CAAA;AAC5B,YAAY,EAAE,mBAAmB,EAAE,aAAa,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AACtH,YAAY,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAA;AAC1D,YAAY,EACX,kBAAkB,EAClB,uBAAuB,EACvB,2BAA2B,EAC3B,qBAAqB,EACrB,yBAAyB,EACzB,mBAAmB,EACnB,wBAAwB,GACxB,MAAM,wBAAwB,CAAA;AAE/B,YAAY,EAAE,eAAe,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAC7F,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAA;AAEvD,OAAO,EACN,WAAW,EACX,QAAQ,EACR,SAAS,EACT,gBAAgB,EAChB,YAAY,EAEZ,GAAG,EACH,SAAS,EACT,OAAO,EAEP,sBAAsB,EACtB,oBAAoB,EACpB,wBAAwB,EACxB,gBAAgB,EAChB,iBAAiB,EACjB,yBAAyB,EAEzB,eAAe,EACf,eAAe,EACf,cAAc,EAEd,eAAe,EACf,oBAAoB,EACpB,oBAAoB,EACpB,SAAS,GACT,CAAA;AAGD,eAAe,MAAM,CAAA"}

package/dist/src/plugins/index.d.ts

@@ -7,14 +7,19 @@ import { type Plugin } from 'vue';
  * ```ts
  * import { createApp } from 'vue'
  * import Stonecrop from '@stonecrop/stonecrop'
+ * import { StonecropClient } from '@stonecrop/graphql-client'
  * import router from './router'
  *
+ * const client = new StonecropClient({ endpoint: '/graphql' })
+ *
  * const app = createApp(App)
  * app.use(Stonecrop, {
  *   router,
+ *   client,
  *   getMeta: async (routeContext) => {
  *     // routeContext contains: { path, segments }
- *     // fetch doctype meta from your API using the route context
+ *     // use the client to fetch doctype meta
+ *     return client.getMeta({ doctype: routeContext.segments[0] })
  *   },
  *   autoInitializeRouter: true,
  *   onRouterInitialized: async (registry, stonecrop) => {

package/dist/src/plugins/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/plugins/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAO,KAAK,MAAM,EAAY,MAAM,KAAK,CAAA;AA2BhD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,QAAA,MAAM,MAAM,EAAE,MAiDb,CAAA;AAED,eAAe,MAAM,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/plugins/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAO,KAAK,MAAM,EAAY,MAAM,KAAK,CAAA;AA2BhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,QAAA,MAAM,MAAM,EAAE,MAkDb,CAAA;AAED,eAAe,MAAM,CAAA"}

package/dist/src/registry.d.ts

@@ -103,5 +103,12 @@ export default class Registry {
      * @public
      */
     initializeRecord(schema: SchemaTypes[]): Record<string, any>;
+    /**
+     * Get a registered doctype by slug
+     * @param slug - The doctype slug to look up
+     * @returns The DoctypeMeta instance if found, or undefined
+     * @public
+     */
+    getDoctype(slug: string): DoctypeMeta | undefined;
 }
 //# sourceMappingURL=registry.d.ts.map

package/dist/src/registry.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../src/registry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAEnC,OAAO,WAAW,MAAM,WAAW,CAAA;AAEnC,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAA;AAE/C;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC5B;;OAEG;IACH,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAA;IAEtB;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IAErB;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;IAE9C;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IAExB;;;;OAIG;gBACS,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,YAAY,EAAE,YAAY,KAAK,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;IAWzG;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,YAAY,EAAE,YAAY,KAAK,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;IAE5E;;;;;OAKG;IACH,UAAU,CAAC,OAAO,EAAE,WAAW;IAsB/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,aAAa,CAAC,MAAM,EAAE,WAAW,EAAE,EAAE,OAAO,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,WAAW,EAAE;IAwF1E;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,gBAAgB,CAAC,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAwD5D"}
+{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../src/registry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAEnC,OAAO,WAAW,MAAM,WAAW,CAAA;AAEnC,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAA;AAE/C;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC5B;;OAEG;IACH,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAA;IAEtB;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IAErB;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;IAE9C;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IAExB;;;;OAIG;gBACS,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,YAAY,EAAE,YAAY,KAAK,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;IAWzG;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,YAAY,EAAE,YAAY,KAAK,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;IAE5E;;;;;OAKG;IACH,UAAU,CAAC,OAAO,EAAE,WAAW;IAsB/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,aAAa,CAAC,MAAM,EAAE,WAAW,EAAE,EAAE,OAAO,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,WAAW,EAAE;IAwF1E;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,gBAAgB,CAAC,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IA4C5D;;;;;OAKG;IACH,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS;CAgBjD"}

package/dist/src/stonecrop.d.ts

@@ -1,8 +1,24 @@
+import type { DataClient } from '@stonecrop/schema';
 import DoctypeMeta from './doctype';
 import Registry from './registry';
 import { type HSTNode } from './stores/hst';
 import type { OperationLogConfig } from './types/operation-log';
 import type { RouteContext } from './types/registry';
+/**
+ * Options for constructing a Stonecrop instance directly.
+ * When using the Vue plugin, pass these via `InstallOptions` instead.
+ * @public
+ */
+export interface StonecropOptions {
+    /**
+     * Data client for fetching doctype metadata and records.
+     * Use \@stonecrop/graphql-client's StonecropClient for GraphQL backends,
+     * or implement DataClient for custom data sources.
+     *
+     * Can be set later via `setClient()` for deferred configuration.
+     */
+    client?: DataClient;
+}
 /**
  * Main Stonecrop class with HST integration and built-in Operation Log
  * @public
@@ -11,14 +27,35 @@ export declare class Stonecrop {
     private hstStore;
     private _operationLogStore?;
     private _operationLogConfig?;
+    private _client?;
     /** The registry instance containing all doctype definitions */
     readonly registry: Registry;
     /**
      * Creates a new Stonecrop instance with HST integration
      * @param registry - The Registry instance containing doctype definitions
      * @param operationLogConfig - Optional configuration for the operation log
+     * @param options - Options including the data client (can be set later via setClient)
+     */
+    constructor(registry: Registry, operationLogConfig?: Partial<OperationLogConfig>, options?: StonecropOptions);
+    /**
+     * Set the data client for fetching doctype metadata and records.
+     * Use this for deferred configuration in Nuxt/Vue plugin setups.
+     *
+     * @param client - DataClient implementation (e.g., StonecropClient from \@stonecrop/graphql-client)
+     *
+     * @example
+     * ```ts
+     * const { setClient } = useStonecropRegistry()
+     * const client = new StonecropClient({ endpoint: '/graphql' })
+     * setClient(client)
+     * ```
      */
-    constructor(registry: Registry, operationLogConfig?: Partial<OperationLogConfig>);
+    setClient(client: DataClient): void;
+    /**
+     * Get the current data client
+     * @returns The DataClient instance or undefined if not set
+     */
+    getClient(): DataClient | undefined;
     /**
      * Get the operation log store (lazy initialization)
      * @internal
@@ -109,7 +146,7 @@ export declare class Stonecrop {
         getSnapshot: () => import("./types").OperationLogSnapshot;
         markIrreversible: (operationId: string, reason: string) => void;
         logAction: (doctype: string, actionName: string, recordIds?: string[], result?: "success" | "failure" | "pending", error?: string) => string;
-    }, "operations" | "clientId" | "currentIndex" | "config">, Pick<{
+    }, "operations" | "currentIndex" | "config" | "clientId">, Pick<{
         operations: import("vue").Ref<{
             id: string;
             type: import("./types").HSTOperationType;
@@ -341,16 +378,33 @@ export declare class Stonecrop {
      */
     runAction(doctype: DoctypeMeta, action: string, args?: any[]): void;
     /**
-     * Get records from server (maintains compatibility)
+     * Get records from server using the configured data client.
      * @param doctype - The doctype
+     * @throws Error if no data client has been configured
      */
     getRecords(doctype: DoctypeMeta): Promise<void>;
     /**
-     * Get single record from server (maintains compatibility)
+     * Get single record from server using the configured data client.
      * @param doctype - The doctype
      * @param recordId - The record ID
+     * @throws Error if no data client has been configured
      */
     getRecord(doctype: DoctypeMeta, recordId: string): Promise<void>;
+    /**
+     * Dispatch an action to the server via the configured data client.
+     * All state changes flow through this single mutation endpoint.
+     *
+     * @param doctype - The doctype
+     * @param action - Action name to execute (e.g., 'SUBMIT', 'APPROVE', 'save')
+     * @param args - Action arguments (typically record ID and/or form data)
+     * @returns Action result with success status, response data, and any error
+     * @throws Error if no data client has been configured
+     */
+    dispatchAction(doctype: DoctypeMeta, action: string, args?: unknown[]): Promise<{
+        success: boolean;
+        data: unknown;
+        error: string | null;
+    }>;
     /**
      * Ensure doctype section exists in HST store
      * @param slug - The doctype slug
@@ -367,5 +421,19 @@ export declare class Stonecrop {
      * @returns Root HST node
      */
     getStore(): HSTNode;
+    /**
+     * Determine the current workflow state for a record.
+     *
+     * Reads the record's `status` field from the HST store. If the field is absent or
+     * empty the doctype's declared `workflow.initial` state is used as the fallback,
+     * giving callers a reliable state name without having to duplicate that logic.
+     *
+     * @param doctype - The doctype slug or DoctypeMeta instance
+     * @param recordId - The record identifier
+     * @returns The current state name, or an empty string if the doctype has no workflow
+     *
+     * @public
+     */
+    getRecordState(doctype: string | DoctypeMeta, recordId: string): string;
 }
 //# sourceMappingURL=stonecrop.d.ts.map