@plasmicapp/data-sources 0.1.136 → 0.1.137

package/dist/index.d.ts

@@ -1,10 +1,137 @@
-export { usePlasmicDataConfig } from "@plasmicapp/query";
-export { Fetcher, FetcherMeta } from "./components/Fetcher";
-export type { FetcherProps } from "./components/Fetcher";
-export { executePlasmicDataOp } from "./executor";
-export type { DataOp } from "./executor";
-export { deriveFieldConfigs, normalizeData, useNormalizedData, } from "./helpers";
-export type { BaseFieldConfig, NormalizedData, QueryResult } from "./helpers";
-export { useDependencyAwareQuery } from "./hooks/useDependencyAwareQuery";
-export { makeCacheKey, usePlasmicDataMutationOp, usePlasmicDataOp, usePlasmicInvalidate, } from "./hooks/usePlasmicDataOp";
-export type { DataSourceSchema, ManyRowsResult, Pagination, SingleRowResult, TableFieldSchema, TableFieldType, TableSchema, } from "./types";
+import { ComponentMeta } from '@plasmicapp/host';
+import { PlasmicDataSourceContextValue } from '@plasmicapp/data-sources-context';
+import { default as React_2 } from 'react';
+import { usePlasmicDataConfig } from '@plasmicapp/query';
+
+export declare type BaseFieldConfig = {
+    key?: string;
+    fieldId?: string;
+};
+
+export declare interface DataOp {
+    sourceId: string;
+    opId: string;
+    userArgs?: Record<string, any>;
+    cacheKey?: string;
+    invalidatedKeys?: string[] | null;
+    roleId?: string | null;
+}
+
+declare interface DataOpConfig {
+    name?: string;
+    pageIndex?: number;
+    pageSize?: number;
+}
+
+export declare interface DataSourceSchema {
+    tables: TableSchema[];
+}
+
+declare interface DependencyAwareQueryConfig extends DataOpConfig {
+    $queries: Record<string, any>;
+    setDollarQueries: ($queries: Record<string, any>) => void;
+    getDataOp: () => DataOp;
+}
+
+export declare function deriveFieldConfigs<T extends BaseFieldConfig>(specifiedFieldsPartial: Partial<T>[], schema: TableSchema | undefined, makeDefaultConfig: (field: TableFieldSchema | undefined) => T): {
+    mergedFields: T[];
+    minimalFullLengthFields: Partial<T>[];
+};
+
+declare interface ExecuteOpts {
+    userAuthToken?: string;
+    user?: PlasmicDataSourceContextValue["user"];
+    paginate?: Pagination;
+}
+
+export declare function executePlasmicDataOp<T extends SingleRowResult | ManyRowsResult>(op: DataOp, opts?: ExecuteOpts): Promise<T>;
+
+export declare function Fetcher(props: FetcherProps): React_2.ReactElement | null;
+
+export declare const FetcherMeta: ComponentMeta<FetcherProps>;
+
+export declare interface FetcherProps extends DataOpConfig {
+    dataOp?: DataOp;
+    children?: ($queries: Record<string, any>) => React_2.ReactElement | null;
+    queries?: Record<string, any>;
+}
+
+export declare function makeCacheKey(dataOp: DataOp, opts?: {
+    paginate?: Pagination;
+    userAuthToken?: string | null;
+}): string;
+
+export declare interface ManyRowsResult<T = any> {
+    data: T[];
+    total?: number;
+    schema: TableSchema;
+    paginate?: Pagination;
+}
+
+export declare function normalizeData(rawData: unknown): NormalizedData | undefined;
+
+export declare interface NormalizedData {
+    data: Record<string, unknown>[];
+    schema?: TableSchema;
+}
+
+export declare interface Pagination {
+    pageSize: number;
+    pageIndex: number;
+}
+
+export declare type QueryResult = Partial<ManyRowsResult<any>> & {
+    error?: any;
+    isLoading?: boolean;
+};
+
+declare type ResolvableDataOp = DataOp | undefined | null | (() => DataOp | undefined | null);
+
+export declare interface SingleRowResult<T = any> {
+    data: T;
+    schema: TableSchema;
+}
+
+export declare interface TableFieldSchema {
+    id: string;
+    label?: string;
+    type: TableFieldType;
+    readOnly: boolean;
+    primaryKey?: boolean;
+    options?: string[];
+}
+
+export declare type TableFieldType = "string" | "boolean" | "number" | "date" | "datetime" | "enum" | "json" | "unknown";
+
+export declare interface TableSchema {
+    id: string;
+    schema?: string;
+    label?: string;
+    fields: TableFieldSchema[];
+}
+
+/**
+ * @deprecated Prefer using `usePlasmicDataOp` directly instead.
+ */
+export declare function useDependencyAwareQuery({ $queries, getDataOp, setDollarQueries, name, pageIndex, pageSize, }: DependencyAwareQueryConfig): void;
+
+export declare function useNormalizedData(rawData: unknown): NormalizedData | undefined;
+
+export { usePlasmicDataConfig }
+
+export declare function usePlasmicDataMutationOp<T extends SingleRowResult | ManyRowsResult>(dataOp: ResolvableDataOp): () => Promise<T | undefined>;
+
+export declare function usePlasmicDataOp<T extends SingleRowResult | ManyRowsResult, E = any>(dataOp: ResolvableDataOp, opts?: {
+    paginate?: Pagination;
+    noUndefinedDataProxy?: boolean;
+}): Partial<T> & {
+    error?: E;
+    isLoading?: boolean;
+};
+
+/**
+ * Returns a function that can be used to invalidate Plasmic query groups.
+ */
+export declare function usePlasmicInvalidate(): (invalidatedKeys: string[] | null | undefined) => Promise<any[] | undefined>;
+
+export { }

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.1.136",
+  "version": "0.1.137",
   "license": "MIT",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",
