@plasmicapp/loader-react 1.0.253 → 1.0.255

package/dist/PlasmicComponent.d.ts

@@ -1,19 +1,19 @@
-import * as React from 'react';
-export declare function PlasmicComponent(props: {
-    /**
-     * Name of the component to render, or the path of the page component
-     */
-    component: string;
-    /**
-     * Optionally specify a projectId if there are multiple components
-     * of the same name from different projects
-     */
-    projectId?: string;
-    /**
-     * If you used registerComponent(), then if the name matches a registered
-     * component, that component is used.  If you want the Plasmic-generated
-     * component instead, specify forceOriginal.
-     */
-    forceOriginal?: boolean;
-    componentProps?: any;
-}): React.ReactElement | null;
+import * as React from "react";
+export declare function PlasmicComponent(props: {
+    /**
+     * Name of the component to render, or the path of the page component
+     */
+    component: string;
+    /**
+     * Optionally specify a projectId if there are multiple components
+     * of the same name from different projects
+     */
+    projectId?: string;
+    /**
+     * If you used registerComponent(), then if the name matches a registered
+     * component, that component is used.  If you want the Plasmic-generated
+     * component instead, specify forceOriginal.
+     */
+    forceOriginal?: boolean;
+    componentProps?: any;
+}): React.ReactElement | null;

package/dist/PlasmicRootProvider.d.ts

