@stonecrop/stonecrop 0.12.7 → 0.13.0

package/dist/composables/stonecrop.js

@@ -0,0 +1,504 @@
+import { storeToRefs } from 'pinia';
+import { inject, onMounted, ref, watch, provide, computed } from 'vue';
+import { Stonecrop } from '../stonecrop';
+/**
+ * @public
+ */
+export function useStonecrop(options) {
+    if (!options)
+        options = {};
+    const registry = options.registry || inject('$registry');
+    const providedStonecrop = inject('$stonecrop');
+    const stonecrop = ref();
+    const hstStore = ref();
+    const formData = ref({});
+    // Use refs for router-loaded doctype to maintain reactivity
+    const routerDoctype = ref();
+    const routerRecordId = ref();
+    // Resolved schema with nested Doctype fields expanded
+    const resolvedSchema = ref([]);
+    // Loading state for lazy-loaded doctypes
+    const isLoading = ref(false);
+    const error = ref(null);
+    const resolvedDoctype = ref();
+    // Workflow readiness computed properties
+    const isWorkflowReady = computed(() => {
+        if (!stonecrop.value || !resolvedDoctype.value || !options.recordId || options.recordId === 'new') {
+            return true;
+        }
+        const status = stonecrop.value.isWorkflowReady(resolvedDoctype.value, options.recordId);
+        return status.ready;
+    });
+    const blockedLinks = computed(() => {
+        if (!stonecrop.value || !resolvedDoctype.value || !options.recordId || options.recordId === 'new') {
+            return [];
+        }
+        const status = stonecrop.value.isWorkflowReady(resolvedDoctype.value, options.recordId);
+        return status.blockedLinks ?? [];
+    });
+    // Initialize stonecrop instance synchronously using singleton pattern
+    // Use injected instance if available, otherwise fall back to the singleton root
+    const stonecropInstance = providedStonecrop || Stonecrop._root;
+    if (stonecropInstance) {
+        stonecrop.value = stonecropInstance;
+    }
+    // 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
+    const operations = ref([]);
+    const currentIndex = ref(-1);
+    const canUndo = computed(() => stonecrop.value?.getOperationLogStore().canUndo ?? false);
+    const canRedo = computed(() => stonecrop.value?.getOperationLogStore().canRedo ?? false);
+    const undoCount = computed(() => stonecrop.value?.getOperationLogStore().undoCount ?? 0);
+    const redoCount = computed(() => stonecrop.value?.getOperationLogStore().redoCount ?? 0);
+    const undoRedoState = computed(() => stonecrop.value?.getOperationLogStore().undoRedoState ?? {
+        canUndo: false,
+        canRedo: false,
+        undoCount: 0,
+        redoCount: 0,
+        currentIndex: -1,
+    });
+    // Operation log methods
+    const undo = (hstStore) => {
+        return stonecrop.value?.getOperationLogStore().undo(hstStore) ?? false;
+    };
+    const redo = (hstStore) => {
+        return stonecrop.value?.getOperationLogStore().redo(hstStore) ?? false;
+    };
+    const startBatch = () => {
+        stonecrop.value?.getOperationLogStore().startBatch();
+    };
+    const commitBatch = (description) => {
+        return stonecrop.value?.getOperationLogStore().commitBatch(description) ?? null;
+    };
+    const cancelBatch = () => {
+        stonecrop.value?.getOperationLogStore().cancelBatch();
+    };
+    const clear = () => {
+        stonecrop.value?.getOperationLogStore().clear();
+    };
+    const getOperationsFor = (doctype, recordId) => {
+        return stonecrop.value?.getOperationLogStore().getOperationsFor(doctype, recordId) ?? [];
+    };
+    const getSnapshot = () => {
+        return (stonecrop.value?.getOperationLogStore().getSnapshot() ?? {
+            operations: [],
+            currentIndex: -1,
+            totalOperations: 0,
+            reversibleOperations: 0,
+            irreversibleOperations: 0,
+        });
+    };
+    const markIrreversible = (operationId, reason) => {
+        stonecrop.value?.getOperationLogStore().markIrreversible(operationId, reason);
+    };
+    const logAction = (doctype, actionName, recordIds, result = 'success', error) => {
+        return stonecrop.value?.getOperationLogStore().logAction(doctype, actionName, recordIds, result, error) ?? '';
+    };
+    const configure = (config) => {
+        stonecrop.value?.getOperationLogStore().configure(config);
+    };
+    // Wire operation log reactive state synchronously — no lifecycle hook needed.
+    // storeToRefs and watch are both safe to call in setup() body.
+    if (registry && stonecrop.value) {
+        try {
+            const opLogStore = stonecrop.value.getOperationLogStore();
+            const opLogRefs = storeToRefs(opLogStore);
+            operations.value = opLogRefs.operations.value;
+            currentIndex.value = opLogRefs.currentIndex.value;
+            // Watch for changes in operation log state
+            watch(() => opLogRefs.operations.value, newOps => {
+                operations.value = newOps;
+            });
+            watch(() => opLogRefs.currentIndex.value, newIndex => {
+                currentIndex.value = newIndex;
+            });
+        }
+        catch {
+            // Pinia not available — operation log is optional, silently skip
+        }
+    }
+    // Synchronous HST initialisation for an explicit Doctype instance.
+    // When the caller passes a Doctype object (not a slug string), every piece of
+    // setup that doesn't require network I/O runs here during setup() so that
+    // hstStore, resolvedSchema, and formData are populated before the first render
+    // and are immediately available to callers without any await.
+    if (options.doctype && typeof options.doctype !== 'string' && registry && stonecrop.value) {
+        hstStore.value = stonecrop.value.getStore();
+        resolvedSchema.value = registry.resolveSchema(options.doctype);
+        if (!options.recordId || options.recordId === 'new') {
+            formData.value = registry.initializeRecord(resolvedSchema.value);
+        }
+        if (hstStore.value) {
+            setupDeepReactivity(options.doctype, options.recordId || 'new', formData, hstStore.value);
+        }
+    }
+    // onMounted handles only work that is genuinely async: lazy-loading a doctype
+    // by slug, fetching an existing record from the server, and router-based setup.
+    onMounted(async () => {
+        if (!registry || !stonecrop.value) {
+            return;
+        }
+        // Handle router-based setup if no specific doctype provided
+        if (!options.doctype && registry.router) {
+            const route = registry.router.currentRoute.value;
+            // Parse route path - let the application determine the doctype from the route
+            if (!route.path)
+                return; // Early return if no path available
+            const pathSegments = route.path.split('/').filter(segment => segment.length > 0);
+            const recordId = pathSegments[1]?.toLowerCase();
+            if (pathSegments.length > 0) {
+                // Create route context for getMeta function
+                const routeContext = {
+                    path: route.path,
+                    segments: pathSegments,
+                };
+                const doctype = await registry.getMeta?.(routeContext);
+                if (doctype) {
+                    registry.addDoctype(doctype);
+                    stonecrop.value.setup(doctype);
+                    // Set reactive refs for router-based doctype
+                    routerDoctype.value = doctype;
+                    routerRecordId.value = recordId;
+                    hstStore.value = stonecrop.value.getStore();
+                    // Resolve schema for router-loaded doctype
+                    if (registry) {
+                        resolvedSchema.value = registry.resolveSchema(doctype);
+                    }
+                    if (recordId && recordId !== 'new') {
+                        const existingRecord = stonecrop.value.getRecordById(doctype, recordId);
+                        if (existingRecord) {
+                            formData.value = existingRecord.get('') || {};
+                        }
+                        else {
+                            try {
+                                await stonecrop.value.getRecord(doctype, recordId);
+                                const loadedRecord = stonecrop.value.getRecordById(doctype, recordId);
+                                if (loadedRecord) {
+                                    formData.value = loadedRecord.get('') || {};
+                                }
+                            }
+                            catch {
+                                formData.value = registry.initializeRecord(resolvedSchema.value);
+                            }
+                        }
+                    }
+                    else {
+                        formData.value = registry.initializeRecord(resolvedSchema.value);
+                    }
+                    if (hstStore.value) {
+                        setupDeepReactivity(doctype, recordId || 'new', formData, hstStore.value);
+                    }
+                    stonecrop.value.runAction(doctype, 'load', recordId ? [recordId] : undefined);
+                }
+            }
+        }
+        // Handle HST integration if doctype is provided explicitly
+        if (options.doctype) {
+            const recordId = options.recordId;
+            if (typeof options.doctype === 'string') {
+                // String doctype — resolve lazily, then do full sync-equivalent setup here.
+                const doctypeSlug = options.doctype;
+                hstStore.value = stonecrop.value.getStore();
+                isLoading.value = true;
+                error.value = null;
+                let doctype;
+                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;
+                }
+                resolvedDoctype.value = doctype;
+                if (!doctype)
+                    return;
+                resolvedSchema.value = registry.resolveSchema(doctype);
+                if (recordId && recordId !== 'new') {
+                    const existingRecord = stonecrop.value.getRecordById(doctype, recordId);
+                    if (existingRecord) {
+                        formData.value = existingRecord.get('') || {};
+                    }
+                    else {
+                        try {
+                            await stonecrop.value.getRecord(doctype, recordId);
+                            const loadedRecord = stonecrop.value.getRecordById(doctype, recordId);
+                            if (loadedRecord) {
+                                formData.value = loadedRecord.get('') || {};
+                            }
+                        }
+                        catch {
+                            formData.value = registry.initializeRecord(resolvedSchema.value);
+                        }
+                    }
+                }
+                else {
+                    formData.value = registry.initializeRecord(resolvedSchema.value);
+                }
+                if (hstStore.value) {
+                    setupDeepReactivity(doctype, recordId || 'new', formData, hstStore.value);
+                }
+            }
+            else {
+                // Doctype instance — sync init was done during setup().
+                // Only handle the async path: fetching an existing record from the server.
+                if (recordId && recordId !== 'new') {
+                    const doctype = options.doctype;
+                    const existingRecord = stonecrop.value.getRecordById(doctype, recordId);
+                    if (existingRecord) {
+                        formData.value = existingRecord.get('') || {};
+                    }
+                    else {
+                        try {
+                            await stonecrop.value.getRecord(doctype, recordId);
+                            const loadedRecord = stonecrop.value.getRecordById(doctype, recordId);
+                            if (loadedRecord) {
+                                formData.value = loadedRecord.get('') || {};
+                            }
+                        }
+                        catch {
+                            formData.value = registry.initializeRecord(resolvedSchema.value);
+                        }
+                    }
+                }
+            }
+        }
+    });
+    // HST integration functions - always created but only populated when HST is available
+    const provideHSTPath = (fieldname, customRecordId) => {
+        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 = resolvedDoctype.value || routerDoctype.value;
+        if (!hstStore.value || !stonecrop.value || !doctype) {
+            return;
+        }
+        try {
+            const pathParts = changeData.path.split('.');
+            if (pathParts.length >= 2) {
+                const doctypeSlug = pathParts[0];
+                const recordId = pathParts[1];
+                if (!hstStore.value.has(`${doctypeSlug}.${recordId}`)) {
+                    stonecrop.value.addRecord(doctype, recordId, { ...formData.value });
+                }
+                if (pathParts.length > 3) {
+                    const recordPath = `${doctypeSlug}.${recordId}`;
+                    const nestedParts = pathParts.slice(2);
+                    let currentPath = recordPath;
+                    for (let i = 0; i < nestedParts.length - 1; i++) {
+                        currentPath += `.${nestedParts[i]}`;
+                        if (!hstStore.value.has(currentPath)) {
+                            const nextPart = nestedParts[i + 1];
+                            const isArray = !isNaN(Number(nextPart));
+                            hstStore.value.set(currentPath, isArray ? [] : {});
+                        }
+                    }
+                }
+            }
+            hstStore.value.set(changeData.path, changeData.value);
+            const fieldParts = changeData.fieldname.split('.');
+            const newFormData = { ...formData.value };
+            if (fieldParts.length === 1) {
+                newFormData[fieldParts[0]] = changeData.value;
+            }
+            else {
+                updateNestedObject(newFormData, fieldParts, changeData.value);
+            }
+            formData.value = newFormData;
+        }
+        catch {
+            // Silently handle errors
+        }
+    };
+    // Provide injection tokens if HST will be available
+    if (options.doctype || registry?.router) {
+        provide('hstPathProvider', provideHSTPath);
+        provide('hstChangeHandler', handleHSTChange);
+    }
+    /**
+     * Scaffold empty descendant records from defaults for all descendant links.
+     * Delegates to Stonecrop.initializeNestedData method.
+     * @param path - The HST path where initialized data should be stored
+     * @param doctype - The doctype to initialize
+     */
+    const initializeNestedData = (path, doctype) => {
+        if (!stonecrop.value) {
+            throw new Error('Stonecrop instance not available');
+        }
+        return stonecrop.value.initializeNestedData(path, doctype);
+    };
+    /**
+     * Fetch a record and its nested data from the server.
+     * Delegates to Stonecrop.fetchNestedData method.
+     * @param path - The HST path (e.g., "recipe.r1")
+     * @param doctype - The doctype to fetch
+     * @param recordId - Record ID to fetch
+     * @param options - Query options (includeNested to control which links are fetched)
+     */
+    const fetchNestedData = async (path, doctype, recordId, options) => {
+        if (!stonecrop.value) {
+            throw new Error('Stonecrop instance not available');
+        }
+        return stonecrop.value.fetchNestedData(path, doctype, recordId, options);
+    };
+    /**
+     * Collect a record payload with all nested doctype fields from HST
+     * Delegates to Stonecrop.collectRecordPayload method
+     * @param doctype - The doctype metadata
+     * @param recordId - The record ID to collect
+     * @returns The complete record payload ready for API submission
+     */
+    const collectRecordPayload = (doctype, recordId) => {
+        if (!stonecrop.value) {
+            throw new Error('Stonecrop instance not available');
+        }
+        return stonecrop.value.collectRecordPayload(doctype, recordId);
+    };
+    /**
+     * Create a nested context for descendant forms
+     * @param basePath - The base path for the nested context (e.g., "customer.123.address")
+     * @param _descendantDoctype - The descendant doctype metadata (unused but kept for API consistency)
+     * @returns Object with scoped provideHSTPath and handleHSTChange
+     */
+    const createNestedContext = (basePath, _descendantDoctype) => {
+        const nestedProvideHSTPath = (fieldname) => {
+            return `${basePath}.${fieldname}`;
+        };
+        const nestedHandleHSTChange = (changeData) => {
+            // Update the path to be relative to the nested base path
+            const nestedPath = changeData.path.startsWith(basePath) ? changeData.path : `${basePath}.${changeData.fieldname}`;
+            handleHSTChange({
+                ...changeData,
+                path: nestedPath,
+            });
+        };
+        return {
+            provideHSTPath: nestedProvideHSTPath,
+            handleHSTChange: nestedHandleHSTChange,
+        };
+    };
+    // Create operation log API object
+    const operationLog = {
+        operations,
+        currentIndex,
+        undoRedoState,
+        canUndo,
+        canRedo,
+        undoCount,
+        redoCount,
+        undo,
+        redo,
+        startBatch,
+        commitBatch,
+        cancelBatch,
+        clear,
+        getOperationsFor,
+        getSnapshot,
+        markIrreversible,
+        logAction,
+        configure,
+    };
+    // Always return HST functions if doctype is provided or will be loaded from router
+    if (options.doctype) {
+        // Explicit doctype - return HST immediately
+        return {
+            stonecrop,
+            operationLog,
+            provideHSTPath,
+            handleHSTChange,
+            hstStore,
+            formData,
+            resolvedSchema,
+            initializeNestedData,
+            fetchNestedData,
+            collectRecordPayload,
+            createNestedContext,
+            isLoading,
+            error,
+            resolvedDoctype,
+            isWorkflowReady,
+            blockedLinks,
+        };
+    }
+    else if (!options.doctype && registry?.router) {
+        // Router-based - return HST (will be populated after mount)
+        return {
+            stonecrop,
+            operationLog,
+            provideHSTPath,
+            handleHSTChange,
+            hstStore,
+            formData,
+            resolvedSchema,
+            initializeNestedData,
+            fetchNestedData,
+            collectRecordPayload,
+            createNestedContext,
+            isLoading,
+            error,
+            resolvedDoctype,
+            isWorkflowReady,
+            blockedLinks,
+        };
+    }
+    // No doctype and no router - basic mode
+    return {
+        stonecrop,
+        operationLog,
+    };
+}
+/**
+ * Setup deep reactivity between form data and HST store
+ */
+function setupDeepReactivity(doctype, recordId, formData, hstStore) {
+    watch(formData, newData => {
+        const recordPath = `${doctype.slug}.${recordId}`;
+        Object.keys(newData).forEach(fieldname => {
+            const path = `${recordPath}.${fieldname}`;
+            try {
+                hstStore.set(path, newData[fieldname]);
+            }
+            catch {
+                // Silently handle errors
+            }
+        });
+    }, { deep: true });
+}
+/**
+ * Update nested object with dot-notation path
+ */
+function updateNestedObject(obj, path, value) {
+    let current = obj;
+    for (let i = 0; i < path.length - 1; i++) {
+        const key = path[i];
+        if (!(key in current) || typeof current[key] !== 'object') {
+            current[key] = isNaN(Number(path[i + 1])) ? {} : [];
+        }
+        current = current[key];
+    }
+    const finalKey = path[path.length - 1];
+    current[finalKey] = value;
+}

