Merge pull request #95 from timsun28/master

Flow-Router Extra Typescript types

Author: dr-dimitru

package-types.json

@@ -0,0 +1,3 @@
+{
+    "typesEntry": "types.d.ts"
+}

package.js

@@ -7,15 +7,15 @@ Package.describe({
 
 Package.onUse((api) => {
   api.versionsFrom('1.4');
-  api.use(['modules', 'ecmascript', 'promise', 'tracker', 'reactive-dict', 'reactive-var', 'ejson', 'check'], ['client', 'server']);
+  api.use(['modules', 'ecmascript', 'promise', 'tracker', 'reactive-dict', 'reactive-var', 'ejson', 'check', 'zodern:types'], ['client', 'server']);
 
   api.use(['templating', 'blaze'], 'client', { weak: true });
   api.mainModule('client/_init.js', 'client');
   api.mainModule('server/_init.js', 'server');
 });
 
 Package.onTest((api) => {
-  api.use(['ecmascript', 'tinytest', 'underscore', 'check', 'mongo', 'http', 'random', 'communitypackages:[email protected]', 'communitypackages:[email protected]', 'montiapm:[email protected]', 'ostrio:flow-router-extra'], ['client', 'server']);
+  api.use(['ecmascript', 'tinytest', 'underscore', 'check', 'mongo', 'http', 'random', 'communitypackages:[email protected]', 'communitypackages:[email protected]', 'montiapm:[email protected]', 'ostrio:flow-router-extra', 'zodern:types'], ['client', 'server']);
   api.use(['reactive-var', 'tracker'], 'client');
 
   api.addFiles('test/common/fast_render_route.js', ['client', 'server']);
@@ -44,4 +44,4 @@ Package.onTest((api) => {
 Npm.depends({
   page: '1.9.0',
   qs: '6.10.5'
-});
+});

types.d.ts

@@ -0,0 +1,128 @@
+type Trigger = (context: ReturnType<Router["current"]>, redirect: Router["go"], stop: () => void, data: any) => void;
+
+type TriggerFilterParam = { only: string[] } | { except: string[] };
+
+type DynamicImport<T extends string> = Promise<typeof import(T)>;
+
+type Hook = (params: Param, qs: QueryParam) => void;
+
+type waitOn = (
+    params: Param,
+    qs: QueryParam,
+    ready: (func: () => ReturnType<waitOn>) => void
+) =>
+    | Promise<any>
+    | Array<Promise<any>>
+    | Meteor.SubscriptionHandle
+    | Tracker.Computation
+    | Array<Tracker.Computation>
+    | DynamicImport<string>
+    | Array<DynamicImport<string> | Meteor.SubscriptionHandle>;
+
+type waitOnResources = (
+    params: Param,
+    qs: QueryParam
+) => {
+    images: string[];
+    other: string[];
+};
+
+type data = (params: Param, qs: QueryParam) => Mongo.CursorStatic | Object | Object[] | false | null | void;
+
+type action = (params: Param, qs: QueryParam, data: any) => void;
+
+type Param = {
+    [key: string]: string;
+};
+
+type QueryParam = Param;
+
+interface Router {
+    go: (path: string, params?: { [key: string]: string }, qs?: { [key: string]: string }) => boolean;
+    route: (
+        path: string,
+        options?: {
+            name?: string;
+            whileWaiting?: Hook;
+            waitOn?: waitOn;
+            waitOnResources?: waitOnResources;
+            endWaiting?: () => void;
+            data?: data;
+            onNoData?: Hook;
+            triggersEnter?: Array<Trigger>;
+            action?: action;
+            triggersExit?: Array<Trigger>;
+            conf?: { [key: string]: any; forceReRender?: boolean };
+            [key: string]: any;
+        }
+    ) => Route;
+    group: (options: { name: string; prefix: string; [key: string]: any }) => any;
+    render: (layout: string, template: string, data?: { [key: string]: any }, callback?: () => void) => void;
+
+    refresh: (layout: string, template: string) => void;
+    reload: () => void;
+    pathRegExp: RegExp;
+    decodeQueryParamsOnce: boolean;
+
+    getParam: (param: string) => string;
+    getQueryParam: (param: string) => string;
+    setParams: (params: Param) => boolean;
+    setQueryParams: (params: QueryParam) => boolean;
+
+    url: (path: string, params?: Param, qs?: QueryParam) => string;
+    path: (path: string, params?: Param, qs?: QueryParam) => string;
+    current: () => {
+        context: Context;
+        oldRoute: Route;
+        params: Param;
+        path: string;
+        queryParams: QueryParam;
+        route: Route;
+    };
+    getRouteName: () => string;
+
+    watchPathChange: () => void;
+    withReplaceState: (callback: () => void) => void;
+
+    onRouteRegister: (callback: (route: Route) => void) => void;
+
+    wait: () => void;
+    initialize: (options: { hashbang: boolean; page: { click: boolean } }) => void;
+
+    triggers: {
+        enter: (triggers: Trigger[], filter?: TriggerFilterParam) => void;
+        exit: (triggers: Trigger[], filter?: TriggerFilterParam) => void;
+    };
+}
+
+interface Route {
+    conf: { [key: string]: string | boolean };
+    globals: Array<any>;
+    group: string;
+    name: string;
+    options: { name: string };
+    path: string;
+    pathDef: string;
+    render: () => void;
+}
+
+type Context = {
+    canonicalPath: string;
+    hash: string;
+    params: Param;
+    path: string;
+    pathname: string;
+    querystring: string;
+    state: { [key: string]: string };
+    title: string;
+};
+
+interface Helpers {
+    name: (routeName: string | RegExp) => boolean;
+    path: (pathName: string | RegExp) => boolean;
+    pathFor: (pathName: string, params: Param) => string;
+    configure: (options: { activeClass: string; caseSensitive: boolean; disabledClass: string; regex: string }) => void;
+}
+
+export const FlowRouter: Router;
+export const RouterHelpers: Helpers;