@stackonward/cms-client 0.0.1

package/dist/routes.mjs

@@ -0,0 +1,148 @@
+const DEFAULT_ROUTE_RESOURCES = {
+  index: "/",
+  category: "/{category_slug}",
+  article: "/{category_slug}/{slug}",
+  author: "/authors/{slug}"
+};
+function trimSlashes(value) {
+  return value.replace(/^\/+|\/+$/g, "");
+}
+function normalizePath(path) {
+  const clean = path.split("?")[0]?.split("#")[0] ?? "";
+  const withSlash = clean.startsWith("/") ? clean : `/${clean}`;
+  const collapsed = withSlash.replace(/\/{2,}/g, "/");
+  if (collapsed.length > 1) return collapsed.replace(/\/+$/g, "");
+  return collapsed;
+}
+function encodePathValue(value) {
+  return encodeURIComponent(String(value));
+}
+function isPlainObject(value) {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function isStringRecord(value) {
+  if (!isPlainObject(value)) return false;
+  return Object.values(value).every((item) => typeof item === "string");
+}
+function localePrefix(locale, policy) {
+  if (!locale) return "";
+  if (locale === policy.defaultLocale && !policy.includeDefaultLocale) return "";
+  const prefix = policy.prefixes[locale] ?? locale.toLowerCase();
+  return `/${trimSlashes(prefix)}`;
+}
+function mergeResources(resources) {
+  return {
+    ...DEFAULT_ROUTE_RESOURCES,
+    ...resources ?? {}
+  };
+}
+function resolveRoutePolicy(config) {
+  const routes = config?.routes ?? {};
+  const defaultLocale = routes.locale?.defaultLocale ?? config?.defaultLocale ?? "en";
+  const prefixes = {
+    ...config?.localePrefixes ?? {},
+    ...routes.locale?.prefixes ?? {}
+  };
+  return {
+    resources: mergeResources(routes.resources),
+    sourceResources: mergeResources(routes.sourceResources),
+    locale: {
+      defaultLocale,
+      prefixes,
+      includeDefaultLocale: routes.locale?.includeDefaultLocale ?? false
+    }
+  };
+}
+function buildRoutePath(policy, resource, params = {}, options = {}) {
+  const resolvedPolicy = resolveRoutePolicy({ routes: policy });
+  const pattern = resolvedPolicy.resources[resource];
+  if (!pattern) {
+    throw new Error(`CMS route pattern is not configured for resource '${resource}'`);
+  }
+  const path = normalizePath(
+    pattern.replace(/\{(\w+)\}/g, (_, key) => {
+      const value = params[key];
+      if (value === void 0 || value === null || value === "") {
+        throw new Error(`CMS route parameter '${key}' is required for resource '${resource}'`);
+      }
+      return encodePathValue(value);
+    })
+  );
+  if (!options.includeLocale) return path;
+  return normalizePath(`${localePrefix(String(params.locale ?? ""), resolvedPolicy.locale)}${path}`);
+}
+function buildRouteUrl(baseUrl, policy, resource, params = {}, options = {}) {
+  const path = buildRoutePath(policy ?? {}, resource, params, options);
+  const normalizedBaseUrl = baseUrl.replace(/\/+$/g, "");
+  return normalizedBaseUrl ? `${normalizedBaseUrl}${path}` : path;
+}
+function isRoutePolicy(value) {
+  if (!isPlainObject(value)) return false;
+  const { locale, resources, sourceResources } = value;
+  if (resources !== void 0 && !isStringRecord(resources)) return false;
+  if (sourceResources !== void 0 && !isStringRecord(sourceResources)) return false;
+  if (locale !== void 0) {
+    if (!isPlainObject(locale)) return false;
+    if (locale.defaultLocale !== void 0 && typeof locale.defaultLocale !== "string") return false;
+    if (locale.includeDefaultLocale !== void 0 && typeof locale.includeDefaultLocale !== "boolean") {
+      return false;
+    }
+    if (locale.prefixes !== void 0 && !isStringRecord(locale.prefixes)) return false;
+  }
+  return true;
+}
+function hasCustomArticleRoute(policy) {
+  return resolveRoutePolicy({ routes: policy ?? void 0 }).resources.article !== DEFAULT_ROUTE_RESOURCES.article;
+}
+function formatRoutePolicy(policy) {
+  return JSON.stringify(resolveRoutePolicy({ routes: policy ?? void 0 }), null, 2);
+}
+function extractRouteParams(pattern, path) {
+  const keys = [];
+  const source = normalizePath(pattern);
+  let expression = "^";
+  for (let index = 0; index < source.length; index++) {
+    const char = source[index];
+    if (char === "{") {
+      const closeIndex = source.indexOf("}", index);
+      if (closeIndex > index) {
+        const key = source.slice(index + 1, closeIndex);
+        keys.push(key);
+        expression += "([^/]+)";
+        index = closeIndex;
+        continue;
+      }
+    }
+    expression += char.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+  }
+  expression += "$";
+  const match = normalizePath(path).match(new RegExp(expression));
+  if (!match) return null;
+  const params = {};
+  for (let index = 0; index < keys.length; index++) {
+    const raw = match[index + 1];
+    if (raw) params[keys[index]] = decodeURIComponent(raw);
+  }
+  return params;
+}
+function extractSourceRouteParams(policy, resource, path) {
+  const resolvedPolicy = resolveRoutePolicy({ routes: policy });
+  const candidates = [
+    resolvedPolicy.sourceResources[resource],
+    resolvedPolicy.resources[resource],
+    DEFAULT_ROUTE_RESOURCES[resource]
+  ].filter((pattern) => Boolean(pattern));
+  for (const pattern of candidates) {
+    const params = extractRouteParams(pattern, path);
+    if (params) return params;
+  }
+  return null;
+}
+function mergeRouteParams(left, right) {
+  return {
+    ...left ?? {},
+    ...right ?? {}
+  };
+}
+
+export { DEFAULT_ROUTE_RESOURCES, buildRoutePath, buildRouteUrl, extractRouteParams, extractSourceRouteParams, formatRoutePolicy, hasCustomArticleRoute, isRoutePolicy, mergeRouteParams, resolveRoutePolicy };

package/dist/types.d.mts

@@ -0,0 +1,311 @@
+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;
+    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 };