5htp-core 0.1.1-2 → 0.1.1-4

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "5htp-core",
 	"description": "5-HTP, scientifically called 5-Hydroxytryptophan, is the precursor of happiness neurotransmitter.",
-	"version": "0.1.1-2",
+	"version": "0.1.1-4",
 	"author": "Gaetan Le Gac (https://github.com/gaetanlegac)",
 	"repository": "git://github.com/gaetanlegac/5htp-core.git",
 	"license": "MIT",

package/src/client/router/Link.tsx

@@ -0,0 +1,36 @@
+/*----------------------------------
+- DEPENDANCES
+----------------------------------*/
+
+// Npm
+import React from 'react';
+import type { ComponentChild } from 'preact';
+import { history } from './request/history';
+
+/*----------------------------------
+- COMPONENT
+----------------------------------*/
+// Simple link
+export const Link = ({ to, ...props }: { 
+    to: string,
+    children?: ComponentChild,
+    class?: string,
+    className?: string
+} & React.HTMLProps<HTMLAnchorElement>) => {
+
+    // External = open in new tab by default
+    if (to[0] !== '/' || to.startsWith('//'))
+        props.target = '_blank';
+    // Otherwise, propagate to the router
+    else 
+        props.onClick = (e) => {
+            history?.push(to);
+            e.preventDefault();
+            return false
+        }
+
+    return (
+        <a {...props} href={to} />
+    )
+
+}

package/src/client/router/{index.tsx → index.ts}

@@ -4,119 +4,97 @@
 
 // Npm
 import React from 'react';
-import type { ComponentChild } from 'preact';
-import type { Location } from 'history';
 
 // Core: libs
 import ClientRequest from './request';
 import ClientResponse from './response';
-import { history } from './request/history';
 
 // Core: types
-import BaseRouter, { TBaseRoute, TRouteOptions, defaultOptions, } from '@common/router'
+import BaseRouter, { defaultOptions, } from '@common/router'
 import { PageResponse } from '@common/router/response';
-import { TFetcher, TFetcherList } from '@common/router/request';
-import type { TSsrData, default as ServerResponse } from '@server/services/router/response';
+import type { TSsrData } from '@server/services/router/response';
 import type { ClientContext } from '@client/context';
 
 // Type xports
 export type { default as ClientResponse } from "./response";
+export { Link } from './Link';
+import type { 
+    TClientRoute,
+    TUnresolvedRoute,
+    TSsrUnresolvedRoute,
+    TRoutesLoaders,
+    TRouteCallback,
+    TFetchedRoute,
+    TRegisterPageArgs
+} from './route';
+
+// Temporary
+// TODO: Import these types directly from router/routes
+export type { 
+    TClientRoute,
+    TUnresolvedRoute,
+    TSsrUnresolvedRoute,
+    TRoutesLoaders,
+    TRouteCallback,
+    TFetchedRoute,
+    TRegisterPageArgs
+} from './route';
 
 /*----------------------------------
-- TYPES: PARTIAL ROUTES
+- CONFIG
 ----------------------------------*/
 
-export type TSsrUnresolvedRoute = Pick<TClientRoute, 'type' | 'keys'> & {
-    regex: string,
-    chunk: string,
-}
-
-export type TUnresolvedRoute = Pick<TClientRoute, 'type' | 'keys'> & {
-    regex: RegExp,
-    chunk: string,
-    load: TRouteLoader,
-}
-
-type TFetchedRoute = Pick<TClientRoute, 'path' | 'options' | 'controller' | 'renderer' | 'method'>
+const debug = true;
+const LogPrefix = '[router]'
 
 /*----------------------------------
-- TYPES: REGISTER
+- TYPES
 ----------------------------------*/
 
-type TRouteLoader = () => Promise<{ default: TFetchedRoute }>;
-
-export type TRoutesLoaders = {
-    [chunkId: string]: /* Preloaded via require() */TFetchedRoute | /* Loader via import() */TRouteLoader/* | undefined*/
-}
-
-type TRouteCallback = (route?: TClientRoute) => void;
+export type THookCallback = (request: ClientRequest) => void;
 
-export type TRegisterPageArgs<TControllerData extends TFetcherList = {}> = [
-    path: string,
-    options: Partial<TRouteOptions>,
-    controller: TFrontController<TControllerData> | null,
-    renderer: TFrontRenderer<TControllerData>
-];
+type THookName = 'locationChange'
 
 /*----------------------------------
-- TYPES: COMPLETE ROUTES
+- ROUTER
 ----------------------------------*/
