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

package/lib/{src/types → types}/index.d.ts

@@ -87,6 +87,32 @@ export interface DataModelMethods<T> {
         data: T;
         filter: FilterParams<T>;
     }) => Promise<MethodResponse<UpdateResponse<T>>>;
+    /**
+     * 创建或者更新的方法
+     * @param {Object} params - 包含创建或者更新对象以及和筛选条件的参数对象。
+     * @returns {Promise<MethodResponse<UpsertResponse<T>>>} 包含更新响应的Promise对象。
+     * @example
+     * models.<model_name>.upsert({
+     *   update: {
+     *     // 更新的数据字段
+     *   },
+     *   create: {
+     *     // 创建的数据字段
+     *   },
+     *   filter: {
+     *     where: {
+     *       // 筛选条件
+     *     }
+     *   }
+     * }).then(({ data }) => {
+     *   console.log(data.count); // 输出更新的数据条数
+     * });
+     */
+    upsert: (params: {
+        update: T;
+        create: T;
+        filter: FilterParams<T>;
+    }) => Promise<MethodResponse<UpsertResponse<T>>>;
     /**
      * 更新多条数据的方法。
      * @param {Object} params - 包含更新数据和筛选条件的参数对象。
@@ -253,6 +279,20 @@ export declare type UpdateResponse<T> = {
      */
     count: number;
 };
+/**
+ * 创建或者更新的响应类型定义。
+ * @template T 模型字段的类型。
+ */
+export declare type UpsertResponse<T> = {
+    /**
+     * 变更的条数，返回非 0 值代表更新成功
+     */
+    count: number;
+    /**
+     *  变更的条数，返回非 "" 值代表创建成功
+     */
+    id: string;
+};
 /**
  * 删除操作的响应类型定义，用于表示删除操作影响的记录数量。
  * @template T 模型字段的类型。
@@ -563,6 +603,9 @@ export declare type CallFunction = (args: {
         dataSourceName: string;
         methodName: string;
         params: Record<string, any>;
+        'x-sdk-version'?: string;
+        userAgent?: string;
+        referrer?: string;
     };
 }) => Promise<any>;
 export {};

package/lib/utils.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 获取全局对象 window
+ *  小程序中可用, 但小程序中对象信息残缺, 无法访问 navigator 对象, ua 信息也无意义
+ */
+export declare function getGlobalObj(): false | typeof globalThis;
+/** 获取referrer 信息, 担心小程序中报错, 故catch */
+export declare function getReferrer(): any;
+/** 获取用户UA, 小程序中使用 getSystemInfo 替代 */
+export declare function getUserAgent(): any;
+export declare const VERSION: string | undefined;

package/lib/wxCloudClientSDK.cjs.js

@@ -93,6 +93,58 @@ var WxCloudSDKError = /** @class */ (function (_super) {
     return WxCloudSDKError;
 }(Error));
 
+/**
+ * 获取全局对象 window
+ *  小程序中可用, 但小程序中对象信息残缺, 无法访问 navigator 对象, ua 信息也无意义
+ */
+function getGlobalObj() {
+    // @ts-ignore
+    return (typeof window !== 'undefined' && window) || (typeof globalThis !== 'undefined' && globalThis);
+}
+/** 获取referrer 信息, 担心小程序中报错, 故catch */
+function getReferrer() {
+    try {
+        var globalObj = getGlobalObj();
+        if (!globalObj)
+            return;
+        // 浏览器中
+        // @ts-ignore
+        if (typeof wx === 'undefined') {
+            // @ts-ignore
+            return getGlobalObj().location.href;
+        }
+        // 当前页面路由
+        // @ts-ignore
+        return globalObj.__wxRoute;
+    }
+    catch (_a) { }
+}
+/** 获取用户UA, 小程序中使用 getSystemInfo 替代 */
+function getUserAgent() {
+    var globalObj = getGlobalObj();
+    // @ts-ignore
+    if (globalObj === null || globalObj === void 0 ? void 0 : globalObj.navigator)
+        return globalObj.navigator.userAgent;
+    // 微信小程序
+    // @ts-ignore
+    if (typeof wx !== 'undefined' && wx.getSystemInfo) {
+        var ua_1;
+        // 同步接口
+        // @ts-ignore
+        wx.getSystemInfo({
+            success: function (res) {
+                if (!res)
+                    return;
+                ua_1 = ['brand', 'model', 'version', 'system', 'platform', 'SDKVersion', 'language']
+                    .map(function (k) { return "".concat(k, ": ").concat(res[k]); })
+                    .join(', ');
+            }
+        });
+        return ua_1;
+    }
+}
+var VERSION = "1.0.0";
+
 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 () {
@@ -113,7 +165,10 @@ var callDataSource = function (_a) {
                             data: {
                                 dataSourceName: dataSourceName,
                                 methodName: methodName,
-                                params: params
+                                params: params,
+                                userAgent: getUserAgent(),
+                                referrer: getReferrer(),
+                                'x-sdk-version': VERSION
                             }
                         })];
                 case 2:
