Big News: Socket raises $60M Series C at a $1B valuation to secure software supply chains for AI-driven development.Announcement
Sign In

@cloudbase/wx-cloud-client-sdk

Package Overview
Dependencies
Maintainers
15
Versions
27
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@cloudbase/wx-cloud-client-sdk - npm Package Compare versions

Comparing version
1.0.0
to
1.1.0
+9
README.md
# 微信云开发客户端 SDK
## 使用
[初始化 SDK](https://docs.cloudbase.net/model/init-sdk)
## 参考文档
[类型声明](https://docs.cloudbase.net/model/sdk-reference/globals)
+10
-2

@@ -1,2 +0,10 @@

import { MethodResponse, CallDataSourceParams } from '../types';
export declare const callDataSource: ({ dataSourceName, methodName, params, realMethodName, callFunction, }: CallDataSourceParams) => Promise<MethodResponse<any>>;
import { MethodResponse, CallDataSourceParams, RunMysqlCommandParams } from '../types';
export declare const enum EQUERY_PARAM_TYPE {
ARRAY = "ARRAY",
BOOLEAN = "BOOLEAN",
NUMBER = "NUMBER",
OBJECT = "OBJECT",
STRING = "STRING"
}
export declare const callDataSource: ({ dataSourceName, methodName, params, realMethodName, callFunction, mode, }: CallDataSourceParams) => Promise<MethodResponse<any>>;
export declare const runMysqlCommand: ({ sql, params, config, callFunction, unsafe }: RunMysqlCommandParams) => Promise<MethodResponse<any>>;

@@ -546,3 +546,44 @@ /**

export declare type Relation = string;
export interface SQLCommandParams {
/**
* 超时时间,默认是 5s,最大不超过 15s
*/
timeout?: number;
}
/**
* 运行原生SQL的ORM客户端接口
*/
export interface OrmRawQueryClient {
$runSQL?: (
/**
* sql 语句
*/
sql: string,
/**
* sql 模版变量
*/
params?: Record<string, any>,
/**
* 配置
*/
config?: SQLCommandParams) => Promise<MethodResponse<{
executeResultList: Record<string, any>[];
total: number;
backendExecute: string;
}>>;
$runSQLRaw?: (
/**
* sql 语句
*/
sql: string,
/**
* 配置
*/
config?: SQLCommandParams) => Promise<MethodResponse<{
executeResultList: Record<string, any>[];
total: number;
backendExecute: string;
}>>;
}
/**
* ORM客户端接口,包含不同模型名称到其操作方法的映射。

@@ -562,3 +603,3 @@ * @hidden

*/
dataSourceName: string;
dataSourceName?: string;
/**

@@ -580,4 +621,19 @@ * 方法名称,标识要调用的数据源中的具体方法。

callFunction: CallFunction;
/**
* @deprecated 使用 dataSourceName 替代。
*/
mode?: string;
}
/**
* 调用runMySQLCoommand 参数的结构定义,用于封装调用云函数时所需的参数。
* @hidden
*/
export interface RunMysqlCommandParams {
sql: string;
params?: Record<string, any>;
callFunction: CallFunction;
config?: any;
unsafe?: boolean;
}
/**
* 云函数调用接口,包含调用函数和认证信息。

@@ -595,3 +651,3 @@ * @hidden

export interface ExtendedCloudBaseInstance extends CloudBaseInstance {
models: OrmClient;
models: OrmClient & OrmRawQueryClient;
}

@@ -606,11 +662,4 @@ /**

name: string;
data: {
dataSourceName: string;
methodName: string;
params: Record<string, any>;
'x-sdk-version'?: string;
userAgent?: string;
referrer?: string;
};
data: Record<string, any>;
}) => Promise<any>;
export {};

@@ -146,8 +146,8 @@ 'use strict';

}
var VERSION = "1.0.0";
var VERSION = "1.1.0";
var callDataSource = function (_a) {
var dataSourceName = _a.dataSourceName, methodName = _a.methodName, params = _a.params, realMethodName = _a.realMethodName, callFunction = _a.callFunction;
var dataSourceName = _a.dataSourceName, methodName = _a.methodName, params = _a.params, realMethodName = _a.realMethodName, callFunction = _a.callFunction, mode = _a.mode;
return __awaiter(void 0, void 0, void 0, function () {
var result, response, error_1;
var result, response, requestId, error_1;
var _b, _c;

@@ -172,3 +172,7 @@ return __generator(this, function (_d) {

referrer: getReferrer(),
'x-sdk-version': VERSION
'x-sdk-version': VERSION,
/**
* todo 移除此字段
*/
mode: mode
}

