igsdk 1.1.1 → 1.1.2

package/README.md

@@ -0,0 +1,423 @@
+# iGlees SDK文档
+
+
+
+## SDK简介
+
+iGlees SDK为Cocos开发者提供了广告、网络请求、加解密、缓存数据等功能。
+
+
+
+## SDK集成
+
+#### 说明
+
+iGlees SDK的所有功能均放在IG命名空间，然后根据具体的功能模块进行调用。比如IG.IGSdk，IG.HttpWrapper等。
+
+
+
+#### 初始化SDK
+
+在使用iGlees SDK前，请务必先调用初始化方法完成SDK的初始，具体如下：
+
+```typescript
+/**
+* 初始化（注：使用SDK功能前调用，只需要调用一次，建议进入首个场景就调用）
+* @param sys 当前系统对象 （CocosCreator<3.0时传cc.sys，CocosCreator>=3.0时传sys）
+* @param reflection 反射对象（打包原生平台时需要设置，CocosCreator<=3.5时传jsb.reflection， CocosCreator>=3.6时传native.reflection）
+* @param logLevel 日志等级（线上环境设置为LOG_ERROR或OFF）
+* @param 是否初始化成功
+*/
+static init(sys: any, reflection?: any, logLevel?: LOG_LEVEL): boolean;
+
+//初始化SDK
+IG.IGSdk.init(sys, sys.isNative ? jsb.reflection : null, IG.LOG_LEVEL.DEBUG);
+```
+
+
+
+#### 广告模块
+
+###### 初始化广告SDK
+
+在使用广告模块时，需先初始化广告SDK，具体如下：
+
+```typescript
+/**
+* 初始化广告SDK
+* @param initOpt 初始化可配置参数
+* @param callback 初始化回调
+*/
+static init(initOpt: ASWInitOpt, callback?: ASWInitCallback): void;
+        
+//初始化广告SDK
+let initOpt = new IG.ASWInitOpt();
+initOpt.mediaIdWeb = '11';
+initOpt.mediaIdAndroid = '9';
+initOpt.mediaIdIOS = '10';
+initOpt.mediaId = '11';
+initOpt.channel = "";
+initOpt.customData = "";
+initOpt.showLog = true;
+initOpt.test = true;
+IG.AdSdkWrapper.init(initOpt, (code, msg) => {
+    console.log(`Init sdk : code=${code} , msg=${msg}`);
+});
+```
+
+其中，初始化可配参数ASWInitOpt定义如下：
+
+```typescript
+/**
+ * 初始化参数
+ */
+export class ASWInitOpt extends InitOpt {
+    //Web端媒体id
+    public mediaIdWeb: string;
+    //Android端媒体id
+    public mediaIdAndroid: string;
+    //iOS端媒体id
+    public mediaIdIOS: string;
+    //鸿蒙端媒体id
+    public mediaIdOpenHarmony: string;
+}
+
+/**
+ * 初始化可配置参数
+ */
+export class InitOpt {
+    //媒体标识（必传）
+    public mediaId: string = "";
+    //自定义渠道标识。广告数据可以根据自定义渠道进行拆分
+    public channel: string = "";
+    //自定义数据，最长255字符。激励视频服务端验证时，该数据会回调给服务器
+    public customData: string = ""
+    // 是否显示日志，默认不显示。线上环境应设置成false
+    public showLog: boolean = false;
+    //是否打开测试模式。正式上线前请设置为false，否则将不产生收益
+    public test: boolean = false;
+}
+```
+
+
+
+###### 请求广告
+
+```typescript
+/**
+* 请求广告
+* @param adOpt 请求广告可配置参数
+* @param callback 请求广告回调
+*/
+static requestAd(adOpt: ASWAdOpt, callback?: ASWAdCallback): void;
+
+//请求广告
+let adOpt = new IG.ASWAdOpt();
+adOpt.adIdWeb = '3';
+adOpt.adIdWechatGame = 'adunit-6c232b47c4cc6f9b';
+adOpt.adIdAndroid = '37';
+adOpt.adType = IG.AD_TYPE.REWARD_VIDEO;
+IG.AdSdkWrapper.requestAd(adOpt, {
+    onAdReward(adId) {
+        console.log(`ad[${adId}] reward.`);
+    },
+});
+```
+
+其中，请求广告可配置参数ASWAdOpt定义如下：
+
+```typescript
+/**
+ * 请求广告参数
+ */
+export class ASWAdOpt {
+    //广告类型（小游戏使用）
+    public adType: AD_TYPE;
+    //Web端广告位id
+    public adIdWeb: string;
+    //Android端广告位id
+    public adIdAndroid: string;
+    //iOS端广告位id
+    public adIdIOS: string;
+    //鸿蒙端广告位id
+    public adIdOpenHarmony: string;
+    //微信小游戏端广告位id
+    public adIdWechatGame: string;
+    //抖音小游戏端广告位id
+    public adIdDouYinGame: string;
+}
+```
+
+其中，请求广告回调ASWAdCallback定义如下：
+
+```typescript
+/**
+ * 请求广告回调接口
+ */
+export interface ASWAdCallback {
+    /**
+     * 加载广告成功回调
+     * @param adId 广告位id
+     */
+    onAdLoad?(adId: string): void;
+
+    /**
+     * 广告曝光回调
+     * @param adId 广告位id
+     */
+    onAdShow?(adId: string): void;
+
+    /**
+     * 广告点击回调（Web平台不一定回调）
+     * @param adId 广告位id
+     */
+    onAdClick?(adId: string): void;
+
+    /**
+     * 激励视频可以奖励回调
+     * @param adId 广告位id
+     */
+    onAdReward?(adId: string): void;
+
+    /**
+     * 激励视频观看完成回调
+     * @param adId 广告位id
+     */
+    onAdComplete?(adId: string): void;
+
+    /**
+     * 广告关闭回调（Web平台不一定回调）
+     * @param adId 广告位id
+     */
+    onAdDismiss?(adId: string): void;
+
+    /**
+     * 广告加载失败回调
+     * @param adId 广告位id
+     * @param code 错误码
+     * @param msg 错误消息
+     */
+    onAdError?(adId: string, code: number, msg: string): void;
+}
+```
+
+
+
+#### 网络请求模块
+
+###### 设置HTTP请求配置
+
+```typescript
+/**
+* 设置Http请求配置（请求之前设置）
+* @param httpConfig Http请求配置
+*/
+static setConfig(httpConfig: HttpWrapperConfig): void;
+
+//构建HTTP请求配置
+let httpConfig = new IG.HttpWrapperConfig();
+httpConfig.baseUrl = 'https://rx.dijikj.com/flkapi/';
+httpConfig.version = '1.1.1';
+httpConfig.channel = 'officail';
+//设置HTTP请求配置
+IG.HttpWrapper.setConfig(httpConfig);
+```
+
+其中，HTTP配置HttpWrapperConfig定义如下：
+
+```typescript
+/**
+ * Http请求配置
+ */
+export class HttpWrapperConfig extends HttpConfig {
+    //请求基地址
+    public baseUrl?: string;
+    //客户端版本号
+    public version?: string;
+    //渠道标识
+    public channel?: string;
+    //签名前缀
+    public signPrefix?: string;
+    //AES加密秘钥
+    public key?: string;
+    //AES加密向量
+    public iv?: string;
+}
+
+/**
+ * Http请求配置
+ */
+export class HttpConfig {
+    //请求超时时间（ms）
+    public timeout: number = 5000;
+}
+```
+
+
+
+###### 发起请求
+
+```typescript
+/**
+* GET请求
+* @param path 请求路径
+* @param callback 请求回调
+*/
+get<T extends HttpResData>(path: string, callback?: HttpCallbackBean<T>): void;
+
+/**
+* POST请求
+* @param path 请求路径
+* @param params 请求参数
+* @param callback 请求回调
+*/
+post<T extends HttpResData>(path: string, params?: object, callback?: HttpCallbackBean<T>): void;
+
+
+//构建回调
+let callback = new IG.HttpCallbackBean<LoginResData>();
+callback.onFail = (code: number, msg: string) => {
+    console.error(`Http request fail: code=${code} , msg=${msg}`);
+};
+callback.onRes = (data: LoginResData) => {
+    //缓存token
+    IG.HttpWrapper.setToken(data.data.token);
+}
+//构建请求参数
+let param = new LoginParam();
+param.type = 1;
+param.mobile = '13617678127';
+param.code = '123454321';
+//发起请求
+new IG.HttpWrapper().post<LoginResData>('user/login', param, callback);
+```
+
+
+
+#### 加解密模块
+
+```typescript
+/**
+* 加解密工具类
+*/
+export class CryptoUtil {
+    /**
+    * 设置配置（未设置时使用默认秘钥、向量）
+    * @param key 秘钥
+    * @param iv 向量
+    */
+    static setKey(key: string, iv?: string): void;
+    
+    /**
+    * 获取秘钥
+    * @param key 当前设置的秘钥
+    * @returns  秘钥
+    */
+    private static getKey;
+    
+        
+    /**
+    * 获取向量
+    * @param iv 当前设置的向量
+    * @returns 向量
+    */
+    private static getIv;
+    
+    /**
+    * MD5（32位小写）
+    * @param data 需要MD5的数据
+    * @returns MD5后的数据
+    */
+    static md5(data: string): any;
+    
+    /**
+    * AES加密
+    * @param data 需要AES加密的数据
+    * @param key 秘钥（未设置时，使用默认秘钥）
+    * @param iv 向量（未设置时，使用默认向量）
+    * @returns AES加密后的数据
+    */
+    static aesEncrypty(data: string, key?: string, iv?: string): any;
+    
+    /**
+    * AES解密
+    * @param data 需要AES解密的数据
+    * @param key 秘钥（未设置时，使用默认秘钥）
+    * @param iv 向量（未设置时，使用默认向量）
+    * @returns AES解密后的数据
+    */
+    static aesDecrypt(data: string, key?: string, iv?: string): any;
+    
+    /**
+    * Base64加密
+    * @param data 需要Base64加密的数据
+    * @returns Base64加密后的数据
+    */
+    static base64Encrpty(data: string): any;
+    
+    /**
+    * BASE64 解密
+    * @param data 需要Base64解密的数据
+    * @returns Base64解密后的数据
+    */
+    static base64Decrypt(data: string): any;
+    
+    /**
+    * 生成符合UUID v4标准的唯一标识（优化版）
+    */
+    static uuid(): string;
+
+}
+```
+
+
+
+#### 缓存模块
+
+```typescript
+/**
+* 本地存储工具类
+*/
+export class StorageUtil {
+    
+    /**
+    * 检查是否可以缓存
+    * @param key 数据key
+    */
+    private static checkAvailable;
+    
+    /**
+    * 缓存数据
+    * @param key 数据key
+    * @param data 数据
+    */
+    static setData(key: string, data: any): void;
+    
+    /**
+    * 获取缓存数据
+    * @param key 数据key
+    * @returns 数据
+    */
+    static getData(key: string): string | null;
+    
+    /**
+    * 安全缓存数据（数据会加密）
+    * @param key 数据key
+    * @param data 数据
+    * @param encryptKey 加密秘钥（未设置时，使用默认秘钥）
+    * @param encryptIv 加密向量（未设置时，使用默认向量）
+    */
+    static setDataSafely(key: string, data: any, encryptKey?: string, encryptIv?: string): void;
+    
+    /**
+    * 获取缓存数据（数据会解密）
+    * @param key 数据key
+    * @param encryptKey 加密秘钥（未设置时，使用默认秘钥）
+    * @param encryptIv 加密向量（未设置时，使用默认向量）
+    * @returns 数据
+    */
+    static getDataSafely(key: string, encryptKey?: string, encryptIv?: string): string | null;
+
+}
+```
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "igsdk",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "iGlees sdk for CocosCreator.include ads,http request,utils etc.",
   "main": "igsdk.js",
   "types": "igsdk.d.ts",
@@ -16,7 +16,6 @@
   "license": "MIT",
   "files": [
     "igsdk.js",
-    "igsdk.d.ts",
-    "README-CN.html"
+    "igsdk.d.ts"
   ]
-}
+}