Merge pull request #1325 from input-output-hk/chore/tsc-alias

LW-10722 chore: add tsc-alias to make dist/esm files imports complient with latest node.js versions

Author: iccicci

.eslintrc.js

@@ -54,7 +54,7 @@ module.exports = {
       'error',
       {
         paths: ['lodash'],
-        patterns: ['@cardano-sdk/*/src/*']
+        patterns: ['@cardano-sdk/*/src/*', 'lodash/*', '!lodash/*.js']
       }
     ],
     'no-shadow': 'off',

.github/workflows/continuous-integration-e2e.yaml

@@ -51,7 +51,7 @@ jobs:
       - name: 🔨 Build
         run: |
           yarn install --immutable --inline-builds --mode=skip-build
-          yarn build
+          yarn build:cjs
           docker build --no-cache .
         env:
           NODE_OPTIONS: '--max_old_space_size=8192'

Dockerfile

@@ -55,7 +55,7 @@ RUN yarn --immutable --inline-builds --mode=skip-build
 COPY packages packages
 RUN \
   echo "export const unused = 'unused';" > packages/e2e/src/index.ts &&\
-  NODE_OPTIONS=--max_old_space_size=10240 yarn build
+  NODE_OPTIONS=--max_old_space_size=10240 yarn build:cjs
 
 FROM nodejs-builder as cardano-services-production-deps
 RUN yarn workspaces focus --all --production

package.json

@@ -11,6 +11,7 @@
   ],
   "scripts": {
     "build": "yarn workspaces foreach -v run build",
+    "build:cjs": "yarn workspaces foreach -v run build:cjs",
     "circular-deps:check": "yarn workspaces foreach -v run circular-deps:check",
     "cleanup-build": "yarn workspaces foreach -v run cleanup && yarn install && yarn workspaces foreach -v run build",
     "reinstall": "yarn workspaces foreach -v run cleanup:nm && yarn install",
@@ -84,6 +85,7 @@
     "ts-jest": "^28.0.7",
     "ts-node": "^10.0.0",
     "ts-node-dev": "^1.1.8",
+    "tsc-alias": "^1.8.10",
     "typedoc": "^0.23.24",
     "typedoc-plugin-missing-exports": "^1.0.0",
     "typescript": "^4.7.4"

packages/cardano-services-client/package.json

@@ -20,11 +20,9 @@
   },
   "license": "Apache-2.0",
   "scripts": {
-    "build:esm": "tsc -p src/tsconfig.json --outDir ./dist/esm --module es2020",
-    "build:cjs": "tsc --build src",
-    "build:version": "bash -c 'if node ./scripts/createVersionSource.js --check ; then node ./scripts/createVersionSource.js --create && yarn lint:fix ; fi && cp ./package.json ./dist/package.json'",
-    "build": "yarn build:version && run-s build:cjs build:esm module-fixup",
-    "module-fixup": "cp ../../build/cjs-package.json ./dist/cjs/package.json && cp ../../build/esm-package.json ./dist/esm/package.json",
+    "build": "yarn build:cjs && tsc -p src/tsconfig.json --outDir ./dist/esm --module es2020 && tsc-alias -p src/tsconfig.json --outDir ./dist/esm && cp ../../build/esm-package.json ./dist/esm/package.json",
+    "build:cjs": "yarn build:version && tsc --build src && cp ./package.json dist/ && cp ../../build/cjs-package.json ./dist/cjs/package.json",
+    "build:version": "bash -c 'if node ./scripts/createVersionSource.js --check ; then node ./scripts/createVersionSource.js --create && yarn lint:fix ; fi'",
     "tscNoEmit": "echo typescript --noEmit command not implemented yet",
     "cleanup:dist": "rm -rf dist",
     "circular-deps:check": "madge --circular dist/cjs",
@@ -50,6 +48,7 @@
     "madge": "^5.0.1",
     "npm-run-all": "^4.1.5",
     "ts-jest": "^28.0.7",
+    "tsc-alias": "^1.8.10",
     "typescript": "^4.7.4"
   },
   "dependencies": {

packages/cardano-services-client/src/typings.d.ts

@@ -1 +1,4 @@
 declare module '*.json';
+
+// exclude from build, as it has to be imported at runtime
+declare module '../package.json';

packages/cardano-services/package.json

@@ -21,9 +21,8 @@
   "sideEffects": false,
   "license": "Apache-2.0",
   "scripts": {
-    "build:cjs": "tsc --build src && chmod +x ./dist/cjs/cli.js",
-    "build:copy-assets": "bash ./copy-assets.sh",
-    "build": "run-s build:cjs build:copy-assets",
+    "build": "yarn build:cjs",
+    "build:cjs": "tsc --build src && chmod +x ./dist/cjs/cli.js && bash ./copy-assets.sh",
     "build:test-db": "./test/jest-setup/rebuild-test-db.sh",
     "cleanup:dist": "rm -rf dist",
     "cleanup:nm": "rm -rf node_modules",

packages/cardano-services/src/Asset/CardanoTokenRegistry.ts

@@ -4,7 +4,7 @@ import { Logger } from 'ts-log';
 import { TokenMetadataService } from './types';
 import { contextLogger } from '@cardano-sdk/util';
 import axios, { AxiosInstance } from 'axios';
-import pick from 'lodash/pick';
+import pick from 'lodash/pick.js';
 
 export const DEFAULT_TOKEN_METADATA_CACHE_TTL = Seconds(10 * 60);
 export const DEFAULT_TOKEN_METADATA_REQUEST_TIMEOUT = Milliseconds(3 * 1000);

packages/cardano-services/src/ChainHistory/DbSyncChainHistory/ChainHistoryBuilder.ts

@@ -39,8 +39,8 @@ import {
   mapTxTokenMap,
   mapWithdrawal
 } from './mappers';
-import omit from 'lodash/omit';
-import orderBy from 'lodash/orderBy';
+import omit from 'lodash/omit.js';
+import orderBy from 'lodash/orderBy.js';
 
 export class ChainHistoryBuilder {
   #db: Pool;

packages/cardano-services/src/ChainHistory/DbSyncChainHistory/DbSyncChainHistoryProvider.ts

@@ -18,7 +18,7 @@ import { QueryResult } from 'pg';
 import { TxMetadataService } from '../../Metadata';
 import { hexStringToBuffer } from '@cardano-sdk/util';
 import { mapBlock, mapTxAlonzo, mapTxIn, mapTxOut } from './mappers';
-import orderBy from 'lodash/orderBy';
+import orderBy from 'lodash/orderBy.js';
 
 /** Properties that are need to create DbSyncChainHistoryProvider */
 export interface ChainHistoryProviderProps {