Merge pull request #18 from Kucoin/release/2025.02.26

Release/2025.02.26

Author: ISAAC-XXYYZZ

.github/workflows/upload-nodejs-sdk-package.yml

@@ -0,0 +1,50 @@
+name: Upload Nodejs SDK Package
+
+on:
+  workflow_dispatch:
+    inputs:
+      publish:
+        description: "Publish Nodejs SDK to NPM"
+        required: false
+        default: "false"
+
+permissions:
+  contents: read
+  packages: write
+  id-token: write
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          registry-url: 'https://registry.npmjs.org'
+          cache: 'npm'
+          cache-dependency-path: sdk/node/package-lock.json
+
+      - name: Install Dependencies
+        working-directory: sdk/node
+        run: npm ci
+
+      - name: Build Project
+        working-directory: sdk/node
+        run: npm run build 
+
+      - name: Dry Run Package Publishing
+        if: github.event.inputs.publish == 'false'
+        working-directory: sdk/node
+        run: npm publish --dry-run
+
+      - name: Publish Package to npm
+        if: github.event.inputs.publish == 'true'
+        working-directory: sdk/node
+        run: npm publish --provenance --access public --tag latest
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

Dockerfile

@@ -22,21 +22,28 @@ RUN --mount=type=cache,target=/root/.m2,sharing=locked mvn -U clean package -Dsk
 # build tools 
 FROM openapitools/openapi-generator-cli:v7.7.0
 
-RUN apt-get update && apt-get install python3 python3-pip python3.8-venv -y
+RUN apt-get update && apt-get install python3 python3-pip python3.8-venv nodejs npm -y
 RUN pip install yapf
 ENV GOLANG_VERSION=1.22.2
 RUN curl -OL https://golang.org/dl/go${GOLANG_VERSION}.linux-amd64.tar.gz && \
     tar -C /usr/local -xzf go${GOLANG_VERSION}.linux-amd64.tar.gz && \
     rm go${GOLANG_VERSION}.linux-amd64.tar.gz
 WORKDIR /APP
 COPY --from=generator-builder /build/target/sdk-openapi-generator-1.0.0.jar /opt/openapi-generator/modules/openapi-generator-cli/target/openapi-generator-cli.jar
+
+# node & npm
+RUN curl -fsSL https://deb.nodesource.com/setup_18.x | bash -
+RUN apt-get install -y nodejs
+RUN npm install -g prettier
+
 ENV CGO_ENABLED=0
 ENV PATH="/usr/local/go/bin:$PATH"
 ENV GOPATH="/go"
 ENV PATH="$GOPATH/bin:$PATH"
 
 ENV GO_POST_PROCESS_FILE="/usr/local/go/bin/gofmt -w"
 ENV PYTHON_POST_PROCESS_FILE="/usr/local/bin/yapf -i"
+ENV TS_POST_PROCESS_FILE="/usr/bin/prettier --write --semi --single-quote --tab-width 4 --trailing-comma all --bracket-spacing --arrow-parens always --end-of-line lf --print-width 100"
 
 ENTRYPOINT ["/usr/local/bin/docker-entrypoint.sh"]
 

Makefile

@@ -64,12 +64,12 @@ define generate-code
 
 	@echo "$(GREEN)lang: $(lang), clean...$(NC)"
 	docker run --rm -v "${PWD}:/local" $(IMAGE_NAME):$(IMAGE_TAG) rm -rf $(outdir)
-
+	
 	@echo "$(GREEN)lang: ${lang}, copy changelog...$(NC)"
 	docker run --rm -v "${PWD}:/local" $(IMAGE_NAME):$(IMAGE_TAG) cp /local/CHANGELOG.md /local/sdk/$(lang)
 
-	@make -f generate.mk generate lang=$(1) subdir=$(2)
-	
+	@make -f generate.mk generate lang=$(1) subdir=$(2) USER_VERSION=$(3)
+
 	@echo "$(GREEN)lang: $(lang), clean...$(NC)"
 	docker run --rm -v "${PWD}:/local" $(IMAGE_NAME):$(IMAGE_TAG) rm -rf $(outdir)/.openapi-generator
 	docker run --rm -v "${PWD}:/local" $(IMAGE_NAME):$(IMAGE_TAG) rm -rf $(outdir)/.openapi-generator-ignore
@@ -97,6 +97,7 @@ generate: setup-logs
 	$(call generate-postman)
 	$(call generate-code,golang,/pkg/generate)
 	$(call generate-code,python,/kucoin_universal_sdk/generate)
+	$(call generate-code,node,/src/generate,v0.1.0-alpha)
 
 .PHONY: gen-postman
 gen-postman: preprocessor

README.md

