@nkootstra/block-kit 0.0.1 → 0.1.1

package/dist/index-gBduJdQh.d.ts

@@ -0,0 +1,127 @@
+
+//#region src/parser/ast.d.ts
+/** Nodes produced by {@link parse}. Plain objects so they can cross any serialization boundary. */
+type MrkdwnNode = BlockNode | InlineNode;
+interface Root {
+  type: "root";
+  children: MrkdwnNode[];
+}
+type BlockNode = Preformatted | Quote;
+/** A ``` fenced block. Content is shown verbatim, only HTML entities are decoded. */
+interface Preformatted {
+  type: "preformatted";
+  value: string;
+}
+/** Lines starting with `>`, or everything after `>>>`. */
+interface Quote {
+  type: "quote";
+  children: InlineNode[];
+}
+type InlineNode = Text | Bold | Italic | Strike | Code | Link | UserMention | ChannelMention | UsergroupMention | Broadcast | DateNode | Emoji;
+/** Plain text. May contain `\n`, which renderers should turn into line breaks. */
+interface Text {
+  type: "text";
+  value: string;
+}
+interface Bold {
+  type: "bold";
+  children: InlineNode[];
+}
+interface Italic {
+  type: "italic";
+  children: InlineNode[];
+}
+interface Strike {
+  type: "strike";
+  children: InlineNode[];
+}
+interface Code {
+  type: "code";
+  value: string;
+}
+/** `<https://example.com|label>` or an auto-linked bare URL. */
+interface Link {
+  type: "link";
+  url: string;
+  /** Parsed label. Absent when the link has no `|label` part, in which case the URL is shown. */
+  children?: InlineNode[];
+}
+/** `<@U123>` or the legacy `<@U123|name>`. */
+interface UserMention {
+  type: "user";
+  id: string;
+  label?: string;
+}
+/** `<#C123>` or `<#C123|name>`. */
+interface ChannelMention {
+  type: "channel";
+  id: string;
+  label?: string;
+}
+/** `<!subteam^S123>` or `<!subteam^S123|@handle>`. */
+interface UsergroupMention {
+  type: "usergroup";
+  id: string;
+  label?: string;
+}
+/** `<!here>`, `<!channel>`, `<!everyone>`. */
+interface Broadcast {
+  type: "broadcast";
+  range: "here" | "channel" | "everyone";
+  label?: string;
+}
+/** `<!date^1392734382^{date_short} at {time}^https://link|fallback>`. */
+interface DateNode {
+  type: "date";
+  /** Unix timestamp in seconds. */
+  timestamp: number;
+  /** Format string with `{token}` placeholders. */
+  format: string;
+  url?: string;
+  fallback: string;
+}
+/** `:smile:` or `:thumbsup::skin-tone-3:`. Renderers fall back to the raw text for unknown names. */
+interface Emoji {
+  type: "emoji";
+  name: string;
+  /** 2–6, as in Slack's `skin-tone-N` modifiers. */
+  skinTone?: number;
+}
+//#endregion
+//#region src/parser/date.d.ts
+interface FormatDateOptions {
+  /** BCP 47 locale. Slack formats dates in the viewer's locale. Defaults to `en-US`. */
+  locale?: string;
+  /** IANA time zone. Defaults to the runtime's zone. */
+  timeZone?: string;
+  /** Reference time for `{ago}` and the `_pretty` variants. Defaults to `Date.now()`. */
+  now?: number;
+}
+/**
+ * Formats a `<!date^...>` token string the way Slack does, e.g.
+ * `formatSlackDate(1392734382, "{date_short} at {time}")` → `Feb 18, 2014 at 6:39 AM`.
+ * Unknown `{tokens}` are left as they are.
+ */
+declare function formatSlackDate(timestamp: number, format: string, options?: FormatDateOptions): string;
+//#endregion
+//#region src/parser/parse.d.ts
+interface ParseOptions {
+  /**
+   * Mirrors the `verbatim` flag on Slack text objects. When `false` (Slack's default),
+   * bare URLs are turned into links. When `true`, only explicit `<...>` markup is linked.
+   */
+  verbatim?: boolean;
+}
+/** Parses Slack mrkdwn into an AST. Never throws: malformed markup is kept as text. */
+declare function parse(input: string, options?: ParseOptions): Root;
+declare function decodeEntities(text: string): string;
+//#endregion
+//#region src/parser/plainText.d.ts
+/**
+ * Converts `:name:` shortcodes in a `plain_text` object's text into emoji nodes. Plain text has no
+ * other mrkdwn formatting (no bold/links/mentions), so this only ever produces `text` and `emoji`.
+ */
+declare function parsePlainTextEmoji(input: string): Array<Text | Emoji>;
+//#endregion
+export { UserMention as C, Text as S, MrkdwnNode as _, FormatDateOptions as a, Root as b, Bold as c, Code as d, DateNode as f, Link as g, Italic as h, parse as i, Broadcast as l, InlineNode as m, ParseOptions as n, formatSlackDate as o, Emoji as p, decodeEntities as r, BlockNode as s, parsePlainTextEmoji as t, ChannelMention as u, Preformatted as v, UsergroupMention as w, Strike as x, Quote as y };
+//# sourceMappingURL=index-gBduJdQh.d.ts.map

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+
+import { $ as BlockSuggestionPayload, A as BlockAction, B as StackedView, C as SlackAttachment, Ct as BlockProps, D as elementComponents, E as SlackReaction, F as EmojiOptions, G as SurfaceScopeProps, H as SubmitResult, I as MessageApi, J as ViewsApi, K as SurfaceScopeValue, L as MessageUpdate, M as BlockKitProvider, N as BlockKitProviderProps, O as Element, P as ElementState, Q as BlockActionsPayload, R as PayloadContext, S as MessageProps, St as Blocks, T as SlackMessageLike, Tt as Json, U as Surface, V as StateValues, W as SurfaceScope, X as useContainer, Y as useBlockKit, Z as useLiveView, _ as HomeTabView, _t as buildBlockSuggestionPayload, a as Tooltip, at as MessageBlockActionsPayload, b as Message, bt as blockComponents, c as TextObject, ct as PayloadIdentity, d as ViewProps, dt as SuggestionOption, et as BuildBlockActionsPayloadOptions, f as Modal, ft as ViewBlockActionsPayload, g as HomeTabProps, gt as buildBlockActionsPayload, h as HomeTab, ht as ViewResponseAction, i as UserMentionProps, it as Container, j as BlockKitContextValue, k as ActionContext, l as AnyView, lt as PayloadTeam, m as ModalView, mt as ViewLike, n as validateView, nt as BuildViewClosedPayloadOptions, o as TooltipProps, ot as MessageContainer, p as ModalProps, pt as ViewContainer, q as UserProfile, r as UserMention, rt as BuildViewSubmissionPayloadOptions, s as Text, st as OptionsResponse, t as VALIDATION_MESSAGES, tt as BuildBlockSuggestionPayloadOptions, u as View, ut as PayloadUser, v as Mrkdwn, vt as buildViewClosedPayload, w as SlackAttachmentField, wt as ElementProps, x as MessageApp, xt as Block, y as MrkdwnProps, yt as buildViewSubmissionPayload, z as Resolvers } from "./index-FPjJcmn3.js";
+export { type ActionContext, type AnyView, Block, type BlockAction, type BlockActionsPayload, type BlockKitContextValue, BlockKitProvider, type BlockKitProviderProps, type BlockProps, type BlockSuggestionPayload, Blocks, type BuildBlockActionsPayloadOptions, type BuildBlockSuggestionPayloadOptions, type BuildViewClosedPayloadOptions, type BuildViewSubmissionPayloadOptions, type Container, Element, type ElementProps, type ElementState, type EmojiOptions, HomeTab, type HomeTabProps, type HomeTabView, type Json, Message, type MessageApi, type MessageApp, type MessageBlockActionsPayload, type MessageContainer, type MessageProps, type MessageUpdate, Modal, type ModalProps, type ModalView, Mrkdwn, type MrkdwnProps, type OptionsResponse, type PayloadContext, type PayloadIdentity, type PayloadTeam, type PayloadUser, type Resolvers, type SlackAttachment, type SlackAttachmentField, type SlackMessageLike, type SlackReaction, type StackedView, type StateValues, type SubmitResult, type SuggestionOption, type Surface, SurfaceScope, type SurfaceScopeProps, type SurfaceScopeValue, Text, type TextObject, Tooltip, type TooltipProps, UserMention, type UserMentionProps, type UserProfile, VALIDATION_MESSAGES, View, type ViewBlockActionsPayload, type ViewContainer, type ViewLike, type ViewProps, type ViewResponseAction, type ViewsApi, blockComponents, buildBlockActionsPayload, buildBlockSuggestionPayload, buildViewClosedPayload, buildViewSubmissionPayload, elementComponents, useBlockKit, useContainer, useLiveView, validateView };