@hybridly/core 0.0.1-alpha.16 → 0.0.1-alpha.18

package/dist/index.cjs

@@ -2,14 +2,14 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-const qs = require('qs');
 const utils = require('@hybridly/utils');
 const axios = require('axios');
+const qs = require('qs');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e["default"] : e; }
 
-const qs__default = /*#__PURE__*/_interopDefaultLegacy(qs);
 const axios__default = /*#__PURE__*/_interopDefaultLegacy(axios);
+const qs__default = /*#__PURE__*/_interopDefaultLegacy(qs);
 
 const STORAGE_EXTERNAL_KEY = "hybridly:external";
 const HYBRIDLY_HEADER = "x-hybrid";
@@ -89,7 +89,12 @@ async function runHooks(hook, requestHooks, ...args) {
 function appendCallbackToHooks(hook, fn) {
   const hooks = getRouterContext().hooks;
   hooks[hook] = [...hooks[hook] ?? [], fn];
-  return () => hooks[hook]?.splice(hooks[hook].indexOf(fn), 1);
+  return () => {
+    const index = hooks[hook].indexOf(fn);
+    if (index !== -1) {
+      hooks[hook]?.splice(index, 1);
+    }
+  };
 }
 function registerHook(hook, fn, options) {
   if (options?.once) {
@@ -469,10 +474,7 @@ async function initializeContext(options) {
     hooks: {},
     state: {}
   };
-  for (const plugin of state.context.plugins) {
-    utils.debug.plugin(plugin.name, 'Calling "initialized" hook.');
-    await plugin.initialized?.(state.context);
-  }
+  await runHooks("initialized", {}, state.context);
   return getInternalRouterContext();
 }
 function setContext(merge = {}, options = {}) {
@@ -733,6 +735,7 @@ function isHybridResponse(response) {
 async function navigate(options) {
   const context = getRouterContext();
   utils.debug.router("Making an internal navigation:", { context, options });
+  await runHooks("navigating", {}, options, context);
   options.payload ?? (options.payload = payloadFromContext());
   const evaluateConditionalOption = (option) => typeof option === "function" ? option(options.payload) : option;
   const shouldPreserveState = evaluateConditionalOption(options.preserveState);
@@ -795,6 +798,7 @@ async function initializeRouter() {
     });
   }
   registerEventListeners();
+  await runHooks("ready", {}, context);
   return context;
 }
 async function performLocalNavigation(targetUrl, options) {

package/dist/index.d.ts

@@ -3,14 +3,10 @@ import { AxiosResponse, AxiosProgressEvent, Axios } from 'axios';
 
 type MaybePromise<T> = T | Promise<T>;
 
-interface Hooks {
+interface RequestHooks {
     /**
-     * Called when a back-forward navigation occurs.
-     */
-    backForward: (state: any, context: InternalRouterContext) => MaybePromise<any>;
-    /**
-     * Called before anything when a navigation is going to happen.
-     */
+         * Called before a navigation request is going to happen.
+         */
     before: (options: HybridRequestOptions, context: InternalRouterContext) => MaybePromise<any | boolean>;
     /**
      * Called before the request of a navigation is going to happen.
@@ -52,8 +48,26 @@ interface Hooks {
      * Called after a request has been made, even if it didn't succeed.
      */
     after: (context: InternalRouterContext) => MaybePromise<void>;
+}
+interface Hooks extends RequestHooks {
+    /**
+         * Called when Hybridly's context is initialized.
+         */
+    initialized: (context: InternalRouterContext) => MaybePromise<void>;
+    /**
+     * Called after Hybridly's initial page load.
+     */
+    ready: (context: InternalRouterContext) => MaybePromise<void>;
+    /**
+     * Called when a back-forward navigation occurs.
+     */
+    backForward: (state: any, context: InternalRouterContext) => MaybePromise<any>;
+    /**
+     * Called when a component navigation is being made.
+     */
+    navigating: (options: NavigationOptions, context: InternalRouterContext) => MaybePromise<void>;
     /**
-     * Called when a navigation has been made and a page component has been navigated to.
+     * Called when a component has been navigated to.
      */
     navigated: (options: NavigationOptions, context: InternalRouterContext) => MaybePromise<void>;
 }
@@ -67,8 +81,8 @@ interface HookOptions {
 declare function registerHook<T extends keyof Hooks>(hook: T, fn: Hooks[T], options?: HookOptions): () => void;
 
 interface Plugin extends Partial<Hooks> {
+    /** Identifier of the plugin. */
     name: string;
-    initialized?: (context: InternalRouterContext) => MaybePromise<void>;
 }
 declare function definePlugin(plugin: Plugin): Plugin;
 
@@ -153,7 +167,7 @@ interface HybridRequestOptions extends Omit<NavigationOptions, 'payload'> {
     /** The bag in which to put potential errors. */
     errorBag?: string;
     /** Hooks for this navigation. */
-    hooks?: Partial<Hooks>;
+    hooks?: Partial<RequestHooks>;
     /** If `true`, force the usage of a `FormData` object. */
     useFormData?: boolean;
     /**

package/dist/index.mjs

@@ -1,6 +1,6 @@
-import qs, { parse, stringify } from 'qs';
 import { debug, merge, debounce, random, hasFiles, objectToFormData, when, match, showResponseErrorModal } from '@hybridly/utils';
 import axios from 'axios';
+import qs, { parse, stringify } from 'qs';
 
 const STORAGE_EXTERNAL_KEY = "hybridly:external";
 const HYBRIDLY_HEADER = "x-hybrid";
@@ -80,7 +80,12 @@ async function runHooks(hook, requestHooks, ...args) {
 function appendCallbackToHooks(hook, fn) {
   const hooks = getRouterContext().hooks;
   hooks[hook] = [...hooks[hook] ?? [], fn];
-  return () => hooks[hook]?.splice(hooks[hook].indexOf(fn), 1);
+  return () => {
+    const index = hooks[hook].indexOf(fn);
+    if (index !== -1) {
+      hooks[hook]?.splice(index, 1);
+    }
+  };
 }
 function registerHook(hook, fn, options) {
   if (options?.once) {
@@ -460,10 +465,7 @@ async function initializeContext(options) {
     hooks: {},
     state: {}
   };
-  for (const plugin of state.context.plugins) {
-    debug.plugin(plugin.name, 'Calling "initialized" hook.');
-    await plugin.initialized?.(state.context);
-  }
+  await runHooks("initialized", {}, state.context);
   return getInternalRouterContext();
 }
 function setContext(merge = {}, options = {}) {
@@ -724,6 +726,7 @@ function isHybridResponse(response) {
 async function navigate(options) {
   const context = getRouterContext();
   debug.router("Making an internal navigation:", { context, options });
+  await runHooks("navigating", {}, options, context);
   options.payload ?? (options.payload = payloadFromContext());
   const evaluateConditionalOption = (option) => typeof option === "function" ? option(options.payload) : option;
   const shouldPreserveState = evaluateConditionalOption(options.preserveState);
@@ -786,6 +789,7 @@ async function initializeRouter() {
     });
   }
   registerEventListeners();
+  await runHooks("ready", {}, context);
   return context;
 }
 async function performLocalNavigation(targetUrl, options) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hybridly/core",
-  "version": "0.0.1-alpha.16",
+  "version": "0.0.1-alpha.18",
   "description": "A solution to develop server-driven, client-rendered applications",
   "keywords": [
     "hybridly",
@@ -37,7 +37,7 @@
   },
   "dependencies": {
     "qs": "^6.11.0",
-    "@hybridly/utils": "0.0.1-alpha.16"
+    "@hybridly/utils": "0.0.1-alpha.18"
   },
   "devDependencies": {
     "defu": "^6.1.1"