piral-core 0.15.0-alpha.3555 → 0.15.0-alpha.3640

package/src/state/withApi.tsx

@@ -1,179 +1,53 @@
 import * as React from 'react';
-import { isfunc } from 'piral-base';
 import { __RouterContext } from 'react-router';
-import { PiralError, PiralLoadingIndicator, ErrorBoundary, ErrorBoundaryOptions, PortalRenderer } from '../components';
-import { useGlobalStateContext } from '../hooks';
-import { defaultRender, convertComponent, none } from '../utils';
-import {
-  AnyComponent,
-  Errors,
-  ComponentConverters,
-  ForeignComponent,
-  PiletApi,
-  BaseComponentProps,
-  ComponentContext,
-  GlobalStateContext,
-} from '../types';
-
-// this is an arbitrary start number to have 6 digits
-let portalIdBase = 123456;
+import { ErrorBoundary, wrapComponent } from '../components';
+import { defaultRender } from '../utils';
+import { AnyComponent, Errors, PiletApi, BaseComponentProps, GlobalStateContext } from '../types';
 
 const DefaultWrapper: React.FC = (props) => defaultRender(props.children);
 
-interface ForeignComponentContainerProps<T> {
-  $portalId: string;
-  $component: ForeignComponent<T>;
-  $context: ComponentContext;
-  innerProps: T & BaseComponentProps;
-}
-
-class ForeignComponentContainer<T> extends React.Component<ForeignComponentContainerProps<T>> {
-  private current?: HTMLElement;
-  private previous?: HTMLElement;
-  private handler = (ev: CustomEvent) => {
-    const { innerProps } = this.props;
-    ev.stopPropagation();
-    innerProps.piral.renderHtmlExtension(ev.detail.target, ev.detail.props);
-  };
-
-  private setNode = (node: HTMLDivElement) => {
-    this.current = node;
-  };
-
-  componentDidMount() {
-    const node = this.current;
-    const { $component, $context, innerProps } = this.props;
-    const { mount } = $component;
-
-    if (node && isfunc(mount)) {
-      mount(node, innerProps, $context);
-      node.addEventListener('render-html', this.handler, false);
-    }
-
-    this.previous = node;
-  }
-
-  componentDidUpdate() {
-    const { current, previous } = this;
-    const { $component, $context, innerProps } = this.props;
-    const { update } = $component;
-
-    if (current !== previous) {
-      previous && this.componentWillUnmount();
-      current && this.componentDidMount();
-    } else if (isfunc(update)) {
-      update(current, innerProps, $context);
-    }
-  }
-
-  componentWillUnmount() {
-    const node = this.previous;
-    const { $component } = this.props;
-    const { unmount } = $component;
-
-    if (node && isfunc(unmount)) {
-      unmount(node);
-      node.removeEventListener('render-html', this.handler, false);
-    }
-
-    this.previous = undefined;
+function getWrapper(wrappers: Record<string, React.ComponentType<any>>, wrapperType: string) {
+  const WrapAll = wrappers['*'];
+  const WrapType = wrappers[wrapperType];
+
+  if (WrapAll && WrapType) {
+    return (props) => (
+      <WrapAll {...props}>
+        <WrapType {...props} />
+      </WrapAll>
+    );
   }
 
-  render() {
-    const { $portalId } = this.props;
-    return <div data-portal-id={$portalId} ref={this.setNode} />;
-  }
+  return WrapType || WrapAll || DefaultWrapper;
 }
 
-function wrapReactComponent<T>(
-  Component: React.ComponentType<T & BaseComponentProps>,
-  stasisOptions: ErrorBoundaryOptions<T>,
-  piral: PiletApi,
-  Wrapper: React.ComponentType<any>,
-): React.ComponentType<T> {
-  return (props: T) => (
-    <Wrapper {...props} piral={piral}>
-      <ErrorBoundary {...stasisOptions} renderProps={props}>
-        <Component {...props} piral={piral} />
+function makeWrapper<TProps>(
+  context: GlobalStateContext,
+  outerProps: any,
+  wrapperType: string,
+  errorType: keyof Errors,
+): React.FC<TProps> {
+  const OuterWrapper = context.readState((m) => getWrapper(m.registry.wrappers, wrapperType));
+
+  return (props) => (
+    <OuterWrapper {...outerProps} {...props}>
+      <ErrorBoundary {...outerProps} {...props} errorType={errorType}>
+        {props.children}
       </ErrorBoundary>
-    </Wrapper>
+    </OuterWrapper>
   );
 }
 
-function wrapForeignComponent<T>(
-  component: ForeignComponent<T & BaseComponentProps>,
-  stasisOptions: ErrorBoundaryOptions<T>,
-  piral: PiletApi,
-  Wrapper: React.ComponentType<any>,
-) {
-  return React.memo((props: T) => {
-    const { state, readState, destroyPortal } = useGlobalStateContext();
-    const router = React.useContext(__RouterContext);
-    const id = React.useMemo(() => (portalIdBase++).toString(26), none);
-    const context = React.useMemo(() => ({ router, state, readState }), [router, state]);
-    const innerProps = React.useMemo(() => ({ ...props, piral }), [props]);
-
-    React.useEffect(() => () => destroyPortal(id), none);
-
-    return (
-      <Wrapper {...innerProps}>
-        <ErrorBoundary {...stasisOptions} renderProps={props}>
-          <PortalRenderer id={id} />
-          <ForeignComponentContainer innerProps={innerProps} $portalId={id} $component={component} $context={context} />
-        </ErrorBoundary>
-      </Wrapper>
-    );
-  });
-}
-
-function isNotExotic(component: any): component is object {
-  return !(component as React.ExoticComponent).$$typeof;
-}
-
-function wrapComponent<T>(
-  converters: ComponentConverters<T & BaseComponentProps>,
-  component: AnyComponent<T & BaseComponentProps>,
-  piral: PiletApi,
-  Wrapper: React.ComponentType<any>,
-  stasisOptions: ErrorBoundaryOptions<T>,
-) {
-  if (!component) {
-    console.error('The given value is not a valid component.');
-    // tslint:disable-next-line:no-null-keyword
-    component = () => null;
-  }
-
-  if (typeof component === 'object' && isNotExotic(component)) {
-    const result = convertComponent(converters[component.type], component);
-    return wrapForeignComponent<T>(result, stasisOptions, piral, Wrapper);
-  }
-
-  return wrapReactComponent<T>(component, stasisOptions, piral, Wrapper);
-}
-
-function getWrapper(wrappers: Record<string, React.ComponentType<any>>, wrapperType: string) {
-  return wrappers[wrapperType] || wrappers['*'] || DefaultWrapper;
-}
-
 export function withApi<TProps>(
   context: GlobalStateContext,
   component: AnyComponent<TProps & BaseComponentProps>,
   piral: PiletApi,
   errorType: keyof Errors,
   wrapperType: string = errorType,
+  captured = {},
 ) {
+  const outerProps = { ...captured, piral };
   const converters = context.converters;
-  const Wrapper = context.readState((m) => getWrapper(m.registry.wrappers, wrapperType));
-
-  return wrapComponent<TProps>(converters, component, piral, Wrapper, {
-    onError(error) {
-      console.error(piral, error);
-    },
-    renderChild(child) {
-      return <React.Suspense fallback={<PiralLoadingIndicator />}>{child}</React.Suspense>;
-    },
-    renderError(error, props: any) {
-      return <PiralError type={errorType} error={error} {...props} />;
-    },
-  });
+  const Wrapper = makeWrapper<TProps>(context, outerProps, wrapperType, errorType);
+  return wrapComponent(converters, component, outerProps, Wrapper);
 }

package/src/types/api.ts

@@ -1,13 +1,22 @@
 import type { ReactElement } from 'react';
 import type { RouteComponentProps } from 'react-router';
-import type { PiletApi, Pilet, PiletEntry, PiletEntries, PiletMetadata, EventEmitter } from 'piral-base';
+import type {
+  PiletApi,
+  Pilet,
+  PiletEntry,
+  PiletEntries,
+  PiletMetadata,
+  EventEmitter,
+  PiletLoader,
+  PiletLoadingStrategy,
+} from 'piral-base';
 import type { PiletCustomApi, PiralCustomPageMeta } from './custom';
 import type { AnyComponent } from './components';
-import type { ExtensionSlotProps, PiralExtensionSlotMap } from './extension';
+import type { ExtensionParams, ExtensionSlotProps, PiralExtensionSlotMap } from './extension';
 import type { SharedData, DataStoreOptions } from './data';
 import type { Disposable } from './utils';
 
-export { PiletApi, Pilet, PiletMetadata, EventEmitter, PiletEntry, PiletEntries };
+export { PiletApi, Pilet, PiletMetadata, EventEmitter, PiletEntry, PiletEntries, PiletLoader, PiletLoadingStrategy };
 
 /**
  * The props that every registered component obtains.
@@ -39,6 +48,11 @@ export interface ExtensionComponentProps<T> extends BaseComponentProps {
   params: T extends keyof PiralExtensionSlotMap ? PiralExtensionSlotMap[T] : T extends string ? any : T;
 }
 
+/**
+ * The meta data registered for a page.
+ */
+export interface PiralPageMeta extends PiralCustomPageMeta {}
+
 /**
  * The props that every registered page component obtains.
  */
@@ -49,12 +63,12 @@ export interface RouteBaseProps<UrlParams = any, UrlState = any>
 /**
  * The props used by a page component.
  */
-export interface PageComponentProps<T = any, S = any> extends RouteBaseProps<T, S> {}
-
-/**
- * The meta data registered for a page.
- */
-export interface PiralPageMeta extends PiralCustomPageMeta {}
+export interface PageComponentProps<T = any, S = any> extends RouteBaseProps<T, S> {
+  /**
+   * The meta data registered with the page.
+   */
+  meta: PiralPageMeta;
+}
 
 /**
  * Defines the Pilet API from piral-core.
@@ -99,7 +113,7 @@ export interface PiletCoreApi {
   registerExtension<TName>(
     name: TName extends string ? TName : string,
     Component: AnyComponent<ExtensionComponentProps<TName>>,
-    defaults?: TName,
+    defaults?: Partial<ExtensionParams<TName>>,
   ): RegistrationDisposer;
   /**
    * Unregisters a global extension component.
@@ -126,7 +140,7 @@ export interface PiletCoreApi {
   renderHtmlExtension<TName>(element: HTMLElement | ShadowRoot, props: ExtensionSlotProps<TName>): Disposable;
 }
 
-declare module 'piral-base/lib/types' {
+declare module 'piral-base/lib/types/runtime' {
   interface PiletApi extends PiletCustomApi, PiletCoreApi {}
 }
 

package/src/types/extension.ts

@@ -34,10 +34,19 @@ export interface BaseExtensionSlotProps<TName, TParams> {
   name: TName;
 }
 
+/**
+ * Gives the extension params shape for the given extension slot name.
+ */
+export type ExtensionParams<TName> = TName extends keyof PiralExtensionSlotMap
+  ? PiralExtensionSlotMap[TName]
+  : TName extends string
+  ? any
+  : TName;
+
 /**
  * The props for defining an extension slot.
  */
-export type ExtensionSlotProps<K = string> = BaseExtensionSlotProps<
-  K extends string ? K : string,
-  K extends keyof PiralExtensionSlotMap ? PiralExtensionSlotMap[K] : K extends string ? any : K
+export type ExtensionSlotProps<TName = string> = BaseExtensionSlotProps<
+  TName extends string ? TName : string,
+  ExtensionParams<TName>
 >;

package/src/utils/index.ts

@@ -1,3 +1,5 @@
+export { isfunc, requireModule } from 'piral-base';
+
 export * from './compare';
 export * from './data';
 export * from './extension';

package/debug-pilet.d.ts

@@ -1,3 +0,0 @@
-import { LoadPiletsOptions } from 'piral-base';
-import { GlobalStateContext } from './lib/types';
-export declare function integrate(context: GlobalStateContext, options: LoadPiletsOptions): void;

package/debug-pilet.js

@@ -1,11 +0,0 @@
-"use strict";
-exports.__esModule = true;
-exports.integrate = void 0;
-var piral_debug_utils_1 = require("piral-debug-utils");
-function integrate(context, options) {
-    options.fetchPilets = (0, piral_debug_utils_1.withEmulatorPilets)(options.fetchPilets, {
-        addPilet: context.addPilet,
-        removePilet: context.removePilet
-    });
-}
-exports.integrate = integrate;

package/debug-piral.d.ts

@@ -1,4 +0,0 @@
-import { LoadPiletsOptions } from 'piral-base';
-import { DebuggerExtensionOptions } from 'piral-debug-utils';
-import { GlobalStateContext } from './lib/types';
-export declare function integrate(context: GlobalStateContext, options: LoadPiletsOptions, debug?: DebuggerExtensionOptions): void;

package/debug-piral.js

@@ -1,72 +0,0 @@
-"use strict";
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
-    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
-        if (ar || !(i in from)) {
-            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
-            ar[i] = from[i];
-        }
-    }
-    return to.concat(ar || Array.prototype.slice.call(from));
-};
-exports.__esModule = true;
-exports.integrate = void 0;
-var react_atom_1 = require("@dbeining/react-atom");
-var piral_debug_utils_1 = require("piral-debug-utils");
-function integrate(context, options, debug) {
-    if (debug === void 0) { debug = {}; }
-    (0, piral_debug_utils_1.installPiralDebug)(__assign(__assign({}, debug), { addPilet: context.addPilet, removePilet: context.removePilet, updatePilet: function (pilet) {
-            if (!pilet.disabled) {
-                var createApi = options.createApi;
-                var newApi = createApi(pilet);
-                try {
-                    context.injectPilet(pilet);
-                    pilet.setup(newApi);
-                }
-                catch (error) {
-                    console.error(error);
-                }
-            }
-            else {
-                context.injectPilet(pilet);
-            }
-        }, fireEvent: context.emit, getDependencies: function () {
-            return Object.keys(options.dependencies);
-        }, getExtensions: function () {
-            return context.readState(function (s) { return Object.keys(s.registry.extensions); });
-        }, getRoutes: function () {
-            var registeredRoutes = context.readState(function (state) { return Object.keys(state.registry.pages); });
-            var componentRoutes = context.readState(function (state) { return Object.keys(state.routes); });
-            return __spreadArray(__spreadArray([], componentRoutes, true), registeredRoutes, true);
-        }, getGlobalState: function () {
-            return context.readState(function (s) { return s; });
-        }, getPilets: function () {
-            return context.readState(function (s) { return s.modules; });
-        }, integrate: function (dbg) {
-            context.dispatch(function (s) { return (__assign(__assign({}, s), { components: __assign(__assign({}, s.components), dbg.components), routes: __assign(__assign({}, s.routes), dbg.routes), registry: __assign(__assign({}, s.registry), { wrappers: __assign(__assign({}, s.registry.wrappers), dbg.wrappers) }) })); });
-            (0, react_atom_1.addChangeHandler)(context.state, 'debugging', function (_a) {
-                var previous = _a.previous, current = _a.current;
-                var pilets = current.modules !== previous.modules;
-                var pages = current.registry.pages !== previous.registry.pages || current.routes !== previous.routes;
-                var extensions = current.registry.extensions !== previous.registry.extensions;
-                var state = current !== previous;
-                dbg.onChange(previous, current, {
-                    pilets: pilets,
-                    pages: pages,
-                    extensions: extensions,
-                    state: state
-                });
-            });
-        } }));
-}
-exports.integrate = integrate;