@objectstack/client-react 1.0.2 → 1.0.5

package/dist/data-hooks.js

@@ -1,398 +0,0 @@
-"use strict";
-/**
- * Data Query Hooks
- *
- * React hooks for querying and mutating ObjectStack data
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useQuery = useQuery;
-exports.useMutation = useMutation;
-exports.usePagination = usePagination;
-exports.useInfiniteQuery = useInfiniteQuery;
-const react_1 = require("react");
-const context_1 = require("./context");
-/**
- * Hook for querying ObjectStack data with automatic caching and refetching
- *
- * @example
- * ```tsx
- * function TaskList() {
- *   const { data, isLoading, error, refetch } = useQuery('todo_task', {
- *     select: ['id', 'subject', 'priority'],
- *     sort: ['-created_at'],
- *     top: 20
- *   });
- *
- *   if (isLoading) return <div>Loading...</div>;
- *   if (error) return <div>Error: {error.message}</div>;
- *
- *   return (
- *     <div>
- *       {data?.value.map(task => (
- *         <div key={task.id}>{task.subject}</div>
- *       ))}
- *     </div>
- *   );
- * }
- * ```
- */
-function useQuery(object, options = {}) {
-    const client = (0, context_1.useClient)();
-    const [data, setData] = (0, react_1.useState)(null);
-    const [isLoading, setIsLoading] = (0, react_1.useState)(true);
-    const [isRefetching, setIsRefetching] = (0, react_1.useState)(false);
-    const [error, setError] = (0, react_1.useState)(null);
-    const intervalRef = (0, react_1.useRef)();
-    const { query, select, filters, sort, top, skip, enabled = true, refetchInterval, onSuccess, onError } = options;
-    const fetchData = (0, react_1.useCallback)(async (isRefetch = false) => {
-        if (!enabled)
-            return;
-        try {
-            if (isRefetch) {
-                setIsRefetching(true);
-            }
-            else {
-                setIsLoading(true);
-            }
-            setError(null);
-            let result;
-            if (query) {
-                // Use advanced query API
-                result = await client.data.query(object, query);
-            }
-            else {
-                // Use simplified find API
-                result = await client.data.find(object, {
-                    select,
-                    filters: filters,
-                    sort,
-                    top,
-                    skip
-                });
-            }
-            setData(result);
-            onSuccess?.(result);
-        }
-        catch (err) {
-            const error = err instanceof Error ? err : new Error('Query failed');
-            setError(error);
-            onError?.(error);
-        }
-        finally {
-            setIsLoading(false);
-            setIsRefetching(false);
-        }
-    }, [client, object, query, select, filters, sort, top, skip, enabled, onSuccess, onError]);
-    // Initial fetch and dependency-based refetch
-    (0, react_1.useEffect)(() => {
-        fetchData();
-    }, [fetchData]);
-    // Setup refetch interval
-    (0, react_1.useEffect)(() => {
-        if (refetchInterval && enabled) {
-            intervalRef.current = setInterval(() => {
-                fetchData(true);
-            }, refetchInterval);
-            return () => {
-                if (intervalRef.current) {
-                    clearInterval(intervalRef.current);
-                }
-            };
-        }
-        return undefined;
-    }, [refetchInterval, enabled, fetchData]);
-    const refetch = (0, react_1.useCallback)(async () => {
-        await fetchData(true);
-    }, [fetchData]);
-    return {
-        data,
-        isLoading,
-        error,
-        refetch,
-        isRefetching
-    };
-}
-/**
- * Hook for creating, updating, or deleting ObjectStack data
- *
- * @example
- * ```tsx
- * function CreateTaskForm() {
- *   const { mutate, isLoading, error } = useMutation('todo_task', 'create', {
- *     onSuccess: (data) => {
- *       console.log('Task created:', data);
- *     }
- *   });
- *
- *   const handleSubmit = (formData) => {
- *     mutate(formData);
- *   };
- *
- *   return <form onSubmit={handleSubmit}>...</form>;
- * }
- * ```
- */
-function useMutation(object, operation, options = {}) {
-    const client = (0, context_1.useClient)();
-    const [data, setData] = (0, react_1.useState)(null);
-    const [isLoading, setIsLoading] = (0, react_1.useState)(false);
-    const [error, setError] = (0, react_1.useState)(null);
-    const { onSuccess, onError, onSettled } = options;
-    const mutateAsync = (0, react_1.useCallback)(async (variables) => {
-        setIsLoading(true);
-        setError(null);
-        try {
-            let result;
-            switch (operation) {
-                case 'create':
-                    result = await client.data.create(object, variables);
-                    break;
-                case 'update':
-                    // Expect variables to be { id: string, data: Partial<T> }
-                    const updateVars = variables;
-                    result = await client.data.update(object, updateVars.id, updateVars.data);
-                    break;
-                case 'delete':
-                    // Expect variables to be { id: string }
-                    const deleteVars = variables;
-                    result = await client.data.delete(object, deleteVars.id);
-                    break;
-                case 'createMany':
-                    // createMany returns an array, which may not match TData type
-                    result = await client.data.createMany(object, variables);
-                    break;
-                case 'updateMany':
-                    // Expect variables to be { records: Array<{ id: string, data: Partial<T> }> }
-                    const updateManyVars = variables;
-                    result = await client.data.updateMany(object, updateManyVars.records, updateManyVars.options);
-                    break;
-                case 'deleteMany':
-                    // Expect variables to be { ids: string[] }
-                    const deleteManyVars = variables;
-                    result = await client.data.deleteMany(object, deleteManyVars.ids, deleteManyVars.options);
-                    break;
-                default:
-                    throw new Error(`Unknown operation: ${operation}`);
-            }
-            setData(result);
-            onSuccess?.(result, variables);
-            onSettled?.(result, null, variables);
-            return result;
-        }
-        catch (err) {
-            const error = err instanceof Error ? err : new Error('Mutation failed');
-            setError(error);
-            onError?.(error, variables);
-            onSettled?.(undefined, error, variables);
-            throw error;
-        }
-        finally {
-            setIsLoading(false);
-        }
-    }, [client, object, operation, onSuccess, onError, onSettled]);
-    const mutate = (0, react_1.useCallback)((variables) => {
-        return mutateAsync(variables).catch(() => {
-            // Swallow error for non-async version
-            // Error is still available in the error state
-            return null;
-        });
-    }, [mutateAsync]);
-    const reset = (0, react_1.useCallback)(() => {
-        setData(null);
-        setError(null);
-        setIsLoading(false);
-    }, []);
-    return {
-        mutate,
-        mutateAsync,
-        data,
-        isLoading,
-        error,
-        reset
-    };
-}
-/**
- * Hook for paginated data queries
- *
- * @example
- * ```tsx
- * function PaginatedTaskList() {
- *   const {
- *     data,
- *     isLoading,
- *     page,
- *     totalPages,
- *     nextPage,
- *     previousPage,
- *     hasNextPage,
- *     hasPreviousPage
- *   } = usePagination('todo_task', {
- *     pageSize: 10,
- *     sort: ['-created_at']
- *   });
- *
- *   return (
- *     <div>
- *       {data?.value.map(task => <div key={task.id}>{task.subject}</div>)}
- *       <button onClick={previousPage} disabled={!hasPreviousPage}>Previous</button>
- *       <span>Page {page} of {totalPages}</span>
- *       <button onClick={nextPage} disabled={!hasNextPage}>Next</button>
- *     </div>
- *   );
- * }
- * ```
- */
-function usePagination(object, options = {}) {
-    const { pageSize = 20, initialPage = 1, ...queryOptions } = options;
-    const [page, setPage] = (0, react_1.useState)(initialPage);
-    const queryResult = useQuery(object, {
-        ...queryOptions,
-        top: pageSize,
-        skip: (page - 1) * pageSize
-    });
-    const totalCount = queryResult.data?.count || 0;
-    const totalPages = Math.ceil(totalCount / pageSize);
-    const hasNextPage = page < totalPages;
-    const hasPreviousPage = page > 1;
-    const nextPage = (0, react_1.useCallback)(() => {
-        if (hasNextPage) {
-            setPage(p => p + 1);
-        }
-    }, [hasNextPage]);
-    const previousPage = (0, react_1.useCallback)(() => {
-        if (hasPreviousPage) {
-            setPage(p => p - 1);
-        }
-    }, [hasPreviousPage]);
-    const goToPage = (0, react_1.useCallback)((newPage) => {
-        const clampedPage = Math.max(1, Math.min(newPage, totalPages));
-        setPage(clampedPage);
-    }, [totalPages]);
-    return {
-        ...queryResult,
-        page,
-        totalPages,
-        totalCount,
-        nextPage,
-        previousPage,
-        goToPage,
-        hasNextPage,
-        hasPreviousPage
-    };
-}
-/**
- * Hook for infinite scrolling / load more functionality
- *
- * @example
- * ```tsx
- * function InfiniteTaskList() {
- *   const {
- *     flatData,
- *     isLoading,
- *     fetchNextPage,
- *     hasNextPage,
- *     isFetchingNextPage
- *   } = useInfiniteQuery('todo_task', {
- *     pageSize: 20,
- *     sort: ['-created_at']
- *   });
- *
- *   return (
- *     <div>
- *       {flatData.map(task => <div key={task.id}>{task.subject}</div>)}
- *       {hasNextPage && (
- *         <button onClick={fetchNextPage} disabled={isFetchingNextPage}>
- *           {isFetchingNextPage ? 'Loading...' : 'Load More'}
- *         </button>
- *       )}
- *     </div>
- *   );
- * }
- * ```
- */
-function useInfiniteQuery(object, options = {}) {
-    const client = (0, context_1.useClient)();
-    const { pageSize = 20, 
-    // getNextPageParam is reserved for future use
-    query, select, filters, sort, enabled = true, onSuccess, onError } = options;
-    const [pages, setPages] = (0, react_1.useState)([]);
-    const [isLoading, setIsLoading] = (0, react_1.useState)(true);
-    const [isFetchingNextPage, setIsFetchingNextPage] = (0, react_1.useState)(false);
-    const [error, setError] = (0, react_1.useState)(null);
-    const [hasNextPage, setHasNextPage] = (0, react_1.useState)(true);
-    const fetchPage = (0, react_1.useCallback)(async (skip, isNextPage = false) => {
-        try {
-            if (isNextPage) {
-                setIsFetchingNextPage(true);
-            }
-            else {
-                setIsLoading(true);
-            }
-            setError(null);
-            let result;
-            if (query) {
-                result = await client.data.query(object, {
-                    ...query,
-                    limit: pageSize,
-                    offset: skip
-                });
-            }
-            else {
-                result = await client.data.find(object, {
-                    select,
-                    filters: filters,
-                    sort,
-                    top: pageSize,
-                    skip
-                });
-            }
-            if (isNextPage) {
-                setPages(prev => [...prev, result]);
-            }
-            else {
-                setPages([result]);
-            }
-            // Determine if there's a next page
-            const fetchedCount = result.value.length;
-            const hasMore = fetchedCount === pageSize;
-            setHasNextPage(hasMore);
-            onSuccess?.(result);
-        }
-        catch (err) {
-            const error = err instanceof Error ? err : new Error('Query failed');
-            setError(error);
-            onError?.(error);
-        }
-        finally {
-            setIsLoading(false);
-            setIsFetchingNextPage(false);
-        }
-    }, [client, object, query, select, filters, sort, pageSize, onSuccess, onError]);
-    // Initial fetch
-    (0, react_1.useEffect)(() => {
-        if (enabled) {
-            fetchPage(0);
-        }
-    }, [enabled, fetchPage]);
-    const fetchNextPage = (0, react_1.useCallback)(async () => {
-        if (!hasNextPage || isFetchingNextPage)
-            return;
-        const nextSkip = pages.length * pageSize;
-        await fetchPage(nextSkip, true);
-    }, [hasNextPage, isFetchingNextPage, pages.length, pageSize, fetchPage]);
-    const refetch = (0, react_1.useCallback)(async () => {
-        setPages([]);
-        await fetchPage(0);
-    }, [fetchPage]);
-    const flatData = pages.flatMap(page => page.value);
-    return {
-        data: pages,
-        flatData,
-        isLoading,
-        error,
-        fetchNextPage,
-        hasNextPage,
-        isFetchingNextPage,
-        refetch
-    };
-}

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAGH,OAAO,EACL,mBAAmB,EACnB,kBAAkB,EAClB,SAAS,EACT,KAAK,wBAAwB,EAC9B,MAAM,WAAW,CAAC;AAGnB,OAAO,EACL,QAAQ,EACR,WAAW,EACX,aAAa,EACb,gBAAgB,EAChB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,EACzB,KAAK,mBAAmB,EACxB,KAAK,uBAAuB,EAC5B,KAAK,sBAAsB,EAC5B,MAAM,cAAc,CAAC;AAGtB,OAAO,EACL,SAAS,EACT,OAAO,EACP,SAAS,EACT,WAAW,EACX,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACvB,MAAM,kBAAkB,CAAC;AAG1B,OAAO,EAAE,iBAAiB,EAAE,KAAK,YAAY,EAAE,MAAM,qBAAqB,CAAC"}

