kb-cloud-client-typescript 2.2.11 → 2.2.13

package/README.md

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

package/dist/openapi/models/data-channel-module-progress.d.ts

@@ -21,6 +21,12 @@ export interface DataChannelModuleProgress {
      * @memberof DataChannelModuleProgress
      */
     'moduleName'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof DataChannelModuleProgress
+     */
+    'kubernetesName'?: string | null;
     /**
      *
      * @type {number}

package/dist/openapi/models/data-channel-module-progress.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"data-channel-module-progress.d.ts","sourceRoot":"","sources":["../../../src/sdk/openapi/models/data-channel-module-progress.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAIH;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACtC;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B"}
+{"version":3,"file":"data-channel-module-progress.d.ts","sourceRoot":"","sources":["../../../src/sdk/openapi/models/data-channel-module-progress.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAIH;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACtC;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B"}

package/package.json

@@ -1,12 +1,16 @@
 {
   "name": "kb-cloud-client-typescript",
-  "version": "2.2.11",
+  "version": "2.2.13",
   "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": {
+    "./openapi": {
+      "types": "./dist/openapi/index.d.ts",
+      "default": "./dist/openapi/index.js"
+    },
     "./adminapi": {
       "types": "./dist/adminapi/index.d.ts",
       "default": "./dist/adminapi/index.js"
@@ -15,10 +19,9 @@
       "types": "./dist/internalapi/index.d.ts",
       "default": "./dist/internalapi/index.js"
     },
-    "./openapi": {
-      "types": "./dist/openapi/index.d.ts",
-      "default": "./dist/openapi/index.js"
-    }
+    "./src/sdk/openapi.yaml": "./src/sdk/openapi.yaml",
+    "./src/sdk/adminapi.yaml": "./src/sdk/adminapi.yaml",
+    "./src/sdk/internalapi.yaml": "./src/sdk/internalapi.yaml"
   },
   "files": [
     "dist",

package/src/sdk/openapi/models/data-channel-module-progress.ts

@@ -26,6 +26,12 @@ export interface DataChannelModuleProgress {
      * @memberof DataChannelModuleProgress
      */
     'moduleName'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DataChannelModuleProgress
+     */
+    'kubernetesName'?: string | null;
     /**
      * 
      * @type {number}

package/src/sdk/openapi.yaml

@@ -25555,6 +25555,9 @@ components:
       properties:
         moduleName:
           type: string
+        kubernetesName:
+          type: string
+          nullable: true
         progress:
           type: number
           format: double