chore: added openapi-generator.rc.js file

danielzhao122 · danielzhao122 · commit be54765a7a0d · 2025-10-23T16:21:38.000-04:00
TICKET: WP-6196 feat: add openapi-config and tags to express ticket: WP-6196 revert: changes TICKET: WP-6196 revert: changes TICKET: WP-6196 refactor: remove duplicate file TICKET: WP-6196
diff --git a/modules/express/openapi-generator.rc.js b/modules/express/openapi-generator.rc.js
@@ -0,0 +1,17 @@
+/**
+ * OpenAPI Generator Configuration
+ * No custom configuration needed for Express module so far.
+ * NOTE: This file is not being passed into the openapi-generator
+ */
+
+module.exports = (E) => {
+  return {
+    '.': {
+      JsonFromStringifiedJson: () => E.right({ type: 'string' }),
+    },
+    'io-ts-types': {
+      Json: () => E.right({ type: 'object', properties: {}, required: [] }),
+      NonEmptyString: () => E.right({ type: 'string', minLength: 1 }),
+    },
+  };
+};
diff --git a/modules/express/package.json b/modules/express/package.json
@@ -4,6 +4,7 @@
   "private": true,
   "description": "Local signing server and proxy for the BitGo platform",
   "main": "./dist/src/index.js",
