@viewfly/router 1.0.0-alpha.2 → 1.0.0-alpha.22

package/bundles/index.d.ts

@@ -0,0 +1,94 @@
+import { ComponentSetup, Props, Module, Application } from '@viewfly/core';
+import { Observable } from '@tanbo/stream';
+
+interface RouteConfig {
+    path: string;
+    component?: ComponentSetup;
+    asyncComponent?: () => Promise<ComponentSetup>;
+    beforeEach?(): boolean | Promise<boolean>;
+}
+declare class Router {
+    private navigator;
+    parent: Router | null;
+    path: string;
+    onRefresh: Observable<void>;
+    get pathname(): string;
+    get beforePath(): string;
+    private refreshEvent;
+    constructor(navigator: Navigator, parent: Router | null, path: string);
+    navigateTo(path: string, params?: QueryParams, fragment?: string): void;
+    replaceTo(path: string, params?: QueryParams): void;
+    refresh(path: string): void;
+    consumeConfig(routes: RouteConfig[]): {
+        remainingPath: string;
+        routeConfig: RouteConfig;
+    } | null;
+    back(): void;
+    forward(): void;
+    go(offset: number): void;
+    private matchRoute;
+}
+
+interface QueryParams {
+    [key: string]: string | string[];
+}
+declare abstract class Navigator {
+    baseUrl: string;
+    protected constructor(baseUrl: string);
+    abstract onUrlChanged: Observable<void>;
+    abstract get pathname(): string;
+    abstract to(pathName: string, relative: Router, queryParams?: QueryParams, fragment?: string): boolean;
+    abstract replace(pathName: string, relative: Router, queryParams?: QueryParams, fragment?: string): boolean;
+    abstract join(pathName: string, relative: Router, queryParams?: QueryParams, fragment?: string): string;
+    abstract back(): void;
+    abstract forward(): void;
+    abstract go(offset: number): void;
+    abstract destroy(): void;
+}
+interface UrlFormatParams {
+    queryParams?: QueryParams;
+    fragment?: string;
+}
+declare function formatUrl(pathname: string, urlFormatParams: UrlFormatParams): string;
+declare function formatQueryParams(queryParams: QueryParams): string;
+declare class BrowserNavigator extends Navigator {
+    onUrlChanged: Observable<void>;
+    get pathname(): string;
+    private urlChangeEvent;
+    private subscription;
+    constructor(baseUrl: string);
+    to(pathName: string, relative: Router, queryParams?: QueryParams, fragment?: string): boolean;
+    replace(pathName: string, relative: Router, queryParams?: QueryParams, fragment?: string): boolean;
+    join(pathname: string, relative: Router, queryParams?: QueryParams, fragment?: string): string;
+    back(): void;
+    forward(): void;
+    go(offset: number): void;
+    destroy(): void;
+}
+
+interface LinkProps extends Props {
+    to: string;
+    active?: string;
+    exact?: boolean;
+    queryParams?: QueryParams;
+    fragment?: string;
+    tag?: string;
+    [key: string]: any;
+}
+declare function Link(props: LinkProps): () => any;
+
+interface RouterOutletProps extends Props {
+    config: RouteConfig[];
+}
+declare const RouterOutlet: (props: RouterOutletProps) => () => any;
+
+declare class RouterModule implements Module {
+    baseUrl: string;
+    private subscription;
+    private navigator;
+    constructor(baseUrl?: string);
+    setup(app: Application): void;
+    onDestroy(): void;
+}
+
+export { BrowserNavigator, Link, type LinkProps, Navigator, type QueryParams, type RouteConfig, Router, RouterModule, RouterOutlet, type RouterOutletProps, type UrlFormatParams, formatQueryParams, formatUrl };

package/bundles/index.esm.js

@@ -1,5 +1,5 @@
 import { jsx, Fragment } from '@viewfly/core/jsx-runtime';
