@plasmicapp/host 1.0.130 → 1.0.131

package/dist/canvas-host.d.ts

@@ -1,41 +1,41 @@
-import * as React from "react";
-declare global {
-    interface Window {
-        __PlasmicHostVersion: string;
-    }
-}
-export declare function setPlasmicRootNode(node: React.ReactElement | null): void;
-export interface PlasmicCanvasContextValue {
-    componentName: string | null;
-    globalVariants: Record<string, string>;
-    interactive?: boolean;
-}
-/**
- * React context to detect whether the component is rendered on Plasmic editor.
- * If not, return false.
- * If so, return an object with more information about the component
- */
-export declare const PlasmicCanvasContext: React.Context<false | PlasmicCanvasContextValue>;
-export declare const usePlasmicCanvasContext: () => false | PlasmicCanvasContextValue;
-interface PlasmicCanvasHostProps {
-    /**
-     * Webpack hmr uses EventSource to	listen to hot reloads, but that
-     * resultsin a persistent	connection from	each window.  In Plasmic
-     * Studio, if a project is configured to use app-hosting with a
-     * nextjs or gatsby server running in dev mode, each artboard will
-     * be holding a persistent connection to the dev server.
-     * Because browsers	have a limit to	how many connections can
-     * be held	at a time by domain, this means	after X	artboards, new
-     * artboards will freeze and not load.
-     *
-     * By default, <PlasmicCanvasHost /> will globally mutate
-     * window.EventSource to avoid using EventSource for HMR, which you
-     * typically don't need for your custom host page.  If you do still
-     * want to retain HRM, then youc an pass enableWebpackHmr={true}.
-     */
-    enableWebpackHmr?: boolean;
-}
-export declare const PlasmicCanvasHost: React.FunctionComponent<PlasmicCanvasHostProps>;
-declare type RenderErrorListener = (err: Error) => void;
-export declare function registerRenderErrorListener(listener: RenderErrorListener): () => void;
-export {};
+import * as React from "react";
+declare global {
+    interface Window {
+        __PlasmicHostVersion: string;
+    }
+}
+export declare function setPlasmicRootNode(node: React.ReactElement | null): void;
+export interface PlasmicCanvasContextValue {
+    componentName: string | null;
+    globalVariants: Record<string, string>;
+    interactive?: boolean;
+}
+/**
+ * React context to detect whether the component is rendered on Plasmic editor.
+ * If not, return false.
+ * If so, return an object with more information about the component
+ */
+export declare const PlasmicCanvasContext: React.Context<false | PlasmicCanvasContextValue>;
+export declare const usePlasmicCanvasContext: () => false | PlasmicCanvasContextValue;
+interface PlasmicCanvasHostProps {
+    /**
+     * Webpack hmr uses EventSource to	listen to hot reloads, but that
+     * resultsin a persistent	connection from	each window.  In Plasmic
+     * Studio, if a project is configured to use app-hosting with a
+     * nextjs or gatsby server running in dev mode, each artboard will
+     * be holding a persistent connection to the dev server.
+     * Because browsers	have a limit to	how many connections can
+     * be held	at a time by domain, this means	after X	artboards, new
+     * artboards will freeze and not load.
+     *
+     * By default, <PlasmicCanvasHost /> will globally mutate
+     * window.EventSource to avoid using EventSource for HMR, which you
+     * typically don't need for your custom host page.  If you do still
+     * want to retain HRM, then youc an pass enableWebpackHmr={true}.
+     */
+    enableWebpackHmr?: boolean;
+}
+export declare const PlasmicCanvasHost: React.FunctionComponent<PlasmicCanvasHostProps>;
+type RenderErrorListener = (err: Error) => void;
+export declare function registerRenderErrorListener(listener: RenderErrorListener): () => void;
+export {};

package/dist/common.d.ts

@@ -1 +1 @@
-export declare const tuple: <T extends any[]>(...args: T) => T;
+export declare const tuple: <T extends any[]>(...args: T) => T;

package/dist/data.d.ts

