@stonecrop/stonecrop 0.4.27 → 0.4.29

package/dist/stores/index.js

@@ -1,11 +1,9 @@
 import { createPinia } from 'pinia';
 import { PiniaSharedState } from 'pinia-shared-state';
-// import { PiniaUndo } from 'pinia-undo'
 const pinia = createPinia();
 // Pass the plugin to your application's pinia plugin
 pinia.use(PiniaSharedState({
     enable: true,
     initialize: true,
 }));
-// pinia.use(PiniaUndo)
 export { pinia };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stonecrop/stonecrop",
-  "version": "0.4.27",
+  "version": "0.4.29",
   "description": "schema helper",
   "license": "MIT",
   "type": "module",
@@ -34,11 +34,10 @@
     "immutable": "^5.1.3",
     "pinia": "^3.0.3",
     "pinia-shared-state": "^1.0.1",
-    "pinia-undo": "^0.2.4",
-    "pinia-xstate": "^2.2.1",
+    "pinia-xstate": "^3.0.0",
     "vue": "^3.5.17",
     "vue-router": "^4.5.1",
-    "xstate": "^4.38.3"
+    "xstate": "^5.20.1"
   },
   "devDependencies": {
     "@microsoft/api-documenter": "^7.26.29",
@@ -47,14 +46,18 @@
     "@typescript-eslint/eslint-plugin": "^7.18.0",
     "@typescript-eslint/parser": "^7.18.0",
     "@vitejs/plugin-vue": "^5.2.4",
+    "@vitest/coverage-istanbul": "^3.2.4",
+    "@vue/test-utils": "^2.4.6",
     "eslint": "^8.57.1",
     "eslint-config-prettier": "^8.10.0",
     "eslint-plugin-vue": "^9.33.0",
+    "jsdom": "^26.1.0",
     "typescript": "^5.8.3",
     "vite": "^6.3.5",
-    "stonecrop-rig": "0.2.22",
-    "@stonecrop/atable": "0.4.27",
-    "@stonecrop/aform": "0.4.27"
+    "vitest": "^3.2.4",
+    "@stonecrop/atable": "0.4.29",
+    "@stonecrop/aform": "0.4.29",
+    "stonecrop-rig": "0.2.22"
   },
   "publishConfig": {
     "access": "public"
@@ -66,8 +69,12 @@
     "_phase:build": "heft build && vite build && rushx docs",
     "prepublish": "heft build && vite build && rushx docs",
     "build": "heft build && vite build && rushx docs",
-    "docs": "api-documenter markdown -i temp -o ../docs/stonecrop",
+    "docs": "cd ../common/autoinstallers/doc-tools && node generate-docs.mjs stonecrop",
     "lint": "eslint . --ext .ts,.vue",
-    "preview": "vite preview"
+    "preview": "vite preview",
+    "test": "vitest run --coverage.enabled false",
+    "test:watch": "vitest watch",
+    "test:coverage": "vitest run --coverage",
+    "test:ui": "vitest --ui"
   }
 }

package/src/composable.ts

@@ -27,6 +27,8 @@ export function useStonecrop(registry?: Registry): StonecropReturn {
 			registry = inject<Registry>('$registry')
 		}
 
+		if (!registry || !registry.router) return
+
 		let store: ReturnType<typeof useDataStore>
 		try {
 			store = useDataStore()
@@ -34,11 +36,7 @@ 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
 		stonecrop.value = new Stonecrop(registry, store)
-
-		if (!registry || !registry.router) return
-
 		const route = registry.router.currentRoute.value
 		const doctypeSlug = route.params.records?.toString().toLowerCase()
 		const recordId = route.params.record?.toString().toLowerCase()
@@ -62,7 +60,7 @@ export function useStonecrop(registry?: Registry): StonecropReturn {
 				}
 			}
 
-			stonecrop.value.runAction(doctype, 'LOAD', recordId ? [recordId] : undefined)
+			stonecrop.value.runAction(doctype, 'load', recordId ? [recordId] : undefined)
 		}
 	})
 

