@inglorious/web 6.5.0 → 6.5.2

package/README.md

@@ -1045,6 +1045,10 @@ api.notify("navigate", "/users/456")
 // Or navigate back in history
 api.notify("navigate", -1)
 
+// Go back, or to "/users" when the app was opened on this page and has
+// nothing of its own to go back to (a deep link, a fresh tab)
+api.notify("back", "/users")
+
 // With options
 api.notify("navigate", {
   to: "/users/456",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inglorious/web",
-  "version": "6.5.0",
+  "version": "6.5.2",
   "description": "A new web framework that leverages the power of the Inglorious Store combined with the performance and simplicity of lit-html.",
   "author": "Matteo Antony Mistretta <antony.mistretta@gmail.com> (https://ingloriouscoderz.it)",
   "contributors": [
@@ -104,12 +104,12 @@
   },
   "sideEffects": false,
   "dependencies": {
-    "@inglorious/utils": "4.0.0",
+    "@inglorious/utils": "5.0.0",
     "@lit-labs/ssr-client": "^1.1.8",
     "lit-html": "^3.3.3"
   },
   "peerDependencies": {
-    "@inglorious/store": "11.0.2"
+    "@inglorious/store": "11.0.3"
   },
   "devDependencies": {
     "@inglorious/eslint-config": "1.1.2",

package/src/router/handlers.js

@@ -221,6 +221,27 @@ export function createHandlers(routeConfig) {
       api.notify("routeChange", historyState)
     },
 
+    /**
+     * Goes back one entry when the app has an entry of its own to go back to,
+     * and otherwise navigates to the fallback in place. An app opened on a deep
+     * link starts at the first index, where `history.back()` would leave the
+     * app or do nothing at all.
+     * @param {RouterEntity} entity - The router entity.
+     * @param {string|{to: string, params?: object, state?: object}} [fallback] - Where to go when there is nothing to go back to.
+     * @param {Api} api - The application API.
+     */
+    back(entity, fallback, api) {
+      if (entity.idx > FIRST_HISTORY_INDEX) {
+        history.back()
+        return
+      }
+
+      if (fallback == null) return
+
+      const options = typeof fallback === "string" ? { to: fallback } : fallback
+      api.notify(`#${entity.id}:navigate`, { ...options, replace: true })
+    },
+
     /**
      * Handles successful loading of a lazily-loaded route module.
      * Registers the loaded type in the runtime type registry via `api.setType`

package/types/router.d.ts

@@ -38,6 +38,8 @@ export interface RouterEntity {
   query?: QueryParams
   /** The hash from the current URL. */
   hash?: string
+  /** The position of the current entry in the session history, counted from the entry the app started on. */
+  idx?: number
   /** Whether a route is currently loading asynchronously. */
   isLoading?: boolean
   /** An error that occurred during route loading. */
@@ -104,6 +106,19 @@ export interface RouterType {
     api: Api,
   ): void | Promise<void>
 
+  /**
+   * Goes back one history entry when the app pushed one, and otherwise
+   * navigates to the fallback, replacing the current entry.
+   * @param {RouterEntity} entity - The router entity.
+   * @param {string|Omit<NavigatePayload, "replace">} [fallback] - Where to go when there is nothing to go back to.
+   * @param {StoreApi} api - The store API.
+   */
+  back(
+    entity: RouterEntity,
+    fallback: string | Omit<NavigatePayload, "replace"> | undefined,
+    api: Api,
+  ): void
+
   /**
    * Synchronizes the router entity's state with data from a routing event,
    * typically triggered by a `popstate` event (browser back/forward).