@stonecrop/stonecrop 0.4.28 → 0.4.29

package/dist/composable.js

@@ -14,6 +14,8 @@ export function useStonecrop(registry) {
         if (!registry) {
             registry = inject('$registry');
         }
+        if (!registry || !registry.router)
+            return;
         let store;
         try {
             store = useDataStore();
@@ -21,10 +23,7 @@ export function useStonecrop(registry) {
         catch (e) {
             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();
@@ -45,7 +44,7 @@ export function useStonecrop(registry) {
                     await stonecrop.value.getRecords(doctype);
                 }
             }
-            stonecrop.value.runAction(doctype, 'LOAD', recordId ? [recordId] : undefined);
+            stonecrop.value.runAction(doctype, 'load', recordId ? [recordId] : undefined);
         }
     });
     return { stonecrop };

package/dist/doctype.js

@@ -43,8 +43,19 @@ export default class DoctypeMeta {
         this.component = component;
     }
     /**
-     * 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/dist/index.js

@@ -2,4 +2,5 @@ import { useStonecrop } from './composable';
 import DoctypeMeta from './doctype';
 import Registry from './registry';
 import Stonecrop from './plugins';
-export { DoctypeMeta, Registry, Stonecrop, useStonecrop };
+import { Stonecrop as StonecropClass } from './stonecrop';
+export { DoctypeMeta, Registry, Stonecrop, StonecropClass, useStonecrop };

package/dist/registry.js

@@ -23,11 +23,6 @@ export default class Registry {
      * @see {@link https://router.vuejs.org/}
      */
     router;
