seller-base-service 0.0.1-security → 0.1.12

package/src/modules/otp/constants.ts

@@ -0,0 +1,39 @@
+/**
+ * OtpSeed 是所有 Otp 验证参数的类型配置
+ */
+export enum OtpSeed {
+  /**
+   * 下载报告
+   */
+  Report = 'report',
+
+  /**
+   * 添加银行账号
+   */
+  AddBankAccount = 'add-bank-account',
+
+  /**
+   * 编辑银行账号，删除银行账号
+   */
+  EditBankAccount = 'edit-bank-account',
+
+  /**
+   * 修改密码返回400，需要二次验证带上此类型
+   */
+  ResetPassword = 'reset-password',
+
+  /**
+   * 绑定手机，修改手机
+   */
+  PhoneNumber = 'phone-number',
+
+  /**
+   * 钱包身份认证
+   */
+  KycVerify = 'kyc-verify',
+
+  /**
+   * 添加验证支付密码
+   */
+  PaymentPasscode = 'payment-passcode',
+}

package/src/modules/otp/index.ts

@@ -0,0 +1,11 @@
+export {
+  OtpSeed
+} from './constants';
+
+export {
+  default as OtpService
+} from './service';
+
+export {
+  OtpVerifyData
+} from './types';

package/src/modules/otp/service.ts

@@ -0,0 +1,28 @@
+import { Service, ServiceModule, APIPromise, APIExternalPromise, APIRequestConfig } from 'seller-base';
+import { OtpVerifyData } from './types';
+
+export default class OtpService extends ServiceModule {
+  public static $instance: OtpService;
+
+  constructor(service: Service) {
+    super(service);
+    this.name = 'otp';
+    OtpService.$instance = this;
+  }
+
+  /**
+   * 获取短信验证码
+   * @see https://api.seller.shopee.io/project/50/interface/api/7950
+   */
+  public sendSmsOtp(data: OtpVerifyData, config?: APIRequestConfig): APIPromise<{}> {
+    return this.api.v3Request.post('/general/send_sms_otp/', data, config) as APIExternalPromise<{}>;
+  }
+
+  /**
+   * 发送语音验证码
+   * @see https://api.seller.shopee.io/project/50/interface/api/9270
+   */
+  public sendVoiceOtp(data: OtpVerifyData, config?: APIRequestConfig): APIPromise<{}> {
+    return this.api.v3Request.post('/general/send_voice_otp/', data, config) as APIExternalPromise<{}>;
+  }
+}

package/src/modules/otp/types.ts

@@ -0,0 +1,13 @@
+import { OtpSeed } from './constants';
+
+export interface OtpVerifyData {
+  /**
+   * OTP 验证的手机号
+   */
+  phone?: string;
+
+  /**
+   * OTP 验证类型
+   */
+  otpSeed: OtpSeed;
+}

package/src/modules/report/constants.ts

@@ -0,0 +1,20 @@
+/**
+ * 文件类型配置
+ */
+export const FileTypeConfig: { [key: string]: string } = {
+  xls: 'application/vnd.ms-excel',
+  xlsx: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
+  csv: 'text/plain;charset=utf-8',
+  zip: 'application/zip',
+};
+
+/**
+ * 报表状态
+ */
+export enum ReportStatus {
+  PROCESSING = 1,
+  DOWNLOADABLE = 2,
+  DOWNLOADED = 3,
+  FAILED = 4,
+  DELETED = 5
+}

package/src/modules/report/index.ts

@@ -0,0 +1,19 @@
+export {
+  FileTypeConfig,
+  ReportStatus
+} from './constants';
+
+export {
+  default as ReportService
+} from './service';
+
+export {
+  downloadBlobData,
+  parseBlobJsonResponse
+} from './utils';
+
+export {
+  Report,
+  ReportListParams,
+  ReportListResponse
+} from './types';

package/src/modules/report/service.ts

