@dereekb/zoho 13.10.9 → 13.11.1

package/nestjs/package.json

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

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

@@ -26,6 +26,11 @@ export declare function logMergeZohoAccountsAccessTokenCacheServiceErrorFunction
  *
  * When updating a cached token, it will update the token across all services.
  *
+ * Read fall-through is delegated to {@link mergeAsyncValueCaches} after wrapping each
+ * underlying cache with an {@link isExpired}-aware filter, so an expired cached token
+ * 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
@@ -35,6 +40,9 @@ export declare function mergeZohoAccountsAccessTokenCacheServices(inputServicesT
 /**
  * Creates a ZohoAccountsAccessTokenCacheService that uses in-memory storage.
  *
+ * 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
@@ -49,6 +57,9 @@ export declare const DEFAULT_FILE_ZOHO_ACCOUNTS_ACCESS_TOKEN_CACHE_SERVICE_PATH
 /**
  * Creates a ZohoAccountsAccessTokenCacheService that reads and writes the access token to the file system.
  *
+ * Composes {@link createJsonFileAsyncKeyedValueCache} (for the on-disk record) optionally with
+ * {@link memoizeAsyncKeyedValueCache} so reads after the first hit memory.
+ *
  * Useful for testing.
  *
  * @param filename - path to the JSON file used for token persistence

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

@@ -36,178 +36,266 @@ export declare class ZohoDeskApi {
     constructor(config: ZohoDeskServiceConfig, zohoAccountsApi: ZohoAccountsApi);
     /**
      * Configured pass-through for {@link zohoDeskGetTickets}.
+     *
+     * @returns a function that lists Desk tickets matching the supplied filter/pagination input
      */
     get getTickets(): import("@dereekb/zoho").ZohoDeskGetTicketsFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketById}.
+     *
+     * @returns a function that fetches a single Desk ticket by its identifier
      */
     get getTicketById(): import("@dereekb/zoho").ZohoDeskGetTicketByIdFunction;
     /**
      * Configured pass-through for {@link zohoDeskSearchTickets}.
+     *
+     * @returns a function that runs a Desk ticket search with the provided criteria
      */
     get searchTickets(): import("@dereekb/zoho").ZohoDeskSearchTicketsFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketsForContact}.
+     *
+     * @returns a function that lists Desk tickets associated with the given contact id
      */
     get getTicketsForContact(): import("@dereekb/zoho").ZohoDeskGetTicketsForContactFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketsForProduct}.
+     *
+     * @returns a function that lists Desk tickets associated with the given product id
      */
     get getTicketsForProduct(): import("@dereekb/zoho").ZohoDeskGetTicketsForProductFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketMetrics}.
+     *
+     * @returns a function that fetches aggregated metrics for the requested Desk tickets
      */
     get getTicketMetrics(): import("@dereekb/zoho").ZohoDeskGetTicketMetricsFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetAgentsTicketsCount}.
+     *
+     * @returns a function that returns ticket counts grouped by agent for the requested filter
      */
     get getAgentsTicketsCount(): import("@dereekb/zoho").ZohoDeskGetAgentsTicketsCountFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketsPageFactory}.
+     *
+     * @returns a paged result factory for iterating over Desk ticket list responses
      */
     get getTicketsPageFactory(): import("@dereekb/zoho").ZohoDeskGetTicketsPageFactory;
     /**
      * Configured pass-through for {@link zohoDeskSearchTicketsPageFactory}.
+     *
+     * @returns a paged result factory for iterating over Desk ticket search responses
      */
     get searchTicketsPageFactory(): import("@dereekb/zoho").ZohoDeskSearchTicketsPageFactory;
     /**
      * Configured pass-through for {@link zohoDeskGetDepartments}.
+     *
+     * @returns a function that lists Desk departments visible to the authenticated portal
      */
     get getDepartments(): import("@dereekb/zoho").ZohoDeskGetDepartmentsFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetDepartmentById}.
