@taruvi/sdk 1.5.0-beta.1 → 1.5.0-beta.2

package/src/lib-internal/errors/types.ts

@@ -1,29 +0,0 @@
-/**
- * Error codes matching the backend's ErrorCode enum.
- * Maps 1:1 with base.responses.error_codes.ErrorCode in Python.
- */
-export enum ErrorCode {
-    BAD_REQUEST = 'BAD_REQUEST',
-    VALIDATION_ERROR = 'VALIDATION_ERROR',
-    UNAUTHORIZED = 'UNAUTHORIZED',
-    FORBIDDEN = 'FORBIDDEN',
-    NOT_FOUND = 'NOT_FOUND',
-    CONFLICT = 'CONFLICT',
-    INTERNAL_ERROR = 'INTERNAL_ERROR',
-    RATE_LIMITED = 'RATE_LIMITED',
-    GATEWAY_TIMEOUT = 'GATEWAY_TIMEOUT',
-    NETWORK_ERROR = 'NETWORK_ERROR'
-}
-
-/**
- * Backend error response shape.
- * Matches AppException.to_dict() output.
- */
-export interface ErrorResponseBody {
-    status: 'error'
-    code: string
-    message: string
-    detail?: string
-    errors?: Record<string, unknown>
-    data?: unknown
-}

package/src/lib-internal/http/HttpClient.ts

@@ -1,116 +0,0 @@
-import type { TaruviConfig } from "../../types.js";
-import type { TokenClient } from "../token/TokenClient.js";
-import axios, { AxiosError, type AxiosInstance, type InternalAxiosRequestConfig } from "axios";
-import { createErrorFromResponse, NetworkError, TaruviError } from "../errors/index.js";
-import type { ErrorResponseBody } from "../errors/index.js";
-
-/**
- * HttpClient handles all HTTP requests to the Taruvi API.
- * Sends session token via X-Session-Token header.
- * Clears tokens on 401 auth failures.
- *
- * @internal
- */
-export class HttpClient {
-    private tokenClient: TokenClient
-    private axiosInstance: AxiosInstance
-
-    constructor(config: TaruviConfig, tokenClient: TokenClient) {
-        this.tokenClient = tokenClient
-        this.axiosInstance = axios.create({ baseURL: config.apiUrl, withCredentials: true })
-        this.setupInterceptors()
-    }
-
-    private setupInterceptors(): void {
-        // Request interceptor: attach session token
-        console.log("test")
-        this.axiosInstance.interceptors.request.use((config: InternalAxiosRequestConfig) => {
-            const isFormData = config.data instanceof FormData
-            if (!isFormData) {
-                config.headers['Content-Type'] = 'application/json'
-            }
-            const sessionToken = this.tokenClient.getSessionToken()
-            if (sessionToken) {
-                config.headers['X-Session-Token'] = sessionToken
-            }
-            return config
-        })
-
-        // Response interceptor: clear tokens on authentication failure
-        // Only 401 (Unauthorized) means the session is invalid
-        // 403 (Forbidden) means authenticated but lacking permission — don't clear tokens
-        this.axiosInstance.interceptors.response.use(
-            (response) => response,
-            (error: AxiosError) => {
-                const status = error.response?.status
-                if (status === 401) {
-                    this.tokenClient.clearTokens()
-                }
-                return Promise.reject(error)
-            }
-        )
-    }
-
-    private handleError(error: unknown): never {
-        if (error instanceof TaruviError) {
-            throw error
-        }
-
-        if (error instanceof AxiosError) {
-            if (error.response) {
-                const body = error.response.data as ErrorResponseBody | undefined
-                throw createErrorFromResponse(error.response.status, body)
-            }
-            throw new NetworkError(error.message)
-        }
-
-        throw error
-    }
-
-    async get<T>(endpoint: string, options?: { responseType?: 'json' | 'blob' }): Promise<T> {
-        try {
-            const { data } = await this.axiosInstance.get<T>(`/${endpoint}`, {
-                ...(options?.responseType && { responseType: options.responseType }),
-            })
-            return data as T
-        } catch (error) {
-            this.handleError(error)
-        }
-    }
-
-    async post<T, D = unknown>(endpoint: string, body: D): Promise<T> {
-        try {
-            const { data } = await this.axiosInstance.post<T>(`/${endpoint}`, body)
-            return data
-        } catch (error) {
-            this.handleError(error)
-        }
-    }
-
-    async put<T, D = unknown>(endpoint: string, body: D): Promise<T> {
-        try {
-            const { data } = await this.axiosInstance.put<T>(`/${endpoint}`, body)
-            return data
-        } catch (error) {
-            this.handleError(error)
-        }
-    }
-
-    async delete<T, D = unknown>(endpoint: string, body?: D): Promise<T> {
-        try {
-            const { data } = await this.axiosInstance.delete<T>(`/${endpoint}`, { data: body })
-            return data
-        } catch (error) {
-            this.handleError(error)
-        }
-    }
-
-    async patch<T, D = unknown>(endpoint: string, body: D): Promise<T> {
-        try {
-            const { data } = await this.axiosInstance.patch<T>(`/${endpoint}`, body)
-            return data
-        } catch (error) {
-            this.handleError(error)
-        }
-    }
-}

