fix(types)!: properly format listing methods with gaxOptions

src/backup.ts

@@ -22,9 +22,9 @@ import {
   ResourceCallback,
 } from './common';
 import {EnumKey, Spanner, RequestConfig, TranslateEnumKeys} from '.';
-import {Metadata, Operation as GaxOperation} from 'google-gax';
+import {Metadata, Operation as GaxOperation, CallOptions} from 'google-gax';
 import {DateStruct, PreciseDate} from '@google-cloud/precise-date';
-import {CallOptions, status} from 'grpc';
+import {status} from 'grpc';
 import {google as databaseAdmin} from '../protos/protos';
 import {common as p} from 'protobufjs';
 

src/common.ts

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-import {ServiceError, CallOptions} from 'grpc';
-import {Operation as GaxOperation} from 'google-gax';
+import {ServiceError} from 'grpc';
+import {Operation as GaxOperation, CallOptions} from 'google-gax';
 import {google as instanceAdmin} from '../protos/protos';
 import {google as databaseAdmin} from '../protos/protos';
 
@@ -33,9 +33,7 @@ export interface ResourceCallback<Resource, Response> {
     response?: Response
   ): void;
 }
-export type PagedResponse<Item, Response> =
-  | [Item[]]
-  | [Item[], {} | null, Response];
+export type PagedResponse<Item, Response> = [Item[], {} | null, Response];
 
 export type RequestCallback<T, R = void> = R extends void
   ? NormalCallback<T>
@@ -63,8 +61,8 @@ export interface LongRunningCallback<Resource> {
   ): void;
 }
 
-export type PagedRequest<P> = P & {
-  autoPaginate?: boolean;
-  maxApiCalls?: number;
+export interface PagedOptions {
+  pageSize?: number;
+  pageToken?: string;
   gaxOptions?: CallOptions;
-};
+}

src/database.ts

@@ -28,7 +28,7 @@ import * as extend from 'extend';
 import * as r from 'teeny-request';
 import * as streamEvents from 'stream-events';
 import * as through from 'through2';
-import {Operation as GaxOperation} from 'google-gax';
+import {Operation as GaxOperation, CallOptions} from 'google-gax';
 import {Backup} from './backup';
 import {BatchTransaction, TransactionIdentifier} from './batch-transaction';
 import {google as databaseAdmin} from '../protos/protos';
@@ -71,13 +71,13 @@ import {
   IOperation,
   Schema,
   RequestCallback,
-  PagedRequest,
+  PagedOptions,
   ResourceCallback,
   PagedResponse,
   NormalCallback,
   LongRunningCallback,
 } from './common';
-import {ServiceError, CallOptions} from 'grpc';
+import {ServiceError} from 'grpc';
 import {Readable, Transform, Duplex} from 'stream';
 import {PreciseDate} from '@google-cloud/precise-date';
 import {google as spannerClient} from '../protos/protos';
@@ -120,7 +120,9 @@ type PoolRequestCallback = RequestCallback<Session>;
 
 type ResultSetStats = spannerClient.spanner.v1.ResultSetStats;
 
