@stackonward/cms-client 0.0.1

package/dist/types.d.ts

@@ -0,0 +1,311 @@
+import { RoutePolicy } from './routes.js';
+export { BuildRoutePathOptions, ResolvedRouteLocalePolicy, ResolvedRoutePolicy, RouteLocalePolicy, RouteParams, RoutePolicyConfig, RouteResourceDefaults, RouteResources } from './routes.js';
+
+/** 作者社交链接 */
+interface AuthorSocialLink {
+    kind?: string;
+    label: string;
+    href: string;
+    handle?: string;
+}
+/** 作者资料统计项 */
+interface AuthorProfileStat {
+    label: string;
+    value: string;
+    description?: string;
+}
+/** 作者资料问答项 */
+interface AuthorProfileQuestion {
+    label?: string;
+    text: string;
+}
+/** 作者资料内容分区 */
+interface AuthorProfileSection {
+    key: string;
+    eyebrow: string;
+    description?: string;
+    paragraphs?: string[];
+    questions?: AuthorProfileQuestion[];
+}
+/** 作者资料行动入口 */
+interface AuthorProfileCta {
+    label: string;
+    href: string;
+    title?: string;
+    description?: string;
+}
+/** 作者资料内容 */
+interface AuthorProfile {
+    eyebrow?: string;
+    role?: string;
+    role_line?: string;
+    lede?: string;
+    socials?: AuthorSocialLink[];
+    stats?: AuthorProfileStat[];
+    sections?: AuthorProfileSection[];
+    tags?: string[];
+    cta?: AuthorProfileCta;
+}
+/** 作者信息 (Go: delivery.DeliveryAuthorResponse) */
+interface Author {
+    id: number;
+    locale: string;
+    display_name: string;
+    slug: string;
+    avatar_url?: string;
+    bio?: string;
+    seo_meta?: Partial<SeoMeta>;
+    og_meta?: Partial<OgMeta>;
+    twitter_meta?: Partial<TwitterMeta>;
+    available_locales?: string[];
+    localized_slugs?: Record<string, string>;
+    profile?: AuthorProfile;
+}
+
+/** 多语言字符串 (Go: domain.LocalizedString = map[string]string) */
+type LocalizedString = Record<string, string>;
+/** 分页元信息 (Go: response.PaginationMeta) */
+interface PaginationMeta {
+    page: number;
+    page_size: number;
+    total: number;
+    total_pages: number;
+}
+/** 分页响应 (Go: response.Paginated[T]) */
+interface Paginated<T> {
+    data: T[];
+    pagination: PaginationMeta;
+}
+/** 列表响应 (Go: response.NewList[T]) */
+type ListResponse<T> = Paginated<T>;
+/** 分页查询参数 */
+interface PaginationParams {
+    page?: number;
+    page_size?: number;
+}
+
+/** 文章详情 (Go: delivery.DeliveryArticleResponse) */
+interface ArticleDetail {
+    slug: string;
+    title: string;
+    excerpt?: string;
+    content_html: string;
+    content_json?: unknown;
+    featured_image_url?: string;
+    featured_image_alt?: string;
+    category?: string;
+    tags: string[];
+    authors: Author[];
+    related_article_ids?: number[];
+    comment_count: number;
+    is_comment_enabled: boolean;
+    published_at: string | null;
+    last_published_at: string | null;
+    word_count: number;
+    reading_time_minutes: number;
+    seo_meta?: SeoMeta;
+    og_meta?: OgMeta;
+    twitter_meta?: TwitterMeta;
+    json_ld: unknown;
+    locale: string;
+    available_locales: string[];
+    localized_slugs?: Record<string, string>;
+}
+/** 文章列表项 (Go: delivery.DeliveryArticleListItem) */
+interface ArticleListItem {
+    slug: string;
+    title: string;
+    excerpt?: string;
+    featured_image_url?: string;
+    featured_image_alt?: string;
+    published_at: string | null;
+    last_published_at?: string | null;
+    reading_time_minutes: number;
+    category_slug?: string;
+    is_pinned: boolean;
+    tags: string[];
+    authors: Author[];
+}
+/** 文章列表查询参数 */
+interface ArticleListParams extends PaginationParams {
+    locale?: string;
+    category_id?: number;
+    category_slug?: string;
+    tag?: string;
+    is_pinned?: boolean;
+    sort_by?: string;
+    sort_order?: 'asc' | 'desc';
+}
+/** 文章搜索查询参数 */
+interface ArticleSearchParams extends PaginationParams {
+    locale?: string;
+    q: string;
+}
+/** 文章搜索结果项 */
+interface ArticleSearchResultItem {
+    article_id: number;
+    title: string;
+    excerpt?: string;
+    slug: string;
+    score: number;
+    category_slug?: string;
+    featured_image_url?: string;
+    featured_image_alt?: string;
+    published_at?: string | null;
+    last_published_at?: string | null;
+    reading_time_minutes?: number;
+    tags?: string[];
+    authors?: Author[];
+}
+/** SEO 元信息 */
+interface SeoMeta {
+    title: string | null;
+    description: string | null;
+    keywords: string | null;
+    robots: string | null;
+    canonical_url: string | null;
+}
+/** Open Graph 元信息 */
+interface OgMeta {
+    title: string | null;
+    description: string | null;
+    image: string | null;
+    url: string | null;
+    type: string | null;
+}
+/** Twitter Card 元信息 */
+interface TwitterMeta {
+    card: string | null;
+    title: string | null;
+    description: string | null;
+    image: string | null;
+}
+
+/** 本地化 SEO 元信息 */
+type LocalizedSeoMetaMap = Record<string, Partial<SeoMeta>>;
+/** 本地化 Open Graph 元信息 */
+type LocalizedOgMetaMap = Record<string, Partial<OgMeta>>;
+/** 本地化 Twitter Card 元信息 */
+type LocalizedTwitterMetaMap = Record<string, Partial<TwitterMeta>>;
+/** 分类树节点 (Go: delivery.CategoryNodeResponse) */
+interface CategoryNode {
+    id: number;
+    slug: string;
+    name: LocalizedString;
+    description: LocalizedString;
+    seo_meta?: LocalizedSeoMetaMap;
+    og_meta?: LocalizedOgMetaMap;
+    twitter_meta?: LocalizedTwitterMetaMap;
+    article_count: number;
+    article_counts?: Record<string, number>;
+    children?: CategoryNode[];
+}
+
+/** 评论树节点 (Go: delivery.CommentTreeResponse) */
+interface Comment {
+    id: number;
+    author_name: string;
+    author_url?: string;
+    content_html: string;
+    is_pinned: boolean;
+    like_count: number;
+    created_at: string;
+    children?: Comment[];
+}
+/** 发表评论请求 */
+interface CreateCommentPayload {
+    author_name: string;
+    author_email: string;
+    content: string;
+    parent_id?: number;
+}
+
+/** 重定向规则 (Go: delivery.RedirectRuleResponse) */
+type RedirectMatchType = 'exact' | 'prefix' | 'regex';
+interface RedirectRule {
+    source_path: string;
+    destination_path: string;
+    status_code: number;
+    match_type: RedirectMatchType;
+    priority: number;
+}
+
+/** 文章系列 (Go: delivery.DeliverySeriesResponse) */
+interface Series {
+    title: string;
+    slug: string;
+    description: string | null;
+    cover_image_url: string | null;
+    articles: ArticleListItem[];
+}
+
+type SiteDeliveryMode = 'isr' | 'static';
+type SiteDomainType = 'alias' | 'preview' | 'primary';
+interface SiteDomain {
+    scheme: 'http' | 'https';
+    host: string;
+    port?: number;
+    base_path: string;
+    domain_type: SiteDomainType;
+}
+interface SiteConfig {
+    site_code: string;
+    product_code: string;
+    site_name: string;
+    delivery_mode: SiteDeliveryMode;
+    canonical_base_url: string;
+    domains: SiteDomain[];
+    sitemap_path: string;
+    route_policy: RoutePolicy;
+    updated_at: string;
+}
+interface SiteConfigQuery {
+    site_code?: string;
+    host?: string;
+}
+
+/** Hreflang 条目 (Go: delivery.HreflangEntry) */
+interface HreflangEntry {
+    lang: string;
+    href: string;
+    route_params?: Record<string, string | number | boolean | null | undefined>;
+}
+/** Sitemap 图片条目 */
+interface SitemapImageEntry {
+    loc: string;
+    title?: string;
+}
+/** Sitemap 视频条目（Google Video Sitemap 扩展） */
+interface SitemapVideoEntry {
+    thumbnail_loc: string;
+    title: string;
+    description: string;
+    content_loc?: string;
+    player_loc?: string;
+    publication_date: string;
+}
+/** Sitemap 条目 (Go: delivery.SitemapEntryResponse) */
+interface SitemapEntry {
+    loc: string;
+    resource_type?: string;
+    route_params?: Record<string, string | number | boolean | null | undefined>;
+    last_mod: string;
+    change_freq: string;
+    priority: number;
+    hreflang?: HreflangEntry[];
+    images?: SitemapImageEntry[];
+    videos?: SitemapVideoEntry[];
+}
+
+/** Webhook 事件类型 */
+type WebhookEventType = 'article.published' | 'article.unpublished' | 'article.updated' | 'article.archived' | 'redirect.changed' | 'comment.approved';
+/** ISR 重验证请求体 */
+interface RevalidatePayload {
+    event: WebhookEventType;
+    slug: string;
+    locale: string;
+    category_slug?: string;
+}
+
+export { RoutePolicy };
+export type { ArticleDetail, ArticleListItem, ArticleListParams, ArticleSearchParams, ArticleSearchResultItem, Author, AuthorProfile, AuthorProfileCta, AuthorProfileQuestion, AuthorProfileSection, AuthorProfileStat, AuthorSocialLink, CategoryNode, Comment, CreateCommentPayload, HreflangEntry, ListResponse, LocalizedOgMetaMap, LocalizedSeoMetaMap, LocalizedString, LocalizedTwitterMetaMap, OgMeta, Paginated, PaginationMeta, PaginationParams, RedirectMatchType, RedirectRule, RevalidatePayload, SeoMeta, Series, SiteConfig, SiteConfigQuery, SiteDeliveryMode, SiteDomain, SiteDomainType, SitemapEntry, SitemapImageEntry, SitemapVideoEntry, TwitterMeta, WebhookEventType };