package/src/lib-internal/http/types.ts

@@ -1,12 +0,0 @@
-/**
- * HTTP methods supported by the HttpClient
- */
-export const HttpMethod = {
-    GET: 'GET',
-    POST: 'POST',
-    PUT: 'PUT',
-    PATCH: 'PATCH',
-    DELETE: 'DELETE'
-} as const
-
-export type HttpMethod = typeof HttpMethod[keyof typeof HttpMethod]

package/src/lib-internal/routes/AnalyticsRoutes.ts

@@ -1,3 +0,0 @@
-export const AnalyticsRoutes = {
-    baseUrl: (appSlug: string, querySlug: string) => `api/apps/${appSlug}/analytics/queries/${querySlug}/execute/`
-}

package/src/lib-internal/routes/AppRoutes.ts

@@ -1,9 +0,0 @@
-export const AppRoutes = {
-    baseUrl: (appSlug: string) => `api/apps/${appSlug}`,
-    roles: (): string => `/roles`,
-    settings: (): string => "/settings/"
-}
-
-type AllRouteKeys = keyof typeof AppRoutes
-export type AppRouteKey = Exclude<AllRouteKeys, 'baseUrl'>
-export type AppUrlParams = Partial<Record<AppRouteKey, string>>

package/src/lib-internal/routes/DatabaseRoutes.ts

@@ -1,10 +0,0 @@
-export const DatabaseRoutes = {
-    baseUrl: (appSlug: string) => `api/apps/${appSlug}`,
-    dataTables: (tableName: string): string => `/datatables/${tableName}/data`,
-    recordId: (recordId: string): string => `/${recordId}`,
-    upsert: (): string => `/upsert`
-}
-
-type AllRouteKeys = keyof typeof DatabaseRoutes
-export type DatabaseRouteKey = Exclude<AllRouteKeys, 'baseUrl'>
-export type DatabaseUrlParams = Partial<Record<DatabaseRouteKey, string>>

package/src/lib-internal/routes/FunctionRoutes.ts

@@ -1,3 +0,0 @@
-export const FunctionRoutes = {
-    baseUrl: (appSlug: string, functionSlug: string) => `api/apps/${appSlug}/functions/${functionSlug}`
-}

package/src/lib-internal/routes/PolicyRoutes.ts

@@ -1,4 +0,0 @@
-export const PolicyRoutes = {
-    baseUrl: (appSlug: string) => `api/apps/${appSlug}`,
-    checkResource: "/check/resources"
-}

package/src/lib-internal/routes/SecretsRoutes.ts

@@ -1,5 +0,0 @@
-export const SecretsRoutes = {
-    baseUrl: "api/secrets/",
-    get: (key: string) => `api/secrets/${key}/`,
-    update: (key: string) => `api/secrets/${key}/`
-}

package/src/lib-internal/routes/SettingsRoutes.ts

@@ -1,4 +0,0 @@
-export const SettingsRoutes = {
-    metadata: "api/settings/metadata/",
-    userAttributes: "api/settings/user-attributes/"
-}

package/src/lib-internal/routes/StorageRoutes.ts

