Fixing linting errors

.eslintrc.cjs

@@ -16,7 +16,7 @@ module.exports = {
     es2021: true,
   },
   extends: ["plugin:@shopify/typescript", "plugin:@shopify/prettier"],
-  ignorePatterns: ["dist/"],
+  ignorePatterns: ["dist/", "node_modules/"],
   rules: {
     "no-console": 0,
     "@typescript-eslint/naming-convention": 0,

packages/graphql-client/src/api-client-utilities/operation-types.ts

@@ -16,8 +16,8 @@ type UnpackedInputMaybe<InputType> = InputType extends InputMaybe<infer R>
 export type OperationVariables<
   Operation extends keyof Operations,
   Operations extends AllOperations,
-> = Operations[Operation]["variables"] extends { [key: string]: never }
-  ? { [key: string]: never }
+> = Operations[Operation]["variables"] extends Record<string, never>
+  ? Record<string, never>
   : {
       variables?: {
         [k in keyof Operations[Operation]["variables"]]: UnpackedInputMaybe<

packages/graphql-client/src/api-client-utilities/types.ts

@@ -54,7 +54,7 @@ export type ApiClientRequestOptions<
   retries?: number;
 } & (Operation extends keyof Operations
   ? OperationVariables<Operation, Operations>
-  : { variables?: { [key: string]: any } });
+  : { variables?: Record<string, any> });
 
 export type ApiClientRequestParams<
   Operation extends keyof Operations,

packages/graphql-client/src/graphql-client/types.ts

@@ -7,13 +7,9 @@ export type CustomFetchApi = (
   },
 ) => Promise<Response>;
 
-interface OperationVariables {
-  [key: string]: any;
-}
+type OperationVariables = Record<string, any>;
 