@@ -157,6 +212,9 @@ var CRUD_METHODS = {
     update: {
         methodName: 'wedaUpdateV2'
     },
+    upsert: {
+        methodName: 'wedaUpsertV2'
+    },
     updateMany: {
         methodName: 'wedaBatchUpdateV2'
     },

package/lib/wxCloudClientSDK.esm.js

@@ -91,6 +91,58 @@ var WxCloudSDKError = /** @class */ (function (_super) {
     return WxCloudSDKError;
 }(Error));
 
+/**
+ * 获取全局对象 window
+ *  小程序中可用, 但小程序中对象信息残缺, 无法访问 navigator 对象, ua 信息也无意义
+ */
+function getGlobalObj() {
+    // @ts-ignore
+    return (typeof window !== 'undefined' && window) || (typeof globalThis !== 'undefined' && globalThis);
+}
+/** 获取referrer 信息, 担心小程序中报错, 故catch */
+function getReferrer() {
+    try {
+        var globalObj = getGlobalObj();
+        if (!globalObj)
+            return;
+        // 浏览器中
+        // @ts-ignore
+        if (typeof wx === 'undefined') {
+            // @ts-ignore
+            return getGlobalObj().location.href;
+        }
+        // 当前页面路由
+        // @ts-ignore
+        return globalObj.__wxRoute;
+    }
+    catch (_a) { }
+}
+/** 获取用户UA, 小程序中使用 getSystemInfo 替代 */
+function getUserAgent() {
+    var globalObj = getGlobalObj();
+    // @ts-ignore
+    if (globalObj === null || globalObj === void 0 ? void 0 : globalObj.navigator)
+        return globalObj.navigator.userAgent;
+    // 微信小程序
+    // @ts-ignore
+    if (typeof wx !== 'undefined' && wx.getSystemInfo) {
+        var ua_1;
+        // 同步接口
+        // @ts-ignore
+        wx.getSystemInfo({
+            success: function (res) {
+                if (!res)
+                    return;
+                ua_1 = ['brand', 'model', 'version', 'system', 'platform', 'SDKVersion', 'language']
+                    .map(function (k) { return "".concat(k, ": ").concat(res[k]); })
+                    .join(', ');
+            }
+        });
+        return ua_1;
+    }
+}
+var VERSION = "1.0.0";
+
 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 () {
@@ -111,7 +163,10 @@ var callDataSource = function (_a) {
                             data: {
                                 dataSourceName: dataSourceName,
                                 methodName: methodName,
-                                params: params
+                                params: params,
+                                userAgent: getUserAgent(),
+                                referrer: getReferrer(),
+                                'x-sdk-version': VERSION
                             }
                         })];
                 case 2:
@@ -155,6 +210,9 @@ var CRUD_METHODS = {
     update: {
         methodName: 'wedaUpdateV2'
     },
+    upsert: {
+        methodName: 'wedaUpsertV2'
+    },
     updateMany: {
         methodName: 'wedaBatchUpdateV2'
     },

package/lib/wxCloudClientSDK.umd.js

@@ -97,6 +97,58 @@
         return WxCloudSDKError;
     }(Error));
 
+    /**
+     * 获取全局对象 window
+     *  小程序中可用, 但小程序中对象信息残缺, 无法访问 navigator 对象, ua 信息也无意义
+     */
+    function getGlobalObj() {
+        // @ts-ignore
+        return (typeof window !== 'undefined' && window) || (typeof globalThis !== 'undefined' && globalThis);
+    }
+    /** 获取referrer 信息, 担心小程序中报错, 故catch */
+    function getReferrer() {
+        try {
+            var globalObj = getGlobalObj();
+            if (!globalObj)
+                return;
+            // 浏览器中
+            // @ts-ignore
+            if (typeof wx === 'undefined') {
+                // @ts-ignore
+                return getGlobalObj().location.href;
+            }
+            // 当前页面路由
+            // @ts-ignore
+            return globalObj.__wxRoute;
+        }
+        catch (_a) { }
+    }
+    /** 获取用户UA, 小程序中使用 getSystemInfo 替代 */
+    function getUserAgent() {
+        var globalObj = getGlobalObj();
+        // @ts-ignore
+        if (globalObj === null || globalObj === void 0 ? void 0 : globalObj.navigator)
+            return globalObj.navigator.userAgent;
+        // 微信小程序
+        // @ts-ignore
+        if (typeof wx !== 'undefined' && wx.getSystemInfo) {
+            var ua_1;
+            // 同步接口
+            // @ts-ignore
+            wx.getSystemInfo({
+                success: function (res) {
+                    if (!res)
+                        return;
+                    ua_1 = ['brand', 'model', 'version', 'system', 'platform', 'SDKVersion', 'language']
+                        .map(function (k) { return "".concat(k, ": ").concat(res[k]); })
+                        .join(', ');
+                }
+            });
+            return ua_1;
+        }
+    }
+    var VERSION = "1.0.0";
+
     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 () {
@@ -117,7 +169,10 @@
                                 data: {
                                     dataSourceName: dataSourceName,
                                     methodName: methodName,
-                                    params: params
+                                    params: params,
+                                    userAgent: getUserAgent(),
+                                    referrer: getReferrer(),
+                                    'x-sdk-version': VERSION
                                 }
                             })];
                     case 2:
@@ -161,6 +216,9 @@
         update: {
             methodName: 'wedaUpdateV2'
         },
+        upsert: {
+            methodName: 'wedaUpsertV2'
+        },
         updateMany: {
             methodName: 'wedaBatchUpdateV2'
         },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudbase/wx-cloud-client-sdk",
-  "version": "1.0.0-alpha.2",
+  "version": "1.0.0",
   "description": "wx cloud client sdk",
   "main": "lib/wxCloudClientSDK.cjs.js",
   "module": "lib/wxCloudClientSDK.esm.js",
@@ -22,6 +22,7 @@
   "devDependencies": {
     "@rollup/plugin-commonjs": "^25.0.8",
     "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-replace": "^5.0.7",
     "@rollup/plugin-typescript": "^11.1.6",
     "parcel-bundler": "1.6.1",
     "rollup": "^4.18.0",

package/lib/demo/app.d.ts

@@ -1 +0,0 @@
-export {};