@squidcloud/client 1.0.447 → 1.0.448

package/dist/internal-common/src/public-types/ai-query.public-types.d.ts

@@ -2,6 +2,15 @@ import { AiAgentMemoryOptions, AiChatOptions, AiFileUrl, AiSessionContext } from
 import { ApiOptions } from './api-client.public-types';
 import { AiAgentId, IntegrationId } from './communication.public-types';
 import { PartialBy } from './typescript.public-types';
+/** A single output column descriptor in a raw query result file. */
+export interface AiQueryResultFieldSchema {
+    /** Column name as it appears in the query result. */
+    name: string;
+    /** Data type of the column (e.g. "varchar", "int", "decimal"). */
+    type: string;
+    /** Human-readable description of what the column represents. */
+    desc: string;
+}
 /**
  * Options for configuring AI query execution.
  * @category AI
@@ -102,7 +111,7 @@ export interface AiQueryAnalyzeResultsOptions {
     agentId?: AiAgentId;
 }
 /**
- * Information about an executed query in a multi-query scenario.
+ * Information about an executed query.
  * @category AI
  */
 export interface ExecutedQueryInfo {

package/dist/internal-common/src/public-types/query.public-types.d.ts

@@ -97,6 +97,8 @@ export interface Query<Doc extends DocumentData = any> {
     limit: number;
     /** Optional configuration to limit results by specific fields with custom sorting. */
     limitBy?: LimitBy<Doc>;
+    /** Optional list of fields to return. If null/undefined, all fields are returned. If empty array, only metadata/IDs are returned. */
+    projectFields?: Array<FieldName<Doc>>;
 }
 /**
  * A configuration object used to apply additional field-based limits to a query.

package/dist/typescript-client/src/document-reference.d.ts

@@ -17,6 +17,7 @@ export declare class DocumentReference<T extends DocumentData = any> {
     private _squidDocId;
     private readonly dataManager;
     private readonly queryBuilderFactory;
+    private readonly projectFields?;
     /** A string that uniquely identifies this document reference. */
     refId: string;
     /**

package/dist/typescript-client/src/query/join-query-builder.factory.d.ts

@@ -4,6 +4,11 @@ import { Alias, DocumentData, FieldName, FieldSort, Operator, PrimitiveFieldType
 import { Pagination, PaginationOptions } from './pagination';
 import { BaseQueryBuilder, HasDereference, QueryBuilder } from './query-builder.factory';
 import { SnapshotEmitter } from './snapshot-emitter';
+/** Result type after projection: only the selected fields.
+ * Note: __docId__ and PKs are still returned at runtime, but not included in the type.
+ * Users must explicitly project fields they want in the type.
+ */
+type ProjectedResult<T, K extends keyof T> = Pick<T, K>;
 /**
  * Represents the result of a join query where each property is a document reference,
  * grouped by alias instead of containing DocumentData.
@@ -110,6 +115,8 @@ export declare class JoinQueryBuilder<Aliases extends Record<Alias, Alias[]>, Re
      * @returns The query builder
      */
     sortBy(fieldName: (keyof ReturnType[RootAlias] & FieldName) | string, asc?: boolean): this;
+    /** @inheritDoc */
+    projectFields<K extends keyof ReturnType & FieldName>(_fields: K[]): JoinQueryBuilder<Aliases, ProjectedResult<ReturnType, K>, LatestAlias, RootAlias>;
     /**
      * Joins this query with another collection using a specified alias from the left side of the join,
      * allowing you to build complex multi-level joins. The join is defined by specifying which fields
@@ -314,3 +321,4 @@ export declare class GroupedJoin<Aliases extends Record<Alias, Alias[]>, ReturnT
     paginate(options?: Partial<PaginationOptions>): Pagination<Grouped<Aliases, WithDocumentReferences<ReturnType>, RootAlias>>;
     private groupData;
 }
+export {};

package/dist/typescript-client/src/query/query-builder.factory.d.ts

@@ -3,6 +3,11 @@ import { DocumentReference } from '../document-reference';
 import { DocumentData, FieldName, FieldSort, Operator, PrimitiveFieldType, Query, SerializedSimpleQuery, SimpleCondition } from '../public-types';
 import { Pagination, PaginationOptions } from './pagination';
 import { SnapshotEmitter } from './snapshot-emitter';
+/** Result type after projection: only the selected fields.
+ * Note: __docId__ and PKs are still returned at runtime, but not included in the type.
+ * Users must explicitly project fields they want in the type.
+ */
+type ProjectedResult<T, K extends keyof T> = Pick<T, K>;
 /**
  * Interface used solely for inheritDoc
  * @category Database
@@ -150,6 +155,13 @@ export declare abstract class BaseQueryBuilder<MyDocType extends DocumentData> {
      * Returns the query object built by this query builder.
      */
     abstract build(): Query;
+    /**
+     * Specifies which fields to return from the query. If not called, all fields are returned.
+     * Use to improve query performance by reducing the amount of data transferred.
+     * @param fields The fields to include in the query results.
+     * @returns A query builder with the narrowed return type containing only the projected fields
+     */
+    abstract projectFields<K extends keyof MyDocType & FieldName>(fields: K[]): BaseQueryBuilder<ProjectedResult<MyDocType, K>>;
     private throwIfInvalidLikePattern;
 }
 /**
@@ -181,6 +193,8 @@ export declare class QueryBuilder<DocumentType extends DocumentData> extends Bas
     /** @inheritDoc */
     sortBy(fieldName: (keyof DocumentType & FieldName) | string, asc?: boolean): this;
     /** @inheritDoc */
+    projectFields<K extends keyof DocumentType & FieldName>(fields: K[]): QueryBuilder<ProjectedResult<DocumentType, K>>;
+    /** @inheritDoc */
     build(): Query;
     getSortOrder(): FieldSort<DocumentType>[];
     /**
@@ -226,3 +240,4 @@ export declare class Changes<DocumentType extends DocumentData> {
     /** The actual document data that was deleted from the query result */
     readonly deletes: Array<DocumentType>;
 }
+export {};

package/dist/typescript-client/src/version.d.ts

@@ -2,4 +2,4 @@
  * The current version of the SquidCloud client package.
  * @category Platform
  */
-export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.447";
+export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.448";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.447",
+  "version": "1.0.448",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",