amplifyquery 1.0.19 → 1.0.21

package/README.md

@@ -159,6 +159,17 @@ const UserSettingsService =
     AmplifyQuery.createAmplifyService<UserSettingsModel>("UserSettings"),
     AmplifyQuery.getModelIds.UserSettings
   );
+
+// Singleton hook (recommended)
+const {
+  item: settings,
+  isLoading: isSettingsLoading,
+  update: upsertSettings, // creates if missing
+  refresh: refreshSettings,
+} = UserSettingsService.useSigletoneHook();
+
+// Legacy alias (deprecated)
+// UserSettingsService.useCurrentHook()
 ```
 
 ### 4. Data Fetching and Saving

package/dist/config.d.ts

@@ -1,6 +1,10 @@
 /**
  * Global configuration for AmplifyQuery library
  */
+export declare function setDebug(debug: boolean): void;
+export declare function isDebugEnabled(): boolean;
+export declare function debugLog(...args: any[]): void;
+export declare function debugWarn(...args: any[]): void;
 /**
  * Set the global model owner query mapping
  * @param queryMap Mapping of model names to their owner query names
@@ -35,3 +39,18 @@ export declare function getDefaultAuthMode(): "apiKey" | "iam" | "identityPool"
  * Reset global configuration (mainly for testing)
  */
 export declare function resetConfig(): void;
+/**
+ * Enable/disable singleton auto-create behavior for singleton hooks.
+ *
+ * - **New**: `useSigletoneHook()` (recommended)
+ * - **Legacy**: `useCurrentHook()` (deprecated alias)
+ */
+export declare function setSingletonAutoCreate(config: {
+    enabled?: boolean;
+    models?: string[];
+}): void;
+export declare function getSingletonAutoCreate(): {
+    enabled?: boolean;
+    models?: string[];
+} | undefined;
+export declare function isSingletonAutoCreateEnabledForModel(modelName: string): boolean;

package/dist/config.js

@@ -3,21 +3,50 @@
  * Global configuration for AmplifyQuery library
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.setDebug = setDebug;
+exports.isDebugEnabled = isDebugEnabled;
+exports.debugLog = debugLog;
+exports.debugWarn = debugWarn;
 exports.setModelOwnerQueryMap = setModelOwnerQueryMap;
 exports.getModelOwnerQueryMap = getModelOwnerQueryMap;
 exports.getOwnerQueryName = getOwnerQueryName;
 exports.setDefaultAuthMode = setDefaultAuthMode;
 exports.getDefaultAuthMode = getDefaultAuthMode;
 exports.resetConfig = resetConfig;
+exports.setSingletonAutoCreate = setSingletonAutoCreate;
+exports.getSingletonAutoCreate = getSingletonAutoCreate;
+exports.isSingletonAutoCreateEnabledForModel = isSingletonAutoCreateEnabledForModel;
 // Global configuration state
 let globalConfig = {};
+function isDebugEnabledInternal() {
+    // Debug logging must be explicitly enabled via AmplifyQuery.configure({ debug: true }).
+    return globalConfig.debug === true;
+}
+function setDebug(debug) {
+    globalConfig.debug = debug === true;
+}
+function isDebugEnabled() {
+    return isDebugEnabledInternal();
+}
+function debugLog(...args) {
+    if (!isDebugEnabledInternal())
+        return;
+    // eslint-disable-next-line no-console
+    console.log(...args);
+}
+function debugWarn(...args) {
+    if (!isDebugEnabledInternal())
+        return;
+    // eslint-disable-next-line no-console
+    console.warn(...args);
+}
 /**
  * Set the global model owner query mapping
  * @param queryMap Mapping of model names to their owner query names
  */
 function setModelOwnerQueryMap(queryMap) {
     globalConfig.modelOwnerQueryMap = Object.assign({}, queryMap);
-    console.log("🔧 AmplifyQuery: Global model owner query map configured");
+    debugLog("🔧 AmplifyQuery: Global model owner query map configured");
 }
 /**
  * Get the global model owner query mapping
@@ -45,7 +74,7 @@ function getOwnerQueryName(modelName) {
  */
 function setDefaultAuthMode(authMode) {
     globalConfig.defaultAuthMode = authMode;
-    console.log(`🔧 AmplifyQuery: Default auth mode set to ${authMode}`);
+    debugLog(`🔧 AmplifyQuery: Default auth mode set to ${authMode}`);
 }
 /**
  * Get the default auth mode
@@ -59,5 +88,30 @@ function getDefaultAuthMode() {
  */
 function resetConfig() {
     globalConfig = {};
-    console.log("🔧 AmplifyQuery: Global configuration reset");
+    debugLog("🔧 AmplifyQuery: Global configuration reset");
+}
+/**
+ * Enable/disable singleton auto-create behavior for singleton hooks.
+ *
+ * - **New**: `useSigletoneHook()` (recommended)
+ * - **Legacy**: `useCurrentHook()` (deprecated alias)
+ */
+function setSingletonAutoCreate(config) {
+    globalConfig.singletonAutoCreate = {
+        // Default: enabled (singleton services are meant to be convenient)
+        enabled: config.enabled !== false,
+        models: Array.isArray(config.models) ? config.models : undefined,
+    };
+    debugLog("🔧 AmplifyQuery: Singleton auto-create configured", globalConfig.singletonAutoCreate);
+}
+function getSingletonAutoCreate() {
+    return globalConfig.singletonAutoCreate;
+}
+function isSingletonAutoCreateEnabledForModel(modelName) {
+    const cfg = getSingletonAutoCreate();
+    if (!(cfg === null || cfg === void 0 ? void 0 : cfg.enabled))
+        return false;
+    if (!cfg.models || cfg.models.length === 0)
+        return true;
+    return cfg.models.includes(modelName);
 }

package/dist/index.d.ts

@@ -39,37 +39,6 @@ export declare const Utils: {
     getDateString: (dateStr: string | undefined) => string;
     removeOwnerField: <T extends Record<string, any>>(data: T, operation: "create" | "update" | "upsert") => Omit<T, "owner">;
 };
-export declare const Storage: {
-    _types: {
-        Item: {
-            url: string;
-            expiresAt: number;
-        };
-        CacheData: {
-            [key: string]: {
-                url: string;
-                expiresAt: number;
-            };
-        };
-    };
-    _urlCache: Map<string, {
-        url: string;
-        expiresAt: number;
-    }>;
-    _CACHE_KEY: string;
-    _initialized: boolean;
-    _initCache: () => void;
-    _saveCache: () => void;
-    uploadImage: (file: Blob | File, key?: string) => Promise<string>;
-    getFileUrl: (key: string, options?: {
-        forceRefresh?: boolean;
-    }) => Promise<string>;
-    deleteFile: (key: string) => Promise<void>;
-    clearUrlCache: () => void;
-    clearUrlCacheForKey: (key: string) => void;
-    clearExpiredUrlCache: () => void;
-    downloadAudioFile: (audioKey: string) => Promise<string>;
-};
 export declare const Auth: {
     getCurrentUserInfo: () => Promise<{
         userId: string;
@@ -92,37 +61,6 @@ export declare const AmplifyQuery: {
         getDateString: (dateStr: string | undefined) => string;
         removeOwnerField: <T extends Record<string, any>>(data: T, operation: "create" | "update" | "upsert") => Omit<T, "owner">;
     };
-    Storage: {
-        _types: {
-            Item: {
-                url: string;
-                expiresAt: number;
-            };
-            CacheData: {
-                [key: string]: {
-                    url: string;
-                    expiresAt: number;
-                };
-            };
-        };
-        _urlCache: Map<string, {
-            url: string;
-            expiresAt: number;
-        }>;
-        _CACHE_KEY: string;
-        _initialized: boolean;
-        _initCache: () => void;
-        _saveCache: () => void;
-        uploadImage: (file: Blob | File, key?: string) => Promise<string>;
-        getFileUrl: (key: string, options?: {
-            forceRefresh?: boolean;
-        }) => Promise<string>;
-        deleteFile: (key: string) => Promise<void>;
-        clearUrlCache: () => void;
-        clearUrlCacheForKey: (key: string) => void;
-        clearExpiredUrlCache: () => void;
-        downloadAudioFile: (audioKey: string) => Promise<string>;
-    };
     Auth: {
         getCurrentUserInfo: () => Promise<{
             userId: string;

package/dist/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AmplifyQuery = exports.getAppUrl = exports.setAppUrl = exports.Auth = exports.Storage = exports.Utils = exports.getClient = exports.createQueryKeys = exports.ensureMutationsFlushed = exports.invalidateAll = exports.invalidateModelByField = exports.invalidateModelItem = exports.invalidateModel = exports.getQueryClient = exports.queryClient = void 0;
+exports.AmplifyQuery = exports.getAppUrl = exports.setAppUrl = exports.Auth = exports.Utils = exports.getClient = exports.createQueryKeys = exports.ensureMutationsFlushed = exports.invalidateAll = exports.invalidateModelByField = exports.invalidateModelItem = exports.invalidateModel = exports.getQueryClient = exports.queryClient = void 0;
 exports.configure = configure;
 const client_1 = require("./client");
 Object.defineProperty(exports, "getClient", { enumerable: true, get: function () { return client_1.getClient; } });
@@ -57,6 +57,10 @@ const config_1 = require("./config");
  * ```
  */
 function configure(config) {
+    // Debug flag first (affects internal logs)
+    if (typeof config.debug === "boolean") {
+        (0, config_1.setDebug)(config.debug);
+    }
     // Configure Amplify client
     if (config.client) {
         (0, client_1.setClient)(config.client);
@@ -69,13 +73,17 @@ function configure(config) {
     if (config.defaultAuthMode) {
         (0, config_1.setDefaultAuthMode)(config.defaultAuthMode);
     }
+    // Set singleton auto-create
+    if (config.singletonAutoCreate) {
+        (0, config_1.setSingletonAutoCreate)(config.singletonAutoCreate);
+    }
     // Apply React Query settings
     (0, query_1.configure)({
         isCachingEnabled: config.isCachingEnabled,
         queryClientConfig: config.queryClientConfig,
         storage: config.storage,
     });
-    console.log("🔌 AmplifyQuery initialized successfully.");
+    (0, config_1.debugLog)("🔌 AmplifyQuery initialized successfully.");
 }
 // Re-export types
 __exportStar(require("./types"), exports);
@@ -83,7 +91,6 @@ __exportStar(require("./types"), exports);
 __exportStar(require("./provider"), exports);
 // Re-export utility services
 exports.Utils = utils_1.Utils;
-exports.Storage = utils_1.StorageService;
 exports.Auth = utils_1.AuthService;
 /**
  * Main object for the AmplifyQuery library.
@@ -95,7 +102,6 @@ exports.AmplifyQuery = {
     createSingletonService: singleton_1.createSingletonService,
     createRelationalHook: utils_1.createRelationalHook,
     Utils: utils_1.Utils,
-    Storage: utils_1.StorageService,
     Auth: utils_1.AuthService,
     getModelIds: singleton_1.getModelIds,
     getQueryClient: query_1.getQueryClient,

package/dist/query.js

@@ -18,9 +18,8 @@ exports.invalidateModelItem = invalidateModelItem;
 exports.invalidateModelByField = invalidateModelByField;
 exports.invalidateAll = invalidateAll;
 exports.ensureMutationsFlushed = ensureMutationsFlushed;
-const react_native_mmkv_1 = require("react-native-mmkv");
 const react_query_1 = require("@tanstack/react-query");
-const react_query_persist_client_1 = require("@tanstack/react-query-persist-client");
+const config_1 = require("./config");
 // Default configuration
 const config = {
     isCachingEnabled: process.env.EXPO_PUBLIC_DISABLE_STORAGE_CACHE !== "true",
@@ -48,17 +47,31 @@ const config = {
         maxAge: 1000 * 60 * 60 * 24 * 7, // 7 days
     },
 };
-// MMKV instance
-let storageInstance; // Renamed from 'storage' to avoid conflict with ConfigOptions.storage
+let storageInstance = null; // Renamed from 'storage' to avoid conflict with ConfigOptions.storage
+function getOrCreateMmkv(id) {
+    if (storageInstance)
+        return storageInstance;
+    // Support both react-native-mmkv v3 (class MMKV) and v4 (createMMKV factory)
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    const mmkv = require("react-native-mmkv");
+    if (typeof mmkv.createMMKV === "function") {
+        const created = mmkv.createMMKV({ id });
+        storageInstance = created;
+        return created;
+    }
+    if (typeof mmkv.MMKV === "function") {
+        const created = new mmkv.MMKV({ id });
+        storageInstance = created;
+        return created;
+    }
+    throw new Error("react-native-mmkv is not available in this runtime");
+}
 // Function to create MMKV persister
 function createMmkvPersister() {
     var _a, _b;
     // Initialize or reuse MMKV instance
-    if (!storageInstance) {
-        storageInstance = new react_native_mmkv_1.MMKV({
-            id: ((_a = config.storage) === null || _a === void 0 ? void 0 : _a.mmkvId) || "mmkv.amplify-query.cache",
-        });
-    }
+    const mmkvId = ((_a = config.storage) === null || _a === void 0 ? void 0 : _a.mmkvId) || "mmkv.amplify-query.cache";
+    const storage = getOrCreateMmkv(mmkvId);
     // Check cache key
     const cacheKey = ((_b = config.storage) === null || _b === void 0 ? void 0 : _b.cacheKey) || "REACT_QUERY_OFFLINE_CACHE";
     return {
@@ -66,7 +79,7 @@ function createMmkvPersister() {
             try {
                 // Convert object to JSON string
                 const clientStr = JSON.stringify(client);
-                storageInstance.set(cacheKey, clientStr);
+                storage.set(cacheKey, clientStr);
             }
             catch (error) {
                 console.error("Error saving cache:", error);
@@ -74,7 +87,7 @@ function createMmkvPersister() {
         },
         restoreClient: () => {
             try {
-                const clientStr = storageInstance.getString(cacheKey);
+                const clientStr = storage.getString(cacheKey);
                 if (!clientStr)
                     return null;
                 // Convert string back to object
@@ -87,7 +100,17 @@ function createMmkvPersister() {
         },
         removeClient: () => {
             try {
-                storageInstance.delete(cacheKey);
+                // v3 uses delete(), v4 uses remove()
+                if (typeof storage.remove === "function") {
+                    storage.remove(cacheKey);
+                }
+                else if (typeof storage.delete === "function") {
+                    storage.delete(cacheKey);
+                }
+                else if (typeof storage.clearAll === "function") {
+                    // As a last resort, clear all
+                    storage.clearAll();
+                }
             }
             catch (error) {
                 console.error("Error removing cache:", error);
@@ -124,28 +147,36 @@ function configure(options = {}) {
     }
     // Apply caching config
     if (config.isCachingEnabled) {
-        console.log("🏃‍♀️ React Query offline cache is enabled with MMKV.");
+        (0, config_1.debugLog)("🏃‍♀️ React Query offline cache is enabled with MMKV.");
         // Create new persister if config changed
         const mmkvPersister = createMmkvPersister();
-        (0, react_query_persist_client_1.persistQueryClient)({
-            queryClient: exports.queryClient,
-            persister: mmkvPersister,
-            // Additional options
-            maxAge: ((_a = config.storage) === null || _a === void 0 ? void 0 : _a.maxAge) || 1000 * 60 * 60 * 24 * 7, // Default 7 days
-            dehydrateOptions: {
-                shouldDehydrateQuery: (query) => {
-                    var _a;
-                    // Only persist successful queries to reduce hydration cancellation noise
-                    if (((_a = query.state) === null || _a === void 0 ? void 0 : _a.status) !== "success")
-                        return false;
-                    // Avoid persisting mutation-like or transient keys if needed later
-                    return true;
+        try {
+            // Lazy-load persistQueryClient to avoid hard dependency resolution at build time.
+            // eslint-disable-next-line @typescript-eslint/no-var-requires
+            const { persistQueryClient } = require("@tanstack/react-query-persist-client");
+            persistQueryClient({
+                queryClient: exports.queryClient,
+                persister: mmkvPersister,
+                // Additional options
+                maxAge: ((_a = config.storage) === null || _a === void 0 ? void 0 : _a.maxAge) || 1000 * 60 * 60 * 24 * 7, // Default 7 days
+                dehydrateOptions: {
+                    shouldDehydrateQuery: (query) => {
+                        var _a;
+                        // Only persist successful queries to reduce hydration cancellation noise
+                        if (((_a = query.state) === null || _a === void 0 ? void 0 : _a.status) !== "success")
+                            return false;
+                        // Avoid persisting mutation-like or transient keys if needed later
+                        return true;
+                    },
                 },
-            },
-        });
+            });
+        }
+        catch (e) {
+            console.error("Error setting up React Query persistence:", e);
+        }
     }
     else {
-        console.log("🏃‍♀️ React Query offline cache is disabled via flag.");
+        (0, config_1.debugLog)("🏃‍♀️ React Query offline cache is disabled via flag.");
     }
 }
 /**