suparisma 1.2.2 → 1.2.6

package/README.md

@@ -26,6 +26,8 @@ A powerful, typesafe React hook generator for Supabase, driven by your Prisma sc
   - [Array Filtering](#array-filtering)
   - [Sorting Data](#sorting-data)
   - [Pagination](#pagination)
+  - [Field Selection (select)](#field-selection-select)
+  - [Including Relations (include)](#including-relations-include)
   - [Search Functionality](#search-functionality)
     - [Enabling Search](#enabling-search)
     - [Search Methods](#search-methods)
@@ -733,6 +735,53 @@ const { data: page2 } = useSuparisma.thing({
 const { data, count } = useSuparisma.thing();
 ```
 
+### Field Selection (select)
+
+Use the `select` option to only return specific fields, reducing payload size:
+
+```tsx
+// Only get id and name fields
+const { data: things } = useSuparisma.thing({
+  select: { id: true, name: true }
+});
+// Returns: [{ id: "123", name: "Thing 1" }, ...]
+
+// Combine with filtering
+const { data: activeThings } = useSuparisma.thing({
+  where: { someEnum: "ONE" },
+  select: { id: true, name: true, someNumber: true }
+});
+```
+
+### Including Relations (include)
+
+Use the `include` option to fetch related records (foreign key relations):
+
+```tsx
+// Include all fields from a related model
+const { data: posts } = useSuparisma.post({
+  include: { author: true }
+});
+// Returns: [{ id: "123", title: "...", author: { id: "456", name: "John" } }, ...]
+
+// Include specific fields from a relation
+const { data: posts } = useSuparisma.post({
+  include: { 
+    author: { 
+      select: { id: true, name: true } 
+    } 
+  }
+});
+
+// Combine select and include
+const { data: posts } = useSuparisma.post({
+  select: { id: true, title: true },
+  include: { author: true, comments: true }
+});
+```
+
+**Note:** The relation names in `include` should match your Prisma schema relation field names.
+
 ### Search Functionality
 
 Suparisma provides powerful PostgreSQL full-text search capabilities with automatic RPC function generation and type-safe search methods. Search is enabled per field using annotations in your Prisma schema.
@@ -1525,8 +1574,8 @@ const { data } = useSuparisma.thing({
 | `limit` | `number` | Maximum number of records to return |
 | `offset` | `number` | Number of records to skip for pagination |
 | `realtime` | `boolean` | Enable/disable real-time updates |
-| `select` | `object` | Fields to include in the response |
-| `include` | `object` | Related records to include |
+| `select` | `object` | Fields to include in the response. Use `{ fieldName: true }` syntax |
+| `include` | `object` | Related records to include. Use `{ relationName: true }` or `{ relationName: { select: {...} } }` |
 | `search` | `object` | Full-text search configuration |
 
 ### Hook Return Value

package/dist/generators/coreGenerator.js

@@ -169,7 +169,39 @@ export type AdvancedWhereInput<T> = {
  *   limit: 10
  * });
  */
-export type SuparismaOptions<TWhereInput, TOrderByInput> = {
+/**
+ * Select input type - specify which fields to return
+ * Use true to include a field, or use an object for relations
+ * @example
+ * // Select specific fields
+ * { id: true, name: true, email: true }
+ * 
+ * @example
+ * // Select fields with relations
+ * { id: true, name: true, posts: true }
+ */
+export type SelectInput<T> = {
+  [K in keyof T]?: boolean;
+};
+
+/**
+ * Include input type - specify which relations to include
+ * @example
+ * // Include a relation with all fields
+ * { posts: true }
+ * 
+ * @example
+ * // Include a relation with specific fields
+ * { posts: { select: { id: true, title: true } } }
+ */
+export type IncludeValue = boolean | { select?: Record<string, boolean> };
+
+export type SuparismaOptions<
+  TWhereInput,
+  TOrderByInput,
+  TSelectInput = Record<string, boolean>,
+  TIncludeInput = Record<never, never>
+> = {
   /** Whether to enable realtime updates (default: true) */
   realtime?: boolean;
   /** Custom channel name for realtime subscription */
@@ -184,6 +216,23 @@ export type SuparismaOptions<TWhereInput, TOrderByInput> = {
   limit?: number;
   /** Offset for pagination (skip records) */
   offset?: number;
+  /** 
+   * Select specific fields to return. Reduces payload size.
+   * @example { id: true, name: true, email: true }
+   */
+  select?: TSelectInput;
+  /**
+   * Include related records (foreign key relations).
+   * @example { posts: true } or { posts: { select: { id: true, title: true } } }
+   */
+  include?: TIncludeInput;
+  /**
+   * Whether to enable the hook (default: true).
+   * When false, the hook will not fetch data or set up realtime subscriptions.
+   * Useful for conditional fetching, e.g., waiting for auth/user data to be ready.
+   * @example enabled: !!user?.id
+   */
+  enabled?: boolean;
 };
 
 /**
@@ -733,6 +782,90 @@ function matchesFilter<T>(record: any, filter: T): boolean {
   return conditions.every(condition => condition);
 }
 
+/**
+ * Build a Supabase select string from select and include options.
+ * 
+ * @param select - Object specifying which fields to select { field: true }
+ * @param include - Object specifying which relations to include { relation: true }
+ * @returns A Supabase-compatible select string
+ * 
+ * @example
+ * // Select specific fields
+ * buildSelectString({ id: true, name: true }) // Returns "id,name"
+ * 
+ * @example
+ * // Include relations
+ * buildSelectString(undefined, { posts: true }) // Returns "*,posts(*)"
+ * 
+ * @example
+ * // Select fields and include relations with specific fields
+ * buildSelectString({ id: true, name: true }, { posts: { select: { id: true, title: true } } })
+ * // Returns "id,name,posts(id,title)"
+ */
+export function buildSelectString<TSelect, TInclude>(
+  select?: TSelect,
+  include?: TInclude,
+  relationMappings?: Record<string, string>
+): string {
+  const parts: string[] = [];
+  
+  // Handle select - if provided, only return specified fields
+  if (select && typeof select === 'object') {
+    const selectedFields = Object.entries(select)
+      .filter(([_, value]) => value === true)
+      .map(([key]) => key);
+    
+    if (selectedFields.length > 0) {
+      parts.push(...selectedFields);
+    }
+  }
+  
+  // Handle include - add related records
+  if (include && typeof include === 'object') {
+    for (const [relationName, relationValue] of Object.entries(include)) {
+      const relatedTableName = relationMappings?.[relationName] || relationName;
+      // If mapping exists, use PostgREST alias syntax: alias:foreignTable(...)
+      const embedName =
+        relationMappings?.[relationName] && relatedTableName !== relationName
+          ? \`\${relationName}:\${relatedTableName}\`
+          : relationName;
+
+      if (relationValue === true) {
+        // Include all fields from the relation
+        parts.push(\`\${embedName}(*)\`);
+      } else if (typeof relationValue === 'object' && relationValue !== null) {
+        // Include specific fields from the relation
+        const relationOptions = relationValue as { select?: Record<string, boolean> };
+        if (relationOptions.select) {
+          const relationFields = Object.entries(relationOptions.select)
+            .filter(([_, value]) => value === true)
+            .map(([key]) => key);
+          
+          if (relationFields.length > 0) {
+            parts.push(\`\${embedName}(\${relationFields.join(',')})\`);
+          } else {
+            parts.push(\`\${embedName}(*)\`);
+          }
+        } else {
+          parts.push(\`\${embedName}(*)\`);
+        }
+      }
+    }
+  }
+  
+  // If no select specified but include is, we need to include base table fields too
+  if (parts.length === 0) {
+    return '*';
+  }
+  
+  // If only include was specified (no select), we need all base fields plus relations
+  if (!select && include) {
+    return '*,' + parts.join(',');
+  }
+  
+  return parts.join(',');
+}
+
 /**
  * Apply order by to the query builder
  */
@@ -789,6 +922,7 @@ export function createSuparismaHook<
   defaultValues?: Record<string, string>;
   createdAtField?: string;
   updatedAtField?: string;
+  relationMappings?: Record<string, string>;
 }) {
   const { 
     tableName, 
@@ -797,7 +931,8 @@ export function createSuparismaHook<
     searchFields = [], 
     defaultValues = {},
     createdAtField = 'createdAt',
-    updatedAtField = 'updatedAt'
+    updatedAtField = 'updatedAt',
+    relationMappings = {}
   } = config;
   
   /**
@@ -828,13 +963,21 @@ export function createSuparismaHook<
       orderBy,
       limit,
       offset,
+      select,
+      include,
+      enabled = true,
     } = options;
     
+    // Build the select string once for reuse
+    const selectString = buildSelectString(select, include, relationMappings);
+    
     // Refs to store the latest options for realtime handlers
     const whereRef = useRef(where);
     const orderByRef = useRef(orderBy);
     const limitRef = useRef(limit);
     const offsetRef = useRef(offset);
+    const selectStringRef = useRef(selectString);
+    const enabledRef = useRef(enabled);
 
     // Update refs whenever options change
     useEffect(() => {
@@ -853,6 +996,14 @@ export function createSuparismaHook<
       offsetRef.current = offset;
     }, [offset]);
 
+    useEffect(() => {
+      selectStringRef.current = selectString;
+    }, [selectString]);
+
+    useEffect(() => {
+      enabledRef.current = enabled;
+    }, [enabled]);
+
     // Single data collection for holding results
     const [data, setData] = useState<TWithRelations[]>([]);
     const [error, setError] = useState<Error | null>(null);
@@ -873,7 +1024,8 @@ export function createSuparismaHook<
     // Function to fetch the total count from Supabase with current filters
     const fetchTotalCount = useCallback(async () => {
       try {
-        // Skip count updates during search
+        // Skip count updates when disabled or during search
+        if (!enabledRef.current) return;
         if (isSearchingRef.current) return;
         
         let countQuery = supabase.from(tableName).select('*', { count: 'exact', head: true });
@@ -1198,7 +1350,8 @@ export function createSuparismaHook<
         setLoading(true);
         setError(null);
         
-        let query = supabase.from(tableName).select('*');
+        // Use selectString for field selection (includes relations if specified)
+        let query = supabase.from(tableName).select(selectString);
         
         // Apply where conditions if provided
         if (params?.where) {
@@ -1285,7 +1438,7 @@ export function createSuparismaHook<
         
         const { data, error } = await supabase
           .from(tableName)
-          .select('*')
+          .select(selectString)
           .eq(primaryKey, value)
           .maybeSingle();
         
@@ -1303,7 +1456,8 @@ export function createSuparismaHook<
 
         // Set up realtime subscription for the list - ONCE and listen to ALL events
     useEffect(() => {
-      if (!realtime) return;
+      // Skip subscription if not enabled or realtime is off
+      if (!enabled || !realtime) return;
       
       // Clean up previous subscription if it exists
       if (channelRef.current) {
@@ -1605,10 +1759,10 @@ export function createSuparismaHook<
           searchTimeoutRef.current = null;
         }
       };
-    }, [realtime, channelName, tableName]); // NEVER include 'where' - subscription should persist
+    }, [realtime, channelName, tableName, enabled]); // NEVER include 'where' - subscription should persist
 
     // Create a memoized options object to prevent unnecessary re-renders
-    const optionsRef = useRef({ where, orderBy, limit, offset });
+    const optionsRef = useRef({ where, orderBy, limit, offset, selectString });
     
     // Compare current options with previous options
     const optionsChanged = useCallback(() => {
@@ -1623,19 +1777,26 @@ export function createSuparismaHook<
         whereStr !== prevWhereStr ||
         orderByStr !== prevOrderByStr ||
         limit !== optionsRef.current.limit ||
-        offset !== optionsRef.current.offset;
+        offset !== optionsRef.current.offset ||
+        selectString !== optionsRef.current.selectString;
       
       if (hasChanged) {
         // Update the ref with the new values
-        optionsRef.current = { where, orderBy, limit, offset };
+        optionsRef.current = { where, orderBy, limit, offset, selectString };
         return true;
       }
       
       return false;
-    }, [where, orderBy, limit, offset]);
+    }, [where, orderBy, limit, offset, selectString]);
 
     // Load initial data and refetch when options change (BUT NEVER TOUCH SUBSCRIPTION)
     useEffect(() => {
+      // Skip fetching if not enabled
+      if (!enabled) {
+        setLoading(false); // Don't show loading spinner when disabled
+        return;
+      }
+      
       // Skip if search is active
       if (isSearchingRef.current) return;
       
@@ -1668,7 +1829,31 @@ export function createSuparismaHook<
       
       // Initial count fetch
       fetchTotalCount();
-    }, [findMany, where, orderBy, limit, offset, optionsChanged, fetchTotalCount]);
+    }, [findMany, where, orderBy, limit, offset, optionsChanged, fetchTotalCount, enabled]);
+
+    // Track previous enabled state to detect changes from false to true
+    const prevEnabledRef = useRef(enabled);
+    
+    // Fetch when enabled changes from false to true
+    useEffect(() => {
+      const wasDisabled = !prevEnabledRef.current;
+      const isNowEnabled = enabled;
+      
+      // Update the previous value
+      prevEnabledRef.current = enabled;
+      
+      // If we just became enabled and have already done initial load, refetch
+      if (wasDisabled && isNowEnabled && initialLoadRef.current) {
+        console.log(\`Hook enabled for \${tableName}, fetching data\`);
+        findMany({
+          where,
+          orderBy,
+          take: limit,
+          skip: offset
+        });
+        fetchTotalCount();
+      }
+    }, [enabled, findMany, where, orderBy, limit, offset, fetchTotalCount]);
 
     /**
      * Create a new record with the provided data.
@@ -1756,7 +1941,7 @@ export function createSuparismaHook<
         const { data: result, error } = await supabase
           .from(tableName)
           .insert([itemWithDefaults])
-          .select();
+          .select(selectString);
         
         if (error) throw error;
         
@@ -1848,7 +2033,7 @@ export function createSuparismaHook<
           .from(tableName)
           .update(itemWithDefaults)
           .eq(primaryKey, value)
-          .select();
+          .select(selectString);
         
         if (error) throw error;
         
@@ -1903,7 +2088,7 @@ export function createSuparismaHook<
         // First fetch the record to return it
         const { data: recordToDelete } = await supabase
           .from(tableName)
-          .select('*')
+          .select(selectString)
           .eq(primaryKey, value)
           .maybeSingle();
         

package/dist/generators/hookGenerator.js

@@ -16,7 +16,7 @@ const config_1 = require("../config");
  * @param modelInfo - Processed model information with metadata
  */
 function generateModelHookFile(modelInfo) {
-    const { modelName, tableName, hasCreatedAt, hasUpdatedAt, searchFields, defaultValues, createdAtField = 'createdAt', // Default to camelCase but use actual field name if provided
+    const { modelName, tableName, hasCreatedAt, hasUpdatedAt, searchFields, defaultValues, relationMappings, createdAtField = 'createdAt', // Default to camelCase but use actual field name if provided
     updatedAtField = 'updatedAt' // Default to camelCase but use actual field name if provided
      } = modelInfo;
     // Configure search fields if available
@@ -29,6 +29,10 @@ function generateModelHookFile(modelInfo) {
         : '';
     // Add createdAt/updatedAt field name config
     const fieldNamesConfig = `${hasCreatedAt ? `,\n  // Field name for createdAt from Prisma schema\n  createdAtField: "${createdAtField}"` : ''}${hasUpdatedAt ? `,\n  // Field name for updatedAt from Prisma schema\n  updatedAtField: "${updatedAtField}"` : ''}`;
+    // Relation mappings config (Prisma relation field -> related table name for PostgREST embedding)
+    const relationMappingsConfig = relationMappings && Object.keys(relationMappings).length > 0
+        ? `,\n  // Relation mappings for PostgREST embedding\n  relationMappings: ${JSON.stringify(relationMappings)}`
+        : '';
     // Generate the hook content
     const hookContent = `// THIS FILE IS AUTO-GENERATED - DO NOT EDIT DIRECTLY
 // Edit the generator script instead: scripts/generate-realtime-hooks.ts
@@ -42,6 +46,8 @@ import type {
   ${modelName}WhereInput,
   ${modelName}WhereUniqueInput,
   ${modelName}OrderByInput,
+  ${modelName}SelectInput,
+  ${modelName}IncludeInput,
   ${modelName}HookApi,
   Use${modelName}Options
 } from '../types/${modelName}Types';
@@ -92,6 +98,18 @@ import type {
  *   orderBy: { // ordering },
  *   take: 20 // limit
  * });
+ * 
+ * @example
+ * // Select specific fields only
+ * const ${modelName.toLowerCase()} = ${config_1.HOOK_NAME_PREFIX}${modelName}({
+ *   select: { id: true, name: true }
+ * });
+ * 
+ * @example
+ * // Include related records
+ * const ${modelName.toLowerCase()} = ${config_1.HOOK_NAME_PREFIX}${modelName}({
+ *   include: { relatedModel: true }
+ * });
  */
 export const ${config_1.HOOK_NAME_PREFIX}${modelName} = createSuparismaHook<
   ${modelName}WithRelations,
@@ -104,7 +122,7 @@ export const ${config_1.HOOK_NAME_PREFIX}${modelName} = createSuparismaHook<
 >({
   tableName: '${tableName}',
   hasCreatedAt: ${hasCreatedAt},
-  hasUpdatedAt: ${hasUpdatedAt}${searchConfig}${defaultValuesConfig}${fieldNamesConfig}
+  hasUpdatedAt: ${hasUpdatedAt}${searchConfig}${defaultValuesConfig}${fieldNamesConfig}${relationMappingsConfig}
 }) as unknown as (options?: Use${modelName}Options) => ${modelName}HookApi;
 `;
     // Output to the HOOKS_DIR

package/dist/generators/typeGenerator.js

@@ -10,7 +10,7 @@ const config_1 = require("../config");
 /**
  * Generate model-specific types for a model
  */
-function generateModelTypesFile(model) {
+function generateModelTypesFile(model, modelNameToTableName = {}) {
     const modelName = model.name || '';
     const tableName = model.mappedName || modelName;
     // Identify foreign key fields (these end with _id)
@@ -21,6 +21,13 @@ function generateModelTypesFile(model) {
     const relationObjectFields = model.fields
         .filter((field) => field.isRelation && !foreignKeyFields.includes(field.name))
         .map((field) => field.name);
+    // Collect relation fields with their target model types (for include + WithRelations typing)
+    const relationFields = model.fields.filter((field) => relationObjectFields.includes(field.name) && field.type !== modelName);
+    // Map relation field name -> actual related table name (for PostgREST embedding)
+    const relationMappings = {};
+    for (const rel of relationFields) {
+        relationMappings[rel.name] = modelNameToTableName[rel.type] || rel.type;
+    }
     // Fields that have default values (should be optional in CreateInput)
     const defaultValueFields = model.fields
         .filter((field) => field.hasDefaultValue)
@@ -82,7 +89,7 @@ function generateModelTypesFile(model) {
     };
     // Create a manual property list for WithRelations interface
     const withRelationsProps = model.fields
-        .filter((field) => !relationObjectFields.includes(field.name) && !foreignKeyFields.includes(field.name))
+        .filter((field) => !relationObjectFields.includes(field.name))
         .map((field) => {
         const isOptional = field.isOptional;
         const finalType = getFieldType(field);
@@ -95,6 +102,20 @@ function generateModelTypesFile(model) {
             withRelationsProps.push(`  ${field}${fieldInfo.isOptional ? '?' : ''}: ${fieldInfo.type === 'Int' ? 'number' : 'string'};`);
         }
     });
+    // Add relation object fields as OPTIONAL (only present when included via include/select)
+    relationFields.forEach((field) => {
+        const relatedModel = field.type;
+        const relatedType = field.isList
+            ? `${relatedModel}WithRelations[]`
+            : `${relatedModel}WithRelations${field.isOptional ? ' | null' : ''}`;
+        withRelationsProps.push(`  ${field.name}?: ${relatedType};`);
+    });
+    // Build type-only imports for related model types (to type relations and include.select)
+    const relatedModelImports = Array.from(new Set(relationFields.map((f) => f.type).filter((t) => t && t !== modelName)));
+    // Note: We can't import multiple files in one statement. We'll generate one per model below.
+    const relationTypeImportStatements = relatedModelImports
+        .map((m) => `import type { ${m}WithRelations, ${m}SelectInput } from './${m}Types';`)
+        .join('\n');
     // Create a manual property list for CreateInput
     const createInputProps = model.fields
         .filter((field) => !relationObjectFields.includes(field.name) &&
@@ -142,7 +163,8 @@ function generateModelTypesFile(model) {
 // Edit the generator script instead
 
 ${customImports}import type { ${modelName} } from '@prisma/client';
-import type { ModelResult, SuparismaOptions, SearchQuery, SearchState, FilterOperators } from '../utils/core';
+import type { ModelResult, SuparismaOptions, SearchQuery, SearchState, FilterOperators, IncludeValue } from '../utils/core';
+${relationTypeImportStatements}
 
 /**
  * Extended ${modelName} type that includes relation fields.
@@ -349,7 +371,28 @@ export type ${modelName}WhereUniqueInput = {
  * });
  */
 export type ${modelName}OrderByInput = {
-  [key in keyof ${modelName}WithRelations]?: 'asc' | 'desc';
+  [key in keyof ${modelName}SelectInput]?: 'asc' | 'desc';
+};
+
+/**
+ * Select specific scalar fields to return from ${modelName} queries.
+ * Relation fields are intentionally excluded; use \`include\` for relations.
+ */
+export type ${modelName}SelectInput = {
+  ${model.fields
+        .filter((f) => !relationObjectFields.includes(f.name))
+        .map((f) => `  ${f.name}?: boolean;`)
+        .join('\n')}
+};
+
+/**
+ * Include related records when querying ${modelName}.
+ * Only real Prisma relation fields are allowed here.
+ */
+export type ${modelName}IncludeInput = {
+  ${relationFields
+        .map((f) => `  ${f.name}?: IncludeValue | { select?: ${f.type}SelectInput };`)
+        .join('\n')}
 };
 
 /**
@@ -364,8 +407,14 @@ export type ${modelName}ManyResult = ModelResult<${modelName}WithRelations[]>;
 
 /**
  * Configuration options for the ${modelName} hook.
+ * Includes where filters, ordering, pagination, and field selection.
  */
-export type Use${modelName}Options = SuparismaOptions<${modelName}WhereInput, ${modelName}OrderByInput>;
+export type Use${modelName}Options = SuparismaOptions<
+  ${modelName}WhereInput,
+  ${modelName}OrderByInput,
+  ${modelName}SelectInput,
+  ${modelName}IncludeInput
+>;
 
 /**
  * The complete API for interacting with ${modelName} records.
@@ -688,6 +737,7 @@ ${createInputProps
         defaultValues: Object.keys(defaultValues).length > 0 ? defaultValues : undefined,
         createdAtField,
         updatedAtField,
+        relationMappings: Object.keys(relationMappings).length > 0 ? relationMappings : undefined,
         zodImports: model.zodImports // Pass through zod imports
     };
 }

package/dist/index.js

@@ -484,9 +484,14 @@ async function generateHooks() {
         (0, coreGenerator_1.generateCoreFile)();
         const models = (0, parser_1.parsePrismaSchema)(config_1.PRISMA_SCHEMA_PATH);
         await configurePrismaTablesForSuparisma(config_1.PRISMA_SCHEMA_PATH);
+        // Map Prisma model name -> actual table name (respects @@map)
+        const modelNameToTableName = {};
+        for (const m of models) {
+            modelNameToTableName[m.name] = m.mappedName || m.name;
+        }
         const modelInfos = [];
         for (const model of models) {
-            const modelInfo = (0, typeGenerator_1.generateModelTypesFile)(model);
+            const modelInfo = (0, typeGenerator_1.generateModelTypesFile)(model, modelNameToTableName);
             (0, hookGenerator_1.generateModelHookFile)(modelInfo);
             modelInfos.push(modelInfo);
         }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "suparisma",
-	"version": "1.2.2",
+	"version": "1.2.6",
 	"description": "Opinionated typesafe React realtime CRUD hooks generator for all your Supabase tables, powered by Prisma. Works with Next.js, Remix, React Native, and Expo.",
 	"main": "dist/index.js",
 	"repository": {