@vcp-dev/contracts 0.4.0 → 0.4.1

package/dist/site-edit-source.d.ts

@@ -0,0 +1,170 @@
+import { z } from "zod";
+export declare const SITE_EDIT_SOURCE_ALLOWED_ROOT_FILES: readonly ["design.md", "DESIGN.md"];
+export declare const SITE_EDIT_SOURCE_ALLOWED_DIRS: readonly ["components/site", "src/components/site", "lib/generated", "src/lib/generated", "public"];
+export declare const SITE_EDIT_SOURCE_ALLOWED_APP_FILES: readonly ["app/globals.css", "src/app/globals.css"];
+export declare const SITE_EDIT_TEXT_SOURCE_EXTENSIONS: readonly [".cjs", ".css", ".cts", ".html", ".js", ".json", ".jsx", ".md", ".mdx", ".mjs", ".mts", ".ts", ".tsx", ".txt", ".yaml", ".yml"];
+export declare const SITE_EDIT_SOURCE_DELETE_CAPABILITY: "source-delete";
+export declare const SiteEditSourceDeleteCapabilitySchema: z.ZodLiteral<"source-delete">;
+export type SiteEditSourceDeleteCapability = z.infer<typeof SiteEditSourceDeleteCapabilitySchema>;
+export type SiteEditSourceDeleteProtectionReason = "design-document" | "route-entry" | "app-global-style" | "generated-media-manifest";
+export declare const SiteEditSourcePathSchema: z.ZodString;
+export type SiteEditSourcePath = z.infer<typeof SiteEditSourcePathSchema>;
+export declare const SiteEditSourceDirectoryPathSchema: z.ZodString;
+export type SiteEditSourceDirectoryPath = z.infer<typeof SiteEditSourceDirectoryPathSchema>;
+export declare const SiteEditSourceFileKindSchema: z.ZodEnum<{
+    text: "text";
+    binary: "binary";
+}>;
+export type SiteEditSourceFileKind = z.infer<typeof SiteEditSourceFileKindSchema>;
+export declare const SiteEditSourceFileListItemSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    path: z.ZodString;
+    sizeBytes: z.ZodNumber;
+    contentHash: z.ZodOptional<z.ZodString>;
+    kind: z.ZodLiteral<"text">;
+    language: z.ZodString;
+    readonly: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>, z.ZodObject<{
+    path: z.ZodString;
+    sizeBytes: z.ZodNumber;
+    contentHash: z.ZodOptional<z.ZodString>;
+    kind: z.ZodLiteral<"binary">;
+    language: z.ZodNull;
+    mimeType: z.ZodOptional<z.ZodString>;
+    readonly: z.ZodLiteral<true>;
+}, z.core.$strip>], "kind">;
+export type SiteEditSourceFileListItem = z.infer<typeof SiteEditSourceFileListItemSchema>;
+export type SiteEditSourceFileTreeNode = {
+    kind: "file";
+    name: string;
+    path: SiteEditSourcePath;
+    file: SiteEditSourceFileListItem;
+};
+export type SiteEditSourceDirectoryTreeNode = {
+    kind: "directory";
+    name: string;
+    path: SiteEditSourceDirectoryPath;
+    children: SiteEditSourceTreeNode[];
+};
+export type SiteEditSourceTreeNode = SiteEditSourceFileTreeNode | SiteEditSourceDirectoryTreeNode;
+export declare const SiteEditSourceTreeNodeSchema: z.ZodType<SiteEditSourceTreeNode>;
+export declare const SiteEditSourceTreeTruncationReasonSchema: z.ZodEnum<{
+    "max-files": "max-files";
+    "max-depth": "max-depth";
+    "max-total-bytes": "max-total-bytes";
+}>;
+export type SiteEditSourceTreeTruncationReason = z.infer<typeof SiteEditSourceTreeTruncationReasonSchema>;
+export declare const SiteEditSourceTreeTruncationSchema: z.ZodObject<{
+    reasons: z.ZodArray<z.ZodEnum<{
+        "max-files": "max-files";
+        "max-depth": "max-depth";
+        "max-total-bytes": "max-total-bytes";
+    }>>;
+    maxFiles: z.ZodNumber;
+    maxDepth: z.ZodNumber;
+    maxTotalBytes: z.ZodNumber;
+}, z.core.$strip>;
+export type SiteEditSourceTreeTruncation = z.infer<typeof SiteEditSourceTreeTruncationSchema>;
+export declare const SiteEditSourceTreeResponseSchema: z.ZodObject<{
+    nodes: z.ZodArray<z.ZodType<SiteEditSourceTreeNode, unknown, z.core.$ZodTypeInternals<SiteEditSourceTreeNode, unknown>>>;
+    defaultPath: z.ZodOptional<z.ZodString>;
+    totalFiles: z.ZodNumber;
+    truncated: z.ZodOptional<z.ZodObject<{
+        reasons: z.ZodArray<z.ZodEnum<{
+            "max-files": "max-files";
+            "max-depth": "max-depth";
+            "max-total-bytes": "max-total-bytes";
+        }>>;
+        maxFiles: z.ZodNumber;
+        maxDepth: z.ZodNumber;
+        maxTotalBytes: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type SiteEditSourceTreeResponse = z.infer<typeof SiteEditSourceTreeResponseSchema>;
+export declare const SiteEditSourceFileTextResponseSchema: z.ZodObject<{
+    path: z.ZodString;
+    sizeBytes: z.ZodNumber;
+    contentHash: z.ZodOptional<z.ZodString>;
+    kind: z.ZodLiteral<"text">;
+    language: z.ZodString;
+    readonly: z.ZodDefault<z.ZodBoolean>;
+    content: z.ZodString;
+}, z.core.$strip>;
+export type SiteEditSourceFileTextResponse = z.infer<typeof SiteEditSourceFileTextResponseSchema>;
+export declare const SiteEditSourceFileBinaryPreviewUnavailableReasonSchema: z.ZodEnum<{
+    "too-large": "too-large";
+    "unsupported-mime": "unsupported-mime";
+    "bytes-unavailable": "bytes-unavailable";
+}>;
+export type SiteEditSourceFileBinaryPreviewUnavailableReason = z.infer<typeof SiteEditSourceFileBinaryPreviewUnavailableReasonSchema>;
+export declare const SiteEditSourceFileBinaryResponseSchema: z.ZodObject<{
+    path: z.ZodString;
+    sizeBytes: z.ZodNumber;
+    contentHash: z.ZodOptional<z.ZodString>;
+    kind: z.ZodLiteral<"binary">;
+    language: z.ZodNull;
+    readonly: z.ZodLiteral<true>;
+    mimeType: z.ZodString;
+    contentBase64: z.ZodOptional<z.ZodString>;
+    previewUnavailableReason: z.ZodOptional<z.ZodEnum<{
+        "too-large": "too-large";
+        "unsupported-mime": "unsupported-mime";
+        "bytes-unavailable": "bytes-unavailable";
+    }>>;
+}, z.core.$strip>;
+export type SiteEditSourceFileBinaryResponse = z.infer<typeof SiteEditSourceFileBinaryResponseSchema>;
+export declare const SiteEditSourceFileResponseSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    path: z.ZodString;
+    sizeBytes: z.ZodNumber;
+    contentHash: z.ZodOptional<z.ZodString>;
+    kind: z.ZodLiteral<"text">;
+    language: z.ZodString;
+    readonly: z.ZodDefault<z.ZodBoolean>;
+    content: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    path: z.ZodString;
+    sizeBytes: z.ZodNumber;
+    contentHash: z.ZodOptional<z.ZodString>;
+    kind: z.ZodLiteral<"binary">;
+    language: z.ZodNull;
+    readonly: z.ZodLiteral<true>;
+    mimeType: z.ZodString;
+    contentBase64: z.ZodOptional<z.ZodString>;
+    previewUnavailableReason: z.ZodOptional<z.ZodEnum<{
+        "too-large": "too-large";
+        "unsupported-mime": "unsupported-mime";
+        "bytes-unavailable": "bytes-unavailable";
+    }>>;
+}, z.core.$strip>], "kind">;
+export type SiteEditSourceFileResponse = z.infer<typeof SiteEditSourceFileResponseSchema>;
+export declare const SiteEditResolveSourceLocationInputSchema: z.ZodObject<{
+    key: z.ZodString;
+    routeId: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type SiteEditResolveSourceLocationInput = z.infer<typeof SiteEditResolveSourceLocationInputSchema>;
+export declare const SiteEditSourceLocationRangeSchema: z.ZodObject<{
+    startLine: z.ZodNumber;
+    startColumn: z.ZodNumber;
+    endLine: z.ZodNumber;
+    endColumn: z.ZodNumber;
+}, z.core.$strip>;
+export type SiteEditSourceLocationRange = z.infer<typeof SiteEditSourceLocationRangeSchema>;
+export declare const SiteEditSourceLocationSchema: z.ZodObject<{
+    key: z.ZodString;
+    routeId: z.ZodOptional<z.ZodString>;
+    sourceFile: z.ZodString;
+    componentName: z.ZodString;
+    openingElementRange: z.ZodObject<{
+        startLine: z.ZodNumber;
+        startColumn: z.ZodNumber;
+        endLine: z.ZodNumber;
+        endColumn: z.ZodNumber;
+    }, z.core.$strip>;
+    structuralPath: z.ZodString;
+    textPreview: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type SiteEditSourceLocation = z.infer<typeof SiteEditSourceLocationSchema>;
+export declare function isSiteEditSourcePath(path: string): boolean;
+export declare function isSiteEditTextSourcePath(path: string): boolean;
+export declare function isSiteEditSourceDirectoryPath(path: string): boolean;
+export declare function getSiteEditSourceDeleteProtectionReason(path: string): SiteEditSourceDeleteProtectionReason | null;
+export declare function isSiteEditSourceDeleteProtectedPath(path: string): boolean;

package/dist/site-edit-version.d.ts

@@ -5,7 +5,7 @@
  *
  * 由 release-edit-engine-packages.ts 在 bump 版本时自动更新。
  */
-export declare const CURRENT_EDIT_ENGINE_VERSION = "0.4.0";
+export declare const CURRENT_EDIT_ENGINE_VERSION = "0.4.1";
 export declare const EDIT_ENGINE_VERSION_HEADER = "x-vcp-edit-engine-version";
 export declare const EDIT_ENGINE_VERSION_SOURCE_HEADER = "x-vcp-edit-engine-version-source";
 export type EditEngineVersionSource = "explicit" | "fallback_current" | "system_current";

package/dist/site-locale.d.ts

@@ -1,10 +1,7 @@
 import { z } from "zod";
-/**
- * 白名单 BCP-47 code（与 {@link SUPPORTED_SITE_LOCALES} 同序同值）。
- * 显式 literal tuple 以便 `z.enum` 推导出精确联合类型。
- */
-export declare const SITE_LOCALE_CODES: readonly ["zh-CN", "en", "ja", "es", "fr", "de", "zh-TW", "ko", "pt", "pt-BR", "it", "ru", "ar", "hi", "id", "vi", "th", "tr", "nl", "pl", "uk", "sv", "da", "fi", "no", "cs", "el", "hu", "ro", "he", "ms", "fil", "bn", "ta", "ca", "sk", "hr", "bg", "lt", "lv", "et", "fa", "sw", "sr", "is"];
+export { DEFAULT_SITE_LOCALE, ISO_639_3_TO_SITE_LOCALE, SITE_LOCALE_CODES, SUPPORTED_SITE_LOCALES, resolveSiteLocaleFromIso6393, type SiteLocale, type SiteLocaleOption, } from "@vcp-dev/i18n/site-locale";
 export declare const SiteLocaleSchema: z.ZodEnum<{
+    id: "id";
     "zh-CN": "zh-CN";
     en: "en";
     ja: "ja";
@@ -19,7 +16,6 @@ export declare const SiteLocaleSchema: z.ZodEnum<{
     ru: "ru";
     ar: "ar";
     hi: "hi";
-    id: "id";
     vi: "vi";
     th: "th";
     tr: "tr";
@@ -51,44 +47,3 @@ export declare const SiteLocaleSchema: z.ZodEnum<{
     sr: "sr";
     is: "is";
 }>;
-export type SiteLocale = z.infer<typeof SiteLocaleSchema>;
-/**
- * 站点产出语种（访客看到的语言）的事实源白名单。
- *
- * - `code`：BCP-47 标签，持久化进 `SiteRecord.default_locale`，并直接用于
- *   生成站点产物的 `<html lang>`。
- * - `label`：语种自称（endonym，如 `日本語` / `Español`），**不随界面语言变**，
- *   控件主显示。
- * - `common`：是否常用，控件浮层默认置顶展示。
- *
- * 语种在当前界面语言下的释义（exonym，如「日语」/「Japanese」）**不放这里**——
- * 它随界面语言变化，由前端 i18n（`clarify` 命名空间 `siteLanguage.names.<code>`）
- * 提供，避免界面切到英文时右侧仍显示中文。
- *
- * `default_locale` 为 NOT NULL：Step 1 创建站点时由后端轻量语言检测写入
- * （识别不出兜底 {@link DEFAULT_SITE_LOCALE}），用户可在 Step 2 覆盖。
- */
-export interface SiteLocaleOption {
-    code: SiteLocale;
-    label: string;
-    common?: boolean;
-}
-/**
- * 控件展示用元数据（前 6 项为常用，控件默认置顶）。code 必须落在白名单内。
- * `label` 是语种自称（endonym），不随界面语言变；释义（exonym）走前端 i18n。
- */
-export declare const SUPPORTED_SITE_LOCALES: readonly SiteLocaleOption[];
-/**
- * 识别不确定 / 失败时的兜底语种。`default_locale` 不可为空，故必须有终极兜底。
- */
-export declare const DEFAULT_SITE_LOCALE: SiteLocale;
-/**
- * 轻量语言检测库（franc 系）输出的 ISO 639-3 → 白名单 BCP-47。
- * 映射未命中时由调用方兜底为 {@link DEFAULT_SITE_LOCALE}。
- * 注：franc 不区分简繁，`cmn` 统一归 `zh-CN`，繁体靠用户在 Step 2 手选。
- */
-export declare const ISO_639_3_TO_SITE_LOCALE: Readonly<Record<string, SiteLocale>>;
-/**
- * 把检测库输出的 ISO 639-3 归一到白名单 BCP-47；未命中返回 {@link DEFAULT_SITE_LOCALE}。
- */
-export declare function resolveSiteLocaleFromIso6393(iso6393: string): SiteLocale;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vcp-dev/contracts",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "type": "module",
   "license": "UNLICENSED",
   "repository": {
@@ -51,6 +51,7 @@
     "typecheck": "tsc -p tsconfig.json --noEmit"
   },
   "dependencies": {
+    "@vcp-dev/i18n": "0.0.0",
     "culori": "^4.0.2",
     "zod": "^4.0.0"
   },