@stonecrop/stonecrop 0.3.11 → 0.4.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stonecrop/stonecrop",
-  "version": "0.3.11",
+  "version": "0.4.1",
   "description": "schema helper",
   "license": "MIT",
   "type": "module",
@@ -50,11 +50,11 @@
     "eslint": "^8.40.0",
     "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-vue": "^9.11.1",
-    "typescript": "^5.6.3",
+    "typescript": "~5.6.3",
     "vite": "^5.4.5",
-    "@stonecrop/aform": "0.3.11",
-    "@stonecrop/atable": "0.3.11",
-    "stonecrop-rig": "0.2.22"
+    "@stonecrop/aform": "0.4.1",
+    "stonecrop-rig": "0.2.22",
+    "@stonecrop/atable": "0.4.1"
   },
   "publishConfig": {
     "access": "public"

package/src/composable.ts

@@ -1,4 +1,4 @@
-import { inject, onBeforeMount, Ref, ref } from 'vue'
+import { inject, onMounted, Ref, ref } from 'vue'
 
 import Registry from './registry'
 import { Stonecrop } from './stonecrop'
@@ -9,8 +9,7 @@ import { useDataStore } from './stores/data'
  * @public
  */
 export type StonecropReturn = {
-	stonecrop: Ref<Stonecrop>
-	isReady: Ref<boolean>
+	stonecrop: Ref<Stonecrop | undefined>
 }
 
 /**
@@ -21,23 +20,24 @@ export type StonecropReturn = {
  * @public
  */
 export function useStonecrop(registry?: Registry): StonecropReturn {
-	if (!registry) {
-		registry = inject<Registry>('$registry')
-	}
+	const stonecrop = ref<Stonecrop>()
 
-	let store: ReturnType<typeof useDataStore>
-	try {
-		store = useDataStore()
-	} catch (e) {
-		throw new Error('Please enable the Stonecrop plugin before using the Stonecrop composable')
-	}
+	onMounted(async () => {
+		if (!registry) {
+			registry = inject<Registry>('$registry')
+		}
+
+		let store: ReturnType<typeof useDataStore>
+		try {
+			store = useDataStore()
+		} 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
-	const stonecrop = ref(new Stonecrop(registry, store))
-	const isReady = ref(false)
+		// @ts-expect-error TODO: handle empty registry passed to Stonecrop
+		stonecrop.value = new Stonecrop(registry, store)
 
-	onBeforeMount(async () => {
-		if (!registry) return
+		if (!registry || !registry.router) return
 
 		const route = registry.router.currentRoute.value
 		const doctypeSlug = route.params.records?.toString().toLowerCase()
@@ -64,10 +64,7 @@ export function useStonecrop(registry?: Registry): StonecropReturn {
 
 			stonecrop.value.runAction(doctype, 'LOAD', recordId ? [recordId] : undefined)
 		}
-
-		isReady.value = true
 	})
 
-	// @ts-expect-error TODO: fix the type mismatch
-	return { stonecrop, isReady }
+	return { stonecrop }
 }

package/src/plugins/index.ts

@@ -1,7 +1,6 @@
 import { App, type Plugin } from 'vue'
 
 import Registry from '../registry'
-import router from '../router'
 import { pinia } from '../stores'
 import type { InstallOptions } from '../types'
 
@@ -35,10 +34,15 @@ import type { InstallOptions } from '../types'
  */
 const plugin: Plugin = {
 	install: (app: App, options?: InstallOptions) => {
-		const appRouter = options?.router || router
+		// check if the router is already installed via another plugin
+		const existingRouter = app.config.globalProperties.$router
+		const appRouter = existingRouter || options?.router
 		const registry = new Registry(appRouter, options?.getMeta)
 
-		app.use(appRouter)
+		if (!existingRouter && appRouter) {
+			app.use(appRouter)
+		}
+
 		app.use(pinia)
 		app.provide('$registry', registry)
 

package/src/registry.ts

@@ -19,32 +19,32 @@ export default class Registry {
 	 */
 	name: string
 
-	/**
-	 * The Vue router instance
-	 * @see {@link https://router.vuejs.org/}
-	 */
-	router: Router
-
 	/**
 	 * The registry property contains a collection of doctypes
 	 * @see {@link DoctypeMeta}
 	 */
 	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>
 
-	constructor(router: Router, getMeta?: (doctype: string) => DoctypeMeta | Promise<DoctypeMeta>) {
+	constructor(router?: Router, getMeta?: (doctype: string) => DoctypeMeta | Promise<DoctypeMeta>) {
 		if (Registry._root) {
 			return Registry._root
 		}
 		Registry._root = this
 		this.name = 'Registry'
-		this.router = router
 		this.registry = {}
+		this.router = router
 		this.getMeta = getMeta
 	}
 
@@ -58,7 +58,8 @@ export default class Registry {
 		if (!(doctype.doctype in Object.keys(this.registry))) {
 			this.registry[doctype.slug] = doctype
 		}
-		if (!this.router.hasRoute(doctype.doctype) && doctype.component) {
+
+		if (doctype.component && this.router && !this.router.hasRoute(doctype.doctype)) {
 			this.router.addRoute({
 				path: `/${doctype.slug}`,
 				name: doctype.slug,

package/dist/router.js

@@ -1,6 +0,0 @@
-import { createRouter, createWebHistory } from 'vue-router';
-const router = createRouter({
-    history: createWebHistory(),
-    routes: [],
-});
-export default router;

package/dist/src/router.d.ts

@@ -1,3 +0,0 @@
-declare const router: import("vue-router").Router;
-export default router;
-//# sourceMappingURL=router.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../../src/router.ts"],"names":[],"mappings":"AAEA,QAAA,MAAM,MAAM,6BAGV,CAAA;AAEF,eAAe,MAAM,CAAA"}

package/src/router.ts

@@ -1,8 +0,0 @@
-import { createRouter, createWebHistory } from 'vue-router'
-
-const router = createRouter({
-	history: createWebHistory(),
-	routes: [],
-})
-
-export default router