suparisma 0.0.2 → 0.0.4

package/dist/generators/supabaseClientGenerator.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateSupabaseClientFile = generateSupabaseClientFile;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
-const config_1 = require("../config"); // Assuming OUTPUT_DIR is defined in config.ts
+const config_1 = require("../config"); // Ensure this is UTILS_DIR
 function generateSupabaseClientFile() {
     const supabaseClientContent = `// THIS FILE IS AUTO-GENERATED - DO NOT EDIT DIRECTLY
 
@@ -19,10 +19,10 @@ export const supabase = createClient(
   process.env.NEXT_PUBLIC_SUPABASE_ANON_KEY!
 );
 `;
-    const outputPath = path_1.default.join(config_1.OUTPUT_DIR, 'supabase-client-generated.ts');
-    // Ensure the output directory exists
-    if (!fs_1.default.existsSync(config_1.OUTPUT_DIR)) {
-        fs_1.default.mkdirSync(config_1.OUTPUT_DIR, { recursive: true });
+    // Output to the UTILS_DIR
+    const outputPath = path_1.default.join(config_1.UTILS_DIR, 'supabase-client.ts');
+    if (!fs_1.default.existsSync(config_1.UTILS_DIR)) {
+        fs_1.default.mkdirSync(config_1.UTILS_DIR, { recursive: true });
     }
     fs_1.default.writeFileSync(outputPath, supabaseClientContent);
     console.log(`🚀 Generated Supabase client file at: ${outputPath}`);

package/dist/generators/typeGenerator.js

@@ -38,6 +38,9 @@ function generateModelTypesFile(model) {
     });
     // Extract searchable fields from annotations
     const searchFields = model.searchFields?.map((field) => field.name) || [];
+    // Find the actual field names for createdAt and updatedAt
+    const createdAtField = model.fields.find(field => field.isCreatedAt)?.name || 'createdAt';
+    const updatedAtField = model.fields.find(field => field.isUpdatedAt)?.name || 'updatedAt';
     // Create a manual property list for WithRelations interface
     const withRelationsProps = model.fields
         .filter((field) => !relationObjectFields.includes(field.name) && !foreignKeyFields.includes(field.name))
@@ -90,7 +93,7 @@ function generateModelTypesFile(model) {
 // Edit the generator script instead
 
 import type { ${modelName} } from '@prisma/client';
-import type { ModelResult, SuparismaOptions, SearchQuery, SearchState } from './core';
+import type { ModelResult, SuparismaOptions, SearchQuery, SearchState } from '../utils/core';
 
 /**
  * Extended ${modelName} type that includes relation fields.
@@ -288,6 +291,18 @@ export interface ${modelName}HookApi {
    */
   loading: boolean;
   
+  /**
+   * The current count of records matching the filter criteria.
+   * This automatically updates with the data, including realtime updates.
+   * It always reflects the current length of the data array, respecting any filters.
+   * 
+   * @example
+   * // Display the count in the UI
+   * const { count } = ${modelName.toLowerCase()};
+   * return <div>Total records: {count}</div>;
+   */
+  count: number;
+  
   ${searchFields.length > 0
         ? `/**
    * Search functionality for ${modelName} records.
@@ -507,26 +522,6 @@ ${createInputProps
     create: ${modelName}CreateInput;
   }) => ${modelName}SingleResult;
   
-  /**
-   * Count the number of ${modelName} records matching the filter criteria.
-   * 
-   * @param params - Optional filter parameters
-   * @returns A promise with the count of matching records
-   * 
-   * @example
-   * // Count all ${modelName.toLowerCase()} records
-   * const count = await ${modelName.toLowerCase()}.count();
-   * 
-   * @example
-   * // Count active ${modelName.toLowerCase()} records
-   * const activeCount = await ${modelName.toLowerCase()}.count({
-   *   where: { active: true }
-   * });
-   */
-  count: (params?: {
-    where?: ${modelName}WhereInput;
-  }) => Promise<number>;
-  
   /**
    * Manually refresh the data with current filter settings.
    * Useful after external operations or when realtime is disabled.
@@ -552,7 +547,10 @@ ${createInputProps
     skip?: number;
   }) => ${modelName}ManyResult;
 }`;
-    const outputPath = path_1.default.join(config_1.OUTPUT_DIR, `${modelName}Types.ts`);
+    const outputPath = path_1.default.join(config_1.TYPES_DIR, `${modelName}Types.ts`);
+    if (!fs_1.default.existsSync(config_1.TYPES_DIR)) {
+        fs_1.default.mkdirSync(config_1.TYPES_DIR, { recursive: true });
+    }
     fs_1.default.writeFileSync(outputPath, typeContent);
     console.log(`Generated type definitions for ${modelName} at ${outputPath}`);
     return {
@@ -562,5 +560,7 @@ ${createInputProps
         hasUpdatedAt: model.fields.some((field) => field.isUpdatedAt),
         searchFields,
         defaultValues: Object.keys(defaultValues).length > 0 ? defaultValues : undefined,
+        createdAtField,
+        updatedAtField
     };
 }

package/dist/index.js

@@ -39,12 +39,59 @@ const typeGenerator_1 = require("./generators/typeGenerator");
 const hookGenerator_1 = require("./generators/hookGenerator");
 const indexGenerator_1 = require("./generators/indexGenerator");
 const supabaseClientGenerator_1 = require("./generators/supabaseClientGenerator");
+/**
+ * Prints the help message showing available commands
+ */
+function printHelp() {
+    console.log(`
+Suparisma - Typesafe React realtime CRUD hooks generator for Supabase, powered by Prisma.
+
+Usage:
+  npx suparisma <command>
+
+Commands:
+  generate    Generate hooks based on your Prisma schema (runs in current directory)
+  help        Show this help message
+
+Example:
+  npx suparisma generate
+  `);
+}
+/**
+ * Checks for essential environment variables and throws an error if any are missing.
+ */
+function checkEnvironmentVariables() {
+    const requiredEnvVars = [
+        'DATABASE_URL',
+        'NEXT_PUBLIC_SUPABASE_URL',
+        'NEXT_PUBLIC_SUPABASE_ANON_KEY',
+    ];
+    const missingVars = requiredEnvVars.filter(varName => !process.env[varName]);
+    if (missingVars.length > 0) {
+        let errorMessage = 'Error: Missing required environment variables:\n';
+        missingVars.forEach(varName => {
+            errorMessage += `- ${varName}: This variable is essential for the generator to function correctly. `;
+            if (varName === 'DATABASE_URL') {
+                errorMessage += 'It is used by Prisma to connect to your database. Please ensure it is set in your .env file or as an environment variable (e.g., postgresql://user:password@host:port/database).\n';
+            }
+            else if (varName === 'NEXT_PUBLIC_SUPABASE_URL') {
+                errorMessage += 'This is your Supabase project URL. It is required by the Supabase client. Please set it in your .env file or as an environment variable (e.g., https://your-project-id.supabase.co).\n';
+            }
+            else if (varName === 'NEXT_PUBLIC_SUPABASE_ANON_KEY') {
+                errorMessage += 'This is your Supabase project public anonymous key. It is required by the Supabase client. Please set it in your .env file or as an environment variable.\n';
+            }
+        });
+        errorMessage += '\nPlease add these variables to your .env file or ensure they are available in your environment and try again.';
+        throw new Error(errorMessage);
+    }
+    console.log('✅ All required environment variables are set.');
+}
 function analyzePrismaSchema(schemaPath) {
     try {
         const schemaContent = fs_1.default.readFileSync(schemaPath, 'utf8');
         const modelInfos = [];
         // Regular expression to match model definitions with comments
-        const modelRegex = /(?:\/\/\s*@enableRealtime\s*)?\s*model\s+(\w+)\s*{([\s\S]*?)}/g;
+        const modelRegex = /(?:\/\/\s*@disableRealtime\s*)?\s*model\s+(\w+)\s*{([\s\S]*?)}/g;
         let modelMatch;
         while ((modelMatch = modelRegex.exec(schemaContent)) !== null) {
             const modelName = modelMatch[1];
@@ -56,8 +103,9 @@ function analyzePrismaSchema(schemaPath) {
             const tableName = modelMatch[0].includes('@map')
                 ? modelMatch[0].match(/@map\s*\(\s*["'](.+?)["']\s*\)/)?.at(1) || modelName
                 : modelName;
-            // Check if model has @enableRealtime comment
-            const enableRealtime = modelMatch[0].includes('// @enableRealtime');
+            // Check if model has @disableRealtime comment
+            // Default is to enable realtime unless explicitly disabled
+            const enableRealtime = !modelMatch[0].includes('// @disableRealtime');
             // Find fields with @enableSearch comment
             const searchFields = [];
             const fieldRegex = /(\w+)\s+(\w+)(?:\?.+?)?\s+(?:@.+?)?\s*(?:\/\/\s*@enableSearch)?/g;
@@ -86,7 +134,7 @@ function analyzePrismaSchema(schemaPath) {
 }
 /**
  * Configure database tables for proper realtime functionality and search
- * 1. Sets REPLICA IDENTITY FULL and enables realtime for models with @enableRealtime
+ * 1. Sets REPLICA IDENTITY FULL and enables realtime for all models (unless they have @disableRealtime)
  * 2. Creates search functions for fields with @enableSearch
  */
 async function configurePrismaTablesForSuparisma(schemaPath) {
@@ -98,8 +146,7 @@ async function configurePrismaTablesForSuparisma(schemaPath) {
         // Get direct PostgreSQL connection URL
         const directUrl = process.env.DIRECT_URL;
         if (!directUrl) {
-            console.warn('⚠️ DIRECT_URL environment variable not found. Skipping database configuration.');
-            return;
+            throw new Error('❌ Error: DIRECT_URL environment variable not found. This is required for database configuration (e.g., setting up realtime). Please define it in your .env file or as an environment variable and try again. This should be a direct PostgreSQL connection string.\n');
         }
         // Analyze Prisma schema for models, realtime and search annotations
         const modelInfos = analyzePrismaSchema(schemaPath);
@@ -129,6 +176,7 @@ async function configurePrismaTablesForSuparisma(schemaPath) {
                 // Use the exact case of the table as it exists in the database
                 const actualTableName = matchingTable.table_name;
                 console.log(`🔍 Model ${model.name} -> Actual table: ${actualTableName}`);
+                console.log(`ℹ️ Model ${model.name}: enableRealtime is ${model.enableRealtime}`);
                 if (model.enableRealtime) {
                     // Explicitly use double quotes for mixed case identifiers
                     // try {
@@ -138,10 +186,10 @@ async function configurePrismaTablesForSuparisma(schemaPath) {
                     //   console.error(`❌ Failed to set REPLICA IDENTITY on "${actualTableName}": ${err.message}`);
                     // }
                     // Directly add the table to Supabase Realtime publication
+                    const alterPublicationQuery = `ALTER PUBLICATION supabase_realtime ADD TABLE "${actualTableName}";`;
+                    console.log(`ℹ️ Executing SQL: ${alterPublicationQuery}`);
                     try {
-                        await pool.query(`
-              ALTER PUBLICATION supabase_realtime ADD TABLE "${actualTableName}";
-            `);
+                        await pool.query(alterPublicationQuery);
                         console.log(`✅ Added "${actualTableName}" to supabase_realtime publication`);
                     }
                     catch (err) {
@@ -150,7 +198,7 @@ async function configurePrismaTablesForSuparisma(schemaPath) {
                             console.log(`ℹ️ Table "${actualTableName}" was already in supabase_realtime publication`);
                         }
                         else {
-                            console.error(`❌ Failed to add "${actualTableName}" to supabase_realtime: ${err.message}`);
+                            console.error(`❌ Failed to add "${actualTableName}" to supabase_realtime. Full error:`, err);
                         }
                     }
                 }
@@ -222,38 +270,68 @@ async function configurePrismaTablesForSuparisma(schemaPath) {
     }
 }
 /**
- * Main execution function
+ * Main execution function for hook generation
  */
-async function main() {
+async function generateHooks() {
     try {
-        console.log('Generating Supabase realtime hooks with improved architecture...');
-        // Ensure output directory exists
-        if (!fs_1.default.existsSync(config_1.OUTPUT_DIR)) {
-            fs_1.default.mkdirSync(config_1.OUTPUT_DIR, { recursive: true });
+        console.log('🚀 Starting Suparisma hook generation...');
+        checkEnvironmentVariables();
+        console.log(`Prisma schema path: ${config_1.PRISMA_SCHEMA_PATH}`);
+        console.log(`Output directory: ${config_1.OUTPUT_DIR}`);
+        // Delete the entire output directory if it exists to clean up any stale files
+        if (fs_1.default.existsSync(config_1.OUTPUT_DIR)) {
+            console.log(`🧹 Cleaning up previous generated files in ${config_1.OUTPUT_DIR}...`);
+            fs_1.default.rmSync(config_1.OUTPUT_DIR, { recursive: true, force: true });
+            console.log(`✅ Removed previous generated directory`);
         }
-        // Generate Supabase client file first
+        // Ensure all specific output directories exist, OUTPUT_DIR is the root and will be created if needed by sub-creations.
+        const dirsToEnsure = [config_1.TYPES_DIR, config_1.HOOKS_DIR, config_1.UTILS_DIR];
+        dirsToEnsure.forEach(dir => {
+            if (!fs_1.default.existsSync(dir)) {
+                fs_1.default.mkdirSync(dir, { recursive: true });
+                console.log(`Created directory: ${dir}`);
+            }
+        });
+        // Generate Supabase client file (goes to UTILS_DIR)
         (0, supabaseClientGenerator_1.generateSupabaseClientFile)();
-        // First, generate the core hook factory
+        // Generate the core hook factory (goes to UTILS_DIR)
         (0, coreGenerator_1.generateCoreFile)();
-        // Parse models from Prisma schema
         const models = (0, parser_1.parsePrismaSchema)(config_1.PRISMA_SCHEMA_PATH);
-        // Configure database tables for real-time and search functionality
         await configurePrismaTablesForSuparisma(config_1.PRISMA_SCHEMA_PATH);
-        // Generate type definitions and hooks for each model
         const modelInfos = [];
         for (const model of models) {
             const modelInfo = (0, typeGenerator_1.generateModelTypesFile)(model);
             (0, hookGenerator_1.generateModelHookFile)(modelInfo);
             modelInfos.push(modelInfo);
         }
-        // Generate the main module file
         (0, indexGenerator_1.generateMainIndexFile)(modelInfos);
-        console.log('✅ Successfully generated all suparisma hooks!');
+        console.log(`✅ Successfully generated all suparisma hooks and types in "${config_1.OUTPUT_DIR}"!`);
     }
     catch (error) {
         console.error('❌ Error generating hooks:', error);
         process.exit(1);
     }
 }
-// Execute main function
-main();
+/**
+ * Main CLI entry point
+ */
+function run() {
+    const args = process.argv.slice(2);
+    const command = args[0];
+    switch (command) {
+        case 'generate':
+            generateHooks();
+            break;
+        case 'help':
+        case '--help':
+        case '-h':
+            printHelp();
+            break;
+        default:
+            console.log(`Unknown command: ${command}`);
+            printHelp();
+            process.exit(1);
+    }
+}
+// Execute the CLI command
+run();

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "suparisma",
-	"version": "0.0.2",
+	"version": "0.0.4",
 	"description": "Opinionated typesafe React realtime CRUD hooks generator for all your Supabase tables, powered by Prisma.",
 	"main": "dist/index.js",
 	"scripts": {
@@ -8,8 +8,21 @@
 		"start": "node dist/index.js",
 		"test": "jest",
 		"generate-prisma-types": "prisma generate",
-		"generate-hooks": "ts-node --transpile-only src/index.ts"
+		"generate-hooks-dev": "npx prisma generate && npx prisma db push && ts-node --transpile-only src/index.ts generate",
+		"run-next-example": "cd src/examples/with-next && npm run dev"
 	},
+	"bin": {
+		"suparisma": "dist/index.js"
+	},
+	"keywords": [
+		"react",
+		"hooks",
+		"supabase",
+		"prisma",
+		"typescript",
+		"nextjs",
+		"realtime"
+	],
 	"dependencies": {
 		"@supabase/supabase-js": "^2.49.4",
 		"dotenv": "^16.5.0",

package/prisma/schema.prisma

@@ -1,4 +1,4 @@
-// This is your Prisma schema file,
+// This is a sample Prisma schema file,
 // learn more about it in the docs: https://pris.ly/d/prisma-schema
 
 // Looking for ways to speed up your queries, or scale easily with your serverless or edge functions?
@@ -13,10 +13,26 @@ datasource db {
   url      = env("DATABASE_URL")
 }
 
-model User {
+enum SomeEnum {
+  ONE
+  TWO
+  THREE
+}
+
+// Realtime is enabled by default for all models
+model Thing {
   id        String   @id @default(uuid())
-  email     String   @unique
   name      String?
+  someEnum  SomeEnum @default(ONE)
+  someNumber Int?
   createdAt DateTime @default(now())
   updatedAt DateTime @updatedAt
 }
+
+// @disableRealtime
+model AuditLog {
+  id        String   @id @default(uuid())
+  action    String
+  details   String?
+  createdAt DateTime @default(now())
+}

package/tsconfig.json

@@ -16,5 +16,5 @@
     "jsx": "preserve"
   },
   "include": ["src/**/*", "../src/app/**/*.ts"],
-  "exclude": ["node_modules", "**/*.spec.ts"]
+  "exclude": ["node_modules", "**/*.spec.ts", "src/examples/**/*"]
 }

package/src/config.ts

@@ -1,7 +0,0 @@
-// Configuration
-export const PRISMA_SCHEMA_PATH = process.env.SUPARISMA_PRISMA_SCHEMA_PATH || 'prisma/schema.prisma';
-export const OUTPUT_DIR = process.env.SUPARISMA_OUTPUT_DIR || 'src/suparisma/generated';
-export const TYPES_DIR = `${OUTPUT_DIR}/types`;
-export const HOOKS_DIR = `${OUTPUT_DIR}/hooks`;
-export const UTILS_DIR = `${OUTPUT_DIR}/utils`;
-export const HOOK_NAME_PREFIX = 'useSuparisma';