kb-cloud-client-typescript 0.0.0-main.20260527.1703 → 0.0.1

package/README.md

@@ -1,19 +1,17 @@
-# KubeBlocks Cloud TypeScript SDK
+# kb-cloud-client-typescript
 
 Auto-generated TypeScript SDK for KubeBlocks Cloud API.
 
-## Install
+## SDKs
 
-```bash
-npm install kb-cloud-client-typescript
-# or
-yarn add kb-cloud-client-typescript
-```
+| SDK | Source | Description |
+|-----|--------|-------------|
+| `openapi` | `openapi.yaml` | User Portal API |
+| `adminapi` | `adminapi.yaml` | Admin Portal API |
+| `internalapi` | `internalapi.yaml` | Internal API |
 
 ## Usage
 
-### User Portal API (`openapi`)
-
 ```ts
 import { Configuration, OpenApi } from 'kb-cloud-client-typescript';
 
@@ -23,34 +21,53 @@ const api = new OpenApi.OrganizationApi(
 const orgs = await api.listOrg();
 ```
 
-### Admin Portal API (`adminapi`)
+## Development
 
-```ts
-import { Configuration, AdminApi } from 'kb-cloud-client-typescript/adminapi';
+### Setup
 
-const api = new AdminApi.OrganizationApi(
-  new Configuration({ basePath: 'https://api.example.com' })
-);
+```bash
+git clone https://github.com/apecloud/kb-cloud-client-typescript.git
+cd kb-cloud-client-typescript
+yarn install
+
+# Clone the OpenAPI spec source (required for SDK generation)
+git clone --depth 1 https://github.com/apecloud/apecloud.git apecloud
 ```
 
-### Internal API (`internalapi`)
+To target a specific branch or tag:
 
-```ts
-import { Configuration, InternalApi } from 'kb-cloud-client-typescript/internalapi';
+```bash
+# Specific branch
+git clone --depth 1 --branch release-2.2 https://github.com/apecloud/apecloud.git apecloud
 
-const api = new InternalApi.SomeApi(
-  new Configuration({ basePath: 'https://api.example.com' })
-);
+# Specific tag
+git clone --depth 1 --branch v2.2.6 https://github.com/apecloud/apecloud.git apecloud
 ```
 
-## Available SDKs
+If already cloned, switch with:
+
+```bash
+cd apecloud
+git fetch --tags
+git checkout v2.2.6
+```
+
+### Generate SDK
+
+```bash
+yarn api:build    # Bundle specs + generate all three SDKs + tsc
+```
+
+### Publish
+
+```bash
+yarn publish      # Publish to npm
+```
 
-| Import Path | Description |
-|---|---|
-| `kb-cloud-client-typescript` | User Portal API |
-| `kb-cloud-client-typescript/adminapi` | Admin Portal API |
-| `kb-cloud-client-typescript/internalapi` | Internal API |
+## CI
 
-## API Documentation
+GitHub Actions workflow (`.github/workflows/generate-and-publish.yml`) auto-generates on push to main:
 
-Refer to the [KubeBlocks API documentation](https://docs.kubeblocks.io) for endpoint details.
+1. Clone `apecloud/apecloud` (default branch, overridable via `workflow_dispatch`)
+2. `redocly bundle` → `openapi-generator-cli` → `tsc`
+3. Publish to npm (requires `NPM_TOKEN` secret)

package/package.json

@@ -1,33 +1,19 @@
 {
   "name": "kb-cloud-client-typescript",
-  "version": "0.0.0-main.20260527.1703",
+  "version": "0.0.1",
   "description": "Auto-generated TypeScript SDK for KubeBlocks Cloud API",
   "private": false,
   "license": "Apache-2.0",
   "main": "dist/openapi/index.js",
   "types": "dist/openapi/index.d.ts",
-  "exports": {
-    "./adminapi": {
-      "types": "./dist/adminapi/index.d.ts",
-      "default": "./dist/adminapi/index.js"
-    },
-    "./internalapi": {
-      "types": "./dist/internalapi/index.d.ts",
-      "default": "./dist/internalapi/index.js"
-    },
-    "./openapi": {
-      "types": "./dist/openapi/index.d.ts",
-      "default": "./dist/openapi/index.js"
-    }
-  },
   "files": [
     "dist",
     "src/sdk"
   ],
   "scripts": {
-    "openapi:bundle": "redocly bundle apecloud/apiserver/api/openapi.yaml > ./src/sdk/openapi.yaml",
-    "adminapi:bundle": "redocly bundle apecloud/apiserver/api/adminapi.yaml > ./src/sdk/adminapi.yaml",
-    "internalapi:bundle": "redocly bundle apecloud/apiserver/api/internalapi.yaml > ./src/sdk/internalapi.yaml",
+    "openapi:bundle": "rm -rf ./src/sdk/openapi.yaml && redocly bundle apecloud/apiserver/api/openapi.yaml > ./src/sdk/openapi.yaml",
+    "adminapi:bundle": "rm -rf ./src/sdk/adminapi.yaml && redocly bundle apecloud/apiserver/api/adminapi.yaml > ./src/sdk/adminapi.yaml",
+    "internalapi:bundle": "rm -rf ./src/sdk/internalapi.yaml && redocly bundle apecloud/apiserver/api/internalapi.yaml > ./src/sdk/internalapi.yaml",
     "openapi:build": "yarn openapi:bundle && cp ./src/sdk/openapitools.json ./openapitools.json && rm -rf ./src/sdk/openapi && mkdir -p ./src/sdk/openapi && openapi-generator-cli generate",
     "adminapi:build": "yarn adminapi:bundle && cp ./src/sdk/adminapitools.json ./openapitools.json && rm -rf ./src/sdk/adminapi && mkdir -p ./src/sdk/adminapi && openapi-generator-cli generate",
     "internalapi:build": "yarn internalapi:bundle && cp ./src/sdk/internalapitools.json ./openapitools.json && rm -rf ./src/sdk/internalapi && mkdir -p ./src/sdk/internalapi && openapi-generator-cli generate",

package/src/sdk/adminapitools.json

@@ -3,7 +3,7 @@
   "spaces": 2,
   "generator-cli": {
     "version": "7.12.0",
-    "useDocker": false,
+    "useDocker": true,
     "generators": {
       "v3.0": {
         "generatorName": "typescript-axios",
@@ -25,4 +25,4 @@
       }
     }
   }
-}
+}

package/src/sdk/internalapitools.json

@@ -3,7 +3,7 @@
   "spaces": 2,
   "generator-cli": {
     "version": "7.12.0",
-    "useDocker": false,
+    "useDocker": true,
     "generators": {
       "v3.0": {
         "generatorName": "typescript-axios",
@@ -25,4 +25,4 @@
       }
     }
   }
-}
+}

package/src/sdk/openapitools.json

@@ -3,7 +3,7 @@
   "spaces": 2,
   "generator-cli": {
     "version": "7.12.0",
-    "useDocker": false,
+    "useDocker": true,
     "generators": {
       "v3.0": {
         "generatorName": "typescript-axios",
@@ -25,4 +25,4 @@
       }
     }
   }
-}
+}