@knpkv/atlassian-common 0.2.0

package/dist/ast/InlineNode.d.ts

@@ -0,0 +1,483 @@
+/**
+ * Inline-level AST nodes for text content (emphasis, links, mentions, etc.).
+ *
+ * **Mental model**
+ *
+ * - **Leaf and recursive nodes**: `Text`, `InlineCode`, `LineBreak` are leaves;
+ *   `Strong`, `Emphasis`, `Highlight` contain nested `InlineNode` children via `Schema.suspend`.
+ * - **Unsupported preservation**: {@link UnsupportedInline} captures raw content that can't be
+ *   mapped, enabling non-destructive roundtrips.
+ *
+ * @module
+ */
+import * as Schema from "effect/Schema";
+/**
+ * Optional raw source HTML for exact roundtrip preservation.
+ *
+ * @category InlineNode
+ */
+export declare const RawSource: Schema.optional<typeof Schema.String>;
+declare const Text_base: Schema.TaggedClass<Text, "Text", {
+    readonly _tag: Schema.tag<"Text">;
+} & {
+    value: typeof Schema.String;
+}>;
+/**
+ * Plain text content.
+ *
+ * @example
+ * ```typescript
+ * import { Text } from "@knpkv/atlassian-common/ast"
+ *
+ * const text = new Text({ value: "Hello world" })
+ * ```
+ *
+ * @category InlineNode
+ */
+export declare class Text extends Text_base {
+}
+declare const InlineCode_base: Schema.TaggedClass<InlineCode, "InlineCode", {
+    readonly _tag: Schema.tag<"InlineCode">;
+} & {
+    value: typeof Schema.String;
+}>;
+/**
+ * Inline code span.
+ *
+ * @example
+ * ```typescript
+ * import { InlineCode } from "@knpkv/atlassian-common/ast"
+ *
+ * const code = new InlineCode({ value: "const x = 1" })
+ * ```
+ *
+ * @category InlineNode
+ */
+export declare class InlineCode extends InlineCode_base {
+}
+declare const LineBreak_base: Schema.TaggedClass<LineBreak, "LineBreak", {
+    readonly _tag: Schema.tag<"LineBreak">;
+}>;
+/**
+ * Line break element.
+ *
+ * @example
+ * ```typescript
+ * import { LineBreak } from "@knpkv/atlassian-common/ast"
+ *
+ * const br = new LineBreak({})
+ * ```
+ *
+ * @category InlineNode
+ */
+export declare class LineBreak extends LineBreak_base {
+}
+declare const UnsupportedInline_base: Schema.TaggedClass<UnsupportedInline, "UnsupportedInline", {
+    readonly _tag: Schema.tag<"UnsupportedInline">;
+} & {
+    raw: typeof Schema.String;
+    source: Schema.Literal<["confluence", "markdown", "adf"]>;
+}>;
+/**
+ * Unsupported inline element - preserves raw content for round-tripping.
+ *
+ * @example
+ * ```typescript
+ * import { UnsupportedInline } from "@knpkv/atlassian-common/ast"
+ *
+ * const unknown = new UnsupportedInline({
+ *   raw: "<custom-tag>content</custom-tag>",
+ *   source: "confluence"
+ * })
+ * ```
+ *
+ * @category InlineNode
+ */
+export declare class UnsupportedInline extends UnsupportedInline_base {
+}
+declare const Emoticon_base: Schema.TaggedClass<Emoticon, "Emoticon", {
+    readonly _tag: Schema.tag<"Emoticon">;
+} & {
+    shortname: typeof Schema.String;
+    emojiId: typeof Schema.String;
+    fallback: typeof Schema.String;
+    rawSource: Schema.optional<typeof Schema.String>;
+}>;
+/**
+ * Emoticon/emoji element.
+ *
+ * @example
+ * ```typescript
+ * import { Emoticon } from "@knpkv/atlassian-common/ast"
+ *
+ * const emoji = new Emoticon({
+ *   shortname: ":grinning:",
+ *   emojiId: "1f600",
+ *   fallback: "grinning"
+ * })
+ * ```
+ *
+ * @category InlineNode
+ */
+export declare class Emoticon extends Emoticon_base {
+}
+declare const UserMention_base: Schema.TaggedClass<UserMention, "UserMention", {
+    readonly _tag: Schema.tag<"UserMention">;
+} & {
+    accountId: typeof Schema.String;
+    rawSource: Schema.optional<typeof Schema.String>;
+}>;
+/**
+ * User mention element.
+ *
+ * @example
+ * ```typescript
+ * import { UserMention } from "@knpkv/atlassian-common/ast"
+ *
+ * const mention = new UserMention({ accountId: "557058:..." })
+ * ```
+ *
+ * @category InlineNode
+ */
+export declare class UserMention extends UserMention_base {
+}
+declare const DateTime_base: Schema.TaggedClass<DateTime, "DateTime", {
+    readonly _tag: Schema.tag<"DateTime">;
+} & {
+    datetime: typeof Schema.String;
+    rawSource: Schema.optional<typeof Schema.String>;
+}>;
+/**
+ * Date/time element.
+ *
+ * @example
+ * ```typescript
+ * import { DateTime } from "@knpkv/atlassian-common/ast"
+ *
+ * const date = new DateTime({ datetime: "2026-01-01" })
+ * ```
+ *
+ * @category InlineNode
+ */
+export declare class DateTime extends DateTime_base {
+}
+declare const Underline_base: Schema.TaggedClass<Underline, "Underline", {
+    readonly _tag: Schema.tag<"Underline">;
+} & {
+    children: Schema.suspend<readonly (Text | InlineCode | LineBreak | UnsupportedInline | Emoticon | UserMention | DateTime)[], readonly ({
+        readonly value: string;
+        readonly _tag: "Text";
+    } | {
+        readonly value: string;
+        readonly _tag: "InlineCode";
+    } | {
+        readonly _tag: "LineBreak";
+    } | {
+        readonly source: "confluence" | "markdown" | "adf";
+        readonly _tag: "UnsupportedInline";
+        readonly raw: string;
+    } | {
+        readonly _tag: "Emoticon";
+        readonly shortname: string;
+        readonly emojiId: string;
+        readonly fallback: string;
+        readonly rawSource?: string | undefined;
+    } | {
+        readonly _tag: "UserMention";
+        readonly accountId: string;
+        readonly rawSource?: string | undefined;
+    } | {
+        readonly _tag: "DateTime";
+        readonly datetime: string;
+        readonly rawSource?: string | undefined;
+    })[], never>;
+}>;
+/**
+ * Underlined text.
+ *
+ * @category InlineNode
+ */
+export declare class Underline extends Underline_base {
+}
+declare const Subscript_base: Schema.TaggedClass<Subscript, "Subscript", {
+    readonly _tag: Schema.tag<"Subscript">;
+} & {
+    children: Schema.suspend<readonly (Text | InlineCode | LineBreak | UnsupportedInline | Emoticon | UserMention | DateTime)[], readonly ({
+        readonly value: string;
+        readonly _tag: "Text";
+    } | {
+        readonly value: string;
+        readonly _tag: "InlineCode";
+    } | {
+        readonly _tag: "LineBreak";
+    } | {
+        readonly source: "confluence" | "markdown" | "adf";
+        readonly _tag: "UnsupportedInline";
+        readonly raw: string;
+    } | {
+        readonly _tag: "Emoticon";
+        readonly shortname: string;
+        readonly emojiId: string;
+        readonly fallback: string;
+        readonly rawSource?: string | undefined;
+    } | {
+        readonly _tag: "UserMention";
+        readonly accountId: string;
+        readonly rawSource?: string | undefined;
+    } | {
+        readonly _tag: "DateTime";
+        readonly datetime: string;
+        readonly rawSource?: string | undefined;
+    })[], never>;
+}>;
+/**
+ * Subscript text.
+ *
+ * @category InlineNode
+ */
+export declare class Subscript extends Subscript_base {
+}
+declare const Superscript_base: Schema.TaggedClass<Superscript, "Superscript", {
+    readonly _tag: Schema.tag<"Superscript">;
+} & {
+    children: Schema.suspend<readonly (Text | InlineCode | LineBreak | UnsupportedInline | Emoticon | UserMention | DateTime)[], readonly ({
+        readonly value: string;
+        readonly _tag: "Text";
+    } | {
+        readonly value: string;
+        readonly _tag: "InlineCode";
+    } | {
+        readonly _tag: "LineBreak";
+    } | {
+        readonly source: "confluence" | "markdown" | "adf";
+        readonly _tag: "UnsupportedInline";
+        readonly raw: string;
+    } | {
+        readonly _tag: "Emoticon";
+        readonly shortname: string;
+        readonly emojiId: string;
+        readonly fallback: string;
+        readonly rawSource?: string | undefined;
+    } | {
+        readonly _tag: "UserMention";
+        readonly accountId: string;
+        readonly rawSource?: string | undefined;
+    } | {
+        readonly _tag: "DateTime";
+        readonly datetime: string;
+        readonly rawSource?: string | undefined;
+    })[], never>;
+}>;
+/**
+ * Superscript text.
+ *
+ * @category InlineNode
+ */
+export declare class Superscript extends Superscript_base {
+}
+declare const Strikethrough_base: Schema.TaggedClass<Strikethrough, "Strikethrough", {
+    readonly _tag: Schema.tag<"Strikethrough">;
+} & {
+    children: Schema.suspend<readonly (Text | InlineCode | LineBreak | UnsupportedInline | Emoticon | UserMention | DateTime)[], readonly ({
+        readonly value: string;
+        readonly _tag: "Text";
+    } | {
+        readonly value: string;
+        readonly _tag: "InlineCode";
+    } | {
+        readonly _tag: "LineBreak";
+    } | {
+        readonly source: "confluence" | "markdown" | "adf";
+        readonly _tag: "UnsupportedInline";
+        readonly raw: string;
+    } | {
+        readonly _tag: "Emoticon";
+        readonly shortname: string;
+        readonly emojiId: string;
+        readonly fallback: string;
+        readonly rawSource?: string | undefined;
+    } | {
+        readonly _tag: "UserMention";
+        readonly accountId: string;
+        readonly rawSource?: string | undefined;
+    } | {
+        readonly _tag: "DateTime";
+        readonly datetime: string;
+        readonly rawSource?: string | undefined;
+    })[], never>;
+}>;
+/**
+ * Strikethrough text.
+ *
+ * @category InlineNode
+ */
+export declare class Strikethrough extends Strikethrough_base {
+}
+declare const ColoredText_base: Schema.TaggedClass<ColoredText, "ColoredText", {
+    readonly _tag: Schema.tag<"ColoredText">;
+} & {
+    color: typeof Schema.String;
+    children: Schema.suspend<readonly (Text | InlineCode | LineBreak | UnsupportedInline | Emoticon | UserMention | DateTime)[], readonly ({
+        readonly value: string;
+        readonly _tag: "Text";
+    } | {
+        readonly value: string;
+        readonly _tag: "InlineCode";
+    } | {
+        readonly _tag: "LineBreak";
+    } | {
+        readonly source: "confluence" | "markdown" | "adf";
+        readonly _tag: "UnsupportedInline";
+        readonly raw: string;
+    } | {
+        readonly _tag: "Emoticon";
+        readonly shortname: string;
+        readonly emojiId: string;
+        readonly fallback: string;
+        readonly rawSource?: string | undefined;
+    } | {
+        readonly _tag: "UserMention";
+        readonly accountId: string;
+        readonly rawSource?: string | undefined;
+    } | {
+        readonly _tag: "DateTime";
+        readonly datetime: string;
+        readonly rawSource?: string | undefined;
+    })[], never>;
+}>;
+/**
+ * Colored text with CSS color value.
+ *
+ * @category InlineNode
+ */
+export declare class ColoredText extends ColoredText_base {
+}
+declare const Highlight_base: Schema.TaggedClass<Highlight, "Highlight", {
+    readonly _tag: Schema.tag<"Highlight">;
+} & {
+    backgroundColor: typeof Schema.String;
+    children: Schema.suspend<readonly (Text | InlineCode | LineBreak | UnsupportedInline | Emoticon | UserMention | DateTime)[], readonly ({
+        readonly value: string;
+        readonly _tag: "Text";
+    } | {
+        readonly value: string;
+        readonly _tag: "InlineCode";
+    } | {
+        readonly _tag: "LineBreak";
+    } | {
+        readonly source: "confluence" | "markdown" | "adf";
+        readonly _tag: "UnsupportedInline";
+        readonly raw: string;
+    } | {
+        readonly _tag: "Emoticon";
+        readonly shortname: string;
+        readonly emojiId: string;
+        readonly fallback: string;
+        readonly rawSource?: string | undefined;
+    } | {
+        readonly _tag: "UserMention";
+        readonly accountId: string;
+        readonly rawSource?: string | undefined;
+    } | {
+        readonly _tag: "DateTime";
+        readonly datetime: string;
+        readonly rawSource?: string | undefined;
+    })[], never>;
+}>;
+/**
+ * Highlighted text with background color.
+ *
+ * @category InlineNode
+ */
+export declare class Highlight extends Highlight_base {
+}
+/**
+ * Inline node children schema - use this for recursive inline content.
+ *
+ * @category InlineNode
+ */
+export declare const InlineNodeChildren: Schema.Schema<ReadonlyArray<InlineNode>>;
+declare const Strong_base: Schema.TaggedClass<Strong, "Strong", {
+    readonly _tag: Schema.tag<"Strong">;
+} & {
+    children: Schema.suspend<readonly InlineNode[], readonly InlineNode[], never>;
+}>;
+/**
+ * Strong/bold text.
+ *
+ * @example
+ * ```typescript
+ * import { Strong, Text } from "@knpkv/atlassian-common/ast"
+ *
+ * const bold = new Strong({ children: [new Text({ value: "important" })] })
+ * ```
+ *
+ * @category InlineNode
+ */
+export declare class Strong extends Strong_base {
+}
+declare const Emphasis_base: Schema.TaggedClass<Emphasis, "Emphasis", {
+    readonly _tag: Schema.tag<"Emphasis">;
+} & {
+    children: Schema.suspend<readonly InlineNode[], readonly InlineNode[], never>;
+}>;
+/**
+ * Emphasized/italic text.
+ *
+ * @example
+ * ```typescript
+ * import { Emphasis, Text } from "@knpkv/atlassian-common/ast"
+ *
+ * const italic = new Emphasis({ children: [new Text({ value: "emphasized" })] })
+ * ```
+ *
+ * @category InlineNode
+ */
+export declare class Emphasis extends Emphasis_base {
+}
+declare const Link_base: Schema.TaggedClass<Link, "Link", {
+    readonly _tag: Schema.tag<"Link">;
+} & {
+    href: typeof Schema.String;
+    title: Schema.optional<typeof Schema.String>;
+    children: Schema.suspend<readonly InlineNode[], readonly InlineNode[], never>;
+    rawSource: Schema.optional<typeof Schema.String>;
+}>;
+/**
+ * Hyperlink with optional title.
+ *
+ * @example
+ * ```typescript
+ * import { Link, Text } from "@knpkv/atlassian-common/ast"
+ *
+ * const link = new Link({
+ *   href: "https://example.com",
+ *   title: "Example",
+ *   children: [new Text({ value: "Click here" })]
+ * })
+ * ```
+ *
+ * @category InlineNode
+ */
+export declare class Link extends Link_base {
+}
+/**
+ * Union of all inline node types.
+ *
+ * @category InlineNode
+ */
+export declare const InlineNode: Schema.Union<[typeof Text, typeof Strong, typeof Emphasis, typeof InlineCode, typeof Link, typeof LineBreak, typeof Emoticon, typeof UserMention, typeof DateTime, typeof Underline, typeof Subscript, typeof Superscript, typeof Strikethrough, typeof ColoredText, typeof Highlight, typeof UnsupportedInline]>;
+/**
+ * Type for inline nodes.
+ *
+ * @category Types
+ */
+export type InlineNode = Text | Strong | Emphasis | InlineCode | Link | LineBreak | Emoticon | UserMention | DateTime | Underline | Subscript | Superscript | Strikethrough | ColoredText | Highlight | UnsupportedInline;
+/**
+ * Schema type helper for InlineNode.
+ *
+ * @category Types
+ */
+export type InlineNodeSchema = typeof InlineNode;
+export {};
+//# sourceMappingURL=InlineNode.d.ts.map