@@ -1,92 +1,92 @@
-import { PlasmicDataSourceContextValue } from '@plasmicapp/data-sources-context';
-import * as React from 'react';
-import { ComponentRenderData, InternalPlasmicComponentLoader, PlasmicComponentLoader } from './loader';
-interface PlasmicRootContextValue extends PlasmicDataSourceContextValue {
-    globalVariants?: GlobalVariantSpec[];
-    globalContextsProps?: Record<string, any>;
-    loader: InternalPlasmicComponentLoader;
-    variation?: Record<string, string>;
-    translator?: PlasmicTranslator;
-    Head?: React.ComponentType<any>;
-}
-export interface GlobalVariantSpec {
-    name: string;
-    projectId?: string;
-    value: any;
-}
-export declare type PlasmicTranslator = (str: string, opts?: {
-    components?: {
-        [key: string]: React.ReactElement | React.ReactFragment;
-    };
-}) => React.ReactNode;
-/**
- * PlasmicRootProvider should be used at the root of your page
- * or application.
- */
-export declare function PlasmicRootProvider(props: {
-    /**
-     * The global PlasmicComponentLoader instance you created via
-     * initPlasmicLoader().
-     */
-    loader: PlasmicComponentLoader;
-    /**
-     * Global variants to activate for Plasmic components
-     */
-    globalVariants?: GlobalVariantSpec[];
-    children?: React.ReactNode;
-    /**
-     * If true, will skip rendering css
-     */
-    skipCss?: boolean;
-    /**
-     * If true, will skip installing fonts
-     */
-    skipFonts?: boolean;
-    /**
-     * If you have pre-fetched component data via PlasmicComponentLoader,
-     * you can pass them in here; PlasmicComponent will avoid fetching
-     * component data that have already been pre-fetched.
-     */
-    prefetchedData?: ComponentRenderData;
-    /**
-     * If you have pre-fetched data that are needed by usePlasmicQueryData(),
-     * then pass in the pre-fetched cache here, mapping query key to fetched data.
-     */
-    prefetchedQueryData?: Record<string, any>;
-    /**
-     * Specifies whether usePlasmicQueryData() should be operating in suspense mode
-     * (throwing promises).
-     */
-    suspenseForQueryData?: boolean;
-    /**
-     * Override your Global Contexts Provider props. This is a map from
-     * globalContextComponentNameProps to object of props to use for that
-     * component.
-     */
-    globalContextsProps?: Record<string, any>;
-    /**
-     * Specifies a mapping of split id to slice id that should be activated
-     */
-    variation?: Record<string, string>;
-    /**
-     * Translator function to be used for text blocks
-     */
-    translator?: PlasmicTranslator;
-    /**
-     * Head component to use in PlasmicHead component (e.g. Head from next/head
-     * or Helmet from react-helmet).
-     */
-    Head?: React.ComponentType<any>;
-    /**
-     * Page path parameters (e.g. {slug: "foo"} if page path is
-     * /products/[slug] and URI is /products/foo).
-     */
-    pageParams?: Record<string, string | string[] | undefined>;
-    /**
-     * Page query parameters (e.g. {q: "foo"} if page path is
-     * /some/path?q=foo).
-     */
-    pageQuery?: Record<string, string | string[] | undefined>;
-} & PlasmicDataSourceContextValue): JSX.Element;
-export declare function usePlasmicRootContext(): PlasmicRootContextValue | undefined;
-export {};
+import { PlasmicDataSourceContextValue } from '@plasmicapp/data-sources-context';
+import * as React from 'react';
+import { ComponentRenderData, InternalPlasmicComponentLoader, PlasmicComponentLoader } from './loader';
+interface PlasmicRootContextValue extends PlasmicDataSourceContextValue {
+    globalVariants?: GlobalVariantSpec[];
+    globalContextsProps?: Record<string, any>;
+    loader: InternalPlasmicComponentLoader;
+    variation?: Record<string, string>;
+    translator?: PlasmicTranslator;
+    Head?: React.ComponentType<any>;
+}
+export interface GlobalVariantSpec {
+    name: string;
+    projectId?: string;
+    value: any;
+}
+export type PlasmicTranslator = (str: string, opts?: {
+    components?: {
+        [key: string]: React.ReactElement | React.ReactFragment;
+    };
+}) => React.ReactNode;
+/**
+ * PlasmicRootProvider should be used at the root of your page
+ * or application.
+ */
+export declare function PlasmicRootProvider(props: {
+    /**
+     * The global PlasmicComponentLoader instance you created via
+     * initPlasmicLoader().
+     */
+    loader: PlasmicComponentLoader;
+    /**
+     * Global variants to activate for Plasmic components
+     */
+    globalVariants?: GlobalVariantSpec[];
+    children?: React.ReactNode;
+    /**
+     * If true, will skip rendering css
+     */
+    skipCss?: boolean;
+    /**
+     * If true, will skip installing fonts
+     */
+    skipFonts?: boolean;
+    /**
+     * If you have pre-fetched component data via PlasmicComponentLoader,
+     * you can pass them in here; PlasmicComponent will avoid fetching
+     * component data that have already been pre-fetched.
+     */
+    prefetchedData?: ComponentRenderData;
+    /**
+     * If you have pre-fetched data that are needed by usePlasmicQueryData(),
+     * then pass in the pre-fetched cache here, mapping query key to fetched data.
+     */
+    prefetchedQueryData?: Record<string, any>;
+    /**
+     * Specifies whether usePlasmicQueryData() should be operating in suspense mode
+     * (throwing promises).
+     */
+    suspenseForQueryData?: boolean;
+    /**
+     * Override your Global Contexts Provider props. This is a map from
+     * globalContextComponentNameProps to object of props to use for that
+     * component.
+     */
+    globalContextsProps?: Record<string, any>;
+    /**
+     * Specifies a mapping of split id to slice id that should be activated
+     */
+    variation?: Record<string, string>;
+    /**
+     * Translator function to be used for text blocks
+     */
+    translator?: PlasmicTranslator;
+    /**
+     * Head component to use in PlasmicHead component (e.g. Head from next/head
+     * or Helmet from react-helmet).
+     */
+    Head?: React.ComponentType<any>;
+    /**
+     * Page path parameters (e.g. {slug: "foo"} if page path is
+     * /products/[slug] and URI is /products/foo).
+     */
+    pageParams?: Record<string, string | string[] | undefined>;
+    /**
+     * Page query parameters (e.g. {q: "foo"} if page path is
+     * /some/path?q=foo).
+     */
+    pageQuery?: Record<string, string | string[] | undefined>;
+} & PlasmicDataSourceContextValue): JSX.Element;
+export declare function usePlasmicRootContext(): PlasmicRootContextValue | undefined;
+export {};

