@querypanel/node-sdk 1.2.4 → 1.2.6

package/README.md

@@ -201,6 +201,45 @@ if (response.chart.vegaLiteSpec) {
 const charts = await qp.listCharts({ tenantId: "tenant_123" });
 ```
 
+### Saved charts via `/charts/all`
+
+`listAllCharts()` calls **`GET /charts/all`**. It accepts the **same options as `listCharts()`** (including **`pagination`** with `page` and `limit`, filters, and sort).
+
+**Breaking change:** Older SDK versions returned a **plain array** of charts from `listAllCharts()`. Current versions return **`{ data, pagination }`**, the same **`PaginatedResponse`** shape as **`listCharts()`**. Update callers from `const charts = await qp.listAllCharts(...)` to **`const { data: charts, pagination } = await qp.listAllCharts(...)`** (or use **`result.data`** only).
+
+```ts
+const { data, pagination } = await qp.listAllCharts({
+  tenantId: "tenant_123",
+  pagination: { page: 1, limit: 50 },
+  includeData: true,
+});
+
+// Walk every page (same pattern as listCharts)
+let page = 1;
+const limit = 50;
+let allCharts: typeof data = [];
+for (;;) {
+  const res = await qp.listAllCharts({
+    tenantId: "tenant_123",
+    pagination: { page, limit },
+  });
+  allCharts = allCharts.concat(res.data);
+  if (!res.pagination.hasNext) break;
+  page += 1;
+}
+```
+
+### Bulk fetch saved charts by ID
+
+To load specific saved charts by their **chart UUIDs** (from `createChart` or list responses), use `getChartsByIds()`. It calls **`GET /charts/bulk`** with `ids` as repeated or comma-separated query params. The API returns **`{ data, missingIds }`**. Up to **100** UUIDs per request.
+
+```ts
+const { data, missingIds } = await qp.getChartsByIds(
+  ["550e8400-e29b-41d4-a716-446655440000"],
+  { tenantId: "tenant_123", includeData: true },
+);
+```
+
 Saved charts now include the original `prompt` so you can show the question
 alongside chart history or reuse it in follow-up workflows.
 
@@ -366,6 +405,37 @@ dashboard.data.forEach(item => {
 });
 ```
 
+### All active charts (no pagination)
+
+`listActiveCharts()` is **paginated** (default page size is small). To load every pinned chart for a tenant in one round trip, use `listAllActiveCharts()`, which calls **`GET /active-charts/all`** and returns `{ data }` from the API as a plain array.
+
+```ts
+const all = await qp.listAllActiveCharts({
+  tenantId: "tenant_123",
+  withData: true, // optional: same as listActiveCharts — runs SQL per chart via your attached DB
+});
+```
+
+### Bulk fetch by active-chart IDs
+
+To load only specific dashboard tiles by their **active chart row IDs** (UUIDs from `createActiveChart` / `listActiveCharts`), use `getActiveChartsByIds()`. It calls **`GET /active-charts/bulk`** with query params `ids` (repeat or comma-separated). The API returns **`{ data, missingIds }`**: rows you are allowed to see, plus any requested IDs that were not found or not in scope.
+
+```ts
+const { data, missingIds } = await qp.getActiveChartsByIds(
+  ["550e8400-e29b-41d4-a716-446655440000", "550e8400-e29b-41d4-a716-446655440001"],
+  {
+    tenantId: "tenant_123",
+    withData: true, // optional
+  },
+);
+
+if (missingIds.length) {
+  console.warn("Unknown or inaccessible active charts:", missingIds);
+}
+```
+
+The API accepts up to **100** UUIDs per request. Examples: `?ids=a&ids=b` or `?ids=a,b`.
+
 ## Deno Support
 
 The SDK is fully compatible with Deno (including Supabase Edge Functions) thanks to its use of Web Crypto API for JWT signing. No additional configuration needed:

package/dist/index.cjs

@@ -1305,6 +1305,61 @@ async function listCharts(client, queryEngine, options, signal) {
   }
   return response;
 }
+async function listAllCharts(client, queryEngine, options, signal) {
+  const tenantId = resolveTenantId(client, options?.tenantId);
+  const params = new URLSearchParams();
+  if (options?.pagination?.page)
+    params.set("page", `${options.pagination.page}`);
+  if (options?.pagination?.limit)
+    params.set("limit", `${options.pagination.limit}`);
+  if (options?.sortBy) params.set("sort_by", options.sortBy);
+  if (options?.sortDir) params.set("sort_dir", options.sortDir);
+  if (options?.title) params.set("title", options.title);
+  if (options?.userFilter) params.set("user_id", options.userFilter);
+  if (options?.createdFrom) params.set("created_from", options.createdFrom);
+  if (options?.createdTo) params.set("created_to", options.createdTo);
+  if (options?.updatedFrom) params.set("updated_from", options.updatedFrom);
+  if (options?.updatedTo) params.set("updated_to", options.updatedTo);
+  const response = await client.get(
+    `/charts/all${params.toString() ? `?${params.toString()}` : ""}`,
+    tenantId,
+    options?.userId,
+    options?.scopes,
+    signal
+  );
+  if (options?.includeData) {
+    response.data = await Promise.all(
+      response.data.map(async (chart) => {
+        const rows = await executeChartQuery(queryEngine, chart, tenantId);
+        return hydrateChartWithData(chart, rows);
+      })
+    );
+  }
+  return response;
+}
+async function getChartsByIds(client, queryEngine, ids, options, signal) {
+  const tenantId = resolveTenantId(client, options?.tenantId);
+  const params = new URLSearchParams();
+  for (const id of ids) {
+    params.append("ids", id);
+  }
+  const response = await client.get(
+    `/charts/bulk${params.toString() ? `?${params.toString()}` : ""}`,
+    tenantId,
+    options?.userId,
+    options?.scopes,
+    signal
+  );
+  if (options?.includeData) {
+    response.data = await Promise.all(
+      response.data.map(async (chart) => {
+        const rows = await executeChartQuery(queryEngine, chart, tenantId);
+        return hydrateChartWithData(chart, rows);
+      })
+    );
+  }
+  return response;
+}
 async function getChart(client, queryEngine, id, options, signal) {
   const tenantId = resolveTenantId(client, options?.tenantId);
   const chart = await client.get(
@@ -2772,6 +2827,29 @@ var QueryPanelSdkAPI = class _QueryPanelSdkAPI {
       signal
     );
   }
+  /**
+   * Lists saved charts via `GET /charts/all` (same query, filters, and pagination as {@link listCharts}).
+   */
+  async listAllCharts(options, signal) {
+    return await listAllCharts(
+      this.client,
+      this.queryEngine,
+      options,
+      signal
+    );
+  }
+  /**
+   * Bulk gets saved charts by chart IDs (`GET /charts/bulk` with `ids` query params).
+   */
+  async getChartsByIds(ids, options, signal) {
+    return await getChartsByIds(
+      this.client,
+      this.queryEngine,
+      ids,
+      options,
+      signal
+    );
+  }
   // Session history CRUD operations
   /**
    * Lists query sessions with pagination and filtering.