@dereekb/zoho 13.11.14 → 13.11.15

package/nestjs/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@dereekb/zoho/nestjs",
-  "version": "13.11.14",
+  "version": "13.11.15",
   "peerDependencies": {
-    "@dereekb/nestjs": "13.11.14",
-    "@dereekb/rxjs": "13.11.14",
-    "@dereekb/util": "13.11.14",
-    "@dereekb/zoho": "13.11.14",
+    "@dereekb/nestjs": "13.11.15",
+    "@dereekb/rxjs": "13.11.15",
+    "@dereekb/util": "13.11.15",
+    "@dereekb/zoho": "13.11.15",
     "@nestjs/common": "^11.1.19",
     "@nestjs/config": "^4.0.4",
     "express": "^5.2.1"

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

@@ -42,6 +42,6 @@ export type ZohoAccountsServiceConfigFromConfigServiceInput = ZohoConfigServiceR
  * @param input - The {@link ZohoAccountsServiceConfigFromConfigServiceInput} containing the
  *   `ConfigService` and the `serviceAccessTokenKey` for the target Zoho service.
  * @returns A validated {@link ZohoAccountsServiceConfig} ready for use with `ZohoAccountsApi`.
- * @throws If any required credential (apiUrl, refreshToken, clientId) is missing.
+ * @throws {Error} If any required credential (apiUrl, refreshToken, clientId) is missing.
  */
 export declare function zohoAccountsServiceConfigFromConfigService(input: ZohoAccountsServiceConfigFromConfigServiceInput): ZohoAccountsServiceConfig;

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

@@ -16,7 +16,7 @@ export type LogMergeZohoAccountsAccessTokenCacheServiceErrorFunction = (failedUp
 /**
  * Default error logging function for merged Zoho access token cache services.
  *
- * @param failedUpdates - array of cache/error tuples that failed during update
+ * @param failedUpdates - Array of cache/error tuples that failed during update.
  */
 export declare function logMergeZohoAccountsAccessTokenCacheServiceErrorFunction(failedUpdates: (readonly [ZohoAccessTokenCache, unknown])[]): void;
 /**
@@ -31,10 +31,10 @@ export declare function logMergeZohoAccountsAccessTokenCacheServiceErrorFunction
  * never short-circuits the lookup. Updates and clears run across all services in parallel
  * via `Promise.allSettled`, mirroring the previous behavior, with optional error logging.
  *
- * @param servicesToMerge Must include atleast one service. Empty arrays will throw an error.
- * @param inputServicesToMerge - cache services to merge in priority order
- * @param logError - optional error logging toggle or custom logging function
- * @returns a merged ZohoAccountsAccessTokenCacheService that delegates across all inputs
+ * @param inputServicesToMerge - Cache services to merge in priority order. Must include at least one service.
+ * @param logError - Optional error logging toggle or custom logging function.
+ * @returns A merged ZohoAccountsAccessTokenCacheService that delegates across all inputs.
+ * @throws {Error} When `inputServicesToMerge` is empty.
  */
 export declare function mergeZohoAccountsAccessTokenCacheServices(inputServicesToMerge: ZohoAccountsAccessTokenCacheService[], logError?: Maybe<boolean | LogMergeZohoAccountsAccessTokenCacheServiceErrorFunction>): ZohoAccountsAccessTokenCacheService;
 /**
@@ -43,9 +43,9 @@ export declare function mergeZohoAccountsAccessTokenCacheServices(inputServicesT
  * Backed by {@link inMemoryAsyncKeyedValueCache} so all per-service caches share the
  * same record instance.
  *
- * @param existingCache - optional pre-populated token cache record to use as initial state
- * @param logAccessToConsole - whether to log cache reads and writes to the console
- * @returns a ZohoAccountsAccessTokenCacheService backed by in-memory storage
+ * @param existingCache - Optional pre-populated token cache record to use as initial state.
+ * @param logAccessToConsole - Whether to log cache reads and writes to the console.
+ * @returns A ZohoAccountsAccessTokenCacheService backed by in-memory storage.
  */
 export declare function memoryZohoAccountsAccessTokenCacheService(existingCache?: ZohoAccountsAccessTokenCacheRecord, logAccessToConsole?: boolean): ZohoAccountsAccessTokenCacheService;
 export interface FileSystemZohoAccountsAccessTokenCacheService extends ZohoAccountsAccessTokenCacheService {
@@ -62,8 +62,8 @@ export declare const DEFAULT_FILE_ZOHO_ACCOUNTS_ACCESS_TOKEN_CACHE_SERVICE_PATH
  *
  * Useful for testing.
  *
- * @param filename - path to the JSON file used for token persistence
- * @param useMemoryCache - whether to also cache tokens in memory for faster reads
- * @returns a FileSystemZohoAccountsAccessTokenCacheService backed by file storage
+ * @param filename - Path to the JSON file used for token persistence.
+ * @param useMemoryCache - Whether to also cache tokens in memory for faster reads.
+ * @returns A FileSystemZohoAccountsAccessTokenCacheService backed by file storage.
  */
 export declare function fileZohoAccountsAccessTokenCacheService(filename?: string, useMemoryCache?: boolean): FileSystemZohoAccountsAccessTokenCacheService;

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

@@ -17,159 +17,159 @@ export declare class ZohoCrmApi {
     /**
      * The authenticated CRM context used by all operation accessors.
      *
-     * @returns the CRM context from the underlying client
+     * @returns The CRM context from the underlying client.
      */
     get crmContext(): ZohoCrmContext;
     /**
      * Rate limiter shared across all CRM 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 CRM client by combining the service config with the
      * accounts context for OAuth token management.
      *
-     * @param config - Zoho CRM service configuration
-     * @param zohoAccountsApi - accounts API used for OAuth token management
+     * @param config - Zoho CRM service configuration.
+     * @param zohoAccountsApi - Accounts API used for OAuth token management.
      */
     constructor(config: ZohoCrmServiceConfig, zohoAccountsApi: ZohoAccountsApi);
     /**
      * Configured pass-through for {@link zohoCrmInsertRecord}.
      *
-     * @returns bound insert record function
+     * @returns Bound insert record function.
      */
     get insertRecord(): import("@dereekb/zoho").ZohoCrmCreateRecordLikeFunction;
     /**
      * Configured pass-through for {@link zohoCrmUpsertRecord}.
      *
-     * @returns bound upsert record function
+     * @returns Bound upsert record function.
      */
     get upsertRecord(): import("@dereekb/zoho").ZohoCrmUpsertRecordLikeFunction;
     /**
      * Configured pass-through for {@link zohoCrmUpdateRecord}.
      *
-     * @returns bound update record function
+     * @returns Bound update record function.
      */
     get updateRecord(): import("@dereekb/zoho").ZohoCrmUpdateRecordLikeFunction;
     /**
      * Configured pass-through for {@link zohoCrmDeleteRecord}.
      *
-     * @returns bound delete record function
+     * @returns Bound delete record function.
      */
     get deleteRecord(): import("@dereekb/zoho").ZohoCrmDeleteRecordFunction;
     /**
      * Configured pass-through for {@link zohoCrmGetRecordById}.
      *
-     * @returns bound get record by ID function
+     * @returns Bound get record by ID function.
      */
     get getRecordById(): import("@dereekb/zoho").ZohoCrmGetRecordByIdFunction;
     /**
      * Configured pass-through for {@link zohoCrmGetRecords}.
      *
-     * @returns bound get records function
+     * @returns Bound get records function.
      */
     get getRecords(): import("@dereekb/zoho").ZohoCrmGetRecordsFunction;
     /**
      * Configured pass-through for {@link zohoCrmSearchRecords}.
      *
-     * @returns bound search records function
+     * @returns Bound search records function.
      */
     get searchRecords(): import("@dereekb/zoho").ZohoCrmSearchRecordsFunction;
     /**
      * Configured pass-through for {@link zohoCrmSearchRecordsPageFactory}.
      *
-     * @returns bound search records page factory function
+     * @returns Bound search records page factory function.
      */
     get searchRecordsPageFactory(): import("@dereekb/zoho").ZohoCrmSearchRecordsPageFactory;
     /**
      * Configured pass-through for {@link zohoCrmGetRelatedRecordsFunctionFactory}.
      *
-     * @returns bound get related records factory function
+     * @returns Bound get related records factory function.
      */
     get getRelatedRecordsFunctionFactory(): import("@dereekb/zoho").ZohoCrmGetRelatedRecordsFunctionFactory;
     /**
      * Configured pass-through for {@link zohoCrmGetEmailsForRecord}.
      *
-     * @returns bound get emails for record function
+     * @returns Bound get emails for record function.
      */
     get getEmailsForRecord(): import("@dereekb/zoho").ZohoCrmGetEmailsForRecordFunction;
     /**
      * Configured pass-through for {@link zohoCrmGetEmailsForRecordPageFactory}.
      *
-     * @returns bound get emails page factory function
+     * @returns Bound get emails page factory function.
      */
     get getEmailsForRecordPageFactory(): import("@dereekb/zoho").ZohoCrmGetEmailsForRecordPageFactory;
     /**
      * Configured pass-through for {@link zohoCrmGetAttachmentsForRecord}.
      *
-     * @returns bound get attachments for record function
+     * @returns Bound get attachments for record function.
      */
     get getAttachmentsForRecord(): import("@dereekb/zoho").ZohoCrmGetAttachmentsForRecordFunction;
     /**
      * Configured pass-through for {@link zohoCrmGetAttachmentsForRecordPageFactory}.
      *
-     * @returns bound get attachments page factory function
+     * @returns Bound get attachments page factory function.
      */
     get getAttachmentsForRecordPageFactory(): import("@dereekb/zoho").ZohoCrmGetAttachmentsForRecordPageFactory;
     /**
      * Configured pass-through for {@link zohoCrmUploadAttachmentForRecord}.
      *
-     * @returns bound upload attachment function
+     * @returns Bound upload attachment function.
      */
     get uploadAttachmentForRecord(): import("@dereekb/zoho").ZohoCrmUploadAttachmentForRecordFunction;
     /**
      * Configured pass-through for {@link zohoCrmDownloadAttachmentForRecord}.
      *
-     * @returns bound download attachment function
+     * @returns Bound download attachment function.
      */
     get downloadAttachmentForRecord(): import("@dereekb/zoho").ZohoCrmDownloadAttachmentForRecordFunction;
     /**
      * Configured pass-through for {@link zohoCrmDeleteAttachmentFromRecord}.
      *
-     * @returns bound delete attachment function
+     * @returns Bound delete attachment function.
      */
     get deleteAttachmentFromRecord(): import("@dereekb/zoho").ZohoCrmDeleteAttachmentFromRecordFunction;
     /**
      * Configured pass-through for {@link zohoCrmCreateNotes}.
      *
-     * @returns bound create notes function
+     * @returns Bound create notes function.
      */
     get createNotes(): (input: import("@dereekb/zoho").ZohoCrmCreateNotesRequest) => Promise<import("@dereekb/zoho").ZohoCrmMultiRecordResult<import("@dereekb/zoho").NewZohoCrmNoteData, import("@dereekb/zoho").ZohoCrmChangeObjectResponseSuccessEntry<import("@dereekb/zoho").ZohoCrmChangeObjectDetails>, import("@dereekb/zoho").ZohoCrmChangeObjectResponseErrorEntry>>;
     /**
      * Configured pass-through for {@link zohoCrmDeleteNotes}.
      *
-     * @returns bound delete notes function
+     * @returns Bound delete notes function.
      */
     get deleteNotes(): (input: import("@dereekb/zoho").ZohoCrmDeleteNotesRequest) => Promise<import("@dereekb/zoho").ZohoCrmMultiRecordResult<string, import("@dereekb/zoho").ZohoCrmChangeObjectResponseSuccessEntry<import("@dereekb/zoho").ZohoCrmChangeObjectDetails>, import("@dereekb/zoho").ZohoCrmChangeObjectResponseErrorEntry>>;
     /**
      * Configured pass-through for {@link zohoCrmCreateNotesForRecord}.
      *
-     * @returns bound create notes for record function
+     * @returns Bound create notes for record function.
      */
     get createNotesForRecord(): import("@dereekb/zoho").ZohoCrmCreateNotesForRecordFunction;
     /**
      * Configured pass-through for {@link zohoCrmGetNotesForRecord}.
      *
-     * @returns bound get notes for record function
+     * @returns Bound get notes for record function.
      */
     get getNotesForRecord(): import("@dereekb/zoho").ZohoCrmGetNotesForRecordFunction;
     /**
      * Configured pass-through for {@link zohoCrmGetNotesForRecordPageFactory}.
      *
-     * @returns bound get notes page factory function
+     * @returns Bound get notes page factory function.
      */
     get getNotesForRecordPageFactory(): import("@dereekb/zoho").ZohoCrmGetNotesForRecordPageFactory;
     /**
      * Configured pass-through for {@link zohoCrmExecuteRestApiFunction}.
      *
-     * @returns bound execute REST API function
+     * @returns Bound execute REST API function.
      */
     get executeRestApiFunction(): import("@dereekb/zoho").ZohoCrmExecuteRestApiFunctionFunction;
     /**
      * Configured pass-through for {@link zohoCrmCreateTagsForModule}.
      *
-     * @returns bound create tags for module function
+     * @returns Bound create tags for module function.
      */
     get createTagsForModule(): (input: import("@dereekb/zoho").ZohoCrmCreateTagsRequest) => Promise<{
         errorItems: import("@dereekb/zoho").ZohoCrmMultiRecordResultEntry<import("@dereekb/zoho").ZohoCrmCreateTagData, import("@dereekb/zoho").ZohoCrmChangeObjectResponseErrorEntry>[];
@@ -180,25 +180,25 @@ export declare class ZohoCrmApi {
     /**
      * Configured pass-through for {@link zohoCrmDeleteTag}.
      *
-     * @returns bound delete tag function
+     * @returns Bound delete tag function.
      */
     get deleteTag(): import("@dereekb/zoho").ZohoCrmDeleteTagFunction;
     /**
      * Configured pass-through for {@link zohoCrmGetTagsForModule}.
      *
-     * @returns bound get tags for module function
+     * @returns Bound get tags for module function.
      */
     get getTagsForModule(): import("@dereekb/zoho").ZohoCrmGetTagsFunction;
     /**
      * Configured pass-through for {@link zohoCrmAddTagsToRecords}.
      *
-     * @returns bound add tags to records function
+     * @returns Bound add tags to records function.
      */
     get addTagsToRecords(): import("@dereekb/zoho").ZohoCrmAddTagsToRecordsFunction;
     /**
      * Configured pass-through for {@link zohoCrmRemoveTagsFromRecords}.
      *
-     * @returns bound remove tags from records function
+     * @returns Bound remove tags from records function.
      */
     get removeTagsFromRecords(): import("@dereekb/zoho").ZohoCrmRemoveTagsFromRecordsFunction;
 }

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

@@ -21,7 +21,7 @@ export declare abstract class ZohoCrmServiceConfig {
     /**
      * Validates that the required Zoho CRM connection fields are present and well-formed.
      *
-     * @param config - the CRM service config to validate
+     * @param config - The CRM service config to validate.
      */
     static assertValidConfig(config: ZohoCrmServiceConfig): void;
 }

package/nestjs/src/lib/crm/crm.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_CRM_API_URL` (service-specific) or `ZOHO_API_URL` (shared fallback).
  *
- * @param configService - NestJS config service populated with Zoho environment variables
- * @returns Validated Zoho CRM 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 CRM service configuration.
+ * @throws {Error} If required config values (e.g. API URL) are missing.
  *
  * @example
  * ```typescript
@@ -28,8 +28,8 @@ export declare function zohoCrmServiceConfigFactory(configService: ConfigService
  * Reads Zoho Accounts (OAuth) settings scoped to the CRM 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 CRM service access token
+ * @param configService - NestJS config service populated with Zoho OAuth environment variables.
+ * @returns Zoho Accounts service config scoped to the CRM service access token.
  *
  * @example
  * ```typescript
@@ -68,14 +68,10 @@ export interface ProvideAppZohoCrmMetadataConfig extends Pick<ModuleMetadata, 'i
  * exports {@link ZohoCrmApi} 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 ProvideAppZohoCrmMetadataConfig extends Pick<ModuleMetadata, 'i
  *   exports: [ZohoAccountsAccessTokenCacheService]
  * })
  * export class ZohoCrmDependencyModule {}
- *
- * @Module(appZohoCrmModuleMetadata({ dependencyModule: ZohoCrmDependencyModule }))
+ * @Module (appZohoCrmModuleMetadata({ dependencyModule: ZohoCrmDependencyModule }))
  * export class AppZohoCrmModule {}
  * ```
+ *
+ * @example
+ * ```typescript
+ * const cacheService = fileZohoAccountsAccessTokenCacheService();
  */
 export declare function appZohoCrmModuleMetadata(config: ProvideAppZohoCrmMetadataConfig): ModuleMetadata;