package/dist/bundles.d.ts

@@ -1,7 +1,7 @@
-import { ComponentMeta, LoaderBundleOutput } from '@plasmicapp/loader-core';
-import type { ComponentRenderData } from './loader';
-export declare function prepComponentData(bundle: LoaderBundleOutput, compMetas: ComponentMeta[], opts?: {
-    target?: 'browser' | 'server';
-}): ComponentRenderData;
-export declare function mergeBundles(target: LoaderBundleOutput, from: LoaderBundleOutput): LoaderBundleOutput;
-export declare const convertBundlesToComponentRenderData: (bundles: LoaderBundleOutput[], compMetas: ComponentMeta[]) => ComponentRenderData | null;
+import { ComponentMeta, LoaderBundleOutput } from '@plasmicapp/loader-core';
+import type { ComponentRenderData } from './loader';
+export declare function prepComponentData(bundle: LoaderBundleOutput, compMetas: ComponentMeta[], opts?: {
+    target?: 'browser' | 'server';
+}): ComponentRenderData;
+export declare function mergeBundles(target: LoaderBundleOutput, from: LoaderBundleOutput): LoaderBundleOutput;
+export declare const convertBundlesToComponentRenderData: (bundles: LoaderBundleOutput[], compMetas: ComponentMeta[]) => ComponentRenderData | null;

package/dist/component-lookup.d.ts

@@ -1,21 +1,21 @@
-import { AssetModule, ComponentMeta, FontMeta, GlobalGroupMeta, LoaderBundleOutput, Registry } from '@plasmicapp/loader-core';
-import * as React from 'react';
-import { ComponentLookupSpec } from './utils';
-export declare class ComponentLookup {
-    private bundle;
-    private registry;
-    constructor(bundle: LoaderBundleOutput, registry: Registry);
-    getComponentMeta(spec: ComponentLookupSpec): ComponentMeta | undefined;
-    getComponent<P extends React.ComponentType = any>(spec: ComponentLookupSpec, opts?: {
-        forceOriginal?: boolean;
-    }): any;
-    hasComponent(spec: ComponentLookupSpec): boolean;
-    getGlobalContexts(): {
-        meta: GlobalGroupMeta;
-        context: any;
-    }[];
-    getGlobalContextsProvider(spec: ComponentLookupSpec): any;
-    getRootProvider(): any;
-    getCss(): AssetModule[];
-    getRemoteFonts(): FontMeta[];
-}
+import { AssetModule, ComponentMeta, FontMeta, GlobalGroupMeta, LoaderBundleOutput, Registry } from '@plasmicapp/loader-core';
+import * as React from 'react';
+import { ComponentLookupSpec } from './utils';
+export declare class ComponentLookup {
+    private bundle;
+    private registry;
+    constructor(bundle: LoaderBundleOutput, registry: Registry);
+    getComponentMeta(spec: ComponentLookupSpec): ComponentMeta | undefined;
+    getComponent<P extends React.ComponentType = any>(spec: ComponentLookupSpec, opts?: {
+        forceOriginal?: boolean;
+    }): any;
+    hasComponent(spec: ComponentLookupSpec): boolean;
+    getGlobalContexts(): {
+        meta: GlobalGroupMeta;
+        context: any;
+    }[];
+    getGlobalContextsProvider(spec: ComponentLookupSpec): any;
+    getRootProvider(): any;
+    getCss(): AssetModule[];
+    getRemoteFonts(): FontMeta[];
+}

package/dist/global-variants.d.ts

