@cloudbase/wx-cloud-client-sdk 1.0.0-alpha.0 → 1.0.0-alpha.2

package/lib/{wxCloudCLientSDK.umd.js → wxCloudClientSDK.umd.js}

@@ -18,8 +18,22 @@
     OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
     PERFORMANCE OF THIS SOFTWARE.
     ***************************************************************************** */
-    /* global Reflect, Promise, SuppressedError, Symbol */
+    /* global Reflect, Promise */
 
+    var extendStatics = function(d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+
+    function __extends(d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    }
 
     var __assign = function() {
         __assign = Object.assign || function __assign(t) {
@@ -38,7 +52,7 @@
             function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
             function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
             function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-            step((generator = generator.apply(thisArg, _arguments || [])).next());
+            step((generator = generator.apply(thisArg, [])).next());
         });
     }
 
@@ -48,7 +62,7 @@
         function verb(n) { return function (v) { return step([n, v]); }; }
         function step(op) {
             if (f) throw new TypeError("Generator is already executing.");
-            while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            while (_) try {
                 if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
                 if (y = 0, t) op = [op[0] & 2, t.value];
                 switch (op[0]) {
@@ -68,30 +82,38 @@
             } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
             if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
         }
-    }
-
-    typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
-        var e = new Error(message);
-        return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
-    };
+    }
+
+    var WxCloudSDKError = /** @class */ (function (_super) {
+        __extends(WxCloudSDKError, _super);
+        function WxCloudSDKError(message, extra) {
+            var _this = _super.call(this, message) || this;
+            _this.name = 'WxCloudSDKError';
+            _this.code = extra === null || extra === void 0 ? void 0 : extra.code;
+            _this.requestId = extra === null || extra === void 0 ? void 0 : extra.requestId;
+            _this.originError = extra === null || extra === void 0 ? void 0 : extra.originError;
+            return _this;
+        }
+        return WxCloudSDKError;
+    }(Error));
 
     var callDataSource = function (_a) {
         var dataSourceName = _a.dataSourceName, methodName = _a.methodName, params = _a.params, realMethodName = _a.realMethodName, callFunction = _a.callFunction;
         return __awaiter(void 0, void 0, void 0, function () {
             var result, response, error_1;
-            var _b;
-            return __generator(this, function (_c) {
-                switch (_c.label) {
+            var _b, _c;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
                     case 0:
                         result = {
                             data: {},
-                            error: null
+                            requestId: ''
                         };
-                        _c.label = 1;
+                        _d.label = 1;
                     case 1:
-                        _c.trys.push([1, 3, , 4]);
+                        _d.trys.push([1, 3, , 4]);
                         return [4 /*yield*/, callFunction({
-                                name: "lowcode-datasource-preview",
+                                name: 'lowcode-datasource',
                                 data: {
                                     dataSourceName: dataSourceName,
                                     methodName: methodName,
@@ -99,32 +121,31 @@
                                 }
                             })];
                     case 2:
-                        response = _c.sent();
+                        response = _d.sent();
                         if (response === null || response === void 0 ? void 0 : response.result.code) {
-                            result.error = {
+                            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'), {
                                 code: response === null || response === void 0 ? void 0 : response.result.code,
-                                message: "\u3010\u9519\u8BEF\u3011" + (response === null || response === void 0 ? void 0 : response.result.message) + " \n\u3010\u64CD\u4F5C\u3011\u8C03\u7528 " + dataSourceName + "." + realMethodName + "\n\u3010\u8BF7\u6C42ID\u3011" + (response === null || response === void 0 ? void 0 : response.requestId),
                                 requestId: response === null || response === void 0 ? void 0 : response.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) || '';
                         }
                         return [3 /*break*/, 4];
                     case 3:
-                        error_1 = _c.sent();
-                        console.error(error_1);
-                        result.error = {
-                            code: 'InternalError',
-                            message: error_1.message || 'Unknown error occurred',
-                            requestId: 'N/A'
-                        };
-                        return [3 /*break*/, 4];
-                    case 4:
-                        if (result.error) {
-                            console.error(result.error);
+                        error_1 = _d.sent();
+                        if (error_1.name === 'WxCloudSDKError') {
+                            throw error_1;
                         }
-                        return [2 /*return*/, result];
+                        else {
+                            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"), {
+                                code: 'UnknownError',
+                                originError: error_1
+                            });
+                        }
+                    case 4: return [2 /*return*/, result];
                 }
             });
         });
