npm - @be-link/ecommerce-product-service-node-sdk - Versions diffs - 0.0.16 → 0.0.18 - Mend

@be-link/ecommerce-product-service-node-sdk 0.0.16 → 0.0.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

package/index.d.ts +2 -0
package/index.js +3 -1
package/modules/job/service.d.ts +8 -0
package/modules/job/service.js +34 -0
package/modules/job/types.d.ts +13 -0
package/modules/job/types.js +2 -0
package/modules/product/types.d.ts +206 -2
package/modules/productExp/types.d.ts +31 -0
package/modules/productLive/types.d.ts +10 -0
package/package.json +1 -1

package/index.d.ts CHANGED Viewed

@@ -5,3 +5,5 @@ export { productExpService } from './modules/productExp/service';
 export type { ProductExpService as ProductExpServiceTypes } from './modules/productExp/types';
 export { productLiveService } from './modules/productLive/service';
 export type { ProductLiveService as ProductLiveServiceTypes } from './modules/productLive/types';
+export { jobService } from './modules/job/service';
+export type { JobService as JobServiceTypes } from './modules/job/types';

package/index.js CHANGED Viewed

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.productLiveService = exports.productExpService = exports.productService = exports.PRODUCT_SERVICE_ENUM = void 0;
+exports.jobService = exports.productLiveService = exports.productExpService = exports.productService = exports.PRODUCT_SERVICE_ENUM = void 0;
 var enum_1 = require("./enum");
 Object.defineProperty(exports, "PRODUCT_SERVICE_ENUM", { enumerable: true, get: function () { return enum_1.ENUM; } });
 var service_1 = require("./modules/product/service");
@@ -9,3 +9,5 @@ var service_2 = require("./modules/productExp/service");
 Object.defineProperty(exports, "productExpService", { enumerable: true, get: function () { return service_2.productExpService; } });
 var service_3 = require("./modules/productLive/service");
 Object.defineProperty(exports, "productLiveService", { enumerable: true, get: function () { return service_3.productLiveService; } });
+var service_4 = require("./modules/job/service");
+Object.defineProperty(exports, "jobService", { enumerable: true, get: function () { return service_4.jobService; } });

package/modules/job/service.d.ts ADDED Viewed

@@ -0,0 +1,8 @@
+import { JobService as Service } from './types';
+import BaseService from '../BaseService';
+declare class JobService extends BaseService implements Service.JobController {
+    protected prefixUrl: string;
+    handleScheduledTasks(): Promise<void>;
+}
+export declare const jobService: JobService;
+export default jobService;

package/modules/job/service.js ADDED Viewed

@@ -0,0 +1,34 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.jobService = void 0;
+const tsoa_1 = require("tsoa");
+const http_1 = require("../../utils/http");
+const BaseService_1 = __importDefault(require("../BaseService"));
+let JobService = class JobService extends BaseService_1.default {
+    constructor() {
+        super(...arguments);
+        this.prefixUrl = '/job';
+    }
+    handleScheduledTasks() {
+        return (0, http_1.callApi)(this.getApiUrl(this.handleScheduledTasks));
+    }
+};
+__decorate([
+    (0, tsoa_1.OperationId)('处理定时任务'),
+    (0, tsoa_1.Post)('handle-scheduled-tasks')
+], JobService.prototype, "handleScheduledTasks", null);
+JobService = __decorate([
+    (0, tsoa_1.Route)('job'),
+    (0, tsoa_1.Tags)('Job')
+], JobService);
+exports.jobService = new JobService();
+exports.default = exports.jobService;

package/modules/job/types.d.ts ADDED Viewed

@@ -0,0 +1,13 @@
+export declare namespace JobService {
+    namespace Request { }
+    namespace Response { }
+    /**
+     * Job Controller 接口定义
+     */
+    interface JobController {
+        /**
+         * 处理商品定时任务
+         */
+        handleScheduledTasks(): Promise<void>;
+    }
+}

package/modules/job/types.js ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ "use strict";
2	+ Object.defineProperty(exports, "__esModule", { value: true });

package/modules/product/types.d.ts CHANGED Viewed

