@stackonward/cms-client 0.0.1

package/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## 0.0.1
+
+- Established the framework-neutral typed CMS delivery client.
+- Added article, author, category, search, site configuration, redirect, preview,
+  and sitemap contracts.
+- Added configurable request headers and error normalization without embedding a
+  product or platform protocol.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-present yhy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,62 @@
+# @stackonward/cms-client
+
+Framework-agnostic typed client for a CMS delivery API. It provides article,
+author, category, comment, sitemap, redirect, series, site-configuration, and
+webhook-signature contracts while leaving backend-specific headers and error
+envelopes to adapters.
+
+## Install
+
+```bash
+pnpm add @stackonward/cms-client
+```
+
+## Usage
+
+```typescript
+import { createCmsClient } from '@stackonward/cms-client'
+
+const cms = createCmsClient({
+  baseUrl: 'https://cms.example.com/api',
+  defaultLocale: 'en',
+  timeout: 10_000,
+  headers: { 'X-Customer-Scope': 'customer_alpha' },
+})
+
+const article = await cms.getArticle('getting-started')
+const sitemap = await cms.getSitemap('en')
+```
+
+## Configuration
+
+| Option            | Required | Description                                          |
+| ----------------- | -------- | ---------------------------------------------------- |
+| `baseUrl`         | Yes      | CMS delivery API base URL                            |
+| `defaultLocale`   | No       | Locale added to eligible reads; defaults to `en`     |
+| `fetch`           | No       | Fetch-compatible transport implementation            |
+| `timeout`         | No       | Request timeout in milliseconds; defaults to `10000` |
+| `headers`         | No       | Static or request-aware header provider              |
+| `errorNormalizer` | No       | Backend error-envelope adapter                       |
+
+The generic client does not know product codes, preview-header ownership, or a
+specific backend error envelope. OneX consumers use
+`@stackonward/onex-cms-client` to bind those contracts explicitly.
+
+## Entry points
+
+| Entry point                       | Content                                  |
+| --------------------------------- | ---------------------------------------- |
+| `@stackonward/cms-client`         | Client, routes, errors, and public types |
+| `@stackonward/cms-client/types`   | CMS request and response types           |
+| `@stackonward/cms-client/routes`  | Resource route policy helpers            |
+| `@stackonward/cms-client/webhook` | HMAC-SHA256 webhook verification         |
+
+## Compatibility
+
+- Fetch-compatible ESM runtime
+- Node.js 18+ for webhook verification
+- TypeScript declarations included
+
+## License
+
+[MIT](./LICENSE)

package/dist/index.d.mts

