@knpkv/atlassian-common 1.9.0 → 1.9.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @knpkv/atlassian-common
 
+## 1.9.1
+
+### 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.
+
 ## 1.9.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knpkv/atlassian-common",
-  "version": "1.9.0",
+  "version": "1.9.1",
   "description": "Shared utilities for Atlassian tools (AST, serializers, auth, config)",
   "license": "MIT",
   "author": "knpkv",
@@ -103,6 +103,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/ApiUpdateWorkflows.test.ts

@@ -45,9 +45,11 @@ const PackageManifest = Schema.Struct({
 
 // Public generated subpaths or generated export targets declare the contract;
 // package names and consumer dependencies do not.
+const isJsonArray = Schema.is(Schema.Array(Schema.Json))
+
 const exposesGeneratedContract = (exports: Schema.Json): boolean => {
   if (Predicate.isString(exports)) return /(?:^|\/)generated(?:\/|$)/u.test(exports)
-  if (Array.isArray(exports)) return exports.some(exposesGeneratedContract)
+  if (isJsonArray(exports)) return exports.some(exposesGeneratedContract)
   if (!isRecord(exports)) return false
   return Object.entries(exports).some(([name, target]) =>
     /^\.\/generated(?:\/|$)/u.test(name) || exposesGeneratedContract(target)
@@ -178,7 +180,7 @@ const inspectApiUpdateWorkflows = Effect.fn("ApiUpdateWorkflows.inspectApiUpdate
   }
   const workflowRoot = path.join(root, ".github/workflows")
   const diagnostics: Array<string> = []
-  for (const name of (yield* fileSystem.readDirectory(workflowRoot)).toSorted()) {
+  for (const name of [...(yield* fileSystem.readDirectory(workflowRoot))].sort()) {
     if (!/-api-update\.ya?ml$/u.test(name)) continue
     const source = yield* fileSystem.readFileString(path.join(workflowRoot, name))
     for (const diagnostic of patchGuidanceDiagnostics(source, generatedClientNames)) {

package/test/AuthProfiles.test.ts

@@ -2,10 +2,11 @@ import { describe, expect, it } from "@effect/vitest"
 import { ConfigProvider, Effect, Layer } from "effect"
 import * as FileSystem from "effect/FileSystem"
 import * as Path from "effect/Path"
-import { SystemError } from "effect/PlatformError"
+import { PlatformError, SystemError } from "effect/PlatformError"
 import {
   deleteProfileBySelector,
   HomeDirectoryLive,
+  type HomeDirectoryTag,
   loadActiveProfileToken,
   loadProfiles,
   type OAuthToken,
@@ -21,7 +22,9 @@ const profilesPath = `${basePath}/profiles.json`
 
 const fsError = (method: string) =>
   Effect.fail(
-    new SystemError({ _tag: "NotFound", module: "FileSystem", method, description: "mock not found" })
+    new PlatformError(
+      new SystemError({ _tag: "NotFound", module: "FileSystem", method, description: "mock not found" })
+    )
   )
 
 const makeToken = (n: number): OAuthToken => ({
@@ -57,7 +60,7 @@ const makeMockFS = (files: Record<string, string> = {}) => {
 
   return {
     store,
-    layer: Layer.succeed(FileSystem.FileSystem, FileSystem.FileSystem.of(partial))
+    layer: FileSystem.layerNoop(partial)
   }
 }
 
@@ -66,7 +69,7 @@ const ConfigProviderLive = ConfigProvider.layer(
 )
 
 const run = <A>(
-  effect: Effect.Effect<A, unknown, FileSystem.FileSystem | Path.Path>,
+  effect: Effect.Effect<A, unknown, FileSystem.FileSystem | Path.Path | HomeDirectoryTag>,
   files?: Record<string, string>
 ) => {
   const mock = makeMockFS(files)

package/test/ProfileManager.test.ts

@@ -6,10 +6,11 @@ import * as Fiber from "effect/Fiber"
 import * as FileSystem from "effect/FileSystem"
 import { HttpClient, HttpClientResponse } from "effect/http"
 import * as Path from "effect/Path"
-import { SystemError } from "effect/PlatformError"
+import { PlatformError, SystemError } from "effect/PlatformError"
 import {
   type AtlassianToolDefinition,
   HomeDirectoryLive,
+  type HomeDirectoryTag,
   inspectAllToolProfiles,
   migrateLegacyProfiles,
   MissingOAuthConfigError,
@@ -39,7 +40,11 @@ const sharedStoreTools: ReadonlyArray<AtlassianToolDefinition> = [
 ]
 
 const fsError = (method: string) =>
-  Effect.fail(new SystemError({ _tag: "NotFound", module: "FileSystem", method, description: "mock not found" }))
+  Effect.fail(
+    new PlatformError(
+      new SystemError({ _tag: "NotFound", module: "FileSystem", method, description: "mock not found" })
+    )
+  )
 
 const makeToken = (n: number, scope = "read:me offline_access", expiresAt = Date.now() + 60_000): OAuthToken => ({
   access_token: `access-${n}`,
@@ -69,13 +74,13 @@ const makeMockFS = () => {
   }
   return {
     store,
-    layer: Layer.succeed(FileSystem.FileSystem, FileSystem.FileSystem.of(partial))
+    layer: FileSystem.layerNoop(partial)
   }
 }
 
 const ConfigProviderLive = ConfigProvider.layer(ConfigProvider.fromEnv({ env: { HOME: TEST_HOME } }))
 
-const run = async <A>(effect: Effect.Effect<A, unknown, FileSystem.FileSystem | Path.Path>) => {
+const run = async <A>(effect: Effect.Effect<A, unknown, FileSystem.FileSystem | Path.Path | HomeDirectoryTag>) => {
   const mock = makeMockFS()
   const layer = Layer.mergeAll(mock.layer, Path.layer, HomeDirectoryLive, ConfigProviderLive)
   const result = await Effect.runPromise(effect.pipe(Effect.provide(layer)))
@@ -242,7 +247,10 @@ describe("ProfileManager", () => {
         Effect.gen(function*() {
           yield* saveProfileToken("tool-a", makeToken(1, "read:me offline_access", Date.now() - 1_000))
           return yield* refreshActiveProfiles([tools[0]!])
-        })
+        }).pipe(
+          // The refresh fails on configuration before any request; a request would be a regression.
+          Effect.provideService(HttpClient.HttpClient, HttpClient.make(() => Effect.die("no request expected")))
+        )
       )
     ).rejects.toBeInstanceOf(MissingOAuthConfigError)
   })

package/test/PublicExports.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, it } from "@effect/vitest"
 import { JIRA_PROPOSAL_SCOPES, JIRA_SCOPES } from "../src/auth/index.js"
 import { JIRA_PROPOSAL_REQUIRED_SCOPES, JIRA_REQUIRED_SCOPES } from "../src/config/index.js"
 

package/test/cliAuth.authCommand.test.ts

@@ -73,7 +73,6 @@ const launchers = (opens: boolean) =>
           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/cliAuth.login.test.ts

@@ -118,7 +118,6 @@ const failingLaunchers = (launched: Deferred.Deferred<string>, attempts: Ref.Ref
           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/cliAuth.openBrowser.test.ts

@@ -32,7 +32,6 @@ const launchers = (outcomes: Readonly<Record<string, number>>, attempts: Array<s
         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/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": []
+}