@stonecrop/stonecrop 0.10.6 → 0.10.7

package/README.md

@@ -84,12 +84,19 @@ export default {
     // Base mode — operation log only, no HST record loading
     const { stonecrop, operationLog } = useStonecrop()
 
-    // HST mode — pass doctype and optional recordId for full integration
+    // HST mode — pass Doctype instance and optional recordId
     const { stonecrop, formData, provideHSTPath, handleHSTChange } = useStonecrop({
       doctype: myDoctype,
       recordId: 'record-123', // omit or pass undefined for new records
     })
 
+    // HST mode with lazy-loading — pass string doctype slug
+    // Automatically loads doctype via registry.getMeta if not in registry
+    const { isLoading, error, resolvedDoctype, formData } = useStonecrop({
+      doctype: 'plan',
+      recordId: 'record-123',
+    })
+
     // Access HST store
     const store = stonecrop.value?.getStore()
 
@@ -101,6 +108,28 @@ export default {
 }
 ```
 
+### String Doctype Lazy-Loading
+
+When you pass a string doctype slug instead of a `Doctype` instance, `useStonecrop` will:
+
+1. Check if the doctype is already in the Registry
+2. If not, call `registry.getMeta` to lazy-load it
+3. Return `isLoading`, `error`, and `resolvedDoctype` refs for handling the async state
+
+```typescript
+const { isLoading, error, resolvedDoctype, formData } = useStonecrop({
+  doctype: 'plan',  // string slug - triggers lazy-loading
+  recordId: '123',
+})
+
+// In your template:
+// <div v-if="isLoading">Loading doctype...</div>
+// <div v-else-if="error">Error: {{ error.message }}</div>
+// <AForm v-else :schema="resolvedDoctype.schema" v-model:data="formData" />
+```
+
+This pattern eliminates the timing mismatch when loading doctypes asynchronously in Nuxt plugins.
+
 ## Design
 A Doctype defines schema, workflow, and actions.
   - **Schema** describes the data model and field layout — used by AForm for rendering.

package/dist/composables/stonecrop.js

@@ -17,14 +17,13 @@ export function useStonecrop(options) {
     const routerRecordId = ref();
     // Resolved schema with nested Doctype fields expanded
     const resolvedSchema = ref([]);
-    // Auto-resolve schema when doctype is available
-    if (options.doctype && registry) {
-        const schemaArray = options.doctype.schema
-            ? Array.isArray(options.doctype.schema)
-                ? options.doctype.schema
-                : Array.from(options.doctype.schema)
-            : [];
-        resolvedSchema.value = registry.resolveSchema(schemaArray);
+    // Loading state for lazy-loaded doctypes
+    const isLoading = ref(false);
+    const error = ref(null);
+    const resolvedDoctype = ref();
+    // If doctype is a Doctype instance (not string), set resolved immediately
+    if (options?.doctype && typeof options.doctype !== 'string') {
+        resolvedDoctype.value = options.doctype;
     }
     // Operation log state and methods - will be populated after stonecrop instance is created
     const operations = ref([]);
@@ -166,8 +165,56 @@ export function useStonecrop(options) {
         // Handle HST integration if doctype is provided explicitly
         if (options.doctype) {
             hstStore.value = stonecrop.value.getStore();
-            const doctype = options.doctype;
             const recordId = options.recordId;
+            // Resolve doctype - handle string (lazy-load) or Doctype instance
+            let doctype;
+            if (typeof options.doctype === 'string') {
+                // String doctype - check registry first, then lazy-load
+                const doctypeSlug = options.doctype;
+                isLoading.value = true;
+                error.value = null;
+                try {
+                    // Check if already in registry
+                    doctype = registry.getDoctype(doctypeSlug);
+                    if (!doctype && registry.getMeta) {
+                        // Lazy-load via getMeta
+                        const routeContext = {
+                            path: `/${doctypeSlug}`,
+                            segments: [doctypeSlug],
+                        };
+                        doctype = await registry.getMeta(routeContext);
+                        if (doctype) {
+                            registry.addDoctype(doctype);
+                        }
+                    }
+                    if (!doctype) {
+                        error.value = new Error(`Doctype '${doctypeSlug}' not found in registry and getMeta returned no result`);
+                    }
+                }
+                catch (e) {
+                    error.value = e instanceof Error ? e : new Error(String(e));
+                }
+                finally {
+                    isLoading.value = false;
+                }
+            }
+            else {
+                // Doctype instance provided directly
+                doctype = options.doctype;
+            }
+            // Set resolved doctype for consumers
+            resolvedDoctype.value = doctype;
+            if (!doctype) {
+                // Error already set above, just return
+                return;
+            }
+            // Resolve schema for the doctype
+            const schemaArray = doctype.schema
+                ? Array.isArray(doctype.schema)
+                    ? doctype.schema
+                    : Array.from(doctype.schema)
+                : [];
+            resolvedSchema.value = registry.resolveSchema(schemaArray);
             if (recordId && recordId !== 'new') {
                 const existingRecord = stonecrop.value.getRecordById(doctype, recordId);
                 if (existingRecord) {
@@ -196,14 +243,14 @@ export function useStonecrop(options) {
     });
     // HST integration functions - always created but only populated when HST is available
     const provideHSTPath = (fieldname, customRecordId) => {
-        const doctype = options.doctype || routerDoctype.value;
+        const doctype = resolvedDoctype.value || routerDoctype.value;
         if (!doctype)
             return '';
         const actualRecordId = customRecordId || options.recordId || routerRecordId.value || 'new';
         return `${doctype.slug}.${actualRecordId}.${fieldname}`;
     };
     const handleHSTChange = (changeData) => {
-        const doctype = options.doctype || routerDoctype.value;
+        const doctype = resolvedDoctype.value || routerDoctype.value;
         if (!hstStore.value || !stonecrop.value || !doctype) {
             return;
         }
@@ -294,7 +341,11 @@ export function useStonecrop(options) {
         // Build the save payload using resolved schema
         const payload = { ...recordData };
         // Use resolveSchema to get the full resolved tree, then walk Doctype fields
-        const schemaArray = (doctype.schema ? (Array.isArray(doctype.schema) ? doctype.schema : Array.from(doctype.schema)) : []);
+        const schemaArray = doctype.schema
+            ? Array.isArray(doctype.schema)
+                ? doctype.schema
+                : Array.from(doctype.schema)
+            : [];
         const resolved = registry ? registry.resolveSchema(schemaArray) : schemaArray;
         const doctypeFields = resolved.filter(field => 'fieldtype' in field && field.fieldtype === 'Doctype' && 'schema' in field && Array.isArray(field.schema));
         // Recursively collect nested data from HST using resolved schemas
@@ -364,6 +415,9 @@ export function useStonecrop(options) {
             loadNestedData,
             saveRecursive,
             createNestedContext,
+            isLoading,
+            error,
+            resolvedDoctype,
         };
     }
     else if (!options.doctype && registry?.router) {
@@ -379,6 +433,9 @@ export function useStonecrop(options) {
             loadNestedData,
             saveRecursive,
             createNestedContext,
+            isLoading,
+            error,
+            resolvedDoctype,
         };
     }
     // No doctype and no router - basic mode

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

@@ -59,6 +59,9 @@ export type HSTStonecropReturn = BaseStonecropReturn & {
         provideHSTPath: (fieldname: string) => string;
         handleHSTChange: (changeData: HSTChangeData) => void;
     };
+    isLoading: Ref<boolean>;
+    error: Ref<Error | null>;
+    resolvedDoctype: Ref<Doctype | undefined>;
 };
 /**
  * HST Change data structure
@@ -81,13 +84,13 @@ export declare function useStonecrop(): BaseStonecropReturn | HSTStonecropReturn
 /**
  * Unified Stonecrop composable with HST integration for a specific doctype and record
  *
- * @param options - Configuration with doctype and optional recordId
+ * @param options - Configuration with doctype (string slug or Doctype instance) and optional recordId
  * @returns Stonecrop instance with full HST integration utilities
  * @public
  */
 export declare function useStonecrop(options: {
     registry?: Registry;
-    doctype: Doctype;
+    doctype: Doctype | string;
     recordId?: string;
 }): HSTStonecropReturn;
 //# sourceMappingURL=stonecrop.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"stonecrop.d.ts","sourceRoot":"","sources":["../../../src/composables/stonecrop.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,GAAG,EAAiC,WAAW,EAAE,MAAM,KAAK,CAAA;AAExF,OAAO,QAAQ,MAAM,aAAa,CAAA;AAClC,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AACxC,OAAO,OAAO,MAAM,YAAY,CAAA;AAChC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AAG5C,OAAO,KAAK,EAAE,YAAY,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AACpG,OAAO,EAAE,WAAW,EAAiB,MAAM,kBAAkB,CAAA;AAE7D;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAC7B,UAAU,EAAE,GAAG,CAAC,YAAY,EAAE,CAAC,CAAA;IAC/B,YAAY,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IACzB,aAAa,EAAE,WAAW,CAAC;QAC1B,OAAO,EAAE,OAAO,CAAA;QAChB,OAAO,EAAE,OAAO,CAAA;QAChB,SAAS,EAAE,MAAM,CAAA;QACjB,SAAS,EAAE,MAAM,CAAA;QACjB,YAAY,EAAE,MAAM,CAAA;KACpB,CAAC,CAAA;IACF,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC,CAAA;IAC7B,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC,CAAA;IAC7B,SAAS,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAC9B,SAAS,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAC9B,IAAI,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,OAAO,CAAA;IACpC,IAAI,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,OAAO,CAAA;IACpC,UAAU,EAAE,MAAM,IAAI,CAAA;IACtB,WAAW,EAAE,CAAC,WAAW,CAAC,EAAE,MAAM,KAAK,MAAM,GAAG,IAAI,CAAA;IACpD,WAAW,EAAE,MAAM,IAAI,CAAA;IACvB,KAAK,EAAE,MAAM,IAAI,CAAA;IACjB,gBAAgB,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,EAAE,CAAA;IACxE,WAAW,EAAE,MAAM,oBAAoB,CAAA;IACvC,gBAAgB,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,CAAA;IAC/D,SAAS,EAAE,CACV,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,SAAS,CAAC,EAAE,MAAM,EAAE,EACpB,MAAM,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,EAC1C,KAAK,CAAC,EAAE,MAAM,KACV,MAAM,CAAA;IACX,SAAS,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,kBAAkB,CAAC,KAAK,IAAI,CAAA;CACzD,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG;IACjC,SAAS,EAAE,GAAG,CAAC,SAAS,GAAG,SAAS,CAAC,CAAA;IACrC,YAAY,EAAE,eAAe,CAAA;CAC7B,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,mBAAmB,GAAG;IACtD,cAAc,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,MAAM,CAAA;IAChE,eAAe,EAAE,CAAC,UAAU,EAAE,aAAa,KAAK,IAAI,CAAA;IACpD,QAAQ,EAAE,GAAG,CAAC,OAAO,GAAG,SAAS,CAAC,CAAA;IAClC,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAA;IAClC,cAAc,EAAE,GAAG,CAAC,WAAW,EAAE,CAAC,CAAA;IAClC,cAAc,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IACrG,aAAa,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAA;IACnF,mBAAmB,EAAE,CACpB,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,OAAO,KACjB;QACJ,cAAc,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,MAAM,CAAA;QAC7C,eAAe,EAAE,CAAC,UAAU,EAAE,aAAa,KAAK,IAAI,CAAA;KACpD,CAAA;CACD,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,GAAG,CAAA;IACV,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,IAAI,mBAAmB,GAAG,kBAAkB,CAAA;AACxE;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE;IAAE,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAAC,OAAO,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,kBAAkB,CAAA"}
+{"version":3,"file":"stonecrop.d.ts","sourceRoot":"","sources":["../../../src/composables/stonecrop.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,GAAG,EAAiC,WAAW,EAAE,MAAM,KAAK,CAAA;AAExF,OAAO,QAAQ,MAAM,aAAa,CAAA;AAClC,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AACxC,OAAO,OAAO,MAAM,YAAY,CAAA;AAChC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AAG5C,OAAO,KAAK,EAAE,YAAY,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AACpG,OAAO,EAAE,WAAW,EAAiB,MAAM,kBAAkB,CAAA;AAE7D;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAC7B,UAAU,EAAE,GAAG,CAAC,YAAY,EAAE,CAAC,CAAA;IAC/B,YAAY,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IACzB,aAAa,EAAE,WAAW,CAAC;QAC1B,OAAO,EAAE,OAAO,CAAA;QAChB,OAAO,EAAE,OAAO,CAAA;QAChB,SAAS,EAAE,MAAM,CAAA;QACjB,SAAS,EAAE,MAAM,CAAA;QACjB,YAAY,EAAE,MAAM,CAAA;KACpB,CAAC,CAAA;IACF,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC,CAAA;IAC7B,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC,CAAA;IAC7B,SAAS,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAC9B,SAAS,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAC9B,IAAI,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,OAAO,CAAA;IACpC,IAAI,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,OAAO,CAAA;IACpC,UAAU,EAAE,MAAM,IAAI,CAAA;IACtB,WAAW,EAAE,CAAC,WAAW,CAAC,EAAE,MAAM,KAAK,MAAM,GAAG,IAAI,CAAA;IACpD,WAAW,EAAE,MAAM,IAAI,CAAA;IACvB,KAAK,EAAE,MAAM,IAAI,CAAA;IACjB,gBAAgB,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,EAAE,CAAA;IACxE,WAAW,EAAE,MAAM,oBAAoB,CAAA;IACvC,gBAAgB,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,CAAA;IAC/D,SAAS,EAAE,CACV,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,SAAS,CAAC,EAAE,MAAM,EAAE,EACpB,MAAM,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,EAC1C,KAAK,CAAC,EAAE,MAAM,KACV,MAAM,CAAA;IACX,SAAS,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,kBAAkB,CAAC,KAAK,IAAI,CAAA;CACzD,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG;IACjC,SAAS,EAAE,GAAG,CAAC,SAAS,GAAG,SAAS,CAAC,CAAA;IACrC,YAAY,EAAE,eAAe,CAAA;CAC7B,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,mBAAmB,GAAG;IACtD,cAAc,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,MAAM,CAAA;IAChE,eAAe,EAAE,CAAC,UAAU,EAAE,aAAa,KAAK,IAAI,CAAA;IACpD,QAAQ,EAAE,GAAG,CAAC,OAAO,GAAG,SAAS,CAAC,CAAA;IAClC,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAA;IAClC,cAAc,EAAE,GAAG,CAAC,WAAW,EAAE,CAAC,CAAA;IAClC,cAAc,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IACrG,aAAa,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAA;IACnF,mBAAmB,EAAE,CACpB,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,OAAO,KACjB;QACJ,cAAc,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,MAAM,CAAA;QAC7C,eAAe,EAAE,CAAC,UAAU,EAAE,aAAa,KAAK,IAAI,CAAA;KACpD,CAAA;IACD,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;IACvB,KAAK,EAAE,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,CAAA;IACxB,eAAe,EAAE,GAAG,CAAC,OAAO,GAAG,SAAS,CAAC,CAAA;CACzC,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,GAAG,CAAA;IACV,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,IAAI,mBAAmB,GAAG,kBAAkB,CAAA;AACxE;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE;IACrC,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,OAAO,EAAE,OAAO,GAAG,MAAM,CAAA;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAA;CACjB,GAAG,kBAAkB,CAAA"}

package/dist/stonecrop.d.ts

@@ -722,6 +722,9 @@ export declare type HSTStonecropReturn = BaseStonecropReturn & {
         provideHSTPath: (fieldname: string) => string;
         handleHSTChange: (changeData: HSTChangeData) => void;
     };
+    isLoading: Ref<boolean>;
+    error: Ref<Error | null>;
+    resolvedDoctype: Ref<Doctype | undefined>;
 };
 
 /**
@@ -1991,13 +1994,13 @@ export declare function useStonecrop(): BaseStonecropReturn | HSTStonecropReturn
 /**
  * Unified Stonecrop composable with HST integration for a specific doctype and record
  *
- * @param options - Configuration with doctype and optional recordId
+ * @param options - Configuration with doctype (string slug or Doctype instance) and optional recordId
  * @returns Stonecrop instance with full HST integration utilities
  * @public
  */
 export declare function useStonecrop(options: {
     registry?: Registry;
-    doctype: Doctype;
+    doctype: Doctype | string;
     recordId?: string;
 }): HSTStonecropReturn;