@open-feishu-card/schema 0.1.0

package/dist/config.js

@@ -0,0 +1,123 @@
+import { z } from 'zod';
+import { DirectionSchema, HorizontalAlignSchema, I18nStringMapSchema, SpacingTokenSchema, SpacingValueSchema, TextSizeSchema, VerticalAlignSchema, WidthModeSchema, } from './common/enums.js';
+import { getElementSchema } from './element-ref.js';
+/**
+ * 流式更新频率/步长的分端配置。
+ */
+const StreamingPlatformNumberSchema = z
+    .object({
+    default: z.number().optional().describe('默认端数值'),
+    android: z.number().optional().describe('Android 端数值'),
+    ios: z.number().optional().describe('iOS 端数值'),
+    pc: z.number().optional().describe('PC 端数值'),
+})
+    .describe('按端区分的数值配置（default / android / ios / pc）');
+/**
+ * 流式更新配置。
+ */
+export const StreamingConfigSchema = z
+    .object({
+    print_frequency_ms: StreamingPlatformNumberSchema.optional().describe('流式更新打印频率，单位 ms'),
+    print_step: StreamingPlatformNumberSchema.optional().describe('流式更新每次打印的字符数'),
+    print_strategy: z
+        .enum(['fast', 'delay'])
+        .optional()
+        .describe('流式更新策略：fast / delay'),
+})
+    .describe('流式更新相关配置（streaming_config）');
+/**
+ * 卡片摘要（聊天栏预览文案）。
+ */
+export const SummarySchema = z
+    .object({
+    content: z
+        .string()
+        .optional()
+        .describe('摘要文案；开启流式更新时默认为「生成中」'),
+    i18n_content: I18nStringMapSchema.optional().describe('摘要多语言配置'),
+})
+    .describe('卡片摘要信息，展示在客户端聊天栏消息预览中');
+/**
+ * 自定义字号（分别配置 PC / Mobile，并可选 default 兜底）。
+ * 各端取值可为官方枚举或 10px–40px。
+ */
+export const CustomTextSizeSchema = z
+    .object({
+    default: TextSizeSchema.optional().describe('旧版客户端无法差异化配置时的兜底字号'),
+    pc: TextSizeSchema.describe('桌面端字号（官方枚举或 10px–40px）'),
+    mobile: TextSizeSchema.describe('移动端字号（官方枚举或 10px–40px）'),
+})
+    .describe('自定义字号（PC / Mobile / 可选 default）');
+/**
+ * 自定义颜色（浅色/深色主题 RGBA）。
+ */
+export const CustomColorSchema = z
+    .object({
+    light_mode: z.string().describe('浅色主题下的 RGBA 颜色'),
+    dark_mode: z.string().describe('深色主题下的 RGBA 颜色'),
+})
+    .describe('自定义颜色（浅色 / 深色主题）');
+/**
+ * 卡片全局行为配置（config）。
+ */
+export const ConfigSchema = z
+    .object({
+    streaming_mode: z
+        .boolean()
+        .optional()
+        .describe('是否处于流式更新模式，默认 false'),
+    streaming_config: StreamingConfigSchema.optional().describe('流式更新配置'),
+    summary: SummarySchema.optional().describe('卡片摘要信息'),
+    locales: z
+        .array(z.string())
+        .optional()
+        .describe('指定生效语言列表；配置后仅列表内语言生效'),
+    enable_forward: z
+        .boolean()
+        .optional()
+        .describe('是否允许转发卡片，默认 true'),
+    update_multi: z
+        .boolean()
+        .optional()
+        .describe('是否为共享卡片，默认 true。JSON 2.0 只能为 true（或不写）；禁止写 false'),
+    width_mode: WidthModeSchema.optional().describe('卡片宽度模式'),
+    use_custom_translation: z
+        .boolean()
+        .optional()
+        .describe('是否使用自定义翻译数据，默认 false'),
+    enable_forward_interaction: z
+        .boolean()
+        .optional()
+        .describe('转发后的卡片是否仍支持回传交互，默认 false'),
+    style: z
+        .object({
+        text_size: z
+            .record(z.string(), CustomTextSizeSchema)
+            .optional()
+            .describe('自定义字号映射，可在组件中引用对应 key'),
+        color: z
+            .record(z.string(), CustomColorSchema)
+            .optional()
+            .describe('自定义颜色映射，可在组件中引用对应 key'),
+    })
+        .optional()
+        .describe('自定义字号与颜色样式'),
+})
+    .describe('卡片全局行为配置（config）');
+/**
+ * 卡片正文（body）。
+ */
+export const BodySchema = z
+    .object({
+    elements: z
+        .lazy(() => z.array(getElementSchema()))
+        .describe('正文组件列表。默认直接放 markdown / column_set / hr / form / table / img / chart / button；form 与 table 必须在此根级。层次靠字重、留白、浅灰弱底与偶尔一条 hr，不靠满屏色块或边框墙'),
+    direction: DirectionSchema.optional().describe('正文内组件排列方向，默认 vertical'),
+    padding: SpacingValueSchema.optional().describe('正文内边距'),
+    horizontal_spacing: SpacingTokenSchema.optional().describe('正文水平间距'),
+    horizontal_align: HorizontalAlignSchema.optional().describe('正文水平对齐，默认 left'),
+    vertical_spacing: SpacingTokenSchema.optional().describe('正文垂直间距'),
+    vertical_align: VerticalAlignSchema.optional().describe('正文垂直对齐，默认 top'),
+})
+    .describe('卡片正文（body）。白底可读；form/table 仅允许出现在 elements 根级');
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EACL,eAAe,EACf,qBAAqB,EACrB,mBAAmB,EACnB,kBAAkB,EAClB,kBAAkB,EAClB,cAAc,EACd,mBAAmB,EACnB,eAAe,GAChB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEpD;;GAEG;AACH,MAAM,6BAA6B,GAAG,CAAC;KACpC,MAAM,CAAC;IACN,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC;IAChD,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC;IACtD,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC;IAC9C,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC;CAC7C,CAAC;KACD,QAAQ,CAAC,yCAAyC,CAAC,CAAC;AAEvD;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC;KACnC,MAAM,CAAC;IACN,kBAAkB,EAAE,6BAA6B,CAAC,QAAQ,EAAE,CAAC,QAAQ,CACnE,gBAAgB,CACjB;IACD,UAAU,EAAE,6BAA6B,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAC3D,cAAc,CACf;IACD,cAAc,EAAE,CAAC;SACd,IAAI,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;SACvB,QAAQ,EAAE;SACV,QAAQ,CAAC,qBAAqB,CAAC;CACnC,CAAC;KACD,QAAQ,CAAC,4BAA4B,CAAC,CAAC;AAI1C;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC;KAC3B,MAAM,CAAC;IACN,OAAO,EAAE,CAAC;SACP,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,sBAAsB,CAAC;IACnC,YAAY,EAAE,mBAAmB,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC;CACjE,CAAC;KACD,QAAQ,CAAC,uBAAuB,CAAC,CAAC;AAIrC;;;GAGG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC;KAClC,MAAM,CAAC;IACN,OAAO,EAAE,cAAc,CAAC,QAAQ,EAAE,CAAC,QAAQ,CACzC,oBAAoB,CACrB;IACD,EAAE,EAAE,cAAc,CAAC,QAAQ,CAAC,wBAAwB,CAAC;IACrD,MAAM,EAAE,cAAc,CAAC,QAAQ,CAAC,wBAAwB,CAAC;CAC1D,CAAC;KACD,QAAQ,CAAC,iCAAiC,CAAC,CAAC;AAI/C;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC;KAC/B,MAAM,CAAC;IACN,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,gBAAgB,CAAC;IACjD,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,gBAAgB,CAAC;CACjD,CAAC;KACD,QAAQ,CAAC,kBAAkB,CAAC,CAAC;AAIhC;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC;KAC1B,MAAM,CAAC;IACN,cAAc,EAAE,CAAC;SACd,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CAAC,qBAAqB,CAAC;IAClC,gBAAgB,EAAE,qBAAqB,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC;IACrE,OAAO,EAAE,aAAa,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC;IACpD,OAAO,EAAE,CAAC;SACP,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACjB,QAAQ,EAAE;SACV,QAAQ,CAAC,sBAAsB,CAAC;IACnC,cAAc,EAAE,CAAC;SACd,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CAAC,kBAAkB,CAAC;IAC/B,YAAY,EAAE,CAAC;SACZ,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CACP,kDAAkD,CACnD;IACH,UAAU,EAAE,eAAe,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC;IACzD,sBAAsB,EAAE,CAAC;SACtB,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CAAC,sBAAsB,CAAC;IACnC,0BAA0B,EAAE,CAAC;SAC1B,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CAAC,0BAA0B,CAAC;IACvC,KAAK,EAAE,CAAC;SACL,MAAM,CAAC;QACN,SAAS,EAAE,CAAC;aACT,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,oBAAoB,CAAC;aACxC,QAAQ,EAAE;aACV,QAAQ,CAAC,uBAAuB,CAAC;QACpC,KAAK,EAAE,CAAC;aACL,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,iBAAiB,CAAC;aACrC,QAAQ,EAAE;aACV,QAAQ,CAAC,uBAAuB,CAAC;KACrC,CAAC;SACD,QAAQ,EAAE;SACV,QAAQ,CAAC,YAAY,CAAC;CAC1B,CAAC;KACD,QAAQ,CAAC,kBAAkB,CAAC,CAAC;AAIhC;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC;KACxB,MAAM,CAAC;IACN,QAAQ,EAAE,CAAC;SACR,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,gBAAgB,EAAE,CAAC,CAAC;SACvC,QAAQ,CACP,oIAAoI,CACrI;IACH,SAAS,EAAE,eAAe,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAC5C,uBAAuB,CACxB;IACD,OAAO,EAAE,kBAAkB,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC;IACxD,kBAAkB,EAAE,kBAAkB,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC;IACpE,gBAAgB,EAAE,qBAAqB,CAAC,QAAQ,EAAE,CAAC,QAAQ,CACzD,gBAAgB,CACjB;IACD,gBAAgB,EAAE,kBAAkB,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC;IAClE,cAAc,EAAE,mBAAmB,CAAC,QAAQ,EAAE,CAAC,QAAQ,CACrD,eAAe,CAChB;CACF,CAAC;KACD,QAAQ,CACP,+CAA+C,CAChD,CAAC"}