@stonecrop/stonecrop 0.3.7 → 0.3.8

package/dist/stores/xstate.js

@@ -1,5 +1,5 @@
 import { defineStore } from 'pinia';
-import xstate from 'pinia-xstate';
+import { xstate } from 'pinia-xstate';
 import { createMachine } from 'xstate';
 export const counterMachine = createMachine({
     id: 'counter',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stonecrop/stonecrop",
-  "version": "0.3.7",
+  "version": "0.3.8",
   "description": "schema helper",
   "license": "MIT",
   "type": "module",
@@ -35,7 +35,7 @@
     "pinia": "^2.3.0",
     "pinia-shared-state": "^0.3.0",
     "pinia-undo": "^0.1.9",
-    "pinia-xstate": "^1.0.9",
+    "pinia-xstate": "^2.2.1",
     "vue": "^3.5.11",
     "vue-router": "^4.4.0",
     "xstate": "^4.38.3"
@@ -52,9 +52,9 @@
     "eslint-plugin-vue": "^9.11.1",
     "typescript": "^5.6.3",
     "vite": "^5.4.5",
-    "@stonecrop/atable": "0.3.7",
     "stonecrop-rig": "0.2.22",
-    "@stonecrop/aform": "0.3.7"
+    "@stonecrop/aform": "0.3.8",
+    "@stonecrop/atable": "0.3.8"
   },
   "publishConfig": {
     "access": "public"

package/src/composable.ts

@@ -32,10 +32,13 @@ export function useStonecrop(registry?: Registry): StonecropReturn {
 		throw new Error('Please enable the Stonecrop plugin before using the Stonecrop composable')
 	}
 
+	// @ts-expect-error TODO: handle empty registry passed to Stonecrop
 	const stonecrop = ref(new Stonecrop(registry, store))
 	const isReady = ref(false)
 
 	onBeforeMount(async () => {
+		if (!registry) return
+
 		const route = registry.router.currentRoute.value
 		const doctypeSlug = route.params.records?.toString().toLowerCase()
 		const recordId = route.params.record?.toString().toLowerCase()
@@ -46,19 +49,22 @@ export function useStonecrop(registry?: Registry): StonecropReturn {
 		}
 
 		// setup doctype via registry
-		const doctype = await registry.getMeta(doctypeSlug)
-		registry.addDoctype(doctype)
-		stonecrop.value.setup(doctype)
+		const doctype = await registry.getMeta?.(doctypeSlug)
+		if (doctype) {
+			registry.addDoctype(doctype)
+			stonecrop.value.setup(doctype)
 
-		if (doctypeSlug) {
-			if (recordId) {
-				await stonecrop.value.getRecord(doctype, recordId)
-			} else {
-				await stonecrop.value.getRecords(doctype)
+			if (doctypeSlug) {
+				if (recordId) {
+					await stonecrop.value.getRecord(doctype, recordId)
+				} else {
+					await stonecrop.value.getRecords(doctype)
+				}
 			}
+
+			stonecrop.value.runAction(doctype, 'LOAD', recordId ? [recordId] : undefined)
 		}
 
-		stonecrop.value.runAction(doctype, 'LOAD', recordId ? [recordId] : undefined)
 		isReady.value = true
 	})
 

package/src/registry.ts

@@ -58,7 +58,7 @@ export default class Registry {
 		if (!(doctype.doctype in Object.keys(this.registry))) {
 			this.registry[doctype.slug] = doctype
 		}
-		if (!this.router.hasRoute(doctype.doctype)) {
+		if (!this.router.hasRoute(doctype.doctype) && doctype.component) {
 			this.router.addRoute({
 				path: `/${doctype.slug}`,
 				name: doctype.slug,

package/src/stonecrop.ts

@@ -43,6 +43,11 @@ export class Stonecrop {
 	 */
 	readonly registry: Registry
 
+	/**
+	 * The Pinia store that manages the mutable records
+	 */
+	store: ReturnType<typeof useDataStore>
+
 	/**
 	 * schema - The Stonecrop schema; the schema is a subset of the registry
 	 * @example
@@ -60,22 +65,17 @@ export class Stonecrop {
 	 * @see {@link DoctypeMeta}
 	 * @see {@link DoctypeMeta.schema}
 	 */
-	schema: Schema
+	schema?: Schema
 
 	/**
 	 * The workflow is a subset of the registry
 	 */
-	workflow: ImmutableDoctype['workflow']
+	workflow?: ImmutableDoctype['workflow']
 
 	/**
 	 * The actions are a subset of the registry
 	 */
-	actions: ImmutableDoctype['actions']
-
-	/**
-	 * The Pinia store that manages the mutable records
-	 */
-	store: ReturnType<typeof useDataStore>
+	actions?: ImmutableDoctype['actions']
 
 	/**
 	 * @param registry - The immutable registry
@@ -236,19 +236,22 @@ export class Stonecrop {
 	 */
 	runAction(doctype: DoctypeMeta, action: string, id?: string[]): void {
 		const doctypeRegistry = this.registry.registry[doctype.slug]
-		const actions = doctypeRegistry.actions.get(action)
+		const actions = doctypeRegistry.actions?.get(action)
 
 		// trigger the action on the state machine
-		const { initialState } = this.workflow
-		this.workflow.transition(initialState, { type: action })
-
-		// run actions after state machine transition
-		if (actions.length > 0) {
-			actions.forEach(action => {
-				// eslint-disable-next-line @typescript-eslint/no-implied-eval
-				const actionFn = new Function(action)
-				actionFn(id)
-			})
+		if (this.workflow) {
+			const { initialState } = this.workflow
+			this.workflow.transition(initialState, { type: action })
+
+			// run actions after state machine transition
+			// TODO: should this happen with or without the workflow?
+			if (actions && actions.length > 0) {
+				actions.forEach(action => {
+					// eslint-disable-next-line @typescript-eslint/no-implied-eval
+					const actionFn = new Function(action)
+					actionFn(id)
+				})
+			}
 		}
 	}
 }

package/src/stores/xstate.ts

@@ -1,5 +1,5 @@
 import { defineStore } from 'pinia'
-import xstate from 'pinia-xstate'
+import { xstate } from 'pinia-xstate'
 import { createMachine } from 'xstate'
 
 export const counterMachine = createMachine(

package/src/types/index.ts

@@ -1,8 +1,8 @@
-import { SchemaTypes } from '@stonecrop/aform'
+import type { SchemaTypes } from '@stonecrop/aform'
 import { List, Map } from 'immutable'
-import { Component } from 'vue'
-import { Router } from 'vue-router'
-import { MachineConfig, StateMachine } from 'xstate'
+import type { Component } from 'vue'
+import type { Router } from 'vue-router'
+import type { MachineConfig, StateMachine } from 'xstate'
 
 import DoctypeMeta from '../doctype'
 
@@ -13,7 +13,7 @@ import DoctypeMeta from '../doctype'
 export type ImmutableDoctype = {
 	// TODO: allow schema to be a function
 	readonly schema?: List<SchemaTypes>
-	readonly workflow: StateMachine<unknown, unknown, any>
+	readonly workflow: StateMachine<unknown, any, any>
 	readonly actions?: Map<string, string[]>
 }
 
@@ -24,7 +24,7 @@ export type ImmutableDoctype = {
 export type MutableDoctype = {
 	// TODO: allow schema to be a function
 	schema?: SchemaTypes[]
-	workflow: MachineConfig<unknown, unknown, any>
+	workflow: MachineConfig<unknown, any, any>
 	actions?: Record<string, string[]>
 }