@knpkv/jira-cli 0.1.1 → 0.3.0

package/src/IssueService.ts

@@ -29,7 +29,7 @@ import { JiraApiError } from "./JiraCliError.js"
  *
  * @category Config
  */
-export class SiteUrl extends Context.Tag("@knpkv/jira-cli/SiteUrl")<SiteUrl, string>() {}
+export class SiteUrl extends Context.Service<SiteUrl, string>()("@knpkv/jira-cli/SiteUrl") {}
 
 /**
  * Attachment metadata.
@@ -104,6 +104,12 @@ export interface SearchResult {
   readonly maxResults: number
 }
 
+interface SearchJqlResponse {
+  readonly issues?: ReadonlyArray<unknown>
+  readonly isLast?: boolean
+  readonly nextPageToken?: string
+}
+
 /**
  * IssueService interface.
  *
@@ -138,10 +144,10 @@ export interface IssueServiceShape {
  *
  * @category Services
  */
-export class IssueService extends Context.Tag("@knpkv/jira-cli/IssueService")<
+export class IssueService extends Context.Service<
   IssueService,
   IssueServiceShape
->() {}
+>()("@knpkv/jira-cli/IssueService") {}
 
 const FIELDS = [
   "summary",
@@ -299,7 +305,7 @@ const make = Effect.gen(function*() {
     jql: string,
     maxResults: number,
     nextPageToken?: string
-  ) =>
+  ): Effect.Effect<SearchJqlResponse, JiraApiError> =>
     toEffect(client.v3.client.GET("/rest/api/3/search/jql", {
       params: {
         query: {
@@ -311,6 +317,7 @@ const make = Effect.gen(function*() {
         }
       }
     })).pipe(
+      Effect.map((result) => result as SearchJqlResponse),
       Effect.mapError((cause) => new JiraApiError({ message: "Failed to search issues", cause }))
     )
 
@@ -336,36 +343,35 @@ const make = Effect.gen(function*() {
   const searchAll = (
     jql: string,
     options?: { readonly maxResults?: number }
-  ): Effect.Effect<ReadonlyArray<Issue>, JiraApiError> =>
-    Effect.gen(function*() {
-      const allIssues: Array<Issue> = []
-      const maxResults = options?.maxResults ?? 100
-      let nextPageToken: string | undefined = undefined
-      let pageCount = 0
-
-      // Fetch first page
-      let result = yield* searchJql(jql, maxResults, nextPageToken)
-      let issues = result.issues ?? []
+  ): Effect.Effect<ReadonlyArray<Issue>, JiraApiError> => (Effect.gen(function*() {
+    const allIssues: Array<Issue> = []
+    const maxResults = options?.maxResults ?? 100
+    let nextPageToken: string | undefined = undefined
+    let pageCount = 0
+
+    // Fetch first page
+    let result = yield* searchJql(jql, maxResults, nextPageToken)
+    let issues = result.issues ?? []
+    pageCount++
+
+    for (const bean of issues) {
+      allIssues.push(mapIssue(bean as unknown as Record<string, unknown>, siteUrl))
+    }
+
+    // Fetch remaining pages with iteration guard
+    while (!result.isLast && result.nextPageToken && pageCount < MAX_PAGES) {
+      nextPageToken = result.nextPageToken
+      result = yield* searchJql(jql, maxResults, nextPageToken)
+      issues = result.issues ?? []
       pageCount++
 
       for (const bean of issues) {
         allIssues.push(mapIssue(bean as unknown as Record<string, unknown>, siteUrl))
       }
+    }
 
-      // Fetch remaining pages with iteration guard
-      while (!result.isLast && result.nextPageToken && pageCount < MAX_PAGES) {
-        nextPageToken = result.nextPageToken
-        result = yield* searchJql(jql, maxResults, nextPageToken)
-        issues = result.issues ?? []
-        pageCount++
-
-        for (const bean of issues) {
-          allIssues.push(mapIssue(bean as unknown as Record<string, unknown>, siteUrl))
-        }
-      }
-
-      return allIssues
-    })
+    return allIssues
+  }) as Effect.Effect<ReadonlyArray<Issue>, JiraApiError>)
 
   return IssueService.of({ getByKey, search, searchAll })
 })

package/src/JiraAuth.ts

@@ -4,7 +4,7 @@
  * **Mental model**
  *
  * - **Service pattern**: {@link JiraAuth} is a `Context.Tag` whose layer requires `HttpClient`
- *   and `CommandExecutor`. All token storage operations are pre-bound to
+ *   and `ChildProcessSpawner`. All token storage operations are pre-bound to
  *   `@knpkv/atlassian-common/config` with a `"jira-cli"` tool name.
  * - **Refresh lock**: A `Ref<Option<Deferred>>` prevents concurrent token refreshes — the
  *   first caller refreshes, others await the same Deferred.
@@ -21,10 +21,6 @@
  */
 import * as NodeFileSystem from "@effect/platform-node/NodeFileSystem"
 import * as NodePath from "@effect/platform-node/NodePath"
-import * as Command from "@effect/platform/Command"
-import * as CommandExecutor from "@effect/platform/CommandExecutor"
-import type * as Error from "@effect/platform/Error"
-import * as HttpClient from "@effect/platform/HttpClient"
 import {
   buildAuthUrl,
   buildOAuthToken,
@@ -58,19 +54,31 @@ import * as Deferred from "effect/Deferred"
 import * as Effect from "effect/Effect"
 import * as Layer from "effect/Layer"
 import * as Option from "effect/Option"
+import type * as PlatformError from "effect/PlatformError"
 import * as Redacted from "effect/Redacted"
 import * as Ref from "effect/Ref"
+import * as HttpClient from "effect/unstable/http/HttpClient"
+import { ChildProcessSpawner } from "effect/unstable/process"
 import { HttpServerFactoryLive } from "./internal/NodeLayers.js"
 import { startCallbackServer } from "./internal/oauthServer.js"
+import { openBrowser } from "./internal/openBrowser.js"
 import type { AuthMissingError } from "./JiraCliError.js"
 import { authMissing } from "./JiraCliError.js"
 
-/** Scopes for Jira CLI (includes write:jira-work for worklog) */
+/** OAuth scopes for the Jira CLI. Granular scopes must also be enabled on the app in the developer console. */
 const JIRA_CLI_SCOPES = [
+  // Read issues, search, and read versions.
   "read:jira-work",
+  // Edit issues and write worklogs.
   "write:jira-work",
+  // Edit a version (e.g. its description) via `PUT /rest/api/3/version/{id}` and
+  // manage version "Related work" links (`/rest/api/3/version/{id}/relatedwork`).
+  "manage:jira-project",
+  // Resolve account IDs to display names for Driver/Contributors/Approvers.
   "read:jira-user",
+  // Read the authenticated user's own profile (`/rest/api/3/myself`).
   "read:me",
+  // Issue a refresh token so the CLI stays logged in across runs.
   "offline_access"
 ]
 
@@ -121,40 +129,46 @@ export interface JiraAuthService {
   /** Configure OAuth client credentials */
   readonly configure: (
     config: OAuthConfig
-  ) => Effect.Effect<void, FileSystemError | HomeDirectoryError | Error.PlatformError>
+  ) => Effect.Effect<void, FileSystemError | HomeDirectoryError | PlatformError.PlatformError>
   /** Check if OAuth is configured */
-  readonly isConfigured: () => Effect.Effect<boolean, FileSystemError | HomeDirectoryError | Error.PlatformError>
+  readonly isConfigured: () => Effect.Effect<
+    boolean,
+    FileSystemError | HomeDirectoryError | PlatformError.PlatformError
+  >
   /** Start OAuth login flow. Returns list of sites if multiple are available. */
   readonly login: (
     options?: LoginOptions
   ) => Effect.Effect<
     ReadonlyArray<AccessibleSite> | void,
-    OAuthError | FileSystemError | HomeDirectoryError | Error.PlatformError
+    OAuthError | FileSystemError | HomeDirectoryError | PlatformError.PlatformError
   >
   /** Remove stored authentication */
-  readonly logout: () => Effect.Effect<void, OAuthError | FileSystemError | HomeDirectoryError | Error.PlatformError>
+  readonly logout: () => Effect.Effect<
+    void,
+    OAuthError | FileSystemError | HomeDirectoryError | PlatformError.PlatformError
+  >
   /** Get access token, refreshing if needed */
   readonly getAccessToken: () => Effect.Effect<
     Redacted.Redacted<string>,
-    AuthMissingError | OAuthError | FileSystemError | HomeDirectoryError | Error.PlatformError
+    AuthMissingError | OAuthError | FileSystemError | HomeDirectoryError | PlatformError.PlatformError
   >
   /** Get cloud ID from stored token */
   readonly getCloudId: () => Effect.Effect<
     string,
-    AuthMissingError | FileSystemError | HomeDirectoryError | Error.PlatformError
+    AuthMissingError | FileSystemError | HomeDirectoryError | PlatformError.PlatformError
   >
   /** Get site URL from stored token */
   readonly getSiteUrl: () => Effect.Effect<
     string,
-    AuthMissingError | FileSystemError | HomeDirectoryError | Error.PlatformError
+    AuthMissingError | FileSystemError | HomeDirectoryError | PlatformError.PlatformError
   >
   /** Get current user info from stored token */
   readonly getCurrentUser: () => Effect.Effect<
     OAuthUser | null,
-    FileSystemError | HomeDirectoryError | Error.PlatformError
+    FileSystemError | HomeDirectoryError | PlatformError.PlatformError
   >
   /** Check if user is logged in */
-  readonly isLoggedIn: () => Effect.Effect<boolean, FileSystemError | HomeDirectoryError | Error.PlatformError>
+  readonly isLoggedIn: () => Effect.Effect<boolean, FileSystemError | HomeDirectoryError | PlatformError.PlatformError>
 }
 
 /**
@@ -176,37 +190,33 @@ export interface JiraAuthService {
  *
  * @category Services
  */
-export class JiraAuth extends Context.Tag("@knpkv/jira-cli/JiraAuth")<
+export class JiraAuth extends Context.Service<
   JiraAuth,
   JiraAuthService
->() {}
+>()("@knpkv/jira-cli/JiraAuth") {}
 
 const make = Effect.gen(function*() {
   const httpClient = yield* HttpClient.HttpClient
-  const commandExecutor = yield* CommandExecutor.CommandExecutor
+  const childProcessSpawner = yield* ChildProcessSpawner.ChildProcessSpawner
 
   // Ref to track ongoing refresh operation to prevent concurrent refreshes
   const refreshLock = yield* Ref.make<
     Option.Option<
-      Deferred.Deferred<OAuthToken, OAuthError | FileSystemError | HomeDirectoryError | Error.PlatformError>
+      Deferred.Deferred<OAuthToken, OAuthError | FileSystemError | HomeDirectoryError | PlatformError.PlatformError>
     >
   >(
     Option.none()
   )
 
   const openBrowserImpl = (url: string): Effect.Effect<void, OAuthError> =>
-    Command.make("open", url).pipe(
-      Command.exitCode,
-      Effect.catchAll(() => Command.make("xdg-open", url).pipe(Command.exitCode)),
-      Effect.catchAll(() => Command.make("cmd", "/c", "start", "", url).pipe(Command.exitCode)),
-      Effect.provide(Layer.succeed(CommandExecutor.CommandExecutor, commandExecutor)),
-      Effect.asVoid,
+    openBrowser(url).pipe(
+      Effect.provideService(ChildProcessSpawner.ChildProcessSpawner, childProcessSpawner),
       Effect.mapError((cause) => new OAuthError({ step: "authorize", cause }))
     )
 
   const getConfig = (): Effect.Effect<
     OAuthConfig,
-    OAuthError | FileSystemError | HomeDirectoryError | Error.PlatformError
+    OAuthError | FileSystemError | HomeDirectoryError | PlatformError.PlatformError
   > =>
     Effect.gen(function*() {
       const config = yield* loadOAuthConfigOp()
@@ -224,7 +234,7 @@ const make = Effect.gen(function*() {
   const refreshTokenImpl = (
     token: OAuthToken,
     config: OAuthConfig
-  ): Effect.Effect<OAuthToken, OAuthError | FileSystemError | HomeDirectoryError | Error.PlatformError> =>
+  ): Effect.Effect<OAuthToken, OAuthError | FileSystemError | HomeDirectoryError | PlatformError.PlatformError> =>
     Effect.gen(function*() {
       const updated = yield* refreshToken(token, config).pipe(
         Effect.provide(Layer.succeed(HttpClient.HttpClient, httpClient))
@@ -243,9 +253,10 @@ const make = Effect.gen(function*() {
 
   const configure = (
     config: OAuthConfig
-  ): Effect.Effect<void, FileSystemError | HomeDirectoryError | Error.PlatformError> => saveOAuthConfigOp(config)
+  ): Effect.Effect<void, FileSystemError | HomeDirectoryError | PlatformError.PlatformError> =>
+    saveOAuthConfigOp(config)
 
-  const isConfigured = (): Effect.Effect<boolean, FileSystemError | HomeDirectoryError | Error.PlatformError> =>
+  const isConfigured = (): Effect.Effect<boolean, FileSystemError | HomeDirectoryError | PlatformError.PlatformError> =>
     Effect.gen(function*() {
       const config = yield* loadOAuthConfigOp()
       return config !== null
@@ -255,7 +266,7 @@ const make = Effect.gen(function*() {
     options?: LoginOptions
   ): Effect.Effect<
     ReadonlyArray<AccessibleSite> | void,
-    OAuthError | FileSystemError | HomeDirectoryError | Error.PlatformError
+    OAuthError | FileSystemError | HomeDirectoryError | PlatformError.PlatformError
   > =>
     Effect.gen(function*() {
       const config = yield* getConfig()
@@ -276,7 +287,7 @@ const make = Effect.gen(function*() {
       const code = yield* codePromise.pipe(
         Effect.timeout("5 minutes"),
         Effect.catchTag(
-          "TimeoutException",
+          "TimeoutError",
           () => Effect.fail(new OAuthError({ step: "authorize", cause: "Authorization timed out" }))
         ),
         Effect.ensuring(shutdown)
@@ -340,7 +351,10 @@ const make = Effect.gen(function*() {
       return undefined
     })
 
-  const logout = (): Effect.Effect<void, OAuthError | FileSystemError | HomeDirectoryError | Error.PlatformError> =>
+  const logout = (): Effect.Effect<
+    void,
+    OAuthError | FileSystemError | HomeDirectoryError | PlatformError.PlatformError
+  > =>
     Effect.gen(function*() {
       const token = yield* loadTokenOp()
       if (token === null) {
@@ -352,7 +366,7 @@ const make = Effect.gen(function*() {
       if (config !== null) {
         yield* revokeTokenImpl(token, config).pipe(
           Effect.tap(() => Effect.log("Token revoked with Atlassian")),
-          Effect.catchAll((error) => Effect.log(`Warning: Failed to revoke token: ${error.message}`))
+          Effect.catch((error) => Effect.log(`Warning: Failed to revoke token: ${error.message}`))
         )
       }
 
@@ -361,7 +375,7 @@ const make = Effect.gen(function*() {
 
   const getAccessToken = (): Effect.Effect<
     Redacted.Redacted<string>,
-    AuthMissingError | OAuthError | FileSystemError | HomeDirectoryError | Error.PlatformError
+    AuthMissingError | OAuthError | FileSystemError | HomeDirectoryError | PlatformError.PlatformError
   > =>
     Effect.gen(function*() {
       const token = yield* loadTokenOp()
@@ -376,7 +390,7 @@ const make = Effect.gen(function*() {
       // Atomically check-then-set refresh lock to avoid TOCTOU race
       const deferred = yield* Deferred.make<
         OAuthToken,
-        OAuthError | FileSystemError | HomeDirectoryError | Error.PlatformError
+        OAuthError | FileSystemError | HomeDirectoryError | PlatformError.PlatformError
       >()
       const existing = yield* Ref.modify(refreshLock, (current) =>
         Option.isSome(current)
@@ -418,7 +432,7 @@ const make = Effect.gen(function*() {
 
   const getCloudId = (): Effect.Effect<
     string,
-    AuthMissingError | FileSystemError | HomeDirectoryError | Error.PlatformError
+    AuthMissingError | FileSystemError | HomeDirectoryError | PlatformError.PlatformError
   > =>
     Effect.gen(function*() {
       const token = yield* loadTokenOp()
@@ -430,7 +444,7 @@ const make = Effect.gen(function*() {
 
   const getSiteUrl = (): Effect.Effect<
     string,
-    AuthMissingError | FileSystemError | HomeDirectoryError | Error.PlatformError
+    AuthMissingError | FileSystemError | HomeDirectoryError | PlatformError.PlatformError
   > =>
     Effect.gen(function*() {
       const token = yield* loadTokenOp()
@@ -442,14 +456,14 @@ const make = Effect.gen(function*() {
 
   const getCurrentUser = (): Effect.Effect<
     OAuthUser | null,
-    FileSystemError | HomeDirectoryError | Error.PlatformError
+    FileSystemError | HomeDirectoryError | PlatformError.PlatformError
   > =>
     Effect.gen(function*() {
       const token = yield* loadTokenOp()
       return token?.user ?? null
     })
 
-  const isLoggedIn = (): Effect.Effect<boolean, FileSystemError | HomeDirectoryError | Error.PlatformError> =>
+  const isLoggedIn = (): Effect.Effect<boolean, FileSystemError | HomeDirectoryError | PlatformError.PlatformError> =>
     Effect.gen(function*() {
       const token = yield* loadTokenOp()
       return token !== null

package/src/MarkdownWriter.ts

@@ -5,15 +5,15 @@
  *
  * - **Two output modes**: {@link MarkdownWriterShape.writeMulti} creates one `.md` per issue;
  *   {@link MarkdownWriterShape.writeSingle} combines all into `jira-export.md`.
- * - **Effect service**: Requires `FileSystem` and `Path` from `@effect/platform`.
+ * - **Effect service**: Requires `FileSystem` and `Path` from `effect`.
  *
  * @module
  */
-import * as FileSystem from "@effect/platform/FileSystem"
-import * as Path from "@effect/platform/Path"
 import * as Context from "effect/Context"
 import * as Effect from "effect/Effect"
+import * as FileSystem from "effect/FileSystem"
 import * as Layer from "effect/Layer"
+import * as Path from "effect/Path"
 import { buildCombinedMarkdown, serializeIssue } from "./internal/frontmatter.js"
 import type { Issue } from "./IssueService.js"
 import { WriteError } from "./JiraCliError.js"
@@ -53,10 +53,10 @@ export interface MarkdownWriterShape {
  *
  * @category Services
  */
-export class MarkdownWriter extends Context.Tag("@knpkv/jira-cli/MarkdownWriter")<
+export class MarkdownWriter extends Context.Service<
   MarkdownWriter,
   MarkdownWriterShape
->() {}
+>()("@knpkv/jira-cli/MarkdownWriter") {}
 
 const make = Effect.gen(function*() {
   const fs = yield* FileSystem.FileSystem
@@ -64,16 +64,12 @@ const make = Effect.gen(function*() {
 
   const ensureDir = (dir: string): Effect.Effect<void, WriteError> =>
     fs.makeDirectory(dir, { recursive: true }).pipe(
-      Effect.catchAll((cause) =>
-        Effect.fail(new WriteError({ path: dir, message: "Failed to create directory", cause }))
-      )
+      Effect.catch((cause) => Effect.fail(new WriteError({ path: dir, message: "Failed to create directory", cause })))
     )
 
   const writeFile = (filePath: string, content: string): Effect.Effect<void, WriteError> =>
     fs.writeFileString(filePath, content).pipe(
-      Effect.catchAll((cause) =>
-        Effect.fail(new WriteError({ path: filePath, message: "Failed to write file", cause }))
-      )
+      Effect.catch((cause) => Effect.fail(new WriteError({ path: filePath, message: "Failed to write file", cause })))
     )
 
   const writeMulti: MarkdownWriterShape["writeMulti"] = (issues, outputDir) =>