@centrali-io/centrali-sdk 2.9.6 → 2.9.7

package/README.md

@@ -203,6 +203,15 @@ console.log('Query ID:', query.data.id);
 // Execute a smart query
 const results = await centrali.smartQueries.execute('employee', query.data.id);
 console.log('Found:', results.data.length, 'employees');
+
+// Execute with variables
+// Query definition uses {{variableName}} syntax: { where: { status: { $eq: "{{statusFilter}}" } } }
+const filteredResults = await centrali.smartQueries.execute('orders', query.data.id, {
+  variables: {
+    statusFilter: 'active',
+    startDate: '2024-01-01'
+  }
+});
 ```
 
 ### Search

package/dist/index.js

@@ -1095,17 +1095,27 @@ class SmartQueriesManager {
      *
      * @param structureSlug - The structure's record slug
      * @param queryId - The smart query UUID
+     * @param options - Optional execution options including variables
      * @returns Query results
      *
      * @example
      * ```ts
+     * // Simple execution without variables
      * const results = await client.smartQueries.execute('employee', 'query-uuid');
      * console.log('Found:', results.data.length, 'records');
+     *
+     * // Execution with variables
+     * // Query definition: { where: { status: { $eq: "{{statusFilter}}" } } }
+     * const filtered = await client.smartQueries.execute('orders', 'query-id', {
+     *   variables: { statusFilter: 'active' }
+     * });
      * ```
      */
-    execute(structureSlug, queryId) {
+    execute(structureSlug, queryId, options) {
         const path = getSmartQueryExecuteApiPath(this.workspaceId, structureSlug, queryId);
-        return this.requestFn('GET', path);
+        // Use POST to support variables, with empty body if no options
+        const body = (options === null || options === void 0 ? void 0 : options.variables) ? { variables: options.variables } : undefined;
+        return this.requestFn('POST', path, body);
     }
 }
 exports.SmartQueriesManager = SmartQueriesManager;

package/index.ts

@@ -1175,6 +1175,39 @@ export interface ListSmartQueryOptions {
     sortDirection?: 'asc' | 'desc';
 }
 
+/**
+ * Options for executing a smart query.
+ */
+export interface ExecuteSmartQueryOptions {
+    /**
+     * Variables to substitute in the query.
+     * Use mustache-style {{variableName}} syntax in query conditions,
+     * then provide values here at execution time.
+     *
+     * @example
+     * ```ts
+     * // Query definition with variable: { where: { userId: { $eq: "{{currentUserId}}" } } }
+     * const results = await client.smartQueries.execute('orders', 'query-id', {
+     *   variables: { currentUserId: 'user_123' }
+     * });
+     * ```
+     */
+    variables?: Record<string, string>;
+}
+
+/**
+ * Result from executing a smart query with metadata.
+ */
+export interface SmartQueryExecuteResult<T = any> {
+    /** Query results */
+    result: T[];
+    /** Metadata about the execution */
+    meta?: {
+        /** Variables that were used in the query */
+        variablesUsed?: string[];
+    };
+}
+
 // =====================================================
 // Search Types
 // =====================================================
@@ -2648,20 +2681,31 @@ export class SmartQueriesManager {
      *
      * @param structureSlug - The structure's record slug
      * @param queryId - The smart query UUID
+     * @param options - Optional execution options including variables
      * @returns Query results
      *
      * @example
      * ```ts
+     * // Simple execution without variables
      * const results = await client.smartQueries.execute('employee', 'query-uuid');
      * console.log('Found:', results.data.length, 'records');
+     *
+     * // Execution with variables
+     * // Query definition: { where: { status: { $eq: "{{statusFilter}}" } } }
+     * const filtered = await client.smartQueries.execute('orders', 'query-id', {
+     *   variables: { statusFilter: 'active' }
+     * });
      * ```
      */
     public execute<T = any>(
         structureSlug: string,
-        queryId: string
+        queryId: string,
+        options?: ExecuteSmartQueryOptions
     ): Promise<ApiResponse<T[]>> {
         const path = getSmartQueryExecuteApiPath(this.workspaceId, structureSlug, queryId);
-        return this.requestFn<T[]>('GET', path);
+        // Use POST to support variables, with empty body if no options
+        const body = options?.variables ? { variables: options.variables } : undefined;
+        return this.requestFn<T[]>('POST', path, body);
     }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@centrali-io/centrali-sdk",
-  "version": "2.9.6",
+  "version": "2.9.7",
   "description": "Centrali Node SDK",
   "main": "dist/index.js",
   "type": "commonjs",