@osdk/react 0.10.0-beta.4 → 0.10.0-beta.6

package/build/cjs/public/experimental.cjs

@@ -71,6 +71,60 @@ function makeExternalStore(createObservation, _name, initialValue) {
     getSnapShot
   };
 }
+function makeExternalStoreAsync(createObservation, _name, initialValue) {
+  let lastResult = initialValue;
+  function getSnapShot() {
+    return lastResult;
+  }
+  function subscribe(notifyUpdate) {
+    let isActive = true;
+    let currentSubscription;
+    const subscriptionPromise = createObservation({
+      next: (payload) => {
+        if (isActive) {
+          lastResult = payload;
+          notifyUpdate();
+        }
+      },
+      error: (error) => {
+        if (isActive) {
+          lastResult = {
+            ...lastResult ?? {},
+            error: error instanceof Error ? error : new Error(String(error))
+          };
+          notifyUpdate();
+        }
+      },
+      complete: () => {
+      }
+    });
+    subscriptionPromise.then((sub) => {
+      if (isActive) {
+        currentSubscription = sub;
+      } else {
+        sub.unsubscribe();
+      }
+    }).catch((error) => {
+      if (isActive) {
+        lastResult = {
+          ...lastResult ?? {},
+          error: error instanceof Error ? error : new Error(String(error))
+        };
+        notifyUpdate();
+      }
+    });
+    return () => {
+      isActive = false;
+      if (currentSubscription) {
+        currentSubscription.unsubscribe();
+      }
+    };
+  }
+  return {
+    subscribe,
+    getSnapShot
+  };
+}
 
 // src/utils/usePlatformQuery.ts
 function usePlatformQuery({
@@ -242,15 +296,16 @@ function useLinks(objects, linkName, options = {}) {
     }, observer));
   }, [enabled, observableClient, objectsArray, objectsKey, linkName, stableWhere, otherOptions.pageSize, stableOrderBy, otherOptions.mode, otherOptions.dedupeIntervalMs]);
   const payload = React9__default.default.useSyncExternalStore(subscribe, getSnapShot);
-  return {
+  return React9__default.default.useMemo(() => ({
     links: payload?.resolvedList,
     isLoading: enabled ? payload?.status === "loading" || payload?.status === "init" || !payload : false,
     isOptimistic: payload?.isOptimistic ?? false,
     error: payload?.error,
     fetchMore: payload?.hasMore ? payload?.fetchMore : void 0,
     hasMore: payload?.hasMore ?? false
-  };
+  }), [payload, enabled]);
 }
+var OBJECT_TYPE_PLACEHOLDER = "$__OBJECT__TYPE__PLACEHOLDER";
 function useObjectSet(baseObjectSet, options = {}) {
   const {
     observableClient
@@ -260,7 +315,7 @@ function useObjectSet(baseObjectSet, options = {}) {
     streamUpdates,
     ...otherOptions
   } = options;
-  const objectTypeKey = baseObjectSet.$objectSetInternals.def.apiName;
+  const objectTypeKey = enabled ? baseObjectSet.$objectSetInternals.def.apiName : OBJECT_TYPE_PLACEHOLDER;
   const previousObjectTypeRef = React9__default.default.useRef(objectTypeKey);
   const previousPayloadRef = React9__default.default.useRef();
   const objectTypeChanged = previousObjectTypeRef.current !== objectTypeKey;
@@ -311,14 +366,14 @@ function useObjectSet(baseObjectSet, options = {}) {
       previousPayloadRef.current = payload;
     }
   }, [payload]);
-  return {
+  return React9__default.default.useMemo(() => ({
     data: payload?.resolvedList,
     isLoading: payload?.status === "loading" || !payload && true || false,
     error: payload && "error" in payload ? payload.error : void 0,
     fetchMore: payload?.hasMore ? payload.fetchMore : void 0,
     objectSet: payload?.objectSet || baseObjectSet,
     totalCount: payload?.totalCount
-  };
+  }), [payload, baseObjectSet]);
 }
 function useOsdkAction(actionDef) {
   const {
@@ -427,7 +482,7 @@ function useOsdkAction(actionDef) {
       }
     };
   }, []);
-  return {
+  return React9__default.default.useMemo(() => ({
     applyAction,
     validateAction,
     error,
@@ -435,48 +490,74 @@ function useOsdkAction(actionDef) {
     isPending,
     isValidating,
     validationResult
-  };
+  }), [applyAction, validateAction, error, data, isPending, isValidating, validationResult]);
 }
 var EMPTY_WHERE = {};
