woodsportal-client-sdk 1.1.4-dev.56 → 1.1.4-dev.57

package/README.md

@@ -225,6 +225,22 @@ export class ObjectsTableComponent {
 
 ---
 
+## Cache purge (CRM Sync)
+
+Prefer **`POST /api/{hubId}/{portalId}/cache-purge-jobs`** over habitual `cache=false` on list reads. Requires `FEATURE_CACHE_PURGE_API_ENABLED` on the API.
+
+| Export | Use |
+|--------|-----|
+| `createCachePurgeJob` | POST + optional warm job poll |
+| `buildCrmListPurgeTarget` / `buildCrmSinglePurgeTarget` | List or detail scope |
+| `buildEngagementPurgeTarget` | `notes` / `emails` / `files` (requires `recordIds`) |
+| `purgeCrmListCache` / `purgeEngagementCaches` | Convenience wrappers returning `PurgeResult` |
+| `purgeCrmObjectDataCache` | Legacy list-only boolean shorthand |
+
+API guide: `woodsportal-api/docs/CACHE-PURGE-API.md` in the monorepo. Types: `src/types/cache-purge.ts`; helpers: `src/utils/cache/`.
+
+---
+
 ## Security & privacy
 
 - Send credentials and tokens **only over HTTPS** in production.

package/dist/adapters/angular/index.js

@@ -1,6 +1,6 @@
 import { bindStoreWithActions } from '../../chunk-Y5MRAAGK.js';
-import { createAdapterHooks } from '../../chunk-XZM2KSXY.js';
-import '../../chunk-YSASAXVN.js';
+import { createAdapterHooks } from '../../chunk-YQLDJJ5M.js';
+import '../../chunk-HSJU2Z2S.js';
 import '../../chunk-2SYUOWTT.js';
 import { inject, DestroyRef, signal } from '@angular/core';
 

package/dist/adapters/react/index.js

@@ -1,5 +1,5 @@
-import { createAdapterHooks } from '../../chunk-XZM2KSXY.js';
-import '../../chunk-YSASAXVN.js';
+import { createAdapterHooks } from '../../chunk-YQLDJJ5M.js';
+import '../../chunk-HSJU2Z2S.js';
 import '../../chunk-2SYUOWTT.js';
 import { useSyncExternalStore } from 'react';
 

package/dist/adapters/vue/index.js

@@ -1,6 +1,6 @@
 import { bindStoreWithActions } from '../../chunk-Y5MRAAGK.js';
-import { createAdapterHooks } from '../../chunk-XZM2KSXY.js';
-import '../../chunk-YSASAXVN.js';
+import { createAdapterHooks } from '../../chunk-YQLDJJ5M.js';
+import '../../chunk-HSJU2Z2S.js';
 import '../../chunk-2SYUOWTT.js';
 import { reactive, onScopeDispose } from 'vue';
 

package/dist/{chunk-YSASAXVN.js → chunk-HSJU2Z2S.js}

@@ -1090,7 +1090,7 @@ var Client = {
   },
   object: {
     list: async (payload = null, param = null) => {
-      param.cache = payload.cache;
+      param.cache = payload?.cache !== false ? true : false;
       const params = { hubspotObjectTypeId: payload?.hubspotObjectTypeId };
       const { updateLink, getLinkParams } = useUpdateLink();
       const { getParamDetails: getParamDetails2 } = routeParam;
@@ -1115,7 +1115,7 @@ var Client = {
           "fPn": param?.filterPropertyName,
           "fO": param?.filterOperator,
           "fV": param?.filterValue,
-          "c": param?.cache,
+          "c": param?.cache !== false,
           "isPC": param?.isPrimaryCompany,
           "v": param?.view,
           "l": param?.limit,
@@ -3200,6 +3200,223 @@ function formatHubSpotActivityDateTime(timestamp, timeZone = getCurrentTimeZone(
   return formatHubSpotActivityDateTimeParts(timestamp, timeZone)?.formatted ?? "";
 }
 
+// src/utils/cache/builders.ts
+function buildCrmListPurgeTarget(objectTypeId, listQuery) {
+  return {
+    domain: "crm_object_data",
+    objectTypeId,
+    views: ["list"],
+    listQuery: listQuery ?? { page: 1, limit: 10, view: "LIST" }
+  };
+}
+function buildCrmSinglePurgeTarget(objectTypeId, recordIds, listQuery) {
+  return {
+    domain: "crm_object_data",
+    objectTypeId,
+    views: ["single"],
+    recordIds,
+    listQuery
+  };
+}
+function buildEngagementPurgeTarget(objectTypeId, recordIds, views, options) {
+  if (!recordIds.length) {
+    throw new Error("recordIds is required for engagement purge views");
+  }
+  return {
+    domain: "crm_object_data",
+    objectTypeId,
+    recordIds,
+    views,
+    fileIds: options?.fileIds,
+    listQuery: options?.listQuery ?? { page: 1, limit: 10 }
+  };
+}
+function buildUserSessionPurgeTarget() {
+  return { domain: "user_session" };
+}
+function buildPortalConfigPurgeTarget(objectTypeIds) {
+  return {
+    domain: "portal_object_config",
+    objectTypeIds
+  };
+}
+function mergePurgeTargets(...targets) {
+  return targets;
+}
+function buildCachePurgeRequest(targets, options) {
+  return {
+    mode: options?.mode ?? "soft",
+    warm: options?.warm ?? true,
+    includeContactAccess: options?.includeContactAccess ?? true,
+    includeShortOnHard: options?.includeShortOnHard ?? false,
+    confirmPortalWide: options?.confirmPortalWide ?? false,
+    targets
+  };
+}
+
+// src/utils/cache/createCachePurgeJob.ts
+function randomIdempotencyKey() {
+  if (typeof crypto !== "undefined" && crypto.randomUUID) {
+    return crypto.randomUUID();
+  }
+  return `purge-${Date.now()}-${Math.random().toString(36).slice(2)}`;
+}
+function mapErrorCode(status, message) {
+  if (status === 400 || status === 422) {
+    return "VALIDATION";
+  }
+  if (status === 429) {
+    return "RATE_LIMITED";
+  }
+  if (message?.toLowerCase().includes("disabled")) {
+    return "PURGE_API_DISABLED";
+  }
+  return status ? "UNKNOWN" : "NETWORK";
+}
+function sleep(ms) {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}
+async function createCachePurgeJob(request, options = {}) {
+  const idempotencyKey = options.idempotencyKey ?? randomIdempotencyKey();
+  try {
+    const headers = { "Idempotency-Key": idempotencyKey };
+    const response = await Client.cache.purge(
+      request,
+      headers
+    );
+    const data = response?.data;
+    const purgeJobId = data?.purgeJobId;
+    let status = data?.status;
+    if (options.waitForWarm && purgeJobId && request.warm !== false) {
+      const timeout = options.pollTimeoutMs ?? 3e4;
+      const interval = options.pollIntervalMs ?? 500;
+      const deadline = Date.now() + timeout;
+      while (Date.now() < deadline) {
+        const statusRes = await Client.cache.purgeStatus(purgeJobId);
+        const job = statusRes?.data;
+        const jobStatus = job?.status;
+        if (jobStatus === "completed") {
+          status = "completed";
+          break;
+        }
+        if (jobStatus === "failed") {
+          return {
+            ok: false,
+            purgeJobId,
+            status: "failed",
+            errorCode: "WARM_FAILED",
+            message: "Cache warm job failed"
+          };
+        }
+        await sleep(interval);
+      }
+      if (status !== "completed") {
+        return {
+          ok: false,
+          purgeJobId,
+          status: status ?? "warming",
+          errorCode: "WARM_FAILED",
+          message: "Timed out waiting for cache warm job"
+        };
+      }
+    }
+    return {
+      ok: true,
+      purgeJobId,
+      status,
+      evicted: data?.evicted,
+      warnings: data?.warnings
+    };
+  } catch (err) {
+    const axiosErr = err;
+    const status = axiosErr.response?.status;
+    const message = axiosErr.response?.data?.message ?? (err instanceof Error ? err.message : "Cache purge request failed");
+    return {
+      ok: false,
+      errorCode: mapErrorCode(status, message),
+      message
+    };
+  }
+}
+
+// src/utils/cache/crmCacheRefresh.ts
+async function purgeCrmObjectDataCache(options) {
+  const result = await purgeCrmListCache(options);
+  return result.ok;
+}
+async function purgeCrmListCache(options) {
+  const objectTypeId = options.objectTypeId?.trim();
+  if (!objectTypeId) {
+    return { ok: false, errorCode: "VALIDATION", message: "objectTypeId is required" };
+  }
+  const target = buildCrmListPurgeTarget(objectTypeId, options.listQuery);
+  const request = buildCachePurgeRequest([target], {
+    mode: options.mode,
+    warm: options.warm
+  });
+  return createCachePurgeJob(request, {
+    idempotencyKey: options.idempotencyKey,
+    waitForWarm: options.waitForWarm
+  });
+}
+async function purgeCrmRecordCache(options) {
+  const objectTypeId = options.objectTypeId?.trim();
+  if (!objectTypeId || !options.recordIds?.length) {
+    return {
+      ok: false,
+      errorCode: "VALIDATION",
+      message: "objectTypeId and recordIds are required"
+    };
+  }
+  const target = buildCrmSinglePurgeTarget(
+    objectTypeId,
+    options.recordIds,
+    options.listQuery
+  );
+  const request = buildCachePurgeRequest([target], {
+    mode: options.mode,
+    warm: options.warm
+  });
+  return createCachePurgeJob(request, {
+    idempotencyKey: options.idempotencyKey,
+    waitForWarm: options.waitForWarm
+  });
+}
+async function purgeEngagementCaches(options) {
+  const objectTypeId = options.objectTypeId?.trim();
+  if (!objectTypeId || !options.recordIds?.length || !options.views?.length) {
+    return {
+      ok: false,
+      errorCode: "VALIDATION",
+      message: "objectTypeId, recordIds, and views are required"
+    };
+  }
+  const target = buildEngagementPurgeTarget(
+    objectTypeId,
+    options.recordIds,
+    options.views,
+    { fileIds: options.fileIds, listQuery: options.listQuery }
+  );
+  const request = buildCachePurgeRequest([target], {
+    mode: options.mode,
+    warm: options.warm
+  });
+  return createCachePurgeJob(request, {
+    idempotencyKey: options.idempotencyKey,
+    waitForWarm: options.waitForWarm
+  });
+}
+async function purgeCrmCombined(options) {
+  const request = buildCachePurgeRequest(options.targets, {
+    mode: options.mode,
+    warm: options.warm
+  });
+  return createCachePurgeJob(request, {
+    idempotencyKey: options.idempotencyKey,
+    waitForWarm: options.waitForWarm
+  });
+}
+
 // src/index.ts
 var api = {
   preLogin,
@@ -3269,6 +3486,6 @@ var routeParam = {
   getParamDetails
 };
 
-export { DEFAULT_HUBSPOT_TIMEZONE, actions2 as actions, actions3 as actions2, actions4 as actions3, actions5 as actions4, actions6 as actions5, actions7 as actions6, api, breadcrumbsDetails, client_exports, emailStore, formatGmtOffset, formatHubSpotActivityDateTime, formatHubSpotActivityDateTimeParts, getCurrentTimeZone, getFieldErrors, getFormErrors, initializeHttpClient, multiObjectStore, normalizeToTimestamp, noteStore, routeParam, store, syncStore, tableStore2 as tableStore, uploaderStore, url };
-//# sourceMappingURL=chunk-YSASAXVN.js.map
-//# sourceMappingURL=chunk-YSASAXVN.js.map
+export { DEFAULT_HUBSPOT_TIMEZONE, actions2 as actions, actions3 as actions2, actions4 as actions3, actions5 as actions4, actions6 as actions5, actions7 as actions6, api, breadcrumbsDetails, buildCachePurgeRequest, buildCrmListPurgeTarget, buildCrmSinglePurgeTarget, buildEngagementPurgeTarget, buildPortalConfigPurgeTarget, buildUserSessionPurgeTarget, client_exports, createCachePurgeJob, emailStore, formatGmtOffset, formatHubSpotActivityDateTime, formatHubSpotActivityDateTimeParts, getCurrentTimeZone, getFieldErrors, getFormErrors, initializeHttpClient, mergePurgeTargets, multiObjectStore, normalizeToTimestamp, noteStore, purgeCrmCombined, purgeCrmListCache, purgeCrmObjectDataCache, purgeCrmRecordCache, purgeEngagementCaches, routeParam, store, syncStore, tableStore2 as tableStore, uploaderStore, url };
+//# sourceMappingURL=chunk-HSJU2Z2S.js.map
+//# sourceMappingURL=chunk-HSJU2Z2S.js.map