@@ -1,15 +0,0 @@
-export const StorageRoutes = {
-    baseUrl: (appslug: string, bucket: string) => `api/apps/${appslug}/storage/buckets/${bucket}/objects`,
-    path: (path: string) => "/" + encodeURIComponent(path),
-    upload: () => "/batch-upload",
-    delete: () => "/batch-delete"
-    // bucket: (appslug: string, bucketslug: string) => `${StorageRoutesClone.baseUrl(appslug)}/${bucketslug}`
-}
-
-export type StoragePathKey = 'path'
-export type StorageFlagKey = 'upload' | 'delete'
-export type StorageRouteKey = StoragePathKey | StorageFlagKey
-
-export type BucketUrlParams = Partial<
-    Record<StorageRouteKey, string | true>
->

package/src/lib-internal/routes/UserRoutes.ts

@@ -1,12 +0,0 @@
-export const UserRoutes = {
-    baseUrl: "api/users/",
-    getCurrentUser: () => `${UserRoutes.baseUrl}me/`,
-    preferences: () => `${UserRoutes.baseUrl}me/preferences/`,
-    getUser: (username: string) => `${UserRoutes.baseUrl}${username}/`,
-    updateUser: (username: string) => `${UserRoutes.baseUrl}${username}/`,
-    deleteUser: (username: string) => `${UserRoutes.baseUrl}${username}/`,
-    listUser: (filter: string) => `${UserRoutes.baseUrl}${filter}`,
-    getUserApps: (username: string) => `${UserRoutes.baseUrl}${username}/apps/`,
-    assignRoles: () => `api/assign/roles/`,
-    revokeRoles: () => `api/revoke/roles/`
-} as const

package/src/lib-internal/token/TokenClient.ts

@@ -1,108 +0,0 @@
-import { getRuntimeEnvironment } from "../../utils/utils.js"
-
-/**
- * TokenClient - Manages session token for browser authentication
- */
-export interface AuthTokens {
-    sessionToken: string;
-}
-
-export class TokenClient {
-    private static readonly SESSION_TOKEN_KEY = 'session_token';
-
-    private runTimeEnvironment: string
-    private browserRunTime: boolean
-    private serverToken: string | null = null
-
-    constructor(token?: string) {
-        this.runTimeEnvironment = getRuntimeEnvironment()
-        this.browserRunTime = this.runTimeEnvironment == "Browser"
-
-        if (!this.browserRunTime && token) {
-            this.serverToken = token
-        }
-    }
-
-    /**
-     * Get session token
-     */
-    getSessionToken(): string | null {
-        if (this.browserRunTime) {
-            if (typeof window === 'undefined' || typeof localStorage === 'undefined') {
-                return null
-            }
-            return localStorage.getItem(TokenClient.SESSION_TOKEN_KEY)
-        }
-        return this.serverToken
-    }
-
-    /**
-     * Alias for getSessionToken (used by server-side code)
-     */
-    getToken(): string | null {
-        return this.getSessionToken()
-    }
-
-    /**
-     * Store session token
-     */
-    setTokens(tokens: AuthTokens): void {
-        if (!this.browserRunTime) {
-            console.warn('Token storage is only available in browser environment')
-            return
-        }
-
-        if (typeof window === 'undefined' || typeof localStorage === 'undefined') {
-            return
-        }
-
-        try {
-            localStorage.setItem(TokenClient.SESSION_TOKEN_KEY, tokens.sessionToken)
-        } catch (err) {
-            console.error('Failed to store session token:', err)
-        }
-    }
-
-    /**
-     * Set session token directly
-     */
-    setAccessToken(token: string): void {
-        if (this.browserRunTime) {
-            if (typeof window === 'undefined' || typeof localStorage === 'undefined') return
-            try {
-                localStorage.setItem(TokenClient.SESSION_TOKEN_KEY, token)
-            } catch (err) {
-                console.error('Failed to set session token:', err)
-            }
-        } else {
-            this.serverToken = token
-        }
-    }
-
-    /**
-     * Check if user is authenticated (has a session token)
-     */
-    isAuthenticated(): boolean {
-        return !!this.getSessionToken()
-    }
-
-    /**
-     * Clear session token
-     */
-    clearTokens(): void {
-        if (!this.browserRunTime) {
-            this.serverToken = null
-            return
-        }
-
-        if (typeof window === 'undefined' || typeof localStorage === 'undefined') {
-            return
-        }
-
-        try {
-            localStorage.removeItem(TokenClient.SESSION_TOKEN_KEY)
-        } catch (err) {
-            console.error('Failed to clear session token:', err)
-        }
-    }
-}

package/src/types.ts