+     *
+     * @returns a function that fetches a single Desk department by its identifier
      */
     get getDepartmentById(): import("@dereekb/zoho").ZohoDeskGetDepartmentByIdFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetContacts}.
+     *
+     * @returns a function that lists Desk contacts matching the supplied filter/pagination input
      */
     get getContacts(): import("@dereekb/zoho").ZohoDeskGetContactsFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetContactById}.
+     *
+     * @returns a function that fetches a single Desk contact by its identifier
      */
     get getContactById(): import("@dereekb/zoho").ZohoDeskGetContactByIdFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetContactsByIds}.
+     *
+     * @returns a function that fetches multiple Desk contacts in a single request by their identifiers
      */
     get getContactsByIds(): import("@dereekb/zoho").ZohoDeskGetContactsByIdsFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetContactsPageFactory}.
+     *
+     * @returns a paged result factory for iterating over Desk contact list responses
      */
     get getContactsPageFactory(): import("@dereekb/zoho").ZohoDeskGetContactsPageFactory;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketTags}.
+     *
+     * @returns a function that lists the tags currently associated with a given Desk ticket
      */
     get getTicketTags(): import("@dereekb/zoho").ZohoDeskGetTicketTagsFunction;
     /**
      * Configured pass-through for {@link zohoDeskAssociateTicketTags}.
+     *
+     * @returns a function that associates one or more tags with a Desk ticket
      */
     get associateTicketTags(): import("@dereekb/zoho").ZohoDeskAssociateTicketTagsFunction;
     /**
      * Configured pass-through for {@link zohoDeskDissociateTicketTag}.
+     *
+     * @returns a function that removes a single tag association from a Desk ticket
      */
     get dissociateTicketTag(): import("@dereekb/zoho").ZohoDeskDissociateTicketTagFunction;
     /**
      * Configured pass-through for {@link zohoDeskSearchTags}.
+     *
+     * @returns a function that searches the Desk tag catalog by the supplied criteria
      */
     get searchTags(): import("@dereekb/zoho").ZohoDeskSearchTagsFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetAllTags}.
+     *
+     * @returns a function that lists every tag defined on the Desk portal
      */
     get getAllTags(): import("@dereekb/zoho").ZohoDeskGetAllTagsFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketFollowers}.
+     *
+     * @returns a function that lists the agents following a given Desk ticket
      */
     get getTicketFollowers(): import("@dereekb/zoho").ZohoDeskGetTicketFollowersFunction;
     /**
      * Configured pass-through for {@link zohoDeskAddTicketFollowers}.
+     *
+     * @returns a function that adds one or more agents as followers of a Desk ticket
      */
     get addTicketFollowers(): import("@dereekb/zoho").ZohoDeskAddTicketFollowersFunction;
     /**
      * Configured pass-through for {@link zohoDeskRemoveTicketFollowers}.
+     *
+     * @returns a function that removes one or more agents from a Desk ticket's follower list
      */
     get removeTicketFollowers(): import("@dereekb/zoho").ZohoDeskRemoveTicketFollowersFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketAttachments}.
+     *
+     * @returns a function that lists the file attachments on a given Desk ticket
      */
     get getTicketAttachments(): import("@dereekb/zoho").ZohoDeskGetTicketAttachmentsFunction;
     /**
      * Configured pass-through for {@link zohoDeskDeleteTicketAttachment}.
+     *
+     * @returns a function that deletes a single attachment from a Desk ticket by attachment id
      */
     get deleteTicketAttachment(): import("@dereekb/zoho").ZohoDeskDeleteTicketAttachmentFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketComments}.
+     *
+     * @returns a function that lists the comments on a given Desk ticket
      */
     get getTicketComments(): import("@dereekb/zoho").ZohoDeskGetTicketCommentsFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketCommentById}.
