icms-api 0.0.1

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

@@ -0,0 +1,150 @@
+import { ImageVO, MemberSrv, SeoProps } from './site';
+/**
+ * 附件类型
+ */
+export type AttachmentType = 'image' | 'video' | 'audio' | 'file';
+/**
+ * 附件
+ */
+export interface AttachmentVO {
+    id: string;
+    name: string;
+    size: number;
+    url: string;
+    type: AttachmentType;
+}
+/**
+ * 内容基类,隶属网站
+ */
+interface OwnerWebSite {
+    id: string;
+    /**
+     * 语言站点编号
+     */
+    websiteNo: string;
+    /**
+     * 具体内容编号
+     */
+    entityNo: string;
+    /**
+     * 隶属栏目层级,如(channelNoLevel)
+     */
+    channelNoLevel: string;
+    /**
+     * 创建时间
+     */
+    createTime: string;
+    /**
+     * 排序
+     */
+    sortBy: number;
+    /**
+     * Seo相关属性
+     */
+    seoProps?: SeoProps;
+}
+/**
+ * 基础内容类
+ */
+export interface AbsContent extends OwnerWebSite {
+    /**
+     * 内容标题
+     */
+    title: string;
+    /**
+     * 内容简介
+     */
+    shortDesc?: string;
+    /**
+     * 关键字
+     */
+    keywords?: string;
+    /**
+     * 内容图片列表
+     */
+    imageList?: Array<ImageVO>;
+    /**
+     * 附件列表
+     */
+    attachments?: Array<AttachmentVO>;
+    /**
+     * 缩略图
+     */
+    thumbUrl?: string;
+}
+export type OwnerUser = {
+    id: string;
+    name: string;
+    nickname?: string;
+    avatar?: string;
+    userType: number;
+};
+export type MemberSrvProp = {
+    memberSrvSet: Set<MemberSrv>;
+};
+/**
+ * 知识付费基类
+ */
+export interface AbsCopyrightContent extends AbsContent {
+    /**
+     * 作者
+     */
+    author?: string;
+    /**
+     * 来源
+     */
+    source?: string;
+    /**
+     * 官方发布
+     */
+    official: boolean;
+    /**
+     * 发布人
+     */
+    ownerInfo?: OwnerUser;
+    /**
+     * 查阅权限,即当前登录用户有对应的会员卡方可以查看(集合中fee==0或该字段为空、所属最近层级的栏目memberSrvProp为空或fee==0的除外)
+     */
+    memberSrvProp?: MemberSrvProp;
+}
+/**
+ * 内容分组
+ */
+export interface ContentGroup<T> {
+    id: string;
+    websiteId: string;
+    groupNo: string;
+    groupName: string;
+    groupDesc?: string;
+    image?: ImageVO;
+    sortBy: number;
+    groupSets: Array<T>;
+}
+export interface GroupSet<T extends AbsContent> {
+    contentObject: T;
+}
+export interface PageInfo<T> {
+    total: number;
+    pageSize: number;
+    pageCount: number;
+    pageNo: number;
+    first: boolean;
+    last: boolean;
+    content: Array<T>;
+}
+/**
+ * 分页参数
+ */
+export type PageParams = {
+    /**
+     * 排序
+     */
+    sort?: 'ASC' | 'DESC';
+    /**
+     * 排序字段
+     */
+    sortBy?: string;
+    pageNo: number;
+    pageSize: number;
+};
+export {};

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

@@ -0,0 +1,53 @@
+import { ChannelType, WebsiteOwner } from './site';
+/**
+ * 评论内容
+ */
+export interface Reviews extends WebsiteOwner {
+    /**
+     * 被评论内容的类型
+     */
+    reviewType: ChannelType;
+    /**
+     * 被评论内容编号
+     */
+    entityNo: string;
+    /**
+     * 评论人
+     */
+    name: string;
+    /**
+     * 评论人ID,即loginUserId, 如果允许未登录评论则uid为空
+     */
+    uid?: string;
+    /**
+     * 评论人头像
+     */
+    avatar?: string;
+    /**
+     * 评级
+     * 如最多5颗星
+     * 0没给评级,1表示一颗星,2表示2颗星等等
+     * 排序desc
+     */
+    rating: number;
+    /**
+     * 评论内容,可能为空
+     */
+    message?: string;
+    /**
+     * 评论时间
+     */
+    createTime: string;
+    /**
+     * 是否可见状态
+     */
+    visible: boolean;
+    /**
+     * 是否管理模似输入
+     */
+    custom?: boolean;
+    /**
+     * 模似输入时间
+     */
+    createdAt?: string;
+}

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

@@ -0,0 +1,14 @@
+import { AbsCopyrightContent } from './cms-base';
+export interface NewsContent extends AbsCopyrightContent {
+    jumpUrl?: string;
+    details?: {
+        /**
+         * 简介
+         */
+        introduction?: string;
+        /**
+         * 详情
+         */
+        description?: string;
+    };
+}

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