@@ -132,25 +153,25 @@
 
     var CRUD_METHODS = {
         create: {
-            methodName: "wedaCreateV2"
+            methodName: 'wedaCreateV2'
         },
         createMany: {
-            methodName: "wedaBatchCreateV2"
+            methodName: 'wedaBatchCreateV2'
         },
         update: {
-            methodName: "wedaUpdateV2"
+            methodName: 'wedaUpdateV2'
         },
         updateMany: {
-            methodName: "wedaBatchUpdateV2"
+            methodName: 'wedaBatchUpdateV2'
         },
         "delete": {
-            methodName: "wedaDeleteV2"
+            methodName: 'wedaDeleteV2'
         },
         deleteMany: {
-            methodName: "wedaBatchDeleteV2"
+            methodName: 'wedaBatchDeleteV2'
         },
         get: {
-            methodName: "wedaGetItemV2",
+            methodName: 'wedaGetItemV2',
             defaultParams: {
                 filter: {
                     where: {}
@@ -161,7 +182,7 @@
             }
         },
         list: {
-            methodName: "wedaGetRecordsV2",
+            methodName: 'wedaGetRecordsV2',
             defaultParams: {
                 filter: {
                     where: {}
@@ -177,18 +198,13 @@
             get: function (target, methodName) {
                 var operation = CRUD_METHODS[methodName];
                 if (!operation) {
-                    var error = new Error("\u4E0D\u652F\u6301\u7684\u64CD\u4F5C: " + methodName);
-                    console.error(error);
-                    return {
-                        data: {},
-                        error: {
-                            code: "InternalError",
-                            message: error.message || "Unknown error occurred",
-                            requestId: "N/A"
-                        }
-                    };
+                    var error = new Error("\u4E0D\u652F\u6301\u7684\u64CD\u4F5C: ".concat(methodName));
+                    throw new WxCloudSDKError(error.message || 'Unknown error occurred', {
+                        originError: error,
+                        code: 'NotSupported',
+                        requestId: 'N/A'
+                    });
                 }
-                console.group("[" + dataSourceName + "." + methodName + "]");
                 return function (params) { return __awaiter(void 0, void 0, void 0, function () {
                     var effectiveParams, rawData, result, dataKey;
                     var _a;
@@ -196,13 +212,6 @@
                         switch (_b.label) {
                             case 0:
                                 effectiveParams = __assign(__assign({}, (operation.defaultParams || {})), (params || {}));
-                                console.log(params);
-                                console.log({
-                                    dataSourceName: dataSourceName,
-                                    methodName: operation.methodName,
-                                    realMethodName: methodName,
-                                    params: effectiveParams
-                                });
                                 return [4 /*yield*/, callDataSource({
                                         callFunction: callFunction,
                                         dataSourceName: dataSourceName,
@@ -212,16 +221,9 @@
                                     })];
                             case 1:
                                 rawData = _b.sent();
-                                result = { error: null, data: {} };
-                                if (!rawData.error) {
-                                    dataKey = operation.responseKey;
-                                    result.data = dataKey ? (_a = rawData === null || rawData === void 0 ? void 0 : rawData.data) === null || _a === void 0 ? void 0 : _a[dataKey] : rawData === null || rawData === void 0 ? void 0 : rawData.data;
-                                }
-                                else {
-                                    result.error = rawData.error;
-                                }
-                                console.log(result);
-                                console.groupEnd();
+                                result = { data: {} };
+                                dataKey = operation.responseKey;
+                                result.data = dataKey ? (_a = rawData === null || rawData === void 0 ? void 0 : rawData.data) === null || _a === void 0 ? void 0 : _a[dataKey] : rawData === null || rawData === void 0 ? void 0 : rawData.data;
                                 return [2 /*return*/, result];
                         }
                     });
@@ -234,7 +236,7 @@
     var generateClient = function (callFunction) {
         return new Proxy({}, {
             get: function (target, prop) {
-                if (typeof prop === "string") {
+                if (typeof prop === 'string') {
                     // 返回一个函数，这个函数接受任意参数并返回一个 Promise
                     return generateClientByDataSourceName(prop, callFunction);
                 }
@@ -244,10 +246,10 @@
 
     function init(cloud) {
         if (!cloud) {
-            throw new Error("cloud is required");
+            throw new Error('cloud is required');
         }
         if (!cloud.callFunction) {
-            throw new Error("cloud.callFunction is required");
+            throw new Error('cloud.callFunction is required');
         }
         var OrmClientImpl = generateClient(cloud.callFunction.bind(cloud));
         cloud.models = OrmClientImpl;

package/package.json

@@ -1,21 +1,23 @@
 {
   "name": "@cloudbase/wx-cloud-client-sdk",
-  "version": "1.0.0-alpha.0",
+  "version": "1.0.0-alpha.2",
   "description": "wx cloud client sdk",
-  "main": "lib/wxCloudCLientSDK.cjs.js",
-  "module": "lib/wxCloudCLientSDK.esm.js",
-  "browser": "lib/wxCloudCLientSDK.umd.js",
-  "types": "lib/types/index.d.ts",
+  "main": "lib/wxCloudClientSDK.cjs.js",
+  "module": "lib/wxCloudClientSDK.esm.js",
+  "browser": "lib/wxCloudClientSDK.umd.js",
+  "types": "lib/index.d.ts",
   "files": [
     "lib"
   ],
   "scripts": {
     "clean": "npx rimraf lib/*",
     "build": "npm run clean && rollup -c",
-    "start-demo": "parcel demo/index.html",
+    "develop": "parcel demo/index.html",
+    "sync-dts": "cd demo && tcb model sync-dts --envId=lowcode-4gs26nnz095f6f4d",
     "build-demo": "npx rimraf dist/* && parcel build demo/index.html --public-url ./",
     "publish": "npm publish --access public",
-    "publish-demo": "tcb hosting deploy dist wx-cloud-client-sdk-demo -e lowcode-4gs26nnz095f6f4d"
+    "publish-demo": "tcb hosting deploy dist wx-cloud-client-sdk-demo -e lowcode-4gs26nnz095f6f4d",
+    "docs": "npx rimraf docs/* && typedoc --options typedoc.json"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "^25.0.8",
@@ -23,6 +25,8 @@
     "@rollup/plugin-typescript": "^11.1.6",
     "parcel-bundler": "1.6.1",
     "rollup": "^4.18.0",
+    "typedoc": "^0.25.13",
+    "typedoc-plugin-markdown": "^4.0.3",
     "typescript": "4.4.4"
   },
   "resolutions": {
@@ -32,4 +36,4 @@
     "typescript",
     "javascript"
   ]
-}
+}

package/lib/index.d.ts

@@ -1,3 +0,0 @@
-import { CloudBaseInstance, ExtendedCloudBaseInstance } from "./types";
-export declare function init(cloud: CloudBaseInstance): ExtendedCloudBaseInstance;
-export * from "./types";

package/lib/types/index.d.ts

@@ -1,130 +0,0 @@
-export declare type DataModelFields<T> = {
-    [key: string]: T;
-};
-export declare type MethodResponse<T> = {
-    data: T;
-    error?: null | {
-        code: string;
-        message: string;
-        requestId: string;
-    };
-};
-export declare type CloudBaseInstance = {
-    callFunction: CallFunction;
-    auth: any;
-};
-export interface ExtendedCloudBaseInstance extends CloudBaseInstance {
-    models: OrmClient;
-}
-export declare type CallFunction = (args: {
-    name: string;
-    data: {
-        dataSourceName: string;
-        methodName: string;
-        params: Record<string, any>;
-    };
-}) => Promise<any>;
-export interface CallDataSourceParams {
-    dataSourceName: string;
-    methodName: string;
-    params: Record<string, any>;
-    realMethodName: string;
-    callFunction: CallFunction;
-}
-export declare type CreateResponse<T> = {
-    id: string;
-};
-export declare type CreateManyResponse<T> = {
-    idList: string[];
-};
-export declare type UpdateResponse<T> = {
-    count: number;
-};
-export declare type DeleteResponse<T> = UpdateResponse<T>;
-export declare type GetResponse<T> = MethodResponse<T>;
-export declare type ListResponse<T> = MethodResponse<{
-    records: T[];
-    total?: number;
-}>;
-export declare type OrderByParams = {
-    [key: string]: 'asc' | 'desc';
-};
-export declare type SelectParams<T> = {
-    [key in keyof T]?: boolean;
-};
-export declare type BasicComparisonOperator = '$eq' | '$neq' | '$gt' | '$gte' | '$lt' | '$lte' | '$in' | '$nin';
-export declare type SpecialComparisonOperator = '$search' | '$nsearch' | '$empty' | '$nempty' | '$eq-current-user' | '$ne-current-user';
-export declare type ComparisonOperator = BasicComparisonOperator | SpecialComparisonOperator;
-export declare type FilterCondition = {
-    [key in ComparisonOperator]?: any;
-};
-export declare type FilterConditionItem<T> = {
-    [key in keyof T]?: FilterCondition;
-};
-export declare type LogicalOperator = '$and' | '$or';
-export declare type FilterObject<T> = {
-    [operator in LogicalOperator]?: FilterConditionItem<T>[] | FilterObject<T>;
-};
-export declare type FilterParams<T> = {
-    where?: FilterObject<T>;
-};
-export declare type ListParams<T> = {
-    filter?: FilterParams<T>;
-    select?: SelectParams<T>;
-    getCount?: boolean;
-    pageSize?: number;
-    pageNumber?: number;
-    orderBy?: OrderByParams[];
-    relateWhere?: any;
-};
-export declare type Relation = string;
-export interface Fields {
-    _id?: string;
-    createdAt?: Date;
-    updatedAt?: Date;
-    owner?: Relation;
-    createBy?: Relation;
-    updateBy?: Relation;
-    _departmentList?: Relation[];
-    _openid?: string;
-}
-export interface DataModelMethods<T> {
-    create: (params: {
-        data: T;
-    }) => Promise<MethodResponse<CreateResponse<T>>>;
-    createMany: (params: {
-        data: T[];
-    }) => Promise<MethodResponse<CreateManyResponse<T>>>;
-    update: (params: {
-        data: T;
-        filter: FilterParams<T>;
-    }) => Promise<MethodResponse<UpdateResponse<T>>>;
-    updateMany: (params: {
-        data: T;
-        filter: FilterParams<T>;
-    }) => Promise<MethodResponse<UpdateResponse<T>>>;
-    delete: (params: {
-        filter: FilterParams<T>;
-    }) => Promise<MethodResponse<DeleteResponse<T>>>;
-    deleteMany: (params: {
-        filter: FilterParams<T>;
-    }) => Promise<MethodResponse<DeleteResponse<T>>>;
-    get: (params: {
-        filter: FilterParams<T>;
-        select?: SelectParams<T>;
-    }) => Promise<MethodResponse<T>>;
-    list: (params: {
-        filter?: FilterParams<T>;
-        select?: SelectParams<T>;
-        getCount?: boolean;
-        pageSize?: number;
-        pageNumber?: number;
-        orderBy?: OrderByParams[];
-    }) => Promise<MethodResponse<{
-        records: T[];
-        total?: number;
-    }>>;
-}
-export interface OrmClient {
-    [modelName: string]: DataModelMethods<any>;
-}