@@ -1,297 +1,501 @@
 export declare namespace ProductService {
     interface SkuField {
+        /** 价格（分） */
         price: number;
+        /** 库存 */
         stock: number;
+        /** SKU编码 */
         skuCode: string;
+        /** 属性列表 */
         attrs: Attr[];
+        /** 绑定的SKU列表 */
         bindSkus: BindSku[];
+        /** 多SKU编码 */
         multiSkuCodes: string[];
     }
     /**
      * 核销期限接口
      */
     interface VerifyPeriod {
+        /** 开始时间戳 */
         startDate: number;
+        /** 结束时间戳 */
         endDate: number;
+        /** 付款后天数 */
         payAfterDay: number;
+        /** 类型 1: 时间范围 2: 付款后天数 */
         type: number;
     }
     /**
      * 属性接口
      */
     interface Attr {
+        /** 属性名称 */
         attrName: string;
+        /** 属性值 */
         attrValue: string;
     }
     /**
      * 绑定的SKU接口
      */
     interface BindSku {
+        /** 商品ID */
         productId: string;
+        /** 绑定的子SKUID */
         skuId: string;
+        /** 数量 */
         quantity: number;
     }
     /**
      * 定时任务接口
      */
     interface ScheduledTask {
+        /** 任务ID */
         id?: string;
+        /** 定时任务时间戳 */
         scheduledTime: number;
+        /** 上下状态 */
         status: string;
     }
     /**
      * SKU项接口
      */
     interface SkuItem {
+        /** SKU ID（编辑/更新时传入） */
         skuId?: string;
+        /** 属性列表 */
         attrs: Attr[];
+        /** 价格（分） */
         price: number;
+        /** 划线价（分） */
         strikethroughPrice: number;
+        /** 采购价（分） */
         purchasePrice: number;
+        /** SKU编码 */
         skuCode: string;
+        /** 多SKU编码 */
         multiSkuCodes: string[];
+        /** 绑定的SKU列表 */
         bindSkus: BindSku[];
+        /** 库存 */
         stock: number;
+        /** 是否展示绑定子商品 1展示，0不展示 */
         showBindSkus: number;
     }
     /**
      * 产品信息接口
      */
     interface ProductInfo {
+        /** 商品ID（编辑/更新时传入） */
         productId?: string;
+        /** 产品类型 */
         productType: string;
+        /** 是否组合商品 */
         isCombo: number;
+        /** 商品名称 */
         productName: string;
+        /** 主图URL */
         mainImg: string;
+        /** 图片列表 */
         imgList: string[];
+        /** 商品描述 */
         productDesc?: string;
+        /** 一级分类ID */
         categoryId: string;
+        /** 二级分类ID */
         twoCategoryId: string;
+        /** 三级分类ID */
         threeCategoryId: string;
+        /** 提货方式 */
         pickType: string;
+        /** 发货方式 */
         dispatchType: string;
+        /** 存储方式 */
         storageMethod: string;
+        /** 商品分类 */
         classification: string;
+        /** 库存单位 */
         stockUnit: string;
+        /** 产品经理ID */
         productManagerId?: string;
+        /** 供应商ID */
         supplierId?: string;
+        /** 直播分组ID */
         liveGroupId?: string;
+        /** 上下架状态 */
         status?: string;
+        /** 是否需要核销 */
         needVerify?: number;
+        /** 核销期限 */
         verifyPeriod?: VerifyPeriod;
+        /** 起售数量 */
         miniSaleQuantity?: number;
+        /** 限购 */
         purchaseLimit?: number;
+        /** 运费模板版本类型 */
         freightType?: string;
     }
     interface ProductData {
+        /** 产品信息 */
         productInfo: ProductInfo;
+        /** SKU列表 */
         skuList: SkuItem[];
     }
     namespace Request {
         interface detail {
+            /** 商品Id */
             productId: string;
         }
         interface list {
+            /** 0 开始 */
             pageIndex: number;
+            /** 每页数量 */
             pageSize: number;
+            /** 商品Id */
             productIds?: string[];
+            /** 商品名称 */
             productNames?: string[];
+            /** 商品分类 */
             classifications?: string[];
+            /** 存储方式 */
             storageMethods?: string[];
+            /** 配货方式 */
             dispatchTypes?: string[];
+            /** 供应商Id */
             supplierIds?: string[];
+            /** 直播分组ID */
             liveGroupIds?: string[];
+            /** 产品经理ID */
             productManagerIds?: string[];
+            /** 商品类型 */
             productType?: string;
+            /** 上下架状态 */
             status?: string;
+            /** 是否套餐 */
             isCombo?: number;
+            /** 69码列表 */
             skuCodes?: string[];
         }
         interface batchUpdate {
+            /** 商品Id列表 */
             productIds: string[];
+            /** 上下架状态 */
             status?: string;
+            /** 定时上下架任务 */
             scheduledTasks?: ScheduledTask[];
+            /** 商品分类 */
             classification?: string;
+            /** 存储方式 */
             storageMethod?: string;
+            /** 配货方式 */
             dispatchType?: string;
+            /** 直播分组ID */
             liveGroupId?: string;
+            /** 是否删除 */
             isDelete?: boolean;
         }
         interface queryScheduledTask {
+            /** 商品Id */
             productId: string;
         }
         interface checkSkuCode {
+            /** 商品Id */
             productId?: string;
+            /** SKU ID（更新已有SKU时传入，排除自身） */
             skuId?: string;
+            /** SKU编码 */
             skuCode: string;
         }
         interface queryProductList {
+            /** 0 开始 */
             pageIndex: number;
+            /** 页码数量 */
             pageSize: number;
+            /** 商品Id列表 */
             productIds?: string[];
+            /** 商品名称列表 */
             productNames?: string[];
+            /** 69码列表 */
             skuCodes?: string[];
+            /** 是否套餐 */
             isCombo?: number;
+            /** 提货方式 */
             pickTypes?: string[];
+            /** 配货方式 */
             dispatchTypes?: string[];
+            /** 存储方式 */
             storageMethods?: string[];
+            /** 商品分类 */
             classifications?: string[];
+            /** 上下架状态 */
             status?: string;
         }
         interface querySkuBaseInfo {
+            /** skuId列表 */
             skuIds?: string[];
+            /** productId列表 */
             productIds?: string[];
+            /** 需要查询的SKU基础信息字段列表 */
             fields: (keyof SkuField)[];
         }
         interface isSoldOut {
+            /** SKU ID */
             skuId: string;
         }
         interface deleteScheduledTask {
+            /** 任务ID */
             taskId: string;
         }
         interface getProductSkuInfo {
+            /** 商品Id */
             productId: string;
-            skuIds?: string[];
-            skuCodes?: string[];
+            /** SKU Id */
+            skuId: string;
         }
     }
     namespace Response {
         interface create {
+            /** 商品Id */
             productId: string;
         }
         interface queryScheduledTask {
+            /** 任务ID */
             id: string;
+            /** 定时任务时间戳 */
             scheduledTime: number;
+            /** 任务状态 */
             status: string;
+            /** 操作类型 上下架 */
             operationType: string;
         }
         interface list {
             total: number;
             list: {
+                /** 商品ID */
                 productId: string;
+                /** 商品名称 */
                 productName: string;
+                /** 商品图片 */
                 productImage: string;
+                /** 分类名称 */
                 cateName: string;
+                /** 商品分类 */
                 classification: string;
+                /** 存储方式 */
                 storageMethod: string;
+                /** 配货方式 */
                 dispatchType: string;
+                /** 销售数量 */
                 salesQuantity: number;
+                /** 退货数量 */
                 refundQuantity: number;
+                /** 价格 */
                 price: number;
+                /** 库存 */
                 stock: number;
+                /** 上下架状态 */
                 status: string;
+                /** 创建时间 */
                 createdAt: number;
             }[];
         }
         interface checkSkuCode {
+            /** 是否可用 */
             enable: boolean;
         }
         interface queryProductList {
             total: number;
             list: {
+                /** 商品ID */
                 productId: string;
+                /** 商品名称 */
                 productName: string;
+                /** 商品图片 */
                 productImage: string;
+                /** 商品分类 */
                 classification: string;
+                /** 存储方式 */
                 storageMethod: string;
+                /** 配货方式 */
                 dispatchType: string;
+                /** 价格 */
                 price: number;
+                /** 库存 */
                 stock: number;
+                /** 上下架状态 */
                 status: string;
             }[];
         }
         interface queryProductSkuList {
             total: number;
             list: {
+                /** 商品ID */
                 productId: string;
+                /** 商品名称 */
                 productName: string;
+                /** 商品图片 */
                 productImage: string;
+                /** 商品分类 */
                 classification: string;
+                /** 存储方式 */
                 storageMethod: string;
+                /** 配货方式 */
                 dispatchType: string;
+                /** 价格 */
                 price: number;
+                /** 库存 */
                 stock: number;
+                /** 上下架状态 */
                 status: string;
+                /** SKU ID */
                 skuId: string;
+                /** 属性列表 */
                 attrs: Attr[];
+                /** SKU编码 */
                 skuCode: string;
             }[];
         }
         interface querySkuBaseInfo extends Partial<SkuField> {
+            /** 商品ID */
             productId: string;
+            /** SKU ID */
             skuId: string;
         }
         interface getProductDetail {
+            /** 商品信息 */
             productInfo: {
+                /** 商品ID */
                 productId: string;
+                /** 产品类型 */
                 productType: string;
+                /** 商品名称 */
                 productName: string;
+                /** 是否组合商品 */
                 isCombo: number;
+                /** 主图URL */
                 mainImg: string;
+                /** 图片列表 */
                 imgList: string[];
+                /** 商品描述 */
                 productDesc: string;
+                /** 提货方式 */
                 pickType: string;
+                /** 发货方式 */
                 dispatchType: string;
+                /** 存储方式 */
                 storageMethod: string;
+                /** 商品分类 */
                 classification: string;
+                /** 库存单位 */
                 stockUnit: string;
+                /** 上下架状态 */
                 status: string;
+                /** 起售数量 */
                 miniSaleQuantity: number;
+                /** 限购 -1 表示不限购 */
                 purchaseLimit: number;
+                /** 运费JSON字符串 */
                 freightTemplate: string[] | null;
+                /** 门店可见范围 */
                 visibleStores: string[] | null;
+                /** 门店不可见范围和可见互斥 */
                 invisibleStores: string[] | null;
             };
+            /** SKU列表 */
             skuList: {
+                /** SKU ID */
                 skuId: string;
+                /** 属性列表 [颜色：白色； 尺寸：L] */
                 attrs: Attr[];
+                /** 价格（分） */
                 price: number;
+                /** 划线价（分） */
                 strikethroughPrice: number;
+                /** SKU编码 */
                 skuCode: string;
+                /** 库存 */
                 stock: number;
             }[];
         }
         interface isSoldOut {
+            /** SKU ID */
             skuId: string;
+            /** 是否售罄 */
             soldOut: boolean;
         }
         interface getProductSkuInfo {
+            /** 商品信息 */
             productInfo: {
+                /** 商品ID */
                 productId: string;
+                /** 产品类型 */
                 productType: string;
+                /** 商品名称 */
                 productName: string;
+                /** 是否组合商品 */
                 isCombo: number;
+                /** 主图URL */
                 mainImg: string;
+                /** 图片列表 */
                 imgList: string[];
+                /** 商品描述 */
                 productDesc: string;
+                /** 一级分类ID */
                 categoryId: string;
+                /** 二级分类ID */
                 twoCategoryId: string;
+                /** 三级分类ID */
                 threeCategoryId: string;
+                /** 提货方式 */
                 pickType: string;
+                /** 发货方式 */
                 dispatchType: string;
+                /** 存储方式 */
                 storageMethod: string;
+                /** 商品分类 */
                 classification: string;
+                /** 库存单位 */
                 stockUnit: string;
+                /** 上下架状态 */
                 status: string;
+                /** 是否需要核销 */
                 needVerify: number;
+                /** 核销期限 */
                 verifyPeriod: VerifyPeriod | null;
+                /** 起售数量 */
                 miniSaleQuantity: number;
+                /** 限购 -1 表示不限购 */
                 purchaseLimit: number;
+                /** 运费JSON字符串 */
                 freightTemplate: string[] | null;
+                /** 门店可见范围 */
                 visibleStores: string[] | null;
+                /** 门店不可见范围和可见互斥 */
                 invisibleStores: string[] | null;
             };
+            /** SKU列表 */
             skuList: {
+                /** SKU ID */
                 skuId: string;
+                /** 属性列表 [颜色：白色； 尺寸：L] */
                 attrs: Attr[];
+                /** 价格（分） */
                 price: number;
+                /** 划线价（分） */
                 strikethroughPrice: number;
+                /** 采购价（分） */
                 purchasePrice: number;
+                /** SKU编码 */
                 skuCode: string;
+                /** 多SKU编码 */
                 multiSkuCodes: string[];
+                /** 绑定的SKU列表 */
                 bindSkus: BindSku[];
+                /** 是否展示绑定子商品 1展示，0不展示 */
                 showBindSkus: number;
+                /** 是否有绑定子商品 1有，0无 */
                 hasBindSkus: number;
+                /** 是否有多码 1有，0无 */
                 hasMultiSkuCodes: number;
             }[];
         }

package/modules/productExp/types.d.ts CHANGED Viewed

@@ -1,73 +1,104 @@
 export declare namespace ProductExpService {
     interface ProductCategory {
+        /** 分类ID */
         id: string;
+        /** 父级ID */
         parentId: string;
+        /** 层级 */
         level: number;
+        /** 分类名称 */
         categoryName: string;
     }
     namespace Request {
         interface getSupplierList {
+            /** 页码，0开始 */
             pageIndex: number;
+            /** 每页数量 */
             pageSize: number;
+            /** 供应商名称，模糊匹配 */
             supplierName?: string;
         }
         interface addSupplier {
+            /** 供应商名称 */
             supplierName: string;
         }
         interface getLiveGroupList {
+            /** 页码，0开始 */
             pageIndex: number;
+            /** 每页数量 */
             pageSize: number;
+            /** 直播分组名称，模糊匹配 */
             liveGroupName?: string;
         }
         interface addLiveGroup {
+            /** 直播分组名称 */
             liveGroupName: string;
         }
         interface productCategoryList {
+            /** 分类层级 */
             level: number;
+            /** 父分类ID */
             parentId?: string;
         }
         interface setStoreScope {
+            /** 商品Id */
             productId: string;
+            /** 类型 VISIBLE | INVISIBLE */
             type: string;
+            /** 门店Id列表 */
             storeIds: string[];
         }
         interface queryStoreScope {
+            /** 商品Id */
             productId: string;
         }
     }
     namespace Response {
         interface addSupplier {
+            /** 供应商Id */
             supplierId: string;
         }
         interface getSupplierList {
             total: number;
             list: {
+                /** 供应商Id */
                 supplierId: string;
+                /** 供应商名称 */
                 supplierName: string;
             }[];
         }
         interface addLiveGroup {
+            /** 直播分组Id */
             liveGroupId: string;
         }
         interface getLiveGroupList {
             total: number;
             list: {
+                /** 直播分组Id */
                 liveGroupId: string;
+                /** 直播分组名称 */
                 liveGroupName: string;
             }[];
         }
         interface list {
             total: number;
             list: {
+                /** 商品ID */
                 productId: string;
+                /** 商品名称 */
                 productName: string;
+                /** 商品图片 */
                 productImage: string;
+                /** 价格 */
                 price: number;
+                /** 库存 */
                 stock: number;
             }[];
         }
         interface queryStoreScope {
+            /** 类型 VISIBLE | INVISIBLE */
             type: string;
+            /** 门店Id列表 */
             storeIds: string[];
         }
     }

package/modules/productLive/types.d.ts CHANGED Viewed

@@ -1,12 +1,17 @@
 export declare namespace ProductLiveService {
     namespace Request {
         interface list {
+            /** 0 开始 */
             pageIndex: number;
+            /** 每页数量 */
             pageSize: number;
+            /** 直播间ID */
             liveRoomId: string;
         }
         interface operate {
+            /** 商品ID */
             productId: string;
+            /** 直播间ID */
             liveRoomId: string;
         }
     }
@@ -14,10 +19,15 @@ export declare namespace ProductLiveService {
         interface list {
             total: number;
             list: {
+                /** 商品ID */
                 productId: string;
+                /** 商品名称 */
                 productName: string;
+                /** 商品图片 */
                 productImage: string;
+                /** 价格 */
                 price: number;
+                /** 库存 */
                 stock: number;
             }[];
         }

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@be-link/ecommerce-product-service-node-sdk",
-  "version": "0.0.16",
+  "version": "0.0.18",
   "description": "EcommerceProductService Node.js SDK",
   "main": "index.js",
   "types": "index.d.ts",