@plasmicapp/host 1.0.14 → 1.0.17

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@plasmicapp/host",
-  "version": "1.0.14",
+  "version": "1.0.17",
   "description": "plasmic library for app hosting",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "module": "dist/host.esm.js",
   "files": [
     "dist",
-    "registerComponent"
+    "registerComponent",
+    "registerGlobalContext"
   ],
   "size-limit": [
     {
@@ -29,7 +30,7 @@
     "analyze": "size-limit --why"
   },
   "dependencies": {
-    "@plasmicapp/preamble": "0.0.47",
+    "@plasmicapp/preamble": "0.0.50",
     "window-or-global": "^1.0.1"
   },
   "devDependencies": {
@@ -39,8 +40,8 @@
     "@size-limit/preset-small-lib": "^4.11.0",
     "@types/classnames": "^2.2.9",
     "@types/node": "^14.0.26",
-    "@types/react": "^16.9.46",
-    "@types/react-dom": "^16.9.8",
+    "@types/react": "^17.0.39",
+    "@types/react-dom": "^17.0.11",
     "csstype": "^3.0.8",
     "rollup": "^2.47.0",
     "rollup-plugin-dts": "^3.0.1",

package/registerGlobalContext/dist/element-types.d.ts

@@ -0,0 +1,103 @@
+import type { Properties } from "csstype";
+export declare type CSSProperties = Properties<string | number>;
+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";
+    /**
+     * 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 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<{}>;
+export {};

package/registerGlobalContext/dist/index.cjs.js

@@ -0,0 +1,14 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var root = globalThis;
+if (root.__PlasmicContextRegistry == null) {
+    root.__PlasmicContextRegistry = [];
+}
+function registerGlobalContext(component, meta) {
+    root.__PlasmicContextRegistry.push({ component: component, meta: meta });
+}
+
+exports['default'] = registerGlobalContext;
+//# sourceMappingURL=index.cjs.js.map

package/registerGlobalContext/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../../src/registerGlobalContext.ts"],"sourcesContent":["import {\n  BooleanType,\n  ChoiceType,\n  CustomType,\n  JSONLikeType,\n  NumberType,\n  StringType,\n  SupportControlled,\n} from \"./registerComponent\";\n\nconst root = globalThis as any;\n\nexport type PropType<P> = SupportControlled<\n  | StringType<P>\n  | BooleanType<P>\n  | NumberType<P>\n  | JSONLikeType<P>\n  | ChoiceType<P>\n  | CustomType<P>\n>;\n\ntype RestrictPropType<T, P> = T extends string\n  ? SupportControlled<\n      StringType<P> | ChoiceType<P> | JSONLikeType<P> | CustomType<P>\n    >\n  : T extends boolean\n  ? SupportControlled<BooleanType<P> | JSONLikeType<P> | CustomType<P>>\n  : T extends number\n  ? SupportControlled<NumberType<P> | JSONLikeType<P> | CustomType<P>>\n  : PropType<P>;\n\ntype DistributedKeyOf<T> = T extends any ? keyof T : never;\n\nexport interface GlobalContextMeta<P> {\n  /**\n   * Any unique string name used to identify that context. Each context\n   * should be registered with a different `meta.name`, even if they have the\n   * same name in the code.\n   */\n  name: string;\n  /**\n   * The name to be displayed for the context in Studio. Optional: if not\n   * specified, `meta.name` is used.\n   */\n  displayName?: string;\n  /**\n   * The javascript name to be used when generating code. Optional: if not\n   * provided, `meta.name` is used.\n   */\n  importName?: string;\n  /**\n   * An object describing the context properties to be used in Studio.\n   * For each `prop`, there should be an entry `meta.props[prop]` describing\n   * its type.\n   */\n  props: { [prop in DistributedKeyOf<P>]?: RestrictPropType<P[prop], P> } & {\n    [prop: string]: PropType<P>;\n  };\n  /**\n   * The path to be used when importing the context in the generated code.\n   * It can be the name of the package that contains the context, or the path\n   * to the file in the project (relative to the root directory).\n   */\n  importPath: string;\n  /**\n   *  Whether the context is the default export from that path. Optional: if\n   * not specified, it's considered `false`.\n   */\n  isDefaultExport?: boolean;\n  /**\n   * The prop that receives and forwards a React `ref`. Plasmic only uses `ref`\n   * to interact with components, so it's not used in the generated code.\n   * Optional: If not provided, the usual `ref` is used.\n   */\n  refProp?: string;\n}\n\nexport interface GlobalContextRegistration {\n  component: React.ComponentType<any>;\n  meta: GlobalContextMeta<any>;\n}\n\ndeclare global {\n  interface Window {\n    __PlasmicContextRegistry: GlobalContextRegistration[];\n  }\n}\n\nif (root.__PlasmicContextRegistry == null) {\n  root.__PlasmicContextRegistry = [];\n}\n\nexport default function registerGlobalContext<\n  T extends React.ComponentType<any>\n>(component: T, meta: GlobalContextMeta<React.ComponentProps<T>>) {\n  root.__PlasmicContextRegistry.push({ component, meta });\n}\n"],"names":[],"mappings":";;;;AAUA,IAAM,IAAI,GAAG,UAAiB,CAAC;AA8E/B,IAAI,IAAI,CAAC,wBAAwB,IAAI,IAAI,EAAE;IACzC,IAAI,CAAC,wBAAwB,GAAG,EAAE,CAAC;CACpC;SAEuB,qBAAqB,CAE3C,SAAY,EAAE,IAAgD;IAC9D,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,EAAE,SAAS,WAAA,EAAE,IAAI,MAAA,EAAE,CAAC,CAAC;AAC1D;;;;"}

package/registerGlobalContext/dist/index.esm.js

@@ -0,0 +1,10 @@
+var root = globalThis;
+if (root.__PlasmicContextRegistry == null) {
+    root.__PlasmicContextRegistry = [];
+}
+function registerGlobalContext(component, meta) {
+    root.__PlasmicContextRegistry.push({ component: component, meta: meta });
+}
+
+export { registerGlobalContext as default };
+//# sourceMappingURL=index.esm.js.map

package/registerGlobalContext/dist/index.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.esm.js","sources":["../../src/registerGlobalContext.ts"],"sourcesContent":["import {\n  BooleanType,\n  ChoiceType,\n  CustomType,\n  JSONLikeType,\n  NumberType,\n  StringType,\n  SupportControlled,\n} from \"./registerComponent\";\n\nconst root = globalThis as any;\n\nexport type PropType<P> = SupportControlled<\n  | StringType<P>\n  | BooleanType<P>\n  | NumberType<P>\n  | JSONLikeType<P>\n  | ChoiceType<P>\n  | CustomType<P>\n>;\n\ntype RestrictPropType<T, P> = T extends string\n  ? SupportControlled<\n      StringType<P> | ChoiceType<P> | JSONLikeType<P> | CustomType<P>\n    >\n  : T extends boolean\n  ? SupportControlled<BooleanType<P> | JSONLikeType<P> | CustomType<P>>\n  : T extends number\n  ? SupportControlled<NumberType<P> | JSONLikeType<P> | CustomType<P>>\n  : PropType<P>;\n\ntype DistributedKeyOf<T> = T extends any ? keyof T : never;\n\nexport interface GlobalContextMeta<P> {\n  /**\n   * Any unique string name used to identify that context. Each context\n   * should be registered with a different `meta.name`, even if they have the\n   * same name in the code.\n   */\n  name: string;\n  /**\n   * The name to be displayed for the context in Studio. Optional: if not\n   * specified, `meta.name` is used.\n   */\n  displayName?: string;\n  /**\n   * The javascript name to be used when generating code. Optional: if not\n   * provided, `meta.name` is used.\n   */\n  importName?: string;\n  /**\n   * An object describing the context properties to be used in Studio.\n   * For each `prop`, there should be an entry `meta.props[prop]` describing\n   * its type.\n   */\n  props: { [prop in DistributedKeyOf<P>]?: RestrictPropType<P[prop], P> } & {\n    [prop: string]: PropType<P>;\n  };\n  /**\n   * The path to be used when importing the context in the generated code.\n   * It can be the name of the package that contains the context, or the path\n   * to the file in the project (relative to the root directory).\n   */\n  importPath: string;\n  /**\n   *  Whether the context is the default export from that path. Optional: if\n   * not specified, it's considered `false`.\n   */\n  isDefaultExport?: boolean;\n  /**\n   * The prop that receives and forwards a React `ref`. Plasmic only uses `ref`\n   * to interact with components, so it's not used in the generated code.\n   * Optional: If not provided, the usual `ref` is used.\n   */\n  refProp?: string;\n}\n\nexport interface GlobalContextRegistration {\n  component: React.ComponentType<any>;\n  meta: GlobalContextMeta<any>;\n}\n\ndeclare global {\n  interface Window {\n    __PlasmicContextRegistry: GlobalContextRegistration[];\n  }\n}\n\nif (root.__PlasmicContextRegistry == null) {\n  root.__PlasmicContextRegistry = [];\n}\n\nexport default function registerGlobalContext<\n  T extends React.ComponentType<any>\n>(component: T, meta: GlobalContextMeta<React.ComponentProps<T>>) {\n  root.__PlasmicContextRegistry.push({ component, meta });\n}\n"],"names":[],"mappings":"AAUA,IAAM,IAAI,GAAG,UAAiB,CAAC;AA8E/B,IAAI,IAAI,CAAC,wBAAwB,IAAI,IAAI,EAAE;IACzC,IAAI,CAAC,wBAAwB,GAAG,EAAE,CAAC;CACpC;SAEuB,qBAAqB,CAE3C,SAAY,EAAE,IAAgD;IAC9D,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,EAAE,SAAS,WAAA,EAAE,IAAI,MAAA,EAAE,CAAC,CAAC;AAC1D;;;;"}