+  "source": "src/typedRoutes/api/index.ts",
   "types": "./dist/src/index.d.ts",
   "bin": {
     "bitgo-express": "./bin/bitgo-express"
diff --git a/modules/express/src/typedRoutes/api/common/calculateMinerFeeInfo.ts b/modules/express/src/typedRoutes/api/common/calculateMinerFeeInfo.ts
@@ -39,6 +39,7 @@ export const CalculateMinerFeeInfoResponse = t.type({
  * 4. The fee rate (in satoshis per kilobyte)
  *
  * @operationId express.calculateminerfeeinfo
+ * @tag express
  */
 export const PostCalculateMinerFeeInfo = httpRoute({
   path: '/api/v[12]/calculateminerfeeinfo',
diff --git a/modules/express/src/typedRoutes/api/common/decrypt.ts b/modules/express/src/typedRoutes/api/common/decrypt.ts
@@ -11,6 +11,7 @@ export const DecryptRequestBody = {
  * Decrypt
  *
  * @operationId express.decrypt
+ * @tag express
  */
 export const PostDecrypt = httpRoute({
   path: '/api/v[12]/decrypt',
diff --git a/modules/express/src/typedRoutes/api/common/encrypt.ts b/modules/express/src/typedRoutes/api/common/encrypt.ts
@@ -12,6 +12,7 @@ export const EncryptRequestBody = {
  * Encrypt
  *
  * @operationId express.encrypt
+ * @tag express
  */
 export const PostEncrypt = httpRoute({
   path: '/api/v[12]/encrypt',
diff --git a/modules/express/src/typedRoutes/api/common/login.ts b/modules/express/src/typedRoutes/api/common/login.ts
@@ -42,6 +42,7 @@ export const LoginRequest = {
  * Login
  *
  * @operationId express.login
+ * @tag express
  */
 export const PostLogin = httpRoute({
   path: '/api/v[12]/user/login',
diff --git a/modules/express/src/typedRoutes/api/common/ping.ts b/modules/express/src/typedRoutes/api/common/ping.ts
@@ -6,6 +6,7 @@ import { BitgoExpressError } from '../../schemas/error';
  * Ping
  *
  * @operationId express.ping
+ * @tag express
  */
 export const GetPing = httpRoute({
   path: '/api/v[12]/ping',
diff --git a/modules/express/src/typedRoutes/api/common/pingExpress.ts b/modules/express/src/typedRoutes/api/common/pingExpress.ts
@@ -6,6 +6,7 @@ import { BitgoExpressError } from '../../schemas/error';
  * Ping Express
  *
  * @operationId express.pingExpress
+ * @tag express
  */
 export const GetPingExpress = httpRoute({
   path: '/api/v[12]/pingexpress',
diff --git a/modules/express/src/typedRoutes/api/common/verifyAddress.ts b/modules/express/src/typedRoutes/api/common/verifyAddress.ts
@@ -10,6 +10,7 @@ export const VerifyAddressBody = {
  * Verify Address
  *
  * @operationId express.verifyaddress
+ * @tag express
  */
 export const PostVerifyAddress = httpRoute({
   path: '/api/v[12]/verifyaddress',
diff --git a/modules/express/src/typedRoutes/api/v1/acceptShare.ts b/modules/express/src/typedRoutes/api/v1/acceptShare.ts
@@ -24,6 +24,7 @@ export const AcceptShareRequestBody = {
  *
  * @tag express
  * @operationId express.v1.wallet.acceptShare
+ * @tag express
  */
 export const PostAcceptShare = httpRoute({
   path: '/api/v1/walletshare/{shareId}/acceptShare',
diff --git a/modules/express/src/typedRoutes/api/v1/consolidateUnspents.ts b/modules/express/src/typedRoutes/api/v1/consolidateUnspents.ts
@@ -73,6 +73,7 @@ export const ConsolidateUnspentsResponse = t.array(
  *
  * @tag express
  * @operationId express.v1.wallet.consolidateunspents
+ * @tag express
  */
 export const PutConsolidateUnspents = httpRoute({
   path: '/api/v1/wallet/{id}/consolidateunspents',
diff --git a/modules/express/src/typedRoutes/api/v1/constructPendingApprovalTx.ts b/modules/express/src/typedRoutes/api/v1/constructPendingApprovalTx.ts
@@ -61,6 +61,7 @@ export const ConstructPendingApprovalTxResponse = t.type({
  *
  * @tag express
  * @operationId express.v1.pendingapproval.constructTx
+ * @tag express
  */
 export const PutConstructPendingApprovalTx = httpRoute({
   path: '/api/v1/pendingapprovals/{id}/constructTx',
diff --git a/modules/express/src/typedRoutes/api/v1/createLocalKeyChain.ts b/modules/express/src/typedRoutes/api/v1/createLocalKeyChain.ts
@@ -35,6 +35,7 @@ export const CreateLocalKeyChainResponse = t.type({
  *
  * @tag express
  * @operationId express.v1.keychain.local
+ * @tag express
  */
 export const PostCreateLocalKeyChain = httpRoute({
   path: '/api/v1/keychain/local',
diff --git a/modules/express/src/typedRoutes/api/v1/deriveLocalKeyChain.ts b/modules/express/src/typedRoutes/api/v1/deriveLocalKeyChain.ts
@@ -46,6 +46,7 @@ export const DeriveLocalKeyChainResponse = t.type({
  *
  * @tag express
  * @operationId express.v1.keychain.derive
+ * @tag express
  */
 export const PostDeriveLocalKeyChain = httpRoute({
   path: '/api/v1/keychain/derive',
diff --git a/modules/express/src/typedRoutes/api/v1/fanoutUnspents.ts b/modules/express/src/typedRoutes/api/v1/fanoutUnspents.ts
@@ -61,6 +61,7 @@ export const FanoutUnspentsResponse = t.type({
  *
  * @tag express
  * @operationId express.v1.wallet.fanoutunspents
+ * @tag express
  */
 export const PutFanoutUnspents = httpRoute({
   path: '/api/v1/wallet/{id}/fanoutunspents',
diff --git a/modules/express/src/typedRoutes/api/v1/pendingApproval.ts b/modules/express/src/typedRoutes/api/v1/pendingApproval.ts
@@ -30,6 +30,7 @@ export const pendingApprovalRequestBody = {
  *
  * @tag express
  * @operationId express.v1.pendingapprovals
+ * @tag express
  */
 
 export const PutPendingApproval = httpRoute({
diff --git a/modules/express/src/typedRoutes/api/v1/signTransaction.ts b/modules/express/src/typedRoutes/api/v1/signTransaction.ts
@@ -33,6 +33,7 @@ export const signTransactionRequestBody = {
  *
  * @tag express
  * @operationId express.v1.wallet.signTransaction
+ * @tag express
  */
 export const PostSignTransaction = httpRoute({
   path: '/api/v1/wallet/{id}/signtransaction',
diff --git a/modules/express/src/typedRoutes/api/v1/simpleCreate.ts b/modules/express/src/typedRoutes/api/v1/simpleCreate.ts
@@ -33,6 +33,7 @@ export const SimpleCreateRequestBody = {
  *
  * @tag express
  * @operationId express.v1.wallet.simplecreate
+ * @tag express
  */
 export const PostSimpleCreate = httpRoute({
   path: '/api/v1/wallets/simplecreate',
diff --git a/modules/express/src/typedRoutes/api/v2/createAddress.ts b/modules/express/src/typedRoutes/api/v2/createAddress.ts
@@ -62,8 +62,8 @@ export const CreateAddressResponse = {
 /**
  * Create address for a wallet
  *
- * @tag express
  * @operationId express.v2.wallet.createAddress
+ * @tag express
  */
 export const PostCreateAddress = httpRoute({
   path: '/api/v2/{coin}/wallet/{id}/address',
diff --git a/modules/express/src/typedRoutes/api/v2/keychainLocal.ts b/modules/express/src/typedRoutes/api/v2/keychainLocal.ts
@@ -35,6 +35,7 @@ export const KeychainLocalResponse = {
  *
  * @tag express
  * @operationId express.keychain.local
+ * @tag express
  */
 export const PostKeychainLocal = httpRoute({
   path: '/api/v2/{coin}/keychain/local',
diff --git a/modules/express/src/typedRoutes/api/v2/lightningInitWallet.ts b/modules/express/src/typedRoutes/api/v2/lightningInitWallet.ts
@@ -38,6 +38,7 @@ export const LightningInitWalletResponse = {
  *
  * @tag express
  * @operationId express.lightning.initWallet
+ * @tag express
  */
 export const PostLightningInitWallet = httpRoute({
   path: '/api/v2/{coin}/wallet/{walletId}/initwallet',
diff --git a/modules/express/src/typedRoutes/api/v2/lightningState.ts b/modules/express/src/typedRoutes/api/v2/lightningState.ts
@@ -34,6 +34,7 @@ export const LightningStateResponse = {
  *
  * @tag express
  * @operationId express.lightning.getState
+ * @tag express
  */
 export const GetLightningState = httpRoute({
   method: 'GET',
diff --git a/modules/express/src/typedRoutes/api/v2/ofcSignPayload.ts b/modules/express/src/typedRoutes/api/v2/ofcSignPayload.ts
@@ -1,7 +1,8 @@
 import * as t from 'io-ts';
-import { Json, NonEmptyString, JsonFromString } from 'io-ts-types';
+import { Json, NonEmptyString } from 'io-ts-types';
 import { httpRoute, httpRequest, optional } from '@api-ts/io-ts-http';
 import { BitgoExpressError } from '../../schemas/error';
+import { JsonFromStringifiedJson } from '../../schemas/jsonFromStringifedJson';
 
 /**
  * Sign an arbitrary payload using an OFC trading account key.
@@ -10,7 +11,7 @@ export const OfcSignPayloadBody = {
   /** The ID of the OFC wallet to sign the payload with. */
   walletId: NonEmptyString,
   /** The payload to sign. The input can either be a stringified JSON, or a JSON object. */
-  payload: t.union([Json, t.string.pipe(JsonFromString)]),
+  payload: t.union([Json, JsonFromStringifiedJson]),
   /** The passphrase to decrypt the user key. */
   walletPassphrase: optional(t.string),
 } as const;
@@ -35,8 +36,8 @@ export const OfcSignPayloadResponse = {
 /** Sign payload with an OFC wallet key.
  * Signs an arbitrary payload with an OFC wallet key.
  *
- * @tag express
  * @operationId express.ofc.signPayload
+ * @tag express
  */
 export const PostOfcSignPayload = httpRoute({
   path: '/api/v2/ofc/signPayload',
diff --git a/modules/express/src/typedRoutes/api/v2/unlockWallet.ts b/modules/express/src/typedRoutes/api/v2/unlockWallet.ts
@@ -44,6 +44,7 @@ export const UnlockLightningWalletResponse = {
  *
  * @tag express
  * @operationId express.lightning.unlockWallet
+ * @tag express
  */
 export const PostUnlockLightningWallet = httpRoute({
   method: 'POST',
diff --git a/modules/express/src/typedRoutes/api/v2/verifyAddress.ts b/modules/express/src/typedRoutes/api/v2/verifyAddress.ts
@@ -32,6 +32,7 @@ export const VerifyAddressV2Body = {
  *
  * @tag express
  * @operationId express.verifycoinaddress
+ * @tag express
  */
 export const PostVerifyCoinAddress = httpRoute({
   path: '/api/v2/{coin}/verifyaddress',
diff --git a/modules/express/src/typedRoutes/schemas/jsonFromStringifedJson.ts b/modules/express/src/typedRoutes/schemas/jsonFromStringifedJson.ts
@@ -0,0 +1,4 @@
+import * as t from 'io-ts';
+import { JsonFromString } from 'io-ts-types';
+
+export const JsonFromStringifiedJson = t.string.pipe(JsonFromString);

Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,7 @@ export const CalculateMinerFeeInfoResponse = t.type({`
`39`	`39`	`* 4. The fee rate (in satoshis per kilobyte)`
`40`	`40`	`*`
`41`	`41`	`* @operationId express.calculateminerfeeinfo`
	`42`	`+ * @tag express`
`42`	`43`	`*/`
`43`	`44`	`export const PostCalculateMinerFeeInfo = httpRoute({`
`44`	`45`	`path: '/api/v[12]/calculateminerfeeinfo',`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@ export const DecryptRequestBody = {`
`11`	`11`	`* Decrypt`
`12`	`12`	`*`
`13`	`13`	`* @operationId express.decrypt`
	`14`	`+ * @tag express`
`14`	`15`	`*/`
`15`	`16`	`export const PostDecrypt = httpRoute({`
`16`	`17`	`path: '/api/v[12]/decrypt',`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@ export const EncryptRequestBody = {`
`12`	`12`	`* Encrypt`
`13`	`13`	`*`
`14`	`14`	`* @operationId express.encrypt`
	`15`	`+ * @tag express`
`15`	`16`	`*/`
`16`	`17`	`export const PostEncrypt = httpRoute({`
`17`	`18`	`path: '/api/v[12]/encrypt',`
Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,7 @@ export const LoginRequest = {`
`42`	`42`	`* Login`
`43`	`43`	`*`
`44`	`44`	`* @operationId express.login`
	`45`	`+ * @tag express`
`45`	`46`	`*/`
`46`	`47`	`export const PostLogin = httpRoute({`
`47`	`48`	`path: '/api/v[12]/user/login',`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@ import { BitgoExpressError } from '../../schemas/error';`
`6`	`6`	`* Ping`
`7`	`7`	`*`
`8`	`8`	`* @operationId express.ping`
	`9`	`+ * @tag express`
`9`	`10`	`*/`
`10`	`11`	`export const GetPing = httpRoute({`
`11`	`12`	`path: '/api/v[12]/ping',`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@ import { BitgoExpressError } from '../../schemas/error';`
`6`	`6`	`* Ping Express`
`7`	`7`	`*`
`8`	`8`	`* @operationId express.pingExpress`
	`9`	`+ * @tag express`
`9`	`10`	`*/`
`10`	`11`	`export const GetPingExpress = httpRoute({`
`11`	`12`	`path: '/api/v[12]/pingexpress',`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@ export const VerifyAddressBody = {`
`10`	`10`	`* Verify Address`
`11`	`11`	`*`
`12`	`12`	`* @operationId express.verifyaddress`
	`13`	`+ * @tag express`
`13`	`14`	`*/`
`14`	`15`	`export const PostVerifyAddress = httpRoute({`
`15`	`16`	`path: '/api/v[12]/verifyaddress',`
Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,7 @@ export const AcceptShareRequestBody = {`
`24`	`24`	`*`
`25`	`25`	`* @tag express`
`26`	`26`	`* @operationId express.v1.wallet.acceptShare`
	`27`	`+ * @tag express`
`27`	`28`	`*/`
`28`	`29`	`export const PostAcceptShare = httpRoute({`
`29`	`30`	`path: '/api/v1/walletshare/{shareId}/acceptShare',`