piral-core 0.15.0-alpha.3549 → 0.15.0-alpha.3592

package/src/types/api.ts

@@ -1,13 +1,22 @@
 import type { ReactElement } from 'react';
 import type { RouteComponentProps } from 'react-router';
-import type { PiletApi, Pilet, PiletMetadata, EventEmitter, SinglePilet, MultiPilet } 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 { SharedData, DataStoreOptions } from './data';
 import type { Disposable } from './utils';
 
-export { PiletApi, Pilet, PiletMetadata, EventEmitter, SinglePilet, MultiPilet };
+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.
@@ -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/state.ts

@@ -12,7 +12,6 @@ import type {
   PiralCustomComponentsState,
 } from './custom';
 import type {
-  PiletMetadata,
   EventEmitter,
   Pilet,
   BaseComponentProps,
@@ -20,6 +19,7 @@ import type {
   ExtensionComponentProps,
   PiletsBag,
   PiralPageMeta,
+  PiletEntry,
 } from './api';
 import type {
   ComponentConverters,
@@ -162,7 +162,7 @@ export interface GlobalState extends PiralCustomState {
   /**
    * Gets the loaded modules.
    */
-  modules: Array<PiletMetadata>;
+  modules: Array<Pilet>;
   /**
    * The foreign component portals to render.
    */
@@ -205,10 +205,20 @@ export interface PiralActions extends PiralCustomActions {
    */
   initialize(loading: boolean, error: Error | undefined, modules: Array<Pilet>): void;
   /**
-   * Injects a pilet at runtime - removes the pilet from registry first if available.
+   * Injects an evaluated pilet at runtime - removes the pilet from registry first if available.
    * @param pilet The pilet to be injected.
    */
   injectPilet(pilet: Pilet): void;
+  /**
+   * Adds a pilet at runtime by loading it, evaluating it, and then injecting it.
+   * @param pilet The pilet to be added.
+   */
+  addPilet(pilet: PiletEntry): void;
+  /**
+   * Removes a pilet by unloading it and deleting all component registrations.
+   * @param name The name of the pilet to remove.
+   */
+  removePilet(name: string): void;
   /**
    * Defines a single action for Piral.
    * @param actionName The name of the action to define.

package/src/types/utils.ts

@@ -60,7 +60,7 @@ export interface PiralStoreDataEvent<TValue = any> {
   expires: number;
 }
 
-declare module 'piral-base/lib/types' {
+declare module 'piral-base/lib/types/api' {
   interface PiralEventMap extends PiralCustomEventMap {
     'store-data': PiralStoreDataEvent;
   }

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.js

@@ -1,13 +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, {
-        injectPilet: context.injectPilet,
-        hooks: options.hooks,
-        createApi: options.createApi,
-        loadPilet: options.loadPilet
-    });
-}
-exports.integrate = integrate;

package/debug-piral.js

@@ -1,59 +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), { createApi: options.createApi, loadPilet: options.loadPilet, injectPilet: context.injectPilet, 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; });
-        }, setPilets: function (modules) {
-            context.dispatch(function (state) { return (__assign(__assign({}, state), { modules: 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;