@stonecrop/stonecrop 0.3.11 → 0.4.1

package/dist/composable.js

@@ -1,4 +1,4 @@
-import { inject, onBeforeMount, ref } from 'vue';
+import { inject, onMounted, ref } from 'vue';
 import { Stonecrop } from './stonecrop';
 import { useDataStore } from './stores/data';
 /**
@@ -9,21 +9,21 @@ import { useDataStore } from './stores/data';
  * @public
  */
 export function useStonecrop(registry) {
-    if (!registry) {
-        registry = inject('$registry');
-    }
-    let store;
-    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);
-    onBeforeMount(async () => {
-        if (!registry)
+    const stonecrop = ref();
+    onMounted(async () => {
+        if (!registry) {
+            registry = inject('$registry');
+        }
+        let store;
+        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
+        stonecrop.value = new Stonecrop(registry, store);
+        if (!registry || !registry.router)
             return;
         const route = registry.router.currentRoute.value;
         const doctypeSlug = route.params.records?.toString().toLowerCase();
@@ -47,8 +47,6 @@ export function useStonecrop(registry) {
             }
             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/dist/plugins/index.js

@@ -1,5 +1,4 @@
 import Registry from '../registry';
-import router from '../router';
 import { pinia } from '../stores';
 /**
  * Stonecrop Vue plugin
@@ -31,9 +30,13 @@ import { pinia } from '../stores';
  */
 const plugin = {
     install: (app, options) => {
-        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);
         if (options?.components) {

package/dist/registry.js

@@ -13,16 +13,16 @@ export default class Registry {
      * @defaultValue 'Registry'
      */
     name;
-    /**
-     * The Vue router instance
-     * @see {@link https://router.vuejs.org/}
-     */
-    router;
     /**
      * The registry property contains a collection of doctypes
      * @see {@link DoctypeMeta}
      */
     registry;
+    /**
+     * The Vue router instance
+     * @see {@link https://router.vuejs.org/}
+     */
+    router;
     /**
      * The getMeta function fetches doctype metadata from an API
      * @see {@link DoctypeMeta}
@@ -34,8 +34,8 @@ export default class Registry {
         }
         Registry._root = this;
         this.name = 'Registry';
-        this.router = router;
         this.registry = {};
+        this.router = router;
         this.getMeta = getMeta;
     }
     /**
@@ -48,7 +48,7 @@ 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/src/composable.d.ts

@@ -6,8 +6,7 @@ import { Stonecrop } from './stonecrop';
  * @public
  */
 export type StonecropReturn = {
-    stonecrop: Ref<Stonecrop>;
-    isReady: Ref<boolean>;
+    stonecrop: Ref<Stonecrop | undefined>;
 };
 /**
  * Stonecrop composable

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

@@ -1 +1 @@
-{"version":3,"file":"composable.d.ts","sourceRoot":"","sources":["../../src/composable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAyB,GAAG,EAAO,MAAM,KAAK,CAAA;AAErD,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,CAAC,CAAA;IACzB,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;CACrB,CAAA;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAG,eAAe,CAkDjE"}
+{"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"}

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/plugins/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAO,KAAK,MAAM,EAAE,MAAM,KAAK,CAAA;AAOtC;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,QAAA,MAAM,MAAM,EAAE,MAeb,CAAA;AAED,eAAe,MAAM,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/plugins/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAO,KAAK,MAAM,EAAE,MAAM,KAAK,CAAA;AAMtC;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,QAAA,MAAM,MAAM,EAAE,MAoBb,CAAA;AAED,eAAe,MAAM,CAAA"}

package/dist/src/registry.d.ts

@@ -15,22 +15,22 @@ export default class Registry {
      * @defaultValue '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>);
     /**
      * 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,MAAM,EAAE,MAAM,CAAA;IAEd;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;IAErC;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;gBAErD,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;IAW7F;;;;;OAKG;IACH,UAAU,CAAC,OAAO,EAAE,WAAW;CAY/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,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"}

package/dist/stonecrop.d.ts

@@ -211,22 +211,22 @@ export declare class Registry {
      * @defaultValue '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>);
     /**
      * Get doctype metadata
      * @param doctype - The doctype to fetch metadata for
@@ -467,8 +467,7 @@ declare class Stonecrop_2 {
  * @public
  */
 export declare type StonecropReturn = {
-    stonecrop: Ref<Stonecrop_2>;
-    isReady: Ref<boolean>;
+    stonecrop: Ref<Stonecrop_2 | undefined>;
 };
 
 /**