@dereekb/zoho 13.11.14 → 13.11.15

package/nestjs/src/lib/recruit/recruit.module.d.ts

@@ -10,9 +10,9 @@ import { type Maybe } from '@dereekb/util';
  * Resolves the API URL via environment variables following the naming convention
  * `ZOHO_RECRUIT_API_URL` (service-specific) or `ZOHO_API_URL` (shared fallback).
  *
- * @param configService - NestJS config service populated with Zoho environment variables
- * @returns Validated Zoho Recruit service configuration
- * @throws {Error} If required config values (e.g. API URL) are missing
+ * @param configService - NestJS config service populated with Zoho environment variables.
+ * @returns Validated Zoho Recruit service configuration.
+ * @throws {Error} If required config values (e.g. API URL) are missing.
  *
  * @example
  * ```typescript
@@ -28,8 +28,8 @@ export declare function zohoRecruitServiceConfigFactory(configService: ConfigSer
  * Reads Zoho Accounts (OAuth) settings scoped to the Recruit service from
  * the NestJS ConfigService and returns an accounts service config.
  *
- * @param configService - NestJS config service populated with Zoho OAuth environment variables
- * @returns Zoho Accounts service config scoped to the Recruit service access token
+ * @param configService - NestJS config service populated with Zoho OAuth environment variables.
+ * @returns Zoho Accounts service config scoped to the Recruit service access token.
  *
  * @example
  * ```typescript
@@ -68,14 +68,10 @@ export interface ProvideAppZohoRecruitMetadataConfig extends Pick<ModuleMetadata
  * exports {@link ZohoRecruitApi} by default. Additional imports, exports, and providers
  * from the config are merged in.
  *
- * @param config - Module configuration with optional dependency module and extra metadata
+ * @param config - Module configuration with optional dependency module and extra metadata.
  * @returns Complete NestJS module metadata ready to pass to `@Module()`
  *
- * @example
- * ```typescript
- * const cacheService = fileZohoAccountsAccessTokenCacheService();
- *
- * @Module({
+ * @Module ({
  *   providers: [
  *     {
  *       provide: ZohoAccountsAccessTokenCacheService,
@@ -85,9 +81,12 @@ export interface ProvideAppZohoRecruitMetadataConfig extends Pick<ModuleMetadata
  *   exports: [ZohoAccountsAccessTokenCacheService]
  * })
  * export class ZohoRecruitDependencyModule {}
- *
- * @Module(appZohoRecruitModuleMetadata({ dependencyModule: ZohoRecruitDependencyModule }))
+ * @Module (appZohoRecruitModuleMetadata({ dependencyModule: ZohoRecruitDependencyModule }))
  * export class AppZohoRecruitModule {}
  * ```
