suparisma 1.2.2 → 1.2.3

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,36 @@ 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 IncludeInput = {
+  [key: string]: boolean | { select?: Record<string, boolean> };
+};
+
+export type SuparismaOptions<TWhereInput, TOrderByInput, TSelectInput = Record<string, boolean>> = {
   /** Whether to enable realtime updates (default: true) */
   realtime?: boolean;
   /** Custom channel name for realtime subscription */
@@ -184,6 +213,16 @@ 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?: IncludeInput;
 };
 
 /**
@@ -733,6 +772,82 @@ 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
+): 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)) {
+      if (relationValue === true) {
+        // Include all fields from the relation
+        parts.push(\`\${relationName}(*)\`);
+      } 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(\`\${relationName}(\${relationFields.join(',')})\`);
+          } else {
+            parts.push(\`\${relationName}(*)\`);
+          }
+        } else {
+          parts.push(\`\${relationName}(*)\`);
+        }
+      }
+    }
+  }
+  
+  // 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
  */
@@ -828,13 +943,19 @@ export function createSuparismaHook<
       orderBy,
       limit,
       offset,
+      select,
+      include,
     } = options;
     
+    // Build the select string once for reuse
+    const selectString = buildSelectString(select, include);
+    
     // 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);
 
     // Update refs whenever options change
     useEffect(() => {
@@ -853,6 +974,10 @@ export function createSuparismaHook<
       offsetRef.current = offset;
     }, [offset]);
 
+    useEffect(() => {
+      selectStringRef.current = selectString;
+    }, [selectString]);
+
     // Single data collection for holding results
     const [data, setData] = useState<TWithRelations[]>([]);
     const [error, setError] = useState<Error | null>(null);
@@ -1198,7 +1323,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 +1411,7 @@ export function createSuparismaHook<
         
         const { data, error } = await supabase
           .from(tableName)
-          .select('*')
+          .select(selectString)
           .eq(primaryKey, value)
           .maybeSingle();
         
@@ -1608,7 +1734,7 @@ export function createSuparismaHook<
     }, [realtime, channelName, tableName]); // 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,16 +1749,17 @@ 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(() => {
@@ -1756,7 +1883,7 @@ export function createSuparismaHook<
         const { data: result, error } = await supabase
           .from(tableName)
           .insert([itemWithDefaults])
-          .select();
+          .select(selectString);
         
         if (error) throw error;
         
@@ -1848,7 +1975,7 @@ export function createSuparismaHook<
           .from(tableName)
           .update(itemWithDefaults)
           .eq(primaryKey, value)
-          .select();
+          .select(selectString);
         
         if (error) throw error;
         
@@ -1903,7 +2030,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

@@ -42,6 +42,8 @@ import type {
   ${modelName}WhereInput,
   ${modelName}WhereUniqueInput,
   ${modelName}OrderByInput,
+  ${modelName}SelectInput,
+  ${modelName}IncludeInput,
   ${modelName}HookApi,
   Use${modelName}Options
 } from '../types/${modelName}Types';
@@ -92,6 +94,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,

package/dist/generators/typeGenerator.js

@@ -352,6 +352,40 @@ export type ${modelName}OrderByInput = {
   [key in keyof ${modelName}WithRelations]?: 'asc' | 'desc';
 };
 
+/**
+ * Select specific fields to return from ${modelName} queries.
+ * Set fields to \`true\` to include them in the response.
+ * 
+ * @example
+ * // Only return id and name
+ * ${modelName.toLowerCase()}.findMany({
+ *   select: { id: true, name: true }
+ * });
+ */
+export type ${modelName}SelectInput = {
+  [key in keyof ${modelName}WithRelations]?: boolean;
+};
+
+/**
+ * Include related records when querying ${modelName}.
+ * Set relation names to \`true\` to include all fields, or use an object to select specific fields.
+ * 
+ * @example
+ * // Include all fields from a relation
+ * ${modelName.toLowerCase()}.findMany({
+ *   include: { relatedModel: true }
+ * });
+ * 
+ * @example
+ * // Include specific fields from a relation
+ * ${modelName.toLowerCase()}.findMany({
+ *   include: { relatedModel: { select: { id: true, name: true } } }
+ * });
+ */
+export type ${modelName}IncludeInput = {
+  [key: string]: boolean | { select?: Record<string, boolean> };
+};
+
 /**
  * Result type for operations that return a single ${modelName} record.
  */
@@ -364,8 +398,12 @@ 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> & {
+  /** Include related records (foreign key relations) */
+  include?: ${modelName}IncludeInput;
+};
 
 /**
  * The complete API for interacting with ${modelName} records.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "suparisma",
-	"version": "1.2.2",
+	"version": "1.2.3",
 	"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": {