amplifyquery 1.0.16 → 1.0.18

package/dist/config.d.ts

@@ -11,6 +11,10 @@ export declare function setModelOwnerQueryMap(queryMap: Record<string, string>):
  * @returns The global model owner query mapping or undefined if not set
  */
 export declare function getModelOwnerQueryMap(): Record<string, string> | undefined;
+/**
+ * Set the global selection set mapping
+ * @param selectionSetMap Mapping of model names to selection sets
+ */
 /**
  * Get owner query name for a specific model
  * @param modelName The model name

package/dist/config.js

@@ -26,6 +26,10 @@ function setModelOwnerQueryMap(queryMap) {
 function getModelOwnerQueryMap() {
     return globalConfig.modelOwnerQueryMap;
 }
+/**
+ * Set the global selection set mapping
+ * @param selectionSetMap Mapping of model names to selection sets
+ */
 /**
  * Get owner query name for a specific model
  * @param modelName The model name

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, _m, _o;
             const hookQueryClient = (0, react_query_1.useQueryClient)();
             // Determine query key
             const queryKey = (0, react_1.useMemo)(() => {
@@ -1170,16 +1170,124 @@ 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 realtimeEvents = (_k = (_j = options === null || options === void 0 ? void 0 : options.realtime) === null || _j === void 0 ? void 0 : _j.events) !== null && _k !== void 0 ? _k : ["create", "update", "delete"];
             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: ((_l = options === null || options === void 0 ? void 0 : options.initialFetchOptions) === null || _l === void 0 ? void 0 : _l.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, _d, _e, _f;
+                if (!realtimeEnabled)
+                    return;
+                if (options === null || options === void 0 ? void 0 : options.customList) {
+                    const client = (0, client_1.getClient)();
+                    const model = (_a = client.models) === null || _a === void 0 ? void 0 : _a[modelName];
+                    if (!model) {
+                        console.warn(`🍬 ${modelName} useHook realtime: model 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;
+                    }
+                    const subscriptions = [
+                        realtimeEvents.includes("create") && model.onCreate
+                            ? model.onCreate(observeOptions).subscribe({
+                                next: () => hookQueryClient.invalidateQueries({
+                                    queryKey,
+                                    refetchType: "active",
+                                }),
+                                error: (err) => console.error(`🍬 ${modelName} useHook realtime onCreate error:`, err),
+                            })
+                            : null,
+                        realtimeEvents.includes("update") && model.onUpdate
+                            ? model.onUpdate(observeOptions).subscribe({
+                                next: () => hookQueryClient.invalidateQueries({
+                                    queryKey,
+                                    refetchType: "active",
+                                }),
+                                error: (err) => console.error(`🍬 ${modelName} useHook realtime onUpdate error:`, err),
+                            })
+                            : null,
+                        realtimeEvents.includes("delete") && model.onDelete
+                            ? model.onDelete(observeOptions).subscribe({
+                                next: () => hookQueryClient.invalidateQueries({
+                                    queryKey,
+                                    refetchType: "active",
+                                }),
+                                error: (err) => console.error(`🍬 ${modelName} useHook realtime onDelete error:`, err),
+                            })
+                            : null,
+                    ].filter(Boolean);
+                    return () => {
+                        subscriptions.forEach((sub) => { var _a; return (_a = sub === null || sub === void 0 ? void 0 : sub.unsubscribe) === null || _a === void 0 ? void 0 : _a.call(sub); });
+                    };
+                }
+                const client = (0, client_1.getClient)();
+                const model = (_d = client.models) === null || _d === void 0 ? void 0 : _d[modelName];
+                if (!(model === null || model === void 0 ? void 0 : model.observeQuery)) {
+                    console.warn(`🍬 ${modelName} useHook realtime: observeQuery not available.`);
+                    return;
+                }
+                const observeOptions = Object.assign({}, (((_e = options === null || options === void 0 ? void 0 : options.realtime) === null || _e === void 0 ? void 0 : _e.observeOptions) || {}));
+                if (observeOptions.filter === undefined &&
+                    ((_f = options === null || options === void 0 ? void 0 : options.initialFetchOptions) === null || _f === void 0 ? void 0 : _f.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,
+                (_m = options === null || options === void 0 ? void 0 : options.initialFetchOptions) === null || _m === void 0 ? void 0 : _m.filter,
+                (_o = options === null || options === void 0 ? void 0 : options.realtime) === null || _o === void 0 ? void 0 : _o.observeOptions,
+            ]);
             // Interface functions implementation
             const getItem = (0, react_1.useCallback)((id) => {
                 // Use useQueryData to get latest single item from current cache
@@ -1282,6 +1390,7 @@ function createAmplifyService(modelName, defaultAuthMode) {
                 items,
                 isLoading,
                 error: error,
+                isSynced,
                 getItem,
                 refresh,
                 create: createItem,
@@ -1291,9 +1400,11 @@ function createAmplifyService(modelName, defaultAuthMode) {
             };
         },
         // Hook for managing single item - Reimplemented based on TanStack Query
-        useItemHook: (id) => {
+        useItemHook: (id, options) => {
+            var _a, _b;
             const hookQueryClient = (0, react_query_1.useQueryClient)();
             const singleItemQueryKey = itemKey(modelName, id);
+            const realtimeEnabled = ((_a = options === null || options === void 0 ? void 0 : options.realtime) === null || _a === void 0 ? void 0 : _a.enabled) === true;
             // First check data from cache
             const rawCachedData = hookQueryClient.getQueryData(singleItemQueryKey);
             // 🔧 버그 수정: 배열이 캐시되어 있는 경우 처리
@@ -1325,8 +1436,83 @@ function createAmplifyService(modelName, defaultAuthMode) {
                 staleTime: 1000 * 60, // Keep data "fresh" for 1 minute
                 refetchOnMount: cachedData ? false : true, // Only refetch if no cached data
                 refetchOnWindowFocus: false, // Disable window focus refetch to prevent loops
-                enabled: !!id, // Only enable query when id exists
+                enabled: !!id && !realtimeEnabled, // Only enable query when id exists
             });
+            const [isSynced, setIsSynced] = (0, react_1.useState)(undefined);
+            (0, react_1.useEffect)(() => {
+                var _a, _b;
+                if (!realtimeEnabled || !id)
+                    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} useItemHook 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) {
+                    observeOptions.filter = { id: { eq: id } };
+                }
+                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 nextItem = safeItems.find((entry) => (entry === null || entry === void 0 ? void 0 : entry.id) === id) || null;
+                        const relatedQueryKeys = findRelatedQueryKeys(modelName, hookQueryClient);
+                        if (nextItem) {
+                            hookQueryClient.setQueryData(singleItemQueryKey, nextItem);
+                            relatedQueryKeys.forEach((queryKey) => {
+                                if (isItemKeyForModel(modelName, queryKey)) {
+                                    return;
+                                }
+                                hookQueryClient.setQueryData(queryKey, (oldData) => {
+                                    const oldItems = Array.isArray(oldData) ? oldData : [];
+                                    const hasItem = oldItems.some((entry) => (entry === null || entry === void 0 ? void 0 : entry.id) === id);
+                                    if (hasItem) {
+                                        return oldItems.map((entry) => (entry === null || entry === void 0 ? void 0 : entry.id) === id ? nextItem : entry);
+                                    }
+                                    if (queryKey.length === 1) {
+                                        return [...oldItems, nextItem];
+                                    }
+                                    return oldItems;
+                                });
+                            });
+                        }
+                        else {
+                            hookQueryClient.setQueryData(singleItemQueryKey, null);
+                            relatedQueryKeys.forEach((queryKey) => {
+                                if (isItemKeyForModel(modelName, queryKey)) {
+                                    return;
+                                }
+                                hookQueryClient.setQueryData(queryKey, (oldData) => {
+                                    const oldItems = Array.isArray(oldData) ? oldData : [];
+                                    return oldItems.filter((entry) => (entry === null || entry === void 0 ? void 0 : entry.id) !== id);
+                                });
+                            });
+                        }
+                        setIsSynced(Boolean(synced));
+                    },
+                    error: (err) => {
+                        console.error(`🍬 ${modelName} useItemHook 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,
+                id,
+                modelName,
+                hookQueryClient,
+                singleItemQueryKey,
+                (_b = options === null || options === void 0 ? void 0 : options.realtime) === null || _b === void 0 ? void 0 : _b.observeOptions,
+            ]);
             // useMutation hooks call service methods,
             // Service methods handle optimistic updates and cache updates/rollbacks internally.
             // Mutations inside useHook only serve to call service methods.
@@ -1396,6 +1582,7 @@ function createAmplifyService(modelName, defaultAuthMode) {
                 item: item || null,
                 isLoading: effectiveLoading, // Not loading if cached data exists
                 error: error, // Explicitly specify error type
+                isSynced,
                 refresh: refreshItem,
                 update: updateItem,
                 delete: deleteItem,

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?: {
@@ -40,6 +41,7 @@ export type ModelHook<T> = {
 export type ItemHook<T> = {
     item: T | null;
     isLoading: boolean;
+    isSynced?: boolean;
     error: Error | null;
     refresh: () => Promise<T | null>;
     update: (data: Partial<T>) => Promise<T | null>;
@@ -92,8 +94,18 @@ export interface AmplifyDataService<T> {
             args: Record<string, any>;
             forceRefresh?: boolean;
         };
+        realtime?: {
+            enabled?: boolean;
+            observeOptions?: Record<string, any>;
+            events?: Array<"create" | "update" | "delete">;
+        };
     }) => ModelHook<T>;
-    useItemHook: (id: string) => ItemHook<T>;
+    useItemHook: (id: string, options?: {
+        realtime?: {
+            enabled?: boolean;
+            observeOptions?: Record<string, any>;
+        };
+    }) => ItemHook<T>;
     modelName: string;
     withExtensions: <E>(extensions: E) => AmplifyDataService<T> & E;
     setAuthMode: (authMode: AuthMode) => void;

package/package.json

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