@knpkv/jira-cli 1.6.1 → 1.6.2

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @knpkv/jira-cli
 
+## 1.6.2
+
+### Patch Changes
+
+- [#579](https://github.com/knpkv/npm/pull/579) [`61c930e`](https://github.com/knpkv/npm/commit/61c930e88f4a9d735522d6c7b052b72d13450a6f) Thanks [@konopkov](https://github.com/konopkov)! - Tests typecheck as part of `check`. `externalizeAdfMetadata` returns the sidecar type `hydrateAdfMetadata` takes.
+- Updated dependencies [[`61c930e`](https://github.com/knpkv/npm/commit/61c930e88f4a9d735522d6c7b052b72d13450a6f)]:
+  - @knpkv/atlassian-common@1.9.1
+
 ## 1.6.1
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knpkv/jira-cli",
-  "version": "1.6.1",
+  "version": "1.6.2",
   "description": "CLI tool to fetch Jira tickets and export to markdown",
   "license": "MIT",
   "author": "knpkv",
@@ -61,8 +61,8 @@
     "gray-matter": "^4.0.3",
     "js-yaml": "5.4.2",
     "@knpkv/agent-skills": "^0.3.4",
-    "@knpkv/atlassian-common": "1.9.0",
-    "@knpkv/jira-api-client": "2.1.0"
+    "@knpkv/jira-api-client": "2.1.0",
+    "@knpkv/atlassian-common": "1.9.1"
   },
   "devDependencies": {
     "@effect/vitest": "4.0.0",
@@ -90,6 +90,6 @@
     "test:watch": "vitest",
     "lint": "eslint src",
     "lint:fix": "eslint src --fix",
-    "check": "tsc --noEmit"
+    "check": "tsc --noEmit && tsc -p test/tsconfig.json --noEmit"
   }
 }

package/test/VersionService.test.ts

@@ -187,7 +187,7 @@ describe("stripEmails", () => {
     const stripped = stripEmails(versionWithEmails)
     expect(stripped.driver?.displayName).toBe("Dana")
     expect(stripped.contributors.map((c) => c.accountId)).toEqual(["c1", "c2"])
-    expect(stripped.approvers[0].status).toBe("APPROVED")
+    expect(stripped.approvers[0]?.status).toBe("APPROVED")
     expect(stripped.tickets.map((t) => t.key)).toEqual(["PROJ-1", "PROJ-2"])
   })
 
@@ -195,7 +195,7 @@ describe("stripEmails", () => {
     // The command emits the unmodified version when --emails is set; assert the
     // original is untouched (stripEmails returns a copy, never mutating input).
     expect(versionWithEmails.driver?.emailAddress).toBe("dana@example.com")
-    expect(versionWithEmails.tickets[0].assignee?.emailAddress).toBe("tom@example.com")
+    expect(versionWithEmails.tickets[0]?.assignee?.emailAddress).toBe("tom@example.com")
   })
 
   it("handles a null driver and null assignees without throwing", () => {
@@ -249,39 +249,40 @@ const makeJiraLayer = () => {
   )
 }
 
-describe("listProjectVersions filtering", () => {
+// One stateless Jira stub for the block; the layer is built once per block, not per test.
+it.layer(VersionServiceLayer.pipe(Layer.provideMerge(makeJiraLayer())))("listProjectVersions filtering", (it) => {
   it.effect("returns all versions when neither flag is set", () =>
     Effect.gen(function*() {
       const service = yield* VersionService
       const list = yield* service.listProjectVersions("PROJ")
       expect(list.map((v) => v.id)).toEqual(["1", "2", "3", "4"])
-    }).pipe(Effect.provide(VersionServiceLayer), Effect.provide(makeJiraLayer())))
+    }))
 
   it.effect("keeps only released versions when released=true", () =>
     Effect.gen(function*() {
       const service = yield* VersionService
       const list = yield* service.listProjectVersions("PROJ", { released: true })
       expect(list.map((v) => v.id)).toEqual(["1", "3"])
-    }).pipe(Effect.provide(VersionServiceLayer), Effect.provide(makeJiraLayer())))
+    }))
 
   it.effect("keeps only unreleased versions when unreleased=true", () =>
     Effect.gen(function*() {
       const service = yield* VersionService
       const list = yield* service.listProjectVersions("PROJ", { unreleased: true })
       expect(list.map((v) => v.id)).toEqual(["2", "4"])
-    }).pipe(Effect.provide(VersionServiceLayer), Effect.provide(makeJiraLayer())))
+    }))
 
   it.effect("caps the result count at maxResults", () =>
     Effect.gen(function*() {
       const service = yield* VersionService
       const list = yield* service.listProjectVersions("PROJ", { maxResults: 2 })
       expect(list.map((v) => v.id)).toEqual(["1", "2"])
-    }).pipe(Effect.provide(VersionServiceLayer), Effect.provide(makeJiraLayer())))
+    }))
 
   it.effect("preserves Jira Premium contributors decoded from the generated Version schema", () =>
     Effect.gen(function*() {
       const service = yield* VersionService
       const list = yield* service.listProjectVersions("PROJ", { maxResults: 1 })
       expect(list[0]?.contributors.map((person) => person.accountId)).toEqual(["account-1", "account-2"])
-    }).pipe(Effect.provide(VersionServiceLayer), Effect.provide(makeJiraLayer())))
+    }))
 })