+     *
+     * @returns a function that fetches a single comment on a Desk ticket by comment id
      */
     get getTicketCommentById(): import("@dereekb/zoho").ZohoDeskGetTicketCommentByIdFunction;
     /**
      * Configured pass-through for {@link zohoDeskCreateTicketComment}.
+     *
+     * @returns a function that creates a new comment on a Desk ticket from the supplied body
      */
     get createTicketComment(): import("@dereekb/zoho").ZohoDeskCreateTicketCommentFunction;
     /**
      * Configured pass-through for {@link zohoDeskDeleteTicketComment}.
+     *
+     * @returns a function that deletes a single comment from a Desk ticket by comment id
      */
     get deleteTicketComment(): import("@dereekb/zoho").ZohoDeskDeleteTicketCommentFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketTimer}.
+     *
+     * @returns a function that fetches the current timer state for a Desk ticket
      */
     get getTicketTimer(): import("@dereekb/zoho").ZohoDeskGetTicketTimerFunction;
     /**
      * Configured pass-through for {@link zohoDeskPerformTicketTimerAction}.
+     *
+     * @returns a function that performs a timer action (start/pause/stop) on a Desk ticket
      */
     get performTicketTimerAction(): import("@dereekb/zoho").ZohoDeskPerformTicketTimerActionFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketTimeEntries}.
+     *
+     * @returns a function that lists the time entries logged against a Desk ticket
      */
     get getTicketTimeEntries(): import("@dereekb/zoho").ZohoDeskGetTicketTimeEntriesFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketTimeEntryById}.
+     *
+     * @returns a function that fetches a single time entry on a Desk ticket by entry id
      */
     get getTicketTimeEntryById(): import("@dereekb/zoho").ZohoDeskGetTicketTimeEntryByIdFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketTimeEntrySummation}.
+     *
+     * @returns a function that fetches the aggregated time-entry totals for a Desk ticket
      */
     get getTicketTimeEntrySummation(): import("@dereekb/zoho").ZohoDeskGetTicketTimeEntrySummationFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketThreads}.
+     *
+     * @returns a function that lists the conversation threads on a given Desk ticket
      */
     get getTicketThreads(): import("@dereekb/zoho").ZohoDeskGetTicketThreadsFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketThreadById}.
+     *
+     * @returns a function that fetches a single thread on a Desk ticket by thread id
      */
     get getTicketThreadById(): import("@dereekb/zoho").ZohoDeskGetTicketThreadByIdFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketThreadsPageFactory}.
+     *
+     * @returns a paged result factory for iterating over Desk ticket thread responses
      */
     get getTicketThreadsPageFactory(): import("@dereekb/zoho").ZohoDeskGetTicketThreadsPageFactory;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketActivities}.
+     *
+     * @returns a function that lists the activity log entries for a given Desk ticket
      */
     get getTicketActivities(): import("@dereekb/zoho").ZohoDeskGetTicketActivitiesFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketActivitiesPageFactory}.
+     *
+     * @returns a paged result factory for iterating over Desk ticket activity responses
      */
     get getTicketActivitiesPageFactory(): import("@dereekb/zoho").ZohoDeskGetTicketActivitiesPageFactory;
     /**
      * Configured pass-through for {@link zohoDeskGetAgents}.
+     *
+     * @returns a function that lists Desk agents matching the supplied filter/pagination input
      */
     get getAgents(): import("@dereekb/zoho").ZohoDeskGetAgentsFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetAgentById}.
+     *
+     * @returns a function that fetches a single Desk agent by agent id
      */
     get getAgentById(): import("@dereekb/zoho").ZohoDeskGetAgentByIdFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetAgentsByIds}.
+     *
+     * @returns a function that fetches multiple Desk agents in a single request by their identifiers
      */
     get getAgentsByIds(): import("@dereekb/zoho").ZohoDeskGetAgentsByIdsFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetMyInfo}.
+     *
+     * @returns a function that fetches the profile information for the currently authenticated agent
      */
     get getMyInfo(): import("@dereekb/zoho").ZohoDeskGetMyInfoFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetAgentsPageFactory}.
+     *
+     * @returns a paged result factory for iterating over Desk agent list responses
      */
     get getAgentsPageFactory(): import("@dereekb/zoho").ZohoDeskGetAgentsPageFactory;
 }

package/package.json

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