suparisma 1.0.0 → 1.0.2

package/generated/types/ThingTypes.ts

@@ -1,394 +0,0 @@
-// THIS FILE IS AUTO-GENERATED - DO NOT EDIT DIRECTLY
-// Edit the generator script instead
-
-import type { Thing } from '@prisma/client';
-import type { ModelResult, SuparismaOptions, SearchQuery, SearchState } from '../utils/core';
-
-/**
- * Extended Thing type that includes relation fields.
- * This represents the complete shape of Thing records returned from the database.
- */
-export interface ThingWithRelations {
-  id: string;
-  name?: string;
-  someEnum: string;
-  someNumber?: number;
-  createdAt: string;
-  updatedAt: string;
-}
-
-/**
- * Input type for creating a new Thing record.
- * Fields with default values are optional and will be filled automatically if not provided.
- * 
- * @example
- * // Create a minimal thing
- * thing.create({
- *   // Required fields only
-
- * });
- * 
- * @example
- * // Create with optional fields
- * thing.create({
- *   // All fields including optional ones
- *   id?: string,
- *   name?: string,
- *   someEnum?: string,
- * });
- */
-export interface ThingCreateInput {
-  id?: string;
-  name?: string;
-  someEnum?: string;
-  someNumber?: number;
-}
-
-/**
- * Input type for updating an existing Thing record.
- * All fields are optional since you only need to specify the fields you want to change.
- * 
- * @example
- * // Update a thing's fields
- * thing.update({
- *   where: { id: "123" },
- *   data: {
- *     id?: string,
- *     name?: string,
- *   }
- * });
- */
-export type ThingUpdateInput = Partial<ThingCreateInput>;
-
-/**
- * Filter type for querying Thing records.
- * You can filter by any field in the model using equality or advanced filter operators.
- * 
- * @example
- * // Basic filtering
- * thing.findMany({
- *   where: {
- *     id: "value",
- *     name?: "value"
- *   }
- * });
- * 
- * @example
- * // Advanced filtering
- * thing.findMany({
- *   where: {
- *     // Use advanced operators
- *     id: { contains: "partial" }
- *   }
- * });
- */
-export type ThingWhereInput = Partial<ThingWithRelations>;
-
-/**
- * Unique identifier for finding a specific Thing record.
- * Usually uses the ID field but can be any field marked as @unique in the schema.
- * 
- * @example
- * // Find by ID
- * thing.findUnique({ id: "123" });
- * 
- * @example
- * // Delete by ID
- * thing.delete({ id: "123" });
- */
-export type ThingWhereUniqueInput = { 
-  id: string;
-};
-
-/**
- * Sort options for Thing queries.
- * Specify the field to sort by and the direction ('asc' or 'desc').
- * 
- * @example
- * // Sort by creation date, newest first
- * thing.findMany({
- *   orderBy: { created_at: 'desc' }
- * });
- * 
- * @example
- * // Sort alphabetically
- * thing.findMany({
- *   orderBy: { name: 'asc' }
- * });
- */
-export type ThingOrderByInput = {
-  [key in keyof ThingWithRelations]?: 'asc' | 'desc';
-};
-
-/**
- * Result type for operations that return a single Thing record.
- */
-export type ThingSingleResult = ModelResult<ThingWithRelations>;
-
-/**
- * Result type for operations that return multiple Thing records.
- */
-export type ThingManyResult = ModelResult<ThingWithRelations[]>;
-
-/**
- * Configuration options for the Thing hook.
- */
-export type UseThingOptions = SuparismaOptions<ThingWhereInput, ThingOrderByInput>;
-
-/**
- * The complete API for interacting with Thing records.
- * This interface defines all available operations and state properties.
- */
-export interface ThingHookApi {
-  /**
-   * Current array of Thing 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 thing records
-   * const { data } = thing;
-   * return (
-   *   <ul>
-   *     {data.map(item => (
-   *       <li key={item.id}>{item.name}</li>
-   *     ))}
-   *   </ul>
-   * );
-   */
-  data: ThingWithRelations[];
-  
-  /**
-   * Error object if the last operation failed, null otherwise.
-   * 
-   * @example
-   * // Handle potential errors
-   * const { error } = thing;
-   * 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 } = thing;
-   * 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 } = thing;
-   * return <div>Total records: {count}</div>;
-   */
-  count: number;
-  
-  
-  
-  /**
-   * Find a single Thing 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 thing by ID
-   * const result = await thing.findUnique({ id: "123" });
-   * if (result.data) {
-   *   console.log("Found thing:", result.data);
-   * }
-   */
-  findUnique: (where: ThingWhereUniqueInput) => ThingSingleResult;
-  
-  /**
-   * Find multiple Thing 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 thing records
-   * const result = await thing.findMany();
-   * 
-   * @example
-   * // Filter and sort records
-   * const result = await thing.findMany({
-   *   where: { active: true },
-   *   orderBy: { created_at: 'desc' },
-   *   take: 10,
-   *   skip: 0
-   * });
-   */
-  findMany: (params?: {
-    where?: ThingWhereInput;
-    orderBy?: ThingOrderByInput;
-    take?: number;
-    skip?: number;
-  }) => ThingManyResult;
-  
-  /**
-   * Find the first Thing 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 thing
-   * const result = await thing.findFirst({
-   *   where: { active: true }
-   * });
-   * 
-   * @example
-   * // Find the oldest thing
-   * const result = await thing.findFirst({
-   *   orderBy: { created_at: 'asc' }
-   * });
-   */
-  findFirst: (params?: {
-    where?: ThingWhereInput;
-    orderBy?: ThingOrderByInput;
-  }) => ThingSingleResult;
-  
-  /**
-   * Create a new Thing 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 thing
-   * const result = await thing.create({
-
-   * });
-   * 
-   * @example
-   * // Create with custom ID (overriding default)
-   * const result = await thing.create({
-   *   id: "custom-id",
-
-   * });
-   */
-  create: (data: ThingCreateInput) => ThingSingleResult;
-  
-  /**
-   * Update an existing Thing record.
-   * 
-   * @param params - Object with the record identifier and fields to update
-   * @returns A promise with the updated record or error
-   * 
-   * @example
-   * // Update a thing's fields
-   * const result = await thing.update({
-   *   where: { id: "123" },
-   *   data: {
-   *     id?: "updated value",
-   *     name?: "updated value"
-   *   }
-   * });
-   */
-  update: (params: {
-    where: ThingWhereUniqueInput;
-    data: ThingUpdateInput;
-  }) => ThingSingleResult;
-  
-  /**
-   * Delete a Thing 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 thing by ID
-   * const result = await thing.delete({ id: "123" });
-   * if (result.data) {
-   *   console.log("Deleted thing:", result.data);
-   * }
-   */
-  delete: (where: ThingWhereUniqueInput) => ThingSingleResult;
-  
-  /**
-   * Delete multiple Thing 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 thing records
-   * const result = await thing.deleteMany({
-   *   where: { active: false }
-   * });
-   * console.log(`Deleted ${result.count} records`);
-   * 
-   * @example
-   * // Delete all thing records (use with caution!)
-   * const result = await thing.deleteMany();
-   */
-  deleteMany: (params?: {
-    where?: ThingWhereInput;
-  }) => 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 thing by ID
-   * const result = await thing.upsert({
-   *   where: { id: "123" },
-   *   update: { name: "Updated Name" },
-   *   create: {
-   *     id: "123",
-   *     name: "New Name"
-
-   *   }
-   * });
-   */
-  upsert: (params: {
-    where: ThingWhereUniqueInput;
-    update: ThingUpdateInput;
-    create: ThingCreateInput;
-  }) => ThingSingleResult;
-  
-  /**
-   * 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 thing.refresh();
-   * 
-   * @example
-   * // Refresh with different filters for this call only
-   * await thing.refresh({
-   *   where: { active: true },
-   *   orderBy: { name: 'asc' }
-   * });
-   */
-  refresh: (params?: {
-    where?: ThingWhereInput;
-    orderBy?: ThingOrderByInput;
-    take?: number;
-    skip?: number;
-  }) => ThingManyResult;
-}