sample-piral 0.14.24-beta.4144 → 0.14.24-beta.4161

package/app/index.d.ts

@@ -594,6 +594,10 @@ declare module "sample-piral" {
      * The provided parameters for showing the extension.
      */
     params: T extends keyof PiralExtensionSlotMap ? PiralExtensionSlotMap[T] : T extends string ? any : T;
+    /**
+     * The optional children to receive, if any.
+     */
+    children?: React.ReactNode;
   }
 
   /**
@@ -614,9 +618,27 @@ declare module "sample-piral" {
      * for the specified extension.
      */
     empty?(): React.ReactNode;
+    /**
+     * Determines if the `render` function should be called in case no
+     * components are available for the specified extension.
+     * 
+     * If true, `empty` will be called and returned from the slot.
+     * If false, `render` will be called with the result of calling `empty`.
+     * The result of calling `render` will then be returned from the slot.
+     */
+    emptySkipsRender?: boolean;
+    /**
+     * Defines the order of the components to render.
+     * May be more convient than using `render` w.r.t. ordering extensions
+     * by their supplied metadata.
+     * @param extensions The registered extensions.
+     * @returns The ordered extensions.
+     */
+    order?(extensions: Array<ExtensionRegistration>): Array<ExtensionRegistration>;
     /**
      * Defines how the provided nodes should be rendered.
      * @param nodes The rendered extension nodes.
+     * @returns The rendered nodes, i.e., an ReactElement.
      */
     render?(nodes: Array<React.ReactNode>): React.ReactElement<any, any> | null;
     /**
@@ -948,6 +970,24 @@ declare module "sample-piral" {
    */
   export interface PiralCustomExtensionSlotMap {}
 
+  /**
+   * The interface modeling the registration of a pilet extension component.
+   */
+  export interface ExtensionRegistration extends BaseRegistration {
+    /**
+     * The wrapped registered extension component.
+     */
+    component: WrappedComponent<ExtensionComponentProps<string>>;
+    /**
+     * The original extension component that has been registered.
+     */
+    reference: any;
+    /**
+     * The default params (i.e., meta) of the extension.
+     */
+    defaults: any;
+  }
+
   /**
    * Metadata for pilets using the v0 schema with a content.
    */
@@ -995,6 +1035,18 @@ declare module "sample-piral" {
     readState: PiralActions["readState"];
   }
 
+  /**
+   * The base type for pilet component registration in the global state context.
+   */
+  export interface BaseRegistration {
+    /**
+     * The pilet registering the component.
+     */
+    pilet: string;
+  }
+
+  export type WrappedComponent<TProps> = React.ComponentType<Without<TProps, keyof BaseComponentProps>>;
+
   /**
    * Basic metadata for pilets using the v0 schema.
    */
@@ -1204,6 +1256,8 @@ declare module "sample-piral" {
     readState<S>(select: (state: GlobalState) => S): S;
   }
 
+  export type Without<T, K> = Pick<T, Exclude<keyof T, K>>;
+
   /**
    * Custom state extensions defined outside of piral-core.
    */
