Lots of linting (#50)

- Lots of linting
- Fixed a couple methods' options not being optional

Author: toptobes

.eslintrc.cjs

@@ -1,6 +1,5 @@
 /* eslint-env node */
 module.exports = {
-  ignorePatterns: ['dist/*', 'scripts/*'],
   extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended'],
   parser: '@typescript-eslint/parser',
   plugins: ['@typescript-eslint'],
@@ -19,6 +18,13 @@ module.exports = {
         'caughtErrorsIgnorePattern': '^_',
       },
     ],
+    // Sometimes 'requires' is necessary
     '@typescript-eslint/no-var-requires': 'off',
   },
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+    project: ['./tsconfig.json'],
+    tsconfigRootDir: __dirname,
+  },
 };

etc/astra-db-ts.api.md

@@ -194,13 +194,13 @@ export class Collection<Schema extends SomeDoc = SomeDoc> {
     findOneAndReplace(filter: Filter<Schema>, replacement: NoId<Schema>, options: FindOneAndReplaceOptions & {
         includeResultMetadata: true;
     }): Promise<ModifyResult<Schema>>;
-    findOneAndReplace(filter: Filter<Schema>, replacement: NoId<Schema>, options: FindOneAndReplaceOptions & {
+    findOneAndReplace(filter: Filter<Schema>, replacement: NoId<Schema>, options?: FindOneAndReplaceOptions & {
         includeResultMetadata?: false;
     }): Promise<WithId<Schema> | null>;
     findOneAndUpdate(filter: Filter<Schema>, update: UpdateFilter<Schema>, options: FindOneAndUpdateOptions & {
         includeResultMetadata: true;
     }): Promise<ModifyResult<Schema>>;
-    findOneAndUpdate(filter: Filter<Schema>, update: UpdateFilter<Schema>, options: FindOneAndUpdateOptions & {
+    findOneAndUpdate(filter: Filter<Schema>, update: UpdateFilter<Schema>, options?: FindOneAndUpdateOptions & {
         includeResultMetadata?: false;
     }): Promise<WithId<Schema> | null>;
     insertMany(documents: MaybeId<Schema>[], options?: InsertManyOptions): Promise<InsertManyResult<Schema>>;
@@ -528,7 +528,7 @@ export interface DbSpawnOptions {
 // @public
 export interface DefaultHttpClientOptions {
     client?: 'default';
-    fetchH2?: any;
+    fetchH2?: unknown;
     http1?: Http1Options;
     maxTimeMS?: number;
     preferHttp2?: boolean;
@@ -695,20 +695,20 @@ export class FindCursor<T, TRaw extends SomeDoc = SomeDoc> {
     clone(): FindCursor<TRaw, TRaw>;
     close(): void;
     get closed(): boolean;
-    filter(filter: Filter<TRaw>): FindCursor<T, TRaw>;
+    filter(filter: Filter<TRaw>): this;
     // @deprecated
-    forEach(consumer: (doc: T) => boolean | void): Promise<void>;
+    forEach(consumer: ((doc: T) => boolean) | ((doc: T) => void)): Promise<void>;
     hasNext(): Promise<boolean>;
-    includeSimilarity(includeSimilarity?: boolean): FindCursor<T, TRaw>;
-    limit(limit: number): FindCursor<T, TRaw>;
+    includeSimilarity(includeSimilarity?: boolean): this;
+    limit(limit: number): this;
     map<R>(mapping: (doc: T) => R): FindCursor<R, TRaw>;
     get namespace(): string;
     next(): Promise<T | null>;
     project<R = any, RRaw extends SomeDoc = SomeDoc>(projection: Projection): FindCursor<R, RRaw>;
     readBufferedDocuments(max?: number): TRaw[];
     rewind(): void;
-    skip(skip: number): FindCursor<T, TRaw>;
-    sort(sort: Sort): FindCursor<T, TRaw>;
+    skip(skip: number): this;
+    sort(sort: Sort): this;
     toArray(): Promise<T[]>;
 }
 
@@ -944,7 +944,7 @@ export interface NumFilterOps {
 
 // @public
 export class ObjectId {
-    constructor(id?: string, validate?: boolean);
+    constructor(id?: string | null, validate?: boolean);
     equals(other: unknown): boolean;
     getTimestamp(): Date;
     inspect(): string;
@@ -1138,7 +1138,7 @@ export class TooManyDocumentsToCountError extends DataAPIError {
 }
 
 // @public
-export type TypeErr<S> = unknown & {
+export type TypeErr<S> = {
     [__error]: S;
 };
 

package.json

@@ -48,7 +48,7 @@
     "url": "git+https://github.com/datastax/astra-db-ts.git"
   },
   "scripts": {
-    "lint": "eslint .",
+    "lint": "eslint src/* tests/*",
     "test": "ts-mocha --paths -p tsconfig.json tests/unit/**/*.test.ts tests/integration/**/*.test.ts tests/integration/**/**/*.test.ts",
     "test:all": "env ASTRA_RUN_LONG_TESTS=1 ASTRA_RUN_ADMIN_TESTS=1 ts-mocha --paths -p tsconfig.json tests/unit/**/*.test.ts tests/integration/**/*.test.ts tests/integration/**/**/*.test.ts",
     "test:coverage": "nyc npm run test:all -- -b",

src/api/clients/data-api-http-client.ts

@@ -120,26 +120,26 @@ export class DataAPIHttpClient extends HttpClient {
         throw new DataAPIHttpError(resp);
       }
 
-      const data: RawDataAPIResponse = JSON.parse(resp.body!, reviver);
+      const data: RawDataAPIResponse = resp.body ? JSON.parse(resp.body, reviver) : {};
 
-      if (resp.status === 401 || (data.errors && data.errors?.length > 0 && data?.errors[0]?.message === 'UNAUTHENTICATED: Invalid token')) {
+      if (resp.status === 401 || (data.errors && data.errors.length > 0 && data.errors[0]?.message === 'UNAUTHENTICATED: Invalid token')) {
         const fauxResponse = mkFauxErroredResponse('Authentication failed; is your token valid?');
         throw mkRespErrorFromResponse(DataAPIResponseError, info.command, fauxResponse);
       }
 
-      if (data.errors && data?.errors?.length > 0 && data?.errors[0]?.errorCode === 'COLLECTION_NOT_EXIST') {
-        const name = data?.errors[0]?.message.split(': ')[1];
-        throw new CollectionNotFoundError(info.namespace!, name);
+      if (data.errors && data.errors.length > 0 && data.errors[0]?.errorCode === 'COLLECTION_NOT_EXIST') {
+        const name = data.errors[0]?.message.split(': ')[1];
+        throw new CollectionNotFoundError(info.namespace ?? '<unknown>', name);
       }
 
-      if (data?.errors && data?.errors.length > 0) {
+      if (data.errors && data.errors.length > 0) {
         throw mkRespErrorFromResponse(DataAPIResponseError, info.command, data);
       }
 
       const respData = {
-        data: data?.data,
-        status: data?.status,
-        errors: data?.errors,
+        data: data.data,
+        status: data.status,
+        errors: data.errors,
       }
 
       if (this.monitorCommands) {

src/api/clients/devops-api-http-client.ts

@@ -33,7 +33,7 @@ export interface DevOpsAPIRequestInfo {
   path: string,
   method: HttpMethodStrings,
   data?: Record<string, any>,
-  params?: Record<string, any>,
+  params?: Record<string, string>,
 }
 
 interface LongRunningRequestInfo {
@@ -80,7 +80,7 @@ export class DevOpsAPIHttpClient extends HttpClient {
         timeoutManager,
       });
 
-      const data = resp.body ? JSON.parse(resp.body) : undefined;
+      const data = resp.body ? JSON.parse(resp.body) as Record<string, any> : undefined;
 
       if (resp.status >= 400) {
         throw new DevOpsAPIResponseError(resp, data);
@@ -110,7 +110,7 @@ export class DevOpsAPIHttpClient extends HttpClient {
 
   public async requestLongRunning(req: DevOpsAPIRequestInfo, info: LongRunningRequestInfo): Promise<DevopsAPIResponse> {
     const timeoutManager = this._mkTimeoutManager(info.options?.maxTimeMS);
-    const isLongRunning = info?.options?.blocking !== false;
+    const isLongRunning = info.options?.blocking !== false;
 
     if (this.monitorCommands) {
       this.emitter.emit('adminCommandStarted', new AdminCommandStartedEvent(req, isLongRunning, timeoutManager.ms));
@@ -188,5 +188,7 @@ export class DevOpsAPIHttpClient extends HttpClient {
 }
 
 function mkHeaders(token: string | undefined) {
-  return { [DEFAULT_DEVOPS_API_AUTH_HEADER]: `Bearer ${token}` };
+  return (token)
+    ? { [DEFAULT_DEVOPS_API_AUTH_HEADER]: `Bearer ${token}` }
+    : {}
 }

src/api/clients/http-client.ts

@@ -58,7 +58,6 @@ export abstract class HttpClient {
     }
 
     const params = info.params ?? {};
-    Object.keys(params).forEach(key => params[key] === undefined && delete params[key]);
 
     const url = (Object.keys(params).length > 0)
       ? `${info.url}?${new URLSearchParams(params).toString()}`

src/client/data-api-client.ts

@@ -19,7 +19,7 @@ import {
   Caller,
   CustomHttpClientOptions,
   DataAPIClientOptions,
-  DataAPIHttpOptions,
+  DataAPIHttpOptions, DefaultHttpClientOptions,
   InternalRootClientOpts,
 } from '@/src/client/types';
 import TypedEmitter from 'typed-emitter';
@@ -61,7 +61,7 @@ export type DataAPIClientEvents =
  */
 export const DataAPIClientEventEmitterBase = (() => {
   try {
-    return require('events').EventEmitter as (new () => TypedEmitter<DataAPIClientEvents>);
+    return (require('events') as { EventEmitter: (new () => TypedEmitter<DataAPIClientEvents>) }).EventEmitter;
   } catch (e) {
     throw new Error(`\`${LIB_NAME}\` requires the \`events\` module to be available for usage. Please provide a polyfill (e.g. the \`events\` package) or use a compatible environment.`);
   }
@@ -149,7 +149,7 @@ export class DataAPIClient extends DataAPIClientEventEmitterBase {
     };
 
     if (Symbol.asyncDispose) {
-      this[Symbol.asyncDispose] = this.close;
+      this[Symbol.asyncDispose] = () => this.close();
     }
   }
 
@@ -311,16 +311,12 @@ function buildFetchCtx(options: DataAPIClientOptions | undefined): FetchCtx {
     ? options?.httpOptions?.client ?? 'default'
     : undefined;
 
-  const ctx = (() => {
-    switch (clientType) {
-      case 'fetch':
-        return new FetchNative();
-      case 'custom':
-        return (options!.httpOptions as CustomHttpClientOptions).fetcher;
-      default:
-        return tryLoadFetchH2(clientType, options);
-    }
-  })();
+  const ctx =
+    (clientType === 'fetch')
+      ? new FetchNative() :
+    (clientType === 'custom')
+      ? (options!.httpOptions as CustomHttpClientOptions).fetcher
+      : tryLoadFetchH2(clientType, options)
 
   return {
     ctx: ctx,
@@ -331,11 +327,13 @@ function buildFetchCtx(options: DataAPIClientOptions | undefined): FetchCtx {
 
 function tryLoadFetchH2(clientType: string | undefined, options: DataAPIClientOptions | undefined): Fetcher {
   try {
-    const preferHttp2 = (<any>options?.httpOptions)?.preferHttp2
+    const httpOptions = options?.httpOptions as DefaultHttpClientOptions | undefined;
+
+    const preferHttp2 = httpOptions?.preferHttp2
       ?? getDeprecatedPrefersHttp2(options)
       ?? true
 
-    return new FetchH2(options?.httpOptions as any, preferHttp2);
+    return new FetchH2(httpOptions, preferHttp2);
   } catch (e) {
     if (clientType === undefined) {
       return new FetchNative();
@@ -346,7 +344,7 @@ function tryLoadFetchH2(clientType: string | undefined, options: DataAPIClientOp
 }
 
 // Shuts the linter up about 'preferHttp2' being deprecated
-function getDeprecatedPrefersHttp2(opts: DataAPIClientOptions | undefined | null) {
+function getDeprecatedPrefersHttp2(opts: DataAPIClientOptions | undefined | null): boolean | undefined {
   return opts?.[('preferHttp2' as any as null)!];
 }
 
@@ -373,7 +371,7 @@ function validateHttpOpts(opts: DataAPIHttpOptions | undefined | null) {
   }
 
   validateOption('httpOptions.client', opts.client, 'string', false, (client) => {
-    if (client !== 'fetch' && client !== 'default' && client !== 'custom') {
+    if (!['fetch', 'default', 'custom'].includes(client)) {
       throw new Error('Invalid httpOptions.client; expected \'fetch\', \'default\', \'custom\', or undefined');
     }
   });

src/common/index.ts

@@ -13,4 +13,5 @@
 // limitations under the License.
 
 export * from './types';
+export * from './utils';
 export * from './token-providers';

src/common/utils.ts

@@ -0,0 +1,19 @@
+// Copyright DataStax, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import { nullish } from '@/src/common/types';
+
+export function isNullish(t: unknown): t is nullish {
+  return t === null || t === undefined;
+}