package/dist/metadata-hooks.d.ts

@@ -1,121 +0,0 @@
-/**
- * Metadata Hooks
- *
- * React hooks for accessing ObjectStack metadata (schemas, views, fields)
- */
-import { useClient } from './context';
-/**
- * Metadata query options
- */
-export interface UseMetadataOptions {
-    /** Enable/disable automatic query execution */
-    enabled?: boolean;
-    /** Use cached metadata if available */
-    useCache?: boolean;
-    /** ETag for conditional requests */
-    ifNoneMatch?: string;
-    /** If-Modified-Since header for conditional requests */
-    ifModifiedSince?: string;
-    /** Callback on successful query */
-    onSuccess?: (data: any) => void;
-    /** Callback on error */
-    onError?: (error: Error) => void;
-}
-/**
- * Metadata query result
- */
-export interface UseMetadataResult<T = any> {
-    /** Metadata data */
-    data: T | null;
-    /** Loading state */
-    isLoading: boolean;
-    /** Error state */
-    error: Error | null;
-    /** Refetch the metadata */
-    refetch: () => Promise<void>;
-    /** ETag from last fetch */
-    etag?: string;
-    /** Whether data came from cache (304 Not Modified) */
-    fromCache: boolean;
-}
-/**
- * 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>
- *   );
- * }
- * ```
- */
-export declare function useObject(objectName: string, options?: UseMetadataOptions): UseMetadataResult;
-/**
- * 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>
- *   );
- * }
- * ```
- */
-export declare function useView(objectName: string, viewType?: 'list' | 'form', options?: UseMetadataOptions): UseMetadataResult;
-/**
- * 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>
- *   );
- * }
- * ```
- */
-export declare function useFields(objectName: string, options?: UseMetadataOptions): UseMetadataResult<any[]>;
-/**
- * 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>;
- * }
- * ```
- */
-export declare function useMetadata<T = any>(fetcher: (client: ReturnType<typeof useClient>) => Promise<T>, options?: Omit<UseMetadataOptions, 'useCache' | 'ifNoneMatch' | 'ifModifiedSince'>): UseMetadataResult<T>;
-//# sourceMappingURL=metadata-hooks.d.ts.map