+class Router extends BaseRouter {
 
-export type TClientRoute = TBaseRoute & {
-    type: 'PAGE',
-    method: 'GET',
-    controller: TFrontController | null,
-    renderer: TFrontRenderer
-}
+    /*----------------------------------
+    - HOOKS
+    ----------------------------------*/
+    private hooks: {[hookname in THookName]?: THookCallback[]} = {}
+    public on( hookName: THookName, callback: THookCallback ) {
 
-// https://stackoverflow.com/questions/44851268/typescript-how-to-extract-the-generic-parameter-from-a-type
-type TypeWithGeneric<T> = TFetcher<T>
-type extractGeneric<Type> = Type extends TypeWithGeneric<infer X> ? X : never
-
-export type TFrontController<TControllerData extends TFetcherList = {}> = 
-    (urlParams: TObjetDonnees, context: ClientContext) => TControllerData
-
-export type TFrontRenderer<TControllerData extends TFetcherList = {}> = (
-    data: {
-        [Property in keyof TControllerData]: undefined | (extractGeneric<TControllerData[Property]> extends ((...args: any[]) => any) 
-            ? ThenArg<ReturnType< extractGeneric<TControllerData[Property]> >>
-            : extractGeneric<TControllerData[Property]>
-        )
-    },
-    context: ClientContext
-) => ComponentChild
-
-// Simple link
-export const Link = ({ to, ...props }: { 
-    to: string,
-    children?: ComponentChild,
-    class?: string,
-    className?: string
-}) => {
-
-    // External = open in new tab by default
-    if (to[0] !== '/' || to.startsWith('//'))
-        props.target = '_blank';
-    // Otherwise, propagate to the router
-    else 
-        props.onClick = (e) => {
-            history?.push(to);
-            e.preventDefault();
-            return false
-        }
+        debug && console.info(LogPrefix, `Register hook ${hookName}`);
 
-    return (
-        <a {...props} href={to} />
-    )
+        let cbIndex: number;
+        let callbacks = this.hooks[ hookName ];
+        if (!callbacks) {
+            cbIndex = 0;
+            callbacks = this.hooks[ hookName ] = [callback]
+        } else {
+            cbIndex = callbacks.length;
+            callbacks.push(callback);
+        }
 
-}
+        // Listener remover
+        return () => {
+            debug && console.info(LogPrefix, `De-register hook ${hookName} (index ${cbIndex})`);
+            delete (callbacks as THookCallback[])[ cbIndex ];
+        }
 
-const debug = true;
+    }
+    private runHook( hookName: THookName, request: ClientRequest ) {
+        const callbacks = this.hooks[hookName];
+        if (callbacks)
+            for (const callback of callbacks)
+                callback(request);
+    }
 
-/*----------------------------------
-- ROUTER
-----------------------------------*/
-class Router extends BaseRouter {
+    /*----------------------------------
+    - ROUTES MANAGEMENT
+    ----------------------------------*/
 
     public disableResolver = false;
 
@@ -171,6 +149,8 @@ class Router extends BaseRouter {
     public async resolve( request: ClientRequest, context: ClientContext ): Promise<PageResponse | undefined | null> {
         debug && console.log('Resolving request', request.path, Object.keys(request.data));
 
+        this.runHook('locationChange', request);
+
         for (let iRoute = 0; iRoute < this.routes.length; iRoute++) {
 
             let route = this.routes[iRoute];

package/src/client/router/route.ts

@@ -0,0 +1,75 @@
+/*----------------------------------
+- DEPENDANCES
+----------------------------------*/
+
+// Npm
+import type { ComponentChild } from 'preact';
+
+// Core
+import type { ClientContext } from '@client/context';
+import type { TBaseRoute, TRouteOptions, } from '@common/router'
+import type { TFetcher, TFetcherList } from '@common/router/request';
+
+/*----------------------------------
+- TYPES: PARTIAL ROUTES
+----------------------------------*/
+
+export type TSsrUnresolvedRoute = Pick<TClientRoute, 'type' | 'keys'> & {
+    regex: string,
+    chunk: string,
+}
+
+export type TUnresolvedRoute = Pick<TClientRoute, 'type' | 'keys'> & {
+    regex: RegExp | null,
+    chunk: string,
+    load: TRouteLoader,
+}
+
+export type TFetchedRoute = Pick<TClientRoute, 'path' | 'options' | 'controller' | 'renderer' | 'method'>
+
+/*----------------------------------
+- TYPES: REGISTER
+----------------------------------*/
+
+type TRouteLoader = () => Promise<{ default: TFetchedRoute }>;
+
+export type TRoutesLoaders = {
+    [chunkId: string]: /* Preloaded via require() */TFetchedRoute | /* Loader via import() */TRouteLoader/* | undefined*/
+}
+
+export type TRouteCallback = (route?: TClientRoute) => void;
+
+export type TRegisterPageArgs<TControllerData extends TFetcherList = {}> = [
+    path: string,
+    options: Partial<TRouteOptions>,
+    controller: TFrontController<TControllerData> | null,
+    renderer: TFrontRenderer<TControllerData>
+];
+
+/*----------------------------------
+- TYPES: COMPLETE ROUTES
+----------------------------------*/
+
+export type TClientRoute = TBaseRoute & {
+    type: 'PAGE',
+    method: 'GET',
+    controller: TFrontController | null,
+    renderer: TFrontRenderer
+}
+
+// https://stackoverflow.com/questions/44851268/typescript-how-to-extract-the-generic-parameter-from-a-type
+type TypeWithGeneric<T> = TFetcher<T>
+type extractGeneric<Type> = Type extends TypeWithGeneric<infer X> ? X : never
+
+export type TFrontController<TControllerData extends TFetcherList = {}> = 
+    (urlParams: TObjetDonnees, context: ClientContext) => TControllerData
+
+export type TFrontRenderer<TControllerData extends TFetcherList = {}> = (
+    data: {
+        [Property in keyof TControllerData]: undefined | (extractGeneric<TControllerData[Property]> extends ((...args: any[]) => any) 
+            ? ThenArg<ReturnType< extractGeneric<TControllerData[Property]> >>
+            : extractGeneric<TControllerData[Property]>
+        )
+    },
+    context: ClientContext
+) => ComponentChild