@@ -178,11 +182,12 @@ })];

response = _d.sent();
requestId = ((_b = response === null || response === void 0 ? void 0 : response.result) === null || _b === void 0 ? void 0 : _b.requestId) || (response === null || response === void 0 ? void 0 : response.requestId) || (response === null || response === void 0 ? void 0 : response.requestID);
if (response === null || response === void 0 ? void 0 : response.result.code) {
throw new WxCloudSDKError("\u3010\u9519\u8BEF\u3011".concat(response === null || response === void 0 ? void 0 : response.result.message, "\n\u3010\u64CD\u4F5C\u3011\u8C03\u7528 ").concat(dataSourceName, ".").concat(realMethodName, "\n\u3010\u8BF7\u6C42ID\u3011").concat((response === null || response === void 0 ? void 0 : response.requestId) || 'N/A'), {
throw new WxCloudSDKError("\u3010\u9519\u8BEF\u3011".concat(response === null || response === void 0 ? void 0 : response.result.message, "\n\u3010\u64CD\u4F5C\u3011\u8C03\u7528 models.").concat(dataSourceName ? "".concat(dataSourceName, ".") : "").concat(realMethodName, "\n\u3010\u9519\u8BEF\u7801\u3011").concat(response === null || response === void 0 ? void 0 : response.result.code, "\n\u3010\u8BF7\u6C42ID\u3011").concat(requestId || 'N/A'), {
code: response === null || response === void 0 ? void 0 : response.result.code,
requestId: response === null || response === void 0 ? void 0 : response.requestId
requestId: requestId
});
}
else {
result.data = ((_b = response === null || response === void 0 ? void 0 : response.result) === null || _b === void 0 ? void 0 : _b.data) || {};
result.requestId = ((_c = response === null || response === void 0 ? void 0 : response.result) === null || _c === void 0 ? void 0 : _c.requestId) || '';
result.data = ((_c = response === null || response === void 0 ? void 0 : response.result) === null || _c === void 0 ? void 0 : _c.data) || {};
result.requestId = requestId;
}

@@ -197,3 +202,3 @@ return [3 /*break*/, 4];

console.log(error_1);
throw new WxCloudSDKError("\u3010\u9519\u8BEF\u3011".concat(error_1.message, "\n \u3010\u64CD\u4F5C\u3011\u8C03\u7528 ").concat(dataSourceName, ".").concat(realMethodName, "\n \u3010\u8BF7\u6C42ID\u3011N/A"), {
throw new WxCloudSDKError("\u3010\u9519\u8BEF\u3011".concat(error_1.message, "\n \u3010\u64CD\u4F5C\u3011\u8C03\u7528 models.").concat(dataSourceName ? "".concat(dataSourceName, ".") : "").concat(realMethodName, "\n \u3010\u8BF7\u6C42ID\u3011N/A"), {
code: 'UnknownError',

@@ -208,2 +213,59 @@ originError: error_1

};
var runMysqlCommand = function (_a) {
var sql = _a.sql, params = _a.params, config = _a.config, callFunction = _a.callFunction, _b = _a.unsafe, unsafe = _b === void 0 ? false : _b;
return __awaiter(void 0, void 0, void 0, function () {
return __generator(this, function (_c) {
return [2 /*return*/, callDataSource({
realMethodName: '$runSQL',
methodName: 'callWedaApi',
params: {
action: 'RunMysqlCommand',
data: {
sqlTemplate: sql,
config: config,
parameter: unsafe
? ''
: Object.entries(params || {}).reduce(function (list, _a) {
var key = _a[0], value = _a[1];
if (value !== undefined) {
var type = "OBJECT" /* EQUERY_PARAM_TYPE.OBJECT */;
var typeofValue = typeof value;
switch (typeofValue) {
case 'boolean': {
type = "BOOLEAN" /* EQUERY_PARAM_TYPE.BOOLEAN */;
break;
}
case 'number': {
type = "NUMBER" /* EQUERY_PARAM_TYPE.NUMBER */;
break;
}
case 'string': {
type = "STRING" /* EQUERY_PARAM_TYPE.STRING */;
break;
}
default: {
if (Array.isArray(value)) {
type = "ARRAY" /* EQUERY_PARAM_TYPE.ARRAY */;
}
else {
type = "OBJECT" /* EQUERY_PARAM_TYPE.OBJECT */;
}
}
}
list.push({
key: key,
type: type,
value: type === "STRING" /* EQUERY_PARAM_TYPE.STRING */ ? value : JSON.stringify(value)
});
}
return list;
}, []) || []
}
},
callFunction: callFunction,
mode: 'sdk'
})];
});
});
};

@@ -296,5 +358,46 @@ var CRUD_METHODS = {

var generateClient = function (callFunction) {
var rawQueryClient = {
$runSQL: function (sql, params, config) {
return __awaiter(this, void 0, void 0, function () {
var res;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, runMysqlCommand({
sql: sql,
params: params,
config: __assign(__assign({}, config), { preparedStatements: true }),
callFunction: callFunction
})];
case 1:
res = _a.sent();
return [2 /*return*/, res];
}
});
});
},
$runSQLRaw: function (sql, config) {
return __awaiter(this, void 0, void 0, function () {
var res;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, runMysqlCommand({
sql: sql,
params: [],
config: __assign(__assign({}, config), { preparedStatements: false }),
callFunction: callFunction
})];
case 1:
res = _a.sent();
return [2 /*return*/, res];
}
});
});
}
};
return new Proxy({}, {
get: function (target, prop) {
if (typeof prop === 'string') {
if (rawQueryClient.hasOwnProperty(prop)) {
return rawQueryClient[prop];
}
// 返回一个函数,这个函数接受任意参数并返回一个 Promise

@@ -301,0 +404,0 @@ return generateClientByDataSourceName(prop, callFunction);

@@ -144,8 +144,8 @@ /******************************************************************************

}
var VERSION = "1.0.0";
var VERSION = "1.1.0";
var callDataSource = function (_a) {
var dataSourceName = _a.dataSourceName, methodName = _a.methodName, params = _a.params, realMethodName = _a.realMethodName, callFunction = _a.callFunction;
var dataSourceName = _a.dataSourceName, methodName = _a.methodName, params = _a.params, realMethodName = _a.realMethodName, callFunction = _a.callFunction, mode = _a.mode;
return __awaiter(void 0, void 0, void 0, function () {
var result, response, error_1;
var result, response, requestId, error_1;
var _b, _c;

@@ -170,3 +170,7 @@ return __generator(this, function (_d) {

referrer: getReferrer(),
'x-sdk-version': VERSION
'x-sdk-version': VERSION,
/**
* todo 移除此字段
*/
mode: mode
}

@@ -176,11 +180,12 @@ })];