package/dist/ast/InlineNode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"InlineNode.d.ts","sourceRoot":"","sources":["../../src/ast/InlineNode.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAEvC;;;;GAIG;AACH,eAAO,MAAM,SAAS,uCAAiC,CAAA;;;;;;AAEvD;;;;;;;;;;;GAWG;AACH,qBAAa,IAAK,SAAQ,SAExB;CAAG;;;;;;AAEL;;;;;;;;;;;GAWG;AACH,qBAAa,UAAW,SAAQ,eAE9B;CAAG;;;;AAEL;;;;;;;;;;;GAWG;AACH,qBAAa,SAAU,SAAQ,cAAgD;CAAG;;;;;;;AAElF;;;;;;;;;;;;;;GAcG;AACH,qBAAa,iBAAkB,SAAQ,sBAGrC;CAAG;;;;;;;;;AAEL;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,QAAS,SAAQ,aAK5B;CAAG;;;;;;;AAEL;;;;;;;;;;;GAWG;AACH,qBAAa,WAAY,SAAQ,gBAG/B;CAAG;;;;;;;AAEL;;;;;;;;;;;GAWG;AACH,qBAAa,QAAS,SAAQ,aAG5B;CAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEL;;;;GAIG;AACH,qBAAa,SAAU,SAAQ,cAE7B;CAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEL;;;;GAIG;AACH,qBAAa,SAAU,SAAQ,cAE7B;CAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEL;;;;GAIG;AACH,qBAAa,WAAY,SAAQ,gBAE/B;CAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEL;;;;GAIG;AACH,qBAAa,aAAc,SAAQ,kBAEjC;CAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEL;;;;GAIG;AACH,qBAAa,WAAY,SAAQ,gBAG/B;CAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEL;;;;GAIG;AACH,qBAAa,SAAU,SAAQ,cAG7B;CAAG;AAaL;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,EAAE,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,UAAU,CAAC,CAEvE,CAAA;;;;;;AAED;;;;;;;;;;;GAWG;AACH,qBAAa,MAAO,SAAQ,WAE1B;CAAG;;;;;;AAEL;;;;;;;;;;;GAWG;AACH,qBAAa,QAAS,SAAQ,aAE5B;CAAG;;;;;;;;;AAEL;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,IAAK,SAAQ,SAKxB;CAAG;AAEL;;;;GAIG;AACH,eAAO,MAAM,UAAU,mTAiBtB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAClB,IAAI,GACJ,MAAM,GACN,QAAQ,GACR,UAAU,GACV,IAAI,GACJ,SAAS,GACT,QAAQ,GACR,WAAW,GACX,QAAQ,GACR,SAAS,GACT,SAAS,GACT,WAAW,GACX,aAAa,GACb,WAAW,GACX,SAAS,GACT,iBAAiB,CAAA;AAErB;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,OAAO,UAAU,CAAA"}