icms-api 0.1.2 → 0.1.3

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

@@ -0,0 +1,3 @@
+export * from './types/site';
+export * from './types/cms';
+export * from './client';

package/dist/types/client.d.ts

@@ -1,13 +1,109 @@
+import { Member, FriendLink, LinkGroup, I18NWebsite, Webchannel, WebsiteInfo } from './types/site';
+import { ProductContent } from './types/cms-product';
+import { PageInfo, PageParams } from './types/cms-base';
+import { NewsContent } from './types/cms-news';
+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 { Member } from './types/site';
 export declare class ICMSClient {
     private cookies;
     constructor();
-    submitComment(): Promise<void>;
     setICookies(c: ICookies): ICMSClient;
     login({ username, password }: Readonly<{
         username: string;
         password: string;
     }>): Promise<Member | undefined>;
     logout(): Promise<void>;
+    loadI18nList(): Promise<Array<I18NWebsite>>;
+    loadWebsite(params?: Readonly<{
+        showNav?: boolean;
+        showFriendLink?: boolean;
+        showI18NList?: boolean;
+    }>): Promise<WebsiteInfo | undefined>;
+    loadChannels(params?: Readonly<{
+        channelNo?: string;
+        showChildren?: boolean;
+    }>): Promise<Array<Webchannel>>;
+    loadChannelById(params: Readonly<{
+        channelId: string;
+        showChildren?: boolean;
+    }>): Promise<Webchannel | undefined>;
+    loadChannelByNo(params: Readonly<{
+        channelNo: string;
+        showChildren?: boolean;
+    }>): Promise<Webchannel | undefined>;
+    loadChannelByUri(params: Readonly<{
+        uri: string;
+        showChildren?: boolean;
+    }>): Promise<Webchannel | undefined>;
+    loadProductDetail(proId: string): Promise<ProductContent | undefined>;
+    loadProductPageInfo(params: Readonly<{
+        channelId?: string;
+        keyword?: string;
+    } & PageParams>): Promise<PageInfo<ProductContent> | undefined>;
+    loadProductPageInfoByGroup(params: Readonly<{
+        groupId: string;
+    } & PageParams>): Promise<PageInfo<ProductContent> | undefined>;
+    loadProductListByGroupId(params: Readonly<{
+        groupId: string;
+    }>): Promise<Array<ProductContent>>;
+    loadNewsDetail(newId: string): Promise<NewsContent | undefined>;
+    loadNewsPageInfo(params: Readonly<{
+        channelNo?: string;
+        keyword?: string;
+    } & PageParams>): Promise<PageInfo<NewsContent> | undefined>;
+    loadNewsPageInfoByGroupId(params: Readonly<{
+        groupId: string;
+    } & PageParams>): Promise<PageInfo<NewsContent> | undefined>;
+    loadNewsListByGroupId(params: Readonly<{
+        groupId: string;
+    }>): Promise<Array<NewsContent>>;
+    loadPhotoDetail(photoId: string): Promise<PhotoContent | undefined>;
+    loadPhotoPageInfo(params: Readonly<{
+        channelNo?: string;
+        keyword?: string;
+    } & PageParams>): Promise<PageInfo<PhotoContent> | undefined>;
+    loadPhotoPageInfoByGroup(params: Readonly<{
+        groupId: string;
+    } & PageParams>): Promise<PageInfo<PhotoContent> | undefined>;
+    loadPhotoListByGroupId(params: Readonly<{
+        groupId: string;
+    }>): Promise<Array<PhotoContent>>;
+    loadVideoDetail(videoId: string): Promise<VideoContent | undefined>;
+    loadVideoPageInfo(params: Readonly<{
+        channelNo?: string;
+        keyword?: string;
+    } & PageParams>): Promise<PageInfo<VideoContent> | undefined>;
+    loadVideoPageInfoByGroup(params: Readonly<{
+        groupId: string;
+    } & PageParams>): Promise<PageInfo<VideoContent> | undefined>;
+    loadVideoListByGroupId(params: Readonly<{
+        groupId: string;
+    }>): Promise<Array<VideoContent>>;
+    loadActivityDetail(activityId: string): Promise<ActivityContent | undefined>;
+    loadActivityPageInfo(params: Readonly<{
+        channelNo?: string;
+        keyword?: string;
+    } & PageParams>): Promise<PageInfo<ActivityContent> | undefined>;
+    loadActivityPageInfoByGroup(params: Readonly<{
+        groupId: string;
+    } & PageParams>): Promise<PageInfo<ActivityContent> | undefined>;
+    loadActivityListByGroupId(params: Readonly<{
+        groupId: string;
+    }>): Promise<Array<ActivityContent>>;
+    loadReviewList(params: Readonly<{
+        entityNo?: string;
+        rowCount?: string;
+    }>): Promise<Array<Reviews>>;
+    submitComment(data: Readonly<Partial<Reviews>>): Promise<boolean>;
+    subscribe(data: Readonly<Pick<SubscribeUser, 'email'> & Partial<Pick<SubscribeUser, 'nickname'>>>): Promise<boolean>;
+    submitContactUs(data: Readonly<Partial<ContactUs>>): Promise<boolean>;
+    loadLinkGroups(): Promise<Array<LinkGroup>>;
+    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>;
 }
