Switch to ts-bridge and harden exports

[mcmire]

Switch to ts-bridge so that we can publish this package in both ES module format and CommonJS module format, and add exports to package.json to instruct bundlers which format they should choose. (Note that this is a breaking change as consumers will no longer be allowed to import subpaths.) The exports are double-checked with @arethetypeswrong/cli to ensure that they work correctly.

Manual Testing

• Run yarn.
• Run yarn build.
• Review dist/ to ensure that it contains all files that are needed to co1nsume this package.
• Run yarn test.
• There should be a report from attw at the end. It should pass.

[socket-security]

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	object-assign@​4.1.1
	unicode-emoji-modifier-base@​1.0.0
	@​braidai/​lang@​1.1.1
	@​arethetypeswrong/​core@​0.18.2
	@​andrewbranch/​untar.js@​1.0.3
	@​colors/​colors@​1.5.0
	environment@​1.1.0
	skin-tone@​2.0.0
	any-promise@​1.3.0
	@​loaderkit/​resolve@​1.0.4
	ansi-escapes@​7.0.0
	cli-highlight@​2.1.11
	fflate@​0.8.2
	supports-hyperlinks@​3.2.0
	parse5-htmlparser2-tree-adapter@​6.0.1
	@​ts-bridge/​resolver@​0.2.0
	@​ts-bridge/​cli@​0.6.3
	@​sindresorhus/​is@​4.6.0
	cli-table3@​0.6.5
	lru-cache@​11.1.0
	marked-terminal@​7.3.0
	thenify@​3.3.1
	node-emoji@​2.2.0
	cliui@​7.0.4
	thenify-all@​1.6.0
	yargs-parser@​20.2.9
	emojilib@​2.4.0
	highlight.js@​10.7.3
	mz@​2.7.0
	parse5@​5.1.1
	commander@​10.0.1
	cjs-module-lexer@​1.3.1 ⏵ 1.4.3
	yargs@​16.2.0
See 3 more rows in the dashboard

View full report

[mcmire]

Feel free to ignore this PR for now, we can merge it when we like.

[mcmire]

Here are the changes to the CommonJS-compatible files:

diff --git a/dist/SmartTransactionsController.js b/dist/SmartTransactionsController.cjs
similarity index 99%
rename from dist/SmartTransactionsController.js
rename to dist/SmartTransactionsController.cjs
index 6a7c7e1..81c47cd 100644
--- a/dist/SmartTransactionsController.js
+++ b/dist/SmartTransactionsController.cjs
@@ -22,10 +22,10 @@ const eth_query_1 = __importDefault(require("@metamask/eth-query"));
 const polling_controller_1 = require("@metamask/polling-controller");
 const transaction_controller_1 = require("@metamask/transaction-controller");
 const bignumber_js_1 = require("bignumber.js");
-const cloneDeep_1 = __importDefault(require("lodash/cloneDeep"));
-const constants_1 = require("./constants");
-const types_1 = require("./types");
-const utils_1 = require("./utils");
+const cloneDeep_1 = __importDefault(require("lodash/cloneDeep.js"));
+const constants_1 = require("./constants.cjs");
+const types_1 = require("./types.cjs");
+const utils_1 = require("./utils.cjs");
 const SECOND = 1000;
 exports.DEFAULT_INTERVAL = SECOND * 5;
 const ETH_QUERY_ERROR_MSG = '`ethQuery` is not defined on SmartTransactionsController';
@@ -699,4 +699,4 @@ async function _SmartTransactionsController_fetch(request, options) {
             newSmartTransactionsForSelectedChain;
     });
 };
-//# sourceMappingURL=SmartTransactionsController.js.map
\ No newline at end of file
+//# sourceMappingURL=SmartTransactionsController.cjs.map
\ No newline at end of file
diff --git a/dist/SmartTransactionsController.d.ts b/dist/SmartTransactionsController.d.cts
similarity index 93%
rename from dist/SmartTransactionsController.d.ts
rename to dist/SmartTransactionsController.d.cts
index c97b904..e5018a0 100644
--- a/dist/SmartTransactionsController.d.ts
+++ b/dist/SmartTransactionsController.d.cts
@@ -1,12 +1,12 @@
 /// <reference types="node" />