-    /**
-     * The getMeta function fetches doctype metadata from an API
-     * @see {@link DoctypeMeta}
-     */
-    getMeta;
     constructor(router, getMeta) {
         if (Registry._root) {
             return Registry._root;
@@ -38,6 +33,11 @@ export default class Registry {
         this.router = router;
         this.getMeta = getMeta;
     }
+    /**
+     * The getMeta function fetches doctype metadata from an API
+     * @see {@link DoctypeMeta}
+     */
+    getMeta;
     /**
      * Get doctype metadata
      * @param doctype - The doctype to fetch metadata for

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

@@ -1 +1 @@
-{"version":3,"file":"composable.d.ts","sourceRoot":"","sources":["../../src/composable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,GAAG,EAAO,MAAM,KAAK,CAAA;AAEjD,OAAO,QAAQ,MAAM,YAAY,CAAA;AACjC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAGvC;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAC7B,SAAS,EAAE,GAAG,CAAC,SAAS,GAAG,SAAS,CAAC,CAAA;CACrC,CAAA;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAG,eAAe,CAgDjE"}
+{"version":3,"file":"composable.d.ts","sourceRoot":"","sources":["../../src/composable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,GAAG,EAAO,MAAM,KAAK,CAAA;AAEjD,OAAO,QAAQ,MAAM,YAAY,CAAA;AACjC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAGvC;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAC7B,SAAS,EAAE,GAAG,CAAC,SAAS,GAAG,SAAS,CAAC,CAAA;CACrC,CAAA;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAG,eAAe,CA8CjE"}

package/dist/src/doctype.d.ts

@@ -37,8 +37,19 @@ export default class DoctypeMeta {
     readonly component?: Component;
     constructor(doctype: string, schema: ImmutableDoctype['schema'], workflow: ImmutableDoctype['workflow'], actions: ImmutableDoctype['actions'], component?: Component);
     /**
-     * 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(): string;

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;gBAK7B,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;;;;OAIG;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,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;gBAK7B,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"}

package/dist/src/index.d.ts

@@ -4,6 +4,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 };
 //# 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,YAAY,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AACxG,YAAY,EACX,WAAW,EACX,eAAe,EACf,gBAAgB,EAChB,cAAc,EACd,YAAY,EACZ,cAAc,EACd,YAAY,EACZ,WAAW,EACX,WAAW,EACX,QAAQ,GACR,MAAM,mBAAmB,CAAA;AAE1B,OAAO,EAAE,KAAK,eAAe,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AACjE,OAAO,WAAW,MAAM,WAAW,CAAA;AACnC,OAAO,QAAQ,MAAM,YAAY,CAAA;AACjC,OAAO,SAAS,MAAM,WAAW,CAAA;AACjC,YAAY,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAEvF,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,eAAe,EAAE,YAAY,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AACxG,YAAY,EACX,WAAW,EACX,eAAe,EACf,gBAAgB,EAChB,cAAc,EACd,YAAY,EACZ,cAAc,EACd,YAAY,EACZ,WAAW,EACX,WAAW,EACX,QAAQ,GACR,MAAM,mBAAmB,CAAA;AAE1B,OAAO,EAAE,KAAK,eAAe,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AACjE,OAAO,WAAW,MAAM,WAAW,CAAA;AACnC,OAAO,QAAQ,MAAM,YAAY,CAAA;AACjC,OAAO,SAAS,MAAM,WAAW,CAAA;AACjC,OAAO,EAAE,SAAS,IAAI,cAAc,EAAE,MAAM,aAAa,CAAA;AACzD,YAAY,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAEvF,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,cAAc,EAAE,eAAe,EAAE,YAAY,EAAE,CAAA"}

package/dist/src/registry.d.ts

@@ -14,23 +14,23 @@ 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;
+    readonly router?: Router;
+    constructor(router?: Router, getMeta?: (doctype: string) => DoctypeMeta | Promise<DoctypeMeta>);
     /**
      * The getMeta function fetches doctype metadata from an API
      * @see {@link DoctypeMeta}
      */
     getMeta?: (doctype: string) => DoctypeMeta | Promise<DoctypeMeta>;
-    constructor(router?: Router, getMeta?: (doctype: string) => DoctypeMeta | Promise<DoctypeMeta>);
     /**
      * Get doctype metadata
      * @param doctype - The doctype to fetch metadata for

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

@@ -1 +1 @@
-{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../src/registry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAEnC,OAAO,WAAW,MAAM,WAAW,CAAA;AAEnC;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC5B;;OAEG;IACH,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAA;IAEtB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;IAErC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;gBAErD,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;IAW9F;;;;;OAKG;IACH,UAAU,CAAC,OAAO,EAAE,WAAW;CAa/B"}
+{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../src/registry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAEnC,OAAO,WAAW,MAAM,WAAW,CAAA;AAEnC;;;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;gBAEZ,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;IAW9F;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;IAEjE;;;;;OAKG;IACH,UAAU,CAAC,OAAO,EAAE,WAAW;CA0B/B"}

package/dist/src/stonecrop.d.ts

@@ -1,7 +1,6 @@
 import DoctypeMeta from './doctype';
 import Registry from './registry';
 import { useDataStore } from './stores/data';
-import type { ImmutableDoctype, Schema } from './types';
 /**
  * Stonecrop class
  * @public
@@ -42,39 +41,10 @@ export declare class Stonecrop {
      * 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
-     * ```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()
@@ -82,7 +52,7 @@ export declare 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>);
     /**
      * Sets up the Stonecrop instance with the given doctype
      * @param doctype - The doctype to setup
@@ -97,7 +67,7 @@ export declare class Stonecrop {
      * 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')
@@ -105,27 +75,7 @@ export declare class Stonecrop {
      * ```
      * @see {@link DoctypeMeta}
      */
-    getMeta(doctype: DoctypeMeta): DoctypeMeta | Promise<DoctypeMeta> | never;
-    /**
-     * 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;
-    /**
-     * 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;
+    getMeta(doctype: string): Promise<DoctypeMeta> | never;
     /**
      * Gets the records for the given doctype
      * @param doctype - The doctype to get records for
@@ -162,22 +112,22 @@ export declare 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;

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

@@ -1 +1 @@
-{"version":3,"file":"stonecrop.d.ts","sourceRoot":"","sources":["../../src/stonecrop.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,WAAW,CAAA;AAEnC,OAAO,QAAQ,MAAM,YAAY,CAAA;AACjC,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAEvD;;;GAGG;AACH,qBAAa,SAAS;IACrB;;OAEG;IACH,MAAM,CAAC,KAAK,EAAE,SAAS,CAAA;IAEvB;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,eAAc;IAE3B;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAE3B;;OAEG;IACH,KAAK,EAAE,UAAU,CAAC,OAAO,YAAY,CAAC,CAAA;IAEtC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,gBAAgB,CAAC,UAAU,CAAC,CAAA;IAEvC;;OAEG;IACH,OAAO,CAAC,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAA;IAErC;;;;;;;;;;;;;OAaG;gBAEF,QAAQ,EAAE,QAAQ,EAClB,KAAK,EAAE,UAAU,CAAC,OAAO,YAAY,CAAC,EACtC,MAAM,CAAC,EAAE,MAAM,EACf,QAAQ,CAAC,EAAE,gBAAgB,CAAC,UAAU,CAAC,EACvC,OAAO,CAAC,EAAE,gBAAgB,CAAC,SAAS,CAAC;IAatC;;;;;;;;OAQG;IACH,KAAK,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI;IAMjC;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,OAAO,EAAE,WAAW,GAAG,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,GAAG,KAAK;IAIzE;;;;;;;;OAQG;IACH,WAAW,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI;IAKvC;;;;;;;;OAQG;IACH,UAAU,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI;IAKtC;;;;;;;;;;;;;;;OAeG;IACG,UAAU,CAAC,OAAO,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAO5E;;;;;;;;;OASG;IACG,SAAS,CAAC,OAAO,EAAE,WAAW,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAOhE;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,SAAS,CAAC,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI;CAoBpE"}
+{"version":3,"file":"stonecrop.d.ts","sourceRoot":"","sources":["../../src/stonecrop.ts"],"names":[],"mappings":"AAEA,OAAO,WAAW,MAAM,WAAW,CAAA;AAEnC,OAAO,QAAQ,MAAM,YAAY,CAAA;AACjC,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAE5C;;;GAGG;AACH,qBAAa,SAAS;IACrB;;OAEG;IACH,MAAM,CAAC,KAAK,EAAE,SAAS,CAAA;IAEvB;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,eAAc;IAE3B;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAE3B;;OAEG;IACH,KAAK,EAAE,UAAU,CAAC,OAAO,YAAY,CAAC,CAAA;IAEtC;;;;;;;;;;OAUG;gBACS,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,CAAC,OAAO,YAAY,CAAC;IAStE;;;;;;;;OAQG;IACH,KAAK,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI;IAIjC;;;;;;;;;;;OAWG;IACG,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,GAAG,KAAK;IAO5D;;;;;;;;;;;;;;;OAeG;IACG,UAAU,CAAC,OAAO,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAO5E;;;;;;;;;OASG;IACG,SAAS,CAAC,OAAO,EAAE,WAAW,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAOhE;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,SAAS,CAAC,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI;CAyBpE"}

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/stores/index.ts"],"names":[],"mappings":"AAIA,QAAA,MAAM,KAAK,uBAAgB,CAAA;AAW3B,OAAO,EAAE,KAAK,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/stores/index.ts"],"names":[],"mappings":"AAGA,QAAA,MAAM,KAAK,uBAAgB,CAAA;AAU3B,OAAO,EAAE,KAAK,EAAE,CAAA"}

package/dist/src/types/index.d.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';
 /**
  * Immutable Doctype type for Stonecrop instances
@@ -10,7 +10,7 @@ import DoctypeMeta from '../doctype';
  */
 export type ImmutableDoctype = {
     readonly schema?: List<SchemaTypes>;
-    readonly workflow: StateMachine<unknown, any, any>;
+    readonly workflow?: UnknownMachineConfig | AnyStateNodeConfig;
     readonly actions?: Map<string, string[]>;
 };
 /**
@@ -19,7 +19,7 @@ export type ImmutableDoctype = {
  */
 export type MutableDoctype = {
     schema?: SchemaTypes[];
-    workflow: MachineConfig<unknown, any, any>;
+    workflow?: UnknownMachineConfig | AnyStateNodeConfig;
     actions?: Record<string, string[]>;
 };
 /**

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AACnD,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,WAAW,CAAA;AACrC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,KAAK,CAAA;AACpC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AACxC,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAA;AAEzD,OAAO,WAAW,MAAM,YAAY,CAAA;AAEpC;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAE9B,QAAQ,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAA;IACnC,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAC,OAAO,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;IAClD,QAAQ,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;CACxC,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;IAE5B,MAAM,CAAC,EAAE,WAAW,EAAE,CAAA;IACtB,QAAQ,EAAE,aAAa,CAAC,OAAO,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;CAClC,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,MAAM,GAAG;IACpB,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,CAAA;CACzB,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IACtC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,KAAK,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;CAClE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AACnD,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,WAAW,CAAA;AACrC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,KAAK,CAAA;AACpC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AACxC,OAAO,KAAK,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,QAAQ,CAAA;AAEtE,OAAO,WAAW,MAAM,YAAY,CAAA;AAEpC;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAE9B,QAAQ,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAA;IACnC,QAAQ,CAAC,QAAQ,CAAC,EAAE,oBAAoB,GAAG,kBAAkB,CAAA;IAC7D,QAAQ,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;CACxC,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;IAE5B,MAAM,CAAC,EAAE,WAAW,EAAE,CAAA;IACtB,QAAQ,CAAC,EAAE,oBAAoB,GAAG,kBAAkB,CAAA;IACpD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;CAClC,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,MAAM,GAAG;IACpB,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,CAAA;CACzB,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IACtC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,KAAK,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;CAClE,CAAA"}

package/dist/stonecrop.d.ts

@@ -1,13 +1,13 @@
+import type { AnyStateNodeConfig } from 'xstate';
 import { Component } from 'vue';
 import { List } from 'immutable';
-import type { MachineConfig } from 'xstate';
 import { Map as Map_2 } from 'immutable';
 import { Plugin as Plugin_2 } from 'vue';
 import { Ref } from 'vue';
 import { Router } from 'vue-router';
 import type { ShallowRef } from 'vue';
-import type { StateMachine } from 'xstate';
 import { StoreDefinition } from 'pinia';
+import type { UnknownMachineConfig } from 'xstate';
 
 /**
  * Basic field structure for AForm schemas
@@ -177,8 +177,19 @@ export declare class DoctypeMeta {
     readonly component?: Component;
     constructor(doctype: string, schema: ImmutableDoctype['schema'], workflow: ImmutableDoctype['workflow'], actions: ImmutableDoctype['actions'], component?: Component);
     /**
-     * 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(): string;
@@ -369,7 +380,7 @@ export declare interface GanttOptions {
  */
 export declare type ImmutableDoctype = {
     readonly schema?: List<SchemaTypes>;
-    readonly workflow: StateMachine<unknown, any, any>;
+    readonly workflow?: UnknownMachineConfig | AnyStateNodeConfig;
     readonly actions?: Map_2<string, string[]>;
 };
 
@@ -389,7 +400,7 @@ export declare type InstallOptions = {
  */
 export declare type MutableDoctype = {
     schema?: SchemaTypes[];
-    workflow: MachineConfig<unknown, any, any>;
+    workflow?: UnknownMachineConfig | AnyStateNodeConfig;
     actions?: Record<string, string[]>;
 };
 
@@ -407,23 +418,23 @@ export declare 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;
+    readonly router?: Router;
+    constructor(router?: Router, getMeta?: (doctype: string) => DoctypeMeta | Promise<DoctypeMeta>);
     /**
      * The getMeta function fetches doctype metadata from an API
      * @see {@link DoctypeMeta}
      */
     getMeta?: (doctype: string) => DoctypeMeta | Promise<DoctypeMeta>;
-    constructor(router?: Router, getMeta?: (doctype: string) => DoctypeMeta | Promise<DoctypeMeta>);
     /**
      * Get doctype metadata
      * @param doctype - The doctype to fetch metadata for
@@ -482,11 +493,11 @@ export declare const Stonecrop: Plugin_2;
  * Stonecrop class
  * @public
  */
-declare class Stonecrop_2 {
+export declare class StonecropClass {
     /**
      * The root Stonecrop instance
      */
-    static _root: Stonecrop_2;
+    static _root: StonecropClass;
     /**
      * The name of the Stonecrop instance
      * @readonly
@@ -518,39 +529,10 @@ declare class Stonecrop_2 {
      * 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
-     * ```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()
@@ -558,7 +540,7 @@ declare class Stonecrop_2 {
      * 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>);
     /**
      * Sets up the Stonecrop instance with the given doctype
      * @param doctype - The doctype to setup
@@ -573,7 +555,7 @@ declare class Stonecrop_2 {
      * 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')
@@ -581,27 +563,7 @@ declare class Stonecrop_2 {
      * ```
      * @see {@link DoctypeMeta}
      */
-    getMeta(doctype: DoctypeMeta): DoctypeMeta | Promise<DoctypeMeta> | never;
-    /**
-     * 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;
-    /**
-     * 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;
+    getMeta(doctype: string): Promise<DoctypeMeta> | never;
     /**
      * Gets the records for the given doctype
      * @param doctype - The doctype to get records for
@@ -638,22 +600,22 @@ declare class Stonecrop_2 {
      * @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;
@@ -664,7 +626,7 @@ declare class Stonecrop_2 {
  * @public
  */
 export declare type StonecropReturn = {
-    stonecrop: Ref<Stonecrop_2 | undefined>;
+    stonecrop: Ref<StonecropClass | undefined>;
 };
 
 /**