google-ads-api 13.0.0-global-service-cache-alpha-0 → 13.0.1

package/build/src/customer.d.ts

@@ -10,7 +10,7 @@ export declare class Customer extends ServiceFactory {
       @description Single query using a raw GAQL string.
       @hooks onQueryStart, onQueryError, onQueryEnd
     */
-    query<T = services.IGoogleAdsRow[]>(gaqlQuery: string, requestOptions?: RequestOptions): Promise<T>;
+    query<T = services.IGoogleAdsRow[]>(gaqlQuery: string, requestOptions?: Readonly<RequestOptions>): Promise<T>;
     /**
       @description Stream query using a raw GAQL string. If a generic type is provided, it must be the type of a single row.
       If a summary row is requested then this will be the last emitted row of the stream.
@@ -19,18 +19,18 @@ export declare class Customer extends ServiceFactory {
       const stream = queryStream<T>(gaqlQuery)
       for await (const row of stream) { ... }
     */
-    queryStream<T = services.IGoogleAdsRow>(gaqlQuery: string, requestOptions?: RequestOptions): AsyncGenerator<T>;
+    queryStream<T = services.IGoogleAdsRow>(gaqlQuery: string, requestOptions?: Readonly<RequestOptions>): AsyncGenerator<T>;
     /**
       @description Single query using ReportOptions.
       If a summary row is requested then this will be the first row of the results.
       @hooks onQueryStart, onQueryError, onQueryEnd
     */
-    report<T = services.IGoogleAdsRow[]>(options: ReportOptions): Promise<T>;
+    report<T = services.IGoogleAdsRow[]>(options: Readonly<ReportOptions>): Promise<T>;
     /**
       @description Get the total row count of a report.
       @hooks none
     */
-    reportCount(options: ReportOptions): Promise<number | undefined>;
+    reportCount(options: Readonly<ReportOptions>): Promise<number | undefined>;
     /**
       @description Stream query using ReportOptions. If a generic type is provided, it must be the type of a single row.
       If a summary row is requested then this will be the last emitted row of the stream.
@@ -39,7 +39,7 @@ export declare class Customer extends ServiceFactory {
       const stream = reportStream<T>(reportOptions)
       for await (const row of stream) { ... }
     */
-    reportStream<T = services.IGoogleAdsRow>(reportOptions: ReportOptions): AsyncGenerator<T>;
+    reportStream<T = services.IGoogleAdsRow>(reportOptions: Readonly<ReportOptions>): AsyncGenerator<T>;
     /**
       @description Retreive the raw stream using ReportOptions.
       @hooks onStreamStart
@@ -49,7 +49,7 @@ export declare class Customer extends ServiceFactory {
       stream.on('error', (error) => { ... })
       stream.on('end', () => { ... })
     */
-    reportStreamRaw(reportOptions: ReportOptions): Promise<CancellableStream | void>;
+    reportStreamRaw(reportOptions: Readonly<ReportOptions>): Promise<CancellableStream | void>;
     private search;
     private paginatedSearch;
     private querier;

package/build/src/customer.js

@@ -49,8 +49,7 @@ class Customer extends serviceFactory_1.default {
       @hooks none
     */
     async reportCount(options) {
-        options.limit = 1; // must get at least one row
-        const { gaqlQuery, requestOptions } = (0, query_1.buildQuery)(options);
+        const { gaqlQuery, requestOptions } = (0, query_1.buildQuery)({ ...options, limit: 1 }); // must get at least one row
         // @ts-expect-error we do not allow this field in reportOptions, however it is still a valid request option
         requestOptions.return_total_results_count = true;
         const useHooks = false; // to avoid cacheing conflicts

package/build/src/query.d.ts

@@ -44,18 +44,18 @@ export declare function validateConstraintKeyAndValue(key: ConstraintKey, op: Co
     val: ParsedConstraintValue;
 };
 export declare function convertNumericEnumToString(key: ConstraintKey, val: ParsedConstraintValue): ParsedConstraintValue;
-export declare function extractConstraintConditions(constraints: ReportOptions["constraints"]): ConstraintString[];
+export declare function extractConstraintConditions(constraints: Readonly<ReportOptions["constraints"]>): ConstraintString[];
 export declare function extractDateConstantConditions(dateConstant: ReportOptions["date_constant"]): ConstraintString[];
 export declare function extractDateConditions(fromDate: ReportOptions["from_date"], toDate: ReportOptions["to_date"]): ConstraintString[];
-export declare function buildWhereClause(constraints: ReportOptions["constraints"], dateConstant: ReportOptions["date_constant"], fromDate: ReportOptions["from_date"], toDate: ReportOptions["to_date"]): WhereClause;
+export declare function buildWhereClause(constraints: Readonly<ReportOptions["constraints"]>, dateConstant: Readonly<ReportOptions["date_constant"]>, fromDate: Readonly<ReportOptions["from_date"]>, toDate: Readonly<ReportOptions["to_date"]>): WhereClause;
 export declare function buildLimitClause(limit: ReportOptions["limit"]): LimitClause;
-export declare function buildParametersClause(parameters: ReportOptions["parameters"]): ParametersClause;
+export declare function buildParametersClause(parameters: Readonly<ReportOptions["parameters"]>): ParametersClause;
 export declare function completeOrderly(orderly: string, entity: ReportOptions["entity"]): string;
-export declare function buildOrderClauseOld(orderBy: ReportOptions["order_by"], sortOrder: ReportOptions["sort_order"], entity: ReportOptions["entity"]): OrderClause;
-export declare function buildOrderClauseNew(order: Required<ReportOptions["order"]>, entity: ReportOptions["entity"]): OrderClause;
-export declare function buildOrderClause(order: ReportOptions["order"], orderBy: ReportOptions["order_by"], sortOrder: ReportOptions["sort_order"], entity: ReportOptions["entity"]): OrderClause;
-export declare function buildRequestOptions(reportOptions: ReportOptions): RequestOptions;
-export declare function buildQuery(reportOptions: ReportOptions): {
+export declare function buildOrderClauseOld(orderBy: Readonly<ReportOptions["order_by"]>, sortOrder: Readonly<ReportOptions["sort_order"]>, entity: Readonly<ReportOptions["entity"]>): OrderClause;
+export declare function buildOrderClauseNew(order: Readonly<Required<ReportOptions["order"]>>, entity: Readonly<ReportOptions["entity"]>): OrderClause;
+export declare function buildOrderClause(order: Readonly<ReportOptions["order"]>, orderBy: Readonly<ReportOptions["order_by"]>, sortOrder: Readonly<ReportOptions["sort_order"]>, entity: Readonly<ReportOptions["entity"]>): OrderClause;
+export declare function buildRequestOptions(reportOptions: Readonly<ReportOptions>): RequestOptions;
+export declare function buildQuery(reportOptions: Readonly<ReportOptions>): {
     gaqlQuery: Query;
     requestOptions: RequestOptions;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "google-ads-api",
-  "version": "13.0.0-global-service-cache-alpha-0",
+  "version": "13.0.1",
   "description": "Google Ads API Client Library for Node.js",
   "repository": "https://github.com/Opteo/google-ads-api",
   "main": "build/src/index.js",