-type GetSessionsOptions = PagedRequest<google.spanner.v1.IListSessionsRequest>;
+interface GetSessionsOptions extends PagedOptions {
+  filter?: string;
+}
 
 /**
  * IDatabase structure with database state enum translated to string form.
@@ -175,8 +177,8 @@ export type CreateSessionResponse = [
 ];
 
 export interface CreateSessionOptions {
-  name?: string | null;
   labels?: {[k: string]: string} | null;
+  gaxOptions?: CallOptions;
 }
 
 export type CreateSessionCallback = ResourceCallback<
@@ -576,6 +578,18 @@ class Database extends GrpcServiceObject {
     options: CreateSessionOptions,
     callback: CreateSessionCallback
   ): void;
+  /**
+   * Create a new session.
+   *
+   * @typedef {object} CreateSessionOptions
+   * @property {Object.<string, string>} [labels] The labels for the session.
+   *
+   *   * Label keys must be between 1 and 63 characters long and must conform to
+   *     the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.
+   *   * Label values must be between 0 and 63 characters long and must conform
+   *     to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
+   *   * No more than 64 labels can be associated with a given session.
+   */
   /**
    * @typedef {array} CreateSessionResponse
    * @property {Session} 0 The newly created session.
@@ -637,10 +651,8 @@ class Database extends GrpcServiceObject {
     cb?: CreateSessionCallback
   ): void | Promise<CreateSessionResponse> {
     const callback =
-      typeof optionsOrCallback === 'function'
-        ? (optionsOrCallback as CreateSessionCallback)
-        : cb!;
-    const gaxOpts =
+      typeof optionsOrCallback === 'function' ? optionsOrCallback : cb!;
+    const options =
       typeof optionsOrCallback === 'object' && optionsOrCallback
         ? extend({}, optionsOrCallback)
         : ({} as CreateSessionOptions);
@@ -649,17 +661,16 @@ class Database extends GrpcServiceObject {
       database: this.formattedName_,
     };
 
-    if (gaxOpts.labels) {
-      reqOpts.session = {labels: gaxOpts.labels};
-      delete gaxOpts.labels;
+    if (options.labels) {
+      reqOpts.session = {labels: options.labels};
     }
 
     this.request<google.spanner.v1.ISession>(
       {
         client: 'SpannerClient',
         method: 'createSession',
         reqOpts,
-        gaxOpts,
+        gaxOpts: options.gaxOptions,
       },
       (err, resp) => {
         if (err) {
@@ -1141,9 +1152,7 @@ class Database extends GrpcServiceObject {
   /**
    * Options object for listing sessions.
    *
-   * @typedef {object} GetSessionsRequest
-   * @property {boolean} [autoPaginate=true] Have pagination handled
-   *     automatically.
+   * @typedef {object} GetSessionsOptions
    * @property {string} [filter] An expression for filtering the results of the
    *     request. Filter rules are case insensitive. The fields eligible for
    *     filtering are:
@@ -1158,21 +1167,23 @@ class Database extends GrpcServiceObject {
    *     - **`labels.env:dev`** The instance's label env has the value dev.
    *     - **`name:howl labels.env:dev`** The instance's name is howl and it has
    *       the label env with value dev.
-   * @property {number} [maxApiCalls] Maximum number of API calls to make.
-   * @property {number} [maxResults] Maximum number of items to return.
    * @property {number} [pageSize] Maximum number of results per page.
    * @property {string} [pageToken] A previously-returned page token
    *     representing part of the larger set of results to view.
+   * @property {object} [gaxOptions] Request configuration options, outlined
+   *     here: https://googleapis.github.io/gax-nodejs/global.html#CallOptions.
    */
   /**
    * @typedef {array} GetSessionsResponse
    * @property {Session[]} 0 Array of {@link Session} instances.
+   * @param {object} nextQuery A query object to receive more results.
    * @property {object} 1 The full API response.
    */
   /**
    * @callback GetSessionsCallback
    * @param {?Error} err Request error, if any.
    * @param {Session[]} instances Array of {@link Session} instances.
+   * @param {object} nextQuery A query object to to receive more results.
    * @param {object} apiResponse The full API response.
    */
   /**
@@ -1210,7 +1221,7 @@ class Database extends GrpcServiceObject {
    * }
    *
    * database.getInstances({
-   *   autoPaginate: false
+   *   gaxOptions: {autoPaginate: false}
    * }, callback);
    *
    * //-
@@ -1227,19 +1238,32 @@ class Database extends GrpcServiceObject {
     // eslint-disable-next-line @typescript-eslint/no-this-alias
     const self = this;
     const callback =
-      typeof optionsOrCallback === 'function'
-        ? (optionsOrCallback as GetSessionsCallback)
-        : cb;
+      typeof optionsOrCallback === 'function' ? optionsOrCallback : cb;
     const options =
       typeof optionsOrCallback === 'object'
-        ? (optionsOrCallback as GetSessionsOptions)
-        : {gaxOptions: {}};
-    const gaxOpts: CallOptions = options.gaxOptions as CallOptions;
-    const reqOpts = extend({}, options, {
+        ? optionsOrCallback
+        : ({} as GetSessionsOptions);
+    const gaxOpts = extend(true, {}, options.gaxOptions);
+    let reqOpts = extend({}, options, {
       database: this.formattedName_,
     });
-
     delete reqOpts.gaxOptions;
+
+    // Copy over pageSize and pageToken values from gaxOptions.
+    // However values set on options take precedence.
+    if (gaxOpts) {
+      reqOpts = extend(
+        {},
+        {
+          pageSize: gaxOpts.pageSize,
+          pageToken: gaxOpts.pageToken,
+        },
+        reqOpts
+      );
+      delete gaxOpts.pageSize;
+      delete gaxOpts.pageToken;
+    }
+
     this.request<
       google.spanner.v1.ISession,
       google.spanner.v1.IListSessionsResponse