suparisma 0.0.3 → 1.0.0

package/dist/generators/coreGenerator.js

@@ -680,7 +680,7 @@ export function createSuparismaHook<
         }
         
         // Apply offset if provided (for pagination)
-        if (params?.skip) {
+        if (params?.skip !== undefined && params.skip >= 0) {
           query = query.range(params.skip, params.skip + (params.take || 10) - 1);
         }
         

package/generated/hooks/useSuparismaAuditLog.ts

@@ -0,0 +1,80 @@
+// THIS FILE IS AUTO-GENERATED - DO NOT EDIT DIRECTLY
+// Edit the generator script instead: scripts/generate-realtime-hooks.ts
+
+// Corrected import for core hook factory
+import { createSuparismaHook } from '../utils/core';
+import type {
+  AuditLogWithRelations,
+  AuditLogCreateInput,
+  AuditLogUpdateInput,
+  AuditLogWhereInput,
+  AuditLogWhereUniqueInput,
+  AuditLogOrderByInput,
+  AuditLogHookApi,
+  UseAuditLogOptions
+} from '../types/AuditLogTypes';
+
+/**
+ * A Prisma-like hook for interacting with AuditLog records with real-time capabilities.
+ * 
+ * This hook provides CRUD operations, real-time updates, and search functionality.
+ *
+ * @param options - Optional configuration options for the hook
+ * @returns An object with data state and methods for interacting with AuditLog records
+ * 
+ * @example
+ * // Basic usage - get all AuditLog records with realtime updates
+ * const auditlog = useSuparismaAuditLog();
+ * const { data, loading, error } = auditlog;
+ * 
+ * @example
+ * // With filtering and ordering
+ * const auditlog = useSuparismaAuditLog({
+ *   where: { active: true },
+ *   orderBy: { createdAt: 'desc' }, // Note: Using actual Prisma field name
+ *   limit: 10
+ * });
+ * 
+ * @example
+ * // Create a new record
+ * const result = await auditlog.create({
+ *   name: "Example Name",
+ *   // other fields...
+ * });
+ * 
+ * @example
+ * // Update a record
+ * const result = await auditlog.update({
+ *   where: { id: "123" },
+ *   data: { name: "Updated Name" }
+ * });
+ * 
+ * @example
+ * // Delete a record
+ * const result = await auditlog.delete({ id: "123" });
+ * 
+ * @example
+ * // Find records with specific criteria
+ * const result = await auditlog.findMany({
+ *   where: { // filters },
+ *   orderBy: { // ordering },
+ *   take: 20 // limit
+ * });
+ */
+export const useSuparismaAuditLog = createSuparismaHook<
+  AuditLogWithRelations,
+  AuditLogWithRelations,
+  AuditLogCreateInput,
+  AuditLogUpdateInput,
+  AuditLogWhereInput,
+  AuditLogWhereUniqueInput,
+  AuditLogOrderByInput
+>({
+  tableName: 'AuditLog',
+  hasCreatedAt: true,
+  hasUpdatedAt: false,
+  // Default values from schema
+  defaultValues: {"id":"uuid(","createdAt":"now("},
+  // Field name for createdAt from Prisma schema
+  createdAtField: "createdAt"
+}) as unknown as (options?: UseAuditLogOptions) => AuditLogHookApi;

package/generated/hooks/useSuparismaThing.ts

@@ -0,0 +1,82 @@
+// THIS FILE IS AUTO-GENERATED - DO NOT EDIT DIRECTLY
+// Edit the generator script instead: scripts/generate-realtime-hooks.ts
+
+// Corrected import for core hook factory
+import { createSuparismaHook } from '../utils/core';
+import type {
+  ThingWithRelations,
+  ThingCreateInput,
+  ThingUpdateInput,
+  ThingWhereInput,
+  ThingWhereUniqueInput,
+  ThingOrderByInput,
+  ThingHookApi,
+  UseThingOptions
+} from '../types/ThingTypes';
+
+/**
+ * A Prisma-like hook for interacting with Thing records with real-time capabilities.
+ * 
+ * This hook provides CRUD operations, real-time updates, and search functionality.
+ *
+ * @param options - Optional configuration options for the hook
+ * @returns An object with data state and methods for interacting with Thing records
+ * 
+ * @example
+ * // Basic usage - get all Thing records with realtime updates
+ * const thing = useSuparismaThing();
+ * const { data, loading, error } = thing;
+ * 
+ * @example
+ * // With filtering and ordering
+ * const thing = useSuparismaThing({
+ *   where: { active: true },
+ *   orderBy: { createdAt: 'desc' }, // Note: Using actual Prisma field name
+ *   limit: 10
+ * });
+ * 
+ * @example
+ * // Create a new record
+ * const result = await thing.create({
+ *   name: "Example Name",
+ *   // other fields...
+ * });
+ * 
+ * @example
+ * // Update a record
+ * const result = await thing.update({
+ *   where: { id: "123" },
+ *   data: { name: "Updated Name" }
+ * });
+ * 
+ * @example
+ * // Delete a record
+ * const result = await thing.delete({ id: "123" });
+ * 
+ * @example
+ * // Find records with specific criteria
+ * const result = await thing.findMany({
+ *   where: { // filters },
+ *   orderBy: { // ordering },
+ *   take: 20 // limit
+ * });
+ */
+export const useSuparismaThing = createSuparismaHook<
+  ThingWithRelations,
+  ThingWithRelations,
+  ThingCreateInput,
+  ThingUpdateInput,
+  ThingWhereInput,
+  ThingWhereUniqueInput,
+  ThingOrderByInput
+>({
+  tableName: 'Thing',
+  hasCreatedAt: true,
+  hasUpdatedAt: true,
+  // Default values from schema
+  defaultValues: {"id":"uuid(","someEnum":"ONE","createdAt":"now("},
+  // Field name for createdAt from Prisma schema
+  createdAtField: "createdAt",
+  // Field name for updatedAt from Prisma schema
+  updatedAtField: "updatedAt"
+}) as unknown as (options?: UseThingOptions) => ThingHookApi;

package/generated/index.ts

@@ -0,0 +1,55 @@
+// THIS FILE IS AUTO-GENERATED - DO NOT EDIT DIRECTLY
+// Edit the generator script instead: scripts/generate-realtime-hooks.ts
+
+import { useSuparismaThing } from './hooks/useSuparismaThing';
+import { useSuparismaAuditLog } from './hooks/useSuparismaAuditLog';
+import type { UseThingOptions, ThingHookApi } from './types/ThingTypes';
+import type { UseAuditLogOptions, AuditLogHookApi } from './types/AuditLogTypes';
+export type { SuparismaOptions, SearchQuery, SearchState, FilterOperators } from './utils/core';
+export type { ThingWithRelations, ThingCreateInput, ThingUpdateInput, ThingWhereInput, ThingWhereUniqueInput, ThingOrderByInput, ThingHookApi, UseThingOptions } from './types/ThingTypes';
+export type { AuditLogWithRelations, AuditLogCreateInput, AuditLogUpdateInput, AuditLogWhereInput, AuditLogWhereUniqueInput, AuditLogOrderByInput, AuditLogHookApi, UseAuditLogOptions } from './types/AuditLogTypes';
+
+/**
+ * Interface for all Suparisma hooks with dot notation access.
+ * This provides IntelliSense for all available models.
+ * 
+ * @example
+ * // Access hooks for different models
+ * const users = useSuparisma.user();
+ * const posts = useSuparisma.post();
+ */
+export interface SuparismaHooks {
+  thing: (options?: UseThingOptions) => ThingHookApi;
+  auditLog: (options?: UseAuditLogOptions) => AuditLogHookApi;
+}
+
+/**
+ * Main Suparisma hook object with dot notation access to all model hooks.
+ * 
+ * @example
+ * // Get hooks for different models
+ * import useSuparisma from './your-output-dir'; // e.g., from './suparisma/generated'
+ * 
+ * // Access user model with all hook methods
+ * const users = useSuparisma.user();
+ * const { data, loading, error } = users;
+ * 
+ * // Create a new record
+ * await users.create({ name: "John" });
+ * 
+ * // Delete a record
+ * await users.delete({ id: "123" });
+ * 
+ * @example
+ * // Use with filtering and options
+ * const admins = useSuparisma.user({
+ *   where: { role: 'admin' },
+ *   orderBy: { created_at: 'desc' }
+ * });
+ */
+const useSuparisma: SuparismaHooks = {
+  thing: useSuparismaThing,
+  auditLog: useSuparismaAuditLog,
+};
+
+export default useSuparisma;

package/generated/types/AuditLogTypes.ts

@@ -0,0 +1,391 @@
+// THIS FILE IS AUTO-GENERATED - DO NOT EDIT DIRECTLY
+// Edit the generator script instead
+
+import type { AuditLog } from '@prisma/client';
+import type { ModelResult, SuparismaOptions, SearchQuery, SearchState } from '../utils/core';
+
+/**
+ * Extended AuditLog type that includes relation fields.
+ * This represents the complete shape of AuditLog records returned from the database.
+ */
+export interface AuditLogWithRelations {
+  id: string;
+  action: string;
+  details?: string;
+  createdAt: string;
+}
+
+/**
+ * Input type for creating a new AuditLog record.
+ * Fields with default values are optional and will be filled automatically if not provided.
+ * 
+ * @example
+ * // Create a minimal auditlog
+ * auditlog.create({
+ *   // Required fields only
+ *   action: string,
+ * });
+ * 
+ * @example
+ * // Create with optional fields
+ * auditlog.create({
+ *   // All fields including optional ones
+ *   id?: string,
+ *   action: string,
+ *   details?: string,
+ * });
+ */
+export interface AuditLogCreateInput {
+  id?: string;
+  action: string;
+  details?: string;
+}
+
+/**
+ * Input type for updating an existing AuditLog record.
+ * All fields are optional since you only need to specify the fields you want to change.
+ * 
+ * @example
+ * // Update a auditlog's fields
+ * auditlog.update({
+ *   where: { id: "123" },
+ *   data: {
+ *     id?: string,
+ *     action: string,
+ *   }
+ * });
+ */
+export type AuditLogUpdateInput = Partial<AuditLogCreateInput>;
+
+/**
+ * Filter type for querying AuditLog records.
+ * You can filter by any field in the model using equality or advanced filter operators.
+ * 
+ * @example
+ * // Basic filtering
+ * auditlog.findMany({
+ *   where: {
+ *     id: "value",
+ *     action: "value"
+ *   }
+ * });
+ * 
+ * @example
+ * // Advanced filtering
+ * auditlog.findMany({
+ *   where: {
+ *     // Use advanced operators
+ *     id: { contains: "partial" }
+ *   }
+ * });
+ */
+export type AuditLogWhereInput = Partial<AuditLogWithRelations>;
+
+/**
+ * Unique identifier for finding a specific AuditLog record.
+ * Usually uses the ID field but can be any field marked as @unique in the schema.
+ * 
+ * @example
+ * // Find by ID
+ * auditlog.findUnique({ id: "123" });
+ * 
+ * @example
+ * // Delete by ID
+ * auditlog.delete({ id: "123" });
+ */
+export type AuditLogWhereUniqueInput = { 
+  id: string;
+};
+
+/**
+ * Sort options for AuditLog queries.
+ * Specify the field to sort by and the direction ('asc' or 'desc').
+ * 
+ * @example
+ * // Sort by creation date, newest first
+ * auditlog.findMany({
+ *   orderBy: { created_at: 'desc' }
+ * });
+ * 
+ * @example
+ * // Sort alphabetically
+ * auditlog.findMany({
+ *   orderBy: { name: 'asc' }
+ * });
+ */
+export type AuditLogOrderByInput = {
+  [key in keyof AuditLogWithRelations]?: 'asc' | 'desc';
+};
+
+/**
+ * Result type for operations that return a single AuditLog record.
+ */
+export type AuditLogSingleResult = ModelResult<AuditLogWithRelations>;
+
+/**
+ * Result type for operations that return multiple AuditLog records.
+ */
+export type AuditLogManyResult = ModelResult<AuditLogWithRelations[]>;
+
+/**
+ * Configuration options for the AuditLog hook.
+ */
+export type UseAuditLogOptions = SuparismaOptions<AuditLogWhereInput, AuditLogOrderByInput>;
+
+/**
+ * The complete API for interacting with AuditLog records.
+ * This interface defines all available operations and state properties.
+ */
+export interface AuditLogHookApi {
+  /**
+   * Current array of AuditLog records.
+   * This is automatically updated when:
+   * - The initial data is loaded
+   * - Mutations are performed (create, update, delete)
+   * - Real-time updates are received from other clients
+   * - The refresh method is called
+   * 
+   * @example
+   * // Render a list of auditlog records
+   * const { data } = auditlog;
+   * return (
+   *   <ul>
+   *     {data.map(item => (
+   *       <li key={item.id}>{item.name}</li>
+   *     ))}
+   *   </ul>
+   * );
+   */
+  data: AuditLogWithRelations[];
+  
+  /**
+   * Error object if the last operation failed, null otherwise.
+   * 
+   * @example
+   * // Handle potential errors
+   * const { error } = auditlog;
+   * if (error) {
+   *   return <div>Error: {error.message}</div>;
+   * }
+   */
+  error: Error | null;
+  
+  /**
+   * Boolean indicating if an operation is in progress.
+   * 
+   * @example
+   * // Show loading state
+   * const { loading } = auditlog;
+   * if (loading) {
+   *   return <div>Loading...</div>;
+   * }
+   */
+  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 } = auditlog;
+   * return <div>Total records: {count}</div>;
+   */
+  count: number;
+  
+  
+  
+  /**
+   * Find a single AuditLog record by its unique identifier.
+   * 
+   * @param where - The unique identifier to find the record by
+   * @returns A promise with the found record or error
+   * 
+   * @example
+   * // Find auditlog by ID
+   * const result = await auditlog.findUnique({ id: "123" });
+   * if (result.data) {
+   *   console.log("Found auditlog:", result.data);
+   * }
+   */
+  findUnique: (where: AuditLogWhereUniqueInput) => AuditLogSingleResult;
+  
+  /**
+   * Find multiple AuditLog records matching the filter criteria.
+   * Supports filtering, sorting, and pagination.
+   * 
+   * @param params - Optional query parameters
+   * @returns A promise with the matching records or error
+   * 
+   * @example
+   * // Get all auditlog records
+   * const result = await auditlog.findMany();
+   * 
+   * @example
+   * // Filter and sort records
+   * const result = await auditlog.findMany({
+   *   where: { active: true },
+   *   orderBy: { created_at: 'desc' },
+   *   take: 10,
+   *   skip: 0
+   * });
+   */
+  findMany: (params?: {
+    where?: AuditLogWhereInput;
+    orderBy?: AuditLogOrderByInput;
+    take?: number;
+    skip?: number;
+  }) => AuditLogManyResult;
+  
+  /**
+   * Find the first AuditLog record matching the filter criteria.
+   * 
+   * @param params - Optional query parameters
+   * @returns A promise with the first matching record or error
+   * 
+   * @example
+   * // Find the first active auditlog
+   * const result = await auditlog.findFirst({
+   *   where: { active: true }
+   * });
+   * 
+   * @example
+   * // Find the oldest auditlog
+   * const result = await auditlog.findFirst({
+   *   orderBy: { created_at: 'asc' }
+   * });
+   */
+  findFirst: (params?: {
+    where?: AuditLogWhereInput;
+    orderBy?: AuditLogOrderByInput;
+  }) => AuditLogSingleResult;
+  
+  /**
+   * Create a new AuditLog record.
+   * Fields with default values are optional and will use their defaults if not provided.
+   * 
+   * @param data - The data for the new record
+   * @returns A promise with the created record or error
+   * 
+   * @example
+   * // Create a new auditlog
+   * const result = await auditlog.create({
+   *   action: "value"
+   * });
+   * 
+   * @example
+   * // Create with custom ID (overriding default)
+   * const result = await auditlog.create({
+   *   id: "custom-id",
+   *   action: "value"
+   * });
+   */
+  create: (data: AuditLogCreateInput) => AuditLogSingleResult;
+  
+  /**
+   * Update an existing AuditLog record.
+   * 
+   * @param params - Object with the record identifier and fields to update
+   * @returns A promise with the updated record or error
+   * 
+   * @example
+   * // Update a auditlog's fields
+   * const result = await auditlog.update({
+   *   where: { id: "123" },
+   *   data: {
+   *     id?: "updated value",
+   *     action: "updated value"
+   *   }
+   * });
+   */
+  update: (params: {
+    where: AuditLogWhereUniqueInput;
+    data: AuditLogUpdateInput;
+  }) => AuditLogSingleResult;
+  
+  /**
+   * Delete a AuditLog record by its unique identifier.
+   * 
+   * @param where - The unique identifier of the record to delete
+   * @returns A promise with the deleted record or error
+   * 
+   * @example
+   * // Delete a auditlog by ID
+   * const result = await auditlog.delete({ id: "123" });
+   * if (result.data) {
+   *   console.log("Deleted auditlog:", result.data);
+   * }
+   */
+  delete: (where: AuditLogWhereUniqueInput) => AuditLogSingleResult;
+  
+  /**
+   * Delete multiple AuditLog records matching the filter criteria.
+   * 
+   * @param params - Optional filter parameters
+   * @returns A promise with the count of deleted records or error
+   * 
+   * @example
+   * // Delete all inactive auditlog records
+   * const result = await auditlog.deleteMany({
+   *   where: { active: false }
+   * });
+   * console.log(`Deleted ${result.count} records`);
+   * 
+   * @example
+   * // Delete all auditlog records (use with caution!)
+   * const result = await auditlog.deleteMany();
+   */
+  deleteMany: (params?: {
+    where?: AuditLogWhereInput;
+  }) => Promise<{ count: number; error: Error | null }>;
+  
+  /**
+   * Create a record if it doesn't exist, or update it if it does.
+   * 
+   * @param params - Object with the identifier, update data, and create data
+   * @returns A promise with the created or updated record or error
+   * 
+   * @example
+   * // Upsert a auditlog by ID
+   * const result = await auditlog.upsert({
+   *   where: { id: "123" },
+   *   update: { name: "Updated Name" },
+   *   create: {
+   *     id: "123",
+   *     name: "New Name",
+   *     action: "value"
+   *   }
+   * });
+   */
+  upsert: (params: {
+    where: AuditLogWhereUniqueInput;
+    update: AuditLogUpdateInput;
+    create: AuditLogCreateInput;
+  }) => AuditLogSingleResult;
+  
+  /**
+   * Manually refresh the data with current filter settings.
+   * Useful after external operations or when realtime is disabled.
+   * 
+   * @param params - Optional override parameters for this specific refresh
+   * @returns A promise with the refreshed data or error
+   * 
+   * @example
+   * // Refresh with current filter settings
+   * await auditlog.refresh();
+   * 
+   * @example
+   * // Refresh with different filters for this call only
+   * await auditlog.refresh({
+   *   where: { active: true },
+   *   orderBy: { name: 'asc' }
+   * });
+   */
+  refresh: (params?: {
+    where?: AuditLogWhereInput;
+    orderBy?: AuditLogOrderByInput;
+    take?: number;
+    skip?: number;
+  }) => AuditLogManyResult;
+}