package/src/doctype.ts

@@ -59,8 +59,19 @@ export default class DoctypeMeta {
 	}
 
 	/**
-	 * Converts the registered doctype to a slug (kebab-case)
+	 * Converts the registered doctype string to a slug (kebab-case). The following conversions are made:
+	 * - It replaces camelCase and PascalCase with kebab-case strings
+	 * - It replaces spaces and underscores with hyphens
+	 * - It converts the string to lowercase
+	 *
 	 * @returns The slugified doctype string
+	 *
+	 * @example
+	 * ```ts
+	 * const doctype = new DoctypeMeta('TaskItem', schema, workflow, actions
+	 * console.log(doctype.slug) // 'task-item'
+	 * ```
+	 *
 	 * @public
 	 */
 	get slug() {

package/src/index.ts

@@ -16,6 +16,7 @@ import { type StonecropReturn, useStonecrop } from './composable'
 import DoctypeMeta from './doctype'
 import Registry from './registry'
 import Stonecrop from './plugins'
+import { Stonecrop as StonecropClass } from './stonecrop'
 export type { ImmutableDoctype, MutableDoctype, Schema, InstallOptions } from './types'
 
-export { DoctypeMeta, Registry, Stonecrop, StonecropReturn, useStonecrop }
+export { DoctypeMeta, Registry, Stonecrop, StonecropClass, StonecropReturn, useStonecrop }

package/src/registry.ts

@@ -17,25 +17,19 @@ export default class Registry {
 	 *
 	 * @defaultValue 'Registry'
 	 */
-	name: string
+	readonly name: string
 
 	/**
 	 * The registry property contains a collection of doctypes
 	 * @see {@link DoctypeMeta}
 	 */
-	registry: Record<string, DoctypeMeta>
+	readonly registry: Record<string, DoctypeMeta>
 
 	/**
 	 * The Vue router instance
 	 * @see {@link https://router.vuejs.org/}
 	 */
-	router?: Router
-
-	/**
-	 * The getMeta function fetches doctype metadata from an API
-	 * @see {@link DoctypeMeta}
-	 */
-	getMeta?: (doctype: string) => DoctypeMeta | Promise<DoctypeMeta>
+	readonly router?: Router
 
 	constructor(router?: Router, getMeta?: (doctype: string) => DoctypeMeta | Promise<DoctypeMeta>) {
 		if (Registry._root) {
@@ -48,6 +42,12 @@ export default class Registry {
 		this.getMeta = getMeta
 	}
 
+	/**
+	 * The getMeta function fetches doctype metadata from an API
+	 * @see {@link DoctypeMeta}
+	 */
+	getMeta?: (doctype: string) => DoctypeMeta | Promise<DoctypeMeta>
+
 	/**
 	 * Get doctype metadata
 	 * @param doctype - The doctype to fetch metadata for
@@ -67,4 +67,17 @@ export default class Registry {
 			})
 		}
 	}
+
+	// TODO: should we allow clearing the registry at all?
+	// clear() {
+	// 	this.registry = {}
+	// 	if (this.router) {
+	// 		const routes = this.router.getRoutes()
+	// 		for (const route of routes) {
+	// 			if (route.name) {
+	// 				this.router.removeRoute(route.name)
+	// 			}
+	// 		}
+	// 	}
+	// }
 }

package/src/stonecrop.ts

@@ -1,8 +1,9 @@
+import { createActor, createMachine } from 'xstate'
+
 import DoctypeMeta from './doctype'
 import { NotImplementedError } from './exceptions'
 import Registry from './registry'
 import { useDataStore } from './stores/data'
-import type { ImmutableDoctype, Schema } from './types'
 
 /**
  * Stonecrop class
@@ -48,42 +49,10 @@ export class Stonecrop {
 	 */
 	store: ReturnType<typeof useDataStore>
 
-	/**
-	 * schema - The Stonecrop schema; the schema is a subset of the registry
-	 * @example
-	 * ```ts
-	 * {
-	 * 	doctype: 'Task',
-	 * 	schema: {
-	 * 		title: 'string',
-	 * 		description: 'string',
-	 * 		...
-	 * 	}
-	 * }
-	 * ```
-	 * @see {@link Registry}
-	 * @see {@link DoctypeMeta}
-	 * @see {@link DoctypeMeta.schema}
-	 */
-	schema?: Schema
-
-	/**
-	 * The workflow is a subset of the registry
-	 */
-	workflow?: ImmutableDoctype['workflow']
-
-	/**
-	 * The actions are a subset of the registry
-	 */
-	actions?: ImmutableDoctype['actions']
-
 	/**
 	 * @param registry - The immutable registry
 	 * @param store - The mutable Pinia store
-	 * @param schema - The Stonecrop schema
-	 * @param workflow - The Stonecrop workflow
-	 * @param actions - The Stonecrop actions
-	 * @returns The Stonecrop instance with the given registry, store, schema, workflow, and actions. If a Stonecrop instance has already been created, it returns the existing instance instead of creating a new one.
+	 * @returns The Stonecrop instance with the given registry and store. If a Stonecrop instance has already been created, it returns the existing instance instead of creating a new one.
 	 * @example
 	 * ```ts
 	 * const registry = new Registry()
@@ -91,22 +60,13 @@ export class Stonecrop {
 	 * const stonecrop = new Stonecrop(registry, store)
 	 * ```
 	 */
-	constructor(
-		registry: Registry,
-		store: ReturnType<typeof useDataStore>,
-		schema?: Schema,
-		workflow?: ImmutableDoctype['workflow'],
-		actions?: ImmutableDoctype['actions']
-	) {
+	constructor(registry: Registry, store: ReturnType<typeof useDataStore>) {
 		if (Stonecrop._root) {
 			return Stonecrop._root
 		}
 		Stonecrop._root = this
 		this.registry = registry
 		this.store = store
-		this.schema = schema // new Registry(schema)
-		this.workflow = workflow
-		this.actions = actions
 	}
 
 	/**
@@ -119,16 +79,14 @@ export class Stonecrop {
 	 * ```
 	 */
 	setup(doctype: DoctypeMeta): void {
-		void this.getMeta(doctype)
-		this.getWorkflow(doctype)
-		this.getActions(doctype)
+		void this.getMeta(doctype.doctype)
 	}
 
 	/**
 	 * Gets the meta for the given doctype
 	 * @param doctype - The doctype to get meta for
 	 * @returns The meta for the given doctype
-	 * @throws NotImplementedError
+	 * @throws `NotImplementedError` if the `getMeta` function is not implemented for the doctype in the registry
 	 * @example
 	 * ```ts
 	 * const doctype = await registry.getMeta('Task')
@@ -136,36 +94,11 @@ export class Stonecrop {
 	 * ```
 	 * @see {@link DoctypeMeta}
 	 */
-	getMeta(doctype: DoctypeMeta): DoctypeMeta | Promise<DoctypeMeta> | never {
-		return this.registry.getMeta ? this.registry.getMeta(doctype.doctype) : new NotImplementedError(doctype.doctype)
-	}
-
-	/**
-	 * Gets the workflow for the given doctype
-	 * @param doctype - The doctype to get workflow for
-	 * @example
-	 * ```ts
-	 * const doctype = await registry.getMeta('Task')
-	 * stonecrop.getWorkflow(doctype)
-	 * ```
-	 */
-	getWorkflow(doctype: DoctypeMeta): void {
-		const doctypeRegistry = this.registry.registry[doctype.slug]
-		this.workflow = doctypeRegistry.workflow
-	}
-
-	/**
-	 * Gets the actions for the given doctype
-	 * @param doctype - The doctype to get actions for
-	 * @example
-	 * ```ts
-	 * const doctype = await registry.getMeta('Task')
-	 * stonecrop.getActions(doctype)
-	 * ```
-	 */
-	getActions(doctype: DoctypeMeta): void {
-		const doctypeRegistry = this.registry.registry[doctype.slug]
-		this.actions = doctypeRegistry.actions
+	async getMeta(doctype: string): Promise<DoctypeMeta> | never {
+		if (!this.registry.getMeta) {
+			throw new NotImplementedError(`getMeta function is not implemented for ${doctype} in the registry`)
+		}
+		return await this.registry.getMeta(doctype)
 	}
 
 	/**
@@ -216,32 +149,37 @@ export class Stonecrop {
 	 * @example
 	 * ```ts
 	 * const doctype = await registry.getMeta('Task')
-	 * stonecrop.runAction(doctype, 'CREATE')
+	 * stonecrop.runAction(doctype, 'create')
 	 * ```
 	 * @example
 	 * ```ts
 	 * const doctype = await registry.getMeta('Task')
-	 * stonecrop.runAction(doctype, 'UPDATE', ['TASK-00001'])
+	 * stonecrop.runAction(doctype, 'update', ['TASK-00001'])
 	 * ```
 	 * @example
 	 * ```ts
 	 * const doctype = await registry.getMeta('Task')
-	 * stonecrop.runAction(doctype, 'DELETE', ['TASK-00001'])
+	 * stonecrop.runAction(doctype, 'delete', ['TASK-00001'])
 	 * ```
 	 * @example
 	 * ```ts
 	 * const doctype = await registry.getMeta('Task')
-	 * stonecrop.runAction(doctype, 'TRANSITION', ['TASK-00001', 'TASK-00002'])
+	 * stonecrop.runAction(doctype, 'merge', ['TASK-00001', 'TASK-00002'])
 	 * ```
 	 */
 	runAction(doctype: DoctypeMeta, action: string, id?: string[]): void {
-		const doctypeRegistry = this.registry.registry[doctype.slug]
-		const actions = doctypeRegistry.actions?.get(action)
+		const registry = this.registry.registry[doctype.slug]
+		const actions = registry.actions?.get(action)
+		const workflow = registry.workflow
 
 		// trigger the action on the state machine
-		if (this.workflow) {
-			const { initialState } = this.workflow
-			this.workflow.transition(initialState, { type: action })
+		if (workflow) {
+			const machine = createMachine(workflow)
+			const actor = createActor(machine)
+
+			// TODO: this shouldn't spawn an actor at the initial state always; look into persistence
+			actor.start()
+			actor.send({ type: action, id })
 
 			// run actions after state machine transition
 			// TODO: should this happen with or without the workflow?

package/src/stores/index.ts

@@ -1,6 +1,5 @@
 import { createPinia } from 'pinia'
 import { PiniaSharedState } from 'pinia-shared-state'
-// import { PiniaUndo } from 'pinia-undo'
 
 const pinia = createPinia()
 
@@ -11,6 +10,5 @@ pinia.use(
 		initialize: true,
 	})
 )
-// pinia.use(PiniaUndo)
 
 export { pinia }

package/src/types/index.ts

@@ -2,7 +2,7 @@ import type { SchemaTypes } from '@stonecrop/aform'
 import { List, Map } from 'immutable'
 import type { Component } from 'vue'
 import type { Router } from 'vue-router'
-import type { MachineConfig, StateMachine } from 'xstate'
+import type { AnyStateNodeConfig, UnknownMachineConfig } 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, any, any>
+	readonly workflow?: UnknownMachineConfig | AnyStateNodeConfig
 	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, any, any>
+	workflow?: UnknownMachineConfig | AnyStateNodeConfig
 	actions?: Record<string, string[]>
 }
 

package/dist/src/stores/xstate.d.ts

@@ -1,31 +0,0 @@
-export declare const counterMachine: import("xstate").StateMachine<{
-    count: number;
-}, any, import("xstate").AnyEventObject, {
-    value: any;
-    context: {
-        count: number;
-    };
-}, import("xstate").BaseActionObject, import("xstate").ServiceMap, import("xstate").ResolveTypegenMeta<import("xstate").TypegenDisabled, import("xstate").AnyEventObject, import("xstate").BaseActionObject, import("xstate").ServiceMap>>;
-export declare const useCounterStore: import("pinia").StoreDefinition<string, Pick<import("pinia-xstate").Store<import("xstate").StateMachine<{
-    count: number;
-}, any, import("xstate").AnyEventObject, {
-    value: any;
-    context: {
-        count: number;
-    };
-}, import("xstate").BaseActionObject, import("xstate").ServiceMap, import("xstate").ResolveTypegenMeta<import("xstate").TypegenDisabled, import("xstate").AnyEventObject, import("xstate").BaseActionObject, import("xstate").ServiceMap>>>, "state" | "actor">, Pick<import("pinia-xstate").Store<import("xstate").StateMachine<{
-    count: number;
-}, any, import("xstate").AnyEventObject, {
-    value: any;
-    context: {
-        count: number;
-    };
-}, import("xstate").BaseActionObject, import("xstate").ServiceMap, import("xstate").ResolveTypegenMeta<import("xstate").TypegenDisabled, import("xstate").AnyEventObject, import("xstate").BaseActionObject, import("xstate").ServiceMap>>>, "state">, Pick<import("pinia-xstate").Store<import("xstate").StateMachine<{
-    count: number;
-}, any, import("xstate").AnyEventObject, {
-    value: any;
-    context: {
-        count: number;
-    };
-}, import("xstate").BaseActionObject, import("xstate").ServiceMap, import("xstate").ResolveTypegenMeta<import("xstate").TypegenDisabled, import("xstate").AnyEventObject, import("xstate").BaseActionObject, import("xstate").ServiceMap>>>, "state" | "send">>;
-//# sourceMappingURL=xstate.d.ts.map

package/dist/src/stores/xstate.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"xstate.d.ts","sourceRoot":"","sources":["../../../src/stores/xstate.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,cAAc;;;;;;;0OA0B1B,CAAA;AAGD,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;+PAAyD,CAAA"}

package/dist/stores/xstate.js

@@ -1,29 +0,0 @@
-import { defineStore } from 'pinia';
-import { xstate } from 'pinia-xstate';
-import { createMachine } from 'xstate';
-export const counterMachine = createMachine({
-    id: 'counter',
-    initial: 'active',
-    context: {
-        count: 0,
-    },
-    states: {
-        active: {
-            on: {
-                INC: { actions: 'increment' },
-                DEC: { actions: 'decrement' },
-            },
-        },
-    },
-}, {
-    actions: {
-        increment: context => {
-            context.count = context.count + 1;
-        },
-        decrement: context => {
-            context.count = context.count - 1;
-        },
-    },
-});
-// create a store using the xstate middleware
-export const useCounterStore = defineStore(counterMachine.id, xstate(counterMachine));

package/src/stores/xstate.ts

@@ -1,34 +0,0 @@
-import { defineStore } from 'pinia'
-import { xstate } from 'pinia-xstate'
-import { createMachine } from 'xstate'
-
-export const counterMachine = createMachine(
-	{
-		id: 'counter',
-		initial: 'active',
-		context: {
-			count: 0,
-		},
-		states: {
-			active: {
-				on: {
-					INC: { actions: 'increment' },
-					DEC: { actions: 'decrement' },
-				},
-			},
-		},
-	},
-	{
-		actions: {
-			increment: context => {
-				context.count = context.count + 1
-			},
-			decrement: context => {
-				context.count = context.count - 1
-			},
-		},
-	}
-)
-
-// create a store using the xstate middleware
-export const useCounterStore = defineStore(counterMachine.id, xstate(counterMachine))