@vigilkids/cms-client 0.3.1 → 0.3.3

package/CHANGELOG.md

@@ -5,6 +5,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.3.3] - 2026-06-16
+
+### Added
+
+- Added localized author profile contract fields for reusable CMS author pages.
+- Added typed site runtime route policy and redirect match rule metadata for CMS delivery consumers.
+
+## [0.3.2] - 2026-06-14
+
+### Added
+
+- Added optional author profile content types for reusable author pages across CMS consumers.
+
 ## [0.3.1] - 2026-06-05
 
 ### Added

package/dist/index.d.mts

@@ -1,5 +1,5 @@
-import { ArticleListParams, Paginated, ArticleListItem, ArticleDetail, ArticleSearchParams, ArticleSearchResultItem, PaginationParams, Author, CategoryNode, Comment, CreateCommentPayload, SitemapEntry, RedirectRule, Series } from './types.mjs';
-export { HreflangEntry, ListResponse, LocalizedOgMetaMap, LocalizedSeoMetaMap, LocalizedString, LocalizedTwitterMetaMap, OgMeta, PaginationMeta, RevalidatePayload, SeoMeta, SitemapImageEntry, TwitterMeta, WebhookEventType } from './types.mjs';
+import { ArticleListParams, Paginated, ArticleListItem, ArticleDetail, ArticleSearchParams, ArticleSearchResultItem, PaginationParams, Author, CategoryNode, Comment, CreateCommentPayload, SitemapEntry, RedirectRule, SiteConfigQuery, SiteConfig, Series } from './types.mjs';
+export { AuthorProfile, AuthorProfileCta, AuthorProfileQuestion, AuthorProfileSection, AuthorProfileStat, AuthorSocialLink, HreflangEntry, ListResponse, LocalizedOgMetaMap, LocalizedSeoMetaMap, LocalizedString, LocalizedTwitterMetaMap, OgMeta, PaginationMeta, RedirectMatchType, RevalidatePayload, SeoMeta, SitemapImageEntry, TwitterMeta, WebhookEventType } from './types.mjs';
 export { BuildRoutePathOptions, BuildRouteUrlOptions, DEFAULT_ROUTE_RESOURCES, ResolvedRouteLocalePolicy, ResolvedRoutePolicy, RouteLocalePolicy, RouteParams, RoutePolicy, RoutePolicyConfig, RouteResourceDefaults, RouteResources, buildRoutePath, buildRouteUrl, extractRouteParams, extractSourceRouteParams, formatRoutePolicy, hasCustomArticleRoute, isRoutePolicy, mergeRouteParams, resolveRoutePolicy } from './routes.mjs';
 
 /** CMS 客户端配置 */
