@plasmicapp/react-web 0.2.187 → 0.2.189

package/dist/all.d.ts

@@ -25,7 +25,8 @@ interface PlasmicPageGuardProps {
     canTriggerLogin: boolean;
     children: React__default.ReactNode;
 }
-declare function PlasmicPageGuard(props: PlasmicPageGuardProps): number | boolean | React__default.ReactFragment | JSX.Element | null | undefined;
+declare function PlasmicPageGuard(props: PlasmicPageGuardProps): JSX.Element | null;
+declare function withPlasmicPageGuard<P extends object>(WrappedComponent: React__default.ComponentType<P>, options: Omit<PlasmicPageGuardProps, "children">): React__default.FC<P>;
 
 declare function pick<T extends {}>(obj: T, ...keys: (string | number | symbol)[]): Partial<T>;
 declare function omit<T extends {}>(obj: T, ...keys: (keyof T)[]): Partial<T>;
@@ -10997,17 +10998,32 @@ interface CanvasComponentProps<Data = any> {
     setControlContextData?: (data: Data) => void;
 }
 declare type InferDataType<P> = P extends CanvasComponentProps<infer Data> ? Data : any;
+declare type ControlExtras = {
+    path: (string | number)[];
+};
 /**
- * Config option that takes the context (e.g., props) of the component instance
- * to dynamically set its value.
+ * Context that we pass back to control functions.
+ */
+declare type ControlContext<P> = [
+/**
+ * props
  */
-declare type ContextDependentConfig<P, R> = (props: P, 
+P, 
 /**
  * `contextData` can be `null` if the prop controls are rendering before
  * the component instance itself (it will re-render once the component
  * calls `setControlContextData`)
  */
-contextData: InferDataType<P> | null) => R;
+InferDataType<P> | null, 
+/**
+ * Extra information for the control to use
+ */
+ControlExtras];
+/**
+ * Config option that takes the context (e.g., props) of the component instance
+ * to dynamically set its value.
+ */
+declare type ContextDependentConfig<P, R> = (...args: ControlContext<P>) => R;
 interface PropTypeBase<P> {
     displayName?: string;
     description?: string;
@@ -11161,7 +11177,7 @@ declare type JSONLikeType<P> = "object" | ({
     /**
      * Optional function that generates a name for this item in the array
      */
-    nameFunc?: (item: any) => string | undefined;
+    nameFunc?: (item: any, ...args: ControlContext<P>) => string | undefined;
 } & DefaultValueOrExpr<P, any> & PropTypeBase<P>) | ({
     type: "array";
     itemType?: {
@@ -11172,8 +11188,29 @@ declare type JSONLikeType<P> = "object" | ({
         /**
          * Optional function that generates a name for this item in the array
          */
-        nameFunc?: (item: any) => string | undefined;
+        nameFunc?: (item: any, ...args: ControlContext<P>) => string | undefined;
     };
+    /**
+     * Specify how to let Plasmic know how to update its own internal representation of the data when the value has
+     * changed, or when issuing a minimalValue or shownValue that is different.
+     *
+     * Important to specify this if you are expecting any nested expression values in this data type!
+     */
+    unstable__keyFunc?: (item: any) => any;
+    /**
+     * Specify what would be the tentative new value that is set if the user makes any changes.
+     *
+     * Useful for field mappings.
+     *
+     * For instance, consider a Table where we have a `fields` prop:
+     *
+     * - Initially, the value is undefined. But if the user makes any changes, we would want to save an array of at
+     *   least three items (corresponding to, say, three columns inferred from a schema).
+     *
+     * - Let's say there are 5 columns in the value. The data schema changes, removing a column and adding two new
+     *   ones. Now we would want a different minimal value, containing 6 items.
+     */
+    unstable__minimalValue?: ContextDependentConfig<P, any>;
 } & DefaultValueOrExpr<P, any[]> & PropTypeBase<P>) | ({
     type: "dataSource";
     dataSource: "airtable" | "cms";
@@ -11902,6 +11939,31 @@ declare type Queries = {
 };
 declare function createUseScreenVariants(isMulti: boolean, screenQueries: Queries): () => string | string[] | undefined;
 
+interface PlasmicDataSourceContextValue {
+    userAuthToken?: string | null;
+    isUserLoading?: boolean;
+    authRedirectUri?: string;
+    user?: {
+        email: string;
+        properties: Record<string, unknown> | null;
+        roleId: string;
+        roleName: string;
+        roleIds: string[];
+        roleNames: string[];
+    } | null;
+}
+declare function useCurrentUser(): {
+    email: string;
+    properties: Record<string, unknown> | null;
+    roleId: string;
+    roleName: string;
+    roleIds: string[];
+    roleNames: string[];
+} | {
+    isLoggedIn: boolean;
+};
+declare const PlasmicDataSourceContextProvider: React__default.Provider<PlasmicDataSourceContextValue | undefined>;
+
 /**
  * Returns whether the component is currently being server side rendered or
  * hydrated on the client. Can be used to delay browser-specific rendering
@@ -11927,32 +11989,7 @@ declare function genTranslatableString(elt: React__default.ReactNode): {
 };
 declare function Trans({ transKey, children }: TransProps): React__default.ReactNode;
 
-interface PlasmicDataSourceContextValue {
-    userAuthToken?: string;
-    isUserLoading?: boolean;
-    authRedirectUri?: string;
-    user?: {
-        email: string;
-        properties: Record<string, unknown> | null;
-        roleId: string;
-        roleName: string;
-        roleIds: string[];
-        roleNames: string[];
-    };
-}
-declare function useCurrentUser(): {
-    email: string;
-    properties: Record<string, unknown> | null;
-    roleId: string;
-    roleName: string;
-    roleIds: string[];
-    roleNames: string[];
-} | {
-    isLoggedIn: boolean;
-};
-declare const PlasmicDataSourceContextProvider: React__default.Provider<PlasmicDataSourceContextValue | undefined>;
-
-interface PlasmicRootProviderProps {
+interface PlasmicRootProviderProps extends PlasmicDataSourceContextValue {
     platform?: "nextjs" | "gatsby";
     children?: React$1.ReactNode;
     translator?: PlasmicTranslator;
@@ -13302,4 +13339,4 @@ interface TriggeredOverlayContextValue {
 }
 declare const TriggeredOverlayContext: React$1.Context<TriggeredOverlayContextValue | undefined>;
 
-export { $State, $StateSpec, BaseButtonProps, BaseMenuButtonProps, BaseMenuGroupProps, BaseMenuItemProps, BaseMenuProps, BaseSelectOptionGroupProps, BaseSelectOptionProps, BaseSelectProps, BaseTextInputProps, BaseTriggeredOverlayProps, ButtonRef, CheckboxProps, CheckboxRef, CheckboxRefValue, DropdownMenu, Flex, HTMLElementRefOf, HtmlAnchorOnlyProps, HtmlButtonOnlyProps, MenuButtonRef, MenuButtonRefValue, MenuRef, MenuRefValue, MultiChoiceArg, PlasmicDataSourceContextProvider, PlasmicHead, PlasmicIcon, PlasmicImg, PlasmicLink, PlasmicPageGuard, PlasmicRootProvider, PlasmicSlot, SelectContext, SelectOptionRef, SelectRef, SelectRefValue, SingleBooleanChoiceArg, SingleChoiceArg, Stack, StrictProps, SwitchProps, SwitchRef, SwitchRefValue, TextInputRef, TextInputRefValue, Trans, TriggeredOverlayConfig, TriggeredOverlayContext, TriggeredOverlayRef, classNames, createPlasmicElementProxy, createUseScreenVariants, deriveRenderOpts, ensureGlobalVariants, genTranslatableString, generateStateOnChangeProp, generateStateOnChangePropForCodeComponents, generateStateValueProp, dlv as get, getCurrentInitialValue, getDataProps, getStateCellsInPlasmicProxy, getStateSpecInPlasmicProxy, hasVariant, initializeCodeComponentStates, initializePlasmicStates, is$StateProxy, isPlasmicStateProxy, makeFragment, mergeVariantsWithStates, omit, pick, plasmicHeadMeta, renderPlasmicSlot, resetToInitialValue, set, setPlumeStrictMode, useButton, useCheckbox, useCurrentUser, useDollarState, useIsSSR, useMenu, useMenuButton, useMenuGroup, useMenuItem, useSelect, useSelectOption, useSelectOptionGroup, useSwitch, useTextInput, useTrigger, useTriggeredOverlay, wrapWithClassName };
+export { $State, $StateSpec, BaseButtonProps, BaseMenuButtonProps, BaseMenuGroupProps, BaseMenuItemProps, BaseMenuProps, BaseSelectOptionGroupProps, BaseSelectOptionProps, BaseSelectProps, BaseTextInputProps, BaseTriggeredOverlayProps, ButtonRef, CheckboxProps, CheckboxRef, CheckboxRefValue, DropdownMenu, Flex, HTMLElementRefOf, HtmlAnchorOnlyProps, HtmlButtonOnlyProps, MenuButtonRef, MenuButtonRefValue, MenuRef, MenuRefValue, MultiChoiceArg, PlasmicDataSourceContextProvider, PlasmicHead, PlasmicIcon, PlasmicImg, PlasmicLink, PlasmicPageGuard, PlasmicRootProvider, PlasmicSlot, SelectContext, SelectOptionRef, SelectRef, SelectRefValue, SingleBooleanChoiceArg, SingleChoiceArg, Stack, StrictProps, SwitchProps, SwitchRef, SwitchRefValue, TextInputRef, TextInputRefValue, Trans, TriggeredOverlayConfig, TriggeredOverlayContext, TriggeredOverlayRef, classNames, createPlasmicElementProxy, createUseScreenVariants, deriveRenderOpts, ensureGlobalVariants, genTranslatableString, generateStateOnChangeProp, generateStateOnChangePropForCodeComponents, generateStateValueProp, dlv as get, getCurrentInitialValue, getDataProps, getStateCellsInPlasmicProxy, getStateSpecInPlasmicProxy, hasVariant, initializeCodeComponentStates, initializePlasmicStates, is$StateProxy, isPlasmicStateProxy, makeFragment, mergeVariantsWithStates, omit, pick, plasmicHeadMeta, renderPlasmicSlot, resetToInitialValue, set, setPlumeStrictMode, useButton, useCheckbox, useCurrentUser, useDollarState, useIsSSR, useMenu, useMenuButton, useMenuGroup, useMenuItem, useSelect, useSelectOption, useSelectOptionGroup, useSwitch, useTextInput, useTrigger, useTriggeredOverlay, withPlasmicPageGuard, wrapWithClassName };

package/dist/auth/PlasmicPageGuard.d.ts

@@ -6,5 +6,6 @@ interface PlasmicPageGuardProps {
     canTriggerLogin: boolean;
     children: React.ReactNode;
 }
-export declare function PlasmicPageGuard(props: PlasmicPageGuardProps): number | boolean | React.ReactFragment | JSX.Element | null | undefined;
+export declare function PlasmicPageGuard(props: PlasmicPageGuardProps): JSX.Element | null;
+export declare function withPlasmicPageGuard<P extends object>(WrappedComponent: React.ComponentType<P>, options: Omit<PlasmicPageGuardProps, "children">): React.FC<P>;
 export {};

package/dist/index-common.d.ts

@@ -1,5 +1,5 @@
 import _classNames from "classnames";
-export { PlasmicPageGuard } from "./auth/PlasmicPageGuard";
+export { PlasmicPageGuard, withPlasmicPageGuard, } from "./auth/PlasmicPageGuard";
 export { omit, pick } from "./common";
 export { HTMLElementRefOf, StrictProps } from "./react-utils";
 export { createPlasmicElementProxy, deriveRenderOpts, Flex, hasVariant, makeFragment, mergeVariantsWithStates, MultiChoiceArg, SingleBooleanChoiceArg, SingleChoiceArg, wrapWithClassName, } from "./render/elements";

package/dist/react-web.cjs.development.js

@@ -966,7 +966,13 @@ function PlasmicPageGuard(props) {
   if (!canUserViewPage()) {
     return React__default.createElement("div", null, "You don't have access to this page");
   }
-  return children;
+  return React__default.createElement(React__default.Fragment, null, children);
+}
+function withPlasmicPageGuard(WrappedComponent, options) {
+  var PageGuard = function PageGuard(props) {
+    return React__default.createElement(PlasmicPageGuard, Object.assign({}, options), React__default.createElement(WrappedComponent, Object.assign({}, props)));
+  };
+  return PageGuard;
 }
 
 function notNil(x) {
@@ -4726,5 +4732,6 @@ exports.useSwitch = useSwitch;
 exports.useTextInput = useTextInput;
 exports.useTrigger = useTrigger;
 exports.useTriggeredOverlay = useTriggeredOverlay;
+exports.withPlasmicPageGuard = withPlasmicPageGuard;
 exports.wrapWithClassName = wrapWithClassName;
 //# sourceMappingURL=react-web.cjs.development.js.map