@taruvi/sdk 1.1.5 → 1.1.7

package/AI_IMPLEMENTATION_GUIDE.md

@@ -708,8 +708,7 @@ import { Analytics } from '@taruvi-io/sdk'
 
 const analytics = new Analytics(taruviClient)
 
-const result = await analytics.execute({
-  name: "monthly_sales_report",
+const result = await analytics.execute("monthly-sales-report", {
   params: {
     start_date: "2024-01-01",
     end_date: "2024-12-31"
@@ -730,8 +729,7 @@ interface SalesData {
 
 const analytics = new Analytics(taruviClient)
 
-const result = await analytics.execute<SalesData>({
-  name: "sales_summary",
+const result = await analytics.execute<SalesData>("sales-summary", {
   params: { period: "monthly" }
 })
 
@@ -753,8 +751,7 @@ export default function AnalyticsDashboard({ taruviClient }) {
     const fetchMetrics = async () => {
       try {
         const analytics = new Analytics(taruviClient)
-        const result = await analytics.execute({
-          name: "dashboard_metrics",
+        const result = await analytics.execute("dashboard-metrics", {
           params: {
             date_range: "last_30_days"
           }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@taruvi/sdk",
-  "version": "1.1.5",
+  "version": "1.1.7",
   "description": "Taruvi SDK",
   "main": "src/index.ts",
   "type": "module",

package/src/lib/Analytics/AnalyticsClient.ts

@@ -12,11 +12,10 @@ export class Analytics {
         this.config = this.client.getConfig()
     }
 
-    async execute<T = unknown>(options: AnalyticsRequest): Promise<AnalyticsResponse<T>> {
-        const url = `${AnalyticsRoutes.baseUrl(this.config.appSlug)}${AnalyticsRoutes.execute}`
+    async execute<T = unknown>(querySlug: string, options: AnalyticsRequest = {}): Promise<AnalyticsResponse<T>> {
+        const url = AnalyticsRoutes.baseUrl(this.config.appSlug, querySlug)
 
         const body = {
-            name: options.name,
             params: options.params || {}
         }
 

package/src/lib/Analytics/types.ts

@@ -1,5 +1,4 @@
 export interface AnalyticsRequest {
-    name: string
     params?: Record<string, unknown>
 }
 

package/src/lib/Database/DatabaseClient.ts

@@ -12,15 +12,15 @@ export class Database {
     private config: TaruviConfig
     private operation: HttpMethod | undefined
     private body: object | undefined
-    private filters: DatabaseFilters | undefined
+    private queryParams: DatabaseFilters | undefined
 
-    constructor(client: Client, urlParams: UrlParams = {}, operation?: HttpMethod | undefined, body?: object | undefined, filters?: DatabaseFilters) {
+    constructor(client: Client, urlParams: UrlParams = {}, operation?: HttpMethod | undefined, body?: object | undefined, queryParams?: DatabaseFilters) {
         this.client = client
         this.urlParams = urlParams
         this.operation = operation
         this.body = body
         this.config = this.client.getConfig()
-        this.filters = filters
+        this.queryParams = queryParams
     }       
 
     from(dataTables: string): Database {
@@ -28,7 +28,11 @@ export class Database {
     }
 
     filter(filters: DatabaseFilters): Database {
-        return new Database(this.client, { ...this.urlParams }, undefined, undefined, filters)
+        return new Database(this.client, { ...this.urlParams }, undefined, undefined, {...this.queryParams, ...filters})
+    }
+
+    populate(populate: string[]): Database {
+        return new Database(this.client, { ...this.urlParams, }, undefined, undefined, {...this.queryParams, populate: populate.join(',')})
     }
 
     get(recordId: string): Database {
@@ -60,7 +64,7 @@ export class Database {
                 return acc
             }, "") +
             "/" +
-            buildQueryString(this.filters)
+            buildQueryString(this.queryParams)
         )
     }
 

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

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

package/src/utils/utils.ts

@@ -21,12 +21,12 @@ export const getRuntimeEnvironment = (): string => {
     return 'Server'
 }
 
-export function buildQueryString(filters: Record<string, unknown> | undefined): string {
-    if (!filters || Object.keys(filters).length === 0) {
+export function buildQueryString(queryParams: Record<string, unknown> | undefined): string {
+    if (!queryParams || Object.keys(queryParams).length === 0) {
         return ''
     }
     const params = new URLSearchParams()
-    Object.entries(filters).forEach(([key, value]) => {
+    Object.entries(queryParams).forEach(([key, value]) => {
         if (value !== undefined && value !== null) {
             params.append(key, String(value))
         }