feat: package exports (#10)

Author: simboonlong

README.md

@@ -1,8 +1,17 @@
 # tradetrust-utils
+
 This is a repository that houses shared project logic between tradetrust website and tradetrust document creator.
 
 Currently, this is still an experiment to see whether this structure of sharing logic between the 2 repos is sustainable.
 
 We will monitor whether the dependencies will get out of hand.
 
-Before any commits here, please ask the maintainers (TradeTrust team) first.
+Before any commits here, please ask the maintainers (TradeTrust team) first.
+
+### Direct import
+
+If the consuming application does not support treeshaking, you should do direct import instead. Example:
+
+```
+import { CHAIN_ID } from "@govtechsg/tradetrust-utils/constants/supportedChains";
+```

package-lock.json

@@ -2,14 +2,37 @@
   "name": "@govtechsg/tradetrust-utils",
   "version": "0.1.0",
   "description": "",
-  "main": "dist/cjs/index.js",
-  "module": "dist/esm/index.js",
-  "types": "dist/types/src/index.d.ts",
+  "types": "./dist/types/index.d.ts",
+  "typesVersions": {
+    "*": {
+      ".": [
+        "./dist/types/index.d.ts"
+      ],
+      "constants/*": [
+        "./dist/types/constants/*.d.ts"
+      ]
+    }
+  },
+  "exports": {
+    ".": {
+      "require": "./dist/cjs/index.js",
+      "import": "./dist/esm/index.js"
+    },
+    "./constants/*": {
+      "require": "./dist/cjs/constants/*.js",
+      "import": "./dist/esm/constants/*.js"
+    }
+  },
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "files": [
+    "dist"
+  ],
   "scripts": {
-    "build": "npm run clean && npm run build:cjs && npm run build:esm && npm run build:type",
+    "build": "npm run clean && npm run build:cjs && npm run build:esm && npm run build:types",
     "build:cjs": "tsc --module commonjs --outDir dist/cjs --project ./tsconfig.prod.json",
     "build:esm": "tsc --module es2015 --outDir dist/esm --project ./tsconfig.prod.json",
-    "build:type": "tsc -d --emitDeclarationOnly --outDir dist/types/src",
+    "build:types": "tsc --declaration --emitDeclarationOnly --outDir dist/types --project ./tsconfig.prod.json",
     "clean": "rm -rf dist/",
     "test:ci": "jest --runInBand",
     "test": "NODE_OPTIONS=--max-old-space-size=2048 jest",
@@ -43,7 +66,7 @@
     "prettier": "^2.5.1",
     "semantic-release": "^18.0.1",
     "ts-jest": "^27.1.0",
-    "typescript": "^4.5.2"
+    "typescript": "^4.9.4"
   },
   "publishConfig": {
     "access": "public"

package.json

@@ -0,0 +1,5 @@
+export type networkName = "local" | "mainnet" | "matic" | "maticmum" | "goerli" | "sepolia";
+
+export type networkType = "production" | "test" | "development";
+
+export type networkCurrency = "ETH" | "MATIC";

src/constants/SupportedNetworks.ts

@@ -0,0 +1,58 @@
+import { networkName, networkType, networkCurrency } from "./network";
+
+export enum CHAIN_ID {
+  local = "1337",
+  mainnet = "1",
+  matic = "137",
+  maticmum = "80001",
+  goerli = "5",
+  sepolia = "11155111",
+}
+
+export type chainInfo = {
+  label: string;
+  name: networkName;
+  type: networkType;
+  currency: networkCurrency;
+};
+
+type supportedChains = Record<CHAIN_ID, chainInfo>;
+
+export const SUPPORTED_CHAINS: supportedChains = {
+  [CHAIN_ID.local]: {
+    label: "Local",
+    name: "local",
+    type: "development",
+    currency: "ETH",
+  },
+  [CHAIN_ID.mainnet]: {
+    label: "Mainnet",
+    name: "mainnet",
+    type: "production",
+    currency: "ETH",
+  },
+  [CHAIN_ID.matic]: {
+    label: "Polygon",
+    name: "matic",
+    type: "production",
+    currency: "MATIC",
+  },
+  [CHAIN_ID.maticmum]: {
+    label: "Polygon Mumbai",
+    name: "maticmum",
+    type: "test",
+    currency: "MATIC",
+  },
+  [CHAIN_ID.goerli]: {
+    label: "Goerli",
+    name: "goerli",
+    type: "test",
+    currency: "ETH",
+  },
+  [CHAIN_ID.sepolia]: {
+    label: "Sepolia",
+    name: "sepolia",
+    type: "test",
+    currency: "ETH",
+  },
+};

src/constants/network.ts

@@ -1,5 +1,5 @@
 import * as CONSTANTS from "./constants/VerificationErrorMessages";
-export * from "./constants/SupportedNetworks";
+export * from "./constants/supportedChains";
 export * from "./analytics";
 export * from "./fragments";
 export { CONSTANTS };