@taruvi/sdk 1.5.0 → 1.5.1

package/PARAMETER_NAMING_CHANGES.md

@@ -1,106 +0,0 @@
-# Parameter Naming Change: baseUrl → apiUrl
-
-**Date**: 2026-01-22  
-**Status**: ✅ Completed
-
-## Changes Made
-
-### Type Definitions
-
-**File**: `src/types.ts`
-- Changed `baseUrl: string` → `apiUrl: string`
-- Updated comment: "Base API URL"
-
-### Client Constructor
-
-**File**: `src/client.ts`
-- Updated validation: `config.baseUrl` → `config.apiUrl`
-- Updated error message: "Base URL is required" → "API URL is required"
-
-### HTTP Client
-
-**File**: `src/lib-internal/http/HttpClient.ts`
-- Updated all HTTP methods to use `config.apiUrl` instead of `config.baseUrl`:
-  - `get()` method
-  - `post()` method
-  - `put()` method
-  - `delete()` method
-  - `patch()` method
-
-### Auth Client
-
-**File**: `src/lib/auth/AuthClient.ts`
-- Updated `login()`: `config.deskUrl || config.baseUrl` → `config.deskUrl || config.apiUrl`
-- Updated `signup()`: `config.baseUrl` → `config.apiUrl`
-- Updated `logout()`: `config.deskUrl || config.baseUrl` → `config.deskUrl || config.apiUrl`
-- Updated `refreshAccessToken()`: `config.baseUrl` → `config.apiUrl`
-
-### Documentation
-
-**File**: `README.md`
-- Updated all examples: `baseUrl:` → `apiUrl:`
-- Updated environment variable: `VITE_TARUVI_BASE_URL` → `VITE_TARUVI_API_URL`
-
-## Build Status
-
-✅ TypeScript compilation successful  
-✅ No errors or warnings
-
-## Alignment with Python SDK
-
-This change aligns the JavaScript SDK with the Python SDK naming convention:
-
-**Python SDK**:
-```python
-client = Client(
-    api_url="https://api.taruvi.cloud",
-    app_slug="my-app"
-)
-```
-
-**JavaScript SDK** (now aligned):
-```typescript
-const client = new Client({
-    apiUrl: "https://api.taruvi.cloud",
-    appSlug: "my-app",
-    apiKey: "your-api-key"
-})
-```
-
-## Breaking Change
-
-⚠️ **This is a breaking change**
-
-Users must update their configuration:
-
-```typescript
-// ❌ Old (will break)
-const client = new Client({
-    baseUrl: "https://api.taruvi.cloud",
-    appSlug: "my-app",
-    apiKey: "key"
-})
-
-// ✅ New (correct)
-const client = new Client({
-    apiUrl: "https://api.taruvi.cloud",
-    appSlug: "my-app",
-    apiKey: "key"
-})
-```
-
-## Migration Guide
-
-1. Find all `baseUrl` references in your code
-2. Replace with `apiUrl`
-3. Update environment variables: `VITE_TARUVI_BASE_URL` → `VITE_TARUVI_API_URL`
-
-## Next Steps
-
-As per the SDK Alignment Analysis:
-
-1. ✅ Module naming - COMPLETED
-2. ✅ Parameter naming (baseUrl → apiUrl) - COMPLETED
-3. ⏭️ Add direct CRUD methods to Database module
-4. ⏭️ Remove `.execute()` requirement from Storage
-5. ⏭️ Add missing methods to Functions module

package/USAGE_EXAMPLE.md