@@ -1,104 +0,0 @@
-import { MimeTypeCategory, Visibility } from './utils/enums.js'
-
-export interface TaruviConfig {
-    apiKey: string      // Identifies which site the client belongs to
-    appSlug: string     // Identifies which app the client belongs to
-    apiUrl: string      // Base API URL
-    deskUrl?: string    // URL for the desk/login page
-    token?: string      // Optional: Pre-existing auth token
-}
-
-// Standard response wrapper matching backend AppDataResponse
-export interface TaruviResponse<T = unknown> {
-    status: "success" | "error"
-    message: string
-    data: T
-    total?: number
-    pagination?: PaginationInfo
-}
-
-export interface PaginationInfo {
-    offset: number
-    limit: number
-    count: number
-    current_page: number
-    total_pages: number
-    has_next: boolean
-    has_previous: boolean
-}
-
-export interface StorageFilters {
-    // Pagination (DRF style)
-    page?: number
-    page_size?: number
-
-    // Range Filters - Size (in bytes)
-    size__gte?: number
-    size__lte?: number
-    size__gt?: number
-    size__lt?: number
-    min_size?: number
-    max_size?: number
-
-    // Range Filters - Dates (ISO 8601)
-    created_at__gte?: string
-    created_at__lte?: string
-    created_after?: string
-    created_before?: string
-    updated_at__gte?: string
-    updated_at__lte?: string
-
-    // Search Filters
-    search?: string
-    filename__icontains?: string
-    prefix?: string
-    file?: string
-    file__icontains?: string
-    file__startswith?: string
-    file__istartswith?: string
-    metadata_search?: string
-
-    // MIME Type Filters
-    mimetype?: string
-    mimetype__in?: string
-    mimetype_category?: MimeTypeCategory
-
-    // Visibility & User Filters
-    visibility?: Visibility
-    created_by_me?: boolean
-    modified_by_me?: boolean
-    created_by__username?: string
-    created_by__username__icontains?: string
-
-    // Sorting
-    ordering?: string
-}
-
-export interface DatabaseFilters {
-    // Pagination (DRF style)
-    page?: number
-    page_size?: number
-
-    // Sorting (DRF style: "-field" for desc, "field" for asc)
-    ordering?: string
-
-    // Populate relations
-    populate?: string
-
-    // Search (translates to search_vector__search on backend)
-    search?: string
-
-    // Aggregates
-    _aggregate?: string
-    _group_by?: string
-    _having?: string
-
-    /**
-     * JSON filter tree for the `filters` query param (set via `Database.filters(tree)`).
-     * Do not use the flat `filters(field, …)` triple overload with `field === 'filters'`.
-     */
-    filters?: string
-
-    // Dynamic filters - allows any field with operators
-    [key: string]: string | number | boolean | undefined
-}

package/src/utils/enums.ts

@@ -1,24 +0,0 @@
-export const MimeTypeCategory = {
-    IMAGE: 'image',
-    VIDEO: 'video',
-    AUDIO: 'audio',
-    APPLICATION: 'application',
-    TEXT: 'text'
-} as const
-
-export type MimeTypeCategory = typeof MimeTypeCategory[keyof typeof MimeTypeCategory]
-
-export const Visibility = {
-    PUBLIC: 'public',
-    PRIVATE: 'private'
-} as const
-
-export type Visibility = typeof Visibility[keyof typeof Visibility]
-
-
-export const QueryParams = {
-    include: "include",
-    depth: "depth",
-    format: "format",
-    graph_type: "graph_type",
-}

package/src/utils/utils.ts

@@ -1,38 +0,0 @@
-const _window = typeof window !== 'undefined' ? window : undefined
-const _navigator = typeof navigator !== 'undefined' ? navigator : undefined
-const _document = typeof document !== 'undefined' ? document : undefined
-
-export const isBrowser = (): boolean => {
-    return _window !== undefined && _document !== undefined
-}
-
-export const isReactNative = (): boolean => {
-    return _navigator !== undefined &&
-        // @ts-ignore - navigator.product is deprecated but still used in RN detection
-        _navigator.product === 'ReactNative'
-}
-
-export const getRuntimeEnvironment = (): string => {
-    if (isBrowser()) return 'Browser'
-    if (isReactNative()) return 'ReactNative'
-    return 'Server'
-}
-
-/** Builds a query string. Keys may include pre-flattened bracket names (e.g. CrudFilters `filters[0][field]=...`). */
-export function buildQueryString(queryParams: Record<string, unknown> | undefined): string {
-    if (!queryParams || Object.keys(queryParams).length === 0) {
-        return ''
-    }
-    const params = new URLSearchParams()
-    Object.entries(queryParams).forEach(([key, value]) => {
-        if (value !== undefined && value !== null) {
-            if (Array.isArray(value)) {
-                value.forEach((v) => params.append(key, String(v)))
-            } else {
-                params.append(key, String(value))
-            }
-        }
-    })
-    const queryString = params.toString()
-    return queryString ? `?${queryString}` : ''
-}

