@gzl10/baserow 1.2.0

package/src/types/requests.ts

@@ -0,0 +1,333 @@
+/**
+ * Tipos para requests a la API de Baserow
+ */
+
+export interface CreateTableRequest {
+  name: string
+  data?: Array<any>
+  first_row_header?: boolean
+  /**
+   * Controla si se debe limpiar automáticamente el contenido por defecto que Baserow
+   * agrega cuando se crea una tabla sin datos. Default: true (limpieza automática)
+   * @since 1.0.0
+   */
+  skipDefaultCleanup?: boolean
+}
+
+export interface UpdateTableRequest {
+  name?: string
+}
+
+export interface CreateRowRequest {
+  [fieldName: string]: any
+  before_id?: number
+}
+
+export interface UpdateRowRequest {
+  [fieldName: string]: any
+}
+
+export interface BulkCreateRowsRequest {
+  items: CreateRowRequest[]
+}
+
+export interface BulkUpdateRowsRequest {
+  items: Array<{
+    id: number
+    [fieldName: string]: any
+  }>
+}
+
+export interface CreateSnapshotRequest {
+  name: string
+  snapshot_from_application: number
+}
+
+export interface RestoreSnapshotRequest {
+  workspace_id: number
+}
+
+export interface CreateWebhookRequest {
+  url: string
+  include_all_events?: boolean
+  events?: string[]
+  headers?: Record<string, string>
+  active?: boolean
+}
+
+export interface UpdateWebhookRequest extends Partial<CreateWebhookRequest> {}
+
+export interface CreateUserRequest {
+  email: string
+  first_name: string
+  last_name?: string
+  password: string
+  is_active?: boolean
+  is_staff?: boolean
+}
+
+export interface UpdateUserRequest {
+  first_name?: string
+  last_name?: string
+  is_active?: boolean
+  is_staff?: boolean
+  language?: string
+}
+
+export interface EmailTestRequest {
+  email: string
+}
+
+/**
+ * Operadores de filtro estilo Prisma para campos individuales
+ *
+ * Proporciona operadores avanzados de filtrado similares a Prisma ORM
+ * para crear consultas expresivas y type-safe.
+ *
+ * @template T - Tipo del valor del campo
+ *
+ * @example
+ * ```typescript
+ * // Filtros numéricos
+ * const ageFilter: FieldOperators<number> = {
+ *   gte: 18,
+ *   lt: 65
+ * }
+ *
+ * // Filtros de texto
+ * const emailFilter: FieldOperators<string> = {
+ *   contains: '@company.com',
+ *   not: 'admin@company.com'
+ * }
+ * ```
+ *
+ * @since 1.2.0
+ */
+export interface FieldOperators<T = any> {
+  /** Igual a valor específico */
+  equals?: T
+  /** Diferente de valor específico */
+  not?: T
+  /** Valor está en la lista */
+  in?: T[]
+  /** Valor no está en la lista */
+  notIn?: T[]
+  /** Campo de texto contiene substring (case-insensitive) */
+  contains?: string
+  /** Campo de texto NO contiene substring */
+  contains_not?: string
+  /** Campo de texto empieza con substring */
+  startsWith?: string
+  /** Campo de texto termina con substring */
+  endsWith?: string
+  /** Mayor que (números, fechas) */
+  gt?: number | Date
+  /** Mayor o igual que (números, fechas) */
+  gte?: number | Date
+  /** Menor que (números, fechas) */
+  lt?: number | Date
+  /** Menor o igual que (números, fechas) */
+  lte?: number | Date
+  /** Campo está vacío o es null (alias: empty) */
+  isEmpty?: boolean
+  /** Campo está vacío o es null (sintaxis Baserow) */
+  empty?: boolean
+  /** Campo no está vacío y no es null (alias: notEmpty) */
+  isNotEmpty?: boolean
+  /** Campo no está vacío y no es null (sintaxis Baserow) */
+  notEmpty?: boolean
+}
+
+/**
+ * Cláusula WHERE estilo Prisma con operadores lógicos
+ *
+ * Permite construir consultas complejas con operadores AND, OR y NOT
+ * combinados con filtros de campo específicos.
+ *
+ * @template T - Tipo del modelo/entidad
+ *
+ * @example
+ * ```typescript
+ * const where: WhereClause<User> = {
+ *   AND: [
+ *     { status: 'active' },
+ *     { age: { gte: 18, lt: 65 } }
+ *   ],
+ *   OR: [
+ *     { department: 'Engineering' },
+ *     { role: 'Manager' }
+ *   ],
+ *   email: { contains: '@company.com' }
+ * }
+ * ```
+ *
+ * @since 1.2.0
+ */
+export interface WhereClause<T = any> {
+  /** Filtros por campo con operadores o valores directos */
+  [key: string]: any
+  /** Operador AND: todas las condiciones deben cumplirse */
+  AND?: WhereClause<T>[]
+  /** Operador OR: al menos una condición debe cumplirse */
+  OR?: WhereClause<T>[]
+  /** Operador NOT: ninguna condición debe cumplirse */
+  NOT?: WhereClause<T>
+}
+
+/**
+ * Configuración de ordenamiento estilo Prisma
+ *
+ * Soporta ordenamiento por uno o múltiples campos con dirección
+ * ascendente ('asc') o descendente ('desc').
+ *
+ * @template T - Tipo del modelo/entidad
+ *
+ * @example
+ * ```typescript
+ * // Ordenamiento simple
+ * const orderBy: OrderByClause<User> = { name: 'asc' }
+ *
+ * // Ordenamiento múltiple
+ * const multiOrder: OrderByClause<User> = [
+ *   { created_at: 'desc' },
+ *   { name: 'asc' }
+ * ]
+ * ```
+ *
+ * @since 1.2.0
+ */
+export type OrderByClause<T = any> = { [K in keyof T]?: 'asc' | 'desc' } | Array<{ [K in keyof T]?: 'asc' | 'desc' }>
+
+/**
+ * Configuración de selección de campos estilo Prisma
+ *
+ * Permite especificar qué campos incluir (true) o excluir (false)
+ * en los resultados de la consulta.
+ *
+ * @template T - Tipo del modelo/entidad
+ *
+ * @example
+ * ```typescript
+ * const select: SelectClause<User> = {
+ *   id: true,
+ *   name: true,
+ *   email: true,
+ *   password: false  // Excluir campo sensible
+ * }
+ * ```
+ *
+ * @since 1.2.0
+ */
+export type SelectClause<T = any> = {
+  [K in keyof T]?: boolean
+}
+
+/**
+ * Opciones de consulta estilo Prisma
+ *
+ * Interface principal que combina todas las capacidades de filtrado,
+ * ordenamiento, paginación y selección de campos en un formato
+ * familiar para desarrolladores de Prisma.
+ *
+ * @template T - Tipo del modelo/entidad
+ *
+ * @example
+ * ```typescript
+ * const options: PrismaLikeQueryOptions<User> = {
+ *   where: {
+ *     status: 'active',
+ *     age: { gte: 18 },
+ *     email: { contains: '@company.com' }
+ *   },
+ *   select: {
+ *     id: true,
+ *     name: true,
+ *     email: true
+ *   },
+ *   orderBy: [
+ *     { created_at: 'desc' },
+ *     { name: 'asc' }
+ *   ],
+ *   take: 20,
+ *   skip: 0
+ * }
+ * ```
+ *
+ * @since 1.2.0
+ */
+export interface PrismaLikeQueryOptions<T = any> {
+  /** Filtros y condiciones de búsqueda */
+  where?: WhereClause<T>
+  /** Selección de campos a incluir/excluir */
+  select?: SelectClause<T>
+  /** Configuración de ordenamiento */
+  orderBy?: OrderByClause<T>
+  /** Número máximo de registros a retornar (equivale a 'size') */
+  take?: number
+  /** Número de registros a saltar (para paginación) */
+  skip?: number
+  /** Campos para eliminar duplicados */
+  distinct?: (keyof T)[]
+  /** Usar nombres de usuario para campos (específico de Baserow) */
+  userFieldNames?: boolean
+}
+
+/**
+ * Opciones de consulta extendidas con compatibilidad legacy
+ *
+ * Mantiene la interface original QueryOptions mientras agrega
+ * soporte completo para sintaxis estilo Prisma. Permite migración
+ * gradual sin romper código existente.
+ *
+ * @example
+ * ```typescript
+ * // Sintaxis Prisma (nueva)
+ * const prismaStyle: QueryOptions = {
+ *   where: { status: 'active' },
+ *   take: 10,
+ *   orderBy: { created_at: 'desc' }
+ * }
+ *
+ * // Sintaxis legacy (compatible)
+ * const legacyStyle: QueryOptions = {
+ *   filters: { status: 'active' },
+ *   size: 10,
+ *   order_by: '-created_at'
+ * }
+ * ```
+ *
+ * @since 1.2.0
+ */
+export interface QueryOptions extends PrismaLikeQueryOptions {
+  // === OPCIONES LEGACY (compatibilidad) ===
+  /** Número de página (legacy) */
+  page?: number
+  /** Tamaño de página (legacy) */
+  size?: number
+  /** Búsqueda en todos los campos (legacy) */
+  search?: string
+  /** String de ordenamiento Baserow (legacy) */
+  order_by?: string
+  /** Filtros en formato Baserow (Record con query parameters) */
+  filters?: Record<string, any>
+  /**
+   * Tipo de filtro para combinar múltiples filtros
+   * - 'AND': Todos los filtros deben cumplirse (default)
+   * - 'OR': Al menos un filtro debe cumplirse
+   * @default 'AND'
+   */
+  filter_type?: 'AND' | 'OR'
+  /** Campos a incluir (legacy) */
+  include?: string[]
+  /** Campos a excluir (legacy) */
+  exclude?: string[]
+  /** Usar nombres de usuario (legacy) */
+  user_field_names?: boolean
+}
+
+export interface BulkOptions {
+  batchSize?: number
+  maxBatchSize?: number
+  send_webhook_events?: boolean
+  user_field_names?: boolean
+}

package/src/types/responses.ts

@@ -0,0 +1,50 @@
+/**
+ * Tipos para responses de la API de Baserow
+ */
+
+export interface BaserowResponse<T = any> {
+  count: number
+  next: string | null
+  previous: string | null
+  results: T[]
+}
+
+export interface Snapshot {
+  id: number
+  name: string
+  snapshot_from_application: number
+  created_at: string
+  created_by: {
+    id: number
+    first_name: string
+    username: string
+  }
+  mark_for_deletion: boolean
+}
+
+export interface Webhook {
+  id: number
+  table_id: number
+  url: string
+  include_all_events: boolean
+  events: string[]
+  headers: Record<string, string>
+  active: boolean
+  created_on: string
+}
+
+export interface WebhookCall {
+  id: number
+  event_type: string
+  called_time: string
+  called_url: string
+  request: any
+  response: any
+  response_status: number
+}
+
+export interface HealthCheck {
+  status: 'healthy' | 'unhealthy'
+  checks?: Record<string, string>
+  timestamp?: string
+}