@stonecrop/stonecrop 0.11.0 → 0.11.1

package/dist/src/stonecrop.js

@@ -1,339 +0,0 @@
-import { reactive } from 'vue';
-import { createHST } from './stores/hst';
-import { useOperationLogStore } from './stores/operation-log';
-/**
- * Main Stonecrop class with HST integration and built-in Operation Log
- * @public
- */
-export class Stonecrop {
-    _hstStore;
-    _operationLogStore;
-    _operationLogConfig;
-    _client;
-    /** The registry instance containing all doctype definitions */
-    registry;
-    get hstStore() {
-        if (!this._hstStore) {
-            const initialStoreStructure = {};
-            Object.keys(this.registry.registry).forEach(doctypeSlug => {
-                initialStoreStructure[doctypeSlug] = {};
-            });
-            this._hstStore = createHST(reactive(initialStoreStructure), 'StonecropStore');
-        }
-        return this._hstStore;
-    }
-    /**
-     * Creates a new Stonecrop instance with HST integration
-     * @param registry - The Registry instance containing doctype definitions
-     * @param operationLogConfig - Optional configuration for the operation log
-     * @param options - Options including the data client (can be set later via setClient)
-     */
-    constructor(registry, operationLogConfig, options) {
-        this.registry = registry;
-        // Store config for lazy initialization
-        this._operationLogConfig = operationLogConfig;
-        // Store data client (can be set later via setClient)
-        this._client = options?.client;
-        // Setup automatic sync with Registry when doctypes are added
-        this.setupRegistrySync();
-    }
-    /**
-     * Set the data client for fetching doctype metadata and records.
-     * Use this for deferred configuration in Nuxt/Vue plugin setups.
-     *
-     * @param client - DataClient implementation (e.g., StonecropClient from \@stonecrop/graphql-client)
-     *
-     * @example
-     * ```ts
-     * const { setClient } = useStonecropRegistry()
-     * const client = new StonecropClient({ endpoint: '/graphql' })
-     * setClient(client)
-     * ```
-     */
-    setClient(client) {
-        this._client = client;
-    }
-    /**
-     * Get the current data client
-     * @returns The DataClient instance or undefined if not set
-     */
-    getClient() {
-        return this._client;
-    }
-    /**
-     * Get the operation log store (lazy initialization)
-     * @internal
-     */
-    getOperationLogStore() {
-        if (!this._operationLogStore) {
-            this._operationLogStore = useOperationLogStore();
-            if (this._operationLogConfig) {
-                this._operationLogStore.configure(this._operationLogConfig);
-            }
-        }
-        return this._operationLogStore;
-    }
-    /**
-     * Setup automatic sync with Registry when doctypes are added
-     */
-    setupRegistrySync() {
-        // Extend Registry.addDoctype to auto-create HST store sections
-        const originalAddDoctype = this.registry.addDoctype.bind(this.registry);
-        this.registry.addDoctype = (doctype) => {
-            // Call original method
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-call
-            originalAddDoctype(doctype);
-            // Auto-create HST store section for new doctype
-            if (!this.hstStore.has(doctype.slug)) {
-                this.hstStore.set(doctype.slug, {});
-            }
-        };
-    }
-    /**
-     * Get records hash for a doctype
-     * @param doctype - The doctype to get records for
-     * @returns HST node containing records hash
-     */
-    records(doctype) {
-        const slug = typeof doctype === 'string' ? doctype : doctype.slug;
-        this.ensureDoctypeExists(slug);
-        return this.hstStore.getNode(slug);
-    }
-    /**
-     * Add a record to the store
-     * @param doctype - The doctype
-     * @param recordId - The record ID
-     * @param recordData - The record data
-     */
-    addRecord(doctype, recordId, recordData) {
-        const slug = typeof doctype === 'string' ? doctype : doctype.slug;
-        this.ensureDoctypeExists(slug);
-        // Store raw record data - let HST handle wrapping with proper hierarchy
-        this.hstStore.set(`${slug}.${recordId}`, recordData);
-    }
-    /**
-     * Get a specific record
-     * @param doctype - The doctype
-     * @param recordId - The record ID
-     * @returns HST node for the record or undefined
-     */
-    getRecordById(doctype, recordId) {
-        const slug = typeof doctype === 'string' ? doctype : doctype.slug;
-        this.ensureDoctypeExists(slug);
-        // First check if the record exists
-        const recordExists = this.hstStore.has(`${slug}.${recordId}`);
-        if (!recordExists) {
-            return undefined;
-        }
-        // Check if the actual value is undefined (i.e., record was removed)
-        const recordValue = this.hstStore.get(`${slug}.${recordId}`);
-        if (recordValue === undefined) {
-            return undefined;
-        }
-        // Use getNode to get the properly wrapped HST node with correct parent relationships
-        return this.hstStore.getNode(`${slug}.${recordId}`);
-    }
-    /**
-     * Remove a record from the store
-     * @param doctype - The doctype
-     * @param recordId - The record ID
-     */
-    removeRecord(doctype, recordId) {
-        const slug = typeof doctype === 'string' ? doctype : doctype.slug;
-        this.ensureDoctypeExists(slug);
-        // Remove the specific record directly by setting to undefined
-        if (this.hstStore.has(`${slug}.${recordId}`)) {
-            this.hstStore.set(`${slug}.${recordId}`, undefined);
-        }
-    }
-    /**
-     * Get all record IDs for a doctype
-     * @param doctype - The doctype
-     * @returns Array of record IDs
-     */
-    getRecordIds(doctype) {
-        const slug = typeof doctype === 'string' ? doctype : doctype.slug;
-        this.ensureDoctypeExists(slug);
-        const doctypeNode = this.hstStore.get(slug);
-        if (!doctypeNode || typeof doctypeNode !== 'object') {
-            return [];
-        }
-        return Object.keys(doctypeNode).filter(key => doctypeNode[key] !== undefined);
-    }
-    /**
-     * Clear all records for a doctype
-     * @param doctype - The doctype
-     */
-    clearRecords(doctype) {
-        const slug = typeof doctype === 'string' ? doctype : doctype.slug;
-        this.ensureDoctypeExists(slug);
-        // Get all record IDs and remove them
-        const recordIds = this.getRecordIds(slug);
-        recordIds.forEach(recordId => {
-            this.hstStore.set(`${slug}.${recordId}`, undefined);
-        });
-    }
-    /**
-     * Setup method for doctype initialization
-     * @param doctype - The doctype to setup
-     */
-    setup(doctype) {
-        // Ensure doctype exists in store
-        this.ensureDoctypeExists(doctype.slug);
-    }
-    /**
-     * Run action on doctype
-     * Executes the action and logs it to the operation log for audit tracking
-     * @param doctype - The doctype
-     * @param action - The action to run
-     * @param args - Action arguments (typically record IDs)
-     */
-    runAction(doctype, action, args) {
-        const registry = this.registry.registry[doctype.slug];
-        const actions = registry?.actions?.get(action);
-        const recordIds = Array.isArray(args) ? args.filter((arg) => typeof arg === 'string') : undefined;
-        // Log action execution start
-        const opLogStore = this.getOperationLogStore();
-        let actionResult = 'success';
-        let actionError;
-        try {
-            // Execute action functions
-            if (actions && actions.length > 0) {
-                actions.forEach(actionStr => {
-                    try {
-                        // eslint-disable-next-line @typescript-eslint/no-implied-eval
-                        const actionFn = new Function('args', actionStr);
-                        // eslint-disable-next-line @typescript-eslint/no-unsafe-call
-                        actionFn(args);
-                    }
-                    catch (error) {
-                        actionResult = 'failure';
-                        actionError = error instanceof Error ? error.message : 'Unknown error';
-                        throw error;
-                    }
-                });
-            }
-        }
-        catch {
-            // Error already set in inner catch
-        }
-        finally {
-            // Log the action execution to operation log
-            opLogStore.logAction(doctype.doctype, action, recordIds, actionResult, actionError);
-        }
-    }
-    /**
-     * Get records from server using the configured data client.
-     * @param doctype - The doctype
-     * @throws Error if no data client has been configured
-     */
-    async getRecords(doctype) {
-        if (!this._client) {
-            throw new Error('No data client configured. Call setClient() with a DataClient implementation ' +
-                '(e.g., StonecropClient from @stonecrop/graphql-client) before fetching records.');
-        }
-        const records = await this._client.getRecords(doctype);
-        // Store each record in HST
-        records.forEach(record => {
-            if (record.id) {
-                this.addRecord(doctype, record.id, record);
-            }
-        });
-    }
-    /**
-     * Get single record from server using the configured data client.
-     * @param doctype - The doctype
-     * @param recordId - The record ID
-     * @throws Error if no data client has been configured
-     */
-    async getRecord(doctype, recordId) {
-        if (!this._client) {
-            throw new Error('No data client configured. Call setClient() with a DataClient implementation ' +
-                '(e.g., StonecropClient from @stonecrop/graphql-client) before fetching records.');
-        }
-        const record = await this._client.getRecord(doctype, recordId);
-        if (record) {
-            this.addRecord(doctype, recordId, record);
-        }
-    }
-    /**
-     * Dispatch an action to the server via the configured data client.
-     * All state changes flow through this single mutation endpoint.
-     *
-     * @param doctype - The doctype
-     * @param action - Action name to execute (e.g., 'SUBMIT', 'APPROVE', 'save')
-     * @param args - Action arguments (typically record ID and/or form data)
-     * @returns Action result with success status, response data, and any error
-     * @throws Error if no data client has been configured
-     */
-    async dispatchAction(doctype, action, args) {
-        if (!this._client) {
-            throw new Error('No data client configured. Call setClient() with a DataClient implementation ' +
-                '(e.g., StonecropClient from @stonecrop/graphql-client) before dispatching actions.');
-        }
-        return this._client.runAction(doctype, action, args);
-    }
-    /**
-     * Ensure doctype section exists in HST store
-     * @param slug - The doctype slug
-     */
-    ensureDoctypeExists(slug) {
-        if (!this.hstStore.has(slug)) {
-            this.hstStore.set(slug, {});
-        }
-    }
-    /**
-     * Get doctype metadata from the registry
-     * @param context - The route context
-     * @returns The doctype metadata
-     */
-    async getMeta(context) {
-        if (!this.registry.getMeta) {
-            throw new Error('No getMeta function provided to Registry');
-        }
-        return await this.registry.getMeta(context);
-    }
-    /**
-     * Get the root HST store node for advanced usage
-     * @returns Root HST node
-     */
-    getStore() {
-        return this.hstStore;
-    }
-    /**
-     * Determine the current workflow state for a record.
-     *
-     * Reads the record's `status` field from the HST store. If the field is absent or
-     * empty the doctype's declared `workflow.initial` state is used as the fallback,
-     * giving callers a reliable state name without having to duplicate that logic.
-     *
-     * @param doctype - The doctype slug or Doctype instance
-     * @param recordId - The record identifier
-     * @returns The current state name, or an empty string if the doctype has no workflow
-     *
-     * @public
-     */
-    getRecordState(doctype, recordId) {
-        const slug = typeof doctype === 'string' ? doctype : doctype.slug;
-        const meta = this.registry.getDoctype(slug);
-        if (!meta?.workflow)
-            return '';
-        const record = this.getRecordById(slug, recordId);
-        const status = record?.get('status');
-        // Handle both XState format and WorkflowMeta format
-        const workflow = meta.workflow;
-        let initialState;
-        if (Array.isArray(workflow.states)) {
-            // WorkflowMeta format: states is a string array
-            initialState = workflow.states[0] ?? '';
-        }
-        else {
-            // XState format: states is an object, use initial or first key
-            initialState =
-                typeof workflow.initial === 'string'
-                    ? workflow.initial
-                    : Object.keys(workflow.states ?? {})[0] ?? '';
-        }
-        return status || initialState;
-    }
-}

package/dist/src/stores/data.d.ts

@@ -1,11 +0,0 @@
-export declare const useDataStore: import("pinia").StoreDefinition<"data", Pick<{
-    records: import("vue").Ref<Record<string, any>[], Record<string, any>[]>;
-    record: import("vue").Ref<Record<string, any>, Record<string, any>>;
-}, "records" | "record">, Pick<{
-    records: import("vue").Ref<Record<string, any>[], Record<string, any>[]>;
-    record: import("vue").Ref<Record<string, any>, Record<string, any>>;
-}, never>, Pick<{
-    records: import("vue").Ref<Record<string, any>[], Record<string, any>[]>;
-    record: import("vue").Ref<Record<string, any>, Record<string, any>>;
-}, never>>;
-//# sourceMappingURL=data.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"data.d.ts","sourceRoot":"","sources":["../../../src/stores/data.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,YAAY;;;;;;;;;UAIvB,CAAA"}