-import { Injectable, inject, createSignal, onUnmounted, withAnnotation, SkipSelf, InjectFlags } from '@viewfly/core';
+import { Injectable, inject, createSignal, onUnmounted, makeError, withAnnotation, SkipSelf, InjectFlags } from '@viewfly/core';
 import { Subject, Subscription, fromEvent } from '@tanbo/stream';
 
 /******************************************************************************
@@ -268,6 +268,7 @@ function Link(props) {
     };
 }
 
+const routerErrorFn = makeError('RouterOutlet');
 const RouterOutlet = withAnnotation({
     providers: [{
             provide: Router,
@@ -281,8 +282,11 @@ const RouterOutlet = withAnnotation({
         }]
 }, function RouterOutlet(props) {
     const children = createSignal(null);
-    const router = inject(Router, InjectFlags.SkipSelf);
+    const router = inject(Router, null, InjectFlags.SkipSelf);
     const childRouter = inject(Router);
+    if (router === null) {
+        throw routerErrorFn('cannot found parent Router.');
+    }
     const subscription = router.onRefresh.subscribe(() => {
         updateChildren();
     });

package/bundles/index.js

@@ -270,6 +270,7 @@ function Link(props) {
     };
 }
 
+const routerErrorFn = core.makeError('RouterOutlet');
 const RouterOutlet = core.withAnnotation({
     providers: [{
             provide: Router,
@@ -283,8 +284,11 @@ const RouterOutlet = core.withAnnotation({
         }]
 }, function RouterOutlet(props) {
     const children = core.createSignal(null);
-    const router = core.inject(Router, core.InjectFlags.SkipSelf);
+    const router = core.inject(Router, null, core.InjectFlags.SkipSelf);
     const childRouter = core.inject(Router);
+    if (router === null) {
+        throw routerErrorFn('cannot found parent Router.');
+    }
     const subscription = router.onRefresh.subscribe(() => {
         updateChildren();
     });

package/package.json

@@ -1,19 +1,21 @@
 {
   "name": "@viewfly/router",
-  "version": "1.0.0-alpha.2",
+  "version": "1.0.0-alpha.22",
   "description": "A routing library based on the Viewfly framework that can be run in the browser or Nodejs background.",
   "main": "./bundles/index.js",
   "module": "./bundles/index.esm.js",
-  "typings": "./bundles/public-api.d.ts",
+  "typings": "./bundles/index.d.ts",
   "scripts": {
-    "build:lib": "rimraf bundles && rollup --config rollup.config.ts --configPlugin @rollup/plugin-typescript",
+    "build:lib": "rimraf bundles && npm run build  && npm run build-d",
+    "build": "rollup --config rollup.config.ts --configPlugin @rollup/plugin-typescript",
+    "build-d": "rollup --config rollup-d.config.ts --configPlugin @rollup/plugin-typescript",
     "publish:lib": "npm run build:lib && npm publish --access=public"
   },
   "license": "MIT",
   "keywords": [],
   "dependencies": {
-    "@tanbo/stream": "^1.2.3",
-    "@viewfly/core": "^1.0.0-alpha.2",
+    "@tanbo/stream": "^1.2.4",
+    "@viewfly/core": "^1.0.0-alpha.22",
     "url": "^0.11.1"
   },
   "devDependencies": {
@@ -21,6 +23,7 @@
     "@rollup/plugin-typescript": "^11.1.2",
     "rimraf": "^3.0.2",
     "rollup": "^3.26.3",
+    "rollup-plugin-dts": "^6.1.1",
     "tslib": "^2.6.0"
   },
   "author": {
@@ -34,5 +37,5 @@
   "bugs": {
     "url": "https://github.com/viewfly/viewfly.git/issues"
   },
-  "gitHead": "494829c8d0cde30d0a35c61351c863ea14515ac2"
+  "gitHead": "b66ca589f7662cd518fc2e5955b3e3ff9de83f94"
 }

package/rollup-d.config.ts

@@ -0,0 +1,14 @@
+import dts from 'rollup-plugin-dts'
+
+export default {
+  input: 'src/public-api.ts',
+  output: [
+    {
+      file: './bundles/index.d.ts',
+      format: 'es'
+    }
+  ],
+  plugins: [
+    dts(),
+  ]
+}

package/bundles/link.d.ts

@@ -1,11 +0,0 @@
-import { Props } from '@viewfly/core';
-import { QueryParams } from './providers/_api';
-export interface LinkProps extends Props {
-    to: string;
-    active?: string;
-    exact?: boolean;
-    queryParams?: QueryParams;
-    fragment?: string;
-    tag?: string;
-}
-export declare function Link(props: LinkProps): () => any;

package/bundles/providers/_api.d.ts

@@ -1,2 +0,0 @@
-export * from './navigator';
-export * from './router';

package/bundles/providers/navigator.d.ts

@@ -1,38 +0,0 @@
-import { Observable } from '@tanbo/stream';
-import { Router } from './router';
-export interface QueryParams {
-    [key: string]: string | string[];
-}
-export declare abstract class Navigator {
-    baseUrl: string;
-    protected constructor(baseUrl: string);
-    abstract onUrlChanged: Observable<void>;
-    abstract get pathname(): string;
-    abstract to(pathName: string, relative: Router, queryParams?: QueryParams, fragment?: string): boolean;
-    abstract replace(pathName: string, relative: Router, queryParams?: QueryParams, fragment?: string): boolean;
-    abstract join(pathName: string, relative: Router, queryParams?: QueryParams, fragment?: string): string;
-    abstract back(): void;
-    abstract forward(): void;
-    abstract go(offset: number): void;
-    abstract destroy(): void;
-}
-export interface UrlFormatParams {
-    queryParams?: QueryParams;
-    fragment?: string;
-}
-export declare function formatUrl(pathname: string, urlFormatParams: UrlFormatParams): string;
-export declare function formatQueryParams(queryParams: QueryParams): string;
-export declare class BrowserNavigator extends Navigator {
-    onUrlChanged: Observable<void>;
-    get pathname(): string;
-    private urlChangeEvent;
-    private subscription;
-    constructor(baseUrl: string);
-    to(pathName: string, relative: Router, queryParams?: QueryParams, fragment?: string): boolean;
-    replace(pathName: string, relative: Router, queryParams?: QueryParams, fragment?: string): boolean;
-    join(pathname: string, relative: Router, queryParams?: QueryParams, fragment?: string): string;
-    back(): void;
-    forward(): void;
-    go(offset: number): void;
-    destroy(): void;
-}

package/bundles/providers/router.d.ts

@@ -1,29 +0,0 @@
-import { Observable } from '@tanbo/stream';
-import { Navigator, QueryParams } from './navigator';
-export interface RouteConfig {
-    path: string;
-    component?: JSXInternal.ComponentSetup;
-    asyncComponent?: () => Promise<JSXInternal.ComponentSetup>;
-    beforeEach?(): boolean | Promise<boolean>;
-}
-export declare class Router {
-    private navigator;
-    parent: Router | null;
-    path: string;
-    onRefresh: Observable<void>;
-    get pathname(): string;
-    get beforePath(): string;
-    private refreshEvent;
-    constructor(navigator: Navigator, parent: Router | null, path: string);
-    navigateTo(path: string, params?: QueryParams, fragment?: string): void;
-    replaceTo(path: string, params?: QueryParams): void;
-    refresh(path: string): void;
-    consumeConfig(routes: RouteConfig[]): {
-        remainingPath: string;
-        routeConfig: RouteConfig;
-    } | null;
-    back(): void;
-    forward(): void;
-    go(offset: number): void;
-    private matchRoute;
-}

package/bundles/public-api.d.ts

@@ -1,4 +0,0 @@
-export * from './link';
-export * from './router-outlet';
-export * from './router-module';
-export * from './providers/_api';

package/bundles/router-module.d.ts

@@ -1,9 +0,0 @@
-import { Application, Module } from '@viewfly/core';
-export declare class RouterModule implements Module {
-    baseUrl: string;
-    private subscription;
-    private navigator;
-    constructor(baseUrl?: string);
-    setup(app: Application): void;
-    onDestroy(): void;
-}

package/bundles/router-outlet.d.ts

@@ -1,6 +0,0 @@
-import { Props } from '@viewfly/core';
-import { RouteConfig } from './providers/_api';
-export interface RouterOutletProps extends Props {
-    config: RouteConfig[];
-}
-export declare const RouterOutlet: (props: RouterOutletProps) => () => any;