@@ -0,0 +1,86 @@
+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, SiteDeliveryMode, SiteDomain, SiteDomainType, SitemapImageEntry, SitemapVideoEntry, TwitterMeta, WebhookEventType } from './types.mjs';
+import { HeaderProvider, ErrorNormalizer, NormalizedApiError } from '@stackonward/api-client';
+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 客户端配置 */
+interface CmsClientConfig {
+    /** CMS API 基础 URL */
+    baseUrl: string;
+    /** 默认语言 */
+    defaultLocale?: string;
+    /** 自定义 fetch 实现 */
+    fetch?: typeof globalThis.fetch;
+    /** 请求超时（毫秒），默认 10000 */
+    timeout?: number;
+    /** 请求头提供器 */
+    headers?: HeaderProvider;
+    /** 后端错误格式适配器 */
+    errorNormalizer?: ErrorNormalizer;
+}
+
+/** CMS Public API 客户端 */
+declare class CmsClient {
+    private readonly config;
+    private readonly api;
+    constructor(config: CmsClientConfig);
+    /** 获取文章分页列表 */
+    getArticles(params?: ArticleListParams): Promise<Paginated<ArticleListItem>>;
+    /** 获取文章详情 */
+    getArticle(slug: string, locale?: string): Promise<ArticleDetail>;
+    /** 获取相关文章 */
+    getRelatedArticles(slug: string, options?: {
+        limit?: number;
+        locale?: string;
+    }): Promise<ArticleListItem[]>;
+    /** 搜索已发布文章 */
+    searchArticles(params: ArticleSearchParams): Promise<Paginated<ArticleSearchResultItem>>;
+    /** 获取作者分页列表 */
+    getAuthorsPage(options?: {
+        locale?: string;
+    } & PaginationParams): Promise<Paginated<Author>>;
+    /** 获取所有作者 */
+    getAuthors(options?: {
+        locale?: string;
+    } & PaginationParams): Promise<Author[]>;
+    /** 获取作者详情 */
+    getAuthor(slug: string, locale?: string): Promise<Author>;
+    /** 获取作者的文章分页列表 */
+    getAuthorArticlesPage(slug: string, options?: {
+        is_pinned?: boolean;
+        locale?: string;
+    } & PaginationParams): Promise<Paginated<ArticleListItem>>;
+    /** 获取作者的文章列表 */
+    getAuthorArticles(slug: string, options?: {
+        is_pinned?: boolean;
+        locale?: string;
+    } & PaginationParams): Promise<ArticleListItem[]>;
+    /** 获取分类树 */
+    getCategories(): Promise<CategoryNode[]>;
+    /** 获取文章评论树 */
+    getComments(articleSlug: string): Promise<Comment[]>;
+    /** 发表评论 */
+    createComment(articleSlug: string, payload: CreateCommentPayload): Promise<void>;
+    /** 获取 Sitemap 条目 */
+    getSitemap(locale?: string): Promise<SitemapEntry[]>;
+    /** 获取重定向规则 */
+    getRedirects(): Promise<RedirectRule[]>;
+    /** 获取站点运行时配置 */
+    getSiteConfig(options?: SiteConfigQuery): Promise<SiteConfig>;
+    /** 获取文章系列 */
+    getSeries(slug: string, locale?: string): Promise<Series>;
+    private request;
+}
+/** 创建 CMS 客户端实例 */
+declare function createCmsClient(config: CmsClientConfig): CmsClient;
+
+/** CMS API 错误（NormalizedApiError 子类，可被 api-client 的 normalizer 直接抛出） */
+declare class CmsApiError extends NormalizedApiError {
+    readonly errorCode: string;
+    constructor(statusCode: number, errorCode: string, message: string, body?: unknown);
+    get isNotFound(): boolean;
+    get isUnauthorized(): boolean;
+}
+
+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

