refactor: interface => type

package.json

@@ -100,7 +100,7 @@
     "messageTransformer/messageTransformer.ts"
   ],
   "dependencies": {
-    "@jsforce/jsforce-node": "^3.0.0-next.3",
+    "@jsforce/jsforce-node": "^3.1.0",
     "@salesforce/kit": "^3.1.0",
     "@salesforce/schemas": "^1.7.0",
     "@salesforce/ts-types": "^2.0.9",
@@ -119,7 +119,7 @@
     "ts-retry-promise": "^0.7.1"
   },
   "devDependencies": {
-    "@salesforce/dev-scripts": "^8.4.2",
+    "@salesforce/dev-scripts": "^8.5.0",
     "@salesforce/ts-sinon": "^1.4.19",
     "@types/benchmark": "^2.1.5",
     "@types/chai-string": "^1.4.5",

src/config/config.ts

@@ -29,7 +29,7 @@ const CONFIG_FILE_NAME = 'config.json';
 /**
  * Interface for meta information about config properties
  */
-export interface ConfigPropertyMeta {
+export type ConfigPropertyMeta = {
   /**
    * The config property name.
    */
@@ -65,12 +65,12 @@ export interface ConfigPropertyMeta {
    * Is only used if deprecated is set to true.
    */
   newKey?: string;
-}
+};
 
 /**
  * Config property input validation
  */
-export interface ConfigPropertyMetaInput {
+export type ConfigPropertyMetaInput = {
   /**
    * Tests if the input value is valid and returns true if the input data is valid.
    *
@@ -82,7 +82,7 @@ export interface ConfigPropertyMetaInput {
    * The message to return in the error if the validation fails.
    */
   failedMessage: string | ((value: ConfigValue) => string);
-}
+};
 
 export enum SfConfigProperties {
   /**

src/config/configAggregator.ts

@@ -18,7 +18,7 @@ const messages = Messages.loadMessages('@salesforce/core', 'config');
 /**
  * Information about a config property.
  */
-export interface ConfigInfo {
+export type ConfigInfo = {
   /**
    * key The config key.
    */
@@ -57,7 +57,7 @@ export interface ConfigInfo {
    * True if the config property is deprecated.
    */
   deprecated?: boolean;
-}
+};
 
 /**
  * Aggregate global and local project config files, as well as environment variables for

src/config/configFile.ts

@@ -406,7 +406,7 @@ export namespace ConfigFile {
   /**
    * The interface for Config options.
    */
-  export interface Options extends BaseConfigStore.Options {
+  export type Options = {
     /**
      * The root folder where the config file is stored.
      */
@@ -435,5 +435,5 @@ export namespace ConfigFile {
      * Indicates if init should throw if the corresponding config file is not found.
      */
     throwOnNotFound?: boolean;
-  }
+  } & BaseConfigStore.Options;
 }

src/config/configStore.ts

@@ -17,7 +17,7 @@ import { ConfigContents, ConfigEntry, ConfigValue, Key } from './configStackType
 /**
  * An interface for a config object with a persistent store.
  */
-export interface ConfigStore<P extends ConfigContents = ConfigContents> {
+export type ConfigStore<P extends ConfigContents = ConfigContents> = {
   // Map manipulation methods
   entries(): ConfigEntry[];
   // NEXT_RELEASE: update types to specify return can be P[K] | undefined
@@ -40,7 +40,7 @@ export interface ConfigStore<P extends ConfigContents = ConfigContents> {
 
   // Content methods
   getContents(): P;
-}
+};
 
 /**
  * An abstract class that implements all the config management functions but
@@ -433,7 +433,7 @@ export namespace BaseConfigStore {
   /**
    * Options for the config store.
    */
-  export interface Options {
+  export type Options = {
     /**
      * Keys to encrypt.
      *
@@ -443,5 +443,5 @@ export namespace BaseConfigStore {
      * defining a new class.
      */
     encryptedKeys?: Array<string | RegExp>;
-  }
+  };
 }

src/config/orgUsersConfig.ts

@@ -46,10 +46,10 @@ export namespace OrgUsersConfig {
   /**
    * The config file options.
    */
-  export interface Options extends ConfigFile.Options {
+  export type Options = {
     /**
      * The org id associated with this user.
      */
     orgId: string;
-  }
+  } & ConfigFile.Options;
 }

src/config/sandboxOrgConfig.ts

@@ -42,12 +42,12 @@ export namespace SandboxOrgConfig {
   /**
    * The config file options.
    */
-  export interface Options extends ConfigFile.Options {
+  export type Options = {
     /**
      * The org id associated with this sandbox.
      */
     orgId: string;
-  }
+  } & ConfigFile.Options;
 
   export enum Fields {
     /**

src/crypto/crypto.ts

@@ -113,10 +113,10 @@ const detectCryptoVersion = (pwd?: string): void => {
 Messages.importMessagesDirectory(pathJoin(__dirname));
 const messages = Messages.loadMessages('@salesforce/core', 'encryption');
 
-interface CredType {
+type CredType = {
   username: string;
   password: string;
-}
+};
 
 const makeSecureBuffer = (password: string, encoding: CryptoEncoding): SecureBuffer<string> => {
   const newSb = new SecureBuffer<string>();
@@ -179,12 +179,12 @@ const keychainPromises = {
   },
 };
 
-interface CryptoOptions {
+type CryptoOptions = {
   keychain?: KeyChain;
   platform?: string;
   retryStatus?: string;
   noResetOnClose?: boolean;
-}
+};
 
 /**
  * Class for managing encrypting and decrypting private auth information.

src/crypto/keyChainImpl.ts

@@ -85,7 +85,7 @@ const _validateProgram = async (
 /**
  * Basic keychain interface.
  */
-export interface PasswordStore {
+export type PasswordStore = {
   /**
    * Gets a password
    *
@@ -106,7 +106,7 @@ export interface PasswordStore {
    * @param fn function callback for password.
    */
   setPassword(opts: ProgramOpts, fn: (error: Nullable<Error>, contents?: SecretContents) => void): Promise<void>;
-}
+};
 
 /**
  * @private
@@ -247,13 +247,13 @@ export class KeychainAccess implements PasswordStore {
   }
 }
 
-interface ProgramOpts {
+type ProgramOpts = {
   account: string;
   service: string;
   password?: string;
-}
+};
 
-interface OsImpl {
+type OsImpl = {
   getProgram(): string;
   getProgramOptions(opts: ProgramOpts): string[];
   getCommandFunc(
@@ -279,7 +279,7 @@ interface OsImpl {
     opts: ProgramOpts,
     fn: (err: Nullable<Error>) => void
   ): Promise<void>;
-}
+};
 
 /**
  * Linux implementation.

src/deviceOauthService.ts

@@ -21,14 +21,14 @@ import { Messages } from './messages';
 Messages.importMessagesDirectory(__dirname);
 const messages = Messages.loadMessages('@salesforce/core', 'auth');
 
-export interface DeviceCodeResponse extends JsonMap {
+export type DeviceCodeResponse = {
   device_code: string;
   interval: number;
   user_code: string;
   verification_uri: string;
-}
+} & JsonMap;
 
-export interface DeviceCodePollingResponse extends JsonMap {
+export type DeviceCodePollingResponse = {
   access_token: string;
   refresh_token: string;
   signature: string;
@@ -37,13 +37,13 @@ export interface DeviceCodePollingResponse extends JsonMap {
   id: string;
   token_type: string;
   issued_at: string;
-}
+} & JsonMap;
 
-interface DeviceCodeAuthError extends SfError {
+type DeviceCodeAuthError = {
   error: string;
   error_description: string;
   status: number;
-}
+} & SfError;
 
 async function makeRequest<T extends JsonMap>(options: HttpRequest): Promise<T> {
   const rawResponse = await new Transport().httpRequest(options);

src/logger/logger.ts

@@ -19,7 +19,7 @@ import { cleanup } from './cleanup';
 /**
  * The common set of `Logger` options.
  */
-export interface LoggerOptions {
+export type LoggerOptions = {
   /**
    * The logger name.
    */
@@ -37,7 +37,7 @@ export interface LoggerOptions {
 
   /** log to memory instead of to a file.  Intended for Unit Testing */
   useMemoryLogger?: boolean;
-}
+};
 
 /**
  * Standard `Logger` levels.
@@ -71,7 +71,7 @@ export type FieldValue = string | number | boolean | Fields;
 /**
  * Log line interface
  */
-export interface LogLine {
+export type LogLine = {
   name: string;
   hostname: string;
   pid: string;
@@ -80,7 +80,7 @@ export interface LogLine {
   msg: string;
   time: string;
   v: number;
-}
+};
 
 /**
  * A logging abstraction powered by {@link https://github.com/pinojs/pino | Pino} that provides both a default

src/org/authInfo.ts

@@ -99,11 +99,11 @@ export type OrgAuthorization = {
 /**
  * Options for access token flow.
  */
-export interface AccessTokenOptions {
+export type AccessTokenOptions = {
   accessToken?: string;
   loginUrl?: string;
   instanceUrl?: string;
-}
+};
 
 export type AuthSideEffects = {
   alias?: string;
@@ -1246,7 +1246,7 @@ export namespace AuthInfo {
   /**
    * Constructor options for AuthInfo.
    */
-  export interface Options {
+  export type Options = {
     /**
      * Org signup username.
      */
@@ -1270,5 +1270,5 @@ export namespace AuthInfo {
     parentUsername?: string;
 
     isDevHub?: boolean;
-  }
+  };
 }

src/org/connection.ts

@@ -45,6 +45,8 @@ export const SFDX_HTTP_HEADERS = {
 export const DNS_ERROR_NAME = 'DomainNotFoundError';
 export type DeployOptionsWithRest = Partial<DeployOptions> & { rest?: boolean };
 
+// preserving interface since it extends a class
+// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
 export interface Tooling<S extends Schema = Schema> extends JSForceTooling<S> {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   _logger: any;
@@ -466,17 +468,17 @@ export const SingleRecordQueryErrors = {
   NoRecords: 'SingleRecordQuery_NoRecords',
   MultipleRecords: 'SingleRecordQuery_MultipleRecords',
 };
-export interface SingleRecordQueryOptions {
+export type SingleRecordQueryOptions = {
   tooling?: boolean;
   returnChoicesOnMultiple?: boolean;
   choiceField?: string; // defaults to Name
-}
+};
 
 export namespace Connection {
   /**
    * Connection Options.
    */
-  export interface Options<S extends Schema> {
+  export type Options<S extends Schema> = {
     /**
      * AuthInfo instance.
      */
@@ -489,7 +491,7 @@ export namespace Connection {
      * Additional connection parameters.
      */
     connectionOptions?: ConnectionConfig<S>;
-  }
+  };
 }
 
 const getOptionsVersion = async <S extends Schema>(options: Connection.Options<S>): Promise<string | undefined> => {