package/registerGlobalContext/dist/registerComponent.d.ts

@@ -0,0 +1,244 @@
+/// <reference types="react" />
+import { CodeComponentElement, CSSProperties, PlasmicElement } from "./element-types";
+export interface CanvasComponentProps<Data = any> {
+    /**
+     * This prop is only provided within the canvas of Plasmic Studio.
+     * Allows the component to set data to be consumed by the props' controls.
+     */
+    setControlContextData?: (data: Data) => void;
+}
+declare type InferDataType<P> = P extends CanvasComponentProps<infer Data> ? Data : any;
+/**
+ * Config option that takes the context (e.g., props) of the component instance
+ * to dynamically set its value.
+ */
+declare type ContextDependentConfig<P, R> = (props: 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;
+interface PropTypeBase<P> {
+    displayName?: string;
+    description?: string;
+    hidden?: ContextDependentConfig<P, boolean>;
+}
+interface StringTypeBase<P> extends PropTypeBase<P> {
+    defaultValue?: string;
+    defaultValueHint?: string;
+}
+export declare type StringType<P> = "string" | (({
+    type: "string";
+    control?: "default" | "large";
+} | {
+    type: "code";
+    lang: "css" | "html" | "javascript" | "json";
+}) & StringTypeBase<P>);
+export declare type BooleanType<P> = "boolean" | ({
+    type: "boolean";
+    defaultValue?: boolean;
+    defaultValueHint?: boolean;
+} & PropTypeBase<P>);
+interface NumberTypeBase<P> extends PropTypeBase<P> {
+    type: "number";
+    defaultValue?: number;
+    defaultValueHint?: number;
+}
+export declare type NumberType<P> = "number" | (({
+    control?: "default";
+    min?: number | ContextDependentConfig<P, number>;
+    max?: number | ContextDependentConfig<P, number>;
+} | {
+    control: "slider";
+    min: number | ContextDependentConfig<P, number>;
+    max: number | ContextDependentConfig<P, number>;
+    step?: number | ContextDependentConfig<P, number>;
+}) & NumberTypeBase<P>);
+export declare type JSONLikeType<P> = "object" | ({
+    type: "object";
+    /**
+     * Expects a JSON-compatible value
+     */
+    defaultValue?: any;
+    defaultValueHint?: any;
+} & PropTypeBase<P>);
+interface ChoiceTypeBase<P> extends PropTypeBase<P> {
+    type: "choice";
+    options: string[] | {
+        label: string;
+        value: string | number | boolean;
+    }[] | ContextDependentConfig<P, string[] | {
+        label: string;
+        value: string | number | boolean;
+    }[]>;
+}
+export declare type ChoiceType<P> = ({
+    defaultValue?: string;
+    defaultValueHint?: string;
+    multiSelect?: false;
+} | {
+    defaultValue?: string[];
+    defaultValueHint?: string[];
+    multiSelect: true;
+}) & ChoiceTypeBase<P>;
+export interface ModalProps {
+    show?: boolean;
+    children?: React.ReactNode;
+    onClose: () => void;
+    style?: CSSProperties;
+}
+interface CustomControlProps<P> {
+    componentProps: 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;
+    value: any;
+    /**
+     * Sets the value to be passed to the prop. Expects a JSON-compatible value.
+     */
+    updateValue: (newVal: any) => void;
+    /**
+     * Full screen modal component
+     */
+    FullscreenModal: React.ComponentType<ModalProps>;
+    /**
+     * Modal component for the side pane
+     */
+    SideModal: React.ComponentType<ModalProps>;
+}
+export declare type CustomControl<P> = React.ComponentType<CustomControlProps<P>>;
+export declare type CustomType<P> = CustomControl<P> | ({
+    type: "custom";
+    control: CustomControl<P>;
+    /**
+     * Expects a JSON-compatible value
+     */
+    defaultValue?: any;
+} & PropTypeBase<P>);
+declare type SlotType = "slot" | {
+    type: "slot";
+    /**
+     * The unique names of all code components that can be placed in the slot
+     */
+    allowedComponents?: string[];
+    defaultValue?: PlasmicElement | PlasmicElement[];
+    /**
+     * Whether the "empty slot" placeholder should be hidden in the canvas.
+     */
+    hidePlaceholder?: boolean;
+};
+declare type ImageUrlType<P> = "imageUrl" | ({
+    type: "imageUrl";
+    defaultValue?: string;
+    defaultValueHint?: string;
+} & PropTypeBase<P>);
+export declare type PrimitiveType<P = any> = Extract<StringType<P> | BooleanType<P> | NumberType<P> | JSONLikeType<P>, String>;
+declare type ControlTypeBase = {
+    editOnly?: false;
+} | {
+    editOnly: true;
+    /**
+     * The prop where the values should be mapped to
+     */
+    uncontrolledProp?: string;
+};
+export declare type SupportControlled<T> = Extract<T, String | CustomControl<any>> | (Exclude<T, String | CustomControl<any>> & ControlTypeBase);
+export declare type PropType<P> = SupportControlled<StringType<P> | BooleanType<P> | NumberType<P> | JSONLikeType<P> | ChoiceType<P> | ImageUrlType<P> | CustomType<P>> | SlotType;
+declare type RestrictPropType<T, P> = T extends string ? SupportControlled<StringType<P> | ChoiceType<P> | JSONLikeType<P> | ImageUrlType<P> | CustomType<P>> : T extends boolean ? SupportControlled<BooleanType<P> | JSONLikeType<P> | CustomType<P>> : T extends number ? SupportControlled<NumberType<P> | JSONLikeType<P> | CustomType<P>> : PropType<P>;
+declare type DistributedKeyOf<T> = T extends any ? keyof T : never;
+interface ComponentTemplate<P> extends Omit<CodeComponentElement<P>, "type" | "name"> {
+    /**
+     * A preview picture for the template.
+     */
+    previewImg?: string;
+}
+export interface ComponentTemplates<P> {
+    [name: string]: ComponentTemplate<P>;
+}
+export interface ComponentMeta<P> {
+    /**
+     * Any unique string name used to identify that component. Each component
+     * should be registered with a different `meta.name`, even if they have the
+     * same name in the code.
+     */
+    name: string;
+    /**
+     * The name to be displayed for the component in Studio. Optional: if not
+     * specified, `meta.name` is used.
+     */
+    displayName?: string;
+    /**
+     * The description of the component to be shown in Studio.
+     */
+    description?: string;
+    /**
+     * The javascript name to be used when generating code. Optional: if not
+     * provided, `meta.name` is used.
+     */
+    importName?: string;
+    /**
+     * An object describing the component properties to be used in Studio.
+     * For each `prop`, there should be an entry `meta.props[prop]` describing
+     * its type.
+     */
+    props: {
+        [prop in DistributedKeyOf<P>]?: RestrictPropType<P[prop], P>;
+    } & {
+        [prop: string]: PropType<P>;
+    };
+    /**
+     * The path to be used when importing the component in the generated code.
+     * It can be the name of the package that contains the component, or the path
+     * to the file in the project (relative to the root directory).
+     */
+    importPath: string;
+    /**
+     *  Whether the component is the default export from that path. Optional: if
+     * not specified, it's considered `false`.
+     */
+    isDefaultExport?: boolean;
+    /**
+     * The prop that expects the CSS classes with styles to be applied to the
+     * component. Optional: if not specified, Plasmic will expect it to be
+     * `className`. Notice that if the component does not accept CSS classes, the
+     * component will not be able to receive styles from the Studio.
+     */
+    classNameProp?: string;
+    /**
+     * The prop that receives and forwards a React `ref`. Plasmic only uses `ref`
+     * to interact with components, so it's not used in the generated code.
+     * Optional: If not provided, the usual `ref` is used.
+     */
+    refProp?: string;
+    /**
+     * Default styles to start with when instantiating the component in Plasmic.
+     */
+    defaultStyles?: CSSProperties;
+    /**
+     * Component templates to start with on Plasmic.
+     */
+    templates?: ComponentTemplates<P>;
+    /**
+     * Registered name of parent component, used for grouping related components.
+     */
+    parentComponentName?: string;
+    /**
+     * Whether the component can be used as an attachment to an element.
+     */
+    isAttachment?: boolean;
+}
+export interface ComponentRegistration {
+    component: React.ComponentType<any>;
+    meta: ComponentMeta<any>;
+}
+declare global {
+    interface Window {
+        __PlasmicComponentRegistry: ComponentRegistration[];
+    }
+}
+export default function registerComponent<T extends React.ComponentType<any>>(component: T, meta: ComponentMeta<React.ComponentProps<T>>): void;
+export {};

package/registerGlobalContext/dist/registerGlobalContext.d.ts

@@ -0,0 +1,61 @@
+/// <reference types="react" />
+import { BooleanType, ChoiceType, CustomType, JSONLikeType, NumberType, StringType, SupportControlled } from "./registerComponent";
+export declare type PropType<P> = SupportControlled<StringType<P> | BooleanType<P> | NumberType<P> | JSONLikeType<P> | ChoiceType<P> | CustomType<P>>;
+declare type RestrictPropType<T, P> = T extends string ? SupportControlled<StringType<P> | ChoiceType<P> | JSONLikeType<P> | CustomType<P>> : T extends boolean ? SupportControlled<BooleanType<P> | JSONLikeType<P> | CustomType<P>> : T extends number ? SupportControlled<NumberType<P> | JSONLikeType<P> | CustomType<P>> : PropType<P>;
+declare type DistributedKeyOf<T> = T extends any ? keyof T : never;
+export interface GlobalContextMeta<P> {
+    /**
+     * Any unique string name used to identify that context. Each context
+     * should be registered with a different `meta.name`, even if they have the
+     * same name in the code.
+     */
+    name: string;
+    /**
+     * The name to be displayed for the context in Studio. Optional: if not
+     * specified, `meta.name` is used.
+     */
+    displayName?: string;
+    /**
+     * The javascript name to be used when generating code. Optional: if not
+     * provided, `meta.name` is used.
+     */
+    importName?: string;
+    /**
+     * An object describing the context properties to be used in Studio.
+     * For each `prop`, there should be an entry `meta.props[prop]` describing
+     * its type.
+     */
+    props: {
+        [prop in DistributedKeyOf<P>]?: RestrictPropType<P[prop], P>;
+    } & {
+        [prop: string]: PropType<P>;
+    };
+    /**
+     * The path to be used when importing the context in the generated code.
+     * It can be the name of the package that contains the context, or the path
+     * to the file in the project (relative to the root directory).
+     */
+    importPath: string;
+    /**
+     *  Whether the context is the default export from that path. Optional: if
+     * not specified, it's considered `false`.
+     */
+    isDefaultExport?: boolean;
+    /**
+     * The prop that receives and forwards a React `ref`. Plasmic only uses `ref`
+     * to interact with components, so it's not used in the generated code.
+     * Optional: If not provided, the usual `ref` is used.
+     */
+    refProp?: string;
+}
+export interface GlobalContextRegistration {
+    component: React.ComponentType<any>;
+    meta: GlobalContextMeta<any>;
+}
+declare global {
+    interface Window {
+        __PlasmicContextRegistry: GlobalContextRegistration[];
+    }
+}
+export default function registerGlobalContext<T extends React.ComponentType<any>>(component: T, meta: GlobalContextMeta<React.ComponentProps<T>>): void;
+export {};

package/registerGlobalContext/package.json

@@ -0,0 +1,5 @@
+{
+  "main": "dist/index.cjs.js",
+  "types": "dist/registerGlobalContext.d.ts",
+  "module": "dist/index.esm.js"
+}