@open-feishu-card/schema 0.1.0

package/dist/markdown/builders.js

@@ -0,0 +1,140 @@
+import { FeishuEmojiTokenSchema, } from './emoji-tokens.js';
+import { renderAnchorTag, renderAtTag, renderFontTag, renderInlineAudioTag, renderLinkTag, renderLocalDateTimeTag, renderNumberTag, renderPersonTag, renderTextTag, } from './tags.js';
+/**
+ * 飞书卡片富文本内容构建器。
+ * 拼接标准 Markdown 与飞书扩展 HTML 标签，最终得到 markdown 组件的 content 字符串。
+ */
+export class MarkdownContentBuilder {
+    chunks = [];
+    /** 追加原始片段（可为 Markdown 或已渲染标签） */
+    raw(text) {
+        this.chunks.push(text);
+        return this;
+    }
+    /** 追加纯文本 */
+    text(value) {
+        return this.raw(value);
+    }
+    /** 硬换行（`\n`） */
+    br() {
+        return this.raw('\n');
+    }
+    /** HTML `<br>` / `<br/>` */
+    htmlBr(selfClosing = true) {
+        return this.raw(selfClosing ? '<br/>' : '<br>');
+    }
+    /** 分割线 */
+    hr(style = 'html') {
+        return this.raw(style === 'html' ? '<hr>' : '---');
+    }
+    italic(text) {
+        return this.raw(`*${text}*`);
+    }
+    bold(text) {
+        return this.raw(`**${text}**`);
+    }
+    strike(text) {
+        return this.raw(`~~${text}~~`);
+    }
+    inlineCode(text) {
+        return this.raw(`\`${text}\``);
+    }
+    /** `#` ~ `######` 标题 */
+    heading(level, text) {
+        return this.raw(`${'#'.repeat(level)} ${text}`);
+    }
+    quote(text) {
+        return this.raw(`> ${text}`);
+    }
+    /** Markdown 文字链接 */
+    mdLink(text, url) {
+        return this.raw(`[${text}](${url})`);
+    }
+    /** 可点击电话（仅移动端） */
+    tel(text, phone) {
+        return this.raw(`[${text}](tel://${phone})`);
+    }
+    /** 图片：`![hover](img_key)` */
+    image(imgKey, hoverText = '') {
+        return this.raw(`![${hoverText}](${imgKey})`);
+    }
+    /** 飞书表情：`:DONE:`；key 为官方 emoji_type 枚举 */
+    emoji(key) {
+        const token = FeishuEmojiTokenSchema.parse(key.startsWith(':') && key.endsWith(':') ? key.slice(1, -1) : key);
+        return this.raw(`:${token}:`);
+    }
+    /**
+     * 代码块。language 官方声明大小写不敏感；未指定时为 Plain Text。
+     */
+    codeBlock(code, language) {
+        const lang = language ?? '';
+        return this.raw(`\`\`\`${lang}\n${code}\n\`\`\``);
+    }
+    unorderedList(items, indent = 0) {
+        const prefix = ' '.repeat(indent * 4);
+        for (const item of items) {
+            this.raw(`${prefix}- ${item}\n`);
+        }
+        return this;
+    }
+    orderedList(items, indent = 0) {
+        const prefix = ' '.repeat(indent * 4);
+        items.forEach((item, index) => {
+            this.raw(`${prefix}${index + 1}. ${item}\n`);
+        });
+        return this;
+    }
+    /** Markdown 表格（除表头外客户端最多展示 5 行） */
+    table(headers, rows) {
+        const escapeCell = (cell) => cell.replace(/\|/g, '\\|');
+        const headerLine = `| ${headers.map(escapeCell).join(' | ')} |`;
+        const sepLine = `| ${headers.map(() => '--------').join(' | ')} |`;
+        this.raw(`${headerLine}\n${sepLine}\n`);
+        for (const row of rows) {
+            this.raw(`| ${row.map(escapeCell).join(' | ')} |\n`);
+        }
+        return this;
+    }
+    at(input) {
+        return this.raw(renderAtTag(input));
+    }
+    atAll() {
+        return this.at({ id: 'all' });
+    }
+    person(input) {
+        return this.raw(renderPersonTag(input));
+    }
+    link(input) {
+        return this.raw(renderLinkTag(input));
+    }
+    textTag(input) {
+        return this.raw(renderTextTag(input));
+    }
+    numberTag(input) {
+        return this.raw(renderNumberTag(input));
+    }
+    localDateTime(input = {}) {
+        return this.raw(renderLocalDateTimeTag(input));
+    }
+    font(input) {
+        return this.raw(renderFontTag(input));
+    }
+    anchor(input) {
+        return this.raw(renderAnchorTag(input));
+    }
+    audio(input) {
+        return this.raw(renderInlineAudioTag(input));
+    }
+    /** 生成最终 content 字符串 */
+    build() {
+        return this.chunks.join('');
+    }
+    toString() {
+        return this.build();
+    }
+}
+/** 快捷创建构建器 */
+export function markdown() {
+    return new MarkdownContentBuilder();
+}
+//# sourceMappingURL=builders.js.map

