@plasmicapp/data-sources 1.0.16 → 1.0.17

package/dist/index.d.ts

@@ -22,6 +22,14 @@ export declare type BaseFieldConfig = {
     fieldId?: string;
 };
 
+/**
+ * Initial context just before execution.
+ * @internal
+ */
+declare type ClientQueryExecutionContext = Pick<QueryExecutionContext, "$ctx" | "$props"> & {
+    $state: QueryExecutionContext["$state"] | null;
+};
+
 /**
  * Represents the result of a client-side query.
  * @deprecated See https://docs.plasmic.app/learn/integrations
@@ -99,6 +107,16 @@ declare interface ExecuteOpts {
 /** @deprecated See https://docs.plasmic.app/learn/integrations */
 export declare function executePlasmicDataOp<T extends SingleRowResult | ManyRowsResult>(op: DataOp, opts?: ExecuteOpts): Promise<T>;
 
+/**
+ * Executes all queries from a serialized component tree and returns query results.
+ *
+ * 1. Walk the tree to discover queries, creating StatefulQueryResult + PlasmicQuery
+ * 2. Execute all newly discovered queries in parallel
+ * 3. After all settle, re-walk. Discover queries from newly expanded repeated nodes
+ * Continue until no new queries found.
+ */
+export declare function executePlasmicQueries(rootNode: QueryComponentNode, env: InitialQueryExecutionContext): Promise<ExecutePlasmicQueriesResult>;
+
 declare interface ExecutePlasmicQueriesResult {
     /** All queries, including nested, by query cache key hash. Passed to PlasmicRootProvider */
     cache: Record<string, unknown>;
@@ -125,6 +143,12 @@ export declare interface FetcherProps extends DataOpConfig {
     queries?: Record<string, any>;
 }
 
+/**
+ * Initial context just before execution.
+ * @internal
+ */
+declare type InitialQueryExecutionContext = Pick<QueryExecutionContext, "$ctx" | "$props">;
+
 export declare function isPlasmicUndefinedDataErrorPromise(x: any): x is PlasmicUndefinedDataErrorPromise;
 
 /** @deprecated See https://docs.plasmic.app/learn/integrations */
@@ -236,12 +260,6 @@ export declare type QueryExecutionContext = {
     $q: Record<string, PlasmicQueryResult>;
 };
 
-/**
- * Initial context just before execution.
- * @internal
- */
-declare type QueryExecutionInitialContext = Pick<QueryExecutionContext, "$ctx" | "$props">;
-
 /** @internal */
 declare type QueryNode = QueryComponentNode | QueryCodeComponentNode | QueryRepeatedNode | QueryDataProviderNode | QueryVisibilityNode;
 
@@ -372,15 +390,25 @@ export declare interface TableSchema {
 
 export declare function throwIfPlasmicUndefinedDataError(err: unknown): void;
 
+/** @deprecated See https://docs.plasmic.app/learn/integrations */
+export declare function useNormalizedData(rawData: unknown): NormalizedData | undefined;
+
+export { usePlasmicDataConfig }
+
+/** @deprecated See https://docs.plasmic.app/learn/integrations */
+export declare function usePlasmicDataMutationOp<T extends SingleRowResult | ManyRowsResult>(dataOp: ResolvableDataOp): () => Promise<T | undefined>;
+
+/** @deprecated See https://docs.plasmic.app/learn/integrations */
+export declare function usePlasmicDataOp<T extends SingleRowResult | ManyRowsResult, E = any>(dataOp: ResolvableDataOp, opts?: {
+    paginate?: Pagination;
+    noUndefinedDataProxy?: boolean;
+}): ClientQueryResult<T["data"]>;
+
 /**
- * Executes all queries from a serialized component tree and returns query results.
- *
- * 1. Walk the tree to discover queries, creating StatefulQueryResult + PlasmicQuery
- * 2. Execute all newly discovered queries in parallel
- * 3. After all settle, re-walk. Discover queries from newly expanded repeated nodes
- * Continue until no new queries found.
+ * Returns a function that invalidates cached query data. Accepts a list of invalidation keys
+ * or `plasmic_refresh_all` to invalidate everything.
  */
-export declare function unstable_executePlasmicQueries(rootNode: QueryComponentNode, options: QueryExecutionInitialContext): Promise<ExecutePlasmicQueriesResult>;
+export declare function usePlasmicInvalidate(): (invalidatedKeys: string[] | null | undefined) => Promise<any[] | undefined>;
 
 /**
  * @internal
@@ -394,7 +422,7 @@ export declare function unstable_executePlasmicQueries(rootNode: QueryComponentN
  *
  * Example codegen:
  *
- * export const serverQueryTree = {
+ * export const queryTree = {
  *   type: "component",
  *   queries: {
  *     films: { fn: $$.fetch, id: "fetch", args: ({ $q, $props, $ctx }) => [...] }
@@ -403,37 +431,17 @@ export declare function unstable_executePlasmicQueries(rootNode: QueryComponentN
  * };
  *
  * export function ClientComponent($props, $ctx) {
- *   const $q = usePlasmicQueries(serverQueryTree, $ctx, $props, null);
+ *   const $q = usePlasmicQueries(queryTree, { $ctx, $props, $state: null });
  *   return <div>{$q.films.data}</div>
  * }
  */
-export declare function unstable_usePlasmicQueries(tree: QueryComponentNode, $ctx: QueryExecutionContext["$ctx"], $props: QueryExecutionContext["$props"], $state: QueryExecutionContext["$state"] | null): Record<string, PlasmicQueryResult>;
+export declare function usePlasmicQueries(tree: QueryComponentNode, env: ClientQueryExecutionContext): Record<string, PlasmicQueryResult>;
 
 /**
  * @internal
  * Wraps each PlasmicQueryResult so that they return a hardcoded string for
  * undefined/loading and error cases.
  */
-export declare function unstable_wrapDollarQueriesForMetadata<T extends Record<string, PlasmicQueryResult>>($queries: T, ifUndefined?: (promise: PlasmicUndefinedDataErrorPromise) => unknown, ifError?: (err: unknown) => unknown): T;
-
-/** @deprecated See https://docs.plasmic.app/learn/integrations */
-export declare function useNormalizedData(rawData: unknown): NormalizedData | undefined;
-
-export { usePlasmicDataConfig }
-
-/** @deprecated See https://docs.plasmic.app/learn/integrations */
-export declare function usePlasmicDataMutationOp<T extends SingleRowResult | ManyRowsResult>(dataOp: ResolvableDataOp): () => Promise<T | undefined>;
-
-/** @deprecated See https://docs.plasmic.app/learn/integrations */
-export declare function usePlasmicDataOp<T extends SingleRowResult | ManyRowsResult, E = any>(dataOp: ResolvableDataOp, opts?: {
-    paginate?: Pagination;
-    noUndefinedDataProxy?: boolean;
-}): ClientQueryResult<T["data"]>;
-
-/**
- * Returns a function that invalidates cached query data. Accepts a list of invalidation keys
- * or `plasmic_refresh_all` to invalidate everything.
- */
-export declare function usePlasmicInvalidate(): (invalidatedKeys: string[] | null | undefined) => Promise<any[] | undefined>;
+export declare function wrapPlasmicQueriesForMetadata<T extends Record<string, PlasmicQueryResult>>(queries: T, ifUndefined?: (promise: PlasmicUndefinedDataErrorPromise) => unknown, ifError?: (err: unknown) => unknown): T;
 
 export { }

package/dist/index.esm.js

@@ -231,7 +231,6 @@ import {
 import * as React2 from "react";
 
 // src/executor.tsx
-import fetch from "@plasmicapp/isomorphic-unfetch";
 import { wrapLoadingFetcher } from "@plasmicapp/query";
 import stringify from "fast-stringify";
 
@@ -718,17 +717,17 @@ function resolveParams(queryId, params) {
     })
   );
 }
