@mermkit/adapters 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/dist/index.d.ts +42 -0
  2. package/dist/index.d.ts.map +1 -0
  3. package/dist/index.js +103 -0
  4. package/dist/index.js.map +1 -0
  5. package/package.json +19 -0
package/dist/index.d.ts ADDED
@@ -0,0 +1,42 @@
1
+ import type { Diagram } from "@mermkit/core";
2
+ export type ChatTarget = "slack" | "discord" | "github" | "generic";
3
+ export type ChatImage = {
4
+ bytes: Uint8Array;
5
+ mime: string;
6
+ filename?: string;
7
+ };
8
+ export type AdapterResult<TPayload = Record<string, unknown>> = {
9
+ target: ChatTarget;
10
+ payload: TPayload;
11
+ files?: ChatImage[];
12
+ markdown?: string;
13
+ meta?: Record<string, unknown>;
14
+ };
15
+ export type ChatPayload<TPayload = Record<string, unknown>> = AdapterResult<TPayload>;
16
+ export type SlackPayload = {
17
+ text?: string;
18
+ blocks?: unknown[];
19
+ };
20
+ export type DiscordPayload = {
21
+ content?: string;
22
+ embeds?: unknown[];
23
+ };
24
+ export type GitHubPayload = {
25
+ body: string;
26
+ };
27
+ export type GenericPayload = {
28
+ text?: string;
29
+ markdown?: string;
30
+ };
31
+ export type ChatFormatOptions = {
32
+ image?: ChatImage;
33
+ altText?: string;
34
+ includeCodeBlock?: boolean;
35
+ title?: string;
36
+ };
37
+ export declare function formatForChat(diagram: Diagram, target: ChatTarget, options?: ChatFormatOptions): ChatPayload;
38
+ export declare function formatGenericMessage(diagram: Diagram, options?: ChatFormatOptions): AdapterResult<GenericPayload>;
39
+ export declare function formatSlackMessage(diagram: Diagram, options?: ChatFormatOptions): AdapterResult<SlackPayload>;
40
+ export declare function formatDiscordMessage(diagram: Diagram, options?: ChatFormatOptions): AdapterResult<DiscordPayload>;
41
+ export declare function formatGitHubComment(diagram: Diagram, options?: ChatFormatOptions): AdapterResult<GitHubPayload>;
42
+ //# sourceMappingURL=index.d.ts.map
package/dist/index.d.ts.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAE7C,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;AAEpE,MAAM,MAAM,SAAS,GAAG;IACtB,KAAK,EAAE,UAAU,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,aAAa,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI;IAC9D,MAAM,EAAE,UAAU,CAAC;IACnB,OAAO,EAAE,QAAQ,CAAC;IAClB,KAAK,CAAC,EAAE,SAAS,EAAE,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,WAAW,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,aAAa,CAAC,QAAQ,CAAC,CAAC;AAEtF,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,wBAAgB,aAAa,CAC3B,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,UAAU,EAClB,OAAO,GAAE,iBAAsB,GAC9B,WAAW,CAYb;AAED,wBAAgB,oBAAoB,CAClC,OAAO,EAAE,OAAO,EAChB,OAAO,GAAE,iBAAsB,GAC9B,aAAa,CAAC,cAAc,CAAC,CAa/B;AAED,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,OAAO,EAChB,OAAO,GAAE,iBAAsB,GAC9B,aAAa,CAAC,YAAY,CAAC,CAiC7B;AAED,wBAAgB,oBAAoB,CAClC,OAAO,EAAE,OAAO,EAChB,OAAO,GAAE,iBAAsB,GAC9B,aAAa,CAAC,cAAc,CAAC,CAwB/B;AAED,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,OAAO,EAChB,OAAO,GAAE,iBAAsB,GAC9B,aAAa,CAAC,aAAa,CAAC,CAc9B"}
package/dist/index.js ADDED
@@ -0,0 +1,103 @@
1
+ export function formatForChat(diagram, target, options = {}) {
2
+ switch (target) {
3
+ case "slack":
4
+ return formatSlackMessage(diagram, options);
5
+ case "discord":
6
+ return formatDiscordMessage(diagram, options);
7
+ case "github":
8
+ return formatGitHubComment(diagram, options);
9
+ case "generic":
10
+ default:
11
+ return formatGenericMessage(diagram, options);
12
+ }
13
+ }
14
+ export function formatGenericMessage(diagram, options = {}) {
15
+ const markdown = options.includeCodeBlock === false ? undefined : toMermaidCode(diagram.source);
16
+ const payload = {
17
+ text: options.title ?? "Mermaid diagram",
18
+ markdown
19
+ };
20
+ return {
21
+ target: "generic",
22
+ payload,
23
+ files: options.image ? [ensureFilename(options.image)] : undefined,
24
+ markdown,
25
+ meta: options.image ? { requiresUpload: true } : undefined
26
+ };
27
+ }
28
+ export function formatSlackMessage(diagram, options = {}) {
29
+ const blocks = [];
30
+ const code = options.includeCodeBlock === false ? undefined : toMermaidCode(diagram.source);
31
+ if (code) {
32
+ blocks.push({
33
+ type: "section",
34
+ text: { type: "mrkdwn", text: code }
35
+ });
36
+ }
37
+ if (options.image) {
38
+ const filename = options.image.filename ?? "diagram.png";
39
+ blocks.push({
40
+ type: "image",
41
+ image_url: `attachment://${filename}`,
42
+ alt_text: options.altText ?? "Mermaid diagram",
43
+ title: options.title ? { type: "plain_text", text: options.title } : undefined
44
+ });
45
+ }
46
+ const payload = {
47
+ text: options.title ?? "Mermaid diagram",
48
+ blocks: blocks.length > 0 ? blocks : undefined
49
+ };
50
+ return {
51
+ target: "slack",
52
+ payload,
53
+ files: options.image ? [ensureFilename(options.image)] : undefined,
54
+ markdown: code,
55
+ meta: options.image ? { requiresUpload: true } : undefined
56
+ };
57
+ }
58
+ export function formatDiscordMessage(diagram, options = {}) {
59
+ const content = options.includeCodeBlock === false ? undefined : toMermaidCode(diagram.source);
60
+ const embeds = [];
61
+ if (options.image) {
62
+ const filename = options.image.filename ?? "diagram.png";
63
+ embeds.push({
64
+ title: options.title,
65
+ image: { url: `attachment://${filename}` },
66
+ description: options.altText
67
+ });
68
+ }
69
+ const payload = {
70
+ content,
71
+ embeds: embeds.length > 0 ? embeds : undefined
72
+ };
73
+ return {
74
+ target: "discord",
75
+ payload,
76
+ files: options.image ? [ensureFilename(options.image)] : undefined,
77
+ markdown: content
78
+ };
79
+ }
80
+ export function formatGitHubComment(diagram, options = {}) {
81
+ const code = options.includeCodeBlock === false ? "" : `${toMermaidCode(diagram.source)}\n\n`;
82
+ const filename = options.image?.filename ?? "diagram.png";
83
+ const markdown = options.image
84
+ ? `${code}![Mermaid diagram](<upload_url>)`
85
+ : code.trim() || undefined;
86
+ return {
87
+ target: "github",
88
+ payload: { body: markdown ?? "" },
89
+ files: options.image ? [ensureFilename({ ...options.image, filename })] : undefined,
90
+ markdown,
91
+ meta: options.image ? { imageFilename: filename, needsUploadUrl: true } : undefined
92
+ };
93
+ }
94
+ function toMermaidCode(source) {
95
+ return `\`\`\`mermaid\n${source}\n\`\`\``;
96
+ }
97
+ function ensureFilename(image) {
98
+ if (image.filename)
99
+ return image;
100
+ const ext = image.mime.includes("svg") ? "svg" : image.mime.includes("pdf") ? "pdf" : "png";
101
+ return { ...image, filename: `diagram.${ext}` };
102
+ }
103
+ //# sourceMappingURL=index.js.map
package/dist/index.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AA8CA,MAAM,UAAU,aAAa,CAC3B,OAAgB,EAChB,MAAkB,EAClB,UAA6B,EAAE;IAE/B,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,OAAO;YACV,OAAO,kBAAkB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC9C,KAAK,SAAS;YACZ,OAAO,oBAAoB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAChD,KAAK,QAAQ;YACX,OAAO,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC/C,KAAK,SAAS,CAAC;QACf;YACE,OAAO,oBAAoB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;AACH,CAAC;AAED,MAAM,UAAU,oBAAoB,CAClC,OAAgB,EAChB,UAA6B,EAAE;IAE/B,MAAM,QAAQ,GAAG,OAAO,CAAC,gBAAgB,KAAK,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAChG,MAAM,OAAO,GAAmB;QAC9B,IAAI,EAAE,OAAO,CAAC,KAAK,IAAI,iBAAiB;QACxC,QAAQ;KACT,CAAC;IACF,OAAO;QACL,MAAM,EAAE,SAAS;QACjB,OAAO;QACP,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;QAClE,QAAQ;QACR,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS;KAC3D,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,kBAAkB,CAChC,OAAgB,EAChB,UAA6B,EAAE;IAE/B,MAAM,MAAM,GAAc,EAAE,CAAC;IAC7B,MAAM,IAAI,GAAG,OAAO,CAAC,gBAAgB,KAAK,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAE5F,IAAI,IAAI,EAAE,CAAC;QACT,MAAM,CAAC,IAAI,CAAC;YACV,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE;SACrC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;QAClB,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,QAAQ,IAAI,aAAa,CAAC;QACzD,MAAM,CAAC,IAAI,CAAC;YACV,IAAI,EAAE,OAAO;YACb,SAAS,EAAE,gBAAgB,QAAQ,EAAE;YACrC,QAAQ,EAAE,OAAO,CAAC,OAAO,IAAI,iBAAiB;YAC9C,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS;SAC/E,CAAC,CAAC;IACL,CAAC;IAED,MAAM,OAAO,GAAiB;QAC5B,IAAI,EAAE,OAAO,CAAC,KAAK,IAAI,iBAAiB;QACxC,MAAM,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;KAC/C,CAAC;IAEF,OAAO;QACL,MAAM,EAAE,OAAO;QACf,OAAO;QACP,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;QAClE,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS;KAC3D,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,oBAAoB,CAClC,OAAgB,EAChB,UAA6B,EAAE;IAE/B,MAAM,OAAO,GAAG,OAAO,CAAC,gBAAgB,KAAK,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC/F,MAAM,MAAM,GAAc,EAAE,CAAC;IAE7B,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;QAClB,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,QAAQ,IAAI,aAAa,CAAC;QACzD,MAAM,CAAC,IAAI,CAAC;YACV,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,KAAK,EAAE,EAAE,GAAG,EAAE,gBAAgB,QAAQ,EAAE,EAAE;YAC1C,WAAW,EAAE,OAAO,CAAC,OAAO;SAC7B,CAAC,CAAC;IACL,CAAC;IAED,MAAM,OAAO,GAAmB;QAC9B,OAAO;QACP,MAAM,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;KAC/C,CAAC;IAEF,OAAO;QACL,MAAM,EAAE,SAAS;QACjB,OAAO;QACP,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;QAClE,QAAQ,EAAE,OAAO;KAClB,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,mBAAmB,CACjC,OAAgB,EAChB,UAA6B,EAAE;IAE/B,MAAM,IAAI,GAAG,OAAO,CAAC,gBAAgB,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC;IAC9F,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,EAAE,QAAQ,IAAI,aAAa,CAAC;IAC1D,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK;QAC5B,CAAC,CAAC,GAAG,IAAI,kCAAkC;QAC3C,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,SAAS,CAAC;IAE7B,OAAO;QACL,MAAM,EAAE,QAAQ;QAChB,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,IAAI,EAAE,EAAE;QACjC,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,EAAE,GAAG,OAAO,CAAC,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;QACnF,QAAQ;QACR,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,QAAQ,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS;KACpF,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,MAAc;IACnC,OAAO,kBAAkB,MAAM,UAAU,CAAC;AAC5C,CAAC;AAED,SAAS,cAAc,CAAC,KAAgB;IACtC,IAAI,KAAK,CAAC,QAAQ;QAAE,OAAO,KAAK,CAAC;IACjC,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC;IAC5F,OAAO,EAAE,GAAG,KAAK,EAAE,QAAQ,EAAE,WAAW,GAAG,EAAE,EAAE,CAAC;AAClD,CAAC"}
package/package.json ADDED
@@ -0,0 +1,19 @@
1
+ {
2
+ "name": "@mermkit/adapters",
3
+ "version": "0.1.0",
4
+ "type": "module",
5
+ "main": "dist/index.js",
6
+ "types": "dist/index.d.ts",
7
+ "exports": {
8
+ ".": "./dist/index.js"
9
+ },
10
+ "files": [
11
+ "dist"
12
+ ],
13
+ "scripts": {
14
+ "build": "tsc -b"
15
+ },
16
+ "dependencies": {
17
+ "@mermkit/core": "0.1.0"
18
+ }
19
+ }