@knpkv/atlassian-common 0.2.0 → 0.3.0

package/src/ast/MacroNode.ts

@@ -10,6 +10,7 @@
  *
  * @module
  */
+import * as Effect from "effect/Effect"
 import * as Schema from "effect/Schema"
 import { RawSource, SchemaVersion, SimpleBlockNode } from "./BlockNode.js"
 
@@ -25,7 +26,7 @@ export const PanelTypes = ["info", "warning", "note", "tip", "error", "panel"] a
  *
  * @category MacroNode
  */
-export const PanelType = Schema.Literal(...PanelTypes)
+export const PanelType = Schema.Literals(PanelTypes)
 
 /**
  * Type for panel type.
@@ -118,8 +119,8 @@ export const CodeMacro = Schema.Struct({
   language: Schema.optional(Schema.String),
   title: Schema.optional(Schema.String),
   code: Schema.String,
-  lineNumbers: Schema.optionalWith(Schema.Boolean, { default: () => false }),
-  collapse: Schema.optionalWith(Schema.Boolean, { default: () => false }),
+  lineNumbers: Schema.Boolean.pipe(Schema.withConstructorDefault(Effect.succeed(false))),
+  collapse: Schema.Boolean.pipe(Schema.withConstructorDefault(Effect.succeed(false))),
   firstLine: Schema.optional(Schema.Number),
   rawSource: RawSource
 })
@@ -140,7 +141,7 @@ export const StatusMacro = Schema.Struct({
   _tag: Schema.Literal("StatusMacro"),
   version: SchemaVersion,
   text: Schema.String,
-  color: Schema.Literal("Grey", "Red", "Yellow", "Green", "Blue"),
+  color: Schema.Literals(["Grey", "Red", "Yellow", "Green", "Blue"]),
   rawSource: RawSource
 })
 
@@ -156,13 +157,13 @@ export type StatusMacro = Schema.Schema.Type<typeof StatusMacro>
  *
  * @category MacroNode
  */
-export const MacroNode = Schema.Union(
+export const MacroNode = Schema.Union([
   InfoPanel,
   ExpandMacro,
   TocMacro,
   CodeMacro,
   StatusMacro
-)
+])
 
 /**
  * Type for macro nodes.

package/src/auth/OAuthOperations.ts

@@ -18,10 +18,9 @@
  *
  * @module
  */
-import * as HttpClient from "@effect/platform/HttpClient"
-import * as HttpClientRequest from "@effect/platform/HttpClientRequest"
 import * as Effect from "effect/Effect"
 import * as Schema from "effect/Schema"
+import { HttpClient, HttpClientRequest } from "effect/unstable/http"
 import { type OAuthConfig, type OAuthToken } from "../config/OAuthSchemas.js"
 import { ME_URL, RESOURCES_URL, REVOKE_URL, TOKEN_URL } from "./OAuthEndpoints.js"
 import { OAuthError } from "./OAuthErrors.js"
@@ -83,7 +82,7 @@ export const exchangeCodeForTokens = (
 
     const body = yield* response.json
 
-    return yield* Schema.decodeUnknown(TokenResponseSchema)(body)
+    return yield* Schema.decodeUnknownEffect(TokenResponseSchema)(body)
   }).pipe(
     Effect.mapError((cause) => new OAuthError({ step: "token", cause }))
   )
@@ -117,7 +116,7 @@ export const getAccessibleResources = (
 
     const body = yield* response.json
 
-    return yield* Schema.decodeUnknown(Schema.Array(AccessibleResourceSchema))(body)
+    return yield* Schema.decodeUnknownEffect(Schema.Array(AccessibleResourceSchema))(body)
   }).pipe(
     Effect.mapError((cause) => new OAuthError({ step: "resources", cause }))
   )
