icms-api 0.1.3 → 0.1.5

package/dist/types/client-helper.d.ts

@@ -0,0 +1,78 @@
+/**
+ * 客户端 HTTP 辅助函数
+ * 从 @rock.chen/icms-http-client/web-client 内联，
+ * 避免引入 pino/pino-pretty/sonic-boom 等 Node.js 服务端模块
+ */
+/** Cookie 读写接口 */
+export interface ICookies {
+    get(key: string): string | undefined;
+    set?(key: string, value: string): void;
+    delete?(key: string): void;
+}
+/** API 返回模型 */
+export interface ResultModel<T = unknown> {
+    code: number;
+    success: boolean;
+    msg: string;
+    data?: T;
+    headers?: Record<string, string>;
+}
+/** GET 请求参数 */
+export interface ClientGetParams {
+    data?: Record<string, string>;
+    headers?: Record<string, string>;
+    useCache?: boolean;
+    showError?: (msg: string) => void;
+}
+/** POST 请求参数 */
+export interface ClientPostParams {
+    data?: Record<string, unknown> | FormData;
+    headers?: Record<string, string>;
+    showError?: (msg: string) => void;
+    showSuccess?: (msg: string) => void;
+}
+/** Cookie 名称常量 */
+export declare const COOKIE_NAMES: {
+    readonly IBOOT_DEVICE_ID: "dvid";
+    readonly IBOOT_LANG: "lang";
+    readonly IBOOT_WEBSITE_ID: "wid";
+    readonly IBOOT_WEBSITE_NO: "wno";
+    readonly IBOOT_TOKEN: "token";
+    readonly IBOOT_USER: "user";
+};
+/** Content-Type 常量 */
+export declare const CONTENT_TYPE_KEY = "Content-Type";
+export declare const CONTENT_TYPE_MAP: {
+    readonly applicationJson: "application/json";
+    readonly multipartFormData: "multipart/form-data";
+    readonly applicationXwwwFormUrlencoded: "application/x-www-form-urlencoded";
+};
+/** 用户信息 */
+export interface User {
+    id: string;
+    name: string;
+    userType: number;
+    username?: string;
+    nickname?: string;
+    sex?: number;
+    headImg?: string;
+    lastLoginTime?: string;
+    tokenExpired?: string;
+    deviceId?: string;
+    status?: number;
+    accountType?: number;
+    enabled?: boolean;
+    userFrom?: number;
+    needToReview?: boolean;
+    socketOnline?: boolean;
+    createTime?: string;
+    mustChangePwd?: boolean;
+}
+/** 从 cookie 中读取已登录用户信息 */
+export declare const getLoginUser: (cookies: ICookies) => User | undefined;
+/** GET 请求快捷方法（自动解包 data） */
+export declare const iGet: <T>(url: string, opts?: ClientGetParams) => Promise<T | undefined>;
+/** POST 请求快捷方法（自动解包 data） */
+export declare const iPost: <T>(url: string, opts?: ClientPostParams) => Promise<T | undefined>;
+/** POST 请求，返回 boolean */
+export declare const iPostSuccess: (url: string, opts?: ClientPostParams) => Promise<boolean>;

package/dist/types/client.d.ts

@@ -6,8 +6,8 @@ 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 { ICookies } from '@rock.chen/icms-http-client';
+import { SpecDescription, GoodsItem, GoodsCategory, GoodsTag } from './types/cms-mall';
+import { ICookies } from './client-helper';
 export declare class ICMSClient {
     private cookies;
     constructor();
@@ -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,54 @@ export interface SpecDescription {
     /** JSON格式的额外属性 */
     props?: Record<string, string>;
 }
+/** 商品图片 */
+export interface GoodsImage {
+    id?: string;
+    url?: string;
+    alt?: string;
+    sort?: number;
+}
+/** 商品视频 */
+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.3",
+  "version": "0.1.5",
   "description": "对iCMS内容管理系统API的封装，使用该API能快速使用iCMS搭建您的WebApp!",
   "type": "module",
   "main": "./dist/icms-api.cjs.js",