@plasmicapp/loader-react 1.0.252 → 1.0.254

package/dist/loader.d.ts

@@ -1,173 +1,173 @@
-import { CodeComponentMeta as InternalCodeComponentMeta, GlobalContextMeta as InternalGlobalContextMeta, StateHelpers, StateSpec, TokenRegistration, TraitMeta } from '@plasmicapp/host';
-import { ComponentMeta, LoaderBundleOutput, TrackRenderOptions } from '@plasmicapp/loader-core';
-import React from 'react';
-import { ComponentLookup } from './component-lookup';
-import { FetchComponentDataOpts, InitOptions } from './loader-react-server';
-import type { GlobalVariantSpec } from './PlasmicRootProvider';
-import { ComponentLookupSpec } from './utils';
-export interface ComponentRenderData {
-    entryCompMetas: (ComponentMeta & {
-        params?: Record<string, string>;
-    })[];
-    bundle: LoaderBundleOutput;
-    remoteFontUrls: string[];
-}
-interface PlasmicRootWatcher {
-    onDataFetched?: () => void;
-}
-export declare type CodeComponentMeta<P> = Omit<InternalCodeComponentMeta<P>, 'importPath' | 'componentHelpers' | 'states'> & {
-    /**
-     * 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).
-     * Optional: not used by Plasmic headless API, only by codegen.
-     */
-    importPath?: string;
-    /**
-     * The states helpers are registered together with the states for the Plasmic headless API
-     */
-    states?: Record<string, StateSpec & StateHelpers<P, any>>;
-};
-export declare type GlobalContextMeta<P> = Omit<InternalGlobalContextMeta<P>, 'importPath'> & {
-    /**
-     * 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).
-     * Optional: not used by Plasmic headless API, only by codegen.
-     */
-    importPath?: string;
-};
-export declare type FetchPagesOpts = {
-    /**
-     * Whether to include dynamic pages in fetchPages() output. A page is
-     * considered dynamic if its path contains some param between brackets,
-     * e.g. "[slug]".
-     */
-    includeDynamicPages?: boolean;
-};
-export declare class InternalPlasmicComponentLoader {
-    private opts;
-    private readonly reactServerLoader;
-    private readonly registry;
-    private subs;
-    private roots;
-    private globalVariants;
-    private tracker;
-    constructor(opts: InitOptions);
-    getBundle(): LoaderBundleOutput;
-    setGlobalVariants(globalVariants: GlobalVariantSpec[]): void;
-    getGlobalVariants(): GlobalVariantSpec[];
-    registerModules(modules: Record<string, any>): void;
-    substituteComponent<P>(component: React.ComponentType<P>, name: ComponentLookupSpec): void;
-    private internalSubstituteComponent;
-    registerComponent<T extends React.ComponentType<any>>(component: T, meta: CodeComponentMeta<React.ComponentProps<T>>): void;
-    registerGlobalContext<T extends React.ComponentType<any>>(context: T, meta: GlobalContextMeta<React.ComponentProps<T>>): void;
-    registerTrait(trait: string, meta: TraitMeta): void;
-    registerToken(token: TokenRegistration): void;
-    registerPrefetchedBundle(bundle: LoaderBundleOutput): void;
-    subscribePlasmicRoot(watcher: PlasmicRootWatcher): void;
-    unsubscribePlasmicRoot(watcher: PlasmicRootWatcher): void;
-    clearCache(): void;
-    getLookup(): ComponentLookup;
-    maybeFetchComponentData(specs: ComponentLookupSpec[], opts?: FetchComponentDataOpts): Promise<ComponentRenderData | null>;
-    maybeFetchComponentData(...specs: ComponentLookupSpec[]): Promise<ComponentRenderData | null>;
-    fetchComponentData(specs: ComponentLookupSpec[], opts?: FetchComponentDataOpts): Promise<ComponentRenderData>;
-    fetchComponentData(...specs: ComponentLookupSpec[]): Promise<ComponentRenderData>;
-    fetchPages(opts?: FetchPagesOpts): Promise<import("@plasmicapp/loader-core").PageMeta[]>;
-    fetchComponents(): Promise<ComponentMeta[]>;
-    getActiveSplits(): import("@plasmicapp/loader-core").Split[];
-    trackConversion(value?: number): void;
-    getActiveVariation(opts: {
-        traits: Record<string, string | number | boolean>;
-        getKnownValue: (key: string) => string | undefined;
-        updateKnownValue: (key: string, value: string) => void;
-    }): Promise<Record<string, string>>;
-    getTeamIds(): string[];
-    getProjectIds(): string[];
-    trackRender(opts?: TrackRenderOptions): void;
-    private refreshRegistry;
-}
-/**
- * Library for fetching component data, and registering
- * custom components.
- */
-export declare class PlasmicComponentLoader {
-    private __internal;
-    constructor(internal: InternalPlasmicComponentLoader);
-    /**
-     * Sets global variants to be used for all components.  Note that
-     * this is not reactive, and will not re-render all components
-     * already mounted; instead, it should be used to activate global
-     * variants that should always be activated for the lifetime of this
-     * app.  If you'd like to reactively change the global variants,
-     * you should specify them via <PlasmicRootProvider />
-     */
-    setGlobalVariants(globalVariants: GlobalVariantSpec[]): void;
-    registerModules(modules: Record<string, any>): void;
-    /**
-     * Register custom components that should be swapped in for
-     * components defined in your project.  You can use this to
-     * swap in / substitute a Plasmic component with a "real" component.
-     */
-    substituteComponent<P>(component: React.ComponentType<P>, name: ComponentLookupSpec): void;
-    /**
-     * Register code components to be used on Plasmic Editor.
-     */
-    registerComponent<T extends React.ComponentType<any>>(component: T, meta: CodeComponentMeta<React.ComponentProps<T>>): void;
-    /**
-     * [[deprecated]] Please use `substituteComponent` instead for component
-     * substitution, or the other `registerComponent` overload to register
-     * code components to be used on Plasmic Editor.
-     *
-     * @see `substituteComponent`
-     */
-    registerComponent<T extends React.ComponentType<any>>(component: T, name: ComponentLookupSpec): void;
-    private warnedRegisterComponent;
-    registerGlobalContext<T extends React.ComponentType<any>>(context: T, meta: GlobalContextMeta<React.ComponentProps<T>>): void;
-    registerTrait(trait: string, meta: TraitMeta): void;
-    registerToken(token: TokenRegistration): void;
-    /**
-     * Pre-fetches component data needed to for PlasmicLoader to render
-     * these components.  Should be passed into PlasmicRootProvider as
-     * the prefetchedData prop.
-     *
-     * You can look up a component either by:
-     * - the name of the component
-     * - the path for a page component
-     * - an array of strings that make up parts of the path
-     * - object { name: "name_or_path", projectId: ...}, to specify which project
-     *   to use, if multiple projects have the same component name
-     *
-     * Throws an Error if a specified component to fetch does not exist in
-     * the Plasmic project.
-     */
-    fetchComponentData(...specs: ComponentLookupSpec[]): Promise<ComponentRenderData>;
-    /**
-     * Like fetchComponentData(), but returns null instead of throwing an Error
-     * when a component is not found.  Useful when you are implementing a catch-all
-     * page and want to check if a specific path had been defined for Plasmic.
-     */
-    maybeFetchComponentData(...specs: ComponentLookupSpec[]): Promise<ComponentRenderData | null>;
-    /**
-     * Returns all the page component metadata for these projects.
-     */
-    fetchPages(opts?: FetchPagesOpts): Promise<import("@plasmicapp/loader-core").PageMeta[]>;
-    /**
-     * Returns all components metadata for these projects.
-     */
-    fetchComponents(): Promise<ComponentMeta[]>;
-    protected _getActiveVariation(opts: {
-        traits: Record<string, string | number | boolean>;
-        getKnownValue: (key: string) => string | undefined;
-        updateKnownValue: (key: string, value: string) => void;
-    }): Promise<Record<string, string>>;
-    getActiveVariation(opts: {
-        known?: Record<string, string>;
-        traits: Record<string, string | number | boolean>;
-    }): Promise<Record<string, string>>;
-    getExternalVariation(variation: Record<string, string>): Record<string, string>;
-    getActiveSplits(): import("@plasmicapp/loader-core").Split[];
-    trackConversion(value?: number): void;
-    clearCache(): void;
-}
-export {};
+import { CodeComponentMeta as InternalCodeComponentMeta, GlobalContextMeta as InternalGlobalContextMeta, StateHelpers, StateSpec, TokenRegistration, TraitMeta } from '@plasmicapp/host';
+import { ComponentMeta, LoaderBundleOutput, TrackRenderOptions } from '@plasmicapp/loader-core';
+import React from 'react';
+import { ComponentLookup } from './component-lookup';
+import { FetchComponentDataOpts, InitOptions } from './loader-react-server';
+import type { GlobalVariantSpec } from './PlasmicRootProvider';
+import { ComponentLookupSpec } from './utils';
+export interface ComponentRenderData {
+    entryCompMetas: (ComponentMeta & {
+        params?: Record<string, string>;
+    })[];
+    bundle: LoaderBundleOutput;
+    remoteFontUrls: string[];
+}
+interface PlasmicRootWatcher {
+    onDataFetched?: () => void;
+}
+export type CodeComponentMeta<P> = Omit<InternalCodeComponentMeta<P>, 'importPath' | 'componentHelpers' | 'states'> & {
+    /**
+     * 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).
+     * Optional: not used by Plasmic headless API, only by codegen.
+     */
+    importPath?: string;
+    /**
+     * The states helpers are registered together with the states for the Plasmic headless API
+     */
+    states?: Record<string, StateSpec & StateHelpers<P, any>>;
+};
+export type GlobalContextMeta<P> = Omit<InternalGlobalContextMeta<P>, 'importPath'> & {
+    /**
+     * 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).
+     * Optional: not used by Plasmic headless API, only by codegen.
+     */
+    importPath?: string;
+};
+export type FetchPagesOpts = {
+    /**
+     * Whether to include dynamic pages in fetchPages() output. A page is
+     * considered dynamic if its path contains some param between brackets,
+     * e.g. "[slug]".
+     */
+    includeDynamicPages?: boolean;
+};
+export declare class InternalPlasmicComponentLoader {
+    private opts;
+    private readonly reactServerLoader;
+    private readonly registry;
+    private subs;
+    private roots;
+    private globalVariants;
+    private tracker;
+    constructor(opts: InitOptions);
+    getBundle(): LoaderBundleOutput;
+    setGlobalVariants(globalVariants: GlobalVariantSpec[]): void;
+    getGlobalVariants(): GlobalVariantSpec[];
+    registerModules(modules: Record<string, any>): void;
+    substituteComponent<P>(component: React.ComponentType<P>, name: ComponentLookupSpec): void;
+    private internalSubstituteComponent;
+    registerComponent<T extends React.ComponentType<any>>(component: T, meta: CodeComponentMeta<React.ComponentProps<T>>): void;
+    registerGlobalContext<T extends React.ComponentType<any>>(context: T, meta: GlobalContextMeta<React.ComponentProps<T>>): void;
+    registerTrait(trait: string, meta: TraitMeta): void;
+    registerToken(token: TokenRegistration): void;
+    registerPrefetchedBundle(bundle: LoaderBundleOutput): void;
+    subscribePlasmicRoot(watcher: PlasmicRootWatcher): void;
+    unsubscribePlasmicRoot(watcher: PlasmicRootWatcher): void;
+    clearCache(): void;
+    getLookup(): ComponentLookup;
+    maybeFetchComponentData(specs: ComponentLookupSpec[], opts?: FetchComponentDataOpts): Promise<ComponentRenderData | null>;
+    maybeFetchComponentData(...specs: ComponentLookupSpec[]): Promise<ComponentRenderData | null>;
+    fetchComponentData(specs: ComponentLookupSpec[], opts?: FetchComponentDataOpts): Promise<ComponentRenderData>;
+    fetchComponentData(...specs: ComponentLookupSpec[]): Promise<ComponentRenderData>;
+    fetchPages(opts?: FetchPagesOpts): Promise<import("@plasmicapp/loader-core").PageMeta[]>;
+    fetchComponents(): Promise<ComponentMeta[]>;
+    getActiveSplits(): import("@plasmicapp/loader-core").Split[];
+    trackConversion(value?: number): void;
+    getActiveVariation(opts: {
+        traits: Record<string, string | number | boolean>;
+        getKnownValue: (key: string) => string | undefined;
+        updateKnownValue: (key: string, value: string) => void;
+    }): Promise<Record<string, string>>;
+    getTeamIds(): string[];
+    getProjectIds(): string[];
+    trackRender(opts?: TrackRenderOptions): void;
+    private refreshRegistry;
+}
+/**
+ * Library for fetching component data, and registering
+ * custom components.
+ */
+export declare class PlasmicComponentLoader {
+    private __internal;
+    constructor(internal: InternalPlasmicComponentLoader);
+    /**
+     * Sets global variants to be used for all components.  Note that
+     * this is not reactive, and will not re-render all components
+     * already mounted; instead, it should be used to activate global
+     * variants that should always be activated for the lifetime of this
+     * app.  If you'd like to reactively change the global variants,
+     * you should specify them via <PlasmicRootProvider />
+     */
+    setGlobalVariants(globalVariants: GlobalVariantSpec[]): void;
+    registerModules(modules: Record<string, any>): void;
+    /**
+     * Register custom components that should be swapped in for
+     * components defined in your project.  You can use this to
+     * swap in / substitute a Plasmic component with a "real" component.
+     */
+    substituteComponent<P>(component: React.ComponentType<P>, name: ComponentLookupSpec): void;
+    /**
+     * Register code components to be used on Plasmic Editor.
+     */
+    registerComponent<T extends React.ComponentType<any>>(component: T, meta: CodeComponentMeta<React.ComponentProps<T>>): void;
+    /**
+     * [[deprecated]] Please use `substituteComponent` instead for component
+     * substitution, or the other `registerComponent` overload to register
+     * code components to be used on Plasmic Editor.
+     *
+     * @see `substituteComponent`
+     */
+    registerComponent<T extends React.ComponentType<any>>(component: T, name: ComponentLookupSpec): void;
+    private warnedRegisterComponent;
+    registerGlobalContext<T extends React.ComponentType<any>>(context: T, meta: GlobalContextMeta<React.ComponentProps<T>>): void;
+    registerTrait(trait: string, meta: TraitMeta): void;
+    registerToken(token: TokenRegistration): void;
+    /**
+     * Pre-fetches component data needed to for PlasmicLoader to render
+     * these components.  Should be passed into PlasmicRootProvider as
+     * the prefetchedData prop.
+     *
+     * You can look up a component either by:
+     * - the name of the component
+     * - the path for a page component
+     * - an array of strings that make up parts of the path
+     * - object { name: "name_or_path", projectId: ...}, to specify which project
+     *   to use, if multiple projects have the same component name
+     *
+     * Throws an Error if a specified component to fetch does not exist in
+     * the Plasmic project.
+     */
+    fetchComponentData(...specs: ComponentLookupSpec[]): Promise<ComponentRenderData>;
+    /**
+     * Like fetchComponentData(), but returns null instead of throwing an Error
+     * when a component is not found.  Useful when you are implementing a catch-all
+     * page and want to check if a specific path had been defined for Plasmic.
+     */
+    maybeFetchComponentData(...specs: ComponentLookupSpec[]): Promise<ComponentRenderData | null>;
+    /**
+     * Returns all the page component metadata for these projects.
+     */
+    fetchPages(opts?: FetchPagesOpts): Promise<import("@plasmicapp/loader-core").PageMeta[]>;
+    /**
+     * Returns all components metadata for these projects.
+     */
+    fetchComponents(): Promise<ComponentMeta[]>;
+    protected _getActiveVariation(opts: {
+        traits: Record<string, string | number | boolean>;
+        getKnownValue: (key: string) => string | undefined;
+        updateKnownValue: (key: string, value: string) => void;
+    }): Promise<Record<string, string>>;
+    getActiveVariation(opts: {
+        known?: Record<string, string>;
+        traits: Record<string, string | number | boolean>;
+    }): Promise<Record<string, string>>;
+    getExternalVariation(variation: Record<string, string>): Record<string, string>;
+    getActiveSplits(): import("@plasmicapp/loader-core").Split[];
+    trackConversion(value?: number): void;
+    clearCache(): void;
+}
+export {};