package/dist/metadata-hooks.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"metadata-hooks.d.ts","sourceRoot":"","sources":["../src/metadata-hooks.tsx"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAEtC;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,+CAA+C;IAC/C,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,uCAAuC;IACvC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,oCAAoC;IACpC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,wDAAwD;IACxD,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,mCAAmC;IACnC,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,CAAC;IAChC,wBAAwB;IACxB,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB,CAAC,CAAC,GAAG,GAAG;IACxC,oBAAoB;IACpB,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC;IACf,oBAAoB;IACpB,SAAS,EAAE,OAAO,CAAC;IACnB,kBAAkB;IAClB,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB,2BAA2B;IAC3B,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7B,2BAA2B;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,sDAAsD;IACtD,SAAS,EAAE,OAAO,CAAC;CACpB;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,SAAS,CACvB,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE,kBAAuB,GAC/B,iBAAiB,CAyEnB;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,OAAO,CACrB,UAAU,EAAE,MAAM,EAClB,QAAQ,GAAE,MAAM,GAAG,MAAe,EAClC,OAAO,GAAE,kBAAuB,GAC/B,iBAAiB,CA0CnB;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,SAAS,CACvB,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE,kBAAuB,GAC/B,iBAAiB,CAAC,GAAG,EAAE,CAAC,CAc1B;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,WAAW,CAAC,CAAC,GAAG,GAAG,EACjC,OAAO,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,SAAS,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,EAC7D,OAAO,GAAE,IAAI,CAAC,kBAAkB,EAAE,UAAU,GAAG,aAAa,GAAG,iBAAiB,CAAM,GACrF,iBAAiB,CAAC,CAAC,CAAC,CA0CtB"}