@@ -0,0 +1,29 @@
+import { AbsContent } from './cms-base';
+export interface ProductContent extends AbsContent {
+    /**
+     * 规格说明
+     */
+    specification?: string;
+    /**
+     * 产品品特性
+     */
+    features?: string;
+    /**
+     * 产品价格
+     */
+    salePrice: number;
+    /**
+     * 市场价格
+     */
+    marketPrice?: number;
+    details?: {
+        /**
+         * 产品简介
+         */
+        introduction?: string;
+        /**
+         * 产品详情
+         */
+        description?: string;
+    };
+}

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

@@ -0,0 +1,3 @@
+export type { AttachmentType, AttachmentVO, PageInfo, PageParams, OwnerUser, MemberSrvProp } from './cms-base';
+export * from './cms-product';
+export * from './cms-news';

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

@@ -0,0 +1,293 @@
+/**
+ * (国际化)语言站点,用于语言站点切换
+ */
+export interface I18NWebsite {
+    /**
+     * 后端语言枚举,如zh_CN,en等
+     */
+    id: string;
+    /**
+     * 后端语言枚举对应的code,与前端locale值是对应的
+     * 如(zh-CN,en),与ID不同是中横线与下横线，因为后端为java,枚举不能使用中横线定义,为了与前端对应所以增加了该code字段
+     */
+    code: string;
+    /**
+     * 后端语言枚举对应的name(如"简体中文"、"English"等)
+     */
+    name: string;
+    /**
+     * 后端语言枚举对应的icon(如国旗)
+     */
+    icon: string;
+    /**
+     * 站点id(即Websit实体主键)
+     */
+    websiteId: string;
+    /**
+     * 站点编号(即Websit实体编号,全局唯一)
+     */
+    websiteNo: string;
+}
+/**
+ * SEO属性
+ */
+export type SeoProps = {
+    title?: string;
+    keywords?: string;
+    description?: string;
+};
+/**
+ * 站点实体(与Website是一对多关系)
+ */
+export interface Site {
+    id: string;
+    description?: string;
+    url?: string;
+    qrcodeUrl?: string;
+    wxQrcodeUrl?: string;
+    icpNumber?: string;
+    safeDomains?: string;
+    apiKey: string;
+    webSiteList?: Array<WebSite>;
+}
+/**
+ * 网站实体
+ */
+export interface WebSite {
+    id: string;
+    name: string;
+    /**
+     * 网站别名
+     */
+    aliasName?: string;
+    /**
+     * 言语,对应 I18NWebsite.id
+     */
+    language: string;
+    /**
+     * 网站简介
+     */
+    description?: string;
+    /**
+     * 网站编号
+     */
+    websiteNo: string;
+    contactPhone?: string;
+    contactEmail?: string;
+    contactAddr?: string;
+    contactQrCode?: string;
+    /**
+     * 允许插入js代码，encode后保存,前端需要decode后才能使用
+     */
+    scriptContent?: string;
+    /**
+     * ICMS接口到期时间,即ICMS系统API调到到期时间
+     */
+    dueTime?: string;
+    /**
+     * 网站创建时间
+     */
+    createTime?: string;
+    /**
+     * 是否默认网站,输入网站优先打开默认网站，如果没有默认即打开Site下属网站的第一个网站
+     */
+    defaultSite?: boolean;
+    /**
+     * Cookie 政策内容公示的内容,即用户打开网站时，公示Cookie使用政策(用户点击“接受”或“不接受”)
+     */
+    agreement?: string;
+    /**
+     * 网站SEO相关设置
+     */
+    seoProps?: SeoProps;
+    /**
+     * 网站不可用状态,true为不可用,false表示可用
+     */
+    unavailable: boolean;
+    /**
+     * 网站备案号(引用的是site.icpNumber)
+     */
+    icpNumber?: string;
+    /**
+     * 网址二维码(引用的是site.qrcodeUrl)
+     */
+    qrcodeUrl?: string;
+    /**
+     * 微信二维码
+     */
+    wxQrcodeUrl?: string;
+    /**
+     * 网站导航菜单
+     */
+    websiteNavVOList?: Array<WebsiteNavVO>;
+    /**
+     * 友情链接(sortBy 升序前20个链接)
+     */
+    friendLinksList?: Array<FriendLink>;
+}
+export interface Webchannel {
+    id: string;
+    /**
+     * 栏目类型
+     */
+    channelType: ChannelType;
+    /**
+     * 栏目编号，全局唯一
+     */
+    channelNo: string;
+    /**
+     * 栏目名称/标题
+     */
+    name: string;
+    /**
+     * 栏目URI
+     */
+    uri: string;
+    /**
+     * 栏目图片
+     */
+    image?: ImageVO;
+    /**
+     * 跳转链接
+     */
+    jumpUrl?: string;
+    /**
+     * 跳转链接的名称
+     */
+    jumpText?: string;
+    /**
+     * 栏目子标题
+     */
+    subTitle?: string;
+    /**
+     * 自定义标记
+     */
+    tagLabel?: string;
+    /**
+     * 栏目简介
+     */
+    introduction?: string;
+    /**
+     * 栏目下的Banner图片，可以用作轮播动画
+     */
+    banners?: Array<ImageVO>;
+    /**
+     * 栏目级别,由channelNo组成
+     * 格式如channelNo,channelNo,channelNo,
+     * 解释如当前栏目level值为channelNo1,channelNo2,channelNo3,
+     * 那么当前栏目的父级栏目为channelNo3,channelNo3的父级栏目为channelNo2,依次类推,根栏目level为空
+     * 注意：系统最多允许设置三级栏目
+     */
+    level?: string;
+    /**
+     * 栏目排序,接口返回是按升序排序的
+     */
+    sortBy: number;
+    /**
+     * 返回值与channelNo一致
+     */
+    key: string;
+    /**
+     * 返回复与name一致
+     */
+    title: string;
+    /**
+     * 隶属语言站点ID(全局唯一)
+     */
+    websiteId: string;
+    /**
+     * 隶属语言站点编号(全局唯一)
+     */
+    websiteNo: string;
+    /**
+     * 样
+     */
+    seoProps?: SeoProps;
+    children?: Array<WebsiteNavVO>;
+}
+/**
+ * 友情链接
+ */
+export interface FriendLink {
+    /**
+     * id
+     */
+    id: string;
+    /**
+     * 链接名称
+     */
+    name: string;
+    /**
+     * 排序
+     */
+    sortBy: number;
+    /**
+     * 链接说明
+     */
+    description?: string;
+    /**
+     * 链接网址
+     */
+    url: string;
+    /**
+     * 是否可见
+     */
+    visible: boolean;
+}
+export type WebsiteNavVO = Pick<Webchannel, 'id' | 'name' | 'channelNo' | 'channelType' | 'uri' | 'image' | 'jumpUrl' | 'jumpText' | 'subTitle' | 'level' | 'sortBy' | 'children'>;
+/**
+ * 栏目类型
+ */
+export type ChannelType = 'page' | 'product' | 'article' | 'photo' | 'video' | 'activity';
+/**
+ * 会员卡收费方式
+ */
+export type MemberFeeType = 'monthly' | 'quarterly' | 'year' | 'forever';
+export type ImageVO = {
+    id: string;
+    name?: string;
+    thumbUrl: string;
+    imageUrl: string;
+};
+export type Metadata = {
+    title?: string;
+    description?: string;
+    keywords?: string;
+    authors?: {
+        url: string;
+        name: string;
+    };
+    [k: string]: unknown;
+};
+export type WebsiteInfo = {
+    "website": WebSite;
+    "i18nSites": Array<I18NWebsite>;
+    "metadata"?: Metadata;
+};
+/**
+ * 会员用户相关资源的所有者
+ */
+export interface Owner {
+    id: string;
+    teamId: string;
+    siteId: string;
+}
+/**
+ * 隶属网站相关
+ */
+export interface WebsiteOwner extends Owner {
+    websiteId: string;
+}
+/**
+ * 会员增值服务
+ */
+export interface MemberSrv extends WebsiteOwner {
+    id: string;
+    /**
+     * 会员购买时记录该字段code,后台订单会自动翻译对应的会员卡
+     */
+    code: string;
+    name: string;
+    feeType: MemberFeeType;
+    fee?: number;
+}

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "icms-api",
+  "private": false,
+  "version": "0.0.1",
+  "description": "对iCMS内容管理系统API的封装，使用该API能快速使用iCMS搭建您的WebApp!",
+  "type": "module",
+  "main": "./dist/icms-api.cjs.js",
+  "module": "./dist/icms-api.es.js",
+  "browser": "./dist/icms-api.umd.js",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/icms-api.es.js",
+      "require": "./dist/icms-api.cjs.js",
+      "default": "./dist/icms-api.es.js"
+    }
+  },
+  "types": "./dist/types/index.d.ts",
+  "files": [
+    "dist/**/*"
+  ],
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "build:types": "tsc --emitDeclarationOnly --outDir dist/types",
+    "test": "vitest run",
+    "preview": "vite preview",
+    "prepublishOnly": "npm run build",
+    "nextjs:dev": "cd simple-nextjs && npm install && npm run dev",
+    "nuxtjs:dev": "cd simple-nuxtjs && npm install && npm run dev"
+  },
+  "keywords": [
+    "cms",
+    "website",
+    "app",
+    "api",
+    "wechat"
+  ],
+  "author": "Rock.chen<szygnet@qq.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/rockychen2016/icms-api.git"
+  },
+  "bugs": {
+    "url": "https://github.com/rockychen2016/icms-api/issues"
+  },
+  "homepage": "https://github.com/rockychen2016/icms-api#readme",
+  "devDependencies": {
+    "@types/node": "^25.0.3",
+    "typescript": "~5.9.3",
+    "vite": "^7.2.4",
+    "vite-plugin-dts": "^4.5.4",
+    "vitest": "^1.0.0"
+  },
+  "dependencies": {
+    "iboot-http-client": "^1.4.8"
+  }
+}