seller-listing-service 0.0.1-security → 0.3.7-mmf-migrate.7

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Shopee Seller Center
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,5 +1,81 @@
-# Security holding package
+# seller-listing-service
 
-This package contained malicious code and was removed from the registry by the npm security team. A placeholder was published to ensure users are not affected in the future.
+## dependences
+- { Service } from 'seller-base'
 
-Please refer to www.npmjs.com/advisories?search=seller-listing-service for more information.
+## 安装
+
+```bash
+yarn add seller-listing-service
+```
+
+## 使用
+Example：
+```typescript
+import { Service } from 'seller-base';
+import { CategoryService } from 'seller-listing-service';
+
+Service.$instance.createServiceModule<CategoryService>(CategoryService, 'module-name');
+```
+更多示例请参考 `src/development/index.ts`
+
+### 按需引入
+
+安装`babel-plugin-import`，在babel的plugin中加入这段配置
+```js
+[require('seller-listing-service/dist/babel-config-for-main-project')]
+```
+
+### Seller Center 按需引入
+
+Seller Center 由于是多模块模式，因此需要使用的模块需要修改构建配置
+
+```js
+{
+  externals: [Object.assign(config.getExternalsConfig(), {
+    'seller-base': config.getExternalsConfig(['@/framework'])['@/framework']
+  })],
+  babelPlugin: config.mode === 'production' ? [require('seller-listing-service/dist/babel-config-for-main-project')] : []
+}
+```
+
+## 注意
+
+1. 不要修改删除.gitignore中已有部分
+2. 不要在本项目`local.config.js`加入个人定制的开发环境代码
+3. 开发一个模块MyService需要创建`src/modules/my-service/index.ts` 和 `src/modules/my-service/lib/service.ts`至少两个文件，`src/modules/my-service/index.ts`不能有默认导出。
+4. 跨模块引入只能从其他模块入口`index.ts`，不能从其他模块的其他文件引入。
+5. Constants 作为 MyService 的静态属性，不要额外导出。
+6. `src/modules/index.ts`代码不能重命名导入。
+
+## 开发
+
+### 开发执行
+
+1. CLI准备，参考CLI文档安装部分
+2. 初始化项目（scc init -d）
+3. yarn start
+
+## 构建
+
+### 构建执行
+
+1. CLI准备，参考CLI文档安装部分
+2. 初始化项目（scc init -b）
+3. yarn build
+
+## Change Logs
+
+从`0.0.xx`升级到从`0.1.xx`版本，主要的变更如下：
+
+- product/list
+1. 重新定义`OriginListProduct`、`ListProduct`对象字段，具体可以参考新版本的字段定义（0.0.xx版本的部分字段已去掉）。
+2. 去除`OriginProductItemModel`、`ProductItemModel`类型定义，使用`OriginListProductItemModel`、`ListProductItemModel`替代。
+
+- product/detail
+1. `getProductById`接口将返回`OriginProductDetail`对象（0.0.xx版本是`OriginProduct`），`computedProduct`接口将返回`ProductDetail`对象（0.0.xx版本是`Product`），返回的对象字段有变更，具体可以参考新版本的字段定义（0.0.xx版本的部分字段已去掉）。
+2. `updateProducts`接口参数变更为`Array<Partial<ProductDetail>>`（0.0.xx版本是`Array<ProductUpdateData>`）。
+
+- 其他
+1. 去除`ProductHelpers`类型定义，使用`ProductHelpers`的接口参数均有变更，seller-listing-service不再支持外部传入user、shop字段。
+2. 新增`ListingConfig`、`ProductConstraints`接口及类型定义。