icms-api 0.1.4 → 0.1.6

package/dist/types/client.d.ts

@@ -6,7 +6,7 @@ import { PhotoContent } from './types/cms-photo';
 import { VideoContent } from './types/cms-video';
 import { ActivityContent } from './types/cms-activity';
 import { Reviews, SubscribeUser, ContactUs } from './types/cms-message';
-import { SpecDescription } from './types/cms-mall';
+import { SpecDescription, GoodsItem, GoodsCategory, GoodsTag } from './types/cms-mall';
 import { ICookies } from './client-helper';
 export declare class ICMSClient {
     private cookies;
@@ -105,5 +105,19 @@ export declare class ICMSClient {
     loadFriendLinks(count?: number): Promise<Array<FriendLink>>;
     submitLink(data: Readonly<Pick<FriendLink, 'name' | 'url'> & Partial<Pick<FriendLink, 'description'>>>): Promise<boolean>;
     getSpecDescription(code: string): Promise<SpecDescription | undefined>;
+    /** 获取商品标签字典 */
+    loadGoodsTagList(): Promise<Array<GoodsTag>>;
+    /** 获取所有货架（类目）列表 */
+    loadGoodsShelves(): Promise<Array<GoodsCategory>>;
+    /** 获取指定货架的商品列表 */
+    loadCategoryGoods(params: Readonly<{
+        cateCode: string;
+        count?: number;
+    }>): Promise<Array<GoodsItem>>;
+    /** 分页搜索商品 */
+    searchGoods(params: Readonly<{
+        cateCode?: string;
+        keyword?: string;
+    } & PageParams>): Promise<PageInfo<GoodsItem> | undefined>;
 }
 export declare const icmsClient: ICMSClient;

package/dist/types/server.d.ts

@@ -7,7 +7,7 @@ import { PhotoContent } from './types/cms-photo';
 import { VideoContent } from './types/cms-video';
 import { ActivityContent } from './types/cms-activity';
 import { Reviews, SubscribeUser, ContactUs } from './types/cms-message';
-import { SpecDescription } from './types/cms-mall';
+import { SpecDescription, GoodsItem, GoodsCategory, GoodsTag } from './types/cms-mall';
 export declare const helloURL: string;
 export declare class ICMSServer {
     private readonly http;
@@ -260,4 +260,18 @@ export declare class ICMSServer {
      * @param code 规格编码
      */
     getSpecDescription(code: string): Promise<SpecDescription | undefined>;
+    /** 获取商品标签字典 */
+    loadGoodsTagList(): Promise<Array<GoodsTag>>;
+    /** 获取所有货架（类目）列表 */
+    loadGoodsShelves(): Promise<Array<GoodsCategory>>;
+    /** 获取指定货架的商品列表 */
+    loadCategoryGoods(params: Readonly<{
+        cateCode: string;
+        count?: number;
+    }>): Promise<Array<GoodsItem>>;
+    /** 分页搜索商品 */
+    searchGoods(params: Readonly<{
+        cateCode?: string;
+        keyword?: string;
+    } & PageParams>): Promise<PageInfo<GoodsItem>>;
 }

package/dist/types/types/cms-mall.d.ts

@@ -12,3 +12,57 @@ export interface SpecDescription {
     /** JSON格式的额外属性 */
     props?: Record<string, string>;
 }
+/** 商品图片 */
+export interface GoodsImage {
+    id: string;
+    /** 图片地址 */
+    imageUrl: string;
+    /** 缩略图地址 */
+    thumbUrl?: string;
+    /** 图片名称 */
+    name?: string;
+}
+/** 商品视频 */
+export interface GoodsVideo {
+    id?: string;
+    url?: string;
+    poster?: string;
+}
+/** 商品基础信息（用于列表展示） */
+export interface GoodsItem {
+    id: string;
+    code: string;
+    name: string;
+    unitCode: string;
+    salePrice: number;
+    marketPrice: number;
+    description?: string;
+    images?: Array<GoodsImage>;
+    video?: GoodsVideo;
+    tags?: string;
+    hidden?: boolean;
+    createTime?: string;
+    lastUpdateTime?: string;
+    /** 货架编码 */
+    cateCode?: string;
+    /** 货架名称（后端 Transient 填充） */
+    cateName?: string;
+}
+/** 货架（商品类目） */
+export interface GoodsCategory {
+    id: string;
+    /** 货架编码，格式 000-000-000-000-000 */
+    code: string;
+    name: string;
+    description?: string;
+    sortValue?: string;
+    /** 是否为叶子节点 */
+    leaf?: boolean;
+}
+/** 商品标签 */
+export interface GoodsTag {
+    id: string;
+    code: string;
+    name: string;
+    websiteNo?: string;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "icms-api",
   "private": false,
-  "version": "0.1.4",
+  "version": "0.1.6",
   "description": "对iCMS内容管理系统API的封装，使用该API能快速使用iCMS搭建您的WebApp!",
   "type": "module",
   "main": "./dist/icms-api.cjs.js",