@stonecrop/stonecrop 0.10.2 → 0.10.4

package/package.json

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

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

@@ -1,13 +1,12 @@
-// src/composable.ts
 import { inject, onMounted, Ref, ref, watch, provide, computed, ComputedRef } from 'vue'
 
-import Registry from './registry'
-import { Stonecrop } from './stonecrop'
-import DoctypeMeta from './doctype'
-import type { HSTNode } from './stores/hst'
-import { RouteContext } from './types/registry'
+import Registry from '../registry'
+import { Stonecrop } from '../stonecrop'
+import DoctypeMeta from '../doctype'
+import type { HSTNode } from '../stores/hst'
+import { RouteContext } from '../types/registry'
 import { storeToRefs } from 'pinia'
-import type { HSTOperation, OperationLogConfig, OperationLogSnapshot } from './types/operation-log'
+import type { HSTOperation, OperationLogConfig, OperationLogSnapshot } from '../types/operation-log'
 import { SchemaTypes, DoctypeSchema } from '@stonecrop/aform'
 
 /**
@@ -449,9 +448,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: DoctypeMeta, recordId: string): Promise<Record<string, any>> => {
+	const saveRecursive = (doctype: DoctypeMeta, recordId: string): Record<string, any> => {
 		if (!hstStore.value || !stonecrop.value) {
 			throw new Error('HST store not initialized')
 		}

package/src/doctype.ts

@@ -14,6 +14,15 @@ export default class DoctypeMeta {
 	 */
 	readonly doctype: string
 
+	/**
+	 * Alias for doctype (for DoctypeLike interface compatibility)
+	 * @public
+	 * @readonly
+	 */
+	get name(): string {
+		return this.doctype
+	}
+
 	/**
 	 * The doctype schema
 	 * @public

package/src/index.ts

@@ -1,7 +1,7 @@
 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 {
@@ -14,13 +14,13 @@ import {
 } 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'
 // Export schema validator
 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,
@@ -39,6 +39,7 @@ export {
 	DoctypeMeta,
 	Registry,
 	Stonecrop,
+	StonecropOptions,
 	useStonecrop,
 	// HST exports for advanced usage
 	HST,

package/src/plugins/index.ts

@@ -33,14 +33,19 @@ async function setupAutoInitialization(
  * ```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) => {
@@ -67,7 +72,7 @@ const plugin: Plugin = {
 		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
 
@@ -85,6 +90,7 @@ const plugin: 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)
 		}
 

package/src/stonecrop.ts

@@ -1,4 +1,6 @@
+import type { DataClient } from '@stonecrop/schema'
 import { reactive } from 'vue'
+
 import DoctypeMeta from './doctype'
 import Registry from './registry'
 import { createHST, type HSTNode } from './stores/hst'
@@ -6,6 +8,22 @@ import { useOperationLogStore } from './stores/operation-log'
 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
@@ -14,6 +32,7 @@ export class Stonecrop {
 	private hstStore: HSTNode
 	private _operationLogStore?: ReturnType<typeof useOperationLogStore>
 	private _operationLogConfig?: Partial<OperationLogConfig>
+	private _client?: DataClient
 
 	/** The registry instance containing all doctype definitions */
 	readonly registry: Registry