@@ -151,7 +150,7 @@ export const getUserInfo = (
 
     const body = yield* response.json
 
-    return yield* Schema.decodeUnknown(UserInfoSchema)(body)
+    return yield* Schema.decodeUnknownEffect(UserInfoSchema)(body)
   }).pipe(
     Effect.mapError((cause) => new OAuthError({ step: "user-info", cause }))
   )
@@ -197,7 +196,7 @@ export const refreshToken = (
     const body = yield* response.json.pipe(
       Effect.mapError((cause) => new OAuthError({ step: "refresh", cause }))
     )
-    const tokenResponse = yield* Schema.decodeUnknown(TokenResponseSchema)(body).pipe(
+    const tokenResponse = yield* Schema.decodeUnknownEffect(TokenResponseSchema)(body).pipe(
       Effect.mapError((cause) => new OAuthError({ step: "refresh", cause }))
     )
 

package/src/config/ConfigPaths.ts

@@ -18,15 +18,15 @@
  *
  * @module
  */
-import type * as Error from "@effect/platform/Error"
-import * as FileSystem from "@effect/platform/FileSystem"
-import * as Path from "@effect/platform/Path"
 import * as Config from "effect/Config"
 import * as Context from "effect/Context"
 import * as Data from "effect/Data"
 import * as Effect from "effect/Effect"
+import * as FileSystem from "effect/FileSystem"
 import * as Layer from "effect/Layer"
 import * as Option from "effect/Option"
+import * as Path from "effect/Path"
+import type * as PlatformError from "effect/PlatformError"
 
 /**
  * Error when home directory cannot be determined.
@@ -56,10 +56,10 @@ export interface HomeDirectory {
  *
  * @category Services
  */
-export class HomeDirectoryTag extends Context.Tag("@knpkv/atlassian-common/HomeDirectory")<
+export class HomeDirectoryTag extends Context.Service<
   HomeDirectoryTag,
   HomeDirectory
->() {}
+>()("@knpkv/atlassian-common/HomeDirectory") {}
 
 const HomeConfig = Config.option(Config.string("HOME")).pipe(
   Config.orElse(() => Config.option(Config.string("USERPROFILE")))
@@ -145,7 +145,7 @@ export const ensureConfigDir = (
   toolName: string
 ): Effect.Effect<
   string,
-  HomeDirectoryError | Error.PlatformError,
+  HomeDirectoryError | PlatformError.PlatformError,
   FileSystem.FileSystem | Path.Path | HomeDirectoryTag
 > =>
   Effect.gen(function*() {
@@ -168,7 +168,7 @@ export const ensureConfigDir = (
 export const writeSecureFile = (
   filePath: string,
   content: string
-): Effect.Effect<void, Error.PlatformError, FileSystem.FileSystem> =>
+): Effect.Effect<void, PlatformError.PlatformError, FileSystem.FileSystem> =>
   Effect.gen(function*() {
     const fs = yield* FileSystem.FileSystem
 

package/src/config/TokenStorage.ts

@@ -6,7 +6,7 @@
  * - **Load returns null, not error**: {@link loadToken} and {@link loadOAuthConfig} return
  *   `null` for missing/corrupt files — callers decide whether absence is an error.
  * - **Save is atomic**: Writes go through {@link writeSecureFile} with `0o600` permissions.
- * - **Schema-gated reads**: JSON is parsed then validated via `Schema.decodeUnknown` —
+ * - **Schema-gated reads**: JSON is parsed then validated via `Schema.decodeUnknownEffect` —
  *   corrupt data is treated as absent rather than crashing.
  *
  * **Common tasks**
@@ -17,16 +17,24 @@
  *
  * @module
  */
-import type * as Error from "@effect/platform/Error"
-import * as FileSystem from "@effect/platform/FileSystem"
-import type * as Path from "@effect/platform/Path"
 import * as Data from "effect/Data"
 import * as Effect from "effect/Effect"
+import * as FileSystem from "effect/FileSystem"
+import type * as Path from "effect/Path"
+import type * as PlatformError from "effect/PlatformError"
 import * as Schema from "effect/Schema"
 import { type HomeDirectoryError, type HomeDirectoryTag } from "./ConfigPaths.js"
 import { ensureConfigDir, getAuthPath, getOAuthConfigPath, writeSecureFile } from "./ConfigPaths.js"
 import { type OAuthConfig, OAuthConfigSchema, type OAuthToken, OAuthTokenSchema } from "./OAuthSchemas.js"
 
+const parseJsonOrNull = (content: string): unknown | null => {
+  try {
+    return JSON.parse(content) as unknown
+  } catch {
+    return null
+  }
+}
+
 /**
  * Error during file system operations.
  *
@@ -62,7 +70,7 @@ export const loadToken = (
     const tokenPath = yield* getAuthPath(toolName)
 
     const exists = yield* fs.exists(tokenPath).pipe(
-      Effect.catchAll(() => Effect.succeed(false))
+      Effect.catchCause(() => Effect.succeed(false))
     )
     if (!exists) {
       return null
@@ -72,20 +80,14 @@ export const loadToken = (
       Effect.mapError((cause) => new FileSystemError({ operation: "read", path: tokenPath, cause }))
     )
 
-    const parsed = yield* Effect.sync(() => {
-      try {
-        return JSON.parse(content) as unknown
-      } catch {
-        return null
-      }
-    })
+    const parsed = yield* Effect.sync(() => parseJsonOrNull(content))
     if (parsed === null) {
       yield* Effect.logWarning(`Corrupted auth.json at ${tokenPath} — could not parse JSON`)
       return null
     }
 
-    return yield* Schema.decodeUnknown(OAuthTokenSchema)(parsed).pipe(
-      Effect.catchAll((e) =>
+    return yield* Schema.decodeUnknownEffect(OAuthTokenSchema)(parsed).pipe(
+      Effect.catchCause((e) =>
         Effect.logWarning(`Invalid token schema in ${tokenPath}: ${e}`).pipe(
           Effect.map(() => null)
         )
@@ -106,7 +108,7 @@ export const saveToken = (
   token: OAuthToken
 ): Effect.Effect<
   void,
-  FileSystemError | HomeDirectoryError | Error.PlatformError,
+  FileSystemError | HomeDirectoryError | PlatformError.PlatformError,
   FileSystem.FileSystem | Path.Path | HomeDirectoryTag
 > =>
   Effect.gen(function*() {
@@ -134,7 +136,7 @@ export const deleteToken = (
     const tokenPath = yield* getAuthPath(toolName)
 
     yield* fs.remove(tokenPath).pipe(
-      Effect.catchAll(() => Effect.void)
+      Effect.catchCause(() => Effect.void)
     )
   })
 
@@ -158,7 +160,7 @@ export const loadOAuthConfig = (
     const configPath = yield* getOAuthConfigPath(toolName)
 
     const exists = yield* fs.exists(configPath).pipe(
-      Effect.catchAll(() => Effect.succeed(false))
+      Effect.catchCause(() => Effect.succeed(false))
     )
     if (!exists) {
       return null
@@ -168,20 +170,14 @@ export const loadOAuthConfig = (
       Effect.mapError((cause) => new FileSystemError({ operation: "read", path: configPath, cause }))
     )
 
-    const parsed = yield* Effect.sync(() => {
-      try {
-        return JSON.parse(content) as unknown
-      } catch {
-        return null
-      }
-    })
+    const parsed = yield* Effect.sync(() => parseJsonOrNull(content))
     if (parsed === null) {
       yield* Effect.logWarning(`Corrupted oauth config at ${configPath} — could not parse JSON`)
       return null
     }
 
-    return yield* Schema.decodeUnknown(OAuthConfigSchema)(parsed).pipe(
-      Effect.catchAll((e) =>
+    return yield* Schema.decodeUnknownEffect(OAuthConfigSchema)(parsed).pipe(
+      Effect.catchCause((e) =>
         Effect.logWarning(`Invalid OAuth config schema in ${configPath}: ${e}`).pipe(
           Effect.map(() => null)
         )
@@ -202,7 +198,7 @@ export const saveOAuthConfig = (
   config: OAuthConfig
 ): Effect.Effect<
   void,
-  FileSystemError | HomeDirectoryError | Error.PlatformError,
+  FileSystemError | HomeDirectoryError | PlatformError.PlatformError,
   FileSystem.FileSystem | Path.Path | HomeDirectoryTag
 > =>
   Effect.gen(function*() {

package/src/index.ts

@@ -19,7 +19,7 @@ export {
 } from "./Brand.js"
 
 // Hash utilities
-export { hashBuffer, hashContent, hashContentSync, hashEquals } from "./Hash.js"
+export { hashBuffer, hashContent, hashEquals } from "./Hash.js"
 
 // Error types
 export { ParseError, SerializeError } from "./SerializeError.js"

package/test/Hash.test.ts

@@ -0,0 +1,52 @@
+import { it as effectIt } from "@effect/vitest"
+import * as Crypto from "effect/Crypto"
+import * as Effect from "effect/Effect"
+import { describe, expect, it } from "vitest"
+import { ContentHash } from "../src/Brand.js"
+import { hashBuffer, hashContent, hashEquals } from "../src/Hash.js"
+
+const byteSequenceDigest = Uint8Array.from({ length: 32 }, (_, index) => index)
+const byteSequenceHash = ContentHash("000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f")
+
+describe("Hash", () => {
+  effectIt.effect("delegates SHA-256 hashing to the provided Crypto service", () =>
+    Effect.gen(function*() {
+      const hash = yield* hashContent("hello")
+      expect(hash).toBe(byteSequenceHash)
+    }).pipe(
+      Effect.provideService(
+        Crypto.Crypto,
+        Crypto.make({
+          randomBytes: (size) => new Uint8Array(size),
+          digest: (algorithm, data) => {
+            expect(algorithm).toBe("SHA-256")
+            expect(Array.from(data)).toEqual([104, 101, 108, 108, 111])
+            return Effect.succeed(byteSequenceDigest)
+          }
+        })
+      )
+    ))
+
+  effectIt.effect("hashes binary content through the provided Crypto service", () =>
+    Effect.gen(function*() {
+      const hash = yield* hashBuffer(Uint8Array.of(1, 2, 3))
+      expect(hash).toBe(byteSequenceHash)
+    }).pipe(
+      Effect.provideService(
+        Crypto.Crypto,
+        Crypto.make({
+          randomBytes: (size) => new Uint8Array(size),
+          digest: (algorithm, data) => {
+            expect(algorithm).toBe("SHA-256")
+            expect(Array.from(data)).toEqual([1, 2, 3])
+            return Effect.succeed(byteSequenceDigest)
+          }
+        })
+      )
+    ))
+
+  it("compares content hashes by value", () => {
+    expect(hashEquals(byteSequenceHash, byteSequenceHash)).toBe(true)
+    expect(hashEquals(byteSequenceHash, ContentHash("f".repeat(64)))).toBe(false)
+  })
+})

package/test/OAuthOperations.test.ts

@@ -1,9 +1,8 @@
-import * as HttpClient from "@effect/platform/HttpClient"
-import type * as HttpClientRequest from "@effect/platform/HttpClientRequest"
-import * as HttpClientResponse from "@effect/platform/HttpClientResponse"
 import { describe, it } from "@effect/vitest"
 import * as Effect from "effect/Effect"
 import * as Layer from "effect/Layer"
+import type { HttpClientRequest } from "effect/unstable/http"
+import { HttpClient, HttpClientResponse } from "effect/unstable/http"
 import { expect } from "vitest"
 import { OAuthError } from "../src/auth/OAuthErrors.js"
 import {