Merge pull request #7247 from BitGo/WP-6196-add-openapi-generator-rc-js

feat(express): Add openapi-generator support

Author: danielzhao122

modules/express/openapi-generator.rc.js

@@ -0,0 +1,29 @@
+/**
+ * OpenAPI Generator Configuration
+ * Custom codec handlers for OpenAPI generation
+ */
+
+module.exports = (E) => {
+  return {
+    '.': {
+      JsonFromStringifiedJson: () => E.right({ type: 'string' }),
+      Optional: (args) => E.right({ ...args[0], nullable: true }),
+    },
+    'io-ts-types': {
+      Json: () => E.right({ type: 'object', properties: {}, required: [] }),
+      NonEmptyString: () => E.right({ type: 'string', minLength: 1 }),
+      DateFromISOString: () => E.right({ type: 'string', format: 'date-time' }),
+      BigIntFromString: () => E.right({ type: 'string' }),
+    },
+    'io-ts-bigint': {
+      BigIntFromString: () => E.right({ type: 'string' }),
+      NegativeBigIntFromString: () => E.right({ type: 'string' }),
+      PositiveBigIntFromString: () => E.right({ type: 'string' }),
+      NonZeroBigIntFromString: () => E.right({ type: 'string' }),
+      NonNegativeBigIntFromString: () => E.right({ type: 'string' }),
+    },
+    'io-ts-numbers': {
+      NumberFromString: () => E.right({ type: 'string' }),
+    },
+  };
+};

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"

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',

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',

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',

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',

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',

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',

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',

modules/express/src/typedRoutes/api/v1/acceptShare.ts

@@ -22,8 +22,8 @@ export const AcceptShareRequestBody = {
  * When a wallet is shared with a user, they need to accept the share to gain access
  * to the wallet according to the permissions granted by the sharing user.
  *
- * @tag express
  * @operationId express.v1.wallet.acceptShare
+ * @tag express
  */
 export const PostAcceptShare = httpRoute({
   path: '/api/v1/walletshare/{shareId}/acceptShare',