sample-piral 0.14.23 → 0.14.24-beta.4157

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.
+     */
+    noEmptyRender?: 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.html

@@ -5,7 +5,7 @@
   <title>Piral Sample</title>
   <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
   
-<script defer src="/index.1ecdc1.js"></script></head>
+<script defer src="/index.c37743.js"></script></head>
 <body>
 <div id="app">
   <div class="pi-center">

package/app/index.js

@@ -2,7 +2,7 @@ if (process.env.NODE_ENV === 'test') {
   // behavior for the test environment, we'll try to make it work
 
   if (typeof window !== 'undefined') {
-    require('.//index.1ecdc1.js');
+    require('.//index.c37743.js');
     const ctx = window['dbg:piral'];
     const dependencies = (ctx && ctx.pilets && ctx.pilets.getDependencies({})) || {};
     module.exports = dependencies['sample-piral'] || {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "sample-piral",
   "description": "Example project illustrating the use of the piral and piral-cli packages.",
-  "version": "0.14.23",
+  "version": "0.14.24-beta.4157",
   "license": "MIT",
   "homepage": "https://piral.io",
   "keywords": [