amplifyquery 1.0.2 → 1.0.3

package/README.md

@@ -9,6 +9,7 @@ A library that combines AWS Amplify and React Query, making it easier to manage
 - 📱 **Offline Support**: Persistent query caching via MMKV for fast data loading even offline.
 - 🪝 **Convenient Hooks API**: Abstract complex data synchronization into simple Hooks.
 - 🛡 **Auth Mode Support**: Supports various AWS Amplify authentication modes (API Key, IAM, Cognito, etc.).
+- ⚙️ **Global Configuration**: Set model mappings and auth modes once - no more repetitive configuration.
 - ⚡ **Performance Optimized**: Maximize performance with request batching and intelligent caching.
 
 ## Installation
@@ -31,8 +32,23 @@ import { generateClient } from "aws-amplify/api";
 const client = generateClient();
 AmplifyQuery.configure({
   client,
+
+  // Global model owner query mapping (optional)
+  // Set once and all services will use it automatically
+  modelOwnerQueryMap: {
+    User: "listUserByOwner",
+    Project: "listProjectByOwner",
+    Todo: "listTodoByOwner",
+    Comment: "listCommentByOwner",
+    // Add your model mappings here
+  },
+
+  // Default authentication mode (optional)
+  defaultAuthMode: "userPool",
+
   // Caching options (optional)
   isCachingEnabled: true,
+
   // Customize Query Client configuration (optional)
   queryClientConfig: {
     defaultOptions: {
@@ -41,6 +57,7 @@ AmplifyQuery.configure({
       },
     },
   },
+
   // Storage configuration (optional)
   storage: {
     mmkvId: "my-app.cache", // MMKV store ID
@@ -125,12 +142,21 @@ interface TodoModel {
   updatedAt: string;
 }
 
-// Create Todo service
+// Create Todo service - automatically uses global modelOwnerQueryMap
 const TodoService = AmplifyQuery.createAmplifyService<TodoModel>("Todo");
 
-// Create Singleton service (for single-instance models)
+// Create service with custom auth mode (optional)
+const AdminTodoService = AmplifyQuery.createAmplifyService<TodoModel>(
+  "Todo",
+  "iam"
+);
+
+// Create Singleton service (for single-instance models like user settings)
 const UserSettingsService =
-  AmplifyQuery.createSingletonService<UserSettingsModel>("UserSettings");
+  AmplifyQuery.createSingletonService<UserSettingsModel>(
+    AmplifyQuery.createAmplifyService<UserSettingsModel>("UserSettings"),
+    AmplifyQuery.getModelIds.UserSettings
+  );
 ```
 
 ### 4. Data Fetching and Saving
@@ -213,6 +239,84 @@ function TodoScreen() {
 
 ## Advanced Features
 
+### Global Configuration
+
+AmplifyQuery supports global configuration to reduce code duplication and simplify service creation.
+
+```typescript
+// Set global model owner query mapping (can be done separately from configure)
+AmplifyQuery.setModelOwnerQueryMap({
+  User: "listUserByOwner",
+  Project: "listProjectByOwner",
+  Todo: "listTodoByOwner",
+  Comment: "listCommentByOwner",
+  Like: "listLikeByOwner",
+  // Add all your model mappings here
+});
+
+// Set global default auth mode
+AmplifyQuery.setDefaultAuthMode("userPool");
+
+// Now all services created will automatically use these settings
+const UserService = AmplifyQuery.createAmplifyService<User>("User");
+const ProjectService = AmplifyQuery.createAmplifyService<Project>("Project");
+const TodoService = AmplifyQuery.createAmplifyService<Todo>("Todo");
+
+// Get current global settings
+const currentQueryMap = AmplifyQuery.getModelOwnerQueryMap();
+const currentAuthMode = AmplifyQuery.getDefaultAuthMode();
+
+// Reset configuration (useful for testing)
+AmplifyQuery.resetConfig();
+```
+
+#### Migration from Previous Versions
+
+If you were previously passing `modelOwnerQueryMap` to each service, you can now simplify your code:
+
+**Before (repetitive):**
+
+```typescript
+const modelOwnerQueryMap = {
+  User: "listUserByOwner",
+  Project: "listProjectByOwner",
+  Todo: "listTodoByOwner",
+};
+
+// Had to pass queryMap to every service
+const UserService = AmplifyQuery.createAmplifyService<User>(
+  "User",
+  modelOwnerQueryMap
+);
+const ProjectService = AmplifyQuery.createAmplifyService<Project>(
+  "Project",
+  modelOwnerQueryMap
+);
+const TodoService = AmplifyQuery.createAmplifyService<Todo>(
+  "Todo",
+  modelOwnerQueryMap
+);
+```
+
+**After (clean):**
+
+```typescript
+// Set once globally
+AmplifyQuery.configure({
+  client,
+  modelOwnerQueryMap: {
+    User: "listUserByOwner",
+    Project: "listProjectByOwner",
+    Todo: "listTodoByOwner",
+  },
+});
+
+// Create services without repetition
+const UserService = AmplifyQuery.createAmplifyService<User>("User");
+const ProjectService = AmplifyQuery.createAmplifyService<Project>("Project");
+const TodoService = AmplifyQuery.createAmplifyService<Todo>("Todo");
+```
+
 ### Caching
 
 AmplifyQuery uses MMKV to persistently cache query results. This allows the app to display previous data immediately upon restart.
@@ -239,10 +343,22 @@ const todos = await TodoService.list({ forceRefresh: true });
 Access data with various authentication methods.
 
 ```typescript
-// Set global default authentication mode
-AmplifyQuery.configure({ client, defaultAuthMode: "userPool" });
+// Set global default authentication mode via configure
+AmplifyQuery.configure({
+  client,
+  defaultAuthMode: "userPool",
+});
+
+// Or set it separately
+AmplifyQuery.setDefaultAuthMode("userPool");
+
+// Create service with custom auth mode
+const AdminTodoService = AmplifyQuery.createAmplifyService<TodoModel>(
+  "Todo",
+  "iam"
+);
 
-// Set authentication mode for a service
+// Set authentication mode for an existing service
 TodoService.setAuthMode("apiKey");
 
 // Apply authentication mode to a specific request

package/dist/config.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Global configuration for AmplifyQuery library
+ */
+/**
+ * Set the global model owner query mapping
+ * @param queryMap Mapping of model names to their owner query names
+ */
+export declare function setModelOwnerQueryMap(queryMap: Record<string, string>): void;
+/**
+ * Get the global model owner query mapping
+ * @returns The global model owner query mapping or undefined if not set
+ */
+export declare function getModelOwnerQueryMap(): Record<string, string> | undefined;
+/**
+ * Get owner query name for a specific model
+ * @param modelName The model name
+ * @returns The owner query name or default format if not found
+ */
+export declare function getOwnerQueryName(modelName: string): string;
+/**
+ * Set the default auth mode
+ * @param authMode Default authentication mode
+ */
+export declare function setDefaultAuthMode(authMode: "apiKey" | "iam" | "identityPool" | "oidc" | "userPool" | "lambda" | "none"): void;
+/**
+ * Get the default auth mode
+ * @returns The default auth mode or 'userPool' if not set
+ */
+export declare function getDefaultAuthMode(): "apiKey" | "iam" | "identityPool" | "oidc" | "userPool" | "lambda" | "none";
+/**
+ * Reset global configuration (mainly for testing)
+ */
+export declare function resetConfig(): void;

package/dist/config.js

@@ -0,0 +1,59 @@
+"use strict";
+/**
+ * Global configuration for AmplifyQuery library
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setModelOwnerQueryMap = setModelOwnerQueryMap;
+exports.getModelOwnerQueryMap = getModelOwnerQueryMap;
+exports.getOwnerQueryName = getOwnerQueryName;
+exports.setDefaultAuthMode = setDefaultAuthMode;
+exports.getDefaultAuthMode = getDefaultAuthMode;
+exports.resetConfig = resetConfig;
+// Global configuration state
+let globalConfig = {};
+/**
+ * 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");
+}
+/**
+ * Get the global model owner query mapping
+ * @returns The global model owner query mapping or undefined if not set
+ */
+function getModelOwnerQueryMap() {
+    return globalConfig.modelOwnerQueryMap;
+}
+/**
+ * Get owner query name for a specific model
+ * @param modelName The model name
+ * @returns The owner query name or default format if not found
+ */
+function getOwnerQueryName(modelName) {
+    const queryMap = getModelOwnerQueryMap();
+    return (queryMap === null || queryMap === void 0 ? void 0 : queryMap[modelName]) || `list${modelName}sByOwner`;
+}
+/**
+ * Set the default auth mode
+ * @param authMode Default authentication mode
+ */
+function setDefaultAuthMode(authMode) {
+    globalConfig.defaultAuthMode = authMode;
+    console.log(`🔧 AmplifyQuery: Default auth mode set to ${authMode}`);
+}
+/**
+ * Get the default auth mode
+ * @returns The default auth mode or 'userPool' if not set
+ */
+function getDefaultAuthMode() {
+    return globalConfig.defaultAuthMode || "userPool";
+}
+/**
+ * Reset global configuration (mainly for testing)
+ */
+function resetConfig() {
+    globalConfig = {};
+    console.log("🔧 AmplifyQuery: Global configuration reset");
+}

package/dist/index.d.ts

@@ -4,6 +4,7 @@ import { createAmplifyService } from "./service";
 import { createSingletonService } from "./singleton";
 import { AmplifyQueryConfig } from "./types";
 import { createRelationalHook, setAppUrl, getAppUrl } from "./utils";
+import { setModelOwnerQueryMap, setDefaultAuthMode, getModelOwnerQueryMap, getDefaultAuthMode, resetConfig } from "./config";
 /**
  * Initialization function for the AmplifyQuery library.
  *
@@ -132,4 +133,9 @@ export declare const AmplifyQuery: {
         User: () => Promise<string>;
     };
     getQueryClient: typeof getQueryClient;
+    setModelOwnerQueryMap: typeof setModelOwnerQueryMap;
+    getModelOwnerQueryMap: typeof getModelOwnerQueryMap;
+    setDefaultAuthMode: typeof setDefaultAuthMode;
+    getDefaultAuthMode: typeof getDefaultAuthMode;
+    resetConfig: typeof resetConfig;
 };

package/dist/index.js

@@ -32,6 +32,7 @@ const singleton_1 = require("./singleton");
 const utils_1 = require("./utils");
 Object.defineProperty(exports, "setAppUrl", { enumerable: true, get: function () { return utils_1.setAppUrl; } });
 Object.defineProperty(exports, "getAppUrl", { enumerable: true, get: function () { return utils_1.getAppUrl; } });
+const config_1 = require("./config");
 /**
  * Initialization function for the AmplifyQuery library.
  *
@@ -60,6 +61,14 @@ function configure(config) {
     if (config.client) {
         (0, client_1.setClient)(config.client);
     }
+    // Set global model owner query mapping
+    if (config.modelOwnerQueryMap) {
+        (0, config_1.setModelOwnerQueryMap)(config.modelOwnerQueryMap);
+    }
+    // Set default auth mode
+    if (config.defaultAuthMode) {
+        (0, config_1.setDefaultAuthMode)(config.defaultAuthMode);
+    }
     // Apply React Query settings
     (0, query_1.configure)({
         isCachingEnabled: config.isCachingEnabled,
@@ -90,4 +99,10 @@ exports.AmplifyQuery = {
     Auth: utils_1.AuthService,
     getModelIds: singleton_1.getModelIds,
     getQueryClient: query_1.getQueryClient,
+    // Global configuration functions
+    setModelOwnerQueryMap: config_1.setModelOwnerQueryMap,
+    getModelOwnerQueryMap: config_1.getModelOwnerQueryMap,
+    setDefaultAuthMode: config_1.setDefaultAuthMode,
+    getDefaultAuthMode: config_1.getDefaultAuthMode,
+    resetConfig: config_1.resetConfig,
 };

package/dist/service.d.ts

@@ -2,8 +2,7 @@ import { AmplifyDataService, AuthMode, BaseModel } from "./types";
 /**
  * Create model-specific Amplify service
  * @param modelName Model name
- * @param queryMap Model-specific query name mapping (optional)
- * @param defaultAuthMode Default authentication mode (default: 'userPool')
+ * @param defaultAuthMode Default authentication mode (optional, uses global config if not provided)
  * @returns AmplifyDataService instance for the model
  */
-export declare function createAmplifyService<T extends BaseModel>(modelName: string, queryMap?: Record<string, string>, defaultAuthMode?: AuthMode): AmplifyDataService<T>;
+export declare function createAmplifyService<T extends BaseModel>(modelName: string, defaultAuthMode?: AuthMode): AmplifyDataService<T>;

package/dist/service.js

@@ -13,6 +13,7 @@ exports.createAmplifyService = createAmplifyService;
 const client_1 = require("./client");
 const query_1 = require("./query");
 const utils_1 = require("./utils");
+const config_1 = require("./config");
 const react_query_1 = require("@tanstack/react-query");
 const auth_1 = require("aws-amplify/auth");
 const expo_crypto_1 = require("expo-crypto");
@@ -169,13 +170,12 @@ function rollbackCache(queryClient, previousDataMap) {
 /**
  * Create model-specific Amplify service
  * @param modelName Model name
- * @param queryMap Model-specific query name mapping (optional)
- * @param defaultAuthMode Default authentication mode (default: 'userPool')
+ * @param defaultAuthMode Default authentication mode (optional, uses global config if not provided)
  * @returns AmplifyDataService instance for the model
  */
-function createAmplifyService(modelName, queryMap, defaultAuthMode = "userPool") {
-    // Track current authentication mode state
-    let currentAuthMode = defaultAuthMode;
+function createAmplifyService(modelName, defaultAuthMode) {
+    // Track current authentication mode state - use global config if not provided
+    let currentAuthMode = defaultAuthMode || (0, config_1.getDefaultAuthMode)();
     // Create service object
     const service = {
         // Add model name (needed for singleton services)
@@ -506,8 +506,8 @@ function createAmplifyService(modelName, queryMap, defaultAuthMode = "userPool")
                 const authMode = (options === null || options === void 0 ? void 0 : options.authMode) || currentAuthMode;
                 // Get owner and parameters based on auth mode
                 const { owner, authModeParams } = yield getOwnerByAuthMode(authMode);
-                // Get owner-based query name, use default format if not found
-                const ownerQueryName = (queryMap === null || queryMap === void 0 ? void 0 : queryMap[modelName]) || `list${modelName}sByOwner`;
+                // Get owner-based query name from global config
+                const ownerQueryName = (0, config_1.getOwnerQueryName)(modelName);
                 // Try query call
                 try {
                     console.log(`🍬 ${modelName} list API call`, queryKey, `by ${ownerQueryName}`, `[Auth: ${authMode}]`);

package/dist/types.d.ts

@@ -128,6 +128,7 @@ import { QueryClientConfig } from "@tanstack/react-query";
 export interface AmplifyQueryConfig {
     client: GraphQLClient;
     defaultAuthMode?: AuthMode;
+    modelOwnerQueryMap?: Record<string, string>;
     isCachingEnabled?: boolean;
     queryClientConfig?: QueryClientConfig;
     storage?: {

package/package.json

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