@knpkv/clockify-api-client 1.0.1 → 1.0.3

package/dist/index.d.ts

@@ -4,7 +4,7 @@
  * @packageDocumentation
  */
 export { ClockifyApiClient, type ClockifyApiClientShape, type ClockifyClientError, layer, make } from "./ClockifyApiClient.js";
-export type { AuthenticatedClockifyApi, CreateTimeEntryParams, GetTimeEntriesParams, Project, StopTimeEntryParams, Tag, TimeEntry, TimeInterval, UpdateTimeEntryParams, User, Workspace } from "./ClockifyApiClient.js";
+export type { AuthenticatedClockifyApi, CreateTimeEntryParams, GetTimeEntriesParams, GetTimeEntryParams, Project, StopTimeEntryParams, Tag, TimeEntry, TimeInterval, UpdateTimeEntryParams, User, Workspace, WorkspaceUser } from "./ClockifyApiClient.js";
 export { ClockifyApiConfig, type ClockifyApiConfigShape } from "./ClockifyApiConfig.js";
 export * as ClockifyApi from "./generated/ClockifyApi.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EACL,iBAAiB,EACjB,KAAK,sBAAsB,EAC3B,KAAK,mBAAmB,EACxB,KAAK,EACL,IAAI,EACL,MAAM,wBAAwB,CAAA;AAE/B,YAAY,EACV,wBAAwB,EACxB,qBAAqB,EACrB,oBAAoB,EACpB,OAAO,EACP,mBAAmB,EACnB,GAAG,EACH,SAAS,EACT,YAAY,EACZ,qBAAqB,EACrB,IAAI,EACJ,SAAS,EACV,MAAM,wBAAwB,CAAA;AAE/B,OAAO,EAAE,iBAAiB,EAAE,KAAK,sBAAsB,EAAE,MAAM,wBAAwB,CAAA;AAEvF,OAAO,KAAK,WAAW,MAAM,4BAA4B,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EACL,iBAAiB,EACjB,KAAK,sBAAsB,EAC3B,KAAK,mBAAmB,EACxB,KAAK,EACL,IAAI,EACL,MAAM,wBAAwB,CAAA;AAE/B,YAAY,EACV,wBAAwB,EACxB,qBAAqB,EACrB,oBAAoB,EACpB,kBAAkB,EAClB,OAAO,EACP,mBAAmB,EACnB,GAAG,EACH,SAAS,EACT,YAAY,EACZ,qBAAqB,EACrB,IAAI,EACJ,SAAS,EACT,aAAa,EACd,MAAM,wBAAwB,CAAA;AAE/B,OAAO,EAAE,iBAAiB,EAAE,KAAK,sBAAsB,EAAE,MAAM,wBAAwB,CAAA;AAEvF,OAAO,KAAK,WAAW,MAAM,4BAA4B,CAAA"}

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EACL,iBAAiB,EAGjB,KAAK,EACL,IAAI,EACL,MAAM,wBAAwB,CAAA;AAgB/B,OAAO,EAAE,iBAAiB,EAA+B,MAAM,wBAAwB,CAAA;AAEvF,OAAO,KAAK,WAAW,MAAM,4BAA4B,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EACL,iBAAiB,EAGjB,KAAK,EACL,IAAI,EACL,MAAM,wBAAwB,CAAA;AAkB/B,OAAO,EAAE,iBAAiB,EAA+B,MAAM,wBAAwB,CAAA;AAEvF,OAAO,KAAK,WAAW,MAAM,4BAA4B,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knpkv/clockify-api-client",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Effect-based Clockify REST API client",
   "license": "MIT",
   "author": "knpkv",

package/src/ClockifyApiClient.ts

@@ -23,6 +23,7 @@ import * as Generated from "./generated/ClockifyApi.js"
 export type ClockifyClientError = HttpClientError.HttpClientError | SchemaError
 
 export type User = Generated.GetLoggedUser200
+export type WorkspaceUser = Generated.GetUsersOfWorkspace200[number]
 export type Workspace = Generated.GetWorkspacesOfUser200[number]
 export type Project = Generated.GetProjects200[number]
 export type Tag = Generated.GetTags200[number]
@@ -39,12 +40,25 @@ export type AuthenticatedClockifyApi = Omit<Generated.ClockifyApi, "uploadImage"
 export interface GetTimeEntriesParams {
   readonly start?: string | undefined
   readonly end?: string | undefined
+  readonly hydrated?: boolean | undefined
   readonly page?: number | undefined
   readonly pageSize?: number | undefined
 }
 