@@ -1,13 +1,13 @@
-/**
- * We don't actually make use of the global variant React contexts generated
- * in the bundle.  That's because we would have to wait until the data is
- * loaded before we can set up the context providers, but setting up context
- * providers will mutate the React tree and invalidate all the children. That means
- * once data comes in, we'll re-render the React tree from the providers down
- * in a way that will lose all existing React state.  Therefore, instead,
- * we always have a single context provided -- the PlasmicRootContext -- and we
- * create these fake useGlobalVariant() hooks that just read from that
- * PlasmicRootContext.  This allows us to have a stable React tree before and
- * after the data load.
- */
-export declare function createUseGlobalVariant(name: string, projectId: string): () => any;
+/**
+ * We don't actually make use of the global variant React contexts generated
+ * in the bundle.  That's because we would have to wait until the data is
+ * loaded before we can set up the context providers, but setting up context
+ * providers will mutate the React tree and invalidate all the children. That means
+ * once data comes in, we'll re-render the React tree from the providers down
+ * in a way that will lose all existing React state.  Therefore, instead,
+ * we always have a single context provided -- the PlasmicRootContext -- and we
+ * create these fake useGlobalVariant() hooks that just read from that
+ * PlasmicRootContext.  This allows us to have a stable React tree before and
+ * after the data load.
+ */
+export declare function createUseGlobalVariant(name: string, projectId: string): () => any;

package/dist/index.d.ts

@@ -1,12 +1,15 @@
-import { CodeComponentMeta, InternalPlasmicComponentLoader, PlasmicComponentLoader } from './loader';
-import type { InitOptions } from './loader-react-server';
-export { DataCtxReader, DataProvider, PageParamsProvider, PlasmicCanvasContext, PlasmicCanvasHost, PrimitiveType, PropType, repeatedElement, TokenRegistration, useDataEnv, usePlasmicCanvasContext, useSelector, useSelectors, } from '@plasmicapp/host';
-export { usePlasmicQueryData } from '@plasmicapp/query';
-export * from './index-shared';
-export { PlasmicComponent } from './PlasmicComponent';
-export { GlobalVariantSpec, PlasmicRootProvider, PlasmicTranslator, } from './PlasmicRootProvider';
-export { extractPlasmicQueryData, plasmicPrepass } from './prepass';
-export { extractPlasmicQueryDataFromElement, hydrateFromElement, renderToElement, renderToString, } from './render';
-export { usePlasmicComponent } from './usePlasmicComponent';
-export { InternalPlasmicComponentLoader, PlasmicComponentLoader, CodeComponentMeta, };
-export declare function initPlasmicLoader(opts: InitOptions): PlasmicComponentLoader;
+import { CodeComponentMeta, InternalPlasmicComponentLoader, PlasmicComponentLoader } from "./loader";
+import type { InitOptions } from "./loader-react-server";
+export type { PrimitiveType, PropType, TokenRegistration, } from "@plasmicapp/host";
+export { DataCtxReader, DataProvider, PageParamsProvider, PlasmicCanvasContext, PlasmicCanvasHost, repeatedElement, useDataEnv, usePlasmicCanvasContext, useSelector, useSelectors, } from "@plasmicapp/host";
+export { usePlasmicQueryData } from "@plasmicapp/query";
+export * from "./shared-exports";
+export { PlasmicComponent } from "./PlasmicComponent";
+export type { GlobalVariantSpec, PlasmicTranslator, } from "./PlasmicRootProvider";
+export { PlasmicRootProvider } from "./PlasmicRootProvider";
+export { extractPlasmicQueryData, plasmicPrepass } from "./prepass";
+export { extractPlasmicQueryDataFromElement, hydrateFromElement, renderToElement, renderToString, } from "./render";
+export { usePlasmicComponent } from "./usePlasmicComponent";
+export type { CodeComponentMeta };
+export { InternalPlasmicComponentLoader, PlasmicComponentLoader };
+export declare function initPlasmicLoader(opts: InitOptions): PlasmicComponentLoader;