@@ -66,6 +66,8 @@ declare class CmsClient {
     getSitemap(locale?: string): Promise<SitemapEntry[]>;
     /** 获取重定向规则 */
     getRedirects(): Promise<RedirectRule[]>;
+    /** 获取站点运行时配置 */
+    getSiteConfig(options?: SiteConfigQuery): Promise<SiteConfig>;
     /** 获取文章系列 */
     getSeries(slug: string, locale?: string): Promise<Series>;
     private request;
@@ -87,5 +89,5 @@ declare class CmsApiError extends Error {
     get isUnauthorized(): boolean;
 }
 
-export { ArticleDetail, ArticleListItem, ArticleListParams, ArticleSearchParams, ArticleSearchResultItem, Author, CategoryNode, CmsApiError, CmsClient, Comment, CreateCommentPayload, Paginated, PaginationParams, RedirectRule, Series, SitemapEntry, createCmsClient };
+export { ArticleDetail, ArticleListItem, ArticleListParams, ArticleSearchParams, ArticleSearchResultItem, Author, CategoryNode, CmsApiError, CmsClient, Comment, CreateCommentPayload, Paginated, PaginationParams, RedirectRule, Series, SiteConfig, SiteConfigQuery, SitemapEntry, createCmsClient };
 export type { CmsClientConfig };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { ArticleListParams, Paginated, ArticleListItem, ArticleDetail, ArticleSearchParams, ArticleSearchResultItem, PaginationParams, Author, CategoryNode, Comment, CreateCommentPayload, SitemapEntry, RedirectRule, Series } from './types.js';
-export { HreflangEntry, ListResponse, LocalizedOgMetaMap, LocalizedSeoMetaMap, LocalizedString, LocalizedTwitterMetaMap, OgMeta, PaginationMeta, RevalidatePayload, SeoMeta, SitemapImageEntry, TwitterMeta, WebhookEventType } from './types.js';
+import { ArticleListParams, Paginated, ArticleListItem, ArticleDetail, ArticleSearchParams, ArticleSearchResultItem, PaginationParams, Author, CategoryNode, Comment, CreateCommentPayload, SitemapEntry, RedirectRule, SiteConfigQuery, SiteConfig, Series } from './types.js';
+export { AuthorProfile, AuthorProfileCta, AuthorProfileQuestion, AuthorProfileSection, AuthorProfileStat, AuthorSocialLink, HreflangEntry, ListResponse, LocalizedOgMetaMap, LocalizedSeoMetaMap, LocalizedString, LocalizedTwitterMetaMap, OgMeta, PaginationMeta, RedirectMatchType, RevalidatePayload, SeoMeta, SitemapImageEntry, TwitterMeta, WebhookEventType } from './types.js';
 export { BuildRoutePathOptions, BuildRouteUrlOptions, DEFAULT_ROUTE_RESOURCES, ResolvedRouteLocalePolicy, ResolvedRoutePolicy, RouteLocalePolicy, RouteParams, RoutePolicy, RoutePolicyConfig, RouteResourceDefaults, RouteResources, buildRoutePath, buildRouteUrl, extractRouteParams, extractSourceRouteParams, formatRoutePolicy, hasCustomArticleRoute, isRoutePolicy, mergeRouteParams, resolveRoutePolicy } from './routes.js';
 
 /** CMS 客户端配置 */
@@ -66,6 +66,8 @@ declare class CmsClient {
     getSitemap(locale?: string): Promise<SitemapEntry[]>;
     /** 获取重定向规则 */
     getRedirects(): Promise<RedirectRule[]>;
+    /** 获取站点运行时配置 */
+    getSiteConfig(options?: SiteConfigQuery): Promise<SiteConfig>;
     /** 获取文章系列 */
     getSeries(slug: string, locale?: string): Promise<Series>;
     private request;
@@ -87,5 +89,5 @@ declare class CmsApiError extends Error {
     get isUnauthorized(): boolean;
 }
 
-export { ArticleDetail, ArticleListItem, ArticleListParams, ArticleSearchParams, ArticleSearchResultItem, Author, CategoryNode, CmsApiError, CmsClient, Comment, CreateCommentPayload, Paginated, PaginationParams, RedirectRule, Series, SitemapEntry, createCmsClient };
+export { ArticleDetail, ArticleListItem, ArticleListParams, ArticleSearchParams, ArticleSearchResultItem, Author, CategoryNode, CmsApiError, CmsClient, Comment, CreateCommentPayload, Paginated, PaginationParams, RedirectRule, Series, SiteConfig, SiteConfigQuery, SitemapEntry, createCmsClient };
 export type { CmsClientConfig };

package/dist/index.mjs

@@ -160,13 +160,23 @@ class CmsClient {
     );
     return normalizeListResponse(result, "/redirects");
   }
+  /** 获取站点运行时配置 */
+  async getSiteConfig(options) {
+    return this.request(
+      "GET",
+      "/site-config",
+      options,
+      void 0,
+      { defaultLocale: false }
+    );
+  }
   /** 获取文章系列 */
   async getSeries(slug, locale) {
     return this.request("GET", `/series/${encodeURIComponent(slug)}`, { locale });
   }
   // ─── 内部请求方法 ──────────────────────────────────
-  async request(method, path, query, body) {
-    if (method === "GET" && this.config.defaultLocale) {
+  async request(method, path, query, body, options) {
+    if (method === "GET" && options?.defaultLocale !== false && this.config.defaultLocale) {
       const q = query ?? {};
       if (q.locale === void 0 || q.locale === null) {
         q.locale = this.config.defaultLocale;

package/dist/types.d.mts

@@ -1,5 +1,51 @@
-export { BuildRoutePathOptions, ResolvedRouteLocalePolicy, ResolvedRoutePolicy, RouteLocalePolicy, RouteParams, RoutePolicy, RoutePolicyConfig, RouteResourceDefaults, RouteResources } from './routes.mjs';
+import { RoutePolicy } from './routes.mjs';
+export { BuildRoutePathOptions, ResolvedRouteLocalePolicy, ResolvedRoutePolicy, RouteLocalePolicy, RouteParams, RoutePolicyConfig, RouteResourceDefaults, RouteResources } from './routes.mjs';
 
+/** 作者社交链接 */
+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;
@@ -13,6 +59,7 @@ interface Author {
     twitter_meta?: Partial<TwitterMeta>;
     available_locales?: string[];
     localized_slugs?: Record<string, string>;
+    profile?: AuthorProfile;
 }
 
 /** 多语言字符串 (Go: domain.LocalizedString = map[string]string) */
@@ -174,11 +221,12 @@ interface CreateCommentPayload {
 }
 
 /** 重定向规则 (Go: delivery.RedirectRuleResponse) */
+type RedirectMatchType = 'exact' | 'prefix' | 'regex';
 interface RedirectRule {
     source_path: string;
     destination_path: string;
     status_code: number;
-    match_type: string;
+    match_type: RedirectMatchType;
     priority: number;
 }
 
@@ -191,6 +239,20 @@ interface Series {
     articles: ArticleListItem[];
 }
 
+interface SiteConfig {
+    product_code: string;
+    site_name: string;
+    site_url: string;
+    sitemap_path: string;
+    domain_aliases: string[];
+    route_policy: RoutePolicy;
+    updated_at: string;
+}
+interface SiteConfigQuery {
+    site_url?: string;
+    host?: string;
+}
+
 /** Hreflang 条目 (Go: delivery.HreflangEntry) */
 interface HreflangEntry {
     lang: string;
@@ -224,4 +286,5 @@ interface RevalidatePayload {
     category_slug?: string;
 }
 
-export type { ArticleDetail, ArticleListItem, ArticleListParams, ArticleSearchParams, ArticleSearchResultItem, Author, CategoryNode, Comment, CreateCommentPayload, HreflangEntry, ListResponse, LocalizedOgMetaMap, LocalizedSeoMetaMap, LocalizedString, LocalizedTwitterMetaMap, OgMeta, Paginated, PaginationMeta, PaginationParams, RedirectRule, RevalidatePayload, SeoMeta, Series, SitemapEntry, SitemapImageEntry, TwitterMeta, WebhookEventType };
+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, SitemapEntry, SitemapImageEntry, TwitterMeta, WebhookEventType };

package/dist/types.d.ts

@@ -1,5 +1,51 @@
-export { BuildRoutePathOptions, ResolvedRouteLocalePolicy, ResolvedRoutePolicy, RouteLocalePolicy, RouteParams, RoutePolicy, RoutePolicyConfig, RouteResourceDefaults, RouteResources } from './routes.js';
+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;
@@ -13,6 +59,7 @@ interface Author {
     twitter_meta?: Partial<TwitterMeta>;
     available_locales?: string[];
     localized_slugs?: Record<string, string>;
+    profile?: AuthorProfile;
 }
 
 /** 多语言字符串 (Go: domain.LocalizedString = map[string]string) */
@@ -174,11 +221,12 @@ interface CreateCommentPayload {
 }
 
 /** 重定向规则 (Go: delivery.RedirectRuleResponse) */
+type RedirectMatchType = 'exact' | 'prefix' | 'regex';
 interface RedirectRule {
     source_path: string;
     destination_path: string;
     status_code: number;
-    match_type: string;
+    match_type: RedirectMatchType;
     priority: number;
 }
 
@@ -191,6 +239,20 @@ interface Series {
     articles: ArticleListItem[];
 }
 
+interface SiteConfig {
+    product_code: string;
+    site_name: string;
+    site_url: string;
+    sitemap_path: string;
+    domain_aliases: string[];
+    route_policy: RoutePolicy;
+    updated_at: string;
+}
+interface SiteConfigQuery {
+    site_url?: string;
+    host?: string;
+}
+
 /** Hreflang 条目 (Go: delivery.HreflangEntry) */
 interface HreflangEntry {
     lang: string;
@@ -224,4 +286,5 @@ interface RevalidatePayload {
     category_slug?: string;
 }
 
-export type { ArticleDetail, ArticleListItem, ArticleListParams, ArticleSearchParams, ArticleSearchResultItem, Author, CategoryNode, Comment, CreateCommentPayload, HreflangEntry, ListResponse, LocalizedOgMetaMap, LocalizedSeoMetaMap, LocalizedString, LocalizedTwitterMetaMap, OgMeta, Paginated, PaginationMeta, PaginationParams, RedirectRule, RevalidatePayload, SeoMeta, Series, SitemapEntry, SitemapImageEntry, TwitterMeta, WebhookEventType };
+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, SitemapEntry, SitemapImageEntry, TwitterMeta, WebhookEventType };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vigilkids/cms-client",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "description": "Framework-agnostic TypeScript client for OnEx CMS Public API",
   "type": "module",
   "main": "./dist/index.mjs",
@@ -46,6 +46,7 @@
   "sideEffects": false,
   "scripts": {
     "build": "unbuild",
+    "prepack": "pnpm build",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
     "format": "prettier --write src/"