package/tests/fixtures/mockClient.ts

@@ -1,19 +0,0 @@
-import { vi } from 'vitest'
-import { Client } from '../../src/client.js'
-
-export const mockHttpClient = {
-    get: vi.fn(),
-    post: vi.fn(),
-    put: vi.fn(),
-    patch: vi.fn(),
-    delete: vi.fn()
-}
-
-export const mockClient = {
-    getConfig: () => ({ apiKey: 'test-key', appSlug: 'test-app', apiUrl: 'https://api.test.com' }),
-    httpClient: mockHttpClient
-} as unknown as Client
-
-export function resetMocks() {
-    vi.clearAllMocks()
-}

package/tests/mocks/db.json

@@ -1 +0,0 @@
-{}

package/tests/unit/analytics/AnalyticsClient.test.ts

@@ -1,84 +0,0 @@
-import { describe, it, expect, vi, beforeEach } from 'vitest'
-import { Analytics } from '../../../src/lib/analytics/AnalyticsClient.js'
-import { Client } from '../../../src/client.js'
-
-const mockHttpClient = {
-    post: vi.fn()
-}
-
-const mockClient = {
-    getConfig: () => ({ apiKey: 'test-key', appSlug: 'test-app', apiUrl: 'https://api.test.com' }),
-    httpClient: mockHttpClient
-} as unknown as Client
-
-describe('Analytics', () => {
-    beforeEach(() => {
-        vi.clearAllMocks()
-    })
-
-    describe('execute()', () => {
-        it('executes analytics query with default options', async () => {
-            const response = { data: { total_sales: 1000 } }
-            mockHttpClient.post.mockResolvedValue(response)
-
-            const analytics = new Analytics(mockClient)
-            const result = await analytics.execute('sales-report')
-
-            expect(mockHttpClient.post).toHaveBeenCalledWith(
-                'api/apps/test-app/analytics/queries/sales-report/execute/',
-                { params: {} }
-            )
-            expect(result).toEqual(response)
-        })
-
-        it('executes analytics query with params', async () => {
-            const response = { data: { total_sales: 5000 } }
-            mockHttpClient.post.mockResolvedValue(response)
-
-            const analytics = new Analytics(mockClient)
-            await analytics.execute('monthly-report', {
-                params: {
-                    start_date: '2024-01-01',
-                    end_date: '2024-12-31'
-                }
-            })
-
-            expect(mockHttpClient.post).toHaveBeenCalledWith(
-                'api/apps/test-app/analytics/queries/monthly-report/execute/',
-                {
-                    params: {
-                        start_date: '2024-01-01',
-                        end_date: '2024-12-31'
-                    }
-                }
-            )
-        })
-
-        it('supports typed response', async () => {
-            interface SalesData {
-                total_sales: number
-                orders_count: number
-            }
-            const response = { data: { total_sales: 10000, orders_count: 50 } }
-            mockHttpClient.post.mockResolvedValue(response)
-
-            const analytics = new Analytics(mockClient)
-            const result = await analytics.execute<SalesData>('sales-summary')
-
-            expect(result.data?.total_sales).toBe(10000)
-            expect(result.data?.orders_count).toBe(50)
-        })
-
-        it('builds correct URL with app slug and query slug', async () => {
-            mockHttpClient.post.mockResolvedValue({})
-
-            const analytics = new Analytics(mockClient)
-            await analytics.execute('dashboard-metrics')
-
-            expect(mockHttpClient.post).toHaveBeenCalledWith(
-                'api/apps/test-app/analytics/queries/dashboard-metrics/execute/',
-                expect.any(Object)
-            )
-        })
-    })
-})