@vigilkids/cms-client 0.3.3 → 0.3.4

package/CHANGELOG.md

@@ -5,6 +5,12 @@ 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.4] - 2026-07-19
+
+### Changed
+
+- Included the package README and license in the published artifact.
+
 ## [0.3.3] - 2026-06-16
 
 ### Added

package/dist/index.d.mts

@@ -1,5 +1,5 @@
 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 { AuthorProfile, AuthorProfileCta, AuthorProfileQuestion, AuthorProfileSection, AuthorProfileStat, AuthorSocialLink, HreflangEntry, ListResponse, LocalizedOgMetaMap, LocalizedSeoMetaMap, LocalizedString, LocalizedTwitterMetaMap, OgMeta, PaginationMeta, RedirectMatchType, RevalidatePayload, SeoMeta, SiteDeliveryMode, SiteDomain, SiteDomainType, 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 客户端配置 */

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 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 { AuthorProfile, AuthorProfileCta, AuthorProfileQuestion, AuthorProfileSection, AuthorProfileStat, AuthorSocialLink, HreflangEntry, ListResponse, LocalizedOgMetaMap, LocalizedSeoMetaMap, LocalizedString, LocalizedTwitterMetaMap, OgMeta, PaginationMeta, RedirectMatchType, RevalidatePayload, SeoMeta, SiteDeliveryMode, SiteDomain, SiteDomainType, 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 客户端配置 */

package/dist/index.mjs

@@ -164,7 +164,7 @@ class CmsClient {
   async getSiteConfig(options) {
     return this.request(
       "GET",
-      "/site-config",
+      "/site",
       options,
       void 0,
       { defaultLocale: false }

package/dist/routes.mjs

@@ -11,7 +11,8 @@ 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, "");
+  if (collapsed.length > 1)
+    return collapsed.replace(/\/+$/g, "");
   return collapsed;
 }
 function encodePathValue(value) {
@@ -21,12 +22,15 @@ function isPlainObject(value) {
   return typeof value === "object" && value !== null && !Array.isArray(value);
 }
 function isStringRecord(value) {
-  if (!isPlainObject(value)) return false;
+  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 "";
+  if (!locale)
+    return "";
+  if (locale === policy.defaultLocale && !policy.includeDefaultLocale)
+    return "";
   const prefix = policy.prefixes[locale] ?? locale.toLowerCase();
   return `/${trimSlashes(prefix)}`;
 }
@@ -68,7 +72,8 @@ function buildRoutePath(policy, resource, params = {}, options = {}) {
       return encodePathValue(value);
     })
   );
-  if (!options.includeLocale) return path;
+  if (!options.includeLocale)
+    return path;
   return normalizePath(`${localePrefix(String(params.locale ?? ""), resolvedPolicy.locale)}${path}`);
 }
 function buildRouteUrl(baseUrl, policy, resource, params = {}, options = {}) {
@@ -77,16 +82,23 @@ function buildRouteUrl(baseUrl, policy, resource, params = {}, options = {}) {
   return normalizedBaseUrl ? `${normalizedBaseUrl}${path}` : path;
 }
 function isRoutePolicy(value) {
-  if (!isPlainObject(value)) return false;
+  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 (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")
+    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;
-    if (locale.prefixes !== void 0 && !isStringRecord(locale.prefixes)) return false;
   }
   return true;
 }
@@ -116,11 +128,13 @@ function extractRouteParams(pattern, path) {
   }
   expression += "$";
   const match = normalizePath(path).match(new RegExp(expression));
-  if (!match) return null;
+  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);
+    if (raw)
+      params[keys[index]] = decodeURIComponent(raw);
   }
   return params;
 }
@@ -133,7 +147,8 @@ function extractSourceRouteParams(policy, resource, path) {
   ].filter((pattern) => Boolean(pattern));
   for (const pattern of candidates) {
     const params = extractRouteParams(pattern, path);
-    if (params) return params;
+    if (params)
+      return params;
   }
   return null;
 }

package/dist/types.d.mts

@@ -239,17 +239,28 @@ interface Series {
     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;
-    site_url: string;
+    delivery_mode: SiteDeliveryMode;
+    canonical_base_url: string;
+    domains: SiteDomain[];
     sitemap_path: string;
-    domain_aliases: string[];
     route_policy: RoutePolicy;
     updated_at: string;
 }
 interface SiteConfigQuery {
-    site_url?: string;
+    site_code?: string;
     host?: string;
 }
 
@@ -287,4 +298,4 @@ interface RevalidatePayload {
 }
 
 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 };
+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, TwitterMeta, WebhookEventType };

package/dist/types.d.ts

@@ -239,17 +239,28 @@ interface Series {
     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;
-    site_url: string;
+    delivery_mode: SiteDeliveryMode;
+    canonical_base_url: string;
+    domains: SiteDomain[];
     sitemap_path: string;
-    domain_aliases: string[];
     route_policy: RoutePolicy;
     updated_at: string;
 }
 interface SiteConfigQuery {
-    site_url?: string;
+    site_code?: string;
     host?: string;
 }
 
@@ -287,4 +298,4 @@ interface RevalidatePayload {
 }
 
 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 };
+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, TwitterMeta, WebhookEventType };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vigilkids/cms-client",
-  "version": "0.3.3",
+  "version": "0.3.4",
   "description": "Framework-agnostic TypeScript client for OnEx CMS Public API",
   "type": "module",
   "main": "./dist/index.mjs",
@@ -41,6 +41,8 @@
   },
   "files": [
     "dist",
+    "README.md",
+    "LICENSE",
     "CHANGELOG.md"
   ],
   "sideEffects": false,