+ *
+ * @example
+ * ```typescript
+ * const cacheService = fileZohoAccountsAccessTokenCacheService();
  */
 export declare function appZohoRecruitModuleMetadata(config: ProvideAppZohoRecruitMetadataConfig): ModuleMetadata;

package/nestjs/src/lib/sign/sign.api.d.ts

@@ -17,93 +17,93 @@ export declare class ZohoSignApi {
     /**
      * The authenticated Sign context used by all operation accessors.
      *
-     * @returns the Sign context from the underlying client
+     * @returns The Sign context from the underlying client.
      */
     get signContext(): ZohoSignContext;
     /**
      * Rate limiter shared across all Sign requests to respect Zoho API quotas.
      *
-     * @returns the shared rate limiter instance
+     * @returns The shared rate limiter instance.
      */
     get zohoRateLimiter(): import("@dereekb/util").ResetPeriodPromiseRateLimiter;
     /**
      * Initializes the Sign client by combining the service config with the
      * accounts context for OAuth token management.
      *
-     * @param config - Zoho Sign service configuration
-     * @param zohoAccountsApi - accounts API used for OAuth token management
+     * @param config - Zoho Sign service configuration.
+     * @param zohoAccountsApi - Accounts API used for OAuth token management.
      */
     constructor(config: ZohoSignServiceConfig, zohoAccountsApi: ZohoAccountsApi);
     /**
      * Configured pass-through for {@link zohoSignGetDocument}.
      *
-     * @returns bound get document function
+     * @returns Bound get document function.
      */
     get getDocument(): import("@dereekb/zoho").ZohoSignGetDocumentFunction;
     /**
      * Configured pass-through for {@link zohoSignGetDocuments}.
      *
-     * @returns bound get documents function
+     * @returns Bound get documents function.
      */
     get getDocuments(): import("@dereekb/zoho").ZohoSignGetDocumentsFunction;
     /**
      * Configured pass-through for {@link zohoSignGetDocumentsPageFactory}.
      *
-     * @returns bound get documents page factory function
+     * @returns Bound get documents page factory function.
      */
     get getDocumentsPageFactory(): import("@dereekb/util/fetch").FetchPageFactory<import("@dereekb/zoho").ZohoSignGetDocumentsInput, import("@dereekb/zoho").ZohoSignGetDocumentsResponse>;
     /**
      * Configured pass-through for {@link zohoSignGetDocumentFormData}.
      *
-     * @returns bound get document form data function
+     * @returns Bound get document form data function.
      */
     get getDocumentFormData(): import("@dereekb/zoho").ZohoSignGetDocumentFormDataFunction;
     /**
      * Configured pass-through for {@link zohoSignRetrieveFieldTypes}.
      *
-     * @returns bound retrieve field types function
+     * @returns Bound retrieve field types function.
      */
     get retrieveFieldTypes(): import("@dereekb/zoho").ZohoSignRetrieveFieldTypesFunction;
     /**
      * Configured pass-through for {@link zohoSignDownloadPdf}.
      *
-     * @returns bound download PDF function
+     * @returns Bound download PDF function.
      */
     get downloadPdf(): import("@dereekb/zoho").ZohoSignDownloadPdfFunction;
     /**
      * Configured pass-through for {@link zohoSignDownloadCompletionCertificate}.
      *
-     * @returns bound download completion certificate function
+     * @returns Bound download completion certificate function.
      */
     get downloadCompletionCertificate(): import("@dereekb/zoho").ZohoSignDownloadCompletionCertificateFunction;
     /**
      * Configured pass-through for {@link zohoSignCreateDocument}.
      *
-     * @returns bound create document function
+     * @returns Bound create document function.
      */
     get createDocument(): import("@dereekb/zoho").ZohoSignCreateDocumentFunction;
     /**
      * Configured pass-through for {@link zohoSignUpdateDocument}.
      *
-     * @returns bound update document function
+     * @returns Bound update document function.
      */
     get updateDocument(): import("@dereekb/zoho").ZohoSignUpdateDocumentFunction;
     /**
      * Configured pass-through for {@link zohoSignSendDocumentForSignature}.
      *
-     * @returns bound send document for signature function
+     * @returns Bound send document for signature function.
      */
     get sendDocumentForSignature(): import("@dereekb/zoho").ZohoSignSendDocumentForSignatureFunction;
     /**
      * Configured pass-through for {@link zohoSignExtendDocument}.
      *
-     * @returns bound extend document function
+     * @returns Bound extend document function.
      */
     get extendDocument(): import("@dereekb/zoho").ZohoSignExtendDocumentFunction;
     /**
      * Configured pass-through for {@link zohoSignDeleteDocument}.
      *
-     * @returns bound delete document function
+     * @returns Bound delete document function.
      */
     get deleteDocument(): import("@dereekb/zoho").ZohoSignDeleteDocumentFunction;
 }

package/nestjs/src/lib/sign/sign.module.d.ts

@@ -10,9 +10,9 @@ import { type Maybe } from '@dereekb/util';
  * Resolves the API URL via environment variables following the naming convention
  * `ZOHO_SIGN_API_URL` (service-specific) or `ZOHO_API_URL` (shared fallback).
  *
- * @param configService - NestJS config service populated with Zoho environment variables
- * @returns Validated Zoho Sign service configuration
- * @throws {Error} If required config values (e.g. API URL) are missing
+ * @param configService - NestJS config service populated with Zoho environment variables.
+ * @returns Validated Zoho Sign service configuration.
+ * @throws {Error} If required config values (e.g. API URL) are missing.
  *
  * @example
  * ```typescript