+export interface GetTimeEntryParams {
+  readonly hydrated?: boolean | undefined
+}
+
 export interface ClockifyApiClientShape {
   readonly getUser: () => Effect.Effect<User, ClockifyClientError>
+  readonly getWorkspaceUsers?: (
+    workspaceId: string
+  ) => Effect.Effect<ReadonlyArray<WorkspaceUser>, ClockifyClientError>
+  readonly getWorkspaceUsersPage?: (
+    workspaceId: string,
+    page: number,
+    pageSize: number
+  ) => Effect.Effect<ReadonlyArray<WorkspaceUser>, ClockifyClientError>
   readonly getWorkspaces: () => Effect.Effect<ReadonlyArray<Workspace>, ClockifyClientError>
   readonly getProjects: (workspaceId: string) => Effect.Effect<ReadonlyArray<Project>, ClockifyClientError>
   readonly getProjectByName: (workspaceId: string, name: string) => Effect.Effect<Project | null, ClockifyClientError>
@@ -77,7 +91,8 @@ export interface ClockifyApiClientShape {
   ) => Effect.Effect<Generated.GetTags200[number] | Generated.CreateNewTag201, ClockifyClientError>
   readonly getTimeEntry: (
     workspaceId: string,
-    timeEntryId: string
+    timeEntryId: string,
+    params?: GetTimeEntryParams
   ) => Effect.Effect<Generated.GetTimeEntry200, ClockifyClientError>
   readonly deleteTimeEntry: (workspaceId: string, timeEntryId: string) => Effect.Effect<void, ClockifyClientError>
   readonly updateTimeEntry: (
@@ -129,8 +144,36 @@ export class ClockifyApiClient extends Context.Service<ClockifyApiClient, Clocki
         const getTags = (workspaceId: string) =>
           api.getTags(workspaceId, { params: { archived: false, "page-size": 200 } })
 
+        const getWorkspaceUsersPage = Effect.fn("ClockifyApiClient.getWorkspaceUsersPage")(function*(
+          workspaceId: string,
+          page: number,
+          pageSize: number
+        ) {
+          return yield* api.getUsersOfWorkspace(workspaceId, {
+            params: {
+              "account-statuses": "ACTIVE,PENDING_EMAIL_VERIFICATION,DELETED,NOT_REGISTERED,LIMITED,LIMITED_DELETED",
+              "include-roles": "false",
+              memberships: "ALL",
+              page,
+              "page-size": pageSize,
+              status: "ALL"
+            }
+          })
+        })
+        const getWorkspaceUsers = Effect.fn("ClockifyApiClient.getWorkspaceUsers")(function*(workspaceId: string) {
+          const users: Array<WorkspaceUser> = []
+          for (let page = 1;; page++) {
+            const batch = yield* getWorkspaceUsersPage(workspaceId, page, 500)
+            for (const user of batch) users.push(user)
+            if (batch.length < 500) break
+          }
+          return users
+        })
+
         return ClockifyApiClient.of({
           getUser: () => api.getLoggedUser(undefined),
+          getWorkspaceUsers,
+          getWorkspaceUsersPage,
           getWorkspaces: () => api.getWorkspacesOfUser(undefined),
           getProjects,
           getProjectByName: (workspaceId, name) =>
@@ -146,6 +189,7 @@ export class ClockifyApiClient extends Context.Service<ClockifyApiClient, Clocki
               params: {
                 ...(params?.start !== undefined ? { start: params.start } : {}),
                 ...(params?.end !== undefined ? { end: params.end } : {}),
+                ...(params?.hydrated === undefined ? {} : { hydrated: params.hydrated }),
                 ...(params?.page !== undefined ? { page: params.page } : {}),
                 ...(params?.pageSize !== undefined ? { "page-size": params.pageSize } : {})
               }
@@ -165,7 +209,12 @@ export class ClockifyApiClient extends Context.Service<ClockifyApiClient, Clocki
                   : Effect.succeed(existing)
               })
             ),
-          getTimeEntry: (workspaceId, timeEntryId) => api.getTimeEntry(workspaceId, timeEntryId, undefined),
+          getTimeEntry: (workspaceId, timeEntryId, params) =>
+            api.getTimeEntry(workspaceId, timeEntryId, {
+              params: {
+                ...(params?.hydrated === undefined ? {} : { hydrated: params.hydrated })
+              }
+            }),
           deleteTimeEntry: (workspaceId, timeEntryId) => api.deleteTimeEntry(workspaceId, timeEntryId, undefined),
           updateTimeEntry: (workspaceId, timeEntryId, payload) =>
             api.updateTimeEntry(workspaceId, timeEntryId, { payload })