response = _d.sent();
requestId = ((_b = response === null || response === void 0 ? void 0 : response.result) === null || _b === void 0 ? void 0 : _b.requestId) || (response === null || response === void 0 ? void 0 : response.requestId) || (response === null || response === void 0 ? void 0 : response.requestID);
if (response === null || response === void 0 ? void 0 : response.result.code) {
throw new WxCloudSDKError("\u3010\u9519\u8BEF\u3011".concat(response === null || response === void 0 ? void 0 : response.result.message, "\n\u3010\u64CD\u4F5C\u3011\u8C03\u7528 ").concat(dataSourceName, ".").concat(realMethodName, "\n\u3010\u8BF7\u6C42ID\u3011").concat((response === null || response === void 0 ? void 0 : response.requestId) || 'N/A'), {
throw new WxCloudSDKError("\u3010\u9519\u8BEF\u3011".concat(response === null || response === void 0 ? void 0 : response.result.message, "\n\u3010\u64CD\u4F5C\u3011\u8C03\u7528 models.").concat(dataSourceName ? "".concat(dataSourceName, ".") : "").concat(realMethodName, "\n\u3010\u9519\u8BEF\u7801\u3011").concat(response === null || response === void 0 ? void 0 : response.result.code, "\n\u3010\u8BF7\u6C42ID\u3011").concat(requestId || 'N/A'), {
code: response === null || response === void 0 ? void 0 : response.result.code,
requestId: response === null || response === void 0 ? void 0 : response.requestId
requestId: requestId
});
}
else {
result.data = ((_b = response === null || response === void 0 ? void 0 : response.result) === null || _b === void 0 ? void 0 : _b.data) || {};
result.requestId = ((_c = response === null || response === void 0 ? void 0 : response.result) === null || _c === void 0 ? void 0 : _c.requestId) || '';
result.data = ((_c = response === null || response === void 0 ? void 0 : response.result) === null || _c === void 0 ? void 0 : _c.data) || {};
result.requestId = requestId;
}

@@ -195,3 +200,3 @@ return [3 /*break*/, 4];

console.log(error_1);
throw new WxCloudSDKError("\u3010\u9519\u8BEF\u3011".concat(error_1.message, "\n \u3010\u64CD\u4F5C\u3011\u8C03\u7528 ").concat(dataSourceName, ".").concat(realMethodName, "\n \u3010\u8BF7\u6C42ID\u3011N/A"), {
throw new WxCloudSDKError("\u3010\u9519\u8BEF\u3011".concat(error_1.message, "\n \u3010\u64CD\u4F5C\u3011\u8C03\u7528 models.").concat(dataSourceName ? "".concat(dataSourceName, ".") : "").concat(realMethodName, "\n \u3010\u8BF7\u6C42ID\u3011N/A"), {
code: 'UnknownError',

@@ -206,2 +211,59 @@ originError: error_1

};
var runMysqlCommand = function (_a) {
var sql = _a.sql, params = _a.params, config = _a.config, callFunction = _a.callFunction, _b = _a.unsafe, unsafe = _b === void 0 ? false : _b;
return __awaiter(void 0, void 0, void 0, function () {
return __generator(this, function (_c) {
return [2 /*return*/, callDataSource({
realMethodName: '$runSQL',
methodName: 'callWedaApi',
params: {
action: 'RunMysqlCommand',
data: {
sqlTemplate: sql,
config: config,
parameter: unsafe
? ''
: Object.entries(params || {}).reduce(function (list, _a) {
var key = _a[0], value = _a[1];
if (value !== undefined) {
var type = "OBJECT" /* EQUERY_PARAM_TYPE.OBJECT */;
var typeofValue = typeof value;
switch (typeofValue) {
case 'boolean': {
type = "BOOLEAN" /* EQUERY_PARAM_TYPE.BOOLEAN */;
break;
}
case 'number': {
type = "NUMBER" /* EQUERY_PARAM_TYPE.NUMBER */;
break;
}
case 'string': {
type = "STRING" /* EQUERY_PARAM_TYPE.STRING */;
break;
}
default: {
if (Array.isArray(value)) {
type = "ARRAY" /* EQUERY_PARAM_TYPE.ARRAY */;
}
else {
type = "OBJECT" /* EQUERY_PARAM_TYPE.OBJECT */;
}
}
}
list.push({
key: key,
type: type,
value: type === "STRING" /* EQUERY_PARAM_TYPE.STRING */ ? value : JSON.stringify(value)
});
}
return list;
}, []) || []
}
},
callFunction: callFunction,
mode: 'sdk'
})];
});
});
};

@@ -294,5 +356,46 @@ var CRUD_METHODS = {

var generateClient = function (callFunction) {
var rawQueryClient = {
$runSQL: function (sql, params, config) {
return __awaiter(this, void 0, void 0, function () {
var res;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, runMysqlCommand({
sql: sql,
params: params,
config: __assign(__assign({}, config), { preparedStatements: true }),
callFunction: callFunction
})];
case 1:
res = _a.sent();
return [2 /*return*/, res];
}
});
});
},
$runSQLRaw: function (sql, config) {
return __awaiter(this, void 0, void 0, function () {
var res;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, runMysqlCommand({
sql: sql,
params: [],
config: __assign(__assign({}, config), { preparedStatements: false }),
callFunction: callFunction
})];
case 1:
res = _a.sent();
return [2 /*return*/, res];
}
});
});
}
};
return new Proxy({}, {
get: function (target, prop) {
if (typeof prop === 'string') {
if (rawQueryClient.hasOwnProperty(prop)) {
return rawQueryClient[prop];
}
// 返回一个函数,这个函数接受任意参数并返回一个 Promise

@@ -299,0 +402,0 @@ return generateClientByDataSourceName(prop, callFunction);

@@ -150,8 +150,8 @@ (function (global, factory) {

}
var VERSION = "1.0.0";
var VERSION = "1.1.0";
var callDataSource = function (_a) {
var dataSourceName = _a.dataSourceName, methodName = _a.methodName, params = _a.params, realMethodName = _a.realMethodName, callFunction = _a.callFunction;
var dataSourceName = _a.dataSourceName, methodName = _a.methodName, params = _a.params, realMethodName = _a.realMethodName, callFunction = _a.callFunction, mode = _a.mode;
return __awaiter(void 0, void 0, void 0, function () {
var result, response, error_1;
var result, response, requestId, error_1;
var _b, _c;

@@ -176,3 +176,7 @@ return __generator(this, function (_d) {

referrer: getReferrer(),
'x-sdk-version': VERSION
'x-sdk-version': VERSION,
/**
* todo 移除此字段
*/
mode: mode
}

@@ -182,11 +186,12 @@ })];

response = _d.sent();
requestId = ((_b = response === null || response === void 0 ? void 0 : response.result) === null || _b === void 0 ? void 0 : _b.requestId) || (response === null || response === void 0 ? void 0 : response.requestId) || (response === null || response === void 0 ? void 0 : response.requestID);
if (response === null || response === void 0 ? void 0 : response.result.code) {
throw new WxCloudSDKError("\u3010\u9519\u8BEF\u3011".concat(response === null || response === void 0 ? void 0 : response.result.message, "\n\u3010\u64CD\u4F5C\u3011\u8C03\u7528 ").concat(dataSourceName, ".").concat(realMethodName, "\n\u3010\u8BF7\u6C42ID\u3011").concat((response === null || response === void 0 ? void 0 : response.requestId) || 'N/A'), {
throw new WxCloudSDKError("\u3010\u9519\u8BEF\u3011".concat(response === null || response === void 0 ? void 0 : response.result.message, "\n\u3010\u64CD\u4F5C\u3011\u8C03\u7528 models.").concat(dataSourceName ? "".concat(dataSourceName, ".") : "").concat(realMethodName, "\n\u3010\u9519\u8BEF\u7801\u3011").concat(response === null || response === void 0 ? void 0 : response.result.code, "\n\u3010\u8BF7\u6C42ID\u3011").concat(requestId || 'N/A'), {
code: response === null || response === void 0 ? void 0 : response.result.code,
requestId: response === null || response === void 0 ? void 0 : response.requestId
requestId: requestId
});
}
else {
result.data = ((_b = response === null || response === void 0 ? void 0 : response.result) === null || _b === void 0 ? void 0 : _b.data) || {};
result.requestId = ((_c = response === null || response === void 0 ? void 0 : response.result) === null || _c === void 0 ? void 0 : _c.requestId) || '';
result.data = ((_c = response === null || response === void 0 ? void 0 : response.result) === null || _c === void 0 ? void 0 : _c.data) || {};
result.requestId = requestId;
}

@@ -201,3 +206,3 @@ return [3 /*break*/, 4];

console.log(error_1);
throw new WxCloudSDKError("\u3010\u9519\u8BEF\u3011".concat(error_1.message, "\n \u3010\u64CD\u4F5C\u3011\u8C03\u7528 ").concat(dataSourceName, ".").concat(realMethodName, "\n \u3010\u8BF7\u6C42ID\u3011N/A"), {
throw new WxCloudSDKError("\u3010\u9519\u8BEF\u3011".concat(error_1.message, "\n \u3010\u64CD\u4F5C\u3011\u8C03\u7528 models.").concat(dataSourceName ? "".concat(dataSourceName, ".") : "").concat(realMethodName, "\n \u3010\u8BF7\u6C42ID\u3011N/A"), {
code: 'UnknownError',

@@ -212,2 +217,59 @@ originError: error_1

};
var runMysqlCommand = function (_a) {
var sql = _a.sql, params = _a.params, config = _a.config, callFunction = _a.callFunction, _b = _a.unsafe, unsafe = _b === void 0 ? false : _b;
return __awaiter(void 0, void 0, void 0, function () {
return __generator(this, function (_c) {
return [2 /*return*/, callDataSource({
realMethodName: '$runSQL',
methodName: 'callWedaApi',
params: {
action: 'RunMysqlCommand',
data: {
sqlTemplate: sql,
config: config,
parameter: unsafe
? ''
: Object.entries(params || {}).reduce(function (list, _a) {
var key = _a[0], value = _a[1];
if (value !== undefined) {
var type = "OBJECT" /* EQUERY_PARAM_TYPE.OBJECT */;
var typeofValue = typeof value;
switch (typeofValue) {
case 'boolean': {
type = "BOOLEAN" /* EQUERY_PARAM_TYPE.BOOLEAN */;
break;
}
case 'number': {
type = "NUMBER" /* EQUERY_PARAM_TYPE.NUMBER */;
break;
}
case 'string': {
type = "STRING" /* EQUERY_PARAM_TYPE.STRING */;
break;
}
default: {
if (Array.isArray(value)) {
type = "ARRAY" /* EQUERY_PARAM_TYPE.ARRAY */;
}
else {
type = "OBJECT" /* EQUERY_PARAM_TYPE.OBJECT */;
}
}
}
list.push({
key: key,
type: type,
value: type === "STRING" /* EQUERY_PARAM_TYPE.STRING */ ? value : JSON.stringify(value)
});
}
return list;
}, []) || []
}
},
callFunction: callFunction,
mode: 'sdk'
})];
});
});
};

@@ -300,5 +362,46 @@ var CRUD_METHODS = {

var generateClient = function (callFunction) {
var rawQueryClient = {
$runSQL: function (sql, params, config) {
return __awaiter(this, void 0, void 0, function () {
var res;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, runMysqlCommand({
sql: sql,
params: params,
config: __assign(__assign({}, config), { preparedStatements: true }),
callFunction: callFunction
})];
case 1:
res = _a.sent();
return [2 /*return*/, res];
}
});
});
},
$runSQLRaw: function (sql, config) {
return __awaiter(this, void 0, void 0, function () {
var res;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, runMysqlCommand({
sql: sql,
params: [],
config: __assign(__assign({}, config), { preparedStatements: false }),
callFunction: callFunction
})];
case 1:
res = _a.sent();
return [2 /*return*/, res];
}
});
});
}
};
return new Proxy({}, {
get: function (target, prop) {
if (typeof prop === 'string') {
if (rawQueryClient.hasOwnProperty(prop)) {
return rawQueryClient[prop];
}
// 返回一个函数,这个函数接受任意参数并返回一个 Promise

@@ -305,0 +408,0 @@ return generateClientByDataSourceName(prop, callFunction);

+7
-2
{
"name": "@cloudbase/wx-cloud-client-sdk",
"version": "1.0.0",
"version": "1.1.0",
"publishConfig": {
"access": "public"
},
"description": "wx cloud client sdk",

@@ -20,3 +23,4 @@ "main": "lib/wxCloudClientSDK.cjs.js",

"publish-demo": "tcb hosting deploy dist wx-cloud-client-sdk-demo -e lowcode-4gs26nnz095f6f4d",
"docs": "npx rimraf docs/* && typedoc --options typedoc.json"
"docs": "typedoc --options typedoc.json",
"deploy": "node ./scripts/deploy.mjs"
},

@@ -28,2 +32,3 @@ "devDependencies": {

"@rollup/plugin-typescript": "^11.1.6",
"@tcwd/dev-tools": "^1.0.1",
"parcel-bundler": "1.6.1",

@@ -30,0 +35,0 @@ "rollup": "^4.18.0",