@elastic/isomer-sdk 0.0.0 → 0.1.0

package/dist/render/slack/format.d.ts

@@ -0,0 +1,95 @@
+import { type SlackBlock } from './blocks.js';
+/**
+ * Escapes the three characters Slack treats as HTML in `mrkdwn` text.
+ *
+ * The formatting markers (`*`, `_`, `~`, `` ` ``) are left intact so callers
+ * can compose markdown with them. Wrap text in {@link code} when literal
+ * asterisks are needed.
+ */
+export declare const escapeMrkdwn: (value: string) => string;
+/** `text` escaped and wrapped in mrkdwn bold markers. */
+export declare const bold: (text: string) => string;
+/** `text` escaped and wrapped in mrkdwn italic markers. */
+export declare const italic: (text: string) => string;
+/** `text` escaped and wrapped in mrkdwn strikethrough markers. */
+export declare const strike: (text: string) => string;
+/**
+ * Inline code span. Contents are not mrkdwn-escaped, since `<` and friends are
+ * literal inside a code span; only embedded backticks are demoted, to a
+ * modifier letter that cannot close the span.
+ */
+export declare const code: (text: string) => string;
+/**
+ * Fenced code block. Slack honours the triple-backtick fence but not a language
+ * hint. Embedded triple-backticks are demoted with a zero-width joiner so they
+ * cannot terminate the block early.
+ */
+export declare const codeBlock: (text: string) => string;
+/**
+ * Whether `url` is an `http:` or `https:` URL with a DNS or IPv6 host that
+ * `URL` prints as written, so nothing it repairs or encodes, such as a
+ * backslash, whitespace, or non-ASCII, passes.
+ */
+export declare const isAbsoluteHttpUrl: (url: string) => boolean;
+/**
+ * `href` when {@link sanitizeNavigationHref} passes it and it is an `http:` or
+ * `https:` URL with a host, or a `mailto:` of well-formed mailboxes; `null`
+ * otherwise. Slack has no page to resolve a relative URL against.
+ */
+export declare const slackLinkUrl: (href: string) => string | null;
+/**
+ * Slack mrkdwn link, `<url|label>`, or a bare `<url>` when `label` is omitted.
+ *
+ * URL and label are both escaped so `&` and `>` cannot break Slack's link
+ * parser, and a `|` in the URL is percent-encoded so it cannot end the URL
+ * early. A URL {@link slackLinkUrl} rejects degrades to plain escaped text
+ * with no link.
+ */
+export declare const link: (url: string, label?: string) => string;
+/**
+ * Truncates `value` to `max` UTF-16 code units at a grapheme boundary,
+ * appending an ellipsis when it had to cut. Pass a `SLACK_LIMITS` constant as
+ * the budget.
+ */
+export declare const clampSlackText: (value: string, max: number) => string;
+/**
+ * {@link clampSlackText} for `mrkdwn`: never cuts inside a `<…>` link or
+ * mention or an entity. Formatting marks are left as they fall; Slack prints an
+ * unclosed one as written.
+ */
+export declare const clampMrkdwn: (value: string, max: number) => string;
+/**
+ * `value` cut to `max` UTF-16 code units, never through a surrogate pair. For
+ * opaque values a host reads back, which an ellipsis would change.
+ */
+export declare const cutSlackValue: (value: string, max: number) => string;
+/**
+ * Collapses whitespace and clamps to `SLACK_LIMITS.headerTextChars`. Header
+ * text is `plain_text`, so no markdown survives — do not pre-format it.
+ */
+export declare const formatHeaderText: (value: string) => string;
+/**
+ * Translates GFM into one Slack `mrkdwn` string:
+ *
+ * - Bold `**X**` to `*X*`, links `[L](U)` to `<U|L>`.
+ * - ATX headings to bold, since Slack renders no headings.
+ * - Pipe tables into a fenced code block, mrkdwn having no table syntax — the
+ *   monospace alignment is all that survives. Prefer
+ *   {@link gfmToSlackBlocks} when a native `table` block is acceptable.
+ *
+ * Free text is HTML-escaped (`&` `<` `>`) per Slack's rules; code spans and
+ * fenced blocks pass through untouched.
+ */
+export declare const gfmToSlackMrkdwn: (gfm: string) => string;
+/**
+ * Translates GFM into structural Block Kit: prose runs as `section`, fenced
+ * code as `rich_text_preformatted`, pipe tables as a native `table` block.
+ *
+ * The markdown fallback for a primitive without a `slack` renderer whose
+ * markdown is a string; builder content goes through
+ * `markdownContentToSlackBlocks`. Preferred over {@link gfmToSlackMrkdwn},
+ * which collapses code and tables into
+ * a section-level fence that Slack and pixel-faithful previews render poorly.
+ */
+export declare const gfmToSlackBlocks: (gfm: string) => SlackBlock[];
+//# sourceMappingURL=format.d.ts.map

package/dist/render/slack/format.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"format.d.ts","sourceRoot":"","sources":["../../../src/render/slack/format.ts"],"names":[],"mappings":"AAoBA,OAAO,EAEL,KAAK,UAAU,EAKhB,MAAM,UAAU,CAAC;AAQlB;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,GAAI,OAAO,MAAM,KAAG,MACuB,CAAC;AAErE,yDAAyD;AACzD,eAAO,MAAM,IAAI,GAAI,MAAM,MAAM,KAAG,MAAmC,CAAC;AACxE,2DAA2D;AAC3D,eAAO,MAAM,MAAM,GAAI,MAAM,MAAM,KAAG,MAAmC,CAAC;AAC1E,kEAAkE;AAClE,eAAO,MAAM,MAAM,GAAI,MAAM,MAAM,KAAG,MAAmC,CAAC;AAE1E;;;;GAIG;AACH,eAAO,MAAM,IAAI,GAAI,MAAM,MAAM,KAAG,MACG,CAAC;AAExC;;;;GAIG;AACH,eAAO,MAAM,SAAS,GAAI,MAAM,MAAM,KAAG,MACe,CAAC;AAgCzD;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,GAAI,KAAK,MAAM,KAAG,OAM/C,CAAC;AAmCF;;;;GAIG;AACH,eAAO,MAAM,YAAY,GAAI,MAAM,MAAM,KAAG,MAAM,GAAG,IAMpD,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,IAAI,GAAI,KAAK,MAAM,EAAE,QAAQ,MAAM,KAAG,MAUlD,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,cAAc,GAAI,OAAO,MAAM,EAAE,KAAK,MAAM,KAAG,MAgB3D,CAAC;AAgBF;;;;GAIG;AACH,eAAO,MAAM,WAAW,GAAI,OAAO,MAAM,EAAE,KAAK,MAAM,KAAG,MAiBxD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,aAAa,GAAI,OAAO,MAAM,EAAE,KAAK,MAAM,KAAG,MAG1D,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,gBAAgB,GAAI,OAAO,MAAM,KAAG,MAI9C,CAAC;AA0gBJ;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,gBAAgB,GAAI,KAAK,MAAM,KAAG,MAuE9C,CAAC;AAoDF;;;;;;;;;GASG;AACH,eAAO,MAAM,gBAAgB,GAAI,KAAK,MAAM,KAAG,UAAU,EA4DxD,CAAC"}