@@ -1,43 +1,43 @@
-import React, { ReactNode } from "react";
-export declare type DataDict = Record<string, any>;
-export declare const DataContext: React.Context<Record<string, any> | undefined>;
-export declare type DataMeta = {
-    hidden?: boolean;
-    label?: string;
-};
-export declare function mkMetaName(name: string): string;
-export declare function mkMetaValue(meta: Partial<DataMeta>): DataMeta;
-export declare function applySelector(rawData: DataDict | undefined, selector: string | undefined): any;
-export declare type SelectorDict = Record<string, string | undefined>;
-export declare function useSelector(selector: string | undefined): any;
-export declare function useSelectors(selectors?: SelectorDict): any;
-export declare function useDataEnv(): Record<string, any> | undefined;
-export interface DataProviderProps {
-    /**
-     * Key to set in data context.
-     */
-    name?: string;
-    /**
-     * Value to set for `name` in data context.
-     */
-    data?: any;
-    /**
-     * If true, hide this entry in studio (data binding).
-     */
-    hidden?: boolean;
-    /**
-     * Label to be shown in the studio data picker for easier navigation (data binding).
-     */
-    label?: string;
-    children?: ReactNode;
-}
-export declare function DataProvider({ name, data, hidden, label, children, }: DataProviderProps): JSX.Element;
-export interface PageParamsProviderProps {
-    params?: Record<string, string | string[] | undefined>;
-    query?: Record<string, string | string[] | undefined>;
-    children?: ReactNode;
-}
-export declare function PageParamsProvider({ children, params, query, }: PageParamsProviderProps): JSX.Element;
-export declare function DataCtxReader({ children, }: {
-    children: ($ctx: DataDict | undefined) => ReactNode;
-}): React.ReactElement<any, string | ((props: any) => React.ReactElement<any, any> | null) | (new (props: any) => React.Component<any, any, any>)> | null;
+import React, { ReactNode } from "react";
+export type DataDict = Record<string, any>;
+export declare const DataContext: React.Context<DataDict | undefined>;
+export type DataMeta = {
+    hidden?: boolean;
+    label?: string;
+};
+export declare function mkMetaName(name: string): string;
+export declare function mkMetaValue(meta: Partial<DataMeta>): DataMeta;
+export declare function applySelector(rawData: DataDict | undefined, selector: string | undefined): any;
+export type SelectorDict = Record<string, string | undefined>;
+export declare function useSelector(selector: string | undefined): any;
+export declare function useSelectors(selectors?: SelectorDict): any;
+export declare function useDataEnv(): DataDict | undefined;
+export interface DataProviderProps {
+    /**
+     * Key to set in data context.
+     */
+    name?: string;
+    /**
+     * Value to set for `name` in data context.
+     */
+    data?: any;
+    /**
+     * If true, hide this entry in studio (data binding).
+     */
+    hidden?: boolean;
+    /**
+     * Label to be shown in the studio data picker for easier navigation (data binding).
+     */
+    label?: string;
+    children?: ReactNode;
+}
+export declare function DataProvider({ name, data, hidden, label, children, }: DataProviderProps): JSX.Element;
+export interface PageParamsProviderProps {
+    params?: Record<string, string | string[] | undefined>;
+    query?: Record<string, string | string[] | undefined>;
+    children?: ReactNode;
+}
+export declare function PageParamsProvider({ children, params, query, }: PageParamsProviderProps): JSX.Element;
+export declare function DataCtxReader({ children, }: {
+    children: ($ctx: DataDict | undefined) => ReactNode;
+}): React.ReactElement<any, string | React.JSXElementConstructor<any>> | null;

package/dist/element-types.d.ts