-function useOsdkAggregation(type, {
-  where = EMPTY_WHERE,
-  withProperties,
-  aggregate,
-  dedupeIntervalMs
-}) {
+function useOsdkAggregation(type, options) {
+  const {
+    where = EMPTY_WHERE,
+    withProperties,
+    intersectWith,
+    aggregate,
+    dedupeIntervalMs
+  } = options;
+  const objectSet = "objectSet" in options ? options.objectSet : void 0;
   const {
     observableClient
   } = React9__default.default.useContext(OsdkContext2);
-  const canonWhere = observableClient.canonicalizeWhereClause(where ?? EMPTY_WHERE);
+  const canonWhere = observableClient.canonicalizeWhereClause(where);
   const stableCanonWhere = React9__default.default.useMemo(() => canonWhere, [JSON.stringify(canonWhere)]);
+  const objectSetRef = React9__default.default.useRef(objectSet);
+  objectSetRef.current = objectSet;
+  const objectSetKeyString = objectSet ? unstableDoNotUse.computeObjectSetCacheKey(objectSet) : void 0;
   const stableWithProperties = React9__default.default.useMemo(() => withProperties, [JSON.stringify(withProperties)]);
   const stableAggregate = React9__default.default.useMemo(() => aggregate, [JSON.stringify(aggregate)]);
+  const stableIntersectWith = React9__default.default.useMemo(() => intersectWith, [JSON.stringify(intersectWith)]);
   const {
     subscribe,
     getSnapShot
-  } = React9__default.default.useMemo(() => makeExternalStore((observer) => observableClient.observeAggregation({
-    type,
-    where: stableCanonWhere,
-    withProperties: stableWithProperties,
-    aggregate: stableAggregate,
-    dedupeInterval: dedupeIntervalMs ?? 2e3
-  }, observer), process.env.NODE_ENV !== "production" ? `aggregation ${type.apiName} ${JSON.stringify(stableCanonWhere)}` : void 0), [observableClient, type.apiName, type.type, stableCanonWhere, stableWithProperties, stableAggregate, dedupeIntervalMs]);
+  } = React9__default.default.useMemo(() => {
+    if (objectSetKeyString && objectSetRef.current) {
+      return makeExternalStoreAsync((observer) => observableClient.observeAggregation({
+        type,
+        objectSet: objectSetRef.current,
+        where: stableCanonWhere,
+        withProperties: stableWithProperties,
+        intersectWith: stableIntersectWith,
+        aggregate: stableAggregate,
+        dedupeInterval: dedupeIntervalMs ?? 2e3
+      }, observer), process.env.NODE_ENV !== "production" ? `aggregation ${type.apiName} ${objectSetKeyString} ${JSON.stringify(stableCanonWhere)}` : void 0);
+    }
+    return makeExternalStore((observer) => (
+      // eslint-disable-next-line @typescript-eslint/no-deprecated
+      observableClient.observeAggregation({
+        type,
+        where: stableCanonWhere,
+        withProperties: stableWithProperties,
+        intersectWith: stableIntersectWith,
+        aggregate: stableAggregate,
+        dedupeInterval: dedupeIntervalMs ?? 2e3
+      }, observer)
+    ), process.env.NODE_ENV !== "production" ? `aggregation ${type.apiName} ${JSON.stringify(stableCanonWhere)}` : void 0);
+  }, [observableClient, type.apiName, type.type, objectSetKeyString, stableCanonWhere, stableWithProperties, stableIntersectWith, stableAggregate, dedupeIntervalMs]);
   const payload = React9__default.default.useSyncExternalStore(subscribe, getSnapShot);
-  let error;
-  if (payload && "error" in payload && payload.error) {
-    error = payload.error;
-  } else if (payload?.status === "error") {
-    error = new Error("Failed to execute aggregation");
-  }
   const refetch = React9__default.default.useCallback(async () => {
     await observableClient.invalidateObjectType(type.apiName);
   }, [observableClient, type.apiName]);
-  return {
-    data: payload?.result,
-    isLoading: payload?.status === "loading" || payload?.status === "init" || !payload,
-    error,
-    refetch
-  };
+  return React9__default.default.useMemo(() => {
+    let error;
+    if (payload && "error" in payload && payload.error) {
+      error = payload.error;
+    } else if (payload?.status === "error") {
+      error = new Error("Failed to execute aggregation");
+    }
+    return {
+      data: payload?.result,
+      isLoading: payload?.status === "loading" || payload?.status === "init" || !payload,
+      error,
+      refetch
+    };
+  }, [payload, refetch]);
 }
 function useOsdkFunction(queryDef, options = {}) {
   const {
@@ -515,17 +596,19 @@ function useOsdkFunction(queryDef, options = {}) {
     }, observer), process.env.NODE_ENV !== "production" ? `function ${queryDef.apiName} ${JSON.stringify(stableParams)}` : void 0);
   }, [observableClient, queryDef.apiName, queryDef.version, paramsForApi, stableDependsOn, stableDependsOnObjects, dedupeIntervalMs, enabled]);
   const payload = React9__default.default.useSyncExternalStore(subscribe, getSnapShot);
-  const error = payload?.error ?? (payload?.status === "error" ? new Error("Failed to execute function") : void 0);
   const refetch = React9__default.default.useCallback(() => {
     void observableClient.invalidateFunction(queryDef, paramsForApi);
   }, [observableClient, queryDef, paramsForApi]);