package/dist/prepass.d.ts

@@ -1,43 +1,43 @@
-import React from 'react';
-/**
- * Performs a prepass over Plasmic content, kicking off the necessary
- * data fetches, and populating the fetched data into a cache.  This
- * cache can be passed as prefetchedQueryData into PlasmicRootProvider.
- *
- * To limit rendering errors that can occur when you do this, we recommend
- * that you pass in _only_ the PlasmicComponents that you are planning to use
- * as the argument.  For example:
- *
- *   const cache = await extractPlasmicQueryData(
- *     <PlasmicRootProvider loader={PLASMIC} prefetchedData={plasmicData}>
- *       <PlasmicComponent component="Home" componentProps={{
- *         // Specify the component prop overrides you are planning to use
- *         // to render the page, as they may change what data is fetched.
- *         ...
- *       }} />
- *       <PlasmicComponent component="NavBar" componentProps={{
- *         ...
- *       }} />
- *       ...
- *     </PlasmicRootProvider>
- *   );
- *
- * If your PlasmicComponent will be wrapping components that require special
- * context set up, you should also wrap the element above with those context
- * providers.
- *
- * You should avoid passing in elements that are not related to Plasmic, as any
- * rendering errors from those elements during the prepass may result in data
- * not being populated in the cache.
- *
- * @param element a React element containing instances of PlasmicComponent.
- *   Will attempt to satisfy all data needs from usePlasmicDataQuery()
- *   in this element tree.
- * @returns an object mapping query key to fetched data
- */
-export declare function extractPlasmicQueryData(element: React.ReactElement): Promise<Record<string, any>>;
-/**
- * Runs react-ssr-prepass on `element`, while isolating rendering errors
- * as much as possible for each PlasmicComponent instance.
- */
-export declare function plasmicPrepass(element: React.ReactElement): Promise<void>;
+import React from "react";
+/**
+ * Performs a prepass over Plasmic content, kicking off the necessary
+ * data fetches, and populating the fetched data into a cache.  This
+ * cache can be passed as prefetchedQueryData into PlasmicRootProvider.
+ *
+ * To limit rendering errors that can occur when you do this, we recommend
+ * that you pass in _only_ the PlasmicComponents that you are planning to use
+ * as the argument.  For example:
+ *
+ *   const cache = await extractPlasmicQueryData(
+ *     <PlasmicRootProvider loader={PLASMIC} prefetchedData={plasmicData}>
+ *       <PlasmicComponent component="Home" componentProps={{
+ *         // Specify the component prop overrides you are planning to use
+ *         // to render the page, as they may change what data is fetched.
+ *         ...
+ *       }} />
+ *       <PlasmicComponent component="NavBar" componentProps={{
+ *         ...
+ *       }} />
+ *       ...
+ *     </PlasmicRootProvider>
+ *   );
+ *
+ * If your PlasmicComponent will be wrapping components that require special
+ * context set up, you should also wrap the element above with those context
+ * providers.
+ *
+ * You should avoid passing in elements that are not related to Plasmic, as any
+ * rendering errors from those elements during the prepass may result in data
+ * not being populated in the cache.
+ *
+ * @param element a React element containing instances of PlasmicComponent.
+ *   Will attempt to satisfy all data needs from usePlasmicDataQuery()
+ *   in this element tree.
+ * @returns an object mapping query key to fetched data
+ */
+export declare function extractPlasmicQueryData(element: React.ReactElement): Promise<Record<string, any>>;
+/**
+ * Runs react-ssr-prepass on `element`, while isolating rendering errors
+ * as much as possible for each PlasmicComponent instance.
+ */
+export declare function plasmicPrepass(element: React.ReactElement): Promise<void>;

package/dist/react-server.d.ts

@@ -0,0 +1,5 @@
+import "server-only";
+import { InitOptions, ReactServerPlasmicComponentLoader } from "./loader-react-server";
+export * from "./shared-exports";
+export { ReactServerPlasmicComponentLoader };
+export declare function initPlasmicLoader(opts: InitOptions): ReactServerPlasmicComponentLoader;