@@ -1,86 +0,0 @@
-# Taruvi SDK - Usage Example
-
-## New Pattern: Dependency Injection (No Singleton)
-
-### Basic Usage
-
-```typescript
-import { Client, Auth, User, Database } from '@taruvi/sdk'
-
-// 1. Create the main client (can create multiple instances)
-const client = new Client({
-  apiKey: 'your-site-key',
-  appSlug: 'my-app',
-  baseUrl: 'https://api.taruvi.com',
-  token: 'optional-initial-token' // optional
-})
-
-// 2. Create only the clients you need (lazy initialization)
-const auth = new Auth(client)
-const user = new User(client)
-const database = new Database(client)
-
-// 3. Use the clients
-if (auth.isUserAuthenticated()) {
-  console.log('User is authenticated')
-}
-
-const token = auth.signInWithSSO()
-console.log('Token:', token)
-
-const userDetails = user.getUser()
-console.log('User:', userDetails)
-
-// Access token via User
-console.log('Current token:', user.token)
-```
-
-### Multiple Instances
-
-You can now create multiple instances for different environments or configs:
-
-```typescript
-const prodClient = new Client({
-  apiKey: 'prod-key',
-    appSlug: 'main-app',
-  baseUrl: 'https://api.taruvi.com'
-})
-
-const devClient = new Client({
-  apiKey: 'dev-key',
-    appSlug: 'dev-app',
-  baseUrl: 'https://dev-api.taruvi.com'
-})
-
-const prodAuth = new Auth(prodClient)
-const devAuth = new Auth(devClient)
-```
-
-### Benefits
-
-✅ **No singleton** - Multiple instances possible
-✅ **Lazy initialization** - Only create clients you need
-✅ **Better testability** - Easy to mock and test
-✅ **Explicit dependencies** - Clear what each client needs
-✅ **No global state** - No hidden global `taruvi` variable
-✅ **Tree-shakable** - Only bundle what you use
-
-### Internal Architecture
-
-The `taruvi` variable is no longer exported. Internal clients like `httpClient` and `tokenClient` are accessible only within the SDK through the `Client` instance passed to each client.
-
-```typescript
-// Inside Auth
-export class Auth {
-  private client: Client
-
-  constructor(client: Client) {
-    this.client = client
-  }
-
-  isUserAuthenticated(): boolean {
-    // Access internal tokenClient through the client instance
-    return !!this.client.tokenClient.getToken()
-  }
-}
-```

package/src/index.ts

@@ -1,50 +0,0 @@
-// Export main client
-export { Client } from "./client.js"
-
-// Export error classes
-export { TaruviError, ValidationError, AuthError, ForbiddenError, NotFoundError, ConflictError, TimeoutError, NetworkError, RateLimitError } from "./lib-internal/errors/index.js"
-export { ErrorCode } from "./lib-internal/errors/index.js"
-export type { ErrorResponseBody } from "./lib-internal/errors/index.js"
-
-// Export public client classes
-export { Auth } from "./lib/auth/AuthClient.js"
-export { User } from "./lib/users/UserClient.js"
-export { Storage } from "./lib/storage/StorageClient.js"
-export { Database } from "./lib/database/DatabaseClient.js"
-export { Settings } from "./lib/settings/SettingsClient.js"
-export { Functions } from "./lib/functions/FunctionsClient.js"
-export { Secrets } from "./lib/secrets/SecretsClient.js"
-export { Policy } from "./lib/policy/PolicyClient.js"
-export { App } from "./lib/app/AppClient.js"
-export { Analytics } from "./lib/analytics/AnalyticsClient.js"
-
-// Export core types
-export type { TaruviConfig, TaruviResponse, PaginationInfo, StorageFilters, DatabaseFilters } from "./types.js"
-export type { AuthTokens } from "./lib-internal/token/TokenClient.js"
-
-// User types
-export type { UserCreateRequest, UserData, UserUpdateRequest, UserListFilters, UserApp, UserResponse, UserListResponse, UserAppsResponse, AssignRolesRequest, RevokeRolesRequest, RolesResponse, UserGroup, UserPermission, UserRole, UserPreferences, UserPreferencesUpdate, UserPreferencesResponse } from "./lib/users/types.js"
-
-// Policy types
-export type { Principal, Resource, Resources, PolicyCheckResult, PolicyCheckBatchResult, ResourceCheckResponse, GetAllowedActionsOptions } from "./lib/policy/types.js"
-
-// App types
-export type { RoleData, AppSettingsData, RoleResponse, RolesListResponse, AppSettingsResponse } from "./lib/app/types.js"
-
-// Function types
-export type { FunctionRequest, FunctionResponse, FunctionInvocation } from "./lib/functions/types.js"
-
-// Database types
-export type { DatabaseRequest, DatabaseResponse, DatabaseSingleResponse, FilterOperator, SortOrder, GraphInclude, GraphFormat, EdgeRequest, EdgeResponse, EdgeDeleteRequest } from "./lib/database/types.js"
-
-// Storage types
-export type { StorageRequest, StorageUpdateRequest, StorageObject, StorageResponse, StorageListResponse, StorageUploadBatchResponse, StorageDeleteBatchResponse } from "./lib/storage/types.js"
-
-// Settings types
-export type { SiteSettingsData, SettingsResponse } from "./lib/settings/types.js"
-
-// Secrets types
-export type { SecretCreateRequest, SecretUpdateRequest, SecretData, SecretResponse, SecretsListResponse, SecretsBatchResponse, SecretsBatchMetadataResponse, GetSecretOptions, GetSecretsOptions } from "./lib/secrets/types.js"
-
-// Analytics types
-export type { AnalyticsRequest, AnalyticsResponse } from "./lib/analytics/types.js"