@@ -45,14 +45,14 @@
     "react-dom": "^18.2.0"
   },
   "dependencies": {
-    "@plasmicapp/data-sources-context": "0.1.18",
-    "@plasmicapp/host": "1.0.178",
+    "@plasmicapp/data-sources-context": "0.1.19",
+    "@plasmicapp/host": "1.0.179",
     "@plasmicapp/isomorphic-unfetch": "1.0.3",
-    "@plasmicapp/query": "0.1.75",
+    "@plasmicapp/query": "0.1.76",
     "fast-stringify": "^2.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "2f3284dea9fbef3b99d2f1aa7d41ad84775f23d3"
+  "gitHead": "48a2877c3dc093d101508fcdde2fd213055fdab9"
 }

package/dist/components/Fetcher.d.ts

@@ -1,15 +0,0 @@
-import { ComponentMeta } from '@plasmicapp/host';
-import React from 'react';
-import { DataOp } from '../executor';
-export interface DataOpConfig {
-    name?: string;
-    pageIndex?: number;
-    pageSize?: number;
-}
-export interface FetcherProps extends DataOpConfig {
-    dataOp?: DataOp;
-    children?: ($queries: Record<string, any>) => React.ReactElement | null;
-    queries?: Record<string, any>;
-}
-export declare function Fetcher(props: FetcherProps): React.ReactElement | null;
-export declare const FetcherMeta: ComponentMeta<FetcherProps>;

package/dist/executor.d.ts

@@ -1,17 +0,0 @@
-import { PlasmicDataSourceContextValue } from "@plasmicapp/data-sources-context";
-import { ManyRowsResult, Pagination, SingleRowResult } from "./types";
-export interface DataOp {
-    sourceId: string;
-    opId: string;
-    userArgs?: Record<string, any>;
-    cacheKey?: string;
-    invalidatedKeys?: string[] | null;
-    roleId?: string | null;
-}
-interface ExecuteOpts {
-    userAuthToken?: string;
-    user?: PlasmicDataSourceContextValue["user"];
-    paginate?: Pagination;
-}
-export declare function executePlasmicDataOp<T extends SingleRowResult | ManyRowsResult>(op: DataOp, opts?: ExecuteOpts): Promise<T>;
-export {};

package/dist/helpers.d.ts

@@ -1,19 +0,0 @@
-import { ManyRowsResult, TableFieldSchema, TableSchema } from "./types";
-export type QueryResult = Partial<ManyRowsResult<any>> & {
-    error?: any;
-    isLoading?: boolean;
-};
-export interface NormalizedData {
-    data: Record<string, unknown>[];
-    schema?: TableSchema;
-}
-export declare function normalizeData(rawData: unknown): NormalizedData | undefined;
-export declare function useNormalizedData(rawData: unknown): NormalizedData | undefined;
-export type BaseFieldConfig = {
-    key?: string;
-    fieldId?: string;
-};
-export declare function deriveFieldConfigs<T extends BaseFieldConfig>(specifiedFieldsPartial: Partial<T>[], schema: TableSchema | undefined, makeDefaultConfig: (field: TableFieldSchema | undefined) => T): {
-    mergedFields: T[];
-    minimalFullLengthFields: Partial<T>[];
-};

package/dist/hooks/useDependencyAwareQuery.d.ts