package/dist/markdown/builders.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"builders.js","sourceRoot":"","sources":["../../src/markdown/builders.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,sBAAsB,GAEvB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EACL,eAAe,EACf,WAAW,EACX,aAAa,EACb,oBAAoB,EACpB,aAAa,EACb,sBAAsB,EACtB,eAAe,EACf,eAAe,EACf,aAAa,GAUd,MAAM,WAAW,CAAC;AAEnB;;;GAGG;AACH,MAAM,OAAO,sBAAsB;IAChB,MAAM,GAAa,EAAE,CAAC;IAEvC,iCAAiC;IACjC,GAAG,CAAC,IAAY;QACd,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,YAAY;IACZ,IAAI,CAAC,KAAa;QAChB,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACzB,CAAC;IAED,gBAAgB;IAChB,EAAE;QACA,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED,4BAA4B;IAC5B,MAAM,CAAC,WAAW,GAAG,IAAI;QACvB,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IAClD,CAAC;IAED,UAAU;IACV,EAAE,CAAC,KAAK,GAAkB,MAAM;QAC9B,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,KAAK,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IACrD,CAAC;IAED,MAAM,CAAC,IAAY;QACjB,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,CAAC;IAC/B,CAAC;IAED,IAAI,CAAC,IAAY;QACf,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC;IACjC,CAAC;IAED,MAAM,CAAC,IAAY;QACjB,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC;IACjC,CAAC;IAED,UAAU,CAAC,IAAY;QACrB,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC;IACjC,CAAC;IAED,wBAAwB;IACxB,OAAO,CAAC,KAA4B,EAAE,IAAY;QAChD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;IAClD,CAAC;IAED,KAAK,CAAC,IAAY;QAChB,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;IAC/B,CAAC;IAED,oBAAoB;IACpB,MAAM,CAAC,IAAY,EAAE,GAAW;QAC9B,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,KAAK,GAAG,GAAG,CAAC,CAAC;IACvC,CAAC;IAED,kBAAkB;IAClB,GAAG,CAAC,IAAY,EAAE,KAAa;QAC7B,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,WAAW,KAAK,GAAG,CAAC,CAAC;IAC/C,CAAC;IAED,6BAA6B;IAC7B,KAAK,CAAC,MAAc,EAAE,SAAS,GAAG,EAAE;QAClC,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,SAAS,KAAK,MAAM,GAAG,CAAC,CAAC;IAChD,CAAC;IAED,0CAA0C;IAC1C,KAAK,CAAC,GAA+C;QACnD,MAAM,KAAK,GAAG,sBAAsB,CAAC,KAAK,CACxC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAClE,CAAC;QACF,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC;IAChC,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,IAAY,EAAE,QAA+C;QACrE,MAAM,IAAI,GAAG,QAAQ,IAAI,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC,GAAG,CAAC,SAAS,IAAI,KAAK,IAAI,UAAU,CAAC,CAAC;IACpD,CAAC;IAED,aAAa,CAAC,KAAe,EAAE,MAAM,GAAG,CAAC;QACvC,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QACtC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,IAAI,CAAC,GAAG,CAAC,GAAG,MAAM,KAAK,IAAI,IAAI,CAAC,CAAC;QACnC,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,WAAW,CAAC,KAAe,EAAE,MAAM,GAAG,CAAC;QACrC,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QACtC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;YAC5B,IAAI,CAAC,GAAG,CAAC,GAAG,MAAM,GAAG,KAAK,GAAG,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED,mCAAmC;IACnC,KAAK,CAAC,OAAiB,EAAE,IAAgB;QACvC,MAAM,UAAU,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAChE,MAAM,UAAU,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;QAChE,MAAM,OAAO,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;QACnE,IAAI,CAAC,GAAG,CAAC,GAAG,UAAU,KAAK,OAAO,IAAI,CAAC,CAAC;QACxC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACvD,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,EAAE,CAAC,KAAoB;QACrB,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;IACtC,CAAC;IAED,KAAK;QACH,OAAO,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IAChC,CAAC;IAED,MAAM,CAAC,KAAwB;QAC7B,OAAO,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC;IAC1C,CAAC;IAED,IAAI,CAAC,KAAsB;QACzB,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;IACxC,CAAC;IAED,OAAO,CAAC,KAAsB;QAC5B,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;IACxC,CAAC;IAED,SAAS,CAAC,KAAwB;QAChC,OAAO,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC;IAC1C,CAAC;IAED,aAAa,CAAC,KAAK,GAA6B,EAAE;QAChD,OAAO,IAAI,CAAC,GAAG,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC,CAAC;IACjD,CAAC;IAED,IAAI,CAAC,KAAsB;QACzB,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;IACxC,CAAC;IAED,MAAM,CAAC,KAAwB;QAC7B,OAAO,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC;IAC1C,CAAC;IAED,KAAK,CAAC,KAA6B;QACjC,OAAO,IAAI,CAAC,GAAG,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC;IAC/C,CAAC;IAED,uBAAuB;IACvB,KAAK;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC;IACtB,CAAC;CACF;AAED,cAAc;AACd,MAAM,UAAU,QAAQ;IACtB,OAAO,IAAI,sBAAsB,EAAE,CAAC;AACtC,CAAC"}