-  return {
-    data: payload?.result,
-    isLoading: payload?.status === "loading",
-    error,
-    lastUpdated: payload?.lastUpdated ?? 0,
-    refetch
-  };
+  return React9__default.default.useMemo(() => {
+    const error = payload?.error ?? (payload?.status === "error" ? new Error("Failed to execute function") : void 0);
+    return {
+      data: payload?.result,
+      isLoading: payload?.status === "loading",
+      error,
+      lastUpdated: payload?.lastUpdated ?? 0,
+      refetch
+    };
+  }, [payload, refetch]);
 }
 function useOsdkObject(...args) {
   const {
@@ -534,8 +617,9 @@ function useOsdkObject(...args) {
   const isInstanceSignature = "$objectType" in args[0];
   const enabled = isInstanceSignature ? typeof args[1] === "boolean" ? args[1] : true : typeof args[2] === "boolean" ? args[2] : true;
   const mode = isInstanceSignature ? "offline" : void 0;
-  const objectType = isInstanceSignature ? args[0].$objectType : args[0].apiName;
+  const typeOrApiName = isInstanceSignature ? args[0].$objectType : args[0];
   const primaryKey = isInstanceSignature ? args[0].$primaryKey : args[1];
+  const apiNameString = typeof typeOrApiName === "string" ? typeOrApiName : typeOrApiName.apiName;
   const {
     subscribe,
     getSnapShot
@@ -546,26 +630,29 @@ function useOsdkObject(...args) {
         }
       }));
     }
-    return makeExternalStore((observer) => observableClient.observeObject(objectType, primaryKey, {
+    return makeExternalStore((observer) => observableClient.observeObject(typeOrApiName, primaryKey, {
       mode
     }, observer));
-  }, [enabled, observableClient, objectType, primaryKey, mode]);
+  }, [enabled, observableClient, typeOrApiName, apiNameString, primaryKey, mode]);
   const payload = React9__default.default.useSyncExternalStore(subscribe, getSnapShot);
-  let error;
-  if (payload && "error" in payload && payload.error) {
-    error = payload.error;
-  } else if (payload?.status === "error") {
-    error = new Error("Failed to load object");
-  }
-  return {
-    object: payload?.object,
-    isLoading: enabled ? payload?.status === "loading" || payload?.status === "init" || !payload : false,
-    isOptimistic: !!payload?.isOptimistic,
-    error,
-    forceUpdate: () => {
-      throw new Error("not implemented");
+  const forceUpdate = React9__default.default.useCallback(() => {
+    throw new Error("not implemented");
+  }, []);
+  return React9__default.default.useMemo(() => {
+    let error;
+    if (payload && "error" in payload && payload.error) {
+      error = payload.error;
+    } else if (payload?.status === "error") {
+      error = new Error("Failed to load object");
     }
-  };
+    return {
+      object: payload?.object,
+      isLoading: enabled ? payload?.status === "loading" || payload?.status === "init" || !payload : false,
+      isOptimistic: !!payload?.isOptimistic,
+      error,
+      forceUpdate
+    };
+  }, [payload, enabled, forceUpdate]);
 }
 var EMPTY_WHERE2 = {};
 function useOsdkObjects(type, options) {
@@ -620,20 +707,22 @@ function useOsdkObjects(type, options) {
     }, observer), process.env.NODE_ENV !== "production" ? `list ${type.apiName} ${stableRids ? `[${stableRids.length} rids]` : ""} ${JSON.stringify(stableCanonWhere)}` : void 0);
   }, [enabled, observableClient, type.apiName, type.type, stableRids, stableCanonWhere, dedupeIntervalMs, pageSize, stableOrderBy, streamUpdates, stableWithProperties, autoFetchMore, stableIntersectWith, pivotTo]);
   const listPayload = React9__default.default.useSyncExternalStore(subscribe, getSnapShot);
-  let error;
-  if (listPayload && "error" in listPayload && listPayload.error) {
-    error = listPayload.error;
-  } else if (listPayload?.status === "error") {
-    error = new Error("Failed to load objects");
-  }
-  return {
-    fetchMore: listPayload?.hasMore ? listPayload.fetchMore : void 0,
-    error,
-    data: listPayload?.resolvedList,
-    isLoading: enabled ? listPayload?.status === "loading" || listPayload?.status === "init" || !listPayload : false,
-    isOptimistic: listPayload?.isOptimistic ?? false,
-    totalCount: listPayload?.totalCount
-  };
+  return React9__default.default.useMemo(() => {
+    let error;
+    if (listPayload && "error" in listPayload && listPayload.error) {
+      error = listPayload.error;
+    } else if (listPayload?.status === "error") {
+      error = new Error("Failed to load objects");
+    }
+    return {
+      fetchMore: listPayload?.hasMore ? listPayload.fetchMore : void 0,
+      error,
+      data: listPayload?.resolvedList,
+      isLoading: enabled ? listPayload?.status === "loading" || listPayload?.status === "init" || !listPayload : false,
+      isOptimistic: listPayload?.isOptimistic ?? false,
+      totalCount: listPayload?.totalCount
+    };
+  }, [listPayload, enabled]);
 }
 function useDebouncedCallback(callback, delay) {
   const timeoutRef = React9__default.default.useRef();