-import type { ControllerGetStateAction, ControllerStateChangeEvent, RestrictedControllerMessenger } from '@metamask/base-controller';
-import { type TraceCallback } from '@metamask/controller-utils';
-import type { NetworkClientId, NetworkControllerGetNetworkClientByIdAction, NetworkControllerGetStateAction, NetworkControllerStateChangeEvent } from '@metamask/network-controller';
-import type { TransactionController, TransactionMeta, TransactionParams } from '@metamask/transaction-controller';
-import { MetaMetricsEventCategory, MetaMetricsEventName } from './constants';
-import type { Fees, Hex, IndividualTxFees, SignedCanceledTransaction, SignedTransaction, SmartTransaction, SmartTransactionsStatus, UnsignedTransaction, GetTransactionsOptions, MetaMetricsProps, FeatureFlags, ClientId } from './types';
-import { SmartTransactionStatuses } from './types';
-import { getSmartTransactionMetricsProperties, getSmartTransactionMetricsSensitiveProperties } from './utils';
+import type { ControllerGetStateAction, ControllerStateChangeEvent, RestrictedControllerMessenger } from "@metamask/base-controller";
+import { type TraceCallback } from "@metamask/controller-utils";
+import type { NetworkClientId, NetworkControllerGetNetworkClientByIdAction, NetworkControllerGetStateAction, NetworkControllerStateChangeEvent } from "@metamask/network-controller";
+import type { TransactionController, TransactionMeta, TransactionParams } from "@metamask/transaction-controller";
+import { MetaMetricsEventCategory, MetaMetricsEventName } from "./constants.cjs";
+import type { Fees, Hex, IndividualTxFees, SignedCanceledTransaction, SignedTransaction, SmartTransaction, SmartTransactionsStatus, UnsignedTransaction, GetTransactionsOptions, MetaMetricsProps, FeatureFlags, ClientId } from "./types.cjs";
+import { SmartTransactionStatuses } from "./types.cjs";
+import { getSmartTransactionMetricsProperties, getSmartTransactionMetricsSensitiveProperties } from "./utils.cjs";
 export declare const DEFAULT_INTERVAL: number;
 /**
  * The name of the {@link SmartTransactionsController}
@@ -150,3 +150,4 @@ export default class SmartTransactionsController extends SmartTransactionsContro
     }): void;
 }
 export {};
+//# sourceMappingURL=SmartTransactionsController.d.cts.map
\ No newline at end of file
diff --git a/dist/constants.js b/dist/constants.cjs
similarity index 98%
rename from dist/constants.js
rename to dist/constants.cjs
index f697705..1fa699b 100644
--- a/dist/constants.js
+++ b/dist/constants.cjs
@@ -29,4 +29,4 @@ var SmartTransactionsTraceName;
     SmartTransactionsTraceName["CancelTransaction"] = "Smart Transactions: Cancel Transaction";
     SmartTransactionsTraceName["FetchLiveness"] = "Smart Transactions: Fetch Liveness";
 })(SmartTransactionsTraceName = exports.SmartTransactionsTraceName || (exports.SmartTransactionsTraceName = {}));
-//# sourceMappingURL=constants.js.map
\ No newline at end of file
+//# sourceMappingURL=constants.cjs.map
\ No newline at end of file
diff --git a/dist/constants.d.ts b/dist/constants.d.cts
similarity index 95%
rename from dist/constants.d.ts
rename to dist/constants.d.cts
index bbcdb59..a5ab0b1 100644
--- a/dist/constants.d.ts
+++ b/dist/constants.d.cts
@@ -20,3 +20,4 @@ export declare enum SmartTransactionsTraceName {
     FetchLiveness = "Smart Transactions: Fetch Liveness"
 }
 export {};
+//# sourceMappingURL=constants.d.cts.map
\ No newline at end of file
diff --git a/dist/index.js b/dist/index.cjs
similarity index 89%
rename from dist/index.js
rename to dist/index.cjs
index 0557827..a96b718 100644
--- a/dist/index.js
+++ b/dist/index.cjs
@@ -4,6 +4,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = void 0;
-var SmartTransactionsController_1 = require("./SmartTransactionsController");
+var SmartTransactionsController_1 = require("./SmartTransactionsController.cjs");
 Object.defineProperty(exports, "default", { enumerable: true, get: function () { return __importDefault(SmartTransactionsController_1).default; } });
-//# sourceMappingURL=index.js.map
\ No newline at end of file
+//# sourceMappingURL=index.cjs.map
\ No newline at end of file
diff --git a/dist/index.d.ts b/dist/index.d.cts
similarity index 63%
rename from dist/index.d.ts
rename to dist/index.d.cts
index fe57ce2..4af0da0 100644
--- a/dist/index.d.ts
+++ b/dist/index.d.cts
@@ -1,2 +1,3 @@
-export { default } from './SmartTransactionsController';
-export type { SmartTransactionsControllerMessenger, SmartTransactionsControllerState, SmartTransactionsControllerGetStateAction, SmartTransactionsControllerActions, SmartTransactionsControllerStateChangeEvent, SmartTransactionsControllerSmartTransactionEvent, SmartTransactionsControllerSmartTransactionConfirmationDoneEvent, SmartTransactionsControllerEvents, } from './SmartTransactionsController';
+export { default } from "./SmartTransactionsController.cjs";
+export type { SmartTransactionsControllerMessenger, SmartTransactionsControllerState, SmartTransactionsControllerGetStateAction, SmartTransactionsControllerActions, SmartTransactionsControllerStateChangeEvent, SmartTransactionsControllerSmartTransactionEvent, SmartTransactionsControllerSmartTransactionConfirmationDoneEvent, SmartTransactionsControllerEvents, } from "./SmartTransactionsController.cjs";
+//# sourceMappingURL=index.d.cts.map
\ No newline at end of file
diff --git a/dist/types.js b/dist/types.cjs
similarity index 98%
rename from dist/types.js
rename to dist/types.cjs
index 8189474..fcf41ab 100644
--- a/dist/types.js
+++ b/dist/types.cjs
@@ -51,4 +51,4 @@ exports.cancellationReasonToStatusMap = {
     [SmartTransactionCancellationReason.INVALID_NONCE]: SmartTransactionStatuses.CANCELLED,
     [SmartTransactionCancellationReason.USER_CANCELLED]: SmartTransactionStatuses.CANCELLED_USER_CANCELLED,
 };
-//# sourceMappingURL=types.js.map
\ No newline at end of file
+//# sourceMappingURL=types.cjs.map
\ No newline at end of file
diff --git a/dist/types.d.ts b/dist/types.d.cts
similarity index 95%
rename from dist/types.d.ts
rename to dist/types.d.cts
index b477889..a3fcaac 100644
--- a/dist/types.d.ts
+++ b/dist/types.d.cts
@@ -1,5 +1,5 @@
-import type { NetworkClientId } from '@metamask/network-controller';
-import type { TransactionMeta } from '@metamask/transaction-controller';
+import type { NetworkClientId } from "@metamask/network-controller";
+import type { TransactionMeta } from "@metamask/transaction-controller";
 /** API */
 export declare enum APIType {
     'GET_FEES' = 0,
@@ -122,3 +122,4 @@ export declare type FeatureFlags = {
         extensionReturnTxHashAsap?: boolean;
     };
 };