@@ -0,0 +1,100 @@
+import { AxiosResponse } from 'axios';
+import { Service, ServiceModule, APIPromise, APIExternalPromise, APIRequestConfig, APIExternalResponse } from 'seller-base';
+import { FileTypeConfig } from './constants';
+import { parseBlobJsonResponse, normalizeError, downloadBlobData } from './utils';
+import { Report, ReportListParams, ReportListResponse } from './types';
+
+/**
+ * 这整个report不应该将具体的实现放在这里，后续需要去掉
+ */
+interface ServiceAPICreatorConfig extends APIRequestConfig {
+  responseInterceptor: any;
+}
+
+export default class ReportService extends ServiceModule {
+  public static $instance: ReportService;
+
+  constructor(service: Service) {
+    super(service);
+    this.name = 'report';
+    ReportService.$instance = this;
+  }
+
+  protected getRequestConfig() {
+    return {
+      downloadRequest: {
+        path: 'api/v3',
+        useTransform: false,
+        useCamelCaseKeys: false,
+        config: {
+          skipError: true,
+          responseType: 'blob',
+          headers: {
+            Accept: 'application/json, application/force-download, text/plain, */*'
+          },
+          namespace: Service.Constants.APICommonNamespace.v3Request,
+        },
+        requestInterceptors: [(config: any) => {
+          Object.assign(config, {
+            skipErorr: config.skipErorr || true,
+          });
+          return config;
+        }],
+
+        responseInterceptor: [
+          [(res: AxiosResponse) => {
+            if (res.data) {
+              if (res.headers['content-disposition']) {
+                const matches = res.headers['content-disposition'].match(/.*filename="([a-zA-Z0-9._]+)"/i);
+                downloadBlobData(new Blob([res.data]), matches ? matches[1] : '', res.config.url, FileTypeConfig);
+                (res as any).error = false;
+                return res;
+              } else {
+                return parseBlobJsonResponse(res).then(res => {
+                  res.error = res.data ? normalizeError(res.data.code, res.data.message, new Error('ParseBlobError: Server response error.')) : normalizeError(null, null, new Error('ParseBlobError: Default Error.')),
+                  res.data = null;
+                  return res;
+                });
+              }
+            }
+          }, (error: Error) => {
+            return {
+              data: null,
+              error: normalizeError(null, null, error),
+              headers: null,
+              config: null
+            } as APIExternalResponse;
+          }]
+        ]
+      } as ServiceAPICreatorConfig
+    };
+  }
+
+  /**
+   * 下载 Report 的基础方法
+   */
+  public downloadReport(url: string, params: any = {}, config: APIRequestConfig = {}): APIPromise<any> {
+    return this.api.downloadRequest.get(url, Object.assign({}, config, {
+      params: Service.Utility.snakeCaseKeys(params)
+    })) as APIExternalPromise<any>;
+  }
+
+  /**
+   * 获取 Report 详情的基础方法
+   */
+  public getReport(url: string, reportId: number, config: APIRequestConfig = {}): APIPromise<Report> {
+    return this.api.v3Request.get(url, Object.assign({}, config, {
+      params: Service.Utility.snakeCaseKeys({ reportId })
+    })) as APIExternalPromise<Report>;
+  }
+
+  /**
+   * 获取 Report List 的基础方法
+   */
+  public getReportList(url: string, params: ReportListParams, config: APIRequestConfig = {}): APIPromise<ReportListResponse> {
+    const status = params.status ? params.status.join(',') : undefined;
+    return this.api.v3Request.get(url, Object.assign({}, config, {
+      params: Service.Utility.snakeCaseKeys(Object.assign({}, params, { status }))
+    })) as APIExternalPromise<ReportListResponse>;
+  }
+}

package/src/modules/report/types.ts

@@ -0,0 +1,31 @@
+import { CommonListResponse } from '../common';
+
+/**
+ * 获取 Report List 的参数
+ */
+export interface ReportListParams {
+  pageNumber: number;
+  pageSize: number;
+  parentType: string;
+  subType?: string;
+  status: number[];
+}
+
+/**
+ * 单个 Report 的类型
+ */
+export interface Report {
+  reportId: number;
+  parentType: string;
+  reportFileName: string;
+  requestTime: number;
+  status: number;
+  subType?: string;
+  userName: string;
+  downloadLink?: string;
+}
+
+/**
+ * Report List 类型
+ */
+export type ReportListResponse = CommonListResponse<Report>;

package/src/modules/report/utils.ts

