@objectstack/client-react 1.0.4 → 1.0.6

package/dist/metadata-hooks.js

@@ -1,243 +0,0 @@
-"use strict";
-/**
- * Metadata Hooks
- *
- * React hooks for accessing ObjectStack metadata (schemas, views, fields)
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useObject = useObject;
-exports.useView = useView;
-exports.useFields = useFields;
-exports.useMetadata = useMetadata;
-const react_1 = require("react");
-const context_1 = require("./context");
-/**
- * Hook for fetching object schema/metadata
- *
- * @example
- * ```tsx
- * function ObjectSchemaViewer({ objectName }: { objectName: string }) {
- *   const { data: schema, isLoading, error } = useObject(objectName);
- *
- *   if (isLoading) return <div>Loading schema...</div>;
- *   if (error) return <div>Error: {error.message}</div>;
- *
- *   return (
- *     <div>
- *       <h2>{schema.label}</h2>
- *       <p>Fields: {Object.keys(schema.fields).length}</p>
- *     </div>
- *   );
- * }
- * ```
- */
-function useObject(objectName, options = {}) {
-    const client = (0, context_1.useClient)();
-    const [data, setData] = (0, react_1.useState)(null);
-    const [isLoading, setIsLoading] = (0, react_1.useState)(true);
-    const [error, setError] = (0, react_1.useState)(null);
-    const [etag, setEtag] = (0, react_1.useState)();
-    const [fromCache, setFromCache] = (0, react_1.useState)(false);
-    const { enabled = true, useCache = true, ifNoneMatch, ifModifiedSince, onSuccess, onError } = options;
-    const fetchMetadata = (0, react_1.useCallback)(async () => {
-        if (!enabled)
-            return;
-        try {
-            setIsLoading(true);
-            setError(null);
-            setFromCache(false);
-            if (useCache) {
-                // Use cached metadata endpoint
-                const result = await client.meta.getCached(objectName, {
-                    ifNoneMatch: ifNoneMatch || etag,
-                    ifModifiedSince
-                });
-                if (result.notModified) {
-                    setFromCache(true);
-                }
-                else {
-                    setData(result.data);
-                    if (result.etag) {
-                        setEtag(result.etag.value);
-                    }
-                }
-                onSuccess?.(result.data || data);
-            }
-            else {
-                // Direct fetch without cache
-                const result = await client.meta.getObject(objectName);
-                setData(result);
-                onSuccess?.(result);
-            }
-        }
-        catch (err) {
-            const error = err instanceof Error ? err : new Error('Failed to fetch object metadata');
-            setError(error);
-            onError?.(error);
-        }
-        finally {
-            setIsLoading(false);
-        }
-    }, [client, objectName, enabled, useCache, ifNoneMatch, ifModifiedSince, etag, data, onSuccess, onError]);
-    (0, react_1.useEffect)(() => {
-        fetchMetadata();
-    }, [fetchMetadata]);
-    const refetch = (0, react_1.useCallback)(async () => {
-        await fetchMetadata();
-    }, [fetchMetadata]);
-    return {
-        data,
-        isLoading,
-        error,
-        refetch,
-        etag,
-        fromCache
-    };
-}
-/**
- * Hook for fetching view configuration
- *
- * @example
- * ```tsx
- * function ViewConfiguration({ objectName }: { objectName: string }) {
- *   const { data: view, isLoading } = useView(objectName, 'list');
- *
- *   if (isLoading) return <div>Loading view...</div>;
- *
- *   return (
- *     <div>
- *       <h3>List View for {objectName}</h3>
- *       <p>Columns: {view?.columns?.length}</p>
- *     </div>
- *   );
- * }
- * ```
- */
-function useView(objectName, viewType = 'list', options = {}) {
-    const client = (0, context_1.useClient)();
-    const [data, setData] = (0, react_1.useState)(null);
-    const [isLoading, setIsLoading] = (0, react_1.useState)(true);
-    const [error, setError] = (0, react_1.useState)(null);
-    const { enabled = true, onSuccess, onError } = options;
-    const fetchView = (0, react_1.useCallback)(async () => {
-        if (!enabled)
-            return;
-        try {
-            setIsLoading(true);
-            setError(null);
-            const result = await client.meta.getView(objectName, viewType);
-            setData(result);
-            onSuccess?.(result);
-        }
-        catch (err) {
-            const error = err instanceof Error ? err : new Error('Failed to fetch view configuration');
-            setError(error);
-            onError?.(error);
-        }
-        finally {
-            setIsLoading(false);
-        }
-    }, [client, objectName, viewType, enabled, onSuccess, onError]);
-    (0, react_1.useEffect)(() => {
-        fetchView();
-    }, [fetchView]);
-    const refetch = (0, react_1.useCallback)(async () => {
-        await fetchView();
-    }, [fetchView]);
-    return {
-        data,
-        isLoading,
-        error,
-        refetch,
-        fromCache: false
-    };
-}
-/**
- * Hook for extracting fields from object schema
- *
- * @example
- * ```tsx
- * function FieldList({ objectName }: { objectName: string }) {
- *   const { data: fields, isLoading } = useFields(objectName);
- *
- *   if (isLoading) return <div>Loading fields...</div>;
- *
- *   return (
- *     <ul>
- *       {fields?.map(field => (
- *         <li key={field.name}>{field.label} ({field.type})</li>
- *       ))}
- *     </ul>
- *   );
- * }
- * ```
- */
-function useFields(objectName, options = {}) {
-    const objectResult = useObject(objectName, options);
-    const fields = objectResult.data?.fields
-        ? Object.entries(objectResult.data.fields).map(([name, field]) => ({
-            name,
-            ...field
-        }))
-        : null;
-    return {
-        ...objectResult,
-        data: fields
-    };
-}
-/**
- * Generic metadata hook for custom metadata queries
- *
- * @example
- * ```tsx
- * function CustomMetadata() {
- *   const { data, isLoading } = useMetadata(async (client) => {
- *     // Custom metadata fetching logic
- *     const object = await client.meta.getObject('custom_object');
- *     const view = await client.meta.getView('custom_object', 'list');
- *     return { object, view };
- *   });
- *
- *   return <pre>{JSON.stringify(data, null, 2)}</pre>;
- * }
- * ```
- */
-function useMetadata(fetcher, options = {}) {
-    const client = (0, context_1.useClient)();
-    const [data, setData] = (0, react_1.useState)(null);
-    const [isLoading, setIsLoading] = (0, react_1.useState)(true);
-    const [error, setError] = (0, react_1.useState)(null);
-    const { enabled = true, onSuccess, onError } = options;
-    const fetchMetadata = (0, react_1.useCallback)(async () => {
-        if (!enabled)
-            return;
-        try {
-            setIsLoading(true);
-            setError(null);
-            const result = await fetcher(client);
-            setData(result);
-            onSuccess?.(result);
-        }
-        catch (err) {
-            const error = err instanceof Error ? err : new Error('Failed to fetch metadata');
-            setError(error);
-            onError?.(error);
-        }
-        finally {
-            setIsLoading(false);
-        }
-    }, [client, fetcher, enabled, onSuccess, onError]);
-    (0, react_1.useEffect)(() => {
-        fetchMetadata();
-    }, [fetchMetadata]);
-    const refetch = (0, react_1.useCallback)(async () => {
-        await fetchMetadata();
-    }, [fetchMetadata]);
-    return {
-        data,
-        isLoading,
-        error,
-        refetch,
-        fromCache: false
-    };
-}