sample-piral 1.1.0-beta.5752 → 1.1.0-beta.5756

package/app/index.d.ts

@@ -256,7 +256,7 @@ export interface PiletNotificationsApi {
    * @param options The options to consider for showing the notification.
    * @returns A callback to trigger closing the notification.
    */
-  showNotification<TType extends keyof PiralNotificationTypes = "info">(content: string | React.ReactElement<any, any> | AnyComponent<NotificationComponentProps<TType>>, options?: NotificationOptions<TType>): Disposable;
+  showNotification(content: string | React.ReactElement<any, any> | AnyComponent<NotificationComponentProps>, options?: NotificationOptions): Disposable;
 }
 
 export interface PiletModalsApi {
@@ -474,55 +474,11 @@ export interface TilePreferences extends PiralCustomTilePreferences {
 
 export interface MenuComponentProps extends BaseComponentProps {}
 
-export interface MenuSettings extends PiralCustomMenuSettings {
-  /**
-   * Sets the type of the menu to attach to.
-   * @default "general"
-   */
-  type?: MenuType;
-}
+export type MenuSettings = PiralCustomMenuSettings & PiralSpecificMenuSettings;
 
-export type NotificationComponentProps<TType extends keyof PiralNotificationTypes> = BaseComponentProps & BareNotificationProps<TType>;
-
-export interface NotificationOptions<TType extends keyof PiralNotificationTypes> extends PiralCustomNotificationOptions {
-  /**
-   * The title of the notification, if any.
-   */
-  title?: string;
-  /**
-   * Determines when the notification should automatically close in milliseconds.
-   * A value of 0 or undefined forces the user to close the notification.
-   */
-  autoClose?: number;
-  /**
-   * The type of the notification used when displaying the message.
-   * By default info is used.
-   */
-  type?: TType;
-  /**
-   * The extra options to specify, if any.
-   */
-  extra?: PiralNotificationTypes[TType];
-}
+export type NotificationComponentProps = BaseComponentProps & BareNotificationProps;
 
-export interface PiralNotificationTypes extends PiralCustomNotificationTypes {
-  /**
-   * The info type. No extra options.
-   */
-  info: void;
-  /**
-   * The success type. No extra options.
-   */
-  success: void;
-  /**
-   * The warning type. No extra options.
-   */
-  warning: void;
-  /**
-   * The error type. No extra options.
-   */
-  error: void;
-}
+export type NotificationOptions = PiralCustomNotificationOptions & PiralStandardNotificationOptions & PiralSpecificNotificationOptions;
 
 export type ModalOptions<T> = T extends keyof PiralModalsMap ? PiralModalsMap[T] & BaseModalOptions : T extends string ? BaseModalOptions : T;
 
@@ -772,9 +728,16 @@ export interface PiralCustomTilePreferences {}
 
 export interface PiralCustomMenuSettings {}
 
-export type MenuType = StandardMenuType | keyof PiralCustomMenuTypes;
+export type PiralSpecificMenuSettings = UnionOf<{
+  [P in keyof PiralMenuType]: Partial<PiralMenuType[P]> & {
+    /**
+     * The type of the menu used.
+     */
+    type?: P;
+  };
+}>;
 
-export interface BareNotificationProps<TType extends keyof PiralNotificationTypes = any> {
+export interface BareNotificationProps {
   /**
    * Callback for closing the notification programmatically.
    */
@@ -782,12 +745,32 @@ export interface BareNotificationProps<TType extends keyof PiralNotificationType
   /**
    * Provides the passed in options for this particular notification.
    */
-  options: NotificationOptions<TType>;
+  options: NotificationOptions;
 }
 
 export interface PiralCustomNotificationOptions {}
 
-export interface PiralCustomNotificationTypes {}
+export interface PiralStandardNotificationOptions {
+  /**
+   * The title of the notification, if any.
+   */
+  title?: string;
+  /**
+   * Determines when the notification should automatically close in milliseconds.
+   * A value of 0 or undefined forces the user to close the notification.
+   */
+  autoClose?: number;
+}
+
+export type PiralSpecificNotificationOptions = UnionOf<{
+  [P in keyof PiralNotificationTypes]: Partial<PiralNotificationTypes[P]> & {
+    /**
+     * The type of the notification used when displaying the message.
+     * By default info is used.
+     */
+    type?: P;
+  };
+}>;
 
 export interface BaseModalOptions {}
 
@@ -914,9 +897,51 @@ export interface ExtensionRegistration extends BaseRegistration {
   defaults: any;
 }
 
-export type StandardMenuType = "general" | "admin" | "user" | "header" | "footer";
+export type UnionOf<T> = {
+  [K in keyof T]: T[K];
+}[keyof T];
 
-export interface PiralCustomMenuTypes {}
+export interface PiralMenuType extends PiralCustomMenuTypes {
+  /**
+   * The general type. No extra options.
+   */
+  general: {};
+  /**
+   * The admin type. No extra options.
+   */
+  admin: {};
+  /**
+   * The user type. No extra options.
+   */
+  user: {};
+  /**
+   * The header type. No extra options.
+   */
+  header: {};
+  /**
+   * The footer type. No extra options.
+   */
+  footer: {};
+}
+
+export interface PiralNotificationTypes extends PiralCustomNotificationTypes {
+  /**
+   * The info type. No extra options.
+   */
+  info: {};
+  /**
+   * The success type. No extra options.
+   */
+  success: {};
+  /**
+   * The warning type. No extra options.
+   */
+  warning: {};
+  /**
+   * The error type. No extra options.
+   */
+  error: {};
+}
 
 export interface PiralCustomModalsMap {}
 
@@ -955,6 +980,10 @@ export interface BaseRegistration {
 
 export type WrappedComponent<TProps> = React.ComponentType<React.PropsWithChildren<Without<TProps, keyof BaseComponentProps>>>;
 
+export interface PiralCustomMenuTypes {}
+
+export interface PiralCustomNotificationTypes {}
+
 export interface NavigationApi {
   /**
    * Pushes a new location onto the history stack.
@@ -997,6 +1026,10 @@ export interface NavigationApi {
    * as the implementation is router specific and may change over time.
    */
   router: any;
+  /**
+   * Gets the public path of the application.
+   */
+  publicPath: string;
 }
 
 export type Without<T, K> = Pick<T, Exclude<keyof T, K>>;

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.0dafac.js"></script></head>
+<script defer src="/index.53afa6.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.0dafac.js');
+    require('.//index.53afa6.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": "1.1.0-beta.5752",
+  "version": "1.1.0-beta.5756",
   "license": "MIT",
   "homepage": "https://piral.io",
   "keywords": [
@@ -31,26 +31,27 @@
     "files": []
   },
   "piralCLI": {
-    "version": "1.1.0-beta.5752",
+    "version": "1.1.0-beta.5756",
     "generated": true
   },
   "main": "./app/index.js",
   "typings": "./app/index.d.ts",
   "app": "./app/index.html",
   "peerDependencies": {},
+  "optionalDependencies": {},
   "devDependencies": {
     "@types/react": "^18.0.0",
     "@types/react-dom": "^18.0.0",
     "@types/react-router": "^5.1.8",
     "@types/react-router-dom": "^5.1.6",
-    "piral-cli": "^1.1.0-beta.5752",
-    "piral-cli-webpack5": "^1.1.0-beta.5752",
+    "piral-cli": "^1.1.0-beta.5756",
+    "piral-cli-webpack5": "^1.1.0-beta.5756",
     "sass": "^1.17.0",
     "bootstrap": "^4.3.1",
-    "piral": "^1.1.0-beta.5752",
-    "piral-auth": "^1.1.0-beta.5752",
+    "piral": "^1.1.0-beta.5756",
+    "piral-auth": "^1.1.0-beta.5756",
     "piral-hooks-utils": "^1.0.2",
-    "piral-search": "^1.1.0-beta.5752",
+    "piral-search": "^1.1.0-beta.5756",
     "reactstrap": "8.10.1",
     "tslib": "2.5.2",
     "react": "18.2.0",