@@ -22,18 +41,47 @@ export class Stonecrop {
 	 * 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>) {
+	constructor(registry: Registry, operationLogConfig?: Partial<OperationLogConfig>, options?: StonecropOptions) {
 		this.registry = registry
 
 		// Store config for lazy initialization
 		this._operationLogConfig = operationLogConfig
 
+		// Store data client (can be set later via setClient)
+		this._client = options?.client
+
 		// Initialize HST store with auto-sync to Registry
 		this.initializeHSTStore()
 		this.setupRegistrySync()
 	}
 
+	/**
+	 * 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)
+	 * ```
+	 */
+	setClient(client: DataClient): void {
+		this._client = client
+	}
+
+	/**
+	 * Get the current data client
+	 * @returns The DataClient instance or undefined if not set
+	 */
+	getClient(): DataClient | undefined {
+		return this._client
+	}
+
 	/**
 	 * Get the operation log store (lazy initialization)
 	 * @internal
@@ -233,32 +281,72 @@ export class Stonecrop {
 	}
 
 	/**
-	 * 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
 	 */
 	async getRecords(doctype: DoctypeMeta): Promise<void> {
-		const response = await fetch(`/${doctype.slug}`)
-		const records = (await response.json()) as { id: string }[]
+		if (!this._client) {
+			throw new Error(
+				'No data client configured. Call setClient() with a DataClient implementation ' +
+					'(e.g., StonecropClient from @stonecrop/graphql-client) before fetching records.'
+			)
+		}
+
+		const records = await this._client.getRecords(doctype)
 
 		// Store each record in HST
 		records.forEach(record => {
 			if (record.id) {
-				this.addRecord(doctype, record.id, record)
+				this.addRecord(doctype, record.id as string, record)
 			}
 		})
 	}
 
 	/**
-	 * 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
 	 */
 	async getRecord(doctype: DoctypeMeta, recordId: string): Promise<void> {
-		const response = await fetch(`/${doctype.slug}/${recordId}`)
-		const record = await response.json()
+		if (!this._client) {
+			throw new Error(
+				'No data client configured. Call setClient() with a DataClient implementation ' +
+					'(e.g., StonecropClient from @stonecrop/graphql-client) before fetching records.'
+			)
+		}
+
+		const record = await this._client.getRecord(doctype, recordId)
+
+		if (record) {
+			this.addRecord(doctype, recordId, record)
+		}
+	}
+
+	/**
+	 * 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
+	 */
+	async dispatchAction(
+		doctype: DoctypeMeta,
+		action: string,
+		args?: unknown[]
+	): Promise<{ success: boolean; data: unknown; error: string | null }> {
+		if (!this._client) {
+			throw new Error(
+				'No data client configured. Call setClient() with a DataClient implementation ' +
+					'(e.g., StonecropClient from @stonecrop/graphql-client) before dispatching actions.'
+			)
+		}
 
-		// Store record
-		this.addRecord(doctype, recordId, record)
+		return this._client.runAction(doctype, action, args)
 	}
 
 	/**

package/src/types/index.ts

@@ -1,3 +1,4 @@
+import type { DataClient } from '@stonecrop/schema'
 import type { SchemaTypes } from '@stonecrop/aform'
 import { List, Map } from 'immutable'
 import type { Component } from 'vue'
@@ -47,6 +48,22 @@ export type InstallOptions = {
 	router?: Router
 	components?: Record<string, Component>
 	getMeta?: (routeContext: RouteContext) => DoctypeMeta | Promise<DoctypeMeta>
+	/**
+	 * 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 `useStonecropRegistry().setClient()` for deferred configuration.
+	 *
+	 * @example
+	 * ```ts
+	 * import { StonecropClient } from '@stonecrop/graphql-client'
+	 *
+	 * const client = new StonecropClient({ endpoint: '/graphql' })
+	 * app.use(StonecropPlugin, { client })
+	 * ```
+	 */
+	client?: DataClient
 	/** Automatically run initialization callback after app mounting (default: false) */
 	autoInitializeRouter?: boolean
 	/** Callback function called after plugin is ready and mounted */

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

@@ -1 +0,0 @@
-{"version":3,"file":"composable.d.ts","sourceRoot":"","sources":["../../src/composable.ts"],"names":[],"mappings":"AACA,OAAO,EAAqB,GAAG,EAAiC,WAAW,EAAE,MAAM,KAAK,CAAA;AAExF,OAAO,QAAQ,MAAM,YAAY,CAAA;AACjC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,WAAW,MAAM,WAAW,CAAA;AACnC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAG3C,OAAO,KAAK,EAAE,YAAY,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAA;AACnG,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"}