+//# sourceMappingURL=types.d.cts.map
\ No newline at end of file
diff --git a/dist/utils.js b/dist/utils.cjs
similarity index 99%
rename from dist/utils.js
rename to dist/utils.cjs
index 696357d..a7cb4c6 100644
--- a/dist/utils.js
+++ b/dist/utils.cjs
@@ -16,8 +16,8 @@ const lodash_1 = __importDefault(require("lodash"));
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore
 const package_json_1 = __importDefault(require("../package.json"));
-const constants_1 = require("./constants");
-const types_1 = require("./types");
+const constants_1 = require("./constants.cjs");
+const types_1 = require("./types.cjs");
 function isSmartTransactionPending(smartTransaction) {
     return smartTransaction.status === types_1.SmartTransactionStatuses.PENDING;
 }
@@ -268,4 +268,4 @@ const markRegularTransactionAsFailed = ({ smartTransaction, getRegularTransactio
     updateTransaction(updatedTransaction, `Smart transaction status: ${status}`);
 };
 exports.markRegularTransactionAsFailed = markRegularTransactionAsFailed;
-//# sourceMappingURL=utils.js.map
\ No newline at end of file
+//# sourceMappingURL=utils.cjs.map
\ No newline at end of file
diff --git a/dist/utils.d.ts b/dist/utils.d.cts
similarity index 94%
rename from dist/utils.d.ts
rename to dist/utils.d.cts
index 644f6dc..64ce428 100644
--- a/dist/utils.d.ts
+++ b/dist/utils.d.cts
@@ -1,6 +1,6 @@
-import type { TransactionMeta } from '@metamask/transaction-controller';
-import type { SmartTransaction, SmartTransactionsStatus, FeatureFlags } from './types';
-import { APIType, SmartTransactionStatuses, ClientId } from './types';
+import type { TransactionMeta } from "@metamask/transaction-controller";
+import type { SmartTransaction, SmartTransactionsStatus, FeatureFlags } from "./types.cjs";
+import { APIType, SmartTransactionStatuses, ClientId } from "./types.cjs";
 export declare function isSmartTransactionPending(smartTransaction: SmartTransaction): boolean;
 export declare const isSmartTransactionStatusResolved: (stxStatus: SmartTransactionsStatus | string) => boolean;
 export declare function getAPIRequestURL(apiType: APIType, chainId: string): string;
@@ -87,3 +87,4 @@ export declare const markRegularTransactionAsFailed: ({ smartTransaction, getReg
     getRegularTransactions: () => TransactionMeta[];
     updateTransaction: (transaction: TransactionMeta, note: string) => void;
 }) => void;
+//# sourceMappingURL=utils.d.cts.map
\ No newline at end of file

[socket-security]

All alerts resolved. Learn more about Socket for GitHub.

This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored.

Ignoring alerts on:

• commander@10.0.1
• mz@2.7.0
• @arethetypeswrong/core@0.18.2

View full report

[mcmire]

@SocketSecurity ignore npm/@arethetypeswrong/core@0.18.2
@SocketSecurity ignore npm/commander@10.0.1
@SocketSecurity ignore npm/mz@2.7.0

Shell access is OK; these are CLI tools.

[mcmire]

@SocketSecurity ignore npm/mz@2.7.0

Network access is OK; this package wraps Node modules.

[mcmire]

@cursor Already addressed.

[mcmire]

@dan437 Would you mind reviewing this when you get a chance?

[dan437]

Looks good. I've also tried Send and Swap transactions in the extension with this branch and they worked.