amplifyquery 1.0.16 → 1.0.17

package/dist/service.js

@@ -1122,7 +1122,7 @@ function createAmplifyService(modelName, defaultAuthMode) {
         },
         // React Hook returning method - Reimplemented based on TanStack Query
         useHook: (options) => {
-            var _a, _b, _c, _d, _e, _f, _g, _h;
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
             const hookQueryClient = (0, react_query_1.useQueryClient)();
             // Determine query key
             const queryKey = (0, react_1.useMemo)(() => {
@@ -1170,16 +1170,82 @@ function createAmplifyService(modelName, defaultAuthMode) {
                 (_g = options === null || options === void 0 ? void 0 : options.customList) === null || _g === void 0 ? void 0 : _g.forceRefresh,
                 service,
             ]);
+            const realtimeEnabled = ((_h = options === null || options === void 0 ? void 0 : options.realtime) === null || _h === void 0 ? void 0 : _h.enabled) === true;
             const queryOptions = {
                 queryKey,
                 queryFn,
-                enabled: ((_h = options === null || options === void 0 ? void 0 : options.initialFetchOptions) === null || _h === void 0 ? void 0 : _h.fetch) !== false,
+                enabled: ((_j = options === null || options === void 0 ? void 0 : options.initialFetchOptions) === null || _j === void 0 ? void 0 : _j.fetch) !== false && !realtimeEnabled,
                 staleTime: 1000 * 30, // Keep fresh for 30 seconds (refresh more frequently)
                 refetchOnMount: true, // Refetch on component mount
                 refetchOnWindowFocus: false, // Don't auto-refetch on window focus
                 refetchOnReconnect: true, // Refetch on network reconnect
             };
+            const [isSynced, setIsSynced] = (0, react_1.useState)(undefined);
             const { data: items = [], isLoading, error, refetch, } = (0, react_query_1.useQuery)(queryOptions);
+            (0, react_1.useEffect)(() => {
+                var _a, _b, _c;
+                if (!realtimeEnabled)
+                    return;
+                if (options === null || options === void 0 ? void 0 : options.customList) {
+                    console.warn(`🍬 ${modelName} useHook realtime: customList is not supported.`);
+                    return;
+                }
+                const client = (0, client_1.getClient)();
+                const model = (_a = client.models) === null || _a === void 0 ? void 0 : _a[modelName];
+                if (!(model === null || model === void 0 ? void 0 : model.observeQuery)) {
+                    console.warn(`🍬 ${modelName} useHook realtime: observeQuery not available.`);
+                    return;
+                }
+                const observeOptions = Object.assign({}, (((_b = options === null || options === void 0 ? void 0 : options.realtime) === null || _b === void 0 ? void 0 : _b.observeOptions) || {}));
+                if (observeOptions.filter === undefined &&
+                    ((_c = options === null || options === void 0 ? void 0 : options.initialFetchOptions) === null || _c === void 0 ? void 0 : _c.filter)) {
+                    observeOptions.filter = options.initialFetchOptions.filter;
+                }
+                let isMounted = true;
+                const subscription = model.observeQuery(observeOptions).subscribe({
+                    next: ({ items: nextItems, isSynced: synced }) => {
+                        if (!isMounted)
+                            return;
+                        const safeItems = Array.isArray(nextItems)
+                            ? nextItems.filter(Boolean)
+                            : [];
+                        const previousItems = hookQueryClient.getQueryData(queryKey) || [];
+                        const previousIds = new Set(previousItems.map((item) => item === null || item === void 0 ? void 0 : item.id).filter(Boolean));
+                        const nextIds = new Set(safeItems.map((item) => item === null || item === void 0 ? void 0 : item.id).filter(Boolean));
+                        previousIds.forEach((id) => {
+                            if (!nextIds.has(id)) {
+                                hookQueryClient.removeQueries({
+                                    queryKey: itemKey(modelName, id),
+                                    exact: true,
+                                });
+                            }
+                        });
+                        hookQueryClient.setQueryData(queryKey, safeItems);
+                        safeItems.forEach((item) => {
+                            if (item === null || item === void 0 ? void 0 : item.id) {
+                                hookQueryClient.setQueryData(itemKey(modelName, item.id), item);
+                            }
+                        });
+                        setIsSynced(Boolean(synced));
+                    },
+                    error: (err) => {
+                        console.error(`🍬 ${modelName} useHook realtime subscribe error:`, err);
+                    },
+                });
+                return () => {
+                    var _a;
+                    isMounted = false;
+                    (_a = subscription === null || subscription === void 0 ? void 0 : subscription.unsubscribe) === null || _a === void 0 ? void 0 : _a.call(subscription);
+                };
+            }, [
+                realtimeEnabled,
+                modelName,
+                queryKey,
+                hookQueryClient,
+                options === null || options === void 0 ? void 0 : options.customList,
+                (_k = options === null || options === void 0 ? void 0 : options.initialFetchOptions) === null || _k === void 0 ? void 0 : _k.filter,
+                (_l = options === null || options === void 0 ? void 0 : options.realtime) === null || _l === void 0 ? void 0 : _l.observeOptions,
+            ]);
             // Interface functions implementation
             const getItem = (0, react_1.useCallback)((id) => {
                 // Use useQueryData to get latest single item from current cache
@@ -1282,6 +1348,7 @@ function createAmplifyService(modelName, defaultAuthMode) {
                 items,
                 isLoading,
                 error: error,
+                isSynced,
                 getItem,
                 refresh,
                 create: createItem,

package/dist/types.d.ts

@@ -20,6 +20,7 @@ export type StoreState<T> = {
 export type ModelHook<T> = {
     items: T[];
     isLoading: boolean;
+    isSynced?: boolean;
     error: Error | null;
     getItem: (id: string) => T | null | undefined;
     refresh: (options?: {
@@ -92,6 +93,10 @@ export interface AmplifyDataService<T> {
             args: Record<string, any>;
             forceRefresh?: boolean;
         };
+        realtime?: {
+            enabled?: boolean;
+            observeOptions?: Record<string, any>;
+        };
     }) => ModelHook<T>;
     useItemHook: (id: string) => ItemHook<T>;
     modelName: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "amplifyquery",
-  "version": "1.0.16",
+  "version": "1.0.17",
   "description": "Amplify+Query",
   "keywords": [
     "Amplify",