package/src/lib/analytics/AnalyticsClient.ts

@@ -1,24 +0,0 @@
-import type { Client } from "../../client.js";
-import type { TaruviConfig } from "../../types.js";
-import type { AnalyticsRequest, AnalyticsResponse } from "./types.js";
-import { AnalyticsRoutes } from "../../lib-internal/routes/AnalyticsRoutes.js";
-
-export class Analytics {
-    private client: Client
-    private config: TaruviConfig
-
-    constructor(client: Client) {
-        this.client = client
-        this.config = this.client.getConfig()
-    }
-
-    async execute<T = unknown>(querySlug: string, options: AnalyticsRequest = {}): Promise<AnalyticsResponse<T>> {
-        const url = AnalyticsRoutes.baseUrl(this.config.appSlug, querySlug)
-
-        const body = {
-            params: options.params || {}
-        }
-
-        return await this.client.httpClient.post<AnalyticsResponse<T>>(url, body)
-    }
-}

package/src/lib/analytics/types.ts

@@ -1,8 +0,0 @@
-import type { TaruviResponse } from "../../types.js"
-
-export interface AnalyticsRequest {
-    params?: Record<string, unknown>
-}
-
-// Response type - uses standard wrapper
-export type AnalyticsResponse<T = unknown> = TaruviResponse<T>

package/src/lib/app/AppClient.ts

@@ -1,54 +0,0 @@
-import type { Client } from "../../client.js";
-import { AppRoutes, type AppRouteKey } from "../../lib-internal/routes/AppRoutes.js";
-import { HttpMethod } from "../../lib-internal/http/types.js";
-import type { TaruviConfig } from "../../types.js";
-import type { UrlParams } from "./types.js";
-
-export class App {
-    private client: Client
-    private urlParams: UrlParams
-    private config: TaruviConfig
-    private operation: HttpMethod | undefined
-
-    constructor(client: Client, urlParams: UrlParams = {}, operation?: HttpMethod | undefined) {
-        this.client = client
-        this.urlParams = urlParams
-        this.operation = operation
-        this.config = this.client.getConfig()
-    }
-
-    roles() {
-        return new App(this.client, { ...this.urlParams, roles: "roles" }, HttpMethod.GET)
-    }
-
-    settings() {
-        return new App(this.client, {...this.urlParams, settings: "settings"}, HttpMethod.GET)
-    }
-
-    private buildRoute(): string {
-        return (
-            AppRoutes.baseUrl(this.config.appSlug) +
-            (Object.keys(this.urlParams) as AppRouteKey[]).reduce((acc, key) => {
-                const value = this.urlParams[key]
-                const routeBuilder = AppRoutes[key]
-
-                if (value && routeBuilder) {
-                    acc += routeBuilder()
-                }
-
-                return acc
-            }, "")
-        )
-    }
-
-    async execute() {
-        const url = this.buildRoute()
-        const operation = this.operation || HttpMethod.GET
-
-        switch (operation) {
-            case HttpMethod.GET:
-            default:
-                return await this.client.httpClient.get(url)
-        }
-    }
-}