package/dist/composables/use-lazy-link-state.js

@@ -0,0 +1,125 @@
+import { computed, inject, ref } from 'vue';
+import { Stonecrop } from '../stonecrop';
+/**
+ * Get the lazy link state for a specific link field on a doctype record.
+ *
+ * This composable provides reactive state for lazy-loaded links:
+ * - `loading`: true while fetching
+ * - `loaded`: true after successful fetch (permanent until reload)
+ * - `error`: error state if any
+ * - `reload()`: explicitly trigger a fetch
+ * - `data`: computed from HST, or undefined if not loaded
+ *
+ * The reload() function respects the link's fetch strategy:
+ * - `sync`: fetches via GraphQL query through fetchNestedData
+ * - `lazy`: fetches via GraphQL query through fetchNestedData
+ * - `custom`: invokes the serialized handler function directly
+ *
+ * @param doctype - The doctype instance
+ * @param recordId - The record ID
+ * @param linkFieldname - The link fieldname to load
+ * @returns LazyLinkState with loading, loaded, error, reload, and data
+ * @public
+ */
+export function useLazyLinkState(doctype, recordId, linkFieldname) {
+    const stonecropInstance = inject('$stonecrop') || Stonecrop._root;
+    if (!stonecropInstance) {
+        throw new Error('Stonecrop instance not available. Ensure useStonecrop() has been called first.');
+    }
+    const loading = ref(false);
+    const loaded = ref(false);
+    const error = ref(null);
+    const hstStore = stonecropInstance.getStore();
+    /**
+     * Build the HST path for a lazy link field
+     */
+    const getLinkPath = () => {
+        const slug = doctype.slug || doctype.doctype;
+        return `${slug}.${recordId}.${linkFieldname}`;
+    };
+    /**
+     * Get the link declaration from the doctype schema
+     */
+    const getLinkDeclaration = () => {
+        return doctype.links?.[linkFieldname]?.fetch;
+    };
+    /**
+     * Invoke a custom fetch handler
+     * The handler is a serialized function string that we execute via new Function()
+     */
+    const invokeCustomHandler = async (handler) => {
+        try {
+            // Create function from serialized string and invoke it
+            // The function receives the stonecrop instance and path as parameters
+            // eslint-disable-next-line @typescript-eslint/no-implied-eval
+            const fn = new Function('stonecrop', 'path', 'hst', `
+				return (${handler})(stonecrop, path, hst)
+			`);
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-call
+            return await fn(stonecropInstance, getLinkPath(), hstStore);
+        }
+        catch (err) {
+            throw new Error(`Custom handler failed: ${err instanceof Error ? err.message : String(err)}`);
+        }
+    };
+    /**
+     * Fetch the link data using the appropriate strategy
+     */
+    const fetchLinkData = async () => {
+        const linkFetch = getLinkDeclaration();
+        const ancestorPath = `${doctype.slug || doctype.doctype}.${recordId}`;
+        if (linkFetch?.method === 'custom') {
+            // Ensure ancestor path exists before invoking custom handler
+            if (!hstStore.has(ancestorPath)) {
+                hstStore.set(ancestorPath, {}, 'system');
+            }
+            // Custom handler - invoke directly
+            const result = await invokeCustomHandler(linkFetch.handler);
+            // Store result in HST at the link path
+            hstStore.set(getLinkPath(), result, 'system');
+        }
+        else {
+            // sync or lazy (both use fetchNestedData but with different includeNested)
+            // For lazy links, we still use fetchNestedData but only for this specific link
+            await stonecropInstance.fetchNestedData(ancestorPath, doctype, recordId, { includeNested: [linkFieldname] });
+        }
+    };
+    /**
+     * Explicitly reload the lazy link data
+     */
+    const reload = async () => {
+        if (loading.value)
+            return;
+        loading.value = true;
+        error.value = null;
+        try {
+            await fetchLinkData();
+            loaded.value = true;
+        }
+        catch (err) {
+            error.value = err instanceof Error ? err : new Error(String(err));
+            throw err;
+        }
+        finally {
+            loading.value = false;
+        }
+    };
+    /**
+     * Computed property that returns the loaded data from HST
+     */
+    const data = computed(() => {
+        if (!loaded.value)
+            return undefined;
+        return hstStore.get(getLinkPath());
+    });
+    return {
+        // State
+        loading,
+        loaded,
+        error,
+        // Computed
+        data,
+        // Actions
+        reload,
+    };
+}