-function wrapDollarQueriesForMetadata($queries, ifUndefined, ifError) {
-  return wrapDollarQueriesWithFallbacks(
-    $queries,
+function wrapPlasmicQueriesForMetadata(queries, ifUndefined, ifError) {
+  return wrapPlasmicQueriesWithFallbacks(
+    queries,
     ifUndefined != null ? ifUndefined : (() => "\u2026"),
     ifError != null ? ifError : (() => "[ERROR]")
   );
 }
-function wrapDollarQueriesWithFallbacks($queries, ifUndefined, ifError) {
+function wrapPlasmicQueriesWithFallbacks(queries, ifUndefined, ifError) {
   return mapRecords(
     (_queryName, $query) => new FallbackQueryResult($query, ifUndefined, ifError),
-    $queries
+    queries
   );
 }
 var FallbackQueryResult = class {
@@ -854,14 +853,16 @@ function createInitial$State($ctx, $props, $q, stateSpecs) {
 
 // src/serverQueries/client.ts
 var GLOBAL_CACHE = /* @__PURE__ */ new Map();
-function usePlasmicQueries(tree, $ctx, $props, $state) {
+function usePlasmicQueries(tree, env) {
   var _a;
+  const { $ctx, $props } = env;
   const wrappedQueries = React4.useMemo(() => wrapQueries(tree.queries), [tree]);
   const $queries = React4.useMemo(
     () => createDollarQueries(Object.keys(tree.queries)),
     [tree]
   );
   const $queryStates = $queries;
+  let $state = env.$state;
   if (!$state) {
     $state = createInitial$State($ctx, $props, $queryStates, tree.stateSpecs);
   }
@@ -1101,8 +1102,8 @@ var ROOT_COMPONENT_KEY_PATH = "root";
 function appendKeyPath(currentKeyPath, currentInput) {
   return currentKeyPath ? `${currentKeyPath}/${currentInput}` : currentInput;
 }
-function executeQueryTree(rootNode, options, queriesByComponent) {
-  const { $props, $ctx } = options;
+function executeQueryTree(rootNode, env, queriesByComponent) {
+  const { $props, $ctx } = env;
   const initialContext = {
     $props,
     $ctx,
@@ -1300,12 +1301,12 @@ function executeRepeatedNode(node, params) {
     );
   });
 }
-function executePlasmicQueries(rootNode, options) {
+function executePlasmicQueries(rootNode, env) {
   return __async(this, null, function* () {
     const queriesByComponent = /* @__PURE__ */ new Map();
     const discoveredQueries = [];
     while (true) {
-      const newQueries = executeQueryTree(rootNode, options, queriesByComponent);
+      const newQueries = executeQueryTree(rootNode, env, queriesByComponent);
       if (newQueries.length === 0) {
         break;
       }
@@ -1549,6 +1550,7 @@ export {
   safeExecResult as _safeExecResult,
   deriveFieldConfigs,
   executePlasmicDataOp,
+  executePlasmicQueries,
   executeServerQuery,
   isPlasmicUndefinedDataErrorPromise,
   makeCacheKey,
@@ -1556,13 +1558,12 @@ export {
   matchesQueryCacheKey,
   normalizeData,
   throwIfPlasmicUndefinedDataError,
-  executePlasmicQueries as unstable_executePlasmicQueries,
-  usePlasmicQueries as unstable_usePlasmicQueries,
-  wrapDollarQueriesForMetadata as unstable_wrapDollarQueriesForMetadata,
   useNormalizedData,
   usePlasmicDataConfig4 as usePlasmicDataConfig,
   usePlasmicDataMutationOp,
   usePlasmicDataOp,
-  usePlasmicInvalidate
+  usePlasmicInvalidate,
+  usePlasmicQueries,
+  wrapPlasmicQueriesForMetadata
 };
 //# sourceMappingURL=index.esm.js.map