-export interface Headers {
-  [key: string]: string;
-}
+export type Headers = Record<string, string>;
 
 export interface ResponseErrors {
   networkStatusCode?: number;
@@ -22,9 +18,7 @@ export interface ResponseErrors {
   response?: Response;
 }
 
-export interface GQLExtensions {
-  [key: string]: any;
-}
+export type GQLExtensions = Record<string, any>;
 
 export interface FetchResponseBody<TData = any> {
   data?: Partial<TData>;

packages/shopify-api/adapters/__e2etests__/test_apps/test-dummy-shopify-server.ts

@@ -18,7 +18,7 @@ interface Test {
 const port: number = parseInt(process.env.HTTP_SERVER_PORT || '3000', 10);
 const errorStatusText = 'Did not work';
 const requestId = 'Request id header';
-const tests: {[key: string | number]: Test} = {
+const tests: Record<string | number, Test> = {
   200: {
     expectedRequest: initTestRequest(),
     testResponse: initTestResponse(),

packages/shopify-api/adapters/__e2etests__/test_apps/test-node-app.ts

@@ -240,7 +240,7 @@ function handle(_signal: any): void {
 
 function setRestClientRetryTime(time: number) {
   // We de-type HttpClient here so we can alter its readonly time property
-  (HttpClient as unknown as {[key: string]: number}).RETRY_WAIT_TIME = time;
+  (HttpClient as any).RETRY_WAIT_TIME = time;
 }
 
 process.on('SIGINT', handle);

packages/shopify-api/adapters/__e2etests__/test_apps/test-web-api-app.ts

@@ -38,7 +38,7 @@ function params(
 
 function setRestClientRetryTime(time: number) {
   // We de-type HttpClient here so we can alter its readonly time property
-  (HttpClient as unknown as {[key: string]: number}).RETRY_WAIT_TIME = time;
+  (HttpClient as any).RETRY_WAIT_TIME = time;
 }
 
 /* eslint-disable-next-line import/no-anonymous-default-export */

packages/shopify-api/adapters/__e2etests__/test_handle_graphql.ts

@@ -27,7 +27,7 @@ export const handleGraphqlTest = async ({
   const graphqlClient = graphqlClientFactory(apiServer);
 
   let operation: string;
-  let variables: {[key: string]: any} | undefined;
+  let variables: Record<string, any> | undefined;
   try {
     const bodyJSON = JSON.parse(testRequest.body!);
     operation = bodyJSON.query;

packages/shopify-api/lib/__test-helpers__/to-match-made-http-request.ts

@@ -8,8 +8,8 @@ interface ExpectRequestParams {
   domain: string;
   path: string;
   query?: string;
-  headers?: {[key: string]: any};
-  data?: string | {[key: string]: any} | null;
+  headers?: Record<string, any>;
+  data?: string | Record<string, any> | null;
   attempts?: number;
 }
 

packages/shopify-api/lib/auth/index.ts

@@ -40,4 +40,4 @@ export type ShopifyAuth<Future extends FutureFlagOptions> = {
   buildEmbeddedAppUrl: BuildEmbeddedAppUrl;
 } & (FeatureEnabled<Future, 'unstable_tokenExchange'> extends true
   ? {tokenExchange: TokenExchange}
-  : {[key: string]: never});
+  : Record<string, never>);

packages/shopify-api/lib/auth/oauth/__tests__/oauth.test.ts

@@ -20,9 +20,7 @@ import {shopifyApi} from '../../..';
 const VALID_NONCE = 'noncenoncenonce';
 jest.mock('../nonce', () => ({nonce: jest.fn(() => VALID_NONCE)}));
 
-interface QueryMock {
-  [key: string]: any;
-}
+type QueryMock = Record<string, any>;
 
 let shop: string;
 

packages/shopify-api/lib/auth/oauth/safe-compare.ts

@@ -1,8 +1,8 @@
 import * as ShopifyErrors from '../../error';
 
 export type SafeCompare = (
-  strA: string | {[key: string]: string} | string[] | number[],
-  strB: string | {[key: string]: string} | string[] | number[],
+  strA: string | Record<string, string> | string[] | number[],
+  strB: string | Record<string, string> | string[] | number[],
 ) => boolean;
 
 export const safeCompare: SafeCompare = (strA, strB) => {

packages/shopify-api/lib/billing/types.ts

@@ -57,11 +57,9 @@ export type BillingConfigItem<
   ? BillingConfigOneTimePlan | BillingConfigSubscriptionLineItemPlan
   : BillingConfigLegacyItem;
 
-export interface BillingConfig<
+export type BillingConfig<
   Future extends FutureFlagOptions = FutureFlagOptions,
-> {
-  [plan: string]: BillingConfigItem<Future>;
-}
+> = Record<string, BillingConfigItem<Future>>;
 
 export type RequestConfigOverrides =
   | Partial<BillingConfigOneTimePlan>

packages/shopify-api/lib/clients/admin/__tests__/admin_graphql_client.test.ts

@@ -76,7 +76,7 @@ describe('GraphQL client', () => {
     const shopify = shopifyApi(testConfig());
 
     const client = new shopify.clients.Graphql({session});
-    const customHeader: {[key: string]: string} = {
+    const customHeader: Record<string, string> = {
       'X-Glib-Glob': 'goobers',
     };
 
@@ -111,7 +111,7 @@ describe('GraphQL client', () => {
       buildExpectedResponse(successResponse),
     );
 
-    const customHeaders: {[key: string]: string} = {};
+    const customHeaders: Record<string, string> = {};
     customHeaders[ShopifyHeader.AccessToken] =
       shopify.config.adminApiAccessToken;
 

packages/shopify-api/lib/clients/admin/__tests__/rest_client.test.ts

@@ -195,7 +195,7 @@ describe('REST client', () => {
 
     const client = new shopify.clients.Rest({session});
 
-    const customHeaders: {[key: string]: string} = {
+    const customHeaders: Record<string, string> = {
       'X-Not-A-Real-Header': 'some_value',
     };
 
@@ -385,7 +385,7 @@ describe('REST client', () => {
       buildExpectedResponse(successResponse),
     );
 
-    const customHeaders: {[key: string]: string} = {};
+    const customHeaders: Record<string, string> = {};
     customHeaders[ShopifyHeader.AccessToken] =
       shopify.config.adminApiAccessToken;
 

packages/shopify-api/lib/clients/admin/graphql/client.ts

@@ -79,7 +79,7 @@ export class GraphqlClient {
     >
   > {
     let operation: Operation;
-    let variables: {[key: string]: any} | undefined;
+    let variables: Record<string, any> | undefined;
     let headers: HeaderParams = {};
     let tries: number | undefined;
     if (typeof params === 'object') {
@@ -142,16 +142,15 @@ export class GraphqlClient {
       : T;
 
     // Get errors array
-    const errors = (body as unknown as {[key: string]: unknown})
-      .errors as any[];
+    const errors = (body as unknown as Record<string, unknown>).errors as any[];
 
     const responseHeaders = Object.fromEntries(response.headers.entries());
 
     // Throw error if response contains errors
     if (errors?.length > 0) {
       throw new ShopifyErrors.GraphqlQueryError({
         message: errors[0]?.message ?? 'GraphQL query returned errors',
-        response: body as unknown as {[key: string]: unknown},
+        response: body as unknown as Record<string, unknown>,
         headers: responseHeaders,
       });
     }

packages/shopify-api/lib/clients/admin/types.ts

@@ -4,7 +4,7 @@ import {RequestReturn, QueryParams} from '../http_client/types';
 
 export interface PageInfoParams {
   path: string;
-  query: {[key: string]: QueryParams};
+  query: Record<string, QueryParams>;
 }
 
 export interface PageInfo {

packages/shopify-api/lib/clients/graphql_proxy/graphql_proxy.ts

@@ -16,7 +16,7 @@ export function graphqlProxy(config: ConfigInterface): GraphqlProxy {
     const client = new GraphqlClient({session});
 
     let query: string;
-    let variables: {[key: string]: any} | undefined;
+    let variables: Record<string, any> | undefined;
     if (typeof rawBody === 'string') {
       query = rawBody;
     } else {

packages/shopify-api/lib/clients/graphql_proxy/types.ts

@@ -3,7 +3,7 @@ import {RequestReturn} from '../http_client/types';
 
 export interface GraphqlProxyParams {
   session: Session;
-  rawBody: string | {[key: string]: any};
+  rawBody: string | Record<string, any>;
 }
 
 export type GraphqlProxy = (

packages/shopify-api/lib/clients/http_client/__tests__/http_client.test.ts

@@ -1021,5 +1021,5 @@ describe('HTTP client', () => {
 
 function setRestClientRetryTime(time: number) {
   // We de-type HttpClient here so we can alter its readonly time property
-  (HttpClient as unknown as {[key: string]: number}).RETRY_WAIT_TIME = time;
+  (HttpClient as any).RETRY_WAIT_TIME = time;
 }

packages/shopify-api/lib/clients/http_client/http_client.ts

@@ -48,7 +48,7 @@ export class HttpClient {
   static readonly RETRY_WAIT_TIME = 1000;
   // 5 minutes
   static readonly DEPRECATION_ALERT_DELAY = 300000;
-  loggedDeprecations: {[key: string]: number} = {};
+  loggedDeprecations: Record<string, number> = {};
   readonly domain: string;
 
   public constructor(params: HttpClientParams) {
@@ -126,7 +126,7 @@ export class HttpClient {
               typeof data === 'string'
                 ? data
                 : new URLSearchParams(
-                    data as {[key: string]: string},
+                    data as Record<string, string>,
                   ).toString();
             break;
           case DataType.GraphQL:
@@ -232,7 +232,7 @@ export class HttpClient {
       );
     }
 
-    let body: {[key: string]: string} | string | T = {};
+    let body: Record<string, string> | string | T = {};
 
     if (response.body) {
       try {

packages/shopify-api/lib/clients/http_client/types.ts

@@ -2,9 +2,7 @@ import {Method} from '@shopify/network';
 
 import {Headers} from '../../../runtime/http';
 
-export interface HeaderParams {
-  [key: string]: string | number | string[];
-}
+export type HeaderParams = Record<string, string | number | string[]>;
 
 /* eslint-disable @shopify/typescript/prefer-pascal-case-enums */
 export enum DataType {
@@ -24,14 +22,14 @@ export type QueryParams =
 export interface GetRequestParams {
   path: string;
   type?: DataType;
-  data?: {[key: string]: unknown} | string;
-  query?: {[key: string]: QueryParams};
+  data?: Record<string, unknown> | string;
+  query?: Record<string, QueryParams>;
   extraHeaders?: HeaderParams;
   tries?: number;
 }
 
 export type PostRequestParams = GetRequestParams & {
-  data: {[key: string]: unknown} | string;
+  data: Record<string, unknown> | string;
 };
 
 export type PutRequestParams = PostRequestParams;

packages/shopify-api/lib/clients/storefront/client.ts

@@ -97,7 +97,7 @@ export class StorefrontClient {
     const config = this.storefrontClass().config;
 
     let operation: Operation;
-    let variables: {[key: string]: any} | undefined;
+    let variables: Record<string, any> | undefined;
     let headers: HeaderParams = {};
     let tries: number | undefined;
     if (typeof params === 'object') {
@@ -160,16 +160,15 @@ export class StorefrontClient {
       : T;
 
     // Get errors array
-    const errors = (body as unknown as {[key: string]: unknown})
-      .errors as any[];
+    const errors = (body as unknown as Record<string, unknown>).errors as any[];
 
     const responseHeaders = Object.fromEntries(response.headers.entries());
 
     // Throw error if response contains errors
     if (errors?.length > 0) {
       throw new ShopifyErrors.GraphqlQueryError({
         message: errors[0]?.message ?? 'GraphQL query returned errors',
-        response: body as unknown as {[key: string]: unknown},
+        response: body as unknown as Record<string, unknown>,
         headers: responseHeaders,
       });
     }

packages/shopify-api/lib/clients/types.ts

@@ -34,7 +34,7 @@ export interface GraphqlQueryOptions<
   Operations extends AllOperations,
 > {
   variables?: ApiClientRequestOptions<Operation, Operations>['variables'];
-  extraHeaders?: {[key: string]: string | number};
+  extraHeaders?: Record<string, string | number>;
   tries?: number;
 }
 

packages/shopify-api/lib/error.ts

@@ -23,8 +23,8 @@ export class HttpMaxRetriesError extends ShopifyError {}
 interface HttpResponseData {
   code: number;
   statusText: string;
-  body?: {[key: string]: unknown};
-  headers?: {[key: string]: unknown};
+  body?: Record<string, unknown>;
+  headers?: Record<string, unknown>;
 }
 interface HttpResponseErrorParams extends HttpResponseData {
   message: string;
@@ -70,17 +70,17 @@ export class HttpThrottlingError extends HttpRetriableError<HttpThrottlingErrorD
 
 export class RestResourceError extends ShopifyError {}
 export class GraphqlQueryError extends ShopifyError {
-  readonly response: {[key: string]: unknown};
-  headers?: {[key: string]: unknown};
+  readonly response: Record<string, unknown>;
+  headers?: Record<string, unknown>;
 
   public constructor({
     message,
     response,
     headers,
   }: {
     message: string;
-    response: {[key: string]: unknown};
-    headers?: {[key: string]: unknown};
+    response: Record<string, unknown>;
+    headers?: Record<string, unknown>;
   }) {
     super(message);
     this.response = response;

packages/shopify-api/lib/logger/log.ts

@@ -6,7 +6,7 @@ import {LogContext} from './types';
 export type LoggerFunction = (
   severity: LogSeverity,
   message: string,
-  context?: {[key: string]: any},
+  context?: Record<string, any>,
 ) => void;
 
 export function log(config: ConfigInterface): LoggerFunction {

packages/shopify-api/lib/logger/types.ts

@@ -1,3 +1 @@
-export interface LogContext {
-  [key: string]: any;
-}
+export type LogContext = Record<string, any>;

packages/shopify-api/lib/utils/processed-query.ts

@@ -1,5 +1,5 @@
 export default class ProcessedQuery {
-  static stringify(keyValuePairs?: {[key: string]: any}): string {
+  static stringify(keyValuePairs?: Record<string, any>): string {
     if (!keyValuePairs || Object.keys(keyValuePairs).length === 0) return '';
 
     return new ProcessedQuery().putAll(keyValuePairs).stringify();
@@ -11,7 +11,7 @@ export default class ProcessedQuery {
     this.processedQuery = new URLSearchParams();
   }
 
-  putAll(keyValuePairs: {[key: string]: any}): ProcessedQuery {
+  putAll(keyValuePairs: Record<string, any>): ProcessedQuery {
     Object.entries(keyValuePairs).forEach(([key, value]: [string, any]) =>
       this.put(key, value),
     );