@@ -1,115 +1,115 @@
-import type { Properties } from "csstype";
-export declare type CSSProperties = Properties<string | number> & {
-    layout?: "vbox" | "hbox" | "box" | "page-section";
-};
-declare type ContainerTags = "a" | "address" | "article" | "aside" | "blockquote" | "button" | "code" | "dd" | "div" | "dl" | "dt" | "form" | "footer" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "header" | "hgroup" | "label" | "li" | "main" | "nav" | "ol" | "p" | "pre" | "section" | "span" | "ul";
-declare type CommonAttrKeys = "title" | "tabIndex" | "className" | "id" | "aria-label" | "aria-hidden" | "aria-labelledby" | "aria-describedby" | "role";
-declare type PictureAttrKeys = "alt" | "loading" | CommonAttrKeys;
-declare type LinkAttrKeys = "href" | "target" | CommonAttrKeys;
-declare type TextAreaAttrKeys = "disabled" | "value" | "cols" | "rows" | "placeholder" | CommonAttrKeys;
-declare type InputAttrKeys = "disabled" | "value" | "defaultValue" | "name" | "autoComplete" | "checked" | "placeholder" | CommonAttrKeys;
-declare type ButtonAttrKeys = "disabled" | CommonAttrKeys;
-declare type Attrs<Keys extends string> = Partial<Record<Keys, string>>;
-export interface PictureElement {
-    type: "img";
-    src: string;
-    styles?: CSSProperties;
-    attrs?: Attrs<PictureAttrKeys>;
-}
-export declare type ImageElement = PictureElement;
-interface LinkTextElement {
-    type: "text";
-    tag: "a";
-    value: string;
-    styles?: CSSProperties;
-    attrs?: Attrs<LinkAttrKeys>;
-}
-interface ButtonTextElement {
-    type: "text";
-    tag: "button";
-    value: string;
-    styles?: CSSProperties;
-    attrs?: Attrs<ButtonAttrKeys>;
-}
-interface GenericTextElement {
-    type: "text";
-    /**
-     * Default: "div"
-     */
-    tag?: Exclude<ContainerTags, "a" | "button">;
-    value: string;
-    styles?: CSSProperties;
-    attrs?: Attrs<CommonAttrKeys>;
-}
-export declare type TextElement = string | LinkTextElement | ButtonTextElement | GenericTextElement;
-interface LinkContainerElement {
-    type: "box" | "vbox" | "hbox";
-    tag: "a";
-    children?: PlasmicElement | PlasmicElement[];
-    styles?: CSSProperties;
-    attrs?: Attrs<LinkAttrKeys>;
-}
-interface ButtonContainerElement {
-    type: "box" | "vbox" | "hbox";
-    tag: "button";
-    children?: PlasmicElement | PlasmicElement[];
-    styles?: CSSProperties;
-    attrs?: Attrs<ButtonAttrKeys>;
-}
-interface GenericContainerElement {
-    type: "box" | "vbox" | "hbox" | "page-section";
-    /**
-     * Default: "div"
-     */
-    tag?: Exclude<ContainerTags, "a" | "button">;
-    children?: PlasmicElement | PlasmicElement[];
-    styles?: CSSProperties;
-    attrs?: Attrs<CommonAttrKeys>;
-}
-export declare type ContainerElement = LinkContainerElement | ButtonContainerElement | GenericContainerElement;
-export interface ButtonElement {
-    type: "button";
-    value: string;
-    styles?: CSSProperties;
-    attrs?: Attrs<ButtonAttrKeys>;
-}
-interface InputElement {
-    type: "input" | "password";
-    styles?: CSSProperties;
-    attrs?: Attrs<InputAttrKeys>;
-}
-interface TextAreaElement {
-    type: "textarea";
-    styles?: CSSProperties;
-    attrs?: Attrs<TextAreaAttrKeys>;
-}
-export declare type TextInputElement = InputElement | TextAreaElement;
-interface JsonElement {
-    type: "json";
-    value: any;
-}
-export interface DefaultComponentElement<P> {
-    type: "default-component";
-    kind: "button" | "text-input";
-    props?: {
-        [prop in keyof Partial<P>]: number | string | boolean | null | undefined | JsonElement | PlasmicElement | PlasmicElement[];
-    } & {
-        [prop: string]: number | string | boolean | null | undefined | JsonElement | PlasmicElement | PlasmicElement[];
-    };
-    styles?: CSSProperties;
-}
-export interface CodeComponentElement<P> {
-    type: "component";
-    /**
-     * The registered component name
-     */
-    name: string;
-    styles?: CSSProperties;
-    props?: {
-        [prop in keyof Partial<P>]: number | string | boolean | null | undefined | JsonElement | PlasmicElement | PlasmicElement[];
-    } & {
-        [prop: string]: number | string | boolean | null | undefined | JsonElement | PlasmicElement | PlasmicElement[];
-    };
-}
-export declare type PlasmicElement = ImageElement | TextElement | ContainerElement | ButtonElement | TextInputElement | CodeComponentElement<{}> | DefaultComponentElement<{}>;
-export {};
+import type { Properties } from "csstype";
+export type CSSProperties = Properties<string | number> & {
+    layout?: "vbox" | "hbox" | "box" | "page-section";
+};
+type ContainerTags = "a" | "address" | "article" | "aside" | "blockquote" | "button" | "code" | "dd" | "div" | "dl" | "dt" | "form" | "footer" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "header" | "hgroup" | "label" | "li" | "main" | "nav" | "ol" | "p" | "pre" | "section" | "span" | "ul";
+type CommonAttrKeys = "title" | "tabIndex" | "className" | "id" | "aria-label" | "aria-hidden" | "aria-labelledby" | "aria-describedby" | "role";
+type PictureAttrKeys = "alt" | "loading" | CommonAttrKeys;
+type LinkAttrKeys = "href" | "target" | CommonAttrKeys;
+type TextAreaAttrKeys = "disabled" | "value" | "cols" | "rows" | "placeholder" | CommonAttrKeys;
+type InputAttrKeys = "disabled" | "value" | "defaultValue" | "name" | "autoComplete" | "checked" | "placeholder" | CommonAttrKeys;
+type ButtonAttrKeys = "disabled" | CommonAttrKeys;
+type Attrs<Keys extends string> = Partial<Record<Keys, string>>;
+export interface PictureElement {
+    type: "img";
+    src: string;
+    styles?: CSSProperties;
+    attrs?: Attrs<PictureAttrKeys>;
+}
+export type ImageElement = PictureElement;
+interface LinkTextElement {
+    type: "text";
+    tag: "a";
+    value: string;
+    styles?: CSSProperties;
+    attrs?: Attrs<LinkAttrKeys>;
+}
+interface ButtonTextElement {
+    type: "text";
+    tag: "button";
+    value: string;
+    styles?: CSSProperties;
+    attrs?: Attrs<ButtonAttrKeys>;
+}
+interface GenericTextElement {
+    type: "text";
+    /**
+     * Default: "div"
+     */
+    tag?: Exclude<ContainerTags, "a" | "button">;
+    value: string;
+    styles?: CSSProperties;
+    attrs?: Attrs<CommonAttrKeys>;
+}
+export type TextElement = string | LinkTextElement | ButtonTextElement | GenericTextElement;
+interface LinkContainerElement {
+    type: "box" | "vbox" | "hbox";
+    tag: "a";
+    children?: PlasmicElement | PlasmicElement[];
+    styles?: CSSProperties;
+    attrs?: Attrs<LinkAttrKeys>;
+}
+interface ButtonContainerElement {
+    type: "box" | "vbox" | "hbox";
+    tag: "button";
+    children?: PlasmicElement | PlasmicElement[];
+    styles?: CSSProperties;
+    attrs?: Attrs<ButtonAttrKeys>;
+}
+interface GenericContainerElement {
+    type: "box" | "vbox" | "hbox" | "page-section";
+    /**
+     * Default: "div"
+     */
+    tag?: Exclude<ContainerTags, "a" | "button">;
+    children?: PlasmicElement | PlasmicElement[];
+    styles?: CSSProperties;
+    attrs?: Attrs<CommonAttrKeys>;
+}
+export type ContainerElement = LinkContainerElement | ButtonContainerElement | GenericContainerElement;
+export interface ButtonElement {
+    type: "button";
+    value: string;
+    styles?: CSSProperties;
+    attrs?: Attrs<ButtonAttrKeys>;
+}
+interface InputElement {
+    type: "input" | "password";
+    styles?: CSSProperties;
+    attrs?: Attrs<InputAttrKeys>;
+}
+interface TextAreaElement {
+    type: "textarea";
+    styles?: CSSProperties;
+    attrs?: Attrs<TextAreaAttrKeys>;
+}
+export type TextInputElement = InputElement | TextAreaElement;
+interface JsonElement {
+    type: "json";
+    value: any;
+}
+export interface DefaultComponentElement<P> {
+    type: "default-component";
+    kind: "button" | "text-input";
+    props?: {
+        [prop in keyof Partial<P>]: number | string | boolean | null | undefined | JsonElement | PlasmicElement | PlasmicElement[];
+    } & {
+        [prop: string]: number | string | boolean | null | undefined | JsonElement | PlasmicElement | PlasmicElement[];
+    };
+    styles?: CSSProperties;
+}
+export interface CodeComponentElement<P> {
+    type: "component";
+    /**
+     * The registered component name
+     */
+    name: string;
+    styles?: CSSProperties;
+    props?: {
+        [prop in keyof Partial<P>]: number | string | boolean | null | undefined | JsonElement | PlasmicElement | PlasmicElement[];
+    } & {
+        [prop: string]: number | string | boolean | null | undefined | JsonElement | PlasmicElement | PlasmicElement[];
+    };
+}
+export type PlasmicElement = ImageElement | TextElement | ContainerElement | ButtonElement | TextInputElement | CodeComponentElement<{}> | DefaultComponentElement<{}>;
+export {};

