@pitcher/js-api 1.25.1 → 1.26.0-beta.10

package/impact-js-api.spec.json

@@ -178,6 +178,21 @@
     "crm_query": {
       "description": ""
     },
+    "crm_smart_query": {
+      "description": "Execute a SmartStore query against local CRM data. iOS only."
+    },
+    "crm_smart_upsert_objects": {
+      "description": "Upsert CRM objects into local CRM data using SmartStore. iOS only."
+    },
+    "crm_smart_object_validation_rules": {
+      "description": "Retrieve validation rules for a CRM smart object. iOS only."
+    },
+    "crm_smart_object_metadata": {
+      "description": "Retrieve metadata for a CRM smart object. iOS only."
+    },
+    "crm_smart_delete_objects": {
+      "description": "Delete CRM objects from local CRM data using SmartStore. iOS only."
+    },
     "search": {
       "description": ""
     },

package/js-api.esm.js

@@ -2537,6 +2537,153 @@ function query(payload) {
 function crmQuery(payload) {
   return highLevelApi.API.request("crm_query", payload);
 }
+function crmSmartQuery(payload) {
+  const query2 = payload.query;
+  if (!query2 || typeof query2 !== "string") {
+    return Promise.reject(new Error("Query is required and must be a string"));
+  }
+  const smartStorePattern = /\{[^}]+:[^}]+\}/;
+  if (!smartStorePattern.test(query2.trim())) {
+    return Promise.reject(
+      new Error(
+        "Invalid SmartStore query syntax. SmartStore queries must use curly braces syntax: {SoupName:FieldName}"
+      )
+    );
+  }
+  return highLevelApi.API.request("crm_smart_query", payload);
+}
+function crmSmartObjectMetadata(payload) {
+  if (!payload) {
+    return Promise.reject(new Error("Payload is required"));
+  }
+  const objectName = payload.object;
+  if (!objectName || typeof objectName !== "string" || objectName.trim() === "") {
+    return Promise.reject(new Error("Object name is required and must be a non-empty string"));
+  }
+  return highLevelApi.API.request("crm_smart_object_metadata", payload);
+}
+function crmSmartUpsertObjects(payload) {
+  if (!payload || !payload.objects || !Array.isArray(payload.objects)) {
+    return Promise.reject(new Error("Payload must contain an array of objects"));
+  }
+  if (payload.objects.length === 0) {
+    return Promise.reject(new Error("Objects array cannot be empty"));
+  }
+  for (const obj of payload.objects) {
+    if (!obj) {
+      return Promise.reject(new Error("Objects array cannot contain null or undefined elements"));
+    }
+    if (!obj.table_name || typeof obj.table_name !== "string" || obj.table_name.trim() === "") {
+      return Promise.reject(new Error("Each object must have a valid non-empty table_name"));
+    }
+    if (obj.external_id_path !== void 0) {
+      if (typeof obj.external_id_path !== "string" || obj.external_id_path.trim() === "") {
+        return Promise.reject(
+          new Error(
+            `Object for table ${obj.table_name} has invalid external_id_path. It must be a non-empty string or undefined.`
+          )
+        );
+      }
+    }
+    if (!obj.objects || !Array.isArray(obj.objects) || obj.objects.length === 0) {
+      return Promise.reject(new Error(`Object for table ${obj.table_name} must have a non-empty objects array`));
+    }
+    for (let i = 0; i < obj.objects.length; i++) {
+      const record = obj.objects[i];
+      if (!record || typeof record !== "object" || Array.isArray(record)) {
+        return Promise.reject(
+          new Error(
+            `Object for table ${obj.table_name} contains invalid element at index ${i}. All records must be valid objects, not null, undefined, or arrays.`
+          )
+        );
+      }
+    }
+  }
+  return highLevelApi.API.request("crm_smart_upsert_objects", payload);
+}
+function crmSmartObjectValidationRules(payload) {
+  if (!payload) {
+    return Promise.reject(new Error("Payload is required"));
+  }
+  const objectName = payload.object;
+  if (!objectName || typeof objectName !== "string" || objectName.trim() === "") {
+    return Promise.reject(new Error("Object name is required and must be a non-empty string"));
+  }
+  return highLevelApi.API.request("crm_smart_object_validation_rules", payload);
+}
+function crmSmartDeleteObjects(payload) {
+  if (!payload || !payload.objects || !Array.isArray(payload.objects)) {
+    return Promise.reject(new Error("Payload must contain an array of objects"));
+  }
+  if (payload.objects.length === 0) {
+    return Promise.reject(new Error("Objects array cannot be empty"));
+  }
+  for (const obj of payload.objects) {
+    if (!obj) {
+      return Promise.reject(new Error("Objects array cannot contain null or undefined elements"));
+    }
+    if (!obj.table_name || typeof obj.table_name !== "string" || obj.table_name.trim() === "") {
+      return Promise.reject(new Error("Each object must have a valid non-empty table_name"));
+    }
+    if (!obj.ids || !Array.isArray(obj.ids) || obj.ids.length === 0) {
+      return Promise.reject(new Error(`Object for table ${obj.table_name} must have a non-empty ids array`));
+    }
+    for (let i = 0; i < obj.ids.length; i++) {
+      const id = obj.ids[i];
+      if (!id || typeof id !== "string" || id.trim() === "") {
+        return Promise.reject(
+          new Error(
+            `Object for table ${obj.table_name} contains invalid id at index ${i}. All IDs must be non-empty strings.`
+          )
+        );
+      }
+    }
+  }
+  return highLevelApi.API.request("crm_smart_delete_objects", payload);
+}
+function crmCreate(payload) {
+  if (!payload) {
+    return Promise.reject(new Error("Payload is required"));
+  }
+  if (!payload.sobject || typeof payload.sobject !== "string" || payload.sobject.trim() === "") {
+    return Promise.reject(new Error("sobject is required and must be a non-empty string"));
+  }
+  if (!payload.records || !Array.isArray(payload.records) || payload.records.length === 0) {
+    return Promise.reject(new Error("records is required and must be a non-empty array"));
+  }
+  for (let i = 0; i < payload.records.length; i++) {
+    const record = payload.records[i];
+    if (!record || typeof record !== "object" || Array.isArray(record)) {
+      return Promise.reject(
+        new Error(`records contains invalid element at index ${i}. All records must be valid objects.`)
+      );
+    }
+  }
+  return highLevelApi.API.request("crm_create", payload);
+}
+function crmUpsert(payload) {
+  if (!payload) {
+    return Promise.reject(new Error("Payload is required"));
+  }
+  if (!payload.sobject || typeof payload.sobject !== "string" || payload.sobject.trim() === "") {
+    return Promise.reject(new Error("sobject is required and must be a non-empty string"));
+  }
+  if (!payload.records || !Array.isArray(payload.records) || payload.records.length === 0) {
+    return Promise.reject(new Error("records is required and must be a non-empty array"));
+  }
+  if (!payload.external_id_field || typeof payload.external_id_field !== "string" || payload.external_id_field.trim() === "") {
+    return Promise.reject(new Error("external_id_field is required and must be a non-empty string"));
+  }
+  for (let i = 0; i < payload.records.length; i++) {
+    const record = payload.records[i];
+    if (!record || typeof record !== "object" || Array.isArray(record)) {
+      return Promise.reject(
+        new Error(`records contains invalid element at index ${i}. All records must be valid objects.`)
+      );
+    }
+  }
+  return highLevelApi.API.request("crm_upsert", payload);
+}
 
 function getFolders(payload) {
   return this.API.request("get_folders", payload);
@@ -2633,7 +2780,14 @@ const modules = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
 	createFavorite,
 	createFile,
 	createFolder,
+	crmCreate,
 	crmQuery,
+	crmSmartDeleteObjects,
+	crmSmartObjectMetadata,
+	crmSmartObjectValidationRules,
+	crmSmartQuery,
+	crmSmartUpsertObjects,
+	crmUpsert,
 	deleteCanvas,
 	deleteEvent,
 	deleteFavorite,
@@ -2807,6 +2961,7 @@ var PitcherEventName = /* @__PURE__ */ ((PitcherEventName2) => {
   PitcherEventName2["ITEM_SHAREBOX_ADD_REQUESTED"] = "item_sharebox_add_requested";
   PitcherEventName2["ITEM_SHAREBOX_ADD_COMPLETED"] = "item_sharebox_add_completed";
   PitcherEventName2["SYNC_BADGE_VALUE_REPORTED"] = "sync_badge_value_reported";
+  PitcherEventName2["PEER_CONNECTIVITY_EVENT"] = "peer_connectivity_event";
   return PitcherEventName2;
 })(PitcherEventName || {});
 var PitcherBroadcastedEventName = /* @__PURE__ */ ((PitcherBroadcastedEventName2) => {
@@ -2839,6 +2994,9 @@ function assert(exp, message) {
 const defaultSkipKeys = [
   "id__in",
   "tags__in",
+  "tags__not_in",
+  "template__id",
+  "template__id__in",
   "modified_at__gtr",
   "created_at__gtr",
   "end_at__lt",
@@ -3221,6 +3379,15 @@ function getTopPitcherWindow(current = window) {
 }
 
 const TRUNCATE_LENGTH_TRIGGER = 10;
+const RAW_PAYLOAD_METHODS = [
+  "crm_create",
+  "crm_upsert",
+  "crm_smart_query",
+  "crm_smart_object_metadata",
+  "crm_smart_object_validation_rules",
+  "crm_smart_upsert_objects",
+  "crm_smart_delete_objects"
+];
 function updateOnlineHandlersEnv(env) {
   env && setEnv(env);
 }
@@ -3286,7 +3453,8 @@ class LowLevelApi extends EventEmitter {
           throw new Error("unsupported response status");
         }
       };
-      const payload = cloneDeep(snakeCaseKeys(body));
+      const shouldSkipSnakeCase = type === "crm_create" || type === "crm_upsert" || type === "crm_smart_query" || type === "crm_smart_object_metadata" || type === "crm_smart_object_validation_rules" || type === "crm_smart_upsert_objects" || type === "crm_smart_delete_objects" || RAW_PAYLOAD_METHODS.includes(type);
+      const payload = shouldSkipSnakeCase ? cloneDeep(body) : cloneDeep(snakeCaseKeys(body));
       this.callbacks[id] = {
         dispatched_at: Date.now(),
         type,
@@ -4031,6 +4199,179 @@ const dsr = {
   ...filesDsr
 };
 
+const PEER_CONNECTIVITY_EVENT = "peer_connectivity_event";
+const PeerConnectivityActions = {
+  CANVAS_PAGE_NEXT: "canvas.navigate.next",
+  CANVAS_PAGE_PREVIOUS: "canvas.navigate.previous",
+  CANVAS_OPEN: "canvas.open",
+  CANVAS_CLOSE: "canvas.close",
+  ROUTE_CHANGE: "route.change",
+  FILE_OPEN: "file.open",
+  FILE_CLOSE: "file.close",
+  BROWSER_FOLDER_OPEN: "browser.folder.open"
+};
+const DEFAULT_PEER_CONNECTIVITY_VERSION = 1;
+const PEER_CONNECTIVITY_HANDLER_MATCH_ALL = "*";
+
+const handlers = /* @__PURE__ */ new Map();
+let unsubscribeNativeListener = null;
+let peerConnectivitySupportPromise = null;
+function generateCorrelationId() {
+  const cryptoApi = globalThis.crypto;
+  if (cryptoApi?.randomUUID) {
+    return cryptoApi.randomUUID();
+  }
+  return `peer-${Date.now().toString(16)}-${Math.random().toString(16).slice(2)}`;
+}
+function normalizeEventPayload(payload, defaults) {
+  const metadata = payload.metadata ?? {};
+  const normalized = {
+    version: payload.version ?? defaults?.version ?? DEFAULT_PEER_CONNECTIVITY_VERSION,
+    action: payload.action,
+    context: payload.context ?? defaults?.context,
+    data: payload.data ?? defaults?.data,
+    metadata: {
+      correlationId: metadata.correlationId ?? defaults?.metadata?.correlationId ?? generateCorrelationId(),
+      source: metadata.source ?? defaults?.metadata?.source ?? "web",
+      timestamp: metadata.timestamp ?? defaults?.metadata?.timestamp ?? Date.now(),
+      extras: {
+        ...defaults?.metadata?.extras ?? {},
+        ...metadata.extras ?? {}
+      }
+    }
+  };
+  return normalized;
+}
+function addHandler(action, handler) {
+  const key = action || PEER_CONNECTIVITY_HANDLER_MATCH_ALL;
+  const handlerSet = handlers.get(key) ?? /* @__PURE__ */ new Set();
+  handlerSet.add(handler);
+  handlers.set(key, handlerSet);
+}
+function removeHandler(action, handler) {
+  const handlerSet = handlers.get(action);
+  if (!handlerSet) {
+    return;
+  }
+  handlerSet.delete(handler);
+  if (!handlerSet.size) {
+    handlers.delete(action);
+  }
+  if (!handlers.size) {
+    teardownNativeListener();
+  }
+}
+async function ensureNativeListener() {
+  if (unsubscribeNativeListener) {
+    return;
+  }
+  const api = usePitcherApi();
+  const listener = (event) => {
+    try {
+      const normalized = normalizeEventPayload(event, {
+        metadata: {
+          correlationId: generateCorrelationId(),
+          source: "native",
+          timestamp: Date.now(),
+          extras: {}
+        }
+      });
+      dispatchEvent(normalized);
+    } catch (error) {
+      console.error("[peer-connectivity] Failed to handle native event:", error);
+    }
+  };
+  api.on(PitcherEventName.PEER_CONNECTIVITY_EVENT, listener);
+  unsubscribeNativeListener = () => {
+    api.off(PitcherEventName.PEER_CONNECTIVITY_EVENT, listener);
+    unsubscribeNativeListener = null;
+  };
+}
+function teardownNativeListener() {
+  if (unsubscribeNativeListener) {
+    unsubscribeNativeListener();
+    unsubscribeNativeListener = null;
+  }
+}
+function dispatchEvent(event) {
+  const specificHandlers = handlers.get(event.action);
+  const wildcardHandlers = handlers.get(PEER_CONNECTIVITY_HANDLER_MATCH_ALL);
+  if (!specificHandlers && !wildcardHandlers) {
+    return;
+  }
+  const payload = Object.freeze(event);
+  specificHandlers?.forEach((handler) => {
+    try {
+      handler(payload);
+    } catch (error) {
+      console.error(`[peer-connectivity] Handler error for action "${event.action}":`, error);
+    }
+  });
+  wildcardHandlers?.forEach((handler) => {
+    try {
+      handler(payload);
+    } catch (error) {
+      console.error("[peer-connectivity] Handler error for wildcard action:", error);
+    }
+  });
+}
+async function isPeerConnectivitySupported() {
+  if (!peerConnectivitySupportPromise) {
+    const api = usePitcherApi();
+    peerConnectivitySupportPromise = api.getEnv().then((env) => env.mode === "IOS").catch((error) => {
+      console.error("[peer-connectivity] Failed to determine environment support:", error);
+      return false;
+    });
+  }
+  return peerConnectivitySupportPromise;
+}
+function normalizeActions(actionOrActions) {
+  return Array.isArray(actionOrActions) ? actionOrActions : [actionOrActions];
+}
+function registerPeerConnectivityHandler(actionOrActions, handler) {
+  normalizeActions(actionOrActions).forEach((action) => {
+    addHandler(action, handler);
+  });
+  ensureNativeListener().catch((error) => {
+    console.error("[peer-connectivity] Failed to register native listener:", error);
+  });
+  return () => {
+    normalizeActions(actionOrActions).forEach((action) => {
+      removeHandler(action, handler);
+    });
+  };
+}
+async function sendPeerConnectivityEvent(payload, options) {
+  if (!payload?.action) {
+    console.warn("[peer-connectivity] Attempted to send an event without action");
+    return;
+  }
+  if (options?.isFeatureEnabled === false) {
+    return;
+  }
+  const isSupported = await isPeerConnectivitySupported();
+  if (!isSupported) {
+    return;
+  }
+  const api = usePitcherApi();
+  const normalizedPayload = normalizeEventPayload(payload, {
+    metadata: {
+      correlationId: generateCorrelationId(),
+      source: "web",
+      timestamp: Date.now(),
+      extras: {}
+    }
+  });
+  try {
+    await api.broadcast({
+      type: PitcherEventName.PEER_CONNECTIVITY_EVENT,
+      body: normalizedPayload
+    });
+  } catch (error) {
+    console.error("[peer-connectivity] Failed to send event:", error);
+  }
+}
+
 let highLevelApi;
 let prevOptions;
 function usePitcherApi(options) {
@@ -4087,5 +4428,5 @@ function useApi(options) {
 
 window.postRobot = pr;
 
-export { ADMIN_API_METHOD_TYPES, ADMIN_API_TYPES, ADMIN_MESSAGE, ADMIN_MESSAGE_TYPES, DSR_API_METHOD_TYPES, DSR_API_TYPES, DSR_MESSAGE, DSR_MESSAGE_TYPES, PITCHER_EVENT, PitcherBroadcastedEventName, PitcherEventName, PitcherExternalEventName, PitcherMessageType, PitcherResponseStatus, UI_API_METHOD_TYPES, UI_MESSAGE, UI_MESSAGE_TYPES, UI_NATIVE_MESSAGE_TYPES, getAvailableApis, highLevelApi, useAdmin, useApi, useDsr, usePitcherApi, useUi };
+export { ADMIN_API_METHOD_TYPES, ADMIN_API_TYPES, ADMIN_MESSAGE, ADMIN_MESSAGE_TYPES, DEFAULT_PEER_CONNECTIVITY_VERSION, DSR_API_METHOD_TYPES, DSR_API_TYPES, DSR_MESSAGE, DSR_MESSAGE_TYPES, PEER_CONNECTIVITY_EVENT, PEER_CONNECTIVITY_HANDLER_MATCH_ALL, PITCHER_EVENT, PeerConnectivityActions, PitcherBroadcastedEventName, PitcherEventName, PitcherExternalEventName, PitcherMessageType, PitcherResponseStatus, UI_API_METHOD_TYPES, UI_MESSAGE, UI_MESSAGE_TYPES, UI_NATIVE_MESSAGE_TYPES, getAvailableApis, highLevelApi, registerPeerConnectivityHandler, sendPeerConnectivityEvent, useAdmin, useApi, useDsr, usePitcherApi, useUi };
 //# sourceMappingURL=js-api.esm.js.map