package/dist/markdown/code-language.d.ts

@@ -0,0 +1,78 @@
+import { z } from 'zod';
+/**
+ * 富文本代码块支持的编程语言（大小写不敏感）。
+ * @see https://open.feishu.cn/document/feishu-cards/card-json-v2-components/content-components/rich-text
+ */
+export declare const MarkdownCodeLanguageSchema: z.ZodEnum<{
+    abap: "abap";
+    ada: "ada";
+    apache: "apache";
+    apex: "apex";
+    assembly: "assembly";
+    bash: "bash";
+    c: "c";
+    c_sharp: "c_sharp";
+    cmake: "cmake";
+    cobol: "cobol";
+    coffee_script: "coffee_script";
+    cpp: "cpp";
+    css: "css";
+    d: "d";
+    dart: "dart";
+    delphi: "delphi";
+    diff: "diff";
+    django: "django";
+    docker_file: "docker_file";
+    erlang: "erlang";
+    fortran: "fortran";
+    gherkin: "gherkin";
+    go: "go";
+    graphql: "graphql";
+    groovy: "groovy";
+    haskell: "haskell";
+    html: "html";
+    htmlbars: "htmlbars";
+    http: "http";
+    java: "java";
+    javascript: "javascript";
+    json: "json";
+    julia: "julia";
+    kotlin: "kotlin";
+    latex: "latex";
+    lisp: "lisp";
+    lua: "lua";
+    makefile: "makefile";
+    markdown: "markdown";
+    matlab: "matlab";
+    nginx: "nginx";
+    objective_c: "objective_c";
+    opengl_shading_language: "opengl_shading_language";
+    perl: "perl";
+    php: "php";
+    plain_text: "plain_text";
+    powershell: "powershell";
+    prolog: "prolog";
+    properties: "properties";
+    protobuf: "protobuf";
+    python: "python";
+    r: "r";
+    ruby: "ruby";
+    rust: "rust";
+    sas: "sas";
+    scala: "scala";
+    scheme: "scheme";
+    scss: "scss";
+    shell: "shell";
+    solidity: "solidity";
+    sql: "sql";
+    swift: "swift";
+    thrift: "thrift";
+    toml: "toml";
+    typescript: "typescript";
+    vbscript: "vbscript";
+    visual_basic: "visual_basic";
+    xml: "xml";
+    yaml: "yaml";
+}>;
+export type MarkdownCodeLanguage = z.infer<typeof MarkdownCodeLanguageSchema>;
+//# sourceMappingURL=code-language.d.ts.map