@@ -0,0 +1,74 @@
+import { AxiosResponse } from 'axios';
+import { Service, APIError, APIPromise } from 'seller-base';
+
+/**
+ * 创建一个标准 error 的结构，仅仅 ReportService 内部使用
+ */
+export function normalizeError(code: number | string, message: string, error: Error): APIError {
+  return {
+    code: code || Service.Constants.APIPredfinedErrors.Default.CODE,
+    message: message || Service.Constants.APIPredfinedErrors.Default.MESSAGE,
+    stack: error.stack || error,
+    data: null,
+    status: 200,
+  } as APIError;
+}
+
+/**
+ * 解析Blob JSON Response，用于把 Blob Data 转化为 JSON Data
+ */
+export function parseBlobJsonResponse(res: AxiosResponse<Blob>): APIPromise<any> {
+  return new Promise((resolve) => {
+    const fileReader = new FileReader();
+    fileReader.onload = (e) => {
+      let data = {};
+      if ((window as any).TextDecoder) {
+        const decoder = new TextDecoder('utf-8');
+        data = JSON.parse(decoder.decode(new Uint8Array(e.target.result as any)));
+      } else {
+        data = JSON.parse(String.fromCharCode.apply(null, new Uint8Array(e.target.result as any)));
+      }
+      resolve({
+        data,
+        error: false,
+        headers: res.headers,
+        config: res.config
+      });
+    };
+    fileReader.onerror = () => {
+      resolve({
+        data: null,
+        error: normalizeError(null, null, new Error('ParseBlobError: Default Error.')),
+        headers: res.headers,
+        config: res.config
+      });
+      fileReader.abort();
+    };
+    fileReader.readAsArrayBuffer(res.data);
+  }) as APIPromise<any>;
+}
+
+/**
+ * 下载 Blob Data
+ */
+export function downloadBlobData(content: any, filename: string, url: string, fileTypes: { [key: string]: string }) {
+  const downLink = document.createElement('a');
+
+  const matches = filename.match(/.+\.([a-z]+)$/);
+  const type = matches ? fileTypes[matches[1]] : undefined;
+
+  if (!('download' in downLink) || !type) {
+    return window.open(url);
+  }
+
+  downLink.download = filename;
+  downLink.style.display = 'none';
+
+  const blobURL = new Blob([content], { type });
+
+  downLink.href = URL.createObjectURL(blobURL);
+
+  document.body.appendChild(downLink);
+  downLink.click();
+  document.body.removeChild(downLink);
+}

package/src/modules/sip/index.ts

@@ -0,0 +1,2 @@
+export { default as SipGlobalService } from './service';
+export { SipOrderResponse, SipOrder, SipOrderItem } from './types';

package/src/modules/sip/service.ts

@@ -0,0 +1,59 @@
+import { SipOrderResponse } from './types';
+import { Service, ServiceModule, APIPromise, APIExternalPromise, APICreatorConfig } from 'seller-base';
+export default class SipGlobalService extends ServiceModule {
+  public static $instance: SipGlobalService;
+  public static GlobalServiceModule = true; // 公用service
+
+  constructor(service: Service) {
+    super(service);
+    this.name = 'sipGlobal';
+    SipGlobalService.$instance = this;
+  }
+
+  protected getRequestConfig(): { [key: string]: Partial<APICreatorConfig> } {
+    return {
+      sipRequestV1: {
+        path: 'api/sip/',
+        useUnpackData: true
+      },
+      sipRequest: {
+        path: 'api/sip/v2/',
+        useUnpackData: true
+      }
+    };
+  }
+
+  /**
+   * getSipOrderDetail 调用SIP接口获取a-shop的订单详情
+   */
+  public getSipOrderDetail(orderidList: number[], aShopId?: number): APIPromise<SipOrderResponse> {
+    const { sipShopid } = Service.Utility.camelCaseKeys(Service.Utility.parseQueryString(window.location.search.substr(1)));
+
+    return this.api.sipRequest.get('orders/detail/', {
+      params: {
+        orderid_list: JSON.stringify(orderidList),
+        affi_shopid: aShopId || sipShopid
+      }
+    }) as APIExternalPromise<SipOrderResponse>;
+  }
+
+  /**
+   * getSuggestedPrice 获取a-shop的sku推荐的价格
+   */
+  public getSuggestedPrice(params: object) {
+    return this.api.sipRequestV1.get('items/price/', { params }).then((response: any) => {
+      const res = response.error ? {} : response.data;
+      return (res as any);
+    });
+  }
+
+  /**
+   * setAskuPrice 设置a-shop的sku的价格
+   */
+  public setAskuPrice(params: object) {
+    return this.api.sipRequestV1.put('items/price/', params).then((response: any) => {
+      const res = response.error ? {} : response.data;
+      return (res as any);
+    });
+  }
+}

package/src/modules/sip/types.ts