package/test/authCommand.test.ts

@@ -25,7 +25,6 @@ const browserOpens = ChildProcessSpawner.make(() =>
     isRunning: Effect.succeed(false),
     kill: () => Effect.void,
     pid: ChildProcessSpawner.ProcessId(1),
-    reref: Effect.void,
     stderr: Stream.empty,
     stdin: Sink.drain,
     stdout: Stream.empty,

package/test/commandTree.test.ts

@@ -1,3 +1,4 @@
+import { NodeServices } from "@effect/platform-node"
 import { describe, expect, it } from "@effect/vitest"
 import { Command } from "effect/cli"
 import * as Effect from "effect/Effect"
@@ -95,7 +96,7 @@ const sampleRelatedWork: RelatedWork = {
 const CaptureTerminalLayer = (stdout: Ref.Ref<string>) =>
   Layer.succeed(
     Terminal.Terminal,
-    Terminal.Terminal.of({
+    Terminal.make({
       columns: Effect.succeed(100),
       rows: Effect.succeed(24),
       readInput: Effect.die("readInput should not be called"),
@@ -174,6 +175,15 @@ const CommandServicesLayer = (calls: Ref.Ref<CommandCalls>) =>
     )
   )
 
+/** Run `effect` with `layer`'s services, built in the effect's own scope. */
+const runWithLayer = <A, E, R>(effect: Effect.Effect<A, E, R>, layer: Layer.Layer<R>): Effect.Effect<A, E> =>
+  Effect.scoped(
+    Effect.gen(function*() {
+      const context = yield* Layer.build(layer)
+      return yield* effect.pipe(Effect.provideContext(context))
+    })
+  )
+
 const runJiraCommand = (
   args: ReadonlyArray<string>,
   calls: Ref.Ref<CommandCalls>,
@@ -184,10 +194,11 @@ const runJiraCommand = (
     Command.withSubcommands([issueCommand, versionCommand])
   )
   const cli = Command.runWith(command, { version: "0.0.0-test" })
-  return cli(args).pipe(
-    Effect.provide(Layer.merge(CommandServicesLayer(calls), CaptureTerminalLayer(stdout))),
-    Effect.exit
-  )
+  return runWithLayer(
+    cli(args),
+    // The platform services the CLI runner requires; these commands never touch them.
+    Layer.mergeAll(NodeServices.layer, CommandServicesLayer(calls), CaptureTerminalLayer(stdout))
+  ).pipe(Effect.exit)
 }
 
 describe("Jira command tree", () => {

package/test/frontmatter.test.ts

@@ -1,6 +1,5 @@
 import { describe, expect, it } from "@effect/vitest"
-import * as Predicate from "effect/Predicate"
-import type * as Schema from "effect/Schema"
+import * as Schema from "effect/Schema"
 import * as yaml from "js-yaml"
 import { extractFrontMatter, serializeIssue } from "../src/internal/frontmatter.js"
 import type { Issue } from "../src/IssueService.js"
@@ -10,17 +9,17 @@ import type { Issue } from "../src/IssueService.js"
  * directly. We avoid gray-matter's default parser here because it calls the
  * removed `safeLoad` — the same incompatibility this module works around.
  */
+const FrontMatter = Schema.Record(Schema.String, Schema.Json)
+
 const parseFrontMatter = (output: string): Record<string, Schema.Json> => {
-  const match = output.match(/^---\n([\s\S]*?)\n---/)
-  const parsed = match ? yaml.load(match[1]) : {}
-  return parsed !== null && Predicate.isObjectOrArray(parsed) && !Array.isArray(parsed)
-    ? Object.fromEntries(Object.entries(parsed))
-    : {}
+  const match = /^---\n([\s\S]*?)\n---/.exec(output)
+  return Schema.decodeUnknownSync(FrontMatter)(match?.[1] === undefined ? {} : yaml.load(match[1]))
 }
 
 const makeIssue = (overrides: Partial<Issue> = {}): Issue => ({
   key: "OOB-81",
   id: "10081",
+  url: "https://example.atlassian.net/browse/OOB-81",
   summary: "Test ticket",
   status: "Done",
   type: "Story",
@@ -70,6 +69,7 @@ describe("frontmatter", () => {
           filename: "diagram.svg",
           url: "https://example.atlassian.net/rest/api/3/attachment/content/10001",
           mediaType: "application/octet-stream",
+          mimeType: "image/svg+xml",
           size: 42
         }]
       }))

package/test/integration.test.ts

@@ -14,12 +14,12 @@ import * as NodeHttpClient from "@effect/platform-node/NodeHttpClient"
 import * as NodeServices from "@effect/platform-node/NodeServices"
 import { describe, expect, it } from "@effect/vitest"
 import { JiraApiClient, JiraApiConfig } from "@knpkv/jira-api-client"
-import { Config, Effect, Layer, Option } from "effect"
+import { Config, Data, Effect, Layer, Option } from "effect"
 import * as FileSystem from "effect/FileSystem"
 import * as Path from "effect/Path"
 import * as Predicate from "effect/Predicate"
 import * as Redacted from "effect/Redacted"
-import type * as Schema from "effect/Schema"
+import * as Schema from "effect/Schema"
 import * as yaml from "js-yaml"
 import { AttachmentService, layer as AttachmentServiceLayer } from "../src/AttachmentService.js"
 import { insertJiraAttachmentReference } from "../src/internal/attachmentInsertion.js"
@@ -45,14 +45,21 @@ const nonEmptyOrDefault = (value: Option.Option<string>, fallback: string): stri
     onSome: (some) => some.trim().length > 0 ? some : fallback
   })
 
-const requireNonEmpty = (name: string, value: string): Effect.Effect<string, Error> =>
-  value.trim().length > 0 ? Effect.succeed(value) : Effect.fail(new Error(`${name} must be set`))
+/** An integration setting that is set but empty. */
+class EmptySetting extends Data.TaggedError("EmptySetting")<{ readonly name: string }> {
+  override get message() {
+    return `${this.name} must be set`
+  }
+}
+
+const requireNonEmpty = (name: string, value: string): Effect.Effect<string, EmptySetting> =>
+  value.trim().length > 0 ? Effect.succeed(value) : Effect.fail(new EmptySetting({ name }))
 
 const requireNonEmptyRedacted = (
   name: string,
   value: Redacted.Redacted<string>
-): Effect.Effect<Redacted.Redacted<string>, Error> =>
-  Redacted.value(value).trim().length > 0 ? Effect.succeed(value) : Effect.fail(new Error(`${name} must be set`))
+): Effect.Effect<Redacted.Redacted<string>, EmptySetting> =>
+  Redacted.value(value).trim().length > 0 ? Effect.succeed(value) : Effect.fail(new EmptySetting({ name }))
 
 const SHOULD_RUN_INTEGRATION = Effect.runSync(
   Config.option(Config.String("JIRA_INTEGRATION")).pipe(
@@ -164,10 +171,9 @@ const expectCanonicalIssueIncludesAttachmentMedia = (
 
 const parseFrontMatter = (markdown: string): Record<string, Schema.Json> => {
   const match = /^---\n([\s\S]*?)\n---/.exec(markdown)
-  const parsed = match?.[1] ? yaml.load(match[1]) : {}
-  return parsed !== null && Predicate.isObjectOrArray(parsed) && !Array.isArray(parsed)
-    ? Object.fromEntries(Object.entries(parsed))
-    : {}
+  return Schema.decodeUnknownSync(Schema.Record(Schema.String, Schema.Json))(
+    match?.[1] === undefined ? {} : yaml.load(match[1])
+  )
 }
 
 const getIssueAsMarkdown = (config: IntegrationConfig, testDir: string) =>

package/test/remoteWrites.test.ts

@@ -61,6 +61,14 @@ const makeRecordingLayer = (respond: (request: HttpClientRequest.HttpClientReque
 
 const json = <UnparsedInput>(body: UnparsedInput, status = 200) =>
   new Response(JSON.stringify(body), { status, headers: { "content-type": "application/json" } })
+/** Run `effect` with `layer`'s services, built in the effect's own scope. */
+const runWithLayer = <A, E, R>(effect: Effect.Effect<A, E, R>, layer: Layer.Layer<R>): Effect.Effect<A, E> =>
+  Effect.scoped(
+    Effect.gen(function*() {
+      const context = yield* Layer.build(layer)
+      return yield* effect.pipe(Effect.provideContext(context))
+    })
+  )
 
 describe("IssueService.edit", () => {
   /**
@@ -102,9 +110,13 @@ describe("IssueService.edit", () => {
       expect(issue.fixVersions).toEqual(["OOB 100"])
       expect(issue.labels).toEqual(["domain:oob"])
     }).pipe(
-      Effect.provide(IssueServiceLayer),
-      Effect.provide(layer),
-      Effect.provide(Layer.succeed(SiteUrl, "https://example.atlassian.net"))
+      (effect) =>
+        runWithLayer(
+          effect,
+          IssueServiceLayer.pipe(
+            Layer.provideMerge(Layer.merge(layer, Layer.succeed(SiteUrl, "https://example.atlassian.net")))
+          )
+        )
     )
   })
 
@@ -128,9 +140,13 @@ describe("IssueService.edit", () => {
       // The write really did go out — that is why the wording matters.
       expect(calls.filter((call) => call.method === "PUT")).toHaveLength(1)
     }).pipe(
-      Effect.provide(IssueServiceLayer),
-      Effect.provide(layer),
-      Effect.provide(Layer.succeed(SiteUrl, "https://example.atlassian.net"))
+      (effect) =>
+        runWithLayer(
+          effect,
+          IssueServiceLayer.pipe(
+            Layer.provideMerge(Layer.merge(layer, Layer.succeed(SiteUrl, "https://example.atlassian.net")))
+          )
+        )
     )
   })
 
@@ -147,9 +163,13 @@ describe("IssueService.edit", () => {
       expect(result.message).toContain("--fix-version cannot be combined")
       expect(calls).toHaveLength(0)
     }).pipe(
-      Effect.provide(IssueServiceLayer),
-      Effect.provide(layer),
-      Effect.provide(Layer.succeed(SiteUrl, "https://example.atlassian.net"))
+      (effect) =>
+        runWithLayer(
+          effect,
+          IssueServiceLayer.pipe(
+            Layer.provideMerge(Layer.merge(layer, Layer.succeed(SiteUrl, "https://example.atlassian.net")))
+          )
+        )
     )
   })
 })
@@ -180,7 +200,7 @@ describe("VersionService.createVersion", () => {
       expect(post?.body).toEqual({ name: "OOB 100", projectId: 10001, description: "Q3 release" })
       expect(version.id).toBe("10042")
       expect(version.released).toBe(false)
-    }).pipe(Effect.provide(VersionServiceLayer), Effect.provide(layer))
+    }).pipe((effect) => runWithLayer(effect, VersionServiceLayer.pipe(Layer.provideMerge(layer))))
   })
 
   /** Omitted optional fields must be absent, not sent as `undefined`/null. */
@@ -199,7 +219,7 @@ describe("VersionService.createVersion", () => {
         name: "OOB 100",
         projectId: 10001
       })
-    }).pipe(Effect.provide(VersionServiceLayer), Effect.provide(layer))
+    }).pipe((effect) => runWithLayer(effect, VersionServiceLayer.pipe(Layer.provideMerge(layer))))
   })
 
   /**
@@ -215,6 +235,6 @@ describe("VersionService.createVersion", () => {
 
       expect(error.message).toContain("no usable numeric id")
       expect(calls.filter((call) => call.method === "POST")).toHaveLength(0)
-    }).pipe(Effect.provide(VersionServiceLayer), Effect.provide(layer))
+    }).pipe((effect) => runWithLayer(effect, VersionServiceLayer.pipe(Layer.provideMerge(layer))))
   })
 })

package/test/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "noEmit": true,
+    "composite": false,
+    "declaration": false,
+    "declarationMap": false,
+    "rootDir": "..",
+    "outDir": null,
+    "tsBuildInfoFile": null
+  },
+  "include": ["../src", "."],
+  "exclude": []
+}