@plasmicapp/data-sources 1.0.6 → 1.0.8

package/dist/index.d.ts

@@ -3,6 +3,19 @@ import { PlasmicDataSourceContextValue } from '@plasmicapp/data-sources-context'
 import { default as React_2 } from 'react';
 import { usePlasmicDataConfig } from '@plasmicapp/query';
 
+declare interface $StateSpec<T = any> {
+    path: string;
+    initFunc?: (env: QueryExecutionContext & {
+        /** @deprecated This field is here to conform to react-web's $StateSpec. */
+        $queries: Record<string, any>;
+        /** @deprecated This field is here to conform to react-web's $StateSpec. */
+        $refs: Record<string, any>;
+    }) => T;
+    initVal?: T;
+    type: "private" | "readonly" | "writable";
+    valueProp?: string;
+}
+
 /** @deprecated See https://docs.plasmic.app/learn/integrations */
 export declare type BaseFieldConfig = {
     key?: string;
@@ -93,6 +106,12 @@ declare interface ExecutePlasmicQueriesResult {
     queries: Record<string, PlasmicQueryResult>;
 }
 
+/** @deprecated no-op function for compatibility only */
+export declare function executeServerQuery<F extends (...args: any[]) => any>(_query?: any): Promise<{
+    data: ReturnType<F>;
+    isLoading: boolean;
+}>;
+
 /** @deprecated See https://docs.plasmic.app/learn/integrations */
 export declare function Fetcher(props: FetcherProps): React_2.ReactElement | null;
 
@@ -139,9 +158,9 @@ export declare interface Pagination {
 }
 
 /** @internal */
-export declare interface PlasmicQuery<F extends (...args: unknown[]) => Promise<unknown> = (...args: unknown[]) => Promise<unknown>> {
+export declare interface PlasmicQuery<F extends (...args: any[]) => Promise<unknown> = (...args: any[]) => Promise<unknown>> {
     fn: F;
-    execParams: () => Parameters<F>;
+    args: ContextFn<Parameters<F>>;
     id: string;
 }
 
@@ -176,8 +195,12 @@ declare interface QueryCodeComponentNode {
 /** @internal */
 export declare interface QueryComponentNode {
     type: "component";
-    queries: Record<string, SerializedServerQuery>;
+    queries: Record<string, PlasmicQuery>;
     propsContext: Record<string, ContextFn<unknown>>;
+    /**
+     * Lazily initializes $state proxy for this component.
+     */
+    stateSpecs: $StateSpec[];
     children: QueryNode[];
 }
 
@@ -189,16 +212,22 @@ declare interface QueryDataProviderNode {
     children: QueryNode[];
 }
 
-export declare interface QueryExecutionContext {
-    $props: Record<string, unknown>;
+/**
+ * Context during execution.
+ * @internal
+ */
+export declare type QueryExecutionContext = {
     $ctx: Record<string, unknown>;
+    $props: Record<string, unknown>;
     $state: Record<string, unknown>;
     $q: Record<string, PlasmicQueryResult>;
-    $scopedItemVars: Record<string, unknown>;
-}
+};
 
-/** @internal */
-declare type QueryExecutionInitialContext = Pick<QueryExecutionContext, "$props" | "$ctx">;
+/**
+ * Initial context just before execution.
+ * @internal
+ */
+declare type QueryExecutionInitialContext = Pick<QueryExecutionContext, "$ctx" | "$props">;
 
 /** @internal */
 declare type QueryNode = QueryComponentNode | QueryCodeComponentNode | QueryRepeatedNode | QueryDataProviderNode | QueryVisibilityNode;
@@ -227,14 +256,12 @@ declare interface QueryVisibilityNode {
 
 declare type ResolvableDataOp = DataOp | undefined | null | (() => DataOp | undefined | null);
 
-declare interface SerializedServerQuery {
-    id: string;
-    fn: (...args: unknown[]) => Promise<unknown>;
-    args: ContextFn<unknown[]>;
-}
-
 declare type SerializedServerRenderingConfig = boolean;
 
+/**
+ * Wraps a Promise so that it can be easily resolved/rejected
+ * outside the executor param of the Promise constructor.
+ */
 declare class SettablePromise<T> {
     readonly promise: Promise<T>;
     private _resolve;
@@ -262,11 +289,6 @@ export declare class _StatefulQueryResult<T = unknown> implements PlasmicQueryRe
     private notifyListeners;
     reset(): void;
     loadingPromise(key: string, promise: Promise<T>): void;
-    /**
-     * Resolve is allowed if:
-     * 1) no key / state is initial, which means we are resolving from cache
-     * 2) key / state is loading, which means we need to check the keys match
-     */
     resolvePromise(key: string, data: T): void;
     /**
      * Reject is allowed if:
@@ -274,6 +296,7 @@ export declare class _StatefulQueryResult<T = unknown> implements PlasmicQueryRe
      * 2) key / state is loading, which means we need to check the keys match
      */
     rejectPromise(key: string | null, error: unknown): void;
+    toJSON(): _StatefulQueryState<T>;
     get key(): string | null;
     get data(): T;
     get isLoading(): boolean;
@@ -358,11 +381,11 @@ export declare function unstable_executePlasmicQueries(rootNode: QueryComponentN
  * };
  *
  * export function ClientComponent($props, $ctx) {
- *   const $q = usePlasmicQueries(serverQueryTree, $props, $ctx);
+ *   const $q = usePlasmicQueries(serverQueryTree, $ctx, $props, null);
  *   return <div>{$q.films.data}</div>
  * }
  */
-export declare function unstable_usePlasmicQueries(tree: QueryComponentNode, $props: Record<string, unknown>, $ctx: Record<string, unknown>, $state?: Record<string, unknown>): Record<string, PlasmicQueryResult>;
+export declare function unstable_usePlasmicQueries(tree: QueryComponentNode, $ctx: QueryExecutionContext["$ctx"], $props: QueryExecutionContext["$props"], $state: QueryExecutionContext["$state"] | null): Record<string, PlasmicQueryResult>;
 
 /**
  * @internal