@@ -0,0 +1,33 @@
+export interface SipOrderResponse {
+  list: SipOrder[];
+}
+export interface SipOrder {
+  orderid: number;
+  transactionFee: number;
+  totalFee: number;
+  netSettlementAmount: number;
+  commissionFee: number;
+  settlementAmount: number;
+  orderItems: SipOrderItem[];
+  priceRatio: number;
+}
+export interface SipOrderItem extends OriginSipOrderItem {
+  subtotal: number;
+  tipText: string;
+}
+export interface OriginSipOrderItem {
+  mstItemid: number;
+  mstModelid: number;
+  affiItemid: number;
+  affiModelid: number;
+  itemSku: string;
+  itemName: string;
+  image: string;
+  promoPrice: number;
+  origPrice: number;
+  mstHpfs: number;
+  settlementPrice: number;
+  modelName: string;
+  modelSku: string;
+  quantity: number;
+}

package/src/modules/upload/index.ts

@@ -0,0 +1,8 @@
+export {
+  default as UploadService
+} from './service';
+
+export {
+  UploadOptions,
+  UploadVideoData
+} from './types';

package/src/modules/upload/service.ts

@@ -0,0 +1,94 @@
+import { Service, ServiceModule, APIPromise, APIExternalPromise, APIRequestConfig } from 'seller-base';
+import { UploadOptions, UploadVideoData } from './types';
+
+export default class UploadService extends ServiceModule {
+  public static $instance: UploadService;
+
+  constructor(service: Service) {
+    super(service);
+    this.name = 'upload';
+    UploadService.$instance = this;
+  }
+
+  /**
+   * 转化 Base64 为 Blob
+   */
+  public dataUrlToBlob(dataURI: string): Blob {
+    let byteString;
+    if (dataURI.split(',')[0].indexOf('base64') >= 0) {
+      byteString = window.atob(dataURI.split(',')[1]);
+    } else {
+      byteString = decodeURIComponent(dataURI.split(',')[1]);
+    }
+
+    /**
+     * 获取 mimeType
+     */
+    const mimeType = dataURI.split(',')[0].split(':')[1].split(';')[0];
+
+    const ia = new Uint8Array(byteString.length);
+    for (let i = 0; i < byteString.length; i++) {
+      ia[i] = byteString.charCodeAt(i);
+    }
+
+    return new Blob([ia], { type: mimeType });
+  }
+
+  /**
+   * 转化传入的对象为 FromData 数据
+   */
+  public createFormData(data: { [name: string]: string | Blob }) {
+    const formData = new FormData();
+    Object.keys(data).forEach(name => {
+      if (data.hasOwnProperty(name)) {
+        const value = data[name];
+        if (value) {
+          const isBase64 = typeof value === 'string' && value.indexOf('data:') === 0;
+          formData.append(name, isBase64 ? this.dataUrlToBlob(value as string) : value);
+        }
+      }
+    });
+    return formData;
+  }
+
+  /**
+   * 一个上传的通用方法 Post 数据，类型是 FormData
+   */
+  public postData(config: UploadOptions): APIPromise<any> {
+    const formData = this.createFormData(config.data);
+    return config.request.post(config.path, formData, Object.assign({}, config.config || {}, { params: config.params || {} })) as APIExternalPromise<any>;
+  }
+
+  /**
+   * 上传图片 V1
+   */
+  public uploadImageV1(file: string | Blob, params?: any, config?: APIRequestConfig): APIPromise<any> {
+    return this.postData({
+      path: '/images/',
+      data: { file },
+      request: this.api.v1Request,
+      params,
+      config
+    });
+  }
+
+  /**
+   * 上传图片 V3，一般应该使用这个接口
+   */
+  public uploadImage(file: string | Blob, params?: any, config?: APIRequestConfig): APIPromise<any> {
+    return this.postData({
+      path: '/general/upload_image/',
+      data: { file },
+      request: this.api.v3Request,
+      params,
+      config
+    });
+  }
+
+  /**
+   * 上传 Video
+   */
+  public uploadVideo(data: UploadVideoData): APIPromise<{}> {
+    return this.api.v3Request.post('/general/upload_video/', data) as APIExternalPromise<{}>;
+  }
+}

package/src/modules/upload/types.ts

@@ -0,0 +1,34 @@
+import { AxiosInstance } from 'axios';
+import { APIRequestConfig } from 'seller-base';
+
+export interface UploadOptions {
+  /**
+   * 上传的路径
+   */
+  path: string;
+
+  /**
+   * 上传的数据，会全部加到 FormData
+   */
+  data: { [name: string]: string | Blob };
+
+  /**
+   * 上传链接的 Params
+   */
+  params?: any;
+
+  /**
+   * 上传的参数配置
+   */
+  config?: APIRequestConfig;
+
+  /**
+   * 上传的 Request
+   */
+  request: AxiosInstance;
+}
+
+export interface UploadVideoData {
+  ratio?: number;
+  videoUrl: string;
+}