suparisma 1.2.2 → 1.2.6

package/tmp/generated-test/types/CourseTypes.ts

@@ -0,0 +1,519 @@
+// THIS FILE IS AUTO-GENERATED - DO NOT EDIT DIRECTLY
+// Edit the generator script instead
+
+import type { Course } from '@prisma/client';
+import type { ModelResult, SuparismaOptions, SearchQuery, SearchState, FilterOperators, IncludeValue } from '../utils/core';
+import type { ChapterWithRelations, ChapterSelectInput } from './ChapterTypes';
+import type { EnrollmentWithRelations, EnrollmentSelectInput } from './EnrollmentTypes';
+import type { LessonPurchaseWithRelations, LessonPurchaseSelectInput } from './LessonPurchaseTypes';
+
+/**
+ * Extended Course type that includes relation fields.
+ * This represents the complete shape of Course records returned from the database.
+ */
+export interface CourseWithRelations {
+  id: string;
+  title: string;
+  description?: string;
+  thumbnail?: string;
+  published: boolean;
+  teacherId: string;
+  createdAt: Date;
+  updatedAt: Date;
+  allowIndividualLessonPurchase: boolean;
+  blockScreenRecording: boolean;
+  maxDevices: number;
+  price: number;
+  pricingType: string;
+  defaultLessonPrice: number;
+  chapters?: ChapterWithRelations[];
+  enrollments?: EnrollmentWithRelations[];
+  purchases?: LessonPurchaseWithRelations[];
+}
+
+/**
+ * Input type for creating a new Course record.
+ * Fields with default values are optional and will be filled automatically if not provided.
+ * 
+ * @example
+ * // Create a minimal course
+ * course.create({
+ *   // Required fields only
+ *   title: string,
+ *   teacherId: string,
+ * });
+ * 
+ * @example
+ * // Create with optional fields
+ * course.create({
+ *   // All fields including optional ones
+ *   id?: string,
+ *   title: string,
+ *   description?: string,
+ * });
+ */
+export interface CourseCreateInput {
+  id?: string;
+  title: string;
+  description?: string;
+  thumbnail?: string;
+  published?: boolean;
+  teacherId: string;
+  allowIndividualLessonPurchase?: boolean;
+  blockScreenRecording?: boolean;
+  maxDevices?: number;
+  price?: number;
+  pricingType?: string;
+  defaultLessonPrice?: number;
+}
+
+/**
+ * Input type for updating an existing Course record.
+ * All fields are optional since you only need to specify the fields you want to change.
+ * 
+ * @example
+ * // Update a course's fields
+ * course.update({
+ *   where: { id: "123" },
+ *   data: {
+ *     id?: string,
+ *     title: string,
+ *   }
+ * });
+ */
+export type CourseUpdateInput = Partial<CourseCreateInput>;
+
+/**
+ * Filter type for querying Course records.
+ * You can filter by any field in the model using equality or advanced filter operators.
+ * Supports OR and AND logical operations for complex queries.
+ * 
+ * @example
+ * // Basic filtering
+ * course.findMany({
+ *   where: {
+ *     id: "value",
+ *     title: "value"
+ *   }
+ * });
+ * 
+ * @example
+ * // Advanced filtering
+ * course.findMany({
+ *   where: {
+ *     // Use advanced operators
+ *     id: { contains: "partial" }
+ *   }
+ * });
+ * 
+ * @example
+ * // OR conditions - match ANY condition
+ * course.findMany({
+ *   where: {
+ *     OR: [
+ *       { id: "value1" },
+ *       { title: { contains: "value2" } }
+ *     ]
+ *   }
+ * });
+ * 
+ * @example
+ * // AND conditions - match ALL conditions
+ * course.findMany({
+ *   where: {
+ *     AND: [
+ *       { id: "value1" },
+ *       { title: { gt: 100 } }
+ *     ]
+ *   }
+ * });
+ * 
+ * @example
+ * // Complex nested logic
+ * course.findMany({
+ *   where: {
+ *     active: true, // Regular condition (implicit AND)
+ *     OR: [
+ *       { role: "admin" },
+ *       { role: "moderator" }
+ *     ]
+ *   }
+ * });
+ * 
+ * @example
+ * // Array filtering (for array fields)
+ * course.findMany({
+ *   where: {
+ *     // Array contains specific items
+ *     chapters?: { has: ["item1", "item2"] }
+ *   }
+ * });
+ */
+export type CourseWhereInput = {
+  id?: string | FilterOperators<string>;
+  title?: string | FilterOperators<string>;
+  description?: string | FilterOperators<string>;
+  thumbnail?: string | FilterOperators<string>;
+  published?: boolean | FilterOperators<boolean>;
+  teacherId?: string | FilterOperators<string>;
+  createdAt?: Date | FilterOperators<Date>;
+  updatedAt?: Date | FilterOperators<Date>;
+  allowIndividualLessonPurchase?: boolean | FilterOperators<boolean>;
+  blockScreenRecording?: boolean | FilterOperators<boolean>;
+  maxDevices?: number | FilterOperators<number>;
+  price?: number | FilterOperators<number>;
+  pricingType?: string | FilterOperators<string>;
+  defaultLessonPrice?: number | FilterOperators<number>;
+} & {
+  /** Match ANY of the provided conditions */
+  OR?: CourseWhereInput[];
+  /** Match ALL of the provided conditions */
+  AND?: CourseWhereInput[];
+};
+
+/**
+ * Unique identifier for finding a specific Course record.
+ * Usually uses the ID field but can be any field marked as @unique in the schema.
+ * 
+ * @example
+ * // Find by ID
+ * course.findUnique({ id: "123" });
+ * 
+ * @example
+ * // Delete by ID
+ * course.delete({ id: "123" });
+ */
+export type CourseWhereUniqueInput = { 
+  id: string;
+};
+
+/**
+ * Sort options for Course queries.
+ * Specify the field to sort by and the direction ('asc' or 'desc').
+ * 
+ * @example
+ * // Sort by creation date, newest first
+ * course.findMany({
+ *   orderBy: { created_at: 'desc' }
+ * });
+ * 
+ * @example
+ * // Sort alphabetically
+ * course.findMany({
+ *   orderBy: { name: 'asc' }
+ * });
+ */
+export type CourseOrderByInput = {
+  [key in keyof CourseSelectInput]?: 'asc' | 'desc';
+};
+
+/**
+ * Select specific scalar fields to return from Course queries.
+ * Relation fields are intentionally excluded; use `include` for relations.
+ */
+export type CourseSelectInput = {
+    id?: boolean;
+  title?: boolean;
+  description?: boolean;
+  thumbnail?: boolean;
+  published?: boolean;
+  teacherId?: boolean;
+  createdAt?: boolean;
+  updatedAt?: boolean;
+  allowIndividualLessonPurchase?: boolean;
+  blockScreenRecording?: boolean;
+  maxDevices?: boolean;
+  price?: boolean;
+  pricingType?: boolean;
+  defaultLessonPrice?: boolean;
+};
+
+/**
+ * Include related records when querying Course.
+ * Only real Prisma relation fields are allowed here.
+ */
+export type CourseIncludeInput = {
+    chapters?: IncludeValue | { select?: ChapterSelectInput };
+  enrollments?: IncludeValue | { select?: EnrollmentSelectInput };
+  purchases?: IncludeValue | { select?: LessonPurchaseSelectInput };
+};
+
+/**
+ * Result type for operations that return a single Course record.
+ */
+export type CourseSingleResult = ModelResult<CourseWithRelations>;
+
+/**
+ * Result type for operations that return multiple Course records.
+ */
+export type CourseManyResult = ModelResult<CourseWithRelations[]>;
+
+/**
+ * Configuration options for the Course hook.
+ * Includes where filters, ordering, pagination, and field selection.
+ */
+export type UseCourseOptions = SuparismaOptions<
+  CourseWhereInput,
+  CourseOrderByInput,
+  CourseSelectInput,
+  CourseIncludeInput
+>;
+
+/**
+ * The complete API for interacting with Course records.
+ * This interface defines all available operations and state properties.
+ */
+export interface CourseHookApi {
+  /**
+   * Current array of Course 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 course records
+   * const { data } = course;
+   * return (
+   *   <ul>
+   *     {data.map(item => (
+   *       <li key={item.id}>{item.name}</li>
+   *     ))}
+   *   </ul>
+   * );
+   */
+  data: CourseWithRelations[];
+  
+  /**
+   * Error object if the last operation failed, null otherwise.
+   * 
+   * @example
+   * // Handle potential errors
+   * const { error } = course;
+   * 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 } = course;
+   * 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 } = course;
+   * return <div>Total records: {count}</div>;
+   */
+  count: number;
+  
+  
+  
+  /**
+   * Find a single Course 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 course by ID
+   * const result = await course.findUnique({ id: "123" });
+   * if (result.data) {
+   *   console.log("Found course:", result.data);
+   * }
+   */
+  findUnique: (where: CourseWhereUniqueInput) => CourseSingleResult;
+  
+  /**
+   * Find multiple Course 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 course records
+   * const result = await course.findMany();
+   * 
+   * @example
+   * // Filter and sort records
+   * const result = await course.findMany({
+   *   where: { active: true },
+   *   orderBy: { created_at: 'desc' },
+   *   take: 10,
+   *   skip: 0
+   * });
+   */
+  findMany: (params?: {
+    where?: CourseWhereInput;
+    orderBy?: CourseOrderByInput;
+    take?: number;
+    skip?: number;
+  }) => CourseManyResult;
+  
+  /**
+   * Find the first Course 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 course
+   * const result = await course.findFirst({
+   *   where: { active: true }
+   * });
+   * 
+   * @example
+   * // Find the oldest course
+   * const result = await course.findFirst({
+   *   orderBy: { created_at: 'asc' }
+   * });
+   */
+  findFirst: (params?: {
+    where?: CourseWhereInput;
+    orderBy?: CourseOrderByInput;
+  }) => CourseSingleResult;
+  
+  /**
+   * Create a new Course 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 course
+   * const result = await course.create({
+   *   title: "value",
+   *   teacherId: "value"
+   * });
+   * 
+   * @example
+   * // Create with custom ID (overriding default)
+   * const result = await course.create({
+   *   id: "custom-id",
+   *   title: "value"
+   * });
+   */
+  create: (data: CourseCreateInput) => CourseSingleResult;
+  
+  /**
+   * Update an existing Course record.
+   * 
+   * @param params - Object with the record identifier and fields to update
+   * @returns A promise with the updated record or error
+   * 
+   * @example
+   * // Update a course's fields
+   * const result = await course.update({
+   *   where: { id: "123" },
+   *   data: {
+   *     id?: "updated value",
+   *     title: "updated value"
+   *   }
+   * });
+   */
+  update: (params: {
+    where: CourseWhereUniqueInput;
+    data: CourseUpdateInput;
+  }) => CourseSingleResult;
+  
+  /**
+   * Delete a Course 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 course by ID
+   * const result = await course.delete({ id: "123" });
+   * if (result.data) {
+   *   console.log("Deleted course:", result.data);
+   * }
+   */
+  delete: (where: CourseWhereUniqueInput) => CourseSingleResult;
+  
+  /**
+   * Delete multiple Course 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 course records
+   * const result = await course.deleteMany({
+   *   where: { active: false }
+   * });
+   * console.log(`Deleted ${result.count} records`);
+   * 
+   * @example
+   * // Delete all course records (use with caution!)
+   * const result = await course.deleteMany();
+   */
+  deleteMany: (params?: {
+    where?: CourseWhereInput;
+  }) => 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 course by ID
+   * const result = await course.upsert({
+   *   where: { id: "123" },
+   *   update: { name: "Updated Name" },
+   *   create: {
+   *     id: "123",
+   *     name: "New Name",
+   *     title: "value"
+   *   }
+   * });
+   */
+  upsert: (params: {
+    where: CourseWhereUniqueInput;
+    update: CourseUpdateInput;
+    create: CourseCreateInput;
+  }) => CourseSingleResult;
+  
+  /**
+   * 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 course.refresh();
+   * 
+   * @example
+   * // Refresh with different filters for this call only
+   * await course.refresh({
+   *   where: { active: true },
+   *   orderBy: { name: 'asc' }
+   * });
+   */
+  refresh: (params?: {
+    where?: CourseWhereInput;
+    orderBy?: CourseOrderByInput;
+    take?: number;
+    skip?: number;
+  }) => CourseManyResult;
+}