@@ -0,0 +1,86 @@
+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, SiteDeliveryMode, SiteDomain, SiteDomainType, SitemapImageEntry, SitemapVideoEntry, TwitterMeta, WebhookEventType } from './types.js';
+import { HeaderProvider, ErrorNormalizer, NormalizedApiError } from '@stackonward/api-client';
+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 客户端配置 */
+interface CmsClientConfig {
+    /** CMS API 基础 URL */
+    baseUrl: string;
+    /** 默认语言 */
+    defaultLocale?: string;
+    /** 自定义 fetch 实现 */
+    fetch?: typeof globalThis.fetch;
+    /** 请求超时（毫秒），默认 10000 */
+    timeout?: number;
+    /** 请求头提供器 */
+    headers?: HeaderProvider;
+    /** 后端错误格式适配器 */
+    errorNormalizer?: ErrorNormalizer;
+}
+
+/** CMS Public API 客户端 */
+declare class CmsClient {
+    private readonly config;
+    private readonly api;
+    constructor(config: CmsClientConfig);
+    /** 获取文章分页列表 */
+    getArticles(params?: ArticleListParams): Promise<Paginated<ArticleListItem>>;
+    /** 获取文章详情 */
+    getArticle(slug: string, locale?: string): Promise<ArticleDetail>;
+    /** 获取相关文章 */
+    getRelatedArticles(slug: string, options?: {
+        limit?: number;
+        locale?: string;
+    }): Promise<ArticleListItem[]>;
+    /** 搜索已发布文章 */
+    searchArticles(params: ArticleSearchParams): Promise<Paginated<ArticleSearchResultItem>>;
+    /** 获取作者分页列表 */
+    getAuthorsPage(options?: {
+        locale?: string;
+    } & PaginationParams): Promise<Paginated<Author>>;
+    /** 获取所有作者 */
+    getAuthors(options?: {
+        locale?: string;
+    } & PaginationParams): Promise<Author[]>;
+    /** 获取作者详情 */
+    getAuthor(slug: string, locale?: string): Promise<Author>;
+    /** 获取作者的文章分页列表 */
+    getAuthorArticlesPage(slug: string, options?: {
+        is_pinned?: boolean;
+        locale?: string;
+    } & PaginationParams): Promise<Paginated<ArticleListItem>>;
+    /** 获取作者的文章列表 */
+    getAuthorArticles(slug: string, options?: {
+        is_pinned?: boolean;
+        locale?: string;
+    } & PaginationParams): Promise<ArticleListItem[]>;
+    /** 获取分类树 */
+    getCategories(): Promise<CategoryNode[]>;
+    /** 获取文章评论树 */
+    getComments(articleSlug: string): Promise<Comment[]>;
+    /** 发表评论 */
+    createComment(articleSlug: string, payload: CreateCommentPayload): Promise<void>;
+    /** 获取 Sitemap 条目 */
+    getSitemap(locale?: string): Promise<SitemapEntry[]>;
+    /** 获取重定向规则 */
+    getRedirects(): Promise<RedirectRule[]>;
+    /** 获取站点运行时配置 */
+    getSiteConfig(options?: SiteConfigQuery): Promise<SiteConfig>;
+    /** 获取文章系列 */
+    getSeries(slug: string, locale?: string): Promise<Series>;
+    private request;
+}
+/** 创建 CMS 客户端实例 */
+declare function createCmsClient(config: CmsClientConfig): CmsClient;
+
+/** CMS API 错误（NormalizedApiError 子类，可被 api-client 的 normalizer 直接抛出） */
+declare class CmsApiError extends NormalizedApiError {
+    readonly errorCode: string;
+    constructor(statusCode: number, errorCode: string, message: string, body?: unknown);
+    get isNotFound(): boolean;
+    get isUnauthorized(): boolean;
+}
+
+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

