feat(ts): exports all the generated namespaces (#184)

script/protocgen-legacy.sh

@@ -38,7 +38,7 @@ for dir in $proto_dirs; do
         -I "vendor/github.com/cosmos/cosmos-sdk/third_party/proto" \
         --plugin="${AKASH_TS_NODE_BIN}/protoc-gen-ts_proto" \
         --ts_proto_out="${AKASH_TS_ROOT}/src/generated" \
-        --ts_proto_opt=esModuleInterop=true,forceLong=long,outputTypeRegistry=true,useExactTypes=false \
+        --ts_proto_opt=esModuleInterop=true,forceLong=long,outputTypeRegistry=true,useExactTypes=false,outputIndex=true \
         $(find "${dir}" -maxdepth 1 -name '*.proto')
 done
 
@@ -72,7 +72,7 @@ for dir in $proto_dirs; do
         -I "vendor/github.com/cosmos/cosmos-sdk/third_party/proto" \
         --plugin="${AKASH_TS_NODE_BIN}/protoc-gen-ts_proto" \
         --ts_proto_out="${AKASH_TS_ROOT}/src/generated" \
-        --ts_proto_opt=esModuleInterop=true,forceLong=long,outputTypeRegistry=true,useExactTypes=false \
+        --ts_proto_opt=esModuleInterop=true,forceLong=long,outputTypeRegistry=true,useExactTypes=false,outputIndex=true \
         $(find "${dir}" -maxdepth 1 -name '*.proto')
 done
 

ts/.eslintrc.json

@@ -10,11 +10,30 @@
     "ecmaVersion": "latest",
     "sourceType": "module"
   },
-  "plugins": ["@typescript-eslint"],
+  "plugins": ["@typescript-eslint", "simple-import-sort"],
   "rules": {
     "@typescript-eslint/no-unused-vars": [
       "error",
-      { "ignoreRestSiblings": true }
+      {
+        "ignoreRestSiblings": true
+      }
+    ],
+    "simple-import-sort/imports": [
+      "error",
+      {
+        "groups": [
+          ["^(@|src|@src)?\\w"],
+          [
+            "^(src|main|core|arc-storybook|viz|design-system|placement|reporting|onboarding)(/.*|$)",
+            "^\\u0000",
+            "^\\.\\.(?!/?$)",
+            "^\\.\\./?$",
+            "^\\./(?=.*/)(?!/?$)",
+            "^\\.(?!/?$)",
+            "^\\./?$"
+          ]
+        ]
+      }
     ]
   }
 }

ts/.gitignore

@@ -2,6 +2,7 @@
 /dist
 /build
 /node_modules
+tsconfig.paths.json
 
 # Logs
 logs

ts/.husky/pre-commit

@@ -1 +1 @@
-ts/node_modules/.bin/lint-staged --cwd ts
+ts/node_modules/.bin/lint-staged --cwd ts

ts/README.md

@@ -0,0 +1,56 @@
+# Akash API TypeScript Bindings
+
+[![npm version](https://badge.fury.io/js/%40akashnetwork%2Fakash-api.svg)](https://badge.fury.io/js/%40akashnetwork%2Fakash-api)
+[![License: Apache-2.0](https://img.shields.io/badge/License-apache2.0-yellow.svg)](https://opensource.org/license/apache-2-0)
+
+This package provides TypeScript bindings for the Akash API, generated from protobuf definitions.
+
+## Installation
+
+To install the package, run:
+
+```bash
+npm install @akashnetwork/akash-api
+```
+
+## Usage
+
+You can import the generated namespaces from the package like this:
+```typescript
+import * as akashDeploymentV1beta1 from '@akashnetwork/akash-api/akash/deployment/v1beta1';
+import * as akashDiscoveryV1 from '@akashnetwork/akash-api/akash/discovery/v1';
+// ... and so on for other namespaces
+```
+
+### TypeScript 4.5 and above
+If you're using TypeScript 4.5 or above, the package exports all the paths of the generated namespaces, so you can import them directly.  
+
+### TypeScript below 4.5
+If you're using a version of TypeScript below 4.5, the package provides a tsconfig.paths.json file that you can extend in your local TypeScript configuration to resolve the paths. Here's how you can do it:  In your tsconfig.json file, add the following:
+```json
+{
+  "extends": "@akashnetwork/akash-api/tsconfig.paths.json"
+}
+```
+
+### Contributing
+Contributions are welcome. Please submit a pull request or create an issue to discuss the changes you want to make.
+
+### Contributing to Generated Files
+
+The files in the `src/generated` directory are auto-generated and should not be modified directly. If you need to make changes to these files, follow the steps below:
+
+1. Create a new file in the `src/patch` directory with the same path as the file you want to modify. For example, if you want to modify `src/generated/cosmos/base/v1beta1/coin.ts`, you should create the directory `src/patch/cosmos/base/v1beta1/coin.ts`.
+
+2. Add your changes to a new file in the `src/patch` directory. The new file should have the same name as the file you want to modify.
+
+3. Rename the original file in the `src/generated` directory by appending `.original.ts` to its name. For example, `src/generated/cosmos/base/v1beta1/coin.ts` should be renamed to `src/generated/cosmos/base/v1beta1/coin.original.ts`.
+
+4. Create a new file in the `src/generated` directory with the same name as the original file. This new file should re-export everything from the corresponding file in the `src/patch` directory. For example, the content of `src/generated/cosmos/base/v1beta1/coin.ts` should be:
+
+```typescript
+export * from '../../../../patch/cosmos/base/v1beta1/coin';
+```
+
+### License
+This package is licensed under the Apache-2.0.

ts/jest.config.js

@@ -0,0 +1,25 @@
+const common = {
+  transform: {
+    '^.+\\.(t|j)s$': ['ts-jest', { tsconfig: './tsconfig.json' }],
+  },
+  rootDir: '.',
+  setupFiles: ['./test/setup.ts'],
+};
+
+module.exports = {
+  collectCoverageFrom: ['./src/**/*.{js,ts}'],
+  projects: [
+    {
+      displayName: 'unit',
+      ...common,
+      testMatch: ['<rootDir>/src/**/*.spec.ts'],
+      setupFilesAfterEnv: ['./test/setup-unit-tests.ts'],
+    },
+    {
+      displayName: 'functional',
+      ...common,
+      testMatch: ['<rootDir>/test/functional/**/*.spec.ts'],
+      setupFilesAfterEnv: ['./test/setup-functional-tests.ts'],
+    },
+  ],
+};