[GMS-1127] chore: Export api types from blockchain data package (#971)

Co-authored-by: Allan Almeida <allan.almeida@immutable.com>

packages/blockchain-data/sample-app/src/app/page.tsx

@@ -6,6 +6,7 @@ import { Environment, ImmutableConfiguration } from '@imtbl/config';
 import {
   BlockchainData,
   BlockchainDataModuleConfiguration,
+  ChainsApi,
 } from '@imtbl/blockchain-data';
 import { PageLayout } from '@/components/PageLayout';
 import { capitalizeFirstLetter } from '@/utils';
@@ -405,7 +406,9 @@ const endpointDomains = {
 };
 
 export default function Home() {
-  const [response, setResponse] = useState('');
+  const [response, setResponse] = useState<ChainsApi.ListChainsResult | null>(
+    null,
+  );
 
   useEffect(() => {
     async function getData() {
@@ -425,8 +428,9 @@ export default function Home() {
       const client = new BlockchainData(config);
 
       try {
-        const response = await client.listChains();
-        setResponse(response.result);
+        const request: ChainsApi.ListChainsRequest = {};
+        const response = await client.listChains(request);
+        setResponse(response);
       } catch (error) {
         console.error(error);
       }
@@ -466,9 +470,11 @@ export default function Home() {
           })}
         </div>
         <div className="flex-1 bg-gray w-full h-full">
-          <pre className="p-4 bg-neutral-800/50 rounded-lg">
-            {JSON.stringify(response, null, 2)}
-          </pre>
+          {response !== null && (
+            <pre className="p-4 bg-neutral-800/50 rounded-lg">
+              {JSON.stringify(response.result, null, 2)}
+            </pre>
+          )}
         </div>
       </div>
     </PageLayout>

packages/blockchain-data/sdk/src/index.ts

@@ -1,11 +1,27 @@
-import { mr } from '@imtbl/generated-clients';
+import {
+  mr,
+  ActivitiesApi,
+  ChainsApi,
+  CollectionsApi,
+  MetadataApi,
+  NFTOwnersApi,
+  NFTsApi,
+  TokensApi,
+} from '@imtbl/generated-clients';
 import { APIError } from './types/errors';
 import { BlockchainData } from './blockchain-data';
 import { BlockchainDataModuleConfiguration } from './config';
 
 type ActivityType = mr.ActivityType;
 
 export {
+  ActivitiesApi,
+  ChainsApi,
+  CollectionsApi,
+  MetadataApi,
+  NFTOwnersApi,
+  NFTsApi,
+  TokensApi,
   APIError,
   BlockchainData,
   BlockchainDataModuleConfiguration,

packages/internal/generated-clients/Makefile

@@ -4,7 +4,7 @@ generate-imx-openapi: get-imx-openapi generate-imx-api-client
 .PHONY: generate-mr-openapi
 generate-mr-openapi: get-mr-openapi generate-mr-api-client
 
-# Note: We generate clients with sandbox spec only as Prod and Sandbox are maintained to be same. 
+# Note: We generate clients with sandbox spec only as Prod and Sandbox are maintained to be same.
 #.      Prod url is passed in via config to talk to prod API.
 .PHONY: get-imx-openapi
 get-imx-openapi:
@@ -28,15 +28,15 @@ generate-imx-api-client:
 	docker run --rm -v $(shell pwd):/app openapitools/openapi-generator-cli:v6.2.1 generate \
     -i ./app/src/imx-openapi.json \
     -g typescript-axios \
-    --additional-properties=supportsES6=true,npmVersion=6.9.0,typescriptThreePlus=true,withSeparateModelsAndApi=true,modelPackage=models,apiPackage=domain,useSingleRequestParameter=true \
-    -o /app/src/imx
+    -o /app/src/imx \
+    -c /app/imx.config.json
 
 .PHONY: generate-mr-api-client
 generate-mr-api-client:
 	rm -rf src/multi-rollup && \
     mkdir src/multi-rollup && \
-	docker run --rm -v $(shell pwd):/app openapitools/openapi-generator-cli:v6.2.1 generate \
+	docker run --rm -v $(shell pwd):/app openapitools/openapi-generator-cli:v7.0.1 generate \
     -i ./app/src/mr-openapi.json \
     -g typescript-axios \
-    --additional-properties=supportsES6=true,npmVersion=6.9.0,typescriptThreePlus=true,withSeparateModelsAndApi=true,modelPackage=models,apiPackage=domain,useSingleRequestParameter=true \
-    -o /app/src/multi-rollup
+    -o /app/src/multi-rollup \
+    -c /app/mr.config.json

packages/internal/generated-clients/imx.config.json

@@ -0,0 +1,9 @@
+{
+  "supportsES6": true,
+  "npmVersion": "6.9.0",
+  "typescriptThreePlus": true,
+  "withSeparateModelsAndApi": true,
+  "modelPackage": "models",
+  "apiPackage": "domain",
+  "useSingleRequestParameter": true
+}

packages/internal/generated-clients/mr.config.json

@@ -0,0 +1,16 @@
+{
+  "supportsES6": true,
+  "npmVersion": "6.9.0",
+  "typescriptThreePlus": true,
+  "withSeparateModelsAndApi": true,
+  "modelPackage": "models",
+  "apiPackage": "domain",
+  "useSingleRequestParameter": true,
+  "templateDir": "app/src/templates",
+  "files": {
+    "api-types.mustache": {
+      "templateType": "API",
+      "destinationFilename": "-types.ts"
+    }
+  }
+}

packages/internal/generated-clients/src/index.ts

@@ -1,5 +1,16 @@
 export * as imx from './imx';
 export * as mr from './multi-rollup';
+
+export * as ActivitiesApi from './multi-rollup/domain/activities-api-types';
+export * as ChainsApi from './multi-rollup/domain/chains-api-types';
+export * as CollectionsApi from './multi-rollup/domain/collections-api-types';
+export * as MetadataApi from './multi-rollup/domain/metadata-api-types';
+export * as NFTOwnersApi from './multi-rollup/domain/nft-owners-api-types';
+export * as NFTsApi from './multi-rollup/domain/nfts-api-types';
+export * as OrdersApi from './multi-rollup/domain/orders-api-types';
+export * as PassportApi from './multi-rollup/domain/passport-api-types';
+export * as TokensApi from './multi-rollup/domain/tokens-api-types';
+
 export { ImxApiClients } from './imx-api-clients';
 export { MultiRollupApiClients } from './mr-api-clients';
 export {

packages/internal/generated-clients/src/multi-rollup/.openapi-generator/FILES

@@ -5,14 +5,23 @@ api.ts
 base.ts
 common.ts
 configuration.ts
+domain/activities-api-types.ts
 domain/activities-api.ts
+domain/chains-api-types.ts
 domain/chains-api.ts
+domain/collections-api-types.ts
 domain/collections-api.ts
+domain/metadata-api-types.ts
 domain/metadata-api.ts
+domain/nft-owners-api-types.ts
 domain/nft-owners-api.ts
+domain/nfts-api-types.ts
 domain/nfts-api.ts
+domain/orders-api-types.ts
 domain/orders-api.ts
+domain/passport-api-types.ts
 domain/passport-api.ts
+domain/tokens-api-types.ts
 domain/tokens-api.ts
 git_push.sh
 index.ts
@@ -24,19 +33,12 @@ models/activity-nft.ts
 models/activity-token.ts
 models/activity-type.ts
 models/activity.ts
-models/apierror400-all-of.ts
 models/apierror400.ts
-models/apierror401-all-of.ts
 models/apierror401.ts
-models/apierror403-all-of.ts
 models/apierror403.ts
-models/apierror404-all-of.ts
 models/apierror404.ts
-models/apierror429-all-of.ts
 models/apierror429.ts
-models/apierror500-all-of.ts
 models/apierror500.ts
-models/apierror501-all-of.ts
 models/apierror501.ts
 models/basic-apierror.ts
 models/blockchain-metadata.ts
@@ -45,7 +47,6 @@ models/cancel-orders-request-body.ts
 models/cancel-orders-result-data.ts
 models/cancel-orders-result.ts
 models/cancelled-order-status.ts
-models/chain-with-details-all-of.ts
 models/chain-with-details.ts
 models/chain.ts
 models/collection-contract-type.ts
@@ -107,10 +108,8 @@ models/protocol-data.ts
 models/refresh-collection-metadata-request.ts
 models/refresh-collection-metadata-result.ts
 models/refresh-metadata-by-id.ts
-models/refresh-metadata-by-idall-of.ts
 models/refresh-metadata-by-idrequest.ts
 models/refresh-metadata-by-token-id.ts
-models/refresh-metadata-by-token-idall-of.ts
 models/refresh-nftmetadata-by-token-idrequest.ts
 models/refreshable-nftattributes.ts
 models/sale-fee.ts

packages/internal/generated-clients/src/multi-rollup/.openapi-generator/VERSION

@@ -1 +1 @@
-6.2.1
+7.0.1

packages/internal/generated-clients/src/multi-rollup/base.ts

@@ -13,10 +13,11 @@
  */
 
 
-import { Configuration } from "./configuration";
+import type { Configuration } from './configuration';
 // Some imports not used depending on template conditions
 // @ts-ignore
-import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
 
 export const BASE_PATH = "https://api.sandbox.immutable.com".replace(/\/+$/, "");
 
@@ -64,8 +65,8 @@ export class BaseAPI {
  * @extends {Error}
  */
 export class RequiredError extends Error {
-    name: "RequiredError" = "RequiredError";
     constructor(public field: string, msg?: string) {
         super(msg);
+        this.name = "RequiredError"
     }
 }

packages/internal/generated-clients/src/multi-rollup/common.ts

@@ -13,9 +13,10 @@
  */
 
 
-import { Configuration } from "./configuration";
-import { RequiredError, RequestArgs } from "./base";
-import { AxiosInstance, AxiosResponse } from 'axios';
+import type { Configuration } from "./configuration";
+import type { RequestArgs } from "./base";
+import type { AxiosInstance, AxiosResponse } from 'axios';
+import { RequiredError } from "./base";
 
 /**
  *
@@ -84,6 +85,7 @@ export const setOAuthToObject = async function (object: any, name: string, scope
 }
 
 function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void {
+    if (parameter == null) return;
     if (typeof parameter === "object") {
         if (Array.isArray(parameter)) {
             (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
@@ -142,7 +144,7 @@ export const toPathString = function (url: URL) {
  */
 export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) {
     return <T = unknown, R = AxiosResponse<T>>(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
-        const axiosRequestArgs = {...axiosArgs.options, url: (configuration?.basePath || basePath) + axiosArgs.url};
+        const axiosRequestArgs = {...axiosArgs.options, url: (configuration?.basePath || axios.defaults.baseURL || basePath) + axiosArgs.url};
         return axios.request<T, R>(axiosRequestArgs);
     };
 }