@@ -0,0 +1,221 @@
+import { NormalizedApiError, createApiClient, ApiHttpError } from '@stackonward/api-client';
+export { DEFAULT_ROUTE_RESOURCES, buildRoutePath, buildRouteUrl, extractRouteParams, extractSourceRouteParams, formatRoutePolicy, hasCustomArticleRoute, isRoutePolicy, mergeRouteParams, resolveRoutePolicy } from './routes.mjs';
+
+const DEFAULT_CONFIG = {
+  defaultLocale: "en",
+  timeout: 1e4
+};
+
+class CmsApiError extends NormalizedApiError {
+  errorCode;
+  constructor(statusCode, errorCode, message, body) {
+    super({ kind: "http", statusCode, code: errorCode, message, body });
+    this.name = "CmsApiError";
+    this.errorCode = errorCode;
+  }
+  get isNotFound() {
+    return this.statusCode === 404;
+  }
+  get isUnauthorized() {
+    return this.statusCode === 401;
+  }
+}
+
+async function resolveHeaders(provider, context) {
+  if (!provider) {
+    return { Accept: "application/json" };
+  }
+  const configured = typeof provider === "function" ? await provider(context) : provider;
+  const headers = new Headers(configured);
+  if (!headers.has("Accept")) {
+    headers.set("Accept", "application/json");
+  }
+  return headers;
+}
+function normalizeListResponse(body, endpoint) {
+  if (Array.isArray(body)) {
+    return body;
+  }
+  if (typeof body === "object" && body !== null && "data" in body) {
+    const data = body.data;
+    if (Array.isArray(data)) {
+      return data;
+    }
+  }
+  throw new CmsApiError(
+    500,
+    "INVALID_LIST_RESPONSE",
+    `CMS API returned invalid list response for ${endpoint}`,
+    body
+  );
+}
+const cmsErrorNormalizer = {
+  normalize(raw) {
+    if (raw instanceof CmsApiError) return raw;
+    if (raw instanceof ApiHttpError) {
+      return new CmsApiError(
+        raw.status,
+        "HTTP_ERROR",
+        `CMS request failed with status ${raw.status}`,
+        raw.data
+      );
+    }
+    if (raw instanceof NormalizedApiError) {
+      return new CmsApiError(
+        raw.statusCode ?? 0,
+        String(raw.code ?? raw.kind).toUpperCase(),
+        raw.message,
+        raw.body
+      );
+    }
+    return new CmsApiError(
+      0,
+      "NETWORK_ERROR",
+      raw instanceof Error ? raw.message : "CMS request failed",
+      raw
+    );
+  }
+};
+class CmsClient {
+  config;
+  api;
+  constructor(config) {
+    this.config = { ...DEFAULT_CONFIG, ...config };
+    this.api = createApiClient({
+      baseUrl: this.config.baseUrl,
+      timeout: this.config.timeout,
+      fetch: config.fetch,
+      headers: (context) => resolveHeaders(config.headers, context),
+      errorNormalizer: config.errorNormalizer ?? cmsErrorNormalizer
+    });
+  }
+  // ─── 文章 ───────────────────────────────────────────
+  /** 获取文章分页列表 */
+  async getArticles(params) {
+    return this.request(
+      "GET",
+      "/articles",
+      params
+    );
+  }
+  /** 获取文章详情 */
+  async getArticle(slug, locale) {
+    return this.request("GET", `/articles/${encodeURIComponent(slug)}`, { locale });
+  }
+  /** 获取相关文章 */
+  async getRelatedArticles(slug, options) {
+    const endpoint = `/articles/${encodeURIComponent(slug)}/related`;
+    const result = await this.request(
+      "GET",
+      endpoint,
+      options
+    );
+    return normalizeListResponse(result, endpoint);
+  }
+  /** 搜索已发布文章 */
+  async searchArticles(params) {
+    return this.request(
+      "GET",
+      "/search",
+      params
+    );
+  }
+  // ─── 作者 ───────────────────────────────────────────
+  /** 获取作者分页列表 */
+  async getAuthorsPage(options) {
+    return this.request("GET", "/authors", options);
+  }
+  /** 获取所有作者 */
+  async getAuthors(options) {
+    const result = await this.getAuthorsPage(options);
+    return normalizeListResponse(result, "/authors");
+  }
+  /** 获取作者详情 */
+  async getAuthor(slug, locale) {
+    return this.request("GET", `/authors/${encodeURIComponent(slug)}`, { locale });
+  }
+  /** 获取作者的文章分页列表 */
+  async getAuthorArticlesPage(slug, options) {
+    return this.request(
+      "GET",
+      `/authors/${encodeURIComponent(slug)}/articles`,
+      options
+    );
+  }
+  /** 获取作者的文章列表 */
+  async getAuthorArticles(slug, options) {
+    const result = await this.getAuthorArticlesPage(slug, options);
+    return normalizeListResponse(
+      result,
+      `/authors/${encodeURIComponent(slug)}/articles`
+    );
+  }
+  // ─── 分类 ───────────────────────────────────────────
+  /** 获取分类树 */
+  async getCategories() {
+    const result = await this.request(
+      "GET",
+      "/categories"
+    );
+    return normalizeListResponse(result, "/categories");
+  }
+  // ─── 评论 ───────────────────────────────────────────
+  /** 获取文章评论树 */
+  async getComments(articleSlug) {
+    return this.request("GET", `/articles/${encodeURIComponent(articleSlug)}/comments`);
+  }
+  /** 发表评论 */
+  async createComment(articleSlug, payload) {
+    return this.request(
+      "POST",
+      `/articles/${encodeURIComponent(articleSlug)}/comments`,
+      void 0,
+      payload
+    );
+  }
+  // ─── Sitemap / 重定向 / 系列 ──────────────────────
+  /** 获取 Sitemap 条目 */
+  async getSitemap(locale) {
+    const result = await this.request(
+      "GET",
+      "/sitemap",
+      { locale }
+    );
+    return normalizeListResponse(result, "/sitemap");
+  }
+  /** 获取重定向规则 */
+  async getRedirects() {
+    const result = await this.request(
+      "GET",
+      "/redirects"
+    );
+    return normalizeListResponse(result, "/redirects");
+  }
+  /** 获取站点运行时配置 */
+  async getSiteConfig(options) {
+    return this.request("GET", "/site", options, void 0, {
+      defaultLocale: false
+    });
+  }
+  /** 获取文章系列 */
+  async getSeries(slug, locale) {
+    return this.request("GET", `/series/${encodeURIComponent(slug)}`, { locale });
+  }
+  // ─── 内部请求方法 ──────────────────────────────────
+  async request(method, path, query, body, options) {
+    let finalQuery = query;
+    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;
+      }
+      finalQuery = q;
+    }
+    return this.api.request(method, path, { query: finalQuery, body });
+  }
+}
+function createCmsClient(config) {
+  return new CmsClient(config);
+}
+
+export { CmsApiError, CmsClient, createCmsClient };