@@ -29,8 +29,8 @@ export declare function zohoSignServiceConfigFactory(configService: ConfigServic
  * Reads Zoho Accounts (OAuth) settings scoped to the Sign service from
  * the NestJS ConfigService and returns an accounts service config.
  *
- * @param configService - NestJS config service populated with Zoho OAuth environment variables
- * @returns Zoho Accounts service config scoped to the Sign service access token
+ * @param configService - NestJS config service populated with Zoho OAuth environment variables.
+ * @returns Zoho Accounts service config scoped to the Sign service access token.
  *
  * @example
  * ```typescript
@@ -69,14 +69,10 @@ export interface ProvideAppZohoSignMetadataConfig extends Pick<ModuleMetadata, '
  * exports {@link ZohoSignApi} by default. Additional imports, exports, and providers
  * from the config are merged in.
  *
- * @param config - Module configuration with optional dependency module and extra metadata
+ * @param config - Module configuration with optional dependency module and extra metadata.
  * @returns Complete NestJS module metadata ready to pass to `@Module()`
  *
- * @example
- * ```typescript
- * const cacheService = fileZohoAccountsAccessTokenCacheService();
- *
- * @Module({
+ * @Module ({
  *   providers: [
  *     {
  *       provide: ZohoAccountsAccessTokenCacheService,
@@ -86,9 +82,12 @@ export interface ProvideAppZohoSignMetadataConfig extends Pick<ModuleMetadata, '
  *   exports: [ZohoAccountsAccessTokenCacheService]
  * })
  * export class ZohoSignDependencyModule {}
- *
- * @Module(appZohoSignModuleMetadata({ dependencyModule: ZohoSignDependencyModule }))
+ * @Module (appZohoSignModuleMetadata({ dependencyModule: ZohoSignDependencyModule }))
  * export class AppZohoSignModule {}
  * ```
+ *
+ * @example
+ * ```typescript
+ * const cacheService = fileZohoAccountsAccessTokenCacheService();
  */
 export declare function appZohoSignModuleMetadata(config: ProvideAppZohoSignMetadataConfig): ModuleMetadata;

package/nestjs/src/lib/sign/webhook/webhook.zoho.sign.d.ts

@@ -107,8 +107,8 @@ export type ZohoSignWebhookEvent<T extends ZohoSignWebhookOperationType = ZohoSi
 /**
  * Creates a {@link ZohoSignWebhookEvent} from a raw payload.
  *
- * @param payload - the raw Zoho Sign webhook payload to convert
- * @returns a webhook event with the operation type extracted for convenience
+ * @param payload - The raw Zoho Sign webhook payload to convert.
+ * @returns A webhook event with the operation type extracted for convenience.
  */
 export declare function zohoSignWebhookEvent(payload: ZohoSignWebhookPayload): ZohoSignWebhookEvent;
 export type ZohoSignEventHandler = Handler<ZohoSignWebhookEvent, ZohoSignWebhookOperationType>;

package/nestjs/src/lib/sign/webhook/webhook.zoho.sign.module.d.ts

@@ -4,9 +4,9 @@ import { ConfigService } from '@nestjs/config';
  * Reads the Zoho Sign webhook secret from the NestJS ConfigService
  * and returns a validated webhook service config.
  *
- * @param configService - NestJS config service populated with webhook environment variables
- * @returns Validated Zoho Sign webhook service configuration
- * @throws {Error} If the webhook secret is not configured
+ * @param configService - NestJS config service populated with webhook environment variables.
+ * @returns Validated Zoho Sign webhook service configuration.
+ * @throws {Error} If the webhook secret is not configured.
  */
 export declare function zohoSignWebhookServiceConfigFactory(configService: ConfigService): ZohoSignWebhookServiceConfig;
 export declare class ZohoSignWebhookModule {

package/nestjs/src/lib/sign/webhook/webhook.zoho.sign.verify.d.ts

@@ -29,8 +29,8 @@ export type ZohoSignWebhookEventVerifier = (req: Request, rawBody: Buffer) => Pr
  * in the `X-ZS-WEBHOOK-SIGNATURE` header. This verifier recomputes the signature
  * from the raw request body and compares using timing-safe equality.
  *
- * @param config - Configuration containing the webhook secret key
- * @returns A function that verifies webhook requests
+ * @param config - Configuration containing the webhook secret key.
+ * @returns Verifies webhook requests.
  *
  * @example
  * ```typescript

package/nestjs/src/lib/zoho.config.d.ts

@@ -46,6 +46,7 @@ export declare function readZohoConfigFromConfigService(configService: ConfigSer
 /**
  * Asserts that the provided ZohoConfig has a valid API URL configured.
  *
- * @param config - the Zoho config to validate
+ * @param config - The Zoho config to validate.
+ * @throws {Error} When `config.apiUrl` is missing.
  */
 export declare function assertValidZohoConfig(config: ZohoConfig): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/zoho",
-  "version": "13.11.14",
+  "version": "13.11.15",
   "bin": {
     "zoho-cli": "cli/index.js"
   },
@@ -23,13 +23,13 @@
     }
   },
   "peerDependencies": {
-    "@dereekb/date": "13.11.14",
-    "@dereekb/dbx-cli": "13.11.14",
-    "@dereekb/firebase": "13.11.14",
-    "@dereekb/model": "13.11.14",
-    "@dereekb/nestjs": "13.11.14",
-    "@dereekb/rxjs": "13.11.14",
-    "@dereekb/util": "13.11.14",
+    "@dereekb/date": "13.11.15",
+    "@dereekb/dbx-cli": "13.11.15",
+    "@dereekb/firebase": "13.11.15",
+    "@dereekb/model": "13.11.15",
+    "@dereekb/nestjs": "13.11.15",
+    "@dereekb/rxjs": "13.11.15",
+    "@dereekb/util": "13.11.15",
     "@nestjs/common": "^11.1.19",
     "@nestjs/config": "^4.0.4",
     "express": "^5.2.1",

package/src/lib/accounts/accounts.api.d.ts

@@ -60,8 +60,10 @@ export interface ZohoAccountsAccessTokenErrorResponse {
  * The returned function accepts optional overrides for client credentials and refresh token.
  * When omitted, values are read from the {@link ZohoAccountsContext}'s config.
  *
- * @param context - Authenticated Zoho Accounts context providing fetch and config
- * @returns Function that exchanges a refresh token for an access token
+ * @param context - Authenticated Zoho Accounts context providing fetch and config.
+ * @returns Function that exchanges a refresh token for an access token.
+ *
+ * @see https://www.zoho.com/accounts/protocol/oauth/web-apps/access-token-expiry.html
  *
  * @example
  * ```typescript
@@ -76,8 +78,6 @@ export interface ZohoAccountsAccessTokenErrorResponse {
  *   refreshToken: 'other-refresh-token'
  * });
  * ```
- *
- * @see https://www.zoho.com/accounts/protocol/oauth/web-apps/access-token-expiry.html
  */
 export declare function zohoAccountsAccessToken(context: ZohoAccountsContext): (input?: ZohoAccountsAccessTokenInput) => Promise<ZohoAccountsAccessTokenResponse>;
 /**
@@ -152,7 +152,9 @@ export type ZohoAccountsRefreshTokenFromAuthorizationCodeFunction = (input: Zoho
  * the initial authorization request.
  *
  * @param context - Zoho Accounts context providing fetch and config (clientId/clientSecret)
- * @returns Function that exchanges an authorization code for tokens
+ * @returns Function that exchanges an authorization code for tokens.
+ *
+ * @see https://www.zoho.com/accounts/protocol/oauth/web-apps/access-token.html
  *
  * @example
  * ```typescript
@@ -163,15 +165,13 @@ export type ZohoAccountsRefreshTokenFromAuthorizationCodeFunction = (input: Zoho
  *   redirectUri: 'https://myapp.example.com/oauth/callback'
  * });
  * ```
- *
- * @see https://www.zoho.com/accounts/protocol/oauth/web-apps/access-token.html
  */
 export declare function zohoAccountsRefreshTokenFromAuthorizationCode(context: ZohoAccountsContext): ZohoAccountsRefreshTokenFromAuthorizationCodeFunction;
 /**
  * Constructs a standard {@link FetchJsonInput} for Zoho Accounts API calls with the given HTTP method and optional body.
  *
- * @param method - HTTP method to use for the request
- * @param body - Optional request body to include
- * @returns Configured fetch input for the Zoho Accounts API call
+ * @param method - HTTP method to use for the request.
+ * @param body - Optional request body to include.
+ * @returns Configured fetch input for the Zoho Accounts API call.
  */
 export declare function zohoAccountsApiFetchJsonInput(method: string, body?: FetchJsonBody): FetchJsonInput;

package/src/lib/accounts/accounts.config.d.ts

@@ -19,8 +19,8 @@ export type ZohoAccountsConfigApiUrlInput = ZohoAccountsApiUrlKey | ZohoAccounts
 /**
  * Resolves a Zoho Accounts API URL input to the full base URL. The 'us' key maps to the US datacenter; custom URLs pass through unchanged.
  *
- * @param input - A well-known datacenter key or a custom Zoho Accounts API URL
- * @returns The resolved full Zoho Accounts API base URL
+ * @param input - A well-known datacenter key or a custom Zoho Accounts API URL.
+ * @returns The resolved full Zoho Accounts API base URL.
  */
 export declare function zohoAccountsConfigApiUrl(input: ZohoAccountsConfigApiUrlInput): ZohoApiUrl;
 /**

package/src/lib/accounts/accounts.d.ts

@@ -81,8 +81,9 @@ export type ZohoAccessTokenStringFactory = () => Promise<ZohoAccessTokenString>;
 /**
  * Generates a new ZohoAccessTokenStringFactory.
  *
- * @param zohoAccessTokenFactory - Factory that produces ZohoAccessToken instances
- * @returns A factory function that resolves to the access token string
+ * @param zohoAccessTokenFactory - Factory that produces ZohoAccessToken instances.
+ * @returns A factory function that resolves to the access token string.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function zohoAccessTokenStringFactory(zohoAccessTokenFactory: ZohoAccessTokenFactory): ZohoAccessTokenStringFactory;

package/src/lib/accounts/accounts.error.api.d.ts

@@ -25,16 +25,16 @@ export declare const logZohoAccountsErrorToConsole: import("..").LogZohoServerEr
 /**
  * Parses a fetch response error into a typed Zoho Accounts server error by extracting and interpreting the JSON error body.
  *
- * @param responseError - The fetch response error to parse
- * @returns The parsed Zoho server error, or undefined if the response could not be parsed
+ * @param responseError - The fetch response error to parse.
+ * @returns The parsed Zoho server error, or undefined if the response could not be parsed.
  */
 export declare function parseZohoAccountsError(responseError: FetchResponseError): Promise<ParsedZohoServerError>;
 /**
  * Parses a Zoho Accounts error response body into a typed error. Handles account-specific error codes before falling back to the generic Zoho error parser.
  *
- * @param errorResponseData - The raw error response data from the Zoho Accounts API
- * @param responseError - The original fetch response error for context
- * @returns The parsed Zoho server error, or undefined if the error could not be classified
+ * @param errorResponseData - The raw error response data from the Zoho Accounts API.
+ * @param responseError - The original fetch response error for context.
+ * @returns The parsed Zoho server error, or undefined if the error could not be classified.
  */
 export declare function parseZohoAccountsServerErrorResponseData(errorResponseData: ZohoServerErrorResponseData, responseError: FetchResponseError): ParsedZohoServerError;
 export declare const interceptZohoAccounts200StatusWithErrorResponse: import("@dereekb/util/fetch").FetchJsonInterceptJsonResponseFunction;

package/src/lib/accounts/accounts.factory.d.ts

@@ -37,9 +37,9 @@ export type ZohoAccountsFactory = (config: ZohoAccountsConfig) => ZohoAccounts;
  * The Accounts client is the foundation for CRM, Recruit, and Sign clients, as it provides
  * the {@link ZohoAccountsContext} needed for OAuth token management.
  *
- * @param factoryConfig - Configuration providing optional fetch and logging overrides
- * @returns A factory function that creates authenticated Zoho Accounts clients
- * @throws {Error} If `refreshToken`, `clientId`, or `clientSecret` are missing from the config
+ * @param factoryConfig - Configuration providing optional fetch and logging overrides.
+ * @returns A factory function that creates authenticated Zoho Accounts clients.
+ * @throws {Error} If `refreshToken`, `clientId`, or `clientSecret` are missing from the config.
  *
  * @example
  * ```typescript
@@ -57,6 +57,7 @@ export type ZohoAccountsFactory = (config: ZohoAccountsConfig) => ZohoAccounts;
  *   accountsContext: zohoAccounts.accountsContext
  * });
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function zohoAccountsFactory(factoryConfig: ZohoAccountsFactoryConfig): ZohoAccountsFactory;
@@ -95,9 +96,10 @@ export interface ZohoAccountsZohoAccessTokenFactoryConfig {
  * The returned function also exposes a `resetAccessToken()` method to invalidate
  * the current cached token, typically called on {@link ZohoInvalidTokenError}.
  *
- * @param config - Token refresh, caching, and expiration buffer configuration
- * @returns A token factory function with `resetAccessToken` for cache invalidation
- * @throws {ZohoAccountsAuthFailureError} If the token refresher fails
+ * @param config - Token refresh, caching, and expiration buffer configuration.
+ * @returns A token factory function with `resetAccessToken` for cache invalidation.
+ * @throws {ZohoAccountsAuthFailureError} If the token refresher fails.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function zohoAccountsZohoAccessTokenFactory(config: ZohoAccountsZohoAccessTokenFactoryConfig): ZohoAccessTokenFactory;