@@ -1527,19 +1581,16 @@ declare module "sample-piral" {
    * The interface modeling the registration of a pilet page component.
    */
   export interface PageRegistration extends BaseRegistration {
+    /**
+     * The registered page component.
+     */
     component: WrappedComponent<PageComponentProps>;
+    /**
+     * The page's associated metadata.
+     */
     meta: PiralPageMeta;
   }
 
-  /**
-   * The interface modeling the registration of a pilet extension component.
-   */
-  export interface ExtensionRegistration extends BaseRegistration {
-    component: WrappedComponent<ExtensionComponentProps<string>>;
-    reference: any;
-    defaults: any;
-  }
-
   export interface OpenNotification {
     id: string;
     component: React.ComponentType<BareNotificationProps>;
@@ -1820,15 +1871,6 @@ declare module "sample-piral" {
     options: LoadPiletsOptions;
   }
 
-  /**
-   * The base type for pilet component registration in the global state context.
-   */
-  export interface BaseRegistration {
-    pilet: string;
-  }
-
-  export type WrappedComponent<TProps> = React.ComponentType<Without<TProps, keyof BaseComponentProps>>;
-
   export interface FeedDataState {
     /**
      * Determines if the feed data is currently loading.
@@ -2103,8 +2145,6 @@ declare module "sample-piral" {
     strategy?: PiletLoadingStrategy;
   }
 
-  export type Without<T, K> = Pick<T, Exclude<keyof T, K>>;
-
   export interface TileErrorInfoProps {
     /**
      * The type of the error.

package/app/{index.374623.js → index.d51e4f.js}

@@ -2639,23 +2639,33 @@ __webpack_require__.r(__webpack_exports__);
 
 
 
+
+function defaultOrder(extensions) {
+  return extensions;
+}
 /**
  * The extension slot component to be used when the available
  * extensions of a given name should be rendered at a specific
  * location.
  */
 
+
 function ExtensionSlot(props) {
   var name = props.name,
       _props$render = props.render,
       render = _props$render === void 0 ? _utils__WEBPACK_IMPORTED_MODULE_1__.defaultRender : _props$render,
       empty = props.empty,
       params = props.params,
-      children = props.children;
+      children = props.children,
+      _props$emptySkipsRend = props.emptySkipsRender,
+      emptySkipsRender = _props$emptySkipsRend === void 0 ? false : _props$emptySkipsRend,
+      _props$order = props.order,
+      order = _props$order === void 0 ? defaultOrder : _props$order;
   var extensions = (0,_hooks__WEBPACK_IMPORTED_MODULE_2__.useGlobalState)(function (s) {
     return s.registry.extensions[name] || _utils__WEBPACK_IMPORTED_MODULE_3__.none;
   });
-  return render(extensions.length === 0 && (0,piral_base__WEBPACK_IMPORTED_MODULE_4__.isfunc)(empty) ? [(0,_utils__WEBPACK_IMPORTED_MODULE_1__.defaultRender)(empty(), 'empty')] : extensions.map(function (_ref, i) {
+  var isEmpty = extensions.length === 0 && (0,piral_base__WEBPACK_IMPORTED_MODULE_4__.isfunc)(empty);
+  var content = isEmpty ? [(0,_utils__WEBPACK_IMPORTED_MODULE_1__.defaultRender)(empty(), 'empty')] : order(extensions).map(function (_ref, i) {
     var Component = _ref.component,
         reference = _ref.reference,
         _ref$defaults = _ref.defaults,
@@ -2665,7 +2675,13 @@ function ExtensionSlot(props) {
       children: children,
       params: Object.assign(Object.assign({}, defaults), params || {})
     });
-  }));
+  });
+
+  if (isEmpty && emptySkipsRender) {
+    return content[0];
+  }
+
+  return render(content);
 }
 ExtensionSlot.displayName = "ExtensionSlot";
 
@@ -3525,7 +3541,7 @@ function createInstance() {
   var createApi = apiFactory(context, usedPlugins);
   var root = createApi({
     name: 'root',
-    version: "0.14.24-beta.4144" || 0,
+    version: "0.14.24-beta.4161" || 0,
     spec: ''
   });
   var options = (0,_helpers__WEBPACK_IMPORTED_MODULE_6__.createPiletOptions)({
@@ -8474,11 +8490,11 @@ function installPiralDebug(options) {
     debug: debugApiVersion,
     instance: {
       name: "sample-piral",
-      version: "0.14.24-beta.4144",
+      version: "0.14.24-beta.4161",
       dependencies: "reactstrap,react,react-dom,react-router,react-router-dom,history,tslib,path-to-regexp,@libre/atom,@dbeining/react-atom"
     },
     build: {
-      date: "2022-05-04T12:53:01.648Z",
+      date: "2022-05-06T14:36:17.678Z",
       cli: "0.14.23",
       compat: "0.14"
     },
@@ -79879,4 +79895,4 @@ function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len
 
 /******/ })()
 ;
-//# sourceMappingURL=index.374623.js.map
+//# sourceMappingURL=index.d51e4f.js.map