@thepassle/app-tools 0.7.3 → 0.7.4

package/api/types.d.ts

@@ -0,0 +1,41 @@
+export type ResponseType = 'text'|'json'|'stream'|'blob'|'arrayBuffer'|'formData'|'stream';
+
+export interface Config {
+  plugins?: Plugin[];
+  responseType?: ResponseType;
+  baseURL?: string
+}
+
+export type BodyMethod<R> = (url: string, data?: object, opts?: RequestOptions) => Promise<R>;
+export type BodylessMethod<R> = (url: string, opts?: RequestOptions) => Promise<R>;
+
+export type Method = 'GET'|'DELETE'|'HEAD'|'OPTIONS'|'POST'|'PUT'|'PATCH';
+
+export interface Plugin {
+  beforeFetch?: (meta: MetaParams) => MetaParams | Promise<MetaParams> | void;
+  afterFetch?: (res: Response) => Response | Promise<Response>;
+  transform?: (data: any) => any;
+  name: string;
+  handleError?: (e: Error) => boolean;
+}
+
+export interface CustomRequestOptions {
+  transform?: (data: object) => object;
+  responseType?: ResponseType;
+  params?: Record<string, string>;
+  plugins?: Plugin[];
+  baseURL?: string;
+}
+
+export type RequestOptions = RequestInit & CustomRequestOptions;
+
+export interface MetaParams {
+  responseType: string;
+  baseURL: string;
+  url: string;
+  method: Method;
+  headers: Headers;
+  opts?: RequestOptions;
+  data?: any;
+  fetchFn: typeof globalThis.fetch;
+}

package/dialog/types.d.ts

@@ -0,0 +1,15 @@
+export type DialogNode = HTMLDialogElement & { form: HTMLFormElement };
+
+export interface DialogCallbacks {
+  opening?: <Parameters>(opts: {dialog: DialogNode, parameters: Parameters}) => void;
+  opened?: <Parameters>(opts: {dialog: DialogNode, parameters: Parameters}) => void;
+  closing?: (opts: {dialog: DialogNode}) => void;
+  closed?: (opts: {dialog: DialogNode}) => void;
+}
+
+export type Config = Record<string, DialogCallbacks>;
+
+export interface OpenDialogOptions {
+  id: string;
+  parameters?: object;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thepassle/app-tools",
-  "version": "0.7.3",
+  "version": "0.7.4",
   "description": "",
   "main": "index.js",
   "type": "module",
@@ -37,6 +37,7 @@
     "./package.json": "./package.json"
   },
   "files": [
+    "./**/*.d.ts",
     "./env.js",
     "./pwa.js",
     "./dialog.js",

package/router/index.js

@@ -24,7 +24,8 @@ export class Router extends EventTarget {
     params: {},
     query: {},
     title: '',
-    url: new URL(window.location.href)
+    url: new URL(window.location.href),
+    dispatch: this._notifyUrlChanged.bind(this)
   }
 
   /**
@@ -93,6 +94,7 @@ export class Router extends EventTarget {
           title: typeof title === 'function' ? title({params, query, url}) : title,
           params,
           query,
+          dispatch: this._notifyUrlChanged.bind(this)
         }
         return route;
       }

package/router/plugins/data.js

@@ -6,7 +6,11 @@ export function data(promise){
   return {
     name: 'data',
     beforeNavigation: async (context) => {
-      const data = await promise(context);
+      const data = promise(context).then((data) => {
+        context.data = data;
+        context.dispatch();
+        return data;
+      });
       context.data = data;
     }
   }

package/router/types.d.ts

@@ -0,0 +1,36 @@
+export interface Config {
+  fallback?: string;
+  plugins?: Plugin[];
+  routes: RouteDefinition[];
+}
+
+export interface Plugin {
+  name: string;
+  shouldNavigate?: (context: Context) => {
+    redirect: string,
+    condition: () => boolean | (() => Promise<Boolean>),
+  };
+  beforeNavigation?: (context: Context) => void;
+  afterNavigation?: (context: Context) => void;
+}
+
+export interface Context {
+  title?: string;
+  query: object;
+  params: object;
+  url: URL;
+  dispatch: () => void;
+  [key: string]: any;
+}
+
+export type Render<RenderResult> = (context: Context) => RenderResult;
+
+export interface RouteDefinition {
+  path: string;
+  title: string | ((context: Partial<Context>) => string);
+  render?: Render<RenderResult>;
+  plugins?: Plugin[];
+}
+
+/** @TODO URLPattern type */
+export type Route = RouteDefinition & { urlPattern?: any };