@knpkv/clockify-api-client 1.0.1 → 1.0.3

package/src/index.ts

@@ -16,6 +16,7 @@ export type {
   AuthenticatedClockifyApi,
   CreateTimeEntryParams,
   GetTimeEntriesParams,
+  GetTimeEntryParams,
   Project,
   StopTimeEntryParams,
   Tag,
@@ -23,7 +24,8 @@ export type {
   TimeInterval,
   UpdateTimeEntryParams,
   User,
-  Workspace
+  Workspace,
+  WorkspaceUser
 } from "./ClockifyApiClient.js"
 
 export { ClockifyApiConfig, type ClockifyApiConfigShape } from "./ClockifyApiConfig.js"

package/test/ClockifyApiClient.test.ts

@@ -80,6 +80,107 @@ describe("ClockifyApiClient", () => {
     )
   })
 
+  it.effect("requests hydrated time-entry details when required by the caller", () => {
+    const requests: Array<HttpClientRequest.HttpClientRequest> = []
+    return Effect.gen(function*() {
+      const client = yield* ClockifyApiClient
+      const entry = yield* client.getTimeEntry("workspace-1", "entry-1", { hydrated: true })
+      yield* client.getTimeEntry("workspace-1", "entry-1")
+      yield* client.getTimeEntry("workspace-1", "entry-1", { hydrated: false })
+      expect(entry.id).toBe("entry-1")
+      expect(new Map(requests[0]?.urlParams ?? []).get("hydrated")).toBe("true")
+      expect(new Map(requests[1]?.urlParams ?? []).has("hydrated")).toBe(false)
+      expect(new Map(requests[2]?.urlParams ?? []).get("hydrated")).toBe("false")
+    }).pipe(
+      Effect.provide(clientLayer({
+        status: 200,
+        body: {
+          id: "entry-1",
+          workspaceId: "workspace-1",
+          userId: "user-1",
+          description: "Review payment safeguards",
+          billable: true,
+          customFieldValues: [],
+          projectId: "project-1",
+          taskId: "task-1",
+          tagIds: ["delivery"],
+          timeInterval: {
+            start: "2026-07-11T08:00:00Z",
+            end: "2026-07-11T09:00:00Z",
+            duration: "PT1H"
+          }
+        }
+      }, requests))
+    )
+  })
+
+  it.effect("forwards hydration when listing canonical time-entry snapshots", () => {
+    const requests: Array<HttpClientRequest.HttpClientRequest> = []
+    return Effect.gen(function*() {
+      const client = yield* ClockifyApiClient
+      yield* client.getTimeEntries("workspace-1", "user-1", {
+        hydrated: true,
+        page: 2,
+        pageSize: 10
+      })
+      expect(new Map(requests[0]?.urlParams ?? []).get("hydrated")).toBe("true")
+      expect(new Map(requests[0]?.urlParams ?? []).get("page")).toBe("2")
+      expect(new Map(requests[0]?.urlParams ?? []).get("page-size")).toBe("10")
+    }).pipe(
+      Effect.provide(clientLayer({ status: 200, body: [] }, requests))
+    )
+  })
+
+  it.effect("pages through the complete workspace user directory", () => {
+    const requests: Array<HttpClientRequest.HttpClientRequest> = []
+    const firstPage = Array.from({ length: 500 }, (_, index) => ({
+      id: `user-${index}`,
+      name: `User ${index}`,
+      email: `user-${index}@example.test`,
+      status: "ACTIVE"
+    }))
+    const layer = ClockifyApiClient.layer.pipe(
+      Layer.provide(Layer.succeed(ClockifyApiConfig, {
+        apiKey: Redacted.make("secret"),
+        workspaceId: "workspace-1",
+        userId: "user-1",
+        baseUrl: "https://clockify.test/api"
+      })),
+      Layer.provide(Layer.succeed(
+        HttpClient.HttpClient,
+        HttpClient.make((request) =>
+          Effect.sync(() => {
+            requests.push(request)
+            const body = requests.length <= 20
+              ? firstPage
+              : [{ id: "configured-user", name: "Configured User", email: "configured@example.test", status: "ACTIVE" }]
+            return HttpClientResponse.fromWeb(
+              request,
+              new Response(JSON.stringify(body), {
+                status: 200,
+                headers: { "content-type": "application/json" }
+              })
+            )
+          })
+        )
+      ))
+    )
+    return Effect.gen(function*() {
+      const client = yield* ClockifyApiClient
+      if (client.getWorkspaceUsers === undefined) return assert.fail("expected workspace user discovery")
+      const users = yield* client.getWorkspaceUsers("workspace-1")
+      expect(users).toHaveLength(10_001)
+      expect(users.at(-1)?.id).toBe("configured-user")
+      expect(requests).toHaveLength(21)
+      expect(new Map(requests[0]?.urlParams ?? []).get("page")).toBe("1")
+      expect(new Map(requests[20]?.urlParams ?? []).get("page")).toBe("21")
+      expect(new Map(requests[0]?.urlParams ?? []).get("account-statuses")).toBe(
+        "ACTIVE,PENDING_EMAIL_VERIFICATION,DELETED,NOT_REGISTERED,LIMITED,LIMITED_DELETED"
+      )
+      expect(new Map(requests[0]?.urlParams ?? []).get("memberships")).toBe("ALL")
+    }).pipe(Effect.provide(layer))
+  })
+
   it.effect("decodes a created time entry whose optional id references are null", () => {
     const requests: Array<HttpClientRequest.HttpClientRequest> = []
     return Effect.gen(function*() {