@@ -47,6 +47,12 @@ go get github.com/Kucoin/kucoin-universal-sdk/sdk/golang
 go mod tidy
 ```
 
+### Node.js Installation (`0.1.0-alpha`)
+Note: This SDK is currently in the Alpha phase. We are actively iterating and improving its features, stability, and documentation. Feedback and contributions are highly encouraged to help us refine the SDK.
+```bash
+npm install kucoin-universal-sdk
+```
+
 ### Postman Installation  
 Visit the [KuCoin API Collection on Postman](https://www.postman.com/kucoin-api/kucoin-api/overview)
 
@@ -124,6 +130,7 @@ For other languages, refer to the [Examples](#-examples) section.
 - Official Documentation: [KuCoin API Docs](https://www.kucoin.com/docs-new)  
 - **[Python Documentation](sdk/python/README.md)**
 - **[Go Documentation](sdk/golang/README.md)**
+- **[Node.js Documentation](sdk/node/README.md)**
 - **[Postman Documentation](sdk/postman/README.md)**
 
 ## 📂 Examples
@@ -132,7 +139,8 @@ Find usage examples for your desired language by selecting the corresponding lin
 | Language | Example Directory                          |
 |----------|--------------------------------------------|
 | Python   | [sdk/python/examples/](sdk/python/example/)|
-| Go       | [sdk/go/examples/](sdk/golang/example/) |
+| Go       | [sdk/go/examples/](sdk/golang/example/)    |
+| Node.js  | [sdk/node/examples/](sdk/node/example/)    |
 
 ## 📋 Changelog
 

generate.mk

@@ -1,8 +1,11 @@
 IMAGE_NAME=sdk-tools
 IMAGE_TAG=1.0
-VERSION := $(shell cat VERSION)
 DATE := $(shell date +%Y-%m-%d)
 
+FILE_VERSION := $(shell cat VERSION)
+USER_VERSION ?= 
+VERSION := $(if $(USER_VERSION),$(USER_VERSION),$(FILE_VERSION))
+
 RED=\033[0;31m
 GREEN=\033[0;32m
 NC=\033[0m
@@ -54,7 +57,7 @@ define generate-entry
 	     -g $(2)-sdk \
 	     -o $(3) \
 		 --skip-validate-spec \
-	     --additional-properties=GEN_MODE=entry,API_VERSION=$(VERSION),API_DATE=$(DATE) > logs/$(service)-$(lang)-entry.log 2>&1 || \
+	     --additional-properties=GEN_MODE=entry,API_VERSION=$(VERSION),API_DATE=$(DATE),CSV_PATH=/local/spec > logs/$(service)-$(lang)-entry.log 2>&1 || \
 		 { echo "$(RED)Entry Task $(service) for $(lang) failed$(NC)"; exit 1; }
 endef
 
@@ -90,7 +93,7 @@ WS_FILES := $(wildcard ./spec/ws/*.json)
 generate-postman:
 	$(call generate-postman-func)
 
-generate: $(patsubst ./spec/rest/api/%.json,generate-rest-%, $(REST_FILES)) $(patsubst ./spec/rest/entry/%.json,generate-entry-%, $(ENTRY_FILES)) $(patsubst ./spec/ws/%.json,generate-ws-%, $(WS_FILES))
+generate: $(patsubst ./spec/rest/api/%.json,generate-rest-%, $(REST_FILES)) $(patsubst ./spec/ws/%.json,generate-ws-%, $(WS_FILES)) $(patsubst ./spec/rest/entry/%.json,generate-entry-%, $(ENTRY_FILES)) 
 
 generate-rest-%: ./spec/rest/api/%.json | force
 	$(eval service=$*)

generator/plugin/pom.xml

@@ -16,6 +16,7 @@
         <maven.shade.plugin.version>3.2.4</maven.shade.plugin.version>
         <maven.compiler.plugin.version>3.6.1</maven.compiler.plugin.version>
         <ascii-table.version>1.8.0</ascii-table.version>
+        <csv.version>5.7.1</csv.version>
     </properties>
 
     <dependencies>
@@ -36,6 +37,12 @@
             <version>${ascii-table.version}</version>
             <scope>compile</scope>
         </dependency>
+        <dependency>
+            <groupId>com.opencsv</groupId>
+            <artifactId>opencsv</artifactId>
+            <version>${csv.version}</version>
+            <scope>compile</scope>
+        </dependency>
     </dependencies>
 
 
@@ -67,6 +74,7 @@
                                 <includes>
                                     <include>org.openapitools:openapi-generator-cli</include>
                                     <include>com.github.freva:ascii-table</include>
+                                    <include>com.opencsv:opencsv</include>
                                 </includes>
                             </artifactSet>
                             <transformers>