package/src/lib/app/types.ts

@@ -1,50 +0,0 @@
-import type { Client } from "../../client.js"
-import { HttpMethod } from "../../lib-internal/http/types.js"
-import type { TaruviResponse } from "../../types.js"
-
-export type AppOperation = HttpMethod
-
-// Internal types
-export interface UrlParams {
-    appSlug?: string
-    roles?: string
-    settings?: string
-}
-
-export interface AppClientInterface {
-    client: Client
-    urlParams?: UrlParams
-}
-
-// Role data
-export interface RoleData {
-    id: string | number
-    name: string
-    slug: string
-    description?: string
-    permissions?: string[]
-    created_at?: string
-    updated_at?: string
-}
-
-// App settings data
-export interface AppSettingsData {
-    display_name: string
-    icon: string | null
-    icon_url: string | null
-    primary_color: string
-    secondary_color: string
-    banner_image: string | null
-    banner_image_url: string | null
-    category: string
-    documentation_url: string | null
-    support_email: string | null
-    default_frontend_worker_url: string | null
-    created_at: string
-    updated_at: string
-}
-
-// Response types - uses standard wrapper
-export type RoleResponse = TaruviResponse<RoleData>
-export type RolesListResponse = TaruviResponse<RoleData[]>
-export type AppSettingsResponse = TaruviResponse<AppSettingsData>

package/src/lib/auth/types.ts

@@ -1,123 +0,0 @@
-export interface UserCreateRequest {
-    // Required fields
-    username: string
-    email: string
-    first_name: string
-    last_name: string
-    password: string
-    confirm_password: string
-    // Optional fields
-    is_active?: boolean
-    is_staff?: boolean
-    attributes?: string
-}
-
-export interface UserCreateResponse {
-    id: string
-    username: string
-    email: string
-    first_name: string
-    last_name: string
-    full_name: string
-    is_active: boolean
-    is_superuser: boolean
-    is_deleted: boolean
-    date_joined: string
-    last_login: string
-    groups: UserGroup[]
-    user_permissions: UserPermission[]
-    attributes: Record<string, unknown>
-    missing_attributes: string[]
-    roles: UserRole[]
-    icon_url: string | null
-}
-
-export interface UserGroup {
-    id: number
-    name: string
-}
-
-export interface UserPermission {
-    id: number
-    name: string
-    codename: string
-    content_type: string // "app_label.model"
-}
-
-export interface UserRole {
-    name: string
-    slug: string
-    type: "app_role"
-    app_slug: string
-    source: "direct" | "site_role" | "inherited"
-}
-
-export interface UserDataResponse {
-    id: string
-    username: string
-    email: string
-    first_name: string
-    last_name: string
-    full_name: string
-    is_active: boolean
-    is_superuser: boolean
-    is_deleted: boolean
-    date_joined: string
-    last_login: string
-    groups: UserGroup[]
-    user_permissions: UserPermission[]
-    attributes: Record<string, unknown>
-    missing_attributes: string[]
-    roles: UserRole[]
-    icon_url: string | null
-}
-
-export interface UserUpdateRequest {
-    username?: string
-    email?: string
-    first_name?: string
-    last_name?: string
-    is_active?: boolean
-    is_staff?: boolean
-}
-
-export interface UserUpdateResponse {
-    id: string
-    username: string
-    email: string
-    first_name: string
-    last_name: string
-    full_name: string
-    is_active: boolean
-    is_superuser: boolean
-    is_deleted: boolean
-    date_joined: string
-    last_login: string
-    groups: UserGroup[]
-    user_permissions: UserPermission[]
-    attributes: Record<string, unknown>
-    missing_attributes: string[]
-    roles: UserRole[]
-    icon_url: string | null
-}
-
-export interface UserList {
-    search: string
-    is_active: boolean
-    is_staff: boolean
-    is_superuser: boolean
-    is_deleted: boolean
-    ordering: string
-    page: Number
-    page_size: Number
-}
-
-export interface UserApp {
-    name: string
-    slug: string
-    icon: string
-    url: string
-    display_name: string
-}
-
-export type UserAppsResponse = UserApp[]