@panoptic-it-solutions/zoho-projects-client 0.1.0

package/README.md

@@ -0,0 +1,231 @@
+# @panoptic-it-solutions/zoho-projects-client
+
+TypeScript client for Zoho Projects V3 API with OAuth 2.0 and rate limiting.
+
+## Installation
+
+```bash
+npm install @panoptic-it-solutions/zoho-projects-client
+```
+
+## Quick Start
+
+```typescript
+import { createZohoProjectsClient } from "@panoptic-it-solutions/zoho-projects-client";
+
+const client = createZohoProjectsClient({
+  clientId: process.env.ZOHO_CLIENT_ID!,
+  clientSecret: process.env.ZOHO_CLIENT_SECRET!,
+  refreshToken: process.env.ZOHO_REFRESH_TOKEN!,
+  portalId: process.env.ZOHO_PORTAL_ID!,
+});
+
+// List projects
+const { data: projects } = await client.projects.list();
+
+// Get all projects with auto-pagination
+const allProjects = await client.projects.listAll();
+
+// Iterate over projects
+for await (const project of client.projects.iterate()) {
+  console.log(project.name);
+}
+```
+
+## Authentication Setup
+
+Zoho requires OAuth 2.0 with a refresh token. Here's how to get one:
+
+### 1. Create a Client
+
+1. Go to [Zoho API Console](https://api-console.zoho.com) (or `.eu`, `.in`, `.com.au` for your region)
+2. Click **Add Client** → **Server-based Applications**
+3. Fill in the details and click **Create**
+4. Copy the **Client ID** and **Client Secret**
+
+### 2. Generate a Refresh Token
+
+1. In API Console, select your client → **Generate Code** → **Self Client**
+2. Enter scope:
+   ```
+   ZohoProjects.projects.READ,ZohoProjects.tasks.READ,ZohoProjects.timesheets.READ,ZohoProjects.users.READ,ZohoProjects.portals.READ
+   ```
+3. Click **Create** and copy the authorization code
+4. Exchange it for a refresh token (within 2 minutes):
+
+```bash
+curl -X POST "https://accounts.zoho.com/oauth/v2/token" \
+  -d "grant_type=authorization_code" \
+  -d "client_id=YOUR_CLIENT_ID" \
+  -d "client_secret=YOUR_CLIENT_SECRET" \
+  -d "code=YOUR_AUTH_CODE"
+```
+
+5. Copy the `refresh_token` from the response (it doesn't expire unless revoked)
+
+## Configuration
+
+```typescript
+const client = createZohoProjectsClient({
+  // Required
+  clientId: "your_client_id",
+  clientSecret: "your_client_secret",
+  refreshToken: "your_refresh_token",
+  portalId: "your_portal_id",
+
+  // Optional - defaults shown
+  apiUrl: "https://projectsapi.zoho.com",      // US region
+  accountsUrl: "https://accounts.zoho.com",    // US region
+  timeout: 30000,                               // 30 seconds
+
+  // Optional - for distributed rate limiting
+  redis: {
+    url: "redis://localhost:6379",
+  },
+});
+```
+
+### Region URLs
+
+| Region | API URL | Accounts URL |
+|--------|---------|--------------|
+| US | `https://projectsapi.zoho.com` | `https://accounts.zoho.com` |
+| EU | `https://projectsapi.zoho.eu` | `https://accounts.zoho.eu` |
+| IN | `https://projectsapi.zoho.in` | `https://accounts.zoho.in` |
+| AU | `https://projectsapi.zoho.com.au` | `https://accounts.zoho.com.au` |
+
+## API Reference
+
+### Projects
+
+```typescript
+// List with pagination
+const { data, pageInfo } = await client.projects.list({ index: 0, range: 100 });
+
+// Get all projects
+const projects = await client.projects.listAll();
+
+// Get single project
+const project = await client.projects.get("project_id");
+
+// Iterate with auto-pagination
+for await (const project of client.projects.iterate()) {
+  console.log(project.name);
+}
+```
+
+### Tasks
+
+```typescript
+// List tasks for a project
+const { data } = await client.tasks.list("project_id");
+
+// Get all tasks for a project
+const tasks = await client.tasks.listAll("project_id");
+
+// Get single task
+const task = await client.tasks.get("project_id", "task_id");
+
+// Get all tasks across all projects
+const allTasks = await client.tasks.listAllAcrossProjects();
+```
+
+### Time Logs
+
+Time logs require specific parameters:
+
+```typescript
+// List time logs for a project
+const { data } = await client.timelogs.list("project_id", {
+  users_list: "all",              // "all" or comma-separated user IDs
+  view_type: "month",             // "day", "week", "month", or "custom_date"
+  date: "12-14-2025",             // MM-DD-YYYY format
+  bill_status: "All",             // "All", "Billable", or "Non Billable"
+  component_type: "task",         // "task", "bug", or "general"
+});
+
+// Get all time logs for a project
+const logs = await client.timelogs.listAll("project_id", {
+  users_list: "all",
+  view_type: "month",
+  date: "12-14-2025",
+  bill_status: "All",
+  component_type: "task",
+});
+```
+
+### Users
+
+```typescript
+// List portal users
+const { data } = await client.users.list();
+
+// Get all users
+const users = await client.users.listAll();
+
+// Get single user
+const user = await client.users.get("user_id");
+
+// List users for a project
+const { data: projectUsers } = await client.users.listForProject("project_id");
+```
+
+## Rate Limiting
+
+The client automatically handles Zoho's rate limits:
+- 100 requests per 2 minutes
+- 30-minute lockout on 429 response
+
+Uses [Bottleneck](https://github.com/SGrondin/bottleneck) with a safety margin (90 requests per 2 minutes).
+
+For distributed deployments, configure Redis:
+
+```typescript
+const client = createZohoProjectsClient({
+  // ...
+  redis: {
+    url: process.env.REDIS_URL!,
+  },
+});
+```
+
+## Error Handling
+
+```typescript
+import {
+  ZohoProjectsError,
+  ZohoAuthenticationError,
+  ZohoRateLimitError,
+  ZohoNotFoundError,
+  isRateLimitError,
+} from "@panoptic-it-solutions/zoho-projects-client";
+
+try {
+  const project = await client.projects.get("invalid_id");
+} catch (error) {
+  if (error instanceof ZohoNotFoundError) {
+    console.log("Project not found");
+  } else if (isRateLimitError(error)) {
+    console.log(`Rate limited, retry after ${error.lockoutDurationMs}ms`);
+  } else if (error instanceof ZohoAuthenticationError) {
+    console.log("Invalid credentials");
+  }
+}
+```
+
+## Environment Variables
+
+```env
+ZOHO_CLIENT_ID=your_client_id
+ZOHO_CLIENT_SECRET=your_client_secret
+ZOHO_REFRESH_TOKEN=your_refresh_token
+ZOHO_PORTAL_ID=your_portal_id
+
+# Optional - defaults to US region
+ZOHO_API_URL=https://projectsapi.zoho.com
+ZOHO_ACCOUNTS_URL=https://accounts.zoho.com
+```
+
+## License
+
+MIT

package/dist/auth/token-manager.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Configuration for the token manager
+ */
+export interface TokenManagerConfig {
+    clientId: string;
+    clientSecret: string;
+    refreshToken: string;
+    accountsUrl: string;
+}
+/**
+ * Manages OAuth 2.0 tokens for Zoho Projects API
+ *
+ * Features:
+ * - Client credentials flow
+ * - Automatic token refresh before expiry (at 55 minutes)
+ * - Promise deduplication to prevent concurrent refresh requests
+ */
+export declare class TokenManager {
+    private readonly config;
+    private accessToken;
+    private expiresAt;
+    private refreshPromise;
+    private httpClient;
+    constructor(config: TokenManagerConfig);
+    /**
+     * Get a valid access token, refreshing if necessary
+     * Safe to call concurrently - only one refresh request will be made
+     */
+    getValidToken(): Promise<string>;
+    /**
+     * Check if the current token is valid
+     * Returns false if token is null or within 5 minutes of expiry
+     */
+    private isTokenValid;
+    /**
+     * Refresh the access token
+     * Uses promise deduplication to prevent concurrent refresh requests
+     * This is critical for multi-instance deployments
+     */
+    private refreshToken;
+    /**
+     * Perform the actual token refresh request
+     */
+    private doRefresh;
+    /**
+     * Invalidate the current token
+     * Useful when receiving 401 responses to force a refresh
+     */
+    invalidate(): void;
+    /**
+     * Get token expiry time for debugging/monitoring
+     */
+    getExpiresAt(): number;
+    /**
+     * Get remaining validity in milliseconds
+     */
+    getRemainingValidityMs(): number;
+}
+//# sourceMappingURL=token-manager.d.ts.map

package/dist/auth/token-manager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"token-manager.d.ts","sourceRoot":"","sources":["../../src/auth/token-manager.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;CACrB;AAYD;;;;;;;GAOG;AACH,qBAAa,YAAY;IAMX,OAAO,CAAC,QAAQ,CAAC,MAAM;IALnC,OAAO,CAAC,WAAW,CAAuB;IAC1C,OAAO,CAAC,SAAS,CAAa;IAC9B,OAAO,CAAC,cAAc,CAAgC;IACtD,OAAO,CAAC,UAAU,CAAgB;gBAEL,MAAM,EAAE,kBAAkB;IAOvD;;;OAGG;IACG,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAOtC;;;OAGG;IACH,OAAO,CAAC,YAAY;IASpB;;;;OAIG;YACW,YAAY;IAgB1B;;OAEG;YACW,SAAS;IA6CvB;;;OAGG;IACH,UAAU,IAAI,IAAI;IAKlB;;OAEG;IACH,YAAY,IAAI,MAAM;IAItB;;OAEG;IACH,sBAAsB,IAAI,MAAM;CAMjC"}

package/dist/auth/token-manager.js

@@ -0,0 +1,120 @@
+import axios from "axios";
+import { ZohoAuthenticationError } from "../errors.js";
+/**
+ * Manages OAuth 2.0 tokens for Zoho Projects API
+ *
+ * Features:
+ * - Client credentials flow
+ * - Automatic token refresh before expiry (at 55 minutes)
+ * - Promise deduplication to prevent concurrent refresh requests
+ */
+export class TokenManager {
+    config;
+    accessToken = null;
+    expiresAt = 0;
+    refreshPromise = null;
+    httpClient;
+    constructor(config) {
+        this.config = config;
+        this.httpClient = axios.create({
+            baseURL: config.accountsUrl,
+            timeout: 30000,
+        });
+    }
+    /**
+     * Get a valid access token, refreshing if necessary
+     * Safe to call concurrently - only one refresh request will be made
+     */
+    async getValidToken() {
+        if (this.isTokenValid()) {
+            return this.accessToken;
+        }
+        return this.refreshToken();
+    }
+    /**
+     * Check if the current token is valid
+     * Returns false if token is null or within 5 minutes of expiry
+     */
+    isTokenValid() {
+        if (!this.accessToken) {
+            return false;
+        }
+        // Refresh 5 minutes before expiry
+        const bufferMs = 5 * 60 * 1000;
+        return Date.now() < this.expiresAt - bufferMs;
+    }
+    /**
+     * Refresh the access token
+     * Uses promise deduplication to prevent concurrent refresh requests
+     * This is critical for multi-instance deployments
+     */
+    async refreshToken() {
+        // If a refresh is already in progress, wait for it
+        if (this.refreshPromise) {
+            return this.refreshPromise;
+        }
+        // Start a new refresh
+        this.refreshPromise = this.doRefresh();
+        try {
+            return await this.refreshPromise;
+        }
+        finally {
+            this.refreshPromise = null;
+        }
+    }
+    /**
+     * Perform the actual token refresh request
+     */
+    async doRefresh() {
+        try {
+            const response = await this.httpClient.post("/oauth/v2/token", null, {
+                params: {
+                    grant_type: "refresh_token",
+                    client_id: this.config.clientId,
+                    client_secret: this.config.clientSecret,
+                    refresh_token: this.config.refreshToken,
+                },
+            });
+            const data = response.data;
+            if (!data.access_token) {
+                throw new ZohoAuthenticationError("No access token in response");
+            }
+            this.accessToken = data.access_token;
+            // Set expiry time - tokens are valid for 1 hour (3600 seconds)
+            this.expiresAt = Date.now() + data.expires_in * 1000;
+            return this.accessToken;
+        }
+        catch (error) {
+            if (axios.isAxiosError(error)) {
+                const message = error.response?.data?.error ||
+                    error.message;
+                throw new ZohoAuthenticationError(`Failed to obtain access token: ${message}`, error);
+            }
+            throw new ZohoAuthenticationError(`Failed to obtain access token: ${error instanceof Error ? error.message : "Unknown error"}`, error instanceof Error ? error : undefined);
+        }
+    }
+    /**
+     * Invalidate the current token
+     * Useful when receiving 401 responses to force a refresh
+     */
+    invalidate() {
+        this.accessToken = null;
+        this.expiresAt = 0;
+    }
+    /**
+     * Get token expiry time for debugging/monitoring
+     */
+    getExpiresAt() {
+        return this.expiresAt;
+    }
+    /**
+     * Get remaining validity in milliseconds
+     */
+    getRemainingValidityMs() {
+        if (!this.accessToken) {
+            return 0;
+        }
+        return Math.max(0, this.expiresAt - Date.now());
+    }
+}
+//# sourceMappingURL=token-manager.js.map

package/dist/auth/token-manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"token-manager.js","sourceRoot":"","sources":["../../src/auth/token-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAA6B,MAAM,OAAO,CAAC;AAClD,OAAO,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAsBvD;;;;;;;GAOG;AACH,MAAM,OAAO,YAAY;IAMM;IALrB,WAAW,GAAkB,IAAI,CAAC;IAClC,SAAS,GAAW,CAAC,CAAC;IACtB,cAAc,GAA2B,IAAI,CAAC;IAC9C,UAAU,CAAgB;IAElC,YAA6B,MAA0B;QAA1B,WAAM,GAAN,MAAM,CAAoB;QACrD,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC;YAC7B,OAAO,EAAE,MAAM,CAAC,WAAW;YAC3B,OAAO,EAAE,KAAK;SACf,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,aAAa;QACjB,IAAI,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC;YACxB,OAAO,IAAI,CAAC,WAAY,CAAC;QAC3B,CAAC;QACD,OAAO,IAAI,CAAC,YAAY,EAAE,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACK,YAAY;QAClB,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACtB,OAAO,KAAK,CAAC;QACf,CAAC;QACD,kCAAkC;QAClC,MAAM,QAAQ,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;QAC/B,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,YAAY;QACxB,mDAAmD;QACnD,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,OAAO,IAAI,CAAC,cAAc,CAAC;QAC7B,CAAC;QAED,sBAAsB;QACtB,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;QAEvC,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC;QACnC,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QAC7B,CAAC;IACH,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,SAAS;QACrB,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CACzC,iBAAiB,EACjB,IAAI,EACJ;gBACE,MAAM,EAAE;oBACN,UAAU,EAAE,eAAe;oBAC3B,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ;oBAC/B,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,YAAY;oBACvC,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,YAAY;iBACxC;aACF,CACF,CAAC;YAEF,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;YAE3B,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;gBACvB,MAAM,IAAI,uBAAuB,CAC/B,6BAA6B,CAC9B,CAAC;YACJ,CAAC;YAED,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC;YACrC,+DAA+D;YAC/D,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;YAErD,OAAO,IAAI,CAAC,WAAW,CAAC;QAC1B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC9B,MAAM,OAAO,GACV,KAAK,CAAC,QAAQ,EAAE,IAA2B,EAAE,KAAK;oBACnD,KAAK,CAAC,OAAO,CAAC;gBAChB,MAAM,IAAI,uBAAuB,CAC/B,kCAAkC,OAAO,EAAE,EAC3C,KAAK,CACN,CAAC;YACJ,CAAC;YACD,MAAM,IAAI,uBAAuB,CAC/B,kCAAkC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,EAAE,EAC5F,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAC3C,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,UAAU;QACR,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;IACrB,CAAC;IAED;;OAEG;IACH,YAAY;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,sBAAsB;QACpB,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACtB,OAAO,CAAC,CAAC;QACX,CAAC;QACD,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;IAClD,CAAC;CACF"}

package/dist/client.d.ts

@@ -0,0 +1,193 @@
+import type Bottleneck from "bottleneck";
+import { TokenManager } from "./auth/token-manager.js";
+import { type Project, type Task, type TimeLog, type User, type ListParams, type TimeLogParams } from "./types/index.js";
+import { type RateLimiterConfig } from "./utils/rate-limiter.js";
+import { type AutoPaginateOptions, type PaginatedResponse } from "./utils/pagination.js";
+/**
+ * Configuration for creating a Zoho Projects client
+ */
+export interface ZohoProjectsConfig {
+    /** OAuth client ID from Zoho Developer Console */
+    clientId: string;
+    /** OAuth client secret from Zoho Developer Console */
+    clientSecret: string;
+    /** OAuth refresh token (obtained via authorization code flow) */
+    refreshToken: string;
+    /** Zoho Projects portal ID */
+    portalId: string;
+    /** API base URL (default: https://projectsapi.zoho.com) */
+    apiUrl?: string;
+    /** OAuth accounts URL (default: https://accounts.zoho.com) */
+    accountsUrl?: string;
+    /** Request timeout in milliseconds (default: 30000) */
+    timeout?: number;
+    /** Redis configuration for distributed rate limiting */
+    redis?: RateLimiterConfig["redis"];
+}
+/**
+ * Create a Zoho Projects API client
+ *
+ * @example
+ * ```ts
+ * const client = createZohoProjectsClient({
+ *   clientId: process.env.ZOHO_CLIENT_ID!,
+ *   clientSecret: process.env.ZOHO_CLIENT_SECRET!,
+ *   portalId: process.env.ZOHO_PORTAL_ID!,
+ * });
+ *
+ * // List all projects
+ * const projects = await client.projects.list();
+ *
+ * // Get all projects with auto-pagination
+ * const allProjects = await client.projects.listAll();
+ *
+ * // Stream projects with async iteration
+ * for await (const project of client.projects.iterate()) {
+ *   console.log(project.name);
+ * }
+ * ```
+ */
+export declare function createZohoProjectsClient(config: ZohoProjectsConfig): {
+    /**
+     * Projects API
+     */
+    projects: {
+        /**
+         * List projects with pagination
+         */
+        list(params?: ListParams): Promise<PaginatedResponse<Project>>;
+        /**
+         * Get all projects with auto-pagination
+         */
+        listAll(options?: AutoPaginateOptions): Promise<Project[]>;
+        /**
+         * Iterate over all projects with auto-pagination
+         */
+        iterate(options?: AutoPaginateOptions): AsyncGenerator<Project, void, unknown>;
+        /**
+         * Get a single project by ID
+         */
+        get(projectId: string): Promise<Project>;
+    };
+    /**
+     * Tasks API
+     */
+    tasks: {
+        /**
+         * List tasks for a project with pagination
+         */
+        list(projectId: string, params?: ListParams): Promise<PaginatedResponse<Task>>;
+        /**
+         * Get all tasks for a project with auto-pagination
+         */
+        listAll(projectId: string, options?: AutoPaginateOptions): Promise<Task[]>;
+        /**
+         * Iterate over all tasks for a project with auto-pagination
+         */
+        iterate(projectId: string, options?: AutoPaginateOptions): AsyncGenerator<Task, void, unknown>;
+        /**
+         * Get a single task by ID
+         */
+        get(projectId: string, taskId: string): Promise<Task>;
+        /**
+         * List all tasks across all projects
+         * Note: This fetches all projects first, then tasks for each
+         */
+        listAllAcrossProjects(options?: AutoPaginateOptions): Promise<Task[]>;
+        _getProjectsRef: () => {
+            /**
+             * List projects with pagination
+             */
+            list(params?: ListParams): Promise<PaginatedResponse<Project>>;
+            /**
+             * Get all projects with auto-pagination
+             */
+            listAll(options?: AutoPaginateOptions): Promise<Project[]>;
+            /**
+             * Iterate over all projects with auto-pagination
+             */
+            iterate(options?: AutoPaginateOptions): AsyncGenerator<Project, void, unknown>;
+            /**
+             * Get a single project by ID
+             */
+            get(projectId: string): Promise<Project>;
+        };
+    };
+    /**
+     * Time Logs API
+     */
+    timelogs: {
+        /**
+         * List time logs for a project
+         */
+        list(projectId: string, params: TimeLogParams): Promise<PaginatedResponse<TimeLog>>;
+        /**
+         * Get all time logs for a project with auto-pagination
+         */
+        listAll(projectId: string, params: Omit<TimeLogParams, "index" | "range">, options?: AutoPaginateOptions): Promise<TimeLog[]>;
+        /**
+         * Iterate over all time logs for a project with auto-pagination
+         */
+        iterate(projectId: string, params: Omit<TimeLogParams, "index" | "range">, options?: AutoPaginateOptions): AsyncGenerator<TimeLog, void, unknown>;
+        /**
+         * List all time logs across all projects
+         */
+        listAllAcrossProjects(params: Omit<TimeLogParams, "index" | "range">, options?: AutoPaginateOptions): Promise<TimeLog[]>;
+        _getProjectsRef: () => {
+            /**
+             * List projects with pagination
+             */
+            list(params?: ListParams): Promise<PaginatedResponse<Project>>;
+            /**
+             * Get all projects with auto-pagination
+             */
+            listAll(options?: AutoPaginateOptions): Promise<Project[]>;
+            /**
+             * Iterate over all projects with auto-pagination
+             */
+            iterate(options?: AutoPaginateOptions): AsyncGenerator<Project, void, unknown>;
+            /**
+             * Get a single project by ID
+             */
+            get(projectId: string): Promise<Project>;
+        };
+    };
+    /**
+     * Users API
+     */
+    users: {
+        /**
+         * List all users in the portal
+         */
+        list(params?: ListParams): Promise<PaginatedResponse<User>>;
+        /**
+         * Get all users with auto-pagination
+         */
+        listAll(options?: AutoPaginateOptions): Promise<User[]>;
+        /**
+         * Iterate over all users with auto-pagination
+         */
+        iterate(options?: AutoPaginateOptions): AsyncGenerator<User, void, unknown>;
+        /**
+         * Get a single user by ID
+         */
+        get(userId: string): Promise<User>;
+        /**
+         * List users for a specific project
+         */
+        listForProject(projectId: string, params?: ListParams): Promise<PaginatedResponse<User>>;
+    };
+    /**
+     * Get the underlying token manager for advanced use cases
+     */
+    getTokenManager: () => TokenManager;
+    /**
+     * Get the underlying rate limiter for monitoring
+     */
+    getRateLimiter: () => Bottleneck;
+};
+/**
+ * Type for the Zoho Projects client
+ */
+export type ZohoProjectsClient = ReturnType<typeof createZohoProjectsClient>;
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,UAAU,MAAM,YAAY,CAAC;AAGzC,OAAO,EAAE,YAAY,EAA2B,MAAM,yBAAyB,CAAC;AAMhF,OAAO,EASL,KAAK,OAAO,EACZ,KAAK,IAAI,EACT,KAAK,OAAO,EACZ,KAAK,IAAI,EACT,KAAK,UAAU,EACf,KAAK,aAAa,EACnB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAqB,KAAK,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AACpF,OAAO,EAIL,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACvB,MAAM,uBAAuB,CAAC;AAE/B;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,kDAAkD;IAClD,QAAQ,EAAE,MAAM,CAAC;IACjB,sDAAsD;IACtD,YAAY,EAAE,MAAM,CAAC;IACrB,iEAAiE;IACjE,YAAY,EAAE,MAAM,CAAC;IACrB,8BAA8B;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,2DAA2D;IAC3D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,8DAA8D;IAC9D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uDAAuD;IACvD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,wDAAwD;IACxD,KAAK,CAAC,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC;CACpC;AAYD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,kBAAkB;IAiG/D;;OAEG;;QAED;;WAEG;sBAEQ,UAAU,GAClB,OAAO,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAmBtC;;WAEG;0BACqB,mBAAmB,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;QAIhE;;WAEG;0BAES,mBAAmB,GAC5B,cAAc,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC;QAOzC;;WAEG;uBACkB,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;;IAYhD;;OAEG;;QAED;;WAEG;wBAEU,MAAM,WACR,UAAU,GAClB,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAmBnC;;WAEG;2BAEU,MAAM,YACP,mBAAmB,GAC5B,OAAO,CAAC,IAAI,EAAE,CAAC;QAIlB;;WAEG;2BAEU,MAAM,YACP,mBAAmB,GAC5B,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC;QAOtC;;WAEG;uBACkB,MAAM,UAAU,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;QAW3D;;;WAGG;wCAES,mBAAmB,GAC5B,OAAO,CAAC,IAAI,EAAE,CAAC;;YAlIlB;;eAEG;0BAEQ,UAAU,GAClB,OAAO,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;YAmBtC;;eAEG;8BACqB,mBAAmB,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;YAIhE;;eAEG;8BAES,mBAAmB,GAC5B,cAAc,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC;YAOzC;;eAEG;2BACkB,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;;;IAoGhD;;OAEG;;QAED;;WAEG;wBAEU,MAAM,UACT,aAAa,GACpB,OAAO,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAqDtC;;WAEG;2BAEU,MAAM,UACT,IAAI,CAAC,aAAa,EAAE,OAAO,GAAG,OAAO,CAAC,YACpC,mBAAmB,GAC5B,OAAO,CAAC,OAAO,EAAE,CAAC;QAIrB;;WAEG;2BAEU,MAAM,UACT,IAAI,CAAC,aAAa,EAAE,OAAO,GAAG,OAAO,CAAC,YACpC,mBAAmB,GAC5B,cAAc,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC;QAOzC;;WAEG;sCAEO,IAAI,CAAC,aAAa,EAAE,OAAO,GAAG,OAAO,CAAC,YACpC,mBAAmB,GAC5B,OAAO,CAAC,OAAO,EAAE,CAAC;;YAhPrB;;eAEG;0BAEQ,UAAU,GAClB,OAAO,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;YAmBtC;;eAEG;8BACqB,mBAAmB,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;YAIhE;;eAEG;8BAES,mBAAmB,GAC5B,cAAc,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC;YAOzC;;eAEG;2BACkB,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;;;IAkNhD;;OAEG;;QAED;;WAEG;sBACiB,UAAU,GAAG,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAiBjE;;WAEG;0BACqB,mBAAmB,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;QAI7D;;WAEG;0BAES,mBAAmB,GAC5B,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC;QAOtC;;WAEG;oBACe,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;QAWxC;;WAEG;kCAEU,MAAM,WACR,UAAU,GAClB,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;;IAkBrC;;OAEG;;IAGH;;OAEG;;EAQN;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC,OAAO,wBAAwB,CAAC,CAAC"}