package/dist/routes.d.mts

@@ -0,0 +1,54 @@
+type RouteParams = Record<string, string | number | boolean | null | undefined>;
+interface RouteResources {
+    index?: string;
+    category?: string;
+    article?: string;
+    author?: string;
+    [resource: string]: string | undefined;
+}
+interface RouteLocalePolicy {
+    defaultLocale?: string;
+    prefixes?: Record<string, string>;
+    includeDefaultLocale?: boolean;
+}
+interface RoutePolicy {
+    resources?: RouteResources;
+    sourceResources?: RouteResources;
+    locale?: RouteLocalePolicy;
+}
+interface RoutePolicyConfig {
+    defaultLocale?: string;
+    localePrefixes?: Record<string, string>;
+    routes?: RoutePolicy;
+}
+interface BuildRoutePathOptions {
+    includeLocale?: boolean;
+}
+interface BuildRouteUrlOptions extends BuildRoutePathOptions {
+}
+interface ResolvedRouteLocalePolicy {
+    defaultLocale: string;
+    prefixes: Record<string, string>;
+    includeDefaultLocale: boolean;
+}
+type RouteResourceDefaults = RouteResources & Required<Pick<RouteResources, 'article' | 'author' | 'category' | 'index'>>;
+interface ResolvedRoutePolicy {
+    resources: RouteResourceDefaults;
+    sourceResources: RouteResourceDefaults;
+    locale: ResolvedRouteLocalePolicy;
+}
+declare const DEFAULT_ROUTE_RESOURCES: RouteResourceDefaults;
+declare function resolveRoutePolicy(config?: RoutePolicyConfig): ResolvedRoutePolicy;
+declare function buildRoutePath(policy: RoutePolicy, resource: string, params?: RouteParams, options?: BuildRoutePathOptions): string;
+declare function buildRouteUrl(baseUrl: string, policy: null | RoutePolicy | undefined, resource: string, params?: RouteParams, options?: BuildRouteUrlOptions): string;
+declare function isRoutePolicy(value: unknown): value is RoutePolicy;
+declare function hasCustomArticleRoute(policy?: null | RoutePolicy): boolean;
+declare function formatRoutePolicy(policy?: null | RoutePolicy): string;
+declare function extractRouteParams(pattern: string, path: string): RouteParams | null;
+declare function extractSourceRouteParams(policy: RoutePolicy, resource: string, path: string): RouteParams | null;
+declare function mergeRouteParams(left: RouteParams | null | undefined, right: RouteParams | null | undefined): {
+    [x: string]: string | number | boolean | null | undefined;
+};
+
+export { DEFAULT_ROUTE_RESOURCES, buildRoutePath, buildRouteUrl, extractRouteParams, extractSourceRouteParams, formatRoutePolicy, hasCustomArticleRoute, isRoutePolicy, mergeRouteParams, resolveRoutePolicy };
+export type { BuildRoutePathOptions, BuildRouteUrlOptions, ResolvedRouteLocalePolicy, ResolvedRoutePolicy, RouteLocalePolicy, RouteParams, RoutePolicy, RoutePolicyConfig, RouteResourceDefaults, RouteResources };