package/dist/exports.d.ts

@@ -1,10 +1,10 @@
-export { PlasmicCanvasContext, PlasmicCanvasHost, usePlasmicCanvasContext, } from "./canvas-host";
-export * from "./data";
-export { PlasmicElement } from "./element-types";
-export { registerFetcher as unstable_registerFetcher } from "./fetcher";
-export * from "./global-actions";
-export { Action, ActionProps, CodeComponentMeta, ComponentHelpers, ComponentMeta, ComponentRegistration, ComponentTemplates, ContextDependentConfig, default as registerComponent, DefaultValueOrExpr, PrimitiveType, PropType, PropTypeBase, StateHelpers, StateSpec, } from "./registerComponent";
-export { default as registerGlobalContext, GlobalContextMeta, GlobalContextRegistration, PropType as GlobalContextPropType, } from "./registerGlobalContext";
-export { default as registerToken, TokenRegistration, TokenType, } from "./registerToken";
-export { BasicTrait, ChoiceTrait, default as registerTrait, TraitMeta, TraitRegistration, } from "./registerTrait";
-export { default as repeatedElement } from "./repeatedElement";
+export { PlasmicCanvasContext, PlasmicCanvasHost, usePlasmicCanvasContext, } from "./canvas-host";
+export * from "./data";
+export { PlasmicElement } from "./element-types";
+export { registerFetcher as unstable_registerFetcher } from "./fetcher";
+export * from "./global-actions";
+export { Action, ActionProps, CodeComponentMeta, ComponentHelpers, ComponentMeta, ComponentRegistration, ComponentTemplates, ContextDependentConfig, default as registerComponent, DefaultValueOrExpr, PrimitiveType, PropType, PropTypeBase, StateHelpers, StateSpec, } from "./registerComponent";
+export { default as registerGlobalContext, GlobalContextMeta, GlobalContextRegistration, PropType as GlobalContextPropType, } from "./registerGlobalContext";
+export { default as registerToken, TokenRegistration, TokenType, } from "./registerToken";
+export { BasicTrait, ChoiceTrait, default as registerTrait, TraitMeta, TraitRegistration, } from "./registerTrait";
+export { default as repeatedElement } from "./repeatedElement";