package/dist/types.mjs

@@ -0,0 +1 @@
+

package/dist/webhook.d.mts

@@ -0,0 +1,10 @@
+interface VerifyWebhookOptions {
+    rawBody: string;
+    signature: string;
+    secret: string;
+}
+/** 验证 Webhook 签名（HMAC-SHA256） */
+declare function verifyWebhookSignature(options: VerifyWebhookOptions): boolean;
+
+export { verifyWebhookSignature };
+export type { VerifyWebhookOptions };

package/dist/webhook.d.ts

@@ -0,0 +1,10 @@
+interface VerifyWebhookOptions {
+    rawBody: string;
+    signature: string;
+    secret: string;
+}
+/** 验证 Webhook 签名（HMAC-SHA256） */
+declare function verifyWebhookSignature(options: VerifyWebhookOptions): boolean;
+
+export { verifyWebhookSignature };
+export type { VerifyWebhookOptions };

package/dist/webhook.mjs

@@ -0,0 +1,14 @@
+import { Buffer } from 'node:buffer';
+import { createHmac, timingSafeEqual } from 'node:crypto';
+
+function verifyWebhookSignature(options) {
+  const { rawBody, signature, secret } = options;
+  if (!signature || !rawBody || !secret) return false;
+  const expected = `sha256=${createHmac("sha256", secret).update(rawBody).digest("hex")}`;
+  const sigBuffer = Buffer.from(signature);
+  const expectedBuffer = Buffer.from(expected);
+  if (sigBuffer.length !== expectedBuffer.length) return false;
+  return timingSafeEqual(sigBuffer, expectedBuffer);
+}
+
+export { verifyWebhookSignature };

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "@stackonward/cms-client",
+  "version": "0.0.1",
+  "description": "Framework-agnostic client for structured CMS resources",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "routes": [
+        "./dist/routes.d.ts"
+      ],
+      "types": [
+        "./dist/types.d.ts"
+      ],
+      "webhook": [
+        "./dist/webhook.d.ts"
+      ],
+      "*": [
+        "./dist/index.d.ts"
+      ]
+    }
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs"
+    },
+    "./types": {
+      "types": "./dist/types.d.ts",
+      "import": "./dist/types.mjs"
+    },
+    "./routes": {
+      "types": "./dist/routes.d.ts",
+      "import": "./dist/routes.mjs"
+    },
+    "./webhook": {
+      "types": "./dist/webhook.d.ts",
+      "import": "./dist/webhook.mjs"
+    }
+  },
+  "files": [
+    "dist",
+    "CHANGELOG.md"
+  ],
+  "sideEffects": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/1yhy/stackonward.git",
+    "directory": "packages/core/cms-client"
+  },
+  "dependencies": {
+    "@stackonward/api-client": "0.0.1"
+  },
+  "devDependencies": {
+    "@antfu/eslint-config": "^4.13.2",
+    "@types/node": "^22.0.0",
+    "eslint": "^9.22.0",
+    "eslint-config-prettier": "^10.1.1",
+    "prettier": "^3.5.3",
+    "unbuild": "^3.5.0"
+  },
+  "scripts": {
+    "build": "unbuild",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "format": "prettier --write src/"
+  }
+}