@baasix/types 1.0.7 → 1.0.8

package/dist/index.d.mts

@@ -729,6 +729,19 @@ interface QueryParams<T = unknown> {
      * Filter conditions for related items (O2M/M2M)
      */
     relConditions?: Record<string, Filter>;
+    /**
+     * Whether to compute the total record count for the result.
+     *
+     * When omitted (`undefined`), the server falls back to the deployment
+     * default (env `COUNT_BY_DEFAULT`, which itself defaults to `true`).
+     * Passing `false` skips the COUNT query even when the default is on;
+     * passing `true` forces it even when the default is off.
+     *
+     * When the count is skipped, `totalCount` is returned as `null`.
+     * When `limit` is `-1` (return all) with no offset, the count is taken
+     * from the result length instead of running a separate query.
+     */
+    count?: boolean;
     /**
      * Additional metadata
      */
@@ -817,7 +830,12 @@ interface StatsResult {
  */
 interface PaginatedResponse<T> {
     data: T[];
-    totalCount?: number;
+    /**
+     * Total number of records matching the query.
+     * `null` when the count was intentionally skipped via `count: false`
+     * (or the deployment default `COUNT_BY_DEFAULT=false`).
+     */
+    totalCount?: number | null;
     page?: number;
     limit?: number;
     totalPages?: number;
@@ -861,7 +879,11 @@ interface BulkResponse<T = string[]> {
  */
 interface ReadResult<T = any> {
     data: T[];
-    totalCount: number;
+    /**
+     * Total number of records matching the query.
+     * `null` when the count was intentionally skipped (see `QueryParams.count`).
+     */
+    totalCount: number | null;
     page?: number;
     limit?: number;
 }

package/dist/index.d.ts

@@ -729,6 +729,19 @@ interface QueryParams<T = unknown> {
      * Filter conditions for related items (O2M/M2M)
      */
     relConditions?: Record<string, Filter>;
+    /**
+     * Whether to compute the total record count for the result.
+     *
+     * When omitted (`undefined`), the server falls back to the deployment
+     * default (env `COUNT_BY_DEFAULT`, which itself defaults to `true`).
+     * Passing `false` skips the COUNT query even when the default is on;
+     * passing `true` forces it even when the default is off.
+     *
+     * When the count is skipped, `totalCount` is returned as `null`.
+     * When `limit` is `-1` (return all) with no offset, the count is taken
+     * from the result length instead of running a separate query.
+     */
+    count?: boolean;
     /**
      * Additional metadata
      */
@@ -817,7 +830,12 @@ interface StatsResult {
  */
 interface PaginatedResponse<T> {
     data: T[];
-    totalCount?: number;
+    /**
+     * Total number of records matching the query.
+     * `null` when the count was intentionally skipped via `count: false`
+     * (or the deployment default `COUNT_BY_DEFAULT=false`).
+     */
+    totalCount?: number | null;
     page?: number;
     limit?: number;
     totalPages?: number;
@@ -861,7 +879,11 @@ interface BulkResponse<T = string[]> {
  */
 interface ReadResult<T = any> {
     data: T[];
-    totalCount: number;
+    /**
+     * Total number of records matching the query.
+     * `null` when the count was intentionally skipped (see `QueryParams.count`).
+     */
+    totalCount: number | null;
     page?: number;
     limit?: number;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@baasix/types",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "description": "Shared TypeScript types for Baasix packages",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",

package/src/query.ts

@@ -353,6 +353,20 @@ export interface QueryParams<T = unknown> {
    */
   relConditions?: Record<string, Filter>;
 
+  /**
+   * Whether to compute the total record count for the result.
+   *
+   * When omitted (`undefined`), the server falls back to the deployment
+   * default (env `COUNT_BY_DEFAULT`, which itself defaults to `true`).
+   * Passing `false` skips the COUNT query even when the default is on;
+   * passing `true` forces it even when the default is off.
+   *
+   * When the count is skipped, `totalCount` is returned as `null`.
+   * When `limit` is `-1` (return all) with no offset, the count is taken
+   * from the result length instead of running a separate query.
+   */
+  count?: boolean;
+
   /**
    * Additional metadata
    */

package/src/response.ts

@@ -12,7 +12,12 @@
  */
 export interface PaginatedResponse<T> {
   data: T[];
-  totalCount?: number;
+  /**
+   * Total number of records matching the query.
+   * `null` when the count was intentionally skipped via `count: false`
+   * (or the deployment default `COUNT_BY_DEFAULT=false`).
+   */
+  totalCount?: number | null;
   page?: number;
   limit?: number;
   totalPages?: number;
@@ -55,7 +60,11 @@ export interface BulkResponse<T = string[]> {
  */
 export interface ReadResult<T = any> {
   data: T[];
-  totalCount: number;
+  /**
+   * Total number of records matching the query.
+   * `null` when the count was intentionally skipped (see `QueryParams.count`).
+   */
+  totalCount: number | null;
   page?: number;
   limit?: number;
 }