ftdsy-attr 2.0.0 → 2.1.0

package/dist/ftdsy-attr.d.ts

@@ -1,93 +1,111 @@
-type Platform = 'pdd' | 'tb' | 'jd' | 'dy' | 'shopee' | 'xhs' | 'ks' | 'dsy' | 'albb' | 'shopeebt' | 'tgc' | 'wxsph' | 'tiktok' | 'tm' | 'tiktokUs';
-type GoodsAttr = {
-    id?: string | number;
+type Pt = 'pdd' | 'tb' | 'jd' | 'dy' | 'shopee' | 'xhs' | 'ks' | 'dsy' | 'albb' | 'shopeebt' | 'tgc' | 'wxsph' | 'tiktok' | 'tm' | 'tiktokUs';
+type PropertyType = 'unknown' | 'input' | 'singleSelect' | 'multiSelect' | 'treeSingleSelect' | 'inputComponent' | 'multiComplex' | 'date' | 'image';
+type RuleName = 'requiredRule' | 'maxLengthRule' | 'valueTypeRule' | 'maxItemsRule' | 'format' | 'regexRule';
+type ComponentType = 'input' | 'unit' | 'select';
+type goodsAttr = {
+    id?: string;
     attr_name: string;
     value: string | string[];
-    value_id?: string | number | string[];
+    value_id?: string | string[];
 };
-type PropertyItem = {
-    property_id: string | number;
-    property_name: string;
-    property_required: boolean;
-    property_type: number;
-    property_value?: number | string | PropertySelectOption[] | PropertySelectOption | object;
-    property_values: PropertySelectOption[];
-    select_max_num: number;
-    select_custom: boolean;
-    input_num: number;
-    input_max_num: number;
-    input_type: string;
-    property_unit: string;
-    property_units: string[];
-    input_operator?: string;
-    input_values?: PropertyInputOption[];
-    date_format: string;
-    has_children: boolean;
-    show?: boolean;
-    show_condition: PropertyShowCondition[];
-    condition_values: PropertySelectOption[];
-    property_tips?: string;
-    measure_templates?: any;
-    property_cstore?: boolean;
-};
-type PropertySelectOption = {
-    name: string;
-    value_id: string;
+type propertyOption = {
+    label: string;
     value: string;
     parent_value?: string[];
-    parent_id?: string;
-    parent_name?: string;
-    children_values?: PropertySelectOption[];
-    disableContent?: boolean;
-    content?: number;
-    similarity?: number;
+    value_path?: string;
+    value_ids_path?: string[];
+    children?: propertyOption[];
+};
+type PropertyComponent = {
+    type: string;
+    name?: string;
+    placeholder?: string;
+    options: propertyOption[];
+    text?: string;
+    precision?: number;
 };
-type PropertyInputOption = {
-    title: string;
+type Rule = {
+    name: RuleName;
     value: string;
+    exProperty?: string;
 };
-type PropertyShowCondition = {
-    parent_property_id: string;
-    parent_property_value: string[];
+type DsyAttr = {
+    property_id: string;
+    property_required: boolean;
+    property_name: string;
+    property_type: PropertyType;
+    property_values: propertyOption[];
+    property_component?: PropertyComponent[];
+    property_tips?: string;
+    rules: Rule[];
+    has_children: boolean;
+    select_custom?: boolean;
+    show_condition?: Condition[];
+    measure_templates?: any;
+    isCStore?: boolean;
 };
-
-/**
- * 生成自定义属性列表
- * 对目标平台的属性列表进行处理，获取转换后的自定义属性列表
- * */
-declare function createCategoryProperties(platform: Platform, pt_attrs: any[]): PropertyItem[];
-
-interface MatchGoods {
+type Condition = {
+    parent_id: string;
+    parent_value_ids: string[];
+};
+type DsyAttrValue = {
+    valueId: string | string[];
+    value: string | string[];
+};
+type DsyAttrWithValue = DsyAttr & DsyAttrValue;
+type MatchDatas = {
+    cate_id: string | number;
+    cate_path: string | string[];
+    platform: string;
+    properties: any[];
+    attrs?: any[];
     title?: string;
     goods_sn?: string;
     ccc_code?: string;
     remark?: string;
-}
-interface MatchDatas extends MatchGoods {
-    cate_id: string;
-    cate_path: string;
-    platform: Platform;
-    properties: any[];
-    attrs?: any[];
-}
+    specs?: any;
+};
 
 declare const _default: {
     version: string;
-    matchCategoryProperties: typeof matchCategoryProperties;
     createCategoryProperties: typeof createCategoryProperties;
+    matchCategoryProperties: typeof matchCategoryProperties;
     createCategoryPropertyTemplate: typeof createCategoryPropertyTemplate;
 };
 
+/**
+ * 转换自定义属性列表，
+ * */
+declare function createCategoryProperties(platform: Pt, ptAttrs: any): DsyAttr[] | null;
 /**
  * 匹配属性值
  * @param matchDatas 匹配数据
  * @param matchLevel 匹配等级
- * @param outType  匹配结果输出类型 group: 分组，template: 模板
+ * @param outType  匹配结果输出类型 group: 分组（已去除），template: 模板, list: 自定义属性列表(不含’品牌‘)
 * */
-declare function matchCategoryProperties(matchDatas: MatchDatas, matchLevel?: number, outType?: string): Promise<unknown>;
+declare function matchCategoryProperties(matchDatas: MatchDatas, matchLevel?: number, outType?: 'template' | 'list'): Promise<{
+    msg: string;
+    data: DsyAttrWithValue[];
+    code: number;
+} | {
+    msg: string;
+    data: goodsAttr[];
+    code: number;
+}>;
 /**
  *  创建分类属性模板
+ *
+ *  返回案例如下：
+ *  input: { attr_name: '货号', value: 'abc' };
+ *  date: { attr_name: '日期', value: '2025-8-1' };
+ *  inputComponent: { attr_name: '含量', value: '100%' };
+ *  singleSelect: { attr_name: '材质', value: '聚酯纤维' };
+ *  singleSelect: { attr_name: '材质', value: '聚酯纤维' };
+ *  multiSelect: { attr_name: '材质', value: '[聚酯纤维, 棉]' };
+ *  multiComplex: { attr_name: '材质', value: '[聚酯纤维[80%], 棉[20%]]' };
+ *  treeSingleSelect: { attr_name: '风格', value: '休闲风-简约风' };
  * */
-declare function createCategoryPropertyTemplate(properties: any[]): GoodsAttr[];
+declare function createCategoryPropertyTemplate(properties: (DsyAttrWithValue | goodsAttr)[]): goodsAttr[];
 
 export { _default as default };
+export type { ComponentType, Condition, DsyAttr, DsyAttrValue, DsyAttrWithValue, MatchDatas, PropertyComponent, PropertyType, Pt, Rule, RuleName, goodsAttr, propertyOption };