package/dist/fetcher.d.ts

@@ -1,40 +1,40 @@
-import { PrimitiveType } from "./registerComponent";
-export declare type Fetcher = (...args: any[]) => Promise<any>;
-export interface FetcherMeta {
-    /**
-     * Any unique identifying string for this fetcher.
-     */
-    name: string;
-    /**
-     * The Studio-user-friendly display name.
-     */
-    displayName?: string;
-    /**
-     * The symbol to import from the importPath.
-     */
-    importName?: string;
-    args: {
-        name: string;
-        type: PrimitiveType;
-    }[];
-    returns: PrimitiveType;
-    /**
-     * Either the path to the fetcher relative to `rootDir` or the npm
-     * package name
-     */
-    importPath: string;
-    /**
-     * Whether it's a default export or named export
-     */
-    isDefaultExport?: boolean;
-}
-export interface FetcherRegistration {
-    fetcher: Fetcher;
-    meta: FetcherMeta;
-}
-declare global {
-    interface Window {
-        __PlasmicFetcherRegistry: FetcherRegistration[];
-    }
-}
-export declare function registerFetcher(fetcher: Fetcher, meta: FetcherMeta): void;
+import { PrimitiveType } from "./registerComponent";
+export type Fetcher = (...args: any[]) => Promise<any>;
+export interface FetcherMeta {
+    /**
+     * Any unique identifying string for this fetcher.
+     */
+    name: string;
+    /**
+     * The Studio-user-friendly display name.
+     */
+    displayName?: string;
+    /**
+     * The symbol to import from the importPath.
+     */
+    importName?: string;
+    args: {
+        name: string;
+        type: PrimitiveType;
+    }[];
+    returns: PrimitiveType;
+    /**
+     * Either the path to the fetcher relative to `rootDir` or the npm
+     * package name
+     */
+    importPath: string;
+    /**
+     * Whether it's a default export or named export
+     */
+    isDefaultExport?: boolean;
+}
+export interface FetcherRegistration {
+    fetcher: Fetcher;
+    meta: FetcherMeta;
+}
+declare global {
+    interface Window {
+        __PlasmicFetcherRegistry: FetcherRegistration[];
+    }
+}
+export declare function registerFetcher(fetcher: Fetcher, meta: FetcherMeta): void;

package/dist/global-actions.d.ts

@@ -1,9 +1,9 @@
-import React from "react";
-export declare type GlobalActionDict = Record<string, Function>;
-export declare const GlobalActionsContext: React.Context<Record<string, Function> | undefined>;
-export declare function GlobalActionsProvider(props: {
-    contextName: string;
-    children?: React.ReactNode;
-    actions: GlobalActionDict;
-}): JSX.Element;
-export declare function useGlobalActions(): Record<string, Function>;
+import React from "react";
+export type GlobalActionDict = Record<string, Function>;
+export declare const GlobalActionsContext: React.Context<GlobalActionDict | undefined>;
+export declare function GlobalActionsProvider(props: {
+    contextName: string;
+    children?: React.ReactNode;
+    actions: GlobalActionDict;
+}): JSX.Element;
+export declare function useGlobalActions(): GlobalActionDict;