package/dist/markdown/code-language.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"code-language.d.ts","sourceRoot":"","sources":["../../src/markdown/code-language.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;GAGG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAwEN,CAAC;AAElC,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC"}

package/dist/markdown/code-language.js

@@ -0,0 +1,79 @@
+import { z } from 'zod';
+/**
+ * 富文本代码块支持的编程语言（大小写不敏感）。
+ * @see https://open.feishu.cn/document/feishu-cards/card-json-v2-components/content-components/rich-text
+ */
+export const MarkdownCodeLanguageSchema = z
+    .enum([
+    'plain_text',
+    'abap',
+    'ada',
+    'apache',
+    'apex',
+    'assembly',
+    'bash',
+    'c_sharp',
+    'cpp',
+    'c',
+    'cmake',
+    'cobol',
+    'css',
+    'coffee_script',
+    'd',
+    'dart',
+    'delphi',
+    'diff',
+    'django',
+    'docker_file',
+    'erlang',
+    'fortran',
+    'gherkin',
+    'go',
+    'graphql',
+    'groovy',
+    'html',
+    'htmlbars',
+    'http',
+    'haskell',
+    'json',
+    'java',
+    'javascript',
+    'julia',
+    'kotlin',
+    'latex',
+    'lisp',
+    'lua',
+    'matlab',
+    'makefile',
+    'markdown',
+    'nginx',
+    'objective_c',
+    'opengl_shading_language',
+    'php',
+    'perl',
+    'powershell',
+    'prolog',
+    'properties',
+    'protobuf',
+    'python',
+    'r',
+    'ruby',
+    'rust',
+    'sas',
+    'scss',
+    'sql',
+    'scala',
+    'scheme',
+    'shell',
+    'solidity',
+    'swift',
+    'toml',
+    'thrift',
+    'typescript',
+    'vbscript',
+    'visual_basic',
+    'xml',
+    'yaml',
+])
+    .describe('富文本代码块语言标识（大小写不敏感）');
+//# sourceMappingURL=code-language.js.map

package/dist/markdown/code-language.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"code-language.js","sourceRoot":"","sources":["../../src/markdown/code-language.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;GAGG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC;KACxC,IAAI,CAAC;IACJ,YAAY;IACZ,MAAM;IACN,KAAK;IACL,QAAQ;IACR,MAAM;IACN,UAAU;IACV,MAAM;IACN,SAAS;IACT,KAAK;IACL,GAAG;IACH,OAAO;IACP,OAAO;IACP,KAAK;IACL,eAAe;IACf,GAAG;IACH,MAAM;IACN,QAAQ;IACR,MAAM;IACN,QAAQ;IACR,aAAa;IACb,QAAQ;IACR,SAAS;IACT,SAAS;IACT,IAAI;IACJ,SAAS;IACT,QAAQ;IACR,MAAM;IACN,UAAU;IACV,MAAM;IACN,SAAS;IACT,MAAM;IACN,MAAM;IACN,YAAY;IACZ,OAAO;IACP,QAAQ;IACR,OAAO;IACP,MAAM;IACN,KAAK;IACL,QAAQ;IACR,UAAU;IACV,UAAU;IACV,OAAO;IACP,aAAa;IACb,yBAAyB;IACzB,KAAK;IACL,MAAM;IACN,YAAY;IACZ,QAAQ;IACR,YAAY;IACZ,UAAU;IACV,QAAQ;IACR,GAAG;IACH,MAAM;IACN,MAAM;IACN,KAAK;IACL,MAAM;IACN,KAAK;IACL,OAAO;IACP,QAAQ;IACR,OAAO;IACP,UAAU;IACV,OAAO;IACP,MAAM;IACN,QAAQ;IACR,YAAY;IACZ,UAAU;IACV,cAAc;IACd,KAAK;IACL,MAAM;CACP,CAAC;KACD,QAAQ,CAAC,oBAAoB,CAAC,CAAC"}