node-cnb 1.2.8 → 1.2.10

package/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2024-present, cnb.cool
+
+Permission is hereby granted, free of charge, to any person obtaining 
+a copy of this software and associated documentation files (the “Software”), 
+to deal in the Software without restriction, including without limitation 
+the rights to use, copy, modify, merge, publish, distribute, sublicense, 
+and/or sell copies of the Software, and to permit persons to whom 
+the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be 
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS 
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 
+THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,3 +1,8 @@
+# 介绍
+
+![badge](https://cnb.cool/cnb/sdk/node-cnb/-/badge/git/1876ef5f/ci/pipeline-as-code)
+![badge](https://cnb.cool/cnb/sdk/node-cnb/-/badge/git/1876ef5f/ci/status/tag_push)
+
 node-cnb 是一个用于访问 [CNB API](https://api.cnb.cool/) 的 node 编写的 SDK。
 
 # 安装

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-cnb",
-  "version": "1.2.8",
+  "version": "1.2.10",
   "description": "node sdk for cnb open api",
   "main": "dist/index.js",
   "typings": "./src/index.d.ts",

package/.cnb.yml

@@ -1,31 +0,0 @@
-.install: &install
-  - name: build cache image
-    type: docker:cache
-    options:
-      dockerfile: cache.dockerfile
-      by:
-        - package.json
-        - package-lock.json
-    exports:
-      name: DOCKER_CACHE_IMAGE_NAME
-  - name: copy node_modules
-    image: $DOCKER_CACHE_IMAGE_NAME
-    commands:
-      - cp -r "$NODE_PATH" ./node_modules
-  - name: build
-    image: $DOCKER_CACHE_IMAGE_NAME
-    script: npm run build
-$:
-  tag_push:
-    - stages:
-        - *install
-        - name: npm publish
-          image: tencentcom/npm
-          imports: https://cnb.cool/folger/folger-secret/-/blob/main/npm_secret.yml
-          settings:
-            username: $NPM_USER
-            token: $NPM_TOKEN
-            email: $NPM_EMAIL
-            folder: ./
-            fail_on_version_conflict: true
-

package/.ide/Dockerfile

@@ -1,20 +0,0 @@
-# .ide/Dockerfile
-FROM node:20
-
-# 以及按需安装其他软件
-RUN apt-get update && apt-get install -y git
-
-# 安装 code-server 和 vscode 常用插件
-RUN curl -fsSL https://code-server.dev/install.sh | sh \
-  && code-server --install-extension redhat.vscode-yaml \
-  && code-server --install-extension dbaeumer.vscode-eslint \
-  && code-server --install-extension eamodio.gitlens \
-  && code-server --install-extension tencent-cloud.coding-copilot \
-  && echo done
-
-# 安装 ssh 服务，用于支持 VSCode 客户端通过 Remote-SSH 访问开发环境
-RUN apt-get update && apt-get install -y wget unzip openssh-server
-
-# 指定字符集支持命令行输入中文（根据需要选择字符集）
-ENV LANG C.UTF-8
-ENV LANGUAGE C.UTF-8

package/CHANGELOG.md

@@ -1,68 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
-
-### [1.2.8](https://cnb.cool/cnb/sdk/node-cnb/compare/v1.2.7...v1.2.8) (2025-02-12)
-
-
-### Bug Fixes
-
-* 更正ci配置 ([e4ee23d](https://cnb.cool/cnb/sdk/node-cnb/commit/e4ee23d2eb5459cda2582974d921943d17fcbcef))
-
-### [1.2.7](https://cnb.cool/cnb/sdk/node-cnb/compare/v1.2.6...v1.2.7) (2025-02-12)
-
-
-### Bug Fixes
-
-* npm publish换用token ([debb51a](https://cnb.cool/cnb/sdk/node-cnb/commit/debb51ae93b6e8d1384e4f4519c745aac0507847))
-
-### [1.2.6](https://cnb.cool/cnb/sdk/node-cnb/compare/v1.2.5...v1.2.6) (2025-02-12)
-
-
-### Bug Fixes
-
-* 更换npm插件修复npm发布报错 ([82ebce5](https://cnb.cool/cnb/sdk/node-cnb/commit/82ebce59059d40c3f941954c0437fc071362d7bb))
-
-### [1.2.5](https://cnb.cool/cnb/sdk/node-cnb/compare/v1.2.4...v1.2.5) (2025-02-12)
-
-
-### Bug Fixes
-
-* 修复构建报错 ([240069a](https://cnb.cool/cnb/sdk/node-cnb/commit/240069afb3eb18e49d231f80470e813fdc856dbc))
-
-### [1.2.4](https://cnb.cool/cnb/sdk/node-cnb/compare/v1.2.3...v1.2.4) (2025-02-12)
-
-
-### Bug Fixes
-
-* 更正流水线报错 ([80500ac](https://cnb.cool/cnb/sdk/node-cnb/commit/80500acf043a91366209bd0261df20ba60a28765))
-
-### [1.2.3](https://cnb.cool/cnb/sdk/node-cnb/compare/v1.2.2...v1.2.3) (2025-02-12)
-
-
-### Bug Fixes
-
-* 修复流水线报错 ([26f01b2](https://cnb.cool/cnb/sdk/node-cnb/commit/26f01b2e33a1a9cad2e54406aed28e4859546c8f))
-
-### [1.2.2](https://cnb.cool/cnb/sdk/node-cnb/compare/v1.2.1...v1.2.2) (2025-02-12)
-
-
-### Bug Fixes
-
-* 更正缓存镜像的node版本 ([5384a07](https://cnb.cool/cnb/sdk/node-cnb/commit/5384a070c4c1552566bec5c2d0433c750a4bcc4b))
-
-### [1.2.1](https://cnb.cool/cnb/sdk/node-cnb/compare/v1.2.0...v1.2.1) (2025-02-12)
-
-## 1.2.0 (2025-02-12)
-
-
-### Features
-
-* 编写文档以及修复post参数不生效问题 ([d65cc4f](https://cnb.cool/cnb/sdk/node-cnb/commit/d65cc4f51e1068c9e6b190df3328a1021342bf63))
-* 初步完成代码编译 ([be40568](https://cnb.cool/cnb/sdk/node-cnb/commit/be40568efb7a2debefeef0e036acd7fc05082797))
-* 初始提交 ([f3e6333](https://cnb.cool/cnb/sdk/node-cnb/commit/f3e6333e488417bb66dfa342ff57ca727e5f12f1))
-* 生成类型声明和ts代码初稿 ([1ff64fd](https://cnb.cool/cnb/sdk/node-cnb/commit/1ff64fd4efc9971bcece7a42c8f021f405e57671))
-
-# Changelog
-
-All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

package/build.js

@@ -1,156 +0,0 @@
-const fs = require('fs');
-const cp = require('child_process');
-const _ = require('lodash');
-const apiSwagger = require('./openapi_swagger.json');
-const { definitions } = apiSwagger;
-const pathMethodNameMap = require('./pathMethodMap.json');
-
-/**
- * 实现原理
- *
- * cnb 会编译出 open api 的 [swagger json](https://api.cnb.cool/swagger.json)，并生成 api 页面。
- *
- * 本仓库依据 swagger json 编译生成对应的 typescript 代码。
- */
-
-const pathMethodsMap = {}
-
-const buildPathMethods = () => {
-    Object.keys(apiSwagger.paths).forEach(path => {
-        const pathValue = apiSwagger.paths[path];
-        Object.keys(pathValue).forEach(method => {
-            const methodValue = pathValue[method];
-            methodValue.path = path;
-            methodValue.method = method;
-
-            const pathMethod = method === 'get' && methodValue.responses['200']?.schema?.type === 'array' ? 'list' : method;
-            const methodPath = pathMethodNameMap[path] ? pathMethodNameMap[path] : [...path.replace(/\/\{([^\}]+)\}\/-\//g, '/$1/').replace(/\/\{[^\}]+\}/g, '/').split('/').map(item => _.camelCase(item)).filter(Boolean), pathMethod].join('.');
-            const methodValues = pathMethodsMap[methodPath] || []
-            methodValues.push(methodValue)
-            pathMethodsMap[methodPath] = methodValues;
-            if (methodValues.length > 1) {
-                console.log('重复的path', methodPath, methodValues.map(item => item.path))
-            }
-        })
-    })
-
-    fs.writeFileSync('./src/paths.json', JSON.stringify(pathMethodsMap, null, 2));
-}
-
-const convertTypeName = (type) => {
-    let typeName = _.camelCase(type.split('.').join('-'));
-    typeName = typeName.charAt(0).toUpperCase() + typeName.slice(1);
-    return typeName;
-}
-
-const typeMap = {
-    'integer': 'number',
-}
-
-function convertSchemaToType(schema) {
-    if (schema.type === 'object') {
-        let properties = '';
-        if (!schema.properties) {
-            return 'any'
-        }
-        for (const [key, value] of Object.entries(schema.properties)) {
-            const typeName = key.includes('-') ? `'${key}'` : key;
-            if (typeName !== key) {
-                console.log('typeName', key, typeName)
-            }
-
-            if (value.description) {
-                properties += `\n  /**${value.description}*/\n`
-            }
-            properties += `  ${typeName}: ${convertSchemaToType(value)};\n`;
-        }
-
-        return `{\n${properties}}`;
-    } else if (schema.type === 'array') {
-        return `${convertSchemaToType(schema.items)}[]`;
-    } else if (schema['$ref']) {
-        return convertTypeName(schema['$ref'].replace('#/definitions/', ''))
-    } else {
-        return typeMap[schema.type] || schema.type || 'any';
-    }
-}
-
-const buildDefinitions = () => {
-    function convertDefinitionsToTypes(definitions) {
-        let types = '';
-
-        for (const [key, value] of Object.entries(definitions)) {
-
-            const convetValue = convertSchemaToType(value);
-            if (!convetValue) {
-                continue;
-            }
-            types += `export type ${convertTypeName(key)} = ${convetValue};\n\n`;
-        }
-
-        return types;
-    }
-
-    // 提取 definitions 并转换为类型声明
-    const types = convertDefinitionsToTypes(definitions);
-
-    // 将类型声明写入 TypeScript 文件
-    fs.writeFileSync('./src/types.d.ts', types, 'utf8');
-}
-const importTypes = [];
-const buildClientInterface = () => {
-    const pathTree = {};
-    Object.keys(pathMethodsMap).forEach(methodPath => {
-        let currentSub = pathTree;
-        const methodList = methodPath.split('.');
-        methodList.forEach((method) => {
-            currentSub[method] = currentSub[method] || {};
-            currentSub = currentSub[method];
-        })
-    });
-
-    const getMethodContent = (tree, path) => {
-        let content = '';
-        Object.keys(tree).forEach(method => {
-            content += `
-${_.camelCase(method)}: ${getMethodContent(tree[method], [path, method].filter(Boolean).join('.'))}
-            `;
-        })
-        if (!content) {
-            const methodValue = pathMethodsMap[path]?.[0] || {};
-            const resultType = convertSchemaToType(methodValue.responses?.['200']?.schema || {});
-            importTypes.push(resultType.replace('[]', ''))
-
-            content = `(params: {${(methodValue.parameters || []).map(param => {
-
-                return param.name + (param.required ? '' : '?') + ': ' + convertSchemaToType(param)
-            })}}) => Promise<${resultType}>`
-        } else {
-            content = `{
-                ${content}
-            }`
-        }
-        return content;
-    }
-
-    let interfaceContent = `
-export interface Client ${getMethodContent(pathTree, '')}
-    `;
-    const distinctImportTypes = _.uniq(importTypes.filter(item => !/^[a-z]+$/.test(item))).join(', ');
-    interfaceContent = `import {${distinctImportTypes}} from './types';
-${interfaceContent}`
-    fs.writeFileSync('./src/client.d.ts', interfaceContent, 'utf8');
-
-}
-
-const prettier = () => {
-    cp.execSync('npx prettier --write ./src/*.ts');
-}
-
-buildPathMethods();
-
-buildDefinitions();
-
-buildClientInterface();
-
-prettier();

package/cache.dockerfile

@@ -1,14 +0,0 @@
-# 选择一个 Base 镜像
-FROM node:20
-
-# 设置工作目录
-WORKDIR /space
-
-# 将 by 中的文件列表 COPY 过来
-COPY . .
-
-# 根据 COPY 过来的文件进行依赖的安装
-RUN npm install
-
-# 设置好需要的环境变量
-ENV NODE_PATH=/space/node_modules