@plasmicapp/data-sources 0.1.208 → 1.0.0

package/dist/index.d.ts

@@ -4,6 +4,7 @@ import { default as React_2 } from 'react';
 import { SWRResponse } from '@plasmicapp/query';
 import { usePlasmicDataConfig } from '@plasmicapp/query';
 
+/** @deprecated See https://docs.plasmic.app/learn/integrations */
 export declare type BaseFieldConfig = {
     key?: string;
     fieldId?: string;
@@ -11,6 +12,7 @@ export declare type BaseFieldConfig = {
 
 /**
  * Represents the result of a client-side query.
+ * @deprecated See https://docs.plasmic.app/learn/integrations
  */
 export declare interface ClientQueryResult<T = any> {
     /**
@@ -42,6 +44,7 @@ export declare interface ClientQueryResult<T = any> {
     isLoading?: boolean;
 }
 
+/** @deprecated See https://docs.plasmic.app/learn/integrations */
 export declare interface DataOp {
     sourceId: string;
     opId: string;
@@ -51,22 +54,19 @@ export declare interface DataOp {
     roleId?: string | null;
 }
 
+/** @deprecated See https://docs.plasmic.app/learn/integrations */
 declare interface DataOpConfig {
     name?: string;
     pageIndex?: number;
     pageSize?: number;
 }
 
+/** @deprecated See https://docs.plasmic.app/learn/integrations */
 export declare interface DataSourceSchema {
     tables: TableSchema[];
 }
 
-declare interface DependencyAwareQueryConfig extends DataOpConfig {
-    $queries: Record<string, any>;
-    setDollarQueries: ($queries: Record<string, any>) => void;
-    getDataOp: () => DataOp;
-}
-
+/** @deprecated See https://docs.plasmic.app/learn/integrations */
 export declare function deriveFieldConfigs<T extends BaseFieldConfig>(specifiedFieldsPartial: Partial<T>[], schema: TableSchema | undefined, makeDefaultConfig: (field: TableFieldSchema | undefined) => T): {
     mergedFields: T[];
     minimalFullLengthFields: Partial<T>[];
@@ -78,26 +78,32 @@ declare interface ExecuteOpts {
     paginate?: Pagination;
 }
 
+/** @deprecated See https://docs.plasmic.app/learn/integrations */
 export declare function executePlasmicDataOp<T extends SingleRowResult | ManyRowsResult>(op: DataOp, opts?: ExecuteOpts): Promise<T>;
 
+/** @deprecated See https://docs.plasmic.app/learn/integrations */
 export declare function Fetcher(props: FetcherProps): React_2.ReactElement | null;
 
+/** @deprecated See https://docs.plasmic.app/learn/integrations */
 export declare const FetcherMeta: CodeComponentMeta<FetcherProps>;
 
+/** @deprecated See https://docs.plasmic.app/learn/integrations */
 export declare interface FetcherProps extends DataOpConfig {
     dataOp?: DataOp;
     children?: ($queries: Record<string, any>) => React_2.ReactElement | null;
     queries?: Record<string, any>;
 }
 
+/** @deprecated See https://docs.plasmic.app/learn/integrations */
 export declare function makeCacheKey(dataOp: DataOp, opts?: {
     paginate?: Pagination;
     userAuthToken?: string | null;
 }): string;
 
-/** Make a cache key for a query */
+/** @internal Make a cache key for a query */
 export declare function makeQueryCacheKey(id: string, params: any[]): string;
 
+/** @deprecated See https://docs.plasmic.app/learn/integrations */
 export declare interface ManyRowsResult<T = any> {
     data: T[];
     total?: number;
@@ -105,24 +111,29 @@ export declare interface ManyRowsResult<T = any> {
     paginate?: Pagination;
 }
 
+/** @deprecated See https://docs.plasmic.app/learn/integrations */
 export declare function normalizeData(rawData: unknown): NormalizedData | undefined;
 
+/** @deprecated See https://docs.plasmic.app/learn/integrations */
 export declare interface NormalizedData {
     data: Record<string, unknown>[];
     schema?: TableSchema;
 }
 
+/** @deprecated See https://docs.plasmic.app/learn/integrations */
 export declare interface Pagination {
     pageSize: number;
     pageIndex: number;
 }
 
+/** @internal */
 export declare interface PlasmicQuery<F extends (...args: unknown[]) => Promise<unknown> = (...args: unknown[]) => Promise<unknown>> {
     fn: F;
     execParams: () => Parameters<F>;
     id: string;
 }
 
+/** @internal */
 export declare interface PlasmicQueryResult<T = unknown> {
     /**
      * Returns the key if params have resolved.
@@ -142,6 +153,7 @@ declare interface PlasmicUndefinedDataErrorPromise extends Promise<any> {
     message: string;
 }
 
+/** @deprecated See https://docs.plasmic.app/learn/integrations */
 export declare type QueryResult = Partial<ManyRowsResult<any>> & {
     error?: any;
     isLoading?: boolean;
@@ -162,6 +174,7 @@ declare class SettablePromise<T> {
     reject(error: unknown): void;
 }
 
+/** @deprecated See https://docs.plasmic.app/learn/integrations */
 export declare interface SingleRowResult<T = any> {
     data: T;
     schema: TableSchema;
@@ -221,6 +234,7 @@ export declare type _StatefulQueryState<T = unknown> = {
 /** @internal */
 export declare type _StateListener<T = unknown> = (state: _StatefulQueryState<T>, prevState: _StatefulQueryState<T>) => void;
 
+/** @deprecated See https://docs.plasmic.app/learn/integrations */
 export declare interface TableFieldSchema {
     id: string;
     label?: string;
@@ -230,8 +244,10 @@ export declare interface TableFieldSchema {
     options?: string[];
 }
 
+/** @deprecated See https://docs.plasmic.app/learn/integrations */
 export declare type TableFieldType = "string" | "boolean" | "number" | "date" | "datetime" | "enum" | "json" | "unknown";
 
+/** @deprecated See https://docs.plasmic.app/learn/integrations */
 export declare interface TableSchema {
     id: string;
     schema?: string;
@@ -240,6 +256,7 @@ export declare interface TableSchema {
 }
 
 /**
+ * @internal
  * Creates a $queries variable that can be used before queries are completed.
  *
  * Each query gets a StatefulQueryResult which implements PlasmicQueryResult.
@@ -253,6 +270,7 @@ export declare interface TableSchema {
 export declare function unstable_createDollarQueries<QueryName extends string>(queryNames: QueryName[]): Record<QueryName, PlasmicQueryResult>;
 
 /**
+ * @internal
  * Executes all queries and returns the query data keyed by cache key.
  *
  * Example codegen:
@@ -296,6 +314,7 @@ export declare function unstable_executePlasmicQueries<QueryName extends string>
 }>;
 
 /**
+ * @internal
  * This hook's job is to execute queries and re-render when query state changes.
  * Data caching can be controlled via @plasmicapp/query.
  *
@@ -339,33 +358,34 @@ export declare function unstable_executePlasmicQueries<QueryName extends string>
 export declare function unstable_usePlasmicQueries<QueryName extends string>($queries: Record<QueryName, PlasmicQueryResult>, queries: Record<QueryName, PlasmicQuery>): Record<QueryName, ReturnType<typeof usePlasmicQuery>>;
 
 /**
+ * @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 Prefer using `usePlasmicDataOp` directly instead.
- */
-export declare function useDependencyAwareQuery({ $queries, getDataOp, setDollarQueries, name, pageIndex, pageSize, }: DependencyAwareQueryConfig): 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"]>;
 
-/**
- * Returns a function that can be used to invalidate Plasmic query groups.
- */
+/** @deprecated See https://docs.plasmic.app/learn/integrations */
 export declare function usePlasmicInvalidate(): (invalidatedKeys: string[] | null | undefined) => Promise<any[] | undefined>;
 
 /**
+ * @deprecated
+ * This export will be deleted before RSC release.
+ * TODO: Rename to usePlasmicQuery
+ * TODO: Reference $query directly.
  * TODO: Use paramsResult from usePlasmicQueries
  */
 declare function usePlasmicQuery<T, F extends (...args: any[]) => Promise<T>>($query: PlasmicQueryResult<T>, query: PlasmicQuery<F>, settledCount?: number): SWRResponse<T, unknown>;

package/dist/index.esm.js

@@ -49,13 +49,6 @@ import * as React3 from "react";
 // src/utils.ts
 function noopFn() {
 }
-function swallow(f) {
-  try {
-    return f();
-  } catch (e) {
-    return void 0;
-  }
-}
 function pick(obj, ...keys) {
   const res = {};
   for (const key of keys) {
@@ -1212,44 +1205,6 @@ function deriveFieldConfigs(specifiedFieldsPartial, schema, makeDefaultConfig) {
   ];
   return { mergedFields, minimalFullLengthFields };
 }
-
-// src/hooks/useDependencyAwareQuery.tsx
-import React6 from "react";
-function usePrevious(value) {
-  const prevValue = React6.useRef(void 0);
-  React6.useEffect(() => {
-    prevValue.current = value;
-    return () => {
-      prevValue.current = void 0;
-    };
-  });
-  return prevValue.current;
-}
-function useDependencyAwareQuery({
-  $queries,
-  getDataOp,
-  setDollarQueries,
-  name,
-  pageIndex,
-  pageSize
-}) {
-  const data = usePlasmicDataOp(swallow(getDataOp), __spreadValues({}, !!pageIndex && !!pageSize && {
-    paginate: { pageIndex, pageSize }
-  }));
-  const finalName = name != null ? name : "data";
-  const prevName = usePrevious(finalName);
-  React6.useEffect(() => {
-    if (!(finalName in $queries) || $queries[finalName] !== data) {
-      const $queries2 = __spreadProps(__spreadValues({}, $queries), {
-        [finalName]: data
-      });
-      if (prevName && finalName !== prevName && prevName in $queries) {
-        delete $queries2[prevName];
-      }
-      setDollarQueries($queries2);
-    }
-  }, [finalName, prevName, data, $queries, setDollarQueries]);
-}
 export {
   Fetcher,
   FetcherMeta,
@@ -1263,7 +1218,6 @@ export {
   executePlasmicQueries as unstable_executePlasmicQueries,
   usePlasmicQueries as unstable_usePlasmicQueries,
   wrapDollarQueriesForMetadata as unstable_wrapDollarQueriesForMetadata,
-  useDependencyAwareQuery,
   useNormalizedData,
   usePlasmicDataConfig4 as usePlasmicDataConfig,
   usePlasmicDataMutationOp,