google-ads-api 10.0.2 → 11.0.0

package/build/src/hooks.d.ts

@@ -16,7 +16,12 @@ export declare type BaseMutationHookArgs = {
     mutation: any;
     isServiceCall: true;
 });
-declare type StartHookArgs<T = RequestOptions | MutateOptions, A = void> = {
+export declare type BaseServiceHookArgs = {
+    credentials: CustomerCredentials;
+    method: `${keyof typeof services}.${string}`;
+    requestOptions: any;
+};
+declare type StartHookArgs<T = RequestOptions | MutateOptions | any, A = void> = {
     cancel: A extends void ? () => void : (args?: A) => void;
     editOptions: (options: Partial<T>) => void;
 };
@@ -30,6 +35,7 @@ declare type EndHookArgs<T = services.IGoogleAdsRow[] | services.MutateGoogleAds
 declare type HookArgs = StartHookArgs | ErrorHookArgs | EndHookArgs;
 declare type RequestHook<H extends HookArgs> = (a: BaseRequestHookArgs & H) => void;
 declare type MutationHook<H extends HookArgs> = (a: BaseMutationHookArgs & H) => void;
+declare type ServiceHook<H extends HookArgs> = (a: BaseServiceHookArgs & H) => void;
 export declare type OnQueryStart = RequestHook<StartHookArgs<RequestOptions, any>>;
 export declare type OnQueryError = RequestHook<ErrorHookArgs>;
 export declare type OnQueryEnd = RequestHook<EndHookArgs<services.IGoogleAdsRow[]>>;
@@ -38,6 +44,9 @@ export declare type OnStreamError = RequestHook<ErrorHookArgs>;
 export declare type OnMutationStart = MutationHook<StartHookArgs<MutateOptions, any>>;
 export declare type OnMutationError = MutationHook<ErrorHookArgs>;
 export declare type OnMutationEnd = MutationHook<EndHookArgs<services.MutateGoogleAdsResponse>>;
+export declare type OnServiceStart = ServiceHook<StartHookArgs<any, any>>;
+export declare type OnServiceError = ServiceHook<ErrorHookArgs>;
+export declare type OnServiceEnd = ServiceHook<EndHookArgs<any>>;
 export interface Hooks {
     /**
      * @description Hook called before execution of a query in the `query` and `report` methods
@@ -98,7 +107,7 @@ export interface Hooks {
     onMutationStart?: OnMutationStart;
     /**
      * @description Hook called upon a mutation throwing an error
-     * @params `{ credentials, mutations error }`
+     * @params `{ credentials, mutations, error }`
      * @param credentials customer id, login customer id, linked customer id
      * @param mutations
      * @param error google ads error
@@ -108,11 +117,37 @@ export interface Hooks {
      * @description Hook called after successful execution of a mutation
      * @params `{ credentials, mutations, response, resolve }`
      * @param credentials customer id, login customer id, linked customer id
-     * @mutations
+     * @param mutations
      * @param response results of the mutation
      * @param resolve utility function for returning an alternative value from the mutation
      */
     onMutationEnd?: OnMutationEnd;
+    /**
+     * @description Hook called before execution of a service
+     * @params `{ credentials, method, requestOptions }`
+     * @param credentials customer id, login customer id, linked customer id
+     * @param method
+     * @param cancel utility function for cancelling the service. if an argument is provided then the service will return this argument
+     * @param editOptions utility function for editing the service options. any service option keys that are passed will be changed
+     */
+    onServiceStart?: OnServiceStart;
+    /**
+     * @description Hook called upon a service throwing an error
+     * @params `{ credentials, method, error }`
+     * @param credentials customer id, login customer id, linked customer id
+     * @param method
+     * @param error google ads error
+     */
+    onServiceError?: OnServiceError;
+    /**
+     * @description Hook called after successful execution of a service
+     * @params `{ credentials, method, response, resolve }`
+     * @param credentials customer id, login customer id, linked customer id
+     * @param method
+     * @param response results of the service
+     * @param resolve utility function for returning an alternative value from the service
+     */
+    onServiceEnd?: OnServiceEnd;
 }
 export declare type HookedCancellation = {
     cancelled: boolean;

package/build/src/index.d.ts

@@ -4,5 +4,5 @@ export { fromMicros, toMicros } from "./utils";
 export { parse } from "./parser";
 export * as ResourceNames from "./protos/autogen/resourceNames";
 export { CustomerOptions, ReportOptions, MutateOperation, Constraint, Constraints, } from "./types";
-export { Hooks, OnQueryStart, OnQueryError, OnQueryEnd, OnStreamStart, OnStreamError, OnMutationStart, OnMutationError, OnMutationEnd, } from "./hooks";
+export { Hooks, OnQueryStart, OnQueryError, OnQueryEnd, OnStreamStart, OnStreamError, OnMutationStart, OnMutationError, OnMutationEnd, OnServiceStart, OnServiceError, OnServiceEnd, } from "./hooks";
 export { Customer } from "./customer";

package/build/src/parser.js

@@ -1,19 +1,12 @@
 "use strict";
-var __spreadArrays = (this && this.__spreadArrays) || function () {
-    for (var s = 0, i = 0, il = arguments.length; i < il; i++) s += arguments[i].length;
-    for (var r = Array(s), k = 0, i = 0; i < il; i++)
-        for (var a = arguments[i], j = 0, jl = a.length; j < jl; j++, k++)
-            r[k] = a[j];
-    return r;
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseRows = exports.getReportOptionFields = exports.getGAQLFields = exports.parse = exports.ParsingError = void 0;
-var long_1 = __importDefault(require("long"));
-var protos_1 = require("./protos");
-var utils_1 = require("./utils");
+const long_1 = __importDefault(require("long"));
+const protos_1 = require("./protos");
+const utils_1 = require("./utils");
 exports.ParsingError = {
     NO_REPORT_OPTIONS_OR_GAQL_QUERY: "Must provided reportOptions or gaqlString to parse results.",
     NO_FIELDS_IN_GAQL_QUERY: "GAQL Query must contain at least one attribute, metric or segment.",
@@ -25,8 +18,7 @@ exports.ParsingError = {
   const parsedResults = parse({ results, reportOptions })
   const parsedResults = parse({ results, gaqlString })
 */
-function parse(_a) {
-    var results = _a.results, reportOptions = _a.reportOptions, gaqlString = _a.gaqlString;
+function parse({ results, reportOptions, gaqlString, }) {
     if (results.length === 0) {
         return results;
     }
@@ -34,27 +26,25 @@ function parse(_a) {
         typeof gaqlString === "undefined") {
         throw new Error(exports.ParsingError.NO_REPORT_OPTIONS_OR_GAQL_QUERY);
     }
-    var queryFields = reportOptions
+    const queryFields = reportOptions
         ? getReportOptionFields(reportOptions)
         : getGAQLFields(gaqlString);
     // Add in all relevant resource_name fields, which are always returned by API
-    var entities = queryFields.map(function (field) { return field.split(".")[0]; });
-    var resourceNameFields = protos_1.fields.resourceNames.filter(function (resourceNameField) {
-        return entities.includes(resourceNameField.split(".")[0]);
-    });
-    var allFields = __spreadArrays(queryFields, resourceNameFields);
+    const entities = queryFields.map((field) => field.split(".")[0]);
+    const resourceNameFields = protos_1.fields.resourceNames.filter((resourceNameField) => entities.includes(resourceNameField.split(".")[0]));
+    const allFields = [...queryFields, ...resourceNameFields];
     return parseRows(results, allFields);
 }
 exports.parse = parse;
 // This function assumes that a gaql query is of the format "select * * * from * ...".
 // Queries that are not in this format should have thrown an error when called.
 function getGAQLFields(gaqlString) {
-    var normalisedQuery = utils_1.normaliseQuery(gaqlString);
-    var fields = normalisedQuery
+    const normalisedQuery = utils_1.normaliseQuery(gaqlString);
+    const fields = normalisedQuery
         .toLowerCase()
         .replace(/(^\s*select)|( from .*)|(\s+)/g, "")
         .split(",")
-        .filter(function (field) { return field.length > 0; });
+        .filter((field) => field.length > 0);
     if (!fields.length) {
         throw new Error(exports.ParsingError.NO_FIELDS_IN_GAQL_QUERY);
     }
@@ -62,7 +52,11 @@ function getGAQLFields(gaqlString) {
 }
 exports.getGAQLFields = getGAQLFields;
 function getReportOptionFields(reportOptions) {
-    var fields = __spreadArrays((reportOptions.attributes || []), (reportOptions.metrics || []), (reportOptions.segments || []));
+    const fields = [
+        ...(reportOptions.attributes || []),
+        ...(reportOptions.metrics || []),
+        ...(reportOptions.segments || []),
+    ];
     if (!fields.length) {
         throw new Error(exports.ParsingError.NO_FIELDS_IN_REPORT_OPTIONS);
     }
@@ -70,24 +64,23 @@ function getReportOptionFields(reportOptions) {
 }
 exports.getReportOptionFields = getReportOptionFields;
 function parseRows(rows, fields) {
-    var fieldsPreSplit = {};
+    const fieldsPreSplit = {};
     // pre-split all the field strings for performance reasons (increases speed by ~5x for large number of rows)
-    for (var _i = 0, fields_1 = fields; _i < fields_1.length; _i++) {
-        var field = fields_1[_i];
+    for (const field of fields) {
         fieldsPreSplit[field] = field.split(".");
     }
-    var newRows = [];
-    for (var r = 0; r < rows.length; r++) {
-        var newRow = {};
-        var originalRow = protos_1.services.GoogleAdsRow.fromObject(rows[r]);
-        for (var split in fieldsPreSplit) {
+    const newRows = [];
+    for (let r = 0; r < rows.length; r++) {
+        const newRow = {};
+        const originalRow = protos_1.services.GoogleAdsRow.fromObject(rows[r]);
+        for (const split in fieldsPreSplit) {
             // @ts-expect-error These are the best we can do for these types
-            var _a = fieldsPreSplit[split], parent_1 = _a[0], children = _a.slice(1);
+            const [parent, ...children] = fieldsPreSplit[split];
             // Ignore null fields (unspecified resource names)
-            if (!originalRow[parent_1]) {
+            if (!originalRow[parent]) {
                 continue;
             }
-            newRow[parent_1] = parseNestedValues(newRow[parent_1], originalRow[parent_1], parent_1, children);
+            newRow[parent] = parseNestedValues(newRow[parent], originalRow[parent], parent, children);
         }
         newRows.push(newRow);
     }
@@ -97,12 +90,12 @@ exports.parseRows = parseRows;
 function parseNestedValues(row, data, field, paths) {
     if (!data)
         return null;
-    var parentField = paths[0], childFields = paths.slice(1);
+    const [parentField, ...childFields] = paths;
     if (!row)
         row = {};
     if (childFields.length === 0) {
-        var rawVal = data[parentField];
-        var parsedVal = long_1.default.isLong(rawVal)
+        const rawVal = data[parentField];
+        const parsedVal = long_1.default.isLong(rawVal)
             ? new long_1.default(rawVal.low, rawVal.high, rawVal.unsigned).toNumber()
             : rawVal;
         row[parentField] = parsedVal;