piral-core 1.10.2-beta.dc71cd5 → 1.10.2

package/lib/types/api.d.ts

@@ -1,5 +1,5 @@
 import type { ReactElement, ReactNode } from 'react';
-import type { RouteComponentProps } from 'react-router';
+import type { History, Location } from 'history';
 import type { PiletApi, Pilet, PiletEntry, PiletEntries, PiletMetadata, EventEmitter, PiletLoader, PiletLoadingStrategy } from 'piral-base';
 import type { PiletCustomApi } from './custom';
 import type { AnyComponent, PiralPageMeta } from './components';
@@ -38,19 +38,54 @@ export interface ExtensionComponentProps<T> extends BaseComponentProps {
      */
     children?: ReactNode;
 }
+/**
+ * The match object determining what exactly has been matched for the current navigation.
+ */
+export interface RouteMatch<Params extends {
+    [K in keyof Params]?: string;
+} = {}> {
+    /**
+     * The parameters extracted from the current navigation.
+     */
+    params: Params;
+    /**
+     * Indicates if the parameters have been matched exactly.
+     */
+    isExact: boolean;
+    /**
+     * The relative path.
+     */
+    path: string;
+    /**
+     * The fully qualified URL.
+     */
+    url: string;
+}
 /**
  * The props that every registered page component obtains.
  */
 export interface RouteBaseProps<UrlParams extends {
     [K in keyof UrlParams]?: string;
-} = {}, UrlState = any> extends RouteComponentProps<UrlParams, {}, UrlState>, BaseComponentProps {
+} = {}, UrlState = any> extends BaseComponentProps {
+    /**
+     * The history API to navigate.
+     */
+    history: History<UrlState>;
+    /**
+     * Information about the current location.
+     */
+    location: Location<UrlState>;
+    /**
+     * Information about the matching of the current route.
+     */
+    match: RouteMatch<UrlParams>;
 }
 /**
  * The props used by a page component.
  */
-export interface PageComponentProps<T extends {
-    [K in keyof T]?: string;
-} = {}, S = any> extends RouteBaseProps<T, S> {
+export interface PageComponentProps<UrlParams extends {
+    [K in keyof UrlParams]?: string;
+} = Record<string, string>, UrlState = any> extends RouteBaseProps<UrlParams, UrlState> {
     /**
      * The meta data registered with the page.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "piral-core",
-  "version": "1.10.2-beta.dc71cd5",
+  "version": "1.10.2",
   "description": "The core library for creating a Piral instance.",
   "keywords": [
     "portal",
@@ -63,8 +63,8 @@
     "test": "echo \"Error: run tests from root\" && exit 1"
   },
   "dependencies": {
-    "piral-base": "1.10.2-beta.dc71cd5",
-    "piral-debug-utils": "1.10.2-beta.dc71cd5",
+    "piral-base": "^1.10.2",
+    "piral-debug-utils": "^1.10.2",
     "zustand": "^3.0.0"
   },
   "devDependencies": {
@@ -84,5 +84,5 @@
     "react-router-dom",
     "tslib"
   ],
-  "gitHead": "dc71cd52424153bf2a1b56e05ccf03d6ad2a3fd8"
+  "gitHead": "296a540a6f2af0f39d7e086d7f437ded81a0d256"
 }

package/src/types/api.ts

@@ -1,5 +1,5 @@
 import type { ReactElement, ReactNode } from 'react';
-import type { RouteComponentProps } from 'react-router';
+import type { History, Location } from 'history';
 import type {
   PiletApi,
   Pilet,
@@ -53,17 +53,54 @@ export interface ExtensionComponentProps<T> extends BaseComponentProps {
   children?: ReactNode;
 }
 
+/**
+ * The match object determining what exactly has been matched for the current navigation.
+ */
+export interface RouteMatch<Params extends { [K in keyof Params]?: string } = {}> {
+  /**
+   * The parameters extracted from the current navigation.
+   */
+  params: Params;
+  /**
+   * Indicates if the parameters have been matched exactly.
+   */
+  isExact: boolean;
+  /**
+   * The relative path.
+   */
+  path: string;
+  /**
+   * The fully qualified URL.
+   */
+  url: string;
+}
+
 /**
  * The props that every registered page component obtains.
  */
 export interface RouteBaseProps<UrlParams extends { [K in keyof UrlParams]?: string } = {}, UrlState = any>
-  extends RouteComponentProps<UrlParams, {}, UrlState>,
-    BaseComponentProps {}
+  extends BaseComponentProps {
+  /**
+   * The history API to navigate.
+   */
+  history: History<UrlState>;
+  /**
+   * Information about the current location.
+   */
+  location: Location<UrlState>;
+  /**
+   * Information about the matching of the current route.
+   */
+  match: RouteMatch<UrlParams>;
+}
 
 /**
  * The props used by a page component.
  */
-export interface PageComponentProps<T extends { [K in keyof T]?: string } = {}, S = any> extends RouteBaseProps<T, S> {
+export interface PageComponentProps<
+  UrlParams extends { [K in keyof UrlParams]?: string } = Record<string, string>,
+  UrlState = any,
+> extends RouteBaseProps<UrlParams, UrlState> {
   /**
    * The meta data registered with the page.
    */
@@ -80,8 +117,8 @@ export interface PageComponentProps<T extends { [K in keyof T]?: string } = {},
 export type AnyExtensionComponent<TName> = TName extends keyof PiralExtensionSlotMap
   ? AnyComponent<ExtensionComponentProps<TName>>
   : TName extends string
-  ? AnyComponent<ExtensionComponentProps<any>>
-  : AnyComponent<ExtensionComponentProps<TName>>;
+    ? AnyComponent<ExtensionComponentProps<any>>
+    : AnyComponent<ExtensionComponentProps<TName>>;
 
 /**
  * Defines the Pilet API from piral-core.