@@ -1,11 +0,0 @@
-import { DataOpConfig } from '../components/Fetcher';
-import { DataOp } from '../executor';
-export interface DependencyAwareQueryConfig extends DataOpConfig {
-    $queries: Record<string, any>;
-    setDollarQueries: ($queries: Record<string, any>) => void;
-    getDataOp: () => DataOp;
-}
-/**
- * @deprecated Prefer using `usePlasmicDataOp` directly instead.
- */
-export declare function useDependencyAwareQuery({ $queries, getDataOp, setDollarQueries, name, pageIndex, pageSize, }: DependencyAwareQueryConfig): void;

package/dist/hooks/usePlasmicDataOp.d.ts

@@ -1,20 +0,0 @@
-import { DataOp } from '../executor';
-import { ManyRowsResult, Pagination, SingleRowResult } from '../types';
-export declare function makeCacheKey(dataOp: DataOp, opts?: {
-    paginate?: Pagination;
-    userAuthToken?: string | null;
-}): string;
-/**
- * Returns a function that can be used to invalidate Plasmic query groups.
- */
-export declare function usePlasmicInvalidate(): (invalidatedKeys: string[] | null | undefined) => Promise<any[] | undefined>;
-type ResolvableDataOp = DataOp | undefined | null | (() => DataOp | undefined | null);
-export declare function usePlasmicDataOp<T extends SingleRowResult | ManyRowsResult, E = any>(dataOp: ResolvableDataOp, opts?: {
-    paginate?: Pagination;
-    noUndefinedDataProxy?: boolean;
-}): Partial<T> & {
-    error?: E;
-    isLoading?: boolean;
-};
-export declare function usePlasmicDataMutationOp<T extends SingleRowResult | ManyRowsResult>(dataOp: ResolvableDataOp): () => Promise<T | undefined>;
-export {};

package/dist/placeholders.d.ts

@@ -1 +0,0 @@
-export declare function addPlaceholdersToUserArgs(userArgs: Record<string, any> | undefined): Record<string, any> | undefined;

package/dist/types.d.ts

@@ -1,32 +0,0 @@
-export interface Pagination {
-    pageSize: number;
-    pageIndex: number;
-}
-export interface DataSourceSchema {
-    tables: TableSchema[];
-}
-export interface TableSchema {
-    id: string;
-    schema?: string;
-    label?: string;
-    fields: TableFieldSchema[];
-}
-export interface TableFieldSchema {
-    id: string;
-    label?: string;
-    type: TableFieldType;
-    readOnly: boolean;
-    primaryKey?: boolean;
-    options?: string[];
-}
-export type TableFieldType = "string" | "boolean" | "number" | "date" | "datetime" | "enum" | "json" | "unknown";
-export interface SingleRowResult<T = any> {
-    data: T;
-    schema: TableSchema;
-}
-export interface ManyRowsResult<T = any> {
-    data: T[];
-    total?: number;
-    schema: TableSchema;
-    paginate?: Pagination;
-}

package/dist/utils.d.ts

@@ -1,31 +0,0 @@
-/// <reference types="react" />
-export declare function swallow<T>(f: () => T): T | undefined;
-export declare function pick<T extends object, K extends keyof T>(obj: T, ...keys: K[]): Pick<T, K>;
-type ReactElt = {
-    children: ReactElt | ReactElt[];
-    props: {
-        children: ReactElt | ReactElt[];
-        [prop: string]: any;
-    } | null;
-    type: React.ComponentType<any> | null;
-    key: string | null;
-} | null;
-export declare function traverseReactEltTree(children: React.ReactNode, callback: (elt: ReactElt) => void): void;
-export declare function asArray<T>(x: T[] | T | undefined | null): T[];
-export declare function ensureNumber(x: number | string): number;
-export declare function ensure<T>(x: T | null | undefined): T;
-export declare function isOneOf<T, U extends T>(elem: T, arr: readonly U[]): elem is U;
-export declare function maybe<T, U>(x: T | undefined | null, f: (y: T) => U): U | undefined;
-export declare function isLikeImage(value: unknown): false | RegExpMatchArray | null;
-export declare function ensureArray<T>(xs: T | T[]): T[];
-export declare const tuple: <T extends any[]>(...args: T) => T;
-export interface HasId {
-    id: string;
-}
-export declare function mkIdMap<T extends HasId>(xs: ReadonlyArray<T>): Map<string, T>;
-export declare const mkShortId: () => string;
-export declare function withoutNils<T>(xs: Array<T | undefined | null>): T[];
-export type Falsey = null | undefined | false | '' | 0 | 0n;
-export type Truthy<T> = T extends Falsey ? never : T;
-export declare function withoutFalsey<T>(xs: Array<T | Falsey>): T[];
-export {};