package/dist/routes.d.ts

@@ -0,0 +1,54 @@
+type RouteParams = Record<string, string | number | boolean | null | undefined>;
+interface RouteResources {
+    index?: string;
+    category?: string;
+    article?: string;
+    author?: string;
+    [resource: string]: string | undefined;
+}
+interface RouteLocalePolicy {
+    defaultLocale?: string;
+    prefixes?: Record<string, string>;
+    includeDefaultLocale?: boolean;
+}
+interface RoutePolicy {
+    resources?: RouteResources;
+    sourceResources?: RouteResources;
+    locale?: RouteLocalePolicy;
+}
+interface RoutePolicyConfig {
+    defaultLocale?: string;
+    localePrefixes?: Record<string, string>;
+    routes?: RoutePolicy;
+}
+interface BuildRoutePathOptions {
+    includeLocale?: boolean;
+}
+interface BuildRouteUrlOptions extends BuildRoutePathOptions {
+}
+interface ResolvedRouteLocalePolicy {
+    defaultLocale: string;
+    prefixes: Record<string, string>;
+    includeDefaultLocale: boolean;
+}
+type RouteResourceDefaults = RouteResources & Required<Pick<RouteResources, 'article' | 'author' | 'category' | 'index'>>;
+interface ResolvedRoutePolicy {
+    resources: RouteResourceDefaults;
+    sourceResources: RouteResourceDefaults;
+    locale: ResolvedRouteLocalePolicy;
+}
+declare const DEFAULT_ROUTE_RESOURCES: RouteResourceDefaults;
+declare function resolveRoutePolicy(config?: RoutePolicyConfig): ResolvedRoutePolicy;
+declare function buildRoutePath(policy: RoutePolicy, resource: string, params?: RouteParams, options?: BuildRoutePathOptions): string;
+declare function buildRouteUrl(baseUrl: string, policy: null | RoutePolicy | undefined, resource: string, params?: RouteParams, options?: BuildRouteUrlOptions): string;
+declare function isRoutePolicy(value: unknown): value is RoutePolicy;
+declare function hasCustomArticleRoute(policy?: null | RoutePolicy): boolean;
+declare function formatRoutePolicy(policy?: null | RoutePolicy): string;
+declare function extractRouteParams(pattern: string, path: string): RouteParams | null;
+declare function extractSourceRouteParams(policy: RoutePolicy, resource: string, path: string): RouteParams | null;
+declare function mergeRouteParams(left: RouteParams | null | undefined, right: RouteParams | null | undefined): {
+    [x: string]: string | number | boolean | null | undefined;
+};
+
+export { DEFAULT_ROUTE_RESOURCES, buildRoutePath, buildRouteUrl, extractRouteParams, extractSourceRouteParams, formatRoutePolicy, hasCustomArticleRoute, isRoutePolicy, mergeRouteParams, resolveRoutePolicy };
+export type { BuildRoutePathOptions, BuildRouteUrlOptions, ResolvedRouteLocalePolicy, ResolvedRoutePolicy, RouteLocalePolicy, RouteParams, RoutePolicy, RoutePolicyConfig, RouteResourceDefaults, RouteResources };