@knpkv/atlassian-common 1.0.0 → 1.2.0

package/src/serializers/MarkdownSerializer.ts

@@ -22,8 +22,10 @@
  * @module
  */
 import * as Effect from "effect/Effect"
+import type { BlockNode, BlockQuote, List } from "../ast/BlockNode.js"
 import type { Document, DocumentNode } from "../ast/Document.js"
 import type { InlineNode } from "../ast/InlineNode.js"
+import type { ExpandMacro, InfoPanel } from "../ast/MacroNode.js"
 import type { SerializeError } from "../SerializeError.js"
 
 /**
@@ -242,28 +244,18 @@ const serializeTable = (
     return lines.join("\n")
   })
 
-// Simple block type for list items - use unknown for flexibility
-type SimpleBlock = unknown
-
-// List item type
-type ListItemType = {
-  readonly _tag: "ListItem"
-  readonly checked?: boolean | undefined
-  readonly children: ReadonlyArray<unknown>
-}
-
 /**
  * Serialize list.
  */
 const serializeList = (
-  node: { ordered: boolean; start?: number | undefined; children: ReadonlyArray<unknown> },
+  node: List,
   options: SerializeOptions
 ): Effect.Effect<string, SerializeError> =>
   Effect.gen(function*() {
     const lines: Array<string> = []
     let counter = node.start ?? 1
 
-    for (const item of node.children as ReadonlyArray<ListItemType>) {
+    for (const item of node.children) {
       const prefix = node.ordered ? `${counter}.` : "-"
       const checkbox = item.checked !== undefined ? (item.checked ? "[x] " : "[ ] ") : ""
 
@@ -291,38 +283,31 @@ const serializeList = (
  * Serialize simple block (for nested content).
  */
 const serializeSimpleBlock = (
-  node: SimpleBlock,
+  node: BlockNode,
   options: SerializeOptions
 ): Effect.Effect<string, SerializeError> =>
   Effect.gen(function*() {
-    const tagged = node as { readonly _tag: string }
-    switch (tagged._tag) {
+    switch (node._tag) {
       case "Heading":
-        return yield* serializeHeading(
-          node as unknown as { level: 1 | 2 | 3 | 4 | 5 | 6; children: ReadonlyArray<InlineNode> }
-        )
+        return yield* serializeHeading(node)
       case "Paragraph":
-        return yield* serializeParagraph(node as unknown as { children: ReadonlyArray<InlineNode> })
+        return yield* serializeParagraph(node)
       case "CodeBlock":
-        return serializeCodeBlock(node as unknown as { code: string; language?: string | undefined })
+        return serializeCodeBlock(node)
       case "ThematicBreak":
         return "---"
       case "Image":
-        return serializeImage(
-          node as unknown as { src: string; alt?: string | undefined; title?: string | undefined },
-          options
-        )
+        return serializeImage(node, options)
       case "Table":
-        return yield* serializeTable(
-          node as unknown as {
-            header?: { cells: ReadonlyArray<{ children: ReadonlyArray<InlineNode> }> } | undefined
-            rows: ReadonlyArray<{ cells: ReadonlyArray<{ children: ReadonlyArray<InlineNode> }> }>
-          }
-        )
-      case "UnsupportedBlock": {
-        const unsupported = node as unknown as { rawMarkdown?: string; rawHtml?: string; rawAdf?: string }
-        return unsupported.rawMarkdown ?? unsupported.rawHtml ?? unsupported.rawAdf ?? ""
-      }
+        return yield* serializeTable(node)
+      case "List":
+        return yield* serializeList(node, options)
+      case "BlockQuote":
+        return yield* serializeBlockQuote(node, options)
+      case "TaskList":
+        return yield* serializeTaskList(node.children, options)
+      case "UnsupportedBlock":
+        return node.rawMarkdown ?? node.rawHtml ?? node.rawAdf ?? ""
       default:
         return ""
     }
@@ -332,7 +317,7 @@ const serializeSimpleBlock = (
  * Serialize block quote.
  */
 const serializeBlockQuote = (
-  node: { children: ReadonlyArray<unknown> },
+  node: BlockQuote,
   options: SerializeOptions
 ): Effect.Effect<string, SerializeError> =>
   Effect.gen(function*() {
@@ -349,7 +334,7 @@ const serializeBlockQuote = (
  * Serialize info panel to container syntax.
  */
 const serializeInfoPanel = (
-  node: { panelType: string; title?: string | undefined; children: ReadonlyArray<unknown> },
+  node: InfoPanel,
   options: SerializeOptions
 ): Effect.Effect<string, SerializeError> =>
   Effect.gen(function*() {
@@ -370,7 +355,7 @@ const serializeInfoPanel = (
  * Serialize expand macro.
  */
 const serializeExpandMacro = (
-  node: { title?: string | undefined; children: ReadonlyArray<unknown> },
+  node: ExpandMacro,
   options: SerializeOptions
 ): Effect.Effect<string, SerializeError> =>
   Effect.gen(function*() {

package/test/AuthProfiles.test.ts

@@ -57,7 +57,7 @@ const makeMockFS = (files: Record<string, string> = {}) => {
 
   return {
     store,
-    layer: Layer.succeed(FileSystem.FileSystem, FileSystem.FileSystem.of(partial as FileSystem.FileSystem))
+    layer: Layer.succeed(FileSystem.FileSystem, FileSystem.FileSystem.of(partial))
   }
 }
 

package/test/OAuthEndpoints.test.ts

@@ -2,11 +2,24 @@ import * as NodeCrypto from "@effect/platform-node/NodeCrypto"
 import { it as effectIt } from "@effect/vitest"
 import * as Effect from "effect/Effect"
 import { describe, expect, it } from "vitest"
-import { AUTH_URL, buildAuthUrl, computeCodeChallenge, generateCodeVerifier } from "../src/auth/OAuthEndpoints.js"
+import {
+  AUTH_URL,
+  buildAuthUrl,
+  computeCodeChallenge,
+  CONFLUENCE_SCOPES,
+  generateCodeVerifier
+} from "../src/auth/OAuthEndpoints.js"
 
 const withCrypto = <A, E, R>(effect: Effect.Effect<A, E, R>) => effect.pipe(Effect.provide(NodeCrypto.layer))
 
 describe("OAuthEndpoints", () => {
+  describe("CONFLUENCE_SCOPES", () => {
+    it("includes attachment read and write scopes", () => {
+      expect(CONFLUENCE_SCOPES).toContain("read:attachment:confluence")
+      expect(CONFLUENCE_SCOPES).toContain("write:attachment:confluence")
+    })
+  })
+
   // ---- PKCE ----
 
   describe("generateCodeVerifier", () => {
@@ -77,6 +90,20 @@ describe("OAuthEndpoints", () => {
       expect(parsed.searchParams.get("prompt")).toBe("consent")
     })
 
+    it("uses an application callback URL when supplied", () => {
+      const url = buildAuthUrl({
+        clientId: "cid",
+        state: "state-123",
+        port: 4173,
+        redirectUri: "http://127.0.0.1:4173/services/oauth/atlassian/callback",
+        scopes: ["read:me"]
+      })
+
+      expect(new URL(url).searchParams.get("redirect_uri")).toBe(
+        "http://127.0.0.1:4173/services/oauth/atlassian/callback"
+      )
+    })
+
     // PKCE is optional — omitting codeChallenge must not add params (backwards compat)
     it("omits PKCE params when codeChallenge not provided", () => {
       const url = buildAuthUrl({

package/test/OAuthOperations.test.ts

@@ -127,6 +127,22 @@ describe("OAuthOperations", () => {
         expect(body.code_verifier).toBe("my-verifier")
       }))
 
+    it.effect("uses the same application callback URL during exchange", () =>
+      Effect.gen(function*() {
+        const { capturedRequests, mockClient } = createMockHttpClient([{ status: 200, body: validTokenBody }])
+        const redirectUri = "http://127.0.0.1:4173/services/oauth/atlassian/callback"
+
+        yield* exchangeCodeForTokens("auth-code", oauthConfig, { port: 4173, redirectUri }).pipe(
+          provide(mockClient)
+        )
+
+        const request = capturedRequests[0]!
+        const body = yield* request.body._tag === "Uint8Array"
+          ? Effect.succeed(JSON.parse(new TextDecoder().decode(request.body.body)))
+          : Effect.succeed({})
+        expect(body.redirect_uri).toBe(redirectUri)
+      }))
+
     // Token exchange failures (invalid code, expired code) must surface as OAuthError with step="token"
     it.effect("returns OAuthError with step=token on HTTP 400", () =>
       Effect.gen(function*() {

package/test/ProfileManager.test.ts

@@ -64,7 +64,7 @@ const makeMockFS = () => {
   }
   return {
     store,
-    layer: Layer.succeed(FileSystem.FileSystem, FileSystem.FileSystem.of(partial as FileSystem.FileSystem))
+    layer: Layer.succeed(FileSystem.FileSystem, FileSystem.FileSystem.of(partial))
   }
 }
 

package/test/attachments.test.ts

@@ -0,0 +1,75 @@
+import { describe, expect, it } from "vitest"
+import { isPreviewableAttachment, renderAttachmentMarkdown, replaceAttachmentPlaceholder } from "../src/attachments.js"
+
+describe("attachment helpers", () => {
+  it("treats SVG as previewable even with a generic media type", () => {
+    expect(isPreviewableAttachment({
+      filename: "diagram.svg",
+      mediaType: "application/octet-stream"
+    })).toBe(true)
+  })
+
+  it("renders image attachments as previews and other attachments as links", () => {
+    expect(renderAttachmentMarkdown({
+      id: "1",
+      filename: "screenshot.png",
+      url: "https://example.test/screenshot.png",
+      mediaType: "image/png",
+      size: 1
+    })).toBe("![screenshot.png](https://example.test/screenshot.png)")
+
+    expect(renderAttachmentMarkdown({
+      id: "2",
+      filename: "debug.log",
+      url: "https://example.test/debug.log",
+      mediaType: "text/plain",
+      size: 1
+    })).toBe("[debug.log](https://example.test/debug.log)")
+  })
+
+  it("escapes labels and wraps unsafe destinations in rendered markdown", () => {
+    expect(renderAttachmentMarkdown({
+      id: "1",
+      filename: "weird ] name\n.svg",
+      url: "https://example.test/a file(1).svg",
+      mediaType: "image/svg+xml",
+      size: 1
+    })).toBe("![weird \\] name .svg](<https://example.test/a file(1).svg>)")
+  })
+
+  it("uses an explicit label when rendering attachment markdown", () => {
+    expect(renderAttachmentMarkdown({
+      id: "1",
+      filename: "diagram.svg",
+      url: "https://example.test/diagram.svg",
+      mediaType: "image/svg+xml",
+      size: 1
+    }, { label: "Architecture diagram" })).toBe("![Architecture diagram](https://example.test/diagram.svg)")
+  })
+
+  it("replaces a named local Markdown placeholder", () => {
+    const result = replaceAttachmentPlaceholder(
+      "before\n![Diagram](./diagram.svg)\nafter",
+      "./diagram.svg",
+      "![diagram.svg](https://example.test/diagram.svg)"
+    )
+
+    expect(result).toEqual({
+      replacements: 1,
+      content: "before\n![diagram.svg](https://example.test/diagram.svg)\nafter"
+    })
+  })
+
+  it("passes the placeholder label to callback replacements", () => {
+    const result = replaceAttachmentPlaceholder(
+      "before\n![Architecture diagram](./diagram.svg)\nafter",
+      "./diagram.svg",
+      ({ isImage, label }) => `${isImage ? "!" : ""}[${label}](https://example.test/diagram.svg)`
+    )
+
+    expect(result).toEqual({
+      replacements: 1,
+      content: "before\n![Architecture diagram](https://example.test/diagram.svg)\nafter"
+    })
+  })
+})

package/test/fixtures/attachments/inline-attachment.svg

@@ -0,0 +1,6 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="160" height="80" viewBox="0 0 160 80" role="img" aria-label="Inline attachment test asset">
+  <rect width="160" height="80" fill="#f4f7fb"/>
+  <rect x="12" y="12" width="136" height="56" rx="6" fill="#ffffff" stroke="#2f6fed" stroke-width="3"/>
+  <circle cx="40" cy="40" r="13" fill="#ffb000"/>
+  <path d="M66 51h58M66 39h72M66 28h44" stroke="#243b53" stroke-width="6" stroke-linecap="round"/>
+</svg>

package/tsconfig.build.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "http://json.schemastore.org/tsconfig",
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "composite": true,
+    "incremental": true,
+    "tsBuildInfoFile": "node_modules/.cache/tsconfig.build.tsbuildinfo"
+  }
+}