+export declare const icmsClient: ICMSClient;

package/dist/types/index.d.ts

@@ -2,4 +2,3 @@ export * from './types/site';
 export * from './types/cms';
 export * from './server';
 export * from './router';
-export * from './client';

package/dist/types/server.d.ts

@@ -1,9 +1,13 @@
 import { ICookies } from '@rock.chen/icms-http-client';
-import { I18NWebsite, Webchannel, WebsiteInfo } from './types/site';
+import { I18NWebsite, Webchannel, WebsiteInfo, FriendLink, LinkGroup } from './types/site';
 import { ProductContent } from './types/cms-product';
 import { PageInfo, PageParams } from './types/cms-base';
 import { NewsContent } from './types/cms-news';
-import { Reviews } from './types/cms-message';
+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';
 export declare const helloURL: string;
 export declare class ICMSServer {
     private readonly http;
@@ -122,8 +126,138 @@ export declare class ICMSServer {
     loadNewsListByGroupId(params: Readonly<{
         groupId: string;
     }>): Promise<Array<NewsContent>>;
+    /**
+     * 获取相册详情
+     * @param photoId
+     * @returns
+     */
+    loadPhotoDetail(photoId: string): Promise<PhotoContent | undefined>;
+    /**
+     * 分页获取相册列表
+     * @param params {channelNo?:指定栏目下的内容, keyword?:关键字查询, pageNo:页码, pageSize:每页记录数, sortBy?:指定排序字段, sort?:排序方向'ASC' | 'DESC'}
+     * @returns
+     */
+    loadPhotoPageInfo(params: Readonly<{
+        channelNo?: string;
+        keyword?: string;
+    } & PageParams>): Promise<PageInfo<PhotoContent>>;
+    /**
+     * 按分组分页获取相册列表
+     * @param params {groupId:分组ID, pageNo:页码, pageSize:每页记录数, sortBy?:指定排序字段, sort?:排序方向'ASC' | 'DESC'}
+     * @returns
+     */
+    loadPhotoPageInfoByGroup(params: Readonly<{
+        groupId: string;
+    } & PageParams>): Promise<PageInfo<PhotoContent>>;
+    /**
+     * 按分组获取相册列表
+     * @param params
+     * @returns
+     */
+    loadPhotoListByGroupId(params: Readonly<{
+        groupId: string;
+    }>): Promise<Array<PhotoContent>>;
+    /**
+     * 获取视频详情
+     * @param videoId
+     * @returns
+     */
+    loadVideoDetail(videoId: string): Promise<VideoContent | undefined>;
+    /**
+     * 分页获取视频列表
+     * @param params {channelNo?:指定栏目下的内容, keyword?:关键字查询, pageNo:页码, pageSize:每页记录数, sortBy?:指定排序字段, sort?:排序方向'ASC' | 'DESC'}
+     * @returns
+     */
+    loadVideoPageInfo(params: Readonly<{
+        channelNo?: string;
+        keyword?: string;
+    } & PageParams>): Promise<PageInfo<VideoContent>>;
+    /**
+     * 按分组分页获取视频列表
+     * @param params {groupId:分组ID, pageNo:页码, pageSize:每页记录数, sortBy?:指定排序字段, sort?:排序方向'ASC' | 'DESC'}
+     * @returns
+     */
+    loadVideoPageInfoByGroup(params: Readonly<{
+        groupId: string;
+    } & PageParams>): Promise<PageInfo<VideoContent>>;
+    /**
+     * 按分组获取视频列表
+     * @param params
+     * @returns
+     */
+    loadVideoListByGroupId(params: Readonly<{
+        groupId: string;
+    }>): Promise<Array<VideoContent>>;
+    /**
+     * 获取活动详情
+     * @param activityId
+     * @returns
+     */
+    loadActivityDetail(activityId: string): Promise<ActivityContent | undefined>;
+    /**
+     * 分页获取活动列表
+     * @param params {channelNo?:指定栏目下的内容, keyword?:关键字查询, pageNo:页码, pageSize:每页记录数, sortBy?:指定排序字段, sort?:排序方向'ASC' | 'DESC'}
+     * @returns
+     */
+    loadActivityPageInfo(params: Readonly<{
+        channelNo?: string;
+        keyword?: string;
+    } & PageParams>): Promise<PageInfo<ActivityContent>>;
+    /**
+     * 按分组分页获取活动列表
+     * @param params {groupId:分组ID, pageNo:页码, pageSize:每页记录数, sortBy?:指定排序字段, sort?:排序方向'ASC' | 'DESC'}
+     * @returns
+     */
+    loadActivityPageInfoByGroup(params: Readonly<{
+        groupId: string;
+    } & PageParams>): Promise<PageInfo<ActivityContent>>;
+    /**
+     * 按分组获取活动列表
+     * @param params
+     * @returns
+     */
+    loadActivityListByGroupId(params: Readonly<{
+        groupId: string;
+    }>): Promise<Array<ActivityContent>>;
+    /**
+     * 获取评论列表
+     */
     loadReviewList(params: Readonly<{
         entityNo?: string;
         rowCount?: string;
     }>): Promise<Array<Reviews>>;
+    /**
+     * 发表评论
+     * @param data 评论数据
+     */
+    submitComment(data: Readonly<Partial<Reviews>>): Promise<boolean>;
+    /**
+     * 订阅
+     * @param data 订阅数据 {email, nickname?}
+     */
+    subscribe(data: Readonly<Pick<SubscribeUser, 'email'> & Partial<Pick<SubscribeUser, 'nickname'>>>): Promise<boolean>;
+    /**
+     * 联系我们留言
+     * @param data 留言数据
+     */
+    submitContactUs(data: Readonly<Partial<ContactUs>>): Promise<boolean>;
+    /**
+     * 获取链接分组列表（含友链）
+     */
+    loadLinkGroups(): Promise<Array<LinkGroup>>;
+    /**
+     * 获取友情链接列表
+     * @param count 获取数量，不传则全部
+     */
+    loadFriendLinks(count?: number): Promise<Array<FriendLink>>;
+    /**
+     * 申请添加友链
+     * @param data 友链数据 {name, url, description?}
+     */
+    submitLink(data: Readonly<Pick<FriendLink, 'name' | 'url'> & Partial<Pick<FriendLink, 'description'>>>): Promise<boolean>;
+    /**
+     * 获取商品规格描述
+     * @param code 规格编码
+     */
+    getSpecDescription(code: string): Promise<SpecDescription | undefined>;
 }

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

@@ -0,0 +1,22 @@
+import { AbsContent } from './cms-base';
+/**
+ * 活动内容
+ */
+export interface ActivityContent extends AbsContent {
+    /** 活动开始时间 */
+    startTime?: string;
+    /** 活动结束时间 */
+    endTime?: string;
+    /** 活动地点 */
+    location?: string;
+    details?: {
+        /**
+         * 活动简介
+         */
+        introduction?: string;
+        /**
+         * 活动详情
+         */
+        description?: string;
+    };
+}

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

@@ -0,0 +1,14 @@
+/**
+ * 商城规格描述
+ */
+export interface SpecDescription {
+    id: string;
+    /** 规格编码 */
+    code: string;
+    /** 规格描述内容 */
+    description?: string;
+    /** 规格图片列表 */
+    images?: Array<string>;
+    /** JSON格式的额外属性 */
+    props?: Record<string, string>;
+}

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

@@ -51,3 +51,35 @@ export interface Reviews extends WebsiteOwner {
      */
     createdAt?: string;
 }
+/**
+ * 订阅用户
+ */
+export interface SubscribeUser extends WebsiteOwner {
+    /** 用户昵称 */
+    nickname?: string;
+    /** 邮箱 */
+    email: string;
+    /** 是否已取消订阅 */
+    cancelSubscribe: boolean;
+    /** 订阅时间 */
+    subscribeTime: string;
+}
+/**
+ * 联系我们留言
+ */
+export interface ContactUs extends WebsiteOwner {
+    /** 留言用户姓名 */
+    name: string;
+    /** 电话 */
+    phone?: string;
+    /** 邮箱 */
+    email?: string;
+    /** 主题 */
+    subject?: string;
+    /** 留言内容 */
+    message?: string;
+    /** 转发邮箱 */
+    forwardEmail?: string;
+    /** 创建时间 */
+    createTime: string;
+}

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

@@ -0,0 +1,16 @@
+import { AbsContent } from './cms-base';
+/**
+ * 相册内容
+ */
+export interface PhotoContent extends AbsContent {
+    details?: {
+        /**
+         * 相册简介
+         */
+        introduction?: string;
+        /**
+         * 相册详情
+         */
+        description?: string;
+    };
+}

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

@@ -0,0 +1,18 @@
+import { AbsContent } from './cms-base';
+/**
+ * 视频内容
+ */
+export interface VideoContent extends AbsContent {
+    /** 视频链接 */
+    videoUrl?: string;
+    details?: {
+        /**
+         * 视频简介
+         */
+        introduction?: string;
+        /**
+         * 视频详情
+         */
+        description?: string;
+    };
+}

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

@@ -1,3 +1,8 @@
 export type { AttachmentType, AttachmentVO, PageInfo, PageParams, OwnerUser, MemberSrvProp } from './cms-base';
 export * from './cms-product';
 export * from './cms-news';
+export * from './cms-photo';
+export * from './cms-video';
+export * from './cms-activity';
+export * from './cms-message';
+export * from './cms-mall';

package/dist/types/types/site.d.ts

@@ -235,6 +235,16 @@ export interface FriendLink {
      */
     visible: boolean;
 }
+/**
+ * 链接分组
+ */
+export interface LinkGroup {
+    id: string;
+    /** 分组名称 */
+    name: string;
+    /** 分组下的链接列表 */
+    friendLinkList?: Array<FriendLink>;
+}
 export type WebsiteNavVO = Pick<Webchannel, 'id' | 'name' | 'channelNo' | 'channelType' | 'uri' | 'image' | 'jumpUrl' | 'jumpText' | 'subTitle' | 'level' | 'sortBy' | 'children'>;
 /**
  * 栏目类型

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "icms-api",
   "private": false,
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "对iCMS内容管理系统API的封装，使用该API能快速使用iCMS搭建您的WebApp!",
   "type": "module",
   "main": "./dist/icms-api.cjs.js",
@@ -13,6 +13,12 @@
       "import": "./dist/icms-api.es.js",
       "require": "./dist/icms-api.cjs.js",
       "default": "./dist/icms-api.es.js"
+    },
+    "./client": {
+      "types": "./dist/types/client-entry.d.ts",
+      "import": "./dist/icms-api.client.es.js",
+      "require": "./dist/icms-api.client.cjs.js",
+      "default": "./dist/icms-api.client.es.js"
     }
   },
   "types": "./dist/types/index.d.ts",
@@ -21,7 +27,7 @@
   ],
   "scripts": {
     "dev": "vite",
-    "build": "tsc && vite build",
+    "build": "tsc && vite build && vite build --config vite.client.config.ts",
     "build:types": "tsc --emitDeclarationOnly --outDir dist/types",
     "test": "vitest run",
     "preview": "vite preview",